Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; autorevert.el --- revert buffers when files on disk change |
4a35aff3 | 2 | |
ab422c4d | 3 | ;; Copyright (C) 1997-1999, 2001-2013 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.) | |
ef3544f6 MA |
42 | ;; |
43 | ;; Since checking a remote file is slow, these modes check or revert | |
44 | ;; remote files only if the user option `auto-revert-remote-files' is | |
45 | ;; non-nil. It is recommended to disable version control for remote | |
46 | ;; files. | |
4a35aff3 | 47 | ;; |
48764ae2 DL |
48 | ;; Both modes operate by checking the time stamp of all files at |
49 | ;; intervals of `auto-revert-interval'. The default is every five | |
50 | ;; seconds. The check is aborted whenever the user actually uses | |
51 | ;; Emacs. You should never even notice that this package is active | |
52 | ;; (except that your buffers will be reverted, of course). | |
1f41bcba | 53 | ;; |
ef3544f6 MA |
54 | ;; If Emacs is compiled with file notification support, notifications |
55 | ;; are used instead of checking the time stamp of the files. You can | |
a778dd57 | 56 | ;; disable this by setting the user option `auto-revert-use-notify' to |
ef3544f6 MA |
57 | ;; nil. Alternatively, a regular expression of directories to be |
58 | ;; excluded from file notifications can be specified by | |
59 | ;; `auto-revert-notify-exclude-dir-regexp'. | |
ed911257 | 60 | ;; |
1f41bcba LT |
61 | ;; After reverting a file buffer, Auto Revert Mode normally puts point |
62 | ;; at the same position that a regular manual revert would. However, | |
63 | ;; there is one exception to this rule. If point is at the end of the | |
64 | ;; buffer before reverting, it stays at the end. Similarly if point | |
65 | ;; is displayed at the end of a file buffer in any window, it will stay | |
66 | ;; at the end of the buffer in that window, even if the window is not | |
67 | ;; selected. This way, you can use Auto Revert Mode to `tail' a file. | |
68 | ;; Just put point at the end of the buffer and it will stay there. | |
69 | ;; These rules apply to file buffers. For non-file buffers, the | |
70 | ;; behavior may be mode dependent. | |
2d677766 LT |
71 | ;; |
72 | ;; While you can use Auto Revert Mode to tail a file, this package | |
73 | ;; contains a third minor mode, Auto Revert Tail Mode, which does so | |
74 | ;; more efficiently, as long as you are sure that the file will only | |
75 | ;; change by growing at the end. It only appends the new output, | |
76 | ;; instead of reverting the entire buffer. It does so even if the | |
77 | ;; buffer contains unsaved changes. (Because they will not be lost.) | |
4a35aff3 RS |
78 | |
79 | ;; Usage: | |
80 | ;; | |
dddc748b | 81 | ;; Go to the appropriate buffer and press either of: |
4a35aff3 | 82 | ;; M-x auto-revert-mode RET |
dddc748b | 83 | ;; M-x auto-revert-tail-mode RET |
4a35aff3 RS |
84 | ;; |
85 | ;; To activate Global Auto-Revert Mode, press: | |
86 | ;; M-x global-auto-revert-mode RET | |
87 | ;; | |
48764ae2 | 88 | ;; To activate Global Auto-Revert Mode every time Emacs is started |
e1dbe924 | 89 | ;; customize the option `global-auto-revert-mode' or the following |
48764ae2 | 90 | ;; line could be added to your ~/.emacs: |
4a35aff3 RS |
91 | ;; (global-auto-revert-mode 1) |
92 | ;; | |
93 | ;; The function `turn-on-auto-revert-mode' could be added to any major | |
94 | ;; mode hook to activate Auto-Revert Mode for all buffers in that | |
95 | ;; mode. For example, the following line will activate Auto-Revert | |
96 | ;; Mode in all C mode buffers: | |
97 | ;; | |
98 | ;; (add-hook 'c-mode-hook 'turn-on-auto-revert-mode) | |
99 | ||
100 | ;;; Code: | |
101 | ||
102 | ;; Dependencies: | |
103 | ||
96c421bb | 104 | (eval-when-compile (require 'cl-lib)) |
4a35aff3 | 105 | (require 'timer) |
0f98bc23 | 106 | |
4a35aff3 RS |
107 | ;; Custom Group: |
108 | ;; | |
109 | ;; The two modes will be placed next to Auto Save Mode under the | |
110 | ;; Files group under Emacs. | |
111 | ||
112 | (defgroup auto-revert nil | |
48764ae2 | 113 | "Revert individual buffers when files on disk change. |
cf20dee0 CY |
114 | Auto-Revert mode enables auto-revert in individual buffers. |
115 | Global Auto-Revert mode does so in all buffers." | |
f5f727f8 DN |
116 | :group 'files |
117 | :group 'convenience) | |
4a35aff3 RS |
118 | |
119 | ||
120 | ;; Variables: | |
121 | ||
dddc748b DP |
122 | ;;; What's this?: ;; Autoload for the benefit of `make-mode-line-mouse-sensitive'. |
123 | ;;; What's this?: ;;;###autoload | |
4a35aff3 | 124 | (defvar auto-revert-mode nil |
18cfb5a1 | 125 | "Non-nil when Auto-Revert Mode is active. |
0e4f9468 SM |
126 | Never set this variable directly, use the command `auto-revert-mode' instead.") |
127 | (put 'auto-revert-mode 'permanent-local t) | |
4a35aff3 | 128 | |
dddc748b | 129 | (defvar auto-revert-tail-mode nil |
18cfb5a1 | 130 | "Non-nil when Auto-Revert Tail Mode is active. |
9e559f9b LT |
131 | Never set this variable directly, use the command |
132 | `auto-revert-tail-mode' instead.") | |
dddc748b DP |
133 | (put 'auto-revert-tail-mode 'permanent-local t) |
134 | ||
a2ac68f1 LT |
135 | (defvar auto-revert-timer nil |
136 | "Timer used by Auto-Revert Mode.") | |
137 | ||
4a35aff3 | 138 | (defcustom auto-revert-interval 5 |
ad660075 | 139 | "Time, in seconds, between Auto-Revert Mode file checks. |
a2ac68f1 LT |
140 | The value may be an integer or floating point number. |
141 | ||
142 | If a timer is already active, there are two ways to make sure | |
143 | that the new value will take effect immediately. You can set | |
144 | this variable through Custom or you can call the command | |
145 | `auto-revert-set-timer' after setting the variable. Otherwise, | |
146 | the new value will take effect the first time Auto Revert Mode | |
147 | calls `auto-revert-set-timer' for internal reasons or in your | |
148 | next editing session." | |
4a35aff3 | 149 | :group 'auto-revert |
a2ac68f1 LT |
150 | :type 'number |
151 | :set (lambda (variable value) | |
152 | (set-default variable value) | |
153 | (and (boundp 'auto-revert-timer) | |
154 | auto-revert-timer | |
155 | (auto-revert-set-timer)))) | |
4a35aff3 RS |
156 | |
157 | (defcustom auto-revert-stop-on-user-input t | |
6547d313 | 158 | "When non-nil, user input temporarily interrupts Auto-Revert Mode. |
6dbbc01d | 159 | With this setting, Auto-Revert Mode checks for user input after |
5433e578 LT |
160 | handling each buffer and does not process any further buffers |
161 | \(until the next run of the timer) if user input is available. | |
162 | When nil, Auto-Revert Mode checks files and reverts buffers, | |
163 | with quitting disabled, without paying attention to user input. | |
8a593054 | 164 | Thus, with this setting, Emacs might be non-responsive at times." |
4a35aff3 RS |
165 | :group 'auto-revert |
166 | :type 'boolean) | |
167 | ||
168 | (defcustom auto-revert-verbose t | |
6547d313 | 169 | "When nil, Auto-Revert Mode does not generate any messages. |
0e5dcfd7 | 170 | When non-nil, a message is generated whenever a file is reverted." |
4a35aff3 RS |
171 | :group 'auto-revert |
172 | :type 'boolean) | |
173 | ||
174 | (defcustom auto-revert-mode-text " ARev" | |
175 | "String to display in the mode line when Auto-Revert Mode is active. | |
176 | ||
177 | \(When the string is not empty, make sure that it has a leading space.)" | |
178 | :tag "Auto Revert Mode Text" ; To separate it from `global-...' | |
179 | :group 'auto-revert | |
180 | :type 'string) | |
181 | ||
dddc748b DP |
182 | (defcustom auto-revert-tail-mode-text " Tail" |
183 | "String to display in the mode line when Auto-Revert Tail Mode is active. | |
184 | ||
185 | \(When the string is not empty, make sure that it has a leading space.)" | |
186 | :group 'auto-revert | |
0a306700 | 187 | :type 'string |
bf247b6e | 188 | :version "22.1") |
dddc748b | 189 | |
4a35aff3 RS |
190 | (defcustom auto-revert-mode-hook nil |
191 | "Functions to run when Auto-Revert Mode is activated." | |
192 | :tag "Auto Revert Mode Hook" ; To separate it from `global-...' | |
193 | :group 'auto-revert | |
194 | :type 'hook) | |
195 | ||
196 | (defcustom global-auto-revert-mode-text "" | |
197 | "String to display when Global Auto-Revert Mode is active. | |
198 | ||
199 | The default is nothing since when this mode is active this text doesn't | |
48764ae2 | 200 | vary over time, or between buffers. Hence mode line text |
4a35aff3 RS |
201 | would only waste precious space." |
202 | :group 'auto-revert | |
203 | :type 'string) | |
204 | ||
205 | (defcustom global-auto-revert-mode-hook nil | |
206 | "Hook called when Global Auto-Revert Mode is activated." | |
207 | :group 'auto-revert | |
208 | :type 'hook) | |
209 | ||
210 | (defcustom global-auto-revert-non-file-buffers nil | |
d9e4328d | 211 | "When nil, Global Auto-Revert mode operates only on file-visiting buffers. |
4a35aff3 RS |
212 | |
213 | When non-nil, both file buffers and buffers with a custom | |
0e5dcfd7 | 214 | `revert-buffer-function' and a `buffer-stale-function' are |
9ae0d84f | 215 | reverted by Global Auto-Revert mode. These include the Buffer |
fc2f6a26 GM |
216 | List buffer displayed by `buffer-menu', and Dired buffers showing |
217 | complete local directories. The Buffer List buffer reverts every | |
218 | `auto-revert-interval' seconds; Dired buffers when the file list of | |
219 | the main directory changes. Dired buffers do not auto-revert as | |
220 | a result of changes in subdirectories, or in the contents, size, | |
221 | modes, etc., of files. You may still sometimes want to revert | |
222 | them manually. | |
0e4f9468 | 223 | |
d9e4328d | 224 | Use this option with care since it could lead to excessive auto-reverts. |
415053a1 | 225 | For more information, see Info node `(emacs)Autorevert'." |
4a35aff3 | 226 | :group 'auto-revert |
843c51ae | 227 | :type 'boolean |
415053a1 | 228 | :link '(info-link "(emacs)Autorevert")) |
4a35aff3 | 229 | |
dddc748b | 230 | (defcustom global-auto-revert-ignore-modes () |
4a35aff3 RS |
231 | "List of major modes Global Auto-Revert Mode should not check." |
232 | :group 'auto-revert | |
233 | :type '(repeat sexp)) | |
234 | ||
235 | (defcustom auto-revert-load-hook nil | |
236 | "Functions to run when Auto-Revert Mode is first loaded." | |
237 | :tag "Load Hook" | |
238 | :group 'auto-revert | |
239 | :type 'hook) | |
240 | ||
71c8db4c LT |
241 | (defcustom auto-revert-check-vc-info nil |
242 | "If non-nil Auto Revert Mode reliably updates version control info. | |
243 | Auto Revert Mode updates version control info whenever the buffer | |
244 | needs reverting, regardless of the value of this variable. | |
245 | However, the version control state can change without changes to | |
246 | the work file. If the change is made from the current Emacs | |
247 | session, all info is updated. But if, for instance, a new | |
248 | version is checked in from outside the current Emacs session, the | |
249 | version control number in the mode line, as well as other version | |
250 | control related information, may not be properly updated. If you | |
251 | are worried about this, set this variable to a non-nil value. | |
252 | ||
253 | This currently works by automatically updating the version | |
254 | control info every `auto-revert-interval' seconds. Nevertheless, | |
255 | it should not cause excessive CPU usage on a reasonably fast | |
256 | machine, if it does not apply to too many version controlled | |
f9478d4d | 257 | buffers. CPU usage depends on the version control system." |
71c8db4c LT |
258 | :group 'auto-revert |
259 | :type 'boolean | |
bf247b6e | 260 | :version "22.1") |
71c8db4c | 261 | |
4a35aff3 | 262 | (defvar global-auto-revert-ignore-buffer nil |
18cfb5a1 | 263 | "When non-nil, Global Auto-Revert Mode will not revert this buffer. |
48764ae2 | 264 | This variable becomes buffer local when set in any fashion.") |
4a35aff3 RS |
265 | (make-variable-buffer-local 'global-auto-revert-ignore-buffer) |
266 | ||
ef3544f6 MA |
267 | (defcustom auto-revert-remote-files nil |
268 | "If non-nil remote files are also reverted." | |
269 | :group 'auto-revert | |
270 | :type 'boolean | |
271 | :version "24.4") | |
272 | ||
a778dd57 MA |
273 | (defconst auto-revert-notify-enabled |
274 | (or (featurep 'inotify) (featurep 'w32notify)) | |
ef3544f6 | 275 | "Non-nil when Emacs has been compiled with file notification support.") |
a778dd57 MA |
276 | |
277 | (defcustom auto-revert-use-notify auto-revert-notify-enabled | |
ef3544f6 MA |
278 | "If non-nil Auto Revert Mode uses file notification functions. |
279 | This requires Emacs being compiled with file notification | |
280 | support (see `auto-revert-notify-enabled'). You should set this | |
281 | variable through Custom only." | |
a778dd57 MA |
282 | :group 'auto-revert |
283 | :type 'boolean | |
284 | :set (lambda (variable value) | |
285 | (set-default variable (and auto-revert-notify-enabled value)) | |
68a08a32 | 286 | (unless (symbol-value variable) |
a778dd57 MA |
287 | (when auto-revert-notify-enabled |
288 | (dolist (buf (buffer-list)) | |
289 | (with-current-buffer buf | |
68a08a32 MA |
290 | (when (symbol-value 'auto-revert-notify-watch-descriptor) |
291 | (auto-revert-notify-rm-watch))))))) | |
a778dd57 MA |
292 | :version "24.4") |
293 | ||
ef3544f6 MA |
294 | (defcustom auto-revert-notify-exclude-dir-regexp |
295 | (concat | |
296 | ;; No mounted file systems. | |
297 | "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/")) | |
298 | ;; No remote files. | |
299 | (unless auto-revert-remote-files "\\|^/[^/|:][^/|]+:")) | |
300 | "Regular expression of directories to be excluded from file notifications." | |
301 | :group 'auto-revert | |
302 | :type 'regexp | |
303 | :version "24.4") | |
304 | ||
4a35aff3 RS |
305 | ;; Internal variables: |
306 | ||
dddc748b | 307 | (defvar auto-revert-buffer-list () |
4a35aff3 RS |
308 | "List of buffers in Auto-Revert Mode. |
309 | ||
310 | Note that only Auto-Revert Mode, never Global Auto-Revert Mode, adds | |
311 | buffers to this list. | |
312 | ||
313 | The timer function `auto-revert-buffers' is responsible for purging | |
314 | the list of old buffers.") | |
315 | ||
dddc748b | 316 | (defvar auto-revert-remaining-buffers () |
4a35aff3 RS |
317 | "Buffers not checked when user input stopped execution.") |
318 | ||
dddc748b DP |
319 | (defvar auto-revert-tail-pos 0 |
320 | "Position of last known end of file.") | |
321 | ||
322 | (add-hook 'find-file-hook | |
0917bb33 GM |
323 | (lambda () |
324 | (set (make-local-variable 'auto-revert-tail-pos) | |
325 | (nth 7 (file-attributes buffer-file-name))))) | |
4a35aff3 | 326 | |
ed911257 MA |
327 | (defvar auto-revert-notify-watch-descriptor-hash-list |
328 | (make-hash-table :test 'equal) | |
329 | "A hash table collecting all file watch descriptors. | |
ef3544f6 MA |
330 | Hash key is a watch descriptor, hash value is a list of buffers |
331 | which are related to files being watched and carrying the same | |
332 | default directory.") | |
ed911257 MA |
333 | |
334 | (defvar auto-revert-notify-watch-descriptor nil | |
335 | "The file watch descriptor active for the current buffer.") | |
0eb87688 | 336 | (make-variable-buffer-local 'auto-revert-notify-watch-descriptor) |
2daddd9e | 337 | (put 'auto-revert-notify-watch-descriptor 'permanent-local t) |
ed911257 MA |
338 | |
339 | (defvar auto-revert-notify-modified-p nil | |
340 | "Non-nil when file has been modified on the file system. | |
ef3544f6 | 341 | This has been reported by a file notification event.") |
ed911257 MA |
342 | (make-variable-buffer-local 'auto-revert-notify-modified-p) |
343 | ||
4a35aff3 RS |
344 | ;; Functions: |
345 | ||
346 | ;;;###autoload | |
0e4f9468 | 347 | (define-minor-mode auto-revert-mode |
06e21633 CY |
348 | "Toggle reverting buffer when the file changes (Auto Revert mode). |
349 | With a prefix argument ARG, enable Auto Revert mode if ARG is | |
350 | positive, and disable it otherwise. If called from Lisp, enable | |
351 | the mode if ARG is omitted or nil. | |
352 | ||
353 | Auto Revert mode is a minor mode that affects only the current | |
354 | buffer. When enabled, it reverts the buffer when the file on | |
355 | disk changes. | |
4a35aff3 | 356 | |
dddc748b DP |
357 | Use `global-auto-revert-mode' to automatically revert all buffers. |
358 | Use `auto-revert-tail-mode' if you know that the file will only grow | |
359 | without being changed in the part that is already in the buffer." | |
834b5c1e | 360 | :group 'auto-revert :lighter auto-revert-mode-text |
4a35aff3 RS |
361 | (if auto-revert-mode |
362 | (if (not (memq (current-buffer) auto-revert-buffer-list)) | |
363 | (push (current-buffer) auto-revert-buffer-list)) | |
a778dd57 | 364 | (when auto-revert-use-notify (auto-revert-notify-rm-watch)) |
4a35aff3 RS |
365 | (setq auto-revert-buffer-list |
366 | (delq (current-buffer) auto-revert-buffer-list))) | |
367 | (auto-revert-set-timer) | |
368 | (when auto-revert-mode | |
dddc748b DP |
369 | (auto-revert-buffers) |
370 | (setq auto-revert-tail-mode nil))) | |
4a35aff3 RS |
371 | |
372 | ||
373 | ;;;###autoload | |
374 | (defun turn-on-auto-revert-mode () | |
375 | "Turn on Auto-Revert Mode. | |
376 | ||
377 | This function is designed to be added to hooks, for example: | |
378 | (add-hook 'c-mode-hook 'turn-on-auto-revert-mode)" | |
379 | (auto-revert-mode 1)) | |
380 | ||
381 | ||
dddc748b DP |
382 | ;;;###autoload |
383 | (define-minor-mode auto-revert-tail-mode | |
06e21633 CY |
384 | "Toggle reverting tail of buffer when the file grows. |
385 | With a prefix argument ARG, enable Auto-Revert Tail mode if ARG | |
386 | is positive, and disable it otherwise. If called from Lisp, | |
387 | enable the mode if ARG is omitted or nil. | |
dddc748b | 388 | |
06e21633 CY |
389 | When Auto Revert Tail mode is enabled, the tail of the file is |
390 | constantly followed, as with the shell command `tail -f'. This | |
391 | means that whenever the file grows on disk (presumably because | |
392 | some background process is appending to it from time to time), | |
393 | this is reflected in the current buffer. | |
dddc748b DP |
394 | |
395 | You can edit the buffer and turn this mode off and on again as | |
396 | you please. But make sure the background process has stopped | |
397 | writing before you save the file! | |
398 | ||
399 | Use `auto-revert-mode' for changes other than appends!" | |
400 | :group 'find-file :lighter auto-revert-tail-mode-text | |
401 | (when auto-revert-tail-mode | |
402 | (unless buffer-file-name | |
403 | (auto-revert-tail-mode 0) | |
404 | (error "This buffer is not visiting a file")) | |
405 | (if (and (buffer-modified-p) | |
0917bb33 | 406 | (zerop auto-revert-tail-pos) ; library was loaded only after finding file |
dddc748b DP |
407 | (not (y-or-n-p "Buffer is modified, so tail offset may be wrong. Proceed? "))) |
408 | (auto-revert-tail-mode 0) | |
0917bb33 GM |
409 | ;; a-r-tail-pos stores the size of the file at the time of the |
410 | ;; last revert. After this package loads, it adds a | |
411 | ;; find-file-hook to set this variable every time a file is | |
412 | ;; loaded. If the package is loaded only _after_ visiting the | |
413 | ;; file to be reverted, then we have no idea what the value of | |
414 | ;; a-r-tail-pos should have been when the file was visited. If | |
415 | ;; the file has changed on disk in the meantime, all we can do | |
416 | ;; is offer to revert the whole thing. If you choose not to | |
417 | ;; revert, then you might miss some output then happened | |
418 | ;; between visiting the file and activating a-r-t-mode. | |
419 | (and (zerop auto-revert-tail-pos) | |
420 | (not (verify-visited-file-modtime (current-buffer))) | |
421 | (y-or-n-p "File changed on disk, content may be missing. \ | |
422 | Perform a full revert? ") | |
423 | ;; Use this (not just revert-buffer) for point-preservation. | |
424 | (auto-revert-handler)) | |
dddc748b DP |
425 | ;; else we might reappend our own end when we save |
426 | (add-hook 'before-save-hook (lambda () (auto-revert-tail-mode 0)) nil t) | |
427 | (or (local-variable-p 'auto-revert-tail-pos) ; don't lose prior position | |
f373470d | 428 | (set (make-local-variable 'auto-revert-tail-pos) |
ced3c1e2 | 429 | (nth 7 (file-attributes buffer-file-name)))) |
dddc748b DP |
430 | ;; let auto-revert-mode set up the mechanism for us if it isn't already |
431 | (or auto-revert-mode | |
432 | (let ((auto-revert-tail-mode t)) | |
433 | (auto-revert-mode 1))) | |
434 | (setq auto-revert-mode nil)))) | |
435 | ||
436 | ||
437 | ;;;###autoload | |
438 | (defun turn-on-auto-revert-tail-mode () | |
06e21633 | 439 | "Turn on Auto-Revert Tail mode. |
dddc748b DP |
440 | |
441 | This function is designed to be added to hooks, for example: | |
442 | (add-hook 'my-logfile-mode-hook 'turn-on-auto-revert-tail-mode)" | |
443 | (auto-revert-tail-mode 1)) | |
444 | ||
445 | ||
4a35aff3 | 446 | ;;;###autoload |
0e4f9468 | 447 | (define-minor-mode global-auto-revert-mode |
fc2f6a26 | 448 | "Toggle Global Auto Revert mode. |
06e21633 CY |
449 | With a prefix argument ARG, enable Global Auto Revert mode if ARG |
450 | is positive, and disable it otherwise. If called from Lisp, | |
451 | enable the mode if ARG is omitted or nil. | |
fc2f6a26 | 452 | |
06e21633 CY |
453 | Global Auto Revert mode is a global minor mode that reverts any |
454 | buffer associated with a file when the file changes on disk. Use | |
455 | `auto-revert-mode' to revert a particular buffer. | |
fc2f6a26 GM |
456 | |
457 | If `global-auto-revert-non-file-buffers' is non-nil, this mode | |
458 | may also revert some non-file buffers, as described in the | |
459 | documentation of that variable. It ignores buffers with modes | |
460 | matching `global-auto-revert-ignore-modes', and buffers with a | |
461 | non-nil vale of `global-auto-revert-ignore-buffer'. | |
462 | ||
463 | This function calls the hook `global-auto-revert-mode-hook'. | |
464 | It displays the text that `global-auto-revert-mode-text' | |
465 | specifies in the mode line." | |
0e4f9468 | 466 | :global t :group 'auto-revert :lighter global-auto-revert-mode-text |
4a35aff3 | 467 | (auto-revert-set-timer) |
ed911257 MA |
468 | (if global-auto-revert-mode |
469 | (auto-revert-buffers) | |
ef3544f6 MA |
470 | (dolist (buf (buffer-list)) |
471 | (with-current-buffer buf | |
472 | (when auto-revert-use-notify | |
ed911257 | 473 | (auto-revert-notify-rm-watch)))))) |
4a35aff3 RS |
474 | |
475 | (defun auto-revert-set-timer () | |
0e5dcfd7 | 476 | "Restart or cancel the timer used by Auto-Revert Mode. |
d97c8375 | 477 | If such a timer is active, cancel it. Start a new timer if |
0e5dcfd7 LT |
478 | Global Auto-Revert Mode is active or if Auto-Revert Mode is active |
479 | in some buffer. Restarting the timer ensures that Auto-Revert Mode | |
480 | will use an up-to-date value of `auto-revert-interval'" | |
a2ac68f1 | 481 | (interactive) |
4a35aff3 RS |
482 | (if (timerp auto-revert-timer) |
483 | (cancel-timer auto-revert-timer)) | |
0e4f9468 SM |
484 | (setq auto-revert-timer |
485 | (if (or global-auto-revert-mode auto-revert-buffer-list) | |
486 | (run-with-timer auto-revert-interval | |
487 | auto-revert-interval | |
dddc748b | 488 | 'auto-revert-buffers)))) |
4a35aff3 | 489 | |
ed911257 | 490 | (defun auto-revert-notify-rm-watch () |
ef3544f6 | 491 | "Disable file notification for current buffer's associated file." |
ed911257 | 492 | (when auto-revert-notify-watch-descriptor |
ef3544f6 MA |
493 | (maphash |
494 | (lambda (key value) | |
495 | (when (equal key auto-revert-notify-watch-descriptor) | |
496 | (setq value (delete (current-buffer) value)) | |
497 | (if value | |
498 | (puthash key value auto-revert-notify-watch-descriptor-hash-list) | |
499 | (remhash key auto-revert-notify-watch-descriptor-hash-list) | |
500 | (ignore-errors | |
501 | (funcall (if (fboundp 'inotify-rm-watch) | |
502 | 'inotify-rm-watch 'w32notify-rm-watch) | |
503 | auto-revert-notify-watch-descriptor))))) | |
504 | auto-revert-notify-watch-descriptor-hash-list) | |
68a08a32 | 505 | (remove-hook 'kill-buffer-hook 'auto-revert-notify-rm-watch)) |
ed911257 MA |
506 | (setq auto-revert-notify-watch-descriptor nil |
507 | auto-revert-notify-modified-p nil)) | |
508 | ||
509 | (defun auto-revert-notify-add-watch () | |
ef3544f6 MA |
510 | "Enable file notification for current buffer's associated file." |
511 | (when (string-match auto-revert-notify-exclude-dir-regexp | |
512 | (expand-file-name default-directory)) | |
513 | ;; Fallback to file checks. | |
514 | (set (make-local-variable 'auto-revert-use-notify) nil)) | |
515 | ||
68a08a32 MA |
516 | (when (and buffer-file-name auto-revert-use-notify |
517 | (not auto-revert-notify-watch-descriptor)) | |
ed911257 | 518 | (let ((func (if (fboundp 'inotify-add-watch) |
10e714d5 | 519 | 'inotify-add-watch 'w32notify-add-watch)) |
ed911257 | 520 | (aspect (if (fboundp 'inotify-add-watch) |
ef3544f6 | 521 | '(create modify moved-to) '(size last-write-time)))) |
ed911257 | 522 | (setq auto-revert-notify-watch-descriptor |
65adfa20 MA |
523 | (ignore-errors |
524 | (funcall | |
ef3544f6 MA |
525 | func (directory-file-name (expand-file-name default-directory)) |
526 | aspect 'auto-revert-notify-handler))) | |
65adfa20 | 527 | (if auto-revert-notify-watch-descriptor |
68a08a32 | 528 | (progn |
ef3544f6 MA |
529 | (puthash |
530 | auto-revert-notify-watch-descriptor | |
531 | (cons (current-buffer) | |
532 | (gethash auto-revert-notify-watch-descriptor | |
533 | auto-revert-notify-watch-descriptor-hash-list)) | |
534 | auto-revert-notify-watch-descriptor-hash-list) | |
68a08a32 MA |
535 | (add-hook (make-local-variable 'kill-buffer-hook) |
536 | 'auto-revert-notify-rm-watch)) | |
65adfa20 MA |
537 | ;; Fallback to file checks. |
538 | (set (make-local-variable 'auto-revert-use-notify) nil))))) | |
539 | ||
540 | (defun auto-revert-notify-event-p (event) | |
ef3544f6 | 541 | "Check that event is a file notification event." |
65adfa20 MA |
542 | (cond ((featurep 'inotify) |
543 | (and (listp event) (= (length event) 4))) | |
544 | ((featurep 'w32notify) | |
545 | (and (listp event) (= (length event) 3) (stringp (nth 2 event)))))) | |
546 | ||
547 | (defun auto-revert-notify-event-descriptor (event) | |
ef3544f6 | 548 | "Return watch descriptor of file notification event, or nil." |
65adfa20 MA |
549 | (and (auto-revert-notify-event-p event) (car event))) |
550 | ||
551 | (defun auto-revert-notify-event-action (event) | |
ef3544f6 | 552 | "Return action of file notification event, or nil." |
65adfa20 MA |
553 | (and (auto-revert-notify-event-p event) (nth 1 event))) |
554 | ||
555 | (defun auto-revert-notify-event-file-name (event) | |
ef3544f6 | 556 | "Return file name of file notification event, or nil." |
65adfa20 MA |
557 | (and (auto-revert-notify-event-p event) |
558 | (cond ((featurep 'inotify) (nth 3 event)) | |
559 | ((featurep 'w32notify) (nth 2 event))))) | |
ed911257 MA |
560 | |
561 | (defun auto-revert-notify-handler (event) | |
ef3544f6 | 562 | "Handle an event returned from file notification." |
65adfa20 MA |
563 | (when (auto-revert-notify-event-p event) |
564 | (let* ((descriptor (auto-revert-notify-event-descriptor event)) | |
565 | (action (auto-revert-notify-event-action event)) | |
566 | (file (auto-revert-notify-event-file-name event)) | |
ef3544f6 MA |
567 | (buffers (gethash descriptor |
568 | auto-revert-notify-watch-descriptor-hash-list))) | |
65adfa20 | 569 | (ignore-errors |
c88be996 MA |
570 | ;; Check, that event is meant for us. |
571 | ;; TODO: Filter events which stop watching, like `move' or `removed'. | |
96c421bb | 572 | (cl-assert descriptor) |
ef3544f6 MA |
573 | (when (featurep 'inotify) |
574 | (cl-assert (or (memq 'create action) | |
575 | (memq 'modify action) | |
576 | (memq 'moved-to action)))) | |
86fbb162 | 577 | (when (featurep 'w32notify) (cl-assert (eq 'modified action))) |
ef3544f6 MA |
578 | ;; Since we watch a directory, a file name must be returned. |
579 | (cl-assert (stringp file)) | |
580 | (dolist (buffer buffers) | |
581 | (when (buffer-live-p buffer) | |
582 | (with-current-buffer buffer | |
583 | (when (and (stringp buffer-file-name) | |
584 | (string-equal | |
585 | (file-name-nondirectory file) | |
586 | (file-name-nondirectory buffer-file-name))) | |
587 | ;; Mark buffer modified. | |
588 | (setq auto-revert-notify-modified-p t) | |
589 | ;; No need to check other buffers. | |
590 | (cl-return))))))))) | |
ed911257 | 591 | |
ed35db71 EZ |
592 | (defun auto-revert-active-p () |
593 | "Check if auto-revert is active (in current buffer or globally)." | |
594 | (or auto-revert-mode | |
dddc748b | 595 | auto-revert-tail-mode |
ed35db71 EZ |
596 | (and |
597 | global-auto-revert-mode | |
598 | (not global-auto-revert-ignore-buffer) | |
599 | (not (memq major-mode | |
600 | global-auto-revert-ignore-modes))))) | |
601 | ||
ed35db71 | 602 | (defun auto-revert-handler () |
0e5dcfd7 LT |
603 | "Revert current buffer, if appropriate. |
604 | This is an internal function used by Auto-Revert Mode." | |
dddc748b | 605 | (when (or auto-revert-tail-mode (not (buffer-modified-p))) |
fdc31e1d | 606 | (let* ((buffer (current-buffer)) size |
ef3544f6 MA |
607 | ;; Tramp caches the file attributes. Setting |
608 | ;; `remote-file-name-inhibit-cache' forces Tramp to reread | |
609 | ;; the values. | |
610 | (remote-file-name-inhibit-cache t) | |
dddc748b DP |
611 | (revert |
612 | (or (and buffer-file-name | |
ef3544f6 MA |
613 | (or auto-revert-remote-files |
614 | (not (file-remote-p buffer-file-name))) | |
629cb6ec MA |
615 | (or (not auto-revert-use-notify) |
616 | auto-revert-notify-modified-p) | |
fdc31e1d | 617 | (if auto-revert-tail-mode |
629cb6ec | 618 | (and (file-readable-p buffer-file-name) |
ef3544f6 MA |
619 | (/= auto-revert-tail-pos |
620 | (setq size | |
621 | (nth 7 (file-attributes | |
622 | buffer-file-name))))) | |
629cb6ec MA |
623 | (and (file-readable-p buffer-file-name) |
624 | (not (verify-visited-file-modtime buffer))))) | |
2d677766 | 625 | (and (or auto-revert-mode |
dddc748b DP |
626 | global-auto-revert-non-file-buffers) |
627 | revert-buffer-function | |
628 | (boundp 'buffer-stale-function) | |
629 | (functionp buffer-stale-function) | |
630 | (funcall buffer-stale-function t)))) | |
631 | eob eoblist) | |
629cb6ec | 632 | (setq auto-revert-notify-modified-p nil) |
d4411cef | 633 | (when revert |
71c8db4c LT |
634 | (when (and auto-revert-verbose |
635 | (not (eq revert 'fast))) | |
633e0363 | 636 | (message "Reverting buffer `%s'." (buffer-name))) |
1f41bcba LT |
637 | ;; If point (or a window point) is at the end of the buffer, |
638 | ;; we want to keep it at the end after reverting. This allows | |
639 | ;; to tail a file. | |
640 | (when buffer-file-name | |
641 | (setq eob (eobp)) | |
642 | (walk-windows | |
06641a47 JB |
643 | (lambda (window) |
644 | (and (eq (window-buffer window) buffer) | |
645 | (= (window-point window) (point-max)) | |
646 | (push window eoblist))) | |
1f41bcba | 647 | 'no-mini t)) |
dddc748b | 648 | (if auto-revert-tail-mode |
fdc31e1d | 649 | (auto-revert-tail-handler size) |
7ebc19f9 RS |
650 | ;; Bind buffer-read-only in case user has done C-x C-q, |
651 | ;; so as not to forget that. This gives undesirable results | |
652 | ;; when the file's mode changes, but that is less common. | |
90e118ab LT |
653 | (let ((buffer-read-only buffer-read-only)) |
654 | (revert-buffer 'ignore-auto 'dont-ask 'preserve-modes))) | |
1f41bcba LT |
655 | (when buffer-file-name |
656 | (when eob (goto-char (point-max))) | |
657 | (dolist (window eoblist) | |
658 | (set-window-point window (point-max))))) | |
71c8db4c LT |
659 | ;; `preserve-modes' avoids changing the (minor) modes. But we |
660 | ;; do want to reset the mode for VC, so we do it manually. | |
661 | (when (or revert auto-revert-check-vc-info) | |
662 | (vc-find-file-hook))))) | |
ed35db71 | 663 | |
3eedbc85 | 664 | (defun auto-revert-tail-handler (size) |
fdc31e1d | 665 | (let ((modified (buffer-modified-p)) |
ddd7c238 | 666 | (inhibit-read-only t) ; Ignore. |
dddc748b | 667 | (file buffer-file-name) |
ddd7c238 | 668 | (buffer-file-name nil)) ; Ignore that file has changed. |
fdc31e1d | 669 | (when (/= auto-revert-tail-pos size) |
ddd7c238 | 670 | (run-hooks 'before-revert-hook) |
d918508e | 671 | (undo-boundary) |
dddc748b DP |
672 | (save-restriction |
673 | (widen) | |
674 | (save-excursion | |
675 | (goto-char (point-max)) | |
fdc31e1d DK |
676 | (insert-file-contents file nil |
677 | (and (< auto-revert-tail-pos size) | |
678 | auto-revert-tail-pos) | |
679 | size))) | |
ddd7c238 | 680 | (run-hooks 'after-revert-hook) |
d918508e | 681 | (undo-boundary) |
dddc748b | 682 | (setq auto-revert-tail-pos size) |
ddd7c238 | 683 | (restore-buffer-modified-p modified))) |
dddc748b DP |
684 | (set-visited-file-modtime)) |
685 | ||
4a35aff3 RS |
686 | (defun auto-revert-buffers () |
687 | "Revert buffers as specified by Auto-Revert and Global Auto-Revert Mode. | |
688 | ||
689 | Should `global-auto-revert-mode' be active all file buffers are checked. | |
690 | ||
691 | Should `auto-revert-mode' be active in some buffers, those buffers | |
692 | are checked. | |
693 | ||
0e5dcfd7 LT |
694 | Non-file buffers that have a custom `revert-buffer-function' and |
695 | a `buffer-stale-function' are reverted either when Auto-Revert | |
696 | Mode is active in that buffer, or when the variable | |
697 | `global-auto-revert-non-file-buffers' is non-nil and Global | |
698 | Auto-Revert Mode is active. | |
4a35aff3 | 699 | |
48764ae2 | 700 | This function stops whenever there is user input. The buffers not |
4a35aff3 RS |
701 | checked are stored in the variable `auto-revert-remaining-buffers'. |
702 | ||
703 | To avoid starvation, the buffers in `auto-revert-remaining-buffers' | |
704 | are checked first the next time this function is called. | |
705 | ||
48764ae2 | 706 | This function is also responsible for removing buffers no longer in |
4a35aff3 RS |
707 | Auto-Revert mode from `auto-revert-buffer-list', and for canceling |
708 | the timer when no buffers need to be checked." | |
33512cbe LT |
709 | (save-match-data |
710 | (let ((bufs (if global-auto-revert-mode | |
711 | (buffer-list) | |
712 | auto-revert-buffer-list)) | |
713 | (remaining ()) | |
714 | (new ())) | |
715 | ;; Partition `bufs' into two halves depending on whether or not | |
716 | ;; the buffers are in `auto-revert-remaining-buffers'. The two | |
717 | ;; halves are then re-joined with the "remaining" buffers at the | |
718 | ;; head of the list. | |
719 | (dolist (buf auto-revert-remaining-buffers) | |
720 | (if (memq buf bufs) | |
721 | (push buf remaining))) | |
722 | (dolist (buf bufs) | |
723 | (if (not (memq buf remaining)) | |
724 | (push buf new))) | |
725 | (setq bufs (nreverse (nconc new remaining))) | |
726 | (while (and bufs | |
727 | (not (and auto-revert-stop-on-user-input | |
728 | (input-pending-p)))) | |
729 | (let ((buf (car bufs))) | |
aa657fbf | 730 | (if (buffer-live-p buf) |
33512cbe LT |
731 | (with-current-buffer buf |
732 | ;; Test if someone has turned off Auto-Revert Mode in a | |
733 | ;; non-standard way, for example by changing major mode. | |
734 | (if (and (not auto-revert-mode) | |
735 | (not auto-revert-tail-mode) | |
736 | (memq buf auto-revert-buffer-list)) | |
737 | (setq auto-revert-buffer-list | |
738 | (delq buf auto-revert-buffer-list))) | |
ed911257 | 739 | (when (auto-revert-active-p) |
ef3544f6 | 740 | ;; Enable file notification. |
a778dd57 | 741 | (when (and auto-revert-use-notify buffer-file-name |
ef3544f6 MA |
742 | (not auto-revert-notify-watch-descriptor)) |
743 | (auto-revert-notify-add-watch)) | |
ed911257 | 744 | (auto-revert-handler))) |
33512cbe LT |
745 | ;; Remove dead buffer from `auto-revert-buffer-list'. |
746 | (setq auto-revert-buffer-list | |
747 | (delq buf auto-revert-buffer-list)))) | |
748 | (setq bufs (cdr bufs))) | |
749 | (setq auto-revert-remaining-buffers bufs) | |
750 | ;; Check if we should cancel the timer. | |
751 | (when (and (not global-auto-revert-mode) | |
752 | (null auto-revert-buffer-list)) | |
753 | (cancel-timer auto-revert-timer) | |
754 | (setq auto-revert-timer nil))))) | |
4a35aff3 RS |
755 | |
756 | ||
757 | ;; The end: | |
4a35aff3 RS |
758 | (provide 'autorevert) |
759 | ||
760 | (run-hooks 'auto-revert-load-hook) | |
761 | ||
e8af40ee | 762 | ;;; autorevert.el ends here |