Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; autorevert.el --- revert buffers when files on disk change |
4a35aff3 | 2 | |
73b0cd50 | 3 | ;; Copyright (C) 1997-1999, 2001-2011 Free Software Foundation, Inc. |
4a35aff3 | 4 | |
a468671a | 5 | ;; Author: Anders Lindgren <andersl@andersl.com> |
f5f727f8 | 6 | ;; Keywords: convenience |
a468671a GM |
7 | ;; Created: 1997-06-01 |
8 | ;; Date: 1999-11-30 | |
4a35aff3 RS |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
eb3fa2cf | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
4a35aff3 | 13 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
4a35aff3 RS |
16 | |
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
4a35aff3 RS |
24 | |
25 | ;;; Commentary: | |
26 | ||
27 | ;; Introduction: | |
28 | ;; | |
29 | ;; Whenever a file that Emacs is editing has been changed by another | |
48764ae2 | 30 | ;; program the user normally has to execute the command `revert-buffer' |
4a35aff3 RS |
31 | ;; to load the new content of the file into Emacs. |
32 | ;; | |
33 | ;; This package contains two minor modes: Global Auto-Revert Mode and | |
48764ae2 | 34 | ;; Auto-Revert Mode. Both modes automatically revert buffers |
2d677766 LT |
35 | ;; whenever the corresponding files have been changed on disk and the |
36 | ;; buffer contains no unsaved changes. | |
4a35aff3 | 37 | ;; |
ae229809 LT |
38 | ;; Auto-Revert Mode can be activated for individual buffers. Global |
39 | ;; Auto-Revert Mode applies to all file buffers. (If the user option | |
40 | ;; `global-auto-revert-non-file-buffers' is non-nil, it also applies | |
41 | ;; to some non-file buffers. This option is disabled by default.) | |
42 | ;; Since checking a remote file is too slow, these modes do not check | |
43 | ;; or revert remote files. | |
4a35aff3 | 44 | ;; |
48764ae2 DL |
45 | ;; Both modes operate by checking the time stamp of all files at |
46 | ;; intervals of `auto-revert-interval'. The default is every five | |
47 | ;; seconds. The check is aborted whenever the user actually uses | |
48 | ;; Emacs. You should never even notice that this package is active | |
49 | ;; (except that your buffers will be reverted, of course). | |
1f41bcba LT |
50 | ;; |
51 | ;; After reverting a file buffer, Auto Revert Mode normally puts point | |
52 | ;; at the same position that a regular manual revert would. However, | |
53 | ;; there is one exception to this rule. If point is at the end of the | |
54 | ;; buffer before reverting, it stays at the end. Similarly if point | |
55 | ;; is displayed at the end of a file buffer in any window, it will stay | |
56 | ;; at the end of the buffer in that window, even if the window is not | |
57 | ;; selected. This way, you can use Auto Revert Mode to `tail' a file. | |
58 | ;; Just put point at the end of the buffer and it will stay there. | |
59 | ;; These rules apply to file buffers. For non-file buffers, the | |
60 | ;; behavior may be mode dependent. | |
2d677766 LT |
61 | ;; |
62 | ;; While you can use Auto Revert Mode to tail a file, this package | |
63 | ;; contains a third minor mode, Auto Revert Tail Mode, which does so | |
64 | ;; more efficiently, as long as you are sure that the file will only | |
65 | ;; change by growing at the end. It only appends the new output, | |
66 | ;; instead of reverting the entire buffer. It does so even if the | |
67 | ;; buffer contains unsaved changes. (Because they will not be lost.) | |
3eedbc85 | 68 | ;; Auto Revert Tail Mode works also for remote files. |
4a35aff3 RS |
69 | |
70 | ;; Usage: | |
71 | ;; | |
dddc748b | 72 | ;; Go to the appropriate buffer and press either of: |
4a35aff3 | 73 | ;; M-x auto-revert-mode RET |
dddc748b | 74 | ;; M-x auto-revert-tail-mode RET |
4a35aff3 RS |
75 | ;; |
76 | ;; To activate Global Auto-Revert Mode, press: | |
77 | ;; M-x global-auto-revert-mode RET | |
78 | ;; | |
48764ae2 DL |
79 | ;; To activate Global Auto-Revert Mode every time Emacs is started |
80 | ;; customise the option `global-auto-revert-mode' or the following | |
81 | ;; line could be added to your ~/.emacs: | |
4a35aff3 RS |
82 | ;; (global-auto-revert-mode 1) |
83 | ;; | |
84 | ;; The function `turn-on-auto-revert-mode' could be added to any major | |
85 | ;; mode hook to activate Auto-Revert Mode for all buffers in that | |
86 | ;; mode. For example, the following line will activate Auto-Revert | |
87 | ;; Mode in all C mode buffers: | |
88 | ;; | |
89 | ;; (add-hook 'c-mode-hook 'turn-on-auto-revert-mode) | |
90 | ||
91 | ;;; Code: | |
92 | ||
93 | ;; Dependencies: | |
94 | ||
95 | (require 'timer) | |
0f98bc23 | 96 | |
71c8db4c | 97 | (eval-when-compile (require 'cl)) |
4a35aff3 RS |
98 | |
99 | ||
100 | ;; Custom Group: | |
101 | ;; | |
102 | ;; The two modes will be placed next to Auto Save Mode under the | |
103 | ;; Files group under Emacs. | |
104 | ||
105 | (defgroup auto-revert nil | |
48764ae2 | 106 | "Revert individual buffers when files on disk change. |
4a35aff3 RS |
107 | |
108 | Auto-Revert Mode can be activated for individual buffer. | |
109 | Global Auto-Revert Mode applies to all buffers." | |
f5f727f8 DN |
110 | :group 'files |
111 | :group 'convenience) | |
4a35aff3 RS |
112 | |
113 | ||
114 | ;; Variables: | |
115 | ||
dddc748b DP |
116 | ;;; What's this?: ;; Autoload for the benefit of `make-mode-line-mouse-sensitive'. |
117 | ;;; What's this?: ;;;###autoload | |
4a35aff3 RS |
118 | (defvar auto-revert-mode nil |
119 | "*Non-nil when Auto-Revert Mode is active. | |
0e4f9468 SM |
120 | Never set this variable directly, use the command `auto-revert-mode' instead.") |
121 | (put 'auto-revert-mode 'permanent-local t) | |
4a35aff3 | 122 | |
dddc748b DP |
123 | (defvar auto-revert-tail-mode nil |
124 | "*Non-nil when Auto-Revert Tail Mode is active. | |
9e559f9b LT |
125 | Never set this variable directly, use the command |
126 | `auto-revert-tail-mode' instead.") | |
dddc748b DP |
127 | (put 'auto-revert-tail-mode 'permanent-local t) |
128 | ||
a2ac68f1 LT |
129 | (defvar auto-revert-timer nil |
130 | "Timer used by Auto-Revert Mode.") | |
131 | ||
4a35aff3 | 132 | (defcustom auto-revert-interval 5 |
ad660075 | 133 | "Time, in seconds, between Auto-Revert Mode file checks. |
a2ac68f1 LT |
134 | The value may be an integer or floating point number. |
135 | ||
136 | If a timer is already active, there are two ways to make sure | |
137 | that the new value will take effect immediately. You can set | |
138 | this variable through Custom or you can call the command | |
139 | `auto-revert-set-timer' after setting the variable. Otherwise, | |
140 | the new value will take effect the first time Auto Revert Mode | |
141 | calls `auto-revert-set-timer' for internal reasons or in your | |
142 | next editing session." | |
4a35aff3 | 143 | :group 'auto-revert |
a2ac68f1 LT |
144 | :type 'number |
145 | :set (lambda (variable value) | |
146 | (set-default variable value) | |
147 | (and (boundp 'auto-revert-timer) | |
148 | auto-revert-timer | |
149 | (auto-revert-set-timer)))) | |
4a35aff3 RS |
150 | |
151 | (defcustom auto-revert-stop-on-user-input t | |
6547d313 | 152 | "When non-nil, user input temporarily interrupts Auto-Revert Mode. |
6dbbc01d | 153 | With this setting, Auto-Revert Mode checks for user input after |
5433e578 LT |
154 | handling each buffer and does not process any further buffers |
155 | \(until the next run of the timer) if user input is available. | |
156 | When nil, Auto-Revert Mode checks files and reverts buffers, | |
157 | with quitting disabled, without paying attention to user input. | |
8a593054 | 158 | Thus, with this setting, Emacs might be non-responsive at times." |
4a35aff3 RS |
159 | :group 'auto-revert |
160 | :type 'boolean) | |
161 | ||
162 | (defcustom auto-revert-verbose t | |
6547d313 | 163 | "When nil, Auto-Revert Mode does not generate any messages. |
0e5dcfd7 | 164 | When non-nil, a message is generated whenever a file is reverted." |
4a35aff3 RS |
165 | :group 'auto-revert |
166 | :type 'boolean) | |
167 | ||
168 | (defcustom auto-revert-mode-text " ARev" | |
169 | "String to display in the mode line when Auto-Revert Mode is active. | |
170 | ||
171 | \(When the string is not empty, make sure that it has a leading space.)" | |
172 | :tag "Auto Revert Mode Text" ; To separate it from `global-...' | |
173 | :group 'auto-revert | |
174 | :type 'string) | |
175 | ||
dddc748b DP |
176 | (defcustom auto-revert-tail-mode-text " Tail" |
177 | "String to display in the mode line when Auto-Revert Tail Mode is active. | |
178 | ||
179 | \(When the string is not empty, make sure that it has a leading space.)" | |
180 | :group 'auto-revert | |
0a306700 | 181 | :type 'string |
bf247b6e | 182 | :version "22.1") |
dddc748b | 183 | |
4a35aff3 RS |
184 | (defcustom auto-revert-mode-hook nil |
185 | "Functions to run when Auto-Revert Mode is activated." | |
186 | :tag "Auto Revert Mode Hook" ; To separate it from `global-...' | |
187 | :group 'auto-revert | |
188 | :type 'hook) | |
189 | ||
190 | (defcustom global-auto-revert-mode-text "" | |
191 | "String to display when Global Auto-Revert Mode is active. | |
192 | ||
193 | The default is nothing since when this mode is active this text doesn't | |
48764ae2 | 194 | vary over time, or between buffers. Hence mode line text |
4a35aff3 RS |
195 | would only waste precious space." |
196 | :group 'auto-revert | |
197 | :type 'string) | |
198 | ||
199 | (defcustom global-auto-revert-mode-hook nil | |
200 | "Hook called when Global Auto-Revert Mode is activated." | |
201 | :group 'auto-revert | |
202 | :type 'hook) | |
203 | ||
204 | (defcustom global-auto-revert-non-file-buffers nil | |
d9e4328d | 205 | "When nil, Global Auto-Revert mode operates only on file-visiting buffers. |
4a35aff3 RS |
206 | |
207 | When non-nil, both file buffers and buffers with a custom | |
0e5dcfd7 | 208 | `revert-buffer-function' and a `buffer-stale-function' are |
9ae0d84f | 209 | reverted by Global Auto-Revert mode. These include the Buffer |
fc2f6a26 GM |
210 | List buffer displayed by `buffer-menu', and Dired buffers showing |
211 | complete local directories. The Buffer List buffer reverts every | |
212 | `auto-revert-interval' seconds; Dired buffers when the file list of | |
213 | the main directory changes. Dired buffers do not auto-revert as | |
214 | a result of changes in subdirectories, or in the contents, size, | |
215 | modes, etc., of files. You may still sometimes want to revert | |
216 | them manually. | |
0e4f9468 | 217 | |
d9e4328d | 218 | Use this option with care since it could lead to excessive auto-reverts. |
415053a1 | 219 | For more information, see Info node `(emacs)Autorevert'." |
4a35aff3 | 220 | :group 'auto-revert |
843c51ae | 221 | :type 'boolean |
415053a1 | 222 | :link '(info-link "(emacs)Autorevert")) |
4a35aff3 | 223 | |
dddc748b | 224 | (defcustom global-auto-revert-ignore-modes () |
4a35aff3 RS |
225 | "List of major modes Global Auto-Revert Mode should not check." |
226 | :group 'auto-revert | |
227 | :type '(repeat sexp)) | |
228 | ||
229 | (defcustom auto-revert-load-hook nil | |
230 | "Functions to run when Auto-Revert Mode is first loaded." | |
231 | :tag "Load Hook" | |
232 | :group 'auto-revert | |
233 | :type 'hook) | |
234 | ||
71c8db4c LT |
235 | (defcustom auto-revert-check-vc-info nil |
236 | "If non-nil Auto Revert Mode reliably updates version control info. | |
237 | Auto Revert Mode updates version control info whenever the buffer | |
238 | needs reverting, regardless of the value of this variable. | |
239 | However, the version control state can change without changes to | |
240 | the work file. If the change is made from the current Emacs | |
241 | session, all info is updated. But if, for instance, a new | |
242 | version is checked in from outside the current Emacs session, the | |
243 | version control number in the mode line, as well as other version | |
244 | control related information, may not be properly updated. If you | |
245 | are worried about this, set this variable to a non-nil value. | |
246 | ||
247 | This currently works by automatically updating the version | |
248 | control info every `auto-revert-interval' seconds. Nevertheless, | |
249 | it should not cause excessive CPU usage on a reasonably fast | |
250 | machine, if it does not apply to too many version controlled | |
f9478d4d | 251 | buffers. CPU usage depends on the version control system." |
71c8db4c LT |
252 | :group 'auto-revert |
253 | :type 'boolean | |
bf247b6e | 254 | :version "22.1") |
71c8db4c | 255 | |
4a35aff3 | 256 | (defvar global-auto-revert-ignore-buffer nil |
f1e3ff80 | 257 | "*When non-nil, Global Auto-Revert Mode will not revert this buffer. |
4a35aff3 | 258 | |
48764ae2 | 259 | This variable becomes buffer local when set in any fashion.") |
4a35aff3 RS |
260 | (make-variable-buffer-local 'global-auto-revert-ignore-buffer) |
261 | ||
4a35aff3 RS |
262 | ;; Internal variables: |
263 | ||
dddc748b | 264 | (defvar auto-revert-buffer-list () |
4a35aff3 RS |
265 | "List of buffers in Auto-Revert Mode. |
266 | ||
267 | Note that only Auto-Revert Mode, never Global Auto-Revert Mode, adds | |
268 | buffers to this list. | |
269 | ||
270 | The timer function `auto-revert-buffers' is responsible for purging | |
271 | the list of old buffers.") | |
272 | ||
dddc748b | 273 | (defvar auto-revert-remaining-buffers () |
4a35aff3 RS |
274 | "Buffers not checked when user input stopped execution.") |
275 | ||
dddc748b DP |
276 | (defvar auto-revert-tail-pos 0 |
277 | "Position of last known end of file.") | |
278 | ||
279 | (add-hook 'find-file-hook | |
0917bb33 GM |
280 | (lambda () |
281 | (set (make-local-variable 'auto-revert-tail-pos) | |
282 | (nth 7 (file-attributes buffer-file-name))))) | |
4a35aff3 RS |
283 | |
284 | ;; Functions: | |
285 | ||
286 | ;;;###autoload | |
0e4f9468 | 287 | (define-minor-mode auto-revert-mode |
48764ae2 | 288 | "Toggle reverting buffer when file on disk changes. |
4a35aff3 | 289 | |
48764ae2 DL |
290 | With arg, turn Auto Revert mode on if and only if arg is positive. |
291 | This is a minor mode that affects only the current buffer. | |
dddc748b DP |
292 | Use `global-auto-revert-mode' to automatically revert all buffers. |
293 | Use `auto-revert-tail-mode' if you know that the file will only grow | |
294 | without being changed in the part that is already in the buffer." | |
834b5c1e | 295 | :group 'auto-revert :lighter auto-revert-mode-text |
4a35aff3 RS |
296 | (if auto-revert-mode |
297 | (if (not (memq (current-buffer) auto-revert-buffer-list)) | |
298 | (push (current-buffer) auto-revert-buffer-list)) | |
299 | (setq auto-revert-buffer-list | |
300 | (delq (current-buffer) auto-revert-buffer-list))) | |
301 | (auto-revert-set-timer) | |
302 | (when auto-revert-mode | |
dddc748b DP |
303 | (auto-revert-buffers) |
304 | (setq auto-revert-tail-mode nil))) | |
4a35aff3 RS |
305 | |
306 | ||
307 | ;;;###autoload | |
308 | (defun turn-on-auto-revert-mode () | |
309 | "Turn on Auto-Revert Mode. | |
310 | ||
311 | This function is designed to be added to hooks, for example: | |
312 | (add-hook 'c-mode-hook 'turn-on-auto-revert-mode)" | |
313 | (auto-revert-mode 1)) | |
314 | ||
315 | ||
dddc748b DP |
316 | ;;;###autoload |
317 | (define-minor-mode auto-revert-tail-mode | |
318 | "Toggle reverting tail of buffer when file on disk grows. | |
4837b516 | 319 | With arg, turn Tail mode on if arg is positive, otherwise turn it off. |
dddc748b DP |
320 | |
321 | When Tail mode is enabled, the tail of the file is constantly | |
322 | followed, as with the shell command `tail -f'. This means that | |
323 | whenever the file grows on disk (presumably because some | |
324 | background process is appending to it from time to time), this is | |
325 | reflected in the current buffer. | |
326 | ||
327 | You can edit the buffer and turn this mode off and on again as | |
328 | you please. But make sure the background process has stopped | |
329 | writing before you save the file! | |
330 | ||
331 | Use `auto-revert-mode' for changes other than appends!" | |
332 | :group 'find-file :lighter auto-revert-tail-mode-text | |
333 | (when auto-revert-tail-mode | |
334 | (unless buffer-file-name | |
335 | (auto-revert-tail-mode 0) | |
336 | (error "This buffer is not visiting a file")) | |
337 | (if (and (buffer-modified-p) | |
0917bb33 | 338 | (zerop auto-revert-tail-pos) ; library was loaded only after finding file |
dddc748b DP |
339 | (not (y-or-n-p "Buffer is modified, so tail offset may be wrong. Proceed? "))) |
340 | (auto-revert-tail-mode 0) | |
0917bb33 GM |
341 | ;; a-r-tail-pos stores the size of the file at the time of the |
342 | ;; last revert. After this package loads, it adds a | |
343 | ;; find-file-hook to set this variable every time a file is | |
344 | ;; loaded. If the package is loaded only _after_ visiting the | |
345 | ;; file to be reverted, then we have no idea what the value of | |
346 | ;; a-r-tail-pos should have been when the file was visited. If | |
347 | ;; the file has changed on disk in the meantime, all we can do | |
348 | ;; is offer to revert the whole thing. If you choose not to | |
349 | ;; revert, then you might miss some output then happened | |
350 | ;; between visiting the file and activating a-r-t-mode. | |
351 | (and (zerop auto-revert-tail-pos) | |
352 | (not (verify-visited-file-modtime (current-buffer))) | |
353 | (y-or-n-p "File changed on disk, content may be missing. \ | |
354 | Perform a full revert? ") | |
355 | ;; Use this (not just revert-buffer) for point-preservation. | |
356 | (auto-revert-handler)) | |
dddc748b DP |
357 | ;; else we might reappend our own end when we save |
358 | (add-hook 'before-save-hook (lambda () (auto-revert-tail-mode 0)) nil t) | |
359 | (or (local-variable-p 'auto-revert-tail-pos) ; don't lose prior position | |
f373470d | 360 | (set (make-local-variable 'auto-revert-tail-pos) |
ced3c1e2 | 361 | (nth 7 (file-attributes buffer-file-name)))) |
dddc748b DP |
362 | ;; let auto-revert-mode set up the mechanism for us if it isn't already |
363 | (or auto-revert-mode | |
364 | (let ((auto-revert-tail-mode t)) | |
365 | (auto-revert-mode 1))) | |
366 | (setq auto-revert-mode nil)))) | |
367 | ||
368 | ||
369 | ;;;###autoload | |
370 | (defun turn-on-auto-revert-tail-mode () | |
371 | "Turn on Auto-Revert Tail Mode. | |
372 | ||
373 | This function is designed to be added to hooks, for example: | |
374 | (add-hook 'my-logfile-mode-hook 'turn-on-auto-revert-tail-mode)" | |
375 | (auto-revert-tail-mode 1)) | |
376 | ||
377 | ||
4a35aff3 | 378 | ;;;###autoload |
0e4f9468 | 379 | (define-minor-mode global-auto-revert-mode |
fc2f6a26 GM |
380 | "Toggle Global Auto Revert mode. |
381 | With optional prefix argument ARG, enable Global Auto Revert Mode | |
382 | if ARG > 0, else disable it. | |
383 | ||
384 | This is a global minor mode that reverts any buffer associated | |
385 | with a file when the file changes on disk. Use `auto-revert-mode' | |
386 | to revert a particular buffer. | |
387 | ||
388 | If `global-auto-revert-non-file-buffers' is non-nil, this mode | |
389 | may also revert some non-file buffers, as described in the | |
390 | documentation of that variable. It ignores buffers with modes | |
391 | matching `global-auto-revert-ignore-modes', and buffers with a | |
392 | non-nil vale of `global-auto-revert-ignore-buffer'. | |
393 | ||
394 | This function calls the hook `global-auto-revert-mode-hook'. | |
395 | It displays the text that `global-auto-revert-mode-text' | |
396 | specifies in the mode line." | |
0e4f9468 | 397 | :global t :group 'auto-revert :lighter global-auto-revert-mode-text |
4a35aff3 RS |
398 | (auto-revert-set-timer) |
399 | (when global-auto-revert-mode | |
0e4f9468 | 400 | (auto-revert-buffers))) |
4a35aff3 RS |
401 | |
402 | ||
403 | (defun auto-revert-set-timer () | |
0e5dcfd7 | 404 | "Restart or cancel the timer used by Auto-Revert Mode. |
d97c8375 | 405 | If such a timer is active, cancel it. Start a new timer if |
0e5dcfd7 LT |
406 | Global Auto-Revert Mode is active or if Auto-Revert Mode is active |
407 | in some buffer. Restarting the timer ensures that Auto-Revert Mode | |
408 | will use an up-to-date value of `auto-revert-interval'" | |
a2ac68f1 | 409 | (interactive) |
4a35aff3 RS |
410 | (if (timerp auto-revert-timer) |
411 | (cancel-timer auto-revert-timer)) | |
0e4f9468 SM |
412 | (setq auto-revert-timer |
413 | (if (or global-auto-revert-mode auto-revert-buffer-list) | |
414 | (run-with-timer auto-revert-interval | |
415 | auto-revert-interval | |
dddc748b | 416 | 'auto-revert-buffers)))) |
4a35aff3 | 417 | |
ed35db71 EZ |
418 | (defun auto-revert-active-p () |
419 | "Check if auto-revert is active (in current buffer or globally)." | |
420 | (or auto-revert-mode | |
dddc748b | 421 | auto-revert-tail-mode |
ed35db71 EZ |
422 | (and |
423 | global-auto-revert-mode | |
424 | (not global-auto-revert-ignore-buffer) | |
425 | (not (memq major-mode | |
426 | global-auto-revert-ignore-modes))))) | |
427 | ||
ed35db71 | 428 | (defun auto-revert-handler () |
0e5dcfd7 LT |
429 | "Revert current buffer, if appropriate. |
430 | This is an internal function used by Auto-Revert Mode." | |
dddc748b | 431 | (when (or auto-revert-tail-mode (not (buffer-modified-p))) |
fdc31e1d | 432 | (let* ((buffer (current-buffer)) size |
dddc748b DP |
433 | (revert |
434 | (or (and buffer-file-name | |
dddc748b | 435 | (file-readable-p buffer-file-name) |
fdc31e1d | 436 | (if auto-revert-tail-mode |
3eedbc85 MA |
437 | ;; Tramp caches the file attributes. Setting |
438 | ;; `tramp-cache-inhibit' forces Tramp to | |
439 | ;; reread the values. | |
440 | (let ((tramp-cache-inhibit-cache t)) | |
441 | (/= auto-revert-tail-pos | |
442 | (setq size | |
443 | (nth 7 (file-attributes | |
444 | buffer-file-name))))) | |
445 | (and (not (file-remote-p buffer-file-name)) | |
446 | (not (verify-visited-file-modtime buffer))))) | |
2d677766 | 447 | (and (or auto-revert-mode |
dddc748b DP |
448 | global-auto-revert-non-file-buffers) |
449 | revert-buffer-function | |
450 | (boundp 'buffer-stale-function) | |
451 | (functionp buffer-stale-function) | |
452 | (funcall buffer-stale-function t)))) | |
453 | eob eoblist) | |
d4411cef | 454 | (when revert |
71c8db4c LT |
455 | (when (and auto-revert-verbose |
456 | (not (eq revert 'fast))) | |
633e0363 | 457 | (message "Reverting buffer `%s'." (buffer-name))) |
1f41bcba LT |
458 | ;; If point (or a window point) is at the end of the buffer, |
459 | ;; we want to keep it at the end after reverting. This allows | |
460 | ;; to tail a file. | |
461 | (when buffer-file-name | |
462 | (setq eob (eobp)) | |
463 | (walk-windows | |
464 | #'(lambda (window) | |
465 | (and (eq (window-buffer window) buffer) | |
466 | (= (window-point window) (point-max)) | |
467 | (push window eoblist))) | |
468 | 'no-mini t)) | |
dddc748b | 469 | (if auto-revert-tail-mode |
fdc31e1d | 470 | (auto-revert-tail-handler size) |
7ebc19f9 RS |
471 | ;; Bind buffer-read-only in case user has done C-x C-q, |
472 | ;; so as not to forget that. This gives undesirable results | |
473 | ;; when the file's mode changes, but that is less common. | |
90e118ab LT |
474 | (let ((buffer-read-only buffer-read-only)) |
475 | (revert-buffer 'ignore-auto 'dont-ask 'preserve-modes))) | |
1f41bcba LT |
476 | (when buffer-file-name |
477 | (when eob (goto-char (point-max))) | |
478 | (dolist (window eoblist) | |
479 | (set-window-point window (point-max))))) | |
71c8db4c LT |
480 | ;; `preserve-modes' avoids changing the (minor) modes. But we |
481 | ;; do want to reset the mode for VC, so we do it manually. | |
482 | (when (or revert auto-revert-check-vc-info) | |
483 | (vc-find-file-hook))))) | |
ed35db71 | 484 | |
3eedbc85 | 485 | (defun auto-revert-tail-handler (size) |
fdc31e1d | 486 | (let ((modified (buffer-modified-p)) |
ddd7c238 | 487 | (inhibit-read-only t) ; Ignore. |
dddc748b | 488 | (file buffer-file-name) |
ddd7c238 | 489 | (buffer-file-name nil)) ; Ignore that file has changed. |
fdc31e1d | 490 | (when (/= auto-revert-tail-pos size) |
ddd7c238 | 491 | (run-hooks 'before-revert-hook) |
d918508e | 492 | (undo-boundary) |
dddc748b DP |
493 | (save-restriction |
494 | (widen) | |
495 | (save-excursion | |
496 | (goto-char (point-max)) | |
fdc31e1d DK |
497 | (insert-file-contents file nil |
498 | (and (< auto-revert-tail-pos size) | |
499 | auto-revert-tail-pos) | |
500 | size))) | |
ddd7c238 | 501 | (run-hooks 'after-revert-hook) |
d918508e | 502 | (undo-boundary) |
dddc748b | 503 | (setq auto-revert-tail-pos size) |
ddd7c238 | 504 | (restore-buffer-modified-p modified))) |
dddc748b DP |
505 | (set-visited-file-modtime)) |
506 | ||
4a35aff3 RS |
507 | (defun auto-revert-buffers () |
508 | "Revert buffers as specified by Auto-Revert and Global Auto-Revert Mode. | |
509 | ||
510 | Should `global-auto-revert-mode' be active all file buffers are checked. | |
511 | ||
512 | Should `auto-revert-mode' be active in some buffers, those buffers | |
513 | are checked. | |
514 | ||
0e5dcfd7 LT |
515 | Non-file buffers that have a custom `revert-buffer-function' and |
516 | a `buffer-stale-function' are reverted either when Auto-Revert | |
517 | Mode is active in that buffer, or when the variable | |
518 | `global-auto-revert-non-file-buffers' is non-nil and Global | |
519 | Auto-Revert Mode is active. | |
4a35aff3 | 520 | |
48764ae2 | 521 | This function stops whenever there is user input. The buffers not |
4a35aff3 RS |
522 | checked are stored in the variable `auto-revert-remaining-buffers'. |
523 | ||
524 | To avoid starvation, the buffers in `auto-revert-remaining-buffers' | |
525 | are checked first the next time this function is called. | |
526 | ||
48764ae2 | 527 | This function is also responsible for removing buffers no longer in |
4a35aff3 RS |
528 | Auto-Revert mode from `auto-revert-buffer-list', and for canceling |
529 | the timer when no buffers need to be checked." | |
33512cbe LT |
530 | (save-match-data |
531 | (let ((bufs (if global-auto-revert-mode | |
532 | (buffer-list) | |
533 | auto-revert-buffer-list)) | |
534 | (remaining ()) | |
535 | (new ())) | |
536 | ;; Partition `bufs' into two halves depending on whether or not | |
537 | ;; the buffers are in `auto-revert-remaining-buffers'. The two | |
538 | ;; halves are then re-joined with the "remaining" buffers at the | |
539 | ;; head of the list. | |
540 | (dolist (buf auto-revert-remaining-buffers) | |
541 | (if (memq buf bufs) | |
542 | (push buf remaining))) | |
543 | (dolist (buf bufs) | |
544 | (if (not (memq buf remaining)) | |
545 | (push buf new))) | |
546 | (setq bufs (nreverse (nconc new remaining))) | |
547 | (while (and bufs | |
548 | (not (and auto-revert-stop-on-user-input | |
549 | (input-pending-p)))) | |
550 | (let ((buf (car bufs))) | |
aa657fbf | 551 | (if (buffer-live-p buf) |
33512cbe LT |
552 | (with-current-buffer buf |
553 | ;; Test if someone has turned off Auto-Revert Mode in a | |
554 | ;; non-standard way, for example by changing major mode. | |
555 | (if (and (not auto-revert-mode) | |
556 | (not auto-revert-tail-mode) | |
557 | (memq buf auto-revert-buffer-list)) | |
558 | (setq auto-revert-buffer-list | |
559 | (delq buf auto-revert-buffer-list))) | |
560 | (when (auto-revert-active-p) (auto-revert-handler))) | |
561 | ;; Remove dead buffer from `auto-revert-buffer-list'. | |
562 | (setq auto-revert-buffer-list | |
563 | (delq buf auto-revert-buffer-list)))) | |
564 | (setq bufs (cdr bufs))) | |
565 | (setq auto-revert-remaining-buffers bufs) | |
566 | ;; Check if we should cancel the timer. | |
567 | (when (and (not global-auto-revert-mode) | |
568 | (null auto-revert-buffer-list)) | |
569 | (cancel-timer auto-revert-timer) | |
570 | (setq auto-revert-timer nil))))) | |
4a35aff3 RS |
571 | |
572 | ||
573 | ;; The end: | |
4a35aff3 RS |
574 | (provide 'autorevert) |
575 | ||
576 | (run-hooks 'auto-revert-load-hook) | |
577 | ||
e8af40ee | 578 | ;;; autorevert.el ends here |