| blob | 5a0c4ce6611a9cb94fa17618e7b8ff75d6812c25 |
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, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Keywords: help
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;; Note that nowadays we expect Info files to be made using makeinfo.
30 ;; In particular we make these assumptions:
31 ;; - a menu item MAY contain colons but not colon-space ": "
32 ;; - a menu item ending with ": " (but not ":: ") is an index entry
33 ;; - a node name MAY NOT contain a colon
34 ;; This distinction is to support indexing of computer programming
35 ;; language terms that may contain ":" but not ": ".
37 ;;; Code:
42 "Info subsystem."
48 "Stack of Info nodes user has visited.
52 "Stack of Info nodes user has visited with `Info-history-back' command.
56 "List of all Info nodes user has visited.
61 This is convenient if you want to write Info files by hand.
62 However, we recommend that you not do this.
63 It is better to write a Texinfo file and generate the Info file from that,
64 because that gives you a printed manual as well."
69 "Non-nil allows Info to execute Lisp code associated with nodes.
77 "Face for Info node names."
86 "Face for info titles at level 1."
88 ;; backward-compatibility alias
94 "Face for info titles at level 2."
96 ;; backward-compatibility alias
102 "Face for info titles at level 3."
104 ;; backward-compatibility alias
110 "Face for info titles at level 4."
112 ;; backward-compatibility alias
117 :underline t
120 :inherit variable-pitch
122 "Face for headers in Info menus."
128 "Face for every third `*' in an Info menu."
134 "Face for unvisited Info cross-references."
139 "Face for visited Info cross-references."
144 "*Non-nil to fontify references to visited nodes in `info-xref-visited' face."
150 "*Maximum size of menu to fontify if `font-lock-mode' is non-nil.
151 Set to nil to disable node fontification."
156 "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
157 A header-line does not scroll with the rest of the buffer."
163 "Face for Info cross-references in a node header."
168 "Face for Info nodes in a node header."
172 "List of directories to search for Info documentation files.
173 If nil, meaning not yet initialized, Info uses the environment
174 variable INFOPATH to initialize it, or `Info-default-directory-list'
175 if there is no INFOPATH variable in the environment, or the
176 concatenation of the two if INFOPATH ends with a colon.
178 When `Info-directory-list' is initialized from the value of
179 `Info-default-directory-list', and Emacs is installed in one of the
180 standard directories, the directory of Info files that come with Emacs
181 is put last (so that local Info files override standard ones).
183 When `Info-directory-list' is initialized from the value of
184 `Info-default-directory-list', and Emacs is not installed in one
185 of the standard directories, the first element of the resulting
186 list is the directory where Emacs installs the Info files that
187 come with it. This is so that Emacs's own manual, which suits the
188 version of Emacs you are using, will always be found first. This
189 is useful when you install an experimental version of Emacs without
190 removing the standard installation.
192 If you want to override the order of directories in
193 `Info-default-directory-list', set INFOPATH in the environment.
195 If you run the Emacs executable from the `src' directory in the Emacs
196 source tree, and INFOPATH is not defined, the `info' directory in the
197 source tree is used as the first element of `Info-directory-list', in
198 place of the installation Info directory. This is useful when you run
202 "List of additional directories to search for Info documentation files.
203 These directories are searched after those in `Info-directory-list'."
210 If this is non-nil, and you scroll far enough in a node that its menu
212 moves to a subnode indicated by the following menu item. This means
213 that you visit a subnode before getting to the end of the menu.
215 Setting this option to nil results in behavior similar to the stand-alone
216 Info reader program, which visits the first subnode from the menu only
217 when you hit the end of the current node."
223 "*If non-nil, hide the tag and section reference in *note and * menu items.
225 If value is non-nil but not t or `hide', the reference section is still shown.
226 `nil' completely disables this feature."
235 "*If non-nil, attempt to refill paragraphs with hidden references.
236 This refilling may accidentally remove explicit line breaks in the Info
237 file, so be prepared for a few surprises if you enable this feature."
243 "*If non-nil, regular expression to match a sequence of whitespace chars.
244 This applies to Info search for regular expressions.
246 In the Customization buffer, that is `[' followed by a space,
247 a tab, a carriage return (control-M), a newline, and `]+'."
252 "*If non-nil, isearch in Info searches through multiple nodes.
253 Before leaving the initial Info node, where isearch was started,
254 it fails once with the error message [initial node], and with
255 subsequent C-s/C-r continues through other nodes without failing
256 with this error message in other nodes. When isearch fails for
257 the rest of the manual, it wraps aroung the whole manual and
258 restarts the search from the top/final node depending on
259 search direction.
261 Setting this option to nil restores the default isearch behavior
262 with wrapping around the current Info node."
270 ;; Try to obey obsolete Info-fontify settings.
273 "Hooks run when `Info-mode' is called."
278 "Hooks run when `Info-select-node' is called."
286 "Info file that Info is now looking at, or nil.
287 This is the name that was specified in Info, not the actual file name.
291 "Info subfile that is actually in the *info* buffer now.
298 "Marker pointing at beginning of current Info file's tag table.
314 "Point location within a selected node.
315 If string, the point is moved to the proper occurrence of the
316 name of the followed cross reference within a selected node.
321 \f
323 ;; The MS-DOS list should work both when long file names are
324 ;; supported (Windows 9X), and when only 8+3 file names are available.
366 "List of file name suffixes and associated decoding commands.
367 Each entry should be (SUFFIX . STRING); the file is given to
368 the command as standard input.
370 STRING may be a list of strings. In that case, the first element is
371 the command name, and the rest are arguments to that command.
373 If STRING is nil, no decoding is done.
374 Because the SUFFIXes are tried in order, the empty string should
377 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
378 ;; First, on MS-DOS with no long file names support, delete some of
379 ;; the extension in FILENAME to make room.
384 ;; How long is the extension in FILENAME (not counting the dot).
386 ext-left)
387 ;; SUFFIX starts with a dot. If FILENAME already has one,
388 ;; get rid of the one in SUFFIX (unless suffix is empty).
393 ;; How many chars of that extension should we keep?
395 ;; Get rid of the rest of the extension, and add SUFFIX.
398 suffix))))
405 "Insert the contents of an Info file in the current buffer.
406 Do the right thing if the file has been compressed or zipped."
410 t))
412 lfn))
413 fullname decoder done)
415 ;; FILENAME exists--see if that name contains a suffix.
416 ;; If so, set DECODE accordingly.
421 filename)))
425 ;; Try adding suffixes to FILENAME and see if we can find something.
431 ;; If we found a file with a suffix, set DECODER
432 ;; according to the suffix.
434 ;; When the MS-DOS port runs on Windows, we need to check
435 ;; the short variant of a long file name as well.
445 ;; check for conflict with jka-compr
455 default-directory)))
461 \f
468 "../share/info/"
469 invocation-directory)))
471 infodir
473 "../../../share/info/"
474 invocation-directory))
476 infodir))))))
477 alternative)
480 ;; Uninstalled, Emacs builddir != srcdir.
481 sibling
482 ;; Uninstalled, builddir == srcdir
483 source))
485 ;; On DOS/NT, we use movable executables always,
486 ;; and we must always find the Info dir at run time.
488 nil
489 ;; Use invocation-directory for Info
490 ;; only if we used it for exec-directory also.
493 installation-directory))))
495 Info-default-directory-list
496 ;; `alternative' contains the Info files that came with this
497 ;; version, so we should look there first. `Info-insert-dir'
498 ;; currently expects to find `alternative' first on the list.
500 ;; Don't drop the last part, it might contain non-Emacs stuff.
501 ;; (reverse (cdr (reverse
505 "Initialize `Info-directory-list', if that hasn't been done yet."
518 ;;;###autoload
520 "Like `info' but show the Info buffer in another window."
526 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
528 ;;;###autoload (put 'info 'info-file "emacs")
529 ;;;###autoload
531 "Enter Info, the documentation browser.
532 Optional argument FILE-OR-NODE specifies the file to examine;
533 the default is the top-level directory of Info.
534 Called from a program, FILE-OR-NODE may specify an Info node of the form
535 `(FILENAME)NODENAME'.
536 Optional argument BUFFER specifies the Info buffer name;
537 the default buffer name is *info*. If BUFFER exists,
538 just switch to BUFFER. Otherwise, create a new buffer
539 with the top-level Info directory.
541 In interactive use, a non-numeric prefix argument directs
542 this command to read a file name from the minibuffer.
543 A numeric prefix argument selects an Info buffer with the prefix number
544 appended to the Info buffer name.
546 The search path for Info files is in the variable `Info-directory-list'.
547 The top-level Info directory is made by combining all the files named `dir'
548 in all the directories in that path."
558 ;; If argument already contains parentheses, don't add another set
559 ;; since the argument will then be parsed improperly. This also
560 ;; has the added benefit of allowing node names to be included
561 ;; following the parenthesized filename.
564 file-or-node
568 ;; If we just created the Info buffer, go to the directory.
571 ;;;###autoload
573 "Display the Emacs manual in Info mode."
577 ;;;###autoload
579 "Run Emacs as a standalone Info reader.
580 Usage: emacs -f info-standalone [filename]
594 \f
595 ;; See if the accessible portion of the buffer begins with a node
596 ;; delimiter, and the node header line which follows matches REGEXP.
597 ;; Typically, this test will be followed by a loop that examines the
598 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
599 ;; to have the overhead of this special test inside the loop.
601 ;; This function changes match-data, but supposedly the caller might
602 ;; want to use the results of re-search-backward.
604 ;; The return value is the value of point at the beginning of matching
605 ;; REGEXP, if the function succeeds, nil otherwise.
617 Optional second argument NOERROR, if t, means if file is not found
618 just return nil (no error)."
619 ;; Convert filename to lower case if not found as specified.
620 ;; Expand it.
629 ;; If specified name starts with `./'
630 ;; then just try current directory.
633 ;; No point in searching for an
634 ;; absolute file name
638 Info-additional-directory-list)
639 Info-directory-list)))))
640 ;; Search the directory list for file FILENAME.
645 ;; Try several variants of specified name.
649 t)))
660 lfn
672 filename)
676 "Go to an Info node specified as separate FILENAME and NODENAME.
677 NO-GOING-BACK is non-nil if recovering from an error in this function;
678 it says do not attempt further (recursive) error recovery."
681 ;; Go into Info buffer.
683 ;; Record the node we are leaving, if we were in one.
685 Info-current-file
688 Info-history)))
691 ;;;###autoload
693 "Use Info mode to browse the current Info buffer.
694 With a prefix arg, this queries for the node name to visit first;
695 otherwise, that defaults to `Top'."
705 ;; If called on a non-file buffer, make a fake file name.
709 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
710 ;; but at least it keeps this routine (which is for makeinfo-buffer and
711 ;; Info-revert-buffer-function) out of the way of normal operations.
712 ;;
714 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
715 When *info* is already displaying FILENAME and NODENAME, the window position
716 is preserved, if possible."
732 ;; note goto-line is no good, we want to measure from point-min
739 ;; only add to the history when coming from a different file+node
749 "Find a node in a tag table.
750 MARKER specifies the buffer and position to start searching at.
751 REGEXP is a regular expression matching nodes or references. Its first
752 group should match `Node:' or `Ref:'.
753 CASE-FOLD t means search for a case-insensitive match.
754 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
755 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
756 where the match was found, and MODE is `major-mode' of the buffer in
757 which the match was found."
763 ;; Search tag table
768 major-mode)))))
771 "Find a node in a tag table.
772 MARKER specifies the buffer and position to start searching at.
773 REGEXP is a regular expression matching nodes or references. Its first
774 group should match `Node:' or `Ref:'.
775 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
776 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
777 where the match was found, and MODE is `major-mode' of the buffer in
778 which the match was found.
779 This function tries to find a case-sensitive match first, then a
780 case-insensitive match is tried."
784 result))
787 "Find a node or anchor in the current buffer.
788 REGEXP is a regular expression matching nodes or references. Its first
789 group should match `Node:' or `Ref:'.
790 CASE-FOLD t means search for a case-insensitive match.
791 Value is the position at which a match was found, or nil if not found."
793 found)
805 found)))
808 "Find a node or anchor in the current buffer.
809 REGEXP is a regular expression matching nodes or references. Its first
810 group should match `Node:' or `Ref:'.
811 Value is the position at which a match was found, or nil if not found.
812 This function looks for a case-sensitive match first. If none is found,
813 a case-insensitive match is tried."
825 anchorpos)
826 ;; Switch files if necessary
831 Info-current-subfile nil
832 Info-current-file-completions nil
833 buffer-file-name nil)
849 ;; Check makeinfo version for index cookie support
861 ;; See whether file has a tag table. Record the location if yes.
864 ;; Use string-equal, not equal, to ignore text props.
869 ;; We have a tag table. Find its beginning.
870 ;; Is this an indirect file?
876 ;; It is indirect. Copy it to another buffer
877 ;; and record that the tag table is in that buffer.
897 ))
898 ;; Use string-equal, not equal, to ignore text props.
902 ;; Possibilities:
903 ;;
904 ;; 1. Anchor found in tag table
905 ;; 2. Anchor *not* in tag table
906 ;;
907 ;; 3. Node found in tag table
908 ;; 4. Node *not* found in tag table, but found in file
909 ;; 5. Node *not* in tag table, and *not* in file
910 ;;
911 ;; *Or* the same, but in an indirect subfile.
913 ;; Search file for a suitable node.
923 ;; First, search a tag table, if any
929 ;; FOUND is (ANCHOR POS MODE).
932 ;; If this is an indirect file, determine which
933 ;; file really holds this node and read it in.
935 ;; Note that the current buffer must be the
936 ;; *info* buffer on entry to
937 ;; Info-read-subfile. Thus the hackery above.
940 ;; Handle anchor
945 ;; Else we may have a node, which we search for:
949 ;; Now search from our advised position (or from beg of
950 ;; buffer) to find the actual node. First, check
951 ;; whether the node is right where we are, in case the
952 ;; buffer begins with a node.
965 ;; No such anchor in tag table or node in tag table or file
973 ;; Add anchors to the history too
984 ;; If we did not finish finding the specified node,
985 ;; go back to the previous one.
992 ;; Cache the contents of the (virtual) dir file, once we have merged
993 ;; it for the first time, so we can save time subsequently.
996 ;; Cache for the directory we decided to use for the default-directory
997 ;; of the merged dir text.
1000 ;; Record the file attributes of all the files from which we
1001 ;; constructed Info-dir-contents.
1006 ;; Construct the Info directory node by merging the files named `dir'
1007 ;; from various directories. Set the *info* buffer's
1008 ;; default-directory to the first directory we actually get any text
1009 ;; from.
1012 ;; Verify that none of the files we used has changed
1013 ;; since we used it.
1017 ;; Handle symlinks
1020 ;; Don't compare the access time.
1024 Info-dir-file-attributes))))
1030 Info-additional-directory-list)
1031 Info-directory-list))
1033 ;; Bind this in case the user sets it to nil.
1035 ;; This is set non-nil if we find a problem in some input files.
1036 problems
1037 buffers buffer others nodes dirs-done)
1039 ;; Search the directory list for the directory file.
1044 ;; Try several variants of specified name.
1045 ;; Try upcasing, appending `.info', or both.
1060 dirs-done)))
1070 file)
1082 ;; Distinguish the dir file that comes with Emacs from all the
1083 ;; others. Yes, that is really what this is supposed to do.
1084 ;; The definition of `Info-directory-list' puts it first on that
1085 ;; list and so last in `buffers' at this point.
1089 ;; Insert the entire original dir file as a start; note that we've
1090 ;; already saved its default directory to use as the default
1091 ;; directory for the whole concatenation.
1094 ;; Look at each of the other buffers one by one.
1097 ;; In each, find all the menus.
1100 ;; Find each menu, and add an elt to NODES for it.
1104 nodename end)
1116 ;; Add to the main menu a menu item for each other node.
1128 end t)
1132 ;; Now take each node of each of the other buffers
1133 ;; and merge it into the main buffer.
1138 ;; Find the like-named node in the main buffer.
1142 nil t)
1147 ;; If none exists, add one.
1150 ;; Merge the text from the other buffer's menu
1151 ;; into the menu in the like-named node in the main buffer.
1154 ;; Kill all the buffers we just made, including the special one excised.
1174 ;; Remove duplicate headings in the same menu.
1177 ;; Look for the next heading to unify.
1182 ;; Check whether this heading should be streamlined.
1192 ;; Look for other headings of the same category and merge them.
1198 ;; Delete redundant heading.
1200 ;; Push the entries onto `text'.
1207 entries)
1209 ;; Insert the entries just found.
1217 ;; Now remove duplicate entries under the same heading.
1224 ;; Fold case straight away; `member-ignore-case' here wasteful.
1232 ;; Note that on entry to this function the current-buffer must be the
1233 ;; *info* buffer; not the info tags buffer.
1235 ;; NODEPOS is either a position (in the Info file as a whole,
1236 ;; not relative to a subfile) or the name of a subfile.
1238 lastfilename)
1250 thisfilepos thisfilename)
1254 ;; read in version 19 stops at the end of number.
1255 ;; Advance to the next line.
1264 ;; Assume previous buffer is in Info-mode.
1265 ;; (set-buffer (get-buffer "*info*"))
1274 ;; Widen in case we are in the same subfile as before.
1284 "Unescape double quotes and backslashes in VALUE."
1290 unquote))
1292 ;; As of Texinfo 4.6, makeinfo writes constructs like
1293 ;; \0\h[image param=value ...\h\0]
1294 ;; into the Info file for handling images.
1297 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1298 whitespace or double quotes, it must be quoted in double quotes and
1303 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1304 parameter-string start)
1310 parameter-alist))
1311 parameter-alist))
1314 "Display images in current node."
1321 nil t)
1335 ;; text-only display, show alternative text if provided, or
1336 ;; otherwise a clue that there's meant to be a picture
1345 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1346 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1347 ;; including one optional trailing newline.
1349 "Hide unrecognized cookies in current node."
1356 nil t)
1363 "Select the Info node that point is in."
1364 ;; Bind this in case the user sets it to nil.
1367 ;; Find beginning of node.
1373 ;; Get nodename spelled as it is in the node.
1381 ;; Find the end of it, and narrow.
1384 ;; Narrow to the node contents
1396 ;; Add a new unique history item to full history list
1411 map)
1419 " ("
1424 ") "
1429 'help-echo
1430 "mouse-1: scroll forward, mouse-3: scroll back"
1434 \f
1435 ;; Go to an Info node specified with a filename-and-nodename string
1436 ;; of the sort that is found in pointers in nodes.
1438 ;; Don't autoload this function: the correct entry point for other packages
1439 ;; to use is `info'. --Stef
1440 ;; ;;;###autoload
1442 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1443 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1444 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1445 its sub-files).
1446 Completion is available, but only for node names in the current Info file.
1447 If FORK is non-nil (interactively with a prefix arg), show the node in
1448 a new Info buffer.
1449 If FORK is a string, it is the name to use for the new buffer."
1457 nodename)
1459 ""
1473 "Virtual completion table for file names input in Info node names.
1474 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1490 ;; If the file name has no suffix or a standard suffix,
1491 ;; include it.
1494 ;; But exclude subfiles of split Info files.
1496 ;; And exclude backup files.
1499 ;; If the file name ends in a standard suffix,
1500 ;; add the unsuffixed name as a completion option.
1509 ;; This function is used as the "completion table" while reading a node name.
1510 ;; It does completion using the alist in Info-read-node-completion-table
1511 ;; unless STRING starts with an open-paren.
1514 ;; First complete embedded file names.
1530 ;; If a file name was given, then any node is fair game.
1536 ;; Otherwise use Info-read-node-completion-table.
1544 ;; Arrange to highlight the proper letters in the completion list buffer.
1550 1
1559 nodename)))
1564 ;; Bind this in case the user sets it to nil.
1579 compl))))
1582 ;; If the buffer begins with a node header, process that first.
1585 ;; Now for the rest of the nodes.
1593 compl))))))))
1596 \f
1598 "If this node has been visited, restore the point value when we left."
1601 ;; Use string-equal, not equal, to ignore text props.
1607 \f
1615 "Search for REGEXP, starting from point, and select node it's found in.
1616 If DIRECTION is `backward', search in the reverse direction."
1644 ;; Hide Info file header for backward search
1656 ;; Skip node header line
1660 ;; Skip Tag Table node
1667 Info-search-whitespace-regexp)))
1682 ;; If no subfiles, give error now.
1687 Info-search-whitespace-regexp)))
1698 ;; Try other subfiles.
1709 ;; Find the subfile we just searched.
1711 ;; Skip that one.
1714 ;; Make a list of all following subfiles.
1715 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1724 list))
1728 ;; Put in forward order
1734 ;; Hide Info file header for backward search
1749 ;; Skip node header line
1753 ;; Skip Tag Table node
1760 Info-search-whitespace-regexp)))
1783 ;; Search landed in the same node
1789 ;; Use string-equal, not equal, to ignore text props.
1795 Info-history))))))
1798 "Search for a regexp case-sensitively."
1804 "Search for next regexp from a previous `Info-search' command."
1812 "Search for REGEXP in the reverse direction."
1831 nil t)
1833 bound noerror count
1836 bound noerror count
1863 \f
1865 "Extract the value of the node-pointer named NAME.
1866 If there is none, use ERRORNAME in the error message;
1867 if ERRORNAME is nil, just return nil."
1868 ;; Bind this in case the user sets it to nil.
1882 "Return a regexp matching a node name.
1883 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1884 saying which chars may appear in the node name.
1885 Submatch 1 is the complete node name.
1886 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1887 Submatch 3 is the local part of the node name.
1888 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1895 ;;; For compatibility; other files have used this name.
1901 "Go to the next node of this node."
1903 ;; In case another window is currently selected
1909 "Go to the previous node of this node."
1911 ;; In case another window is currently selected
1917 "Go to the superior node of this node.
1918 If SAME-FILE is non-nil, do not move to a different Info file."
1920 ;; In case another window is currently selected
1939 nil t))
1945 "Go back in the history to the last node visited."
1951 Info-history-forward))
1952 filename nodename opoint)
1965 "Go forward in the history of visited nodes."
1970 filename nodename opoint)
1978 ;;;###autoload
1980 "Go to the Info directory node."
1983 \f
1985 "Go to a node with a menu of visited nodes."
1989 p)
2014 "Go to a node with table of contents of the current Info file.
2015 Table of contents is created from the tree structure of menus."
2020 p)
2050 "Insert table of contents with references to nodes."
2062 "Build table of contents from menus of Info FILE and its subfiles."
2067 default-directory))
2070 nodes subfiles)
2082 menu-items)
2091 bound))
2094 ;; Menu item line
2104 ;; Other non-empty strings in the Top node are section names
2113 nodes))
2122 subfiles)))))
2124 main-file nil))
2128 \f
2130 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2131 FOOTNOTENAME may be an abbreviation of the reference name.
2132 If FORK is non-nil (interactively with a prefix arg), show the node in
2133 a new Info buffer. If FORK is a string, it is the name to use for the
2134 new buffer."
2140 ;; Store end and beginning of line.
2149 ;; See if this one should be the default.
2154 ;; See if this one should be the alternate default.
2164 ;; Record as a completion and perhaps as default.
2167 ;; Don't add this string if it's a duplicate.
2170 ;; If no good default was found, try an alternate.
2173 ;; If only one cross-reference found, then make it default.
2179 "Follow reference named (default "
2182 completions nil t)))
2196 ;; Move point to the beginning of reference if point is on reference
2206 ;; Go to the reference closest to point
2214 next-ref prev-ref))
2225 ;; We allow newline because this is also used in Info-follow-reference,
2226 ;; where the xref name might be wrapped over two lines.
2227 "Regexp that matches a menu entry name upto but not including the colon.
2228 Because of ambiguities, this should be concatenated with something like
2249 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2250 ;;; (setq Info-point-loc
2251 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2252 )
2256 ;; If the node name is the menu entry name (using `entry::').
2260 ;; No one calls this.
2261 ;;(defun Info-menu-item-sequence (list)
2262 ;; (while list
2263 ;; (Info-menu (car list))
2264 ;; (setq list (cdr list))))
2276 ;; This uses two dynamically bound variables:
2277 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2278 ;; is the menu of items we're trying to complete.
2279 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2280 ;; also look for menu items in subsequent nodes as long as those
2281 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2282 ;; not used.
2283 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2284 ;; also look for menu items in these nodes. This feature is currently
2285 ;; only used for completion in Info-index.
2287 ;; Note that `Info-complete-menu-buffer' could be current already,
2288 ;; so we want to save point.
2294 nextnode)
2303 completions
2305 ;; Check the cache.
2313 ;; We can reuse the previous list.
2315 ;; The cache can't be used.
2320 completions))
2321 ;; Check subsequent nodes if applicable.
2329 ;; Go back to the start node (for the next completion).
2332 ;; Update the cache.
2335 Info-complete-next-re string completions
2336 Info-complete-nodes)))
2343 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2344 The menu item should one of those listed in the current node's menu.
2345 Completion is allowed, and the default menu item is the one point is on.
2346 If FORK is non-nil (interactively with a prefix arg), show the node in
2347 a new Info buffer. If FORK is a string, it is the name to use for the
2348 new buffer."
2351 ;; If point is within a menu item, use that item as the default
2354 beg
2367 Info-menu-entry-name-re
2376 default)
2379 ;; we rely on the fact that completing-read accepts an input
2380 ;; of "" even when the require-match argument is true and ""
2381 ;; is not a valid possibility
2385 ;; ask again
2388 ;; there is a problem here in that if several menu items have the same
2389 ;; name you can only go to the node of the first with this command.
2407 ;; If COUNT is nil, use the last item in the menu.
2419 nil))
2423 "Go to the node of the Nth menu item.
2424 N is the digit argument used to invoke this command."
2431 "Go to the Top node of this file."
2436 "Go to the final node in this file."
2441 ;; Go to the last node in the menu of Top.
2443 ;; If the last node in the menu is not last in pointer structure,
2444 ;; move forward until we can't go any farther.
2446 ;; Then keep moving down to last subnode, unless we reach an index.
2452 "Go forward one node, considering all nodes as forming one sequence."
2457 ;; three possibilities, in order of priority:
2458 ;; 1. next node is in a menu in this node (but not in an index)
2459 ;; 2. next node is next at same level
2460 ;; 3. next node is up and next
2465 t)
2468 t)
2470 ;; Use string-equal, not equal, to ignore text props.
2483 "Go backward one node, considering all nodes as forming one sequence."
2491 ;; Use string-equal, not equal,
2492 ;; to ignore text properties.
2497 ;; If we move back at the same level,
2498 ;; go down to find the last subnode*.
2508 "Exit Info by selecting some other buffer."
2515 "Go to the node of the next menu item."
2517 ;; Bind this in case the user sets it to nil.
2529 "Go to the node of the previous menu item."
2533 ;; Bind this in case the user sets it to nil.
2548 "Go to the next subnode or the next node, or go up a level."
2553 ;; Since we have already gone thru all the items in this menu,
2554 ;; go up to the end of this node.
2556 ;; Since logically we are done with the node with that menu,
2557 ;; move on from it.
2563 "Go to the last node, popping up a level if there is none."
2567 ;; If we go down a menu item, go to the end of the node
2568 ;; so we can scroll back through it.
2570 ;; Keep going down, as long as there are nested menu nodes.
2573 ;; If we go down a menu item, go to the end of the node
2574 ;; so we can scroll back through it.
2584 ;; If we go down a menu item, go to the end of the node
2585 ;; so we can scroll back through it.
2596 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2597 Once you scroll far enough in a node that its menu appears on the screen
2598 but after point, the next scroll moves into its first subnode, unless
2599 `Info-scroll-prefer-subnodes' is nil.
2601 When you scroll past the end of a node, that goes to the next node if
2602 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2603 if this node has no successor, it moves to the parent node's successor,
2604 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2605 the menu of a node, it moves to subnode indicated by the following menu
2606 item. (That case won't normally result from this command, but can happen
2607 in other ways.)"
2629 "Scroll one screenful forward in Info, using the mouse.
2630 See `Info-scroll-up'."
2638 "Scroll one screenful back in Info, considering all nodes as one sequence.
2639 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2640 is non-nil, this goes to its last subnode. When you scroll past the
2641 beginning of a node, that goes to the previous node or back up to the
2642 parent node."
2656 current-point
2657 t)))))
2664 "Scroll one screenful backward in Info, using the mouse.
2665 See `Info-scroll-down'."
2673 "Move cursor to the next cross-reference or menu item in the node."
2695 "Move cursor to the previous cross-reference or menu item in the node."
2714 \f
2716 "Alist of cached index node names of visited Info files.
2720 "Return a list of names of all index nodes in Info FILE.
2721 If FILE is omitted, it defaults to the current Info file.
2722 First look in a list of cached index node names. Then scan Info
2723 file and its subfiles for nodes with the index cookie. Then try
2724 to find index nodes starting from the first node in the top level
2729 ;; Skip virtual Info files
2734 ;; Find nodes with index cookie
2738 default-directory))
2739 Info-history Info-history-list Info-fontify-maximum-menu-size
2759 subfiles)))))
2761 main-file nil))
2767 nodes)
2768 ;; Else find nodes with the word "Index" in the node name
2770 Info-history Info-history-list Info-fontify-maximum-menu-size
2771 nodes node)
2789 nodes))
2790 ;; If file has no index nodes, still add it to the cache
2795 "Return non-nil value if NODE is an index node.
2796 If NODE is nil, check the current Info node.
2797 If FILE is nil, check the current Info file."
2801 ;; Don't search all index nodes if request is only for the current node
2802 ;; and file is not in the cache of index nodes
2816 "Go to the first index node."
2821 ;;;###autoload
2823 "Look up a string TOPIC in the index for this manual and go to that entry.
2824 If there are no exact matches to the specified topic, this chooses
2825 the first match which is a case-insensitive substring of a topic.
2827 Give an empty topic name to go to the Index node itself."
2843 ;; Strip leading colon in topic; index format does not allow them.
2849 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2858 ;; We bind Info-history to nil for internal node-switches so
2859 ;; that we don't put junk in the history. In the first
2860 ;; Info-goto-index call, above, we do update the history
2861 ;; because that is what the user's previous node choice into it.
2863 found)
2870 Info-current-node
2873 matches))
2880 ;; Here it is a feature that assoc is case-sensitive.
2913 'Info-index-next overriding-local-map
2914 t)))
2918 "Move point to the place within the current node where NAME is defined."
2923 ;; Find a function definition with a return type.
2931 nil t))
2933 ;; Try again without the " <1>" makeinfo can append
2939 ;;;###autoload
2941 "Grovel indices of all known Info files on your system for STRING.
2942 Build a menu of the possible matches."
2945 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2951 manuals matches node nodes)
2954 ;; current-node and current-file are nil when they invoke info-apropos
2955 ;; as the first Info command, i.e. info-apropos loads info.el. In that
2956 ;; case, we use (DIR)Top instead, to avoid signalling an error after
2957 ;; the search is complete.
2965 ;; add-to-list makes sure we don't have duplicates in `manuals',
2966 ;; so that the following dolist loop runs faster.
2983 matches)))
2992 Info-history-list ohist-list)
3013 "Make command be undefined in Info."
3018 "Enter the Info tutorial."
3023 "Help-Small-Screen"
3027 "Display a brief summary of all Info commands."
3042 flag))
3045 \f
3047 "Return the token around POS.
3048 POS must be somewhere inside the token
3049 START is a regular expression which will match the
3050 beginning of the tokens delimited string
3051 ALL is a regular expression with a single
3052 parenthesized subpattern which is the token to be
3053 returned. E.g. '{\(.*\)}' would return any string
3054 enclosed in braces around POS.
3055 ERRORSTRING optional fourth argument, controls action on no match
3056 nil: return nil
3057 t: beep
3058 a string: signal an error, using that string."
3062 ;; First look for a match for START that goes across POS.
3066 ;; If we did not find one, search back for START
3067 ;; (this finds only matches that end at or before POS).
3080 nil)
3083 nil)
3089 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3090 At end of the node's text, moves to the next node, or up if none."
3098 "Follow a node reference near point.
3099 If point is on a reference, follow that reference. Otherwise,
3100 if point is in a menu item description, follow that menu item.
3102 If FORK is non-nil (interactively with a prefix arg), show the node in
3103 a new Info buffer.
3104 If FORK is a string, it is the name to use for the new buffer."
3116 t)))
3119 ;; Common subroutine.
3121 "Follow a node reference near point. Return non-nil if successful.
3122 If FORK is non-nil, it i spassed to `Info-goto-node'."
3131 ;; menu item: node name
3134 ;; menu item: node name or index entry
3148 node))
3149 \f
3153 nil
3163 (define-key Info-mode-map "1" 'Info-nth-menu-item)
3164 (define-key Info-mode-map "2" 'Info-nth-menu-item)
3165 (define-key Info-mode-map "3" 'Info-nth-menu-item)
3166 (define-key Info-mode-map "4" 'Info-nth-menu-item)
3167 (define-key Info-mode-map "5" 'Info-nth-menu-item)
3168 (define-key Info-mode-map "6" 'Info-nth-menu-item)
3169 (define-key Info-mode-map "7" 'Info-nth-menu-item)
3170 (define-key Info-mode-map "8" 'Info-nth-menu-item)
3171 (define-key Info-mode-map "9" 'Info-nth-menu-item)
3172 (define-key Info-mode-map "0" 'undefined)
3173 (define-key Info-mode-map "?" 'Info-summary)
3174 (define-key Info-mode-map "]" 'Info-forward-node)
3175 (define-key Info-mode-map "[" 'Info-backward-node)
3176 (define-key Info-mode-map "<" 'Info-top-node)
3177 (define-key Info-mode-map ">" 'Info-final-node)
3178 (define-key Info-mode-map "b" 'beginning-of-buffer)
3179 (define-key Info-mode-map "d" 'Info-directory)
3180 (define-key Info-mode-map "e" 'Info-edit)
3181 (define-key Info-mode-map "f" 'Info-follow-reference)
3182 (define-key Info-mode-map "g" 'Info-goto-node)
3183 (define-key Info-mode-map "h" 'Info-help)
3184 (define-key Info-mode-map "i" 'Info-index)
3185 (define-key Info-mode-map "l" 'Info-history-back)
3186 (define-key Info-mode-map "L" 'Info-history)
3187 (define-key Info-mode-map "m" 'Info-menu)
3188 (define-key Info-mode-map "n" 'Info-next)
3189 (define-key Info-mode-map "p" 'Info-prev)
3190 (define-key Info-mode-map "q" 'Info-exit)
3191 (define-key Info-mode-map "r" 'Info-history-forward)
3192 (define-key Info-mode-map "s" 'Info-search)
3193 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
3194 ;; For consistency with Rmail.
3195 (define-key Info-mode-map "\M-s" 'Info-search)
3196 (define-key Info-mode-map "\M-n" 'clone-buffer)
3197 (define-key Info-mode-map "t" 'Info-top-node)
3198 (define-key Info-mode-map "T" 'Info-toc)
3199 (define-key Info-mode-map "u" 'Info-up)
3200 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3201 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
3202 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
3203 ;; `^' for consistency with `dired-up-directory'.
3204 (define-key Info-mode-map "^" 'Info-up)
3205 (define-key Info-mode-map "," 'Info-index-next)
3207 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
3208 (define-key Info-mode-map [follow-link] 'mouse-face)
3209 )
3211 (defun Info-check-pointer (item)
3212 "Non-nil if ITEM is present in this node."
3213 (condition-case nil
3214 (Info-extract-pointer item)
3215 (error nil)))
3217 (easy-menu-define
3218 Info-mode-menu Info-mode-map
3219 "Menu for Info files."
3220 '("Info"
3221 ["Up" Info-up :active (Info-check-pointer "up")
3222 :help "Go up in the Info tree"]
3223 ["Next" Info-next :active (Info-check-pointer "next")
3224 :help "Go to the next node"]
3225 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3226 :help "Go to the previous node"]
3227 ["Backward" Info-backward-node
3228 :help "Go backward one node, considering all as a sequence"]
3229 ["Forward" Info-forward-node
3230 :help "Go forward one node, considering all as a sequence"]
3231 ["Beginning" beginning-of-buffer
3232 :help "Go to beginning of this node"]
3233 ["Top" Info-top-node
3234 :help "Go to top node of file"]
3235 ["Final Node" Info-final-node
3236 :help "Go to final node in this file"]
3237 ("Menu Item" ["You should never see this" report-emacs-bug t])
3238 ("Reference" ["You should never see this" report-emacs-bug t])
3239 ["Search..." Info-search
3240 :help "Search for regular expression in this Info file"]
3241 ["Search Next" Info-search-next
3242 :help "Search for another occurrence of regular expression"]
3243 ["Go to Node..." Info-goto-node
3244 :help "Go to a named node"]
3245 ["Back in history" Info-history-back :active Info-history
3246 :help "Go back in history to the last node you were at"]
3247 ["Forward in history" Info-history-forward :active Info-history-forward
3248 :help "Go forward in history"]
3249 ["History" Info-history :active Info-history-list
3250 :help "Go to menu of visited nodes"]
3251 ["Table of Contents" Info-toc
3252 :help "Go to table of contents"]
3253 ("Index"
3254 ["Lookup a String..." Info-index
3255 :help "Look for a string in the index items"]
3256 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3257 :help "Look for another occurrence of previous item"]
3258 ["Lookup a string in all indices..." info-apropos
3259 :help "Look for a string in the indices of all manuals"])
3260 ["Copy Node Name" Info-copy-current-node-name
3261 :help "Copy the name of the current node into the kill ring"]
3262 ["Clone Info buffer" clone-buffer
3263 :help "Create a twin copy of the current Info buffer."]
3264 ["Exit" Info-exit :help "Stop reading Info"]))
3267 (defvar info-tool-bar-map
3268 (if (display-graphic-p)
3269 (let ((map (make-sparse-keymap)))
3270 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map
3271 :rtl "right-arrow")
3272 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map
3273 :rtl "left-arrow")
3274 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map
3275 :rtl "next-node")
3276 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map
3277 :rtl "prev-node")
3278 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3279 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3280 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3281 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3282 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3283 (tool-bar-local-item-from-menu 'Info-exit "exit" map Info-mode-map)
3284 map)))
3286 (defvar Info-menu-last-node nil)
3287 ;; Last node the menu was created for.
3288 ;; Value is a list, (FILE-NAME NODE-NAME).
3290 (defun Info-menu-update ()
3291 "Update the Info menu for the current node."
3292 (condition-case nil
3293 (if (or (not (eq major-mode 'Info-mode))
3294 (equal (list Info-current-file Info-current-node)
3295 Info-menu-last-node))
3296 ()
3297 ;; Update menu menu.
3298 (let* ((Info-complete-menu-buffer (current-buffer))
3299 (items (nreverse (condition-case nil
3300 (Info-complete-menu-item "" nil t)
3301 (error nil))))
3302 entries current
3303 (number 0))
3304 (while (and items (< number 9))
3305 (setq current (car items)
3306 items (cdr items)
3307 number (1+ number))
3308 (setq entries (cons `[,current
3309 (Info-menu ,current)
3310 :keys ,(format "%d" number)]
3311 entries)))
3312 (if items
3313 (setq entries (cons ["Other..." Info-menu t] entries)))
3314 (or entries
3315 (setq entries (list ["No menu" nil nil] nil :active)))
3316 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3317 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3318 (let ((items nil)
3319 str i entries current
3320 (number 0)
3321 (case-fold-search t))
3322 (save-excursion
3323 (goto-char (point-min))
3325 (setq str (match-string 1))
3326 (setq i 0)
3328 (setq str (concat (substring str 0 i) " "
3329 (substring str (match-end 0))))
3330 (setq i (1+ i)))
3331 (setq items
3332 (cons str items))))
3333 (while (and items (< number 9))
3334 (setq current (car items)
3335 items (cdr items)
3336 number (1+ number))
3337 (setq entries (cons `[,current
3338 (Info-follow-reference ,current)
3339 t]
3340 entries)))
3341 (if items
3342 (setq entries (cons ["Other..." Info-follow-reference t]
3343 entries)))
3344 (or entries
3345 (setq entries (list ["No references" nil nil] nil :active)))
3346 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3347 ;; Update last seen node.
3348 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3349 ;; Try to avoid entering infinite beep mode in case of errors.
3350 (error (ding))))
3352 \f
3353 (defun Info-copy-current-node-name (&optional arg)
3354 "Put the name of the current Info node into the kill ring.
3355 The name of the Info file is prepended to the node name in parentheses.
3356 With a zero prefix arg, put the name inside a function call to `info'."
3357 (interactive "P")
3358 (unless Info-current-node
3359 (error "No current Info node"))
3360 (let ((node (if (stringp Info-current-file)
3361 (concat "(" (file-name-nondirectory Info-current-file) ") "
3362 Info-current-node))))
3363 (if (zerop (prefix-numeric-value arg))
3365 (unless (stringp Info-current-file)
3366 (setq node (format "(Info-find-node '%S '%S)"
3367 Info-current-file Info-current-node)))
3368 (kill-new node)
3369 (message "%s" node)))
3371 \f
3372 ;; Info mode is suitable only for specially formatted data.
3373 (put 'Info-mode 'mode-class 'special)
3374 (put 'Info-mode 'no-clone-indirect t)
3376 (defvar tool-bar-map)
3377 (defvar bookmark-make-record-function)
3379 ;; Autoload cookie needed by desktop.el
3380 ;;;###autoload
3381 (defun Info-mode ()
3382 "Info mode provides commands for browsing through the Info documentation tree.
3384 one topic and contains references to other nodes which discuss related
3385 topics. Info has commands to follow the references and show you other nodes.
3391 Selecting other nodes:
3393 Follow a node reference you click on.
3394 This works with menu items, cross references, and
3396 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3401 Picking a menu item causes another node to be selected.
3411 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3415 Moving within a node:
3417 Once you scroll far enough in a node that its menu appears on the
3418 screen but after point, the next scroll moves into its first
3419 subnode. When after all menu items (or if there is no menu),
3420 move up to the parent node.
3422 already visible, try to go to the previous menu entry, or up
3423 if there is none.
3426 Advanced commands:
3428 and select the node in which the next occurrence is found.
3429 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3433 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3436 You may include a filename as well, as (FILENAME)NODENAME.
3437 1 .. 9 Pick first ... ninth item in node's menu.
3438 Every third `*' is highlighted to help pick the right number.
3442 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3443 (kill-all-local-variables)
3444 (setq major-mode 'Info-mode)
3445 (setq mode-name "Info")
3446 (setq tab-width 8)
3447 (use-local-map Info-mode-map)
3448 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3449 (set-syntax-table text-mode-syntax-table)
3450 (setq local-abbrev-table text-mode-abbrev-table)
3451 (setq case-fold-search t)
3452 (setq buffer-read-only t)
3453 (make-local-variable 'Info-current-file)
3454 (make-local-variable 'Info-current-subfile)
3455 (make-local-variable 'Info-current-node)
3456 (make-local-variable 'Info-tag-table-marker)
3457 (setq Info-tag-table-marker (make-marker))
3458 (make-local-variable 'Info-tag-table-buffer)
3459 (setq Info-tag-table-buffer nil)
3460 (make-local-variable 'Info-history)
3461 (make-local-variable 'Info-history-forward)
3462 (make-local-variable 'Info-index-alternatives)
3463 (setq header-line-format
3464 (if Info-use-header-line
3465 '(:eval (get-text-property (point-min) 'header-line))
3466 nil)) ; so the header line isn't displayed
3467 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3468 ;; This is for the sake of the invisible text we use handling titles.
3469 (make-local-variable 'line-move-ignore-invisible)
3470 (setq line-move-ignore-invisible t)
3471 (make-local-variable 'desktop-save-buffer)
3472 (make-local-variable 'widen-automatically)
3473 (setq widen-automatically nil)
3474 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3475 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3476 (add-hook 'clone-buffer-hook 'Info-clone-buffer nil t)
3477 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3478 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3479 (set (make-local-variable 'isearch-search-fun-function)
3480 'Info-isearch-search)
3481 (set (make-local-variable 'isearch-wrap-function)
3482 'Info-isearch-wrap)
3483 (set (make-local-variable 'isearch-push-state-function)
3484 'Info-isearch-push-state)
3485 (set (make-local-variable 'search-whitespace-regexp)
3486 Info-search-whitespace-regexp)
3487 (set (make-local-variable 'revert-buffer-function)
3488 'Info-revert-buffer-function)
3489 (Info-set-mode-line)
3490 (set (make-local-variable 'bookmark-make-record-function)
3491 'Info-bookmark-make-record)
3492 (run-mode-hooks 'Info-mode-hook))
3494 ;; When an Info buffer is killed, make sure the associated tags buffer
3495 ;; is killed too.
3496 (defun Info-kill-buffer ()
3497 (and (eq major-mode 'Info-mode)
3498 Info-tag-table-buffer
3499 (kill-buffer Info-tag-table-buffer)))
3501 ;; Placed on `clone-buffer-hook'.
3502 (defun Info-clone-buffer ()
3503 (when (bufferp Info-tag-table-buffer)
3504 (setq Info-tag-table-buffer
3505 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3506 (let ((m Info-tag-table-marker))
3507 (when (markerp m)
3508 (setq Info-tag-table-marker
3509 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3510 (with-current-buffer Info-tag-table-buffer
3511 (copy-marker (marker-position m)))
3512 (make-marker))))))
3514 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3515 (set-keymap-parent map text-mode-map)
3516 (define-key map "\C-c\C-c" 'Info-cease-edit)
3517 map)
3518 "Local keymap used within `e' command of Info.")
3520 ;; Info-edit mode is suitable only for specially formatted data.
3521 (put 'Info-edit-mode 'mode-class 'special)
3523 (defun Info-edit-mode ()
3524 "Major mode for editing the contents of an Info node.
3525 Like text mode with the addition of `Info-cease-edit'
3526 which returns to Info mode for browsing.
3528 (use-local-map Info-edit-map)
3529 (setq major-mode 'Info-edit-mode)
3530 (setq mode-name "Info Edit")
3531 (kill-local-variable 'mode-line-buffer-identification)
3532 (setq buffer-read-only nil)
3533 (force-mode-line-update)
3534 (buffer-enable-undo (current-buffer))
3535 (run-mode-hooks 'Info-edit-mode-hook))
3537 (defun Info-edit ()
3538 "Edit the contents of this Info node.
3539 Allowed only if variable `Info-enable-edit' is non-nil."
3540 (interactive)
3541 (or Info-enable-edit
3542 (error "Editing Info nodes is not enabled"))
3543 (Info-edit-mode)
3544 (message "%s" (substitute-command-keys
3547 (defun Info-cease-edit ()
3548 "Finish editing Info node; switch back to Info proper."
3549 (interactive)
3550 ;; Do this first, so nothing has changed if user C-g's at query.
3551 (and (buffer-modified-p)
3552 (y-or-n-p "Save the file? ")
3553 (save-buffer))
3554 (use-local-map Info-mode-map)
3555 (setq major-mode 'Info-mode)
3556 (setq mode-name "Info")
3557 (Info-set-mode-line)
3558 (setq buffer-read-only t)
3559 (force-mode-line-update)
3560 (and (marker-position Info-tag-table-marker)
3561 (buffer-modified-p)
3562 (message "Tags may have changed. Use Info-tagify if necessary")))
3563 \f
3564 (defvar Info-file-list-for-emacs
3565 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3566 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3567 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3568 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3569 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3570 ("copyright" . "autotype") ("executable" . "autotype")
3571 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3572 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3573 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3574 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3575 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3576 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3577 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3578 ("rfc2045" . "emacs-mime")
3579 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3580 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3581 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3582 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3583 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3584 ("mml" . "emacs-mime"))
3585 "List of Info files that describe Emacs commands.
3586 An element can be a file name, or a list of the form (PREFIX . FILE)
3587 where PREFIX is a name prefix and FILE is the file to look in.
3588 If the element is just a file name, the file name also serves as the prefix.")
3590 (defun Info-find-emacs-command-nodes (command)
3591 "Return a list of locations documenting COMMAND.
3592 The `info-file' property of COMMAND says which Info manual to search.
3593 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3594 defines heuristics for which Info manual to try.
3595 The locations are of the format used in `Info-history', i.e.
3596 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3597 in the first element of the returned list (which is treated specially in
3598 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3599 (let ((where '()) line-number
3603 (info-file "emacs")) ;default
3604 ;; Determine which Info file this command is documented in.
3605 (if (get command 'info-file)
3606 (setq info-file (get command 'info-file))
3607 ;; If it doesn't say explicitly, test its name against
3608 ;; various prefixes that we know.
3609 (let ((file-list Info-file-list-for-emacs))
3610 (while file-list
3611 (let* ((elt (car file-list))
3612 (name (if (consp elt)
3613 (car elt)
3614 elt))
3615 (file (if (consp elt) (cdr elt) elt))
3616 (case-fold-search nil)
3619 (if (string-match regexp (symbol-name command))
3620 (setq info-file file file-list nil))
3621 (setq file-list (cdr file-list))))))
3622 (Info-find-node info-file "Top")
3623 ;; Bind Info-history to nil, to prevent the index nodes from
3624 ;; getting into the node history.
3625 (let ((Info-history nil)
3626 (Info-history-list nil)
3627 node (nodes (Info-index-nodes)))
3628 (Info-goto-node (car nodes))
3629 (while
3630 (progn
3631 (goto-char (point-min))
3632 (while (re-search-forward cmd-desc nil t)
3633 (setq where
3634 (cons (list Info-current-file
3635 (match-string-no-properties 2)
3636 0)
3637 where))
3638 (setq line-number (and (match-beginning 3)
3639 (string-to-number (match-string 3)))))
3640 (and (setq nodes (cdr nodes) node (car nodes))))
3641 (Info-goto-node node)))
3642 (if (and line-number where)
3643 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3644 (cdr where))
3645 where)))
3647 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3648 ;;;###autoload
3649 (defun Info-goto-emacs-command-node (command)
3650 "Go to the Info node in the Emacs manual for command COMMAND.
3651 The command is found by looking up in Emacs manual's indices
3652 or in another manual found via COMMAND's `info-file' property or
3653 the variable `Info-file-list-for-emacs'.
3654 COMMAND must be a symbol or string."
3655 (interactive "CFind documentation for command: ")
3656 ;; If command is given as a string, convert it to a symbol.
3657 (if (stringp command)
3658 (setq command (intern command)))
3659 (or (commandp command)
3660 (signal 'wrong-type-argument (list 'commandp command)))
3661 (let ((where (Info-find-emacs-command-nodes command)))
3662 (if where
3663 (let ((num-matches (length where)))
3664 ;; Get Info running, and pop to it in another window.
3665 (save-window-excursion
3666 (info))
3667 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3668 ;; Bind Info-history to nil, to prevent the last Index node
3669 ;; visited by Info-find-emacs-command-nodes from being
3670 ;; pushed onto the history.
3671 (let ((Info-history nil) (Info-history-list nil)
3672 (line-number (nth 2 (car where))))
3673 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3674 (if (and (integerp line-number) (> line-number 0))
3675 (forward-line (1- line-number))))
3676 (if (> num-matches 1)
3677 (progn
3678 ;; (car where) will be pushed onto Info-history
3679 ;; when/if they go to another node. Put the other
3680 ;; nodes that were found on the history.
3681 (setq Info-history (nconc (cdr where) Info-history))
3682 (message "Found %d other entr%s. Use %s to see %s."
3683 (1- num-matches)
3684 (if (> num-matches 2) "ies" "y")
3686 (if (> num-matches 2) "them" "it")))))
3687 (error "Couldn't find documentation for %s" command))))
3689 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3690 ;;;###autoload
3691 (defun Info-goto-emacs-key-command-node (key)
3692 "Go to the node in the Emacs manual which describes the command bound to KEY.
3693 KEY is a string.
3694 Interactively, if the binding is `execute-extended-command', a command is read.
3695 The command is found by looking up in Emacs manual's indices
3696 or in another manual found via COMMAND's `info-file' property or
3697 the variable `Info-file-list-for-emacs'."
3698 (interactive "kFind documentation for key: ")
3699 (let ((command (key-binding key)))
3700 (cond ((null command)
3701 (message "%s is undefined" (key-description key)))
3702 ((and (interactive-p)
3703 (eq command 'execute-extended-command))
3704 (Info-goto-emacs-command-node
3705 (read-command "Find documentation for command: ")))
3706 (t
3707 (Info-goto-emacs-command-node command)))))
3708 \f
3709 (defvar Info-next-link-keymap
3710 (let ((keymap (make-sparse-keymap)))
3711 (define-key keymap [header-line mouse-1] 'Info-next)
3712 (define-key keymap [header-line mouse-2] 'Info-next)
3713 (define-key keymap [header-line down-mouse-1] 'ignore)
3714 (define-key keymap [mouse-2] 'Info-next)
3715 (define-key keymap [follow-link] 'mouse-face)
3716 keymap)
3717 "Keymap to put on the Next link in the text or the header line.")
3719 (defvar Info-prev-link-keymap
3720 (let ((keymap (make-sparse-keymap)))
3721 (define-key keymap [header-line mouse-1] 'Info-prev)
3722 (define-key keymap [header-line mouse-2] 'Info-prev)
3723 (define-key keymap [header-line down-mouse-1] 'ignore)
3724 (define-key keymap [mouse-2] 'Info-prev)
3725 (define-key keymap [follow-link] 'mouse-face)
3726 keymap)
3727 "Keymap to put on the Prev link in the text or the header line.")
3729 (defvar Info-up-link-keymap
3730 (let ((keymap (make-sparse-keymap)))
3731 (define-key keymap [header-line mouse-1] 'Info-up)
3732 (define-key keymap [header-line mouse-2] 'Info-up)
3733 (define-key keymap [header-line down-mouse-1] 'ignore)
3734 (define-key keymap [mouse-2] 'Info-up)
3735 (define-key keymap [follow-link] 'mouse-face)
3736 keymap)
3737 "Keymap to put on the Up link in the text or the header line.")
3739 (defun Info-fontify-node ()
3740 "Fontify the node."
3741 (save-excursion
3742 (let* ((inhibit-read-only t)
3743 (case-fold-search t)
3744 paragraph-markers
3745 (not-fontified-p ; the node hasn't already been fontified
3746 (not (let ((where (next-single-property-change (point-min)
3747 'font-lock-face)))
3748 (and where (not (= where (point-max)))))))
3749 (fontify-visited-p ; visited nodes need to be re-fontified
3750 (and Info-fontify-visited-nodes
3751 ;; Don't take time to refontify visited nodes in huge nodes
3752 Info-fontify-maximum-menu-size
3753 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3754 rbeg rend)
3756 ;; Fontify header line
3757 (goto-char (point-min))
3759 (goto-char (match-end 0))
3761 (goto-char (match-end 0))
3762 (let* ((nbeg (match-beginning 2))
3763 (nend (match-end 2))
3764 (tbeg (match-beginning 1))
3765 (tag (match-string 1)))
3766 (if (string-equal (downcase tag) "node")
3767 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3768 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3769 (put-text-property tbeg nend 'mouse-face 'highlight)
3770 (put-text-property tbeg nend
3771 'help-echo
3772 (concat "mouse-2: Go to node "
3773 (buffer-substring nbeg nend)))
3774 ;; Always set up the text property keymap.
3775 ;; It will either be used in the buffer
3776 ;; or copied in the header line.
3777 (put-text-property
3778 tbeg nend 'keymap
3779 (cond
3780 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3781 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3782 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3783 (when Info-use-header-line
3784 (goto-char (point-min))
3785 (let* ((header-end (line-end-position))
3786 (header
3787 ;; If we find neither Next: nor Prev: link, show the entire
3788 ;; node header. Otherwise, don't show the File: and Node:
3789 ;; parts, to avoid wasting precious space on information that
3790 ;; is available in the mode line.
3791 (if (re-search-forward
3793 header-end t)
3794 (progn
3795 (goto-char (match-beginning 1))
3796 (buffer-substring (point) header-end))
3798 header-end t)
3799 (concat "No next, prev or up links -- "
3800 (buffer-substring (point) header-end))
3801 (buffer-substring (point) header-end)))))
3802 (put-text-property (point-min) (1+ (point-min))
3803 'header-line
3804 (replace-regexp-in-string
3805 "%"
3806 ;; Preserve text properties on duplicated `%'.
3807 (lambda (s) (concat s s)) header))
3808 ;; Hide the part of the first line
3809 ;; that is in the header, if it is just part.
3810 (unless (bobp)
3811 ;; Hide the punctuation at the end, too.
3813 (put-text-property (point) header-end 'invisible t)))))
3815 ;; Fontify titles
3816 (goto-char (point-min))
3817 (when (and font-lock-mode not-fontified-p)
3819 nil t)
3820 ;; Only consider it as an underlined title if the ASCII
3821 ;; underline has the same size as the text. A typical
3822 ;; counter example is when a continuation "..." is alone
3823 ;; on a line.
3824 (= (string-width (match-string 1))
3825 (string-width (match-string 2))))
3826 (let* ((c (preceding-char))
3827 (face
3828 (cond ((= c ?*) 'info-title-1)
3829 ((= c ?=) 'info-title-2)
3830 ((= c ?-) 'info-title-3)
3831 (t 'info-title-4))))
3832 (put-text-property (match-beginning 1) (match-end 1)
3833 'font-lock-face face))
3834 ;; This is a serious problem for trying to handle multiple
3835 ;; frame types at once. We want this text to be invisible
3836 ;; on frames that can display the font above.
3837 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3838 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3839 '(invisible t front-sticky nil rear-nonsticky t)))))
3841 ;; Fontify cross references
3842 (goto-char (point-min))
3843 (when (or not-fontified-p fontify-visited-p)
3844 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3845 (let ((start (match-beginning 0))
3846 (next (point))
3847 other-tag)
3848 (when not-fontified-p
3849 (when Info-hide-note-references
3850 (when (not (eq Info-hide-note-references 'hide))
3851 ;; *Note is often used where *note should have been
3852 (goto-char start)
3853 (skip-syntax-backward " ")
3854 (when (memq (char-before) '(?\( ?\[ ?\{))
3855 ;; Check whether the paren is preceded by
3856 ;; an end of sentence
3857 (skip-syntax-backward " ("))
3858 (setq other-tag
3860 "")
3862 "")
3863 ((memq (char-before) '(nil ?\. ?! ??))
3864 "See ")
3865 ((save-match-data
3866 (save-excursion
3868 "See ")
3869 (t "see "))))
3870 (goto-char next)
3871 (add-text-properties
3872 (match-beginning 1)
3873 (or (save-match-data
3875 (let ((start1 (match-beginning 1)))
3877 (+ start1 (match-beginning 0)))))
3878 (match-end 1))
3879 (if other-tag
3880 `(display ,other-tag front-sticky nil rear-nonsticky t)
3881 '(invisible t front-sticky nil rear-nonsticky t))))
3882 (add-text-properties
3883 (match-beginning 2) (match-end 2)
3884 (list
3885 'help-echo (if (or (match-end 5)
3886 (not (equal (match-string 4) "")))
3887 (concat "mouse-2: go to " (or (match-string 5)
3888 (match-string 4)))
3889 "mouse-2: go to this node")
3890 'mouse-face 'highlight)))
3891 (when (or not-fontified-p fontify-visited-p)
3892 (setq rbeg (match-beginning 2)
3893 rend (match-end 2))
3894 (put-text-property
3895 rbeg rend
3896 'font-lock-face
3897 ;; Display visited nodes in a different face
3898 (if (and Info-fontify-visited-nodes
3899 (save-match-data
3900 (let* ((node (replace-regexp-in-string
3902 (replace-regexp-in-string
3904 (or (match-string-no-properties 5)
3905 (and (not (equal (match-string 4) ""))
3906 (match-string-no-properties 4))
3907 (match-string-no-properties 2)))))
3908 (external-link-p
3910 (file (if external-link-p
3911 (file-name-nondirectory
3912 (match-string-no-properties 1 node))
3913 Info-current-file))
3914 (hl Info-history-list)
3915 res)
3916 (if external-link-p
3917 (setq node (if (equal (match-string 2 node) "")
3918 "Top"
3919 (match-string-no-properties 2 node))))
3920 (while hl
3921 (if (and (string-equal node (nth 1 (car hl)))
3922 (equal file
3923 (if (and external-link-p
3924 (stringp (caar hl)))
3925 (file-name-nondirectory
3926 (caar hl))
3927 (caar hl))))
3928 (setq res (car hl) hl nil)
3929 (setq hl (cdr hl))))
3930 res))) 'info-xref-visited 'info-xref))
3931 ;; For multiline ref, unfontify newline and surrounding whitespace
3932 (save-excursion
3933 (goto-char rbeg)
3934 (save-match-data
3936 (remove-text-properties (match-beginning 0)
3937 (match-end 0)
3938 '(font-lock-face t))))))
3939 (when not-fontified-p
3940 (when (memq Info-hide-note-references '(t hide))
3941 (add-text-properties (match-beginning 3) (match-end 3)
3942 '(invisible t front-sticky nil rear-nonsticky t))
3943 ;; Unhide the file name of the external reference in parens
3944 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3945 (remove-text-properties (match-beginning 6) (match-end 6)
3946 '(invisible t front-sticky nil rear-nonsticky t)))
3947 ;; Unhide newline because hidden newlines cause too long lines
3948 (save-match-data
3949 (let ((beg3 (match-beginning 3))
3950 (end3 (match-end 3)))
3952 (not (save-match-data
3953 (save-excursion
3954 (goto-char (1+ end3))
3955 (looking-at "[.)]*$")))))
3956 (remove-text-properties (+ beg3 (match-beginning 0))
3957 (+ beg3 (match-end 0))
3958 '(invisible t front-sticky nil rear-nonsticky t))))))
3959 (when (and Info-refill-paragraphs Info-hide-note-references)
3960 (push (set-marker (make-marker) start)
3961 paragraph-markers))))))
3963 ;; Refill paragraphs (experimental feature)
3964 (when (and not-fontified-p
3965 Info-refill-paragraphs
3966 paragraph-markers)
3967 (let ((fill-nobreak-invisible t)
3968 (fill-individual-varying-indent nil)
3971 (adaptive-fill-mode nil))
3972 (goto-char (point-max))
3973 (dolist (m paragraph-markers)
3974 (when (< m (point))
3975 (goto-char m)
3976 (beginning-of-line)
3977 (let ((beg (point)))
3978 (when (zerop (forward-paragraph))
3979 (fill-individual-paragraphs beg (point) nil nil)
3980 (goto-char beg))))
3981 (set-marker m nil))))
3983 ;; Fontify menu items
3984 (goto-char (point-min))
3985 (when (and (or not-fontified-p fontify-visited-p)
3987 ;; Don't take time to annotate huge menus
3988 Info-fontify-maximum-menu-size
3989 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3990 (let ((n 0)
3991 cont)
3992 (while (re-search-forward
3995 nil t)
3996 (when (match-beginning 1)
3997 (when not-fontified-p
3998 (setq n (1+ n))
3999 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
4000 (put-text-property (match-beginning 0)
4001 (1+ (match-beginning 0))
4002 'font-lock-face 'info-menu-star)))
4003 (when not-fontified-p
4004 (add-text-properties
4005 (match-beginning 1) (match-end 1)
4006 (list
4007 'help-echo (if (and (match-end 3)
4008 (not (equal (match-string 3) "")))
4009 (concat "mouse-2: go to " (match-string 3))
4010 "mouse-2: go to this node")
4011 'mouse-face 'highlight)))
4012 (when (or not-fontified-p fontify-visited-p)
4013 (put-text-property
4014 (match-beginning 1) (match-end 1)
4015 'font-lock-face
4016 ;; Display visited menu items in a different face
4017 (if (and Info-fontify-visited-nodes
4018 (save-match-data
4019 (let* ((node (if (equal (match-string 3) "")
4020 (match-string-no-properties 1)
4021 (match-string-no-properties 3)))
4022 (external-link-p
4024 (file (if external-link-p
4025 (file-name-nondirectory
4026 (match-string-no-properties 1 node))
4027 Info-current-file))
4028 (hl Info-history-list)
4029 res)
4030 (if external-link-p
4031 (setq node (if (equal (match-string 2 node) "")
4032 "Top"
4033 (match-string-no-properties 2 node))))
4034 (while hl
4035 (if (and (string-equal node (nth 1 (car hl)))
4036 (equal file
4037 (if (and external-link-p
4038 (stringp (caar hl)))
4039 (file-name-nondirectory
4040 (caar hl))
4041 (caar hl))))
4042 (setq res (car hl) hl nil)
4043 (setq hl (cdr hl))))
4044 res))) 'info-xref-visited 'info-xref)))
4045 (when (and not-fontified-p
4046 (memq Info-hide-note-references '(t hide))
4047 (not (Info-index-node)))
4048 (put-text-property (match-beginning 2) (1- (match-end 6))
4049 'invisible t)
4050 ;; Unhide the file name in parens
4051 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
4052 (remove-text-properties (match-beginning 4) (match-end 4)
4053 '(invisible t)))
4054 ;; We need a stretchable space like :align-to but with
4055 ;; a minimum value.
4056 (put-text-property (1- (match-end 6)) (match-end 6) 'display
4057 (if (>= 22 (- (match-end 1)
4058 (match-beginning 0)))
4059 '(space :align-to 24)
4060 '(space :width 2)))
4061 (setq cont (looking-at "."))
4062 (while (and (= (forward-line 1) 0)
4064 (put-text-property (match-beginning 1) (1- (match-end 1))
4065 'invisible t)
4066 (put-text-property (1- (match-end 1)) (match-end 1)
4067 'display
4068 (if cont
4069 '(space :align-to 26)
4070 '(space :align-to 24)))
4071 (setq cont t)))))))
4073 ;; Fontify menu headers
4074 ;; Add the face `info-menu-header' to any header before a menu entry
4075 (goto-char (point-min))
4077 (put-text-property (match-beginning 0) (match-end 0)
4078 'font-lock-face 'info-menu-header)
4080 (put-text-property (match-beginning 1) (match-end 1)
4081 'font-lock-face 'info-menu-header)))
4083 ;; Hide index line numbers
4084 (goto-char (point-min))
4085 (when (and not-fontified-p (Info-index-node))
4087 (put-text-property (match-beginning 0) (match-end 0)
4088 'invisible t)))
4090 ;; Fontify http and ftp references
4091 (goto-char (point-min))
4092 (when not-fontified-p
4094 nil t)
4095 (add-text-properties (match-beginning 0) (match-end 0)
4096 '(font-lock-face info-xref
4097 mouse-face highlight
4098 help-echo "mouse-2: go to this URL"))))
4100 (set-buffer-modified-p nil))))
4101 \f
4102 ;;; Speedbar support:
4103 ;; These functions permit speedbar to display the "tags" in the
4104 ;; current Info node.
4105 (eval-when-compile (require 'speedbar))
4107 (defvar Info-speedbar-key-map nil
4108 "Keymap used when in the info display mode.")
4110 (defun Info-install-speedbar-variables ()
4111 "Install those variables used by speedbar to enhance Info."
4112 (if Info-speedbar-key-map
4113 nil
4114 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4116 ;; Basic tree features
4117 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4118 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4119 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4120 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4121 )
4123 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4124 Info-speedbar-key-map
4125 Info-speedbar-hierarchy-buttons)))
4127 (defvar Info-speedbar-menu-items
4128 '(["Browse Node" speedbar-edit-line t]
4129 ["Expand Node" speedbar-expand-line
4130 (save-excursion (beginning-of-line)
4132 ["Contract Node" speedbar-contract-line
4133 (save-excursion (beginning-of-line)
4134 (looking-at "[0-9]+: *.-. "))]
4135 )
4136 "Additional menu-items to add to speedbar frame.")
4138 ;; Make sure our special speedbar major mode is loaded
4139 (if (featurep 'speedbar)
4140 (Info-install-speedbar-variables)
4141 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4143 ;;; Info hierarchy display method
4144 ;;;###autoload
4145 (defun Info-speedbar-browser ()
4146 "Initialize speedbar to display an Info node browser.
4147 This will add a speedbar major display mode."
4148 (interactive)
4149 (require 'speedbar)
4150 ;; Make sure that speedbar is active
4151 (speedbar-frame-mode 1)
4152 ;; Now, throw us into Info mode on speedbar.
4153 (speedbar-change-initial-expansion-list "Info")
4154 )
4156 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4157 "Display an Info directory hierarchy in speedbar.
4158 DIRECTORY is the current directory in the attached frame.
4159 DEPTH is the current indentation depth.
4160 NODE is an optional argument that is used to represent the
4161 specific node to expand."
4162 (if (and (not node)
4163 (save-excursion (goto-char (point-min))
4164 (let ((case-fold-search t))
4165 (looking-at "Info Nodes:"))))
4166 ;; Update our "current node" maybe?
4167 nil
4168 ;; We cannot use the generic list code, that depends on all leaves
4169 ;; being known at creation time.
4170 (if (not node)
4172 (let ((completions nil))
4173 (speedbar-select-attached-frame)
4174 (save-window-excursion
4175 (setq completions
4176 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4177 (select-frame (speedbar-current-frame))
4178 (if completions
4179 (speedbar-with-writable
4180 (dolist (completion completions)
4181 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4182 (cdr completion)
4183 (car completion)
4184 'Info-speedbar-goto-node
4185 (cdr completion)
4186 'info-xref depth))
4187 t)
4188 nil))))
4190 (defun Info-speedbar-goto-node (text node indent)
4191 "When user clicks on TEXT, go to an info NODE.
4192 The INDENT level is ignored."
4193 (speedbar-select-attached-frame)
4194 (let* ((buff (or (get-buffer "*info*")
4195 (progn (info) (get-buffer "*info*"))))
4196 (bwin (get-buffer-window buff 0)))
4197 (if bwin
4198 (progn
4199 (select-window bwin)
4200 (raise-frame (window-frame bwin)))
4201 (if speedbar-power-click
4202 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4203 (speedbar-select-attached-frame)
4204 (switch-to-buffer buff)))
4206 (error "Invalid node %s" node)
4207 (Info-find-node (match-string 1 node) (match-string 2 node))
4208 ;; If we do a find-node, and we were in info mode, restore
4209 ;; the old default method. Once we are in info mode, it makes
4210 ;; sense to return to whatever method the user was using before.
4211 (if (string= speedbar-initial-expansion-list-name "Info")
4212 (speedbar-change-initial-expansion-list
4213 speedbar-previously-used-expansion-list-name)))))
4215 (defun Info-speedbar-expand-node (text token indent)
4216 "Expand the node the user clicked on.
4217 TEXT is the text of the button we clicked on, a + or - item.
4218 TOKEN is data related to this node (NAME . FILE).
4219 INDENT is the current indentation depth."
4220 (cond ((string-match "+" text) ;we have to expand this file
4221 (speedbar-change-expand-button-char ?-)
4222 (if (speedbar-with-writable
4223 (save-excursion
4224 (end-of-line) (forward-char 1)
4225 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4226 (speedbar-change-expand-button-char ?-)
4227 (speedbar-change-expand-button-char ??)))
4228 ((string-match "-" text) ;we have to contract this node
4229 (speedbar-change-expand-button-char ?+)
4230 (speedbar-delete-subblock indent))
4231 (t (error "Ooops... not sure what to do")))
4232 (speedbar-center-buffer-smartly))
4234 (defun Info-speedbar-fetch-file-nodes (nodespec)
4235 "Fetch the subnodes from the info NODESPEC.
4236 NODESPEC is a string of the form: (file)node."
4237 (save-excursion
4238 ;; Set up a buffer we can use to fake-out Info.
4239 (set-buffer (get-buffer-create " *info-browse-tmp*"))
4240 (if (not (equal major-mode 'Info-mode))
4241 (Info-mode))
4242 ;; Get the node into this buffer
4244 (error "Invalid node specification %s" nodespec)
4245 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4246 ;; Scan the created buffer
4247 (goto-char (point-min))
4248 (let ((completions nil)
4249 (case-fold-search t)
4251 (match-string 1 nodespec))))
4252 ;; Always skip the first one...
4255 (let ((name (match-string 1)))
4256 (push (cons name
4258 (match-string 1)
4260 (concat (match-string 1) "Top")
4261 (concat "(" thisfile ")"
4263 (match-string 1)
4264 name)))))
4265 completions)))
4266 (nreverse completions))))
4268 ;;; Info mode node listing
4269 ;; This is called by `speedbar-add-localized-speedbar-support'
4270 (defun Info-speedbar-buttons (buffer)
4271 "Create a speedbar display to help navigation in an Info file.
4272 BUFFER is the buffer speedbar is requesting buttons for."
4273 (if (save-excursion (goto-char (point-min))
4274 (let ((case-fold-search t))
4275 (not (looking-at "Info Nodes:"))))
4276 (erase-buffer))
4277 (Info-speedbar-hierarchy-buttons nil 0))
4279 (dolist (mess '("^First node in file$"
4280 "^No `.*' in index$"
4281 "^No cross-reference named"
4282 "^No cross.references in this node$"
4283 "^No current Info node$"
4284 "^No menu in this node$"
4285 "^No more items in menu$"
4286 "^No more nodes$"
4288 "^No previous `i' command$"
4289 "^No previous items in menu$"
4290 "^No previous nodes$"
4291 "^No such item in menu$"
4292 "^No such node or anchor"
4293 "^Node has no"
4294 "^Point neither on reference nor in menu item description$"
4296 search-failed))
4297 (add-to-list 'debug-ignored-errors mess))
4299 ;;;; Desktop support
4301 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4302 "Auxiliary information to be saved in desktop file."
4303 (unless (member Info-current-file '(apropos history toc nil))
4304 (list Info-current-file Info-current-node)))
4306 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4307 desktop-buffer-name
4308 desktop-buffer-misc)
4309 "Restore an Info buffer specified in a desktop file."
4310 (let ((first (nth 0 desktop-buffer-misc))
4311 (second (nth 1 desktop-buffer-misc)))
4312 (when (and first second)
4313 (when desktop-buffer-name
4314 (set-buffer (get-buffer-create desktop-buffer-name))
4315 (Info-mode))
4316 (Info-find-node first second)
4317 (current-buffer))))
4319 (add-to-list 'desktop-buffer-mode-handlers
4320 '(Info-mode . Info-restore-desktop-buffer))
4322 ;;;; Bookmark support
4324 (defvar bookmark-search-size)
4326 ;; This is only called from bookmark.el.
4327 (declare-function bookmark-buffer-file-name "bookmark" ())
4329 (defun Info-bookmark-make-record ()
4330 `(,Info-current-node
4331 (filename . ,(bookmark-buffer-file-name))
4332 (front-context-string
4333 . ,(if (>= (- (point-max) (point)) bookmark-search-size)
4334 (buffer-substring-no-properties
4335 (point)
4336 (+ (point) bookmark-search-size))
4337 nil))
4338 (rear-context-string
4339 . ,(if (>= (- (point) (point-min)) bookmark-search-size)
4340 (buffer-substring-no-properties
4341 (point)
4342 (- (point) bookmark-search-size))
4343 nil))
4344 (info-node . ,Info-current-node)
4345 (handler . Info-bookmark-jump)))
4348 (defvar bookmark-current-bookmark)
4349 (declare-function bookmark-prop-get "bookmark" (bookmark prop))
4350 (declare-function bookmark-file-or-variation-thereof "bookmark" (file))
4351 (declare-function bookmark-jump-noselect "bookmark" (str))
4352 (declare-function bookmark-get-bookmark-record "bookmark" (bookmark))
4354 ;;;###autoload
4355 (defun Info-bookmark-jump (bmk)
4356 ;; This implements the `handler' function interface for record type returned
4357 ;; by `Info-bookmark-make-record', which see.
4358 (let* ((file (expand-file-name (bookmark-prop-get bmk 'filename)))
4359 (forward-str (bookmark-prop-get bmk 'front-context-string))
4360 (behind-str (bookmark-prop-get bmk 'rear-context-string))
4361 (info-node (bookmark-prop-get bmk 'info-node)))
4362 (if (setq file (bookmark-file-or-variation-thereof file))
4363 (save-excursion
4364 (save-window-excursion
4365 (with-no-warnings
4366 (Info-find-node file info-node))
4367 ;; Go searching forward first. Then, if forward-str exists and was
4368 ;; found in the file, we can search backward for behind-str.
4369 ;; Rationale is that if text was inserted between the two in the
4370 ;; file, it's better to be put before it so you can read it, rather
4371 ;; than after and remain perhaps unaware of the changes.
4372 (if forward-str
4373 (if (search-forward forward-str (point-max) t)
4374 (goto-char (match-beginning 0))))
4375 (if behind-str
4376 (if (search-backward behind-str (point-min) t)
4377 (goto-char (match-end 0))))
4378 `((buffer ,(current-buffer)) (position ,(point))))))))
4380 (provide 'info)
4382 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4383 ;;; info.el ends here