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