| blob | b274c8258a4fcf391c1ddd091e018b52115fdd1f |
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
685 Info-history))
688 ;;;###autoload
690 "Use Info mode to browse the current Info buffer.
691 With a prefix arg, this queries for the node name to visit first;
692 otherwise, that defaults to `Top'."
702 ;; If called on a non-file buffer, make a fake file name.
706 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
707 ;; but at least it keeps this routine (which is for makeinfo-buffer and
708 ;; Info-revert-buffer-function) out of the way of normal operations.
709 ;;
711 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
712 When *info* is already displaying FILENAME and NODENAME, the window position
713 is preserved, if possible."
729 ;; note goto-line is no good, we want to measure from point-min
736 ;; only add to the history when coming from a different file+node
746 "Find a node in a tag table.
747 MARKER specifies the buffer and position to start searching at.
748 REGEXP is a regular expression matching nodes or references. Its first
749 group should match `Node:' or `Ref:'.
750 CASE-FOLD t means search for a case-insensitive match.
751 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
752 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
753 where the match was found, and MODE is `major-mode' of the buffer in
754 which the match was found."
759 ;; Search tag table
764 major-mode)))))
767 "Find a node in a tag table.
768 MARKER specifies the buffer and position to start searching at.
769 REGEXP is a regular expression matching nodes or references. Its first
770 group should match `Node:' or `Ref:'.
771 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
772 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
773 where the match was found, and MODE is `major-mode' of the buffer in
774 which the match was found.
775 This function tries to find a case-sensitive match first, then a
776 case-insensitive match is tried."
780 result))
783 "Find a node or anchor in the current buffer.
784 REGEXP is a regular expression matching nodes or references. Its first
785 group should match `Node:' or `Ref:'.
786 CASE-FOLD t means search for a case-insensitive match.
787 Value is the position at which a match was found, or nil if not found."
789 found)
801 found)))
804 "Find a node or anchor in the current buffer.
805 REGEXP is a regular expression matching nodes or references. Its first
806 group should match `Node:' or `Ref:'.
807 Value is the position at which a match was found, or nil if not found.
808 This function looks for a case-sensitive match first. If none is found,
809 a case-insensitive match is tried."
821 anchorpos)
822 ;; Switch files if necessary
827 Info-current-subfile nil
828 Info-current-file-completions nil
829 buffer-file-name nil)
845 ;; Check makeinfo version for index cookie support
857 ;; See whether file has a tag table. Record the location if yes.
860 ;; Use string-equal, not equal, to ignore text props.
865 ;; We have a tag table. Find its beginning.
866 ;; Is this an indirect file?
872 ;; It is indirect. Copy it to another buffer
873 ;; and record that the tag table is in that buffer.
892 ))
893 ;; Use string-equal, not equal, to ignore text props.
897 ;; Possibilities:
898 ;;
899 ;; 1. Anchor found in tag table
900 ;; 2. Anchor *not* in tag table
901 ;;
902 ;; 3. Node found in tag table
903 ;; 4. Node *not* found in tag table, but found in file
904 ;; 5. Node *not* in tag table, and *not* in file
905 ;;
906 ;; *Or* the same, but in an indirect subfile.
908 ;; Search file for a suitable node.
918 ;; First, search a tag table, if any
924 ;; FOUND is (ANCHOR POS MODE).
927 ;; If this is an indirect file, determine which
928 ;; file really holds this node and read it in.
930 ;; Note that the current buffer must be the
931 ;; *info* buffer on entry to
932 ;; Info-read-subfile. Thus the hackery above.
935 ;; Handle anchor
940 ;; Else we may have a node, which we search for:
944 ;; Now search from our advised position (or from beg of
945 ;; buffer) to find the actual node. First, check
946 ;; whether the node is right where we are, in case the
947 ;; buffer begins with a node.
960 ;; No such anchor in tag table or node in tag table or file
968 ;; Add anchors to the history too
979 ;; If we did not finish finding the specified node,
980 ;; go back to the previous one.
987 ;; Cache the contents of the (virtual) dir file, once we have merged
988 ;; it for the first time, so we can save time subsequently.
991 ;; Cache for the directory we decided to use for the default-directory
992 ;; of the merged dir text.
995 ;; Record the file attributes of all the files from which we
996 ;; constructed Info-dir-contents.
1001 ;; Construct the Info directory node by merging the files named `dir'
1002 ;; from various directories. Set the *info* buffer's
1003 ;; default-directory to the first directory we actually get any text
1004 ;; from.
1007 ;; Verify that none of the files we used has changed
1008 ;; since we used it.
1012 ;; Handle symlinks
1015 ;; Don't compare the access time.
1019 Info-dir-file-attributes))))
1025 Info-additional-directory-list)
1026 Info-directory-list))
1028 ;; Bind this in case the user sets it to nil.
1030 ;; This is set non-nil if we find a problem in some input files.
1031 problems
1032 buffers buffer others nodes dirs-done)
1034 ;; Search the directory list for the directory file.
1039 ;; Try several variants of specified name.
1040 ;; Try upcasing, appending `.info', or both.
1055 dirs-done)))
1064 file)
1076 ;; Distinguish the dir file that comes with Emacs from all the
1077 ;; others. Yes, that is really what this is supposed to do.
1078 ;; The definition of `Info-directory-list' puts it first on that
1079 ;; list and so last in `buffers' at this point.
1083 ;; Insert the entire original dir file as a start; note that we've
1084 ;; already saved its default directory to use as the default
1085 ;; directory for the whole concatenation.
1088 ;; Look at each of the other buffers one by one.
1091 ;; In each, find all the menus.
1094 ;; Find each menu, and add an elt to NODES for it.
1098 nodename end)
1110 ;; Add to the main menu a menu item for each other node.
1122 end t)
1126 ;; Now take each node of each of the other buffers
1127 ;; and merge it into the main buffer.
1132 ;; Find the like-named node in the main buffer.
1136 nil t)
1141 ;; If none exists, add one.
1144 ;; Merge the text from the other buffer's menu
1145 ;; into the menu in the like-named node in the main buffer.
1148 ;; Kill all the buffers we just made, including the special one excised.
1168 ;; Remove duplicate headings in the same menu.
1171 ;; Look for the next heading to unify.
1176 ;; Check whether this heading should be streamlined.
1186 ;; Look for other headings of the same category and merge them.
1192 ;; Delete redundant heading.
1194 ;; Push the entries onto `text'.
1201 entries)
1203 ;; Insert the entries just found.
1211 ;; Now remove duplicate entries under the same heading.
1218 ;; Fold case straight away; `member-ignore-case' here wasteful.
1226 ;; Note that on entry to this function the current-buffer must be the
1227 ;; *info* buffer; not the info tags buffer.
1229 ;; NODEPOS is either a position (in the Info file as a whole,
1230 ;; not relative to a subfile) or the name of a subfile.
1232 lastfilename)
1243 thisfilepos thisfilename)
1247 ;; read in version 19 stops at the end of number.
1248 ;; Advance to the next line.
1257 ;; Assume previous buffer is in Info-mode.
1258 ;; (set-buffer (get-buffer "*info*"))
1267 ;; Widen in case we are in the same subfile as before.
1277 "Unescape double quotes and backslashes in VALUE."
1283 unquote))
1285 ;; As of Texinfo 4.6, makeinfo writes constructs like
1286 ;; \0\h[image param=value ...\h\0]
1287 ;; into the Info file for handling images.
1290 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1291 whitespace or double quotes, it must be quoted in double quotes and
1296 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1297 parameter-string start)
1303 parameter-alist))
1304 parameter-alist))
1307 "Display images in current node."
1314 nil t)
1328 ;; text-only display, show alternative text if provided, or
1329 ;; otherwise a clue that there's meant to be a picture
1338 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1339 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1340 ;; including one optional trailing newline.
1342 "Hide unrecognized cookies in current node."
1349 nil t)
1356 "Select the Info node that point is in."
1357 ;; Bind this in case the user sets it to nil.
1360 ;; Find beginning of node.
1366 ;; Get nodename spelled as it is in the node.
1374 ;; Find the end of it, and narrow.
1377 ;; Narrow to the node contents
1389 ;; Add a new unique history item to full history list
1404 map)
1412 " ("
1417 ") "
1422 'help-echo
1423 "mouse-1: scroll forward, mouse-3: scroll back"
1427 \f
1428 ;; Go to an Info node specified with a filename-and-nodename string
1429 ;; of the sort that is found in pointers in nodes.
1431 ;; Don't autoload this function: the correct entry point for other packages
1432 ;; to use is `info'. --Stef
1433 ;; ;;;###autoload
1435 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1436 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1437 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1438 its sub-files).
1439 Completion is available, but only for node names in the current Info file.
1440 If FORK is non-nil (interactively with a prefix arg), show the node in
1441 a new Info buffer.
1442 If FORK is a string, it is the name to use for the new buffer."
1450 nodename)
1452 ""
1466 "Virtual completion table for file names input in Info node names.
1467 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1481 ;; If the file name has no suffix or a standard suffix,
1482 ;; include it.
1485 ;; But exclude subfiles of split Info files.
1487 ;; And exclude backup files.
1490 ;; If the file name ends in a standard suffix,
1491 ;; add the unsuffixed name as a completion option.
1497 ;; This function is used as the "completion table" while reading a node name.
1498 ;; It does completion using the alist in Info-read-node-completion-table
1499 ;; unless STRING starts with an open-paren.
1502 ;; First complete embedded file names.
1505 "("
1508 Info-directory-list
1511 predicate
1512 code))
1514 ;; If a file name was given, then any node is fair game.
1520 ;; Otherwise use Info-read-node-completion-table.
1522 code Info-read-node-completion-table string predicate))))
1524 ;; Arrange to highlight the proper letters in the completion list buffer.
1533 nodename)))
1538 ;; Bind this in case the user sets it to nil.
1553 compl))))
1556 ;; If the buffer begins with a node header, process that first.
1559 ;; Now for the rest of the nodes.
1567 compl))))))))
1570 \f
1572 "If this node has been visited, restore the point value when we left."
1575 ;; Use string-equal, not equal, to ignore text props.
1581 \f
1589 "Search for REGEXP, starting from point, and select node it's found in.
1590 If DIRECTION is `backward', search in the reverse direction."
1618 ;; Hide Info file header for backward search
1629 Info-search-whitespace-regexp)))
1644 ;; If no subfiles, give error now.
1649 Info-search-whitespace-regexp)))
1660 ;; Try other subfiles.
1670 ;; Find the subfile we just searched.
1672 ;; Skip that one.
1675 ;; Make a list of all following subfiles.
1676 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1685 list))
1689 ;; Put in forward order
1695 ;; Hide Info file header for backward search
1709 Info-search-whitespace-regexp)))
1732 ;; Search landed in the same node
1738 ;; Use string-equal, not equal, to ignore text props.
1744 Info-history))))))
1747 "Search for a regexp case-sensitively."
1753 "Search for next regexp from a previous `Info-search' command."
1761 "Search for REGEXP in the reverse direction."
1780 nil t)
1782 bound noerror count
1785 bound noerror count
1814 "Skip invisible text, node header line and Tag Table node."
1824 ;; Skip node header line
1828 ;; Skip Tag Table node
1834 \f
1836 "Extract the value of the node-pointer named NAME.
1837 If there is none, use ERRORNAME in the error message;
1838 if ERRORNAME is nil, just return nil."
1839 ;; Bind this in case the user sets it to nil.
1853 "Return a regexp matching a node name.
1854 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1855 saying which chars may appear in the node name.
1856 Submatch 1 is the complete node name.
1857 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1858 Submatch 3 is the local part of the node name.
1859 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1866 ;;; For compatibility; other files have used this name.
1872 "Go to the next node of this node."
1874 ;; In case another window is currently selected
1880 "Go to the previous node of this node."
1882 ;; In case another window is currently selected
1888 "Go to the superior node of this node.
1889 If SAME-FILE is non-nil, do not move to a different Info file."
1891 ;; In case another window is currently selected
1910 nil t))
1916 "Go back in the history to the last node visited."
1922 Info-history-forward))
1923 filename nodename opoint)
1936 "Go forward in the history of visited nodes."
1941 filename nodename opoint)
1949 ;;;###autoload
1951 "Go to the Info directory node."
1954 \f
1956 "Go to a node with a menu of visited nodes."
1960 p)
1985 "Go to a node with table of contents of the current Info file.
1986 Table of contents is created from the tree structure of menus."
1991 p)
2021 "Insert table of contents with references to nodes."
2033 "Build table of contents from menus of Info FILE and its subfiles."
2038 default-directory))
2041 nodes subfiles)
2053 menu-items)
2062 bound))
2065 ;; Menu item line
2075 ;; Other non-empty strings in the Top node are section names
2084 nodes))
2093 subfiles)))))
2095 main-file nil))
2099 \f
2101 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2102 FOOTNOTENAME may be an abbreviation of the reference name.
2103 If FORK is non-nil (interactively with a prefix arg), show the node in
2104 a new Info buffer. If FORK is a string, it is the name to use for the
2105 new buffer."
2111 ;; Store end and beginning of line.
2120 ;; See if this one should be the default.
2125 ;; See if this one should be the alternate default.
2135 ;; Record as a completion and perhaps as default.
2138 ;; Don't add this string if it's a duplicate.
2141 ;; If no good default was found, try an alternate.
2144 ;; If only one cross-reference found, then make it default.
2150 "Follow reference named (default "
2153 completions nil t)))
2167 ;; Move point to the beginning of reference if point is on reference
2177 ;; Go to the reference closest to point
2185 next-ref prev-ref))
2196 ;; We allow newline because this is also used in Info-follow-reference,
2197 ;; where the xref name might be wrapped over two lines.
2198 "Regexp that matches a menu entry name upto but not including the colon.
2199 Because of ambiguities, this should be concatenated with something like
2220 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2221 ;;; (setq Info-point-loc
2222 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2223 )
2227 ;; If the node name is the menu entry name (using `entry::').
2231 ;; No one calls this.
2232 ;;(defun Info-menu-item-sequence (list)
2233 ;; (while list
2234 ;; (Info-menu (car list))
2235 ;; (setq list (cdr list))))
2247 ;; This uses two dynamically bound variables:
2248 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2249 ;; is the menu of items we're trying to complete.
2250 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2251 ;; also look for menu items in subsequent nodes as long as those
2252 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2253 ;; not used.
2254 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2255 ;; also look for menu items in these nodes. This feature is currently
2256 ;; only used for completion in Info-index.
2258 ;; Note that `Info-complete-menu-buffer' could be current already,
2259 ;; so we want to save point.
2265 nextnode)
2274 completions
2276 ;; Check the cache.
2284 ;; We can reuse the previous list.
2286 ;; The cache can't be used.
2291 completions))
2292 ;; Check subsequent nodes if applicable.
2300 ;; Go back to the start node (for the next completion).
2303 ;; Update the cache.
2306 Info-complete-next-re string completions
2307 Info-complete-nodes)))
2314 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2315 The menu item should one of those listed in the current node's menu.
2316 Completion is allowed, and the default menu item is the one point is on.
2317 If FORK is non-nil (interactively with a prefix arg), show the node in
2318 a new Info buffer. If FORK is a string, it is the name to use for the
2319 new buffer."
2322 ;; If point is within a menu item, use that item as the default
2325 beg
2338 Info-menu-entry-name-re
2347 default)
2350 ;; we rely on the fact that completing-read accepts an input
2351 ;; of "" even when the require-match argument is true and ""
2352 ;; is not a valid possibility
2356 ;; ask again
2359 ;; there is a problem here in that if several menu items have the same
2360 ;; name you can only go to the node of the first with this command.
2378 ;; If COUNT is nil, use the last item in the menu.
2390 nil))
2394 "Go to the node of the Nth menu item.
2395 N is the digit argument used to invoke this command."
2402 "Go to the Top node of this file."
2407 "Go to the final node in this file."
2412 ;; Go to the last node in the menu of Top.
2414 ;; If the last node in the menu is not last in pointer structure,
2415 ;; move forward until we can't go any farther.
2417 ;; Then keep moving down to last subnode, unless we reach an index.
2423 "Go forward one node, considering all nodes as forming one sequence."
2428 ;; three possibilities, in order of priority:
2429 ;; 1. next node is in a menu in this node (but not in an index)
2430 ;; 2. next node is next at same level
2431 ;; 3. next node is up and next
2436 t)
2439 t)
2441 ;; Use string-equal, not equal, to ignore text props.
2454 "Go backward one node, considering all nodes as forming one sequence."
2462 ;; Use string-equal, not equal,
2463 ;; to ignore text properties.
2468 ;; If we move back at the same level,
2469 ;; go down to find the last subnode*.
2479 "Exit Info by selecting some other buffer."
2486 "Go to the node of the next menu item."
2488 ;; Bind this in case the user sets it to nil.
2500 "Go to the node of the previous menu item."
2504 ;; Bind this in case the user sets it to nil.
2519 "Go to the next subnode or the next node, or go up a level."
2524 ;; Since we have already gone thru all the items in this menu,
2525 ;; go up to the end of this node.
2527 ;; Since logically we are done with the node with that menu,
2528 ;; move on from it. But don't add intermediate nodes
2529 ;; to the history on recursive calls.
2536 "Go to the last node, popping up a level if there is none."
2540 ;; If we go down a menu item, go to the end of the node
2541 ;; so we can scroll back through it.
2543 ;; Keep going down, as long as there are nested menu nodes.
2546 ;; If we go down a menu item, go to the end of the node
2547 ;; so we can scroll back through it.
2557 ;; If we go down a menu item, go to the end of the node
2558 ;; so we can scroll back through it.
2569 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2570 Once you scroll far enough in a node that its menu appears on the screen
2571 but after point, the next scroll moves into its first subnode, unless
2572 `Info-scroll-prefer-subnodes' is nil.
2574 When you scroll past the end of a node, that goes to the next node if
2575 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2576 if this node has no successor, it moves to the parent node's successor,
2577 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2578 the menu of a node, it moves to subnode indicated by the following menu
2579 item. (That case won't normally result from this command, but can happen
2580 in other ways.)"
2602 "Scroll one screenful forward in Info, using the mouse.
2603 See `Info-scroll-up'."
2611 "Scroll one screenful back in Info, considering all nodes as one sequence.
2612 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2613 is non-nil, this goes to its last subnode. When you scroll past the
2614 beginning of a node, that goes to the previous node or back up to the
2615 parent node."
2629 current-point
2630 t)))))
2637 "Scroll one screenful backward in Info, using the mouse.
2638 See `Info-scroll-down'."
2646 "Move cursor to the next cross-reference or menu item in the node."
2668 "Move cursor to the previous cross-reference or menu item in the node."
2687 \f
2689 "Alist of cached index node names of visited Info files.
2693 "Return a list of names of all index nodes in Info FILE.
2694 If FILE is omitted, it defaults to the current Info file.
2695 First look in a list of cached index node names. Then scan Info
2696 file and its subfiles for nodes with the index cookie. Then try
2697 to find index nodes starting from the first node in the top level
2702 ;; Skip virtual Info files
2707 ;; Find nodes with index cookie
2711 default-directory))
2712 Info-history Info-history-list Info-fontify-maximum-menu-size
2732 subfiles)))))
2734 main-file nil))
2740 nodes)
2741 ;; Else find nodes with the word "Index" in the node name
2743 Info-history Info-history-list Info-fontify-maximum-menu-size
2744 nodes node)
2762 nodes))
2763 ;; If file has no index nodes, still add it to the cache
2768 "Return non-nil value if NODE is an index node.
2769 If NODE is nil, check the current Info node.
2770 If FILE is nil, check the current Info file."
2774 ;; Don't search all index nodes if request is only for the current node
2775 ;; and file is not in the cache of index nodes
2789 "Go to the first index node."
2794 ;;;###autoload
2796 "Look up a string TOPIC in the index for this manual and go to that entry.
2797 If there are no exact matches to the specified topic, this chooses
2798 the first match which is a case-insensitive substring of a topic.
2800 Give an empty topic name to go to the Index node itself."
2816 ;; Strip leading colon in topic; index format does not allow them.
2822 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2831 ;; We bind Info-history to nil for internal node-switches so
2832 ;; that we don't put junk in the history. In the first
2833 ;; Info-goto-index call, above, we do update the history
2834 ;; because that is what the user's previous node choice into it.
2836 found)
2843 Info-current-node
2846 matches))
2853 ;; Here it is a feature that assoc is case-sensitive.
2886 'Info-index-next overriding-local-map
2887 t)))
2891 "Move point to the place within the current node where NAME is defined."
2896 ;; Find a function definition with a return type.
2904 nil t))
2906 ;; Try again without the " <1>" makeinfo can append
2912 ;;;###autoload
2914 "Grovel indices of all known Info files on your system for STRING.
2915 Build a menu of the possible matches."
2918 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2924 manuals matches node nodes)
2927 ;; current-node and current-file are nil when they invoke info-apropos
2928 ;; as the first Info command, i.e. info-apropos loads info.el. In that
2929 ;; case, we use (DIR)Top instead, to avoid signalling an error after
2930 ;; the search is complete.
2938 ;; add-to-list makes sure we don't have duplicates in `manuals',
2939 ;; so that the following dolist loop runs faster.
2956 matches)))
2965 Info-history-list ohist-list)
2986 "Make command be undefined in Info."
2991 "Enter the Info tutorial."
2996 "Help-Small-Screen"
3000 "Display a brief summary of all Info commands."
3015 flag))
3018 \f
3020 "Return the token around POS.
3021 POS must be somewhere inside the token
3022 START is a regular expression which will match the
3023 beginning of the tokens delimited string
3024 ALL is a regular expression with a single
3025 parenthesized subpattern which is the token to be
3026 returned. E.g. '{\(.*\)}' would return any string
3027 enclosed in braces around POS.
3028 ERRORSTRING optional fourth argument, controls action on no match
3029 nil: return nil
3030 t: beep
3031 a string: signal an error, using that string."
3035 ;; First look for a match for START that goes across POS.
3039 ;; If we did not find one, search back for START
3040 ;; (this finds only matches that end at or before POS).
3053 nil)
3056 nil)
3062 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3063 At end of the node's text, moves to the next node, or up if none."
3071 "Follow a node reference near point.
3072 If point is on a reference, follow that reference. Otherwise,
3073 if point is in a menu item description, follow that menu item.
3075 If FORK is non-nil (interactively with a prefix arg), show the node in
3076 a new Info buffer.
3077 If FORK is a string, it is the name to use for the new buffer."
3089 t)))
3092 ;; Common subroutine.
3094 "Follow a node reference near point. Return non-nil if successful.
3095 If FORK is non-nil, it i spassed to `Info-goto-node'."
3104 ;; menu item: node name
3107 ;; menu item: node name or index entry
3121 node))
3122 \f
3133 (define-key map "1" 'Info-nth-menu-item)
3134 (define-key map "2" 'Info-nth-menu-item)
3135 (define-key map "3" 'Info-nth-menu-item)
3136 (define-key map "4" 'Info-nth-menu-item)
3137 (define-key map "5" 'Info-nth-menu-item)
3138 (define-key map "6" 'Info-nth-menu-item)
3139 (define-key map "7" 'Info-nth-menu-item)
3140 (define-key map "8" 'Info-nth-menu-item)
3141 (define-key map "9" 'Info-nth-menu-item)
3142 (define-key map "0" 'undefined)
3143 (define-key map "?" 'Info-summary)
3144 (define-key map "]" 'Info-forward-node)
3145 (define-key map "[" 'Info-backward-node)
3146 (define-key map "<" 'Info-top-node)
3147 (define-key map ">" 'Info-final-node)
3148 (define-key map "b" 'beginning-of-buffer)
3149 (define-key map "d" 'Info-directory)
3150 (define-key map "e" 'Info-edit)
3151 (define-key map "f" 'Info-follow-reference)
3152 (define-key map "g" 'Info-goto-node)
3153 (define-key map "h" 'Info-help)
3154 (define-key map "i" 'Info-index)
3155 (define-key map "l" 'Info-history-back)
3156 (define-key map "L" 'Info-history)
3157 (define-key map "m" 'Info-menu)
3158 (define-key map "n" 'Info-next)
3159 (define-key map "p" 'Info-prev)
3160 (define-key map "q" 'Info-exit)
3161 (define-key map "r" 'Info-history-forward)
3162 (define-key map "s" 'Info-search)
3163 (define-key map "S" 'Info-search-case-sensitively)
3164 ;; For consistency with Rmail.
3165 (define-key map "\M-s" 'Info-search)
3166 (define-key map "\M-n" 'clone-buffer)
3167 (define-key map "t" 'Info-top-node)
3168 (define-key map "T" 'Info-toc)
3169 (define-key map "u" 'Info-up)
3170 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3171 (define-key map "w" 'Info-copy-current-node-name)
3172 (define-key map "c" 'Info-copy-current-node-name)
3173 ;; `^' for consistency with `dired-up-directory'.
3174 (define-key map "^" 'Info-up)
3175 (define-key map "," 'Info-index-next)
3177 (define-key map [mouse-2] 'Info-mouse-follow-nearest-node)
3178 (define-key map [follow-link] 'mouse-face)
3179 map)
3180 "Keymap containing Info commands.")
3183 (defun Info-check-pointer (item)
3184 "Non-nil if ITEM is present in this node."
3185 (condition-case nil
3186 (Info-extract-pointer item)
3187 (error nil)))
3189 (easy-menu-define
3190 Info-mode-menu Info-mode-map
3191 "Menu for Info files."
3192 '("Info"
3193 ["Up" Info-up :active (Info-check-pointer "up")
3194 :help "Go up in the Info tree"]
3195 ["Next" Info-next :active (Info-check-pointer "next")
3196 :help "Go to the next node"]
3197 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3198 :help "Go to the previous node"]
3199 ["Backward" Info-backward-node
3200 :help "Go backward one node, considering all as a sequence"]
3201 ["Forward" Info-forward-node
3202 :help "Go forward one node, considering all as a sequence"]
3203 ["Beginning" beginning-of-buffer
3204 :help "Go to beginning of this node"]
3205 ["Top" Info-top-node
3206 :help "Go to top node of file"]
3207 ["Final Node" Info-final-node
3208 :help "Go to final node in this file"]
3209 ("Menu Item" ["You should never see this" report-emacs-bug t])
3210 ("Reference" ["You should never see this" report-emacs-bug t])
3211 ["Search..." Info-search
3212 :help "Search for regular expression in this Info file"]
3213 ["Search Next" Info-search-next
3214 :help "Search for another occurrence of regular expression"]
3215 ["Go to Node..." Info-goto-node
3216 :help "Go to a named node"]
3217 ["Back in history" Info-history-back :active Info-history
3218 :help "Go back in history to the last node you were at"]
3219 ["Forward in history" Info-history-forward :active Info-history-forward
3220 :help "Go forward in history"]
3221 ["History" Info-history :active Info-history-list
3222 :help "Go to menu of visited nodes"]
3223 ["Table of Contents" Info-toc
3224 :help "Go to table of contents"]
3225 ("Index"
3226 ["Lookup a String..." Info-index
3227 :help "Look for a string in the index items"]
3228 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3229 :help "Look for another occurrence of previous item"]
3230 ["Lookup a string in all indices..." info-apropos
3231 :help "Look for a string in the indices of all manuals"])
3232 ["Copy Node Name" Info-copy-current-node-name
3233 :help "Copy the name of the current node into the kill ring"]
3234 ["Clone Info buffer" clone-buffer
3235 :help "Create a twin copy of the current Info buffer."]
3236 ["Exit" Info-exit :help "Stop reading Info"]))
3239 (defvar info-tool-bar-map
3240 (if (display-graphic-p)
3241 (let ((map (make-sparse-keymap)))
3242 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map
3243 :rtl "right-arrow")
3244 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map
3245 :rtl "left-arrow")
3246 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map
3247 :rtl "next-node")
3248 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map
3249 :rtl "prev-node")
3250 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3251 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3252 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3253 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3254 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3255 (tool-bar-local-item-from-menu 'Info-exit "exit" map Info-mode-map)
3256 map)))
3258 (defvar Info-menu-last-node nil)
3259 ;; Last node the menu was created for.
3260 ;; Value is a list, (FILE-NAME NODE-NAME).
3262 (defun Info-menu-update ()
3263 "Update the Info menu for the current node."
3264 (condition-case nil
3265 (if (or (not (eq major-mode 'Info-mode))
3266 (equal (list Info-current-file Info-current-node)
3267 Info-menu-last-node))
3268 ()
3269 ;; Update menu menu.
3270 (let* ((Info-complete-menu-buffer (current-buffer))
3271 (items (nreverse (condition-case nil
3272 (Info-complete-menu-item "" nil t)
3273 (error nil))))
3274 entries current
3275 (number 0))
3276 (while (and items (< number 9))
3277 (setq current (car items)
3278 items (cdr items)
3279 number (1+ number))
3280 (setq entries (cons `[,current
3281 (Info-menu ,current)
3282 :keys ,(format "%d" number)]
3283 entries)))
3284 (if items
3285 (setq entries (cons ["Other..." Info-menu t] entries)))
3286 (or entries
3287 (setq entries (list ["No menu" nil nil] nil :active)))
3288 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3289 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3290 (let ((items nil)
3291 str i entries current
3292 (number 0)
3293 (case-fold-search t))
3294 (save-excursion
3295 (goto-char (point-min))
3297 (setq str (match-string 1))
3298 (setq i 0)
3300 (setq str (concat (substring str 0 i) " "
3301 (substring str (match-end 0))))
3302 (setq i (1+ i)))
3303 (setq items
3304 (cons str items))))
3305 (while (and items (< number 9))
3306 (setq current (car items)
3307 items (cdr items)
3308 number (1+ number))
3309 (setq entries (cons `[,current
3310 (Info-follow-reference ,current)
3311 t]
3312 entries)))
3313 (if items
3314 (setq entries (cons ["Other..." Info-follow-reference t]
3315 entries)))
3316 (or entries
3317 (setq entries (list ["No references" nil nil] nil :active)))
3318 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3319 ;; Update last seen node.
3320 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3321 ;; Try to avoid entering infinite beep mode in case of errors.
3322 (error (ding))))
3324 \f
3325 (defun Info-copy-current-node-name (&optional arg)
3326 "Put the name of the current Info node into the kill ring.
3327 The name of the Info file is prepended to the node name in parentheses.
3328 With a zero prefix arg, put the name inside a function call to `info'."
3329 (interactive "P")
3330 (unless Info-current-node
3331 (error "No current Info node"))
3332 (let ((node (if (stringp Info-current-file)
3333 (concat "(" (file-name-nondirectory Info-current-file) ") "
3334 Info-current-node))))
3335 (if (zerop (prefix-numeric-value arg))
3337 (unless (stringp Info-current-file)
3338 (setq node (format "(Info-find-node '%S '%S)"
3339 Info-current-file Info-current-node)))
3340 (kill-new node)
3341 (message "%s" node)))
3343 \f
3344 ;; Info mode is suitable only for specially formatted data.
3345 (put 'Info-mode 'mode-class 'special)
3346 (put 'Info-mode 'no-clone-indirect t)
3348 (defvar tool-bar-map)
3349 (defvar bookmark-make-record-function)
3351 ;; Autoload cookie needed by desktop.el
3352 ;;;###autoload
3353 (defun Info-mode ()
3354 "Info mode provides commands for browsing through the Info documentation tree.
3356 one topic and contains references to other nodes which discuss related
3357 topics. Info has commands to follow the references and show you other nodes.
3363 Selecting other nodes:
3365 Follow a node reference you click on.
3366 This works with menu items, cross references, and
3368 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3373 Picking a menu item causes another node to be selected.
3383 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3387 Moving within a node:
3389 Once you scroll far enough in a node that its menu appears on the
3390 screen but after point, the next scroll moves into its first
3391 subnode. When after all menu items (or if there is no menu),
3392 move up to the parent node.
3394 already visible, try to go to the previous menu entry, or up
3395 if there is none.
3398 Advanced commands:
3400 and select the node in which the next occurrence is found.
3401 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3405 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3408 You may include a filename as well, as (FILENAME)NODENAME.
3409 1 .. 9 Pick first ... ninth item in node's menu.
3410 Every third `*' is highlighted to help pick the right number.
3414 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3415 (kill-all-local-variables)
3416 (setq major-mode 'Info-mode)
3417 (setq mode-name "Info")
3418 (setq tab-width 8)
3419 (use-local-map Info-mode-map)
3420 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3421 (set-syntax-table text-mode-syntax-table)
3422 (setq local-abbrev-table text-mode-abbrev-table)
3423 (setq case-fold-search t)
3424 (setq buffer-read-only t)
3425 (make-local-variable 'Info-current-file)
3426 (make-local-variable 'Info-current-subfile)
3427 (make-local-variable 'Info-current-node)
3428 (make-local-variable 'Info-tag-table-marker)
3429 (setq Info-tag-table-marker (make-marker))
3430 (make-local-variable 'Info-tag-table-buffer)
3431 (setq Info-tag-table-buffer nil)
3432 (make-local-variable 'Info-history)
3433 (make-local-variable 'Info-history-forward)
3434 (make-local-variable 'Info-index-alternatives)
3435 (setq header-line-format
3436 (if Info-use-header-line
3437 '(:eval (get-text-property (point-min) 'header-line))
3438 nil)) ; so the header line isn't displayed
3439 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3440 ;; This is for the sake of the invisible text we use handling titles.
3441 (make-local-variable 'line-move-ignore-invisible)
3442 (setq line-move-ignore-invisible t)
3443 (make-local-variable 'desktop-save-buffer)
3444 (make-local-variable 'widen-automatically)
3445 (setq widen-automatically nil)
3446 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3447 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3448 (add-hook 'clone-buffer-hook 'Info-clone-buffer nil t)
3449 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3450 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3451 (set (make-local-variable 'isearch-search-fun-function)
3452 'Info-isearch-search)
3453 (set (make-local-variable 'isearch-wrap-function)
3454 'Info-isearch-wrap)
3455 (set (make-local-variable 'isearch-push-state-function)
3456 'Info-isearch-push-state)
3457 (set (make-local-variable 'isearch-success-function)
3458 'Info-search-success-function)
3459 (set (make-local-variable 'search-whitespace-regexp)
3460 Info-search-whitespace-regexp)
3461 (set (make-local-variable 'revert-buffer-function)
3462 'Info-revert-buffer-function)
3463 (Info-set-mode-line)
3464 (set (make-local-variable 'bookmark-make-record-function)
3465 'Info-bookmark-make-record)
3466 (run-mode-hooks 'Info-mode-hook))
3468 ;; When an Info buffer is killed, make sure the associated tags buffer
3469 ;; is killed too.
3470 (defun Info-kill-buffer ()
3471 (and (eq major-mode 'Info-mode)
3472 Info-tag-table-buffer
3473 (kill-buffer Info-tag-table-buffer)))
3475 ;; Placed on `clone-buffer-hook'.
3476 (defun Info-clone-buffer ()
3477 (when (bufferp Info-tag-table-buffer)
3478 (setq Info-tag-table-buffer
3479 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3480 (let ((m Info-tag-table-marker))
3481 (when (markerp m)
3482 (setq Info-tag-table-marker
3483 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3484 (with-current-buffer Info-tag-table-buffer
3485 (copy-marker (marker-position m)))
3486 (make-marker))))))
3488 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3489 (set-keymap-parent map text-mode-map)
3490 (define-key map "\C-c\C-c" 'Info-cease-edit)
3491 map)
3492 "Local keymap used within `e' command of Info.")
3494 ;; Info-edit mode is suitable only for specially formatted data.
3495 (put 'Info-edit-mode 'mode-class 'special)
3497 (defun Info-edit-mode ()
3498 "Major mode for editing the contents of an Info node.
3499 Like text mode with the addition of `Info-cease-edit'
3500 which returns to Info mode for browsing.
3502 (use-local-map Info-edit-map)
3503 (setq major-mode 'Info-edit-mode)
3504 (setq mode-name "Info Edit")
3505 (kill-local-variable 'mode-line-buffer-identification)
3506 (setq buffer-read-only nil)
3507 (force-mode-line-update)
3508 (buffer-enable-undo (current-buffer))
3509 (run-mode-hooks 'Info-edit-mode-hook))
3511 (defun Info-edit ()
3512 "Edit the contents of this Info node.
3513 Allowed only if variable `Info-enable-edit' is non-nil."
3514 (interactive)
3515 (or Info-enable-edit
3516 (error "Editing Info nodes is not enabled"))
3517 (Info-edit-mode)
3518 (message "%s" (substitute-command-keys
3521 (defun Info-cease-edit ()
3522 "Finish editing Info node; switch back to Info proper."
3523 (interactive)
3524 ;; Do this first, so nothing has changed if user C-g's at query.
3525 (and (buffer-modified-p)
3526 (y-or-n-p "Save the file? ")
3527 (save-buffer))
3528 (use-local-map Info-mode-map)
3529 (setq major-mode 'Info-mode)
3530 (setq mode-name "Info")
3531 (Info-set-mode-line)
3532 (setq buffer-read-only t)
3533 (force-mode-line-update)
3534 (and (marker-position Info-tag-table-marker)
3535 (buffer-modified-p)
3536 (message "Tags may have changed. Use Info-tagify if necessary")))
3537 \f
3538 (defvar Info-file-list-for-emacs
3539 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3540 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3541 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3542 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3543 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3544 ("copyright" . "autotype") ("executable" . "autotype")
3545 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3546 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3547 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3548 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3549 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3550 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3551 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3552 ("rfc2045" . "emacs-mime")
3553 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3554 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3555 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3556 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3557 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3558 ("mml" . "emacs-mime"))
3559 "List of Info files that describe Emacs commands.
3560 An element can be a file name, or a list of the form (PREFIX . FILE)
3561 where PREFIX is a name prefix and FILE is the file to look in.
3562 If the element is just a file name, the file name also serves as the prefix.")
3564 (defun Info-find-emacs-command-nodes (command)
3565 "Return a list of locations documenting COMMAND.
3566 The `info-file' property of COMMAND says which Info manual to search.
3567 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3568 defines heuristics for which Info manual to try.
3569 The locations are of the format used in `Info-history', i.e.
3570 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3571 in the first element of the returned list (which is treated specially in
3572 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3573 (let ((where '()) line-number
3577 (info-file "emacs")) ;default
3578 ;; Determine which Info file this command is documented in.
3579 (if (get command 'info-file)
3580 (setq info-file (get command 'info-file))
3581 ;; If it doesn't say explicitly, test its name against
3582 ;; various prefixes that we know.
3583 (let ((file-list Info-file-list-for-emacs))
3584 (while file-list
3585 (let* ((elt (car file-list))
3586 (name (if (consp elt)
3587 (car elt)
3588 elt))
3589 (file (if (consp elt) (cdr elt) elt))
3590 (case-fold-search nil)
3593 (if (string-match regexp (symbol-name command))
3594 (setq info-file file file-list nil))
3595 (setq file-list (cdr file-list))))))
3596 (Info-find-node info-file "Top")
3597 ;; Bind Info-history to nil, to prevent the index nodes from
3598 ;; getting into the node history.
3599 (let ((Info-history nil)
3600 (Info-history-list nil)
3601 node (nodes (Info-index-nodes)))
3602 (Info-goto-node (car nodes))
3603 (while
3604 (progn
3605 (goto-char (point-min))
3606 (while (re-search-forward cmd-desc nil t)
3607 (setq where
3608 (cons (list Info-current-file
3609 (match-string-no-properties 2)
3610 0)
3611 where))
3612 (setq line-number (and (match-beginning 3)
3613 (string-to-number (match-string 3)))))
3614 (and (setq nodes (cdr nodes) node (car nodes))))
3615 (Info-goto-node node)))
3616 (if (and line-number where)
3617 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3618 (cdr where))
3619 where)))
3621 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3622 ;;;###autoload
3623 (defun Info-goto-emacs-command-node (command)
3624 "Go to the Info node in the Emacs manual for command COMMAND.
3625 The command is found by looking up in Emacs manual's indices
3626 or in another manual found via COMMAND's `info-file' property or
3627 the variable `Info-file-list-for-emacs'.
3628 COMMAND must be a symbol or string."
3629 (interactive "CFind documentation for command: ")
3630 ;; If command is given as a string, convert it to a symbol.
3631 (if (stringp command)
3632 (setq command (intern command)))
3633 (or (commandp command)
3634 (signal 'wrong-type-argument (list 'commandp command)))
3635 (let ((where (Info-find-emacs-command-nodes command)))
3636 (if where
3637 (let ((num-matches (length where)))
3638 ;; Get Info running, and pop to it in another window.
3639 (save-window-excursion
3640 (info))
3641 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3642 ;; Bind Info-history to nil, to prevent the last Index node
3643 ;; visited by Info-find-emacs-command-nodes from being
3644 ;; pushed onto the history.
3645 (let ((Info-history nil) (Info-history-list nil)
3646 (line-number (nth 2 (car where))))
3647 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3648 (if (and (integerp line-number) (> line-number 0))
3649 (forward-line (1- line-number))))
3650 (if (> num-matches 1)
3651 (progn
3652 ;; (car where) will be pushed onto Info-history
3653 ;; when/if they go to another node. Put the other
3654 ;; nodes that were found on the history.
3655 (setq Info-history (nconc (cdr where) Info-history))
3656 (message "Found %d other entr%s. Use %s to see %s."
3657 (1- num-matches)
3658 (if (> num-matches 2) "ies" "y")
3660 (if (> num-matches 2) "them" "it")))))
3661 (error "Couldn't find documentation for %s" command))))
3663 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3664 ;;;###autoload
3665 (defun Info-goto-emacs-key-command-node (key)
3666 "Go to the node in the Emacs manual which describes the command bound to KEY.
3667 KEY is a string.
3668 Interactively, if the binding is `execute-extended-command', a command is read.
3669 The command is found by looking up in Emacs manual's indices
3670 or in another manual found via COMMAND's `info-file' property or
3671 the variable `Info-file-list-for-emacs'."
3672 (interactive "kFind documentation for key: ")
3673 (let ((command (key-binding key)))
3674 (cond ((null command)
3675 (message "%s is undefined" (key-description key)))
3676 ((and (interactive-p)
3677 (eq command 'execute-extended-command))
3678 (Info-goto-emacs-command-node
3679 (read-command "Find documentation for command: ")))
3680 (t
3681 (Info-goto-emacs-command-node command)))))
3682 \f
3683 (defvar Info-next-link-keymap
3684 (let ((keymap (make-sparse-keymap)))
3685 (define-key keymap [header-line mouse-1] 'Info-next)
3686 (define-key keymap [header-line mouse-2] 'Info-next)
3687 (define-key keymap [header-line down-mouse-1] 'ignore)
3688 (define-key keymap [mouse-2] 'Info-next)
3689 (define-key keymap [follow-link] 'mouse-face)
3690 keymap)
3691 "Keymap to put on the Next link in the text or the header line.")
3693 (defvar Info-prev-link-keymap
3694 (let ((keymap (make-sparse-keymap)))
3695 (define-key keymap [header-line mouse-1] 'Info-prev)
3696 (define-key keymap [header-line mouse-2] 'Info-prev)
3697 (define-key keymap [header-line down-mouse-1] 'ignore)
3698 (define-key keymap [mouse-2] 'Info-prev)
3699 (define-key keymap [follow-link] 'mouse-face)
3700 keymap)
3701 "Keymap to put on the Prev link in the text or the header line.")
3703 (defvar Info-up-link-keymap
3704 (let ((keymap (make-sparse-keymap)))
3705 (define-key keymap [header-line mouse-1] 'Info-up)
3706 (define-key keymap [header-line mouse-2] 'Info-up)
3707 (define-key keymap [header-line down-mouse-1] 'ignore)
3708 (define-key keymap [mouse-2] 'Info-up)
3709 (define-key keymap [follow-link] 'mouse-face)
3710 keymap)
3711 "Keymap to put on the Up link in the text or the header line.")
3713 (defcustom Info-breadcrumbs-depth 3
3714 "Depth of breadcrumbs to display.
3715 0 means do not display breadcrumbs."
3716 :type 'integer)
3718 (defun Info-insert-breadcrumbs ()
3719 (let ((onode Info-current-node)
3720 (crumbs ())
3721 (depth Info-breadcrumbs-depth)
3722 (Info-fontify-maximum-menu-size nil)) ; Prevent infinite recursion.
3723 (unwind-protect
3724 (while (and (not (equal "Top" Info-current-node)) (> depth 0))
3725 (let ((up (Info-extract-pointer "up")))
3726 (push up crumbs)
3727 (setq depth (1- depth))
3728 (Info-find-node Info-current-file up 'no-going-back)))
3729 (if crumbs ;Do bother going back if we haven't moved.
3730 (Info-find-node Info-current-file onode 'no-going-back))
3731 ;; Add bottom node.
3732 (when Info-use-header-line
3733 ;; Let it disappear if crumbs is nil.
3734 (nconc crumbs (list Info-current-node)))
3735 (when (or Info-use-header-line crumbs)
3736 ;; Add top node (and continuation if needed).
3737 (setq crumbs
3738 (cons "Top" (if (member (pop crumbs) '(nil "Top"))
3739 crumbs (cons nil crumbs))))
3740 ;; Eliminate duplicate.
3741 (forward-line 1)
3742 (dolist (node crumbs)
3743 (let ((text
3744 (if (not (equal node "Top")) node
3745 (format "(%s)Top"
3746 (file-name-nondirectory Info-current-file)))))
3747 (insert (if (bolp) "> " " > ")
3748 (cond
3749 ((null node) "...")
3750 ((equal node Info-current-node)
3751 ;; No point linking to ourselves.
3752 (propertize text 'font-lock-face 'info-header-node))
3753 (t
3754 (concat "*Note " text "::"))))))
3757 (defun Info-fontify-node ()
3758 "Fontify the node."
3759 (save-excursion
3760 (let* ((inhibit-read-only t)
3761 (case-fold-search t)
3762 paragraph-markers
3763 (not-fontified-p ; the node hasn't already been fontified
3764 (not (let ((where (next-single-property-change (point-min)
3765 'font-lock-face)))
3766 (and where (not (= where (point-max)))))))
3767 (fontify-visited-p ; visited nodes need to be re-fontified
3768 (and Info-fontify-visited-nodes
3769 ;; Don't take time to refontify visited nodes in huge nodes
3770 Info-fontify-maximum-menu-size
3771 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3772 rbeg rend)
3774 ;; Fontify header line
3775 (goto-char (point-min))
3777 (goto-char (match-end 0))
3779 (goto-char (match-end 0))
3780 (let* ((nbeg (match-beginning 2))
3781 (nend (match-end 2))
3782 (tbeg (match-beginning 1))
3783 (tag (match-string 1)))
3784 (if (string-equal (downcase tag) "node")
3785 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3786 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3787 (put-text-property tbeg nend 'mouse-face 'highlight)
3788 (put-text-property tbeg nend
3789 'help-echo
3790 (concat "mouse-2: Go to node "
3791 (buffer-substring nbeg nend)))
3792 ;; Always set up the text property keymap.
3793 ;; It will either be used in the buffer
3794 ;; or copied in the header line.
3795 (put-text-property
3796 tbeg nend 'keymap
3797 (cond
3798 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3799 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3800 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3802 (when (> Info-breadcrumbs-depth 0)
3803 (Info-insert-breadcrumbs))
3805 ;; Treat header line.
3806 (when Info-use-header-line
3807 (goto-char (point-min))
3808 (let* ((header-end (line-end-position))
3809 (header
3810 ;; If we find neither Next: nor Prev: link, show the entire
3811 ;; node header. Otherwise, don't show the File: and Node:
3812 ;; parts, to avoid wasting precious space on information that
3813 ;; is available in the mode line.
3814 (if (re-search-forward
3816 header-end t)
3817 (progn
3818 (goto-char (match-beginning 1))
3819 (buffer-substring (point) header-end))
3821 header-end t)
3822 (concat "No next, prev or up links -- "
3823 (buffer-substring (point) header-end))
3824 (buffer-substring (point) header-end)))))
3825 (put-text-property (point-min) (1+ (point-min))
3826 'header-line
3827 (replace-regexp-in-string
3828 "%"
3829 ;; Preserve text properties on duplicated `%'.
3830 (lambda (s) (concat s s)) header))
3831 ;; Hide the part of the first line
3832 ;; that is in the header, if it is just part.
3833 (cond
3834 ((> Info-breadcrumbs-depth 0)
3835 (put-text-property (point-min) (1+ header-end) 'invisible t))
3836 ((not (bobp))
3837 ;; Hide the punctuation at the end, too.
3839 (put-text-property (point) header-end 'invisible t))))))
3841 ;; Fontify titles
3842 (goto-char (point-min))
3843 (when (and font-lock-mode not-fontified-p)
3845 nil t)
3846 ;; Only consider it as an underlined title if the ASCII
3847 ;; underline has the same size as the text. A typical
3848 ;; counter example is when a continuation "..." is alone
3849 ;; on a line.
3850 (= (string-width (match-string 1))
3851 (string-width (match-string 2))))
3852 (let* ((c (preceding-char))
3853 (face
3854 (cond ((= c ?*) 'info-title-1)
3855 ((= c ?=) 'info-title-2)
3856 ((= c ?-) 'info-title-3)
3857 (t 'info-title-4))))
3858 (put-text-property (match-beginning 1) (match-end 1)
3859 'font-lock-face face))
3860 ;; This is a serious problem for trying to handle multiple
3861 ;; frame types at once. We want this text to be invisible
3862 ;; on frames that can display the font above.
3863 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3864 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3865 '(invisible t front-sticky nil rear-nonsticky t)))))
3867 ;; Fontify cross references
3868 (goto-char (point-min))
3869 (when (or not-fontified-p fontify-visited-p)
3870 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3871 (let ((start (match-beginning 0))
3872 (next (point))
3873 other-tag)
3874 (when not-fontified-p
3875 (when Info-hide-note-references
3876 (when (and (not (eq Info-hide-note-references 'hide))
3877 (> (line-number-at-pos) 4)) ; Skip breadcrumbs
3878 ;; *Note is often used where *note should have been
3879 (goto-char start)
3880 (skip-syntax-backward " ")
3881 (when (memq (char-before) '(?\( ?\[ ?\{))
3882 ;; Check whether the paren is preceded by
3883 ;; an end of sentence
3884 (skip-syntax-backward " ("))
3885 (setq other-tag
3887 "")
3889 "")
3890 ((memq (char-before) '(nil ?\. ?! ??))
3891 "See ")
3892 ((save-match-data
3893 (save-excursion
3895 "See ")
3896 (t "see "))))
3897 (goto-char next)
3898 (add-text-properties
3899 (match-beginning 1)
3900 (or (save-match-data
3902 (let ((start1 (match-beginning 1)))
3904 (+ start1 (match-beginning 0)))))
3905 (match-end 1))
3906 (if other-tag
3907 `(display ,other-tag front-sticky nil rear-nonsticky t)
3908 '(invisible t front-sticky nil rear-nonsticky t))))
3909 (add-text-properties
3910 (match-beginning 2) (match-end 2)
3911 (list
3912 'help-echo (if (or (match-end 5)
3913 (not (equal (match-string 4) "")))
3914 (concat "mouse-2: go to " (or (match-string 5)
3915 (match-string 4)))
3916 "mouse-2: go to this node")
3917 'mouse-face 'highlight)))
3918 (when (or not-fontified-p fontify-visited-p)
3919 (setq rbeg (match-beginning 2)
3920 rend (match-end 2))
3921 (put-text-property
3922 rbeg rend
3923 'font-lock-face
3924 ;; Display visited nodes in a different face
3925 (if (and Info-fontify-visited-nodes
3926 (save-match-data
3927 (let* ((node (replace-regexp-in-string
3929 (replace-regexp-in-string
3931 (or (match-string-no-properties 5)
3932 (and (not (equal (match-string 4) ""))
3933 (match-string-no-properties 4))
3934 (match-string-no-properties 2)))))
3935 (external-link-p
3937 (file (if external-link-p
3938 (file-name-nondirectory
3939 (match-string-no-properties 1 node))
3940 Info-current-file))
3941 (hl Info-history-list)
3942 res)
3943 (if external-link-p
3944 (setq node (if (equal (match-string 2 node) "")
3945 "Top"
3946 (match-string-no-properties 2 node))))
3947 (while hl
3948 (if (and (string-equal node (nth 1 (car hl)))
3949 (equal file
3950 (if (and external-link-p
3951 (stringp (caar hl)))
3952 (file-name-nondirectory
3953 (caar hl))
3954 (caar hl))))
3955 (setq res (car hl) hl nil)
3956 (setq hl (cdr hl))))
3957 res))) 'info-xref-visited 'info-xref))
3958 ;; For multiline ref, unfontify newline and surrounding whitespace
3959 (save-excursion
3960 (goto-char rbeg)
3961 (save-match-data
3963 (remove-text-properties (match-beginning 0)
3964 (match-end 0)
3965 '(font-lock-face t))))))
3966 (when not-fontified-p
3967 (when (memq Info-hide-note-references '(t hide))
3968 (add-text-properties (match-beginning 3) (match-end 3)
3969 '(invisible t front-sticky nil rear-nonsticky t))
3970 ;; Unhide the file name of the external reference in parens
3971 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3972 (remove-text-properties (match-beginning 6) (match-end 6)
3973 '(invisible t front-sticky nil rear-nonsticky t)))
3974 ;; Unhide newline because hidden newlines cause too long lines
3975 (save-match-data
3976 (let ((beg3 (match-beginning 3))
3977 (end3 (match-end 3)))
3979 (not (save-match-data
3980 (save-excursion
3981 (goto-char (1+ end3))
3982 (looking-at "[.)]*$")))))
3983 (remove-text-properties (+ beg3 (match-beginning 0))
3984 (+ beg3 (match-end 0))
3985 '(invisible t front-sticky nil rear-nonsticky t))))))
3986 (when (and Info-refill-paragraphs Info-hide-note-references)
3987 (push (set-marker (make-marker) start)
3988 paragraph-markers))))))
3990 ;; Refill paragraphs (experimental feature)
3991 (when (and not-fontified-p
3992 Info-refill-paragraphs
3993 paragraph-markers)
3994 (let ((fill-nobreak-invisible t)
3995 (fill-individual-varying-indent nil)
3998 (adaptive-fill-mode nil))
3999 (goto-char (point-max))
4000 (dolist (m paragraph-markers)
4001 (when (< m (point))
4002 (goto-char m)
4003 (beginning-of-line)
4004 (let ((beg (point)))
4005 (when (zerop (forward-paragraph))
4006 (fill-individual-paragraphs beg (point) nil nil)
4007 (goto-char beg))))
4008 (set-marker m nil))))
4010 ;; Fontify menu items
4011 (goto-char (point-min))
4012 (when (and (or not-fontified-p fontify-visited-p)
4014 ;; Don't take time to annotate huge menus
4015 Info-fontify-maximum-menu-size
4016 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
4017 (let ((n 0)
4018 cont)
4019 (while (re-search-forward
4022 nil t)
4023 (when (match-beginning 1)
4024 (when not-fontified-p
4025 (setq n (1+ n))
4026 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
4027 (put-text-property (match-beginning 0)
4028 (1+ (match-beginning 0))
4029 'font-lock-face 'info-menu-star)))
4030 (when not-fontified-p
4031 (add-text-properties
4032 (match-beginning 1) (match-end 1)
4033 (list
4034 'help-echo (if (and (match-end 3)
4035 (not (equal (match-string 3) "")))
4036 (concat "mouse-2: go to " (match-string 3))
4037 "mouse-2: go to this node")
4038 'mouse-face 'highlight)))
4039 (when (or not-fontified-p fontify-visited-p)
4040 (put-text-property
4041 (match-beginning 1) (match-end 1)
4042 'font-lock-face
4043 ;; Display visited menu items in a different face
4044 (if (and Info-fontify-visited-nodes
4045 (save-match-data
4046 (let* ((node (if (equal (match-string 3) "")
4047 (match-string-no-properties 1)
4048 (match-string-no-properties 3)))
4049 (external-link-p
4051 (file (if external-link-p
4052 (file-name-nondirectory
4053 (match-string-no-properties 1 node))
4054 Info-current-file))
4055 (hl Info-history-list)
4056 res)
4057 (if external-link-p
4058 (setq node (if (equal (match-string 2 node) "")
4059 "Top"
4060 (match-string-no-properties 2 node))))
4061 (while hl
4062 (if (and (string-equal node (nth 1 (car hl)))
4063 (equal file
4064 (if (and external-link-p
4065 (stringp (caar hl)))
4066 (file-name-nondirectory
4067 (caar hl))
4068 (caar hl))))
4069 (setq res (car hl) hl nil)
4070 (setq hl (cdr hl))))
4071 res))) 'info-xref-visited 'info-xref)))
4072 (when (and not-fontified-p
4073 (memq Info-hide-note-references '(t hide))
4074 (not (Info-index-node)))
4075 (put-text-property (match-beginning 2) (1- (match-end 6))
4076 'invisible t)
4077 ;; Unhide the file name in parens
4078 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
4079 (remove-text-properties (match-beginning 4) (match-end 4)
4080 '(invisible t)))
4081 ;; We need a stretchable space like :align-to but with
4082 ;; a minimum value.
4083 (put-text-property (1- (match-end 6)) (match-end 6) 'display
4084 (if (>= 22 (- (match-end 1)
4085 (match-beginning 0)))
4086 '(space :align-to 24)
4087 '(space :width 2)))
4088 (setq cont (looking-at "."))
4089 (while (and (= (forward-line 1) 0)
4091 (put-text-property (match-beginning 1) (1- (match-end 1))
4092 'invisible t)
4093 (put-text-property (1- (match-end 1)) (match-end 1)
4094 'display
4095 (if cont
4096 '(space :align-to 26)
4097 '(space :align-to 24)))
4098 (setq cont t)))))))
4100 ;; Fontify menu headers
4101 ;; Add the face `info-menu-header' to any header before a menu entry
4102 (goto-char (point-min))
4104 (put-text-property (match-beginning 0) (match-end 0)
4105 'font-lock-face 'info-menu-header)
4107 (put-text-property (match-beginning 1) (match-end 1)
4108 'font-lock-face 'info-menu-header)))
4110 ;; Hide index line numbers
4111 (goto-char (point-min))
4112 (when (and not-fontified-p (Info-index-node))
4114 (put-text-property (match-beginning 0) (match-end 0)
4115 'invisible t)))
4117 ;; Fontify http and ftp references
4118 (goto-char (point-min))
4119 (when not-fontified-p
4121 nil t)
4122 (add-text-properties (match-beginning 0) (match-end 0)
4123 '(font-lock-face info-xref
4124 mouse-face highlight
4125 help-echo "mouse-2: go to this URL"))))
4127 (set-buffer-modified-p nil))))
4128 \f
4129 ;;; Speedbar support:
4130 ;; These functions permit speedbar to display the "tags" in the
4131 ;; current Info node.
4132 (eval-when-compile (require 'speedbar))
4134 (defvar Info-speedbar-key-map nil
4135 "Keymap used when in the info display mode.")
4137 (defun Info-install-speedbar-variables ()
4138 "Install those variables used by speedbar to enhance Info."
4139 (if Info-speedbar-key-map
4140 nil
4141 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4143 ;; Basic tree features
4144 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4145 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4146 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4147 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4148 )
4150 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4151 Info-speedbar-key-map
4152 Info-speedbar-hierarchy-buttons)))
4154 (defvar Info-speedbar-menu-items
4155 '(["Browse Node" speedbar-edit-line t]
4156 ["Expand Node" speedbar-expand-line
4157 (save-excursion (beginning-of-line)
4159 ["Contract Node" speedbar-contract-line
4160 (save-excursion (beginning-of-line)
4161 (looking-at "[0-9]+: *.-. "))]
4162 )
4163 "Additional menu-items to add to speedbar frame.")
4165 ;; Make sure our special speedbar major mode is loaded
4166 (if (featurep 'speedbar)
4167 (Info-install-speedbar-variables)
4168 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4170 ;;; Info hierarchy display method
4171 ;;;###autoload
4172 (defun Info-speedbar-browser ()
4173 "Initialize speedbar to display an Info node browser.
4174 This will add a speedbar major display mode."
4175 (interactive)
4176 (require 'speedbar)
4177 ;; Make sure that speedbar is active
4178 (speedbar-frame-mode 1)
4179 ;; Now, throw us into Info mode on speedbar.
4180 (speedbar-change-initial-expansion-list "Info")
4181 )
4183 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4184 "Display an Info directory hierarchy in speedbar.
4185 DIRECTORY is the current directory in the attached frame.
4186 DEPTH is the current indentation depth.
4187 NODE is an optional argument that is used to represent the
4188 specific node to expand."
4189 (if (and (not node)
4190 (save-excursion (goto-char (point-min))
4191 (let ((case-fold-search t))
4192 (looking-at "Info Nodes:"))))
4193 ;; Update our "current node" maybe?
4194 nil
4195 ;; We cannot use the generic list code, that depends on all leaves
4196 ;; being known at creation time.
4197 (if (not node)
4199 (let ((completions nil))
4200 (speedbar-select-attached-frame)
4201 (save-window-excursion
4202 (setq completions
4203 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4204 (select-frame (speedbar-current-frame))
4205 (if completions
4206 (speedbar-with-writable
4207 (dolist (completion completions)
4208 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4209 (cdr completion)
4210 (car completion)
4211 'Info-speedbar-goto-node
4212 (cdr completion)
4213 'info-xref depth))
4214 t)
4215 nil))))
4217 (defun Info-speedbar-goto-node (text node indent)
4218 "When user clicks on TEXT, go to an info NODE.
4219 The INDENT level is ignored."
4220 (speedbar-select-attached-frame)
4221 (let* ((buff (or (get-buffer "*info*")
4222 (progn (info) (get-buffer "*info*"))))
4223 (bwin (get-buffer-window buff 0)))
4224 (if bwin
4225 (progn
4226 (select-window bwin)
4227 (raise-frame (window-frame bwin)))
4228 (if speedbar-power-click
4229 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4230 (speedbar-select-attached-frame)
4231 (switch-to-buffer buff)))
4233 (error "Invalid node %s" node)
4234 (Info-find-node (match-string 1 node) (match-string 2 node))
4235 ;; If we do a find-node, and we were in info mode, restore
4236 ;; the old default method. Once we are in info mode, it makes
4237 ;; sense to return to whatever method the user was using before.
4238 (if (string= speedbar-initial-expansion-list-name "Info")
4239 (speedbar-change-initial-expansion-list
4240 speedbar-previously-used-expansion-list-name)))))
4242 (defun Info-speedbar-expand-node (text token indent)
4243 "Expand the node the user clicked on.
4244 TEXT is the text of the button we clicked on, a + or - item.
4245 TOKEN is data related to this node (NAME . FILE).
4246 INDENT is the current indentation depth."
4247 (cond ((string-match "+" text) ;we have to expand this file
4248 (speedbar-change-expand-button-char ?-)
4249 (if (speedbar-with-writable
4250 (save-excursion
4251 (end-of-line) (forward-char 1)
4252 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4253 (speedbar-change-expand-button-char ?-)
4254 (speedbar-change-expand-button-char ??)))
4255 ((string-match "-" text) ;we have to contract this node
4256 (speedbar-change-expand-button-char ?+)
4257 (speedbar-delete-subblock indent))
4258 (t (error "Ooops... not sure what to do")))
4259 (speedbar-center-buffer-smartly))
4261 (defun Info-speedbar-fetch-file-nodes (nodespec)
4262 "Fetch the subnodes from the info NODESPEC.
4263 NODESPEC is a string of the form: (file)node."
4264 ;; Set up a buffer we can use to fake-out Info.
4265 (with-current-buffer (get-buffer-create " *info-browse-tmp*")
4266 (if (not (equal major-mode 'Info-mode))
4267 (Info-mode))
4268 ;; Get the node into this buffer
4270 (error "Invalid node specification %s" nodespec)
4271 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4272 ;; Scan the created buffer
4273 (goto-char (point-min))
4274 (let ((completions nil)
4275 (case-fold-search t)
4277 (match-string 1 nodespec))))
4278 ;; Always skip the first one...
4281 (let ((name (match-string 1)))
4282 (push (cons name
4284 (match-string 1)
4286 (concat (match-string 1) "Top")
4287 (concat "(" thisfile ")"
4289 (match-string 1)
4290 name)))))
4291 completions)))
4292 (nreverse completions))))
4294 ;;; Info mode node listing
4295 ;; This is called by `speedbar-add-localized-speedbar-support'
4296 (defun Info-speedbar-buttons (buffer)
4297 "Create a speedbar display to help navigation in an Info file.
4298 BUFFER is the buffer speedbar is requesting buttons for."
4299 (if (save-excursion (goto-char (point-min))
4300 (let ((case-fold-search t))
4301 (not (looking-at "Info Nodes:"))))
4302 (erase-buffer))
4303 (Info-speedbar-hierarchy-buttons nil 0))
4305 (dolist (mess '("^First node in file$"
4306 "^No `.*' in index$"
4307 "^No cross-reference named"
4308 "^No cross.references in this node$"
4309 "^No current Info node$"
4310 "^No menu in this node$"
4311 "^No more items in menu$"
4312 "^No more nodes$"
4314 "^No previous `i' command$"
4315 "^No previous items in menu$"
4316 "^No previous nodes$"
4317 "^No such item in menu$"
4318 "^No such node or anchor"
4319 "^Node has no"
4320 "^Point neither on reference nor in menu item description$"
4322 search-failed))
4323 (add-to-list 'debug-ignored-errors mess))
4325 ;;;; Desktop support
4327 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4328 "Auxiliary information to be saved in desktop file."
4329 (unless (member Info-current-file '(apropos history toc nil))
4330 (list Info-current-file Info-current-node)))
4332 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4333 desktop-buffer-name
4334 desktop-buffer-misc)
4335 "Restore an Info buffer specified in a desktop file."
4336 (let ((first (nth 0 desktop-buffer-misc))
4337 (second (nth 1 desktop-buffer-misc)))
4338 (when (and first second)
4339 (when desktop-buffer-name
4340 (set-buffer (get-buffer-create desktop-buffer-name))
4341 (Info-mode))
4342 (Info-find-node first second)
4343 (current-buffer))))
4345 (add-to-list 'desktop-buffer-mode-handlers
4346 '(Info-mode . Info-restore-desktop-buffer))
4348 ;;;; Bookmark support
4350 (defvar bookmark-search-size)
4352 ;; This is only called from bookmark.el.
4353 (declare-function bookmark-buffer-file-name "bookmark" ())
4355 (defun Info-bookmark-make-record ()
4356 `(,Info-current-node
4357 (filename . ,(bookmark-buffer-file-name))
4358 (front-context-string
4359 . ,(if (>= (- (point-max) (point)) bookmark-search-size)
4360 (buffer-substring-no-properties
4361 (point)
4362 (+ (point) bookmark-search-size))
4363 nil))
4364 (rear-context-string
4365 . ,(if (>= (- (point) (point-min)) bookmark-search-size)
4366 (buffer-substring-no-properties
4367 (point)
4368 (- (point) bookmark-search-size))
4369 nil))
4370 (info-node . ,Info-current-node)
4371 (handler . Info-bookmark-jump)))
4374 (defvar bookmark-current-bookmark)
4375 (declare-function bookmark-prop-get "bookmark" (bookmark prop))
4376 (declare-function bookmark-file-or-variation-thereof "bookmark" (file))
4377 (declare-function bookmark-jump-noselect "bookmark" (str))
4378 (declare-function bookmark-get-bookmark-record "bookmark" (bookmark))
4380 ;;;###autoload
4381 (defun Info-bookmark-jump (bmk)
4382 ;; This implements the `handler' function interface for record type returned
4383 ;; by `Info-bookmark-make-record', which see.
4384 (let* ((file (expand-file-name (bookmark-prop-get bmk 'filename)))
4385 (forward-str (bookmark-prop-get bmk 'front-context-string))
4386 (behind-str (bookmark-prop-get bmk 'rear-context-string))
4387 (info-node (bookmark-prop-get bmk 'info-node)))
4388 (if (setq file (bookmark-file-or-variation-thereof file))
4389 (save-excursion
4390 (save-window-excursion
4391 (with-no-warnings
4392 (Info-find-node file info-node))
4393 ;; Go searching forward first. Then, if forward-str exists and was
4394 ;; found in the file, we can search backward for behind-str.
4395 ;; Rationale is that if text was inserted between the two in the
4396 ;; file, it's better to be put before it so you can read it, rather
4397 ;; than after and remain perhaps unaware of the changes.
4398 (if forward-str
4399 (if (search-forward forward-str (point-max) t)
4400 (goto-char (match-beginning 0))))
4401 (if behind-str
4402 (if (search-backward behind-str (point-min) t)
4403 (goto-char (match-end 0))))
4404 `((buffer ,(current-buffer)) (position ,(point))))))))
4406 (provide 'info)
4408 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4409 ;;; info.el ends here