| blob | 84e8248e02986124475589d8c70725f2f3357723 |
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 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: help
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Note that nowadays we expect Info files to be made using makeinfo.
29 ;; In particular we make these assumptions:
30 ;; - a menu item MAY contain colons but not colon-space ": "
31 ;; - a menu item ending with ": " (but not ":: ") is an index entry
32 ;; - a node name MAY NOT contain a colon
33 ;; This distinction is to support indexing of computer programming
34 ;; language terms that may contain ":" but not ": ".
36 ;;; Code:
41 "Info subsystem."
47 "Stack of Info nodes user has visited.
51 "Stack of Info nodes user has visited with `Info-history-back' command.
55 "List of all Info nodes user has visited.
60 This is convenient if you want to write Info files by hand.
61 However, we recommend that you not do this.
62 It is better to write a Texinfo file and generate the Info file from that,
63 because that gives you a printed manual as well."
68 "Non-nil allows Info to execute Lisp code associated with nodes.
76 "Face for Info node names."
85 "Face for info titles at level 1."
87 ;; backward-compatibility alias
93 "Face for info titles at level 2."
95 ;; backward-compatibility alias
101 "Face for info titles at level 3."
103 ;; backward-compatibility alias
109 "Face for info titles at level 4."
111 ;; backward-compatibility alias
116 :underline t
119 :inherit variable-pitch
121 "Face for headers in Info menus."
127 "Face for every third `*' in an Info menu."
133 "Face for unvisited Info cross-references."
138 "Face for visited Info cross-references."
143 "*Non-nil to fontify references to visited nodes in `info-xref-visited' face."
149 "*Maximum size of menu to fontify if `font-lock-mode' is non-nil.
150 Set to nil to disable node fontification."
155 "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
156 A header-line does not scroll with the rest of the buffer."
162 "Face for Info cross-references in a node header."
167 "Face for Info nodes in a node header."
171 "List of directories to search for Info documentation files.
172 If nil, meaning not yet initialized, Info uses the environment
173 variable INFOPATH to initialize it, or `Info-default-directory-list'
174 if there is no INFOPATH variable in the environment, or the
175 concatenation of the two if INFOPATH ends with a colon.
177 When `Info-directory-list' is initialized from the value of
178 `Info-default-directory-list', and Emacs is installed in one of the
179 standard directories, the directory of Info files that come with Emacs
180 is put last (so that local Info files override standard ones).
182 When `Info-directory-list' is initialized from the value of
183 `Info-default-directory-list', and Emacs is not installed in one
184 of the standard directories, the first element of the resulting
185 list is the directory where Emacs installs the Info files that
186 come with it. This is so that Emacs's own manual, which suits the
187 version of Emacs you are using, will always be found first. This
188 is useful when you install an experimental version of Emacs without
189 removing the standard installation.
191 If you want to override the order of directories in
192 `Info-default-directory-list', set INFOPATH in the environment.
194 If you run the Emacs executable from the `src' directory in the Emacs
195 source tree, and INFOPATH is not defined, the `info' directory in the
196 source tree is used as the first element of `Info-directory-list', in
197 place of the installation Info directory. This is useful when you run
201 "List of additional directories to search for Info documentation files.
202 These directories are searched after those in `Info-directory-list'."
209 If this is non-nil, and you scroll far enough in a node that its menu
211 moves to a subnode indicated by the following menu item. This means
212 that you visit a subnode before getting to the end of the menu.
214 Setting this option to nil results in behavior similar to the stand-alone
215 Info reader program, which visits the first subnode from the menu only
216 when you hit the end of the current node."
222 "*If non-nil, hide the tag and section reference in *note and * menu items.
224 If value is non-nil but not t or `hide', the reference section is still shown.
225 `nil' completely disables this feature."
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."
242 "*If non-nil, regular expression to match a sequence of whitespace chars.
243 This applies to Info search for regular expressions.
245 In the Customization buffer, that is `[' followed by a space,
246 a tab, a carriage return (control-M), a newline, and `]+'."
251 "*If non-nil, isearch in Info searches through multiple nodes.
252 Before leaving the initial Info node, where isearch was started,
253 it fails once with the error message [initial node], and with
254 subsequent C-s/C-r continues through other nodes without failing
255 with this error message in other nodes. When isearch fails for
256 the rest of the manual, it wraps aroung the whole manual and
257 restarts the search from the top/final node depending on
258 search direction.
260 Setting this option to nil restores the default isearch behavior
261 with wrapping around the current Info node."
269 ;; Try to obey obsolete Info-fontify settings.
272 "Hooks run when `Info-mode' is called."
277 "Hooks run when `Info-select-node' is called."
285 "Info file that Info is now looking at, or nil.
286 This is the name that was specified in Info, not the actual file name.
290 "Info subfile that is actually in the *info* buffer now.
297 "Marker pointing at beginning of current Info file's tag table.
313 "Point location within a selected node.
314 If string, the point is moved to the proper occurrence of the
315 name of the followed cross reference within a selected node.
320 \f
322 ;; The MS-DOS list should work both when long file names are
323 ;; supported (Windows 9X), and when only 8+3 file names are available.
365 "List of file name suffixes and associated decoding commands.
366 Each entry should be (SUFFIX . STRING); the file is given to
367 the command as standard input.
369 STRING may be a list of strings. In that case, the first element is
370 the command name, and the rest are arguments to that command.
372 If STRING is nil, no decoding is done.
373 Because the SUFFIXes are tried in order, the empty string should
376 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
377 ;; First, on MS-DOS with no long file names support, delete some of
378 ;; the extension in FILENAME to make room.
383 ;; How long is the extension in FILENAME (not counting the dot).
385 ext-left)
386 ;; SUFFIX starts with a dot. If FILENAME already has one,
387 ;; get rid of the one in SUFFIX (unless suffix is empty).
392 ;; How many chars of that extension should we keep?
394 ;; Get rid of the rest of the extension, and add SUFFIX.
397 suffix))))
404 "Insert the contents of an Info file in the current buffer.
405 Do the right thing if the file has been compressed or zipped."
409 t))
411 lfn))
412 fullname decoder done)
414 ;; FILENAME exists--see if that name contains a suffix.
415 ;; If so, set DECODE accordingly.
420 filename)))
424 ;; Try adding suffixes to FILENAME and see if we can find something.
430 ;; If we found a file with a suffix, set DECODER
431 ;; according to the suffix.
433 ;; When the MS-DOS port runs on Windows, we need to check
434 ;; the short variant of a long file name as well.
444 ;; check for conflict with jka-compr
454 default-directory)))
460 \f
467 "../share/info/"
468 invocation-directory)))
470 infodir
472 "../../../share/info/"
473 invocation-directory))
475 infodir))))))
476 alternative)
479 ;; Uninstalled, Emacs builddir != srcdir.
480 sibling
481 ;; Uninstalled, builddir == srcdir
482 source))
484 ;; On DOS/NT, we use movable executables always,
485 ;; and we must always find the Info dir at run time.
487 nil
488 ;; Use invocation-directory for Info
489 ;; only if we used it for exec-directory also.
492 installation-directory))))
494 Info-default-directory-list
495 ;; `alternative' contains the Info files that came with this
496 ;; version, so we should look there first. `Info-insert-dir'
497 ;; currently expects to find `alternative' first on the list.
499 ;; Don't drop the last part, it might contain non-Emacs stuff.
500 ;; (reverse (cdr (reverse
504 "Initialize `Info-directory-list', if that hasn't been done yet."
517 ;;;###autoload
519 "Like `info' but show the Info buffer in another window."
525 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
527 ;;;###autoload (put 'info 'info-file "emacs")
528 ;;;###autoload
530 "Enter Info, the documentation browser.
531 Optional argument FILE-OR-NODE specifies the file to examine;
532 the default is the top-level directory of Info.
533 Called from a program, FILE-OR-NODE may specify an Info node of the form
534 `(FILENAME)NODENAME'.
535 Optional argument BUFFER specifies the Info buffer name;
536 the default buffer name is *info*. If BUFFER exists,
537 just switch to BUFFER. Otherwise, create a new buffer
538 with the top-level Info directory.
540 In interactive use, a non-numeric prefix argument directs
541 this command to read a file name from the minibuffer.
542 A numeric prefix argument selects an Info buffer with the prefix number
543 appended to the Info buffer name.
545 The search path for Info files is in the variable `Info-directory-list'.
546 The top-level Info directory is made by combining all the files named `dir'
547 in all the directories in that path."
557 ;; If argument already contains parentheses, don't add another set
558 ;; since the argument will then be parsed improperly. This also
559 ;; has the added benefit of allowing node names to be included
560 ;; following the parenthesized filename.
563 file-or-node
567 ;; If we just created the Info buffer, go to the directory.
570 ;;;###autoload
572 "Display the Emacs manual in Info mode."
576 ;;;###autoload
578 "Run Emacs as a standalone Info reader.
579 Usage: emacs -f info-standalone [filename]
593 \f
594 ;; See if the accessible portion of the buffer begins with a node
595 ;; delimiter, and the node header line which follows matches REGEXP.
596 ;; Typically, this test will be followed by a loop that examines the
597 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
598 ;; to have the overhead of this special test inside the loop.
600 ;; This function changes match-data, but supposedly the caller might
601 ;; want to use the results of re-search-backward.
603 ;; The return value is the value of point at the beginning of matching
604 ;; REGEXP, if the function succeeds, nil otherwise.
616 Optional second argument NOERROR, if t, means if file is not found
617 just return nil (no error)."
618 ;; Convert filename to lower case if not found as specified.
619 ;; Expand it.
628 ;; If specified name starts with `./'
629 ;; then just try current directory.
632 ;; No point in searching for an
633 ;; absolute file name
637 Info-additional-directory-list)
638 Info-directory-list)))))
639 ;; Search the directory list for file FILENAME.
644 ;; Try several variants of specified name.
648 t)))
659 lfn
671 filename)
675 "Go to an Info node specified as separate FILENAME and NODENAME.
676 NO-GOING-BACK is non-nil if recovering from an error in this function;
677 it says do not attempt further (recursive) error recovery."
680 ;; Go into Info buffer.
682 ;; Record the node we are leaving, if we were in one.
684 Info-current-file
687 Info-history)))
690 ;;;###autoload
692 "Use Info mode to browse the current Info buffer.
693 With a prefix arg, this queries for the node name to visit first;
694 otherwise, that defaults to `Top'."
704 ;; If called on a non-file buffer, make a fake file name.
708 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
709 ;; but at least it keeps this routine (which is only for the benefit of
710 ;; makeinfo-buffer) out of the way of normal operations.
711 ;;
713 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
714 When *info* is already displaying FILENAME and NODENAME, the window position
715 is preserved, if possible."
731 ;; note goto-line is no good, we want to measure from point-min
738 ;; only add to the history when coming from a different file+node
743 "Find a node in a tag table.
744 MARKER specifies the buffer and position to start searching at.
745 REGEXP is a regular expression matching nodes or references. Its first
746 group should match `Node:' or `Ref:'.
747 CASE-FOLD t means search for a case-insensitive match.
748 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
749 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
750 where the match was found, and MODE is `major-mode' of the buffer in
751 which the match was found."
757 ;; Search tag table
762 major-mode)))))
765 "Find a node in a tag table.
766 MARKER specifies the buffer and position to start searching at.
767 REGEXP is a regular expression matching nodes or references. Its first
768 group should match `Node:' or `Ref:'.
769 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
770 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
771 where the match was found, and MODE is `major-mode' of the buffer in
772 which the match was found.
773 This function tries to find a case-sensitive match first, then a
774 case-insensitive match is tried."
778 result))
781 "Find a node or anchor in the current buffer.
782 REGEXP is a regular expression matching nodes or references. Its first
783 group should match `Node:' or `Ref:'.
784 CASE-FOLD t means search for a case-insensitive match.
785 Value is the position at which a match was found, or nil if not found."
787 found)
799 found)))
802 "Find a node or anchor in the current buffer.
803 REGEXP is a regular expression matching nodes or references. Its first
804 group should match `Node:' or `Ref:'.
805 Value is the position at which a match was found, or nil if not found.
806 This function looks for a case-sensitive match first. If none is found,
807 a case-insensitive match is tried."
819 anchorpos)
820 ;; Switch files if necessary
825 Info-current-subfile nil
826 Info-current-file-completions nil
827 buffer-file-name nil)
843 ;; Check makeinfo version for index cookie support
855 ;; See whether file has a tag table. Record the location if yes.
858 ;; Use string-equal, not equal, to ignore text props.
863 ;; We have a tag table. Find its beginning.
864 ;; Is this an indirect file?
870 ;; It is indirect. Copy it to another buffer
871 ;; and record that the tag table is in that buffer.
891 ))
892 ;; Use string-equal, not equal, to ignore text props.
896 ;; Possibilities:
897 ;;
898 ;; 1. Anchor found in tag table
899 ;; 2. Anchor *not* in tag table
900 ;;
901 ;; 3. Node found in tag table
902 ;; 4. Node *not* found in tag table, but found in file
903 ;; 5. Node *not* in tag table, and *not* in file
904 ;;
905 ;; *Or* the same, but in an indirect subfile.
907 ;; Search file for a suitable node.
917 ;; First, search a tag table, if any
923 ;; FOUND is (ANCHOR POS MODE).
926 ;; If this is an indirect file, determine which
927 ;; file really holds this node and read it in.
929 ;; Note that the current buffer must be the
930 ;; *info* buffer on entry to
931 ;; Info-read-subfile. Thus the hackery above.
934 ;; Handle anchor
939 ;; Else we may have a node, which we search for:
943 ;; Now search from our advised position (or from beg of
944 ;; buffer) to find the actual node. First, check
945 ;; whether the node is right where we are, in case the
946 ;; buffer begins with a node.
959 ;; No such anchor in tag table or node in tag table or file
967 ;; Add anchors to the history too
978 ;; If we did not finish finding the specified node,
979 ;; go back to the previous one.
986 ;; Cache the contents of the (virtual) dir file, once we have merged
987 ;; it for the first time, so we can save time subsequently.
990 ;; Cache for the directory we decided to use for the default-directory
991 ;; of the merged dir text.
994 ;; Record the file attributes of all the files from which we
995 ;; constructed Info-dir-contents.
1000 ;; Construct the Info directory node by merging the files named `dir'
1001 ;; from various directories. Set the *info* buffer's
1002 ;; default-directory to the first directory we actually get any text
1003 ;; from.
1006 ;; Verify that none of the files we used has changed
1007 ;; since we used it.
1011 ;; Handle symlinks
1014 ;; Don't compare the access time.
1018 Info-dir-file-attributes))))
1024 Info-additional-directory-list)
1025 Info-directory-list))
1027 ;; Bind this in case the user sets it to nil.
1029 ;; This is set non-nil if we find a problem in some input files.
1030 problems
1031 buffers buffer others nodes dirs-done)
1033 ;; Search the directory list for the directory file.
1038 ;; Try several variants of specified name.
1039 ;; Try upcasing, appending `.info', or both.
1054 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)
1244 thisfilepos thisfilename)
1248 ;; read in version 19 stops at the end of number.
1249 ;; Advance to the next line.
1258 ;; Assume previous buffer is in Info-mode.
1259 ;; (set-buffer (get-buffer "*info*"))
1268 ;; Widen in case we are in the same subfile as before.
1278 "Unescape double quotes and backslashes in VALUE."
1284 unquote))
1286 ;; As of Texinfo 4.6, makeinfo writes constructs like
1287 ;; \0\h[image param=value ...\h\0]
1288 ;; into the Info file for handling images.
1291 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1292 whitespace or double quotes, it must be quoted in double quotes and
1297 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1298 parameter-string start)
1304 parameter-alist))
1305 parameter-alist))
1308 "Display images in current node."
1315 nil t)
1329 ;; text-only display, show alternative text if provided, or
1330 ;; otherwise a clue that there's meant to be a picture
1339 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1340 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1341 ;; including one optional trailing newline.
1343 "Hide unrecognized cookies in current node."
1350 nil t)
1357 "Select the Info node that point is in."
1358 ;; Bind this in case the user sets it to nil.
1361 ;; Find beginning of node.
1367 ;; Get nodename spelled as it is in the node.
1375 ;; Find the end of it, and narrow.
1378 ;; Narrow to the node contents
1390 ;; Add a new unique history item to full history list
1405 map)
1413 " ("
1418 ") "
1423 'help-echo
1424 "mouse-1: scroll forward, mouse-3: scroll back"
1428 \f
1429 ;; Go to an Info node specified with a filename-and-nodename string
1430 ;; of the sort that is found in pointers in nodes.
1432 ;; Don't autoload this function: the correct entry point for other packages
1433 ;; to use is `info'. --Stef
1434 ;; ;;;###autoload
1436 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1437 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1438 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1439 its sub-files).
1440 Completion is available, but only for node names in the current Info file.
1441 If FORK is non-nil (interactively with a prefix arg), show the node in
1442 a new Info buffer.
1443 If FORK is a string, it is the name to use for the new buffer."
1451 nodename)
1453 ""
1467 "Virtual completion table for file names input in Info node names.
1468 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1484 ;; If the file name has no suffix or a standard suffix,
1485 ;; include it.
1488 ;; But exclude subfiles of split Info files.
1490 ;; And exclude backup files.
1493 ;; If the file name ends in a standard suffix,
1494 ;; add the unsuffixed name as a completion option.
1503 ;; This function is used as the "completion table" while reading a node name.
1504 ;; It does completion using the alist in Info-read-node-completion-table
1505 ;; unless STRING starts with an open-paren.
1508 ;; First complete embedded file names.
1524 ;; If a file name was given, then any node is fair game.
1530 ;; Otherwise use Info-read-node-completion-table.
1538 ;; Arrange to highlight the proper letters in the completion list buffer.
1544 1
1554 nodename)))
1559 ;; Bind this in case the user sets it to nil.
1574 compl))))
1577 ;; If the buffer begins with a node header, process that first.
1580 ;; Now for the rest of the nodes.
1588 compl))))))))
1591 \f
1593 "If this node has been visited, restore the point value when we left."
1596 ;; Use string-equal, not equal, to ignore text props.
1602 \f
1610 "Search for REGEXP, starting from point, and select node it's found in.
1611 If DIRECTION is `backward', search in the reverse direction."
1639 ;; Hide Info file header for backward search
1651 ;; Skip node header line
1655 ;; Skip Tag Table node
1662 Info-search-whitespace-regexp)))
1677 ;; If no subfiles, give error now.
1682 Info-search-whitespace-regexp)))
1693 ;; Try other subfiles.
1704 ;; Find the subfile we just searched.
1706 ;; Skip that one.
1709 ;; Make a list of all following subfiles.
1710 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1719 list))
1723 ;; Put in forward order
1729 ;; Hide Info file header for backward search
1744 ;; Skip node header line
1748 ;; Skip Tag Table node
1755 Info-search-whitespace-regexp)))
1778 ;; Search landed in the same node
1784 ;; Use string-equal, not equal, to ignore text props.
1790 Info-history))))))
1793 "Search for a regexp case-sensitively."
1799 "Search for next regexp from a previous `Info-search' command."
1807 "Search for REGEXP in the reverse direction."
1826 nil t)
1828 bound noerror count
1831 bound noerror count
1858 \f
1860 "Extract the value of the node-pointer named NAME.
1861 If there is none, use ERRORNAME in the error message;
1862 if ERRORNAME is nil, just return nil."
1863 ;; Bind this in case the user sets it to nil.
1877 "Return a regexp matching a node name.
1878 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1879 saying which chars may appear in the node name.
1880 Submatch 1 is the complete node name.
1881 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1882 Submatch 3 is the local part of the node name.
1883 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1890 ;;; For compatibility; other files have used this name.
1896 "Go to the next node of this node."
1898 ;; In case another window is currently selected
1904 "Go to the previous node of this node."
1906 ;; In case another window is currently selected
1912 "Go to the superior node of this node.
1913 If SAME-FILE is non-nil, do not move to a different Info file."
1915 ;; In case another window is currently selected
1934 nil t))
1940 "Go back in the history to the last node visited."
1946 Info-history-forward))
1947 filename nodename opoint)
1960 "Go forward in the history of visited nodes."
1965 filename nodename opoint)
1973 ;;;###autoload
1975 "Go to the Info directory node."
1978 \f
1980 "Go to a node with a menu of visited nodes."
1984 p)
2009 "Go to a node with table of contents of the current Info file.
2010 Table of contents is created from the tree structure of menus."
2015 p)
2045 "Insert table of contents with references to nodes."
2057 "Build table of contents from menus of Info FILE and its subfiles."
2062 default-directory))
2065 nodes subfiles)
2077 menu-items)
2086 bound))
2089 ;; Menu item line
2099 ;; Other non-empty strings in the Top node are section names
2108 nodes))
2117 subfiles)))))
2119 main-file nil))
2123 \f
2125 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2126 FOOTNOTENAME may be an abbreviation of the reference name.
2127 If FORK is non-nil (interactively with a prefix arg), show the node in
2128 a new Info buffer. If FORK is a string, it is the name to use for the
2129 new buffer."
2135 ;; Store end and beginning of line.
2144 ;; See if this one should be the default.
2149 ;; See if this one should be the alternate default.
2159 ;; Record as a completion and perhaps as default.
2162 ;; Don't add this string if it's a duplicate.
2165 ;; If no good default was found, try an alternate.
2168 ;; If only one cross-reference found, then make it default.
2174 "Follow reference named (default "
2177 completions nil t)))
2191 ;; Move point to the beginning of reference if point is on reference
2201 ;; Go to the reference closest to point
2209 next-ref prev-ref))
2220 ;; We allow newline because this is also used in Info-follow-reference,
2221 ;; where the xref name might be wrapped over two lines.
2222 "Regexp that matches a menu entry name upto but not including the colon.
2223 Because of ambiguities, this should be concatenated with something like
2244 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2245 ;;; (setq Info-point-loc
2246 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2247 )
2251 ;; If the node name is the menu entry name (using `entry::').
2255 ;; No one calls this.
2256 ;;(defun Info-menu-item-sequence (list)
2257 ;; (while list
2258 ;; (Info-menu (car list))
2259 ;; (setq list (cdr list))))
2271 ;; This uses two dynamically bound variables:
2272 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2273 ;; is the menu of items we're trying to complete.
2274 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2275 ;; also look for menu items in subsequent nodes as long as those
2276 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2277 ;; not used.
2278 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2279 ;; also look for menu items in these nodes. This feature is currently
2280 ;; only used for completion in Info-index.
2282 ;; Note that `Info-complete-menu-buffer' could be current already,
2283 ;; so we want to save point.
2289 nextnode)
2298 completions
2300 ;; Check the cache.
2308 ;; We can reuse the previous list.
2310 ;; The cache can't be used.
2315 completions))
2316 ;; Check subsequent nodes if applicable.
2324 ;; Go back to the start node (for the next completion).
2327 ;; Update the cache.
2330 Info-complete-next-re string completions
2331 Info-complete-nodes)))
2338 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2339 The menu item should one of those listed in the current node's menu.
2340 Completion is allowed, and the default menu item is the one point is on.
2341 If FORK is non-nil (interactively with a prefix arg), show the node in
2342 a new Info buffer. If FORK is a string, it is the name to use for the
2343 new buffer."
2346 ;; If point is within a menu item, use that item as the default
2349 beg
2362 Info-menu-entry-name-re
2371 default)
2374 ;; we rely on the fact that completing-read accepts an input
2375 ;; of "" even when the require-match argument is true and ""
2376 ;; is not a valid possibility
2380 ;; ask again
2383 ;; there is a problem here in that if several menu items have the same
2384 ;; name you can only go to the node of the first with this command.
2402 ;; If COUNT is nil, use the last item in the menu.
2414 nil))
2418 "Go to the node of the Nth menu item.
2419 N is the digit argument used to invoke this command."
2426 "Go to the Top node of this file."
2431 "Go to the final node in this file."
2436 ;; Go to the last node in the menu of Top.
2438 ;; If the last node in the menu is not last in pointer structure,
2439 ;; move forward until we can't go any farther.
2441 ;; Then keep moving down to last subnode, unless we reach an index.
2447 "Go forward one node, considering all nodes as forming one sequence."
2452 ;; three possibilities, in order of priority:
2453 ;; 1. next node is in a menu in this node (but not in an index)
2454 ;; 2. next node is next at same level
2455 ;; 3. next node is up and next
2460 t)
2463 t)
2465 ;; Use string-equal, not equal, to ignore text props.
2478 "Go backward one node, considering all nodes as forming one sequence."
2486 ;; Use string-equal, not equal,
2487 ;; to ignore text properties.
2492 ;; If we move back at the same level,
2493 ;; go down to find the last subnode*.
2503 "Exit Info by selecting some other buffer."
2510 "Go to the node of the next menu item."
2512 ;; Bind this in case the user sets it to nil.
2524 "Go to the node of the previous menu item."
2528 ;; Bind this in case the user sets it to nil.
2543 "Go to the next subnode or the next node, or go up a level."
2548 ;; Since we have already gone thru all the items in this menu,
2549 ;; go up to the end of this node.
2551 ;; Since logically we are done with the node with that menu,
2552 ;; move on from it.
2558 "Go to the last node, popping up a level if there is none."
2562 ;; If we go down a menu item, go to the end of the node
2563 ;; so we can scroll back through it.
2565 ;; Keep going down, as long as there are nested menu nodes.
2568 ;; If we go down a menu item, go to the end of the node
2569 ;; so we can scroll back through it.
2579 ;; If we go down a menu item, go to the end of the node
2580 ;; so we can scroll back through it.
2591 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2592 Once you scroll far enough in a node that its menu appears on the screen
2593 but after point, the next scroll moves into its first subnode, unless
2594 `Info-scroll-prefer-subnodes' is nil.
2596 When you scroll past the end of a node, that goes to the next node if
2597 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2598 if this node has no successor, it moves to the parent node's successor,
2599 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2600 the menu of a node, it moves to subnode indicated by the following menu
2601 item. (That case won't normally result from this command, but can happen
2602 in other ways.)"
2624 "Scroll one screenful forward in Info, using the mouse.
2625 See `Info-scroll-up'."
2633 "Scroll one screenful back in Info, considering all nodes as one sequence.
2634 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2635 is non-nil, this goes to its last subnode. When you scroll past the
2636 beginning of a node, that goes to the previous node or back up to the
2637 parent node."
2651 current-point
2652 t)))))
2659 "Scroll one screenful backward in Info, using the mouse.
2660 See `Info-scroll-down'."
2668 "Move cursor to the next cross-reference or menu item in the node."
2690 "Move cursor to the previous cross-reference or menu item in the node."
2709 \f
2711 "Alist of cached index node names of visited Info files.
2715 "Return a list of names of all index nodes in Info FILE.
2716 If FILE is omitted, it defaults to the current Info file.
2717 First look in a list of cached index node names. Then scan Info
2718 file and its subfiles for nodes with the index cookie. Then try
2719 to find index nodes starting from the first node in the top level
2724 ;; Skip virtual Info files
2729 ;; Find nodes with index cookie
2733 default-directory))
2734 Info-history Info-history-list Info-fontify-maximum-menu-size
2754 subfiles)))))
2756 main-file nil))
2762 nodes)
2763 ;; Else find nodes with the word "Index" in the node name
2765 Info-history Info-history-list Info-fontify-maximum-menu-size
2766 nodes node)
2784 nodes))
2785 ;; If file has no index nodes, still add it to the cache
2790 "Return non-nil value if NODE is an index node.
2791 If NODE is nil, check the current Info node.
2792 If FILE is nil, check the current Info file."
2796 ;; Don't search all index nodes if request is only for the current node
2797 ;; and file is not in the cache of index nodes
2811 "Go to the first index node."
2816 ;;;###autoload
2818 "Look up a string TOPIC in the index for this manual and go to that entry.
2819 If there are no exact matches to the specified topic, this chooses
2820 the first match which is a case-insensitive substring of a topic.
2822 Give an empty topic name to go to the Index node itself."
2838 ;; Strip leading colon in topic; index format does not allow them.
2844 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2853 ;; We bind Info-history to nil for internal node-switches so
2854 ;; that we don't put junk in the history. In the first
2855 ;; Info-goto-index call, above, we do update the history
2856 ;; because that is what the user's previous node choice into it.
2858 found)
2865 Info-current-node
2868 matches))
2875 ;; Here it is a feature that assoc is case-sensitive.
2908 'Info-index-next overriding-local-map
2909 t)))
2913 "Move point to the place within the current node where NAME is defined."
2918 ;; Find a function definition with a return type.
2926 nil t))
2928 ;; Try again without the " <1>" makeinfo can append
2934 ;;;###autoload
2936 "Grovel indices of all known Info files on your system for STRING.
2937 Build a menu of the possible matches."
2940 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2946 manuals matches node nodes)
2949 ;; current-node and current-file are nil when they invoke info-apropos
2950 ;; as the first Info command, i.e. info-apropos loads info.el. In that
2951 ;; case, we use (DIR)Top instead, to avoid signalling an error after
2952 ;; the search is complete.
2960 ;; add-to-list makes sure we don't have duplicates in `manuals',
2961 ;; so that the following dolist loop runs faster.
2978 matches)))
2987 Info-history-list ohist-list)
3008 "Make command be undefined in Info."
3013 "Enter the Info tutorial."
3018 "Help-Small-Screen"
3022 "Display a brief summary of all Info commands."
3037 flag))
3040 \f
3042 "Return the token around POS.
3043 POS must be somewhere inside the token
3044 START is a regular expression which will match the
3045 beginning of the tokens delimited string
3046 ALL is a regular expression with a single
3047 parenthesized subpattern which is the token to be
3048 returned. E.g. '{\(.*\)}' would return any string
3049 enclosed in braces around POS.
3050 ERRORSTRING optional fourth argument, controls action on no match
3051 nil: return nil
3052 t: beep
3053 a string: signal an error, using that string."
3057 ;; First look for a match for START that goes across POS.
3061 ;; If we did not find one, search back for START
3062 ;; (this finds only matches that end at or before POS).
3075 nil)
3078 nil)
3084 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3085 At end of the node's text, moves to the next node, or up if none."
3093 "Follow a node reference near point.
3094 If point is on a reference, follow that reference. Otherwise,
3095 if point is in a menu item description, follow that menu item.
3097 If FORK is non-nil (interactively with a prefix arg), show the node in
3098 a new Info buffer.
3099 If FORK is a string, it is the name to use for the new buffer."
3111 t)))
3114 ;; Common subroutine.
3116 "Follow a node reference near point. Return non-nil if successful.
3117 If FORK is non-nil, it i spassed to `Info-goto-node'."
3126 ;; menu item: node name
3129 ;; menu item: node name or index entry
3143 node))
3144 \f
3148 nil
3158 (define-key Info-mode-map "1" 'Info-nth-menu-item)
3159 (define-key Info-mode-map "2" 'Info-nth-menu-item)
3160 (define-key Info-mode-map "3" 'Info-nth-menu-item)
3161 (define-key Info-mode-map "4" 'Info-nth-menu-item)
3162 (define-key Info-mode-map "5" 'Info-nth-menu-item)
3163 (define-key Info-mode-map "6" 'Info-nth-menu-item)
3164 (define-key Info-mode-map "7" 'Info-nth-menu-item)
3165 (define-key Info-mode-map "8" 'Info-nth-menu-item)
3166 (define-key Info-mode-map "9" 'Info-nth-menu-item)
3167 (define-key Info-mode-map "0" 'undefined)
3168 (define-key Info-mode-map "?" 'Info-summary)
3169 (define-key Info-mode-map "]" 'Info-forward-node)
3170 (define-key Info-mode-map "[" 'Info-backward-node)
3171 (define-key Info-mode-map "<" 'Info-top-node)
3172 (define-key Info-mode-map ">" 'Info-final-node)
3173 (define-key Info-mode-map "b" 'beginning-of-buffer)
3174 (define-key Info-mode-map "d" 'Info-directory)
3175 (define-key Info-mode-map "e" 'Info-edit)
3176 (define-key Info-mode-map "f" 'Info-follow-reference)
3177 (define-key Info-mode-map "g" 'Info-goto-node)
3178 (define-key Info-mode-map "h" 'Info-help)
3179 (define-key Info-mode-map "i" 'Info-index)
3180 (define-key Info-mode-map "l" 'Info-history-back)
3181 (define-key Info-mode-map "L" 'Info-history)
3182 (define-key Info-mode-map "m" 'Info-menu)
3183 (define-key Info-mode-map "n" 'Info-next)
3184 (define-key Info-mode-map "p" 'Info-prev)
3185 (define-key Info-mode-map "q" 'Info-exit)
3186 (define-key Info-mode-map "r" 'Info-history-forward)
3187 (define-key Info-mode-map "s" 'Info-search)
3188 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
3189 ;; For consistency with Rmail.
3190 (define-key Info-mode-map "\M-s" 'Info-search)
3191 (define-key Info-mode-map "\M-n" 'clone-buffer)
3192 (define-key Info-mode-map "t" 'Info-top-node)
3193 (define-key Info-mode-map "T" 'Info-toc)
3194 (define-key Info-mode-map "u" 'Info-up)
3195 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3196 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
3197 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
3198 ;; `^' for consistency with `dired-up-directory'.
3199 (define-key Info-mode-map "^" 'Info-up)
3200 (define-key Info-mode-map "," 'Info-index-next)
3202 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
3203 (define-key Info-mode-map [follow-link] 'mouse-face)
3204 )
3206 (defun Info-check-pointer (item)
3207 "Non-nil if ITEM is present in this node."
3208 (condition-case nil
3209 (Info-extract-pointer item)
3210 (error nil)))
3212 (easy-menu-define
3213 Info-mode-menu Info-mode-map
3214 "Menu for Info files."
3215 '("Info"
3216 ["Up" Info-up :active (Info-check-pointer "up")
3217 :help "Go up in the Info tree"]
3218 ["Next" Info-next :active (Info-check-pointer "next")
3219 :help "Go to the next node"]
3220 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3221 :help "Go to the previous node"]
3222 ["Backward" Info-backward-node
3223 :help "Go backward one node, considering all as a sequence"]
3224 ["Forward" Info-forward-node
3225 :help "Go forward one node, considering all as a sequence"]
3226 ["Beginning" beginning-of-buffer
3227 :help "Go to beginning of this node"]
3228 ["Top" Info-top-node
3229 :help "Go to top node of file"]
3230 ["Final Node" Info-final-node
3231 :help "Go to final node in this file"]
3232 ("Menu Item" ["You should never see this" report-emacs-bug t])
3233 ("Reference" ["You should never see this" report-emacs-bug t])
3234 ["Search..." Info-search
3235 :help "Search for regular expression in this Info file"]
3236 ["Search Next" Info-search-next
3237 :help "Search for another occurrence of regular expression"]
3238 ["Go to Node..." Info-goto-node
3239 :help "Go to a named node"]
3240 ["Back in history" Info-history-back :active Info-history
3241 :help "Go back in history to the last node you were at"]
3242 ["Forward in history" Info-history-forward :active Info-history-forward
3243 :help "Go forward in history"]
3244 ["History" Info-history :active Info-history-list
3245 :help "Go to menu of visited nodes"]
3246 ["Table of Contents" Info-toc
3247 :help "Go to table of contents"]
3248 ("Index"
3249 ["Lookup a String..." Info-index
3250 :help "Look for a string in the index items"]
3251 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3252 :help "Look for another occurrence of previous item"]
3253 ["Lookup a string in all indices..." info-apropos
3254 :help "Look for a string in the indices of all manuals"])
3255 ["Copy Node Name" Info-copy-current-node-name
3256 :help "Copy the name of the current node into the kill ring"]
3257 ["Clone Info buffer" clone-buffer
3258 :help "Create a twin copy of the current Info buffer."]
3259 ["Exit" Info-exit :help "Stop reading Info"]))
3262 (defvar info-tool-bar-map
3263 (if (display-graphic-p)
3264 (let ((map (make-sparse-keymap)))
3265 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map)
3266 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map)
3267 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map)
3268 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map)
3269 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3270 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3271 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3272 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3273 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3274 (tool-bar-local-item-from-menu 'Info-exit "exit" map Info-mode-map)
3275 map)))
3277 (defvar Info-menu-last-node nil)
3278 ;; Last node the menu was created for.
3279 ;; Value is a list, (FILE-NAME NODE-NAME).
3281 (defun Info-menu-update ()
3282 "Update the Info menu for the current node."
3283 (condition-case nil
3284 (if (or (not (eq major-mode 'Info-mode))
3285 (equal (list Info-current-file Info-current-node)
3286 Info-menu-last-node))
3287 ()
3288 ;; Update menu menu.
3289 (let* ((Info-complete-menu-buffer (current-buffer))
3290 (items (nreverse (condition-case nil
3291 (Info-complete-menu-item "" nil t)
3292 (error nil))))
3293 entries current
3294 (number 0))
3295 (while (and items (< number 9))
3296 (setq current (car items)
3297 items (cdr items)
3298 number (1+ number))
3299 (setq entries (cons `[,current
3300 (Info-menu ,current)
3301 :keys ,(format "%d" number)]
3302 entries)))
3303 (if items
3304 (setq entries (cons ["Other..." Info-menu t] entries)))
3305 (or entries
3306 (setq entries (list ["No menu" nil nil] nil :active)))
3307 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3308 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3309 (let ((items nil)
3310 str i entries current
3311 (number 0)
3312 (case-fold-search t))
3313 (save-excursion
3314 (goto-char (point-min))
3316 (setq str (match-string 1))
3317 (setq i 0)
3319 (setq str (concat (substring str 0 i) " "
3320 (substring str (match-end 0))))
3321 (setq i (1+ i)))
3322 (setq items
3323 (cons str items))))
3324 (while (and items (< number 9))
3325 (setq current (car items)
3326 items (cdr items)
3327 number (1+ number))
3328 (setq entries (cons `[,current
3329 (Info-follow-reference ,current)
3330 t]
3331 entries)))
3332 (if items
3333 (setq entries (cons ["Other..." Info-follow-reference t]
3334 entries)))
3335 (or entries
3336 (setq entries (list ["No references" nil nil] nil :active)))
3337 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3338 ;; Update last seen node.
3339 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3340 ;; Try to avoid entering infinite beep mode in case of errors.
3341 (error (ding))))
3343 \f
3344 (defun Info-copy-current-node-name (&optional arg)
3345 "Put the name of the current Info node into the kill ring.
3346 The name of the Info file is prepended to the node name in parentheses.
3347 With a zero prefix arg, put the name inside a function call to `info'."
3348 (interactive "P")
3349 (unless Info-current-node
3350 (error "No current Info node"))
3351 (let ((node (if (stringp Info-current-file)
3352 (concat "(" (file-name-nondirectory Info-current-file) ")"
3353 Info-current-node))))
3354 (if (zerop (prefix-numeric-value arg))
3356 (unless (stringp Info-current-file)
3357 (setq node (format "(Info-find-node '%S '%S)"
3358 Info-current-file Info-current-node)))
3359 (kill-new node)
3360 (message "%s" node)))
3362 \f
3363 ;; Info mode is suitable only for specially formatted data.
3364 (put 'Info-mode 'mode-class 'special)
3365 (put 'Info-mode 'no-clone-indirect t)
3367 (defvar tool-bar-map)
3369 ;; Autoload cookie needed by desktop.el
3370 ;;;###autoload
3371 (defun Info-mode ()
3372 "Info mode provides commands for browsing through the Info documentation tree.
3374 one topic and contains references to other nodes which discuss related
3375 topics. Info has commands to follow the references and show you other nodes.
3381 Selecting other nodes:
3383 Follow a node reference you click on.
3384 This works with menu items, cross references, and
3386 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3391 Picking a menu item causes another node to be selected.
3401 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3405 Moving within a node:
3407 Once you scroll far enough in a node that its menu appears on the
3408 screen but after point, the next scroll moves into its first
3409 subnode. When after all menu items (or if there is no menu),
3410 move up to the parent node.
3412 already visible, try to go to the previous menu entry, or up
3413 if there is none.
3416 Advanced commands:
3418 and select the node in which the next occurrence is found.
3419 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3423 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3426 You may include a filename as well, as (FILENAME)NODENAME.
3427 1 .. 9 Pick first ... ninth item in node's menu.
3428 Every third `*' is highlighted to help pick the right number.
3432 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3433 (kill-all-local-variables)
3434 (setq major-mode 'Info-mode)
3435 (setq mode-name "Info")
3436 (setq tab-width 8)
3437 (use-local-map Info-mode-map)
3438 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3439 (set-syntax-table text-mode-syntax-table)
3440 (setq local-abbrev-table text-mode-abbrev-table)
3441 (setq case-fold-search t)
3442 (setq buffer-read-only t)
3443 (make-local-variable 'Info-current-file)
3444 (make-local-variable 'Info-current-subfile)
3445 (make-local-variable 'Info-current-node)
3446 (make-local-variable 'Info-tag-table-marker)
3447 (setq Info-tag-table-marker (make-marker))
3448 (make-local-variable 'Info-tag-table-buffer)
3449 (setq Info-tag-table-buffer nil)
3450 (make-local-variable 'Info-history)
3451 (make-local-variable 'Info-history-forward)
3452 (make-local-variable 'Info-index-alternatives)
3453 (setq header-line-format
3454 (if Info-use-header-line
3455 '(:eval (get-text-property (point-min) 'header-line))
3456 nil)) ; so the header line isn't displayed
3457 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3458 ;; This is for the sake of the invisible text we use handling titles.
3459 (make-local-variable 'line-move-ignore-invisible)
3460 (setq line-move-ignore-invisible t)
3461 (make-local-variable 'desktop-save-buffer)
3462 (make-local-variable 'widen-automatically)
3463 (setq widen-automatically nil)
3464 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3465 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3466 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
3467 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3468 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3469 (set (make-local-variable 'isearch-search-fun-function)
3470 'Info-isearch-search)
3471 (set (make-local-variable 'isearch-wrap-function)
3472 'Info-isearch-wrap)
3473 (set (make-local-variable 'isearch-push-state-function)
3474 'Info-isearch-push-state)
3475 (set (make-local-variable 'search-whitespace-regexp)
3476 Info-search-whitespace-regexp)
3477 (Info-set-mode-line)
3478 (run-mode-hooks 'Info-mode-hook))
3480 ;; When an Info buffer is killed, make sure the associated tags buffer
3481 ;; is killed too.
3482 (defun Info-kill-buffer ()
3483 (and (eq major-mode 'Info-mode)
3484 Info-tag-table-buffer
3485 (kill-buffer Info-tag-table-buffer)))
3487 (defun Info-clone-buffer-hook ()
3488 (when (bufferp Info-tag-table-buffer)
3489 (setq Info-tag-table-buffer
3490 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3491 (let ((m Info-tag-table-marker))
3492 (when (markerp m)
3493 (setq Info-tag-table-marker
3494 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3495 (with-current-buffer Info-tag-table-buffer
3496 (copy-marker (marker-position m)))
3497 (make-marker))))))
3499 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3500 (set-keymap-parent map text-mode-map)
3501 (define-key map "\C-c\C-c" 'Info-cease-edit)
3502 map)
3503 "Local keymap used within `e' command of Info.")
3505 ;; Info-edit mode is suitable only for specially formatted data.
3506 (put 'Info-edit-mode 'mode-class 'special)
3508 (defun Info-edit-mode ()
3509 "Major mode for editing the contents of an Info node.
3510 Like text mode with the addition of `Info-cease-edit'
3511 which returns to Info mode for browsing.
3513 (use-local-map Info-edit-map)
3514 (setq major-mode 'Info-edit-mode)
3515 (setq mode-name "Info Edit")
3516 (kill-local-variable 'mode-line-buffer-identification)
3517 (setq buffer-read-only nil)
3518 (force-mode-line-update)
3519 (buffer-enable-undo (current-buffer))
3520 (run-mode-hooks 'Info-edit-mode-hook))
3522 (defun Info-edit ()
3523 "Edit the contents of this Info node.
3524 Allowed only if variable `Info-enable-edit' is non-nil."
3525 (interactive)
3526 (or Info-enable-edit
3527 (error "Editing Info nodes is not enabled"))
3528 (Info-edit-mode)
3529 (message "%s" (substitute-command-keys
3532 (defun Info-cease-edit ()
3533 "Finish editing Info node; switch back to Info proper."
3534 (interactive)
3535 ;; Do this first, so nothing has changed if user C-g's at query.
3536 (and (buffer-modified-p)
3537 (y-or-n-p "Save the file? ")
3538 (save-buffer))
3539 (use-local-map Info-mode-map)
3540 (setq major-mode 'Info-mode)
3541 (setq mode-name "Info")
3542 (Info-set-mode-line)
3543 (setq buffer-read-only t)
3544 (force-mode-line-update)
3545 (and (marker-position Info-tag-table-marker)
3546 (buffer-modified-p)
3547 (message "Tags may have changed. Use Info-tagify if necessary")))
3548 \f
3549 (defvar Info-file-list-for-emacs
3550 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3551 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3552 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3553 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3554 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3555 ("copyright" . "autotype") ("executable" . "autotype")
3556 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3557 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3558 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3559 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3560 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3561 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3562 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3563 ("rfc2045" . "emacs-mime")
3564 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3565 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3566 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3567 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3568 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3569 ("mml" . "emacs-mime"))
3570 "List of Info files that describe Emacs commands.
3571 An element can be a file name, or a list of the form (PREFIX . FILE)
3572 where PREFIX is a name prefix and FILE is the file to look in.
3573 If the element is just a file name, the file name also serves as the prefix.")
3575 (defun Info-find-emacs-command-nodes (command)
3576 "Return a list of locations documenting COMMAND.
3577 The `info-file' property of COMMAND says which Info manual to search.
3578 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3579 defines heuristics for which Info manual to try.
3580 The locations are of the format used in `Info-history', i.e.
3581 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3582 in the first element of the returned list (which is treated specially in
3583 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3584 (let ((where '()) line-number
3588 (info-file "emacs")) ;default
3589 ;; Determine which Info file this command is documented in.
3590 (if (get command 'info-file)
3591 (setq info-file (get command 'info-file))
3592 ;; If it doesn't say explicitly, test its name against
3593 ;; various prefixes that we know.
3594 (let ((file-list Info-file-list-for-emacs))
3595 (while file-list
3596 (let* ((elt (car file-list))
3597 (name (if (consp elt)
3598 (car elt)
3599 elt))
3600 (file (if (consp elt) (cdr elt) elt))
3601 (case-fold-search nil)
3604 (if (string-match regexp (symbol-name command))
3605 (setq info-file file file-list nil))
3606 (setq file-list (cdr file-list))))))
3607 (Info-find-node info-file "Top")
3608 ;; Bind Info-history to nil, to prevent the index nodes from
3609 ;; getting into the node history.
3610 (let ((Info-history nil)
3611 (Info-history-list nil)
3612 node (nodes (Info-index-nodes)))
3613 (Info-goto-node (car nodes))
3614 (while
3615 (progn
3616 (goto-char (point-min))
3617 (while (re-search-forward cmd-desc nil t)
3618 (setq where
3619 (cons (list Info-current-file
3620 (match-string-no-properties 2)
3621 0)
3622 where))
3623 (setq line-number (and (match-beginning 3)
3624 (string-to-number (match-string 3)))))
3625 (and (setq nodes (cdr nodes) node (car nodes))))
3626 (Info-goto-node node)))
3627 (if (and line-number where)
3628 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3629 (cdr where))
3630 where)))
3632 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3633 ;;;###autoload
3634 (defun Info-goto-emacs-command-node (command)
3635 "Go to the Info node in the Emacs manual for command COMMAND.
3636 The command is found by looking up in Emacs manual's indices
3637 or in another manual found via COMMAND's `info-file' property or
3638 the variable `Info-file-list-for-emacs'.
3639 COMMAND must be a symbol or string."
3640 (interactive "CFind documentation for command: ")
3641 ;; If command is given as a string, convert it to a symbol.
3642 (if (stringp command)
3643 (setq command (intern command)))
3644 (or (commandp command)
3645 (signal 'wrong-type-argument (list 'commandp command)))
3646 (let ((where (Info-find-emacs-command-nodes command)))
3647 (if where
3648 (let ((num-matches (length where)))
3649 ;; Get Info running, and pop to it in another window.
3650 (save-window-excursion
3651 (info))
3652 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3653 ;; Bind Info-history to nil, to prevent the last Index node
3654 ;; visited by Info-find-emacs-command-nodes from being
3655 ;; pushed onto the history.
3656 (let ((Info-history nil) (Info-history-list nil)
3657 (line-number (nth 2 (car where))))
3658 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3659 (if (and (integerp line-number) (> line-number 0))
3660 (forward-line (1- line-number))))
3661 (if (> num-matches 1)
3662 (progn
3663 ;; (car where) will be pushed onto Info-history
3664 ;; when/if they go to another node. Put the other
3665 ;; nodes that were found on the history.
3666 (setq Info-history (nconc (cdr where) Info-history))
3667 (message "Found %d other entr%s. Use %s to see %s."
3668 (1- num-matches)
3669 (if (> num-matches 2) "ies" "y")
3671 (if (> num-matches 2) "them" "it")))))
3672 (error "Couldn't find documentation for %s" command))))
3674 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3675 ;;;###autoload
3676 (defun Info-goto-emacs-key-command-node (key)
3677 "Go to the node in the Emacs manual which describes the command bound to KEY.
3678 KEY is a string.
3679 Interactively, if the binding is `execute-extended-command', a command is read.
3680 The command is found by looking up in Emacs manual's indices
3681 or in another manual found via COMMAND's `info-file' property or
3682 the variable `Info-file-list-for-emacs'."
3683 (interactive "kFind documentation for key: ")
3684 (let ((command (key-binding key)))
3685 (cond ((null command)
3686 (message "%s is undefined" (key-description key)))
3687 ((and (interactive-p)
3688 (eq command 'execute-extended-command))
3689 (Info-goto-emacs-command-node
3690 (read-command "Find documentation for command: ")))
3691 (t
3692 (Info-goto-emacs-command-node command)))))
3693 \f
3694 (defvar Info-next-link-keymap
3695 (let ((keymap (make-sparse-keymap)))
3696 (define-key keymap [header-line mouse-1] 'Info-next)
3697 (define-key keymap [header-line mouse-2] 'Info-next)
3698 (define-key keymap [header-line down-mouse-1] 'ignore)
3699 (define-key keymap [mouse-2] 'Info-next)
3700 (define-key keymap [follow-link] 'mouse-face)
3701 keymap)
3702 "Keymap to put on the Next link in the text or the header line.")
3704 (defvar Info-prev-link-keymap
3705 (let ((keymap (make-sparse-keymap)))
3706 (define-key keymap [header-line mouse-1] 'Info-prev)
3707 (define-key keymap [header-line mouse-2] 'Info-prev)
3708 (define-key keymap [header-line down-mouse-1] 'ignore)
3709 (define-key keymap [mouse-2] 'Info-prev)
3710 (define-key keymap [follow-link] 'mouse-face)
3711 keymap)
3712 "Keymap to put on the Prev link in the text or the header line.")
3714 (defvar Info-up-link-keymap
3715 (let ((keymap (make-sparse-keymap)))
3716 (define-key keymap [header-line mouse-1] 'Info-up)
3717 (define-key keymap [header-line mouse-2] 'Info-up)
3718 (define-key keymap [header-line down-mouse-1] 'ignore)
3719 (define-key keymap [mouse-2] 'Info-up)
3720 (define-key keymap [follow-link] 'mouse-face)
3721 keymap)
3722 "Keymap to put on the Up link in the text or the header line.")
3724 (defun Info-fontify-node ()
3725 "Fontify the node."
3726 (save-excursion
3727 (let* ((inhibit-read-only t)
3728 (case-fold-search t)
3729 paragraph-markers
3730 (not-fontified-p ; the node hasn't already been fontified
3731 (not (let ((where (next-property-change (point-min))))
3732 (and where (not (= where (point-max)))))))
3733 (fontify-visited-p ; visited nodes need to be re-fontified
3734 (and Info-fontify-visited-nodes
3735 ;; Don't take time to refontify visited nodes in huge nodes
3736 Info-fontify-maximum-menu-size
3737 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3738 rbeg rend)
3740 ;; Fontify header line
3741 (goto-char (point-min))
3743 (goto-char (match-end 0))
3745 (goto-char (match-end 0))
3746 (let* ((nbeg (match-beginning 2))
3747 (nend (match-end 2))
3748 (tbeg (match-beginning 1))
3749 (tag (match-string 1)))
3750 (if (string-equal (downcase tag) "node")
3751 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3752 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3753 (put-text-property tbeg nend 'mouse-face 'highlight)
3754 (put-text-property tbeg nend
3755 'help-echo
3756 (concat "mouse-2: Go to node "
3757 (buffer-substring nbeg nend)))
3758 ;; Always set up the text property keymap.
3759 ;; It will either be used in the buffer
3760 ;; or copied in the header line.
3761 (put-text-property
3762 tbeg nend 'keymap
3763 (cond
3764 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3765 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3766 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3767 (when Info-use-header-line
3768 (goto-char (point-min))
3769 (let* ((header-end (line-end-position))
3770 (header
3771 ;; If we find neither Next: nor Prev: link, show the entire
3772 ;; node header. Otherwise, don't show the File: and Node:
3773 ;; parts, to avoid wasting precious space on information that
3774 ;; is available in the mode line.
3775 (if (re-search-forward
3777 header-end t)
3778 (progn
3779 (goto-char (match-beginning 1))
3780 (buffer-substring (point) header-end))
3782 header-end t)
3783 (concat "No next, prev or up links -- "
3784 (buffer-substring (point) header-end))
3785 (buffer-substring (point) header-end)))))
3786 (put-text-property (point-min) (1+ (point-min))
3787 'header-line
3788 (replace-regexp-in-string
3789 "%"
3790 ;; Preserve text properties on duplicated `%'.
3791 (lambda (s) (concat s s)) header))
3792 ;; Hide the part of the first line
3793 ;; that is in the header, if it is just part.
3794 (unless (bobp)
3795 ;; Hide the punctuation at the end, too.
3797 (put-text-property (point) header-end 'invisible t)))))
3799 ;; Fontify titles
3800 (goto-char (point-min))
3801 (when (and font-lock-mode not-fontified-p)
3803 nil t)
3804 ;; Only consider it as an underlined title if the ASCII
3805 ;; underline has the same size as the text. A typical
3806 ;; counter example is when a continuation "..." is alone
3807 ;; on a line.
3808 (= (string-width (match-string 1))
3809 (string-width (match-string 2))))
3810 (let* ((c (preceding-char))
3811 (face
3812 (cond ((= c ?*) 'info-title-1)
3813 ((= c ?=) 'info-title-2)
3814 ((= c ?-) 'info-title-3)
3815 (t 'info-title-4))))
3816 (put-text-property (match-beginning 1) (match-end 1)
3817 'font-lock-face face))
3818 ;; This is a serious problem for trying to handle multiple
3819 ;; frame types at once. We want this text to be invisible
3820 ;; on frames that can display the font above.
3821 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3822 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3823 '(invisible t front-sticky nil rear-nonsticky t)))))
3825 ;; Fontify cross references
3826 (goto-char (point-min))
3827 (when (or not-fontified-p fontify-visited-p)
3828 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3829 (let ((start (match-beginning 0))
3830 (next (point))
3831 other-tag)
3832 (when not-fontified-p
3833 (when Info-hide-note-references
3834 (when (not (eq Info-hide-note-references 'hide))
3835 ;; *Note is often used where *note should have been
3836 (goto-char start)
3837 (skip-syntax-backward " ")
3838 (when (memq (char-before) '(?\( ?\[ ?\{))
3839 ;; Check whether the paren is preceded by
3840 ;; an end of sentence
3841 (skip-syntax-backward " ("))
3842 (setq other-tag
3844 "")
3846 "")
3847 ((memq (char-before) '(nil ?\. ?! ??))
3848 "See ")
3849 ((save-match-data
3850 (save-excursion
3852 "See ")
3853 (t "see "))))
3854 (goto-char next)
3855 (add-text-properties
3856 (match-beginning 1)
3857 (or (save-match-data
3859 (let ((start1 (match-beginning 1)))
3861 (+ start1 (match-beginning 0)))))
3862 (match-end 1))
3863 (if other-tag
3864 `(display ,other-tag front-sticky nil rear-nonsticky t)
3865 '(invisible t front-sticky nil rear-nonsticky t))))
3866 (add-text-properties
3867 (match-beginning 2) (match-end 2)
3868 (list
3869 'help-echo (if (or (match-end 5)
3870 (not (equal (match-string 4) "")))
3871 (concat "mouse-2: go to " (or (match-string 5)
3872 (match-string 4)))
3873 "mouse-2: go to this node")
3874 'mouse-face 'highlight)))
3875 (when (or not-fontified-p fontify-visited-p)
3876 (setq rbeg (match-beginning 2)
3877 rend (match-end 2))
3878 (put-text-property
3879 rbeg rend
3880 'font-lock-face
3881 ;; Display visited nodes in a different face
3882 (if (and Info-fontify-visited-nodes
3883 (save-match-data
3884 (let* ((node (replace-regexp-in-string
3886 (replace-regexp-in-string
3888 (or (match-string-no-properties 5)
3889 (and (not (equal (match-string 4) ""))
3890 (match-string-no-properties 4))
3891 (match-string-no-properties 2)))))
3892 (external-link-p
3894 (file (if external-link-p
3895 (file-name-nondirectory
3896 (match-string-no-properties 1 node))
3897 Info-current-file))
3898 (hl Info-history-list)
3899 res)
3900 (if external-link-p
3901 (setq node (if (equal (match-string 2 node) "")
3902 "Top"
3903 (match-string-no-properties 2 node))))
3904 (while hl
3905 (if (and (string-equal node (nth 1 (car hl)))
3906 (equal file
3907 (if (and external-link-p
3908 (stringp (caar hl)))
3909 (file-name-nondirectory
3910 (caar hl))
3911 (caar hl))))
3912 (setq res (car hl) hl nil)
3913 (setq hl (cdr hl))))
3914 res))) 'info-xref-visited 'info-xref))
3915 ;; For multiline ref, unfontify newline and surrounding whitespace
3916 (save-excursion
3917 (goto-char rbeg)
3918 (save-match-data
3920 (remove-text-properties (match-beginning 0)
3921 (match-end 0)
3922 '(font-lock-face t))))))
3923 (when not-fontified-p
3924 (when (memq Info-hide-note-references '(t hide))
3925 (add-text-properties (match-beginning 3) (match-end 3)
3926 '(invisible t front-sticky nil rear-nonsticky t))
3927 ;; Unhide the file name of the external reference in parens
3928 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3929 (remove-text-properties (match-beginning 6) (match-end 6)
3930 '(invisible t front-sticky nil rear-nonsticky t)))
3931 ;; Unhide newline because hidden newlines cause too long lines
3932 (save-match-data
3933 (let ((beg3 (match-beginning 3))
3934 (end3 (match-end 3)))
3936 (not (save-match-data
3937 (save-excursion
3938 (goto-char (1+ end3))
3939 (looking-at "[.)]*$")))))
3940 (remove-text-properties (+ beg3 (match-beginning 0))
3941 (+ beg3 (match-end 0))
3942 '(invisible t front-sticky nil rear-nonsticky t))))))
3943 (when (and Info-refill-paragraphs Info-hide-note-references)
3944 (push (set-marker (make-marker) start)
3945 paragraph-markers))))))
3947 ;; Refill paragraphs (experimental feature)
3948 (when (and not-fontified-p
3949 Info-refill-paragraphs
3950 paragraph-markers)
3951 (let ((fill-nobreak-invisible t)
3952 (fill-individual-varying-indent nil)
3955 (adaptive-fill-mode nil))
3956 (goto-char (point-max))
3957 (dolist (m paragraph-markers)
3958 (when (< m (point))
3959 (goto-char m)
3960 (beginning-of-line)
3961 (let ((beg (point)))
3962 (when (zerop (forward-paragraph))
3963 (fill-individual-paragraphs beg (point) nil nil)
3964 (goto-char beg))))
3965 (set-marker m nil))))
3967 ;; Fontify menu items
3968 (goto-char (point-min))
3969 (when (and (or not-fontified-p fontify-visited-p)
3971 ;; Don't take time to annotate huge menus
3972 Info-fontify-maximum-menu-size
3973 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3974 (let ((n 0)
3975 cont)
3976 (while (re-search-forward
3979 nil t)
3980 (when (match-beginning 1)
3981 (when not-fontified-p
3982 (setq n (1+ n))
3983 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3984 (put-text-property (match-beginning 0)
3985 (1+ (match-beginning 0))
3986 'font-lock-face 'info-menu-star)))
3987 (when not-fontified-p
3988 (add-text-properties
3989 (match-beginning 1) (match-end 1)
3990 (list
3991 'help-echo (if (and (match-end 3)
3992 (not (equal (match-string 3) "")))
3993 (concat "mouse-2: go to " (match-string 3))
3994 "mouse-2: go to this node")
3995 'mouse-face 'highlight)))
3996 (when (or not-fontified-p fontify-visited-p)
3997 (put-text-property
3998 (match-beginning 1) (match-end 1)
3999 'font-lock-face
4000 ;; Display visited menu items in a different face
4001 (if (and Info-fontify-visited-nodes
4002 (save-match-data
4003 (let* ((node (if (equal (match-string 3) "")
4004 (match-string-no-properties 1)
4005 (match-string-no-properties 3)))
4006 (external-link-p
4008 (file (if external-link-p
4009 (file-name-nondirectory
4010 (match-string-no-properties 1 node))
4011 Info-current-file))
4012 (hl Info-history-list)
4013 res)
4014 (if external-link-p
4015 (setq node (if (equal (match-string 2 node) "")
4016 "Top"
4017 (match-string-no-properties 2 node))))
4018 (while hl
4019 (if (and (string-equal node (nth 1 (car hl)))
4020 (equal file
4021 (if (and external-link-p
4022 (stringp (caar hl)))
4023 (file-name-nondirectory
4024 (caar hl))
4025 (caar hl))))
4026 (setq res (car hl) hl nil)
4027 (setq hl (cdr hl))))
4028 res))) 'info-xref-visited 'info-xref)))
4029 (when (and not-fontified-p
4030 (memq Info-hide-note-references '(t hide))
4031 (not (Info-index-node)))
4032 (put-text-property (match-beginning 2) (1- (match-end 6))
4033 'invisible t)
4034 ;; Unhide the file name in parens
4035 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
4036 (remove-text-properties (match-beginning 4) (match-end 4)
4037 '(invisible t)))
4038 ;; We need a stretchable space like :align-to but with
4039 ;; a minimum value.
4040 (put-text-property (1- (match-end 6)) (match-end 6) 'display
4041 (if (>= 22 (- (match-end 1)
4042 (match-beginning 0)))
4043 '(space :align-to 24)
4044 '(space :width 2)))
4045 (setq cont (looking-at "."))
4046 (while (and (= (forward-line 1) 0)
4048 (put-text-property (match-beginning 1) (1- (match-end 1))
4049 'invisible t)
4050 (put-text-property (1- (match-end 1)) (match-end 1)
4051 'display
4052 (if cont
4053 '(space :align-to 26)
4054 '(space :align-to 24)))
4055 (setq cont t)))))))
4057 ;; Fontify menu headers
4058 ;; Add the face `info-menu-header' to any header before a menu entry
4059 (goto-char (point-min))
4061 (put-text-property (match-beginning 0) (match-end 0)
4062 'font-lock-face 'info-menu-header)
4064 (put-text-property (match-beginning 1) (match-end 1)
4065 'font-lock-face 'info-menu-header)))
4067 ;; Hide index line numbers
4068 (goto-char (point-min))
4069 (when (and not-fontified-p (Info-index-node))
4071 (put-text-property (match-beginning 0) (match-end 0)
4072 'invisible t)))
4074 ;; Fontify http and ftp references
4075 (goto-char (point-min))
4076 (when not-fontified-p
4078 nil t)
4079 (add-text-properties (match-beginning 0) (match-end 0)
4080 '(font-lock-face info-xref
4081 mouse-face highlight
4082 help-echo "mouse-2: go to this URL"))))
4084 (set-buffer-modified-p nil))))
4085 \f
4086 ;;; Speedbar support:
4087 ;; These functions permit speedbar to display the "tags" in the
4088 ;; current Info node.
4089 (eval-when-compile (require 'speedbar))
4091 (defvar Info-speedbar-key-map nil
4092 "Keymap used when in the info display mode.")
4094 (defun Info-install-speedbar-variables ()
4095 "Install those variables used by speedbar to enhance Info."
4096 (if Info-speedbar-key-map
4097 nil
4098 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4100 ;; Basic tree features
4101 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4102 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4103 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4104 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4105 )
4107 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4108 Info-speedbar-key-map
4109 Info-speedbar-hierarchy-buttons)))
4111 (defvar Info-speedbar-menu-items
4112 '(["Browse Node" speedbar-edit-line t]
4113 ["Expand Node" speedbar-expand-line
4114 (save-excursion (beginning-of-line)
4116 ["Contract Node" speedbar-contract-line
4117 (save-excursion (beginning-of-line)
4118 (looking-at "[0-9]+: *.-. "))]
4119 )
4120 "Additional menu-items to add to speedbar frame.")
4122 ;; Make sure our special speedbar major mode is loaded
4123 (if (featurep 'speedbar)
4124 (Info-install-speedbar-variables)
4125 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4127 ;;; Info hierarchy display method
4128 ;;;###autoload
4129 (defun Info-speedbar-browser ()
4130 "Initialize speedbar to display an Info node browser.
4131 This will add a speedbar major display mode."
4132 (interactive)
4133 (require 'speedbar)
4134 ;; Make sure that speedbar is active
4135 (speedbar-frame-mode 1)
4136 ;; Now, throw us into Info mode on speedbar.
4137 (speedbar-change-initial-expansion-list "Info")
4138 )
4140 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4141 "Display an Info directory hierarchy in speedbar.
4142 DIRECTORY is the current directory in the attached frame.
4143 DEPTH is the current indentation depth.
4144 NODE is an optional argument that is used to represent the
4145 specific node to expand."
4146 (if (and (not node)
4147 (save-excursion (goto-char (point-min))
4148 (let ((case-fold-search t))
4149 (looking-at "Info Nodes:"))))
4150 ;; Update our "current node" maybe?
4151 nil
4152 ;; We cannot use the generic list code, that depends on all leaves
4153 ;; being known at creation time.
4154 (if (not node)
4156 (let ((completions nil))
4157 (speedbar-select-attached-frame)
4158 (save-window-excursion
4159 (setq completions
4160 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4161 (select-frame (speedbar-current-frame))
4162 (if completions
4163 (speedbar-with-writable
4164 (dolist (completion completions)
4165 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4166 (cdr completion)
4167 (car completion)
4168 'Info-speedbar-goto-node
4169 (cdr completion)
4170 'info-xref depth))
4171 t)
4172 nil))))
4174 (defun Info-speedbar-goto-node (text node indent)
4175 "When user clicks on TEXT, go to an info NODE.
4176 The INDENT level is ignored."
4177 (speedbar-select-attached-frame)
4178 (let* ((buff (or (get-buffer "*info*")
4179 (progn (info) (get-buffer "*info*"))))
4180 (bwin (get-buffer-window buff 0)))
4181 (if bwin
4182 (progn
4183 (select-window bwin)
4184 (raise-frame (window-frame bwin)))
4185 (if speedbar-power-click
4186 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4187 (speedbar-select-attached-frame)
4188 (switch-to-buffer buff)))
4190 (error "Invalid node %s" node)
4191 (Info-find-node (match-string 1 node) (match-string 2 node))
4192 ;; If we do a find-node, and we were in info mode, restore
4193 ;; the old default method. Once we are in info mode, it makes
4194 ;; sense to return to whatever method the user was using before.
4195 (if (string= speedbar-initial-expansion-list-name "Info")
4196 (speedbar-change-initial-expansion-list
4197 speedbar-previously-used-expansion-list-name)))))
4199 (defun Info-speedbar-expand-node (text token indent)
4200 "Expand the node the user clicked on.
4201 TEXT is the text of the button we clicked on, a + or - item.
4202 TOKEN is data related to this node (NAME . FILE).
4203 INDENT is the current indentation depth."
4204 (cond ((string-match "+" text) ;we have to expand this file
4205 (speedbar-change-expand-button-char ?-)
4206 (if (speedbar-with-writable
4207 (save-excursion
4208 (end-of-line) (forward-char 1)
4209 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4210 (speedbar-change-expand-button-char ?-)
4211 (speedbar-change-expand-button-char ??)))
4212 ((string-match "-" text) ;we have to contract this node
4213 (speedbar-change-expand-button-char ?+)
4214 (speedbar-delete-subblock indent))
4215 (t (error "Ooops... not sure what to do")))
4216 (speedbar-center-buffer-smartly))
4218 (defun Info-speedbar-fetch-file-nodes (nodespec)
4219 "Fetch the subnodes from the info NODESPEC.
4220 NODESPEC is a string of the form: (file)node."
4221 (save-excursion
4222 ;; Set up a buffer we can use to fake-out Info.
4223 (set-buffer (get-buffer-create " *info-browse-tmp*"))
4224 (if (not (equal major-mode 'Info-mode))
4225 (Info-mode))
4226 ;; Get the node into this buffer
4228 (error "Invalid node specification %s" nodespec)
4229 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4230 ;; Scan the created buffer
4231 (goto-char (point-min))
4232 (let ((completions nil)
4233 (case-fold-search t)
4235 (match-string 1 nodespec))))
4236 ;; Always skip the first one...
4239 (let ((name (match-string 1)))
4240 (push (cons name
4242 (match-string 1)
4244 (concat (match-string 1) "Top")
4245 (concat "(" thisfile ")"
4247 (match-string 1)
4248 name)))))
4249 completions)))
4250 (nreverse completions))))
4252 ;;; Info mode node listing
4253 ;; This is called by `speedbar-add-localized-speedbar-support'
4254 (defun Info-speedbar-buttons (buffer)
4255 "Create a speedbar display to help navigation in an Info file.
4256 BUFFER is the buffer speedbar is requesting buttons for."
4257 (if (save-excursion (goto-char (point-min))
4258 (let ((case-fold-search t))
4259 (not (looking-at "Info Nodes:"))))
4260 (erase-buffer))
4261 (Info-speedbar-hierarchy-buttons nil 0))
4263 (dolist (mess '("^First node in file$"
4264 "^No `.*' in index$"
4265 "^No cross-reference named"
4266 "^No cross.references in this node$"
4267 "^No current Info node$"
4268 "^No menu in this node$"
4269 "^No more items in menu$"
4270 "^No more nodes$"
4272 "^No previous `i' command$"
4273 "^No previous items in menu$"
4274 "^No previous nodes$"
4275 "^No such item in menu$"
4276 "^No such node or anchor"
4277 "^Node has no"
4278 "^Point neither on reference nor in menu item description$"
4280 search-failed))
4281 (add-to-list 'debug-ignored-errors mess))
4283 ;;;; Desktop support
4285 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4286 "Auxiliary information to be saved in desktop file."
4287 (unless (member Info-current-file '(apropos history toc nil))
4288 (list Info-current-file Info-current-node)))
4290 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4291 desktop-buffer-name
4292 desktop-buffer-misc)
4293 "Restore an Info buffer specified in a desktop file."
4294 (let ((first (nth 0 desktop-buffer-misc))
4295 (second (nth 1 desktop-buffer-misc)))
4296 (when (and first second)
4297 (when desktop-buffer-name
4298 (set-buffer (get-buffer-create desktop-buffer-name))
4299 (Info-mode))
4300 (Info-find-node first second)
4301 (current-buffer))))
4303 (add-to-list 'desktop-buffer-mode-handlers
4304 '(Info-mode . Info-restore-desktop-buffer))
4306 (provide 'info)
4308 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4309 ;;; info.el ends here