|
0
|
1 ;;; help.el --- help commands for XEmacs.
|
|
|
2 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994 Free Software Foundation, Inc.
|
|
|
3
|
|
|
4 ;; Maintainer: FSF
|
|
|
5 ;; Keywords: help, internal
|
|
|
6
|
|
|
7 ;; This file is part of XEmacs.
|
|
|
8
|
|
|
9 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
10 ;; under the terms of the GNU General Public License as published by
|
|
|
11 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
12 ;; any later version.
|
|
|
13
|
|
|
14 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
17 ;; General Public License for more details.
|
|
|
18
|
|
|
19 ;; You should have received a copy of the GNU General Public License
|
|
16
|
20 ;; along with XEmacs; see the file COPYING. If not, write to the
|
|
70
|
21 ;; Free Software Foundation, 59 Temple Place - Suite 330,
|
|
16
|
22 ;; Boston, MA 02111-1307, USA.
|
|
0
|
23
|
|
|
24 ;;; Synched up with: FSF 19.30.
|
|
|
25
|
|
|
26 ;;; Commentary:
|
|
|
27
|
|
|
28 ;; This code implements XEmacs's on-line help system, the one invoked by
|
|
|
29 ;;`M-x help-for-help'.
|
|
|
30
|
|
|
31 ;;; Code:
|
|
|
32
|
|
|
33 ;#### FSFmacs
|
|
|
34 ;; Get the macro make-help-screen when this is compiled,
|
|
|
35 ;; or run interpreted, but not when the compiled code is loaded.
|
|
|
36 ;(eval-when-compile (require 'help-macro))
|
|
|
37
|
|
120
|
38 (defgroup help-appearance nil
|
|
|
39 "Appearance of help buffers"
|
|
|
40 :group 'help)
|
|
|
41
|
|
0
|
42 (defvar help-map (let ((map (make-sparse-keymap)))
|
|
|
43 (set-keymap-name map 'help-map)
|
|
|
44 (set-keymap-prompt
|
|
|
45 map (purecopy (gettext "(Type ? for further options)")))
|
|
|
46 map)
|
|
|
47 "Keymap for characters following the Help key.")
|
|
|
48
|
|
|
49 ;; global-map definitions moved to keydefs.el
|
|
|
50 (fset 'help-command help-map)
|
|
|
51
|
|
98
|
52 (define-key help-map (vector help-char) 'help-for-help)
|
|
0
|
53 (define-key help-map "?" 'help-for-help)
|
|
|
54 (define-key help-map 'help 'help-for-help)
|
|
|
55
|
|
|
56 (define-key help-map "\C-l" 'describe-copying) ; on \C-c in FSFmacs
|
|
|
57 (define-key help-map "\C-d" 'describe-distribution)
|
|
|
58 (define-key help-map "\C-w" 'describe-no-warranty)
|
|
|
59 (define-key help-map "a" 'hyper-apropos) ; 'command-apropos in FSFmacs
|
|
|
60 (define-key help-map "A" 'command-apropos)
|
|
|
61
|
|
|
62 (define-key help-map "b" 'describe-bindings)
|
|
108
|
63 (define-key help-map "B" 'describe-beta)
|
|
0
|
64 (define-key help-map "\C-p" 'describe-pointer)
|
|
|
65
|
|
|
66 (define-key help-map "c" 'describe-key-briefly)
|
|
|
67 (define-key help-map "k" 'describe-key)
|
|
|
68
|
|
|
69 (define-key help-map "d" 'describe-function)
|
|
|
70 (define-key help-map "e" 'describe-last-error)
|
|
|
71 (define-key help-map "f" 'describe-function)
|
|
|
72
|
|
|
73 (define-key help-map "F" 'xemacs-local-faq)
|
|
|
74
|
|
|
75 ;;; Setup so Hyperbole can be autoloaded from a key.
|
|
|
76 ;;; Choose a key on which to place the Hyperbole menus.
|
|
|
77 ;;; For most people this key binding will work and will be equivalent
|
|
|
78 ;;; to {C-h h}.
|
|
|
79 ;;;
|
|
|
80 (or (where-is-internal 'hyperbole)
|
|
|
81 (where-is-internal 'hui:menu)
|
|
|
82 (define-key help-map "h" 'hyperbole))
|
|
|
83 (autoload 'hyperbole "hsite" "Hyperbole info manager menus." t)
|
|
|
84
|
|
|
85 (define-key help-map "i" 'info)
|
|
|
86 (define-key help-map '(control i) 'Info-query)
|
|
|
87 ;; FSFmacs has Info-goto-emacs-command-node on C-f, no binding
|
|
|
88 ;; for Info-elisp-ref
|
|
|
89 (define-key help-map '(control c) 'Info-goto-emacs-command-node)
|
|
|
90 (define-key help-map '(control k) 'Info-goto-emacs-key-command-node)
|
|
|
91 (define-key help-map '(control f) 'Info-elisp-ref)
|
|
|
92
|
|
|
93 (define-key help-map "l" 'view-lossage)
|
|
|
94
|
|
|
95 (define-key help-map "m" 'describe-mode)
|
|
|
96
|
|
|
97 (define-key help-map "\C-n" 'view-emacs-news)
|
|
|
98 (define-key help-map "n" 'view-emacs-news)
|
|
|
99
|
|
|
100 (define-key help-map "p" 'finder-by-keyword)
|
|
|
101 (autoload 'finder-by-keyword "finder"
|
|
|
102 "Find packages matching a given keyword." t)
|
|
|
103
|
|
|
104 (define-key help-map "s" 'describe-syntax)
|
|
|
105
|
|
|
106 (define-key help-map "t" 'help-with-tutorial)
|
|
|
107
|
|
|
108 (define-key help-map "w" 'where-is)
|
|
|
109
|
|
|
110 (define-key help-map "v" 'describe-variable)
|
|
|
111
|
|
|
112 (if (fboundp 'view-last-error)
|
|
|
113 (define-key help-map "e" 'view-last-error))
|
|
|
114
|
|
|
115
|
|
|
116 (define-key help-map "q" 'help-quit)
|
|
|
117
|
|
|
118 ;#### This stuff was an attempt to have font locking and hyperlinks in the
|
|
|
119 ;help buffer, but it doesn't really work. Some of this stuff comes from
|
|
|
120 ;FSF Emacs; but the FSF Emacs implementation is rather broken, as usual.
|
|
|
121 ;What needs to happen is this:
|
|
|
122 ;
|
|
|
123 ; -- we probably need a "hyperlink mode" from which help-mode is derived.
|
|
|
124 ; -- this means we probably need multiple inheritance of modes!
|
|
|
125 ; Thankfully this is not hard to implement; we already have the
|
|
|
126 ; ability for a keymap to have multiple parents. However, we'd
|
|
|
127 ; have to define any multiply-inherited-from modes using a standard
|
|
|
128 ; `define-mode' construction instead of manually doing it, because
|
|
|
129 ; we don't want each guy calling `kill-all-local-variables' and
|
|
|
130 ; messing up the previous one.
|
|
|
131 ; -- we need to scan the buffer ourselves (not from font-lock, because
|
|
|
132 ; the user might not have font-lock enabled) and highlight only
|
|
|
133 ; those words that are *documented* functions and variables (and
|
|
|
134 ; probably excluding words without dashes in them unless enclosed
|
|
|
135 ; in quotes, so that common words like "list" and "point" don't
|
|
|
136 ; become hyperlinks.
|
|
|
137 ; -- we should *not* use font-lock keywords like below. Instead we
|
|
|
138 ; should add the font-lock stuff ourselves during the scanning phase,
|
|
|
139 ; if font-lock is enabled in this buffer.
|
|
|
140
|
|
|
141 ;(defun help-follow-reference (event extent user-data)
|
|
|
142 ; (let ((symbol (intern-soft (extent-string extent))))
|
|
|
143 ; (cond ((and symbol (fboundp symbol))
|
|
|
144 ; (describe-function symbol))
|
|
|
145 ; ((and symbol (boundp symbol))
|
|
|
146 ; (describe-variable symbol))
|
|
|
147 ; (t nil))))
|
|
|
148
|
|
|
149 ;(defvar help-font-lock-keywords
|
|
|
150 ; (let ((name-char "[-+a-zA-Z0-9_*]") (sym-char "[-+a-zA-Z0-9_:*]"))
|
|
|
151 ; (list
|
|
|
152 ; ;;
|
|
|
153 ; ;; The symbol itself.
|
|
|
154 ; (list (concat "\\`\\(" name-char "+\\)\\(:\\)?")
|
|
|
155 ; '(1 (if (match-beginning 2)
|
|
|
156 ; 'font-lock-function-name-face
|
|
|
157 ; 'font-lock-variable-name-face)
|
|
|
158 ; nil t))
|
|
|
159 ; ;;
|
|
|
160 ; ;; Words inside `' which tend to be symbol names.
|
|
|
161 ; (list (concat "`\\(" sym-char sym-char "+\\)'")
|
|
|
162 ; 1 '(prog1
|
|
|
163 ; 'font-lock-reference-face
|
|
|
164 ; (add-list-mode-item (match-beginning 1)
|
|
|
165 ; (match-end 1)
|
|
|
166 ; nil
|
|
|
167 ; 'help-follow-reference))
|
|
|
168 ; t)
|
|
|
169 ; ;;
|
|
|
170 ; ;; CLisp `:' keywords as references.
|
|
|
171 ; (list (concat "\\<:" sym-char "+\\>") 0 'font-lock-reference-face t)))
|
|
|
172 ; "Default expressions to highlight in Help mode.")
|
|
|
173
|
|
|
174 ;(put 'help-mode 'font-lock-defaults '(help-font-lock-keywords))
|
|
|
175
|
|
|
176 (define-derived-mode help-mode view-major-mode "Help"
|
|
|
177 "Major mode for viewing help text.
|
|
|
178 Entry to this mode runs the normal hook `help-mode-hook'.
|
|
|
179 Commands:
|
|
|
180 \\{help-mode-map}"
|
|
|
181 )
|
|
|
182
|
|
|
183 (define-key help-mode-map "q" 'help-mode-quit)
|
|
|
184
|
|
|
185 (defun help-mode-quit ()
|
|
80
|
186 "Exits from help mode, possibly restoring the previous window configuration."
|
|
0
|
187 (interactive)
|
|
114
|
188 (cond ((frame-property (selected-frame) 'help-window-config)
|
|
|
189 (set-window-configuration
|
|
|
190 (frame-property (selected-frame) 'help-window-config))
|
|
|
191 (set-frame-property (selected-frame) 'help-window-config nil))
|
|
0
|
192 ((one-window-p)
|
|
|
193 (bury-buffer))
|
|
|
194 (t
|
|
|
195 (delete-window))))
|
|
|
196
|
|
|
197 (defun help-quit ()
|
|
|
198 (interactive)
|
|
|
199 nil)
|
|
|
200
|
|
|
201 ;; This is a grody hack of the same genotype as `advertised-undo'; if the
|
|
|
202 ;; bindings of Backspace and C-h are the same, we want the menubar to claim
|
|
|
203 ;; that `info' in invoked with `C-h i', not `BS i'.
|
|
|
204
|
|
|
205 (defun deprecated-help-command ()
|
|
|
206 (interactive)
|
|
|
207 (if (eq 'help-command (key-binding "\C-h"))
|
|
|
208 (setq unread-command-event (character-to-event ?\C-h))
|
|
|
209 (help-for-help)))
|
|
|
210
|
|
|
211 ;;(define-key global-map 'backspace 'deprecated-help-command)
|
|
|
212
|
|
|
213 ;; TUTORIAL arg is XEmacs addition
|
|
|
214 (defun help-with-tutorial (&optional tutorial)
|
|
|
215 "Select the XEmacs learn-by-doing tutorial.
|
|
|
216 Optional arg TUTORIAL specifies the tutorial file; default is \"TUTORIAL\"."
|
|
|
217 (interactive)
|
|
|
218 (if (null tutorial)
|
|
|
219 (setq tutorial "TUTORIAL"))
|
|
|
220 (let ((file (expand-file-name (concat "~/" tutorial))))
|
|
|
221 (delete-other-windows)
|
|
|
222 (if (get-file-buffer file)
|
|
|
223 (switch-to-buffer (get-file-buffer file))
|
|
|
224 (switch-to-buffer (create-file-buffer file))
|
|
|
225 (setq buffer-file-name file)
|
|
|
226 (setq default-directory (expand-file-name "~/"))
|
|
|
227 (setq buffer-auto-save-file-name nil)
|
|
|
228 (insert-file-contents (expand-file-name tutorial data-directory))
|
|
|
229 (goto-char (point-min))
|
|
|
230 (search-forward "\n<<")
|
|
|
231 (beginning-of-line)
|
|
|
232 (delete-region (point) (progn (end-of-line) (point)))
|
|
|
233 (let ((n (- (window-height (selected-window))
|
|
|
234 (count-lines (point-min) (point))
|
|
|
235 6)))
|
|
|
236 (if (< n 12)
|
|
|
237 (newline n)
|
|
|
238 ;; Some people get confused by the large gap.
|
|
|
239 (newline (/ n 2))
|
|
|
240 (insert "[Middle of page left blank for didactic purposes. "
|
|
|
241 "Text continues below]")
|
|
|
242 (newline (- n (/ n 2)))))
|
|
|
243 (goto-char (point-min))
|
|
|
244 (set-buffer-modified-p nil))))
|
|
|
245
|
|
|
246 ;; used by describe-key and describe-key-briefly
|
|
|
247
|
|
|
248 (defun key-or-menu-binding (key &optional menu-flag)
|
|
|
249 ;; KEY is any value returned by next-command-event
|
|
|
250 ;; MENU-FLAG is a symbol that should be set to T if KEY is a menu event,
|
|
|
251 ;; or NIL otherwise
|
|
|
252 (let (defn)
|
|
|
253 (and menu-flag (set menu-flag nil))
|
|
|
254 ;; If the key typed was really a menu selection, grab the form out
|
|
|
255 ;; of the event object and intuit the function that would be called,
|
|
|
256 ;; and describe that instead.
|
|
|
257 (if (and (vectorp key) (= 1 (length key))
|
|
|
258 (or (misc-user-event-p (aref key 0))
|
|
|
259 (eq (car-safe (aref key 0)) 'menu-selection)))
|
|
|
260 (let ((event (aref key 0)))
|
|
|
261 (setq defn (if (eventp event)
|
|
|
262 (list (event-function event) (event-object event))
|
|
|
263 (cdr event)))
|
|
|
264 (and menu-flag (set menu-flag t))
|
|
|
265 (if (eq (car defn) 'eval)
|
|
|
266 (setq defn (car (cdr defn))))
|
|
|
267 (if (eq (car-safe defn) 'call-interactively)
|
|
|
268 (setq defn (car (cdr defn))))
|
|
|
269 (if (and (consp defn) (null (cdr defn)))
|
|
|
270 (setq defn (car defn))))
|
|
|
271 ;; else
|
|
|
272 (setq defn (key-binding key)))
|
|
|
273 ;; kludge: if a toolbar button was pressed on, try to find the
|
|
|
274 ;; binding of the toolbar button.
|
|
|
275 (if (and (eq defn 'press-toolbar-button)
|
|
|
276 (vectorp key)
|
|
|
277 (button-press-event-p (aref key (1- (length key)))))
|
|
|
278 ;; wait for the button release. We're on shaky ground here ...
|
|
|
279 (let ((event (next-command-event))
|
|
|
280 button)
|
|
|
281 (if (and (button-release-event-p event)
|
|
|
282 (event-over-toolbar-p event)
|
|
|
283 (eq 'release-and-activate-toolbar-button
|
|
|
284 (key-binding (vector event)))
|
|
|
285 (setq button (event-toolbar-button event)))
|
|
|
286 (toolbar-button-callback button)
|
|
|
287 ;; if anything went wrong, try returning the binding of
|
|
|
288 ;; the button-up event, of the original binding
|
|
|
289 (or (key-or-menu-binding (vector event))
|
|
|
290 defn)))
|
|
|
291 ;; no toolbar kludge
|
|
|
292 defn)
|
|
|
293 ))
|
|
|
294
|
|
|
295 (defun describe-key-briefly (key)
|
|
|
296 "Print the name of the function KEY invokes. KEY is a string."
|
|
|
297 (interactive "kDescribe key briefly: ")
|
|
|
298 (let (defn menup)
|
|
|
299 (setq defn (key-or-menu-binding key 'menup))
|
|
|
300 (if (or (null defn) (integerp defn))
|
|
|
301 (message "%s is undefined" (key-description key))
|
|
|
302 ;; If it's a keyboard macro which trivially invokes another command,
|
|
|
303 ;; document that instead.
|
|
|
304 (if (or (stringp defn) (vectorp defn))
|
|
|
305 (setq defn (or (key-binding defn)
|
|
|
306 defn)))
|
|
|
307 (let ((last-event (and (vectorp key)
|
|
|
308 (aref key (1- (length key))))))
|
|
|
309 (message (if (or (button-press-event-p last-event)
|
|
|
310 (button-release-event-p last-event))
|
|
|
311 (gettext "%s at that spot runs the command %s")
|
|
|
312 (gettext "%s runs the command %s"))
|
|
|
313 ;; This used to say 'This menu item' but it could also
|
|
|
314 ;; be a scrollbar event. We can't distinguish at the
|
|
|
315 ;; moment.
|
|
|
316 (if menup "This item" (key-description key))
|
|
|
317 (if (symbolp defn) defn (prin1-to-string defn)))))))
|
|
|
318
|
|
|
319 ;; #### this is a horrible piece of shit function that should
|
|
|
320 ;; not exist. In FSF 19.30 this function has gotten three times
|
|
|
321 ;; as long and has tons and tons of dumb shit checking
|
|
|
322 ;; special-display-buffer-names and such crap. I absolutely
|
|
|
323 ;; refuse to insert that Ebolification here. I wanted to delete
|
|
|
324 ;; this function entirely but Mly bitched.
|
|
|
325 ;;
|
|
|
326 ;; If your user-land code calls this function, rewrite it to
|
|
|
327 ;; call with-displaying-help-buffer.
|
|
|
328
|
|
|
329 (defun print-help-return-message (&optional function)
|
|
|
330 "Display or return message saying how to restore windows after help command.
|
|
|
331 Computes a message and applies the optional argument FUNCTION to it.
|
|
|
332 If FUNCTION is nil, applies `message' to it, thus printing it."
|
|
|
333 (and (not (get-buffer-window standard-output))
|
|
|
334 (funcall
|
|
|
335 (or function 'message)
|
|
|
336 (concat
|
|
|
337 (substitute-command-keys
|
|
|
338 (if (one-window-p t)
|
|
|
339 (if pop-up-windows
|
|
|
340 (gettext "Type \\[delete-other-windows] to remove help window.")
|
|
|
341 (gettext "Type \\[switch-to-buffer] RET to remove help window."))
|
|
|
342 (gettext "Type \\[switch-to-buffer-other-window] RET to restore the other window.")))
|
|
|
343 (substitute-command-keys
|
|
|
344 (gettext " \\[scroll-other-window] to scroll the help."))))))
|
|
|
345
|
|
120
|
346 (defcustom help-selects-help-window t
|
|
0
|
347 "*If nil, use the \"old Emacs\" behavior for Help buffers.
|
|
|
348 This just displays the buffer in another window, rather than selecting
|
|
120
|
349 the window."
|
|
|
350 :type 'boolean
|
|
|
351 :group 'help-appearance)
|
|
0
|
352
|
|
|
353 ;; Use this function for displaying help when C-h something is pressed
|
|
|
354 ;; or in similar situations. Do *not* use it when you are displaying
|
|
|
355 ;; a help message and then prompting for input in the minibuffer --
|
|
|
356 ;; this macro usually selects the help buffer, which is not what you
|
|
|
357 ;; want in those situations.
|
|
2
|
358
|
|
|
359 ;;; ### Should really be a macro (as suggested above) to eliminate the
|
|
|
360 ;;; requirement of caller to code a lambda form in THUNK -- mrb
|
|
0
|
361 (defun with-displaying-help-buffer (thunk)
|
|
|
362 (let ((winconfig (current-window-configuration))
|
|
114
|
363 (was-one-window (one-window-p))
|
|
|
364 (help-not-visible
|
|
|
365 (not (and (windows-of-buffer "*Help*") ;shortcut
|
|
|
366 (member (selected-frame)
|
|
|
367 (mapcar 'window-frame
|
|
|
368 (windows-of-buffer "*Help*")))))))
|
|
0
|
369 (prog1 (with-output-to-temp-buffer "*Help*"
|
|
|
370 (prog1 (funcall thunk)
|
|
|
371 (save-excursion
|
|
|
372 (set-buffer standard-output)
|
|
|
373 (help-mode))))
|
|
|
374 (let ((helpwin (get-buffer-window "*Help*")))
|
|
|
375 (if helpwin
|
|
|
376 (progn
|
|
|
377 (save-excursion
|
|
|
378 (set-buffer (window-buffer helpwin))
|
|
114
|
379 ;;If the *Help* buffer is already displayed on this
|
|
|
380 ;; frame, don't override the previous configuration
|
|
|
381 (if help-not-visible
|
|
|
382 (set-frame-property (selected-frame)
|
|
|
383 'help-window-config winconfig)))
|
|
0
|
384 (if help-selects-help-window
|
|
|
385 (select-window helpwin))
|
|
|
386 (cond ((eq helpwin (selected-window))
|
|
|
387 (message
|
|
|
388 (substitute-command-keys "Type \\[help-mode-quit] to remove help window, \\[scroll-up] to scroll the help.")))
|
|
|
389 (was-one-window
|
|
|
390 (message
|
|
|
391 (substitute-command-keys "Type \\[delete-other-windows] to remove help window, \\[scroll-other-window] to scroll the help.")))
|
|
|
392 (t
|
|
|
393 (message
|
|
116
|
394 (substitute-command-keys "Type \\[switch-to-buffer-other-window] to restore the other window, \\[scroll-other-window] to scroll the help."))))))))))
|
|
0
|
395
|
|
|
396 (defun describe-key (key)
|
|
|
397 "Display documentation of the function invoked by KEY.
|
|
|
398 KEY is a string, or vector of events.
|
|
108
|
399 When called interactively, KEY may also be a menu selection."
|
|
0
|
400 (interactive "kDescribe key: ")
|
|
|
401 (let ((defn (key-or-menu-binding key)))
|
|
|
402 (if (or (null defn) (integerp defn))
|
|
|
403 (message "%s is undefined" (key-description key))
|
|
|
404 (with-displaying-help-buffer
|
|
|
405 (lambda ()
|
|
|
406 ; (princ (key-description key))
|
|
|
407 ; (princ " runs the command ")
|
|
|
408 (prin1 defn)
|
|
|
409 (princ ":\n")
|
|
|
410 (cond ((or (stringp defn) (vectorp defn))
|
|
|
411 (let ((cmd (key-binding defn)))
|
|
|
412 (if (not cmd)
|
|
|
413 (princ "a keyboard macro")
|
|
|
414 (progn
|
|
|
415 (princ (format "a keyboard macro which runs the command %s:\n\n"
|
|
|
416 cmd))
|
|
|
417 (princ cmd)
|
|
|
418 (princ "\n")
|
|
|
419 (if (documentation cmd) (princ (documentation cmd)))))))
|
|
|
420 ((and (consp defn) (not (eq 'lambda (car-safe defn))))
|
|
|
421 (princ "\n")
|
|
|
422 (let ((describe-function-show-arglist nil))
|
|
|
423 (describe-function-1 (car defn) standard-output)))
|
|
|
424 ((documentation defn)
|
|
|
425 (princ (documentation defn)))
|
|
|
426 (t
|
|
|
427 (princ "not documented"))))))))
|
|
|
428
|
|
|
429 (defun describe-mode ()
|
|
|
430 "Display documentation of current major mode and minor modes.
|
|
|
431 For this to work correctly for a minor mode, the mode's indicator variable
|
|
|
432 \(listed in `minor-mode-alist') must also be a function whose documentation
|
|
|
433 describes the minor mode."
|
|
|
434 (interactive)
|
|
|
435 (with-displaying-help-buffer
|
|
|
436 (lambda ()
|
|
|
437 ;; XEmacs change: print the major-mode documentation before
|
|
|
438 ;; the minor modes.
|
|
|
439 (princ mode-name)
|
|
|
440 (princ " mode:\n")
|
|
|
441 (princ (documentation major-mode))
|
|
|
442 (princ "\n\n----\n\n")
|
|
|
443 (let ((minor-modes minor-mode-alist))
|
|
|
444 (while minor-modes
|
|
|
445 (let* ((minor-mode (car (car minor-modes)))
|
|
|
446 (indicator (car (cdr (car minor-modes)))))
|
|
|
447 ;; Document a minor mode if it is listed in minor-mode-alist,
|
|
|
448 ;; bound locally in this buffer, non-nil, and has a function
|
|
|
449 ;; definition.
|
|
|
450 (if (and (boundp minor-mode)
|
|
|
451 (symbol-value minor-mode)
|
|
|
452 (fboundp minor-mode))
|
|
|
453 (let ((pretty-minor-mode minor-mode))
|
|
|
454 (if (string-match "-mode\\'" (symbol-name minor-mode))
|
|
|
455 (setq pretty-minor-mode
|
|
|
456 (capitalize
|
|
|
457 (substring (symbol-name minor-mode)
|
|
|
458 0 (match-beginning 0)))))
|
|
|
459 (while (and (consp indicator) (extentp (car indicator)))
|
|
|
460 (setq indicator (cdr indicator)))
|
|
|
461 (while (and indicator (symbolp indicator))
|
|
|
462 (setq indicator (symbol-value indicator)))
|
|
|
463 (princ (format "%s minor mode (indicator%s):\n"
|
|
|
464 pretty-minor-mode indicator))
|
|
|
465 (princ (documentation minor-mode))
|
|
|
466 (princ "\n\n----\n\n"))))
|
|
|
467 (setq minor-modes (cdr minor-modes)))))))
|
|
|
468
|
|
|
469 ;; So keyboard macro definitions are documented correctly
|
|
|
470 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
|
|
|
471
|
|
|
472 (defun describe-distribution ()
|
|
|
473 "Display info on how to obtain the latest version of XEmacs."
|
|
|
474 (interactive)
|
|
|
475 (find-file-read-only
|
|
|
476 (expand-file-name "DISTRIB" data-directory)))
|
|
|
477
|
|
108
|
478 (defun describe-beta ()
|
|
|
479 "Display info on how to deal with Beta versions of XEmacs."
|
|
|
480 (interactive)
|
|
|
481 (find-file-read-only
|
|
|
482 (expand-file-name "BETA" data-directory))
|
|
|
483 (goto-char (point-min)))
|
|
|
484
|
|
0
|
485 (defun describe-copying ()
|
|
|
486 "Display info on how you may redistribute copies of XEmacs."
|
|
|
487 (interactive)
|
|
|
488 (find-file-read-only
|
|
|
489 (expand-file-name "COPYING" data-directory))
|
|
|
490 (goto-char (point-min)))
|
|
|
491
|
|
|
492 (defun describe-pointer ()
|
|
|
493 "Show a list of all defined mouse buttons, and their definitions."
|
|
|
494 (interactive)
|
|
|
495 (describe-bindings nil t))
|
|
|
496
|
|
|
497 (defun describe-project ()
|
|
|
498 "Display info on the GNU project."
|
|
|
499 (interactive)
|
|
|
500 (find-file-read-only
|
|
|
501 (expand-file-name "GNU" data-directory))
|
|
|
502 (goto-char (point-min)))
|
|
|
503
|
|
|
504 (defun describe-no-warranty ()
|
|
|
505 "Display info on all the kinds of warranty XEmacs does NOT have."
|
|
|
506 (interactive)
|
|
|
507 (describe-copying)
|
|
|
508 (let (case-fold-search)
|
|
|
509 (search-forward "NO WARRANTY")
|
|
|
510 (recenter 0)))
|
|
|
511
|
|
|
512 (defun describe-bindings (&optional prefix mouse-only-p)
|
|
|
513 "Show a list of all defined keys, and their definitions.
|
|
|
514 The list is put in a buffer, which is displayed.
|
|
|
515 If the optional argument PREFIX is supplied, only commands which
|
|
|
516 start with that sequence of keys are described.
|
|
|
517 If the second argument (prefix arg, interactively) is non-null
|
|
|
518 then only the mouse bindings are displayed."
|
|
|
519 (interactive (list nil current-prefix-arg))
|
|
|
520 (with-displaying-help-buffer
|
|
|
521 (lambda ()
|
|
|
522 (describe-bindings-1 prefix mouse-only-p))))
|
|
|
523
|
|
|
524 (defun describe-bindings-1 (&optional prefix mouse-only-p)
|
|
|
525 (let ((heading (if mouse-only-p
|
|
|
526 (gettext "button binding\n------ -------\n")
|
|
|
527 (gettext "key binding\n--- -------\n")))
|
|
|
528 (buffer (current-buffer))
|
|
|
529 (minor minor-mode-map-alist)
|
|
|
530 (local (current-local-map))
|
|
|
531 (shadow '()))
|
|
|
532 (set-buffer standard-output)
|
|
|
533 (while minor
|
|
|
534 (let ((sym (car (car minor)))
|
|
|
535 (map (cdr (car minor))))
|
|
|
536 (if (symbol-value-in-buffer sym buffer nil)
|
|
|
537 (progn
|
|
|
538 (insert (format "Minor Mode Bindings for `%s':\n"
|
|
|
539 sym)
|
|
|
540 heading)
|
|
|
541 (describe-bindings-internal map nil shadow prefix mouse-only-p)
|
|
|
542 (insert "\n")
|
|
|
543 (setq shadow (cons map shadow))))
|
|
|
544 (setq minor (cdr minor))))
|
|
|
545 (if local
|
|
|
546 (progn
|
|
|
547 (insert "Local Bindings:\n" heading)
|
|
|
548 (describe-bindings-internal local nil shadow prefix mouse-only-p)
|
|
|
549 (insert "\n")
|
|
|
550 (setq shadow (cons local shadow))))
|
|
|
551 (insert "Global Bindings:\n" heading)
|
|
|
552 (describe-bindings-internal (current-global-map)
|
|
|
553 nil shadow prefix mouse-only-p)
|
|
|
554 (set-buffer buffer)))
|
|
|
555
|
|
|
556 (defun describe-prefix-bindings ()
|
|
|
557 "Describe the bindings of the prefix used to reach this command.
|
|
|
558 The prefix described consists of all but the last event
|
|
|
559 of the key sequence that ran this command."
|
|
|
560 (interactive)
|
|
|
561 (let* ((key (this-command-keys))
|
|
|
562 (prefix (make-vector (1- (length key)) nil))
|
|
|
563 i)
|
|
|
564 (setq i 0)
|
|
|
565 (while (< i (length prefix))
|
|
|
566 (aset prefix i (aref key i))
|
|
|
567 (setq i (1+ i)))
|
|
|
568 (with-displaying-help-buffer
|
|
|
569 (lambda ()
|
|
|
570 (princ "Key bindings starting with ")
|
|
|
571 (princ (key-description prefix))
|
|
|
572 (princ ":\n\n")
|
|
|
573 (describe-bindings-1 prefix nil)))))
|
|
|
574
|
|
|
575 ;; Make C-h after a prefix, when not specifically bound,
|
|
|
576 ;; run describe-prefix-bindings.
|
|
|
577 (setq prefix-help-command 'describe-prefix-bindings)
|
|
|
578
|
|
|
579 (defun view-emacs-news ()
|
|
|
580 "Display info on recent changes to XEmacs."
|
|
|
581 (interactive)
|
|
|
582 (require 'outl-mouse)
|
|
|
583 (find-file (expand-file-name "NEWS" data-directory)))
|
|
|
584
|
|
|
585 (defun xemacs-www-page ()
|
|
|
586 "Go to the XEmacs World Wide Web page."
|
|
|
587 (interactive)
|
|
|
588 (funcall browse-url-browser-function "http://www.xemacs.org/"))
|
|
|
589
|
|
|
590 (defun xemacs-www-faq ()
|
|
|
591 "View the latest and greatest XEmacs FAQ using the World Wide Web."
|
|
|
592 (interactive)
|
|
|
593 (funcall browse-url-browser-function "http://www.xemacs.org/faq/index.html"))
|
|
|
594
|
|
|
595 (defun xemacs-local-faq ()
|
|
|
596 "View the local copy of the XEmacs FAQ.
|
|
|
597 If you have access to the World Wide Web, you should use `xemacs-www-faq'
|
|
|
598 instead, to ensure that you get the most up-to-date information."
|
|
|
599 (interactive)
|
|
|
600 (save-window-excursion
|
|
|
601 (info)
|
|
|
602 (Info-find-node "xemacs-faq" "Top"))
|
|
|
603 (switch-to-buffer "*info*"))
|
|
|
604
|
|
153
|
605 (defcustom view-lossage-key-count 100
|
|
|
606 "*Number of keys `view-lossage' shows.
|
|
|
607 The maximum number of available keys is governed by `recent-keys-ring-size'."
|
|
|
608 :type 'integer
|
|
|
609 :group 'help)
|
|
|
610
|
|
|
611 (defcustom view-lossage-message-count 100
|
|
|
612 "*Number of minibuffer messages `view-lossage' shows."
|
|
|
613 :type 'integer
|
|
|
614 :group 'help)
|
|
|
615
|
|
0
|
616 (defun view-lossage ()
|
|
153
|
617 "Display recent input keystrokes and recent minibuffer messages.
|
|
|
618 The number of keys shown is controlled by `view-lossage-key-count'.
|
|
|
619 The number of messages shown is controlled by `view-lossage-message-count'."
|
|
0
|
620 (interactive)
|
|
|
621 (with-displaying-help-buffer
|
|
|
622 (lambda ()
|
|
153
|
623 (princ (key-description (recent-keys view-lossage-key-count)))
|
|
0
|
624 (save-excursion
|
|
|
625 (set-buffer standard-output)
|
|
|
626 (goto-char (point-min))
|
|
|
627 (insert "Recent keystrokes:\n\n")
|
|
|
628 (while (progn (move-to-column 50) (not (eobp)))
|
|
|
629 (search-forward " " nil t)
|
|
|
630 (insert "\n")))
|
|
|
631 ;; XEmacs addition
|
|
|
632 (princ "\n\n\nRecent minibuffer messages (most recent first):\n\n")
|
|
|
633 (save-excursion
|
|
|
634 (let ((buffer (get-buffer " *Message-Log*"))
|
|
|
635 (count 0)
|
|
|
636 oldpoint)
|
|
|
637 (set-buffer buffer)
|
|
|
638 (goto-char (point-max))
|
|
|
639 (set-buffer standard-output)
|
|
|
640 (while (and (> (point buffer) (point-min buffer))
|
|
153
|
641 (< count view-lossage-message-count))
|
|
0
|
642 (setq oldpoint (point buffer))
|
|
|
643 (forward-line -1 buffer)
|
|
|
644 (insert-buffer-substring buffer (point buffer) oldpoint)
|
|
|
645 (setq count (1+ count))))))))
|
|
|
646
|
|
|
647 (define-function 'help 'help-for-help)
|
|
|
648 ;; #### FSF calls `make-help-screen' here. We need to port `help-macro.el'.
|
|
|
649 (defun help-for-help ()
|
|
|
650 "You have typed \\[help-for-help], the help character. Type a Help option:
|
|
|
651 \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.)
|
|
|
652
|
|
|
653 \\[hyper-apropos] Give a substring, and see a hypertext list of
|
|
|
654 functions and variables that contain that substring.
|
|
|
655 See also the `apropos' command.
|
|
|
656 \\[command-apropos] Give a substring, and see a list of commands
|
|
|
657 (functions interactively callable) that contain that substring.
|
|
|
658 \\[describe-bindings] Display table of all key bindings.
|
|
|
659 \\[describe-key-briefly] Type a command key sequence;
|
|
|
660 it prints the function name that sequence runs.
|
|
|
661 \\[Info-goto-emacs-command-node] Type a function name;
|
|
|
662 it takes you to the Info node for that command.
|
|
|
663 \\[describe-function] Type a function name and get documentation of it.
|
|
|
664 \\[Info-elisp-ref] Type a function name and jump to the full documentation
|
|
|
665 in the XEmacs Lisp Programmer's Manual.
|
|
|
666 \\[xemacs-local-faq] To view a local copy of the XEmacs FAQ.
|
|
|
667 \\[info] The info documentation reader.
|
|
|
668 \\[Info-query] Info reader, prompt for topic name.
|
|
|
669 \\[describe-key] Type a command key sequence;
|
|
|
670 it displays the full documentation.
|
|
|
671 \\[Info-goto-emacs-key-command-node] Type a command key sequence;
|
|
|
672 it takes you to the Info node for the command bound to that key.
|
|
|
673 \\[view-lossage] Shows last 100 characters you typed.
|
|
|
674 \\[describe-mode] Print documentation of current major mode,
|
|
|
675 which describes the commands peculiar to it.
|
|
|
676 \\[view-emacs-news] Shows emacs news file.
|
|
|
677 \\[finder-by-keyword] Find packages matching a given topic keyword.
|
|
|
678 \\[describe-pointer] Display table of all mouse-button bindings.
|
|
|
679 \\[describe-syntax] Display contents of syntax table, plus explanations
|
|
|
680 \\[help-with-tutorial] Select the XEmacs learn-by-doing tutorial.
|
|
|
681 \\[describe-variable] Type name of a variable;
|
|
|
682 it displays the variable's documentation and value.
|
|
|
683 \\[where-is] Type command name;
|
|
|
684 it prints which keystrokes invoke that command.
|
|
|
685 \\[describe-distribution] XEmacs ordering information.
|
|
|
686 \\[describe-copying] print XEmacs copying permission (General Public License).
|
|
153
|
687 \\[view-emacs-news] print news of recent XEmacs changes.
|
|
0
|
688 \\[describe-no-warranty] print information on absence of warranty for XEmacs."
|
|
|
689 (interactive)
|
|
|
690 (let ((help-key (copy-event last-command-event))
|
|
|
691 event char)
|
|
|
692 (message (gettext "A B C F I K L M N P S T V W C-c C-d C-n C-w. Type %s again for more help: ")
|
|
|
693 ;; arrgh, no room for "C-i C-k C-f" !!
|
|
|
694 (single-key-description help-key))
|
|
|
695 (setq event (next-command-event)
|
|
|
696 char (event-to-character event))
|
|
|
697 (if (or (equal event help-key)
|
|
|
698 (eq char ??)
|
|
|
699 (eq 'help-command (key-binding event)))
|
|
|
700 (save-window-excursion
|
|
|
701 (switch-to-buffer "*Help*")
|
|
|
702 ;; #### I18N3 should mark buffer as output-translating
|
|
|
703 (delete-other-windows)
|
|
|
704 (let ((buffer-read-only nil))
|
|
|
705 (erase-buffer)
|
|
|
706 (insert (documentation 'help-for-help)))
|
|
|
707 (goto-char (point-min))
|
|
|
708 (while (or (equal event help-key)
|
|
|
709 (eq char ??)
|
|
|
710 (eq 'help-command (key-binding event))
|
|
|
711 (eq char ? )
|
|
|
712 (eq 'scroll-up (key-binding event))
|
|
|
713 (eq char ?\177)
|
|
76
|
714 (and (not (eq char ?b))
|
|
|
715 (eq 'scroll-down (key-binding event))))
|
|
0
|
716 (if (or (eq char ? )
|
|
|
717 (eq 'scroll-up (key-binding event)))
|
|
|
718 (scroll-up))
|
|
|
719 (if (or (eq char ?\177)
|
|
76
|
720 (and (not (eq char ?b))
|
|
|
721 (eq 'scroll-down (key-binding event))))
|
|
0
|
722 (scroll-down))
|
|
|
723 ;; write this way for I18N3 snarfing
|
|
|
724 (if (pos-visible-in-window-p (point-max))
|
|
|
725 (message "A B C F I K L M N P S T V W C-c C-d C-n C-w C-i C-k C-f: ")
|
|
|
726 (message "A B C F I K L M N P S T V W C-c C-d C-n C-w C-i C-k C-f or Space to scroll: "))
|
|
|
727 (let ((cursor-in-echo-area t))
|
|
|
728 (setq event (next-command-event event)
|
|
|
729 char (or (event-to-character event) event))))))
|
|
|
730 (let ((defn (or (lookup-key help-map (vector event))
|
|
|
731 (and (numberp char)
|
|
|
732 (lookup-key help-map (make-string 1 (downcase char)))))))
|
|
|
733 (message nil)
|
|
|
734 (if defn
|
|
|
735 (call-interactively defn)
|
|
|
736 (ding)))))
|
|
|
737
|
|
|
738 ;; Return a function which is called by the list containing point.
|
|
|
739 ;; If that gives no function, return a function whose name is around point.
|
|
|
740 ;; If that doesn't give a function, return nil.
|
|
|
741 (defun function-called-at-point ()
|
|
|
742 (or (condition-case ()
|
|
|
743 (save-excursion
|
|
|
744 (save-restriction
|
|
|
745 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max))
|
|
|
746 (backward-up-list 1)
|
|
|
747 (forward-char 1)
|
|
|
748 (let (obj)
|
|
|
749 (setq obj (read (current-buffer)))
|
|
|
750 (and (symbolp obj) (fboundp obj) obj))))
|
|
|
751 (error nil))
|
|
|
752 (condition-case ()
|
|
|
753 (let ((stab (syntax-table)))
|
|
|
754 (unwind-protect
|
|
|
755 (save-excursion
|
|
|
756 (set-syntax-table emacs-lisp-mode-syntax-table)
|
|
|
757 (or (not (zerop (skip-syntax-backward "_w")))
|
|
|
758 (eq (char-syntax (following-char)) ?w)
|
|
|
759 (eq (char-syntax (following-char)) ?_)
|
|
|
760 (forward-sexp -1))
|
|
|
761 (skip-chars-forward "`'")
|
|
|
762 (let ((obj (read (current-buffer))))
|
|
|
763 (and (symbolp obj) (fboundp obj) obj)))
|
|
|
764 (set-syntax-table stab)))
|
|
|
765 (error nil))))
|
|
|
766
|
|
120
|
767 ;; default to nil for the non-hackers?
|
|
|
768 (defcustom describe-function-show-arglist t
|
|
|
769 "*If non-nil, describe-function will show its arglist,
|
|
|
770 unless the function is autoloaded."
|
|
|
771 :type 'boolean
|
|
|
772 :group 'help-appearance)
|
|
0
|
773
|
|
|
774 (defun describe-function-find-file (function)
|
|
|
775 (and (boundp 'load-history) ; not standardly bound in XEmacs
|
|
|
776 (let ((files load-history)
|
|
|
777 file)
|
|
|
778 (while files
|
|
|
779 (if (memq function (cdr (car files)))
|
|
|
780 (setq file (car (car files)) files nil))
|
|
|
781 (setq files (cdr files)))
|
|
|
782 file)))
|
|
|
783
|
|
|
784 (defun describe-function (function)
|
|
|
785 "Display the full documentation of FUNCTION (a symbol)."
|
|
|
786 (interactive
|
|
|
787 (let* ((fn (function-called-at-point))
|
|
|
788 (val (let ((enable-recursive-minibuffers t))
|
|
|
789 (completing-read
|
|
|
790 (if fn
|
|
|
791 (format (gettext "Describe function (default %s): ")
|
|
|
792 fn)
|
|
|
793 (gettext "Describe function: "))
|
|
|
794 obarray 'fboundp t))))
|
|
|
795 (list (if (equal val "") fn (intern val)))))
|
|
|
796 (with-displaying-help-buffer
|
|
|
797 (lambda ()
|
|
|
798 (describe-function-1 function standard-output)
|
|
|
799 (save-excursion
|
|
|
800 (set-buffer standard-output)
|
|
|
801 ;; Return the text we displayed.
|
|
|
802 (buffer-string)))))
|
|
|
803
|
|
|
804 (defun function-obsolete-p (function)
|
|
|
805 "Return non-nil if FUNCTION is obsolete."
|
|
|
806 (not (null (get function 'byte-obsolete-info))))
|
|
|
807
|
|
|
808 (defun function-obsoleteness-doc (function)
|
|
|
809 "If FUNCTION is obsolete, return a string describing this."
|
|
|
810 (let ((obsolete (get function 'byte-obsolete-info)))
|
|
|
811 (if obsolete
|
|
|
812 (format "Obsolete; %s"
|
|
|
813 (if (stringp (car obsolete))
|
|
|
814 (car obsolete)
|
|
|
815 (format "use `%s' instead." (car obsolete)))))))
|
|
|
816
|
|
100
|
817 (defun function-compatible-p (function)
|
|
|
818 "Return non-nil if FUNCTION is present for Emacs compatibility."
|
|
|
819 (not (null (get function 'byte-compatible-info))))
|
|
|
820
|
|
|
821 (defun function-compatibility-doc (function)
|
|
|
822 "If FUNCTION is Emacs compatible, return a string describing this."
|
|
|
823 (let ((compatible (get function 'byte-compatible-info)))
|
|
|
824 (if compatible
|
|
|
825 (format "Emacs Compatible; %s"
|
|
|
826 (if (stringp (car compatible))
|
|
|
827 (car compatible)
|
|
|
828 (format "use `%s' instead." (car compatible)))))))
|
|
|
829
|
|
0
|
830 ;Here are all the possibilities below spelled out, for the benefit
|
|
|
831 ;of the I18N3 snarfer.
|
|
|
832 ;
|
|
|
833 ;(gettext "a built-in function")
|
|
|
834 ;(gettext "an interactive built-in function")
|
|
|
835 ;(gettext "a built-in macro")
|
|
|
836 ;(gettext "an interactive built-in macro")
|
|
|
837 ;(gettext "a compiled Lisp function")
|
|
|
838 ;(gettext "an interactive compiled Lisp function")
|
|
|
839 ;(gettext "a compiled Lisp macro")
|
|
|
840 ;(gettext "an interactive compiled Lisp macro")
|
|
|
841 ;(gettext "a Lisp function")
|
|
|
842 ;(gettext "an interactive Lisp function")
|
|
|
843 ;(gettext "a Lisp macro")
|
|
|
844 ;(gettext "an interactive Lisp macro")
|
|
|
845 ;(gettext "a mocklisp function")
|
|
|
846 ;(gettext "an interactive mocklisp function")
|
|
|
847 ;(gettext "a mocklisp macro")
|
|
|
848 ;(gettext "an interactive mocklisp macro")
|
|
|
849 ;(gettext "an autoloaded Lisp function")
|
|
|
850 ;(gettext "an interactive autoloaded Lisp function")
|
|
|
851 ;(gettext "an autoloaded Lisp macro")
|
|
|
852 ;(gettext "an interactive autoloaded Lisp macro")
|
|
|
853
|
|
|
854 (defun describe-function-1 (function stream &optional nodoc)
|
|
|
855 (prin1 function stream)
|
|
|
856 (princ ": " stream)
|
|
|
857 (let* ((def function)
|
|
|
858 file-name
|
|
|
859 (doc (or (documentation function)
|
|
|
860 (gettext "not documented")))
|
|
104
|
861 aliases home kbd-macro-p fndef macrop)
|
|
0
|
862 (while (symbolp def)
|
|
|
863 (or (eq def function)
|
|
|
864 (if aliases
|
|
|
865 ;; I18N3 Need gettext due to concat
|
|
|
866 (setq aliases (concat aliases
|
|
|
867 (format "\n which is an alias for %s, "
|
|
|
868 (symbol-name def))))
|
|
|
869 (setq aliases (format "an alias for %s, " (symbol-name def)))))
|
|
|
870 (setq def (symbol-function def)))
|
|
104
|
871 (if (compiled-function-p def)
|
|
|
872 (setq home (compiled-function-annotation def)))
|
|
0
|
873 (if (eq 'macro (car-safe def))
|
|
|
874 (setq fndef (cdr def)
|
|
|
875 macrop t)
|
|
|
876 (setq fndef def))
|
|
|
877 (if describe-function-show-arglist
|
|
|
878 (if (cond ((eq 'autoload (car-safe fndef))
|
|
|
879 nil)
|
|
|
880 ((eq 'lambda (car-safe fndef))
|
|
|
881 (princ (or (nth 1 fndef) "()") stream)
|
|
|
882 t)
|
|
|
883 ((compiled-function-p fndef)
|
|
|
884 (princ (or (compiled-function-arglist fndef) "()") stream)
|
|
|
885 t)
|
|
|
886 ((and (subrp fndef)
|
|
|
887 (string-match "[\n\t ]*\narguments: ?\\((.*)\\)\n?\\'"
|
|
|
888 doc))
|
|
|
889 (princ (substring doc (match-beginning 1) (match-end 1))
|
|
|
890 stream)
|
|
|
891 (setq doc (substring doc 0 (match-beginning 0)))
|
|
|
892 t)
|
|
|
893 (t
|
|
|
894 nil))
|
|
|
895 (princ "\n -- " stream)))
|
|
|
896 (if aliases (princ aliases stream))
|
|
|
897 (let ((int #'(lambda (string an-p macro-p)
|
|
|
898 (princ (format
|
|
|
899 (gettext (concat
|
|
|
900 (cond ((commandp def)
|
|
|
901 "an interactive ")
|
|
|
902 (an-p "an ")
|
|
|
903 (t "a "))
|
|
|
904 "%s"
|
|
|
905 (if macro-p " macro" " function")))
|
|
|
906 string)
|
|
|
907 stream))))
|
|
|
908 (cond ((or (stringp def) (vectorp def))
|
|
|
909 (princ "a keyboard macro." stream)
|
|
|
910 (setq kbd-macro-p t))
|
|
|
911 ((subrp fndef)
|
|
|
912 (funcall int "built-in" nil macrop))
|
|
|
913 ((compiled-function-p fndef)
|
|
|
914 (funcall int "compiled Lisp" nil macrop))
|
|
|
915 ; XEmacs -- we handle aliases above.
|
|
|
916 ; ((symbolp fndef)
|
|
|
917 ; (princ (format "alias for `%s'"
|
|
|
918 ; (prin1-to-string def)) stream))
|
|
|
919 ((eq (car-safe fndef) 'lambda)
|
|
|
920 (funcall int "Lisp" nil macrop))
|
|
|
921 ((eq (car-safe fndef) 'mocklisp)
|
|
|
922 (funcall int "mocklisp" nil macrop))
|
|
|
923 ((eq (car-safe def) 'autoload)
|
|
|
924 (setq file-name (elt def 1))
|
|
|
925 (funcall int "autoloaded Lisp" t (elt def 4)))
|
|
|
926 (t
|
|
|
927 nil)))
|
|
|
928 (or file-name
|
|
|
929 (setq file-name (describe-function-find-file function)))
|
|
|
930 (if file-name
|
|
|
931 (princ (format ".\n -- loads from \"%s\"" file-name) stream))
|
|
104
|
932 (if home
|
|
|
933 (princ (format ".\n -- loaded from %s" home)))
|
|
110
|
934 (princ "." stream)
|
|
|
935 (terpri stream)
|
|
0
|
936 (cond (kbd-macro-p
|
|
|
937 (princ "These characters are executed:\n\n\t" stream)
|
|
|
938 (princ (key-description def) stream)
|
|
|
939 (cond ((setq def (key-binding def))
|
|
|
940 (princ (format "\n\nwhich executes the command %s.\n\n" def) stream)
|
|
|
941 (describe-function-1 def stream))))
|
|
|
942 (nodoc nil)
|
|
|
943 (t
|
|
|
944 ;; tell the user about obsoleteness.
|
|
|
945 ;; If the function is obsolete and is aliased, don't
|
|
|
946 ;; even bother to report the documentation, as a further
|
|
|
947 ;; encouragement to use the new function.
|
|
100
|
948 (let ((obsolete (function-obsoleteness-doc function))
|
|
|
949 (compatible (function-compatibility-doc function)))
|
|
0
|
950 (if obsolete
|
|
|
951 (progn
|
|
|
952 (princ obsolete stream)
|
|
|
953 (terpri stream)
|
|
|
954 (terpri stream)))
|
|
100
|
955 (if compatible
|
|
|
956 (progn
|
|
|
957 (princ compatible stream)
|
|
|
958 (terpri stream)
|
|
|
959 (terpri stream)))
|
|
0
|
960 (if (not (and obsolete aliases))
|
|
|
961 (progn
|
|
|
962 (princ doc stream)
|
|
118
|
963 (or (equal doc "")
|
|
|
964 (eq ?\n (aref doc (1- (length doc))))
|
|
110
|
965 (terpri stream)))))))))
|
|
0
|
966
|
|
|
967
|
|
|
968 (defun describe-function-arglist (function)
|
|
|
969 (interactive (list (or (function-called-at-point)
|
|
|
970 (error "no function call at point"))))
|
|
|
971 (let ((b nil))
|
|
|
972 (unwind-protect
|
|
|
973 (save-excursion
|
|
|
974 (set-buffer (setq b (get-buffer-create " *arglist*")))
|
|
|
975 (buffer-disable-undo b)
|
|
|
976 (erase-buffer)
|
|
|
977 (describe-function-1 function b t)
|
|
|
978 (goto-char (point-min))
|
|
|
979 (end-of-line)
|
|
|
980 (or (eobp) (delete-char 1))
|
|
|
981 (just-one-space)
|
|
|
982 (end-of-line)
|
|
|
983 (message (buffer-substring (point-min) (point))))
|
|
|
984 (and b (kill-buffer b)))))
|
|
|
985
|
|
|
986
|
|
|
987 (defun variable-at-point ()
|
|
|
988 (condition-case ()
|
|
|
989 (let ((stab (syntax-table)))
|
|
|
990 (unwind-protect
|
|
|
991 (save-excursion
|
|
|
992 (set-syntax-table emacs-lisp-mode-syntax-table)
|
|
|
993 (or (not (zerop (skip-syntax-backward "_w")))
|
|
|
994 (eq (char-syntax (following-char)) ?w)
|
|
|
995 (eq (char-syntax (following-char)) ?_)
|
|
|
996 (forward-sexp -1))
|
|
|
997 (skip-chars-forward "'")
|
|
|
998 (let ((obj (read (current-buffer))))
|
|
|
999 (and (symbolp obj) (boundp obj) obj)))
|
|
|
1000 (set-syntax-table stab)))
|
|
|
1001 (error nil)))
|
|
|
1002
|
|
|
1003 (defun variable-obsolete-p (variable)
|
|
|
1004 "Return non-nil if VARIABLE is obsolete."
|
|
|
1005 (not (null (get variable 'byte-obsolete-variable))))
|
|
|
1006
|
|
|
1007 (defun variable-obsoleteness-doc (variable)
|
|
|
1008 "If VARIABLE is obsolete, return a string describing this."
|
|
|
1009 (let ((obsolete (get variable 'byte-obsolete-variable)))
|
|
|
1010 (if obsolete
|
|
|
1011 (format "Obsolete; %s"
|
|
|
1012 (if (stringp obsolete)
|
|
|
1013 obsolete
|
|
|
1014 (format "use `%s' instead." obsolete))))))
|
|
|
1015
|
|
100
|
1016 (defun variable-compatible-p (variable)
|
|
|
1017 "Return non-nil if VARIABLE is Emacs compatible."
|
|
|
1018 (not (null (get variable 'byte-compatible-variable))))
|
|
|
1019
|
|
|
1020 (defun variable-compatibility-doc (variable)
|
|
|
1021 "If VARIABLE is Emacs compatible, return a string describing this."
|
|
|
1022 (let ((compatible (get variable 'byte-compatible-variable)))
|
|
|
1023 (if compatible
|
|
|
1024 (format "Emacs Compatible; %s"
|
|
|
1025 (if (stringp compatible)
|
|
|
1026 compatible
|
|
|
1027 (format "use `%s' instead." compatible))))))
|
|
|
1028
|
|
0
|
1029 (defun built-in-variable-doc (variable)
|
|
|
1030 "Return a string describing whether VARIABLE is built-in."
|
|
|
1031 (let ((type (built-in-variable-type variable)))
|
|
|
1032 (cond ((eq type 'integer) "a built-in integer variable")
|
|
|
1033 ((eq type 'const-integer) "a built-in constant integer variable")
|
|
|
1034 ((eq type 'boolean) "a built-in boolean variable")
|
|
|
1035 ((eq type 'const-boolean) "a built-in constant boolean variable")
|
|
|
1036 ((eq type 'object) "a simple built-in variable")
|
|
|
1037 ((eq type 'const-object) "a simple built-in constant variable")
|
|
|
1038 ((eq type 'const-specifier) "a built-in constant specifier variable")
|
|
|
1039 ((eq type 'current-buffer) "a built-in buffer-local variable")
|
|
|
1040 ((eq type 'const-current-buffer)
|
|
|
1041 "a built-in constant buffer-local variable")
|
|
|
1042 ((eq type 'default-buffer)
|
|
|
1043 "a built-in default buffer-local variable")
|
|
|
1044 ((eq type 'selected-console) "a built-in console-local variable")
|
|
|
1045 ((eq type 'const-selected-console)
|
|
|
1046 "a built-in constant console-local variable")
|
|
|
1047 ((eq type 'default-console)
|
|
|
1048 "a built-in default console-local variable")
|
|
|
1049 (type "an unknown type of built-in variable?")
|
|
|
1050 (t "a variable declared in Lisp"))))
|
|
|
1051
|
|
|
1052 (defun describe-variable (variable)
|
|
|
1053 "Display the full documentation of VARIABLE (a symbol)."
|
|
|
1054 (interactive
|
|
|
1055 (let* ((v (variable-at-point))
|
|
|
1056 (val (let ((enable-recursive-minibuffers t))
|
|
|
1057 (completing-read
|
|
|
1058 (if v
|
|
|
1059 (format "Describe variable (default %s): " v)
|
|
|
1060 (gettext "Describe variable: "))
|
|
|
1061 obarray 'boundp t))))
|
|
|
1062 (list (if (equal val "") v (intern val)))))
|
|
|
1063 (with-displaying-help-buffer
|
|
|
1064 (lambda ()
|
|
|
1065 (let ((origvar variable)
|
|
|
1066 aliases)
|
|
|
1067 (let ((print-escape-newlines t))
|
|
|
1068 (while (variable-alias variable)
|
|
|
1069 (let ((newvar (variable-alias variable)))
|
|
|
1070 (if aliases
|
|
|
1071 ;; I18N3 Need gettext due to concat
|
|
|
1072 (setq aliases
|
|
|
1073 (concat aliases
|
|
|
1074 (format ",\n which is an alias for %s"
|
|
|
1075 (symbol-name newvar))))
|
|
|
1076 (setq aliases
|
|
|
1077 (format "%s is an alias for %s"
|
|
|
1078 (symbol-name variable)
|
|
|
1079 (symbol-name newvar))))
|
|
|
1080 (setq variable newvar)))
|
|
|
1081 (if aliases
|
|
|
1082 (princ (format "%s.\n" aliases)))
|
|
|
1083 (if (not (boundp variable))
|
|
|
1084 (princ (format "%s is void" variable))
|
|
|
1085 (princ (format "%s's value is " variable))
|
|
|
1086 (prin1 (symbol-value variable)))
|
|
|
1087 (terpri)
|
|
|
1088 (princ " -- ")
|
|
|
1089 (princ (built-in-variable-doc variable))
|
|
|
1090 (princ ".")
|
|
|
1091 (terpri)
|
|
|
1092 (cond ((local-variable-p variable (current-buffer))
|
|
|
1093 (let* ((void (cons nil nil))
|
|
|
1094 (def (condition-case nil
|
|
|
1095 (default-value variable)
|
|
|
1096 (error void))))
|
|
|
1097 (princ "This value is specific to the current buffer.")
|
|
|
1098 (terpri)
|
|
|
1099 (if (local-variable-p variable nil)
|
|
|
1100 (progn
|
|
|
1101 (princ "(Its value is local to each buffer.)")
|
|
|
1102 (terpri)))
|
|
|
1103 (if (if (eq def void)
|
|
|
1104 (boundp variable)
|
|
|
1105 (not (eq (symbol-value variable) def)))
|
|
|
1106 ;; #### I18N3 doesn't localize properly!
|
|
|
1107 (progn (princ "Its default-value is ")
|
|
|
1108 (if (eq def void)
|
|
|
1109 (princ "void.")
|
|
|
1110 (prin1 def))
|
|
|
1111 (terpri)))))
|
|
|
1112 ((local-variable-p variable (current-buffer) t)
|
|
|
1113 (princ "Setting it would make its value buffer-local.\n")
|
|
|
1114 (terpri))))
|
|
|
1115 (terpri)
|
|
|
1116 (princ "Documentation:")
|
|
|
1117 (terpri)
|
|
|
1118 (let ((doc (documentation-property variable 'variable-documentation))
|
|
100
|
1119 (obsolete (variable-obsoleteness-doc origvar))
|
|
|
1120 (compatible (variable-compatibility-doc origvar)))
|
|
0
|
1121 (if obsolete
|
|
|
1122 (progn
|
|
|
1123 (princ obsolete)
|
|
|
1124 (terpri)
|
|
|
1125 (terpri)))
|
|
100
|
1126 (if compatible
|
|
|
1127 (progn
|
|
|
1128 (princ compatible)
|
|
|
1129 (terpri)
|
|
|
1130 (terpri)))
|
|
0
|
1131 ;; don't bother to print anything if variable is obsolete and aliased.
|
|
120
|
1132 (when (or (not obsolete) (not aliases))
|
|
|
1133 (if doc
|
|
|
1134 ;; note: documentation-property calls substitute-command-keys.
|
|
|
1135 (princ doc)
|
|
|
1136 (princ "not documented as a variable."))
|
|
|
1137 (terpri)))
|
|
0
|
1138 (save-excursion
|
|
|
1139 (set-buffer standard-output)
|
|
|
1140 ;; Return the text we displayed.
|
|
|
1141 (buffer-string))))))
|
|
|
1142
|
|
|
1143 (defun where-is (definition)
|
|
|
1144 "Print message listing key sequences that invoke specified command.
|
|
|
1145 Argument is a command definition, usually a symbol with a function definition."
|
|
|
1146 (interactive
|
|
|
1147 (let ((fn (function-called-at-point))
|
|
|
1148 (enable-recursive-minibuffers t)
|
|
|
1149 val)
|
|
|
1150 ;; #### should use `read-command'
|
|
|
1151 (setq val (completing-read (if fn
|
|
|
1152 (format "Where is command (default %s): " fn)
|
|
|
1153 "Where is command: ")
|
|
|
1154 obarray 'commandp t nil
|
|
|
1155 'read-command-history))
|
|
|
1156 (list (if (equal val "")
|
|
|
1157 fn (intern val)))))
|
|
|
1158 (let ((keys (where-is-internal definition)))
|
|
|
1159 (if keys
|
|
|
1160 (message "%s is on %s" definition
|
|
|
1161 (mapconcat 'key-description
|
|
|
1162 (sort keys #'(lambda (x y)
|
|
|
1163 (< (length x) (length y))))
|
|
|
1164 ", "))
|
|
|
1165 (message "%s is not on any keys" definition)))
|
|
|
1166 nil)
|
|
|
1167
|
|
110
|
1168 ;; Synched with Emacs 19.35
|
|
|
1169 (defun locate-library (library &optional nosuffix path interactive-call)
|
|
|
1170 "Show the precise file name of Emacs library LIBRARY.
|
|
0
|
1171 This command searches the directories in `load-path' like `M-x load-library'
|
|
|
1172 to find the file that `M-x load-library RET LIBRARY RET' would load.
|
|
|
1173 Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el'
|
|
110
|
1174 to the specified name LIBRARY.
|
|
|
1175
|
|
|
1176 If the optional third arg PATH is specified, that list of directories
|
|
|
1177 is used instead of `load-path'."
|
|
|
1178 (interactive (list (read-string "Locate library: ")
|
|
|
1179 nil nil
|
|
|
1180 t))
|
|
|
1181 (let (result)
|
|
|
1182 (catch 'answer
|
|
|
1183 (mapcar
|
|
|
1184 (lambda (dir)
|
|
|
1185 (mapcar
|
|
|
1186 (lambda (suf)
|
|
|
1187 (let ((try (expand-file-name (concat library suf) dir)))
|
|
|
1188 (and (file-readable-p try)
|
|
|
1189 (null (file-directory-p try))
|
|
|
1190 (progn
|
|
|
1191 (setq result try)
|
|
|
1192 (throw 'answer try)))))
|
|
|
1193 (if nosuffix
|
|
|
1194 '("")
|
|
|
1195 (let ((basic '(".elc" ".el" ""))
|
|
|
1196 (compressed '(".Z" ".gz" "")))
|
|
|
1197 ;; If autocompression mode is on,
|
|
|
1198 ;; consider all combinations of library suffixes
|
|
|
1199 ;; and compression suffixes.
|
|
|
1200 (if (rassq 'jka-compr-handler file-name-handler-alist)
|
|
|
1201 (apply 'nconc
|
|
|
1202 (mapcar (lambda (compelt)
|
|
|
1203 (mapcar (lambda (baselt)
|
|
|
1204 (concat baselt compelt))
|
|
|
1205 basic))
|
|
|
1206 compressed))
|
|
|
1207 basic)))))
|
|
|
1208 (or path load-path)))
|
|
|
1209 (and interactive-call
|
|
|
1210 (if result
|
|
|
1211 (message "Library is file %s" result)
|
|
|
1212 (message "No library %s in search path" library)))
|
|
|
1213 result))
|
|
0
|
1214
|
|
|
1215 ;; Functions ported from C into Lisp in XEmacs
|
|
|
1216
|
|
|
1217 (defun describe-syntax ()
|
|
|
1218 "Describe the syntax specifications in the syntax table.
|
|
|
1219 The descriptions are inserted in a buffer, which is then displayed."
|
|
|
1220 (interactive)
|
|
|
1221 (with-displaying-help-buffer
|
|
|
1222 (lambda ()
|
|
|
1223 ;; defined in syntax.el
|
|
|
1224 (describe-syntax-table (syntax-table) standard-output))))
|
|
|
1225
|
|
|
1226 (defun list-processes ()
|
|
|
1227 "Display a list of all processes.
|
|
|
1228 \(Any processes listed as Exited or Signaled are actually eliminated
|
|
|
1229 after the listing is made.)"
|
|
|
1230 (interactive)
|
|
|
1231 (with-output-to-temp-buffer "*Process List*"
|
|
|
1232 (set-buffer standard-output)
|
|
|
1233 (buffer-disable-undo standard-output)
|
|
|
1234 (make-local-variable 'truncate-lines)
|
|
|
1235 (setq truncate-lines t)
|
|
|
1236 (let ((stream standard-output))
|
|
|
1237 ;; 00000000001111111111222222222233333333334444444444
|
|
|
1238 ;; 01234567890123456789012345678901234567890123456789
|
|
|
1239 ;; rewritten for I18N3. This one should stay rewritten
|
|
|
1240 ;; so that the dashes will line up properly.
|
|
|
1241 (princ "Proc Status Buffer Tty Command\n---- ------ ------ --- -------\n" stream)
|
|
|
1242 (let ((tail (process-list)))
|
|
|
1243 (while tail
|
|
|
1244 (let* ((p (car tail))
|
|
|
1245 (pid (process-id p))
|
|
|
1246 (s (process-status p)))
|
|
|
1247 (setq tail (cdr tail))
|
|
|
1248 (princ (format "%-13s" (process-name p)) stream)
|
|
|
1249 ;(if (and (eq system-type 'vax-vms)
|
|
|
1250 ; (eq s 'signal)
|
|
|
1251 ; (< (process-exit-status p) NSIG))
|
|
|
1252 ; (princ (aref sys_errlist (process-exit-status p)) stream))
|
|
|
1253 (princ s stream)
|
|
|
1254 (if (and (eq s 'exit) (/= (process-exit-status p) 0))
|
|
|
1255 (princ (format " %d" (process-exit-status p)) stream))
|
|
|
1256 (if (memq s '(signal exit closed))
|
|
|
1257 ;; Do delete-exited-processes' work
|
|
|
1258 (delete-process p))
|
|
|
1259 (indent-to 22 1) ;####
|
|
|
1260 (let ((b (process-buffer p)))
|
|
|
1261 (cond ((not b)
|
|
|
1262 (princ "(none)" stream))
|
|
|
1263 ((not (buffer-name b))
|
|
|
1264 (princ "(killed)" stream))
|
|
|
1265 (t
|
|
|
1266 (princ (buffer-name b) stream))))
|
|
|
1267 (indent-to 37 1) ;####
|
|
|
1268 (let ((tn (process-tty-name p)))
|
|
|
1269 (cond ((not tn)
|
|
|
1270 (princ "(none)" stream))
|
|
|
1271 (t
|
|
|
1272 (princ (format "%s" tn) stream))))
|
|
|
1273 (indent-to 49 1) ;####
|
|
|
1274 (if (not (integerp pid))
|
|
|
1275 (progn
|
|
|
1276 (princ "network stream connection " stream)
|
|
|
1277 (princ (car pid) stream)
|
|
|
1278 (princ "@" stream)
|
|
|
1279 (princ (cdr pid) stream))
|
|
|
1280 (let ((cmd (process-command p)))
|
|
|
1281 (while cmd
|
|
|
1282 (princ (car cmd) stream)
|
|
|
1283 (setq cmd (cdr cmd))
|
|
|
1284 (if cmd (princ " " stream)))))
|
|
|
1285 (terpri stream)))))))
|
