| blob | 085be1ae897e4be2dec732f09b7600e8ec115119 |
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 "List of all info nodes user has visited.
56 This is convenient if you want to write info files by hand.
57 However, we recommend that you not do this.
58 It is better to write a Texinfo file and generate the Info file from that,
59 because that gives you a printed manual as well."
64 "Non-nil allows Info to execute Lisp code associated with nodes.
72 "Face for Info node names."
78 "Face for every third `*' in an Info menu."
85 "Face for Info cross-references."
92 "Face for visited Info cross-references."
96 "*Non-nil means to fontify visited nodes in a different face."
102 "*Maximum size of menu to fontify if `font-lock-mode' is non-nil."
107 "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
108 A header-line does not scroll with the rest of the buffer."
114 "Face for Info cross-references in a node header."
119 "Face for Info nodes in a node header."
123 "List of directories to search for Info documentation files.
124 If nil, meaning not yet initialized, Info uses the environment
125 variable INFOPATH to initialize it, or `Info-default-directory-list'
126 if there is no INFOPATH variable in the environment, or the
127 concatenation of the two if INFOPATH ends with a colon.
129 When `Info-directory-list' is initialized from the value of
130 `Info-default-directory-list', and Emacs is installed in one of the
131 standard directories, the directory of Info files that come with Emacs
132 is put last (so that local Info files override standard ones).
134 When `Info-directory-list' is initialized from the value of
135 `Info-default-directory-list', and Emacs is not installed in one
136 of the standard directories, the first element of the resulting
137 list is the directory where Emacs installs the Info files that
138 come with it. This is so that Emacs's own manual, which suits the
139 version of Emacs you are using, will always be found first. This
140 is useful when you install an experimental version of Emacs without
141 removing the standard installation.
143 If you want to override the order of directories in
144 `Info-default-directory-list', set INFOPATH in the environment.
146 If you run the Emacs executable from the `src' directory in the Emacs
147 source tree, and INFOPATH is not defined, the `info' directory in the
148 source tree is used as the first element of `Info-directory-list', in
149 place of the installation Info directory. This is useful when you run
153 "List of additional directories to search for Info documentation files.
154 These directories are searched after those in `Info-directory-list'."
160 If this is non-nil, and you scroll far enough in a node that its menu
162 moves to a subnode indicated by the following menu item. This means
163 that you visit a subnode before getting to the end of the menu.
165 Setting this option to nil results in behavior similar to the stand-alone
166 Info reader program, which visits the first subnode from the menu only
167 when you hit the end of the current node."
173 "*If non-nil, hide the tag and section reference in *note and * menu items.
175 If value is non-nil but not t or `hide', the reference section is still shown."
184 "*If non-nil, attempt to refill paragraphs with hidden references.
185 This refilling may accidentally remove explicit line breaks in the info
186 file, so be prepared for a few surprises if you enable this feature."
192 "*If non-nil, regular expression to match a sequence of whitespace chars.
193 This applies to Info search for regular expressions.
195 In the Customization buffer, that is `[' followed by a space,
196 a tab, a carriage return (control-M), a newline, and `]+'."
201 ;; Try to obey obsolete Info-fontify settings.
204 "Hooks run when `Info-mode' is called."
209 "Hooks run when `Info-select-node' is called."
217 "Info file that Info is now looking at, or nil.
218 This is the name that was specified in Info, not the actual file name.
219 It doesn't contain directory names or file name extensions added by Info.
223 "Info subfile that is actually in the *info* buffer now.
230 "Marker pointing at beginning of current Info file's tag table.
243 "Point location within a selected node.
244 If string, the point is moved to the proper occurrence of the
245 name of the followed cross reference within a selected node.
250 \f
252 ;; The MS-DOS list should work both when long file names are
253 ;; supported (Windows 9X), and when only 8+3 file names are available.
295 "List of file name suffixes and associated decoding commands.
296 Each entry should be (SUFFIX . STRING); the file is given to
297 the command as standard input.
299 STRING may be a list of strings. In that case, the first element is
300 the command name, and the rest are arguments to that command.
302 If STRING is nil, no decoding is done.
303 Because the SUFFIXes are tried in order, the empty string should
306 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
307 ;; First, on MS-DOS with no long file names support, delete some of
308 ;; the extension in FILENAME to make room.
313 ;; How long is the extension in FILENAME (not counting the dot).
315 ext-left)
316 ;; SUFFIX starts with a dot. If FILENAME already has one,
317 ;; get rid of the one in SUFFIX (unless suffix is empty).
322 ;; How many chars of that extension should we keep?
324 ;; Get rid of the rest of the extension, and add SUFFIX.
327 suffix))))
334 "Insert the contents of an info file in the current buffer.
335 Do the right thing if the file has been compressed or zipped."
339 t))
341 lfn))
342 fullname decoder done)
344 ;; FILENAME exists--see if that name contains a suffix.
345 ;; If so, set DECODE accordingly.
350 filename)))
354 ;; Try adding suffixes to FILENAME and see if we can find something.
360 ;; If we found a file with a suffix, set DECODER
361 ;; according to the suffix.
363 ;; When the MS-DOS port runs on Windows, we need to check
364 ;; the short variant of a long file name as well.
374 ;; check for conflict with jka-compr
385 default-directory)))
391 \f
398 "../info/"
399 invocation-directory)))
401 infodir
403 "../../../info/"
404 invocation-directory))
406 infodir))))))
407 alternative)
410 ;; Uninstalled, Emacs builddir != srcdir.
411 sibling
412 ;; Uninstalled, builddir == srcdir
413 source))
415 ;; On DOS/NT, we use movable executables always,
416 ;; and we must always find the Info dir at run time.
418 nil
419 ;; Use invocation-directory for Info
420 ;; only if we used it for exec-directory also.
423 installation-directory))))
425 Info-default-directory-list
426 ;; `alternative' contains the Info files that came with this
427 ;; version, so we should look there first. `Info-insert-dir'
428 ;; currently expects to find `alternative' first on the list.
430 ;; Don't drop the last part, it might contain non-Emacs stuff.
431 ;; (reverse (cdr (reverse
435 "Initialize `Info-directory-list', if that hasn't been done yet."
448 ;;;###autoload
450 "Like `info' but show the Info buffer in another window."
456 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
458 ;;;###autoload
460 "Enter Info, the documentation browser.
461 Optional argument FILE specifies the file to examine;
462 the default is the top-level directory of Info.
463 Called from a program, FILE may specify an Info node of the form
464 `(FILENAME)NODENAME'.
465 Optional argument BUFFER specifies the Info buffer name;
466 the default buffer name is *info*. If BUFFER exists,
467 just switch to BUFFER. Otherwise, create a new buffer
468 with the top-level Info directory.
470 In interactive use, a non-numeric prefix argument directs
471 this command to read a file name from the minibuffer.
472 A numeric prefix argument appends the number to the buffer name.
474 The search path for Info files is in the variable `Info-directory-list'.
475 The top-level Info directory is made by combining all the files named `dir'
476 in all the directories in that path."
486 ;; If argument already contains parentheses, don't add another set
487 ;; since the argument will then be parsed improperly. This also
488 ;; has the added benefit of allowing node names to be included
489 ;; following the parenthesized filename.
496 ;;;###autoload
498 "Display the Emacs manual in Info mode."
502 ;;;###autoload
504 "Run Emacs as a standalone Info reader.
505 Usage: emacs -f info-standalone [filename]
519 \f
520 ;; See if the accessible portion of the buffer begins with a node
521 ;; delimiter, and the node header line which follows matches REGEXP.
522 ;; Typically, this test will be followed by a loop that examines the
523 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
524 ;; to have the overhead of this special test inside the loop.
526 ;; This function changes match-data, but supposedly the caller might
527 ;; want to use the results of re-search-backward.
529 ;; The return value is the value of point at the beginning of matching
530 ;; REGEXP, if the function succeeds, nil otherwise.
542 Optional second argument NOERROR, if t, means if file is not found
543 just return nil (no error)."
544 ;; Convert filename to lower case if not found as specified.
545 ;; Expand it.
560 ;; If specified name starts with `./'
561 ;; then just try current directory.
564 ;; No point in searching for an
565 ;; absolute file name
569 Info-additional-directory-list)
570 Info-directory-list)))))
571 ;; Search the directory list for file FILENAME.
576 ;; Try several variants of specified name.
580 t)))
591 lfn
603 filename)))
606 "Go to an info node specified as separate FILENAME and NODENAME.
607 NO-GOING-BACK is non-nil if recovering from an error in this function;
608 it says do not attempt further (recursive) error recovery."
611 ;; Record the node we are leaving.
615 Info-history)))
616 ;; Go into info buffer.
621 "Use the `Info-mode' to browse the current info buffer.
622 If a prefix arg is provided, it queries for the NODENAME which
634 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
635 ;; but at least it keeps this routine (which is only for the benefit of
636 ;; makeinfo-buffer) out of the way of normal operations.
637 ;;
639 "Go to an info node FILENAME and NODENAME, re-reading disk contents.
640 When *info* is already displaying FILENAME and NODENAME, the window position
641 is preserved, if possible."
657 ;; note goto-line is no good, we want to measure from point-min
664 ;; only add to the history when coming from a different file+node
669 "Find a node in a tag table.
670 MARKER specifies the buffer and position to start searching at.
671 REGEXP is a regular expression matching nodes or references. Its first
672 group should match `Node:' or `Ref:'.
673 CASE-FOLD t means search for a case-insensitive match.
674 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
675 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
676 where the match was found, and MODE is `major-mode' of the buffer in
677 which the match was found."
683 ;; Search tag table
688 major-mode)))))
691 "Find a node in a tag table.
692 MARKER specifies the buffer and position to start searching at.
693 REGEXP is a regular expression matching nodes or references. Its first
694 group should match `Node:' or `Ref:'.
695 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
696 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
697 where the match was found, and MODE is `major-mode' of the buffer in
698 which the match was found.
699 This function tries to find a case-sensitive match first, then a
700 case-insensitive match is tried."
704 result))
707 "Find a node or anchor in the current buffer.
708 REGEXP is a regular expression matching nodes or references. Its first
709 group should match `Node:' or `Ref:'.
710 CASE-FOLD t means search for a case-insensitive match.
711 Value is the position at which a match was found, or nil if not found."
713 found)
725 found)))
728 "Find a node or anchor in the current buffer.
729 REGEXP is a regular expression matching nodes or references. Its first
730 group should match `Node:' or `Ref:'.
731 Value is the position at which a match was found, or nil if not found.
732 This function looks for a case-sensitive match first. If none is found,
733 a case-insensitive match is tried."
745 anchorpos)
746 ;; Switch files if necessary
751 Info-current-subfile nil
752 Info-current-file-completions nil
753 buffer-file-name nil)
768 ;; See whether file has a tag table. Record the location if yes.
771 ;; Use string-equal, not equal, to ignore text props.
776 ;; We have a tag table. Find its beginning.
777 ;; Is this an indirect file?
783 ;; It is indirect. Copy it to another buffer
784 ;; and record that the tag table is in that buffer.
807 ))
808 ;; Use string-equal, not equal, to ignore text props.
812 ;; Possibilities:
813 ;;
814 ;; 1. Anchor found in tag table
815 ;; 2. Anchor *not* in tag table
816 ;;
817 ;; 3. Node found in tag table
818 ;; 4. Node *not* found in tag table, but found in file
819 ;; 5. Node *not* in tag table, and *not* in file
820 ;;
821 ;; *Or* the same, but in an indirect subfile.
823 ;; Search file for a suitable node.
833 ;; First, search a tag table, if any
839 ;; FOUND is (ANCHOR POS MODE).
842 ;; If this is an indirect file, determine which
843 ;; file really holds this node and read it in.
845 ;; Note that the current buffer must be the
846 ;; *info* buffer on entry to
847 ;; Info-read-subfile. Thus the hackery above.
850 ;; Handle anchor
855 ;; Else we may have a node, which we search for:
859 ;; Now search from our advised position (or from beg of
860 ;; buffer) to find the actual node. First, check
861 ;; whether the node is right where we are, in case the
862 ;; buffer begins with a node.
867 ;; No such anchor in tag table or node in tag table or file
875 ;; Add anchors to the history too
886 ;; If we did not finish finding the specified node,
887 ;; go back to the previous one.
894 ;; Cache the contents of the (virtual) dir file, once we have merged
895 ;; it for the first time, so we can save time subsequently.
898 ;; Cache for the directory we decided to use for the default-directory
899 ;; of the merged dir text.
902 ;; Record the file attributes of all the files from which we
903 ;; constructed Info-dir-contents.
908 ;; Construct the Info directory node by merging the files named `dir'
909 ;; from various directories. Set the *info* buffer's
910 ;; default-directory to the first directory we actually get any text
911 ;; from.
914 ;; Verify that none of the files we used has changed
915 ;; since we used it.
919 ;; Handle symlinks
922 ;; Don't compare the access time.
926 Info-dir-file-attributes))))
932 Info-additional-directory-list)
933 Info-directory-list))
935 ;; Bind this in case the user sets it to nil.
937 ;; This is set non-nil if we find a problem in some input files.
938 problems
939 buffers buffer others nodes dirs-done)
941 ;; Search the directory list for the directory file.
946 ;; Try several variants of specified name.
947 ;; Try upcasing, appending `.info', or both.
962 dirs-done)))
972 file)
984 ;; Distinguish the dir file that comes with Emacs from all the
985 ;; others. Yes, that is really what this is supposed to do.
986 ;; The definition of `Info-directory-list' puts it first on that
987 ;; list and so last in `buffers' at this point.
991 ;; Insert the entire original dir file as a start; note that we've
992 ;; already saved its default directory to use as the default
993 ;; directory for the whole concatenation.
996 ;; Look at each of the other buffers one by one.
999 ;; In each, find all the menus.
1002 ;; Find each menu, and add an elt to NODES for it.
1006 nodename end)
1018 ;; Add to the main menu a menu item for each other node.
1030 end t)
1034 ;; Now take each node of each of the other buffers
1035 ;; and merge it into the main buffer.
1040 ;; Find the like-named node in the main buffer.
1044 nil t)
1049 ;; If none exists, add one.
1052 ;; Merge the text from the other buffer's menu
1053 ;; into the menu in the like-named node in the main buffer.
1056 ;; Kill all the buffers we just made.
1076 ;; Remove duplicate headings in the same menu.
1079 ;; Look for the next heading to unify.
1084 ;; Check whether this heading should be streamlined.
1094 ;; Look for other headings of the same category and merge them.
1100 ;; Delete redundant heading.
1102 ;; Push the entries onto `text'.
1109 ;; Insert the entries just found.
1117 ;; Now remove duplicate entries under the same heading.
1130 ;; Note that on entry to this function the current-buffer must be the
1131 ;; *info* buffer; not the info tags buffer.
1133 ;; NODEPOS is either a position (in the Info file as a whole,
1134 ;; not relative to a subfile) or the name of a subfile.
1136 lastfilename)
1148 thisfilepos thisfilename)
1152 ;; read in version 19 stops at the end of number.
1153 ;; Advance to the next line.
1162 ;; Assume previous buffer is in Info-mode.
1163 ;; (set-buffer (get-buffer "*info*"))
1172 ;; Widen in case we are in the same subfile as before.
1182 "Unescape double quotes and backslashes in VALUE."
1188 unquote))
1190 ;; As of Texinfo 4.6, makeinfo writes constructs like
1191 ;; \0\h[image param=value ...\h\0]
1192 ;; into the Info file for handling images.
1195 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1196 whitespace or double quotes, it must be quoted in double quotes and
1201 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1202 parameter-string start)
1208 parameter-alist))
1209 parameter-alist))
1212 "Display images in current node."
1219 nil t)
1234 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1235 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1236 ;; including one optional trailing newline.
1238 "Hide unrecognised cookies in current node."
1245 nil t)
1252 "Select the info node that point is in."
1253 ;; Bind this in case the user sets it to nil.
1256 ;; Find beginning of node.
1262 ;; Get nodename spelled as it is in the node.
1270 ;; Find the end of it, and narrow.
1273 ;; Narrow to the node contents
1285 ;; Add a new unique history item to full history list
1301 Info-current-file
1303 ") "
1305 \f
1306 ;; Go to an info node specified with a filename-and-nodename string
1307 ;; of the sort that is found in pointers in nodes.
1310 "Go to info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1311 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1312 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1313 its sub-files).
1314 Completion is available, but only for node names in the current Info file.
1315 If FORK is non-nil (interactively with a prefix arg), show the node in
1316 a new info buffer.
1317 If FORK is a string, it is the name to use for the new buffer."
1325 nodename)
1327 ""
1340 ;; This function is used as the "completion table" while reading a node name.
1341 ;; It does completion using the alist in Info-read-node-completion-table
1342 ;; unless STRING starts with an open-paren.
1345 ;; First complete embedded file names.
1360 ;; If a file name was given, then any node is fair game.
1366 ;; Otherwise use Info-read-node-completion-table.
1381 nodename)))
1386 ;; Bind this in case the user sets it to nil.
1399 compl))))
1402 ;; If the buffer begins with a node header, process that first.
1405 ;; Now for the rest of the nodes.
1413 compl))))))))
1416 \f
1418 "If this node has been visited, restore the point value when we left."
1421 ;; Use string-equal, not equal, to ignore text props.
1427 \f
1435 "Search for REGEXP, starting from point, and select node it's found in."
1468 ;; If no subfiles, give error now.
1476 ;; Try other subfiles.
1487 ;; Find the subfile we just searched.
1489 ;; Skip that one.
1491 ;; Make a list of all following subfiles.
1492 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1499 list))
1501 ;; Put in forward order
1529 ;; Use string-equal, not equal, to ignore text props.
1533 Info-history))))))
1536 "Search for a regexp case-sensitively."
1542 "Search for next regexp from a previous `Info-search' command."
1548 \f
1550 "Extract the value of the node-pointer named NAME.
1551 If there is none, use ERRORNAME in the error message;
1552 if ERRORNAME is nil, just return nil."
1553 ;; Bind this in case the user sets it to nil.
1567 "Return a regexp matching a node name.
1568 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1569 saying which chars may appear in the node name.
1570 Submatch 1 is the complete node name.
1571 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1572 Submatch 3 is the local part of the node name.
1573 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1580 ;;; For compatibility; other files have used this name.
1586 "Go to the next node of this node."
1591 "Go to the previous node of this node."
1596 "Go to the superior node of this node.
1597 If SAME-FILE is non-nil, do not move to a different Info file."
1614 nil t))
1620 "Go back to the last node visited."
1633 ;;;###autoload
1635 "Go to the Info directory node."
1638 \f
1640 "Go to a node with a menu of visited nodes."
1644 p)
1666 "Go to a node with table of contents of the current Info file."
1670 p)
1694 "Insert table of contents with references to nodes."
1706 "Build table of contents from menus of Info FILE and its subfiles."
1713 default-directory))
1715 nodes subfiles)
1726 menu-items)
1735 bound))
1738 ;; Menu item line
1748 ;; Other non-empty strings in the Top node are section names
1757 nodes))
1766 subfiles)))))
1768 file nil))
1772 \f
1774 "Follow cross reference named FOOTNOTENAME to the node it refers to.
1775 FOOTNOTENAME may be an abbreviation of the reference name.
1776 If FORK is non-nil (interactively with a prefix arg), show the node in
1777 a new info buffer. If FORK is a string, it is the name to use for the
1778 new buffer."
1784 ;; Store end and beginning of line.
1793 ;; See if this one should be the default.
1798 ;; See if this one should be the alternate default.
1808 ;; Record as a completion and perhaps as default.
1811 ;; Don't add this string if it's a duplicate.
1814 ;; If no good default was found, try an alternate.
1817 ;; If only one cross-reference found, then make it default.
1823 "Follow reference named: (default "
1826 completions nil t)))
1840 ;; Move point to the beginning of reference if point is on reference
1850 ;; Go to the reference closest to point
1858 next-ref prev-ref))
1869 ;; We allow newline because this is also used in Info-follow-reference,
1870 ;; where the xref name might be wrapped over two lines.
1871 "Regexp that matches a menu entry name upto but not including the colon.
1872 Because of ambiguities, this should be concatenated with something like
1892 ;;; Comment out the next line to use names of cross-references:
1893 ;;; (setq Info-point-loc
1894 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
1895 )
1899 ;; If the node name is the menu entry name (using `entry::').
1902 ;; No one calls this.
1903 ;;(defun Info-menu-item-sequence (list)
1904 ;; (while list
1905 ;; (Info-menu (car list))
1906 ;; (setq list (cdr list))))
1917 ;; This uses two dynamically bound variables:
1918 ;; - `Info-complete-menu-buffer' which contains the buffer in which
1919 ;; is the menu of items we're trying to complete.
1920 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
1921 ;; also look for menu items in subsequent nodes as long as those
1922 ;; nodes' names match `Info-complete-next-re'. This feature is currently
1923 ;; only used for completion in Info-index.
1925 ;; Note that `Info-complete-menu-buffer' could be current already,
1926 ;; so we want to save point.
1932 nextnode)
1941 completions)
1942 ;; Check the cache.
1949 ;; We can reuse the previous list.
1951 ;; The cache can't be used.
1956 completions))
1957 ;; Check subsequent nodes if applicable.
1962 ;; Go back to the start node (for the next completion).
1965 ;; Update the cache.
1968 Info-complete-next-re string completions)))
1975 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
1976 The menu item should one of those listed in the current node's menu.
1977 Completion is allowed, and the default menu item is the one point is on.
1978 If FORK is non-nil (interactively with a prefix arg), show the node in
1979 a new info buffer. If FORK is a string, it is the name to use for the
1980 new buffer."
1983 ;; If point is within a menu item, use that item as the default
1986 beg
1999 Info-menu-entry-name-re
2008 default)
2011 ;; we rely on the fact that completing-read accepts an input
2012 ;; of "" even when the require-match argument is true and ""
2013 ;; is not a valid possibility
2017 ;; ask again
2020 ;; there is a problem here in that if several menu items have the same
2021 ;; name you can only go to the node of the first with this command.
2039 ;; If COUNT is nil, use the last item in the menu.
2051 nil))
2055 "Go to the node of the Nth menu item.
2056 N is the digit argument used to invoke this command."
2063 "Go to the Top node of this file."
2068 "Go to the final node in this file."
2073 ;; Go to the last node in the menu of Top.
2075 ;; If the last node in the menu is not last in pointer structure,
2076 ;; move forward until we can't go any farther.
2078 ;; Then keep moving down to last subnode, unless we reach an index.
2084 "Go forward one node, considering all nodes as forming one sequence."
2089 ;; three possibilities, in order of priority:
2090 ;; 1. next node is in a menu in this node (but not in an index)
2091 ;; 2. next node is next at same level
2092 ;; 3. next node is up and next
2097 t)
2100 t)
2102 ;; Use string-equal, not equal, to ignore text props.
2115 "Go backward one node, considering all nodes as forming one sequence."
2123 ;; Use string-equal, not equal,
2124 ;; to ignore text properties.
2129 ;; If we move back at the same level,
2130 ;; go down to find the last subnode*.
2140 "Exit Info by selecting some other buffer."
2147 "Go to the node of the next menu item."
2149 ;; Bind this in case the user sets it to nil.
2161 "Go to the node of the previous menu item."
2165 ;; Bind this in case the user sets it to nil.
2180 "Go to the next subnode or the next node, or go up a level."
2185 ;; Since we have already gone thru all the items in this menu,
2186 ;; go up to the end of this node.
2188 ;; Since logically we are done with the node with that menu,
2189 ;; move on from it.
2195 "Go to the last node, popping up a level if there is none."
2199 ;; If we go down a menu item, go to the end of the node
2200 ;; so we can scroll back through it.
2202 ;; Keep going down, as long as there are nested menu nodes.
2205 ;; If we go down a menu item, go to the end of the node
2206 ;; so we can scroll back through it.
2216 ;; If we go down a menu item, go to the end of the node
2217 ;; so we can scroll back through it.
2228 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2229 Once you scroll far enough in a node that its menu appears on the screen
2230 but after point, the next scroll moves into its first subnode, unless
2231 `Info-scroll-prefer-subnodes' is nil.
2233 When you scroll past the end of a node, that goes to the next node if
2234 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2235 if this node has no successor, it moves to the parent node's successor,
2236 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2237 the menu of a node, it moves to subnode indicated by the following menu
2238 item. (That case won't normally result from this command, but can happen
2239 in other ways.)"
2261 "Scroll one screenful back in Info, considering all nodes as one sequence.
2262 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2263 is non-nil, this goes to its last subnode. When you scroll past the
2264 beginning of a node, that goes to the previous node or back up to the
2265 parent node."
2279 current-point
2280 t)))))
2287 "Move cursor to the next cross-reference or menu item in the node."
2307 "Move cursor to the previous cross-reference or menu item in the node."
2332 ;; Protect Info-history so that the current node (Top) is not added to it.
2336 ;;;###autoload
2338 "Look up a string TOPIC in the index for this file.
2339 The index is defined as the first node in the top level menu whose
2342 If there are no exact matches to the specified topic, this chooses
2343 the first match which is a case-insensitive substring of a topic.
2345 Give a blank topic name to go to the Index node itself."
2360 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2362 node
2368 ;; We bind Info-history to nil for internal node-switches so
2369 ;; that we don't put junk in the history. In the first
2370 ;; Info-goto-index call, above, we do update the history
2371 ;; because that is what the user's previous node choice into it.
2373 found)
2380 Info-current-node
2383 matches))
2391 ;; Here it is a feature that assoc is case-sensitive.
2420 "(`,' tries to find next)"
2424 "Move point to the place within the current node where NAME is defined."
2429 ;; Find a function definition with a return type.
2437 nil t))
2439 ;; Try again without the " <1>" makeinfo can append
2445 ;;;###autoload
2447 "Grovel indices of all known Info files on your system for STRING.
2448 Build a menu of the possible matches."
2451 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2457 manuals matches node)
2459 Info-use-header-lines
2460 Info-hide-note-references)
2490 Info-history-list ohist-list)
2511 "Make command be undefined in Info."
2516 "Enter the Info tutorial."
2521 "Help-Small-Screen"
2525 "Display a brief summary of all Info commands."
2540 flag))
2543 \f
2545 "Return the token around POS.
2546 POS must be somewhere inside the token
2547 START is a regular expression which will match the
2548 beginning of the tokens delimited string
2549 ALL is a regular expression with a single
2550 parenthesized subpattern which is the token to be
2551 returned. E.g. '{\(.*\)}' would return any string
2552 enclosed in braces around POS.
2553 ERRORSTRING optional fourth argument, controls action on no match
2554 nil: return nil
2555 t: beep
2556 a string: signal an error, using that string."
2560 ;; First look for a match for START that goes across POS.
2564 ;; If we did not find one, search back for START
2565 ;; (this finds only matches that end at or before POS).
2578 nil)
2581 nil)
2587 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
2588 At end of the node's text, moves to the next node, or up if none."
2596 "Follow a node reference near point.
2597 If point is on a reference, follow that reference. Otherwise,
2598 if point is in a menu item description, follow that menu item."
2610 t)))
2613 ;; Common subroutine.
2615 "Follow a node reference near point. Return non-nil if successful."
2625 ;; menu item: node name
2628 ;; menu item: node name or index entry
2643 node))
2644 \f
2648 nil
2657 (define-key Info-mode-map "1" 'Info-nth-menu-item)
2658 (define-key Info-mode-map "2" 'Info-nth-menu-item)
2659 (define-key Info-mode-map "3" 'Info-nth-menu-item)
2660 (define-key Info-mode-map "4" 'Info-nth-menu-item)
2661 (define-key Info-mode-map "5" 'Info-nth-menu-item)
2662 (define-key Info-mode-map "6" 'Info-nth-menu-item)
2663 (define-key Info-mode-map "7" 'Info-nth-menu-item)
2664 (define-key Info-mode-map "8" 'Info-nth-menu-item)
2665 (define-key Info-mode-map "9" 'Info-nth-menu-item)
2666 (define-key Info-mode-map "0" 'undefined)
2667 (define-key Info-mode-map "?" 'Info-summary)
2668 (define-key Info-mode-map "]" 'Info-forward-node)
2669 (define-key Info-mode-map "[" 'Info-backward-node)
2670 (define-key Info-mode-map "<" 'Info-top-node)
2671 (define-key Info-mode-map ">" 'Info-final-node)
2672 (define-key Info-mode-map "b" 'beginning-of-buffer)
2673 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
2674 (define-key Info-mode-map "d" 'Info-directory)
2675 (define-key Info-mode-map "e" 'Info-edit)
2676 (define-key Info-mode-map "f" 'Info-follow-reference)
2677 (define-key Info-mode-map "g" 'Info-goto-node)
2678 (define-key Info-mode-map "h" 'Info-help)
2679 (define-key Info-mode-map "i" 'Info-index)
2680 (define-key Info-mode-map "l" 'Info-last)
2681 (define-key Info-mode-map "m" 'Info-menu)
2682 (define-key Info-mode-map "n" 'Info-next)
2683 (define-key Info-mode-map "p" 'Info-prev)
2684 (define-key Info-mode-map "q" 'Info-exit)
2685 (define-key Info-mode-map "s" 'Info-search)
2686 ;; For consistency with Rmail.
2687 (define-key Info-mode-map "\M-s" 'Info-search)
2688 (define-key Info-mode-map "\M-n" 'clone-buffer)
2689 (define-key Info-mode-map "t" 'Info-top-node)
2690 (define-key Info-mode-map "u" 'Info-up)
2691 (define-key Info-mode-map "," 'Info-index-next)
2693 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
2694 )
2696 (defun Info-check-pointer (item)
2697 "Non-nil if ITEM is present in this node."
2698 (condition-case nil
2699 (Info-extract-pointer item)
2700 (error nil)))
2702 (easy-menu-define
2703 Info-mode-menu Info-mode-map
2704 "Menu for info files."
2705 '("Info"
2706 ["Up" Info-up :active (Info-check-pointer "up")
2707 :help "Go up in the Info tree"]
2708 ["Next" Info-next :active (Info-check-pointer "next")
2709 :help "Go to the next node"]
2710 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
2711 :help "Go to the previous node"]
2712 ["Backward" Info-backward-node
2713 :help "Go backward one node, considering all as a sequence"]
2714 ["Forward" Info-forward-node
2715 :help "Go forward one node, considering all as a sequence"]
2716 ["Beginning" beginning-of-buffer
2717 :help "Go to beginning of this node"]
2718 ["Top" Info-top-node
2719 :help "Go to top node of file"]
2720 ["Final Node" Info-final-node
2721 :help "Go to final node in this file"]
2722 ("Menu Item" ["You should never see this" report-emacs-bug t])
2723 ("Reference" ["You should never see this" report-emacs-bug t])
2724 ["Search..." Info-search
2725 :help "Search for regular expression in this Info file"]
2726 ["Search Case-Sensitively..." Info-search-case-sensitively
2727 :help "Search for regular expression case sensitively"]
2728 ["Search Next" Info-search-next
2729 :help "Search for another occurrence of regular expression"]
2730 ["Go to Node..." Info-goto-node
2731 :help "Go to a named node"]
2732 ["Last" Info-last :active Info-history
2733 :help "Go to the last node you were at"]
2734 ["History" Info-history :active Info-history-list
2735 :help "Go to the history buffer"]
2736 ["Table of Contents" Info-toc
2737 :help "Go to the buffer with a table of contents"]
2738 ("Index..."
2739 ["Lookup a String" Info-index
2740 :help "Look for a string in the index items"]
2741 ["Next Matching Item" Info-index-next
2742 :help "Look for another occurrence of previous item"]
2743 ["Lookup a string in all indices" info-apropos
2744 :help "Look for a string in the indices of all manuals"])
2745 ["Edit" Info-edit :help "Edit contents of this node"
2746 :active Info-enable-edit]
2747 ["Copy Node Name" Info-copy-current-node-name
2748 :help "Copy the name of the current node into the kill ring"]
2749 ["Clone Info buffer" clone-buffer
2750 :help "Create a twin copy of the current Info buffer."]
2751 ["Exit" Info-exit :help "Stop reading Info"]))
2754 (defvar info-tool-bar-map
2755 (if (display-graphic-p)
2756 (let ((map (make-sparse-keymap)))
2757 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
2758 (tool-bar-local-item-from-menu 'Info-prev "left_arrow" map Info-mode-map)
2759 (tool-bar-local-item-from-menu 'Info-next "right_arrow" map Info-mode-map)
2760 (tool-bar-local-item-from-menu 'Info-up "up_arrow" map Info-mode-map)
2761 (tool-bar-local-item-from-menu 'Info-last "undo" map Info-mode-map)
2762 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
2763 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
2764 (tool-bar-local-item-from-menu 'Info-goto-node "jump_to" map Info-mode-map)
2765 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
2766 map)))
2768 (defvar Info-menu-last-node nil)
2769 ;; Last node the menu was created for.
2770 ;; Value is a list, (FILE-NAME NODE-NAME).
2772 (defun Info-menu-update ()
2773 "Update the Info menu for the current node."
2774 (condition-case nil
2775 (if (or (not (eq major-mode 'Info-mode))
2776 (equal (list Info-current-file Info-current-node)
2777 Info-menu-last-node))
2778 ()
2779 ;; Update menu menu.
2780 (let* ((Info-complete-menu-buffer (current-buffer))
2781 (items (nreverse (condition-case nil
2782 (Info-complete-menu-item "" nil t)
2783 (error nil))))
2784 entries current
2785 (number 0))
2786 (while (and items (< number 9))
2787 (setq current (car items)
2788 items (cdr items)
2789 number (1+ number))
2790 (setq entries (cons `[,current
2791 (Info-menu ,current)
2792 :keys ,(format "%d" number)]
2793 entries)))
2794 (if items
2795 (setq entries (cons ["Other..." Info-menu t] entries)))
2796 (or entries
2797 (setq entries (list ["No menu" nil nil] nil :active)))
2798 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
2799 ;; Update reference menu. Code stolen from `Info-follow-reference'.
2800 (let ((items nil)
2801 str i entries current
2802 (number 0)
2803 (case-fold-search t))
2804 (save-excursion
2805 (goto-char (point-min))
2807 (setq str (match-string 1))
2808 (setq i 0)
2810 (setq str (concat (substring str 0 i) " "
2811 (substring str (match-end 0))))
2812 (setq i (1+ i)))
2813 (setq items
2814 (cons str items))))
2815 (while (and items (< number 9))
2816 (setq current (car items)
2817 items (cdr items)
2818 number (1+ number))
2819 (setq entries (cons `[,current
2820 (Info-follow-reference ,current)
2821 t]
2822 entries)))
2823 (if items
2824 (setq entries (cons ["Other..." Info-follow-reference t]
2825 entries)))
2826 (or entries
2827 (setq entries (list ["No references" nil nil] nil :active)))
2828 (easy-menu-change '("Info") "Reference" (nreverse entries)))
2829 ;; Update last seen node.
2830 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
2831 ;; Try to avoid entering infinite beep mode in case of errors.
2832 (error (ding))))
2834 \f
2835 (defun Info-copy-current-node-name ()
2836 "Put the name of the current info node into the kill ring.
2837 The name of the info file is prepended to the node name in parentheses."
2838 (interactive)
2839 (unless Info-current-node
2840 (error "No current info node"))
2841 (kill-new
2842 (concat "("
2843 (file-name-nondirectory
2844 (if (stringp Info-current-file)
2845 Info-current-file
2846 (or buffer-file-name "")))
2847 ")"
2848 Info-current-node)))
2850 \f
2851 ;; Info mode is suitable only for specially formatted data.
2852 (put 'Info-mode 'mode-class 'special)
2853 (put 'Info-mode 'no-clone-indirect t)
2855 (defun Info-mode ()
2856 "Info mode provides commands for browsing through the Info documentation tree.
2858 one topic and contains references to other nodes which discuss related
2859 topics. Info has commands to follow the references and show you other nodes.
2865 Selecting other nodes:
2867 Follow a node reference you click on.
2868 This works with menu items, cross references, and
2870 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
2875 Picking a menu item causes another node to be selected.
2882 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
2889 Moving within a node:
2891 Once you scroll far enough in a node that its menu appears on the
2892 screen but after point, the next scroll moves into its first
2893 subnode. When after all menu items (or if there is no menu),
2894 move up to the parent node.
2896 already visible, try to go to the previous menu entry, or up
2897 if there is none.
2900 Advanced commands:
2904 1 Pick first item in node's menu.
2905 2, 3, 4, 5 Pick second ... fifth item in node's menu.
2907 You may include a filename as well, as (FILENAME)NODENAME.
2910 and select the node in which the next occurrence is found.
2912 for specified regexp case-sensitively.
2917 (kill-all-local-variables)
2918 (setq major-mode 'Info-mode)
2919 (setq mode-name "Info")
2920 (setq tab-width 8)
2921 (use-local-map Info-mode-map)
2922 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
2923 (set-syntax-table text-mode-syntax-table)
2924 (setq local-abbrev-table text-mode-abbrev-table)
2925 (setq case-fold-search t)
2926 (setq buffer-read-only t)
2927 (make-local-variable 'Info-current-file)
2928 (make-local-variable 'Info-current-subfile)
2929 (make-local-variable 'Info-current-node)
2930 (make-local-variable 'Info-tag-table-marker)
2931 (setq Info-tag-table-marker (make-marker))
2932 (make-local-variable 'Info-tag-table-buffer)
2933 (setq Info-tag-table-buffer nil)
2934 (make-local-variable 'Info-history)
2935 (make-local-variable 'Info-index-alternatives)
2936 (setq header-line-format
2937 (if Info-use-header-line
2938 '(:eval (get-text-property (point-min) 'header-line))
2939 nil)) ; so the header line isn't displayed
2940 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
2941 ;; This is for the sake of the invisible text we use handling titles.
2942 (make-local-variable 'line-move-ignore-invisible)
2943 (setq line-move-ignore-invisible t)
2944 (make-local-variable 'desktop-save-buffer)
2945 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
2946 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
2947 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
2948 (Info-set-mode-line)
2949 (run-hooks 'Info-mode-hook))
2951 (defun Info-clone-buffer-hook ()
2952 (when (bufferp Info-tag-table-buffer)
2953 (setq Info-tag-table-buffer
2954 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
2955 (let ((m Info-tag-table-marker))
2956 (when (markerp m)
2957 (setq Info-tag-table-marker
2958 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
2959 (with-current-buffer Info-tag-table-buffer
2960 (copy-marker (marker-position m)))
2961 (make-marker))))))
2963 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
2964 (set-keymap-parent map text-mode-map)
2965 (define-key map "\C-c\C-c" 'Info-cease-edit)
2966 map)
2967 "Local keymap used within `e' command of Info.")
2969 ;; Info-edit mode is suitable only for specially formatted data.
2970 (put 'Info-edit-mode 'mode-class 'special)
2972 (defun Info-edit-mode ()
2973 "Major mode for editing the contents of an Info node.
2974 Like text mode with the addition of `Info-cease-edit'
2975 which returns to Info mode for browsing.
2977 (use-local-map Info-edit-map)
2978 (setq major-mode 'Info-edit-mode)
2979 (setq mode-name "Info Edit")
2980 (kill-local-variable 'mode-line-buffer-identification)
2981 (setq buffer-read-only nil)
2982 (force-mode-line-update)
2983 (buffer-enable-undo (current-buffer))
2984 (run-hooks 'Info-edit-mode-hook))
2986 (defun Info-edit ()
2987 "Edit the contents of this Info node.
2988 Allowed only if variable `Info-enable-edit' is non-nil."
2989 (interactive)
2990 (or Info-enable-edit
2991 (error "Editing info nodes is not enabled"))
2992 (Info-edit-mode)
2993 (message "%s" (substitute-command-keys
2996 (defun Info-cease-edit ()
2997 "Finish editing Info node; switch back to Info proper."
2998 (interactive)
2999 ;; Do this first, so nothing has changed if user C-g's at query.
3000 (and (buffer-modified-p)
3001 (y-or-n-p "Save the file? ")
3002 (save-buffer))
3003 (use-local-map Info-mode-map)
3004 (setq major-mode 'Info-mode)
3005 (setq mode-name "Info")
3006 (Info-set-mode-line)
3007 (setq buffer-read-only t)
3008 (force-mode-line-update)
3009 (and (marker-position Info-tag-table-marker)
3010 (buffer-modified-p)
3011 (message "Tags may have changed. Use Info-tagify if necessary")))
3012 \f
3013 (defvar Info-file-list-for-emacs
3014 '("ediff" "eudc" "forms" "gnus" "info" ("mh" . "mh-e")
3015 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3016 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3017 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3018 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3019 ("copyright" . "autotype") ("executable" . "autotype")
3020 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3021 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3022 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3023 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3024 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3025 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3026 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3027 ("rfc2045" . "emacs-mime")
3028 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3029 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3030 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3031 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3032 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3033 ("mml" . "emacs-mime"))
3034 "List of Info files that describe Emacs commands.
3035 An element can be a file name, or a list of the form (PREFIX . FILE)
3036 where PREFIX is a name prefix and FILE is the file to look in.
3037 If the element is just a file name, the file name also serves as the prefix.")
3039 (defun Info-find-emacs-command-nodes (command)
3040 "Return a list of locations documenting COMMAND.
3041 The `info-file' property of COMMAND says which Info manual to search.
3042 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3043 defines heuristics for which Info manual to try.
3044 The locations are of the format used in `Info-history', i.e.
3045 \(FILENAME NODENAME BUFFERPOS\)."
3046 (let ((where '())
3049 (info-file "emacs")) ;default
3050 ;; Determine which info file this command is documented in.
3051 (if (get command 'info-file)
3052 (setq info-file (get command 'info-file))
3053 ;; If it doesn't say explicitly, test its name against
3054 ;; various prefixes that we know.
3055 (let ((file-list Info-file-list-for-emacs))
3056 (while file-list
3057 (let* ((elt (car file-list))
3058 (name (if (consp elt)
3059 (car elt)
3060 elt))
3061 (file (if (consp elt) (cdr elt) elt))
3064 (if (string-match regexp (symbol-name command))
3065 (setq info-file file file-list nil))
3066 (setq file-list (cdr file-list))))))
3067 (Info-find-node info-file "Top")
3070 (error "Info file `%s' appears to lack an index" info-file))
3071 (goto-char (match-beginning 1))
3072 ;; Bind Info-history to nil, to prevent the index nodes from
3073 ;; getting into the node history.
3074 (let ((Info-history nil)
3075 node)
3076 (Info-goto-node (Info-extract-menu-node-name))
3077 (while
3078 (progn
3079 (goto-char (point-min))
3080 (while (re-search-forward cmd-desc nil t)
3081 (setq where
3082 (cons (list Info-current-file
3083 (match-string-no-properties 2)
3084 0)
3085 where)))
3086 (and (setq node (Info-extract-pointer "next" t))
3088 (Info-goto-node node)))
3089 where))
3091 ;;;###autoload
3092 (defun Info-goto-emacs-command-node (command)
3093 "Go to the Info node in the Emacs manual for command COMMAND.
3094 The command is found by looking up in Emacs manual's indices
3095 or in another manual found via COMMAND's `info-file' property or
3096 the variable `Info-file-list-for-emacs'.
3097 COMMAND must be a symbol or string."
3098 (interactive "CFind documentation for command: ")
3099 ;; If command is given as a string, convert it to a symbol.
3100 (if (stringp command)
3101 (setq command (intern command)))
3102 (or (commandp command)
3103 (signal 'wrong-type-argument (list 'commandp command)))
3104 (let ((where (Info-find-emacs-command-nodes command)))
3105 (if where
3106 (let ((num-matches (length where)))
3107 ;; Get Info running, and pop to it in another window.
3108 (save-window-excursion
3109 (info))
3110 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3111 ;; Bind Info-history to nil, to prevent the last Index node
3112 ;; visited by Info-find-emacs-command-nodes from being
3113 ;; pushed onto the history.
3114 (let ((Info-history nil))
3115 (Info-find-node (car (car where))
3116 (car (cdr (car where)))))
3117 (if (> num-matches 1)
3118 (progn
3119 ;; (car where) will be pushed onto Info-history
3120 ;; when/if they go to another node. Put the other
3121 ;; nodes that were found on the history.
3122 (setq Info-history (nconc (cdr where) Info-history))
3123 (message "Found %d other entr%s. Use %s to see %s."
3124 (1- num-matches)
3125 (if (> num-matches 2) "ies" "y")
3127 (if (> num-matches 2) "them" "it")))))
3128 (error "Couldn't find documentation for %s" command))))
3130 ;;;###autoload
3131 (defun Info-goto-emacs-key-command-node (key)
3132 "Go to the node in the Emacs manual which describes the command bound to KEY.
3133 KEY is a string.
3134 Interactively, if the binding is `execute-extended-command', a command is read.
3135 The command is found by looking up in Emacs manual's indices
3136 or in another manual found via COMMAND's `info-file' property or
3137 the variable `Info-file-list-for-emacs'."
3138 (interactive "kFind documentation for key: ")
3139 (let ((command (key-binding key)))
3140 (cond ((null command)
3141 (message "%s is undefined" (key-description key)))
3142 ((and (interactive-p)
3143 (eq command 'execute-extended-command))
3144 (Info-goto-emacs-command-node
3145 (read-command "Find documentation for command: ")))
3146 (t
3147 (Info-goto-emacs-command-node command)))))
3148 \f
3149 (defface Info-title-1-face
3150 '((((type tty pc) (class color)) :foreground "yellow" :weight bold)
3151 (t :height 1.2 :inherit Info-title-2-face))
3152 "Face for Info titles at level 1."
3153 :group 'info)
3155 (defface Info-title-2-face
3156 '((((type tty pc) (class color)) :foreground "lightblue" :weight bold)
3157 (t :height 1.2 :inherit Info-title-3-face))
3158 "Face for Info titles at level 2."
3159 :group 'info)
3161 (defface Info-title-3-face
3162 '((((type tty pc) (class color)) :weight bold)
3163 (t :height 1.2 :inherit Info-title-4-face))
3164 "Face for Info titles at level 3."
3165 :group 'info)
3167 (defface Info-title-4-face
3168 '((((type tty pc) (class color)) :weight bold)
3169 (t :weight bold :inherit variable-pitch))
3170 "Face for Info titles at level 4."
3171 :group 'info)
3173 (defface info-menu-header
3174 '((((type tty pc))
3175 :underline t
3176 :weight bold)
3177 (t
3178 :inherit variable-pitch
3179 :weight bold))
3180 "Face for headers in Info menus."
3181 :group 'info)
3183 (defun Info-escape-percent (string)
3184 "Double all occurrences of `%' in STRING.
3186 Return a new string with all `%' characters replaced by `%%'.
3187 Preserve text properties."
3188 (let ((start 0)
3189 (end (length string))
3190 mb me m matches)
3191 (save-match-data
3192 (while (and (< start end) (string-match "%" string start))
3193 (setq mb (match-beginning 0)
3194 me (1+ mb)
3195 m (substring string mb me)
3196 matches (cons m
3197 (cons m
3198 (cons (substring string start mb)
3199 matches)))
3200 start me))
3201 (push (substring string start end) matches)
3202 (apply #'concat (nreverse matches)))))
3204 (defvar Info-next-link-keymap
3205 (let ((keymap (make-sparse-keymap)))
3206 (define-key keymap [header-line mouse-1] 'Info-next)
3207 (define-key keymap [header-line mouse-2] 'Info-next)
3208 (define-key keymap [header-line down-mouse-1] 'ignore)
3209 (define-key keymap [mouse-2] 'Info-next)
3210 keymap)
3211 "Keymap to put on the Next link in the text or the header line.")
3213 (defvar Info-prev-link-keymap
3214 (let ((keymap (make-sparse-keymap)))
3215 (define-key keymap [header-line mouse-1] 'Info-prev)
3216 (define-key keymap [header-line mouse-2] 'Info-prev)
3217 (define-key keymap [header-line down-mouse-1] 'ignore)
3218 (define-key keymap [mouse-2] 'Info-prev)
3219 keymap)
3220 "Keymap to put on the Prev link in the text or the header line.")
3223 (defvar Info-up-link-keymap
3224 (let ((keymap (make-sparse-keymap)))
3225 (define-key keymap [header-line mouse-1] 'Info-up)
3226 (define-key keymap [header-line mouse-2] 'Info-up)
3227 (define-key keymap [header-line down-mouse-1] 'ignore)
3228 (define-key keymap [mouse-2] 'Info-up)
3229 keymap)
3230 "Keymap to put on the Up link in the text or the header line.")
3232 (defun Info-fontify-node ()
3233 "Fontify the node."
3234 (save-excursion
3235 (let* ((inhibit-read-only t)
3236 (case-fold-search t)
3237 paragraph-markers
3238 (not-fontified-p ; the node hasn't already been fontified
3239 (not (let ((where (next-property-change (point-min))))
3240 (and where (not (= where (point-max)))))))
3241 (fontify-visited-p ; visited nodes need to be re-fontified
3242 (and Info-fontify-visited-nodes
3243 ;; Don't take time to refontify visited nodes in huge nodes
3244 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size))))
3246 ;; Fontify header line
3247 (goto-char (point-min))
3249 (goto-char (match-end 0))
3251 (goto-char (match-end 0))
3252 (let* ((nbeg (match-beginning 2))
3253 (nend (match-end 2))
3254 (tbeg (match-beginning 1))
3255 (tag (match-string 1)))
3256 (if (string-equal tag "Node")
3257 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3258 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3259 (put-text-property tbeg nend 'mouse-face 'highlight)
3260 (put-text-property tbeg nend
3261 'help-echo
3262 (concat "Go to node "
3263 (buffer-substring nbeg nend)))
3264 ;; Always set up the text property keymap.
3265 ;; It will either be used in the buffer
3266 ;; or copied in the header line.
3267 (put-text-property tbeg nend 'keymap
3268 (cond
3269 ((equal tag "Prev") Info-prev-link-keymap)
3270 ((equal tag "Next") Info-next-link-keymap)
3271 ((equal tag "Up") Info-up-link-keymap))))))
3272 (when Info-use-header-line
3273 (goto-char (point-min))
3274 (let ((header-end (line-end-position))
3275 header)
3276 ;; If we find neither Next: nor Prev: link, show the entire
3277 ;; node header. Otherwise, don't show the File: and Node:
3278 ;; parts, to avoid wasting precious space on information that
3279 ;; is available in the mode line.
3280 (if (re-search-forward
3282 header-end t)
3283 (progn
3284 (goto-char (match-beginning 1))
3285 (setq header (buffer-substring (point) header-end)))
3287 (setq header
3288 (concat "No next, prev or up links -- "
3289 (buffer-substring (point) header-end)))
3290 (setq header (buffer-substring (point) header-end))))
3291 (put-text-property (point-min) (1+ (point-min))
3292 'header-line (Info-escape-percent header))
3293 ;; Hide the part of the first line
3294 ;; that is in the header, if it is just part.
3295 (unless (bobp)
3296 ;; Hide the punctuation at the end, too.
3298 (put-text-property (point) header-end 'invisible t)))))
3300 ;; Fontify titles
3301 (goto-char (point-min))
3302 (when not-fontified-p
3304 nil t)
3305 (let* ((c (preceding-char))
3306 (face
3307 (cond ((= c ?*) 'Info-title-1-face)
3308 ((= c ?=) 'Info-title-2-face)
3309 ((= c ?-) 'Info-title-3-face)
3310 (t 'Info-title-4-face))))
3311 (put-text-property (match-beginning 1) (match-end 1)
3312 'font-lock-face face))
3313 ;; This is a serious problem for trying to handle multiple
3314 ;; frame types at once. We want this text to be invisible
3315 ;; on frames that can display the font above.
3316 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3317 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3318 '(invisible t front-sticky nil rear-nonsticky t)))))
3320 ;; Fontify cross references
3321 (goto-char (point-min))
3322 (when (or not-fontified-p fontify-visited-p)
3323 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3324 (let ((start (match-beginning 0))
3325 (next (point))
3326 other-tag)
3327 (when not-fontified-p
3328 (when Info-hide-note-references
3329 ;; *Note is often used where *note should have been
3330 (goto-char start)
3331 (skip-syntax-backward " ")
3332 (setq other-tag
3333 (cond ((memq (char-before) '(nil ?\. ?! ??))
3334 "See ")
3335 ((memq (char-before) '(?\, ?\; ?\: ?-))
3336 "see ")
3337 ((memq (char-before) '(?\( ?\[ ?\{))
3338 ;; Check whether the paren is preceded by
3339 ;; an end of sentence
3340 (skip-syntax-backward " (")
3341 (if (memq (char-before) '(nil ?\. ?! ??))
3342 "See "
3343 "see "))
3345 "See ")))
3346 (goto-char next)
3347 (add-text-properties
3348 (match-beginning 1)
3349 (or (save-match-data
3351 (let ((start1 (match-beginning 1)))
3353 (+ start1 (match-beginning 0)))))
3354 (match-end 1))
3355 (if (and other-tag (not (eq Info-hide-note-references 'hide)))
3356 `(display ,other-tag front-sticky nil rear-nonsticky t)
3357 '(invisible t front-sticky nil rear-nonsticky t))))
3358 (add-text-properties
3359 (match-beginning 2) (match-end 2)
3360 (list
3361 'help-echo (if (or (match-end 5)
3362 (not (equal (match-string 4) "")))
3363 (concat "mouse-2: go to " (or (match-string 5)
3364 (match-string 4)))
3365 "mouse-2: go to this node")
3366 'mouse-face 'highlight)))
3367 (when (or not-fontified-p fontify-visited-p)
3368 (add-text-properties
3369 (match-beginning 2) (match-end 2)
3370 (list
3371 'font-lock-face
3372 ;; Display visited nodes in a different face
3373 (if (and Info-fontify-visited-nodes
3374 (save-match-data
3375 (let* ((node (replace-regexp-in-string
3377 (replace-regexp-in-string
3379 (or (match-string 5)
3380 (and (not (equal (match-string 4) ""))
3381 (match-string 4))
3382 (match-string 2)))))
3383 (file (file-name-nondirectory
3384 Info-current-file))
3385 (hl Info-history-list)
3386 res)
3388 (setq file (file-name-nondirectory
3389 (match-string 1 node))
3390 node (if (equal (match-string 2 node) "")
3391 "Top"
3392 (match-string 2 node))))
3393 (while hl
3394 (if (and (string-equal node (nth 1 (car hl)))
3395 (string-equal file
3396 (file-name-nondirectory
3397 (nth 0 (car hl)))))
3398 (setq res (car hl) hl nil)
3399 (setq hl (cdr hl))))
3400 res))) 'info-xref-visited 'info-xref))))
3401 (when not-fontified-p
3402 (when (memq Info-hide-note-references '(t hide))
3403 (add-text-properties (match-beginning 3) (match-end 3)
3404 '(invisible t front-sticky nil rear-nonsticky t))
3405 ;; Unhide the file name of the external reference in parens
3406 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3407 (remove-text-properties (match-beginning 6) (match-end 6)
3408 '(invisible t front-sticky nil rear-nonsticky t)))
3409 ;; Unhide newline because hidden newlines cause too long lines
3410 (save-match-data
3411 (let ((beg3 (match-beginning 3))
3412 (end3 (match-end 3)))
3414 (not (save-match-data
3415 (save-excursion
3416 (goto-char (1+ end3))
3417 (looking-at "[.)]*$")))))
3418 (remove-text-properties (+ beg3 (match-beginning 0))
3419 (+ beg3 (match-end 0))
3420 '(invisible t front-sticky nil rear-nonsticky t))))))
3421 (when (and Info-refill-paragraphs Info-hide-note-references)
3422 (push (set-marker (make-marker) start)
3423 paragraph-markers))))))
3425 ;; Refill paragraphs (experimental feature)
3426 (when (and not-fontified-p
3427 Info-refill-paragraphs
3428 paragraph-markers)
3429 (let ((fill-nobreak-invisible t)
3430 (fill-individual-varying-indent nil)
3433 (adaptive-fill-mode nil))
3434 (goto-char (point-max))
3435 (while paragraph-markers
3436 (let ((m (car paragraph-markers)))
3437 (setq paragraph-markers (cdr paragraph-markers))
3438 (when (< m (point))
3439 (goto-char m)
3440 (beginning-of-line)
3441 (let ((beg (point)))
3442 (when (zerop (forward-paragraph))
3443 (fill-individual-paragraphs beg (point) nil nil)
3444 (goto-char beg))))
3445 (set-marker m nil)))))
3447 ;; Fontify menu items
3448 (goto-char (point-min))
3449 (when (and (or not-fontified-p fontify-visited-p)
3452 ;; Don't take time to annotate huge menus
3453 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3454 (let ((n 0)
3455 cont)
3456 (while (re-search-forward
3459 nil t)
3460 (when not-fontified-p
3461 (setq n (1+ n))
3462 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3463 (put-text-property (match-beginning 0)
3464 (1+ (match-beginning 0))
3465 'font-lock-face 'info-menu-5)))
3466 (when not-fontified-p
3467 (add-text-properties
3468 (match-beginning 1) (match-end 1)
3469 (list
3470 'help-echo (if (match-end 3)
3471 (concat "mouse-2: go to " (match-string 3))
3472 "mouse-2: go to this node")
3473 'mouse-face 'highlight)))
3474 (when (or not-fontified-p fontify-visited-p)
3475 (add-text-properties
3476 (match-beginning 1) (match-end 1)
3477 (list
3478 'font-lock-face
3479 ;; Display visited menu items in a different face
3480 (if (and Info-fontify-visited-nodes
3481 (save-match-data
3482 (let ((node (if (equal (match-string 3) "")
3483 (match-string 1)
3484 (match-string 3)))
3485 (file (file-name-nondirectory Info-current-file))
3486 (hl Info-history-list)
3487 res)
3489 (setq file (file-name-nondirectory
3490 (match-string 1 node))
3491 node (if (equal (match-string 2 node) "")
3492 "Top"
3493 (match-string 2 node))))
3494 (while hl
3495 (if (and (string-equal node (nth 1 (car hl)))
3496 (string-equal file
3497 (file-name-nondirectory
3498 (nth 0 (car hl)))))
3499 (setq res (car hl) hl nil)
3500 (setq hl (cdr hl))))
3501 res))) 'info-xref-visited 'info-xref))))
3502 (when (and not-fontified-p (memq Info-hide-note-references '(t hide)))
3503 (put-text-property (match-beginning 2) (1- (match-end 6))
3504 'invisible t)
3505 ;; Unhide the file name in parens
3506 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
3507 (remove-text-properties (match-beginning 4) (match-end 4)
3508 '(invisible t)))
3509 ;; We need a stretchable space like :align-to but with
3510 ;; a minimum value.
3511 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3512 (if (>= 22 (- (match-end 1)
3513 (match-beginning 0)))
3514 '(space :align-to 24)
3515 '(space :width 2)))
3516 (setq cont (looking-at "."))
3517 (while (and (= (forward-line 1) 0)
3519 (put-text-property (match-beginning 1) (1- (match-end 1))
3520 'invisible t)
3521 (put-text-property (1- (match-end 1)) (match-end 1)
3522 'display
3523 (if cont
3524 '(space :align-to 26)
3525 '(space :align-to 24)))
3526 (setq cont t))))))
3528 ;; Fontify menu headers
3529 ;; Add the face `info-menu-header' to any header before a menu entry
3530 (goto-char (point-min))
3532 (put-text-property (match-beginning 0) (match-end 0)
3533 'font-lock-face 'info-menu-header)
3535 (put-text-property (match-beginning 1) (match-end 1)
3536 'font-lock-face 'info-menu-header)))
3538 ;; Hide index line numbers
3539 (goto-char (point-min))
3542 (put-text-property (match-beginning 0) (match-end 0)
3543 'invisible t)))
3545 ;; Fontify http and ftp references
3546 (goto-char (point-min))
3547 (when not-fontified-p
3549 (add-text-properties (match-beginning 0) (match-end 0)
3550 '(font-lock-face info-xref
3551 mouse-face highlight
3552 help-echo "mouse-2: go to this URL"))))
3554 (set-buffer-modified-p nil))))
3555 \f
3557 ;; When an Info buffer is killed, make sure the associated tags buffer
3558 ;; is killed too.
3559 (defun Info-kill-buffer ()
3560 (and (eq major-mode 'Info-mode)
3561 Info-tag-table-buffer
3562 (kill-buffer Info-tag-table-buffer)))
3564 (add-hook 'kill-buffer-hook 'Info-kill-buffer)
3566 ;;; Speedbar support:
3567 ;; These functions permit speedbar to display the "tags" in the
3568 ;; current info node.
3569 (eval-when-compile (require 'speedbar))
3571 (defvar Info-speedbar-key-map nil
3572 "Keymap used when in the info display mode.")
3574 (defun Info-install-speedbar-variables ()
3575 "Install those variables used by speedbar to enhance Info."
3576 (if Info-speedbar-key-map
3577 nil
3578 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
3580 ;; Basic tree features
3581 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
3582 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
3583 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
3584 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
3585 )
3587 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
3588 Info-speedbar-key-map
3589 Info-speedbar-hierarchy-buttons)))
3591 (defvar Info-speedbar-menu-items
3592 '(["Browse Node" speedbar-edit-line t]
3593 ["Expand Node" speedbar-expand-line
3594 (save-excursion (beginning-of-line)
3596 ["Contract Node" speedbar-contract-line
3597 (save-excursion (beginning-of-line)
3598 (looking-at "[0-9]+: *.-. "))]
3599 )
3600 "Additional menu-items to add to speedbar frame.")
3602 ;; Make sure our special speedbar major mode is loaded
3603 (if (featurep 'speedbar)
3604 (Info-install-speedbar-variables)
3605 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
3607 ;;; Info hierarchy display method
3608 ;;;###autoload
3609 (defun Info-speedbar-browser ()
3610 "Initialize speedbar to display an info node browser.
3611 This will add a speedbar major display mode."
3612 (interactive)
3613 (require 'speedbar)
3614 ;; Make sure that speedbar is active
3615 (speedbar-frame-mode 1)
3616 ;; Now, throw us into Info mode on speedbar.
3617 (speedbar-change-initial-expansion-list "Info")
3618 )
3620 (eval-when-compile (defvar speedbar-attached-frame))
3622 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
3623 "Display an Info directory hierarchy in speedbar.
3624 DIRECTORY is the current directory in the attached frame.
3625 DEPTH is the current indentation depth.
3626 NODE is an optional argument that is used to represent the
3627 specific node to expand."
3628 (if (and (not node)
3629 (save-excursion (goto-char (point-min))
3630 (let ((case-fold-search t))
3631 (looking-at "Info Nodes:"))))
3632 ;; Update our "current node" maybe?
3633 nil
3634 ;; We cannot use the generic list code, that depends on all leaves
3635 ;; being known at creation time.
3636 (if (not node)
3638 (let ((completions nil)
3639 (cf (selected-frame)))
3640 (select-frame speedbar-attached-frame)
3641 (save-window-excursion
3642 (setq completions
3643 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
3644 (select-frame cf)
3645 (if completions
3646 (speedbar-with-writable
3647 (dolist (completion completions)
3648 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
3649 (cdr completion)
3650 (car completion)
3651 'Info-speedbar-goto-node
3652 (cdr completion)
3653 'info-xref depth))
3654 t)
3655 nil))))
3657 (defun Info-speedbar-goto-node (text node indent)
3658 "When user clicks on TEXT, go to an info NODE.
3659 The INDENT level is ignored."
3660 (select-frame speedbar-attached-frame)
3661 (let* ((buff (or (get-buffer "*info*")
3662 (progn (info) (get-buffer "*info*"))))
3663 (bwin (get-buffer-window buff 0)))
3664 (if bwin
3665 (progn
3666 (select-window bwin)
3667 (raise-frame (window-frame bwin)))
3668 (if speedbar-power-click
3669 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
3670 (select-frame speedbar-attached-frame)
3671 (switch-to-buffer buff)))
3673 (error "Invalid node %s" node)
3674 (Info-find-node (match-string 1 node) (match-string 2 node))
3675 ;; If we do a find-node, and we were in info mode, restore
3676 ;; the old default method. Once we are in info mode, it makes
3677 ;; sense to return to whatever method the user was using before.
3678 (if (string= speedbar-initial-expansion-list-name "Info")
3679 (speedbar-change-initial-expansion-list
3680 speedbar-previously-used-expansion-list-name)))))
3682 (defun Info-speedbar-expand-node (text token indent)
3683 "Expand the node the user clicked on.
3684 TEXT is the text of the button we clicked on, a + or - item.
3685 TOKEN is data related to this node (NAME . FILE).
3686 INDENT is the current indentation depth."
3687 (cond ((string-match "+" text) ;we have to expand this file
3688 (speedbar-change-expand-button-char ?-)
3689 (if (speedbar-with-writable
3690 (save-excursion
3691 (end-of-line) (forward-char 1)
3692 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
3693 (speedbar-change-expand-button-char ?-)
3694 (speedbar-change-expand-button-char ??)))
3695 ((string-match "-" text) ;we have to contract this node
3696 (speedbar-change-expand-button-char ?+)
3697 (speedbar-delete-subblock indent))
3698 (t (error "Ooops... not sure what to do")))
3699 (speedbar-center-buffer-smartly))
3701 (defun Info-speedbar-fetch-file-nodes (nodespec)
3702 "Fetch the subnodes from the info NODESPEC.
3703 NODESPEC is a string of the form: (file)node.
3704 Optional THISFILE represends the filename of"
3705 (save-excursion
3706 ;; Set up a buffer we can use to fake-out Info.
3707 (set-buffer (get-buffer-create "*info-browse-tmp*"))
3708 (if (not (equal major-mode 'Info-mode))
3709 (Info-mode))
3710 ;; Get the node into this buffer
3712 (error "Invalid node specification %s" nodespec)
3713 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
3714 ;; Scan the created buffer
3715 (goto-char (point-min))
3716 (let ((completions nil)
3717 (case-fold-search t)
3719 (match-string 1 nodespec))))
3720 ;; Always skip the first one...
3723 (let ((name (match-string 1)))
3724 (push (cons name
3726 (match-string 1)
3728 (concat (match-string 1) "Top")
3729 (concat "(" thisfile ")"
3731 (match-string 1)
3732 name)))))
3733 completions)))
3734 (nreverse completions))))
3736 ;;; Info mode node listing
3737 ;; FIXME: Seems not to be used. -stef
3738 (defun Info-speedbar-buttons (buffer)
3739 "Create a speedbar display to help navigation in an Info file.
3740 BUFFER is the buffer speedbar is requesting buttons for."
3741 (if (save-excursion (goto-char (point-min))
3742 (let ((case-fold-search t))
3743 (not (looking-at "Info Nodes:"))))
3744 (erase-buffer))
3745 (Info-speedbar-hierarchy-buttons nil 0)
3746 )
3748 (dolist (mess '("^Node has no Previous$"
3749 "^No menu in this node$"
3750 "^Node has no Next$"
3751 "^No cross-references in this node^"
3752 search-failed
3754 (add-to-list 'debug-ignored-errors mess))
3756 ;;;; Desktop support
3758 (defun Info-desktop-buffer-misc-data (desktop-dirname)
3759 "Auxiliary information to be saved in desktop file."
3760 (list Info-current-file Info-current-node))
3762 ;;;###autoload
3763 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
3764 desktop-buffer-name
3765 desktop-buffer-misc)
3766 "Restore an info buffer specified in a desktop file."
3767 (let ((first (nth 0 desktop-buffer-misc))
3768 (second (nth 1 desktop-buffer-misc)))
3769 (when (and first second)
3770 (Info-find-node first second)
3771 (current-buffer))))
3773 (provide 'info)
3775 ;;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
3776 ;;; info.el ends here