Mercurial > emacs
annotate lisp/autorevert.el @ 54671:237f008115f7
Delete obsolete autoload's and defvar's.
(auto-revert-check-vc-info): New variable.
(auto-revert-vc-cvs-file-version, auto-revert-vc-buffer-p)
(auto-revert-handler-vc): Delete.
(auto-revert-handler): Treat return value `fast' of
buffer-stale-function specially. Check `auto-revert-check-vc-info'.
author | Luc Teirlinck <teirllm@auburn.edu> |
---|---|
date | Thu, 01 Apr 2004 01:34:15 +0000 |
parents | ce6a58ba4c84 |
children | 582d81c73e11 |
rev | line source |
---|---|
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
36992
diff
changeset
|
1 ;;; autorevert.el --- revert buffers when files on disk change |
18597 | 2 |
36992
55fdf25cbb27
(global-auto-revert-non-file-buffers): Remove
Gerd Moellmann <gerd@gnu.org>
parents:
27574
diff
changeset
|
3 ;; Copyright (C) 1997, 1998, 1999, 2001 Free Software Foundation, Inc. |
18597 | 4 |
26673
f649f6c04a54
(auto-revert-buffers): Auto-revert mode was turned
Gerd Moellmann <gerd@gnu.org>
parents:
26097
diff
changeset
|
5 ;; Author: Anders Lindgren <andersl@andersl.com> |
22250
a77d473867b8
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21289
diff
changeset
|
6 ;; Keywords: convenience |
26673
f649f6c04a54
(auto-revert-buffers): Auto-revert mode was turned
Gerd Moellmann <gerd@gnu.org>
parents:
26097
diff
changeset
|
7 ;; Created: 1997-06-01 |
f649f6c04a54
(auto-revert-buffers): Auto-revert mode was turned
Gerd Moellmann <gerd@gnu.org>
parents:
26097
diff
changeset
|
8 ;; Date: 1999-11-30 |
18597 | 9 |
10 ;; This file is part of GNU Emacs. | |
11 | |
12 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 ;; it under the terms of the GNU General Public License as published by | |
14 ;; the Free Software Foundation; either version 2, or (at your option) | |
15 ;; any later version. | |
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 | |
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 ;; Boston, MA 02111-1307, USA. | |
26 | |
27 ;;; Commentary: | |
28 | |
29 ;; Introduction: | |
30 ;; | |
31 ;; Whenever a file that Emacs is editing has been changed by another | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
32 ;; program the user normally has to execute the command `revert-buffer' |
18597 | 33 ;; to load the new content of the file into Emacs. |
34 ;; | |
35 ;; This package contains two minor modes: Global Auto-Revert Mode and | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
36 ;; Auto-Revert Mode. Both modes automatically revert buffers |
18597 | 37 ;; whenever the corresponding files have been changed on disk. |
38 ;; | |
39 ;; Auto-Revert Mode can be activated for individual buffers. | |
40 ;; Global Auto-Revert Mode applies to all file buffers. | |
41 ;; | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
42 ;; Both modes operate by checking the time stamp of all files at |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
43 ;; intervals of `auto-revert-interval'. The default is every five |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
44 ;; seconds. The check is aborted whenever the user actually uses |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
45 ;; Emacs. You should never even notice that this package is active |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
46 ;; (except that your buffers will be reverted, of course). |
18597 | 47 |
48 ;; Usage: | |
49 ;; | |
50 ;; Go to the appropriate buffer and press: | |
51 ;; M-x auto-revert-mode RET | |
52 ;; | |
53 ;; To activate Global Auto-Revert Mode, press: | |
54 ;; M-x global-auto-revert-mode RET | |
55 ;; | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
56 ;; To activate Global Auto-Revert Mode every time Emacs is started |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
57 ;; customise the option `global-auto-revert-mode' or the following |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
58 ;; line could be added to your ~/.emacs: |
18597 | 59 ;; (global-auto-revert-mode 1) |
60 ;; | |
61 ;; The function `turn-on-auto-revert-mode' could be added to any major | |
62 ;; mode hook to activate Auto-Revert Mode for all buffers in that | |
63 ;; mode. For example, the following line will activate Auto-Revert | |
64 ;; Mode in all C mode buffers: | |
65 ;; | |
66 ;; (add-hook 'c-mode-hook 'turn-on-auto-revert-mode) | |
67 | |
68 ;;; Code: | |
69 | |
70 ;; Dependencies: | |
71 | |
72 (require 'timer) | |
53984
73f78af624f2
(auto-revert-dired-file-list): added missing variable `file' to `let'.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53980
diff
changeset
|
73 |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
74 (eval-when-compile (require 'cl)) |
18597 | 75 |
76 | |
77 ;; Custom Group: | |
78 ;; | |
79 ;; The two modes will be placed next to Auto Save Mode under the | |
80 ;; Files group under Emacs. | |
81 | |
82 (defgroup auto-revert nil | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
83 "Revert individual buffers when files on disk change. |
18597 | 84 |
85 Auto-Revert Mode can be activated for individual buffer. | |
86 Global Auto-Revert Mode applies to all buffers." | |
22250
a77d473867b8
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21289
diff
changeset
|
87 :group 'files |
a77d473867b8
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21289
diff
changeset
|
88 :group 'convenience) |
18597 | 89 |
90 | |
91 ;; Variables: | |
92 | |
25215
5d684a6517db
(auto-revert-mode): Add autoload cookie.
Dave Love <fx@gnu.org>
parents:
22388
diff
changeset
|
93 ;; Autoload for the benefit of `make-mode-line-mouse-sensitive'. |
5d684a6517db
(auto-revert-mode): Add autoload cookie.
Dave Love <fx@gnu.org>
parents:
22388
diff
changeset
|
94 ;;;###autoload |
18597 | 95 (defvar auto-revert-mode nil |
96 "*Non-nil when Auto-Revert Mode is active. | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
97 Never set this variable directly, use the command `auto-revert-mode' instead.") |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
98 (put 'auto-revert-mode 'permanent-local t) |
18597 | 99 |
54452
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
100 (defvar auto-revert-timer nil |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
101 "Timer used by Auto-Revert Mode.") |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
102 |
18597 | 103 (defcustom auto-revert-interval 5 |
53379
cd6072a24608
(auto-revert-interval): Doc fix.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52401
diff
changeset
|
104 "Time, in seconds, between Auto-Revert Mode file checks. |
54452
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
105 The value may be an integer or floating point number. |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
106 |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
107 If a timer is already active, there are two ways to make sure |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
108 that the new value will take effect immediately. You can set |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
109 this variable through Custom or you can call the command |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
110 `auto-revert-set-timer' after setting the variable. Otherwise, |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
111 the new value will take effect the first time Auto Revert Mode |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
112 calls `auto-revert-set-timer' for internal reasons or in your |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
113 next editing session." |
18597 | 114 :group 'auto-revert |
54452
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
115 :type 'number |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
116 :set (lambda (variable value) |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
117 (set-default variable value) |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
118 (and (boundp 'auto-revert-timer) |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
119 auto-revert-timer |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
120 (auto-revert-set-timer)))) |
18597 | 121 |
122 (defcustom auto-revert-stop-on-user-input t | |
123 "When non-nil Auto-Revert Mode stops checking files on user input." | |
124 :group 'auto-revert | |
125 :type 'boolean) | |
126 | |
127 (defcustom auto-revert-verbose t | |
128 "When nil, Auto-Revert Mode will not generate any messages. | |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
129 When non-nil, a message is generated whenever a file is reverted." |
18597 | 130 :group 'auto-revert |
131 :type 'boolean) | |
132 | |
133 (defcustom auto-revert-mode-text " ARev" | |
134 "String to display in the mode line when Auto-Revert Mode is active. | |
135 | |
136 \(When the string is not empty, make sure that it has a leading space.)" | |
137 :tag "Auto Revert Mode Text" ; To separate it from `global-...' | |
138 :group 'auto-revert | |
139 :type 'string) | |
140 | |
141 (defcustom auto-revert-mode-hook nil | |
142 "Functions to run when Auto-Revert Mode is activated." | |
143 :tag "Auto Revert Mode Hook" ; To separate it from `global-...' | |
144 :group 'auto-revert | |
145 :type 'hook) | |
146 | |
147 (defcustom global-auto-revert-mode-text "" | |
148 "String to display when Global Auto-Revert Mode is active. | |
149 | |
150 The default is nothing since when this mode is active this text doesn't | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
151 vary over time, or between buffers. Hence mode line text |
18597 | 152 would only waste precious space." |
153 :group 'auto-revert | |
154 :type 'string) | |
155 | |
156 (defcustom global-auto-revert-mode-hook nil | |
157 "Hook called when Global Auto-Revert Mode is activated." | |
158 :group 'auto-revert | |
159 :type 'hook) | |
160 | |
161 (defcustom global-auto-revert-non-file-buffers nil | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
162 "When nil only file buffers are reverted by Global Auto-Revert Mode. |
18597 | 163 |
164 When non-nil, both file buffers and buffers with a custom | |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
165 `revert-buffer-function' and a `buffer-stale-function' are |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
166 reverted by Global Auto-Revert Mode. |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
167 |
54513
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
168 Use this option with care since it could lead to excessive reverts. |
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
169 Note also that for some non-file buffers the check whether the |
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
170 buffer needs updating may be imperfect, due to efficiency |
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
171 considerations, and may not take all information listed in the |
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
172 buffer into account. Hence, a non-nil value for this option does |
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
173 not necessarily make manual updates useless for non-file buffers." |
18597 | 174 :group 'auto-revert |
175 :type 'boolean) | |
176 | |
177 (defcustom global-auto-revert-ignore-modes '() | |
178 "List of major modes Global Auto-Revert Mode should not check." | |
179 :group 'auto-revert | |
180 :type '(repeat sexp)) | |
181 | |
182 (defcustom auto-revert-load-hook nil | |
183 "Functions to run when Auto-Revert Mode is first loaded." | |
184 :tag "Load Hook" | |
185 :group 'auto-revert | |
186 :type 'hook) | |
187 | |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
188 (defcustom auto-revert-check-vc-info nil |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
189 "If non-nil Auto Revert Mode reliably updates version control info. |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
190 Auto Revert Mode updates version control info whenever the buffer |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
191 needs reverting, regardless of the value of this variable. |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
192 However, the version control state can change without changes to |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
193 the work file. If the change is made from the current Emacs |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
194 session, all info is updated. But if, for instance, a new |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
195 version is checked in from outside the current Emacs session, the |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
196 version control number in the mode line, as well as other version |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
197 control related information, may not be properly updated. If you |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
198 are worried about this, set this variable to a non-nil value. |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
199 |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
200 This currently works by automatically updating the version |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
201 control info every `auto-revert-interval' seconds. Nevertheless, |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
202 it should not cause excessive CPU usage on a reasonably fast |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
203 machine, if it does not apply to too many version controlled |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
204 buffers. CPU usage depends on the version control system" |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
205 :group 'auto-revert |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
206 :type 'boolean |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
207 :version "21.4") |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
208 |
18597 | 209 (defvar global-auto-revert-ignore-buffer nil |
20648
b644667dcd19
(global-auto-revert-ignore-buffer): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
18597
diff
changeset
|
210 "*When non-nil, Global Auto-Revert Mode will not revert this buffer. |
18597 | 211 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
212 This variable becomes buffer local when set in any fashion.") |
18597 | 213 (make-variable-buffer-local 'global-auto-revert-ignore-buffer) |
214 | |
215 ;; Internal variables: | |
216 | |
217 (defvar auto-revert-buffer-list '() | |
218 "List of buffers in Auto-Revert Mode. | |
219 | |
220 Note that only Auto-Revert Mode, never Global Auto-Revert Mode, adds | |
221 buffers to this list. | |
222 | |
223 The timer function `auto-revert-buffers' is responsible for purging | |
224 the list of old buffers.") | |
225 | |
226 (defvar auto-revert-remaining-buffers '() | |
227 "Buffers not checked when user input stopped execution.") | |
228 | |
229 | |
230 ;; Functions: | |
231 | |
232 ;;;###autoload | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
233 (define-minor-mode auto-revert-mode |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
234 "Toggle reverting buffer when file on disk changes. |
18597 | 235 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
236 With arg, turn Auto Revert mode on if and only if arg is positive. |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
237 This is a minor mode that affects only the current buffer. |
18597 | 238 Use `global-auto-revert-mode' to automatically revert all buffers." |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
239 nil auto-revert-mode-text nil |
18597 | 240 (if auto-revert-mode |
241 (if (not (memq (current-buffer) auto-revert-buffer-list)) | |
242 (push (current-buffer) auto-revert-buffer-list)) | |
243 (setq auto-revert-buffer-list | |
244 (delq (current-buffer) auto-revert-buffer-list))) | |
245 (auto-revert-set-timer) | |
246 (when auto-revert-mode | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
247 (auto-revert-buffers))) |
18597 | 248 |
249 | |
250 ;;;###autoload | |
251 (defun turn-on-auto-revert-mode () | |
252 "Turn on Auto-Revert Mode. | |
253 | |
254 This function is designed to be added to hooks, for example: | |
255 (add-hook 'c-mode-hook 'turn-on-auto-revert-mode)" | |
256 (auto-revert-mode 1)) | |
257 | |
258 | |
259 ;;;###autoload | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
260 (define-minor-mode global-auto-revert-mode |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
261 "Revert any buffer when file on disk changes. |
18597 | 262 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
263 With arg, turn Auto Revert mode on globally if and only if arg is positive. |
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
264 This is a minor mode that affects all buffers. |
18597 | 265 Use `auto-revert-mode' to revert a particular buffer." |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
266 :global t :group 'auto-revert :lighter global-auto-revert-mode-text |
18597 | 267 (auto-revert-set-timer) |
268 (when global-auto-revert-mode | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
269 (auto-revert-buffers))) |
18597 | 270 |
271 | |
272 (defun auto-revert-set-timer () | |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
273 "Restart or cancel the timer used by Auto-Revert Mode. |
54612
ce6a58ba4c84
(auto-revert-set-timer): Minor doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54609
diff
changeset
|
274 If such a timer is active, cancel it. Start a new timer if |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
275 Global Auto-Revert Mode is active or if Auto-Revert Mode is active |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
276 in some buffer. Restarting the timer ensures that Auto-Revert Mode |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
277 will use an up-to-date value of `auto-revert-interval'" |
54452
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
278 (interactive) |
18597 | 279 (if (timerp auto-revert-timer) |
280 (cancel-timer auto-revert-timer)) | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
281 (setq auto-revert-timer |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
282 (if (or global-auto-revert-mode auto-revert-buffer-list) |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
283 (run-with-timer auto-revert-interval |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
284 auto-revert-interval |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
285 'auto-revert-buffers) |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
286 nil))) |
18597 | 287 |
53980
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
288 (defun auto-revert-active-p () |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
289 "Check if auto-revert is active (in current buffer or globally)." |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
290 (or auto-revert-mode |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
291 (and |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
292 global-auto-revert-mode |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
293 (not global-auto-revert-ignore-buffer) |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
294 (not (memq major-mode |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
295 global-auto-revert-ignore-modes))))) |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
296 |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
297 (defun auto-revert-handler () |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
298 "Revert current buffer, if appropriate. |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
299 This is an internal function used by Auto-Revert Mode." |
54513
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
300 (unless (buffer-modified-p) |
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
301 (let (revert) |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
302 (or (and (buffer-file-name) |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
303 (file-readable-p (buffer-file-name)) |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
304 (not (verify-visited-file-modtime (current-buffer))) |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
305 (setq revert t)) |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
306 (and (or auto-revert-mode global-auto-revert-non-file-buffers) |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
307 revert-buffer-function |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
308 (boundp 'buffer-stale-function) |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
309 (functionp buffer-stale-function) |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
310 (setq revert (funcall buffer-stale-function t)))) |
54513
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
311 (when revert |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
312 (when (and auto-revert-verbose |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
313 (not (eq revert 'fast))) |
54592
6a2022999abf
(auto-revert-handler): Print revert message before, rather than after,
Luc Teirlinck <teirllm@auburn.edu>
parents:
54513
diff
changeset
|
314 (message "Reverting buffer `%s'." (buffer-name))) |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
315 (revert-buffer 'ignore-auto 'dont-ask 'preserve-modes)) |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
316 ;; `preserve-modes' avoids changing the (minor) modes. But we |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
317 ;; do want to reset the mode for VC, so we do it manually. |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
318 (when (or revert auto-revert-check-vc-info) |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
319 (vc-find-file-hook))))) |
53980
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
320 |
18597 | 321 (defun auto-revert-buffers () |
322 "Revert buffers as specified by Auto-Revert and Global Auto-Revert Mode. | |
323 | |
324 Should `global-auto-revert-mode' be active all file buffers are checked. | |
325 | |
326 Should `auto-revert-mode' be active in some buffers, those buffers | |
327 are checked. | |
328 | |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
329 Non-file buffers that have a custom `revert-buffer-function' and |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
330 a `buffer-stale-function' are reverted either when Auto-Revert |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
331 Mode is active in that buffer, or when the variable |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
332 `global-auto-revert-non-file-buffers' is non-nil and Global |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
333 Auto-Revert Mode is active. |
18597 | 334 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
335 This function stops whenever there is user input. The buffers not |
18597 | 336 checked are stored in the variable `auto-revert-remaining-buffers'. |
337 | |
338 To avoid starvation, the buffers in `auto-revert-remaining-buffers' | |
339 are checked first the next time this function is called. | |
340 | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
341 This function is also responsible for removing buffers no longer in |
18597 | 342 Auto-Revert mode from `auto-revert-buffer-list', and for canceling |
343 the timer when no buffers need to be checked." | |
344 (let ((bufs (if global-auto-revert-mode | |
345 (buffer-list) | |
346 auto-revert-buffer-list)) | |
347 (remaining '()) | |
348 (new '())) | |
349 ;; Partition `bufs' into two halves depending on whether or not | |
350 ;; the buffers are in `auto-revert-remaining-buffers'. The two | |
351 ;; halves are then re-joined with the "remaining" buffers at the | |
352 ;; head of the list. | |
353 (dolist (buf auto-revert-remaining-buffers) | |
354 (if (memq buf bufs) | |
355 (push buf remaining))) | |
356 (dolist (buf bufs) | |
357 (if (not (memq buf remaining)) | |
358 (push buf new))) | |
359 (setq bufs (nreverse (nconc new remaining))) | |
360 (while (and bufs | |
361 (not (and auto-revert-stop-on-user-input | |
362 (input-pending-p)))) | |
363 (let ((buf (car bufs))) | |
364 (if (buffer-name buf) ; Buffer still alive? | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
365 (with-current-buffer buf |
18597 | 366 ;; Test if someone has turned off Auto-Revert Mode in a |
367 ;; non-standard way, for example by changing major mode. | |
368 (if (and (not auto-revert-mode) | |
369 (memq buf auto-revert-buffer-list)) | |
370 (setq auto-revert-buffer-list | |
371 (delq buf auto-revert-buffer-list))) | |
54606
959316c3db53
(auto-revert-handler): Handle auto-revert-mode.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54592
diff
changeset
|
372 (when (auto-revert-active-p) (auto-revert-handler))) |
18597 | 373 ;; Remove dead buffer from `auto-revert-buffer-list'. |
374 (setq auto-revert-buffer-list | |
375 (delq buf auto-revert-buffer-list)))) | |
376 (setq bufs (cdr bufs))) | |
377 (setq auto-revert-remaining-buffers bufs) | |
378 ;; Check if we should cancel the timer. | |
379 (when (and (not global-auto-revert-mode) | |
380 (null auto-revert-buffer-list)) | |
381 (cancel-timer auto-revert-timer) | |
382 (setq auto-revert-timer nil)))) | |
383 | |
384 | |
385 ;; The end: | |
386 (provide 'autorevert) | |
387 | |
388 (run-hooks 'auto-revert-load-hook) | |
389 | |
52401 | 390 ;;; arch-tag: f6bcb07b-4841-477e-9e44-b18678e58876 |
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
36992
diff
changeset
|
391 ;;; autorevert.el ends here |