|
428
|
1 ;;; hyper-apropos.el --- Hypertext emacs lisp documentation interface.
|
|
|
2
|
|
|
3 ;; Copyright (C) 1997 Free Software Foundation, Inc.
|
|
|
4 ;; Copyright (C) 1994, 1995 Tinker Systems and INS Engineering Corp.
|
|
|
5 ;; Copyright (C) 1995 Sun Microsystems.
|
|
|
6 ;; Copyright (C) 1996 Ben Wing.
|
|
|
7
|
|
|
8 ;; Maintainer: Jonathan Stigelman <Stig@hackvan.com>
|
|
|
9 ;; Keywords: lisp, tools, help, docs, matching
|
|
|
10
|
|
|
11 ;; This file is part of XEmacs.
|
|
|
12
|
|
|
13 ;; XEmacs is free software; you can redistribute it and/or modify
|
|
|
14 ;; it under the terms of the GNU General Public License as published by
|
|
|
15 ;; the Free Software Foundation; either version 2 of the License, or
|
|
|
16 ;; (at your option) any later version.
|
|
|
17 ;;
|
|
|
18 ;; XEmacs is distributed in the hope that it will be useful,
|
|
|
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
21 ;; GNU General Public License for more details.
|
|
|
22 ;;
|
|
|
23 ;; You should have received a copy of the GNU General Public License
|
|
|
24 ;; along with XEmacs; if not, write to the Free Software
|
|
|
25 ;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
|
26
|
|
|
27 ;;; Synched up with: Not in FSF.
|
|
|
28
|
|
|
29 ;;; Commentary:
|
|
|
30
|
|
|
31 ;; based upon emacs-apropos.el by Frank C. Guida <fcg@philabs.philips.com>
|
|
|
32 ;;
|
|
|
33 ;; Rather than run apropos and print all the documentation at once,
|
|
|
34 ;; I find it easier to view a "table of contents" first, then
|
|
|
35 ;; get the details for symbols as you need them.
|
|
|
36 ;;
|
|
|
37 ;; This version of apropos prints two lists of symbols matching the
|
|
|
38 ;; given regexp: functions/macros and variables/constants.
|
|
|
39 ;;
|
|
|
40 ;; The user can then do the following:
|
|
|
41 ;;
|
|
|
42 ;; - add an additional regexp to narrow the search
|
|
|
43 ;; - display documentation for the current symbol
|
|
|
44 ;; - find the tag for the current symbol
|
|
|
45 ;; - show any keybindings if the current symbol is a command
|
|
|
46 ;; - invoke functions
|
|
|
47 ;; - set variables
|
|
|
48 ;;
|
|
|
49 ;; An additional feature is the ability to search the current tags
|
|
|
50 ;; table, allowing you to interrogate functions not yet loaded (this
|
|
|
51 ;; isn't available with the standard package).
|
|
|
52 ;;
|
|
|
53 ;; Mouse bindings and menus are provided for XEmacs.
|
|
|
54 ;;
|
|
|
55 ;; additions by Ben Wing <ben@xemacs.org> July 1995:
|
|
|
56 ;; added support for function aliases, made programmer's apropos be the
|
|
|
57 ;; default, various other hacking.
|
|
|
58 ;; Massive changes by Christoph Wedler <wedler@fmi.uni-passau.de>
|
|
|
59 ;; Some changes for XEmacs 20.3 by hniksic
|
|
|
60
|
|
|
61 ;; ### The maintainer is supposed to be stig, but I haven't seen him
|
|
|
62 ;; around for ages. The real maintainer for the moment is Hrvoje
|
|
|
63 ;; Niksic <hniksic@xemacs.org>.
|
|
|
64
|
|
|
65 ;;; Code:
|
|
|
66
|
|
|
67 (defgroup hyper-apropos nil
|
|
|
68 "Hypertext emacs lisp documentation interface."
|
|
|
69 :group 'docs
|
|
|
70 :group 'lisp
|
|
|
71 :group 'tools
|
|
|
72 :group 'help
|
|
|
73 :group 'matching)
|
|
|
74
|
|
|
75 (defcustom hyper-apropos-show-brief-docs t
|
|
|
76 "*If non-nil, display some documentation in the \"*Hyper Apropos*\" buffer.
|
|
|
77 Setting this to nil will speed up searches."
|
|
|
78 :type 'boolean
|
|
|
79 :group 'hyper-apropos)
|
|
|
80 (define-obsolete-variable-alias
|
|
|
81 'hypropos-show-brief-docs 'hyper-apropos-show-brief-docs)
|
|
|
82 ;; I changed this to true because I think it's more useful this way. --ben
|
|
|
83
|
|
|
84 (defcustom hyper-apropos-programming-apropos t
|
|
|
85 "*If non-nil, list all the functions and variables.
|
|
|
86 This will cause more output to be generated, and take a longer time.
|
|
|
87
|
|
|
88 Otherwise, only the interactive functions and user variables will be listed."
|
|
|
89 :type 'boolean
|
|
|
90 :group 'hyper-apropos)
|
|
|
91 (define-obsolete-variable-alias
|
|
|
92 'hypropos-programming-apropos 'hyper-apropos-programming-apropos)
|
|
|
93
|
|
|
94 (defcustom hyper-apropos-shrink-window nil
|
|
|
95 "*If non-nil, shrink *Hyper Help* buffer if possible."
|
|
|
96 :type 'boolean
|
|
|
97 :group 'hyper-apropos)
|
|
|
98 (define-obsolete-variable-alias
|
|
|
99 'hypropos-shrink-window 'hyper-apropos-shrink-window)
|
|
|
100
|
|
|
101 (defcustom hyper-apropos-prettyprint-long-values t
|
|
|
102 "*If non-nil, then try to beautify the printing of very long values."
|
|
|
103 :type 'boolean
|
|
|
104 :group 'hyper-apropos)
|
|
|
105 (define-obsolete-variable-alias
|
|
|
106 'hypropos-prettyprint-long-values 'hyper-apropos-prettyprint-long-values)
|
|
|
107
|
|
|
108 (defgroup hyper-apropos-faces nil
|
|
|
109 "Faces defined by hyper-apropos."
|
|
|
110 :prefix "hyper-apropos-"
|
|
|
111 :group 'faces)
|
|
|
112
|
|
|
113 (defface hyper-apropos-documentation
|
|
|
114 '((((class color) (background light))
|
|
|
115 (:foreground "darkred"))
|
|
|
116 (((class color) (background dark))
|
|
|
117 (:foreground "gray90")))
|
|
|
118 "Hyper-apropos documentation."
|
|
|
119 :group 'hyper-apropos-faces)
|
|
|
120
|
|
|
121 (defface hyper-apropos-hyperlink
|
|
|
122 '((((class color) (background light))
|
|
|
123 (:foreground "blue4"))
|
|
|
124 (((class color) (background dark))
|
|
|
125 (:foreground "lightseagreen"))
|
|
|
126 (t
|
|
|
127 (:bold t)))
|
|
|
128 "Hyper-apropos hyperlinks."
|
|
|
129 :group 'hyper-apropos-faces)
|
|
|
130
|
|
|
131 (defface hyper-apropos-major-heading '((t (:bold t)))
|
|
|
132 "Hyper-apropos major heading."
|
|
|
133 :group 'hyper-apropos-faces)
|
|
|
134
|
|
|
135 (defface hyper-apropos-section-heading '((t (:bold t :italic t)))
|
|
|
136 "Hyper-apropos section heading."
|
|
|
137 :group 'hyper-apropos-faces)
|
|
|
138
|
|
|
139 (defface hyper-apropos-heading '((t (:bold t)))
|
|
|
140 "Hyper-apropos heading."
|
|
|
141 :group 'hyper-apropos-faces)
|
|
|
142
|
|
|
143 (defface hyper-apropos-warning '((t (:bold t :foreground "red")))
|
|
|
144 "Hyper-apropos warning."
|
|
|
145 :group 'hyper-apropos-faces)
|
|
|
146
|
|
|
147 ;;; Internal variables below this point
|
|
|
148
|
|
|
149 (defvar hyper-apropos-ref-buffer)
|
|
|
150 (defvar hyper-apropos-prev-wconfig)
|
|
|
151
|
|
|
152 (defvar hyper-apropos-help-map
|
|
|
153 (let ((map (make-sparse-keymap)))
|
|
|
154 (suppress-keymap map)
|
|
|
155 (set-keymap-name map 'hyper-apropos-help-map)
|
|
|
156 ;; movement
|
|
|
157 (define-key map " " 'scroll-up)
|
|
|
158 (define-key map "b" 'scroll-down)
|
|
|
159 (define-key map [delete] 'scroll-down)
|
|
|
160 (define-key map [backspace] 'scroll-down)
|
|
|
161 (define-key map "/" 'isearch-forward)
|
|
|
162 (define-key map "?" 'isearch-backward)
|
|
|
163 ;; follow links
|
|
|
164 (define-key map [return] 'hyper-apropos-get-doc)
|
|
|
165 (define-key map "s" 'hyper-apropos-set-variable)
|
|
|
166 (define-key map "t" 'hyper-apropos-find-tag)
|
|
|
167 (define-key map "l" 'hyper-apropos-last-help)
|
|
|
168 (define-key map "c" 'hyper-apropos-customize-variable)
|
|
|
169 (define-key map "f" 'hyper-apropos-find-function)
|
|
|
170 (define-key map [button2] 'hyper-apropos-mouse-get-doc)
|
|
|
171 (define-key map [button3] 'hyper-apropos-popup-menu)
|
|
|
172 ;; for the totally hardcore...
|
|
|
173 (define-key map "D" 'hyper-apropos-disassemble)
|
|
|
174 ;; administrativa
|
|
|
175 (define-key map "a" 'hyper-apropos)
|
|
|
176 (define-key map "n" 'hyper-apropos)
|
|
|
177 (define-key map "q" 'hyper-apropos-quit)
|
|
|
178 map)
|
|
|
179 "Keybindings for the *Hyper Help* buffer and the *Hyper Apropos* buffer")
|
|
|
180 (define-obsolete-variable-alias
|
|
|
181 'hypropos-help-map 'hyper-apropos-help-map)
|
|
|
182
|
|
|
183 (defvar hyper-apropos-map
|
|
|
184 (let ((map (make-sparse-keymap)))
|
|
|
185 (set-keymap-name map 'hyper-apropos-map)
|
|
|
186 (set-keymap-parents map (list hyper-apropos-help-map))
|
|
|
187 ;; slightly different scrolling...
|
|
|
188 (define-key map " " 'hyper-apropos-scroll-up)
|
|
|
189 (define-key map "b" 'hyper-apropos-scroll-down)
|
|
|
190 (define-key map [delete] 'hyper-apropos-scroll-down)
|
|
|
191 (define-key map [backspace] 'hyper-apropos-scroll-down)
|
|
|
192 ;; act on the current line...
|
|
|
193 (define-key map "w" 'hyper-apropos-where-is)
|
|
|
194 (define-key map "i" 'hyper-apropos-invoke-fn)
|
|
|
195 ;; this is already defined in the parent-keymap above, isn't it?
|
|
|
196 ;; (define-key map "s" 'hyper-apropos-set-variable)
|
|
|
197 ;; more administrativa...
|
|
|
198 (define-key map "P" 'hyper-apropos-toggle-programming-flag)
|
|
|
199 (define-key map "k" 'hyper-apropos-add-keyword)
|
|
|
200 (define-key map "e" 'hyper-apropos-eliminate-keyword)
|
|
|
201 map)
|
|
|
202 "Keybindings for the *Hyper Apropos* buffer.
|
|
|
203 This map inherits from `hyper-apropos-help-map.'")
|
|
|
204 (define-obsolete-variable-alias
|
|
|
205 'hypropos-map 'hyper-apropos-map)
|
|
|
206
|
|
|
207 ;;(defvar hyper-apropos-mousable-keymap
|
|
|
208 ;; (let ((map (make-sparse-keymap)))
|
|
|
209 ;; (define-key map [button2] 'hyper-apropos-mouse-get-doc)
|
|
|
210 ;; map))
|
|
|
211
|
|
|
212 (defvar hyper-apropos-mode-hook nil
|
|
|
213 "*User function run after hyper-apropos mode initialization. Usage:
|
|
|
214 \(add-hook 'hyper-apropos-mode-hook #'(lambda () ... your init forms ...)).")
|
|
|
215
|
|
|
216 ;; ---------------------------------------------------------------------- ;;
|
|
|
217
|
|
|
218 (defconst hyper-apropos-junk-regexp
|
|
|
219 "^Apropos\\|^Functions\\|^Variables\\|^$")
|
|
|
220
|
|
|
221 (defvar hyper-apropos-currently-showing nil) ; symbol documented in
|
|
|
222 ; help buffer now
|
|
|
223 (defvar hyper-apropos-help-history nil) ; chain of symbols followed as links in
|
|
|
224 ; help buffer
|
|
|
225 (defvar hyper-apropos-face-history nil)
|
|
|
226 ;;;(defvar hyper-apropos-variable-history nil)
|
|
|
227 ;;;(defvar hyper-apropos-function-history nil)
|
|
|
228 (defvar hyper-apropos-regexp-history nil)
|
|
|
229 (defvar hyper-apropos-last-regexp nil) ; regex used for last apropos
|
|
|
230 (defconst hyper-apropos-apropos-buf "*Hyper Apropos*")
|
|
|
231 (defconst hyper-apropos-help-buf "*Hyper Help*")
|
|
|
232
|
|
|
233 ;;;###autoload
|
|
|
234 (defun hyper-apropos (regexp toggle-apropos)
|
|
|
235 "Display lists of functions and variables matching REGEXP
|
|
|
236 in buffer \"*Hyper Apropos*\". If optional prefix arg is given, then the
|
|
|
237 value of `hyper-apropos-programming-apropos' is toggled for this search.
|
|
|
238 See also `hyper-apropos-mode'."
|
|
|
239 (interactive (list (read-from-minibuffer "List symbols matching regexp: "
|
|
|
240 nil nil nil 'hyper-apropos-regexp-history)
|
|
|
241 current-prefix-arg))
|
|
|
242 (or (memq major-mode '(hyper-apropos-mode hyper-apropos-help-mode))
|
|
|
243 (setq hyper-apropos-prev-wconfig (current-window-configuration)))
|
|
|
244 (if (string= "" regexp)
|
|
|
245 (if (get-buffer hyper-apropos-apropos-buf)
|
|
|
246 (if toggle-apropos
|
|
|
247 (hyper-apropos-toggle-programming-flag)
|
|
|
248 (message "Using last search results"))
|
|
|
249 (error "Be more specific..."))
|
|
|
250 (set-buffer (get-buffer-create hyper-apropos-apropos-buf))
|
|
|
251 (setq buffer-read-only nil)
|
|
|
252 (erase-buffer)
|
|
|
253 (if toggle-apropos
|
|
|
254 (set (make-local-variable 'hyper-apropos-programming-apropos)
|
|
|
255 (not (default-value 'hyper-apropos-programming-apropos))))
|
|
|
256 (let ((flist (apropos-internal regexp
|
|
|
257 (if hyper-apropos-programming-apropos
|
|
|
258 #'fboundp
|
|
|
259 #'commandp)))
|
|
|
260 (vlist (apropos-internal regexp
|
|
|
261 (if hyper-apropos-programming-apropos
|
|
|
262 #'boundp
|
|
|
263 #'user-variable-p))))
|
|
|
264 (insert-face (format "Apropos search for: %S\n\n" regexp)
|
|
|
265 'hyper-apropos-major-heading)
|
|
|
266 (insert-face "* = command (M-x) or user-variable.\n"
|
|
|
267 'hyper-apropos-documentation)
|
|
|
268 (insert-face "\
|
|
|
269 a = autoloaded, b = byte-compiled, i = internal, l = lambda, m = macro.\n\n"
|
|
|
270 'hyper-apropos-documentation)
|
|
|
271 (insert-face "Functions and Macros:\n\n" 'hyper-apropos-major-heading)
|
|
|
272 (hyper-apropos-grok-functions flist)
|
|
|
273 (insert-face "\n\nVariables and Constants:\n\n"
|
|
|
274 'hyper-apropos-major-heading)
|
|
|
275 (hyper-apropos-grok-variables vlist)
|
|
|
276 (goto-char (point-min))))
|
|
|
277 (switch-to-buffer hyper-apropos-apropos-buf)
|
|
|
278 (hyper-apropos-mode regexp))
|
|
|
279
|
|
|
280 (defun hyper-apropos-toggle-programming-flag ()
|
|
|
281 (interactive)
|
|
|
282 (with-current-buffer hyper-apropos-apropos-buf
|
|
|
283 (set (make-local-variable 'hyper-apropos-programming-apropos)
|
|
|
284 (not hyper-apropos-programming-apropos)))
|
|
|
285 (message "Re-running apropos...")
|
|
|
286 (hyper-apropos hyper-apropos-last-regexp nil))
|
|
|
287
|
|
|
288 (defun hyper-apropos-grok-functions (fns)
|
|
|
289 (let (bind doc type)
|
|
|
290 (dolist (fn fns)
|
|
|
291 (setq bind (symbol-function fn)
|
|
|
292 type (cond ((subrp bind) ?i)
|
|
|
293 ((compiled-function-p bind) ?b)
|
|
|
294 ((consp bind) (or (cdr
|
|
|
295 (assq (car bind) '((autoload . ?a)
|
|
|
296 (lambda . ?l)
|
|
|
297 (macro . ?m))))
|
|
|
298 ??))
|
|
|
299 (t ?\ )))
|
|
|
300 (insert type (if (commandp fn) "* " " "))
|
|
|
301 (let ((e (insert-face (format "%S" fn) 'hyper-apropos-hyperlink)))
|
|
|
302 (set-extent-property e 'mouse-face 'highlight))
|
|
|
303 (insert-char ?\ (let ((l (- 30 (length (format "%S" fn)))))
|
|
|
304 (if (natnump l) l 0)))
|
|
|
305 (and hyper-apropos-show-brief-docs
|
|
|
306 (setq doc
|
|
|
307 ;; A symbol's function slot can point to an unbound symbol.
|
|
|
308 ;; In that case, `documentation' will fail.
|
|
|
309 (ignore-errors
|
|
|
310 (documentation fn)))
|
|
|
311 (if (string-match
|
|
|
312 "^([^\n\t )]+[\t ]*\\([^\n)]+\\)?)\\(:[\t ]*\\|\n?\\'\\)"
|
|
|
313 doc)
|
|
|
314 (setq doc (substring doc (match-end 0) (string-match "\n" doc)))
|
|
|
315 t)
|
|
|
316 (insert-face (if doc
|
|
|
317 (concat " - "
|
|
|
318 (substring doc 0 (string-match "\n" doc)))
|
|
|
319 " Not documented.")
|
|
|
320 'hyper-apropos-documentation))
|
|
|
321 (insert ?\n))))
|
|
|
322
|
|
|
323 (defun hyper-apropos-grok-variables (vars)
|
|
|
324 (let (doc userp)
|
|
|
325 (dolist (var vars)
|
|
|
326 (setq userp (user-variable-p var))
|
|
|
327 (insert (if userp " * " " "))
|
|
|
328 (let ((e (insert-face (format "%S" var) 'hyper-apropos-hyperlink)))
|
|
|
329 (set-extent-property e 'mouse-face 'highlight))
|
|
|
330 (insert-char ?\ (let ((l (- 30 (length (format "%S" var)))))
|
|
|
331 (if (natnump l) l 0)))
|
|
|
332 (and hyper-apropos-show-brief-docs
|
|
|
333 (setq doc (documentation-property var 'variable-documentation))
|
|
|
334 (insert-face (if doc
|
|
|
335 (concat " - " (substring doc (if userp 1 0)
|
|
|
336 (string-match "\n" doc)))
|
|
|
337 " - Not documented.")
|
|
|
338 'hyper-apropos-documentation))
|
|
|
339 (insert ?\n))))
|
|
|
340
|
|
|
341 ;; ---------------------------------------------------------------------- ;;
|
|
|
342
|
|
|
343 (defun hyper-apropos-mode (regexp)
|
|
|
344 "Improved apropos mode for displaying Emacs documentation. Function and
|
|
|
345 variable names are displayed in the buffer \"*Hyper Apropos*\".
|
|
|
346
|
|
|
347 Functions are preceded by a single character to indicates their types:
|
|
|
348 a = autoloaded, b = byte-compiled, i = internal, l = lambda, m = macro.
|
|
|
349 Interactive functions are also preceded by an asterisk.
|
|
|
350 Variables are preceded by an asterisk if they are user variables.
|
|
|
351
|
|
|
352 General Commands:
|
|
|
353
|
|
|
354 SPC - scroll documentation or apropos window forward
|
|
|
355 b - scroll documentation or apropos window backward
|
|
|
356 k - eliminate all hits that don't contain keyword
|
|
|
357 n - new search
|
|
|
358 / - isearch-forward
|
|
|
359 q - quit and restore previous window configuration
|
|
|
360
|
|
|
361 Operations for Symbol on Current Line:
|
|
|
362
|
|
|
363 RET - toggle display of symbol's documentation
|
|
|
364 (also on button2 in xemacs)
|
|
|
365 w - show the keybinding if symbol is a command
|
|
|
366 i - invoke function on current line
|
|
|
367 s - set value of variable on current line
|
|
|
368 t - display the C or lisp source (find-tag)"
|
|
|
369 (delete-other-windows)
|
|
|
370 (setq mode-name "Hyper-Apropos"
|
|
|
371 major-mode 'hyper-apropos-mode
|
|
|
372 buffer-read-only t
|
|
|
373 truncate-lines t
|
|
|
374 hyper-apropos-last-regexp regexp
|
|
|
375 modeline-buffer-identification
|
|
|
376 (list (cons modeline-buffer-id-left-extent "Hyper Apropos: ")
|
|
|
377 (cons modeline-buffer-id-right-extent (concat "\"" regexp "\""))))
|
|
|
378 (use-local-map hyper-apropos-map)
|
|
|
379 (run-hooks 'hyper-apropos-mode-hook))
|
|
|
380
|
|
|
381 ;; ---------------------------------------------------------------------- ;;
|
|
|
382
|
|
|
383 ;; similar to `describe-key-briefly', copied from help.el by CW
|
|
|
384
|
|
|
385 ;;;###autoload
|
|
|
386 (defun hyper-describe-key (key)
|
|
|
387 (interactive "kDescribe key: ")
|
|
|
388 (hyper-describe-key-briefly key t))
|
|
|
389
|
|
|
390 ;;;###autoload
|
|
|
391 (defun hyper-describe-key-briefly (key &optional show)
|
|
|
392 (interactive "kDescribe key briefly: \nP")
|
|
|
393 (let (menup defn interm final msg)
|
|
|
394 (setq defn (key-or-menu-binding key 'menup))
|
|
|
395 (if (or (null defn) (integerp defn))
|
|
|
396 (or (numberp show) (message "%s is undefined" (key-description key)))
|
|
|
397 (cond ((stringp defn)
|
|
|
398 (setq interm defn
|
|
|
399 final (key-binding defn)))
|
|
|
400 ((vectorp defn)
|
|
|
401 (setq interm (append defn nil))
|
|
|
402 (while (and interm
|
|
|
403 (member (key-binding (vector (car interm)))
|
|
|
404 '(universal-argument digit-argument)))
|
|
|
405 (setq interm (cdr interm)))
|
|
|
406 (while (and interm
|
|
|
407 (not (setq final (key-binding (vconcat interm)))))
|
|
|
408 (setq interm (butlast interm)))
|
|
|
409 (if final
|
|
|
410 (setq interm (vconcat interm))
|
|
|
411 (setq interm defn
|
|
|
412 final (key-binding defn)))))
|
|
|
413 (setq msg (format
|
|
|
414 "%s runs %s%s%s"
|
|
|
415 ;; This used to say 'This menu item' but it could also
|
|
|
416 ;; be a scrollbar event. We can't distinguish at the
|
|
|
417 ;; moment.
|
|
|
418 (if menup "This item" (key-description key))
|
|
|
419 ;;(if (symbolp defn) defn (key-description defn))
|
|
|
420 (if (symbolp defn) defn (prin1-to-string defn))
|
|
|
421 (if final (concat ", " (key-description interm) " runs ") "")
|
|
|
422 (if final
|
|
|
423 (if (symbolp final) final (prin1-to-string final))
|
|
|
424 "")))
|
|
|
425 (if (numberp show)
|
|
|
426 (or (not (symbolp defn))
|
|
|
427 (memq (symbol-function defn)
|
|
|
428 '(zkey-init-kbd-macro zkey-init-kbd-fn))
|
|
|
429 (progn (princ msg) (princ "\n")))
|
|
|
430 (message "%s" msg)
|
|
|
431 (if final (setq defn final))
|
|
|
432 (if (and (or (symbolp defn) (symbolp (setq defn (car-safe defn))))
|
|
|
433 defn
|
|
|
434 show)
|
|
|
435 (hyper-apropos-get-doc defn t))))))
|
|
|
436
|
|
|
437 ;;;###autoload
|
|
|
438 (defun hyper-describe-face (symbol &optional this-ref-buffer)
|
|
|
439 "Describe face..
|
|
|
440 See also `hyper-apropos' and `hyper-describe-function'."
|
|
|
441 ;; #### - perhaps a prefix arg should suppress the prompt...
|
|
|
442 (interactive
|
|
|
443 (let (v val)
|
|
|
444 (setq v (hyper-apropos-this-symbol)) ; symbol under point
|
|
|
445 (or (find-face v)
|
|
|
446 (setq v (variable-at-point)))
|
|
|
447 (setq val (let ((enable-recursive-minibuffers t))
|
|
|
448 (completing-read
|
|
|
449 (concat (if (hyper-apropos-follow-ref-buffer current-prefix-arg)
|
|
|
450 "Follow face"
|
|
|
451 "Describe face")
|
|
|
452 (if v
|
|
|
453 (format " (default %s): " v)
|
|
|
454 ": "))
|
|
|
455 (mapcar #'(lambda (x) (list (symbol-name x)))
|
|
|
456 (face-list))
|
|
|
457 nil t nil 'hyper-apropos-face-history)))
|
|
|
458 (list (if (string= val "")
|
|
|
459 (progn (push (symbol-name v) hyper-apropos-face-history) v)
|
|
|
460 (intern-soft val))
|
|
|
461 current-prefix-arg)))
|
|
|
462 (if (null symbol)
|
|
|
463 (message "Sorry, nothing to describe.")
|
|
|
464 (or (memq major-mode '(hyper-apropos-mode hyper-apropos-help-mode))
|
|
|
465 (setq hyper-apropos-prev-wconfig (current-window-configuration)))
|
|
|
466 (hyper-apropos-get-doc symbol t nil this-ref-buffer)))
|
|
|
467
|
|
|
468 ;;;###autoload
|
|
|
469 (defun hyper-describe-variable (symbol &optional this-ref-buffer)
|
|
|
470 "Hypertext drop-in replacement for `describe-variable'.
|
|
|
471 See also `hyper-apropos' and `hyper-describe-function'."
|
|
|
472 ;; #### - perhaps a prefix arg should suppress the prompt...
|
|
|
473 (interactive (list (hyper-apropos-read-variable-symbol
|
|
|
474 (if (hyper-apropos-follow-ref-buffer current-prefix-arg)
|
|
|
475 "Follow variable"
|
|
|
476 "Describe variable"))
|
|
|
477 current-prefix-arg))
|
|
|
478 (if (null symbol)
|
|
|
479 (message "Sorry, nothing to describe.")
|
|
|
480 (or (memq major-mode '(hyper-apropos-mode hyper-apropos-help-mode))
|
|
|
481 (setq hyper-apropos-prev-wconfig (current-window-configuration)))
|
|
|
482 (hyper-apropos-get-doc symbol t nil this-ref-buffer)))
|
|
|
483
|
|
|
484 ;;;###autoload
|
|
|
485 (defun hyper-where-is (symbol)
|
|
|
486 "Print message listing key sequences that invoke specified command."
|
|
|
487 (interactive (list (hyper-apropos-read-function-symbol "Where is function")))
|
|
|
488 (if (null symbol)
|
|
|
489 (message "Sorry, nothing to describe.")
|
|
|
490 (where-is symbol)))
|
|
|
491
|
|
|
492 ;;;###autoload
|
|
|
493 (defun hyper-describe-function (symbol &optional this-ref-buffer)
|
|
|
494 "Hypertext replacement for `describe-function'. Unlike `describe-function'
|
|
|
495 in that the symbol under the cursor is the default if it is a function.
|
|
|
496 See also `hyper-apropos' and `hyper-describe-variable'."
|
|
|
497 ;; #### - perhaps a prefix arg should suppress the prompt...
|
|
|
498 (interactive (list (hyper-apropos-read-function-symbol
|
|
|
499 (if (hyper-apropos-follow-ref-buffer current-prefix-arg)
|
|
|
500 "Follow function"
|
|
|
501 "Describe function"))
|
|
|
502 current-prefix-arg))
|
|
|
503 (if (null symbol)
|
|
|
504 (message "Sorry, nothing to describe.")
|
|
|
505 (or (memq major-mode '(hyper-apropos-mode hyper-apropos-help-mode))
|
|
|
506 (setq hyper-apropos-prev-wconfig (current-window-configuration)))
|
|
|
507 (hyper-apropos-get-doc symbol t nil this-ref-buffer)))
|
|
|
508
|
|
|
509 ;;;###autoload
|
|
|
510 (defun hyper-apropos-read-variable-symbol (prompt &optional predicate)
|
|
|
511 "Hypertext drop-in replacement for `describe-variable'.
|
|
|
512 See also `hyper-apropos' and `hyper-describe-function'."
|
|
|
513 ;; #### - perhaps a prefix arg should suppress the prompt...
|
|
|
514 (or predicate (setq predicate 'boundp))
|
|
|
515 (let (v val)
|
|
|
516 (setq v (hyper-apropos-this-symbol)) ; symbol under point
|
|
|
517 (or (funcall predicate v)
|
|
|
518 (setq v (variable-at-point)))
|
|
|
519 (or (funcall predicate v)
|
|
|
520 (setq v nil))
|
|
|
521 (setq val (let ((enable-recursive-minibuffers t))
|
|
|
522 (completing-read
|
|
|
523 (concat prompt
|
|
|
524 (if v
|
|
|
525 (format " (default %s): " v)
|
|
|
526 ": "))
|
|
|
527 obarray predicate t nil 'variable-history)))
|
|
|
528 (if (string= val "")
|
|
|
529 (progn (push (symbol-name v) variable-history) v)
|
|
|
530 (intern-soft val))))
|
|
|
531 ;;;###autoload
|
|
|
532 (define-obsolete-function-alias
|
|
|
533 'hypropos-read-variable-symbol 'hyper-apropos-read-variable-symbol)
|
|
|
534
|
|
|
535 (defun hyper-apropos-read-function-symbol (prompt)
|
|
|
536 "Read function symbol from minibuffer."
|
|
|
537 (let ((fn (hyper-apropos-this-symbol))
|
|
|
538 val)
|
|
|
539 (or (fboundp fn)
|
|
|
540 (setq fn (function-at-point)))
|
|
|
541 (setq val (let ((enable-recursive-minibuffers t))
|
|
|
542 (completing-read (if fn
|
|
|
543 (format "%s (default %s): " prompt fn)
|
|
|
544 (format "%s: " prompt))
|
|
|
545 obarray 'fboundp t nil
|
|
|
546 'function-history)))
|
|
|
547 (if (equal val "")
|
|
|
548 (progn (push (symbol-name fn) function-history) fn)
|
|
|
549 (intern-soft val))))
|
|
|
550
|
|
|
551 (defun hyper-apropos-last-help (arg)
|
|
|
552 "Go back to the last symbol documented in the *Hyper Help* buffer."
|
|
|
553 (interactive "P")
|
|
|
554 (let ((win (get-buffer-window hyper-apropos-help-buf)))
|
|
|
555 (or arg (setq arg (if win 1 0)))
|
|
|
556 (cond ((= arg 0))
|
|
|
557 ((<= (length hyper-apropos-help-history) arg)
|
|
|
558 ;; go back as far as we can...
|
|
|
559 (setcdr (nreverse hyper-apropos-help-history) nil))
|
|
|
560 (t
|
|
|
561 (setq hyper-apropos-help-history
|
|
|
562 (nthcdr arg hyper-apropos-help-history))))
|
|
|
563 (if (or win (> arg 0))
|
|
|
564 (hyper-apropos-get-doc (car hyper-apropos-help-history) t)
|
|
|
565 (display-buffer hyper-apropos-help-buf))))
|
|
|
566
|
|
|
567 (defun hyper-apropos-insert-face (string &optional face)
|
|
|
568 "Insert STRING and fontify some parts with face `hyper-apropos-hyperlink'."
|
|
|
569 (let ((beg (point)) end)
|
|
|
570 (insert-face string (or face 'hyper-apropos-documentation))
|
|
|
571 (setq end (point))
|
|
|
572 (goto-char beg)
|
|
|
573 (while (re-search-forward
|
|
|
574 "`\\([-a-zA-Z0-9_][-a-zA-Z0-9_][-a-zA-Z0-9_.]+\\)'"
|
|
|
575 end 'limit)
|
|
|
576 (let ((e (make-extent (match-beginning 1) (match-end 1))))
|
|
|
577 (set-extent-face e 'hyper-apropos-hyperlink)
|
|
|
578 (set-extent-property e 'mouse-face 'highlight)))
|
|
|
579 (goto-char beg)
|
|
|
580 (while (re-search-forward
|
|
|
581 "M-x \\([-a-zA-Z0-9_][-a-zA-Z0-9_][-a-zA-Z0-9_.]+\\)"
|
|
|
582 end 'limit)
|
|
|
583 (let ((e (make-extent (match-beginning 1) (match-end 1))))
|
|
|
584 (set-extent-face e 'hyper-apropos-hyperlink)
|
|
|
585 (set-extent-property e 'mouse-face 'highlight)))))
|
|
|
586
|
|
|
587 (defun hyper-apropos-insert-keybinding (keys string)
|
|
|
588 (if keys
|
|
|
589 (insert " (" string " bound to \""
|
|
|
590 (mapconcat 'key-description
|
|
|
591 (sort* keys #'< :key #'length)
|
|
|
592 "\", \"")
|
|
|
593 "\")\n")))
|
|
|
594
|
|
|
595 (defun hyper-apropos-insert-section-heading (alias-desc &optional desc)
|
|
|
596 (or desc (setq desc alias-desc
|
|
|
597 alias-desc nil))
|
|
|
598 (if alias-desc
|
|
|
599 (setq desc (concat alias-desc
|
|
|
600 (if (memq (aref desc 0)
|
|
|
601 '(?a ?e ?i ?o ?u))
|
|
|
602 ", an " ", a ")
|
|
|
603 desc)))
|
|
|
604 (aset desc 0 (upcase (aref desc 0))) ; capitalize
|
|
|
605 (goto-char (point-max))
|
|
|
606 (newline 3) (delete-blank-lines) (newline 2)
|
|
|
607 (hyper-apropos-insert-face desc 'hyper-apropos-section-heading))
|
|
|
608
|
|
|
609 (defun hyper-apropos-insert-value (string symbol val)
|
|
|
610 (insert-face string 'hyper-apropos-heading)
|
|
|
611 (insert (if (symbol-value symbol)
|
|
|
612 (if (or (null val) (eq val t) (integerp val))
|
|
|
613 (prog1
|
|
|
614 (symbol-value symbol)
|
|
|
615 (set symbol nil))
|
|
|
616 "see below")
|
|
|
617 "is void")))
|
|
|
618
|
|
|
619 (defun hyper-apropos-follow-ref-buffer (this-ref-buffer)
|
|
|
620 (and (not this-ref-buffer)
|
|
|
621 (eq major-mode 'hyper-apropos-help-mode)
|
|
|
622 hyper-apropos-ref-buffer
|
|
|
623 (buffer-live-p hyper-apropos-ref-buffer)))
|
|
|
624
|
|
|
625 (defun hyper-apropos-get-alias (symbol alias-p next-symbol &optional use)
|
|
|
626 "Return (TERMINAL-SYMBOL . ALIAS-DESC)."
|
|
|
627 (let (aliases)
|
|
|
628 (while (funcall alias-p symbol)
|
|
|
629 (setq aliases (cons (if use (funcall use symbol) symbol) aliases))
|
|
|
630 (setq symbol (funcall next-symbol symbol)))
|
|
|
631 (cons symbol
|
|
|
632 (and aliases
|
|
|
633 (concat "an alias for `"
|
|
|
634 (mapconcat 'symbol-name
|
|
|
635 (nreverse aliases)
|
|
|
636 "',\nwhich is an alias for `")
|
|
|
637 "'")))))
|
|
|
638
|
|
|
639 (defun hyper-apropos-get-doc (&optional symbol force type this-ref-buffer)
|
|
|
640 ;; #### - update this docstring
|
|
|
641 "Toggle display of documentation for the symbol on the current line."
|
|
|
642 ;; SYMBOL is the symbol to document. FORCE, if non-nil, means to
|
|
|
643 ;; regenerate the documentation even if it already seems to be there. And
|
|
|
644 ;; TYPE, if present, forces the generation of only variable documentation
|
|
|
645 ;; or only function documentation. Normally, if both are present, then
|
|
|
646 ;; both will be generated.
|
|
|
647 ;;
|
|
|
648 ;; TYPES TO IMPLEMENT: obsolete face
|
|
|
649 ;;
|
|
|
650 (interactive)
|
|
|
651 (or symbol
|
|
|
652 (setq symbol (hyper-apropos-this-symbol)))
|
|
|
653 (or type
|
|
|
654 (setq type '(function variable face)))
|
|
|
655 (if (and (eq hyper-apropos-currently-showing symbol)
|
|
|
656 (get-buffer hyper-apropos-help-buf)
|
|
|
657 (get-buffer-window hyper-apropos-help-buf)
|
|
|
658 (not force))
|
|
|
659 ;; we're already displaying this help, so toggle its display.
|
|
|
660 (delete-windows-on hyper-apropos-help-buf)
|
|
|
661 ;; OK, we've got to refresh and display it...
|
|
|
662 (or (eq symbol (car hyper-apropos-help-history))
|
|
|
663 (setq hyper-apropos-help-history
|
|
|
664 (if (eq major-mode 'hyper-apropos-help-mode)
|
|
|
665 ;; if we're following a link in the help buffer, then
|
|
|
666 ;; record that in the help history.
|
|
|
667 (cons symbol hyper-apropos-help-history)
|
|
|
668 ;; otherwise clear the history because it's a new search.
|
|
|
669 (list symbol))))
|
|
|
670 (save-excursion
|
|
|
671 (if (hyper-apropos-follow-ref-buffer this-ref-buffer)
|
|
|
672 (set-buffer hyper-apropos-ref-buffer)
|
|
|
673 (setq hyper-apropos-ref-buffer (current-buffer)))
|
|
|
674 (let (standard-output
|
|
|
675 ok beg
|
|
|
676 newsym symtype doc obsolete
|
|
|
677 (local mode-name)
|
|
|
678 global local-str global-str
|
|
|
679 font fore back undl
|
|
|
680 aliases alias-desc desc)
|
|
|
681 (save-excursion
|
|
|
682 (set-buffer (get-buffer-create hyper-apropos-help-buf))
|
|
|
683 ;;(setq standard-output (current-buffer))
|
|
|
684 (setq buffer-read-only nil)
|
|
|
685 (erase-buffer)
|
|
|
686 (insert-face (format "`%s'" symbol) 'hyper-apropos-major-heading)
|
|
|
687 (insert (format " (buffer: %s, mode: %s)\n"
|
|
|
688 (buffer-name hyper-apropos-ref-buffer)
|
|
|
689 local)))
|
|
|
690 ;; function ----------------------------------------------------------
|
|
|
691 (and (memq 'function type)
|
|
|
692 (fboundp symbol)
|
|
|
693 (progn
|
|
|
694 (setq ok t)
|
|
|
695 (setq aliases (hyper-apropos-get-alias (symbol-function symbol)
|
|
|
696 'symbolp
|
|
|
697 'symbol-function)
|
|
|
698 newsym (car aliases)
|
|
|
699 alias-desc (cdr aliases))
|
|
|
700 (if (eq 'macro (car-safe newsym))
|
|
|
701 (setq desc "macro"
|
|
|
702 newsym (cdr newsym))
|
|
|
703 (setq desc "function"))
|
|
|
704 (setq symtype (cond ((subrp newsym) 'subr)
|
|
|
705 ((compiled-function-p newsym) 'bytecode)
|
|
|
706 ((eq (car-safe newsym) 'autoload) 'autoload)
|
|
|
707 ((eq (car-safe newsym) 'lambda) 'lambda))
|
|
|
708 desc (concat (if (commandp symbol) "interactive ")
|
|
|
709 (cdr (assq symtype
|
|
|
710 '((subr . "built-in ")
|
|
|
711 (bytecode . "compiled Lisp ")
|
|
|
712 (autoload . "autoloaded Lisp ")
|
|
|
713 (lambda . "Lisp "))))
|
|
|
714 desc
|
|
|
715 (case symtype
|
|
|
716 ((autoload) (format ",\n(autoloaded from \"%s\")"
|
|
|
717 (nth 1 newsym)))
|
|
|
718 ((bytecode) (format ",\n(loaded from \"%s\")"
|
|
|
719 (symbol-file symbol)))))
|
|
|
720 local (current-local-map)
|
|
|
721 global (current-global-map)
|
|
|
722 obsolete (get symbol 'byte-obsolete-info)
|
|
|
723 doc (or (documentation symbol) "function not documented"))
|
|
|
724 (save-excursion
|
|
|
725 (set-buffer hyper-apropos-help-buf)
|
|
|
726 (goto-char (point-max))
|
|
|
727 (setq standard-output (current-buffer))
|
|
|
728 (hyper-apropos-insert-section-heading alias-desc desc)
|
|
|
729 (insert ":\n")
|
|
|
730 (if local
|
|
|
731 (hyper-apropos-insert-keybinding
|
|
|
732 (where-is-internal symbol (list local) nil nil nil)
|
|
|
733 "locally"))
|
|
|
734 (hyper-apropos-insert-keybinding
|
|
|
735 (where-is-internal symbol (list global) nil nil nil)
|
|
|
736 "globally")
|
|
|
737 (insert "\n")
|
|
|
738 (if obsolete
|
|
|
739 (hyper-apropos-insert-face
|
|
|
740 (format "%s is an obsolete function; %s\n\n" symbol
|
|
|
741 (if (stringp (car obsolete))
|
|
|
742 (car obsolete)
|
|
|
743 (format "use `%s' instead." (car obsolete))))
|
|
|
744 'hyper-apropos-warning))
|
|
|
745 (setq beg (point))
|
|
|
746 (insert-face "arguments: " 'hyper-apropos-heading)
|
|
|
747 (cond ((eq symtype 'lambda)
|
|
|
748 (princ (or (nth 1 newsym) "()")))
|
|
|
749 ((eq symtype 'bytecode)
|
|
|
750 (princ (or (compiled-function-arglist newsym)
|
|
|
751 "()")))
|
|
|
752 ((and (eq symtype 'subr)
|
|
|
753 (string-match
|
|
|
754 "[\n\t ]*\narguments: ?\\((.*)\\)\n?\\'"
|
|
|
755 doc))
|
|
|
756 (insert (substring doc
|
|
|
757 (match-beginning 1)
|
|
|
758 (match-end 1)))
|
|
|
759 (setq doc (substring doc 0 (match-beginning 0))))
|
|
|
760 ((and (eq symtype 'subr)
|
|
|
761 (string-match
|
|
|
762 "\
|
|
|
763 \[\n\t ]*([^\n\t )]+[\t ]*\\([^\n)]+\\)?)\\(:[\t ]*\\|\n?\\'\\)"
|
|
|
764 doc))
|
|
|
765 (insert "("
|
|
|
766 (if (match-end 1)
|
|
|
767 (substring doc
|
|
|
768 (match-beginning 1)
|
|
|
769 (match-end 1)))
|
|
|
770 ")")
|
|
|
771 (setq doc (substring doc (match-end 0))))
|
|
|
772 (t (princ "[not available]")))
|
|
|
773 (insert "\n\n")
|
|
|
774 (hyper-apropos-insert-face doc)
|
|
|
775 (insert "\n")
|
|
|
776 (indent-rigidly beg (point) 2))))
|
|
|
777 ;; variable ----------------------------------------------------------
|
|
|
778 (and (memq 'variable type)
|
|
|
779 (or (boundp symbol) (default-boundp symbol))
|
|
|
780 (progn
|
|
|
781 (setq ok t)
|
|
|
782 (setq aliases (hyper-apropos-get-alias symbol
|
|
|
783 'variable-alias
|
|
|
784 'variable-alias
|
|
|
785 'variable-alias)
|
|
|
786 newsym (car aliases)
|
|
|
787 alias-desc (cdr aliases))
|
|
|
788 (setq symtype (or (local-variable-p newsym (current-buffer))
|
|
|
789 (and (local-variable-p newsym
|
|
|
790 (current-buffer) t)
|
|
|
791 'auto-local))
|
|
|
792 desc (concat (and (get newsym 'custom-type)
|
|
|
793 "customizable ")
|
|
|
794 (if (user-variable-p newsym)
|
|
|
795 "user variable"
|
|
|
796 "variable")
|
|
|
797 (cond ((eq symtype t) ", buffer-local")
|
|
|
798 ((eq symtype 'auto-local)
|
|
|
799 ", local when set")))
|
|
|
800 local (and (boundp newsym)
|
|
|
801 (symbol-value newsym))
|
|
|
802 local-str (and (boundp newsym)
|
|
|
803 (prin1-to-string local))
|
|
|
804 global (and (eq symtype t)
|
|
|
805 (default-boundp newsym)
|
|
|
806 (default-value newsym))
|
|
|
807 global-str (and (eq symtype t)
|
|
|
808 (default-boundp newsym)
|
|
|
809 (prin1-to-string global))
|
|
|
810 obsolete (get symbol 'byte-obsolete-variable)
|
|
|
811 doc (or (documentation-property symbol
|
|
|
812 'variable-documentation)
|
|
|
813 "variable not documented"))
|
|
|
814 (save-excursion
|
|
|
815 (set-buffer hyper-apropos-help-buf)
|
|
|
816 (goto-char (point-max))
|
|
|
817 (setq standard-output (current-buffer))
|
|
|
818 (hyper-apropos-insert-section-heading alias-desc desc)
|
|
|
819 (when (and (user-variable-p newsym)
|
|
|
820 (get newsym 'custom-type))
|
|
|
821 (let ((e (make-extent (point-at-bol) (point))))
|
|
|
822 (set-extent-property e 'mouse-face 'highlight)
|
|
|
823 (set-extent-property e 'help-echo
|
|
|
824 (format "Customize %s" newsym))
|
|
|
825 (set-extent-property
|
|
|
826 e 'hyper-apropos-custom
|
|
|
827 `(lambda () (customize-variable (quote ,newsym))))))
|
|
|
828 (insert ":\n\n")
|
|
|
829 (setq beg (point))
|
|
|
830 (if obsolete
|
|
|
831 (hyper-apropos-insert-face
|
|
|
832 (format "%s is an obsolete function; %s\n\n" symbol
|
|
|
833 (if (stringp obsolete)
|
|
|
834 obsolete
|
|
|
835 (format "use `%s' instead." obsolete)))
|
|
|
836 'hyper-apropos-warning))
|
|
|
837 ;; generally, the value of the variable is short and the
|
|
|
838 ;; documentation of the variable long, so it's desirable
|
|
|
839 ;; to see all of the value and the start of the
|
|
|
840 ;; documentation. Some variables, though, have huge and
|
|
|
841 ;; nearly meaningless values that force you to page
|
|
|
842 ;; forward just to find the doc string. That is
|
|
|
843 ;; undesirable.
|
|
|
844 (if (and (or (null local-str) (< (length local-str) 69))
|
|
|
845 (or (null global-str) (< (length global-str) 69)))
|
|
|
846 ; 80 cols. docstrings assume this.
|
|
|
847 (progn (insert-face "value: " 'hyper-apropos-heading)
|
|
|
848 (insert (or local-str "is void"))
|
|
|
849 (if (eq symtype t)
|
|
|
850 (progn
|
|
|
851 (insert "\n")
|
|
|
852 (insert-face "default value: " 'hyper-apropos-heading)
|
|
|
853 (insert (or global-str "is void"))))
|
|
|
854 (insert "\n\n")
|
|
|
855 (hyper-apropos-insert-face doc))
|
|
|
856 (hyper-apropos-insert-value "value: " 'local-str local)
|
|
|
857 (if (eq symtype t)
|
|
|
858 (progn
|
|
|
859 (insert ", ")
|
|
|
860 (hyper-apropos-insert-value "default-value: "
|
|
|
861 'global-str global)))
|
|
|
862 (insert "\n\n")
|
|
|
863 (hyper-apropos-insert-face doc)
|
|
|
864 (if local-str
|
|
|
865 (progn
|
|
|
866 (newline 3) (delete-blank-lines) (newline 1)
|
|
|
867 (insert-face "value: " 'hyper-apropos-heading)
|
|
|
868 (if hyper-apropos-prettyprint-long-values
|
|
|
869 (condition-case nil
|
|
|
870 (cl-prettyprint local)
|
|
|
871 (error (insert local-str)))
|
|
|
872 (insert local-str))))
|
|
|
873 (if global-str
|
|
|
874 (progn
|
|
|
875 (newline 3) (delete-blank-lines) (newline 1)
|
|
|
876 (insert-face "default value: " 'hyper-apropos-heading)
|
|
|
877 (if hyper-apropos-prettyprint-long-values
|
|
|
878 (condition-case nil
|
|
|
879 (cl-prettyprint global)
|
|
|
880 (error (insert global-str)))
|
|
|
881 (insert global-str)))))
|
|
|
882 (indent-rigidly beg (point) 2))))
|
|
|
883 ;; face --------------------------------------------------------------
|
|
|
884 (and (memq 'face type)
|
|
|
885 (find-face symbol)
|
|
|
886 (progn
|
|
|
887 (setq ok t)
|
|
|
888 (copy-face symbol 'hyper-apropos-temp-face 'global)
|
|
|
889 (mapcar #'(lambda (property)
|
|
|
890 (setq symtype (face-property-instance symbol
|
|
|
891 property))
|
|
|
892 (if symtype
|
|
|
893 (set-face-property 'hyper-apropos-temp-face
|
|
|
894 property
|
|
|
895 symtype)))
|
|
|
896 built-in-face-specifiers)
|
|
|
897 (setq font (cons (face-property-instance symbol 'font nil 0 t)
|
|
|
898 (face-property-instance symbol 'font))
|
|
|
899 fore (cons (face-foreground-instance symbol nil 0 t)
|
|
|
900 (face-foreground-instance symbol))
|
|
|
901 back (cons (face-background-instance symbol nil 0 t)
|
|
|
902 (face-background-instance symbol))
|
|
|
903 undl (cons (face-underline-p symbol nil 0 t)
|
|
|
904 (face-underline-p symbol))
|
|
|
905 doc (face-doc-string symbol))
|
|
|
906 ;; #### - add some code here
|
|
|
907 (save-excursion
|
|
|
908 (set-buffer hyper-apropos-help-buf)
|
|
|
909 (setq standard-output (current-buffer))
|
|
|
910 (hyper-apropos-insert-section-heading
|
|
|
911 (concat "Face"
|
|
|
912 (when (get symbol 'face-defface-spec)
|
|
|
913 (let* ((str " (customizable)")
|
|
|
914 (e (make-extent 1 (length str) str)))
|
|
|
915 (set-extent-property e 'mouse-face 'highlight)
|
|
|
916 (set-extent-property e 'help-echo
|
|
|
917 (format "Customize %s" symbol))
|
|
|
918 (set-extent-property e 'unique t)
|
|
|
919 (set-extent-property e 'duplicable t)
|
|
|
920 (set-extent-property
|
|
|
921 e 'hyper-apropos-custom
|
|
|
922 `(lambda () (customize-face (quote ,symbol))))
|
|
|
923 str))
|
|
|
924 ":\n\n "))
|
|
|
925 (insert-face "\
|
|
|
926 ABCDEFHIJKLMNOPQRSTUVWXYZ abcdefhijklmnopqrstuvwxyz 0123456789"
|
|
|
927 'hyper-apropos-temp-face)
|
|
|
928 (newline 2)
|
|
|
929 (insert-face " Font: " 'hyper-apropos-heading)
|
|
|
930 (insert (format (if (numberp (car font)) "(%s)\n" "%s\n")
|
|
|
931 (and (cdr font)
|
|
|
932 (font-instance-name (cdr font)))))
|
|
|
933 (insert-face " Foreground: " 'hyper-apropos-heading)
|
|
|
934 (insert (format (if (numberp (car fore)) "(%s)\n" "%s\n")
|
|
|
935 (and (cdr fore)
|
|
|
936 (color-instance-name (cdr fore)))))
|
|
|
937 (insert-face " Background: " 'hyper-apropos-heading)
|
|
|
938 (insert (format (if (numberp (car back)) "(%s)\n" "%s\n")
|
|
|
939 (and (cdr back)
|
|
|
940 (color-instance-name (cdr back)))))
|
|
|
941 (insert-face " Underline: " 'hyper-apropos-heading)
|
|
|
942 (insert (format (if (numberp (car undl)) "(%s)\n" "%s\n")
|
|
|
943 (cdr undl)))
|
|
|
944 (if doc
|
|
|
945 (progn
|
|
|
946 (newline)
|
|
|
947 (setq beg (point))
|
|
|
948 (insert doc)
|
|
|
949 (indent-rigidly beg (point) 2))))))
|
|
|
950 ;; not bound & property list -----------------------------------------
|
|
|
951 (or ok
|
|
|
952 (save-excursion
|
|
|
953 (set-buffer hyper-apropos-help-buf)
|
|
|
954 (hyper-apropos-insert-section-heading
|
|
|
955 "symbol is not currently bound\n")))
|
|
|
956 (if (and (setq symtype (symbol-plist symbol))
|
|
|
957 (or (> (length symtype) 2)
|
|
|
958 (not (memq 'variable-documentation symtype))))
|
|
|
959 (save-excursion
|
|
|
960 (set-buffer hyper-apropos-help-buf)
|
|
|
961 (goto-char (point-max))
|
|
|
962 (setq standard-output (current-buffer))
|
|
|
963 (hyper-apropos-insert-section-heading "property-list:\n\n")
|
|
|
964 (while symtype
|
|
|
965 (if (memq (car symtype)
|
|
|
966 '(variable-documentation byte-obsolete-info))
|
|
|
967 (setq symtype (cdr symtype))
|
|
|
968 (insert-face (concat " " (symbol-name (car symtype))
|
|
|
969 ": ")
|
|
|
970 'hyper-apropos-heading)
|
|
|
971 (setq symtype (cdr symtype))
|
|
|
972 (indent-to 32)
|
|
|
973 (insert (prin1-to-string (car symtype)) "\n"))
|
|
|
974 (setq symtype (cdr symtype)))))))
|
|
|
975 (save-excursion
|
|
|
976 (set-buffer hyper-apropos-help-buf)
|
|
|
977 (goto-char (point-min))
|
|
|
978 ;; pop up window and shrink it if it's wasting space
|
|
|
979 (if hyper-apropos-shrink-window
|
|
|
980 (shrink-window-if-larger-than-buffer
|
|
|
981 (display-buffer (current-buffer)))
|
|
|
982 (display-buffer (current-buffer)))
|
|
|
983 (hyper-apropos-help-mode))
|
|
|
984 (setq hyper-apropos-currently-showing symbol)))
|
|
|
985 ;;;###autoload
|
|
|
986 (define-obsolete-function-alias
|
|
|
987 'hypropos-get-doc 'hyper-apropos-get-doc)
|
|
|
988
|
|
|
989 ; -----------------------------------------------------------------------------
|
|
|
990
|
|
|
991 (defun hyper-apropos-help-mode ()
|
|
|
992 "Major mode for hypertext XEmacs help. In this mode, you can quickly
|
|
|
993 follow links between back and forth between the documentation strings for
|
|
|
994 different variables and functions. Common commands:
|
|
|
995
|
|
|
996 \\{hyper-apropos-help-map}"
|
|
|
997 (setq buffer-read-only t
|
|
|
998 major-mode 'hyper-apropos-help-mode
|
|
|
999 mode-name "Hyper-Help")
|
|
|
1000 (set-syntax-table emacs-lisp-mode-syntax-table)
|
|
|
1001 (use-local-map hyper-apropos-help-map))
|
|
|
1002
|
|
|
1003 ;; ---------------------------------------------------------------------- ;;
|
|
|
1004
|
|
|
1005 (defun hyper-apropos-scroll-up ()
|
|
|
1006 "Scroll up the \"*Hyper Help*\" buffer if it's visible.
|
|
|
1007 Otherwise, scroll the selected window up."
|
|
|
1008 (interactive)
|
|
|
1009 (let ((win (get-buffer-window hyper-apropos-help-buf))
|
|
|
1010 (owin (selected-window)))
|
|
|
1011 (if win
|
|
|
1012 (progn
|
|
|
1013 (select-window win)
|
|
|
1014 (condition-case nil
|
|
|
1015 (scroll-up nil)
|
|
|
1016 (error (goto-char (point-max))))
|
|
|
1017 (select-window owin))
|
|
|
1018 (scroll-up nil))))
|
|
|
1019
|
|
|
1020 (defun hyper-apropos-scroll-down ()
|
|
|
1021 "Scroll down the \"*Hyper Help*\" buffer if it's visible.
|
|
|
1022 Otherwise, scroll the selected window down."
|
|
|
1023 (interactive)
|
|
|
1024 (let ((win (get-buffer-window hyper-apropos-help-buf))
|
|
|
1025 (owin (selected-window)))
|
|
|
1026 (if win
|
|
|
1027 (progn
|
|
|
1028 (select-window win)
|
|
|
1029 (condition-case nil
|
|
|
1030 (scroll-down nil)
|
|
|
1031 (error (goto-char (point-max))))
|
|
|
1032 (select-window owin))
|
|
|
1033 (scroll-down nil))))
|
|
|
1034
|
|
|
1035 ;; ---------------------------------------------------------------------- ;;
|
|
|
1036
|
|
|
1037 (defun hyper-apropos-mouse-get-doc (event)
|
|
|
1038 "Get the documentation for the symbol the mouse is on."
|
|
|
1039 (interactive "e")
|
|
|
1040 (mouse-set-point event)
|
|
|
1041 (let ((e (extent-at (point) nil 'hyper-apropos-custom)))
|
|
|
1042 (if e
|
|
|
1043 (funcall (extent-property e 'hyper-apropos-custom))
|
|
|
1044 (save-excursion
|
|
|
1045 (let ((symbol (hyper-apropos-this-symbol)))
|
|
|
1046 (if symbol
|
|
|
1047 (hyper-apropos-get-doc symbol)
|
|
|
1048 (error "Click on a symbol")))))))
|
|
|
1049
|
|
|
1050 ;; ---------------------------------------------------------------------- ;;
|
|
|
1051
|
|
|
1052 (defun hyper-apropos-add-keyword (pattern)
|
|
|
1053 "Use additional keyword to narrow regexp match.
|
|
|
1054 Deletes lines which don't match PATTERN."
|
|
|
1055 (interactive "sAdditional Keyword: ")
|
|
|
1056 (save-excursion
|
|
|
1057 (goto-char (point-min))
|
|
|
1058 (let (buffer-read-only)
|
|
|
1059 (keep-lines (concat pattern "\\|" hyper-apropos-junk-regexp))
|
|
|
1060 )))
|
|
|
1061
|
|
|
1062 (defun hyper-apropos-eliminate-keyword (pattern)
|
|
|
1063 "Use additional keyword to eliminate uninteresting matches.
|
|
|
1064 Deletes lines which match PATTERN."
|
|
|
1065 (interactive "sKeyword to eliminate: ")
|
|
|
1066 (save-excursion
|
|
|
1067 (goto-char (point-min))
|
|
|
1068 (let (buffer-read-only)
|
|
|
1069 (flush-lines pattern))
|
|
|
1070 ))
|
|
|
1071
|
|
|
1072 ;; ---------------------------------------------------------------------- ;;
|
|
|
1073
|
|
|
1074 (defun hyper-apropos-this-symbol ()
|
|
|
1075 (save-excursion
|
|
|
1076 (cond ((eq major-mode 'hyper-apropos-mode)
|
|
|
1077 (beginning-of-line)
|
|
|
1078 (if (looking-at hyper-apropos-junk-regexp)
|
|
|
1079 nil
|
|
|
1080 (forward-char 3)
|
|
|
1081 (read (point-marker))))
|
|
|
1082 (t
|
|
|
1083 (let* ((st (progn
|
|
|
1084 (skip-syntax-backward "w_")
|
|
|
1085 ;; !@(*$^%%# stupid backquote implementation!!!
|
|
|
1086 (skip-chars-forward "`")
|
|
|
1087 (point)))
|
|
|
1088 (en (progn
|
|
|
1089 (skip-syntax-forward "w_")
|
|
|
1090 (skip-chars-backward ".':") ; : for Local Variables
|
|
|
1091 (point))))
|
|
|
1092 (and (not (eq st en))
|
|
|
1093 (intern-soft (buffer-substring st en))))))))
|
|
|
1094
|
|
|
1095 (defun hyper-apropos-where-is (symbol)
|
|
|
1096 "Find keybinding for symbol on current line."
|
|
|
1097 (interactive (list (hyper-apropos-this-symbol)))
|
|
|
1098 (where-is symbol))
|
|
|
1099
|
|
|
1100 (defun hyper-apropos-invoke-fn (fn)
|
|
|
1101 "Interactively invoke the function on the current line."
|
|
|
1102 (interactive (list (hyper-apropos-this-symbol)))
|
|
|
1103 (cond ((not (fboundp fn))
|
|
|
1104 (error "%S is not a function" fn))
|
|
|
1105 (t (call-interactively fn))))
|
|
|
1106
|
|
|
1107 ;;;###autoload
|
|
|
1108 (defun hyper-set-variable (var val &optional this-ref-buffer)
|
|
|
1109 (interactive
|
|
|
1110 (let ((var (hyper-apropos-read-variable-symbol
|
|
|
1111 (if (hyper-apropos-follow-ref-buffer current-prefix-arg)
|
|
|
1112 "In ref buffer, set user option"
|
|
|
1113 "Set user option")
|
|
|
1114 'user-variable-p)))
|
|
|
1115 (list var (hyper-apropos-read-variable-value var) current-prefix-arg)))
|
|
|
1116 (hyper-apropos-set-variable var val this-ref-buffer))
|
|
|
1117
|
|
|
1118 ;;;###autoload
|
|
|
1119 (defun hyper-apropos-set-variable (var val &optional this-ref-buffer)
|
|
|
1120 "Interactively set the variable on the current line."
|
|
|
1121 (interactive
|
|
|
1122 (let ((var (hyper-apropos-this-symbol)))
|
|
|
1123 (or (and var (boundp var))
|
|
|
1124 (and (setq var (and (eq major-mode 'hyper-apropos-help-mode)
|
|
|
1125 (save-excursion
|
|
|
1126 (goto-char (point-min))
|
|
|
1127 (hyper-apropos-this-symbol))))
|
|
|
1128 (boundp var))
|
|
|
1129 (setq var nil))
|
|
|
1130 (list var (hyper-apropos-read-variable-value var))))
|
|
|
1131 (and var
|
|
|
1132 (boundp var)
|
|
|
1133 (progn
|
|
|
1134 (if (hyper-apropos-follow-ref-buffer this-ref-buffer)
|
|
|
1135 (save-excursion
|
|
|
1136 (set-buffer hyper-apropos-ref-buffer)
|
|
|
1137 (set var val))
|
|
|
1138 (set var val))
|
|
|
1139 (hyper-apropos-get-doc var t '(variable) this-ref-buffer))))
|
|
|
1140 ;;;###autoload
|
|
|
1141 (define-obsolete-function-alias
|
|
|
1142 'hypropos-set-variable 'hyper-apropos-set-variable)
|
|
|
1143
|
|
|
1144 (defun hyper-apropos-read-variable-value (var &optional this-ref-buffer)
|
|
|
1145 (and var
|
|
|
1146 (boundp var)
|
|
|
1147 (let ((prop (get var 'variable-interactive))
|
|
|
1148 (print-readably t)
|
|
|
1149 val str)
|
|
|
1150 (hyper-apropos-get-doc var t '(variable) current-prefix-arg)
|
|
|
1151 (if prop
|
|
|
1152 (call-interactively (list 'lambda '(arg)
|
|
|
1153 (list 'interactive prop)
|
|
|
1154 'arg))
|
|
|
1155 (setq val (if (hyper-apropos-follow-ref-buffer this-ref-buffer)
|
|
|
1156 (save-excursion
|
|
|
1157 (set-buffer hyper-apropos-ref-buffer)
|
|
|
1158 (symbol-value var))
|
|
|
1159 (symbol-value var))
|
|
|
1160 str (prin1-to-string val))
|
|
|
1161 (eval-minibuffer
|
|
|
1162 (format "Set %s `%s' to value (evaluated): "
|
|
|
1163 (if (user-variable-p var) "user option" "Variable")
|
|
|
1164 var)
|
|
|
1165 (condition-case nil
|
|
|
1166 (progn
|
|
|
1167 (read str)
|
|
|
1168 (format (if (or (consp val)
|
|
|
1169 (and (symbolp val)
|
|
|
1170 (not (memq val '(t nil)))))
|
|
|
1171 "'%s" "%s")
|
|
|
1172 str))
|
|
|
1173 (error nil)))))))
|
|
|
1174
|
|
|
1175 (defun hyper-apropos-customize-variable ()
|
|
|
1176 (interactive)
|
|
|
1177 (let ((var (hyper-apropos-this-symbol)))
|
|
|
1178 (customize-variable var)))
|
|
|
1179
|
|
|
1180 ;; ---------------------------------------------------------------------- ;;
|
|
|
1181
|
|
|
1182 (defun hyper-apropos-find-tag (&optional tag-name)
|
|
|
1183 "Find the tag for the symbol on the current line in other window. In
|
|
|
1184 order for this to work properly, the variable `tag-table-alist' or
|
|
|
1185 `tags-file-name' must be set so that a TAGS file with tags for the emacs
|
|
|
1186 source is found for the \"*Hyper Apropos*\" buffer."
|
|
|
1187 (interactive)
|
|
|
1188 ;; there ought to be a default tags file for this...
|
|
|
1189 (or tag-name (setq tag-name (symbol-name (hyper-apropos-this-symbol))))
|
|
|
1190 (find-tag-other-window (list tag-name)))
|
|
|
1191
|
|
|
1192 ;; ---------------------------------------------------------------------- ;;
|
|
|
1193
|
|
|
1194 (defun hyper-apropos-find-function (fn)
|
|
|
1195 "Find the function for the symbol on the current line in other
|
|
|
1196 window. (See also `find-function'.)"
|
|
|
1197 (interactive
|
|
|
1198 (let ((fn (hyper-apropos-this-symbol)))
|
|
|
1199 (or (fboundp fn)
|
|
|
1200 (and (setq fn (and (eq major-mode 'hyper-apropos-help-mode)
|
|
|
1201 (save-excursion
|
|
|
1202 (goto-char (point-min))
|
|
|
1203 (hyper-apropos-this-symbol))))
|
|
|
1204 (fboundp fn))
|
|
|
1205 (setq fn nil))
|
|
|
1206 (list fn)))
|
|
|
1207 (if fn
|
|
|
1208 (find-function-other-window fn)))
|
|
|
1209
|
|
|
1210 ;; ---------------------------------------------------------------------- ;;
|
|
|
1211
|
|
|
1212 (defun hyper-apropos-disassemble (sym)
|
|
|
1213 "Disassemble FUN if it is byte-coded. If it's a lambda, prettyprint it."
|
|
|
1214 (interactive (list (hyper-apropos-this-symbol)))
|
|
|
1215 (let ((fun sym) (trail nil) macrop)
|
|
|
1216 (while (and (symbolp fun) (not (memq fun trail)))
|
|
|
1217 (setq trail (cons fun trail)
|
|
|
1218 fun (symbol-function fun)))
|
|
|
1219 (and (symbolp fun)
|
|
|
1220 (error "Loop detected in function binding of `%s'" fun))
|
|
|
1221 (setq macrop (and (consp fun)
|
|
|
1222 (eq 'macro (car fun))))
|
|
|
1223 (cond ((compiled-function-p (if macrop (cdr fun) fun))
|
|
|
1224 (disassemble fun)
|
|
|
1225 (set-buffer "*Disassemble*")
|
|
|
1226 (goto-char (point-min))
|
|
|
1227 (forward-sexp 2)
|
|
|
1228 (insert (format " for function `%S'" sym))
|
|
|
1229 )
|
|
|
1230 ((consp fun)
|
|
|
1231 (with-current-buffer "*Disassemble*"
|
|
|
1232 (cl-prettyprint (if macrop
|
|
|
1233 (cons 'defmacro (cons sym (cdr (cdr fun))))
|
|
|
1234 (cons 'defun (cons sym (cdr fun))))))
|
|
|
1235 (set-buffer "*Disassemble*")
|
|
|
1236 (emacs-lisp-mode))
|
|
|
1237 ((or (vectorp fun) (stringp fun))
|
|
|
1238 ;; #### - do something fancy here
|
|
|
1239 (with-output-to-temp-buffer "*Disassemble*"
|
|
|
1240 (princ (format "%s is a keyboard macro:\n\n\t" sym))
|
|
|
1241 (prin1 fun)))
|
|
|
1242 (t
|
|
|
1243 (error "Sorry, cannot disassemble `%s'" sym)))))
|
|
|
1244
|
|
|
1245 ;; ---------------------------------------------------------------------- ;;
|
|
|
1246
|
|
|
1247 (defun hyper-apropos-quit ()
|
|
|
1248 (interactive)
|
|
|
1249 "Quit Hyper Apropos and restore original window config."
|
|
|
1250 (let ((buf (get-buffer hyper-apropos-apropos-buf)))
|
|
|
1251 (and buf (bury-buffer buf)))
|
|
|
1252 (set-window-configuration hyper-apropos-prev-wconfig))
|
|
|
1253
|
|
|
1254 ;; ---------------------------------------------------------------------- ;;
|
|
|
1255
|
|
|
1256 ;;;###autoload
|
|
|
1257 (defun hyper-apropos-popup-menu (event)
|
|
|
1258 (interactive "e")
|
|
|
1259 (mouse-set-point event)
|
|
|
1260 (let* ((sym (or (hyper-apropos-this-symbol)
|
|
|
1261 (and (eq major-mode 'hyper-apropos-help-mode)
|
|
|
1262 (save-excursion
|
|
|
1263 (goto-char (point-min))
|
|
|
1264 (hyper-apropos-this-symbol)))))
|
|
|
1265 (notjunk (not (null sym)))
|
|
|
1266 (command-p (if (commandp sym) t))
|
|
|
1267 (variable-p (and sym (boundp sym)))
|
|
|
1268 (customizable-p (and variable-p
|
|
|
1269 (get sym 'custom-type)
|
|
|
1270 t))
|
|
|
1271 (function-p (fboundp sym))
|
|
|
1272 (apropos-p (eq 'hyper-apropos-mode
|
|
|
1273 (save-excursion (set-buffer (event-buffer event))
|
|
|
1274 major-mode)))
|
|
|
1275 (name (if sym (symbol-name sym) ""))
|
|
|
1276 (hyper-apropos-menu
|
|
|
1277 (delete
|
|
|
1278 nil
|
|
|
1279 (list (concat "Hyper-Help: " name)
|
|
|
1280 (vector "Display documentation" 'hyper-apropos-get-doc notjunk)
|
|
|
1281 (vector "Set variable" 'hyper-apropos-set-variable variable-p)
|
|
|
1282 (vector "Customize variable" 'hyper-apropos-customize-variable
|
|
|
1283 customizable-p)
|
|
|
1284 (vector "Show keys for" 'hyper-apropos-where-is command-p)
|
|
|
1285 (vector "Invoke command" 'hyper-apropos-invoke-fn command-p)
|
|
|
1286 (vector "Find function" 'hyper-apropos-find-function function-p)
|
|
|
1287 (vector "Find tag" 'hyper-apropos-find-tag notjunk)
|
|
|
1288 (and apropos-p
|
|
|
1289 ["Add keyword..." hyper-apropos-add-keyword t])
|
|
|
1290 (and apropos-p
|
|
|
1291 ["Eliminate keyword..." hyper-apropos-eliminate-keyword t])
|
|
|
1292 (if apropos-p
|
|
|
1293 ["Programmers' Apropos" hyper-apropos-toggle-programming-flag
|
|
|
1294 :style toggle :selected hyper-apropos-programming-apropos]
|
|
|
1295 ["Programmers' Help" hyper-apropos-toggle-programming-flag
|
|
|
1296 :style toggle :selected hyper-apropos-programming-apropos])
|
|
|
1297 (and hyper-apropos-programming-apropos
|
|
|
1298 (vector "Disassemble function"
|
|
|
1299 'hyper-apropos-disassemble
|
|
|
1300 function-p))
|
|
|
1301 ["Help" describe-mode t]
|
|
|
1302 ["Quit" hyper-apropos-quit t]
|
|
|
1303 ))))
|
|
|
1304 (popup-menu hyper-apropos-menu)))
|
|
|
1305 ;;;###autoload
|
|
|
1306 (define-obsolete-function-alias
|
|
|
1307 'hypropos-popup-menu 'hyper-apropos-popup-menu)
|
|
|
1308
|
|
|
1309 (provide 'hyper-apropos)
|
|
|
1310
|
|
|
1311 ;; end of hyper-apropos.el
|
