| blob | 43e1dafcc6ff38d1b23ac69158f0fe3394099c90 |
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 selects an Info buffer with the prefix number
473 appended to the Info buffer name.
475 The search path for Info files is in the variable `Info-directory-list'.
476 The top-level Info directory is made by combining all the files named `dir'
477 in all the directories in that path."
487 ;; If argument already contains parentheses, don't add another set
488 ;; since the argument will then be parsed improperly. This also
489 ;; has the added benefit of allowing node names to be included
490 ;; following the parenthesized filename.
497 ;;;###autoload
499 "Display the Emacs manual in Info mode."
503 ;;;###autoload
505 "Run Emacs as a standalone Info reader.
506 Usage: emacs -f info-standalone [filename]
520 \f
521 ;; See if the accessible portion of the buffer begins with a node
522 ;; delimiter, and the node header line which follows matches REGEXP.
523 ;; Typically, this test will be followed by a loop that examines the
524 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
525 ;; to have the overhead of this special test inside the loop.
527 ;; This function changes match-data, but supposedly the caller might
528 ;; want to use the results of re-search-backward.
530 ;; The return value is the value of point at the beginning of matching
531 ;; REGEXP, if the function succeeds, nil otherwise.
543 Optional second argument NOERROR, if t, means if file is not found
544 just return nil (no error)."
545 ;; Convert filename to lower case if not found as specified.
546 ;; Expand it.
561 ;; If specified name starts with `./'
562 ;; then just try current directory.
565 ;; No point in searching for an
566 ;; absolute file name
570 Info-additional-directory-list)
571 Info-directory-list)))))
572 ;; Search the directory list for file FILENAME.
577 ;; Try several variants of specified name.
581 t)))
592 lfn
604 filename)))
607 "Go to an info node specified as separate FILENAME and NODENAME.
608 NO-GOING-BACK is non-nil if recovering from an error in this function;
609 it says do not attempt further (recursive) error recovery."
612 ;; Record the node we are leaving.
616 Info-history)))
617 ;; Go into info buffer.
622 "Use the `Info-mode' to browse the current info buffer.
623 If a prefix arg is provided, it queries for the NODENAME which
635 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
636 ;; but at least it keeps this routine (which is only for the benefit of
637 ;; makeinfo-buffer) out of the way of normal operations.
638 ;;
640 "Go to an info node FILENAME and NODENAME, re-reading disk contents.
641 When *info* is already displaying FILENAME and NODENAME, the window position
642 is preserved, if possible."
658 ;; note goto-line is no good, we want to measure from point-min
665 ;; only add to the history when coming from a different file+node
670 "Find a node in a tag table.
671 MARKER specifies the buffer and position to start searching at.
672 REGEXP is a regular expression matching nodes or references. Its first
673 group should match `Node:' or `Ref:'.
674 CASE-FOLD t means search for a case-insensitive match.
675 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
676 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
677 where the match was found, and MODE is `major-mode' of the buffer in
678 which the match was found."
684 ;; Search tag table
689 major-mode)))))
692 "Find a node in a tag table.
693 MARKER specifies the buffer and position to start searching at.
694 REGEXP is a regular expression matching nodes or references. Its first
695 group should match `Node:' or `Ref:'.
696 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
697 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
698 where the match was found, and MODE is `major-mode' of the buffer in
699 which the match was found.
700 This function tries to find a case-sensitive match first, then a
701 case-insensitive match is tried."
705 result))
708 "Find a node or anchor in the current buffer.
709 REGEXP is a regular expression matching nodes or references. Its first
710 group should match `Node:' or `Ref:'.
711 CASE-FOLD t means search for a case-insensitive match.
712 Value is the position at which a match was found, or nil if not found."
714 found)
726 found)))
729 "Find a node or anchor in the current buffer.
730 REGEXP is a regular expression matching nodes or references. Its first
731 group should match `Node:' or `Ref:'.
732 Value is the position at which a match was found, or nil if not found.
733 This function looks for a case-sensitive match first. If none is found,
734 a case-insensitive match is tried."
746 anchorpos)
747 ;; Switch files if necessary
752 Info-current-subfile nil
753 Info-current-file-completions nil
754 buffer-file-name nil)
769 ;; See whether file has a tag table. Record the location if yes.
772 ;; Use string-equal, not equal, to ignore text props.
777 ;; We have a tag table. Find its beginning.
778 ;; Is this an indirect file?
784 ;; It is indirect. Copy it to another buffer
785 ;; and record that the tag table is in that buffer.
808 ))
809 ;; Use string-equal, not equal, to ignore text props.
813 ;; Possibilities:
814 ;;
815 ;; 1. Anchor found in tag table
816 ;; 2. Anchor *not* in tag table
817 ;;
818 ;; 3. Node found in tag table
819 ;; 4. Node *not* found in tag table, but found in file
820 ;; 5. Node *not* in tag table, and *not* in file
821 ;;
822 ;; *Or* the same, but in an indirect subfile.
824 ;; Search file for a suitable node.
834 ;; First, search a tag table, if any
840 ;; FOUND is (ANCHOR POS MODE).
843 ;; If this is an indirect file, determine which
844 ;; file really holds this node and read it in.
846 ;; Note that the current buffer must be the
847 ;; *info* buffer on entry to
848 ;; Info-read-subfile. Thus the hackery above.
851 ;; Handle anchor
856 ;; Else we may have a node, which we search for:
860 ;; Now search from our advised position (or from beg of
861 ;; buffer) to find the actual node. First, check
862 ;; whether the node is right where we are, in case the
863 ;; buffer begins with a node.
876 ;; No such anchor in tag table or node in tag table or file
884 ;; Add anchors to the history too
895 ;; If we did not finish finding the specified node,
896 ;; go back to the previous one.
903 ;; Cache the contents of the (virtual) dir file, once we have merged
904 ;; it for the first time, so we can save time subsequently.
907 ;; Cache for the directory we decided to use for the default-directory
908 ;; of the merged dir text.
911 ;; Record the file attributes of all the files from which we
912 ;; constructed Info-dir-contents.
917 ;; Construct the Info directory node by merging the files named `dir'
918 ;; from various directories. Set the *info* buffer's
919 ;; default-directory to the first directory we actually get any text
920 ;; from.
923 ;; Verify that none of the files we used has changed
924 ;; since we used it.
928 ;; Handle symlinks
931 ;; Don't compare the access time.
935 Info-dir-file-attributes))))
941 Info-additional-directory-list)
942 Info-directory-list))
944 ;; Bind this in case the user sets it to nil.
946 ;; This is set non-nil if we find a problem in some input files.
947 problems
948 buffers buffer others nodes dirs-done)
950 ;; Search the directory list for the directory file.
955 ;; Try several variants of specified name.
956 ;; Try upcasing, appending `.info', or both.
971 dirs-done)))
981 file)
993 ;; Distinguish the dir file that comes with Emacs from all the
994 ;; others. Yes, that is really what this is supposed to do.
995 ;; The definition of `Info-directory-list' puts it first on that
996 ;; list and so last in `buffers' at this point.
1000 ;; Insert the entire original dir file as a start; note that we've
1001 ;; already saved its default directory to use as the default
1002 ;; directory for the whole concatenation.
1005 ;; Look at each of the other buffers one by one.
1008 ;; In each, find all the menus.
1011 ;; Find each menu, and add an elt to NODES for it.
1015 nodename end)
1027 ;; Add to the main menu a menu item for each other node.
1039 end t)
1043 ;; Now take each node of each of the other buffers
1044 ;; and merge it into the main buffer.
1049 ;; Find the like-named node in the main buffer.
1053 nil t)
1058 ;; If none exists, add one.
1061 ;; Merge the text from the other buffer's menu
1062 ;; into the menu in the like-named node in the main buffer.
1065 ;; Kill all the buffers we just made.
1085 ;; Remove duplicate headings in the same menu.
1088 ;; Look for the next heading to unify.
1093 ;; Check whether this heading should be streamlined.
1103 ;; Look for other headings of the same category and merge them.
1109 ;; Delete redundant heading.
1111 ;; Push the entries onto `text'.
1118 ;; Insert the entries just found.
1126 ;; Now remove duplicate entries under the same heading.
1139 ;; Note that on entry to this function the current-buffer must be the
1140 ;; *info* buffer; not the info tags buffer.
1142 ;; NODEPOS is either a position (in the Info file as a whole,
1143 ;; not relative to a subfile) or the name of a subfile.
1145 lastfilename)
1157 thisfilepos thisfilename)
1161 ;; read in version 19 stops at the end of number.
1162 ;; Advance to the next line.
1171 ;; Assume previous buffer is in Info-mode.
1172 ;; (set-buffer (get-buffer "*info*"))
1181 ;; Widen in case we are in the same subfile as before.
1191 "Unescape double quotes and backslashes in VALUE."
1197 unquote))
1199 ;; As of Texinfo 4.6, makeinfo writes constructs like
1200 ;; \0\h[image param=value ...\h\0]
1201 ;; into the Info file for handling images.
1204 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1205 whitespace or double quotes, it must be quoted in double quotes and
1210 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1211 parameter-string start)
1217 parameter-alist))
1218 parameter-alist))
1221 "Display images in current node."
1228 nil t)
1243 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1244 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1245 ;; including one optional trailing newline.
1247 "Hide unrecognised cookies in current node."
1254 nil t)
1261 "Select the info node that point is in."
1262 ;; Bind this in case the user sets it to nil.
1265 ;; Find beginning of node.
1271 ;; Get nodename spelled as it is in the node.
1279 ;; Find the end of it, and narrow.
1282 ;; Narrow to the node contents
1294 ;; Add a new unique history item to full history list
1311 Info-current-file
1313 ") "
1315 \f
1316 ;; Go to an info node specified with a filename-and-nodename string
1317 ;; of the sort that is found in pointers in nodes.
1319 ;;;###autoload
1321 "Go to info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1322 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1323 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1324 its sub-files).
1325 Completion is available, but only for node names in the current Info file.
1326 If FORK is non-nil (interactively with a prefix arg), show the node in
1327 a new info buffer.
1328 If FORK is a string, it is the name to use for the new buffer."
1336 nodename)
1338 ""
1351 ;; This function is used as the "completion table" while reading a node name.
1352 ;; It does completion using the alist in Info-read-node-completion-table
1353 ;; unless STRING starts with an open-paren.
1356 ;; First complete embedded file names.
1371 ;; If a file name was given, then any node is fair game.
1377 ;; Otherwise use Info-read-node-completion-table.
1392 nodename)))
1397 ;; Bind this in case the user sets it to nil.
1410 compl))))
1413 ;; If the buffer begins with a node header, process that first.
1416 ;; Now for the rest of the nodes.
1424 compl))))))))
1427 \f
1429 "If this node has been visited, restore the point value when we left."
1432 ;; Use string-equal, not equal, to ignore text props.
1438 \f
1446 "Search for REGEXP, starting from point, and select node it's found in."
1479 ;; If no subfiles, give error now.
1487 ;; Try other subfiles.
1498 ;; Find the subfile we just searched.
1500 ;; Skip that one.
1502 ;; Make a list of all following subfiles.
1503 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1510 list))
1512 ;; Put in forward order
1540 ;; Use string-equal, not equal, to ignore text props.
1544 Info-history))))))
1547 "Search for a regexp case-sensitively."
1553 "Search for next regexp from a previous `Info-search' command."
1559 \f
1561 "Extract the value of the node-pointer named NAME.
1562 If there is none, use ERRORNAME in the error message;
1563 if ERRORNAME is nil, just return nil."
1564 ;; Bind this in case the user sets it to nil.
1578 "Return a regexp matching a node name.
1579 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1580 saying which chars may appear in the node name.
1581 Submatch 1 is the complete node name.
1582 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1583 Submatch 3 is the local part of the node name.
1584 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1591 ;;; For compatibility; other files have used this name.
1597 "Go to the next node of this node."
1602 "Go to the previous node of this node."
1607 "Go to the superior node of this node.
1608 If SAME-FILE is non-nil, do not move to a different Info file."
1625 nil t))
1631 "Go back to the last node visited."
1644 ;;;###autoload
1646 "Go to the Info directory node."
1649 \f
1651 "Go to a node with a menu of visited nodes."
1655 p)
1677 "Go to a node with table of contents of the current Info file.
1678 Table of contents is created from the tree structure of menus."
1682 p)
1707 "Insert table of contents with references to nodes."
1719 "Build table of contents from menus of Info FILE and its subfiles."
1726 default-directory))
1729 nodes subfiles)
1741 menu-items)
1750 bound))
1753 ;; Menu item line
1763 ;; Other non-empty strings in the Top node are section names
1772 nodes))
1781 subfiles)))))
1783 main-file nil))
1787 \f
1789 "Follow cross reference named FOOTNOTENAME to the node it refers to.
1790 FOOTNOTENAME may be an abbreviation of the reference name.
1791 If FORK is non-nil (interactively with a prefix arg), show the node in
1792 a new info buffer. If FORK is a string, it is the name to use for the
1793 new buffer."
1799 ;; Store end and beginning of line.
1808 ;; See if this one should be the default.
1813 ;; See if this one should be the alternate default.
1823 ;; Record as a completion and perhaps as default.
1826 ;; Don't add this string if it's a duplicate.
1829 ;; If no good default was found, try an alternate.
1832 ;; If only one cross-reference found, then make it default.
1838 "Follow reference named: (default "
1841 completions nil t)))
1855 ;; Move point to the beginning of reference if point is on reference
1865 ;; Go to the reference closest to point
1873 next-ref prev-ref))
1884 ;; We allow newline because this is also used in Info-follow-reference,
1885 ;; where the xref name might be wrapped over two lines.
1886 "Regexp that matches a menu entry name upto but not including the colon.
1887 Because of ambiguities, this should be concatenated with something like
1907 ;;; Comment out the next line to use names of cross-references:
1908 ;;; (setq Info-point-loc
1909 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
1910 )
1914 ;; If the node name is the menu entry name (using `entry::').
1917 ;; No one calls this.
1918 ;;(defun Info-menu-item-sequence (list)
1919 ;; (while list
1920 ;; (Info-menu (car list))
1921 ;; (setq list (cdr list))))
1933 ;; This uses two dynamically bound variables:
1934 ;; - `Info-complete-menu-buffer' which contains the buffer in which
1935 ;; is the menu of items we're trying to complete.
1936 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
1937 ;; also look for menu items in subsequent nodes as long as those
1938 ;; nodes' names match `Info-complete-next-re'. This feature is currently
1939 ;; not used.
1940 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
1941 ;; also look for menu items in these nodes. This feature is currently
1942 ;; only used for completion in Info-index.
1944 ;; Note that `Info-complete-menu-buffer' could be current already,
1945 ;; so we want to save point.
1951 nextnode)
1960 completions)
1961 ;; Check the cache.
1969 ;; We can reuse the previous list.
1971 ;; The cache can't be used.
1976 completions))
1977 ;; Check subsequent nodes if applicable.
1985 ;; Go back to the start node (for the next completion).
1988 ;; Update the cache.
1991 Info-complete-next-re string completions
1992 Info-complete-nodes)))
1999 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2000 The menu item should one of those listed in the current node's menu.
2001 Completion is allowed, and the default menu item is the one point is on.
2002 If FORK is non-nil (interactively with a prefix arg), show the node in
2003 a new info buffer. If FORK is a string, it is the name to use for the
2004 new buffer."
2007 ;; If point is within a menu item, use that item as the default
2010 beg
2023 Info-menu-entry-name-re
2032 default)
2035 ;; we rely on the fact that completing-read accepts an input
2036 ;; of "" even when the require-match argument is true and ""
2037 ;; is not a valid possibility
2041 ;; ask again
2044 ;; there is a problem here in that if several menu items have the same
2045 ;; name you can only go to the node of the first with this command.
2063 ;; If COUNT is nil, use the last item in the menu.
2075 nil))
2079 "Go to the node of the Nth menu item.
2080 N is the digit argument used to invoke this command."
2087 "Go to the Top node of this file."
2092 "Go to the final node in this file."
2097 ;; Go to the last node in the menu of Top.
2099 ;; If the last node in the menu is not last in pointer structure,
2100 ;; move forward until we can't go any farther.
2102 ;; Then keep moving down to last subnode, unless we reach an index.
2108 "Go forward one node, considering all nodes as forming one sequence."
2113 ;; three possibilities, in order of priority:
2114 ;; 1. next node is in a menu in this node (but not in an index)
2115 ;; 2. next node is next at same level
2116 ;; 3. next node is up and next
2121 t)
2124 t)
2126 ;; Use string-equal, not equal, to ignore text props.
2139 "Go backward one node, considering all nodes as forming one sequence."
2147 ;; Use string-equal, not equal,
2148 ;; to ignore text properties.
2153 ;; If we move back at the same level,
2154 ;; go down to find the last subnode*.
2164 "Exit Info by selecting some other buffer."
2171 "Go to the node of the next menu item."
2173 ;; Bind this in case the user sets it to nil.
2185 "Go to the node of the previous menu item."
2189 ;; Bind this in case the user sets it to nil.
2204 "Go to the next subnode or the next node, or go up a level."
2209 ;; Since we have already gone thru all the items in this menu,
2210 ;; go up to the end of this node.
2212 ;; Since logically we are done with the node with that menu,
2213 ;; move on from it.
2219 "Go to the last node, popping up a level if there is none."
2223 ;; If we go down a menu item, go to the end of the node
2224 ;; so we can scroll back through it.
2226 ;; Keep going down, as long as there are nested menu nodes.
2229 ;; If we go down a menu item, go to the end of the node
2230 ;; so we can scroll back through it.
2240 ;; If we go down a menu item, go to the end of the node
2241 ;; so we can scroll back through it.
2252 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2253 Once you scroll far enough in a node that its menu appears on the screen
2254 but after point, the next scroll moves into its first subnode, unless
2255 `Info-scroll-prefer-subnodes' is nil.
2257 When you scroll past the end of a node, that goes to the next node if
2258 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2259 if this node has no successor, it moves to the parent node's successor,
2260 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2261 the menu of a node, it moves to subnode indicated by the following menu
2262 item. (That case won't normally result from this command, but can happen
2263 in other ways.)"
2285 "Scroll one screenful back in Info, considering all nodes as one sequence.
2286 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2287 is non-nil, this goes to its last subnode. When you scroll past the
2288 beginning of a node, that goes to the previous node or back up to the
2289 parent node."
2303 current-point
2304 t)))))
2311 "Move cursor to the next cross-reference or menu item in the node."
2331 "Move cursor to the previous cross-reference or menu item in the node."
2348 \f
2350 "Alist of cached index node names of visited Info files.
2354 "Return a list of names of all index nodes in Info FILE.
2355 If FILE is omitted, it defaults to the current Info file.
2356 First look in a list of cached index node names. Then scan Info
2357 file and its subfiles for nodes with the index cookie. Then try
2358 to find index nodes starting from the first node in the top level
2363 ;; Skip virtual Info files
2367 ;; Find nodes with index cookie
2371 default-directory))
2372 Info-history Info-history-list Info-fontify-maximum-menu-size
2392 subfiles)))))
2394 main-file nil))
2400 nodes)
2401 ;; Find nodes with the word "Index" in the node name
2403 Info-history Info-history-list Info-fontify-maximum-menu-size
2404 nodes node)
2422 nodes)
2423 ;; If file has no index nodes, still add it to the cache
2428 "Return non-nil value if NODE is an index node.
2429 If NODE is nil, check the current Info node.
2430 If FILE is nil, check the current Info file."
2434 ;; Don't search all index nodes if request is only for the current node
2435 ;; and file is not in the cache of index nodes
2449 "Go to the first index node."
2454 ;;;###autoload
2456 "Look up a string TOPIC in the index for this file.
2457 If there are no exact matches to the specified topic, this chooses
2458 the first match which is a case-insensitive substring of a topic.
2460 Give a blank topic name to go to the Index node itself."
2476 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2485 ;; We bind Info-history to nil for internal node-switches so
2486 ;; that we don't put junk in the history. In the first
2487 ;; Info-goto-index call, above, we do update the history
2488 ;; because that is what the user's previous node choice into it.
2490 found)
2497 Info-current-node
2500 matches))
2507 ;; Here it is a feature that assoc is case-sensitive.
2537 "(`,' tries to find next)"
2541 "Move point to the place within the current node where NAME is defined."
2546 ;; Find a function definition with a return type.
2554 nil t))
2556 ;; Try again without the " <1>" makeinfo can append
2562 ;;;###autoload
2564 "Grovel indices of all known Info files on your system for STRING.
2565 Build a menu of the possible matches."
2568 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2574 manuals matches node nodes)
2602 Info-history-list ohist-list)
2623 "Make command be undefined in Info."
2628 "Enter the Info tutorial."
2633 "Help-Small-Screen"
2637 "Display a brief summary of all Info commands."
2652 flag))
2655 \f
2657 "Return the token around POS.
2658 POS must be somewhere inside the token
2659 START is a regular expression which will match the
2660 beginning of the tokens delimited string
2661 ALL is a regular expression with a single
2662 parenthesized subpattern which is the token to be
2663 returned. E.g. '{\(.*\)}' would return any string
2664 enclosed in braces around POS.
2665 ERRORSTRING optional fourth argument, controls action on no match
2666 nil: return nil
2667 t: beep
2668 a string: signal an error, using that string."
2672 ;; First look for a match for START that goes across POS.
2676 ;; If we did not find one, search back for START
2677 ;; (this finds only matches that end at or before POS).
2690 nil)
2693 nil)
2699 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
2700 At end of the node's text, moves to the next node, or up if none."
2708 "Follow a node reference near point.
2709 If point is on a reference, follow that reference. Otherwise,
2710 if point is in a menu item description, follow that menu item."
2722 t)))
2725 ;; Common subroutine.
2727 "Follow a node reference near point. Return non-nil if successful."
2737 ;; menu item: node name
2740 ;; menu item: node name or index entry
2754 node))
2755 \f
2759 nil
2768 (define-key Info-mode-map "1" 'Info-nth-menu-item)
2769 (define-key Info-mode-map "2" 'Info-nth-menu-item)
2770 (define-key Info-mode-map "3" 'Info-nth-menu-item)
2771 (define-key Info-mode-map "4" 'Info-nth-menu-item)
2772 (define-key Info-mode-map "5" 'Info-nth-menu-item)
2773 (define-key Info-mode-map "6" 'Info-nth-menu-item)
2774 (define-key Info-mode-map "7" 'Info-nth-menu-item)
2775 (define-key Info-mode-map "8" 'Info-nth-menu-item)
2776 (define-key Info-mode-map "9" 'Info-nth-menu-item)
2777 (define-key Info-mode-map "0" 'undefined)
2778 (define-key Info-mode-map "?" 'Info-summary)
2779 (define-key Info-mode-map "]" 'Info-forward-node)
2780 (define-key Info-mode-map "[" 'Info-backward-node)
2781 (define-key Info-mode-map "<" 'Info-top-node)
2782 (define-key Info-mode-map ">" 'Info-final-node)
2783 (define-key Info-mode-map "b" 'beginning-of-buffer)
2784 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
2785 (define-key Info-mode-map "d" 'Info-directory)
2786 (define-key Info-mode-map "e" 'Info-edit)
2787 (define-key Info-mode-map "f" 'Info-follow-reference)
2788 (define-key Info-mode-map "g" 'Info-goto-node)
2789 (define-key Info-mode-map "h" 'Info-help)
2790 (define-key Info-mode-map "i" 'Info-index)
2791 (define-key Info-mode-map "l" 'Info-last)
2792 (define-key Info-mode-map "L" 'Info-history)
2793 (define-key Info-mode-map "m" 'Info-menu)
2794 (define-key Info-mode-map "n" 'Info-next)
2795 (define-key Info-mode-map "p" 'Info-prev)
2796 (define-key Info-mode-map "q" 'Info-exit)
2797 (define-key Info-mode-map "s" 'Info-search)
2798 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
2799 ;; For consistency with Rmail.
2800 (define-key Info-mode-map "\M-s" 'Info-search)
2801 (define-key Info-mode-map "\M-n" 'clone-buffer)
2802 (define-key Info-mode-map "t" 'Info-top-node)
2803 (define-key Info-mode-map "T" 'Info-toc)
2804 (define-key Info-mode-map "u" 'Info-up)
2805 ;; For consistency with dired-copy-filename-as-kill.
2806 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
2807 (define-key Info-mode-map "," 'Info-index-next)
2809 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
2810 )
2812 (defun Info-check-pointer (item)
2813 "Non-nil if ITEM is present in this node."
2814 (condition-case nil
2815 (Info-extract-pointer item)
2816 (error nil)))
2818 (easy-menu-define
2819 Info-mode-menu Info-mode-map
2820 "Menu for info files."
2821 '("Info"
2822 ["Up" Info-up :active (Info-check-pointer "up")
2823 :help "Go up in the Info tree"]
2824 ["Next" Info-next :active (Info-check-pointer "next")
2825 :help "Go to the next node"]
2826 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
2827 :help "Go to the previous node"]
2828 ["Backward" Info-backward-node
2829 :help "Go backward one node, considering all as a sequence"]
2830 ["Forward" Info-forward-node
2831 :help "Go forward one node, considering all as a sequence"]
2832 ["Beginning" beginning-of-buffer
2833 :help "Go to beginning of this node"]
2834 ["Top" Info-top-node
2835 :help "Go to top node of file"]
2836 ["Final Node" Info-final-node
2837 :help "Go to final node in this file"]
2838 ("Menu Item" ["You should never see this" report-emacs-bug t])
2839 ("Reference" ["You should never see this" report-emacs-bug t])
2840 ["Search..." Info-search
2841 :help "Search for regular expression in this Info file"]
2842 ["Search Case-Sensitively..." Info-search-case-sensitively
2843 :help "Search for regular expression case sensitively"]
2844 ["Search Next" Info-search-next
2845 :help "Search for another occurrence of regular expression"]
2846 ["Go to Node..." Info-goto-node
2847 :help "Go to a named node"]
2848 ["Last" Info-last :active Info-history
2849 :help "Go to the last node you were at"]
2850 ["History" Info-history :active Info-history-list
2851 :help "Go to menu of visited nodes"]
2852 ["Table of Contents" Info-toc
2853 :help "Go to table of contents"]
2854 ("Index..."
2855 ["Lookup a String" Info-index
2856 :help "Look for a string in the index items"]
2857 ["Next Matching Item" Info-index-next
2858 :help "Look for another occurrence of previous item"]
2859 ["Lookup a string in all indices" info-apropos
2860 :help "Look for a string in the indices of all manuals"])
2861 ["Edit" Info-edit :help "Edit contents of this node"
2862 :active Info-enable-edit]
2863 ["Copy Node Name" Info-copy-current-node-name
2864 :help "Copy the name of the current node into the kill ring"]
2865 ["Clone Info buffer" clone-buffer
2866 :help "Create a twin copy of the current Info buffer."]
2867 ["Exit" Info-exit :help "Stop reading Info"]))
2870 (defvar info-tool-bar-map
2871 (if (display-graphic-p)
2872 (let ((map (make-sparse-keymap)))
2873 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
2874 (tool-bar-local-item-from-menu 'Info-prev "left_arrow" map Info-mode-map)
2875 (tool-bar-local-item-from-menu 'Info-next "right_arrow" map Info-mode-map)
2876 (tool-bar-local-item-from-menu 'Info-up "up_arrow" map Info-mode-map)
2877 (tool-bar-local-item-from-menu 'Info-last "undo" map Info-mode-map)
2878 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
2879 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
2880 (tool-bar-local-item-from-menu 'Info-goto-node "jump_to" map Info-mode-map)
2881 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
2882 map)))
2884 (defvar Info-menu-last-node nil)
2885 ;; Last node the menu was created for.
2886 ;; Value is a list, (FILE-NAME NODE-NAME).
2888 (defun Info-menu-update ()
2889 "Update the Info menu for the current node."
2890 (condition-case nil
2891 (if (or (not (eq major-mode 'Info-mode))
2892 (equal (list Info-current-file Info-current-node)
2893 Info-menu-last-node))
2894 ()
2895 ;; Update menu menu.
2896 (let* ((Info-complete-menu-buffer (current-buffer))
2897 (items (nreverse (condition-case nil
2898 (Info-complete-menu-item "" nil t)
2899 (error nil))))
2900 entries current
2901 (number 0))
2902 (while (and items (< number 9))
2903 (setq current (car items)
2904 items (cdr items)
2905 number (1+ number))
2906 (setq entries (cons `[,current
2907 (Info-menu ,current)
2908 :keys ,(format "%d" number)]
2909 entries)))
2910 (if items
2911 (setq entries (cons ["Other..." Info-menu t] entries)))
2912 (or entries
2913 (setq entries (list ["No menu" nil nil] nil :active)))
2914 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
2915 ;; Update reference menu. Code stolen from `Info-follow-reference'.
2916 (let ((items nil)
2917 str i entries current
2918 (number 0)
2919 (case-fold-search t))
2920 (save-excursion
2921 (goto-char (point-min))
2923 (setq str (match-string 1))
2924 (setq i 0)
2926 (setq str (concat (substring str 0 i) " "
2927 (substring str (match-end 0))))
2928 (setq i (1+ i)))
2929 (setq items
2930 (cons str items))))
2931 (while (and items (< number 9))
2932 (setq current (car items)
2933 items (cdr items)
2934 number (1+ number))
2935 (setq entries (cons `[,current
2936 (Info-follow-reference ,current)
2937 t]
2938 entries)))
2939 (if items
2940 (setq entries (cons ["Other..." Info-follow-reference t]
2941 entries)))
2942 (or entries
2943 (setq entries (list ["No references" nil nil] nil :active)))
2944 (easy-menu-change '("Info") "Reference" (nreverse entries)))
2945 ;; Update last seen node.
2946 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
2947 ;; Try to avoid entering infinite beep mode in case of errors.
2948 (error (ding))))
2950 \f
2951 (defun Info-copy-current-node-name (&optional arg)
2952 "Put the name of the current info node into the kill ring.
2953 The name of the info file is prepended to the node name in parentheses.
2954 With a zero prefix arg, put the name inside a function call to `info'."
2955 (interactive "P")
2956 (unless Info-current-node
2957 (error "No current info node"))
2958 (let ((node (concat "(" (file-name-nondirectory
2959 (or (and (stringp Info-current-file)
2960 Info-current-file)
2961 buffer-file-name
2962 ""))
2963 ")" Info-current-node)))
2964 (if (zerop (prefix-numeric-value arg))
2966 (kill-new node)
2967 (message "%s" node)))
2969 \f
2970 ;; Info mode is suitable only for specially formatted data.
2971 (put 'Info-mode 'mode-class 'special)
2972 (put 'Info-mode 'no-clone-indirect t)
2974 (defun Info-mode ()
2975 "Info mode provides commands for browsing through the Info documentation tree.
2977 one topic and contains references to other nodes which discuss related
2978 topics. Info has commands to follow the references and show you other nodes.
2984 Selecting other nodes:
2986 Follow a node reference you click on.
2987 This works with menu items, cross references, and
2989 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
2994 Picking a menu item causes another node to be selected.
3005 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3008 Moving within a node:
3010 Once you scroll far enough in a node that its menu appears on the
3011 screen but after point, the next scroll moves into its first
3012 subnode. When after all menu items (or if there is no menu),
3013 move up to the parent node.
3015 already visible, try to go to the previous menu entry, or up
3016 if there is none.
3019 Advanced commands:
3023 1 .. 9 Pick first ... ninth item in node's menu.
3024 Every third `*' is highlighted to help pick the right number.
3026 You may include a filename as well, as (FILENAME)NODENAME.
3030 and select the node in which the next occurrence is found.
3031 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3036 (kill-all-local-variables)
3037 (setq major-mode 'Info-mode)
3038 (setq mode-name "Info")
3039 (setq tab-width 8)
3040 (use-local-map Info-mode-map)
3041 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3042 (set-syntax-table text-mode-syntax-table)
3043 (setq local-abbrev-table text-mode-abbrev-table)
3044 (setq case-fold-search t)
3045 (setq buffer-read-only t)
3046 (make-local-variable 'Info-current-file)
3047 (make-local-variable 'Info-current-subfile)
3048 (make-local-variable 'Info-current-node)
3049 (make-local-variable 'Info-tag-table-marker)
3050 (setq Info-tag-table-marker (make-marker))
3051 (make-local-variable 'Info-tag-table-buffer)
3052 (setq Info-tag-table-buffer nil)
3053 (make-local-variable 'Info-history)
3054 (make-local-variable 'Info-index-alternatives)
3055 (setq header-line-format
3056 (if Info-use-header-line
3057 '(:eval (get-text-property (point-min) 'header-line))
3058 nil)) ; so the header line isn't displayed
3059 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3060 ;; This is for the sake of the invisible text we use handling titles.
3061 (make-local-variable 'line-move-ignore-invisible)
3062 (setq line-move-ignore-invisible t)
3063 (make-local-variable 'desktop-save-buffer)
3064 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3065 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
3066 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3067 (Info-set-mode-line)
3068 (run-hooks 'Info-mode-hook))
3070 (defun Info-clone-buffer-hook ()
3071 (when (bufferp Info-tag-table-buffer)
3072 (setq Info-tag-table-buffer
3073 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3074 (let ((m Info-tag-table-marker))
3075 (when (markerp m)
3076 (setq Info-tag-table-marker
3077 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3078 (with-current-buffer Info-tag-table-buffer
3079 (copy-marker (marker-position m)))
3080 (make-marker))))))
3082 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3083 (set-keymap-parent map text-mode-map)
3084 (define-key map "\C-c\C-c" 'Info-cease-edit)
3085 map)
3086 "Local keymap used within `e' command of Info.")
3088 ;; Info-edit mode is suitable only for specially formatted data.
3089 (put 'Info-edit-mode 'mode-class 'special)
3091 (defun Info-edit-mode ()
3092 "Major mode for editing the contents of an Info node.
3093 Like text mode with the addition of `Info-cease-edit'
3094 which returns to Info mode for browsing.
3096 (use-local-map Info-edit-map)
3097 (setq major-mode 'Info-edit-mode)
3098 (setq mode-name "Info Edit")
3099 (kill-local-variable 'mode-line-buffer-identification)
3100 (setq buffer-read-only nil)
3101 (force-mode-line-update)
3102 (buffer-enable-undo (current-buffer))
3103 (run-hooks 'Info-edit-mode-hook))
3105 (defun Info-edit ()
3106 "Edit the contents of this Info node.
3107 Allowed only if variable `Info-enable-edit' is non-nil."
3108 (interactive)
3109 (or Info-enable-edit
3110 (error "Editing info nodes is not enabled"))
3111 (Info-edit-mode)
3112 (message "%s" (substitute-command-keys
3115 (defun Info-cease-edit ()
3116 "Finish editing Info node; switch back to Info proper."
3117 (interactive)
3118 ;; Do this first, so nothing has changed if user C-g's at query.
3119 (and (buffer-modified-p)
3120 (y-or-n-p "Save the file? ")
3121 (save-buffer))
3122 (use-local-map Info-mode-map)
3123 (setq major-mode 'Info-mode)
3124 (setq mode-name "Info")
3125 (Info-set-mode-line)
3126 (setq buffer-read-only t)
3127 (force-mode-line-update)
3128 (and (marker-position Info-tag-table-marker)
3129 (buffer-modified-p)
3130 (message "Tags may have changed. Use Info-tagify if necessary")))
3131 \f
3132 (defvar Info-file-list-for-emacs
3133 '("ediff" "eudc" "forms" "gnus" "info" ("mh" . "mh-e")
3134 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3135 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3136 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3137 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3138 ("copyright" . "autotype") ("executable" . "autotype")
3139 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3140 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3141 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3142 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3143 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3144 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3145 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3146 ("rfc2045" . "emacs-mime")
3147 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3148 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3149 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3150 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3151 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3152 ("mml" . "emacs-mime"))
3153 "List of Info files that describe Emacs commands.
3154 An element can be a file name, or a list of the form (PREFIX . FILE)
3155 where PREFIX is a name prefix and FILE is the file to look in.
3156 If the element is just a file name, the file name also serves as the prefix.")
3158 (defun Info-find-emacs-command-nodes (command)
3159 "Return a list of locations documenting COMMAND.
3160 The `info-file' property of COMMAND says which Info manual to search.
3161 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3162 defines heuristics for which Info manual to try.
3163 The locations are of the format used in `Info-history', i.e.
3164 \(FILENAME NODENAME BUFFERPOS\)."
3165 (let ((where '())
3168 (info-file "emacs")) ;default
3169 ;; Determine which info file this command is documented in.
3170 (if (get command 'info-file)
3171 (setq info-file (get command 'info-file))
3172 ;; If it doesn't say explicitly, test its name against
3173 ;; various prefixes that we know.
3174 (let ((file-list Info-file-list-for-emacs))
3175 (while file-list
3176 (let* ((elt (car file-list))
3177 (name (if (consp elt)
3178 (car elt)
3179 elt))
3180 (file (if (consp elt) (cdr elt) elt))
3183 (if (string-match regexp (symbol-name command))
3184 (setq info-file file file-list nil))
3185 (setq file-list (cdr file-list))))))
3186 (Info-find-node info-file "Top")
3189 (error "Info file `%s' appears to lack an index" info-file))
3190 (goto-char (match-beginning 1))
3191 ;; Bind Info-history to nil, to prevent the index nodes from
3192 ;; getting into the node history.
3193 (let ((Info-history nil)
3194 (Info-history-list nil)
3195 node (nodes (Info-index-nodes)))
3196 (Info-goto-node (car nodes))
3197 (while
3198 (progn
3199 (goto-char (point-min))
3200 (while (re-search-forward cmd-desc nil t)
3201 (setq where
3202 (cons (list Info-current-file
3203 (match-string-no-properties 2)
3204 0)
3205 where)))
3206 (and (setq nodes (cdr nodes) node (car nodes))))
3207 (Info-goto-node node)))
3208 where))
3210 ;;;###autoload
3211 (defun Info-goto-emacs-command-node (command)
3212 "Go to the Info node in the Emacs manual for command COMMAND.
3213 The command is found by looking up in Emacs manual's indices
3214 or in another manual found via COMMAND's `info-file' property or
3215 the variable `Info-file-list-for-emacs'.
3216 COMMAND must be a symbol or string."
3217 (interactive "CFind documentation for command: ")
3218 ;; If command is given as a string, convert it to a symbol.
3219 (if (stringp command)
3220 (setq command (intern command)))
3221 (or (commandp command)
3222 (signal 'wrong-type-argument (list 'commandp command)))
3223 (let ((where (Info-find-emacs-command-nodes command)))
3224 (if where
3225 (let ((num-matches (length where)))
3226 ;; Get Info running, and pop to it in another window.
3227 (save-window-excursion
3228 (info))
3229 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3230 ;; Bind Info-history to nil, to prevent the last Index node
3231 ;; visited by Info-find-emacs-command-nodes from being
3232 ;; pushed onto the history.
3233 (let ((Info-history nil) (Info-history-list nil))
3234 (Info-find-node (car (car where))
3235 (car (cdr (car where)))))
3236 (if (> num-matches 1)
3237 (progn
3238 ;; (car where) will be pushed onto Info-history
3239 ;; when/if they go to another node. Put the other
3240 ;; nodes that were found on the history.
3241 (setq Info-history (nconc (cdr where) Info-history))
3242 (message "Found %d other entr%s. Use %s to see %s."
3243 (1- num-matches)
3244 (if (> num-matches 2) "ies" "y")
3246 (if (> num-matches 2) "them" "it")))))
3247 (error "Couldn't find documentation for %s" command))))
3249 ;;;###autoload
3250 (defun Info-goto-emacs-key-command-node (key)
3251 "Go to the node in the Emacs manual which describes the command bound to KEY.
3252 KEY is a string.
3253 Interactively, if the binding is `execute-extended-command', a command is read.
3254 The command is found by looking up in Emacs manual's indices
3255 or in another manual found via COMMAND's `info-file' property or
3256 the variable `Info-file-list-for-emacs'."
3257 (interactive "kFind documentation for key: ")
3258 (let ((command (key-binding key)))
3259 (cond ((null command)
3260 (message "%s is undefined" (key-description key)))
3261 ((and (interactive-p)
3262 (eq command 'execute-extended-command))
3263 (Info-goto-emacs-command-node
3264 (read-command "Find documentation for command: ")))
3265 (t
3266 (Info-goto-emacs-command-node command)))))
3267 \f
3268 (defface Info-title-1-face
3269 '((((type tty pc) (class color)) :foreground "yellow" :weight bold)
3270 (t :height 1.2 :inherit Info-title-2-face))
3271 "Face for Info titles at level 1."
3272 :group 'info)
3274 (defface Info-title-2-face
3275 '((((type tty pc) (class color)) :foreground "lightblue" :weight bold)
3276 (t :height 1.2 :inherit Info-title-3-face))
3277 "Face for Info titles at level 2."
3278 :group 'info)
3280 (defface Info-title-3-face
3281 '((((type tty pc) (class color)) :weight bold)
3282 (t :height 1.2 :inherit Info-title-4-face))
3283 "Face for Info titles at level 3."
3284 :group 'info)
3286 (defface Info-title-4-face
3287 '((((type tty pc) (class color)) :weight bold)
3288 (t :weight bold :inherit variable-pitch))
3289 "Face for Info titles at level 4."
3290 :group 'info)
3292 (defface info-menu-header
3293 '((((type tty pc))
3294 :underline t
3295 :weight bold)
3296 (t
3297 :inherit variable-pitch
3298 :weight bold))
3299 "Face for headers in Info menus."
3300 :group 'info)
3302 (defun Info-escape-percent (string)
3303 "Double all occurrences of `%' in STRING.
3305 Return a new string with all `%' characters replaced by `%%'.
3306 Preserve text properties."
3307 (let ((start 0)
3308 (end (length string))
3309 mb me m matches)
3310 (save-match-data
3311 (while (and (< start end) (string-match "%" string start))
3312 (setq mb (match-beginning 0)
3313 me (1+ mb)
3314 m (substring string mb me)
3315 matches (cons m
3316 (cons m
3317 (cons (substring string start mb)
3318 matches)))
3319 start me))
3320 (push (substring string start end) matches)
3321 (apply #'concat (nreverse matches)))))
3323 (defvar Info-next-link-keymap
3324 (let ((keymap (make-sparse-keymap)))
3325 (define-key keymap [header-line mouse-1] 'Info-next)
3326 (define-key keymap [header-line mouse-2] 'Info-next)
3327 (define-key keymap [header-line down-mouse-1] 'ignore)
3328 (define-key keymap [mouse-2] 'Info-next)
3329 keymap)
3330 "Keymap to put on the Next link in the text or the header line.")
3332 (defvar Info-prev-link-keymap
3333 (let ((keymap (make-sparse-keymap)))
3334 (define-key keymap [header-line mouse-1] 'Info-prev)
3335 (define-key keymap [header-line mouse-2] 'Info-prev)
3336 (define-key keymap [header-line down-mouse-1] 'ignore)
3337 (define-key keymap [mouse-2] 'Info-prev)
3338 keymap)
3339 "Keymap to put on the Prev link in the text or the header line.")
3342 (defvar Info-up-link-keymap
3343 (let ((keymap (make-sparse-keymap)))
3344 (define-key keymap [header-line mouse-1] 'Info-up)
3345 (define-key keymap [header-line mouse-2] 'Info-up)
3346 (define-key keymap [header-line down-mouse-1] 'ignore)
3347 (define-key keymap [mouse-2] 'Info-up)
3348 keymap)
3349 "Keymap to put on the Up link in the text or the header line.")
3351 (defun Info-fontify-node ()
3352 "Fontify the node."
3353 (save-excursion
3354 (let* ((inhibit-read-only t)
3355 (case-fold-search t)
3356 paragraph-markers
3357 (not-fontified-p ; the node hasn't already been fontified
3358 (not (let ((where (next-property-change (point-min))))
3359 (and where (not (= where (point-max)))))))
3360 (fontify-visited-p ; visited nodes need to be re-fontified
3361 (and Info-fontify-visited-nodes
3362 ;; Don't take time to refontify visited nodes in huge nodes
3363 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size))))
3365 ;; Fontify header line
3366 (goto-char (point-min))
3368 (goto-char (match-end 0))
3370 (goto-char (match-end 0))
3371 (let* ((nbeg (match-beginning 2))
3372 (nend (match-end 2))
3373 (tbeg (match-beginning 1))
3374 (tag (match-string 1)))
3375 (if (string-equal tag "Node")
3376 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3377 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3378 (put-text-property tbeg nend 'mouse-face 'highlight)
3379 (put-text-property tbeg nend
3380 'help-echo
3381 (concat "Go to node "
3382 (buffer-substring nbeg nend)))
3383 ;; Always set up the text property keymap.
3384 ;; It will either be used in the buffer
3385 ;; or copied in the header line.
3386 (put-text-property tbeg nend 'keymap
3387 (cond
3388 ((equal tag "Prev") Info-prev-link-keymap)
3389 ((equal tag "Next") Info-next-link-keymap)
3390 ((equal tag "Up") Info-up-link-keymap))))))
3391 (when Info-use-header-line
3392 (goto-char (point-min))
3393 (let ((header-end (line-end-position))
3394 header)
3395 ;; If we find neither Next: nor Prev: link, show the entire
3396 ;; node header. Otherwise, don't show the File: and Node:
3397 ;; parts, to avoid wasting precious space on information that
3398 ;; is available in the mode line.
3399 (if (re-search-forward
3401 header-end t)
3402 (progn
3403 (goto-char (match-beginning 1))
3404 (setq header (buffer-substring (point) header-end)))
3406 (setq header
3407 (concat "No next, prev or up links -- "
3408 (buffer-substring (point) header-end)))
3409 (setq header (buffer-substring (point) header-end))))
3410 (put-text-property (point-min) (1+ (point-min))
3411 'header-line (Info-escape-percent header))
3412 ;; Hide the part of the first line
3413 ;; that is in the header, if it is just part.
3414 (unless (bobp)
3415 ;; Hide the punctuation at the end, too.
3417 (put-text-property (point) header-end 'invisible t)))))
3419 ;; Fontify titles
3420 (goto-char (point-min))
3421 (when not-fontified-p
3423 nil t)
3424 (let* ((c (preceding-char))
3425 (face
3426 (cond ((= c ?*) 'Info-title-1-face)
3427 ((= c ?=) 'Info-title-2-face)
3428 ((= c ?-) 'Info-title-3-face)
3429 (t 'Info-title-4-face))))
3430 (put-text-property (match-beginning 1) (match-end 1)
3431 'font-lock-face face))
3432 ;; This is a serious problem for trying to handle multiple
3433 ;; frame types at once. We want this text to be invisible
3434 ;; on frames that can display the font above.
3435 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3436 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3437 '(invisible t front-sticky nil rear-nonsticky t)))))
3439 ;; Fontify cross references
3440 (goto-char (point-min))
3441 (when (or not-fontified-p fontify-visited-p)
3442 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3443 (let ((start (match-beginning 0))
3444 (next (point))
3445 other-tag)
3446 (when not-fontified-p
3447 (when Info-hide-note-references
3448 ;; *Note is often used where *note should have been
3449 (goto-char start)
3450 (skip-syntax-backward " ")
3451 (setq other-tag
3452 (cond ((memq (char-before) '(nil ?\. ?! ??))
3453 "See ")
3454 ((memq (char-before) '(?\, ?\; ?\: ?-))
3455 "see ")
3456 ((memq (char-before) '(?\( ?\[ ?\{))
3457 ;; Check whether the paren is preceded by
3458 ;; an end of sentence
3459 (skip-syntax-backward " (")
3460 (if (memq (char-before) '(nil ?\. ?! ??))
3461 "See "
3462 "see "))
3464 "See ")))
3465 (goto-char next)
3466 (add-text-properties
3467 (match-beginning 1)
3468 (or (save-match-data
3470 (let ((start1 (match-beginning 1)))
3472 (+ start1 (match-beginning 0)))))
3473 (match-end 1))
3474 (if (and other-tag (not (eq Info-hide-note-references 'hide)))
3475 `(display ,other-tag front-sticky nil rear-nonsticky t)
3476 '(invisible t front-sticky nil rear-nonsticky t))))
3477 (add-text-properties
3478 (match-beginning 2) (match-end 2)
3479 (list
3480 'help-echo (if (or (match-end 5)
3481 (not (equal (match-string 4) "")))
3482 (concat "mouse-2: go to " (or (match-string 5)
3483 (match-string 4)))
3484 "mouse-2: go to this node")
3485 'mouse-face 'highlight)))
3486 (when (or not-fontified-p fontify-visited-p)
3487 (add-text-properties
3488 (match-beginning 2) (match-end 2)
3489 (list
3490 'font-lock-face
3491 ;; Display visited nodes in a different face
3492 (if (and Info-fontify-visited-nodes
3493 (save-match-data
3494 (let* ((node (replace-regexp-in-string
3496 (replace-regexp-in-string
3498 (or (match-string 5)
3499 (and (not (equal (match-string 4) ""))
3500 (match-string 4))
3501 (match-string 2)))))
3502 (file (file-name-nondirectory
3503 Info-current-file))
3504 (hl Info-history-list)
3505 res)
3507 (setq file (file-name-nondirectory
3508 (match-string 1 node))
3509 node (if (equal (match-string 2 node) "")
3510 "Top"
3511 (match-string 2 node))))
3512 (while hl
3513 (if (and (string-equal node (nth 1 (car hl)))
3514 (string-equal file
3515 (file-name-nondirectory
3516 (nth 0 (car hl)))))
3517 (setq res (car hl) hl nil)
3518 (setq hl (cdr hl))))
3519 res))) 'info-xref-visited 'info-xref))))
3520 (when not-fontified-p
3521 (when (memq Info-hide-note-references '(t hide))
3522 (add-text-properties (match-beginning 3) (match-end 3)
3523 '(invisible t front-sticky nil rear-nonsticky t))
3524 ;; Unhide the file name of the external reference in parens
3525 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3526 (remove-text-properties (match-beginning 6) (match-end 6)
3527 '(invisible t front-sticky nil rear-nonsticky t)))
3528 ;; Unhide newline because hidden newlines cause too long lines
3529 (save-match-data
3530 (let ((beg3 (match-beginning 3))
3531 (end3 (match-end 3)))
3533 (not (save-match-data
3534 (save-excursion
3535 (goto-char (1+ end3))
3536 (looking-at "[.)]*$")))))
3537 (remove-text-properties (+ beg3 (match-beginning 0))
3538 (+ beg3 (match-end 0))
3539 '(invisible t front-sticky nil rear-nonsticky t))))))
3540 (when (and Info-refill-paragraphs Info-hide-note-references)
3541 (push (set-marker (make-marker) start)
3542 paragraph-markers))))))
3544 ;; Refill paragraphs (experimental feature)
3545 (when (and not-fontified-p
3546 Info-refill-paragraphs
3547 paragraph-markers)
3548 (let ((fill-nobreak-invisible t)
3549 (fill-individual-varying-indent nil)
3552 (adaptive-fill-mode nil))
3553 (goto-char (point-max))
3554 (while paragraph-markers
3555 (let ((m (car paragraph-markers)))
3556 (setq paragraph-markers (cdr paragraph-markers))
3557 (when (< m (point))
3558 (goto-char m)
3559 (beginning-of-line)
3560 (let ((beg (point)))
3561 (when (zerop (forward-paragraph))
3562 (fill-individual-paragraphs beg (point) nil nil)
3563 (goto-char beg))))
3564 (set-marker m nil)))))
3566 ;; Fontify menu items
3567 (goto-char (point-min))
3568 (when (and (or not-fontified-p fontify-visited-p)
3570 (not (Info-index-node))
3571 ;; Don't take time to annotate huge menus
3572 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3573 (let ((n 0)
3574 cont)
3575 (while (re-search-forward
3578 nil t)
3579 (when not-fontified-p
3580 (setq n (1+ n))
3581 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3582 (put-text-property (match-beginning 0)
3583 (1+ (match-beginning 0))
3584 'font-lock-face 'info-menu-5)))
3585 (when not-fontified-p
3586 (add-text-properties
3587 (match-beginning 1) (match-end 1)
3588 (list
3589 'help-echo (if (match-end 3)
3590 (concat "mouse-2: go to " (match-string 3))
3591 "mouse-2: go to this node")
3592 'mouse-face 'highlight)))
3593 (when (or not-fontified-p fontify-visited-p)
3594 (add-text-properties
3595 (match-beginning 1) (match-end 1)
3596 (list
3597 'font-lock-face
3598 ;; Display visited menu items in a different face
3599 (if (and Info-fontify-visited-nodes
3600 (save-match-data
3601 (let ((node (if (equal (match-string 3) "")
3602 (match-string 1)
3603 (match-string 3)))
3604 (file (file-name-nondirectory Info-current-file))
3605 (hl Info-history-list)
3606 res)
3608 (setq file (file-name-nondirectory
3609 (match-string 1 node))
3610 node (if (equal (match-string 2 node) "")
3611 "Top"
3612 (match-string 2 node))))
3613 (while hl
3614 (if (and (string-equal node (nth 1 (car hl)))
3615 (string-equal file
3616 (file-name-nondirectory
3617 (nth 0 (car hl)))))
3618 (setq res (car hl) hl nil)
3619 (setq hl (cdr hl))))
3620 res))) 'info-xref-visited 'info-xref))))
3621 (when (and not-fontified-p (memq Info-hide-note-references '(t hide)))
3622 (put-text-property (match-beginning 2) (1- (match-end 6))
3623 'invisible t)
3624 ;; Unhide the file name in parens
3625 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
3626 (remove-text-properties (match-beginning 4) (match-end 4)
3627 '(invisible t)))
3628 ;; We need a stretchable space like :align-to but with
3629 ;; a minimum value.
3630 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3631 (if (>= 22 (- (match-end 1)
3632 (match-beginning 0)))
3633 '(space :align-to 24)
3634 '(space :width 2)))
3635 (setq cont (looking-at "."))
3636 (while (and (= (forward-line 1) 0)
3638 (put-text-property (match-beginning 1) (1- (match-end 1))
3639 'invisible t)
3640 (put-text-property (1- (match-end 1)) (match-end 1)
3641 'display
3642 (if cont
3643 '(space :align-to 26)
3644 '(space :align-to 24)))
3645 (setq cont t))))))
3647 ;; Fontify menu headers
3648 ;; Add the face `info-menu-header' to any header before a menu entry
3649 (goto-char (point-min))
3651 (put-text-property (match-beginning 0) (match-end 0)
3652 'font-lock-face 'info-menu-header)
3654 (put-text-property (match-beginning 1) (match-end 1)
3655 'font-lock-face 'info-menu-header)))
3657 ;; Hide index line numbers
3658 (goto-char (point-min))
3659 (when (and not-fontified-p (Info-index-node))
3661 (put-text-property (match-beginning 0) (match-end 0)
3662 'invisible t)))
3664 ;; Fontify http and ftp references
3665 (goto-char (point-min))
3666 (when not-fontified-p
3668 (add-text-properties (match-beginning 0) (match-end 0)
3669 '(font-lock-face info-xref
3670 mouse-face highlight
3671 help-echo "mouse-2: go to this URL"))))
3673 (set-buffer-modified-p nil))))
3674 \f
3676 ;; When an Info buffer is killed, make sure the associated tags buffer
3677 ;; is killed too.
3678 (defun Info-kill-buffer ()
3679 (and (eq major-mode 'Info-mode)
3680 Info-tag-table-buffer
3681 (kill-buffer Info-tag-table-buffer)))
3683 (add-hook 'kill-buffer-hook 'Info-kill-buffer)
3685 ;;; Speedbar support:
3686 ;; These functions permit speedbar to display the "tags" in the
3687 ;; current info node.
3688 (eval-when-compile (require 'speedbar))
3690 (defvar Info-speedbar-key-map nil
3691 "Keymap used when in the info display mode.")
3693 (defun Info-install-speedbar-variables ()
3694 "Install those variables used by speedbar to enhance Info."
3695 (if Info-speedbar-key-map
3696 nil
3697 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
3699 ;; Basic tree features
3700 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
3701 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
3702 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
3703 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
3704 )
3706 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
3707 Info-speedbar-key-map
3708 Info-speedbar-hierarchy-buttons)))
3710 (defvar Info-speedbar-menu-items
3711 '(["Browse Node" speedbar-edit-line t]
3712 ["Expand Node" speedbar-expand-line
3713 (save-excursion (beginning-of-line)
3715 ["Contract Node" speedbar-contract-line
3716 (save-excursion (beginning-of-line)
3717 (looking-at "[0-9]+: *.-. "))]
3718 )
3719 "Additional menu-items to add to speedbar frame.")
3721 ;; Make sure our special speedbar major mode is loaded
3722 (if (featurep 'speedbar)
3723 (Info-install-speedbar-variables)
3724 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
3726 ;;; Info hierarchy display method
3727 ;;;###autoload
3728 (defun Info-speedbar-browser ()
3729 "Initialize speedbar to display an info node browser.
3730 This will add a speedbar major display mode."
3731 (interactive)
3732 (require 'speedbar)
3733 ;; Make sure that speedbar is active
3734 (speedbar-frame-mode 1)
3735 ;; Now, throw us into Info mode on speedbar.
3736 (speedbar-change-initial-expansion-list "Info")
3737 )
3739 (eval-when-compile (defvar speedbar-attached-frame))
3741 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
3742 "Display an Info directory hierarchy in speedbar.
3743 DIRECTORY is the current directory in the attached frame.
3744 DEPTH is the current indentation depth.
3745 NODE is an optional argument that is used to represent the
3746 specific node to expand."
3747 (if (and (not node)
3748 (save-excursion (goto-char (point-min))
3749 (let ((case-fold-search t))
3750 (looking-at "Info Nodes:"))))
3751 ;; Update our "current node" maybe?
3752 nil
3753 ;; We cannot use the generic list code, that depends on all leaves
3754 ;; being known at creation time.
3755 (if (not node)
3757 (let ((completions nil)
3758 (cf (selected-frame)))
3759 (select-frame speedbar-attached-frame)
3760 (save-window-excursion
3761 (setq completions
3762 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
3763 (select-frame cf)
3764 (if completions
3765 (speedbar-with-writable
3766 (dolist (completion completions)
3767 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
3768 (cdr completion)
3769 (car completion)
3770 'Info-speedbar-goto-node
3771 (cdr completion)
3772 'info-xref depth))
3773 t)
3774 nil))))
3776 (defun Info-speedbar-goto-node (text node indent)
3777 "When user clicks on TEXT, go to an info NODE.
3778 The INDENT level is ignored."
3779 (select-frame speedbar-attached-frame)
3780 (let* ((buff (or (get-buffer "*info*")
3781 (progn (info) (get-buffer "*info*"))))
3782 (bwin (get-buffer-window buff 0)))
3783 (if bwin
3784 (progn
3785 (select-window bwin)
3786 (raise-frame (window-frame bwin)))
3787 (if speedbar-power-click
3788 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
3789 (select-frame speedbar-attached-frame)
3790 (switch-to-buffer buff)))
3792 (error "Invalid node %s" node)
3793 (Info-find-node (match-string 1 node) (match-string 2 node))
3794 ;; If we do a find-node, and we were in info mode, restore
3795 ;; the old default method. Once we are in info mode, it makes
3796 ;; sense to return to whatever method the user was using before.
3797 (if (string= speedbar-initial-expansion-list-name "Info")
3798 (speedbar-change-initial-expansion-list
3799 speedbar-previously-used-expansion-list-name)))))
3801 (defun Info-speedbar-expand-node (text token indent)
3802 "Expand the node the user clicked on.
3803 TEXT is the text of the button we clicked on, a + or - item.
3804 TOKEN is data related to this node (NAME . FILE).
3805 INDENT is the current indentation depth."
3806 (cond ((string-match "+" text) ;we have to expand this file
3807 (speedbar-change-expand-button-char ?-)
3808 (if (speedbar-with-writable
3809 (save-excursion
3810 (end-of-line) (forward-char 1)
3811 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
3812 (speedbar-change-expand-button-char ?-)
3813 (speedbar-change-expand-button-char ??)))
3814 ((string-match "-" text) ;we have to contract this node
3815 (speedbar-change-expand-button-char ?+)
3816 (speedbar-delete-subblock indent))
3817 (t (error "Ooops... not sure what to do")))
3818 (speedbar-center-buffer-smartly))
3820 (defun Info-speedbar-fetch-file-nodes (nodespec)
3821 "Fetch the subnodes from the info NODESPEC.
3822 NODESPEC is a string of the form: (file)node.
3823 Optional THISFILE represends the filename of"
3824 (save-excursion
3825 ;; Set up a buffer we can use to fake-out Info.
3826 (set-buffer (get-buffer-create "*info-browse-tmp*"))
3827 (if (not (equal major-mode 'Info-mode))
3828 (Info-mode))
3829 ;; Get the node into this buffer
3831 (error "Invalid node specification %s" nodespec)
3832 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
3833 ;; Scan the created buffer
3834 (goto-char (point-min))
3835 (let ((completions nil)
3836 (case-fold-search t)
3838 (match-string 1 nodespec))))
3839 ;; Always skip the first one...
3842 (let ((name (match-string 1)))
3843 (push (cons name
3845 (match-string 1)
3847 (concat (match-string 1) "Top")
3848 (concat "(" thisfile ")"
3850 (match-string 1)
3851 name)))))
3852 completions)))
3853 (nreverse completions))))
3855 ;;; Info mode node listing
3856 ;; FIXME: Seems not to be used. -stef
3857 (defun Info-speedbar-buttons (buffer)
3858 "Create a speedbar display to help navigation in an Info file.
3859 BUFFER is the buffer speedbar is requesting buttons for."
3860 (if (save-excursion (goto-char (point-min))
3861 (let ((case-fold-search t))
3862 (not (looking-at "Info Nodes:"))))
3863 (erase-buffer))
3864 (Info-speedbar-hierarchy-buttons nil 0)
3865 )
3867 (dolist (mess '("^Node has no Previous$"
3868 "^No menu in this node$"
3869 "^Node has no Next$"
3870 "^No cross-references in this node^"
3871 search-failed
3873 (add-to-list 'debug-ignored-errors mess))
3875 ;;;; Desktop support
3877 (defun Info-desktop-buffer-misc-data (desktop-dirname)
3878 "Auxiliary information to be saved in desktop file."
3879 (if (not (member Info-current-file '("apropos" "history" "toc")))
3880 (list Info-current-file Info-current-node)))
3882 ;;;###autoload
3883 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
3884 desktop-buffer-name
3885 desktop-buffer-misc)
3886 "Restore an info buffer specified in a desktop file."
3887 (let ((first (nth 0 desktop-buffer-misc))
3888 (second (nth 1 desktop-buffer-misc)))
3889 (when (and first second)
3890 (when desktop-buffer-name
3891 (set-buffer (get-buffer-create desktop-buffer-name))
3892 (Info-mode))
3893 (Info-find-node first second)
3894 (current-buffer))))
3896 (provide 'info)
3898 ;;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
3899 ;;; info.el ends here