| blob | 9f2935dfe3a1e2379dc4d9f90eeacc607b171e29 |
1 ;;; info.el --- info package for Emacs
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Keywords: help
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Note that nowadays we expect Info files to be made using makeinfo.
28 ;; In particular we make these assumptions:
29 ;; - a menu item MAY contain colons but not colon-space ": "
30 ;; - a menu item ending with ": " (but not ":: ") is an index entry
31 ;; - a node name MAY NOT contain a colon
32 ;; This distinction is to support indexing of computer programming
33 ;; language terms that may contain ":" but not ": ".
35 ;;; Code:
40 "Info subsystem."
46 "Stack of Info nodes user has visited.
50 "Stack of Info nodes user has visited with `Info-history-back' command.
54 "List of all Info nodes user has visited.
59 This is convenient if you want to write Info files by hand.
60 However, we recommend that you not do this.
61 It is better to write a Texinfo file and generate the Info file from that,
62 because that gives you a printed manual as well."
67 "Non-nil allows Info to execute Lisp code associated with nodes.
75 "Face for Info node names."
84 "Face for info titles at level 1."
86 ;; backward-compatibility alias
92 "Face for info titles at level 2."
94 ;; backward-compatibility alias
100 "Face for info titles at level 3."
102 ;; backward-compatibility alias
108 "Face for info titles at level 4."
110 ;; backward-compatibility alias
115 :underline t
118 :inherit variable-pitch
120 "Face for headers in Info menus."
126 "Face for every third `*' in an Info menu."
132 "Face for unvisited Info cross-references."
137 "Face for visited Info cross-references."
142 "*Non-nil to fontify references to visited nodes in `info-xref-visited' face."
148 "*Maximum size of menu to fontify if `font-lock-mode' is non-nil.
149 Set to nil to disable node fontification."
154 "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
155 A header-line does not scroll with the rest of the buffer."
161 "Face for Info cross-references in a node header."
166 "Face for Info nodes in a node header."
170 "List of directories to search for Info documentation files.
171 If nil, meaning not yet initialized, Info uses the environment
172 variable INFOPATH to initialize it, or `Info-default-directory-list'
173 if there is no INFOPATH variable in the environment, or the
174 concatenation of the two if INFOPATH ends with a colon.
176 When `Info-directory-list' is initialized from the value of
177 `Info-default-directory-list', and Emacs is installed in one of the
178 standard directories, the directory of Info files that come with Emacs
179 is put last (so that local Info files override standard ones).
181 When `Info-directory-list' is initialized from the value of
182 `Info-default-directory-list', and Emacs is not installed in one
183 of the standard directories, the first element of the resulting
184 list is the directory where Emacs installs the Info files that
185 come with it. This is so that Emacs's own manual, which suits the
186 version of Emacs you are using, will always be found first. This
187 is useful when you install an experimental version of Emacs without
188 removing the standard installation.
190 If you want to override the order of directories in
191 `Info-default-directory-list', set INFOPATH in the environment.
193 If you run the Emacs executable from the `src' directory in the Emacs
194 source tree, and INFOPATH is not defined, the `info' directory in the
195 source tree is used as the first element of `Info-directory-list', in
196 place of the installation Info directory. This is useful when you run
200 "List of additional directories to search for Info documentation files.
201 These directories are searched after those in `Info-directory-list'."
208 If this is non-nil, and you scroll far enough in a node that its menu
210 moves to a subnode indicated by the following menu item. This means
211 that you visit a subnode before getting to the end of the menu.
213 Setting this option to nil results in behavior similar to the stand-alone
214 Info reader program, which visits the first subnode from the menu only
215 when you hit the end of the current node."
221 "*If non-nil, hide the tag and section reference in *note and * menu items.
223 If value is non-nil but not t or `hide', the reference section is still shown.
224 `nil' completely disables this feature."
233 "*If non-nil, attempt to refill paragraphs with hidden references.
234 This refilling may accidentally remove explicit line breaks in the Info
235 file, so be prepared for a few surprises if you enable this feature."
241 "*If non-nil, regular expression to match a sequence of whitespace chars.
242 This applies to Info search for regular expressions.
244 In the Customization buffer, that is `[' followed by a space,
245 a tab, a carriage return (control-M), a newline, and `]+'."
250 "*If non-nil, isearch in Info searches through multiple nodes.
251 Before leaving the initial Info node, where isearch was started,
252 it fails once with the error message [initial node], and with
253 subsequent C-s/C-r continues through other nodes without failing
254 with this error message in other nodes. When isearch fails for
255 the rest of the manual, it wraps aroung the whole manual and
256 restarts the search from the top/final node depending on
257 search direction.
259 Setting this option to nil restores the default isearch behavior
260 with wrapping around the current Info node."
268 ;; Try to obey obsolete Info-fontify settings.
271 "Hooks run when `Info-mode' is called."
276 "Hooks run when `Info-select-node' is called."
284 "Info file that Info is now looking at, or nil.
285 This is the name that was specified in Info, not the actual file name.
289 "Info subfile that is actually in the *info* buffer now.
296 "Marker pointing at beginning of current Info file's tag table.
312 "Point location within a selected node.
313 If string, the point is moved to the proper occurrence of the
314 name of the followed cross reference within a selected node.
319 \f
321 ;; The MS-DOS list should work both when long file names are
322 ;; supported (Windows 9X), and when only 8+3 file names are available.
364 "List of file name suffixes and associated decoding commands.
365 Each entry should be (SUFFIX . STRING); the file is given to
366 the command as standard input.
368 STRING may be a list of strings. In that case, the first element is
369 the command name, and the rest are arguments to that command.
371 If STRING is nil, no decoding is done.
372 Because the SUFFIXes are tried in order, the empty string should
375 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
376 ;; First, on MS-DOS with no long file names support, delete some of
377 ;; the extension in FILENAME to make room.
382 ;; How long is the extension in FILENAME (not counting the dot).
384 ext-left)
385 ;; SUFFIX starts with a dot. If FILENAME already has one,
386 ;; get rid of the one in SUFFIX (unless suffix is empty).
391 ;; How many chars of that extension should we keep?
393 ;; Get rid of the rest of the extension, and add SUFFIX.
396 suffix))))
403 "Insert the contents of an Info file in the current buffer.
404 Do the right thing if the file has been compressed or zipped."
408 t))
410 lfn))
411 fullname decoder done)
413 ;; FILENAME exists--see if that name contains a suffix.
414 ;; If so, set DECODE accordingly.
419 filename)))
423 ;; Try adding suffixes to FILENAME and see if we can find something.
429 ;; If we found a file with a suffix, set DECODER
430 ;; according to the suffix.
432 ;; When the MS-DOS port runs on Windows, we need to check
433 ;; the short variant of a long file name as well.
443 ;; check for conflict with jka-compr
453 default-directory)))
459 \f
466 "../share/info/"
467 invocation-directory)))
469 infodir
471 "../../../share/info/"
472 invocation-directory))
474 infodir))))))
475 alternative)
478 ;; Uninstalled, Emacs builddir != srcdir.
479 sibling
480 ;; Uninstalled, builddir == srcdir
481 source))
483 ;; On DOS/NT, we use movable executables always,
484 ;; and we must always find the Info dir at run time.
486 nil
487 ;; Use invocation-directory for Info
488 ;; only if we used it for exec-directory also.
491 installation-directory))))
493 Info-default-directory-list
494 ;; `alternative' contains the Info files that came with this
495 ;; version, so we should look there first. `Info-insert-dir'
496 ;; currently expects to find `alternative' first on the list.
498 ;; Don't drop the last part, it might contain non-Emacs stuff.
499 ;; (reverse (cdr (reverse
503 "Initialize `Info-directory-list', if that hasn't been done yet."
516 ;;;###autoload
518 "Like `info' but show the Info buffer in another window."
524 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
526 ;;;###autoload (put 'info 'info-file "emacs")
527 ;;;###autoload
529 "Enter Info, the documentation browser.
530 Optional argument FILE-OR-NODE specifies the file to examine;
531 the default is the top-level directory of Info.
532 Called from a program, FILE-OR-NODE may specify an Info node of the form
533 `(FILENAME)NODENAME'.
534 Optional argument BUFFER specifies the Info buffer name;
535 the default buffer name is *info*. If BUFFER exists,
536 just switch to BUFFER. Otherwise, create a new buffer
537 with the top-level Info directory.
539 In interactive use, a non-numeric prefix argument directs
540 this command to read a file name from the minibuffer.
541 A numeric prefix argument selects an Info buffer with the prefix number
542 appended to the Info buffer name.
544 The search path for Info files is in the variable `Info-directory-list'.
545 The top-level Info directory is made by combining all the files named `dir'
546 in all the directories in that path.
548 See a list of available Info commands in `Info-mode'."
558 ;; If argument already contains parentheses, don't add another set
559 ;; since the argument will then be parsed improperly. This also
560 ;; has the added benefit of allowing node names to be included
561 ;; following the parenthesized filename.
564 file-or-node
568 ;; If we just created the Info buffer, go to the directory.
571 ;;;###autoload
573 "Display the Emacs manual in Info mode."
577 ;;;###autoload
579 "Run Emacs as a standalone Info reader.
580 Usage: emacs -f info-standalone [filename]
594 \f
595 ;; See if the accessible portion of the buffer begins with a node
596 ;; delimiter, and the node header line which follows matches REGEXP.
597 ;; Typically, this test will be followed by a loop that examines the
598 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
599 ;; to have the overhead of this special test inside the loop.
601 ;; This function changes match-data, but supposedly the caller might
602 ;; want to use the results of re-search-backward.
604 ;; The return value is the value of point at the beginning of matching
605 ;; REGEXP, if the function succeeds, nil otherwise.
617 Optional second argument NOERROR, if t, means if file is not found
618 just return nil (no error)."
619 ;; Convert filename to lower case if not found as specified.
620 ;; Expand it.
629 ;; If specified name starts with `./'
630 ;; then just try current directory.
633 ;; No point in searching for an
634 ;; absolute file name
638 Info-additional-directory-list)
639 Info-directory-list)))))
640 ;; Search the directory list for file FILENAME.
645 ;; Try several variants of specified name.
649 t)))
660 lfn
672 filename)
676 "Go to an Info node specified as separate FILENAME and NODENAME.
677 NO-GOING-BACK is non-nil if recovering from an error in this function;
678 it says do not attempt further (recursive) error recovery."
681 ;; Go into Info buffer.
683 ;; Record the node we are leaving, if we were in one.
685 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 for makeinfo-buffer and
710 ;; Info-revert-buffer-function) 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
748 "Find a node in a tag table.
749 MARKER specifies the buffer and position to start searching at.
750 REGEXP is a regular expression matching nodes or references. Its first
751 group should match `Node:' or `Ref:'.
752 CASE-FOLD t means search for a case-insensitive match.
753 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
754 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
755 where the match was found, and MODE is `major-mode' of the buffer in
756 which the match was found."
761 ;; Search tag table
766 major-mode)))))
769 "Find a node in a tag table.
770 MARKER specifies the buffer and position to start searching at.
771 REGEXP is a regular expression matching nodes or references. Its first
772 group should match `Node:' or `Ref:'.
773 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
774 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
775 where the match was found, and MODE is `major-mode' of the buffer in
776 which the match was found.
777 This function tries to find a case-sensitive match first, then a
778 case-insensitive match is tried."
782 result))
785 "Find a node or anchor in the current buffer.
786 REGEXP is a regular expression matching nodes or references. Its first
787 group should match `Node:' or `Ref:'.
788 CASE-FOLD t means search for a case-insensitive match.
789 Value is the position at which a match was found, or nil if not found."
791 found)
803 found)))
806 "Find a node or anchor in the current buffer.
807 REGEXP is a regular expression matching nodes or references. Its first
808 group should match `Node:' or `Ref:'.
809 Value is the position at which a match was found, or nil if not found.
810 This function looks for a case-sensitive match first. If none is found,
811 a case-insensitive match is tried."
823 anchorpos)
824 ;; Switch files if necessary
829 Info-current-subfile nil
830 Info-current-file-completions nil
831 buffer-file-name nil)
847 ;; Check makeinfo version for index cookie support
859 ;; See whether file has a tag table. Record the location if yes.
862 ;; Use string-equal, not equal, to ignore text props.
867 ;; We have a tag table. Find its beginning.
868 ;; Is this an indirect file?
874 ;; It is indirect. Copy it to another buffer
875 ;; and record that the tag table is in that buffer.
894 ))
895 ;; Use string-equal, not equal, to ignore text props.
899 ;; Possibilities:
900 ;;
901 ;; 1. Anchor found in tag table
902 ;; 2. Anchor *not* in tag table
903 ;;
904 ;; 3. Node found in tag table
905 ;; 4. Node *not* found in tag table, but found in file
906 ;; 5. Node *not* in tag table, and *not* in file
907 ;;
908 ;; *Or* the same, but in an indirect subfile.
910 ;; Search file for a suitable node.
920 ;; First, search a tag table, if any
926 ;; FOUND is (ANCHOR POS MODE).
929 ;; If this is an indirect file, determine which
930 ;; file really holds this node and read it in.
932 ;; Note that the current buffer must be the
933 ;; *info* buffer on entry to
934 ;; Info-read-subfile. Thus the hackery above.
937 ;; Handle anchor
942 ;; Else we may have a node, which we search for:
946 ;; Now search from our advised position (or from beg of
947 ;; buffer) to find the actual node. First, check
948 ;; whether the node is right where we are, in case the
949 ;; buffer begins with a node.
962 ;; No such anchor in tag table or node in tag table or file
970 ;; Add anchors to the history too
981 ;; If we did not finish finding the specified node,
982 ;; go back to the previous one.
989 ;; Cache the contents of the (virtual) dir file, once we have merged
990 ;; it for the first time, so we can save time subsequently.
993 ;; Cache for the directory we decided to use for the default-directory
994 ;; of the merged dir text.
997 ;; Record the file attributes of all the files from which we
998 ;; constructed Info-dir-contents.
1003 ;; Construct the Info directory node by merging the files named `dir'
1004 ;; from various directories. Set the *info* buffer's
1005 ;; default-directory to the first directory we actually get any text
1006 ;; from.
1009 ;; Verify that none of the files we used has changed
1010 ;; since we used it.
1014 ;; Handle symlinks
1017 ;; Don't compare the access time.
1021 Info-dir-file-attributes))))
1027 Info-additional-directory-list)
1028 Info-directory-list))
1030 ;; Bind this in case the user sets it to nil.
1032 ;; This is set non-nil if we find a problem in some input files.
1033 problems
1034 buffers buffer others nodes dirs-done)
1036 ;; Search the directory list for the directory file.
1041 ;; Try several variants of specified name.
1042 ;; Try upcasing, appending `.info', or both.
1057 dirs-done)))
1066 file)
1078 ;; Distinguish the dir file that comes with Emacs from all the
1079 ;; others. Yes, that is really what this is supposed to do.
1080 ;; The definition of `Info-directory-list' puts it first on that
1081 ;; list and so last in `buffers' at this point.
1085 ;; Insert the entire original dir file as a start; note that we've
1086 ;; already saved its default directory to use as the default
1087 ;; directory for the whole concatenation.
1090 ;; Look at each of the other buffers one by one.
1093 ;; In each, find all the menus.
1096 ;; Find each menu, and add an elt to NODES for it.
1100 nodename end)
1112 ;; Add to the main menu a menu item for each other node.
1124 end t)
1128 ;; Now take each node of each of the other buffers
1129 ;; and merge it into the main buffer.
1134 ;; Find the like-named node in the main buffer.
1138 nil t)
1143 ;; If none exists, add one.
1146 ;; Merge the text from the other buffer's menu
1147 ;; into the menu in the like-named node in the main buffer.
1150 ;; Kill all the buffers we just made, including the special one excised.
1170 ;; Remove duplicate headings in the same menu.
1173 ;; Look for the next heading to unify.
1178 ;; Check whether this heading should be streamlined.
1188 ;; Look for other headings of the same category and merge them.
1194 ;; Delete redundant heading.
1196 ;; Push the entries onto `text'.
1203 entries)
1205 ;; Insert the entries just found.
1213 ;; Now remove duplicate entries under the same heading.
1220 ;; Fold case straight away; `member-ignore-case' here wasteful.
1228 ;; Note that on entry to this function the current-buffer must be the
1229 ;; *info* buffer; not the info tags buffer.
1231 ;; NODEPOS is either a position (in the Info file as a whole,
1232 ;; not relative to a subfile) or the name of a subfile.
1234 lastfilename)
1245 thisfilepos thisfilename)
1249 ;; read in version 19 stops at the end of number.
1250 ;; Advance to the next line.
1259 ;; Assume previous buffer is in Info-mode.
1260 ;; (set-buffer (get-buffer "*info*"))
1269 ;; Widen in case we are in the same subfile as before.
1279 "Unescape double quotes and backslashes in VALUE."
1285 unquote))
1287 ;; As of Texinfo 4.6, makeinfo writes constructs like
1288 ;; \0\h[image param=value ...\h\0]
1289 ;; into the Info file for handling images.
1292 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1293 whitespace or double quotes, it must be quoted in double quotes and
1298 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1299 parameter-string start)
1305 parameter-alist))
1306 parameter-alist))
1309 "Display images in current node."
1316 nil t)
1330 ;; text-only display, show alternative text if provided, or
1331 ;; otherwise a clue that there's meant to be a picture
1340 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1341 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1342 ;; including one optional trailing newline.
1344 "Hide unrecognized cookies in current node."
1351 nil t)
1358 "Select the Info node that point is in."
1359 ;; Bind this in case the user sets it to nil.
1362 ;; Find beginning of node.
1368 ;; Get nodename spelled as it is in the node.
1376 ;; Find the end of it, and narrow.
1379 ;; Narrow to the node contents
1391 ;; Add a new unique history item to full history list
1406 map)
1414 " ("
1419 ") "
1424 'help-echo
1425 "mouse-1: scroll forward, mouse-3: scroll back"
1429 \f
1430 ;; Go to an Info node specified with a filename-and-nodename string
1431 ;; of the sort that is found in pointers in nodes.
1433 ;; Don't autoload this function: the correct entry point for other packages
1434 ;; to use is `info'. --Stef
1435 ;; ;;;###autoload
1437 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1438 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1439 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1440 its sub-files).
1441 Completion is available, but only for node names in the current Info file.
1442 If FORK is non-nil (interactively with a prefix arg), show the node in
1443 a new Info buffer.
1444 If FORK is a string, it is the name to use for the new buffer."
1452 nodename)
1454 ""
1468 "Virtual completion table for file names input in Info node names.
1469 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1483 ;; If the file name has no suffix or a standard suffix,
1484 ;; include it.
1487 ;; But exclude subfiles of split Info files.
1489 ;; And exclude backup files.
1492 ;; If the file name ends in a standard suffix,
1493 ;; add the unsuffixed name as a completion option.
1499 ;; This function is used as the "completion table" while reading a node name.
1500 ;; It does completion using the alist in Info-read-node-completion-table
1501 ;; unless STRING starts with an open-paren.
1504 ;; First complete embedded file names.
1507 "("
1510 Info-directory-list
1513 predicate
1514 code))
1516 ;; If a file name was given, then any node is fair game.
1522 ;; Otherwise use Info-read-node-completion-table.
1524 code Info-read-node-completion-table string predicate))))
1526 ;; Arrange to highlight the proper letters in the completion list buffer.
1535 nodename)))
1540 ;; Bind this in case the user sets it to nil.
1555 compl))))
1558 ;; If the buffer begins with a node header, process that first.
1561 ;; Now for the rest of the nodes.
1569 compl))))))))
1572 \f
1574 "If this node has been visited, restore the point value when we left."
1577 ;; Use string-equal, not equal, to ignore text props.
1583 \f
1591 "Search for REGEXP, starting from point, and select node it's found in.
1592 If DIRECTION is `backward', search in the reverse direction."
1620 ;; Hide Info file header for backward search
1631 Info-search-whitespace-regexp)))
1646 ;; If no subfiles, give error now.
1651 Info-search-whitespace-regexp)))
1662 ;; Try other subfiles.
1672 ;; Find the subfile we just searched.
1674 ;; Skip that one.
1677 ;; Make a list of all following subfiles.
1678 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1687 list))
1691 ;; Put in forward order
1697 ;; Hide Info file header for backward search
1711 Info-search-whitespace-regexp)))
1734 ;; Search landed in the same node
1740 ;; Use string-equal, not equal, to ignore text props.
1746 Info-history))))))
1749 "Search for a regexp case-sensitively."
1755 "Search for next regexp from a previous `Info-search' command."
1763 "Search for REGEXP in the reverse direction."
1782 nil t)
1784 bound noerror count
1787 bound noerror count
1816 "Skip invisible text, node header line and Tag Table node."
1826 ;; Skip node header line
1830 ;; Skip Tag Table node
1836 \f
1838 "Extract the value of the node-pointer named NAME.
1839 If there is none, use ERRORNAME in the error message;
1840 if ERRORNAME is nil, just return nil."
1841 ;; Bind this in case the user sets it to nil.
1855 "Return a regexp matching a node name.
1856 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1857 saying which chars may appear in the node name.
1858 Submatch 1 is the complete node name.
1859 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1860 Submatch 3 is the local part of the node name.
1861 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1868 ;;; For compatibility; other files have used this name.
1874 "Go to the next node of this node."
1876 ;; In case another window is currently selected
1882 "Go to the previous node of this node."
1884 ;; In case another window is currently selected
1890 "Go to the superior node of this node.
1891 If SAME-FILE is non-nil, do not move to a different Info file."
1893 ;; In case another window is currently selected
1912 nil t))
1918 "Go back in the history to the last node visited."
1924 Info-history-forward))
1925 filename nodename opoint)
1938 "Go forward in the history of visited nodes."
1943 filename nodename opoint)
1951 ;;;###autoload
1953 "Go to the Info directory node."
1956 \f
1958 "Go to a node with a menu of visited nodes."
1962 p)
1987 "Go to a node with table of contents of the current Info file.
1988 Table of contents is created from the tree structure of menus."
1993 p)
2023 "Insert table of contents with references to nodes."
2035 "Build table of contents from menus of Info FILE and its subfiles."
2040 default-directory))
2043 nodes subfiles)
2045 ;; (or main-file (message "Searching subfile %s..." (car subfiles)))
2056 bound t)
2059 menu-items)
2069 bound))
2072 ;; Menu item line
2082 ;; Other non-empty strings in the Top node are section names
2091 nodes))
2100 subfiles)))))
2102 main-file nil))
2108 "Alist of cached parent-children node information in visited Info files.
2109 Each element is (FILE (NODE-NAME PARENT SECTION CHILDREN) ...)
2110 where PARENT is the parent node extracted from the Up pointer,
2111 SECTION is the section name in the Top node where this node is placed,
2115 "Return a node list of Info FILE with parent-children information.
2116 This information is cached in the variable `Info-toc-nodes' with the help
2117 of the function `Info-build-toc'."
2120 ;; Skip virtual Info files
2124 ;; Scan the entire manual and cache the result in Info-toc-nodes
2127 nodes)
2128 ;; If there is an error, still add nil to the cache
2132 \f
2134 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2135 FOOTNOTENAME may be an abbreviation of the reference name.
2136 If FORK is non-nil (interactively with a prefix arg), show the node in
2137 a new Info buffer. If FORK is a string, it is the name to use for the
2138 new buffer."
2144 ;; Store end and beginning of line.
2153 ;; See if this one should be the default.
2158 ;; See if this one should be the alternate default.
2168 ;; Record as a completion and perhaps as default.
2171 ;; Don't add this string if it's a duplicate.
2174 ;; If no good default was found, try an alternate.
2177 ;; If only one cross-reference found, then make it default.
2183 "Follow reference named (default "
2186 completions nil t)))
2200 ;; Move point to the beginning of reference if point is on reference
2210 ;; Go to the reference closest to point
2218 next-ref prev-ref))
2229 ;; We allow newline because this is also used in Info-follow-reference,
2230 ;; where the xref name might be wrapped over two lines.
2231 "Regexp that matches a menu entry name upto but not including the colon.
2232 Because of ambiguities, this should be concatenated with something like
2253 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2254 ;;; (setq Info-point-loc
2255 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2256 )
2260 ;; If the node name is the menu entry name (using `entry::').
2264 ;; No one calls this.
2265 ;;(defun Info-menu-item-sequence (list)
2266 ;; (while list
2267 ;; (Info-menu (car list))
2268 ;; (setq list (cdr list))))
2280 ;; This uses two dynamically bound variables:
2281 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2282 ;; is the menu of items we're trying to complete.
2283 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2284 ;; also look for menu items in subsequent nodes as long as those
2285 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2286 ;; not used.
2287 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2288 ;; also look for menu items in these nodes. This feature is currently
2289 ;; only used for completion in Info-index.
2291 ;; Note that `Info-complete-menu-buffer' could be current already,
2292 ;; so we want to save point.
2298 nextnode)
2307 completions
2309 ;; Check the cache.
2317 ;; We can reuse the previous list.
2319 ;; The cache can't be used.
2324 completions))
2325 ;; Check subsequent nodes if applicable.
2333 ;; Go back to the start node (for the next completion).
2336 ;; Update the cache.
2339 Info-complete-next-re string completions
2340 Info-complete-nodes)))
2347 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2348 The menu item should one of those listed in the current node's menu.
2349 Completion is allowed, and the default menu item is the one point is on.
2350 If FORK is non-nil (interactively with a prefix arg), show the node in
2351 a new Info buffer. If FORK is a string, it is the name to use for the
2352 new buffer."
2355 ;; If point is within a menu item, use that item as the default
2358 beg
2371 Info-menu-entry-name-re
2380 default)
2383 ;; we rely on the fact that completing-read accepts an input
2384 ;; of "" even when the require-match argument is true and ""
2385 ;; is not a valid possibility
2389 ;; ask again
2392 ;; there is a problem here in that if several menu items have the same
2393 ;; name you can only go to the node of the first with this command.
2411 ;; If COUNT is nil, use the last item in the menu.
2423 nil))
2427 "Go to the node of the Nth menu item.
2428 N is the digit argument used to invoke this command."
2435 "Go to the Top node of this file."
2440 "Go to the final node in this file."
2445 ;; Go to the last node in the menu of Top.
2447 ;; If the last node in the menu is not last in pointer structure,
2448 ;; move forward until we can't go any farther.
2450 ;; Then keep moving down to last subnode, unless we reach an index.
2456 "Go forward one node, considering all nodes as forming one sequence."
2461 ;; three possibilities, in order of priority:
2462 ;; 1. next node is in a menu in this node (but not in an index)
2463 ;; 2. next node is next at same level
2464 ;; 3. next node is up and next
2469 t)
2472 t)
2474 ;; Use string-equal, not equal, to ignore text props.
2487 "Go backward one node, considering all nodes as forming one sequence."
2495 ;; Use string-equal, not equal,
2496 ;; to ignore text properties.
2501 ;; If we move back at the same level,
2502 ;; go down to find the last subnode*.
2512 "Exit Info by selecting some other buffer."
2519 "Go to the node of the next menu item."
2521 ;; Bind this in case the user sets it to nil.
2533 "Go to the node of the previous menu item."
2537 ;; Bind this in case the user sets it to nil.
2552 "Go to the next subnode or the next node, or go up a level."
2557 ;; Since we have already gone thru all the items in this menu,
2558 ;; go up to the end of this node.
2560 ;; Since logically we are done with the node with that menu,
2561 ;; move on from it. But don't add intermediate nodes
2562 ;; to the history on recursive calls.
2569 "Go to the last node, popping up a level if there is none."
2573 ;; If we go down a menu item, go to the end of the node
2574 ;; so we can scroll back through it.
2576 ;; Keep going down, as long as there are nested menu nodes.
2579 ;; If we go down a menu item, go to the end of the node
2580 ;; so we can scroll back through it.
2590 ;; If we go down a menu item, go to the end of the node
2591 ;; so we can scroll back through it.
2602 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2603 Once you scroll far enough in a node that its menu appears on the screen
2604 but after point, the next scroll moves into its first subnode, unless
2605 `Info-scroll-prefer-subnodes' is nil.
2607 When you scroll past the end of a node, that goes to the next node if
2608 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2609 if this node has no successor, it moves to the parent node's successor,
2610 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2611 the menu of a node, it moves to subnode indicated by the following menu
2612 item. (That case won't normally result from this command, but can happen
2613 in other ways.)"
2635 "Scroll one screenful forward in Info, using the mouse.
2636 See `Info-scroll-up'."
2644 "Scroll one screenful back in Info, considering all nodes as one sequence.
2645 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2646 is non-nil, this goes to its last subnode. When you scroll past the
2647 beginning of a node, that goes to the previous node or back up to the
2648 parent node."
2662 current-point
2663 t)))))
2670 "Scroll one screenful backward in Info, using the mouse.
2671 See `Info-scroll-down'."
2679 "Move cursor to the next cross-reference or menu item in the node."
2701 "Move cursor to the previous cross-reference or menu item in the node."
2720 \f
2722 "Alist of cached index node names of visited Info files.
2726 "Return a list of names of all index nodes in Info FILE.
2727 If FILE is omitted, it defaults to the current Info file.
2728 First look in a list of cached index node names. Then scan Info
2729 file and its subfiles for nodes with the index cookie. Then try
2730 to find index nodes starting from the first node in the top level
2735 ;; Skip virtual Info files
2740 ;; Find nodes with index cookie
2744 default-directory))
2745 Info-history Info-history-list Info-fontify-maximum-menu-size
2765 subfiles)))))
2767 main-file nil))
2773 nodes)
2774 ;; Else find nodes with the word "Index" in the node name
2776 Info-history Info-history-list Info-fontify-maximum-menu-size
2777 nodes node)
2795 nodes))
2796 ;; If file has no index nodes, still add it to the cache
2801 "Return non-nil value if NODE is an index node.
2802 If NODE is nil, check the current Info node.
2803 If FILE is nil, check the current Info file."
2807 ;; Don't search all index nodes if request is only for the current node
2808 ;; and file is not in the cache of index nodes
2822 "Go to the first index node."
2827 ;;;###autoload
2829 "Look up a string TOPIC in the index for this manual and go to that entry.
2830 If there are no exact matches to the specified topic, this chooses
2831 the first match which is a case-insensitive substring of a topic.
2833 Give an empty topic name to go to the Index node itself."
2849 ;; Strip leading colon in topic; index format does not allow them.
2855 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2864 ;; We bind Info-history to nil for internal node-switches so
2865 ;; that we don't put junk in the history. In the first
2866 ;; Info-goto-index call, above, we do update the history
2867 ;; because that is what the user's previous node choice into it.
2869 found)
2876 Info-current-node
2879 matches))
2886 ;; Here it is a feature that assoc is case-sensitive.
2919 'Info-index-next overriding-local-map
2920 t)))
2924 "Move point to the place within the current node where NAME is defined."
2929 ;; Find a function definition with a return type.
2937 nil t))
2939 ;; Try again without the " <1>" makeinfo can append
2945 ;;;###autoload
2947 "Grovel indices of all known Info files on your system for STRING.
2948 Build a menu of the possible matches."
2951 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2957 manuals matches node nodes)
2960 ;; current-node and current-file are nil when they invoke info-apropos
2961 ;; as the first Info command, i.e. info-apropos loads info.el. In that
2962 ;; case, we use (DIR)Top instead, to avoid signalling an error after
2963 ;; the search is complete.
2971 ;; add-to-list makes sure we don't have duplicates in `manuals',
2972 ;; so that the following dolist loop runs faster.
2989 matches)))
2998 Info-history-list ohist-list)
3019 "Make command be undefined in Info."
3024 "Enter the Info tutorial."
3029 "Help-Small-Screen"
3033 "Display a brief summary of all Info commands."
3048 flag))
3051 \f
3053 "Return the token around POS.
3054 POS must be somewhere inside the token
3055 START is a regular expression which will match the
3056 beginning of the tokens delimited string
3057 ALL is a regular expression with a single
3058 parenthesized subpattern which is the token to be
3059 returned. E.g. '{\(.*\)}' would return any string
3060 enclosed in braces around POS.
3061 ERRORSTRING optional fourth argument, controls action on no match
3062 nil: return nil
3063 t: beep
3064 a string: signal an error, using that string."
3068 ;; First look for a match for START that goes across POS.
3072 ;; If we did not find one, search back for START
3073 ;; (this finds only matches that end at or before POS).
3086 nil)
3089 nil)
3095 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3096 At end of the node's text, moves to the next node, or up if none."
3104 "Follow a node reference near point.
3105 If point is on a reference, follow that reference. Otherwise,
3106 if point is in a menu item description, follow that menu item.
3108 If FORK is non-nil (interactively with a prefix arg), show the node in
3109 a new Info buffer.
3110 If FORK is a string, it is the name to use for the new buffer."
3122 t)))
3125 ;; Common subroutine.
3127 "Follow a node reference near point. Return non-nil if successful.
3128 If FORK is non-nil, it i spassed to `Info-goto-node'."
3137 ;; menu item: node name
3140 ;; menu item: node name or index entry
3154 node))
3155 \f
3166 (define-key map "1" 'Info-nth-menu-item)
3167 (define-key map "2" 'Info-nth-menu-item)
3168 (define-key map "3" 'Info-nth-menu-item)
3169 (define-key map "4" 'Info-nth-menu-item)
3170 (define-key map "5" 'Info-nth-menu-item)
3171 (define-key map "6" 'Info-nth-menu-item)
3172 (define-key map "7" 'Info-nth-menu-item)
3173 (define-key map "8" 'Info-nth-menu-item)
3174 (define-key map "9" 'Info-nth-menu-item)
3175 (define-key map "0" 'undefined)
3176 (define-key map "?" 'Info-summary)
3177 (define-key map "]" 'Info-forward-node)
3178 (define-key map "[" 'Info-backward-node)
3179 (define-key map "<" 'Info-top-node)
3180 (define-key map ">" 'Info-final-node)
3181 (define-key map "b" 'beginning-of-buffer)
3182 (define-key map "d" 'Info-directory)
3183 (define-key map "e" 'Info-edit)
3184 (define-key map "f" 'Info-follow-reference)
3185 (define-key map "g" 'Info-goto-node)
3186 (define-key map "h" 'Info-help)
3187 (define-key map "i" 'Info-index)
3188 (define-key map "l" 'Info-history-back)
3189 (define-key map "L" 'Info-history)
3190 (define-key map "m" 'Info-menu)
3191 (define-key map "n" 'Info-next)
3192 (define-key map "p" 'Info-prev)
3193 (define-key map "q" 'Info-exit)
3194 (define-key map "r" 'Info-history-forward)
3195 (define-key map "s" 'Info-search)
3196 (define-key map "S" 'Info-search-case-sensitively)
3197 ;; For consistency with Rmail.
3198 (define-key map "\M-s" 'Info-search)
3199 (define-key map "\M-n" 'clone-buffer)
3200 (define-key map "t" 'Info-top-node)
3201 (define-key map "T" 'Info-toc)
3202 (define-key map "u" 'Info-up)
3203 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3204 (define-key map "w" 'Info-copy-current-node-name)
3205 (define-key map "c" 'Info-copy-current-node-name)
3206 ;; `^' for consistency with `dired-up-directory'.
3207 (define-key map "^" 'Info-up)
3208 (define-key map "," 'Info-index-next)
3210 (define-key map [mouse-2] 'Info-mouse-follow-nearest-node)
3211 (define-key map [follow-link] 'mouse-face)
3212 map)
3213 "Keymap containing Info commands.")
3216 (defun Info-check-pointer (item)
3217 "Non-nil if ITEM is present in this node."
3218 (condition-case nil
3219 (Info-extract-pointer item)
3220 (error nil)))
3222 (easy-menu-define
3223 Info-mode-menu Info-mode-map
3224 "Menu for Info files."
3225 '("Info"
3226 ["Up" Info-up :active (Info-check-pointer "up")
3227 :help "Go up in the Info tree"]
3228 ["Next" Info-next :active (Info-check-pointer "next")
3229 :help "Go to the next node"]
3230 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3231 :help "Go to the previous node"]
3232 ["Backward" Info-backward-node
3233 :help "Go backward one node, considering all as a sequence"]
3234 ["Forward" Info-forward-node
3235 :help "Go forward one node, considering all as a sequence"]
3236 ["Beginning" beginning-of-buffer
3237 :help "Go to beginning of this node"]
3238 ["Top" Info-top-node
3239 :help "Go to top node of file"]
3240 ["Final Node" Info-final-node
3241 :help "Go to final node in this file"]
3242 ("Menu Item" ["You should never see this" report-emacs-bug t])
3243 ("Reference" ["You should never see this" report-emacs-bug t])
3244 ["Search..." Info-search
3245 :help "Search for regular expression in this Info file"]
3246 ["Search Next" Info-search-next
3247 :help "Search for another occurrence of regular expression"]
3248 ["Go to Node..." Info-goto-node
3249 :help "Go to a named node"]
3250 ["Back in history" Info-history-back :active Info-history
3251 :help "Go back in history to the last node you were at"]
3252 ["Forward in history" Info-history-forward :active Info-history-forward
3253 :help "Go forward in history"]
3254 ["History" Info-history :active Info-history-list
3255 :help "Go to menu of visited nodes"]
3256 ["Table of Contents" Info-toc
3257 :help "Go to table of contents"]
3258 ("Index"
3259 ["Lookup a String..." Info-index
3260 :help "Look for a string in the index items"]
3261 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3262 :help "Look for another occurrence of previous item"]
3263 ["Lookup a string in all indices..." info-apropos
3264 :help "Look for a string in the indices of all manuals"])
3265 ["Copy Node Name" Info-copy-current-node-name
3266 :help "Copy the name of the current node into the kill ring"]
3267 ["Clone Info buffer" clone-buffer
3268 :help "Create a twin copy of the current Info buffer."]
3269 ["Exit" Info-exit :help "Stop reading Info"]))
3272 (defvar info-tool-bar-map
3273 (if (display-graphic-p)
3274 (let ((map (make-sparse-keymap)))
3275 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map
3276 :rtl "right-arrow")
3277 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map
3278 :rtl "left-arrow")
3279 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map
3280 :rtl "next-node")
3281 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map
3282 :rtl "prev-node")
3283 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3284 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3285 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3286 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3287 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3288 (tool-bar-local-item-from-menu 'Info-exit "exit" map Info-mode-map)
3289 map)))
3291 (defvar Info-menu-last-node nil)
3292 ;; Last node the menu was created for.
3293 ;; Value is a list, (FILE-NAME NODE-NAME).
3295 (defun Info-menu-update ()
3296 "Update the Info menu for the current node."
3297 (condition-case nil
3298 (if (or (not (eq major-mode 'Info-mode))
3299 (equal (list Info-current-file Info-current-node)
3300 Info-menu-last-node))
3301 ()
3302 ;; Update menu menu.
3303 (let* ((Info-complete-menu-buffer (current-buffer))
3304 (items (nreverse (condition-case nil
3305 (Info-complete-menu-item "" nil t)
3306 (error nil))))
3307 entries current
3308 (number 0))
3309 (while (and items (< number 9))
3310 (setq current (car items)
3311 items (cdr items)
3312 number (1+ number))
3313 (setq entries (cons `[,current
3314 (Info-menu ,current)
3315 :keys ,(format "%d" number)]
3316 entries)))
3317 (if items
3318 (setq entries (cons ["Other..." Info-menu t] entries)))
3319 (or entries
3320 (setq entries (list ["No menu" nil nil] nil :active)))
3321 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3322 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3323 (let ((items nil)
3324 str i entries current
3325 (number 0)
3326 (case-fold-search t))
3327 (save-excursion
3328 (goto-char (point-min))
3330 (setq str (match-string 1))
3331 (setq i 0)
3333 (setq str (concat (substring str 0 i) " "
3334 (substring str (match-end 0))))
3335 (setq i (1+ i)))
3336 (setq items
3337 (cons str items))))
3338 (while (and items (< number 9))
3339 (setq current (car items)
3340 items (cdr items)
3341 number (1+ number))
3342 (setq entries (cons `[,current
3343 (Info-follow-reference ,current)
3344 t]
3345 entries)))
3346 (if items
3347 (setq entries (cons ["Other..." Info-follow-reference t]
3348 entries)))
3349 (or entries
3350 (setq entries (list ["No references" nil nil] nil :active)))
3351 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3352 ;; Update last seen node.
3353 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3354 ;; Try to avoid entering infinite beep mode in case of errors.
3355 (error (ding))))
3357 \f
3358 (defun Info-copy-current-node-name (&optional arg)
3359 "Put the name of the current Info node into the kill ring.
3360 The name of the Info file is prepended to the node name in parentheses.
3361 With a zero prefix arg, put the name inside a function call to `info'."
3362 (interactive "P")
3363 (unless Info-current-node
3364 (error "No current Info node"))
3365 (let ((node (if (stringp Info-current-file)
3366 (concat "(" (file-name-nondirectory Info-current-file) ") "
3367 Info-current-node))))
3368 (if (zerop (prefix-numeric-value arg))
3370 (unless (stringp Info-current-file)
3371 (setq node (format "(Info-find-node '%S '%S)"
3372 Info-current-file Info-current-node)))
3373 (kill-new node)
3374 (message "%s" node)))
3376 \f
3377 ;; Info mode is suitable only for specially formatted data.
3378 (put 'Info-mode 'mode-class 'special)
3379 (put 'Info-mode 'no-clone-indirect t)
3381 (defvar tool-bar-map)
3382 (defvar bookmark-make-record-function)
3384 ;; Autoload cookie needed by desktop.el
3385 ;;;###autoload
3386 (defun Info-mode ()
3387 "Info mode provides commands for browsing through the Info documentation tree.
3389 one topic and contains references to other nodes which discuss related
3390 topics. Info has commands to follow the references and show you other nodes.
3396 Selecting other nodes:
3398 Follow a node reference you click on.
3399 This works with menu items, cross references, and
3401 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3406 Picking a menu item causes another node to be selected.
3416 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3420 Moving within a node:
3422 Once you scroll far enough in a node that its menu appears on the
3423 screen but after point, the next scroll moves into its first
3424 subnode. When after all menu items (or if there is no menu),
3425 move up to the parent node.
3427 already visible, try to go to the previous menu entry, or up
3428 if there is none.
3431 Advanced commands:
3433 and select the node in which the next occurrence is found.
3434 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3437 \\[isearch-forward], \\[isearch-forward-regexp] Use Isearch to search through multiple Info nodes.
3439 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3442 You may include a filename as well, as (FILENAME)NODENAME.
3443 1 .. 9 Pick first ... ninth item in node's menu.
3444 Every third `*' is highlighted to help pick the right number.
3448 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3449 (kill-all-local-variables)
3450 (setq major-mode 'Info-mode)
3451 (setq mode-name "Info")
3452 (setq tab-width 8)
3453 (use-local-map Info-mode-map)
3454 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3455 (set-syntax-table text-mode-syntax-table)
3456 (setq local-abbrev-table text-mode-abbrev-table)
3457 (setq case-fold-search t)
3458 (setq buffer-read-only t)
3459 (make-local-variable 'Info-current-file)
3460 (make-local-variable 'Info-current-subfile)
3461 (make-local-variable 'Info-current-node)
3462 (make-local-variable 'Info-tag-table-marker)
3463 (setq Info-tag-table-marker (make-marker))
3464 (make-local-variable 'Info-tag-table-buffer)
3465 (setq Info-tag-table-buffer nil)
3466 (make-local-variable 'Info-history)
3467 (make-local-variable 'Info-history-forward)
3468 (make-local-variable 'Info-index-alternatives)
3469 (setq header-line-format
3470 (if Info-use-header-line
3471 '(:eval (get-text-property (point-min) 'header-line))
3472 nil)) ; so the header line isn't displayed
3473 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3474 ;; This is for the sake of the invisible text we use handling titles.
3475 (make-local-variable 'line-move-ignore-invisible)
3476 (setq line-move-ignore-invisible t)
3477 (make-local-variable 'desktop-save-buffer)
3478 (make-local-variable 'widen-automatically)
3479 (setq widen-automatically nil)
3480 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3481 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3482 (add-hook 'clone-buffer-hook 'Info-clone-buffer nil t)
3483 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3484 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3485 (set (make-local-variable 'isearch-search-fun-function)
3486 'Info-isearch-search)
3487 (set (make-local-variable 'isearch-wrap-function)
3488 'Info-isearch-wrap)
3489 (set (make-local-variable 'isearch-push-state-function)
3490 'Info-isearch-push-state)
3491 (set (make-local-variable 'isearch-success-function)
3492 'Info-search-success-function)
3493 (set (make-local-variable 'search-whitespace-regexp)
3494 Info-search-whitespace-regexp)
3495 (set (make-local-variable 'revert-buffer-function)
3496 'Info-revert-buffer-function)
3497 (Info-set-mode-line)
3498 (set (make-local-variable 'bookmark-make-record-function)
3499 'Info-bookmark-make-record)
3500 (run-mode-hooks 'Info-mode-hook))
3502 ;; When an Info buffer is killed, make sure the associated tags buffer
3503 ;; is killed too.
3504 (defun Info-kill-buffer ()
3505 (and (eq major-mode 'Info-mode)
3506 Info-tag-table-buffer
3507 (kill-buffer Info-tag-table-buffer)))
3509 ;; Placed on `clone-buffer-hook'.
3510 (defun Info-clone-buffer ()
3511 (when (bufferp Info-tag-table-buffer)
3512 (setq Info-tag-table-buffer
3513 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3514 (let ((m Info-tag-table-marker))
3515 (when (markerp m)
3516 (setq Info-tag-table-marker
3517 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3518 (with-current-buffer Info-tag-table-buffer
3519 (copy-marker (marker-position m)))
3520 (make-marker))))))
3522 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3523 (set-keymap-parent map text-mode-map)
3524 (define-key map "\C-c\C-c" 'Info-cease-edit)
3525 map)
3526 "Local keymap used within `e' command of Info.")
3528 ;; Info-edit mode is suitable only for specially formatted data.
3529 (put 'Info-edit-mode 'mode-class 'special)
3531 (defun Info-edit-mode ()
3532 "Major mode for editing the contents of an Info node.
3533 Like text mode with the addition of `Info-cease-edit'
3534 which returns to Info mode for browsing.
3536 (use-local-map Info-edit-map)
3537 (setq major-mode 'Info-edit-mode)
3538 (setq mode-name "Info Edit")
3539 (kill-local-variable 'mode-line-buffer-identification)
3540 (setq buffer-read-only nil)
3541 (force-mode-line-update)
3542 (buffer-enable-undo (current-buffer))
3543 (run-mode-hooks 'Info-edit-mode-hook))
3545 (defun Info-edit ()
3546 "Edit the contents of this Info node.
3547 Allowed only if variable `Info-enable-edit' is non-nil."
3548 (interactive)
3549 (or Info-enable-edit
3550 (error "Editing Info nodes is not enabled"))
3551 (Info-edit-mode)
3552 (message "%s" (substitute-command-keys
3555 (defun Info-cease-edit ()
3556 "Finish editing Info node; switch back to Info proper."
3557 (interactive)
3558 ;; Do this first, so nothing has changed if user C-g's at query.
3559 (and (buffer-modified-p)
3560 (y-or-n-p "Save the file? ")
3561 (save-buffer))
3562 (use-local-map Info-mode-map)
3563 (setq major-mode 'Info-mode)
3564 (setq mode-name "Info")
3565 (Info-set-mode-line)
3566 (setq buffer-read-only t)
3567 (force-mode-line-update)
3568 (and (marker-position Info-tag-table-marker)
3569 (buffer-modified-p)
3570 (message "Tags may have changed. Use Info-tagify if necessary")))
3571 \f
3572 (defvar Info-file-list-for-emacs
3573 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3574 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3575 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3576 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3577 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3578 ("copyright" . "autotype") ("executable" . "autotype")
3579 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3580 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3581 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3582 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3583 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3584 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3585 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3586 ("rfc2045" . "emacs-mime")
3587 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3588 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3589 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3590 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3591 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3592 ("mml" . "emacs-mime"))
3593 "List of Info files that describe Emacs commands.
3594 An element can be a file name, or a list of the form (PREFIX . FILE)
3595 where PREFIX is a name prefix and FILE is the file to look in.
3596 If the element is just a file name, the file name also serves as the prefix.")
3598 (defun Info-find-emacs-command-nodes (command)
3599 "Return a list of locations documenting COMMAND.
3600 The `info-file' property of COMMAND says which Info manual to search.
3601 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3602 defines heuristics for which Info manual to try.
3603 The locations are of the format used in `Info-history', i.e.
3604 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3605 in the first element of the returned list (which is treated specially in
3606 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3607 (let ((where '()) line-number
3611 (info-file "emacs")) ;default
3612 ;; Determine which Info file this command is documented in.
3613 (if (get command 'info-file)
3614 (setq info-file (get command 'info-file))
3615 ;; If it doesn't say explicitly, test its name against
3616 ;; various prefixes that we know.
3617 (let ((file-list Info-file-list-for-emacs))
3618 (while file-list
3619 (let* ((elt (car file-list))
3620 (name (if (consp elt)
3621 (car elt)
3622 elt))
3623 (file (if (consp elt) (cdr elt) elt))
3624 (case-fold-search nil)
3627 (if (string-match regexp (symbol-name command))
3628 (setq info-file file file-list nil))
3629 (setq file-list (cdr file-list))))))
3630 (Info-find-node info-file "Top")
3631 ;; Bind Info-history to nil, to prevent the index nodes from
3632 ;; getting into the node history.
3633 (let ((Info-history nil)
3634 (Info-history-list nil)
3635 node (nodes (Info-index-nodes)))
3636 (Info-goto-node (car nodes))
3637 (while
3638 (progn
3639 (goto-char (point-min))
3640 (while (re-search-forward cmd-desc nil t)
3641 (setq where
3642 (cons (list Info-current-file
3643 (match-string-no-properties 2)
3644 0)
3645 where))
3646 (setq line-number (and (match-beginning 3)
3647 (string-to-number (match-string 3)))))
3648 (and (setq nodes (cdr nodes) node (car nodes))))
3649 (Info-goto-node node)))
3650 (if (and line-number where)
3651 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3652 (cdr where))
3653 where)))
3655 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3656 ;;;###autoload
3657 (defun Info-goto-emacs-command-node (command)
3658 "Go to the Info node in the Emacs manual for command COMMAND.
3659 The command is found by looking up in Emacs manual's indices
3660 or in another manual found via COMMAND's `info-file' property or
3661 the variable `Info-file-list-for-emacs'.
3662 COMMAND must be a symbol or string."
3663 (interactive "CFind documentation for command: ")
3664 ;; If command is given as a string, convert it to a symbol.
3665 (if (stringp command)
3666 (setq command (intern command)))
3667 (or (commandp command)
3668 (signal 'wrong-type-argument (list 'commandp command)))
3669 (let ((where (Info-find-emacs-command-nodes command)))
3670 (if where
3671 (let ((num-matches (length where)))
3672 ;; Get Info running, and pop to it in another window.
3673 (save-window-excursion
3674 (info))
3675 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3676 ;; Bind Info-history to nil, to prevent the last Index node
3677 ;; visited by Info-find-emacs-command-nodes from being
3678 ;; pushed onto the history.
3679 (let ((Info-history nil) (Info-history-list nil)
3680 (line-number (nth 2 (car where))))
3681 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3682 (if (and (integerp line-number) (> line-number 0))
3683 (forward-line (1- line-number))))
3684 (if (> num-matches 1)
3685 (progn
3686 ;; (car where) will be pushed onto Info-history
3687 ;; when/if they go to another node. Put the other
3688 ;; nodes that were found on the history.
3689 (setq Info-history (nconc (cdr where) Info-history))
3690 (message "Found %d other entr%s. Use %s to see %s."
3691 (1- num-matches)
3692 (if (> num-matches 2) "ies" "y")
3694 (if (> num-matches 2) "them" "it")))))
3695 (error "Couldn't find documentation for %s" command))))
3697 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3698 ;;;###autoload
3699 (defun Info-goto-emacs-key-command-node (key)
3700 "Go to the node in the Emacs manual which describes the command bound to KEY.
3701 KEY is a string.
3702 Interactively, if the binding is `execute-extended-command', a command is read.
3703 The command is found by looking up in Emacs manual's indices
3704 or in another manual found via COMMAND's `info-file' property or
3705 the variable `Info-file-list-for-emacs'."
3706 (interactive "kFind documentation for key: ")
3707 (let ((command (key-binding key)))
3708 (cond ((null command)
3709 (message "%s is undefined" (key-description key)))
3710 ((and (interactive-p)
3711 (eq command 'execute-extended-command))
3712 (Info-goto-emacs-command-node
3713 (read-command "Find documentation for command: ")))
3714 (t
3715 (Info-goto-emacs-command-node command)))))
3716 \f
3717 (defvar Info-next-link-keymap
3718 (let ((keymap (make-sparse-keymap)))
3719 (define-key keymap [header-line mouse-1] 'Info-next)
3720 (define-key keymap [header-line mouse-2] 'Info-next)
3721 (define-key keymap [header-line down-mouse-1] 'ignore)
3722 (define-key keymap [mouse-2] 'Info-next)
3723 (define-key keymap [follow-link] 'mouse-face)
3724 keymap)
3725 "Keymap to put on the Next link in the text or the header line.")
3727 (defvar Info-prev-link-keymap
3728 (let ((keymap (make-sparse-keymap)))
3729 (define-key keymap [header-line mouse-1] 'Info-prev)
3730 (define-key keymap [header-line mouse-2] 'Info-prev)
3731 (define-key keymap [header-line down-mouse-1] 'ignore)
3732 (define-key keymap [mouse-2] 'Info-prev)
3733 (define-key keymap [follow-link] 'mouse-face)
3734 keymap)
3735 "Keymap to put on the Prev link in the text or the header line.")
3737 (defvar Info-up-link-keymap
3738 (let ((keymap (make-sparse-keymap)))
3739 (define-key keymap [header-line mouse-1] 'Info-up)
3740 (define-key keymap [header-line mouse-2] 'Info-up)
3741 (define-key keymap [header-line down-mouse-1] 'ignore)
3742 (define-key keymap [mouse-2] 'Info-up)
3743 (define-key keymap [follow-link] 'mouse-face)
3744 keymap)
3745 "Keymap to put on the Up link in the text or the header line.")
3747 (defcustom Info-breadcrumbs-depth 4
3748 "Depth of breadcrumbs to display.
3749 0 means do not display breadcrumbs."
3750 :type 'integer)
3752 (defun Info-insert-breadcrumbs ()
3753 (let ((nodes (Info-toc-nodes Info-current-file))
3754 (node Info-current-node)
3755 (crumbs ())
3756 (depth Info-breadcrumbs-depth))
3758 ;; Get ancestors from the cached parent-children node info
3759 (while (and (not (equal "Top" node)) (> depth 0))
3760 (setq node (nth 1 (assoc node nodes)))
3761 (if node (push node crumbs))
3762 (setq depth (1- depth)))
3764 ;; Add bottom node.
3765 (when Info-use-header-line
3766 ;; Let it disappear if crumbs is nil.
3767 (nconc crumbs (list Info-current-node)))
3768 (when (or Info-use-header-line crumbs)
3769 ;; Add top node (and continuation if needed).
3770 (setq crumbs
3771 (cons "Top" (if (member (pop crumbs) '(nil "Top"))
3772 crumbs (cons nil crumbs))))
3773 ;; Eliminate duplicate.
3774 (forward-line 1)
3775 (dolist (node crumbs)
3776 (let ((text
3777 (if (not (equal node "Top")) node
3778 (format "(%s)Top"
3779 (if (stringp Info-current-file)
3780 (file-name-nondirectory Info-current-file)
3781 ;; Can be `toc', `apropos', or even `history'.
3782 Info-current-file)))))
3783 (insert (if (bolp) "" " > ")
3784 (cond
3785 ((null node) "...")
3786 ((equal node Info-current-node)
3787 ;; No point linking to ourselves.
3788 (propertize text 'font-lock-face 'info-header-node))
3789 (t
3790 (concat "*Note " text "::"))))))
3793 (defun Info-fontify-node ()
3794 "Fontify the node."
3795 (save-excursion
3796 (let* ((inhibit-read-only t)
3797 (case-fold-search t)
3798 paragraph-markers
3799 (not-fontified-p ; the node hasn't already been fontified
3800 (not (let ((where (next-single-property-change (point-min)
3801 'font-lock-face)))
3802 (and where (not (= where (point-max)))))))
3803 (fontify-visited-p ; visited nodes need to be re-fontified
3804 (and Info-fontify-visited-nodes
3805 ;; Don't take time to refontify visited nodes in huge nodes
3806 Info-fontify-maximum-menu-size
3807 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3808 rbeg rend)
3810 ;; Fontify header line
3811 (goto-char (point-min))
3813 (goto-char (match-end 0))
3815 (goto-char (match-end 0))
3816 (let* ((nbeg (match-beginning 2))
3817 (nend (match-end 2))
3818 (tbeg (match-beginning 1))
3819 (tag (match-string 1)))
3820 (if (string-equal (downcase tag) "node")
3821 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3822 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3823 (put-text-property tbeg nend 'mouse-face 'highlight)
3824 (put-text-property tbeg nend
3825 'help-echo
3826 (concat "mouse-2: Go to node "
3827 (buffer-substring nbeg nend)))
3828 ;; Always set up the text property keymap.
3829 ;; It will either be used in the buffer
3830 ;; or copied in the header line.
3831 (put-text-property
3832 tbeg nend 'keymap
3833 (cond
3834 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3835 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3836 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3838 (when (> Info-breadcrumbs-depth 0)
3839 (Info-insert-breadcrumbs))
3841 ;; Treat header line.
3842 (when Info-use-header-line
3843 (goto-char (point-min))
3844 (let* ((header-end (line-end-position))
3845 (header
3846 ;; If we find neither Next: nor Prev: link, show the entire
3847 ;; node header. Otherwise, don't show the File: and Node:
3848 ;; parts, to avoid wasting precious space on information that
3849 ;; is available in the mode line.
3850 (if (re-search-forward
3852 header-end t)
3853 (progn
3854 (goto-char (match-beginning 1))
3855 (buffer-substring (point) header-end))
3857 header-end t)
3858 (concat "No next, prev or up links -- "
3859 (buffer-substring (point) header-end))
3860 (buffer-substring (point) header-end)))))
3861 (put-text-property (point-min) (1+ (point-min))
3862 'header-line
3863 (replace-regexp-in-string
3864 "%"
3865 ;; Preserve text properties on duplicated `%'.
3866 (lambda (s) (concat s s)) header))
3867 ;; Hide the part of the first line
3868 ;; that is in the header, if it is just part.
3869 (cond
3870 ((> Info-breadcrumbs-depth 0)
3871 (put-text-property (point-min) (1+ header-end) 'invisible t))
3872 ((not (bobp))
3873 ;; Hide the punctuation at the end, too.
3875 (put-text-property (point) header-end 'invisible t))))))
3877 ;; Fontify titles
3878 (goto-char (point-min))
3879 (when (and font-lock-mode not-fontified-p)
3881 nil t)
3882 ;; Only consider it as an underlined title if the ASCII
3883 ;; underline has the same size as the text. A typical
3884 ;; counter example is when a continuation "..." is alone
3885 ;; on a line.
3886 (= (string-width (match-string 1))
3887 (string-width (match-string 2))))
3888 (let* ((c (preceding-char))
3889 (face
3890 (cond ((= c ?*) 'info-title-1)
3891 ((= c ?=) 'info-title-2)
3892 ((= c ?-) 'info-title-3)
3893 (t 'info-title-4))))
3894 (put-text-property (match-beginning 1) (match-end 1)
3895 'font-lock-face face))
3896 ;; This is a serious problem for trying to handle multiple
3897 ;; frame types at once. We want this text to be invisible
3898 ;; on frames that can display the font above.
3899 (when (memq (framep (selected-frame)) '(x pc w32 ns))
3900 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3901 '(invisible t front-sticky nil rear-nonsticky t)))))
3903 ;; Fontify cross references
3904 (goto-char (point-min))
3905 (when (or not-fontified-p fontify-visited-p)
3906 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3907 (let ((start (match-beginning 0))
3908 (next (point))
3909 other-tag)
3910 (when not-fontified-p
3911 (when Info-hide-note-references
3912 (when (and (not (eq Info-hide-note-references 'hide))
3913 (> (line-number-at-pos) 4)) ; Skip breadcrumbs
3914 ;; *Note is often used where *note should have been
3915 (goto-char start)
3916 (skip-syntax-backward " ")
3917 (when (memq (char-before) '(?\( ?\[ ?\{))
3918 ;; Check whether the paren is preceded by
3919 ;; an end of sentence
3920 (skip-syntax-backward " ("))
3921 (setq other-tag
3923 "")
3925 "")
3926 ((memq (char-before) '(nil ?\. ?! ??))
3927 "See ")
3928 ((save-match-data
3929 (save-excursion
3931 "See ")
3932 (t "see "))))
3933 (goto-char next)
3934 (add-text-properties
3935 (match-beginning 1)
3936 (or (save-match-data
3938 (let ((start1 (match-beginning 1)))
3940 (+ start1 (match-beginning 0)))))
3941 (match-end 1))
3942 (if other-tag
3943 `(display ,other-tag front-sticky nil rear-nonsticky t)
3944 '(invisible t front-sticky nil rear-nonsticky t))))
3945 (add-text-properties
3946 (match-beginning 2) (match-end 2)
3947 (list
3948 'help-echo (if (or (match-end 5)
3949 (not (equal (match-string 4) "")))
3950 (concat "mouse-2: go to " (or (match-string 5)
3951 (match-string 4)))
3952 "mouse-2: go to this node")
3953 'mouse-face 'highlight)))
3954 (when (or not-fontified-p fontify-visited-p)
3955 (setq rbeg (match-beginning 2)
3956 rend (match-end 2))
3957 (put-text-property
3958 rbeg rend
3959 'font-lock-face
3960 ;; Display visited nodes in a different face
3961 (if (and Info-fontify-visited-nodes
3962 (save-match-data
3963 (let* ((node (replace-regexp-in-string
3965 (replace-regexp-in-string
3967 (or (match-string-no-properties 5)
3968 (and (not (equal (match-string 4) ""))
3969 (match-string-no-properties 4))
3970 (match-string-no-properties 2)))))
3971 (external-link-p
3973 (file (if external-link-p
3974 (file-name-nondirectory
3975 (match-string-no-properties 1 node))
3976 Info-current-file))
3977 (hl Info-history-list)
3978 res)
3979 (if external-link-p
3980 (setq node (if (equal (match-string 2 node) "")
3981 "Top"
3982 (match-string-no-properties 2 node))))
3983 (while hl
3984 (if (and (string-equal node (nth 1 (car hl)))
3985 (equal file
3986 (if (and external-link-p
3987 (stringp (caar hl)))
3988 (file-name-nondirectory
3989 (caar hl))
3990 (caar hl))))
3991 (setq res (car hl) hl nil)
3992 (setq hl (cdr hl))))
3993 res))) 'info-xref-visited 'info-xref))
3994 ;; For multiline ref, unfontify newline and surrounding whitespace
3995 (save-excursion
3996 (goto-char rbeg)
3997 (save-match-data
3999 (remove-text-properties (match-beginning 0)
4000 (match-end 0)
4001 '(font-lock-face t))))))
4002 (when not-fontified-p
4003 (when (memq Info-hide-note-references '(t hide))
4004 (add-text-properties (match-beginning 3) (match-end 3)
4005 '(invisible t front-sticky nil rear-nonsticky t))
4006 ;; Unhide the file name of the external reference in parens
4007 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
4008 (remove-text-properties (match-beginning 6) (match-end 6)
4009 '(invisible t front-sticky nil rear-nonsticky t)))
4010 ;; Unhide newline because hidden newlines cause too long lines
4011 (save-match-data
4012 (let ((beg3 (match-beginning 3))
4013 (end3 (match-end 3)))
4015 (not (save-match-data
4016 (save-excursion
4017 (goto-char (1+ end3))
4018 (looking-at "[.)]*$")))))
4019 (remove-text-properties (+ beg3 (match-beginning 0))
4020 (+ beg3 (match-end 0))
4021 '(invisible t front-sticky nil rear-nonsticky t))))))
4022 (when (and Info-refill-paragraphs Info-hide-note-references)
4023 (push (set-marker (make-marker) start)
4024 paragraph-markers))))))
4026 ;; Refill paragraphs (experimental feature)
4027 (when (and not-fontified-p
4028 Info-refill-paragraphs
4029 paragraph-markers)
4030 (let ((fill-nobreak-invisible t)
4031 (fill-individual-varying-indent nil)
4034 (adaptive-fill-mode nil))
4035 (goto-char (point-max))
4036 (dolist (m paragraph-markers)
4037 (when (< m (point))
4038 (goto-char m)
4039 (beginning-of-line)
4040 (let ((beg (point)))
4041 (when (zerop (forward-paragraph))
4042 (fill-individual-paragraphs beg (point) nil nil)
4043 (goto-char beg))))
4044 (set-marker m nil))))
4046 ;; Fontify menu items
4047 (goto-char (point-min))
4048 (when (and (or not-fontified-p fontify-visited-p)
4050 ;; Don't take time to annotate huge menus
4051 Info-fontify-maximum-menu-size
4052 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
4053 (let ((n 0)
4054 cont)
4055 (while (re-search-forward
4058 nil t)
4059 (when (match-beginning 1)
4060 (when not-fontified-p
4061 (setq n (1+ n))
4062 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
4063 (put-text-property (match-beginning 0)
4064 (1+ (match-beginning 0))
4065 'font-lock-face 'info-menu-star)))
4066 (when not-fontified-p
4067 (add-text-properties
4068 (match-beginning 1) (match-end 1)
4069 (list
4070 'help-echo (if (and (match-end 3)
4071 (not (equal (match-string 3) "")))
4072 (concat "mouse-2: go to " (match-string 3))
4073 "mouse-2: go to this node")
4074 'mouse-face 'highlight)))
4075 (when (or not-fontified-p fontify-visited-p)
4076 (put-text-property
4077 (match-beginning 1) (match-end 1)
4078 'font-lock-face
4079 ;; Display visited menu items in a different face
4080 (if (and Info-fontify-visited-nodes
4081 (save-match-data
4082 (let* ((node (if (equal (match-string 3) "")
4083 (match-string-no-properties 1)
4084 (match-string-no-properties 3)))
4085 (external-link-p
4087 (file (if external-link-p
4088 (file-name-nondirectory
4089 (match-string-no-properties 1 node))
4090 Info-current-file))
4091 (hl Info-history-list)
4092 res)
4093 (if external-link-p
4094 (setq node (if (equal (match-string 2 node) "")
4095 "Top"
4096 (match-string-no-properties 2 node))))
4097 (while hl
4098 (if (and (string-equal node (nth 1 (car hl)))
4099 (equal file
4100 (if (and external-link-p
4101 (stringp (caar hl)))
4102 (file-name-nondirectory
4103 (caar hl))
4104 (caar hl))))
4105 (setq res (car hl) hl nil)
4106 (setq hl (cdr hl))))
4107 res))) 'info-xref-visited 'info-xref)))
4108 (when (and not-fontified-p
4109 (memq Info-hide-note-references '(t hide))
4110 (not (Info-index-node)))
4111 (put-text-property (match-beginning 2) (1- (match-end 6))
4112 'invisible t)
4113 ;; Unhide the file name in parens
4114 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
4115 (remove-text-properties (match-beginning 4) (match-end 4)
4116 '(invisible t)))
4117 ;; We need a stretchable space like :align-to but with
4118 ;; a minimum value.
4119 (put-text-property (1- (match-end 6)) (match-end 6) 'display
4120 (if (>= 22 (- (match-end 1)
4121 (match-beginning 0)))
4122 '(space :align-to 24)
4123 '(space :width 2)))
4124 (setq cont (looking-at "."))
4125 (while (and (= (forward-line 1) 0)
4127 (put-text-property (match-beginning 1) (1- (match-end 1))
4128 'invisible t)
4129 (put-text-property (1- (match-end 1)) (match-end 1)
4130 'display
4131 (if cont
4132 '(space :align-to 26)
4133 '(space :align-to 24)))
4134 (setq cont t)))))))
4136 ;; Fontify menu headers
4137 ;; Add the face `info-menu-header' to any header before a menu entry
4138 (goto-char (point-min))
4140 (put-text-property (match-beginning 0) (match-end 0)
4141 'font-lock-face 'info-menu-header)
4143 (put-text-property (match-beginning 1) (match-end 1)
4144 'font-lock-face 'info-menu-header)))
4146 ;; Hide index line numbers
4147 (goto-char (point-min))
4148 (when (and not-fontified-p (Info-index-node))
4150 (put-text-property (match-beginning 0) (match-end 0)
4151 'invisible t)))
4153 ;; Fontify http and ftp references
4154 (goto-char (point-min))
4155 (when not-fontified-p
4157 nil t)
4158 (add-text-properties (match-beginning 0) (match-end 0)
4159 '(font-lock-face info-xref
4160 mouse-face highlight
4161 help-echo "mouse-2: go to this URL"))))
4163 (set-buffer-modified-p nil))))
4164 \f
4165 ;;; Speedbar support:
4166 ;; These functions permit speedbar to display the "tags" in the
4167 ;; current Info node.
4168 (eval-when-compile (require 'speedbar))
4170 (defvar Info-speedbar-key-map nil
4171 "Keymap used when in the info display mode.")
4173 (defun Info-install-speedbar-variables ()
4174 "Install those variables used by speedbar to enhance Info."
4175 (if Info-speedbar-key-map
4176 nil
4177 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4179 ;; Basic tree features
4180 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4181 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4182 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4183 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4184 )
4186 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4187 Info-speedbar-key-map
4188 Info-speedbar-hierarchy-buttons)))
4190 (defvar Info-speedbar-menu-items
4191 '(["Browse Node" speedbar-edit-line t]
4192 ["Expand Node" speedbar-expand-line
4193 (save-excursion (beginning-of-line)
4195 ["Contract Node" speedbar-contract-line
4196 (save-excursion (beginning-of-line)
4197 (looking-at "[0-9]+: *.-. "))]
4198 )
4199 "Additional menu-items to add to speedbar frame.")
4201 ;; Make sure our special speedbar major mode is loaded
4202 (if (featurep 'speedbar)
4203 (Info-install-speedbar-variables)
4204 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4206 ;;; Info hierarchy display method
4207 ;;;###autoload
4208 (defun Info-speedbar-browser ()
4209 "Initialize speedbar to display an Info node browser.
4210 This will add a speedbar major display mode."
4211 (interactive)
4212 (require 'speedbar)
4213 ;; Make sure that speedbar is active
4214 (speedbar-frame-mode 1)
4215 ;; Now, throw us into Info mode on speedbar.
4216 (speedbar-change-initial-expansion-list "Info")
4217 )
4219 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4220 "Display an Info directory hierarchy in speedbar.
4221 DIRECTORY is the current directory in the attached frame.
4222 DEPTH is the current indentation depth.
4223 NODE is an optional argument that is used to represent the
4224 specific node to expand."
4225 (if (and (not node)
4226 (save-excursion (goto-char (point-min))
4227 (let ((case-fold-search t))
4228 (looking-at "Info Nodes:"))))
4229 ;; Update our "current node" maybe?
4230 nil
4231 ;; We cannot use the generic list code, that depends on all leaves
4232 ;; being known at creation time.
4233 (if (not node)
4235 (let ((completions nil))
4236 (speedbar-select-attached-frame)
4237 (save-window-excursion
4238 (setq completions
4239 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4240 (select-frame (speedbar-current-frame))
4241 (if completions
4242 (speedbar-with-writable
4243 (dolist (completion completions)
4244 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4245 (cdr completion)
4246 (car completion)
4247 'Info-speedbar-goto-node
4248 (cdr completion)
4249 'info-xref depth))
4250 t)
4251 nil))))
4253 (defun Info-speedbar-goto-node (text node indent)
4254 "When user clicks on TEXT, go to an info NODE.
4255 The INDENT level is ignored."
4256 (speedbar-select-attached-frame)
4257 (let* ((buff (or (get-buffer "*info*")
4258 (progn (info) (get-buffer "*info*"))))
4259 (bwin (get-buffer-window buff 0)))
4260 (if bwin
4261 (progn
4262 (select-window bwin)
4263 (raise-frame (window-frame bwin)))
4264 (if speedbar-power-click
4265 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4266 (speedbar-select-attached-frame)
4267 (switch-to-buffer buff)))
4269 (error "Invalid node %s" node)
4270 (Info-find-node (match-string 1 node) (match-string 2 node))
4271 ;; If we do a find-node, and we were in info mode, restore
4272 ;; the old default method. Once we are in info mode, it makes
4273 ;; sense to return to whatever method the user was using before.
4274 (if (string= speedbar-initial-expansion-list-name "Info")
4275 (speedbar-change-initial-expansion-list
4276 speedbar-previously-used-expansion-list-name)))))
4278 (defun Info-speedbar-expand-node (text token indent)
4279 "Expand the node the user clicked on.
4280 TEXT is the text of the button we clicked on, a + or - item.
4281 TOKEN is data related to this node (NAME . FILE).
4282 INDENT is the current indentation depth."
4283 (cond ((string-match "+" text) ;we have to expand this file
4284 (speedbar-change-expand-button-char ?-)
4285 (if (speedbar-with-writable
4286 (save-excursion
4287 (end-of-line) (forward-char 1)
4288 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4289 (speedbar-change-expand-button-char ?-)
4290 (speedbar-change-expand-button-char ??)))
4291 ((string-match "-" text) ;we have to contract this node
4292 (speedbar-change-expand-button-char ?+)
4293 (speedbar-delete-subblock indent))
4294 (t (error "Ooops... not sure what to do")))
4295 (speedbar-center-buffer-smartly))
4297 (defun Info-speedbar-fetch-file-nodes (nodespec)
4298 "Fetch the subnodes from the info NODESPEC.
4299 NODESPEC is a string of the form: (file)node."
4300 ;; Set up a buffer we can use to fake-out Info.
4301 (with-current-buffer (get-buffer-create " *info-browse-tmp*")
4302 (if (not (equal major-mode 'Info-mode))
4303 (Info-mode))
4304 ;; Get the node into this buffer
4306 (error "Invalid node specification %s" nodespec)
4307 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4308 ;; Scan the created buffer
4309 (goto-char (point-min))
4310 (let ((completions nil)
4311 (case-fold-search t)
4313 (match-string 1 nodespec))))
4314 ;; Always skip the first one...
4317 (let ((name (match-string 1)))
4318 (push (cons name
4320 (match-string 1)
4322 (concat (match-string 1) "Top")
4323 (concat "(" thisfile ")"
4325 (match-string 1)
4326 name)))))
4327 completions)))
4328 (nreverse completions))))
4330 ;;; Info mode node listing
4331 ;; This is called by `speedbar-add-localized-speedbar-support'
4332 (defun Info-speedbar-buttons (buffer)
4333 "Create a speedbar display to help navigation in an Info file.
4334 BUFFER is the buffer speedbar is requesting buttons for."
4335 (if (save-excursion (goto-char (point-min))
4336 (let ((case-fold-search t))
4337 (not (looking-at "Info Nodes:"))))
4338 (erase-buffer))
4339 (Info-speedbar-hierarchy-buttons nil 0))
4341 (dolist (mess '("^First node in file$"
4342 "^No `.*' in index$"
4343 "^No cross-reference named"
4344 "^No cross.references in this node$"
4345 "^No current Info node$"
4346 "^No menu in this node$"
4347 "^No more items in menu$"
4348 "^No more nodes$"
4350 "^No previous `i' command$"
4351 "^No previous items in menu$"
4352 "^No previous nodes$"
4353 "^No such item in menu$"
4354 "^No such node or anchor"
4355 "^Node has no"
4356 "^Point neither on reference nor in menu item description$"
4358 search-failed))
4359 (add-to-list 'debug-ignored-errors mess))
4361 ;;;; Desktop support
4363 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4364 "Auxiliary information to be saved in desktop file."
4365 (unless (member Info-current-file '(apropos history toc nil))
4366 (list Info-current-file Info-current-node)))
4368 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4369 desktop-buffer-name
4370 desktop-buffer-misc)
4371 "Restore an Info buffer specified in a desktop file."
4372 (let ((first (nth 0 desktop-buffer-misc))
4373 (second (nth 1 desktop-buffer-misc)))
4374 (when (and first second)
4375 (when desktop-buffer-name
4376 (set-buffer (get-buffer-create desktop-buffer-name))
4377 (Info-mode))
4378 (Info-find-node first second)
4379 (current-buffer))))
4381 (add-to-list 'desktop-buffer-mode-handlers
4382 '(Info-mode . Info-restore-desktop-buffer))
4384 ;;;; Bookmark support
4385 (declare-function bookmark-make-record-default "bookmark" (&optional pos-only))
4386 (declare-function bookmark-prop-get "bookmark" (bookmark prop))
4387 (declare-function bookmark-default-handler "bookmark" (bmk))
4388 (declare-function bookmark-get-bookmark-record "bookmark" (bmk))
4390 (defun Info-bookmark-make-record ()
4391 `(,Info-current-node
4392 ,@(bookmark-make-record-default 'point-only)
4393 (filename . ,Info-current-file)
4394 (info-node . ,Info-current-node)
4395 (handler . Info-bookmark-jump)))
4397 ;;;###autoload
4398 (defun Info-bookmark-jump (bmk)
4399 ;; This implements the `handler' function interface for record type returned
4400 ;; by `Info-bookmark-make-record', which see.
4401 (let* ((file (bookmark-prop-get bmk 'filename))
4402 (info-node (bookmark-prop-get bmk 'info-node))
4403 (buf (save-window-excursion ;FIXME: doesn't work with frames!
4404 (Info-find-node file info-node) (current-buffer))))
4405 ;; Use bookmark-default-handler to move to the appropriate location
4406 ;; within the node.
4407 (bookmark-default-handler
4408 (list* "" `(buffer . ,buf) (bookmark-get-bookmark-record bmk)))))
4410 (provide 'info)
4412 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4413 ;;; info.el ends here