| blob | fada0045782e0ab16f7f02b9878b97d6c2f80f9c |
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 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 "*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.
550 See a list of available Info commands in `Info-mode'."
560 ;; If argument already contains parentheses, don't add another set
561 ;; since the argument will then be parsed improperly. This also
562 ;; has the added benefit of allowing node names to be included
563 ;; following the parenthesized filename.
566 file-or-node
570 ;; If we just created the Info buffer, go to the directory.
573 ;;;###autoload
575 "Display the Emacs manual in Info mode."
579 ;;;###autoload
581 "Run Emacs as a standalone Info reader.
582 Usage: emacs -f info-standalone [filename]
596 \f
597 ;; See if the accessible portion of the buffer begins with a node
598 ;; delimiter, and the node header line which follows matches REGEXP.
599 ;; Typically, this test will be followed by a loop that examines the
600 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
601 ;; to have the overhead of this special test inside the loop.
603 ;; This function changes match-data, but supposedly the caller might
604 ;; want to use the results of re-search-backward.
606 ;; The return value is the value of point at the beginning of matching
607 ;; REGEXP, if the function succeeds, nil otherwise.
619 Optional second argument NOERROR, if t, means if file is not found
620 just return nil (no error)."
621 ;; Convert filename to lower case if not found as specified.
622 ;; Expand it.
631 ;; If specified name starts with `./'
632 ;; then just try current directory.
635 ;; No point in searching for an
636 ;; absolute file name
640 Info-additional-directory-list)
641 Info-directory-list)))))
642 ;; Search the directory list for file FILENAME.
647 ;; Try several variants of specified name.
651 t)))
662 lfn
674 filename)
678 "Go to an Info node specified as separate FILENAME and NODENAME.
679 NO-GOING-BACK is non-nil if recovering from an error in this function;
680 it says do not attempt further (recursive) error recovery."
683 ;; Go into Info buffer.
685 ;; Record the node we are leaving, if we were in one.
687 Info-current-file
689 Info-history))
692 ;;;###autoload
694 "Use Info mode to browse the current Info buffer.
695 With a prefix arg, this queries for the node name to visit first;
696 otherwise, that defaults to `Top'."
706 ;; If called on a non-file buffer, make a fake file name.
710 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
711 ;; but at least it keeps this routine (which is for makeinfo-buffer and
712 ;; Info-revert-buffer-function) out of the way of normal operations.
713 ;;
715 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
716 When *info* is already displaying FILENAME and NODENAME, the window position
717 is preserved, if possible."
733 ;; note goto-line is no good, we want to measure from point-min
740 ;; only add to the history when coming from a different file+node
750 "Find a node in a tag table.
751 MARKER specifies the buffer and position to start searching at.
752 REGEXP is a regular expression matching nodes or references. Its first
753 group should match `Node:' or `Ref:'.
754 CASE-FOLD t means search for a case-insensitive match.
755 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
756 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
757 where the match was found, and MODE is `major-mode' of the buffer in
758 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.
896 ))
897 ;; Use string-equal, not equal, to ignore text props.
901 ;; Possibilities:
902 ;;
903 ;; 1. Anchor found in tag table
904 ;; 2. Anchor *not* in tag table
905 ;;
906 ;; 3. Node found in tag table
907 ;; 4. Node *not* found in tag table, but found in file
908 ;; 5. Node *not* in tag table, and *not* in file
909 ;;
910 ;; *Or* the same, but in an indirect subfile.
912 ;; Search file for a suitable node.
922 ;; First, search a tag table, if any
928 ;; FOUND is (ANCHOR POS MODE).
931 ;; If this is an indirect file, determine which
932 ;; file really holds this node and read it in.
934 ;; Note that the current buffer must be the
935 ;; *info* buffer on entry to
936 ;; Info-read-subfile. Thus the hackery above.
939 ;; Handle anchor
944 ;; Else we may have a node, which we search for:
948 ;; Now search from our advised position (or from beg of
949 ;; buffer) to find the actual node. First, check
950 ;; whether the node is right where we are, in case the
951 ;; buffer begins with a node.
964 ;; No such anchor in tag table or node in tag table or file
972 ;; Add anchors to the history too
983 ;; If we did not finish finding the specified node,
984 ;; go back to the previous one.
991 ;; Cache the contents of the (virtual) dir file, once we have merged
992 ;; it for the first time, so we can save time subsequently.
995 ;; Cache for the directory we decided to use for the default-directory
996 ;; of the merged dir text.
999 ;; Record the file attributes of all the files from which we
1000 ;; constructed Info-dir-contents.
1005 ;; Construct the Info directory node by merging the files named `dir'
1006 ;; from various directories. Set the *info* buffer's
1007 ;; default-directory to the first directory we actually get any text
1008 ;; from.
1011 ;; Verify that none of the files we used has changed
1012 ;; since we used it.
1016 ;; Handle symlinks
1019 ;; Don't compare the access time.
1023 Info-dir-file-attributes))))
1029 Info-additional-directory-list)
1030 Info-directory-list))
1032 ;; Bind this in case the user sets it to nil.
1034 ;; This is set non-nil if we find a problem in some input files.
1035 problems
1036 buffers buffer others nodes dirs-done)
1038 ;; Search the directory list for the directory file.
1043 ;; Try several variants of specified name.
1044 ;; Try upcasing, appending `.info', or both.
1059 dirs-done)))
1068 file)
1080 ;; Distinguish the dir file that comes with Emacs from all the
1081 ;; others. Yes, that is really what this is supposed to do.
1082 ;; The definition of `Info-directory-list' puts it first on that
1083 ;; list and so last in `buffers' at this point.
1087 ;; Insert the entire original dir file as a start; note that we've
1088 ;; already saved its default directory to use as the default
1089 ;; directory for the whole concatenation.
1092 ;; Look at each of the other buffers one by one.
1095 ;; In each, find all the menus.
1098 ;; Find each menu, and add an elt to NODES for it.
1102 nodename end)
1114 ;; Add to the main menu a menu item for each other node.
1126 end t)
1130 ;; Now take each node of each of the other buffers
1131 ;; and merge it into the main buffer.
1136 ;; Find the like-named node in the main buffer.
1140 nil t)
1145 ;; If none exists, add one.
1148 ;; Merge the text from the other buffer's menu
1149 ;; into the menu in the like-named node in the main buffer.
1152 ;; Kill all the buffers we just made, including the special one excised.
1172 ;; Remove duplicate headings in the same menu.
1175 ;; Look for the next heading to unify.
1180 ;; Check whether this heading should be streamlined.
1190 ;; Look for other headings of the same category and merge them.
1196 ;; Delete redundant heading.
1198 ;; Push the entries onto `text'.
1205 entries)
1207 ;; Insert the entries just found.
1215 ;; Now remove duplicate entries under the same heading.
1222 ;; Fold case straight away; `member-ignore-case' here wasteful.
1230 ;; Note that on entry to this function the current-buffer must be the
1231 ;; *info* buffer; not the info tags buffer.
1233 ;; NODEPOS is either a position (in the Info file as a whole,
1234 ;; not relative to a subfile) or the name of a subfile.
1236 lastfilename)
1247 thisfilepos thisfilename)
1251 ;; read in version 19 stops at the end of number.
1252 ;; Advance to the next line.
1261 ;; Assume previous buffer is in Info-mode.
1262 ;; (set-buffer (get-buffer "*info*"))
1271 ;; Widen in case we are in the same subfile as before.
1281 "Unescape double quotes and backslashes in VALUE."
1287 unquote))
1289 ;; As of Texinfo 4.6, makeinfo writes constructs like
1290 ;; \0\h[image param=value ...\h\0]
1291 ;; into the Info file for handling images.
1294 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1295 whitespace or double quotes, it must be quoted in double quotes and
1300 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1301 parameter-string start)
1307 parameter-alist))
1308 parameter-alist))
1311 "Display images in current node."
1318 nil t)
1332 ;; text-only display, show alternative text if provided, or
1333 ;; otherwise a clue that there's meant to be a picture
1342 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1343 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1344 ;; including one optional trailing newline.
1346 "Hide unrecognized cookies in current node."
1353 nil t)
1360 "Select the Info node that point is in."
1361 ;; Bind this in case the user sets it to nil.
1364 ;; Find beginning of node.
1370 ;; Get nodename spelled as it is in the node.
1378 ;; Find the end of it, and narrow.
1381 ;; Narrow to the node contents
1393 ;; Add a new unique history item to full history list
1408 map)
1416 " ("
1421 ") "
1426 'help-echo
1427 "mouse-1: scroll forward, mouse-3: scroll back"
1431 \f
1432 ;; Go to an Info node specified with a filename-and-nodename string
1433 ;; of the sort that is found in pointers in nodes.
1435 ;; Don't autoload this function: the correct entry point for other packages
1436 ;; to use is `info'. --Stef
1437 ;; ;;;###autoload
1439 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1440 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1441 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1442 its sub-files).
1443 Completion is available, but only for node names in the current Info file.
1444 If FORK is non-nil (interactively with a prefix arg), show the node in
1445 a new Info buffer.
1446 If FORK is a string, it is the name to use for the new buffer."
1454 nodename)
1456 ""
1470 "Virtual completion table for file names input in Info node names.
1471 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1485 ;; If the file name has no suffix or a standard suffix,
1486 ;; include it.
1489 ;; But exclude subfiles of split Info files.
1491 ;; And exclude backup files.
1494 ;; If the file name ends in a standard suffix,
1495 ;; add the unsuffixed name as a completion option.
1501 ;; This function is used as the "completion table" while reading a node name.
1502 ;; It does completion using the alist in Info-read-node-completion-table
1503 ;; unless STRING starts with an open-paren.
1506 ;; First complete embedded file names.
1509 "("
1512 Info-directory-list
1515 predicate
1516 code))
1518 ;; If a file name was given, then any node is fair game.
1524 ;; Otherwise use Info-read-node-completion-table.
1526 code Info-read-node-completion-table string predicate))))
1528 ;; Arrange to highlight the proper letters in the completion list buffer.
1537 nodename)))
1542 ;; Bind this in case the user sets it to nil.
1557 compl))))
1560 ;; If the buffer begins with a node header, process that first.
1563 ;; Now for the rest of the nodes.
1571 compl))))))))
1574 \f
1576 "If this node has been visited, restore the point value when we left."
1579 ;; Use string-equal, not equal, to ignore text props.
1585 \f
1593 "Search for REGEXP, starting from point, and select node it's found in.
1594 If DIRECTION is `backward', search in the reverse direction."
1622 ;; Hide Info file header for backward search
1633 Info-search-whitespace-regexp)))
1648 ;; If no subfiles, give error now.
1653 Info-search-whitespace-regexp)))
1664 ;; Try other subfiles.
1674 ;; Find the subfile we just searched.
1676 ;; Skip that one.
1679 ;; Make a list of all following subfiles.
1680 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1689 list))
1693 ;; Put in forward order
1699 ;; Hide Info file header for backward search
1713 Info-search-whitespace-regexp)))
1736 ;; Search landed in the same node
1742 ;; Use string-equal, not equal, to ignore text props.
1748 Info-history))))))
1751 "Search for a regexp case-sensitively."
1757 "Search for next regexp from a previous `Info-search' command."
1765 "Search for REGEXP in the reverse direction."
1784 nil t)
1786 bound noerror count
1789 bound noerror count
1818 "Skip invisible text, node header line and Tag Table node."
1828 ;; Skip node header line
1832 ;; Skip Tag Table node
1838 \f
1840 "Extract the value of the node-pointer named NAME.
1841 If there is none, use ERRORNAME in the error message;
1842 if ERRORNAME is nil, just return nil."
1843 ;; Bind this in case the user sets it to nil.
1857 "Return a regexp matching a node name.
1858 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1859 saying which chars may appear in the node name.
1860 Submatch 1 is the complete node name.
1861 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1862 Submatch 3 is the local part of the node name.
1863 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1870 ;;; For compatibility; other files have used this name.
1876 "Go to the next node of this node."
1878 ;; In case another window is currently selected
1884 "Go to the previous node of this node."
1886 ;; In case another window is currently selected
1892 "Go to the superior node of this node.
1893 If SAME-FILE is non-nil, do not move to a different Info file."
1895 ;; In case another window is currently selected
1914 nil t))
1920 "Go back in the history to the last node visited."
1926 Info-history-forward))
1927 filename nodename opoint)
1940 "Go forward in the history of visited nodes."
1945 filename nodename opoint)
1953 ;;;###autoload
1955 "Go to the Info directory node."
1958 \f
1960 "Go to a node with a menu of visited nodes."
1964 p)
1989 "Go to a node with table of contents of the current Info file.
1990 Table of contents is created from the tree structure of menus."
1995 p)
2025 "Insert table of contents with references to nodes."
2037 "Build table of contents from menus of Info FILE and its subfiles."
2042 default-directory))
2045 nodes subfiles)
2047 ;; (or main-file (message "Searching subfile %s..." (car subfiles)))
2058 bound t)
2061 menu-items)
2071 bound))
2074 ;; Menu item line
2084 ;; Other non-empty strings in the Top node are section names
2093 nodes))
2102 subfiles)))))
2104 main-file nil))
2110 "Alist of cached parent-children node information in visited Info files.
2111 Each element is (FILE (NODE-NAME PARENT SECTION CHILDREN) ...)
2112 where PARENT is the parent node extracted from the Up pointer,
2113 SECTION is the section name in the Top node where this node is placed,
2117 "Return a node list of Info FILE with parent-children information.
2118 This information is cached in the variable `Info-toc-nodes' with the help
2119 of the function `Info-build-toc'."
2122 ;; Skip virtual Info files
2126 ;; Scan the entire manual and cache the result in Info-toc-nodes
2129 nodes)
2130 ;; If there is an error, still add nil to the cache
2134 \f
2136 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2137 FOOTNOTENAME may be an abbreviation of the reference name.
2138 If FORK is non-nil (interactively with a prefix arg), show the node in
2139 a new Info buffer. If FORK is a string, it is the name to use for the
2140 new buffer."
2146 ;; Store end and beginning of line.
2155 ;; See if this one should be the default.
2160 ;; See if this one should be the alternate default.
2170 ;; Record as a completion and perhaps as default.
2173 ;; Don't add this string if it's a duplicate.
2176 ;; If no good default was found, try an alternate.
2179 ;; If only one cross-reference found, then make it default.
2185 "Follow reference named (default "
2188 completions nil t)))
2202 ;; Move point to the beginning of reference if point is on reference
2212 ;; Go to the reference closest to point
2220 next-ref prev-ref))
2231 ;; We allow newline because this is also used in Info-follow-reference,
2232 ;; where the xref name might be wrapped over two lines.
2233 "Regexp that matches a menu entry name upto but not including the colon.
2234 Because of ambiguities, this should be concatenated with something like
2255 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2256 ;;; (setq Info-point-loc
2257 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2258 )
2262 ;; If the node name is the menu entry name (using `entry::').
2266 ;; No one calls this.
2267 ;;(defun Info-menu-item-sequence (list)
2268 ;; (while list
2269 ;; (Info-menu (car list))
2270 ;; (setq list (cdr list))))
2282 ;; This uses two dynamically bound variables:
2283 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2284 ;; is the menu of items we're trying to complete.
2285 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2286 ;; also look for menu items in subsequent nodes as long as those
2287 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2288 ;; not used.
2289 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2290 ;; also look for menu items in these nodes. This feature is currently
2291 ;; only used for completion in Info-index.
2293 ;; Note that `Info-complete-menu-buffer' could be current already,
2294 ;; so we want to save point.
2300 nextnode)
2309 completions
2311 ;; Check the cache.
2319 ;; We can reuse the previous list.
2321 ;; The cache can't be used.
2326 completions))
2327 ;; Check subsequent nodes if applicable.
2335 ;; Go back to the start node (for the next completion).
2338 ;; Update the cache.
2341 Info-complete-next-re string completions
2342 Info-complete-nodes)))
2349 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2350 The menu item should one of those listed in the current node's menu.
2351 Completion is allowed, and the default menu item is the one point is on.
2352 If FORK is non-nil (interactively with a prefix arg), show the node in
2353 a new Info buffer. If FORK is a string, it is the name to use for the
2354 new buffer."
2357 ;; If point is within a menu item, use that item as the default
2360 beg
2373 Info-menu-entry-name-re
2382 default)
2385 ;; we rely on the fact that completing-read accepts an input
2386 ;; of "" even when the require-match argument is true and ""
2387 ;; is not a valid possibility
2391 ;; ask again
2394 ;; there is a problem here in that if several menu items have the same
2395 ;; name you can only go to the node of the first with this command.
2413 ;; If COUNT is nil, use the last item in the menu.
2425 nil))
2429 "Go to the node of the Nth menu item.
2430 N is the digit argument used to invoke this command."
2437 "Go to the Top node of this file."
2442 "Go to the final node in this file."
2447 ;; Go to the last node in the menu of Top.
2449 ;; If the last node in the menu is not last in pointer structure,
2450 ;; move forward until we can't go any farther.
2452 ;; Then keep moving down to last subnode, unless we reach an index.
2458 "Go forward one node, considering all nodes as forming one sequence."
2463 ;; three possibilities, in order of priority:
2464 ;; 1. next node is in a menu in this node (but not in an index)
2465 ;; 2. next node is next at same level
2466 ;; 3. next node is up and next
2471 t)
2474 t)
2476 ;; Use string-equal, not equal, to ignore text props.
2489 "Go backward one node, considering all nodes as forming one sequence."
2497 ;; Use string-equal, not equal,
2498 ;; to ignore text properties.
2503 ;; If we move back at the same level,
2504 ;; go down to find the last subnode*.
2514 "Exit Info by selecting some other buffer."
2521 "Go to the node of the next menu item."
2523 ;; Bind this in case the user sets it to nil.
2535 "Go to the node of the previous menu item."
2539 ;; Bind this in case the user sets it to nil.
2554 "Go to the next subnode or the next node, or go up a level."
2559 ;; Since we have already gone thru all the items in this menu,
2560 ;; go up to the end of this node.
2562 ;; Since logically we are done with the node with that menu,
2563 ;; move on from it. But don't add intermediate nodes
2564 ;; to the history on recursive calls.
2571 "Go to the last node, popping up a level if there is none."
2575 ;; If we go down a menu item, go to the end of the node
2576 ;; so we can scroll back through it.
2578 ;; Keep going down, as long as there are nested menu nodes.
2581 ;; If we go down a menu item, go to the end of the node
2582 ;; so we can scroll back through it.
2592 ;; If we go down a menu item, go to the end of the node
2593 ;; so we can scroll back through it.
2604 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2605 Once you scroll far enough in a node that its menu appears on the screen
2606 but after point, the next scroll moves into its first subnode, unless
2607 `Info-scroll-prefer-subnodes' is nil.
2609 When you scroll past the end of a node, that goes to the next node if
2610 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2611 if this node has no successor, it moves to the parent node's successor,
2612 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2613 the menu of a node, it moves to subnode indicated by the following menu
2614 item. (That case won't normally result from this command, but can happen
2615 in other ways.)"
2637 "Scroll one screenful forward in Info, using the mouse.
2638 See `Info-scroll-up'."
2646 "Scroll one screenful back in Info, considering all nodes as one sequence.
2647 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2648 is non-nil, this goes to its last subnode. When you scroll past the
2649 beginning of a node, that goes to the previous node or back up to the
2650 parent node."
2664 current-point
2665 t)))))
2672 "Scroll one screenful backward in Info, using the mouse.
2673 See `Info-scroll-down'."
2681 "Move cursor to the next cross-reference or menu item in the node."
2703 "Move cursor to the previous cross-reference or menu item in the node."
2722 \f
2724 "Alist of cached index node names of visited Info files.
2728 "Return a list of names of all index nodes in Info FILE.
2729 If FILE is omitted, it defaults to the current Info file.
2730 First look in a list of cached index node names. Then scan Info
2731 file and its subfiles for nodes with the index cookie. Then try
2732 to find index nodes starting from the first node in the top level
2737 ;; Skip virtual Info files
2742 ;; Find nodes with index cookie
2746 default-directory))
2747 Info-history Info-history-list Info-fontify-maximum-menu-size
2767 subfiles)))))
2769 main-file nil))
2775 nodes)
2776 ;; Else find nodes with the word "Index" in the node name
2778 Info-history Info-history-list Info-fontify-maximum-menu-size
2779 nodes node)
2797 nodes))
2798 ;; If file has no index nodes, still add it to the cache
2803 "Return non-nil value if NODE is an index node.
2804 If NODE is nil, check the current Info node.
2805 If FILE is nil, check the current Info file."
2809 ;; Don't search all index nodes if request is only for the current node
2810 ;; and file is not in the cache of index nodes
2824 "Go to the first index node."
2829 ;;;###autoload
2831 "Look up a string TOPIC in the index for this manual and go to that entry.
2832 If there are no exact matches to the specified topic, this chooses
2833 the first match which is a case-insensitive substring of a topic.
2835 Give an empty topic name to go to the Index node itself."
2851 ;; Strip leading colon in topic; index format does not allow them.
2857 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2866 ;; We bind Info-history to nil for internal node-switches so
2867 ;; that we don't put junk in the history. In the first
2868 ;; Info-goto-index call, above, we do update the history
2869 ;; because that is what the user's previous node choice into it.
2871 found)
2878 Info-current-node
2881 matches))
2888 ;; Here it is a feature that assoc is case-sensitive.
2921 'Info-index-next overriding-local-map
2922 t)))
2926 "Move point to the place within the current node where NAME is defined."
2931 ;; Find a function definition with a return type.
2939 nil t))
2941 ;; Try again without the " <1>" makeinfo can append
2947 ;;;###autoload
2949 "Grovel indices of all known Info files on your system for STRING.
2950 Build a menu of the possible matches."
2953 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2959 manuals matches node nodes)
2962 ;; current-node and current-file are nil when they invoke info-apropos
2963 ;; as the first Info command, i.e. info-apropos loads info.el. In that
2964 ;; case, we use (DIR)Top instead, to avoid signalling an error after
2965 ;; the search is complete.
2973 ;; add-to-list makes sure we don't have duplicates in `manuals',
2974 ;; so that the following dolist loop runs faster.
2991 matches)))
3000 Info-history-list ohist-list)
3021 "Make command be undefined in Info."
3026 "Enter the Info tutorial."
3031 "Help-Small-Screen"
3035 "Display a brief summary of all Info commands."
3050 flag))
3053 \f
3055 "Return the token around POS.
3056 POS must be somewhere inside the token
3057 START is a regular expression which will match the
3058 beginning of the tokens delimited string
3059 ALL is a regular expression with a single
3060 parenthesized subpattern which is the token to be
3061 returned. E.g. '{\(.*\)}' would return any string
3062 enclosed in braces around POS.
3063 ERRORSTRING optional fourth argument, controls action on no match
3064 nil: return nil
3065 t: beep
3066 a string: signal an error, using that string."
3070 ;; First look for a match for START that goes across POS.
3074 ;; If we did not find one, search back for START
3075 ;; (this finds only matches that end at or before POS).
3088 nil)
3091 nil)
3097 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3098 At end of the node's text, moves to the next node, or up if none."
3106 "Follow a node reference near point.
3107 If point is on a reference, follow that reference. Otherwise,
3108 if point is in a menu item description, follow that menu item.
3110 If FORK is non-nil (interactively with a prefix arg), show the node in
3111 a new Info buffer.
3112 If FORK is a string, it is the name to use for the new buffer."
3124 t)))
3127 ;; Common subroutine.
3129 "Follow a node reference near point. Return non-nil if successful.
3130 If FORK is non-nil, it i spassed to `Info-goto-node'."
3139 ;; menu item: node name
3142 ;; menu item: node name or index entry
3156 node))
3157 \f
3168 (define-key map "1" 'Info-nth-menu-item)
3169 (define-key map "2" 'Info-nth-menu-item)
3170 (define-key map "3" 'Info-nth-menu-item)
3171 (define-key map "4" 'Info-nth-menu-item)
3172 (define-key map "5" 'Info-nth-menu-item)
3173 (define-key map "6" 'Info-nth-menu-item)
3174 (define-key map "7" 'Info-nth-menu-item)
3175 (define-key map "8" 'Info-nth-menu-item)
3176 (define-key map "9" 'Info-nth-menu-item)
3177 (define-key map "0" 'undefined)
3178 (define-key map "?" 'Info-summary)
3179 (define-key map "]" 'Info-forward-node)
3180 (define-key map "[" 'Info-backward-node)
3181 (define-key map "<" 'Info-top-node)
3182 (define-key map ">" 'Info-final-node)
3183 (define-key map "b" 'beginning-of-buffer)
3184 (define-key map "d" 'Info-directory)
3185 (define-key map "e" 'Info-edit)
3186 (define-key map "f" 'Info-follow-reference)
3187 (define-key map "g" 'Info-goto-node)
3188 (define-key map "h" 'Info-help)
3189 (define-key map "i" 'Info-index)
3190 (define-key map "l" 'Info-history-back)
3191 (define-key map "L" 'Info-history)
3192 (define-key map "m" 'Info-menu)
3193 (define-key map "n" 'Info-next)
3194 (define-key map "p" 'Info-prev)
3195 (define-key map "q" 'Info-exit)
3196 (define-key map "r" 'Info-history-forward)
3197 (define-key map "s" 'Info-search)
3198 (define-key map "S" 'Info-search-case-sensitively)
3199 ;; For consistency with Rmail.
3200 (define-key map "\M-s" 'Info-search)
3201 (define-key map "\M-n" 'clone-buffer)
3202 (define-key map "t" 'Info-top-node)
3203 (define-key map "T" 'Info-toc)
3204 (define-key map "u" 'Info-up)
3205 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3206 (define-key map "w" 'Info-copy-current-node-name)
3207 (define-key map "c" 'Info-copy-current-node-name)
3208 ;; `^' for consistency with `dired-up-directory'.
3209 (define-key map "^" 'Info-up)
3210 (define-key map "," 'Info-index-next)
3212 (define-key map [mouse-2] 'Info-mouse-follow-nearest-node)
3213 (define-key map [follow-link] 'mouse-face)
3214 map)
3215 "Keymap containing Info commands.")
3218 (defun Info-check-pointer (item)
3219 "Non-nil if ITEM is present in this node."
3220 (condition-case nil
3221 (Info-extract-pointer item)
3222 (error nil)))
3224 (easy-menu-define
3225 Info-mode-menu Info-mode-map
3226 "Menu for Info files."
3227 '("Info"
3228 ["Up" Info-up :active (Info-check-pointer "up")
3229 :help "Go up in the Info tree"]
3230 ["Next" Info-next :active (Info-check-pointer "next")
3231 :help "Go to the next node"]
3232 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3233 :help "Go to the previous node"]
3234 ["Backward" Info-backward-node
3235 :help "Go backward one node, considering all as a sequence"]
3236 ["Forward" Info-forward-node
3237 :help "Go forward one node, considering all as a sequence"]
3238 ["Beginning" beginning-of-buffer
3239 :help "Go to beginning of this node"]
3240 ["Top" Info-top-node
3241 :help "Go to top node of file"]
3242 ["Final Node" Info-final-node
3243 :help "Go to final node in this file"]
3244 ("Menu Item" ["You should never see this" report-emacs-bug t])
3245 ("Reference" ["You should never see this" report-emacs-bug t])
3246 ["Search..." Info-search
3247 :help "Search for regular expression in this Info file"]
3248 ["Search Next" Info-search-next
3249 :help "Search for another occurrence of regular expression"]
3250 ["Go to Node..." Info-goto-node
3251 :help "Go to a named node"]
3252 ["Back in history" Info-history-back :active Info-history
3253 :help "Go back in history to the last node you were at"]
3254 ["Forward in history" Info-history-forward :active Info-history-forward
3255 :help "Go forward in history"]
3256 ["History" Info-history :active Info-history-list
3257 :help "Go to menu of visited nodes"]
3258 ["Table of Contents" Info-toc
3259 :help "Go to table of contents"]
3260 ("Index"
3261 ["Lookup a String..." Info-index
3262 :help "Look for a string in the index items"]
3263 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3264 :help "Look for another occurrence of previous item"]
3265 ["Lookup a string in all indices..." info-apropos
3266 :help "Look for a string in the indices of all manuals"])
3267 ["Copy Node Name" Info-copy-current-node-name
3268 :help "Copy the name of the current node into the kill ring"]
3269 ["Clone Info buffer" clone-buffer
3270 :help "Create a twin copy of the current Info buffer."]
3271 ["Exit" Info-exit :help "Stop reading Info"]))
3274 (defvar info-tool-bar-map
3275 (if (display-graphic-p)
3276 (let ((map (make-sparse-keymap)))
3277 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map
3278 :rtl "right-arrow")
3279 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map
3280 :rtl "left-arrow")
3281 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map
3282 :rtl "next-node")
3283 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map
3284 :rtl "prev-node")
3285 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3286 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3287 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3288 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3289 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3290 (tool-bar-local-item-from-menu 'Info-exit "exit" map Info-mode-map)
3291 map)))
3293 (defvar Info-menu-last-node nil)
3294 ;; Last node the menu was created for.
3295 ;; Value is a list, (FILE-NAME NODE-NAME).
3297 (defun Info-menu-update ()
3298 "Update the Info menu for the current node."
3299 (condition-case nil
3300 (if (or (not (eq major-mode 'Info-mode))
3301 (equal (list Info-current-file Info-current-node)
3302 Info-menu-last-node))
3303 ()
3304 ;; Update menu menu.
3305 (let* ((Info-complete-menu-buffer (current-buffer))
3306 (items (nreverse (condition-case nil
3307 (Info-complete-menu-item "" nil t)
3308 (error nil))))
3309 entries current
3310 (number 0))
3311 (while (and items (< number 9))
3312 (setq current (car items)
3313 items (cdr items)
3314 number (1+ number))
3315 (setq entries (cons `[,current
3316 (Info-menu ,current)
3317 :keys ,(format "%d" number)]
3318 entries)))
3319 (if items
3320 (setq entries (cons ["Other..." Info-menu t] entries)))
3321 (or entries
3322 (setq entries (list ["No menu" nil nil] nil :active)))
3323 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3324 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3325 (let ((items nil)
3326 str i entries current
3327 (number 0)
3328 (case-fold-search t))
3329 (save-excursion
3330 (goto-char (point-min))
3332 (setq str (match-string 1))
3333 (setq i 0)
3335 (setq str (concat (substring str 0 i) " "
3336 (substring str (match-end 0))))
3337 (setq i (1+ i)))
3338 (setq items
3339 (cons str items))))
3340 (while (and items (< number 9))
3341 (setq current (car items)
3342 items (cdr items)
3343 number (1+ number))
3344 (setq entries (cons `[,current
3345 (Info-follow-reference ,current)
3346 t]
3347 entries)))
3348 (if items
3349 (setq entries (cons ["Other..." Info-follow-reference t]
3350 entries)))
3351 (or entries
3352 (setq entries (list ["No references" nil nil] nil :active)))
3353 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3354 ;; Update last seen node.
3355 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3356 ;; Try to avoid entering infinite beep mode in case of errors.
3357 (error (ding))))
3359 \f
3360 (defun Info-copy-current-node-name (&optional arg)
3361 "Put the name of the current Info node into the kill ring.
3362 The name of the Info file is prepended to the node name in parentheses.
3363 With a zero prefix arg, put the name inside a function call to `info'."
3364 (interactive "P")
3365 (unless Info-current-node
3366 (error "No current Info node"))
3367 (let ((node (if (stringp Info-current-file)
3368 (concat "(" (file-name-nondirectory Info-current-file) ") "
3369 Info-current-node))))
3370 (if (zerop (prefix-numeric-value arg))
3372 (unless (stringp Info-current-file)
3373 (setq node (format "(Info-find-node '%S '%S)"
3374 Info-current-file Info-current-node)))
3375 (kill-new node)
3376 (message "%s" node)))
3378 \f
3379 ;; Info mode is suitable only for specially formatted data.
3380 (put 'Info-mode 'mode-class 'special)
3381 (put 'Info-mode 'no-clone-indirect t)
3383 (defvar tool-bar-map)
3384 (defvar bookmark-make-record-function)
3386 ;; Autoload cookie needed by desktop.el
3387 ;;;###autoload
3388 (defun Info-mode ()
3389 "Info mode provides commands for browsing through the Info documentation tree.
3391 one topic and contains references to other nodes which discuss related
3392 topics. Info has commands to follow the references and show you other nodes.
3398 Selecting other nodes:
3400 Follow a node reference you click on.
3401 This works with menu items, cross references, and
3403 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3408 Picking a menu item causes another node to be selected.
3418 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3422 Moving within a node:
3424 Once you scroll far enough in a node that its menu appears on the
3425 screen but after point, the next scroll moves into its first
3426 subnode. When after all menu items (or if there is no menu),
3427 move up to the parent node.
3429 already visible, try to go to the previous menu entry, or up
3430 if there is none.
3433 Advanced commands:
3435 and select the node in which the next occurrence is found.
3436 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3439 \\[isearch-forward], \\[isearch-forward-regexp] Use Isearch to search through multiple Info nodes.
3441 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3444 You may include a filename as well, as (FILENAME)NODENAME.
3445 1 .. 9 Pick first ... ninth item in node's menu.
3446 Every third `*' is highlighted to help pick the right number.
3450 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3451 (kill-all-local-variables)
3452 (setq major-mode 'Info-mode)
3453 (setq mode-name "Info")
3454 (setq tab-width 8)
3455 (use-local-map Info-mode-map)
3456 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3457 (set-syntax-table text-mode-syntax-table)
3458 (setq local-abbrev-table text-mode-abbrev-table)
3459 (setq case-fold-search t)
3460 (setq buffer-read-only t)
3461 (make-local-variable 'Info-current-file)
3462 (make-local-variable 'Info-current-subfile)
3463 (make-local-variable 'Info-current-node)
3464 (make-local-variable 'Info-tag-table-marker)
3465 (setq Info-tag-table-marker (make-marker))
3466 (make-local-variable 'Info-tag-table-buffer)
3467 (setq Info-tag-table-buffer nil)
3468 (make-local-variable 'Info-history)
3469 (make-local-variable 'Info-history-forward)
3470 (make-local-variable 'Info-index-alternatives)
3471 (setq header-line-format
3472 (if Info-use-header-line
3473 '(:eval (get-text-property (point-min) 'header-line))
3474 nil)) ; so the header line isn't displayed
3475 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3476 ;; This is for the sake of the invisible text we use handling titles.
3477 (make-local-variable 'line-move-ignore-invisible)
3478 (setq line-move-ignore-invisible t)
3479 (make-local-variable 'desktop-save-buffer)
3480 (make-local-variable 'widen-automatically)
3481 (setq widen-automatically nil)
3482 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3483 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3484 (add-hook 'clone-buffer-hook 'Info-clone-buffer nil t)
3485 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3486 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3487 (set (make-local-variable 'isearch-search-fun-function)
3488 'Info-isearch-search)
3489 (set (make-local-variable 'isearch-wrap-function)
3490 'Info-isearch-wrap)
3491 (set (make-local-variable 'isearch-push-state-function)
3492 'Info-isearch-push-state)
3493 (set (make-local-variable 'isearch-success-function)
3494 'Info-search-success-function)
3495 (set (make-local-variable 'search-whitespace-regexp)
3496 Info-search-whitespace-regexp)
3497 (set (make-local-variable 'revert-buffer-function)
3498 'Info-revert-buffer-function)
3499 (Info-set-mode-line)
3500 (set (make-local-variable 'bookmark-make-record-function)
3501 'Info-bookmark-make-record)
3502 (run-mode-hooks 'Info-mode-hook))
3504 ;; When an Info buffer is killed, make sure the associated tags buffer
3505 ;; is killed too.
3506 (defun Info-kill-buffer ()
3507 (and (eq major-mode 'Info-mode)
3508 Info-tag-table-buffer
3509 (kill-buffer Info-tag-table-buffer)))
3511 ;; Placed on `clone-buffer-hook'.
3512 (defun Info-clone-buffer ()
3513 (when (bufferp Info-tag-table-buffer)
3514 (setq Info-tag-table-buffer
3515 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3516 (let ((m Info-tag-table-marker))
3517 (when (markerp m)
3518 (setq Info-tag-table-marker
3519 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3520 (with-current-buffer Info-tag-table-buffer
3521 (copy-marker (marker-position m)))
3522 (make-marker))))))
3524 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3525 (set-keymap-parent map text-mode-map)
3526 (define-key map "\C-c\C-c" 'Info-cease-edit)
3527 map)
3528 "Local keymap used within `e' command of Info.")
3530 ;; Info-edit mode is suitable only for specially formatted data.
3531 (put 'Info-edit-mode 'mode-class 'special)
3533 (defun Info-edit-mode ()
3534 "Major mode for editing the contents of an Info node.
3535 Like text mode with the addition of `Info-cease-edit'
3536 which returns to Info mode for browsing.
3538 (use-local-map Info-edit-map)
3539 (setq major-mode 'Info-edit-mode)
3540 (setq mode-name "Info Edit")
3541 (kill-local-variable 'mode-line-buffer-identification)
3542 (setq buffer-read-only nil)
3543 (force-mode-line-update)
3544 (buffer-enable-undo (current-buffer))
3545 (run-mode-hooks 'Info-edit-mode-hook))
3547 (defun Info-edit ()
3548 "Edit the contents of this Info node.
3549 Allowed only if variable `Info-enable-edit' is non-nil."
3550 (interactive)
3551 (or Info-enable-edit
3552 (error "Editing Info nodes is not enabled"))
3553 (Info-edit-mode)
3554 (message "%s" (substitute-command-keys
3557 (defun Info-cease-edit ()
3558 "Finish editing Info node; switch back to Info proper."
3559 (interactive)
3560 ;; Do this first, so nothing has changed if user C-g's at query.
3561 (and (buffer-modified-p)
3562 (y-or-n-p "Save the file? ")
3563 (save-buffer))
3564 (use-local-map Info-mode-map)
3565 (setq major-mode 'Info-mode)
3566 (setq mode-name "Info")
3567 (Info-set-mode-line)
3568 (setq buffer-read-only t)
3569 (force-mode-line-update)
3570 (and (marker-position Info-tag-table-marker)
3571 (buffer-modified-p)
3572 (message "Tags may have changed. Use Info-tagify if necessary")))
3573 \f
3574 (defvar Info-file-list-for-emacs
3575 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3576 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3577 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3578 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3579 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3580 ("copyright" . "autotype") ("executable" . "autotype")
3581 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3582 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3583 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3584 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3585 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3586 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3587 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3588 ("rfc2045" . "emacs-mime")
3589 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3590 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3591 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3592 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3593 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3594 ("mml" . "emacs-mime"))
3595 "List of Info files that describe Emacs commands.
3596 An element can be a file name, or a list of the form (PREFIX . FILE)
3597 where PREFIX is a name prefix and FILE is the file to look in.
3598 If the element is just a file name, the file name also serves as the prefix.")
3600 (defun Info-find-emacs-command-nodes (command)
3601 "Return a list of locations documenting COMMAND.
3602 The `info-file' property of COMMAND says which Info manual to search.
3603 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3604 defines heuristics for which Info manual to try.
3605 The locations are of the format used in `Info-history', i.e.
3606 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3607 in the first element of the returned list (which is treated specially in
3608 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3609 (let ((where '()) line-number
3613 (info-file "emacs")) ;default
3614 ;; Determine which Info file this command is documented in.
3615 (if (get command 'info-file)
3616 (setq info-file (get command 'info-file))
3617 ;; If it doesn't say explicitly, test its name against
3618 ;; various prefixes that we know.
3619 (let ((file-list Info-file-list-for-emacs))
3620 (while file-list
3621 (let* ((elt (car file-list))
3622 (name (if (consp elt)
3623 (car elt)
3624 elt))
3625 (file (if (consp elt) (cdr elt) elt))
3626 (case-fold-search nil)
3629 (if (string-match regexp (symbol-name command))
3630 (setq info-file file file-list nil))
3631 (setq file-list (cdr file-list))))))
3632 (Info-find-node info-file "Top")
3633 ;; Bind Info-history to nil, to prevent the index nodes from
3634 ;; getting into the node history.
3635 (let ((Info-history nil)
3636 (Info-history-list nil)
3637 node (nodes (Info-index-nodes)))
3638 (Info-goto-node (car nodes))
3639 (while
3640 (progn
3641 (goto-char (point-min))
3642 (while (re-search-forward cmd-desc nil t)
3643 (setq where
3644 (cons (list Info-current-file
3645 (match-string-no-properties 2)
3646 0)
3647 where))
3648 (setq line-number (and (match-beginning 3)
3649 (string-to-number (match-string 3)))))
3650 (and (setq nodes (cdr nodes) node (car nodes))))
3651 (Info-goto-node node)))
3652 (if (and line-number where)
3653 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3654 (cdr where))
3655 where)))
3657 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3658 ;;;###autoload
3659 (defun Info-goto-emacs-command-node (command)
3660 "Go to the Info node in the Emacs manual for command COMMAND.
3661 The command is found by looking up in Emacs manual's indices
3662 or in another manual found via COMMAND's `info-file' property or
3663 the variable `Info-file-list-for-emacs'.
3664 COMMAND must be a symbol or string."
3665 (interactive "CFind documentation for command: ")
3666 ;; If command is given as a string, convert it to a symbol.
3667 (if (stringp command)
3668 (setq command (intern command)))
3669 (or (commandp command)
3670 (signal 'wrong-type-argument (list 'commandp command)))
3671 (let ((where (Info-find-emacs-command-nodes command)))
3672 (if where
3673 (let ((num-matches (length where)))
3674 ;; Get Info running, and pop to it in another window.
3675 (save-window-excursion
3676 (info))
3677 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3678 ;; Bind Info-history to nil, to prevent the last Index node
3679 ;; visited by Info-find-emacs-command-nodes from being
3680 ;; pushed onto the history.
3681 (let ((Info-history nil) (Info-history-list nil)
3682 (line-number (nth 2 (car where))))
3683 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3684 (if (and (integerp line-number) (> line-number 0))
3685 (forward-line (1- line-number))))
3686 (if (> num-matches 1)
3687 (progn
3688 ;; (car where) will be pushed onto Info-history
3689 ;; when/if they go to another node. Put the other
3690 ;; nodes that were found on the history.
3691 (setq Info-history (nconc (cdr where) Info-history))
3692 (message "Found %d other entr%s. Use %s to see %s."
3693 (1- num-matches)
3694 (if (> num-matches 2) "ies" "y")
3696 (if (> num-matches 2) "them" "it")))))
3697 (error "Couldn't find documentation for %s" command))))
3699 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3700 ;;;###autoload
3701 (defun Info-goto-emacs-key-command-node (key)
3702 "Go to the node in the Emacs manual which describes the command bound to KEY.
3703 KEY is a string.
3704 Interactively, if the binding is `execute-extended-command', a command is read.
3705 The command is found by looking up in Emacs manual's indices
3706 or in another manual found via COMMAND's `info-file' property or
3707 the variable `Info-file-list-for-emacs'."
3708 (interactive "kFind documentation for key: ")
3709 (let ((command (key-binding key)))
3710 (cond ((null command)
3711 (message "%s is undefined" (key-description key)))
3712 ((and (interactive-p)
3713 (eq command 'execute-extended-command))
3714 (Info-goto-emacs-command-node
3715 (read-command "Find documentation for command: ")))
3716 (t
3717 (Info-goto-emacs-command-node command)))))
3718 \f
3719 (defvar Info-next-link-keymap
3720 (let ((keymap (make-sparse-keymap)))
3721 (define-key keymap [header-line mouse-1] 'Info-next)
3722 (define-key keymap [header-line mouse-2] 'Info-next)
3723 (define-key keymap [header-line down-mouse-1] 'ignore)
3724 (define-key keymap [mouse-2] 'Info-next)
3725 (define-key keymap [follow-link] 'mouse-face)
3726 keymap)
3727 "Keymap to put on the Next link in the text or the header line.")
3729 (defvar Info-prev-link-keymap
3730 (let ((keymap (make-sparse-keymap)))
3731 (define-key keymap [header-line mouse-1] 'Info-prev)
3732 (define-key keymap [header-line mouse-2] 'Info-prev)
3733 (define-key keymap [header-line down-mouse-1] 'ignore)
3734 (define-key keymap [mouse-2] 'Info-prev)
3735 (define-key keymap [follow-link] 'mouse-face)
3736 keymap)
3737 "Keymap to put on the Prev link in the text or the header line.")
3739 (defvar Info-up-link-keymap
3740 (let ((keymap (make-sparse-keymap)))
3741 (define-key keymap [header-line mouse-1] 'Info-up)
3742 (define-key keymap [header-line mouse-2] 'Info-up)
3743 (define-key keymap [header-line down-mouse-1] 'ignore)
3744 (define-key keymap [mouse-2] 'Info-up)
3745 (define-key keymap [follow-link] 'mouse-face)
3746 keymap)
3747 "Keymap to put on the Up link in the text or the header line.")
3749 (defcustom Info-breadcrumbs-depth 4
3750 "Depth of breadcrumbs to display.
3751 0 means do not display breadcrumbs."
3752 :type 'integer)
3754 (defun Info-insert-breadcrumbs ()
3755 (let ((nodes (Info-toc-nodes Info-current-file))
3756 (node Info-current-node)
3757 (crumbs ())
3758 (depth Info-breadcrumbs-depth))
3760 ;; Get ancestors from the cached parent-children node info
3761 (while (and (not (equal "Top" node)) (> depth 0))
3762 (setq node (nth 1 (assoc node nodes)))
3763 (if node (push node crumbs))
3764 (setq depth (1- depth)))
3766 ;; Add bottom node.
3767 (when Info-use-header-line
3768 ;; Let it disappear if crumbs is nil.
3769 (nconc crumbs (list Info-current-node)))
3770 (when (or Info-use-header-line crumbs)
3771 ;; Add top node (and continuation if needed).
3772 (setq crumbs
3773 (cons "Top" (if (member (pop crumbs) '(nil "Top"))
3774 crumbs (cons nil crumbs))))
3775 ;; Eliminate duplicate.
3776 (forward-line 1)
3777 (dolist (node crumbs)
3778 (let ((text
3779 (if (not (equal node "Top")) node
3780 (format "(%s)Top"
3781 (if (stringp Info-current-file)
3782 (file-name-nondirectory Info-current-file)
3783 ;; Can be `toc', `apropos', or even `history'.
3784 Info-current-file)))))
3785 (insert (if (bolp) "" " > ")
3786 (cond
3787 ((null node) "...")
3788 ((equal node Info-current-node)
3789 ;; No point linking to ourselves.
3790 (propertize text 'font-lock-face 'info-header-node))
3791 (t
3792 (concat "*Note " text "::"))))))
3795 (defun Info-fontify-node ()
3796 "Fontify the node."
3797 (save-excursion
3798 (let* ((inhibit-read-only t)
3799 (case-fold-search t)
3800 paragraph-markers
3801 (not-fontified-p ; the node hasn't already been fontified
3802 (not (let ((where (next-single-property-change (point-min)
3803 'font-lock-face)))
3804 (and where (not (= where (point-max)))))))
3805 (fontify-visited-p ; visited nodes need to be re-fontified
3806 (and Info-fontify-visited-nodes
3807 ;; Don't take time to refontify visited nodes in huge nodes
3808 Info-fontify-maximum-menu-size
3809 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3810 rbeg rend)
3812 ;; Fontify header line
3813 (goto-char (point-min))
3815 (goto-char (match-end 0))
3817 (goto-char (match-end 0))
3818 (let* ((nbeg (match-beginning 2))
3819 (nend (match-end 2))
3820 (tbeg (match-beginning 1))
3821 (tag (match-string 1)))
3822 (if (string-equal (downcase tag) "node")
3823 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3824 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3825 (put-text-property tbeg nend 'mouse-face 'highlight)
3826 (put-text-property tbeg nend
3827 'help-echo
3828 (concat "mouse-2: Go to node "
3829 (buffer-substring nbeg nend)))
3830 ;; Always set up the text property keymap.
3831 ;; It will either be used in the buffer
3832 ;; or copied in the header line.
3833 (put-text-property
3834 tbeg nend 'keymap
3835 (cond
3836 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3837 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3838 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3840 (when (> Info-breadcrumbs-depth 0)
3841 (Info-insert-breadcrumbs))
3843 ;; Treat header line.
3844 (when Info-use-header-line
3845 (goto-char (point-min))
3846 (let* ((header-end (line-end-position))
3847 (header
3848 ;; If we find neither Next: nor Prev: link, show the entire
3849 ;; node header. Otherwise, don't show the File: and Node:
3850 ;; parts, to avoid wasting precious space on information that
3851 ;; is available in the mode line.
3852 (if (re-search-forward
3854 header-end t)
3855 (progn
3856 (goto-char (match-beginning 1))
3857 (buffer-substring (point) header-end))
3859 header-end t)
3860 (concat "No next, prev or up links -- "
3861 (buffer-substring (point) header-end))
3862 (buffer-substring (point) header-end)))))
3863 (put-text-property (point-min) (1+ (point-min))
3864 'header-line
3865 (replace-regexp-in-string
3866 "%"
3867 ;; Preserve text properties on duplicated `%'.
3868 (lambda (s) (concat s s)) header))
3869 ;; Hide the part of the first line
3870 ;; that is in the header, if it is just part.
3871 (cond
3872 ((> Info-breadcrumbs-depth 0)
3873 (put-text-property (point-min) (1+ header-end) 'invisible t))
3874 ((not (bobp))
3875 ;; Hide the punctuation at the end, too.
3877 (put-text-property (point) header-end 'invisible t))))))
3879 ;; Fontify titles
3880 (goto-char (point-min))
3881 (when (and font-lock-mode not-fontified-p)
3883 nil t)
3884 ;; Only consider it as an underlined title if the ASCII
3885 ;; underline has the same size as the text. A typical
3886 ;; counter example is when a continuation "..." is alone
3887 ;; on a line.
3888 (= (string-width (match-string 1))
3889 (string-width (match-string 2))))
3890 (let* ((c (preceding-char))
3891 (face
3892 (cond ((= c ?*) 'info-title-1)
3893 ((= c ?=) 'info-title-2)
3894 ((= c ?-) 'info-title-3)
3895 (t 'info-title-4))))
3896 (put-text-property (match-beginning 1) (match-end 1)
3897 'font-lock-face face))
3898 ;; This is a serious problem for trying to handle multiple
3899 ;; frame types at once. We want this text to be invisible
3900 ;; on frames that can display the font above.
3901 (when (memq (framep (selected-frame)) '(x pc w32 ns))
3902 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3903 '(invisible t front-sticky nil rear-nonsticky t)))))
3905 ;; Fontify cross references
3906 (goto-char (point-min))
3907 (when (or not-fontified-p fontify-visited-p)
3908 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3909 (let ((start (match-beginning 0))
3910 (next (point))
3911 other-tag)
3912 (when not-fontified-p
3913 (when Info-hide-note-references
3914 (when (and (not (eq Info-hide-note-references 'hide))
3915 (> (line-number-at-pos) 4)) ; Skip breadcrumbs
3916 ;; *Note is often used where *note should have been
3917 (goto-char start)
3918 (skip-syntax-backward " ")
3919 (when (memq (char-before) '(?\( ?\[ ?\{))
3920 ;; Check whether the paren is preceded by
3921 ;; an end of sentence
3922 (skip-syntax-backward " ("))
3923 (setq other-tag
3925 "")
3927 "")
3928 ((memq (char-before) '(nil ?\. ?! ??))
3929 "See ")
3930 ((save-match-data
3931 (save-excursion
3933 "See ")
3934 (t "see "))))
3935 (goto-char next)
3936 (add-text-properties
3937 (match-beginning 1)
3938 (or (save-match-data
3940 (let ((start1 (match-beginning 1)))
3942 (+ start1 (match-beginning 0)))))
3943 (match-end 1))
3944 (if other-tag
3945 `(display ,other-tag front-sticky nil rear-nonsticky t)
3946 '(invisible t front-sticky nil rear-nonsticky t))))
3947 (add-text-properties
3948 (match-beginning 2) (match-end 2)
3949 (list
3950 'help-echo (if (or (match-end 5)
3951 (not (equal (match-string 4) "")))
3952 (concat "mouse-2: go to " (or (match-string 5)
3953 (match-string 4)))
3954 "mouse-2: go to this node")
3955 'mouse-face 'highlight)))
3956 (when (or not-fontified-p fontify-visited-p)
3957 (setq rbeg (match-beginning 2)
3958 rend (match-end 2))
3959 (put-text-property
3960 rbeg rend
3961 'font-lock-face
3962 ;; Display visited nodes in a different face
3963 (if (and Info-fontify-visited-nodes
3964 (save-match-data
3965 (let* ((node (replace-regexp-in-string
3967 (replace-regexp-in-string
3969 (or (match-string-no-properties 5)
3970 (and (not (equal (match-string 4) ""))
3971 (match-string-no-properties 4))
3972 (match-string-no-properties 2)))))
3973 (external-link-p
3975 (file (if external-link-p
3976 (file-name-nondirectory
3977 (match-string-no-properties 1 node))
3978 Info-current-file))
3979 (hl Info-history-list)
3980 res)
3981 (if external-link-p
3982 (setq node (if (equal (match-string 2 node) "")
3983 "Top"
3984 (match-string-no-properties 2 node))))
3985 (while hl
3986 (if (and (string-equal node (nth 1 (car hl)))
3987 (equal file
3988 (if (and external-link-p
3989 (stringp (caar hl)))
3990 (file-name-nondirectory
3991 (caar hl))
3992 (caar hl))))
3993 (setq res (car hl) hl nil)
3994 (setq hl (cdr hl))))
3995 res))) 'info-xref-visited 'info-xref))
3996 ;; For multiline ref, unfontify newline and surrounding whitespace
3997 (save-excursion
3998 (goto-char rbeg)
3999 (save-match-data
4001 (remove-text-properties (match-beginning 0)
4002 (match-end 0)
4003 '(font-lock-face t))))))
4004 (when not-fontified-p
4005 (when (memq Info-hide-note-references '(t hide))
4006 (add-text-properties (match-beginning 3) (match-end 3)
4007 '(invisible t front-sticky nil rear-nonsticky t))
4008 ;; Unhide the file name of the external reference in parens
4009 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
4010 (remove-text-properties (match-beginning 6) (match-end 6)
4011 '(invisible t front-sticky nil rear-nonsticky t)))
4012 ;; Unhide newline because hidden newlines cause too long lines
4013 (save-match-data
4014 (let ((beg3 (match-beginning 3))
4015 (end3 (match-end 3)))
4017 (not (save-match-data
4018 (save-excursion
4019 (goto-char (1+ end3))
4020 (looking-at "[.)]*$")))))
4021 (remove-text-properties (+ beg3 (match-beginning 0))
4022 (+ beg3 (match-end 0))
4023 '(invisible t front-sticky nil rear-nonsticky t))))))
4024 (when (and Info-refill-paragraphs Info-hide-note-references)
4025 (push (set-marker (make-marker) start)
4026 paragraph-markers))))))
4028 ;; Refill paragraphs (experimental feature)
4029 (when (and not-fontified-p
4030 Info-refill-paragraphs
4031 paragraph-markers)
4032 (let ((fill-nobreak-invisible t)
4033 (fill-individual-varying-indent nil)
4036 (adaptive-fill-mode nil))
4037 (goto-char (point-max))
4038 (dolist (m paragraph-markers)
4039 (when (< m (point))
4040 (goto-char m)
4041 (beginning-of-line)
4042 (let ((beg (point)))
4043 (when (zerop (forward-paragraph))
4044 (fill-individual-paragraphs beg (point) nil nil)
4045 (goto-char beg))))
4046 (set-marker m nil))))
4048 ;; Fontify menu items
4049 (goto-char (point-min))
4050 (when (and (or not-fontified-p fontify-visited-p)
4052 ;; Don't take time to annotate huge menus
4053 Info-fontify-maximum-menu-size
4054 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
4055 (let ((n 0)
4056 cont)
4057 (while (re-search-forward
4060 nil t)
4061 (when (match-beginning 1)
4062 (when not-fontified-p
4063 (setq n (1+ n))
4064 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
4065 (put-text-property (match-beginning 0)
4066 (1+ (match-beginning 0))
4067 'font-lock-face 'info-menu-star)))
4068 (when not-fontified-p
4069 (add-text-properties
4070 (match-beginning 1) (match-end 1)
4071 (list
4072 'help-echo (if (and (match-end 3)
4073 (not (equal (match-string 3) "")))
4074 (concat "mouse-2: go to " (match-string 3))
4075 "mouse-2: go to this node")
4076 'mouse-face 'highlight)))
4077 (when (or not-fontified-p fontify-visited-p)
4078 (put-text-property
4079 (match-beginning 1) (match-end 1)
4080 'font-lock-face
4081 ;; Display visited menu items in a different face
4082 (if (and Info-fontify-visited-nodes
4083 (save-match-data
4084 (let* ((node (if (equal (match-string 3) "")
4085 (match-string-no-properties 1)
4086 (match-string-no-properties 3)))
4087 (external-link-p
4089 (file (if external-link-p
4090 (file-name-nondirectory
4091 (match-string-no-properties 1 node))
4092 Info-current-file))
4093 (hl Info-history-list)
4094 res)
4095 (if external-link-p
4096 (setq node (if (equal (match-string 2 node) "")
4097 "Top"
4098 (match-string-no-properties 2 node))))
4099 (while hl
4100 (if (and (string-equal node (nth 1 (car hl)))
4101 (equal file
4102 (if (and external-link-p
4103 (stringp (caar hl)))
4104 (file-name-nondirectory
4105 (caar hl))
4106 (caar hl))))
4107 (setq res (car hl) hl nil)
4108 (setq hl (cdr hl))))
4109 res))) 'info-xref-visited 'info-xref)))
4110 (when (and not-fontified-p
4111 (memq Info-hide-note-references '(t hide))
4112 (not (Info-index-node)))
4113 (put-text-property (match-beginning 2) (1- (match-end 6))
4114 'invisible t)
4115 ;; Unhide the file name in parens
4116 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
4117 (remove-text-properties (match-beginning 4) (match-end 4)
4118 '(invisible t)))
4119 ;; We need a stretchable space like :align-to but with
4120 ;; a minimum value.
4121 (put-text-property (1- (match-end 6)) (match-end 6) 'display
4122 (if (>= 22 (- (match-end 1)
4123 (match-beginning 0)))
4124 '(space :align-to 24)
4125 '(space :width 2)))
4126 (setq cont (looking-at "."))
4127 (while (and (= (forward-line 1) 0)
4129 (put-text-property (match-beginning 1) (1- (match-end 1))
4130 'invisible t)
4131 (put-text-property (1- (match-end 1)) (match-end 1)
4132 'display
4133 (if cont
4134 '(space :align-to 26)
4135 '(space :align-to 24)))
4136 (setq cont t)))))))
4138 ;; Fontify menu headers
4139 ;; Add the face `info-menu-header' to any header before a menu entry
4140 (goto-char (point-min))
4142 (put-text-property (match-beginning 0) (match-end 0)
4143 'font-lock-face 'info-menu-header)
4145 (put-text-property (match-beginning 1) (match-end 1)
4146 'font-lock-face 'info-menu-header)))
4148 ;; Hide index line numbers
4149 (goto-char (point-min))
4150 (when (and not-fontified-p (Info-index-node))
4152 (put-text-property (match-beginning 0) (match-end 0)
4153 'invisible t)))
4155 ;; Fontify http and ftp references
4156 (goto-char (point-min))
4157 (when not-fontified-p
4159 nil t)
4160 (add-text-properties (match-beginning 0) (match-end 0)
4161 '(font-lock-face info-xref
4162 mouse-face highlight
4163 help-echo "mouse-2: go to this URL"))))
4165 (set-buffer-modified-p nil))))
4166 \f
4167 ;;; Speedbar support:
4168 ;; These functions permit speedbar to display the "tags" in the
4169 ;; current Info node.
4170 (eval-when-compile (require 'speedbar))
4172 (defvar Info-speedbar-key-map nil
4173 "Keymap used when in the info display mode.")
4175 (defun Info-install-speedbar-variables ()
4176 "Install those variables used by speedbar to enhance Info."
4177 (if Info-speedbar-key-map
4178 nil
4179 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4181 ;; Basic tree features
4182 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4183 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4184 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4185 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4186 )
4188 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4189 Info-speedbar-key-map
4190 Info-speedbar-hierarchy-buttons)))
4192 (defvar Info-speedbar-menu-items
4193 '(["Browse Node" speedbar-edit-line t]
4194 ["Expand Node" speedbar-expand-line
4195 (save-excursion (beginning-of-line)
4197 ["Contract Node" speedbar-contract-line
4198 (save-excursion (beginning-of-line)
4199 (looking-at "[0-9]+: *.-. "))]
4200 )
4201 "Additional menu-items to add to speedbar frame.")
4203 ;; Make sure our special speedbar major mode is loaded
4204 (if (featurep 'speedbar)
4205 (Info-install-speedbar-variables)
4206 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4208 ;;; Info hierarchy display method
4209 ;;;###autoload
4210 (defun Info-speedbar-browser ()
4211 "Initialize speedbar to display an Info node browser.
4212 This will add a speedbar major display mode."
4213 (interactive)
4214 (require 'speedbar)
4215 ;; Make sure that speedbar is active
4216 (speedbar-frame-mode 1)
4217 ;; Now, throw us into Info mode on speedbar.
4218 (speedbar-change-initial-expansion-list "Info")
4219 )
4221 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4222 "Display an Info directory hierarchy in speedbar.
4223 DIRECTORY is the current directory in the attached frame.
4224 DEPTH is the current indentation depth.
4225 NODE is an optional argument that is used to represent the
4226 specific node to expand."
4227 (if (and (not node)
4228 (save-excursion (goto-char (point-min))
4229 (let ((case-fold-search t))
4230 (looking-at "Info Nodes:"))))
4231 ;; Update our "current node" maybe?
4232 nil
4233 ;; We cannot use the generic list code, that depends on all leaves
4234 ;; being known at creation time.
4235 (if (not node)
4237 (let ((completions nil))
4238 (speedbar-select-attached-frame)
4239 (save-window-excursion
4240 (setq completions
4241 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4242 (select-frame (speedbar-current-frame))
4243 (if completions
4244 (speedbar-with-writable
4245 (dolist (completion completions)
4246 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4247 (cdr completion)
4248 (car completion)
4249 'Info-speedbar-goto-node
4250 (cdr completion)
4251 'info-xref depth))
4252 t)
4253 nil))))
4255 (defun Info-speedbar-goto-node (text node indent)
4256 "When user clicks on TEXT, go to an info NODE.
4257 The INDENT level is ignored."
4258 (speedbar-select-attached-frame)
4259 (let* ((buff (or (get-buffer "*info*")
4260 (progn (info) (get-buffer "*info*"))))
4261 (bwin (get-buffer-window buff 0)))
4262 (if bwin
4263 (progn
4264 (select-window bwin)
4265 (raise-frame (window-frame bwin)))
4266 (if speedbar-power-click
4267 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4268 (speedbar-select-attached-frame)
4269 (switch-to-buffer buff)))
4271 (error "Invalid node %s" node)
4272 (Info-find-node (match-string 1 node) (match-string 2 node))
4273 ;; If we do a find-node, and we were in info mode, restore
4274 ;; the old default method. Once we are in info mode, it makes
4275 ;; sense to return to whatever method the user was using before.
4276 (if (string= speedbar-initial-expansion-list-name "Info")
4277 (speedbar-change-initial-expansion-list
4278 speedbar-previously-used-expansion-list-name)))))
4280 (defun Info-speedbar-expand-node (text token indent)
4281 "Expand the node the user clicked on.
4282 TEXT is the text of the button we clicked on, a + or - item.
4283 TOKEN is data related to this node (NAME . FILE).
4284 INDENT is the current indentation depth."
4285 (cond ((string-match "+" text) ;we have to expand this file
4286 (speedbar-change-expand-button-char ?-)
4287 (if (speedbar-with-writable
4288 (save-excursion
4289 (end-of-line) (forward-char 1)
4290 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4291 (speedbar-change-expand-button-char ?-)
4292 (speedbar-change-expand-button-char ??)))
4293 ((string-match "-" text) ;we have to contract this node
4294 (speedbar-change-expand-button-char ?+)
4295 (speedbar-delete-subblock indent))
4296 (t (error "Ooops... not sure what to do")))
4297 (speedbar-center-buffer-smartly))
4299 (defun Info-speedbar-fetch-file-nodes (nodespec)
4300 "Fetch the subnodes from the info NODESPEC.
4301 NODESPEC is a string of the form: (file)node."
4302 ;; Set up a buffer we can use to fake-out Info.
4303 (with-current-buffer (get-buffer-create " *info-browse-tmp*")
4304 (if (not (equal major-mode 'Info-mode))
4305 (Info-mode))
4306 ;; Get the node into this buffer
4308 (error "Invalid node specification %s" nodespec)
4309 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4310 ;; Scan the created buffer
4311 (goto-char (point-min))
4312 (let ((completions nil)
4313 (case-fold-search t)
4315 (match-string 1 nodespec))))
4316 ;; Always skip the first one...
4319 (let ((name (match-string 1)))
4320 (push (cons name
4322 (match-string 1)
4324 (concat (match-string 1) "Top")
4325 (concat "(" thisfile ")"
4327 (match-string 1)
4328 name)))))
4329 completions)))
4330 (nreverse completions))))
4332 ;;; Info mode node listing
4333 ;; This is called by `speedbar-add-localized-speedbar-support'
4334 (defun Info-speedbar-buttons (buffer)
4335 "Create a speedbar display to help navigation in an Info file.
4336 BUFFER is the buffer speedbar is requesting buttons for."
4337 (if (save-excursion (goto-char (point-min))
4338 (let ((case-fold-search t))
4339 (not (looking-at "Info Nodes:"))))
4340 (erase-buffer))
4341 (Info-speedbar-hierarchy-buttons nil 0))
4343 (dolist (mess '("^First node in file$"
4344 "^No `.*' in index$"
4345 "^No cross-reference named"
4346 "^No cross.references in this node$"
4347 "^No current Info node$"
4348 "^No menu in this node$"
4349 "^No more items in menu$"
4350 "^No more nodes$"
4352 "^No previous `i' command$"
4353 "^No previous items in menu$"
4354 "^No previous nodes$"
4355 "^No such item in menu$"
4356 "^No such node or anchor"
4357 "^Node has no"
4358 "^Point neither on reference nor in menu item description$"
4360 search-failed))
4361 (add-to-list 'debug-ignored-errors mess))
4363 ;;;; Desktop support
4365 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4366 "Auxiliary information to be saved in desktop file."
4367 (unless (member Info-current-file '(apropos history toc nil))
4368 (list Info-current-file Info-current-node)))
4370 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4371 desktop-buffer-name
4372 desktop-buffer-misc)
4373 "Restore an Info buffer specified in a desktop file."
4374 (let ((first (nth 0 desktop-buffer-misc))
4375 (second (nth 1 desktop-buffer-misc)))
4376 (when (and first second)
4377 (when desktop-buffer-name
4378 (set-buffer (get-buffer-create desktop-buffer-name))
4379 (Info-mode))
4380 (Info-find-node first second)
4381 (current-buffer))))
4383 (add-to-list 'desktop-buffer-mode-handlers
4384 '(Info-mode . Info-restore-desktop-buffer))
4386 ;;;; Bookmark support
4387 (declare-function bookmark-make-record-default "bookmark" (&optional pos-only))
4388 (declare-function bookmark-prop-get "bookmark" (bookmark prop))
4389 (declare-function bookmark-default-handler "bookmark" (bmk))
4390 (declare-function bookmark-get-bookmark-record "bookmark" (bmk))
4392 (defun Info-bookmark-make-record ()
4393 `(,Info-current-node
4394 ,@(bookmark-make-record-default 'point-only)
4395 (filename . ,Info-current-file)
4396 (info-node . ,Info-current-node)
4397 (handler . Info-bookmark-jump)))
4399 ;;;###autoload
4400 (defun Info-bookmark-jump (bmk)
4401 ;; This implements the `handler' function interface for record type returned
4402 ;; by `Info-bookmark-make-record', which see.
4403 (let* ((file (bookmark-prop-get bmk 'filename))
4404 (info-node (bookmark-prop-get bmk 'info-node))
4405 (buf (save-window-excursion ;FIXME: doesn't work with frames!
4406 (Info-find-node file info-node) (current-buffer))))
4407 ;; Use bookmark-default-handler to move to the appropriate location
4408 ;; within the node.
4409 (bookmark-default-handler
4410 (list* "" `(buffer . ,buf) (bookmark-get-bookmark-record bmk)))))
4412 (provide 'info)
4414 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4415 ;;; info.el ends here