Commit | Line | Data |
---|---|---|
55535639 | 1 | ;;; novice.el --- handling of disabled commands ("novice mode") for Emacs |
6594deb0 | 2 | |
939a7761 LT |
3 | ;; Copyright (C) 1985, 1986, 1987, 1994, 2002, 2004 |
4 | ;; Free Software Foundation, Inc. | |
9750e079 | 5 | |
e5167999 | 6 | ;; Maintainer: FSF |
d7b4d18f | 7 | ;; Keywords: internal, help |
e5167999 | 8 | |
a2535589 JA |
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 | |
e5167999 | 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
a2535589 JA |
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 | |
b578f267 EN |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | ;; Boston, MA 02111-1307, USA. | |
a2535589 | 25 | |
edbd2f74 ER |
26 | ;;; Commentary: |
27 | ||
28 | ;; This mode provides a hook which is, by default, attached to various | |
29 | ;; putatively dangerous commands in a (probably futile) attempt to | |
30 | ;; prevent lusers from shooting themselves in the feet. | |
31 | ||
aae56ea7 | 32 | ;;; Code: |
a2535589 JA |
33 | |
34 | ;; This function is called (by autoloading) | |
35 | ;; to handle any disabled command. | |
36 | ;; The command is found in this-command | |
37 | ;; and the keys are returned by (this-command-keys). | |
38 | ||
7229064d | 39 | ;;;###autoload |
939a7761 | 40 | (defvar disabled-command-function 'disabled-command-function |
4442951c EN |
41 | "Function to call to handle disabled commands. |
42 | If nil, the feature is disabled, i.e., all commands work normally.") | |
73fa8346 | 43 | |
939a7761 LT |
44 | (defvaralias 'disabled-command-hook 'disabled-command-function) |
45 | (make-obsolete-variable | |
46 | 'disabled-command-hook | |
bf247b6e | 47 | 'disabled-command-function "22.1") |
939a7761 | 48 | |
1c599895 | 49 | ;;;###autoload |
939a7761 | 50 | (defun disabled-command-function (&rest ignore) |
a2535589 JA |
51 | (let (char) |
52 | (save-window-excursion | |
53 | (with-output-to-temp-buffer "*Help*" | |
be29d453 KH |
54 | (let ((keys (this-command-keys))) |
55 | (if (or (eq (aref keys 0) | |
56 | (if (stringp keys) | |
57 | (aref "\M-x" 0) | |
58 | ?\M-x)) | |
59 | (and (>= (length keys) 2) | |
60 | (eq (aref keys 0) meta-prefix-char) | |
61 | (eq (aref keys 1) ?x))) | |
606e6135 RS |
62 | (princ (format "You have invoked the disabled command %s.\n" |
63 | (symbol-name this-command))) | |
64 | (princ (format "You have typed %s, invoking disabled command %s.\n" | |
65 | (key-description keys) (symbol-name this-command))))) | |
a2535589 JA |
66 | ;; Print any special message saying why the command is disabled. |
67 | (if (stringp (get this-command 'disabled)) | |
606e6135 RS |
68 | (princ (get this-command 'disabled)) |
69 | (princ "It is disabled because new users often find it confusing.\n") | |
70 | (princ "Here's the first part of its description:\n\n") | |
71 | ;; Keep only the first paragraph of the documentation. | |
72 | (with-current-buffer "*Help*" | |
73 | (goto-char (point-max)) | |
74 | (let ((start (point))) | |
75 | (save-excursion | |
76 | (princ (or (condition-case () | |
77 | (documentation this-command) | |
78 | (error nil)) | |
79 | "<< not documented >>"))) | |
80 | (if (search-forward "\n\n" nil t) | |
81 | (delete-region (match-beginning 0) (point-max))) | |
82 | (goto-char (point-max)) | |
83 | (indent-rigidly start (point) 3)))) | |
84 | (princ "\n\nDo you want to use this command anyway?\n\n") | |
a2535589 | 85 | (princ "You can now type |
eb4cb84f PJ |
86 | y to try it and enable it (no questions if you use it again). |
87 | n to cancel--don't try the command, and it remains disabled. | |
606e6135 RS |
88 | SPC to try the command just this once, but leave it disabled. |
89 | ! to try it, and enable all disabled commands for this session only.") | |
ea165072 KH |
90 | (save-excursion |
91 | (set-buffer standard-output) | |
92 | (help-mode))) | |
eb4cb84f | 93 | (message "Type y, n, ! or SPC (the space bar): ") |
a2535589 JA |
94 | (let ((cursor-in-echo-area t)) |
95 | (while (not (memq (setq char (downcase (read-char))) | |
c046590e | 96 | '(?! ?y ?n ?\ ))) |
a2535589 | 97 | (ding) |
eb4cb84f | 98 | (message "Please type y, n, ! or SPC (the space bar): ")))) |
4442951c | 99 | (if (= char ?!) |
939a7761 | 100 | (setq disabled-command-function nil)) |
a2535589 | 101 | (if (= char ?y) |
7435bd25 RS |
102 | (if (and user-init-file |
103 | (not (string= "" user-init-file)) | |
104 | (y-or-n-p "Enable command for future editing sessions also? ")) | |
a2535589 JA |
105 | (enable-command this-command) |
106 | (put this-command 'disabled nil))) | |
107 | (if (/= char ?n) | |
108 | (call-interactively this-command)))) | |
109 | ||
7229064d | 110 | ;;;###autoload |
a2535589 JA |
111 | (defun enable-command (command) |
112 | "Allow COMMAND to be executed without special confirmation from now on. | |
7a4d608f LT |
113 | COMMAND must be a symbol. |
114 | This command alters the user's .emacs file so that this will apply | |
a2535589 JA |
115 | to future sessions." |
116 | (interactive "CEnable command: ") | |
117 | (put command 'disabled nil) | |
2308fe27 EZ |
118 | (let ((init-file user-init-file) |
119 | (default-init-file | |
120 | (if (eq system-type 'ms-dos) "~/_emacs" "~/.emacs"))) | |
121 | (when (null init-file) | |
122 | (if (or (file-exists-p default-init-file) | |
123 | (and (eq system-type 'windows-nt) | |
124 | (file-exists-p "~/_emacs"))) | |
125 | ;; Started with -q, i.e. the file containing | |
126 | ;; enabled/disabled commands hasn't been read. Saving | |
127 | ;; settings there would overwrite other settings. | |
128 | (error "Saving settings from \"emacs -q\" would overwrite existing customizations")) | |
129 | (setq init-file default-init-file) | |
49b1a638 EZ |
130 | (if (and (not (file-exists-p init-file)) |
131 | (eq system-type 'windows-nt) | |
132 | (file-exists-p "~/_emacs")) | |
133 | (setq init-file "~/_emacs"))) | |
134 | (save-excursion | |
135 | (set-buffer (find-file-noselect | |
136 | (substitute-in-file-name init-file))) | |
137 | (goto-char (point-min)) | |
138 | (if (search-forward (concat "(put '" (symbol-name command) " ") nil t) | |
139 | (delete-region | |
140 | (progn (beginning-of-line) (point)) | |
141 | (progn (forward-line 1) (point)))) | |
142 | ;; Explicitly enable, in case this command is disabled by default | |
143 | ;; or in case the code we deleted was actually a comment. | |
144 | (goto-char (point-max)) | |
145 | (insert "\n(put '" (symbol-name command) " 'disabled nil)\n") | |
146 | (save-buffer)))) | |
a2535589 | 147 | |
7229064d | 148 | ;;;###autoload |
a2535589 JA |
149 | (defun disable-command (command) |
150 | "Require special confirmation to execute COMMAND from now on. | |
7a4d608f LT |
151 | COMMAND must be a symbol. |
152 | This command alters the user's .emacs file so that this will apply | |
a2535589 JA |
153 | to future sessions." |
154 | (interactive "CDisable command: ") | |
5b817cf2 RS |
155 | (if (not (commandp command)) |
156 | (error "Invalid command name `%s'" command)) | |
a2535589 | 157 | (put command 'disabled t) |
2308fe27 EZ |
158 | (let ((init-file user-init-file) |
159 | (default-init-file | |
160 | (if (eq system-type 'ms-dos) "~/_emacs" "~/.emacs"))) | |
161 | (when (null init-file) | |
162 | (if (or (file-exists-p default-init-file) | |
163 | (and (eq system-type 'windows-nt) | |
164 | (file-exists-p "~/_emacs"))) | |
165 | ;; Started with -q, i.e. the file containing | |
166 | ;; enabled/disabled commands hasn't been read. Saving | |
167 | ;; settings there would overwrite other settings. | |
168 | (error "Saving settings from \"emacs -q\" would overwrite existing customizations")) | |
169 | (setq init-file default-init-file) | |
170 | (if (and (not (file-exists-p init-file)) | |
171 | (eq system-type 'windows-nt) | |
172 | (file-exists-p "~/_emacs")) | |
173 | (setq init-file "~/_emacs"))) | |
174 | (save-excursion | |
175 | (set-buffer (find-file-noselect | |
176 | (substitute-in-file-name init-file))) | |
177 | (goto-char (point-min)) | |
178 | (if (search-forward (concat "(put '" (symbol-name command) " ") nil t) | |
179 | (delete-region | |
180 | (progn (beginning-of-line) (point)) | |
181 | (progn (forward-line 1) (point)))) | |
182 | (goto-char (point-max)) | |
183 | (insert "\n(put '" (symbol-name command) " 'disabled t)\n") | |
184 | (save-buffer)))) | |
a2535589 | 185 | |
896546cd RS |
186 | (provide 'novice) |
187 | ||
c046590e | 188 | ;; arch-tag: f83c0f96-497e-4db6-a430-8703716c6dd9 |
6594deb0 | 189 | ;;; novice.el ends here |