(help-manyarg-func-alist): Correct several omissions.

[gnu-emacs] / lisp / help.el

diff --git a/lisp/help.el b/lisp/help.el
index 875723f154a18e69c98ca0518c450c16e2f5f212..b36075b81142f95e3114ff04218de93ac7b23e7e 100644 (file)
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -1,6 +1,6 @@
 ;;; help.el --- help commands for Emacs
 
 ;;; help.el --- help commands for Emacs
 

-;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000 Free Software Foundation, Inc.

 
 ;; Maintainer: FSF
 ;; Keywords: help, internal
 
 ;; Maintainer: FSF
 ;; Keywords: help, internal


@@ -104,26 +104,6 @@
 ;; Documentation only, since we use minor-mode-overriding-map-alist.
 (define-key help-mode-map "\r" 'help-follow)
 
 ;; Documentation only, since we use minor-mode-overriding-map-alist.
 (define-key help-mode-map "\r" 'help-follow)
 

-;; Font-locking is incompatible with the new xref stuff.
-;(defvar help-font-lock-keywords
-;  (eval-when-compile
-;    (let ((name-char "[-+a-zA-Z0-9_*]") (sym-char "[-+a-zA-Z0-9_:*]"))
-;      (list
-;       ;;
-;       ;; The symbol itself.
-;       (list (concat "\\`\\(" name-char "+\\)\\(\\(:\\)\\|\\('\\)\\)")
-;           '(1 (if (match-beginning 3)
-;                   font-lock-function-name-face
-;                 font-lock-variable-name-face)))
-;       ;;
-;       ;; Words inside `' which tend to be symbol names.
-;       (list (concat "`\\(" sym-char sym-char "+\\)'")
-;           1 'font-lock-constant-face t)
-;       ;;
-;       ;; CLisp `:' keywords as references.
-;       (list (concat "\\<:" sym-char "+\\>") 0 'font-lock-builtin-face t))))
-;  "Default expressions to highlight in Help mode.")
-

 (defvar help-xref-stack nil
   "A stack of ways by which to return to help buffers after following xrefs.
 Used by `help-follow' and `help-xref-go-back'.
 (defvar help-xref-stack nil
   "A stack of ways by which to return to help buffers after following xrefs.
 Used by `help-follow' and `help-xref-go-back'.


@@ -681,7 +661,8 @@ It can also be nil, if the definition is not associated with any file."
       (save-excursion
        (save-match-data
          (if (re-search-backward "alias for `\\([^`']+\\)'" nil t)
       (save-excursion
        (save-match-data
          (if (re-search-backward "alias for `\\([^`']+\\)'" nil t)

-             (help-xref-button 1 #'describe-function def)))))
+             (help-xref-button 1 #'describe-function def
+                               "mouse-2, RET: describe this function")))))

     (or file-name
        (setq file-name (symbol-file function)))
     (if file-name
     (or file-name
        (setq file-name (symbol-file function)))
     (if file-name


@@ -700,7 +681,8 @@ It can also be nil, if the definition is not associated with any file."
                                             (find-function-noselect arg)))
                                        (pop-to-buffer (car location))
                                        (goto-char (cdr location))))
                                             (find-function-noselect arg)))
                                        (pop-to-buffer (car location))
                                        (goto-char (cdr location))))

-                               function)))))
+                               function
+                               "mouse-2, RET: find function's definition")))))

     (if need-close (princ ")"))
     (princ ".")
     (terpri)
     (if need-close (princ ")"))
     (princ ".")
     (terpri)


@@ -713,21 +695,41 @@ It can also be nil, if the definition is not associated with any file."
                          (car (append def nil)))
                         ((eq (car-safe def) 'lambda)
                          (nth 1 def))
                          (car (append def nil)))
                         ((eq (car-safe def) 'lambda)
                          (nth 1 def))

+                        ((and (eq (car-safe def) 'autoload)
+                              (not (eq (nth 4 def) 'keymap)))
+                         (concat "[Arg list not available until "
+                                 "function definition is loaded.]"))

                         (t t))))
                         (t t))))

