Mercurial > emacs
annotate lisp/userlock.el @ 70409:be2fb717fb5d
(Diff Mode): Minor cleanup.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Fri, 05 May 2006 20:56:02 +0000 |
parents | 3bd95f4f2941 |
children | 26cf15a2cb37 c5406394f567 |
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 |
64762
41bb365f41c4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64091
diff
changeset
|
3 ;; Copyright (C) 1985, 1986, 2002, 2003, 2004, |
68651
3bd95f4f2941
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64762
diff
changeset
|
4 ;; 2005, 2006 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 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
13 ;; the Free Software Foundation; either version 2, or (at your option) |
36 | 14 ;; any later version. |
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 | |
14169 | 22 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
64091 | 23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 ;; Boston, MA 02110-1301, USA. | |
36 | 25 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
26 ;;; Commentary: |
36 | 27 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
28 ;; This file is autoloaded to handle certain conditions |
36 | 29 ;; detected by the file-locking code within Emacs. |
30 ;; The two entry points are `ask-user-about-lock' and | |
31 ;; `ask-user-about-supersession-threat'. | |
32 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
33 ;;; Code: |
36 | 34 |
35 (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
|
36 (put 'file-locked 'error-message "File is locked") |
36 | 37 |
258 | 38 ;;;###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
|
39 (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
|
40 "Ask user what to do when he wants to edit FILE but it is locked by OPPONENT. |
36 | 41 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
|
42 do (signal 'file-locked (list FILE OPPONENT)) |
36 | 43 to refrain from editing the file |
44 return t (grab the lock on the file) | |
45 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
|
46 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
|
47 in any way you like." |
36 | 48 (discard-input) |
49 (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
|
50 (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
|
51 (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
|
52 (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
|
53 (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
|
54 file)) |
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
parents:
15571
diff
changeset
|
55 (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
|
56 (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
|
57 (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
|
58 (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
|
59 (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
|
60 (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
|
61 opponent)) |
36 | 62 (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
|
63 (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
|
64 short-file short-opponent) |
36 | 65 (let ((tem (let ((inhibit-quit t) |
66 (cursor-in-echo-area t)) | |
67 (prog1 (downcase (read-char)) | |
68 (setq quit-flag nil))))) | |
69 (if (= tem help-char) | |
70 (ask-user-about-lock-help) | |
71 (setq answer (assoc tem '((?s . t) | |
72 (?q . yield) | |
73 (?\C-g . yield) | |
74 (?p . nil) | |
75 (?? . help)))) | |
76 (cond ((null answer) | |
77 (beep) | |
78 (message "Please type q, s, or p; or ? for help") | |
79 (sit-for 3)) | |
80 ((eq (cdr answer) 'help) | |
81 (ask-user-about-lock-help) | |
82 (setq answer nil)) | |
83 ((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
|
84 (signal 'file-locked (list file opponent))))))) |
36 | 85 (cdr answer)))) |
86 | |
87 (defun ask-user-about-lock-help () | |
88 (with-output-to-temp-buffer "*Help*" | |
89 (princ "It has been detected that you want to modify a file that someone else has | |
90 already started modifying in EMACS. | |
91 | |
92 You can <s>teal the file; The other user becomes the | |
93 intruder if (s)he ever unmodifies the file and then changes it again. | |
94 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
|
95 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
|
96 (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
|
97 (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
|
98 (help-mode)))) |
36 | 99 |
100 (put | |
101 'file-supersession 'error-conditions '(file-supersession file-error error)) | |
102 | |
258 | 103 ;;;###autoload |
36 | 104 (defun ask-user-about-supersession-threat (fn) |
105 "Ask a user who is about to modify an obsolete buffer what to do. | |
106 This function has two choices: it can return, in which case the modification | |
107 of the buffer will proceed, or it can (signal 'file-supersession (file)), | |
108 in which case the proposed buffer modification will not be made. | |
109 | |
110 You can rewrite this to use any criterion you like to choose which one to do. | |
111 The buffer in question is current when this function is called." | |
112 (discard-input) | |
113 (save-window-excursion | |
114 (let (answer) | |
115 (while (null answer) | |
15571
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
116 (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
|
117 (file-name-nondirectory fn)) |
36 | 118 (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
|
119 (read-char-exclusive))))) |
36 | 120 (setq answer |
121 (if (= tem help-char) | |
122 'help | |
123 (cdr (assoc tem '((?n . yield) | |
124 (?\C-g . yield) | |
125 (?y . proceed) | |
15571
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
126 (?r . revert) |
36 | 127 (?? . help)))))) |
128 (cond ((null answer) | |
129 (beep) | |
15571
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
130 (message "Please type y, n or r; or ? for help") |
36 | 131 (sit-for 3)) |
132 ((eq answer 'help) | |
133 (ask-user-about-supersession-help) | |
134 (setq answer nil)) | |
15571
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
135 ((eq answer 'revert) |
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
136 (revert-buffer nil (not (buffer-modified-p))) |
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
137 ; ask confirmation iff buffer modified |
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
138 (signal 'file-supersession |
d99336533cc0
(ask-user-about-supersession-help): Change help text.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
139 (list "File reverted" fn))) |
36 | 140 ((eq answer 'yield) |
141 (signal 'file-supersession | |
142 (list "File changed on disk" fn)))))) | |
143 (message | |
144 "File on disk now will become a backup file if you save these changes.") | |
145 (setq buffer-backed-up nil)))) | |
146 | |
147 (defun ask-user-about-supersession-help () | |
148 (with-output-to-temp-buffer "*Help*" | |
149 (princ "You want to modify a buffer whose disk file has changed | |
150 since you last read it in or saved it with this buffer. | |
151 | |
152 If you say `y' to go ahead and modify this buffer, | |
153 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
|
154 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
|
155 from the file on disk. |
36 | 156 If you say `n', the change you started to make will be aborted. |
157 | |
158 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
|
159 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
|
160 (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
|
161 (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
|
162 (help-mode)))) |
36 | 163 |
52401 | 164 ;;; arch-tag: a61c5b60-e1c8-44fd-894a-c617f4dfc639 |
657
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
258
diff
changeset
|
165 ;;; userlock.el ends here |