| blob | 58690deb198b4054b3ee50d475ceb857a0999937 |
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 "Name of the selected cross-reference.
244 Point is moved to the proper occurrence of this name within a node
249 \f
251 ;; The MS-DOS list should work both when long file names are
252 ;; supported (Windows 9X), and when only 8+3 file names are available.
294 "List of file name suffixes and associated decoding commands.
295 Each entry should be (SUFFIX . STRING); the file is given to
296 the command as standard input.
298 STRING may be a list of strings. In that case, the first element is
299 the command name, and the rest are arguments to that command.
301 If STRING is nil, no decoding is done.
302 Because the SUFFIXes are tried in order, the empty string should
305 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
306 ;; First, on MS-DOS with no long file names support, delete some of
307 ;; the extension in FILENAME to make room.
312 ;; How long is the extension in FILENAME (not counting the dot).
314 ext-left)
315 ;; SUFFIX starts with a dot. If FILENAME already has one,
316 ;; get rid of the one in SUFFIX (unless suffix is empty).
321 ;; How many chars of that extension should we keep?
323 ;; Get rid of the rest of the extension, and add SUFFIX.
326 suffix))))
333 "Insert the contents of an info file in the current buffer.
334 Do the right thing if the file has been compressed or zipped."
338 t))
340 lfn))
341 fullname decoder done)
343 ;; FILENAME exists--see if that name contains a suffix.
344 ;; If so, set DECODE accordingly.
349 filename)))
353 ;; Try adding suffixes to FILENAME and see if we can find something.
359 ;; If we found a file with a suffix, set DECODER
360 ;; according to the suffix.
362 ;; When the MS-DOS port runs on Windows, we need to check
363 ;; the short variant of a long file name as well.
373 ;; check for conflict with jka-compr
384 default-directory)))
390 \f
397 "../info/"
398 invocation-directory)))
400 infodir
402 "../../../info/"
403 invocation-directory))
405 infodir))))))
406 alternative)
409 ;; Uninstalled, Emacs builddir != srcdir.
410 sibling
411 ;; Uninstalled, builddir == srcdir
412 source))
414 ;; On DOS/NT, we use movable executables always,
415 ;; and we must always find the Info dir at run time.
417 nil
418 ;; Use invocation-directory for Info
419 ;; only if we used it for exec-directory also.
422 installation-directory))))
424 Info-default-directory-list
425 ;; `alternative' contains the Info files that came with this
426 ;; version, so we should look there first. `Info-insert-dir'
427 ;; currently expects to find `alternative' first on the list.
429 ;; Don't drop the last part, it might contain non-Emacs stuff.
430 ;; (reverse (cdr (reverse
434 "Initialize `Info-directory-list', if that hasn't been done yet."
447 ;;;###autoload
449 "Like `info' but show the Info buffer in another window."
455 ;;;###autoload (add-hook 'same-window-buffer-names "*info*")
457 ;;;###autoload
459 "Enter Info, the documentation browser.
460 Optional argument FILE specifies the file to examine;
461 the default is the top-level directory of Info.
462 Called from a program, FILE may specify an Info node of the form
463 `(FILENAME)NODENAME'.
465 In interactive use, a prefix argument directs this command
466 to read a file name from the minibuffer.
468 The search path for Info files is in the variable `Info-directory-list'.
469 The top-level Info directory is made by combining all the files named `dir'
470 in all the directories in that path."
475 ;; If argument already contains parentheses, don't add another set
476 ;; since the argument will then be parsed improperly. This also
477 ;; has the added benefit of allowing node names to be included
478 ;; following the parenthesized filename.
485 ;;;###autoload
487 "Display the Emacs manual in Info mode."
491 ;;;###autoload
493 "Run Emacs as a standalone Info reader.
494 Usage: emacs -f info-standalone [filename]
508 \f
509 ;; See if the accessible portion of the buffer begins with a node
510 ;; delimiter, and the node header line which follows matches REGEXP.
511 ;; Typically, this test will be followed by a loop that examines the
512 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
513 ;; to have the overhead of this special test inside the loop.
515 ;; This function changes match-data, but supposedly the caller might
516 ;; want to use the results of re-search-backward.
518 ;; The return value is the value of point at the beginning of matching
519 ;; REGEXP, if the function succeeds, nil otherwise.
531 Optional second argument NOERROR, if t, means if file is not found
532 just return nil (no error)."
533 ;; Convert filename to lower case if not found as specified.
534 ;; Expand it.
549 ;; If specified name starts with `./'
550 ;; then just try current directory.
553 ;; No point in searching for an
554 ;; absolute file name
558 Info-additional-directory-list)
559 Info-directory-list)))))
560 ;; Search the directory list for file FILENAME.
565 ;; Try several variants of specified name.
569 t)))
580 lfn
592 filename)))
595 "Go to an info node specified as separate FILENAME and NODENAME.
596 NO-GOING-BACK is non-nil if recovering from an error in this function;
597 it says do not attempt further (recursive) error recovery."
600 ;; Record the node we are leaving.
604 Info-history)))
605 ;; Go into info buffer.
610 "Use the `Info-mode' to browse the current info buffer.
611 If a prefix arg is provided, it queries for the NODENAME which
623 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
624 ;; but at least it keeps this routine (which is only for the benefit of
625 ;; makeinfo-buffer) out of the way of normal operations.
626 ;;
628 "Go to an info node FILENAME and NODENAME, re-reading disk contents.
629 When *info* is already displaying FILENAME and NODENAME, the window position
630 is preserved, if possible."
646 ;; note goto-line is no good, we want to measure from point-min
653 ;; only add to the history when coming from a different file+node
658 "Find a node in a tag table.
659 MARKER specifies the buffer and position to start searching at.
660 REGEXP is a regular expression matching nodes or references. Its first
661 group should match `Node:' or `Ref:'.
662 CASE-FOLD t means search for a case-insensitive match.
663 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
664 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
665 where the match was found, and MODE is `major-mode' of the buffer in
666 which the match was found."
672 ;; Search tag table
677 major-mode)))))
680 "Find a node in a tag table.
681 MARKER specifies the buffer and position to start searching at.
682 REGEXP is a regular expression matching nodes or references. Its first
683 group should match `Node:' or `Ref:'.
684 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
685 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
686 where the match was found, and MODE is `major-mode' of the buffer in
687 which the match was found.
688 This function tries to find a case-sensitive match first, then a
689 case-insensitive match is tried."
693 result))
696 "Find a node or anchor in the current buffer.
697 REGEXP is a regular expression matching nodes or references. Its first
698 group should match `Node:' or `Ref:'.
699 CASE-FOLD t means search for a case-insensitive match.
700 Value is the position at which a match was found, or nil if not found."
702 found)
714 found)))
717 "Find a node or anchor in the current buffer.
718 REGEXP is a regular expression matching nodes or references. Its first
719 group should match `Node:' or `Ref:'.
720 Value is the position at which a match was found, or nil if not found.
721 This function looks for a case-sensitive match first. If none is found,
722 a case-insensitive match is tried."
734 anchorpos)
735 ;; Switch files if necessary
740 Info-current-subfile nil
741 Info-current-file-completions nil
742 buffer-file-name nil)
757 ;; See whether file has a tag table. Record the location if yes.
760 ;; Use string-equal, not equal, to ignore text props.
765 ;; We have a tag table. Find its beginning.
766 ;; Is this an indirect file?
772 ;; It is indirect. Copy it to another buffer
773 ;; and record that the tag table is in that buffer.
796 ))
797 ;; Use string-equal, not equal, to ignore text props.
801 ;; Possibilities:
802 ;;
803 ;; 1. Anchor found in tag table
804 ;; 2. Anchor *not* in tag table
805 ;;
806 ;; 3. Node found in tag table
807 ;; 4. Node *not* found in tag table, but found in file
808 ;; 5. Node *not* in tag table, and *not* in file
809 ;;
810 ;; *Or* the same, but in an indirect subfile.
812 ;; Search file for a suitable node.
822 ;; First, search a tag table, if any
828 ;; FOUND is (ANCHOR POS MODE).
831 ;; If this is an indirect file, determine which
832 ;; file really holds this node and read it in.
834 ;; Note that the current buffer must be the
835 ;; *info* buffer on entry to
836 ;; Info-read-subfile. Thus the hackery above.
839 ;; Handle anchor
844 ;; Else we may have a node, which we search for:
848 ;; Now search from our advised position (or from beg of
849 ;; buffer) to find the actual node. First, check
850 ;; whether the node is right where we are, in case the
851 ;; buffer begins with a node.
856 ;; No such anchor in tag table or node in tag table or file
864 ;; Add anchors to the history too
872 ;; If we did not finish finding the specified node,
873 ;; go back to the previous one.
880 ;; Cache the contents of the (virtual) dir file, once we have merged
881 ;; it for the first time, so we can save time subsequently.
884 ;; Cache for the directory we decided to use for the default-directory
885 ;; of the merged dir text.
888 ;; Record the file attributes of all the files from which we
889 ;; constructed Info-dir-contents.
894 ;; Construct the Info directory node by merging the files named `dir'
895 ;; from various directories. Set the *info* buffer's
896 ;; default-directory to the first directory we actually get any text
897 ;; from.
900 ;; Verify that none of the files we used has changed
901 ;; since we used it.
905 ;; Handle symlinks
908 ;; Don't compare the access time.
912 Info-dir-file-attributes))))
918 Info-additional-directory-list)
919 Info-directory-list))
921 ;; Bind this in case the user sets it to nil.
923 ;; This is set non-nil if we find a problem in some input files.
924 problems
925 buffers buffer others nodes dirs-done)
927 ;; Search the directory list for the directory file.
932 ;; Try several variants of specified name.
933 ;; Try upcasing, appending `.info', or both.
948 dirs-done)))
958 file)
970 ;; Distinguish the dir file that comes with Emacs from all the
971 ;; others. Yes, that is really what this is supposed to do.
972 ;; The definition of `Info-directory-list' puts it first on that
973 ;; list and so last in `buffers' at this point.
977 ;; Insert the entire original dir file as a start; note that we've
978 ;; already saved its default directory to use as the default
979 ;; directory for the whole concatenation.
982 ;; Look at each of the other buffers one by one.
985 ;; In each, find all the menus.
988 ;; Find each menu, and add an elt to NODES for it.
992 nodename end)
1004 ;; Add to the main menu a menu item for each other node.
1016 end t)
1020 ;; Now take each node of each of the other buffers
1021 ;; and merge it into the main buffer.
1026 ;; Find the like-named node in the main buffer.
1030 nil t)
1035 ;; If none exists, add one.
1038 ;; Merge the text from the other buffer's menu
1039 ;; into the menu in the like-named node in the main buffer.
1042 ;; Kill all the buffers we just made.
1062 ;; Remove duplicate headings in the same menu.
1065 ;; Look for the next heading to unify.
1070 ;; Check whether this heading should be streamlined.
1080 ;; Look for other headings of the same category and merge them.
1086 ;; Delete redundant heading.
1088 ;; Push the entries onto `text'.
1095 ;; Insert the entries just found.
1103 ;; Now remove duplicate entries under the same heading.
1116 ;; Note that on entry to this function the current-buffer must be the
1117 ;; *info* buffer; not the info tags buffer.
1119 ;; NODEPOS is either a position (in the Info file as a whole,
1120 ;; not relative to a subfile) or the name of a subfile.
1122 lastfilename)
1134 thisfilepos thisfilename)
1138 ;; read in version 19 stops at the end of number.
1139 ;; Advance to the next line.
1148 ;; Assume previous buffer is in Info-mode.
1149 ;; (set-buffer (get-buffer "*info*"))
1158 ;; Widen in case we are in the same subfile as before.
1168 "Unescape double quotes and backslashes in VALUE."
1174 unquote))
1176 ;; As of Texinfo 4.6, makeinfo writes constructs like
1177 ;; \0\h[image param=value ...\h\0]
1178 ;; into the Info file for handling images.
1181 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1182 whitespace or double quotes, it must be quoted in double quotes and
1187 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1188 parameter-string start)
1194 parameter-alist))
1195 parameter-alist))
1198 "Display images in current node."
1205 nil t)
1220 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1221 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1222 ;; including one optional trailing newline.
1224 "Hide unrecognised cookies in current node."
1231 nil t)
1238 "Select the info node that point is in."
1239 ;; Bind this in case the user sets it to nil.
1242 ;; Find beginning of node.
1248 ;; Get nodename spelled as it is in the node.
1256 ;; Find the end of it, and narrow.
1259 ;; Narrow to the node contents
1271 ;; Add a new unique history item to full history list
1287 Info-current-file
1289 ") "
1291 \f
1292 ;; Go to an info node specified with a filename-and-nodename string
1293 ;; of the sort that is found in pointers in nodes.
1296 "Go to info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1297 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1298 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1299 its sub-files).
1300 Completion is available, but only for node names in the current Info file.
1301 If FORK is non-nil (interactively with a prefix arg), show the node in
1302 a new info buffer.
1303 If FORK is a string, it is the name to use for the new buffer."
1311 nodename)
1313 ""
1326 ;; This function is used as the "completion table" while reading a node name.
1327 ;; It does completion using the alist in Info-read-node-completion-table
1328 ;; unless STRING starts with an open-paren.
1331 ;; First complete embedded file names.
1346 ;; If a file name was given, then any node is fair game.
1352 ;; Otherwise use Info-read-node-completion-table.
1367 nodename)))
1372 ;; Bind this in case the user sets it to nil.
1385 compl))))
1388 ;; If the buffer begins with a node header, process that first.
1391 ;; Now for the rest of the nodes.
1399 compl))))))))
1402 \f
1404 "If this node has been visited, restore the point value when we left."
1407 ;; Use string-equal, not equal, to ignore text props.
1413 \f
1421 "Search for REGEXP, starting from point, and select node it's found in."
1454 ;; If no subfiles, give error now.
1462 ;; Try other subfiles.
1473 ;; Find the subfile we just searched.
1475 ;; Skip that one.
1477 ;; Make a list of all following subfiles.
1478 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1485 list))
1487 ;; Put in forward order
1515 ;; Use string-equal, not equal, to ignore text props.
1519 Info-history))))))
1522 "Search for a regexp case-sensitively."
1528 "Search for next regexp from a previous `Info-search' command."
1534 \f
1536 "Extract the value of the node-pointer named NAME.
1537 If there is none, use ERRORNAME in the error message;
1538 if ERRORNAME is nil, just return nil."
1539 ;; Bind this in case the user sets it to nil.
1553 "Return a regexp matching a node name.
1554 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1555 saying which chars may appear in the node name.
1556 Submatch 1 is the complete node name.
1557 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1558 Submatch 3 is the local part of the node name.
1559 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1566 ;;; For compatibility; other files have used this name.
1572 "Go to the next node of this node."
1577 "Go to the previous node of this node."
1582 "Go to the superior node of this node.
1583 If SAME-FILE is non-nil, do not move to a different Info file."
1600 nil t))
1606 "Go back to the last node visited."
1619 ;;;###autoload
1621 "Go to the Info directory node."
1624 \f
1626 "Go to a node with a menu of visited nodes."
1630 p)
1652 "Go to a node with table of contents of the current Info file."
1656 p)
1679 "Insert table of contents with references to nodes."
1691 "Build table of contents from menus of Info FILE and its subfiles."
1698 default-directory))
1700 nodes subfiles)
1711 menu-items)
1720 bound))
1723 ;; Menu item line
1733 ;; Other non-empty strings in the Top node are section names
1742 nodes))
1751 subfiles)))))
1753 file nil))
1757 \f
1759 "Follow cross reference named FOOTNOTENAME to the node it refers to.
1760 FOOTNOTENAME may be an abbreviation of the reference name.
1761 If FORK is non-nil (interactively with a prefix arg), show the node in
1762 a new info buffer. If FORK is a string, it is the name to use for the
1763 new buffer."
1769 ;; Store end and beginning of line.
1778 ;; See if this one should be the default.
1783 ;; See if this one should be the alternate default.
1793 ;; Record as a completion and perhaps as default.
1796 ;; Don't add this string if it's a duplicate.
1799 ;; If no good default was found, try an alternate.
1802 ;; If only one cross-reference found, then make it default.
1808 "Follow reference named: (default "
1811 completions nil t)))
1825 ;; Move point to the beginning of reference if point is on reference
1836 ;; Go to the reference closest to point
1844 next-ref prev-ref))
1855 ;; We allow newline because this is also used in Info-follow-reference,
1856 ;; where the xref name might be wrapped over two lines.
1857 "Regexp that matches a menu entry name upto but not including the colon.
1858 Because of ambiguities, this should be concatenated with something like
1869 ;; If the node name is the menu entry name (using `entry::').
1872 ;; No one calls this.
1873 ;;(defun Info-menu-item-sequence (list)
1874 ;; (while list
1875 ;; (Info-menu (car list))
1876 ;; (setq list (cdr list))))
1887 ;; This uses two dynamically bound variables:
1888 ;; - `Info-complete-menu-buffer' which contains the buffer in which
1889 ;; is the menu of items we're trying to complete.
1890 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
1891 ;; also look for menu items in subsequent nodes as long as those
1892 ;; nodes' names match `Info-complete-next-re'. This feature is currently
1893 ;; only used for completion in Info-index.
1895 ;; Note that `Info-complete-menu-buffer' could be current already,
1896 ;; so we want to save point.
1902 nextnode)
1911 completions)
1912 ;; Check the cache.
1919 ;; We can reuse the previous list.
1921 ;; The cache can't be used.
1926 completions))
1927 ;; Check subsequent nodes if applicable.
1932 ;; Go back to the start node (for the next completion).
1935 ;; Update the cache.
1938 Info-complete-next-re string completions)))
1945 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
1946 The menu item should one of those listed in the current node's menu.
1947 Completion is allowed, and the default menu item is the one point is on.
1948 If FORK is non-nil (interactively with a prefix arg), show the node in
1949 a new info buffer. If FORK is a string, it is the name to use for the
1950 new buffer."
1953 ;; If point is within a menu item, use that item as the default
1956 beg
1969 Info-menu-entry-name-re
1978 default)
1981 ;; we rely on the fact that completing-read accepts an input
1982 ;; of "" even when the require-match argument is true and ""
1983 ;; is not a valid possibility
1987 ;; ask again
1990 ;; there is a problem here in that if several menu items have the same
1991 ;; name you can only go to the node of the first with this command.
2009 ;; If COUNT is nil, use the last item in the menu.
2021 nil))
2025 "Go to the node of the Nth menu item.
2026 N is the digit argument used to invoke this command."
2033 "Go to the Top node of this file."
2038 "Go to the final node in this file."
2043 ;; Go to the last node in the menu of Top.
2045 ;; If the last node in the menu is not last in pointer structure,
2046 ;; move forward until we can't go any farther.
2048 ;; Then keep moving down to last subnode, unless we reach an index.
2054 "Go forward one node, considering all nodes as forming one sequence."
2059 ;; three possibilities, in order of priority:
2060 ;; 1. next node is in a menu in this node (but not in an index)
2061 ;; 2. next node is next at same level
2062 ;; 3. next node is up and next
2067 t)
2070 t)
2072 ;; Use string-equal, not equal, to ignore text props.
2085 "Go backward one node, considering all nodes as forming one sequence."
2093 ;; Use string-equal, not equal,
2094 ;; to ignore text properties.
2099 ;; If we move back at the same level,
2100 ;; go down to find the last subnode*.
2110 "Exit Info by selecting some other buffer."
2117 "Go to the node of the next menu item."
2119 ;; Bind this in case the user sets it to nil.
2131 "Go to the node of the previous menu item."
2135 ;; Bind this in case the user sets it to nil.
2150 "Go to the next subnode or the next node, or go up a level."
2155 ;; Since we have already gone thru all the items in this menu,
2156 ;; go up to the end of this node.
2158 ;; Since logically we are done with the node with that menu,
2159 ;; move on from it.
2165 "Go to the last node, popping up a level if there is none."
2169 ;; If we go down a menu item, go to the end of the node
2170 ;; so we can scroll back through it.
2172 ;; Keep going down, as long as there are nested menu nodes.
2175 ;; If we go down a menu item, go to the end of the node
2176 ;; so we can scroll back through it.
2186 ;; If we go down a menu item, go to the end of the node
2187 ;; so we can scroll back through it.
2198 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2199 Once you scroll far enough in a node that its menu appears on the screen
2200 but after point, the next scroll moves into its first subnode, unless
2201 `Info-scroll-prefer-subnodes' is nil.
2203 When you scroll past the end of a node, that goes to the next node if
2204 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2205 if this node has no successor, it moves to the parent node's successor,
2206 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2207 the menu of a node, it moves to subnode indicated by the following menu
2208 item. (That case won't normally result from this command, but can happen
2209 in other ways.)"
2231 "Scroll one screenful back in Info, considering all nodes as one sequence.
2232 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2233 is non-nil, this goes to its last subnode. When you scroll past the
2234 beginning of a node, that goes to the previous node or back up to the
2235 parent node."
2249 current-point
2250 t)))))
2257 "Move cursor to the next cross-reference or menu item in the node."
2277 "Move cursor to the previous cross-reference or menu item in the node."
2302 ;; Protect Info-history so that the current node (Top) is not added to it.
2306 ;;;###autoload
2308 "Look up a string TOPIC in the index for this file.
2309 The index is defined as the first node in the top level menu whose
2312 If there are no exact matches to the specified topic, this chooses
2313 the first match which is a case-insensitive substring of a topic.
2315 Give a blank topic name to go to the Index node itself."
2332 node
2338 ;; We bind Info-history to nil for internal node-switches so
2339 ;; that we don't put junk in the history. In the first
2340 ;; Info-goto-index call, above, we do update the history
2341 ;; because that is what the user's previous node choice into it.
2343 found)
2350 Info-current-node
2353 matches))
2361 ;; Here it is a feature that assoc is case-sensitive.
2390 "(`,' tries to find next)"
2394 "Move point to the place within the current node where NAME is defined."
2399 ;; Find a function definition with a return type.
2407 nil t))
2409 ;; Try again without the " <1>" makeinfo can append
2415 ;;;###autoload
2417 "Grovel indices of all known Info files on your system for STRING.
2418 Build a menu of the possible matches."
2427 manuals matches node)
2429 Info-use-header-lines
2430 Info-hide-note-references)
2452 manual)))
2459 Info-history-list ohist-list)
2474 "Make command be undefined in Info."
2479 "Enter the Info tutorial."
2484 "Help-Small-Screen"
2488 "Display a brief summary of all Info commands."
2503 flag))
2506 \f
2508 "Return the token around POS.
2509 POS must be somewhere inside the token
2510 START is a regular expression which will match the
2511 beginning of the tokens delimited string
2512 ALL is a regular expression with a single
2513 parenthesized subpattern which is the token to be
2514 returned. E.g. '{\(.*\)}' would return any string
2515 enclosed in braces around POS.
2516 ERRORSTRING optional fourth argument, controls action on no match
2517 nil: return nil
2518 t: beep
2519 a string: signal an error, using that string."
2523 ;; First look for a match for START that goes across POS.
2527 ;; If we did not find one, search back for START
2528 ;; (this finds only matches that end at or before POS).
2541 nil)
2544 nil)
2550 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
2551 At end of the node's text, moves to the next node, or up if none."
2559 "Follow a node reference near point.
2560 If point is on a reference, follow that reference. Otherwise,
2561 if point is in a menu item description, follow that menu item."
2573 t)))
2576 ;; Common subroutine.
2578 "Follow a node reference near point. Return non-nil if successful."
2587 ;;; (or (match-string 2)
2588 ;;; (setq Info-reference-name
2589 ;;; (replace-regexp-in-string
2590 ;;; "[ \n\t]+" " " (match-string-no-properties 1))))
2592 ;; menu item: node name
2595 ;; menu item: index entry
2611 node))
2612 \f
2616 nil
2625 (define-key Info-mode-map "1" 'Info-nth-menu-item)
2626 (define-key Info-mode-map "2" 'Info-nth-menu-item)
2627 (define-key Info-mode-map "3" 'Info-nth-menu-item)
2628 (define-key Info-mode-map "4" 'Info-nth-menu-item)
2629 (define-key Info-mode-map "5" 'Info-nth-menu-item)
2630 (define-key Info-mode-map "6" 'Info-nth-menu-item)
2631 (define-key Info-mode-map "7" 'Info-nth-menu-item)
2632 (define-key Info-mode-map "8" 'Info-nth-menu-item)
2633 (define-key Info-mode-map "9" 'Info-nth-menu-item)
2634 (define-key Info-mode-map "0" 'undefined)
2635 (define-key Info-mode-map "?" 'Info-summary)
2636 (define-key Info-mode-map "]" 'Info-forward-node)
2637 (define-key Info-mode-map "[" 'Info-backward-node)
2638 (define-key Info-mode-map "<" 'Info-top-node)
2639 (define-key Info-mode-map ">" 'Info-final-node)
2640 (define-key Info-mode-map "b" 'beginning-of-buffer)
2641 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
2642 (define-key Info-mode-map "d" 'Info-directory)
2643 (define-key Info-mode-map "e" 'Info-edit)
2644 (define-key Info-mode-map "f" 'Info-follow-reference)
2645 (define-key Info-mode-map "g" 'Info-goto-node)
2646 (define-key Info-mode-map "h" 'Info-help)
2647 (define-key Info-mode-map "i" 'Info-index)
2648 (define-key Info-mode-map "l" 'Info-last)
2649 (define-key Info-mode-map "m" 'Info-menu)
2650 (define-key Info-mode-map "n" 'Info-next)
2651 (define-key Info-mode-map "p" 'Info-prev)
2652 (define-key Info-mode-map "q" 'Info-exit)
2653 (define-key Info-mode-map "s" 'Info-search)
2654 ;; For consistency with Rmail.
2655 (define-key Info-mode-map "\M-s" 'Info-search)
2656 (define-key Info-mode-map "\M-n" 'clone-buffer)
2657 (define-key Info-mode-map "t" 'Info-top-node)
2658 (define-key Info-mode-map "u" 'Info-up)
2659 (define-key Info-mode-map "," 'Info-index-next)
2661 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
2662 )
2664 (defun Info-check-pointer (item)
2665 "Non-nil if ITEM is present in this node."
2666 (condition-case nil
2667 (Info-extract-pointer item)
2668 (error nil)))
2670 (easy-menu-define
2671 Info-mode-menu Info-mode-map
2672 "Menu for info files."
2673 '("Info"
2674 ["Up" Info-up :active (Info-check-pointer "up")
2675 :help "Go up in the Info tree"]
2676 ["Next" Info-next :active (Info-check-pointer "next")
2677 :help "Go to the next node"]
2678 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
2679 :help "Go to the previous node"]
2680 ["Backward" Info-backward-node
2681 :help "Go backward one node, considering all as a sequence"]
2682 ["Forward" Info-forward-node
2683 :help "Go forward one node, considering all as a sequence"]
2684 ["Beginning" beginning-of-buffer
2685 :help "Go to beginning of this node"]
2686 ["Top" Info-top-node
2687 :help "Go to top node of file"]
2688 ["Final Node" Info-final-node
2689 :help "Go to final node in this file"]
2690 ("Menu Item" ["You should never see this" report-emacs-bug t])
2691 ("Reference" ["You should never see this" report-emacs-bug t])
2692 ["Search..." Info-search
2693 :help "Search for regular expression in this Info file"]
2694 ["Search Case-Sensitively..." Info-search-case-sensitively
2695 :help "Search for regular expression case sensitively"]
2696 ["Search Next" Info-search-next
2697 :help "Search for another occurrence of regular expression"]
2698 ["Go to Node..." Info-goto-node
2699 :help "Go to a named node"]
2700 ["Last" Info-last :active Info-history
2701 :help "Go to the last node you were at"]
2702 ["History" Info-history :active Info-history-list
2703 :help "Go to the history buffer"]
2704 ["Table of Contents" Info-toc
2705 :help "Go to the buffer with a table of contents"]
2706 ("Index..."
2707 ["Lookup a String" Info-index
2708 :help "Look for a string in the index items"]
2709 ["Next Matching Item" Info-index-next
2710 :help "Look for another occurrence of previous item"]
2711 ["Lookup a string in all indices" info-apropos
2712 :help "Look for a string in the indices of all manuals"])
2713 ["Edit" Info-edit :help "Edit contents of this node"
2714 :active Info-enable-edit]
2715 ["Copy Node Name" Info-copy-current-node-name
2716 :help "Copy the name of the current node into the kill ring"]
2717 ["Clone Info buffer" clone-buffer
2718 :help "Create a twin copy of the current Info buffer."]
2719 ["Exit" Info-exit :help "Stop reading Info"]))
2722 (defvar info-tool-bar-map
2723 (if (display-graphic-p)
2724 (let ((map (make-sparse-keymap)))
2725 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
2726 (tool-bar-local-item-from-menu 'Info-prev "left_arrow" map Info-mode-map)
2727 (tool-bar-local-item-from-menu 'Info-next "right_arrow" map Info-mode-map)
2728 (tool-bar-local-item-from-menu 'Info-up "up_arrow" map Info-mode-map)
2729 (tool-bar-local-item-from-menu 'Info-last "undo" map Info-mode-map)
2730 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
2731 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
2732 (tool-bar-local-item-from-menu 'Info-goto-node "jump_to" map Info-mode-map)
2733 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
2734 map)))
2736 (defvar Info-menu-last-node nil)
2737 ;; Last node the menu was created for.
2738 ;; Value is a list, (FILE-NAME NODE-NAME).
2740 (defun Info-menu-update ()
2741 "Update the Info menu for the current node."
2742 (condition-case nil
2743 (if (or (not (eq major-mode 'Info-mode))
2744 (equal (list Info-current-file Info-current-node)
2745 Info-menu-last-node))
2746 ()
2747 ;; Update menu menu.
2748 (let* ((Info-complete-menu-buffer (current-buffer))
2749 (items (nreverse (condition-case nil
2750 (Info-complete-menu-item "" nil t)
2751 (error nil))))
2752 entries current
2753 (number 0))
2754 (while (and items (< number 9))
2755 (setq current (car items)
2756 items (cdr items)
2757 number (1+ number))
2758 (setq entries (cons `[,current
2759 (Info-menu ,current)
2760 :keys ,(format "%d" number)]
2761 entries)))
2762 (if items
2763 (setq entries (cons ["Other..." Info-menu t] entries)))
2764 (or entries
2765 (setq entries (list ["No menu" nil nil] nil :active)))
2766 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
2767 ;; Update reference menu. Code stolen from `Info-follow-reference'.
2768 (let ((items nil)
2769 str i entries current
2770 (number 0)
2771 (case-fold-search t))
2772 (save-excursion
2773 (goto-char (point-min))
2775 (setq str (match-string 1))
2776 (setq i 0)
2778 (setq str (concat (substring str 0 i) " "
2779 (substring str (match-end 0))))
2780 (setq i (1+ i)))
2781 (setq items
2782 (cons str items))))
2783 (while (and items (< number 9))
2784 (setq current (car items)
2785 items (cdr items)
2786 number (1+ number))
2787 (setq entries (cons `[,current
2788 (Info-follow-reference ,current)
2789 t]
2790 entries)))
2791 (if items
2792 (setq entries (cons ["Other..." Info-follow-reference t]
2793 entries)))
2794 (or entries
2795 (setq entries (list ["No references" nil nil] nil :active)))
2796 (easy-menu-change '("Info") "Reference" (nreverse entries)))
2797 ;; Update last seen node.
2798 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
2799 ;; Try to avoid entering infinite beep mode in case of errors.
2800 (error (ding))))
2802 \f
2803 (defun Info-copy-current-node-name ()
2804 "Put the name of the current info node into the kill ring.
2805 The name of the info file is prepended to the node name in parentheses."
2806 (interactive)
2807 (unless Info-current-node
2808 (error "No current info node"))
2809 (kill-new
2810 (concat "("
2811 (file-name-nondirectory
2812 (if (stringp Info-current-file)
2813 Info-current-file
2814 (or buffer-file-name "")))
2815 ")"
2816 Info-current-node)))
2818 \f
2819 ;; Info mode is suitable only for specially formatted data.
2820 (put 'Info-mode 'mode-class 'special)
2821 (put 'Info-mode 'no-clone-indirect t)
2823 (defun Info-mode ()
2824 "Info mode provides commands for browsing through the Info documentation tree.
2826 one topic and contains references to other nodes which discuss related
2827 topics. Info has commands to follow the references and show you other nodes.
2833 Selecting other nodes:
2835 Follow a node reference you click on.
2836 This works with menu items, cross references, and
2838 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
2843 Picking a menu item causes another node to be selected.
2850 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
2856 Moving within a node:
2858 Once you scroll far enough in a node that its menu appears on the
2859 screen but after point, the next scroll moves into its first
2860 subnode. When after all menu items (or if there is no menu),
2861 move up to the parent node.
2863 already visible, try to go to the previous menu entry, or up
2864 if there is none.
2867 Advanced commands:
2871 1 Pick first item in node's menu.
2872 2, 3, 4, 5 Pick second ... fifth item in node's menu.
2874 You may include a filename as well, as (FILENAME)NODENAME.
2877 and select the node in which the next occurrence is found.
2879 for specified regexp case-sensitively.
2884 (kill-all-local-variables)
2885 (setq major-mode 'Info-mode)
2886 (setq mode-name "Info")
2887 (setq tab-width 8)
2888 (use-local-map Info-mode-map)
2889 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
2890 (set-syntax-table text-mode-syntax-table)
2891 (setq local-abbrev-table text-mode-abbrev-table)
2892 (setq case-fold-search t)
2893 (setq buffer-read-only t)
2894 (make-local-variable 'Info-current-file)
2895 (make-local-variable 'Info-current-subfile)
2896 (make-local-variable 'Info-current-node)
2897 (make-local-variable 'Info-tag-table-marker)
2898 (setq Info-tag-table-marker (make-marker))
2899 (make-local-variable 'Info-tag-table-buffer)
2900 (setq Info-tag-table-buffer nil)
2901 (make-local-variable 'Info-history)
2902 (make-local-variable 'Info-index-alternatives)
2903 (setq header-line-format
2904 (if Info-use-header-line
2905 '(:eval (get-text-property (point-min) 'header-line))
2906 nil)) ; so the header line isn't displayed
2907 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
2908 ;; This is for the sake of the invisible text we use handling titles.
2909 (make-local-variable 'line-move-ignore-invisible)
2910 (setq line-move-ignore-invisible t)
2911 (make-local-variable 'desktop-save-buffer)
2912 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
2913 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
2914 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
2915 (Info-set-mode-line)
2916 (run-hooks 'Info-mode-hook))
2918 (defun Info-clone-buffer-hook ()
2919 (when (bufferp Info-tag-table-buffer)
2920 (setq Info-tag-table-buffer
2921 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
2922 (let ((m Info-tag-table-marker))
2923 (when (markerp m)
2924 (setq Info-tag-table-marker
2925 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
2926 (with-current-buffer Info-tag-table-buffer
2927 (copy-marker (marker-position m)))
2928 (make-marker))))))
2930 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
2931 (set-keymap-parent map text-mode-map)
2932 (define-key map "\C-c\C-c" 'Info-cease-edit)
2933 map)
2934 "Local keymap used within `e' command of Info.")
2936 ;; Info-edit mode is suitable only for specially formatted data.
2937 (put 'Info-edit-mode 'mode-class 'special)
2939 (defun Info-edit-mode ()
2940 "Major mode for editing the contents of an Info node.
2941 Like text mode with the addition of `Info-cease-edit'
2942 which returns to Info mode for browsing.
2944 (use-local-map Info-edit-map)
2945 (setq major-mode 'Info-edit-mode)
2946 (setq mode-name "Info Edit")
2947 (kill-local-variable 'mode-line-buffer-identification)
2948 (setq buffer-read-only nil)
2949 (force-mode-line-update)
2950 (buffer-enable-undo (current-buffer))
2951 (run-hooks 'Info-edit-mode-hook))
2953 (defun Info-edit ()
2954 "Edit the contents of this Info node.
2955 Allowed only if variable `Info-enable-edit' is non-nil."
2956 (interactive)
2957 (or Info-enable-edit
2958 (error "Editing info nodes is not enabled"))
2959 (Info-edit-mode)
2960 (message "%s" (substitute-command-keys
2963 (defun Info-cease-edit ()
2964 "Finish editing Info node; switch back to Info proper."
2965 (interactive)
2966 ;; Do this first, so nothing has changed if user C-g's at query.
2967 (and (buffer-modified-p)
2968 (y-or-n-p "Save the file? ")
2969 (save-buffer))
2970 (use-local-map Info-mode-map)
2971 (setq major-mode 'Info-mode)
2972 (setq mode-name "Info")
2973 (Info-set-mode-line)
2974 (setq buffer-read-only t)
2975 (force-mode-line-update)
2976 (and (marker-position Info-tag-table-marker)
2977 (buffer-modified-p)
2978 (message "Tags may have changed. Use Info-tagify if necessary")))
2979 \f
2980 (defvar Info-file-list-for-emacs
2981 '("ediff" "eudc" "forms" "gnus" "info" ("mh" . "mh-e")
2982 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
2983 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
2984 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
2985 ("skeleton" . "autotype") ("auto-insert" . "autotype")
2986 ("copyright" . "autotype") ("executable" . "autotype")
2987 ("time-stamp" . "autotype") ("quickurl" . "autotype")
2988 ("tempo" . "autotype") ("hippie-expand" . "autotype")
2989 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
2990 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
2991 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
2992 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
2993 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
2994 ("rfc2045" . "emacs-mime")
2995 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
2996 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
2997 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
2998 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
2999 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3000 ("mml" . "emacs-mime"))
3001 "List of Info files that describe Emacs commands.
3002 An element can be a file name, or a list of the form (PREFIX . FILE)
3003 where PREFIX is a name prefix and FILE is the file to look in.
3004 If the element is just a file name, the file name also serves as the prefix.")
3006 (defun Info-find-emacs-command-nodes (command)
3007 "Return a list of locations documenting COMMAND.
3008 The `info-file' property of COMMAND says which Info manual to search.
3009 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3010 defines heuristics for which Info manual to try.
3011 The locations are of the format used in `Info-history', i.e.
3012 \(FILENAME NODENAME BUFFERPOS\)."
3013 (let ((where '())
3016 (info-file "emacs")) ;default
3017 ;; Determine which info file this command is documented in.
3018 (if (get command 'info-file)
3019 (setq info-file (get command 'info-file))
3020 ;; If it doesn't say explicitly, test its name against
3021 ;; various prefixes that we know.
3022 (let ((file-list Info-file-list-for-emacs))
3023 (while file-list
3024 (let* ((elt (car file-list))
3025 (name (if (consp elt)
3026 (car elt)
3027 elt))
3028 (file (if (consp elt) (cdr elt) elt))
3031 (if (string-match regexp (symbol-name command))
3032 (setq info-file file file-list nil))
3033 (setq file-list (cdr file-list))))))
3034 (Info-find-node info-file "Top")
3037 (error "Info file `%s' appears to lack an index" info-file))
3038 (goto-char (match-beginning 1))
3039 ;; Bind Info-history to nil, to prevent the index nodes from
3040 ;; getting into the node history.
3041 (let ((Info-history nil)
3042 node)
3043 (Info-goto-node (Info-extract-menu-node-name))
3044 (while
3045 (progn
3046 (goto-char (point-min))
3047 (while (re-search-forward cmd-desc nil t)
3048 (setq where
3049 (cons (list Info-current-file
3050 (match-string-no-properties 2)
3051 0)
3052 where)))
3053 (and (setq node (Info-extract-pointer "next" t))
3055 (Info-goto-node node)))
3056 where))
3058 ;;;###autoload
3059 (defun Info-goto-emacs-command-node (command)
3060 "Go to the Info node in the Emacs manual for command COMMAND.
3061 The command is found by looking up in Emacs manual's indices
3062 or in another manual found via COMMAND's `info-file' property or
3063 the variable `Info-file-list-for-emacs'.
3064 COMMAND must be a symbol or string."
3065 (interactive "CFind documentation for command: ")
3066 ;; If command is given as a string, convert it to a symbol.
3067 (if (stringp command)
3068 (setq command (intern command)))
3069 (or (commandp command)
3070 (signal 'wrong-type-argument (list 'commandp command)))
3071 (let ((where (Info-find-emacs-command-nodes command)))
3072 (if where
3073 (let ((num-matches (length where)))
3074 ;; Get Info running, and pop to it in another window.
3075 (save-window-excursion
3076 (info))
3077 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3078 ;; Bind Info-history to nil, to prevent the last Index node
3079 ;; visited by Info-find-emacs-command-nodes from being
3080 ;; pushed onto the history.
3081 (let ((Info-history nil))
3082 (Info-find-node (car (car where))
3083 (car (cdr (car where)))))
3084 (if (> num-matches 1)
3085 (progn
3086 ;; (car where) will be pushed onto Info-history
3087 ;; when/if they go to another node. Put the other
3088 ;; nodes that were found on the history.
3089 (setq Info-history (nconc (cdr where) Info-history))
3090 (message "Found %d other entr%s. Use %s to see %s."
3091 (1- num-matches)
3092 (if (> num-matches 2) "ies" "y")
3094 (if (> num-matches 2) "them" "it")))))
3095 (error "Couldn't find documentation for %s" command))))
3097 ;;;###autoload
3098 (defun Info-goto-emacs-key-command-node (key)
3099 "Go to the node in the Emacs manual which describes the command bound to KEY.
3100 KEY is a string.
3101 Interactively, if the binding is `execute-extended-command', a command is read.
3102 The command is found by looking up in Emacs manual's indices
3103 or in another manual found via COMMAND's `info-file' property or
3104 the variable `Info-file-list-for-emacs'."
3105 (interactive "kFind documentation for key: ")
3106 (let ((command (key-binding key)))
3107 (cond ((null command)
3108 (message "%s is undefined" (key-description key)))
3109 ((and (interactive-p)
3110 (eq command 'execute-extended-command))
3111 (Info-goto-emacs-command-node
3112 (read-command "Find documentation for command: ")))
3113 (t
3114 (Info-goto-emacs-command-node command)))))
3115 \f
3116 (defface Info-title-1-face
3117 '((((type tty pc) (class color)) :foreground "yellow" :weight bold)
3118 (t :height 1.2 :inherit Info-title-2-face))
3119 "Face for Info titles at level 1."
3120 :group 'info)
3122 (defface Info-title-2-face
3123 '((((type tty pc) (class color)) :foreground "lightblue" :weight bold)
3124 (t :height 1.2 :inherit Info-title-3-face))
3125 "Face for Info titles at level 2."
3126 :group 'info)
3128 (defface Info-title-3-face
3129 '((((type tty pc) (class color)) :weight bold)
3130 (t :height 1.2 :inherit Info-title-4-face))
3131 "Face for Info titles at level 3."
3132 :group 'info)
3134 (defface Info-title-4-face
3135 '((((type tty pc) (class color)) :weight bold)
3136 (t :weight bold :inherit variable-pitch))
3137 "Face for Info titles at level 4."
3138 :group 'info)
3140 (defface info-menu-header
3141 '((((type tty pc))
3142 :underline t
3143 :weight bold)
3144 (t
3145 :inherit variable-pitch
3146 :weight bold))
3147 "Face for headers in Info menus."
3148 :group 'info)
3150 (defun Info-escape-percent (string)
3151 "Double all occurrences of `%' in STRING.
3153 Return a new string with all `%' characters replaced by `%%'.
3154 Preserve text properties."
3155 (let ((start 0)
3156 (end (length string))
3157 mb me m matches)
3158 (save-match-data
3159 (while (and (< start end) (string-match "%" string start))
3160 (setq mb (match-beginning 0)
3161 me (1+ mb)
3162 m (substring string mb me)
3163 matches (cons m
3164 (cons m
3165 (cons (substring string start mb)
3166 matches)))
3167 start me))
3168 (push (substring string start end) matches)
3169 (apply #'concat (nreverse matches)))))
3171 (defvar Info-next-link-keymap
3172 (let ((keymap (make-sparse-keymap)))
3173 (define-key keymap [header-line mouse-1] 'Info-next)
3174 (define-key keymap [header-line mouse-2] 'Info-next)
3175 (define-key keymap [header-line down-mouse-1] 'ignore)
3176 (define-key keymap [mouse-2] 'Info-next)
3177 keymap)
3178 "Keymap to put on the Next link in the text or the header line.")
3180 (defvar Info-prev-link-keymap
3181 (let ((keymap (make-sparse-keymap)))
3182 (define-key keymap [header-line mouse-1] 'Info-prev)
3183 (define-key keymap [header-line mouse-2] 'Info-prev)
3184 (define-key keymap [header-line down-mouse-1] 'ignore)
3185 (define-key keymap [mouse-2] 'Info-prev)
3186 keymap)
3187 "Keymap to put on the Prev link in the text or the header line.")
3190 (defvar Info-up-link-keymap
3191 (let ((keymap (make-sparse-keymap)))
3192 (define-key keymap [header-line mouse-1] 'Info-up)
3193 (define-key keymap [header-line mouse-2] 'Info-up)
3194 (define-key keymap [header-line down-mouse-1] 'ignore)
3195 (define-key keymap [mouse-2] 'Info-up)
3196 keymap)
3197 "Keymap to put on the Up link in the text or the header line.")
3199 (defun Info-fontify-node ()
3200 "Fontify the node."
3201 (save-excursion
3202 (let* ((inhibit-read-only t)
3203 (case-fold-search t)
3204 paragraph-markers
3205 (not-fontified-p ; the node hasn't already been fontified
3206 (not (let ((where (next-property-change (point-min))))
3207 (and where (not (= where (point-max)))))))
3208 (fontify-visited-p ; visited nodes need to be re-fontified
3209 (and Info-fontify-visited-nodes
3210 ;; Don't take time to refontify visited nodes in huge nodes
3211 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size))))
3213 ;; Fontify header line
3214 (goto-char (point-min))
3216 (goto-char (match-end 0))
3218 (goto-char (match-end 0))
3219 (let* ((nbeg (match-beginning 2))
3220 (nend (match-end 2))
3221 (tbeg (match-beginning 1))
3222 (tag (match-string 1)))
3223 (if (string-equal tag "Node")
3224 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3225 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3226 (put-text-property tbeg nend 'mouse-face 'highlight)
3227 (put-text-property tbeg nend
3228 'help-echo
3229 (concat "Go to node "
3230 (buffer-substring nbeg nend)))
3231 ;; Always set up the text property keymap.
3232 ;; It will either be used in the buffer
3233 ;; or copied in the header line.
3234 (put-text-property tbeg nend 'keymap
3235 (cond
3236 ((equal tag "Prev") Info-prev-link-keymap)
3237 ((equal tag "Next") Info-next-link-keymap)
3238 ((equal tag "Up") Info-up-link-keymap))))))
3239 (when Info-use-header-line
3240 (goto-char (point-min))
3241 (let ((header-end (line-end-position))
3242 header)
3243 ;; If we find neither Next: nor Prev: link, show the entire
3244 ;; node header. Otherwise, don't show the File: and Node:
3245 ;; parts, to avoid wasting precious space on information that
3246 ;; is available in the mode line.
3247 (if (re-search-forward
3249 header-end t)
3250 (progn
3251 (goto-char (match-beginning 1))
3252 (setq header (buffer-substring (point) header-end)))
3254 (setq header
3255 (concat "No next, prev or up links -- "
3256 (buffer-substring (point) header-end)))
3257 (setq header (buffer-substring (point) header-end))))
3258 (put-text-property (point-min) (1+ (point-min))
3259 'header-line (Info-escape-percent header))
3260 ;; Hide the part of the first line
3261 ;; that is in the header, if it is just part.
3262 (unless (bobp)
3263 ;; Hide the punctuation at the end, too.
3265 (put-text-property (point) header-end 'invisible t)))))
3267 ;; Fontify titles
3268 (goto-char (point-min))
3269 (when not-fontified-p
3271 nil t)
3272 (let* ((c (preceding-char))
3273 (face
3274 (cond ((= c ?*) 'Info-title-1-face)
3275 ((= c ?=) 'Info-title-2-face)
3276 ((= c ?-) 'Info-title-3-face)
3277 (t 'Info-title-4-face))))
3278 (put-text-property (match-beginning 1) (match-end 1)
3279 'font-lock-face face))
3280 ;; This is a serious problem for trying to handle multiple
3281 ;; frame types at once. We want this text to be invisible
3282 ;; on frames that can display the font above.
3283 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3284 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3285 '(invisible t front-sticky nil rear-nonsticky t)))))
3287 ;; Fontify cross references
3288 (goto-char (point-min))
3289 (when (or not-fontified-p fontify-visited-p)
3290 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3291 (let ((start (match-beginning 0))
3292 (next (point))
3293 other-tag)
3294 (when not-fontified-p
3295 (when Info-hide-note-references
3296 ;; *Note is often used where *note should have been
3297 (goto-char start)
3298 (skip-syntax-backward " ")
3299 (setq other-tag
3300 (cond ((memq (char-before) '(nil ?\. ?! ??))
3301 "See ")
3302 ((memq (char-before) '(?\, ?\; ?\: ?-))
3303 "see ")
3304 ((memq (char-before) '(?\( ?\[ ?\{))
3305 ;; Check whether the paren is preceded by
3306 ;; an end of sentence
3307 (skip-syntax-backward " (")
3308 (if (memq (char-before) '(nil ?\. ?! ??))
3309 "See "
3310 "see "))
3312 "See ")))
3313 (goto-char next)
3314 (add-text-properties
3315 (match-beginning 1)
3316 (or (save-match-data
3318 (let ((start1 (match-beginning 1)))
3320 (+ start1 (match-beginning 0)))))
3321 (match-end 1))
3322 (if (and other-tag (not (eq Info-hide-note-references 'hide)))
3323 `(display ,other-tag front-sticky nil rear-nonsticky t)
3324 '(invisible t front-sticky nil rear-nonsticky t))))
3325 (add-text-properties
3326 (match-beginning 2) (match-end 2)
3327 (list
3328 'help-echo (if (or (match-end 5)
3329 (not (equal (match-string 4) "")))
3330 (concat "mouse-2: go to " (or (match-string 5)
3331 (match-string 4)))
3332 "mouse-2: go to this node")
3333 'mouse-face 'highlight)))
3334 (when (or not-fontified-p fontify-visited-p)
3335 (add-text-properties
3336 (match-beginning 2) (match-end 2)
3337 (list
3338 'font-lock-face
3339 ;; Display visited nodes in a different face
3340 (if (and Info-fontify-visited-nodes
3341 (save-match-data
3342 (let* ((node (replace-regexp-in-string
3344 (replace-regexp-in-string
3346 (or (match-string 5)
3347 (and (not (equal (match-string 4) ""))
3348 (match-string 4))
3349 (match-string 2)))))
3350 (file (file-name-nondirectory
3351 Info-current-file))
3352 (hl Info-history-list)
3353 res)
3355 (setq file (match-string 1 node)
3356 node (if (equal (match-string 2 node) "")
3357 "Top"
3358 (match-string 2 node))))
3359 (while hl
3360 (if (and (string-equal node (nth 1 (car hl)))
3361 (string-equal file
3362 (file-name-nondirectory
3363 (nth 0 (car hl)))))
3364 (setq res (car hl) hl nil)
3365 (setq hl (cdr hl))))
3366 res))) 'info-xref-visited 'info-xref))))
3367 (when not-fontified-p
3368 (when (memq Info-hide-note-references '(t hide))
3369 (add-text-properties (match-beginning 3) (match-end 3)
3370 '(invisible t front-sticky nil rear-nonsticky t))
3371 ;; Unhide the file name of the external reference in parens
3372 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3373 (remove-text-properties (match-beginning 6) (match-end 6)
3374 '(invisible t front-sticky nil rear-nonsticky t)))
3375 ;; Unhide newline because hidden newlines cause too long lines
3376 (save-match-data
3377 (let ((beg3 (match-beginning 3))
3378 (end3 (match-end 3)))
3380 (not (save-match-data
3381 (save-excursion
3382 (goto-char (1+ end3))
3383 (looking-at "[.)]*$")))))
3384 (remove-text-properties (+ beg3 (match-beginning 0))
3385 (+ beg3 (match-end 0))
3386 '(invisible t front-sticky nil rear-nonsticky t))))))
3387 (when (and Info-refill-paragraphs Info-hide-note-references)
3388 (push (set-marker (make-marker) start)
3389 paragraph-markers))))))
3391 ;; Refill paragraphs (experimental feature)
3392 (when (and not-fontified-p
3393 Info-refill-paragraphs
3394 paragraph-markers)
3395 (let ((fill-nobreak-invisible t)
3396 (fill-individual-varying-indent nil)
3399 (adaptive-fill-mode nil))
3400 (goto-char (point-max))
3401 (while paragraph-markers
3402 (let ((m (car paragraph-markers)))
3403 (setq paragraph-markers (cdr paragraph-markers))
3404 (when (< m (point))
3405 (goto-char m)
3406 (beginning-of-line)
3407 (let ((beg (point)))
3408 (when (zerop (forward-paragraph))
3409 (fill-individual-paragraphs beg (point) nil nil)
3410 (goto-char beg))))
3411 (set-marker m nil)))))
3413 ;; Fontify menu items
3414 (goto-char (point-min))
3415 (when (and (or not-fontified-p fontify-visited-p)
3418 ;; Don't take time to annotate huge menus
3419 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3420 (let ((n 0)
3421 cont)
3422 (while (re-search-forward
3425 nil t)
3426 (when not-fontified-p
3427 (setq n (1+ n))
3428 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3429 (put-text-property (match-beginning 0)
3430 (1+ (match-beginning 0))
3431 'font-lock-face 'info-menu-5)))
3432 (when not-fontified-p
3433 (add-text-properties
3434 (match-beginning 1) (match-end 1)
3435 (list
3436 'help-echo (if (match-end 3)
3437 (concat "mouse-2: go to " (match-string 3))
3438 "mouse-2: go to this node")
3439 'mouse-face 'highlight)))
3440 (when (or not-fontified-p fontify-visited-p)
3441 (add-text-properties
3442 (match-beginning 1) (match-end 1)
3443 (list
3444 'font-lock-face
3445 ;; Display visited menu items in a different face
3446 (if (and Info-fontify-visited-nodes
3447 (save-match-data
3448 (let ((node (if (equal (match-string 3) "")
3449 (match-string 1)
3450 (match-string 3)))
3451 (file (file-name-nondirectory Info-current-file))
3452 (hl Info-history-list)
3453 res)
3455 (setq file (match-string 1 node)
3456 node (if (equal (match-string 2 node) "")
3457 "Top"
3458 (match-string 2 node))))
3459 (while hl
3460 (if (and (string-equal node (nth 1 (car hl)))
3461 (string-equal file
3462 (file-name-nondirectory
3463 (nth 0 (car hl)))))
3464 (setq res (car hl) hl nil)
3465 (setq hl (cdr hl))))
3466 res))) 'info-xref-visited 'info-xref))))
3467 (when (and not-fontified-p (memq Info-hide-note-references '(t hide)))
3468 (put-text-property (match-beginning 2) (1- (match-end 6))
3469 'invisible t)
3470 ;; Unhide the file name in parens
3471 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
3472 (remove-text-properties (match-beginning 4) (match-end 4)
3473 '(invisible t)))
3474 ;; We need a stretchable space like :align-to but with
3475 ;; a minimum value.
3476 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3477 (if (>= 22 (- (match-end 1)
3478 (match-beginning 0)))
3479 '(space :align-to 24)
3480 '(space :width 2)))
3481 (setq cont (looking-at "."))
3482 (while (and (= (forward-line 1) 0)
3484 (put-text-property (match-beginning 1) (1- (match-end 1))
3485 'invisible t)
3486 (put-text-property (1- (match-end 1)) (match-end 1)
3487 'display
3488 (if cont
3489 '(space :align-to 26)
3490 '(space :align-to 24)))
3491 (setq cont t))))))
3493 ;; Fontify menu headers
3494 ;; Add the face `info-menu-header' to any header before a menu entry
3495 (goto-char (point-min))
3497 (put-text-property (match-beginning 0) (match-end 0)
3498 'font-lock-face 'info-menu-header)
3500 (put-text-property (match-beginning 1) (match-end 1)
3501 'font-lock-face 'info-menu-header)))
3503 ;; Fontify http and ftp references
3504 (goto-char (point-min))
3505 (when not-fontified-p
3507 (add-text-properties (match-beginning 0) (match-end 0)
3508 '(font-lock-face info-xref
3509 mouse-face highlight
3510 help-echo "mouse-2: go to this URL"))))
3512 (set-buffer-modified-p nil))))
3513 \f
3515 ;; When an Info buffer is killed, make sure the associated tags buffer
3516 ;; is killed too.
3517 (defun Info-kill-buffer ()
3518 (and (eq major-mode 'Info-mode)
3519 Info-tag-table-buffer
3520 (kill-buffer Info-tag-table-buffer)))
3522 (add-hook 'kill-buffer-hook 'Info-kill-buffer)
3524 ;;; Speedbar support:
3525 ;; These functions permit speedbar to display the "tags" in the
3526 ;; current info node.
3527 (eval-when-compile (require 'speedbar))
3529 (defvar Info-speedbar-key-map nil
3530 "Keymap used when in the info display mode.")
3532 (defun Info-install-speedbar-variables ()
3533 "Install those variables used by speedbar to enhance Info."
3534 (if Info-speedbar-key-map
3535 nil
3536 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
3538 ;; Basic tree features
3539 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
3540 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
3541 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
3542 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
3543 )
3545 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
3546 Info-speedbar-key-map
3547 Info-speedbar-hierarchy-buttons)))
3549 (defvar Info-speedbar-menu-items
3550 '(["Browse Node" speedbar-edit-line t]
3551 ["Expand Node" speedbar-expand-line
3552 (save-excursion (beginning-of-line)
3554 ["Contract Node" speedbar-contract-line
3555 (save-excursion (beginning-of-line)
3556 (looking-at "[0-9]+: *.-. "))]
3557 )
3558 "Additional menu-items to add to speedbar frame.")
3560 ;; Make sure our special speedbar major mode is loaded
3561 (if (featurep 'speedbar)
3562 (Info-install-speedbar-variables)
3563 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
3565 ;;; Info hierarchy display method
3566 ;;;###autoload
3567 (defun Info-speedbar-browser ()
3568 "Initialize speedbar to display an info node browser.
3569 This will add a speedbar major display mode."
3570 (interactive)
3571 (require 'speedbar)
3572 ;; Make sure that speedbar is active
3573 (speedbar-frame-mode 1)
3574 ;; Now, throw us into Info mode on speedbar.
3575 (speedbar-change-initial-expansion-list "Info")
3576 )
3578 (eval-when-compile (defvar speedbar-attached-frame))
3580 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
3581 "Display an Info directory hierarchy in speedbar.
3582 DIRECTORY is the current directory in the attached frame.
3583 DEPTH is the current indentation depth.
3584 NODE is an optional argument that is used to represent the
3585 specific node to expand."
3586 (if (and (not node)
3587 (save-excursion (goto-char (point-min))
3588 (let ((case-fold-search t))
3589 (looking-at "Info Nodes:"))))
3590 ;; Update our "current node" maybe?
3591 nil
3592 ;; We cannot use the generic list code, that depends on all leaves
3593 ;; being known at creation time.
3594 (if (not node)
3596 (let ((completions nil)
3597 (cf (selected-frame)))
3598 (select-frame speedbar-attached-frame)
3599 (save-window-excursion
3600 (setq completions
3601 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
3602 (select-frame cf)
3603 (if completions
3604 (speedbar-with-writable
3605 (dolist (completion completions)
3606 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
3607 (cdr completion)
3608 (car completion)
3609 'Info-speedbar-goto-node
3610 (cdr completion)
3611 'info-xref depth))
3612 t)
3613 nil))))
3615 (defun Info-speedbar-goto-node (text node indent)
3616 "When user clicks on TEXT, go to an info NODE.
3617 The INDENT level is ignored."
3618 (select-frame speedbar-attached-frame)
3619 (let* ((buff (or (get-buffer "*info*")
3620 (progn (info) (get-buffer "*info*"))))
3621 (bwin (get-buffer-window buff 0)))
3622 (if bwin
3623 (progn
3624 (select-window bwin)
3625 (raise-frame (window-frame bwin)))
3626 (if speedbar-power-click
3627 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
3628 (select-frame speedbar-attached-frame)
3629 (switch-to-buffer buff)))
3631 (error "Invalid node %s" node)
3632 (Info-find-node (match-string 1 node) (match-string 2 node))
3633 ;; If we do a find-node, and we were in info mode, restore
3634 ;; the old default method. Once we are in info mode, it makes
3635 ;; sense to return to whatever method the user was using before.
3636 (if (string= speedbar-initial-expansion-list-name "Info")
3637 (speedbar-change-initial-expansion-list
3638 speedbar-previously-used-expansion-list-name)))))
3640 (defun Info-speedbar-expand-node (text token indent)
3641 "Expand the node the user clicked on.
3642 TEXT is the text of the button we clicked on, a + or - item.
3643 TOKEN is data related to this node (NAME . FILE).
3644 INDENT is the current indentation depth."
3645 (cond ((string-match "+" text) ;we have to expand this file
3646 (speedbar-change-expand-button-char ?-)
3647 (if (speedbar-with-writable
3648 (save-excursion
3649 (end-of-line) (forward-char 1)
3650 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
3651 (speedbar-change-expand-button-char ?-)
3652 (speedbar-change-expand-button-char ??)))
3653 ((string-match "-" text) ;we have to contract this node
3654 (speedbar-change-expand-button-char ?+)
3655 (speedbar-delete-subblock indent))
3656 (t (error "Ooops... not sure what to do")))
3657 (speedbar-center-buffer-smartly))
3659 (defun Info-speedbar-fetch-file-nodes (nodespec)
3660 "Fetch the subnodes from the info NODESPEC.
3661 NODESPEC is a string of the form: (file)node.
3662 Optional THISFILE represends the filename of"
3663 (save-excursion
3664 ;; Set up a buffer we can use to fake-out Info.
3665 (set-buffer (get-buffer-create "*info-browse-tmp*"))
3666 (if (not (equal major-mode 'Info-mode))
3667 (Info-mode))
3668 ;; Get the node into this buffer
3670 (error "Invalid node specification %s" nodespec)
3671 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
3672 ;; Scan the created buffer
3673 (goto-char (point-min))
3674 (let ((completions nil)
3675 (case-fold-search t)
3677 (match-string 1 nodespec))))
3678 ;; Always skip the first one...
3681 (let ((name (match-string 1)))
3682 (push (cons name
3684 (match-string 1)
3686 (concat (match-string 1) "Top")
3687 (concat "(" thisfile ")"
3689 (match-string 1)
3690 name)))))
3691 completions)))
3692 (nreverse completions))))
3694 ;;; Info mode node listing
3695 ;; FIXME: Seems not to be used. -stef
3696 (defun Info-speedbar-buttons (buffer)
3697 "Create a speedbar display to help navigation in an Info file.
3698 BUFFER is the buffer speedbar is requesting buttons for."
3699 (if (save-excursion (goto-char (point-min))
3700 (let ((case-fold-search t))
3701 (not (looking-at "Info Nodes:"))))
3702 (erase-buffer))
3703 (Info-speedbar-hierarchy-buttons nil 0)
3704 )
3706 (dolist (mess '("^Node has no Previous$"
3707 "^No menu in this node$"
3708 "^Node has no Next$"
3709 "^No cross-references in this node^"
3710 search-failed
3712 (add-to-list 'debug-ignored-errors mess))
3714 ;;;; Desktop support
3716 (defun Info-desktop-buffer-misc-data (desktop-dirname)
3717 "Auxiliary information to be saved in desktop file."
3718 (list Info-current-file Info-current-node))
3720 ;;;###autoload
3721 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
3722 desktop-buffer-name
3723 desktop-buffer-misc)
3724 "Restore an info buffer specified in a desktop file."
3725 (let ((first (nth 0 desktop-buffer-misc))
3726 (second (nth 1 desktop-buffer-misc)))
3727 (when (and first second)
3728 (Info-find-node first second)
3729 (current-buffer))))
3731 (provide 'info)
3733 ;;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
3734 ;;; info.el ends here