-      (if (listp arglist)
-         (progn
-           (princ (cons (if (symbolp function) function "anonymous")
-                        (mapcar (lambda (arg)
-                                  (if (memq arg '(&optional &rest))
-                                      arg
-                                    (intern (upcase (symbol-name arg)))))
-                                arglist)))
-           (terpri))))
+      (cond ((listp arglist)
+            (princ (cons (if (symbolp function) function "anonymous")
+                         (mapcar (lambda (arg)
+                                   (if (memq arg '(&optional &rest))
+                                       arg
+                                     (intern (upcase (symbol-name arg)))))
+                                 arglist)))
+            (terpri))
+           ((stringp arglist)
+            (princ arglist)
+            (terpri))))

     (let ((doc (documentation function)))
       (if doc
          (progn (terpri)
                 (princ doc)
     (let ((doc (documentation function)))
       (if doc
          (progn (terpri)
                 (princ doc)

-                (help-setup-xref (list #'describe-function function) interactive-p))
+                (with-current-buffer standard-output
+                  (beginning-of-line)
+                  ;; Builtins get the calling sequence at the end of
+                  ;; the doc string.  Move it to the same place as
+                  ;; for other functions.
+                  (when (looking-at (format "(%S[ )]" function))
+                    (let ((start (point-marker)))
+                      (goto-char (point-min))
+                      (forward-paragraph)
+                      (insert-buffer-substring (current-buffer) start)
+                      (insert ?\n)
+                      (delete-region (1- start) (point-max))
+                      (goto-char (point-max)))))
+                (help-setup-xref (list #'describe-function function)
+                                 interactive-p))

        (princ "not documented")))))
 
 (defun variable-at-point ()
        (princ "not documented")))))
 
 (defun variable-at-point ()


@@ -790,6 +792,7 @@ Returns the documentation as a string, also."
            (set-buffer standard-output)
            (if (> (count-lines (point-min) (point-max)) 10)
                (progn
            (set-buffer standard-output)
            (if (> (count-lines (point-min) (point-max)) 10)
                (progn

+                 (set-syntax-table emacs-lisp-mode-syntax-table)

                  (goto-char (point-min))
                  (if valvoid
                      (forward-line 1)
                  (goto-char (point-min))
                  (if valvoid
                      (forward-line 1)


@@ -820,7 +823,9 @@ Returns the documentation as a string, also."
                    (re-search-backward 
                     (concat "\\(" customize-label "\\)") nil t)
                    (help-xref-button 1 #'(lambda (v)
                    (re-search-backward 
                     (concat "\\(" customize-label "\\)") nil t)
                    (help-xref-button 1 #'(lambda (v)

-                                           (customize-variable v)) variable)
+                                           (customize-variable v))
+                                     variable
+                                     "mouse-2, RET: customize variable")

                    ))))
          ;; Make a hyperlink to the library if appropriate.  (Don't
          ;; change the format of the buffer's initial line in case
                    ))))
          ;; Make a hyperlink to the library if appropriate.  (Don't
          ;; change the format of the buffer's initial line in case


@@ -833,12 +838,13 @@ Returns the documentation as a string, also."
              (with-current-buffer "*Help*"
                (save-excursion
                  (re-search-backward "`\\([^`']+\\)'" nil t)
              (with-current-buffer "*Help*"
                (save-excursion
                  (re-search-backward "`\\([^`']+\\)'" nil t)

-                 (help-xref-button 1 (lambda (arg)
-                                       (let ((location
-                                              (find-variable-noselect arg)))
-                                         (pop-to-buffer (car location))
-                                         (goto-char (cdr location))))
-                                   variable)))))
+                 (help-xref-button
+                  1 (lambda (arg)
+                      (let ((location
+                             (find-variable-noselect arg)))
+                        (pop-to-buffer (car location))
+                        (goto-char (cdr location))))
+                  variable "mouse-2, RET: find variable's definition")))))

 
          (print-help-return-message)
          (save-excursion
 
          (print-help-return-message)
          (save-excursion


@@ -874,7 +880,7 @@ If INSERT (the prefix arg) is non-nil, insert the message in the buffer."
      (setq val (completing-read (if fn
                                    (format "Where is command (default %s): " fn)
                                  "Where is command: ")
      (setq val (completing-read (if fn
                                    (format "Where is command (default %s): " fn)
                                  "Where is command: ")

-                               obarray 'fboundp t))
+                               obarray 'commandp t))

      (list (if (equal val "")
               fn (intern val))
           current-prefix-arg)))
      (list (if (equal val "")
               fn (intern val))
           current-prefix-arg)))


@@ -966,22 +972,22 @@ Must be previously-defined."
   :version "20.3"
   :type 'face)
 
   :version "20.3"
   :type 'face)
 

-(defvar help-back-label "[back]"
+(defvar help-back-label (purecopy "[back]")

   "Label to use by `help-make-xrefs' for the go-back reference.")
 
   "Label to use by `help-make-xrefs' for the go-back reference.")
 

-(defvar help-xref-symbol-regexp
-  (concat "\\(\\<\\(\\(variable\\|option\\)\\|"
-          "\\(function\\|command\\)\\|"
-          "\\(symbol\\)\\)\\s-+\\)?"
-          ;; Note starting with word-syntax character:
-          "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'")
+(defconst help-xref-symbol-regexp
+  (purecopy (concat "\\(\\<\\(\\(variable\\|option\\)\\|"
+                   "\\(function\\|command\\)\\|"
+                   "\\(symbol\\)\\)\\s-+\\)?"
+                   ;; Note starting with word-syntax character:
+                   "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'"))

   "Regexp matching doc string references to symbols.
 
 The words preceding the quoted symbol can be used in doc strings to
 distinguish references to variables, functions and symbols.")
 
   "Regexp matching doc string references to symbols.
 
 The words preceding the quoted symbol can be used in doc strings to
 distinguish references to variables, functions and symbols.")
 

-(defvar help-xref-info-regexp
-  "\\<[Ii]nfo[ \t\n]+node[ \t\n]+`\\([^']+\\)'"
+(defconst help-xref-info-regexp
+  (purecopy "\\<[Ii]nfo[ \t\n]+node[ \t\n]+`\\([^']+\\)'")

   "Regexp matching doc string references to an Info node.")
 
 (defun help-setup-xref (item interactive-p)
   "Regexp matching doc string references to an Info node.")
 
 (defun help-setup-xref (item interactive-p)


@@ -1030,7 +1036,8 @@ that."
                    (save-match-data
                      (unless (string-match "^([^)]+)" data)
                        (setq data (concat "(emacs)" data))))
                    (save-match-data
                      (unless (string-match "^([^)]+)" data)
                        (setq data (concat "(emacs)" data))))

-                   (help-xref-button 1 #'info data))))
+                   (help-xref-button 1 #'info data
+                                     "mouse-2, RET: read this Info node"))))

               ;; Quoted symbols
               (save-excursion
                 (while (re-search-forward help-xref-symbol-regexp nil t)
               ;; Quoted symbols
               (save-excursion
                 (while (re-search-forward help-xref-symbol-regexp nil t)


@@ -1041,15 +1048,29 @@ that."
                          ((match-string 3) ; `variable' &c
                           (and (boundp sym) ; `variable' doesn't ensure
                                         ; it's actually bound
                          ((match-string 3) ; `variable' &c
                           (and (boundp sym) ; `variable' doesn't ensure
                                         ; it's actually bound

-                               (help-xref-button 6 #'describe-variable sym)))
+                               (help-xref-button
+                               6 #'describe-variable sym
+                               "mouse-2, RET: describe this variable")))

                          ((match-string 4) ; `function' &c
                           (and (fboundp sym) ; similarly
                          ((match-string 4) ; `function' &c
                           (and (fboundp sym) ; similarly

-                               (help-xref-button 6 #'describe-function sym)))
+                               (help-xref-button
+                               6 #'describe-function sym
+                               "mouse-2, RET: describe this function")))

                          ((match-string 5)) ; nothing for symbol
                          ((match-string 5)) ; nothing for symbol

-                         ((or (boundp sym) (fboundp sym))
+                         ((and (boundp sym) (fboundp sym))

                           ;; We can't intuit whether to use the
                           ;; variable or function doc -- supply both.
                           ;; We can't intuit whether to use the
                           ;; variable or function doc -- supply both.

-                          (help-xref-button 6 #'help-xref-interned sym)))))))
+                          (help-xref-button
+                          6 #'help-xref-interned sym
+                          "mouse-2, RET: describe this symbol"))
+                         ((boundp sym)
+                         (help-xref-button
+                          6 #'describe-variable sym
+                          "mouse-2, RET: describe this variable"))
+                        ((fboundp sym)
+                         (help-xref-button
+                          6 #'describe-function sym
+                          "mouse-2, RET: describe this function")))))))

               ;; An obvious case of a key substitution:
               (save-excursion              
                 (while (re-search-forward
               ;; An obvious case of a key substitution:
               (save-excursion              
                 (while (re-search-forward


@@ -1058,7 +1079,9 @@ that."
                         "\\<M-x\\s-+\\(\\sw\\(\\sw\\|-\\)+\\)" nil t)
                   (let ((sym (intern-soft (match-string 1))))
                     (if (fboundp sym)
                         "\\<M-x\\s-+\\(\\sw\\(\\sw\\|-\\)+\\)" nil t)
                   (let ((sym (intern-soft (match-string 1))))
                     (if (fboundp sym)

-                        (help-xref-button 1 #'describe-function sym)))))
+                        (help-xref-button
+                        1 #'describe-function sym
+                        "mouse-2, RET: describe this command")))))

               ;; Look for commands in whole keymap substitutions:
               (save-excursion
                ;; Make sure to find the first keymap.
               ;; Look for commands in whole keymap substitutions:
               (save-excursion
                ;; Make sure to find the first keymap.


@@ -1081,7 +1104,8 @@ that."
                                    (let ((sym (intern-soft (match-string 0))))
                                      (if (fboundp sym)
                                          (help-xref-button 
                                    (let ((sym (intern-soft (match-string 0))))
                                      (if (fboundp sym)
                                          (help-xref-button 

-                                          0 #'describe-function sym))))
+                                          0 #'describe-function sym
+                                         "mouse-2, RET: describe this function"))))

                               (zerop (forward-line)))))))))
           (set-syntax-table stab))
         ;; Make a back-reference in this buffer if appropriate.
                               (zerop (forward-line)))))))))
           (set-syntax-table stab))
         ;; Make a back-reference in this buffer if appropriate.


