| blob | 84c83bd419b616528043f7f1ddba6f94fc01c821 |
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.
293 It doesn't contain directory names or file name extensions added by Info.
297 "Info subfile that is actually in the *info* buffer now.
304 "Marker pointing at beginning of current Info file's tag table.
320 "Point location within a selected node.
321 If string, the point is moved to the proper occurrence of the
322 name of the followed cross reference within a selected node.
327 \f
329 ;; The MS-DOS list should work both when long file names are
330 ;; supported (Windows 9X), and when only 8+3 file names are available.
372 "List of file name suffixes and associated decoding commands.
373 Each entry should be (SUFFIX . STRING); the file is given to
374 the command as standard input.
376 STRING may be a list of strings. In that case, the first element is
377 the command name, and the rest are arguments to that command.
379 If STRING is nil, no decoding is done.
380 Because the SUFFIXes are tried in order, the empty string should
383 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
384 ;; First, on MS-DOS with no long file names support, delete some of
385 ;; the extension in FILENAME to make room.
390 ;; How long is the extension in FILENAME (not counting the dot).
392 ext-left)
393 ;; SUFFIX starts with a dot. If FILENAME already has one,
394 ;; get rid of the one in SUFFIX (unless suffix is empty).
399 ;; How many chars of that extension should we keep?
401 ;; Get rid of the rest of the extension, and add SUFFIX.
404 suffix))))
411 "Insert the contents of an Info file in the current buffer.
412 Do the right thing if the file has been compressed or zipped."
416 t))
418 lfn))
419 fullname decoder done)
421 ;; FILENAME exists--see if that name contains a suffix.
422 ;; If so, set DECODE accordingly.
427 filename)))
431 ;; Try adding suffixes to FILENAME and see if we can find something.
437 ;; If we found a file with a suffix, set DECODER
438 ;; according to the suffix.
440 ;; When the MS-DOS port runs on Windows, we need to check
441 ;; the short variant of a long file name as well.
451 ;; check for conflict with jka-compr
462 default-directory)))
468 \f
475 "../info/"
476 invocation-directory)))
478 infodir
480 "../../../info/"
481 invocation-directory))
483 infodir))))))
484 alternative)
487 ;; Uninstalled, Emacs builddir != srcdir.
488 sibling
489 ;; Uninstalled, builddir == srcdir
490 source))
492 ;; On DOS/NT, we use movable executables always,
493 ;; and we must always find the Info dir at run time.
495 nil
496 ;; Use invocation-directory for Info
497 ;; only if we used it for exec-directory also.
500 installation-directory))))
502 Info-default-directory-list
503 ;; `alternative' contains the Info files that came with this
504 ;; version, so we should look there first. `Info-insert-dir'
505 ;; currently expects to find `alternative' first on the list.
507 ;; Don't drop the last part, it might contain non-Emacs stuff.
508 ;; (reverse (cdr (reverse
512 "Initialize `Info-directory-list', if that hasn't been done yet."
525 ;;;###autoload
527 "Like `info' but show the Info buffer in another window."
533 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
535 ;;;###autoload (put 'info 'info-file "emacs")
536 ;;;###autoload
538 "Enter Info, the documentation browser.
539 Optional argument FILE specifies the file to examine;
540 the default is the top-level directory of Info.
541 Called from a program, FILE may specify an Info node of the form
542 `(FILENAME)NODENAME'.
543 Optional argument BUFFER specifies the Info buffer name;
544 the default buffer name is *info*. If BUFFER exists,
545 just switch to BUFFER. Otherwise, create a new buffer
546 with the top-level Info directory.
548 In interactive use, a non-numeric prefix argument directs
549 this command to read a file name from the minibuffer.
550 A numeric prefix argument selects an Info buffer with the prefix number
551 appended to the Info buffer name.
553 The search path for Info files is in the variable `Info-directory-list'.
554 The top-level Info directory is made by combining all the files named `dir'
555 in all the directories in that path."
565 ;; If argument already contains parentheses, don't add another set
566 ;; since the argument will then be parsed improperly. This also
567 ;; has the added benefit of allowing node names to be included
568 ;; following the parenthesized filename.
571 file
576 ;;;###autoload
578 "Display the Emacs manual in Info mode."
582 ;;;###autoload
584 "Run Emacs as a standalone Info reader.
585 Usage: emacs -f info-standalone [filename]
599 \f
600 ;; See if the accessible portion of the buffer begins with a node
601 ;; delimiter, and the node header line which follows matches REGEXP.
602 ;; Typically, this test will be followed by a loop that examines the
603 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
604 ;; to have the overhead of this special test inside the loop.
606 ;; This function changes match-data, but supposedly the caller might
607 ;; want to use the results of re-search-backward.
609 ;; The return value is the value of point at the beginning of matching
610 ;; REGEXP, if the function succeeds, nil otherwise.
622 Optional second argument NOERROR, if t, means if file is not found
623 just return nil (no error)."
624 ;; Convert filename to lower case if not found as specified.
625 ;; Expand it.
640 ;; If specified name starts with `./'
641 ;; then just try current directory.
644 ;; No point in searching for an
645 ;; absolute file name
649 Info-additional-directory-list)
650 Info-directory-list)))))
651 ;; Search the directory list for file FILENAME.
656 ;; Try several variants of specified name.
660 t)))
671 lfn
683 filename)))
686 "Go to an Info node specified as separate FILENAME and NODENAME.
687 NO-GOING-BACK is non-nil if recovering from an error in this function;
688 it says do not attempt further (recursive) error recovery."
691 ;; Go into Info buffer.
693 ;; Record the node we are leaving.
697 Info-history)))
701 "Use the `Info-mode' to browse the current Info buffer.
702 If a prefix arg is provided, it queries for the NODENAME which
714 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
715 ;; but at least it keeps this routine (which is only for the benefit of
716 ;; makeinfo-buffer) out of the way of normal operations.
717 ;;
719 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
720 When *info* is already displaying FILENAME and NODENAME, the window position
721 is preserved, if possible."
737 ;; note goto-line is no good, we want to measure from point-min
744 ;; only add to the history when coming from a different file+node
749 "Find a node in a tag table.
750 MARKER specifies the buffer and position to start searching at.
751 REGEXP is a regular expression matching nodes or references. Its first
752 group should match `Node:' or `Ref:'.
753 CASE-FOLD t means search for a case-insensitive match.
754 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
755 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
756 where the match was found, and MODE is `major-mode' of the buffer in
757 which the match was found."
763 ;; Search tag table
768 major-mode)))))
771 "Find a node in a tag table.
772 MARKER specifies the buffer and position to start searching at.
773 REGEXP is a regular expression matching nodes or references. Its first
774 group should match `Node:' or `Ref:'.
775 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
776 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
777 where the match was found, and MODE is `major-mode' of the buffer in
778 which the match was found.
779 This function tries to find a case-sensitive match first, then a
780 case-insensitive match is tried."
784 result))
787 "Find a node or anchor in the current buffer.
788 REGEXP is a regular expression matching nodes or references. Its first
789 group should match `Node:' or `Ref:'.
790 CASE-FOLD t means search for a case-insensitive match.
791 Value is the position at which a match was found, or nil if not found."
793 found)
805 found)))
808 "Find a node or anchor in the current buffer.
809 REGEXP is a regular expression matching nodes or references. Its first
810 group should match `Node:' or `Ref:'.
811 Value is the position at which a match was found, or nil if not found.
812 This function looks for a case-sensitive match first. If none is found,
813 a case-insensitive match is tried."
825 anchorpos)
826 ;; Switch files if necessary
831 Info-current-subfile nil
832 Info-current-file-completions nil
833 buffer-file-name nil)
849 ;; Check makeinfo version for index cookie support
861 ;; See whether file has a tag table. Record the location if yes.
864 ;; Use string-equal, not equal, to ignore text props.
869 ;; We have a tag table. Find its beginning.
870 ;; Is this an indirect file?
876 ;; It is indirect. Copy it to another buffer
877 ;; and record that the tag table is in that buffer.
900 ))
901 ;; Use string-equal, not equal, to ignore text props.
905 ;; Possibilities:
906 ;;
907 ;; 1. Anchor found in tag table
908 ;; 2. Anchor *not* in tag table
909 ;;
910 ;; 3. Node found in tag table
911 ;; 4. Node *not* found in tag table, but found in file
912 ;; 5. Node *not* in tag table, and *not* in file
913 ;;
914 ;; *Or* the same, but in an indirect subfile.
916 ;; Search file for a suitable node.
926 ;; First, search a tag table, if any
932 ;; FOUND is (ANCHOR POS MODE).
935 ;; If this is an indirect file, determine which
936 ;; file really holds this node and read it in.
938 ;; Note that the current buffer must be the
939 ;; *info* buffer on entry to
940 ;; Info-read-subfile. Thus the hackery above.
943 ;; Handle anchor
948 ;; Else we may have a node, which we search for:
952 ;; Now search from our advised position (or from beg of
953 ;; buffer) to find the actual node. First, check
954 ;; whether the node is right where we are, in case the
955 ;; buffer begins with a node.
968 ;; No such anchor in tag table or node in tag table or file
976 ;; Add anchors to the history too
987 ;; If we did not finish finding the specified node,
988 ;; go back to the previous one.
995 ;; Cache the contents of the (virtual) dir file, once we have merged
996 ;; it for the first time, so we can save time subsequently.
999 ;; Cache for the directory we decided to use for the default-directory
1000 ;; of the merged dir text.
1003 ;; Record the file attributes of all the files from which we
1004 ;; constructed Info-dir-contents.
1009 ;; Construct the Info directory node by merging the files named `dir'
1010 ;; from various directories. Set the *info* buffer's
1011 ;; default-directory to the first directory we actually get any text
1012 ;; from.
1015 ;; Verify that none of the files we used has changed
1016 ;; since we used it.
1020 ;; Handle symlinks
1023 ;; Don't compare the access time.
1027 Info-dir-file-attributes))))
1033 Info-additional-directory-list)
1034 Info-directory-list))
1036 ;; Bind this in case the user sets it to nil.
1038 ;; This is set non-nil if we find a problem in some input files.
1039 problems
1040 buffers buffer others nodes dirs-done)
1042 ;; Search the directory list for the directory file.
1047 ;; Try several variants of specified name.
1048 ;; Try upcasing, appending `.info', or both.
1063 dirs-done)))
1073 file)
1085 ;; Distinguish the dir file that comes with Emacs from all the
1086 ;; others. Yes, that is really what this is supposed to do.
1087 ;; The definition of `Info-directory-list' puts it first on that
1088 ;; list and so last in `buffers' at this point.
1092 ;; Insert the entire original dir file as a start; note that we've
1093 ;; already saved its default directory to use as the default
1094 ;; directory for the whole concatenation.
1097 ;; Look at each of the other buffers one by one.
1100 ;; In each, find all the menus.
1103 ;; Find each menu, and add an elt to NODES for it.
1107 nodename end)
1119 ;; Add to the main menu a menu item for each other node.
1131 end t)
1135 ;; Now take each node of each of the other buffers
1136 ;; and merge it into the main buffer.
1141 ;; Find the like-named node in the main buffer.
1145 nil t)
1150 ;; If none exists, add one.
1153 ;; Merge the text from the other buffer's menu
1154 ;; into the menu in the like-named node in the main buffer.
1157 ;; Kill all the buffers we just made, including the special one excised.
1177 ;; Remove duplicate headings in the same menu.
1180 ;; Look for the next heading to unify.
1185 ;; Check whether this heading should be streamlined.
1195 ;; Look for other headings of the same category and merge them.
1201 ;; Delete redundant heading.
1203 ;; Push the entries onto `text'.
1210 ;; Insert the entries just found.
1218 ;; Now remove duplicate entries under the same heading.
1224 ;; Fold case straight away; `member-ignore-case' here wasteful.
1232 ;; Note that on entry to this function the current-buffer must be the
1233 ;; *info* buffer; not the info tags buffer.
1235 ;; NODEPOS is either a position (in the Info file as a whole,
1236 ;; not relative to a subfile) or the name of a subfile.
1238 lastfilename)
1250 thisfilepos thisfilename)
1254 ;; read in version 19 stops at the end of number.
1255 ;; Advance to the next line.
1264 ;; Assume previous buffer is in Info-mode.
1265 ;; (set-buffer (get-buffer "*info*"))
1274 ;; Widen in case we are in the same subfile as before.
1284 "Unescape double quotes and backslashes in VALUE."
1290 unquote))
1292 ;; As of Texinfo 4.6, makeinfo writes constructs like
1293 ;; \0\h[image param=value ...\h\0]
1294 ;; into the Info file for handling images.
1297 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1298 whitespace or double quotes, it must be quoted in double quotes and
1303 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1304 parameter-string start)
1310 parameter-alist))
1311 parameter-alist))
1314 "Display images in current node."
1321 nil t)
1336 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1337 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1338 ;; including one optional trailing newline.
1340 "Hide unrecognized cookies in current node."
1347 nil t)
1354 "Select the Info node that point is in."
1355 ;; Bind this in case the user sets it to nil.
1358 ;; Find beginning of node.
1364 ;; Get nodename spelled as it is in the node.
1372 ;; Find the end of it, and narrow.
1375 ;; Narrow to the node contents
1387 ;; Add a new unique history item to full history list
1405 Info-current-file
1407 ") "
1409 \f
1410 ;; Go to an Info node specified with a filename-and-nodename string
1411 ;; of the sort that is found in pointers in nodes.
1413 ;; Don't autoload this function: the correct entry point for other packages
1414 ;; to use is `info'. --Stef
1415 ;; ;;;###autoload
1417 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1418 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1419 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1420 its sub-files).
1421 Completion is available, but only for node names in the current Info file.
1422 If FORK is non-nil (interactively with a prefix arg), show the node in
1423 a new Info buffer.
1424 If FORK is a string, it is the name to use for the new buffer."
1432 nodename)
1434 ""
1448 "Virtual completion table for file names input in Info node names.
1449 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1465 ;; If the file name has no suffix or a standard suffix,
1466 ;; include it.
1469 ;; But exclude subfiles of split Info files.
1471 ;; And exclude backup files.
1474 ;; If the file name ends in a standard suffix,
1475 ;; add the unsuffixed name as a completion option.
1484 ;; This function is used as the "completion table" while reading a node name.
1485 ;; It does completion using the alist in Info-read-node-completion-table
1486 ;; unless STRING starts with an open-paren.
1489 ;; First complete embedded file names.
1505 ;; If a file name was given, then any node is fair game.
1511 ;; Otherwise use Info-read-node-completion-table.
1519 ;; Arrange to highlight the proper letters in the completion list buffer.
1530 nodename)))
1535 ;; Bind this in case the user sets it to nil.
1548 compl))))
1551 ;; If the buffer begins with a node header, process that first.
1554 ;; Now for the rest of the nodes.
1562 compl))))))))
1565 \f
1567 "If this node has been visited, restore the point value when we left."
1570 ;; Use string-equal, not equal, to ignore text props.
1576 \f
1584 "Search for REGEXP, starting from point, and select node it's found in.
1585 If DIRECTION is `backward', search in the reverse direction."
1613 ;; Hide Info file header for backward search
1625 ;; Skip node header line
1629 ;; Skip Tag Table node
1648 ;; If no subfiles, give error now.
1662 ;; Try other subfiles.
1673 ;; Find the subfile we just searched.
1675 ;; Skip that one.
1678 ;; Make a list of all following subfiles.
1679 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1688 list))
1692 ;; Put in forward order
1698 ;; Hide Info file header for backward search
1713 ;; Skip node header line
1717 ;; Skip Tag Table node
1744 ;; Search landed in the same node
1750 ;; Use string-equal, not equal, to ignore text props.
1756 Info-history))))))
1759 "Search for a regexp case-sensitively."
1765 "Search for next regexp from a previous `Info-search' command."
1773 "Search for REGEXP in the reverse direction."
1792 nil t)
1794 bound noerror count
1797 bound noerror count
1824 \f
1826 "Extract the value of the node-pointer named NAME.
1827 If there is none, use ERRORNAME in the error message;
1828 if ERRORNAME is nil, just return nil."
1829 ;; Bind this in case the user sets it to nil.
1843 "Return a regexp matching a node name.
1844 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1845 saying which chars may appear in the node name.
1846 Submatch 1 is the complete node name.
1847 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1848 Submatch 3 is the local part of the node name.
1849 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1856 ;;; For compatibility; other files have used this name.
1862 "Go to the next node of this node."
1864 ;; In case another window is currently selected
1870 "Go to the previous node of this node."
1872 ;; In case another window is currently selected
1878 "Go to the superior node of this node.
1879 If SAME-FILE is non-nil, do not move to a different Info file."
1881 ;; In case another window is currently selected
1899 nil t))
1905 "Go back in the history to the last node visited."
1911 Info-history-forward))
1912 filename nodename opoint)
1925 "Go forward in the history of visited nodes."
1930 filename nodename opoint)
1938 ;;;###autoload
1940 "Go to the Info directory node."
1943 \f
1945 "Go to a node with a menu of visited nodes."
1949 p)
1973 "Go to a node with table of contents of the current Info file.
1974 Table of contents is created from the tree structure of menus."
1978 p)
2008 "Insert table of contents with references to nodes."
2020 "Build table of contents from menus of Info FILE and its subfiles."
2025 default-directory))
2028 nodes subfiles)
2040 menu-items)
2049 bound))
2052 ;; Menu item line
2062 ;; Other non-empty strings in the Top node are section names
2071 nodes))
2080 subfiles)))))
2082 main-file nil))
2086 \f
2088 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2089 FOOTNOTENAME may be an abbreviation of the reference name.
2090 If FORK is non-nil (interactively with a prefix arg), show the node in
2091 a new Info buffer. If FORK is a string, it is the name to use for the
2092 new buffer."
2098 ;; Store end and beginning of line.
2107 ;; See if this one should be the default.
2112 ;; See if this one should be the alternate default.
2122 ;; Record as a completion and perhaps as default.
2125 ;; Don't add this string if it's a duplicate.
2128 ;; If no good default was found, try an alternate.
2131 ;; If only one cross-reference found, then make it default.
2137 "Follow reference named (default "
2140 completions nil t)))
2154 ;; Move point to the beginning of reference if point is on reference
2164 ;; Go to the reference closest to point
2172 next-ref prev-ref))
2183 ;; We allow newline because this is also used in Info-follow-reference,
2184 ;; where the xref name might be wrapped over two lines.
2185 "Regexp that matches a menu entry name upto but not including the colon.
2186 Because of ambiguities, this should be concatenated with something like
2206 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2207 ;;; (setq Info-point-loc
2208 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2209 )
2213 ;; If the node name is the menu entry name (using `entry::').
2216 ;; No one calls this.
2217 ;;(defun Info-menu-item-sequence (list)
2218 ;; (while list
2219 ;; (Info-menu (car list))
2220 ;; (setq list (cdr list))))
2232 ;; This uses two dynamically bound variables:
2233 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2234 ;; is the menu of items we're trying to complete.
2235 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2236 ;; also look for menu items in subsequent nodes as long as those
2237 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2238 ;; not used.
2239 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2240 ;; also look for menu items in these nodes. This feature is currently
2241 ;; only used for completion in Info-index.
2243 ;; Note that `Info-complete-menu-buffer' could be current already,
2244 ;; so we want to save point.
2250 nextnode)
2259 completions)
2260 ;; Check the cache.
2268 ;; We can reuse the previous list.
2270 ;; The cache can't be used.
2275 completions))
2276 ;; Check subsequent nodes if applicable.
2284 ;; Go back to the start node (for the next completion).
2287 ;; Update the cache.
2290 Info-complete-next-re string completions
2291 Info-complete-nodes)))
2298 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2299 The menu item should one of those listed in the current node's menu.
2300 Completion is allowed, and the default menu item is the one point is on.
2301 If FORK is non-nil (interactively with a prefix arg), show the node in
2302 a new Info buffer. If FORK is a string, it is the name to use for the
2303 new buffer."
2306 ;; If point is within a menu item, use that item as the default
2309 beg
2322 Info-menu-entry-name-re
2331 default)
2334 ;; we rely on the fact that completing-read accepts an input
2335 ;; of "" even when the require-match argument is true and ""
2336 ;; is not a valid possibility
2340 ;; ask again
2343 ;; there is a problem here in that if several menu items have the same
2344 ;; name you can only go to the node of the first with this command.
2362 ;; If COUNT is nil, use the last item in the menu.
2374 nil))
2378 "Go to the node of the Nth menu item.
2379 N is the digit argument used to invoke this command."
2386 "Go to the Top node of this file."
2391 "Go to the final node in this file."
2396 ;; Go to the last node in the menu of Top.
2398 ;; If the last node in the menu is not last in pointer structure,
2399 ;; move forward until we can't go any farther.
2401 ;; Then keep moving down to last subnode, unless we reach an index.
2407 "Go forward one node, considering all nodes as forming one sequence."
2412 ;; three possibilities, in order of priority:
2413 ;; 1. next node is in a menu in this node (but not in an index)
2414 ;; 2. next node is next at same level
2415 ;; 3. next node is up and next
2420 t)
2423 t)
2425 ;; Use string-equal, not equal, to ignore text props.
2438 "Go backward one node, considering all nodes as forming one sequence."
2446 ;; Use string-equal, not equal,
2447 ;; to ignore text properties.
2452 ;; If we move back at the same level,
2453 ;; go down to find the last subnode*.
2463 "Exit Info by selecting some other buffer."
2470 "Go to the node of the next menu item."
2472 ;; Bind this in case the user sets it to nil.
2484 "Go to the node of the previous menu item."
2488 ;; Bind this in case the user sets it to nil.
2503 "Go to the next subnode or the next node, or go up a level."
2508 ;; Since we have already gone thru all the items in this menu,
2509 ;; go up to the end of this node.
2511 ;; Since logically we are done with the node with that menu,
2512 ;; move on from it.
2518 "Go to the last node, popping up a level if there is none."
2522 ;; If we go down a menu item, go to the end of the node
2523 ;; so we can scroll back through it.
2525 ;; Keep going down, as long as there are nested menu nodes.
2528 ;; If we go down a menu item, go to the end of the node
2529 ;; so we can scroll back through it.
2539 ;; If we go down a menu item, go to the end of the node
2540 ;; so we can scroll back through it.
2551 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2552 Once you scroll far enough in a node that its menu appears on the screen
2553 but after point, the next scroll moves into its first subnode, unless
2554 `Info-scroll-prefer-subnodes' is nil.
2556 When you scroll past the end of a node, that goes to the next node if
2557 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2558 if this node has no successor, it moves to the parent node's successor,
2559 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2560 the menu of a node, it moves to subnode indicated by the following menu
2561 item. (That case won't normally result from this command, but can happen
2562 in other ways.)"
2584 "Scroll one screenful back in Info, considering all nodes as one sequence.
2585 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2586 is non-nil, this goes to its last subnode. When you scroll past the
2587 beginning of a node, that goes to the previous node or back up to the
2588 parent node."
2602 current-point
2603 t)))))
2610 "Move cursor to the next cross-reference or menu item in the node."
2632 "Move cursor to the previous cross-reference or menu item in the node."
2651 \f
2653 "Alist of cached index node names of visited Info files.
2657 "Return a list of names of all index nodes in Info FILE.
2658 If FILE is omitted, it defaults to the current Info file.
2659 First look in a list of cached index node names. Then scan Info
2660 file and its subfiles for nodes with the index cookie. Then try
2661 to find index nodes starting from the first node in the top level
2666 ;; Skip virtual Info files
2671 ;; Find nodes with index cookie
2675 default-directory))
2676 Info-history Info-history-list Info-fontify-maximum-menu-size
2696 subfiles)))))
2698 main-file nil))
2704 nodes)
2705 ;; Else find nodes with the word "Index" in the node name
2707 Info-history Info-history-list Info-fontify-maximum-menu-size
2708 nodes node)
2726 nodes))
2727 ;; If file has no index nodes, still add it to the cache
2732 "Return non-nil value if NODE is an index node.
2733 If NODE is nil, check the current Info node.
2734 If FILE is nil, check the current Info file."
2738 ;; Don't search all index nodes if request is only for the current node
2739 ;; and file is not in the cache of index nodes
2753 "Go to the first index node."
2758 ;;;###autoload
2760 "Look up a string TOPIC in the index for this file.
2761 If there are no exact matches to the specified topic, this chooses
2762 the first match which is a case-insensitive substring of a topic.
2764 Give a blank topic name to go to the Index node itself."
2780 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2789 ;; We bind Info-history to nil for internal node-switches so
2790 ;; that we don't put junk in the history. In the first
2791 ;; Info-goto-index call, above, we do update the history
2792 ;; because that is what the user's previous node choice into it.
2794 found)
2801 Info-current-node
2804 matches))
2811 ;; Here it is a feature that assoc is case-sensitive.
2846 "Move point to the place within the current node where NAME is defined."
2851 ;; Find a function definition with a return type.
2859 nil t))
2861 ;; Try again without the " <1>" makeinfo can append
2867 ;;;###autoload
2869 "Grovel indices of all known Info files on your system for STRING.
2870 Build a menu of the possible matches."
2873 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2879 manuals matches node nodes)
2902 matches)))
2911 Info-history-list ohist-list)
2932 "Make command be undefined in Info."
2937 "Enter the Info tutorial."
2942 "Help-Small-Screen"
2946 "Display a brief summary of all Info commands."
2961 flag))
2964 \f
2966 "Return the token around POS.
2967 POS must be somewhere inside the token
2968 START is a regular expression which will match the
2969 beginning of the tokens delimited string
2970 ALL is a regular expression with a single
2971 parenthesized subpattern which is the token to be
2972 returned. E.g. '{\(.*\)}' would return any string
2973 enclosed in braces around POS.
2974 ERRORSTRING optional fourth argument, controls action on no match
2975 nil: return nil
2976 t: beep
2977 a string: signal an error, using that string."
2981 ;; First look for a match for START that goes across POS.
2985 ;; If we did not find one, search back for START
2986 ;; (this finds only matches that end at or before POS).
2999 nil)
3002 nil)
3008 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3009 At end of the node's text, moves to the next node, or up if none."
3017 "Follow a node reference near point.
3018 If point is on a reference, follow that reference. Otherwise,
3019 if point is in a menu item description, follow that menu item."
3031 t)))
3034 ;; Common subroutine.
3036 "Follow a node reference near point. Return non-nil if successful."
3045 ;; menu item: node name
3048 ;; menu item: node name or index entry
3062 node))
3063 \f
3067 nil
3076 (define-key Info-mode-map "1" 'Info-nth-menu-item)
3077 (define-key Info-mode-map "2" 'Info-nth-menu-item)
3078 (define-key Info-mode-map "3" 'Info-nth-menu-item)
3079 (define-key Info-mode-map "4" 'Info-nth-menu-item)
3080 (define-key Info-mode-map "5" 'Info-nth-menu-item)
3081 (define-key Info-mode-map "6" 'Info-nth-menu-item)
3082 (define-key Info-mode-map "7" 'Info-nth-menu-item)
3083 (define-key Info-mode-map "8" 'Info-nth-menu-item)
3084 (define-key Info-mode-map "9" 'Info-nth-menu-item)
3085 (define-key Info-mode-map "0" 'undefined)
3086 (define-key Info-mode-map "?" 'Info-summary)
3087 (define-key Info-mode-map "]" 'Info-forward-node)
3088 (define-key Info-mode-map "[" 'Info-backward-node)
3089 (define-key Info-mode-map "<" 'Info-top-node)
3090 (define-key Info-mode-map ">" 'Info-final-node)
3091 (define-key Info-mode-map "b" 'beginning-of-buffer)
3092 (define-key Info-mode-map "d" 'Info-directory)
3093 (define-key Info-mode-map "e" 'Info-edit)
3094 (define-key Info-mode-map "f" 'Info-follow-reference)
3095 (define-key Info-mode-map "g" 'Info-goto-node)
3096 (define-key Info-mode-map "h" 'Info-help)
3097 (define-key Info-mode-map "i" 'Info-index)
3098 (define-key Info-mode-map "l" 'Info-history-back)
3099 (define-key Info-mode-map "L" 'Info-history)
3100 (define-key Info-mode-map "m" 'Info-menu)
3101 (define-key Info-mode-map "n" 'Info-next)
3102 (define-key Info-mode-map "p" 'Info-prev)
3103 (define-key Info-mode-map "q" 'Info-exit)
3104 (define-key Info-mode-map "r" 'Info-history-forward)
3105 (define-key Info-mode-map "s" 'Info-search)
3106 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
3107 ;; For consistency with Rmail.
3108 (define-key Info-mode-map "\M-s" 'Info-search)
3109 (define-key Info-mode-map "\M-n" 'clone-buffer)
3110 (define-key Info-mode-map "t" 'Info-top-node)
3111 (define-key Info-mode-map "T" 'Info-toc)
3112 (define-key Info-mode-map "u" 'Info-up)
3113 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3114 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
3115 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
3116 ;; `^' for consistency with `dired-up-directory'.
3117 (define-key Info-mode-map "^" 'Info-up)
3118 (define-key Info-mode-map "," 'Info-index-next)
3120 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
3121 (define-key Info-mode-map [follow-link] 'mouse-face)
3122 )
3124 (defun Info-check-pointer (item)
3125 "Non-nil if ITEM is present in this node."
3126 (condition-case nil
3127 (Info-extract-pointer item)
3128 (error nil)))
3130 (easy-menu-define
3131 Info-mode-menu Info-mode-map
3132 "Menu for Info files."
3133 '("Info"
3134 ["Up" Info-up :active (Info-check-pointer "up")
3135 :help "Go up in the Info tree"]
3136 ["Next" Info-next :active (Info-check-pointer "next")
3137 :help "Go to the next node"]
3138 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3139 :help "Go to the previous node"]
3140 ["Backward" Info-backward-node
3141 :help "Go backward one node, considering all as a sequence"]
3142 ["Forward" Info-forward-node
3143 :help "Go forward one node, considering all as a sequence"]
3144 ["Beginning" beginning-of-buffer
3145 :help "Go to beginning of this node"]
3146 ["Top" Info-top-node
3147 :help "Go to top node of file"]
3148 ["Final Node" Info-final-node
3149 :help "Go to final node in this file"]
3150 ("Menu Item" ["You should never see this" report-emacs-bug t])
3151 ("Reference" ["You should never see this" report-emacs-bug t])
3152 ["Search..." Info-search
3153 :help "Search for regular expression in this Info file"]
3154 ["Search Next" Info-search-next
3155 :help "Search for another occurrence of regular expression"]
3156 ["Go to Node..." Info-goto-node
3157 :help "Go to a named node"]
3158 ["Back in history" Info-history-back :active Info-history
3159 :help "Go back in history to the last node you were at"]
3160 ["Forward in history" Info-history-forward :active Info-history-forward
3161 :help "Go forward in history"]
3162 ["History" Info-history :active Info-history-list
3163 :help "Go to menu of visited nodes"]
3164 ["Table of Contents" Info-toc
3165 :help "Go to table of contents"]
3166 ("Index"
3167 ["Lookup a String..." Info-index
3168 :help "Look for a string in the index items"]
3169 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3170 :help "Look for another occurrence of previous item"]
3171 ["Lookup a string in all indices..." info-apropos
3172 :help "Look for a string in the indices of all manuals"])
3173 ["Copy Node Name" Info-copy-current-node-name
3174 :help "Copy the name of the current node into the kill ring"]
3175 ["Clone Info buffer" clone-buffer
3176 :help "Create a twin copy of the current Info buffer."]
3177 ["Exit" Info-exit :help "Stop reading Info"]))
3180 (defvar info-tool-bar-map
3181 (if (display-graphic-p)
3182 (let ((map (make-sparse-keymap)))
3183 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
3184 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map)
3185 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map)
3186 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3187 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map)
3188 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map)
3189 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3190 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3191 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3192 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3193 map)))
3195 (defvar Info-menu-last-node nil)
3196 ;; Last node the menu was created for.
3197 ;; Value is a list, (FILE-NAME NODE-NAME).
3199 (defun Info-menu-update ()
3200 "Update the Info menu for the current node."
3201 (condition-case nil
3202 (if (or (not (eq major-mode 'Info-mode))
3203 (equal (list Info-current-file Info-current-node)
3204 Info-menu-last-node))
3205 ()
3206 ;; Update menu menu.
3207 (let* ((Info-complete-menu-buffer (current-buffer))
3208 (items (nreverse (condition-case nil
3209 (Info-complete-menu-item "" nil t)
3210 (error nil))))
3211 entries current
3212 (number 0))
3213 (while (and items (< number 9))
3214 (setq current (car items)
3215 items (cdr items)
3216 number (1+ number))
3217 (setq entries (cons `[,current
3218 (Info-menu ,current)
3219 :keys ,(format "%d" number)]
3220 entries)))
3221 (if items
3222 (setq entries (cons ["Other..." Info-menu t] entries)))
3223 (or entries
3224 (setq entries (list ["No menu" nil nil] nil :active)))
3225 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3226 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3227 (let ((items nil)
3228 str i entries current
3229 (number 0)
3230 (case-fold-search t))
3231 (save-excursion
3232 (goto-char (point-min))
3234 (setq str (match-string 1))
3235 (setq i 0)
3237 (setq str (concat (substring str 0 i) " "
3238 (substring str (match-end 0))))
3239 (setq i (1+ i)))
3240 (setq items
3241 (cons str items))))
3242 (while (and items (< number 9))
3243 (setq current (car items)
3244 items (cdr items)
3245 number (1+ number))
3246 (setq entries (cons `[,current
3247 (Info-follow-reference ,current)
3248 t]
3249 entries)))
3250 (if items
3251 (setq entries (cons ["Other..." Info-follow-reference t]
3252 entries)))
3253 (or entries
3254 (setq entries (list ["No references" nil nil] nil :active)))
3255 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3256 ;; Update last seen node.
3257 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3258 ;; Try to avoid entering infinite beep mode in case of errors.
3259 (error (ding))))
3261 \f
3262 (defun Info-copy-current-node-name (&optional arg)
3263 "Put the name of the current Info node into the kill ring.
3264 The name of the Info file is prepended to the node name in parentheses.
3265 With a zero prefix arg, put the name inside a function call to `info'."
3266 (interactive "P")
3267 (unless Info-current-node
3268 (error "No current Info node"))
3269 (let ((node (concat "(" (file-name-nondirectory
3270 (or (and (stringp Info-current-file)
3271 Info-current-file)
3272 buffer-file-name
3273 ""))
3274 ")" Info-current-node)))
3275 (if (zerop (prefix-numeric-value arg))
3277 (kill-new node)
3278 (message "%s" node)))
3280 \f
3281 ;; Info mode is suitable only for specially formatted data.
3282 (put 'Info-mode 'mode-class 'special)
3283 (put 'Info-mode 'no-clone-indirect t)
3285 (defvar tool-bar-map)
3287 ;; Autoload cookie needed by desktop.el
3288 ;;;###autoload
3289 (defun Info-mode ()
3290 "Info mode provides commands for browsing through the Info documentation tree.
3292 one topic and contains references to other nodes which discuss related
3293 topics. Info has commands to follow the references and show you other nodes.
3299 Selecting other nodes:
3301 Follow a node reference you click on.
3302 This works with menu items, cross references, and
3304 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3309 Picking a menu item causes another node to be selected.
3319 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3323 Moving within a node:
3325 Once you scroll far enough in a node that its menu appears on the
3326 screen but after point, the next scroll moves into its first
3327 subnode. When after all menu items (or if there is no menu),
3328 move up to the parent node.
3330 already visible, try to go to the previous menu entry, or up
3331 if there is none.
3334 Advanced commands:
3336 and select the node in which the next occurrence is found.
3337 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3341 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3344 You may include a filename as well, as (FILENAME)NODENAME.
3345 1 .. 9 Pick first ... ninth item in node's menu.
3346 Every third `*' is highlighted to help pick the right number.
3350 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3351 (kill-all-local-variables)
3352 (setq major-mode 'Info-mode)
3353 (setq mode-name "Info")
3354 (setq tab-width 8)
3355 (use-local-map Info-mode-map)
3356 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3357 (set-syntax-table text-mode-syntax-table)
3358 (setq local-abbrev-table text-mode-abbrev-table)
3359 (setq case-fold-search t)
3360 (setq buffer-read-only t)
3361 (make-local-variable 'Info-current-file)
3362 (make-local-variable 'Info-current-subfile)
3363 (make-local-variable 'Info-current-node)
3364 (make-local-variable 'Info-tag-table-marker)
3365 (setq Info-tag-table-marker (make-marker))
3366 (make-local-variable 'Info-tag-table-buffer)
3367 (setq Info-tag-table-buffer nil)
3368 (make-local-variable 'Info-history)
3369 (make-local-variable 'Info-history-forward)
3370 (make-local-variable 'Info-index-alternatives)
3371 (setq header-line-format
3372 (if Info-use-header-line
3373 '(:eval (get-text-property (point-min) 'header-line))
3374 nil)) ; so the header line isn't displayed
3375 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3376 ;; This is for the sake of the invisible text we use handling titles.
3377 (make-local-variable 'line-move-ignore-invisible)
3378 (setq line-move-ignore-invisible t)
3379 (make-local-variable 'desktop-save-buffer)
3380 (make-local-variable 'widen-automatically)
3381 (setq widen-automatically nil)
3382 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3383 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3384 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
3385 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3386 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3387 (set (make-local-variable 'isearch-search-fun-function)
3388 'Info-isearch-search)
3389 (set (make-local-variable 'isearch-wrap-function)
3390 'Info-isearch-wrap)
3391 (set (make-local-variable 'isearch-push-state-function)
3392 'Info-isearch-push-state)
3393 (set (make-local-variable 'search-whitespace-regexp)
3394 Info-search-whitespace-regexp)
3395 (Info-set-mode-line)
3396 (run-mode-hooks 'Info-mode-hook))
3398 ;; When an Info buffer is killed, make sure the associated tags buffer
3399 ;; is killed too.
3400 (defun Info-kill-buffer ()
3401 (and (eq major-mode 'Info-mode)
3402 Info-tag-table-buffer
3403 (kill-buffer Info-tag-table-buffer)))
3405 (defun Info-clone-buffer-hook ()
3406 (when (bufferp Info-tag-table-buffer)
3407 (setq Info-tag-table-buffer
3408 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3409 (let ((m Info-tag-table-marker))
3410 (when (markerp m)
3411 (setq Info-tag-table-marker
3412 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3413 (with-current-buffer Info-tag-table-buffer
3414 (copy-marker (marker-position m)))
3415 (make-marker))))))
3417 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3418 (set-keymap-parent map text-mode-map)
3419 (define-key map "\C-c\C-c" 'Info-cease-edit)
3420 map)
3421 "Local keymap used within `e' command of Info.")
3423 ;; Info-edit mode is suitable only for specially formatted data.
3424 (put 'Info-edit-mode 'mode-class 'special)
3426 (defun Info-edit-mode ()
3427 "Major mode for editing the contents of an Info node.
3428 Like text mode with the addition of `Info-cease-edit'
3429 which returns to Info mode for browsing.
3431 (use-local-map Info-edit-map)
3432 (setq major-mode 'Info-edit-mode)
3433 (setq mode-name "Info Edit")
3434 (kill-local-variable 'mode-line-buffer-identification)
3435 (setq buffer-read-only nil)
3436 (force-mode-line-update)
3437 (buffer-enable-undo (current-buffer))
3438 (run-mode-hooks 'Info-edit-mode-hook))
3440 (defun Info-edit ()
3441 "Edit the contents of this Info node.
3442 Allowed only if variable `Info-enable-edit' is non-nil."
3443 (interactive)
3444 (or Info-enable-edit
3445 (error "Editing Info nodes is not enabled"))
3446 (Info-edit-mode)
3447 (message "%s" (substitute-command-keys
3450 (defun Info-cease-edit ()
3451 "Finish editing Info node; switch back to Info proper."
3452 (interactive)
3453 ;; Do this first, so nothing has changed if user C-g's at query.
3454 (and (buffer-modified-p)
3455 (y-or-n-p "Save the file? ")
3456 (save-buffer))
3457 (use-local-map Info-mode-map)
3458 (setq major-mode 'Info-mode)
3459 (setq mode-name "Info")
3460 (Info-set-mode-line)
3461 (setq buffer-read-only t)
3462 (force-mode-line-update)
3463 (and (marker-position Info-tag-table-marker)
3464 (buffer-modified-p)
3465 (message "Tags may have changed. Use Info-tagify if necessary")))
3466 \f
3467 (defvar Info-file-list-for-emacs
3468 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3469 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3470 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3471 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3472 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3473 ("copyright" . "autotype") ("executable" . "autotype")
3474 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3475 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3476 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3477 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3478 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3479 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3480 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3481 ("rfc2045" . "emacs-mime")
3482 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3483 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3484 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3485 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3486 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3487 ("mml" . "emacs-mime"))
3488 "List of Info files that describe Emacs commands.
3489 An element can be a file name, or a list of the form (PREFIX . FILE)
3490 where PREFIX is a name prefix and FILE is the file to look in.
3491 If the element is just a file name, the file name also serves as the prefix.")
3493 (defun Info-find-emacs-command-nodes (command)
3494 "Return a list of locations documenting COMMAND.
3495 The `info-file' property of COMMAND says which Info manual to search.
3496 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3497 defines heuristics for which Info manual to try.
3498 The locations are of the format used in `Info-history', i.e.
3499 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3500 in the first element of the returned list (which is treated specially in
3501 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3502 (let ((where '()) line-number
3506 (info-file "emacs")) ;default
3507 ;; Determine which Info file this command is documented in.
3508 (if (get command 'info-file)
3509 (setq info-file (get command 'info-file))
3510 ;; If it doesn't say explicitly, test its name against
3511 ;; various prefixes that we know.
3512 (let ((file-list Info-file-list-for-emacs))
3513 (while file-list
3514 (let* ((elt (car file-list))
3515 (name (if (consp elt)
3516 (car elt)
3517 elt))
3518 (file (if (consp elt) (cdr elt) elt))
3519 (case-fold-search nil)
3522 (if (string-match regexp (symbol-name command))
3523 (setq info-file file file-list nil))
3524 (setq file-list (cdr file-list))))))
3525 (Info-find-node info-file "Top")
3526 ;; Bind Info-history to nil, to prevent the index nodes from
3527 ;; getting into the node history.
3528 (let ((Info-history nil)
3529 (Info-history-list nil)
3530 node (nodes (Info-index-nodes)))
3531 (Info-goto-node (car nodes))
3532 (while
3533 (progn
3534 (goto-char (point-min))
3535 (while (re-search-forward cmd-desc nil t)
3536 (setq where
3537 (cons (list Info-current-file
3538 (match-string-no-properties 2)
3539 0)
3540 where))
3541 (setq line-number (and (match-beginning 3)
3542 (string-to-number (match-string 3)))))
3543 (and (setq nodes (cdr nodes) node (car nodes))))
3544 (Info-goto-node node)))
3545 (if (and line-number where)
3546 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3547 (cdr where))
3548 where)))
3550 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3551 ;;;###autoload
3552 (defun Info-goto-emacs-command-node (command)
3553 "Go to the Info node in the Emacs manual for command COMMAND.
3554 The command is found by looking up in Emacs manual's indices
3555 or in another manual found via COMMAND's `info-file' property or
3556 the variable `Info-file-list-for-emacs'.
3557 COMMAND must be a symbol or string."
3558 (interactive "CFind documentation for command: ")
3559 ;; If command is given as a string, convert it to a symbol.
3560 (if (stringp command)
3561 (setq command (intern command)))
3562 (or (commandp command)
3563 (signal 'wrong-type-argument (list 'commandp command)))
3564 (let ((where (Info-find-emacs-command-nodes command)))
3565 (if where
3566 (let ((num-matches (length where)))
3567 ;; Get Info running, and pop to it in another window.
3568 (save-window-excursion
3569 (info))
3570 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3571 ;; Bind Info-history to nil, to prevent the last Index node
3572 ;; visited by Info-find-emacs-command-nodes from being
3573 ;; pushed onto the history.
3574 (let ((Info-history nil) (Info-history-list nil)
3575 (line-number (nth 2 (car where))))
3576 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3577 (if (and (integerp line-number) (> line-number 0))
3578 (forward-line (1- line-number))))
3579 (if (> num-matches 1)
3580 (progn
3581 ;; (car where) will be pushed onto Info-history
3582 ;; when/if they go to another node. Put the other
3583 ;; nodes that were found on the history.
3584 (setq Info-history (nconc (cdr where) Info-history))
3585 (message "Found %d other entr%s. Use %s to see %s."
3586 (1- num-matches)
3587 (if (> num-matches 2) "ies" "y")
3589 (if (> num-matches 2) "them" "it")))))
3590 (error "Couldn't find documentation for %s" command))))
3592 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3593 ;;;###autoload
3594 (defun Info-goto-emacs-key-command-node (key)
3595 "Go to the node in the Emacs manual which describes the command bound to KEY.
3596 KEY is a string.
3597 Interactively, if the binding is `execute-extended-command', a command is read.
3598 The command is found by looking up in Emacs manual's indices
3599 or in another manual found via COMMAND's `info-file' property or
3600 the variable `Info-file-list-for-emacs'."
3601 (interactive "kFind documentation for key: ")
3602 (let ((command (key-binding key)))
3603 (cond ((null command)
3604 (message "%s is undefined" (key-description key)))
3605 ((and (interactive-p)
3606 (eq command 'execute-extended-command))
3607 (Info-goto-emacs-command-node
3608 (read-command "Find documentation for command: ")))
3609 (t
3610 (Info-goto-emacs-command-node command)))))
3611 \f
3612 (defvar Info-next-link-keymap
3613 (let ((keymap (make-sparse-keymap)))
3614 (define-key keymap [header-line mouse-1] 'Info-next)
3615 (define-key keymap [header-line mouse-2] 'Info-next)
3616 (define-key keymap [header-line down-mouse-1] 'ignore)
3617 (define-key keymap [mouse-2] 'Info-next)
3618 (define-key keymap [follow-link] 'mouse-face)
3619 keymap)
3620 "Keymap to put on the Next link in the text or the header line.")
3622 (defvar Info-prev-link-keymap
3623 (let ((keymap (make-sparse-keymap)))
3624 (define-key keymap [header-line mouse-1] 'Info-prev)
3625 (define-key keymap [header-line mouse-2] 'Info-prev)
3626 (define-key keymap [header-line down-mouse-1] 'ignore)
3627 (define-key keymap [mouse-2] 'Info-prev)
3628 (define-key keymap [follow-link] 'mouse-face)
3629 keymap)
3630 "Keymap to put on the Prev link in the text or the header line.")
3632 (defvar Info-up-link-keymap
3633 (let ((keymap (make-sparse-keymap)))
3634 (define-key keymap [header-line mouse-1] 'Info-up)
3635 (define-key keymap [header-line mouse-2] 'Info-up)
3636 (define-key keymap [header-line down-mouse-1] 'ignore)
3637 (define-key keymap [mouse-2] 'Info-up)
3638 (define-key keymap [follow-link] 'mouse-face)
3639 keymap)
3640 "Keymap to put on the Up link in the text or the header line.")
3642 (defun Info-fontify-node ()
3643 "Fontify the node."
3644 (save-excursion
3645 (let* ((inhibit-read-only t)
3646 (case-fold-search t)
3647 paragraph-markers
3648 (not-fontified-p ; the node hasn't already been fontified
3649 (not (let ((where (next-property-change (point-min))))
3650 (and where (not (= where (point-max)))))))
3651 (fontify-visited-p ; visited nodes need to be re-fontified
3652 (and Info-fontify-visited-nodes
3653 ;; Don't take time to refontify visited nodes in huge nodes
3654 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3655 rbeg rend)
3657 ;; Fontify header line
3658 (goto-char (point-min))
3660 (goto-char (match-end 0))
3662 (goto-char (match-end 0))
3663 (let* ((nbeg (match-beginning 2))
3664 (nend (match-end 2))
3665 (tbeg (match-beginning 1))
3666 (tag (match-string 1)))
3667 (if (string-equal (downcase tag) "node")
3668 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3669 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3670 (put-text-property tbeg nend 'mouse-face 'highlight)
3671 (put-text-property tbeg nend
3672 'help-echo
3673 (concat "mouse-2: Go to node "
3674 (buffer-substring nbeg nend)))
3675 ;; Always set up the text property keymap.
3676 ;; It will either be used in the buffer
3677 ;; or copied in the header line.
3678 (put-text-property
3679 tbeg nend 'keymap
3680 (cond
3681 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3682 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3683 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3684 (when Info-use-header-line
3685 (goto-char (point-min))
3686 (let* ((header-end (line-end-position))
3687 (header
3688 ;; If we find neither Next: nor Prev: link, show the entire
3689 ;; node header. Otherwise, don't show the File: and Node:
3690 ;; parts, to avoid wasting precious space on information that
3691 ;; is available in the mode line.
3692 (if (re-search-forward
3694 header-end t)
3695 (progn
3696 (goto-char (match-beginning 1))
3697 (buffer-substring (point) header-end))
3699 header-end t)
3700 (concat "No next, prev or up links -- "
3701 (buffer-substring (point) header-end))
3702 (buffer-substring (point) header-end)))))
3703 (put-text-property (point-min) (1+ (point-min))
3704 'header-line
3705 (replace-regexp-in-string
3706 "%"
3707 ;; Preserve text properties on duplicated `%'.
3708 (lambda (s) (concat s s)) header))
3709 ;; Hide the part of the first line
3710 ;; that is in the header, if it is just part.
3711 (unless (bobp)
3712 ;; Hide the punctuation at the end, too.
3714 (put-text-property (point) header-end 'invisible t)))))
3716 ;; Fontify titles
3717 (goto-char (point-min))
3718 (when (and font-lock-mode not-fontified-p)
3720 nil t)
3721 ;; Only consider it as an underlined title if the ASCII
3722 ;; underline has the same size as the text. A typical
3723 ;; counter example is when a continuation "..." is alone
3724 ;; on a line.
3725 (= (string-width (match-string 1))
3726 (string-width (match-string 2))))
3727 (let* ((c (preceding-char))
3728 (face
3729 (cond ((= c ?*) 'info-title-1)
3730 ((= c ?=) 'info-title-2)
3731 ((= c ?-) 'info-title-3)
3732 (t 'info-title-4))))
3733 (put-text-property (match-beginning 1) (match-end 1)
3734 'font-lock-face face))
3735 ;; This is a serious problem for trying to handle multiple
3736 ;; frame types at once. We want this text to be invisible
3737 ;; on frames that can display the font above.
3738 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3739 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3740 '(invisible t front-sticky nil rear-nonsticky t)))))
3742 ;; Fontify cross references
3743 (goto-char (point-min))
3744 (when (or not-fontified-p fontify-visited-p)
3745 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3746 (let ((start (match-beginning 0))
3747 (next (point))
3748 other-tag)
3749 (when not-fontified-p
3750 (when Info-hide-note-references
3751 (when (not (eq Info-hide-note-references 'hide))
3752 ;; *Note is often used where *note should have been
3753 (goto-char start)
3754 (skip-syntax-backward " ")
3755 (when (memq (char-before) '(?\( ?\[ ?\{))
3756 ;; Check whether the paren is preceded by
3757 ;; an end of sentence
3758 (skip-syntax-backward " ("))
3759 (setq other-tag
3761 "")
3762 ((memq (char-before) '(nil ?\. ?! ??))
3763 "See ")
3764 ((save-match-data
3765 (save-excursion
3767 "See ")
3768 (t "see "))))
3769 (goto-char next)
3770 (add-text-properties
3771 (match-beginning 1)
3772 (or (save-match-data
3774 (let ((start1 (match-beginning 1)))
3776 (+ start1 (match-beginning 0)))))
3777 (match-end 1))
3778 (if other-tag
3779 `(display ,other-tag front-sticky nil rear-nonsticky t)
3780 '(invisible t front-sticky nil rear-nonsticky t))))
3781 (add-text-properties
3782 (match-beginning 2) (match-end 2)
3783 (list
3784 'help-echo (if (or (match-end 5)
3785 (not (equal (match-string 4) "")))
3786 (concat "mouse-2: go to " (or (match-string 5)
3787 (match-string 4)))
3788 "mouse-2: go to this node")
3789 'mouse-face 'highlight)))
3790 (when (or not-fontified-p fontify-visited-p)
3791 (setq rbeg (match-beginning 2)
3792 rend (match-end 2))
3793 (put-text-property
3794 rbeg rend
3795 'font-lock-face
3796 ;; Display visited nodes in a different face
3797 (if (and Info-fontify-visited-nodes
3798 (save-match-data
3799 (let* ((node (replace-regexp-in-string
3801 (replace-regexp-in-string
3803 (or (match-string 5)
3804 (and (not (equal (match-string 4) ""))
3805 (match-string 4))
3806 (match-string 2)))))
3807 (file (file-name-nondirectory
3808 Info-current-file))
3809 (hl Info-history-list)
3810 res)
3812 (setq file (file-name-nondirectory
3813 (match-string 1 node))
3814 node (if (equal (match-string 2 node) "")
3815 "Top"
3816 (match-string 2 node))))
3817 (while hl
3818 (if (and (string-equal node (nth 1 (car hl)))
3819 (string-equal file
3820 (file-name-nondirectory
3821 (nth 0 (car hl)))))
3822 (setq res (car hl) hl nil)
3823 (setq hl (cdr hl))))
3824 res))) 'info-xref-visited 'info-xref))
3825 ;; For multiline ref, unfontify newline and surrounding whitespace
3826 (save-excursion
3827 (goto-char rbeg)
3828 (save-match-data
3830 (remove-text-properties (match-beginning 0)
3831 (match-end 0)
3832 '(font-lock-face t))))))
3833 (when not-fontified-p
3834 (when (memq Info-hide-note-references '(t hide))
3835 (add-text-properties (match-beginning 3) (match-end 3)
3836 '(invisible t front-sticky nil rear-nonsticky t))
3837 ;; Unhide the file name of the external reference in parens
3838 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3839 (remove-text-properties (match-beginning 6) (match-end 6)
3840 '(invisible t front-sticky nil rear-nonsticky t)))
3841 ;; Unhide newline because hidden newlines cause too long lines
3842 (save-match-data
3843 (let ((beg3 (match-beginning 3))
3844 (end3 (match-end 3)))
3846 (not (save-match-data
3847 (save-excursion
3848 (goto-char (1+ end3))
3849 (looking-at "[.)]*$")))))
3850 (remove-text-properties (+ beg3 (match-beginning 0))
3851 (+ beg3 (match-end 0))
3852 '(invisible t front-sticky nil rear-nonsticky t))))))
3853 (when (and Info-refill-paragraphs Info-hide-note-references)
3854 (push (set-marker (make-marker) start)
3855 paragraph-markers))))))
3857 ;; Refill paragraphs (experimental feature)
3858 (when (and not-fontified-p
3859 Info-refill-paragraphs
3860 paragraph-markers)
3861 (let ((fill-nobreak-invisible t)
3862 (fill-individual-varying-indent nil)
3865 (adaptive-fill-mode nil))
3866 (goto-char (point-max))
3867 (dolist (m paragraph-markers)
3868 (when (< m (point))
3869 (goto-char m)
3870 (beginning-of-line)
3871 (let ((beg (point)))
3872 (when (zerop (forward-paragraph))
3873 (fill-individual-paragraphs beg (point) nil nil)
3874 (goto-char beg))))
3875 (set-marker m nil))))
3877 ;; Fontify menu items
3878 (goto-char (point-min))
3879 (when (and (or not-fontified-p fontify-visited-p)
3881 (not (Info-index-node))
3882 ;; Don't take time to annotate huge menus
3883 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3884 (let ((n 0)
3885 cont)
3886 (while (re-search-forward
3889 nil t)
3890 (when (match-beginning 1)
3891 (when not-fontified-p
3892 (setq n (1+ n))
3893 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3894 (put-text-property (match-beginning 0)
3895 (1+ (match-beginning 0))
3896 'font-lock-face 'info-menu-star)))
3897 (when not-fontified-p
3898 (add-text-properties
3899 (match-beginning 1) (match-end 1)
3900 (list
3901 'help-echo (if (and (match-end 3)
3902 (not (equal (match-string 3) "")))
3903 (concat "mouse-2: go to " (match-string 3))
3904 "mouse-2: go to this node")
3905 'mouse-face 'highlight)))
3906 (when (or not-fontified-p fontify-visited-p)
3907 (put-text-property
3908 (match-beginning 1) (match-end 1)
3909 'font-lock-face
3910 ;; Display visited menu items in a different face
3911 (if (and Info-fontify-visited-nodes
3912 (save-match-data
3913 (let ((node (if (equal (match-string 3) "")
3914 (match-string 1)
3915 (match-string 3)))
3916 (file (file-name-nondirectory Info-current-file))
3917 (hl Info-history-list)
3918 res)
3920 (setq file (file-name-nondirectory
3921 (match-string 1 node))
3922 node (if (equal (match-string 2 node) "")
3923 "Top"
3924 (match-string 2 node))))
3925 (while hl
3926 (if (and (string-equal node (nth 1 (car hl)))
3927 (string-equal file
3928 (file-name-nondirectory
3929 (nth 0 (car hl)))))
3930 (setq res (car hl) hl nil)
3931 (setq hl (cdr hl))))
3932 res))) 'info-xref-visited 'info-xref)))
3933 (when (and not-fontified-p (memq Info-hide-note-references '(t hide)))
3934 (put-text-property (match-beginning 2) (1- (match-end 6))
3935 'invisible t)
3936 ;; Unhide the file name in parens
3937 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
3938 (remove-text-properties (match-beginning 4) (match-end 4)
3939 '(invisible t)))
3940 ;; We need a stretchable space like :align-to but with
3941 ;; a minimum value.
3942 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3943 (if (>= 22 (- (match-end 1)
3944 (match-beginning 0)))
3945 '(space :align-to 24)
3946 '(space :width 2)))
3947 (setq cont (looking-at "."))
3948 (while (and (= (forward-line 1) 0)
3950 (put-text-property (match-beginning 1) (1- (match-end 1))
3951 'invisible t)
3952 (put-text-property (1- (match-end 1)) (match-end 1)
3953 'display
3954 (if cont
3955 '(space :align-to 26)
3956 '(space :align-to 24)))
3957 (setq cont t)))))))
3959 ;; Fontify menu headers
3960 ;; Add the face `info-menu-header' to any header before a menu entry
3961 (goto-char (point-min))
3963 (put-text-property (match-beginning 0) (match-end 0)
3964 'font-lock-face 'info-menu-header)
3966 (put-text-property (match-beginning 1) (match-end 1)
3967 'font-lock-face 'info-menu-header)))
3969 ;; Hide index line numbers
3970 (goto-char (point-min))
3971 (when (and not-fontified-p (Info-index-node))
3973 (put-text-property (match-beginning 0) (match-end 0)
3974 'invisible t)))
3976 ;; Fontify http and ftp references
3977 (goto-char (point-min))
3978 (when not-fontified-p
3980 (add-text-properties (match-beginning 0) (match-end 0)
3981 '(font-lock-face info-xref
3982 mouse-face highlight
3983 help-echo "mouse-2: go to this URL"))))
3985 (set-buffer-modified-p nil))))
3986 \f
3987 ;;; Speedbar support:
3988 ;; These functions permit speedbar to display the "tags" in the
3989 ;; current Info node.
3990 (eval-when-compile (require 'speedbar))
3992 (defvar Info-speedbar-key-map nil
3993 "Keymap used when in the info display mode.")
3995 (defun Info-install-speedbar-variables ()
3996 "Install those variables used by speedbar to enhance Info."
3997 (if Info-speedbar-key-map
3998 nil
3999 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4001 ;; Basic tree features
4002 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4003 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4004 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4005 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4006 )
4008 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4009 Info-speedbar-key-map
4010 Info-speedbar-hierarchy-buttons)))
4012 (defvar Info-speedbar-menu-items
4013 '(["Browse Node" speedbar-edit-line t]
4014 ["Expand Node" speedbar-expand-line
4015 (save-excursion (beginning-of-line)
4017 ["Contract Node" speedbar-contract-line
4018 (save-excursion (beginning-of-line)
4019 (looking-at "[0-9]+: *.-. "))]
4020 )
4021 "Additional menu-items to add to speedbar frame.")
4023 ;; Make sure our special speedbar major mode is loaded
4024 (if (featurep 'speedbar)
4025 (Info-install-speedbar-variables)
4026 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4028 ;;; Info hierarchy display method
4029 ;;;###autoload
4030 (defun Info-speedbar-browser ()
4031 "Initialize speedbar to display an Info node browser.
4032 This will add a speedbar major display mode."
4033 (interactive)
4034 (require 'speedbar)
4035 ;; Make sure that speedbar is active
4036 (speedbar-frame-mode 1)
4037 ;; Now, throw us into Info mode on speedbar.
4038 (speedbar-change-initial-expansion-list "Info")
4039 )
4041 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4042 "Display an Info directory hierarchy in speedbar.
4043 DIRECTORY is the current directory in the attached frame.
4044 DEPTH is the current indentation depth.
4045 NODE is an optional argument that is used to represent the
4046 specific node to expand."
4047 (if (and (not node)
4048 (save-excursion (goto-char (point-min))
4049 (let ((case-fold-search t))
4050 (looking-at "Info Nodes:"))))
4051 ;; Update our "current node" maybe?
4052 nil
4053 ;; We cannot use the generic list code, that depends on all leaves
4054 ;; being known at creation time.
4055 (if (not node)
4057 (let ((completions nil))
4058 (speedbar-select-attached-frame)
4059 (save-window-excursion
4060 (setq completions
4061 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4062 (select-frame (speedbar-current-frame))
4063 (if completions
4064 (speedbar-with-writable
4065 (dolist (completion completions)
4066 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4067 (cdr completion)
4068 (car completion)
4069 'Info-speedbar-goto-node
4070 (cdr completion)
4071 'info-xref depth))
4072 t)
4073 nil))))
4075 (defun Info-speedbar-goto-node (text node indent)
4076 "When user clicks on TEXT, go to an info NODE.
4077 The INDENT level is ignored."
4078 (speedbar-select-attached-frame)
4079 (let* ((buff (or (get-buffer "*info*")
4080 (progn (info) (get-buffer "*info*"))))
4081 (bwin (get-buffer-window buff 0)))
4082 (if bwin
4083 (progn
4084 (select-window bwin)
4085 (raise-frame (window-frame bwin)))
4086 (if speedbar-power-click
4087 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4088 (speedbar-select-attached-frame)
4089 (switch-to-buffer buff)))
4091 (error "Invalid node %s" node)
4092 (Info-find-node (match-string 1 node) (match-string 2 node))
4093 ;; If we do a find-node, and we were in info mode, restore
4094 ;; the old default method. Once we are in info mode, it makes
4095 ;; sense to return to whatever method the user was using before.
4096 (if (string= speedbar-initial-expansion-list-name "Info")
4097 (speedbar-change-initial-expansion-list
4098 speedbar-previously-used-expansion-list-name)))))
4100 (defun Info-speedbar-expand-node (text token indent)
4101 "Expand the node the user clicked on.
4102 TEXT is the text of the button we clicked on, a + or - item.
4103 TOKEN is data related to this node (NAME . FILE).
4104 INDENT is the current indentation depth."
4105 (cond ((string-match "+" text) ;we have to expand this file
4106 (speedbar-change-expand-button-char ?-)
4107 (if (speedbar-with-writable
4108 (save-excursion
4109 (end-of-line) (forward-char 1)
4110 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4111 (speedbar-change-expand-button-char ?-)
4112 (speedbar-change-expand-button-char ??)))
4113 ((string-match "-" text) ;we have to contract this node
4114 (speedbar-change-expand-button-char ?+)
4115 (speedbar-delete-subblock indent))
4116 (t (error "Ooops... not sure what to do")))
4117 (speedbar-center-buffer-smartly))
4119 (defun Info-speedbar-fetch-file-nodes (nodespec)
4120 "Fetch the subnodes from the info NODESPEC.
4121 NODESPEC is a string of the form: (file)node."
4122 (save-excursion
4123 ;; Set up a buffer we can use to fake-out Info.
4124 (set-buffer (get-buffer-create "*info-browse-tmp*"))
4125 (if (not (equal major-mode 'Info-mode))
4126 (Info-mode))
4127 ;; Get the node into this buffer
4129 (error "Invalid node specification %s" nodespec)
4130 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4131 ;; Scan the created buffer
4132 (goto-char (point-min))
4133 (let ((completions nil)
4134 (case-fold-search t)
4136 (match-string 1 nodespec))))
4137 ;; Always skip the first one...
4140 (let ((name (match-string 1)))
4141 (push (cons name
4143 (match-string 1)
4145 (concat (match-string 1) "Top")
4146 (concat "(" thisfile ")"
4148 (match-string 1)
4149 name)))))
4150 completions)))
4151 (nreverse completions))))
4153 ;;; Info mode node listing
4154 ;; This is called by `speedbar-add-localized-speedbar-support'
4155 (defun Info-speedbar-buttons (buffer)
4156 "Create a speedbar display to help navigation in an Info file.
4157 BUFFER is the buffer speedbar is requesting buttons for."
4158 (if (save-excursion (goto-char (point-min))
4159 (let ((case-fold-search t))
4160 (not (looking-at "Info Nodes:"))))
4161 (erase-buffer))
4162 (Info-speedbar-hierarchy-buttons nil 0))
4164 (dolist (mess '("^First node in file$"
4165 "^No `.*' in index$"
4166 "^No cross-reference named"
4167 "^No cross.references in this node$"
4168 "^No current Info node$"
4169 "^No menu in this node$"
4170 "^No more items in menu$"
4171 "^No more nodes$"
4173 "^No previous `i' command$"
4174 "^No previous items in menu$"
4175 "^No previous nodes$"
4176 "^No such item in menu$"
4177 "^No such node or anchor"
4178 "^Node has no"
4179 "^Point neither on reference nor in menu item description$"
4181 search-failed))
4182 (add-to-list 'debug-ignored-errors mess))
4184 ;;;; Desktop support
4186 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4187 "Auxiliary information to be saved in desktop file."
4188 (if (not (member Info-current-file '("apropos" "history" "toc")))
4189 (list Info-current-file Info-current-node)))
4191 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4192 desktop-buffer-name
4193 desktop-buffer-misc)
4194 "Restore an Info buffer specified in a desktop file."
4195 (let ((first (nth 0 desktop-buffer-misc))
4196 (second (nth 1 desktop-buffer-misc)))
4197 (when (and first second)
4198 (when desktop-buffer-name
4199 (set-buffer (get-buffer-create desktop-buffer-name))
4200 (Info-mode))
4201 (Info-find-node first second)
4202 (current-buffer))))
4204 (add-to-list 'desktop-buffer-mode-handlers
4205 '(Info-mode . Info-restore-desktop-buffer))
4207 (provide 'info)
4209 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4210 ;;; info.el ends here