| blob | 2737999b0900ce97edb954369b687018fccf6f78 |
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 entries)
1202 ;; Insert the entries just found.
1210 ;; Now remove duplicate entries under the same heading.
1217 ;; Fold case straight away; `member-ignore-case' here wasteful.
1225 ;; Note that on entry to this function the current-buffer must be the
1226 ;; *info* buffer; not the info tags buffer.
1228 ;; NODEPOS is either a position (in the Info file as a whole,
1229 ;; not relative to a subfile) or the name of a subfile.
1231 lastfilename)
1243 thisfilepos thisfilename)
1247 ;; read in version 19 stops at the end of number.
1248 ;; Advance to the next line.
1257 ;; Assume previous buffer is in Info-mode.
1258 ;; (set-buffer (get-buffer "*info*"))
1267 ;; Widen in case we are in the same subfile as before.
1277 "Unescape double quotes and backslashes in VALUE."
1283 unquote))
1285 ;; As of Texinfo 4.6, makeinfo writes constructs like
1286 ;; \0\h[image param=value ...\h\0]
1287 ;; into the Info file for handling images.
1290 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1291 whitespace or double quotes, it must be quoted in double quotes and
1296 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1297 parameter-string start)
1303 parameter-alist))
1304 parameter-alist))
1307 "Display images in current node."
1314 nil t)
1329 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1330 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1331 ;; including one optional trailing newline.
1333 "Hide unrecognized cookies in current node."
1340 nil t)
1347 "Select the Info node that point is in."
1348 ;; Bind this in case the user sets it to nil.
1351 ;; Find beginning of node.
1357 ;; Get nodename spelled as it is in the node.
1365 ;; Find the end of it, and narrow.
1368 ;; Narrow to the node contents
1380 ;; Add a new unique history item to full history list
1395 map)
1403 " ("
1408 ") "
1413 'help-echo
1414 "mouse-1: scroll forward, mouse-3: scroll back"
1418 \f
1419 ;; Go to an Info node specified with a filename-and-nodename string
1420 ;; of the sort that is found in pointers in nodes.
1422 ;; Don't autoload this function: the correct entry point for other packages
1423 ;; to use is `info'. --Stef
1424 ;; ;;;###autoload
1426 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1427 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1428 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1429 its sub-files).
1430 Completion is available, but only for node names in the current Info file.
1431 If FORK is non-nil (interactively with a prefix arg), show the node in
1432 a new Info buffer.
1433 If FORK is a string, it is the name to use for the new buffer."
1441 nodename)
1443 ""
1457 "Virtual completion table for file names input in Info node names.
1458 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1474 ;; If the file name has no suffix or a standard suffix,
1475 ;; include it.
1478 ;; But exclude subfiles of split Info files.
1480 ;; And exclude backup files.
1483 ;; If the file name ends in a standard suffix,
1484 ;; add the unsuffixed name as a completion option.
1493 ;; This function is used as the "completion table" while reading a node name.
1494 ;; It does completion using the alist in Info-read-node-completion-table
1495 ;; unless STRING starts with an open-paren.
1498 ;; First complete embedded file names.
1514 ;; If a file name was given, then any node is fair game.
1520 ;; Otherwise use Info-read-node-completion-table.
1528 ;; Arrange to highlight the proper letters in the completion list buffer.
1534 1
1544 nodename)))
1549 ;; Bind this in case the user sets it to nil.
1562 compl))))
1565 ;; If the buffer begins with a node header, process that first.
1568 ;; Now for the rest of the nodes.
1576 compl))))))))
1579 \f
1581 "If this node has been visited, restore the point value when we left."
1584 ;; Use string-equal, not equal, to ignore text props.
1590 \f
1598 "Search for REGEXP, starting from point, and select node it's found in.
1599 If DIRECTION is `backward', search in the reverse direction."
1627 ;; Hide Info file header for backward search
1639 ;; Skip node header line
1643 ;; Skip Tag Table node
1650 Info-search-whitespace-regexp)))
1665 ;; If no subfiles, give error now.
1670 Info-search-whitespace-regexp)))
1681 ;; Try other subfiles.
1692 ;; Find the subfile we just searched.
1694 ;; Skip that one.
1697 ;; Make a list of all following subfiles.
1698 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1707 list))
1711 ;; Put in forward order
1717 ;; Hide Info file header for backward search
1732 ;; Skip node header line
1736 ;; Skip Tag Table node
1743 Info-search-whitespace-regexp)))
1766 ;; Search landed in the same node
1772 ;; Use string-equal, not equal, to ignore text props.
1778 Info-history))))))
1781 "Search for a regexp case-sensitively."
1787 "Search for next regexp from a previous `Info-search' command."
1795 "Search for REGEXP in the reverse direction."
1814 nil t)
1816 bound noerror count
1819 bound noerror count
1846 \f
1848 "Extract the value of the node-pointer named NAME.
1849 If there is none, use ERRORNAME in the error message;
1850 if ERRORNAME is nil, just return nil."
1851 ;; Bind this in case the user sets it to nil.
1865 "Return a regexp matching a node name.
1866 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1867 saying which chars may appear in the node name.
1868 Submatch 1 is the complete node name.
1869 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1870 Submatch 3 is the local part of the node name.
1871 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1878 ;;; For compatibility; other files have used this name.
1884 "Go to the next node of this node."
1886 ;; In case another window is currently selected
1892 "Go to the previous node of this node."
1894 ;; In case another window is currently selected
1900 "Go to the superior node of this node.
1901 If SAME-FILE is non-nil, do not move to a different Info file."
1903 ;; In case another window is currently selected
1922 nil t))
1928 "Go back in the history to the last node visited."
1934 Info-history-forward))
1935 filename nodename opoint)
1948 "Go forward in the history of visited nodes."
1953 filename nodename opoint)
1961 ;;;###autoload
1963 "Go to the Info directory node."
1966 \f
1968 "Go to a node with a menu of visited nodes."
1972 p)
1997 "Go to a node with table of contents of the current Info file.
1998 Table of contents is created from the tree structure of menus."
2003 p)
2033 "Insert table of contents with references to nodes."
2045 "Build table of contents from menus of Info FILE and its subfiles."
2050 default-directory))
2053 nodes subfiles)
2065 menu-items)
2074 bound))
2077 ;; Menu item line
2087 ;; Other non-empty strings in the Top node are section names
2096 nodes))
2105 subfiles)))))
2107 main-file nil))
2111 \f
2113 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2114 FOOTNOTENAME may be an abbreviation of the reference name.
2115 If FORK is non-nil (interactively with a prefix arg), show the node in
2116 a new Info buffer. If FORK is a string, it is the name to use for the
2117 new buffer."
2123 ;; Store end and beginning of line.
2132 ;; See if this one should be the default.
2137 ;; See if this one should be the alternate default.
2147 ;; Record as a completion and perhaps as default.
2150 ;; Don't add this string if it's a duplicate.
2153 ;; If no good default was found, try an alternate.
2156 ;; If only one cross-reference found, then make it default.
2162 "Follow reference named (default "
2165 completions nil t)))
2179 ;; Move point to the beginning of reference if point is on reference
2189 ;; Go to the reference closest to point
2197 next-ref prev-ref))
2208 ;; We allow newline because this is also used in Info-follow-reference,
2209 ;; where the xref name might be wrapped over two lines.
2210 "Regexp that matches a menu entry name upto but not including the colon.
2211 Because of ambiguities, this should be concatenated with something like
2232 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2233 ;;; (setq Info-point-loc
2234 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2235 )
2239 ;; If the node name is the menu entry name (using `entry::').
2243 ;; No one calls this.
2244 ;;(defun Info-menu-item-sequence (list)
2245 ;; (while list
2246 ;; (Info-menu (car list))
2247 ;; (setq list (cdr list))))
2259 ;; This uses two dynamically bound variables:
2260 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2261 ;; is the menu of items we're trying to complete.
2262 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2263 ;; also look for menu items in subsequent nodes as long as those
2264 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2265 ;; not used.
2266 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2267 ;; also look for menu items in these nodes. This feature is currently
2268 ;; only used for completion in Info-index.
2270 ;; Note that `Info-complete-menu-buffer' could be current already,
2271 ;; so we want to save point.
2277 nextnode)
2286 completions
2288 ;; Check the cache.
2296 ;; We can reuse the previous list.
2298 ;; The cache can't be used.
2303 completions))
2304 ;; Check subsequent nodes if applicable.
2312 ;; Go back to the start node (for the next completion).
2315 ;; Update the cache.
2318 Info-complete-next-re string completions
2319 Info-complete-nodes)))
2326 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2327 The menu item should one of those listed in the current node's menu.
2328 Completion is allowed, and the default menu item is the one point is on.
2329 If FORK is non-nil (interactively with a prefix arg), show the node in
2330 a new Info buffer. If FORK is a string, it is the name to use for the
2331 new buffer."
2334 ;; If point is within a menu item, use that item as the default
2337 beg
2350 Info-menu-entry-name-re
2359 default)
2362 ;; we rely on the fact that completing-read accepts an input
2363 ;; of "" even when the require-match argument is true and ""
2364 ;; is not a valid possibility
2368 ;; ask again
2371 ;; there is a problem here in that if several menu items have the same
2372 ;; name you can only go to the node of the first with this command.
2390 ;; If COUNT is nil, use the last item in the menu.
2402 nil))
2406 "Go to the node of the Nth menu item.
2407 N is the digit argument used to invoke this command."
2414 "Go to the Top node of this file."
2419 "Go to the final node in this file."
2424 ;; Go to the last node in the menu of Top.
2426 ;; If the last node in the menu is not last in pointer structure,
2427 ;; move forward until we can't go any farther.
2429 ;; Then keep moving down to last subnode, unless we reach an index.
2435 "Go forward one node, considering all nodes as forming one sequence."
2440 ;; three possibilities, in order of priority:
2441 ;; 1. next node is in a menu in this node (but not in an index)
2442 ;; 2. next node is next at same level
2443 ;; 3. next node is up and next
2448 t)
2451 t)
2453 ;; Use string-equal, not equal, to ignore text props.
2466 "Go backward one node, considering all nodes as forming one sequence."
2474 ;; Use string-equal, not equal,
2475 ;; to ignore text properties.
2480 ;; If we move back at the same level,
2481 ;; go down to find the last subnode*.
2491 "Exit Info by selecting some other buffer."
2498 "Go to the node of the next menu item."
2500 ;; Bind this in case the user sets it to nil.
2512 "Go to the node of the previous menu item."
2516 ;; Bind this in case the user sets it to nil.
2531 "Go to the next subnode or the next node, or go up a level."
2536 ;; Since we have already gone thru all the items in this menu,
2537 ;; go up to the end of this node.
2539 ;; Since logically we are done with the node with that menu,
2540 ;; move on from it.
2546 "Go to the last node, popping up a level if there is none."
2550 ;; If we go down a menu item, go to the end of the node
2551 ;; so we can scroll back through it.
2553 ;; Keep going down, as long as there are nested menu nodes.
2556 ;; If we go down a menu item, go to the end of the node
2557 ;; so we can scroll back through it.
2567 ;; If we go down a menu item, go to the end of the node
2568 ;; so we can scroll back through it.
2579 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2580 Once you scroll far enough in a node that its menu appears on the screen
2581 but after point, the next scroll moves into its first subnode, unless
2582 `Info-scroll-prefer-subnodes' is nil.
2584 When you scroll past the end of a node, that goes to the next node if
2585 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2586 if this node has no successor, it moves to the parent node's successor,
2587 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2588 the menu of a node, it moves to subnode indicated by the following menu
2589 item. (That case won't normally result from this command, but can happen
2590 in other ways.)"
2612 "Scroll one screenful back in Info, considering all nodes as one sequence.
2613 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2614 is non-nil, this goes to its last subnode. When you scroll past the
2615 beginning of a node, that goes to the previous node or back up to the
2616 parent node."
2630 current-point
2631 t)))))
2638 "Move cursor to the next cross-reference or menu item in the node."
2660 "Move cursor to the previous cross-reference or menu item in the node."
2679 \f
2681 "Alist of cached index node names of visited Info files.
2685 "Return a list of names of all index nodes in Info FILE.
2686 If FILE is omitted, it defaults to the current Info file.
2687 First look in a list of cached index node names. Then scan Info
2688 file and its subfiles for nodes with the index cookie. Then try
2689 to find index nodes starting from the first node in the top level
2694 ;; Skip virtual Info files
2699 ;; Find nodes with index cookie
2703 default-directory))
2704 Info-history Info-history-list Info-fontify-maximum-menu-size
2724 subfiles)))))
2726 main-file nil))
2732 nodes)
2733 ;; Else find nodes with the word "Index" in the node name
2735 Info-history Info-history-list Info-fontify-maximum-menu-size
2736 nodes node)
2754 nodes))
2755 ;; If file has no index nodes, still add it to the cache
2760 "Return non-nil value if NODE is an index node.
2761 If NODE is nil, check the current Info node.
2762 If FILE is nil, check the current Info file."
2766 ;; Don't search all index nodes if request is only for the current node
2767 ;; and file is not in the cache of index nodes
2781 "Go to the first index node."
2786 ;;;###autoload
2788 "Look up a string TOPIC in the index for this manual and go to that entry.
2789 If there are no exact matches to the specified topic, this chooses
2790 the first match which is a case-insensitive substring of a topic.
2792 Give an empty topic name to go to the Index node itself."
2808 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2817 ;; We bind Info-history to nil for internal node-switches so
2818 ;; that we don't put junk in the history. In the first
2819 ;; Info-goto-index call, above, we do update the history
2820 ;; because that is what the user's previous node choice into it.
2822 found)
2829 Info-current-node
2832 matches))
2839 ;; Here it is a feature that assoc is case-sensitive.
2874 "Move point to the place within the current node where NAME is defined."
2879 ;; Find a function definition with a return type.
2887 nil t))
2889 ;; Try again without the " <1>" makeinfo can append
2895 ;;;###autoload
2897 "Grovel indices of all known Info files on your system for STRING.
2898 Build a menu of the possible matches."
2901 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2907 manuals matches node nodes)
2910 ;; current-node and current-file are nil when they invoke info-apropos
2911 ;; as the first Info command, i.e. info-apropos loads info.el. In that
2912 ;; case, we use (DIR)Top instead, to avoid signalling an error after
2913 ;; the search is complete.
2921 ;; add-to-list makes sure we don't have duplicates in `manuals',
2922 ;; so that the following dolist loop runs faster.
2939 matches)))
2948 Info-history-list ohist-list)
2969 "Make command be undefined in Info."
2974 "Enter the Info tutorial."
2979 "Help-Small-Screen"
2983 "Display a brief summary of all Info commands."
2998 flag))
3001 \f
3003 "Return the token around POS.
3004 POS must be somewhere inside the token
3005 START is a regular expression which will match the
3006 beginning of the tokens delimited string
3007 ALL is a regular expression with a single
3008 parenthesized subpattern which is the token to be
3009 returned. E.g. '{\(.*\)}' would return any string
3010 enclosed in braces around POS.
3011 ERRORSTRING optional fourth argument, controls action on no match
3012 nil: return nil
3013 t: beep
3014 a string: signal an error, using that string."
3018 ;; First look for a match for START that goes across POS.
3022 ;; If we did not find one, search back for START
3023 ;; (this finds only matches that end at or before POS).
3036 nil)
3039 nil)
3045 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3046 At end of the node's text, moves to the next node, or up if none."
3054 "Follow a node reference near point.
3055 If point is on a reference, follow that reference. Otherwise,
3056 if point is in a menu item description, follow that menu item.
3058 If FORK is non-nil (interactively with a prefix arg), show the node in
3059 a new Info buffer.
3060 If FORK is a string, it is the name to use for the new buffer."
3072 t)))
3075 ;; Common subroutine.
3077 "Follow a node reference near point. Return non-nil if successful."
3086 ;; menu item: node name
3089 ;; menu item: node name or index entry
3103 node))
3104 \f
3108 nil
3118 (define-key Info-mode-map "1" 'Info-nth-menu-item)
3119 (define-key Info-mode-map "2" 'Info-nth-menu-item)
3120 (define-key Info-mode-map "3" 'Info-nth-menu-item)
3121 (define-key Info-mode-map "4" 'Info-nth-menu-item)
3122 (define-key Info-mode-map "5" 'Info-nth-menu-item)
3123 (define-key Info-mode-map "6" 'Info-nth-menu-item)
3124 (define-key Info-mode-map "7" 'Info-nth-menu-item)
3125 (define-key Info-mode-map "8" 'Info-nth-menu-item)
3126 (define-key Info-mode-map "9" 'Info-nth-menu-item)
3127 (define-key Info-mode-map "0" 'undefined)
3128 (define-key Info-mode-map "?" 'Info-summary)
3129 (define-key Info-mode-map "]" 'Info-forward-node)
3130 (define-key Info-mode-map "[" 'Info-backward-node)
3131 (define-key Info-mode-map "<" 'Info-top-node)
3132 (define-key Info-mode-map ">" 'Info-final-node)
3133 (define-key Info-mode-map "b" 'beginning-of-buffer)
3134 (define-key Info-mode-map "d" 'Info-directory)
3135 (define-key Info-mode-map "e" 'Info-edit)
3136 (define-key Info-mode-map "f" 'Info-follow-reference)
3137 (define-key Info-mode-map "g" 'Info-goto-node)
3138 (define-key Info-mode-map "h" 'Info-help)
3139 (define-key Info-mode-map "i" 'Info-index)
3140 (define-key Info-mode-map "l" 'Info-history-back)
3141 (define-key Info-mode-map "L" 'Info-history)
3142 (define-key Info-mode-map "m" 'Info-menu)
3143 (define-key Info-mode-map "n" 'Info-next)
3144 (define-key Info-mode-map "p" 'Info-prev)
3145 (define-key Info-mode-map "q" 'Info-exit)
3146 (define-key Info-mode-map "r" 'Info-history-forward)
3147 (define-key Info-mode-map "s" 'Info-search)
3148 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
3149 ;; For consistency with Rmail.
3150 (define-key Info-mode-map "\M-s" 'Info-search)
3151 (define-key Info-mode-map "\M-n" 'clone-buffer)
3152 (define-key Info-mode-map "t" 'Info-top-node)
3153 (define-key Info-mode-map "T" 'Info-toc)
3154 (define-key Info-mode-map "u" 'Info-up)
3155 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3156 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
3157 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
3158 ;; `^' for consistency with `dired-up-directory'.
3159 (define-key Info-mode-map "^" 'Info-up)
3160 (define-key Info-mode-map "," 'Info-index-next)
3162 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
3163 (define-key Info-mode-map [follow-link] 'mouse-face)
3164 )
3166 (defun Info-check-pointer (item)
3167 "Non-nil if ITEM is present in this node."
3168 (condition-case nil
3169 (Info-extract-pointer item)
3170 (error nil)))
3172 (easy-menu-define
3173 Info-mode-menu Info-mode-map
3174 "Menu for Info files."
3175 '("Info"
3176 ["Up" Info-up :active (Info-check-pointer "up")
3177 :help "Go up in the Info tree"]
3178 ["Next" Info-next :active (Info-check-pointer "next")
3179 :help "Go to the next node"]
3180 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3181 :help "Go to the previous node"]
3182 ["Backward" Info-backward-node
3183 :help "Go backward one node, considering all as a sequence"]
3184 ["Forward" Info-forward-node
3185 :help "Go forward one node, considering all as a sequence"]
3186 ["Beginning" beginning-of-buffer
3187 :help "Go to beginning of this node"]
3188 ["Top" Info-top-node
3189 :help "Go to top node of file"]
3190 ["Final Node" Info-final-node
3191 :help "Go to final node in this file"]
3192 ("Menu Item" ["You should never see this" report-emacs-bug t])
3193 ("Reference" ["You should never see this" report-emacs-bug t])
3194 ["Search..." Info-search
3195 :help "Search for regular expression in this Info file"]
3196 ["Search Next" Info-search-next
3197 :help "Search for another occurrence of regular expression"]
3198 ["Go to Node..." Info-goto-node
3199 :help "Go to a named node"]
3200 ["Back in history" Info-history-back :active Info-history
3201 :help "Go back in history to the last node you were at"]
3202 ["Forward in history" Info-history-forward :active Info-history-forward
3203 :help "Go forward in history"]
3204 ["History" Info-history :active Info-history-list
3205 :help "Go to menu of visited nodes"]
3206 ["Table of Contents" Info-toc
3207 :help "Go to table of contents"]
3208 ("Index"
3209 ["Lookup a String..." Info-index
3210 :help "Look for a string in the index items"]
3211 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3212 :help "Look for another occurrence of previous item"]
3213 ["Lookup a string in all indices..." info-apropos
3214 :help "Look for a string in the indices of all manuals"])
3215 ["Copy Node Name" Info-copy-current-node-name
3216 :help "Copy the name of the current node into the kill ring"]
3217 ["Clone Info buffer" clone-buffer
3218 :help "Create a twin copy of the current Info buffer."]
3219 ["Exit" Info-exit :help "Stop reading Info"]))
3222 (defvar info-tool-bar-map
3223 (if (display-graphic-p)
3224 (let ((map (make-sparse-keymap)))
3225 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
3226 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map)
3227 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map)
3228 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map)
3229 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map)
3230 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3231 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3232 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3233 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3234 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3235 map)))
3237 (defvar Info-menu-last-node nil)
3238 ;; Last node the menu was created for.
3239 ;; Value is a list, (FILE-NAME NODE-NAME).
3241 (defun Info-menu-update ()
3242 "Update the Info menu for the current node."
3243 (condition-case nil
3244 (if (or (not (eq major-mode 'Info-mode))
3245 (equal (list Info-current-file Info-current-node)
3246 Info-menu-last-node))
3247 ()
3248 ;; Update menu menu.
3249 (let* ((Info-complete-menu-buffer (current-buffer))
3250 (items (nreverse (condition-case nil
3251 (Info-complete-menu-item "" nil t)
3252 (error nil))))
3253 entries current
3254 (number 0))
3255 (while (and items (< number 9))
3256 (setq current (car items)
3257 items (cdr items)
3258 number (1+ number))
3259 (setq entries (cons `[,current
3260 (Info-menu ,current)
3261 :keys ,(format "%d" number)]
3262 entries)))
3263 (if items
3264 (setq entries (cons ["Other..." Info-menu t] entries)))
3265 (or entries
3266 (setq entries (list ["No menu" nil nil] nil :active)))
3267 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3268 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3269 (let ((items nil)
3270 str i entries current
3271 (number 0)
3272 (case-fold-search t))
3273 (save-excursion
3274 (goto-char (point-min))
3276 (setq str (match-string 1))
3277 (setq i 0)
3279 (setq str (concat (substring str 0 i) " "
3280 (substring str (match-end 0))))
3281 (setq i (1+ i)))
3282 (setq items
3283 (cons str items))))
3284 (while (and items (< number 9))
3285 (setq current (car items)
3286 items (cdr items)
3287 number (1+ number))
3288 (setq entries (cons `[,current
3289 (Info-follow-reference ,current)
3290 t]
3291 entries)))
3292 (if items
3293 (setq entries (cons ["Other..." Info-follow-reference t]
3294 entries)))
3295 (or entries
3296 (setq entries (list ["No references" nil nil] nil :active)))
3297 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3298 ;; Update last seen node.
3299 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3300 ;; Try to avoid entering infinite beep mode in case of errors.
3301 (error (ding))))
3303 \f
3304 (defun Info-copy-current-node-name (&optional arg)
3305 "Put the name of the current Info node into the kill ring.
3306 The name of the Info file is prepended to the node name in parentheses.
3307 With a zero prefix arg, put the name inside a function call to `info'."
3308 (interactive "P")
3309 (unless Info-current-node
3310 (error "No current Info node"))
3311 (let ((node (if (stringp Info-current-file)
3312 (concat "(" (file-name-nondirectory Info-current-file) ")"
3313 Info-current-node))))
3314 (if (zerop (prefix-numeric-value arg))
3316 (unless (stringp Info-current-file)
3317 (setq node (format "(Info-find-node '%S '%S)"
3318 Info-current-file Info-current-node)))
3319 (kill-new node)
3320 (message "%s" node)))
3322 \f
3323 ;; Info mode is suitable only for specially formatted data.
3324 (put 'Info-mode 'mode-class 'special)
3325 (put 'Info-mode 'no-clone-indirect t)
3327 (defvar tool-bar-map)
3329 ;; Autoload cookie needed by desktop.el
3330 ;;;###autoload
3331 (defun Info-mode ()
3332 "Info mode provides commands for browsing through the Info documentation tree.
3334 one topic and contains references to other nodes which discuss related
3335 topics. Info has commands to follow the references and show you other nodes.
3341 Selecting other nodes:
3343 Follow a node reference you click on.
3344 This works with menu items, cross references, and
3346 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3351 Picking a menu item causes another node to be selected.
3361 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3365 Moving within a node:
3367 Once you scroll far enough in a node that its menu appears on the
3368 screen but after point, the next scroll moves into its first
3369 subnode. When after all menu items (or if there is no menu),
3370 move up to the parent node.
3372 already visible, try to go to the previous menu entry, or up
3373 if there is none.
3376 Advanced commands:
3378 and select the node in which the next occurrence is found.
3379 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3383 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3386 You may include a filename as well, as (FILENAME)NODENAME.
3387 1 .. 9 Pick first ... ninth item in node's menu.
3388 Every third `*' is highlighted to help pick the right number.
3392 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3393 (kill-all-local-variables)
3394 (setq major-mode 'Info-mode)
3395 (setq mode-name "Info")
3396 (setq tab-width 8)
3397 (use-local-map Info-mode-map)
3398 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3399 (set-syntax-table text-mode-syntax-table)
3400 (setq local-abbrev-table text-mode-abbrev-table)
3401 (setq case-fold-search t)
3402 (setq buffer-read-only t)
3403 (make-local-variable 'Info-current-file)
3404 (make-local-variable 'Info-current-subfile)
3405 (make-local-variable 'Info-current-node)
3406 (make-local-variable 'Info-tag-table-marker)
3407 (setq Info-tag-table-marker (make-marker))
3408 (make-local-variable 'Info-tag-table-buffer)
3409 (setq Info-tag-table-buffer nil)
3410 (make-local-variable 'Info-history)
3411 (make-local-variable 'Info-history-forward)
3412 (make-local-variable 'Info-index-alternatives)
3413 (setq header-line-format
3414 (if Info-use-header-line
3415 '(:eval (get-text-property (point-min) 'header-line))
3416 nil)) ; so the header line isn't displayed
3417 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3418 ;; This is for the sake of the invisible text we use handling titles.
3419 (make-local-variable 'line-move-ignore-invisible)
3420 (setq line-move-ignore-invisible t)
3421 (make-local-variable 'desktop-save-buffer)
3422 (make-local-variable 'widen-automatically)
3423 (setq widen-automatically nil)
3424 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3425 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3426 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
3427 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3428 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3429 (set (make-local-variable 'isearch-search-fun-function)
3430 'Info-isearch-search)
3431 (set (make-local-variable 'isearch-wrap-function)
3432 'Info-isearch-wrap)
3433 (set (make-local-variable 'isearch-push-state-function)
3434 'Info-isearch-push-state)
3435 (set (make-local-variable 'search-whitespace-regexp)
3436 Info-search-whitespace-regexp)
3437 (Info-set-mode-line)
3438 (run-mode-hooks 'Info-mode-hook))
3440 ;; When an Info buffer is killed, make sure the associated tags buffer
3441 ;; is killed too.
3442 (defun Info-kill-buffer ()
3443 (and (eq major-mode 'Info-mode)
3444 Info-tag-table-buffer
3445 (kill-buffer Info-tag-table-buffer)))
3447 (defun Info-clone-buffer-hook ()
3448 (when (bufferp Info-tag-table-buffer)
3449 (setq Info-tag-table-buffer
3450 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3451 (let ((m Info-tag-table-marker))
3452 (when (markerp m)
3453 (setq Info-tag-table-marker
3454 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3455 (with-current-buffer Info-tag-table-buffer
3456 (copy-marker (marker-position m)))
3457 (make-marker))))))
3459 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3460 (set-keymap-parent map text-mode-map)
3461 (define-key map "\C-c\C-c" 'Info-cease-edit)
3462 map)
3463 "Local keymap used within `e' command of Info.")
3465 ;; Info-edit mode is suitable only for specially formatted data.
3466 (put 'Info-edit-mode 'mode-class 'special)
3468 (defun Info-edit-mode ()
3469 "Major mode for editing the contents of an Info node.
3470 Like text mode with the addition of `Info-cease-edit'
3471 which returns to Info mode for browsing.
3473 (use-local-map Info-edit-map)
3474 (setq major-mode 'Info-edit-mode)
3475 (setq mode-name "Info Edit")
3476 (kill-local-variable 'mode-line-buffer-identification)
3477 (setq buffer-read-only nil)
3478 (force-mode-line-update)
3479 (buffer-enable-undo (current-buffer))
3480 (run-mode-hooks 'Info-edit-mode-hook))
3482 (defun Info-edit ()
3483 "Edit the contents of this Info node.
3484 Allowed only if variable `Info-enable-edit' is non-nil."
3485 (interactive)
3486 (or Info-enable-edit
3487 (error "Editing Info nodes is not enabled"))
3488 (Info-edit-mode)
3489 (message "%s" (substitute-command-keys
3492 (defun Info-cease-edit ()
3493 "Finish editing Info node; switch back to Info proper."
3494 (interactive)
3495 ;; Do this first, so nothing has changed if user C-g's at query.
3496 (and (buffer-modified-p)
3497 (y-or-n-p "Save the file? ")
3498 (save-buffer))
3499 (use-local-map Info-mode-map)
3500 (setq major-mode 'Info-mode)
3501 (setq mode-name "Info")
3502 (Info-set-mode-line)
3503 (setq buffer-read-only t)
3504 (force-mode-line-update)
3505 (and (marker-position Info-tag-table-marker)
3506 (buffer-modified-p)
3507 (message "Tags may have changed. Use Info-tagify if necessary")))
3508 \f
3509 (defvar Info-file-list-for-emacs
3510 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3511 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3512 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3513 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3514 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3515 ("copyright" . "autotype") ("executable" . "autotype")
3516 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3517 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3518 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3519 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3520 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3521 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3522 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3523 ("rfc2045" . "emacs-mime")
3524 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3525 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3526 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3527 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3528 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3529 ("mml" . "emacs-mime"))
3530 "List of Info files that describe Emacs commands.
3531 An element can be a file name, or a list of the form (PREFIX . FILE)
3532 where PREFIX is a name prefix and FILE is the file to look in.
3533 If the element is just a file name, the file name also serves as the prefix.")
3535 (defun Info-find-emacs-command-nodes (command)
3536 "Return a list of locations documenting COMMAND.
3537 The `info-file' property of COMMAND says which Info manual to search.
3538 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3539 defines heuristics for which Info manual to try.
3540 The locations are of the format used in `Info-history', i.e.
3541 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3542 in the first element of the returned list (which is treated specially in
3543 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3544 (let ((where '()) line-number
3548 (info-file "emacs")) ;default
3549 ;; Determine which Info file this command is documented in.
3550 (if (get command 'info-file)
3551 (setq info-file (get command 'info-file))
3552 ;; If it doesn't say explicitly, test its name against
3553 ;; various prefixes that we know.
3554 (let ((file-list Info-file-list-for-emacs))
3555 (while file-list
3556 (let* ((elt (car file-list))
3557 (name (if (consp elt)
3558 (car elt)
3559 elt))
3560 (file (if (consp elt) (cdr elt) elt))
3561 (case-fold-search nil)
3564 (if (string-match regexp (symbol-name command))
3565 (setq info-file file file-list nil))
3566 (setq file-list (cdr file-list))))))
3567 (Info-find-node info-file "Top")
3568 ;; Bind Info-history to nil, to prevent the index nodes from
3569 ;; getting into the node history.
3570 (let ((Info-history nil)
3571 (Info-history-list nil)
3572 node (nodes (Info-index-nodes)))
3573 (Info-goto-node (car nodes))
3574 (while
3575 (progn
3576 (goto-char (point-min))
3577 (while (re-search-forward cmd-desc nil t)
3578 (setq where
3579 (cons (list Info-current-file
3580 (match-string-no-properties 2)
3581 0)
3582 where))
3583 (setq line-number (and (match-beginning 3)
3584 (string-to-number (match-string 3)))))
3585 (and (setq nodes (cdr nodes) node (car nodes))))
3586 (Info-goto-node node)))
3587 (if (and line-number where)
3588 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3589 (cdr where))
3590 where)))
3592 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3593 ;;;###autoload
3594 (defun Info-goto-emacs-command-node (command)
3595 "Go to the Info node in the Emacs manual for command COMMAND.
3596 The command is found by looking up in Emacs manual's indices
3597 or in another manual found via COMMAND's `info-file' property or
3598 the variable `Info-file-list-for-emacs'.
3599 COMMAND must be a symbol or string."
3600 (interactive "CFind documentation for command: ")
3601 ;; If command is given as a string, convert it to a symbol.
3602 (if (stringp command)
3603 (setq command (intern command)))
3604 (or (commandp command)
3605 (signal 'wrong-type-argument (list 'commandp command)))
3606 (let ((where (Info-find-emacs-command-nodes command)))
3607 (if where
3608 (let ((num-matches (length where)))
3609 ;; Get Info running, and pop to it in another window.
3610 (save-window-excursion
3611 (info))
3612 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3613 ;; Bind Info-history to nil, to prevent the last Index node
3614 ;; visited by Info-find-emacs-command-nodes from being
3615 ;; pushed onto the history.
3616 (let ((Info-history nil) (Info-history-list nil)
3617 (line-number (nth 2 (car where))))
3618 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3619 (if (and (integerp line-number) (> line-number 0))
3620 (forward-line (1- line-number))))
3621 (if (> num-matches 1)
3622 (progn
3623 ;; (car where) will be pushed onto Info-history
3624 ;; when/if they go to another node. Put the other
3625 ;; nodes that were found on the history.
3626 (setq Info-history (nconc (cdr where) Info-history))
3627 (message "Found %d other entr%s. Use %s to see %s."
3628 (1- num-matches)
3629 (if (> num-matches 2) "ies" "y")
3631 (if (> num-matches 2) "them" "it")))))
3632 (error "Couldn't find documentation for %s" command))))
3634 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3635 ;;;###autoload
3636 (defun Info-goto-emacs-key-command-node (key)
3637 "Go to the node in the Emacs manual which describes the command bound to KEY.
3638 KEY is a string.
3639 Interactively, if the binding is `execute-extended-command', a command is read.
3640 The command is found by looking up in Emacs manual's indices
3641 or in another manual found via COMMAND's `info-file' property or
3642 the variable `Info-file-list-for-emacs'."
3643 (interactive "kFind documentation for key: ")
3644 (let ((command (key-binding key)))
3645 (cond ((null command)
3646 (message "%s is undefined" (key-description key)))
3647 ((and (interactive-p)
3648 (eq command 'execute-extended-command))
3649 (Info-goto-emacs-command-node
3650 (read-command "Find documentation for command: ")))
3651 (t
3652 (Info-goto-emacs-command-node command)))))
3653 \f
3654 (defvar Info-next-link-keymap
3655 (let ((keymap (make-sparse-keymap)))
3656 (define-key keymap [header-line mouse-1] 'Info-next)
3657 (define-key keymap [header-line mouse-2] 'Info-next)
3658 (define-key keymap [header-line down-mouse-1] 'ignore)
3659 (define-key keymap [mouse-2] 'Info-next)
3660 (define-key keymap [follow-link] 'mouse-face)
3661 keymap)
3662 "Keymap to put on the Next link in the text or the header line.")
3664 (defvar Info-prev-link-keymap
3665 (let ((keymap (make-sparse-keymap)))
3666 (define-key keymap [header-line mouse-1] 'Info-prev)
3667 (define-key keymap [header-line mouse-2] 'Info-prev)
3668 (define-key keymap [header-line down-mouse-1] 'ignore)
3669 (define-key keymap [mouse-2] 'Info-prev)
3670 (define-key keymap [follow-link] 'mouse-face)
3671 keymap)
3672 "Keymap to put on the Prev link in the text or the header line.")
3674 (defvar Info-up-link-keymap
3675 (let ((keymap (make-sparse-keymap)))
3676 (define-key keymap [header-line mouse-1] 'Info-up)
3677 (define-key keymap [header-line mouse-2] 'Info-up)
3678 (define-key keymap [header-line down-mouse-1] 'ignore)
3679 (define-key keymap [mouse-2] 'Info-up)
3680 (define-key keymap [follow-link] 'mouse-face)
3681 keymap)
3682 "Keymap to put on the Up link in the text or the header line.")
3684 (defun Info-fontify-node ()
3685 "Fontify the node."
3686 (save-excursion
3687 (let* ((inhibit-read-only t)
3688 (case-fold-search t)
3689 paragraph-markers
3690 (not-fontified-p ; the node hasn't already been fontified
3691 (not (let ((where (next-property-change (point-min))))
3692 (and where (not (= where (point-max)))))))
3693 (fontify-visited-p ; visited nodes need to be re-fontified
3694 (and Info-fontify-visited-nodes
3695 ;; Don't take time to refontify visited nodes in huge nodes
3696 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3697 rbeg rend)
3699 ;; Fontify header line
3700 (goto-char (point-min))
3702 (goto-char (match-end 0))
3704 (goto-char (match-end 0))
3705 (let* ((nbeg (match-beginning 2))
3706 (nend (match-end 2))
3707 (tbeg (match-beginning 1))
3708 (tag (match-string 1)))
3709 (if (string-equal (downcase tag) "node")
3710 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3711 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3712 (put-text-property tbeg nend 'mouse-face 'highlight)
3713 (put-text-property tbeg nend
3714 'help-echo
3715 (concat "mouse-2: Go to node "
3716 (buffer-substring nbeg nend)))
3717 ;; Always set up the text property keymap.
3718 ;; It will either be used in the buffer
3719 ;; or copied in the header line.
3720 (put-text-property
3721 tbeg nend 'keymap
3722 (cond
3723 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3724 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3725 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3726 (when Info-use-header-line
3727 (goto-char (point-min))
3728 (let* ((header-end (line-end-position))
3729 (header
3730 ;; If we find neither Next: nor Prev: link, show the entire
3731 ;; node header. Otherwise, don't show the File: and Node:
3732 ;; parts, to avoid wasting precious space on information that
3733 ;; is available in the mode line.
3734 (if (re-search-forward
3736 header-end t)
3737 (progn
3738 (goto-char (match-beginning 1))
3739 (buffer-substring (point) header-end))
3741 header-end t)
3742 (concat "No next, prev or up links -- "
3743 (buffer-substring (point) header-end))
3744 (buffer-substring (point) header-end)))))
3745 (put-text-property (point-min) (1+ (point-min))
3746 'header-line
3747 (replace-regexp-in-string
3748 "%"
3749 ;; Preserve text properties on duplicated `%'.
3750 (lambda (s) (concat s s)) header))
3751 ;; Hide the part of the first line
3752 ;; that is in the header, if it is just part.
3753 (unless (bobp)
3754 ;; Hide the punctuation at the end, too.
3756 (put-text-property (point) header-end 'invisible t)))))
3758 ;; Fontify titles
3759 (goto-char (point-min))
3760 (when (and font-lock-mode not-fontified-p)
3762 nil t)
3763 ;; Only consider it as an underlined title if the ASCII
3764 ;; underline has the same size as the text. A typical
3765 ;; counter example is when a continuation "..." is alone
3766 ;; on a line.
3767 (= (string-width (match-string 1))
3768 (string-width (match-string 2))))
3769 (let* ((c (preceding-char))
3770 (face
3771 (cond ((= c ?*) 'info-title-1)
3772 ((= c ?=) 'info-title-2)
3773 ((= c ?-) 'info-title-3)
3774 (t 'info-title-4))))
3775 (put-text-property (match-beginning 1) (match-end 1)
3776 'font-lock-face face))
3777 ;; This is a serious problem for trying to handle multiple
3778 ;; frame types at once. We want this text to be invisible
3779 ;; on frames that can display the font above.
3780 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3781 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3782 '(invisible t front-sticky nil rear-nonsticky t)))))
3784 ;; Fontify cross references
3785 (goto-char (point-min))
3786 (when (or not-fontified-p fontify-visited-p)
3787 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3788 (let ((start (match-beginning 0))
3789 (next (point))
3790 other-tag)
3791 (when not-fontified-p
3792 (when Info-hide-note-references
3793 (when (not (eq Info-hide-note-references 'hide))
3794 ;; *Note is often used where *note should have been
3795 (goto-char start)
3796 (skip-syntax-backward " ")
3797 (when (memq (char-before) '(?\( ?\[ ?\{))
3798 ;; Check whether the paren is preceded by
3799 ;; an end of sentence
3800 (skip-syntax-backward " ("))
3801 (setq other-tag
3803 "")
3804 ((memq (char-before) '(nil ?\. ?! ??))
3805 "See ")
3806 ((save-match-data
3807 (save-excursion
3809 "See ")
3810 (t "see "))))
3811 (goto-char next)
3812 (add-text-properties
3813 (match-beginning 1)
3814 (or (save-match-data
3816 (let ((start1 (match-beginning 1)))
3818 (+ start1 (match-beginning 0)))))
3819 (match-end 1))
3820 (if other-tag
3821 `(display ,other-tag front-sticky nil rear-nonsticky t)
3822 '(invisible t front-sticky nil rear-nonsticky t))))
3823 (add-text-properties
3824 (match-beginning 2) (match-end 2)
3825 (list
3826 'help-echo (if (or (match-end 5)
3827 (not (equal (match-string 4) "")))
3828 (concat "mouse-2: go to " (or (match-string 5)
3829 (match-string 4)))
3830 "mouse-2: go to this node")
3831 'mouse-face 'highlight)))
3832 (when (or not-fontified-p fontify-visited-p)
3833 (setq rbeg (match-beginning 2)
3834 rend (match-end 2))
3835 (put-text-property
3836 rbeg rend
3837 'font-lock-face
3838 ;; Display visited nodes in a different face
3839 (if (and Info-fontify-visited-nodes
3840 (save-match-data
3841 (let* ((node (replace-regexp-in-string
3843 (replace-regexp-in-string
3845 (or (match-string-no-properties 5)
3846 (and (not (equal (match-string 4) ""))
3847 (match-string-no-properties 4))
3848 (match-string-no-properties 2)))))
3849 (external-link-p
3851 (file (if external-link-p
3852 (file-name-nondirectory
3853 (match-string-no-properties 1 node))
3854 Info-current-file))
3855 (hl Info-history-list)
3856 res)
3857 (if external-link-p
3858 (setq node (if (equal (match-string 2 node) "")
3859 "Top"
3860 (match-string-no-properties 2 node))))
3861 (while hl
3862 (if (and (string-equal node (nth 1 (car hl)))
3863 (equal file
3864 (if (and external-link-p
3865 (stringp (caar hl)))
3866 (file-name-nondirectory
3867 (caar hl))
3868 (caar hl))))
3869 (setq res (car hl) hl nil)
3870 (setq hl (cdr hl))))
3871 res))) 'info-xref-visited 'info-xref))
3872 ;; For multiline ref, unfontify newline and surrounding whitespace
3873 (save-excursion
3874 (goto-char rbeg)
3875 (save-match-data
3877 (remove-text-properties (match-beginning 0)
3878 (match-end 0)
3879 '(font-lock-face t))))))
3880 (when not-fontified-p
3881 (when (memq Info-hide-note-references '(t hide))
3882 (add-text-properties (match-beginning 3) (match-end 3)
3883 '(invisible t front-sticky nil rear-nonsticky t))
3884 ;; Unhide the file name of the external reference in parens
3885 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3886 (remove-text-properties (match-beginning 6) (match-end 6)
3887 '(invisible t front-sticky nil rear-nonsticky t)))
3888 ;; Unhide newline because hidden newlines cause too long lines
3889 (save-match-data
3890 (let ((beg3 (match-beginning 3))
3891 (end3 (match-end 3)))
3893 (not (save-match-data
3894 (save-excursion
3895 (goto-char (1+ end3))
3896 (looking-at "[.)]*$")))))
3897 (remove-text-properties (+ beg3 (match-beginning 0))
3898 (+ beg3 (match-end 0))
3899 '(invisible t front-sticky nil rear-nonsticky t))))))
3900 (when (and Info-refill-paragraphs Info-hide-note-references)
3901 (push (set-marker (make-marker) start)
3902 paragraph-markers))))))
3904 ;; Refill paragraphs (experimental feature)
3905 (when (and not-fontified-p
3906 Info-refill-paragraphs
3907 paragraph-markers)
3908 (let ((fill-nobreak-invisible t)
3909 (fill-individual-varying-indent nil)
3912 (adaptive-fill-mode nil))
3913 (goto-char (point-max))
3914 (dolist (m paragraph-markers)
3915 (when (< m (point))
3916 (goto-char m)
3917 (beginning-of-line)
3918 (let ((beg (point)))
3919 (when (zerop (forward-paragraph))
3920 (fill-individual-paragraphs beg (point) nil nil)
3921 (goto-char beg))))
3922 (set-marker m nil))))
3924 ;; Fontify menu items
3925 (goto-char (point-min))
3926 (when (and (or not-fontified-p fontify-visited-p)
3928 (not (Info-index-node))
3929 ;; Don't take time to annotate huge menus
3930 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3931 (let ((n 0)
3932 cont)
3933 (while (re-search-forward
3936 nil t)
3937 (when (match-beginning 1)
3938 (when not-fontified-p
3939 (setq n (1+ n))
3940 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3941 (put-text-property (match-beginning 0)
3942 (1+ (match-beginning 0))
3943 'font-lock-face 'info-menu-star)))
3944 (when not-fontified-p
3945 (add-text-properties
3946 (match-beginning 1) (match-end 1)
3947 (list
3948 'help-echo (if (and (match-end 3)
3949 (not (equal (match-string 3) "")))
3950 (concat "mouse-2: go to " (match-string 3))
3951 "mouse-2: go to this node")
3952 'mouse-face 'highlight)))
3953 (when (or not-fontified-p fontify-visited-p)
3954 (put-text-property
3955 (match-beginning 1) (match-end 1)
3956 'font-lock-face
3957 ;; Display visited menu items in a different face
3958 (if (and Info-fontify-visited-nodes
3959 (save-match-data
3960 (let* ((node (if (equal (match-string 3) "")
3961 (match-string-no-properties 1)
3962 (match-string-no-properties 3)))
3963 (external-link-p
3965 (file (if external-link-p
3966 (file-name-nondirectory
3967 (match-string-no-properties 1 node))
3968 Info-current-file))
3969 (hl Info-history-list)
3970 res)
3971 (if external-link-p
3972 (setq node (if (equal (match-string 2 node) "")
3973 "Top"
3974 (match-string-no-properties 2 node))))
3975 (while hl
3976 (if (and (string-equal node (nth 1 (car hl)))
3977 (equal file
3978 (if (and external-link-p
3979 (stringp (caar hl)))
3980 (file-name-nondirectory
3981 (caar hl))
3982 (caar hl))))
3983 (setq res (car hl) hl nil)
3984 (setq hl (cdr hl))))
3985 res))) 'info-xref-visited 'info-xref)))
3986 (when (and not-fontified-p (memq Info-hide-note-references '(t hide)))
3987 (put-text-property (match-beginning 2) (1- (match-end 6))
3988 'invisible t)
3989 ;; Unhide the file name in parens
3990 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
3991 (remove-text-properties (match-beginning 4) (match-end 4)
3992 '(invisible t)))
3993 ;; We need a stretchable space like :align-to but with
3994 ;; a minimum value.
3995 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3996 (if (>= 22 (- (match-end 1)
3997 (match-beginning 0)))
3998 '(space :align-to 24)
3999 '(space :width 2)))
4000 (setq cont (looking-at "."))
4001 (while (and (= (forward-line 1) 0)
4003 (put-text-property (match-beginning 1) (1- (match-end 1))
4004 'invisible t)
4005 (put-text-property (1- (match-end 1)) (match-end 1)
4006 'display
4007 (if cont
4008 '(space :align-to 26)
4009 '(space :align-to 24)))
4010 (setq cont t)))))))
4012 ;; Fontify menu headers
4013 ;; Add the face `info-menu-header' to any header before a menu entry
4014 (goto-char (point-min))
4016 (put-text-property (match-beginning 0) (match-end 0)
4017 'font-lock-face 'info-menu-header)
4019 (put-text-property (match-beginning 1) (match-end 1)
4020 'font-lock-face 'info-menu-header)))
4022 ;; Hide index line numbers
4023 (goto-char (point-min))
4024 (when (and not-fontified-p (Info-index-node))
4026 (put-text-property (match-beginning 0) (match-end 0)
4027 'invisible t)))
4029 ;; Fontify http and ftp references
4030 (goto-char (point-min))
4031 (when not-fontified-p
4033 (add-text-properties (match-beginning 0) (match-end 0)
4034 '(font-lock-face info-xref
4035 mouse-face highlight
4036 help-echo "mouse-2: go to this URL"))))
4038 (set-buffer-modified-p nil))))
4039 \f
4040 ;;; Speedbar support:
4041 ;; These functions permit speedbar to display the "tags" in the
4042 ;; current Info node.
4043 (eval-when-compile (require 'speedbar))
4045 (defvar Info-speedbar-key-map nil
4046 "Keymap used when in the info display mode.")
4048 (defun Info-install-speedbar-variables ()
4049 "Install those variables used by speedbar to enhance Info."
4050 (if Info-speedbar-key-map
4051 nil
4052 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4054 ;; Basic tree features
4055 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4056 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4057 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4058 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4059 )
4061 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4062 Info-speedbar-key-map
4063 Info-speedbar-hierarchy-buttons)))
4065 (defvar Info-speedbar-menu-items
4066 '(["Browse Node" speedbar-edit-line t]
4067 ["Expand Node" speedbar-expand-line
4068 (save-excursion (beginning-of-line)
4070 ["Contract Node" speedbar-contract-line
4071 (save-excursion (beginning-of-line)
4072 (looking-at "[0-9]+: *.-. "))]
4073 )
4074 "Additional menu-items to add to speedbar frame.")
4076 ;; Make sure our special speedbar major mode is loaded
4077 (if (featurep 'speedbar)
4078 (Info-install-speedbar-variables)
4079 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4081 ;;; Info hierarchy display method
4082 ;;;###autoload
4083 (defun Info-speedbar-browser ()
4084 "Initialize speedbar to display an Info node browser.
4085 This will add a speedbar major display mode."
4086 (interactive)
4087 (require 'speedbar)
4088 ;; Make sure that speedbar is active
4089 (speedbar-frame-mode 1)
4090 ;; Now, throw us into Info mode on speedbar.
4091 (speedbar-change-initial-expansion-list "Info")
4092 )
4094 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4095 "Display an Info directory hierarchy in speedbar.
4096 DIRECTORY is the current directory in the attached frame.
4097 DEPTH is the current indentation depth.
4098 NODE is an optional argument that is used to represent the
4099 specific node to expand."
4100 (if (and (not node)
4101 (save-excursion (goto-char (point-min))
4102 (let ((case-fold-search t))
4103 (looking-at "Info Nodes:"))))
4104 ;; Update our "current node" maybe?
4105 nil
4106 ;; We cannot use the generic list code, that depends on all leaves
4107 ;; being known at creation time.
4108 (if (not node)
4110 (let ((completions nil))
4111 (speedbar-select-attached-frame)
4112 (save-window-excursion
4113 (setq completions
4114 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4115 (select-frame (speedbar-current-frame))
4116 (if completions
4117 (speedbar-with-writable
4118 (dolist (completion completions)
4119 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4120 (cdr completion)
4121 (car completion)
4122 'Info-speedbar-goto-node
4123 (cdr completion)
4124 'info-xref depth))
4125 t)
4126 nil))))
4128 (defun Info-speedbar-goto-node (text node indent)
4129 "When user clicks on TEXT, go to an info NODE.
4130 The INDENT level is ignored."
4131 (speedbar-select-attached-frame)
4132 (let* ((buff (or (get-buffer "*info*")
4133 (progn (info) (get-buffer "*info*"))))
4134 (bwin (get-buffer-window buff 0)))
4135 (if bwin
4136 (progn
4137 (select-window bwin)
4138 (raise-frame (window-frame bwin)))
4139 (if speedbar-power-click
4140 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4141 (speedbar-select-attached-frame)
4142 (switch-to-buffer buff)))
4144 (error "Invalid node %s" node)
4145 (Info-find-node (match-string 1 node) (match-string 2 node))
4146 ;; If we do a find-node, and we were in info mode, restore
4147 ;; the old default method. Once we are in info mode, it makes
4148 ;; sense to return to whatever method the user was using before.
4149 (if (string= speedbar-initial-expansion-list-name "Info")
4150 (speedbar-change-initial-expansion-list
4151 speedbar-previously-used-expansion-list-name)))))
4153 (defun Info-speedbar-expand-node (text token indent)
4154 "Expand the node the user clicked on.
4155 TEXT is the text of the button we clicked on, a + or - item.
4156 TOKEN is data related to this node (NAME . FILE).
4157 INDENT is the current indentation depth."
4158 (cond ((string-match "+" text) ;we have to expand this file
4159 (speedbar-change-expand-button-char ?-)
4160 (if (speedbar-with-writable
4161 (save-excursion
4162 (end-of-line) (forward-char 1)
4163 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4164 (speedbar-change-expand-button-char ?-)
4165 (speedbar-change-expand-button-char ??)))
4166 ((string-match "-" text) ;we have to contract this node
4167 (speedbar-change-expand-button-char ?+)
4168 (speedbar-delete-subblock indent))
4169 (t (error "Ooops... not sure what to do")))
4170 (speedbar-center-buffer-smartly))
4172 (defun Info-speedbar-fetch-file-nodes (nodespec)
4173 "Fetch the subnodes from the info NODESPEC.
4174 NODESPEC is a string of the form: (file)node."
4175 (save-excursion
4176 ;; Set up a buffer we can use to fake-out Info.
4177 (set-buffer (get-buffer-create " *info-browse-tmp*"))
4178 (if (not (equal major-mode 'Info-mode))
4179 (Info-mode))
4180 ;; Get the node into this buffer
4182 (error "Invalid node specification %s" nodespec)
4183 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4184 ;; Scan the created buffer
4185 (goto-char (point-min))
4186 (let ((completions nil)
4187 (case-fold-search t)
4189 (match-string 1 nodespec))))
4190 ;; Always skip the first one...
4193 (let ((name (match-string 1)))
4194 (push (cons name
4196 (match-string 1)
4198 (concat (match-string 1) "Top")
4199 (concat "(" thisfile ")"
4201 (match-string 1)
4202 name)))))
4203 completions)))
4204 (nreverse completions))))
4206 ;;; Info mode node listing
4207 ;; This is called by `speedbar-add-localized-speedbar-support'
4208 (defun Info-speedbar-buttons (buffer)
4209 "Create a speedbar display to help navigation in an Info file.
4210 BUFFER is the buffer speedbar is requesting buttons for."
4211 (if (save-excursion (goto-char (point-min))
4212 (let ((case-fold-search t))
4213 (not (looking-at "Info Nodes:"))))
4214 (erase-buffer))
4215 (Info-speedbar-hierarchy-buttons nil 0))
4217 (dolist (mess '("^First node in file$"
4218 "^No `.*' in index$"
4219 "^No cross-reference named"
4220 "^No cross.references in this node$"
4221 "^No current Info node$"
4222 "^No menu in this node$"
4223 "^No more items in menu$"
4224 "^No more nodes$"
4226 "^No previous `i' command$"
4227 "^No previous items in menu$"
4228 "^No previous nodes$"
4229 "^No such item in menu$"
4230 "^No such node or anchor"
4231 "^Node has no"
4232 "^Point neither on reference nor in menu item description$"
4234 search-failed))
4235 (add-to-list 'debug-ignored-errors mess))
4237 ;;;; Desktop support
4239 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4240 "Auxiliary information to be saved in desktop file."
4241 (unless (member Info-current-file '(apropos history toc nil))
4242 (list Info-current-file Info-current-node)))
4244 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4245 desktop-buffer-name
4246 desktop-buffer-misc)
4247 "Restore an Info buffer specified in a desktop file."
4248 (let ((first (nth 0 desktop-buffer-misc))
4249 (second (nth 1 desktop-buffer-misc)))
4250 (when (and first second)
4251 (when desktop-buffer-name
4252 (set-buffer (get-buffer-create desktop-buffer-name))
4253 (Info-mode))
4254 (Info-find-node first second)
4255 (current-buffer))))
4257 (add-to-list 'desktop-buffer-mode-handlers
4258 '(Info-mode . Info-restore-desktop-buffer))
4260 (provide 'info)
4262 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4263 ;;; info.el ends here