Mercurial > emacs
annotate lisp/help-fns.el @ 101963:8de12e689594
(fill_gstring_glyph_string): Adjusted for the change of
<struct glyph>.u.cmp.to. Check if the glyph belongs to the same
composition.
(append_composite_glyph): Adjusted for the change of
<strcut glyph>.u.cmp.to.
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Thu, 12 Feb 2009 05:54:20 +0000 |
parents | a9dc0e7c3f2b |
children | ee7d5d4ca6e7 |
rev | line source |
---|---|
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
1 ;;; help-fns.el --- Complex help functions |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
2 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, |
100908 | 4 ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
5 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
6 ;; Maintainer: FSF |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
7 ;; Keywords: help, internal |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
8 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
9 ;; This file is part of GNU Emacs. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
10 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
11 ;; GNU Emacs is free software: you can redistribute it and/or modify |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
12 ;; it under the terms of the GNU General Public License as published by |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
13 ;; the Free Software Foundation, either version 3 of the License, or |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
14 ;; (at your option) any later version. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
15 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
16 ;; GNU Emacs is distributed in the hope that it will be useful, |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
19 ;; GNU General Public License for more details. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
20 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
21 ;; You should have received a copy of the GNU General Public License |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
23 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
24 ;;; Commentary: |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
25 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
26 ;; This file contains those help commands which are complicated, and |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
27 ;; which may not be used in every session. For example |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
28 ;; `describe-function' will probably be heavily used when doing elisp |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
29 ;; programming, but not if just editing C files. Simpler help commands |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
30 ;; are in help.el |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
31 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
32 ;;; Code: |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
33 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
34 (require 'help-mode) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
35 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
36 ;; Functions |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
37 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
38 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
39 (defun describe-function (function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
40 "Display the full documentation of FUNCTION (a symbol)." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
41 (interactive |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
42 (let ((fn (function-called-at-point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
43 (enable-recursive-minibuffers t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
44 val) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
45 (setq val (completing-read (if fn |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
46 (format "Describe function (default %s): " fn) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
47 "Describe function: ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
48 obarray 'fboundp t nil nil |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
49 (and fn (symbol-name fn)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
50 (list (if (equal val "") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
51 fn (intern val))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
52 (if (null function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
53 (message "You didn't specify a function") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
54 (help-setup-xref (list #'describe-function function) (interactive-p)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
55 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
56 (with-help-window (help-buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
57 (prin1 function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
58 ;; Use " is " instead of a colon so that |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
59 ;; it is easier to get out the function name using forward-sexp. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
60 (princ " is ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
61 (describe-function-1 function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
62 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
63 ;; Return the text we displayed. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
64 (buffer-string)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
65 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
66 (defun help-split-fundoc (docstring def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
67 "Split a function DOCSTRING into the actual doc and the usage info. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
68 Return (USAGE . DOC) or nil if there's no usage info. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
69 DEF is the function whose usage we're looking for in DOCSTRING." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
70 ;; Functions can get the calling sequence at the end of the doc string. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
71 ;; In cases where `function' has been fset to a subr we can't search for |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
72 ;; function's name in the doc string so we use `fn' as the anonymous |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
73 ;; function name instead. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
74 (when (and docstring (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
75 (cons (format "(%s%s" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
76 ;; Replace `fn' with the actual function name. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
77 (if (consp def) "anonymous" def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
78 (match-string 1 docstring)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
79 (substring docstring 0 (match-beginning 0))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
80 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
81 (defun help-add-fundoc-usage (docstring arglist) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
82 "Add the usage info to DOCSTRING. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
83 If DOCSTRING already has a usage info, then just return it unchanged. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
84 The usage info is built from ARGLIST. DOCSTRING can be nil. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
85 ARGLIST can also be t or a string of the form \"(FUN ARG1 ARG2 ...)\"." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
86 (unless (stringp docstring) (setq docstring "Not documented")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
87 (if (or (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring) (eq arglist t)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
88 docstring |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
89 (concat docstring |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
90 (if (string-match "\n?\n\\'" docstring) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
91 (if (< (- (match-end 0) (match-beginning 0)) 2) "\n" "") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
92 "\n\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
93 (if (and (stringp arglist) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
94 (string-match "\\`([^ ]+\\(.*\\))\\'" arglist)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
95 (concat "(fn" (match-string 1 arglist) ")") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
96 (format "%S" (help-make-usage 'fn arglist)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
97 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
98 (defun help-function-arglist (def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
99 ;; Handle symbols aliased to other symbols. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
100 (if (and (symbolp def) (fboundp def)) (setq def (indirect-function def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
101 ;; If definition is a macro, find the function inside it. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
102 (if (eq (car-safe def) 'macro) (setq def (cdr def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
103 (cond |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
104 ((byte-code-function-p def) (aref def 0)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
105 ((eq (car-safe def) 'lambda) (nth 1 def)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
106 ((and (eq (car-safe def) 'autoload) (not (eq (nth 4 def) 'keymap))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
107 "[Arg list not available until function definition is loaded.]") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
108 (t t))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
109 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
110 (defun help-make-usage (function arglist) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
111 (cons (if (symbolp function) function 'anonymous) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
112 (mapcar (lambda (arg) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
113 (if (not (symbolp arg)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
114 (if (and (consp arg) (symbolp (car arg))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
115 ;; CL style default values for optional args. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
116 (cons (intern (upcase (symbol-name (car arg)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
117 (cdr arg)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
118 arg) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
119 (let ((name (symbol-name arg))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
120 (if (string-match "\\`&" name) arg |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
121 (intern (upcase name)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
122 arglist))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
123 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
124 ;; Could be this, if we make symbol-file do the work below. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
125 ;; (defun help-C-file-name (subr-or-var kind) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
126 ;; "Return the name of the C file where SUBR-OR-VAR is defined. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
127 ;; KIND should be `var' for a variable or `subr' for a subroutine." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
128 ;; (symbol-file (if (symbolp subr-or-var) subr-or-var |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
129 ;; (subr-name subr-or-var)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
130 ;; (if (eq kind 'var) 'defvar 'defun))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
131 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
132 (defun help-C-file-name (subr-or-var kind) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
133 "Return the name of the C file where SUBR-OR-VAR is defined. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
134 KIND should be `var' for a variable or `subr' for a subroutine." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
135 (let ((docbuf (get-buffer-create " *DOC*")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
136 (name (if (eq 'var kind) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
137 (concat "V" (symbol-name subr-or-var)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
138 (concat "F" (subr-name subr-or-var))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
139 (with-current-buffer docbuf |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
140 (goto-char (point-min)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
141 (if (eobp) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
142 (insert-file-contents-literally |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
143 (expand-file-name internal-doc-file-name doc-directory))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
144 (let ((file (catch 'loop |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
145 (while t |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
146 (let ((pnt (search-forward (concat "" name "\n")))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
147 (re-search-backward "S\\(.*\\)") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
148 (let ((file (match-string 1))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
149 (if (member file build-files) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
150 (throw 'loop file) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
151 (goto-char pnt)))))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
152 (if (string-match "^ns.*\\(\\.o\\|obj\\)\\'" file) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
153 (setq file (replace-match ".m" t t file 1)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
154 (if (string-match "\\.\\(o\\|obj\\)\\'" file) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
155 (setq file (replace-match ".c" t t file)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
156 (if (string-match "\\.\\(c\\|m\\)\\'" file) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
157 (concat "src/" file) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
158 file))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
159 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
160 (defface help-argument-name '((((supports :slant italic)) :inherit italic)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
161 "Face to highlight argument names in *Help* buffers." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
162 :group 'help) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
163 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
164 (defun help-default-arg-highlight (arg) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
165 "Default function to highlight arguments in *Help* buffers. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
166 It returns ARG in face `help-argument-name'; ARG is also |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
167 downcased if it displays differently than the default |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
168 face (according to `face-differs-from-default-p')." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
169 (propertize (if (face-differs-from-default-p 'help-argument-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
170 (downcase arg) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
171 arg) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
172 'face 'help-argument-name)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
173 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
174 (defun help-do-arg-highlight (doc args) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
175 (with-syntax-table (make-syntax-table emacs-lisp-mode-syntax-table) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
176 (modify-syntax-entry ?\- "w") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
177 (dolist (arg args doc) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
178 (setq doc (replace-regexp-in-string |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
179 ;; This is heuristic, but covers all common cases |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
180 ;; except ARG1-ARG2 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
181 (concat "\\<" ; beginning of word |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
182 "\\(?:[a-z-]*-\\)?" ; for xxx-ARG |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
183 "\\(" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
184 (regexp-quote arg) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
185 "\\)" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
186 "\\(?:es\\|s\\|th\\)?" ; for ARGth, ARGs |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
187 "\\(?:-[a-z0-9-]+\\)?" ; for ARG-xxx, ARG-n |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
188 "\\(?:-[{([<`\"].*?\\)?"; for ARG-{x}, (x), <x>, [x], `x' |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
189 "\\>") ; end of word |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
190 (help-default-arg-highlight arg) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
191 doc t t 1))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
192 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
193 (defun help-highlight-arguments (usage doc &rest args) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
194 (when usage |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
195 (with-temp-buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
196 (insert usage) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
197 (goto-char (point-min)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
198 (let ((case-fold-search nil) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
199 (next (not (or args (looking-at "\\[")))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
200 (opt nil)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
201 ;; Make a list of all arguments |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
202 (skip-chars-forward "^ ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
203 (while next |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
204 (or opt (not (looking-at " &")) (setq opt t)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
205 (if (not (re-search-forward " \\([\\[(]*\\)\\([^] &)\.]+\\)" nil t)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
206 (setq next nil) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
207 (setq args (cons (match-string 2) args)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
208 (when (and opt (string= (match-string 1) "(")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
209 ;; A pesky CL-style optional argument with default value, |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
210 ;; so let's skip over it |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
211 (search-backward "(") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
212 (goto-char (scan-sexps (point) 1))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
213 ;; Highlight aguments in the USAGE string |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
214 (setq usage (help-do-arg-highlight (buffer-string) args)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
215 ;; Highlight arguments in the DOC string |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
216 (setq doc (and doc (help-do-arg-highlight doc args)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
217 ;; Return value is like the one from help-split-fundoc, but highlighted |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
218 (cons usage doc)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
219 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
220 ;; The following function was compiled from the former functions |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
221 ;; `describe-simplify-lib-file-name' and `find-source-lisp-file' with |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
222 ;; some excerpts from `describe-function-1' and `describe-variable'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
223 ;; The only additional twists provided are (1) locate the defining file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
224 ;; for autoloaded functions, and (2) give preference to files in the |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
225 ;; "install directory" (directories found via `load-path') rather than |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
226 ;; to files in the "compile directory" (directories found by searching |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
227 ;; the loaddefs.el file). We autoload it because it's also used by |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
228 ;; `describe-face' (instead of `describe-simplify-lib-file-name'). |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
229 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
230 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
231 (defun find-lisp-object-file-name (object type) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
232 "Guess the file that defined the Lisp object OBJECT, of type TYPE. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
233 OBJECT should be a symbol associated with a function, variable, or face; |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
234 alternatively, it can be a function definition. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
235 If TYPE is `variable', search for a variable definition. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
236 If TYPE is `face', search for a face definition. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
237 If TYPE is the value returned by `symbol-function' for a function symbol, |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
238 search for a function definition. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
239 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
240 The return value is the absolute name of a readable file where OBJECT is |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
241 defined. If several such files exist, preference is given to a file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
242 found via `load-path'. The return value can also be `C-source', which |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
243 means that OBJECT is a function or variable defined in C. If no |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
244 suitable file is found, return nil." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
245 (let* ((autoloaded (eq (car-safe type) 'autoload)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
246 (file-name (or (and autoloaded (nth 1 type)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
247 (symbol-file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
248 object (if (memq type (list 'defvar 'defface)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
249 type |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
250 'defun))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
251 (cond |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
252 (autoloaded |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
253 ;; An autoloaded function: Locate the file since `symbol-function' |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
254 ;; has only returned a bare string here. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
255 (setq file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
256 (locate-file file-name load-path '(".el" ".elc") 'readable))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
257 ((and (stringp file-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
258 (string-match "[.]*loaddefs.el\\'" file-name)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
259 ;; An autoloaded variable or face. Visit loaddefs.el in a buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
260 ;; and try to extract the defining file. The following form is |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
261 ;; from `describe-function-1' and `describe-variable'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
262 (let ((location |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
263 (condition-case nil |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
264 (find-function-search-for-symbol object nil file-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
265 (error nil)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
266 (when location |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
267 (with-current-buffer (car location) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
268 (goto-char (cdr location)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
269 (when (re-search-backward |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
270 "^;;; Generated autoloads from \\(.*\\)" nil t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
271 (setq file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
272 (locate-file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
273 (match-string-no-properties 1) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
274 load-path nil 'readable)))))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
275 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
276 (cond |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
277 ((and (not file-name) (subrp type)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
278 ;; A built-in function. The form is from `describe-function-1'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
279 (if (get-buffer " *DOC*") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
280 (help-C-file-name type 'subr) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
281 'C-source)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
282 ((and (not file-name) (symbolp object) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
283 (integerp (get object 'variable-documentation))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
284 ;; A variable defined in C. The form is from `describe-variable'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
285 (if (get-buffer " *DOC*") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
286 (help-C-file-name object 'var) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
287 'C-source)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
288 ((not (stringp file-name)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
289 ;; If we don't have a file-name string by now, we lost. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
290 nil) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
291 ((let ((lib-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
292 (if (string-match "[.]elc\\'" file-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
293 (substring-no-properties file-name 0 -1) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
294 file-name))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
295 ;; When the Elisp source file can be found in the install |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
296 ;; directory return the name of that file - `file-name' should |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
297 ;; have become an absolute file name ny now. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
298 (or (and (file-readable-p lib-name) lib-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
299 ;; The library might be compressed. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
300 (and (file-readable-p (concat lib-name ".gz")) lib-name)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
301 ((let* ((lib-name (file-name-nondirectory file-name)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
302 ;; The next form is from `describe-simplify-lib-file-name'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
303 (file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
304 ;; Try converting the absolute file name to a library |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
305 ;; name, convert that back to a file name and see if we |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
306 ;; get the original one. If so, they are equivalent. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
307 (if (equal file-name (locate-file lib-name load-path '(""))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
308 (if (string-match "[.]elc\\'" lib-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
309 (substring-no-properties lib-name 0 -1) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
310 lib-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
311 file-name)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
312 ;; The next three forms are from `find-source-lisp-file'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
313 (elc-file (locate-file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
314 (concat file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
315 (if (string-match "\\.el\\'" file-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
316 "c" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
317 ".elc")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
318 load-path nil 'readable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
319 (str (when elc-file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
320 (with-temp-buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
321 (insert-file-contents-literally elc-file nil 0 256) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
322 (buffer-string)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
323 (src-file (and str |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
324 (string-match ";;; from file \\(.*\\.el\\)" str) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
325 (match-string 1 str)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
326 (and src-file (file-readable-p src-file) src-file)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
327 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
328 (declare-function ad-get-advice-info "advice" (function)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
329 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
330 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
331 (defun describe-function-1 (function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
332 (let* ((advised (and (symbolp function) (featurep 'advice) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
333 (ad-get-advice-info function))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
334 ;; If the function is advised, use the symbol that has the |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
335 ;; real definition, if that symbol is already set up. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
336 (real-function |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
337 (or (and advised |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
338 (let ((origname (cdr (assq 'origname advised)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
339 (and (fboundp origname) origname))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
340 function)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
341 ;; Get the real definition. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
342 (def (if (symbolp real-function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
343 (symbol-function real-function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
344 function)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
345 file-name string |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
346 (beg (if (commandp def) "an interactive " "a ")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
347 (pt1 (with-current-buffer (help-buffer) (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
348 errtype) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
349 (setq string |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
350 (cond ((or (stringp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
351 (vectorp def)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
352 "a keyboard macro") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
353 ((subrp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
354 (if (eq 'unevalled (cdr (subr-arity def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
355 (concat beg "special form") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
356 (concat beg "built-in function"))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
357 ((byte-code-function-p def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
358 (concat beg "compiled Lisp function")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
359 ((symbolp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
360 (while (and (fboundp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
361 (symbolp (symbol-function def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
362 (setq def (symbol-function def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
363 ;; Handle (defalias 'foo 'bar), where bar is undefined. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
364 (or (fboundp def) (setq errtype 'alias)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
365 (format "an alias for `%s'" def)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
366 ((eq (car-safe def) 'lambda) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
367 (concat beg "Lisp function")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
368 ((eq (car-safe def) 'macro) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
369 "a Lisp macro") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
370 ((eq (car-safe def) 'autoload) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
371 (format "%s autoloaded %s" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
372 (if (commandp def) "an interactive" "an") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
373 (if (eq (nth 4 def) 'keymap) "keymap" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
374 (if (nth 4 def) "Lisp macro" "Lisp function")))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
375 ((keymapp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
376 (let ((is-full nil) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
377 (elts (cdr-safe def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
378 (while elts |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
379 (if (char-table-p (car-safe elts)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
380 (setq is-full t |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
381 elts nil)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
382 (setq elts (cdr-safe elts))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
383 (if is-full |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
384 "a full keymap" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
385 "a sparse keymap"))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
386 (t ""))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
387 (princ string) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
388 (if (eq errtype 'alias) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
389 (princ ",\nwhich is not defined. Please make a bug report.") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
390 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
391 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
392 (save-match-data |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
393 (when (re-search-backward "alias for `\\([^`']+\\)'" nil t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
394 (help-xref-button 1 'help-function def))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
395 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
396 (setq file-name (find-lisp-object-file-name function def)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
397 (when file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
398 (princ " in `") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
399 ;; We used to add .el to the file name, |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
400 ;; but that's completely wrong when the user used load-file. |
98319
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
401 (princ (if (eq file-name 'C-source) |
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
402 "C source code" |
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
403 (file-name-nondirectory file-name))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
404 (princ "'") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
405 ;; Make a hyperlink to the library. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
406 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
407 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
408 (re-search-backward "`\\([^`']+\\)'" nil t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
409 (help-xref-button 1 'help-function-def real-function file-name)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
410 (princ ".") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
411 (with-current-buffer (help-buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
412 (fill-region-as-paragraph (save-excursion (goto-char pt1) (forward-line 0) (point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
413 (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
414 (terpri)(terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
415 (when (commandp function) |
99564
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
416 (let ((pt2 (with-current-buffer (help-buffer) (point))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
417 (remapped (command-remapping function))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
418 (unless (memq remapped '(ignore undefined)) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
419 (let ((keys (where-is-internal |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
420 (or remapped function) overriding-local-map nil nil)) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
421 non-modified-keys) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
422 (if (and (eq function 'self-insert-command) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
423 (vectorp (car-safe keys)) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
424 (consp (aref (car keys) 0))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
425 (princ "It is bound to many ordinary text characters.\n") |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
426 ;; Which non-control non-meta keys run this command? |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
427 (dolist (key keys) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
428 (if (member (event-modifiers (aref key 0)) '(nil (shift))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
429 (push key non-modified-keys))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
430 (when remapped |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
431 (princ "It is remapped to `") |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
432 (princ (symbol-name remapped)) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
433 (princ "'")) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
434 |
99564
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
435 (when keys |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
436 (princ (if remapped ", which is bound to " "It is bound to ")) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
437 ;; If lots of ordinary text characters run this command, |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
438 ;; don't mention them one by one. |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
439 (if (< (length non-modified-keys) 10) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
440 (princ (mapconcat 'key-description keys ", ")) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
441 (dolist (key non-modified-keys) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
442 (setq keys (delq key keys))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
443 (if keys |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
444 (progn |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
445 (princ (mapconcat 'key-description keys ", ")) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
446 (princ ", and many ordinary text characters")) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
447 (princ "many ordinary text characters")))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
448 (when (or remapped keys non-modified-keys) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
449 (princ ".") |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
450 (terpri))))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
451 |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
452 (with-current-buffer (help-buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
453 (fill-region-as-paragraph pt2 (point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
454 (unless (looking-back "\n\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
455 (terpri))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
456 (let* ((arglist (help-function-arglist def)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
457 (doc (documentation function)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
458 (usage (help-split-fundoc doc function))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
459 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
460 ;; If definition is a keymap, skip arglist note. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
461 (unless (keymapp function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
462 (let* ((use (cond |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
463 (usage (setq doc (cdr usage)) (car usage)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
464 ((listp arglist) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
465 (format "%S" (help-make-usage function arglist))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
466 ((stringp arglist) arglist) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
467 ;; Maybe the arglist is in the docstring of a symbol |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
468 ;; this one is aliased to. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
469 ((let ((fun real-function)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
470 (while (and (symbolp fun) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
471 (setq fun (symbol-function fun)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
472 (not (setq usage (help-split-fundoc |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
473 (documentation fun) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
474 function))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
475 usage) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
476 (car usage)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
477 ((or (stringp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
478 (vectorp def)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
479 (format "\nMacro: %s" (format-kbd-macro def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
480 (t "[Missing arglist. Please make a bug report.]"))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
481 (high (help-highlight-arguments use doc))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
482 (let ((fill-begin (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
483 (insert (car high) "\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
484 (fill-region fill-begin (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
485 (setq doc (cdr high)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
486 (let* ((obsolete (and |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
487 ;; function might be a lambda construct. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
488 (symbolp function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
489 (get function 'byte-obsolete-info))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
490 (use (car obsolete))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
491 (when obsolete |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
492 (princ "\nThis function is obsolete") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
493 (when (nth 2 obsolete) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
494 (insert (format " since %s" (nth 2 obsolete)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
495 (insert (cond ((stringp use) (concat ";\n" use)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
496 (use (format ";\nuse `%s' instead." use)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
497 (t ".")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
498 "\n")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
499 (insert "\n" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
500 (or doc "Not documented.")))))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
501 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
502 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
503 ;; Variables |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
504 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
505 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
506 (defun variable-at-point (&optional any-symbol) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
507 "Return the bound variable symbol found at or before point. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
508 Return 0 if there is no such symbol. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
509 If ANY-SYMBOL is non-nil, don't insist the symbol be bound." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
510 (with-syntax-table emacs-lisp-mode-syntax-table |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
511 (or (condition-case () |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
512 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
513 (or (not (zerop (skip-syntax-backward "_w"))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
514 (eq (char-syntax (following-char)) ?w) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
515 (eq (char-syntax (following-char)) ?_) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
516 (forward-sexp -1)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
517 (skip-chars-forward "'") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
518 (let ((obj (read (current-buffer)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
519 (and (symbolp obj) (boundp obj) obj))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
520 (error nil)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
521 (let* ((str (find-tag-default)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
522 (sym (if str (intern-soft str)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
523 (if (and sym (or any-symbol (boundp sym))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
524 sym |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
525 (save-match-data |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
526 (when (and str (string-match "\\`\\W*\\(.*?\\)\\W*\\'" str)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
527 (setq sym (intern-soft (match-string 1 str))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
528 (and (or any-symbol (boundp sym)) sym))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
529 0))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
530 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
531 (defun describe-variable-custom-version-info (variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
532 (let ((custom-version (get variable 'custom-version)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
533 (cpv (get variable 'custom-package-version)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
534 (output nil)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
535 (if custom-version |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
536 (setq output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
537 (format "This variable was introduced, or its default value was changed, in\nversion %s of Emacs.\n" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
538 custom-version)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
539 (when cpv |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
540 (let* ((package (car-safe cpv)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
541 (version (if (listp (cdr-safe cpv)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
542 (car (cdr-safe cpv)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
543 (cdr-safe cpv))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
544 (pkg-versions (assq package customize-package-emacs-version-alist)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
545 (emacsv (cdr (assoc version pkg-versions)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
546 (if (and package version) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
547 (setq output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
548 (format (concat "This variable was introduced, or its default value was changed, in\nversion %s of the %s package" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
549 (if emacsv |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
550 (format " that is part of Emacs %s" emacsv)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
551 ".\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
552 version package)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
553 output)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
554 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
555 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
556 (defun describe-variable (variable &optional buffer frame) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
557 "Display the full documentation of VARIABLE (a symbol). |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
558 Returns the documentation as a string, also. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
559 If VARIABLE has a buffer-local value in BUFFER or FRAME |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
560 \(default to the current buffer and current frame), |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
561 it is displayed along with the global value." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
562 (interactive |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
563 (let ((v (variable-at-point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
564 (enable-recursive-minibuffers t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
565 val) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
566 (setq val (completing-read (if (symbolp v) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
567 (format |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
568 "Describe variable (default %s): " v) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
569 "Describe variable: ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
570 obarray |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
571 '(lambda (vv) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
572 (or (boundp vv) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
573 (get vv 'variable-documentation))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
574 t nil nil |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
575 (if (symbolp v) (symbol-name v)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
576 (list (if (equal val "") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
577 v (intern val))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
578 (let (file-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
579 (unless (buffer-live-p buffer) (setq buffer (current-buffer))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
580 (unless (frame-live-p frame) (setq frame (selected-frame))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
581 (if (not (symbolp variable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
582 (message "You did not specify a variable") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
583 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
584 (let ((valvoid (not (with-current-buffer buffer (boundp variable)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
585 val val-start-pos locus) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
586 ;; Extract the value before setting up the output buffer, |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
587 ;; in case `buffer' *is* the output buffer. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
588 (unless valvoid |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
589 (with-selected-frame frame |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
590 (with-current-buffer buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
591 (setq val (symbol-value variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
592 locus (variable-binding-locus variable))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
593 (help-setup-xref (list #'describe-variable variable buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
594 (interactive-p)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
595 (with-help-window (help-buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
596 (with-current-buffer buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
597 (prin1 variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
598 (setq file-name (find-lisp-object-file-name variable 'defvar)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
599 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
600 (if file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
601 (progn |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
602 (princ " is a variable defined in `") |
98319
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
603 (princ (if (eq file-name 'C-source) |
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
604 "C source code" |
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
605 (file-name-nondirectory file-name))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
606 (princ "'.\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
607 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
608 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
609 (re-search-backward "`\\([^`']+\\)'" nil t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
610 (help-xref-button 1 'help-variable-def |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
611 variable file-name))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
612 (if valvoid |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
613 (princ "It is void as a variable.") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
614 (princ "Its "))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
615 (if valvoid |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
616 (princ " is void as a variable.") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
617 (princ "'s ")))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
618 (if valvoid |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
619 nil |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
620 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
621 (setq val-start-pos (point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
622 (princ "value is ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
623 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
624 (let ((from (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
625 (pp val) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
626 ;; Hyperlinks in variable's value are quite frequently |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
627 ;; inappropriate e.g C-h v <RET> features <RET> |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
628 ;; (help-xref-on-pp from (point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
629 (if (< (point) (+ from 20)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
630 (delete-region (1- from) from))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
631 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
632 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
633 (when locus |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
634 (if (bufferp locus) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
635 (princ (format "%socal in buffer %s; " |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
636 (if (get variable 'permanent-local) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
637 "Permanently l" "L") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
638 (buffer-name))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
639 (princ (format "It is a frame-local variable; "))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
640 (if (not (default-boundp variable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
641 (princ "globally void") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
642 (let ((val (default-value variable))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
643 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
644 (princ "global value is ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
645 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
646 ;; Fixme: pp can take an age if you happen to |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
647 ;; ask for a very large expression. We should |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
648 ;; probably print it raw once and check it's a |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
649 ;; sensible size before prettyprinting. -- fx |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
650 (let ((from (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
651 (pp val) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
652 ;; See previous comment for this function. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
653 ;; (help-xref-on-pp from (point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
654 (if (< (point) (+ from 20)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
655 (delete-region (1- from) from)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
656 (terpri)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
657 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
658 ;; If the value is large, move it to the end. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
659 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
660 (when (> (count-lines (point-min) (point-max)) 10) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
661 ;; Note that setting the syntax table like below |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
662 ;; makes forward-sexp move over a `'s' at the end |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
663 ;; of a symbol. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
664 (set-syntax-table emacs-lisp-mode-syntax-table) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
665 (goto-char val-start-pos) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
666 ;; The line below previously read as |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
667 ;; (delete-region (point) (progn (end-of-line) (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
668 ;; which suppressed display of the buffer local value for |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
669 ;; large values. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
670 (when (looking-at "value is") (replace-match "")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
671 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
672 (insert "\n\nValue:") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
673 (set (make-local-variable 'help-button-cache) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
674 (point-marker))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
675 (insert "value is shown ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
676 (insert-button "below" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
677 'action help-button-cache |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
678 'follow-link t |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
679 'help-echo "mouse-2, RET: show value") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
680 (insert ".\n"))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
681 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
682 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
683 (let* ((alias (condition-case nil |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
684 (indirect-variable variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
685 (error variable))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
686 (obsolete (get variable 'byte-obsolete-variable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
687 (use (car obsolete)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
688 (safe-var (get variable 'safe-local-variable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
689 (doc (or (documentation-property variable 'variable-documentation) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
690 (documentation-property alias 'variable-documentation))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
691 (extra-line nil)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
692 ;; Add a note for variables that have been make-var-buffer-local. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
693 (when (and (local-variable-if-set-p variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
694 (or (not (local-variable-p variable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
695 (with-temp-buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
696 (local-variable-if-set-p variable)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
697 (setq extra-line t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
698 (princ " Automatically becomes buffer-local when set in any fashion.\n")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
699 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
700 ;; Mention if it's an alias |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
701 (unless (eq alias variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
702 (setq extra-line t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
703 (princ (format " This variable is an alias for `%s'.\n" alias))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
704 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
705 (when obsolete |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
706 (setq extra-line t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
707 (princ " This variable is obsolete") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
708 (if (cdr obsolete) (princ (format " since %s" (cdr obsolete)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
709 (princ (cond ((stringp use) (concat ";\n " use)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
710 (use (format ";\n use `%s' instead." (car obsolete))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
711 (t "."))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
712 (terpri)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
713 (when safe-var |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
714 (setq extra-line t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
715 (princ " This variable is safe as a file local variable ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
716 (princ "if its value\n satisfies the predicate ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
717 (princ (if (byte-code-function-p safe-var) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
718 "which is byte-compiled expression.\n" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
719 (format "`%s'.\n" safe-var)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
720 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
721 (if extra-line (terpri)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
722 (princ "Documentation:\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
723 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
724 (insert (or doc "Not documented as a variable.")))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
725 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
726 ;; Make a link to customize if this variable can be customized. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
727 (when (custom-variable-p variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
728 (let ((customize-label "customize")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
729 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
730 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
731 (princ (concat "You can " customize-label " this variable.")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
732 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
733 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
734 (re-search-backward |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
735 (concat "\\(" customize-label "\\)") nil t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
736 (help-xref-button 1 'help-customize-variable variable)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
737 ;; Note variable's version or package version |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
738 (let ((output (describe-variable-custom-version-info variable))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
739 (when output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
740 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
741 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
742 (princ output)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
743 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
744 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
745 (set-buffer standard-output) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
746 ;; Return the text we displayed. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
747 (buffer-string)))))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
748 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
749 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
750 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
751 (defun describe-syntax (&optional buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
752 "Describe the syntax specifications in the syntax table of BUFFER. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
753 The descriptions are inserted in a help buffer, which is then displayed. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
754 BUFFER defaults to the current buffer." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
755 (interactive) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
756 (setq buffer (or buffer (current-buffer))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
757 (help-setup-xref (list #'describe-syntax buffer) (interactive-p)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
758 (with-help-window (help-buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
759 (let ((table (with-current-buffer buffer (syntax-table)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
760 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
761 (describe-vector table 'internal-describe-syntax-value) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
762 (while (setq table (char-table-parent table)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
763 (insert "\nThe parent syntax table is:") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
764 (describe-vector table 'internal-describe-syntax-value)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
765 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
766 (defun help-describe-category-set (value) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
767 (insert (cond |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
768 ((null value) "default") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
769 ((char-table-p value) "deeper char-table ...") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
770 (t (condition-case err |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
771 (category-set-mnemonics value) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
772 (error "invalid")))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
773 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
774 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
775 (defun describe-categories (&optional buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
776 "Describe the category specifications in the current category table. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
777 The descriptions are inserted in a buffer, which is then displayed. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
778 If BUFFER is non-nil, then describe BUFFER's category table instead. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
779 BUFFER should be a buffer or a buffer name." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
780 (interactive) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
781 (setq buffer (or buffer (current-buffer))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
782 (help-setup-xref (list #'describe-categories buffer) (interactive-p)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
783 (with-help-window (help-buffer) |
99119
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
784 (let* ((table (with-current-buffer buffer (category-table))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
785 (docs (char-table-extra-slot table 0))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
786 (if (or (not (vectorp docs)) (/= (length docs) 95)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
787 (error "Invalid first extra slot in this category table\n")) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
788 (with-current-buffer standard-output |
99119
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
789 (insert "Legend of category mnemonics (see the tail for the longer description)\n") |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
790 (let ((pos (point)) (items 0) lines n) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
791 (dotimes (i 95) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
792 (if (aref docs i) (setq items (1+ items)))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
793 (setq lines (1+ (/ (1- items) 4))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
794 (setq n 0) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
795 (dotimes (i 95) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
796 (let ((elt (aref docs i))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
797 (when elt |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
798 (string-match ".*" elt) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
799 (setq elt (match-string 0 elt)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
800 (if (>= (length elt) 17) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
801 (setq elt (concat (substring elt 0 14) "..."))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
802 (if (< (point) (point-max)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
803 (move-to-column (* 20 (/ n lines)) t)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
804 (insert (+ i ?\s) ?: elt) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
805 (if (< (point) (point-max)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
806 (forward-line 1) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
807 (insert "\n")) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
808 (setq n (1+ n)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
809 (if (= (% n lines) 0) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
810 (goto-char pos)))))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
811 (goto-char (point-max)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
812 (insert "\n" |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
813 "character(s)\tcategory mnemonics\n" |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
814 "------------\t------------------") |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
815 (describe-vector table 'help-describe-category-set) |
99119
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
816 (insert "Legend of category mnemonics:\n") |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
817 (dotimes (i 95) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
818 (let ((elt (aref docs i))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
819 (when elt |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
820 (if (string-match "\n" elt) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
821 (setq elt (substring elt (match-end 0)))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
822 (insert (+ i ?\s) ": " elt "\n")))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
823 (while (setq table (char-table-parent table)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
824 (insert "\nThe parent category table is:") |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
825 (describe-vector table 'help-describe-category-set)))))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
826 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
827 (provide 'help-fns) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
828 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
829 ;; arch-tag: 9e10331c-ae81-4d13-965d-c4819aaab0b3 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
830 ;;; help-fns.el ends here |