annotate lisp/autorevert.el @ 55093:f849da3c5bb4

*** empty log message ***
author Juanma Barranquero <lekktu@gmail.com>
date Fri, 23 Apr 2004 00:25:28 +0000
parents 582d81c73e11
children 5a212b0ada97
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 ;; This file is part of GNU Emacs.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; it under the terms of the GNU General Public License as published by
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; the Free Software Foundation; either version 2, or (at your option)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 ;; any later version.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; GNU Emacs is distributed in the hope that it will be useful,
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; GNU General Public License for more details.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 ;; You should have received a copy of the GNU General Public License
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 ;; Boston, MA 02111-1307, USA.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 ;;; Commentary:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 ;; Introduction:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 ;;
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 ;; to load the new content of the file into Emacs.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 ;;
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 ;; whenever the corresponding files have been changed on disk.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 ;;
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 ;; Auto-Revert Mode can be activated for individual buffers.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 ;; Global Auto-Revert Mode applies to all file buffers.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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).
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
47 ;;
582d81c73e11 (auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents: 54671
diff changeset
48 ;; 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
49 ;; 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
50 ;; 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
51 ;; 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
52 ;; 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
53 ;; 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
54 ;; 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
55 ;; 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
56 ;; 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
57 ;; behavior may be mode dependent.
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 ;; Usage:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 ;;
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 ;; Go to the appropriate buffer and press:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 ;; M-x auto-revert-mode RET
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 ;;
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 ;; To activate Global Auto-Revert Mode, press:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 ;; M-x global-auto-revert-mode RET
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 ;;
21288
1b06a18f33fd Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents: 20648
diff changeset
67 ;; 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
68 ;; 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
69 ;; line could be added to your ~/.emacs:
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 ;; (global-auto-revert-mode 1)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 ;;
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 ;; The function `turn-on-auto-revert-mode' could be added to any major
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 ;; mode hook to activate Auto-Revert Mode for all buffers in that
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 ;; mode. For example, the following line will activate Auto-Revert
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 ;; Mode in all C mode buffers:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 ;;
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 ;; (add-hook 'c-mode-hook 'turn-on-auto-revert-mode)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 ;;; Code:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 ;; Dependencies:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83 (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
84
54671
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
85 (eval-when-compile (require 'cl))
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88 ;; Custom Group:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
89 ;;
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90 ;; The two modes will be placed next to Auto Save Mode under the
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91 ;; Files group under Emacs.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93 (defgroup auto-revert nil
21288
1b06a18f33fd Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents: 20648
diff changeset
94 "Revert individual buffers when files on disk change.
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 Auto-Revert Mode can be activated for individual buffer.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 Global Auto-Revert Mode applies to all buffers."
22250
a77d473867b8 *** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents: 21289
diff changeset
98 :group 'files
a77d473867b8 *** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents: 21289
diff changeset
99 :group 'convenience)
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 ;; Variables:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103
25215
5d684a6517db (auto-revert-mode): Add autoload cookie.
Dave Love <fx@gnu.org>
parents: 22388
diff changeset
104 ;; 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
105 ;;;###autoload
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 (defvar auto-revert-mode nil
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107 "*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
108 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
109 (put 'auto-revert-mode 'permanent-local t)
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110
54452
b0a078151291 (auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents: 54045
diff changeset
111 (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
112 "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
113
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114 (defcustom auto-revert-interval 5
53379
cd6072a24608 (auto-revert-interval): Doc fix.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 52401
diff changeset
115 "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
116 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
117
b0a078151291 (auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents: 54045
diff changeset
118 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
119 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
120 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
121 `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
122 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
123 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
124 next editing session."
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 :group 'auto-revert
54452
b0a078151291 (auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents: 54045
diff changeset
126 :type 'number
b0a078151291 (auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents: 54045
diff changeset
127 :set (lambda (variable value)
b0a078151291 (auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents: 54045
diff changeset
128 (set-default variable value)
b0a078151291 (auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents: 54045
diff changeset
129 (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
130 auto-revert-timer
b0a078151291 (auto-revert-interval): Make new value take effect immediately when
Luc Teirlinck <teirllm@auburn.edu>
parents: 54045
diff changeset
131 (auto-revert-set-timer))))
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
132
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 (defcustom auto-revert-stop-on-user-input t
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134 "When non-nil Auto-Revert Mode stops checking files on user input."
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135 :group 'auto-revert
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136 :type 'boolean)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138 (defcustom auto-revert-verbose t
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 "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
140 When non-nil, a message is generated whenever a file is reverted."
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 :group 'auto-revert
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142 :type 'boolean)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 (defcustom auto-revert-mode-text " ARev"
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 "String to display in the mode line when Auto-Revert Mode is active.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147 \(When the string is not empty, make sure that it has a leading space.)"
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
148 :tag "Auto Revert Mode Text" ; To separate it from `global-...'
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
149 :group 'auto-revert
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
150 :type 'string)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
151
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
152 (defcustom auto-revert-mode-hook nil
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153 "Functions to run when Auto-Revert Mode is activated."
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
154 :tag "Auto Revert Mode Hook" ; To separate it from `global-...'
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
155 :group 'auto-revert
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
156 :type 'hook)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
157
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
158 (defcustom global-auto-revert-mode-text ""
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
159 "String to display when Global Auto-Revert Mode is active.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
160
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
161 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
162 vary over time, or between buffers. Hence mode line text
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
163 would only waste precious space."
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
164 :group 'auto-revert
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
165 :type 'string)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
166
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
167 (defcustom global-auto-revert-mode-hook nil
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
168 "Hook called when Global Auto-Revert Mode is activated."
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
169 :group 'auto-revert
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
170 :type 'hook)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
171
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
172 (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
173 "When nil only file buffers are reverted by Global Auto-Revert Mode.
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
174
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
175 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
176 `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
177 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
178
54513
188394103088 (global-auto-revert-non-file-buffers): Expand doc string.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54452
diff changeset
179 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
180 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
181 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
182 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
183 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
184 not necessarily make manual updates useless for non-file buffers."
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185 :group 'auto-revert
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186 :type 'boolean)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
187
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
188 (defcustom global-auto-revert-ignore-modes '()
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189 "List of major modes Global Auto-Revert Mode should not check."
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190 :group 'auto-revert
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
191 :type '(repeat sexp))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 (defcustom auto-revert-load-hook nil
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194 "Functions to run when Auto-Revert Mode is first loaded."
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195 :tag "Load Hook"
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
196 :group 'auto-revert
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
197 :type 'hook)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
198
54671
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
199 (defcustom auto-revert-check-vc-info nil
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
200 "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
201 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
202 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
203 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
204 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
205 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
206 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
207 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
208 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
209 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
210
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
211 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
212 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
213 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
214 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
215 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
216 :group 'auto-revert
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
217 :type 'boolean
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
218 :version "21.4")
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
219
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220 (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
221 "*When non-nil, Global Auto-Revert Mode will not revert this buffer.
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222
21288
1b06a18f33fd Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents: 20648
diff changeset
223 This variable becomes buffer local when set in any fashion.")
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 (make-variable-buffer-local 'global-auto-revert-ignore-buffer)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226 ;; Internal variables:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
227
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
228 (defvar auto-revert-buffer-list '()
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
229 "List of buffers in Auto-Revert Mode.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
230
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231 Note that only Auto-Revert Mode, never Global Auto-Revert Mode, adds
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 buffers to this list.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234 The timer function `auto-revert-buffers' is responsible for purging
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
235 the list of old buffers.")
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
236
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
237 (defvar auto-revert-remaining-buffers '()
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
238 "Buffers not checked when user input stopped execution.")
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
240
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
241 ;; Functions:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
242
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
243 ;;;###autoload
44456
a7dbce305a53 (auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
244 (define-minor-mode auto-revert-mode
21288
1b06a18f33fd Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents: 20648
diff changeset
245 "Toggle reverting buffer when file on disk changes.
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
246
21288
1b06a18f33fd Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents: 20648
diff changeset
247 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
248 This is a minor mode that affects only the current buffer.
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
249 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
250 nil auto-revert-mode-text nil
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
251 (if auto-revert-mode
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
252 (if (not (memq (current-buffer) auto-revert-buffer-list))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
253 (push (current-buffer) auto-revert-buffer-list))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
254 (setq auto-revert-buffer-list
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
255 (delq (current-buffer) auto-revert-buffer-list)))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
256 (auto-revert-set-timer)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
257 (when auto-revert-mode
44456
a7dbce305a53 (auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
258 (auto-revert-buffers)))
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
260
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
261 ;;;###autoload
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
262 (defun turn-on-auto-revert-mode ()
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
263 "Turn on Auto-Revert Mode.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 This function is designed to be added to hooks, for example:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266 (add-hook 'c-mode-hook 'turn-on-auto-revert-mode)"
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
267 (auto-revert-mode 1))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
268
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
269
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
270 ;;;###autoload
44456
a7dbce305a53 (auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
271 (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
272 "Revert any buffer when file on disk changes.
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
273
21288
1b06a18f33fd Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents: 20648
diff changeset
274 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
275 This is a minor mode that affects all buffers.
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
276 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
277 :global t :group 'auto-revert :lighter global-auto-revert-mode-text
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
278 (auto-revert-set-timer)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
279 (when global-auto-revert-mode
44456
a7dbce305a53 (auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
280 (auto-revert-buffers)))
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
281
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
282
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
283 (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
284 "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
285 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
286 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
287 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
288 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
289 (interactive)
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
290 (if (timerp auto-revert-timer)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
291 (cancel-timer auto-revert-timer))
44456
a7dbce305a53 (auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
292 (setq auto-revert-timer
a7dbce305a53 (auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
293 (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
294 (run-with-timer auto-revert-interval
a7dbce305a53 (auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
295 auto-revert-interval
a7dbce305a53 (auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
296 'auto-revert-buffers)
a7dbce305a53 (auto-revert-mode, global-auto-revert-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
297 nil)))
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
298
53980
0bcb32954b6f Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53379
diff changeset
299 (defun auto-revert-active-p ()
0bcb32954b6f Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53379
diff changeset
300 "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
301 (or auto-revert-mode
0bcb32954b6f Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53379
diff changeset
302 (and
0bcb32954b6f Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53379
diff changeset
303 global-auto-revert-mode
0bcb32954b6f Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53379
diff changeset
304 (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
305 (not (memq major-mode
0bcb32954b6f Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53379
diff changeset
306 global-auto-revert-ignore-modes)))))
0bcb32954b6f Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53379
diff changeset
307
0bcb32954b6f Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53379
diff changeset
308 (defun auto-revert-handler ()
54609
b35a0c2934f9 (auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents: 54606
diff changeset
309 "Revert current buffer, if appropriate.
b35a0c2934f9 (auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents: 54606
diff changeset
310 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
311 (unless (buffer-modified-p)
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
312 (let ((buffer (current-buffer)) revert eob 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
313 (or (and 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
314 (file-readable-p 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
315 (not (verify-visited-file-modtime buffer))
54671
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
316 (setq revert t))
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
317 (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
318 revert-buffer-function
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
319 (boundp 'buffer-stale-function)
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
320 (functionp buffer-stale-function)
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
321 (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
322 (when revert
54671
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
323 (when (and auto-revert-verbose
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
324 (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
325 (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
326 ;; 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
327 ;; 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
328 ;; 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
329 (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
330 (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
331 (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
332 #'(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
333 (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
334 (= (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
335 (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
336 'no-mini t))
582d81c73e11 (auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents: 54671
diff changeset
337 (revert-buffer 'ignore-auto 'dont-ask 'preserve-modes)
582d81c73e11 (auto-revert-handler): If point (or a window point) is at the end of
Luc Teirlinck <teirllm@auburn.edu>
parents: 54671
diff changeset
338 (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
339 (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
340 (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
341 (set-window-point window (point-max)))))
54671
237f008115f7 Delete obsolete autoload's and defvar's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54612
diff changeset
342 ;; `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
343 ;; 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
344 (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
345 (vc-find-file-hook)))))
53980
0bcb32954b6f Added support to detect changed dired buffers.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53379
diff changeset
346
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
347 (defun auto-revert-buffers ()
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
348 "Revert buffers as specified by Auto-Revert and Global Auto-Revert Mode.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
350 Should `global-auto-revert-mode' be active all file buffers are checked.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
352 Should `auto-revert-mode' be active in some buffers, those buffers
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
353 are checked.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
354
54609
b35a0c2934f9 (auto-revert-verbose, global-auto-revert-non-file-buffers)
Luc Teirlinck <teirllm@auburn.edu>
parents: 54606
diff changeset
355 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
356 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
357 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
358 `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
359 Auto-Revert Mode is active.
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
360
21288
1b06a18f33fd Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents: 20648
diff changeset
361 This function stops whenever there is user input. The buffers not
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
362 checked are stored in the variable `auto-revert-remaining-buffers'.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
363
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364 To avoid starvation, the buffers in `auto-revert-remaining-buffers'
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365 are checked first the next time this function is called.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
366
21288
1b06a18f33fd Various doc fixes, mainly grammar.
Dave Love <fx@gnu.org>
parents: 20648
diff changeset
367 This function is also responsible for removing buffers no longer in
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
368 Auto-Revert mode from `auto-revert-buffer-list', and for canceling
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
369 the timer when no buffers need to be checked."
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
370 (let ((bufs (if global-auto-revert-mode
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
371 (buffer-list)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
372 auto-revert-buffer-list))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
373 (remaining '())
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
374 (new '()))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
375 ;; Partition `bufs' into two halves depending on whether or not
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
376 ;; the buffers are in `auto-revert-remaining-buffers'. The two
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
377 ;; halves are then re-joined with the "remaining" buffers at the
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
378 ;; head of the list.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
379 (dolist (buf auto-revert-remaining-buffers)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380 (if (memq buf bufs)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 (push buf remaining)))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382 (dolist (buf bufs)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383 (if (not (memq buf remaining))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
384 (push buf new)))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
385 (setq bufs (nreverse (nconc new remaining)))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
386 (while (and bufs
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
387 (not (and auto-revert-stop-on-user-input
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
388 (input-pending-p))))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
389 (let ((buf (car bufs)))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
390 (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
391 (with-current-buffer buf
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
392 ;; Test if someone has turned off Auto-Revert Mode in a
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
393 ;; non-standard way, for example by changing major mode.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394 (if (and (not auto-revert-mode)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
395 (memq buf auto-revert-buffer-list))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
396 (setq auto-revert-buffer-list
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
397 (delq buf auto-revert-buffer-list)))
54606
959316c3db53 (auto-revert-handler): Handle auto-revert-mode.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54592
diff changeset
398 (when (auto-revert-active-p) (auto-revert-handler)))
18597
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399 ;; Remove dead buffer from `auto-revert-buffer-list'.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
400 (setq auto-revert-buffer-list
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
401 (delq buf auto-revert-buffer-list))))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402 (setq bufs (cdr bufs)))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 (setq auto-revert-remaining-buffers bufs)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404 ;; Check if we should cancel the timer.
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 (when (and (not global-auto-revert-mode)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 (null auto-revert-buffer-list))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407 (cancel-timer auto-revert-timer)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
408 (setq auto-revert-timer nil))))
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411 ;; The end:
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 (provide 'autorevert)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414 (run-hooks 'auto-revert-load-hook)
515b7c955cd8 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 44456
diff changeset
416 ;;; 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
417 ;;; autorevert.el ends here