annotate lisp/emacs-lock.el @ 103398:8cc2b1e9767f

Re-generated.
author Kenichi Handa <handa@m17n.org>
date Fri, 12 Jun 2009 12:34:00 +0000
parents a9dc0e7c3f2b
children 1d1d5d9bd884
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
74249
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
1 ;;; emacs-lock.el --- prevents you from exiting Emacs if a buffer is locked
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
2
74439
ddcbd2c1b70d Update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 74249
diff changeset
3 ;; Copyright (C) 1994, 1997, 2001, 2002, 2003, 2004,
100908
a9dc0e7c3f2b Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 94678
diff changeset
4 ;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
5
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 ;; Author: Tom Wurgler <twurgler@goodyear.com>
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 ;; Created: 12/8/94
18214
34593904dc4e Add some keywords.
Richard M. Stallman <rms@gnu.org>
parents: 18211
diff changeset
8 ;; Keywords: extensions, processes
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
9
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
10 ;; This file is part of GNU Emacs.
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
11
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
10240
72101c74e9e7 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
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93975
diff changeset
14 ;; 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
15 ;; (at your option) any later version.
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
16
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
17 ;; GNU Emacs is distributed in the hope that it will be useful,
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; GNU General Public License for more details.
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
21
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 ;; 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
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 ;;; Commentary:
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
26
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 ;; This code sets a buffer-local variable to t if toggle-emacs-lock is run,
74249
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
28 ;; then if the user attempts to exit Emacs, the locked buffer name will be
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 ;; displayed and the exit aborted. This is just a way of protecting
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 ;; yourself from yourself. For example, if you have a shell running a big
74249
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
31 ;; program and exiting Emacs would abort that program, you may want to lock
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 ;; that buffer, then if you forget about it after a while, you won't
74249
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
33 ;; accidentally exit Emacs. To unlock the buffer, just goto the buffer and
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 ;; run toggle-emacs-lock again.
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
36 ;;; Code:
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14040
diff changeset
37
18207
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
38 (defvar emacs-lock-from-exiting nil
73761
7d7c934f1c8f (emacs-lock-from-exiting): Fix typo in docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 68651
diff changeset
39 "Whether Emacs is locked to prevent exiting. See `check-emacs-lock'.")
18207
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
40 (make-variable-buffer-local 'emacs-lock-from-exiting)
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
41
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
42 (defvar emacs-lock-buffer-locked nil
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
43 "Whether a shell or telnet buffer was locked when its process was killed.")
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
44 (make-variable-buffer-local 'emacs-lock-buffer-locked)
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
45 (put 'emacs-lock-buffer-locked 'permanent-local t)
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 (defun check-emacs-lock ()
18207
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
48 "Check if variable `emacs-lock-from-exiting' is t for any buffer.
74249
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
49 If any locked buffer is found, signal error and display the buffer's name."
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
50 (save-excursion
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
51 (dolist (buffer (buffer-list))
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
52 (set-buffer buffer)
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
53 (when emacs-lock-from-exiting
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
54 (error "Emacs is locked from exit due to buffer: %s" (buffer-name))))))
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 (defun toggle-emacs-lock ()
74249
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
57 "Toggle `emacs-lock-from-exiting' for the current buffer.
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 See `check-emacs-lock'."
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 (interactive)
74249
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
60 (setq emacs-lock-from-exiting (not emacs-lock-from-exiting))
18207
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
61 (if emacs-lock-from-exiting
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
62 (message "Buffer is now locked")
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
63 (message "Buffer is now unlocked")))
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
64
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
65 (defun emacs-lock-check-buffer-lock ()
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
66 "Check if variable `emacs-lock-from-exiting' is t for a buffer.
74249
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
67 If the buffer is locked, signal error and display its name."
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
68 (when emacs-lock-from-exiting
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
69 (error "Buffer `%s' is locked, can't delete it" (buffer-name))))
18207
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
70
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
71 ; These next defuns make it so if you exit a shell that is locked, the lock
74249
13b7163b7bff (toggle-emacs-lock): Doc fix. Simplify.
Juanma Barranquero <lekktu@gmail.com>
parents: 73761
diff changeset
72 ; is shut off for that shell so you can exit Emacs. Same for telnet.
18207
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
73 ; Also, if a shell or a telnet buffer was locked and the process killed,
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
74 ; turn the lock back on again if the process is restarted.
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
75
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
76 (defun emacs-lock-shell-sentinel ()
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
77 (set-process-sentinel
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
78 (get-buffer-process (buffer-name)) (function emacs-lock-clear-sentinel)))
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
79
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
80 (defun emacs-lock-clear-sentinel (proc str)
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
81 (if emacs-lock-from-exiting
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
82 (progn
18211
9364da8606f3 Comment fix.
Karl Heuer <kwzh@gnu.org>
parents: 18207
diff changeset
83 (setq emacs-lock-from-exiting nil)
18207
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
84 (setq emacs-lock-buffer-locked t)
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
85 (message "Buffer is now unlocked"))
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
86 (setq emacs-lock-buffer-locked nil)))
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
87
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
88 (defun emacs-lock-was-buffer-locked ()
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
89 (if emacs-lock-buffer-locked
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
90 (setq emacs-lock-from-exiting t)))
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92 (add-hook 'kill-emacs-hook 'check-emacs-lock)
18207
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
93 (add-hook 'kill-buffer-hook 'emacs-lock-check-buffer-lock)
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
94 (add-hook 'shell-mode-hook 'emacs-lock-was-buffer-locked)
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
95 (add-hook 'shell-mode-hook 'emacs-lock-shell-sentinel)
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
96 (add-hook 'telnet-mode-hook 'emacs-lock-was-buffer-locked)
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
97 (add-hook 'telnet-mode-hook 'emacs-lock-shell-sentinel)
10240
72101c74e9e7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98
18207
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
99 (provide 'emacs-lock)
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
100
93975
1e3a407766b9 Fix up comment convention on the arch-tag lines.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 79721
diff changeset
101 ;; arch-tag: 58e6cb43-7cf0-401a-bcb6-4902a0b8bdc1
18207
3b7e375756d2 Added the string "emacs-lock" to all function
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
102 ;;; emacs-lock.el ends here