| blob | 8aaf7755df2d42354f4f048a4526d09bc23b503c |
1 ;;; info.el --- info package for Emacs
3 ;; Copyright (C) 1985,86,92,93,94,95,96,97,98,99,2000,01,02,03,2004
4 ;; 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., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, 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 "List of all info nodes user has visited.
56 This is convenient if you want to write info files by hand.
57 However, we recommend that you not do this.
58 It is better to write a Texinfo file and generate the Info file from that,
59 because that gives you a printed manual as well."
64 "Non-nil allows Info to execute Lisp code associated with nodes.
72 "Face for Info node names."
78 "Face for every third `*' in an Info menu."
85 "Face for Info cross-references."
92 "Face for visited Info cross-references."
96 "*Non-nil means to fontify visited nodes in a different face."
102 "*Maximum size of menu to fontify if `font-lock-mode' is non-nil."
107 "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
108 A header-line does not scroll with the rest of the buffer."
114 "Face for Info cross-references in a node header."
119 "Face for Info nodes in a node header."
123 "List of directories to search for Info documentation files.
124 If nil, meaning not yet initialized, Info uses the environment
125 variable INFOPATH to initialize it, or `Info-default-directory-list'
126 if there is no INFOPATH variable in the environment, or the
127 concatenation of the two if INFOPATH ends with a colon.
129 When `Info-directory-list' is initialized from the value of
130 `Info-default-directory-list', and Emacs is installed in one of the
131 standard directories, the directory of Info files that come with Emacs
132 is put last (so that local Info files override standard ones).
134 When `Info-directory-list' is initialized from the value of
135 `Info-default-directory-list', and Emacs is not installed in one
136 of the standard directories, the first element of the resulting
137 list is the directory where Emacs installs the Info files that
138 come with it. This is so that Emacs's own manual, which suits the
139 version of Emacs you are using, will always be found first. This
140 is useful when you install an experimental version of Emacs without
141 removing the standard installation.
143 If you want to override the order of directories in
144 `Info-default-directory-list', set INFOPATH in the environment.
146 If you run the Emacs executable from the `src' directory in the Emacs
147 source tree, and INFOPATH is not defined, the `info' directory in the
148 source tree is used as the first element of `Info-directory-list', in
149 place of the installation Info directory. This is useful when you run
153 "List of additional directories to search for Info documentation files.
154 These directories are searched after those in `Info-directory-list'."
160 If this is non-nil, and you scroll far enough in a node that its menu
162 moves to a subnode indicated by the following menu item. This means
163 that you visit a subnode before getting to the end of the menu.
165 Setting this option to nil results in behavior similar to the stand-alone
166 Info reader program, which visits the first subnode from the menu only
167 when you hit the end of the current node."
173 "*If non-nil, hide the tag and section reference in *note and * menu items.
175 If value is non-nil but not t or `hide', the reference section is still shown."
184 "*If non-nil, attempt to refill paragraphs with hidden references.
185 This refilling may accidentally remove explicit line breaks in the info
186 file, so be prepared for a few surprises if you enable this feature."
192 "*If non-nil, regular expression to match a sequence of whitespace chars.
193 This applies to Info search for regular expressions.
195 In the Customization buffer, that is `[' followed by a space,
196 a tab, a carriage return (control-M), a newline, and `]+'."
201 ;; Try to obey obsolete Info-fontify settings.
204 "Hooks run when `Info-mode' is called."
209 "Hooks run when `Info-select-node' is called."
217 "Info file that Info is now looking at, or nil.
218 This is the name that was specified in Info, not the actual file name.
219 It doesn't contain directory names or file name extensions added by Info.
223 "Info subfile that is actually in the *info* buffer now.
230 "Marker pointing at beginning of current Info file's tag table.
243 "Point location within a selected node.
244 If string, the point is moved to the proper occurrence of the
245 name of the followed cross reference within a selected node.
250 \f
252 ;; The MS-DOS list should work both when long file names are
253 ;; supported (Windows 9X), and when only 8+3 file names are available.
295 "List of file name suffixes and associated decoding commands.
296 Each entry should be (SUFFIX . STRING); the file is given to
297 the command as standard input.
299 STRING may be a list of strings. In that case, the first element is
300 the command name, and the rest are arguments to that command.
302 If STRING is nil, no decoding is done.
303 Because the SUFFIXes are tried in order, the empty string should
306 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
307 ;; First, on MS-DOS with no long file names support, delete some of
308 ;; the extension in FILENAME to make room.
313 ;; How long is the extension in FILENAME (not counting the dot).
315 ext-left)
316 ;; SUFFIX starts with a dot. If FILENAME already has one,
317 ;; get rid of the one in SUFFIX (unless suffix is empty).
322 ;; How many chars of that extension should we keep?
324 ;; Get rid of the rest of the extension, and add SUFFIX.
327 suffix))))
334 "Insert the contents of an info file in the current buffer.
335 Do the right thing if the file has been compressed or zipped."
339 t))
341 lfn))
342 fullname decoder done)
344 ;; FILENAME exists--see if that name contains a suffix.
345 ;; If so, set DECODE accordingly.
350 filename)))
354 ;; Try adding suffixes to FILENAME and see if we can find something.
360 ;; If we found a file with a suffix, set DECODER
361 ;; according to the suffix.
363 ;; When the MS-DOS port runs on Windows, we need to check
364 ;; the short variant of a long file name as well.
374 ;; check for conflict with jka-compr
385 default-directory)))
391 \f
398 "../info/"
399 invocation-directory)))
401 infodir
403 "../../../info/"
404 invocation-directory))
406 infodir))))))
407 alternative)
410 ;; Uninstalled, Emacs builddir != srcdir.
411 sibling
412 ;; Uninstalled, builddir == srcdir
413 source))
415 ;; On DOS/NT, we use movable executables always,
416 ;; and we must always find the Info dir at run time.
418 nil
419 ;; Use invocation-directory for Info
420 ;; only if we used it for exec-directory also.
423 installation-directory))))
425 Info-default-directory-list
426 ;; `alternative' contains the Info files that came with this
427 ;; version, so we should look there first. `Info-insert-dir'
428 ;; currently expects to find `alternative' first on the list.
430 ;; Don't drop the last part, it might contain non-Emacs stuff.
431 ;; (reverse (cdr (reverse
435 "Initialize `Info-directory-list', if that hasn't been done yet."
448 ;;;###autoload
450 "Like `info' but show the Info buffer in another window."
456 ;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
458 ;;;###autoload (put 'info 'info-file "emacs")
459 ;;;###autoload
461 "Enter Info, the documentation browser.
462 Optional argument FILE specifies the file to examine;
463 the default is the top-level directory of Info.
464 Called from a program, FILE may specify an Info node of the form
465 `(FILENAME)NODENAME'.
466 Optional argument BUFFER specifies the Info buffer name;
467 the default buffer name is *info*. If BUFFER exists,
468 just switch to BUFFER. Otherwise, create a new buffer
469 with the top-level Info directory.
471 In interactive use, a non-numeric prefix argument directs
472 this command to read a file name from the minibuffer.
473 A numeric prefix argument selects an Info buffer with the prefix number
474 appended to the Info buffer name.
476 The search path for Info files is in the variable `Info-directory-list'.
477 The top-level Info directory is made by combining all the files named `dir'
478 in all the directories in that path."
488 ;; If argument already contains parentheses, don't add another set
489 ;; since the argument will then be parsed improperly. This also
490 ;; has the added benefit of allowing node names to be included
491 ;; following the parenthesized filename.
498 ;;;###autoload
500 "Display the Emacs manual in Info mode."
504 ;;;###autoload
506 "Run Emacs as a standalone Info reader.
507 Usage: emacs -f info-standalone [filename]
521 \f
522 ;; See if the accessible portion of the buffer begins with a node
523 ;; delimiter, and the node header line which follows matches REGEXP.
524 ;; Typically, this test will be followed by a loop that examines the
525 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
526 ;; to have the overhead of this special test inside the loop.
528 ;; This function changes match-data, but supposedly the caller might
529 ;; want to use the results of re-search-backward.
531 ;; The return value is the value of point at the beginning of matching
532 ;; REGEXP, if the function succeeds, nil otherwise.
544 Optional second argument NOERROR, if t, means if file is not found
545 just return nil (no error)."
546 ;; Convert filename to lower case if not found as specified.
547 ;; Expand it.
562 ;; If specified name starts with `./'
563 ;; then just try current directory.
566 ;; No point in searching for an
567 ;; absolute file name
571 Info-additional-directory-list)
572 Info-directory-list)))))
573 ;; Search the directory list for file FILENAME.
578 ;; Try several variants of specified name.
582 t)))
593 lfn
605 filename)))
608 "Go to an info node specified as separate FILENAME and NODENAME.
609 NO-GOING-BACK is non-nil if recovering from an error in this function;
610 it says do not attempt further (recursive) error recovery."
613 ;; Record the node we are leaving.
617 Info-history)))
618 ;; Go into info buffer.
623 "Use the `Info-mode' to browse the current info buffer.
624 If a prefix arg is provided, it queries for the NODENAME which
636 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
637 ;; but at least it keeps this routine (which is only for the benefit of
638 ;; makeinfo-buffer) out of the way of normal operations.
639 ;;
641 "Go to an info node FILENAME and NODENAME, re-reading disk contents.
642 When *info* is already displaying FILENAME and NODENAME, the window position
643 is preserved, if possible."
659 ;; note goto-line is no good, we want to measure from point-min
666 ;; only add to the history when coming from a different file+node
671 "Find a node in a tag table.
672 MARKER specifies the buffer and position to start searching at.
673 REGEXP is a regular expression matching nodes or references. Its first
674 group should match `Node:' or `Ref:'.
675 CASE-FOLD t means search for a case-insensitive match.
676 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
677 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
678 where the match was found, and MODE is `major-mode' of the buffer in
679 which the match was found."
685 ;; Search tag table
690 major-mode)))))
693 "Find a node in a tag table.
694 MARKER specifies the buffer and position to start searching at.
695 REGEXP is a regular expression matching nodes or references. Its first
696 group should match `Node:' or `Ref:'.
697 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
698 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
699 where the match was found, and MODE is `major-mode' of the buffer in
700 which the match was found.
701 This function tries to find a case-sensitive match first, then a
702 case-insensitive match is tried."
706 result))
709 "Find a node or anchor in the current buffer.
710 REGEXP is a regular expression matching nodes or references. Its first
711 group should match `Node:' or `Ref:'.
712 CASE-FOLD t means search for a case-insensitive match.
713 Value is the position at which a match was found, or nil if not found."
715 found)
727 found)))
730 "Find a node or anchor in the current buffer.
731 REGEXP is a regular expression matching nodes or references. Its first
732 group should match `Node:' or `Ref:'.
733 Value is the position at which a match was found, or nil if not found.
734 This function looks for a case-sensitive match first. If none is found,
735 a case-insensitive match is tried."
747 anchorpos)
748 ;; Switch files if necessary
753 Info-current-subfile nil
754 Info-current-file-completions nil
755 buffer-file-name nil)
770 ;; See whether file has a tag table. Record the location if yes.
773 ;; Use string-equal, not equal, to ignore text props.
778 ;; We have a tag table. Find its beginning.
779 ;; Is this an indirect file?
785 ;; It is indirect. Copy it to another buffer
786 ;; and record that the tag table is in that buffer.
809 ))
810 ;; Use string-equal, not equal, to ignore text props.
814 ;; Possibilities:
815 ;;
816 ;; 1. Anchor found in tag table
817 ;; 2. Anchor *not* in tag table
818 ;;
819 ;; 3. Node found in tag table
820 ;; 4. Node *not* found in tag table, but found in file
821 ;; 5. Node *not* in tag table, and *not* in file
822 ;;
823 ;; *Or* the same, but in an indirect subfile.
825 ;; Search file for a suitable node.
835 ;; First, search a tag table, if any
841 ;; FOUND is (ANCHOR POS MODE).
844 ;; If this is an indirect file, determine which
845 ;; file really holds this node and read it in.
847 ;; Note that the current buffer must be the
848 ;; *info* buffer on entry to
849 ;; Info-read-subfile. Thus the hackery above.
852 ;; Handle anchor
857 ;; Else we may have a node, which we search for:
861 ;; Now search from our advised position (or from beg of
862 ;; buffer) to find the actual node. First, check
863 ;; whether the node is right where we are, in case the
864 ;; buffer begins with a node.
877 ;; No such anchor in tag table or node in tag table or file
885 ;; Add anchors to the history too
896 ;; If we did not finish finding the specified node,
897 ;; go back to the previous one.
904 ;; Cache the contents of the (virtual) dir file, once we have merged
905 ;; it for the first time, so we can save time subsequently.
908 ;; Cache for the directory we decided to use for the default-directory
909 ;; of the merged dir text.
912 ;; Record the file attributes of all the files from which we
913 ;; constructed Info-dir-contents.
918 ;; Construct the Info directory node by merging the files named `dir'
919 ;; from various directories. Set the *info* buffer's
920 ;; default-directory to the first directory we actually get any text
921 ;; from.
924 ;; Verify that none of the files we used has changed
925 ;; since we used it.
929 ;; Handle symlinks
932 ;; Don't compare the access time.
936 Info-dir-file-attributes))))
942 Info-additional-directory-list)
943 Info-directory-list))
945 ;; Bind this in case the user sets it to nil.
947 ;; This is set non-nil if we find a problem in some input files.
948 problems
949 buffers buffer others nodes dirs-done)
951 ;; Search the directory list for the directory file.
956 ;; Try several variants of specified name.
957 ;; Try upcasing, appending `.info', or both.
972 dirs-done)))
982 file)
994 ;; Distinguish the dir file that comes with Emacs from all the
995 ;; others. Yes, that is really what this is supposed to do.
996 ;; The definition of `Info-directory-list' puts it first on that
997 ;; list and so last in `buffers' at this point.
1001 ;; Insert the entire original dir file as a start; note that we've
1002 ;; already saved its default directory to use as the default
1003 ;; directory for the whole concatenation.
1006 ;; Look at each of the other buffers one by one.
1009 ;; In each, find all the menus.
1012 ;; Find each menu, and add an elt to NODES for it.
1016 nodename end)
1028 ;; Add to the main menu a menu item for each other node.
1040 end t)
1044 ;; Now take each node of each of the other buffers
1045 ;; and merge it into the main buffer.
1050 ;; Find the like-named node in the main buffer.
1054 nil t)
1059 ;; If none exists, add one.
1062 ;; Merge the text from the other buffer's menu
1063 ;; into the menu in the like-named node in the main buffer.
1066 ;; Kill all the buffers we just made, including the special one excised.
1086 ;; Remove duplicate headings in the same menu.
1089 ;; Look for the next heading to unify.
1094 ;; Check whether this heading should be streamlined.
1104 ;; Look for other headings of the same category and merge them.
1110 ;; Delete redundant heading.
1112 ;; Push the entries onto `text'.
1119 ;; Insert the entries just found.
1127 ;; Now remove duplicate entries under the same heading.
1140 ;; Note that on entry to this function the current-buffer must be the
1141 ;; *info* buffer; not the info tags buffer.
1143 ;; NODEPOS is either a position (in the Info file as a whole,
1144 ;; not relative to a subfile) or the name of a subfile.
1146 lastfilename)
1158 thisfilepos thisfilename)
1162 ;; read in version 19 stops at the end of number.
1163 ;; Advance to the next line.
1172 ;; Assume previous buffer is in Info-mode.
1173 ;; (set-buffer (get-buffer "*info*"))
1182 ;; Widen in case we are in the same subfile as before.
1192 "Unescape double quotes and backslashes in VALUE."
1198 unquote))
1200 ;; As of Texinfo 4.6, makeinfo writes constructs like
1201 ;; \0\h[image param=value ...\h\0]
1202 ;; into the Info file for handling images.
1205 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1206 whitespace or double quotes, it must be quoted in double quotes and
1211 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1212 parameter-string start)
1218 parameter-alist))
1219 parameter-alist))
1222 "Display images in current node."
1229 nil t)
1244 ;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1245 ;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1246 ;; including one optional trailing newline.
1248 "Hide unrecognised cookies in current node."
1255 nil t)
1262 "Select the info node that point is in."
1263 ;; Bind this in case the user sets it to nil.
1266 ;; Find beginning of node.
1272 ;; Get nodename spelled as it is in the node.
1280 ;; Find the end of it, and narrow.
1283 ;; Narrow to the node contents
1295 ;; Add a new unique history item to full history list
1312 Info-current-file
1314 ") "
1316 \f
1317 ;; Go to an info node specified with a filename-and-nodename string
1318 ;; of the sort that is found in pointers in nodes.
1320 ;;;###autoload
1322 "Go to info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1323 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1324 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1325 its sub-files).
1326 Completion is available, but only for node names in the current Info file.
1327 If FORK is non-nil (interactively with a prefix arg), show the node in
1328 a new info buffer.
1329 If FORK is a string, it is the name to use for the new buffer."
1337 nodename)
1339 ""
1352 ;; This function is used as the "completion table" while reading a node name.
1353 ;; It does completion using the alist in Info-read-node-completion-table
1354 ;; unless STRING starts with an open-paren.
1357 ;; First complete embedded file names.
1372 ;; If a file name was given, then any node is fair game.
1378 ;; Otherwise use Info-read-node-completion-table.
1393 nodename)))
1398 ;; Bind this in case the user sets it to nil.
1411 compl))))
1414 ;; If the buffer begins with a node header, process that first.
1417 ;; Now for the rest of the nodes.
1425 compl))))))))
1428 \f
1430 "If this node has been visited, restore the point value when we left."
1433 ;; Use string-equal, not equal, to ignore text props.
1439 \f
1447 "Search for REGEXP, starting from point, and select node it's found in.
1448 If DIRECTION is `backward', search in the reverse direction."
1474 Info-search-whitespace-regexp)))
1480 ;; Hide Info file header for backward search
1491 ;; Skip node header line
1500 ;; If no subfiles, give error now.
1510 ;; Try other subfiles.
1521 ;; Find the subfile we just searched.
1523 ;; Skip that one.
1525 ;; Make a list of all following subfiles.
1526 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1535 list))
1539 ;; Put in forward order
1545 ;; Hide Info file header for backward search
1559 ;; Skip node header line
1584 ;; Search landed in the same node
1590 ;; Use string-equal, not equal, to ignore text props.
1595 Info-history))))))
1598 "Search for a regexp case-sensitively."
1604 "Search for next regexp from a previous `Info-search' command."
1612 "Search for REGEXP in the reverse direction."
1652 \f
1654 "Extract the value of the node-pointer named NAME.
1655 If there is none, use ERRORNAME in the error message;
1656 if ERRORNAME is nil, just return nil."
1657 ;; Bind this in case the user sets it to nil.
1671 "Return a regexp matching a node name.
1672 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1673 saying which chars may appear in the node name.
1674 Submatch 1 is the complete node name.
1675 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1676 Submatch 3 is the local part of the node name.
1677 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1684 ;;; For compatibility; other files have used this name.
1690 "Go to the next node of this node."
1695 "Go to the previous node of this node."
1700 "Go to the superior node of this node.
1701 If SAME-FILE is non-nil, do not move to a different Info file."
1718 nil t))
1724 "Go back to the last node visited."
1737 ;;;###autoload
1739 "Go to the Info directory node."
1742 \f
1744 "Go to a node with a menu of visited nodes."
1748 p)
1770 "Go to a node with table of contents of the current Info file.
1771 Table of contents is created from the tree structure of menus."
1775 p)
1805 "Insert table of contents with references to nodes."
1817 "Build table of contents from menus of Info FILE and its subfiles."
1822 default-directory))
1825 nodes subfiles)
1837 menu-items)
1846 bound))
1849 ;; Menu item line
1859 ;; Other non-empty strings in the Top node are section names
1868 nodes))
1877 subfiles)))))
1879 main-file nil))
1883 \f
1885 "Follow cross reference named FOOTNOTENAME to the node it refers to.
1886 FOOTNOTENAME may be an abbreviation of the reference name.
1887 If FORK is non-nil (interactively with a prefix arg), show the node in
1888 a new info buffer. If FORK is a string, it is the name to use for the
1889 new buffer."
1895 ;; Store end and beginning of line.
1904 ;; See if this one should be the default.
1909 ;; See if this one should be the alternate default.
1919 ;; Record as a completion and perhaps as default.
1922 ;; Don't add this string if it's a duplicate.
1925 ;; If no good default was found, try an alternate.
1928 ;; If only one cross-reference found, then make it default.
1934 "Follow reference named: (default "
1937 completions nil t)))
1951 ;; Move point to the beginning of reference if point is on reference
1961 ;; Go to the reference closest to point
1969 next-ref prev-ref))
1980 ;; We allow newline because this is also used in Info-follow-reference,
1981 ;; where the xref name might be wrapped over two lines.
1982 "Regexp that matches a menu entry name upto but not including the colon.
1983 Because of ambiguities, this should be concatenated with something like
2003 ;;; Uncomment next line to use names of cross-references in non-index nodes:
2004 ;;; (setq Info-point-loc
2005 ;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2006 )
2010 ;; If the node name is the menu entry name (using `entry::').
2013 ;; No one calls this.
2014 ;;(defun Info-menu-item-sequence (list)
2015 ;; (while list
2016 ;; (Info-menu (car list))
2017 ;; (setq list (cdr list))))
2029 ;; This uses two dynamically bound variables:
2030 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2031 ;; is the menu of items we're trying to complete.
2032 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2033 ;; also look for menu items in subsequent nodes as long as those
2034 ;; nodes' names match `Info-complete-next-re'. This feature is currently
2035 ;; not used.
2036 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2037 ;; also look for menu items in these nodes. This feature is currently
2038 ;; only used for completion in Info-index.
2040 ;; Note that `Info-complete-menu-buffer' could be current already,
2041 ;; so we want to save point.
2047 nextnode)
2056 completions)
2057 ;; Check the cache.
2065 ;; We can reuse the previous list.
2067 ;; The cache can't be used.
2072 completions))
2073 ;; Check subsequent nodes if applicable.
2081 ;; Go back to the start node (for the next completion).
2084 ;; Update the cache.
2087 Info-complete-next-re string completions
2088 Info-complete-nodes)))
2095 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2096 The menu item should one of those listed in the current node's menu.
2097 Completion is allowed, and the default menu item is the one point is on.
2098 If FORK is non-nil (interactively with a prefix arg), show the node in
2099 a new info buffer. If FORK is a string, it is the name to use for the
2100 new buffer."
2103 ;; If point is within a menu item, use that item as the default
2106 beg
2119 Info-menu-entry-name-re
2128 default)
2131 ;; we rely on the fact that completing-read accepts an input
2132 ;; of "" even when the require-match argument is true and ""
2133 ;; is not a valid possibility
2137 ;; ask again
2140 ;; there is a problem here in that if several menu items have the same
2141 ;; name you can only go to the node of the first with this command.
2159 ;; If COUNT is nil, use the last item in the menu.
2171 nil))
2175 "Go to the node of the Nth menu item.
2176 N is the digit argument used to invoke this command."
2183 "Go to the Top node of this file."
2188 "Go to the final node in this file."
2193 ;; Go to the last node in the menu of Top.
2195 ;; If the last node in the menu is not last in pointer structure,
2196 ;; move forward until we can't go any farther.
2198 ;; Then keep moving down to last subnode, unless we reach an index.
2204 "Go forward one node, considering all nodes as forming one sequence."
2209 ;; three possibilities, in order of priority:
2210 ;; 1. next node is in a menu in this node (but not in an index)
2211 ;; 2. next node is next at same level
2212 ;; 3. next node is up and next
2217 t)
2220 t)
2222 ;; Use string-equal, not equal, to ignore text props.
2235 "Go backward one node, considering all nodes as forming one sequence."
2243 ;; Use string-equal, not equal,
2244 ;; to ignore text properties.
2249 ;; If we move back at the same level,
2250 ;; go down to find the last subnode*.
2260 "Exit Info by selecting some other buffer."
2267 "Go to the node of the next menu item."
2269 ;; Bind this in case the user sets it to nil.
2281 "Go to the node of the previous menu item."
2285 ;; Bind this in case the user sets it to nil.
2300 "Go to the next subnode or the next node, or go up a level."
2305 ;; Since we have already gone thru all the items in this menu,
2306 ;; go up to the end of this node.
2308 ;; Since logically we are done with the node with that menu,
2309 ;; move on from it.
2315 "Go to the last node, popping up a level if there is none."
2319 ;; If we go down a menu item, go to the end of the node
2320 ;; so we can scroll back through it.
2322 ;; Keep going down, as long as there are nested menu nodes.
2325 ;; If we go down a menu item, go to the end of the node
2326 ;; so we can scroll back through it.
2336 ;; If we go down a menu item, go to the end of the node
2337 ;; so we can scroll back through it.
2348 "Scroll one screenful forward in Info, considering all nodes as one sequence.
2349 Once you scroll far enough in a node that its menu appears on the screen
2350 but after point, the next scroll moves into its first subnode, unless
2351 `Info-scroll-prefer-subnodes' is nil.
2353 When you scroll past the end of a node, that goes to the next node if
2354 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2355 if this node has no successor, it moves to the parent node's successor,
2356 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2357 the menu of a node, it moves to subnode indicated by the following menu
2358 item. (That case won't normally result from this command, but can happen
2359 in other ways.)"
2381 "Scroll one screenful back in Info, considering all nodes as one sequence.
2382 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2383 is non-nil, this goes to its last subnode. When you scroll past the
2384 beginning of a node, that goes to the previous node or back up to the
2385 parent node."
2399 current-point
2400 t)))))
2407 "Move cursor to the next cross-reference or menu item in the node."
2427 "Move cursor to the previous cross-reference or menu item in the node."
2444 \f
2446 "Alist of cached index node names of visited Info files.
2450 "Return a list of names of all index nodes in Info FILE.
2451 If FILE is omitted, it defaults to the current Info file.
2452 First look in a list of cached index node names. Then scan Info
2453 file and its subfiles for nodes with the index cookie. Then try
2454 to find index nodes starting from the first node in the top level
2459 ;; Skip virtual Info files
2463 ;; Find nodes with index cookie
2467 default-directory))
2468 Info-history Info-history-list Info-fontify-maximum-menu-size
2488 subfiles)))))
2490 main-file nil))
2496 nodes)
2497 ;; Find nodes with the word "Index" in the node name
2499 Info-history Info-history-list Info-fontify-maximum-menu-size
2500 nodes node)
2518 nodes)
2519 ;; If file has no index nodes, still add it to the cache
2524 "Return non-nil value if NODE is an index node.
2525 If NODE is nil, check the current Info node.
2526 If FILE is nil, check the current Info file."
2530 ;; Don't search all index nodes if request is only for the current node
2531 ;; and file is not in the cache of index nodes
2545 "Go to the first index node."
2550 ;;;###autoload
2552 "Look up a string TOPIC in the index for this file.
2553 If there are no exact matches to the specified topic, this chooses
2554 the first match which is a case-insensitive substring of a topic.
2556 Give a blank topic name to go to the Index node itself."
2572 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2581 ;; We bind Info-history to nil for internal node-switches so
2582 ;; that we don't put junk in the history. In the first
2583 ;; Info-goto-index call, above, we do update the history
2584 ;; because that is what the user's previous node choice into it.
2586 found)
2593 Info-current-node
2596 matches))
2603 ;; Here it is a feature that assoc is case-sensitive.
2633 "(`,' tries to find next)"
2637 "Move point to the place within the current node where NAME is defined."
2642 ;; Find a function definition with a return type.
2650 nil t))
2652 ;; Try again without the " <1>" makeinfo can append
2658 ;;;###autoload
2660 "Grovel indices of all known Info files on your system for STRING.
2661 Build a menu of the possible matches."
2664 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
2670 manuals matches node nodes)
2698 Info-history-list ohist-list)
2719 "Make command be undefined in Info."
2724 "Enter the Info tutorial."
2729 "Help-Small-Screen"
2733 "Display a brief summary of all Info commands."
2748 flag))
2751 \f
2753 "Return the token around POS.
2754 POS must be somewhere inside the token
2755 START is a regular expression which will match the
2756 beginning of the tokens delimited string
2757 ALL is a regular expression with a single
2758 parenthesized subpattern which is the token to be
2759 returned. E.g. '{\(.*\)}' would return any string
2760 enclosed in braces around POS.
2761 ERRORSTRING optional fourth argument, controls action on no match
2762 nil: return nil
2763 t: beep
2764 a string: signal an error, using that string."
2768 ;; First look for a match for START that goes across POS.
2772 ;; If we did not find one, search back for START
2773 ;; (this finds only matches that end at or before POS).
2786 nil)
2789 nil)
2795 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
2796 At end of the node's text, moves to the next node, or up if none."
2804 "Follow a node reference near point.
2805 If point is on a reference, follow that reference. Otherwise,
2806 if point is in a menu item description, follow that menu item."
2818 t)))
2821 ;; Common subroutine.
2823 "Follow a node reference near point. Return non-nil if successful."
2833 ;; menu item: node name
2836 ;; menu item: node name or index entry
2850 node))
2851 \f
2855 nil
2864 (define-key Info-mode-map "1" 'Info-nth-menu-item)
2865 (define-key Info-mode-map "2" 'Info-nth-menu-item)
2866 (define-key Info-mode-map "3" 'Info-nth-menu-item)
2867 (define-key Info-mode-map "4" 'Info-nth-menu-item)
2868 (define-key Info-mode-map "5" 'Info-nth-menu-item)
2869 (define-key Info-mode-map "6" 'Info-nth-menu-item)
2870 (define-key Info-mode-map "7" 'Info-nth-menu-item)
2871 (define-key Info-mode-map "8" 'Info-nth-menu-item)
2872 (define-key Info-mode-map "9" 'Info-nth-menu-item)
2873 (define-key Info-mode-map "0" 'undefined)
2874 (define-key Info-mode-map "?" 'Info-summary)
2875 (define-key Info-mode-map "]" 'Info-forward-node)
2876 (define-key Info-mode-map "[" 'Info-backward-node)
2877 (define-key Info-mode-map "<" 'Info-top-node)
2878 (define-key Info-mode-map ">" 'Info-final-node)
2879 (define-key Info-mode-map "b" 'beginning-of-buffer)
2880 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
2881 (define-key Info-mode-map "d" 'Info-directory)
2882 (define-key Info-mode-map "e" 'Info-edit)
2883 (define-key Info-mode-map "f" 'Info-follow-reference)
2884 (define-key Info-mode-map "g" 'Info-goto-node)
2885 (define-key Info-mode-map "h" 'Info-help)
2886 (define-key Info-mode-map "i" 'Info-index)
2887 (define-key Info-mode-map "l" 'Info-last)
2888 (define-key Info-mode-map "L" 'Info-history)
2889 (define-key Info-mode-map "m" 'Info-menu)
2890 (define-key Info-mode-map "n" 'Info-next)
2891 (define-key Info-mode-map "p" 'Info-prev)
2892 (define-key Info-mode-map "q" 'Info-exit)
2893 (define-key Info-mode-map "s" 'Info-search)
2894 (define-key Info-mode-map "S" 'Info-search-case-sensitively)
2895 ;; For consistency with Rmail.
2896 (define-key Info-mode-map "\M-s" 'Info-search)
2897 (define-key Info-mode-map "\M-n" 'clone-buffer)
2898 (define-key Info-mode-map "t" 'Info-top-node)
2899 (define-key Info-mode-map "T" 'Info-toc)
2900 (define-key Info-mode-map "u" 'Info-up)
2901 ;; For consistency with dired-copy-filename-as-kill.
2902 (define-key Info-mode-map "w" 'Info-copy-current-node-name)
2903 (define-key Info-mode-map "," 'Info-index-next)
2905 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
2906 )
2908 (defun Info-check-pointer (item)
2909 "Non-nil if ITEM is present in this node."
2910 (condition-case nil
2911 (Info-extract-pointer item)
2912 (error nil)))
2914 (easy-menu-define
2915 Info-mode-menu Info-mode-map
2916 "Menu for info files."
2917 '("Info"
2918 ["Up" Info-up :active (Info-check-pointer "up")
2919 :help "Go up in the Info tree"]
2920 ["Next" Info-next :active (Info-check-pointer "next")
2921 :help "Go to the next node"]
2922 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
2923 :help "Go to the previous node"]
2924 ["Backward" Info-backward-node
2925 :help "Go backward one node, considering all as a sequence"]
2926 ["Forward" Info-forward-node
2927 :help "Go forward one node, considering all as a sequence"]
2928 ["Beginning" beginning-of-buffer
2929 :help "Go to beginning of this node"]
2930 ["Top" Info-top-node
2931 :help "Go to top node of file"]
2932 ["Final Node" Info-final-node
2933 :help "Go to final node in this file"]
2934 ("Menu Item" ["You should never see this" report-emacs-bug t])
2935 ("Reference" ["You should never see this" report-emacs-bug t])
2936 ["Search..." Info-search
2937 :help "Search for regular expression in this Info file"]
2938 ["Search Case-Sensitively..." Info-search-case-sensitively
2939 :help "Search for regular expression case sensitively"]
2940 ["Search Next" Info-search-next
2941 :help "Search for another occurrence of regular expression"]
2942 ["Go to Node..." Info-goto-node
2943 :help "Go to a named node"]
2944 ["Last" Info-last :active Info-history
2945 :help "Go to the last node you were at"]
2946 ["History" Info-history :active Info-history-list
2947 :help "Go to menu of visited nodes"]
2948 ["Table of Contents" Info-toc
2949 :help "Go to table of contents"]
2950 ("Index..."
2951 ["Lookup a String" Info-index
2952 :help "Look for a string in the index items"]
2953 ["Next Matching Item" Info-index-next
2954 :help "Look for another occurrence of previous item"]
2955 ["Lookup a string in all indices" info-apropos
2956 :help "Look for a string in the indices of all manuals"])
2957 ["Edit" Info-edit :help "Edit contents of this node"
2958 :active Info-enable-edit]
2959 ["Copy Node Name" Info-copy-current-node-name
2960 :help "Copy the name of the current node into the kill ring"]
2961 ["Clone Info buffer" clone-buffer
2962 :help "Create a twin copy of the current Info buffer."]
2963 ["Exit" Info-exit :help "Stop reading Info"]))
2966 (defvar info-tool-bar-map
2967 (if (display-graphic-p)
2968 (let ((map (make-sparse-keymap)))
2969 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
2970 (tool-bar-local-item-from-menu 'Info-prev "left_arrow" map Info-mode-map)
2971 (tool-bar-local-item-from-menu 'Info-next "right_arrow" map Info-mode-map)
2972 (tool-bar-local-item-from-menu 'Info-up "up_arrow" map Info-mode-map)
2973 (tool-bar-local-item-from-menu 'Info-last "undo" map Info-mode-map)
2974 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
2975 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
2976 (tool-bar-local-item-from-menu 'Info-goto-node "jump_to" map Info-mode-map)
2977 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
2978 map)))
2980 (defvar Info-menu-last-node nil)
2981 ;; Last node the menu was created for.
2982 ;; Value is a list, (FILE-NAME NODE-NAME).
2984 (defun Info-menu-update ()
2985 "Update the Info menu for the current node."
2986 (condition-case nil
2987 (if (or (not (eq major-mode 'Info-mode))
2988 (equal (list Info-current-file Info-current-node)
2989 Info-menu-last-node))
2990 ()
2991 ;; Update menu menu.
2992 (let* ((Info-complete-menu-buffer (current-buffer))
2993 (items (nreverse (condition-case nil
2994 (Info-complete-menu-item "" nil t)
2995 (error nil))))
2996 entries current
2997 (number 0))
2998 (while (and items (< number 9))
2999 (setq current (car items)
3000 items (cdr items)
3001 number (1+ number))
3002 (setq entries (cons `[,current
3003 (Info-menu ,current)
3004 :keys ,(format "%d" number)]
3005 entries)))
3006 (if items
3007 (setq entries (cons ["Other..." Info-menu t] entries)))
3008 (or entries
3009 (setq entries (list ["No menu" nil nil] nil :active)))
3010 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
3011 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3012 (let ((items nil)
3013 str i entries current
3014 (number 0)
3015 (case-fold-search t))
3016 (save-excursion
3017 (goto-char (point-min))
3019 (setq str (match-string 1))
3020 (setq i 0)
3022 (setq str (concat (substring str 0 i) " "
3023 (substring str (match-end 0))))
3024 (setq i (1+ i)))
3025 (setq items
3026 (cons str items))))
3027 (while (and items (< number 9))
3028 (setq current (car items)
3029 items (cdr items)
3030 number (1+ number))
3031 (setq entries (cons `[,current
3032 (Info-follow-reference ,current)
3033 t]
3034 entries)))
3035 (if items
3036 (setq entries (cons ["Other..." Info-follow-reference t]
3037 entries)))
3038 (or entries
3039 (setq entries (list ["No references" nil nil] nil :active)))
3040 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3041 ;; Update last seen node.
3042 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
3043 ;; Try to avoid entering infinite beep mode in case of errors.
3044 (error (ding))))
3046 \f
3047 (defun Info-copy-current-node-name (&optional arg)
3048 "Put the name of the current info node into the kill ring.
3049 The name of the info file is prepended to the node name in parentheses.
3050 With a zero prefix arg, put the name inside a function call to `info'."
3051 (interactive "P")
3052 (unless Info-current-node
3053 (error "No current info node"))
3054 (let ((node (concat "(" (file-name-nondirectory
3055 (or (and (stringp Info-current-file)
3056 Info-current-file)
3057 buffer-file-name
3058 ""))
3059 ")" Info-current-node)))
3060 (if (zerop (prefix-numeric-value arg))
3062 (kill-new node)
3063 (message "%s" node)))
3065 \f
3066 ;; Info mode is suitable only for specially formatted data.
3067 (put 'Info-mode 'mode-class 'special)
3068 (put 'Info-mode 'no-clone-indirect t)
3070 (defun Info-mode ()
3071 "Info mode provides commands for browsing through the Info documentation tree.
3073 one topic and contains references to other nodes which discuss related
3074 topics. Info has commands to follow the references and show you other nodes.
3080 Selecting other nodes:
3082 Follow a node reference you click on.
3083 This works with menu items, cross references, and
3085 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
3090 Picking a menu item causes another node to be selected.
3101 \\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
3104 Moving within a node:
3106 Once you scroll far enough in a node that its menu appears on the
3107 screen but after point, the next scroll moves into its first
3108 subnode. When after all menu items (or if there is no menu),
3109 move up to the parent node.
3111 already visible, try to go to the previous menu entry, or up
3112 if there is none.
3115 Advanced commands:
3119 1 .. 9 Pick first ... ninth item in node's menu.
3120 Every third `*' is highlighted to help pick the right number.
3122 You may include a filename as well, as (FILENAME)NODENAME.
3126 and select the node in which the next occurrence is found.
3127 \\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
3132 (kill-all-local-variables)
3133 (setq major-mode 'Info-mode)
3134 (setq mode-name "Info")
3135 (setq tab-width 8)
3136 (use-local-map Info-mode-map)
3137 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
3138 (set-syntax-table text-mode-syntax-table)
3139 (setq local-abbrev-table text-mode-abbrev-table)
3140 (setq case-fold-search t)
3141 (setq buffer-read-only t)
3142 (make-local-variable 'Info-current-file)
3143 (make-local-variable 'Info-current-subfile)
3144 (make-local-variable 'Info-current-node)
3145 (make-local-variable 'Info-tag-table-marker)
3146 (setq Info-tag-table-marker (make-marker))
3147 (make-local-variable 'Info-tag-table-buffer)
3148 (setq Info-tag-table-buffer nil)
3149 (make-local-variable 'Info-history)
3150 (make-local-variable 'Info-index-alternatives)
3151 (setq header-line-format
3152 (if Info-use-header-line
3153 '(:eval (get-text-property (point-min) 'header-line))
3154 nil)) ; so the header line isn't displayed
3155 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
3156 ;; This is for the sake of the invisible text we use handling titles.
3157 (make-local-variable 'line-move-ignore-invisible)
3158 (setq line-move-ignore-invisible t)
3159 (make-local-variable 'desktop-save-buffer)
3160 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
3161 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
3162 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
3163 (set (make-local-variable 'isearch-search-fun-function)
3164 'Info-isearch-search)
3165 (set (make-local-variable 'isearch-wrap-function)
3166 'Info-isearch-wrap)
3167 (set (make-local-variable 'isearch-push-state-function)
3168 'Info-isearch-push-state)
3169 (set (make-local-variable 'search-whitespace-regexp)
3170 Info-search-whitespace-regexp)
3171 (Info-set-mode-line)
3172 (run-hooks 'Info-mode-hook))
3174 (defun Info-clone-buffer-hook ()
3175 (when (bufferp Info-tag-table-buffer)
3176 (setq Info-tag-table-buffer
3177 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3178 (let ((m Info-tag-table-marker))
3179 (when (markerp m)
3180 (setq Info-tag-table-marker
3181 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
3182 (with-current-buffer Info-tag-table-buffer
3183 (copy-marker (marker-position m)))
3184 (make-marker))))))
3186 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
3187 (set-keymap-parent map text-mode-map)
3188 (define-key map "\C-c\C-c" 'Info-cease-edit)
3189 map)
3190 "Local keymap used within `e' command of Info.")
3192 ;; Info-edit mode is suitable only for specially formatted data.
3193 (put 'Info-edit-mode 'mode-class 'special)
3195 (defun Info-edit-mode ()
3196 "Major mode for editing the contents of an Info node.
3197 Like text mode with the addition of `Info-cease-edit'
3198 which returns to Info mode for browsing.
3200 (use-local-map Info-edit-map)
3201 (setq major-mode 'Info-edit-mode)
3202 (setq mode-name "Info Edit")
3203 (kill-local-variable 'mode-line-buffer-identification)
3204 (setq buffer-read-only nil)
3205 (force-mode-line-update)
3206 (buffer-enable-undo (current-buffer))
3207 (run-hooks 'Info-edit-mode-hook))
3209 (defun Info-edit ()
3210 "Edit the contents of this Info node.
3211 Allowed only if variable `Info-enable-edit' is non-nil."
3212 (interactive)
3213 (or Info-enable-edit
3214 (error "Editing info nodes is not enabled"))
3215 (Info-edit-mode)
3216 (message "%s" (substitute-command-keys
3219 (defun Info-cease-edit ()
3220 "Finish editing Info node; switch back to Info proper."
3221 (interactive)
3222 ;; Do this first, so nothing has changed if user C-g's at query.
3223 (and (buffer-modified-p)
3224 (y-or-n-p "Save the file? ")
3225 (save-buffer))
3226 (use-local-map Info-mode-map)
3227 (setq major-mode 'Info-mode)
3228 (setq mode-name "Info")
3229 (Info-set-mode-line)
3230 (setq buffer-read-only t)
3231 (force-mode-line-update)
3232 (and (marker-position Info-tag-table-marker)
3233 (buffer-modified-p)
3234 (message "Tags may have changed. Use Info-tagify if necessary")))
3235 \f
3236 (defvar Info-file-list-for-emacs
3237 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
3238 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3239 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3240 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
3241 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3242 ("copyright" . "autotype") ("executable" . "autotype")
3243 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3244 ("tempo" . "autotype") ("hippie-expand" . "autotype")
3245 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3246 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
3247 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3248 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3249 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3250 ("rfc2045" . "emacs-mime")
3251 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
3252 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
3253 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
3254 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
3255 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
3256 ("mml" . "emacs-mime"))
3257 "List of Info files that describe Emacs commands.
3258 An element can be a file name, or a list of the form (PREFIX . FILE)
3259 where PREFIX is a name prefix and FILE is the file to look in.
3260 If the element is just a file name, the file name also serves as the prefix.")
3262 (defun Info-find-emacs-command-nodes (command)
3263 "Return a list of locations documenting COMMAND.
3264 The `info-file' property of COMMAND says which Info manual to search.
3265 If COMMAND has no property, the variable `Info-file-list-for-emacs'
3266 defines heuristics for which Info manual to try.
3267 The locations are of the format used in `Info-history', i.e.
3268 \(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
3269 in the first element of the returned list (which is treated specially in
3270 `Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
3271 (let ((where '()) line-number
3275 (info-file "emacs")) ;default
3276 ;; Determine which info file this command is documented in.
3277 (if (get command 'info-file)
3278 (setq info-file (get command 'info-file))
3279 ;; If it doesn't say explicitly, test its name against
3280 ;; various prefixes that we know.
3281 (let ((file-list Info-file-list-for-emacs))
3282 (while file-list
3283 (let* ((elt (car file-list))
3284 (name (if (consp elt)
3285 (car elt)
3286 elt))
3287 (file (if (consp elt) (cdr elt) elt))
3288 (case-fold-search nil)
3291 (if (string-match regexp (symbol-name command))
3292 (setq info-file file file-list nil))
3293 (setq file-list (cdr file-list))))))
3294 (Info-find-node info-file "Top")
3297 (error "Info file `%s' appears to lack an index" info-file))
3298 (goto-char (match-beginning 1))
3299 ;; Bind Info-history to nil, to prevent the index nodes from
3300 ;; getting into the node history.
3301 (let ((Info-history nil)
3302 (Info-history-list nil)
3303 node (nodes (Info-index-nodes)))
3304 (Info-goto-node (car nodes))
3305 (while
3306 (progn
3307 (goto-char (point-min))
3308 (while (re-search-forward cmd-desc nil t)
3309 (setq where
3310 (cons (list Info-current-file
3311 (match-string-no-properties 2)
3312 0)
3313 where))
3314 (setq line-number (and (match-beginning 3)
3315 (string-to-number (match-string 3)))))
3316 (and (setq nodes (cdr nodes) node (car nodes))))
3317 (Info-goto-node node)))
3318 (if (and line-number where)
3319 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
3320 (cdr where))
3321 where)))
3323 ;;;###autoload (put 'Info-goto-emacs-command-node 'info-file "emacs")
3324 ;;;###autoload
3325 (defun Info-goto-emacs-command-node (command)
3326 "Go to the Info node in the Emacs manual for command COMMAND.
3327 The command is found by looking up in Emacs manual's indices
3328 or in another manual found via COMMAND's `info-file' property or
3329 the variable `Info-file-list-for-emacs'.
3330 COMMAND must be a symbol or string."
3331 (interactive "CFind documentation for command: ")
3332 ;; If command is given as a string, convert it to a symbol.
3333 (if (stringp command)
3334 (setq command (intern command)))
3335 (or (commandp command)
3336 (signal 'wrong-type-argument (list 'commandp command)))
3337 (let ((where (Info-find-emacs-command-nodes command)))
3338 (if where
3339 (let ((num-matches (length where)))
3340 ;; Get Info running, and pop to it in another window.
3341 (save-window-excursion
3342 (info))
3343 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
3344 ;; Bind Info-history to nil, to prevent the last Index node
3345 ;; visited by Info-find-emacs-command-nodes from being
3346 ;; pushed onto the history.
3347 (let ((Info-history nil) (Info-history-list nil)
3348 (line-number (nth 2 (car where))))
3349 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
3350 (if (and (integerp line-number) (> line-number 0))
3351 (forward-line (1- line-number))))
3352 (if (> num-matches 1)
3353 (progn
3354 ;; (car where) will be pushed onto Info-history
3355 ;; when/if they go to another node. Put the other
3356 ;; nodes that were found on the history.
3357 (setq Info-history (nconc (cdr where) Info-history))
3358 (message "Found %d other entr%s. Use %s to see %s."
3359 (1- num-matches)
3360 (if (> num-matches 2) "ies" "y")
3362 (if (> num-matches 2) "them" "it")))))
3363 (error "Couldn't find documentation for %s" command))))
3365 ;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file "emacs")
3366 ;;;###autoload
3367 (defun Info-goto-emacs-key-command-node (key)
3368 "Go to the node in the Emacs manual which describes the command bound to KEY.
3369 KEY is a string.
3370 Interactively, if the binding is `execute-extended-command', a command is read.
3371 The command is found by looking up in Emacs manual's indices
3372 or in another manual found via COMMAND's `info-file' property or
3373 the variable `Info-file-list-for-emacs'."
3374 (interactive "kFind documentation for key: ")
3375 (let ((command (key-binding key)))
3376 (cond ((null command)
3377 (message "%s is undefined" (key-description key)))
3378 ((and (interactive-p)
3379 (eq command 'execute-extended-command))
3380 (Info-goto-emacs-command-node
3381 (read-command "Find documentation for command: ")))
3382 (t
3383 (Info-goto-emacs-command-node command)))))
3384 \f
3385 (defface Info-title-1-face
3386 '((((type tty pc) (class color)) :foreground "yellow" :weight bold)
3387 (t :height 1.2 :inherit Info-title-2-face))
3388 "Face for Info titles at level 1."
3389 :group 'info)
3391 (defface Info-title-2-face
3392 '((((type tty pc) (class color)) :foreground "lightblue" :weight bold)
3393 (t :height 1.2 :inherit Info-title-3-face))
3394 "Face for Info titles at level 2."
3395 :group 'info)
3397 (defface Info-title-3-face
3398 '((((type tty pc) (class color)) :weight bold)
3399 (t :height 1.2 :inherit Info-title-4-face))
3400 "Face for Info titles at level 3."
3401 :group 'info)
3403 (defface Info-title-4-face
3404 '((((type tty pc) (class color)) :weight bold)
3405 (t :weight bold :inherit variable-pitch))
3406 "Face for Info titles at level 4."
3407 :group 'info)
3409 (defface info-menu-header
3410 '((((type tty pc))
3411 :underline t
3412 :weight bold)
3413 (t
3414 :inherit variable-pitch
3415 :weight bold))
3416 "Face for headers in Info menus."
3417 :group 'info)
3419 (defun Info-escape-percent (string)
3420 "Double all occurrences of `%' in STRING.
3422 Return a new string with all `%' characters replaced by `%%'.
3423 Preserve text properties."
3424 (let ((start 0)
3425 (end (length string))
3426 mb me m matches)
3427 (save-match-data
3428 (while (and (< start end) (string-match "%" string start))
3429 (setq mb (match-beginning 0)
3430 me (1+ mb)
3431 m (substring string mb me)
3432 matches (cons m
3433 (cons m
3434 (cons (substring string start mb)
3435 matches)))
3436 start me))
3437 (push (substring string start end) matches)
3438 (apply #'concat (nreverse matches)))))
3440 (defvar Info-next-link-keymap
3441 (let ((keymap (make-sparse-keymap)))
3442 (define-key keymap [header-line mouse-1] 'Info-next)
3443 (define-key keymap [header-line mouse-2] 'Info-next)
3444 (define-key keymap [header-line down-mouse-1] 'ignore)
3445 (define-key keymap [mouse-2] 'Info-next)
3446 keymap)
3447 "Keymap to put on the Next link in the text or the header line.")
3449 (defvar Info-prev-link-keymap
3450 (let ((keymap (make-sparse-keymap)))
3451 (define-key keymap [header-line mouse-1] 'Info-prev)
3452 (define-key keymap [header-line mouse-2] 'Info-prev)
3453 (define-key keymap [header-line down-mouse-1] 'ignore)
3454 (define-key keymap [mouse-2] 'Info-prev)
3455 keymap)
3456 "Keymap to put on the Prev link in the text or the header line.")
3459 (defvar Info-up-link-keymap
3460 (let ((keymap (make-sparse-keymap)))
3461 (define-key keymap [header-line mouse-1] 'Info-up)
3462 (define-key keymap [header-line mouse-2] 'Info-up)
3463 (define-key keymap [header-line down-mouse-1] 'ignore)
3464 (define-key keymap [mouse-2] 'Info-up)
3465 keymap)
3466 "Keymap to put on the Up link in the text or the header line.")
3468 (defun Info-fontify-node ()
3469 "Fontify the node."
3470 (save-excursion
3471 (let* ((inhibit-read-only t)
3472 (case-fold-search t)
3473 paragraph-markers
3474 (not-fontified-p ; the node hasn't already been fontified
3475 (not (let ((where (next-property-change (point-min))))
3476 (and where (not (= where (point-max)))))))
3477 (fontify-visited-p ; visited nodes need to be re-fontified
3478 (and Info-fontify-visited-nodes
3479 ;; Don't take time to refontify visited nodes in huge nodes
3480 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
3481 rbeg rend)
3483 ;; Fontify header line
3484 (goto-char (point-min))
3486 (goto-char (match-end 0))
3488 (goto-char (match-end 0))
3489 (let* ((nbeg (match-beginning 2))
3490 (nend (match-end 2))
3491 (tbeg (match-beginning 1))
3492 (tag (match-string 1)))
3493 (if (string-equal tag "Node")
3494 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
3495 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
3496 (put-text-property tbeg nend 'mouse-face 'highlight)
3497 (put-text-property tbeg nend
3498 'help-echo
3499 (concat "Go to node "
3500 (buffer-substring nbeg nend)))
3501 ;; Always set up the text property keymap.
3502 ;; It will either be used in the buffer
3503 ;; or copied in the header line.
3504 (put-text-property tbeg nend 'keymap
3505 (cond
3506 ((equal tag "Prev") Info-prev-link-keymap)
3507 ((equal tag "Next") Info-next-link-keymap)
3508 ((equal tag "Up") Info-up-link-keymap))))))
3509 (when Info-use-header-line
3510 (goto-char (point-min))
3511 (let ((header-end (line-end-position))
3512 header)
3513 ;; If we find neither Next: nor Prev: link, show the entire
3514 ;; node header. Otherwise, don't show the File: and Node:
3515 ;; parts, to avoid wasting precious space on information that
3516 ;; is available in the mode line.
3517 (if (re-search-forward
3519 header-end t)
3520 (progn
3521 (goto-char (match-beginning 1))
3522 (setq header (buffer-substring (point) header-end)))
3524 (setq header
3525 (concat "No next, prev or up links -- "
3526 (buffer-substring (point) header-end)))
3527 (setq header (buffer-substring (point) header-end))))
3528 (put-text-property (point-min) (1+ (point-min))
3529 'header-line (Info-escape-percent header))
3530 ;; Hide the part of the first line
3531 ;; that is in the header, if it is just part.
3532 (unless (bobp)
3533 ;; Hide the punctuation at the end, too.
3535 (put-text-property (point) header-end 'invisible t)))))
3537 ;; Fontify titles
3538 (goto-char (point-min))
3539 (when not-fontified-p
3541 nil t)
3542 (let* ((c (preceding-char))
3543 (face
3544 (cond ((= c ?*) 'Info-title-1-face)
3545 ((= c ?=) 'Info-title-2-face)
3546 ((= c ?-) 'Info-title-3-face)
3547 (t 'Info-title-4-face))))
3548 (put-text-property (match-beginning 1) (match-end 1)
3549 'font-lock-face face))
3550 ;; This is a serious problem for trying to handle multiple
3551 ;; frame types at once. We want this text to be invisible
3552 ;; on frames that can display the font above.
3553 (when (memq (framep (selected-frame)) '(x pc w32 mac))
3554 (add-text-properties (1- (match-beginning 2)) (match-end 2)
3555 '(invisible t front-sticky nil rear-nonsticky t)))))
3557 ;; Fontify cross references
3558 (goto-char (point-min))
3559 (when (or not-fontified-p fontify-visited-p)
3560 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
3561 (let ((start (match-beginning 0))
3562 (next (point))
3563 other-tag)
3564 (when not-fontified-p
3565 (when Info-hide-note-references
3566 (when (not (eq Info-hide-note-references 'hide))
3567 ;; *Note is often used where *note should have been
3568 (goto-char start)
3569 (skip-syntax-backward " ")
3570 (setq other-tag
3571 (cond ((memq (char-before) '(nil ?\. ?! ??))
3572 "See ")
3573 ((memq (char-before) '(?\, ?\; ?\: ?-))
3574 "see ")
3575 ((memq (char-before) '(?\( ?\[ ?\{))
3576 ;; Check whether the paren is preceded by
3577 ;; an end of sentence
3578 (skip-syntax-backward " (")
3579 (if (memq (char-before) '(nil ?\. ?! ??))
3580 "See "
3581 "see "))
3583 "See "))))
3584 (goto-char next)
3585 (add-text-properties
3586 (match-beginning 1)
3587 (or (save-match-data
3589 (let ((start1 (match-beginning 1)))
3591 (+ start1 (match-beginning 0)))))
3592 (match-end 1))
3593 (if other-tag
3594 `(display ,other-tag front-sticky nil rear-nonsticky t)
3595 '(invisible t front-sticky nil rear-nonsticky t))))
3596 (add-text-properties
3597 (match-beginning 2) (match-end 2)
3598 (list
3599 'help-echo (if (or (match-end 5)
3600 (not (equal (match-string 4) "")))
3601 (concat "mouse-2: go to " (or (match-string 5)
3602 (match-string 4)))
3603 "mouse-2: go to this node")
3604 'mouse-face 'highlight)))
3605 (when (or not-fontified-p fontify-visited-p)
3606 (setq rbeg (match-beginning 2)
3607 rend (match-end 2))
3608 (put-text-property
3609 rbeg rend
3610 'font-lock-face
3611 ;; Display visited nodes in a different face
3612 (if (and Info-fontify-visited-nodes
3613 (save-match-data
3614 (let* ((node (replace-regexp-in-string
3616 (replace-regexp-in-string
3618 (or (match-string 5)
3619 (and (not (equal (match-string 4) ""))
3620 (match-string 4))
3621 (match-string 2)))))
3622 (file (file-name-nondirectory
3623 Info-current-file))
3624 (hl Info-history-list)
3625 res)
3627 (setq file (file-name-nondirectory
3628 (match-string 1 node))
3629 node (if (equal (match-string 2 node) "")
3630 "Top"
3631 (match-string 2 node))))
3632 (while hl
3633 (if (and (string-equal node (nth 1 (car hl)))
3634 (string-equal file
3635 (file-name-nondirectory
3636 (nth 0 (car hl)))))
3637 (setq res (car hl) hl nil)
3638 (setq hl (cdr hl))))
3639 res))) 'info-xref-visited 'info-xref))
3640 ;; For multiline ref, unfontify newline and surrounding whitespace
3641 (save-excursion
3642 (goto-char rbeg)
3643 (save-match-data
3645 (remove-text-properties (match-beginning 0)
3646 (match-end 0)
3647 '(font-lock-face t))))))
3648 (when not-fontified-p
3649 (when (memq Info-hide-note-references '(t hide))
3650 (add-text-properties (match-beginning 3) (match-end 3)
3651 '(invisible t front-sticky nil rear-nonsticky t))
3652 ;; Unhide the file name of the external reference in parens
3653 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
3654 (remove-text-properties (match-beginning 6) (match-end 6)
3655 '(invisible t front-sticky nil rear-nonsticky t)))
3656 ;; Unhide newline because hidden newlines cause too long lines
3657 (save-match-data
3658 (let ((beg3 (match-beginning 3))
3659 (end3 (match-end 3)))
3661 (not (save-match-data
3662 (save-excursion
3663 (goto-char (1+ end3))
3664 (looking-at "[.)]*$")))))
3665 (remove-text-properties (+ beg3 (match-beginning 0))
3666 (+ beg3 (match-end 0))
3667 '(invisible t front-sticky nil rear-nonsticky t))))))
3668 (when (and Info-refill-paragraphs Info-hide-note-references)
3669 (push (set-marker (make-marker) start)
3670 paragraph-markers))))))
3672 ;; Refill paragraphs (experimental feature)
3673 (when (and not-fontified-p
3674 Info-refill-paragraphs
3675 paragraph-markers)
3676 (let ((fill-nobreak-invisible t)
3677 (fill-individual-varying-indent nil)
3680 (adaptive-fill-mode nil))
3681 (goto-char (point-max))
3682 (while paragraph-markers
3683 (let ((m (car paragraph-markers)))
3684 (setq paragraph-markers (cdr paragraph-markers))
3685 (when (< m (point))
3686 (goto-char m)
3687 (beginning-of-line)
3688 (let ((beg (point)))
3689 (when (zerop (forward-paragraph))
3690 (fill-individual-paragraphs beg (point) nil nil)
3691 (goto-char beg))))
3692 (set-marker m nil)))))
3694 ;; Fontify menu items
3695 (goto-char (point-min))
3696 (when (and (or not-fontified-p fontify-visited-p)
3698 (not (Info-index-node))
3699 ;; Don't take time to annotate huge menus
3700 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
3701 (let ((n 0)
3702 cont)
3703 (while (re-search-forward
3706 nil t)
3707 (when not-fontified-p
3708 (setq n (1+ n))
3709 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
3710 (put-text-property (match-beginning 0)
3711 (1+ (match-beginning 0))
3712 'font-lock-face 'info-menu-5)))
3713 (when not-fontified-p
3714 (add-text-properties
3715 (match-beginning 1) (match-end 1)
3716 (list
3717 'help-echo (if (match-end 3)
3718 (concat "mouse-2: go to " (match-string 3))
3719 "mouse-2: go to this node")
3720 'mouse-face 'highlight)))
3721 (when (or not-fontified-p fontify-visited-p)
3722 (add-text-properties
3723 (match-beginning 1) (match-end 1)
3724 (list
3725 'font-lock-face
3726 ;; Display visited menu items in a different face
3727 (if (and Info-fontify-visited-nodes
3728 (save-match-data
3729 (let ((node (if (equal (match-string 3) "")
3730 (match-string 1)
3731 (match-string 3)))
3732 (file (file-name-nondirectory Info-current-file))
3733 (hl Info-history-list)
3734 res)
3736 (setq file (file-name-nondirectory
3737 (match-string 1 node))
3738 node (if (equal (match-string 2 node) "")
3739 "Top"
3740 (match-string 2 node))))
3741 (while hl
3742 (if (and (string-equal node (nth 1 (car hl)))
3743 (string-equal file
3744 (file-name-nondirectory
3745 (nth 0 (car hl)))))
3746 (setq res (car hl) hl nil)
3747 (setq hl (cdr hl))))
3748 res))) 'info-xref-visited 'info-xref))))
3749 (when (and not-fontified-p (memq Info-hide-note-references '(t hide)))
3750 (put-text-property (match-beginning 2) (1- (match-end 6))
3751 'invisible t)
3752 ;; Unhide the file name in parens
3753 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
3754 (remove-text-properties (match-beginning 4) (match-end 4)
3755 '(invisible t)))
3756 ;; We need a stretchable space like :align-to but with
3757 ;; a minimum value.
3758 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3759 (if (>= 22 (- (match-end 1)
3760 (match-beginning 0)))
3761 '(space :align-to 24)
3762 '(space :width 2)))
3763 (setq cont (looking-at "."))
3764 (while (and (= (forward-line 1) 0)
3766 (put-text-property (match-beginning 1) (1- (match-end 1))
3767 'invisible t)
3768 (put-text-property (1- (match-end 1)) (match-end 1)
3769 'display
3770 (if cont
3771 '(space :align-to 26)
3772 '(space :align-to 24)))
3773 (setq cont t))))))
3775 ;; Fontify menu headers
3776 ;; Add the face `info-menu-header' to any header before a menu entry
3777 (goto-char (point-min))
3779 (put-text-property (match-beginning 0) (match-end 0)
3780 'font-lock-face 'info-menu-header)
3782 (put-text-property (match-beginning 1) (match-end 1)
3783 'font-lock-face 'info-menu-header)))
3785 ;; Hide index line numbers
3786 (goto-char (point-min))
3787 (when (and not-fontified-p (Info-index-node))
3789 (put-text-property (match-beginning 0) (match-end 0)
3790 'invisible t)))
3792 ;; Fontify http and ftp references
3793 (goto-char (point-min))
3794 (when not-fontified-p
3796 (add-text-properties (match-beginning 0) (match-end 0)
3797 '(font-lock-face info-xref
3798 mouse-face highlight
3799 help-echo "mouse-2: go to this URL"))))
3801 (set-buffer-modified-p nil))))
3802 \f
3804 ;; When an Info buffer is killed, make sure the associated tags buffer
3805 ;; is killed too.
3806 (defun Info-kill-buffer ()
3807 (and (eq major-mode 'Info-mode)
3808 Info-tag-table-buffer
3809 (kill-buffer Info-tag-table-buffer)))
3811 (add-hook 'kill-buffer-hook 'Info-kill-buffer)
3813 ;;; Speedbar support:
3814 ;; These functions permit speedbar to display the "tags" in the
3815 ;; current info node.
3816 (eval-when-compile (require 'speedbar))
3818 (defvar Info-speedbar-key-map nil
3819 "Keymap used when in the info display mode.")
3821 (defun Info-install-speedbar-variables ()
3822 "Install those variables used by speedbar to enhance Info."
3823 (if Info-speedbar-key-map
3824 nil
3825 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
3827 ;; Basic tree features
3828 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
3829 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
3830 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
3831 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
3832 )
3834 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
3835 Info-speedbar-key-map
3836 Info-speedbar-hierarchy-buttons)))
3838 (defvar Info-speedbar-menu-items
3839 '(["Browse Node" speedbar-edit-line t]
3840 ["Expand Node" speedbar-expand-line
3841 (save-excursion (beginning-of-line)
3843 ["Contract Node" speedbar-contract-line
3844 (save-excursion (beginning-of-line)
3845 (looking-at "[0-9]+: *.-. "))]
3846 )
3847 "Additional menu-items to add to speedbar frame.")
3849 ;; Make sure our special speedbar major mode is loaded
3850 (if (featurep 'speedbar)
3851 (Info-install-speedbar-variables)
3852 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
3854 ;;; Info hierarchy display method
3855 ;;;###autoload
3856 (defun Info-speedbar-browser ()
3857 "Initialize speedbar to display an info node browser.
3858 This will add a speedbar major display mode."
3859 (interactive)
3860 (require 'speedbar)
3861 ;; Make sure that speedbar is active
3862 (speedbar-frame-mode 1)
3863 ;; Now, throw us into Info mode on speedbar.
3864 (speedbar-change-initial-expansion-list "Info")
3865 )
3867 (eval-when-compile (defvar speedbar-attached-frame))
3869 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
3870 "Display an Info directory hierarchy in speedbar.
3871 DIRECTORY is the current directory in the attached frame.
3872 DEPTH is the current indentation depth.
3873 NODE is an optional argument that is used to represent the
3874 specific node to expand."
3875 (if (and (not node)
3876 (save-excursion (goto-char (point-min))
3877 (let ((case-fold-search t))
3878 (looking-at "Info Nodes:"))))
3879 ;; Update our "current node" maybe?
3880 nil
3881 ;; We cannot use the generic list code, that depends on all leaves
3882 ;; being known at creation time.
3883 (if (not node)
3885 (let ((completions nil)
3886 (cf (selected-frame)))
3887 (select-frame speedbar-attached-frame)
3888 (save-window-excursion
3889 (setq completions
3890 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
3891 (select-frame cf)
3892 (if completions
3893 (speedbar-with-writable
3894 (dolist (completion completions)
3895 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
3896 (cdr completion)
3897 (car completion)
3898 'Info-speedbar-goto-node
3899 (cdr completion)
3900 'info-xref depth))
3901 t)
3902 nil))))
3904 (defun Info-speedbar-goto-node (text node indent)
3905 "When user clicks on TEXT, go to an info NODE.
3906 The INDENT level is ignored."
3907 (select-frame speedbar-attached-frame)
3908 (let* ((buff (or (get-buffer "*info*")
3909 (progn (info) (get-buffer "*info*"))))
3910 (bwin (get-buffer-window buff 0)))
3911 (if bwin
3912 (progn
3913 (select-window bwin)
3914 (raise-frame (window-frame bwin)))
3915 (if speedbar-power-click
3916 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
3917 (select-frame speedbar-attached-frame)
3918 (switch-to-buffer buff)))
3920 (error "Invalid node %s" node)
3921 (Info-find-node (match-string 1 node) (match-string 2 node))
3922 ;; If we do a find-node, and we were in info mode, restore
3923 ;; the old default method. Once we are in info mode, it makes
3924 ;; sense to return to whatever method the user was using before.
3925 (if (string= speedbar-initial-expansion-list-name "Info")
3926 (speedbar-change-initial-expansion-list
3927 speedbar-previously-used-expansion-list-name)))))
3929 (defun Info-speedbar-expand-node (text token indent)
3930 "Expand the node the user clicked on.
3931 TEXT is the text of the button we clicked on, a + or - item.
3932 TOKEN is data related to this node (NAME . FILE).
3933 INDENT is the current indentation depth."
3934 (cond ((string-match "+" text) ;we have to expand this file
3935 (speedbar-change-expand-button-char ?-)
3936 (if (speedbar-with-writable
3937 (save-excursion
3938 (end-of-line) (forward-char 1)
3939 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
3940 (speedbar-change-expand-button-char ?-)
3941 (speedbar-change-expand-button-char ??)))
3942 ((string-match "-" text) ;we have to contract this node
3943 (speedbar-change-expand-button-char ?+)
3944 (speedbar-delete-subblock indent))
3945 (t (error "Ooops... not sure what to do")))
3946 (speedbar-center-buffer-smartly))
3948 (defun Info-speedbar-fetch-file-nodes (nodespec)
3949 "Fetch the subnodes from the info NODESPEC.
3950 NODESPEC is a string of the form: (file)node.
3951 Optional THISFILE represends the filename of"
3952 (save-excursion
3953 ;; Set up a buffer we can use to fake-out Info.
3954 (set-buffer (get-buffer-create "*info-browse-tmp*"))
3955 (if (not (equal major-mode 'Info-mode))
3956 (Info-mode))
3957 ;; Get the node into this buffer
3959 (error "Invalid node specification %s" nodespec)
3960 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
3961 ;; Scan the created buffer
3962 (goto-char (point-min))
3963 (let ((completions nil)
3964 (case-fold-search t)
3966 (match-string 1 nodespec))))
3967 ;; Always skip the first one...
3970 (let ((name (match-string 1)))
3971 (push (cons name
3973 (match-string 1)
3975 (concat (match-string 1) "Top")
3976 (concat "(" thisfile ")"
3978 (match-string 1)
3979 name)))))
3980 completions)))
3981 (nreverse completions))))
3983 ;;; Info mode node listing
3984 ;; FIXME: Seems not to be used. -stef
3985 (defun Info-speedbar-buttons (buffer)
3986 "Create a speedbar display to help navigation in an Info file.
3987 BUFFER is the buffer speedbar is requesting buttons for."
3988 (if (save-excursion (goto-char (point-min))
3989 (let ((case-fold-search t))
3990 (not (looking-at "Info Nodes:"))))
3991 (erase-buffer))
3992 (Info-speedbar-hierarchy-buttons nil 0)
3993 )
3995 (dolist (mess '("^Node has no Previous$"
3996 "^No menu in this node$"
3997 "^Node has no Next$"
3998 "^No cross-references in this node^"
3999 search-failed
4001 (add-to-list 'debug-ignored-errors mess))
4003 ;;;; Desktop support
4005 (defun Info-desktop-buffer-misc-data (desktop-dirname)
4006 "Auxiliary information to be saved in desktop file."
4007 (if (not (member Info-current-file '("apropos" "history" "toc")))
4008 (list Info-current-file Info-current-node)))
4010 ;;;###autoload
4011 (defun Info-restore-desktop-buffer (desktop-buffer-file-name
4012 desktop-buffer-name
4013 desktop-buffer-misc)
4014 "Restore an info buffer specified in a desktop file."
4015 (let ((first (nth 0 desktop-buffer-misc))
4016 (second (nth 1 desktop-buffer-misc)))
4017 (when (and first second)
4018 (when desktop-buffer-name
4019 (set-buffer (get-buffer-create desktop-buffer-name))
4020 (Info-mode))
4021 (Info-find-node first second)
4022 (current-buffer))))
4024 (provide 'info)
4026 ;;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
4027 ;;; info.el ends here