| blob | e3514fb972902f1fd2270681160365e75b292a42 |
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 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."
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 "../info/"
467 invocation-directory)))
469 infodir
471 "../../../info/"
472 invocation-directory))
474 infodir))))))
475 alternative)
478 ;; Uninstalled, Emacs builddir != srcdir.
479 sibling
480 ;; Uninstalled, builddir == srcdir
481 source))
483 ;; On DOS/NT, we use movable executables always,
484 ;; and we must always find the Info dir at run time.
486 nil
487 ;; Use invocation-directory for Info
488 ;; only if we used it for exec-directory also.
491 installation-directory))))
493 Info-default-directory-list
494 ;; `alternative' contains the Info files that came with this
495 ;; version, so we should look there first. `Info-insert-dir'
496 ;; currently expects to find `alternative' first on the list.
498 ;; Don't drop the last part, it might contain non-Emacs stuff.
499 ;; (reverse (cdr (reverse
503 "Initialize `Info-directory-list', if that hasn't been done yet."
516 ;;;###autoload
518 "Like `info' but show the Info buffer in another window."
524 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
526 ;;;###autoload (put 'info 'info-file "emacs")
527 ;;;###autoload
529 "Enter Info, the documentation browser.
530 Optional argument FILE-OR-NODE specifies the file to examine;
531 the default is the top-level directory of Info.
532 Called from a program, FILE-OR-NODE may specify an Info node of the form
533 `(FILENAME)NODENAME'.
534 Optional argument BUFFER specifies the Info buffer name;
535 the default buffer name is *info*. If BUFFER exists,
536 just switch to BUFFER. Otherwise, create a new buffer
537 with the top-level Info directory.
539 In interactive use, a non-numeric prefix argument directs
540 this command to read a file name from the minibuffer.
541 A numeric prefix argument selects an Info buffer with the prefix number
542 appended to the Info buffer name.
544 The search path for Info files is in the variable `Info-directory-list'.
545 The top-level Info directory is made by combining all the files named `dir'
546 in all the directories in that path."
556 ;; If argument already contains parentheses, don't add another set
557 ;; since the argument will then be parsed improperly. This also
558 ;; has the added benefit of allowing node names to be included
559 ;; following the parenthesized filename.
562 file-or-node
566 ;; If we just created the Info buffer, go to the directory.
569 ;;;###autoload
571 "Display the Emacs manual in Info mode."
575 ;;;###autoload
577 "Run Emacs as a standalone Info reader.
578 Usage: emacs -f info-standalone [filename]
592 \f
593 ;; See if the accessible portion of the buffer begins with a node
594 ;; delimiter, and the node header line which follows matches REGEXP.
595 ;; Typically, this test will be followed by a loop that examines the
596 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
597 ;; to have the overhead of this special test inside the loop.
599 ;; This function changes match-data, but supposedly the caller might
600 ;; want to use the results of re-search-backward.
602 ;; The return value is the value of point at the beginning of matching
603 ;; REGEXP, if the function succeeds, nil otherwise.
615 Optional second argument NOERROR, if t, means if file is not found
616 just return nil (no error)."
617 ;; Convert filename to lower case if not found as specified.
618 ;; Expand it.
633 ;; If specified name starts with `./'
634 ;; then just try current directory.
637 ;; No point in searching for an
638 ;; absolute file name
642 Info-additional-directory-list)
643 Info-directory-list)))))
644 ;; Search the directory list for file FILENAME.
649 ;; Try several variants of specified name.
653 t)))
664 lfn
676 filename)))
679 "Go to an Info node specified as separate FILENAME and NODENAME.
680 NO-GOING-BACK is non-nil if recovering from an error in this function;
681 it says do not attempt further (recursive) error recovery."
684 ;; Go into Info buffer.
686 ;; Record the node we are leaving, if we were in one.
688 Info-current-file
691 Info-history)))
694 ;;;###autoload
696 "Use Info mode to browse the current Info buffer.
697 With a prefix arg, this queries for the node name to visit first;
698 otherwise, that defaults to `Top'."
708 ;; If called on a non-file buffer, make a fake file name.
712 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
713 ;; but at least it keeps this routine (which is only for the benefit of
714 ;; makeinfo-buffer) out of the way of normal operations.
715 ;;
717 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
718 When *info* is already displaying FILENAME and NODENAME, the window position
719 is preserved, if possible."
735 ;; note goto-line is no good, we want to measure from point-min
742 ;; only add to the history when coming from a different file+node
747 "Find a node in a tag table.
748 MARKER specifies the buffer and position to start searching at.
749 REGEXP is a regular expression matching nodes or references. Its first
750 group should match `Node:' or `Ref:'.
751 CASE-FOLD t means search for a case-insensitive match.
752 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
753 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
754 where the match was found, and MODE is `major-mode' of the buffer in
755 which the match was found."
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.
898 ))
899 ;; Use string-equal, not equal, to ignore text props.
903 ;; Possibilities:
904 ;;
905 ;; 1. Anchor found in tag table
906 ;; 2. Anchor *not* in tag table
907 ;;
908 ;; 3. Node found in tag table
909 ;; 4. Node *not* found in tag table, but found in file
910 ;; 5. Node *not* in tag table, and *not* in file
911 ;;
912 ;; *Or* the same, but in an indirect subfile.
914 ;; Search file for a suitable node.
924 ;; First, search a tag table, if any
930 ;; FOUND is (ANCHOR POS MODE).
933 ;; If this is an indirect file, determine which
934 ;; file really holds this node and read it in.
936 ;; Note that the current buffer must be the
937 ;; *info* buffer on entry to
938 ;; Info-read-subfile. Thus the hackery above.
941 ;; Handle anchor
946 ;; Else we may have a node, which we search for:
950 ;; Now search from our advised position (or from beg of
951 ;; buffer) to find the actual node. First, check
952 ;; whether the node is right where we are, in case the
953 ;; buffer begins with a node.
966 ;; No such anchor in tag table or node in tag table or file
974 ;; Add anchors to the history too
985 ;; If we did not finish finding the specified node,
986 ;; go back to the previous one.
993 ;; Cache the contents of the (virtual) dir file, once we have merged
994 ;; it for the first time, so we can save time subsequently.
997 ;; Cache for the directory we decided to use for the default-directory
998 ;; of the merged dir text.
1001 ;; Record the file attributes of all the files from which we
1002 ;; constructed Info-dir-contents.
1007 ;; Construct the Info directory node by merging the files named `dir'
1008 ;; from various directories. Set the *info* buffer's
1009 ;; default-directory to the first directory we actually get any text
1010 ;; from.
1013 ;; Verify that none of the files we used has changed
1014 ;; since we used it.
1018 ;; Handle symlinks
1021 ;; Don't compare the access time.
1025 Info-dir-file-attributes))))
1031 Info-additional-directory-list)
1032 Info-directory-list))
1034 ;; Bind this in case the user sets it to nil.
1036 ;; This is set non-nil if we find a problem in some input files.
1037 problems
1038 buffers buffer others nodes dirs-done)
1040 ;; Search the directory list for the directory file.
1045 ;; Try several variants of specified name.
1046 ;; Try upcasing, appending `.info', or both.
1061 dirs-done)))
1071 file)
1083 ;; Distinguish the dir file that comes with Emacs from all the
1084 ;; others. Yes, that is really what this is supposed to do.
1085 ;; The definition of `Info-directory-list' puts it first on that
1086 ;; list and so last in `buffers' at this point.
1090 ;; Insert the entire original dir file as a start; note that we've
1091 ;; already saved its default directory to use as the default
1092 ;; directory for the whole concatenation.
1095 ;; Look at each of the other buffers one by one.
1098 ;; In each, find all the menus.
1101 ;; Find each menu, and add an elt to NODES for it.
1105 nodename end)
1117 ;; Add to the main menu a menu item for each other node.
1129 end t)
1133 ;; Now take each node of each of the other buffers
1134 ;; and merge it into the main buffer.
1139 ;; Find the like-named node in the main buffer.
1143 nil t)
1148 ;; If none exists, add one.
1151 ;; Merge the text from the other buffer's menu
1152 ;; into the menu in the like-named node in the main buffer.
1155 ;; Kill all the buffers we just made, including the special one excised.
1175 ;; Remove duplicate headings in the same menu.
1178 ;; Look for the next heading to unify.
1183 ;; Check whether this heading should be streamlined.
1193 ;; Look for other headings of the same category and merge them.
1199 ;; Delete redundant heading.
1201 ;; Push the entries onto `text'.
1208 ;; Insert the entries just found.
1216 ;; Now remove duplicate entries under the same heading.
1222 ;; Fold case straight away; `member-ignore-case' here wasteful.
1230 ;; Note that on entry to this function the current-buffer must be the
1231 ;; *info* buffer; not the info tags buffer.
1233 ;; NODEPOS is either a position (in the Info file as a whole,
1234 ;; not relative to a subfile) or the name of a subfile.
1236 lastfilename)
1248 thisfilepos thisfilename)
1252 ;; read in version 19 stops at the end of number.
1253 ;; Advance to the next line.
1262 ;; Assume previous buffer is in Info-mode.
1263 ;; (set-buffer (get-buffer "*info*"))
1272 ;; Widen in case we are in the same subfile as before.
1282 "Unescape double quotes and backslashes in VALUE."
1288 unquote))
1290 ;; As of Texinfo 4.6, makeinfo writes constructs like
1291 ;; \0\h[image param=value ...\h\0]
1292 ;; into the Info file for handling images.
1295 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1296 whitespace or double quotes, it must be quoted in double quotes and
1301 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1302 parameter-string start)
1308 parameter-alist))
1309 parameter-alist))
1312 "Display images in current node."
1319 nil t)
1334 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1335 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1336 ;; including one optional trailing newline.
1338 "Hide unrecognized cookies in current node."
1345 nil t)
1352 "Select the Info node that point is in."
1353 ;; Bind this in case the user sets it to nil.
1356 ;; Find beginning of node.
1362 ;; Get nodename spelled as it is in the node.
1370 ;; Find the end of it, and narrow.
1373 ;; Narrow to the node contents
1385 ;; Add a new unique history item to full history list
1400 map)
1408 " ("
1413 ") "
1418 'help-echo
1419 "mouse-1: scroll forward, mouse-3: scroll back"
1423 \f
1424 ;; Go to an Info node specified with a filename-and-nodename string
1425 ;; of the sort that is found in pointers in nodes.
1427 ;; Don't autoload this function: the correct entry point for other packages
1428 ;; to use is `info'. --Stef
1429 ;; ;;;###autoload
1431 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1432 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1433 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1434 its sub-files).
1435 Completion is available, but only for node names in the current Info file.
1436 If FORK is non-nil (interactively with a prefix arg), show the node in
1437 a new Info buffer.
1438 If FORK is a string, it is the name to use for the new buffer."
1446 nodename)
1448 ""
1462 "Virtual completion table for file names input in Info node names.
1463 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
1479 ;; If the file name has no suffix or a standard suffix,
1480 ;; include it.
1483 ;; But exclude subfiles of split Info files.
1485 ;; And exclude backup files.
1488 ;; If the file name ends in a standard suffix,
1489 ;; add the unsuffixed name as a completion option.
1498 ;; This function is used as the "completion table" while reading a node name.
1499 ;; It does completion using the alist in Info-read-node-completion-table
1500 ;; unless STRING starts with an open-paren.
1503 ;; First complete embedded file names.
1519 ;; If a file name was given, then any node is fair game.
1525 ;; Otherwise use Info-read-node-completion-table.
1533 ;; Arrange to highlight the proper letters in the completion list buffer.
1539 1
1549 nodename)))
1554 ;; Bind this in case the user sets it to nil.
1567 compl))))
1570 ;; If the buffer begins with a node header, process that first.
1573 ;; Now for the rest of the nodes.
1581 compl))))))))
1584 \f
1586 "If this node has been visited, restore the point value when we left."
1589 ;; Use string-equal, not equal, to ignore text props.
1595 \f
1603 "Search for REGEXP, starting from point, and select node it's found in.
1604 If DIRECTION is `backward', search in the reverse direction."
1632 ;; Hide Info file header for backward search
1644 ;; Skip node header line
1648 ;; Skip Tag Table node
1667 ;; If no subfiles, give error now.
1681 ;; Try other subfiles.
1692 ;; Find the subfile we just searched.
1694 ;; Skip that one.
1697 ;; Make a list of all following subfiles.
1698 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1707 list))
1711 ;; Put in forward order
1717 ;; Hide Info file header for backward search
1732 ;; Skip node header line
1736 ;; Skip Tag Table node
1763 ;; Search landed in the same node
1769 ;; Use string-equal, not equal, to ignore text props.
1775 Info-history))))))
1778 "Search for a regexp case-sensitively."
1784 "Search for next regexp from a previous `Info-search' command."
1792 "Search for REGEXP in the reverse direction."
1811 nil t)
1813 bound noerror count
1816 bound noerror count
1843 \f
1845 "Extract the value of the node-pointer named NAME.
1846 If there is none, use ERRORNAME in the error message;
1847 if ERRORNAME is nil, just return nil."
1848 ;; Bind this in case the user sets it to nil.
1862 "Return a regexp matching a node name.
1863 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1864 saying which chars may appear in the node name.
1865 Submatch 1 is the complete node name.
1866 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1867 Submatch 3 is the local part of the node name.
1868 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1875 ;;; For compatibility; other files have used this name.
1881 "Go to the next node of this node."
1883 ;; In case another window is currently selected
1889 "Go to the previous node of this node."
1891 ;; In case another window is currently selected
1897 "Go to the superior node of this node.
1898 If SAME-FILE is non-nil, do not move to a different Info file."
1900 ;; In case another window is currently selected
1918 nil t))
1924 "Go back in the history to the last node visited."
1930 Info-history-forward))
1931 filename nodename opoint)
1944 "Go forward in the history of visited nodes."
1949 filename nodename opoint)
1957 ;;;###autoload
1959 "Go to the Info directory node."
1962 \f
1964 "Go to a node with a menu of visited nodes."
1968 p)
1992 "Go to a node with table of contents of the current Info file.
1993 Table of contents is created from the tree structure of menus."
1997 p)
2027 "Insert table of contents with references to nodes."
2039 "Build table of contents from menus of Info FILE and its subfiles."
2044 default-directory))
2047 nodes subfiles)
2059 menu-items)
2068 bound))
2071 ;; Menu item line
2081 ;; Other non-empty strings in the Top node are section names
2090 nodes))
2099 subfiles)))))
2101 main-file nil))
2105 \f
2107 "Follow cross reference named FOOTNOTENAME to the node it refers to.
2108 FOOTNOTENAME may be an abbreviation of the reference name.
2109 If FORK is non-nil (interactively with a prefix arg), show the node in
2110 a new Info buffer. If FORK is a string, it is the name to use for the
2111 new buffer."
2117 ;; Store end and beginning of line.
2126 ;; See if this one should be the default.
2131 ;; See if this one should be the alternate default.
2141 ;; Record as a completion and perhaps as default.
2144 ;; Don't add this string if it's a duplicate.
2147 ;; If no good default was found, try an alternate.
2150 ;; If only one cross-reference found, then make it default.
2156 "Follow reference named (default "
2159 completions nil t)))
2173 ;; Move point to the beginning of reference if point is on reference
2183 ;; Go to the reference closest to point
2191 next-ref prev-ref))
2202 ;; We allow newline because this is also used in Info-follow-reference,
2203 ;; where the xref name might be wrapped over two lines.
2204 "Regexp that matches a menu entry name upto but not including the colon.
2205 Because of ambiguities, this should be concatenated with something like
2225 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2226 ;;; (setq Info-point-loc
2227 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2228 )
2232 ;; If the node name is the menu entry name (using `entry::').
2235 ;; No one calls this.
2236 ;;(defun Info-menu-item-sequence (list)
2237 ;; (while list
2238 ;; (Info-menu (car list))
2239 ;; (setq list (cdr list))))
2251 ;; This uses two dynamically bound variables:
2252 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2253 ;; is the menu of items we're trying to complete.
2254 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2255 ;; also look for menu items in subsequent nodes as long as those
2256 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2257 ;; not used.
2258 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2259 ;; also look for menu items in these nodes. This feature is currently
2260 ;; only used for completion in Info-index.
2262 ;; Note that `Info-complete-menu-buffer' could be current already,
2263 ;; so we want to save point.
2269 nextnode)
2278 completions
2280 ;; Check the cache.
2288 ;; We can reuse the previous list.
2290 ;; The cache can't be used.
2295 completions))
2296 ;; Check subsequent nodes if applicable.
2304 ;; Go back to the start node (for the next completion).
2307 ;; Update the cache.
2310 Info-complete-next-re string completions
2311 Info-complete-nodes)))
2318 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2319 The menu item should one of those listed in the current node's menu.
2320 Completion is allowed, and the default menu item is the one point is on.
2321 If FORK is non-nil (interactively with a prefix arg), show the node in
2322 a new Info buffer. If FORK is a string, it is the name to use for the
2323 new buffer."
2326 ;; If point is within a menu item, use that item as the default
2329 beg
2342 Info-menu-entry-name-re
2351 default)
2354 ;; we rely on the fact that completing-read accepts an input
2355 ;; of "" even when the require-match argument is true and ""
2356 ;; is not a valid possibility
2360 ;; ask again
2363 ;; there is a problem here in that if several menu items have the same
2364 ;; name you can only go to the node of the first with this command.
2382 ;; If COUNT is nil, use the last item in the menu.
2394 nil))
2398 "Go to the node of the Nth menu item.
2399 N is the digit argument used to invoke this command."
2406 "Go to the Top node of this file."
2411 "Go to the final node in this file."
2416 ;; Go to the last node in the menu of Top.
2418 ;; If the last node in the menu is not last in pointer structure,
2419 ;; move forward until we can't go any farther.
2421 ;; Then keep moving down to last subnode, unless we reach an index.
2427 "Go forward one node, considering all nodes as forming one sequence."
2432 ;; three possibilities, in order of priority:
2433 ;; 1. next node is in a menu in this node (but not in an index)
2434 ;; 2. next node is next at same level
2435 ;; 3. next node is up and next
2440 t)
2443 t)
2445 ;; Use string-equal, not equal, to ignore text props.
2458 "Go backward one node, considering all nodes as forming one sequence."
2466 ;; Use string-equal, not equal,
2467 ;; to ignore text properties.
2472 ;; If we move back at the same level,
2473 ;; go down to find the last subnode*.
2483 "Exit Info by selecting some other buffer."
2490 "Go to the node of the next menu item."
2492 ;; Bind this in case the user sets it to nil.
2504 "Go to the node of the previous menu item."
2508 ;; Bind this in case the user sets it to nil.
2523 "Go to the next subnode or the next node, or go up a level."
2528 ;; Since we have already gone thru all the items in this menu,
2529 ;; go up to the end of this node.
2531 ;; Since logically we are done with the node with that menu,
2532 ;; move on from it.
2538 "Go to the last node, popping up a level if there is none."
2542 ;; If we go down a menu item, go to the end of the node
2543 ;; so we can scroll back through it.
2545 ;; Keep going down, as long as there are nested menu nodes.
2548 ;; If we go down a menu item, go to the end of the node
2549 ;; so we can scroll back through it.
2559 ;; If we go down a menu item, go to the end of the node
2560 ;; so we can scroll back through it.
2571 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2572 Once you scroll far enough in a node that its menu appears on the screen
2573 but after point, the next scroll moves into its first subnode, unless
2574 `Info-scroll-prefer-subnodes' is nil.
2576 When you scroll past the end of a node, that goes to the next node if
2577 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2578 if this node has no successor, it moves to the parent node's successor,
2579 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2580 the menu of a node, it moves to subnode indicated by the following menu
2581 item. (That case won't normally result from this command, but can happen
2582 in other ways.)"
2604 "Scroll one screenful back in Info, considering all nodes as one sequence.
2605 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2606 is non-nil, this goes to its last subnode. When you scroll past the
2607 beginning of a node, that goes to the previous node or back up to the
2608 parent node."
2622 current-point
2623 t)))))
2630 "Move cursor to the next cross-reference or menu item in the node."
2652 "Move cursor to the previous cross-reference or menu item in the node."
2671 \f
2673 "Alist of cached index node names of visited Info files.
2677 "Return a list of names of all index nodes in Info FILE.
2678 If FILE is omitted, it defaults to the current Info file.
2679 First look in a list of cached index node names. Then scan Info
2680 file and its subfiles for nodes with the index cookie. Then try
2681 to find index nodes starting from the first node in the top level
2686 ;; Skip virtual Info files
2691 ;; Find nodes with index cookie
2695 default-directory))
2696 Info-history Info-history-list Info-fontify-maximum-menu-size
2716 subfiles)))))
2718 main-file nil))
2724 nodes)
2725 ;; Else find nodes with the word "Index" in the node name
2727 Info-history Info-history-list Info-fontify-maximum-menu-size
2728 nodes node)
2746 nodes))
2747 ;; If file has no index nodes, still add it to the cache
2752 "Return non-nil value if NODE is an index node.
2753 If NODE is nil, check the current Info node.
2754 If FILE is nil, check the current Info file."
2758 ;; Don't search all index nodes if request is only for the current node
2759 ;; and file is not in the cache of index nodes
2773 "Go to the first index node."
2778 ;;;###autoload
2780 "Look up a string TOPIC in the index for this manual and go to that entry.
2781 If there are no exact matches to the specified topic, this chooses
2782 the first match which is a case-insensitive substring of a topic.
2784 Give an empty topic name to go to the Index node itself."
2800 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2809 ;; We bind Info-history to nil for internal node-switches so
2810 ;; that we don't put junk in the history. In the first
2811 ;; Info-goto-index call, above, we do update the history
2812 ;; because that is what the user's previous node choice into it.
2814 found)
2821 Info-current-node
2824 matches))
2831 ;; Here it is a feature that assoc is case-sensitive.
2866 "Move point to the place within the current node where NAME is defined."
2871 ;; Find a function definition with a return type.
2879 nil t))
2881 ;; Try again without the " <1>" makeinfo can append
2887 ;;;###autoload
2889 "Grovel indices of all known Info files on your system for STRING.
2890 Build a menu of the possible matches."
2893 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2899 manuals matches node nodes)
2922 matches)))
2931 Info-history-list ohist-list)
2952 "Make command be undefined in Info."
2957 "Enter the Info tutorial."
2962 "Help-Small-Screen"
2966 "Display a brief summary of all Info commands."
2981 flag))
2984 \f
2986 "Return the token around POS.
2987 POS must be somewhere inside the token
2988 START is a regular expression which will match the
2989 beginning of the tokens delimited string
2990 ALL is a regular expression with a single
2991 parenthesized subpattern which is the token to be
2992 returned. E.g. '{\(.*\)}' would return any string
2993 enclosed in braces around POS.
2994 ERRORSTRING optional fourth argument, controls action on no match
2995 nil: return nil
2996 t: beep
2997 a string: signal an error, using that string."
3001 ;; First look for a match for START that goes across POS.
3005 ;; If we did not find one, search back for START
3006 ;; (this finds only matches that end at or before POS).
3019 nil)
3022 nil)
3028 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
3029 At end of the node's text, moves to the next node, or up if none."
3037 "Follow a node reference near point.
3038 If point is on a reference, follow that reference. Otherwise,
3039 if point is in a menu item description, follow that menu item."
3051 t)))
3054 ;; Common subroutine.
3056 "Follow a node reference near point. Return non-nil if successful."
3065 ;; menu item: node name
3068 ;; menu item: node name or index entry
3082 node))
3083 \f
3087 nil
3097 (define-key Info-mode-map "1" 'Info-nth-menu-item)
3098 (define-key Info-mode-map "2" 'Info-nth-menu-item)
3099 (define-key Info-mode-map "3" 'Info-nth-menu-item)
3100 (define-key Info-mode-map "4" 'Info-nth-menu-item)
3101 (define-key Info-mode-map "5" 'Info-nth-menu-item)
3102 (define-key Info-mode-map "6" 'Info-nth-menu-item)
3103 (define-key Info-mode-map "7" 'Info-nth-menu-item)
3104 (define-key Info-mode-map "8" 'Info-nth-menu-item)
3105 (define-key Info-mode-map "9" 'Info-nth-menu-item)
3106 (define-key Info-mode-map "0" 'undefined)
3107 (define-key Info-mode-map "?" 'Info-summary)
3108 (define-key Info-mode-map "]" 'Info-forward-node)
3109 (define-key Info-mode-map "[" 'Info-backward-node)
3110 (define-key Info-mode-map "<" 'Info-top-node)
3111 (define-key Info-mode-map ">" 'Info-final-node)
3112 (define-key Info-mode-map "b" 'beginning-of-buffer)
3113 (define-key Info-mode-map "d" 'Info-directory)
3114 (define-key Info-mode-map "e" 'Info-edit)
3115 (define-key Info-mode-map "f" 'Info-follow-reference)
3116 (define-key Info-mode-map "g" 'Info-goto-node)
3117 (define-key Info-mode-map "h" 'Info-help)
3118 (define-key Info-mode-map "i" 'Info-index)
3119 (define-key Info-mode-map "l" 'Info-history-back)
3120 (define-key Info-mode-map "L" 'Info-history)
3121 (define-key Info-mode-map "m" 'Info-menu)
3122 (define-key Info-mode-map "n" 'Info-next)
3123 (define-key Info-mode-map "p" 'Info-prev)
3124 (define-key Info-mode-map "q" 'Info-exit)
3125 (define-key Info-mode-map "r" 'Info-history-forward)
3126 (define-key Info-mode-map "s" 'Info-search)
3127 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
3128 ;; For consistency with Rmail.
3129 (define-key Info-mode-map "\M-s" 'Info-search)
3130 (define-key Info-mode-map "\M-n" 'clone-buffer)
3131 (define-key Info-mode-map "t" 'Info-top-node)
3132 (define-key Info-mode-map "T" 'Info-toc)
3133 (define-key Info-mode-map "u" 'Info-up)
3134 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3135 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
3136 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
3137 ;; `^' for consistency with `dired-up-directory'.
3138 (define-key Info-mode-map "^" 'Info-up)
3139 (define-key Info-mode-map "," 'Info-index-next)
3141 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
3142 (define-key Info-mode-map [follow-link] 'mouse-face)
3143 )
3145 (defun Info-check-pointer (item)
3146 "Non-nil if ITEM is present in this node."
3147 (condition-case nil
3148 (Info-extract-pointer item)
3149 (error nil)))
3151 (easy-menu-define
3152 Info-mode-menu Info-mode-map
3153 "Menu for Info files."
3154 '("Info"
3155 ["Up" Info-up :active (Info-check-pointer "up")
3156 :help "Go up in the Info tree"]
3157 ["Next" Info-next :active (Info-check-pointer "next")
3158 :help "Go to the next node"]
3159 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3160 :help "Go to the previous node"]
3161 ["Backward" Info-backward-node
3162 :help "Go backward one node, considering all as a sequence"]
3163 ["Forward" Info-forward-node
3164 :help "Go forward one node, considering all as a sequence"]
3165 ["Beginning" beginning-of-buffer
3166 :help "Go to beginning of this node"]
3167 ["Top" Info-top-node
3168 :help "Go to top node of file"]
3169 ["Final Node" Info-final-node
3170 :help "Go to final node in this file"]
3171 ("Menu Item" ["You should never see this" report-emacs-bug t])
3172 ("Reference" ["You should never see this" report-emacs-bug t])
3173 ["Search..." Info-search
3174 :help "Search for regular expression in this Info file"]
3175 ["Search Next" Info-search-next
3176 :help "Search for another occurrence of regular expression"]
3177 ["Go to Node..." Info-goto-node
3178 :help "Go to a named node"]
3179 ["Back in history" Info-history-back :active Info-history
3180 :help "Go back in history to the last node you were at"]
3181 ["Forward in history" Info-history-forward :active Info-history-forward
3182 :help "Go forward in history"]
3183 ["History" Info-history :active Info-history-list
3184 :help "Go to menu of visited nodes"]
3185 ["Table of Contents" Info-toc
3186 :help "Go to table of contents"]
3187 ("Index"
3188 ["Lookup a String..." Info-index
3189 :help "Look for a string in the index items"]
3190 ["Next Matching Item" Info-index-next :active Info-index-alternatives
3191 :help "Look for another occurrence of previous item"]
3192 ["Lookup a string in all indices..." info-apropos
3193 :help "Look for a string in the indices of all manuals"])
3194 ["Copy Node Name" Info-copy-current-node-name
3195 :help "Copy the name of the current node into the kill ring"]
3196 ["Clone Info buffer" clone-buffer
3197 :help "Create a twin copy of the current Info buffer."]
3198 ["Exit" Info-exit :help "Stop reading Info"]))
3201 (defvar info-tool-bar-map
3202 (if (display-graphic-p)
3203 (let ((map (make-sparse-keymap)))
3204 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
3205 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map)
3206 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map)
3207 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map)
3208 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map)
3209 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3210 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3211 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3212 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3213 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3214 map)))
3216 (defvar Info-menu-last-node nil)
3217 ;; Last node the menu was created for.
3218 ;; Value is a list, (FILE-NAME NODE-NAME).
3220 (defun Info-menu-update ()
3221 "Update the Info menu for the current node."
3222 (condition-case nil
3223 (if (or (not (eq major-mode 'Info-mode))
3224 (equal (list Info-current-file Info-current-node)
3225 Info-menu-last-node))
3226 ()
3227 ;; Update menu menu.
3228 (let* ((Info-complete-menu-buffer (current-buffer))
3229 (items (nreverse (condition-case nil
3230 (Info-complete-menu-item "" nil t)
3231 (error nil))))
3232 entries current
3233 (number 0))
3234 (while (and items (< number 9))
3235 (setq current (car items)
3236 items (cdr items)
3237 number (1+ number))
3238 (setq entries (cons `[,current
3239 (Info-menu ,current)
3240 :keys ,(format "%d" number)]
3241 entries)))
3242 (if items
3243 (setq entries (cons ["Other..." Info-menu t] entries)))
3244 (or entries
3245 (setq entries (list ["No menu" nil nil] nil :active)))
3246 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3247 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3248 (let ((items nil)
3249 str i entries current
3250 (number 0)
3251 (case-fold-search t))
3252 (save-excursion
3253 (goto-char (point-min))
3255 (setq str (match-string 1))
3256 (setq i 0)
3258 (setq str (concat (substring str 0 i) " "
3259 (substring str (match-end 0))))
3260 (setq i (1+ i)))
3261 (setq items
3262 (cons str items))))
3263 (while (and items (< number 9))
3264 (setq current (car items)
3265 items (cdr items)
3266 number (1+ number))
3267 (setq entries (cons `[,current
3268 (Info-follow-reference ,current)
3269 t]
3270 entries)))
3271 (if items
3272 (setq entries (cons ["Other..." Info-follow-reference t]
3273 entries)))
3274 (or entries
3275 (setq entries (list ["No references" nil nil] nil :active)))
3276 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3277 ;; Update last seen node.
3278 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3279 ;; Try to avoid entering infinite beep mode in case of errors.
3280 (error (ding))))
3282 \f
3283 (defun Info-copy-current-node-name (&optional arg)
3284 "Put the name of the current Info node into the kill ring.
3285 The name of the Info file is prepended to the node name in parentheses.
3286 With a zero prefix arg, put the name inside a function call to `info'."
3287 (interactive "P")
3288 (unless Info-current-node
3289 (error "No current Info node"))
3290 (let ((node (concat "(" (file-name-nondirectory Info-current-file) ")"
3291 Info-current-node)))
3292 (if (zerop (prefix-numeric-value arg))
3294 (kill-new node)
3295 (message "%s" node)))
3297 \f
3298 ;; Info mode is suitable only for specially formatted data.
3299 (put 'Info-mode 'mode-class 'special)
3300 (put 'Info-mode 'no-clone-indirect t)
3302 (defvar tool-bar-map)
3304 ;; Autoload cookie needed by desktop.el
3305 ;;;###autoload
3306 (defun Info-mode ()
3307 "Info mode provides commands for browsing through the Info documentation tree.
3309 one topic and contains references to other nodes which discuss related
3310 topics. Info has commands to follow the references and show you other nodes.
3316 Selecting other nodes:
3318 Follow a node reference you click on.
3319 This works with menu items, cross references, and
3321 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3326 Picking a menu item causes another node to be selected.
3336 \\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
3340 Moving within a node:
3342 Once you scroll far enough in a node that its menu appears on the
3343 screen but after point, the next scroll moves into its first
3344 subnode. When after all menu items (or if there is no menu),
3345 move up to the parent node.
3347 already visible, try to go to the previous menu entry, or up
3348 if there is none.
3351 Advanced commands:
3353 and select the node in which the next occurrence is found.
3354 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3358 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3361 You may include a filename as well, as (FILENAME)NODENAME.
3362 1 .. 9 Pick first ... ninth item in node's menu.
3363 Every third `*' is highlighted to help pick the right number.
3367 \\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
3368 (kill-all-local-variables)
3369 (setq major-mode 'Info-mode)
3370 (setq mode-name "Info")
3371 (setq tab-width 8)
3372 (use-local-map Info-mode-map)
3373 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3374 (set-syntax-table text-mode-syntax-table)
3375 (setq local-abbrev-table text-mode-abbrev-table)
3376 (setq case-fold-search t)
3377 (setq buffer-read-only t)
3378 (make-local-variable 'Info-current-file)
3379 (make-local-variable 'Info-current-subfile)
3380 (make-local-variable 'Info-current-node)
3381 (make-local-variable 'Info-tag-table-marker)
3382 (setq Info-tag-table-marker (make-marker))
3383 (make-local-variable 'Info-tag-table-buffer)
3384 (setq Info-tag-table-buffer nil)
3385 (make-local-variable 'Info-history)
3386 (make-local-variable 'Info-history-forward)
3387 (make-local-variable 'Info-index-alternatives)
3388 (setq header-line-format
3389 (if Info-use-header-line
3390 '(:eval (get-text-property (point-min) 'header-line))
3391 nil)) ; so the header line isn't displayed
3392 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3393 ;; This is for the sake of the invisible text we use handling titles.
3394 (make-local-variable 'line-move-ignore-invisible)
3395 (setq line-move-ignore-invisible t)
3396 (make-local-variable 'desktop-save-buffer)
3397 (make-local-variable 'widen-automatically)
3398 (setq widen-automatically nil)
3399 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3400 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
3401 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
3402 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3403 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
3404 (set (make-local-variable 'isearch-search-fun-function)
3405 'Info-isearch-search)
3406 (set (make-local-variable 'isearch-wrap-function)
3407 'Info-isearch-wrap)
3408 (set (make-local-variable 'isearch-push-state-function)
3409 'Info-isearch-push-state)
3410 (set (make-local-variable 'search-whitespace-regexp)
3411 Info-search-whitespace-regexp)
3412 (Info-set-mode-line)
3413 (run-mode-hooks 'Info-mode-hook))
3415 ;; When an Info buffer is killed, make sure the associated tags buffer
3416 ;; is killed too.
3417 (defun Info-kill-buffer ()
3418 (and (eq major-mode 'Info-mode)
3419 Info-tag-table-buffer
3420 (kill-buffer Info-tag-table-buffer)))
3422 (defun Info-clone-buffer-hook ()
3423 (when (bufferp Info-tag-table-buffer)
3424 (setq Info-tag-table-buffer
3425 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3426 (let ((m Info-tag-table-marker))
3427 (when (markerp m)
3428 (setq Info-tag-table-marker
3429 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3430 (with-current-buffer Info-tag-table-buffer
3431 (copy-marker (marker-position m)))
3432 (make-marker))))))
3434 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3435 (set-keymap-parent map text-mode-map)
3436 (define-key map "\C-c\C-c" 'Info-cease-edit)
3437 map)
3438 "Local keymap used within `e' command of Info.")
3440 ;; Info-edit mode is suitable only for specially formatted data.
3441 (put 'Info-edit-mode 'mode-class 'special)
3443 (defun Info-edit-mode ()
3444 "Major mode for editing the contents of an Info node.
3445 Like text mode with the addition of `Info-cease-edit'
3446 which returns to Info mode for browsing.
3448 (use-local-map Info-edit-map)
3449 (setq major-mode 'Info-edit-mode)
3450 (setq mode-name "Info Edit")
3451 (kill-local-variable 'mode-line-buffer-identification)
3452 (setq buffer-read-only nil)
3453 (force-mode-line-update)
3454 (buffer-enable-undo (current-buffer))
3455 (run-mode-hooks 'Info-edit-mode-hook))
3457 (defun Info-edit ()
3458 "Edit the contents of this Info node.
3459 Allowed only if variable `Info-enable-edit' is non-nil."
3460 (interactive)
3461 (or Info-enable-edit
3462 (error "Editing Info nodes is not enabled"))
3463 (Info-edit-mode)
3464 (message "%s" (substitute-command-keys
3467 (defun Info-cease-edit ()
3468 "Finish editing Info node; switch back to Info proper."
3469 (interactive)
3470 ;; Do this first, so nothing has changed if user C-g's at query.
3471 (and (buffer-modified-p)
3472 (y-or-n-p "Save the file? ")
3473 (save-buffer))
3474 (use-local-map Info-mode-map)
3475 (setq major-mode 'Info-mode)
3476 (setq mode-name "Info")
3477 (Info-set-mode-line)
3478 (setq buffer-read-only t)
3479 (force-mode-line-update)
3480 (and (marker-position Info-tag-table-marker)
3481 (buffer-modified-p)
3482 (message "Tags may have changed. Use Info-tagify if necessary")))
3483 \f
3484 (defvar Info-file-list-for-emacs
3485 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3486 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3487 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3488 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3489 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3490 ("copyright" . "autotype") ("executable" . "autotype")
3491 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3492 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3493 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3494 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3495 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3496 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3497 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3498 ("rfc2045" . "emacs-mime")
3499 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3500 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3501 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3502 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3503 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3504 ("mml" . "emacs-mime"))
3505 "List of Info files that describe Emacs commands.
3506 An element can be a file name, or a list of the form (PREFIX . FILE)
3507 where PREFIX is a name prefix and FILE is the file to look in.
3508 If the element is just a file name, the file name also serves as the prefix.")
3510 (defun Info-find-emacs-command-nodes (command)
3511 "Return a list of locations documenting COMMAND.
3512 The `info-file' property of COMMAND says which Info manual to search.
3513 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3514 defines heuristics for which Info manual to try.
3515 The locations are of the format used in `Info-history', i.e.
3516 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3517 in the first element of the returned list (which is treated specially in
3518 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3519 (let ((where '()) line-number
3523 (info-file "emacs")) ;default
3524 ;; Determine which Info file this command is documented in.
3525 (if (get command 'info-file)
3526 (setq info-file (get command 'info-file))
3527 ;; If it doesn't say explicitly, test its name against
3528 ;; various prefixes that we know.
3529 (let ((file-list Info-file-list-for-emacs))
3530 (while file-list
3531 (let* ((elt (car file-list))
3532 (name (if (consp elt)
3533 (car elt)
3534 elt))
3535 (file (if (consp elt) (cdr elt) elt))
3536 (case-fold-search nil)
3539 (if (string-match regexp (symbol-name command))
3540 (setq info-file file file-list nil))
3541 (setq file-list (cdr file-list))))))
3542 (Info-find-node info-file "Top")
3543 ;; Bind Info-history to nil, to prevent the index nodes from
3544 ;; getting into the node history.
3545 (let ((Info-history nil)
3546 (Info-history-list nil)
3547 node (nodes (Info-index-nodes)))
3548 (Info-goto-node (car nodes))
3549 (while
3550 (progn
3551 (goto-char (point-min))
3552 (while (re-search-forward cmd-desc nil t)
3553 (setq where
3554 (cons (list Info-current-file
3555 (match-string-no-properties 2)
3556 0)
3557 where))
3558 (setq line-number (and (match-beginning 3)
3559 (string-to-number (match-string 3)))))
3560 (and (setq nodes (cdr nodes) node (car nodes))))
3561 (Info-goto-node node)))
3562 (if (and line-number where)
3563 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3564 (cdr where))
3565 where)))
3567 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3568 ;;;###autoload
3569 (defun Info-goto-emacs-command-node (command)
3570 "Go to the Info node in the Emacs manual for command COMMAND.
3571 The command is found by looking up in Emacs manual's indices
3572 or in another manual found via COMMAND's `info-file' property or
3573 the variable `Info-file-list-for-emacs'.
3574 COMMAND must be a symbol or string."
3575 (interactive "CFind documentation for command: ")
3576 ;; If command is given as a string, convert it to a symbol.
3577 (if (stringp command)
3578 (setq command (intern command)))
3579 (or (commandp command)
3580 (signal 'wrong-type-argument (list 'commandp command)))
3581 (let ((where (Info-find-emacs-command-nodes command)))
3582 (if where
3583 (let ((num-matches (length where)))
3584 ;; Get Info running, and pop to it in another window.
3585 (save-window-excursion
3586 (info))
3587 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3588 ;; Bind Info-history to nil, to prevent the last Index node
3589 ;; visited by Info-find-emacs-command-nodes from being
3590 ;; pushed onto the history.
3591 (let ((Info-history nil) (Info-history-list nil)
3592 (line-number (nth 2 (car where))))
3593 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3594 (if (and (integerp line-number) (> line-number 0))
3595 (forward-line (1- line-number))))
3596 (if (> num-matches 1)
3597 (progn
3598 ;; (car where) will be pushed onto Info-history
3599 ;; when/if they go to another node. Put the other
3600 ;; nodes that were found on the history.
3601 (setq Info-history (nconc (cdr where) Info-history))
3602 (message "Found %d other entr%s. Use %s to see %s."
3603 (1- num-matches)
3604 (if (> num-matches 2) "ies" "y")
3606 (if (> num-matches 2) "them" "it")))))
3607 (error "Couldn't find documentation for %s" command))))
3609 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3610 ;;;###autoload
3611 (defun Info-goto-emacs-key-command-node (key)
3612 "Go to the node in the Emacs manual which describes the command bound to KEY.
3613 KEY is a string.
3614 Interactively, if the binding is `execute-extended-command', a command is read.
3615 The command is found by looking up in Emacs manual's indices
3616 or in another manual found via COMMAND's `info-file' property or
3617 the variable `Info-file-list-for-emacs'."
3618 (interactive "kFind documentation for key: ")
3619 (let ((command (key-binding key)))
3620 (cond ((null command)
3621 (message "%s is undefined" (key-description key)))
3622 ((and (interactive-p)
3623 (eq command 'execute-extended-command))
3624 (Info-goto-emacs-command-node
3625 (read-command "Find documentation for command: ")))
3626 (t
3627 (Info-goto-emacs-command-node command)))))
3628 \f
3629 (defvar Info-next-link-keymap
3630 (let ((keymap (make-sparse-keymap)))
3631 (define-key keymap [header-line mouse-1] 'Info-next)
3632 (define-key keymap [header-line mouse-2] 'Info-next)
3633 (define-key keymap [header-line down-mouse-1] 'ignore)
3634 (define-key keymap [mouse-2] 'Info-next)
3635 (define-key keymap [follow-link] 'mouse-face)
3636 keymap)
3637 "Keymap to put on the Next link in the text or the header line.")
3639 (defvar Info-prev-link-keymap
3640 (let ((keymap (make-sparse-keymap)))
3641 (define-key keymap [header-line mouse-1] 'Info-prev)
3642 (define-key keymap [header-line mouse-2] 'Info-prev)
3643 (define-key keymap [header-line down-mouse-1] 'ignore)
3644 (define-key keymap [mouse-2] 'Info-prev)
3645 (define-key keymap [follow-link] 'mouse-face)
3646 keymap)
3647 "Keymap to put on the Prev link in the text or the header line.")
3649 (defvar Info-up-link-keymap
3650 (let ((keymap (make-sparse-keymap)))
3651 (define-key keymap [header-line mouse-1] 'Info-up)
3652 (define-key keymap [header-line mouse-2] 'Info-up)
3653 (define-key keymap [header-line down-mouse-1] 'ignore)
3654 (define-key keymap [mouse-2] 'Info-up)
3655 (define-key keymap [follow-link] 'mouse-face)
3656 keymap)
3657 "Keymap to put on the Up link in the text or the header line.")
3659 (defun Info-fontify-node ()
3660 "Fontify the node."
3661 (save-excursion
3662 (let* ((inhibit-read-only t)
3663 (case-fold-search t)
3664 paragraph-markers
3665 (not-fontified-p ; the node hasn't already been fontified
3666 (not (let ((where (next-property-change (point-min))))
3667 (and where (not (= where (point-max)))))))
3668 (fontify-visited-p ; visited nodes need to be re-fontified
3669 (and Info-fontify-visited-nodes
3670 ;; Don't take time to refontify visited nodes in huge nodes
3671 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3672 rbeg rend)
3674 ;; Fontify header line
3675 (goto-char (point-min))
3677 (goto-char (match-end 0))
3679 (goto-char (match-end 0))
3680 (let* ((nbeg (match-beginning 2))
3681 (nend (match-end 2))
3682 (tbeg (match-beginning 1))
3683 (tag (match-string 1)))
3684 (if (string-equal (downcase tag) "node")
3685 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3686 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3687 (put-text-property tbeg nend 'mouse-face 'highlight)
3688 (put-text-property tbeg nend
3689 'help-echo
3690 (concat "mouse-2: Go to node "
3691 (buffer-substring nbeg nend)))
3692 ;; Always set up the text property keymap.
3693 ;; It will either be used in the buffer
3694 ;; or copied in the header line.
3695 (put-text-property
3696 tbeg nend 'keymap
3697 (cond
3698 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
3699 ((string-equal (downcase tag) "next") Info-next-link-keymap)
3700 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3701 (when Info-use-header-line
3702 (goto-char (point-min))
3703 (let* ((header-end (line-end-position))
3704 (header
3705 ;; If we find neither Next: nor Prev: link, show the entire
3706 ;; node header. Otherwise, don't show the File: and Node:
3707 ;; parts, to avoid wasting precious space on information that
3708 ;; is available in the mode line.
3709 (if (re-search-forward
3711 header-end t)
3712 (progn
3713 (goto-char (match-beginning 1))
3714 (buffer-substring (point) header-end))
3716 header-end t)
3717 (concat "No next, prev or up links -- "
3718 (buffer-substring (point) header-end))
3719 (buffer-substring (point) header-end)))))
3720 (put-text-property (point-min) (1+ (point-min))
3721 'header-line
3722 (replace-regexp-in-string
3723 "%"
3724 ;; Preserve text properties on duplicated `%'.
3725 (lambda (s) (concat s s)) header))
3726 ;; Hide the part of the first line
3727 ;; that is in the header, if it is just part.
3728 (unless (bobp)
3729 ;; Hide the punctuation at the end, too.
3731 (put-text-property (point) header-end 'invisible t)))))
3733 ;; Fontify titles
3734 (goto-char (point-min))
3735 (when (and font-lock-mode not-fontified-p)
3737 nil t)
3738 ;; Only consider it as an underlined title if the ASCII
3739 ;; underline has the same size as the text. A typical
3740 ;; counter example is when a continuation "..." is alone
3741 ;; on a line.
3742 (= (string-width (match-string 1))
3743 (string-width (match-string 2))))
3744 (let* ((c (preceding-char))
3745 (face
3746 (cond ((= c ?*) 'info-title-1)
3747 ((= c ?=) 'info-title-2)
3748 ((= c ?-) 'info-title-3)
3749 (t 'info-title-4))))
3750 (put-text-property (match-beginning 1) (match-end 1)
3751 'font-lock-face face))
3752 ;; This is a serious problem for trying to handle multiple
3753 ;; frame types at once. We want this text to be invisible
3754 ;; on frames that can display the font above.
3755 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3756 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3757 '(invisible t front-sticky nil rear-nonsticky t)))))
3759 ;; Fontify cross references
3760 (goto-char (point-min))
3761 (when (or not-fontified-p fontify-visited-p)
3762 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3763 (let ((start (match-beginning 0))
3764 (next (point))
3765 other-tag)
3766 (when not-fontified-p
3767 (when Info-hide-note-references
3768 (when (not (eq Info-hide-note-references 'hide))
3769 ;; *Note is often used where *note should have been
3770 (goto-char start)
3771 (skip-syntax-backward " ")
3772 (when (memq (char-before) '(?\( ?\[ ?\{))
3773 ;; Check whether the paren is preceded by
3774 ;; an end of sentence
3775 (skip-syntax-backward " ("))
3776 (setq other-tag
3778 "")
3779 ((memq (char-before) '(nil ?\. ?! ??))
3780 "See ")
3781 ((save-match-data
3782 (save-excursion
3784 "See ")
3785 (t "see "))))
3786 (goto-char next)
3787 (add-text-properties
3788 (match-beginning 1)
3789 (or (save-match-data
3791 (let ((start1 (match-beginning 1)))
3793 (+ start1 (match-beginning 0)))))
3794 (match-end 1))
3795 (if other-tag
3796 `(display ,other-tag front-sticky nil rear-nonsticky t)
3797 '(invisible t front-sticky nil rear-nonsticky t))))
3798 (add-text-properties
3799 (match-beginning 2) (match-end 2)
3800 (list
3801 'help-echo (if (or (match-end 5)
3802 (not (equal (match-string 4) "")))
3803 (concat "mouse-2: go to " (or (match-string 5)
3804 (match-string 4)))
3805 "mouse-2: go to this node")
3806 'mouse-face 'highlight)))
3807 (when (or not-fontified-p fontify-visited-p)
3808 (setq rbeg (match-beginning 2)
3809 rend (match-end 2))
3810 (put-text-property
3811 rbeg rend
3812 'font-lock-face
3813 ;; Display visited nodes in a different face
3814 (if (and Info-fontify-visited-nodes
3815 (save-match-data
3816 (let* ((node (replace-regexp-in-string
3818 (replace-regexp-in-string
3820 (or (match-string 5)
3821 (and (not (equal (match-string 4) ""))
3822 (match-string 4))
3823 (match-string 2)))))
3824 (external-link-p
3826 (file (if external-link-p
3827 (file-name-nondirectory
3828 (match-string 1 node))
3829 Info-current-file))
3830 (hl Info-history-list)
3831 res)
3832 (if external-link-p
3833 (setq node (if (equal (match-string 2 node) "")
3834 "Top"
3835 (match-string 2 node))))
3836 (while hl
3837 (if (and (string-equal node (nth 1 (car hl)))
3838 (string-equal
3839 file (if external-link-p
3840 (file-name-nondirectory
3841 (caar hl))
3842 (caar hl))))
3843 (setq res (car hl) hl nil)
3844 (setq hl (cdr hl))))
3845 res))) 'info-xref-visited 'info-xref))
3846 ;; For multiline ref, unfontify newline and surrounding whitespace
3847 (save-excursion
3848 (goto-char rbeg)
3849 (save-match-data
3851 (remove-text-properties (match-beginning 0)
3852 (match-end 0)
3853 '(font-lock-face t))))))
3854 (when not-fontified-p
3855 (when (memq Info-hide-note-references '(t hide))
3856 (add-text-properties (match-beginning 3) (match-end 3)
3857 '(invisible t front-sticky nil rear-nonsticky t))
3858 ;; Unhide the file name of the external reference in parens
3859 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3860 (remove-text-properties (match-beginning 6) (match-end 6)
3861 '(invisible t front-sticky nil rear-nonsticky t)))
3862 ;; Unhide newline because hidden newlines cause too long lines
3863 (save-match-data
3864 (let ((beg3 (match-beginning 3))
3865 (end3 (match-end 3)))
3867 (not (save-match-data
3868 (save-excursion
3869 (goto-char (1+ end3))
3870 (looking-at "[.)]*$")))))
3871 (remove-text-properties (+ beg3 (match-beginning 0))
3872 (+ beg3 (match-end 0))
3873 '(invisible t front-sticky nil rear-nonsticky t))))))
3874 (when (and Info-refill-paragraphs Info-hide-note-references)
3875 (push (set-marker (make-marker) start)
3876 paragraph-markers))))))
3878 ;; Refill paragraphs (experimental feature)
3879 (when (and not-fontified-p
3880 Info-refill-paragraphs
3881 paragraph-markers)
3882 (let ((fill-nobreak-invisible t)
3883 (fill-individual-varying-indent nil)
3886 (adaptive-fill-mode nil))
3887 (goto-char (point-max))
3888 (dolist (m paragraph-markers)
3889 (when (< m (point))
3890 (goto-char m)
3891 (beginning-of-line)
3892 (let ((beg (point)))
3893 (when (zerop (forward-paragraph))
3894 (fill-individual-paragraphs beg (point) nil nil)
3895 (goto-char beg))))
3896 (set-marker m nil))))
3898 ;; Fontify menu items
3899 (goto-char (point-min))
3900 (when (and (or not-fontified-p fontify-visited-p)
3902 (not (Info-index-node))
3903 ;; Don't take time to annotate huge menus
3904 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3905 (let ((n 0)
3906 cont)
3907 (while (re-search-forward
3910 nil t)
3911 (when (match-beginning 1)
3912 (when not-fontified-p
3913 (setq n (1+ n))
3914 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3915 (put-text-property (match-beginning 0)
3916 (1+ (match-beginning 0))
3917 'font-lock-face 'info-menu-star)))
3918 (when not-fontified-p
3919 (add-text-properties
3920 (match-beginning 1) (match-end 1)
3921 (list
3922 'help-echo (if (and (match-end 3)
3923 (not (equal (match-string 3) "")))
3924 (concat "mouse-2: go to " (match-string 3))
3925 "mouse-2: go to this node")
3926 'mouse-face 'highlight)))
3927 (when (or not-fontified-p fontify-visited-p)
3928 (put-text-property
3929 (match-beginning 1) (match-end 1)
3930 'font-lock-face
3931 ;; Display visited menu items in a different face
3932 (if (and Info-fontify-visited-nodes
3933 (save-match-data
3934 (let* ((node (if (equal (match-string 3) "")
3935 (match-string 1)
3936 (match-string 3)))
3937 (external-link-p
3939 (file (if external-link-p
3940 (file-name-nondirectory
3941 (match-string 1 node))
3942 Info-current-file))
3943 (hl Info-history-list)
3944 res)
3945 (if external-link-p
3946 (setq node (if (equal (match-string 2 node) "")
3947 "Top"
3948 (match-string 2 node))))
3949 (while hl
3950 (if (and (string-equal node (nth 1 (car hl)))
3951 (string-equal
3952 file (if external-link-p
3953 (file-name-nondirectory (caar hl))
3954 (caar hl))))
3955 (setq res (car hl) hl nil)
3956 (setq hl (cdr hl))))
3957 res))) 'info-xref-visited 'info-xref)))
3958 (when (and not-fontified-p (memq Info-hide-note-references '(t hide)))
3959 (put-text-property (match-beginning 2) (1- (match-end 6))
3960 'invisible t)
3961 ;; Unhide the file name in parens
3962 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
3963 (remove-text-properties (match-beginning 4) (match-end 4)
3964 '(invisible t)))
3965 ;; We need a stretchable space like :align-to but with
3966 ;; a minimum value.
3967 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3968 (if (>= 22 (- (match-end 1)
3969 (match-beginning 0)))
3970 '(space :align-to 24)
3971 '(space :width 2)))
3972 (setq cont (looking-at "."))
3973 (while (and (= (forward-line 1) 0)
3975 (put-text-property (match-beginning 1) (1- (match-end 1))
3976 'invisible t)
3977 (put-text-property (1- (match-end 1)) (match-end 1)
3978 'display
3979 (if cont
3980 '(space :align-to 26)
3981 '(space :align-to 24)))
3982 (setq cont t)))))))
3984 ;; Fontify menu headers
3985 ;; Add the face `info-menu-header' to any header before a menu entry
3986 (goto-char (point-min))
3988 (put-text-property (match-beginning 0) (match-end 0)
3989 'font-lock-face 'info-menu-header)
3991 (put-text-property (match-beginning 1) (match-end 1)
3992 'font-lock-face 'info-menu-header)))
3994 ;; Hide index line numbers
3995 (goto-char (point-min))
3996 (when (and not-fontified-p (Info-index-node))
3998 (put-text-property (match-beginning 0) (match-end 0)
3999 'invisible t)))
4001 ;; Fontify http and ftp references
4002 (goto-char (point-min))
4003 (when not-fontified-p
4005 (add-text-properties (match-beginning 0) (match-end 0)
4006 '(font-lock-face info-xref
4007 mouse-face highlight
4008 help-echo "mouse-2: go to this URL"))))
4010 (set-buffer-modified-p nil))))
4011 \f
4012 ;;; Speedbar support:
4013 ;; These functions permit speedbar to display the "tags" in the
4014 ;; current Info node.
4015 (eval-when-compile (require 'speedbar))
4017 (defvar Info-speedbar-key-map nil
4018 "Keymap used when in the info display mode.")
4020 (defun Info-install-speedbar-variables ()
4021 "Install those variables used by speedbar to enhance Info."
4022 (if Info-speedbar-key-map
4023 nil
4024 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4026 ;; Basic tree features
4027 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4028 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4029 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4030 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4031 )
4033 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4034 Info-speedbar-key-map
4035 Info-speedbar-hierarchy-buttons)))
4037 (defvar Info-speedbar-menu-items
4038 '(["Browse Node" speedbar-edit-line t]
4039 ["Expand Node" speedbar-expand-line
4040 (save-excursion (beginning-of-line)
4042 ["Contract Node" speedbar-contract-line
4043 (save-excursion (beginning-of-line)
4044 (looking-at "[0-9]+: *.-. "))]
4045 )
4046 "Additional menu-items to add to speedbar frame.")
4048 ;; Make sure our special speedbar major mode is loaded
4049 (if (featurep 'speedbar)
4050 (Info-install-speedbar-variables)
4051 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4053 ;;; Info hierarchy display method
4054 ;;;###autoload
4055 (defun Info-speedbar-browser ()
4056 "Initialize speedbar to display an Info node browser.
4057 This will add a speedbar major display mode."
4058 (interactive)
4059 (require 'speedbar)
4060 ;; Make sure that speedbar is active
4061 (speedbar-frame-mode 1)
4062 ;; Now, throw us into Info mode on speedbar.
4063 (speedbar-change-initial-expansion-list "Info")
4064 )
4066 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4067 "Display an Info directory hierarchy in speedbar.
4068 DIRECTORY is the current directory in the attached frame.
4069 DEPTH is the current indentation depth.
4070 NODE is an optional argument that is used to represent the
4071 specific node to expand."
4072 (if (and (not node)
4073 (save-excursion (goto-char (point-min))
4074 (let ((case-fold-search t))
4075 (looking-at "Info Nodes:"))))
4076 ;; Update our "current node" maybe?
4077 nil
4078 ;; We cannot use the generic list code, that depends on all leaves
4079 ;; being known at creation time.
4080 (if (not node)
4082 (let ((completions nil))
4083 (speedbar-select-attached-frame)
4084 (save-window-excursion
4085 (setq completions
4086 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
4087 (select-frame (speedbar-current-frame))
4088 (if completions
4089 (speedbar-with-writable
4090 (dolist (completion completions)
4091 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
4092 (cdr completion)
4093 (car completion)
4094 'Info-speedbar-goto-node
4095 (cdr completion)
4096 'info-xref depth))
4097 t)
4098 nil))))
4100 (defun Info-speedbar-goto-node (text node indent)
4101 "When user clicks on TEXT, go to an info NODE.
4102 The INDENT level is ignored."
4103 (speedbar-select-attached-frame)
4104 (let* ((buff (or (get-buffer "*info*")
4105 (progn (info) (get-buffer "*info*"))))
4106 (bwin (get-buffer-window buff 0)))
4107 (if bwin
4108 (progn
4109 (select-window bwin)
4110 (raise-frame (window-frame bwin)))
4111 (if speedbar-power-click
4112 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
4113 (speedbar-select-attached-frame)
4114 (switch-to-buffer buff)))
4116 (error "Invalid node %s" node)
4117 (Info-find-node (match-string 1 node) (match-string 2 node))
4118 ;; If we do a find-node, and we were in info mode, restore
4119 ;; the old default method. Once we are in info mode, it makes
4120 ;; sense to return to whatever method the user was using before.
4121 (if (string= speedbar-initial-expansion-list-name "Info")
4122 (speedbar-change-initial-expansion-list
4123 speedbar-previously-used-expansion-list-name)))))
4125 (defun Info-speedbar-expand-node (text token indent)
4126 "Expand the node the user clicked on.
4127 TEXT is the text of the button we clicked on, a + or - item.
4128 TOKEN is data related to this node (NAME . FILE).
4129 INDENT is the current indentation depth."
4130 (cond ((string-match "+" text) ;we have to expand this file
4131 (speedbar-change-expand-button-char ?-)
4132 (if (speedbar-with-writable
4133 (save-excursion
4134 (end-of-line) (forward-char 1)
4135 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
4136 (speedbar-change-expand-button-char ?-)
4137 (speedbar-change-expand-button-char ??)))
4138 ((string-match "-" text) ;we have to contract this node
4139 (speedbar-change-expand-button-char ?+)
4140 (speedbar-delete-subblock indent))
4141 (t (error "Ooops... not sure what to do")))
4142 (speedbar-center-buffer-smartly))
4144 (defun Info-speedbar-fetch-file-nodes (nodespec)
4145 "Fetch the subnodes from the info NODESPEC.
4146 NODESPEC is a string of the form: (file)node."
4147 (save-excursion
4148 ;; Set up a buffer we can use to fake-out Info.
4149 (set-buffer (get-buffer-create " *info-browse-tmp*"))
4150 (if (not (equal major-mode 'Info-mode))
4151 (Info-mode))
4152 ;; Get the node into this buffer
4154 (error "Invalid node specification %s" nodespec)
4155 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
4156 ;; Scan the created buffer
4157 (goto-char (point-min))
4158 (let ((completions nil)
4159 (case-fold-search t)
4161 (match-string 1 nodespec))))
4162 ;; Always skip the first one...
4165 (let ((name (match-string 1)))
4166 (push (cons name
4168 (match-string 1)
4170 (concat (match-string 1) "Top")
4171 (concat "(" thisfile ")"
4173 (match-string 1)
4174 name)))))
4175 completions)))
4176 (nreverse completions))))
4178 ;;; Info mode node listing
4179 ;; This is called by `speedbar-add-localized-speedbar-support'
4180 (defun Info-speedbar-buttons (buffer)
4181 "Create a speedbar display to help navigation in an Info file.
4182 BUFFER is the buffer speedbar is requesting buttons for."
4183 (if (save-excursion (goto-char (point-min))
4184 (let ((case-fold-search t))
4185 (not (looking-at "Info Nodes:"))))
4186 (erase-buffer))
4187 (Info-speedbar-hierarchy-buttons nil 0))
4189 (dolist (mess '("^First node in file$"
4190 "^No `.*' in index$"
4191 "^No cross-reference named"
4192 "^No cross.references in this node$"
4193 "^No current Info node$"
4194 "^No menu in this node$"
4195 "^No more items in menu$"
4196 "^No more nodes$"
4198 "^No previous `i' command$"
4199 "^No previous items in menu$"
4200 "^No previous nodes$"
4201 "^No such item in menu$"
4202 "^No such node or anchor"
4203 "^Node has no"
4204 "^Point neither on reference nor in menu item description$"
4206 search-failed))
4207 (add-to-list 'debug-ignored-errors mess))
4209 ;;;; Desktop support
4211 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4212 "Auxiliary information to be saved in desktop file."
4213 (if (not (member Info-current-file '("apropos" "history" "toc")))
4214 (list Info-current-file Info-current-node)))
4216 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4217 desktop-buffer-name
4218 desktop-buffer-misc)
4219 "Restore an Info buffer specified in a desktop file."
4220 (let ((first (nth 0 desktop-buffer-misc))
4221 (second (nth 1 desktop-buffer-misc)))
4222 (when (and first second)
4223 (when desktop-buffer-name
4224 (set-buffer (get-buffer-create desktop-buffer-name))
4225 (Info-mode))
4226 (Info-find-node first second)
4227 (current-buffer))))
4229 (add-to-list 'desktop-buffer-mode-handlers
4230 '(Info-mode . Info-restore-desktop-buffer))
4232 (provide 'info)
4234 ;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4235 ;;; info.el ends here