Mercurial > emacs
annotate lisp/userlock.el @ 98688:19eaf7a7f803
*** empty log message ***
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Mon, 13 Oct 2008 11:24:22 +0000 |
parents | ee5932bf781d |
children | a9dc0e7c3f2b |
rev | line source |
---|---|
657
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
258
diff
changeset
|
1 ;;; userlock.el --- handle file access contention between multiple users |
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
258
diff
changeset
|
2 |
74442 | 3 ;; Copyright (C) 1985, 1986, 2001, 2002, 2003, 2004, |
79721 | 4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
841 | 5 |
812
485e82a8acb5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
6 ;; Maintainer: FSF |
485e82a8acb5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
7 ;; Keywords: internal |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
8 |
36 | 9 ;; This file is part of GNU Emacs. |
10 | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
11 ;; GNU Emacs is free software: you can redistribute it and/or modify |
36 | 12 ;; it under the terms of the GNU General Public License as published by |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
13 ;; the Free Software Foundation, either version 3 of the License, or |
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
14 ;; (at your option) any later version. |
36 | 15 |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
36 | 23 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
24 ;;; Commentary: |
36 | 25 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
26 ;; This file is autoloaded to handle certain conditions |
36 | 27 ;; detected by the file-locking code within Emacs. |
28 ;; The two entry points are `ask-user-about-lock' and | |
29 ;; `ask-user-about-supersession-threat'. | |
30 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
31 ;;; Code: |
36 | 32 |
33 (put 'file-locked 'error-conditions '(file-locked file-error error)) | |
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
34 (put 'file-locked 'error-message "File is locked") |
36 | 35 |
258 | 36 ;;;###autoload |
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
37 (defun ask-user-about-lock (file opponent) |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
38 "Ask user what to do when he wants to edit FILE but it is locked by OPPONENT. |
36 | 39 This function has a choice of three things to do: |
26281
d4ba91022b7a
(ask-user-about-lock): Doc fix.
Gerd Moellmann <gerd@gnu.org>
parents:
19676
diff
changeset
|
40 do (signal 'file-locked (list FILE OPPONENT)) |
36 | 41 to refrain from editing the file |
42 return t (grab the lock on the file) | |
43 return nil (edit the file even though it is locked). | |
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
44 You can redefine this function to choose among those three alternatives |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
45 in any way you like." |
36 | 46 (discard-input) |
47 (save-window-excursion | |
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
48 (let (answer short-opponent short-file) |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
49 (setq short-file |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
50 (if (> (length file) 22) |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
51 (concat "..." (substring file (- (length file) 22))) |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
52 file)) |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
53 (setq short-opponent |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
54 (if (> (length opponent) 25) |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
55 (save-match-data |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
56 (string-match " (pid [0-9]+)" opponent) |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
57 (concat (substring opponent 0 13) "..." |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
58 (match-string 0 opponent))) |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
59 opponent)) |
36 | 60 (while (null answer) |
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
61 (message "%s locked by %s: (s, q, p, ?)? " |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
62 short-file short-opponent) |
36 | 63 (let ((tem (let ((inhibit-quit t) |
64 (cursor-in-echo-area t)) | |
65 (prog1 (downcase (read-char)) | |
66 (setq quit-flag nil))))) | |
67 (if (= tem help-char) | |
68 (ask-user-about-lock-help) | |
69 (setq answer (assoc tem '((?s . t) | |
70 (?q . yield) | |
71 (?\C-g . yield) | |
72 (?p . nil) | |
73 (?? . help)))) | |
74 (cond ((null answer) | |
75 (beep) | |
76 (message "Please type q, s, or p; or ? for help") | |
77 (sit-for 3)) | |
78 ((eq (cdr answer) 'help) | |
79 (ask-user-about-lock-help) | |
80 (setq answer nil)) | |
81 ((eq (cdr answer) 'yield) | |
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
82 (signal 'file-locked (list file opponent))))))) |
36 | 83 (cdr answer)))) |
84 | |
85 (defun ask-user-about-lock-help () | |
86 (with-output-to-temp-buffer "*Help*" | |
87 (princ "It has been detected that you want to modify a file that someone else has | |
74258
26cf15a2cb37
(ask-user-about-lock-help): Fix typos in output message.
Juanma Barranquero <lekktu@gmail.com>
parents:
68651
diff
changeset
|
88 already started modifying in Emacs. |
36 | 89 |
74258
26cf15a2cb37
(ask-user-about-lock-help): Fix typos in output message.
Juanma Barranquero <lekktu@gmail.com>
parents:
68651
diff
changeset
|
90 You can <s>teal the file; the other user becomes the |
36 | 91 intruder if (s)he ever unmodifies the file and then changes it again. |
92 You can <p>roceed; you edit at your own (and the other user's) risk. | |
9843
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
4566
diff
changeset
|
93 You can <q>uit; don't modify this file.") |
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
4566
diff
changeset
|
94 (save-excursion |
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
4566
diff
changeset
|
95 (set-buffer standard-output) |
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
4566
diff
changeset
|
96 (help-mode)))) |
36 | 97 |
98 (put | |
99 'file-supersession 'error-conditions '(file-supersession file-error error)) | |
100 | |
258 | 101 ;;;###autoload |
36 | 102 (defun ask-user-about-supersession-threat (fn) |
103 "Ask a user who is about to modify an obsolete buffer what to do. | |
104 This function has two choices: it can return, in which case the modification | |
105 of the buffer will proceed, or it can (signal 'file-supersession (file)), | |
106 in which case the proposed buffer modification will not be made. | |
107 | |
108 You can rewrite this to use any criterion you like to choose which one to do. | |
109 The buffer in question is current when this function is called." | |
110 (discard-input) | |
111 (save-window-excursion | |
112 (let (answer) | |
113 (while (null answer) | |
15571
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
114 (message "%s changed on disk; really edit the buffer? (y, n, r or C-h) " |
4566
14d8646c61c4
(ask-user-about-supersession-threat): Mention file name when asking question.
Richard M. Stallman <rms@gnu.org>
parents:
841
diff
changeset
|
115 (file-name-nondirectory fn)) |
36 | 116 (let ((tem (downcase (let ((cursor-in-echo-area t)) |
47651
0c66d7531f3e
(ask-user-about-supersession-threat): Don't abort when the user hits mouse-2.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26281
diff
changeset
|
117 (read-char-exclusive))))) |
36 | 118 (setq answer |
119 (if (= tem help-char) | |
120 'help | |
121 (cdr (assoc tem '((?n . yield) | |
122 (?\C-g . yield) | |
123 (?y . proceed) | |
15571
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
124 (?r . revert) |
36 | 125 (?? . help)))))) |
126 (cond ((null answer) | |
127 (beep) | |
15571
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
128 (message "Please type y, n or r; or ? for help") |
36 | 129 (sit-for 3)) |
130 ((eq answer 'help) | |
131 (ask-user-about-supersession-help) | |
132 (setq answer nil)) | |
15571
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
133 ((eq answer 'revert) |
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
134 (revert-buffer nil (not (buffer-modified-p))) |
78492
7c8949dbfa0d
Replace `iff' in doc-strings and comments.
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
135 ; ask confirmation if buffer modified |
15571
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
136 (signal 'file-supersession |
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
137 (list "File reverted" fn))) |
36 | 138 ((eq answer 'yield) |
139 (signal 'file-supersession | |
140 (list "File changed on disk" fn)))))) | |
141 (message | |
142 "File on disk now will become a backup file if you save these changes.") | |
143 (setq buffer-backed-up nil)))) | |
144 | |
145 (defun ask-user-about-supersession-help () | |
146 (with-output-to-temp-buffer "*Help*" | |
147 (princ "You want to modify a buffer whose disk file has changed | |
148 since you last read it in or saved it with this buffer. | |
149 | |
150 If you say `y' to go ahead and modify this buffer, | |
151 you risk ruining the work of whoever rewrote the file. | |
15571
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
152 If you say `r' to revert, the contents of the buffer are refreshed |
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
153 from the file on disk. |
36 | 154 If you say `n', the change you started to make will be aborted. |
155 | |
156 Usually, you should type `n' and then `M-x revert-buffer', | |
9843
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
4566
diff
changeset
|
157 to get the latest version of the file, then make the change again.") |
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
4566
diff
changeset
|
158 (save-excursion |
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
4566
diff
changeset
|
159 (set-buffer standard-output) |
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
4566
diff
changeset
|
160 (help-mode)))) |
36 | 161 |
93975
1e3a407766b9
Fix up comment convention on the arch-tag lines.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
79721
diff
changeset
|
162 ;; arch-tag: a61c5b60-e1c8-44fd-894a-c617f4dfc639 |
657
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
258
diff
changeset
|
163 ;;; userlock.el ends here |