autorevert.el 31.5 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-2016 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 <http://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
;; If Emacs is compiled with file notification support, notifications
;; are used instead of checking the time stamp of the files.  You can
56
;; disable this by setting the user option `auto-revert-use-notify' to
57 58 59
;; nil.  Alternatively, a regular expression of directories to be
;; excluded from file notifications can be specified by
;; `auto-revert-notify-exclude-dir-regexp'.
60
;;
61 62 63 64 65 66 67 68 69 70
;; After reverting a file buffer, Auto Revert Mode normally puts point
;; 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
;; selected.  This way, you can use Auto Revert Mode to `tail' a file.
;; 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.
71 72 73 74 75 76 77
;;
;; 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
;; 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
78 79 80

;; Usage:
;;
81
;; Go to the appropriate buffer and press either of:
Richard M. Stallman's avatar
Richard M. Stallman committed
82
;;   M-x auto-revert-mode RET
83
;;   M-x auto-revert-tail-mode RET
Richard M. Stallman's avatar
Richard M. Stallman committed
84 85 86 87
;;
;; To activate Global Auto-Revert Mode, press:
;;   M-x global-auto-revert-mode RET
;;
Dave Love's avatar
Dave Love committed
88
;; To activate Global Auto-Revert Mode every time Emacs is started
Paul Eggert's avatar
Paul Eggert committed
89
;; customize the option `global-auto-revert-mode' or the following
Dave Love's avatar
Dave Love committed
90
;; line could be added to your ~/.emacs:
Richard M. Stallman's avatar
Richard M. Stallman committed
91 92 93 94 95 96 97
;;   (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:
;;
98
;; (add-hook 'c-mode-hook #'turn-on-auto-revert-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
99 100 101 102 103

;;; Code:

;; Dependencies:

104
(eval-when-compile (require 'cl-lib))
Richard M. Stallman's avatar
Richard M. Stallman committed
105
(require 'timer)
106
(require 'filenotify)
107

Richard M. Stallman's avatar
Richard M. Stallman committed
108 109 110 111 112 113
;; 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
114
  "Revert individual buffers when files on disk change.
115 116
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
117 118
  :group 'files
  :group 'convenience)
Richard M. Stallman's avatar
Richard M. Stallman committed
119 120 121 122


;; Variables:

123 124
;;; What's this?: ;; Autoload for the benefit of `make-mode-line-mouse-sensitive'.
;;; What's this?: ;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
125
(defvar auto-revert-mode nil
Glenn Morris's avatar
Glenn Morris committed
126
  "Non-nil when Auto-Revert Mode is active.
127 128
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
129

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

136 137 138
(defvar auto-revert-timer nil
  "Timer used by Auto-Revert Mode.")

Richard M. Stallman's avatar
Richard M. Stallman committed
139
(defcustom auto-revert-interval 5
140
  "Time, in seconds, between Auto-Revert Mode file checks.
141 142 143 144 145 146 147 148 149
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,
the new value will take effect the first time Auto Revert Mode
calls `auto-revert-set-timer' for internal reasons or in your
next editing session."
Richard M. Stallman's avatar
Richard M. Stallman committed
150
  :group 'auto-revert
151 152 153 154 155 156
  :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
157 158

(defcustom auto-revert-stop-on-user-input t
159
  "When non-nil, user input temporarily interrupts Auto-Revert Mode.
160
With this setting, Auto-Revert Mode checks for user input after
161 162 163 164
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.
165
Thus, with this setting, Emacs might be non-responsive at times."
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167 168 169
  :group 'auto-revert
  :type 'boolean)

(defcustom auto-revert-verbose t
170
  "When nil, Auto-Revert Mode does not generate any messages.
Michael Albinus's avatar
Michael Albinus committed
171
When non-nil, a message is generated whenever a buffer is reverted."
Richard M. Stallman's avatar
Richard M. Stallman committed
172 173 174 175 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.)"
  :tag "Auto Revert Mode Text"		; To separate it from `global-...'
  :group 'auto-revert
  :type 'string)

183 184 185 186 187
(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
188
  :type 'string
189
  :version "22.1")
190

Richard M. Stallman's avatar
Richard M. Stallman committed
191 192 193 194 195 196 197 198 199 200
(defcustom auto-revert-mode-hook nil
  "Functions to run when Auto-Revert Mode is activated."
  :tag "Auto Revert Mode Hook"		; To separate it from `global-...'
  :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
201
vary over time, or between buffers.  Hence mode line text
Richard M. Stallman's avatar
Richard M. Stallman committed
202 203 204 205 206 207 208 209 210 211
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
212
  "When nil, Global Auto-Revert mode operates only on file-visiting buffers.
Richard M. Stallman's avatar
Richard M. Stallman committed
213 214

When non-nil, both file buffers and buffers with a custom
215
`revert-buffer-function' and a `buffer-stale-function' are
216
reverted by Global Auto-Revert mode.  These include the Buffer
217 218 219 220 221 222 223
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.
224

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

231
(defcustom global-auto-revert-ignore-modes ()
Richard M. Stallman's avatar
Richard M. Stallman committed
232 233 234 235 236 237 238 239 240 241
  "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)

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
(defcustom auto-revert-check-vc-info nil
  "If non-nil Auto Revert Mode reliably updates version control info.
Auto Revert Mode updates version control info whenever the buffer
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
258
buffers.  CPU usage depends on the version control system."
259 260
  :group 'auto-revert
  :type 'boolean
261
  :version "22.1")
262

263
(defvar-local global-auto-revert-ignore-buffer nil
Glenn Morris's avatar
Glenn Morris committed
264
  "When non-nil, Global Auto-Revert Mode will not revert this buffer.
Dave Love's avatar
Dave Love committed
265
This variable becomes buffer local when set in any fashion.")
Richard M. Stallman's avatar
Richard M. Stallman committed
266

267 268 269 270 271 272
(defcustom auto-revert-remote-files nil
  "If non-nil remote files are also reverted."
  :group 'auto-revert
  :type 'boolean
  :version "24.4")

273
(defcustom auto-revert-use-notify t
274
  "If non-nil Auto Revert Mode uses file notification functions.
275
You should set this variable through Custom."
276 277 278
  :group 'auto-revert
  :type 'boolean
  :set (lambda (variable value)
279
	 (set-default variable value)
280
	 (unless (symbol-value variable)
281 282 283 284
	   (dolist (buf (buffer-list))
	     (with-current-buffer buf
	       (when (symbol-value 'auto-revert-notify-watch-descriptor)
		 (auto-revert-notify-rm-watch))))))
285
  :initialize 'custom-initialize-default
286 287
  :version "24.4")

288 289 290 291 292 293 294 295 296 297 298
(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")

Richard M. Stallman's avatar
Richard M. Stallman committed
299 300
;; Internal variables:

301
(defvar auto-revert-buffer-list ()
Richard M. Stallman's avatar
Richard M. Stallman committed
302 303 304 305 306 307 308 309
  "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.")

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

313 314 315 316
(defvar auto-revert-tail-pos 0
  "Position of last known end of file.")

(add-hook 'find-file-hook
317 318 319
	  (lambda ()
	    (setq-local auto-revert-tail-pos
                        (nth 7 (file-attributes buffer-file-name)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
320

321 322 323
(defvar auto-revert-notify-watch-descriptor-hash-list
  (make-hash-table :test 'equal)
  "A hash table collecting all file watch descriptors.
324 325 326
Hash key is a watch descriptor, hash value is a list of buffers
which are related to files being watched and carrying the same
default directory.")
327

328
(defvar-local auto-revert-notify-watch-descriptor nil
329
  "The file watch descriptor active for the current buffer.")
330
(put 'auto-revert-notify-watch-descriptor 'permanent-local t)
331

332
(defvar-local auto-revert-notify-modified-p nil
333
  "Non-nil when file has been modified on the file system.
334
This has been reported by a file notification event.")
335

Richard M. Stallman's avatar
Richard M. Stallman committed
336 337 338
;; Functions:

;;;###autoload
339
(define-minor-mode auto-revert-mode
340 341 342 343 344 345 346 347
  "Toggle reverting buffer when the file changes (Auto Revert mode).
With a prefix argument ARG, enable Auto Revert mode if ARG is
positive, and disable it otherwise.  If called from Lisp, enable
the mode if ARG is omitted or nil.

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

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

352 353 354
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."
355
  :group 'auto-revert :lighter auto-revert-mode-text
Richard M. Stallman's avatar
Richard M. Stallman committed
356 357 358
  (if auto-revert-mode
      (if (not (memq (current-buffer) auto-revert-buffer-list))
	  (push (current-buffer) auto-revert-buffer-list))
359
    (when auto-revert-use-notify (auto-revert-notify-rm-watch))
Richard M. Stallman's avatar
Richard M. Stallman committed
360 361 362 363
    (setq auto-revert-buffer-list
	  (delq (current-buffer) auto-revert-buffer-list)))
  (auto-revert-set-timer)
  (when auto-revert-mode
364 365
    (auto-revert-buffers)
    (setq auto-revert-tail-mode nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
366 367 368 369 370 371 372


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

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


377 378
;;;###autoload
(define-minor-mode auto-revert-tail-mode
379 380 381 382
  "Toggle reverting tail of buffer when the file grows.
With a prefix argument ARG, enable Auto-Revert Tail mode if ARG
is positive, and disable it otherwise.  If called from Lisp,
enable the mode if ARG is omitted or nil.
383

384 385 386 387 388
When Auto Revert Tail mode is enabled, the tail of the file is
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.
389 390 391 392 393

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
394 395 396
When a buffer is reverted, a message is generated.  This can be
suppressed by setting `auto-revert-verbose' to nil.

397 398 399 400 401 402 403
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)
404
	     (zerop auto-revert-tail-pos) ; library was loaded only after finding file
405 406
	     (not (y-or-n-p "Buffer is modified, so tail offset may be wrong.  Proceed? ")))
	(auto-revert-tail-mode 0)
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
      ;; 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.
422
           (auto-revert-buffers))
423 424 425
      ;; 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
426 427
	  (setq-local auto-revert-tail-pos
                      (nth 7 (file-attributes buffer-file-name))))
428 429 430 431 432 433 434 435 436
      ;; 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 ()
437
  "Turn on Auto-Revert Tail mode.
438 439

This function is designed to be added to hooks, for example:
440
  (add-hook \\='my-logfile-mode-hook #\\='turn-on-auto-revert-tail-mode)"
441 442 443
  (auto-revert-tail-mode 1))


Richard M. Stallman's avatar
Richard M. Stallman committed
444
;;;###autoload
445
(define-minor-mode global-auto-revert-mode
446
  "Toggle Global Auto Revert mode.
447 448 449
With a prefix argument ARG, enable Global Auto Revert mode if ARG
is positive, and disable it otherwise.  If called from Lisp,
enable the mode if ARG is omitted or nil.
450

451 452 453
Global Auto Revert mode is a global minor mode that reverts any
buffer associated with a file when the file changes on disk.  Use
`auto-revert-mode' to revert a particular buffer.
454 455 456 457 458 459 460

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
non-nil vale of `global-auto-revert-ignore-buffer'.

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

464 465 466
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."
467
  :global t :group 'auto-revert :lighter global-auto-revert-mode-text
Richard M. Stallman's avatar
Richard M. Stallman committed
468
  (auto-revert-set-timer)
469
  (if global-auto-revert-mode
470
      (progn
471 472
        ;; Disable file notification because it could use too many resources.
        ;; See Bug#22814.
473 474
        (setq auto-revert-use-notify nil)
        (auto-revert-buffers))
475 476 477
    (dolist (buf (buffer-list))
      (with-current-buffer buf
	(when auto-revert-use-notify
478
	  (auto-revert-notify-rm-watch))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
479 480

(defun auto-revert-set-timer ()
481
  "Restart or cancel the timer used by Auto-Revert Mode.
482
If such a timer is active, cancel it.  Start a new timer if
483 484 485
Global Auto-Revert Mode is active or if Auto-Revert Mode is active
in some buffer.  Restarting the timer ensures that Auto-Revert Mode
will use an up-to-date value of `auto-revert-interval'"
486
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
487 488
  (if (timerp auto-revert-timer)
      (cancel-timer auto-revert-timer))
489 490 491 492
  (setq auto-revert-timer
	(if (or global-auto-revert-mode auto-revert-buffer-list)
	    (run-with-timer auto-revert-interval
			    auto-revert-interval
493
			    'auto-revert-buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
494

495
(defun auto-revert-notify-rm-watch ()
496
  "Disable file notification for current buffer's associated file."
497
  (when auto-revert-notify-watch-descriptor
498 499 500 501 502 503 504 505
    (maphash
     (lambda (key value)
       (when (equal key auto-revert-notify-watch-descriptor)
	 (setq value (delete (current-buffer) value))
	 (if value
	     (puthash key value auto-revert-notify-watch-descriptor-hash-list)
	   (remhash key auto-revert-notify-watch-descriptor-hash-list)
	   (ignore-errors
506
	     (file-notify-rm-watch auto-revert-notify-watch-descriptor)))))
507
     auto-revert-notify-watch-descriptor-hash-list)
508
    (remove-hook 'kill-buffer-hook #'auto-revert-notify-rm-watch))
509 510 511 512
  (setq auto-revert-notify-watch-descriptor nil
	auto-revert-notify-modified-p nil))

(defun auto-revert-notify-add-watch ()
513
  "Enable file notification for current buffer's associated file."
514 515
  ;; We can assume that `buffer-file-name' and
  ;; `auto-revert-use-notify' are non-nil.
516 517 518 519
  (if (or (string-match auto-revert-notify-exclude-dir-regexp
			(expand-file-name default-directory))
	  (file-symlink-p (or buffer-file-name default-directory)))

520
      ;; Fallback to file checks.
521
      (setq-local auto-revert-use-notify nil)
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542

    (when (not auto-revert-notify-watch-descriptor)
      (setq auto-revert-notify-watch-descriptor
	    (ignore-errors
	      (if buffer-file-name
		  (file-notify-add-watch
		   (expand-file-name buffer-file-name default-directory)
		   '(change attribute-change)
		   'auto-revert-notify-handler)
		(file-notify-add-watch
		 (expand-file-name default-directory)
		 '(change)
		 'auto-revert-notify-handler))))
      (if auto-revert-notify-watch-descriptor
	  (progn
	    (puthash
	     auto-revert-notify-watch-descriptor
	     (cons (current-buffer)
		   (gethash auto-revert-notify-watch-descriptor
			    auto-revert-notify-watch-descriptor-hash-list))
	     auto-revert-notify-watch-descriptor-hash-list)
543 544
	    (add-hook 'kill-buffer-hook
		      #'auto-revert-notify-rm-watch nil t))
545
	;; Fallback to file checks.
546
	(setq-local auto-revert-use-notify nil)))))
547

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
;; 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.
;;
;; We do this by reverting immediately in response to the first in a flurry of
;; notifications. We suppress subsequent notifications until the next time
;; `auto-revert-buffers' is called (this happens on a timer with a period set by
;; `auto-revert-interval').
(defvar auto-revert-buffers-counter 1
  "Incremented each time `auto-revert-buffers' is called")
(defvar-local auto-revert-buffers-counter-lockedout 0
  "Buffer-local value to indicate whether we should immediately
update the buffer on a notification event or not. If

  (= auto-revert-buffers-counter-lockedout
     auto-revert-buffers-counter)

then the updates are locked out, and we wait until the next call
of `auto-revert-buffers' to revert the buffer. If no lockout is
present, then we revert immediately and set the lockout, so that
no more reverts are possible until the next call of
`auto-revert-buffers'")

572
(defun auto-revert-notify-handler (event)
573
  "Handle an EVENT returned from file notification."
574
  (with-demoted-errors
575 576 577 578
    (let* ((descriptor (car event))
	   (action (nth 1 event))
	   (file (nth 2 event))
	   (file1 (nth 3 event)) ;; Target of `renamed'.
579 580
	   (buffers (gethash descriptor
			     auto-revert-notify-watch-descriptor-hash-list)))
581 582
      ;; Check, that event is meant for us.
      (cl-assert descriptor)
583 584 585
      ;; Since we watch a directory, a file name must be returned.
      (cl-assert (stringp file))
      (when (eq action 'renamed) (cl-assert (stringp file1)))
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633

      (if (eq action 'stopped)
          ;; File notification has stopped.  Continue with polling.
          (cl-dolist (buffer buffers)
            (with-current-buffer buffer
              (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))
                (auto-revert-notify-rm-watch)
                (setq-local auto-revert-use-notify nil))))

        ;; 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.
                (when (/= auto-revert-buffers-counter-lockedout
                          auto-revert-buffers-counter)
                  (auto-revert-handler)
                  (setq auto-revert-buffers-counter-lockedout
                        auto-revert-buffers-counter))

                ;; No need to check other buffers.
                (cl-return)))))))))
634

635 636 637
(defun auto-revert-active-p ()
  "Check if auto-revert is active (in current buffer or globally)."
  (or auto-revert-mode
638
      auto-revert-tail-mode
639 640 641 642 643 644 645
      (and
       global-auto-revert-mode
       (not global-auto-revert-ignore-buffer)
       (not (memq major-mode
		  global-auto-revert-ignore-modes)))))

(defun auto-revert-handler ()
646 647
  "Revert current buffer, if appropriate.
This is an internal function used by Auto-Revert Mode."
Michael Albinus's avatar
Michael Albinus committed
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
  (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)))
                   (or (not auto-revert-use-notify)
                       auto-revert-notify-modified-p)
                   (if auto-revert-tail-mode
                       (and (file-readable-p buffer-file-name)
                            (/= auto-revert-tail-pos
                                (setq size
                                      (nth 7 (file-attributes
                                              buffer-file-name)))))
                     (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)))
        (message "Reverting buffer `%s'." (buffer-name)))
      ;; If point (or a window point) is at the end of the buffer, we
680 681
      ;; want to keep it at the end after reverting.  This allows one
      ;; to tail a file.
Michael Albinus's avatar
Michael Albinus committed
682 683 684 685 686 687 688 689 690 691 692 693 694 695
      (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
696 697 698 699
          ;; 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
700 701 702 703 704 705 706
      (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)
707
      (vc-refresh-state))))
708

709
(defun auto-revert-tail-handler (size)
710
  (let ((modified (buffer-modified-p))
711
	(inhibit-read-only t)		; Ignore.
712
	(file buffer-file-name)
713
	(buffer-file-name nil))		; Ignore that file has changed.
714
    (when (/= auto-revert-tail-pos size)
715
      (run-hooks 'before-revert-hook)
716
      (undo-boundary)
717 718 719 720
      (save-restriction
	(widen)
	(save-excursion
	  (goto-char (point-max))
721 722 723 724
	  (insert-file-contents file nil
				(and (< auto-revert-tail-pos size)
				     auto-revert-tail-pos)
				size)))
725
      (run-hooks 'after-revert-hook)
726
      (undo-boundary)
727
      (setq auto-revert-tail-pos size)
728
      (restore-buffer-modified-p modified)))
729 730
  (set-visited-file-modtime))

Richard M. Stallman's avatar
Richard M. Stallman committed
731 732 733 734 735 736 737 738
(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.

739
Non-file buffers that have a custom `revert-buffer-function' and
740
`buffer-stale-function' are reverted either when Auto-Revert
741 742 743
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
744

Dave Love's avatar
Dave Love committed
745
This function stops whenever there is user input.  The buffers not
Richard M. Stallman's avatar
Richard M. Stallman committed
746 747 748 749 750
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
751
This function is also responsible for removing buffers no longer in
Richard M. Stallman's avatar
Richard M. Stallman committed
752 753
Auto-Revert mode from `auto-revert-buffer-list', and for canceling
the timer when no buffers need to be checked."
754 755 756 757

  (setq auto-revert-buffers-counter
        (1+ auto-revert-buffers-counter))

758 759 760 761
  (save-match-data
    (let ((bufs (if global-auto-revert-mode
		    (buffer-list)
		  auto-revert-buffer-list))
762
	  remaining new)
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
      ;; 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)))
778
          (if (buffer-live-p buf)
779 780 781 782 783 784 785 786
	      (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))
		    (setq auto-revert-buffer-list
			  (delq buf auto-revert-buffer-list)))
787
		(when (auto-revert-active-p)
788
		  ;; Enable file notification.
789
		  (when (and auto-revert-use-notify
790 791
			     (not auto-revert-notify-watch-descriptor))
		    (auto-revert-notify-add-watch))
792
		  (auto-revert-handler)))
793 794 795 796 797 798 799 800 801 802
	    ;; Remove dead buffer from `auto-revert-buffer-list'.
	    (setq auto-revert-buffer-list
		  (delq buf auto-revert-buffer-list))))
	(setq bufs (cdr bufs)))
      (setq auto-revert-remaining-buffers bufs)
      ;; Check if we should cancel the timer.
      (when (and (not global-auto-revert-mode)
		 (null auto-revert-buffer-list))
	(cancel-timer auto-revert-timer)
	(setq auto-revert-timer nil)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
803 804 805 806 807 808 809


;; The end:
(provide 'autorevert)

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

810
;;; autorevert.el ends here