novice.el 7.32 KB
Newer Older
1
;;; novice.el --- handling of disabled commands ("novice mode") for Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1985, 1986, 1987, 1994, 2001, 2002, 2003, 2004,
4
;;   2005, 2006 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: internal, help
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Joseph Arceneaux's avatar
Joseph Arceneaux committed
9 10 11 12
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
13
;; the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
14 15 16 17 18 19 20 21
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
25

26 27 28 29 30 31
;;; Commentary:

;; This mode provides a hook which is, by default, attached to various
;; putatively dangerous commands in a (probably futile) attempt to
;; prevent lusers from shooting themselves in the feet.

32
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
33 34 35 36 37 38

;; This function is called (by autoloading)
;; to handle any disabled command.
;; The command is found in this-command
;; and the keys are returned by (this-command-keys).

Roland McGrath's avatar
Roland McGrath committed
39
;;;###autoload
40
(defvar disabled-command-function 'disabled-command-function
41 42
  "Function to call to handle disabled commands.
If nil, the feature is disabled, i.e., all commands work normally.")
Brian Preble's avatar
Brian Preble committed
43

44
;;;###autoload
45
(define-obsolete-variable-alias 'disabled-command-hook 'disabled-command-function "22.1")
46

Richard M. Stallman's avatar
Richard M. Stallman committed
47 48
;; It is ok here to assume that this-command is a symbol
;; because we won't get called otherwise.
Jim Blandy's avatar
Jim Blandy committed
49
;;;###autoload
50
(defun disabled-command-function (&rest ignore)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
51 52
  (let (char)
    (save-window-excursion
53
     (with-output-to-temp-buffer "*Disabled Command*"
54 55 56 57 58 59 60 61
       (let ((keys (this-command-keys)))
	 (if (or (eq (aref keys 0)
		     (if (stringp keys)
			 (aref "\M-x" 0)
		       ?\M-x))
		 (and (>= (length keys) 2)
		      (eq (aref keys 0) meta-prefix-char)
		      (eq (aref keys 1) ?x)))
62 63 64 65
	     (princ (format "You have invoked the disabled command %s.\n"
			    (symbol-name this-command)))
	   (princ (format "You have typed %s, invoking disabled command %s.\n"
			  (key-description keys) (symbol-name this-command)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
66 67
       ;; Print any special message saying why the command is disabled.
       (if (stringp (get this-command 'disabled))
68 69 70 71
	   (princ (get this-command 'disabled))
	 (princ "It is disabled because new users often find it confusing.\n")
	 (princ "Here's the first part of its description:\n\n")
	 ;; Keep only the first paragraph of the documentation.
72
	 (with-current-buffer "*Disabled Command*"
73 74 75 76 77 78 79 80 81 82 83 84
	   (goto-char (point-max))
	   (let ((start (point)))
	     (save-excursion
	       (princ (or (condition-case ()
			      (documentation this-command)
			    (error nil))
			  "<< not documented >>")))
	     (if (search-forward "\n\n" nil t)
		 (delete-region (match-beginning 0) (point-max)))
	     (goto-char (point-max))
	     (indent-rigidly start (point) 3))))
       (princ "\n\nDo you want to use this command anyway?\n\n")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
85
       (princ "You can now type
86 87
y   to try it and enable it (no questions if you use it again).
n   to cancel--don't try the command, and it remains disabled.
88 89
SPC to try the command just this once, but leave it disabled.
!   to try it, and enable all disabled commands for this session only.")
90 91 92
       (save-excursion
	(set-buffer standard-output)
	(help-mode)))
93
     (message "Type y, n, ! or SPC (the space bar): ")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
94
     (let ((cursor-in-echo-area t))
95 96 97
       (while (progn (setq char (read-event))
		     (or (not (numberp char))
			 (not (memq (downcase char)
98
				    '(?! ?y ?n ?\s ?\C-g)))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
99
	 (ding)
100
	 (message "Please type y, n, ! or SPC (the space bar): "))))
101 102 103
    (setq char (downcase char))
    (if (= char ?\C-g)
	(setq quit-flag t))
104
    (if (= char ?!)
105
	(setq disabled-command-function nil))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
106
    (if (= char ?y)
107 108 109
	(if (and user-init-file
		 (not (string= "" user-init-file))
		 (y-or-n-p "Enable command for future editing sessions also? "))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
110 111 112 113 114
	    (enable-command this-command)
	  (put this-command 'disabled nil)))
    (if (/= char ?n)
	(call-interactively this-command))))

Roland McGrath's avatar
Roland McGrath committed
115
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
116 117
(defun enable-command (command)
  "Allow COMMAND to be executed without special confirmation from now on.
118 119
COMMAND must be a symbol.
This command alters the user's .emacs file so that this will apply
Joseph Arceneaux's avatar
Joseph Arceneaux committed
120 121 122
to future sessions."
  (interactive "CEnable command: ")
  (put command 'disabled nil)
123 124 125 126 127 128 129 130 131 132 133 134
  (let ((init-file user-init-file)
	(default-init-file
	  (if (eq system-type 'ms-dos) "~/_emacs" "~/.emacs")))
    (when (null init-file)
      (if (or (file-exists-p default-init-file)
	      (and (eq system-type 'windows-nt)
		   (file-exists-p "~/_emacs")))
	  ;; Started with -q, i.e. the file containing
	  ;; enabled/disabled commands hasn't been read.  Saving
	  ;; settings there would overwrite other settings.
	  (error "Saving settings from \"emacs -q\" would overwrite existing customizations"))
      (setq init-file default-init-file)
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
      (if (and (not (file-exists-p init-file))
	       (eq system-type 'windows-nt)
	       (file-exists-p "~/_emacs"))
	  (setq init-file "~/_emacs")))
    (save-excursion
      (set-buffer (find-file-noselect
		   (substitute-in-file-name init-file)))
      (goto-char (point-min))
      (if (search-forward (concat "(put '" (symbol-name command) " ") nil t)
	  (delete-region
	   (progn (beginning-of-line) (point))
	   (progn (forward-line 1) (point))))
      ;; Explicitly enable, in case this command is disabled by default
      ;; or in case the code we deleted was actually a comment.
      (goto-char (point-max))
      (insert "\n(put '" (symbol-name command) " 'disabled nil)\n")
      (save-buffer))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
152

Roland McGrath's avatar
Roland McGrath committed
153
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
154 155
(defun disable-command (command)
  "Require special confirmation to execute COMMAND from now on.
156 157
COMMAND must be a symbol.
This command alters the user's .emacs file so that this will apply
Joseph Arceneaux's avatar
Joseph Arceneaux committed
158 159
to future sessions."
  (interactive "CDisable command: ")
160 161
  (if (not (commandp command))
      (error "Invalid command name `%s'" command))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
162
  (put command 'disabled t)
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
  (let ((init-file user-init-file)
	(default-init-file
	  (if (eq system-type 'ms-dos) "~/_emacs" "~/.emacs")))
    (when (null init-file)
      (if (or (file-exists-p default-init-file)
	      (and (eq system-type 'windows-nt)
		   (file-exists-p "~/_emacs")))
	  ;; Started with -q, i.e. the file containing
	  ;; enabled/disabled commands hasn't been read.  Saving
	  ;; settings there would overwrite other settings.
	  (error "Saving settings from \"emacs -q\" would overwrite existing customizations"))
      (setq init-file default-init-file)
      (if (and (not (file-exists-p init-file))
	       (eq system-type 'windows-nt)
	       (file-exists-p "~/_emacs"))
	  (setq init-file "~/_emacs")))
    (save-excursion
      (set-buffer (find-file-noselect
		   (substitute-in-file-name init-file)))
      (goto-char (point-min))
      (if (search-forward (concat "(put '" (symbol-name command) " ") nil t)
	  (delete-region
	   (progn (beginning-of-line) (point))
186 187 188 189
	   (progn (forward-line 1) (point)))
	(goto-char (point-max))
	(insert ?\n))
      (insert "(put '" (symbol-name command) " 'disabled t)\n")
190
      (save-buffer))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
191

Richard M. Stallman's avatar
Richard M. Stallman committed
192 193
(provide 'novice)

194
;; arch-tag: f83c0f96-497e-4db6-a430-8703716c6dd9
Eric S. Raymond's avatar
Eric S. Raymond committed
195
;;; novice.el ends here