follow.el 73.7 KB
Newer Older
1
;;; follow.el --- synchronize windows showing the same buffer
Karl Heuer's avatar
Karl Heuer committed
2

3
;; Copyright (C) 1995, 1996, 1997, 1999, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007 Free Software Foundation, Inc.
Karl Heuer's avatar
Karl Heuer committed
5

6
;; Author: Anders Lindgren <andersl@andersl.com>
Richard M. Stallman's avatar
Richard M. Stallman committed
7
;; Maintainer: FSF (Anders' email bounces, Sep 2005)
8
;; Created: 1995-05-25
Dan Nicolaescu's avatar
Dan Nicolaescu committed
9
;; Keywords: display, window, minor-mode, convenience
Karl Heuer's avatar
Karl Heuer committed
10

Richard M. Stallman's avatar
Richard M. Stallman committed
11 12 13
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
Karl Heuer's avatar
Karl Heuer committed
14
;; it under the terms of the GNU General Public License as published by
15
;; the Free Software Foundation; either version 3, or (at your option)
Karl Heuer's avatar
Karl Heuer committed
16 17
;; any later version.

Richard M. Stallman's avatar
Richard M. Stallman committed
18
;; GNU Emacs is distributed in the hope that it will be useful,
Karl Heuer's avatar
Karl Heuer committed
19 20 21 22 23
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Richard M. Stallman's avatar
Richard M. Stallman committed
24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Karl Heuer's avatar
Karl Heuer committed
27 28 29 30 31

;;; Commentary:

;;{{{ Documentation

32
;; `Follow mode' is a minor mode for Emacs and XEmacs that
Karl Heuer's avatar
Karl Heuer committed
33 34 35 36 37
;; combines windows into one tall virtual window.
;;
;; The feeling of a "virtual window" has been accomplished by the use
;; of two major techniques:
;;
38
;; * The windows always displays adjacent sections of the buffer.
Karl Heuer's avatar
Karl Heuer committed
39 40 41
;;   This means that whenever one window is moved, all the
;;   others will follow.  (Hence the name Follow Mode.)
;;
42 43 44
;; * Should the point (cursor) end up outside a window, another
;;   window displaying that point is selected, if possible.  This
;;   makes it possible to walk between windows using normal cursor
Karl Heuer's avatar
Karl Heuer committed
45 46
;;   movement commands.
;;
47
;; Follow mode comes to its prime when a large screen and two
48
;; side-by-side window are used.  The user can, with the help of Follow
Karl Heuer's avatar
Karl Heuer committed
49
;; mode, use two full-height windows as though they would have been
50
;; one.  Imagine yourself editing a large function, or section of text,
51
;; and being able to use 144 lines instead of the normal 72... (your
Karl Heuer's avatar
Karl Heuer committed
52 53 54
;; mileage may vary).

;; To test this package, make sure `follow' is loaded, or will be
55
;; autoloaded when activated (see below).  Then do the following:
Karl Heuer's avatar
Karl Heuer committed
56
;;
57
;; * Find your favorite file (preferably a long one).
Karl Heuer's avatar
Karl Heuer committed
58
;;
59 60 61
;; * 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'.
Karl Heuer's avatar
Karl Heuer committed
62 63 64 65 66 67 68 69 70 71 72
;;
;; * Give the command:
;;	M-x follow-mode <RETURN>
;;
;; * Now the display should look something like (assuming the text "71"
;;   is on line 71):
;;
;;		    +----------+----------+
;;		    |1         |73        |
;;		    |2         |74        |
;;		    |3         |75        |
73
;;		         ...        ...
Karl Heuer's avatar
Karl Heuer committed
74 75 76 77 78
;;		    |71        |143       |
;;		    |72        |144       |
;;		    +----------+----------+
;;
;;   As you can see, the right-hand window starts at line 73, the line
79
;;   immediately below the end of the left-hand window.  As long as
Karl Heuer's avatar
Karl Heuer committed
80 81 82
;;   `follow-mode' is active, the two windows will follow eachother!
;;
;; * Play around and enjoy! Scroll one window and watch the other.
83 84 85
;;   Jump to the beginning or end.  Press `Cursor down' at the last
;;   line of the left-hand window.  Enter new lines into the
;;   text.  Enter long lines spanning several lines, or several
Karl Heuer's avatar
Karl Heuer committed
86 87 88
;;   windows.
;;
;; * Should you find `Follow' mode annoying, just type
89
;;	M-x follow-mode <RETURN>
Karl Heuer's avatar
Karl Heuer committed
90 91 92 93 94 95 96 97 98 99 100 101 102 103
;;   to turn it off.


;; The command `follow-delete-other-windows-and-split' maximises the
;; visible area of the current buffer.
;;
;; I recommend adding it, and `follow-mode', to hotkeys in the global
;; key map.  To do so, add the following lines (replacing `[f7]' and
;; `[f8]' with your favorite keys) to the init file:
;;
;; (global-set-key [f8] 'follow-mode)
;; (global-set-key [f7] 'follow-delete-other-windows-and-split)


104 105
;; There exists two system variables that controls the appearence of
;; lines that are wider than the window containing them.  The default
106 107
;; is to truncate long lines whenever a window isn't as wide as the
;; frame.
Karl Heuer's avatar
Karl Heuer committed
108 109 110 111 112 113 114 115
;;
;; To make sure lines are never truncated, please place the following
;; lines in your init file:
;;
;; (setq truncate-lines nil)
;; (setq truncate-partial-width-windows nil)


116 117 118 119 120 121 122 123 124
;; Since the display of XEmacs is pixel-oriented, a line could be
;; clipped in half at the bottom of the window.
;;
;; To make XEmacs avoid clipping (normal) lines, please place the
;; following line in your init-file:
;;
;; (setq pixel-vertical-clip-threshold 30)


Karl Heuer's avatar
Karl Heuer committed
125
;; The correct way to cofigurate Follow mode, or any other mode for
126
;; that matter, is to create one (or more) function that does
Karl Heuer's avatar
Karl Heuer committed
127 128 129 130 131
;; 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
Richard M. Stallman's avatar
Richard M. Stallman committed
132
;; `follow-mode-off-hook' is run.
Karl Heuer's avatar
Karl Heuer committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146
;;
;; The keymap `follow-key-map' contains key bindings activated by
;; `follow-mode'.
;;
;; Example:
;; (add-hook 'follow-mode-hook 'my-follow-mode-hook)
;;
;; (defun my-follow-mode-hook ()
;;    (define-key follow-mode-map "\C-ca" 'your-favorite-function)
;;    (define-key follow-mode-map "\C-cb" 'another-function))


;; Usage:
;;
147
;; To activate issue the command "M-x follow-mode"
148
;; and press return.  To deactivate, do it again.
Karl Heuer's avatar
Karl Heuer committed
149
;;
150 151
;; The following is a list of commands useful when follow-mode is active.
;;
Karl Heuer's avatar
Karl Heuer committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
;;	follow-scroll-up			 C-c . C-v
;;		Scroll text in a Follow Mode window chain up.
;;
;;	follow-scroll-down			 C-c . v
;;		Like `follow-scroll-up', but in the other direction.
;;
;;	follow-delete-other-windows-and-split	 C-c . 1
;;		Maximise the visible area of the current buffer,
;;		and enter Follow Mode. 	This is a very convenient
;;		way to start Follow Mode, hence it is recomended
;;		that this command is added to the global keymap.
;;
;;	follow-recenter				 C-c . C-l
;;		Place the point in the center of the middle window,
;;		or a specified number of lines from either top or bottom.
;;
;;	follow-switch-to-buffer			 C-c . b
;;		Switch buffer in all windows displaying the current buffer
;;		in this frame.
;;
;;	follow-switch-to-buffer-all		 C-c . C-b
;;		Switch buffer in all windows in the active frame.
;;
;;	follow-switch-to-current-buffer-all
;;		Show the current buffer in all windows on the current
;;		frame and turn on `follow-mode'.
;;
;;	follow-first-window			 C-c . <
;;		Select the first window in the frame showing the same buffer.
;;
;;	follow-last-window			 C-c . >
;;		Select the last window in the frame showing the same buffer.
;;
;;	follow-next-window			 C-c . n
;;		Select the next window in the frame showing the same buffer.
;;
;;	follow-previous-window			 C-c . p
;;		Select the previous window showing the same buffer.


;; Well, it seems ok, but what if I really want to look at two different
;; positions in the text? Here are two simple methods to use:
;;
;; 1) Use multiple frames; `follow' mode only affects windows displayed
;;    in the same frame. (My apoligies to you who can't use frames.)
;;
;; 2) Bind `follow-mode' to key so you can turn it off whenever
199
;;    you want to view two locations.  Of course, `follow' mode can
Karl Heuer's avatar
Karl Heuer committed
200 201 202 203 204 205
;;    be reactivated by hitting the same key again.
;;
;;    Example from my ~/.emacs:
;;	(global-set-key [f8] 'follow-mode)


206
;; Implementation:
Karl Heuer's avatar
Karl Heuer committed
207 208
;;
;; In an ideal world, follow mode would have been implemented in the
209
;; kernel of the display routines, making sure that the windows (using
210
;; follow mode) ALWAYS are aligned.  On planet earth, however, we must
Karl Heuer's avatar
Karl Heuer committed
211 212 213 214 215 216 217 218 219
;; accept a solution where we ALMOST ALWAYS can make sure that the
;; windows are aligned.
;;
;; Follow mode does this in three places:
;; 1) After each user command.
;; 2) After a process output has been perfomed.
;; 3) When a scrollbar has been moved.
;;
;; This will cover most situations. (Let me know if there are other
220
;; situations that should be covered.)
Karl Heuer's avatar
Karl Heuer committed
221
;;
222 223
;; Note that only the selected window is checked, for the reason of
;; efficiency and code complexity. (I.e. it is possible to make a
224
;; non-selected windows unaligned.  It will, however, pop right back
Karl Heuer's avatar
Karl Heuer committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
;; when it is selected.)

;;}}}

;;; Code:

;;{{{ Preliminaries

;; Make the compiler shut up!
;; There are two strategies:
;; 1) Shut warnings off completely.
;; 2) Handle each warning separately.
;;
;; Since I would like to see real errors, I've selected the latter
;; method.
;;
;; The problem with undefined variables and functions has been solved
;; by using `set', `symbol-value' and `symbol-function' rather than
;; `setq' and direct references to variables and functions.
;;
;; For example:
;;	(if (boundp 'foo)   ... (symbol-value 'foo) )
;;	(set 'foo ...)   <-- XEmacs doesn't fall for this one.
;;	(funcall (symbol-function 'set) 'bar ...)
;;
;; Note: When this file is interpreted, `eval-when-compile' is
251 252 253
;; 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...
Karl Heuer's avatar
Karl Heuer committed
254 255 256 257 258 259 260
;;
;; Should someone come up with a better solution, please let me
;; know.

(eval-when-compile
  (if (or (featurep 'bytecomp)
	  (featurep 'byte-compile))
261
      (cond ((featurep 'xemacs)
Karl Heuer's avatar
Karl Heuer committed
262 263 264 265 266 267 268 269 270 271 272 273
	     ;; Make XEmacs shut up!  I'm using standard Emacs
	     ;; functions, they are NOT obsolete!
	     (if (eq (get 'force-mode-line-update 'byte-compile)
		     'byte-compile-obsolete)
		 (put 'force-mode-line-update 'byte-compile 'nil))
	     (if (eq (get 'frame-first-window 'byte-compile)
		     'byte-compile-obsolete)
		 (put 'frame-first-window 'byte-compile 'nil))))))

;;}}}
;;{{{ Variables

Stephen Eglen's avatar
Stephen Eglen committed
274 275 276
(defgroup follow nil
  "Synchronize windows showing the same buffer."
  :prefix "follow-"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
277 278
  :group 'windows
  :group 'convenience)
Stephen Eglen's avatar
Stephen Eglen committed
279 280

(defcustom follow-mode-hook nil
281
  "Hooks to run when Follow mode is turned on."
Stephen Eglen's avatar
Stephen Eglen committed
282 283
  :type 'hook
  :group 'follow)
Karl Heuer's avatar
Karl Heuer committed
284

Stephen Eglen's avatar
Stephen Eglen committed
285
(defcustom follow-mode-off-hook nil
286
  "Hooks to run when Follow mode is turned off."
Stephen Eglen's avatar
Stephen Eglen committed
287 288
  :type 'hook
  :group 'follow)
Karl Heuer's avatar
Karl Heuer committed
289 290


291
;;{{{ Keymap/Menu
Karl Heuer's avatar
Karl Heuer committed
292

293 294 295 296 297 298 299 300 301 302 303 304 305 306
;; Define keys for the follow-mode minor mode map and replace some
;; functions in the global map.  All `follow' mode special functions
;; can be found on (the somewhat cumbersome) "C-c . <key>"
;; (Control-C dot <key>). (As of Emacs 19.29 the keys
;; C-c <punctuation character> are reserved for minor modes.)
;;
;; To change the prefix, redefine `follow-mode-prefix' before
;; `follow' is loaded, or see the section on `follow-mode-hook'
;; above for an example of how to bind the keys the way you like.
;;
;; Please note that the keymap is defined the first time this file is
;; loaded.  Also note that the only legal way to manipulate the
;; keymap is to use `define-key'.  Don't change it using `setq' or
;; similar!
Karl Heuer's avatar
Karl Heuer committed
307

Stephen Eglen's avatar
Stephen Eglen committed
308
(defcustom follow-mode-prefix "\C-c."
309
  "Prefix key to use for follow commands in Follow mode.
Karl Heuer's avatar
Karl Heuer committed
310
The value of this variable is checked as part of loading Follow mode.
Stephen Eglen's avatar
Stephen Eglen committed
311 312 313 314
After that, changing the prefix key requires manipulating keymaps."
  :type 'string
  :group 'follow)

315 316 317
(defvar follow-mode-map
  (let ((mainmap (make-sparse-keymap))
        (map (make-sparse-keymap)))
Karl Heuer's avatar
Karl Heuer committed
318 319 320 321 322 323 324 325 326 327 328 329
    (define-key map "\C-v"	'follow-scroll-up)
    (define-key map "\M-v"	'follow-scroll-down)
    (define-key map "v"		'follow-scroll-down)
    (define-key map "1"		'follow-delete-other-windows-and-split)
    (define-key map "b"		'follow-switch-to-buffer)
    (define-key map "\C-b"	'follow-switch-to-buffer-all)
    (define-key map "\C-l"	'follow-recenter)
    (define-key map "<"		'follow-first-window)
    (define-key map ">"		'follow-last-window)
    (define-key map "n"		'follow-next-window)
    (define-key map "p"		'follow-previous-window)

330
    (define-key mainmap follow-mode-prefix map)
Karl Heuer's avatar
Karl Heuer committed
331 332

    ;; Replace the standard `end-of-buffer', when in Follow Mode.  (I
333
    ;; don't see the point in trying to replace every function that
Karl Heuer's avatar
Karl Heuer committed
334 335 336
    ;; 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.)
337
    (define-key mainmap [remap end-of-buffer] 'follow-end-of-buffer)
Karl Heuer's avatar
Karl Heuer committed
338

339 340
    mainmap)
  "Minor mode keymap for Follow mode.")
Karl Heuer's avatar
Karl Heuer committed
341

342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
;; When the mode is not activated, only one item is visible to activate
;; the mode.
(defun follow-menu-filter (menu)
  (if (bound-and-true-p 'follow-mode)
      menu
    '(["Follow mode    "	follow-mode
       :style toggle :selected follow-mode])))

;; If there is a `tools' menu, we use it.  However, we can't add a
;; minor-mode specific item to it (it's broken), so we make the
;; contents ghosted when not in use, and add ourselves to the
;; global map.
(easy-menu-add-item nil '("Tools")
  '("Follow"
    ;; The Emacs code used to just grey out operations when follow-mode was
    ;; not enabled, whereas the XEmacs code used to remove it altogether.
    ;; Not sure which is preferable, but clearly the preference should not
    ;; depend on the flavor.
    :filter follow-menu-filter
    ["Scroll Up"	follow-scroll-up	follow-mode]
    ["Scroll Down"	follow-scroll-down	follow-mode]
    "--"
    ["Delete Other Windows and Split" follow-delete-other-windows-and-split follow-mode]
    "--"
    ["Switch To Buffer"	follow-switch-to-buffer	follow-mode]
    ["Switch To Buffer (all windows)" follow-switch-to-buffer-all follow-mode]
    "--"
    ["First Window"	follow-first-window	follow-mode]
    ["Last Window"	follow-last-window	follow-mode]
    ["Next Window"	follow-next-window	follow-mode]
    ["Previous Window"	follow-previous-window	follow-mode]
    "--"
    ["Recenter"		follow-recenter		follow-mode]
    "--"
    ["Follow mode"	follow-mode :style toggle :selected follow-mode]))

378
;;}}}
Karl Heuer's avatar
Karl Heuer committed
379

380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
(defcustom follow-mode-line-text " Follow"
  "Text shown in the mode line when Follow mode is active.
Defaults to \" Follow\".  Examples of other values
are \" Fw\", or simply \"\"."
  :type 'string
  :group 'follow)

(defcustom follow-auto nil
  "Non-nil activates Follow mode whenever a file is loaded."
  :type 'boolean
  :group 'follow)

(defcustom follow-intercept-processes (fboundp 'start-process)
  "When non-nil, Follow Mode will monitor process output."
  :type 'boolean
  :group 'follow)

(defvar follow-avoid-tail-recenter-p (not (featurep 'xemacs))
398
  "*When non-nil, patch Emacs so that tail windows won't be recentered.
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463

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
in a window \"above\" the last window.  This is for
example the case when displaying a short page in info.

Must be set before Follow Mode is loaded.

Please note that it is not possible to fully prevent Emacs from
recentering empty windows.  Please report if you find a repeatable
situation in which Emacs recenters empty windows.

XEmacs, as of 19.12, does not recenter windows, good!")

(defvar follow-cache-command-list
  '(next-line previous-line forward-char backward-char)
  "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
buffer.

The commands in this list are checked at load time.

To mark other commands as suitable for caching, set the symbol
property `follow-mode-use-cache' to non-nil.")

(defvar follow-debug nil
  "*Non-nil when debugging Follow mode.")


;; Internal variables:

(defvar follow-internal-force-redisplay nil
  "True when Follow mode should redisplay the windows.")

(defvar follow-process-filter-alist '()
  "The original filters for processes intercepted by Follow mode.")

(defvar follow-active-menu nil
  "The menu visible when Follow mode is active.")

(defvar follow-deactive-menu nil
  "The menu visible when Follow mode is deactivated.")

(defvar follow-inside-post-command-hook nil
  "Non-nil when inside Follow modes `post-command-hook'.
Used by `follow-window-size-change'.")

(defvar follow-windows-start-end-cache nil
  "Cache used by `follow-window-start-end'.")

;;}}}
;;{{{ Debug messages

;; This inline function must be as small as possible!
;; Maybe we should define a macro that expands to nil if
;; the variable is not set.

(defsubst follow-debug-message (&rest args)
  "Like message, but only active when `follow-debug' is non-nil."
  (if (and (boundp 'follow-debug) follow-debug)
      (apply 'message args)))
Karl Heuer's avatar
Karl Heuer committed
464

465 466 467
;;}}}
;;{{{ Cache

468 469
(dolist (cmd follow-cache-command-list)
  (put cmd 'follow-mode-use-cache t))
470

Karl Heuer's avatar
Karl Heuer committed
471 472 473 474 475 476
;;}}}

;;{{{ The mode

;;;###autoload
(defun turn-on-follow-mode ()
477
  "Turn on Follow mode.  Please see the function `follow-mode'."
Karl Heuer's avatar
Karl Heuer committed
478 479 480 481 482
  (follow-mode 1))


;;;###autoload
(defun turn-off-follow-mode ()
483
  "Turn off Follow mode.  Please see the function `follow-mode'."
Karl Heuer's avatar
Karl Heuer committed
484 485
  (follow-mode -1))

486
(put 'follow-mode 'permanent-local t)
Karl Heuer's avatar
Karl Heuer committed
487
;;;###autoload
488
(define-minor-mode follow-mode
489
  "Minor mode that combines windows into one tall virtual window.
Karl Heuer's avatar
Karl Heuer committed
490 491 492 493

The feeling of a \"virtual window\" has been accomplished by the use
of two major techniques:

494
* The windows always displays adjacent sections of the buffer.
Karl Heuer's avatar
Karl Heuer committed
495 496 497
  This means that whenever one window is moved, all the
  others will follow.  (Hence the name Follow Mode.)

498 499 500
* Should the point (cursor) end up outside a window, another
  window displaying that point is selected, if possible.  This
  makes it possible to walk between windows using normal cursor
Karl Heuer's avatar
Karl Heuer committed
501 502 503
  movement commands.

Follow mode comes to its prime when used on a large screen and two
Juanma Barranquero's avatar
Juanma Barranquero committed
504
side-by-side windows are used.  The user can, with the help of Follow
Karl Heuer's avatar
Karl Heuer committed
505
mode, use two full-height windows as though they would have been
506
one.  Imagine yourself editing a large function, or section of text,
507
and being able to use 144 lines instead of the normal 72... (your
Karl Heuer's avatar
Karl Heuer committed
508 509 510 511 512 513
mileage may vary).

To split one large window into two side-by-side windows, the commands
`\\[split-window-horizontally]' or \
`M-x follow-delete-other-windows-and-split' can be used.

514
Only windows displayed in the same frame follow each other.
Karl Heuer's avatar
Karl Heuer committed
515 516 517 518 519 520 521 522 523 524

If the variable `follow-intercept-processes' is non-nil, Follow mode
will listen to the output of processes and redisplay accordingly.
\(This is the default.)

When Follow mode is switched on, the hook `follow-mode-hook'
is called.  When turned off, `follow-mode-off-hook' is called.

Keys specific to Follow mode:
\\{follow-mode-map}"
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
  :keymap follow-mode-map
  (if (and follow-mode follow-intercept-processes)
      (follow-intercept-process-output))
  (cond (follow-mode ; On
         ;; XEmacs: If this is non-nil, the window will scroll before
         ;; the point will have a chance to get into the next window.
         (if (boundp 'scroll-on-clipped-lines)
             (setq scroll-on-clipped-lines nil))
         (force-mode-line-update)
         (add-hook 'post-command-hook 'follow-post-command-hook t)
         (run-hooks 'follow-mode-hook))

        ((not follow-mode) ; Off
         (force-mode-line-update)
         (run-hooks 'follow-mode-off-hook))))
Karl Heuer's avatar
Karl Heuer committed
540 541 542 543 544 545 546

;;}}}
;;{{{ Find file hook

;; This will start follow-mode whenever a new file is loaded, if
;; the variable `follow-auto' is non-nil.

547
(add-hook 'find-file-hook 'follow-find-file-hook t)
Karl Heuer's avatar
Karl Heuer committed
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599

(defun follow-find-file-hook ()
  "Find-file hook for Follow Mode.  See the variable `follow-auto'."
  (if follow-auto (follow-mode t)))

;;}}}

;;{{{ User functions

;;;
;;; User functions usable when in Follow mode.
;;;

;;{{{ Scroll

;; `scroll-up' and `-down', but for windows in Follow Mode.
;;
;; Almost like the real thing, excpet when the cursor ends up outside
;; the top or bottom...  In our case however, we end up outside the
;; window and hence we are recenterd.  Should we let `recenter' handle
;; the point position we would never leave the selected window.  To do
;; it ourselves we would need to do our own redisplay, which is easier
;; said than done.  (Why didn't I do a real display abstraction from
;; the beginning?)
;;
;; We must sometimes set `follow-internal-force-redisplay', otherwise
;; our post-command-hook will move our windows back into the old
;; position...  (This would also be corrected if we would have had a
;; good redisplay abstraction.)

(defun follow-scroll-up (&optional arg)
  "Scroll text in a Follow Mode window chain up.

If called with no ARG, the `next-screen-context-lines' last lines of
the bottom window in the chain will be visible in the top window.

If called with an argument, scroll ARG lines up.
Negative ARG means scroll downward.

Works like `scroll-up' when not in Follow Mode."
  (interactive "P")
  (cond ((not (and (boundp 'follow-mode) follow-mode))
	 (scroll-up arg))
	(arg
	 (save-excursion (scroll-up arg))
	 (setq follow-internal-force-redisplay t))
	(t
	 (let* ((windows (follow-all-followers))
		(end (window-end (car (reverse windows)))))
	   (if (eq end (point-max))
	       (signal 'end-of-buffer nil)
	     (select-window (car windows))
600 601 602
	     ;; `window-end' might return nil.
	     (if end
		 (goto-char end))
Karl Heuer's avatar
Karl Heuer committed
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
	     (vertical-motion (- next-screen-context-lines))
	     (set-window-start (car windows) (point)))))))


(defun follow-scroll-down (&optional arg)
  "Scroll text in a Follow Mode window chain down.

If called with no ARG, the `next-screen-context-lines' top lines of
the top window in the chain will be visible in the bottom window.

If called with an argument, scroll ARG lines down.
Negative ARG means scroll upward.

Works like `scroll-up' when not in Follow Mode."
  (interactive "P")
  (cond ((not (and (boundp 'follow-mode) follow-mode))
	 (scroll-up arg))
	(arg
	 (save-excursion (scroll-down arg)))
	(t
	 (let* ((windows (follow-all-followers))
		(win (car (reverse windows)))
		(start (window-start (car windows))))
	   (if (eq start (point-min))
	       (signal 'beginning-of-buffer nil)
	     (select-window win)
	     (goto-char start)
630 631
	     (vertical-motion (- (- (window-height win)
				    1
Karl Heuer's avatar
Karl Heuer committed
632 633 634 635 636 637 638 639 640 641 642 643 644 645
				    next-screen-context-lines)))
	     (set-window-start win (point))
	     (goto-char start)
	     (vertical-motion (- next-screen-context-lines 1))
	     (setq follow-internal-force-redisplay t))))))

;;}}}
;;{{{ Buffer

;;;###autoload
(defun follow-delete-other-windows-and-split (&optional arg)
  "Create two side by side windows and enter Follow Mode.

Execute this command to display as much as possible of the text
646
in the selected window.  All other windows, in the current
Karl Heuer's avatar
Karl Heuer committed
647
frame, are deleted and the selected window is split in two
648
side-by-side windows.  Follow Mode is activated, hence the
Karl Heuer's avatar
Karl Heuer committed
649 650 651
two windows always will display two successive pages.
\(If one window is moved, the other one will follow.)

652
If ARG is positive, the leftmost window is selected.  If negative,
Karl Heuer's avatar
Karl Heuer committed
653 654 655 656 657 658 659
the rightmost is selected.  If ARG is nil, the leftmost window is
selected if the original window is the first one in the frame.

To bind this command to a hotkey, place the following line
in your `~/.emacs' file, replacing [f7] by your favourite key:
    (global-set-key [f7] 'follow-delete-other-windows-and-split)"
  (interactive "P")
660
  (let ((other (or (and (null arg)
Karl Heuer's avatar
Karl Heuer committed
661 662 663 664 665 666 667
			(not (eq (selected-window)
				 (frame-first-window (selected-frame)))))
		   (and arg
			(< (prefix-numeric-value arg) 0))))
	(start (window-start)))
    (delete-other-windows)
    (split-window-horizontally)
668
    (if other
Karl Heuer's avatar
Karl Heuer committed
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
	(progn
	  (other-window 1)
	  (set-window-start (selected-window) start)
	  (setq follow-internal-force-redisplay t)))
    (follow-mode 1)))

(defun follow-switch-to-buffer (buffer)
  "Show BUFFER in all windows in the current Follow Mode window chain."
  (interactive "BSwitch to Buffer: ")
  (let ((orig-window (selected-window))
	(windows (follow-all-followers)))
    (while windows
      (select-window (car windows))
      (switch-to-buffer buffer)
      (setq windows (cdr windows)))
    (select-window orig-window)))


(defun follow-switch-to-buffer-all (&optional buffer)
  "Show BUFFER in all windows on this frame.
Defaults to current buffer."
690
  (interactive (list (read-buffer "Switch to Buffer: "
Karl Heuer's avatar
Karl Heuer committed
691 692 693
				  (current-buffer))))
  (or buffer (setq buffer (current-buffer)))
  (let ((orig-window (selected-window)))
694 695
    (walk-windows
     (function
Karl Heuer's avatar
Karl Heuer committed
696 697 698 699 700 701 702 703 704 705
      (lambda (win)
	(select-window win)
	(switch-to-buffer buffer))))
    (select-window orig-window)
    (follow-redisplay)))


(defun follow-switch-to-current-buffer-all ()
  "Show current buffer in all windows on this frame, and enter Follow Mode.

706
To bind this command to a hotkey place the following line
Karl Heuer's avatar
Karl Heuer committed
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
in your `~/.emacs' file:
	(global-set-key [f7] 'follow-switch-to-current-buffer-all)"
  (interactive)
  (or (and (boundp 'follow-mode) follow-mode)
      (follow-mode 1))
  (follow-switch-to-buffer-all))

;;}}}
;;{{{ Movement

;; Note, these functions are not very useful, atleast not unless you
;; rebind the rather cumbersome key sequence `C-c . p'.

(defun follow-next-window ()
  "Select the next window showing the same buffer."
  (interactive)
  (let ((succ (cdr (follow-split-followers (follow-all-followers)))))
    (if succ
	(select-window (car succ))
      (error "%s" "No more windows"))))


(defun follow-previous-window ()
  "Select the previous window showing the same buffer."
  (interactive)
  (let ((pred (car (follow-split-followers (follow-all-followers)))))
    (if pred
	(select-window (car pred))
      (error "%s" "No more windows"))))


(defun follow-first-window ()
  "Select the first window in the frame showing the same buffer."
  (interactive)
  (select-window (car (follow-all-followers))))


(defun follow-last-window ()
  "Select the last window in the frame showing the same buffer."
  (interactive)
  (select-window (car (reverse (follow-all-followers)))))

;;}}}
;;{{{ Redraw

(defun follow-recenter (&optional arg)
753 754
  "Recenter the middle window around point.
Rearrange all other windows around the middle window.
Karl Heuer's avatar
Karl Heuer committed
755 756

With a positive argument, place the current line ARG lines
757 758
from the top.  With a negative argument, place it -ARG lines
from the bottom."
Karl Heuer's avatar
Karl Heuer committed
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
  (interactive "P")
  (if arg
      (let ((p (point))
	    (arg (prefix-numeric-value arg)))
	(if (>= arg 0)
	    ;; Recenter relative to the top.
	    (progn
	      (follow-first-window)
	      (goto-char p)
	      (recenter arg))
	  ;; Recenter relative to the bottom.
	  (follow-last-window)
	  (goto-char p)
	  (recenter arg)
	  ;; Otherwise, our post-command-hook will move the window
	  ;; right back.
	  (setq follow-internal-force-redisplay t)))
    ;; Recenter in the middle.
    (let* ((dest (point))
	   (windows (follow-all-followers))
	   (win (nth (/ (- (length windows) 1) 2) windows)))
      (select-window win)
      (goto-char dest)
      (recenter)
      ;;(setq follow-internal-force-redisplay t)
      )))


(defun follow-redraw ()
  "Arrange windows displaying the same buffer in successor order.
This function can be called even if the buffer is not in Follow mode.

Hopefully, there should be no reason to call this function when in
Follow mode since the windows should always be aligned."
  (interactive)
  (sit-for 0)
  (follow-redisplay))

;;}}}
;;{{{ End of buffer

(defun follow-end-of-buffer (&optional arg)
801
  "Move point to the end of the buffer, Follow Mode style.
Karl Heuer's avatar
Karl Heuer committed
802 803 804 805

If the end is not visible, it will be displayed in the last possible
window in the Follow Mode window chain.

806
The mark is left at the previous position.  With arg N, put point N/10
Karl Heuer's avatar
Karl Heuer committed
807 808 809 810 811 812
of the way from the true end."
  (interactive "P")
  (let ((followers (follow-all-followers))
	(pos (point)))
    (cond (arg
	   (select-window (car (reverse followers))))
813
	  ((follow-select-if-end-visible
Karl Heuer's avatar
Karl Heuer committed
814 815 816 817
	    (follow-windows-start-end followers)))
	  (t
	   (select-window (car (reverse followers)))))
    (goto-char pos)
818 819
    (with-no-warnings
      (end-of-buffer arg))))
Karl Heuer's avatar
Karl Heuer committed
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834

;;}}}

;;}}}

;;{{{ Display

;;;; The display routines

;;{{{ Information gathering functions

(defun follow-all-followers (&optional testwin)
  "Return all windows displaying the same buffer as the TESTWIN.
The list contains only windows displayed in the same frame as TESTWIN.
If TESTWIN is nil the selected window is used."
835
  (or (window-live-p testwin)
Karl Heuer's avatar
Karl Heuer committed
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
      (setq testwin (selected-window)))
  (let* ((top (frame-first-window (window-frame testwin)))
	 (win top)
	 (done nil)
	 (windows '())
	 (buffer (window-buffer testwin)))
    (while (and (not done) win)
      (if (eq (window-buffer win) buffer)
	  (setq windows (cons win windows)))
      (setq win (next-window win 'not))
      (if (eq win top)
	  (setq done t)))
    (nreverse windows)))


(defun follow-split-followers (windows &optional win)
  "Split the WINDOWS into the sets: predecessors and successors.
853
Return `(PRED . SUCC)' where `PRED' and `SUCC' are ordered starting
Karl Heuer's avatar
Karl Heuer committed
854
from the selected window."
855
  (or win
Karl Heuer's avatar
Karl Heuer committed
856 857 858 859 860 861 862 863
      (setq win (selected-window)))
  (let ((pred '()))
    (while (not (eq (car windows) win))
      (setq pred (cons (car windows) pred))
      (setq windows (cdr windows)))
    (cons pred (cdr windows))))


864
;; This function is optimized function for speed!
Karl Heuer's avatar
Karl Heuer committed
865 866 867 868 869 870 871 872 873 874

(defun follow-calc-win-end (&optional win)
  "Calculate the presumed window end for WIN.

Actually, the position returned is the start of the next
window, normally is the end plus one.

If WIN is nil, the selected window is used.

Returns (end-pos end-of-buffer-p)"
875
  (if (featurep 'xemacs)
Karl Heuer's avatar
Karl Heuer committed
876 877 878 879 880 881
      ;; XEmacs can calculate the end of the window by using
      ;; the 'guarantee options. GOOD!
      (let ((end (window-end win t)))
	(if (= end (funcall (symbol-function 'point-max)
			    (window-buffer win)))
	    (list end t)
882
	  (list (+ end 1) nil)))
883 884
    ;; Emacs: We have to calculate the end by ourselves.
    ;; This code works on both XEmacs and Emacs, but now
Karl Heuer's avatar
Karl Heuer committed
885
    ;; that XEmacs has got custom-written code, this could
886
    ;; be optimized for Emacs.
Karl Heuer's avatar
Karl Heuer committed
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
    (let ((orig-win (and win (selected-window)))
	  height
	  buffer-end-p)
      (if win (select-window win))
      (prog1
	  (save-excursion
	    (goto-char (window-start))
	    (setq height (- (window-height) 1))
	    (setq buffer-end-p
		  (if (bolp)
		      (not (= height (vertical-motion height)))
		    (save-restriction
		      ;; Fix a mis-feature in `vertical-motion':
		      ;; The start of the window is assumed to
		      ;; coinside with the start of a line.
		      (narrow-to-region (point) (point-max))
		      (not (= height (vertical-motion height))))))
	    (list (point) buffer-end-p))
	(if orig-win
	    (select-window orig-win))))))


;; Can't use `save-window-excursion' since it triggers a redraw.
(defun follow-calc-win-start (windows pos win)
  "Calculate where WIN will start if the first in WINDOWS start at POS.

If WIN is nil the point below all windows is returned."
  (let (start)
    (while (and windows (not (eq (car windows) win)))
      (setq start (window-start (car windows)))
      (set-window-start (car windows) pos 'noforce)
      (setq pos (car (inline (follow-calc-win-end (car windows)))))
      (set-window-start (car windows) start 'noforce)
      (setq windows (cdr windows)))
    pos))


924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
;; The result from `follow-windows-start-end' is cached when using
;; a handful simple commands, like cursor movement commands.

(defsubst follow-cache-valid-p (windows)
  "Test if the cached value of `follow-windows-start-end' can be used.
Note that this handles the case when the cache has been set to nil."
  (let ((res t)
	(cache follow-windows-start-end-cache))
    (while (and res windows cache)
      (setq res (and (eq (car windows)
			 (car (car cache)))
		     (eq (window-start (car windows))
			 (car (cdr (car cache))))))
      (setq windows (cdr windows))
      (setq cache (cdr cache)))
    (and res (null windows) (null cache))))


(defsubst follow-invalidate-cache ()
  "Force `follow-windows-start-end' to recalculate the end of the window."
  (setq follow-windows-start-end-cache nil))


Karl Heuer's avatar
Karl Heuer committed
947 948 949 950 951 952 953 954 955 956 957
;; Build a list of windows and their start and end positions.
;; Useful to avoid calculating start/end position whenever they are needed.
;; The list has the format:
;; ((Win Start End End-of-buffer-visible-p) ...)

;; Used to have a `save-window-excursion', but it obviously triggered
;; redraws of the display. Check if I used it for anything.


(defun follow-windows-start-end (windows)
  "Builds a list of (WIN START END BUFFER-END-P) for every window in WINDOWS."
958 959 960 961 962 963
  (if (follow-cache-valid-p windows)
      follow-windows-start-end-cache
    (let ((win-start-end '())
	  (orig-win (selected-window)))
      (while windows
	(select-window (car windows))
964 965
	(setq win-start-end
	      (cons (cons (car windows)
966 967 968 969 970 971 972 973 974 975
			  (cons (window-start)
				(follow-calc-win-end)))
		    win-start-end))
	(setq windows (cdr windows)))
      (select-window orig-win)
      (setq follow-windows-start-end-cache (nreverse win-start-end))
      follow-windows-start-end-cache)))


(defsubst follow-pos-visible (pos win win-start-end)
Karl Heuer's avatar
Karl Heuer committed
976 977 978 979 980 981 982 983 984 985 986
  "Non-nil when POS is visible in WIN."
  (let ((wstart-wend-bend (cdr (assq win win-start-end))))
    (and (>= pos (car wstart-wend-bend))
	 (or (< pos (car (cdr wstart-wend-bend)))
	     (nth 2 wstart-wend-bend)))))


;; By `aligned' we mean that for all adjecent windows, the end of the
;; first is equal with the start of the successor.  The first window
;; should start at a full screen line.

987
(defsubst follow-windows-aligned-p (win-start-end)
988
  "Non-nil if the follower windows are aligned."
989
  (let ((res t))
Karl Heuer's avatar
Karl Heuer committed
990 991 992 993 994 995 996 997
    (save-excursion
       (goto-char (window-start (car (car win-start-end))))
       (if (bolp)
	   nil
	 (vertical-motion 0 (car (car win-start-end)))
	 (setq res (eq (point) (window-start (car (car win-start-end)))))))
    (while (and res (cdr win-start-end))
      ;; At least two followers left
998 999
      (setq res (eq (car (cdr (cdr (car win-start-end))))
		    (car (cdr (car (cdr win-start-end))))))
Karl Heuer's avatar
Karl Heuer committed
1000 1001 1002 1003 1004 1005 1006 1007
      (setq win-start-end (cdr win-start-end)))
    res))


;; Check if the point is visible in all windows. (So that
;; no one will be recentered.)

(defun follow-point-visible-all-windows-p (win-start-end)
1008
  "Non-nil when the `window-point' is visible in all windows."
Karl Heuer's avatar
Karl Heuer committed
1009 1010
  (let ((res t))
    (while (and res win-start-end)
1011 1012 1013
      (setq res (follow-pos-visible (window-point (car (car win-start-end)))
				    (car (car win-start-end))
				    win-start-end))
Karl Heuer's avatar
Karl Heuer committed
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
      (setq win-start-end (cdr win-start-end)))
    res))


;; Make sure WIN always starts at the beginning of an whole screen
;; line. If WIN is not aligned the start is updated which probably
;; will lead to a redisplay of the screen later on.
;;
;; This is used with the first window in a follow chain.  The reason
;; is that we want to detect that the point is outside the window.
;; (Without the update, the start of the window will move as the
;; user presses BackSpace, and the other window redisplay routines
;; will move the start of the window in the wrong direction.)

(defun follow-update-window-start (win)
  "Make sure that the start of WIN starts at a full screen line."
  (save-excursion
    (goto-char (window-start win))
    (if (bolp)
	nil
      (vertical-motion 0 win)
      (if (eq (point) (window-start win))
	  nil
	(vertical-motion 1 win)
	(set-window-start win (point) 'noforce)))))

;;}}}
;;{{{ Selection functions

;; Make a window in WINDOWS selected if it currently
;; is displaying the position DEST.
;;
;; We don't select a window if it just has been moved.

(defun follow-select-if-visible (dest win-start-end)
  "Select and return a window, if DEST is visible in it.
Return the selected window."
  (let ((win nil))
    (while (and (not win) win-start-end)
1053
      ;; Don't select a window that was just moved. This makes it
Karl Heuer's avatar
Karl Heuer committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
      ;; 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)
	  (progn
	    (setq win (car (car win-start-end)))
	    (select-window win)))
      (setq win-start-end (cdr win-start-end)))
    win))


;; Lets select a window showing the end. Make sure we only select it if it
;; it wasn't just moved here. (i.e. M-> shall not unconditionally place
;; the point in the selected window.)
;;
1068
;; (Compability cludge: in Emacs `window-end' is equal to `point-max';
Karl Heuer's avatar
Karl Heuer committed
1069
;; in XEmacs, it is equal to `point-max + 1'. Should I really bother
1070
;; checking `window-end' now when I check `end-of-buffer' explicitly?)
Karl Heuer's avatar
Karl Heuer committed
1071 1072 1073 1074 1075

(defun follow-select-if-end-visible (win-start-end)
  "Select and return a window, if end is visible in it."
  (let ((win nil))
    (while (and (not win) win-start-end)
1076
      ;; Don't select a window that was just moved. This makes it
Karl Heuer's avatar
Karl Heuer committed
1077 1078 1079 1080
      ;; 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))
1081 1082 1083 1084
	       ;; `window-end' might return nil.
	       (let ((end (window-end (car (car win-start-end)))))
		 (and end
		      (eq (point-max) (min (point-max) end)))))
Karl Heuer's avatar
Karl Heuer committed
1085 1086 1087 1088 1089 1090 1091
	  (progn
	    (setq win (car (car win-start-end)))
	    (select-window win)))
      (setq win-start-end (cdr win-start-end)))
    win))


1092
;; Select a window that will display the point if the windows would
Karl Heuer's avatar
Karl Heuer committed
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
;; 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-select-if-visible-from-first (dest windows)
  "Select and return a window with DEST, if WINDOWS are redrawn from top."
  (let ((win nil)
	end-pos-end-p)
    (save-excursion
      (goto-char (window-start (car windows)))
      ;; Make sure the line start in the beginning of a real screen
      ;; line.
1105
      (vertical-motion 0 (car windows))
Karl Heuer's avatar
Karl Heuer committed
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
      (if (< dest (point))
	  ;; Above the start, not visible.
	  nil
	;; At or below the start. Check the windows.
	(save-window-excursion
	  (while (and (not win) windows)
	    (set-window-start (car windows) (point) 'noforce)
	    (setq end-pos-end-p (follow-calc-win-end (car windows)))
	    (goto-char (car end-pos-end-p))
	    ;; Visible, if dest above end, or if eob is visible inside
	    ;; the window.
	    (if (or (car (cdr end-pos-end-p))
		    (< dest (point)))
		  (setq win (car windows))
		(setq windows (cdr windows)))))))
1121
    (if win
Karl Heuer's avatar
Karl Heuer committed
1122 1123 1124 1125 1126
	(select-window win))
    win))


;;}}}
1127
;;{{{ Redisplay
Karl Heuer's avatar
Karl Heuer committed
1128 1129 1130 1131 1132 1133 1134 1135

;; Redraw all the windows on the screen, starting with the top window.
;; The window used as as marker is WIN, or the selcted window if WIN
;; is nil.

(defun follow-redisplay (&optional windows win)
  "Reposition the WINDOWS around WIN.
Should the point be too close to the roof we redisplay everything
1136
from the top.  WINDOWS should contain a list of windows to
1137
redisplay, it is assumed that WIN is a member of the list.
Karl Heuer's avatar
Karl Heuer committed
1138 1139
Should WINDOWS be nil, the windows displaying the
same buffer as WIN, in the current frame, are used.
1140
Should WIN be nil, the selected window is used."
Karl Heuer's avatar
Karl Heuer committed
1141 1142
  (or win
      (setq win (selected-window)))
1143
  (or windows
Karl Heuer's avatar
Karl Heuer committed
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
      (setq windows (follow-all-followers win)))
  (follow-downward windows (follow-calculate-first-window-start windows win)))


;; Redisplay a chain of windows. Start every window directly after the
;; end of the previous window, to make sure long lines are displayed
;; correctly.

(defun follow-downward (windows pos)
  "Redisplay all WINDOWS starting at POS."
  (while windows
    (set-window-start (car windows) pos)
    (setq pos (car (follow-calc-win-end (car windows))))
    (setq windows (cdr windows))))


;;(defun follow-downward (windows pos)
;;  "Redisplay all WINDOWS starting at POS."
;;  (let (p)
;;    (while windows
;;      (setq p (window-point (car windows)))
;;      (set-window-start (car windows) pos)
;;      (set-window-point (car windows) (max p pos))
;;      (setq pos (car (follow-calc-win-end (car windows))))
;;      (setq windows (cdr windows)))))


;; Return the start of the first window.
;;
;; First, estimate the position. It the value is not perfect (i.e. we
;; have somewhere splited a line between windows) we try to enhance
;; the value.
;;
;; The guess is always perfect if no long lines is split between
;; windows.
;;
;; The worst case peformace of probably very bad, but it is very
;; unlikely that we ever will miss the correct start by more than one
;; or two lines.

(defun follow-calculate-first-window-start (windows &optional win start)
  "Calculate the start of the first window.

WINDOWS is a chain of windows to work with.  WIN is the window
1188
to recenter around.  It is assumed that WIN starts at position
Karl Heuer's avatar
Karl Heuer committed
1189
START."
1190
  (or win
Karl Heuer's avatar
Karl Heuer committed
1191
      (setq win (selected-window)))
1192
  (or start
Karl Heuer's avatar
Karl Heuer committed
1193 1194 1195 1196 1197 1198
      (setq start (window-start win)))
  (let ((guess (follow-estimate-first-window-start windows win start)))
    (if (car guess)
	(cdr guess)
      ;; The guess wasn't exact, try to enhance it.
      (let ((win-start (follow-calc-win-start windows (cdr guess) win)))
1199
	(cond ((= win-start start)
Karl Heuer's avatar
Karl Heuer committed
1200 1201 1202 1203
	       (follow-debug-message "exact")
	       (cdr guess))
	      ((< win-start start)
	       (follow-debug-message "above")
1204
	       (follow-calculate-first-window-start-from-above
Karl Heuer's avatar
Karl Heuer committed
1205 1206 1207
		windows (cdr guess) win start))
	      (t
	       (follow-debug-message "below")
1208
	       (follow-calculate-first-window-start-from-below
Karl Heuer's avatar
Karl Heuer committed
1209 1210 1211 1212 1213 1214 1215 1216
		windows (cdr guess) win start)))))))


;; `exact' is disabled due to XEmacs and fonts of variable
;; height.
(defun follow-estimate-first-window-start (windows win start)
  "Estimate the position of the first window.

1217 1218
Returns (EXACT . POS).  If EXACT is non-nil, POS is the starting
position of the first window.  Otherwise it is a good guess."
Karl Heuer's avatar
Karl Heuer committed
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
  (let ((pred (car (follow-split-followers windows win)))
	(exact nil))
    (save-excursion
      (goto-char start)
      ;(setq exact (bolp))
      (vertical-motion 0 win)
      (while pred
	(vertical-motion (- 1 (window-height (car pred))) (car pred))
	(if (not (bolp))
	  (setq exact nil))
	(setq pred (cdr pred)))
      (cons exact (point)))))


;; Find the starting point, start at GUESS and search downward.
;; The returned point is always a point below GUESS.

1236
(defun follow-calculate-first-window-start-from-above
Karl Heuer's avatar
Karl Heuer committed
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
       (windows guess win start)
  (save-excursion
    (let ((done nil)
	  win-start
	  res)
      (goto-char guess)
      (while (not done)
	(if (not (= (vertical-motion 1 (car windows)) 1))
	    ;; Hit bottom! (Can we really do this?)
	    ;; We'll keep it, since it ensures termination.
	    (progn
	      (setq done t)
	      (setq res (point-max)))
	  (setq win-start (follow-calc-win-start windows (point) win))
	  (if (>= win-start start)
1252
	      (progn
Karl Heuer's avatar
Karl Heuer committed
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
		(setq done t)
		(setq res (point))))))
      res)))


;; Find the starting point, start at GUESS and search upward.  Return
;; a point on the same line as GUESS, or above.
;;
;; (Is this ever used? I must make sure it works just in case it is
;; ever called.)

(defun follow-calculate-first-window-start-from-below
       (windows guess &optional win start)
  (setq win (or win (selected-window)))
  (setq start (or start (window-start win)))
  (save-excursion
    (let ((done nil)
	  win-start
	  res)
      ;; Always calculate what happend when no line is displayed in the first
      ;; window. (The `previous' res is needed below!)
      (goto-char guess)
      (vertical-motion 0 (car windows))
      (setq res (point))
      (while (not done)
	(if (not (= (vertical-motion -1 (car windows)) -1))
	    ;; Hit roof!
	    (progn
	      (setq done t)
	      (setq res (point-min)))
	  (setq win-start (follow-calc-win-start windows (point) win))
	  (cond ((= win-start start)	; Perfect match, use this value
		 (setq done t)
		 (setq res (point)))
		((< win-start start)	; Walked to far, use preious result
		 (setq done t))
		(t			; Store result for next iteration
		 (setq res (point))))))
      res)))

;;}}}
;;{{{ Avoid tail recenter

;; This sets the window internal flag `force_start'. The effect is that
;; windows only displaying the tail isn't recentered.
;; Has to be called before every redisplay... (Great isn't it?)
;;
;; XEmacs doesn't recenter the tail, GOOD!
;;
;; A window displaying only the tail, is a windows whose
;; window-start position is equal to (point-max) of the buffer it
;; displays.
;;
;; This function is also added to `post-command-idle-hook', introduced
;; in Emacs 19.30.  This is needed since the vaccine injected by the
;; call from `post-command-hook' only works until the next redisplay.
;; It is possible that the functions in the `post-command-idle-hook'
;; can cause a redisplay, and hence a new vaccine is needed.
;;
;; Sometimes, calling this function could actually cause a redisplay,
;; especially if it is placed in the debug filter section.  I must
;; investigate this further...

(defun follow-avoid-tail-recenter (&rest rest)
  "Make sure windows displaying the end of a buffer aren't recentered.

1319
This is done by reading and rewriting the start position of
Karl Heuer's avatar
Karl Heuer committed
1320 1321 1322
non-first windows in Follow Mode."
  (if follow-avoid-tail-recenter-p
      (let* ((orig-buffer (current-buffer))
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
	    (top (frame-first-window (selected-frame)))
	    (win top)
	    (who '())			; list of (buffer . frame)
	    start
	    pair)			; (buffer . frame)
	;; If the only window in the frame is a minibuffer
	;; window, `next-window' will never find it again...
	(if (window-minibuffer-p top)
	    nil
	  (while  ;; look, no body!
	      (progn
		(setq start (window-start win))
		(set-buffer (window-buffer win))
		(setq pair (cons (window-buffer win) (window-frame win)))
		(if (member pair who)
1338
		    (if (and (boundp 'follow-mode) follow-mode
1339 1340 1341 1342 1343 1344 1345 1346
			     (eq (point-max) start))
			;; Write the same window start back, but don't
			;; set the NOFORCE flag.
			(set-window-start win start))
		  (setq who (cons pair who)))
		(setq win (next-window win 'not t))
		(not (eq win top))))  ;; Loop while this is true.
	  (set-buffer orig-buffer)))))
Karl Heuer's avatar
Karl Heuer committed
1347 1348 1349 1350 1351 1352

;;}}}

;;}}}
;;{{{ Post Command Hook

1353
;; The magic little box. This function is called after every command.
Karl Heuer's avatar
Karl Heuer committed
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363

;; This is not as complicated as it seems. It is simply a list of common
;; display situations and the actions to take, plus commands for redrawing
;; the screen if it should be unaligned.
;;
;; We divide the check into two parts; whether we are at the end or not.
;; This is due to the fact that the end can actaually be visible
;; in several window even though they are aligned.

(defun follow-post-command-hook ()
1364
  "Ensure that the windows in Follow mode are adjacent after each command."
Karl Heuer's avatar
Karl Heuer committed
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
  (setq follow-inside-post-command-hook t)
  (if (or (not (input-pending-p))
	  ;; Sometimes, in XEmacs, mouse events are not handled
	  ;; properly by `input-pending-p'.  A typical example is
	  ;; when clicking on a node in `info'.
	  (and (boundp 'current-mouse-event)
	       (symbol-value 'current-mouse-event)
	       (fboundp 'button-event-p)
	       (funcall (symbol-function 'button-event-p)
			(symbol-value 'current-mouse-event))))
      ;; Work in the selected window, not in the current buffer.
      (let ((orig-buffer (current-buffer))
	    (win (selected-window)))
	(set-buffer (window-buffer win))
1379
	(or (and (symbolp this-command)
1380 1381
		 (get this-command 'follow-mode-use-cache))
	    (follow-invalidate-cache))
Karl Heuer's avatar
Karl Heuer committed
1382 1383 1384 1385 1386 1387 1388
	(if (and (boundp 'follow-mode) follow-mode
		 (not (window-minibuffer-p win)))
	    ;; The buffer shown in the selected window is in follow
	    ;; mode, lets find the current state of the display and
	    ;; cache the result for speed (i.e. `aligned' and `visible'.)
	    (let* ((windows (inline (follow-all-followers win)))
		   (dest (point))
1389
		   (win-start-end (inline
Karl Heuer's avatar
Karl Heuer committed
1390 1391 1392 1393
				    (follow-update-window-start (car windows))
				    (follow-windows-start-end windows)))
		   (aligned (follow-windows-aligned-p win-start-end))
		   (visible (follow-pos-visible dest win win-start-end)))
1394 1395 1396
	      (if (not (and aligned visible))
		  (follow-invalidate-cache))
	      (inline (follow-avoid-tail-recenter))
Karl Heuer's avatar
Karl Heuer committed
1397 1398 1399 1400
	      ;; Select a window to display the point.
	      (or follow-internal-force-redisplay
		  (progn
		    (if (eq dest (point-max))
Juanma Barranquero's avatar
Juanma Barranquero committed
1401
			;; We're at the end, we have to be careful since
Karl Heuer's avatar
Karl Heuer committed
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
			;; the display can be aligned while `dest' can
			;; be visible in several windows.
			(cond
			 ;; Select the current window, but only when
			 ;; the display is correct. (When inserting
			 ;; character in a tail window, the display is
			 ;; not correct, as they are shown twice.)
			 ;;
			 ;; Never stick to the current window after a
			 ;; deletion.  The reason is cosmetic, when
			 ;; typing `DEL' in a window showing only the
			 ;; end of the file, character are removed
			 ;; from the window above, which is very
			 ;; unintuitive.
			 ((and visible
			       aligned
1418
			       (not (memq this-command
Karl Heuer's avatar
Karl Heuer committed
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433