@@ -1101,13 +1125,14 @@ that."
                          map))))
       (set-buffer-modified-p old-modified))))
 
                          map))))
       (set-buffer-modified-p old-modified))))
 

-(defun help-xref-button (match-number function data)
+(defun help-xref-button (match-number function data &optional help-echo)

   "Make a hyperlink for cross-reference text previously matched.
 
 MATCH-NUMBER is the subexpression of interest in the last matched
 regexp.  FUNCTION is a function to invoke when the button is
 activated, applied to DATA.  DATA may be a single value or a list.
   "Make a hyperlink for cross-reference text previously matched.
 
 MATCH-NUMBER is the subexpression of interest in the last matched
 regexp.  FUNCTION is a function to invoke when the button is
 activated, applied to DATA.  DATA may be a single value or a list.

-See `help-make-xrefs'."
+See `help-make-xrefs'.
+If optional arg HELP-ECHO is supplied, it is used as a help string."

   ;; Don't mung properties we've added specially in some instances.
   (unless (get-text-property (match-beginning match-number) 'help-xref)
     (add-text-properties (match-beginning match-number)
   ;; Don't mung properties we've added specially in some instances.
   (unless (get-text-property (match-beginning match-number) 'help-xref)
     (add-text-properties (match-beginning match-number)


@@ -1117,6 +1142,10 @@ See `help-make-xrefs'."
                                                (if (listp data)
                                                    data
                                                  (list data)))))
                                                (if (listp data)
                                                    data
                                                  (list data)))))

+    (if help-echo
+       (put-text-property (match-beginning match-number)
+                          (match-end match-number)
+                          'help-echo help-echo))

     (if help-highlight-p
        (put-text-property (match-beginning match-number)
                           (match-end match-number)
     (if help-highlight-p
        (put-text-property (match-beginning match-number)
                           (match-end match-number)


@@ -1170,7 +1199,10 @@ help buffer."
              args (cddr item))
        (setq help-xref-stack (cdr help-xref-stack))))
     (apply method args)
              args (cddr item))
        (setq help-xref-stack (cdr help-xref-stack))))
     (apply method args)

-    (goto-char position)))
+    ;; We're not in the right buffer to do this, and we don't actually
+    ;; know which we should be in.
+    ;;(goto-char position)
+    ))

 
 (defun help-go-back ()
   "Invoke the [back] button (if any) in the Help mode buffer."
 
 (defun help-go-back ()
   "Invoke the [back] button (if any) in the Help mode buffer."


@@ -1310,4 +1342,82 @@ out of view."
            (new-height (max (min text-height max-height) min-height)))
       (enlarge-window (- new-height win-height)))))
 
            (new-height (max (min text-height max-height) min-height)))
       (enlarge-window (- new-height win-height)))))
 

+;; `help-manyarg-func-alist' is defined primitively (in doc.c).
+;; New primitives with `MANY' or `UNEVALLED' arglists should be added
+;; to this alist.
+;; The parens and function name are redundant, but it's messy to add
+;; them in `documentation'.
+(defconst help-manyarg-func-alist
+  (purecopy
+   '((list . "(list &rest OBJECTS)")
+     (vector . "(vector &rest OBJECTS)")
+     (make-byte-code . "(make-byte-code &rest ELEMENTS)")
+     (call-process
+      . "(call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS)")
+     (string . "(string &rest CHARACTERS)")
+     (+ . "(+ &rest NUMBERS-OR-MARKERS)")
+     (- . "(- &optional NUMBER-OR-MARKER &rest MORE-NUMBERS-OR-MARKERS)")
+     (* . "(* &rest NUMBERS-OR-MARKERS)")
+     (/ . "(/ DIVIDEND DIVISOR &rest DIVISORS)")
+     (max . "(max NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS)")
+     (min . "(min NUMBER-OR-MARKER &rest NUMBERS-OR-MARKERS)")
+     (logand . "(logand &rest INTS-OR-MARKERS)")
+     (logior . "(logior &rest INTS-OR-MARKERS)")
+     (logxor . "(logxor &rest INTS-OR-MARKERS)")
+     (encode-time
+      . "(encode-time SECOND MINUTE HOUR DAY MONTH YEAR &optional ZONE)")
+     (insert . "(insert &rest ARGS)")
+     (insert-before-markers . "(insert-before-markers &rest ARGS)")
+     (message . "(message STRING &rest ARGUMENTS)")
+     (message-box . "(message-box STRING &rest ARGUMENTS)")
+     (message-or-box . "(message-or-box STRING &rest ARGUMENTS)")
+     (propertize . "(propertize STRING &rest PROPERTIES)")
+     (format . "(format STRING &rest OBJECTS)")
+     (apply . "(apply FUNCTION &rest ARGUMENTS)")
+     (run-hooks . "(run-hooks &rest HOOKS)")
+     (run-hook-with-args . "(run-hook-with-args HOOK &rest ARGS)")
+     (run-hook-with-args-until-failure
+      . "(run-hook-with-args-until-failure HOOK &rest ARGS)")
+     (run-hook-with-args-until-success
+      . "(run-hook-with-args-until-success HOOK &rest ARGS)")
+     (funcall . "(funcall FUNCTION &rest ARGUMENTS)")
+     (append . "(append &rest SEQUENCES)")
+     (concat . "(concat &rest SEQUENCES)")
+     (vconcat . "(vconcat vconcat)")
+     (nconc . "(nconc &rest LISTS)")
+     (widget-apply . "(widget-apply WIDGET PROPERTY &rest ARGS)")
+     (make-hash-table . "(make-hash-table &rest KEYWORD-ARGS)")
+     (insert-string . "(insert-string &rest ARGS)")
+     (start-process . "(start-process NAME BUFFER PROGRAM &rest PROGRAM-ARGS)")
+     (setq-default . "(setq-default SYMBOL VALUE [SYMBOL VALUE...])")
+     (save-excursion . "(save-excursion &rest BODY)")
+     (save-current-buffer . "(save-current-buffer &rest BODY)")
+     (save-restriction . "(save-restriction &rest BODY)")
+     (or . "(or CONDITIONS ...)")
+     (and . "(and CONDITIONS ...)")
+     (if . "(if COND THEN ELSE...)")
+     (cond . "(cond CLAUSES...)")
+     (progn . "(progn BODY ...)")
+     (prog1 . "(prog1 FIRST BODY...)")
+     (prog2 . "(prog2 X Y BODY...)")
+     (setq . "(setq SYM VAL SYM VAL ...)")
+     (quote . "(quote ARG)")
+     (function . "(function ARG)")
+     (defun . "(defun NAME ARGLIST [DOCSTRING] BODY...)")
+     (defmacro . "(defmacro NAME ARGLIST [DOCSTRING] BODY...)")
+     (defvar . "(defvar SYMBOL [INITVALUE DOCSTRING])")
+     (defconst . "(defconst SYMBOL INITVALUE [DOCSTRING])")
+     (let* . "(let* VARLIST BODY...)")
+     (let . "(let VARLIST BODY...)")
+     (while . "(while TEST BODY...)")
+     (catch . "(catch TAG BODY...)")
+     (unwind-protect . "(unwind-protect BODYFORM UNWINDFORMS...)")
+     (condition-case . "(condition-case VAR BODYFORM HANDLERS...)")
+     (track-mouse . "(track-mouse BOFY ...)")
+     (ml-if . "(ml-if COND THEN ELSE...)")
+     (ml-provide-prefix-argument . "(ml-provide-prefix-argument ARG1 ARG2)")
+     (with-output-to-temp-buffer
+        . "(with-output-to-temp-buffer BUFFNAME BODY ...)")
+     (save-window-excursion . "(save-window-excursion BODY ...)"))))
+

 ;;; help.el ends here
 ;;; help.el ends here