lisp/help-fns.el

   1 ;;; help-fns.el --- Complex help functions
   2
   3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001,
   4 ;;   2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Maintainer: FSF
   7 ;; Keywords: help, internal
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;; This file contains those help commands which are complicated, and
  27 ;; which may not be used in every session.  For example
  28 ;; `describe-function' will probably be heavily used when doing elisp
  29 ;; programming, but not if just editing C files.  Simpler help commands
  30 ;; are in help.el
  31
  32 ;;; Code:
  33
  34 (require 'help-mode)
  35
  36 ;; Functions
  37
  38 ;;;###autoload
  39 (defun describe-function (function)
  40   "Display the full documentation of FUNCTION (a symbol)."
  41   (interactive
  42    (let ((fn (function-called-at-point))
  43          (enable-recursive-minibuffers t)
  44          val)
  45      (setq val (completing-read (if fn
  46                                     (format "Describe function (default %s): " fn)
  47                                   "Describe function: ")
  48                                 obarray 'fboundp t nil nil
  49                                 (and fn (symbol-name fn))))
  50      (list (if (equal val "")
  51                fn (intern val)))))
  52   (if (null function)
  53       (message "You didn't specify a function")
  54     (help-setup-xref (list #'describe-function function) (interactive-p))
  55     (save-excursion
  56       (with-help-window (help-buffer)
  57         (prin1 function)
  58         ;; Use " is " instead of a colon so that
  59         ;; it is easier to get out the function name using forward-sexp.
  60         (princ " is ")
  61         (describe-function-1 function)
  62         (with-current-buffer standard-output
  63           ;; Return the text we displayed.
  64           (buffer-string))))))
  65
  66 (defun help-split-fundoc (docstring def)
  67   "Split a function DOCSTRING into the actual doc and the usage info.
  68 Return (USAGE . DOC) or nil if there's no usage info.
  69 DEF is the function whose usage we're looking for in DOCSTRING."
  70   ;; Functions can get the calling sequence at the end of the doc string.
  71   ;; In cases where `function' has been fset to a subr we can't search for
  72   ;; function's name in the doc string so we use `fn' as the anonymous
  73   ;; function name instead.
  74   (when (and docstring (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring))
  75     (cons (format "(%s%s"
  76                   ;; Replace `fn' with the actual function name.
  77                   (if (consp def) "anonymous" def)
  78                   (match-string 1 docstring))
  79           (substring docstring 0 (match-beginning 0)))))
  80
  81 (defun help-add-fundoc-usage (docstring arglist)
  82   "Add the usage info to DOCSTRING.
  83 If DOCSTRING already has a usage info, then just return it unchanged.
  84 The usage info is built from ARGLIST.  DOCSTRING can be nil.
  85 ARGLIST can also be t or a string of the form \"(FUN ARG1 ARG2 ...)\"."
  86   (unless (stringp docstring) (setq docstring "Not documented"))
  87   (if (or (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring) (eq arglist t))
  88       docstring
  89     (concat docstring
  90             (if (string-match "\n?\n\\'" docstring)
  91                 (if (< (- (match-end 0) (match-beginning 0)) 2) "\n" "")
  92               "\n\n")
  93             (if (and (stringp arglist)
  94                      (string-match "\\`([^ ]+\\(.*\\))\\'" arglist))
  95                 (concat "(fn" (match-string 1 arglist) ")")
  96               (format "%S" (help-make-usage 'fn arglist))))))
  97
  98 (defun help-function-arglist (def)
  99   ;; Handle symbols aliased to other symbols.
 100   (if (and (symbolp def) (fboundp def)) (setq def (indirect-function def)))
 101   ;; If definition is a macro, find the function inside it.
 102   (if (eq (car-safe def) 'macro) (setq def (cdr def)))
 103   (cond
 104    ((byte-code-function-p def) (aref def 0))
 105    ((eq (car-safe def) 'lambda) (nth 1 def))
 106    ((and (eq (car-safe def) 'autoload) (not (eq (nth 4 def) 'keymap)))
 107     "[Arg list not available until function definition is loaded.]")
 108    (t t)))
 109
 110 (defun help-make-usage (function arglist)
 111   (cons (if (symbolp function) function 'anonymous)
 112         (mapcar (lambda (arg)
 113                   (if (not (symbolp arg))
 114                       (if (and (consp arg) (symbolp (car arg)))
 115                           ;; CL style default values for optional args.
 116                           (cons (intern (upcase (symbol-name (car arg))))
 117                                 (cdr arg))
 118                         arg)
 119                     (let ((name (symbol-name arg)))
 120                       (if (string-match "\\`&" name) arg
 121                         (intern (upcase name))))))
 122                 arglist)))
 123
 124 ;; Could be this, if we make symbol-file do the work below.
 125 ;; (defun help-C-file-name (subr-or-var kind)
 126 ;;   "Return the name of the C file where SUBR-OR-VAR is defined.
 127 ;; KIND should be `var' for a variable or `subr' for a subroutine."
 128 ;;   (symbol-file (if (symbolp subr-or-var) subr-or-var
 129 ;;               (subr-name subr-or-var))
 130 ;;             (if (eq kind 'var) 'defvar 'defun)))
 131 ;;;###autoload
 132 (defun help-C-file-name (subr-or-var kind)
 133   "Return the name of the C file where SUBR-OR-VAR is defined.
 134 KIND should be `var' for a variable or `subr' for a subroutine."
 135   (let ((docbuf (get-buffer-create " *DOC*"))
 136         (name (if (eq 'var kind)
 137                   (concat "V" (symbol-name subr-or-var))
 138                 (concat "F" (subr-name subr-or-var)))))
 139     (with-current-buffer docbuf
 140       (goto-char (point-min))
 141       (if (eobp)
 142           (insert-file-contents-literally
 143            (expand-file-name internal-doc-file-name doc-directory)))
 144       (let ((file (catch 'loop
 145                     (while t
 146                       (let ((pnt (search-forward (concat "\1f" name "\n"))))
 147                         (re-search-backward "\1fS\\(.*\\)")
 148                         (let ((file (match-string 1)))
 149                           (if (member file build-files)
 150                               (throw 'loop file)
 151                             (goto-char pnt))))))))
 152         (if (string-match "^ns.*\\(\\.o\\|obj\\)\\'" file)
 153             (setq file (replace-match ".m" t t file 1))
 154           (if (string-match "\\.\\(o\\|obj\\)\\'" file)
 155               (setq file (replace-match ".c" t t file))))
 156         (if (string-match "\\.\\(c\\|m\\)\\'" file)
 157             (concat "src/" file)
 158           file)))))
 159
 160 (defface help-argument-name '((((supports :slant italic)) :inherit italic))
 161   "Face to highlight argument names in *Help* buffers."
 162   :group 'help)
 163
 164 (defun help-default-arg-highlight (arg)
 165   "Default function to highlight arguments in *Help* buffers.
 166 It returns ARG in face `help-argument-name'; ARG is also
 167 downcased if it displays differently than the default
 168 face (according to `face-differs-from-default-p')."
 169   (propertize (if (face-differs-from-default-p 'help-argument-name)
 170                   (downcase arg)
 171                 arg)
 172               'face 'help-argument-name))
 173
 174 (defun help-do-arg-highlight (doc args)
 175   (with-syntax-table (make-syntax-table emacs-lisp-mode-syntax-table)
 176     (modify-syntax-entry ?\- "w")
 177     (dolist (arg args doc)
 178       (setq doc (replace-regexp-in-string
 179                  ;; This is heuristic, but covers all common cases
 180                  ;; except ARG1-ARG2
 181                  (concat "\\<"                   ; beginning of word
 182                          "\\(?:[a-z-]*-\\)?"     ; for xxx-ARG
 183                          "\\("
 184                          (regexp-quote arg)
 185                          "\\)"
 186                          "\\(?:es\\|s\\|th\\)?"  ; for ARGth, ARGs
 187                          "\\(?:-[a-z0-9-]+\\)?"  ; for ARG-xxx, ARG-n
 188                          "\\(?:-[{([<`\"].*?\\)?"; for ARG-{x}, (x), <x>, [x], `x'
 189                          "\\>")                  ; end of word
 190                  (help-default-arg-highlight arg)
 191                  doc t t 1)))))
 192
 193 (defun help-highlight-arguments (usage doc &rest args)
 194   (when usage
 195     (with-temp-buffer
 196       (insert usage)
 197       (goto-char (point-min))
 198       (let ((case-fold-search nil)
 199             (next (not (or args (looking-at "\\["))))
 200             (opt nil))
 201         ;; Make a list of all arguments
 202         (skip-chars-forward "^ ")
 203         (while next
 204           (or opt (not (looking-at " &")) (setq opt t))
 205           (if (not (re-search-forward " \\([\\[(]*\\)\\([^] &)\.]+\\)" nil t))
 206               (setq next nil)
 207             (setq args (cons (match-string 2) args))
 208             (when (and opt (string= (match-string 1) "("))
 209               ;; A pesky CL-style optional argument with default value,
 210               ;; so let's skip over it
 211               (search-backward "(")
 212               (goto-char (scan-sexps (point) 1)))))
 213         ;; Highlight aguments in the USAGE string
 214         (setq usage (help-do-arg-highlight (buffer-string) args))
 215         ;; Highlight arguments in the DOC string
 216         (setq doc (and doc (help-do-arg-highlight doc args))))))
 217   ;; Return value is like the one from help-split-fundoc, but highlighted
 218   (cons usage doc))
 219
 220 ;; The following function was compiled from the former functions
 221 ;; `describe-simplify-lib-file-name' and `find-source-lisp-file' with
 222 ;; some excerpts from `describe-function-1' and `describe-variable'.
 223 ;; The only additional twists provided are (1) locate the defining file
 224 ;; for autoloaded functions, and (2) give preference to files in the
 225 ;; "install directory" (directories found via `load-path') rather than
 226 ;; to files in the "compile directory" (directories found by searching
 227 ;; the loaddefs.el file).  We autoload it because it's also used by
 228 ;; `describe-face' (instead of `describe-simplify-lib-file-name').
 229
 230 ;;;###autoload
 231 (defun find-lisp-object-file-name (object type)
 232   "Guess the file that defined the Lisp object OBJECT, of type TYPE.
 233 OBJECT should be a symbol associated with a function, variable, or face;
 234   alternatively, it can be a function definition.
 235 If TYPE is `variable', search for a variable definition.
 236 If TYPE is `face', search for a face definition.
 237 If TYPE is the value returned by `symbol-function' for a function symbol,
 238  search for a function definition.
 239
 240 The return value is the absolute name of a readable file where OBJECT is
 241 defined.  If several such files exist, preference is given to a file
 242 found via `load-path'.  The return value can also be `C-source', which
 243 means that OBJECT is a function or variable defined in C.  If no
 244 suitable file is found, return nil."
 245   (let* ((autoloaded (eq (car-safe type) 'autoload))
 246          (file-name (or (and autoloaded (nth 1 type))
 247                         (symbol-file
 248                          object (if (memq type (list 'defvar 'defface))
 249                                     type
 250                                   'defun)))))
 251     (cond
 252      (autoloaded
 253       ;; An autoloaded function: Locate the file since `symbol-function'
 254       ;; has only returned a bare string here.
 255       (setq file-name
 256             (locate-file file-name load-path '(".el" ".elc") 'readable)))
 257      ((and (stringp file-name)
 258            (string-match "[.]*loaddefs.el\\'" file-name))
 259       ;; An autoloaded variable or face.  Visit loaddefs.el in a buffer
 260       ;; and try to extract the defining file.  The following form is
 261       ;; from `describe-function-1' and `describe-variable'.
 262       (let ((location
 263              (condition-case nil
 264                  (find-function-search-for-symbol object nil file-name)
 265                (error nil))))
 266         (when location
 267           (with-current-buffer (car location)
 268             (goto-char (cdr location))
 269             (when (re-search-backward
 270                    "^;;; Generated autoloads from \\(.*\\)" nil t)
 271               (setq file-name
 272                     (locate-file
 273                      (match-string-no-properties 1)
 274                      load-path nil 'readable))))))))
 275
 276     (cond
 277      ((and (not file-name) (subrp type))
 278       ;; A built-in function.  The form is from `describe-function-1'.
 279       (if (get-buffer " *DOC*")
 280           (help-C-file-name type 'subr)
 281         'C-source))
 282      ((and (not file-name) (symbolp object)
 283            (integerp (get object 'variable-documentation)))
 284       ;; A variable defined in C.  The form is from `describe-variable'.
 285       (if (get-buffer " *DOC*")
 286           (help-C-file-name object 'var)
 287         'C-source))
 288      ((not (stringp file-name))
 289       ;; If we don't have a file-name string by now, we lost.
 290       nil)
 291      ((let ((lib-name
 292              (if (string-match "[.]elc\\'" file-name)
 293                  (substring-no-properties file-name 0 -1)
 294                file-name)))
 295         ;; When the Elisp source file can be found in the install
 296         ;; directory return the name of that file - `file-name' should
 297         ;; have become an absolute file name ny now.
 298         (or (and (file-readable-p lib-name) lib-name)
 299             ;; The library might be compressed.
 300             (and (file-readable-p (concat lib-name ".gz")) lib-name))))
 301      ((let* ((lib-name (file-name-nondirectory file-name))
 302              ;; The next form is from `describe-simplify-lib-file-name'.
 303              (file-name
 304               ;; Try converting the absolute file name to a library
 305               ;; name, convert that back to a file name and see if we
 306               ;; get the original one.  If so, they are equivalent.
 307               (if (equal file-name (locate-file lib-name load-path '("")))
 308                   (if (string-match "[.]elc\\'" lib-name)
 309                       (substring-no-properties lib-name 0 -1)
 310                     lib-name)
 311                 file-name))
 312              ;; The next three forms are from `find-source-lisp-file'.
 313              (elc-file (locate-file
 314                         (concat file-name
 315                                 (if (string-match "\\.el\\'" file-name)
 316                                     "c"
 317                                   ".elc"))
 318                         load-path nil 'readable))
 319              (str (when elc-file
 320                     (with-temp-buffer
 321                       (insert-file-contents-literally elc-file nil 0 256)
 322                       (buffer-string))))
 323              (src-file (and str
 324                             (string-match ";;; from file \\(.*\\.el\\)" str)
 325                             (match-string 1 str))))
 326         (and src-file (file-readable-p src-file) src-file))))))
 327
 328 (declare-function ad-get-advice-info "advice" (function))
 329
 330 ;;;###autoload
 331 (defun describe-function-1 (function)
 332   (let* ((advised (and (symbolp function) (featurep 'advice)
 333                        (ad-get-advice-info function)))
 334          ;; If the function is advised, use the symbol that has the
 335          ;; real definition, if that symbol is already set up.
 336          (real-function
 337           (or (and advised
 338                    (let ((origname (cdr (assq 'origname advised))))
 339                      (and (fboundp origname) origname)))
 340               function))
 341          ;; Get the real definition.
 342          (def (if (symbolp real-function)
 343                   (symbol-function real-function)
 344                 function))
 345          file-name string
 346          (beg (if (commandp def) "an interactive " "a "))
 347          (pt1 (with-current-buffer (help-buffer) (point)))
 348          errtype)
 349     (setq string
 350           (cond ((or (stringp def)
 351                      (vectorp def))
 352                  "a keyboard macro")
 353                 ((subrp def)
 354                  (if (eq 'unevalled (cdr (subr-arity def)))
 355                      (concat beg "special form")
 356                    (concat beg "built-in function")))
 357                 ((byte-code-function-p def)
 358                  (concat beg "compiled Lisp function"))
 359                 ((symbolp def)
 360                  (while (and (fboundp def)
 361                              (symbolp (symbol-function def)))
 362                    (setq def (symbol-function def)))
 363                  ;; Handle (defalias 'foo 'bar), where bar is undefined.
 364                  (or (fboundp def) (setq errtype 'alias))
 365                  (format "an alias for `%s'" def))
 366                 ((eq (car-safe def) 'lambda)
 367                  (concat beg "Lisp function"))
 368                 ((eq (car-safe def) 'macro)
 369                  "a Lisp macro")
 370                 ((eq (car-safe def) 'autoload)
 371                  (format "%s autoloaded %s"
 372                          (if (commandp def) "an interactive" "an")
 373                          (if (eq (nth 4 def) 'keymap) "keymap"
 374                            (if (nth 4 def) "Lisp macro" "Lisp function"))))
 375                 ((keymapp def)
 376                  (let ((is-full nil)
 377                        (elts (cdr-safe def)))
 378                    (while elts
 379                      (if (char-table-p (car-safe elts))
 380                          (setq is-full t
 381                                elts nil))
 382                      (setq elts (cdr-safe elts)))
 383                    (if is-full
 384                        "a full keymap"
 385                      "a sparse keymap")))
 386                 (t "")))
 387     (princ string)
 388     (if (eq errtype 'alias)
 389         (princ ",\nwhich is not defined.  Please make a bug report.")
 390       (with-current-buffer standard-output
 391         (save-excursion
 392           (save-match-data
 393             (when (re-search-backward "alias for `\\([^`']+\\)'" nil t)
 394               (help-xref-button 1 'help-function def)))))
 395
 396       (setq file-name (find-lisp-object-file-name function def))
 397       (when file-name
 398         (princ " in `")
 399         ;; We used to add .el to the file name,
 400         ;; but that's completely wrong when the user used load-file.
 401         (princ (if (eq file-name 'C-source)
 402                    "C source code"
 403                  (file-name-nondirectory file-name)))
 404         (princ "'")
 405         ;; Make a hyperlink to the library.
 406         (with-current-buffer standard-output
 407           (save-excursion
 408             (re-search-backward "`\\([^`']+\\)'" nil t)
 409             (help-xref-button 1 'help-function-def real-function file-name))))
 410       (princ ".")
 411       (with-current-buffer (help-buffer)
 412         (fill-region-as-paragraph (save-excursion (goto-char pt1) (forward-line 0) (point))
 413                                   (point)))
 414       (terpri)(terpri)
 415       (when (commandp function)
 416         (let ((pt2 (with-current-buffer (help-buffer) (point))))
 417           (if (and (eq function 'self-insert-command)
 418                    (eq (key-binding "a") 'self-insert-command)
 419                    (eq (key-binding "b") 'self-insert-command)
 420                    (eq (key-binding "c") 'self-insert-command))
 421               (princ "It is bound to many ordinary text characters.\n")
 422             (let* ((remapped (command-remapping function))
 423                    (keys (where-is-internal
 424                           (or remapped function) overriding-local-map nil nil))
 425                    non-modified-keys)
 426               ;; Which non-control non-meta keys run this command?
 427               (dolist (key keys)
 428                 (if (member (event-modifiers (aref key 0)) '(nil (shift)))
 429                     (push key non-modified-keys)))
 430               (when remapped
 431                 (princ "It is remapped to `")
 432                 (princ (symbol-name remapped))
 433                 (princ "'"))
 434
 435               (when keys
 436                 (princ (if remapped ", which is bound to " "It is bound to "))
 437                 ;; If lots of ordinary text characters run this command,
 438                 ;; don't mention them one by one.
 439                 (if (< (length non-modified-keys) 10)
 440                     (princ (mapconcat 'key-description keys ", "))
 441                   (dolist (key non-modified-keys)
 442                     (setq keys (delq key keys)))
 443                   (if keys
 444                       (progn
 445                         (princ (mapconcat 'key-description keys ", "))
 446                         (princ ", and many ordinary text characters"))
 447                     (princ "many ordinary text characters"))))
 448               (when (or remapped keys non-modified-keys)
 449                 (princ ".")
 450                 (terpri))))
 451           (with-current-buffer (help-buffer)
 452             (fill-region-as-paragraph pt2 (point))
 453             (unless (looking-back "\n\n")
 454               (terpri)))))
 455       (let* ((arglist (help-function-arglist def))
 456              (doc (documentation function))
 457              (usage (help-split-fundoc doc function)))
 458         (with-current-buffer standard-output
 459           ;; If definition is a keymap, skip arglist note.
 460           (unless (keymapp function)
 461             (let* ((use (cond
 462                          (usage (setq doc (cdr usage)) (car usage))
 463                          ((listp arglist)
 464                           (format "%S" (help-make-usage function arglist)))
 465                          ((stringp arglist) arglist)
 466                          ;; Maybe the arglist is in the docstring of a symbol
 467                          ;; this one is aliased to.
 468                          ((let ((fun real-function))
 469                             (while (and (symbolp fun)
 470                                         (setq fun (symbol-function fun))
 471                                         (not (setq usage (help-split-fundoc
 472                                                           (documentation fun)
 473                                                           function)))))
 474                             usage)
 475                           (car usage))
 476                          ((or (stringp def)
 477                               (vectorp def))
 478                           (format "\nMacro: %s" (format-kbd-macro def)))
 479                          (t "[Missing arglist.  Please make a bug report.]")))
 480                    (high (help-highlight-arguments use doc)))
 481               (let ((fill-begin (point)))
 482                 (insert (car high) "\n")
 483                 (fill-region fill-begin (point)))
 484               (setq doc (cdr high))))
 485           (let* ((obsolete (and
 486                             ;; function might be a lambda construct.
 487                             (symbolp function)
 488                             (get function 'byte-obsolete-info)))
 489                  (use (car obsolete)))
 490             (when obsolete
 491               (princ "\nThis function is obsolete")
 492               (when (nth 2 obsolete)
 493                 (insert (format " since %s" (nth 2 obsolete))))
 494               (insert (cond ((stringp use) (concat ";\n" use))
 495                             (use (format ";\nuse `%s' instead." use))
 496                             (t "."))
 497                       "\n"))
 498             (insert "\n"
 499                     (or doc "Not documented."))))))))
 500
 501 \f
 502 ;; Variables
 503
 504 ;;;###autoload
 505 (defun variable-at-point (&optional any-symbol)
 506   "Return the bound variable symbol found at or before point.
 507 Return 0 if there is no such symbol.
 508 If ANY-SYMBOL is non-nil, don't insist the symbol be bound."
 509   (with-syntax-table emacs-lisp-mode-syntax-table
 510     (or (condition-case ()
 511             (save-excursion
 512               (or (not (zerop (skip-syntax-backward "_w")))
 513                   (eq (char-syntax (following-char)) ?w)
 514                   (eq (char-syntax (following-char)) ?_)
 515                   (forward-sexp -1))
 516               (skip-chars-forward "'")
 517               (let ((obj (read (current-buffer))))
 518                 (and (symbolp obj) (boundp obj) obj)))
 519           (error nil))
 520         (let* ((str (find-tag-default))
 521                (sym (if str (intern-soft str))))
 522           (if (and sym (or any-symbol (boundp sym)))
 523               sym
 524             (save-match-data
 525               (when (and str (string-match "\\`\\W*\\(.*?\\)\\W*\\'" str))
 526                 (setq sym (intern-soft (match-string 1 str)))
 527                 (and (or any-symbol (boundp sym)) sym)))))
 528         0)))
 529
 530 (defun describe-variable-custom-version-info (variable)
 531   (let ((custom-version (get variable 'custom-version))
 532         (cpv (get variable 'custom-package-version))
 533         (output nil))
 534     (if custom-version
 535         (setq output
 536               (format "This variable was introduced, or its default value was changed, in\nversion %s of Emacs.\n"
 537                       custom-version))
 538       (when cpv
 539         (let* ((package (car-safe cpv))
 540                (version (if (listp (cdr-safe cpv))
 541                             (car (cdr-safe cpv))
 542                           (cdr-safe cpv)))
 543                (pkg-versions (assq package customize-package-emacs-version-alist))
 544                (emacsv (cdr (assoc version pkg-versions))))
 545           (if (and package version)
 546               (setq output
 547                     (format (concat "This variable was introduced, or its default value was changed, in\nversion %s of the %s package"
 548                                     (if emacsv
 549                                         (format " that is part of Emacs %s" emacsv))
 550                                     ".\n")
 551                             version package))))))
 552     output))
 553
 554 ;;;###autoload
 555 (defun describe-variable (variable &optional buffer frame)
 556   "Display the full documentation of VARIABLE (a symbol).
 557 Returns the documentation as a string, also.
 558 If VARIABLE has a buffer-local value in BUFFER or FRAME
 559 \(default to the current buffer and current frame),
 560 it is displayed along with the global value."
 561   (interactive
 562    (let ((v (variable-at-point))
 563          (enable-recursive-minibuffers t)
 564          val)
 565      (setq val (completing-read (if (symbolp v)
 566                                     (format
 567                                      "Describe variable (default %s): " v)
 568                                   "Describe variable: ")
 569                                 obarray
 570                                 '(lambda (vv)
 571                                    (or (boundp vv)
 572                                        (get vv 'variable-documentation)))
 573                                 t nil nil
 574                                 (if (symbolp v) (symbol-name v))))
 575      (list (if (equal val "")
 576                v (intern val)))))
 577   (let (file-name)
 578     (unless (buffer-live-p buffer) (setq buffer (current-buffer)))
 579     (unless (frame-live-p frame) (setq frame (selected-frame)))
 580     (if (not (symbolp variable))
 581         (message "You did not specify a variable")
 582       (save-excursion
 583         (let ((valvoid (not (with-current-buffer buffer (boundp variable))))
 584               val val-start-pos locus)
 585           ;; Extract the value before setting up the output buffer,
 586           ;; in case `buffer' *is* the output buffer.
 587           (unless valvoid
 588             (with-selected-frame frame
 589               (with-current-buffer buffer
 590                 (setq val (symbol-value variable)
 591                       locus (variable-binding-locus variable)))))
 592           (help-setup-xref (list #'describe-variable variable buffer)
 593                            (interactive-p))
 594           (with-help-window (help-buffer)
 595             (with-current-buffer buffer
 596               (prin1 variable)
 597               (setq file-name (find-lisp-object-file-name variable 'defvar))
 598
 599               (if file-name
 600                   (progn
 601                     (princ " is a variable defined in `")
 602                     (princ (if (eq file-name 'C-source)
 603                                "C source code"
 604                              (file-name-nondirectory file-name)))
 605                     (princ "'.\n")
 606                     (with-current-buffer standard-output
 607                       (save-excursion
 608                         (re-search-backward "`\\([^`']+\\)'" nil t)
 609                         (help-xref-button 1 'help-variable-def
 610                                           variable file-name)))
 611                     (if valvoid
 612                         (princ "It is void as a variable.")
 613                       (princ "Its ")))
 614                 (if valvoid
 615                     (princ " is void as a variable.")
 616                   (princ "'s "))))
 617             (if valvoid
 618                 nil
 619               (with-current-buffer standard-output
 620                 (setq val-start-pos (point))
 621                 (princ "value is ")
 622                 (terpri)
 623                 (let ((from (point)))
 624                   (pp val)
 625                   ;; Hyperlinks in variable's value are quite frequently
 626                   ;; inappropriate e.g C-h v <RET> features <RET>
 627                   ;; (help-xref-on-pp from (point))
 628                   (if (< (point) (+ from 20))
 629                       (delete-region (1- from) from)))))
 630             (terpri)
 631
 632             (when locus
 633               (if (bufferp locus)
 634                   (princ (format "%socal in buffer %s; "
 635                                  (if (get variable 'permanent-local)
 636                                      "Permanently l" "L")
 637                                  (buffer-name)))
 638                 (princ (format "It is a frame-local variable; ")))
 639               (if (not (default-boundp variable))
 640                   (princ "globally void")
 641                 (let ((val (default-value variable)))
 642                   (with-current-buffer standard-output
 643                     (princ "global value is ")
 644                     (terpri)
 645                     ;; Fixme: pp can take an age if you happen to
 646                     ;; ask for a very large expression.  We should
 647                     ;; probably print it raw once and check it's a
 648                     ;; sensible size before prettyprinting.  -- fx
 649                     (let ((from (point)))
 650                       (pp val)
 651                       ;; See previous comment for this function.
 652                       ;; (help-xref-on-pp from (point))
 653                       (if (< (point) (+ from 20))
 654                           (delete-region (1- from) from))))))
 655               (terpri))
 656
 657             ;; If the value is large, move it to the end.
 658             (with-current-buffer standard-output
 659               (when (> (count-lines (point-min) (point-max)) 10)
 660                 ;; Note that setting the syntax table like below
 661                 ;; makes forward-sexp move over a `'s' at the end
 662                 ;; of a symbol.
 663                 (set-syntax-table emacs-lisp-mode-syntax-table)
 664                 (goto-char val-start-pos)
 665                 ;; The line below previously read as
 666                 ;; (delete-region (point) (progn (end-of-line) (point)))
 667                 ;; which suppressed display of the buffer local value for
 668                 ;; large values.
 669                 (when (looking-at "value is") (replace-match ""))
 670                 (save-excursion
 671                   (insert "\n\nValue:")
 672                   (set (make-local-variable 'help-button-cache)
 673                        (point-marker)))
 674                 (insert "value is shown ")
 675                 (insert-button "below"
 676                                'action help-button-cache
 677                                'follow-link t
 678                                'help-echo "mouse-2, RET: show value")
 679                 (insert ".\n")))
 680             (terpri)
 681
 682             (let* ((alias (condition-case nil
 683                               (indirect-variable variable)
 684                             (error variable)))
 685                    (obsolete (get variable 'byte-obsolete-variable))
 686                    (use (car obsolete))
 687                    (safe-var (get variable 'safe-local-variable))
 688                    (doc (or (documentation-property variable 'variable-documentation)
 689                             (documentation-property alias 'variable-documentation)))
 690                    (extra-line nil))
 691               ;; Add a note for variables that have been make-var-buffer-local.
 692               (when (and (local-variable-if-set-p variable)
 693                          (or (not (local-variable-p variable))
 694                              (with-temp-buffer
 695                                (local-variable-if-set-p variable))))
 696                 (setq extra-line t)
 697                 (princ "  Automatically becomes buffer-local when set in any fashion.\n"))
 698
 699               ;; Mention if it's an alias
 700               (unless (eq alias variable)
 701                 (setq extra-line t)
 702                 (princ (format "  This variable is an alias for `%s'.\n" alias)))
 703
 704               (when obsolete
 705                 (setq extra-line t)
 706                 (princ "  This variable is obsolete")
 707                 (if (cdr obsolete) (princ (format " since %s" (cdr obsolete))))
 708                 (princ (cond ((stringp use) (concat ";\n  " use))
 709                              (use (format ";\n  use `%s' instead." (car obsolete)))
 710                              (t ".")))
 711                 (terpri))
 712               (when safe-var
 713                 (setq extra-line t)
 714                 (princ "  This variable is safe as a file local variable ")
 715                 (princ "if its value\n  satisfies the predicate ")
 716                 (princ (if (byte-code-function-p safe-var)
 717                            "which is byte-compiled expression.\n"
 718                          (format "`%s'.\n" safe-var))))
 719
 720               (if extra-line (terpri))
 721               (princ "Documentation:\n")
 722               (with-current-buffer standard-output
 723                 (insert (or doc "Not documented as a variable."))))
 724
 725             ;; Make a link to customize if this variable can be customized.
 726             (when (custom-variable-p variable)
 727               (let ((customize-label "customize"))
 728                 (terpri)
 729                 (terpri)
 730                 (princ (concat "You can " customize-label " this variable."))
 731                 (with-current-buffer standard-output
 732                   (save-excursion
 733                     (re-search-backward
 734                      (concat "\\(" customize-label "\\)") nil t)
 735                     (help-xref-button 1 'help-customize-variable variable))))
 736               ;; Note variable's version or package version
 737               (let ((output (describe-variable-custom-version-info variable)))
 738                 (when output
 739                   (terpri)
 740                   (terpri)
 741                   (princ output))))
 742
 743             (save-excursion
 744               (set-buffer standard-output)
 745               ;; Return the text we displayed.
 746               (buffer-string))))))))
 747
 748
 749 ;;;###autoload
 750 (defun describe-syntax (&optional buffer)
 751   "Describe the syntax specifications in the syntax table of BUFFER.
 752 The descriptions are inserted in a help buffer, which is then displayed.
 753 BUFFER defaults to the current buffer."
 754   (interactive)
 755   (setq buffer (or buffer (current-buffer)))
 756   (help-setup-xref (list #'describe-syntax buffer) (interactive-p))
 757   (with-help-window (help-buffer)
 758     (let ((table (with-current-buffer buffer (syntax-table))))
 759       (with-current-buffer standard-output
 760         (describe-vector table 'internal-describe-syntax-value)
 761         (while (setq table (char-table-parent table))
 762           (insert "\nThe parent syntax table is:")
 763           (describe-vector table 'internal-describe-syntax-value))))))
 764
 765 (defun help-describe-category-set (value)
 766   (insert (cond
 767            ((null value) "default")
 768            ((char-table-p value) "deeper char-table ...")
 769            (t (condition-case err
 770                   (category-set-mnemonics value)
 771                 (error "invalid"))))))
 772
 773 ;;;###autoload
 774 (defun describe-categories (&optional buffer)
 775   "Describe the category specifications in the current category table.
 776 The descriptions are inserted in a buffer, which is then displayed.
 777 If BUFFER is non-nil, then describe BUFFER's category table instead.
 778 BUFFER should be a buffer or a buffer name."
 779   (interactive)
 780   (setq buffer (or buffer (current-buffer)))
 781   (help-setup-xref (list #'describe-categories buffer) (interactive-p))
 782   (with-help-window (help-buffer)
 783     (let* ((table (with-current-buffer buffer (category-table)))
 784            (docs (char-table-extra-slot table 0)))
 785       (if (or (not (vectorp docs)) (/= (length docs) 95))
 786           (error "Invalid first extra slot in this category table\n"))
 787       (with-current-buffer standard-output
 788         (insert "Legend of category mnemonics (see the tail for the longer description)\n")
 789         (let ((pos (point)) (items 0) lines n)
 790           (dotimes (i 95)
 791             (if (aref docs i) (setq items (1+ items))))
 792           (setq lines (1+ (/ (1- items) 4)))
 793           (setq n 0)
 794           (dotimes (i 95)
 795             (let ((elt (aref docs i)))
 796               (when elt
 797                 (string-match ".*" elt)
 798                 (setq elt (match-string 0 elt))
 799                 (if (>= (length elt) 17)
 800                     (setq elt (concat (substring elt 0 14) "...")))
 801                 (if (< (point) (point-max))
 802                     (move-to-column (* 20 (/ n lines)) t))
 803                 (insert (+ i ?\s) ?: elt)
 804                 (if (< (point) (point-max))
 805                     (forward-line 1)
 806                   (insert "\n"))
 807                 (setq n (1+ n))
 808                 (if (= (% n lines) 0)
 809                     (goto-char pos))))))
 810         (goto-char (point-max))
 811         (insert "\n"
 812                 "character(s)\tcategory mnemonics\n"
 813                 "------------\t------------------")
 814         (describe-vector table 'help-describe-category-set)
 815         (insert "Legend of category mnemonics:\n")
 816         (dotimes (i 95)
 817           (let ((elt (aref docs i)))
 818             (when elt
 819               (if (string-match "\n" elt)
 820                   (setq elt (substring elt (match-end 0))))
 821               (insert (+ i ?\s) ": " elt "\n"))))
 822         (while (setq table (char-table-parent table))
 823           (insert "\nThe parent category table is:")
 824           (describe-vector table 'help-describe-category-set))))))
 825
 826 (provide 'help-fns)
 827
 828 ;; arch-tag: 9e10331c-ae81-4d13-965d-c4819aaab0b3
 829 ;;; help-fns.el ends here