Mercurial > emacs
annotate lisp/autorevert.el @ 57982:641cb7192482
Don't call define-fringe-bitmap if the display doesn't support images.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sat, 06 Nov 2004 16:07:10 +0000 |
parents | ab671a8f1ce3 |
children | a5d9000cf1cd e24e2e78deda |
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 |
56516 | 3 ;; Copyright (C) 1997, 1998, 1999, 2001, 2004 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 |
56463
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
37 ;; whenever the corresponding files have been changed on disk and the |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
38 ;; buffer contains no unsaved changes. |
18597 | 39 ;; |
55867
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
40 ;; Auto-Revert Mode can be activated for individual buffers. Global |
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
41 ;; Auto-Revert Mode applies to all file buffers. (If the user option |
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
42 ;; `global-auto-revert-non-file-buffers' is non-nil, it also applies |
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
43 ;; to some non-file buffers. This option is disabled by default.) |
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
44 ;; Since checking a remote file is too slow, these modes do not check |
5514ad802f6b
Update `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
55779
diff
changeset
|
45 ;; or revert remote files. |
18597 | 46 ;; |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
47 ;; 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
|
48 ;; 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
|
49 ;; 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
|
50 ;; 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
|
51 ;; (except that your buffers will be reverted, of course). |
54709
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
52 ;; |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
53 ;; After reverting a file buffer, Auto Revert Mode normally puts point |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
54 ;; at the same position that a regular manual revert would. However, |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
55 ;; there is one exception to this rule. If point is at the end of the |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
56 ;; buffer before reverting, it stays at the end. Similarly if point |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
57 ;; is displayed at the end of a file buffer in any window, it will stay |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
58 ;; at the end of the buffer in that window, even if the window is not |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
59 ;; selected. This way, you can use Auto Revert Mode to `tail' a file. |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
60 ;; Just put point at the end of the buffer and it will stay there. |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
61 ;; These rules apply to file buffers. For non-file buffers, the |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
62 ;; behavior may be mode dependent. |
56463
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
63 ;; |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
64 ;; While you can use Auto Revert Mode to tail a file, this package |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
65 ;; contains a third minor mode, Auto Revert Tail Mode, which does so |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
66 ;; more efficiently, as long as you are sure that the file will only |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
67 ;; change by growing at the end. It only appends the new output, |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
68 ;; instead of reverting the entire buffer. It does so even if the |
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
69 ;; buffer contains unsaved changes. (Because they will not be lost.) |
18597 | 70 |
71 ;; Usage: | |
72 ;; | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
73 ;; Go to the appropriate buffer and press either of: |
18597 | 74 ;; M-x auto-revert-mode RET |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
75 ;; M-x auto-revert-tail-mode RET |
18597 | 76 ;; |
77 ;; To activate Global Auto-Revert Mode, press: | |
78 ;; M-x global-auto-revert-mode RET | |
79 ;; | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
80 ;; 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
|
81 ;; 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
|
82 ;; line could be added to your ~/.emacs: |
18597 | 83 ;; (global-auto-revert-mode 1) |
84 ;; | |
85 ;; The function `turn-on-auto-revert-mode' could be added to any major | |
86 ;; mode hook to activate Auto-Revert Mode for all buffers in that | |
87 ;; mode. For example, the following line will activate Auto-Revert | |
88 ;; Mode in all C mode buffers: | |
89 ;; | |
90 ;; (add-hook 'c-mode-hook 'turn-on-auto-revert-mode) | |
91 | |
92 ;;; Code: | |
93 | |
94 ;; Dependencies: | |
95 | |
96 (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
|
97 |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
98 (eval-when-compile (require 'cl)) |
18597 | 99 |
100 | |
101 ;; Custom Group: | |
102 ;; | |
103 ;; The two modes will be placed next to Auto Save Mode under the | |
104 ;; Files group under Emacs. | |
105 | |
106 (defgroup auto-revert nil | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
107 "Revert individual buffers when files on disk change. |
18597 | 108 |
109 Auto-Revert Mode can be activated for individual buffer. | |
110 Global Auto-Revert Mode applies to all buffers." | |
22250
a77d473867b8
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21289
diff
changeset
|
111 :group 'files |
a77d473867b8
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21289
diff
changeset
|
112 :group 'convenience) |
18597 | 113 |
114 | |
115 ;; Variables: | |
116 | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
117 ;;; What's this?: ;; Autoload for the benefit of `make-mode-line-mouse-sensitive'. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
118 ;;; What's this?: ;;;###autoload |
18597 | 119 (defvar auto-revert-mode nil |
120 "*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
|
121 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
|
122 (put 'auto-revert-mode 'permanent-local t) |
18597 | 123 |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
124 (defvar auto-revert-tail-mode nil |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
125 "*Non-nil when Auto-Revert Tail Mode is active. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
126 Never set this variable directly, use the command `auto-revert-mode' instead.") |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
127 (put 'auto-revert-tail-mode 'permanent-local t) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
128 |
54452
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
129 (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
|
130 "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
|
131 |
18597 | 132 (defcustom auto-revert-interval 5 |
53379
cd6072a24608
(auto-revert-interval): Doc fix.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52401
diff
changeset
|
133 "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
|
134 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
|
135 |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
136 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
|
137 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
|
138 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
|
139 `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
|
140 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
|
141 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
|
142 next editing session." |
18597 | 143 :group 'auto-revert |
54452
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
144 :type 'number |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
145 :set (lambda (variable value) |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
146 (set-default variable value) |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
147 (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
|
148 auto-revert-timer |
b0a078151291
(auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents:
54045
diff
changeset
|
149 (auto-revert-set-timer)))) |
18597 | 150 |
151 (defcustom auto-revert-stop-on-user-input t | |
152 "When non-nil Auto-Revert Mode stops checking files on user input." | |
153 :group 'auto-revert | |
154 :type 'boolean) | |
155 | |
156 (defcustom auto-revert-verbose t | |
157 "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
|
158 When non-nil, a message is generated whenever a file is reverted." |
18597 | 159 :group 'auto-revert |
160 :type 'boolean) | |
161 | |
162 (defcustom auto-revert-mode-text " ARev" | |
163 "String to display in the mode line when Auto-Revert Mode is active. | |
164 | |
165 \(When the string is not empty, make sure that it has a leading space.)" | |
166 :tag "Auto Revert Mode Text" ; To separate it from `global-...' | |
167 :group 'auto-revert | |
168 :type 'string) | |
169 | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
170 (defcustom auto-revert-tail-mode-text " Tail" |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
171 "String to display in the mode line when Auto-Revert Tail Mode is active. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
172 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
173 \(When the string is not empty, make sure that it has a leading space.)" |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
174 :group 'auto-revert |
57800
ab671a8f1ce3
(auto-revert-tail-mode-text): Add :version keyword.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57602
diff
changeset
|
175 :type 'string |
ab671a8f1ce3
(auto-revert-tail-mode-text): Add :version keyword.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57602
diff
changeset
|
176 :version "21.4") |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
177 |
18597 | 178 (defcustom auto-revert-mode-hook nil |
179 "Functions to run when Auto-Revert Mode is activated." | |
180 :tag "Auto Revert Mode Hook" ; To separate it from `global-...' | |
181 :group 'auto-revert | |
182 :type 'hook) | |
183 | |
184 (defcustom global-auto-revert-mode-text "" | |
185 "String to display when Global Auto-Revert Mode is active. | |
186 | |
187 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
|
188 vary over time, or between buffers. Hence mode line text |
18597 | 189 would only waste precious space." |
190 :group 'auto-revert | |
191 :type 'string) | |
192 | |
193 (defcustom global-auto-revert-mode-hook nil | |
194 "Hook called when Global Auto-Revert Mode is activated." | |
195 :group 'auto-revert | |
196 :type 'hook) | |
197 | |
198 (defcustom global-auto-revert-non-file-buffers nil | |
56169
c6dcd23450de
(global-auto-revert-non-file-buffers): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
56156
diff
changeset
|
199 "When nil, Global Auto-Revert mode operates only on file-visiting buffers. |
18597 | 200 |
201 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
|
202 `revert-buffer-function' and a `buffer-stale-function' are |
56156
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
203 reverted by Global Auto-Revert mode. These include the Buffer |
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
204 List buffer, and Dired buffers showing complete local |
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
205 directories. Dired buffers do not auto-revert as a result of |
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
206 changes in subdirectories or in the contents, size, modes, etc., |
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
207 of files. You may still sometimes want to revert them manually. |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
208 |
56169
c6dcd23450de
(global-auto-revert-non-file-buffers): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
56156
diff
changeset
|
209 Use this option with care since it could lead to excessive auto-reverts. |
56156
698bb0e02eba
(global-auto-revert-non-file-buffers): Update docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56124
diff
changeset
|
210 For more information, see Info node `(emacs-xtra)Autorevert'." |
18597 | 211 :group 'auto-revert |
56124
9d0ad446b262
(global-auto-revert-non-file-buffers): Add hyperlink to emacs-xtra
Luc Teirlinck <teirllm@auburn.edu>
parents:
55867
diff
changeset
|
212 :type 'boolean |
9d0ad446b262
(global-auto-revert-non-file-buffers): Add hyperlink to emacs-xtra
Luc Teirlinck <teirllm@auburn.edu>
parents:
55867
diff
changeset
|
213 :link '(info-link "(emacs-xtra)Autorevert")) |
18597 | 214 |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
215 (defcustom global-auto-revert-ignore-modes () |
18597 | 216 "List of major modes Global Auto-Revert Mode should not check." |
217 :group 'auto-revert | |
218 :type '(repeat sexp)) | |
219 | |
220 (defcustom auto-revert-load-hook nil | |
221 "Functions to run when Auto-Revert Mode is first loaded." | |
222 :tag "Load Hook" | |
223 :group 'auto-revert | |
224 :type 'hook) | |
225 | |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
226 (defcustom auto-revert-check-vc-info nil |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
227 "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
|
228 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
|
229 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
|
230 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
|
231 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
|
232 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
|
233 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
|
234 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
|
235 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
|
236 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
|
237 |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
238 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
|
239 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
|
240 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
|
241 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
|
242 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
|
243 :group 'auto-revert |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
244 :type 'boolean |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
245 :version "21.4") |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
246 |
18597 | 247 (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
|
248 "*When non-nil, Global Auto-Revert Mode will not revert this buffer. |
18597 | 249 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
250 This variable becomes buffer local when set in any fashion.") |
18597 | 251 (make-variable-buffer-local 'global-auto-revert-ignore-buffer) |
252 | |
253 ;; Internal variables: | |
254 | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
255 (defvar auto-revert-buffer-list () |
18597 | 256 "List of buffers in Auto-Revert Mode. |
257 | |
258 Note that only Auto-Revert Mode, never Global Auto-Revert Mode, adds | |
259 buffers to this list. | |
260 | |
261 The timer function `auto-revert-buffers' is responsible for purging | |
262 the list of old buffers.") | |
263 | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
264 (defvar auto-revert-remaining-buffers () |
18597 | 265 "Buffers not checked when user input stopped execution.") |
266 | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
267 (defvar auto-revert-tail-pos 0 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
268 "Position of last known end of file.") |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
269 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
270 (add-hook 'find-file-hook |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
271 (lambda () |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
272 (set (make-local-variable 'auto-revert-tail-pos) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
273 (save-restriction (widen) (1- (point-max)))))) |
18597 | 274 |
275 ;; Functions: | |
276 | |
277 ;;;###autoload | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
278 (define-minor-mode auto-revert-mode |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
279 "Toggle reverting buffer when file on disk changes. |
18597 | 280 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
281 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
|
282 This is a minor mode that affects only the current buffer. |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
283 Use `global-auto-revert-mode' to automatically revert all buffers. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
284 Use `auto-revert-tail-mode' if you know that the file will only grow |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
285 without being changed in the part that is already in the buffer." |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
286 nil auto-revert-mode-text nil |
18597 | 287 (if auto-revert-mode |
288 (if (not (memq (current-buffer) auto-revert-buffer-list)) | |
289 (push (current-buffer) auto-revert-buffer-list)) | |
290 (setq auto-revert-buffer-list | |
291 (delq (current-buffer) auto-revert-buffer-list))) | |
292 (auto-revert-set-timer) | |
293 (when auto-revert-mode | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
294 (auto-revert-buffers) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
295 (setq auto-revert-tail-mode nil))) |
18597 | 296 |
297 | |
298 ;;;###autoload | |
299 (defun turn-on-auto-revert-mode () | |
300 "Turn on Auto-Revert Mode. | |
301 | |
302 This function is designed to be added to hooks, for example: | |
303 (add-hook 'c-mode-hook 'turn-on-auto-revert-mode)" | |
304 (auto-revert-mode 1)) | |
305 | |
306 | |
307 ;;;###autoload | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
308 (define-minor-mode auto-revert-tail-mode |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
309 "Toggle reverting tail of buffer when file on disk grows. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
310 With arg, turn Tail mode on iff arg is positive. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
311 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
312 When Tail mode is enabled, the tail of the file is constantly |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
313 followed, as with the shell command `tail -f'. This means that |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
314 whenever the file grows on disk (presumably because some |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
315 background process is appending to it from time to time), this is |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
316 reflected in the current buffer. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
317 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
318 You can edit the buffer and turn this mode off and on again as |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
319 you please. But make sure the background process has stopped |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
320 writing before you save the file! |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
321 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
322 Use `auto-revert-mode' for changes other than appends!" |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
323 :group 'find-file :lighter auto-revert-tail-mode-text |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
324 (when auto-revert-tail-mode |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
325 (unless buffer-file-name |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
326 (auto-revert-tail-mode 0) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
327 (error "This buffer is not visiting a file")) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
328 (if (and (buffer-modified-p) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
329 (not auto-revert-tail-pos) ; library was loaded only after finding file |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
330 (not (y-or-n-p "Buffer is modified, so tail offset may be wrong. Proceed? "))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
331 (auto-revert-tail-mode 0) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
332 ;; else we might reappend our own end when we save |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
333 (add-hook 'before-save-hook (lambda () (auto-revert-tail-mode 0)) nil t) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
334 (or (local-variable-p 'auto-revert-tail-pos) ; don't lose prior position |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
335 (set (make-variable-buffer-local 'auto-revert-tail-pos) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
336 (save-restriction (widen) (1- (point-max))))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
337 ;; let auto-revert-mode set up the mechanism for us if it isn't already |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
338 (or auto-revert-mode |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
339 (let ((auto-revert-tail-mode t)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
340 (auto-revert-mode 1))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
341 (setq auto-revert-mode nil)))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
342 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
343 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
344 ;;;###autoload |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
345 (defun turn-on-auto-revert-tail-mode () |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
346 "Turn on Auto-Revert Tail Mode. |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
347 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
348 This function is designed to be added to hooks, for example: |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
349 (add-hook 'my-logfile-mode-hook 'turn-on-auto-revert-tail-mode)" |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
350 (auto-revert-tail-mode 1)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
351 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
352 |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
353 ;;;###autoload |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
354 (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
|
355 "Revert any buffer when file on disk changes. |
18597 | 356 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
357 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
|
358 This is a minor mode that affects all buffers. |
18597 | 359 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
|
360 :global t :group 'auto-revert :lighter global-auto-revert-mode-text |
18597 | 361 (auto-revert-set-timer) |
362 (when global-auto-revert-mode | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
363 (auto-revert-buffers))) |
18597 | 364 |
365 | |
366 (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
|
367 "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
|
368 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
|
369 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
|
370 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
|
371 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
|
372 (interactive) |
18597 | 373 (if (timerp auto-revert-timer) |
374 (cancel-timer auto-revert-timer)) | |
44456
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
375 (setq auto-revert-timer |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
376 (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
|
377 (run-with-timer auto-revert-interval |
a7dbce305a53
(auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38436
diff
changeset
|
378 auto-revert-interval |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
379 'auto-revert-buffers)))) |
18597 | 380 |
53980
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
381 (defun auto-revert-active-p () |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
382 "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
|
383 (or auto-revert-mode |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
384 auto-revert-tail-mode |
53980
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
385 (and |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
386 global-auto-revert-mode |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
387 (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
|
388 (not (memq major-mode |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
389 global-auto-revert-ignore-modes))))) |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
390 |
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
391 (defun auto-revert-handler () |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
392 "Revert current buffer, if appropriate. |
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
393 This is an internal function used by Auto-Revert Mode." |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
394 (when (or auto-revert-tail-mode (not (buffer-modified-p))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
395 (let* ((buffer (current-buffer)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
396 (revert |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
397 (or (and buffer-file-name |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
398 (not (file-remote-p buffer-file-name)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
399 (file-readable-p buffer-file-name) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
400 (not (verify-visited-file-modtime buffer))) |
56463
e86e7a1eccac
Describe `Auto Revert Tail Mode' in `Commentary' section.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56415
diff
changeset
|
401 (and (or auto-revert-mode |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
402 global-auto-revert-non-file-buffers) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
403 revert-buffer-function |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
404 (boundp 'buffer-stale-function) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
405 (functionp buffer-stale-function) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
406 (funcall buffer-stale-function t)))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
407 eob eoblist) |
54513
188394103088
(global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54452
diff
changeset
|
408 (when revert |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
409 (when (and auto-revert-verbose |
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
410 (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
|
411 (message "Reverting buffer `%s'." (buffer-name))) |
54709
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
412 ;; If point (or a window point) is at the end of the buffer, |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
413 ;; we want to keep it at the end after reverting. This allows |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
414 ;; to tail a file. |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
415 (when buffer-file-name |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
416 (setq eob (eobp)) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
417 (walk-windows |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
418 #'(lambda (window) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
419 (and (eq (window-buffer window) buffer) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
420 (= (window-point window) (point-max)) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
421 (push window eoblist))) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
422 'no-mini t)) |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
423 (if auto-revert-tail-mode |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
424 (auto-revert-tail-handler) |
57602 | 425 ;; Bind buffer-read-only in case user has done C-x C-q, |
426 ;; so as not to forget that. This gives undesirable results | |
427 ;; when the file's mode changes, but that is less common. | |
56912
86b23d3c36a2
(auto-revert-handler): Bind `buffer-read-only' locally around the call
Luc Teirlinck <teirllm@auburn.edu>
parents:
56516
diff
changeset
|
428 (let ((buffer-read-only buffer-read-only)) |
86b23d3c36a2
(auto-revert-handler): Bind `buffer-read-only' locally around the call
Luc Teirlinck <teirllm@auburn.edu>
parents:
56516
diff
changeset
|
429 (revert-buffer 'ignore-auto 'dont-ask 'preserve-modes))) |
54709
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
430 (when buffer-file-name |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
431 (when eob (goto-char (point-max))) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
432 (dolist (window eoblist) |
582d81c73e11
(auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents:
54671
diff
changeset
|
433 (set-window-point window (point-max))))) |
54671
237f008115f7
Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54612
diff
changeset
|
434 ;; `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
|
435 ;; 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
|
436 (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
|
437 (vc-find-file-hook))))) |
53980
0bcb32954b6f
Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
53379
diff
changeset
|
438 |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
439 (defun auto-revert-tail-handler () |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
440 (let ((size (nth 7 (file-attributes buffer-file-name))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
441 (modified (buffer-modified-p)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
442 buffer-read-only ; ignore |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
443 (file buffer-file-name) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
444 buffer-file-name) ; ignore that file has changed |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
445 (when (> size auto-revert-tail-pos) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
446 (save-restriction |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
447 (widen) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
448 (save-excursion |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
449 (goto-char (point-max)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
450 (insert-file-contents file nil auto-revert-tail-pos size))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
451 (setq auto-revert-tail-pos size) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
452 (set-buffer-modified-p modified))) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
453 (set-visited-file-modtime)) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
454 |
18597 | 455 (defun auto-revert-buffers () |
456 "Revert buffers as specified by Auto-Revert and Global Auto-Revert Mode. | |
457 | |
458 Should `global-auto-revert-mode' be active all file buffers are checked. | |
459 | |
460 Should `auto-revert-mode' be active in some buffers, those buffers | |
461 are checked. | |
462 | |
54609
b35a0c2934f9
(auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents:
54606
diff
changeset
|
463 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
|
464 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
|
465 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
|
466 `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
|
467 Auto-Revert Mode is active. |
18597 | 468 |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
469 This function stops whenever there is user input. The buffers not |
18597 | 470 checked are stored in the variable `auto-revert-remaining-buffers'. |
471 | |
472 To avoid starvation, the buffers in `auto-revert-remaining-buffers' | |
473 are checked first the next time this function is called. | |
474 | |
21288
1b06a18f33fd
Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents:
20648
diff
changeset
|
475 This function is also responsible for removing buffers no longer in |
18597 | 476 Auto-Revert mode from `auto-revert-buffer-list', and for canceling |
477 the timer when no buffers need to be checked." | |
478 (let ((bufs (if global-auto-revert-mode | |
479 (buffer-list) | |
480 auto-revert-buffer-list)) | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
481 (remaining ()) |
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
482 (new ())) |
18597 | 483 ;; Partition `bufs' into two halves depending on whether or not |
484 ;; the buffers are in `auto-revert-remaining-buffers'. The two | |
485 ;; halves are then re-joined with the "remaining" buffers at the | |
486 ;; head of the list. | |
487 (dolist (buf auto-revert-remaining-buffers) | |
488 (if (memq buf bufs) | |
489 (push buf remaining))) | |
490 (dolist (buf bufs) | |
491 (if (not (memq buf remaining)) | |
492 (push buf new))) | |
493 (setq bufs (nreverse (nconc new remaining))) | |
494 (while (and bufs | |
495 (not (and auto-revert-stop-on-user-input | |
496 (input-pending-p)))) | |
497 (let ((buf (car bufs))) | |
498 (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
|
499 (with-current-buffer buf |
18597 | 500 ;; Test if someone has turned off Auto-Revert Mode in a |
501 ;; non-standard way, for example by changing major mode. | |
502 (if (and (not auto-revert-mode) | |
56415
bda3d4cff473
(auto-revert-tail-mode, auto-revert-tail-mode-text, auto-revert-tail-pos): New vars.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56169
diff
changeset
|
503 (not auto-revert-tail-mode) |
18597 | 504 (memq buf auto-revert-buffer-list)) |
505 (setq auto-revert-buffer-list | |
506 (delq buf auto-revert-buffer-list))) | |
54606
959316c3db53
(auto-revert-handler): Handle auto-revert-mode.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54592
diff
changeset
|
507 (when (auto-revert-active-p) (auto-revert-handler))) |
18597 | 508 ;; Remove dead buffer from `auto-revert-buffer-list'. |
509 (setq auto-revert-buffer-list | |
510 (delq buf auto-revert-buffer-list)))) | |
511 (setq bufs (cdr bufs))) | |
512 (setq auto-revert-remaining-buffers bufs) | |
513 ;; Check if we should cancel the timer. | |
514 (when (and (not global-auto-revert-mode) | |
515 (null auto-revert-buffer-list)) | |
516 (cancel-timer auto-revert-timer) | |
517 (setq auto-revert-timer nil)))) | |
518 | |
519 | |
520 ;; The end: | |
521 (provide 'autorevert) | |
522 | |
523 (run-hooks 'auto-revert-load-hook) | |
524 | |
52401 | 525 ;;; 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
|
526 ;;; autorevert.el ends here |