| blob | 43ee5cabcbc73d1fc87819da92791d7d53041931 |
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, 2006 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."
133 "Face for unvisited Info cross-references."
138 "Face for visited Info cross-references."
143 "*Non-nil to fontify references to visited nodes in `info-xref-visited' face."
149 "*Maximum size of menu to fontify if `font-lock-mode' is non-nil."
154 "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
155 A header-line does not scroll with the rest of the buffer."
161 "Face for Info cross-references in a node header."
166 "Face for Info nodes in a node header."
170 "List of directories to search for Info documentation files.
171 If nil, meaning not yet initialized, Info uses the environment
172 variable INFOPATH to initialize it, or `Info-default-directory-list'
173 if there is no INFOPATH variable in the environment, or the
174 concatenation of the two if INFOPATH ends with a colon.
176 When `Info-directory-list' is initialized from the value of
177 `Info-default-directory-list', and Emacs is installed in one of the
178 standard directories, the directory of Info files that come with Emacs
179 is put last (so that local Info files override standard ones).
181 When `Info-directory-list' is initialized from the value of
182 `Info-default-directory-list', and Emacs is not installed in one
183 of the standard directories, the first element of the resulting
184 list is the directory where Emacs installs the Info files that
185 come with it. This is so that Emacs's own manual, which suits the
186 version of Emacs you are using, will always be found first. This
187 is useful when you install an experimental version of Emacs without
188 removing the standard installation.
190 If you want to override the order of directories in
191 `Info-default-directory-list', set INFOPATH in the environment.
193 If you run the Emacs executable from the `src' directory in the Emacs
194 source tree, and INFOPATH is not defined, the `info' directory in the
195 source tree is used as the first element of `Info-directory-list', in
196 place of the installation Info directory. This is useful when you run
200 "List of additional directories to search for Info documentation files.
201 These directories are searched after those in `Info-directory-list'."
208 If this is non-nil, and you scroll far enough in a node that its menu
210 moves to a subnode indicated by the following menu item. This means
211 that you visit a subnode before getting to the end of the menu.
213 Setting this option to nil results in behavior similar to the stand-alone
214 Info reader program, which visits the first subnode from the menu only
215 when you hit the end of the current node."
221 "*If non-nil, hide the tag and section reference in *note and * menu items.
223 If value is non-nil but not t or `hide', the reference section is still shown.
224 `nil' completely disables this feature."
233 "*If non-nil, attempt to refill paragraphs with hidden references.
234 This refilling may accidentally remove explicit line breaks in the Info
235 file, so be prepared for a few surprises if you enable this feature."
241 "*If non-nil, regular expression to match a sequence of whitespace chars.
242 This applies to Info search for regular expressions.
244 In the Customization buffer, that is `[' followed by a space,
245 a tab, a carriage return (control-M), a newline, and `]+'."
250 "*If non-nil, isearch in Info searches through multiple nodes.
251 Before leaving the initial Info node, where isearch was started,
252 it fails once with the error message [initial node], and with
253 subsequent C-s/C-r continues through other nodes without failing
254 with this error message in other nodes. When isearch fails for
255 the rest of the manual, it wraps aroung the whole manual and
256 restarts the search from the top/final node depending on
257 search direction.
259 Setting this option to nil restores the default isearch behavior
260 with wrapping around the current Info node."
268 ;; Try to obey obsolete Info-fontify settings.
271 "Hooks run when `Info-mode' is called."
276 "Hooks run when `Info-select-node' is called."
284 "Info file that Info is now looking at, or nil.
285 This is the name that was specified in Info, not the actual file name.
289 "Info subfile that is actually in the *info* buffer now.
296 "Marker pointing at beginning of current Info file's tag table.
312 "Point location within a selected node.
313 If string, the point is moved to the proper occurrence of the
314 name of the followed cross reference within a selected node.
319 \f
321 ;; The MS-DOS list should work both when long file names are
322 ;; supported (Windows 9X), and when only 8+3 file names are available.
364 "List of file name suffixes and associated decoding commands.
365 Each entry should be (SUFFIX . STRING); the file is given to
366 the command as standard input.
368 STRING may be a list of strings. In that case, the first element is
369 the command name, and the rest are arguments to that command.
371 If STRING is nil, no decoding is done.
372 Because the SUFFIXes are tried in order, the empty string should
375 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
376 ;; First, on MS-DOS with no long file names support, delete some of
377 ;; the extension in FILENAME to make room.
382 ;; How long is the extension in FILENAME (not counting the dot).
384 ext-left)
385 ;; SUFFIX starts with a dot. If FILENAME already has one,
386 ;; get rid of the one in SUFFIX (unless suffix is empty).
391 ;; How many chars of that extension should we keep?
393 ;; Get rid of the rest of the extension, and add SUFFIX.
396 suffix))))
403 "Insert the contents of an Info file in the current buffer.
404 Do the right thing if the file has been compressed or zipped."
408 t))
410 lfn))
411 fullname decoder done)
413 ;; FILENAME exists--see if that name contains a suffix.
414 ;; If so, set DECODE accordingly.
419 filename)))
423 ;; Try adding suffixes to FILENAME and see if we can find something.
429 ;; If we found a file with a suffix, set DECODER
430 ;; according to the suffix.
432 ;; When the MS-DOS port runs on Windows, we need to check
433 ;; the short variant of a long file name as well.
443 ;; check for conflict with jka-compr
453 default-directory)))
459 \f
466 "../info/"
467 invocation-directory)))
469 infodir
471 "../../../info/"
472 invocation-directory))
474 infodir))))))
475 alternative)
478 ;; Uninstalled, Emacs builddir != srcdir.
479 sibling
480 ;; Uninstalled, builddir == srcdir
481 source))
483 ;; On DOS/NT, we use movable executables always,
484 ;; and we must always find the Info dir at run time.
486 nil
487 ;; Use invocation-directory for Info
488 ;; only if we used it for exec-directory also.
491 installation-directory))))
493 Info-default-directory-list
494 ;; `alternative' contains the Info files that came with this
495 ;; version, so we should look there first. `Info-insert-dir'
496 ;; currently expects to find `alternative' first on the list.
498 ;; Don't drop the last part, it might contain non-Emacs stuff.
499 ;; (reverse (cdr (reverse
503 "Initialize `Info-directory-list', if that hasn't been done yet."
516 ;;;###autoload
518 "Like `info' but show the Info buffer in another window."
524 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
526 ;;;###autoload (put 'info 'info-file "emacs")
527 ;;;###autoload
529 "Enter Info, the documentation browser.
530 Optional argument FILE-OR-NODE specifies the file to examine;
531 the default is the top-level directory of Info.
532 Called from a program, FILE-OR-NODE may specify an Info node of the form
533 `(FILENAME)NODENAME'.
534 Optional argument BUFFER specifies the Info buffer name;
535 the default buffer name is *info*. If BUFFER exists,
536 just switch to BUFFER. Otherwise, create a new buffer
537 with the top-level Info directory.
539 In interactive use, a non-numeric prefix argument directs
540 this command to read a file name from the minibuffer.
541 A numeric prefix argument selects an Info buffer with the prefix number
542 appended to the Info buffer name.
544 The search path for Info files is in the variable `Info-directory-list'.
545 The top-level Info directory is made by combining all the files named `dir'
546 in all the directories in that path."
556 ;; If argument already contains parentheses, don't add another set
557 ;; since the argument will then be parsed improperly. This also
558 ;; has the added benefit of allowing node names to be included
559 ;; following the parenthesized filename.
562 file-or-node
566 ;; If we just created the Info buffer, go to the directory.
569 ;;;###autoload
571 "Display the Emacs manual in Info mode."
575 ;;;###autoload
577 "Run Emacs as a standalone Info reader.
578 Usage: emacs -f info-standalone [filename]
592 \f
593 ;; See if the accessible portion of the buffer begins with a node
594 ;; delimiter, and the node header line which follows matches REGEXP.
595 ;; Typically, this test will be followed by a loop that examines the
596 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
597 ;; to have the overhead of this special test inside the loop.
599 ;; This function changes match-data, but supposedly the caller might
600 ;; want to use the results of re-search-backward.
602 ;; The return value is the value of point at the beginning of matching
603 ;; REGEXP, if the function succeeds, nil otherwise.
615 Optional second argument NOERROR, if t, means if file is not found
616 just return nil (no error)."
617 ;; Convert filename to lower case if not found as specified.
618 ;; Expand it.
627 ;; If specified name starts with `./'
628 ;; then just try current directory.
631 ;; No point in searching for an
632 ;; absolute file name
636 Info-additional-directory-list)
637 Info-directory-list)))))
638 ;; Search the directory list for file FILENAME.
643 ;; Try several variants of specified name.
647 t)))
658 lfn
670 filename)
674 "Go to an Info node specified as separate FILENAME and NODENAME.
675 NO-GOING-BACK is non-nil if recovering from an error in this function;
676 it says do not attempt further (recursive) error recovery."
679 ;; Go into Info buffer.
681 ;; Record the node we are leaving, if we were in one.
683 Info-current-file
686 Info-history)))
689 ;;;###autoload
691 "Use Info mode to browse the current Info buffer.
692 With a prefix arg, this queries for the node name to visit first;
693 otherwise, that defaults to `Top'."
703 ;; If called on a non-file buffer, make a fake file name.
707 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
708 ;; but at least it keeps this routine (which is only for the benefit of
709 ;; makeinfo-buffer) out of the way of normal operations.
710 ;;
712 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
713 When *info* is already displaying FILENAME and NODENAME, the window position
714 is preserved, if possible."
730 ;; note goto-line is no good, we want to measure from point-min
737 ;; only add to the history when coming from a different file+node
742 "Find a node in a tag table.
743 MARKER specifies the buffer and position to start searching at.
744 REGEXP is a regular expression matching nodes or references. Its first
745 group should match `Node:' or `Ref:'.
746 CASE-FOLD t means search for a case-insensitive match.
747 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
748 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
749 where the match was found, and MODE is `major-mode' of the buffer in
750 which the match was found."
756 ;; Search tag table
761 major-mode)))))
764 "Find a node in a tag table.
765 MARKER specifies the buffer and position to start searching at.
766 REGEXP is a regular expression matching nodes or references. Its first
767 group should match `Node:' or `Ref:'.
768 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
769 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
770 where the match was found, and MODE is `major-mode' of the buffer in
771 which the match was found.
772 This function tries to find a case-sensitive match first, then a
773 case-insensitive match is tried."
777 result))
780 "Find a node or anchor in the current buffer.
781 REGEXP is a regular expression matching nodes or references. Its first
782 group should match `Node:' or `Ref:'.
783 CASE-FOLD t means search for a case-insensitive match.
784 Value is the position at which a match was found, or nil if not found."
786 found)
798 found)))
801 "Find a node or anchor in the current buffer.
802 REGEXP is a regular expression matching nodes or references. Its first
803 group should match `Node:' or `Ref:'.
804 Value is the position at which a match was found, or nil if not found.
805 This function looks for a case-sensitive match first. If none is found,
806 a case-insensitive match is tried."
818 anchorpos)
819 ;; Switch files if necessary
824 Info-current-subfile nil
825 Info-current-file-completions nil
826 buffer-file-name nil)
842 ;; Check makeinfo version for index cookie support
854 ;; See whether file has a tag table. Record the location if yes.
857 ;; Use string-equal, not equal, to ignore text props.
862 ;; We have a tag table. Find its beginning.
863 ;; Is this an indirect file?
869 ;; It is indirect. Copy it to another buffer
870 ;; and record that the tag table is in that buffer.
890 ))
891 ;; Use string-equal, not equal, to ignore text props.
895 ;; Possibilities:
896 ;;
897 ;; 1. Anchor found in tag table
898 ;; 2. Anchor *not* in tag table
899 ;;
900 ;; 3. Node found in tag table
901 ;; 4. Node *not* found in tag table, but found in file
902 ;; 5. Node *not* in tag table, and *not* in file
903 ;;
904 ;; *Or* the same, but in an indirect subfile.
906 ;; Search file for a suitable node.
916 ;; First, search a tag table, if any
922 ;; FOUND is (ANCHOR POS MODE).
925 ;; If this is an indirect file, determine which
926 ;; file really holds this node and read it in.
928 ;; Note that the current buffer must be the
929 ;; *info* buffer on entry to
930 ;; Info-read-subfile. Thus the hackery above.
933 ;; Handle anchor
938 ;; Else we may have a node, which we search for:
942 ;; Now search from our advised position (or from beg of
943 ;; buffer) to find the actual node. First, check
944 ;; whether the node is right where we are, in case the
945 ;; buffer begins with a node.
958 ;; No such anchor in tag table or node in tag table or file
966 ;; Add anchors to the history too
977 ;; If we did not finish finding the specified node,
978 ;; go back to the previous one.
985 ;; Cache the contents of the (virtual) dir file, once we have merged
986 ;; it for the first time, so we can save time subsequently.
989 ;; Cache for the directory we decided to use for the default-directory
990 ;; of the merged dir text.
993 ;; Record the file attributes of all the files from which we
994 ;; constructed Info-dir-contents.
999 ;; Construct the Info directory node by merging the files named `dir'
1000 ;; from various directories. Set the *info* buffer's
1001 ;; default-directory to the first directory we actually get any text
1002 ;; from.
1005 ;; Verify that none of the files we used has changed
1006 ;; since we used it.
1010 ;; Handle symlinks
1013 ;; Don't compare the access time.
1017 Info-dir-file-attributes))))
1023 Info-additional-directory-list)
1024 Info-directory-list))
1026 ;; Bind this in case the user sets it to nil.
1028 ;; This is set non-nil if we find a problem in some input files.
1029 problems
1030 buffers buffer others nodes dirs-done)
1032 ;; Search the directory list for the directory file.
1037 ;; Try several variants of specified name.
1038 ;; Try upcasing, appending `.info', or both.
1053 dirs-done)))
1063 file)
1075 ;; Distinguish the dir file that comes with Emacs from all the
1076 ;; others. Yes, that is really what this is supposed to do.
1077 ;; The definition of `Info-directory-list' puts it first on that
1078 ;; list and so last in `buffers' at this point.
1082 ;; Insert the entire original dir file as a start; note that we've
1083 ;; already saved its default directory to use as the default
1084 ;; directory for the whole concatenation.
1087 ;; Look at each of the other buffers one by one.
1090 ;; In each, find all the menus.
1093 ;; Find each menu, and add an elt to NODES for it.
1097 nodename end)
1109 ;; Add to the main menu a menu item for each other node.
1121 end t)
1125 ;; Now take each node of each of the other buffers
1126 ;; and merge it into the main buffer.
1131 ;; Find the like-named node in the main buffer.
1135 nil t)
1140 ;; If none exists, add one.
1143 ;; Merge the text from the other buffer's menu
1144 ;; into the menu in the like-named node in the main buffer.
1147 ;; Kill all the buffers we just made, including the special one excised.
1167 ;; Remove duplicate headings in the same menu.
1170 ;; Look for the next heading to unify.
1175 ;; Check whether this heading should be streamlined.
1185 ;; Look for other headings of the same category and merge them.
1191 ;; Delete redundant heading.
1193 ;; Push the entries onto `text'.
1200 ;; Insert the entries just found.
1208 ;; Now remove duplicate entries under the same heading.
1214 ;; Fold case straight away; `member-ignore-case' here wasteful.
1222 ;; Note that on entry to this function the current-buffer must be the
1223 ;; *info* buffer; not the info tags buffer.
1225 ;; NODEPOS is either a position (in the Info file as a whole,
1226 ;; not relative to a subfile) or the name of a subfile.
1228 lastfilename)
1240 thisfilepos thisfilename)
1244 ;; read in version 19 stops at the end of number.
1245 ;; Advance to the next line.
1254 ;; Assume previous buffer is in Info-mode.
1255 ;; (set-buffer (get-buffer "*info*"))
1264 ;; Widen in case we are in the same subfile as before.
1274 "Unescape double quotes and backslashes in VALUE."
1280 unquote))
1282 ;; As of Texinfo 4.6, makeinfo writes constructs like
1283 ;; \0\h[image param=value ...\h\0]
1284 ;; into the Info file for handling images.
1287 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1288 whitespace or double quotes, it must be quoted in double quotes and
1293 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1294 parameter-string start)
1300 parameter-alist))
1301 parameter-alist))
1304 "Display images in current node."
1311 nil t)
1326 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1327 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1328 ;; including one optional trailing newline.
1330 "Hide unrecognized cookies in current node."
1337 nil t)
1344 "Select the Info node that point is in."
1345 ;; Bind this in case the user sets it to nil.
1348 ;; Find beginning of node.
1354 ;; Get nodename spelled as it is in the node.
1362 ;; Find the end of it, and narrow.
1365 ;; Narrow to the node contents
1377 ;; Add a new unique history item to full history list
1392 map)
1400 " ("
1405 ") "
1410 'help-echo
1411 "mouse-1: scroll forward, mouse-3: scroll back"
1415 \f
1416 ;; Go to an Info node specified with a filename-and-nodename string
1417 ;; of the sort that is found in pointers in nodes.
1419 ;; Don't autoload this function: the correct entry point for other packages
1420 ;; to use is `info'. --Stef
1421 ;; ;;;###autoload
1423 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1424 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1425 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1426 its sub-files).
1427 Completion is available, but only for node names in the current Info file.
1428 If FORK is non-nil (interactively with a prefix arg), show the node in
1429 a new Info buffer.
1430 If FORK is a string, it is the name to use for the new buffer."
1438 nodename)
1440 ""
1454 "Virtual completion table for file names input in Info node names.
1455 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1471 ;; If the file name has no suffix or a standard suffix,
1472 ;; include it.
1475 ;; But exclude subfiles of split Info files.
1477 ;; And exclude backup files.
1480 ;; If the file name ends in a standard suffix,
1481 ;; add the unsuffixed name as a completion option.
1490 ;; This function is used as the "completion table" while reading a node name.
1491 ;; It does completion using the alist in Info-read-node-completion-table
1492 ;; unless STRING starts with an open-paren.
1495 ;; First complete embedded file names.
1511 ;; If a file name was given, then any node is fair game.
1517 ;; Otherwise use Info-read-node-completion-table.
1525 ;; Arrange to highlight the proper letters in the completion list buffer.
1531 1
1541 nodename)))
1546 ;; Bind this in case the user sets it to nil.
1559 compl))))
1562 ;; If the buffer begins with a node header, process that first.
1565 ;; Now for the rest of the nodes.
1573 compl))))))))
1576 \f
1578 "If this node has been visited, restore the point value when we left."
1581 ;; Use string-equal, not equal, to ignore text props.
1587 \f
1595 "Search for REGEXP, starting from point, and select node it's found in.
1596 If DIRECTION is `backward', search in the reverse direction."
1624 ;; Hide Info file header for backward search
1636 ;; Skip node header line
1640 ;; Skip Tag Table node
1647 Info-search-whitespace-regexp)))
1662 ;; If no subfiles, give error now.
1667 Info-search-whitespace-regexp)))
1678 ;; Try other subfiles.
1689 ;; Find the subfile we just searched.
1691 ;; Skip that one.
1694 ;; Make a list of all following subfiles.
1695 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1704 list))
1708 ;; Put in forward order
1714 ;; Hide Info file header for backward search
1729 ;; Skip node header line
1733 ;; Skip Tag Table node
1740 Info-search-whitespace-regexp)))
1763 ;; Search landed in the same node
1769 ;; Use string-equal, not equal, to ignore text props.
1775 Info-history))))))
1778 "Search for a regexp case-sensitively."
1784 "Search for next regexp from a previous `Info-search' command."
1792 "Search for REGEXP in the reverse direction."
1811 nil t)
1813 bound noerror count
1816 bound noerror count
1843 \f
1845 "Extract the value of the node-pointer named NAME.
1846 If there is none, use ERRORNAME in the error message;
1847 if ERRORNAME is nil, just return nil."
1848 ;; Bind this in case the user sets it to nil.
1862 "Return a regexp matching a node name.
1863 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1864 saying which chars may appear in the node name.
1865 Submatch 1 is the complete node name.
1866 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1867 Submatch 3 is the local part of the node name.
1868 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1875 ;;; For compatibility; other files have used this name.
1881 "Go to the next node of this node."
1883 ;; In case another window is currently selected
1889 "Go to the previous node of this node."
1891 ;; In case another window is currently selected
1897 "Go to the superior node of this node.
1898 If SAME-FILE is non-nil, do not move to a different Info file."
1900 ;; In case another window is currently selected
1919 nil t))
1925 "Go back in the history to the last node visited."
1931 Info-history-forward))
1932 filename nodename opoint)
1945 "Go forward in the history of visited nodes."
1950 filename nodename opoint)
1958 ;;;###autoload
1960 "Go to the Info directory node."
1963 \f
1965 "Go to a node with a menu of visited nodes."
1969 p)
1994 "Go to a node with table of contents of the current Info file.
1995 Table of contents is created from the tree structure of menus."
2000 p)
2030 "Insert table of contents with references to nodes."
2042 "Build table of contents from menus of Info FILE and its subfiles."
2047 default-directory))
2050 nodes subfiles)
2062 menu-items)
2071 bound))
2074 ;; Menu item line
2084 ;; Other non-empty strings in the Top node are section names
2093 nodes))
2102 subfiles)))))
2104 main-file nil))
2108 \f
2110 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2111 FOOTNOTENAME may be an abbreviation of the reference name.
2112 If FORK is non-nil (interactively with a prefix arg), show the node in
2113 a new Info buffer. If FORK is a string, it is the name to use for the
2114 new buffer."
2120 ;; Store end and beginning of line.
2129 ;; See if this one should be the default.
2134 ;; See if this one should be the alternate default.
2144 ;; Record as a completion and perhaps as default.
2147 ;; Don't add this string if it's a duplicate.
2150 ;; If no good default was found, try an alternate.
2153 ;; If only one cross-reference found, then make it default.
2159 "Follow reference named (default "
2162 completions nil t)))
2176 ;; Move point to the beginning of reference if point is on reference
2186 ;; Go to the reference closest to point
2194 next-ref prev-ref))
2205 ;; We allow newline because this is also used in Info-follow-reference,
2206 ;; where the xref name might be wrapped over two lines.
2207 "Regexp that matches a menu entry name upto but not including the colon.
2208 Because of ambiguities, this should be concatenated with something like
2229 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2230 ;;; (setq Info-point-loc
2231 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2232 )
2236 ;; If the node name is the menu entry name (using `entry::').
2240 ;; No one calls this.
2241 ;;(defun Info-menu-item-sequence (list)
2242 ;; (while list
2243 ;; (Info-menu (car list))
2244 ;; (setq list (cdr list))))
2256 ;; This uses two dynamically bound variables:
2257 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2258 ;; is the menu of items we're trying to complete.
2259 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2260 ;; also look for menu items in subsequent nodes as long as those
2261 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2262 ;; not used.
2263 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2264 ;; also look for menu items in these nodes. This feature is currently
2265 ;; only used for completion in Info-index.
2267 ;; Note that `Info-complete-menu-buffer' could be current already,
2268 ;; so we want to save point.
2274 nextnode)
2283 completions
2285 ;; Check the cache.
2293 ;; We can reuse the previous list.
2295 ;; The cache can't be used.
2300 completions))
2301 ;; Check subsequent nodes if applicable.
2309 ;; Go back to the start node (for the next completion).
2312 ;; Update the cache.
2315 Info-complete-next-re string completions
2316 Info-complete-nodes)))
2323 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2324 The menu item should one of those listed in the current node's menu.
2325 Completion is allowed, and the default menu item is the one point is on.
2326 If FORK is non-nil (interactively with a prefix arg), show the node in
2327 a new Info buffer. If FORK is a string, it is the name to use for the
2328 new buffer."
2331 ;; If point is within a menu item, use that item as the default
2334 beg
2347 Info-menu-entry-name-re
2356 default)
2359 ;; we rely on the fact that completing-read accepts an input
2360 ;; of "" even when the require-match argument is true and ""
2361 ;; is not a valid possibility
2365 ;; ask again
2368 ;; there is a problem here in that if several menu items have the same
2369 ;; name you can only go to the node of the first with this command.
2387 ;; If COUNT is nil, use the last item in the menu.
2399 nil))
2403 "Go to the node of the Nth menu item.
2404 N is the digit argument used to invoke this command."
2411 "Go to the Top node of this file."
2416 "Go to the final node in this file."
2421 ;; Go to the last node in the menu of Top.
2423 ;; If the last node in the menu is not last in pointer structure,
2424 ;; move forward until we can't go any farther.
2426 ;; Then keep moving down to last subnode, unless we reach an index.
2432 "Go forward one node, considering all nodes as forming one sequence."
2437 ;; three possibilities, in order of priority:
2438 ;; 1. next node is in a menu in this node (but not in an index)
2439 ;; 2. next node is next at same level
2440 ;; 3. next node is up and next
2445 t)
2448 t)
2450 ;; Use string-equal, not equal, to ignore text props.
2463 "Go backward one node, considering all nodes as forming one sequence."
2471 ;; Use string-equal, not equal,
2472 ;; to ignore text properties.
2477 ;; If we move back at the same level,
2478 ;; go down to find the last subnode*.
2488 "Exit Info by selecting some other buffer."
2495 "Go to the node of the next menu item."
2497 ;; Bind this in case the user sets it to nil.
2509 "Go to the node of the previous menu item."
2513 ;; Bind this in case the user sets it to nil.
2528 "Go to the next subnode or the next node, or go up a level."
2533 ;; Since we have already gone thru all the items in this menu,
2534 ;; go up to the end of this node.
2536 ;; Since logically we are done with the node with that menu,
2537 ;; move on from it.
2543 "Go to the last node, popping up a level if there is none."
2547 ;; If we go down a menu item, go to the end of the node
2548 ;; so we can scroll back through it.
2550 ;; Keep going down, as long as there are nested menu nodes.
2553 ;; If we go down a menu item, go to the end of the node
2554 ;; so we can scroll back through it.
2564 ;; If we go down a menu item, go to the end of the node
2565 ;; so we can scroll back through it.
2576 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2577 Once you scroll far enough in a node that its menu appears on the screen
2578 but after point, the next scroll moves into its first subnode, unless
2579 `Info-scroll-prefer-subnodes' is nil.
2581 When you scroll past the end of a node, that goes to the next node if
2582 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2583 if this node has no successor, it moves to the parent node's successor,
2584 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2585 the menu of a node, it moves to subnode indicated by the following menu
2586 item. (That case won't normally result from this command, but can happen
2587 in other ways.)"
2609 "Scroll one screenful back in Info, considering all nodes as one sequence.
2610 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2611 is non-nil, this goes to its last subnode. When you scroll past the
2612 beginning of a node, that goes to the previous node or back up to the
2613 parent node."
2627 current-point
2628 t)))))
2635 "Move cursor to the next cross-reference or menu item in the node."
2657 "Move cursor to the previous cross-reference or menu item in the node."
2676 \f
2678 "Alist of cached index node names of visited Info files.
2682 "Return a list of names of all index nodes in Info FILE.
2683 If FILE is omitted, it defaults to the current Info file.
2684 First look in a list of cached index node names. Then scan Info
2685 file and its subfiles for nodes with the index cookie. Then try
2686 to find index nodes starting from the first node in the top level
2691 ;; Skip virtual Info files
2696 ;; Find nodes with index cookie
2700 default-directory))
2701 Info-history Info-history-list Info-fontify-maximum-menu-size
2721 subfiles)))))
2723 main-file nil))
2729 nodes)
2730 ;; Else find nodes with the word "Index" in the node name
2732 Info-history Info-history-list Info-fontify-maximum-menu-size
2733 nodes node)
2751 nodes))
2752 ;; If file has no index nodes, still add it to the cache
2757 "Return non-nil value if NODE is an index node.
2758 If NODE is nil, check the current Info node.
2759 If FILE is nil, check the current Info file."
2763 ;; Don't search all index nodes if request is only for the current node
2764 ;; and file is not in the cache of index nodes
2778 "Go to the first index node."
2783 ;;;###autoload
2785 "Look up a string TOPIC in the index for this manual and go to that entry.
2786 If there are no exact matches to the specified topic, this chooses
2787 the first match which is a case-insensitive substring of a topic.
2789 Give an empty topic name to go to the Index node itself."
2805 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2814 ;; We bind Info-history to nil for internal node-switches so
2815 ;; that we don't put junk in the history. In the first
2816 ;; Info-goto-index call, above, we do update the history
2817 ;; because that is what the user's previous node choice into it.
2819 found)
2826 Info-current-node
2829 matches))
2836 ;; Here it is a feature that assoc is case-sensitive.
2871 "Move point to the place within the current node where NAME is defined."
2876 ;; Find a function definition with a return type.
2884 nil t))
2886 ;; Try again without the " <1>" makeinfo can append
2892 ;;;###autoload
2894 "Grovel indices of all known Info files on your system for STRING.
2895 Build a menu of the possible matches."
2898 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2904 manuals matches node nodes)
2927 matches)))
2936 Info-history-list ohist-list)
2957 "Make command be undefined in Info."
2962 "Enter the Info tutorial."
2967 "Help-Small-Screen"
2971 "Display a brief summary of all Info commands."
2986 flag))
2989 \f
2991 "Return the token around POS.
2992 POS must be somewhere inside the token
2993 START is a regular expression which will match the
2994 beginning of the tokens delimited string
2995 ALL is a regular expression with a single
2996 parenthesized subpattern which is the token to be
2997 returned. E.g. '{\(.*\)}' would return any string
2998 enclosed in braces around POS.
2999 ERRORSTRING optional fourth argument, controls action on no match
3000 nil: return nil
3001 t: beep
3002 a string: signal an error, using that string."
3006 ;; First look for a match for START that goes across POS.
3010 ;; If we did not find one, search back for START
3011 ;; (this finds only matches that end at or before POS).
3024 nil)
3027 nil)
3033 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3034 At end of the node's text, moves to the next node, or up if none."
3042 "Follow a node reference near point.
3043 If point is on a reference, follow that reference. Otherwise,
3044 if point is in a menu item description, follow that menu item."
3056 t)))
3059 ;; Common subroutine.
3061 "Follow a node reference near point. Return non-nil if successful."
3070 ;; menu item: node name
3073 ;; menu item: node name or index entry
3087 node))
3088 \f
3092 nil
3102 (define-key Info-mode-map "1" 'Info-nth-menu-item)
3103 (define-key Info-mode-map "2" 'Info-nth-menu-item)
3104 (define-key Info-mode-map "3" 'Info-nth-menu-item)
3105 (define-key Info-mode-map "4" 'Info-nth-menu-item)
3106 (define-key Info-mode-map "5" 'Info-nth-menu-item)
3107 (define-key Info-mode-map "6" 'Info-nth-menu-item)
3108 (define-key Info-mode-map "7" 'Info-nth-menu-item)
3109 (define-key Info-mode-map "8" 'Info-nth-menu-item)
3110 (define-key Info-mode-map "9" 'Info-nth-menu-item)
3111 (define-key Info-mode-map "0" 'undefined)
3112 (define-key Info-mode-map "?" 'Info-summary)
3113 (define-key Info-mode-map "]" 'Info-forward-node)
3114 (define-key Info-mode-map "[" 'Info-backward-node)
3115 (define-key Info-mode-map "<" 'Info-top-node)
3116 (define-key Info-mode-map ">" 'Info-final-node)
3117 (define-key Info-mode-map "b" 'beginning-of-buffer)
3118 (define-key Info-mode-map "d" 'Info-directory)
3119 (define-key Info-mode-map "e" 'Info-edit)
3120 (define-key Info-mode-map "f" 'Info-follow-reference)
3121 (define-key Info-mode-map "g" 'Info-goto-node)
3122 (define-key Info-mode-map "h" 'Info-help)
3123 (define-key Info-mode-map "i" 'Info-index)
3124 (define-key Info-mode-map "l" 'Info-history-back)
3125 (define-key Info-mode-map "L" 'Info-history)
3126 (define-key Info-mode-map "m" 'Info-menu)
3127 (define-key Info-mode-map "n" 'Info-next)
3128 (define-key Info-mode-map "p" 'Info-prev)
3129 (define-key Info-mode-map "q" 'Info-exit)
3130 (define-key Info-mode-map "r" 'Info-history-forward)
3131 (define-key Info-mode-map "s" 'Info-search)
3132 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
3133 ;; For consistency with Rmail.
3134 (define-key Info-mode-map "\M-s" 'Info-search)
3135 (define-key Info-mode-map "\M-n" 'clone-buffer)
3136 (define-key Info-mode-map "t" 'Info-top-node)
3137 (define-key Info-mode-map "T" 'Info-toc)
3138 (define-key Info-mode-map "u" 'Info-up)
3139 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3140 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
3141 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
3142 ;; `^' for consistency with `dired-up-directory'.
3143 (define-key Info-mode-map "^" 'Info-up)
3144 (define-key Info-mode-map "," 'Info-index-next)
3146 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
3147 (define-key Info-mode-map [follow-link] 'mouse-face)
3148 )
3150 (defun Info-check-pointer (item)
3151 "Non-nil if ITEM is present in this node."
3152 (condition-case nil
3153 (Info-extract-pointer item)
3154 (error nil)))
3156 (easy-menu-define
3157 Info-mode-menu Info-mode-map
3158 "Menu for Info files."
3159 '("Info"
3160 ["Up" Info-up :active (Info-check-pointer "up")
3161 :help "Go up in the Info tree"]
3162 ["Next" Info-next :active (Info-check-pointer "next")
3163 :help "Go to the next node"]
3164 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3165 :help "Go to the previous node"]
3166 ["Backward" Info-backward-node
3167 :help "Go backward one node, considering all as a sequence"]
3168 ["Forward" Info-forward-node
3169 :help "Go forward one node, considering all as a sequence"]
3170 ["Beginning" beginning-of-buffer
3171 :help "Go to beginning of this node"]
3172 ["Top" Info-top-node
3173 :help "Go to top node of file"]
3174 ["Final Node" Info-final-node
3175 :help "Go to final node in this file"]
3176 ("Menu Item" ["You should never see this" report-emacs-bug t])
3177 ("Reference" ["You should never see this" report-emacs-bug t])
3178 ["Search..." Info-search
3179 :help "Search for regular expression in this Info file"]
3180 ["Search Next" Info-search-next
3181 :help "Search for another occurrence of regular expression"]
3182 ["Go to Node..." Info-goto-node
3183 :help "Go to a named node"]
3184 ["Back in history" Info-history-back :active Info-history
3185 :help "Go back in history to the last node you were at"]
3186 ["Forward in history" Info-history-forward :active Info-history-forward
3187 :help "Go forward in history"]
3188 ["History" Info-history :active Info-history-list
3189 :help "Go to menu of visited nodes"]
3190 ["Table of Contents" Info-toc
3191 :help "Go to table of contents"]
3192 ("Index"
3193 ["Lookup a String..." Info-index
3194 :help "Look for a string in the index items"]
3195 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3196 :help "Look for another occurrence of previous item"]
3197 ["Lookup a string in all indices..." info-apropos
3198 :help "Look for a string in the indices of all manuals"])
3199 ["Copy Node Name" Info-copy-current-node-name
3200 :help "Copy the name of the current node into the kill ring"]
3201 ["Clone Info buffer" clone-buffer
3202 :help "Create a twin copy of the current Info buffer."]
3203 ["Exit" Info-exit :help "Stop reading Info"]))
3206 (defvar info-tool-bar-map
3207 (if (display-graphic-p)
3208 (let ((map (make-sparse-keymap)))
3209 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
3210 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map)
3211 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map)
3212 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map)
3213 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map)
3214 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3215 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3216 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3217 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3218 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3219 map)))
3221 (defvar Info-menu-last-node nil)
3222 ;; Last node the menu was created for.
3223 ;; Value is a list, (FILE-NAME NODE-NAME).
3225 (defun Info-menu-update ()
3226 "Update the Info menu for the current node."
3227 (condition-case nil
3228 (if (or (not (eq major-mode 'Info-mode))
3229 (equal (list Info-current-file Info-current-node)
3230 Info-menu-last-node))
3231 ()
3232 ;; Update menu menu.
3233 (let* ((Info-complete-menu-buffer (current-buffer))
3234 (items (nreverse (condition-case nil
3235 (Info-complete-menu-item "" nil t)
3236 (error nil))))
3237 entries current
3238 (number 0))
3239 (while (and items (< number 9))
3240 (setq current (car items)
3241 items (cdr items)
3242 number (1+ number))
3243 (setq entries (cons `[,current
3244 (Info-menu ,current)
3245 :keys ,(format "%d" number)]
3246 entries)))
3247 (if items
3248 (setq entries (cons ["Other..." Info-menu t] entries)))
3249 (or entries
3250 (setq entries (list ["No menu" nil nil] nil :active)))
3251 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3252 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3253 (let ((items nil)
3254 str i entries current
3255 (number 0)
3256 (case-fold-search t))
3257 (save-excursion
3258 (goto-char (point-min))
3260 (setq str (match-string 1))
3261 (setq i 0)
3263 (setq str (concat (substring str 0 i) " "
3264 (substring str (match-end 0))))
3265 (setq i (1+ i)))
3266 (setq items
3267 (cons str items))))
3268 (while (and items (< number 9))
3269 (setq current (car items)
3270 items (cdr items)
3271 number (1+ number))
3272 (setq entries (cons `[,current
3273 (Info-follow-reference ,current)
3274 t]
3275 entries)))
3276 (if items
3277 (setq entries (cons ["Other..." Info-follow-reference t]
3278 entries)))
3279 (or entries
3280 (setq entries (list ["No references" nil nil] nil :active)))
3281 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3282 ;; Update last seen node.
3283 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3284 ;; Try to avoid entering infinite beep mode in case of errors.
3285 (error (ding))))
3287 \f
3288 (defun Info-copy-current-node-name (&optional arg)
3289 "Put the name of the current Info node into the kill ring.
3290 The name of the Info file is prepended to the node name in parentheses.
3291 With a zero prefix arg, put the name inside a function call to `info'."
3292 (interactive "P")
3293 (unless Info-current-node
3294 (error "No current Info node"))
3295 (let ((node (if (stringp Info-current-file)
3296 (concat "(" (file-name-nondirectory Info-current-file) ")"
3297 Info-current-node))))
3298 (if (zerop (prefix-numeric-value arg))
3300 (unless (stringp Info-current-file)
3301 (setq node (format "(Info-find-node '%S '%S)"
3302 Info-current-file Info-current-node)))
3303 (kill-new node)
3304 (message "%s" node)))
3306 \f
3307 ;; Info mode is suitable only for specially formatted data.
3308 (put 'Info-mode 'mode-class 'special)
3309 (put 'Info-mode 'no-clone-indirect t)
3311 (defvar tool-bar-map)
3313 ;; Autoload cookie needed by desktop.el
3314 ;;;###autoload
3315 (defun Info-mode ()
3316 "Info mode provides commands for browsing through the Info documentation tree.
3318 one topic and contains references to other nodes which discuss related
3319 topics. Info has commands to follow the references and show you other nodes.
3325 Selecting other nodes:
3327 Follow a node reference you click on.
3328 This works with menu items, cross references, and
3330 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3335 Picking a menu item causes another node to be selected.
3345 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3349 Moving within a node:
3351 Once you scroll far enough in a node that its menu appears on the
3352 screen but after point, the next scroll moves into its first
3353 subnode. When after all menu items (or if there is no menu),
3354 move up to the parent node.
3356 already visible, try to go to the previous menu entry, or up
3357 if there is none.
3360 Advanced commands:
3362 and select the node in which the next occurrence is found.
3363 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3367 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3370 You may include a filename as well, as (FILENAME)NODENAME.
3371 1 .. 9 Pick first ... ninth item in node's menu.
3372 Every third `*' is highlighted to help pick the right number.
3376 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3377 (kill-all-local-variables)
3378 (setq major-mode 'Info-mode)
3379 (setq mode-name "Info")
3380 (setq tab-width 8)
3381 (use-local-map Info-mode-map)
3382 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3383 (set-syntax-table text-mode-syntax-table)
3384 (setq local-abbrev-table text-mode-abbrev-table)
3385 (setq case-fold-search t)
3386 (setq buffer-read-only t)
3387 (make-local-variable 'Info-current-file)
3388 (make-local-variable 'Info-current-subfile)
3389 (make-local-variable 'Info-current-node)
3390 (make-local-variable 'Info-tag-table-marker)
3391 (setq Info-tag-table-marker (make-marker))
3392 (make-local-variable 'Info-tag-table-buffer)
3393 (setq Info-tag-table-buffer nil)
3394 (make-local-variable 'Info-history)
3395 (make-local-variable 'Info-history-forward)
3396 (make-local-variable 'Info-index-alternatives)
3397 (setq header-line-format
3398 (if Info-use-header-line
3399 '(:eval (get-text-property (point-min) 'header-line))
3400 nil)) ; so the header line isn't displayed
3401 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3402 ;; This is for the sake of the invisible text we use handling titles.
3403 (make-local-variable 'line-move-ignore-invisible)
3404 (setq line-move-ignore-invisible t)
3405 (make-local-variable 'desktop-save-buffer)
3406 (make-local-variable 'widen-automatically)
3407 (setq widen-automatically nil)
3408 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3409 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3410 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
3411 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3412 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3413 (set (make-local-variable 'isearch-search-fun-function)
3414 'Info-isearch-search)
3415 (set (make-local-variable 'isearch-wrap-function)
3416 'Info-isearch-wrap)
3417 (set (make-local-variable 'isearch-push-state-function)
3418 'Info-isearch-push-state)
3419 (set (make-local-variable 'search-whitespace-regexp)
3420 Info-search-whitespace-regexp)
3421 (Info-set-mode-line)
3422 (run-mode-hooks 'Info-mode-hook))
3424 ;; When an Info buffer is killed, make sure the associated tags buffer
3425 ;; is killed too.
3426 (defun Info-kill-buffer ()
3427 (and (eq major-mode 'Info-mode)
3428 Info-tag-table-buffer
3429 (kill-buffer Info-tag-table-buffer)))
3431 (defun Info-clone-buffer-hook ()
3432 (when (bufferp Info-tag-table-buffer)
3433 (setq Info-tag-table-buffer
3434 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3435 (let ((m Info-tag-table-marker))
3436 (when (markerp m)
3437 (setq Info-tag-table-marker
3438 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3439 (with-current-buffer Info-tag-table-buffer
3440 (copy-marker (marker-position m)))
3441 (make-marker))))))
3443 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3444 (set-keymap-parent map text-mode-map)
3445 (define-key map "\C-c\C-c" 'Info-cease-edit)
3446 map)
3447 "Local keymap used within `e' command of Info.")
3449 ;; Info-edit mode is suitable only for specially formatted data.
3450 (put 'Info-edit-mode 'mode-class 'special)
3452 (defun Info-edit-mode ()
3453 "Major mode for editing the contents of an Info node.
3454 Like text mode with the addition of `Info-cease-edit'
3455 which returns to Info mode for browsing.
3457 (use-local-map Info-edit-map)
3458 (setq major-mode 'Info-edit-mode)
3459 (setq mode-name "Info Edit")
3460 (kill-local-variable 'mode-line-buffer-identification)
3461 (setq buffer-read-only nil)
3462 (force-mode-line-update)
3463 (buffer-enable-undo (current-buffer))
3464 (run-mode-hooks 'Info-edit-mode-hook))
3466 (defun Info-edit ()
3467 "Edit the contents of this Info node.
3468 Allowed only if variable `Info-enable-edit' is non-nil."
3469 (interactive)
3470 (or Info-enable-edit
3471 (error "Editing Info nodes is not enabled"))
3472 (Info-edit-mode)
3473 (message "%s" (substitute-command-keys
3476 (defun Info-cease-edit ()
3477 "Finish editing Info node; switch back to Info proper."
3478 (interactive)
3479 ;; Do this first, so nothing has changed if user C-g's at query.
3480 (and (buffer-modified-p)
3481 (y-or-n-p "Save the file? ")
3482 (save-buffer))
3483 (use-local-map Info-mode-map)
3484 (setq major-mode 'Info-mode)
3485 (setq mode-name "Info")
3486 (Info-set-mode-line)
3487 (setq buffer-read-only t)
3488 (force-mode-line-update)
3489 (and (marker-position Info-tag-table-marker)
3490 (buffer-modified-p)
3491 (message "Tags may have changed. Use Info-tagify if necessary")))
3492 \f
3493 (defvar Info-file-list-for-emacs
3494 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3495 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3496 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3497 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3498 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3499 ("copyright" . "autotype") ("executable" . "autotype")
3500 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3501 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3502 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3503 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3504 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3505 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3506 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3507 ("rfc2045" . "emacs-mime")
3508 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3509 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3510 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3511 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3512 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3513 ("mml" . "emacs-mime"))
3514 "List of Info files that describe Emacs commands.
3515 An element can be a file name, or a list of the form (PREFIX . FILE)
3516 where PREFIX is a name prefix and FILE is the file to look in.
3517 If the element is just a file name, the file name also serves as the prefix.")
3519 (defun Info-find-emacs-command-nodes (command)
3520 "Return a list of locations documenting COMMAND.
3521 The `info-file' property of COMMAND says which Info manual to search.
3522 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3523 defines heuristics for which Info manual to try.
3524 The locations are of the format used in `Info-history', i.e.
3525 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3526 in the first element of the returned list (which is treated specially in
3527 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3528 (let ((where '()) line-number
3532 (info-file "emacs")) ;default
3533 ;; Determine which Info file this command is documented in.
3534 (if (get command 'info-file)
3535 (setq info-file (get command 'info-file))
3536 ;; If it doesn't say explicitly, test its name against
3537 ;; various prefixes that we know.
3538 (let ((file-list Info-file-list-for-emacs))
3539 (while file-list
3540 (let* ((elt (car file-list))
3541 (name (if (consp elt)
3542 (car elt)
3543 elt))
3544 (file (if (consp elt) (cdr elt) elt))
3545 (case-fold-search nil)
3548 (if (string-match regexp (symbol-name command))
3549 (setq info-file file file-list nil))
3550 (setq file-list (cdr file-list))))))
3551 (Info-find-node info-file "Top")
3552 ;; Bind Info-history to nil, to prevent the index nodes from
3553 ;; getting into the node history.
3554 (let ((Info-history nil)
3555 (Info-history-list nil)
3556 node (nodes (Info-index-nodes)))
3557 (Info-goto-node (car nodes))
3558 (while
3559 (progn
3560 (goto-char (point-min))
3561 (while (re-search-forward cmd-desc nil t)
3562 (setq where
3563 (cons (list Info-current-file
3564 (match-string-no-properties 2)
3565 0)
3566 where))
3567 (setq line-number (and (match-beginning 3)
3568 (string-to-number (match-string 3)))))
3569 (and (setq nodes (cdr nodes) node (car nodes))))
3570 (Info-goto-node node)))
3571 (if (and line-number where)
3572 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3573 (cdr where))
3574 where)))
3576 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3577 ;;;###autoload
3578 (defun Info-goto-emacs-command-node (command)
3579 "Go to the Info node in the Emacs manual for command COMMAND.
3580 The command is found by looking up in Emacs manual's indices
3581 or in another manual found via COMMAND's `info-file' property or
3582 the variable `Info-file-list-for-emacs'.
3583 COMMAND must be a symbol or string."
3584 (interactive "CFind documentation for command: ")
3585 ;; If command is given as a string, convert it to a symbol.
3586 (if (stringp command)
3587 (setq command (intern command)))
3588 (or (commandp command)
3589 (signal 'wrong-type-argument (list 'commandp command)))
3590 (let ((where (Info-find-emacs-command-nodes command)))
3591 (if where
3592 (let ((num-matches (length where)))
3593 ;; Get Info running, and pop to it in another window.
3594 (save-window-excursion
3595 (info))
3596 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3597 ;; Bind Info-history to nil, to prevent the last Index node
3598 ;; visited by Info-find-emacs-command-nodes from being
3599 ;; pushed onto the history.
3600 (let ((Info-history nil) (Info-history-list nil)
3601 (line-number (nth 2 (car where))))
3602 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3603 (if (and (integerp line-number) (> line-number 0))
3604 (forward-line (1- line-number))))
3605 (if (> num-matches 1)
3606 (progn
3607 ;; (car where) will be pushed onto Info-history
3608 ;; when/if they go to another node. Put the other
3609 ;; nodes that were found on the history.
3610 (setq Info-history (nconc (cdr where) Info-history))
3611 (message "Found %d other entr%s. Use %s to see %s."
3612 (1- num-matches)
3613 (if (> num-matches 2) "ies" "y")
3615 (if (> num-matches 2) "them" "it")))))
3616 (error "Couldn't find documentation for %s" command))))
3618 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3619 ;;;###autoload
3620 (defun Info-goto-emacs-key-command-node (key)
3621 "Go to the node in the Emacs manual which describes the command bound to KEY.
3622 KEY is a string.
3623 Interactively, if the binding is `execute-extended-command', a command is read.
3624 The command is found by looking up in Emacs manual's indices
3625 or in another manual found via COMMAND's `info-file' property or
3626 the variable `Info-file-list-for-emacs'."
3627 (interactive "kFind documentation for key: ")
3628 (let ((command (key-binding key)))
3629 (cond ((null command)
3630 (message "%s is undefined" (key-description key)))
3631 ((and (interactive-p)
3632 (eq command 'execute-extended-command))
3633 (Info-goto-emacs-command-node
3634 (read-command "Find documentation for command: ")))
3635 (t
3636 (Info-goto-emacs-command-node command)))))
3637 \f
3638 (defvar Info-next-link-keymap
3639 (let ((keymap (make-sparse-keymap)))
3640 (define-key keymap [header-line mouse-1] 'Info-next)
3641 (define-key keymap [header-line mouse-2] 'Info-next)
3642 (define-key keymap [header-line down-mouse-1] 'ignore)
3643 (define-key keymap [mouse-2] 'Info-next)
3644 (define-key keymap [follow-link] 'mouse-face)
3645 keymap)
3646 "Keymap to put on the Next link in the text or the header line.")
3648 (defvar Info-prev-link-keymap
3649 (let ((keymap (make-sparse-keymap)))
3650 (define-key keymap [header-line mouse-1] 'Info-prev)
3651 (define-key keymap [header-line mouse-2] 'Info-prev)
3652 (define-key keymap [header-line down-mouse-1] 'ignore)
3653 (define-key keymap [mouse-2] 'Info-prev)
3654 (define-key keymap [follow-link] 'mouse-face)
3655 keymap)
3656 "Keymap to put on the Prev link in the text or the header line.")
3658 (defvar Info-up-link-keymap
3659 (let ((keymap (make-sparse-keymap)))
3660 (define-key keymap [header-line mouse-1] 'Info-up)
3661 (define-key keymap [header-line mouse-2] 'Info-up)
3662 (define-key keymap [header-line down-mouse-1] 'ignore)
3663 (define-key keymap [mouse-2] 'Info-up)
3664 (define-key keymap [follow-link] 'mouse-face)
3665 keymap)
3666 "Keymap to put on the Up link in the text or the header line.")
3668 (defun Info-fontify-node ()
3669 "Fontify the node."
3670 (save-excursion
3671 (let* ((inhibit-read-only t)
3672 (case-fold-search t)
3673 paragraph-markers
3674 (not-fontified-p ; the node hasn't already been fontified
3675 (not (let ((where (next-property-change (point-min))))
3676 (and where (not (= where (point-max)))))))
3677 (fontify-visited-p ; visited nodes need to be re-fontified
3678 (and Info-fontify-visited-nodes
3679 ;; Don't take time to refontify visited nodes in huge nodes
3680 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3681 rbeg rend)
3683 ;; Fontify header line
3684 (goto-char (point-min))
3686 (goto-char (match-end 0))
3688 (goto-char (match-end 0))
3689 (let* ((nbeg (match-beginning 2))
3690 (nend (match-end 2))
3691 (tbeg (match-beginning 1))
3692 (tag (match-string 1)))
3693 (if (string-equal (downcase tag) "node")
3694 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3695 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3696 (put-text-property tbeg nend 'mouse-face 'highlight)
3697 (put-text-property tbeg nend
3698 'help-echo
3699 (concat "mouse-2: Go to node "
3700 (buffer-substring nbeg nend)))
3701 ;; Always set up the text property keymap.
3702 ;; It will either be used in the buffer
3703 ;; or copied in the header line.
3704 (put-text-property
3705 tbeg nend 'keymap
3706 (cond
3707 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3708 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3709 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3710 (when Info-use-header-line
3711 (goto-char (point-min))
3712 (let* ((header-end (line-end-position))
3713 (header
3714 ;; If we find neither Next: nor Prev: link, show the entire
3715 ;; node header. Otherwise, don't show the File: and Node:
3716 ;; parts, to avoid wasting precious space on information that
3717 ;; is available in the mode line.
3718 (if (re-search-forward
3720 header-end t)
3721 (progn
3722 (goto-char (match-beginning 1))
3723 (buffer-substring (point) header-end))
3725 header-end t)
3726 (concat "No next, prev or up links -- "
3727 (buffer-substring (point) header-end))
3728 (buffer-substring (point) header-end)))))
3729 (put-text-property (point-min) (1+ (point-min))
3730 'header-line
3731 (replace-regexp-in-string
3732 "%"
3733 ;; Preserve text properties on duplicated `%'.
3734 (lambda (s) (concat s s)) header))
3735 ;; Hide the part of the first line
3736 ;; that is in the header, if it is just part.
3737 (unless (bobp)
3738 ;; Hide the punctuation at the end, too.
3740 (put-text-property (point) header-end 'invisible t)))))
3742 ;; Fontify titles
3743 (goto-char (point-min))
3744 (when (and font-lock-mode not-fontified-p)
3746 nil t)
3747 ;; Only consider it as an underlined title if the ASCII
3748 ;; underline has the same size as the text. A typical
3749 ;; counter example is when a continuation "..." is alone
3750 ;; on a line.
3751 (= (string-width (match-string 1))
3752 (string-width (match-string 2))))
3753 (let* ((c (preceding-char))
3754 (face
3755 (cond ((= c ?*) 'info-title-1)
3756 ((= c ?=) 'info-title-2)
3757 ((= c ?-) 'info-title-3)
3758 (t 'info-title-4))))
3759 (put-text-property (match-beginning 1) (match-end 1)
3760 'font-lock-face face))
3761 ;; This is a serious problem for trying to handle multiple
3762 ;; frame types at once. We want this text to be invisible
3763 ;; on frames that can display the font above.
3764 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3765 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3766 '(invisible t front-sticky nil rear-nonsticky t)))))
3768 ;; Fontify cross references
3769 (goto-char (point-min))
3770 (when (or not-fontified-p fontify-visited-p)
3771 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3772 (let ((start (match-beginning 0))
3773 (next (point))
3774 other-tag)
3775 (when not-fontified-p
3776 (when Info-hide-note-references
3777 (when (not (eq Info-hide-note-references 'hide))
3778 ;; *Note is often used where *note should have been
3779 (goto-char start)
3780 (skip-syntax-backward " ")
3781 (when (memq (char-before) '(?\( ?\[ ?\{))
3782 ;; Check whether the paren is preceded by
3783 ;; an end of sentence
3784 (skip-syntax-backward " ("))
3785 (setq other-tag
3787 "")
3788 ((memq (char-before) '(nil ?\. ?! ??))
3789 "See ")
3790 ((save-match-data
3791 (save-excursion
3793 "See ")
3794 (t "see "))))
3795 (goto-char next)
3796 (add-text-properties
3797 (match-beginning 1)
3798 (or (save-match-data
3800 (let ((start1 (match-beginning 1)))
3802 (+ start1 (match-beginning 0)))))
3803 (match-end 1))
3804 (if other-tag
3805 `(display ,other-tag front-sticky nil rear-nonsticky t)
3806 '(invisible t front-sticky nil rear-nonsticky t))))
3807 (add-text-properties
3808 (match-beginning 2) (match-end 2)
3809 (list
3810 'help-echo (if (or (match-end 5)
3811 (not (equal (match-string 4) "")))
3812 (concat "mouse-2: go to " (or (match-string 5)
3813 (match-string 4)))
3814 "mouse-2: go to this node")
3815 'mouse-face 'highlight)))
3816 (when (or not-fontified-p fontify-visited-p)
3817 (setq rbeg (match-beginning 2)
3818 rend (match-end 2))
3819 (put-text-property
3820 rbeg rend
3821 'font-lock-face
3822 ;; Display visited nodes in a different face
3823 (if (and Info-fontify-visited-nodes
3824 (save-match-data
3825 (let* ((node (replace-regexp-in-string
3827 (replace-regexp-in-string
3829 (or (match-string-no-properties 5)
3830 (and (not (equal (match-string 4) ""))
3831 (match-string-no-properties 4))
3832 (match-string-no-properties 2)))))
3833 (external-link-p
3835 (file (if external-link-p
3836 (file-name-nondirectory
3837 (match-string-no-properties 1 node))
3838 Info-current-file))
3839 (hl Info-history-list)
3840 res)
3841 (if external-link-p
3842 (setq node (if (equal (match-string 2 node) "")
3843 "Top"
3844 (match-string-no-properties 2 node))))
3845 (while hl
3846 (if (and (string-equal node (nth 1 (car hl)))
3847 (equal file
3848 (if (and external-link-p
3849 (stringp (caar hl)))
3850 (file-name-nondirectory
3851 (caar hl))
3852 (caar hl))))
3853 (setq res (car hl) hl nil)
3854 (setq hl (cdr hl))))
3855 res))) 'info-xref-visited 'info-xref))
3856 ;; For multiline ref, unfontify newline and surrounding whitespace
3857 (save-excursion
3858 (goto-char rbeg)
3859 (save-match-data
3861 (remove-text-properties (match-beginning 0)
3862 (match-end 0)
3863 '(font-lock-face t))))))
3864 (when not-fontified-p
3865 (when (memq Info-hide-note-references '(t hide))
3866 (add-text-properties (match-beginning 3) (match-end 3)
3867 '(invisible t front-sticky nil rear-nonsticky t))
3868 ;; Unhide the file name of the external reference in parens
3869 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3870 (remove-text-properties (match-beginning 6) (match-end 6)
3871 '(invisible t front-sticky nil rear-nonsticky t)))
3872 ;; Unhide newline because hidden newlines cause too long lines
3873 (save-match-data
3874 (let ((beg3 (match-beginning 3))
3875 (end3 (match-end 3)))
3877 (not (save-match-data
3878 (save-excursion
3879 (goto-char (1+ end3))
3880 (looking-at "[.)]*$")))))
3881 (remove-text-properties (+ beg3 (match-beginning 0))
3882 (+ beg3 (match-end 0))
3883 '(invisible t front-sticky nil rear-nonsticky t))))))
3884 (when (and Info-refill-paragraphs Info-hide-note-references)
3885 (push (set-marker (make-marker) start)
3886 paragraph-markers))))))
3888 ;; Refill paragraphs (experimental feature)
3889 (when (and not-fontified-p
3890 Info-refill-paragraphs
3891 paragraph-markers)
3892 (let ((fill-nobreak-invisible t)
3893 (fill-individual-varying-indent nil)
3896 (adaptive-fill-mode nil))
3897 (goto-char (point-max))
3898 (dolist (m paragraph-markers)
3899 (when (< m (point))
3900 (goto-char m)
3901 (beginning-of-line)
3902 (let ((beg (point)))
3903 (when (zerop (forward-paragraph))
3904 (fill-individual-paragraphs beg (point) nil nil)
3905 (goto-char beg))))
3906 (set-marker m nil))))
3908 ;; Fontify menu items
3909 (goto-char (point-min))
3910 (when (and (or not-fontified-p fontify-visited-p)
3912 (not (Info-index-node))
3913 ;; Don't take time to annotate huge menus
3914 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3915 (let ((n 0)
3916 cont)
3917 (while (re-search-forward
3920 nil t)
3921 (when (match-beginning 1)
3922 (when not-fontified-p
3923 (setq n (1+ n))
3924 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3925 (put-text-property (match-beginning 0)
3926 (1+ (match-beginning 0))
3927 'font-lock-face 'info-menu-star)))
3928 (when not-fontified-p
3929 (add-text-properties
3930 (match-beginning 1) (match-end 1)
3931 (list
3932 'help-echo (if (and (match-end 3)
3933 (not (equal (match-string 3) "")))
3934 (concat "mouse-2: go to " (match-string 3))
3935 "mouse-2: go to this node")
3936 'mouse-face 'highlight)))
3937 (when (or not-fontified-p fontify-visited-p)
3938 (put-text-property
3939 (match-beginning 1) (match-end 1)
3940 'font-lock-face
3941 ;; Display visited menu items in a different face
3942 (if (and Info-fontify-visited-nodes
3943 (save-match-data
3944 (let* ((node (if (equal (match-string 3) "")
3945 (match-string-no-properties 1)
3946 (match-string-no-properties 3)))
3947 (external-link-p
3949 (file (if external-link-p
3950 (file-name-nondirectory
3951 (match-string-no-properties 1 node))
3952 Info-current-file))
3953 (hl Info-history-list)
3954 res)
3955 (if external-link-p
3956 (setq node (if (equal (match-string 2 node) "")
3957 "Top"
3958 (match-string-no-properties 2 node))))
3959 (while hl
3960 (if (and (string-equal node (nth 1 (car hl)))
3961 (equal file
3962 (if (and external-link-p
3963 (stringp (caar hl)))
3964 (file-name-nondirectory
3965 (caar hl))
3966 (caar hl))))
3967 (setq res (car hl) hl nil)
3968 (setq hl (cdr hl))))
3969 res))) 'info-xref-visited 'info-xref)))
3970 (when (and not-fontified-p (memq Info-hide-note-references '(t hide)))
3971 (put-text-property (match-beginning 2) (1- (match-end 6))
3972 'invisible t)
3973 ;; Unhide the file name in parens
3974 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
3975 (remove-text-properties (match-beginning 4) (match-end 4)
3976 '(invisible t)))
3977 ;; We need a stretchable space like :align-to but with
3978 ;; a minimum value.
3979 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3980 (if (>= 22 (- (match-end 1)
3981 (match-beginning 0)))
3982 '(space :align-to 24)
3983 '(space :width 2)))
3984 (setq cont (looking-at "."))
3985 (while (and (= (forward-line 1) 0)
3987 (put-text-property (match-beginning 1) (1- (match-end 1))
3988 'invisible t)
3989 (put-text-property (1- (match-end 1)) (match-end 1)
3990 'display
3991 (if cont
3992 '(space :align-to 26)
3993 '(space :align-to 24)))
3994 (setq cont t)))))))
3996 ;; Fontify menu headers
3997 ;; Add the face `info-menu-header' to any header before a menu entry
3998 (goto-char (point-min))
4000 (put-text-property (match-beginning 0) (match-end 0)
4001 'font-lock-face 'info-menu-header)
4003 (put-text-property (match-beginning 1) (match-end 1)
4004 'font-lock-face 'info-menu-header)))
4006 ;; Hide index line numbers
4007 (goto-char (point-min))
4008 (when (and not-fontified-p (Info-index-node))
4010 (put-text-property (match-beginning 0) (match-end 0)
4011 'invisible t)))
4013 ;; Fontify http and ftp references
4014 (goto-char (point-min))
4015 (when not-fontified-p
4017 (add-text-properties (match-beginning 0) (match-end 0)
4018 '(font-lock-face info-xref
4019 mouse-face highlight
4020 help-echo "mouse-2: go to this URL"))))
4022 (set-buffer-modified-p nil))))
4023 \f
4024 ;;; Speedbar support:
4025 ;; These functions permit speedbar to display the "tags" in the
4026 ;; current Info node.
4027 (eval-when-compile (require 'speedbar))
4029 (defvar Info-speedbar-key-map nil
4030 "Keymap used when in the info display mode.")
4032 (defun Info-install-speedbar-variables ()
4033 "Install those variables used by speedbar to enhance Info."
4034 (if Info-speedbar-key-map
4035 nil
4036 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4038 ;; Basic tree features
4039 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4040 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4041 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4042 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4043 )
4045 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4046 Info-speedbar-key-map
4047 Info-speedbar-hierarchy-buttons)))
4049 (defvar Info-speedbar-menu-items
4050 '(["Browse Node" speedbar-edit-line t]
4051 ["Expand Node" speedbar-expand-line
4052 (save-excursion (beginning-of-line)
4054 ["Contract Node" speedbar-contract-line
4055 (save-excursion (beginning-of-line)
4056 (looking-at "[0-9]+: *.-. "))]
4057 )
4058 "Additional menu-items to add to speedbar frame.")
4060 ;; Make sure our special speedbar major mode is loaded
4061 (if (featurep 'speedbar)
4062 (Info-install-speedbar-variables)
4063 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4065 ;;; Info hierarchy display method
4066 ;;;###autoload
4067 (defun Info-speedbar-browser ()
4068 "Initialize speedbar to display an Info node browser.
4069 This will add a speedbar major display mode."
4070 (interactive)
4071 (require 'speedbar)
4072 ;; Make sure that speedbar is active
4073 (speedbar-frame-mode 1)
4074 ;; Now, throw us into Info mode on speedbar.
4075 (speedbar-change-initial-expansion-list "Info")
4076 )
4078 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4079 "Display an Info directory hierarchy in speedbar.
4080 DIRECTORY is the current directory in the attached frame.
4081 DEPTH is the current indentation depth.
4082 NODE is an optional argument that is used to represent the
4083 specific node to expand."
4084 (if (and (not node)
4085 (save-excursion (goto-char (point-min))
4086 (let ((case-fold-search t))
4087 (looking-at "Info Nodes:"))))
4088 ;; Update our "current node" maybe?
4089 nil
4090 ;; We cannot use the generic list code, that depends on all leaves
4091 ;; being known at creation time.
4092 (if (not node)
4094 (let ((completions nil))
4095 (speedbar-select-attached-frame)
4096 (save-window-excursion
4097 (setq completions
4098 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4099 (select-frame (speedbar-current-frame))
4100 (if completions
4101 (speedbar-with-writable
4102 (dolist (completion completions)
4103 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4104 (cdr completion)
4105 (car completion)
4106 'Info-speedbar-goto-node
4107 (cdr completion)
4108 'info-xref depth))
4109 t)
4110 nil))))
4112 (defun Info-speedbar-goto-node (text node indent)
4113 "When user clicks on TEXT, go to an info NODE.
4114 The INDENT level is ignored."
4115 (speedbar-select-attached-frame)
4116 (let* ((buff (or (get-buffer "*info*")
4117 (progn (info) (get-buffer "*info*"))))
4118 (bwin (get-buffer-window buff 0)))
4119 (if bwin
4120 (progn
4121 (select-window bwin)
4122 (raise-frame (window-frame bwin)))
4123 (if speedbar-power-click
4124 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4125 (speedbar-select-attached-frame)
4126 (switch-to-buffer buff)))
4128 (error "Invalid node %s" node)
4129 (Info-find-node (match-string 1 node) (match-string 2 node))
4130 ;; If we do a find-node, and we were in info mode, restore
4131 ;; the old default method. Once we are in info mode, it makes
4132 ;; sense to return to whatever method the user was using before.
4133 (if (string= speedbar-initial-expansion-list-name "Info")
4134 (speedbar-change-initial-expansion-list
4135 speedbar-previously-used-expansion-list-name)))))
4137 (defun Info-speedbar-expand-node (text token indent)
4138 "Expand the node the user clicked on.
4139 TEXT is the text of the button we clicked on, a + or - item.
4140 TOKEN is data related to this node (NAME . FILE).
4141 INDENT is the current indentation depth."
4142 (cond ((string-match "+" text) ;we have to expand this file
4143 (speedbar-change-expand-button-char ?-)
4144 (if (speedbar-with-writable
4145 (save-excursion
4146 (end-of-line) (forward-char 1)
4147 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4148 (speedbar-change-expand-button-char ?-)
4149 (speedbar-change-expand-button-char ??)))
4150 ((string-match "-" text) ;we have to contract this node
4151 (speedbar-change-expand-button-char ?+)
4152 (speedbar-delete-subblock indent))
4153 (t (error "Ooops... not sure what to do")))
4154 (speedbar-center-buffer-smartly))
4156 (defun Info-speedbar-fetch-file-nodes (nodespec)
4157 "Fetch the subnodes from the info NODESPEC.
4158 NODESPEC is a string of the form: (file)node."
4159 (save-excursion
4160 ;; Set up a buffer we can use to fake-out Info.
4161 (set-buffer (get-buffer-create " *info-browse-tmp*"))
4162 (if (not (equal major-mode 'Info-mode))
4163 (Info-mode))
4164 ;; Get the node into this buffer
4166 (error "Invalid node specification %s" nodespec)
4167 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4168 ;; Scan the created buffer
4169 (goto-char (point-min))
4170 (let ((completions nil)
4171 (case-fold-search t)
4173 (match-string 1 nodespec))))
4174 ;; Always skip the first one...
4177 (let ((name (match-string 1)))
4178 (push (cons name
4180 (match-string 1)
4182 (concat (match-string 1) "Top")
4183 (concat "(" thisfile ")"
4185 (match-string 1)
4186 name)))))
4187 completions)))
4188 (nreverse completions))))
4190 ;;; Info mode node listing
4191 ;; This is called by `speedbar-add-localized-speedbar-support'
4192 (defun Info-speedbar-buttons (buffer)
4193 "Create a speedbar display to help navigation in an Info file.
4194 BUFFER is the buffer speedbar is requesting buttons for."
4195 (if (save-excursion (goto-char (point-min))
4196 (let ((case-fold-search t))
4197 (not (looking-at "Info Nodes:"))))
4198 (erase-buffer))
4199 (Info-speedbar-hierarchy-buttons nil 0))
4201 (dolist (mess '("^First node in file$"
4202 "^No `.*' in index$"
4203 "^No cross-reference named"
4204 "^No cross.references in this node$"
4205 "^No current Info node$"
4206 "^No menu in this node$"
4207 "^No more items in menu$"
4208 "^No more nodes$"
4210 "^No previous `i' command$"
4211 "^No previous items in menu$"
4212 "^No previous nodes$"
4213 "^No such item in menu$"
4214 "^No such node or anchor"
4215 "^Node has no"
4216 "^Point neither on reference nor in menu item description$"
4218 search-failed))
4219 (add-to-list 'debug-ignored-errors mess))
4221 ;;;; Desktop support
4223 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4224 "Auxiliary information to be saved in desktop file."
4225 (unless (member Info-current-file '(apropos history toc nil))
4226 (list Info-current-file Info-current-node)))
4228 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4229 desktop-buffer-name
4230 desktop-buffer-misc)
4231 "Restore an Info buffer specified in a desktop file."
4232 (let ((first (nth 0 desktop-buffer-misc))
4233 (second (nth 1 desktop-buffer-misc)))
4234 (when (and first second)
4235 (when desktop-buffer-name
4236 (set-buffer (get-buffer-create desktop-buffer-name))
4237 (Info-mode))
4238 (Info-find-node first second)
4239 (current-buffer))))
4241 (add-to-list 'desktop-buffer-mode-handlers
4242 '(Info-mode . Info-restore-desktop-buffer))
4244 (provide 'info)
4246 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4247 ;;; info.el ends here