| blob | 4fcbdeb633046d791bc4d27443ddd13e82a5524c |
1 ;;; info.el --- info package for Emacs
3 ;; Copyright (C) 1985,86,92,93,94,95,96,97,98,99,2000,01,02,03,2004
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: help
9 ;; This file is part of GNU Emacs.
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 2, or (at your option)
14 ;; any later version.
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.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;; Note that nowadays we expect info files to be made using makeinfo.
29 ;; In particular we make these assumptions:
30 ;; - a menu item MAY contain colons but not colon-space ": "
31 ;; - a menu item ending with ": " (but not ":: ") is an index entry
32 ;; - a node name MAY NOT contain a colon
33 ;; This distinction is to support indexing of computer programming
34 ;; language terms that may contain ":" but not ": ".
36 ;;; Code:
41 "Info subsystem"
47 "Stack of info nodes user has visited.
51 "Stack of info nodes user has visited with `Info-history-back' command.
55 "List of all info nodes user has visited.
60 This is convenient if you want to write info files by hand.
61 However, we recommend that you not do this.
62 It is better to write a Texinfo file and generate the Info file from that,
63 because that gives you a printed manual as well."
68 "Non-nil allows Info to execute Lisp code associated with nodes.
76 "Face for Info node names."
82 "Face for every third `*' in an Info menu."
89 "Face for Info cross-references."
96 "Face for visited Info cross-references."
100 "*Non-nil means to fontify visited nodes in a different face."
106 "*Maximum size of menu to fontify if `font-lock-mode' is non-nil."
111 "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
112 A header-line does not scroll with the rest of the buffer."
118 "Face for Info cross-references in a node header."
123 "Face for Info nodes in a node header."
127 "List of directories to search for Info documentation files.
128 If nil, meaning not yet initialized, Info uses the environment
129 variable INFOPATH to initialize it, or `Info-default-directory-list'
130 if there is no INFOPATH variable in the environment, or the
131 concatenation of the two if INFOPATH ends with a colon.
133 When `Info-directory-list' is initialized from the value of
134 `Info-default-directory-list', and Emacs is installed in one of the
135 standard directories, the directory of Info files that come with Emacs
136 is put last (so that local Info files override standard ones).
138 When `Info-directory-list' is initialized from the value of
139 `Info-default-directory-list', and Emacs is not installed in one
140 of the standard directories, the first element of the resulting
141 list is the directory where Emacs installs the Info files that
142 come with it. This is so that Emacs's own manual, which suits the
143 version of Emacs you are using, will always be found first. This
144 is useful when you install an experimental version of Emacs without
145 removing the standard installation.
147 If you want to override the order of directories in
148 `Info-default-directory-list', set INFOPATH in the environment.
150 If you run the Emacs executable from the `src' directory in the Emacs
151 source tree, and INFOPATH is not defined, the `info' directory in the
152 source tree is used as the first element of `Info-directory-list', in
153 place of the installation Info directory. This is useful when you run
157 "List of additional directories to search for Info documentation files.
158 These directories are searched after those in `Info-directory-list'."
164 If this is non-nil, and you scroll far enough in a node that its menu
166 moves to a subnode indicated by the following menu item. This means
167 that you visit a subnode before getting to the end of the menu.
169 Setting this option to nil results in behavior similar to the stand-alone
170 Info reader program, which visits the first subnode from the menu only
171 when you hit the end of the current node."
177 "*If non-nil, hide the tag and section reference in *note and * menu items.
179 If value is non-nil but not t or `hide', the reference section is still shown."
188 "*If non-nil, attempt to refill paragraphs with hidden references.
189 This refilling may accidentally remove explicit line breaks in the info
190 file, so be prepared for a few surprises if you enable this feature."
196 "*If non-nil, regular expression to match a sequence of whitespace chars.
197 This applies to Info search for regular expressions.
199 In the Customization buffer, that is `[' followed by a space,
200 a tab, a carriage return (control-M), a newline, and `]+'."
205 ;; Try to obey obsolete Info-fontify settings.
208 "Hooks run when `Info-mode' is called."
213 "Hooks run when `Info-select-node' is called."
221 "Info file that Info is now looking at, or nil.
222 This is the name that was specified in Info, not the actual file name.
223 It doesn't contain directory names or file name extensions added by Info.
227 "Info subfile that is actually in the *info* buffer now.
234 "Marker pointing at beginning of current Info file's tag table.
247 "Point location within a selected node.
248 If string, the point is moved to the proper occurrence of the
249 name of the followed cross reference within a selected node.
254 \f
256 ;; The MS-DOS list should work both when long file names are
257 ;; supported (Windows 9X), and when only 8+3 file names are available.
299 "List of file name suffixes and associated decoding commands.
300 Each entry should be (SUFFIX . STRING); the file is given to
301 the command as standard input.
303 STRING may be a list of strings. In that case, the first element is
304 the command name, and the rest are arguments to that command.
306 If STRING is nil, no decoding is done.
307 Because the SUFFIXes are tried in order, the empty string should
310 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
311 ;; First, on MS-DOS with no long file names support, delete some of
312 ;; the extension in FILENAME to make room.
317 ;; How long is the extension in FILENAME (not counting the dot).
319 ext-left)
320 ;; SUFFIX starts with a dot. If FILENAME already has one,
321 ;; get rid of the one in SUFFIX (unless suffix is empty).
326 ;; How many chars of that extension should we keep?
328 ;; Get rid of the rest of the extension, and add SUFFIX.
331 suffix))))
338 "Insert the contents of an info file in the current buffer.
339 Do the right thing if the file has been compressed or zipped."
343 t))
345 lfn))
346 fullname decoder done)
348 ;; FILENAME exists--see if that name contains a suffix.
349 ;; If so, set DECODE accordingly.
354 filename)))
358 ;; Try adding suffixes to FILENAME and see if we can find something.
364 ;; If we found a file with a suffix, set DECODER
365 ;; according to the suffix.
367 ;; When the MS-DOS port runs on Windows, we need to check
368 ;; the short variant of a long file name as well.
378 ;; check for conflict with jka-compr
389 default-directory)))
395 \f
402 "../info/"
403 invocation-directory)))
405 infodir
407 "../../../info/"
408 invocation-directory))
410 infodir))))))
411 alternative)
414 ;; Uninstalled, Emacs builddir != srcdir.
415 sibling
416 ;; Uninstalled, builddir == srcdir
417 source))
419 ;; On DOS/NT, we use movable executables always,
420 ;; and we must always find the Info dir at run time.
422 nil
423 ;; Use invocation-directory for Info
424 ;; only if we used it for exec-directory also.
427 installation-directory))))
429 Info-default-directory-list
430 ;; `alternative' contains the Info files that came with this
431 ;; version, so we should look there first. `Info-insert-dir'
432 ;; currently expects to find `alternative' first on the list.
434 ;; Don't drop the last part, it might contain non-Emacs stuff.
435 ;; (reverse (cdr (reverse
439 "Initialize `Info-directory-list', if that hasn't been done yet."
452 ;;;###autoload
454 "Like `info' but show the Info buffer in another window."
460 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
462 ;;;###autoload (put 'info 'info-file "emacs")
463 ;;;###autoload
465 "Enter Info, the documentation browser.
466 Optional argument FILE specifies the file to examine;
467 the default is the top-level directory of Info.
468 Called from a program, FILE may specify an Info node of the form
469 `(FILENAME)NODENAME'.
470 Optional argument BUFFER specifies the Info buffer name;
471 the default buffer name is *info*. If BUFFER exists,
472 just switch to BUFFER. Otherwise, create a new buffer
473 with the top-level Info directory.
475 In interactive use, a non-numeric prefix argument directs
476 this command to read a file name from the minibuffer.
477 A numeric prefix argument selects an Info buffer with the prefix number
478 appended to the Info buffer name.
480 The search path for Info files is in the variable `Info-directory-list'.
481 The top-level Info directory is made by combining all the files named `dir'
482 in all the directories in that path."
492 ;; If argument already contains parentheses, don't add another set
493 ;; since the argument will then be parsed improperly. This also
494 ;; has the added benefit of allowing node names to be included
495 ;; following the parenthesized filename.
502 ;;;###autoload
504 "Display the Emacs manual in Info mode."
508 ;;;###autoload
510 "Run Emacs as a standalone Info reader.
511 Usage: emacs -f info-standalone [filename]
525 \f
526 ;; See if the accessible portion of the buffer begins with a node
527 ;; delimiter, and the node header line which follows matches REGEXP.
528 ;; Typically, this test will be followed by a loop that examines the
529 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
530 ;; to have the overhead of this special test inside the loop.
532 ;; This function changes match-data, but supposedly the caller might
533 ;; want to use the results of re-search-backward.
535 ;; The return value is the value of point at the beginning of matching
536 ;; REGEXP, if the function succeeds, nil otherwise.
548 Optional second argument NOERROR, if t, means if file is not found
549 just return nil (no error)."
550 ;; Convert filename to lower case if not found as specified.
551 ;; Expand it.
566 ;; If specified name starts with `./'
567 ;; then just try current directory.
570 ;; No point in searching for an
571 ;; absolute file name
575 Info-additional-directory-list)
576 Info-directory-list)))))
577 ;; Search the directory list for file FILENAME.
582 ;; Try several variants of specified name.
586 t)))
597 lfn
609 filename)))
612 "Go to an info node specified as separate FILENAME and NODENAME.
613 NO-GOING-BACK is non-nil if recovering from an error in this function;
614 it says do not attempt further (recursive) error recovery."
617 ;; Record the node we are leaving.
621 Info-history)))
622 ;; Go into info buffer.
627 "Use the `Info-mode' to browse the current info buffer.
628 If a prefix arg is provided, it queries for the NODENAME which
640 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
641 ;; but at least it keeps this routine (which is only for the benefit of
642 ;; makeinfo-buffer) out of the way of normal operations.
643 ;;
645 "Go to an info node FILENAME and NODENAME, re-reading disk contents.
646 When *info* is already displaying FILENAME and NODENAME, the window position
647 is preserved, if possible."
663 ;; note goto-line is no good, we want to measure from point-min
670 ;; only add to the history when coming from a different file+node
675 "Find a node in a tag table.
676 MARKER specifies the buffer and position to start searching at.
677 REGEXP is a regular expression matching nodes or references. Its first
678 group should match `Node:' or `Ref:'.
679 CASE-FOLD t means search for a case-insensitive match.
680 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
681 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
682 where the match was found, and MODE is `major-mode' of the buffer in
683 which the match was found."
689 ;; Search tag table
694 major-mode)))))
697 "Find a node in a tag table.
698 MARKER specifies the buffer and position to start searching at.
699 REGEXP is a regular expression matching nodes or references. Its first
700 group should match `Node:' or `Ref:'.
701 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
702 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
703 where the match was found, and MODE is `major-mode' of the buffer in
704 which the match was found.
705 This function tries to find a case-sensitive match first, then a
706 case-insensitive match is tried."
710 result))
713 "Find a node or anchor in the current buffer.
714 REGEXP is a regular expression matching nodes or references. Its first
715 group should match `Node:' or `Ref:'.
716 CASE-FOLD t means search for a case-insensitive match.
717 Value is the position at which a match was found, or nil if not found."
719 found)
731 found)))
734 "Find a node or anchor in the current buffer.
735 REGEXP is a regular expression matching nodes or references. Its first
736 group should match `Node:' or `Ref:'.
737 Value is the position at which a match was found, or nil if not found.
738 This function looks for a case-sensitive match first. If none is found,
739 a case-insensitive match is tried."
751 anchorpos)
752 ;; Switch files if necessary
757 Info-current-subfile nil
758 Info-current-file-completions nil
759 buffer-file-name nil)
774 ;; See whether file has a tag table. Record the location if yes.
777 ;; Use string-equal, not equal, to ignore text props.
782 ;; We have a tag table. Find its beginning.
783 ;; Is this an indirect file?
789 ;; It is indirect. Copy it to another buffer
790 ;; and record that the tag table is in that buffer.
813 ))
814 ;; Use string-equal, not equal, to ignore text props.
818 ;; Possibilities:
819 ;;
820 ;; 1. Anchor found in tag table
821 ;; 2. Anchor *not* in tag table
822 ;;
823 ;; 3. Node found in tag table
824 ;; 4. Node *not* found in tag table, but found in file
825 ;; 5. Node *not* in tag table, and *not* in file
826 ;;
827 ;; *Or* the same, but in an indirect subfile.
829 ;; Search file for a suitable node.
839 ;; First, search a tag table, if any
845 ;; FOUND is (ANCHOR POS MODE).
848 ;; If this is an indirect file, determine which
849 ;; file really holds this node and read it in.
851 ;; Note that the current buffer must be the
852 ;; *info* buffer on entry to
853 ;; Info-read-subfile. Thus the hackery above.
856 ;; Handle anchor
861 ;; Else we may have a node, which we search for:
865 ;; Now search from our advised position (or from beg of
866 ;; buffer) to find the actual node. First, check
867 ;; whether the node is right where we are, in case the
868 ;; buffer begins with a node.
881 ;; No such anchor in tag table or node in tag table or file
889 ;; Add anchors to the history too
900 ;; If we did not finish finding the specified node,
901 ;; go back to the previous one.
908 ;; Cache the contents of the (virtual) dir file, once we have merged
909 ;; it for the first time, so we can save time subsequently.
912 ;; Cache for the directory we decided to use for the default-directory
913 ;; of the merged dir text.
916 ;; Record the file attributes of all the files from which we
917 ;; constructed Info-dir-contents.
922 ;; Construct the Info directory node by merging the files named `dir'
923 ;; from various directories. Set the *info* buffer's
924 ;; default-directory to the first directory we actually get any text
925 ;; from.
928 ;; Verify that none of the files we used has changed
929 ;; since we used it.
933 ;; Handle symlinks
936 ;; Don't compare the access time.
940 Info-dir-file-attributes))))
946 Info-additional-directory-list)
947 Info-directory-list))
949 ;; Bind this in case the user sets it to nil.
951 ;; This is set non-nil if we find a problem in some input files.
952 problems
953 buffers buffer others nodes dirs-done)
955 ;; Search the directory list for the directory file.
960 ;; Try several variants of specified name.
961 ;; Try upcasing, appending `.info', or both.
976 dirs-done)))
986 file)
998 ;; Distinguish the dir file that comes with Emacs from all the
999 ;; others. Yes, that is really what this is supposed to do.
1000 ;; The definition of `Info-directory-list' puts it first on that
1001 ;; list and so last in `buffers' at this point.
1005 ;; Insert the entire original dir file as a start; note that we've
1006 ;; already saved its default directory to use as the default
1007 ;; directory for the whole concatenation.
1010 ;; Look at each of the other buffers one by one.
1013 ;; In each, find all the menus.
1016 ;; Find each menu, and add an elt to NODES for it.
1020 nodename end)
1032 ;; Add to the main menu a menu item for each other node.
1044 end t)
1048 ;; Now take each node of each of the other buffers
1049 ;; and merge it into the main buffer.
1054 ;; Find the like-named node in the main buffer.
1058 nil t)
1063 ;; If none exists, add one.
1066 ;; Merge the text from the other buffer's menu
1067 ;; into the menu in the like-named node in the main buffer.
1070 ;; Kill all the buffers we just made, including the special one excised.
1090 ;; Remove duplicate headings in the same menu.
1093 ;; Look for the next heading to unify.
1098 ;; Check whether this heading should be streamlined.
1108 ;; Look for other headings of the same category and merge them.
1114 ;; Delete redundant heading.
1116 ;; Push the entries onto `text'.
1123 ;; Insert the entries just found.
1131 ;; Now remove duplicate entries under the same heading.
1144 ;; Note that on entry to this function the current-buffer must be the
1145 ;; *info* buffer; not the info tags buffer.
1147 ;; NODEPOS is either a position (in the Info file as a whole,
1148 ;; not relative to a subfile) or the name of a subfile.
1150 lastfilename)
1162 thisfilepos thisfilename)
1166 ;; read in version 19 stops at the end of number.
1167 ;; Advance to the next line.
1176 ;; Assume previous buffer is in Info-mode.
1177 ;; (set-buffer (get-buffer "*info*"))
1186 ;; Widen in case we are in the same subfile as before.
1196 "Unescape double quotes and backslashes in VALUE."
1202 unquote))
1204 ;; As of Texinfo 4.6, makeinfo writes constructs like
1205 ;; \0\h[image param=value ...\h\0]
1206 ;; into the Info file for handling images.
1209 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1210 whitespace or double quotes, it must be quoted in double quotes and
1215 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1216 parameter-string start)
1222 parameter-alist))
1223 parameter-alist))
1226 "Display images in current node."
1233 nil t)
1248 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1249 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1250 ;; including one optional trailing newline.
1252 "Hide unrecognised cookies in current node."
1259 nil t)
1266 "Select the info node that point is in."
1267 ;; Bind this in case the user sets it to nil.
1270 ;; Find beginning of node.
1276 ;; Get nodename spelled as it is in the node.
1284 ;; Find the end of it, and narrow.
1287 ;; Narrow to the node contents
1299 ;; Add a new unique history item to full history list
1317 Info-current-file
1319 ") "
1321 \f
1322 ;; Go to an info node specified with a filename-and-nodename string
1323 ;; of the sort that is found in pointers in nodes.
1325 ;;;###autoload
1327 "Go to info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1328 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1329 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1330 its sub-files).
1331 Completion is available, but only for node names in the current Info file.
1332 If FORK is non-nil (interactively with a prefix arg), show the node in
1333 a new info buffer.
1334 If FORK is a string, it is the name to use for the new buffer."
1342 nodename)
1344 ""
1357 ;; This function is used as the "completion table" while reading a node name.
1358 ;; It does completion using the alist in Info-read-node-completion-table
1359 ;; unless STRING starts with an open-paren.
1362 ;; First complete embedded file names.
1377 ;; If a file name was given, then any node is fair game.
1383 ;; Otherwise use Info-read-node-completion-table.
1398 nodename)))
1403 ;; Bind this in case the user sets it to nil.
1416 compl))))
1419 ;; If the buffer begins with a node header, process that first.
1422 ;; Now for the rest of the nodes.
1430 compl))))))))
1433 \f
1435 "If this node has been visited, restore the point value when we left."
1438 ;; Use string-equal, not equal, to ignore text props.
1444 \f
1452 "Search for REGEXP, starting from point, and select node it's found in.
1453 If DIRECTION is `backward', search in the reverse direction."
1481 ;; Hide Info file header for backward search
1493 ;; Skip node header line
1497 ;; Skip Tag Table node
1508 ;; If no subfiles, give error now.
1519 ;; Try other subfiles.
1530 ;; Find the subfile we just searched.
1532 ;; Skip that one.
1534 ;; Make a list of all following subfiles.
1535 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1544 list))
1548 ;; Put in forward order
1554 ;; Hide Info file header for backward search
1569 ;; Skip node header line
1573 ;; Skip Tag Table node
1600 ;; Search landed in the same node
1606 ;; Use string-equal, not equal, to ignore text props.
1611 Info-history))))))
1614 "Search for a regexp case-sensitively."
1620 "Search for next regexp from a previous `Info-search' command."
1628 "Search for REGEXP in the reverse direction."
1668 \f
1670 "Extract the value of the node-pointer named NAME.
1671 If there is none, use ERRORNAME in the error message;
1672 if ERRORNAME is nil, just return nil."
1673 ;; Bind this in case the user sets it to nil.
1687 "Return a regexp matching a node name.
1688 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1689 saying which chars may appear in the node name.
1690 Submatch 1 is the complete node name.
1691 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1692 Submatch 3 is the local part of the node name.
1693 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1700 ;;; For compatibility; other files have used this name.
1706 "Go to the next node of this node."
1711 "Go to the previous node of this node."
1716 "Go to the superior node of this node.
1717 If SAME-FILE is non-nil, do not move to a different Info file."
1734 nil t))
1740 "Go back in the history to the last node visited."
1746 Info-history-forward))
1747 filename nodename opoint)
1760 "Go forward in the history of visited nodes."
1765 filename nodename opoint)
1773 ;;;###autoload
1775 "Go to the Info directory node."
1778 \f
1780 "Go to a node with a menu of visited nodes."
1784 p)
1806 "Go to a node with table of contents of the current Info file.
1807 Table of contents is created from the tree structure of menus."
1811 p)
1841 "Insert table of contents with references to nodes."
1853 "Build table of contents from menus of Info FILE and its subfiles."
1858 default-directory))
1861 nodes subfiles)
1873 menu-items)
1882 bound))
1885 ;; Menu item line
1895 ;; Other non-empty strings in the Top node are section names
1904 nodes))
1913 subfiles)))))
1915 main-file nil))
1919 \f
1921 "Follow cross reference named FOOTNOTENAME to the node it refers to.
1922 FOOTNOTENAME may be an abbreviation of the reference name.
1923 If FORK is non-nil (interactively with a prefix arg), show the node in
1924 a new info buffer. If FORK is a string, it is the name to use for the
1925 new buffer."
1931 ;; Store end and beginning of line.
1940 ;; See if this one should be the default.
1945 ;; See if this one should be the alternate default.
1955 ;; Record as a completion and perhaps as default.
1958 ;; Don't add this string if it's a duplicate.
1961 ;; If no good default was found, try an alternate.
1964 ;; If only one cross-reference found, then make it default.
1970 "Follow reference named: (default "
1973 completions nil t)))
1987 ;; Move point to the beginning of reference if point is on reference
1997 ;; Go to the reference closest to point
2005 next-ref prev-ref))
2016 ;; We allow newline because this is also used in Info-follow-reference,
2017 ;; where the xref name might be wrapped over two lines.
2018 "Regexp that matches a menu entry name upto but not including the colon.
2019 Because of ambiguities, this should be concatenated with something like
2039 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2040 ;;; (setq Info-point-loc
2041 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2042 )
2046 ;; If the node name is the menu entry name (using `entry::').
2049 ;; No one calls this.
2050 ;;(defun Info-menu-item-sequence (list)
2051 ;; (while list
2052 ;; (Info-menu (car list))
2053 ;; (setq list (cdr list))))
2065 ;; This uses two dynamically bound variables:
2066 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2067 ;; is the menu of items we're trying to complete.
2068 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2069 ;; also look for menu items in subsequent nodes as long as those
2070 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2071 ;; not used.
2072 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2073 ;; also look for menu items in these nodes. This feature is currently
2074 ;; only used for completion in Info-index.
2076 ;; Note that `Info-complete-menu-buffer' could be current already,
2077 ;; so we want to save point.
2083 nextnode)
2092 completions)
2093 ;; Check the cache.
2101 ;; We can reuse the previous list.
2103 ;; The cache can't be used.
2108 completions))
2109 ;; Check subsequent nodes if applicable.
2117 ;; Go back to the start node (for the next completion).
2120 ;; Update the cache.
2123 Info-complete-next-re string completions
2124 Info-complete-nodes)))
2131 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2132 The menu item should one of those listed in the current node's menu.
2133 Completion is allowed, and the default menu item is the one point is on.
2134 If FORK is non-nil (interactively with a prefix arg), show the node in
2135 a new info buffer. If FORK is a string, it is the name to use for the
2136 new buffer."
2139 ;; If point is within a menu item, use that item as the default
2142 beg
2155 Info-menu-entry-name-re
2164 default)
2167 ;; we rely on the fact that completing-read accepts an input
2168 ;; of "" even when the require-match argument is true and ""
2169 ;; is not a valid possibility
2173 ;; ask again
2176 ;; there is a problem here in that if several menu items have the same
2177 ;; name you can only go to the node of the first with this command.
2195 ;; If COUNT is nil, use the last item in the menu.
2207 nil))
2211 "Go to the node of the Nth menu item.
2212 N is the digit argument used to invoke this command."
2219 "Go to the Top node of this file."
2224 "Go to the final node in this file."
2229 ;; Go to the last node in the menu of Top.
2231 ;; If the last node in the menu is not last in pointer structure,
2232 ;; move forward until we can't go any farther.
2234 ;; Then keep moving down to last subnode, unless we reach an index.
2240 "Go forward one node, considering all nodes as forming one sequence."
2245 ;; three possibilities, in order of priority:
2246 ;; 1. next node is in a menu in this node (but not in an index)
2247 ;; 2. next node is next at same level
2248 ;; 3. next node is up and next
2253 t)
2256 t)
2258 ;; Use string-equal, not equal, to ignore text props.
2271 "Go backward one node, considering all nodes as forming one sequence."
2279 ;; Use string-equal, not equal,
2280 ;; to ignore text properties.
2285 ;; If we move back at the same level,
2286 ;; go down to find the last subnode*.
2296 "Exit Info by selecting some other buffer."
2303 "Go to the node of the next menu item."
2305 ;; Bind this in case the user sets it to nil.
2317 "Go to the node of the previous menu item."
2321 ;; Bind this in case the user sets it to nil.
2336 "Go to the next subnode or the next node, or go up a level."
2341 ;; Since we have already gone thru all the items in this menu,
2342 ;; go up to the end of this node.
2344 ;; Since logically we are done with the node with that menu,
2345 ;; move on from it.
2351 "Go to the last node, popping up a level if there is none."
2355 ;; If we go down a menu item, go to the end of the node
2356 ;; so we can scroll back through it.
2358 ;; Keep going down, as long as there are nested menu nodes.
2361 ;; If we go down a menu item, go to the end of the node
2362 ;; so we can scroll back through it.
2372 ;; If we go down a menu item, go to the end of the node
2373 ;; so we can scroll back through it.
2384 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2385 Once you scroll far enough in a node that its menu appears on the screen
2386 but after point, the next scroll moves into its first subnode, unless
2387 `Info-scroll-prefer-subnodes' is nil.
2389 When you scroll past the end of a node, that goes to the next node if
2390 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2391 if this node has no successor, it moves to the parent node's successor,
2392 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2393 the menu of a node, it moves to subnode indicated by the following menu
2394 item. (That case won't normally result from this command, but can happen
2395 in other ways.)"
2417 "Scroll one screenful back in Info, considering all nodes as one sequence.
2418 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2419 is non-nil, this goes to its last subnode. When you scroll past the
2420 beginning of a node, that goes to the previous node or back up to the
2421 parent node."
2435 current-point
2436 t)))))
2443 "Move cursor to the next cross-reference or menu item in the node."
2463 "Move cursor to the previous cross-reference or menu item in the node."
2480 \f
2482 "Alist of cached index node names of visited Info files.
2486 "Return a list of names of all index nodes in Info FILE.
2487 If FILE is omitted, it defaults to the current Info file.
2488 First look in a list of cached index node names. Then scan Info
2489 file and its subfiles for nodes with the index cookie. Then try
2490 to find index nodes starting from the first node in the top level
2495 ;; Skip virtual Info files
2499 ;; Find nodes with index cookie
2503 default-directory))
2504 Info-history Info-history-list Info-fontify-maximum-menu-size
2524 subfiles)))))
2526 main-file nil))
2532 nodes)
2533 ;; Find nodes with the word "Index" in the node name
2535 Info-history Info-history-list Info-fontify-maximum-menu-size
2536 nodes node)
2554 nodes)
2555 ;; If file has no index nodes, still add it to the cache
2560 "Return non-nil value if NODE is an index node.
2561 If NODE is nil, check the current Info node.
2562 If FILE is nil, check the current Info file."
2566 ;; Don't search all index nodes if request is only for the current node
2567 ;; and file is not in the cache of index nodes
2581 "Go to the first index node."
2586 ;;;###autoload
2588 "Look up a string TOPIC in the index for this file.
2589 If there are no exact matches to the specified topic, this chooses
2590 the first match which is a case-insensitive substring of a topic.
2592 Give a blank topic name to go to the Index node itself."
2608 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2617 ;; We bind Info-history to nil for internal node-switches so
2618 ;; that we don't put junk in the history. In the first
2619 ;; Info-goto-index call, above, we do update the history
2620 ;; because that is what the user's previous node choice into it.
2622 found)
2629 Info-current-node
2632 matches))
2639 ;; Here it is a feature that assoc is case-sensitive.
2669 "(`,' tries to find next)"
2673 "Move point to the place within the current node where NAME is defined."
2678 ;; Find a function definition with a return type.
2686 nil t))
2688 ;; Try again without the " <1>" makeinfo can append
2694 ;;;###autoload
2696 "Grovel indices of all known Info files on your system for STRING.
2697 Build a menu of the possible matches."
2700 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2706 manuals matches node nodes)
2734 Info-history-list ohist-list)
2755 "Make command be undefined in Info."
2760 "Enter the Info tutorial."
2765 "Help-Small-Screen"
2769 "Display a brief summary of all Info commands."
2784 flag))
2787 \f
2789 "Return the token around POS.
2790 POS must be somewhere inside the token
2791 START is a regular expression which will match the
2792 beginning of the tokens delimited string
2793 ALL is a regular expression with a single
2794 parenthesized subpattern which is the token to be
2795 returned. E.g. '{\(.*\)}' would return any string
2796 enclosed in braces around POS.
2797 ERRORSTRING optional fourth argument, controls action on no match
2798 nil: return nil
2799 t: beep
2800 a string: signal an error, using that string."
2804 ;; First look for a match for START that goes across POS.
2808 ;; If we did not find one, search back for START
2809 ;; (this finds only matches that end at or before POS).
2822 nil)
2825 nil)
2831 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
2832 At end of the node's text, moves to the next node, or up if none."
2840 "Follow a node reference near point.
2841 If point is on a reference, follow that reference. Otherwise,
2842 if point is in a menu item description, follow that menu item."
2854 t)))
2857 ;; Common subroutine.
2859 "Follow a node reference near point. Return non-nil if successful."
2868 ;; menu item: node name
2871 ;; menu item: node name or index entry
2885 node))
2886 \f
2890 nil
2899 (define-key Info-mode-map "1" 'Info-nth-menu-item)
2900 (define-key Info-mode-map "2" 'Info-nth-menu-item)
2901 (define-key Info-mode-map "3" 'Info-nth-menu-item)
2902 (define-key Info-mode-map "4" 'Info-nth-menu-item)
2903 (define-key Info-mode-map "5" 'Info-nth-menu-item)
2904 (define-key Info-mode-map "6" 'Info-nth-menu-item)
2905 (define-key Info-mode-map "7" 'Info-nth-menu-item)
2906 (define-key Info-mode-map "8" 'Info-nth-menu-item)
2907 (define-key Info-mode-map "9" 'Info-nth-menu-item)
2908 (define-key Info-mode-map "0" 'undefined)
2909 (define-key Info-mode-map "?" 'Info-summary)
2910 (define-key Info-mode-map "]" 'Info-forward-node)
2911 (define-key Info-mode-map "[" 'Info-backward-node)
2912 (define-key Info-mode-map "<" 'Info-top-node)
2913 (define-key Info-mode-map ">" 'Info-final-node)
2914 (define-key Info-mode-map "b" 'beginning-of-buffer)
2915 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
2916 (define-key Info-mode-map "d" 'Info-directory)
2917 (define-key Info-mode-map "e" 'Info-edit)
2918 (define-key Info-mode-map "f" 'Info-follow-reference)
2919 (define-key Info-mode-map "g" 'Info-goto-node)
2920 (define-key Info-mode-map "h" 'Info-help)
2921 (define-key Info-mode-map "i" 'Info-index)
2922 (define-key Info-mode-map "l" 'Info-history-back)
2923 (define-key Info-mode-map "L" 'Info-history)
2924 (define-key Info-mode-map "m" 'Info-menu)
2925 (define-key Info-mode-map "n" 'Info-next)
2926 (define-key Info-mode-map "p" 'Info-prev)
2927 (define-key Info-mode-map "q" 'Info-exit)
2928 (define-key Info-mode-map "r" 'Info-history-forward)
2929 (define-key Info-mode-map "s" 'Info-search)
2930 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
2931 ;; For consistency with Rmail.
2932 (define-key Info-mode-map "\M-s" 'Info-search)
2933 (define-key Info-mode-map "\M-n" 'clone-buffer)
2934 (define-key Info-mode-map "t" 'Info-top-node)
2935 (define-key Info-mode-map "T" 'Info-toc)
2936 (define-key Info-mode-map "u" 'Info-up)
2937 ;; For consistency with dired-copy-filename-as-kill.
2938 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
2939 (define-key Info-mode-map "," 'Info-index-next)
2941 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
2942 (define-key Info-mode-map [follow-link] 'mouse-face)
2943 )
2945 (defun Info-check-pointer (item)
2946 "Non-nil if ITEM is present in this node."
2947 (condition-case nil
2948 (Info-extract-pointer item)
2949 (error nil)))
2951 (easy-menu-define
2952 Info-mode-menu Info-mode-map
2953 "Menu for info files."
2954 '("Info"
2955 ["Up" Info-up :active (Info-check-pointer "up")
2956 :help "Go up in the Info tree"]
2957 ["Next" Info-next :active (Info-check-pointer "next")
2958 :help "Go to the next node"]
2959 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
2960 :help "Go to the previous node"]
2961 ["Backward" Info-backward-node
2962 :help "Go backward one node, considering all as a sequence"]
2963 ["Forward" Info-forward-node
2964 :help "Go forward one node, considering all as a sequence"]
2965 ["Beginning" beginning-of-buffer
2966 :help "Go to beginning of this node"]
2967 ["Top" Info-top-node
2968 :help "Go to top node of file"]
2969 ["Final Node" Info-final-node
2970 :help "Go to final node in this file"]
2971 ("Menu Item" ["You should never see this" report-emacs-bug t])
2972 ("Reference" ["You should never see this" report-emacs-bug t])
2973 ["Search..." Info-search
2974 :help "Search for regular expression in this Info file"]
2975 ["Search Case-Sensitively..." Info-search-case-sensitively
2976 :help "Search for regular expression case sensitively"]
2977 ["Search Next" Info-search-next
2978 :help "Search for another occurrence of regular expression"]
2979 ["Go to Node..." Info-goto-node
2980 :help "Go to a named node"]
2981 ["Back in history" Info-history-back :active Info-history
2982 :help "Go back in history to the last node you were at"]
2983 ["Forward in history" Info-history-forward :active Info-history-forward
2984 :help "Go forward in history"]
2985 ["History" Info-history :active Info-history-list
2986 :help "Go to menu of visited nodes"]
2987 ["Table of Contents" Info-toc
2988 :help "Go to table of contents"]
2989 ("Index..."
2990 ["Lookup a String" Info-index
2991 :help "Look for a string in the index items"]
2992 ["Next Matching Item" Info-index-next
2993 :help "Look for another occurrence of previous item"]
2994 ["Lookup a string in all indices" info-apropos
2995 :help "Look for a string in the indices of all manuals"])
2996 ["Edit" Info-edit :help "Edit contents of this node"
2997 :active Info-enable-edit]
2998 ["Copy Node Name" Info-copy-current-node-name
2999 :help "Copy the name of the current node into the kill ring"]
3000 ["Clone Info buffer" clone-buffer
3001 :help "Create a twin copy of the current Info buffer."]
3002 ["Exit" Info-exit :help "Stop reading Info"]))
3005 (defvar info-tool-bar-map
3006 (if (display-graphic-p)
3007 (let ((map (make-sparse-keymap)))
3008 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
3009 (tool-bar-local-item-from-menu 'Info-prev "left_arrow" map Info-mode-map)
3010 (tool-bar-local-item-from-menu 'Info-next "right_arrow" map Info-mode-map)
3011 (tool-bar-local-item-from-menu 'Info-up "up_arrow" map Info-mode-map)
3012 (tool-bar-local-item-from-menu 'Info-history-back "back_arrow" map Info-mode-map)
3013 (tool-bar-local-item-from-menu 'Info-history-forward "fwd_arrow" map Info-mode-map)
3014 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3015 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3016 (tool-bar-local-item-from-menu 'Info-goto-node "jump_to" map Info-mode-map)
3017 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3018 map)))
3020 (defvar Info-menu-last-node nil)
3021 ;; Last node the menu was created for.
3022 ;; Value is a list, (FILE-NAME NODE-NAME).
3024 (defun Info-menu-update ()
3025 "Update the Info menu for the current node."
3026 (condition-case nil
3027 (if (or (not (eq major-mode 'Info-mode))
3028 (equal (list Info-current-file Info-current-node)
3029 Info-menu-last-node))
3030 ()
3031 ;; Update menu menu.
3032 (let* ((Info-complete-menu-buffer (current-buffer))
3033 (items (nreverse (condition-case nil
3034 (Info-complete-menu-item "" nil t)
3035 (error nil))))
3036 entries current
3037 (number 0))
3038 (while (and items (< number 9))
3039 (setq current (car items)
3040 items (cdr items)
3041 number (1+ number))
3042 (setq entries (cons `[,current
3043 (Info-menu ,current)
3044 :keys ,(format "%d" number)]
3045 entries)))
3046 (if items
3047 (setq entries (cons ["Other..." Info-menu t] entries)))
3048 (or entries
3049 (setq entries (list ["No menu" nil nil] nil :active)))
3050 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3051 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3052 (let ((items nil)
3053 str i entries current
3054 (number 0)
3055 (case-fold-search t))
3056 (save-excursion
3057 (goto-char (point-min))
3059 (setq str (match-string 1))
3060 (setq i 0)
3062 (setq str (concat (substring str 0 i) " "
3063 (substring str (match-end 0))))
3064 (setq i (1+ i)))
3065 (setq items
3066 (cons str items))))
3067 (while (and items (< number 9))
3068 (setq current (car items)
3069 items (cdr items)
3070 number (1+ number))
3071 (setq entries (cons `[,current
3072 (Info-follow-reference ,current)
3073 t]
3074 entries)))
3075 (if items
3076 (setq entries (cons ["Other..." Info-follow-reference t]
3077 entries)))
3078 (or entries
3079 (setq entries (list ["No references" nil nil] nil :active)))
3080 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3081 ;; Update last seen node.
3082 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3083 ;; Try to avoid entering infinite beep mode in case of errors.
3084 (error (ding))))
3086 \f
3087 (defun Info-copy-current-node-name (&optional arg)
3088 "Put the name of the current info node into the kill ring.
3089 The name of the info file is prepended to the node name in parentheses.
3090 With a zero prefix arg, put the name inside a function call to `info'."
3091 (interactive "P")
3092 (unless Info-current-node
3093 (error "No current info node"))
3094 (let ((node (concat "(" (file-name-nondirectory
3095 (or (and (stringp Info-current-file)
3096 Info-current-file)
3097 buffer-file-name
3098 ""))
3099 ")" Info-current-node)))
3100 (if (zerop (prefix-numeric-value arg))
3102 (kill-new node)
3103 (message "%s" node)))
3105 \f
3106 ;; Info mode is suitable only for specially formatted data.
3107 (put 'Info-mode 'mode-class 'special)
3108 (put 'Info-mode 'no-clone-indirect t)
3110 (defun Info-mode ()
3111 "Info mode provides commands for browsing through the Info documentation tree.
3113 one topic and contains references to other nodes which discuss related
3114 topics. Info has commands to follow the references and show you other nodes.
3120 Selecting other nodes:
3122 Follow a node reference you click on.
3123 This works with menu items, cross references, and
3125 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3130 Picking a menu item causes another node to be selected.
3134 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3142 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3145 Moving within a node:
3147 Once you scroll far enough in a node that its menu appears on the
3148 screen but after point, the next scroll moves into its first
3149 subnode. When after all menu items (or if there is no menu),
3150 move up to the parent node.
3152 already visible, try to go to the previous menu entry, or up
3153 if there is none.
3156 Advanced commands:
3160 1 .. 9 Pick first ... ninth item in node's menu.
3161 Every third `*' is highlighted to help pick the right number.
3163 You may include a filename as well, as (FILENAME)NODENAME.
3167 and select the node in which the next occurrence is found.
3168 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3173 (kill-all-local-variables)
3174 (setq major-mode 'Info-mode)
3175 (setq mode-name "Info")
3176 (setq tab-width 8)
3177 (use-local-map Info-mode-map)
3178 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3179 (set-syntax-table text-mode-syntax-table)
3180 (setq local-abbrev-table text-mode-abbrev-table)
3181 (setq case-fold-search t)
3182 (setq buffer-read-only t)
3183 (make-local-variable 'Info-current-file)
3184 (make-local-variable 'Info-current-subfile)
3185 (make-local-variable 'Info-current-node)
3186 (make-local-variable 'Info-tag-table-marker)
3187 (setq Info-tag-table-marker (make-marker))
3188 (make-local-variable 'Info-tag-table-buffer)
3189 (setq Info-tag-table-buffer nil)
3190 (make-local-variable 'Info-history)
3191 (make-local-variable 'Info-history-forward)
3192 (make-local-variable 'Info-index-alternatives)
3193 (setq header-line-format
3194 (if Info-use-header-line
3195 '(:eval (get-text-property (point-min) 'header-line))
3196 nil)) ; so the header line isn't displayed
3197 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3198 ;; This is for the sake of the invisible text we use handling titles.
3199 (make-local-variable 'line-move-ignore-invisible)
3200 (setq line-move-ignore-invisible t)
3201 (make-local-variable 'desktop-save-buffer)
3202 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3203 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
3204 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3205 (set (make-local-variable 'isearch-search-fun-function)
3206 'Info-isearch-search)
3207 (set (make-local-variable 'isearch-wrap-function)
3208 'Info-isearch-wrap)
3209 (set (make-local-variable 'isearch-push-state-function)
3210 'Info-isearch-push-state)
3211 (set (make-local-variable 'search-whitespace-regexp)
3212 Info-search-whitespace-regexp)
3213 (Info-set-mode-line)
3214 (run-hooks 'Info-mode-hook))
3216 (defun Info-clone-buffer-hook ()
3217 (when (bufferp Info-tag-table-buffer)
3218 (setq Info-tag-table-buffer
3219 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3220 (let ((m Info-tag-table-marker))
3221 (when (markerp m)
3222 (setq Info-tag-table-marker
3223 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3224 (with-current-buffer Info-tag-table-buffer
3225 (copy-marker (marker-position m)))
3226 (make-marker))))))
3228 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3229 (set-keymap-parent map text-mode-map)
3230 (define-key map "\C-c\C-c" 'Info-cease-edit)
3231 map)
3232 "Local keymap used within `e' command of Info.")
3234 ;; Info-edit mode is suitable only for specially formatted data.
3235 (put 'Info-edit-mode 'mode-class 'special)
3237 (defun Info-edit-mode ()
3238 "Major mode for editing the contents of an Info node.
3239 Like text mode with the addition of `Info-cease-edit'
3240 which returns to Info mode for browsing.
3242 (use-local-map Info-edit-map)
3243 (setq major-mode 'Info-edit-mode)
3244 (setq mode-name "Info Edit")
3245 (kill-local-variable 'mode-line-buffer-identification)
3246 (setq buffer-read-only nil)
3247 (force-mode-line-update)
3248 (buffer-enable-undo (current-buffer))
3249 (run-hooks 'Info-edit-mode-hook))
3251 (defun Info-edit ()
3252 "Edit the contents of this Info node.
3253 Allowed only if variable `Info-enable-edit' is non-nil."
3254 (interactive)
3255 (or Info-enable-edit
3256 (error "Editing info nodes is not enabled"))
3257 (Info-edit-mode)
3258 (message "%s" (substitute-command-keys
3261 (defun Info-cease-edit ()
3262 "Finish editing Info node; switch back to Info proper."
3263 (interactive)
3264 ;; Do this first, so nothing has changed if user C-g's at query.
3265 (and (buffer-modified-p)
3266 (y-or-n-p "Save the file? ")
3267 (save-buffer))
3268 (use-local-map Info-mode-map)
3269 (setq major-mode 'Info-mode)
3270 (setq mode-name "Info")
3271 (Info-set-mode-line)
3272 (setq buffer-read-only t)
3273 (force-mode-line-update)
3274 (and (marker-position Info-tag-table-marker)
3275 (buffer-modified-p)
3276 (message "Tags may have changed. Use Info-tagify if necessary")))
3277 \f
3278 (defvar Info-file-list-for-emacs
3279 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3280 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3281 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3282 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3283 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3284 ("copyright" . "autotype") ("executable" . "autotype")
3285 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3286 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3287 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3288 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3289 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3290 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3291 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3292 ("rfc2045" . "emacs-mime")
3293 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3294 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3295 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3296 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3297 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3298 ("mml" . "emacs-mime"))
3299 "List of Info files that describe Emacs commands.
3300 An element can be a file name, or a list of the form (PREFIX . FILE)
3301 where PREFIX is a name prefix and FILE is the file to look in.
3302 If the element is just a file name, the file name also serves as the prefix.")
3304 (defun Info-find-emacs-command-nodes (command)
3305 "Return a list of locations documenting COMMAND.
3306 The `info-file' property of COMMAND says which Info manual to search.
3307 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3308 defines heuristics for which Info manual to try.
3309 The locations are of the format used in `Info-history', i.e.
3310 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3311 in the first element of the returned list (which is treated specially in
3312 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3313 (let ((where '()) line-number
3317 (info-file "emacs")) ;default
3318 ;; Determine which info file this command is documented in.
3319 (if (get command 'info-file)
3320 (setq info-file (get command 'info-file))
3321 ;; If it doesn't say explicitly, test its name against
3322 ;; various prefixes that we know.
3323 (let ((file-list Info-file-list-for-emacs))
3324 (while file-list
3325 (let* ((elt (car file-list))
3326 (name (if (consp elt)
3327 (car elt)
3328 elt))
3329 (file (if (consp elt) (cdr elt) elt))
3330 (case-fold-search nil)
3333 (if (string-match regexp (symbol-name command))
3334 (setq info-file file file-list nil))
3335 (setq file-list (cdr file-list))))))
3336 (Info-find-node info-file "Top")
3339 (error "Info file `%s' appears to lack an index" info-file))
3340 (goto-char (match-beginning 1))
3341 ;; Bind Info-history to nil, to prevent the index nodes from
3342 ;; getting into the node history.
3343 (let ((Info-history nil)
3344 (Info-history-list nil)
3345 node (nodes (Info-index-nodes)))
3346 (Info-goto-node (car nodes))
3347 (while
3348 (progn
3349 (goto-char (point-min))
3350 (while (re-search-forward cmd-desc nil t)
3351 (setq where
3352 (cons (list Info-current-file
3353 (match-string-no-properties 2)
3354 0)
3355 where))
3356 (setq line-number (and (match-beginning 3)
3357 (string-to-number (match-string 3)))))
3358 (and (setq nodes (cdr nodes) node (car nodes))))
3359 (Info-goto-node node)))
3360 (if (and line-number where)
3361 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3362 (cdr where))
3363 where)))
3365 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3366 ;;;###autoload
3367 (defun Info-goto-emacs-command-node (command)
3368 "Go to the Info node in the Emacs manual for command COMMAND.
3369 The command is found by looking up in Emacs manual's indices
3370 or in another manual found via COMMAND's `info-file' property or
3371 the variable `Info-file-list-for-emacs'.
3372 COMMAND must be a symbol or string."
3373 (interactive "CFind documentation for command: ")
3374 ;; If command is given as a string, convert it to a symbol.
3375 (if (stringp command)
3376 (setq command (intern command)))
3377 (or (commandp command)
3378 (signal 'wrong-type-argument (list 'commandp command)))
3379 (let ((where (Info-find-emacs-command-nodes command)))
3380 (if where
3381 (let ((num-matches (length where)))
3382 ;; Get Info running, and pop to it in another window.
3383 (save-window-excursion
3384 (info))
3385 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3386 ;; Bind Info-history to nil, to prevent the last Index node
3387 ;; visited by Info-find-emacs-command-nodes from being
3388 ;; pushed onto the history.
3389 (let ((Info-history nil) (Info-history-list nil)
3390 (line-number (nth 2 (car where))))
3391 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3392 (if (and (integerp line-number) (> line-number 0))
3393 (forward-line (1- line-number))))
3394 (if (> num-matches 1)
3395 (progn
3396 ;; (car where) will be pushed onto Info-history
3397 ;; when/if they go to another node. Put the other
3398 ;; nodes that were found on the history.
3399 (setq Info-history (nconc (cdr where) Info-history))
3400 (message "Found %d other entr%s. Use %s to see %s."
3401 (1- num-matches)
3402 (if (> num-matches 2) "ies" "y")
3404 (if (> num-matches 2) "them" "it")))))
3405 (error "Couldn't find documentation for %s" command))))
3407 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3408 ;;;###autoload
3409 (defun Info-goto-emacs-key-command-node (key)
3410 "Go to the node in the Emacs manual which describes the command bound to KEY.
3411 KEY is a string.
3412 Interactively, if the binding is `execute-extended-command', a command is read.
3413 The command is found by looking up in Emacs manual's indices
3414 or in another manual found via COMMAND's `info-file' property or
3415 the variable `Info-file-list-for-emacs'."
3416 (interactive "kFind documentation for key: ")
3417 (let ((command (key-binding key)))
3418 (cond ((null command)
3419 (message "%s is undefined" (key-description key)))
3420 ((and (interactive-p)
3421 (eq command 'execute-extended-command))
3422 (Info-goto-emacs-command-node
3423 (read-command "Find documentation for command: ")))
3424 (t
3425 (Info-goto-emacs-command-node command)))))
3426 \f
3427 (defface Info-title-1-face
3428 '((((type tty pc) (class color)) :foreground "yellow" :weight bold)
3429 (t :height 1.2 :inherit Info-title-2-face))
3430 "Face for Info titles at level 1."
3431 :group 'info)
3433 (defface Info-title-2-face
3434 '((((type tty pc) (class color)) :foreground "lightblue" :weight bold)
3435 (t :height 1.2 :inherit Info-title-3-face))
3436 "Face for Info titles at level 2."
3437 :group 'info)
3439 (defface Info-title-3-face
3440 '((((type tty pc) (class color)) :weight bold)
3441 (t :height 1.2 :inherit Info-title-4-face))
3442 "Face for Info titles at level 3."
3443 :group 'info)
3445 (defface Info-title-4-face
3446 '((((type tty pc) (class color)) :weight bold)
3447 (t :weight bold :inherit variable-pitch))
3448 "Face for Info titles at level 4."
3449 :group 'info)
3451 (defface info-menu-header
3452 '((((type tty pc))
3453 :underline t
3454 :weight bold)
3455 (t
3456 :inherit variable-pitch
3457 :weight bold))
3458 "Face for headers in Info menus."
3459 :group 'info)
3461 (defun Info-escape-percent (string)
3462 "Double all occurrences of `%' in STRING.
3464 Return a new string with all `%' characters replaced by `%%'.
3465 Preserve text properties."
3466 (let ((start 0)
3467 (end (length string))
3468 mb me m matches)
3469 (save-match-data
3470 (while (and (< start end) (string-match "%" string start))
3471 (setq mb (match-beginning 0)
3472 me (1+ mb)
3473 m (substring string mb me)
3474 matches (cons m
3475 (cons m
3476 (cons (substring string start mb)
3477 matches)))
3478 start me))
3479 (push (substring string start end) matches)
3480 (apply #'concat (nreverse matches)))))
3482 (defvar Info-next-link-keymap
3483 (let ((keymap (make-sparse-keymap)))
3484 (define-key keymap [header-line mouse-1] 'Info-next)
3485 (define-key keymap [header-line mouse-2] 'Info-next)
3486 (define-key keymap [header-line down-mouse-1] 'ignore)
3487 (define-key keymap [mouse-2] 'Info-next)
3488 (define-key keymap [follow-link] 'mouse-face)
3489 keymap)
3490 "Keymap to put on the Next link in the text or the header line.")
3492 (defvar Info-prev-link-keymap
3493 (let ((keymap (make-sparse-keymap)))
3494 (define-key keymap [header-line mouse-1] 'Info-prev)
3495 (define-key keymap [header-line mouse-2] 'Info-prev)
3496 (define-key keymap [header-line down-mouse-1] 'ignore)
3497 (define-key keymap [mouse-2] 'Info-prev)
3498 (define-key keymap [follow-link] 'mouse-face)
3499 keymap)
3500 "Keymap to put on the Prev link in the text or the header line.")
3503 (defvar Info-up-link-keymap
3504 (let ((keymap (make-sparse-keymap)))
3505 (define-key keymap [header-line mouse-1] 'Info-up)
3506 (define-key keymap [header-line mouse-2] 'Info-up)
3507 (define-key keymap [header-line down-mouse-1] 'ignore)
3508 (define-key keymap [mouse-2] 'Info-up)
3509 (define-key keymap [follow-link] 'mouse-face)
3510 keymap)
3511 "Keymap to put on the Up link in the text or the header line.")
3513 (defun Info-fontify-node ()
3514 "Fontify the node."
3515 (save-excursion
3516 (let* ((inhibit-read-only t)
3517 (case-fold-search t)
3518 paragraph-markers
3519 (not-fontified-p ; the node hasn't already been fontified
3520 (not (let ((where (next-property-change (point-min))))
3521 (and where (not (= where (point-max)))))))
3522 (fontify-visited-p ; visited nodes need to be re-fontified
3523 (and Info-fontify-visited-nodes
3524 ;; Don't take time to refontify visited nodes in huge nodes
3525 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3526 rbeg rend)
3528 ;; Fontify header line
3529 (goto-char (point-min))
3531 (goto-char (match-end 0))
3533 (goto-char (match-end 0))
3534 (let* ((nbeg (match-beginning 2))
3535 (nend (match-end 2))
3536 (tbeg (match-beginning 1))
3537 (tag (match-string 1)))
3538 (if (string-equal tag "Node")
3539 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3540 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3541 (put-text-property tbeg nend 'mouse-face 'highlight)
3542 (put-text-property tbeg nend
3543 'help-echo
3544 (concat "mouse-2: Go to node "
3545 (buffer-substring nbeg nend)))
3546 ;; Always set up the text property keymap.
3547 ;; It will either be used in the buffer
3548 ;; or copied in the header line.
3549 (put-text-property tbeg nend 'keymap
3550 (cond
3551 ((equal tag "Prev") Info-prev-link-keymap)
3552 ((equal tag "Next") Info-next-link-keymap)
3553 ((equal tag "Up") Info-up-link-keymap))))))
3554 (when Info-use-header-line
3555 (goto-char (point-min))
3556 (let ((header-end (line-end-position))
3557 header)
3558 ;; If we find neither Next: nor Prev: link, show the entire
3559 ;; node header. Otherwise, don't show the File: and Node:
3560 ;; parts, to avoid wasting precious space on information that
3561 ;; is available in the mode line.
3562 (if (re-search-forward
3564 header-end t)
3565 (progn
3566 (goto-char (match-beginning 1))
3567 (setq header (buffer-substring (point) header-end)))
3569 (setq header
3570 (concat "No next, prev or up links -- "
3571 (buffer-substring (point) header-end)))
3572 (setq header (buffer-substring (point) header-end))))
3573 (put-text-property (point-min) (1+ (point-min))
3574 'header-line (Info-escape-percent header))
3575 ;; Hide the part of the first line
3576 ;; that is in the header, if it is just part.
3577 (unless (bobp)
3578 ;; Hide the punctuation at the end, too.
3580 (put-text-property (point) header-end 'invisible t)))))
3582 ;; Fontify titles
3583 (goto-char (point-min))
3584 (when not-fontified-p
3586 nil t)
3587 (let* ((c (preceding-char))
3588 (face
3589 (cond ((= c ?*) 'Info-title-1-face)
3590 ((= c ?=) 'Info-title-2-face)
3591 ((= c ?-) 'Info-title-3-face)
3592 (t 'Info-title-4-face))))
3593 (put-text-property (match-beginning 1) (match-end 1)
3594 'font-lock-face face))
3595 ;; This is a serious problem for trying to handle multiple
3596 ;; frame types at once. We want this text to be invisible
3597 ;; on frames that can display the font above.
3598 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3599 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3600 '(invisible t front-sticky nil rear-nonsticky t)))))
3602 ;; Fontify cross references
3603 (goto-char (point-min))
3604 (when (or not-fontified-p fontify-visited-p)
3605 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3606 (let ((start (match-beginning 0))
3607 (next (point))
3608 other-tag)
3609 (when not-fontified-p
3610 (when Info-hide-note-references
3611 (when (not (eq Info-hide-note-references 'hide))
3612 ;; *Note is often used where *note should have been
3613 (goto-char start)
3614 (skip-syntax-backward " ")
3615 (setq other-tag
3616 (cond ((memq (char-before) '(nil ?\. ?! ??))
3617 "See ")
3618 ((memq (char-before) '(?\, ?\; ?\: ?-))
3619 "see ")
3620 ((memq (char-before) '(?\( ?\[ ?\{))
3621 ;; Check whether the paren is preceded by
3622 ;; an end of sentence
3623 (skip-syntax-backward " (")
3624 (if (memq (char-before) '(nil ?\. ?! ??))
3625 "See "
3626 "see "))
3628 "See "))))
3629 (goto-char next)
3630 (add-text-properties
3631 (match-beginning 1)
3632 (or (save-match-data
3634 (let ((start1 (match-beginning 1)))
3636 (+ start1 (match-beginning 0)))))
3637 (match-end 1))
3638 (if other-tag
3639 `(display ,other-tag front-sticky nil rear-nonsticky t)
3640 '(invisible t front-sticky nil rear-nonsticky t))))
3641 (add-text-properties
3642 (match-beginning 2) (match-end 2)
3643 (list
3644 'help-echo (if (or (match-end 5)
3645 (not (equal (match-string 4) "")))
3646 (concat "mouse-2: go to " (or (match-string 5)
3647 (match-string 4)))
3648 "mouse-2: go to this node")
3649 'mouse-face 'highlight)))
3650 (when (or not-fontified-p fontify-visited-p)
3651 (setq rbeg (match-beginning 2)
3652 rend (match-end 2))
3653 (put-text-property
3654 rbeg rend
3655 'font-lock-face
3656 ;; Display visited nodes in a different face
3657 (if (and Info-fontify-visited-nodes
3658 (save-match-data
3659 (let* ((node (replace-regexp-in-string
3661 (replace-regexp-in-string
3663 (or (match-string 5)
3664 (and (not (equal (match-string 4) ""))
3665 (match-string 4))
3666 (match-string 2)))))
3667 (file (file-name-nondirectory
3668 Info-current-file))
3669 (hl Info-history-list)
3670 res)
3672 (setq file (file-name-nondirectory
3673 (match-string 1 node))
3674 node (if (equal (match-string 2 node) "")
3675 "Top"
3676 (match-string 2 node))))
3677 (while hl
3678 (if (and (string-equal node (nth 1 (car hl)))
3679 (string-equal file
3680 (file-name-nondirectory
3681 (nth 0 (car hl)))))
3682 (setq res (car hl) hl nil)
3683 (setq hl (cdr hl))))
3684 res))) 'info-xref-visited 'info-xref))
3685 ;; For multiline ref, unfontify newline and surrounding whitespace
3686 (save-excursion
3687 (goto-char rbeg)
3688 (save-match-data
3690 (remove-text-properties (match-beginning 0)
3691 (match-end 0)
3692 '(font-lock-face t))))))
3693 (when not-fontified-p
3694 (when (memq Info-hide-note-references '(t hide))
3695 (add-text-properties (match-beginning 3) (match-end 3)
3696 '(invisible t front-sticky nil rear-nonsticky t))
3697 ;; Unhide the file name of the external reference in parens
3698 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3699 (remove-text-properties (match-beginning 6) (match-end 6)
3700 '(invisible t front-sticky nil rear-nonsticky t)))
3701 ;; Unhide newline because hidden newlines cause too long lines
3702 (save-match-data
3703 (let ((beg3 (match-beginning 3))
3704 (end3 (match-end 3)))
3706 (not (save-match-data
3707 (save-excursion
3708 (goto-char (1+ end3))
3709 (looking-at "[.)]*$")))))
3710 (remove-text-properties (+ beg3 (match-beginning 0))
3711 (+ beg3 (match-end 0))
3712 '(invisible t front-sticky nil rear-nonsticky t))))))
3713 (when (and Info-refill-paragraphs Info-hide-note-references)
3714 (push (set-marker (make-marker) start)
3715 paragraph-markers))))))
3717 ;; Refill paragraphs (experimental feature)
3718 (when (and not-fontified-p
3719 Info-refill-paragraphs
3720 paragraph-markers)
3721 (let ((fill-nobreak-invisible t)
3722 (fill-individual-varying-indent nil)
3725 (adaptive-fill-mode nil))
3726 (goto-char (point-max))
3727 (while paragraph-markers
3728 (let ((m (car paragraph-markers)))
3729 (setq paragraph-markers (cdr paragraph-markers))
3730 (when (< m (point))
3731 (goto-char m)
3732 (beginning-of-line)
3733 (let ((beg (point)))
3734 (when (zerop (forward-paragraph))
3735 (fill-individual-paragraphs beg (point) nil nil)
3736 (goto-char beg))))
3737 (set-marker m nil)))))
3739 ;; Fontify menu items
3740 (goto-char (point-min))
3741 (when (and (or not-fontified-p fontify-visited-p)
3743 (not (Info-index-node))
3744 ;; Don't take time to annotate huge menus
3745 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3746 (let ((n 0)
3747 cont)
3748 (while (re-search-forward
3751 nil t)
3752 (when not-fontified-p
3753 (setq n (1+ n))
3754 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3755 (put-text-property (match-beginning 0)
3756 (1+ (match-beginning 0))
3757 'font-lock-face 'info-menu-5)))
3758 (when not-fontified-p
3759 (add-text-properties
3760 (match-beginning 1) (match-end 1)
3761 (list
3762 'help-echo (if (match-end 3)
3763 (concat "mouse-2: go to " (match-string 3))
3764 "mouse-2: go to this node")
3765 'mouse-face 'highlight)))
3766 (when (or not-fontified-p fontify-visited-p)
3767 (add-text-properties
3768 (match-beginning 1) (match-end 1)
3769 (list
3770 'font-lock-face
3771 ;; Display visited menu items in a different face
3772 (if (and Info-fontify-visited-nodes
3773 (save-match-data
3774 (let ((node (if (equal (match-string 3) "")
3775 (match-string 1)
3776 (match-string 3)))
3777 (file (file-name-nondirectory Info-current-file))
3778 (hl Info-history-list)
3779 res)
3781 (setq file (file-name-nondirectory
3782 (match-string 1 node))
3783 node (if (equal (match-string 2 node) "")
3784 "Top"
3785 (match-string 2 node))))
3786 (while hl
3787 (if (and (string-equal node (nth 1 (car hl)))
3788 (string-equal file
3789 (file-name-nondirectory
3790 (nth 0 (car hl)))))
3791 (setq res (car hl) hl nil)
3792 (setq hl (cdr hl))))
3793 res))) 'info-xref-visited 'info-xref))))
3794 (when (and not-fontified-p (memq Info-hide-note-references '(t hide)))
3795 (put-text-property (match-beginning 2) (1- (match-end 6))
3796 'invisible t)
3797 ;; Unhide the file name in parens
3798 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
3799 (remove-text-properties (match-beginning 4) (match-end 4)
3800 '(invisible t)))
3801 ;; We need a stretchable space like :align-to but with
3802 ;; a minimum value.
3803 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3804 (if (>= 22 (- (match-end 1)
3805 (match-beginning 0)))
3806 '(space :align-to 24)
3807 '(space :width 2)))
3808 (setq cont (looking-at "."))
3809 (while (and (= (forward-line 1) 0)
3811 (put-text-property (match-beginning 1) (1- (match-end 1))
3812 'invisible t)
3813 (put-text-property (1- (match-end 1)) (match-end 1)
3814 'display
3815 (if cont
3816 '(space :align-to 26)
3817 '(space :align-to 24)))
3818 (setq cont t))))))
3820 ;; Fontify menu headers
3821 ;; Add the face `info-menu-header' to any header before a menu entry
3822 (goto-char (point-min))
3824 (put-text-property (match-beginning 0) (match-end 0)
3825 'font-lock-face 'info-menu-header)
3827 (put-text-property (match-beginning 1) (match-end 1)
3828 'font-lock-face 'info-menu-header)))
3830 ;; Hide index line numbers
3831 (goto-char (point-min))
3832 (when (and not-fontified-p (Info-index-node))
3834 (put-text-property (match-beginning 0) (match-end 0)
3835 'invisible t)))
3837 ;; Fontify http and ftp references
3838 (goto-char (point-min))
3839 (when not-fontified-p
3841 (add-text-properties (match-beginning 0) (match-end 0)
3842 '(font-lock-face info-xref
3843 mouse-face highlight
3844 help-echo "mouse-2: go to this URL"))))
3846 (set-buffer-modified-p nil))))
3847 \f
3849 ;; When an Info buffer is killed, make sure the associated tags buffer
3850 ;; is killed too.
3851 (defun Info-kill-buffer ()
3852 (and (eq major-mode 'Info-mode)
3853 Info-tag-table-buffer
3854 (kill-buffer Info-tag-table-buffer)))
3856 (add-hook 'kill-buffer-hook 'Info-kill-buffer)
3858 ;;; Speedbar support:
3859 ;; These functions permit speedbar to display the "tags" in the
3860 ;; current info node.
3861 (eval-when-compile (require 'speedbar))
3863 (defvar Info-speedbar-key-map nil
3864 "Keymap used when in the info display mode.")
3866 (defun Info-install-speedbar-variables ()
3867 "Install those variables used by speedbar to enhance Info."
3868 (if Info-speedbar-key-map
3869 nil
3870 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
3872 ;; Basic tree features
3873 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
3874 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
3875 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
3876 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
3877 )
3879 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
3880 Info-speedbar-key-map
3881 Info-speedbar-hierarchy-buttons)))
3883 (defvar Info-speedbar-menu-items
3884 '(["Browse Node" speedbar-edit-line t]
3885 ["Expand Node" speedbar-expand-line
3886 (save-excursion (beginning-of-line)
3888 ["Contract Node" speedbar-contract-line
3889 (save-excursion (beginning-of-line)
3890 (looking-at "[0-9]+: *.-. "))]
3891 )
3892 "Additional menu-items to add to speedbar frame.")
3894 ;; Make sure our special speedbar major mode is loaded
3895 (if (featurep 'speedbar)
3896 (Info-install-speedbar-variables)
3897 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
3899 ;;; Info hierarchy display method
3900 ;;;###autoload
3901 (defun Info-speedbar-browser ()
3902 "Initialize speedbar to display an info node browser.
3903 This will add a speedbar major display mode."
3904 (interactive)
3905 (require 'speedbar)
3906 ;; Make sure that speedbar is active
3907 (speedbar-frame-mode 1)
3908 ;; Now, throw us into Info mode on speedbar.
3909 (speedbar-change-initial-expansion-list "Info")
3910 )
3912 (eval-when-compile (defvar speedbar-attached-frame))
3914 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
3915 "Display an Info directory hierarchy in speedbar.
3916 DIRECTORY is the current directory in the attached frame.
3917 DEPTH is the current indentation depth.
3918 NODE is an optional argument that is used to represent the
3919 specific node to expand."
3920 (if (and (not node)
3921 (save-excursion (goto-char (point-min))
3922 (let ((case-fold-search t))
3923 (looking-at "Info Nodes:"))))
3924 ;; Update our "current node" maybe?
3925 nil
3926 ;; We cannot use the generic list code, that depends on all leaves
3927 ;; being known at creation time.
3928 (if (not node)
3930 (let ((completions nil)
3931 (cf (selected-frame)))
3932 (select-frame speedbar-attached-frame)
3933 (save-window-excursion
3934 (setq completions
3935 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
3936 (select-frame cf)
3937 (if completions
3938 (speedbar-with-writable
3939 (dolist (completion completions)
3940 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
3941 (cdr completion)
3942 (car completion)
3943 'Info-speedbar-goto-node
3944 (cdr completion)
3945 'info-xref depth))
3946 t)
3947 nil))))
3949 (defun Info-speedbar-goto-node (text node indent)
3950 "When user clicks on TEXT, go to an info NODE.
3951 The INDENT level is ignored."
3952 (select-frame speedbar-attached-frame)
3953 (let* ((buff (or (get-buffer "*info*")
3954 (progn (info) (get-buffer "*info*"))))
3955 (bwin (get-buffer-window buff 0)))
3956 (if bwin
3957 (progn
3958 (select-window bwin)
3959 (raise-frame (window-frame bwin)))
3960 (if speedbar-power-click
3961 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
3962 (select-frame speedbar-attached-frame)
3963 (switch-to-buffer buff)))
3965 (error "Invalid node %s" node)
3966 (Info-find-node (match-string 1 node) (match-string 2 node))
3967 ;; If we do a find-node, and we were in info mode, restore
3968 ;; the old default method. Once we are in info mode, it makes
3969 ;; sense to return to whatever method the user was using before.
3970 (if (string= speedbar-initial-expansion-list-name "Info")
3971 (speedbar-change-initial-expansion-list
3972 speedbar-previously-used-expansion-list-name)))))
3974 (defun Info-speedbar-expand-node (text token indent)
3975 "Expand the node the user clicked on.
3976 TEXT is the text of the button we clicked on, a + or - item.
3977 TOKEN is data related to this node (NAME . FILE).
3978 INDENT is the current indentation depth."
3979 (cond ((string-match "+" text) ;we have to expand this file
3980 (speedbar-change-expand-button-char ?-)
3981 (if (speedbar-with-writable
3982 (save-excursion
3983 (end-of-line) (forward-char 1)
3984 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
3985 (speedbar-change-expand-button-char ?-)
3986 (speedbar-change-expand-button-char ??)))
3987 ((string-match "-" text) ;we have to contract this node
3988 (speedbar-change-expand-button-char ?+)
3989 (speedbar-delete-subblock indent))
3990 (t (error "Ooops... not sure what to do")))
3991 (speedbar-center-buffer-smartly))
3993 (defun Info-speedbar-fetch-file-nodes (nodespec)
3994 "Fetch the subnodes from the info NODESPEC.
3995 NODESPEC is a string of the form: (file)node.
3996 Optional THISFILE represends the filename of"
3997 (save-excursion
3998 ;; Set up a buffer we can use to fake-out Info.
3999 (set-buffer (get-buffer-create "*info-browse-tmp*"))
4000 (if (not (equal major-mode 'Info-mode))
4001 (Info-mode))
4002 ;; Get the node into this buffer
4004 (error "Invalid node specification %s" nodespec)
4005 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4006 ;; Scan the created buffer
4007 (goto-char (point-min))
4008 (let ((completions nil)
4009 (case-fold-search t)
4011 (match-string 1 nodespec))))
4012 ;; Always skip the first one...
4015 (let ((name (match-string 1)))
4016 (push (cons name
4018 (match-string 1)
4020 (concat (match-string 1) "Top")
4021 (concat "(" thisfile ")"
4023 (match-string 1)
4024 name)))))
4025 completions)))
4026 (nreverse completions))))
4028 ;;; Info mode node listing
4029 ;; FIXME: Seems not to be used. -stef
4030 (defun Info-speedbar-buttons (buffer)
4031 "Create a speedbar display to help navigation in an Info file.
4032 BUFFER is the buffer speedbar is requesting buttons for."
4033 (if (save-excursion (goto-char (point-min))
4034 (let ((case-fold-search t))
4035 (not (looking-at "Info Nodes:"))))
4036 (erase-buffer))
4037 (Info-speedbar-hierarchy-buttons nil 0)
4038 )
4040 (dolist (mess '("^Node has no Previous$"
4041 "^No menu in this node$"
4042 "^Node has no Next$"
4043 "^No cross-references in this node^"
4044 search-failed
4046 (add-to-list 'debug-ignored-errors mess))
4048 ;;;; Desktop support
4050 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4051 "Auxiliary information to be saved in desktop file."
4052 (if (not (member Info-current-file '("apropos" "history" "toc")))
4053 (list Info-current-file Info-current-node)))
4055 ;;;###autoload
4056 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4057 desktop-buffer-name
4058 desktop-buffer-misc)
4059 "Restore an info buffer specified in a desktop file."
4060 (let ((first (nth 0 desktop-buffer-misc))
4061 (second (nth 1 desktop-buffer-misc)))
4062 (when (and first second)
4063 (when desktop-buffer-name
4064 (set-buffer (get-buffer-create desktop-buffer-name))
4065 (Info-mode))
4066 (Info-find-node first second)
4067 (current-buffer))))
4069 (provide 'info)
4071 ;;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4072 ;;; info.el ends here