1 ;;; help-funs.el --- Complex help functions
3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001
4 ;; Free Software Foundation, Inc.
7 ;; Keywords: help, internal
9 ;; This file is part of GNU Emacs.
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
13 ;; the Free Software Foundation; either version 2, or (at your option)
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.
21 ;; You should have received a copy of the GNU General Public License
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.
28 ;; This file contains those help commands which are complicated, and
29 ;; which may not be used in every session. For example
30 ;; `describe-function' will probably be heavily used when doing elisp
31 ;; programming, but not if just editing C files. Simpler help commands
40 (defun help-with-tutorial (&optional arg
)
41 "Select the Emacs learn-by-doing tutorial.
42 If there is a tutorial version written in the language
43 of the selected language environment, that version is used.
44 If there's no tutorial in that language, `TUTORIAL' is selected.
45 With arg, you are asked to choose which language."
48 (read-language-name 'tutorial
"Language: " "English")
49 (if (get-language-info current-language-environment
'tutorial
)
50 current-language-environment
53 (setq filename
(get-language-info lang
'tutorial
))
54 (setq file
(expand-file-name (concat "~/" filename
)))
55 (delete-other-windows)
56 (if (get-file-buffer file
)
57 (switch-to-buffer (get-file-buffer file
))
58 (switch-to-buffer (create-file-buffer file
))
59 (setq buffer-file-name file
)
60 (setq default-directory
(expand-file-name "~/"))
61 (setq buffer-auto-save-file-name nil
)
62 (insert-file-contents (expand-file-name filename data-directory
))
63 (goto-char (point-min))
64 (search-forward "\n<<")
66 (delete-region (point) (progn (end-of-line) (point)))
67 (let ((n (- (window-height (selected-window))
68 (count-lines (point-min) (point))
72 ;; Some people get confused by the large gap.
74 (insert "[Middle of page left blank for didactic purposes. "
75 "Text continues below]")
76 (newline (- n
(/ n
2)))))
77 (goto-char (point-min))
78 (set-buffer-modified-p nil
))))
81 (defun locate-library (library &optional nosuffix path interactive-call
)
82 "Show the precise file name of Emacs library LIBRARY.
83 This command searches the directories in `load-path' like `M-x load-library'
84 to find the file that `M-x load-library RET LIBRARY RET' would load.
85 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
86 to the specified name LIBRARY.
88 If the optional third arg PATH is specified, that list of directories
89 is used instead of `load-path'.
91 When called from a program, the file name is normaly returned as a
92 string. When run interactively, the argument INTERACTIVE-CALL is t,
93 and the file name is displayed in the echo area."
94 (interactive (list (read-string "Locate library: ")
98 (dolist (dir (or path load-path
))
99 (dolist (suf (append (unless nosuffix load-suffixes
) '("")))
100 (let ((try (expand-file-name (concat library suf
) dir
)))
101 (and (file-readable-p try
)
102 (null (file-directory-p try
))
105 (message "Library is file %s" (abbreviate-file-name try
)))
106 (throw 'answer try
))))))
108 (message "No library %s in search path" library
))
115 (defun describe-function (function)
116 "Display the full documentation of FUNCTION (a symbol)."
118 (let ((fn (function-called-at-point))
119 (enable-recursive-minibuffers t
)
121 (setq val
(completing-read (if fn
122 (format "Describe function (default %s): " fn
)
123 "Describe function: ")
124 obarray
'fboundp t nil nil
(symbol-name fn
)))
125 (list (if (equal val
"")
128 (message "You didn't specify a function")
129 (help-setup-xref (list #'describe-function function
) (interactive-p))
130 (with-output-to-temp-buffer (help-buffer)
132 ;; Use " is " instead of a colon so that
133 ;; it is easier to get out the function name using forward-sexp.
135 (describe-function-1 function
)
136 (print-help-return-message)
137 (with-current-buffer standard-output
138 ;; Return the text we displayed.
142 (defun describe-function-1 (function)
143 (let* ((def (if (symbolp function
)
144 (symbol-function function
)
147 (beg (if (commandp def
) "an interactive " "a ")))
149 (cond ((or (stringp def
)
153 (if (eq 'unevalled
(cdr (subr-arity def
)))
154 (concat beg
"special form")
155 (concat beg
"built-in function")))
156 ((byte-code-function-p def
)
157 (concat beg
"compiled Lisp function"))
159 (while (symbolp (symbol-function def
))
160 (setq def
(symbol-function def
)))
161 (format "an alias for `%s'" def
))
162 ((eq (car-safe def
) 'lambda
)
163 (concat beg
"Lisp function"))
164 ((eq (car-safe def
) 'macro
)
166 ((eq (car-safe def
) 'mocklisp
)
167 "a mocklisp function")
168 ((eq (car-safe def
) 'autoload
)
169 (setq file-name
(nth 1 def
))
170 (format "%s autoloaded %s"
171 (if (commandp def
) "an interactive" "an")
172 (if (eq (nth 4 def
) 'keymap
) "keymap"
173 (if (nth 4 def
) "Lisp macro" "Lisp function"))
175 ;; perhaps use keymapp here instead
176 ((eq (car-safe def
) 'keymap
)
178 (elts (cdr-safe def
)))
180 (if (char-table-p (car-safe elts
))
183 (setq elts
(cdr-safe elts
)))
189 (with-current-buffer standard-output
192 (if (re-search-backward "alias for `\\([^`']+\\)'" nil t
)
193 (help-xref-button 1 'help-function def
)))))
195 (setq file-name
(symbol-file function
)))
199 ;; We used to add .el to the file name,
200 ;; but that's completely wrong when the user used load-file.
203 ;; Make a hyperlink to the library.
204 (with-current-buffer standard-output
206 (re-search-backward "`\\([^`']+\\)'" nil t
)
207 (help-xref-button 1 'help-function-def function file-name
)))))
210 (when (commandp function
)
211 (let ((keys (where-is-internal
212 function overriding-local-map nil nil
)))
214 (princ "It is bound to ")
215 ;; FIXME: This list can be very long (f.ex. for self-insert-command).
216 (princ (mapconcat 'key-description keys
", "))
219 ;; Handle symbols aliased to other symbols.
220 (setq def
(indirect-function def
))
221 ;; If definition is a macro, find the function inside it.
222 (if (eq (car-safe def
) 'macro
)
223 (setq def
(cdr def
)))
224 (let ((arglist (cond ((byte-code-function-p def
)
225 (car (append def nil
)))
226 ((eq (car-safe def
) 'lambda
)
228 ((and (eq (car-safe def
) 'autoload
)
229 (not (eq (nth 4 def
) 'keymap
)))
230 (concat "[Arg list not available until "
231 "function definition is loaded.]"))
233 (cond ((listp arglist
)
234 (princ (cons (if (symbolp function
) function
"anonymous")
235 (mapcar (lambda (arg)
236 (if (memq arg
'(&optional
&rest
))
238 (intern (upcase (symbol-name arg
)))))
244 (let ((doc (documentation function
)))
249 (with-current-buffer standard-output
251 ;; Builtins get the calling sequence at the end of
252 ;; the doc string. Move it to the same place as
253 ;; for other functions.
255 ;; In cases where `function' has been fset to a
256 ;; subr we can't search for function's name in
257 ;; the doc string. Kluge round that using the
258 ;; printed representation. The arg list then
259 ;; shows the wrong function name, but that
260 ;; might be a useful hint.
261 (let* ((rep (prin1-to-string def
))
263 (string-match " \\([^ ]+\\)>$" rep
)
264 (match-string 1 rep
))))
265 (if (looking-at (format "(%s[ )]" (regexp-quote name
)))
266 (let ((start (point-marker)))
267 (goto-char (point-min))
269 (insert-buffer-substring (current-buffer) start
)
271 (delete-region (1- start
) (point-max)))
272 (goto-char (point-min))
275 "[Missing arglist. Please make a bug report.]\n")))
276 (goto-char (point-max)))))
277 (princ "not documented")))))
283 (defun variable-at-point ()
284 "Return the bound variable symbol found around point.
285 Return 0 if there is no such symbol."
287 (with-syntax-table emacs-lisp-mode-syntax-table
289 (or (not (zerop (skip-syntax-backward "_w")))
290 (eq (char-syntax (following-char)) ?w
)
291 (eq (char-syntax (following-char)) ?_
)
293 (skip-chars-forward "'")
294 (let ((obj (read (current-buffer))))
295 (or (and (symbolp obj
) (boundp obj
) obj
)
300 (defun describe-variable (variable &optional buffer
)
301 "Display the full documentation of VARIABLE (a symbol).
302 Returns the documentation as a string, also.
303 If VARIABLE has a buffer-local value in BUFFER (default to the current buffer),
304 it is displayed along with the global value."
306 (let ((v (variable-at-point))
307 (enable-recursive-minibuffers t
)
309 (setq val
(completing-read (if (symbolp v
)
311 "Describe variable (default %s): " v
)
312 "Describe variable: ")
313 obarray
'boundp t nil nil
314 (if (symbolp v
) (symbol-name v
))))
315 (list (if (equal val
"")
317 (unless (bufferp buffer
) (setq buffer
(current-buffer)))
318 (if (not (symbolp variable
))
319 (message "You did not specify a variable")
321 (help-setup-xref (list #'describe-variable variable buffer
)
323 (with-output-to-temp-buffer (help-buffer)
324 (with-current-buffer buffer
326 (if (not (boundp variable
))
330 (let ((val (symbol-value variable
)))
331 (with-current-buffer standard-output
332 (princ "'s value is ")
334 (let ((from (point)))
336 (help-xref-on-pp from
(point))
337 (if (< (point) (+ from
20))
340 (delete-char -
1)))))))
342 (when (local-variable-p variable
)
343 (princ (format "Local in buffer %s; " (buffer-name)))
344 (if (not (default-boundp variable
))
345 (princ "globally void")
346 (let ((val (default-value variable
)))
347 (with-current-buffer standard-output
348 (princ "global value is ")
350 ;; Fixme: pp can take an age if you happen to
351 ;; ask for a very large expression. We should
352 ;; probably print it raw once and check it's a
353 ;; sensible size before prettyprinting. -- fx
354 (let ((from (point)))
356 (help-xref-on-pp from
(point))
357 (if (< (point) (+ from
20))
360 (delete-char -
1)))))))
363 (with-current-buffer standard-output
364 (when (> (count-lines (point-min) (point-max)) 10)
365 ;; Note that setting the syntax table like below
366 ;; makes forward-sexp move over a `'s' at the end
368 (set-syntax-table emacs-lisp-mode-syntax-table
)
369 (goto-char (point-min))
373 (delete-region (point) (progn (end-of-line) (point)))
374 (insert " value is shown below.\n\n")
376 (insert "\n\nValue:"))))
377 ;; Add a note for variables that have been make-var-buffer-local.
378 (when (and (local-variable-if-set-p variable
)
379 (or (not (local-variable-p variable
))
381 (local-variable-if-set-p variable
))))
384 (insert "Automatically becomes buffer-local when set in any fashion.\n"))))
385 (princ "Documentation:")
387 (let ((doc (documentation-property variable
'variable-documentation
)))
388 (princ (or doc
"not documented as a variable.")))
390 ;; Make a link to customize if this variable can be customized.
391 ;; Note, it is not reliable to test only for a custom-type property
392 ;; because those are only present after the var's definition
394 (if (or (get variable
'custom-type
) ; after defcustom
395 (get variable
'custom-loads
) ; from loaddefs.el
396 (get variable
'standard-value
)) ; from cus-start.el
397 (let ((customize-label "customize"))
400 (princ (concat "You can " customize-label
" this variable."))
401 (with-current-buffer standard-output
404 (concat "\\(" customize-label
"\\)") nil t
)
405 (help-xref-button 1 'help-customize-variable variable
)))))
406 ;; Make a hyperlink to the library if appropriate. (Don't
407 ;; change the format of the buffer's initial line in case
408 ;; anything expects the current format.)
409 (let ((file-name (symbol-file variable
)))
410 (when (equal file-name
"loaddefs.el")
411 ;; Find the real def site of the preloaded variable.
414 (find-variable-noselect variable file-name
)
417 (with-current-buffer (car location
)
418 (goto-char (cdr location
))
419 (when (re-search-backward
420 "^;;; Generated autoloads from \\(.*\\)" nil t
)
421 (setq file-name
(match-string 1)))))))
423 (princ "\n\nDefined in `")
426 (with-current-buffer standard-output
428 (re-search-backward "`\\([^`']+\\)'" nil t
)
429 (help-xref-button 1 'help-variable-def
430 variable file-name
)))))
432 (print-help-return-message)
434 (set-buffer standard-output
)
435 ;; Return the text we displayed.
436 (buffer-string)))))))
441 ;;; help-funs.el ends here