| blob | 03618cc098d2e7318984432a0b123e13341d2a8a |
1 ;;; info.el --- info package for Emacs
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
5 ;; Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Keywords: help
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Note that nowadays we expect Info files to be made using makeinfo.
28 ;; In particular we make these assumptions:
29 ;; - a menu item MAY contain colons but not colon-space ": "
30 ;; - a menu item ending with ": " (but not ":: ") is an index entry
31 ;; - a node name MAY NOT contain a colon
32 ;; This distinction is to support indexing of computer programming
33 ;; language terms that may contain ":" but not ": ".
35 ;;; Code:
40 "Info subsystem."
46 "Stack of Info nodes user has visited.
50 "Stack of Info nodes user has visited with `Info-history-back' command.
54 "List of all Info nodes user has visited.
59 This is convenient if you want to write Info files by hand.
60 However, we recommend that you not do this.
61 It is better to write a Texinfo file and generate the Info file from that,
62 because that gives you a printed manual as well."
67 "Non-nil allows Info to execute Lisp code associated with nodes.
75 "Face for Info node names."
84 "Face for info titles at level 1."
86 ;; backward-compatibility alias
92 "Face for info titles at level 2."
94 ;; backward-compatibility alias
100 "Face for info titles at level 3."
102 ;; backward-compatibility alias
108 "Face for info titles at level 4."
110 ;; backward-compatibility alias
115 :underline t
118 :inherit variable-pitch
120 "Face for headers in Info menus."
126 "Face for every third `*' in an Info menu."
132 "Face for unvisited Info cross-references."
137 "Face for visited Info cross-references."
142 "Non-nil to fontify references to visited nodes in `info-xref-visited' face."
148 "Maximum size of menu to fontify if `font-lock-mode' is non-nil.
149 Set to nil to disable node fontification."
154 "Non-nil means to put the beginning-of-node links in an Emacs header-line.
155 A header-line does not scroll with the rest of the buffer."
161 "Face for Info cross-references in a node header."
166 "Face for Info nodes in a node header."
170 "List of directories to search for Info documentation files.
171 If nil, meaning not yet initialized, Info uses the environment
172 variable INFOPATH to initialize it, or `Info-default-directory-list'
173 if there is no INFOPATH variable in the environment, or the
174 concatenation of the two if INFOPATH ends with a colon.
176 When `Info-directory-list' is initialized from the value of
177 `Info-default-directory-list', and Emacs is installed in one of the
178 standard directories, the directory of Info files that come with Emacs
179 is put last (so that local Info files override standard ones).
181 When `Info-directory-list' is initialized from the value of
182 `Info-default-directory-list', and Emacs is not installed in one
183 of the standard directories, the first element of the resulting
184 list is the directory where Emacs installs the Info files that
185 come with it. This is so that Emacs's own manual, which suits the
186 version of Emacs you are using, will always be found first. This
187 is useful when you install an experimental version of Emacs without
188 removing the standard installation.
190 If you want to override the order of directories in
191 `Info-default-directory-list', set INFOPATH in the environment.
193 If you run the Emacs executable from the `src' directory in the Emacs
194 source tree, and INFOPATH is not defined, the `info' directory in the
195 source tree is used as the first element of `Info-directory-list', in
196 place of the installation Info directory. This is useful when you run
200 "List of additional directories to search for Info documentation files.
201 These directories are searched after those in `Info-directory-list'."
208 If this is non-nil, and you scroll far enough in a node that its menu
210 moves to a subnode indicated by the following menu item. This means
211 that you visit a subnode before getting to the end of the menu.
213 Setting this option to nil results in behavior similar to the stand-alone
214 Info reader program, which visits the first subnode from the menu only
215 when you hit the end of the current node."
221 "If non-nil, hide the tag and section reference in *note and * menu items.
223 If value is non-nil but not t or `hide', the reference section is still shown.
224 `nil' completely disables this feature. If this is non-nil, you might
225 want to set `Info-refill-paragraphs'."
234 "If non-nil, attempt to refill paragraphs with hidden references.
235 This refilling may accidentally remove explicit line breaks in the Info
236 file, so be prepared for a few surprises if you enable this feature.
237 This only has an effect if `Info-hide-note-references' is non-nil."
243 "Depth of breadcrumbs to display.
244 0 means do not display breadcrumbs."
248 "If non-nil, regular expression to match a sequence of whitespace chars.
249 This applies to Info search for regular expressions.
251 In the Customization buffer, that is `[' followed by a space,
252 a tab, a carriage return (control-M), a newline, and `]+'."
257 "If non-nil, isearch in Info searches through multiple nodes.
258 Before leaving the initial Info node, where isearch was started,
259 it fails once with the error message [initial node], and with
260 subsequent C-s/C-r continues through other nodes without failing
261 with this error message in other nodes. When isearch fails for
262 the rest of the manual, it wraps aroung the whole manual and
263 restarts the search from the top/final node depending on
264 search direction.
266 Setting this option to nil restores the default isearch behavior
267 with wrapping around the current Info node."
275 ;; Try to obey obsolete Info-fontify settings.
278 "Hooks run when `Info-mode' is called."
283 "Hooks run when `Info-select-node' is called."
291 "Info file that Info is now looking at, or nil.
292 This is the name that was specified in Info, not the actual file name.
296 "Info subfile that is actually in the *info* buffer now.
303 "Marker pointing at beginning of current Info file's tag table.
316 "List of Info files with information about index cookies support.
317 Each element of the list is a list (FILENAME SUPPORTS-INDEX-COOKIES)
324 "Point location within a selected node.
325 If string, the point is moved to the proper occurrence of the
326 name of the followed cross reference within a selected node.
333 "List of definitions of virtual Info files.
334 Each element of the list has the format (FILENAME (OPERATION . HANDLER) ...)
335 where FILENAME is a regexp that matches a class of virtual Info file names.
336 It should be carefully chosen to not cause file name clashes with
337 existing file names. OPERATION is one of the following operation
338 symbols `find-file', `find-node', `toc-nodes' that define what HANDLER
339 function to call instead of calling the default corresponding function
343 "List of definitions of virtual Info nodes.
344 Each element of the list has the format (NODENAME (OPERATION . HANDLER) ...)
345 where NODENAME is a regexp that matches a class of virtual Info node names.
346 It should be carefully chosen to not cause node name clashes with
347 existing node names. OPERATION is one of the following operation
348 symbols `find-node' that define what HANDLER
349 function to call instead of calling the default corresponding function
356 "Check if Info file FILENAME is virtual."
360 "Find a function that handles operations on virtual manuals.
361 OP is an operation symbol (`find-file', `find-node' or `toc-nodes'),
362 FILENAME is a virtual Info file name, NODENAME is a virtual Info
363 node name. Return a function found either in `Info-virtual-files'
364 or `Info-virtual-nodes'."
367 Info-virtual-files
371 Info-virtual-nodes
375 "Call a function that handles operations on virtual manuals."
379 \f
381 ;; The MS-DOS list should work both when long file names are
382 ;; supported (Windows 9X), and when only 8+3 file names are available.
424 "List of file name suffixes and associated decoding commands.
425 Each entry should be (SUFFIX . STRING); the file is given to
426 the command as standard input.
428 STRING may be a list of strings. In that case, the first element is
429 the command name, and the rest are arguments to that command.
431 If STRING is nil, no decoding is done.
432 Because the SUFFIXes are tried in order, the empty string should
435 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
436 ;; First, on MS-DOS with no long file names support, delete some of
437 ;; the extension in FILENAME to make room.
442 ;; How long is the extension in FILENAME (not counting the dot).
444 ext-left)
445 ;; SUFFIX starts with a dot. If FILENAME already has one,
446 ;; get rid of the one in SUFFIX (unless suffix is empty).
451 ;; How many chars of that extension should we keep?
453 ;; Get rid of the rest of the extension, and add SUFFIX.
456 suffix))))
463 "Insert the contents of an Info file in the current buffer.
464 Do the right thing if the file has been compressed or zipped."
468 t))
470 lfn))
471 fullname decoder done)
473 ;; FILENAME exists--see if that name contains a suffix.
474 ;; If so, set DECODE accordingly.
479 filename)))
483 ;; Try adding suffixes to FILENAME and see if we can find something.
489 ;; If we found a file with a suffix, set DECODER
490 ;; according to the suffix.
492 ;; When the MS-DOS port runs on Windows, we need to check
493 ;; the short variant of a long file name as well.
503 ;; check for conflict with jka-compr
514 default-directory)))
523 "Return non-nil value if FILE supports Info index cookies.
524 Info index cookies were first introduced in 4.7, and all later
525 makeinfo versions output them in index nodes, so we can rely
526 solely on the makeinfo version. This function caches the information
527 in `Info-file-supports-index-cookies-list'."
530 ;; Skip virtual Info files
549 \f
556 "../share/info/"
557 invocation-directory)))
559 infodir
561 "../../../share/info/"
562 invocation-directory))
564 infodir))))))
565 alternative)
568 ;; Uninstalled, Emacs builddir != srcdir.
569 sibling
570 ;; Uninstalled, builddir == srcdir
571 source))
573 ;; On DOS/NT, we use movable executables always,
574 ;; and we must always find the Info dir at run time.
576 nil
577 ;; Use invocation-directory for Info
578 ;; only if we used it for exec-directory also.
581 installation-directory))))
583 Info-default-directory-list
584 ;; `alternative' contains the Info files that came with this
585 ;; version, so we should look there first. `Info-insert-dir'
586 ;; currently expects to find `alternative' first on the list.
588 ;; Don't drop the last part, it might contain non-Emacs stuff.
589 ;; (reverse (cdr (reverse
593 "Initialize `Info-directory-list', if that hasn't been done yet."
606 ;;;###autoload
608 "Like `info' but show the Info buffer in another window."
614 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
616 ;;;###autoload (put 'info 'info-file "emacs")
617 ;;;###autoload
619 "Enter Info, the documentation browser.
620 Optional argument FILE-OR-NODE specifies the file to examine;
621 the default is the top-level directory of Info.
622 Called from a program, FILE-OR-NODE may specify an Info node of the form
623 `(FILENAME)NODENAME'.
624 Optional argument BUFFER specifies the Info buffer name;
625 the default buffer name is *info*. If BUFFER exists,
626 just switch to BUFFER. Otherwise, create a new buffer
627 with the top-level Info directory.
629 In interactive use, a non-numeric prefix argument directs
630 this command to read a file name from the minibuffer.
631 A numeric prefix argument selects an Info buffer with the prefix number
632 appended to the Info buffer name.
634 The search path for Info files is in the variable `Info-directory-list'.
635 The top-level Info directory is made by combining all the files named `dir'
636 in all the directories in that path.
638 See a list of available Info commands in `Info-mode'."
648 ;; If argument already contains parentheses, don't add another set
649 ;; since the argument will then be parsed improperly. This also
650 ;; has the added benefit of allowing node names to be included
651 ;; following the parenthesized filename.
654 file-or-node
658 ;; If we just created the Info buffer, go to the directory.
661 ;;;###autoload
663 "Display the Emacs manual in Info mode."
667 ;;;###autoload
669 "Run Emacs as a standalone Info reader.
670 Usage: emacs -f info-standalone [filename]
684 \f
685 ;; See if the accessible portion of the buffer begins with a node
686 ;; delimiter, and the node header line which follows matches REGEXP.
687 ;; Typically, this test will be followed by a loop that examines the
688 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
689 ;; to have the overhead of this special test inside the loop.
691 ;; This function changes match-data, but supposedly the caller might
692 ;; want to use the results of re-search-backward.
694 ;; The return value is the value of point at the beginning of matching
695 ;; REGEXP, if the function succeeds, nil otherwise.
707 Optional second argument NOERROR, if t, means if file is not found
708 just return nil (no error)."
709 ;; Convert filename to lower case if not found as specified.
710 ;; Expand it.
714 filename noerror))
719 ;; If specified name starts with `./'
720 ;; then just try current directory.
723 ;; No point in searching for an
724 ;; absolute file name
728 Info-additional-directory-list)
729 Info-directory-list)))))
730 ;; Search the directory list for file FILENAME.
735 ;; Try several variants of specified name.
739 t)))
750 lfn
762 filename))))
765 "Go to an Info node specified as separate FILENAME and NODENAME.
766 NO-GOING-BACK is non-nil if recovering from an error in this function;
767 it says do not attempt further (recursive) error recovery."
770 ;; Go into Info buffer.
772 ;; Record the node we are leaving, if we were in one.
774 Info-current-file
776 Info-history))
779 ;;;###autoload
781 "Use Info mode to browse the current Info buffer.
782 With a prefix arg, this queries for the node name to visit first;
783 otherwise, that defaults to `Top'."
793 ;; If called on a non-file buffer, make a fake file name.
797 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
798 ;; but at least it keeps this routine (which is for makeinfo-buffer and
799 ;; Info-revert-buffer-function) out of the way of normal operations.
800 ;;
802 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
803 When *info* is already displaying FILENAME and NODENAME, the window position
804 is preserved, if possible."
820 ;; note goto-line is no good, we want to measure from point-min
827 ;; only add to the history when coming from a different file+node
837 "Find a node in a tag table.
838 MARKER specifies the buffer and position to start searching at.
839 REGEXP is a regular expression matching nodes or references. Its first
840 group should match `Node:' or `Ref:'.
841 CASE-FOLD t means search for a case-insensitive match.
842 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
843 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
844 where the match was found, and MODE is `major-mode' of the buffer in
845 which the match was found."
850 ;; Search tag table
855 major-mode)))))
858 "Find a node in a tag table.
859 MARKER specifies the buffer and position to start searching at.
860 REGEXP is a regular expression matching nodes or references. Its first
861 group should match `Node:' or `Ref:'.
862 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
863 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
864 where the match was found, and MODE is `major-mode' of the buffer in
865 which the match was found.
866 This function tries to find a case-sensitive match first, then a
867 case-insensitive match is tried."
871 result))
874 "Find a node or anchor in the current buffer.
875 REGEXP is a regular expression matching nodes or references. Its first
876 group should match `Node:' or `Ref:'.
877 CASE-FOLD t means search for a case-insensitive match.
878 Value is the position at which a match was found, or nil if not found."
880 found)
892 found)))
895 "Find a node or anchor in the current buffer.
896 REGEXP is a regular expression matching nodes or references. Its first
897 group should match `Node:' or `Ref:'.
898 Value is the position at which a match was found, or nil if not found.
899 This function looks for a case-sensitive match first. If none is found,
900 a case-insensitive match is tried."
914 nodename))
915 anchorpos)
929 ;; Reread a file when moving from a virtual node.
933 ;; Switch files if necessary
938 Info-current-subfile nil
939 Info-current-file-completions nil
940 buffer-file-name nil)
948 ;; See whether file has a tag table. Record the location if yes.
951 ;; Use string-equal, not equal, to ignore text props.
956 ;; We have a tag table. Find its beginning.
957 ;; Is this an indirect file?
963 ;; It is indirect. Copy it to another buffer
964 ;; and record that the tag table is in that buffer.
980 )))
982 ;; Use string-equal, not equal, to ignore text props.
986 ;; Possibilities:
987 ;;
988 ;; 1. Anchor found in tag table
989 ;; 2. Anchor *not* in tag table
990 ;;
991 ;; 3. Node found in tag table
992 ;; 4. Node *not* found in tag table, but found in file
993 ;; 5. Node *not* in tag table, and *not* in file
994 ;;
995 ;; *Or* the same, but in an indirect subfile.
997 ;; Search file for a suitable node.
1007 ;; First, search a tag table, if any
1013 ;; FOUND is (ANCHOR POS MODE).
1016 ;; If this is an indirect file, determine which
1017 ;; file really holds this node and read it in.
1019 ;; Note that the current buffer must be the
1020 ;; *info* buffer on entry to
1021 ;; Info-read-subfile. Thus the hackery above.
1024 ;; Handle anchor
1029 ;; Else we may have a node, which we search for:
1033 ;; Now search from our advised position (or from beg of
1034 ;; buffer) to find the actual node. First, check
1035 ;; whether the node is right where we are, in case the
1036 ;; buffer begins with a node.
1049 ;; No such anchor in tag table or node in tag table or file
1061 ;; Add anchors to the history too
1072 ;; If we did not finish finding the specified node,
1073 ;; go back to the previous one.
1080 ;; Cache the contents of the (virtual) dir file, once we have merged
1081 ;; it for the first time, so we can save time subsequently.
1084 ;; Cache for the directory we decided to use for the default-directory
1085 ;; of the merged dir text.
1088 ;; Record the file attributes of all the files from which we
1089 ;; constructed Info-dir-contents.
1094 ;; Construct the Info directory node by merging the files named `dir'
1095 ;; from various directories. Set the *info* buffer's
1096 ;; default-directory to the first directory we actually get any text
1097 ;; from.
1100 ;; Verify that none of the files we used has changed
1101 ;; since we used it.
1105 ;; Handle symlinks
1108 ;; Don't compare the access time.
1112 Info-dir-file-attributes))))
1118 Info-additional-directory-list)
1119 Info-directory-list))
1121 ;; Bind this in case the user sets it to nil.
1123 ;; This is set non-nil if we find a problem in some input files.
1124 problems
1125 buffers buffer others nodes dirs-done)
1127 ;; Search the directory list for the directory file.
1132 ;; Try several variants of specified name.
1133 ;; Try upcasing, appending `.info', or both.
1148 dirs-done)))
1154 ;; Index nodes include null bytes. DIR
1155 ;; files should not have indices, but who
1156 ;; knows...
1160 file)
1172 ;; Distinguish the dir file that comes with Emacs from all the
1173 ;; others. Yes, that is really what this is supposed to do.
1174 ;; The definition of `Info-directory-list' puts it first on that
1175 ;; list and so last in `buffers' at this point.
1179 ;; Insert the entire original dir file as a start; note that we've
1180 ;; already saved its default directory to use as the default
1181 ;; directory for the whole concatenation.
1184 ;; Look at each of the other buffers one by one.
1187 ;; In each, find all the menus.
1190 ;; Find each menu, and add an elt to NODES for it.
1194 nodename end)
1206 ;; Add to the main menu a menu item for each other node.
1218 end t)
1222 ;; Now take each node of each of the other buffers
1223 ;; and merge it into the main buffer.
1228 ;; Find the like-named node in the main buffer.
1232 nil t)
1237 ;; If none exists, add one.
1240 ;; Merge the text from the other buffer's menu
1241 ;; into the menu in the like-named node in the main buffer.
1244 ;; Kill all the buffers we just made, including the special one excised.
1264 ;; Remove duplicate headings in the same menu.
1267 ;; Look for the next heading to unify.
1272 ;; Check whether this heading should be streamlined.
1282 ;; Look for other headings of the same category and merge them.
1288 ;; Delete redundant heading.
1290 ;; Push the entries onto `text'.
1297 entries)
1299 ;; Insert the entries just found.
1307 ;; Now remove duplicate entries under the same heading.
1313 ;; Fold case straight away; `member-ignore-case' here wasteful.
1323 ;; Note that on entry to this function the current-buffer must be the
1324 ;; *info* buffer; not the info tags buffer.
1326 ;; NODEPOS is either a position (in the Info file as a whole,
1327 ;; not relative to a subfile) or the name of a subfile.
1329 lastfilename)
1340 thisfilepos thisfilename)
1344 ;; read in version 19 stops at the end of number.
1345 ;; Advance to the next line.
1354 ;; Assume previous buffer is in Info-mode.
1355 ;; (set-buffer (get-buffer "*info*"))
1364 ;; Widen in case we are in the same subfile as before.
1374 "Unescape double quotes and backslashes in VALUE."
1380 unquote))
1382 ;; As of Texinfo 4.6, makeinfo writes constructs like
1383 ;; \0\h[image param=value ...\h\0]
1384 ;; into the Info file for handling images.
1387 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1388 whitespace or double quotes, it must be quoted in double quotes and
1393 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1394 parameter-string start)
1400 parameter-alist))
1401 parameter-alist))
1404 "Display images in current node."
1411 nil t)
1425 ;; text-only display, show alternative text if provided, or
1426 ;; otherwise a clue that there's meant to be a picture
1435 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1436 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1437 ;; including one optional trailing newline.
1439 "Hide unrecognized cookies in current node."
1446 nil t)
1453 "Select the Info node that point is in."
1454 ;; Bind this in case the user sets it to nil.
1457 ;; Find beginning of node.
1463 ;; Get nodename spelled as it is in the node.
1471 ;; Find the end of it, and narrow.
1474 ;; Narrow to the node contents
1486 ;; Add a new unique history item to full history list
1501 map)
1509 " ("
1514 ") "
1519 'help-echo
1520 "mouse-1: scroll forward, mouse-3: scroll back"
1524 \f
1525 ;; Go to an Info node specified with a filename-and-nodename string
1526 ;; of the sort that is found in pointers in nodes.
1528 ;; Don't autoload this function: the correct entry point for other packages
1529 ;; to use is `info'. --Stef
1530 ;; ;;;###autoload
1532 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1533 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1534 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1535 its sub-files).
1536 Completion is available, but only for node names in the current Info file.
1537 If FORK is non-nil (interactively with a prefix arg), show the node in
1538 a new Info buffer.
1539 If FORK is a string, it is the name to use for the new buffer."
1547 nodename)
1549 ""
1563 "Virtual completion table for file names input in Info node names.
1564 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1578 ;; If the file name has no suffix or a standard suffix,
1579 ;; include it.
1582 ;; But exclude subfiles of split Info files.
1584 ;; And exclude backup files.
1587 ;; If the file name ends in a standard suffix,
1588 ;; add the unsuffixed name as a completion option.
1594 ;; This function is used as the "completion table" while reading a node name.
1595 ;; It does completion using the alist in Info-read-node-completion-table
1596 ;; unless STRING starts with an open-paren.
1599 ;; First complete embedded file names.
1602 "("
1605 Info-directory-list
1608 predicate
1609 code))
1611 ;; If a file name was given, then any node is fair game.
1617 ;; Otherwise use Info-read-node-completion-table.
1619 code Info-read-node-completion-table string predicate))))
1621 ;; Arrange to highlight the proper letters in the completion list buffer.
1630 nodename)))
1635 ;; Bind this in case the user sets it to nil.
1650 compl))))
1653 ;; If the buffer begins with a node header, process that first.
1656 ;; Now for the rest of the nodes.
1664 compl))))))))
1667 \f
1669 "If this node has been visited, restore the point value when we left."
1672 ;; Use string-equal, not equal, to ignore text props.
1678 \f
1686 "Search for REGEXP, starting from point, and select node it's found in.
1687 If DIRECTION is `backward', search in the reverse direction."
1715 ;; Hide Info file header for backward search
1726 Info-search-whitespace-regexp)))
1741 ;; If no subfiles, give error now.
1746 Info-search-whitespace-regexp)))
1757 ;; Try other subfiles.
1767 ;; Find the subfile we just searched.
1769 ;; Skip that one.
1772 ;; Make a list of all following subfiles.
1773 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1782 list))
1786 ;; Put in forward order
1792 ;; Hide Info file header for backward search
1806 Info-search-whitespace-regexp)))
1829 ;; Search landed in the same node
1835 ;; Use string-equal, not equal, to ignore text props.
1841 Info-history))))))
1844 "Search for a regexp case-sensitively."
1850 "Search for next regexp from a previous `Info-search' command."
1858 "Search for REGEXP in the reverse direction."
1877 nil t)
1878 ;; Lax version of word search
1884 bound noerror count
1887 bound noerror count
1914 ;; Don't stop at initial node for nonincremental search.
1915 ;; Otherwise this variable is set after first search failure.
1919 "Test whether the current search hit is a visible useful text.
1920 Return non-nil if the text from BEG-FOUND to FOUND is visible
1921 and is not in the header line or a tag table."
1932 ;; Skip node header line
1936 ;; Skip Tag Table node
1942 \f
1944 "Extract the value of the node-pointer named NAME.
1945 If there is none, use ERRORNAME in the error message;
1946 if ERRORNAME is nil, just return nil."
1947 ;; Bind this in case the user sets it to nil.
1961 "Return a regexp matching a node name.
1962 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1963 saying which chars may appear in the node name.
1964 Submatch 1 is the complete node name.
1965 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1966 Submatch 3 is the local part of the node name.
1967 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1974 ;;; For compatibility; other files have used this name.
1980 "Go to the next node of this node."
1982 ;; In case another window is currently selected
1988 "Go to the previous node of this node."
1990 ;; In case another window is currently selected
1996 "Go to the superior node of this node.
1997 If SAME-FILE is non-nil, do not move to a different Info file."
1999 ;; In case another window is currently selected
2018 nil t))
2024 "Go back in the history to the last node visited."
2030 Info-history-forward))
2031 filename nodename opoint)
2044 "Go forward in the history of visited nodes."
2049 filename nodename opoint)
2056 \f
2062 ))
2065 "Directory-specific implementation of Info-directory-toc-nodes."
2066 `(,filename
2070 "Directory-specific implementation of Info-find-file."
2071 filename)
2074 "Directory-specific implementation of Info-find-node-2."
2077 ;;;###autoload
2079 "Go to the Info directory node."
2082 \f
2088 ))
2091 "History-specific implementation of Info-history-toc-nodes."
2092 `(,filename
2096 "History-specific implementation of Info-find-file."
2097 filename)
2100 "History-specific implementation of Info-find-node-2."
2118 "Go to a node with a menu of visited nodes."
2123 \f
2127 ))
2130 "Toc-specific implementation of Info-find-node-2."
2135 curr-file curr-node))
2154 "Go to a node with table of contents of the current Info file.
2155 Table of contents is created from the tree structure of menus."
2165 "Insert table of contents with references to nodes."
2177 "Build table of contents from menus of Info FILE and its subfiles."
2182 default-directory))
2185 nodes subfiles)
2187 ;; (or main-file (message "Searching subfile %s..." (car subfiles)))
2198 bound t)
2201 menu-items)
2211 bound))
2214 ;; Menu item line
2224 ;; Other non-empty strings in the Top node are section names
2233 nodes))
2242 subfiles)))))
2244 main-file nil))
2250 "Alist of cached parent-children node information in visited Info files.
2251 Each element is (FILE (NODE-NAME PARENT SECTION CHILDREN) ...)
2252 where PARENT is the parent node extracted from the Up pointer,
2253 SECTION is the section name in the Top node where this node is placed,
2257 "Return a node list of Info FILENAME with parent-children information.
2258 This information is cached in the variable `Info-toc-nodes' with the help
2259 of the function `Info-toc-build'."
2263 filename))
2267 ;; Skip virtual Info files
2271 ;; Scan the entire manual and cache the result in Info-toc-nodes
2274 nodes)
2275 ;; If there is an error, still add nil to the cache
2279 \f
2281 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2282 FOOTNOTENAME may be an abbreviation of the reference name.
2283 If FORK is non-nil (interactively with a prefix arg), show the node in
2284 a new Info buffer. If FORK is a string, it is the name to use for the
2285 new buffer."
2291 ;; Store end and beginning of line.
2300 ;; See if this one should be the default.
2305 ;; See if this one should be the alternate default.
2315 ;; Record as a completion and perhaps as default.
2318 ;; Don't add this string if it's a duplicate.
2321 ;; If no good default was found, try an alternate.
2324 ;; If only one cross-reference found, then make it default.
2330 "Follow reference named (default "
2333 completions nil t)))
2347 ;; Move point to the beginning of reference if point is on reference
2357 ;; Go to the reference closest to point
2365 next-ref prev-ref))
2376 ;; We allow newline because this is also used in Info-follow-reference,
2377 ;; where the xref name might be wrapped over two lines.
2378 "Regexp that matches a menu entry name upto but not including the colon.
2379 Because of ambiguities, this should be concatenated with something like
2400 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2401 ;;; (setq Info-point-loc
2402 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2403 )
2407 ;; If the node name is the menu entry name (using `entry::').
2411 ;; No one calls this.
2412 ;;(defun Info-menu-item-sequence (list)
2413 ;; (while list
2414 ;; (Info-menu (car list))
2415 ;; (setq list (cdr list))))
2427 ;; This uses two dynamically bound variables:
2428 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2429 ;; is the menu of items we're trying to complete.
2430 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2431 ;; also look for menu items in subsequent nodes as long as those
2432 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2433 ;; not used.
2434 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2435 ;; also look for menu items in these nodes. This feature is currently
2436 ;; only used for completion in Info-index.
2438 ;; Note that `Info-complete-menu-buffer' could be current already,
2439 ;; so we want to save point.
2445 nextnode)
2454 completions
2456 ;; Check the cache.
2464 ;; We can reuse the previous list.
2466 ;; The cache can't be used.
2471 completions))
2472 ;; Check subsequent nodes if applicable.
2480 ;; Go back to the start node (for the next completion).
2483 ;; Update the cache.
2486 Info-complete-next-re string completions
2487 Info-complete-nodes)))
2494 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2495 The menu item should one of those listed in the current node's menu.
2496 Completion is allowed, and the default menu item is the one point is on.
2497 If FORK is non-nil (interactively with a prefix arg), show the node in
2498 a new Info buffer. If FORK is a string, it is the name to use for the
2499 new buffer."
2502 ;; If point is within a menu item, use that item as the default
2505 beg
2518 Info-menu-entry-name-re
2527 default)
2530 ;; we rely on the fact that completing-read accepts an input
2531 ;; of "" even when the require-match argument is true and ""
2532 ;; is not a valid possibility
2536 ;; ask again
2539 ;; there is a problem here in that if several menu items have the same
2540 ;; name you can only go to the node of the first with this command.
2558 ;; If COUNT is nil, use the last item in the menu.
2574 nil))
2578 "Go to the node of the Nth menu item.
2579 N is the digit argument used to invoke this command."
2586 "Go to the Top node of this file."
2591 "Go to the final node in this file."
2596 ;; Go to the last node in the menu of Top. But don't delve into
2597 ;; detailed node listings.
2599 ;; If the last node in the menu is not last in pointer structure,
2600 ;; move forward (but not down- or upward - see bug#1116) until we
2601 ;; can't go any farther.
2603 ;; Then keep moving down to last subnode, unless we reach an index.
2609 "Go forward one node, considering all nodes as forming one sequence."
2614 ;; three possibilities, in order of priority:
2615 ;; 1. next node is in a menu in this node (but not in an index)
2616 ;; 2. next node is next at same level
2617 ;; 3. next node is up and next
2622 t)
2625 t)
2628 ;; Use string-equal, not equal, to ignore text props.
2641 "Go backward one node, considering all nodes as forming one sequence."
2649 ;; Use string-equal, not equal,
2650 ;; to ignore text properties.
2655 ;; If we move back at the same level,
2656 ;; go down to find the last subnode*.
2666 "Exit Info by selecting some other buffer."
2673 "Go to the node of the next menu item."
2675 ;; Bind this in case the user sets it to nil.
2687 "Go to the node of the previous menu item."
2691 ;; Bind this in case the user sets it to nil.
2706 "Go to the next subnode or the next node, or go up a level."
2711 ;; Since we have already gone thru all the items in this menu,
2712 ;; go up to the end of this node.
2714 ;; Since logically we are done with the node with that menu,
2715 ;; move on from it. But don't add intermediate nodes
2716 ;; to the history on recursive calls.
2723 "Go to the last node, popping up a level if there is none."
2727 ;; If we go down a menu item, go to the end of the node
2728 ;; so we can scroll back through it.
2730 ;; Keep going down, as long as there are nested menu nodes.
2733 ;; If we go down a menu item, go to the end of the node
2734 ;; so we can scroll back through it.
2744 ;; If we go down a menu item, go to the end of the node
2745 ;; so we can scroll back through it.
2756 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2757 Once you scroll far enough in a node that its menu appears on the screen
2758 but after point, the next scroll moves into its first subnode, unless
2759 `Info-scroll-prefer-subnodes' is nil.
2761 When you scroll past the end of a node, that goes to the next node if
2762 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2763 if this node has no successor, it moves to the parent node's successor,
2764 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2765 the menu of a node, it moves to subnode indicated by the following menu
2766 item. (That case won't normally result from this command, but can happen
2767 in other ways.)"
2789 "Scroll one screenful forward in Info, using the mouse.
2790 See `Info-scroll-up'."
2798 "Scroll one screenful back in Info, considering all nodes as one sequence.
2799 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2800 is non-nil, this goes to its last subnode. When you scroll past the
2801 beginning of a node, that goes to the previous node or back up to the
2802 parent node."
2816 current-point
2817 t)))))
2824 "Scroll one screenful backward in Info, using the mouse.
2825 See `Info-scroll-down'."
2833 "Move cursor to the next cross-reference or menu item in the node."
2855 "Move cursor to the previous cross-reference or menu item in the node."
2874 \f
2876 "Alist of cached index node names of visited Info files.
2880 "Return a list of names of all index nodes in Info FILE.
2881 If FILE is omitted, it defaults to the current Info file.
2882 First look in a list of cached index node names. Then scan Info
2883 file and its subfiles for nodes with the index cookie. Then try
2884 to find index nodes starting from the first node in the top level
2889 ;; Skip virtual Info files
2894 ;; Find nodes with index cookie
2898 default-directory))
2899 Info-history Info-history-list Info-fontify-maximum-menu-size
2919 subfiles)))))
2921 main-file nil))
2927 nodes)
2928 ;; Else find nodes with the word "Index" in the node name
2930 Info-history Info-history-list Info-fontify-maximum-menu-size Info-point-loc
2931 nodes node)
2949 nodes))
2950 ;; If file has no index nodes, still add it to the cache
2955 "Return non-nil value if NODE is an index node.
2956 If NODE is nil, check the current Info node.
2957 If FILE is nil, check the current Info file."
2963 ;; Don't search all index nodes if request is only for the current node
2964 ;; and file is not in the cache of index nodes
2978 "Go to the first index node."
2983 ;;;###autoload
2985 "Look up a string TOPIC in the index for this manual and go to that entry.
2986 If there are no exact matches to the specified topic, this chooses
2987 the first match which is a case-insensitive substring of a topic.
2989 Give an empty topic name to go to the Index node itself."
3005 ;; Strip leading colon in topic; index format does not allow them.
3011 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
3020 ;; We bind Info-history to nil for internal node-switches so
3021 ;; that we don't put junk in the history. In the first
3022 ;; Info-goto-index call, above, we do update the history
3023 ;; because that is what the user's previous node choice into it.
3025 found)
3032 Info-current-node
3035 matches))
3042 ;; Here it is a feature that assoc is case-sensitive.
3075 'Info-index-next overriding-local-map
3076 t)))
3080 "Move point to the place within the current node where NAME is defined."
3085 ;; Find a function definition with a return type.
3093 nil t))
3095 ;; Try again without the " <1>" makeinfo can append
3100 \f
3104 ))
3107 "Alist of cached matched index search nodes.
3108 Each element is ((FILENAME . TOPIC) MATCHES) where
3109 FILENAME is the file name of the manual,
3110 TOPIC is the search string given as an argument to `Info-virtual-index',
3114 "Index-specific implementation of Info-find-node-2."
3115 ;; Generate Index-like menu of matches
3117 ;; Generate Index-like menu of matches
3120 Info-virtual-index-nodes))))
3137 ;; Else, Generate a list of previous search results
3154 "Show a node with all lines in the index containing a string TOPIC.
3155 Like `Info-index' but displays a node with index search results.
3156 Give an empty topic name to go to the node with links to previous
3157 search results."
3158 ;; `interactive' is a copy from `Info-index'
3177 nodename)
3178 ;; Reuse `Info-index' to set `Info-index-alternatives'.
3181 Info-virtual-index-nodes)
3182 ;; Clean up unneccessary side-effects of `Info-index'.
3187 \f
3193 ))
3199 "Alist of cached apropos matched nodes.
3200 Each element is (NODENAME STRING MATCHES) where
3201 NODENAME is the name of the node that holds the search result,
3202 STRING is the search string given as an argument to `info-apropos',
3206 "Apropos-specific implementation of Info-apropos-toc-nodes."
3208 `(,filename
3213 "Apropos-specific implementation of Info-find-file."
3214 filename)
3217 "Apropos-specific implementation of Info-find-node-2."
3219 ;; Generate Top menu
3222 Info-apropos-file nodename))
3231 ;; Else, Generate Index-like menu of matches
3236 Info-apropos-file nodename))
3254 "Collect STRING matches from all known Info files on your system.
3255 Return a list of matches where each element is in the format
3256 \((FILENAME INDEXTEXT NODENAME LINENUMBER))."
3259 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
3265 manuals matches node nodes)
3268 ;; current-node and current-file are nil when they invoke info-apropos
3269 ;; as the first Info command, i.e. info-apropos loads info.el. In that
3270 ;; case, we use (DIR)Top instead, to avoid signalling an error after
3271 ;; the search is complete.
3279 ;; add-to-list makes sure we don't have duplicates in `manuals',
3280 ;; so that the following dolist loop runs faster.
3297 matches)))
3306 Info-history-list ohist-list)
3310 ;;;###autoload
3312 "Grovel indices of all known Info files on your system for STRING.
3313 Build a menu of the possible matches."
3324 Info-apropos-nodes)
3326 \f
3328 "Make command be undefined in Info."
3333 "Enter the Info tutorial."
3338 "Help-Small-Screen"
3342 "Display a brief summary of all Info commands."
3357 flag))
3360 \f
3362 "Return the token around POS.
3363 POS must be somewhere inside the token
3364 START is a regular expression which will match the
3365 beginning of the tokens delimited string
3366 ALL is a regular expression with a single
3367 parenthesized subpattern which is the token to be
3368 returned. E.g. '{\(.*\)}' would return any string
3369 enclosed in braces around POS.
3370 ERRORSTRING optional fourth argument, controls action on no match
3371 nil: return nil
3372 t: beep
3373 a string: signal an error, using that string."
3377 ;; First look for a match for START that goes across POS.
3381 ;; If we did not find one, search back for START
3382 ;; (this finds only matches that end at or before POS).
3395 nil)
3398 nil)
3404 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3405 At end of the node's text, moves to the next node, or up if none."
3413 "Follow a node reference near point.
3414 If point is on a reference, follow that reference. Otherwise,
3415 if point is in a menu item description, follow that menu item.
3417 If FORK is non-nil (interactively with a prefix arg), show the node in
3418 a new Info buffer.
3419 If FORK is a string, it is the name to use for the new buffer."
3431 t)))
3433 ;; Don't raise an error when mouse-1 is bound to this - it's
3434 ;; often used to simply select the window or frame.
3438 ;; Common subroutine.
3440 "Follow a node reference near point. Return non-nil if successful.
3441 If FORK is non-nil, it is passed to `Info-goto-node'."
3450 ;; menu item: node name
3453 ;; menu item: node name or index entry
3467 node))
3468 \f
3479 (define-key map "1" 'Info-nth-menu-item)
3480 (define-key map "2" 'Info-nth-menu-item)
3481 (define-key map "3" 'Info-nth-menu-item)
3482 (define-key map "4" 'Info-nth-menu-item)
3483 (define-key map "5" 'Info-nth-menu-item)
3484 (define-key map "6" 'Info-nth-menu-item)
3485 (define-key map "7" 'Info-nth-menu-item)
3486 (define-key map "8" 'Info-nth-menu-item)
3487 (define-key map "9" 'Info-nth-menu-item)
3488 (define-key map "0" 'undefined)
3489 (define-key map "?" 'Info-summary)
3490 (define-key map "]" 'Info-forward-node)
3491 (define-key map "[" 'Info-backward-node)
3492 (define-key map "<" 'Info-top-node)
3493 (define-key map ">" 'Info-final-node)
3494 (define-key map "b" 'beginning-of-buffer)
3495 (define-key map "d" 'Info-directory)
3496 (define-key map "e" 'Info-edit)
3497 (define-key map "f" 'Info-follow-reference)
3498 (define-key map "g" 'Info-goto-node)
3499 (define-key map "h" 'Info-help)
3500 (define-key map "i" 'Info-index)
3501 (define-key map "I" 'Info-virtual-index)
3502 (define-key map "l" 'Info-history-back)
3503 (define-key map "L" 'Info-history)
3504 (define-key map "m" 'Info-menu)
3505 (define-key map "n" 'Info-next)
3506 (define-key map "p" 'Info-prev)
3507 (define-key map "q" 'Info-exit)
3508 (define-key map "r" 'Info-history-forward)
3509 (define-key map "s" 'Info-search)
3510 (define-key map "S" 'Info-search-case-sensitively)
3511 (define-key map "\M-n" 'clone-buffer)
3512 (define-key map "t" 'Info-top-node)
3513 (define-key map "T" 'Info-toc)
3514 (define-key map "u" 'Info-up)
3515 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3516 (define-key map "w" 'Info-copy-current-node-name)
3517 (define-key map "c" 'Info-copy-current-node-name)
3518 ;; `^' for consistency with `dired-up-directory'.
3519 (define-key map "^" 'Info-up)
3520 (define-key map "," 'Info-index-next)
3522 (define-key map [mouse-2] 'Info-mouse-follow-nearest-node)
3523 (define-key map [follow-link] 'mouse-face)
3524 map)
3525 "Keymap containing Info commands.")
3528 (defun Info-check-pointer (item)
3529 "Non-nil if ITEM is present in this node."
3530 (condition-case nil
3531 (Info-extract-pointer item)
3532 (error nil)))
3534 (easy-menu-define
3535 Info-mode-menu Info-mode-map
3536 "Menu for Info files."
3537 '("Info"
3538 ["Up" Info-up :active (Info-check-pointer "up")
3539 :help "Go up in the Info tree"]
3540 ["Next" Info-next :active (Info-check-pointer "next")
3541 :help "Go to the next node"]
3542 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3543 :help "Go to the previous node"]
3544 ["Backward" Info-backward-node
3545 :help "Go backward one node, considering all as a sequence"]
3546 ["Forward" Info-forward-node
3547 :help "Go forward one node, considering all as a sequence"]
3548 ["Beginning" beginning-of-buffer
3549 :help "Go to beginning of this node"]
3550 ["Top" Info-top-node
3551 :help "Go to top node of file"]
3552 ["Final Node" Info-final-node
3553 :help "Go to final node in this file"]
3554 ("Menu Item" ["You should never see this" report-emacs-bug t])
3555 ("Reference" ["You should never see this" report-emacs-bug t])
3556 ["Search..." Info-search
3557 :help "Search for regular expression in this Info file"]
3558 ["Search Next" Info-search-next
3559 :help "Search for another occurrence of regular expression"]
3560 ["Go to Node..." Info-goto-node
3561 :help "Go to a named node"]
3562 ["Back in history" Info-history-back :active Info-history
3563 :help "Go back in history to the last node you were at"]
3564 ["Forward in history" Info-history-forward :active Info-history-forward
3565 :help "Go forward in history"]
3566 ["History" Info-history :active Info-history-list
3567 :help "Go to menu of visited nodes"]
3568 ["Table of Contents" Info-toc
3569 :help "Go to table of contents"]
3570 ("Index"
3571 ["Lookup a String..." Info-index
3572 :help "Look for a string in the index items"]
3573 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3574 :help "Look for another occurrence of previous item"]
3575 ["Lookup a string in all indices..." info-apropos
3576 :help "Look for a string in the indices of all manuals"])
3577 ["Copy Node Name" Info-copy-current-node-name
3578 :help "Copy the name of the current node into the kill ring"]
3579 ["Clone Info buffer" clone-buffer
3580 :help "Create a twin copy of the current Info buffer."]
3581 ["Exit" Info-exit :help "Stop reading Info"]))
3584 (defvar info-tool-bar-map
3585 (let ((map (make-sparse-keymap)))
3586 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map
3587 :rtl "right-arrow")
3588 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map
3589 :rtl "left-arrow")
3590 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map
3591 :rtl "next-node")
3592 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map
3593 :rtl "prev-node")
3594 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3595 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3596 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3597 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3598 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3599 (tool-bar-local-item-from-menu 'Info-exit "exit" map Info-mode-map)
3600 map))
3602 (defvar Info-menu-last-node nil)
3603 ;; Last node the menu was created for.
3604 ;; Value is a list, (FILE-NAME NODE-NAME).
3606 (defun Info-menu-update ()
3607 "Update the Info menu for the current node."
3608 (condition-case nil
3609 (if (or (not (eq major-mode 'Info-mode))
3610 (equal (list Info-current-file Info-current-node)
3611 Info-menu-last-node))
3612 ()
3613 ;; Update menu menu.
3614 (let* ((Info-complete-menu-buffer (current-buffer))
3615 (items (nreverse (condition-case nil
3616 (Info-complete-menu-item "" nil t)
3617 (error nil))))
3618 entries current
3619 (number 0))
3620 (while (and items (< number 9))
3621 (setq current (car items)
3622 items (cdr items)
3623 number (1+ number))
3624 (setq entries (cons `[,current
3625 (Info-menu ,current)
3626 :keys ,(format "%d" number)]
3627 entries)))
3628 (if items
3629 (setq entries (cons ["Other..." Info-menu t] entries)))
3630 (or entries
3631 (setq entries (list ["No menu" nil nil] nil :active)))
3632 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3633 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3634 (let ((items nil)
3635 str i entries current
3636 (number 0)
3637 (case-fold-search t))
3638 (save-excursion
3639 (goto-char (point-min))
3641 (setq str (match-string 1))
3642 (setq i 0)
3644 (setq str (concat (substring str 0 i) " "
3645 (substring str (match-end 0))))
3646 (setq i (1+ i)))
3647 (setq items
3648 (cons str items))))
3649 (while (and items (< number 9))
3650 (setq current (car items)
3651 items (cdr items)
3652 number (1+ number))
3653 (setq entries (cons `[,current
3654 (Info-follow-reference ,current)
3655 t]
3656 entries)))
3657 (if items
3658 (setq entries (cons ["Other..." Info-follow-reference t]
3659 entries)))
3660 (or entries
3661 (setq entries (list ["No references" nil nil] nil :active)))
3662 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3663 ;; Update last seen node.
3664 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3665 ;; Try to avoid entering infinite beep mode in case of errors.
3666 (error (ding))))
3668 \f
3669 (defun Info-copy-current-node-name (&optional arg)
3670 "Put the name of the current Info node into the kill ring.
3671 The name of the Info file is prepended to the node name in parentheses.
3672 With a zero prefix arg, put the name inside a function call to `info'."
3673 (interactive "P")
3674 (unless Info-current-node
3675 (error "No current Info node"))
3676 (let ((node (if (stringp Info-current-file)
3677 (concat "(" (file-name-nondirectory Info-current-file) ") "
3678 Info-current-node))))
3679 (if (zerop (prefix-numeric-value arg))
3681 (unless (stringp Info-current-file)
3682 (setq node (format "(Info-find-node '%S '%S)"
3683 Info-current-file Info-current-node)))
3684 (kill-new node)
3685 (message "%s" node)))
3687 \f
3688 ;; Info mode is suitable only for specially formatted data.
3689 (put 'Info-mode 'mode-class 'special)
3690 (put 'Info-mode 'no-clone-indirect t)
3692 (defvar tool-bar-map)
3693 (defvar bookmark-make-record-function)
3695 ;; Autoload cookie needed by desktop.el
3696 ;;;###autoload
3697 (defun Info-mode ()
3698 "Info mode provides commands for browsing through the Info documentation tree.
3700 one topic and contains references to other nodes which discuss related
3701 topics. Info has commands to follow the references and show you other nodes.
3707 Selecting other nodes:
3709 Follow a node reference you click on.
3710 This works with menu items, cross references, and
3712 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3717 Picking a menu item causes another node to be selected.
3727 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3731 Moving within a node:
3733 Once you scroll far enough in a node that its menu appears on the
3734 screen but after point, the next scroll moves into its first
3735 subnode. When after all menu items (or if there is no menu),
3736 move up to the parent node.
3738 already visible, try to go to the previous menu entry, or up
3739 if there is none.
3742 Advanced commands:
3744 and select the node in which the next occurrence is found.
3745 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3746 \\[isearch-forward], \\[isearch-forward-regexp] Use Isearch to search through multiple Info nodes.
3748 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3751 You may include a filename as well, as (FILENAME)NODENAME.
3752 1 .. 9 Pick first ... ninth item in node's menu.
3753 Every third `*' is highlighted to help pick the right number.
3757 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3758 (kill-all-local-variables)
3759 (setq major-mode 'Info-mode)
3760 (setq mode-name "Info")
3761 (setq tab-width 8)
3762 (use-local-map Info-mode-map)
3763 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3764 (set-syntax-table text-mode-syntax-table)
3765 (setq local-abbrev-table text-mode-abbrev-table)
3766 (setq case-fold-search t)
3767 (setq buffer-read-only t)
3768 (make-local-variable 'Info-current-file)
3769 (make-local-variable 'Info-current-subfile)
3770 (make-local-variable 'Info-current-node)
3771 (make-local-variable 'Info-tag-table-marker)
3772 (setq Info-tag-table-marker (make-marker))
3773 (make-local-variable 'Info-tag-table-buffer)
3774 (setq Info-tag-table-buffer nil)
3775 (make-local-variable 'Info-history)
3776 (make-local-variable 'Info-history-forward)
3777 (make-local-variable 'Info-index-alternatives)
3778 (if Info-use-header-line ; do not override global header lines
3779 (setq header-line-format
3780 '(:eval (get-text-property (point-min) 'header-line))))
3781 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3782 ;; This is for the sake of the invisible text we use handling titles.
3783 (make-local-variable 'line-move-ignore-invisible)
3784 (setq line-move-ignore-invisible t)
3785 (make-local-variable 'desktop-save-buffer)
3786 (make-local-variable 'widen-automatically)
3787 (setq widen-automatically nil)
3788 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3789 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3790 (add-hook 'clone-buffer-hook 'Info-clone-buffer nil t)
3791 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3792 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3793 (set (make-local-variable 'isearch-search-fun-function)
3794 'Info-isearch-search)
3795 (set (make-local-variable 'isearch-wrap-function)
3796 'Info-isearch-wrap)
3797 (set (make-local-variable 'isearch-push-state-function)
3798 'Info-isearch-push-state)
3799 (set (make-local-variable 'isearch-filter-predicate)
3800 'Info-isearch-filter)
3801 (set (make-local-variable 'search-whitespace-regexp)
3802 Info-search-whitespace-regexp)
3803 (set (make-local-variable 'revert-buffer-function)
3804 'Info-revert-buffer-function)
3805 (Info-set-mode-line)
3806 (set (make-local-variable 'bookmark-make-record-function)
3807 'Info-bookmark-make-record)
3808 (run-mode-hooks 'Info-mode-hook))
3810 ;; When an Info buffer is killed, make sure the associated tags buffer
3811 ;; is killed too.
3812 (defun Info-kill-buffer ()
3813 (and (eq major-mode 'Info-mode)
3814 Info-tag-table-buffer
3815 (kill-buffer Info-tag-table-buffer)))
3817 ;; Placed on `clone-buffer-hook'.
3818 (defun Info-clone-buffer ()
3819 (when (bufferp Info-tag-table-buffer)
3820 (setq Info-tag-table-buffer
3821 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3822 (let ((m Info-tag-table-marker))
3823 (when (markerp m)
3824 (setq Info-tag-table-marker
3825 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3826 (with-current-buffer Info-tag-table-buffer
3827 (copy-marker (marker-position m)))
3828 (make-marker))))))
3830 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3831 (set-keymap-parent map text-mode-map)
3832 (define-key map "\C-c\C-c" 'Info-cease-edit)
3833 map)
3834 "Local keymap used within `e' command of Info.")
3836 ;; Info-edit mode is suitable only for specially formatted data.
3837 (put 'Info-edit-mode 'mode-class 'special)
3839 (defun Info-edit-mode ()
3840 "Major mode for editing the contents of an Info node.
3841 Like text mode with the addition of `Info-cease-edit'
3842 which returns to Info mode for browsing.
3844 (use-local-map Info-edit-map)
3845 (setq major-mode 'Info-edit-mode)
3846 (setq mode-name "Info Edit")
3847 (kill-local-variable 'mode-line-buffer-identification)
3848 (setq buffer-read-only nil)
3849 (force-mode-line-update)
3850 (buffer-enable-undo (current-buffer))
3851 (run-mode-hooks 'Info-edit-mode-hook))
3853 (defun Info-edit ()
3854 "Edit the contents of this Info node.
3855 Allowed only if variable `Info-enable-edit' is non-nil."
3856 (interactive)
3857 (or Info-enable-edit
3858 (error "Editing Info nodes is not enabled"))
3859 (Info-edit-mode)
3860 (message "%s" (substitute-command-keys
3863 (defun Info-cease-edit ()
3864 "Finish editing Info node; switch back to Info proper."
3865 (interactive)
3866 ;; Do this first, so nothing has changed if user C-g's at query.
3867 (and (buffer-modified-p)
3868 (y-or-n-p "Save the file? ")
3869 (save-buffer))
3870 (use-local-map Info-mode-map)
3871 (setq major-mode 'Info-mode)
3872 (setq mode-name "Info")
3873 (Info-set-mode-line)
3874 (setq buffer-read-only t)
3875 (force-mode-line-update)
3876 (and (marker-position Info-tag-table-marker)
3877 (buffer-modified-p)
3878 (message "Tags may have changed. Use Info-tagify if necessary")))
3879 \f
3880 (defvar Info-file-list-for-emacs
3881 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3882 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3883 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3884 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3885 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3886 ("copyright" . "autotype") ("executable" . "autotype")
3887 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3888 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3889 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3890 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3891 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3892 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3893 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3894 ("rfc2045" . "emacs-mime")
3895 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3896 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3897 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3898 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3899 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3900 ("mml" . "emacs-mime"))
3901 "List of Info files that describe Emacs commands.
3902 An element can be a file name, or a list of the form (PREFIX . FILE)
3903 where PREFIX is a name prefix and FILE is the file to look in.
3904 If the element is just a file name, the file name also serves as the prefix.")
3906 (defun Info-find-emacs-command-nodes (command)
3907 "Return a list of locations documenting COMMAND.
3908 The `info-file' property of COMMAND says which Info manual to search.
3909 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3910 defines heuristics for which Info manual to try.
3911 The locations are of the format used in `Info-history', i.e.
3912 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3913 in the first element of the returned list (which is treated specially in
3914 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3915 (let ((where '()) line-number
3919 (info-file "emacs")) ;default
3920 ;; Determine which Info file this command is documented in.
3921 (if (get command 'info-file)
3922 (setq info-file (get command 'info-file))
3923 ;; If it doesn't say explicitly, test its name against
3924 ;; various prefixes that we know.
3925 (let ((file-list Info-file-list-for-emacs))
3926 (while file-list
3927 (let* ((elt (car file-list))
3928 (name (if (consp elt)
3929 (car elt)
3930 elt))
3931 (file (if (consp elt) (cdr elt) elt))
3932 (case-fold-search nil)
3935 (if (string-match regexp (symbol-name command))
3936 (setq info-file file file-list nil))
3937 (setq file-list (cdr file-list))))))
3938 (Info-find-node info-file "Top")
3939 ;; Bind Info-history to nil, to prevent the index nodes from
3940 ;; getting into the node history.
3941 (let ((Info-history nil)
3942 (Info-history-list nil)
3943 node (nodes (Info-index-nodes)))
3944 (Info-goto-node (car nodes))
3945 (while
3946 (progn
3947 (goto-char (point-min))
3948 (while (re-search-forward cmd-desc nil t)
3949 (setq where
3950 (cons (list Info-current-file
3951 (match-string-no-properties 2)
3952 0)
3953 where))
3954 (setq line-number (and (match-beginning 3)
3955 (string-to-number (match-string 3)))))
3956 (and (setq nodes (cdr nodes) node (car nodes))))
3957 (Info-goto-node node)))
3958 (if (and line-number where)
3959 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3960 (cdr where))
3961 where)))
3963 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3964 ;;;###autoload
3965 (defun Info-goto-emacs-command-node (command)
3966 "Go to the Info node in the Emacs manual for command COMMAND.
3967 The command is found by looking up in Emacs manual's indices
3968 or in another manual found via COMMAND's `info-file' property or
3969 the variable `Info-file-list-for-emacs'.
3970 COMMAND must be a symbol or string."
3971 (interactive "CFind documentation for command: ")
3972 ;; If command is given as a string, convert it to a symbol.
3973 (if (stringp command)
3974 (setq command (intern command)))
3975 (or (commandp command)
3976 (signal 'wrong-type-argument (list 'commandp command)))
3977 (let ((where (Info-find-emacs-command-nodes command)))
3978 (if where
3979 (let ((num-matches (length where)))
3980 ;; Get Info running, and pop to it in another window.
3981 (save-window-excursion
3982 (info))
3983 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3984 ;; Bind Info-history to nil, to prevent the last Index node
3985 ;; visited by Info-find-emacs-command-nodes from being
3986 ;; pushed onto the history.
3987 (let ((Info-history nil) (Info-history-list nil)
3988 (line-number (nth 2 (car where))))
3989 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3990 (if (and (integerp line-number) (> line-number 0))
3991 (forward-line (1- line-number))))
3992 (if (> num-matches 1)
3993 (progn
3994 ;; (car where) will be pushed onto Info-history
3995 ;; when/if they go to another node. Put the other
3996 ;; nodes that were found on the history.
3997 (setq Info-history (nconc (cdr where) Info-history))
3998 (message "Found %d other entr%s. Use %s to see %s."
3999 (1- num-matches)
4000 (if (> num-matches 2) "ies" "y")
4002 (if (> num-matches 2) "them" "it")))))
4003 (error "Couldn't find documentation for %s" command))))
4005 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
4006 ;;;###autoload
4007 (defun Info-goto-emacs-key-command-node (key)
4008 "Go to the node in the Emacs manual which describes the command bound to KEY.
4009 KEY is a string.
4010 Interactively, if the binding is `execute-extended-command', a command is read.
4011 The command is found by looking up in Emacs manual's indices
4012 or in another manual found via COMMAND's `info-file' property or
4013 the variable `Info-file-list-for-emacs'."
4014 (interactive "kFind documentation for key: ")
4015 (let ((command (key-binding key)))
4016 (cond ((null command)
4017 (message "%s is undefined" (key-description key)))
4018 ((and (interactive-p)
4019 (eq command 'execute-extended-command))
4020 (Info-goto-emacs-command-node
4021 (read-command "Find documentation for command: ")))
4022 (t
4023 (Info-goto-emacs-command-node command)))))
4024 \f
4025 (defvar Info-next-link-keymap
4026 (let ((keymap (make-sparse-keymap)))
4027 (define-key keymap [header-line mouse-1] 'Info-next)
4028 (define-key keymap [header-line mouse-2] 'Info-next)
4029 (define-key keymap [header-line down-mouse-1] 'ignore)
4030 (define-key keymap [mouse-2] 'Info-next)
4031 (define-key keymap [follow-link] 'mouse-face)
4032 keymap)
4033 "Keymap to put on the Next link in the text or the header line.")
4035 (defvar Info-prev-link-keymap
4036 (let ((keymap (make-sparse-keymap)))
4037 (define-key keymap [header-line mouse-1] 'Info-prev)
4038 (define-key keymap [header-line mouse-2] 'Info-prev)
4039 (define-key keymap [header-line down-mouse-1] 'ignore)
4040 (define-key keymap [mouse-2] 'Info-prev)
4041 (define-key keymap [follow-link] 'mouse-face)
4042 keymap)
4043 "Keymap to put on the Prev link in the text or the header line.")
4045 (defvar Info-up-link-keymap
4046 (let ((keymap (make-sparse-keymap)))
4047 (define-key keymap [header-line mouse-1] 'Info-up)
4048 (define-key keymap [header-line mouse-2] 'Info-up)
4049 (define-key keymap [header-line down-mouse-1] 'ignore)
4050 (define-key keymap [mouse-2] 'Info-up)
4051 (define-key keymap [follow-link] 'mouse-face)
4052 keymap)
4053 "Keymap to put on the Up link in the text or the header line.")
4055 (defun Info-insert-breadcrumbs ()
4056 (let ((nodes (Info-toc-nodes Info-current-file))
4057 (node Info-current-node)
4058 (crumbs ())
4059 (depth Info-breadcrumbs-depth))
4061 ;; Get ancestors from the cached parent-children node info
4062 (while (and (not (equal "Top" node)) (> depth 0))
4063 (setq node (nth 1 (assoc node nodes)))
4064 (if node (push node crumbs))
4065 (setq depth (1- depth)))
4067 ;; Add bottom node.
4068 (when Info-use-header-line
4069 ;; Let it disappear if crumbs is nil.
4070 (nconc crumbs (list Info-current-node)))
4071 (when (or Info-use-header-line crumbs)
4072 ;; Add top node (and continuation if needed).
4073 (setq crumbs
4074 (cons "Top" (if (member (pop crumbs) '(nil "Top"))
4075 crumbs (cons nil crumbs))))
4076 ;; Eliminate duplicate.
4077 (forward-line 1)
4078 (dolist (node crumbs)
4079 (let ((text
4080 (if (not (equal node "Top")) node
4081 (format "(%s)Top"
4082 (if (stringp Info-current-file)
4083 (file-name-nondirectory Info-current-file)
4084 ;; Some legacy code can still use a symbol.
4085 Info-current-file)))))
4086 (insert (if (bolp) "" " > ")
4087 (cond
4088 ((null node) "...")
4089 ((equal node Info-current-node)
4090 ;; No point linking to ourselves.
4091 (propertize text 'font-lock-face 'info-header-node))
4092 (t
4093 (concat "*Note " text "::"))))))
4096 (defun Info-fontify-node ()
4097 "Fontify the node."
4098 (save-excursion
4099 (let* ((inhibit-read-only t)
4100 (case-fold-search t)
4101 paragraph-markers
4102 (not-fontified-p ; the node hasn't already been fontified
4103 (not (let ((where (next-single-property-change (point-min)
4104 'font-lock-face)))
4105 (and where (not (= where (point-max)))))))
4106 (fontify-visited-p ; visited nodes need to be re-fontified
4107 (and Info-fontify-visited-nodes
4108 ;; Don't take time to refontify visited nodes in huge nodes
4109 Info-fontify-maximum-menu-size
4110 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
4111 rbeg rend)
4113 ;; Fontify header line
4114 (goto-char (point-min))
4116 (goto-char (match-end 0))
4118 (goto-char (match-end 0))
4119 (let* ((nbeg (match-beginning 2))
4120 (nend (match-end 2))
4121 (tbeg (match-beginning 1))
4122 (tag (match-string 1)))
4123 (if (string-equal (downcase tag) "node")
4124 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
4125 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
4126 (put-text-property tbeg nend 'mouse-face 'highlight)
4127 (put-text-property tbeg nend
4128 'help-echo
4129 (concat "mouse-2: Go to node "
4130 (buffer-substring nbeg nend)))
4131 ;; Always set up the text property keymap.
4132 ;; It will either be used in the buffer
4133 ;; or copied in the header line.
4134 (put-text-property
4135 tbeg nend 'keymap
4136 (cond
4137 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
4138 ((string-equal (downcase tag) "next") Info-next-link-keymap)
4139 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
4141 (when (> Info-breadcrumbs-depth 0)
4142 (Info-insert-breadcrumbs))
4144 ;; Treat header line.
4145 (when Info-use-header-line
4146 (goto-char (point-min))
4147 (let* ((header-end (line-end-position))
4148 (header
4149 ;; If we find neither Next: nor Prev: link, show the entire
4150 ;; node header. Otherwise, don't show the File: and Node:
4151 ;; parts, to avoid wasting precious space on information that
4152 ;; is available in the mode line.
4153 (if (re-search-forward
4155 header-end t)
4156 (progn
4157 (goto-char (match-beginning 1))
4158 (buffer-substring (point) header-end))
4160 header-end t)
4161 (concat "No next, prev or up links -- "
4162 (buffer-substring (point) header-end))
4163 (buffer-substring (point) header-end)))))
4164 (put-text-property (point-min) (1+ (point-min))
4165 'header-line
4166 (replace-regexp-in-string
4167 "%"
4168 ;; Preserve text properties on duplicated `%'.
4169 (lambda (s) (concat s s)) header))
4170 ;; Hide the part of the first line
4171 ;; that is in the header, if it is just part.
4172 (cond
4173 ((> Info-breadcrumbs-depth 0)
4174 (put-text-property (point-min) (1+ header-end) 'invisible t))
4175 ((not (bobp))
4176 ;; Hide the punctuation at the end, too.
4178 (put-text-property (point) header-end 'invisible t))))))
4180 ;; Fontify titles
4181 (goto-char (point-min))
4182 (when (and font-lock-mode not-fontified-p)
4184 nil t)
4185 ;; Only consider it as an underlined title if the ASCII
4186 ;; underline has the same size as the text. A typical
4187 ;; counter example is when a continuation "..." is alone
4188 ;; on a line.
4189 (= (string-width (match-string 1))
4190 (string-width (match-string 2))))
4191 (let* ((c (preceding-char))
4192 (face
4193 (cond ((= c ?*) 'info-title-1)
4194 ((= c ?=) 'info-title-2)
4195 ((= c ?-) 'info-title-3)
4196 (t 'info-title-4))))
4197 (put-text-property (match-beginning 1) (match-end 1)
4198 'font-lock-face face))
4199 ;; This is a serious problem for trying to handle multiple
4200 ;; frame types at once. We want this text to be invisible
4201 ;; on frames that can display the font above.
4202 (when (memq (framep (selected-frame)) '(x pc w32 ns))
4203 (add-text-properties (1- (match-beginning 2)) (match-end 2)
4204 '(invisible t front-sticky nil rear-nonsticky t)))))
4206 ;; Fontify cross references
4207 (goto-char (point-min))
4208 (when (or not-fontified-p fontify-visited-p)
4209 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
4210 (let ((start (match-beginning 0))
4211 (next (point))
4212 other-tag)
4213 (when not-fontified-p
4214 (when Info-hide-note-references
4215 (when (and (not (eq Info-hide-note-references 'hide))
4216 (> (line-number-at-pos) 4)) ; Skip breadcrumbs
4217 ;; *Note is often used where *note should have been
4218 (goto-char start)
4219 (skip-syntax-backward " ")
4220 (when (memq (char-before) '(?\( ?\[ ?\{))
4221 ;; Check whether the paren is preceded by
4222 ;; an end of sentence
4223 (skip-syntax-backward " ("))
4224 (setq other-tag
4226 "")
4228 "")
4229 ((memq (char-before) '(nil ?\. ?! ??))
4230 "See ")
4231 ((save-match-data
4232 (save-excursion
4234 "See ")
4235 (t "see "))))
4236 (goto-char next)
4237 (add-text-properties
4238 (match-beginning 1)
4239 (or (save-match-data
4241 (let ((start1 (match-beginning 1)))
4243 (+ start1 (match-beginning 0)))))
4244 (match-end 1))
4245 (if other-tag
4246 `(display ,other-tag front-sticky nil rear-nonsticky t)
4247 '(invisible t front-sticky nil rear-nonsticky t))))
4248 (add-text-properties
4249 (match-beginning 2) (match-end 2)
4250 (list
4251 'help-echo (if (or (match-end 5)
4252 (not (equal (match-string 4) "")))
4253 (concat "mouse-2: go to " (or (match-string 5)
4254 (match-string 4)))
4255 "mouse-2: go to this node")
4256 'mouse-face 'highlight)))
4257 (when (or not-fontified-p fontify-visited-p)
4258 (setq rbeg (match-beginning 2)
4259 rend (match-end 2))
4260 (put-text-property
4261 rbeg rend
4262 'font-lock-face
4263 ;; Display visited nodes in a different face
4264 (if (and Info-fontify-visited-nodes
4265 (save-match-data
4266 (let* ((node (replace-regexp-in-string
4268 (replace-regexp-in-string
4270 (or (match-string-no-properties 5)
4271 (and (not (equal (match-string 4) ""))
4272 (match-string-no-properties 4))
4273 (match-string-no-properties 2)))))
4274 (external-link-p
4276 (file (if external-link-p
4277 (file-name-nondirectory
4278 (match-string-no-properties 1 node))
4279 Info-current-file))
4280 (hl Info-history-list)
4281 res)
4282 (if external-link-p
4283 (setq node (if (equal (match-string 2 node) "")
4284 "Top"
4285 (match-string-no-properties 2 node))))
4286 (while hl
4287 (if (and (string-equal node (nth 1 (car hl)))
4288 (equal file
4289 (if (and external-link-p
4290 (stringp (caar hl)))
4291 (file-name-nondirectory
4292 (caar hl))
4293 (caar hl))))
4294 (setq res (car hl) hl nil)
4295 (setq hl (cdr hl))))
4296 res))) 'info-xref-visited 'info-xref))
4297 ;; For multiline ref, unfontify newline and surrounding whitespace
4298 (save-excursion
4299 (goto-char rbeg)
4300 (save-match-data
4302 (remove-text-properties (match-beginning 0)
4303 (match-end 0)
4304 '(font-lock-face t))))))
4305 (when not-fontified-p
4306 (when (memq Info-hide-note-references '(t hide))
4307 (add-text-properties (match-beginning 3) (match-end 3)
4308 '(invisible t front-sticky nil rear-nonsticky t))
4309 ;; Unhide the file name of the external reference in parens
4310 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
4311 (remove-text-properties (match-beginning 6) (match-end 6)
4312 '(invisible t front-sticky nil rear-nonsticky t)))
4313 ;; Unhide newline because hidden newlines cause too long lines
4314 (save-match-data
4315 (let ((beg3 (match-beginning 3))
4316 (end3 (match-end 3)))
4318 (not (save-match-data
4319 (save-excursion
4320 (goto-char (1+ end3))
4321 (looking-at "[.)]*$")))))
4322 (remove-text-properties (+ beg3 (match-beginning 0))
4323 (+ beg3 (match-end 0))
4324 '(invisible t front-sticky nil rear-nonsticky t))))))
4325 (when (and Info-refill-paragraphs Info-hide-note-references)
4326 (push (set-marker (make-marker) start)
4327 paragraph-markers))))))
4329 ;; Refill paragraphs (experimental feature)
4330 (when (and not-fontified-p
4331 Info-refill-paragraphs
4332 paragraph-markers)
4333 (let ((fill-nobreak-invisible t)
4334 (fill-individual-varying-indent nil)
4337 (adaptive-fill-mode nil))
4338 (goto-char (point-max))
4339 (dolist (m paragraph-markers)
4340 (when (< m (point))
4341 (goto-char m)
4342 (beginning-of-line)
4343 (let ((beg (point)))
4344 (when (zerop (forward-paragraph))
4345 (fill-individual-paragraphs beg (point) nil nil)
4346 (goto-char beg))))
4347 (set-marker m nil))))
4349 ;; Fontify menu items
4350 (goto-char (point-min))
4351 (when (and (or not-fontified-p fontify-visited-p)
4353 ;; Don't take time to annotate huge menus
4354 Info-fontify-maximum-menu-size
4355 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
4356 (let ((n 0)
4357 cont)
4358 (while (re-search-forward
4361 nil t)
4362 (when (match-beginning 1)
4363 (when not-fontified-p
4364 (setq n (1+ n))
4365 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
4366 (put-text-property (match-beginning 0)
4367 (1+ (match-beginning 0))
4368 'font-lock-face 'info-menu-star)))
4369 (when not-fontified-p
4370 (add-text-properties
4371 (match-beginning 1) (match-end 1)
4372 (list
4373 'help-echo (if (and (match-end 3)
4374 (not (equal (match-string 3) "")))
4375 (concat "mouse-2: go to " (match-string 3))
4376 "mouse-2: go to this node")
4377 'mouse-face 'highlight)))
4378 (when (or not-fontified-p fontify-visited-p)
4379 (put-text-property
4380 (match-beginning 1) (match-end 1)
4381 'font-lock-face
4382 ;; Display visited menu items in a different face
4383 (if (and Info-fontify-visited-nodes
4384 (save-match-data
4385 (let* ((node (if (equal (match-string 3) "")
4386 (match-string-no-properties 1)
4387 (match-string-no-properties 3)))
4388 (external-link-p
4390 (file (if external-link-p
4391 (file-name-nondirectory
4392 (match-string-no-properties 1 node))
4393 Info-current-file))
4394 (hl Info-history-list)
4395 res)
4396 (if external-link-p
4397 (setq node (if (equal (match-string 2 node) "")
4398 "Top"
4399 (match-string-no-properties 2 node))))
4400 (while hl
4401 (if (and (string-equal node (nth 1 (car hl)))
4402 (equal file
4403 (if (and external-link-p
4404 (stringp (caar hl)))
4405 (file-name-nondirectory
4406 (caar hl))
4407 (caar hl))))
4408 (setq res (car hl) hl nil)
4409 (setq hl (cdr hl))))
4410 res))) 'info-xref-visited 'info-xref)))
4411 (when (and not-fontified-p
4412 (memq Info-hide-note-references '(t hide))
4413 (not (Info-index-node)))
4414 (put-text-property (match-beginning 2) (1- (match-end 6))
4415 'invisible t)
4416 ;; Unhide the file name in parens
4417 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
4418 (remove-text-properties (match-beginning 4) (match-end 4)
4419 '(invisible t)))
4420 ;; We need a stretchable space like :align-to but with
4421 ;; a minimum value.
4422 (put-text-property (1- (match-end 6)) (match-end 6) 'display
4423 (if (>= 22 (- (match-end 1)
4424 (match-beginning 0)))
4425 '(space :align-to 24)
4426 '(space :width 2)))
4427 (setq cont (looking-at "."))
4428 (while (and (= (forward-line 1) 0)
4430 (put-text-property (match-beginning 1) (1- (match-end 1))
4431 'invisible t)
4432 (put-text-property (1- (match-end 1)) (match-end 1)
4433 'display
4434 (if cont
4435 '(space :align-to 26)
4436 '(space :align-to 24)))
4437 (setq cont t)))))))
4439 ;; Fontify menu headers
4440 ;; Add the face `info-menu-header' to any header before a menu entry
4441 (goto-char (point-min))
4443 (put-text-property (match-beginning 0) (match-end 0)
4444 'font-lock-face 'info-menu-header)
4446 (put-text-property (match-beginning 1) (match-end 1)
4447 'font-lock-face 'info-menu-header)))
4449 ;; Hide index line numbers
4450 (goto-char (point-min))
4451 (when (and not-fontified-p (Info-index-node))
4453 (put-text-property (match-beginning 0) (match-end 0)
4454 'invisible t)))
4456 ;; Fontify http and ftp references
4457 (goto-char (point-min))
4458 (when not-fontified-p
4460 nil t)
4461 (add-text-properties (match-beginning 0) (match-end 0)
4462 '(font-lock-face info-xref
4463 mouse-face highlight
4464 help-echo "mouse-2: go to this URL"))))
4466 (set-buffer-modified-p nil))))
4467 \f
4468 ;;; Speedbar support:
4469 ;; These functions permit speedbar to display the "tags" in the
4470 ;; current Info node.
4471 (eval-when-compile (require 'speedbar))
4473 (defvar Info-speedbar-key-map nil
4474 "Keymap used when in the info display mode.")
4476 (defun Info-install-speedbar-variables ()
4477 "Install those variables used by speedbar to enhance Info."
4478 (if Info-speedbar-key-map
4479 nil
4480 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4482 ;; Basic tree features
4483 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4484 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4485 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4486 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4487 )
4489 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4490 Info-speedbar-key-map
4491 Info-speedbar-hierarchy-buttons)))
4493 (defvar Info-speedbar-menu-items
4494 '(["Browse Node" speedbar-edit-line t]
4495 ["Expand Node" speedbar-expand-line
4496 (save-excursion (beginning-of-line)
4498 ["Contract Node" speedbar-contract-line
4499 (save-excursion (beginning-of-line)
4500 (looking-at "[0-9]+: *.-. "))]
4501 )
4502 "Additional menu-items to add to speedbar frame.")
4504 ;; Make sure our special speedbar major mode is loaded
4505 (if (featurep 'speedbar)
4506 (Info-install-speedbar-variables)
4507 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4509 ;;; Info hierarchy display method
4510 ;;;###autoload
4511 (defun Info-speedbar-browser ()
4512 "Initialize speedbar to display an Info node browser.
4513 This will add a speedbar major display mode."
4514 (interactive)
4515 (require 'speedbar)
4516 ;; Make sure that speedbar is active
4517 (speedbar-frame-mode 1)
4518 ;; Now, throw us into Info mode on speedbar.
4519 (speedbar-change-initial-expansion-list "Info")
4520 )
4522 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4523 "Display an Info directory hierarchy in speedbar.
4524 DIRECTORY is the current directory in the attached frame.
4525 DEPTH is the current indentation depth.
4526 NODE is an optional argument that is used to represent the
4527 specific node to expand."
4528 (if (and (not node)
4529 (save-excursion (goto-char (point-min))
4530 (let ((case-fold-search t))
4531 (looking-at "Info Nodes:"))))
4532 ;; Update our "current node" maybe?
4533 nil
4534 ;; We cannot use the generic list code, that depends on all leaves
4535 ;; being known at creation time.
4536 (if (not node)
4538 (let ((completions nil))
4539 (speedbar-select-attached-frame)
4540 (save-window-excursion
4541 (setq completions
4542 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4543 (select-frame (speedbar-current-frame))
4544 (if completions
4545 (speedbar-with-writable
4546 (dolist (completion completions)
4547 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4548 (cdr completion)
4549 (car completion)
4550 'Info-speedbar-goto-node
4551 (cdr completion)
4552 'info-xref depth))
4553 t)
4554 nil))))
4556 (defun Info-speedbar-goto-node (text node indent)
4557 "When user clicks on TEXT, go to an info NODE.
4558 The INDENT level is ignored."
4559 (speedbar-select-attached-frame)
4560 (let* ((buff (or (get-buffer "*info*")
4561 (progn (info) (get-buffer "*info*"))))
4562 (bwin (get-buffer-window buff 0)))
4563 (if bwin
4564 (progn
4565 (select-window bwin)
4566 (raise-frame (window-frame bwin)))
4567 (if speedbar-power-click
4568 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4569 (speedbar-select-attached-frame)
4570 (switch-to-buffer buff)))
4572 (error "Invalid node %s" node)
4573 (Info-find-node (match-string 1 node) (match-string 2 node))
4574 ;; If we do a find-node, and we were in info mode, restore
4575 ;; the old default method. Once we are in info mode, it makes
4576 ;; sense to return to whatever method the user was using before.
4577 (if (string= speedbar-initial-expansion-list-name "Info")
4578 (speedbar-change-initial-expansion-list
4579 speedbar-previously-used-expansion-list-name)))))
4581 (defun Info-speedbar-expand-node (text token indent)
4582 "Expand the node the user clicked on.
4583 TEXT is the text of the button we clicked on, a + or - item.
4584 TOKEN is data related to this node (NAME . FILE).
4585 INDENT is the current indentation depth."
4586 (cond ((string-match "+" text) ;we have to expand this file
4587 (speedbar-change-expand-button-char ?-)
4588 (if (speedbar-with-writable
4589 (save-excursion
4590 (end-of-line) (forward-char 1)
4591 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4592 (speedbar-change-expand-button-char ?-)
4593 (speedbar-change-expand-button-char ??)))
4594 ((string-match "-" text) ;we have to contract this node
4595 (speedbar-change-expand-button-char ?+)
4596 (speedbar-delete-subblock indent))
4597 (t (error "Ooops... not sure what to do")))
4598 (speedbar-center-buffer-smartly))
4600 (defun Info-speedbar-fetch-file-nodes (nodespec)
4601 "Fetch the subnodes from the info NODESPEC.
4602 NODESPEC is a string of the form: (file)node."
4603 ;; Set up a buffer we can use to fake-out Info.
4604 (with-current-buffer (get-buffer-create " *info-browse-tmp*")
4605 (if (not (equal major-mode 'Info-mode))
4606 (Info-mode))
4607 ;; Get the node into this buffer
4609 (error "Invalid node specification %s" nodespec)
4610 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4611 ;; Scan the created buffer
4612 (goto-char (point-min))
4613 (let ((completions nil)
4614 (case-fold-search t)
4616 (match-string 1 nodespec))))
4617 ;; Always skip the first one...
4620 (let ((name (match-string 1)))
4621 (push (cons name
4623 (match-string 1)
4625 (concat (match-string 1) "Top")
4626 (concat "(" thisfile ")"
4628 (match-string 1)
4629 name)))))
4630 completions)))
4631 (nreverse completions))))
4633 ;;; Info mode node listing
4634 ;; This is called by `speedbar-add-localized-speedbar-support'
4635 (defun Info-speedbar-buttons (buffer)
4636 "Create a speedbar display to help navigation in an Info file.
4637 BUFFER is the buffer speedbar is requesting buttons for."
4638 (if (save-excursion (goto-char (point-min))
4639 (let ((case-fold-search t))
4640 (not (looking-at "Info Nodes:"))))
4641 (erase-buffer))
4642 (Info-speedbar-hierarchy-buttons nil 0))
4644 (dolist (mess '("^First node in file$"
4645 "^No `.*' in index$"
4646 "^No cross-reference named"
4647 "^No cross.references in this node$"
4648 "^No current Info node$"
4649 "^No menu in this node$"
4650 "^No more items in menu$"
4651 "^No more nodes$"
4653 "^No previous `i' command$"
4654 "^No previous items in menu$"
4655 "^No previous nodes$"
4656 "^No such item in menu$"
4657 "^No such node or anchor"
4658 "^Node has no"
4659 "^Point neither on reference nor in menu item description$"
4661 search-failed))
4662 (add-to-list 'debug-ignored-errors mess))
4664 ;;;; Desktop support
4666 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4667 "Auxiliary information to be saved in desktop file."
4668 (unless (Info-virtual-file-p Info-current-file)
4669 (list Info-current-file Info-current-node)))
4671 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4672 desktop-buffer-name
4673 desktop-buffer-misc)
4674 "Restore an Info buffer specified in a desktop file."
4675 (let ((first (nth 0 desktop-buffer-misc))
4676 (second (nth 1 desktop-buffer-misc)))
4677 (when (and first second)
4678 (when desktop-buffer-name
4679 (set-buffer (get-buffer-create desktop-buffer-name))
4680 (Info-mode))
4681 (Info-find-node first second)
4682 (current-buffer))))
4684 (add-to-list 'desktop-buffer-mode-handlers
4685 '(Info-mode . Info-restore-desktop-buffer))
4687 ;;;; Bookmark support
4688 (declare-function bookmark-make-record-default "bookmark" (&optional pos-only))
4689 (declare-function bookmark-prop-get "bookmark" (bookmark prop))
4690 (declare-function bookmark-default-handler "bookmark" (bmk))
4691 (declare-function bookmark-get-bookmark-record "bookmark" (bmk))
4693 (defun Info-bookmark-make-record ()
4694 `(,Info-current-node
4695 ,@(bookmark-make-record-default 'point-only)
4696 (filename . ,Info-current-file)
4697 (info-node . ,Info-current-node)
4698 (handler . Info-bookmark-jump)))
4700 ;;;###autoload
4701 (defun Info-bookmark-jump (bmk)
4702 ;; This implements the `handler' function interface for record type returned
4703 ;; by `Info-bookmark-make-record', which see.
4704 (let* ((file (bookmark-prop-get bmk 'filename))
4705 (info-node (bookmark-prop-get bmk 'info-node))
4706 (buf (save-window-excursion ;FIXME: doesn't work with frames!
4707 (Info-find-node file info-node) (current-buffer))))
4708 ;; Use bookmark-default-handler to move to the appropriate location
4709 ;; within the node.
4710 (bookmark-default-handler
4711 (list* "" `(buffer . ,buf) (bookmark-get-bookmark-record bmk)))))
4713 (provide 'info)
4715 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4716 ;;; info.el ends here