Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; follow.el --- synchronize windows showing the same buffer |
e79016aa | 2 | |
0d30b337 | 3 | ;; Copyright (C) 1995, 1996, 1997, 1999, 2001, 2002, 2003, 2004, |
d7a0267c | 4 | ;; 2005, 2006, 2007 Free Software Foundation, Inc. |
e79016aa | 5 | |
c86b6fd2 | 6 | ;; Author: Anders Lindgren <andersl@andersl.com> |
ec8d89ec | 7 | ;; Maintainer: FSF (Anders' email bounces, Sep 2005) |
c86b6fd2 | 8 | ;; Created: 1995-05-25 |
f5f727f8 | 9 | ;; Keywords: display, window, minor-mode, convenience |
e79016aa | 10 | |
dcde1278 RS |
11 | ;; This file is part of GNU Emacs. |
12 | ||
13 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
e79016aa | 14 | ;; it under the terms of the GNU General Public License as published by |
b4aa6026 | 15 | ;; the Free Software Foundation; either version 3, or (at your option) |
e79016aa KH |
16 | ;; any later version. |
17 | ||
dcde1278 | 18 | ;; GNU Emacs is distributed in the hope that it will be useful, |
e79016aa KH |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
dcde1278 | 24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
25 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
26 | ;; Boston, MA 02110-1301, USA. | |
e79016aa KH |
27 | |
28 | ;;; Commentary: | |
29 | ||
30 | ;;{{{ Documentation | |
31 | ||
ff753438 | 32 | ;; `Follow mode' is a minor mode for Emacs and XEmacs that |
e79016aa KH |
33 | ;; combines windows into one tall virtual window. |
34 | ;; | |
35 | ;; The feeling of a "virtual window" has been accomplished by the use | |
36 | ;; of two major techniques: | |
37 | ;; | |
cb02be17 | 38 | ;; * The windows always displays adjacent sections of the buffer. |
e79016aa KH |
39 | ;; This means that whenever one window is moved, all the |
40 | ;; others will follow. (Hence the name Follow Mode.) | |
41 | ;; | |
cb02be17 KH |
42 | ;; * Should the point (cursor) end up outside a window, another |
43 | ;; window displaying that point is selected, if possible. This | |
44 | ;; makes it possible to walk between windows using normal cursor | |
e79016aa KH |
45 | ;; movement commands. |
46 | ;; | |
ff753438 | 47 | ;; Follow mode comes to its prime when a large screen and two |
08a1dbe6 | 48 | ;; side-by-side window are used. The user can, with the help of Follow |
e79016aa | 49 | ;; mode, use two full-height windows as though they would have been |
08a1dbe6 | 50 | ;; one. Imagine yourself editing a large function, or section of text, |
c8d05b03 | 51 | ;; and being able to use 144 lines instead of the normal 72... (your |
e79016aa KH |
52 | ;; mileage may vary). |
53 | ||
e79016aa | 54 | ;; To test this package, make sure `follow' is loaded, or will be |
08a1dbe6 | 55 | ;; autoloaded when activated (see below). Then do the following: |
e79016aa | 56 | ;; |
ff753438 | 57 | ;; * Find your favorite file (preferably a long one). |
e79016aa | 58 | ;; |
ff753438 RS |
59 | ;; * Resize Emacs so that it will be wide enough for two full size |
60 | ;; columns. Delete the other windows and split the window with | |
61 | ;; the commands `C-x 1 C-x 3'. | |
e79016aa KH |
62 | ;; |
63 | ;; * Give the command: | |
64 | ;; M-x follow-mode <RETURN> | |
65 | ;; | |
66 | ;; * Now the display should look something like (assuming the text "71" | |
67 | ;; is on line 71): | |
68 | ;; | |
69 | ;; +----------+----------+ | |
70 | ;; |1 |73 | | |
71 | ;; |2 |74 | | |
72 | ;; |3 |75 | | |
cb02be17 | 73 | ;; ... ... |
e79016aa KH |
74 | ;; |71 |143 | |
75 | ;; |72 |144 | | |
76 | ;; +----------+----------+ | |
77 | ;; | |
78 | ;; As you can see, the right-hand window starts at line 73, the line | |
08a1dbe6 | 79 | ;; immediately below the end of the left-hand window. As long as |
e79016aa KH |
80 | ;; `follow-mode' is active, the two windows will follow eachother! |
81 | ;; | |
82 | ;; * Play around and enjoy! Scroll one window and watch the other. | |
08a1dbe6 SM |
83 | ;; Jump to the beginning or end. Press `Cursor down' at the last |
84 | ;; line of the left-hand window. Enter new lines into the | |
85 | ;; text. Enter long lines spanning several lines, or several | |
e79016aa KH |
86 | ;; windows. |
87 | ;; | |
88 | ;; * Should you find `Follow' mode annoying, just type | |
cb02be17 | 89 | ;; M-x follow-mode <RETURN> |
e79016aa KH |
90 | ;; to turn it off. |
91 | ||
92 | ||
e79016aa KH |
93 | ;; The command `follow-delete-other-windows-and-split' maximises the |
94 | ;; visible area of the current buffer. | |
95 | ;; | |
96 | ;; I recommend adding it, and `follow-mode', to hotkeys in the global | |
97 | ;; key map. To do so, add the following lines (replacing `[f7]' and | |
98 | ;; `[f8]' with your favorite keys) to the init file: | |
99 | ;; | |
e79016aa | 100 | ;; (global-set-key [f8] 'follow-mode) |
e79016aa KH |
101 | ;; (global-set-key [f7] 'follow-delete-other-windows-and-split) |
102 | ||
103 | ||
ff753438 RS |
104 | ;; There exists two system variables that controls the appearence of |
105 | ;; lines that are wider than the window containing them. The default | |
f3bfa025 KH |
106 | ;; is to truncate long lines whenever a window isn't as wide as the |
107 | ;; frame. | |
e79016aa KH |
108 | ;; |
109 | ;; To make sure lines are never truncated, please place the following | |
110 | ;; lines in your init file: | |
111 | ;; | |
112 | ;; (setq truncate-lines nil) | |
113 | ;; (setq truncate-partial-width-windows nil) | |
114 | ||
115 | ||
f3bfa025 KH |
116 | ;; Since the display of XEmacs is pixel-oriented, a line could be |
117 | ;; clipped in half at the bottom of the window. | |
118 | ;; | |
119 | ;; To make XEmacs avoid clipping (normal) lines, please place the | |
120 | ;; following line in your init-file: | |
121 | ;; | |
122 | ;; (setq pixel-vertical-clip-threshold 30) | |
123 | ||
124 | ||
e79016aa | 125 | ;; The correct way to cofigurate Follow mode, or any other mode for |
ff753438 | 126 | ;; that matter, is to create one (or more) function that does |
e79016aa KH |
127 | ;; whatever you would like to do. The function is then added to |
128 | ;; a hook. | |
129 | ;; | |
130 | ;; When `Follow' mode is activated, functions stored in the hook | |
131 | ;; `follow-mode-hook' are called. When it is deactivated | |
28ccdfff | 132 | ;; `follow-mode-off-hook' is run. |
e79016aa KH |
133 | ;; |
134 | ;; The keymap `follow-key-map' contains key bindings activated by | |
135 | ;; `follow-mode'. | |
136 | ;; | |
137 | ;; Example: | |
138 | ;; (add-hook 'follow-mode-hook 'my-follow-mode-hook) | |
139 | ;; | |
140 | ;; (defun my-follow-mode-hook () | |
141 | ;; (define-key follow-mode-map "\C-ca" 'your-favorite-function) | |
142 | ;; (define-key follow-mode-map "\C-cb" 'another-function)) | |
143 | ||
144 | ||
145 | ;; Usage: | |
146 | ;; | |
ff753438 | 147 | ;; To activate issue the command "M-x follow-mode" |
08a1dbe6 | 148 | ;; and press return. To deactivate, do it again. |
e79016aa | 149 | ;; |
ff753438 RS |
150 | ;; The following is a list of commands useful when follow-mode is active. |
151 | ;; | |
e79016aa KH |
152 | ;; follow-scroll-up C-c . C-v |
153 | ;; Scroll text in a Follow Mode window chain up. | |
154 | ;; | |
155 | ;; follow-scroll-down C-c . v | |
156 | ;; Like `follow-scroll-up', but in the other direction. | |
157 | ;; | |
158 | ;; follow-delete-other-windows-and-split C-c . 1 | |
159 | ;; Maximise the visible area of the current buffer, | |
160 | ;; and enter Follow Mode. This is a very convenient | |
161 | ;; way to start Follow Mode, hence it is recomended | |
162 | ;; that this command is added to the global keymap. | |
163 | ;; | |
164 | ;; follow-recenter C-c . C-l | |
165 | ;; Place the point in the center of the middle window, | |
166 | ;; or a specified number of lines from either top or bottom. | |
167 | ;; | |
168 | ;; follow-switch-to-buffer C-c . b | |
169 | ;; Switch buffer in all windows displaying the current buffer | |
170 | ;; in this frame. | |
171 | ;; | |
172 | ;; follow-switch-to-buffer-all C-c . C-b | |
173 | ;; Switch buffer in all windows in the active frame. | |
174 | ;; | |
175 | ;; follow-switch-to-current-buffer-all | |
176 | ;; Show the current buffer in all windows on the current | |
177 | ;; frame and turn on `follow-mode'. | |
178 | ;; | |
179 | ;; follow-first-window C-c . < | |
180 | ;; Select the first window in the frame showing the same buffer. | |
181 | ;; | |
182 | ;; follow-last-window C-c . > | |
183 | ;; Select the last window in the frame showing the same buffer. | |
184 | ;; | |
185 | ;; follow-next-window C-c . n | |
186 | ;; Select the next window in the frame showing the same buffer. | |
187 | ;; | |
188 | ;; follow-previous-window C-c . p | |
189 | ;; Select the previous window showing the same buffer. | |
190 | ||
191 | ||
192 | ;; Well, it seems ok, but what if I really want to look at two different | |
193 | ;; positions in the text? Here are two simple methods to use: | |
194 | ;; | |
195 | ;; 1) Use multiple frames; `follow' mode only affects windows displayed | |
196 | ;; in the same frame. (My apoligies to you who can't use frames.) | |
197 | ;; | |
198 | ;; 2) Bind `follow-mode' to key so you can turn it off whenever | |
08a1dbe6 | 199 | ;; you want to view two locations. Of course, `follow' mode can |
e79016aa KH |
200 | ;; be reactivated by hitting the same key again. |
201 | ;; | |
202 | ;; Example from my ~/.emacs: | |
203 | ;; (global-set-key [f8] 'follow-mode) | |
204 | ||
205 | ||
cb02be17 | 206 | ;; Implementation: |
e79016aa KH |
207 | ;; |
208 | ;; In an ideal world, follow mode would have been implemented in the | |
ff753438 | 209 | ;; kernel of the display routines, making sure that the windows (using |
08a1dbe6 | 210 | ;; follow mode) ALWAYS are aligned. On planet earth, however, we must |
e79016aa KH |
211 | ;; accept a solution where we ALMOST ALWAYS can make sure that the |
212 | ;; windows are aligned. | |
213 | ;; | |
214 | ;; Follow mode does this in three places: | |
215 | ;; 1) After each user command. | |
216 | ;; 2) After a process output has been perfomed. | |
217 | ;; 3) When a scrollbar has been moved. | |
218 | ;; | |
219 | ;; This will cover most situations. (Let me know if there are other | |
ff753438 | 220 | ;; situations that should be covered.) |
e79016aa | 221 | ;; |
ff753438 RS |
222 | ;; Note that only the selected window is checked, for the reason of |
223 | ;; efficiency and code complexity. (I.e. it is possible to make a | |
08a1dbe6 | 224 | ;; non-selected windows unaligned. It will, however, pop right back |
e79016aa KH |
225 | ;; when it is selected.) |
226 | ||
e79016aa KH |
227 | ;;}}} |
228 | ||
229 | ;;; Code: | |
230 | ||
231 | ;;{{{ Preliminaries | |
232 | ||
233 | ;; Make the compiler shut up! | |
234 | ;; There are two strategies: | |
235 | ;; 1) Shut warnings off completely. | |
236 | ;; 2) Handle each warning separately. | |
237 | ;; | |
238 | ;; Since I would like to see real errors, I've selected the latter | |
239 | ;; method. | |
240 | ;; | |
241 | ;; The problem with undefined variables and functions has been solved | |
242 | ;; by using `set', `symbol-value' and `symbol-function' rather than | |
243 | ;; `setq' and direct references to variables and functions. | |
244 | ;; | |
245 | ;; For example: | |
246 | ;; (if (boundp 'foo) ... (symbol-value 'foo) ) | |
247 | ;; (set 'foo ...) <-- XEmacs doesn't fall for this one. | |
248 | ;; (funcall (symbol-function 'set) 'bar ...) | |
249 | ;; | |
250 | ;; Note: When this file is interpreted, `eval-when-compile' is | |
ff753438 RS |
251 | ;; evaluted. Since it doesn't hurt to evaluate it, but it is a bit |
252 | ;; annoying, we test if the byte-compiler has been loaded. This can, | |
253 | ;; of course, lead to some occasional unintended evaluation... | |
e79016aa KH |
254 | ;; |
255 | ;; Should someone come up with a better solution, please let me | |
256 | ;; know. | |
257 | ||
258 | (eval-when-compile | |
259 | (if (or (featurep 'bytecomp) | |
260 | (featurep 'byte-compile)) | |
08a1dbe6 | 261 | (cond ((featurep 'xemacs) |
e79016aa KH |
262 | ;; Make XEmacs shut up! I'm using standard Emacs |
263 | ;; functions, they are NOT obsolete! | |
264 | (if (eq (get 'force-mode-line-update 'byte-compile) | |
265 | 'byte-compile-obsolete) | |
266 | (put 'force-mode-line-update 'byte-compile 'nil)) | |
267 | (if (eq (get 'frame-first-window 'byte-compile) | |
268 | 'byte-compile-obsolete) | |
269 | (put 'frame-first-window 'byte-compile 'nil)))))) | |
270 | ||
271 | ;;}}} | |
272 | ;;{{{ Variables | |
273 | ||
4bef9110 SE |
274 | (defgroup follow nil |
275 | "Synchronize windows showing the same buffer." | |
276 | :prefix "follow-" | |
f5f727f8 DN |
277 | :group 'windows |
278 | :group 'convenience) | |
4bef9110 | 279 | |
4bef9110 | 280 | (defcustom follow-mode-hook nil |
8cd3480b | 281 | "Hooks to run when Follow mode is turned on." |
4bef9110 SE |
282 | :type 'hook |
283 | :group 'follow) | |
e79016aa | 284 | |
4bef9110 | 285 | (defcustom follow-mode-off-hook nil |
8cd3480b | 286 | "Hooks to run when Follow mode is turned off." |
4bef9110 SE |
287 | :type 'hook |
288 | :group 'follow) | |
e79016aa | 289 | |
e79016aa | 290 | |
08a1dbe6 | 291 | ;;{{{ Keymap/Menu |
e79016aa | 292 | |
08a1dbe6 SM |
293 | ;; Define keys for the follow-mode minor mode map and replace some |
294 | ;; functions in the global map. All `follow' mode special functions | |
295 | ;; can be found on (the somewhat cumbersome) "C-c . <key>" | |
296 | ;; (Control-C dot <key>). (As of Emacs 19.29 the keys | |
297 | ;; C-c <punctuation character> are reserved for minor modes.) | |
298 | ;; | |
299 | ;; To change the prefix, redefine `follow-mode-prefix' before | |
300 | ;; `follow' is loaded, or see the section on `follow-mode-hook' | |
301 | ;; above for an example of how to bind the keys the way you like. | |
302 | ;; | |
303 | ;; Please note that the keymap is defined the first time this file is | |
304 | ;; loaded. Also note that the only legal way to manipulate the | |
305 | ;; keymap is to use `define-key'. Don't change it using `setq' or | |
306 | ;; similar! | |
e79016aa | 307 | |
4bef9110 | 308 | (defcustom follow-mode-prefix "\C-c." |
08a1dbe6 | 309 | "Prefix key to use for follow commands in Follow mode. |
e79016aa | 310 | The value of this variable is checked as part of loading Follow mode. |
4bef9110 SE |
311 | After that, changing the prefix key requires manipulating keymaps." |
312 | :type 'string | |
313 | :group 'follow) | |
314 | ||
08a1dbe6 SM |
315 | (defvar follow-mode-map |
316 | (let ((mainmap (make-sparse-keymap)) | |
317 | (map (make-sparse-keymap))) | |
e79016aa KH |
318 | (define-key map "\C-v" 'follow-scroll-up) |
319 | (define-key map "\M-v" 'follow-scroll-down) | |
320 | (define-key map "v" 'follow-scroll-down) | |
321 | (define-key map "1" 'follow-delete-other-windows-and-split) | |
322 | (define-key map "b" 'follow-switch-to-buffer) | |
323 | (define-key map "\C-b" 'follow-switch-to-buffer-all) | |
324 | (define-key map "\C-l" 'follow-recenter) | |
325 | (define-key map "<" 'follow-first-window) | |
326 | (define-key map ">" 'follow-last-window) | |
327 | (define-key map "n" 'follow-next-window) | |
328 | (define-key map "p" 'follow-previous-window) | |
329 | ||
08a1dbe6 | 330 | (define-key mainmap follow-mode-prefix map) |
e79016aa KH |
331 | |
332 | ;; Replace the standard `end-of-buffer', when in Follow Mode. (I | |
ff753438 | 333 | ;; don't see the point in trying to replace every function that |
e79016aa KH |
334 | ;; could be enhanced in Follow mode. End-of-buffer is a special |
335 | ;; case since it is very simple to define and it greatly enhances | |
336 | ;; the look and feel of Follow mode.) | |
08a1dbe6 | 337 | (define-key mainmap [remap end-of-buffer] 'follow-end-of-buffer) |
e79016aa | 338 | |
08a1dbe6 SM |
339 | mainmap) |
340 | "Minor mode keymap for Follow mode.") | |
e79016aa | 341 | |
7dcef48d SM |
342 | ;; When the mode is not activated, only one item is visible to activate |
343 | ;; the mode. | |
344 | (defun follow-menu-filter (menu) | |
345 | (if (bound-and-true-p 'follow-mode) | |
346 | menu | |
347 | '(["Follow mode " follow-mode | |
348 | :style toggle :selected follow-mode]))) | |
349 | ||
350 | ;; If there is a `tools' menu, we use it. However, we can't add a | |
351 | ;; minor-mode specific item to it (it's broken), so we make the | |
352 | ;; contents ghosted when not in use, and add ourselves to the | |
353 | ;; global map. | |
354 | (easy-menu-add-item nil '("Tools") | |
355 | '("Follow" | |
356 | ;; The Emacs code used to just grey out operations when follow-mode was | |
357 | ;; not enabled, whereas the XEmacs code used to remove it altogether. | |
358 | ;; Not sure which is preferable, but clearly the preference should not | |
359 | ;; depend on the flavor. | |
360 | :filter follow-menu-filter | |
361 | ["Scroll Up" follow-scroll-up follow-mode] | |
362 | ["Scroll Down" follow-scroll-down follow-mode] | |
363 | "--" | |
364 | ["Delete Other Windows and Split" follow-delete-other-windows-and-split follow-mode] | |
365 | "--" | |
366 | ["Switch To Buffer" follow-switch-to-buffer follow-mode] | |
367 | ["Switch To Buffer (all windows)" follow-switch-to-buffer-all follow-mode] | |
368 | "--" | |
369 | ["First Window" follow-first-window follow-mode] | |
370 | ["Last Window" follow-last-window follow-mode] | |
371 | ["Next Window" follow-next-window follow-mode] | |
372 | ["Previous Window" follow-previous-window follow-mode] | |
373 | "--" | |
374 | ["Recenter" follow-recenter follow-mode] | |
375 | "--" | |
376 | ["Follow mode" follow-mode :style toggle :selected follow-mode])) | |
377 | ||
08a1dbe6 | 378 | ;;}}} |
e79016aa | 379 | |
08a1dbe6 SM |
380 | (defcustom follow-mode-line-text " Follow" |
381 | "Text shown in the mode line when Follow mode is active. | |
382 | Defaults to \" Follow\". Examples of other values | |
383 | are \" Fw\", or simply \"\"." | |
384 | :type 'string | |
385 | :group 'follow) | |
386 | ||
387 | (defcustom follow-auto nil | |
388 | "Non-nil activates Follow mode whenever a file is loaded." | |
389 | :type 'boolean | |
390 | :group 'follow) | |
391 | ||
392 | (defcustom follow-intercept-processes (fboundp 'start-process) | |
393 | "When non-nil, Follow Mode will monitor process output." | |
394 | :type 'boolean | |
395 | :group 'follow) | |
396 | ||
397 | (defvar follow-avoid-tail-recenter-p (not (featurep 'xemacs)) | |
f02725b4 | 398 | "*When non-nil, patch Emacs so that tail windows won't be recentered. |
08a1dbe6 SM |
399 | |
400 | A \"tail window\" is a window that displays only the end of | |
401 | the buffer. Normally it is practical for the user that empty | |
402 | windows are recentered automatically. However, when using | |
403 | Follow Mode it breaks the display when the end is displayed | |
404 | in a window \"above\" the last window. This is for | |
405 | example the case when displaying a short page in info. | |
406 | ||
407 | Must be set before Follow Mode is loaded. | |
408 | ||
409 | Please note that it is not possible to fully prevent Emacs from | |
410 | recentering empty windows. Please report if you find a repeatable | |
411 | situation in which Emacs recenters empty windows. | |
412 | ||
413 | XEmacs, as of 19.12, does not recenter windows, good!") | |
414 | ||
415 | (defvar follow-cache-command-list | |
416 | '(next-line previous-line forward-char backward-char) | |
417 | "List of commands that don't require recalculation. | |
418 | ||
419 | In order to be able to use the cache, a command should not change the | |
420 | contents of the buffer, nor should it change selected window or current | |
421 | buffer. | |
422 | ||
423 | The commands in this list are checked at load time. | |
424 | ||
425 | To mark other commands as suitable for caching, set the symbol | |
426 | property `follow-mode-use-cache' to non-nil.") | |
427 | ||
428 | (defvar follow-debug nil | |
429 | "*Non-nil when debugging Follow mode.") | |
430 | ||
431 | ||
432 | ;; Internal variables: | |
433 | ||
434 | (defvar follow-internal-force-redisplay nil | |
435 | "True when Follow mode should redisplay the windows.") | |
436 | ||
437 | (defvar follow-process-filter-alist '() | |
438 | "The original filters for processes intercepted by Follow mode.") | |
439 | ||
440 | (defvar follow-active-menu nil | |
441 | "The menu visible when Follow mode is active.") | |
442 | ||
443 | (defvar follow-deactive-menu nil | |
444 | "The menu visible when Follow mode is deactivated.") | |
445 | ||
446 | (defvar follow-inside-post-command-hook nil | |
447 | "Non-nil when inside Follow modes `post-command-hook'. | |
448 | Used by `follow-window-size-change'.") | |
449 | ||
450 | (defvar follow-windows-start-end-cache nil | |
451 | "Cache used by `follow-window-start-end'.") | |
452 | ||
453 | ;;}}} | |
454 | ;;{{{ Debug messages | |
455 | ||
456 | ;; This inline function must be as small as possible! | |
457 | ;; Maybe we should define a macro that expands to nil if | |
458 | ;; the variable is not set. | |
459 | ||
460 | (defsubst follow-debug-message (&rest args) | |
461 | "Like message, but only active when `follow-debug' is non-nil." | |
462 | (if (and (boundp 'follow-debug) follow-debug) | |
463 | (apply 'message args))) | |
e79016aa | 464 | |
f3bfa025 KH |
465 | ;;}}} |
466 | ;;{{{ Cache | |
467 | ||
08a1dbe6 SM |
468 | (dolist (cmd follow-cache-command-list) |
469 | (put cmd 'follow-mode-use-cache t)) | |
f3bfa025 | 470 | |
e79016aa KH |
471 | ;;}}} |
472 | ||
473 | ;;{{{ The mode | |
474 | ||
475 | ;;;###autoload | |
476 | (defun turn-on-follow-mode () | |
08a1dbe6 | 477 | "Turn on Follow mode. Please see the function `follow-mode'." |
e79016aa KH |
478 | (follow-mode 1)) |
479 | ||
480 | ||
481 | ;;;###autoload | |
482 | (defun turn-off-follow-mode () | |
08a1dbe6 | 483 | "Turn off Follow mode. Please see the function `follow-mode'." |
e79016aa KH |
484 | (follow-mode -1)) |
485 | ||
08a1dbe6 | 486 | (put 'follow-mode 'permanent-local t) |
e79016aa | 487 | ;;;###autoload |
08a1dbe6 | 488 | (define-minor-mode follow-mode |
ff753438 | 489 | "Minor mode that combines windows into one tall virtual window. |
e79016aa KH |
490 | |
491 | The feeling of a \"virtual window\" has been accomplished by the use | |
492 | of two major techniques: | |
493 | ||
cb02be17 | 494 | * The windows always displays adjacent sections of the buffer. |
e79016aa KH |
495 | This means that whenever one window is moved, all the |
496 | others will follow. (Hence the name Follow Mode.) | |
497 | ||
cb02be17 KH |
498 | * Should the point (cursor) end up outside a window, another |
499 | window displaying that point is selected, if possible. This | |
500 | makes it possible to walk between windows using normal cursor | |
e79016aa KH |
501 | movement commands. |
502 | ||
503 | Follow mode comes to its prime when used on a large screen and two | |
3eaf40f7 | 504 | side-by-side windows are used. The user can, with the help of Follow |
e79016aa | 505 | mode, use two full-height windows as though they would have been |
8cd3480b | 506 | one. Imagine yourself editing a large function, or section of text, |
c8d05b03 | 507 | and being able to use 144 lines instead of the normal 72... (your |
e79016aa KH |
508 | mileage may vary). |
509 | ||
510 | To split one large window into two side-by-side windows, the commands | |
511 | `\\[split-window-horizontally]' or \ | |
512 | `M-x follow-delete-other-windows-and-split' can be used. | |
513 | ||
8cd3480b | 514 | Only windows displayed in the same frame follow each other. |
e79016aa KH |
515 | |
516 | If the variable `follow-intercept-processes' is non-nil, Follow mode | |
517 | will listen to the output of processes and redisplay accordingly. | |
518 | \(This is the default.) | |
519 | ||
520 | When Follow mode is switched on, the hook `follow-mode-hook' | |
521 | is called. When turned off, `follow-mode-off-hook' is called. | |
522 | ||
523 | Keys specific to Follow mode: | |
524 | \\{follow-mode-map}" | |
08a1dbe6 SM |
525 | :keymap follow-mode-map |
526 | (if (and follow-mode follow-intercept-processes) | |
527 | (follow-intercept-process-output)) | |
528 | (cond (follow-mode ; On | |
529 | ;; XEmacs: If this is non-nil, the window will scroll before | |
530 | ;; the point will have a chance to get into the next window. | |
531 | (if (boundp 'scroll-on-clipped-lines) | |
532 | (setq scroll-on-clipped-lines nil)) | |
533 | (force-mode-line-update) | |
534 | (add-hook 'post-command-hook 'follow-post-command-hook t) | |
535 | (run-hooks 'follow-mode-hook)) | |
536 | ||
537 | ((not follow-mode) ; Off | |
538 | (force-mode-line-update) | |
539 | (run-hooks 'follow-mode-off-hook)))) | |
e79016aa KH |
540 | |
541 | ;;}}} | |
542 | ;;{{{ Find file hook | |
543 | ||
544 | ;; This will start follow-mode whenever a new file is loaded, if | |
545 | ;; the variable `follow-auto' is non-nil. | |
546 | ||
ffc30f4f | 547 | (add-hook 'find-file-hook 'follow-find-file-hook t) |
e79016aa KH |
548 | |
549 | (defun follow-find-file-hook () | |
550 | "Find-file hook for Follow Mode. See the variable `follow-auto'." | |
551 | (if follow-auto (follow-mode t))) | |
552 | ||
553 | ;;}}} | |
554 | ||
555 | ;;{{{ User functions | |
556 | ||
557 | ;;; | |
558 | ;;; User functions usable when in Follow mode. | |
559 | ;;; | |
560 | ||
561 | ;;{{{ Scroll | |
562 | ||
563 | ;; `scroll-up' and `-down', but for windows in Follow Mode. | |
564 | ;; | |
565 | ;; Almost like the real thing, excpet when the cursor ends up outside | |
566 | ;; the top or bottom... In our case however, we end up outside the | |
567 | ;; window and hence we are recenterd. Should we let `recenter' handle | |
568 | ;; the point position we would never leave the selected window. To do | |
569 | ;; it ourselves we would need to do our own redisplay, which is easier | |
570 | ;; said than done. (Why didn't I do a real display abstraction from | |
571 | ;; the beginning?) | |
572 | ;; | |
573 | ;; We must sometimes set `follow-internal-force-redisplay', otherwise | |
574 | ;; our post-command-hook will move our windows back into the old | |
575 | ;; position... (This would also be corrected if we would have had a | |
576 | ;; good redisplay abstraction.) | |
577 | ||
578 | (defun follow-scroll-up (&optional arg) | |
579 | "Scroll text in a Follow Mode window chain up. | |
580 | ||
581 | If called with no ARG, the `next-screen-context-lines' last lines of | |
582 | the bottom window in the chain will be visible in the top window. | |
583 | ||
584 | If called with an argument, scroll ARG lines up. | |
585 | Negative ARG means scroll downward. | |
586 | ||
587 | Works like `scroll-up' when not in Follow Mode." | |
588 | (interactive "P") | |
589 | (cond ((not (and (boundp 'follow-mode) follow-mode)) | |
590 | (scroll-up arg)) | |
591 | (arg | |
592 | (save-excursion (scroll-up arg)) | |
593 | (setq follow-internal-force-redisplay t)) | |
594 | (t | |
595 | (let* ((windows (follow-all-followers)) | |
596 | (end (window-end (car (reverse windows))))) | |
597 | (if (eq end (point-max)) | |
598 | (signal 'end-of-buffer nil) | |
599 | (select-window (car windows)) | |
ff753438 RS |
600 | ;; `window-end' might return nil. |
601 | (if end | |
602 | (goto-char end)) | |
e79016aa KH |
603 | (vertical-motion (- next-screen-context-lines)) |
604 | (set-window-start (car windows) (point))))))) | |
605 | ||
606 | ||
607 | (defun follow-scroll-down (&optional arg) | |
608 | "Scroll text in a Follow Mode window chain down. | |
609 | ||
610 | If called with no ARG, the `next-screen-context-lines' top lines of | |
611 | the top window in the chain will be visible in the bottom window. | |
612 | ||
613 | If called with an argument, scroll ARG lines down. | |
614 | Negative ARG means scroll upward. | |
615 | ||
616 | Works like `scroll-up' when not in Follow Mode." | |
617 | (interactive "P") | |
618 | (cond ((not (and (boundp 'follow-mode) follow-mode)) | |
619 | (scroll-up arg)) | |
620 | (arg | |
621 | (save-excursion (scroll-down arg))) | |
622 | (t | |
623 | (let* ((windows (follow-all-followers)) | |
624 | (win (car (reverse windows))) | |
625 | (start (window-start (car windows)))) | |
626 | (if (eq start (point-min)) | |
627 | (signal 'beginning-of-buffer nil) | |
628 | (select-window win) | |
629 | (goto-char start) | |
cb02be17 KH |
630 | (vertical-motion (- (- (window-height win) |
631 | 1 | |
e79016aa KH |
632 | next-screen-context-lines))) |
633 | (set-window-start win (point)) | |
634 | (goto-char start) | |
635 | (vertical-motion (- next-screen-context-lines 1)) | |
636 | (setq follow-internal-force-redisplay t)))))) | |
637 | ||
638 | ;;}}} | |
639 | ;;{{{ Buffer | |
640 | ||
641 | ;;;###autoload | |
642 | (defun follow-delete-other-windows-and-split (&optional arg) | |
643 | "Create two side by side windows and enter Follow Mode. | |
644 | ||
645 | Execute this command to display as much as possible of the text | |
cb02be17 | 646 | in the selected window. All other windows, in the current |
e79016aa | 647 | frame, are deleted and the selected window is split in two |
8cd3480b | 648 | side-by-side windows. Follow Mode is activated, hence the |
e79016aa KH |
649 | two windows always will display two successive pages. |
650 | \(If one window is moved, the other one will follow.) | |
651 | ||
8cd3480b | 652 | If ARG is positive, the leftmost window is selected. If negative, |
e79016aa KH |
653 | the rightmost is selected. If ARG is nil, the leftmost window is |
654 | selected if the original window is the first one in the frame. | |
655 | ||
656 | To bind this command to a hotkey, place the following line | |
657 | in your `~/.emacs' file, replacing [f7] by your favourite key: | |
658 | (global-set-key [f7] 'follow-delete-other-windows-and-split)" | |
659 | (interactive "P") | |
cb02be17 | 660 | (let ((other (or (and (null arg) |
e79016aa KH |
661 | (not (eq (selected-window) |
662 | (frame-first-window (selected-frame))))) | |
663 | (and arg | |
664 | (< (prefix-numeric-value arg) 0)))) | |
665 | (start (window-start))) | |
666 | (delete-other-windows) | |
667 | (split-window-horizontally) | |
cb02be17 | 668 | (if other |
e79016aa KH |
669 | (progn |
670 | (other-window 1) | |
671 | (set-window-start (selected-window) start) | |
672 | (setq follow-internal-force-redisplay t))) | |
673 | (follow-mode 1))) | |
674 | ||
675 | (defun follow-switch-to-buffer (buffer) | |
676 | "Show BUFFER in all windows in the current Follow Mode window chain." | |
677 | (interactive "BSwitch to Buffer: ") | |
678 | (let ((orig-window (selected-window)) | |
679 | (windows (follow-all-followers))) | |
680 | (while windows | |
681 | (select-window (car windows)) | |
682 | (switch-to-buffer buffer) | |
683 | (setq windows (cdr windows))) | |
684 | (select-window orig-window))) | |
685 | ||
686 | ||
687 | (defun follow-switch-to-buffer-all (&optional buffer) | |
688 | "Show BUFFER in all windows on this frame. | |
689 | Defaults to current buffer." | |
cb02be17 | 690 | (interactive (list (read-buffer "Switch to Buffer: " |
e79016aa KH |
691 | (current-buffer)))) |
692 | (or buffer (setq buffer (current-buffer))) | |
693 | (let ((orig-window (selected-window))) | |
cb02be17 KH |
694 | (walk-windows |
695 | (function | |
e79016aa KH |
696 | (lambda (win) |
697 | (select-window win) | |
698 | (switch-to-buffer buffer)))) | |
699 | (select-window orig-window) | |
700 | (follow-redisplay))) | |
701 | ||
702 | ||
703 | (defun follow-switch-to-current-buffer-all () | |
704 | "Show current buffer in all windows on this frame, and enter Follow Mode. | |
705 | ||
cb02be17 | 706 | To bind this command to a hotkey place the following line |
e79016aa KH |
707 | in your `~/.emacs' file: |
708 | (global-set-key [f7] 'follow-switch-to-current-buffer-all)" | |
709 | (interactive) | |
710 | (or (and (boundp 'follow-mode) follow-mode) | |
711 | (follow-mode 1)) | |
712 | (follow-switch-to-buffer-all)) | |
713 | ||
714 | ;;}}} | |
715 | ;;{{{ Movement | |
716 | ||
717 | ;; Note, these functions are not very useful, atleast not unless you | |
718 | ;; rebind the rather cumbersome key sequence `C-c . p'. | |
719 | ||
720 | (defun follow-next-window () | |
721 | "Select the next window showing the same buffer." | |
722 | (interactive) | |
723 | (let ((succ (cdr (follow-split-followers (follow-all-followers))))) | |
724 | (if succ | |
725 | (select-window (car succ)) | |
726 | (error "%s" "No more windows")))) | |
727 | ||
728 | ||
729 | (defun follow-previous-window () | |
730 | "Select the previous window showing the same buffer." | |
731 | (interactive) | |
732 | (let ((pred (car (follow-split-followers (follow-all-followers))))) | |
733 | (if pred | |
734 | (select-window (car pred)) | |
735 | (error "%s" "No more windows")))) | |
736 | ||
737 | ||
738 | (defun follow-first-window () | |
739 | "Select the first window in the frame showing the same buffer." | |
740 | (interactive) | |
741 | (select-window (car (follow-all-followers)))) | |
742 | ||
743 | ||
744 | (defun follow-last-window () | |
745 | "Select the last window in the frame showing the same buffer." | |
746 | (interactive) | |
747 | (select-window (car (reverse (follow-all-followers))))) | |
748 | ||
749 | ;;}}} | |
750 | ;;{{{ Redraw | |
751 | ||
752 | (defun follow-recenter (&optional arg) | |
cb02be17 KH |
753 | "Recenter the middle window around point. |
754 | Rearrange all other windows around the middle window. | |
e79016aa KH |
755 | |
756 | With a positive argument, place the current line ARG lines | |
8cd3480b JB |
757 | from the top. With a negative argument, place it -ARG lines |
758 | from the bottom." | |
e79016aa KH |
759 | (interactive "P") |
760 | (if arg | |
761 | (let ((p (point)) | |
762 | (arg (prefix-numeric-value arg))) | |
763 | (if (>= arg 0) | |
764 | ;; Recenter relative to the top. | |
765 | (progn | |
766 | (follow-first-window) | |
767 | (goto-char p) | |
768 | (recenter arg)) | |
769 | ;; Recenter relative to the bottom. | |
770 | (follow-last-window) | |
771 | (goto-char p) | |
772 | (recenter arg) | |
773 | ;; Otherwise, our post-command-hook will move the window | |
774 | ;; right back. | |
775 | (setq follow-internal-force-redisplay t))) | |
776 | ;; Recenter in the middle. | |
777 | (let* ((dest (point)) | |
778 | (windows (follow-all-followers)) | |
779 | (win (nth (/ (- (length windows) 1) 2) windows))) | |
780 | (select-window win) | |
781 | (goto-char dest) | |
782 | (recenter) | |
783 | ;;(setq follow-internal-force-redisplay t) | |
784 | ))) | |
785 | ||
786 | ||
787 | (defun follow-redraw () | |
788 | "Arrange windows displaying the same buffer in successor order. | |
789 | This function can be called even if the buffer is not in Follow mode. | |
790 | ||
791 | Hopefully, there should be no reason to call this function when in | |
792 | Follow mode since the windows should always be aligned." | |
793 | (interactive) | |
794 | (sit-for 0) | |
795 | (follow-redisplay)) | |
796 | ||
797 | ;;}}} | |
798 | ;;{{{ End of buffer | |
799 | ||
800 | (defun follow-end-of-buffer (&optional arg) | |
cb02be17 | 801 | "Move point to the end of the buffer, Follow Mode style. |
e79016aa KH |
802 | |
803 | If the end is not visible, it will be displayed in the last possible | |
804 | window in the Follow Mode window chain. | |
805 | ||
cb02be17 | 806 | The mark is left at the previous position. With arg N, put point N/10 |
e79016aa KH |
807 | of the way from the true end." |
808 | (interactive "P") | |
809 | (let ((followers (follow-all-followers)) | |
810 | (pos (point))) | |
811 | (cond (arg | |
812 | (select-window (car (reverse followers)))) | |
cb02be17 | 813 | ((follow-select-if-end-visible |
e79016aa KH |
814 | (follow-windows-start-end followers))) |
815 | (t | |
816 | (select-window (car (reverse followers))))) | |
817 | (goto-char pos) | |
2a4b9211 RS |
818 | (with-no-warnings |
819 | (end-of-buffer arg)))) | |
e79016aa KH |
820 | |
821 | ;;}}} | |
822 | ||
823 | ;;}}} | |
824 | ||
825 | ;;{{{ Display | |
826 | ||
827 | ;;;; The display routines | |
828 | ||
829 | ;;{{{ Information gathering functions | |
830 | ||
831 | (defun follow-all-followers (&optional testwin) | |
832 | "Return all windows displaying the same buffer as the TESTWIN. | |
833 | The list contains only windows displayed in the same frame as TESTWIN. | |
834 | If TESTWIN is nil the selected window is used." | |
09c013ef | 835 | (or (window-live-p testwin) |
e79016aa KH |
836 | (setq testwin (selected-window))) |
837 | (let* ((top (frame-first-window (window-frame testwin))) | |
838 | (win top) | |
839 | (done nil) | |
840 | (windows '()) | |
841 | (buffer (window-buffer testwin))) | |
842 | (while (and (not done) win) | |
843 | (if (eq (window-buffer win) buffer) | |
844 | (setq windows (cons win windows))) | |
845 | (setq win (next-window win 'not)) | |
846 | (if (eq win top) | |
847 | (setq done t))) | |
848 | (nreverse windows))) | |
849 | ||
850 | ||
851 | (defun follow-split-followers (windows &optional win) | |
852 | "Split the WINDOWS into the sets: predecessors and successors. | |
cb02be17 | 853 | Return `(PRED . SUCC)' where `PRED' and `SUCC' are ordered starting |
e79016aa | 854 | from the selected window." |
cb02be17 | 855 | (or win |
e79016aa KH |
856 | (setq win (selected-window))) |
857 | (let ((pred '())) | |
858 | (while (not (eq (car windows) win)) | |
859 | (setq pred (cons (car windows) pred)) | |
860 | (setq windows (cdr windows))) | |
861 | (cons pred (cdr windows)))) | |
862 | ||
863 | ||
ff753438 | 864 | ;; This function is optimized function for speed! |
e79016aa KH |
865 | |
866 | (defun follow-calc-win-end (&optional win) | |
867 | "Calculate the presumed window end for WIN. | |
868 | ||
869 | Actually, the position returned is the start of the next | |
870 | window, normally is the end plus one. | |
871 | ||
872 | If WIN is nil, the selected window is used. | |
873 | ||
874 | Returns (end-pos end-of-buffer-p)" | |
08a1dbe6 | 875 | (if (featurep 'xemacs) |
e79016aa KH |
876 | ;; XEmacs can calculate the end of the window by using |
877 | ;; the 'guarantee options. GOOD! | |
878 | (let ((end (window-end win t))) | |
879 | (if (= end (funcall (symbol-function 'point-max) | |
880 | (window-buffer win))) | |
881 | (list end t) | |
cb02be17 | 882 | (list (+ end 1) nil))) |
ff753438 RS |
883 | ;; Emacs: We have to calculate the end by ourselves. |
884 | ;; This code works on both XEmacs and Emacs, but now | |
e79016aa | 885 | ;; that XEmacs has got custom-written code, this could |
ff753438 | 886 | ;; be optimized for Emacs. |
e79016aa KH |
887 | (let ((orig-win (and win (selected-window))) |
888 | height | |
889 | buffer-end-p) | |
890 | (if win (select-window win)) | |
891 | (prog1 | |
892 | (save-excursion | |
893 | (goto-char (window-start)) | |
894 | (setq height (- (window-height) 1)) | |
895 | (setq buffer-end-p | |
896 | (if (bolp) | |
897 | (not (= height (vertical-motion height))) | |
898 | (save-restriction | |
899 | ;; Fix a mis-feature in `vertical-motion': | |
900 | ;; The start of the window is assumed to | |
901 | ;; coinside with the start of a line. | |
902 | (narrow-to-region (point) (point-max)) | |
903 | (not (= height (vertical-motion height)))))) | |
904 | (list (point) buffer-end-p)) | |
905 | (if orig-win | |
906 | (select-window orig-win)))))) | |
907 | ||
908 | ||
909 | ;; Can't use `save-window-excursion' since it triggers a redraw. | |
910 | (defun follow-calc-win-start (windows pos win) | |
911 | "Calculate where WIN will start if the first in WINDOWS start at POS. | |
912 | ||
913 | If WIN is nil the point below all windows is returned." | |
914 | (let (start) | |
915 | (while (and windows (not (eq (car windows) win))) | |
916 | (setq start (window-start (car windows))) | |
917 | (set-window-start (car windows) pos 'noforce) | |
918 | (setq pos (car (inline (follow-calc-win-end (car windows))))) | |
919 | (set-window-start (car windows) start 'noforce) | |
920 | (setq windows (cdr windows))) | |
921 | pos)) | |
922 | ||
923 | ||
f3bfa025 KH |
924 | ;; The result from `follow-windows-start-end' is cached when using |
925 | ;; a handful simple commands, like cursor movement commands. | |
926 | ||
927 | (defsubst follow-cache-valid-p (windows) | |
928 | "Test if the cached value of `follow-windows-start-end' can be used. | |
929 | Note that this handles the case when the cache has been set to nil." | |
930 | (let ((res t) | |
931 | (cache follow-windows-start-end-cache)) | |
932 | (while (and res windows cache) | |
933 | (setq res (and (eq (car windows) | |
934 | (car (car cache))) | |
935 | (eq (window-start (car windows)) | |
936 | (car (cdr (car cache)))))) | |
937 | (setq windows (cdr windows)) | |
938 | (setq cache (cdr cache))) | |
939 | (and res (null windows) (null cache)))) | |
940 | ||
941 | ||
942 | (defsubst follow-invalidate-cache () | |
943 | "Force `follow-windows-start-end' to recalculate the end of the window." | |
944 | (setq follow-windows-start-end-cache nil)) | |
945 | ||
946 | ||
e79016aa KH |
947 | ;; Build a list of windows and their start and end positions. |
948 | ;; Useful to avoid calculating start/end position whenever they are needed. | |
949 | ;; The list has the format: | |
950 | ;; ((Win Start End End-of-buffer-visible-p) ...) | |
951 | ||
952 | ;; Used to have a `save-window-excursion', but it obviously triggered | |
953 | ;; redraws of the display. Check if I used it for anything. | |
954 | ||
955 | ||
956 | (defun follow-windows-start-end (windows) | |
957 | "Builds a list of (WIN START END BUFFER-END-P) for every window in WINDOWS." | |
f3bfa025 KH |
958 | (if (follow-cache-valid-p windows) |
959 | follow-windows-start-end-cache | |
960 | (let ((win-start-end '()) | |
961 | (orig-win (selected-window))) | |
962 | (while windows | |
963 | (select-window (car windows)) | |
cb02be17 KH |
964 | (setq win-start-end |
965 | (cons (cons (car windows) | |
f3bfa025 KH |
966 | (cons (window-start) |
967 | (follow-calc-win-end))) | |
968 | win-start-end)) | |
969 | (setq windows (cdr windows))) | |
970 | (select-window orig-win) | |
971 | (setq follow-windows-start-end-cache (nreverse win-start-end)) | |
972 | follow-windows-start-end-cache))) | |
973 | ||
974 | ||
975 | (defsubst follow-pos-visible (pos win win-start-end) | |
e79016aa KH |
976 | "Non-nil when POS is visible in WIN." |
977 | (let ((wstart-wend-bend (cdr (assq win win-start-end)))) | |
978 | (and (>= pos (car wstart-wend-bend)) | |
979 | (or (< pos (car (cdr wstart-wend-bend))) | |
980 | (nth 2 wstart-wend-bend))))) | |
981 | ||
982 | ||
983 | ;; By `aligned' we mean that for all adjecent windows, the end of the | |
984 | ;; first is equal with the start of the successor. The first window | |
985 | ;; should start at a full screen line. | |
986 | ||
f3bfa025 | 987 | (defsubst follow-windows-aligned-p (win-start-end) |
8cd3480b | 988 | "Non-nil if the follower windows are aligned." |
cb02be17 | 989 | (let ((res t)) |
e79016aa KH |
990 | (save-excursion |
991 | (goto-char (window-start (car (car win-start-end)))) | |
992 | (if (bolp) | |
993 | nil | |
994 | (vertical-motion 0 (car (car win-start-end))) | |
995 | (setq res (eq (point) (window-start (car (car win-start-end))))))) | |
996 | (while (and res (cdr win-start-end)) | |
997 | ;; At least two followers left | |
f3bfa025 KH |
998 | (setq res (eq (car (cdr (cdr (car win-start-end)))) |
999 | (car (cdr (car (cdr win-start-end)))))) | |
e79016aa KH |
1000 | (setq win-start-end (cdr win-start-end))) |
1001 | res)) | |
1002 | ||
1003 | ||
1004 | ;; Check if the point is visible in all windows. (So that | |
1005 | ;; no one will be recentered.) | |
1006 | ||
1007 | (defun follow-point-visible-all-windows-p (win-start-end) | |
8cd3480b | 1008 | "Non-nil when the `window-point' is visible in all windows." |
e79016aa KH |
1009 | (let ((res t)) |
1010 | (while (and res win-start-end) | |
f3bfa025 KH |
1011 | (setq res (follow-pos-visible (window-point (car (car win-start-end))) |
1012 | (car (car win-start-end)) | |
1013 | win-start-end)) | |
e79016aa KH |
1014 | (setq win-start-end (cdr win-start-end))) |
1015 | res)) | |
1016 | ||
1017 | ||
1018 | ;; Make sure WIN always starts at the beginning of an whole screen | |
1019 | ;; line. If WIN is not aligned the start is updated which probably | |
1020 | ;; will lead to a redisplay of the screen later on. | |
1021 | ;; | |
1022 | ;; This is used with the first window in a follow chain. The reason | |
1023 | ;; is that we want to detect that the point is outside the window. | |
1024 | ;; (Without the update, the start of the window will move as the | |
1025 | ;; user presses BackSpace, and the other window redisplay routines | |
1026 | ;; will move the start of the window in the wrong direction.) | |
1027 | ||
1028 | (defun follow-update-window-start (win) | |
1029 | "Make sure that the start of WIN starts at a full screen line." | |
1030 | (save-excursion | |
1031 | (goto-char (window-start win)) | |
1032 | (if (bolp) | |
1033 | nil | |
1034 | (vertical-motion 0 win) | |
1035 | (if (eq (point) (window-start win)) | |
1036 | nil | |
1037 | (vertical-motion 1 win) | |
1038 | (set-window-start win (point) 'noforce))))) | |
1039 | ||
1040 | ;;}}} | |
1041 | ;;{{{ Selection functions | |
1042 | ||
1043 | ;; Make a window in WINDOWS selected if it currently | |
1044 | ;; is displaying the position DEST. | |
1045 | ;; | |
1046 | ;; We don't select a window if it just has been moved. | |
1047 | ||
1048 | (defun follow-select-if-visible (dest win-start-end) | |
1049 | "Select and return a window, if DEST is visible in it. | |
1050 | Return the selected window." | |
1051 | (let ((win nil)) | |
1052 | (while (and (not win) win-start-end) | |
ff753438 | 1053 | ;; Don't select a window that was just moved. This makes it |
e79016aa KH |
1054 | ;; possible to later select the last window after a `end-of-buffer' |
1055 | ;; command. | |
1056 | (if (follow-pos-visible dest (car (car win-start-end)) win-start-end) | |
1057 | (progn | |
1058 | (setq win (car (car win-start-end))) | |
1059 | (select-window win))) | |
1060 | (setq win-start-end (cdr win-start-end))) | |
1061 | win)) | |
1062 | ||
1063 | ||
1064 | ;; Lets select a window showing the end. Make sure we only select it if it | |
1065 | ;; it wasn't just moved here. (i.e. M-> shall not unconditionally place | |
1066 | ;; the point in the selected window.) | |
1067 | ;; | |
ff753438 | 1068 | ;; (Compability cludge: in Emacs `window-end' is equal to `point-max'; |
e79016aa | 1069 | ;; in XEmacs, it is equal to `point-max + 1'. Should I really bother |
cb02be17 | 1070 | ;; checking `window-end' now when I check `end-of-buffer' explicitly?) |
e79016aa KH |
1071 | |
1072 | (defun follow-select-if-end-visible (win-start-end) | |
1073 | "Select and return a window, if end is visible in it." | |
1074 | (let ((win nil)) | |
1075 | (while (and (not win) win-start-end) | |
ff753438 | 1076 | ;; Don't select a window that was just moved. This makes it |
e79016aa KH |
1077 | ;; possible to later select the last window after a `end-of-buffer' |
1078 | ;; command. | |
1079 | (if (and (eq (point-max) (nth 2 (car win-start-end))) | |
1080 | (nth 3 (car win-start-end)) | |
ff753438 RS |
1081 | ;; `window-end' might return nil. |
1082 | (let ((end (window-end (car (car win-start-end))))) | |
1083 | (and end | |
1084 | (eq (point-max) (min (point-max) end))))) | |
e79016aa KH |
1085 | (progn |
1086 | (setq win (car (car win-start-end))) | |
1087 | (select-window win))) | |
1088 | (setq win-start-end (cdr win-start-end))) | |
1089 | win)) | |
1090 | ||
1091 | ||
ff753438 | 1092 | ;; Select a window that will display the point if the windows would |
e79016aa KH |
1093 | ;; be redisplayed with the first window fixed. This is useful for |
1094 | ;; example when the user has pressed return at the bottom of a window | |
1095 | ;; as the point is not visible in any window. | |
1096 | ||
1097 | (defun follow-select-if-visible-from-first (dest windows) | |
1098 | "Select and return a window with DEST, if WINDOWS are redrawn from top." | |
1099 | (let ((win nil) | |
1100 | end-pos-end-p) | |
1101 | (save-excursion | |
1102 | (goto-char (window-start (car windows))) | |
1103 | ;; Make sure the line start in the beginning of a real screen | |
1104 | ;; line. | |
cb02be17 | 1105 | (vertical-motion 0 (car windows)) |
e79016aa KH |
1106 | (if (< dest (point)) |
1107 | ;; Above the start, not visible. | |
1108 | nil | |
1109 | ;; At or below the start. Check the windows. | |
1110 | (save-window-excursion | |
1111 | (while (and (not win) windows) | |
1112 | (set-window-start (car windows) (point) 'noforce) | |
1113 | (setq end-pos-end-p (follow-calc-win-end (car windows))) | |
1114 | (goto-char (car end-pos-end-p)) | |
1115 | ;; Visible, if dest above end, or if eob is visible inside | |
1116 | ;; the window. | |
1117 | (if (or (car (cdr end-pos-end-p)) | |
1118 | (< dest (point))) | |
1119 | (setq win (car windows)) | |
1120 | (setq windows (cdr windows))))))) | |
cb02be17 | 1121 | (if win |
e79016aa KH |
1122 | (select-window win)) |
1123 | win)) | |
1124 | ||
1125 | ||
1126 | ;;}}} | |
cb02be17 | 1127 | ;;{{{ Redisplay |
e79016aa KH |
1128 | |
1129 | ;; Redraw all the windows on the screen, starting with the top window. | |
1130 | ;; The window used as as marker is WIN, or the selcted window if WIN | |
1131 | ;; is nil. | |
1132 | ||
1133 | (defun follow-redisplay (&optional windows win) | |
1134 | "Reposition the WINDOWS around WIN. | |
1135 | Should the point be too close to the roof we redisplay everything | |
8cd3480b | 1136 | from the top. WINDOWS should contain a list of windows to |
cb02be17 | 1137 | redisplay, it is assumed that WIN is a member of the list. |
e79016aa KH |
1138 | Should WINDOWS be nil, the windows displaying the |
1139 | same buffer as WIN, in the current frame, are used. | |
cb02be17 | 1140 | Should WIN be nil, the selected window is used." |
e79016aa KH |
1141 | (or win |
1142 | (setq win (selected-window))) | |
cb02be17 | 1143 | (or windows |
e79016aa KH |
1144 | (setq windows (follow-all-followers win))) |
1145 | (follow-downward windows (follow-calculate-first-window-start windows win))) | |
1146 | ||
1147 | ||
1148 | ;; Redisplay a chain of windows. Start every window directly after the | |
1149 | ;; end of the previous window, to make sure long lines are displayed | |
1150 | ;; correctly. | |
1151 | ||
1152 | (defun follow-downward (windows pos) | |
1153 | "Redisplay all WINDOWS starting at POS." | |
1154 | (while windows | |
1155 | (set-window-start (car windows) pos) | |
1156 | (setq pos (car (follow-calc-win-end (car windows)))) | |
1157 | (setq windows (cdr windows)))) | |
1158 | ||
1159 | ||
1160 | ;;(defun follow-downward (windows pos) | |
1161 | ;; "Redisplay all WINDOWS starting at POS." | |
1162 | ;; (let (p) | |
1163 | ;; (while windows | |
1164 | ;; (setq p (window-point (car windows))) | |
1165 | ;; (set-window-start (car windows) pos) | |
1166 | ;; (set-window-point (car windows) (max p pos)) | |
1167 | ;; (setq pos (car (follow-calc-win-end (car windows)))) | |
1168 | ;; (setq windows (cdr windows))))) | |
1169 | ||
1170 | ||
1171 | ;; Return the start of the first window. | |
1172 | ;; | |
1173 | ;; First, estimate the position. It the value is not perfect (i.e. we | |
1174 | ;; have somewhere splited a line between windows) we try to enhance | |
1175 | ;; the value. | |
1176 | ;; | |
1177 | ;; The guess is always perfect if no long lines is split between | |
1178 | ;; windows. | |
1179 | ;; | |
1180 | ;; The worst case peformace of probably very bad, but it is very | |
1181 | ;; unlikely that we ever will miss the correct start by more than one | |
1182 | ;; or two lines. | |
1183 | ||
1184 | (defun follow-calculate-first-window-start (windows &optional win start) | |
1185 | "Calculate the start of the first window. | |
1186 | ||
1187 | WINDOWS is a chain of windows to work with. WIN is the window | |
cb02be17 | 1188 | to recenter around. It is assumed that WIN starts at position |
e79016aa | 1189 | START." |
cb02be17 | 1190 | (or win |
e79016aa | 1191 | (setq win (selected-window))) |
cb02be17 | 1192 | (or start |
e79016aa KH |
1193 | (setq start (window-start win))) |
1194 | (let ((guess (follow-estimate-first-window-start windows win start))) | |
1195 | (if (car guess) | |
1196 | (cdr guess) | |
1197 | ;; The guess wasn't exact, try to enhance it. | |
1198 | (let ((win-start (follow-calc-win-start windows (cdr guess) win))) | |
cb02be17 | 1199 | (cond ((= win-start start) |
e79016aa KH |
1200 | (follow-debug-message "exact") |
1201 | (cdr guess)) | |
1202 | ((< win-start start) | |
1203 | (follow-debug-message "above") | |
cb02be17 | 1204 | (follow-calculate-first-window-start-from-above |
e79016aa KH |
1205 | windows (cdr guess) win start)) |
1206 | (t | |
1207 | (follow-debug-message "below") | |
cb02be17 | 1208 | (follow-calculate-first-window-start-from-below |
e79016aa KH |
1209 | windows (cdr guess) win start))))))) |
1210 | ||
1211 | ||
1212 | ;; `exact' is disabled due to XEmacs and fonts of variable | |
1213 | ;; height. | |
1214 | (defun follow-estimate-first-window-start (windows win start) | |
1215 | "Estimate the position of the first window. | |
1216 | ||
8cd3480b JB |
1217 | Returns (EXACT . POS). If EXACT is non-nil, POS is the starting |
1218 | position of the first window. Otherwise it is a good guess." | |
e79016aa KH |
1219 | (let ((pred (car (follow-split-followers windows win))) |
1220 | (exact nil)) | |
1221 | (save-excursion | |
1222 | (goto-char start) | |
1223 | ;(setq exact (bolp)) | |
1224 | (vertical-motion 0 win) | |
1225 | (while pred | |
1226 | (vertical-motion (- 1 (window-height (car pred))) (car pred)) | |
1227 | (if (not (bolp)) | |
1228 | (setq exact nil)) | |
1229 | (setq pred (cdr pred))) | |
1230 | (cons exact (point))))) | |
1231 | ||
1232 | ||
1233 | ;; Find the starting point, start at GUESS and search downward. | |
1234 | ;; The returned point is always a point below GUESS. | |
1235 | ||
cb02be17 | 1236 | (defun follow-calculate-first-window-start-from-above |
e79016aa KH |
1237 | (windows guess win start) |
1238 | (save-excursion | |
1239 | (let ((done nil) | |
1240 | win-start | |
1241 | res) | |
1242 | (goto-char guess) | |
1243 | (while (not done) | |
1244 | (if (not (= (vertical-motion 1 (car windows)) 1)) | |
1245 | ;; Hit bottom! (Can we really do this?) | |
1246 | ;; We'll keep it, since it ensures termination. | |
1247 | (progn | |
1248 | (setq done t) | |
1249 | (setq res (point-max))) | |
1250 | (setq win-start (follow-calc-win-start windows (point) win)) | |
1251 | (if (>= win-start start) | |
cb02be17 | 1252 | (progn |
e79016aa KH |
1253 | (setq done t) |
1254 | (setq res (point)))))) | |
1255 | res))) | |
1256 | ||
1257 | ||
1258 | ;; Find the starting point, start at GUESS and search upward. Return | |
1259 | ;; a point on the same line as GUESS, or above. | |
1260 | ;; | |
1261 | ;; (Is this ever used? I must make sure it works just in case it is | |
1262 | ;; ever called.) | |
1263 | ||
1264 | (defun follow-calculate-first-window-start-from-below | |
1265 | (windows guess &optional win start) | |
1266 | (setq win (or win (selected-window))) | |
1267 | (setq start (or start (window-start win))) | |
1268 | (save-excursion | |
1269 | (let ((done nil) | |
1270 | win-start | |
1271 | res) | |
1272 | ;; Always calculate what happend when no line is displayed in the first | |
1273 | ;; window. (The `previous' res is needed below!) | |
1274 | (goto-char guess) | |
1275 | (vertical-motion 0 (car windows)) | |
1276 | (setq res (point)) | |
1277 | (while (not done) | |
1278 | (if (not (= (vertical-motion -1 (car windows)) -1)) | |
1279 | ;; Hit roof! | |
1280 | (progn | |
1281 | (setq done t) | |
1282 | (setq res (point-min))) | |
1283 | (setq win-start (follow-calc-win-start windows (point) win)) | |
1284 | (cond ((= win-start start) ; Perfect match, use this value | |
1285 | (setq done t) | |
1286 | (setq res (point))) | |
1287 | ((< win-start start) ; Walked to far, use preious result | |
1288 | (setq done t)) | |
1289 | (t ; Store result for next iteration | |
1290 | (setq res (point)))))) | |
1291 | res))) | |
1292 | ||
1293 | ;;}}} | |
1294 | ;;{{{ Avoid tail recenter | |
1295 | ||
1296 | ;; This sets the window internal flag `force_start'. The effect is that | |
1297 | ;; windows only displaying the tail isn't recentered. | |
1298 | ;; Has to be called before every redisplay... (Great isn't it?) | |
1299 | ;; | |
1300 | ;; XEmacs doesn't recenter the tail, GOOD! | |
1301 | ;; | |
1302 | ;; A window displaying only the tail, is a windows whose | |
1303 | ;; window-start position is equal to (point-max) of the buffer it | |
1304 | ;; displays. | |
1305 | ;; | |
1306 | ;; This function is also added to `post-command-idle-hook', introduced | |
1307 | ;; in Emacs 19.30. This is needed since the vaccine injected by the | |
1308 | ;; call from `post-command-hook' only works until the next redisplay. | |
1309 | ;; It is possible that the functions in the `post-command-idle-hook' | |
1310 | ;; can cause a redisplay, and hence a new vaccine is needed. | |
1311 | ;; | |
1312 | ;; Sometimes, calling this function could actually cause a redisplay, | |
1313 | ;; especially if it is placed in the debug filter section. I must | |
1314 | ;; investigate this further... | |
1315 | ||
1316 | (defun follow-avoid-tail-recenter (&rest rest) | |
1317 | "Make sure windows displaying the end of a buffer aren't recentered. | |
1318 | ||
7194219d | 1319 | This is done by reading and rewriting the start position of |
e79016aa KH |
1320 | non-first windows in Follow Mode." |
1321 | (if follow-avoid-tail-recenter-p | |
1322 | (let* ((orig-buffer (current-buffer)) | |
f3bfa025 KH |
1323 | (top (frame-first-window (selected-frame))) |
1324 | (win top) | |
1325 | (who '()) ; list of (buffer . frame) | |
1326 | start | |
1327 | pair) ; (buffer . frame) | |
1328 | ;; If the only window in the frame is a minibuffer | |
1329 | ;; window, `next-window' will never find it again... | |
1330 | (if (window-minibuffer-p top) | |
1331 | nil | |
1332 | (while ;; look, no body! | |
1333 | (progn | |
1334 | (setq start (window-start win)) | |
1335 | (set-buffer (window-buffer win)) | |
1336 | (setq pair (cons (window-buffer win) (window-frame win))) | |
1337 | (if (member pair who) | |
cb02be17 | 1338 | (if (and (boundp 'follow-mode) follow-mode |
f3bfa025 KH |
1339 | (eq (point-max) start)) |
1340 | ;; Write the same window start back, but don't | |
1341 | ;; set the NOFORCE flag. | |
1342 | (set-window-start win start)) | |
1343 | (setq who (cons pair who))) | |
1344 | (setq win (next-window win 'not t)) | |
1345 | (not (eq win top)))) ;; Loop while this is true. | |
1346 | (set-buffer orig-buffer))))) | |
e79016aa KH |
1347 | |
1348 | ;;}}} | |
1349 | ||
1350 | ;;}}} | |
1351 | ;;{{{ Post Command Hook | |
1352 | ||
08a1dbe6 | 1353 | ;; The magic little box. This function is called after every command. |
e79016aa KH |
1354 | |
1355 | ;; This is not as complicated as it seems. It is simply a list of common | |
1356 | ;; display situations and the actions to take, plus commands for redrawing | |
1357 | ;; the screen if it should be unaligned. | |
1358 | ;; | |
1359 | ;; We divide the check into two parts; whether we are at the end or not. | |
1360 | ;; This is due to the fact that the end can actaually be visible | |
1361 | ;; in several window even though they are aligned. | |
1362 | ||
1363 | (defun follow-post-command-hook () | |
cb02be17 | 1364 | "Ensure that the windows in Follow mode are adjacent after each command." |
e79016aa KH |
1365 | (setq follow-inside-post-command-hook t) |
1366 | (if (or (not (input-pending-p)) | |
1367 | ;; Sometimes, in XEmacs, mouse events are not handled | |
1368 | ;; properly by `input-pending-p'. A typical example is | |
1369 | ;; when clicking on a node in `info'. | |
1370 | (and (boundp 'current-mouse-event) | |
1371 | (symbol-value 'current-mouse-event) | |
1372 | (fboundp 'button-event-p) | |
1373 | (funcall (symbol-function 'button-event-p) | |
1374 | (symbol-value 'current-mouse-event)))) | |
1375 | ;; Work in the selected window, not in the current buffer. | |
1376 | (let ((orig-buffer (current-buffer)) | |
1377 | (win (selected-window))) | |
1378 | (set-buffer (window-buffer win)) | |
cb02be17 | 1379 | (or (and (symbolp this-command) |
f3bfa025 KH |
1380 | (get this-command 'follow-mode-use-cache)) |
1381 | (follow-invalidate-cache)) | |
e79016aa KH |
1382 | (if (and (boundp 'follow-mode) follow-mode |
1383 | (not (window-minibuffer-p win))) | |
1384 | ;; The buffer shown in the selected window is in follow | |
1385 | ;; mode, lets find the current state of the display and | |
1386 | ;; cache the result for speed (i.e. `aligned' and `visible'.) | |
1387 | (let* ((windows (inline (follow-all-followers win))) | |
1388 | (dest (point)) | |
f3bfa025 | 1389 | (win-start-end (inline |
e79016aa KH |
1390 | (follow-update-window-start (car windows)) |
1391 | (follow-windows-start-end windows))) | |
1392 | (aligned (follow-windows-aligned-p win-start-end)) | |
1393 | (visible (follow-pos-visible dest win win-start-end))) | |
f3bfa025 KH |
1394 | (if (not (and aligned visible)) |
1395 | (follow-invalidate-cache)) | |
1396 | (inline (follow-avoid-tail-recenter)) | |
e79016aa KH |
1397 | ;; Select a window to display the point. |
1398 | (or follow-internal-force-redisplay | |
1399 | (progn | |
1400 | (if (eq dest (point-max)) | |
d4b6b1af | 1401 | ;; We're at the end, we have to be careful since |
e79016aa KH |
1402 | ;; the display can be aligned while `dest' can |
1403 | ;; be visible in several windows. | |
1404 | (cond | |
1405 | ;; Select the current window, but only when | |
1406 | ;; the display is correct. (When inserting | |
1407 | ;; character in a tail window, the display is | |
1408 | ;; not correct, as they are shown twice.) | |
1409 | ;; | |
1410 | ;; Never stick to the current window after a | |
1411 | ;; deletion. The reason is cosmetic, when | |
1412 | ;; typing `DEL' in a window showing only the | |
1413 | ;; end of the file, character are removed | |
1414 | ;; from the window above, which is very | |
1415 | ;; unintuitive. | |
1416 | ((and visible | |
1417 | aligned | |
cb02be17 | 1418 | (not (memq this-command |
e79016aa KH |
1419 | '(backward-delete-char |
1420 | delete-backward-char | |
1421 | backward-delete-char-untabify | |
1422 | kill-region)))) | |
1423 | (follow-debug-message "Max: same")) | |
1424 | ;; If the end is visible, and the window | |
1425 | ;; doesn't seems like it just has been moved, | |
1426 | ;; select it. | |
1427 | ((follow-select-if-end-visible win-start-end) | |
1428 | (follow-debug-message "Max: end visible") | |
1429 | (setq visible t) | |
1430 | (setq aligned nil) | |
1431 | (goto-char dest)) | |
1432 | ;; Just show the end... | |
1433 | (t | |
1434 | (follow-debug-message "Max: default") | |
1435 | (select-window (car (reverse windows))) | |
1436 | (goto-char dest) | |
1437 | (setq visible nil) | |
1438 | (setq aligned nil))) | |
cb02be17 | 1439 | |
e79016aa KH |
1440 | ;; We're not at the end, here life is much simpler. |
1441 | (cond | |
cb02be17 | 1442 | ;; This is the normal case! |
e79016aa KH |
1443 | ;; It should be optimized for speed. |
1444 | ((and visible aligned) | |
1445 | (follow-debug-message "same")) | |
1446 | ;; Pick a position in any window. If the | |
1447 | ;; display is ok, this will pick the `correct' | |
1448 | ;; window. If the display is wierd do this | |
1449 | ;; anyway, this will be the case after a delete | |
1450 | ;; at the beginning of the window. | |
1451 | ((follow-select-if-visible dest win-start-end) | |
1452 | (follow-debug-message "visible") | |
1453 | (setq visible t) | |
1454 | (goto-char dest)) | |
1455 | ;; Not visible anywhere else, lets pick this one. | |
1456 | ;; (Is this case used?) | |
1457 | (visible | |
1458 | (follow-debug-message "visible in selected.")) | |
1459 | ;; Far out! | |
1460 | ((eq dest (point-min)) | |
1461 | (follow-debug-message "min") | |
1462 | (select-window (car windows)) | |
1463 | (goto-char dest) | |
1464 | (set-window-start (selected-window) (point-min)) | |
1465 | (setq win-start-end (follow-windows-start-end windows)) | |
f3bfa025 | 1466 | (follow-invalidate-cache) |
e79016aa KH |
1467 | (setq visible t) |
1468 | (setq aligned nil)) | |
1469 | ;; If we can position the cursor without moving the first | |
ff753438 | 1470 | ;; window, do it. This is the case that catches `RET' |
e79016aa KH |
1471 | ;; at the bottom of a window. |
1472 | ((follow-select-if-visible-from-first dest windows) | |
1473 | (follow-debug-message "Below first") | |
cb02be17 | 1474 | (setq visible t) |
e79016aa KH |
1475 | (setq aligned t) |
1476 | (follow-redisplay windows (car windows)) | |
1477 | (goto-char dest)) | |
1478 | ;; None of the above. For simplicity, we stick to the | |
1479 | ;; selected window. | |
1480 | (t | |
1481 | (follow-debug-message "None") | |
1482 | (setq visible nil) | |
1483 | (setq aligned nil)))) | |
1484 | ;; If a new window has been selected, make sure that the | |
1485 | ;; old is not scrolled when the point is outside the | |
1486 | ;; window. | |
1487 | (or (eq win (selected-window)) | |
1488 | (let ((p (window-point win))) | |
1489 | (set-window-start win (window-start win) nil) | |
1490 | (set-window-point win p))))) | |
1491 | ;; Make sure the point is visible in the selected window. | |
1492 | ;; (This could lead to a scroll.) | |
1493 | (if (or visible | |
1494 | (follow-pos-visible dest win win-start-end)) | |
1495 | nil | |
1496 | (sit-for 0) | |
1497 | (follow-avoid-tail-recenter) | |
1498 | (setq win-start-end (follow-windows-start-end windows)) | |
f3bfa025 | 1499 | (follow-invalidate-cache) |
e79016aa KH |
1500 | (setq aligned nil)) |
1501 | ;; Redraw the windows whenever needed. | |
1502 | (if (or follow-internal-force-redisplay | |
1503 | (not (or aligned | |
1504 | (follow-windows-aligned-p win-start-end))) | |
cb02be17 | 1505 | (not (inline (follow-point-visible-all-windows-p |
e79016aa KH |
1506 | win-start-end)))) |
1507 | (progn | |
1508 | (setq follow-internal-force-redisplay nil) | |
1509 | (follow-redisplay windows (selected-window)) | |
1510 | (setq win-start-end (follow-windows-start-end windows)) | |
f3bfa025 | 1511 | (follow-invalidate-cache) |
e79016aa KH |
1512 | ;; When the point ends up in another window. This |
1513 | ;; happends when dest is in the beginning of the | |
1514 | ;; file and the selected window is not the first. | |
1515 | ;; It can also, in rare situations happend when | |
1516 | ;; long lines are used and there is a big | |
1517 | ;; difference between the width of the windows. | |
1518 | ;; (When scrolling one line in a wide window which | |
1519 | ;; will cause a move larger that an entire small | |
1520 | ;; window.) | |
1521 | (if (follow-pos-visible dest win win-start-end) | |
1522 | nil | |
1523 | (follow-select-if-visible dest win-start-end) | |
1524 | (goto-char dest)))) | |
cb02be17 | 1525 | |
e79016aa KH |
1526 | ;; If the region is visible, make it look good when spanning |
1527 | ;; multiple windows. | |
1528 | (if (or (and (boundp 'mark-active) (symbol-value 'mark-active)) | |
cb02be17 | 1529 | (and (fboundp 'region-active-p) |
e79016aa | 1530 | (funcall (symbol-function 'region-active-p)))) |
cb02be17 | 1531 | (follow-maximize-region |
e79016aa KH |
1532 | (selected-window) windows win-start-end)) |
1533 | ||
f3bfa025 | 1534 | (inline (follow-avoid-tail-recenter)) |
e79016aa | 1535 | ;; DEBUG |
cb02be17 | 1536 | ;;(if (not (follow-windows-aligned-p |
e79016aa KH |
1537 | ;; (follow-windows-start-end windows))) |
1538 | ;; (message "follow-mode: windows still unaligend!")) | |
1539 | ;; END OF DEBUG | |
1540 | ) ; Matches (let* | |
1541 | ;; Buffer not in follow mode: | |
1542 | ;; We still must update the windows displaying the tail so that | |
1543 | ;; Emacs won't recenter them. | |
1544 | (follow-avoid-tail-recenter)) | |
1545 | (set-buffer orig-buffer))) | |
1546 | (setq follow-inside-post-command-hook nil)) | |
1547 | ||
1548 | ;;}}} | |
1549 | ;;{{{ The region | |
1550 | ||
1551 | ;; Tries to make the highlighted area representing the region look | |
cb02be17 | 1552 | ;; good when spanning several windows. |
e79016aa KH |
1553 | ;; |
1554 | ;; Not perfect, as the point can't be placed at window end, only at | |
cb02be17 | 1555 | ;; end-1. This will highlight a little bit in windows above |
e79016aa KH |
1556 | ;; the current. |
1557 | ||
1558 | (defun follow-maximize-region (win windows win-start-end) | |
cb02be17 | 1559 | "Make a highlighted region stretching multiple windows look good." |
e79016aa KH |
1560 | (let* ((all (follow-split-followers windows win)) |
1561 | (pred (car all)) | |
1562 | (succ (cdr all)) | |
1563 | data) | |
1564 | (while pred | |
1565 | (setq data (assq (car pred) win-start-end)) | |
1566 | (set-window-point (car pred) (max (nth 1 data) (- (nth 2 data) 1))) | |
1567 | (setq pred (cdr pred))) | |
1568 | (while succ | |
1569 | (set-window-point (car succ) (nth 1 (assq (car succ) win-start-end))) | |
1570 | (setq succ (cdr succ))))) | |
1571 | ||
1572 | ;;}}} | |
1573 | ;;{{{ Scroll bar | |
1574 | ||
1575 | ;;;; Scroll-bar support code. | |
1576 | ||
08a1dbe6 SM |
1577 | ;; Why is it needed? Well, if the selected window is in follow mode, |
1578 | ;; all its follower stick to it blindly. If one of them is scrolled, | |
1579 | ;; it immediately returns to the original position when the mouse is | |
1580 | ;; released. If the selected window is not a follower of the dragged | |
1581 | ;; window the windows will be unaligned. | |
e79016aa | 1582 | |
08a1dbe6 SM |
1583 | ;; The advices doesn't get compiled. Aestetically, this might be a |
1584 | ;; problem but in practical life it isn't. | |
e79016aa | 1585 | |
08a1dbe6 SM |
1586 | ;; Discussion: Now when the other windows in the chain follow the |
1587 | ;; dragged, should we really select it? | |
e79016aa KH |
1588 | |
1589 | (cond ((fboundp 'scroll-bar-drag) | |
1590 | ;;; | |
ff753438 | 1591 | ;;; Emacs style scrollbars. |
e79016aa KH |
1592 | ;;; |
1593 | ||
1594 | ;; Select the dragged window if it is a follower of the | |
1595 | ;; selected window. | |
1596 | ;; | |
1597 | ;; Generate advices of the form: | |
1598 | ;; (defadvice scroll-bar-drag (after follow-scroll-bar-drag activate) | |
1599 | ;; "Adviced by `follow-mode'." | |
1600 | ;; (follow-redraw-after-event (ad-get-arg 0))) | |
1601 | (let ((cmds '(scroll-bar-drag | |
1602 | scroll-bar-drag-1 ; Executed at every move. | |
1603 | scroll-bar-scroll-down | |
1604 | scroll-bar-scroll-up | |
1605 | scroll-bar-set-window-start))) | |
1606 | (while cmds | |
1607 | (eval | |
c86b6fd2 | 1608 | `(defadvice ,(intern (symbol-name (car cmds))) |
cb02be17 | 1609 | (after |
c86b6fd2 | 1610 | ,(intern (concat "follow-" (symbol-name (car cmds)))) |
e79016aa KH |
1611 | activate) |
1612 | "Adviced by Follow Mode." | |
c86b6fd2 | 1613 | (follow-redraw-after-event (ad-get-arg 0)))) |
e79016aa | 1614 | (setq cmds (cdr cmds)))) |
cb02be17 KH |
1615 | |
1616 | ||
e79016aa KH |
1617 | (defun follow-redraw-after-event (event) |
1618 | "Adviced by Follow mode." | |
1619 | (condition-case nil | |
1620 | (let* ((orig-win (selected-window)) | |
cb02be17 | 1621 | (win (nth 0 (funcall |
e79016aa | 1622 | (symbol-function 'event-start) event))) |
cb02be17 KH |
1623 | (fmode (assq 'follow-mode |
1624 | (buffer-local-variables | |
e79016aa KH |
1625 | (window-buffer win))))) |
1626 | (if (and fmode (cdr fmode)) | |
1627 | ;; The selected window is in follow-mode | |
1628 | (progn | |
1629 | ;; Recenter around the dragged window. | |
1630 | (select-window win) | |
1631 | (follow-redisplay) | |
1632 | (select-window orig-win)))) | |
1633 | (error nil)))) | |
1634 | ||
1635 | ||
1636 | ((fboundp 'scrollbar-vertical-drag) | |
1637 | ;;; | |
1638 | ;;; XEmacs style scrollbars. | |
1639 | ;;; | |
1640 | ||
1641 | ;; Advice all scrollbar functions on the form: | |
1642 | ;; | |
cb02be17 | 1643 | ;; (defadvice scrollbar-line-down |
e79016aa KH |
1644 | ;; (after follow-scrollbar-line-down activate) |
1645 | ;; (follow-xemacs-scrollbar-support (ad-get-arg 0))) | |
1646 | ||
1647 | (let ((cmds '(scrollbar-line-down ; Window | |
1648 | scrollbar-line-up | |
1649 | scrollbar-page-down ; Object | |
1650 | scrollbar-page-up | |
1651 | scrollbar-to-bottom ; Window | |
1652 | scrollbar-to-top | |
1653 | scrollbar-vertical-drag ; Object | |
1654 | ))) | |
cb02be17 | 1655 | |
e79016aa KH |
1656 | (while cmds |
1657 | (eval | |
c86b6fd2 | 1658 | `(defadvice ,(intern (symbol-name (car cmds))) |
cb02be17 | 1659 | (after |
c86b6fd2 | 1660 | ,(intern (concat "follow-" (symbol-name (car cmds)))) |
e79016aa KH |
1661 | activate) |
1662 | "Adviced by `follow-mode'." | |
c86b6fd2 | 1663 | (follow-xemacs-scrollbar-support (ad-get-arg 0)))) |
e79016aa KH |
1664 | (setq cmds (cdr cmds)))) |
1665 | ||
1666 | ||
1667 | (defun follow-xemacs-scrollbar-support (window) | |
1668 | "Redraw windows showing the same buffer as shown in WINDOW. | |
1669 | WINDOW is either the dragged window, or a cons containing the | |
8cd3480b | 1670 | window as its first element. This is called while the user drags |
e79016aa KH |
1671 | the scrollbar. |
1672 | ||
1673 | WINDOW can be an object or a window." | |
1674 | (condition-case nil | |
1675 | (progn | |
1676 | (if (consp window) | |
1677 | (setq window (car window))) | |
cb02be17 KH |
1678 | (let ((fmode (assq 'follow-mode |
1679 | (buffer-local-variables | |
e79016aa KH |
1680 | (window-buffer window)))) |
1681 | (orig-win (selected-window))) | |
1682 | (if (and fmode (cdr fmode)) | |
1683 | (progn | |
1684 | ;; Recenter around the dragged window. | |
1685 | (select-window window) | |
1686 | (follow-redisplay) | |
1687 | (select-window orig-win))))) | |
1688 | (error nil))))) | |
1689 | ||
1690 | ;;}}} | |
1691 | ;;{{{ Process output | |
1692 | ||
08a1dbe6 SM |
1693 | ;; The following sections installs a spy that listens to process |
1694 | ;; output and tries to reposition the windows whose buffers are in | |
1695 | ;; Follow mode. We play safe as much as possible... | |
1696 | ;; | |
1697 | ;; When follow-mode is activated all active processes are | |
1698 | ;; intercepted. All new processes that change their filter function | |
1699 | ;; using `set-process-filter' are also intercepted. The reason is | |
1700 | ;; that a process can cause a redisplay recentering "tail" windows. | |
1701 | ;; Note that it doesn't hurt to spy on more processes than needed. | |
1702 | ;; | |
1703 | ;; Technically, we set the process filter to `follow-generic-filter'. | |
1704 | ;; The original filter is stored in `follow-process-filter-alist'. | |
1705 | ;; Our generic filter calls the original filter, or inserts the | |
1706 | ;; output into the buffer, if the buffer originally didn't have an | |
1707 | ;; output filter. It also makes sure that the windows connected to | |
1708 | ;; the buffer are aligned. | |
1709 | ;; | |
1710 | ;; Discussion: How do we find processes that don't call | |
1711 | ;; `set-process-filter'? (How often are processes created in a | |
1712 | ;; buffer after Follow mode are activated?) | |
1713 | ;; | |
1714 | ;; Discussion: Should we also advice `process-filter' to make our | |
1715 | ;; filter invisible to others? | |
e79016aa KH |
1716 | |
1717 | ;;{{{ Advice for `set-process-filter' | |
1718 | ||
1719 | ;; Do not call this with 'follow-generic-filter as the name of the | |
1720 | ;; filter... | |
1721 | ||
1722 | (defadvice set-process-filter (before follow-set-process-filter activate) | |
ba4841b2 | 1723 | "Ensure process output will be displayed correctly in Follow Mode buffers. |
e79016aa | 1724 | |
cb02be17 | 1725 | Follow Mode inserts its own process filter to do its |
e79016aa KH |
1726 | magic stuff before the real process filter is called." |
1727 | (if follow-intercept-processes | |
1728 | (progn | |
1729 | (setq follow-process-filter-alist | |
1730 | (delq (assq (ad-get-arg 0) follow-process-filter-alist) | |
1731 | follow-process-filter-alist)) | |
1732 | (follow-tidy-process-filter-alist) | |
1733 | (cond ((eq (ad-get-arg 1) t)) | |
1734 | ((eq (ad-get-arg 1) nil) | |
1735 | (ad-set-arg 1 'follow-generic-filter)) | |
1736 | (t | |
cb02be17 KH |
1737 | (setq follow-process-filter-alist |
1738 | (cons (cons (ad-get-arg 0) (ad-get-arg 1)) | |
e79016aa KH |
1739 | follow-process-filter-alist)) |
1740 | (ad-set-arg 1 'follow-generic-filter)))))) | |
1741 | ||
1742 | ||
1743 | (defun follow-call-set-process-filter (proc filter) | |
1744 | "Call original `set-process-filter' without the Follow mode advice." | |
1745 | (ad-disable-advice 'set-process-filter 'before | |
1746 | 'follow-set-process-filter) | |
1747 | (ad-activate 'set-process-filter) | |
cb02be17 | 1748 | (prog1 |
e79016aa KH |
1749 | (set-process-filter proc filter) |
1750 | (ad-enable-advice 'set-process-filter 'before | |
1751 | 'follow-set-process-filter) | |
1752 | (ad-activate 'set-process-filter))) | |
1753 | ||
1754 | ||
1755 | (defadvice process-filter (after follow-process-filter activate) | |
cb02be17 | 1756 | "Return the original process filter, not `follow-generic-filter'." |
e79016aa KH |
1757 | (cond ((eq ad-return-value 'follow-generic-filter) |
1758 | (setq ad-return-value | |
cb02be17 | 1759 | (cdr-safe (assq (ad-get-arg 0) |
e79016aa KH |
1760 | follow-process-filter-alist)))))) |
1761 | ||
1762 | ||
1763 | (defun follow-call-process-filter (proc) | |
1764 | "Call original `process-filter' without the Follow mode advice." | |
1765 | (ad-disable-advice 'process-filter 'after | |
1766 | 'follow-process-filter) | |
1767 | (ad-activate 'process-filter) | |
cb02be17 | 1768 | (prog1 |
e79016aa | 1769 | (process-filter proc) |
cb02be17 | 1770 | (ad-enable-advice 'process-filter 'after |
e79016aa KH |
1771 | 'follow-process-filter) |
1772 | (ad-activate 'process-filter))) | |
cb02be17 | 1773 | |
e79016aa KH |
1774 | |
1775 | (defun follow-tidy-process-filter-alist () | |
1776 | "Remove old processes from `follow-process-filter-alist'." | |
1777 | (let ((alist follow-process-filter-alist) | |
1778 | (ps (process-list)) | |
1779 | (new ())) | |
1780 | (while alist | |
cb02be17 | 1781 | (if (and (not (memq (process-status (car (car alist))) |
e79016aa KH |
1782 | '(exit signal closed nil))) |
1783 | (memq (car (car alist)) ps)) | |
1784 | (setq new (cons (car alist) new))) | |
1785 | (setq alist (cdr alist))) | |
1786 | (setq follow-process-filter-alist new))) | |
1787 | ||
1788 | ;;}}} | |
1789 | ;;{{{ Start/stop interception of processes. | |
1790 | ||
1791 | ;; Normally, all new processed are intercepted by our `set-process-filter'. | |
ff753438 | 1792 | ;; This is needed to intercept old processed that were started before we were |
e79016aa KH |
1793 | ;; loaded, and processes we have forgotten by calling |
1794 | ;; `follow-stop-intercept-process-output'. | |
1795 | ||
1796 | (defun follow-intercept-process-output () | |
1797 | "Intercept all active processes. | |
1798 | ||
1799 | This is needed so that Follow Mode can track all display events in the | |
8cd3480b | 1800 | system. (See `follow-mode'.)" |
e79016aa KH |
1801 | (interactive) |
1802 | (let ((list (process-list))) | |
1803 | (while list | |
1804 | (if (eq (process-filter (car list)) 'follow-generic-filter) | |
1805 | nil | |
1806 | ;; The custom `set-process-filter' defined above. | |
1807 | (set-process-filter (car list) (process-filter (car list)))) | |
1808 | (setq list (cdr list)))) | |
1809 | (setq follow-intercept-processes t)) | |
1810 | ||
1811 | ||
1812 | (defun follow-stop-intercept-process-output () | |
1813 | "Stop Follow Mode from spying on processes. | |
1814 | ||
1815 | All current spypoints are removed and no new will be added. | |
1816 | ||
cb02be17 KH |
1817 | The effect is that Follow mode won't be able to handle buffers |
1818 | connected to processes. | |
e79016aa KH |
1819 | |
1820 | The only reason to call this function is if the Follow mode spy filter | |
1821 | would interfere with some other package. If this happens, please | |
08a1dbe6 | 1822 | report this using the `report-emacs-bug' function." |
e79016aa KH |
1823 | (interactive) |
1824 | (follow-tidy-process-filter-alist) | |
1825 | (let ((list (process-list))) | |
1826 | (while list | |
1827 | (if (eq (process-filter (car list)) 'follow-generic-filter) | |
1828 | (progn | |
cb02be17 KH |
1829 | (follow-call-set-process-filter |
1830 | (car list) | |
e79016aa | 1831 | (cdr-safe (assq (car list) follow-process-filter-alist))) |
cb02be17 | 1832 | (setq follow-process-filter-alist |
e79016aa KH |
1833 | (delq (assq (car list) follow-process-filter-alist) |
1834 | follow-process-filter-alist)))) | |
1835 | (setq list (cdr list)))) | |
1836 | (setq follow-intercept-processes nil)) | |
1837 | ||
1838 | ;;}}} | |
1839 | ;;{{{ The filter | |
1840 | ||
08a1dbe6 SM |
1841 | ;; The following section is a naive method to make buffers with |
1842 | ;; process output to work with Follow mode. Whenever the start of the | |
1843 | ;; window displaying the buffer is moved, we moves it back to its | |
1844 | ;; original position and try to select a new window. (If we fail, | |
1845 | ;; the normal redisplay functions of Emacs will scroll it right | |
1846 | ;; back!) | |
e79016aa KH |
1847 | |
1848 | (defun follow-generic-filter (proc output) | |
1849 | "Process output filter for process connected to buffers in Follow mode." | |
1850 | (let* ((old-buffer (current-buffer)) | |
1851 | (orig-win (selected-window)) | |
1852 | (buf (process-buffer proc)) | |
1853 | (win (and buf (if (eq buf (window-buffer orig-win)) | |
1854 | orig-win | |
1855 | (get-buffer-window buf t)))) | |
1856 | (return-to-orig-win (and win (not (eq win orig-win)))) | |
1857 | (orig-window-start (and win (window-start win)))) | |
1858 | ||
1859 | ;; If input is pending, the `sit-for' below won't redraw the | |
1860 | ;; display. In that case, calling `follow-avoid-tail-recenter' may | |
1861 | ;; provoke the process hadnling code to sceduling a redisplay. | |
1862 | ;(or (input-pending-p) | |
1863 | ; (follow-avoid-tail-recenter)) | |
1864 | ||
1865 | ;; Output the `output'. | |
1866 | (let ((filter (cdr-safe (assq proc follow-process-filter-alist)))) | |
cb02be17 | 1867 | (cond |
e79016aa KH |
1868 | ;; Call the original filter function |
1869 | (filter | |
1870 | (funcall filter proc output)) | |
1871 | ||
1872 | ;; No filter, but we've got a buffer. Just output into it. | |
1873 | (buf | |
1874 | (set-buffer buf) | |
1875 | (if (not (marker-buffer (process-mark proc))) | |
1876 | (set-marker (process-mark proc) (point-max))) | |
1877 | (let ((moving (= (point) (process-mark proc))) | |
bbf04be4 RS |
1878 | deactivate-mark |
1879 | (inhibit-read-only t)) | |
e79016aa KH |
1880 | (save-excursion |
1881 | (goto-char (process-mark proc)) | |
1882 | ;; `insert-before-markers' just in case the users next | |
1883 | ;; command is M-y. | |
1884 | (insert-before-markers output) | |
1885 | (set-marker (process-mark proc) (point))) | |
bbf04be4 | 1886 | (if moving (goto-char (process-mark proc))))))) |
e79016aa KH |
1887 | |
1888 | ;; If we're in follow mode, do our stuff. Select a new window and | |
1889 | ;; redisplay. (Actually, it is redundant to check `buf', but I | |
1890 | ;; feel it's more correct.) | |
09c013ef | 1891 | (if (and buf (window-live-p win)) |
e79016aa KH |
1892 | (progn |
1893 | (set-buffer buf) | |
1894 | (if (and (boundp 'follow-mode) follow-mode) | |
cb02be17 | 1895 | (progn |
e79016aa KH |
1896 | (select-window win) |
1897 | (let* ((windows (follow-all-followers win)) | |
1898 | (win-start-end (follow-windows-start-end windows)) | |
1899 | (new-window-start (window-start win)) | |
1900 | (new-window-point (window-point win))) | |
1901 | (cond | |
bb40a524 PJ |
1902 | ;; The start of the selected window was repositioned. |
1903 | ;; Try to use the original start position and continue | |
1904 | ;; working with a window to the "right" in the window | |
1905 | ;; chain. This will create the effect that the output | |
1906 | ;; starts in one window and continues into the next. | |
1907 | ||
1908 | ;; If the display has changed so much that it is not | |
1909 | ;; possible to keep the original window fixed and still | |
1910 | ;; display the point then we give up and use the new | |
1911 | ;; window start. | |
1912 | ||
1913 | ;; This case is typically used when the process filter | |
1914 | ;; tries to reposition the start of the window in order | |
1915 | ;; to view the tail of the output. | |
e79016aa KH |
1916 | ((not (eq orig-window-start new-window-start)) |
1917 | (follow-debug-message "filter: Moved") | |
1918 | (set-window-start win orig-window-start) | |
1919 | (follow-redisplay windows win) | |
1920 | (setq win-start-end (follow-windows-start-end windows)) | |
cb02be17 | 1921 | (follow-select-if-visible new-window-point |
e79016aa KH |
1922 | win-start-end) |
1923 | (goto-char new-window-point) | |
1924 | (if (eq win (selected-window)) | |
1925 | (set-window-start win new-window-start)) | |
1926 | (setq win-start-end (follow-windows-start-end windows))) | |
1927 | ;; Stick to this window, if point is visible in it. | |
1928 | ((pos-visible-in-window-p new-window-point) | |
1929 | (follow-debug-message "filter: Visible in window")) | |
1930 | ;; Avoid redisplaying the first window. If the | |
1931 | ;; point is visible at a window below, | |
1932 | ;; redisplay and select it. | |
cb02be17 | 1933 | ((follow-select-if-visible-from-first |
e79016aa KH |
1934 | new-window-point windows) |
1935 | (follow-debug-message "filter: Seen from first") | |
1936 | (follow-redisplay windows (car windows)) | |
1937 | (goto-char new-window-point) | |
1938 | (setq win-start-end | |
1939 | (follow-windows-start-end windows))) | |
1940 | ;; None of the above. We stick to the current window. | |
cb02be17 | 1941 | (t |
e79016aa KH |
1942 | (follow-debug-message "filter: nothing"))) |
1943 | ||
1944 | ;; Here we have slected a window. Make sure the | |
1945 | ;; windows are aligned and the point is visible | |
1946 | ;; in the selected window. | |
cb02be17 | 1947 | (if (and (not (follow-pos-visible |
e79016aa KH |
1948 | (point) (selected-window) win-start-end)) |
1949 | (not return-to-orig-win)) | |
1950 | (progn | |
1951 | (sit-for 0) | |
cb02be17 | 1952 | (setq win-start-end |
e79016aa KH |
1953 | (follow-windows-start-end windows)))) |
1954 | ||
1955 | (if (or follow-internal-force-redisplay | |
1956 | (not (follow-windows-aligned-p win-start-end))) | |
1957 | (follow-redisplay windows))))))) | |
1958 | ||
1959 | ;; return to the original window. | |
1960 | (if return-to-orig-win | |
1961 | (select-window orig-win)) | |
c8d05b03 KH |
1962 | ;; Restore the orignal buffer, unless the filter explicitly |
1963 | ;; changed buffer or killed the old buffer. | |
1964 | (if (and (eq buf (current-buffer)) | |
1965 | (buffer-name old-buffer)) | |
1966 | (set-buffer old-buffer))) | |
cb02be17 | 1967 | |
f3bfa025 KH |
1968 | (follow-invalidate-cache) |
1969 | ||
1970 | ;; Normally, if the display has been changed, it is redrawn. All | |
1971 | ;; windows showing only the end of a buffer is unconditionally | |
1972 | ;; recentered, we can't prevent it by calling | |
1973 | ;; `follow-avoid-tail-recenter'. | |
1974 | ;; | |
1975 | ;; By performing a redisplay on our own, Emacs need not perform | |
ec265e13 | 1976 | ;; the above described redisplay. (However, by performing it when |
f3bfa025 KH |
1977 | ;; there are input available just seems to make things worse.) |
1978 | (if (and follow-avoid-tail-recenter-p | |
1979 | (not (input-pending-p))) | |
1980 | (sit-for 0))) | |
e79016aa KH |
1981 | |
1982 | ;;}}} | |
1983 | ||
1984 | ;;}}} | |
1985 | ;;{{{ Window size change | |
1986 | ||
1987 | ;; In Emacs 19.29, the functions in `window-size-change-functions' are | |
1988 | ;; called every time a window in a frame changes size. Most notably, it | |
1989 | ;; is called after the frame has been resized. | |
1990 | ;; | |
ff753438 | 1991 | ;; We basically call our post-command-hook for every buffer that is |
e79016aa KH |
1992 | ;; visible in any window in the resized frame, which is in follow-mode. |
1993 | ;; | |
1994 | ;; Since this function can be called indirectly from | |
1995 | ;; `follow-post-command-hook' we have a potential infinite loop. We | |
1996 | ;; handle this problem by simply not doing anything at all in this | |
1997 | ;; situation. The variable `follow-inside-post-command-hook' contains | |
1998 | ;; information about whether the execution actually is inside the | |
1999 | ;; post-command-hook or not. | |
2000 | ||
2001 | (if (boundp 'window-size-change-functions) | |
2002 | (add-hook 'window-size-change-functions 'follow-window-size-change)) | |
2003 | ||
2004 | ||
2005 | (defun follow-window-size-change (frame) | |
2006 | "Redraw all windows in FRAME, when in Follow mode." | |
7dcef48d SM |
2007 | ;; Below, we call `post-command-hook'. This makes sure that we |
2008 | ;; don't start a mutually recursive endless loop. | |
e79016aa KH |
2009 | (if follow-inside-post-command-hook |
2010 | nil | |
2011 | (let ((buffers '()) | |
2012 | (orig-window (selected-window)) | |
2013 | (orig-buffer (current-buffer)) | |
2014 | (orig-frame (selected-frame)) | |
2015 | windows | |
2016 | buf) | |
2017 | (select-frame frame) | |
2018 | (unwind-protect | |
cb02be17 KH |
2019 | (walk-windows |
2020 | (function | |
e79016aa KH |
2021 | (lambda (win) |
2022 | (setq buf (window-buffer win)) | |
2023 | (if (memq buf buffers) | |
2024 | nil | |
2025 | (set-buffer buf) | |
2026 | (if (and (boundp 'follow-mode) | |
2027 | follow-mode) | |
2028 | (progn | |
2029 | (setq windows (follow-all-followers win)) | |
2030 | (if (memq orig-window windows) | |
2031 | (progn | |
7dcef48d SM |
2032 | ;; Make sure we're redrawing around the |
2033 | ;; selected window. | |
2034 | ;; | |
2035 | ;; We must be really careful not to do this | |
2036 | ;; when we are (indirectly) called by | |
2037 | ;; `post-command-hook'. | |
e79016aa KH |
2038 | (select-window orig-window) |
2039 | (follow-post-command-hook) | |
2040 | (setq orig-window (selected-window))) | |
2041 | (follow-redisplay windows win)) | |
2042 | (setq buffers (cons buf buffers)))))))) | |
2043 | (select-frame orig-frame) | |
2044 | (set-buffer orig-buffer) | |
2045 | (select-window orig-window))))) | |
2046 | ||
2047 | ;;}}} | |
2048 | ||
2049 | ;;{{{ XEmacs isearch | |
2050 | ||
2051 | ;; In XEmacs, isearch often finds matches in other windows than the | |
2052 | ;; currently selected. However, when exiting the old window | |
2053 | ;; configuration is restored, with the exception of the beginning of | |
2054 | ;; the start of the window for the selected window. This is not much | |
2055 | ;; help for us. | |
2056 | ;; | |
2057 | ;; We overwrite the stored window configuration with the current, | |
2058 | ;; unless we are in `slow-search-mode', i.e. only a few lines | |
2059 | ;; of text is visible. | |
2060 | ||
08a1dbe6 | 2061 | (if (featurep 'xemacs) |
e79016aa KH |
2062 | (defadvice isearch-done (before follow-isearch-done activate) |
2063 | (if (and (boundp 'follow-mode) | |
2064 | follow-mode | |
2065 | (boundp 'isearch-window-configuration) | |
2066 | isearch-window-configuration | |
2067 | (boundp 'isearch-slow-terminal-mode) | |
2068 | (not isearch-slow-terminal-mode)) | |
2069 | (let ((buf (current-buffer))) | |
cb02be17 | 2070 | (setq isearch-window-configuration |
e79016aa KH |
2071 | (current-window-configuration)) |
2072 | (set-buffer buf))))) | |
2073 | ||
2074 | ;;}}} | |
2075 | ;;{{{ Tail window handling | |
2076 | ||
08a1dbe6 | 2077 | ;; In Emacs (not XEmacs) windows showing nothing are sometimes |
8cd3480b | 2078 | ;; recentered. When in Follow Mode, this is not desirable for |
08a1dbe6 SM |
2079 | ;; non-first windows in the window chain. This section tries to |
2080 | ;; make the windows stay where they should be. | |
2081 | ;; | |
2082 | ;; If the display is updated, all windows starting at (point-max) are | |
2083 | ;; going to be recentered at the next redisplay, unless we do a | |
2084 | ;; read-and-write cycle to update the `force' flag inside the windows. | |
2085 | ;; | |
2086 | ;; In 19.30, a new varible `window-scroll-functions' is called every | |
2087 | ;; time a window is recentered. It is not perfect for our situation, | |
2088 | ;; since when it is called for a tail window, it is to late. However, | |
2089 | ;; if it is called for another window, we can try to update our | |
2090 | ;; windows. | |
2091 | ;; | |
2092 | ;; By patching `sit-for' we can make sure that to catch all explicit | |
2093 | ;; updates initiated by lisp programs. Internal calls, on the other | |
2094 | ;; hand, are not handled. | |
2095 | ;; | |
2096 | ;; Please note that the function `follow-avoid-tail-recenter' is also | |
2097 | ;; called from other places, e.g. `post-command-hook' and | |
2098 | ;; `post-command-idle-hook'. | |
e79016aa | 2099 | |
c8d05b03 KH |
2100 | ;; If this function is called it is too late for this window, but |
2101 | ;; we might save other windows from being recentered. | |
e79016aa KH |
2102 | |
2103 | (if (and follow-avoid-tail-recenter-p (boundp 'window-scroll-functions)) | |
2104 | (add-hook 'window-scroll-functions 'follow-avoid-tail-recenter t)) | |
2105 | ||
2106 | ||
ff753438 | 2107 | ;; This prevents all packages that calls `sit-for' directly |
e79016aa KH |
2108 | ;; to recenter tail windows. |
2109 | ||
2110 | (if follow-avoid-tail-recenter-p | |
2111 | (defadvice sit-for (before follow-sit-for activate) | |
2112 | "Adviced by Follow Mode. | |
2113 | ||
2114 | Avoid to recenter windows displaying only the end of a file as when | |
2115 | displaying a short file in two windows, using Follow Mode." | |
2116 | (follow-avoid-tail-recenter))) | |
2117 | ||
2118 | ||
2119 | ;; Without this advice, `mouse-drag-region' would start to recenter | |
2120 | ;; tail windows. | |
2121 | ||
2122 | (if (and follow-avoid-tail-recenter-p | |
2123 | (fboundp 'move-overlay)) | |
2124 | (defadvice move-overlay (before follow-move-overlay activate) | |
cb02be17 KH |
2125 | "Adviced by Follow Mode. |
2126 | Don't recenter windows showing only the end of a buffer. | |
2127 | This prevents `mouse-drag-region' from messing things up." | |
e79016aa KH |
2128 | (follow-avoid-tail-recenter))) |
2129 | ||
2130 | ;;}}} | |
2131 | ;;{{{ profile support | |
2132 | ||
2133 | ;; The following (non-evaluated) section can be used to | |
2134 | ;; profile this package using `elp'. | |
2135 | ;; | |
2136 | ;; Invalid indentation on purpose! | |
2137 | ||
2138 | (cond (nil | |
2139 | (setq elp-function-list | |
cb02be17 KH |
2140 | '(window-end |
2141 | vertical-motion | |
e79016aa KH |
2142 | ; sit-for ;; elp can't handle advices... |
2143 | follow-mode | |
2144 | follow-all-followers | |
cb02be17 | 2145 | follow-split-followers |
e79016aa KH |
2146 | follow-redisplay |
2147 | follow-downward | |
2148 | follow-calculate-first-window-start | |
2149 | follow-estimate-first-window-start | |
2150 | follow-calculate-first-window-start-from-above | |
2151 | follow-calculate-first-window-start-from-below | |
2152 | follow-calc-win-end | |
2153 | follow-calc-win-start | |
2154 | follow-pos-visible | |
2155 | follow-windows-start-end | |
f3bfa025 | 2156 | follow-cache-valid-p |
e79016aa KH |
2157 | follow-select-if-visible |
2158 | follow-select-if-visible-from-first | |
2159 | follow-windows-aligned-p | |
2160 | follow-point-visible-all-windows-p | |
2161 | follow-avoid-tail-recenter | |
2162 | follow-update-window-start | |
2163 | follow-post-command-hook | |
2164 | )))) | |
2165 | ||
2166 | ;;}}} | |
2167 | ||
2168 | ;;{{{ The end | |
2169 | ||
08a1dbe6 SM |
2170 | ;; |
2171 | ;; We're done! | |
2172 | ;; | |
e79016aa KH |
2173 | |
2174 | (provide 'follow) | |
2175 | ||
2176 | ;;}}} | |
2177 | ||
2178 | ;; /------------------------------------------------------------------------\ | |
2179 | ;; | "I [..] am rarely happier then when spending an entire day programming | | |
2180 | ;; | my computer to perform automatically a task that it would otherwise | | |
2181 | ;; | take me a good ten seconds to do by hand. Ten seconds, I tell myself, | | |
2182 | ;; | is ten seconds. Time is valuable and ten seconds' worth of it is well | | |
2183 | ;; | worth the investment of a day's happy activity working out a way to | | |
2184 | ;; | save it". -- Douglas Adams, "Last Chance to See" | | |
2185 | ;; \------------------------------------------------------------------------/ | |
2186 | ||
ffc30f4f | 2187 | ;; arch-tag: 7b16bb1a-808c-4991-a8cc-66d3822936d0 |
e79016aa | 2188 | ;;; follow.el ends here |