Mercurial > emacs
annotate lisp/autorevert.el @ 93164:849abb573acb
(vc-bzr-state): Return 'removed for removed files and
'unregistered for unregistered files.
author | Dan Nicolaescu <dann@ics.uci.edu> |
---|---|
date | Sun, 23 Mar 2008 20:50:52 +0000 |
parents | 107ccd98fa12 |
children | 606f2d163a64 298da4c56fcb |
rev | line source |
---|---|
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
36992
diff
changeset
|
1 ;;; autorevert.el --- revert buffers when files on disk change |
18597 | 2 |
64762
41bb365f41c4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64091
diff
changeset
|
3 ;; Copyright (C) 1997, 1998, 1999, 2001, 2002, 2003, 2004, |
79721 | 4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
18597 | 5 |
26673
f649f6c04a54
(auto-revert-buffers): Auto-revert mode was turned
Gerd Moellmann <gerd@gnu.org>
parents:
26097
diff
changeset
|
6 ;; Author: Anders Lindgren <andersl@andersl.com> |
22250
a77d473867b8
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21289
diff
changeset
|
7 ;; Keywords: convenience |
26673
f649f6c04a54
(auto-revert-buffers): Auto-revert mode was turned
Gerd Moellmann <gerd@gnu.org>
parents:
26097
diff
changeset
|
8 ;; Created: 1997-06-01 |
f649f6c04a54
(auto-revert-buffers): Auto-revert mode was turned
Gerd Moellmann <gerd@gnu.org>
parents:
26097
diff
changeset
|
9 ;; Date: 1999-11-30 |
18597 | 10 |
11 ;; This file is part of GNU Emacs. | |
12 | |
13 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
14 ;; it under the terms of the GNU General Public License as published by | |
78236
9355f9b7bbff
Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents:
76697
diff
changeset
|
15 ;; the Free Software Foundation; either version 3, or (at your option) |
18597 | 16 ;; any later version. |
17 | |
18 ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 ;; GNU General Public License for more details. | |
22 | |
23 ;; You should have received a copy of the GNU General Public License | |
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
64091 | 25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
26 ;; Boston, MA 02110-1301, USA. | |
18597 | 27 |
28 ;;; Commentary: | |
29 | |
30 ;; Introduction: | |
31 ;; | |
32 ;; Whenever a file that Emacs is editing has been changed by another | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
33 ;; program the user normally has to execute the command `revert-buffer' |
18597 | 34 ;; to load the new content of the file into Emacs. |
35 ;; | |
36 ;; This package contains two minor modes: Global Auto-Revert Mode and | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
37 ;; Auto-Revert Mode. Both modes automatically revert buffers |
56463
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
38 ;; whenever the corresponding files have been changed on disk and the |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
39 ;; buffer contains no unsaved changes. |
18597 | 40 ;; |
55867
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
41 ;; Auto-Revert Mode can be activated for individual buffers. Global |
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
42 ;; Auto-Revert Mode applies to all file buffers. (If the user option |
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
43 ;; `global-auto-revert-non-file-buffers' is non-nil, it also applies |
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
44 ;; to some non-file buffers. This option is disabled by default.) |
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
45 ;; Since checking a remote file is too slow, these modes do not check |
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
46 ;; or revert remote files. |
18597 | 47 ;; |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
48 ;; Both modes operate by checking the time stamp of all files at |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
49 ;; intervals of `auto-revert-interval'. The default is every five |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
50 ;; seconds. The check is aborted whenever the user actually uses |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
51 ;; Emacs. You should never even notice that this package is active |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
52 ;; (except that your buffers will be reverted, of course). |
54709
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
53 ;; |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
54 ;; After reverting a file buffer, Auto Revert Mode normally puts point |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
55 ;; at the same position that a regular manual revert would. However, |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
56 ;; there is one exception to this rule. If point is at the end of the |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
57 ;; buffer before reverting, it stays at the end. Similarly if point |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
58 ;; is displayed at the end of a file buffer in any window, it will stay |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
59 ;; at the end of the buffer in that window, even if the window is not |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
60 ;; selected. This way, you can use Auto Revert Mode to `tail' a file. |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
61 ;; Just put point at the end of the buffer and it will stay there. |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
62 ;; These rules apply to file buffers. For non-file buffers, the |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
63 ;; behavior may be mode dependent. |
56463
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
64 ;; |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
65 ;; While you can use Auto Revert Mode to tail a file, this package |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
66 ;; contains a third minor mode, Auto Revert Tail Mode, which does so |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
67 ;; more efficiently, as long as you are sure that the file will only |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
68 ;; change by growing at the end. It only appends the new output, |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
69 ;; instead of reverting the entire buffer. It does so even if the |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
70 ;; buffer contains unsaved changes. (Because they will not be lost.) |
18597 | 71 |
72 ;; Usage: | |
73 ;; | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
74 ;; Go to the appropriate buffer and press either of: |
18597 | 75 ;; M-x auto-revert-mode RET |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
76 ;; M-x auto-revert-tail-mode RET |
18597 | 77 ;; |
78 ;; To activate Global Auto-Revert Mode, press: | |
79 ;; M-x global-auto-revert-mode RET | |
80 ;; | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
81 ;; To activate Global Auto-Revert Mode every time Emacs is started |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
82 ;; customise the option `global-auto-revert-mode' or the following |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
83 ;; line could be added to your ~/.emacs: |
18597 | 84 ;; (global-auto-revert-mode 1) |
85 ;; | |
86 ;; The function `turn-on-auto-revert-mode' could be added to any major | |
87 ;; mode hook to activate Auto-Revert Mode for all buffers in that | |
88 ;; mode. For example, the following line will activate Auto-Revert | |
89 ;; Mode in all C mode buffers: | |
90 ;; | |
91 ;; (add-hook 'c-mode-hook 'turn-on-auto-revert-mode) | |
92 | |
93 ;;; Code: | |
94 | |
95 ;; Dependencies: | |
96 | |
97 (require 'timer) | |
53984
73f78af624f2
(auto-revert-dired-file-list): added missing variable `file' to `let'.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53980
diff
changeset
|
98 |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
99 (eval-when-compile (require 'cl)) |
18597 | 100 |
101 | |
102 ;; Custom Group: | |
103 ;; | |
104 ;; The two modes will be placed next to Auto Save Mode under the | |
105 ;; Files group under Emacs. | |
106 | |
107 (defgroup auto-revert nil | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
108 "Revert individual buffers when files on disk change. |
18597 | 109 |
110 Auto-Revert Mode can be activated for individual buffer. | |
111 Global Auto-Revert Mode applies to all buffers." | |
22250
a77d473867b8
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21289
diff
changeset
|
112 :group 'files |
a77d473867b8
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21289
diff
changeset
|
113 :group 'convenience) |
18597 | 114 |
115 | |
116 ;; Variables: | |
117 | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
118 ;;; What's this?: ;; Autoload for the benefit of `make-mode-line-mouse-sensitive'. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
119 ;;; What's this?: ;;;###autoload |
18597 | 120 (defvar auto-revert-mode nil |
121 "*Non-nil when Auto-Revert Mode is active. | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
122 Never set this variable directly, use the command `auto-revert-mode' instead.") |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
123 (put 'auto-revert-mode 'permanent-local t) |
18597 | 124 |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
125 (defvar auto-revert-tail-mode nil |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
126 "*Non-nil when Auto-Revert Tail Mode is active. |
59200
a5d9000cf1cd
(auto-revert-tail-mode): Doc fix for defvar.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57800
diff
changeset
|
127 Never set this variable directly, use the command |
a5d9000cf1cd
(auto-revert-tail-mode): Doc fix for defvar.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57800
diff
changeset
|
128 `auto-revert-tail-mode' instead.") |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
129 (put 'auto-revert-tail-mode 'permanent-local t) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
130 |
54452
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
131 (defvar auto-revert-timer nil |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
132 "Timer used by Auto-Revert Mode.") |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
133 |
18597 | 134 (defcustom auto-revert-interval 5 |
53379
cd6072a24608
(auto-revert-interval): Doc fix.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52401
diff
changeset
|
135 "Time, in seconds, between Auto-Revert Mode file checks. |
54452
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
136 The value may be an integer or floating point number. |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
137 |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
138 If a timer is already active, there are two ways to make sure |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
139 that the new value will take effect immediately. You can set |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
140 this variable through Custom or you can call the command |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
141 `auto-revert-set-timer' after setting the variable. Otherwise, |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
142 the new value will take effect the first time Auto Revert Mode |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
143 calls `auto-revert-set-timer' for internal reasons or in your |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
144 next editing session." |
18597 | 145 :group 'auto-revert |
54452
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
146 :type 'number |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
147 :set (lambda (variable value) |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
148 (set-default variable value) |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
149 (and (boundp 'auto-revert-timer) |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
150 auto-revert-timer |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
151 (auto-revert-set-timer)))) |
18597 | 152 |
153 (defcustom auto-revert-stop-on-user-input t | |
60094
daab1497df5a
(auto-revert-stop-on-user-input, auto-revert-verbose): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
59996
diff
changeset
|
154 "When non-nil, user input temporarily interrupts Auto-Revert Mode. |
60131
bb1a6b3a999d
(auto-revert-stop-on-user-input): Further doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60118
diff
changeset
|
155 With this setting, Auto-Revert Mode checks for user input after |
60118
705006da8774
(auto-revert-stop-on-user-input): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60094
diff
changeset
|
156 handling each buffer and does not process any further buffers |
705006da8774
(auto-revert-stop-on-user-input): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60094
diff
changeset
|
157 \(until the next run of the timer) if user input is available. |
705006da8774
(auto-revert-stop-on-user-input): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60094
diff
changeset
|
158 When nil, Auto-Revert Mode checks files and reverts buffers, |
705006da8774
(auto-revert-stop-on-user-input): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60094
diff
changeset
|
159 with quitting disabled, without paying attention to user input. |
60139
cf2460efae4d
(auto-revert-stop-on-user-input): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60131
diff
changeset
|
160 Thus, with this setting, Emacs might be non-responsive at times." |
18597 | 161 :group 'auto-revert |
162 :type 'boolean) | |
163 | |
164 (defcustom auto-revert-verbose t | |
60094
daab1497df5a
(auto-revert-stop-on-user-input, auto-revert-verbose): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
59996
diff
changeset
|
165 "When nil, Auto-Revert Mode does not generate any messages. |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
166 When non-nil, a message is generated whenever a file is reverted." |
18597 | 167 :group 'auto-revert |
168 :type 'boolean) | |
169 | |
170 (defcustom auto-revert-mode-text " ARev" | |
171 "String to display in the mode line when Auto-Revert Mode is active. | |
172 | |
173 \(When the string is not empty, make sure that it has a leading space.)" | |
174 :tag "Auto Revert Mode Text" ; To separate it from `global-...' | |
175 :group 'auto-revert | |
176 :type 'string) | |
177 | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
178 (defcustom auto-revert-tail-mode-text " Tail" |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
179 "String to display in the mode line when Auto-Revert Tail Mode is active. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
180 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
181 \(When the string is not empty, make sure that it has a leading space.)" |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
182 :group 'auto-revert |
57800
ab671a8f1ce3
(auto-revert-tail-mode-text): Add :version keyword.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57602
diff
changeset
|
183 :type 'string |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59221
diff
changeset
|
184 :version "22.1") |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
185 |
18597 | 186 (defcustom auto-revert-mode-hook nil |
187 "Functions to run when Auto-Revert Mode is activated." | |
188 :tag "Auto Revert Mode Hook" ; To separate it from `global-...' | |
189 :group 'auto-revert | |
190 :type 'hook) | |
191 | |
192 (defcustom global-auto-revert-mode-text "" | |
193 "String to display when Global Auto-Revert Mode is active. | |
194 | |
195 The default is nothing since when this mode is active this text doesn't | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
196 vary over time, or between buffers. Hence mode line text |
18597 | 197 would only waste precious space." |
198 :group 'auto-revert | |
199 :type 'string) | |
200 | |
201 (defcustom global-auto-revert-mode-hook nil | |
202 "Hook called when Global Auto-Revert Mode is activated." | |
203 :group 'auto-revert | |
204 :type 'hook) | |
205 | |
206 (defcustom global-auto-revert-non-file-buffers nil | |
56169
c6dcd23450de
(global-auto-revert-non-file-buffers): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
56156
diff
changeset
|
207 "When nil, Global Auto-Revert mode operates only on file-visiting buffers. |
18597 | 208 |
209 When non-nil, both file buffers and buffers with a custom | |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
210 `revert-buffer-function' and a `buffer-stale-function' are |
56156
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
211 reverted by Global Auto-Revert mode. These include the Buffer |
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
212 List buffer, and Dired buffers showing complete local |
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
213 directories. Dired buffers do not auto-revert as a result of |
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
214 changes in subdirectories or in the contents, size, modes, etc., |
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
215 of files. You may still sometimes want to revert them manually. |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
216 |
56169
c6dcd23450de
(global-auto-revert-non-file-buffers): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
56156
diff
changeset
|
217 Use this option with care since it could lead to excessive auto-reverts. |
70471
c24a99a3c600
(global-auto-revert-non-file-buffers): Point Info links to the main manual,
Eli Zaretskii <eliz@gnu.org>
parents:
68651
diff
changeset
|
218 For more information, see Info node `(emacs)Autorevert'." |
18597 | 219 :group 'auto-revert |
56124
9d0ad446b262
(global-auto-revert-non-file-buffers): Add hyperlink to emacs-xtra
Luc Teirlinck <teirllm@auburn.edu>
parents:
55867
diff
changeset
|
220 :type 'boolean |
70471
c24a99a3c600
(global-auto-revert-non-file-buffers): Point Info links to the main manual,
Eli Zaretskii <eliz@gnu.org>
parents:
68651
diff
changeset
|
221 :link '(info-link "(emacs)Autorevert")) |
18597 | 222 |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
223 (defcustom global-auto-revert-ignore-modes () |
18597 | 224 "List of major modes Global Auto-Revert Mode should not check." |
225 :group 'auto-revert | |
226 :type '(repeat sexp)) | |
227 | |
228 (defcustom auto-revert-load-hook nil | |
229 "Functions to run when Auto-Revert Mode is first loaded." | |
230 :tag "Load Hook" | |
231 :group 'auto-revert | |
232 :type 'hook) | |
233 | |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
234 (defcustom auto-revert-check-vc-info nil |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
235 "If non-nil Auto Revert Mode reliably updates version control info. |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
236 Auto Revert Mode updates version control info whenever the buffer |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
237 needs reverting, regardless of the value of this variable. |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
238 However, the version control state can change without changes to |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
239 the work file. If the change is made from the current Emacs |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
240 session, all info is updated. But if, for instance, a new |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
241 version is checked in from outside the current Emacs session, the |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
242 version control number in the mode line, as well as other version |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
243 control related information, may not be properly updated. If you |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
244 are worried about this, set this variable to a non-nil value. |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
245 |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
246 This currently works by automatically updating the version |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
247 control info every `auto-revert-interval' seconds. Nevertheless, |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
248 it should not cause excessive CPU usage on a reasonably fast |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
249 machine, if it does not apply to too many version controlled |
61013
c0725fd29477
(auto-revert-check-vc-info): Minor doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60139
diff
changeset
|
250 buffers. CPU usage depends on the version control system." |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
251 :group 'auto-revert |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
252 :type 'boolean |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59221
diff
changeset
|
253 :version "22.1") |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
254 |
18597 | 255 (defvar global-auto-revert-ignore-buffer nil |
20648
b644667dcd19
(global-auto-revert-ignore-buffer): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
18597
diff
changeset
|
256 "*When non-nil, Global Auto-Revert Mode will not revert this buffer. |
18597 | 257 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
258 This variable becomes buffer local when set in any fashion.") |
18597 | 259 (make-variable-buffer-local 'global-auto-revert-ignore-buffer) |
260 | |
261 ;; Internal variables: | |
262 | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
263 (defvar auto-revert-buffer-list () |
18597 | 264 "List of buffers in Auto-Revert Mode. |
265 | |
266 Note that only Auto-Revert Mode, never Global Auto-Revert Mode, adds | |
267 buffers to this list. | |
268 | |
269 The timer function `auto-revert-buffers' is responsible for purging | |
270 the list of old buffers.") | |
271 | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
272 (defvar auto-revert-remaining-buffers () |
18597 | 273 "Buffers not checked when user input stopped execution.") |
274 | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
275 (defvar auto-revert-tail-pos 0 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
276 "Position of last known end of file.") |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
277 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
278 (add-hook 'find-file-hook |
82257
8c188b53071d
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
82140
diff
changeset
|
279 (lambda () |
8c188b53071d
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
82140
diff
changeset
|
280 (set (make-local-variable 'auto-revert-tail-pos) |
8c188b53071d
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
82140
diff
changeset
|
281 (nth 7 (file-attributes buffer-file-name))))) |
18597 | 282 |
283 ;; Functions: | |
284 | |
285 ;;;###autoload | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
286 (define-minor-mode auto-revert-mode |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
287 "Toggle reverting buffer when file on disk changes. |
18597 | 288 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
289 With arg, turn Auto Revert mode on if and only if arg is positive. |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
290 This is a minor mode that affects only the current buffer. |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
291 Use `global-auto-revert-mode' to automatically revert all buffers. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
292 Use `auto-revert-tail-mode' if you know that the file will only grow |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
293 without being changed in the part that is already in the buffer." |
61267
06afa2a6987d
(auto-revert-mode): Specify :group.
Lute Kamstra <lute@gnu.org>
parents:
61013
diff
changeset
|
294 :group 'auto-revert :lighter auto-revert-mode-text |
18597 | 295 (if auto-revert-mode |
296 (if (not (memq (current-buffer) auto-revert-buffer-list)) | |
297 (push (current-buffer) auto-revert-buffer-list)) | |
298 (setq auto-revert-buffer-list | |
299 (delq (current-buffer) auto-revert-buffer-list))) | |
300 (auto-revert-set-timer) | |
301 (when auto-revert-mode | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
302 (auto-revert-buffers) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
303 (setq auto-revert-tail-mode nil))) |
18597 | 304 |
305 | |
306 ;;;###autoload | |
307 (defun turn-on-auto-revert-mode () | |
308 "Turn on Auto-Revert Mode. | |
309 | |
310 This function is designed to be added to hooks, for example: | |
311 (add-hook 'c-mode-hook 'turn-on-auto-revert-mode)" | |
312 (auto-revert-mode 1)) | |
313 | |
314 | |
315 ;;;###autoload | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
316 (define-minor-mode auto-revert-tail-mode |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
317 "Toggle reverting tail of buffer when file on disk grows. |
78492
7c8949dbfa0d
Replace `iff' in doc-strings and comments.
Glenn Morris <rgm@gnu.org>
parents:
78408
diff
changeset
|
318 With arg, turn Tail mode on if arg is positive, otherwise turn it off. |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
319 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
320 When Tail mode is enabled, the tail of the file is constantly |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
321 followed, as with the shell command `tail -f'. This means that |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
322 whenever the file grows on disk (presumably because some |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
323 background process is appending to it from time to time), this is |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
324 reflected in the current buffer. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
325 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
326 You can edit the buffer and turn this mode off and on again as |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
327 you please. But make sure the background process has stopped |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
328 writing before you save the file! |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
329 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
330 Use `auto-revert-mode' for changes other than appends!" |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
331 :group 'find-file :lighter auto-revert-tail-mode-text |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
332 (when auto-revert-tail-mode |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
333 (unless buffer-file-name |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
334 (auto-revert-tail-mode 0) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
335 (error "This buffer is not visiting a file")) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
336 (if (and (buffer-modified-p) |
82257
8c188b53071d
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
82140
diff
changeset
|
337 (zerop auto-revert-tail-pos) ; library was loaded only after finding file |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
338 (not (y-or-n-p "Buffer is modified, so tail offset may be wrong. Proceed? "))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
339 (auto-revert-tail-mode 0) |
78408
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
340 ;; a-r-tail-pos stores the size of the file at the time of the |
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
341 ;; last revert. After this package loads, it adds a |
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
342 ;; find-file-hook to set this variable every time a file is |
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
343 ;; loaded. If the package is loaded only _after_ visiting the |
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
344 ;; file to be reverted, then we have no idea what the value of |
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
345 ;; a-r-tail-pos should have been when the file was visited. If |
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
346 ;; the file has changed on disk in the meantime, all we can do |
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
347 ;; is offer to revert the whole thing. If you choose not to |
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
348 ;; revert, then you might miss some output then happened |
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
349 ;; between visiting the file and activating a-r-t-mode. |
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
350 (and (zerop auto-revert-tail-pos) |
82257
8c188b53071d
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
82140
diff
changeset
|
351 (not (verify-visited-file-modtime (current-buffer))) |
8c188b53071d
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
82140
diff
changeset
|
352 (y-or-n-p "File changed on disk, content may be missing. \ |
78408
0f698dc9799c
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
353 Perform a full revert? ") |
82257
8c188b53071d
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
82140
diff
changeset
|
354 ;; Use this (not just revert-buffer) for point-preservation. |
8c188b53071d
(auto-revert-tail-mode): auto-revert-tail-pos is zero, not nil, when
Glenn Morris <rgm@gnu.org>
parents:
82140
diff
changeset
|
355 (auto-revert-handler)) |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
356 ;; else we might reappend our own end when we save |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
357 (add-hook 'before-save-hook (lambda () (auto-revert-tail-mode 0)) nil t) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
358 (or (local-variable-p 'auto-revert-tail-pos) ; don't lose prior position |
64801
da6e5acb4109
(auto-revert-tail-mode): Use make-local-variable,
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
359 (set (make-local-variable 'auto-revert-tail-pos) |
76697
596838644e8e
(find-file-hook, auto-revert-tail-mode):
Jason Rumney <jasonr@gnu.org>
parents:
76520
diff
changeset
|
360 (nth 7 (file-attributes buffer-file-name)))) |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
361 ;; let auto-revert-mode set up the mechanism for us if it isn't already |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
362 (or auto-revert-mode |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
363 (let ((auto-revert-tail-mode t)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
364 (auto-revert-mode 1))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
365 (setq auto-revert-mode nil)))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
366 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
367 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
368 ;;;###autoload |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
369 (defun turn-on-auto-revert-tail-mode () |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
370 "Turn on Auto-Revert Tail Mode. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
371 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
372 This function is designed to be added to hooks, for example: |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
373 (add-hook 'my-logfile-mode-hook 'turn-on-auto-revert-tail-mode)" |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
374 (auto-revert-tail-mode 1)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
375 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
376 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
377 ;;;###autoload |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
378 (define-minor-mode global-auto-revert-mode |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
379 "Revert any buffer when file on disk changes. |
18597 | 380 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
381 With arg, turn Auto Revert mode on globally if and only if arg is positive. |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
382 This is a minor mode that affects all buffers. |
18597 | 383 Use `auto-revert-mode' to revert a particular buffer." |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
384 :global t :group 'auto-revert :lighter global-auto-revert-mode-text |
18597 | 385 (auto-revert-set-timer) |
386 (when global-auto-revert-mode | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
387 (auto-revert-buffers))) |
18597 | 388 |
389 | |
390 (defun auto-revert-set-timer () | |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
391 "Restart or cancel the timer used by Auto-Revert Mode. |
54612
ce6a58ba4c84
(auto-revert-set-timer): Minor doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54609
diff
changeset
|
392 If such a timer is active, cancel it. Start a new timer if |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
393 Global Auto-Revert Mode is active or if Auto-Revert Mode is active |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
394 in some buffer. Restarting the timer ensures that Auto-Revert Mode |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
395 will use an up-to-date value of `auto-revert-interval'" |
54452
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
396 (interactive) |
18597 | 397 (if (timerp auto-revert-timer) |
398 (cancel-timer auto-revert-timer)) | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
399 (setq auto-revert-timer |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
400 (if (or global-auto-revert-mode auto-revert-buffer-list) |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
401 (run-with-timer auto-revert-interval |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
402 auto-revert-interval |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
403 'auto-revert-buffers)))) |
18597 | 404 |
53980
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
405 (defun auto-revert-active-p () |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
406 "Check if auto-revert is active (in current buffer or globally)." |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
407 (or auto-revert-mode |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
408 auto-revert-tail-mode |
53980
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
409 (and |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
410 global-auto-revert-mode |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
411 (not global-auto-revert-ignore-buffer) |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
412 (not (memq major-mode |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
413 global-auto-revert-ignore-modes))))) |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
414 |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
415 (defun auto-revert-handler () |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
416 "Revert current buffer, if appropriate. |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
417 This is an internal function used by Auto-Revert Mode." |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
418 (when (or auto-revert-tail-mode (not (buffer-modified-p))) |
84987
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
419 (let* ((buffer (current-buffer)) size |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
420 (revert |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
421 (or (and buffer-file-name |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
422 (not (file-remote-p buffer-file-name)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
423 (file-readable-p buffer-file-name) |
84987
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
424 (if auto-revert-tail-mode |
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
425 (/= auto-revert-tail-pos |
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
426 (setq size |
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
427 (nth 7 (file-attributes buffer-file-name)))) |
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
428 (not (verify-visited-file-modtime buffer)))) |
56463
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
429 (and (or auto-revert-mode |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
430 global-auto-revert-non-file-buffers) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
431 revert-buffer-function |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
432 (boundp 'buffer-stale-function) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
433 (functionp buffer-stale-function) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
434 (funcall buffer-stale-function t)))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
435 eob eoblist) |
54513
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
436 (when revert |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
437 (when (and auto-revert-verbose |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
438 (not (eq revert 'fast))) |
54592
6a2022999abf
(auto-revert-handler): Print revert message before, rather than after,
Luc Teirlinck <teirllm@auburn.edu>
parents:
54513
diff
changeset
|
439 (message "Reverting buffer `%s'." (buffer-name))) |
54709
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
440 ;; If point (or a window point) is at the end of the buffer, |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
441 ;; we want to keep it at the end after reverting. This allows |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
442 ;; to tail a file. |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
443 (when buffer-file-name |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
444 (setq eob (eobp)) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
445 (walk-windows |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
446 #'(lambda (window) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
447 (and (eq (window-buffer window) buffer) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
448 (= (window-point window) (point-max)) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
449 (push window eoblist))) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
450 'no-mini t)) |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
451 (if auto-revert-tail-mode |
84987
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
452 (auto-revert-tail-handler size) |
57602 | 453 ;; Bind buffer-read-only in case user has done C-x C-q, |
454 ;; so as not to forget that. This gives undesirable results | |
455 ;; when the file's mode changes, but that is less common. | |
56912
86b23d3c36a2
(auto-revert-handler): Bind `buffer-read-only' locally around the call
Luc Teirlinck <teirllm@auburn.edu>
parents:
56516
diff
changeset
|
456 (let ((buffer-read-only buffer-read-only)) |
86b23d3c36a2
(auto-revert-handler): Bind `buffer-read-only' locally around the call
Luc Teirlinck <teirllm@auburn.edu>
parents:
56516
diff
changeset
|
457 (revert-buffer 'ignore-auto 'dont-ask 'preserve-modes))) |
54709
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
458 (when buffer-file-name |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
459 (when eob (goto-char (point-max))) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
460 (dolist (window eoblist) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
461 (set-window-point window (point-max))))) |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
462 ;; `preserve-modes' avoids changing the (minor) modes. But we |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
463 ;; do want to reset the mode for VC, so we do it manually. |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
464 (when (or revert auto-revert-check-vc-info) |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
465 (vc-find-file-hook))))) |
53980
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
466 |
84987
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
467 (defun auto-revert-tail-handler (size) |
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
468 (let ((modified (buffer-modified-p)) |
81721
59741e45a674
(auto-revert-tail-handler): Use inhibit-read-only.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76697
diff
changeset
|
469 (inhibit-read-only t) ; Ignore. |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
470 (file buffer-file-name) |
81721
59741e45a674
(auto-revert-tail-handler): Use inhibit-read-only.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76697
diff
changeset
|
471 (buffer-file-name nil)) ; Ignore that file has changed. |
84987
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
472 (when (/= auto-revert-tail-pos size) |
81721
59741e45a674
(auto-revert-tail-handler): Use inhibit-read-only.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76697
diff
changeset
|
473 (run-hooks 'before-revert-hook) |
59221
4de707f3cc8e
(auto-revert-tail-handler): Put in undo boundaries.
Luc Teirlinck <teirllm@auburn.edu>
parents:
59200
diff
changeset
|
474 (undo-boundary) |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
475 (save-restriction |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
476 (widen) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
477 (save-excursion |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
478 (goto-char (point-max)) |
84987
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
479 (insert-file-contents file nil |
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
480 (and (< auto-revert-tail-pos size) |
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
481 auto-revert-tail-pos) |
9f33047587c7
(auto-revert-handler): In `auto-revert-tail-mode',
David Kastrup <dak@gnu.org>
parents:
82365
diff
changeset
|
482 size))) |
81721
59741e45a674
(auto-revert-tail-handler): Use inhibit-read-only.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76697
diff
changeset
|
483 (run-hooks 'after-revert-hook) |
59221
4de707f3cc8e
(auto-revert-tail-handler): Put in undo boundaries.
Luc Teirlinck <teirllm@auburn.edu>
parents:
59200
diff
changeset
|
484 (undo-boundary) |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
485 (setq auto-revert-tail-pos size) |
81721
59741e45a674
(auto-revert-tail-handler): Use inhibit-read-only.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76697
diff
changeset
|
486 (restore-buffer-modified-p modified))) |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
487 (set-visited-file-modtime)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
488 |
18597 | 489 (defun auto-revert-buffers () |
490 "Revert buffers as specified by Auto-Revert and Global Auto-Revert Mode. | |
491 | |
492 Should `global-auto-revert-mode' be active all file buffers are checked. | |
493 | |
494 Should `auto-revert-mode' be active in some buffers, those buffers | |
495 are checked. | |
496 | |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
497 Non-file buffers that have a custom `revert-buffer-function' and |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
498 a `buffer-stale-function' are reverted either when Auto-Revert |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
499 Mode is active in that buffer, or when the variable |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
500 `global-auto-revert-non-file-buffers' is non-nil and Global |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
501 Auto-Revert Mode is active. |
18597 | 502 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
503 This function stops whenever there is user input. The buffers not |
18597 | 504 checked are stored in the variable `auto-revert-remaining-buffers'. |
505 | |
506 To avoid starvation, the buffers in `auto-revert-remaining-buffers' | |
507 are checked first the next time this function is called. | |
508 | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
509 This function is also responsible for removing buffers no longer in |
18597 | 510 Auto-Revert mode from `auto-revert-buffer-list', and for canceling |
511 the timer when no buffers need to be checked." | |
62957
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
512 (save-match-data |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
513 (let ((bufs (if global-auto-revert-mode |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
514 (buffer-list) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
515 auto-revert-buffer-list)) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
516 (remaining ()) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
517 (new ())) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
518 ;; Partition `bufs' into two halves depending on whether or not |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
519 ;; the buffers are in `auto-revert-remaining-buffers'. The two |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
520 ;; halves are then re-joined with the "remaining" buffers at the |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
521 ;; head of the list. |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
522 (dolist (buf auto-revert-remaining-buffers) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
523 (if (memq buf bufs) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
524 (push buf remaining))) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
525 (dolist (buf bufs) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
526 (if (not (memq buf remaining)) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
527 (push buf new))) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
528 (setq bufs (nreverse (nconc new remaining))) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
529 (while (and bufs |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
530 (not (and auto-revert-stop-on-user-input |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
531 (input-pending-p)))) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
532 (let ((buf (car bufs))) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
533 (if (buffer-name buf) ; Buffer still alive? |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
534 (with-current-buffer buf |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
535 ;; Test if someone has turned off Auto-Revert Mode in a |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
536 ;; non-standard way, for example by changing major mode. |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
537 (if (and (not auto-revert-mode) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
538 (not auto-revert-tail-mode) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
539 (memq buf auto-revert-buffer-list)) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
540 (setq auto-revert-buffer-list |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
541 (delq buf auto-revert-buffer-list))) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
542 (when (auto-revert-active-p) (auto-revert-handler))) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
543 ;; Remove dead buffer from `auto-revert-buffer-list'. |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
544 (setq auto-revert-buffer-list |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
545 (delq buf auto-revert-buffer-list)))) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
546 (setq bufs (cdr bufs))) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
547 (setq auto-revert-remaining-buffers bufs) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
548 ;; Check if we should cancel the timer. |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
549 (when (and (not global-auto-revert-mode) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
550 (null auto-revert-buffer-list)) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
551 (cancel-timer auto-revert-timer) |
e8139030a8a9
(auto-revert-buffers): Use save-match-data.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61267
diff
changeset
|
552 (setq auto-revert-timer nil))))) |
18597 | 553 |
554 | |
555 ;; The end: | |
556 (provide 'autorevert) | |
557 | |
558 (run-hooks 'auto-revert-load-hook) | |
559 | |
81721
59741e45a674
(auto-revert-tail-handler): Use inhibit-read-only.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
76697
diff
changeset
|
560 ;; arch-tag: f6bcb07b-4841-477e-9e44-b18678e58876 |
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
36992
diff
changeset
|
561 ;;; autorevert.el ends here |