autorevert.el 39 KB
Newer Older
1
;;; autorevert.el --- revert buffers when files on disk change  -*- lexical-binding:t -*-
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1997-1999, 2001-2020 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

5
;; Author: Anders Lindgren
Dan Nicolaescu's avatar
Dan Nicolaescu committed
6
;; Keywords: convenience
7 8
;; Created: 1997-06-01
;; Date: 1999-11-30
Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
24 25 26 27 28 29

;;; Commentary:

;; Introduction:
;;
;; Whenever a file that Emacs is editing has been changed by another
Dave Love's avatar
Dave Love committed
30
;; program the user normally has to execute the command `revert-buffer'
Richard M. Stallman's avatar
Richard M. Stallman committed
31 32 33
;; to load the new content of the file into Emacs.
;;
;; This package contains two minor modes: Global Auto-Revert Mode and
Dave Love's avatar
Dave Love committed
34
;; Auto-Revert Mode.  Both modes automatically revert buffers
35 36
;; whenever the corresponding files have been changed on disk and the
;; buffer contains no unsaved changes.
Richard M. Stallman's avatar
Richard M. Stallman committed
37
;;
Luc Teirlinck's avatar
Luc Teirlinck committed
38 39 40 41
;; Auto-Revert Mode can be activated for individual buffers.  Global
;; Auto-Revert Mode applies to all file buffers. (If the user option
;; `global-auto-revert-non-file-buffers' is non-nil, it also applies
;; to some non-file buffers.  This option is disabled by default.)
42 43 44 45 46
;;
;; Since checking a remote file is slow, these modes check or revert
;; remote files only if the user option `auto-revert-remote-files' is
;; non-nil.  It is recommended to disable version control for remote
;; files.
Richard M. Stallman's avatar
Richard M. Stallman committed
47
;;
Dave Love's avatar
Dave Love committed
48 49 50 51 52
;; Both modes operate by checking the time stamp of all files at
;; intervals of `auto-revert-interval'.  The default is every five
;; seconds.  The check is aborted whenever the user actually uses
;; Emacs.  You should never even notice that this package is active
;; (except that your buffers will be reverted, of course).
53
;;
54 55 56 57 58 59
;; If the file exists, Auto-Revert Mode updates the buffer based on
;; its (possibly empty) contents.  If the file no longer exists, then
;; there is nothing to revert, so it does not modify the buffer.  Once
;; a deleted file corresponding to a buffer in Auto-Revert Mode
;; reappears, Auto-Revert Mode continues to work.
;;
60 61
;; If Emacs is compiled with file notification support, notifications
;; are used instead of checking the time stamp of the files.  You can
62
;; disable this by setting the user option `auto-revert-use-notify' to
63 64 65
;; nil.  Alternatively, a regular expression of directories to be
;; excluded from file notifications can be specified by
;; `auto-revert-notify-exclude-dir-regexp'.
66
;;
67
;; After reverting a file buffer, Auto-Revert Mode normally puts point
68 69 70 71 72
;; at the same position that a regular manual revert would.  However,
;; there is one exception to this rule.  If point is at the end of the
;; buffer before reverting, it stays at the end.  Similarly if point
;; is displayed at the end of a file buffer in any window, it will stay
;; at the end of the buffer in that window, even if the window is not
73
;; selected.  This way, you can use Auto-Revert Mode to `tail' a file.
74 75 76
;; Just put point at the end of the buffer and it will stay there.
;; These rules apply to file buffers. For non-file buffers, the
;; behavior may be mode dependent.
77
;;
78 79
;; While you can use Auto-Revert Mode to tail a file, this package
;; contains a third minor mode, Auto-Revert Tail Mode, which does so
80 81 82 83
;; more efficiently, as long as you are sure that the file will only
;; change by growing at the end.  It only appends the new output,
;; instead of reverting the entire buffer.  It does so even if the
;; buffer contains unsaved changes.  (Because they will not be lost.)
Richard M. Stallman's avatar
Richard M. Stallman committed
84 85 86

;; Usage:
;;
87
;; Go to the appropriate buffer and press either of:
Richard M. Stallman's avatar
Richard M. Stallman committed
88
;;   M-x auto-revert-mode RET
89
;;   M-x auto-revert-tail-mode RET
Richard M. Stallman's avatar
Richard M. Stallman committed
90 91 92 93
;;
;; To activate Global Auto-Revert Mode, press:
;;   M-x global-auto-revert-mode RET
;;
Dave Love's avatar
Dave Love committed
94
;; To activate Global Auto-Revert Mode every time Emacs is started
Paul Eggert's avatar
Paul Eggert committed
95
;; customize the option `global-auto-revert-mode' or the following
Dave Love's avatar
Dave Love committed
96
;; line could be added to your ~/.emacs:
Richard M. Stallman's avatar
Richard M. Stallman committed
97 98 99 100 101 102 103
;;   (global-auto-revert-mode 1)
;;
;; The function `turn-on-auto-revert-mode' could be added to any major
;; mode hook to activate Auto-Revert Mode for all buffers in that
;; mode.  For example, the following line will activate Auto-Revert
;; Mode in all C mode buffers:
;;
104
;; (add-hook 'c-mode-hook #'turn-on-auto-revert-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
105 106 107 108 109

;;; Code:

;; Dependencies:

110
(require 'cl-lib)
Richard M. Stallman's avatar
Richard M. Stallman committed
111
(require 'timer)
112
(require 'filenotify)
113

Richard M. Stallman's avatar
Richard M. Stallman committed
114 115 116 117 118 119
;; Custom Group:
;;
;; The two modes will be placed next to Auto Save Mode under the
;; Files group under Emacs.

(defgroup auto-revert nil
Dave Love's avatar
Dave Love committed
120
  "Revert individual buffers when files on disk change.
121 122
Auto-Revert Mode enables auto-revert in individual buffers.
Global Auto-Revert Mode does so in all buffers."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
123 124
  :group 'files
  :group 'convenience)
Richard M. Stallman's avatar
Richard M. Stallman committed
125 126 127 128 129


;; Variables:

(defvar auto-revert-mode nil
Glenn Morris's avatar
Glenn Morris committed
130
  "Non-nil when Auto-Revert Mode is active.
131 132
Never set this variable directly, use the command `auto-revert-mode' instead.")
(put 'auto-revert-mode 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
133

134
(defvar auto-revert-tail-mode nil
Glenn Morris's avatar
Glenn Morris committed
135
  "Non-nil when Auto-Revert Tail Mode is active.
136 137
Never set this variable directly, use the command
`auto-revert-tail-mode' instead.")
138 139
(put 'auto-revert-tail-mode 'permanent-local t)

140 141 142
(defvar auto-revert-timer nil
  "Timer used by Auto-Revert Mode.")

Richard M. Stallman's avatar
Richard M. Stallman committed
143
(defcustom auto-revert-interval 5
144
  "Time, in seconds, between Auto-Revert Mode file checks.
145 146 147 148 149 150
The value may be an integer or floating point number.

If a timer is already active, there are two ways to make sure
that the new value will take effect immediately.  You can set
this variable through Custom or you can call the command
`auto-revert-set-timer' after setting the variable.  Otherwise,
151
the new value will take effect the first time Auto-Revert Mode
152 153
calls `auto-revert-set-timer' for internal reasons or in your
next editing session."
Richard M. Stallman's avatar
Richard M. Stallman committed
154
  :group 'auto-revert
155 156 157 158 159 160
  :type 'number
  :set (lambda (variable value)
	 (set-default variable value)
	 (and (boundp 'auto-revert-timer)
	      auto-revert-timer
	      (auto-revert-set-timer))))
Richard M. Stallman's avatar
Richard M. Stallman committed
161 162

(defcustom auto-revert-stop-on-user-input t
163
  "When non-nil, user input temporarily interrupts Auto-Revert Mode.
164
With this setting, Auto-Revert Mode checks for user input after
165 166 167 168
handling each buffer and does not process any further buffers
\(until the next run of the timer) if user input is available.
When nil, Auto-Revert Mode checks files and reverts buffers,
with quitting disabled, without paying attention to user input.
169
Thus, with this setting, Emacs might be non-responsive at times."
Richard M. Stallman's avatar
Richard M. Stallman committed
170 171 172 173
  :group 'auto-revert
  :type 'boolean)

(defcustom auto-revert-verbose t
174
  "When nil, Auto-Revert Mode does not generate any messages.
Michael Albinus's avatar
Michael Albinus committed
175
When non-nil, a message is generated whenever a buffer is reverted."
Richard M. Stallman's avatar
Richard M. Stallman committed
176 177 178 179 180 181 182
  :group 'auto-revert
  :type 'boolean)

(defcustom auto-revert-mode-text " ARev"
  "String to display in the mode line when Auto-Revert Mode is active.

\(When the string is not empty, make sure that it has a leading space.)"
183
  :tag "Auto-Revert Mode Text"		; To separate it from `global-...'
Richard M. Stallman's avatar
Richard M. Stallman committed
184 185 186
  :group 'auto-revert
  :type 'string)

187 188 189 190 191
(defcustom auto-revert-tail-mode-text " Tail"
  "String to display in the mode line when Auto-Revert Tail Mode is active.

\(When the string is not empty, make sure that it has a leading space.)"
  :group 'auto-revert
192
  :type 'string
193
  :version "22.1")
194

Richard M. Stallman's avatar
Richard M. Stallman committed
195 196
(defcustom auto-revert-mode-hook nil
  "Functions to run when Auto-Revert Mode is activated."
197
  :tag "Auto-Revert Mode Hook"		; To separate it from `global-...'
Richard M. Stallman's avatar
Richard M. Stallman committed
198 199 200 201 202 203 204
  :group 'auto-revert
  :type 'hook)

(defcustom global-auto-revert-mode-text ""
  "String to display when Global Auto-Revert Mode is active.

The default is nothing since when this mode is active this text doesn't
Dave Love's avatar
Dave Love committed
205
vary over time, or between buffers.  Hence mode line text
Richard M. Stallman's avatar
Richard M. Stallman committed
206 207 208 209 210 211 212 213 214 215
would only waste precious space."
  :group 'auto-revert
  :type 'string)

(defcustom global-auto-revert-mode-hook nil
  "Hook called when Global Auto-Revert Mode is activated."
  :group 'auto-revert
  :type 'hook)

(defcustom global-auto-revert-non-file-buffers nil
216
  "When nil, Global Auto-Revert Mode operates only on file-visiting buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
217 218

When non-nil, both file buffers and buffers with a custom
219
`revert-buffer-function' and a `buffer-stale-function' are
220
reverted by Global Auto-Revert Mode.  These include the Buffer
221 222 223 224 225 226 227
List buffer displayed by `buffer-menu', and Dired buffers showing
complete local directories.  The Buffer List buffer reverts every
`auto-revert-interval' seconds; Dired buffers when the file list of
the main directory changes.  Dired buffers do not auto-revert as
a result of changes in subdirectories, or in the contents, size,
modes, etc., of files.  You may still sometimes want to revert
them manually.
228

229
Use this option with care since it could lead to excessive auto-reverts.
230
For more information, see Info node `(emacs)Autorevert'."
Richard M. Stallman's avatar
Richard M. Stallman committed
231
  :group 'auto-revert
232
  :type 'boolean
233
  :link '(info-link "(emacs)Autorevert"))
Richard M. Stallman's avatar
Richard M. Stallman committed
234

235
(defcustom global-auto-revert-ignore-modes ()
Richard M. Stallman's avatar
Richard M. Stallman committed
236 237 238 239 240 241 242 243 244
  "List of major modes Global Auto-Revert Mode should not check."
  :group 'auto-revert
  :type '(repeat sexp))

(defcustom auto-revert-load-hook nil
  "Functions to run when Auto-Revert Mode is first loaded."
  :tag "Load Hook"
  :group 'auto-revert
  :type 'hook)
Glenn Morris's avatar
Glenn Morris committed
245 246
(make-obsolete-variable 'auto-revert-load-hook
                        "use `with-eval-after-load' instead." "28.1")
Richard M. Stallman's avatar
Richard M. Stallman committed
247

248
(defcustom auto-revert-check-vc-info nil
249 250
  "If non-nil Auto-Revert Mode reliably updates version control info.
Auto-Revert Mode updates version control info whenever the buffer
251 252 253 254 255 256 257 258 259 260 261 262 263
needs reverting, regardless of the value of this variable.
However, the version control state can change without changes to
the work file.  If the change is made from the current Emacs
session, all info is updated.  But if, for instance, a new
version is checked in from outside the current Emacs session, the
version control number in the mode line, as well as other version
control related information, may not be properly updated.  If you
are worried about this, set this variable to a non-nil value.

This currently works by automatically updating the version
control info every `auto-revert-interval' seconds.  Nevertheless,
it should not cause excessive CPU usage on a reasonably fast
machine, if it does not apply to too many version controlled
264
buffers.  CPU usage depends on the version control system."
265 266
  :group 'auto-revert
  :type 'boolean
267
  :version "22.1")
268

269
(defvar-local global-auto-revert-ignore-buffer nil
Glenn Morris's avatar
Glenn Morris committed
270
  "When non-nil, Global Auto-Revert Mode will not revert this buffer.
271 272 273 274
This variable can also be a predicate function, in which case
it'll be called with one parameter (the buffer in question), and
it should return non-nil to make Global Auto-Revert Mode not
revert this buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
275

276 277 278 279 280 281
(defcustom auto-revert-remote-files nil
  "If non-nil remote files are also reverted."
  :group 'auto-revert
  :type 'boolean
  :version "24.4")

282
(defcustom auto-revert-use-notify t
283
  "If non-nil Auto-Revert Mode uses file notification functions.
284
You should set this variable through Custom."
285 286 287
  :group 'auto-revert
  :type 'boolean
  :set (lambda (variable value)
288
	 (set-default variable value)
289
	 (unless (symbol-value variable)
290 291 292
	   (dolist (buf (buffer-list))
	     (with-current-buffer buf
	       (when (symbol-value 'auto-revert-notify-watch-descriptor)
293
		 (auto-revert-notify-rm-watch))))))
294
  :initialize 'custom-initialize-default
295 296
  :version "24.4")

297 298 299 300 301 302 303 304 305 306 307
(defcustom auto-revert-notify-exclude-dir-regexp
  (concat
   ;; No mounted file systems.
   "^" (regexp-opt '("/afs/" "/media/" "/mnt" "/net/" "/tmp_mnt/"))
   ;; No remote files.
   (unless auto-revert-remote-files "\\|^/[^/|:][^/|]+:"))
  "Regular expression of directories to be excluded from file notifications."
  :group 'auto-revert
  :type 'regexp
  :version "24.4")

308 309 310 311 312 313 314 315 316 317 318 319
(defcustom auto-revert-avoid-polling nil
  "Non-nil to avoid polling files when notification is available.

Set this variable to a non-nil value to save power by avoiding
polling when possible.  Files on file-systems that do not support
change notifications must match `auto-revert-notify-exclude-dir-regexp'
for Auto-Revert to work properly in this case.  This typically
includes files on network file systems on Unix-like machines,
when those files are modified from another computer.

When nil, buffers in Auto-Revert Mode will always be polled for
changes to their files on disk every `auto-revert-interval'
320
seconds, in addition to using notification for those files."
321 322 323 324
  :group 'auto-revert
  :type 'boolean
  :set (lambda (variable value)
         (set-default variable value)
325 326
	 (when (fboundp 'auto-revert-set-timer)
           (auto-revert-set-timer)))
327 328
  :version "27.1")

Richard M. Stallman's avatar
Richard M. Stallman committed
329 330
;; Internal variables:

331
(defvar auto-revert-buffer-list ()
Richard M. Stallman's avatar
Richard M. Stallman committed
332 333 334 335 336 337 338 339
  "List of buffers in Auto-Revert Mode.

Note that only Auto-Revert Mode, never Global Auto-Revert Mode, adds
buffers to this list.

The timer function `auto-revert-buffers' is responsible for purging
the list of old buffers.")

340 341 342
(defvar-local auto-revert--global-mode nil
  "Non-nil if buffer is handled by Global Auto-Revert mode.")

343
(defvar auto-revert-remaining-buffers ()
Richard M. Stallman's avatar
Richard M. Stallman committed
344 345
  "Buffers not checked when user input stopped execution.")

346 347 348
(defvar auto-revert-tail-pos 0
  "Position of last known end of file.")

Michael Albinus's avatar
Michael Albinus committed
349 350
(defun auto-revert-find-file-function ()
  (setq-local auto-revert-tail-pos
Paul Eggert's avatar
Paul Eggert committed
351
              (file-attribute-size (file-attributes buffer-file-name))))
Michael Albinus's avatar
Michael Albinus committed
352

353
(add-hook 'find-file-hook
Michael Albinus's avatar
Michael Albinus committed
354
	  #'auto-revert-find-file-function)
355 356
(add-hook 'after-set-visited-file-name-hook
          #'auto-revert-set-visited-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
357

358
(defvar auto-revert--buffers-by-watch-descriptor
359
  (make-hash-table :test 'equal)
360 361 362 363
  "A hash table mapping notification descriptors to lists of buffers.
The buffers use that descriptor for auto-revert notifications.
The key is equal to `auto-revert-notify-watch-descriptor' in each
buffer.")
364

365
(defvar-local auto-revert-notify-watch-descriptor nil
366
  "The file watch descriptor active for the current buffer.")
367
(put 'auto-revert-notify-watch-descriptor 'permanent-local t)
368

369
(defvar-local auto-revert-notify-modified-p nil
370
  "Non-nil when file has been modified on the file system.
371
This has been reported by a file notification event.")
372

373 374 375
(defvar auto-revert-debug nil
  "Use for debug messages.")

Richard M. Stallman's avatar
Richard M. Stallman committed
376 377
;; Functions:

Michael Albinus's avatar
Michael Albinus committed
378 379 380
(defun auto-revert-remove-current-buffer (&optional buffer)
  "Remove BUFFER from `auto-revert-buffer-list'.
BUFFER defaults to `current-buffer'."
Michael Albinus's avatar
Michael Albinus committed
381
  (setq auto-revert-buffer-list
Michael Albinus's avatar
Michael Albinus committed
382
        (delq (or buffer (current-buffer)) auto-revert-buffer-list)))
Michael Albinus's avatar
Michael Albinus committed
383

Richard M. Stallman's avatar
Richard M. Stallman committed
384
;;;###autoload
385
(define-minor-mode auto-revert-mode
386
  "Toggle reverting buffer when the file changes (Auto-Revert Mode).
387

388
Auto-Revert Mode is a minor mode that affects only the current
389 390
buffer.  When enabled, it reverts the buffer when the file on
disk changes.
Richard M. Stallman's avatar
Richard M. Stallman committed
391

Michael Albinus's avatar
Michael Albinus committed
392 393 394
When a buffer is reverted, a message is generated.  This can be
suppressed by setting `auto-revert-verbose' to nil.

395 396 397
Use `global-auto-revert-mode' to automatically revert all buffers.
Use `auto-revert-tail-mode' if you know that the file will only grow
without being changed in the part that is already in the buffer."
398
  :group 'auto-revert :lighter auto-revert-mode-text
Richard M. Stallman's avatar
Richard M. Stallman committed
399
  (if auto-revert-mode
400 401 402 403
      (when (not (memq (current-buffer) auto-revert-buffer-list))
        (push (current-buffer) auto-revert-buffer-list)
        (add-hook
         'kill-buffer-hook
Michael Albinus's avatar
Michael Albinus committed
404
         #'auto-revert-remove-current-buffer
405
         nil t))
406
    (when auto-revert-notify-watch-descriptor (auto-revert-notify-rm-watch))
Michael Albinus's avatar
Michael Albinus committed
407
    (auto-revert-remove-current-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
408 409
  (auto-revert-set-timer)
  (when auto-revert-mode
410 411
    (auto-revert-buffers)
    (setq auto-revert-tail-mode nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
412 413 414 415 416 417 418


;;;###autoload
(defun turn-on-auto-revert-mode ()
  "Turn on Auto-Revert Mode.

This function is designed to be added to hooks, for example:
419
  (add-hook \\='c-mode-hook #\\='turn-on-auto-revert-mode)"
Richard M. Stallman's avatar
Richard M. Stallman committed
420 421 422
  (auto-revert-mode 1))


423 424
;;;###autoload
(define-minor-mode auto-revert-tail-mode
425
  "Toggle reverting tail of buffer when the file grows.
426

427
When Auto-Revert Tail Mode is enabled, the tail of the file is
428 429 430 431
constantly followed, as with the shell command `tail -f'.  This
means that whenever the file grows on disk (presumably because
some background process is appending to it from time to time),
this is reflected in the current buffer.
432 433 434 435 436

You can edit the buffer and turn this mode off and on again as
you please.  But make sure the background process has stopped
writing before you save the file!

Michael Albinus's avatar
Michael Albinus committed
437 438 439
When a buffer is reverted, a message is generated.  This can be
suppressed by setting `auto-revert-verbose' to nil.

440 441 442 443 444 445 446
Use `auto-revert-mode' for changes other than appends!"
  :group 'find-file :lighter auto-revert-tail-mode-text
  (when auto-revert-tail-mode
    (unless buffer-file-name
      (auto-revert-tail-mode 0)
      (error "This buffer is not visiting a file"))
    (if (and (buffer-modified-p)
447
	     (zerop auto-revert-tail-pos) ; library was loaded only after finding file
448 449
	     (not (y-or-n-p "Buffer is modified, so tail offset may be wrong.  Proceed? ")))
	(auto-revert-tail-mode 0)
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
      ;; a-r-tail-pos stores the size of the file at the time of the
      ;; last revert. After this package loads, it adds a
      ;; find-file-hook to set this variable every time a file is
      ;; loaded.  If the package is loaded only _after_ visiting the
      ;; file to be reverted, then we have no idea what the value of
      ;; a-r-tail-pos should have been when the file was visited.  If
      ;; the file has changed on disk in the meantime, all we can do
      ;; is offer to revert the whole thing. If you choose not to
      ;; revert, then you might miss some output then happened
      ;; between visiting the file and activating a-r-t-mode.
      (and (zerop auto-revert-tail-pos)
           (not (verify-visited-file-modtime (current-buffer)))
           (y-or-n-p "File changed on disk, content may be missing.  \
Perform a full revert? ")
           ;; Use this (not just revert-buffer) for point-preservation.
465
           (auto-revert-buffers))
466 467 468
      ;; else we might reappend our own end when we save
      (add-hook 'before-save-hook (lambda () (auto-revert-tail-mode 0)) nil t)
      (or (local-variable-p 'auto-revert-tail-pos) ; don't lose prior position
469
	  (setq-local auto-revert-tail-pos
Paul Eggert's avatar
Paul Eggert committed
470 471
                      (file-attribute-size
                       (file-attributes buffer-file-name))))
472 473 474 475 476 477 478 479 480
      ;; let auto-revert-mode set up the mechanism for us if it isn't already
      (or auto-revert-mode
	  (let ((auto-revert-tail-mode t))
	    (auto-revert-mode 1)))
      (setq auto-revert-mode nil))))


;;;###autoload
(defun turn-on-auto-revert-tail-mode ()
481
  "Turn on Auto-Revert Tail Mode.
482 483

This function is designed to be added to hooks, for example:
484
  (add-hook \\='my-logfile-mode-hook #\\='turn-on-auto-revert-tail-mode)"
485 486 487
  (auto-revert-tail-mode 1))


Richard M. Stallman's avatar
Richard M. Stallman committed
488
;;;###autoload
489
(define-minor-mode global-auto-revert-mode
490
  "Toggle Global Auto-Revert Mode.
491

492
Global Auto-Revert Mode is a global minor mode that reverts any
493 494
buffer associated with a file when the file changes on disk.  Use
`auto-revert-mode' to revert a particular buffer.
495 496 497 498 499

If `global-auto-revert-non-file-buffers' is non-nil, this mode
may also revert some non-file buffers, as described in the
documentation of that variable.  It ignores buffers with modes
matching `global-auto-revert-ignore-modes', and buffers with a
Mauro Aranda's avatar
Mauro Aranda committed
500
non-nil value of `global-auto-revert-ignore-buffer'.
501

Michael Albinus's avatar
Michael Albinus committed
502 503 504
When a buffer is reverted, a message is generated.  This can be
suppressed by setting `auto-revert-verbose' to nil.

505 506 507
This function calls the hook `global-auto-revert-mode-hook'.
It displays the text that `global-auto-revert-mode-text'
specifies in the mode line."
508
  :global t :group 'auto-revert :lighter global-auto-revert-mode-text
Richard M. Stallman's avatar
Richard M. Stallman committed
509
  (auto-revert-set-timer)
510
  (if global-auto-revert-mode
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
      ;; Turn global-auto-revert-mode ON.
      (progn
        (dolist (buf (buffer-list))
          (with-current-buffer buf
            (auto-revert--global-add-current-buffer)))
        ;; Make sure future buffers are added as well.
        (add-hook 'find-file-hook #'auto-revert--global-adopt-current-buffer)
        ;; To track non-file buffers, we need to listen in to buffer
        ;; creation in general.  Listening to major-mode changes is
        ;; suitable, since we then know whether it's a mode that is tracked.
        (when global-auto-revert-non-file-buffers
          (add-hook 'after-change-major-mode-hook
                    #'auto-revert--global-adopt-current-buffer))
        (auto-revert-buffers))
    ;; Turn global-auto-revert-mode OFF.
    (remove-hook 'after-change-major-mode-hook
                 #'auto-revert--global-adopt-current-buffer)
    (remove-hook 'find-file-hook #'auto-revert--global-adopt-current-buffer)
529 530
    (dolist (buf (buffer-list))
      (with-current-buffer buf
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
        (when auto-revert--global-mode
          (setq auto-revert--global-mode nil)
          (when (and auto-revert-notify-watch-descriptor
                     (not (or auto-revert-mode auto-revert-tail-mode)))
	    (auto-revert-notify-rm-watch)))))))

(defun auto-revert--global-add-current-buffer ()
  "Set current buffer to be tracked by Global Auto-Revert if appropriate."
  (when (and (not auto-revert--global-mode)
             (or buffer-file-name
                 (and global-auto-revert-non-file-buffers
                      (not (string-prefix-p " " (buffer-name)))
                      ;; Any non-file buffer must have a custom
                      ;; `buffer-stale-function' to be tracked, since
                      ;; we wouldn't know when to revert it otherwise.
                      (not (eq buffer-stale-function
                               #'buffer-stale--default-function))))
548
             (not (memq major-mode global-auto-revert-ignore-modes))
549 550 551 552 553
             (or (null global-auto-revert-ignore-buffer)
                 (if (functionp global-auto-revert-ignore-buffer)
                     (not (funcall global-auto-revert-ignore-buffer
                                   (current-buffer)))
                   nil)))
554 555 556 557 558 559 560
    (setq auto-revert--global-mode t)))

(defun auto-revert--global-adopt-current-buffer ()
  "Consider tracking current buffer in a running Global Auto-Revert mode."
  (auto-revert--global-add-current-buffer)
  (auto-revert-set-timer))

561 562
(defun auto-revert-set-visited-file-name ()
  "Update Auto-Revert management of the current buffer.
563 564
Called after `set-visited-file-name'."
  (when auto-revert-notify-watch-descriptor
565 566
    ;; Remove any existing notifier so that we don't track the wrong
    ;; file in case the file name was changed.
567
    (auto-revert-notify-rm-watch))
568 569 570 571
    (cond (global-auto-revert-mode
           (auto-revert--global-adopt-current-buffer))
          ((or auto-revert-mode auto-revert-tail-mode)
           (auto-revert-set-timer))))
Richard M. Stallman's avatar
Richard M. Stallman committed
572

573 574
(defun auto-revert--polled-buffers ()
  "List of buffers that need to be polled."
575 576 577 578 579 580 581 582 583 584 585 586
  (cond (global-auto-revert-mode
         (mapcan (lambda (buffer)
                   (and (not (and auto-revert-avoid-polling
                                  (buffer-local-value
                                   'auto-revert-notify-watch-descriptor
                                   buffer)))
                        (or (buffer-local-value
                             'auto-revert--global-mode buffer)
                            (buffer-local-value 'auto-revert-mode buffer)
                            (buffer-local-value 'auto-revert-tail-mode buffer))
                        (list buffer)))
                 (buffer-list)))
587 588
        (auto-revert-avoid-polling
         (mapcan (lambda (buffer)
589 590 591 592
                   (and (not (buffer-local-value
                              'auto-revert-notify-watch-descriptor buffer))
                        (list buffer)))
                 auto-revert-buffer-list))
593 594 595 596 597
        (t auto-revert-buffer-list)))

;; Same as above in a boolean context, but cheaper.
(defun auto-revert--need-polling-p ()
  "Whether periodic polling is required."
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
  (cond (global-auto-revert-mode
         (or (not auto-revert-avoid-polling)
             (cl-some
              (lambda (buffer)
                (and (not (buffer-local-value
                           'auto-revert-notify-watch-descriptor buffer))
                     (or (buffer-local-value 'auto-revert--global-mode buffer)
                         (buffer-local-value 'auto-revert-mode buffer)
                         (buffer-local-value 'auto-revert-tail-mode buffer))))
              (buffer-list))))
        (auto-revert-avoid-polling
         (not (cl-every
               (lambda (buffer)
                 (buffer-local-value
                  'auto-revert-notify-watch-descriptor buffer))
               auto-revert-buffer-list)))
        (t auto-revert-buffer-list)))
615

Richard M. Stallman's avatar
Richard M. Stallman committed
616
(defun auto-revert-set-timer ()
617
  "Restart or cancel the timer used by Auto-Revert Mode.
618
If such a timer is active, cancel it.  Start a new timer if
619 620
Global Auto-Revert Mode is active or if Auto-Revert Mode is active
in some buffer.  Restarting the timer ensures that Auto-Revert Mode
621
will use an up-to-date value of `auto-revert-interval'."
622
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
623 624
  (if (timerp auto-revert-timer)
      (cancel-timer auto-revert-timer))
625
  (setq auto-revert-timer
626 627 628 629
	(and (auto-revert--need-polling-p)
	     (run-with-timer auto-revert-interval
			     auto-revert-interval
			     'auto-revert-buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
630

631 632
(defun auto-revert-notify-rm-watch ()
  "Disable file notification for current buffer's associated file."
633
  (let ((desc auto-revert-notify-watch-descriptor)
634
        (table auto-revert--buffers-by-watch-descriptor))
635 636 637 638 639 640 641 642
    (when desc
      (let ((buffers (delq (current-buffer) (gethash desc table))))
        (if buffers
            (puthash desc buffers table)
          (remhash desc table)))
      (ignore-errors
	(file-notify-rm-watch desc))
      (remove-hook 'kill-buffer-hook #'auto-revert-notify-rm-watch t)))
643 644 645 646
  (setq auto-revert-notify-watch-descriptor nil
	auto-revert-notify-modified-p nil))

(defun auto-revert-notify-add-watch ()
647
  "Enable file notification for current buffer's associated file."
Michael Albinus's avatar
Michael Albinus committed
648
  ;; We can assume that `auto-revert-notify-watch-descriptor' is nil.
649 650 651 652
  (unless (or auto-revert-notify-watch-descriptor
              (string-match auto-revert-notify-exclude-dir-regexp
			    (expand-file-name default-directory))
	      (file-symlink-p (or buffer-file-name default-directory)))
Michael Albinus's avatar
Michael Albinus committed
653 654 655 656 657 658 659
    ;; Check, whether this has been activated already.
    (let ((file (if buffer-file-name
		    (expand-file-name buffer-file-name default-directory)
	          (expand-file-name default-directory))))
      (maphash
       (lambda (key _value)
         (when (and
Michael Albinus's avatar
Michael Albinus committed
660
                (file-notify-valid-p key)
Michael Albinus's avatar
Michael Albinus committed
661 662 663 664 665 666 667
                (equal (file-notify--watch-absolute-filename
                        (gethash key file-notify-descriptors))
                       (directory-file-name file))
                (equal (file-notify--watch-callback
                        (gethash key file-notify-descriptors))
                       'auto-revert-notify-handler))
         (setq auto-revert-notify-watch-descriptor key)))
668
       auto-revert--buffers-by-watch-descriptor)
Michael Albinus's avatar
Michael Albinus committed
669 670 671 672 673 674 675 676 677 678 679 680 681 682
      ;; Create a new watch if needed.
      (unless auto-revert-notify-watch-descriptor
        (setq auto-revert-notify-watch-descriptor
	      (ignore-errors
		(file-notify-add-watch
		 file
                 (if buffer-file-name '(change attribute-change) '(change))
                 'auto-revert-notify-handler))))
      (when auto-revert-notify-watch-descriptor
        (setq auto-revert-notify-modified-p t)
        (puthash
         auto-revert-notify-watch-descriptor
         (cons (current-buffer)
	       (gethash auto-revert-notify-watch-descriptor
683 684
		        auto-revert--buffers-by-watch-descriptor))
         auto-revert--buffers-by-watch-descriptor)
685
        (add-hook 'kill-buffer-hook #'auto-revert-notify-rm-watch nil t)))))
686

687 688 689 690 691
;; If we have file notifications, we want to update the auto-revert buffers
;; immediately when a notification occurs. Since file updates can happen very
;; often, we want to skip some revert operations so that we don't spend all our
;; time reverting the buffer.
;;
692 693 694 695 696 697 698 699 700 701 702 703 704 705
;; We do this by reverting immediately in response to the first in a
;; flurry of notifications. Any notifications during the following
;; `auto-revert-lockout-interval' seconds are noted but not acted upon
;; until the end of that interval.

(defconst auto-revert--lockout-interval 2.5
  "Duration, in seconds, of the Auto-Revert Mode notification lockout.
This is the quiescence after each notification of a file being
changed during which no automatic reverting takes place, to
prevent many updates in rapid succession from overwhelming the
system.")

(defvar-local auto-revert--lockout-timer nil
  "Timer awaiting the end of the notification lockout interval, or nil.")
706

707
(defun auto-revert-notify-handler (event)
708
  "Handle an EVENT returned from file notification."
709
  (with-demoted-errors
710 711 712 713
    (let* ((descriptor (car event))
	   (action (nth 1 event))
	   (file (nth 2 event))
	   (file1 (nth 3 event)) ;; Target of `renamed'.
714
	   (buffers (gethash descriptor
715
			     auto-revert--buffers-by-watch-descriptor)))
716 717
      ;; Check, that event is meant for us.
      (cl-assert descriptor)
718 719 720
      ;; Since we watch a directory, a file name must be returned.
      (cl-assert (stringp file))
      (when (eq action 'renamed) (cl-assert (stringp file1)))
721 722
      (when auto-revert-debug
        (message "auto-revert-notify-handler %S" event))
723 724 725

      (if (eq action 'stopped)
          ;; File notification has stopped.  Continue with polling.
726
          (cl-dolist (buffer buffers)
727
            (with-current-buffer buffer
728 729 730 731 732 733 734 735
              (when (or
                     ;; A buffer associated with a file.
                     (and (stringp buffer-file-name)
                          (string-equal
                           (file-name-nondirectory file)
                           (file-name-nondirectory buffer-file-name)))
                     ;; A buffer w/o a file, like dired.
                     (null buffer-file-name))
736 737
                (auto-revert-notify-rm-watch)
                ;; Restart the timer if it wasn't running.
738 739
                (unless auto-revert-timer
                  (auto-revert-set-timer)))))
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764

        ;; Loop over all buffers, in order to find the intended one.
        (cl-dolist (buffer buffers)
          (when (buffer-live-p buffer)
            (with-current-buffer buffer
              (when (or
                     ;; A buffer associated with a file.
                     (and (stringp buffer-file-name)
                          (or
                           (and (memq
                                 action '(attribute-changed changed created))
                                (string-equal
                                 (file-name-nondirectory file)
                                 (file-name-nondirectory buffer-file-name)))
                           (and (eq action 'renamed)
                                (string-equal
                                 (file-name-nondirectory file1)
                                 (file-name-nondirectory buffer-file-name)))))
                     ;; A buffer w/o a file, like dired.
                     (and (null buffer-file-name)
                          (memq action '(created renamed deleted))))
                ;; Mark buffer modified.
                (setq auto-revert-notify-modified-p t)

                ;; Revert the buffer now if we're not locked out.
765
                (unless auto-revert--lockout-timer
766
                  (auto-revert-handler)
767 768 769 770 771 772 773 774 775 776 777 778 779
                  (setq auto-revert--lockout-timer
                        (run-with-timer
                         auto-revert--lockout-interval nil
                         #'auto-revert--end-lockout buffer)))))))))))

(defun auto-revert--end-lockout (buffer)
  "End the lockout period after a notification.
If the buffer needs to be reverted, do it now."
  (when (buffer-live-p buffer)
    (with-current-buffer buffer
      (setq auto-revert--lockout-timer nil)
      (when auto-revert-notify-modified-p
        (auto-revert-handler)))))
780

781
(defun auto-revert-active-p ()
782
  "Check if auto-revert is active in current buffer."
783
  (or auto-revert-mode
784
      auto-revert-tail-mode
785
      auto-revert--global-mode))
786 787

(defun auto-revert-handler ()
788 789
  "Revert current buffer, if appropriate.
This is an internal function used by Auto-Revert Mode."
Michael Albinus's avatar
Michael Albinus committed
790 791 792 793 794 795 796 797 798
  (let* ((buffer (current-buffer)) size
         ;; Tramp caches the file attributes.  Setting
         ;; `remote-file-name-inhibit-cache' forces Tramp to reread
         ;; the values.
         (remote-file-name-inhibit-cache t)
         (revert
          (if buffer-file-name
              (and (or auto-revert-remote-files
                       (not (file-remote-p buffer-file-name)))
799
                   (or (not auto-revert-notify-watch-descriptor)
Michael Albinus's avatar
Michael Albinus committed
800 801 802 803 804
                       auto-revert-notify-modified-p)
                   (if auto-revert-tail-mode
                       (and (file-readable-p buffer-file-name)
                            (/= auto-revert-tail-pos
                                (setq size
Paul Eggert's avatar
Paul Eggert committed
805 806
                                      (file-attribute-size
                                       (file-attributes buffer-file-name)))))
Michael Albinus's avatar
Michael Albinus committed
807 808 809 810 811 812 813 814 815 816 817 818 819
                     (funcall (or buffer-stale-function
                                  #'buffer-stale--default-function)
                              t)))
            (and (or auto-revert-mode
                     global-auto-revert-non-file-buffers)
                 (funcall (or buffer-stale-function
                              #'buffer-stale--default-function)
                          t))))
         eob eoblist)
    (setq auto-revert-notify-modified-p nil)
    (when revert
      (when (and auto-revert-verbose
                 (not (eq revert 'fast)))
820
        (message "Reverting buffer `%s'." (buffer-name)))
Michael Albinus's avatar
Michael Albinus committed
821
      ;; If point (or a window point) is at the end of the buffer, we
822 823
      ;; want to keep it at the end after reverting.  This allows one
      ;; to tail a file.
Michael Albinus's avatar
Michael Albinus committed
824 825 826 827 828 829 830 831 832 833 834 835 836 837
      (when buffer-file-name
        (setq eob (eobp))
        (walk-windows
         (lambda (window)
           (and (eq (window-buffer window) buffer)
                (= (window-point window) (point-max))
                (push window eoblist)))
         'no-mini t))
      (if auto-revert-tail-mode
          (auto-revert-tail-handler size)
        ;; Bind buffer-read-only in case user has done C-x C-q, so as
        ;; not to forget that.  This gives undesirable results when
        ;; the file's mode changes, but that is less common.
        (let ((buffer-read-only buffer-read-only))
Michael Albinus's avatar
Michael Albinus committed
838 839 840 841
          ;; Bug#23276: When the file has been deleted, keep the
          ;; buffer unchanged.
          (ignore-errors
            (revert-buffer 'ignore-auto 'dont-ask 'preserve-modes))))
Michael Albinus's avatar
Michael Albinus committed
842 843 844 845 846 847 848
      (when buffer-file-name
        (when eob (goto-char (point-max)))
        (dolist (window eoblist)
          (set-window-point window (point-max)))))
    ;; `preserve-modes' avoids changing the (minor) modes.  But we do
    ;; want to reset the mode for VC, so we do it manually.
    (when (or revert auto-revert-check-vc-info)
849 850
      (let ((revert-buffer-in-progress-p t))
        (vc-refresh-state)))))
851

852
(defun auto-revert-tail-handler (size)
853
  (let ((modified (buffer-modified-p))
854
	(inhibit-read-only t)		; Ignore.
855
	(file buffer-file-name)
856
	(buffer-file-name nil))		; Ignore that file has changed.
857
    (when (/= auto-revert-tail-pos size)
858
      (run-hooks 'before-revert-hook)
859
      (undo-boundary)
860 861 862 863
      (save-restriction
	(widen)
	(save-excursion
	  (goto-char (point-max))
864 865 866 867
	  (insert-file-contents file nil
				(and (< auto-revert-tail-pos size)
				     auto-revert-tail-pos)
				size)))
868
      (run-hooks 'after-revert-hook)
869
      (undo-boundary)
870
      (setq auto-revert-tail-pos size)
871
      (restore-buffer-modified-p modified)))
872 873
  (set-visited-file-modtime))

Richard M. Stallman's avatar
Richard M. Stallman committed
874 875 876 877 878 879 880 881
(defun auto-revert-buffers ()
  "Revert buffers as specified by Auto-Revert and Global Auto-Revert Mode.

Should `global-auto-revert-mode' be active all file buffers are checked.

Should `auto-revert-mode' be active in some buffers, those buffers
are checked.

882
Non-file buffers that have a custom `revert-buffer-function' and
883
`buffer-stale-function' are reverted either when Auto-Revert
884 885 886
Mode is active in that buffer, or when the variable
`global-auto-revert-non-file-buffers' is non-nil and Global
Auto-Revert Mode is active.
Richard M. Stallman's avatar
Richard M. Stallman committed
887

Dave Love's avatar
Dave Love committed
888
This function stops whenever there is user input.  The buffers not
Richard M. Stallman's avatar
Richard M. Stallman committed
889 890 891 892 893
checked are stored in the variable `auto-revert-remaining-buffers'.

To avoid starvation, the buffers in `auto-revert-remaining-buffers'
are checked first the next time this function is called.

Dave Love's avatar
Dave Love committed
894
This function is also responsible for removing buffers no longer in
895
Auto-Revert Mode from `auto-revert-buffer-list', and for canceling
Richard M. Stallman's avatar
Richard M. Stallman committed
896
the timer when no buffers need to be checked."
897

898
  (save-match-data
899
    (let ((bufs (auto-revert--polled-buffers))
900
	  remaining new)
Michael Albinus's avatar
Michael Albinus committed
901 902 903 904 905
      ;; Buffers with remote contents shall be reverted only if the
      ;; connection is established already.
      (setq bufs (delq nil
                       (mapcar
                        (lambda (buf)
Michael Albinus's avatar
Michael Albinus committed
906 907 908 909 910 911
                          (and (buffer-live-p buf)
                               (with-current-buffer buf
                                 (and
                                  (or (not (file-remote-p default-directory))
                                      (file-remote-p default-directory nil t))
                                      buf))))
Michael Albinus's avatar
Michael Albinus committed
912
                        bufs)))
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
      ;; Partition `bufs' into two halves depending on whether or not
      ;; the buffers are in `auto-revert-remaining-buffers'.  The two
      ;; halves are then re-joined with the "remaining" buffers at the
      ;; head of the list.
      (dolist (buf auto-revert-remaining-buffers)
	(if (memq buf bufs)
	    (push buf remaining)))
      (dolist (buf bufs)
	(if (not (memq buf remaining))
	    (push buf new)))
      (setq bufs (nreverse (nconc new remaining)))
      (while (and bufs
		  (not (and auto-revert-stop-on-user-input
			    (input-pending-p))))
	(let ((buf (car bufs)))
Michael Albinus's avatar
Michael Albinus committed
928
          (if (not (buffer-live-p buf))
Michael Albinus's avatar
Michael Albinus committed
929
              ;; Remove dead buffer from `auto-revert-buffer-list'.
Michael Albinus's avatar
Michael Albinus committed
930 931 932 933 934 935 936 937 938 939 940
              (auto-revert-remove-current-buffer buf)
            (with-current-buffer buf
              ;; Test if someone has turned off Auto-Revert Mode
              ;; in a non-standard way, for example by changing
              ;; major mode.
              (if (and (not auto-revert-mode)
                       (not auto-revert-tail-mode)
                       (memq buf auto-revert-buffer-list))
                  (auto-revert-remove-current-buffer))
              (when (auto-revert-active-p)
                ;; Enable file notification.
941 942
                ;; Don't bother creating a notifier for non-file buffers
                ;; unless it explicitly indicates that this works.
Michael Albinus's avatar
Michael Albinus committed
943
                (when (and auto-revert-use-notify
944 945 946
                           (not auto-revert-notify-watch-descriptor)
                           (or buffer-file-name
                               buffer-auto-revert-by-notification))
Michael Albinus's avatar
Michael Albinus committed
947 948
                  (auto-revert-notify-add-watch))
                (auto-revert-handler)))))
949 950 951
	(setq bufs (cdr bufs)))
      (setq auto-revert-remaining-buffers bufs)
      ;; Check if we should cancel the timer.
952
      (unless (auto-revert--need-polling-p)
953
        (if (timerp auto-revert-timer)
954
            (cancel-timer auto-revert-timer))
955
	(setq auto-revert-timer nil)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
956 957 958 959 960 961 962


;; The end:
(provide 'autorevert)

(run-hooks 'auto-revert-load-hook)

963
;;; autorevert.el ends here