| blob | 4a90b3e65bba4dd3a142b9fd7170cca9998bce8f |
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, 2009
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 of the License, or
15 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Note that nowadays we expect Info files to be made using makeinfo.
28 ;; In particular we make these assumptions:
29 ;; - a menu item MAY contain colons but not colon-space ": "
30 ;; - a menu item ending with ": " (but not ":: ") is an index entry
31 ;; - a node name MAY NOT contain a colon
32 ;; This distinction is to support indexing of computer programming
33 ;; language terms that may contain ":" but not ": ".
35 ;;; Code:
40 "Info subsystem."
46 "Stack of Info nodes user has visited.
50 "Stack of Info nodes user has visited with `Info-history-back' command.
54 "List of all Info nodes user has visited.
59 This is convenient if you want to write Info files by hand.
60 However, we recommend that you not do this.
61 It is better to write a Texinfo file and generate the Info file from that,
62 because that gives you a printed manual as well."
67 "Non-nil allows Info to execute Lisp code associated with nodes.
75 "Face for Info node names."
84 "Face for info titles at level 1."
86 ;; backward-compatibility alias
92 "Face for info titles at level 2."
94 ;; backward-compatibility alias
100 "Face for info titles at level 3."
102 ;; backward-compatibility alias
108 "Face for info titles at level 4."
110 ;; backward-compatibility alias
115 :underline t
118 :inherit variable-pitch
120 "Face for headers in Info menus."
126 "Face for every third `*' in an Info menu."
132 "Face for unvisited Info cross-references."
137 "Face for visited Info cross-references."
142 "Non-nil to fontify references to visited nodes in `info-xref-visited' face."
148 "Maximum size of menu to fontify if `font-lock-mode' is non-nil.
149 Set to nil to disable node fontification."
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. If this is non-nil, you might
225 want to set `Info-refill-paragraphs'."
234 "If non-nil, attempt to refill paragraphs with hidden references.
235 This refilling may accidentally remove explicit line breaks in the Info
236 file, so be prepared for a few surprises if you enable this feature.
237 This only has an effect if `Info-hide-note-references' is non-nil."
243 "Depth of breadcrumbs to display.
244 0 means do not display breadcrumbs."
248 "If non-nil, regular expression to match a sequence of whitespace chars.
249 This applies to Info search for regular expressions.
251 In the Customization buffer, that is `[' followed by a space,
252 a tab, a carriage return (control-M), a newline, and `]+'."
257 "If non-nil, isearch in Info searches through multiple nodes.
258 Before leaving the initial Info node, where isearch was started,
259 it fails once with the error message [initial node], and with
260 subsequent C-s/C-r continues through other nodes without failing
261 with this error message in other nodes. When isearch fails for
262 the rest of the manual, it wraps aroung the whole manual and
263 restarts the search from the top/final node depending on
264 search direction.
266 Setting this option to nil restores the default isearch behavior
267 with wrapping around the current Info node."
275 ;; Try to obey obsolete Info-fontify settings.
278 "Hooks run when `Info-mode' is called."
283 "Hooks run when `Info-select-node' is called."
291 "Info file that Info is now looking at, or nil.
292 This is the name that was specified in Info, not the actual file name.
296 "Info subfile that is actually in the *info* buffer now.
303 "Marker pointing at beginning of current Info file's tag table.
316 "List of Info files with information about index cookies support.
317 Each element of the list is a list (FILENAME SUPPORTS-INDEX-COOKIES)
324 "Point location within a selected node.
325 If string, the point is moved to the proper occurrence of the
326 name of the followed cross reference within a selected node.
331 \f
333 ;; The MS-DOS list should work both when long file names are
334 ;; supported (Windows 9X), and when only 8+3 file names are available.
376 "List of file name suffixes and associated decoding commands.
377 Each entry should be (SUFFIX . STRING); the file is given to
378 the command as standard input.
380 STRING may be a list of strings. In that case, the first element is
381 the command name, and the rest are arguments to that command.
383 If STRING is nil, no decoding is done.
384 Because the SUFFIXes are tried in order, the empty string should
387 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
388 ;; First, on MS-DOS with no long file names support, delete some of
389 ;; the extension in FILENAME to make room.
394 ;; How long is the extension in FILENAME (not counting the dot).
396 ext-left)
397 ;; SUFFIX starts with a dot. If FILENAME already has one,
398 ;; get rid of the one in SUFFIX (unless suffix is empty).
403 ;; How many chars of that extension should we keep?
405 ;; Get rid of the rest of the extension, and add SUFFIX.
408 suffix))))
415 "Insert the contents of an Info file in the current buffer.
416 Do the right thing if the file has been compressed or zipped."
420 t))
422 lfn))
423 fullname decoder done)
425 ;; FILENAME exists--see if that name contains a suffix.
426 ;; If so, set DECODE accordingly.
431 filename)))
435 ;; Try adding suffixes to FILENAME and see if we can find something.
441 ;; If we found a file with a suffix, set DECODER
442 ;; according to the suffix.
444 ;; When the MS-DOS port runs on Windows, we need to check
445 ;; the short variant of a long file name as well.
455 ;; check for conflict with jka-compr
466 default-directory)))
475 "Return non-nil value if FILE supports Info index cookies.
476 Info index cookies were first introduced in 4.7, and all later
477 makeinfo versions output them in index nodes, so we can rely
478 solely on the makeinfo version. This function caches the information
479 in `Info-file-supports-index-cookies-list'."
482 ;; Skip virtual Info files
501 \f
508 "../share/info/"
509 invocation-directory)))
511 infodir
513 "../../../share/info/"
514 invocation-directory))
516 infodir))))))
517 alternative)
520 ;; Uninstalled, Emacs builddir != srcdir.
521 sibling
522 ;; Uninstalled, builddir == srcdir
523 source))
525 ;; On DOS/NT, we use movable executables always,
526 ;; and we must always find the Info dir at run time.
528 nil
529 ;; Use invocation-directory for Info
530 ;; only if we used it for exec-directory also.
533 installation-directory))))
535 Info-default-directory-list
536 ;; `alternative' contains the Info files that came with this
537 ;; version, so we should look there first. `Info-insert-dir'
538 ;; currently expects to find `alternative' first on the list.
540 ;; Don't drop the last part, it might contain non-Emacs stuff.
541 ;; (reverse (cdr (reverse
545 "Initialize `Info-directory-list', if that hasn't been done yet."
558 ;;;###autoload
560 "Like `info' but show the Info buffer in another window."
566 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
568 ;;;###autoload (put 'info 'info-file "emacs")
569 ;;;###autoload
571 "Enter Info, the documentation browser.
572 Optional argument FILE-OR-NODE specifies the file to examine;
573 the default is the top-level directory of Info.
574 Called from a program, FILE-OR-NODE may specify an Info node of the form
575 `(FILENAME)NODENAME'.
576 Optional argument BUFFER specifies the Info buffer name;
577 the default buffer name is *info*. If BUFFER exists,
578 just switch to BUFFER. Otherwise, create a new buffer
579 with the top-level Info directory.
581 In interactive use, a non-numeric prefix argument directs
582 this command to read a file name from the minibuffer.
583 A numeric prefix argument selects an Info buffer with the prefix number
584 appended to the Info buffer name.
586 The search path for Info files is in the variable `Info-directory-list'.
587 The top-level Info directory is made by combining all the files named `dir'
588 in all the directories in that path.
590 See a list of available Info commands in `Info-mode'."
600 ;; If argument already contains parentheses, don't add another set
601 ;; since the argument will then be parsed improperly. This also
602 ;; has the added benefit of allowing node names to be included
603 ;; following the parenthesized filename.
606 file-or-node
610 ;; If we just created the Info buffer, go to the directory.
613 ;;;###autoload
615 "Display the Emacs manual in Info mode."
619 ;;;###autoload
621 "Run Emacs as a standalone Info reader.
622 Usage: emacs -f info-standalone [filename]
636 \f
637 ;; See if the accessible portion of the buffer begins with a node
638 ;; delimiter, and the node header line which follows matches REGEXP.
639 ;; Typically, this test will be followed by a loop that examines the
640 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
641 ;; to have the overhead of this special test inside the loop.
643 ;; This function changes match-data, but supposedly the caller might
644 ;; want to use the results of re-search-backward.
646 ;; The return value is the value of point at the beginning of matching
647 ;; REGEXP, if the function succeeds, nil otherwise.
659 Optional second argument NOERROR, if t, means if file is not found
660 just return nil (no error)."
661 ;; Convert filename to lower case if not found as specified.
662 ;; Expand it.
671 ;; If specified name starts with `./'
672 ;; then just try current directory.
675 ;; No point in searching for an
676 ;; absolute file name
680 Info-additional-directory-list)
681 Info-directory-list)))))
682 ;; Search the directory list for file FILENAME.
687 ;; Try several variants of specified name.
691 t)))
702 lfn
714 filename)
718 "Go to an Info node specified as separate FILENAME and NODENAME.
719 NO-GOING-BACK is non-nil if recovering from an error in this function;
720 it says do not attempt further (recursive) error recovery."
723 ;; Go into Info buffer.
725 ;; Record the node we are leaving, if we were in one.
727 Info-current-file
729 Info-history))
732 ;;;###autoload
734 "Use Info mode to browse the current Info buffer.
735 With a prefix arg, this queries for the node name to visit first;
736 otherwise, that defaults to `Top'."
746 ;; If called on a non-file buffer, make a fake file name.
750 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
751 ;; but at least it keeps this routine (which is for makeinfo-buffer and
752 ;; Info-revert-buffer-function) out of the way of normal operations.
753 ;;
755 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
756 When *info* is already displaying FILENAME and NODENAME, the window position
757 is preserved, if possible."
773 ;; note goto-line is no good, we want to measure from point-min
780 ;; only add to the history when coming from a different file+node
790 "Find a node in a tag table.
791 MARKER specifies the buffer and position to start searching at.
792 REGEXP is a regular expression matching nodes or references. Its first
793 group should match `Node:' or `Ref:'.
794 CASE-FOLD t means search for a case-insensitive match.
795 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
796 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
797 where the match was found, and MODE is `major-mode' of the buffer in
798 which the match was found."
803 ;; Search tag table
808 major-mode)))))
811 "Find a node in a tag table.
812 MARKER specifies the buffer and position to start searching at.
813 REGEXP is a regular expression matching nodes or references. Its first
814 group should match `Node:' or `Ref:'.
815 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
816 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
817 where the match was found, and MODE is `major-mode' of the buffer in
818 which the match was found.
819 This function tries to find a case-sensitive match first, then a
820 case-insensitive match is tried."
824 result))
827 "Find a node or anchor in the current buffer.
828 REGEXP is a regular expression matching nodes or references. Its first
829 group should match `Node:' or `Ref:'.
830 CASE-FOLD t means search for a case-insensitive match.
831 Value is the position at which a match was found, or nil if not found."
833 found)
845 found)))
848 "Find a node or anchor in the current buffer.
849 REGEXP is a regular expression matching nodes or references. Its first
850 group should match `Node:' or `Ref:'.
851 Value is the position at which a match was found, or nil if not found.
852 This function looks for a case-sensitive match first. If none is found,
853 a case-insensitive match is tried."
865 anchorpos)
866 ;; Switch files if necessary
871 Info-current-subfile nil
872 Info-current-file-completions nil
873 buffer-file-name nil)
891 ;; See whether file has a tag table. Record the location if yes.
894 ;; Use string-equal, not equal, to ignore text props.
899 ;; We have a tag table. Find its beginning.
900 ;; Is this an indirect file?
906 ;; It is indirect. Copy it to another buffer
907 ;; and record that the tag table is in that buffer.
926 ))
927 ;; Use string-equal, not equal, to ignore text props.
931 ;; Possibilities:
932 ;;
933 ;; 1. Anchor found in tag table
934 ;; 2. Anchor *not* in tag table
935 ;;
936 ;; 3. Node found in tag table
937 ;; 4. Node *not* found in tag table, but found in file
938 ;; 5. Node *not* in tag table, and *not* in file
939 ;;
940 ;; *Or* the same, but in an indirect subfile.
942 ;; Search file for a suitable node.
952 ;; First, search a tag table, if any
958 ;; FOUND is (ANCHOR POS MODE).
961 ;; If this is an indirect file, determine which
962 ;; file really holds this node and read it in.
964 ;; Note that the current buffer must be the
965 ;; *info* buffer on entry to
966 ;; Info-read-subfile. Thus the hackery above.
969 ;; Handle anchor
974 ;; Else we may have a node, which we search for:
978 ;; Now search from our advised position (or from beg of
979 ;; buffer) to find the actual node. First, check
980 ;; whether the node is right where we are, in case the
981 ;; buffer begins with a node.
994 ;; No such anchor in tag table or node in tag table or file
1006 ;; Add anchors to the history too
1017 ;; If we did not finish finding the specified node,
1018 ;; go back to the previous one.
1025 ;; Cache the contents of the (virtual) dir file, once we have merged
1026 ;; it for the first time, so we can save time subsequently.
1029 ;; Cache for the directory we decided to use for the default-directory
1030 ;; of the merged dir text.
1033 ;; Record the file attributes of all the files from which we
1034 ;; constructed Info-dir-contents.
1039 ;; Construct the Info directory node by merging the files named `dir'
1040 ;; from various directories. Set the *info* buffer's
1041 ;; default-directory to the first directory we actually get any text
1042 ;; from.
1045 ;; Verify that none of the files we used has changed
1046 ;; since we used it.
1050 ;; Handle symlinks
1053 ;; Don't compare the access time.
1057 Info-dir-file-attributes))))
1063 Info-additional-directory-list)
1064 Info-directory-list))
1066 ;; Bind this in case the user sets it to nil.
1068 ;; This is set non-nil if we find a problem in some input files.
1069 problems
1070 buffers buffer others nodes dirs-done)
1072 ;; Search the directory list for the directory file.
1077 ;; Try several variants of specified name.
1078 ;; Try upcasing, appending `.info', or both.
1093 dirs-done)))
1099 ;; Index nodes include null bytes. DIR
1100 ;; files should not have indices, but who
1101 ;; knows...
1105 file)
1117 ;; Distinguish the dir file that comes with Emacs from all the
1118 ;; others. Yes, that is really what this is supposed to do.
1119 ;; The definition of `Info-directory-list' puts it first on that
1120 ;; list and so last in `buffers' at this point.
1124 ;; Insert the entire original dir file as a start; note that we've
1125 ;; already saved its default directory to use as the default
1126 ;; directory for the whole concatenation.
1129 ;; Look at each of the other buffers one by one.
1132 ;; In each, find all the menus.
1135 ;; Find each menu, and add an elt to NODES for it.
1139 nodename end)
1151 ;; Add to the main menu a menu item for each other node.
1163 end t)
1167 ;; Now take each node of each of the other buffers
1168 ;; and merge it into the main buffer.
1173 ;; Find the like-named node in the main buffer.
1177 nil t)
1182 ;; If none exists, add one.
1185 ;; Merge the text from the other buffer's menu
1186 ;; into the menu in the like-named node in the main buffer.
1189 ;; Kill all the buffers we just made, including the special one excised.
1209 ;; Remove duplicate headings in the same menu.
1212 ;; Look for the next heading to unify.
1217 ;; Check whether this heading should be streamlined.
1227 ;; Look for other headings of the same category and merge them.
1233 ;; Delete redundant heading.
1235 ;; Push the entries onto `text'.
1242 entries)
1244 ;; Insert the entries just found.
1252 ;; Now remove duplicate entries under the same heading.
1258 ;; Fold case straight away; `member-ignore-case' here wasteful.
1268 ;; Note that on entry to this function the current-buffer must be the
1269 ;; *info* buffer; not the info tags buffer.
1271 ;; NODEPOS is either a position (in the Info file as a whole,
1272 ;; not relative to a subfile) or the name of a subfile.
1274 lastfilename)
1285 thisfilepos thisfilename)
1289 ;; read in version 19 stops at the end of number.
1290 ;; Advance to the next line.
1299 ;; Assume previous buffer is in Info-mode.
1300 ;; (set-buffer (get-buffer "*info*"))
1309 ;; Widen in case we are in the same subfile as before.
1319 "Unescape double quotes and backslashes in VALUE."
1325 unquote))
1327 ;; As of Texinfo 4.6, makeinfo writes constructs like
1328 ;; \0\h[image param=value ...\h\0]
1329 ;; into the Info file for handling images.
1332 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1333 whitespace or double quotes, it must be quoted in double quotes and
1338 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1339 parameter-string start)
1345 parameter-alist))
1346 parameter-alist))
1349 "Display images in current node."
1356 nil t)
1370 ;; text-only display, show alternative text if provided, or
1371 ;; otherwise a clue that there's meant to be a picture
1380 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1381 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1382 ;; including one optional trailing newline.
1384 "Hide unrecognized cookies in current node."
1391 nil t)
1398 "Select the Info node that point is in."
1399 ;; Bind this in case the user sets it to nil.
1402 ;; Find beginning of node.
1408 ;; Get nodename spelled as it is in the node.
1416 ;; Find the end of it, and narrow.
1419 ;; Narrow to the node contents
1431 ;; Add a new unique history item to full history list
1446 map)
1454 " ("
1459 ") "
1464 'help-echo
1465 "mouse-1: scroll forward, mouse-3: scroll back"
1469 \f
1470 ;; Go to an Info node specified with a filename-and-nodename string
1471 ;; of the sort that is found in pointers in nodes.
1473 ;; Don't autoload this function: the correct entry point for other packages
1474 ;; to use is `info'. --Stef
1475 ;; ;;;###autoload
1477 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1478 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1479 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1480 its sub-files).
1481 Completion is available, but only for node names in the current Info file.
1482 If FORK is non-nil (interactively with a prefix arg), show the node in
1483 a new Info buffer.
1484 If FORK is a string, it is the name to use for the new buffer."
1492 nodename)
1494 ""
1508 "Virtual completion table for file names input in Info node names.
1509 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1523 ;; If the file name has no suffix or a standard suffix,
1524 ;; include it.
1527 ;; But exclude subfiles of split Info files.
1529 ;; And exclude backup files.
1532 ;; If the file name ends in a standard suffix,
1533 ;; add the unsuffixed name as a completion option.
1539 ;; This function is used as the "completion table" while reading a node name.
1540 ;; It does completion using the alist in Info-read-node-completion-table
1541 ;; unless STRING starts with an open-paren.
1544 ;; First complete embedded file names.
1547 "("
1550 Info-directory-list
1553 predicate
1554 code))
1556 ;; If a file name was given, then any node is fair game.
1562 ;; Otherwise use Info-read-node-completion-table.
1564 code Info-read-node-completion-table string predicate))))
1566 ;; Arrange to highlight the proper letters in the completion list buffer.
1575 nodename)))
1580 ;; Bind this in case the user sets it to nil.
1595 compl))))
1598 ;; If the buffer begins with a node header, process that first.
1601 ;; Now for the rest of the nodes.
1609 compl))))))))
1612 \f
1614 "If this node has been visited, restore the point value when we left."
1617 ;; Use string-equal, not equal, to ignore text props.
1623 \f
1631 "Search for REGEXP, starting from point, and select node it's found in.
1632 If DIRECTION is `backward', search in the reverse direction."
1660 ;; Hide Info file header for backward search
1671 Info-search-whitespace-regexp)))
1686 ;; If no subfiles, give error now.
1691 Info-search-whitespace-regexp)))
1702 ;; Try other subfiles.
1712 ;; Find the subfile we just searched.
1714 ;; Skip that one.
1717 ;; Make a list of all following subfiles.
1718 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1727 list))
1731 ;; Put in forward order
1737 ;; Hide Info file header for backward search
1751 Info-search-whitespace-regexp)))
1774 ;; Search landed in the same node
1780 ;; Use string-equal, not equal, to ignore text props.
1786 Info-history))))))
1789 "Search for a regexp case-sensitively."
1795 "Search for next regexp from a previous `Info-search' command."
1803 "Search for REGEXP in the reverse direction."
1822 nil t)
1823 ;; Lax version of word search
1829 bound noerror count
1832 bound noerror count
1859 ;; Don't stop at initial node for nonincremental search.
1860 ;; Otherwise this variable is set after first search failure.
1864 "Test whether the current search hit is a visible useful text.
1865 Return non-nil if the text from BEG-FOUND to FOUND is visible
1866 and is not in the header line or a tag table."
1877 ;; Skip node header line
1881 ;; Skip Tag Table node
1887 \f
1889 "Extract the value of the node-pointer named NAME.
1890 If there is none, use ERRORNAME in the error message;
1891 if ERRORNAME is nil, just return nil."
1892 ;; Bind this in case the user sets it to nil.
1906 "Return a regexp matching a node name.
1907 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1908 saying which chars may appear in the node name.
1909 Submatch 1 is the complete node name.
1910 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1911 Submatch 3 is the local part of the node name.
1912 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1919 ;;; For compatibility; other files have used this name.
1925 "Go to the next node of this node."
1927 ;; In case another window is currently selected
1933 "Go to the previous node of this node."
1935 ;; In case another window is currently selected
1941 "Go to the superior node of this node.
1942 If SAME-FILE is non-nil, do not move to a different Info file."
1944 ;; In case another window is currently selected
1963 nil t))
1969 "Go back in the history to the last node visited."
1975 Info-history-forward))
1976 filename nodename opoint)
1989 "Go forward in the history of visited nodes."
1994 filename nodename opoint)
2002 ;;;###autoload
2004 "Go to the Info directory node."
2007 \f
2009 "Go to a node with a menu of visited nodes."
2013 p)
2038 "Go to a node with table of contents of the current Info file.
2039 Table of contents is created from the tree structure of menus."
2044 p)
2074 "Insert table of contents with references to nodes."
2086 "Build table of contents from menus of Info FILE and its subfiles."
2091 default-directory))
2094 nodes subfiles)
2096 ;; (or main-file (message "Searching subfile %s..." (car subfiles)))
2107 bound t)
2110 menu-items)
2120 bound))
2123 ;; Menu item line
2133 ;; Other non-empty strings in the Top node are section names
2142 nodes))
2151 subfiles)))))
2153 main-file nil))
2159 "Alist of cached parent-children node information in visited Info files.
2160 Each element is (FILE (NODE-NAME PARENT SECTION CHILDREN) ...)
2161 where PARENT is the parent node extracted from the Up pointer,
2162 SECTION is the section name in the Top node where this node is placed,
2166 "Return a node list of Info FILE with parent-children information.
2167 This information is cached in the variable `Info-toc-nodes' with the help
2168 of the function `Info-build-toc'."
2171 ;; Skip virtual Info files
2175 ;; Scan the entire manual and cache the result in Info-toc-nodes
2178 nodes)
2179 ;; If there is an error, still add nil to the cache
2183 \f
2185 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2186 FOOTNOTENAME may be an abbreviation of the reference name.
2187 If FORK is non-nil (interactively with a prefix arg), show the node in
2188 a new Info buffer. If FORK is a string, it is the name to use for the
2189 new buffer."
2195 ;; Store end and beginning of line.
2204 ;; See if this one should be the default.
2209 ;; See if this one should be the alternate default.
2219 ;; Record as a completion and perhaps as default.
2222 ;; Don't add this string if it's a duplicate.
2225 ;; If no good default was found, try an alternate.
2228 ;; If only one cross-reference found, then make it default.
2234 "Follow reference named (default "
2237 completions nil t)))
2251 ;; Move point to the beginning of reference if point is on reference
2261 ;; Go to the reference closest to point
2269 next-ref prev-ref))
2280 ;; We allow newline because this is also used in Info-follow-reference,
2281 ;; where the xref name might be wrapped over two lines.
2282 "Regexp that matches a menu entry name upto but not including the colon.
2283 Because of ambiguities, this should be concatenated with something like
2304 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2305 ;;; (setq Info-point-loc
2306 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2307 )
2311 ;; If the node name is the menu entry name (using `entry::').
2315 ;; No one calls this.
2316 ;;(defun Info-menu-item-sequence (list)
2317 ;; (while list
2318 ;; (Info-menu (car list))
2319 ;; (setq list (cdr list))))
2331 ;; This uses two dynamically bound variables:
2332 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2333 ;; is the menu of items we're trying to complete.
2334 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2335 ;; also look for menu items in subsequent nodes as long as those
2336 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2337 ;; not used.
2338 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2339 ;; also look for menu items in these nodes. This feature is currently
2340 ;; only used for completion in Info-index.
2342 ;; Note that `Info-complete-menu-buffer' could be current already,
2343 ;; so we want to save point.
2349 nextnode)
2358 completions
2360 ;; Check the cache.
2368 ;; We can reuse the previous list.
2370 ;; The cache can't be used.
2375 completions))
2376 ;; Check subsequent nodes if applicable.
2384 ;; Go back to the start node (for the next completion).
2387 ;; Update the cache.
2390 Info-complete-next-re string completions
2391 Info-complete-nodes)))
2398 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2399 The menu item should one of those listed in the current node's menu.
2400 Completion is allowed, and the default menu item is the one point is on.
2401 If FORK is non-nil (interactively with a prefix arg), show the node in
2402 a new Info buffer. If FORK is a string, it is the name to use for the
2403 new buffer."
2406 ;; If point is within a menu item, use that item as the default
2409 beg
2422 Info-menu-entry-name-re
2431 default)
2434 ;; we rely on the fact that completing-read accepts an input
2435 ;; of "" even when the require-match argument is true and ""
2436 ;; is not a valid possibility
2440 ;; ask again
2443 ;; there is a problem here in that if several menu items have the same
2444 ;; name you can only go to the node of the first with this command.
2462 ;; If COUNT is nil, use the last item in the menu.
2478 nil))
2482 "Go to the node of the Nth menu item.
2483 N is the digit argument used to invoke this command."
2490 "Go to the Top node of this file."
2495 "Go to the final node in this file."
2500 ;; Go to the last node in the menu of Top. But don't delve into
2501 ;; detailed node listings.
2503 ;; If the last node in the menu is not last in pointer structure,
2504 ;; move forward (but not down- or upward - see bug#1116) until we
2505 ;; can't go any farther.
2507 ;; Then keep moving down to last subnode, unless we reach an index.
2513 "Go forward one node, considering all nodes as forming one sequence."
2518 ;; three possibilities, in order of priority:
2519 ;; 1. next node is in a menu in this node (but not in an index)
2520 ;; 2. next node is next at same level
2521 ;; 3. next node is up and next
2526 t)
2529 t)
2532 ;; Use string-equal, not equal, to ignore text props.
2545 "Go backward one node, considering all nodes as forming one sequence."
2553 ;; Use string-equal, not equal,
2554 ;; to ignore text properties.
2559 ;; If we move back at the same level,
2560 ;; go down to find the last subnode*.
2570 "Exit Info by selecting some other buffer."
2577 "Go to the node of the next menu item."
2579 ;; Bind this in case the user sets it to nil.
2591 "Go to the node of the previous menu item."
2595 ;; Bind this in case the user sets it to nil.
2610 "Go to the next subnode or the next node, or go up a level."
2615 ;; Since we have already gone thru all the items in this menu,
2616 ;; go up to the end of this node.
2618 ;; Since logically we are done with the node with that menu,
2619 ;; move on from it. But don't add intermediate nodes
2620 ;; to the history on recursive calls.
2627 "Go to the last node, popping up a level if there is none."
2631 ;; If we go down a menu item, go to the end of the node
2632 ;; so we can scroll back through it.
2634 ;; Keep going down, as long as there are nested menu nodes.
2637 ;; If we go down a menu item, go to the end of the node
2638 ;; so we can scroll back through it.
2648 ;; If we go down a menu item, go to the end of the node
2649 ;; so we can scroll back through it.
2660 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2661 Once you scroll far enough in a node that its menu appears on the screen
2662 but after point, the next scroll moves into its first subnode, unless
2663 `Info-scroll-prefer-subnodes' is nil.
2665 When you scroll past the end of a node, that goes to the next node if
2666 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2667 if this node has no successor, it moves to the parent node's successor,
2668 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2669 the menu of a node, it moves to subnode indicated by the following menu
2670 item. (That case won't normally result from this command, but can happen
2671 in other ways.)"
2693 "Scroll one screenful forward in Info, using the mouse.
2694 See `Info-scroll-up'."
2702 "Scroll one screenful back in Info, considering all nodes as one sequence.
2703 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2704 is non-nil, this goes to its last subnode. When you scroll past the
2705 beginning of a node, that goes to the previous node or back up to the
2706 parent node."
2720 current-point
2721 t)))))
2728 "Scroll one screenful backward in Info, using the mouse.
2729 See `Info-scroll-down'."
2737 "Move cursor to the next cross-reference or menu item in the node."
2759 "Move cursor to the previous cross-reference or menu item in the node."
2778 \f
2780 "Alist of cached index node names of visited Info files.
2784 "Return a list of names of all index nodes in Info FILE.
2785 If FILE is omitted, it defaults to the current Info file.
2786 First look in a list of cached index node names. Then scan Info
2787 file and its subfiles for nodes with the index cookie. Then try
2788 to find index nodes starting from the first node in the top level
2793 ;; Skip virtual Info files
2798 ;; Find nodes with index cookie
2802 default-directory))
2803 Info-history Info-history-list Info-fontify-maximum-menu-size
2823 subfiles)))))
2825 main-file nil))
2831 nodes)
2832 ;; Else find nodes with the word "Index" in the node name
2834 Info-history Info-history-list Info-fontify-maximum-menu-size Info-point-loc
2835 nodes node)
2853 nodes))
2854 ;; If file has no index nodes, still add it to the cache
2859 "Return non-nil value if NODE is an index node.
2860 If NODE is nil, check the current Info node.
2861 If FILE is nil, check the current Info file."
2866 ;; Don't search all index nodes if request is only for the current node
2867 ;; and file is not in the cache of index nodes
2881 "Go to the first index node."
2886 ;;;###autoload
2888 "Look up a string TOPIC in the index for this manual and go to that entry.
2889 If there are no exact matches to the specified topic, this chooses
2890 the first match which is a case-insensitive substring of a topic.
2892 Give an empty topic name to go to the Index node itself."
2908 ;; Strip leading colon in topic; index format does not allow them.
2914 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2923 ;; We bind Info-history to nil for internal node-switches so
2924 ;; that we don't put junk in the history. In the first
2925 ;; Info-goto-index call, above, we do update the history
2926 ;; because that is what the user's previous node choice into it.
2928 found)
2935 Info-current-node
2938 matches))
2945 ;; Here it is a feature that assoc is case-sensitive.
2978 'Info-index-next overriding-local-map
2979 t)))
2983 "Move point to the place within the current node where NAME is defined."
2988 ;; Find a function definition with a return type.
2996 nil t))
2998 ;; Try again without the " <1>" makeinfo can append
3004 ;;;###autoload
3006 "Grovel indices of all known Info files on your system for STRING.
3007 Build a menu of the possible matches."
3010 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
3016 manuals matches node nodes)
3019 ;; current-node and current-file are nil when they invoke info-apropos
3020 ;; as the first Info command, i.e. info-apropos loads info.el. In that
3021 ;; case, we use (DIR)Top instead, to avoid signalling an error after
3022 ;; the search is complete.
3030 ;; add-to-list makes sure we don't have duplicates in `manuals',
3031 ;; so that the following dolist loop runs faster.
3048 matches)))
3057 Info-history-list ohist-list)
3078 "Make command be undefined in Info."
3083 "Enter the Info tutorial."
3088 "Help-Small-Screen"
3092 "Display a brief summary of all Info commands."
3107 flag))
3110 \f
3112 "Return the token around POS.
3113 POS must be somewhere inside the token
3114 START is a regular expression which will match the
3115 beginning of the tokens delimited string
3116 ALL is a regular expression with a single
3117 parenthesized subpattern which is the token to be
3118 returned. E.g. '{\(.*\)}' would return any string
3119 enclosed in braces around POS.
3120 ERRORSTRING optional fourth argument, controls action on no match
3121 nil: return nil
3122 t: beep
3123 a string: signal an error, using that string."
3127 ;; First look for a match for START that goes across POS.
3131 ;; If we did not find one, search back for START
3132 ;; (this finds only matches that end at or before POS).
3145 nil)
3148 nil)
3154 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3155 At end of the node's text, moves to the next node, or up if none."
3163 "Follow a node reference near point.
3164 If point is on a reference, follow that reference. Otherwise,
3165 if point is in a menu item description, follow that menu item.
3167 If FORK is non-nil (interactively with a prefix arg), show the node in
3168 a new Info buffer.
3169 If FORK is a string, it is the name to use for the new buffer."
3181 t)))
3183 ;; Don't raise an error when mouse-1 is bound to this - it's
3184 ;; often used to simply select the window or frame.
3188 ;; Common subroutine.
3190 "Follow a node reference near point. Return non-nil if successful.
3191 If FORK is non-nil, it is passed to `Info-goto-node'."
3200 ;; menu item: node name
3203 ;; menu item: node name or index entry
3217 node))
3218 \f
3229 (define-key map "1" 'Info-nth-menu-item)
3230 (define-key map "2" 'Info-nth-menu-item)
3231 (define-key map "3" 'Info-nth-menu-item)
3232 (define-key map "4" 'Info-nth-menu-item)
3233 (define-key map "5" 'Info-nth-menu-item)
3234 (define-key map "6" 'Info-nth-menu-item)
3235 (define-key map "7" 'Info-nth-menu-item)
3236 (define-key map "8" 'Info-nth-menu-item)
3237 (define-key map "9" 'Info-nth-menu-item)
3238 (define-key map "0" 'undefined)
3239 (define-key map "?" 'Info-summary)
3240 (define-key map "]" 'Info-forward-node)
3241 (define-key map "[" 'Info-backward-node)
3242 (define-key map "<" 'Info-top-node)
3243 (define-key map ">" 'Info-final-node)
3244 (define-key map "b" 'beginning-of-buffer)
3245 (define-key map "d" 'Info-directory)
3246 (define-key map "e" 'Info-edit)
3247 (define-key map "f" 'Info-follow-reference)
3248 (define-key map "g" 'Info-goto-node)
3249 (define-key map "h" 'Info-help)
3250 (define-key map "i" 'Info-index)
3251 (define-key map "l" 'Info-history-back)
3252 (define-key map "L" 'Info-history)
3253 (define-key map "m" 'Info-menu)
3254 (define-key map "n" 'Info-next)
3255 (define-key map "p" 'Info-prev)
3256 (define-key map "q" 'Info-exit)
3257 (define-key map "r" 'Info-history-forward)
3258 (define-key map "s" 'Info-search)
3259 (define-key map "S" 'Info-search-case-sensitively)
3260 (define-key map "\M-n" 'clone-buffer)
3261 (define-key map "t" 'Info-top-node)
3262 (define-key map "T" 'Info-toc)
3263 (define-key map "u" 'Info-up)
3264 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3265 (define-key map "w" 'Info-copy-current-node-name)
3266 (define-key map "c" 'Info-copy-current-node-name)
3267 ;; `^' for consistency with `dired-up-directory'.
3268 (define-key map "^" 'Info-up)
3269 (define-key map "," 'Info-index-next)
3271 (define-key map [mouse-2] 'Info-mouse-follow-nearest-node)
3272 (define-key map [follow-link] 'mouse-face)
3273 map)
3274 "Keymap containing Info commands.")
3277 (defun Info-check-pointer (item)
3278 "Non-nil if ITEM is present in this node."
3279 (condition-case nil
3280 (Info-extract-pointer item)
3281 (error nil)))
3283 (easy-menu-define
3284 Info-mode-menu Info-mode-map
3285 "Menu for Info files."
3286 '("Info"
3287 ["Up" Info-up :active (Info-check-pointer "up")
3288 :help "Go up in the Info tree"]
3289 ["Next" Info-next :active (Info-check-pointer "next")
3290 :help "Go to the next node"]
3291 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3292 :help "Go to the previous node"]
3293 ["Backward" Info-backward-node
3294 :help "Go backward one node, considering all as a sequence"]
3295 ["Forward" Info-forward-node
3296 :help "Go forward one node, considering all as a sequence"]
3297 ["Beginning" beginning-of-buffer
3298 :help "Go to beginning of this node"]
3299 ["Top" Info-top-node
3300 :help "Go to top node of file"]
3301 ["Final Node" Info-final-node
3302 :help "Go to final node in this file"]
3303 ("Menu Item" ["You should never see this" report-emacs-bug t])
3304 ("Reference" ["You should never see this" report-emacs-bug t])
3305 ["Search..." Info-search
3306 :help "Search for regular expression in this Info file"]
3307 ["Search Next" Info-search-next
3308 :help "Search for another occurrence of regular expression"]
3309 ["Go to Node..." Info-goto-node
3310 :help "Go to a named node"]
3311 ["Back in history" Info-history-back :active Info-history
3312 :help "Go back in history to the last node you were at"]
3313 ["Forward in history" Info-history-forward :active Info-history-forward
3314 :help "Go forward in history"]
3315 ["History" Info-history :active Info-history-list
3316 :help "Go to menu of visited nodes"]
3317 ["Table of Contents" Info-toc
3318 :help "Go to table of contents"]
3319 ("Index"
3320 ["Lookup a String..." Info-index
3321 :help "Look for a string in the index items"]
3322 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3323 :help "Look for another occurrence of previous item"]
3324 ["Lookup a string in all indices..." info-apropos
3325 :help "Look for a string in the indices of all manuals"])
3326 ["Copy Node Name" Info-copy-current-node-name
3327 :help "Copy the name of the current node into the kill ring"]
3328 ["Clone Info buffer" clone-buffer
3329 :help "Create a twin copy of the current Info buffer."]
3330 ["Exit" Info-exit :help "Stop reading Info"]))
3333 (defvar info-tool-bar-map
3334 (let ((map (make-sparse-keymap)))
3335 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map
3336 :rtl "right-arrow")
3337 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map
3338 :rtl "left-arrow")
3339 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map
3340 :rtl "next-node")
3341 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map
3342 :rtl "prev-node")
3343 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3344 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3345 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3346 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3347 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3348 (tool-bar-local-item-from-menu 'Info-exit "exit" map Info-mode-map)
3349 map))
3351 (defvar Info-menu-last-node nil)
3352 ;; Last node the menu was created for.
3353 ;; Value is a list, (FILE-NAME NODE-NAME).
3355 (defun Info-menu-update ()
3356 "Update the Info menu for the current node."
3357 (condition-case nil
3358 (if (or (not (eq major-mode 'Info-mode))
3359 (equal (list Info-current-file Info-current-node)
3360 Info-menu-last-node))
3361 ()
3362 ;; Update menu menu.
3363 (let* ((Info-complete-menu-buffer (current-buffer))
3364 (items (nreverse (condition-case nil
3365 (Info-complete-menu-item "" nil t)
3366 (error nil))))
3367 entries current
3368 (number 0))
3369 (while (and items (< number 9))
3370 (setq current (car items)
3371 items (cdr items)
3372 number (1+ number))
3373 (setq entries (cons `[,current
3374 (Info-menu ,current)
3375 :keys ,(format "%d" number)]
3376 entries)))
3377 (if items
3378 (setq entries (cons ["Other..." Info-menu t] entries)))
3379 (or entries
3380 (setq entries (list ["No menu" nil nil] nil :active)))
3381 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3382 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3383 (let ((items nil)
3384 str i entries current
3385 (number 0)
3386 (case-fold-search t))
3387 (save-excursion
3388 (goto-char (point-min))
3390 (setq str (match-string 1))
3391 (setq i 0)
3393 (setq str (concat (substring str 0 i) " "
3394 (substring str (match-end 0))))
3395 (setq i (1+ i)))
3396 (setq items
3397 (cons str items))))
3398 (while (and items (< number 9))
3399 (setq current (car items)
3400 items (cdr items)
3401 number (1+ number))
3402 (setq entries (cons `[,current
3403 (Info-follow-reference ,current)
3404 t]
3405 entries)))
3406 (if items
3407 (setq entries (cons ["Other..." Info-follow-reference t]
3408 entries)))
3409 (or entries
3410 (setq entries (list ["No references" nil nil] nil :active)))
3411 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3412 ;; Update last seen node.
3413 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3414 ;; Try to avoid entering infinite beep mode in case of errors.
3415 (error (ding))))
3417 \f
3418 (defun Info-copy-current-node-name (&optional arg)
3419 "Put the name of the current Info node into the kill ring.
3420 The name of the Info file is prepended to the node name in parentheses.
3421 With a zero prefix arg, put the name inside a function call to `info'."
3422 (interactive "P")
3423 (unless Info-current-node
3424 (error "No current Info node"))
3425 (let ((node (if (stringp Info-current-file)
3426 (concat "(" (file-name-nondirectory Info-current-file) ") "
3427 Info-current-node))))
3428 (if (zerop (prefix-numeric-value arg))
3430 (unless (stringp Info-current-file)
3431 (setq node (format "(Info-find-node '%S '%S)"
3432 Info-current-file Info-current-node)))
3433 (kill-new node)
3434 (message "%s" node)))
3436 \f
3437 ;; Info mode is suitable only for specially formatted data.
3438 (put 'Info-mode 'mode-class 'special)
3439 (put 'Info-mode 'no-clone-indirect t)
3441 (defvar tool-bar-map)
3442 (defvar bookmark-make-record-function)
3444 ;; Autoload cookie needed by desktop.el
3445 ;;;###autoload
3446 (defun Info-mode ()
3447 "Info mode provides commands for browsing through the Info documentation tree.
3449 one topic and contains references to other nodes which discuss related
3450 topics. Info has commands to follow the references and show you other nodes.
3456 Selecting other nodes:
3458 Follow a node reference you click on.
3459 This works with menu items, cross references, and
3461 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3466 Picking a menu item causes another node to be selected.
3476 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3480 Moving within a node:
3482 Once you scroll far enough in a node that its menu appears on the
3483 screen but after point, the next scroll moves into its first
3484 subnode. When after all menu items (or if there is no menu),
3485 move up to the parent node.
3487 already visible, try to go to the previous menu entry, or up
3488 if there is none.
3491 Advanced commands:
3493 and select the node in which the next occurrence is found.
3494 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3497 \\[isearch-forward], \\[isearch-forward-regexp] Use Isearch to search through multiple Info nodes.
3499 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3502 You may include a filename as well, as (FILENAME)NODENAME.
3503 1 .. 9 Pick first ... ninth item in node's menu.
3504 Every third `*' is highlighted to help pick the right number.
3508 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3509 (kill-all-local-variables)
3510 (setq major-mode 'Info-mode)
3511 (setq mode-name "Info")
3512 (setq tab-width 8)
3513 (use-local-map Info-mode-map)
3514 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3515 (set-syntax-table text-mode-syntax-table)
3516 (setq local-abbrev-table text-mode-abbrev-table)
3517 (setq case-fold-search t)
3518 (setq buffer-read-only t)
3519 (make-local-variable 'Info-current-file)
3520 (make-local-variable 'Info-current-subfile)
3521 (make-local-variable 'Info-current-node)
3522 (make-local-variable 'Info-tag-table-marker)
3523 (setq Info-tag-table-marker (make-marker))
3524 (make-local-variable 'Info-tag-table-buffer)
3525 (setq Info-tag-table-buffer nil)
3526 (make-local-variable 'Info-history)
3527 (make-local-variable 'Info-history-forward)
3528 (make-local-variable 'Info-index-alternatives)
3529 (if Info-use-header-line ; do not override global header lines
3530 (setq header-line-format
3531 '(:eval (get-text-property (point-min) 'header-line))))
3532 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3533 ;; This is for the sake of the invisible text we use handling titles.
3534 (make-local-variable 'line-move-ignore-invisible)
3535 (setq line-move-ignore-invisible t)
3536 (make-local-variable 'desktop-save-buffer)
3537 (make-local-variable 'widen-automatically)
3538 (setq widen-automatically nil)
3539 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3540 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3541 (add-hook 'clone-buffer-hook 'Info-clone-buffer nil t)
3542 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3543 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3544 (set (make-local-variable 'isearch-search-fun-function)
3545 'Info-isearch-search)
3546 (set (make-local-variable 'isearch-wrap-function)
3547 'Info-isearch-wrap)
3548 (set (make-local-variable 'isearch-push-state-function)
3549 'Info-isearch-push-state)
3550 (set (make-local-variable 'isearch-filter-predicate)
3551 'Info-isearch-filter)
3552 (set (make-local-variable 'search-whitespace-regexp)
3553 Info-search-whitespace-regexp)
3554 (set (make-local-variable 'revert-buffer-function)
3555 'Info-revert-buffer-function)
3556 (Info-set-mode-line)
3557 (set (make-local-variable 'bookmark-make-record-function)
3558 'Info-bookmark-make-record)
3559 (run-mode-hooks 'Info-mode-hook))
3561 ;; When an Info buffer is killed, make sure the associated tags buffer
3562 ;; is killed too.
3563 (defun Info-kill-buffer ()
3564 (and (eq major-mode 'Info-mode)
3565 Info-tag-table-buffer
3566 (kill-buffer Info-tag-table-buffer)))
3568 ;; Placed on `clone-buffer-hook'.
3569 (defun Info-clone-buffer ()
3570 (when (bufferp Info-tag-table-buffer)
3571 (setq Info-tag-table-buffer
3572 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3573 (let ((m Info-tag-table-marker))
3574 (when (markerp m)
3575 (setq Info-tag-table-marker
3576 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3577 (with-current-buffer Info-tag-table-buffer
3578 (copy-marker (marker-position m)))
3579 (make-marker))))))
3581 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3582 (set-keymap-parent map text-mode-map)
3583 (define-key map "\C-c\C-c" 'Info-cease-edit)
3584 map)
3585 "Local keymap used within `e' command of Info.")
3587 ;; Info-edit mode is suitable only for specially formatted data.
3588 (put 'Info-edit-mode 'mode-class 'special)
3590 (defun Info-edit-mode ()
3591 "Major mode for editing the contents of an Info node.
3592 Like text mode with the addition of `Info-cease-edit'
3593 which returns to Info mode for browsing.
3595 (use-local-map Info-edit-map)
3596 (setq major-mode 'Info-edit-mode)
3597 (setq mode-name "Info Edit")
3598 (kill-local-variable 'mode-line-buffer-identification)
3599 (setq buffer-read-only nil)
3600 (force-mode-line-update)
3601 (buffer-enable-undo (current-buffer))
3602 (run-mode-hooks 'Info-edit-mode-hook))
3604 (defun Info-edit ()
3605 "Edit the contents of this Info node.
3606 Allowed only if variable `Info-enable-edit' is non-nil."
3607 (interactive)
3608 (or Info-enable-edit
3609 (error "Editing Info nodes is not enabled"))
3610 (Info-edit-mode)
3611 (message "%s" (substitute-command-keys
3614 (defun Info-cease-edit ()
3615 "Finish editing Info node; switch back to Info proper."
3616 (interactive)
3617 ;; Do this first, so nothing has changed if user C-g's at query.
3618 (and (buffer-modified-p)
3619 (y-or-n-p "Save the file? ")
3620 (save-buffer))
3621 (use-local-map Info-mode-map)
3622 (setq major-mode 'Info-mode)
3623 (setq mode-name "Info")
3624 (Info-set-mode-line)
3625 (setq buffer-read-only t)
3626 (force-mode-line-update)
3627 (and (marker-position Info-tag-table-marker)
3628 (buffer-modified-p)
3629 (message "Tags may have changed. Use Info-tagify if necessary")))
3630 \f
3631 (defvar Info-file-list-for-emacs
3632 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3633 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3634 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3635 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3636 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3637 ("copyright" . "autotype") ("executable" . "autotype")
3638 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3639 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3640 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3641 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3642 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3643 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3644 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3645 ("rfc2045" . "emacs-mime")
3646 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3647 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3648 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3649 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3650 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3651 ("mml" . "emacs-mime"))
3652 "List of Info files that describe Emacs commands.
3653 An element can be a file name, or a list of the form (PREFIX . FILE)
3654 where PREFIX is a name prefix and FILE is the file to look in.
3655 If the element is just a file name, the file name also serves as the prefix.")
3657 (defun Info-find-emacs-command-nodes (command)
3658 "Return a list of locations documenting COMMAND.
3659 The `info-file' property of COMMAND says which Info manual to search.
3660 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3661 defines heuristics for which Info manual to try.
3662 The locations are of the format used in `Info-history', i.e.
3663 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3664 in the first element of the returned list (which is treated specially in
3665 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3666 (let ((where '()) line-number
3670 (info-file "emacs")) ;default
3671 ;; Determine which Info file this command is documented in.
3672 (if (get command 'info-file)
3673 (setq info-file (get command 'info-file))
3674 ;; If it doesn't say explicitly, test its name against
3675 ;; various prefixes that we know.
3676 (let ((file-list Info-file-list-for-emacs))
3677 (while file-list
3678 (let* ((elt (car file-list))
3679 (name (if (consp elt)
3680 (car elt)
3681 elt))
3682 (file (if (consp elt) (cdr elt) elt))
3683 (case-fold-search nil)
3686 (if (string-match regexp (symbol-name command))
3687 (setq info-file file file-list nil))
3688 (setq file-list (cdr file-list))))))
3689 (Info-find-node info-file "Top")
3690 ;; Bind Info-history to nil, to prevent the index nodes from
3691 ;; getting into the node history.
3692 (let ((Info-history nil)
3693 (Info-history-list nil)
3694 node (nodes (Info-index-nodes)))
3695 (Info-goto-node (car nodes))
3696 (while
3697 (progn
3698 (goto-char (point-min))
3699 (while (re-search-forward cmd-desc nil t)
3700 (setq where
3701 (cons (list Info-current-file
3702 (match-string-no-properties 2)
3703 0)
3704 where))
3705 (setq line-number (and (match-beginning 3)
3706 (string-to-number (match-string 3)))))
3707 (and (setq nodes (cdr nodes) node (car nodes))))
3708 (Info-goto-node node)))
3709 (if (and line-number where)
3710 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3711 (cdr where))
3712 where)))
3714 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3715 ;;;###autoload
3716 (defun Info-goto-emacs-command-node (command)
3717 "Go to the Info node in the Emacs manual for command COMMAND.
3718 The command is found by looking up in Emacs manual's indices
3719 or in another manual found via COMMAND's `info-file' property or
3720 the variable `Info-file-list-for-emacs'.
3721 COMMAND must be a symbol or string."
3722 (interactive "CFind documentation for command: ")
3723 ;; If command is given as a string, convert it to a symbol.
3724 (if (stringp command)
3725 (setq command (intern command)))
3726 (or (commandp command)
3727 (signal 'wrong-type-argument (list 'commandp command)))
3728 (let ((where (Info-find-emacs-command-nodes command)))
3729 (if where
3730 (let ((num-matches (length where)))
3731 ;; Get Info running, and pop to it in another window.
3732 (save-window-excursion
3733 (info))
3734 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3735 ;; Bind Info-history to nil, to prevent the last Index node
3736 ;; visited by Info-find-emacs-command-nodes from being
3737 ;; pushed onto the history.
3738 (let ((Info-history nil) (Info-history-list nil)
3739 (line-number (nth 2 (car where))))
3740 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3741 (if (and (integerp line-number) (> line-number 0))
3742 (forward-line (1- line-number))))
3743 (if (> num-matches 1)
3744 (progn
3745 ;; (car where) will be pushed onto Info-history
3746 ;; when/if they go to another node. Put the other
3747 ;; nodes that were found on the history.
3748 (setq Info-history (nconc (cdr where) Info-history))
3749 (message "Found %d other entr%s. Use %s to see %s."
3750 (1- num-matches)
3751 (if (> num-matches 2) "ies" "y")
3753 (if (> num-matches 2) "them" "it")))))
3754 (error "Couldn't find documentation for %s" command))))
3756 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3757 ;;;###autoload
3758 (defun Info-goto-emacs-key-command-node (key)
3759 "Go to the node in the Emacs manual which describes the command bound to KEY.
3760 KEY is a string.
3761 Interactively, if the binding is `execute-extended-command', a command is read.
3762 The command is found by looking up in Emacs manual's indices
3763 or in another manual found via COMMAND's `info-file' property or
3764 the variable `Info-file-list-for-emacs'."
3765 (interactive "kFind documentation for key: ")
3766 (let ((command (key-binding key)))
3767 (cond ((null command)
3768 (message "%s is undefined" (key-description key)))
3769 ((and (interactive-p)
3770 (eq command 'execute-extended-command))
3771 (Info-goto-emacs-command-node
3772 (read-command "Find documentation for command: ")))
3773 (t
3774 (Info-goto-emacs-command-node command)))))
3775 \f
3776 (defvar Info-next-link-keymap
3777 (let ((keymap (make-sparse-keymap)))
3778 (define-key keymap [header-line mouse-1] 'Info-next)
3779 (define-key keymap [header-line mouse-2] 'Info-next)
3780 (define-key keymap [header-line down-mouse-1] 'ignore)
3781 (define-key keymap [mouse-2] 'Info-next)
3782 (define-key keymap [follow-link] 'mouse-face)
3783 keymap)
3784 "Keymap to put on the Next link in the text or the header line.")
3786 (defvar Info-prev-link-keymap
3787 (let ((keymap (make-sparse-keymap)))
3788 (define-key keymap [header-line mouse-1] 'Info-prev)
3789 (define-key keymap [header-line mouse-2] 'Info-prev)
3790 (define-key keymap [header-line down-mouse-1] 'ignore)
3791 (define-key keymap [mouse-2] 'Info-prev)
3792 (define-key keymap [follow-link] 'mouse-face)
3793 keymap)
3794 "Keymap to put on the Prev link in the text or the header line.")
3796 (defvar Info-up-link-keymap
3797 (let ((keymap (make-sparse-keymap)))
3798 (define-key keymap [header-line mouse-1] 'Info-up)
3799 (define-key keymap [header-line mouse-2] 'Info-up)
3800 (define-key keymap [header-line down-mouse-1] 'ignore)
3801 (define-key keymap [mouse-2] 'Info-up)
3802 (define-key keymap [follow-link] 'mouse-face)
3803 keymap)
3804 "Keymap to put on the Up link in the text or the header line.")
3806 (defun Info-insert-breadcrumbs ()
3807 (let ((nodes (Info-toc-nodes Info-current-file))
3808 (node Info-current-node)
3809 (crumbs ())
3810 (depth Info-breadcrumbs-depth))
3812 ;; Get ancestors from the cached parent-children node info
3813 (while (and (not (equal "Top" node)) (> depth 0))
3814 (setq node (nth 1 (assoc node nodes)))
3815 (if node (push node crumbs))
3816 (setq depth (1- depth)))
3818 ;; Add bottom node.
3819 (when Info-use-header-line
3820 ;; Let it disappear if crumbs is nil.
3821 (nconc crumbs (list Info-current-node)))
3822 (when (or Info-use-header-line crumbs)
3823 ;; Add top node (and continuation if needed).
3824 (setq crumbs
3825 (cons "Top" (if (member (pop crumbs) '(nil "Top"))
3826 crumbs (cons nil crumbs))))
3827 ;; Eliminate duplicate.
3828 (forward-line 1)
3829 (dolist (node crumbs)
3830 (let ((text
3831 (if (not (equal node "Top")) node
3832 (format "(%s)Top"
3833 (if (stringp Info-current-file)
3834 (file-name-nondirectory Info-current-file)
3835 ;; Can be `toc', `apropos', or even `history'.
3836 Info-current-file)))))
3837 (insert (if (bolp) "" " > ")
3838 (cond
3839 ((null node) "...")
3840 ((equal node Info-current-node)
3841 ;; No point linking to ourselves.
3842 (propertize text 'font-lock-face 'info-header-node))
3843 (t
3844 (concat "*Note " text "::"))))))
3847 (defun Info-fontify-node ()
3848 "Fontify the node."
3849 (save-excursion
3850 (let* ((inhibit-read-only t)
3851 (case-fold-search t)
3852 paragraph-markers
3853 (not-fontified-p ; the node hasn't already been fontified
3854 (not (let ((where (next-single-property-change (point-min)
3855 'font-lock-face)))
3856 (and where (not (= where (point-max)))))))
3857 (fontify-visited-p ; visited nodes need to be re-fontified
3858 (and Info-fontify-visited-nodes
3859 ;; Don't take time to refontify visited nodes in huge nodes
3860 Info-fontify-maximum-menu-size
3861 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3862 rbeg rend)
3864 ;; Fontify header line
3865 (goto-char (point-min))
3867 (goto-char (match-end 0))
3869 (goto-char (match-end 0))
3870 (let* ((nbeg (match-beginning 2))
3871 (nend (match-end 2))
3872 (tbeg (match-beginning 1))
3873 (tag (match-string 1)))
3874 (if (string-equal (downcase tag) "node")
3875 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3876 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3877 (put-text-property tbeg nend 'mouse-face 'highlight)
3878 (put-text-property tbeg nend
3879 'help-echo
3880 (concat "mouse-2: Go to node "
3881 (buffer-substring nbeg nend)))
3882 ;; Always set up the text property keymap.
3883 ;; It will either be used in the buffer
3884 ;; or copied in the header line.
3885 (put-text-property
3886 tbeg nend 'keymap
3887 (cond
3888 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3889 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3890 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3892 (when (> Info-breadcrumbs-depth 0)
3893 (Info-insert-breadcrumbs))
3895 ;; Treat header line.
3896 (when Info-use-header-line
3897 (goto-char (point-min))
3898 (let* ((header-end (line-end-position))
3899 (header
3900 ;; If we find neither Next: nor Prev: link, show the entire
3901 ;; node header. Otherwise, don't show the File: and Node:
3902 ;; parts, to avoid wasting precious space on information that
3903 ;; is available in the mode line.
3904 (if (re-search-forward
3906 header-end t)
3907 (progn
3908 (goto-char (match-beginning 1))
3909 (buffer-substring (point) header-end))
3911 header-end t)
3912 (concat "No next, prev or up links -- "
3913 (buffer-substring (point) header-end))
3914 (buffer-substring (point) header-end)))))
3915 (put-text-property (point-min) (1+ (point-min))
3916 'header-line
3917 (replace-regexp-in-string
3918 "%"
3919 ;; Preserve text properties on duplicated `%'.
3920 (lambda (s) (concat s s)) header))
3921 ;; Hide the part of the first line
3922 ;; that is in the header, if it is just part.
3923 (cond
3924 ((> Info-breadcrumbs-depth 0)
3925 (put-text-property (point-min) (1+ header-end) 'invisible t))
3926 ((not (bobp))
3927 ;; Hide the punctuation at the end, too.
3929 (put-text-property (point) header-end 'invisible t))))))
3931 ;; Fontify titles
3932 (goto-char (point-min))
3933 (when (and font-lock-mode not-fontified-p)
3935 nil t)
3936 ;; Only consider it as an underlined title if the ASCII
3937 ;; underline has the same size as the text. A typical
3938 ;; counter example is when a continuation "..." is alone
3939 ;; on a line.
3940 (= (string-width (match-string 1))
3941 (string-width (match-string 2))))
3942 (let* ((c (preceding-char))
3943 (face
3944 (cond ((= c ?*) 'info-title-1)
3945 ((= c ?=) 'info-title-2)
3946 ((= c ?-) 'info-title-3)
3947 (t 'info-title-4))))
3948 (put-text-property (match-beginning 1) (match-end 1)
3949 'font-lock-face face))
3950 ;; This is a serious problem for trying to handle multiple
3951 ;; frame types at once. We want this text to be invisible
3952 ;; on frames that can display the font above.
3953 (when (memq (framep (selected-frame)) '(x pc w32 ns))
3954 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3955 '(invisible t front-sticky nil rear-nonsticky t)))))
3957 ;; Fontify cross references
3958 (goto-char (point-min))
3959 (when (or not-fontified-p fontify-visited-p)
3960 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3961 (let ((start (match-beginning 0))
3962 (next (point))
3963 other-tag)
3964 (when not-fontified-p
3965 (when Info-hide-note-references
3966 (when (and (not (eq Info-hide-note-references 'hide))
3967 (> (line-number-at-pos) 4)) ; Skip breadcrumbs
3968 ;; *Note is often used where *note should have been
3969 (goto-char start)
3970 (skip-syntax-backward " ")
3971 (when (memq (char-before) '(?\( ?\[ ?\{))
3972 ;; Check whether the paren is preceded by
3973 ;; an end of sentence
3974 (skip-syntax-backward " ("))
3975 (setq other-tag
3977 "")
3979 "")
3980 ((memq (char-before) '(nil ?\. ?! ??))
3981 "See ")
3982 ((save-match-data
3983 (save-excursion
3985 "See ")
3986 (t "see "))))
3987 (goto-char next)
3988 (add-text-properties
3989 (match-beginning 1)
3990 (or (save-match-data
3992 (let ((start1 (match-beginning 1)))
3994 (+ start1 (match-beginning 0)))))
3995 (match-end 1))
3996 (if other-tag
3997 `(display ,other-tag front-sticky nil rear-nonsticky t)
3998 '(invisible t front-sticky nil rear-nonsticky t))))
3999 (add-text-properties
4000 (match-beginning 2) (match-end 2)
4001 (list
4002 'help-echo (if (or (match-end 5)
4003 (not (equal (match-string 4) "")))
4004 (concat "mouse-2: go to " (or (match-string 5)
4005 (match-string 4)))
4006 "mouse-2: go to this node")
4007 'mouse-face 'highlight)))
4008 (when (or not-fontified-p fontify-visited-p)
4009 (setq rbeg (match-beginning 2)
4010 rend (match-end 2))
4011 (put-text-property
4012 rbeg rend
4013 'font-lock-face
4014 ;; Display visited nodes in a different face
4015 (if (and Info-fontify-visited-nodes
4016 (save-match-data
4017 (let* ((node (replace-regexp-in-string
4019 (replace-regexp-in-string
4021 (or (match-string-no-properties 5)
4022 (and (not (equal (match-string 4) ""))
4023 (match-string-no-properties 4))
4024 (match-string-no-properties 2)))))
4025 (external-link-p
4027 (file (if external-link-p
4028 (file-name-nondirectory
4029 (match-string-no-properties 1 node))
4030 Info-current-file))
4031 (hl Info-history-list)
4032 res)
4033 (if external-link-p
4034 (setq node (if (equal (match-string 2 node) "")
4035 "Top"
4036 (match-string-no-properties 2 node))))
4037 (while hl
4038 (if (and (string-equal node (nth 1 (car hl)))
4039 (equal file
4040 (if (and external-link-p
4041 (stringp (caar hl)))
4042 (file-name-nondirectory
4043 (caar hl))
4044 (caar hl))))
4045 (setq res (car hl) hl nil)
4046 (setq hl (cdr hl))))
4047 res))) 'info-xref-visited 'info-xref))
4048 ;; For multiline ref, unfontify newline and surrounding whitespace
4049 (save-excursion
4050 (goto-char rbeg)
4051 (save-match-data
4053 (remove-text-properties (match-beginning 0)
4054 (match-end 0)
4055 '(font-lock-face t))))))
4056 (when not-fontified-p
4057 (when (memq Info-hide-note-references '(t hide))
4058 (add-text-properties (match-beginning 3) (match-end 3)
4059 '(invisible t front-sticky nil rear-nonsticky t))
4060 ;; Unhide the file name of the external reference in parens
4061 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
4062 (remove-text-properties (match-beginning 6) (match-end 6)
4063 '(invisible t front-sticky nil rear-nonsticky t)))
4064 ;; Unhide newline because hidden newlines cause too long lines
4065 (save-match-data
4066 (let ((beg3 (match-beginning 3))
4067 (end3 (match-end 3)))
4069 (not (save-match-data
4070 (save-excursion
4071 (goto-char (1+ end3))
4072 (looking-at "[.)]*$")))))
4073 (remove-text-properties (+ beg3 (match-beginning 0))
4074 (+ beg3 (match-end 0))
4075 '(invisible t front-sticky nil rear-nonsticky t))))))
4076 (when (and Info-refill-paragraphs Info-hide-note-references)
4077 (push (set-marker (make-marker) start)
4078 paragraph-markers))))))
4080 ;; Refill paragraphs (experimental feature)
4081 (when (and not-fontified-p
4082 Info-refill-paragraphs
4083 paragraph-markers)
4084 (let ((fill-nobreak-invisible t)
4085 (fill-individual-varying-indent nil)
4088 (adaptive-fill-mode nil))
4089 (goto-char (point-max))
4090 (dolist (m paragraph-markers)
4091 (when (< m (point))
4092 (goto-char m)
4093 (beginning-of-line)
4094 (let ((beg (point)))
4095 (when (zerop (forward-paragraph))
4096 (fill-individual-paragraphs beg (point) nil nil)
4097 (goto-char beg))))
4098 (set-marker m nil))))
4100 ;; Fontify menu items
4101 (goto-char (point-min))
4102 (when (and (or not-fontified-p fontify-visited-p)
4104 ;; Don't take time to annotate huge menus
4105 Info-fontify-maximum-menu-size
4106 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
4107 (let ((n 0)
4108 cont)
4109 (while (re-search-forward
4112 nil t)
4113 (when (match-beginning 1)
4114 (when not-fontified-p
4115 (setq n (1+ n))
4116 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
4117 (put-text-property (match-beginning 0)
4118 (1+ (match-beginning 0))
4119 'font-lock-face 'info-menu-star)))
4120 (when not-fontified-p
4121 (add-text-properties
4122 (match-beginning 1) (match-end 1)
4123 (list
4124 'help-echo (if (and (match-end 3)
4125 (not (equal (match-string 3) "")))
4126 (concat "mouse-2: go to " (match-string 3))
4127 "mouse-2: go to this node")
4128 'mouse-face 'highlight)))
4129 (when (or not-fontified-p fontify-visited-p)
4130 (put-text-property
4131 (match-beginning 1) (match-end 1)
4132 'font-lock-face
4133 ;; Display visited menu items in a different face
4134 (if (and Info-fontify-visited-nodes
4135 (save-match-data
4136 (let* ((node (if (equal (match-string 3) "")
4137 (match-string-no-properties 1)
4138 (match-string-no-properties 3)))
4139 (external-link-p
4141 (file (if external-link-p
4142 (file-name-nondirectory
4143 (match-string-no-properties 1 node))
4144 Info-current-file))
4145 (hl Info-history-list)
4146 res)
4147 (if external-link-p
4148 (setq node (if (equal (match-string 2 node) "")
4149 "Top"
4150 (match-string-no-properties 2 node))))
4151 (while hl
4152 (if (and (string-equal node (nth 1 (car hl)))
4153 (equal file
4154 (if (and external-link-p
4155 (stringp (caar hl)))
4156 (file-name-nondirectory
4157 (caar hl))
4158 (caar hl))))
4159 (setq res (car hl) hl nil)
4160 (setq hl (cdr hl))))
4161 res))) 'info-xref-visited 'info-xref)))
4162 (when (and not-fontified-p
4163 (memq Info-hide-note-references '(t hide))
4164 (not (Info-index-node)))
4165 (put-text-property (match-beginning 2) (1- (match-end 6))
4166 'invisible t)
4167 ;; Unhide the file name in parens
4168 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
4169 (remove-text-properties (match-beginning 4) (match-end 4)
4170 '(invisible t)))
4171 ;; We need a stretchable space like :align-to but with
4172 ;; a minimum value.
4173 (put-text-property (1- (match-end 6)) (match-end 6) 'display
4174 (if (>= 22 (- (match-end 1)
4175 (match-beginning 0)))
4176 '(space :align-to 24)
4177 '(space :width 2)))
4178 (setq cont (looking-at "."))
4179 (while (and (= (forward-line 1) 0)
4181 (put-text-property (match-beginning 1) (1- (match-end 1))
4182 'invisible t)
4183 (put-text-property (1- (match-end 1)) (match-end 1)
4184 'display
4185 (if cont
4186 '(space :align-to 26)
4187 '(space :align-to 24)))
4188 (setq cont t)))))))
4190 ;; Fontify menu headers
4191 ;; Add the face `info-menu-header' to any header before a menu entry
4192 (goto-char (point-min))
4194 (put-text-property (match-beginning 0) (match-end 0)
4195 'font-lock-face 'info-menu-header)
4197 (put-text-property (match-beginning 1) (match-end 1)
4198 'font-lock-face 'info-menu-header)))
4200 ;; Hide index line numbers
4201 (goto-char (point-min))
4202 (when (and not-fontified-p (Info-index-node))
4204 (put-text-property (match-beginning 0) (match-end 0)
4205 'invisible t)))
4207 ;; Fontify http and ftp references
4208 (goto-char (point-min))
4209 (when not-fontified-p
4211 nil t)
4212 (add-text-properties (match-beginning 0) (match-end 0)
4213 '(font-lock-face info-xref
4214 mouse-face highlight
4215 help-echo "mouse-2: go to this URL"))))
4217 (set-buffer-modified-p nil))))
4218 \f
4219 ;;; Speedbar support:
4220 ;; These functions permit speedbar to display the "tags" in the
4221 ;; current Info node.
4222 (eval-when-compile (require 'speedbar))
4224 (defvar Info-speedbar-key-map nil
4225 "Keymap used when in the info display mode.")
4227 (defun Info-install-speedbar-variables ()
4228 "Install those variables used by speedbar to enhance Info."
4229 (if Info-speedbar-key-map
4230 nil
4231 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4233 ;; Basic tree features
4234 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4235 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4236 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4237 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4238 )
4240 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4241 Info-speedbar-key-map
4242 Info-speedbar-hierarchy-buttons)))
4244 (defvar Info-speedbar-menu-items
4245 '(["Browse Node" speedbar-edit-line t]
4246 ["Expand Node" speedbar-expand-line
4247 (save-excursion (beginning-of-line)
4249 ["Contract Node" speedbar-contract-line
4250 (save-excursion (beginning-of-line)
4251 (looking-at "[0-9]+: *.-. "))]
4252 )
4253 "Additional menu-items to add to speedbar frame.")
4255 ;; Make sure our special speedbar major mode is loaded
4256 (if (featurep 'speedbar)
4257 (Info-install-speedbar-variables)
4258 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4260 ;;; Info hierarchy display method
4261 ;;;###autoload
4262 (defun Info-speedbar-browser ()
4263 "Initialize speedbar to display an Info node browser.
4264 This will add a speedbar major display mode."
4265 (interactive)
4266 (require 'speedbar)
4267 ;; Make sure that speedbar is active
4268 (speedbar-frame-mode 1)
4269 ;; Now, throw us into Info mode on speedbar.
4270 (speedbar-change-initial-expansion-list "Info")
4271 )
4273 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4274 "Display an Info directory hierarchy in speedbar.
4275 DIRECTORY is the current directory in the attached frame.
4276 DEPTH is the current indentation depth.
4277 NODE is an optional argument that is used to represent the
4278 specific node to expand."
4279 (if (and (not node)
4280 (save-excursion (goto-char (point-min))
4281 (let ((case-fold-search t))
4282 (looking-at "Info Nodes:"))))
4283 ;; Update our "current node" maybe?
4284 nil
4285 ;; We cannot use the generic list code, that depends on all leaves
4286 ;; being known at creation time.
4287 (if (not node)
4289 (let ((completions nil))
4290 (speedbar-select-attached-frame)
4291 (save-window-excursion
4292 (setq completions
4293 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4294 (select-frame (speedbar-current-frame))
4295 (if completions
4296 (speedbar-with-writable
4297 (dolist (completion completions)
4298 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4299 (cdr completion)
4300 (car completion)
4301 'Info-speedbar-goto-node
4302 (cdr completion)
4303 'info-xref depth))
4304 t)
4305 nil))))
4307 (defun Info-speedbar-goto-node (text node indent)
4308 "When user clicks on TEXT, go to an info NODE.
4309 The INDENT level is ignored."
4310 (speedbar-select-attached-frame)
4311 (let* ((buff (or (get-buffer "*info*")
4312 (progn (info) (get-buffer "*info*"))))
4313 (bwin (get-buffer-window buff 0)))
4314 (if bwin
4315 (progn
4316 (select-window bwin)
4317 (raise-frame (window-frame bwin)))
4318 (if speedbar-power-click
4319 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4320 (speedbar-select-attached-frame)
4321 (switch-to-buffer buff)))
4323 (error "Invalid node %s" node)
4324 (Info-find-node (match-string 1 node) (match-string 2 node))
4325 ;; If we do a find-node, and we were in info mode, restore
4326 ;; the old default method. Once we are in info mode, it makes
4327 ;; sense to return to whatever method the user was using before.
4328 (if (string= speedbar-initial-expansion-list-name "Info")
4329 (speedbar-change-initial-expansion-list
4330 speedbar-previously-used-expansion-list-name)))))
4332 (defun Info-speedbar-expand-node (text token indent)
4333 "Expand the node the user clicked on.
4334 TEXT is the text of the button we clicked on, a + or - item.
4335 TOKEN is data related to this node (NAME . FILE).
4336 INDENT is the current indentation depth."
4337 (cond ((string-match "+" text) ;we have to expand this file
4338 (speedbar-change-expand-button-char ?-)
4339 (if (speedbar-with-writable
4340 (save-excursion
4341 (end-of-line) (forward-char 1)
4342 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4343 (speedbar-change-expand-button-char ?-)
4344 (speedbar-change-expand-button-char ??)))
4345 ((string-match "-" text) ;we have to contract this node
4346 (speedbar-change-expand-button-char ?+)
4347 (speedbar-delete-subblock indent))
4348 (t (error "Ooops... not sure what to do")))
4349 (speedbar-center-buffer-smartly))
4351 (defun Info-speedbar-fetch-file-nodes (nodespec)
4352 "Fetch the subnodes from the info NODESPEC.
4353 NODESPEC is a string of the form: (file)node."
4354 ;; Set up a buffer we can use to fake-out Info.
4355 (with-current-buffer (get-buffer-create " *info-browse-tmp*")
4356 (if (not (equal major-mode 'Info-mode))
4357 (Info-mode))
4358 ;; Get the node into this buffer
4360 (error "Invalid node specification %s" nodespec)
4361 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4362 ;; Scan the created buffer
4363 (goto-char (point-min))
4364 (let ((completions nil)
4365 (case-fold-search t)
4367 (match-string 1 nodespec))))
4368 ;; Always skip the first one...
4371 (let ((name (match-string 1)))
4372 (push (cons name
4374 (match-string 1)
4376 (concat (match-string 1) "Top")
4377 (concat "(" thisfile ")"
4379 (match-string 1)
4380 name)))))
4381 completions)))
4382 (nreverse completions))))
4384 ;;; Info mode node listing
4385 ;; This is called by `speedbar-add-localized-speedbar-support'
4386 (defun Info-speedbar-buttons (buffer)
4387 "Create a speedbar display to help navigation in an Info file.
4388 BUFFER is the buffer speedbar is requesting buttons for."
4389 (if (save-excursion (goto-char (point-min))
4390 (let ((case-fold-search t))
4391 (not (looking-at "Info Nodes:"))))
4392 (erase-buffer))
4393 (Info-speedbar-hierarchy-buttons nil 0))
4395 (dolist (mess '("^First node in file$"
4396 "^No `.*' in index$"
4397 "^No cross-reference named"
4398 "^No cross.references in this node$"
4399 "^No current Info node$"
4400 "^No menu in this node$"
4401 "^No more items in menu$"
4402 "^No more nodes$"
4404 "^No previous `i' command$"
4405 "^No previous items in menu$"
4406 "^No previous nodes$"
4407 "^No such item in menu$"
4408 "^No such node or anchor"
4409 "^Node has no"
4410 "^Point neither on reference nor in menu item description$"
4412 search-failed))
4413 (add-to-list 'debug-ignored-errors mess))
4415 ;;;; Desktop support
4417 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4418 "Auxiliary information to be saved in desktop file."
4419 (unless (member Info-current-file '(apropos history toc nil))
4420 (list Info-current-file Info-current-node)))
4422 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4423 desktop-buffer-name
4424 desktop-buffer-misc)
4425 "Restore an Info buffer specified in a desktop file."
4426 (let ((first (nth 0 desktop-buffer-misc))
4427 (second (nth 1 desktop-buffer-misc)))
4428 (when (and first second)
4429 (when desktop-buffer-name
4430 (set-buffer (get-buffer-create desktop-buffer-name))
4431 (Info-mode))
4432 (Info-find-node first second)
4433 (current-buffer))))
4435 (add-to-list 'desktop-buffer-mode-handlers
4436 '(Info-mode . Info-restore-desktop-buffer))
4438 ;;;; Bookmark support
4439 (declare-function bookmark-make-record-default "bookmark" (&optional pos-only))
4440 (declare-function bookmark-prop-get "bookmark" (bookmark prop))
4441 (declare-function bookmark-default-handler "bookmark" (bmk))
4442 (declare-function bookmark-get-bookmark-record "bookmark" (bmk))
4444 (defun Info-bookmark-make-record ()
4445 `(,Info-current-node
4446 ,@(bookmark-make-record-default 'point-only)
4447 (filename . ,Info-current-file)
4448 (info-node . ,Info-current-node)
4449 (handler . Info-bookmark-jump)))
4451 ;;;###autoload
4452 (defun Info-bookmark-jump (bmk)
4453 ;; This implements the `handler' function interface for record type returned
4454 ;; by `Info-bookmark-make-record', which see.
4455 (let* ((file (bookmark-prop-get bmk 'filename))
4456 (info-node (bookmark-prop-get bmk 'info-node))
4457 (buf (save-window-excursion ;FIXME: doesn't work with frames!
4458 (Info-find-node file info-node) (current-buffer))))
4459 ;; Use bookmark-default-handler to move to the appropriate location
4460 ;; within the node.
4461 (bookmark-default-handler
4462 (list* "" `(buffer . ,buf) (bookmark-get-bookmark-record bmk)))))
4464 (provide 'info)
4466 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4467 ;;; info.el ends here