*** empty log message ***
[bpt/emacs.git] / lisp / scroll-all.el
index 3a9e019..af6760f 100644 (file)
@@ -1,16 +1,17 @@
 ;;; scroll-all.el --- scroll all buffers together minor mode
 
-;; Copyright (C) 1997 Free Software Foundation, Inc.
+;; Copyright (C) 1997, 2001, 2002, 2003, 2004, 2005,
+;;   2006, 2007, 2008 Free Software Foundation, Inc.
 
 ;; Author: Gary D. Foster <Gary.Foster@corp.sun.com>
 ;; Keywords: scroll crisp brief lock
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 ;;    This mode allows multiple buffers to be 'locked' so that scrolling
 ;;    up or down lines in any buffer causes all the buffers to mirror
 ;;    the scrolling.  It hooks into the post-command-hook to check for
 ;;    potential scrolling commands and if we're locked, mirrors them in all
-;;    windows. This allows us to grab line-at-a-time scrolling as well as
+;;    windows.  This allows us to grab line-at-a-time scrolling as well as
 ;;    screen-at-a-time scrolling, and doesn't remap any of the keyboard
 ;;    commands to do it.
 
 
 ;;; Code:
 
-(defvar running-xemacs (string-match "XEmacs\\|Lucid" emacs-version))
-
-;;;###autoload
-(defcustom scroll-all-mode nil
-  "Control/track scroll locking.
-
-Setting this variable directly does not take effect;
-use either M-x customize or the function `scroll-all-mode'."
-  :set (lambda (symbol value) (scroll-all-mode (if value 1 0)))
-  :initialize 'custom-initialize-default
-  :require 'scroll-all
-  :type 'boolean
-  :group 'windows)
-
-(if running-xemacs
-    (add-minor-mode 'scroll-all-mode " *SL*")
-  (or (assq 'scroll-all-mode minor-mode-alist)
-      (setq minor-mode-alist
-           (cons '(scroll-all-mode " *SL*") minor-mode-alist))))
-
-(defun scroll-all-scroll-down-all (arg)
-  "Scroll down all visible windows."
-  (interactive "P")
+(defun scroll-all-function-all (func arg)
+  "Apply function FUNC with argument ARG to all visible windows."
   (let ((num-windows (count-windows))
        (count 1))
     (when (> num-windows 1)
       (other-window 1)
       (while (< count num-windows)
-       (if (not (eq (point) (point-max)))
-           (call-interactively 'next-line))
+       (condition-case nil
+           (funcall func arg)
+         ;; Ignore beginning- or end-of-buffer error in other windows.
+         (error nil)
+         )
        (other-window 1)
        (setq count (1+ count))))))
 
+(defun scroll-all-scroll-down-all (arg)
+  "Scroll down in all visible windows."
+  (interactive "p")
+  (scroll-all-function-all 'next-line arg))
+
 (defun scroll-all-scroll-up-all (arg)
-  "Scroll up all visible windows."
-  (interactive "P")
-  (let ((num-windows (count-windows))
-       (count 1))
-    (when (> num-windows 1)
-      (other-window 1)
-      (while (< count num-windows)
-       (if (not (eq (point) (point-min)))
-           (call-interactively 'previous-line))
-       (other-window 1)
-       (setq count (1+ count))))))
+  "Scroll up in all visible windows."
+  (interactive "p")
+  (scroll-all-function-all 'previous-line arg))
 
 (defun scroll-all-page-down-all (arg)
   "Page down in all visible windows."
   (interactive "P")
-  (let ((num-windows (count-windows))
-       (count 1))
-    (when (> num-windows 1)
-      (other-window 1)
-      (while (< count num-windows)
-       (condition-case nil
-           (call-interactively 'scroll-up) (end-of-buffer nil))
-       (other-window 1)
-       (setq count (1+ count))))))
+  (scroll-all-function-all 'scroll-up arg))
 
 (defun scroll-all-page-up-all (arg)
   "Page up in all visible windows."
   (interactive "P")
-  (let ((num-windows (count-windows))
-       (count 1))
-    (when (> num-windows 1)
-      (other-window 1)
-      (while (< count num-windows)
-       (condition-case nil
-           (call-interactively 'scroll-down) (beginning-of-buffer nil))
-       (other-window 1)
-       (setq count (1+ count))))))
+  (scroll-all-function-all 'scroll-down arg))
 
 (defun scroll-all-beginning-of-buffer-all (arg)
   "Go to the beginning of the buffer in all visible windows."
   (interactive "P")
-  (let ((num-windows (count-windows))
-       (count 1))
-    (when (> num-windows 1)
-      (other-window 1)
-      (while (< count num-windows)
-       (call-interactively 'beginning-of-buffer)
-       (other-window 1)
-       (setq count (1+ count))))))
+  (scroll-all-function-all 'beginning-of-buffer arg))
 
 (defun scroll-all-end-of-buffer-all (arg)
   "Go to the end of the buffer in all visible windows."
   (interactive "P")
-  (let ((num-windows (count-windows))
-       (count 1))
-    (when (> num-windows 1)
-      (other-window 1)
-      (while (< count num-windows)
-       (call-interactively 'end-of-buffer)
-       (other-window 1)
-       (setq count (1+ count))))))
+  (scroll-all-function-all 'end-of-buffer arg))
 
 
 (defun scroll-all-check-to-scroll ()
@@ -150,19 +98,23 @@ use either M-x customize or the function `scroll-all-mode'."
         (call-interactively 'scroll-all-beginning-of-buffer-all))
        ((eq this-command 'end-of-buffer)
         (call-interactively 'scroll-all-end-of-buffer-all))))
+
 
 ;;;###autoload
-(defun scroll-all-mode (arg)
-  "Toggle Scroll-All minor mode."
-  (interactive "P")
-  (setq scroll-all-mode (not scroll-all-mode))
-  (cond
-   ((eq scroll-all-mode 't)
-    (add-hook 'post-command-hook 'scroll-all-check-to-scroll))
-   ((eq scroll-all-mode 'nil)
-    (remove-hook 'post-command-hook 'scroll-all-check-to-scroll))))
+(define-minor-mode scroll-all-mode
+  "Toggle Scroll-All minor mode.
+With ARG, turn Scroll-All minor mode on if ARG is positive, off otherwise.
+When Scroll-All mode is on, scrolling commands entered in one window
+apply to all visible windows in the same frame."
+  nil " *SL*" nil
+  :global t
+  :group 'windows
+  :group 'scrolling
+  (if scroll-all-mode
+      (add-hook 'post-command-hook 'scroll-all-check-to-scroll)
+    (remove-hook 'post-command-hook 'scroll-all-check-to-scroll)))
 
 (provide 'scroll-all)
 
+;; arch-tag: db20089a-b157-45df-b5d4-2430e60acdd8
 ;;; scroll-all.el ends here