X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/dd39c336a9ef030a2d672aac8fbc278eb69055f8..dc5c3489f44f5bd0a17ee3deef9363387f5b4de5:/lisp/help.el diff --git a/lisp/help.el b/lisp/help.el index 22d383559a..5eef13ff9c 100644 --- a/lisp/help.el +++ b/lisp/help.el @@ -1,7 +1,7 @@ ;;; help.el --- help commands for Emacs -;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002, 2004, -;; 2005 Free Software Foundation, Inc. +;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002, +;; 2003, 2004, 2005, 2006 Free Software Foundation, Inc. ;; Maintainer: FSF ;; Keywords: help, internal @@ -20,8 +20,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs; see the file COPYING. If not, write to the -;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, -;; Boston, MA 02111-1307, USA. +;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: @@ -38,7 +38,57 @@ (add-hook 'temp-buffer-setup-hook 'help-mode-setup) (add-hook 'temp-buffer-show-hook 'help-mode-finish) -(defvar help-map (make-sparse-keymap) +(defvar help-map + (let ((map (make-sparse-keymap))) + (define-key map (char-to-string help-char) 'help-for-help) + (define-key map [help] 'help-for-help) + (define-key map [f1] 'help-for-help) + (define-key map "." 'display-local-help) + (define-key map "?" 'help-for-help) + + (define-key map "\C-c" 'describe-copying) + (define-key map "\C-d" 'describe-distribution) + (define-key map "\C-e" 'view-emacs-problems) + (define-key map "\C-f" 'view-emacs-FAQ) + (define-key map "\C-m" 'view-order-manuals) + (define-key map "\C-n" 'view-emacs-news) + (define-key map "\C-p" 'describe-project) + (define-key map "\C-t" 'view-todo) + (define-key map "\C-w" 'describe-no-warranty) + + ;; This does not fit the pattern, but it is natural given the C-\ command. + (define-key map "\C-\\" 'describe-input-method) + + (define-key map "C" 'describe-coding-system) + (define-key map "F" 'Info-goto-emacs-command-node) + (define-key map "I" 'describe-input-method) + (define-key map "K" 'Info-goto-emacs-key-command-node) + (define-key map "L" 'describe-language-environment) + (define-key map "S" 'info-lookup-symbol) + + (define-key map "a" 'apropos-command) + (define-key map "b" 'describe-bindings) + (define-key map "c" 'describe-key-briefly) + (define-key map "d" 'apropos-documentation) + (define-key map "e" 'view-echo-area-messages) + (define-key map "f" 'describe-function) + (define-key map "h" 'view-hello-file) + + (define-key map "i" 'info) + (define-key map "4i" 'info-other-window) + + (define-key map "k" 'describe-key) + (define-key map "l" 'view-lossage) + (define-key map "m" 'describe-mode) + (define-key map "n" 'view-emacs-news) + (define-key map "p" 'finder-by-keyword) + (define-key map "r" 'info-emacs-manual) + (define-key map "s" 'describe-syntax) + (define-key map "t" 'help-with-tutorial) + (define-key map "w" 'where-is) + (define-key map "v" 'describe-variable) + (define-key map "q" 'help-quit) + map) "Keymap for characters following the Help key.") (define-key global-map (char-to-string help-char) 'help-command) @@ -46,71 +96,9 @@ (define-key global-map [f1] 'help-command) (fset 'help-command help-map) -(define-key help-map (char-to-string help-char) 'help-for-help) -(define-key help-map [help] 'help-for-help) -(define-key help-map [f1] 'help-for-help) -(define-key help-map "." 'display-local-help) -(define-key help-map "?" 'help-for-help) - -(define-key help-map "\C-c" 'describe-copying) -(define-key help-map "\C-d" 'describe-distribution) -(define-key help-map "\C-e" 'view-emacs-problems) -(define-key help-map "\C-f" 'view-emacs-FAQ) -(define-key help-map "\C-m" 'view-order-manuals) -(define-key help-map "\C-n" 'view-emacs-news) -(define-key help-map "\C-p" 'describe-project) -(define-key help-map "\C-t" 'view-todo) -(define-key help-map "\C-w" 'describe-no-warranty) - -;; This does not fit the pattern, but it is natural given the C-\ command. -(define-key help-map "\C-\\" 'describe-input-method) - -(define-key help-map "C" 'describe-coding-system) -(define-key help-map "F" 'Info-goto-emacs-command-node) -(define-key help-map "I" 'describe-input-method) -(define-key help-map "K" 'Info-goto-emacs-key-command-node) -(define-key help-map "L" 'describe-language-environment) -(define-key help-map "S" 'info-lookup-symbol) - -(define-key help-map "a" 'apropos-command) - -(define-key help-map "b" 'describe-bindings) - -(define-key help-map "c" 'describe-key-briefly) - -(define-key help-map "e" 'view-echo-area-messages) - -(define-key help-map "f" 'describe-function) - -(define-key help-map "h" 'view-hello-file) - -(define-key help-map "i" 'info) -(define-key help-map "4i" 'info-other-window) - -(define-key help-map "k" 'describe-key) - -(define-key help-map "l" 'view-lossage) - -(define-key help-map "m" 'describe-mode) - -(define-key help-map "n" 'view-emacs-news) - -(define-key help-map "p" 'finder-by-keyword) (autoload 'finder-by-keyword "finder" "Find packages matching a given keyword." t) -(define-key help-map "r" 'info-emacs-manual) - -(define-key help-map "s" 'describe-syntax) - -(define-key help-map "t" 'help-with-tutorial) - -(define-key help-map "w" 'where-is) - -(define-key help-map "v" 'describe-variable) - -(define-key help-map "q" 'help-quit) - ;; insert-button makes the action nil if it is not store somewhere (defvar help-button-cache nil) @@ -123,7 +111,8 @@ (defvar help-return-method nil "What to do to \"exit\" the help buffer. This is a list - (WINDOW . t) delete the selected window, go to WINDOW. + (WINDOW . t) delete the selected window (and possibly its frame, + see `quit-window' and `View-quit'), go to WINDOW. (WINDOW . quit-window) do quit-window, then select WINDOW. (WINDOW BUF START POINT) display BUF at START, POINT, then select WINDOW.") @@ -131,10 +120,14 @@ This is a list "Display or return message saying how to restore windows after help command. This function assumes that `standard-output' is the help buffer. It computes a message, and applies the optional argument FUNCTION to it. -If FUNCTION is nil, it applies `message', thus displaying the message." +If FUNCTION is nil, it applies `message', thus displaying the message. +In addition, this function sets up `help-return-method', which see, that +specifies what to do when the user exits the help buffer." (and (not (get-buffer-window standard-output)) (let ((first-message - (cond ((special-display-p (buffer-name standard-output)) + (cond ((or + pop-up-frames + (special-display-p (buffer-name standard-output))) (setq help-return-method (cons (selected-window) t)) ;; If the help output buffer is a special display buffer, ;; don't say anything about how to get rid of it. @@ -166,7 +159,8 @@ If FUNCTION is nil, it applies `message', thus displaying the message." (if first-message " ") ;; If the help buffer will go in a separate frame, ;; it's no use mentioning a command to scroll, so don't. - (if (special-display-p (buffer-name standard-output)) + (if (or pop-up-windows + (special-display-p (buffer-name standard-output))) nil (if (same-window-p (buffer-name standard-output)) ;; Say how to scroll this window. @@ -184,19 +178,21 @@ If FUNCTION is nil, it applies `message', thus displaying the message." (defalias 'help-for-help 'help-for-help-internal) ;; It can't find this, but nobody will look. (make-help-screen help-for-help-internal - "a b c C e f F i I k C-k l L m p s t v w C-c C-d C-f C-n C-p C-t C-w . or ? :" + "a b c C e f F i I k C-k l L m p r s t v w C-c C-d C-f C-n C-p C-t C-w . or ? :" "You have typed %THIS-KEY%, the help character. Type a Help option: \(Use SPC or DEL to scroll through this text. Type \\\\[help-quit] to exit the Help command.) -a command-apropos. Give a substring, and see a list of commands - (functions that are interactively callable) that contain - that substring. See also the apropos command. +a command-apropos. Give a list of words or a regexp, to get a list of + commands whose names match. See also the apropos command. b describe-bindings. Display table of all key bindings. c describe-key-briefly. Type a command key sequence; it prints the function name that sequence runs. C describe-coding-system. This describes either a specific coding system (if you type its name) or the coding systems currently in use (if you type just RET). +d apropos-documentation. Give a pattern (a list or words or a regexp), and + see a list of functions, variables, and other items whose built-in + doucmentation string matches that pattern. See also the apropos command. e view-echo-area-messages. Show the buffer where the echo-area messages are stored. f describe-function. Type a function name and get its documentation. @@ -220,6 +216,7 @@ m describe-mode. Display documentation of current minor modes, and the current major mode, including their special commands. n view-emacs-news. Display news of recent Emacs changes. p finder-by-keyword. Find packages matching a given topic keyword. +r info-emacs-manual. Display the Emacs manual in Info mode. s describe-syntax. Display contents of syntax table, plus explanations. S info-lookup-symbol. Display the definition of a specific symbol as found in the manual for the language this buffer is written in. @@ -432,8 +429,9 @@ To record all your input on a file, use `open-dribble-file'." (with-current-buffer standard-output (goto-char (point-min)) (while (progn (move-to-column 50) (not (eobp))) - (search-forward " " nil t) - (insert "\n"))) + (when (search-forward " " nil t) + (delete-char -1)) + (insert "\n"))) (print-help-return-message))) @@ -486,6 +484,7 @@ If INSERT (the prefix arg) is non-nil, insert the message in the buffer." (let ((func (indirect-function definition)) (defs nil) (standard-output (if insert (current-buffer) t))) + ;; In DEFS, find all symbols that are aliases for DEFINITION. (mapatoms (lambda (symbol) (and (fboundp symbol) (not (eq symbol definition)) @@ -493,27 +492,37 @@ If INSERT (the prefix arg) is non-nil, insert the message in the buffer." (indirect-function symbol) (error symbol))) (push symbol defs)))) - (princ (mapconcat - #'(lambda (symbol) - (let* ((remapped (command-remapping symbol)) - (keys (where-is-internal - symbol overriding-local-map nil nil remapped)) - (keys (mapconcat 'key-description keys ", "))) - (if insert - (if (> (length keys) 0) - (if remapped - (format "%s (%s) (remapped from %s)" - keys remapped symbol) - (format "%s (%s)" keys symbol)) - (format "M-x %s RET" symbol)) - (if (> (length keys) 0) - (if remapped - (format "%s is remapped to %s which is on %s" - definition symbol keys) - (format "%s is on %s" symbol keys)) - (format "%s is not on any key" symbol))))) - (cons definition defs) - ";\nand "))) + ;; Look at all the symbols--first DEFINITION, + ;; then its aliases. + (dolist (symbol (cons definition defs)) + (let* ((remapped (command-remapping symbol)) + (keys (where-is-internal + symbol overriding-local-map nil nil remapped)) + (keys (mapconcat 'key-description keys ", ")) + string) + (setq string + (if insert + (if (> (length keys) 0) + (if remapped + (format "%s (%s) (remapped from %s)" + keys remapped symbol) + (format "%s (%s)" keys symbol)) + (format "M-x %s RET" symbol)) + (if (> (length keys) 0) + (if remapped + (format "%s is remapped to %s which is on %s" + symbol remapped keys) + (format "%s is on %s" symbol keys)) + ;; If this is the command the user asked about, + ;; and it is not on any key, say so. + ;; For other symbols, its aliases, say nothing + ;; about them unless they are on keys. + (if (eq symbol definition) + (format "%s is not on any key" symbol))))) + (when string + (unless (eq symbol definition) + (princ ";\n its alias ")) + (princ string))))) nil) (defun string-key-binding (key) @@ -548,13 +557,41 @@ or `keymap' property, return the binding of KEY in the string's keymap." string (format "%s (translated from %s)" string otherstring)))))) -(defun describe-key-briefly (key &optional insert untranslated) +(defun describe-key-briefly (&optional key insert untranslated) "Print the name of the function KEY invokes. KEY is a string. If INSERT (the prefix arg) is non-nil, insert the message in the buffer. -If non-nil UNTRANSLATED is a vector of the untranslated events. +If non-nil, UNTRANSLATED is a vector of the untranslated events. It can also be a number in which case the untranslated events from -the last key hit are used." - (interactive "kDescribe key briefly: \nP\np") +the last key hit are used. + +If KEY is a menu item or a tool-bar button that is disabled, this command +temporarily enables it to allow getting help on disabled items and buttons." + (interactive + (let ((enable-disabled-menus-and-buttons t) + (cursor-in-echo-area t) + saved-yank-menu) + (unwind-protect + (let (key) + ;; If yank-menu is empty, populate it temporarily, so that + ;; "Select and Paste" menu can generate a complete event. + (when (null (cdr yank-menu)) + (setq saved-yank-menu (copy-sequence yank-menu)) + (menu-bar-update-yank-menu "(any string)" nil)) + (setq key (read-key-sequence "Describe key (or click or menu item): ")) + ;; If KEY is a down-event, read and discard the + ;; corresponding up-event. + (if (and (vectorp key) + (eventp (elt key 0)) + (memq 'down (event-modifiers (elt key 0)))) + (read-event)) + (list + key + (if current-prefix-arg (prefix-numeric-value current-prefix-arg)) + 1)) + ;; Put yank-menu back as it was, if we changed it. + (when saved-yank-menu + (setq yank-menu (copy-sequence saved-yank-menu)) + (fset 'yank-menu (cons 'keymap yank-menu)))))) (if (numberp untranslated) (setq untranslated (this-single-command-raw-keys))) (save-excursion @@ -574,8 +611,22 @@ the last key hit are used." (goto-char position))) ;; Ok, now look up the key and name the command. (let ((defn (or (string-key-binding key) - (key-binding key))) - (key-desc (help-key-description key untranslated))) + (key-binding key t))) + key-desc) + ;; Handle the case where we faked an entry in "Select and Paste" menu. + (if (and (eq defn nil) + (stringp (aref key (1- (length key)))) + (eq (key-binding (substring key 0 -1)) 'yank-menu)) + (setq defn 'menu-bar-select-yank)) + ;; Don't bother user with strings from (e.g.) the select-paste menu. + (if (stringp (aref key (1- (length key)))) + (aset key (1- (length key)) "(any string)")) + (if (and (> (length untranslated) 0) + (stringp (aref untranslated (1- (length untranslated))))) + (aset untranslated (1- (length untranslated)) + "(any string)")) + ;; Now describe the key, perhaps as changed. + (setq key-desc (help-key-description key untranslated)) (if (or (null defn) (integerp defn) (equal defn 'undefined)) (princ (format "%s is undefined" key-desc)) (princ (format (if (windowp window) @@ -584,15 +635,44 @@ the last key hit are used." key-desc (if (symbolp defn) defn (prin1-to-string defn))))))))) - -(defun describe-key (key &optional untranslated up-event) +(defun describe-key (&optional key untranslated up-event) "Display documentation of the function invoked by KEY. -KEY should be a key sequence--when calling from a program, -pass a string or a vector. -If non-nil UNTRANSLATED is a vector of the untranslated events. -It can also be a number in which case the untranslated events from -the last key hit are used." - (interactive "kDescribe key: \np\nU") +KEY can be any kind of a key sequence; it can include keyboard events, +mouse events, and/or menu events. When calling from a program, +pass KEY as a string or a vector. + +If non-nil, UNTRANSLATED is a vector of the corresponding untranslated events. +It can also be a number, in which case the untranslated events from +the last key sequence entered are used. +UP-EVENT is the up-event that was discarded by reading KEY, or nil. + +If KEY is a menu item or a tool-bar button that is disabled, this command +temporarily enables it to allow getting help on disabled items and buttons." + (interactive + (let ((enable-disabled-menus-and-buttons t) + (cursor-in-echo-area t) + saved-yank-menu) + (unwind-protect + (let (key) + ;; If yank-menu is empty, populate it temporarily, so that + ;; "Select and Paste" menu can generate a complete event. + (when (null (cdr yank-menu)) + (setq saved-yank-menu (copy-sequence yank-menu)) + (menu-bar-update-yank-menu "(any string)" nil)) + (setq key (read-key-sequence "Describe key (or click or menu item): ")) + (list + key + (prefix-numeric-value current-prefix-arg) + ;; If KEY is a down-event, read the corresponding up-event + ;; and use it as the third argument. + (if (and (vectorp key) + (eventp (elt key 0)) + (memq 'down (event-modifiers (elt key 0)))) + (read-event)))) + ;; Put yank-menu back as it was, if we changed it. + (when saved-yank-menu + (setq yank-menu (copy-sequence saved-yank-menu)) + (fset 'yank-menu (cons 'keymap yank-menu)))))) (if (numberp untranslated) (setq untranslated (this-single-command-raw-keys))) (save-excursion @@ -608,10 +688,22 @@ the last key hit are used." (when (windowp window) (set-buffer (window-buffer window)) (goto-char position)) - (let ((defn (or (string-key-binding key) (key-binding key)))) + (let ((defn (or (string-key-binding key) (key-binding key t)))) + ;; Handle the case where we faked an entry in "Select and Paste" menu. + (if (and (eq defn nil) + (stringp (aref key (1- (length key)))) + (eq (key-binding (substring key 0 -1)) 'yank-menu)) + (setq defn 'menu-bar-select-yank)) (if (or (null defn) (integerp defn) (equal defn 'undefined)) (message "%s is undefined" (help-key-description key untranslated)) (help-setup-xref (list #'describe-function defn) (interactive-p)) + ;; Don't bother user with strings from (e.g.) the select-paste menu. + (if (stringp (aref key (1- (length key)))) + (aset key (1- (length key)) "(any string)")) + (if (and untranslated + (stringp (aref untranslated (1- (length untranslated))))) + (aset untranslated (1- (length untranslated)) + "(any string)")) (with-output-to-temp-buffer (help-buffer) (princ (help-key-description key untranslated)) (if (windowp window) @@ -621,30 +713,34 @@ the last key hit are used." (princ "\n which is ") (describe-function-1 defn) (when up-event - (let ((ev (aref up-event 0)) - (descr (key-description up-event)) + (let ((type (event-basic-type up-event)) (hdr "\n\n-------------- up event ---------------\n\n") - defn + defn sequence mouse-1-tricky mouse-1-remapped) - (when (and (consp ev) - (eq (car ev) 'mouse-1) + (setq sequence (vector up-event)) + (when (and (eq type 'mouse-1) (windowp window) mouse-1-click-follows-link (not (eq mouse-1-click-follows-link 'double)) - (with-current-buffer (window-buffer window) - (mouse-on-link-p (posn-point (event-start ev))))) - (setq mouse-1-tricky (integerp mouse-1-click-follows-link) - mouse-1-remapped (or (not mouse-1-tricky) - (> mouse-1-click-follows-link 0))) - (if mouse-1-remapped - (setcar ev 'mouse-2))) - (setq defn (or (string-key-binding up-event) (key-binding up-event))) + (setq mouse-1-remapped + (with-current-buffer (window-buffer window) + (mouse-on-link-p (posn-point + (event-start up-event)))))) + (setq mouse-1-tricky (and (integerp mouse-1-click-follows-link) + (> mouse-1-click-follows-link 0))) + (cond ((stringp mouse-1-remapped) + (setq sequence mouse-1-remapped)) + ((vectorp mouse-1-remapped) + (setcar up-event (elt mouse-1-remapped 0))) + (t (setcar up-event 'mouse-2)))) + (setq defn (or (string-key-binding sequence) + (key-binding sequence))) (unless (or (null defn) (integerp defn) (equal defn 'undefined)) (princ (if mouse-1-tricky "\n\n----------------- up-event (short click) ----------------\n\n" hdr)) (setq hdr nil) - (princ descr) + (princ (symbol-name type)) (if (windowp window) (princ " at that spot")) (if mouse-1-remapped @@ -654,26 +750,22 @@ the last key hit are used." (princ "\n which is ") (describe-function-1 defn)) (when mouse-1-tricky - (setcar ev - (if (> mouse-1-click-follows-link 0) 'mouse-1 'mouse-2)) - (setq defn (or (string-key-binding up-event) (key-binding up-event))) - (unless (or (null defn) (integerp defn) (equal defn 'undefined)) + (setcar up-event 'mouse-1) + (setq defn (or (string-key-binding (vector up-event)) + (key-binding (vector up-event)))) + (unless (or (null defn) (integerp defn) (eq defn 'undefined)) (princ (or hdr "\n\n----------------- up-event (long click) ----------------\n\n")) - (princ "Pressing ") - (princ descr) + (princ "Pressing mouse-1") (if (windowp window) (princ " at that spot")) (princ (format " for longer than %d milli-seconds\n" - (abs mouse-1-click-follows-link))) - (if (not mouse-1-remapped) - (princ " remaps it to which" )) + mouse-1-click-follows-link)) (princ " runs the command ") (prin1 defn) (princ "\n which is ") - (describe-function-1 defn)))) - (print-help-return-message)))))))) - + (describe-function-1 defn))))) + (print-help-return-message))))))) (defun describe-mode (&optional buffer) "Display documentation of current major mode and minor modes. @@ -703,32 +795,29 @@ whose documentation describes the minor mode." (dolist (mode minor-mode-list) ;; Document a minor mode if it is listed in minor-mode-alist, ;; non-nil, and has a function definition. - (and (boundp mode) (symbol-value mode) - (fboundp mode) - (let ((pretty-minor-mode mode)) - (if (string-match "\\(-minor\\)?-mode\\'" - (symbol-name mode)) - (setq pretty-minor-mode - (capitalize - (substring (symbol-name mode) - 0 (match-beginning 0))))) - (push (list pretty-minor-mode mode - (format-mode-line (assq mode minor-mode-alist))) - minor-modes)))) - (if auto-fill-function - ;; copy pure string so we can add face property to it below. - (push (list (copy-sequence "Auto Fill") 'auto-fill-mode " Fill") - minor-modes)) + (let ((fmode (or (get mode :minor-mode-function) mode))) + (and (boundp mode) (symbol-value mode) + (fboundp fmode) + (let ((pretty-minor-mode + (if (string-match "\\(\\(-minor\\)?-mode\\)?\\'" + (symbol-name fmode)) + (capitalize + (substring (symbol-name fmode) + 0 (match-beginning 0))) + fmode))) + (push (list fmode pretty-minor-mode + (format-mode-line (assq mode minor-mode-alist))) + minor-modes))))) (setq minor-modes (sort minor-modes - (lambda (a b) (string-lessp (car a) (car b))))) + (lambda (a b) (string-lessp (cadr a) (cadr b))))) (when minor-modes (princ "Summary of minor modes:\n") (make-local-variable 'help-button-cache) (with-current-buffer standard-output (dolist (mode minor-modes) - (let ((pretty-minor-mode (nth 0 mode)) - (mode-function (nth 1 mode)) + (let ((mode-function (nth 0 mode)) + (pretty-minor-mode (nth 1 mode)) (indicator (nth 2 mode))) (setq indicator (if (zerop (length indicator)) "no indicator" @@ -754,8 +843,9 @@ follows the description of the major mode.)\n\n")) ;; Document the major mode. (let ((mode mode-name)) (with-current-buffer standard-output - (insert mode) - (add-text-properties (- (point) (length mode)) (point) '(face bold)))) + (let ((start (point))) + (insert (format-mode-line mode)) + (add-text-properties start (point) '(face bold))))) (princ " mode:\n") (princ (documentation major-mode))) (print-help-return-message)))) @@ -851,7 +941,7 @@ is currently activated with completion." ;;; Automatic resizing of temporary buffers. (defcustom temp-buffer-max-height (lambda (buffer) (/ (- (frame-height) 2) 2)) - "*Maximum height of a window displaying a temporary buffer. + "Maximum height of a window displaying a temporary buffer. This is the maximum height (in text lines) which `resize-temp-buffer-window' will give to a window displaying a temporary buffer. It can also be a function which will be called with the object corresponding @@ -890,8 +980,7 @@ out of view." (funcall temp-buffer-max-height (current-buffer)) temp-buffer-max-height)))) -;; Provide this for the sake of define-minor-mode which generates -;; defcustoms which require 'help'. + (provide 'help) ;; arch-tag: cf427352-27e9-49b7-9a6f-741ebab02423