| blob | e3ca18e0edeb8a2b8781aff6a48e8280e3f683e7 |
1 ;;; info.el --- info package for Emacs
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005 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., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Note that nowadays we expect Info files to be made using makeinfo.
29 ;; In particular we make these assumptions:
30 ;; - a menu item MAY contain colons but not colon-space ": "
31 ;; - a menu item ending with ": " (but not ":: ") is an index entry
32 ;; - a node name MAY NOT contain a colon
33 ;; This distinction is to support indexing of computer programming
34 ;; language terms that may contain ":" but not ": ".
36 ;;; Code:
41 "Info subsystem."
47 "Stack of Info nodes user has visited.
51 "Stack of Info nodes user has visited with `Info-history-back' command.
55 "List of all Info nodes user has visited.
60 This is convenient if you want to write Info files by hand.
61 However, we recommend that you not do this.
62 It is better to write a Texinfo file and generate the Info file from that,
63 because that gives you a printed manual as well."
68 "Non-nil allows Info to execute Lisp code associated with nodes.
76 "Face for Info node names."
85 "Face for info titles at level 1."
87 ;; backward-compatibility alias
93 "Face for info titles at level 2."
95 ;; backward-compatibility alias
101 "Face for info titles at level 3."
103 ;; backward-compatibility alias
109 "Face for info titles at level 4."
111 ;; backward-compatibility alias
116 :underline t
119 :inherit variable-pitch
121 "Face for headers in Info menus."
127 "Face for every third `*' in an Info menu."
139 "Face for Info cross-references."
146 "Face for visited Info cross-references."
150 "*Non-nil to fontify references to visited nodes in `info-xref-visited' face."
156 "*Maximum size of menu to fontify if `font-lock-mode' is non-nil."
161 "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
162 A header-line does not scroll with the rest of the buffer."
168 "Face for Info cross-references in a node header."
173 "Face for Info nodes in a node header."
177 "List of directories to search for Info documentation files.
178 If nil, meaning not yet initialized, Info uses the environment
179 variable INFOPATH to initialize it, or `Info-default-directory-list'
180 if there is no INFOPATH variable in the environment, or the
181 concatenation of the two if INFOPATH ends with a colon.
183 When `Info-directory-list' is initialized from the value of
184 `Info-default-directory-list', and Emacs is installed in one of the
185 standard directories, the directory of Info files that come with Emacs
186 is put last (so that local Info files override standard ones).
188 When `Info-directory-list' is initialized from the value of
189 `Info-default-directory-list', and Emacs is not installed in one
190 of the standard directories, the first element of the resulting
191 list is the directory where Emacs installs the Info files that
192 come with it. This is so that Emacs's own manual, which suits the
193 version of Emacs you are using, will always be found first. This
194 is useful when you install an experimental version of Emacs without
195 removing the standard installation.
197 If you want to override the order of directories in
198 `Info-default-directory-list', set INFOPATH in the environment.
200 If you run the Emacs executable from the `src' directory in the Emacs
201 source tree, and INFOPATH is not defined, the `info' directory in the
202 source tree is used as the first element of `Info-directory-list', in
203 place of the installation Info directory. This is useful when you run
207 "List of additional directories to search for Info documentation files.
208 These directories are searched after those in `Info-directory-list'."
215 If this is non-nil, and you scroll far enough in a node that its menu
217 moves to a subnode indicated by the following menu item. This means
218 that you visit a subnode before getting to the end of the menu.
220 Setting this option to nil results in behavior similar to the stand-alone
221 Info reader program, which visits the first subnode from the menu only
222 when you hit the end of the current node."
228 "*If non-nil, hide the tag and section reference in *note and * menu items.
230 If value is non-nil but not t or `hide', the reference section is still shown.
231 `nil' completely disables this feature."
240 "*If non-nil, attempt to refill paragraphs with hidden references.
241 This refilling may accidentally remove explicit line breaks in the Info
242 file, so be prepared for a few surprises if you enable this feature."
248 "*If non-nil, regular expression to match a sequence of whitespace chars.
249 This applies to Info search for regular expressions.
251 In the Customization buffer, that is `[' followed by a space,
252 a tab, a carriage return (control-M), a newline, and `]+'."
257 "*If non-nil, isearch in Info searches through multiple nodes.
258 Before leaving the initial Info node, where isearch was started,
259 it fails once with the error message [initial node], and with
260 subsequent C-s/C-r continues through other nodes without failing
261 with this error message in other nodes. When isearch fails for
262 the rest of the manual, it wraps aroung the whole manual and
263 restarts the search from the top/final node depending on
264 search direction.
266 Setting this option to nil restores the default isearch behavior
267 with wrapping around the current Info node."
275 ;; Try to obey obsolete Info-fontify settings.
278 "Hooks run when `Info-mode' is called."
283 "Hooks run when `Info-select-node' is called."
291 "Info file that Info is now looking at, or nil.
292 This is the name that was specified in Info, not the actual file name.
296 "Info subfile that is actually in the *info* buffer now.
303 "Marker pointing at beginning of current Info file's tag table.
319 "Point location within a selected node.
320 If string, the point is moved to the proper occurrence of the
321 name of the followed cross reference within a selected node.
326 \f
328 ;; The MS-DOS list should work both when long file names are
329 ;; supported (Windows 9X), and when only 8+3 file names are available.
371 "List of file name suffixes and associated decoding commands.
372 Each entry should be (SUFFIX . STRING); the file is given to
373 the command as standard input.
375 STRING may be a list of strings. In that case, the first element is
376 the command name, and the rest are arguments to that command.
378 If STRING is nil, no decoding is done.
379 Because the SUFFIXes are tried in order, the empty string should
382 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
383 ;; First, on MS-DOS with no long file names support, delete some of
384 ;; the extension in FILENAME to make room.
389 ;; How long is the extension in FILENAME (not counting the dot).
391 ext-left)
392 ;; SUFFIX starts with a dot. If FILENAME already has one,
393 ;; get rid of the one in SUFFIX (unless suffix is empty).
398 ;; How many chars of that extension should we keep?
400 ;; Get rid of the rest of the extension, and add SUFFIX.
403 suffix))))
410 "Insert the contents of an Info file in the current buffer.
411 Do the right thing if the file has been compressed or zipped."
415 t))
417 lfn))
418 fullname decoder done)
420 ;; FILENAME exists--see if that name contains a suffix.
421 ;; If so, set DECODE accordingly.
426 filename)))
430 ;; Try adding suffixes to FILENAME and see if we can find something.
436 ;; If we found a file with a suffix, set DECODER
437 ;; according to the suffix.
439 ;; When the MS-DOS port runs on Windows, we need to check
440 ;; the short variant of a long file name as well.
450 ;; check for conflict with jka-compr
460 default-directory)))
466 \f
473 "../info/"
474 invocation-directory)))
476 infodir
478 "../../../info/"
479 invocation-directory))
481 infodir))))))
482 alternative)
485 ;; Uninstalled, Emacs builddir != srcdir.
486 sibling
487 ;; Uninstalled, builddir == srcdir
488 source))
490 ;; On DOS/NT, we use movable executables always,
491 ;; and we must always find the Info dir at run time.
493 nil
494 ;; Use invocation-directory for Info
495 ;; only if we used it for exec-directory also.
498 installation-directory))))
500 Info-default-directory-list
501 ;; `alternative' contains the Info files that came with this
502 ;; version, so we should look there first. `Info-insert-dir'
503 ;; currently expects to find `alternative' first on the list.
505 ;; Don't drop the last part, it might contain non-Emacs stuff.
506 ;; (reverse (cdr (reverse
510 "Initialize `Info-directory-list', if that hasn't been done yet."
523 ;;;###autoload
525 "Like `info' but show the Info buffer in another window."
531 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
533 ;;;###autoload (put 'info 'info-file "emacs")
534 ;;;###autoload
536 "Enter Info, the documentation browser.
537 Optional argument FILE-OR-NODE specifies the file to examine;
538 the default is the top-level directory of Info.
539 Called from a program, FILE-OR-NODE may specify an Info node of the form
540 `(FILENAME)NODENAME'.
541 Optional argument BUFFER specifies the Info buffer name;
542 the default buffer name is *info*. If BUFFER exists,
543 just switch to BUFFER. Otherwise, create a new buffer
544 with the top-level Info directory.
546 In interactive use, a non-numeric prefix argument directs
547 this command to read a file name from the minibuffer.
548 A numeric prefix argument selects an Info buffer with the prefix number
549 appended to the Info buffer name.
551 The search path for Info files is in the variable `Info-directory-list'.
552 The top-level Info directory is made by combining all the files named `dir'
553 in all the directories in that path."
563 ;; If argument already contains parentheses, don't add another set
564 ;; since the argument will then be parsed improperly. This also
565 ;; has the added benefit of allowing node names to be included
566 ;; following the parenthesized filename.
569 file-or-node
574 ;;;###autoload
576 "Display the Emacs manual in Info mode."
580 ;;;###autoload
582 "Run Emacs as a standalone Info reader.
583 Usage: emacs -f info-standalone [filename]
597 \f
598 ;; See if the accessible portion of the buffer begins with a node
599 ;; delimiter, and the node header line which follows matches REGEXP.
600 ;; Typically, this test will be followed by a loop that examines the
601 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
602 ;; to have the overhead of this special test inside the loop.
604 ;; This function changes match-data, but supposedly the caller might
605 ;; want to use the results of re-search-backward.
607 ;; The return value is the value of point at the beginning of matching
608 ;; REGEXP, if the function succeeds, nil otherwise.
620 Optional second argument NOERROR, if t, means if file is not found
621 just return nil (no error)."
622 ;; Convert filename to lower case if not found as specified.
623 ;; Expand it.
638 ;; If specified name starts with `./'
639 ;; then just try current directory.
642 ;; No point in searching for an
643 ;; absolute file name
647 Info-additional-directory-list)
648 Info-directory-list)))))
649 ;; Search the directory list for file FILENAME.
654 ;; Try several variants of specified name.
658 t)))
669 lfn
681 filename)))
684 "Go to an Info node specified as separate FILENAME and NODENAME.
685 NO-GOING-BACK is non-nil if recovering from an error in this function;
686 it says do not attempt further (recursive) error recovery."
689 ;; Go into Info buffer.
691 ;; Record the node we are leaving.
695 Info-history)))
698 ;;;###autoload
700 "Use Info mode to browse the current Info buffer.
701 With a prefix arg, this queries for the node name to visit first;
702 otherwise, that defaults to `Top'."
712 ;; If called on a non-file buffer, make a fake file name.
716 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
717 ;; but at least it keeps this routine (which is only for the benefit of
718 ;; makeinfo-buffer) out of the way of normal operations.
719 ;;
721 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
722 When *info* is already displaying FILENAME and NODENAME, the window position
723 is preserved, if possible."
738 ;; note goto-line is no good, we want to measure from point-min
745 ;; only add to the history when coming from a different file+node
750 "Find a node in a tag table.
751 MARKER specifies the buffer and position to start searching at.
752 REGEXP is a regular expression matching nodes or references. Its first
753 group should match `Node:' or `Ref:'.
754 CASE-FOLD t means search for a case-insensitive match.
755 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
756 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
757 where the match was found, and MODE is `major-mode' of the buffer in
758 which the match was found."
764 ;; Search tag table
769 major-mode)))))
772 "Find a node in a tag table.
773 MARKER specifies the buffer and position to start searching at.
774 REGEXP is a regular expression matching nodes or references. Its first
775 group should match `Node:' or `Ref:'.
776 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
777 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
778 where the match was found, and MODE is `major-mode' of the buffer in
779 which the match was found.
780 This function tries to find a case-sensitive match first, then a
781 case-insensitive match is tried."
785 result))
788 "Find a node or anchor in the current buffer.
789 REGEXP is a regular expression matching nodes or references. Its first
790 group should match `Node:' or `Ref:'.
791 CASE-FOLD t means search for a case-insensitive match.
792 Value is the position at which a match was found, or nil if not found."
794 found)
806 found)))
809 "Find a node or anchor in the current buffer.
810 REGEXP is a regular expression matching nodes or references. Its first
811 group should match `Node:' or `Ref:'.
812 Value is the position at which a match was found, or nil if not found.
813 This function looks for a case-sensitive match first. If none is found,
814 a case-insensitive match is tried."
826 anchorpos)
827 ;; Switch files if necessary
832 Info-current-subfile nil
833 Info-current-file-completions nil
834 buffer-file-name nil)
850 ;; Check makeinfo version for index cookie support
862 ;; See whether file has a tag table. Record the location if yes.
865 ;; Use string-equal, not equal, to ignore text props.
870 ;; We have a tag table. Find its beginning.
871 ;; Is this an indirect file?
877 ;; It is indirect. Copy it to another buffer
878 ;; and record that the tag table is in that buffer.
901 ))
902 ;; Use string-equal, not equal, to ignore text props.
906 ;; Possibilities:
907 ;;
908 ;; 1. Anchor found in tag table
909 ;; 2. Anchor *not* in tag table
910 ;;
911 ;; 3. Node found in tag table
912 ;; 4. Node *not* found in tag table, but found in file
913 ;; 5. Node *not* in tag table, and *not* in file
914 ;;
915 ;; *Or* the same, but in an indirect subfile.
917 ;; Search file for a suitable node.
927 ;; First, search a tag table, if any
933 ;; FOUND is (ANCHOR POS MODE).
936 ;; If this is an indirect file, determine which
937 ;; file really holds this node and read it in.
939 ;; Note that the current buffer must be the
940 ;; *info* buffer on entry to
941 ;; Info-read-subfile. Thus the hackery above.
944 ;; Handle anchor
949 ;; Else we may have a node, which we search for:
953 ;; Now search from our advised position (or from beg of
954 ;; buffer) to find the actual node. First, check
955 ;; whether the node is right where we are, in case the
956 ;; buffer begins with a node.
969 ;; No such anchor in tag table or node in tag table or file
977 ;; Add anchors to the history too
988 ;; If we did not finish finding the specified node,
989 ;; go back to the previous one.
996 ;; Cache the contents of the (virtual) dir file, once we have merged
997 ;; it for the first time, so we can save time subsequently.
1000 ;; Cache for the directory we decided to use for the default-directory
1001 ;; of the merged dir text.
1004 ;; Record the file attributes of all the files from which we
1005 ;; constructed Info-dir-contents.
1010 ;; Construct the Info directory node by merging the files named `dir'
1011 ;; from various directories. Set the *info* buffer's
1012 ;; default-directory to the first directory we actually get any text
1013 ;; from.
1016 ;; Verify that none of the files we used has changed
1017 ;; since we used it.
1021 ;; Handle symlinks
1024 ;; Don't compare the access time.
1028 Info-dir-file-attributes))))
1034 Info-additional-directory-list)
1035 Info-directory-list))
1037 ;; Bind this in case the user sets it to nil.
1039 ;; This is set non-nil if we find a problem in some input files.
1040 problems
1041 buffers buffer others nodes dirs-done)
1043 ;; Search the directory list for the directory file.
1048 ;; Try several variants of specified name.
1049 ;; Try upcasing, appending `.info', or both.
1064 dirs-done)))
1074 file)
1086 ;; Distinguish the dir file that comes with Emacs from all the
1087 ;; others. Yes, that is really what this is supposed to do.
1088 ;; The definition of `Info-directory-list' puts it first on that
1089 ;; list and so last in `buffers' at this point.
1093 ;; Insert the entire original dir file as a start; note that we've
1094 ;; already saved its default directory to use as the default
1095 ;; directory for the whole concatenation.
1098 ;; Look at each of the other buffers one by one.
1101 ;; In each, find all the menus.
1104 ;; Find each menu, and add an elt to NODES for it.
1108 nodename end)
1120 ;; Add to the main menu a menu item for each other node.
1132 end t)
1136 ;; Now take each node of each of the other buffers
1137 ;; and merge it into the main buffer.
1142 ;; Find the like-named node in the main buffer.
1146 nil t)
1151 ;; If none exists, add one.
1154 ;; Merge the text from the other buffer's menu
1155 ;; into the menu in the like-named node in the main buffer.
1158 ;; Kill all the buffers we just made, including the special one excised.
1178 ;; Remove duplicate headings in the same menu.
1181 ;; Look for the next heading to unify.
1186 ;; Check whether this heading should be streamlined.
1196 ;; Look for other headings of the same category and merge them.
1202 ;; Delete redundant heading.
1204 ;; Push the entries onto `text'.
1211 ;; Insert the entries just found.
1219 ;; Now remove duplicate entries under the same heading.
1225 ;; Fold case straight away; `member-ignore-case' here wasteful.
1233 ;; Note that on entry to this function the current-buffer must be the
1234 ;; *info* buffer; not the info tags buffer.
1236 ;; NODEPOS is either a position (in the Info file as a whole,
1237 ;; not relative to a subfile) or the name of a subfile.
1239 lastfilename)
1251 thisfilepos thisfilename)
1255 ;; read in version 19 stops at the end of number.
1256 ;; Advance to the next line.
1265 ;; Assume previous buffer is in Info-mode.
1266 ;; (set-buffer (get-buffer "*info*"))
1275 ;; Widen in case we are in the same subfile as before.
1285 "Unescape double quotes and backslashes in VALUE."
1291 unquote))
1293 ;; As of Texinfo 4.6, makeinfo writes constructs like
1294 ;; \0\h[image param=value ...\h\0]
1295 ;; into the Info file for handling images.
1298 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1299 whitespace or double quotes, it must be quoted in double quotes and
1304 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1305 parameter-string start)
1311 parameter-alist))
1312 parameter-alist))
1315 "Display images in current node."
1322 nil t)
1337 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1338 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1339 ;; including one optional trailing newline.
1341 "Hide unrecognized cookies in current node."
1348 nil t)
1355 "Select the Info node that point is in."
1356 ;; Bind this in case the user sets it to nil.
1359 ;; Find beginning of node.
1365 ;; Get nodename spelled as it is in the node.
1373 ;; Find the end of it, and narrow.
1376 ;; Narrow to the node contents
1388 ;; Add a new unique history item to full history list
1408 \f
1409 ;; Go to an Info node specified with a filename-and-nodename string
1410 ;; of the sort that is found in pointers in nodes.
1412 ;; Don't autoload this function: the correct entry point for other packages
1413 ;; to use is `info'. --Stef
1414 ;; ;;;###autoload
1416 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1417 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1418 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1419 its sub-files).
1420 Completion is available, but only for node names in the current Info file.
1421 If FORK is non-nil (interactively with a prefix arg), show the node in
1422 a new Info buffer.
1423 If FORK is a string, it is the name to use for the new buffer."
1431 nodename)
1433 ""
1447 "Virtual completion table for file names input in Info node names.
1448 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1464 ;; If the file name has no suffix or a standard suffix,
1465 ;; include it.
1468 ;; But exclude subfiles of split Info files.
1470 ;; And exclude backup files.
1473 ;; If the file name ends in a standard suffix,
1474 ;; add the unsuffixed name as a completion option.
1483 ;; This function is used as the "completion table" while reading a node name.
1484 ;; It does completion using the alist in Info-read-node-completion-table
1485 ;; unless STRING starts with an open-paren.
1488 ;; First complete embedded file names.
1504 ;; If a file name was given, then any node is fair game.
1510 ;; Otherwise use Info-read-node-completion-table.
1518 ;; Arrange to highlight the proper letters in the completion list buffer.
1524 1
1534 nodename)))
1539 ;; Bind this in case the user sets it to nil.
1552 compl))))
1555 ;; If the buffer begins with a node header, process that first.
1558 ;; Now for the rest of the nodes.
1566 compl))))))))
1569 \f
1571 "If this node has been visited, restore the point value when we left."
1574 ;; Use string-equal, not equal, to ignore text props.
1580 \f
1588 "Search for REGEXP, starting from point, and select node it's found in.
1589 If DIRECTION is `backward', search in the reverse direction."
1617 ;; Hide Info file header for backward search
1629 ;; Skip node header line
1633 ;; Skip Tag Table node
1652 ;; If no subfiles, give error now.
1666 ;; Try other subfiles.
1677 ;; Find the subfile we just searched.
1679 ;; Skip that one.
1682 ;; Make a list of all following subfiles.
1683 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1692 list))
1696 ;; Put in forward order
1702 ;; Hide Info file header for backward search
1717 ;; Skip node header line
1721 ;; Skip Tag Table node
1748 ;; Search landed in the same node
1754 ;; Use string-equal, not equal, to ignore text props.
1760 Info-history))))))
1763 "Search for a regexp case-sensitively."
1769 "Search for next regexp from a previous `Info-search' command."
1777 "Search for REGEXP in the reverse direction."
1796 nil t)
1798 bound noerror count
1801 bound noerror count
1828 \f
1830 "Extract the value of the node-pointer named NAME.
1831 If there is none, use ERRORNAME in the error message;
1832 if ERRORNAME is nil, just return nil."
1833 ;; Bind this in case the user sets it to nil.
1847 "Return a regexp matching a node name.
1848 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1849 saying which chars may appear in the node name.
1850 Submatch 1 is the complete node name.
1851 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1852 Submatch 3 is the local part of the node name.
1853 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1860 ;;; For compatibility; other files have used this name.
1866 "Go to the next node of this node."
1868 ;; In case another window is currently selected
1874 "Go to the previous node of this node."
1876 ;; In case another window is currently selected
1882 "Go to the superior node of this node.
1883 If SAME-FILE is non-nil, do not move to a different Info file."
1885 ;; In case another window is currently selected
1903 nil t))
1909 "Go back in the history to the last node visited."
1915 Info-history-forward))
1916 filename nodename opoint)
1929 "Go forward in the history of visited nodes."
1934 filename nodename opoint)
1942 ;;;###autoload
1944 "Go to the Info directory node."
1947 \f
1949 "Go to a node with a menu of visited nodes."
1953 p)
1977 "Go to a node with table of contents of the current Info file.
1978 Table of contents is created from the tree structure of menus."
1982 p)
2012 "Insert table of contents with references to nodes."
2024 "Build table of contents from menus of Info FILE and its subfiles."
2029 default-directory))
2032 nodes subfiles)
2044 menu-items)
2053 bound))
2056 ;; Menu item line
2066 ;; Other non-empty strings in the Top node are section names
2075 nodes))
2084 subfiles)))))
2086 main-file nil))
2090 \f
2092 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2093 FOOTNOTENAME may be an abbreviation of the reference name.
2094 If FORK is non-nil (interactively with a prefix arg), show the node in
2095 a new Info buffer. If FORK is a string, it is the name to use for the
2096 new buffer."
2102 ;; Store end and beginning of line.
2111 ;; See if this one should be the default.
2116 ;; See if this one should be the alternate default.
2126 ;; Record as a completion and perhaps as default.
2129 ;; Don't add this string if it's a duplicate.
2132 ;; If no good default was found, try an alternate.
2135 ;; If only one cross-reference found, then make it default.
2141 "Follow reference named (default "
2144 completions nil t)))
2158 ;; Move point to the beginning of reference if point is on reference
2168 ;; Go to the reference closest to point
2176 next-ref prev-ref))
2187 ;; We allow newline because this is also used in Info-follow-reference,
2188 ;; where the xref name might be wrapped over two lines.
2189 "Regexp that matches a menu entry name upto but not including the colon.
2190 Because of ambiguities, this should be concatenated with something like
2210 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2211 ;;; (setq Info-point-loc
2212 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2213 )
2217 ;; If the node name is the menu entry name (using `entry::').
2220 ;; No one calls this.
2221 ;;(defun Info-menu-item-sequence (list)
2222 ;; (while list
2223 ;; (Info-menu (car list))
2224 ;; (setq list (cdr list))))
2236 ;; This uses two dynamically bound variables:
2237 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2238 ;; is the menu of items we're trying to complete.
2239 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2240 ;; also look for menu items in subsequent nodes as long as those
2241 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2242 ;; not used.
2243 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2244 ;; also look for menu items in these nodes. This feature is currently
2245 ;; only used for completion in Info-index.
2247 ;; Note that `Info-complete-menu-buffer' could be current already,
2248 ;; so we want to save point.
2254 nextnode)
2263 completions
2265 ;; Check the cache.
2273 ;; We can reuse the previous list.
2275 ;; The cache can't be used.
2280 completions))
2281 ;; Check subsequent nodes if applicable.
2289 ;; Go back to the start node (for the next completion).
2292 ;; Update the cache.
2295 Info-complete-next-re string completions
2296 Info-complete-nodes)))
2303 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2304 The menu item should one of those listed in the current node's menu.
2305 Completion is allowed, and the default menu item is the one point is on.
2306 If FORK is non-nil (interactively with a prefix arg), show the node in
2307 a new Info buffer. If FORK is a string, it is the name to use for the
2308 new buffer."
2311 ;; If point is within a menu item, use that item as the default
2314 beg
2327 Info-menu-entry-name-re
2336 default)
2339 ;; we rely on the fact that completing-read accepts an input
2340 ;; of "" even when the require-match argument is true and ""
2341 ;; is not a valid possibility
2345 ;; ask again
2348 ;; there is a problem here in that if several menu items have the same
2349 ;; name you can only go to the node of the first with this command.
2367 ;; If COUNT is nil, use the last item in the menu.
2379 nil))
2383 "Go to the node of the Nth menu item.
2384 N is the digit argument used to invoke this command."
2391 "Go to the Top node of this file."
2396 "Go to the final node in this file."
2401 ;; Go to the last node in the menu of Top.
2403 ;; If the last node in the menu is not last in pointer structure,
2404 ;; move forward until we can't go any farther.
2406 ;; Then keep moving down to last subnode, unless we reach an index.
2412 "Go forward one node, considering all nodes as forming one sequence."
2417 ;; three possibilities, in order of priority:
2418 ;; 1. next node is in a menu in this node (but not in an index)
2419 ;; 2. next node is next at same level
2420 ;; 3. next node is up and next
2425 t)
2428 t)
2430 ;; Use string-equal, not equal, to ignore text props.
2443 "Go backward one node, considering all nodes as forming one sequence."
2451 ;; Use string-equal, not equal,
2452 ;; to ignore text properties.
2457 ;; If we move back at the same level,
2458 ;; go down to find the last subnode*.
2468 "Exit Info by selecting some other buffer."
2475 "Go to the node of the next menu item."
2477 ;; Bind this in case the user sets it to nil.
2489 "Go to the node of the previous menu item."
2493 ;; Bind this in case the user sets it to nil.
2508 "Go to the next subnode or the next node, or go up a level."
2513 ;; Since we have already gone thru all the items in this menu,
2514 ;; go up to the end of this node.
2516 ;; Since logically we are done with the node with that menu,
2517 ;; move on from it.
2523 "Go to the last node, popping up a level if there is none."
2527 ;; If we go down a menu item, go to the end of the node
2528 ;; so we can scroll back through it.
2530 ;; Keep going down, as long as there are nested menu nodes.
2533 ;; If we go down a menu item, go to the end of the node
2534 ;; so we can scroll back through it.
2544 ;; If we go down a menu item, go to the end of the node
2545 ;; so we can scroll back through it.
2556 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2557 Once you scroll far enough in a node that its menu appears on the screen
2558 but after point, the next scroll moves into its first subnode, unless
2559 `Info-scroll-prefer-subnodes' is nil.
2561 When you scroll past the end of a node, that goes to the next node if
2562 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2563 if this node has no successor, it moves to the parent node's successor,
2564 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2565 the menu of a node, it moves to subnode indicated by the following menu
2566 item. (That case won't normally result from this command, but can happen
2567 in other ways.)"
2589 "Scroll one screenful back in Info, considering all nodes as one sequence.
2590 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2591 is non-nil, this goes to its last subnode. When you scroll past the
2592 beginning of a node, that goes to the previous node or back up to the
2593 parent node."
2607 current-point
2608 t)))))
2615 "Move cursor to the next cross-reference or menu item in the node."
2637 "Move cursor to the previous cross-reference or menu item in the node."
2656 \f
2658 "Alist of cached index node names of visited Info files.
2662 "Return a list of names of all index nodes in Info FILE.
2663 If FILE is omitted, it defaults to the current Info file.
2664 First look in a list of cached index node names. Then scan Info
2665 file and its subfiles for nodes with the index cookie. Then try
2666 to find index nodes starting from the first node in the top level
2671 ;; Skip virtual Info files
2676 ;; Find nodes with index cookie
2680 default-directory))
2681 Info-history Info-history-list Info-fontify-maximum-menu-size
2701 subfiles)))))
2703 main-file nil))
2709 nodes)
2710 ;; Else find nodes with the word "Index" in the node name
2712 Info-history Info-history-list Info-fontify-maximum-menu-size
2713 nodes node)
2731 nodes))
2732 ;; If file has no index nodes, still add it to the cache
2737 "Return non-nil value if NODE is an index node.
2738 If NODE is nil, check the current Info node.
2739 If FILE is nil, check the current Info file."
2743 ;; Don't search all index nodes if request is only for the current node
2744 ;; and file is not in the cache of index nodes
2758 "Go to the first index node."
2763 ;;;###autoload
2765 "Look up a string TOPIC in the index for this file.
2766 If there are no exact matches to the specified topic, this chooses
2767 the first match which is a case-insensitive substring of a topic.
2769 Give a blank topic name to go to the Index node itself."
2785 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2794 ;; We bind Info-history to nil for internal node-switches so
2795 ;; that we don't put junk in the history. In the first
2796 ;; Info-goto-index call, above, we do update the history
2797 ;; because that is what the user's previous node choice into it.
2799 found)
2806 Info-current-node
2809 matches))
2816 ;; Here it is a feature that assoc is case-sensitive.
2851 "Move point to the place within the current node where NAME is defined."
2856 ;; Find a function definition with a return type.
2864 nil t))
2866 ;; Try again without the " <1>" makeinfo can append
2872 ;;;###autoload
2874 "Grovel indices of all known Info files on your system for STRING.
2875 Build a menu of the possible matches."
2878 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2884 manuals matches node nodes)
2907 matches)))
2916 Info-history-list ohist-list)
2937 "Make command be undefined in Info."
2942 "Enter the Info tutorial."
2947 "Help-Small-Screen"
2951 "Display a brief summary of all Info commands."
2966 flag))
2969 \f
2971 "Return the token around POS.
2972 POS must be somewhere inside the token
2973 START is a regular expression which will match the
2974 beginning of the tokens delimited string
2975 ALL is a regular expression with a single
2976 parenthesized subpattern which is the token to be
2977 returned. E.g. '{\(.*\)}' would return any string
2978 enclosed in braces around POS.
2979 ERRORSTRING optional fourth argument, controls action on no match
2980 nil: return nil
2981 t: beep
2982 a string: signal an error, using that string."
2986 ;; First look for a match for START that goes across POS.
2990 ;; If we did not find one, search back for START
2991 ;; (this finds only matches that end at or before POS).
3004 nil)
3007 nil)
3013 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3014 At end of the node's text, moves to the next node, or up if none."
3022 "Follow a node reference near point.
3023 If point is on a reference, follow that reference. Otherwise,
3024 if point is in a menu item description, follow that menu item."
3036 t)))
3039 ;; Common subroutine.
3041 "Follow a node reference near point. Return non-nil if successful."
3050 ;; menu item: node name
3053 ;; menu item: node name or index entry
3067 node))
3068 \f
3072 nil
3082 (define-key Info-mode-map "1" 'Info-nth-menu-item)
3083 (define-key Info-mode-map "2" 'Info-nth-menu-item)
3084 (define-key Info-mode-map "3" 'Info-nth-menu-item)
3085 (define-key Info-mode-map "4" 'Info-nth-menu-item)
3086 (define-key Info-mode-map "5" 'Info-nth-menu-item)
3087 (define-key Info-mode-map "6" 'Info-nth-menu-item)
3088 (define-key Info-mode-map "7" 'Info-nth-menu-item)
3089 (define-key Info-mode-map "8" 'Info-nth-menu-item)
3090 (define-key Info-mode-map "9" 'Info-nth-menu-item)
3091 (define-key Info-mode-map "0" 'undefined)
3092 (define-key Info-mode-map "?" 'Info-summary)
3093 (define-key Info-mode-map "]" 'Info-forward-node)
3094 (define-key Info-mode-map "[" 'Info-backward-node)
3095 (define-key Info-mode-map "<" 'Info-top-node)
3096 (define-key Info-mode-map ">" 'Info-final-node)
3097 (define-key Info-mode-map "b" 'beginning-of-buffer)
3098 (define-key Info-mode-map "d" 'Info-directory)
3099 (define-key Info-mode-map "e" 'Info-edit)
3100 (define-key Info-mode-map "f" 'Info-follow-reference)
3101 (define-key Info-mode-map "g" 'Info-goto-node)
3102 (define-key Info-mode-map "h" 'Info-help)
3103 (define-key Info-mode-map "i" 'Info-index)
3104 (define-key Info-mode-map "l" 'Info-history-back)
3105 (define-key Info-mode-map "L" 'Info-history)
3106 (define-key Info-mode-map "m" 'Info-menu)
3107 (define-key Info-mode-map "n" 'Info-next)
3108 (define-key Info-mode-map "p" 'Info-prev)
3109 (define-key Info-mode-map "q" 'Info-exit)
3110 (define-key Info-mode-map "r" 'Info-history-forward)
3111 (define-key Info-mode-map "s" 'Info-search)
3112 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
3113 ;; For consistency with Rmail.
3114 (define-key Info-mode-map "\M-s" 'Info-search)
3115 (define-key Info-mode-map "\M-n" 'clone-buffer)
3116 (define-key Info-mode-map "t" 'Info-top-node)
3117 (define-key Info-mode-map "T" 'Info-toc)
3118 (define-key Info-mode-map "u" 'Info-up)
3119 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3120 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
3121 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
3122 ;; `^' for consistency with `dired-up-directory'.
3123 (define-key Info-mode-map "^" 'Info-up)
3124 (define-key Info-mode-map "," 'Info-index-next)
3126 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
3127 (define-key Info-mode-map [follow-link] 'mouse-face)
3128 )
3130 (defun Info-check-pointer (item)
3131 "Non-nil if ITEM is present in this node."
3132 (condition-case nil
3133 (Info-extract-pointer item)
3134 (error nil)))
3136 (easy-menu-define
3137 Info-mode-menu Info-mode-map
3138 "Menu for Info files."
3139 '("Info"
3140 ["Up" Info-up :active (Info-check-pointer "up")
3141 :help "Go up in the Info tree"]
3142 ["Next" Info-next :active (Info-check-pointer "next")
3143 :help "Go to the next node"]
3144 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3145 :help "Go to the previous node"]
3146 ["Backward" Info-backward-node
3147 :help "Go backward one node, considering all as a sequence"]
3148 ["Forward" Info-forward-node
3149 :help "Go forward one node, considering all as a sequence"]
3150 ["Beginning" beginning-of-buffer
3151 :help "Go to beginning of this node"]
3152 ["Top" Info-top-node
3153 :help "Go to top node of file"]
3154 ["Final Node" Info-final-node
3155 :help "Go to final node in this file"]
3156 ("Menu Item" ["You should never see this" report-emacs-bug t])
3157 ("Reference" ["You should never see this" report-emacs-bug t])
3158 ["Search..." Info-search
3159 :help "Search for regular expression in this Info file"]
3160 ["Search Next" Info-search-next
3161 :help "Search for another occurrence of regular expression"]
3162 ["Go to Node..." Info-goto-node
3163 :help "Go to a named node"]
3164 ["Back in history" Info-history-back :active Info-history
3165 :help "Go back in history to the last node you were at"]
3166 ["Forward in history" Info-history-forward :active Info-history-forward
3167 :help "Go forward in history"]
3168 ["History" Info-history :active Info-history-list
3169 :help "Go to menu of visited nodes"]
3170 ["Table of Contents" Info-toc
3171 :help "Go to table of contents"]
3172 ("Index"
3173 ["Lookup a String..." Info-index
3174 :help "Look for a string in the index items"]
3175 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3176 :help "Look for another occurrence of previous item"]
3177 ["Lookup a string in all indices..." info-apropos
3178 :help "Look for a string in the indices of all manuals"])
3179 ["Copy Node Name" Info-copy-current-node-name
3180 :help "Copy the name of the current node into the kill ring"]
3181 ["Clone Info buffer" clone-buffer
3182 :help "Create a twin copy of the current Info buffer."]
3183 ["Exit" Info-exit :help "Stop reading Info"]))
3186 (defvar info-tool-bar-map
3187 (if (display-graphic-p)
3188 (let ((map (make-sparse-keymap)))
3189 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
3190 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map)
3191 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map)
3192 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map)
3193 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map)
3194 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3195 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3196 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3197 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3198 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3199 map)))
3201 (defvar Info-menu-last-node nil)
3202 ;; Last node the menu was created for.
3203 ;; Value is a list, (FILE-NAME NODE-NAME).
3205 (defun Info-menu-update ()
3206 "Update the Info menu for the current node."
3207 (condition-case nil
3208 (if (or (not (eq major-mode 'Info-mode))
3209 (equal (list Info-current-file Info-current-node)
3210 Info-menu-last-node))
3211 ()
3212 ;; Update menu menu.
3213 (let* ((Info-complete-menu-buffer (current-buffer))
3214 (items (nreverse (condition-case nil
3215 (Info-complete-menu-item "" nil t)
3216 (error nil))))
3217 entries current
3218 (number 0))
3219 (while (and items (< number 9))
3220 (setq current (car items)
3221 items (cdr items)
3222 number (1+ number))
3223 (setq entries (cons `[,current
3224 (Info-menu ,current)
3225 :keys ,(format "%d" number)]
3226 entries)))
3227 (if items
3228 (setq entries (cons ["Other..." Info-menu t] entries)))
3229 (or entries
3230 (setq entries (list ["No menu" nil nil] nil :active)))
3231 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3232 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3233 (let ((items nil)
3234 str i entries current
3235 (number 0)
3236 (case-fold-search t))
3237 (save-excursion
3238 (goto-char (point-min))
3240 (setq str (match-string 1))
3241 (setq i 0)
3243 (setq str (concat (substring str 0 i) " "
3244 (substring str (match-end 0))))
3245 (setq i (1+ i)))
3246 (setq items
3247 (cons str items))))
3248 (while (and items (< number 9))
3249 (setq current (car items)
3250 items (cdr items)
3251 number (1+ number))
3252 (setq entries (cons `[,current
3253 (Info-follow-reference ,current)
3254 t]
3255 entries)))
3256 (if items
3257 (setq entries (cons ["Other..." Info-follow-reference t]
3258 entries)))
3259 (or entries
3260 (setq entries (list ["No references" nil nil] nil :active)))
3261 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3262 ;; Update last seen node.
3263 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3264 ;; Try to avoid entering infinite beep mode in case of errors.
3265 (error (ding))))
3267 \f
3268 (defun Info-copy-current-node-name (&optional arg)
3269 "Put the name of the current Info node into the kill ring.
3270 The name of the Info file is prepended to the node name in parentheses.
3271 With a zero prefix arg, put the name inside a function call to `info'."
3272 (interactive "P")
3273 (unless Info-current-node
3274 (error "No current Info node"))
3275 (let ((node (concat "(" (file-name-nondirectory Info-current-file) ")"
3276 Info-current-node)))
3277 (if (zerop (prefix-numeric-value arg))
3279 (kill-new node)
3280 (message "%s" node)))
3282 \f
3283 ;; Info mode is suitable only for specially formatted data.
3284 (put 'Info-mode 'mode-class 'special)
3285 (put 'Info-mode 'no-clone-indirect t)
3287 (defvar tool-bar-map)
3289 ;; Autoload cookie needed by desktop.el
3290 ;;;###autoload
3291 (defun Info-mode ()
3292 "Info mode provides commands for browsing through the Info documentation tree.
3294 one topic and contains references to other nodes which discuss related
3295 topics. Info has commands to follow the references and show you other nodes.
3301 Selecting other nodes:
3303 Follow a node reference you click on.
3304 This works with menu items, cross references, and
3306 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3311 Picking a menu item causes another node to be selected.
3321 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3325 Moving within a node:
3327 Once you scroll far enough in a node that its menu appears on the
3328 screen but after point, the next scroll moves into its first
3329 subnode. When after all menu items (or if there is no menu),
3330 move up to the parent node.
3332 already visible, try to go to the previous menu entry, or up
3333 if there is none.
3336 Advanced commands:
3338 and select the node in which the next occurrence is found.
3339 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3343 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3346 You may include a filename as well, as (FILENAME)NODENAME.
3347 1 .. 9 Pick first ... ninth item in node's menu.
3348 Every third `*' is highlighted to help pick the right number.
3352 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3353 (kill-all-local-variables)
3354 (setq major-mode 'Info-mode)
3355 (setq mode-name "Info")
3356 (setq tab-width 8)
3357 (use-local-map Info-mode-map)
3358 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3359 (set-syntax-table text-mode-syntax-table)
3360 (setq local-abbrev-table text-mode-abbrev-table)
3361 (setq case-fold-search t)
3362 (setq buffer-read-only t)
3363 (make-local-variable 'Info-current-file)
3364 (make-local-variable 'Info-current-subfile)
3365 (make-local-variable 'Info-current-node)
3366 (make-local-variable 'Info-tag-table-marker)
3367 (setq Info-tag-table-marker (make-marker))
3368 (make-local-variable 'Info-tag-table-buffer)
3369 (setq Info-tag-table-buffer nil)
3370 (make-local-variable 'Info-history)
3371 (make-local-variable 'Info-history-forward)
3372 (make-local-variable 'Info-index-alternatives)
3373 (setq header-line-format
3374 (if Info-use-header-line
3375 '(:eval (get-text-property (point-min) 'header-line))
3376 nil)) ; so the header line isn't displayed
3377 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3378 ;; This is for the sake of the invisible text we use handling titles.
3379 (make-local-variable 'line-move-ignore-invisible)
3380 (setq line-move-ignore-invisible t)
3381 (make-local-variable 'desktop-save-buffer)
3382 (make-local-variable 'widen-automatically)
3383 (setq widen-automatically nil)
3384 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3385 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3386 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
3387 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3388 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3389 (set (make-local-variable 'isearch-search-fun-function)
3390 'Info-isearch-search)
3391 (set (make-local-variable 'isearch-wrap-function)
3392 'Info-isearch-wrap)
3393 (set (make-local-variable 'isearch-push-state-function)
3394 'Info-isearch-push-state)
3395 (set (make-local-variable 'search-whitespace-regexp)
3396 Info-search-whitespace-regexp)
3397 (Info-set-mode-line)
3398 (run-mode-hooks 'Info-mode-hook))
3400 ;; When an Info buffer is killed, make sure the associated tags buffer
3401 ;; is killed too.
3402 (defun Info-kill-buffer ()
3403 (and (eq major-mode 'Info-mode)
3404 Info-tag-table-buffer
3405 (kill-buffer Info-tag-table-buffer)))
3407 (defun Info-clone-buffer-hook ()
3408 (when (bufferp Info-tag-table-buffer)
3409 (setq Info-tag-table-buffer
3410 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3411 (let ((m Info-tag-table-marker))
3412 (when (markerp m)
3413 (setq Info-tag-table-marker
3414 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3415 (with-current-buffer Info-tag-table-buffer
3416 (copy-marker (marker-position m)))
3417 (make-marker))))))
3419 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3420 (set-keymap-parent map text-mode-map)
3421 (define-key map "\C-c\C-c" 'Info-cease-edit)
3422 map)
3423 "Local keymap used within `e' command of Info.")
3425 ;; Info-edit mode is suitable only for specially formatted data.
3426 (put 'Info-edit-mode 'mode-class 'special)
3428 (defun Info-edit-mode ()
3429 "Major mode for editing the contents of an Info node.
3430 Like text mode with the addition of `Info-cease-edit'
3431 which returns to Info mode for browsing.
3433 (use-local-map Info-edit-map)
3434 (setq major-mode 'Info-edit-mode)
3435 (setq mode-name "Info Edit")
3436 (kill-local-variable 'mode-line-buffer-identification)
3437 (setq buffer-read-only nil)
3438 (force-mode-line-update)
3439 (buffer-enable-undo (current-buffer))
3440 (run-mode-hooks 'Info-edit-mode-hook))
3442 (defun Info-edit ()
3443 "Edit the contents of this Info node.
3444 Allowed only if variable `Info-enable-edit' is non-nil."
3445 (interactive)
3446 (or Info-enable-edit
3447 (error "Editing Info nodes is not enabled"))
3448 (Info-edit-mode)
3449 (message "%s" (substitute-command-keys
3452 (defun Info-cease-edit ()
3453 "Finish editing Info node; switch back to Info proper."
3454 (interactive)
3455 ;; Do this first, so nothing has changed if user C-g's at query.
3456 (and (buffer-modified-p)
3457 (y-or-n-p "Save the file? ")
3458 (save-buffer))
3459 (use-local-map Info-mode-map)
3460 (setq major-mode 'Info-mode)
3461 (setq mode-name "Info")
3462 (Info-set-mode-line)
3463 (setq buffer-read-only t)
3464 (force-mode-line-update)
3465 (and (marker-position Info-tag-table-marker)
3466 (buffer-modified-p)
3467 (message "Tags may have changed. Use Info-tagify if necessary")))
3468 \f
3469 (defvar Info-file-list-for-emacs
3470 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3471 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3472 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3473 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3474 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3475 ("copyright" . "autotype") ("executable" . "autotype")
3476 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3477 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3478 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3479 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3480 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3481 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3482 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3483 ("rfc2045" . "emacs-mime")
3484 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3485 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3486 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3487 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3488 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3489 ("mml" . "emacs-mime"))
3490 "List of Info files that describe Emacs commands.
3491 An element can be a file name, or a list of the form (PREFIX . FILE)
3492 where PREFIX is a name prefix and FILE is the file to look in.
3493 If the element is just a file name, the file name also serves as the prefix.")
3495 (defun Info-find-emacs-command-nodes (command)
3496 "Return a list of locations documenting COMMAND.
3497 The `info-file' property of COMMAND says which Info manual to search.
3498 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3499 defines heuristics for which Info manual to try.
3500 The locations are of the format used in `Info-history', i.e.
3501 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3502 in the first element of the returned list (which is treated specially in
3503 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3504 (let ((where '()) line-number
3508 (info-file "emacs")) ;default
3509 ;; Determine which Info file this command is documented in.
3510 (if (get command 'info-file)
3511 (setq info-file (get command 'info-file))
3512 ;; If it doesn't say explicitly, test its name against
3513 ;; various prefixes that we know.
3514 (let ((file-list Info-file-list-for-emacs))
3515 (while file-list
3516 (let* ((elt (car file-list))
3517 (name (if (consp elt)
3518 (car elt)
3519 elt))
3520 (file (if (consp elt) (cdr elt) elt))
3521 (case-fold-search nil)
3524 (if (string-match regexp (symbol-name command))
3525 (setq info-file file file-list nil))
3526 (setq file-list (cdr file-list))))))
3527 (Info-find-node info-file "Top")
3528 ;; Bind Info-history to nil, to prevent the index nodes from
3529 ;; getting into the node history.
3530 (let ((Info-history nil)
3531 (Info-history-list nil)
3532 node (nodes (Info-index-nodes)))
3533 (Info-goto-node (car nodes))
3534 (while
3535 (progn
3536 (goto-char (point-min))
3537 (while (re-search-forward cmd-desc nil t)
3538 (setq where
3539 (cons (list Info-current-file
3540 (match-string-no-properties 2)
3541 0)
3542 where))
3543 (setq line-number (and (match-beginning 3)
3544 (string-to-number (match-string 3)))))
3545 (and (setq nodes (cdr nodes) node (car nodes))))
3546 (Info-goto-node node)))
3547 (if (and line-number where)
3548 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3549 (cdr where))
3550 where)))
3552 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3553 ;;;###autoload
3554 (defun Info-goto-emacs-command-node (command)
3555 "Go to the Info node in the Emacs manual for command COMMAND.
3556 The command is found by looking up in Emacs manual's indices
3557 or in another manual found via COMMAND's `info-file' property or
3558 the variable `Info-file-list-for-emacs'.
3559 COMMAND must be a symbol or string."
3560 (interactive "CFind documentation for command: ")
3561 ;; If command is given as a string, convert it to a symbol.
3562 (if (stringp command)
3563 (setq command (intern command)))
3564 (or (commandp command)
3565 (signal 'wrong-type-argument (list 'commandp command)))
3566 (let ((where (Info-find-emacs-command-nodes command)))
3567 (if where
3568 (let ((num-matches (length where)))
3569 ;; Get Info running, and pop to it in another window.
3570 (save-window-excursion
3571 (info))
3572 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3573 ;; Bind Info-history to nil, to prevent the last Index node
3574 ;; visited by Info-find-emacs-command-nodes from being
3575 ;; pushed onto the history.
3576 (let ((Info-history nil) (Info-history-list nil)
3577 (line-number (nth 2 (car where))))
3578 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3579 (if (and (integerp line-number) (> line-number 0))
3580 (forward-line (1- line-number))))
3581 (if (> num-matches 1)
3582 (progn
3583 ;; (car where) will be pushed onto Info-history
3584 ;; when/if they go to another node. Put the other
3585 ;; nodes that were found on the history.
3586 (setq Info-history (nconc (cdr where) Info-history))
3587 (message "Found %d other entr%s. Use %s to see %s."
3588 (1- num-matches)
3589 (if (> num-matches 2) "ies" "y")
3591 (if (> num-matches 2) "them" "it")))))
3592 (error "Couldn't find documentation for %s" command))))
3594 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3595 ;;;###autoload
3596 (defun Info-goto-emacs-key-command-node (key)
3597 "Go to the node in the Emacs manual which describes the command bound to KEY.
3598 KEY is a string.
3599 Interactively, if the binding is `execute-extended-command', a command is read.
3600 The command is found by looking up in Emacs manual's indices
3601 or in another manual found via COMMAND's `info-file' property or
3602 the variable `Info-file-list-for-emacs'."
3603 (interactive "kFind documentation for key: ")
3604 (let ((command (key-binding key)))
3605 (cond ((null command)
3606 (message "%s is undefined" (key-description key)))
3607 ((and (interactive-p)
3608 (eq command 'execute-extended-command))
3609 (Info-goto-emacs-command-node
3610 (read-command "Find documentation for command: ")))
3611 (t
3612 (Info-goto-emacs-command-node command)))))
3613 \f
3614 (defvar Info-next-link-keymap
3615 (let ((keymap (make-sparse-keymap)))
3616 (define-key keymap [header-line mouse-1] 'Info-next)
3617 (define-key keymap [header-line mouse-2] 'Info-next)
3618 (define-key keymap [header-line down-mouse-1] 'ignore)
3619 (define-key keymap [mouse-2] 'Info-next)
3620 (define-key keymap [follow-link] 'mouse-face)
3621 keymap)
3622 "Keymap to put on the Next link in the text or the header line.")
3624 (defvar Info-prev-link-keymap
3625 (let ((keymap (make-sparse-keymap)))
3626 (define-key keymap [header-line mouse-1] 'Info-prev)
3627 (define-key keymap [header-line mouse-2] 'Info-prev)
3628 (define-key keymap [header-line down-mouse-1] 'ignore)
3629 (define-key keymap [mouse-2] 'Info-prev)
3630 (define-key keymap [follow-link] 'mouse-face)
3631 keymap)
3632 "Keymap to put on the Prev link in the text or the header line.")
3634 (defvar Info-up-link-keymap
3635 (let ((keymap (make-sparse-keymap)))
3636 (define-key keymap [header-line mouse-1] 'Info-up)
3637 (define-key keymap [header-line mouse-2] 'Info-up)
3638 (define-key keymap [header-line down-mouse-1] 'ignore)
3639 (define-key keymap [mouse-2] 'Info-up)
3640 (define-key keymap [follow-link] 'mouse-face)
3641 keymap)
3642 "Keymap to put on the Up link in the text or the header line.")
3644 (defun Info-fontify-node ()
3645 "Fontify the node."
3646 (save-excursion
3647 (let* ((inhibit-read-only t)
3648 (case-fold-search t)
3649 paragraph-markers
3650 (not-fontified-p ; the node hasn't already been fontified
3651 (not (let ((where (next-property-change (point-min))))
3652 (and where (not (= where (point-max)))))))
3653 (fontify-visited-p ; visited nodes need to be re-fontified
3654 (and Info-fontify-visited-nodes
3655 ;; Don't take time to refontify visited nodes in huge nodes
3656 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3657 rbeg rend)
3659 ;; Fontify header line
3660 (goto-char (point-min))
3662 (goto-char (match-end 0))
3664 (goto-char (match-end 0))
3665 (let* ((nbeg (match-beginning 2))
3666 (nend (match-end 2))
3667 (tbeg (match-beginning 1))
3668 (tag (match-string 1)))
3669 (if (string-equal (downcase tag) "node")
3670 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3671 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3672 (put-text-property tbeg nend 'mouse-face 'highlight)
3673 (put-text-property tbeg nend
3674 'help-echo
3675 (concat "mouse-2: Go to node "
3676 (buffer-substring nbeg nend)))
3677 ;; Always set up the text property keymap.
3678 ;; It will either be used in the buffer
3679 ;; or copied in the header line.
3680 (put-text-property
3681 tbeg nend 'keymap
3682 (cond
3683 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3684 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3685 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3686 (when Info-use-header-line
3687 (goto-char (point-min))
3688 (let* ((header-end (line-end-position))
3689 (header
3690 ;; If we find neither Next: nor Prev: link, show the entire
3691 ;; node header. Otherwise, don't show the File: and Node:
3692 ;; parts, to avoid wasting precious space on information that
3693 ;; is available in the mode line.
3694 (if (re-search-forward
3696 header-end t)
3697 (progn
3698 (goto-char (match-beginning 1))
3699 (buffer-substring (point) header-end))
3701 header-end t)
3702 (concat "No next, prev or up links -- "
3703 (buffer-substring (point) header-end))
3704 (buffer-substring (point) header-end)))))
3705 (put-text-property (point-min) (1+ (point-min))
3706 'header-line
3707 (replace-regexp-in-string
3708 "%"
3709 ;; Preserve text properties on duplicated `%'.
3710 (lambda (s) (concat s s)) header))
3711 ;; Hide the part of the first line
3712 ;; that is in the header, if it is just part.
3713 (unless (bobp)
3714 ;; Hide the punctuation at the end, too.
3716 (put-text-property (point) header-end 'invisible t)))))
3718 ;; Fontify titles
3719 (goto-char (point-min))
3720 (when (and font-lock-mode not-fontified-p)
3722 nil t)
3723 ;; Only consider it as an underlined title if the ASCII
3724 ;; underline has the same size as the text. A typical
3725 ;; counter example is when a continuation "..." is alone
3726 ;; on a line.
3727 (= (string-width (match-string 1))
3728 (string-width (match-string 2))))
3729 (let* ((c (preceding-char))
3730 (face
3731 (cond ((= c ?*) 'info-title-1)
3732 ((= c ?=) 'info-title-2)
3733 ((= c ?-) 'info-title-3)
3734 (t 'info-title-4))))
3735 (put-text-property (match-beginning 1) (match-end 1)
3736 'font-lock-face face))
3737 ;; This is a serious problem for trying to handle multiple
3738 ;; frame types at once. We want this text to be invisible
3739 ;; on frames that can display the font above.
3740 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3741 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3742 '(invisible t front-sticky nil rear-nonsticky t)))))
3744 ;; Fontify cross references
3745 (goto-char (point-min))
3746 (when (or not-fontified-p fontify-visited-p)
3747 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3748 (let ((start (match-beginning 0))
3749 (next (point))
3750 other-tag)
3751 (when not-fontified-p
3752 (when Info-hide-note-references
3753 (when (not (eq Info-hide-note-references 'hide))
3754 ;; *Note is often used where *note should have been
3755 (goto-char start)
3756 (skip-syntax-backward " ")
3757 (when (memq (char-before) '(?\( ?\[ ?\{))
3758 ;; Check whether the paren is preceded by
3759 ;; an end of sentence
3760 (skip-syntax-backward " ("))
3761 (setq other-tag
3763 "")
3764 ((memq (char-before) '(nil ?\. ?! ??))
3765 "See ")
3766 ((save-match-data
3767 (save-excursion
3769 "See ")
3770 (t "see "))))
3771 (goto-char next)
3772 (add-text-properties
3773 (match-beginning 1)
3774 (or (save-match-data
3776 (let ((start1 (match-beginning 1)))
3778 (+ start1 (match-beginning 0)))))
3779 (match-end 1))
3780 (if other-tag
3781 `(display ,other-tag front-sticky nil rear-nonsticky t)
3782 '(invisible t front-sticky nil rear-nonsticky t))))
3783 (add-text-properties
3784 (match-beginning 2) (match-end 2)
3785 (list
3786 'help-echo (if (or (match-end 5)
3787 (not (equal (match-string 4) "")))
3788 (concat "mouse-2: go to " (or (match-string 5)
3789 (match-string 4)))
3790 "mouse-2: go to this node")
3791 'mouse-face 'highlight)))
3792 (when (or not-fontified-p fontify-visited-p)
3793 (setq rbeg (match-beginning 2)
3794 rend (match-end 2))
3795 (put-text-property
3796 rbeg rend
3797 'font-lock-face
3798 ;; Display visited nodes in a different face
3799 (if (and Info-fontify-visited-nodes
3800 (save-match-data
3801 (let* ((node (replace-regexp-in-string
3803 (replace-regexp-in-string
3805 (or (match-string 5)
3806 (and (not (equal (match-string 4) ""))
3807 (match-string 4))
3808 (match-string 2)))))
3809 (external-link-p
3811 (file (if external-link-p
3812 (file-name-nondirectory
3813 (match-string 1 node))
3814 Info-current-file))
3815 (hl Info-history-list)
3816 res)
3817 (if external-link-p
3818 (setq node (if (equal (match-string 2 node) "")
3819 "Top"
3820 (match-string 2 node))))
3821 (while hl
3822 (if (and (string-equal node (nth 1 (car hl)))
3823 (string-equal
3824 file (if external-link-p
3825 (file-name-nondirectory
3826 (caar hl))
3827 (caar hl))))
3828 (setq res (car hl) hl nil)
3829 (setq hl (cdr hl))))
3830 res))) 'info-xref-visited 'info-xref))
3831 ;; For multiline ref, unfontify newline and surrounding whitespace
3832 (save-excursion
3833 (goto-char rbeg)
3834 (save-match-data
3836 (remove-text-properties (match-beginning 0)
3837 (match-end 0)
3838 '(font-lock-face t))))))
3839 (when not-fontified-p
3840 (when (memq Info-hide-note-references '(t hide))
3841 (add-text-properties (match-beginning 3) (match-end 3)
3842 '(invisible t front-sticky nil rear-nonsticky t))
3843 ;; Unhide the file name of the external reference in parens
3844 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3845 (remove-text-properties (match-beginning 6) (match-end 6)
3846 '(invisible t front-sticky nil rear-nonsticky t)))
3847 ;; Unhide newline because hidden newlines cause too long lines
3848 (save-match-data
3849 (let ((beg3 (match-beginning 3))
3850 (end3 (match-end 3)))
3852 (not (save-match-data
3853 (save-excursion
3854 (goto-char (1+ end3))
3855 (looking-at "[.)]*$")))))
3856 (remove-text-properties (+ beg3 (match-beginning 0))
3857 (+ beg3 (match-end 0))
3858 '(invisible t front-sticky nil rear-nonsticky t))))))
3859 (when (and Info-refill-paragraphs Info-hide-note-references)
3860 (push (set-marker (make-marker) start)
3861 paragraph-markers))))))
3863 ;; Refill paragraphs (experimental feature)
3864 (when (and not-fontified-p
3865 Info-refill-paragraphs
3866 paragraph-markers)
3867 (let ((fill-nobreak-invisible t)
3868 (fill-individual-varying-indent nil)
3871 (adaptive-fill-mode nil))
3872 (goto-char (point-max))
3873 (dolist (m paragraph-markers)
3874 (when (< m (point))
3875 (goto-char m)
3876 (beginning-of-line)
3877 (let ((beg (point)))
3878 (when (zerop (forward-paragraph))
3879 (fill-individual-paragraphs beg (point) nil nil)
3880 (goto-char beg))))
3881 (set-marker m nil))))
3883 ;; Fontify menu items
3884 (goto-char (point-min))
3885 (when (and (or not-fontified-p fontify-visited-p)
3887 (not (Info-index-node))
3888 ;; Don't take time to annotate huge menus
3889 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3890 (let ((n 0)
3891 cont)
3892 (while (re-search-forward
3895 nil t)
3896 (when (match-beginning 1)
3897 (when not-fontified-p
3898 (setq n (1+ n))
3899 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3900 (put-text-property (match-beginning 0)
3901 (1+ (match-beginning 0))
3902 'font-lock-face 'info-menu-star)))
3903 (when not-fontified-p
3904 (add-text-properties
3905 (match-beginning 1) (match-end 1)
3906 (list
3907 'help-echo (if (and (match-end 3)
3908 (not (equal (match-string 3) "")))
3909 (concat "mouse-2: go to " (match-string 3))
3910 "mouse-2: go to this node")
3911 'mouse-face 'highlight)))
3912 (when (or not-fontified-p fontify-visited-p)
3913 (put-text-property
3914 (match-beginning 1) (match-end 1)
3915 'font-lock-face
3916 ;; Display visited menu items in a different face
3917 (if (and Info-fontify-visited-nodes
3918 (save-match-data
3919 (let* ((node (if (equal (match-string 3) "")
3920 (match-string 1)
3921 (match-string 3)))
3922 (external-link-p
3924 (file (if external-link-p
3925 (file-name-nondirectory
3926 (match-string 1 node))
3927 Info-current-file))
3928 (hl Info-history-list)
3929 res)
3930 (if external-link-p
3931 (setq node (if (equal (match-string 2 node) "")
3932 "Top"
3933 (match-string 2 node))))
3934 (while hl
3935 (if (and (string-equal node (nth 1 (car hl)))
3936 (string-equal
3937 file (if external-link-p
3938 (file-name-nondirectory (caar hl))
3939 (caar hl))))
3940 (setq res (car hl) hl nil)
3941 (setq hl (cdr hl))))
3942 res))) 'info-xref-visited 'info-xref)))
3943 (when (and not-fontified-p (memq Info-hide-note-references '(t hide)))
3944 (put-text-property (match-beginning 2) (1- (match-end 6))
3945 'invisible t)
3946 ;; Unhide the file name in parens
3947 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
3948 (remove-text-properties (match-beginning 4) (match-end 4)
3949 '(invisible t)))
3950 ;; We need a stretchable space like :align-to but with
3951 ;; a minimum value.
3952 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3953 (if (>= 22 (- (match-end 1)
3954 (match-beginning 0)))
3955 '(space :align-to 24)
3956 '(space :width 2)))
3957 (setq cont (looking-at "."))
3958 (while (and (= (forward-line 1) 0)
3960 (put-text-property (match-beginning 1) (1- (match-end 1))
3961 'invisible t)
3962 (put-text-property (1- (match-end 1)) (match-end 1)
3963 'display
3964 (if cont
3965 '(space :align-to 26)
3966 '(space :align-to 24)))
3967 (setq cont t)))))))
3969 ;; Fontify menu headers
3970 ;; Add the face `info-menu-header' to any header before a menu entry
3971 (goto-char (point-min))
3973 (put-text-property (match-beginning 0) (match-end 0)
3974 'font-lock-face 'info-menu-header)
3976 (put-text-property (match-beginning 1) (match-end 1)
3977 'font-lock-face 'info-menu-header)))
3979 ;; Hide index line numbers
3980 (goto-char (point-min))
3981 (when (and not-fontified-p (Info-index-node))
3983 (put-text-property (match-beginning 0) (match-end 0)
3984 'invisible t)))
3986 ;; Fontify http and ftp references
3987 (goto-char (point-min))
3988 (when not-fontified-p
3990 (add-text-properties (match-beginning 0) (match-end 0)
3991 '(font-lock-face info-xref
3992 mouse-face highlight
3993 help-echo "mouse-2: go to this URL"))))
3995 (set-buffer-modified-p nil))))
3996 \f
3997 ;;; Speedbar support:
3998 ;; These functions permit speedbar to display the "tags" in the
3999 ;; current Info node.
4000 (eval-when-compile (require 'speedbar))
4002 (defvar Info-speedbar-key-map nil
4003 "Keymap used when in the info display mode.")
4005 (defun Info-install-speedbar-variables ()
4006 "Install those variables used by speedbar to enhance Info."
4007 (if Info-speedbar-key-map
4008 nil
4009 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4011 ;; Basic tree features
4012 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4013 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4014 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4015 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4016 )
4018 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4019 Info-speedbar-key-map
4020 Info-speedbar-hierarchy-buttons)))
4022 (defvar Info-speedbar-menu-items
4023 '(["Browse Node" speedbar-edit-line t]
4024 ["Expand Node" speedbar-expand-line
4025 (save-excursion (beginning-of-line)
4027 ["Contract Node" speedbar-contract-line
4028 (save-excursion (beginning-of-line)
4029 (looking-at "[0-9]+: *.-. "))]
4030 )
4031 "Additional menu-items to add to speedbar frame.")
4033 ;; Make sure our special speedbar major mode is loaded
4034 (if (featurep 'speedbar)
4035 (Info-install-speedbar-variables)
4036 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4038 ;;; Info hierarchy display method
4039 ;;;###autoload
4040 (defun Info-speedbar-browser ()
4041 "Initialize speedbar to display an Info node browser.
4042 This will add a speedbar major display mode."
4043 (interactive)
4044 (require 'speedbar)
4045 ;; Make sure that speedbar is active
4046 (speedbar-frame-mode 1)
4047 ;; Now, throw us into Info mode on speedbar.
4048 (speedbar-change-initial-expansion-list "Info")
4049 )
4051 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4052 "Display an Info directory hierarchy in speedbar.
4053 DIRECTORY is the current directory in the attached frame.
4054 DEPTH is the current indentation depth.
4055 NODE is an optional argument that is used to represent the
4056 specific node to expand."
4057 (if (and (not node)
4058 (save-excursion (goto-char (point-min))
4059 (let ((case-fold-search t))
4060 (looking-at "Info Nodes:"))))
4061 ;; Update our "current node" maybe?
4062 nil
4063 ;; We cannot use the generic list code, that depends on all leaves
4064 ;; being known at creation time.
4065 (if (not node)
4067 (let ((completions nil))
4068 (speedbar-select-attached-frame)
4069 (save-window-excursion
4070 (setq completions
4071 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4072 (select-frame (speedbar-current-frame))
4073 (if completions
4074 (speedbar-with-writable
4075 (dolist (completion completions)
4076 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4077 (cdr completion)
4078 (car completion)
4079 'Info-speedbar-goto-node
4080 (cdr completion)
4081 'info-xref depth))
4082 t)
4083 nil))))
4085 (defun Info-speedbar-goto-node (text node indent)
4086 "When user clicks on TEXT, go to an info NODE.
4087 The INDENT level is ignored."
4088 (speedbar-select-attached-frame)
4089 (let* ((buff (or (get-buffer "*info*")
4090 (progn (info) (get-buffer "*info*"))))
4091 (bwin (get-buffer-window buff 0)))
4092 (if bwin
4093 (progn
4094 (select-window bwin)
4095 (raise-frame (window-frame bwin)))
4096 (if speedbar-power-click
4097 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4098 (speedbar-select-attached-frame)
4099 (switch-to-buffer buff)))
4101 (error "Invalid node %s" node)
4102 (Info-find-node (match-string 1 node) (match-string 2 node))
4103 ;; If we do a find-node, and we were in info mode, restore
4104 ;; the old default method. Once we are in info mode, it makes
4105 ;; sense to return to whatever method the user was using before.
4106 (if (string= speedbar-initial-expansion-list-name "Info")
4107 (speedbar-change-initial-expansion-list
4108 speedbar-previously-used-expansion-list-name)))))
4110 (defun Info-speedbar-expand-node (text token indent)
4111 "Expand the node the user clicked on.
4112 TEXT is the text of the button we clicked on, a + or - item.
4113 TOKEN is data related to this node (NAME . FILE).
4114 INDENT is the current indentation depth."
4115 (cond ((string-match "+" text) ;we have to expand this file
4116 (speedbar-change-expand-button-char ?-)
4117 (if (speedbar-with-writable
4118 (save-excursion
4119 (end-of-line) (forward-char 1)
4120 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4121 (speedbar-change-expand-button-char ?-)
4122 (speedbar-change-expand-button-char ??)))
4123 ((string-match "-" text) ;we have to contract this node
4124 (speedbar-change-expand-button-char ?+)
4125 (speedbar-delete-subblock indent))
4126 (t (error "Ooops... not sure what to do")))
4127 (speedbar-center-buffer-smartly))
4129 (defun Info-speedbar-fetch-file-nodes (nodespec)
4130 "Fetch the subnodes from the info NODESPEC.
4131 NODESPEC is a string of the form: (file)node."
4132 (save-excursion
4133 ;; Set up a buffer we can use to fake-out Info.
4134 (set-buffer (get-buffer-create " *info-browse-tmp*"))
4135 (if (not (equal major-mode 'Info-mode))
4136 (Info-mode))
4137 ;; Get the node into this buffer
4139 (error "Invalid node specification %s" nodespec)
4140 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4141 ;; Scan the created buffer
4142 (goto-char (point-min))
4143 (let ((completions nil)
4144 (case-fold-search t)
4146 (match-string 1 nodespec))))
4147 ;; Always skip the first one...
4150 (let ((name (match-string 1)))
4151 (push (cons name
4153 (match-string 1)
4155 (concat (match-string 1) "Top")
4156 (concat "(" thisfile ")"
4158 (match-string 1)
4159 name)))))
4160 completions)))
4161 (nreverse completions))))
4163 ;;; Info mode node listing
4164 ;; This is called by `speedbar-add-localized-speedbar-support'
4165 (defun Info-speedbar-buttons (buffer)
4166 "Create a speedbar display to help navigation in an Info file.
4167 BUFFER is the buffer speedbar is requesting buttons for."
4168 (if (save-excursion (goto-char (point-min))
4169 (let ((case-fold-search t))
4170 (not (looking-at "Info Nodes:"))))
4171 (erase-buffer))
4172 (Info-speedbar-hierarchy-buttons nil 0))
4174 (dolist (mess '("^First node in file$"
4175 "^No `.*' in index$"
4176 "^No cross-reference named"
4177 "^No cross.references in this node$"
4178 "^No current Info node$"
4179 "^No menu in this node$"
4180 "^No more items in menu$"
4181 "^No more nodes$"
4183 "^No previous `i' command$"
4184 "^No previous items in menu$"
4185 "^No previous nodes$"
4186 "^No such item in menu$"
4187 "^No such node or anchor"
4188 "^Node has no"
4189 "^Point neither on reference nor in menu item description$"
4191 search-failed))
4192 (add-to-list 'debug-ignored-errors mess))
4194 ;;;; Desktop support
4196 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4197 "Auxiliary information to be saved in desktop file."
4198 (if (not (member Info-current-file '("apropos" "history" "toc")))
4199 (list Info-current-file Info-current-node)))
4201 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4202 desktop-buffer-name
4203 desktop-buffer-misc)
4204 "Restore an Info buffer specified in a desktop file."
4205 (let ((first (nth 0 desktop-buffer-misc))
4206 (second (nth 1 desktop-buffer-misc)))
4207 (when (and first second)
4208 (when desktop-buffer-name
4209 (set-buffer (get-buffer-create desktop-buffer-name))
4210 (Info-mode))
4211 (Info-find-node first second)
4212 (current-buffer))))
4214 (add-to-list 'desktop-buffer-mode-handlers
4215 '(Info-mode . Info-restore-desktop-buffer))
4217 (provide 'info)
4219 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4220 ;;; info.el ends here