help.el 23.5 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; help.el --- help commands for Emacs

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

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

Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10 11
;; 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
12
;; the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
13 14 15 16 17 18 19 20
;; 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
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
24

25 26 27 28 29
;;; Commentary:

;; This code implements GNU Emac's on-line help system, the one invoked by
;;`M-x help-for-help'.

Eric S. Raymond's avatar
Eric S. Raymond committed
30 31
;;; Code:

32 33
;; Get the macro make-help-screen when this is compiled,
;; or run interpreted, but not when the compiled code is loaded.
34
(eval-when-compile (require 'help-macro))
35

Richard M. Stallman's avatar
Richard M. Stallman committed
36 37 38
(defvar help-map (make-sparse-keymap)
  "Keymap for characters following the Help key.")

Karl Heuer's avatar
Karl Heuer committed
39 40 41
(defvar help-mode-map (make-sparse-keymap)
  "Keymap for help mode.")

Eric S. Raymond's avatar
Eric S. Raymond committed
42
(define-key global-map (char-to-string help-char) 'help-command)
43 44
(define-key global-map [help] 'help-command)
(define-key global-map [f1] 'help-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
45 46
(fset 'help-command help-map)

Eric S. Raymond's avatar
Eric S. Raymond committed
47
(define-key help-map (char-to-string help-char) 'help-for-help)
48 49
(define-key help-map [help] 'help-for-help)
(define-key help-map [f1] 'help-for-help)
Richard M. Stallman's avatar
Richard M. Stallman committed
50 51 52 53 54
(define-key help-map "?" 'help-for-help)

(define-key help-map "\C-c" 'describe-copying)
(define-key help-map "\C-d" 'describe-distribution)
(define-key help-map "\C-w" 'describe-no-warranty)
55
(define-key help-map "\C-p" 'describe-project)
Richard M. Stallman's avatar
Richard M. Stallman committed
56 57 58 59 60 61 62 63 64 65
(define-key help-map "a" 'command-apropos)

(define-key help-map "b" 'describe-bindings)

(define-key help-map "c" 'describe-key-briefly)
(define-key help-map "k" 'describe-key)

(define-key help-map "d" 'describe-function)
(define-key help-map "f" 'describe-function)

66 67
(define-key help-map "F" 'view-emacs-FAQ)

Richard M. Stallman's avatar
Richard M. Stallman committed
68
(define-key help-map "i" 'info)
Jim Blandy's avatar
Jim Blandy committed
69 70
(define-key help-map "\C-f" 'Info-goto-emacs-command-node)
(define-key help-map "\C-k" 'Info-goto-emacs-key-command-node)
Richard M. Stallman's avatar
Richard M. Stallman committed
71 72 73 74 75 76 77 78

(define-key help-map "l" 'view-lossage)

(define-key help-map "m" 'describe-mode)

(define-key help-map "\C-n" 'view-emacs-news)
(define-key help-map "n" 'view-emacs-news)

79
(define-key help-map "p" 'finder-by-keyword)
80 81
(autoload 'finder-by-keyword "finder"
  "Find packages matching a given keyword." t)
82

Richard M. Stallman's avatar
Richard M. Stallman committed
83 84 85 86 87 88 89 90
(define-key help-map "s" 'describe-syntax)

(define-key help-map "t" 'help-with-tutorial)

(define-key help-map "w" 'where-is)

(define-key help-map "v" 'describe-variable)

Richard M. Stallman's avatar
Richard M. Stallman committed
91 92
(define-key help-map "q" 'help-quit)

Simon Marshall's avatar
Simon Marshall committed
93
(defvar help-font-lock-keywords
94 95 96 97 98 99 100 101 102 103 104 105 106 107
  (eval-when-compile
    (let ((name-char "[-+a-zA-Z0-9_*]") (sym-char "[-+a-zA-Z0-9_:*]"))
      (list
       ;;
       ;; The symbol itself.
       (list (concat "\\`\\(" name-char "+\\)\\(\\(:\\)\\|\\('\\)\\)")
	     '(1 font-lock-function-name-face))
       ;;
       ;; Words inside `' which tend to be symbol names.
       (list (concat "`\\(" sym-char sym-char "+\\)'")
	     1 'font-lock-reference-face t)
       ;;
       ;; CLisp `:' keywords as references.
       (list (concat "\\<:" sym-char "+\\>") 0 'font-lock-reference-face t))))
Simon Marshall's avatar
Simon Marshall committed
108 109
  "Default expressions to highlight in Help mode.")

Karl Heuer's avatar
Karl Heuer committed
110 111 112 113 114 115 116 117 118 119
(defun help-mode ()
  "Major mode for viewing help text.
Entry to this mode runs the normal hook `help-mode-hook'.
Commands:
\\{help-mode-map}"
  (interactive)
  (kill-all-local-variables)
  (use-local-map help-mode-map)
  (setq mode-name "Help")
  (setq major-mode 'help-mode)
Simon Marshall's avatar
Simon Marshall committed
120
  (make-local-variable 'font-lock-defaults)
121
  (setq font-lock-defaults '(help-font-lock-keywords))
122
  (view-mode)
Karl Heuer's avatar
Karl Heuer committed
123 124
  (run-hooks 'help-mode-hook))

Richard M. Stallman's avatar
Richard M. Stallman committed
125 126 127 128
(defun help-quit ()
  (interactive)
  nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
129 130 131 132 133 134 135 136 137 138
(defun help-with-tutorial ()
  "Select the Emacs learn-by-doing tutorial."
  (interactive)
  (let ((file (expand-file-name "~/TUTORIAL")))
    (delete-other-windows)
    (if (get-file-buffer file)
	(switch-to-buffer (get-file-buffer file))
      (switch-to-buffer (create-file-buffer file))
      (setq buffer-file-name file)
      (setq default-directory (expand-file-name "~/"))
Jim Blandy's avatar
Jim Blandy committed
139
      (setq buffer-auto-save-file-name nil)
Jim Blandy's avatar
Jim Blandy committed
140
      (insert-file-contents (expand-file-name "TUTORIAL" data-directory))
Richard M. Stallman's avatar
Richard M. Stallman committed
141 142 143 144
      (goto-char (point-min))
      (search-forward "\n<<")
      (beginning-of-line)
      (delete-region (point) (progn (end-of-line) (point)))
145
      (let ((n (- (window-height (selected-window))
Richard M. Stallman's avatar
Richard M. Stallman committed
146
		  (count-lines (point-min) (point))
147
		  6)))
148
	(if (< n 12)
149 150 151 152 153 154
	    (newline n)
	  ;; Some people get confused by the large gap.
	  (newline (/ n 2))
	  (insert "[Middle of page left blank for didactic purposes.  "
		  "Text continues below]")
	  (newline (- n (/ n 2)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
155 156 157 158 159 160
      (goto-char (point-min))
      (set-buffer-modified-p nil))))

(defun describe-key-briefly (key)
  "Print the name of the function KEY invokes.  KEY is a string."
  (interactive "kDescribe key briefly: ")
161 162 163 164 165 166 167
  ;; If this key seq ends with a down event, discard the
  ;; following click or drag event.  Otherwise that would
  ;; erase the message.
  (let ((type (aref key (1- (length key)))))
    (if (listp type) (setq type (car type)))
    (and (symbolp type)
	 (memq 'down (event-modifiers type))
168
	 (read-event)))
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
  (save-excursion
    (let ((modifiers (event-modifiers (aref key 0)))
	  window position)
      ;; For a mouse button event, go to the button it applies to
      ;; to get the right key bindings.  And go to the right place
      ;; in case the keymap depends on where you clicked.
      (if (or (memq 'click modifiers) (memq 'down modifiers)
	      (memq 'drag modifiers))
	  (setq window (posn-window (event-start (aref key 0)))
		position (posn-point (event-start (aref key 0)))))
      (if (windowp window)
	  (progn
	    (set-buffer (window-buffer window))
	    (goto-char position)))
      ;; Ok, now look up the key and name the command.
      (let ((defn (key-binding key)))
	(if (or (null defn) (integerp defn))
	    (message "%s is undefined" (key-description key))
	  (message (if (windowp window)
		       "%s at that spot runs the command %s"
		     "%s runs the command %s")
		   (key-description key)
		   (if (symbolp defn) defn (prin1-to-string defn))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
192 193 194 195 196 197

(defun print-help-return-message (&optional function)
  "Display or return message saying how to restore windows after help command.
Computes a message and applies the optional argument FUNCTION to it.
If FUNCTION is nil, applies `message' to it, thus printing it."
  (and (not (get-buffer-window standard-output))
198 199 200
       (let ((first-message
	      (cond ((or (member (buffer-name standard-output)
				 special-display-buffer-names)
201 202
			 (assoc (buffer-name standard-output)
				special-display-buffer-names)
203 204 205 206
			 (let (found
			       (tail special-display-regexps)
			       (name (buffer-name standard-output)))
			   (while (and tail (not found))
Karl Heuer's avatar
Karl Heuer committed
207
			     (if (or (and (consp (car tail))
208 209 210
					  (string-match (car (car tail)) name))
				     (and (stringp (car tail))
					  (string-match (car tail) name)))
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
				 (setq found t))
			     (setq tail (cdr tail)))
			   found))
		     ;; If the help output buffer is a special display buffer,
		     ;; don't say anything about how to get rid of it.
		     ;; First of all, the user will do that with the window
		     ;; manager, not with Emacs.
		     ;; Secondly, the buffer has not been displayed yet,
		     ;; so we don't know whether its frame will be selected.
		     ;; Even the message about scrolling the help
		     ;; might be wrong, but it seems worth showing it anyway.
		     nil)
		    ((not (one-window-p t))
		     "Type \\[switch-to-buffer-other-window] RET to restore the other window.")
		    (pop-up-windows
		     "Type \\[delete-other-windows] to remove help window.")
		    (t
		     "Type \\[switch-to-buffer] RET to remove help window."))))
	 (funcall (or function 'message)
		  (concat
		   (if first-message
		       (substitute-command-keys first-message)
		     "")
		   (if first-message "  " "")
235 236
		   ;; If the help buffer will go in a separate frame,
		   ;; it's no use mentioning a command to scroll, so don't.
237
		   (if (or (member (buffer-name standard-output)
238
				   special-display-buffer-names)
239 240
			   (assoc (buffer-name standard-output)
				  special-display-buffer-names)
241
			   (memq t (mapcar '(lambda (elt)
242 243
					      (if (consp elt)
						  (setq elt (car elt)))
244
					      (string-match elt (buffer-name standard-output)))
245 246 247 248
					   special-display-regexps)))
		       nil
		     (if (or (member (buffer-name standard-output)
				     same-window-buffer-names)
249 250
			     (assoc (buffer-name standard-output)
				    same-window-buffer-names)
251
			     (memq t (mapcar '(lambda (elt)
252 253
						(if (consp elt)
						    (setq elt (car elt)))
254 255 256 257 258 259
						(string-match elt (buffer-name standard-output)))
					     same-window-regexps)))
			 ;; Say how to scroll this window.
			 (substitute-command-keys
			  "\\[scroll-up] to scroll the help.")
		       ;; Say how to scroll some other window.
260
		       (substitute-command-keys
261
			"\\[scroll-other-window] to scroll the help."))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
262 263 264 265

(defun describe-key (key)
  "Display documentation of the function invoked by KEY.  KEY is a string."
  (interactive "kDescribe key: ")
266 267 268 269 270 271 272 273
  ;; If this key seq ends with a down event, discard the
  ;; following click or drag event.  Otherwise that would
  ;; erase the message.
  (let ((type (aref key (1- (length key)))))
    (if (listp type) (setq type (car type)))
    (and (symbolp type)
	 (memq 'down (event-modifiers type))
	 (read-event)))
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
  (save-excursion
    (let ((modifiers (event-modifiers (aref key 0)))
	  window position)
      ;; For a mouse button event, go to the button it applies to
      ;; to get the right key bindings.  And go to the right place
      ;; in case the keymap depends on where you clicked.
      (if (or (memq 'click modifiers) (memq 'down modifiers)
	      (memq 'drag modifiers))
	  (setq window (posn-window (event-start (aref key 0)))
		position (posn-point (event-start (aref key 0)))))
      (if (windowp window)
	  (progn
	    (set-buffer (window-buffer window))
	    (goto-char position)))
      (let ((defn (key-binding key)))
	(if (or (null defn) (integerp defn))
	    (message "%s is undefined" (key-description key))
	  (with-output-to-temp-buffer "*Help*"
	    (princ (key-description key))
	    (if (windowp window)
		(princ " at that spot"))
	    (princ " runs the command ")
	    (prin1 defn)
	    (princ ":\n")
298 299 300 301 302
	    (let ((doc (documentation defn)))
	      (if doc
		  (progn (terpri)
			 (princ doc))
		(princ "not documented")))
303 304 305 306
	    (save-excursion
	      (set-buffer standard-output)
	      (help-mode))
	    (print-help-return-message)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
307

308 309
(defun describe-mode ()
  "Display documentation of current major mode and minor modes.
Richard M. Stallman's avatar
Richard M. Stallman committed
310
For this to work correctly for a minor mode, the mode's indicator variable
311
\(listed in `minor-mode-alist') must also be a function whose documentation
Richard M. Stallman's avatar
Richard M. Stallman committed
312
describes the minor mode."
313
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
314
  (with-output-to-temp-buffer "*Help*"
315
    (let ((minor-modes minor-mode-alist)
316
	  (first t)
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
	  (locals (buffer-local-variables)))
      (while minor-modes
	(let* ((minor-mode (car (car minor-modes)))
	       (indicator (car (cdr (car minor-modes))))
	       (local-binding (assq minor-mode locals)))
	  ;; Document a minor mode if it is listed in minor-mode-alist,
	  ;; bound locally in this buffer, non-nil, and has a function
	  ;; definition.
	  (if (and local-binding
		   (cdr local-binding)
		   (fboundp minor-mode))
	      (let ((pretty-minor-mode minor-mode))
		(if (string-match "-mode$" (symbol-name minor-mode))
		    (setq pretty-minor-mode
			  (capitalize
			   (substring (symbol-name minor-mode)
				      0 (match-beginning 0)))))
		(while (and indicator (symbolp indicator))
		  (setq indicator (symbol-value indicator)))
336 337 338 339
		(if first
		    (princ "The minor modes are described first,
followed by the major mode, which is described on the last page.\n\f\n"))
		(setq first nil)
340 341 342 343 344
		(princ (format "%s minor mode (%s):\n"
			       pretty-minor-mode
			       (if indicator
				   (format "indicator%s" indicator)
				 "no indicator")))
345
		(princ (documentation minor-mode))
346
		(princ "\n\f\n"))))
347
	(setq minor-modes (cdr minor-modes))))
Richard M. Stallman's avatar
Richard M. Stallman committed
348
    (princ mode-name)
349
    (princ " mode:\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
350
    (princ (documentation major-mode))
351 352 353
    (save-excursion
      (set-buffer standard-output)
      (help-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
354 355 356 357 358 359 360 361 362
    (print-help-return-message)))

;; So keyboard macro definitions are documented correctly
(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))

(defun describe-distribution ()
  "Display info on how to obtain the latest version of GNU Emacs."
  (interactive)
  (find-file-read-only
Jim Blandy's avatar
Jim Blandy committed
363
   (expand-file-name "DISTRIB" data-directory)))
Richard M. Stallman's avatar
Richard M. Stallman committed
364 365 366 367 368

(defun describe-copying ()
  "Display info on how you may redistribute copies of GNU Emacs."
  (interactive)
  (find-file-read-only
Jim Blandy's avatar
Jim Blandy committed
369
   (expand-file-name "COPYING" data-directory))
Richard M. Stallman's avatar
Richard M. Stallman committed
370 371
  (goto-char (point-min)))

372 373 374 375 376 377 378
(defun describe-project ()
  "Display info on the GNU project."
  (interactive)
  (find-file-read-only
   (expand-file-name "GNU" data-directory))
  (goto-char (point-min)))

Richard M. Stallman's avatar
Richard M. Stallman committed
379 380 381 382 383 384 385 386
(defun describe-no-warranty ()
  "Display info on all the kinds of warranty Emacs does NOT have."
  (interactive)
  (describe-copying)
  (let (case-fold-search)
    (search-forward "NO WARRANTY")
    (recenter 0)))

387
(defun describe-prefix-bindings ()
388 389 390
  "Describe the bindings of the prefix used to reach this command.
The prefix described consists of all but the last event
of the key sequence that ran this command."
391
  (interactive)
392 393 394 395 396 397 398 399 400 401
  (let* ((key (this-command-keys)))
    (describe-bindings
     (if (stringp key)
	 (substring key 0 (1- (length key)))
       (let ((prefix (make-vector (1- (length key)) nil))
	     (i 0))
	 (while (< i (length prefix))
	   (aset prefix i (aref key i))
	   (setq i (1+ i)))
	 prefix)))))
402 403
;; Make C-h after a prefix, when not specifically bound, 
;; run describe-prefix-bindings.
404 405
(setq prefix-help-command 'describe-prefix-bindings)

Richard M. Stallman's avatar
Richard M. Stallman committed
406 407 408
(defun view-emacs-news ()
  "Display info on recent changes to Emacs."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
409
  (find-file-read-only (expand-file-name "NEWS" data-directory)))
Richard M. Stallman's avatar
Richard M. Stallman committed
410

411 412 413 414 415
(defun view-emacs-FAQ ()
  "Display the Emacs Frequently Asked Questions (FAQ) file."
  (interactive)
  (find-file-read-only (expand-file-name "FAQ" data-directory)))

Richard M. Stallman's avatar
Richard M. Stallman committed
416 417 418 419
(defun view-lossage ()
  "Display last 100 input keystrokes."
  (interactive)
  (with-output-to-temp-buffer "*Help*"
420 421 422 423 424 425 426 427
    (princ (mapconcat (function (lambda (key)
				  (if (or (integerp key)
					  (symbolp key)
					  (listp key))
				      (single-key-description key)
				    (prin1-to-string key nil))))
		      (recent-keys)
		      " "))
Richard M. Stallman's avatar
Richard M. Stallman committed
428 429 430 431 432
    (save-excursion
      (set-buffer standard-output)
      (goto-char (point-min))
      (while (progn (move-to-column 50) (not (eobp)))
	(search-forward " " nil t)
433 434
	(insert "\n"))
      (help-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
435 436
    (print-help-return-message)))

Richard M. Stallman's avatar
Richard M. Stallman committed
437
(defalias 'help 'help-for-help)
438
(make-help-screen help-for-help
439
  "a b c f C-f i k C-k l m n p s t v w C-c C-d C-n C-w, or ? for more help:"
440
  "You have typed \\[help-command], the help character.  Type a Help option:
441
\(Use SPC or DEL to scroll through this text.  Type \\<help-map>\\[help-quit] to exit the Help command.)
Richard M. Stallman's avatar
Richard M. Stallman committed
442

443 444 445
a  command-apropos.  Give a substring, and see a list of commands
	(functions interactively callable) that contain
	that substring.  See also the  apropos  command.
446 447
b  describe-bindings.  Display table of all key bindings.
c  describe-key-briefly.  Type a command key sequence;
448
	it prints the function name that sequence runs.
449
f  describe-function.  Type a function name and get documentation of it.
450 451
C-f Info-goto-emacs-command-node.  Type a function name;
	it takes you to the Info node for that command.
452
F  view-emacs-FAQ.  Shows emacs frequently asked questions file.
453 454
i  info. The  info  documentation reader.
k  describe-key.  Type a command key sequence;
455 456 457
	it displays the full documentation.
C-k Info-goto-emacs-key-command-node.  Type a command key sequence;
	it takes you to the Info node for the command bound to that key.
458 459
l  view-lossage.  Shows last 100 characters you typed.
m  describe-mode.  Print documentation of current major mode,
460
	which describes the commands peculiar to it.
461 462 463 464 465
n  view-emacs-news.  Shows emacs news file.
p  finder-by-keyword. Find packages matching a given topic keyword.
s  describe-syntax.  Display contents of syntax table, plus explanations
t  help-with-tutorial.  Select the Emacs learn-by-doing tutorial.
v  describe-variable.  Type name of a variable;
466
	it displays the variable's documentation and value.
467
w  where-is.  Type command name; it prints which keystrokes
468
	invoke that command.
Richard M. Stallman's avatar
Richard M. Stallman committed
469 470 471
C-c print Emacs copying permission (General Public License).
C-d print Emacs ordering information.
C-n print news of recent Emacs changes.
472
C-p print information about the GNU project.
Richard M. Stallman's avatar
Richard M. Stallman committed
473
C-w print information on absence of warranty for GNU Emacs."
474
  help-map)
Richard M. Stallman's avatar
Richard M. Stallman committed
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490

;; Return a function which is called by the list containing point.
;; If that gives no function, return a function whose name is around point.
;; If that doesn't give a function, return nil.
(defun function-called-at-point ()
  (or (condition-case ()
	  (save-excursion
	    (save-restriction
	      (narrow-to-region (max (point-min) (- (point) 1000)) (point-max))
	      (backward-up-list 1)
	      (forward-char 1)
	      (let (obj)
		(setq obj (read (current-buffer)))
		(and (symbolp obj) (fboundp obj) obj))))
	(error nil))
      (condition-case ()
491 492 493 494 495 496 497 498 499 500 501 502
	  (let ((stab (syntax-table)))
	    (unwind-protect
		(save-excursion
		  (set-syntax-table emacs-lisp-mode-syntax-table)
		  (or (not (zerop (skip-syntax-backward "_w")))
		      (eq (char-syntax (following-char)) ?w)
		      (eq (char-syntax (following-char)) ?_)
		      (forward-sexp -1))
		  (skip-chars-forward "'")
		  (let ((obj (read (current-buffer))))
		    (and (symbolp obj) (fboundp obj) obj)))
	      (set-syntax-table stab)))
Richard M. Stallman's avatar
Richard M. Stallman committed
503 504
	(error nil))))

505 506 507 508 509 510 511 512 513
(defun describe-function-find-file (function)
  (let ((files load-history)
	file functions)
    (while files
      (if (memq function (cdr (car files)))
	  (setq file (car (car files)) files nil))
      (setq files (cdr files)))
    file))

Richard M. Stallman's avatar
Richard M. Stallman committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
(defun describe-function (function)
  "Display the full documentation of FUNCTION (a symbol)."
  (interactive
   (let ((fn (function-called-at-point))
	 (enable-recursive-minibuffers t)	     
	 val)
     (setq val (completing-read (if fn
				    (format "Describe function (default %s): " fn)
				  "Describe function: ")
				obarray 'fboundp t))
     (list (if (equal val "")
	       fn (intern val)))))
  (with-output-to-temp-buffer "*Help*"
    (prin1 function)
    (princ ": ")
    (let* ((def (symbol-function function))
530
	   file-name
Richard M. Stallman's avatar
Richard M. Stallman committed
531
	   (beg (if (commandp def) "an interactive " "a ")))
532 533
      (princ (cond ((or (stringp def)
			(vectorp def))
534
		    "a keyboard macro")
Richard M. Stallman's avatar
Richard M. Stallman committed
535
		   ((subrp def)
536
		    (concat beg "built-in function"))
Jim Blandy's avatar
Jim Blandy committed
537
		   ((byte-code-function-p def)
538
		    (concat beg "compiled Lisp function"))
Richard M. Stallman's avatar
Richard M. Stallman committed
539
		   ((symbolp def)
540
		    (format "alias for `%s'" def))
Richard M. Stallman's avatar
Richard M. Stallman committed
541
		   ((eq (car-safe def) 'lambda)
542
		    (concat beg "Lisp function"))
Richard M. Stallman's avatar
Richard M. Stallman committed
543
		   ((eq (car-safe def) 'macro)
544
		    "a Lisp macro")
Richard M. Stallman's avatar
Richard M. Stallman committed
545
		   ((eq (car-safe def) 'mocklisp)
546
		    "a mocklisp function")
Richard M. Stallman's avatar
Richard M. Stallman committed
547
		   ((eq (car-safe def) 'autoload)
548
		    (setq file-name (nth 1 def))
549
		    (format "%s autoloaded Lisp %s"
550
			    (if (commandp def) "an interactive" "an")
Richard M. Stallman's avatar
Richard M. Stallman committed
551
			    (if (nth 4 def) "macro" "function")
552
			    ))
Richard M. Stallman's avatar
Richard M. Stallman committed
553
		   (t "")))
554 555 556 557 558 559 560 561 562
      (or file-name
	  (setq file-name (describe-function-find-file function)))
      (if file-name
	  (progn
	    (princ " in `")
	    ;; We used to add .el to the file name,
	    ;; but that's completely wrong when the user used load-file.
	    (princ file-name)
	    (princ "'")))
563
      (princ ".")
564
      (terpri)
565 566 567 568 569 570 571 572 573 574 575 576 577 578
      (let ((arglist (cond ((byte-code-function-p def)
			    (car (append def nil)))
			   ((eq (car-safe def) 'lambda)
			    (nth 1 def))
			   (t t))))
	(if (listp arglist)
	    (progn
	      (princ (cons function
			   (mapcar (lambda (arg)
				     (if (memq arg '(&optional &rest))
					 arg
				       (intern (upcase (symbol-name arg)))))
				   arglist)))
	      (terpri))))
579 580 581 582 583
      (let ((doc (documentation function)))
	(if doc
	    (progn (terpri)
		   (princ doc))
	  (princ "not documented"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
584
    (print-help-return-message)
585 586 587 588 589
    (save-excursion
      (set-buffer standard-output)
      (help-mode)
      ;; Return the text we displayed.
      (buffer-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
590 591 592

(defun variable-at-point ()
  (condition-case ()
593 594 595 596 597 598 599 600 601 602 603 604
      (let ((stab (syntax-table)))
	(unwind-protect
	    (save-excursion
	      (set-syntax-table emacs-lisp-mode-syntax-table)
	      (or (not (zerop (skip-syntax-backward "_w")))
		  (eq (char-syntax (following-char)) ?w)
		  (eq (char-syntax (following-char)) ?_)
		  (forward-sexp -1))
	      (skip-chars-forward "'")
	      (let ((obj (read (current-buffer))))
		(and (symbolp obj) (boundp obj) obj)))
	  (set-syntax-table stab)))
Richard M. Stallman's avatar
Richard M. Stallman committed
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
    (error nil)))

(defun describe-variable (variable)
  "Display the full documentation of VARIABLE (a symbol).
Returns the documentation as a string, also."
  (interactive 
   (let ((v (variable-at-point))
	 (enable-recursive-minibuffers t)
	 val)
     (setq val (completing-read (if v
				    (format "Describe variable (default %s): " v)
				  "Describe variable: ")
				obarray 'boundp t))
     (list (if (equal val "")
	       v (intern val)))))
  (with-output-to-temp-buffer "*Help*"
    (prin1 variable)
    (if (not (boundp variable))
623 624
        (princ " is void")
      (princ "'s value is ")
Richard M. Stallman's avatar
Richard M. Stallman committed
625
      (prin1 (symbol-value variable)))
626
    (terpri)
627
    (if (local-variable-p variable)
628 629 630 631 632 633 634
	(progn
	  (princ (format "Local in buffer %s; " (buffer-name)))
	  (if (not (default-boundp variable))
	      (princ "globally void")
	    (princ "global value is ")
	    (prin1 (default-value variable)))
	  (terpri)))
635
    (terpri)
Richard M. Stallman's avatar
Richard M. Stallman committed
636 637 638
    (princ "Documentation:")
    (terpri)
    (let ((doc (documentation-property variable 'variable-documentation)))
639
      (princ (or doc "not documented as a variable.")))
Richard M. Stallman's avatar
Richard M. Stallman committed
640
    (print-help-return-message)
641 642 643 644 645
    (save-excursion
      (set-buffer standard-output)
      (help-mode)
      ;; Return the text we displayed.
      (buffer-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
646

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
(defun where-is (definition)
  "Print message listing key sequences that invoke specified command.
Argument is a command definition, usually a symbol with a function definition."
  (interactive
   (let ((fn (function-called-at-point))
	 (enable-recursive-minibuffers t)	     
	 val)
     (setq val (completing-read (if fn
				    (format "Where is command (default %s): " fn)
				  "Where is command: ")
				obarray 'fboundp t))
     (list (if (equal val "")
	       fn (intern val)))))
  (let* ((keys (where-is-internal definition overriding-local-map nil nil))
	 (keys1 (mapconcat 'key-description keys ", ")))
    (if (> (length keys1) 0)
	(message "%s is on %s" definition keys1)
      (message "%s is not on any key" definition)))
  nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
(defun locate-library (library &optional nosuffix)
  "Show the full path name of Emacs library LIBRARY.
This command searches the directories in `load-path' like `M-x load-library'
to find the file that `M-x load-library RET LIBRARY RET' would load.
Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el'
to the specified name LIBRARY (a la calling `load' instead of `load-library')."
  (interactive "sLocate library: ")
  (catch 'answer
    (mapcar
     '(lambda (dir)
	(mapcar
	 '(lambda (suf)
	    (let ((try (expand-file-name (concat library suf) dir)))
	      (and (file-readable-p try)
		   (null (file-directory-p try))
		   (progn
		     (message "Library is file %s" try)
		     (throw 'answer try)))))
	 (if nosuffix '("") '(".elc" ".el" ""))))
     load-path)
    (message "No library %s in search path" library)
    nil))
Eric S. Raymond's avatar
Eric S. Raymond committed
689 690

;;; help.el ends here