|
428
|
1 ;;; help.el --- help commands for XEmacs.
|
|
|
2
|
|
|
3 ;; Copyright (C) 1985, 1986, 1992-4, 1997 Free Software Foundation, Inc.
|
|
771
|
4 ;; Copyright (C) 2001, 2002 Ben Wing.
|
|
428
|
5
|
|
|
6 ;; Maintainer: FSF
|
|
|
7 ;; Keywords: help, internal, dumped
|
|
|
8
|
|
|
9 ;; This file is part of XEmacs.
|
|
|
10
|
|
|
11 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
12 ;; under the terms of the GNU General Public License as published by
|
|
|
13 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
14 ;; any later version.
|
|
|
15
|
|
|
16 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
19 ;; General Public License for more details.
|
|
|
20
|
|
|
21 ;; You should have received a copy of the GNU General Public License
|
|
|
22 ;; along with XEmacs; see the file COPYING. If not, write to the
|
|
|
23 ;; Free Software Foundation, 59 Temple Place - Suite 330,
|
|
|
24 ;; Boston, MA 02111-1307, USA.
|
|
|
25
|
|
|
26 ;;; Synched up with: FSF 19.30.
|
|
|
27
|
|
|
28 ;;; Commentary:
|
|
|
29
|
|
|
30 ;; This file is dumped with XEmacs.
|
|
|
31
|
|
|
32 ;; This code implements XEmacs's on-line help system, the one invoked by
|
|
|
33 ;;`M-x help-for-help'.
|
|
|
34
|
|
|
35 ;; 06/11/1997 -- Converted to use char-after instead of broken
|
|
|
36 ;; following-char. -slb
|
|
|
37
|
|
|
38 ;;; Code:
|
|
|
39
|
|
|
40 ;; Get the macro make-help-screen when this is compiled,
|
|
|
41 ;; or run interpreted, but not when the compiled code is loaded.
|
|
|
42 (eval-when-compile (require 'help-macro))
|
|
|
43
|
|
|
44 (defgroup help nil
|
|
|
45 "Support for on-line help systems."
|
|
|
46 :group 'emacs)
|
|
|
47
|
|
|
48 (defgroup help-appearance nil
|
|
|
49 "Appearance of help buffers."
|
|
|
50 :group 'help)
|
|
|
51
|
|
|
52 (defvar help-map (let ((map (make-sparse-keymap)))
|
|
|
53 (set-keymap-name map 'help-map)
|
|
|
54 (set-keymap-prompt
|
|
444
|
55 map (gettext "(Type ? for further options)"))
|
|
428
|
56 map)
|
|
|
57 "Keymap for characters following the Help key.")
|
|
|
58
|
|
|
59 ;; global-map definitions moved to keydefs.el
|
|
|
60 (fset 'help-command help-map)
|
|
|
61
|
|
|
62 (define-key help-map (vector help-char) 'help-for-help)
|
|
|
63 (define-key help-map "?" 'help-for-help)
|
|
|
64 (define-key help-map 'help 'help-for-help)
|
|
|
65 (define-key help-map '(f1) 'help-for-help)
|
|
|
66
|
|
|
67 (define-key help-map "a" 'hyper-apropos) ; 'command-apropos in FSFmacs
|
|
502
|
68 (define-key help-map "A" 'command-hyper-apropos)
|
|
|
69 ;; #### should be hyper-apropos-documentation, once that's written.
|
|
|
70 (define-key help-map "\C-a" 'apropos-documentation)
|
|
428
|
71
|
|
|
72 (define-key help-map "b" 'describe-bindings)
|
|
|
73 (define-key help-map "B" 'describe-beta)
|
|
|
74
|
|
502
|
75 (define-key help-map "c" 'describe-key-briefly)
|
|
428
|
76 (define-key help-map "C" 'customize)
|
|
502
|
77 ;; FSFmacs has Info-goto-emacs-command-node on C-f, no binding
|
|
|
78 ;; for Info-elisp-ref
|
|
|
79 (define-key help-map "\C-c" 'Info-goto-emacs-command-node)
|
|
428
|
80
|
|
|
81 (define-key help-map "d" 'describe-function)
|
|
502
|
82 (define-key help-map "\C-d" 'describe-distribution)
|
|
|
83
|
|
|
84 (define-key help-map "e" (if (fboundp 'view-last-error) 'view-last-error
|
|
|
85 'describe-last-error))
|
|
|
86
|
|
428
|
87 (define-key help-map "f" 'describe-function)
|
|
502
|
88 ;; #### not a good interface. no way to specify that C-h is preferred
|
|
|
89 ;; as a prefix and not BS. should instead be specified as part of
|
|
|
90 ;; `define-key'.
|
|
|
91 ;; (put 'describe-function 'preferred-key-sequence "\C-hf")
|
|
428
|
92 (define-key help-map "F" 'xemacs-local-faq)
|
|
502
|
93 (define-key help-map "\C-f" 'Info-elisp-ref)
|
|
428
|
94
|
|
|
95 (define-key help-map "i" 'info)
|
|
502
|
96 (define-key help-map "I" 'Info-search-index-in-xemacs-and-lispref)
|
|
|
97 (define-key help-map "\C-i" 'Info-query)
|
|
|
98
|
|
|
99 (define-key help-map "k" 'describe-key)
|
|
|
100 (define-key help-map "\C-k" 'Info-goto-emacs-key-command-node)
|
|
428
|
101
|
|
|
102 (define-key help-map "l" 'view-lossage)
|
|
502
|
103 (define-key help-map "\C-l" 'describe-copying) ; on \C-c in FSFmacs
|
|
428
|
104
|
|
|
105 (define-key help-map "m" 'describe-mode)
|
|
|
106
|
|
502
|
107 (define-key help-map "n" 'view-emacs-news)
|
|
428
|
108 (define-key help-map "\C-n" 'view-emacs-news)
|
|
|
109
|
|
|
110 (define-key help-map "p" 'finder-by-keyword)
|
|
502
|
111 (define-key help-map "\C-p" 'describe-pointer)
|
|
|
112
|
|
|
113 (define-key help-map "q" 'help-quit)
|
|
428
|
114
|
|
|
115 ;; Do this right with an autoload cookie in finder.el.
|
|
|
116 ;;(autoload 'finder-by-keyword "finder"
|
|
|
117 ;; "Find packages matching a given keyword." t)
|
|
|
118
|
|
|
119 (define-key help-map "s" 'describe-syntax)
|
|
502
|
120 (define-key help-map "S" 'view-sample-init-el)
|
|
428
|
121
|
|
|
122 (define-key help-map "t" 'help-with-tutorial)
|
|
|
123
|
|
|
124 (define-key help-map "v" 'describe-variable)
|
|
|
125
|
|
502
|
126 (define-key help-map "w" 'where-is)
|
|
|
127 (define-key help-map "\C-w" 'describe-no-warranty)
|
|
428
|
128
|
|
502
|
129 ;; #### It would be nice if the code below to add hyperlinks was
|
|
|
130 ;; generalized. We would probably need a "hyperlink mode" from which
|
|
|
131 ;; help-mode is derived. This means we probably need multiple
|
|
|
132 ;; inheritance of modes! Thankfully this is not hard to implement; we
|
|
|
133 ;; already have the ability for a keymap to have multiple parents.
|
|
|
134 ;; However, we'd have to define any multiply-inherited-from modes using
|
|
|
135 ;; a standard `define-mode' construction instead of manually doing it,
|
|
|
136 ;; because we don't want each guy calling `kill-all-local-variables' and
|
|
|
137 ;; messing up the previous one.
|
|
428
|
138
|
|
|
139 (define-derived-mode help-mode view-major-mode "Help"
|
|
|
140 "Major mode for viewing help text.
|
|
|
141 Entry to this mode runs the normal hook `help-mode-hook'.
|
|
|
142 Commands:
|
|
|
143 \\{help-mode-map}"
|
|
|
144 )
|
|
|
145
|
|
|
146 (define-key help-mode-map "q" 'help-mode-quit)
|
|
|
147 (define-key help-mode-map "Q" 'help-mode-bury)
|
|
|
148 (define-key help-mode-map "f" 'find-function-at-point)
|
|
|
149 (define-key help-mode-map "d" 'describe-function-at-point)
|
|
|
150 (define-key help-mode-map "v" 'describe-variable-at-point)
|
|
|
151 (define-key help-mode-map "i" 'Info-elisp-ref)
|
|
|
152 (define-key help-mode-map "c" 'customize-variable)
|
|
|
153 (define-key help-mode-map [tab] 'help-next-symbol)
|
|
|
154 (define-key help-mode-map [(shift tab)] 'help-prev-symbol)
|
|
|
155 (define-key help-mode-map "n" 'help-next-section)
|
|
|
156 (define-key help-mode-map "p" 'help-prev-section)
|
|
|
157
|
|
|
158 (defun describe-function-at-point ()
|
|
|
159 "Describe directly the function at point in the other window."
|
|
|
160 (interactive)
|
|
|
161 (let ((symb (function-at-point)))
|
|
|
162 (when symb
|
|
|
163 (describe-function symb))))
|
|
|
164
|
|
|
165 (defun describe-variable-at-point ()
|
|
|
166 "Describe directly the variable at point in the other window."
|
|
|
167 (interactive)
|
|
|
168 (let ((symb (variable-at-point)))
|
|
|
169 (when symb
|
|
|
170 (describe-variable symb))))
|
|
|
171
|
|
|
172 (defun help-next-symbol ()
|
|
|
173 "Move point to the next quoted symbol."
|
|
|
174 (interactive)
|
|
|
175 (search-forward "`" nil t))
|
|
|
176
|
|
|
177 (defun help-prev-symbol ()
|
|
|
178 "Move point to the previous quoted symbol."
|
|
|
179 (interactive)
|
|
|
180 (search-backward "'" nil t))
|
|
|
181
|
|
|
182 (defun help-next-section ()
|
|
|
183 "Move point to the next quoted symbol."
|
|
|
184 (interactive)
|
|
|
185 (search-forward-regexp "^\\w+:" nil t))
|
|
|
186
|
|
|
187 (defun help-prev-section ()
|
|
|
188 "Move point to the previous quoted symbol."
|
|
|
189 (interactive)
|
|
|
190 (search-backward-regexp "^\\w+:" nil t))
|
|
|
191
|
|
|
192 (defun help-mode-bury ()
|
|
|
193 "Bury the help buffer, possibly restoring the previous window configuration."
|
|
|
194 (interactive)
|
|
|
195 (help-mode-quit t))
|
|
|
196
|
|
|
197 (defun help-mode-quit (&optional bury)
|
|
|
198 "Exit from help mode, possibly restoring the previous window configuration.
|
|
|
199 If the optional argument BURY is non-nil, the help buffer is buried,
|
|
|
200 otherwise it is killed."
|
|
|
201 (interactive)
|
|
|
202 (let ((buf (current-buffer)))
|
|
442
|
203 (cond (help-window-config
|
|
|
204 (set-window-configuration help-window-config))
|
|
428
|
205 ((not (one-window-p))
|
|
|
206 (delete-window)))
|
|
|
207 (if bury
|
|
|
208 (bury-buffer buf)
|
|
|
209 (kill-buffer buf))))
|
|
|
210
|
|
|
211 (defun help-quit ()
|
|
|
212 (interactive)
|
|
|
213 nil)
|
|
|
214
|
|
771
|
215 (define-obsolete-function-alias 'deprecated-help-command 'help-for-help)
|
|
428
|
216
|
|
|
217 ;;(define-key global-map 'backspace 'deprecated-help-command)
|
|
|
218
|
|
771
|
219 (defconst tutorial-supported-languages
|
|
|
220 '(
|
|
|
221 ("Croatian" hr iso-8859-2)
|
|
|
222 ("Czech" cs iso-8859-2)
|
|
|
223 ("Dutch" nl iso-8859-1)
|
|
|
224 ("English" nil raw-text)
|
|
|
225 ("French" fr iso-8859-1)
|
|
|
226 ("German" de iso-8859-1)
|
|
|
227 ("Norwegian" no iso-8859-1)
|
|
|
228 ("Polish" pl iso-8859-2)
|
|
|
229 ("Romanian" ro iso-8859-2)
|
|
|
230 ("Slovak" sk iso-8859-2)
|
|
|
231 ("Slovenian" sl iso-8859-2)
|
|
|
232 ("Spanish" es iso-8859-1)
|
|
|
233 ("Swedish" se iso-8859-1)
|
|
|
234 )
|
|
|
235 "Alist of supported languages in TUTORIAL files.
|
|
|
236 Add languages here, as more are translated.")
|
|
|
237
|
|
|
238 ;; TUTORIAL arg is XEmacs addition
|
|
|
239 (defun help-with-tutorial (&optional tutorial language)
|
|
|
240 "Select the XEmacs learn-by-doing tutorial.
|
|
|
241 Optional arg TUTORIAL specifies the tutorial file; if not specified or
|
|
|
242 if this command is invoked interactively, the tutorial appropriate to
|
|
|
243 the current language environment is used. If there is no tutorial
|
|
|
244 written in that language, or if this version of XEmacs has no
|
|
|
245 international (Mule) support, the English-language tutorial is used.
|
|
|
246 With a prefix argument, you are asked to select which language."
|
|
|
247 (interactive "i\nP")
|
|
|
248 (when (and language (consp language))
|
|
|
249 (setq language
|
|
|
250 (if (featurep 'mule)
|
|
|
251 (or (declare-fboundp (read-language-name 'tutorial "Language: "))
|
|
|
252 (error "No tutorial file of the specified language"))
|
|
|
253 (let ((completion-ignore-case t))
|
|
|
254 (completing-read "Language: "
|
|
|
255 tutorial-supported-languages nil t)))))
|
|
|
256 (or language
|
|
|
257 (setq language
|
|
|
258 (if (featurep 'mule) (declare-boundp current-language-environment)
|
|
|
259 "English")))
|
|
|
260 (or tutorial
|
|
|
261 (setq tutorial
|
|
|
262 (cond ((featurep 'mule)
|
|
|
263 (or (declare-fboundp (get-language-info language 'tutorial))
|
|
|
264 "TUTORIAL"))
|
|
|
265 ((equal language "English") "TUTORIAL")
|
|
|
266 (t (format "TUTORIAL.%s"
|
|
|
267 (cadr (assoc language
|
|
|
268 tutorial-supported-languages)))))))
|
|
|
269 (let ((file (expand-file-name tutorial "~")))
|
|
|
270 (delete-other-windows)
|
|
|
271 (let ((buffer (or (get-file-buffer file)
|
|
|
272 (create-file-buffer file)))
|
|
|
273 (window-configuration (current-window-configuration)))
|
|
|
274 (condition-case error-data
|
|
|
275 (progn
|
|
|
276 (switch-to-buffer buffer)
|
|
|
277 (setq buffer-file-name file)
|
|
|
278 (setq default-directory (expand-file-name "~/"))
|
|
|
279 (setq buffer-auto-save-file-name nil)
|
|
|
280 ;; Because of non-Mule users, TUTORIALs are not coded
|
|
|
281 ;; independently, so we must guess the coding according to
|
|
|
282 ;; the language.
|
|
|
283 (let ((coding-system-for-read
|
|
|
284 (if (featurep 'mule)
|
|
|
285 (with-fboundp 'get-language-info
|
|
|
286 (or (get-language-info language
|
|
|
287 'tutorial-coding-system)
|
|
|
288 (car (get-language-info language
|
|
|
289 'coding-system))))
|
|
|
290 (nth 2 (assoc language tutorial-supported-languages)))))
|
|
|
291 (insert-file-contents (locate-data-file tutorial)))
|
|
|
292 (goto-char (point-min))
|
|
|
293 ;; [The 'didactic' blank lines: possibly insert blank lines
|
|
|
294 ;; around <<nya nya nya>> and replace << >> with [ ].] No more
|
|
|
295 ;; didactic blank lines. It was just a bad idea, anyway. I
|
|
|
296 ;; rewrote the TUTORIAL so it doesn't need them. However, some
|
|
|
297 ;; tutorials in other languages haven't yet been updated. ####
|
|
|
298 ;; Delete this code when they're all updated.
|
|
|
299 (if (re-search-forward "^<<.+>>" nil t)
|
|
|
300 (let ((n (- (window-height (selected-window))
|
|
|
301 (count-lines (point-min) (point-at-bol))
|
|
|
302 6)))
|
|
|
303 (if (< n 12)
|
|
|
304 (progn (beginning-of-line) (kill-line))
|
|
|
305 ;; Some people get confused by the large gap
|
|
|
306 (delete-backward-char 2)
|
|
|
307 (insert "]")
|
|
|
308 (beginning-of-line)
|
|
|
309 (save-excursion
|
|
|
310 (delete-char 2)
|
|
|
311 (insert "["))
|
|
|
312 (newline (/ n 2))
|
|
|
313 (next-line 1)
|
|
|
314 (newline (- n (/ n 2))))))
|
|
|
315 (goto-char (point-min))
|
|
|
316 (set-buffer-modified-p nil))
|
|
|
317 ;; TUTORIAL was not found: kill the buffer and restore the
|
|
|
318 ;; window configuration.
|
|
|
319 (file-error (kill-buffer buffer)
|
|
|
320 (set-window-configuration window-configuration)
|
|
|
321 ;; Now, signal the error
|
|
|
322 (signal (car error-data) (cdr error-data)))))))
|
|
428
|
323
|
|
|
324 ;; used by describe-key, describe-key-briefly, insert-key-binding, etc.
|
|
|
325 (defun key-or-menu-binding (key &optional menu-flag)
|
|
|
326 "Return the command invoked by KEY.
|
|
|
327 Like `key-binding', but handles menu events and toolbar presses correctly.
|
|
|
328 KEY is any value returned by `next-command-event'.
|
|
|
329 MENU-FLAG is a symbol that should be set to t if KEY is a menu event,
|
|
444
|
330 or nil otherwise."
|
|
428
|
331 (let (defn)
|
|
|
332 (and menu-flag (set menu-flag nil))
|
|
|
333 ;; If the key typed was really a menu selection, grab the form out
|
|
|
334 ;; of the event object and intuit the function that would be called,
|
|
|
335 ;; and describe that instead.
|
|
|
336 (if (and (vectorp key) (= 1 (length key))
|
|
|
337 (or (misc-user-event-p (aref key 0))
|
|
|
338 (eq (car-safe (aref key 0)) 'menu-selection)))
|
|
|
339 (let ((event (aref key 0)))
|
|
|
340 (setq defn (if (eventp event)
|
|
|
341 (list (event-function event) (event-object event))
|
|
|
342 (cdr event)))
|
|
|
343 (and menu-flag (set menu-flag t))
|
|
|
344 (when (eq (car defn) 'eval)
|
|
|
345 (setq defn (car (cdr defn))))
|
|
|
346 (when (eq (car-safe defn) 'call-interactively)
|
|
|
347 (setq defn (car (cdr defn))))
|
|
|
348 (when (and (consp defn) (null (cdr defn)))
|
|
|
349 (setq defn (car defn))))
|
|
|
350 ;; else
|
|
|
351 (setq defn (key-binding key)))
|
|
|
352 ;; kludge: if a toolbar button was pressed on, try to find the
|
|
|
353 ;; binding of the toolbar button.
|
|
|
354 (if (and (eq defn 'press-toolbar-button)
|
|
|
355 (vectorp key)
|
|
|
356 (button-press-event-p (aref key (1- (length key)))))
|
|
|
357 ;; wait for the button release. We're on shaky ground here ...
|
|
|
358 (let ((event (next-command-event))
|
|
|
359 button)
|
|
|
360 (if (and (button-release-event-p event)
|
|
|
361 (event-over-toolbar-p event)
|
|
|
362 (eq 'release-and-activate-toolbar-button
|
|
|
363 (key-binding (vector event)))
|
|
|
364 (setq button (event-toolbar-button event)))
|
|
|
365 (toolbar-button-callback button)
|
|
|
366 ;; if anything went wrong, try returning the binding of
|
|
|
367 ;; the button-up event, of the original binding
|
|
|
368 (or (key-or-menu-binding (vector event))
|
|
|
369 defn)))
|
|
|
370 ;; no toolbar kludge
|
|
|
371 defn)
|
|
|
372 ))
|
|
|
373
|
|
|
374 (defun describe-key-briefly (key &optional insert)
|
|
|
375 "Print the name of the function KEY invokes. KEY is a string.
|
|
|
376 If INSERT (the prefix arg) is non-nil, insert the message in the buffer."
|
|
|
377 (interactive "kDescribe key briefly: \nP")
|
|
|
378 (let ((standard-output (if insert (current-buffer) t))
|
|
|
379 defn menup)
|
|
|
380 (setq defn (key-or-menu-binding key 'menup))
|
|
|
381 (if (or (null defn) (integerp defn))
|
|
|
382 (princ (format "%s is undefined" (key-description key)))
|
|
|
383 ;; If it's a keyboard macro which trivially invokes another command,
|
|
|
384 ;; document that instead.
|
|
|
385 (if (or (stringp defn) (vectorp defn))
|
|
|
386 (setq defn (or (key-binding defn)
|
|
|
387 defn)))
|
|
|
388 (let ((last-event (and (vectorp key)
|
|
|
389 (aref key (1- (length key))))))
|
|
|
390 (princ (format (cond (insert
|
|
|
391 "%s (%s)")
|
|
|
392 ((or (button-press-event-p last-event)
|
|
|
393 (button-release-event-p last-event))
|
|
|
394 (gettext "%s at that spot runs the command %s"))
|
|
|
395 (t
|
|
|
396 (gettext "%s runs the command %s")))
|
|
|
397 ;; This used to say 'This menu item' but it
|
|
|
398 ;; could also be a scrollbar event. We can't
|
|
|
399 ;; distinguish at the moment.
|
|
|
400 (if menup
|
|
|
401 (if insert "item" "This item")
|
|
|
402 (key-description key))
|
|
|
403 (if (symbolp defn) defn (prin1-to-string defn))))))))
|
|
|
404
|
|
|
405 ;; #### this is a horrible piece of shit function that should
|
|
|
406 ;; not exist. In FSF 19.30 this function has gotten three times
|
|
|
407 ;; as long and has tons and tons of dumb shit checking
|
|
|
408 ;; special-display-buffer-names and such crap. I absolutely
|
|
|
409 ;; refuse to insert that Ebolification here. I wanted to delete
|
|
|
410 ;; this function entirely but Mly bitched.
|
|
|
411 ;;
|
|
|
412 ;; If your user-land code calls this function, rewrite it to
|
|
|
413 ;; call with-displaying-help-buffer.
|
|
|
414
|
|
|
415 (defun print-help-return-message (&optional function)
|
|
|
416 "Display or return message saying how to restore windows after help command.
|
|
|
417 Computes a message and applies the optional argument FUNCTION to it.
|
|
|
418 If FUNCTION is nil, applies `message' to it, thus printing it."
|
|
|
419 (and (not (get-buffer-window standard-output))
|
|
|
420 (funcall
|
|
|
421 (or function 'message)
|
|
|
422 (concat
|
|
|
423 (substitute-command-keys
|
|
|
424 (if (one-window-p t)
|
|
|
425 (if pop-up-windows
|
|
|
426 (gettext "Type \\[delete-other-windows] to remove help window.")
|
|
|
427 (gettext "Type \\[switch-to-buffer] RET to remove help window."))
|
|
|
428 (gettext "Type \\[switch-to-buffer-other-window] RET to restore the other window.")))
|
|
|
429 (substitute-command-keys
|
|
|
430 (gettext " \\[scroll-other-window] to scroll the help."))))))
|
|
|
431
|
|
|
432 (defcustom help-selects-help-window t
|
|
|
433 "*If nil, use the \"old Emacs\" behavior for Help buffers.
|
|
|
434 This just displays the buffer in another window, rather than selecting
|
|
|
435 the window."
|
|
|
436 :type 'boolean
|
|
|
437 :group 'help-appearance)
|
|
|
438
|
|
|
439 (defcustom help-max-help-buffers 10
|
|
|
440 "*Maximum help buffers to allow before they start getting killed.
|
|
|
441 If this is a positive integer, before a help buffer is displayed
|
|
|
442 by `with-displaying-help-buffer', any excess help buffers which
|
|
|
443 are not being displayed are first killed. Otherwise, if it is
|
|
|
444 zero or nil, only one help buffer, \"*Help*\" is ever used."
|
|
|
445 :type '(choice integer (const :tag "None" nil))
|
|
|
446 :group 'help-appearance)
|
|
|
447
|
|
|
448 (defvar help-buffer-list nil
|
|
|
449 "List of help buffers used by `help-register-and-maybe-prune-excess'")
|
|
|
450
|
|
|
451 (defun help-register-and-maybe-prune-excess (newbuf)
|
|
|
452 "Register use of a help buffer and possibly kill any excess ones."
|
|
|
453 ;; remove new buffer from list
|
|
|
454 (setq help-buffer-list (remove newbuf help-buffer-list))
|
|
|
455 ;; maybe kill excess help buffers
|
|
|
456 (if (and (integerp help-max-help-buffers)
|
|
|
457 (> (length help-buffer-list) help-max-help-buffers))
|
|
|
458 (let ((keep-list nil)
|
|
|
459 (num-kill (- (length help-buffer-list)
|
|
|
460 help-max-help-buffers)))
|
|
|
461 (while help-buffer-list
|
|
|
462 (let ((buf (car help-buffer-list)))
|
|
|
463 (if (and (or (equal buf newbuf) (get-buffer buf))
|
|
|
464 (string-match "^*Help" buf)
|
|
|
465 (save-excursion (set-buffer buf)
|
|
|
466 (eq major-mode 'help-mode)))
|
|
|
467 (if (and (>= num-kill (length help-buffer-list))
|
|
|
468 (not (get-buffer-window buf t t)))
|
|
|
469 (kill-buffer buf)
|
|
|
470 (setq keep-list (cons buf keep-list)))))
|
|
|
471 (setq help-buffer-list (cdr help-buffer-list)))
|
|
|
472 (setq help-buffer-list (nreverse keep-list))))
|
|
|
473 ;; push new buffer
|
|
|
474 (setq help-buffer-list (cons newbuf help-buffer-list)))
|
|
|
475
|
|
|
476 (defvar help-buffer-prefix-string "Help"
|
|
|
477 "Initial string to use in constructing help buffer names.
|
|
|
478 You should never set this directory, only let-bind it.")
|
|
|
479
|
|
|
480 (defun help-buffer-name (name)
|
|
|
481 "Return a name for a Help buffer using string NAME for context."
|
|
|
482 (if (and (integerp help-max-help-buffers)
|
|
|
483 (> help-max-help-buffers 0)
|
|
|
484 (stringp name))
|
|
|
485 (if help-buffer-prefix-string
|
|
|
486 (format "*%s: %s*" help-buffer-prefix-string name)
|
|
|
487 (format "*%s*" name))
|
|
|
488 (format "*%s*" help-buffer-prefix-string)))
|
|
|
489
|
|
|
490 ;; Use this function for displaying help when C-h something is pressed
|
|
|
491 ;; or in similar situations. Do *not* use it when you are displaying
|
|
|
492 ;; a help message and then prompting for input in the minibuffer --
|
|
|
493 ;; this macro usually selects the help buffer, which is not what you
|
|
|
494 ;; want in those situations.
|
|
|
495
|
|
|
496 ;; #### Should really be a macro to eliminate the requirement of
|
|
|
497 ;; caller to code a lambda form in THUNK -- mrb
|
|
|
498
|
|
|
499 ;; #### BEFORE you rush to make this a macro, think about backward
|
|
|
500 ;; compatibility. The right way would be to create a macro with
|
|
|
501 ;; another name (which is a shame, because w-d-h-b is a perfect name
|
|
|
502 ;; for a macro) that uses with-displaying-help-buffer internally.
|
|
|
503
|
|
442
|
504 (defcustom mode-for-help 'help-mode
|
|
|
505 "*Mode that help buffers are put into.")
|
|
|
506
|
|
|
507 (defvar help-sticky-window nil
|
|
|
508 ;; Window into which help buffers will be displayed, rather than
|
|
|
509 ;; always searching for a new one. This is INTERNAL and liable to
|
|
|
510 ;; change its interface and/or name at any moment. It should be
|
|
|
511 ;; bound, not set.
|
|
|
512 )
|
|
|
513
|
|
|
514 (defvar help-window-config nil)
|
|
|
515
|
|
|
516 (make-variable-buffer-local 'help-window-config)
|
|
|
517 (put 'help-window-config 'permanent-local t)
|
|
|
518
|
|
428
|
519 (defun with-displaying-help-buffer (thunk &optional name)
|
|
|
520 "Form which makes a help buffer with given NAME and evaluates BODY there.
|
|
|
521 The actual name of the buffer is generated by the function `help-buffer-name'."
|
|
|
522 (let* ((winconfig (current-window-configuration))
|
|
|
523 (was-one-window (one-window-p))
|
|
|
524 (buffer-name (help-buffer-name name))
|
|
|
525 (help-not-visible
|
|
|
526 (not (and (windows-of-buffer buffer-name) ;shortcut
|
|
|
527 (memq (selected-frame)
|
|
|
528 (mapcar 'window-frame
|
|
|
529 (windows-of-buffer buffer-name)))))))
|
|
|
530 (help-register-and-maybe-prune-excess buffer-name)
|
|
442
|
531 ;; if help-sticky-window is bogus or deleted, get rid of it.
|
|
|
532 (if (and help-sticky-window (or (not (windowp help-sticky-window))
|
|
|
533 (not (window-live-p help-sticky-window))))
|
|
|
534 (setq help-sticky-window nil))
|
|
|
535 (prog1
|
|
|
536 (let ((temp-buffer-show-function
|
|
|
537 (if help-sticky-window
|
|
|
538 #'(lambda (buffer)
|
|
|
539 (set-window-buffer help-sticky-window buffer))
|
|
|
540 temp-buffer-show-function)))
|
|
|
541 (with-output-to-temp-buffer buffer-name
|
|
|
542 (prog1 (funcall thunk)
|
|
|
543 (save-excursion
|
|
|
544 (set-buffer standard-output)
|
|
|
545 (funcall mode-for-help)))))
|
|
428
|
546 (let ((helpwin (get-buffer-window buffer-name)))
|
|
|
547 (when helpwin
|
|
442
|
548 ;; If the *Help* buffer is already displayed on this
|
|
|
549 ;; frame, don't override the previous configuration
|
|
|
550 (when help-not-visible
|
|
|
551 (with-current-buffer (window-buffer helpwin)
|
|
|
552 (setq help-window-config winconfig)))
|
|
428
|
553 (when help-selects-help-window
|
|
|
554 (select-window helpwin))
|
|
|
555 (cond ((eq helpwin (selected-window))
|
|
|
556 (display-message 'command
|
|
|
557 (substitute-command-keys "Type \\[help-mode-quit] to remove help window, \\[scroll-up] to scroll the help.")))
|
|
|
558 (was-one-window
|
|
|
559 (display-message 'command
|
|
|
560 (substitute-command-keys "Type \\[delete-other-windows] to remove help window, \\[scroll-other-window] to scroll the help.")))
|
|
|
561 (t
|
|
|
562 (display-message 'command
|
|
|
563 (substitute-command-keys "Type \\[switch-to-buffer-other-window] to restore the other window, \\[scroll-other-window] to scroll the help.")))))))))
|
|
|
564
|
|
|
565 (defun describe-key (key)
|
|
|
566 "Display documentation of the function invoked by KEY.
|
|
|
567 KEY is a string, or vector of events.
|
|
|
568 When called interactively, KEY may also be a menu selection."
|
|
|
569 (interactive "kDescribe key: ")
|
|
|
570 (let ((defn (key-or-menu-binding key))
|
|
|
571 (key-string (key-description key)))
|
|
|
572 (if (or (null defn) (integerp defn))
|
|
|
573 (message "%s is undefined" key-string)
|
|
|
574 (with-displaying-help-buffer
|
|
|
575 (lambda ()
|
|
|
576 (princ key-string)
|
|
|
577 (princ " runs ")
|
|
|
578 (if (symbolp defn)
|
|
|
579 (princ (format "`%s'" defn))
|
|
|
580 (princ defn))
|
|
|
581 (princ "\n\n")
|
|
|
582 (cond ((or (stringp defn) (vectorp defn))
|
|
|
583 (let ((cmd (key-binding defn)))
|
|
|
584 (if (not cmd)
|
|
|
585 (princ "a keyboard macro")
|
|
|
586 (progn
|
|
|
587 (princ "a keyboard macro which runs the command ")
|
|
|
588 (princ cmd)
|
|
|
589 (princ ":\n\n")
|
|
|
590 (if (documentation cmd) (princ (documentation cmd)))))))
|
|
|
591 ((and (consp defn) (not (eq 'lambda (car-safe defn))))
|
|
|
592 (let ((describe-function-show-arglist nil))
|
|
|
593 (describe-function-1 (car defn))))
|
|
|
594 ((symbolp defn)
|
|
|
595 (describe-function-1 defn))
|
|
|
596 ((documentation defn)
|
|
|
597 (princ (documentation defn)))
|
|
|
598 (t
|
|
|
599 (princ "not documented"))))
|
|
|
600 (format "key `%s'" key-string)))))
|
|
|
601
|
|
|
602 (defun describe-mode ()
|
|
|
603 "Display documentation of current major mode and minor modes.
|
|
|
604 For this to work correctly for a minor mode, the mode's indicator variable
|
|
|
605 \(listed in `minor-mode-alist') must also be a function whose documentation
|
|
|
606 describes the minor mode."
|
|
|
607 (interactive)
|
|
|
608 (with-displaying-help-buffer
|
|
|
609 (lambda ()
|
|
|
610 ;; XEmacs change: print the major-mode documentation before
|
|
|
611 ;; the minor modes.
|
|
|
612 (princ mode-name)
|
|
|
613 (princ " mode:\n")
|
|
|
614 (princ (documentation major-mode))
|
|
|
615 (princ "\n\n----\n\n")
|
|
|
616 (let ((minor-modes minor-mode-alist))
|
|
|
617 (while minor-modes
|
|
|
618 (let* ((minor-mode (car (car minor-modes)))
|
|
|
619 (indicator (car (cdr (car minor-modes)))))
|
|
|
620 ;; Document a minor mode if it is listed in minor-mode-alist,
|
|
|
621 ;; bound locally in this buffer, non-nil, and has a function
|
|
|
622 ;; definition.
|
|
|
623 (if (and (boundp minor-mode)
|
|
|
624 (symbol-value minor-mode)
|
|
|
625 (fboundp minor-mode))
|
|
|
626 (let ((pretty-minor-mode minor-mode))
|
|
|
627 (if (string-match "-mode\\'" (symbol-name minor-mode))
|
|
|
628 (setq pretty-minor-mode
|
|
|
629 (capitalize
|
|
|
630 (substring (symbol-name minor-mode)
|
|
|
631 0 (match-beginning 0)))))
|
|
|
632 (while (and (consp indicator) (extentp (car indicator)))
|
|
|
633 (setq indicator (cdr indicator)))
|
|
|
634 (while (and indicator (symbolp indicator))
|
|
|
635 (setq indicator (symbol-value indicator)))
|
|
732
|
636 (princ (format "%s minor mode (%s):\n"
|
|
|
637 pretty-minor-mode
|
|
|
638 (if indicator
|
|
|
639 (format "indicator%s" indicator)
|
|
|
640 "no indicator")))
|
|
428
|
641 (princ (documentation minor-mode))
|
|
|
642 (princ "\n\n----\n\n"))))
|
|
|
643 (setq minor-modes (cdr minor-modes)))))
|
|
|
644 (format "%s mode" mode-name)))
|
|
|
645
|
|
|
646 ;; So keyboard macro definitions are documented correctly
|
|
|
647 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
|
|
|
648
|
|
462
|
649 ;; view a read-only file intelligently
|
|
|
650 (defun Help-find-file (file)
|
|
|
651 (if (fboundp 'view-file)
|
|
|
652 (view-file file)
|
|
|
653 (find-file-read-only file)
|
|
|
654 (goto-char (point-min))))
|
|
|
655
|
|
428
|
656 (defun describe-distribution ()
|
|
|
657 "Display info on how to obtain the latest version of XEmacs."
|
|
|
658 (interactive)
|
|
462
|
659 (Help-find-file (locate-data-file "DISTRIB")))
|
|
428
|
660
|
|
|
661 (defun describe-beta ()
|
|
|
662 "Display info on how to deal with Beta versions of XEmacs."
|
|
|
663 (interactive)
|
|
462
|
664 (Help-find-file (locate-data-file "BETA")))
|
|
428
|
665
|
|
|
666 (defun describe-copying ()
|
|
|
667 "Display info on how you may redistribute copies of XEmacs."
|
|
|
668 (interactive)
|
|
462
|
669 (Help-find-file (locate-data-file "COPYING")))
|
|
428
|
670
|
|
|
671 (defun describe-pointer ()
|
|
|
672 "Show a list of all defined mouse buttons, and their definitions."
|
|
|
673 (interactive)
|
|
|
674 (describe-bindings nil t))
|
|
|
675
|
|
|
676 (defun describe-project ()
|
|
|
677 "Display info on the GNU project."
|
|
|
678 (interactive)
|
|
462
|
679 (Help-find-file (locate-data-file "GNU")))
|
|
428
|
680
|
|
|
681 (defun describe-no-warranty ()
|
|
|
682 "Display info on all the kinds of warranty XEmacs does NOT have."
|
|
|
683 (interactive)
|
|
|
684 (describe-copying)
|
|
|
685 (let (case-fold-search)
|
|
|
686 (search-forward "NO WARRANTY")
|
|
|
687 (recenter 0)))
|
|
|
688
|
|
|
689 (defun describe-bindings (&optional prefix mouse-only-p)
|
|
|
690 "Show a list of all defined keys, and their definitions.
|
|
|
691 The list is put in a buffer, which is displayed.
|
|
444
|
692 If optional first argument PREFIX is supplied, only commands
|
|
|
693 which start with that sequence of keys are described.
|
|
|
694 If optional second argument MOUSE-ONLY-P (prefix arg, interactively)
|
|
|
695 is non-nil then only the mouse bindings are displayed."
|
|
428
|
696 (interactive (list nil current-prefix-arg))
|
|
|
697 (with-displaying-help-buffer
|
|
|
698 (lambda ()
|
|
|
699 (describe-bindings-1 prefix mouse-only-p))
|
|
|
700 (format "bindings for %s" major-mode)))
|
|
|
701
|
|
|
702 (defun describe-bindings-1 (&optional prefix mouse-only-p)
|
|
|
703 (let ((heading (if mouse-only-p
|
|
|
704 (gettext "button binding\n------ -------\n")
|
|
|
705 (gettext "key binding\n--- -------\n")))
|
|
|
706 (buffer (current-buffer))
|
|
|
707 (minor minor-mode-map-alist)
|
|
430
|
708 (extent-maps (mapcar-extents
|
|
|
709 'extent-keymap
|
|
|
710 nil (current-buffer) (point) (point) nil 'keymap))
|
|
428
|
711 (local (current-local-map))
|
|
|
712 (shadow '()))
|
|
|
713 (set-buffer standard-output)
|
|
430
|
714 (while extent-maps
|
|
|
715 (insert "Bindings for Text Region:\n"
|
|
|
716 heading)
|
|
|
717 (describe-bindings-internal
|
|
|
718 (car extent-maps) nil shadow prefix mouse-only-p)
|
|
|
719 (insert "\n")
|
|
|
720 (setq shadow (cons (car extent-maps) shadow)
|
|
|
721 extent-maps (cdr extent-maps)))
|
|
428
|
722 (while minor
|
|
|
723 (let ((sym (car (car minor)))
|
|
|
724 (map (cdr (car minor))))
|
|
|
725 (if (symbol-value-in-buffer sym buffer nil)
|
|
|
726 (progn
|
|
|
727 (insert (format "Minor Mode Bindings for `%s':\n"
|
|
|
728 sym)
|
|
|
729 heading)
|
|
|
730 (describe-bindings-internal map nil shadow prefix mouse-only-p)
|
|
|
731 (insert "\n")
|
|
|
732 (setq shadow (cons map shadow))))
|
|
|
733 (setq minor (cdr minor))))
|
|
|
734 (if local
|
|
|
735 (progn
|
|
|
736 (insert "Local Bindings:\n" heading)
|
|
|
737 (describe-bindings-internal local nil shadow prefix mouse-only-p)
|
|
|
738 (insert "\n")
|
|
|
739 (setq shadow (cons local shadow))))
|
|
771
|
740 (if (console-on-window-system-p)
|
|
|
741 (progn
|
|
|
742 (insert "Global Window-System-Only Bindings:\n" heading)
|
|
|
743 (describe-bindings-internal global-window-system-map nil
|
|
|
744 shadow prefix mouse-only-p)
|
|
|
745 (push global-window-system-map shadow))
|
|
|
746 (insert "Global TTY-Only Bindings:\n" heading)
|
|
|
747 (describe-bindings-internal global-tty-map nil
|
|
|
748 shadow prefix mouse-only-p)
|
|
|
749 (push global-tty-map shadow))
|
|
|
750 (insert "\nGlobal Bindings:\n" heading)
|
|
428
|
751 (describe-bindings-internal (current-global-map)
|
|
|
752 nil shadow prefix mouse-only-p)
|
|
|
753 (when (and prefix function-key-map (not mouse-only-p))
|
|
|
754 (insert "\nFunction key map translations:\n" heading)
|
|
|
755 (describe-bindings-internal function-key-map nil nil
|
|
|
756 prefix mouse-only-p))
|
|
|
757 (set-buffer buffer)
|
|
|
758 standard-output))
|
|
|
759
|
|
|
760 (defun describe-prefix-bindings ()
|
|
|
761 "Describe the bindings of the prefix used to reach this command.
|
|
|
762 The prefix described consists of all but the last event
|
|
|
763 of the key sequence that ran this command."
|
|
|
764 (interactive)
|
|
|
765 (let* ((key (this-command-keys))
|
|
|
766 (prefix (make-vector (1- (length key)) nil))
|
|
|
767 i)
|
|
|
768 (setq i 0)
|
|
|
769 (while (< i (length prefix))
|
|
|
770 (aset prefix i (aref key i))
|
|
|
771 (setq i (1+ i)))
|
|
|
772 (with-displaying-help-buffer
|
|
|
773 (lambda ()
|
|
|
774 (princ "Key bindings starting with ")
|
|
|
775 (princ (key-description prefix))
|
|
|
776 (princ ":\n\n")
|
|
|
777 (describe-bindings-1 prefix nil))
|
|
|
778 (format "%s prefix" (key-description prefix)))))
|
|
|
779
|
|
|
780 ;; Make C-h after a prefix, when not specifically bound,
|
|
|
781 ;; run describe-prefix-bindings.
|
|
|
782 (setq prefix-help-command 'describe-prefix-bindings)
|
|
|
783
|
|
|
784 (defun describe-installation ()
|
|
|
785 "Display a buffer showing information about this XEmacs was compiled."
|
|
|
786 (interactive)
|
|
|
787 (if (and (boundp 'Installation-string)
|
|
|
788 (stringp Installation-string))
|
|
|
789 (with-displaying-help-buffer
|
|
|
790 (lambda ()
|
|
442
|
791 (princ
|
|
|
792 (if (fboundp 'decode-coding-string)
|
|
|
793 (decode-coding-string Installation-string 'automatic-conversion)
|
|
|
794 Installation-string)))
|
|
428
|
795 "Installation")
|
|
|
796 (error "No Installation information available.")))
|
|
|
797
|
|
|
798 (defun view-emacs-news ()
|
|
|
799 "Display info on recent changes to XEmacs."
|
|
|
800 (interactive)
|
|
462
|
801 (Help-find-file (locate-data-file "NEWS")))
|
|
428
|
802
|
|
|
803 (defun xemacs-www-page ()
|
|
|
804 "Go to the XEmacs World Wide Web page."
|
|
|
805 (interactive)
|
|
776
|
806 (if-fboundp 'browse-url
|
|
442
|
807 (browse-url "http://www.xemacs.org/")
|
|
428
|
808 (error "xemacs-www-page requires browse-url")))
|
|
|
809
|
|
|
810 (defun xemacs-www-faq ()
|
|
|
811 "View the latest and greatest XEmacs FAQ using the World Wide Web."
|
|
|
812 (interactive)
|
|
776
|
813 (if-fboundp 'browse-url
|
|
442
|
814 (browse-url "http://www.xemacs.org/faq/index.html")
|
|
428
|
815 (error "xemacs-www-faq requires browse-url")))
|
|
|
816
|
|
|
817 (defun xemacs-local-faq ()
|
|
|
818 "View the local copy of the XEmacs FAQ.
|
|
|
819 If you have access to the World Wide Web, you should use `xemacs-www-faq'
|
|
|
820 instead, to ensure that you get the most up-to-date information."
|
|
|
821 (interactive)
|
|
|
822 (save-window-excursion
|
|
|
823 (info)
|
|
|
824 (Info-find-node "xemacs-faq" "Top"))
|
|
|
825 (switch-to-buffer "*info*"))
|
|
|
826
|
|
462
|
827 (defun view-sample-init-el ()
|
|
|
828 "Display the sample init.el file."
|
|
|
829 (interactive)
|
|
|
830 (Help-find-file (locate-data-file "sample.init.el")))
|
|
|
831
|
|
428
|
832 (defcustom view-lossage-key-count 100
|
|
|
833 "*Number of keys `view-lossage' shows.
|
|
|
834 The maximum number of available keys is governed by `recent-keys-ring-size'."
|
|
|
835 :type 'integer
|
|
|
836 :group 'help)
|
|
|
837
|
|
|
838 (defcustom view-lossage-message-count 100
|
|
|
839 "*Number of minibuffer messages `view-lossage' shows."
|
|
|
840 :type 'integer
|
|
|
841 :group 'help)
|
|
|
842
|
|
|
843 (defun print-recent-messages (n)
|
|
|
844 "Print N most recent messages to standard-output, most recent first.
|
|
|
845 If N is nil, all messages will be printed."
|
|
793
|
846 (clear-message) ;; make sure current message goes into log
|
|
428
|
847 (save-excursion
|
|
|
848 (let ((buffer (get-buffer-create " *Message-Log*"))
|
|
|
849 oldpoint extent)
|
|
|
850 (goto-char (point-max buffer) buffer)
|
|
|
851 (set-buffer standard-output)
|
|
|
852 (while (and (not (bobp buffer))
|
|
|
853 (or (null n) (>= (decf n) 0)))
|
|
|
854 (setq oldpoint (point buffer))
|
|
|
855 (setq extent (extent-at oldpoint buffer
|
|
|
856 'message-multiline nil 'before))
|
|
|
857 ;; If the message was multiline, move all the way to the
|
|
|
858 ;; beginning.
|
|
|
859 (if extent
|
|
|
860 (goto-char (extent-start-position extent) buffer)
|
|
|
861 (forward-line -1 buffer))
|
|
|
862 (insert-buffer-substring buffer (point buffer) oldpoint)))))
|
|
|
863
|
|
793
|
864 (defun view-warnings ()
|
|
|
865 "Display warnings issued."
|
|
|
866 (interactive)
|
|
|
867 (with-displaying-help-buffer
|
|
|
868 (lambda ()
|
|
|
869 (let ((buf (get-buffer "*Warnings*")))
|
|
|
870 (when buf
|
|
|
871 (save-excursion
|
|
|
872 (set-buffer standard-output)
|
|
|
873 (map-extents
|
|
|
874 #'(lambda (extent arg)
|
|
|
875 (goto-char (point-min))
|
|
|
876 (insert (extent-string extent)))
|
|
|
877 buf)))))
|
|
|
878 "warnings"))
|
|
|
879
|
|
|
880 (defun view-lossage (&optional no-keys)
|
|
428
|
881 "Display recent input keystrokes and recent minibuffer messages.
|
|
|
882 The number of keys shown is controlled by `view-lossage-key-count'.
|
|
|
883 The number of messages shown is controlled by `view-lossage-message-count'."
|
|
|
884 (interactive)
|
|
|
885 (with-displaying-help-buffer
|
|
|
886 (lambda ()
|
|
793
|
887 (unless no-keys
|
|
|
888 (princ (key-description (recent-keys view-lossage-key-count)))
|
|
|
889 (save-excursion
|
|
|
890 (set-buffer standard-output)
|
|
|
891 (goto-char (point-min))
|
|
|
892 (insert "Recent keystrokes:\n\n")
|
|
|
893 (while (progn (move-to-column 50) (not (eobp)))
|
|
|
894 (search-forward " " nil t)
|
|
|
895 (insert "\n")))
|
|
|
896 (princ "\n\n\n"))
|
|
|
897 ;; Copy the messages from " *Message-Log*", reversing their order and
|
|
|
898 ;; handling multiline messages correctly.
|
|
|
899 (princ "Recent minibuffer messages (most recent first):\n\n")
|
|
428
|
900 (print-recent-messages view-lossage-message-count))
|
|
|
901 "lossage"))
|
|
|
902
|
|
|
903 (define-function 'help 'help-for-help)
|
|
|
904
|
|
|
905 (make-help-screen help-for-help
|
|
|
906 "A B C F I K L M N P S T V W C-c C-d C-f C-i C-k C-n C-w; ? for more help:"
|
|
502
|
907 (concat
|
|
|
908 "Type a Help option:
|
|
428
|
909 \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.)
|
|
|
910
|
|
502
|
911 Help on key bindings:
|
|
|
912
|
|
|
913 \\[describe-bindings] Table of all key bindings.
|
|
|
914 \\[describe-key-briefly] Type a key sequence or select a menu item;
|
|
|
915 it displays the corresponding command name.
|
|
|
916 \\[describe-key] Type a key sequence or select a menu item;
|
|
|
917 it displays the documentation for the command bound to that key.
|
|
|
918 (Terser but more up-to-date than what's in the manual.)
|
|
|
919 \\[Info-goto-emacs-key-command-node] Type a key sequence or select a menu item;
|
|
|
920 it jumps to the full documentation in the XEmacs User's Manual
|
|
|
921 for the corresponding command.
|
|
|
922 \\[view-lossage] Recent input keystrokes and minibuffer messages.
|
|
|
923 \\[describe-mode] Documentation of current major and minor modes.
|
|
|
924 \\[describe-pointer] Table of all mouse-button bindings.
|
|
|
925 \\[where-is] Type a command name; it displays which keystrokes invoke that command.
|
|
|
926
|
|
|
927 Help on functions and variables:
|
|
|
928
|
|
428
|
929 \\[hyper-apropos] Type a substring; it shows a hypertext list of
|
|
|
930 functions and variables that contain that substring.
|
|
502
|
931 \\[command-apropos] Older version of apropos; superseded by previous command.
|
|
|
932 \\[apropos-documentation] Type a substring; it shows a hypertext list of
|
|
|
933 functions and variables containing that substring anywhere
|
|
|
934 in their documentation.
|
|
|
935 \\[Info-goto-emacs-command-node] Type a command name; it jumps to the full documentation
|
|
|
936 in the XEmacs User's Manual.
|
|
|
937 \\[describe-function] Type a command or function name; it shows its documentation.
|
|
|
938 (Terser but more up-to-date than what's in the manual.)
|
|
|
939 \\[Info-elisp-ref] Type a function name; it jumps to the full documentation
|
|
|
940 in the XEmacs Lisp Reference Manual.
|
|
|
941 \\[Info-search-index-in-xemacs-and-lispref] Type a substring; it looks it up in the indices of both
|
|
|
942 the XEmacs User's Manual and the XEmacs Lisp Reference Manual.
|
|
|
943 It jumps to the first match (preferring an exact match); you
|
|
|
944 can use `\\<Info-mode-map>\\[Info-index-next]\\<help-map>' to successively visit other matches.
|
|
|
945 \\[describe-variable] Type a variable name; it displays its documentation and value.
|
|
|
946
|
|
|
947 Miscellaneous:
|
|
|
948
|
|
|
949 "
|
|
|
950 (if (string-match "beta" emacs-version)
|
|
|
951 "\\[describe-beta] Special considerations about running a beta version of XEmacs.
|
|
|
952 "
|
|
|
953 "")
|
|
|
954 "
|
|
428
|
955 \\[customize] Customize Emacs options.
|
|
502
|
956 \\[describe-distribution] How to obtain XEmacs.
|
|
|
957 \\[describe-last-error] Information about the most recent error.
|
|
428
|
958 \\[xemacs-local-faq] Local copy of the XEmacs FAQ.
|
|
|
959 \\[info] Info documentation reader.
|
|
|
960 \\[Info-query] Type an Info file name; it displays it in Info reader.
|
|
502
|
961 \\[describe-copying] XEmacs copying permission (General Public License).
|
|
428
|
962 \\[view-emacs-news] News of recent XEmacs changes.
|
|
|
963 \\[finder-by-keyword] Type a topic keyword; it finds matching packages.
|
|
|
964 \\[describe-syntax] Contents of syntax table with explanations.
|
|
502
|
965 \\[view-sample-init-el] View the sample init.el that comes with XEmacs.
|
|
428
|
966 \\[help-with-tutorial] XEmacs learn-by-doing tutorial.
|
|
502
|
967 \\[describe-no-warranty] Information on absence of warranty for XEmacs."
|
|
|
968 )
|
|
428
|
969 help-map)
|
|
|
970
|
|
|
971 (defmacro with-syntax-table (syntab &rest body)
|
|
444
|
972 "Evaluate BODY with the SYNTAB as the current syntax table."
|
|
428
|
973 `(let ((stab (syntax-table)))
|
|
|
974 (unwind-protect
|
|
|
975 (progn
|
|
|
976 (set-syntax-table (copy-syntax-table ,syntab))
|
|
|
977 ,@body)
|
|
|
978 (set-syntax-table stab))))
|
|
|
979 (put 'with-syntax-table 'lisp-indent-function 1)
|
|
|
980 (put 'with-syntax-table 'edebug-form-spec '(form body))
|
|
|
981
|
|
|
982 (defun function-called-at-point ()
|
|
|
983 "Return the function which is called by the list containing point.
|
|
|
984 If that gives no function, return the function whose name is around point.
|
|
|
985 If that doesn't give a function, return nil."
|
|
|
986 (or (ignore-errors
|
|
|
987 (save-excursion
|
|
|
988 (save-restriction
|
|
|
989 (narrow-to-region (max (point-min) (- (point) 1000))
|
|
|
990 (point-max))
|
|
|
991 (backward-up-list 1)
|
|
|
992 (forward-char 1)
|
|
|
993 (let (obj)
|
|
|
994 (setq obj (read (current-buffer)))
|
|
|
995 (and (symbolp obj) (fboundp obj) obj)))))
|
|
|
996 (ignore-errors
|
|
|
997 (with-syntax-table emacs-lisp-mode-syntax-table
|
|
|
998 (save-excursion
|
|
|
999 (or (not (zerop (skip-syntax-backward "_w")))
|
|
|
1000 (eq (char-syntax (char-after (point))) ?w)
|
|
|
1001 (eq (char-syntax (char-after (point))) ?_)
|
|
|
1002 (forward-sexp -1))
|
|
|
1003 (skip-chars-forward "`'")
|
|
|
1004 (let ((obj (read (current-buffer))))
|
|
|
1005 (and (symbolp obj) (fboundp obj) obj)))))))
|
|
|
1006
|
|
|
1007 (defun function-at-point ()
|
|
|
1008 "Return the function whose name is around point.
|
|
|
1009 If that gives no function, return the function which is called by the
|
|
|
1010 list containing point. If that doesn't give a function, return nil."
|
|
|
1011 (or (ignore-errors
|
|
|
1012 (with-syntax-table emacs-lisp-mode-syntax-table
|
|
|
1013 (save-excursion
|
|
|
1014 (or (not (zerop (skip-syntax-backward "_w")))
|
|
|
1015 (eq (char-syntax (char-after (point))) ?w)
|
|
|
1016 (eq (char-syntax (char-after (point))) ?_)
|
|
|
1017 (forward-sexp -1))
|
|
|
1018 (skip-chars-forward "`'")
|
|
|
1019 (let ((obj (read (current-buffer))))
|
|
|
1020 (and (symbolp obj) (fboundp obj) obj)))))
|
|
|
1021 (ignore-errors
|
|
|
1022 (save-excursion
|
|
|
1023 (save-restriction
|
|
|
1024 (narrow-to-region (max (point-min) (- (point) 1000))
|
|
|
1025 (point-max))
|
|
|
1026 (backward-up-list 1)
|
|
|
1027 (forward-char 1)
|
|
|
1028 (let (obj)
|
|
|
1029 (setq obj (read (current-buffer)))
|
|
|
1030 (and (symbolp obj) (fboundp obj) obj)))))))
|
|
|
1031
|
|
442
|
1032 (defun function-at-event (event)
|
|
|
1033 "Return the function whose name is around the position of EVENT.
|
|
|
1034 EVENT should be a mouse event. When calling from a popup or context menu,
|
|
|
1035 use `last-popup-menu-event' to find out where the mouse was clicked.
|
|
|
1036 \(You cannot use (interactive \"e\"), unfortunately. This returns a
|
|
|
1037 misc-user event.)
|
|
|
1038
|
|
|
1039 If the event contains no position, or the position is not over text, or
|
|
|
1040 there is no function around that point, nil is returned."
|
|
|
1041 (if (and event (event-buffer event) (event-point event))
|
|
|
1042 (save-excursion
|
|
|
1043 (set-buffer (event-buffer event))
|
|
|
1044 (goto-char (event-point event))
|
|
|
1045 (function-at-point))))
|
|
|
1046
|
|
428
|
1047 ;; Default to nil for the non-hackers? Not until we find a way to
|
|
|
1048 ;; distinguish hackers from non-hackers automatically!
|
|
|
1049 (defcustom describe-function-show-arglist t
|
|
|
1050 "*If non-nil, describe-function will show its arglist,
|
|
|
1051 unless the function is autoloaded."
|
|
|
1052 :type 'boolean
|
|
|
1053 :group 'help-appearance)
|
|
|
1054
|
|
|
1055 (defun describe-symbol-find-file (symbol)
|
|
|
1056 (loop for (file . load-data) in load-history
|
|
|
1057 do (when (memq symbol load-data)
|
|
|
1058 (return file))))
|
|
|
1059
|
|
|
1060 (define-obsolete-function-alias
|
|
|
1061 'describe-function-find-file
|
|
|
1062 'describe-symbol-find-file)
|
|
|
1063
|
|
|
1064 (defun describe-function (function)
|
|
|
1065 "Display the full documentation of FUNCTION (a symbol).
|
|
|
1066 When run interactively, it defaults to any function found by
|
|
|
1067 `function-at-point'."
|
|
|
1068 (interactive
|
|
|
1069 (let* ((fn (function-at-point))
|
|
|
1070 (val (let ((enable-recursive-minibuffers t))
|
|
|
1071 (completing-read
|
|
|
1072 (if fn
|
|
|
1073 (format (gettext "Describe function (default %s): ")
|
|
|
1074 fn)
|
|
|
1075 (gettext "Describe function: "))
|
|
430
|
1076 obarray 'fboundp t nil 'function-history
|
|
|
1077 (symbol-name fn)))))
|
|
|
1078 (list (intern val))))
|
|
428
|
1079 (with-displaying-help-buffer
|
|
|
1080 (lambda ()
|
|
|
1081 (describe-function-1 function)
|
|
|
1082 ;; Return the text we displayed.
|
|
|
1083 (buffer-string nil nil standard-output))
|
|
|
1084 (format "function `%s'" function)))
|
|
|
1085
|
|
|
1086 (defun function-obsolete-p (function)
|
|
|
1087 "Return non-nil if FUNCTION is obsolete."
|
|
|
1088 (not (null (get function 'byte-obsolete-info))))
|
|
|
1089
|
|
|
1090 (defun function-obsoleteness-doc (function)
|
|
|
1091 "If FUNCTION is obsolete, return a string describing this."
|
|
|
1092 (let ((obsolete (get function 'byte-obsolete-info)))
|
|
|
1093 (if obsolete
|
|
|
1094 (format "Obsolete; %s"
|
|
|
1095 (if (stringp (car obsolete))
|
|
|
1096 (car obsolete)
|
|
|
1097 (format "use `%s' instead." (car obsolete)))))))
|
|
|
1098
|
|
|
1099 (defun function-compatible-p (function)
|
|
|
1100 "Return non-nil if FUNCTION is present for Emacs compatibility."
|
|
|
1101 (not (null (get function 'byte-compatible-info))))
|
|
|
1102
|
|
|
1103 (defun function-compatibility-doc (function)
|
|
|
1104 "If FUNCTION is Emacs compatible, return a string describing this."
|
|
|
1105 (let ((compatible (get function 'byte-compatible-info)))
|
|
|
1106 (if compatible
|
|
|
1107 (format "Emacs Compatible; %s"
|
|
|
1108 (if (stringp (car compatible))
|
|
|
1109 (car compatible)
|
|
|
1110 (format "use `%s' instead." (car compatible)))))))
|
|
|
1111
|
|
|
1112 ;Here are all the possibilities below spelled out, for the benefit
|
|
|
1113 ;of the I18N3 snarfer.
|
|
|
1114 ;
|
|
|
1115 ;(gettext "a built-in function")
|
|
|
1116 ;(gettext "an interactive built-in function")
|
|
|
1117 ;(gettext "a built-in macro")
|
|
|
1118 ;(gettext "an interactive built-in macro")
|
|
|
1119 ;(gettext "a compiled Lisp function")
|
|
|
1120 ;(gettext "an interactive compiled Lisp function")
|
|
|
1121 ;(gettext "a compiled Lisp macro")
|
|
|
1122 ;(gettext "an interactive compiled Lisp macro")
|
|
|
1123 ;(gettext "a Lisp function")
|
|
|
1124 ;(gettext "an interactive Lisp function")
|
|
|
1125 ;(gettext "a Lisp macro")
|
|
|
1126 ;(gettext "an interactive Lisp macro")
|
|
|
1127 ;(gettext "a mocklisp function")
|
|
|
1128 ;(gettext "an interactive mocklisp function")
|
|
|
1129 ;(gettext "a mocklisp macro")
|
|
|
1130 ;(gettext "an interactive mocklisp macro")
|
|
|
1131 ;(gettext "an autoloaded Lisp function")
|
|
|
1132 ;(gettext "an interactive autoloaded Lisp function")
|
|
|
1133 ;(gettext "an autoloaded Lisp macro")
|
|
|
1134 ;(gettext "an interactive autoloaded Lisp macro")
|
|
|
1135
|
|
|
1136 ;; taken out of `describe-function-1'
|
|
|
1137 (defun function-arglist (function)
|
|
|
1138 "Return a string giving the argument list of FUNCTION.
|
|
|
1139 For example:
|
|
|
1140
|
|
|
1141 (function-arglist 'function-arglist)
|
|
|
1142 => (function-arglist FUNCTION)
|
|
|
1143
|
|
|
1144 This function is used by `describe-function-1' to list function
|
|
|
1145 arguments in the standard Lisp style."
|
|
440
|
1146 (let* ((fnc (indirect-function function))
|
|
|
1147 (fndef (if (eq (car-safe fnc) 'macro)
|
|
|
1148 (cdr fnc)
|
|
|
1149 fnc))
|
|
428
|
1150 (arglist
|
|
440
|
1151 (cond ((compiled-function-p fndef)
|
|
|
1152 (compiled-function-arglist fndef))
|
|
|
1153 ((eq (car-safe fndef) 'lambda)
|
|
|
1154 (nth 1 fndef))
|
|
|
1155 ((subrp fndef)
|
|
|
1156 (let* ((doc (documentation function))
|
|
|
1157 (args (and (string-match
|
|
|
1158 "[\n\t ]*\narguments: ?(\\(.*\\))\n?\\'"
|
|
|
1159 doc)
|
|
|
1160 (match-string 1 doc))))
|
|
|
1161 ;; If there are no arguments documented for the
|
|
|
1162 ;; subr, rather don't print anything.
|
|
|
1163 (cond ((null args) t)
|
|
|
1164 ((equal args "") nil)
|
|
|
1165 (args))))
|
|
|
1166 (t t))))
|
|
428
|
1167 (cond ((listp arglist)
|
|
|
1168 (prin1-to-string
|
|
|
1169 (cons function (mapcar (lambda (arg)
|
|
|
1170 (if (memq arg '(&optional &rest))
|
|
|
1171 arg
|
|
|
1172 (intern (upcase (symbol-name arg)))))
|
|
|
1173 arglist))
|
|
|
1174 t))
|
|
|
1175 ((stringp arglist)
|
|
|
1176 (format "(%s %s)" function arglist)))))
|
|
|
1177
|
|
|
1178 (defun function-documentation (function &optional strip-arglist)
|
|
|
1179 "Return a string giving the documentation for FUNCTION, if any.
|
|
|
1180 If the optional argument STRIP-ARGLIST is non-nil, remove the arglist
|
|
|
1181 part of the documentation of internal subroutines."
|
|
|
1182 (let ((doc (condition-case nil
|
|
|
1183 (or (documentation function)
|
|
|
1184 (gettext "not documented"))
|
|
|
1185 (void-function ""))))
|
|
|
1186 (if (and strip-arglist
|
|
|
1187 (string-match "[\n\t ]*\narguments: ?(\\(.*\\))\n?\\'" doc))
|
|
|
1188 (setq doc (substring doc 0 (match-beginning 0))))
|
|
|
1189 doc))
|
|
442
|
1190
|
|
462
|
1191 ;; replacement for `princ' that puts the text in the specified face,
|
|
|
1192 ;; if possible
|
|
|
1193 (defun Help-princ-face (object face)
|
|
|
1194 (cond ((bufferp standard-output)
|
|
464
|
1195 (let ((opoint (point standard-output)))
|
|
|
1196 (princ object)
|
|
|
1197 (put-nonduplicable-text-property opoint (point standard-output)
|
|
|
1198 'face face standard-output)))
|
|
|
1199 ((markerp standard-output)
|
|
|
1200 (let ((buf (marker-buffer standard-output))
|
|
|
1201 (pos (marker-position standard-output)))
|
|
|
1202 (princ object)
|
|
|
1203 (put-nonduplicable-text-property
|
|
|
1204 pos (marker-position standard-output) 'face face buf)))
|
|
|
1205 (t princ object)))
|
|
462
|
1206
|
|
|
1207 ;; replacement for `prin1' that puts the text in the specified face,
|
|
|
1208 ;; if possible
|
|
|
1209 (defun Help-prin1-face (object face)
|
|
|
1210 (cond ((bufferp standard-output)
|
|
464
|
1211 (let ((opoint (point standard-output)))
|
|
|
1212 (prin1 object)
|
|
|
1213 (put-nonduplicable-text-property opoint (point standard-output)
|
|
|
1214 'face face standard-output)))
|
|
|
1215 ((markerp standard-output)
|
|
|
1216 (let ((buf (marker-buffer standard-output))
|
|
|
1217 (pos (marker-position standard-output)))
|
|
|
1218 (prin1 object)
|
|
|
1219 (put-nonduplicable-text-property
|
|
|
1220 pos (marker-position standard-output) 'face face buf)))
|
|
|
1221 (t prin1 object)))
|
|
462
|
1222
|
|
442
|
1223 (defvar help-symbol-regexp
|
|
|
1224 (let ((sym-char "[+a-zA-Z0-9_:*]")
|
|
|
1225 (sym-char-no-dash "[-+a-zA-Z0-9_:*]"))
|
|
|
1226 (concat "\\("
|
|
|
1227 ;; a symbol with a - in it.
|
|
|
1228 "\\<\\(" sym-char-no-dash "+\\(-" sym-char-no-dash "+\\)+\\)\\>"
|
|
|
1229 "\\|"
|
|
|
1230 "`\\(" sym-char "+\\)'"
|
|
|
1231 "\\)")))
|
|
|
1232
|
|
|
1233 (defun help-symbol-run-function-1 (ev ex fun)
|
|
|
1234 (let ((help-sticky-window
|
|
|
1235 ;; if we were called from a help buffer, make sure the new help
|
|
|
1236 ;; goes in the same window.
|
|
|
1237 (if (and (event-buffer ev)
|
|
|
1238 (symbol-value-in-buffer 'help-window-config
|
|
|
1239 (event-buffer ev)))
|
|
|
1240 (event-window ev)
|
|
|
1241 help-sticky-window)))
|
|
|
1242 (funcall fun (extent-property ex 'help-symbol))))
|
|
|
1243
|
|
|
1244 (defun help-symbol-run-function (fun)
|
|
|
1245 (let ((ex (extent-at-event last-popup-menu-event 'help-symbol)))
|
|
|
1246 (when ex
|
|
|
1247 (help-symbol-run-function-1 last-popup-menu-event ex fun))))
|
|
|
1248
|
|
|
1249 (defvar help-symbol-function-context-menu
|
|
462
|
1250 '(["View %_Documentation" (help-symbol-run-function 'describe-function)]
|
|
442
|
1251 ["Find %_Function Source" (help-symbol-run-function 'find-function)]
|
|
462
|
1252 ["Find %_Tag" (help-symbol-run-function 'find-tag)]
|
|
442
|
1253 ))
|
|
|
1254
|
|
|
1255 (defvar help-symbol-variable-context-menu
|
|
462
|
1256 '(["View %_Documentation" (help-symbol-run-function 'describe-variable)]
|
|
442
|
1257 ["Find %_Variable Source" (help-symbol-run-function 'find-variable)]
|
|
462
|
1258 ["Find %_Tag" (help-symbol-run-function 'find-tag)]
|
|
442
|
1259 ))
|
|
|
1260
|
|
|
1261 (defvar help-symbol-function-and-variable-context-menu
|
|
462
|
1262 '(["View Function %_Documentation" (help-symbol-run-function
|
|
442
|
1263 'describe-function)]
|
|
|
1264 ["View Variable D%_ocumentation" (help-symbol-run-function
|
|
|
1265 'describe-variable)]
|
|
|
1266 ["Find %_Function Source" (help-symbol-run-function 'find-function)]
|
|
|
1267 ["Find %_Variable Source" (help-symbol-run-function 'find-variable)]
|
|
462
|
1268 ["Find %_Tag" (help-symbol-run-function 'find-tag)]
|
|
442
|
1269 ))
|
|
|
1270
|
|
|
1271 (defun frob-help-extents (buffer)
|
|
|
1272 ;; Look through BUFFER, starting at the buffer's point and continuing
|
|
|
1273 ;; till end of file, and find documented functions and variables.
|
|
|
1274 ;; any such symbol found is tagged with an extent, that sets up these
|
|
|
1275 ;; properties:
|
|
|
1276 ;; 1. mouse-face is 'highlight (so the extent gets highlighted on mouse over)
|
|
|
1277 ;; 2. help-symbol is the name of the symbol.
|
|
464
|
1278 ;; 3. face is 'hyper-apropos-hyperlink.
|
|
462
|
1279 ;; 4. context-menu is a list of context menu items, specific to whether
|
|
442
|
1280 ;; the symbol is a function, variable, or both.
|
|
462
|
1281 ;; 5. activate-function will cause the function or variable to be described,
|
|
442
|
1282 ;; replacing the existing help contents.
|
|
|
1283 (save-excursion
|
|
|
1284 (set-buffer buffer)
|
|
|
1285 (let (b e name)
|
|
|
1286 (while (re-search-forward help-symbol-regexp nil t)
|
|
|
1287 (setq b (or (match-beginning 2) (match-beginning 4)))
|
|
|
1288 (setq e (or (match-end 2) (match-end 4)))
|
|
|
1289 (setq name (buffer-substring b e))
|
|
|
1290 (let* ((sym (intern-soft name))
|
|
|
1291 (var (and sym (boundp sym)
|
|
|
1292 (documentation-property sym
|
|
|
1293 'variable-documentation t)))
|
|
|
1294 (fun (and sym (fboundp sym)
|
|
|
1295 (documentation sym t))))
|
|
|
1296 (when (or var fun)
|
|
|
1297 (let ((ex (make-extent b e)))
|
|
622
|
1298 (require 'hyper-apropos)
|
|
442
|
1299 (set-extent-property ex 'mouse-face 'highlight)
|
|
|
1300 (set-extent-property ex 'help-symbol sym)
|
|
464
|
1301 (set-extent-property ex 'face 'hyper-apropos-hyperlink)
|
|
442
|
1302 (set-extent-property
|
|
|
1303 ex 'context-menu
|
|
|
1304 (cond ((and var fun)
|
|
|
1305 help-symbol-function-and-variable-context-menu)
|
|
|
1306 (var help-symbol-variable-context-menu)
|
|
|
1307 (fun help-symbol-function-context-menu)))
|
|
|
1308 (set-extent-property
|
|
|
1309 ex 'activate-function
|
|
|
1310 (if fun
|
|
|
1311 #'(lambda (ev ex)
|
|
|
1312 (help-symbol-run-function-1 ev ex 'describe-function))
|
|
|
1313 #'(lambda (ev ex)
|
|
|
1314 (help-symbol-run-function-1 ev ex 'describe-variable))))
|
|
|
1315 ))))))) ;; 11 parentheses!
|
|
428
|
1316
|
|
|
1317 (defun describe-function-1 (function &optional nodoc)
|
|
|
1318 "This function does the work for `describe-function'."
|
|
462
|
1319 (princ "`")
|
|
|
1320 ;; (Help-princ-face function 'font-lock-function-name-face) overkill
|
|
|
1321 (princ function)
|
|
|
1322 (princ "' is ")
|
|
428
|
1323 (let* ((def function)
|
|
|
1324 aliases file-name autoload-file kbd-macro-p fndef macrop)
|
|
|
1325 (while (and (symbolp def) (fboundp def))
|
|
|
1326 (when (not (eq def function))
|
|
|
1327 (setq aliases
|
|
|
1328 (if aliases
|
|
|
1329 ;; I18N3 Need gettext due to concat
|
|
|
1330 (concat aliases
|
|
|
1331 (format
|
|
|
1332 "\n which is an alias for `%s', "
|
|
|
1333 (symbol-name def)))
|
|
|
1334 (format "an alias for `%s', " (symbol-name def)))))
|
|
|
1335 (setq def (symbol-function def)))
|
|
|
1336 (if (and (fboundp 'compiled-function-annotation)
|
|
|
1337 (compiled-function-p def))
|
|
502
|
1338 (setq file-name (declare-fboundp (compiled-function-annotation def))))
|
|
428
|
1339 (if (eq 'macro (car-safe def))
|
|
|
1340 (setq fndef (cdr def)
|
|
|
1341 file-name (and (compiled-function-p (cdr def))
|
|
|
1342 (fboundp 'compiled-function-annotation)
|
|
502
|
1343 (declare-fboundp
|
|
|
1344 (compiled-function-annotation (cdr def))))
|
|
428
|
1345 macrop t)
|
|
|
1346 (setq fndef def))
|
|
|
1347 (if aliases (princ aliases))
|
|
|
1348 (let ((int #'(lambda (string an-p macro-p)
|
|
|
1349 (princ (format
|
|
|
1350 (gettext (concat
|
|
|
1351 (cond ((commandp def)
|
|
|
1352 "an interactive ")
|
|
|
1353 (an-p "an ")
|
|
|
1354 (t "a "))
|
|
|
1355 "%s"
|
|
|
1356 (if macro-p " macro" " function")))
|
|
|
1357 string)))))
|
|
|
1358 (cond ((or (stringp def) (vectorp def))
|
|
|
1359 (princ "a keyboard macro.")
|
|
|
1360 (setq kbd-macro-p t))
|
|
|
1361 ((subrp fndef)
|
|
|
1362 (funcall int "built-in" nil macrop))
|
|
|
1363 ((compiled-function-p fndef)
|
|
|
1364 (funcall int "compiled Lisp" nil macrop))
|
|
|
1365 ((eq (car-safe fndef) 'lambda)
|
|
|
1366 (funcall int "Lisp" nil macrop))
|
|
|
1367 ((eq (car-safe fndef) 'mocklisp)
|
|
|
1368 (funcall int "mocklisp" nil macrop))
|
|
|
1369 ((eq (car-safe def) 'autoload)
|
|
|
1370 (setq autoload-file (elt def 1))
|
|
|
1371 (funcall int "autoloaded Lisp" t (elt def 4)))
|
|
|
1372 ((and (symbolp def) (not (fboundp def)))
|
|
|
1373 (princ "a symbol with a void (unbound) function definition."))
|
|
|
1374 (t
|
|
|
1375 nil)))
|
|
|
1376 (princ "\n")
|
|
|
1377 (if autoload-file
|
|
|
1378 (princ (format " -- autoloads from \"%s\"\n" autoload-file)))
|
|
|
1379 (or file-name
|
|
|
1380 (setq file-name (describe-symbol-find-file function)))
|
|
|
1381 (if file-name
|
|
|
1382 (princ (format " -- loaded from \"%s\"\n" file-name)))
|
|
|
1383 ;; (terpri)
|
|
|
1384 (if describe-function-show-arglist
|
|
|
1385 (let ((arglist (function-arglist function)))
|
|
|
1386 (when arglist
|
|
464
|
1387 (require 'hyper-apropos)
|
|
|
1388 (Help-princ-face arglist 'hyper-apropos-documentation)
|
|
428
|
1389 (terpri))))
|
|
|
1390 (terpri)
|
|
|
1391 (cond (kbd-macro-p
|
|
|
1392 (princ "These characters are executed:\n\n\t")
|
|
|
1393 (princ (key-description def))
|
|
|
1394 (cond ((setq def (key-binding def))
|
|
|
1395 (princ (format "\n\nwhich executes the command `%s'.\n\n"
|
|
|
1396 def))
|
|
|
1397 (describe-function-1 def))))
|
|
|
1398 (nodoc nil)
|
|
|
1399 (t
|
|
|
1400 ;; tell the user about obsoleteness.
|
|
|
1401 ;; If the function is obsolete and is aliased, don't
|
|
|
1402 ;; even bother to report the documentation, as a further
|
|
|
1403 ;; encouragement to use the new function.
|
|
|
1404 (let ((obsolete (function-obsoleteness-doc function))
|
|
|
1405 (compatible (function-compatibility-doc function)))
|
|
|
1406 (when obsolete
|
|
|
1407 (princ obsolete)
|
|
|
1408 (terpri)
|
|
|
1409 (terpri))
|
|
|
1410 (when compatible
|
|
|
1411 (princ compatible)
|
|
|
1412 (terpri)
|
|
|
1413 (terpri))
|
|
|
1414 (unless (and obsolete aliases)
|
|
|
1415 (let ((doc (function-documentation function t)))
|
|
|
1416 (princ "Documentation:\n")
|
|
442
|
1417 (let ((oldp (point standard-output))
|
|
|
1418 newp)
|
|
|
1419 (princ doc)
|
|
|
1420 (setq newp (point standard-output))
|
|
|
1421 (goto-char oldp standard-output)
|
|
|
1422 (frob-help-extents standard-output)
|
|
|
1423 (goto-char newp standard-output))
|
|
428
|
1424 (unless (or (equal doc "")
|
|
|
1425 (eq ?\n (aref doc (1- (length doc)))))
|
|
|
1426 (terpri)))))))))
|
|
|
1427
|
|
|
1428
|
|
|
1429 ;;; [Obnoxious, whining people who complain very LOUDLY on Usenet
|
|
|
1430 ;;; are binding this to keys.]
|
|
|
1431 (defun describe-function-arglist (function)
|
|
|
1432 (interactive (list (or (function-at-point)
|
|
|
1433 (error "no function call at point"))))
|
|
|
1434 (message nil)
|
|
|
1435 (message (function-arglist function)))
|
|
|
1436
|
|
|
1437 (defun variable-at-point ()
|
|
|
1438 (ignore-errors
|
|
|
1439 (with-syntax-table emacs-lisp-mode-syntax-table
|
|
|
1440 (save-excursion
|
|
|
1441 (or (not (zerop (skip-syntax-backward "_w")))
|
|
|
1442 (eq (char-syntax (char-after (point))) ?w)
|
|
|
1443 (eq (char-syntax (char-after (point))) ?_)
|
|
|
1444 (forward-sexp -1))
|
|
|
1445 (skip-chars-forward "'")
|
|
|
1446 (let ((obj (read (current-buffer))))
|
|
|
1447 (and (symbolp obj) (boundp obj) obj))))))
|
|
|
1448
|
|
442
|
1449 (defun variable-at-event (event)
|
|
|
1450 "Return the variable whose name is around the position of EVENT.
|
|
|
1451 EVENT should be a mouse event. When calling from a popup or context menu,
|
|
|
1452 use `last-popup-menu-event' to find out where the mouse was clicked.
|
|
|
1453 \(You cannot use (interactive \"e\"), unfortunately. This returns a
|
|
|
1454 misc-user event.)
|
|
|
1455
|
|
|
1456 If the event contains no position, or the position is not over text, or
|
|
|
1457 there is no variable around that point, nil is returned."
|
|
|
1458 (if (and event (event-buffer event) (event-point event))
|
|
|
1459 (save-excursion
|
|
|
1460 (set-buffer (event-buffer event))
|
|
|
1461 (goto-char (event-point event))
|
|
|
1462 (variable-at-point))))
|
|
|
1463
|
|
428
|
1464 (defun variable-obsolete-p (variable)
|
|
|
1465 "Return non-nil if VARIABLE is obsolete."
|
|
|
1466 (not (null (get variable 'byte-obsolete-variable))))
|
|
|
1467
|
|
|
1468 (defun variable-obsoleteness-doc (variable)
|
|
|
1469 "If VARIABLE is obsolete, return a string describing this."
|
|
|
1470 (let ((obsolete (get variable 'byte-obsolete-variable)))
|
|
|
1471 (if obsolete
|
|
|
1472 (format "Obsolete; %s"
|
|
|
1473 (if (stringp obsolete)
|
|
|
1474 obsolete
|
|
|
1475 (format "use `%s' instead." obsolete))))))
|
|
|
1476
|
|
|
1477 (defun variable-compatible-p (variable)
|
|
|
1478 "Return non-nil if VARIABLE is Emacs compatible."
|
|
|
1479 (not (null (get variable 'byte-compatible-variable))))
|
|
|
1480
|
|
|
1481 (defun variable-compatibility-doc (variable)
|
|
|
1482 "If VARIABLE is Emacs compatible, return a string describing this."
|
|
|
1483 (let ((compatible (get variable 'byte-compatible-variable)))
|
|
|
1484 (if compatible
|
|
|
1485 (format "Emacs Compatible; %s"
|
|
|
1486 (if (stringp compatible)
|
|
|
1487 compatible
|
|
|
1488 (format "use `%s' instead." compatible))))))
|
|
|
1489
|
|
|
1490 (defun built-in-variable-doc (variable)
|
|
|
1491 "Return a string describing whether VARIABLE is built-in."
|
|
|
1492 (let ((type (built-in-variable-type variable)))
|
|
|
1493 (case type
|
|
|
1494 (integer "a built-in integer variable")
|
|
|
1495 (const-integer "a built-in constant integer variable")
|
|
|
1496 (boolean "a built-in boolean variable")
|
|
|
1497 (const-boolean "a built-in constant boolean variable")
|
|
|
1498 (object "a simple built-in variable")
|
|
|
1499 (const-object "a simple built-in constant variable")
|
|
|
1500 (const-specifier "a built-in constant specifier variable")
|
|
|
1501 (current-buffer "a built-in buffer-local variable")
|
|
|
1502 (const-current-buffer "a built-in constant buffer-local variable")
|
|
|
1503 (default-buffer "a built-in default buffer-local variable")
|
|
|
1504 (selected-console "a built-in console-local variable")
|
|
|
1505 (const-selected-console "a built-in constant console-local variable")
|
|
|
1506 (default-console "a built-in default console-local variable")
|
|
|
1507 (t
|
|
|
1508 (if type "an unknown type of built-in variable?"
|
|
|
1509 "a variable declared in Lisp")))))
|
|
|
1510
|
|
|
1511 (defun describe-variable (variable)
|
|
|
1512 "Display the full documentation of VARIABLE (a symbol)."
|
|
|
1513 (interactive
|
|
|
1514 (let* ((v (variable-at-point))
|
|
|
1515 (val (let ((enable-recursive-minibuffers t))
|
|
|
1516 (completing-read
|
|
|
1517 (if v
|
|
|
1518 (format "Describe variable (default %s): " v)
|
|
|
1519 (gettext "Describe variable: "))
|
|
430
|
1520 obarray 'boundp t nil 'variable-history
|
|
|
1521 (symbol-name v)))))
|
|
|
1522 (list (intern val))))
|
|
428
|
1523 (with-displaying-help-buffer
|
|
|
1524 (lambda ()
|
|
|
1525 (let ((origvar variable)
|
|
|
1526 aliases)
|
|
|
1527 (let ((print-escape-newlines t))
|
|
462
|
1528 (princ "`")
|
|
|
1529 ;; (Help-princ-face (symbol-name variable)
|
|
502
|
1530 ;; 'font-lock-variable-name-face) overkill
|
|
462
|
1531 (princ (symbol-name variable))
|
|
|
1532 (princ "' is ")
|
|
428
|
1533 (while (variable-alias variable)
|
|
|
1534 (let ((newvar (variable-alias variable)))
|
|
|
1535 (if aliases
|
|
|
1536 ;; I18N3 Need gettext due to concat
|
|
|
1537 (setq aliases
|
|
|
1538 (concat aliases
|
|
|
1539 (format "\n which is an alias for `%s',"
|
|
|
1540 (symbol-name newvar))))
|
|
|
1541 (setq aliases
|
|
|
1542 (format "an alias for `%s',"
|
|
|
1543 (symbol-name newvar))))
|
|
|
1544 (setq variable newvar)))
|
|
|
1545 (if aliases
|
|
|
1546 (princ (format "%s" aliases)))
|
|
|
1547 (princ (built-in-variable-doc variable))
|
|
|
1548 (princ ".\n")
|
|
|
1549 (let ((file-name (describe-symbol-find-file variable)))
|
|
|
1550 (if file-name
|
|
|
1551 (princ (format " -- loaded from \"%s\"\n" file-name))))
|
|
|
1552 (princ "\nValue: ")
|
|
464
|
1553 (require 'hyper-apropos)
|
|
|
1554 (if (not (boundp variable))
|
|
|
1555 (Help-princ-face "void\n" 'hyper-apropos-documentation)
|
|
|
1556 (Help-prin1-face (symbol-value variable)
|
|
|
1557 'hyper-apropos-documentation)
|
|
428
|
1558 (terpri))
|
|
|
1559 (terpri)
|
|
|
1560 (cond ((local-variable-p variable (current-buffer))
|
|
|
1561 (let* ((void (cons nil nil))
|
|
|
1562 (def (condition-case nil
|
|
|
1563 (default-value variable)
|
|
|
1564 (error void))))
|
|
|
1565 (princ "This value is specific to the current buffer.\n")
|
|
|
1566 (if (local-variable-p variable nil)
|
|
|
1567 (princ "(Its value is local to each buffer.)\n"))
|
|
|
1568 (terpri)
|
|
|
1569 (if (if (eq def void)
|
|
|
1570 (boundp variable)
|
|
|
1571 (not (eq (symbol-value variable) def)))
|
|
|
1572 ;; #### I18N3 doesn't localize properly!
|
|
|
1573 (progn (princ "Default-value: ")
|
|
|
1574 (if (eq def void)
|
|
|
1575 (princ "void\n")
|
|
|
1576 (prin1 def)
|
|
|
1577 (terpri))
|
|
|
1578 (terpri)))))
|
|
|
1579 ((local-variable-p variable (current-buffer) t)
|
|
|
1580 (princ "Setting it would make its value buffer-local.\n\n"))))
|
|
|
1581 (princ "Documentation:")
|
|
|
1582 (terpri)
|
|
|
1583 (let ((doc (documentation-property variable 'variable-documentation))
|
|
|
1584 (obsolete (variable-obsoleteness-doc origvar))
|
|
|
1585 (compatible (variable-compatibility-doc origvar)))
|
|
|
1586 (when obsolete
|
|
|
1587 (princ obsolete)
|
|
|
1588 (terpri)
|
|
|
1589 (terpri))
|
|
|
1590 (when compatible
|
|
|
1591 (princ compatible)
|
|
|
1592 (terpri)
|
|
|
1593 (terpri))
|
|
|
1594 ;; don't bother to print anything if variable is obsolete and aliased.
|
|
|
1595 (when (or (not obsolete) (not aliases))
|
|
|
1596 (if doc
|
|
|
1597 ;; note: documentation-property calls substitute-command-keys.
|
|
442
|
1598 (let ((oldp (point standard-output))
|
|
|
1599 newp)
|
|
|
1600 (princ doc)
|
|
|
1601 (setq newp (point standard-output))
|
|
|
1602 (goto-char oldp standard-output)
|
|
|
1603 (frob-help-extents standard-output)
|
|
|
1604 (goto-char newp standard-output))
|
|
428
|
1605 (princ "not documented as a variable."))))
|
|
|
1606 (terpri)))
|
|
|
1607 (format "variable `%s'" variable)))
|
|
|
1608
|
|
|
1609 (defun sorted-key-descriptions (keys &optional separator)
|
|
|
1610 "Sort and separate the key descriptions for KEYS.
|
|
|
1611 The sorting is done by length (shortest bindings first), and the bindings
|
|
|
1612 are separated with SEPARATOR (\", \" by default)."
|
|
|
1613 (mapconcat 'key-description
|
|
|
1614 (sort keys #'(lambda (x y)
|
|
|
1615 (< (length x) (length y))))
|
|
|
1616 (or separator ", ")))
|
|
|
1617
|
|
|
1618 (defun where-is (definition &optional insert)
|
|
|
1619 "Print message listing key sequences that invoke specified command.
|
|
|
1620 Argument is a command definition, usually a symbol with a function definition.
|
|
|
1621 When run interactively, it defaults to any function found by
|
|
|
1622 `function-at-point'.
|
|
|
1623 If INSERT (the prefix arg) is non-nil, insert the message in the buffer."
|
|
|
1624 (interactive
|
|
|
1625 (let ((fn (function-at-point))
|
|
|
1626 (enable-recursive-minibuffers t)
|
|
|
1627 val)
|
|
|
1628 (setq val (read-command
|
|
|
1629 (if fn (format "Where is command (default %s): " fn)
|
|
456
|
1630 "Where is command: ")
|
|
|
1631 (and fn (symbol-name fn))))
|
|
428
|
1632 (list (if (equal (symbol-name val) "")
|
|
|
1633 fn val)
|
|
|
1634 current-prefix-arg)))
|
|
|
1635 (let ((keys (where-is-internal definition)))
|
|
|
1636 (if keys
|
|
|
1637 (if insert
|
|
|
1638 (princ (format "%s (%s)" (sorted-key-descriptions keys)
|
|
|
1639 definition) (current-buffer))
|
|
|
1640 (message "%s is on %s" definition (sorted-key-descriptions keys)))
|
|
|
1641 (if insert
|
|
|
1642 (princ (format (if (commandp definition) "M-x %s RET"
|
|
|
1643 "M-: (%s ...)") definition) (current-buffer))
|
|
|
1644 (message "%s is not on any keys" definition))))
|
|
|
1645 nil)
|
|
|
1646
|
|
|
1647 ;; `locate-library' moved to "packages.el"
|
|
|
1648
|
|
|
1649
|
|
|
1650 ;; Functions ported from C into Lisp in XEmacs
|
|
|
1651
|
|
|
1652 (defun describe-syntax ()
|
|
|
1653 "Describe the syntax specifications in the syntax table.
|
|
|
1654 The descriptions are inserted in a buffer, which is then displayed."
|
|
|
1655 (interactive)
|
|
|
1656 (with-displaying-help-buffer
|
|
|
1657 (lambda ()
|
|
|
1658 ;; defined in syntax.el
|
|
|
1659 (describe-syntax-table (syntax-table) standard-output))
|
|
|
1660 (format "syntax-table for %s" major-mode)))
|
|
|
1661
|
|
|
1662 (defun list-processes ()
|
|
|
1663 "Display a list of all processes.
|
|
|
1664 \(Any processes listed as Exited or Signaled are actually eliminated
|
|
|
1665 after the listing is made.)"
|
|
|
1666 (interactive)
|
|
|
1667 (with-output-to-temp-buffer "*Process List*"
|
|
|
1668 (set-buffer standard-output)
|
|
|
1669 (buffer-disable-undo standard-output)
|
|
|
1670 (make-local-variable 'truncate-lines)
|
|
|
1671 (setq truncate-lines t)
|
|
|
1672 ;; 00000000001111111111222222222233333333334444444444
|
|
|
1673 ;; 01234567890123456789012345678901234567890123456789
|
|
|
1674 ;; rewritten for I18N3. This one should stay rewritten
|
|
|
1675 ;; so that the dashes will line up properly.
|
|
|
1676 (princ "Proc Status Buffer Tty Command\n---- ------ ------ --- -------\n")
|
|
|
1677 (let ((tail (process-list)))
|
|
|
1678 (while tail
|
|
|
1679 (let* ((p (car tail))
|
|
|
1680 (pid (process-id p))
|
|
|
1681 (s (process-status p)))
|
|
|
1682 (setq tail (cdr tail))
|
|
|
1683 (princ (format "%-13s" (process-name p)))
|
|
|
1684 (princ s)
|
|
|
1685 (if (and (eq s 'exit) (/= (process-exit-status p) 0))
|
|
|
1686 (princ (format " %d" (process-exit-status p))))
|
|
|
1687 (if (memq s '(signal exit closed))
|
|
|
1688 ;; Do delete-exited-processes' work
|
|
|
1689 (delete-process p))
|
|
|
1690 (indent-to 22 1) ;####
|
|
|
1691 (let ((b (process-buffer p)))
|
|
|
1692 (cond ((not b)
|
|
|
1693 (princ "(none)"))
|
|
|
1694 ((not (buffer-name b))
|
|
|
1695 (princ "(killed)"))
|
|
|
1696 (t
|
|
|
1697 (princ (buffer-name b)))))
|
|
|
1698 (indent-to 37 1) ;####
|
|
|
1699 (let ((tn (process-tty-name p)))
|
|
|
1700 (cond ((not tn)
|
|
|
1701 (princ "(none)"))
|
|
|
1702 (t
|
|
|
1703 (princ (format "%s" tn)))))
|
|
|
1704 (indent-to 49 1) ;####
|
|
|
1705 (if (not (integerp pid))
|
|
|
1706 (progn
|
|
|
1707 (princ "network stream connection ")
|
|
|
1708 (princ (car pid))
|
|
|
1709 (princ "@")
|
|
|
1710 (princ (cdr pid)))
|
|
|
1711 (let ((cmd (process-command p)))
|
|
|
1712 (while cmd
|
|
|
1713 (princ (car cmd))
|
|
|
1714 (setq cmd (cdr cmd))
|
|
|
1715 (if cmd (princ " ")))))
|
|
|
1716 (terpri))))))
|
|
|
1717
|
|
440
|
1718 ;; Stop gap for 21.0 until we do help-char etc properly.
|
|
428
|
1719 (defun help-keymap-with-help-key (keymap form)
|
|
|
1720 "Return a copy of KEYMAP with an help-key binding according to help-char
|
|
|
1721 invoking FORM like help-form. An existing binding is not overridden.
|
|
|
1722 If FORM is nil then no binding is made."
|
|
|
1723 (let ((map (copy-keymap keymap))
|
|
|
1724 (key (if (characterp help-char)
|
|
|
1725 (vector (character-to-event help-char))
|
|
|
1726 help-char)))
|
|
|
1727 (when (and form key (not (lookup-key map key)))
|
|
|
1728 (define-key map key
|
|
|
1729 `(lambda () (interactive) (help-print-help-form ,form))))
|
|
|
1730 map))
|
|
|
1731
|
|
|
1732 (defun help-print-help-form (form)
|
|
|
1733 (let ((string (eval form)))
|
|
|
1734 (if (stringp string)
|
|
|
1735 (with-displaying-help-buffer
|
|
|
1736 (insert string)))))
|
|
|
1737
|
|
|
1738 ;;; help.el ends here
|
