| blob | 57a791f3e27b59e7381b67b8f7682e583f7ec465 |
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."
233 "*If non-nil, attempt to refill paragraphs with hidden references.
234 This refilling may accidentally remove explicit line breaks in the Info
235 file, so be prepared for a few surprises if you enable this feature."
241 "*If non-nil, regular expression to match a sequence of whitespace chars.
242 This applies to Info search for regular expressions.
244 In the Customization buffer, that is `[' followed by a space,
245 a tab, a carriage return (control-M), a newline, and `]+'."
250 "*If non-nil, isearch in Info searches through multiple nodes.
251 Before leaving the initial Info node, where isearch was started,
252 it fails once with the error message [initial node], and with
253 subsequent C-s/C-r continues through other nodes without failing
254 with this error message in other nodes. When isearch fails for
255 the rest of the manual, it wraps aroung the whole manual and
256 restarts the search from the top/final node depending on
257 search direction.
259 Setting this option to nil restores the default isearch behavior
260 with wrapping around the current Info node."
268 ;; Try to obey obsolete Info-fontify settings.
271 "Hooks run when `Info-mode' is called."
276 "Hooks run when `Info-select-node' is called."
284 "Info file that Info is now looking at, or nil.
285 This is the name that was specified in Info, not the actual file name.
289 "Info subfile that is actually in the *info* buffer now.
296 "Marker pointing at beginning of current Info file's tag table.
312 "Point location within a selected node.
313 If string, the point is moved to the proper occurrence of the
314 name of the followed cross reference within a selected node.
319 \f
321 ;; The MS-DOS list should work both when long file names are
322 ;; supported (Windows 9X), and when only 8+3 file names are available.
364 "List of file name suffixes and associated decoding commands.
365 Each entry should be (SUFFIX . STRING); the file is given to
366 the command as standard input.
368 STRING may be a list of strings. In that case, the first element is
369 the command name, and the rest are arguments to that command.
371 If STRING is nil, no decoding is done.
372 Because the SUFFIXes are tried in order, the empty string should
375 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
376 ;; First, on MS-DOS with no long file names support, delete some of
377 ;; the extension in FILENAME to make room.
382 ;; How long is the extension in FILENAME (not counting the dot).
384 ext-left)
385 ;; SUFFIX starts with a dot. If FILENAME already has one,
386 ;; get rid of the one in SUFFIX (unless suffix is empty).
391 ;; How many chars of that extension should we keep?
393 ;; Get rid of the rest of the extension, and add SUFFIX.
396 suffix))))
403 "Insert the contents of an Info file in the current buffer.
404 Do the right thing if the file has been compressed or zipped."
408 t))
410 lfn))
411 fullname decoder done)
413 ;; FILENAME exists--see if that name contains a suffix.
414 ;; If so, set DECODE accordingly.
419 filename)))
423 ;; Try adding suffixes to FILENAME and see if we can find something.
429 ;; If we found a file with a suffix, set DECODER
430 ;; according to the suffix.
432 ;; When the MS-DOS port runs on Windows, we need to check
433 ;; the short variant of a long file name as well.
443 ;; check for conflict with jka-compr
453 default-directory)))
459 \f
466 "../share/info/"
467 invocation-directory)))
469 infodir
471 "../../../share/info/"
472 invocation-directory))
474 infodir))))))
475 alternative)
478 ;; Uninstalled, Emacs builddir != srcdir.
479 sibling
480 ;; Uninstalled, builddir == srcdir
481 source))
483 ;; On DOS/NT, we use movable executables always,
484 ;; and we must always find the Info dir at run time.
486 nil
487 ;; Use invocation-directory for Info
488 ;; only if we used it for exec-directory also.
491 installation-directory))))
493 Info-default-directory-list
494 ;; `alternative' contains the Info files that came with this
495 ;; version, so we should look there first. `Info-insert-dir'
496 ;; currently expects to find `alternative' first on the list.
498 ;; Don't drop the last part, it might contain non-Emacs stuff.
499 ;; (reverse (cdr (reverse
503 "Initialize `Info-directory-list', if that hasn't been done yet."
516 ;;;###autoload
518 "Like `info' but show the Info buffer in another window."
524 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
526 ;;;###autoload (put 'info 'info-file "emacs")
527 ;;;###autoload
529 "Enter Info, the documentation browser.
530 Optional argument FILE-OR-NODE specifies the file to examine;
531 the default is the top-level directory of Info.
532 Called from a program, FILE-OR-NODE may specify an Info node of the form
533 `(FILENAME)NODENAME'.
534 Optional argument BUFFER specifies the Info buffer name;
535 the default buffer name is *info*. If BUFFER exists,
536 just switch to BUFFER. Otherwise, create a new buffer
537 with the top-level Info directory.
539 In interactive use, a non-numeric prefix argument directs
540 this command to read a file name from the minibuffer.
541 A numeric prefix argument selects an Info buffer with the prefix number
542 appended to the Info buffer name.
544 The search path for Info files is in the variable `Info-directory-list'.
545 The top-level Info directory is made by combining all the files named `dir'
546 in all the directories in that path."
556 ;; If argument already contains parentheses, don't add another set
557 ;; since the argument will then be parsed improperly. This also
558 ;; has the added benefit of allowing node names to be included
559 ;; following the parenthesized filename.
562 file-or-node
566 ;; If we just created the Info buffer, go to the directory.
569 ;;;###autoload
571 "Display the Emacs manual in Info mode."
575 ;;;###autoload
577 "Run Emacs as a standalone Info reader.
578 Usage: emacs -f info-standalone [filename]
592 \f
593 ;; See if the accessible portion of the buffer begins with a node
594 ;; delimiter, and the node header line which follows matches REGEXP.
595 ;; Typically, this test will be followed by a loop that examines the
596 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
597 ;; to have the overhead of this special test inside the loop.
599 ;; This function changes match-data, but supposedly the caller might
600 ;; want to use the results of re-search-backward.
602 ;; The return value is the value of point at the beginning of matching
603 ;; REGEXP, if the function succeeds, nil otherwise.
615 Optional second argument NOERROR, if t, means if file is not found
616 just return nil (no error)."
617 ;; Convert filename to lower case if not found as specified.
618 ;; Expand it.
627 ;; If specified name starts with `./'
628 ;; then just try current directory.
631 ;; No point in searching for an
632 ;; absolute file name
636 Info-additional-directory-list)
637 Info-directory-list)))))
638 ;; Search the directory list for file FILENAME.
643 ;; Try several variants of specified name.
647 t)))
658 lfn
670 filename)
674 "Go to an Info node specified as separate FILENAME and NODENAME.
675 NO-GOING-BACK is non-nil if recovering from an error in this function;
676 it says do not attempt further (recursive) error recovery."
679 ;; Go into Info buffer.
681 ;; Record the node we are leaving, if we were in one.
683 Info-current-file
686 Info-history)))
689 ;;;###autoload
691 "Use Info mode to browse the current Info buffer.
692 With a prefix arg, this queries for the node name to visit first;
693 otherwise, that defaults to `Top'."
703 ;; If called on a non-file buffer, make a fake file name.
707 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
708 ;; but at least it keeps this routine (which is for makeinfo-buffer and
709 ;; Info-revert-buffer-function) out of the way of normal operations.
710 ;;
712 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
713 When *info* is already displaying FILENAME and NODENAME, the window position
714 is preserved, if possible."
730 ;; note goto-line is no good, we want to measure from point-min
737 ;; only add to the history when coming from a different file+node
747 "Find a node in a tag table.
748 MARKER specifies the buffer and position to start searching at.
749 REGEXP is a regular expression matching nodes or references. Its first
750 group should match `Node:' or `Ref:'.
751 CASE-FOLD t means search for a case-insensitive match.
752 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
753 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
754 where the match was found, and MODE is `major-mode' of the buffer in
755 which the match was found."
760 ;; Search tag table
765 major-mode)))))
768 "Find a node in a tag table.
769 MARKER specifies the buffer and position to start searching at.
770 REGEXP is a regular expression matching nodes or references. Its first
771 group should match `Node:' or `Ref:'.
772 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
773 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
774 where the match was found, and MODE is `major-mode' of the buffer in
775 which the match was found.
776 This function tries to find a case-sensitive match first, then a
777 case-insensitive match is tried."
781 result))
784 "Find a node or anchor in the current buffer.
785 REGEXP is a regular expression matching nodes or references. Its first
786 group should match `Node:' or `Ref:'.
787 CASE-FOLD t means search for a case-insensitive match.
788 Value is the position at which a match was found, or nil if not found."
790 found)
802 found)))
805 "Find a node or anchor in the current buffer.
806 REGEXP is a regular expression matching nodes or references. Its first
807 group should match `Node:' or `Ref:'.
808 Value is the position at which a match was found, or nil if not found.
809 This function looks for a case-sensitive match first. If none is found,
810 a case-insensitive match is tried."
822 anchorpos)
823 ;; Switch files if necessary
828 Info-current-subfile nil
829 Info-current-file-completions nil
830 buffer-file-name nil)
846 ;; Check makeinfo version for index cookie support
858 ;; See whether file has a tag table. Record the location if yes.
861 ;; Use string-equal, not equal, to ignore text props.
866 ;; We have a tag table. Find its beginning.
867 ;; Is this an indirect file?
873 ;; It is indirect. Copy it to another buffer
874 ;; and record that the tag table is in that buffer.
893 ))
894 ;; Use string-equal, not equal, to ignore text props.
898 ;; Possibilities:
899 ;;
900 ;; 1. Anchor found in tag table
901 ;; 2. Anchor *not* in tag table
902 ;;
903 ;; 3. Node found in tag table
904 ;; 4. Node *not* found in tag table, but found in file
905 ;; 5. Node *not* in tag table, and *not* in file
906 ;;
907 ;; *Or* the same, but in an indirect subfile.
909 ;; Search file for a suitable node.
919 ;; First, search a tag table, if any
925 ;; FOUND is (ANCHOR POS MODE).
928 ;; If this is an indirect file, determine which
929 ;; file really holds this node and read it in.
931 ;; Note that the current buffer must be the
932 ;; *info* buffer on entry to
933 ;; Info-read-subfile. Thus the hackery above.
936 ;; Handle anchor
941 ;; Else we may have a node, which we search for:
945 ;; Now search from our advised position (or from beg of
946 ;; buffer) to find the actual node. First, check
947 ;; whether the node is right where we are, in case the
948 ;; buffer begins with a node.
961 ;; No such anchor in tag table or node in tag table or file
969 ;; Add anchors to the history too
980 ;; If we did not finish finding the specified node,
981 ;; go back to the previous one.
988 ;; Cache the contents of the (virtual) dir file, once we have merged
989 ;; it for the first time, so we can save time subsequently.
992 ;; Cache for the directory we decided to use for the default-directory
993 ;; of the merged dir text.
996 ;; Record the file attributes of all the files from which we
997 ;; constructed Info-dir-contents.
1002 ;; Construct the Info directory node by merging the files named `dir'
1003 ;; from various directories. Set the *info* buffer's
1004 ;; default-directory to the first directory we actually get any text
1005 ;; from.
1008 ;; Verify that none of the files we used has changed
1009 ;; since we used it.
1013 ;; Handle symlinks
1016 ;; Don't compare the access time.
1020 Info-dir-file-attributes))))
1026 Info-additional-directory-list)
1027 Info-directory-list))
1029 ;; Bind this in case the user sets it to nil.
1031 ;; This is set non-nil if we find a problem in some input files.
1032 problems
1033 buffers buffer others nodes dirs-done)
1035 ;; Search the directory list for the directory file.
1040 ;; Try several variants of specified name.
1041 ;; Try upcasing, appending `.info', or both.
1056 dirs-done)))
1065 file)
1077 ;; Distinguish the dir file that comes with Emacs from all the
1078 ;; others. Yes, that is really what this is supposed to do.
1079 ;; The definition of `Info-directory-list' puts it first on that
1080 ;; list and so last in `buffers' at this point.
1084 ;; Insert the entire original dir file as a start; note that we've
1085 ;; already saved its default directory to use as the default
1086 ;; directory for the whole concatenation.
1089 ;; Look at each of the other buffers one by one.
1092 ;; In each, find all the menus.
1095 ;; Find each menu, and add an elt to NODES for it.
1099 nodename end)
1111 ;; Add to the main menu a menu item for each other node.
1123 end t)
1127 ;; Now take each node of each of the other buffers
1128 ;; and merge it into the main buffer.
1133 ;; Find the like-named node in the main buffer.
1137 nil t)
1142 ;; If none exists, add one.
1145 ;; Merge the text from the other buffer's menu
1146 ;; into the menu in the like-named node in the main buffer.
1149 ;; Kill all the buffers we just made, including the special one excised.
1169 ;; Remove duplicate headings in the same menu.
1172 ;; Look for the next heading to unify.
1177 ;; Check whether this heading should be streamlined.
1187 ;; Look for other headings of the same category and merge them.
1193 ;; Delete redundant heading.
1195 ;; Push the entries onto `text'.
1202 entries)
1204 ;; Insert the entries just found.
1212 ;; Now remove duplicate entries under the same heading.
1219 ;; Fold case straight away; `member-ignore-case' here wasteful.
1227 ;; Note that on entry to this function the current-buffer must be the
1228 ;; *info* buffer; not the info tags buffer.
1230 ;; NODEPOS is either a position (in the Info file as a whole,
1231 ;; not relative to a subfile) or the name of a subfile.
1233 lastfilename)
1244 thisfilepos thisfilename)
1248 ;; read in version 19 stops at the end of number.
1249 ;; Advance to the next line.
1258 ;; Assume previous buffer is in Info-mode.
1259 ;; (set-buffer (get-buffer "*info*"))
1268 ;; Widen in case we are in the same subfile as before.
1278 "Unescape double quotes and backslashes in VALUE."
1284 unquote))
1286 ;; As of Texinfo 4.6, makeinfo writes constructs like
1287 ;; \0\h[image param=value ...\h\0]
1288 ;; into the Info file for handling images.
1291 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1292 whitespace or double quotes, it must be quoted in double quotes and
1297 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1298 parameter-string start)
1304 parameter-alist))
1305 parameter-alist))
1308 "Display images in current node."
1315 nil t)
1329 ;; text-only display, show alternative text if provided, or
1330 ;; otherwise a clue that there's meant to be a picture
1339 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1340 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1341 ;; including one optional trailing newline.
1343 "Hide unrecognized cookies in current node."
1350 nil t)
1357 "Select the Info node that point is in."
1358 ;; Bind this in case the user sets it to nil.
1361 ;; Find beginning of node.
1367 ;; Get nodename spelled as it is in the node.
1375 ;; Find the end of it, and narrow.
1378 ;; Narrow to the node contents
1390 ;; Add a new unique history item to full history list
1405 map)
1413 " ("
1418 ") "
1423 'help-echo
1424 "mouse-1: scroll forward, mouse-3: scroll back"
1428 \f
1429 ;; Go to an Info node specified with a filename-and-nodename string
1430 ;; of the sort that is found in pointers in nodes.
1432 ;; Don't autoload this function: the correct entry point for other packages
1433 ;; to use is `info'. --Stef
1434 ;; ;;;###autoload
1436 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1437 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1438 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1439 its sub-files).
1440 Completion is available, but only for node names in the current Info file.
1441 If FORK is non-nil (interactively with a prefix arg), show the node in
1442 a new Info buffer.
1443 If FORK is a string, it is the name to use for the new buffer."
1451 nodename)
1453 ""
1467 "Virtual completion table for file names input in Info node names.
1468 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1482 ;; If the file name has no suffix or a standard suffix,
1483 ;; include it.
1486 ;; But exclude subfiles of split Info files.
1488 ;; And exclude backup files.
1491 ;; If the file name ends in a standard suffix,
1492 ;; add the unsuffixed name as a completion option.
1498 ;; This function is used as the "completion table" while reading a node name.
1499 ;; It does completion using the alist in Info-read-node-completion-table
1500 ;; unless STRING starts with an open-paren.
1503 ;; First complete embedded file names.
1506 "("
1509 Info-directory-list
1512 predicate
1513 code))
1515 ;; If a file name was given, then any node is fair game.
1521 ;; Otherwise use Info-read-node-completion-table.
1523 code Info-read-node-completion-table string predicate))))
1525 ;; Arrange to highlight the proper letters in the completion list buffer.
1534 nodename)))
1539 ;; Bind this in case the user sets it to nil.
1554 compl))))
1557 ;; If the buffer begins with a node header, process that first.
1560 ;; Now for the rest of the nodes.
1568 compl))))))))
1571 \f
1573 "If this node has been visited, restore the point value when we left."
1576 ;; Use string-equal, not equal, to ignore text props.
1582 \f
1590 "Search for REGEXP, starting from point, and select node it's found in.
1591 If DIRECTION is `backward', search in the reverse direction."
1619 ;; Hide Info file header for backward search
1630 Info-search-whitespace-regexp)))
1645 ;; If no subfiles, give error now.
1650 Info-search-whitespace-regexp)))
1661 ;; Try other subfiles.
1671 ;; Find the subfile we just searched.
1673 ;; Skip that one.
1676 ;; Make a list of all following subfiles.
1677 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1686 list))
1690 ;; Put in forward order
1696 ;; Hide Info file header for backward search
1710 Info-search-whitespace-regexp)))
1733 ;; Search landed in the same node
1739 ;; Use string-equal, not equal, to ignore text props.
1745 Info-history))))))
1748 "Search for a regexp case-sensitively."
1754 "Search for next regexp from a previous `Info-search' command."
1762 "Search for REGEXP in the reverse direction."
1781 nil t)
1783 bound noerror count
1786 bound noerror count
1815 "Skip invisible text, node header line and Tag Table node."
1825 ;; Skip node header line
1829 ;; Skip Tag Table node
1835 \f
1837 "Extract the value of the node-pointer named NAME.
1838 If there is none, use ERRORNAME in the error message;
1839 if ERRORNAME is nil, just return nil."
1840 ;; Bind this in case the user sets it to nil.
1854 "Return a regexp matching a node name.
1855 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1856 saying which chars may appear in the node name.
1857 Submatch 1 is the complete node name.
1858 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1859 Submatch 3 is the local part of the node name.
1860 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1867 ;;; For compatibility; other files have used this name.
1873 "Go to the next node of this node."
1875 ;; In case another window is currently selected
1881 "Go to the previous node of this node."
1883 ;; In case another window is currently selected
1889 "Go to the superior node of this node.
1890 If SAME-FILE is non-nil, do not move to a different Info file."
1892 ;; In case another window is currently selected
1911 nil t))
1917 "Go back in the history to the last node visited."
1923 Info-history-forward))
1924 filename nodename opoint)
1937 "Go forward in the history of visited nodes."
1942 filename nodename opoint)
1950 ;;;###autoload
1952 "Go to the Info directory node."
1955 \f
1957 "Go to a node with a menu of visited nodes."
1961 p)
1986 "Go to a node with table of contents of the current Info file.
1987 Table of contents is created from the tree structure of menus."
1992 p)
2022 "Insert table of contents with references to nodes."
2034 "Build table of contents from menus of Info FILE and its subfiles."
2039 default-directory))
2042 nodes subfiles)
2054 menu-items)
2063 bound))
2066 ;; Menu item line
2076 ;; Other non-empty strings in the Top node are section names
2085 nodes))
2094 subfiles)))))
2096 main-file nil))
2100 \f
2102 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2103 FOOTNOTENAME may be an abbreviation of the reference name.
2104 If FORK is non-nil (interactively with a prefix arg), show the node in
2105 a new Info buffer. If FORK is a string, it is the name to use for the
2106 new buffer."
2112 ;; Store end and beginning of line.
2121 ;; See if this one should be the default.
2126 ;; See if this one should be the alternate default.
2136 ;; Record as a completion and perhaps as default.
2139 ;; Don't add this string if it's a duplicate.
2142 ;; If no good default was found, try an alternate.
2145 ;; If only one cross-reference found, then make it default.
2151 "Follow reference named (default "
2154 completions nil t)))
2168 ;; Move point to the beginning of reference if point is on reference
2178 ;; Go to the reference closest to point
2186 next-ref prev-ref))
2197 ;; We allow newline because this is also used in Info-follow-reference,
2198 ;; where the xref name might be wrapped over two lines.
2199 "Regexp that matches a menu entry name upto but not including the colon.
2200 Because of ambiguities, this should be concatenated with something like
2221 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2222 ;;; (setq Info-point-loc
2223 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2224 )
2228 ;; If the node name is the menu entry name (using `entry::').
2232 ;; No one calls this.
2233 ;;(defun Info-menu-item-sequence (list)
2234 ;; (while list
2235 ;; (Info-menu (car list))
2236 ;; (setq list (cdr list))))
2248 ;; This uses two dynamically bound variables:
2249 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2250 ;; is the menu of items we're trying to complete.
2251 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2252 ;; also look for menu items in subsequent nodes as long as those
2253 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2254 ;; not used.
2255 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2256 ;; also look for menu items in these nodes. This feature is currently
2257 ;; only used for completion in Info-index.
2259 ;; Note that `Info-complete-menu-buffer' could be current already,
2260 ;; so we want to save point.
2266 nextnode)
2275 completions
2277 ;; Check the cache.
2285 ;; We can reuse the previous list.
2287 ;; The cache can't be used.
2292 completions))
2293 ;; Check subsequent nodes if applicable.
2301 ;; Go back to the start node (for the next completion).
2304 ;; Update the cache.
2307 Info-complete-next-re string completions
2308 Info-complete-nodes)))
2315 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2316 The menu item should one of those listed in the current node's menu.
2317 Completion is allowed, and the default menu item is the one point is on.
2318 If FORK is non-nil (interactively with a prefix arg), show the node in
2319 a new Info buffer. If FORK is a string, it is the name to use for the
2320 new buffer."
2323 ;; If point is within a menu item, use that item as the default
2326 beg
2339 Info-menu-entry-name-re
2348 default)
2351 ;; we rely on the fact that completing-read accepts an input
2352 ;; of "" even when the require-match argument is true and ""
2353 ;; is not a valid possibility
2357 ;; ask again
2360 ;; there is a problem here in that if several menu items have the same
2361 ;; name you can only go to the node of the first with this command.
2379 ;; If COUNT is nil, use the last item in the menu.
2391 nil))
2395 "Go to the node of the Nth menu item.
2396 N is the digit argument used to invoke this command."
2403 "Go to the Top node of this file."
2408 "Go to the final node in this file."
2413 ;; Go to the last node in the menu of Top.
2415 ;; If the last node in the menu is not last in pointer structure,
2416 ;; move forward until we can't go any farther.
2418 ;; Then keep moving down to last subnode, unless we reach an index.
2424 "Go forward one node, considering all nodes as forming one sequence."
2429 ;; three possibilities, in order of priority:
2430 ;; 1. next node is in a menu in this node (but not in an index)
2431 ;; 2. next node is next at same level
2432 ;; 3. next node is up and next
2437 t)
2440 t)
2442 ;; Use string-equal, not equal, to ignore text props.
2455 "Go backward one node, considering all nodes as forming one sequence."
2463 ;; Use string-equal, not equal,
2464 ;; to ignore text properties.
2469 ;; If we move back at the same level,
2470 ;; go down to find the last subnode*.
2480 "Exit Info by selecting some other buffer."
2487 "Go to the node of the next menu item."
2489 ;; Bind this in case the user sets it to nil.
2501 "Go to the node of the previous menu item."
2505 ;; Bind this in case the user sets it to nil.
2520 "Go to the next subnode or the next node, or go up a level."
2525 ;; Since we have already gone thru all the items in this menu,
2526 ;; go up to the end of this node.
2528 ;; Since logically we are done with the node with that menu,
2529 ;; move on from it. But don't add intermediate nodes
2530 ;; to the history on recursive calls.
2537 "Go to the last node, popping up a level if there is none."
2541 ;; If we go down a menu item, go to the end of the node
2542 ;; so we can scroll back through it.
2544 ;; Keep going down, as long as there are nested menu nodes.
2547 ;; If we go down a menu item, go to the end of the node
2548 ;; so we can scroll back through it.
2558 ;; If we go down a menu item, go to the end of the node
2559 ;; so we can scroll back through it.
2570 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2571 Once you scroll far enough in a node that its menu appears on the screen
2572 but after point, the next scroll moves into its first subnode, unless
2573 `Info-scroll-prefer-subnodes' is nil.
2575 When you scroll past the end of a node, that goes to the next node if
2576 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2577 if this node has no successor, it moves to the parent node's successor,
2578 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2579 the menu of a node, it moves to subnode indicated by the following menu
2580 item. (That case won't normally result from this command, but can happen
2581 in other ways.)"
2603 "Scroll one screenful forward in Info, using the mouse.
2604 See `Info-scroll-up'."
2612 "Scroll one screenful back in Info, considering all nodes as one sequence.
2613 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2614 is non-nil, this goes to its last subnode. When you scroll past the
2615 beginning of a node, that goes to the previous node or back up to the
2616 parent node."
2630 current-point
2631 t)))))
2638 "Scroll one screenful backward in Info, using the mouse.
2639 See `Info-scroll-down'."
2647 "Move cursor to the next cross-reference or menu item in the node."
2669 "Move cursor to the previous cross-reference or menu item in the node."
2688 \f
2690 "Alist of cached index node names of visited Info files.
2694 "Return a list of names of all index nodes in Info FILE.
2695 If FILE is omitted, it defaults to the current Info file.
2696 First look in a list of cached index node names. Then scan Info
2697 file and its subfiles for nodes with the index cookie. Then try
2698 to find index nodes starting from the first node in the top level
2703 ;; Skip virtual Info files
2708 ;; Find nodes with index cookie
2712 default-directory))
2713 Info-history Info-history-list Info-fontify-maximum-menu-size
2733 subfiles)))))
2735 main-file nil))
2741 nodes)
2742 ;; Else find nodes with the word "Index" in the node name
2744 Info-history Info-history-list Info-fontify-maximum-menu-size
2745 nodes node)
2763 nodes))
2764 ;; If file has no index nodes, still add it to the cache
2769 "Return non-nil value if NODE is an index node.
2770 If NODE is nil, check the current Info node.
2771 If FILE is nil, check the current Info file."
2775 ;; Don't search all index nodes if request is only for the current node
2776 ;; and file is not in the cache of index nodes
2790 "Go to the first index node."
2795 ;;;###autoload
2797 "Look up a string TOPIC in the index for this manual and go to that entry.
2798 If there are no exact matches to the specified topic, this chooses
2799 the first match which is a case-insensitive substring of a topic.
2801 Give an empty topic name to go to the Index node itself."
2817 ;; Strip leading colon in topic; index format does not allow them.
2823 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2832 ;; We bind Info-history to nil for internal node-switches so
2833 ;; that we don't put junk in the history. In the first
2834 ;; Info-goto-index call, above, we do update the history
2835 ;; because that is what the user's previous node choice into it.
2837 found)
2844 Info-current-node
2847 matches))
2854 ;; Here it is a feature that assoc is case-sensitive.
2887 'Info-index-next overriding-local-map
2888 t)))
2892 "Move point to the place within the current node where NAME is defined."
2897 ;; Find a function definition with a return type.
2905 nil t))
2907 ;; Try again without the " <1>" makeinfo can append
2913 ;;;###autoload
2915 "Grovel indices of all known Info files on your system for STRING.
2916 Build a menu of the possible matches."
2919 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2925 manuals matches node nodes)
2928 ;; current-node and current-file are nil when they invoke info-apropos
2929 ;; as the first Info command, i.e. info-apropos loads info.el. In that
2930 ;; case, we use (DIR)Top instead, to avoid signalling an error after
2931 ;; the search is complete.
2939 ;; add-to-list makes sure we don't have duplicates in `manuals',
2940 ;; so that the following dolist loop runs faster.
2957 matches)))
2966 Info-history-list ohist-list)
2987 "Make command be undefined in Info."
2992 "Enter the Info tutorial."
2997 "Help-Small-Screen"
3001 "Display a brief summary of all Info commands."
3016 flag))
3019 \f
3021 "Return the token around POS.
3022 POS must be somewhere inside the token
3023 START is a regular expression which will match the
3024 beginning of the tokens delimited string
3025 ALL is a regular expression with a single
3026 parenthesized subpattern which is the token to be
3027 returned. E.g. '{\(.*\)}' would return any string
3028 enclosed in braces around POS.
3029 ERRORSTRING optional fourth argument, controls action on no match
3030 nil: return nil
3031 t: beep
3032 a string: signal an error, using that string."
3036 ;; First look for a match for START that goes across POS.
3040 ;; If we did not find one, search back for START
3041 ;; (this finds only matches that end at or before POS).
3054 nil)
3057 nil)
3063 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3064 At end of the node's text, moves to the next node, or up if none."
3072 "Follow a node reference near point.
3073 If point is on a reference, follow that reference. Otherwise,
3074 if point is in a menu item description, follow that menu item.
3076 If FORK is non-nil (interactively with a prefix arg), show the node in
3077 a new Info buffer.
3078 If FORK is a string, it is the name to use for the new buffer."
3090 t)))
3093 ;; Common subroutine.
3095 "Follow a node reference near point. Return non-nil if successful.
3096 If FORK is non-nil, it i spassed to `Info-goto-node'."
3105 ;; menu item: node name
3108 ;; menu item: node name or index entry
3122 node))
3123 \f
3127 nil
3137 (define-key Info-mode-map "1" 'Info-nth-menu-item)
3138 (define-key Info-mode-map "2" 'Info-nth-menu-item)
3139 (define-key Info-mode-map "3" 'Info-nth-menu-item)
3140 (define-key Info-mode-map "4" 'Info-nth-menu-item)
3141 (define-key Info-mode-map "5" 'Info-nth-menu-item)
3142 (define-key Info-mode-map "6" 'Info-nth-menu-item)
3143 (define-key Info-mode-map "7" 'Info-nth-menu-item)
3144 (define-key Info-mode-map "8" 'Info-nth-menu-item)
3145 (define-key Info-mode-map "9" 'Info-nth-menu-item)
3146 (define-key Info-mode-map "0" 'undefined)
3147 (define-key Info-mode-map "?" 'Info-summary)
3148 (define-key Info-mode-map "]" 'Info-forward-node)
3149 (define-key Info-mode-map "[" 'Info-backward-node)
3150 (define-key Info-mode-map "<" 'Info-top-node)
3151 (define-key Info-mode-map ">" 'Info-final-node)
3152 (define-key Info-mode-map "b" 'beginning-of-buffer)
3153 (define-key Info-mode-map "d" 'Info-directory)
3154 (define-key Info-mode-map "e" 'Info-edit)
3155 (define-key Info-mode-map "f" 'Info-follow-reference)
3156 (define-key Info-mode-map "g" 'Info-goto-node)
3157 (define-key Info-mode-map "h" 'Info-help)
3158 (define-key Info-mode-map "i" 'Info-index)
3159 (define-key Info-mode-map "l" 'Info-history-back)
3160 (define-key Info-mode-map "L" 'Info-history)
3161 (define-key Info-mode-map "m" 'Info-menu)
3162 (define-key Info-mode-map "n" 'Info-next)
3163 (define-key Info-mode-map "p" 'Info-prev)
3164 (define-key Info-mode-map "q" 'Info-exit)
3165 (define-key Info-mode-map "r" 'Info-history-forward)
3166 (define-key Info-mode-map "s" 'Info-search)
3167 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
3168 ;; For consistency with Rmail.
3169 (define-key Info-mode-map "\M-s" 'Info-search)
3170 (define-key Info-mode-map "\M-n" 'clone-buffer)
3171 (define-key Info-mode-map "t" 'Info-top-node)
3172 (define-key Info-mode-map "T" 'Info-toc)
3173 (define-key Info-mode-map "u" 'Info-up)
3174 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3175 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
3176 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
3177 ;; `^' for consistency with `dired-up-directory'.
3178 (define-key Info-mode-map "^" 'Info-up)
3179 (define-key Info-mode-map "," 'Info-index-next)
3181 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
3182 (define-key Info-mode-map [follow-link] 'mouse-face)
3183 )
3185 (defun Info-check-pointer (item)
3186 "Non-nil if ITEM is present in this node."
3187 (condition-case nil
3188 (Info-extract-pointer item)
3189 (error nil)))
3191 (easy-menu-define
3192 Info-mode-menu Info-mode-map
3193 "Menu for Info files."
3194 '("Info"
3195 ["Up" Info-up :active (Info-check-pointer "up")
3196 :help "Go up in the Info tree"]
3197 ["Next" Info-next :active (Info-check-pointer "next")
3198 :help "Go to the next node"]
3199 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3200 :help "Go to the previous node"]
3201 ["Backward" Info-backward-node
3202 :help "Go backward one node, considering all as a sequence"]
3203 ["Forward" Info-forward-node
3204 :help "Go forward one node, considering all as a sequence"]
3205 ["Beginning" beginning-of-buffer
3206 :help "Go to beginning of this node"]
3207 ["Top" Info-top-node
3208 :help "Go to top node of file"]
3209 ["Final Node" Info-final-node
3210 :help "Go to final node in this file"]
3211 ("Menu Item" ["You should never see this" report-emacs-bug t])
3212 ("Reference" ["You should never see this" report-emacs-bug t])
3213 ["Search..." Info-search
3214 :help "Search for regular expression in this Info file"]
3215 ["Search Next" Info-search-next
3216 :help "Search for another occurrence of regular expression"]
3217 ["Go to Node..." Info-goto-node
3218 :help "Go to a named node"]
3219 ["Back in history" Info-history-back :active Info-history
3220 :help "Go back in history to the last node you were at"]
3221 ["Forward in history" Info-history-forward :active Info-history-forward
3222 :help "Go forward in history"]
3223 ["History" Info-history :active Info-history-list
3224 :help "Go to menu of visited nodes"]
3225 ["Table of Contents" Info-toc
3226 :help "Go to table of contents"]
3227 ("Index"
3228 ["Lookup a String..." Info-index
3229 :help "Look for a string in the index items"]
3230 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3231 :help "Look for another occurrence of previous item"]
3232 ["Lookup a string in all indices..." info-apropos
3233 :help "Look for a string in the indices of all manuals"])
3234 ["Copy Node Name" Info-copy-current-node-name
3235 :help "Copy the name of the current node into the kill ring"]
3236 ["Clone Info buffer" clone-buffer
3237 :help "Create a twin copy of the current Info buffer."]
3238 ["Exit" Info-exit :help "Stop reading Info"]))
3241 (defvar info-tool-bar-map
3242 (if (display-graphic-p)
3243 (let ((map (make-sparse-keymap)))
3244 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map
3245 :rtl "right-arrow")
3246 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map
3247 :rtl "left-arrow")
3248 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map
3249 :rtl "next-node")
3250 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map
3251 :rtl "prev-node")
3252 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3253 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3254 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3255 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3256 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3257 (tool-bar-local-item-from-menu 'Info-exit "exit" map Info-mode-map)
3258 map)))
3260 (defvar Info-menu-last-node nil)
3261 ;; Last node the menu was created for.
3262 ;; Value is a list, (FILE-NAME NODE-NAME).
3264 (defun Info-menu-update ()
3265 "Update the Info menu for the current node."
3266 (condition-case nil
3267 (if (or (not (eq major-mode 'Info-mode))
3268 (equal (list Info-current-file Info-current-node)
3269 Info-menu-last-node))
3270 ()
3271 ;; Update menu menu.
3272 (let* ((Info-complete-menu-buffer (current-buffer))
3273 (items (nreverse (condition-case nil
3274 (Info-complete-menu-item "" nil t)
3275 (error nil))))
3276 entries current
3277 (number 0))
3278 (while (and items (< number 9))
3279 (setq current (car items)
3280 items (cdr items)
3281 number (1+ number))
3282 (setq entries (cons `[,current
3283 (Info-menu ,current)
3284 :keys ,(format "%d" number)]
3285 entries)))
3286 (if items
3287 (setq entries (cons ["Other..." Info-menu t] entries)))
3288 (or entries
3289 (setq entries (list ["No menu" nil nil] nil :active)))
3290 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3291 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3292 (let ((items nil)
3293 str i entries current
3294 (number 0)
3295 (case-fold-search t))
3296 (save-excursion
3297 (goto-char (point-min))
3299 (setq str (match-string 1))
3300 (setq i 0)
3302 (setq str (concat (substring str 0 i) " "
3303 (substring str (match-end 0))))
3304 (setq i (1+ i)))
3305 (setq items
3306 (cons str items))))
3307 (while (and items (< number 9))
3308 (setq current (car items)
3309 items (cdr items)
3310 number (1+ number))
3311 (setq entries (cons `[,current
3312 (Info-follow-reference ,current)
3313 t]
3314 entries)))
3315 (if items
3316 (setq entries (cons ["Other..." Info-follow-reference t]
3317 entries)))
3318 (or entries
3319 (setq entries (list ["No references" nil nil] nil :active)))
3320 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3321 ;; Update last seen node.
3322 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3323 ;; Try to avoid entering infinite beep mode in case of errors.
3324 (error (ding))))
3326 \f
3327 (defun Info-copy-current-node-name (&optional arg)
3328 "Put the name of the current Info node into the kill ring.
3329 The name of the Info file is prepended to the node name in parentheses.
3330 With a zero prefix arg, put the name inside a function call to `info'."
3331 (interactive "P")
3332 (unless Info-current-node
3333 (error "No current Info node"))
3334 (let ((node (if (stringp Info-current-file)
3335 (concat "(" (file-name-nondirectory Info-current-file) ") "
3336 Info-current-node))))
3337 (if (zerop (prefix-numeric-value arg))
3339 (unless (stringp Info-current-file)
3340 (setq node (format "(Info-find-node '%S '%S)"
3341 Info-current-file Info-current-node)))
3342 (kill-new node)
3343 (message "%s" node)))
3345 \f
3346 ;; Info mode is suitable only for specially formatted data.
3347 (put 'Info-mode 'mode-class 'special)
3348 (put 'Info-mode 'no-clone-indirect t)
3350 (defvar tool-bar-map)
3351 (defvar bookmark-make-record-function)
3353 ;; Autoload cookie needed by desktop.el
3354 ;;;###autoload
3355 (defun Info-mode ()
3356 "Info mode provides commands for browsing through the Info documentation tree.
3358 one topic and contains references to other nodes which discuss related
3359 topics. Info has commands to follow the references and show you other nodes.
3365 Selecting other nodes:
3367 Follow a node reference you click on.
3368 This works with menu items, cross references, and
3370 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3375 Picking a menu item causes another node to be selected.
3385 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3389 Moving within a node:
3391 Once you scroll far enough in a node that its menu appears on the
3392 screen but after point, the next scroll moves into its first
3393 subnode. When after all menu items (or if there is no menu),
3394 move up to the parent node.
3396 already visible, try to go to the previous menu entry, or up
3397 if there is none.
3400 Advanced commands:
3402 and select the node in which the next occurrence is found.
3403 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3407 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3410 You may include a filename as well, as (FILENAME)NODENAME.
3411 1 .. 9 Pick first ... ninth item in node's menu.
3412 Every third `*' is highlighted to help pick the right number.
3416 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3417 (kill-all-local-variables)
3418 (setq major-mode 'Info-mode)
3419 (setq mode-name "Info")
3420 (setq tab-width 8)
3421 (use-local-map Info-mode-map)
3422 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3423 (set-syntax-table text-mode-syntax-table)
3424 (setq local-abbrev-table text-mode-abbrev-table)
3425 (setq case-fold-search t)
3426 (setq buffer-read-only t)
3427 (make-local-variable 'Info-current-file)
3428 (make-local-variable 'Info-current-subfile)
3429 (make-local-variable 'Info-current-node)
3430 (make-local-variable 'Info-tag-table-marker)
3431 (setq Info-tag-table-marker (make-marker))
3432 (make-local-variable 'Info-tag-table-buffer)
3433 (setq Info-tag-table-buffer nil)
3434 (make-local-variable 'Info-history)
3435 (make-local-variable 'Info-history-forward)
3436 (make-local-variable 'Info-index-alternatives)
3437 (setq header-line-format
3438 (if Info-use-header-line
3439 '(:eval (get-text-property (point-min) 'header-line))
3440 nil)) ; so the header line isn't displayed
3441 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3442 ;; This is for the sake of the invisible text we use handling titles.
3443 (make-local-variable 'line-move-ignore-invisible)
3444 (setq line-move-ignore-invisible t)
3445 (make-local-variable 'desktop-save-buffer)
3446 (make-local-variable 'widen-automatically)
3447 (setq widen-automatically nil)
3448 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3449 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3450 (add-hook 'clone-buffer-hook 'Info-clone-buffer nil t)
3451 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3452 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3453 (set (make-local-variable 'isearch-search-fun-function)
3454 'Info-isearch-search)
3455 (set (make-local-variable 'isearch-wrap-function)
3456 'Info-isearch-wrap)
3457 (set (make-local-variable 'isearch-push-state-function)
3458 'Info-isearch-push-state)
3459 (set (make-local-variable 'isearch-success-function)
3460 'Info-search-success-function)
3461 (set (make-local-variable 'search-whitespace-regexp)
3462 Info-search-whitespace-regexp)
3463 (set (make-local-variable 'revert-buffer-function)
3464 'Info-revert-buffer-function)
3465 (Info-set-mode-line)
3466 (set (make-local-variable 'bookmark-make-record-function)
3467 'Info-bookmark-make-record)
3468 (run-mode-hooks 'Info-mode-hook))
3470 ;; When an Info buffer is killed, make sure the associated tags buffer
3471 ;; is killed too.
3472 (defun Info-kill-buffer ()
3473 (and (eq major-mode 'Info-mode)
3474 Info-tag-table-buffer
3475 (kill-buffer Info-tag-table-buffer)))
3477 ;; Placed on `clone-buffer-hook'.
3478 (defun Info-clone-buffer ()
3479 (when (bufferp Info-tag-table-buffer)
3480 (setq Info-tag-table-buffer
3481 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3482 (let ((m Info-tag-table-marker))
3483 (when (markerp m)
3484 (setq Info-tag-table-marker
3485 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3486 (with-current-buffer Info-tag-table-buffer
3487 (copy-marker (marker-position m)))
3488 (make-marker))))))
3490 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3491 (set-keymap-parent map text-mode-map)
3492 (define-key map "\C-c\C-c" 'Info-cease-edit)
3493 map)
3494 "Local keymap used within `e' command of Info.")
3496 ;; Info-edit mode is suitable only for specially formatted data.
3497 (put 'Info-edit-mode 'mode-class 'special)
3499 (defun Info-edit-mode ()
3500 "Major mode for editing the contents of an Info node.
3501 Like text mode with the addition of `Info-cease-edit'
3502 which returns to Info mode for browsing.
3504 (use-local-map Info-edit-map)
3505 (setq major-mode 'Info-edit-mode)
3506 (setq mode-name "Info Edit")
3507 (kill-local-variable 'mode-line-buffer-identification)
3508 (setq buffer-read-only nil)
3509 (force-mode-line-update)
3510 (buffer-enable-undo (current-buffer))
3511 (run-mode-hooks 'Info-edit-mode-hook))
3513 (defun Info-edit ()
3514 "Edit the contents of this Info node.
3515 Allowed only if variable `Info-enable-edit' is non-nil."
3516 (interactive)
3517 (or Info-enable-edit
3518 (error "Editing Info nodes is not enabled"))
3519 (Info-edit-mode)
3520 (message "%s" (substitute-command-keys
3523 (defun Info-cease-edit ()
3524 "Finish editing Info node; switch back to Info proper."
3525 (interactive)
3526 ;; Do this first, so nothing has changed if user C-g's at query.
3527 (and (buffer-modified-p)
3528 (y-or-n-p "Save the file? ")
3529 (save-buffer))
3530 (use-local-map Info-mode-map)
3531 (setq major-mode 'Info-mode)
3532 (setq mode-name "Info")
3533 (Info-set-mode-line)
3534 (setq buffer-read-only t)
3535 (force-mode-line-update)
3536 (and (marker-position Info-tag-table-marker)
3537 (buffer-modified-p)
3538 (message "Tags may have changed. Use Info-tagify if necessary")))
3539 \f
3540 (defvar Info-file-list-for-emacs
3541 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3542 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3543 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3544 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3545 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3546 ("copyright" . "autotype") ("executable" . "autotype")
3547 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3548 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3549 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3550 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3551 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3552 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3553 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3554 ("rfc2045" . "emacs-mime")
3555 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3556 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3557 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3558 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3559 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3560 ("mml" . "emacs-mime"))
3561 "List of Info files that describe Emacs commands.
3562 An element can be a file name, or a list of the form (PREFIX . FILE)
3563 where PREFIX is a name prefix and FILE is the file to look in.
3564 If the element is just a file name, the file name also serves as the prefix.")
3566 (defun Info-find-emacs-command-nodes (command)
3567 "Return a list of locations documenting COMMAND.
3568 The `info-file' property of COMMAND says which Info manual to search.
3569 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3570 defines heuristics for which Info manual to try.
3571 The locations are of the format used in `Info-history', i.e.
3572 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3573 in the first element of the returned list (which is treated specially in
3574 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3575 (let ((where '()) line-number
3579 (info-file "emacs")) ;default
3580 ;; Determine which Info file this command is documented in.
3581 (if (get command 'info-file)
3582 (setq info-file (get command 'info-file))
3583 ;; If it doesn't say explicitly, test its name against
3584 ;; various prefixes that we know.
3585 (let ((file-list Info-file-list-for-emacs))
3586 (while file-list
3587 (let* ((elt (car file-list))
3588 (name (if (consp elt)
3589 (car elt)
3590 elt))
3591 (file (if (consp elt) (cdr elt) elt))
3592 (case-fold-search nil)
3595 (if (string-match regexp (symbol-name command))
3596 (setq info-file file file-list nil))
3597 (setq file-list (cdr file-list))))))
3598 (Info-find-node info-file "Top")
3599 ;; Bind Info-history to nil, to prevent the index nodes from
3600 ;; getting into the node history.
3601 (let ((Info-history nil)
3602 (Info-history-list nil)
3603 node (nodes (Info-index-nodes)))
3604 (Info-goto-node (car nodes))
3605 (while
3606 (progn
3607 (goto-char (point-min))
3608 (while (re-search-forward cmd-desc nil t)
3609 (setq where
3610 (cons (list Info-current-file
3611 (match-string-no-properties 2)
3612 0)
3613 where))
3614 (setq line-number (and (match-beginning 3)
3615 (string-to-number (match-string 3)))))
3616 (and (setq nodes (cdr nodes) node (car nodes))))
3617 (Info-goto-node node)))
3618 (if (and line-number where)
3619 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3620 (cdr where))
3621 where)))
3623 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3624 ;;;###autoload
3625 (defun Info-goto-emacs-command-node (command)
3626 "Go to the Info node in the Emacs manual for command COMMAND.
3627 The command is found by looking up in Emacs manual's indices
3628 or in another manual found via COMMAND's `info-file' property or
3629 the variable `Info-file-list-for-emacs'.
3630 COMMAND must be a symbol or string."
3631 (interactive "CFind documentation for command: ")
3632 ;; If command is given as a string, convert it to a symbol.
3633 (if (stringp command)
3634 (setq command (intern command)))
3635 (or (commandp command)
3636 (signal 'wrong-type-argument (list 'commandp command)))
3637 (let ((where (Info-find-emacs-command-nodes command)))
3638 (if where
3639 (let ((num-matches (length where)))
3640 ;; Get Info running, and pop to it in another window.
3641 (save-window-excursion
3642 (info))
3643 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3644 ;; Bind Info-history to nil, to prevent the last Index node
3645 ;; visited by Info-find-emacs-command-nodes from being
3646 ;; pushed onto the history.
3647 (let ((Info-history nil) (Info-history-list nil)
3648 (line-number (nth 2 (car where))))
3649 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3650 (if (and (integerp line-number) (> line-number 0))
3651 (forward-line (1- line-number))))
3652 (if (> num-matches 1)
3653 (progn
3654 ;; (car where) will be pushed onto Info-history
3655 ;; when/if they go to another node. Put the other
3656 ;; nodes that were found on the history.
3657 (setq Info-history (nconc (cdr where) Info-history))
3658 (message "Found %d other entr%s. Use %s to see %s."
3659 (1- num-matches)
3660 (if (> num-matches 2) "ies" "y")
3662 (if (> num-matches 2) "them" "it")))))
3663 (error "Couldn't find documentation for %s" command))))
3665 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3666 ;;;###autoload
3667 (defun Info-goto-emacs-key-command-node (key)
3668 "Go to the node in the Emacs manual which describes the command bound to KEY.
3669 KEY is a string.
3670 Interactively, if the binding is `execute-extended-command', a command is read.
3671 The command is found by looking up in Emacs manual's indices
3672 or in another manual found via COMMAND's `info-file' property or
3673 the variable `Info-file-list-for-emacs'."
3674 (interactive "kFind documentation for key: ")
3675 (let ((command (key-binding key)))
3676 (cond ((null command)
3677 (message "%s is undefined" (key-description key)))
3678 ((and (interactive-p)
3679 (eq command 'execute-extended-command))
3680 (Info-goto-emacs-command-node
3681 (read-command "Find documentation for command: ")))
3682 (t
3683 (Info-goto-emacs-command-node command)))))
3684 \f
3685 (defvar Info-next-link-keymap
3686 (let ((keymap (make-sparse-keymap)))
3687 (define-key keymap [header-line mouse-1] 'Info-next)
3688 (define-key keymap [header-line mouse-2] 'Info-next)
3689 (define-key keymap [header-line down-mouse-1] 'ignore)
3690 (define-key keymap [mouse-2] 'Info-next)
3691 (define-key keymap [follow-link] 'mouse-face)
3692 keymap)
3693 "Keymap to put on the Next link in the text or the header line.")
3695 (defvar Info-prev-link-keymap
3696 (let ((keymap (make-sparse-keymap)))
3697 (define-key keymap [header-line mouse-1] 'Info-prev)
3698 (define-key keymap [header-line mouse-2] 'Info-prev)
3699 (define-key keymap [header-line down-mouse-1] 'ignore)
3700 (define-key keymap [mouse-2] 'Info-prev)
3701 (define-key keymap [follow-link] 'mouse-face)
3702 keymap)
3703 "Keymap to put on the Prev link in the text or the header line.")
3705 (defvar Info-up-link-keymap
3706 (let ((keymap (make-sparse-keymap)))
3707 (define-key keymap [header-line mouse-1] 'Info-up)
3708 (define-key keymap [header-line mouse-2] 'Info-up)
3709 (define-key keymap [header-line down-mouse-1] 'ignore)
3710 (define-key keymap [mouse-2] 'Info-up)
3711 (define-key keymap [follow-link] 'mouse-face)
3712 keymap)
3713 "Keymap to put on the Up link in the text or the header line.")
3715 (defun Info-fontify-node ()
3716 "Fontify the node."
3717 (save-excursion
3718 (let* ((inhibit-read-only t)
3719 (case-fold-search t)
3720 paragraph-markers
3721 (not-fontified-p ; the node hasn't already been fontified
3722 (not (let ((where (next-single-property-change (point-min)
3723 'font-lock-face)))
3724 (and where (not (= where (point-max)))))))
3725 (fontify-visited-p ; visited nodes need to be re-fontified
3726 (and Info-fontify-visited-nodes
3727 ;; Don't take time to refontify visited nodes in huge nodes
3728 Info-fontify-maximum-menu-size
3729 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3730 rbeg rend)
3732 ;; Fontify header line
3733 (goto-char (point-min))
3735 (goto-char (match-end 0))
3737 (goto-char (match-end 0))
3738 (let* ((nbeg (match-beginning 2))
3739 (nend (match-end 2))
3740 (tbeg (match-beginning 1))
3741 (tag (match-string 1)))
3742 (if (string-equal (downcase tag) "node")
3743 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3744 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3745 (put-text-property tbeg nend 'mouse-face 'highlight)
3746 (put-text-property tbeg nend
3747 'help-echo
3748 (concat "mouse-2: Go to node "
3749 (buffer-substring nbeg nend)))
3750 ;; Always set up the text property keymap.
3751 ;; It will either be used in the buffer
3752 ;; or copied in the header line.
3753 (put-text-property
3754 tbeg nend 'keymap
3755 (cond
3756 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3757 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3758 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3759 (when Info-use-header-line
3760 (goto-char (point-min))
3761 (let* ((header-end (line-end-position))
3762 (header
3763 ;; If we find neither Next: nor Prev: link, show the entire
3764 ;; node header. Otherwise, don't show the File: and Node:
3765 ;; parts, to avoid wasting precious space on information that
3766 ;; is available in the mode line.
3767 (if (re-search-forward
3769 header-end t)
3770 (progn
3771 (goto-char (match-beginning 1))
3772 (buffer-substring (point) header-end))
3774 header-end t)
3775 (concat "No next, prev or up links -- "
3776 (buffer-substring (point) header-end))
3777 (buffer-substring (point) header-end)))))
3778 (put-text-property (point-min) (1+ (point-min))
3779 'header-line
3780 (replace-regexp-in-string
3781 "%"
3782 ;; Preserve text properties on duplicated `%'.
3783 (lambda (s) (concat s s)) header))
3784 ;; Hide the part of the first line
3785 ;; that is in the header, if it is just part.
3786 (unless (bobp)
3787 ;; Hide the punctuation at the end, too.
3789 (put-text-property (point) header-end 'invisible t)))))
3791 ;; Fontify titles
3792 (goto-char (point-min))
3793 (when (and font-lock-mode not-fontified-p)
3795 nil t)
3796 ;; Only consider it as an underlined title if the ASCII
3797 ;; underline has the same size as the text. A typical
3798 ;; counter example is when a continuation "..." is alone
3799 ;; on a line.
3800 (= (string-width (match-string 1))
3801 (string-width (match-string 2))))
3802 (let* ((c (preceding-char))
3803 (face
3804 (cond ((= c ?*) 'info-title-1)
3805 ((= c ?=) 'info-title-2)
3806 ((= c ?-) 'info-title-3)
3807 (t 'info-title-4))))
3808 (put-text-property (match-beginning 1) (match-end 1)
3809 'font-lock-face face))
3810 ;; This is a serious problem for trying to handle multiple
3811 ;; frame types at once. We want this text to be invisible
3812 ;; on frames that can display the font above.
3813 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3814 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3815 '(invisible t front-sticky nil rear-nonsticky t)))))
3817 ;; Fontify cross references
3818 (goto-char (point-min))
3819 (when (or not-fontified-p fontify-visited-p)
3820 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3821 (let ((start (match-beginning 0))
3822 (next (point))
3823 other-tag)
3824 (when not-fontified-p
3825 (when Info-hide-note-references
3826 (when (not (eq Info-hide-note-references 'hide))
3827 ;; *Note is often used where *note should have been
3828 (goto-char start)
3829 (skip-syntax-backward " ")
3830 (when (memq (char-before) '(?\( ?\[ ?\{))
3831 ;; Check whether the paren is preceded by
3832 ;; an end of sentence
3833 (skip-syntax-backward " ("))
3834 (setq other-tag
3836 "")
3838 "")
3839 ((memq (char-before) '(nil ?\. ?! ??))
3840 "See ")
3841 ((save-match-data
3842 (save-excursion
3844 "See ")
3845 (t "see "))))
3846 (goto-char next)
3847 (add-text-properties
3848 (match-beginning 1)
3849 (or (save-match-data
3851 (let ((start1 (match-beginning 1)))
3853 (+ start1 (match-beginning 0)))))
3854 (match-end 1))
3855 (if other-tag
3856 `(display ,other-tag front-sticky nil rear-nonsticky t)
3857 '(invisible t front-sticky nil rear-nonsticky t))))
3858 (add-text-properties
3859 (match-beginning 2) (match-end 2)
3860 (list
3861 'help-echo (if (or (match-end 5)
3862 (not (equal (match-string 4) "")))
3863 (concat "mouse-2: go to " (or (match-string 5)
3864 (match-string 4)))
3865 "mouse-2: go to this node")
3866 'mouse-face 'highlight)))
3867 (when (or not-fontified-p fontify-visited-p)
3868 (setq rbeg (match-beginning 2)
3869 rend (match-end 2))
3870 (put-text-property
3871 rbeg rend
3872 'font-lock-face
3873 ;; Display visited nodes in a different face
3874 (if (and Info-fontify-visited-nodes
3875 (save-match-data
3876 (let* ((node (replace-regexp-in-string
3878 (replace-regexp-in-string
3880 (or (match-string-no-properties 5)
3881 (and (not (equal (match-string 4) ""))
3882 (match-string-no-properties 4))
3883 (match-string-no-properties 2)))))
3884 (external-link-p
3886 (file (if external-link-p
3887 (file-name-nondirectory
3888 (match-string-no-properties 1 node))
3889 Info-current-file))
3890 (hl Info-history-list)
3891 res)
3892 (if external-link-p
3893 (setq node (if (equal (match-string 2 node) "")
3894 "Top"
3895 (match-string-no-properties 2 node))))
3896 (while hl
3897 (if (and (string-equal node (nth 1 (car hl)))
3898 (equal file
3899 (if (and external-link-p
3900 (stringp (caar hl)))
3901 (file-name-nondirectory
3902 (caar hl))
3903 (caar hl))))
3904 (setq res (car hl) hl nil)
3905 (setq hl (cdr hl))))
3906 res))) 'info-xref-visited 'info-xref))
3907 ;; For multiline ref, unfontify newline and surrounding whitespace
3908 (save-excursion
3909 (goto-char rbeg)
3910 (save-match-data
3912 (remove-text-properties (match-beginning 0)
3913 (match-end 0)
3914 '(font-lock-face t))))))
3915 (when not-fontified-p
3916 (when (memq Info-hide-note-references '(t hide))
3917 (add-text-properties (match-beginning 3) (match-end 3)
3918 '(invisible t front-sticky nil rear-nonsticky t))
3919 ;; Unhide the file name of the external reference in parens
3920 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3921 (remove-text-properties (match-beginning 6) (match-end 6)
3922 '(invisible t front-sticky nil rear-nonsticky t)))
3923 ;; Unhide newline because hidden newlines cause too long lines
3924 (save-match-data
3925 (let ((beg3 (match-beginning 3))
3926 (end3 (match-end 3)))
3928 (not (save-match-data
3929 (save-excursion
3930 (goto-char (1+ end3))
3931 (looking-at "[.)]*$")))))
3932 (remove-text-properties (+ beg3 (match-beginning 0))
3933 (+ beg3 (match-end 0))
3934 '(invisible t front-sticky nil rear-nonsticky t))))))
3935 (when (and Info-refill-paragraphs Info-hide-note-references)
3936 (push (set-marker (make-marker) start)
3937 paragraph-markers))))))
3939 ;; Refill paragraphs (experimental feature)
3940 (when (and not-fontified-p
3941 Info-refill-paragraphs
3942 paragraph-markers)
3943 (let ((fill-nobreak-invisible t)
3944 (fill-individual-varying-indent nil)
3947 (adaptive-fill-mode nil))
3948 (goto-char (point-max))
3949 (dolist (m paragraph-markers)
3950 (when (< m (point))
3951 (goto-char m)
3952 (beginning-of-line)
3953 (let ((beg (point)))
3954 (when (zerop (forward-paragraph))
3955 (fill-individual-paragraphs beg (point) nil nil)
3956 (goto-char beg))))
3957 (set-marker m nil))))
3959 ;; Fontify menu items
3960 (goto-char (point-min))
3961 (when (and (or not-fontified-p fontify-visited-p)
3963 ;; Don't take time to annotate huge menus
3964 Info-fontify-maximum-menu-size
3965 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3966 (let ((n 0)
3967 cont)
3968 (while (re-search-forward
3971 nil t)
3972 (when (match-beginning 1)
3973 (when not-fontified-p
3974 (setq n (1+ n))
3975 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3976 (put-text-property (match-beginning 0)
3977 (1+ (match-beginning 0))
3978 'font-lock-face 'info-menu-star)))
3979 (when not-fontified-p
3980 (add-text-properties
3981 (match-beginning 1) (match-end 1)
3982 (list
3983 'help-echo (if (and (match-end 3)
3984 (not (equal (match-string 3) "")))
3985 (concat "mouse-2: go to " (match-string 3))
3986 "mouse-2: go to this node")
3987 'mouse-face 'highlight)))
3988 (when (or not-fontified-p fontify-visited-p)
3989 (put-text-property
3990 (match-beginning 1) (match-end 1)
3991 'font-lock-face
3992 ;; Display visited menu items in a different face
3993 (if (and Info-fontify-visited-nodes
3994 (save-match-data
3995 (let* ((node (if (equal (match-string 3) "")
3996 (match-string-no-properties 1)
3997 (match-string-no-properties 3)))
3998 (external-link-p
4000 (file (if external-link-p
4001 (file-name-nondirectory
4002 (match-string-no-properties 1 node))
4003 Info-current-file))
4004 (hl Info-history-list)
4005 res)
4006 (if external-link-p
4007 (setq node (if (equal (match-string 2 node) "")
4008 "Top"
4009 (match-string-no-properties 2 node))))
4010 (while hl
4011 (if (and (string-equal node (nth 1 (car hl)))
4012 (equal file
4013 (if (and external-link-p
4014 (stringp (caar hl)))
4015 (file-name-nondirectory
4016 (caar hl))
4017 (caar hl))))
4018 (setq res (car hl) hl nil)
4019 (setq hl (cdr hl))))
4020 res))) 'info-xref-visited 'info-xref)))
4021 (when (and not-fontified-p
4022 (memq Info-hide-note-references '(t hide))
4023 (not (Info-index-node)))
4024 (put-text-property (match-beginning 2) (1- (match-end 6))
4025 'invisible t)
4026 ;; Unhide the file name in parens
4027 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
4028 (remove-text-properties (match-beginning 4) (match-end 4)
4029 '(invisible t)))
4030 ;; We need a stretchable space like :align-to but with
4031 ;; a minimum value.
4032 (put-text-property (1- (match-end 6)) (match-end 6) 'display
4033 (if (>= 22 (- (match-end 1)
4034 (match-beginning 0)))
4035 '(space :align-to 24)
4036 '(space :width 2)))
4037 (setq cont (looking-at "."))
4038 (while (and (= (forward-line 1) 0)
4040 (put-text-property (match-beginning 1) (1- (match-end 1))
4041 'invisible t)
4042 (put-text-property (1- (match-end 1)) (match-end 1)
4043 'display
4044 (if cont
4045 '(space :align-to 26)
4046 '(space :align-to 24)))
4047 (setq cont t)))))))
4049 ;; Fontify menu headers
4050 ;; Add the face `info-menu-header' to any header before a menu entry
4051 (goto-char (point-min))
4053 (put-text-property (match-beginning 0) (match-end 0)
4054 'font-lock-face 'info-menu-header)
4056 (put-text-property (match-beginning 1) (match-end 1)
4057 'font-lock-face 'info-menu-header)))
4059 ;; Hide index line numbers
4060 (goto-char (point-min))
4061 (when (and not-fontified-p (Info-index-node))
4063 (put-text-property (match-beginning 0) (match-end 0)
4064 'invisible t)))
4066 ;; Fontify http and ftp references
4067 (goto-char (point-min))
4068 (when not-fontified-p
4070 nil t)
4071 (add-text-properties (match-beginning 0) (match-end 0)
4072 '(font-lock-face info-xref
4073 mouse-face highlight
4074 help-echo "mouse-2: go to this URL"))))
4076 (set-buffer-modified-p nil))))
4077 \f
4078 ;;; Speedbar support:
4079 ;; These functions permit speedbar to display the "tags" in the
4080 ;; current Info node.
4081 (eval-when-compile (require 'speedbar))
4083 (defvar Info-speedbar-key-map nil
4084 "Keymap used when in the info display mode.")
4086 (defun Info-install-speedbar-variables ()
4087 "Install those variables used by speedbar to enhance Info."
4088 (if Info-speedbar-key-map
4089 nil
4090 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4092 ;; Basic tree features
4093 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4094 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4095 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4096 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4097 )
4099 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4100 Info-speedbar-key-map
4101 Info-speedbar-hierarchy-buttons)))
4103 (defvar Info-speedbar-menu-items
4104 '(["Browse Node" speedbar-edit-line t]
4105 ["Expand Node" speedbar-expand-line
4106 (save-excursion (beginning-of-line)
4108 ["Contract Node" speedbar-contract-line
4109 (save-excursion (beginning-of-line)
4110 (looking-at "[0-9]+: *.-. "))]
4111 )
4112 "Additional menu-items to add to speedbar frame.")
4114 ;; Make sure our special speedbar major mode is loaded
4115 (if (featurep 'speedbar)
4116 (Info-install-speedbar-variables)
4117 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4119 ;;; Info hierarchy display method
4120 ;;;###autoload
4121 (defun Info-speedbar-browser ()
4122 "Initialize speedbar to display an Info node browser.
4123 This will add a speedbar major display mode."
4124 (interactive)
4125 (require 'speedbar)
4126 ;; Make sure that speedbar is active
4127 (speedbar-frame-mode 1)
4128 ;; Now, throw us into Info mode on speedbar.
4129 (speedbar-change-initial-expansion-list "Info")
4130 )
4132 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4133 "Display an Info directory hierarchy in speedbar.
4134 DIRECTORY is the current directory in the attached frame.
4135 DEPTH is the current indentation depth.
4136 NODE is an optional argument that is used to represent the
4137 specific node to expand."
4138 (if (and (not node)
4139 (save-excursion (goto-char (point-min))
4140 (let ((case-fold-search t))
4141 (looking-at "Info Nodes:"))))
4142 ;; Update our "current node" maybe?
4143 nil
4144 ;; We cannot use the generic list code, that depends on all leaves
4145 ;; being known at creation time.
4146 (if (not node)
4148 (let ((completions nil))
4149 (speedbar-select-attached-frame)
4150 (save-window-excursion
4151 (setq completions
4152 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4153 (select-frame (speedbar-current-frame))
4154 (if completions
4155 (speedbar-with-writable
4156 (dolist (completion completions)
4157 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4158 (cdr completion)
4159 (car completion)
4160 'Info-speedbar-goto-node
4161 (cdr completion)
4162 'info-xref depth))
4163 t)
4164 nil))))
4166 (defun Info-speedbar-goto-node (text node indent)
4167 "When user clicks on TEXT, go to an info NODE.
4168 The INDENT level is ignored."
4169 (speedbar-select-attached-frame)
4170 (let* ((buff (or (get-buffer "*info*")
4171 (progn (info) (get-buffer "*info*"))))
4172 (bwin (get-buffer-window buff 0)))
4173 (if bwin
4174 (progn
4175 (select-window bwin)
4176 (raise-frame (window-frame bwin)))
4177 (if speedbar-power-click
4178 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4179 (speedbar-select-attached-frame)
4180 (switch-to-buffer buff)))
4182 (error "Invalid node %s" node)
4183 (Info-find-node (match-string 1 node) (match-string 2 node))
4184 ;; If we do a find-node, and we were in info mode, restore
4185 ;; the old default method. Once we are in info mode, it makes
4186 ;; sense to return to whatever method the user was using before.
4187 (if (string= speedbar-initial-expansion-list-name "Info")
4188 (speedbar-change-initial-expansion-list
4189 speedbar-previously-used-expansion-list-name)))))
4191 (defun Info-speedbar-expand-node (text token indent)
4192 "Expand the node the user clicked on.
4193 TEXT is the text of the button we clicked on, a + or - item.
4194 TOKEN is data related to this node (NAME . FILE).
4195 INDENT is the current indentation depth."
4196 (cond ((string-match "+" text) ;we have to expand this file
4197 (speedbar-change-expand-button-char ?-)
4198 (if (speedbar-with-writable
4199 (save-excursion
4200 (end-of-line) (forward-char 1)
4201 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4202 (speedbar-change-expand-button-char ?-)
4203 (speedbar-change-expand-button-char ??)))
4204 ((string-match "-" text) ;we have to contract this node
4205 (speedbar-change-expand-button-char ?+)
4206 (speedbar-delete-subblock indent))
4207 (t (error "Ooops... not sure what to do")))
4208 (speedbar-center-buffer-smartly))
4210 (defun Info-speedbar-fetch-file-nodes (nodespec)
4211 "Fetch the subnodes from the info NODESPEC.
4212 NODESPEC is a string of the form: (file)node."
4213 ;; Set up a buffer we can use to fake-out Info.
4214 (with-current-buffer (get-buffer-create " *info-browse-tmp*")
4215 (if (not (equal major-mode 'Info-mode))
4216 (Info-mode))
4217 ;; Get the node into this buffer
4219 (error "Invalid node specification %s" nodespec)
4220 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4221 ;; Scan the created buffer
4222 (goto-char (point-min))
4223 (let ((completions nil)
4224 (case-fold-search t)
4226 (match-string 1 nodespec))))
4227 ;; Always skip the first one...
4230 (let ((name (match-string 1)))
4231 (push (cons name
4233 (match-string 1)
4235 (concat (match-string 1) "Top")
4236 (concat "(" thisfile ")"
4238 (match-string 1)
4239 name)))))
4240 completions)))
4241 (nreverse completions))))
4243 ;;; Info mode node listing
4244 ;; This is called by `speedbar-add-localized-speedbar-support'
4245 (defun Info-speedbar-buttons (buffer)
4246 "Create a speedbar display to help navigation in an Info file.
4247 BUFFER is the buffer speedbar is requesting buttons for."
4248 (if (save-excursion (goto-char (point-min))
4249 (let ((case-fold-search t))
4250 (not (looking-at "Info Nodes:"))))
4251 (erase-buffer))
4252 (Info-speedbar-hierarchy-buttons nil 0))
4254 (dolist (mess '("^First node in file$"
4255 "^No `.*' in index$"
4256 "^No cross-reference named"
4257 "^No cross.references in this node$"
4258 "^No current Info node$"
4259 "^No menu in this node$"
4260 "^No more items in menu$"
4261 "^No more nodes$"
4263 "^No previous `i' command$"
4264 "^No previous items in menu$"
4265 "^No previous nodes$"
4266 "^No such item in menu$"
4267 "^No such node or anchor"
4268 "^Node has no"
4269 "^Point neither on reference nor in menu item description$"
4271 search-failed))
4272 (add-to-list 'debug-ignored-errors mess))
4274 ;;;; Desktop support
4276 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4277 "Auxiliary information to be saved in desktop file."
4278 (unless (member Info-current-file '(apropos history toc nil))
4279 (list Info-current-file Info-current-node)))
4281 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4282 desktop-buffer-name
4283 desktop-buffer-misc)
4284 "Restore an Info buffer specified in a desktop file."
4285 (let ((first (nth 0 desktop-buffer-misc))
4286 (second (nth 1 desktop-buffer-misc)))
4287 (when (and first second)
4288 (when desktop-buffer-name
4289 (set-buffer (get-buffer-create desktop-buffer-name))
4290 (Info-mode))
4291 (Info-find-node first second)
4292 (current-buffer))))
4294 (add-to-list 'desktop-buffer-mode-handlers
4295 '(Info-mode . Info-restore-desktop-buffer))
4297 ;;;; Bookmark support
4299 (defvar bookmark-search-size)
4301 ;; This is only called from bookmark.el.
4302 (declare-function bookmark-buffer-file-name "bookmark" ())
4304 (defun Info-bookmark-make-record ()
4305 `(,Info-current-node
4306 (filename . ,(bookmark-buffer-file-name))
4307 (front-context-string
4308 . ,(if (>= (- (point-max) (point)) bookmark-search-size)
4309 (buffer-substring-no-properties
4310 (point)
4311 (+ (point) bookmark-search-size))
4312 nil))
4313 (rear-context-string
4314 . ,(if (>= (- (point) (point-min)) bookmark-search-size)
4315 (buffer-substring-no-properties
4316 (point)
4317 (- (point) bookmark-search-size))
4318 nil))
4319 (info-node . ,Info-current-node)
4320 (handler . Info-bookmark-jump)))
4323 (defvar bookmark-current-bookmark)
4324 (declare-function bookmark-prop-get "bookmark" (bookmark prop))
4325 (declare-function bookmark-file-or-variation-thereof "bookmark" (file))
4326 (declare-function bookmark-jump-noselect "bookmark" (str))
4327 (declare-function bookmark-get-bookmark-record "bookmark" (bookmark))
4329 ;;;###autoload
4330 (defun Info-bookmark-jump (bmk)
4331 ;; This implements the `handler' function interface for record type returned
4332 ;; by `Info-bookmark-make-record', which see.
4333 (let* ((file (expand-file-name (bookmark-prop-get bmk 'filename)))
4334 (forward-str (bookmark-prop-get bmk 'front-context-string))
4335 (behind-str (bookmark-prop-get bmk 'rear-context-string))
4336 (info-node (bookmark-prop-get bmk 'info-node)))
4337 (if (setq file (bookmark-file-or-variation-thereof file))
4338 (save-excursion
4339 (save-window-excursion
4340 (with-no-warnings
4341 (Info-find-node file info-node))
4342 ;; Go searching forward first. Then, if forward-str exists and was
4343 ;; found in the file, we can search backward for behind-str.
4344 ;; Rationale is that if text was inserted between the two in the
4345 ;; file, it's better to be put before it so you can read it, rather
4346 ;; than after and remain perhaps unaware of the changes.
4347 (if forward-str
4348 (if (search-forward forward-str (point-max) t)
4349 (goto-char (match-beginning 0))))
4350 (if behind-str
4351 (if (search-backward behind-str (point-min) t)
4352 (goto-char (match-end 0))))
4353 `((buffer ,(current-buffer)) (position ,(point))))))))
4355 (provide 'info)
4357 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4358 ;;; info.el ends here