tbc@hplsdrk.COS.HP.COM (Tim Chambers) (05/10/91)
I got tired of having to revert my buffers every time emacs detects the file changed out from under me, so I changed userlock.el. My version enhances the behavior you get when you now see the message, "File has changed on disk; really want to edit the buffer? (y, n, or C-h)." With my version, you can type `r' and revert-buffer will be called. I also like electric-help, so I added that, too. My version of the file userlock.el is the next response. Respectfully submitted, Tim Chambers <tbc@hp-lsd.hp.com> P.S. I'd appreciate it if someone from the FSF would let me know if this change will be included in a future version of GNU emacs.
tbc@hplsdrk.COS.HP.COM (Tim Chambers) (05/10/91)
;; Copyright (C) 1985, 1986 Free Software Foundation, inc.
;; This file is part of GNU Emacs.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY. No author or distributor
;; accepts responsibility to anyone for the consequences of using it
;; or for whether it serves any particular purpose or works at all,
;; unless he says so in writing. Refer to the GNU Emacs General Public
;; License for full details.
;; Everyone is granted permission to copy, modify and redistribute
;; GNU Emacs, but only under the conditions described in the
;; GNU Emacs General Public License. A copy of this license is
;; supposed to have been given to you along with GNU Emacs so you
;; can know your rights and responsibilities. It should be in a
;; file named COPYING. Among other things, the copyright notice
;; and this notice must be preserved on all copies.
;; This file is autloaded to handle certain conditions
;; detected by the file-locking code within Emacs.
;; The two entry points are `ask-user-about-lock' and
;; `ask-user-about-supersession-threat'.
(require 'ehelp) ; electric help package
(put 'file-locked 'error-conditions '(file-locked file-error error))
(defun ask-user-about-lock (fn opponent)
"Ask user what to do when he wants to edit FILE but it is locked by USER.
This function has a choice of three things to do:
do (signal 'buffer-file-locked (list FILE USER))
to refrain from editing the file
return t (grab the lock on the file)
return nil (edit the file even though it is locked).
You can rewrite it to use any criterion you like to choose which one to do."
(discard-input)
(save-window-excursion
(let (answer)
(while (null answer)
(message "%s is locking %s: action (s, q, p, ?)? " opponent fn)
(let ((tem (let ((inhibit-quit t)
(cursor-in-echo-area t))
(prog1 (downcase (read-char))
(setq quit-flag nil)))))
(if (= tem help-char)
(ask-user-about-lock-help)
(setq answer (assoc tem '((?s . t)
(?q . yield)
(?\C-g . yield)
(?p . nil)
(?? . help))))
(cond ((null answer)
(beep)
(message "Please type q, s, or p; or ? for help")
(sit-for 3))
((eq (cdr answer) 'help)
(ask-user-about-lock-help)
(setq answer nil))
((eq (cdr answer) 'yield)
(signal 'file-locked (list "File is locked" fn opponent)))))))
(cdr answer))))
(defun ask-user-about-lock-help ()
(with-output-to-temp-buffer "*Help*"
(princ "It has been detected that you want to modify a file that someone else has
already started modifying in EMACS.
You can <s>teal the file; The other user becomes the
intruder if (s)he ever unmodifies the file and then changes it again.
You can <p>roceed; you edit at your own (and the other user's) risk.
You can <q>uit; don't modify this file.")))
(put
'file-supersession 'error-conditions '(file-supersession file-error error))
(defun ask-user-about-supersession-threat (fn)
"Ask a user who is about to modify an obsolete buffer what to do.
This function has two choices: it can return, in which case the modification
of the buffer will proceed, or it can (signal 'file-supersession (file)),
in which case the proposed buffer modification will not be made.
You can rewrite this to use any criterion you like to choose which one to do."
(discard-input)
(save-window-excursion
(let (answer)
(while (null answer)
(message "File has changed on disk; really want to edit the buffer? (y, n, r or C-h) ")
(let ((tem (downcase (let ((cursor-in-echo-area t))
(read-char)))))
(setq answer
(if (= tem help-char)
'help
(cdr (assoc tem '((?n . yield)
(?\C-g . yield)
(?y . proceed)
(?r . revert)
(?? . help))))))
(cond ((null answer)
(beep)
(message "Please type y, n, or r; or ? for help")
(sit-for 3))
((eq answer 'help)
(ask-user-about-supersession-help)
(setq answer nil))
((eq answer 'revert)
(revert-buffer)) ; call with all confirmations
((eq answer 'yield)
(signal 'file-supersession
(list "File changed on disk" fn))))))
(message
"File on disk now will become a backup file if you save these changes.")
(setq buffer-backed-up nil))))
(defun ask-user-about-supersession-help ()
(with-electric-help
(function
(lambda ()
(princ "You want to modify a buffer whose disk file has changed
since you last read it in or saved it with this buffer.
If you say `y' to go ahead and modify this buffer,
you risk ruining the work of whoever rewrote the file.
If you say `r', revert-buffer will be called.
If you say `n', the change you started to make will be aborted.")
)
)
)
)