-;;; follow.el --- Minor mode, Synchronize windows showing the same buffer.
+;;; follow.el --- synchronize windows showing the same buffer
-;; Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
+;; Copyright (C) 1995, 1996, 1997, 1999, 2001 Free Software Foundation, Inc.
-;; Author: Anders Lindgren <andersl@csd.uu.se>
-;; Maintainer: Anders Lindgren <andersl@csd.uu.se>
-;; Created: 25 May 1995
-;; Version: 1.7
-;; Keywords: display, window, minor-mode
-;; Date: 4 Jun 1997
+;; Author: Anders Lindgren <andersl@andersl.com>
+;; Maintainer: Anders Lindgren <andersl@andersl.com>
+;; Created: 1995-05-25
+;; Keywords: display, window, minor-mode, convenience
+;; Last Changed: 1999-11-17
;; This file is part of GNU Emacs.
;;{{{ Documentation
-;; `Follow mode' is a minor mode for Emacs 19 and XEmacs which
+;; `Follow mode' is a minor mode for Emacs and XEmacs that
;; combines windows into one tall virtual window.
;;
;; The feeling of a "virtual window" has been accomplished by the use
;; makes it possible to walk between windows using normal cursor
;; movement commands.
;;
-;; Follow mode comes to its prime when used on a large screen and two
+;; Follow mode comes to its prime when a large screen and two
;; side-by-side window are used. The user can, with the help of Follow
;; mode, use two full-height windows as though they would have been
;; one. Imagine yourself editing a large function, or section of text,
;; and being able to use 144 lines instead of the normal 72... (your
;; mileage may vary).
-;; The latest version, and a demonstration, are avaiable at:
-;;
-;; ftp://ftp.csd.uu.se/pub/users/andersl/emacs/follow.el
-;; http://www.csd.uu.se/~andersl/follow.shtml
-
-;; `Follow mode' can be used together with Emacs 19 and XEmacs.
-;; It has been tested together with Emacs 19.27, 19.28, 19.29,
-;; 19.30, XEmacs 19.12, and 19.13.
-
-
;; To test this package, make sure `follow' is loaded, or will be
;; autoloaded when activated (see below). Then do the following:
;;
-;; * Find your favorite file (preferably a long one.)
+;; * Find your favorite file (preferably a long one).
;;
-;; * Resize Emacs so that it will be wide enough for two full sized
-;; columns. Delete the other windows and split with the commands
-;; `C-x 1 C-x 3'.
+;; * Resize Emacs so that it will be wide enough for two full size
+;; columns. Delete the other windows and split the window with
+;; the commands `C-x 1 C-x 3'.
;;
;; * Give the command:
;; M-x follow-mode <RETURN>
;; to turn it off.
-;; Installation:
-;;
-;; To fully install this, add this file to your Emacs Lisp directory and
-;; compile it with M-x byte-compile-file. Then add the following to the
-;; appropriate init file (normally your `~/.emacs' file):
-;;
-;; (autoload 'follow-mode "follow"
-;; "Synchronize windows showing the same buffer, minor mode." t)
-
-
;; The command `follow-delete-other-windows-and-split' maximises the
;; visible area of the current buffer.
;;
;; key map. To do so, add the following lines (replacing `[f7]' and
;; `[f8]' with your favorite keys) to the init file:
;;
-;; (autoload 'follow-mode "follow"
-;; "Synchronize windows showing the same buffer, minor mode." t)
;; (global-set-key [f8] 'follow-mode)
-;;
-;; (autoload 'follow-delete-other-windows-and-split "follow"
-;; "Delete other windows, split the frame in two, and enter Follow Mode." t)
;; (global-set-key [f7] 'follow-delete-other-windows-and-split)
-;; There exists two system variables which controls the appearence of
-;; lines which are wider than the window containing them. The default
+;; There exists two system variables that controls the appearence of
+;; lines that are wider than the window containing them. The default
;; is to truncate long lines whenever a window isn't as wide as the
;; frame.
;;
;; The correct way to cofigurate Follow mode, or any other mode for
-;; that matter, is to create one (or more) function which does
+;; that matter, is to create one (or more) function that does
;; whatever you would like to do. The function is then added to
;; a hook.
;;
;; When `Follow' mode is activated, functions stored in the hook
;; `follow-mode-hook' are called. When it is deactivated
-;; `follow-mode-off-hook' is runed.
+;; `follow-mode-off-hook' is run.
;;
;; The keymap `follow-key-map' contains key bindings activated by
;; `follow-mode'.
;; Usage:
;;
-;; To activate give the command: M-x follow-mode
+;; To activate issue the command "M-x follow-mode"
;; and press return. To deactivate, do it again.
;;
-;; Some special commands have been developed to make life even easier:
+;; The following is a list of commands useful when follow-mode is active.
+;;
;; follow-scroll-up C-c . C-v
;; Scroll text in a Follow Mode window chain up.
;;
;; Implementation:
;;
;; In an ideal world, follow mode would have been implemented in the
-;; kernal of the display routines, making sure that the windows (in
+;; kernel of the display routines, making sure that the windows (using
;; follow mode) ALWAYS are aligned. On planet earth, however, we must
;; accept a solution where we ALMOST ALWAYS can make sure that the
;; windows are aligned.
;; 3) When a scrollbar has been moved.
;;
;; This will cover most situations. (Let me know if there are other
-;; situations which should be covered.)
+;; situations that should be covered.)
;;
-;; However, only the selected window is checked, for the reason of
-;; efficiency and code complexity. (i.e. it is possible to make a
+;; Note that only the selected window is checked, for the reason of
+;; efficiency and code complexity. (I.e. it is possible to make a
;; non-selected windows unaligned. It will, however, pop right back
;; when it is selected.)
-;;}}}
-;;{{{ Change Log
-
-;;; Change log:
-;; 25-May-95 andersl * File created.
-;; 26-May-95 andersl * It works!
-;; 27-May-95 andersl * Avoids hitting the head in the roof.
-;; * follow-scroll-up, -scroll-down, and -recenter.
-;; * V0.1 Sent to Ohio.
-;; 28-May-95 andersl * Scroll-bar support added.
-;; 30-May-95 andersl * Code adopted to standard style.
-;; * Minor mode keymap.
-;; 2-Jun-95 andersl * Processor output.
-;; 3-Jun-95 andersl * V0.4
-;; 5-Jun-95 andersl * V0.5. Copyright notice corrected.
-;; (The old one stated that I had copyright, but
-;; that Emacs could be freely distributed ;-) )
-;; 6-Jun-95 andersl * Lucid support added. (no longer valid.)
-;; 7-Jun-95 andersl * Menu bar added.
-;; * Bug fix, (at-window 0 0) => (frame-first-window)
-;; 15-Jun-95 andersl * 0.8 Major rework. looong lines and outline mode.
-;; 18-Jun-95 andersl * 0.9 Allow a tail window to be selected, but pick
-;; a better one when edited.
-;; 26-Jun-95 andersl * Inlineing.
-;; 02-Jul-95 andersl * compute-motion imitated with a ugly workaround,
-;; Works with XEmacs again!
-;; 15-Jul-95 andersl * find-file hook.
-;; * submit-feedback.
-;; * Survives major mode changes.
-;; * Region spanning multiple windows looks
-;; reasonably good.
-;; 19-Jul-95 andersl * New process-filter handling.
-;; 1-Aug-95 andersl * XEmacs scrollbar support.
-;; * Emacs 19 `window-size-change' support.
-;; * `save-window-excursion' removed, it triggered
-;; a redraw!
-;; 5-Aug-95 andersl * `follow-switch-to-current-buffer-all' added.
-;; 16-Nov-95 andersl * V1.0 released!
-;; 17-Nov-95 andersl * Byte compiler silencer for XEmacs broken.
-;; * fkey-end-of-buffer treated the same way
-;; end-of-buffer is.
-;; * follow-mode-off-hook added.
-;; (Suggested by David Hughes, thanks!)
-;; 20-Nov-95 andersl * Bug in menu code corrected.
-;; (Reported by Robert E. Brown, thanks!)
-;; 5-Dec-95 andersl * `follow-avoid-tail-recenter' added to the
-;; post-command-idle-hook to avoid recentering
-;; caused by `paren' et. al.
-;; 7-Dec-95 andersl * `follow-avoid-tail-recenter' called by
-;; `window-scroll-functions'.
-;; 18-Dec-95 andersl * All processes intercepted.
-;; 20-Dec-95 andersl * `follow-recenter' accepts arguments.
-;; * `move-overlay' advices, drag-region works.
-;; 2-Jan-96 andersl * XEmacs: isearch fixed.
-;; * `follow-calc-win-end' created.
-;; 8-Jan-96 andersl * XEmacs: `window-end' with `guarantee'
-;; argument used in `follow-calc-win-end'.
-;; 9-Jan-96 andersl * `follow-end-of-buffer' added.
-;; Code in post hook removed.
-;; * XEmacs: Post hook is always executed
-;; after a mouse button event.
-;; 22-Jan-96 andersl * 1.5 released.
-;;
-
-;;}}}
-;;{{{ LCD Entry
-
-;;; LCD Archive Entry:
-;; follow|Anders Lindgren|andersl@csd.uu.se|
-;; Combines windows into tall virtual window, minor mode.
-;; 20-Feb-1996|1.6|~/modes/follow.el.Z|
-
;;}}}
;;; Code:
;; (funcall (symbol-function 'set) 'bar ...)
;;
;; Note: When this file is interpreted, `eval-when-compile' is
-;; evaluted (really smart...) Since it doesn't hurt to evaluate it,
-;; but it is a bit annoying, we test if the byte-compiler has been
-;; loaded. This can, of course, lead to some occasional unintended
-;; evaluation...
+;; evaluted. Since it doesn't hurt to evaluate it, but it is a bit
+;; annoying, we test if the byte-compiler has been loaded. This can,
+;; of course, lead to some occasional unintended evaluation...
;;
;; Should someone come up with a better solution, please let me
;; know.
(defgroup follow nil
"Synchronize windows showing the same buffer."
:prefix "follow-"
- :group 'windows)
+ :group 'windows
+ :group 'convenience)
(defvar follow-mode nil
"Variable indicating if Follow mode is active.")
:type 'hook
:group 'follow)
-(defvar follow-mode-version "follow.el (Release 1.6)"
- "The current version of Follow mode.")
-
(defvar follow-mode-map nil
"*Minor mode keymap for Follow mode.")
:type 'string
:group 'follow)
-(defcustom follow-intercept-processes t
+(defcustom follow-intercept-processes
+ (fboundp 'start-process)
"*When non-nil, Follow Mode will monitor process output."
:type 'boolean
:group 'follow)
(not follow-emacs-version-xemacs-p)
"*When non-nil, patch emacs so that tail windows won't be recentered.
-A \"tail window\" is a window which displays only the end of
+A \"tail window\" is a window that displays only the end of
the buffer. Normally it is practical for the user that empty
windows are recentered automatically. However, when using
Follow Mode it breaks the display when the end is displayed
(defvar follow-cache-command-list
'(next-line previous-line forward-char backward-char)
- "List of commands which don't require recalculation.
+ "List of commands that don't require recalculation.
In order to be able to use the cache, a command should not change the
contents of the buffer, nor should it change selected window or current
(eval-when-compile (require 'reporter))
(defun follow-submit-feedback ()
- "Submit feedback on Follow mode to the author: andersl@csd.uu.se"
+ "Submit feedback on Follow mode to the author: andersl@andersl.com"
(interactive)
(require 'reporter)
(and (y-or-n-p "Do you really want to submit a report on Follow mode? ")
(reporter-submit-bug-report
- "Anders Lindgren <andersl@csd.uu.se>"
- follow-mode-version
+ "Anders Lindgren <andersl@andersl.com>"
+ "follow.el"
'(post-command-hook
post-command-idle-hook
pre-command-hook
;;{{{ Debug messages
;; This inline function must be as small as possible!
-;; Maybe we should define a macro which expands to nil if
+;; Maybe we should define a macro that expands to nil if
;; the variable is not set.
(defsubst follow-debug-message (&rest args)
(define-key follow-mode-map follow-mode-prefix map)
;; Replace the standard `end-of-buffer', when in Follow Mode. (I
- ;; don't see the point in trying to replace every function which
+ ;; don't see the point in trying to replace every function that
;; could be enhanced in Follow mode. End-of-buffer is a special
;; case since it is very simple to define and it greatly enhances
;; the look and feel of Follow mode.)
(if (not follow-emacs-version-xemacs-p)
;;
- ;; Emacs 19
+ ;; Emacs
;;
(let ((menumap (funcall (symbol-function 'make-sparse-keymap)
"Follow"))
;; Why not just `(set-buffer-menubar current-menubar)'? The
;; question is a very good question. The reason is that under
- ;; Emacs 19, neither `set-buffer-menubar' nor
+ ;; Emacs, neither `set-buffer-menubar' nor
;; `current-menubar' is defined, hence the byte-compiler will
;; warn.
(funcall (symbol-function 'set-buffer-menubar)
;;;###autoload
(defun follow-mode (arg)
- "Minor mode which combines windows into one tall virtual window.
+ "Minor mode that combines windows into one tall virtual window.
The feeling of a \"virtual window\" has been accomplished by the use
of two major techniques:
(if (eq end (point-max))
(signal 'end-of-buffer nil)
(select-window (car windows))
- (goto-char end)
+ ;; `window-end' might return nil.
+ (if end
+ (goto-char end))
(vertical-motion (- next-screen-context-lines))
(set-window-start (car windows) (point)))))))
(cons pred (cdr windows))))
-;; Try to optimize this function for speed!
+;; This function is optimized function for speed!
(defun follow-calc-win-end (&optional win)
"Calculate the presumed window end for WIN.
(window-buffer win)))
(list end t)
(list (+ end 1) nil)))
- ;; Emacs 19: We have to calculate the end by ourselves.
- ;; This code works on both XEmacs and Emacs 19, but now
+ ;; Emacs: We have to calculate the end by ourselves.
+ ;; This code works on both XEmacs and Emacs, but now
;; that XEmacs has got custom-written code, this could
- ;; be optimized for Emacs 19.
+ ;; be optimized for Emacs.
(let ((orig-win (and win (selected-window)))
height
buffer-end-p)
Return the selected window."
(let ((win nil))
(while (and (not win) win-start-end)
- ;; Don't select a window which was just moved. This makes it
+ ;; Don't select a window that was just moved. This makes it
;; possible to later select the last window after a `end-of-buffer'
;; command.
(if (follow-pos-visible dest (car (car win-start-end)) win-start-end)
;; it wasn't just moved here. (i.e. M-> shall not unconditionally place
;; the point in the selected window.)
;;
-;; (Compability cludge: in Emacs 19 `window-end' is equal to `point-max';
+;; (Compability cludge: in Emacs `window-end' is equal to `point-max';
;; in XEmacs, it is equal to `point-max + 1'. Should I really bother
;; checking `window-end' now when I check `end-of-buffer' explicitly?)
"Select and return a window, if end is visible in it."
(let ((win nil))
(while (and (not win) win-start-end)
- ;; Don't select a window which was just moved. This makes it
+ ;; Don't select a window that was just moved. This makes it
;; possible to later select the last window after a `end-of-buffer'
;; command.
(if (and (eq (point-max) (nth 2 (car win-start-end)))
(nth 3 (car win-start-end))
- (eq (point-max) (min (point-max)
- (window-end (car (car win-start-end))))))
+ ;; `window-end' might return nil.
+ (let ((end (window-end (car (car win-start-end)))))
+ (and end
+ (eq (point-max) (min (point-max) end)))))
(progn
(setq win (car (car win-start-end)))
(select-window win)))
win))
-;; Select a window which will display the point if the windows would
+;; Select a window that will display the point if the windows would
;; be redisplayed with the first window fixed. This is useful for
;; example when the user has pressed return at the bottom of a window
;; as the point is not visible in any window.
(defun follow-avoid-tail-recenter (&rest rest)
"Make sure windows displaying the end of a buffer aren't recentered.
-This is done by reading and rewriting the start positon of
+This is done by reading and rewriting the start position of
non-first windows in Follow Mode."
(if follow-avoid-tail-recenter-p
(let* ((orig-buffer (current-buffer))
(or follow-internal-force-redisplay
(progn
(if (eq dest (point-max))
- ;; We're at the end, we have be be careful since
+ ;; We're at the end, we have to be careful since
;; the display can be aligned while `dest' can
;; be visible in several windows.
(cond
(setq visible t)
(setq aligned nil))
;; If we can position the cursor without moving the first
- ;; window, do it. This is the case which catches `RET'
+ ;; window, do it. This is the case that catches `RET'
;; at the bottom of a window.
((follow-select-if-visible-from-first dest windows)
(follow-debug-message "Below first")
(cond ((fboundp 'scroll-bar-drag)
;;;
- ;;; Emacs 19 style scrollbars.
+ ;;; Emacs style scrollbars.
;;;
;; Select the dragged window if it is a follower of the
scroll-bar-set-window-start)))
(while cmds
(eval
- (` (defadvice (, (intern (symbol-name (car cmds))))
+ `(defadvice ,(intern (symbol-name (car cmds)))
(after
- (, (intern (concat "follow-" (symbol-name (car cmds)))))
+ ,(intern (concat "follow-" (symbol-name (car cmds))))
activate)
"Adviced by Follow Mode."
- (follow-redraw-after-event (ad-get-arg 0)))))
+ (follow-redraw-after-event (ad-get-arg 0))))
(setq cmds (cdr cmds))))
(while cmds
(eval
- (` (defadvice (, (intern (symbol-name (car cmds))))
+ `(defadvice ,(intern (symbol-name (car cmds)))
(after
- (, (intern (concat "follow-" (symbol-name (car cmds)))))
+ ,(intern (concat "follow-" (symbol-name (car cmds))))
activate)
"Adviced by `follow-mode'."
- (follow-xemacs-scrollbar-support (ad-get-arg 0)))))
+ (follow-xemacs-scrollbar-support (ad-get-arg 0))))
(setq cmds (cdr cmds))))
;;}}}
;;{{{ Process output
-;;; The following sections installs a spy which listens to process
+;;; The following sections installs a spy that listens to process
;;; output and tries to reposition the windows whose buffers are in
;;; Follow mode. We play safe as much as possible...
;;;
;;; When follow-mode is activated all active processes are
-;;; intercepted. All new processes which change their filter function
+;;; intercepted. All new processes that change their filter function
;;; using `set-process-filter' are also intercepted. The reason is
;;; that a process can cause a redisplay recentering "tail" windows.
;;; Note that it doesn't hurt to spy on more processes than needed.
;;; output filter. It also makes sure that the windows connected to
;;; the buffer are aligned.
;;;
-;;; Discussion: How do we find processes which don't call
+;;; Discussion: How do we find processes that don't call
;;; `set-process-filter'? (How often are processes created in a
;;; buffer after Follow mode are activated?)
;;;
;;{{{ Start/stop interception of processes.
;; Normally, all new processed are intercepted by our `set-process-filter'.
-;; This is needed to intercept old processed which were started before we were
+;; This is needed to intercept old processed that were started before we were
;; loaded, and processes we have forgotten by calling
;; `follow-stop-intercept-process-output'.
(if (not (marker-buffer (process-mark proc)))
(set-marker (process-mark proc) (point-max)))
(let ((moving (= (point) (process-mark proc)))
- (odeactivate (and (boundp 'deactivate-mark)
- (symbol-value 'deactivate-mark)))
- (old-buffer-read-only buffer-read-only))
- (setq buffer-read-only nil)
+ deactivate-mark
+ (inhibit-read-only t))
(save-excursion
(goto-char (process-mark proc))
;; `insert-before-markers' just in case the users next
;; command is M-y.
(insert-before-markers output)
(set-marker (process-mark proc) (point)))
- (if moving (goto-char (process-mark proc)))
- (if (boundp 'deactivate-mark)
- ;; This could really be
- ;; (setq deactivate-mark odeactivate)
- ;; but this raises an error when compiling on XEmacs.
- (funcall (symbol-function 'set)
- 'deactivate-mark odeactivate))
- (setq buffer-read-only old-buffer-read-only)))))
+ (if moving (goto-char (process-mark proc)))))))
;; If we're in follow mode, do our stuff. Select a new window and
;; redisplay. (Actually, it is redundant to check `buf', but I
(new-window-start (window-start win))
(new-window-point (window-point win)))
(cond
- ;; The window was moved. Move it back and
- ;; select a new. If no better could be found,
- ;; we stick the the new start position. This
- ;; is used when the original process filter
- ;; tries to position the cursor at the bottom
- ;; of the window. Example: `lyskom'.
+ ;; The start of the selected window was repositioned.
+ ;; Try to use the original start position and continue
+ ;; working with a window to the "right" in the window
+ ;; chain. This will create the effect that the output
+ ;; starts in one window and continues into the next.
+
+ ;; If the display has changed so much that it is not
+ ;; possible to keep the original window fixed and still
+ ;; display the point then we give up and use the new
+ ;; window start.
+
+ ;; This case is typically used when the process filter
+ ;; tries to reposition the start of the window in order
+ ;; to view the tail of the output.
((not (eq orig-window-start new-window-start))
(follow-debug-message "filter: Moved")
(set-window-start win orig-window-start)
;; called every time a window in a frame changes size. Most notably, it
;; is called after the frame has been resized.
;;
-;; We basically call our post-command-hook for every buffer which is
+;; We basically call our post-command-hook for every buffer that is
;; visible in any window in the resized frame, which is in follow-mode.
;;
;; Since this function can be called indirectly from
(add-hook 'window-scroll-functions 'follow-avoid-tail-recenter t))
-;; This prevents all packages which calls `sit-for' directly
+;; This prevents all packages that calls `sit-for' directly
;; to recenter tail windows.
(if follow-avoid-tail-recenter-p
;; | save it". -- Douglas Adams, "Last Chance to See" |
;; \------------------------------------------------------------------------/
+;;; arch-tag: 7b16bb1a-808c-4991-a8cc-66d3822936d0
;;; follow.el ends here