annotate lisp/scroll-all.el @ 45072:42c1cb1a6fdf

*** empty log message ***
author Kim F. Storm <storm@cua.dk>
date Wed, 01 May 2002 21:59:53 +0000
parents 4ebf66bb8850
children 348e184769b0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 33422
diff changeset
1 ;;; scroll-all.el --- scroll all buffers together minor mode
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3 ;; Copyright (C) 1997 Free Software Foundation, Inc.
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 ;; Author: Gary D. Foster <Gary.Foster@corp.sun.com>
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 ;; Keywords: scroll crisp brief lock
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 ;; This file is part of GNU Emacs.
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; it under the terms of the GNU General Public License as published by
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; any later version.
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; GNU General Public License for more details.
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 ;; Boston, MA 02111-1307, USA.
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 33422
diff changeset
25 ;;; Commentary:
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 ;; This mode allows multiple buffers to be 'locked' so that scrolling
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 ;; up or down lines in any buffer causes all the buffers to mirror
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 ;; the scrolling. It hooks into the post-command-hook to check for
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 ;; potential scrolling commands and if we're locked, mirrors them in all
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 ;; windows. This allows us to grab line-at-a-time scrolling as well as
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 ;; screen-at-a-time scrolling, and doesn't remap any of the keyboard
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 ;; commands to do it.
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33
17598
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
34 ;; You can enable and disable this mode with the 'scroll-all-mode' command.
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 ;; Suggestions/ideas from:
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 ;; Rick Macdonald <rickm@vsl.com>
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 ;; Anders Lindgren <andersl@csd.uu.se>
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 33422
diff changeset
40 ;;; Code:
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 33422
diff changeset
41
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 (defvar running-xemacs (string-match "XEmacs\\|Lucid" emacs-version))
33422
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
43
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
44 ;;;###autoload
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
45 (defcustom scroll-all-mode nil
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
46 "Control/track scroll locking.
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
47
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
48 Setting this variable directly does not take effect;
44821
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
49 use either \\[customize] or the function `scroll-all-mode'."
33422
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
50 :set (lambda (symbol value) (scroll-all-mode (if value 1 0)))
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
51 :initialize 'custom-initialize-default
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
52 :require 'scroll-all
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
53 :type 'boolean
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
54 :group 'windows)
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
55
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 (if running-xemacs
17598
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
57 (add-minor-mode 'scroll-all-mode " *SL*")
44721
193981425f19 (minor-mode-alist): `scroll-all-mode', not `scroll-all-mode-mode'.
Glenn Morris <rgm@gnu.org>
parents: 38436
diff changeset
58 (or (assq 'scroll-all-mode minor-mode-alist)
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 (setq minor-mode-alist
44721
193981425f19 (minor-mode-alist): `scroll-all-mode', not `scroll-all-mode-mode'.
Glenn Morris <rgm@gnu.org>
parents: 38436
diff changeset
60 (cons '(scroll-all-mode " *SL*") minor-mode-alist))))
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61
44821
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
62 (defun scroll-all-function-all (func arg)
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
63 "Apply function FUNC with argument ARG to all visible windows."
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 (let ((num-windows (count-windows))
44731
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
65 (count 1))
44722
c4139de15915 (scroll-all-page-down-all, scroll-all-page-up-all): Ignore the error if one
Glenn Morris <rgm@gnu.org>
parents: 44721
diff changeset
66 (when (> num-windows 1)
44731
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
67 (other-window 1)
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
68 (while (< count num-windows)
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
69 (condition-case nil
44821
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
70 (funcall func arg)
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
71 ;; Ignore beginning- or end-of-buffer error in other windows.
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
72 (error nil)
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
73 )
44731
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
74 (other-window 1)
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
75 (setq count (1+ count))))))
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76
44821
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
77 (defun scroll-all-scroll-down-all (arg)
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
78 "Scroll down in all visible windows."
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
79 (interactive "p")
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
80 (scroll-all-function-all 'next-line arg))
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
81
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
82 (defun scroll-all-scroll-up-all (arg)
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
83 "Scroll up in all visible windows."
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
84 (interactive "p")
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
85 (scroll-all-function-all 'previous-line arg))
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
86
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
87 (defun scroll-all-page-down-all (arg)
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
88 "Page down in all visible windows."
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
89 (interactive "P")
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
90 (scroll-all-function-all 'scroll-up arg))
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
91
17598
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
92 (defun scroll-all-page-up-all (arg)
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
93 "Page up in all visible windows."
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 (interactive "P")
44821
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
95 (scroll-all-function-all 'scroll-down arg))
44722
c4139de15915 (scroll-all-page-down-all, scroll-all-page-up-all): Ignore the error if one
Glenn Morris <rgm@gnu.org>
parents: 44721
diff changeset
96
c4139de15915 (scroll-all-page-down-all, scroll-all-page-up-all): Ignore the error if one
Glenn Morris <rgm@gnu.org>
parents: 44721
diff changeset
97 (defun scroll-all-beginning-of-buffer-all (arg)
c4139de15915 (scroll-all-page-down-all, scroll-all-page-up-all): Ignore the error if one
Glenn Morris <rgm@gnu.org>
parents: 44721
diff changeset
98 "Go to the beginning of the buffer in all visible windows."
c4139de15915 (scroll-all-page-down-all, scroll-all-page-up-all): Ignore the error if one
Glenn Morris <rgm@gnu.org>
parents: 44721
diff changeset
99 (interactive "P")
44821
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
100 (scroll-all-function-all 'beginning-of-buffer arg))
44722
c4139de15915 (scroll-all-page-down-all, scroll-all-page-up-all): Ignore the error if one
Glenn Morris <rgm@gnu.org>
parents: 44721
diff changeset
101
c4139de15915 (scroll-all-page-down-all, scroll-all-page-up-all): Ignore the error if one
Glenn Morris <rgm@gnu.org>
parents: 44721
diff changeset
102 (defun scroll-all-end-of-buffer-all (arg)
c4139de15915 (scroll-all-page-down-all, scroll-all-page-up-all): Ignore the error if one
Glenn Morris <rgm@gnu.org>
parents: 44721
diff changeset
103 "Go to the end of the buffer in all visible windows."
c4139de15915 (scroll-all-page-down-all, scroll-all-page-up-all): Ignore the error if one
Glenn Morris <rgm@gnu.org>
parents: 44721
diff changeset
104 (interactive "P")
44821
4ebf66bb8850 (scroll-all-function-all): New function to do the work of scrolling other
Glenn Morris <rgm@gnu.org>
parents: 44731
diff changeset
105 (scroll-all-function-all 'end-of-buffer arg))
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107
17598
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
108 (defun scroll-all-check-to-scroll ()
44721
193981425f19 (minor-mode-alist): `scroll-all-mode', not `scroll-all-mode-mode'.
Glenn Morris <rgm@gnu.org>
parents: 38436
diff changeset
109 "Check `this-command' to see if a scroll is to be done."
44731
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
110 (cond ((eq this-command 'next-line)
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
111 (call-interactively 'scroll-all-scroll-down-all))
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
112 ((eq this-command 'previous-line)
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
113 (call-interactively 'scroll-all-scroll-up-all))
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
114 ((eq this-command 'scroll-up)
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
115 (call-interactively 'scroll-all-page-down-all))
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
116 ((eq this-command 'scroll-down)
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
117 (call-interactively 'scroll-all-page-up-all))
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
118 ((eq this-command 'beginning-of-buffer)
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
119 (call-interactively 'scroll-all-beginning-of-buffer-all))
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
120 ((eq this-command 'end-of-buffer)
5d3c147b760a Whitespace changes.
Richard M. Stallman <rms@gnu.org>
parents: 44725
diff changeset
121 (call-interactively 'scroll-all-end-of-buffer-all))))
44722
c4139de15915 (scroll-all-page-down-all, scroll-all-page-up-all): Ignore the error if one
Glenn Morris <rgm@gnu.org>
parents: 44721
diff changeset
122
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123
33422
c8f856ed18d0 (scroll-all-mode): Customize variable. Add
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
124 ;;;###autoload
17598
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
125 (defun scroll-all-mode (arg)
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
126 "Toggle Scroll-All minor mode."
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 (interactive "P")
17598
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
128 (setq scroll-all-mode (not scroll-all-mode))
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 (cond
17598
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
130 ((eq scroll-all-mode 't)
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
131 (add-hook 'post-command-hook 'scroll-all-check-to-scroll))
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
132 ((eq scroll-all-mode 'nil)
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
133 (remove-hook 'post-command-hook 'scroll-all-check-to-scroll))))
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134
17598
b3016633740a Renamed from scroll-lock.el.
Richard M. Stallman <rms@gnu.org>
parents: 17597
diff changeset
135 (provide 'scroll-all)
17597
a60da52b8ea2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 33422
diff changeset
137 ;;; scroll-all.el ends here