| blob | 3438320beb433f78f446d53bf7537883641ab5a2 |
1 ;;; info.el --- info package for Emacs
3 ;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001,
4 ;; 2002, 2003
5 ;; Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Keywords: help
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; Note that nowadays we expect info files to be made using makeinfo.
30 ;; In particular we make these assumptions:
31 ;; - a menu item MAY contain colons but not colon-space ": "
32 ;; - a menu item ending with ": " (but not ":: ") is an index entry
33 ;; - a node name MAY NOT contain a colon
34 ;; This distinction is to support indexing of computer programming
35 ;; language terms that may contain ":" but not ": ".
37 ;;; Code:
42 "Info subsystem"
48 "List of info nodes user has visited.
53 This is convenient if you want to write info files by hand.
54 However, we recommend that you not do this.
55 It is better to write a Texinfo file and generate the Info file from that,
56 because that gives you a printed manual as well."
61 "Non-nil allows Info to execute Lisp code associated with nodes.
69 "Face for Info node names."
75 "Face for every third `*' in an Info menu."
82 "Face for Info cross-references."
86 "*Maximum size of menu to fontify if `font-lock-mode' is non-nil."
91 "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
92 A header-line does not scroll with the rest of the buffer."
98 "Face for Info cross-references in a node header."
103 "Face for Info nodes in a node header."
107 "List of directories to search for Info documentation files.
108 If nil, meaning not yet initialized, Info uses the environment
109 variable INFOPATH to initialize it, or `Info-default-directory-list'
110 if there is no INFOPATH variable in the environment, or the
111 concatenation of the two if INFOPATH ends with a colon.
113 When `Info-directory-list' is initialized from the value of
114 `Info-default-directory-list', and Emacs is installed in one of the
115 standard directories, the directory of Info files that come with Emacs
116 is put last (so that local Info files override standard ones).
118 When `Info-directory-list' is initialized from the value of
119 `Info-default-directory-list', and Emacs is not installed in one
120 of the standard directories, the first element of the resulting
121 list is the directory where Emacs installs the Info files that
122 come with it. This is so that Emacs's own manual, which suits the
123 version of Emacs you are using, will always be found first. This
124 is useful when you install an experimental version of Emacs without
125 removing the standard installation.
127 If you want to override the order of directories in
128 `Info-default-directory-list', set INFOPATH in the environment.
130 If you run the Emacs executable from the `src' directory in the Emacs
131 source tree, and INFOPATH is not defined, the `info' directory in the
132 source tree is used as the first element of `Info-directory-list', in
133 place of the installation Info directory. This is useful when you run
137 "List of additional directories to search for Info documentation files.
138 These directories are searched after those in `Info-directory-list'."
144 If this is non-nil, and you scroll far enough in a node that its menu
146 moves to a subnode indicated by the following menu item. This means
147 that you visit a subnode before getting to the end of the menu.
149 Setting this option to nil results in behavior similar to the stand-alone
150 Info reader program, which visits the first subnode from the menu only
151 when you hit the end of the current node."
157 "*If non-nil, hide the tag and section reference in *note and * menu items.
159 If value is non-nil but not t, the reference section is still shown."
167 "*If non-nil, attempt to refill paragraphs with hidden references.
168 This refilling may accidentally remove explicit line breaks in the info
169 file, so be prepared for a few surprises if you enable this feature."
175 ;; Try to obey obsolete Info-fontify settings.
178 "Hooks run when `info-mode' is called."
183 "Info file that Info is now looking at, or nil.
184 This is the name that was specified in Info, not the actual file name.
185 It doesn't contain directory names or file name extensions added by Info.
189 "Info subfile that is actually in the *info* buffer now.
196 "Marker pointing at beginning of current Info file's tag table.
210 \f
212 ;; The MS-DOS list should work both when long file names are
213 ;; supported (Windows 9X), and when only 8+3 file names are available.
255 "List of file name suffixes and associated decoding commands.
256 Each entry should be (SUFFIX . STRING); the file is given to
257 the command as standard input.
259 STRING may be a list of strings. In that case, the first element is
260 the command name, and the rest are arguments to that command.
262 If STRING is nil, no decoding is done.
263 Because the SUFFIXes are tried in order, the empty string should
266 ;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
267 ;; First, on MS-DOS with no long file names support, delete some of
268 ;; the extension in FILENAME to make room.
273 ;; How long is the extension in FILENAME (not counting the dot).
275 ext-left)
276 ;; SUFFIX starts with a dot. If FILENAME already has one,
277 ;; get rid of the one in SUFFIX (unless suffix is empty).
282 ;; How many chars of that extension should we keep?
284 ;; Get rid of the rest of the extension, and add SUFFIX.
287 suffix))))
294 "Insert the contents of an info file in the current buffer.
295 Do the right thing if the file has been compressed or zipped."
299 t))
301 lfn))
302 fullname decoder done)
304 ;; FILENAME exists--see if that name contains a suffix.
305 ;; If so, set DECODE accordingly.
310 filename)))
314 ;; Try adding suffixes to FILENAME and see if we can find something.
320 ;; If we found a file with a suffix, set DECODER
321 ;; according to the suffix.
323 ;; When the MS-DOS port runs on Windows, we need to check
324 ;; the short variant of a long file name as well.
334 ;; check for conflict with jka-compr
345 default-directory)))
351 \f
358 "../info/"
359 invocation-directory)))
361 infodir
363 "../../../info/"
364 invocation-directory))
366 infodir))))))
367 alternative)
370 ;; Uninstalled, Emacs builddir != srcdir.
371 sibling
372 ;; Uninstalled, builddir == srcdir
373 source))
375 ;; On DOS/NT, we use movable executables always,
376 ;; and we must always find the Info dir at run time.
378 nil
379 ;; Use invocation-directory for Info
380 ;; only if we used it for exec-directory also.
383 installation-directory))))
385 Info-default-directory-list
386 ;; `alternative' contains the Info files that came with this
387 ;; version, so we should look there first. `Info-insert-dir'
388 ;; currently expects to find `alternative' first on the list.
393 "Initialize `Info-directory-list', if that hasn't been done yet."
406 ;;;###autoload
408 "Like `info' but show the Info buffer in another window."
414 ;;;###autoload (add-hook 'same-window-buffer-names "*info*")
416 ;;;###autoload
418 "Enter Info, the documentation browser.
419 Optional argument FILE specifies the file to examine;
420 the default is the top-level directory of Info.
421 Called from a program, FILE may specify an Info node of the form
422 `(FILENAME)NODENAME'.
424 In interactive use, a prefix argument directs this command
425 to read a file name from the minibuffer.
427 The search path for Info files is in the variable `Info-directory-list'.
428 The top-level Info directory is made by combining all the files named `dir'
429 in all the directories in that path."
435 ;; If argument already contains parentheses, don't add another set
436 ;; since the argument will then be parsed improperly. This also
437 ;; has the added benefit of allowing node names to be included
438 ;; following the parenthesized filename.
446 ;;;###autoload
448 "Display the Emacs manual in Info mode."
452 ;;;###autoload
454 "Run Emacs as a standalone Info reader.
455 Usage: emacs -f info-standalone [filename]
469 \f
470 ;; See if the accessible portion of the buffer begins with a node
471 ;; delimiter, and the node header line which follows matches REGEXP.
472 ;; Typically, this test will be followed by a loop that examines the
473 ;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
474 ;; to have the overhead of this special test inside the loop.
476 ;; This function changes match-data, but supposedly the caller might
477 ;; want to use the results of re-search-backward.
479 ;; The return value is the value of point at the beginning of matching
480 ;; REGEXP, if the function succeeds, nil otherwise.
491 "Go to an info node specified as separate FILENAME and NODENAME.
492 NO-GOING-BACK is non-nil if recovering from an error in this function;
493 it says do not attempt further (recursive) error recovery."
495 ;; Convert filename to lower case if not found as specified.
496 ;; Expand it.
503 ;; If specified name starts with `./'
504 ;; then just try current directory.
507 ;; No point in searching for an
508 ;; absolute file name
512 Info-additional-directory-list)
513 Info-directory-list)))))
514 ;; Search the directory list for file FILENAME.
519 ;; Try several variants of specified name.
523 t)))
534 lfn
544 ;; Record the node we are leaving.
548 Info-history)))
549 ;; Go into info buffer.
554 "Use the `Info-mode' to browse the current info buffer.
555 If a prefix arg is provided, it queries for the NODENAME which
567 ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
568 ;; but at least it keeps this routine (which is only for the benefit of
569 ;; makeinfo-buffer) out of the way of normal operations.
570 ;;
572 "Go to an info node FILENAME and NODENAME, re-reading disk contents.
573 When *info* is already displaying FILENAME and NODENAME, the window position
574 is preserved, if possible."
590 ;; note goto-line is no good, we want to measure from point-min
597 ;; only add to the history when coming from a different file+node
602 "Find a node in a tag table.
603 MARKER specifies the buffer and position to start searching at.
604 REGEXP is a regular expression matching nodes or references. Its first
605 group should match `Node:' or `Ref:'.
606 CASE-FOLD t means search for a case-insensitive match.
607 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
608 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
609 where the match was found, and MODE is `major-mode' of the buffer in
610 which the match was found."
616 ;; Search tag table
621 major-mode)))))
624 "Find a node in a tag table.
625 MARKER specifies the buffer and position to start searching at.
626 REGEXP is a regular expression matching nodes or references. Its first
627 group should match `Node:' or `Ref:'.
628 If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
629 FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
630 where the match was found, and MODE is `major-mode' of the buffer in
631 which the match was found.
632 This function tries to find a case-sensitive match first, then a
633 case-insensitive match is tried."
637 result))
640 "Find a node or anchor in the current buffer.
641 REGEXP is a regular expression matching nodes or references. Its first
642 group should match `Node:' or `Ref:'.
643 CASE-FOLD t means search for a case-insensitive match.
644 Value is the position at which a match was found, or nil if not found."
646 found)
658 found)))
661 "Find a node or anchor in the current buffer.
662 REGEXP is a regular expression matching nodes or references. Its first
663 group should match `Node:' or `Ref:'.
664 Value is the position at which a match was found, or nil if not found.
665 This function looks for a case-sensitive match first. If none is found,
666 a case-insensitive match is tried."
678 anchorpos)
679 ;; Switch files if necessary
684 Info-current-subfile nil
685 Info-current-file-completions nil
686 buffer-file-name nil)
693 ;; See whether file has a tag table. Record the location if yes.
696 ;; Use string-equal, not equal, to ignore text props.
701 ;; We have a tag table. Find its beginning.
702 ;; Is this an indirect file?
708 ;; It is indirect. Copy it to another buffer
709 ;; and record that the tag table is in that buffer.
727 ;; Use string-equal, not equal, to ignore text props.
731 ;; Possibilities:
732 ;;
733 ;; 1. Anchor found in tag table
734 ;; 2. Anchor *not* in tag table
735 ;;
736 ;; 3. Node found in tag table
737 ;; 4. Node *not* found in tag table, but found in file
738 ;; 5. Node *not* in tag table, and *not* in file
739 ;;
740 ;; *Or* the same, but in an indirect subfile.
742 ;; Search file for a suitable node.
752 ;; First, search a tag table, if any
758 ;; FOUND is (ANCHOR POS MODE).
761 ;; If this is an indirect file, determine which
762 ;; file really holds this node and read it in.
764 ;; Note that the current buffer must be the
765 ;; *info* buffer on entry to
766 ;; Info-read-subfile. Thus the hackery above.
769 ;; Handle anchor
774 ;; Else we may have a node, which we search for:
778 ;; Now search from our advised position (or from beg of
779 ;; buffer) to find the actual node. First, check
780 ;; whether the node is right where we are, in case the
781 ;; buffer begins with a node.
787 nodename)))
791 ;; If we did not finish finding the specified node,
792 ;; go back to the previous one.
799 ;; Cache the contents of the (virtual) dir file, once we have merged
800 ;; it for the first time, so we can save time subsequently.
803 ;; Cache for the directory we decided to use for the default-directory
804 ;; of the merged dir text.
807 ;; Record the file attributes of all the files from which we
808 ;; constructed Info-dir-contents.
813 ;; Construct the Info directory node by merging the files named `dir'
814 ;; from various directories. Set the *info* buffer's
815 ;; default-directory to the first directory we actually get any text
816 ;; from.
819 ;; Verify that none of the files we used has changed
820 ;; since we used it.
824 ;; Handle symlinks
827 ;; Don't compare the access time.
831 Info-dir-file-attributes))))
837 Info-additional-directory-list)
838 Info-directory-list))
840 ;; Bind this in case the user sets it to nil.
842 ;; This is set non-nil if we find a problem in some input files.
843 problems
844 buffers buffer others nodes dirs-done)
846 ;; Search the directory list for the directory file.
851 ;; Try several variants of specified name.
852 ;; Try upcasing, appending `.info', or both.
867 dirs-done)))
877 file)
889 ;; Distinguish the dir file that comes with Emacs from all the
890 ;; others. Yes, that is really what this is supposed to do.
891 ;; The definition of `Info-directory-list' puts it first on that
892 ;; list and so last in `buffers' at this point.
896 ;; Insert the entire original dir file as a start; note that we've
897 ;; already saved its default directory to use as the default
898 ;; directory for the whole concatenation.
901 ;; Look at each of the other buffers one by one.
904 ;; In each, find all the menus.
907 ;; Find each menu, and add an elt to NODES for it.
911 nodename end)
925 ;; Add to the main menu a menu item for each other node.
937 end t)
941 ;; Now take each node of each of the other buffers
942 ;; and merge it into the main buffer.
947 ;; Find the like-named node in the main buffer.
951 nil t)
956 ;; If none exists, add one.
959 ;; Merge the text from the other buffer's menu
960 ;; into the menu in the like-named node in the main buffer.
963 ;; Kill all the buffers we just made.
983 ;; Remove duplicate headings in the same menu.
986 ;; Look for the next heading to unify.
991 ;; Check whether this heading should be streamlined.
1001 ;; Look for other headings of the same category and merge them.
1007 ;; Delete redundant heading.
1009 ;; Push the entries onto `text'.
1016 ;; Insert the entries just found.
1024 ;; Now remove duplicate entries under the same heading.
1037 ;; Note that on entry to this function the current-buffer must be the
1038 ;; *info* buffer; not the info tags buffer.
1040 ;; NODEPOS is either a position (in the Info file as a whole,
1041 ;; not relative to a subfile) or the name of a subfile.
1043 lastfilename)
1055 thisfilepos thisfilename)
1059 ;; read in version 19 stops at the end of number.
1060 ;; Advance to the next line.
1069 ;; Assume previous buffer is in Info-mode.
1070 ;; (set-buffer (get-buffer "*info*"))
1079 ;; Widen in case we are in the same subfile as before.
1089 "Unescape double quotes and backslashes in VALUE."
1095 unquote))
1097 ;; As of Texinfo 4.6, makeinfo writes constructs like
1098 ;; \0\h[image param=value ...\h\0]
1099 ;; into the Info file for handling images.
1102 whitespace separated list of KEY=VALUE pairs. If VALUE contains
1103 whitespace or double quotes, it must be quoted in double quotes and
1108 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1109 parameter-string start)
1115 parameter-alist))
1116 parameter-alist))
1119 "Display images in current node."
1126 nil t)
1143 "Select the info node that point is in."
1144 ;; Bind this in case the user sets it to nil.
1147 ;; Find beginning of node.
1153 ;; Get nodename spelled as it is in the node.
1161 ;; Find the end of it, and narrow.
1164 ;; Narrow to the node contents
1187 Info-current-file
1189 ") "
1191 \f
1192 ;; Go to an info node specified with a filename-and-nodename string
1193 ;; of the sort that is found in pointers in nodes.
1196 "Go to info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
1197 If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1198 FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1199 its sub-files).
1200 Completion is available, but only for node names in the current Info file.
1201 If FORK is non-nil (interactively with a prefix arg), show the node in
1202 a new info buffer.
1203 If FORK is a string, it is the name to use for the new buffer."
1211 nodename)
1213 ""
1226 ;; This function is used as the "completion table" while reading a node name.
1227 ;; It does completion using the alist in Info-read-node-completion-table
1228 ;; unless STRING starts with an open-paren.
1231 ;; First complete embedded file names.
1246 ;; If a file name was given, then any node is fair game.
1252 ;; Otherwise use Info-read-node-completion-table.
1267 nodename)))
1272 ;; Bind this in case the user sets it to nil.
1285 compl))))
1288 ;; If the buffer begins with a node header, process that first.
1291 ;; Now for the rest of the nodes.
1299 compl))))))))
1302 \f
1304 "If this node has been visited, restore the point value when we left."
1307 ;; Use string-equal, not equal, to ignore text props.
1313 \f
1318 "Search for REGEXP, starting from point, and select node it's found in."
1345 ;; If no subfiles, give error now.
1353 ;; Try other subfiles.
1364 ;; Find the subfile we just searched.
1366 ;; Skip that one.
1368 ;; Make a list of all following subfiles.
1369 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
1376 list))
1378 ;; Put in forward order
1406 ;; Use string-equal, not equal, to ignore text props.
1410 Info-history))))))
1411 \f
1413 "Extract the value of the node-pointer named NAME.
1414 If there is none, use ERRORNAME in the error message;
1415 if ERRORNAME is nil, just return nil."
1416 ;; Bind this in case the user sets it to nil.
1430 "Return a regexp matching a node name.
1431 ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1432 saying which chars may appear in the node name.
1433 Submatch 1 is the complete node name.
1434 Submatch 2 if non-nil is the parenthesized file name part of the node name.
1435 Submatch 3 is the local part of the node name.
1436 End of submatch 0, 1, and 3 are the same, so you can safely concat."
1443 ;;; For compatibility; other files have used this name.
1449 "Go to the next node of this node."
1454 "Go to the previous node of this node."
1459 "Go to the superior node of this node.
1460 If SAME-FILE is non-nil, do not move to a different Info file."
1470 "Go back to the last node visited."
1483 ;;;###autoload
1485 "Go to the Info directory node."
1488 \f
1490 "Follow cross reference named FOOTNOTENAME to the node it refers to.
1491 FOOTNOTENAME may be an abbreviation of the reference name."
1497 ;; Store end and beginning of line.
1506 ;; See if this one should be the default.
1511 ;; See if this one should be the alternate default.
1521 ;; Record as a completion and perhaps as default.
1524 ;; Don't add this string if it's a duplicate.
1527 ;; If no good default was found, try an alternate.
1530 ;; If only one cross-reference found, then make it default.
1536 "Follow reference named: (default "
1539 completions nil t)))
1541 default input)))
1566 ;; We allow newline because this is also used in Info-follow-reference,
1567 ;; where the xref name might be wrapped over two lines.
1568 "Regexp that matches a menu entry name upto but not including the colon.
1569 Because of ambiguities, this should be concatenated with something like
1580 ;; If the node name is the menu entry name (using `entry::').
1583 ;; No one calls this.
1584 ;;(defun Info-menu-item-sequence (list)
1585 ;; (while list
1586 ;; (Info-menu (car list))
1587 ;; (setq list (cdr list))))
1598 ;; This uses two dynamically bound variables:
1599 ;; - `Info-complete-menu-buffer' which contains the buffer in which
1600 ;; is the menu of items we're trying to complete.
1601 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
1602 ;; also look for menu items in subsequent nodes as long as those
1603 ;; nodes' names match `Info-complete-next-re'. This feature is currently
1604 ;; only used for completion in Info-index.
1606 ;; Note that `Info-complete-menu-buffer' could be current already,
1607 ;; so we want to save point.
1613 nextnode)
1622 completions)
1623 ;; Check the cache.
1630 ;; We can reuse the previous list.
1632 ;; The cache can't be used.
1637 completions))
1638 ;; Check subsequent nodes if applicable.
1643 ;; Go back to the start node (for the next completion).
1646 ;; Update the cache.
1649 Info-complete-next-re string completions)))
1656 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
1657 The menu item should one of those listed in the current node's menu.
1658 Completion is allowed, and the default menu item is the one point is on.
1659 If FORK is non-nil (interactively with a prefix arg), show the node in
1660 a new info buffer. If FORK is a string, it is the name to use for the
1661 new buffer."
1664 ;; If point is within a menu item, use that item as the default
1667 beg
1680 Info-menu-entry-name-re
1689 default)
1692 ;; we rely on the fact that completing-read accepts an input
1693 ;; of "" even when the require-match argument is true and ""
1694 ;; is not a valid possibility
1698 ;; ask again
1701 ;; there is a problem here in that if several menu items have the same
1702 ;; name you can only go to the node of the first with this command.
1720 ;; If COUNT is nil, use the last item in the menu.
1732 nil))
1736 "Go to the node of the Nth menu item.
1737 N is the digit argument used to invoke this command."
1744 "Go to the Top node of this file."
1749 "Go to the final node in this file."
1754 ;; Go to the last node in the menu of Top.
1756 ;; If the last node in the menu is not last in pointer structure,
1757 ;; move forward until we can't go any farther.
1759 ;; Then keep moving down to last subnode, unless we reach an index.
1765 "Go forward one node, considering all nodes as forming one sequence."
1770 ;; three possibilities, in order of priority:
1771 ;; 1. next node is in a menu in this node (but not in an index)
1772 ;; 2. next node is next at same level
1773 ;; 3. next node is up and next
1778 t)
1781 t)
1783 ;; Use string-equal, not equal, to ignore text props.
1796 "Go backward one node, considering all nodes as forming one sequence."
1804 ;; Use string-equal, not equal,
1805 ;; to ignore text properties.
1810 ;; If we move back at the same level,
1811 ;; go down to find the last subnode*.
1821 "Exit Info by selecting some other buffer."
1828 "Go to the node of the next menu item."
1830 ;; Bind this in case the user sets it to nil.
1842 "Go to the node of the previous menu item."
1846 ;; Bind this in case the user sets it to nil.
1861 "Go to the next subnode or the next node, or go up a level."
1866 ;; Since we have already gone thru all the items in this menu,
1867 ;; go up to the end of this node.
1869 ;; Since logically we are done with the node with that menu,
1870 ;; move on from it.
1876 "Go to the last node, popping up a level if there is none."
1880 ;; If we go down a menu item, go to the end of the node
1881 ;; so we can scroll back through it.
1883 ;; Keep going down, as long as there are nested menu nodes.
1886 ;; If we go down a menu item, go to the end of the node
1887 ;; so we can scroll back through it.
1897 ;; If we go down a menu item, go to the end of the node
1898 ;; so we can scroll back through it.
1909 "Scroll one screenful forward in Info, considering all nodes as one sequence.
1910 Once you scroll far enough in a node that its menu appears on the screen
1911 but after point, the next scroll moves into its first subnode, unless
1912 `Info-scroll-prefer-subnodes' is nil.
1914 When you scroll past the end of a node, that goes to the next node if
1915 `Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
1916 if this node has no successor, it moves to the parent node's successor,
1917 and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
1918 the menu of a node, it moves to subnode indicated by the following menu
1919 item. (That case won't normally result from this command, but can happen
1920 in other ways.)"
1942 "Scroll one screenful back in Info, considering all nodes as one sequence.
1943 If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
1944 is non-nil, this goes to its last subnode. When you scroll past the
1945 beginning of a node, that goes to the previous node or back up to the
1946 parent node."
1960 current-point
1961 t)))))
1968 "Move cursor to the next cross-reference or menu item in the node."
1988 "Move cursor to the previous cross-reference or menu item in the node."
2013 ;; Protect Info-history so that the current node (Top) is not added to it.
2017 ;;;###autoload
2019 "Look up a string TOPIC in the index for this file.
2020 The index is defined as the first node in the top level menu whose
2023 If there are no exact matches to the specified topic, this chooses
2024 the first match which is a case-insensitive substring of a topic.
2025 Use the `,' command to see the other matches.
2026 Give a blank topic name to go to the Index node itself."
2043 node
2049 ;; We bind Info-history to nil for internal node-switches so
2050 ;; that we don't put junk in the history. In the first
2051 ;; Info-goto-index call, above, we do update the history
2052 ;; because that is what the user's previous node choice into it.
2054 found)
2061 Info-current-node
2064 matches))
2072 ;; Here it is a feature that assoc is case-sensitive.
2080 "Go to the next matching index item from the last `i' command."
2101 "(`,' tries to find next)"
2105 "Move point to the place within the current node where NAME is defined."
2110 ;; Find a function definition with a return type.
2118 nil t))
2120 ;; Try again without the " <1>" makeinfo can append
2127 "Make command be undefined in Info."
2132 "Enter the Info tutorial."
2137 "Help-Small-Screen"
2141 "Display a brief summary of all Info commands."
2156 flag))
2159 \f
2161 "Return the token around POS.
2162 POS must be somewhere inside the token
2163 START is a regular expression which will match the
2164 beginning of the tokens delimited string
2165 ALL is a regular expression with a single
2166 parenthesized subpattern which is the token to be
2167 returned. E.g. '{\(.*\)}' would return any string
2168 enclosed in braces around POS.
2169 ERRORSTRING optional fourth argument, controls action on no match
2170 nil: return nil
2171 t: beep
2172 a string: signal an error, using that string."
2176 ;; First look for a match for START that goes across POS.
2180 ;; If we did not find one, search back for START
2181 ;; (this finds only matches that end at or before POS).
2194 nil)
2197 nil)
2203 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
2204 At end of the node's text, moves to the next node, or up if none."
2212 "Follow a node reference near point.
2213 If point is on a reference, follow that reference. Otherwise,
2214 if point is in a menu item description, follow that menu item."
2226 t)))
2229 ;; Common subroutine.
2231 "Follow a node reference near point. Return non-nil if successful."
2237 ;; menu item: node name
2240 ;; menu item: index entry
2254 node))
2255 \f
2259 nil
2268 (define-key Info-mode-map "1" 'Info-nth-menu-item)
2269 (define-key Info-mode-map "2" 'Info-nth-menu-item)
2270 (define-key Info-mode-map "3" 'Info-nth-menu-item)
2271 (define-key Info-mode-map "4" 'Info-nth-menu-item)
2272 (define-key Info-mode-map "5" 'Info-nth-menu-item)
2273 (define-key Info-mode-map "6" 'Info-nth-menu-item)
2274 (define-key Info-mode-map "7" 'Info-nth-menu-item)
2275 (define-key Info-mode-map "8" 'Info-nth-menu-item)
2276 (define-key Info-mode-map "9" 'Info-nth-menu-item)
2277 (define-key Info-mode-map "0" 'undefined)
2278 (define-key Info-mode-map "?" 'Info-summary)
2279 (define-key Info-mode-map "]" 'Info-forward-node)
2280 (define-key Info-mode-map "[" 'Info-backward-node)
2281 (define-key Info-mode-map "<" 'Info-top-node)
2282 (define-key Info-mode-map ">" 'Info-final-node)
2283 (define-key Info-mode-map "b" 'beginning-of-buffer)
2284 (define-key Info-mode-map "c" 'Info-copy-current-node-name)
2285 (define-key Info-mode-map "d" 'Info-directory)
2286 (define-key Info-mode-map "e" 'Info-edit)
2287 (define-key Info-mode-map "f" 'Info-follow-reference)
2288 (define-key Info-mode-map "g" 'Info-goto-node)
2289 (define-key Info-mode-map "h" 'Info-help)
2290 (define-key Info-mode-map "i" 'Info-index)
2291 (define-key Info-mode-map "l" 'Info-last)
2292 (define-key Info-mode-map "m" 'Info-menu)
2293 (define-key Info-mode-map "n" 'Info-next)
2294 (define-key Info-mode-map "p" 'Info-prev)
2295 (define-key Info-mode-map "q" 'Info-exit)
2296 (define-key Info-mode-map "s" 'Info-search)
2297 ;; For consistency with Rmail.
2298 (define-key Info-mode-map "\M-s" 'Info-search)
2299 (define-key Info-mode-map "\M-n" 'clone-buffer)
2300 (define-key Info-mode-map "t" 'Info-top-node)
2301 (define-key Info-mode-map "u" 'Info-up)
2302 (define-key Info-mode-map "," 'Info-index-next)
2304 (define-key Info-mode-map [mouse-2] 'Info-mouse-follow-nearest-node)
2305 )
2307 (defun Info-check-pointer (item)
2308 "Non-nil if ITEM is present in this node."
2309 (condition-case nil
2310 (Info-extract-pointer item)
2311 (error nil)))
2313 (easy-menu-define
2314 Info-mode-menu Info-mode-map
2315 "Menu for info files."
2316 '("Info"
2317 ["Up" Info-up :active (Info-check-pointer "up")
2318 :help "Go up in the Info tree"]
2319 ["Next" Info-next :active (Info-check-pointer "next")
2320 :help "Go to the next node"]
2321 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
2322 :help "Go to the previous node"]
2323 ["Backward" Info-backward-node
2324 :help "Go backward one node, considering all as a sequence"]
2325 ["Forward" Info-forward-node
2326 :help "Go forward one node, considering all as a sequence"]
2327 ["Beginning" beginning-of-buffer
2328 :help "Go to beginning of this node"]
2329 ["Top" Info-top-node
2330 :help "Go to top node of file"]
2331 ["Final Node" Info-final-node
2332 :help "Go to final node in this file"]
2333 ("Menu Item" ["You should never see this" report-emacs-bug t])
2334 ("Reference" ["You should never see this" report-emacs-bug t])
2335 ["Search..." Info-search
2336 :help "Search for regular expression in this Info file"]
2337 ["Go to Node..." Info-goto-node
2338 :help "Go to a named node"]
2339 ["Last" Info-last :active Info-history
2340 :help "Go to the last node you were at"]
2341 ("Index..."
2342 ["Lookup a String" Info-index
2343 :help "Look for a string in the index items"]
2344 ["Next Matching Item" Info-index-next
2345 :help "Look for another occurrence of previous item"])
2346 ["Edit" Info-edit :help "Edit contents of this node"
2347 :active Info-enable-edit]
2348 ["Copy Node Name" Info-copy-current-node-name
2349 :help "Copy the name of the current node into the kill ring"]
2350 ["Exit" Info-exit :help "Stop reading Info"]))
2353 (defvar info-tool-bar-map
2354 (if (display-graphic-p)
2355 (let ((map (make-sparse-keymap)))
2356 (tool-bar-local-item-from-menu 'Info-exit "close" map Info-mode-map)
2357 (tool-bar-local-item-from-menu 'Info-prev "left_arrow" map Info-mode-map)
2358 (tool-bar-local-item-from-menu 'Info-next "right_arrow" map Info-mode-map)
2359 (tool-bar-local-item-from-menu 'Info-up "up_arrow" map Info-mode-map)
2360 (tool-bar-local-item-from-menu 'Info-last "undo" map Info-mode-map)
2361 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
2362 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
2363 (tool-bar-local-item-from-menu 'Info-goto-node "jump_to" map Info-mode-map)
2364 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
2365 map)))
2367 (defvar Info-menu-last-node nil)
2368 ;; Last node the menu was created for.
2369 ;; Value is a list, (FILE-NAME NODE-NAME).
2371 (defun Info-menu-update ()
2372 "Update the Info menu for the current node."
2373 (condition-case nil
2374 (if (or (not (eq major-mode 'Info-mode))
2375 (equal (list Info-current-file Info-current-node)
2376 Info-menu-last-node))
2377 ()
2378 ;; Update menu menu.
2379 (let* ((Info-complete-menu-buffer (current-buffer))
2380 (items (nreverse (condition-case nil
2381 (Info-complete-menu-item "" nil t)
2382 (error nil))))
2383 entries current
2384 (number 0))
2385 (while (and items (< number 9))
2386 (setq current (car items)
2387 items (cdr items)
2388 number (1+ number))
2389 (setq entries (cons `[,current
2390 (Info-menu ,current)
2391 :keys ,(format "%d" number)]
2392 entries)))
2393 (if items
2394 (setq entries (cons ["Other..." Info-menu t] entries)))
2395 (or entries
2396 (setq entries (list ["No menu" nil nil] nil :active)))
2397 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
2398 ;; Update reference menu. Code stolen from `Info-follow-reference'.
2399 (let ((items nil)
2400 str i entries current
2401 (number 0)
2402 (case-fold-search t))
2403 (save-excursion
2404 (goto-char (point-min))
2406 (setq str (match-string 1))
2407 (setq i 0)
2409 (setq str (concat (substring str 0 i) " "
2410 (substring str (match-end 0))))
2411 (setq i (1+ i)))
2412 (setq items
2413 (cons str items))))
2414 (while (and items (< number 9))
2415 (setq current (car items)
2416 items (cdr items)
2417 number (1+ number))
2418 (setq entries (cons `[,current
2419 (Info-follow-reference ,current)
2420 t]
2421 entries)))
2422 (if items
2423 (setq entries (cons ["Other..." Info-follow-reference t]
2424 entries)))
2425 (or entries
2426 (setq entries (list ["No references" nil nil] nil :active)))
2427 (easy-menu-change '("Info") "Reference" (nreverse entries)))
2428 ;; Update last seen node.
2429 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
2430 ;; Try to avoid entering infinite beep mode in case of errors.
2431 (error (ding))))
2433 \f
2434 (defun Info-copy-current-node-name ()
2435 "Put the name of the current info node into the kill ring.
2436 The name of the info file is prepended to the node name in parentheses."
2437 (interactive)
2438 (unless Info-current-node
2439 (error "No current info node"))
2440 (kill-new
2441 (concat "("
2442 (file-name-nondirectory
2443 (if (stringp Info-current-file)
2444 Info-current-file
2445 (or buffer-file-name "")))
2446 ")"
2447 Info-current-node)))
2449 \f
2450 ;; Info mode is suitable only for specially formatted data.
2451 (put 'Info-mode 'mode-class 'special)
2452 (put 'Info-mode 'no-clone-indirect t)
2454 (defun Info-mode ()
2455 "Info mode provides commands for browsing through the Info documentation tree.
2457 one topic and contains references to other nodes which discuss related
2458 topics. Info has commands to follow the references and show you other nodes.
2464 Selecting other nodes:
2466 Follow a node reference you click on.
2467 This works with menu items, cross references, and
2469 \\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
2474 Picking a menu item causes another node to be selected.
2485 Moving within a node:
2487 Once you scroll far enough in a node that its menu appears on the
2488 screen but after point, the next scroll moves into its first
2489 subnode. When after all menu items (or if there is no menu),
2490 move up to the parent node.
2492 already visible, try to go to the previous menu entry, or up
2493 if there is none.
2496 Advanced commands:
2499 1 Pick first item in node's menu.
2500 2, 3, 4, 5 Pick second ... fifth item in node's menu.
2502 You may include a filename as well, as (FILENAME)NODENAME.
2505 and select the node in which the next occurrence is found.
2508 (kill-all-local-variables)
2509 (setq major-mode 'Info-mode)
2510 (setq mode-name "Info")
2511 (setq tab-width 8)
2512 (use-local-map Info-mode-map)
2513 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
2514 (set-syntax-table text-mode-syntax-table)
2515 (setq local-abbrev-table text-mode-abbrev-table)
2516 (setq case-fold-search t)
2517 (setq buffer-read-only t)
2518 (make-local-variable 'Info-current-file)
2519 (make-local-variable 'Info-current-subfile)
2520 (make-local-variable 'Info-current-node)
2521 (make-local-variable 'Info-tag-table-marker)
2522 (setq Info-tag-table-marker (make-marker))
2523 (make-local-variable 'Info-tag-table-buffer)
2524 (setq Info-tag-table-buffer nil)
2525 (make-local-variable 'Info-history)
2526 (make-local-variable 'Info-index-alternatives)
2527 (setq header-line-format
2528 (if Info-use-header-line
2529 '(:eval (get-text-property (point-min) 'header-line))
2530 nil)) ; so the header line isn't displayed
2531 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
2532 ;; This is for the sake of the invisible text we use handling titles.
2533 (make-local-variable 'line-move-ignore-invisible)
2534 (setq line-move-ignore-invisible t)
2535 (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
2536 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
2537 (Info-set-mode-line)
2538 (run-hooks 'Info-mode-hook))
2540 (defun Info-clone-buffer-hook ()
2541 (when (bufferp Info-tag-table-buffer)
2542 (setq Info-tag-table-buffer
2543 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
2544 (let ((m Info-tag-table-marker))
2545 (when (markerp m)
2546 (setq Info-tag-table-marker
2547 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
2548 (with-current-buffer Info-tag-table-buffer
2549 (copy-marker (marker-position m)))
2550 (make-marker))))))
2552 (defvar Info-edit-map (let ((map (make-sparse-keymap)))
2553 (set-keymap-parent map text-mode-map)
2554 (define-key map "\C-c\C-c" 'Info-cease-edit)
2555 map)
2556 "Local keymap used within `e' command of Info.")
2558 ;; Info-edit mode is suitable only for specially formatted data.
2559 (put 'Info-edit-mode 'mode-class 'special)
2561 (defun Info-edit-mode ()
2562 "Major mode for editing the contents of an Info node.
2563 Like text mode with the addition of `Info-cease-edit'
2564 which returns to Info mode for browsing.
2566 (use-local-map Info-edit-map)
2567 (setq major-mode 'Info-edit-mode)
2568 (setq mode-name "Info Edit")
2569 (kill-local-variable 'mode-line-buffer-identification)
2570 (setq buffer-read-only nil)
2571 (force-mode-line-update)
2572 (buffer-enable-undo (current-buffer))
2573 (run-hooks 'Info-edit-mode-hook))
2575 (defun Info-edit ()
2576 "Edit the contents of this Info node.
2577 Allowed only if variable `Info-enable-edit' is non-nil."
2578 (interactive)
2579 (or Info-enable-edit
2580 (error "Editing info nodes is not enabled"))
2581 (Info-edit-mode)
2582 (message "%s" (substitute-command-keys
2585 (defun Info-cease-edit ()
2586 "Finish editing Info node; switch back to Info proper."
2587 (interactive)
2588 ;; Do this first, so nothing has changed if user C-g's at query.
2589 (and (buffer-modified-p)
2590 (y-or-n-p "Save the file? ")
2591 (save-buffer))
2592 (use-local-map Info-mode-map)
2593 (setq major-mode 'Info-mode)
2594 (setq mode-name "Info")
2595 (Info-set-mode-line)
2596 (setq buffer-read-only t)
2597 (force-mode-line-update)
2598 (and (marker-position Info-tag-table-marker)
2599 (buffer-modified-p)
2600 (message "Tags may have changed. Use Info-tagify if necessary")))
2601 \f
2602 (defvar Info-file-list-for-emacs
2603 '("ediff" "eudc" "forms" "gnus" "info" ("mh" . "mh-e")
2604 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
2605 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
2606 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
2607 ("skeleton" . "autotype") ("auto-insert" . "autotype")
2608 ("copyright" . "autotype") ("executable" . "autotype")
2609 ("time-stamp" . "autotype") ("quickurl" . "autotype")
2610 ("tempo" . "autotype") ("hippie-expand" . "autotype")
2611 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
2612 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
2613 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
2614 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
2615 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
2616 ("rfc2045" . "emacs-mime")
2617 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
2618 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
2619 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
2620 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
2621 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
2622 ("mml" . "emacs-mime"))
2623 "List of Info files that describe Emacs commands.
2624 An element can be a file name, or a list of the form (PREFIX . FILE)
2625 where PREFIX is a name prefix and FILE is the file to look in.
2626 If the element is just a file name, the file name also serves as the prefix.")
2628 (defun Info-find-emacs-command-nodes (command)
2629 "Return a list of locations documenting COMMAND.
2630 The `info-file' property of COMMAND says which Info manual to search.
2631 If COMMAND has no property, the variable `Info-file-list-for-emacs'
2632 defines heuristics for which Info manual to try.
2633 The locations are of the format used in `Info-history', i.e.
2634 \(FILENAME NODENAME BUFFERPOS\)."
2635 (let ((where '())
2638 (info-file "emacs")) ;default
2639 ;; Determine which info file this command is documented in.
2640 (if (get command 'info-file)
2641 (setq info-file (get command 'info-file))
2642 ;; If it doesn't say explicitly, test its name against
2643 ;; various prefixes that we know.
2644 (let ((file-list Info-file-list-for-emacs))
2645 (while file-list
2646 (let* ((elt (car file-list))
2647 (name (if (consp elt)
2648 (car elt)
2649 elt))
2650 (file (if (consp elt) (cdr elt) elt))
2653 (if (string-match regexp (symbol-name command))
2654 (setq info-file file file-list nil))
2655 (setq file-list (cdr file-list))))))
2656 (Info-find-node info-file "Top")
2659 (error "Info file `%s' appears to lack an index" info-file))
2660 (goto-char (match-beginning 1))
2661 ;; Bind Info-history to nil, to prevent the index nodes from
2662 ;; getting into the node history.
2663 (let ((Info-history nil)
2664 node)
2665 (Info-goto-node (Info-extract-menu-node-name))
2666 (while
2667 (progn
2668 (goto-char (point-min))
2669 (while (re-search-forward cmd-desc nil t)
2670 (setq where
2671 (cons (list Info-current-file
2672 (match-string-no-properties 2)
2673 0)
2674 where)))
2675 (and (setq node (Info-extract-pointer "next" t))
2677 (Info-goto-node node)))
2678 where))
2680 ;;;###autoload
2681 (defun Info-goto-emacs-command-node (command)
2682 "Go to the Info node in the Emacs manual for command COMMAND.
2683 The command is found by looking up in Emacs manual's indices
2684 or in another manual found via COMMAND's `info-file' property or
2685 the variable `Info-file-list-for-emacs'.
2686 COMMAND must be a symbol or string."
2687 (interactive "CFind documentation for command: ")
2688 ;; If command is given as a string, convert it to a symbol.
2689 (if (stringp command)
2690 (setq command (intern command)))
2691 (or (commandp command)
2692 (signal 'wrong-type-argument (list 'commandp command)))
2693 (let ((where (Info-find-emacs-command-nodes command)))
2694 (if where
2695 (let ((num-matches (length where)))
2696 ;; Get Info running, and pop to it in another window.
2697 (save-window-excursion
2698 (info))
2699 ;; FIXME It would be cool if this could use a buffer other
2700 ;; than *info*.
2701 (pop-to-buffer "*info*")
2702 ;; Bind Info-history to nil, to prevent the last Index node
2703 ;; visited by Info-find-emacs-command-nodes from being
2704 ;; pushed onto the history.
2705 (let ((Info-history nil))
2706 (Info-find-node (car (car where))
2707 (car (cdr (car where)))))
2708 (if (> num-matches 1)
2709 (progn
2710 ;; (car where) will be pushed onto Info-history
2711 ;; when/if they go to another node. Put the other
2712 ;; nodes that were found on the history.
2713 (setq Info-history (nconc (cdr where) Info-history))
2714 (message "Found %d other entr%s. Use %s to see %s."
2715 (1- num-matches)
2716 (if (> num-matches 2) "ies" "y")
2718 (if (> num-matches 2) "them" "it")))))
2719 (error "Couldn't find documentation for %s" command))))
2721 ;;;###autoload
2722 (defun Info-goto-emacs-key-command-node (key)
2723 "Go to the node in the Emacs manual which describes the command bound to KEY.
2724 KEY is a string.
2725 Interactively, if the binding is `execute-extended-command', a command is read.
2726 The command is found by looking up in Emacs manual's indices
2727 or in another manual found via COMMAND's `info-file' property or
2728 the variable `Info-file-list-for-emacs'."
2729 (interactive "kFind documentation for key: ")
2730 (let ((command (key-binding key)))
2731 (cond ((null command)
2732 (message "%s is undefined" (key-description key)))
2733 ((and (interactive-p)
2734 (eq command 'execute-extended-command))
2735 (Info-goto-emacs-command-node
2736 (read-command "Find documentation for command: ")))
2737 (t
2738 (Info-goto-emacs-command-node command)))))
2739 \f
2740 (defface Info-title-1-face
2741 '((((type tty pc) (class color)) (:foreground "yellow" :weight bold))
2742 (t (:height 1.2 :inherit Info-title-2-face)))
2743 "Face for Info titles at level 1."
2744 :group 'info)
2746 (defface Info-title-2-face
2747 '((((type tty pc) (class color)) (:foreground "lightblue" :weight bold))
2748 (t (:height 1.2 :inherit Info-title-3-face)))
2749 "Face for Info titles at level 2."
2750 :group 'info)
2752 (defface Info-title-3-face
2753 '((((type tty pc) (class color)) (:weight bold))
2754 (t (:height 1.2 :inherit Info-title-4-face)))
2755 "Face for Info titles at level 3."
2756 :group 'info)
2758 (defface Info-title-4-face
2759 '((((type tty pc) (class color)) (:weight bold))
2760 (t (:weight bold :inherit variable-pitch)))
2761 "Face for Info titles at level 4."
2762 :group 'info)
2764 (defface info-menu-header
2765 '((((type tty pc))
2766 :underline t
2767 :weight bold)
2768 (t
2769 :inherit variable-pitch
2770 :weight bold))
2771 "Face for headers in Info menus."
2772 :group 'info)
2774 (defun Info-escape-percent (string)
2775 "Double all occurrences of `%' in STRING.
2777 Return a new string with all `%' characters replaced by `%%'.
2778 Preserve text properties."
2779 (let ((start 0)
2780 (end (length string))
2781 mb me m matches)
2782 (save-match-data
2783 (while (and (< start end) (string-match "%" string start))
2784 (setq mb (match-beginning 0)
2785 me (1+ mb)
2786 m (substring string mb me)
2787 matches (cons m
2788 (cons m
2789 (cons (substring string start mb)
2790 matches)))
2791 start me))
2792 (push (substring string start end) matches)
2793 (apply #'concat (nreverse matches)))))
2795 (defun Info-fontify-menu-headers ()
2796 "Add the face `info-menu-header' to any header before a menu entry."
2797 (save-excursion
2798 (goto-char (point-min))
2800 (put-text-property (match-beginning 0) (match-end 0)
2801 'font-lock-face 'info-menu-header)
2803 (put-text-property (match-beginning 1) (match-end 1)
2804 'font-lock-face 'info-menu-header)))))
2806 (defvar Info-next-link-keymap
2807 (let ((keymap (make-sparse-keymap)))
2808 (define-key keymap [header-line mouse-1] 'Info-next)
2809 (define-key keymap [header-line mouse-2] 'Info-next)
2810 (define-key keymap [header-line down-mouse-1] 'ignore)
2811 (define-key keymap [mouse-2] 'Info-next)
2812 keymap)
2813 "Keymap to put on the Next link in the text or the header line.")
2815 (defvar Info-prev-link-keymap
2816 (let ((keymap (make-sparse-keymap)))
2817 (define-key keymap [header-line mouse-1] 'Info-prev)
2818 (define-key keymap [header-line mouse-2] 'Info-prev)
2819 (define-key keymap [header-line down-mouse-1] 'ignore)
2820 (define-key keymap [mouse-2] 'Info-prev)
2821 keymap)
2822 "Keymap to put on the Prev link in the text or the header line.")
2825 (defvar Info-up-link-keymap
2826 (let ((keymap (make-sparse-keymap)))
2827 (define-key keymap [header-line mouse-1] 'Info-up)
2828 (define-key keymap [header-line mouse-2] 'Info-up)
2829 (define-key keymap [header-line down-mouse-1] 'ignore)
2830 (define-key keymap [mouse-2] 'Info-up)
2831 keymap)
2832 "Keymap to put on the Up link in the text or the header line.")
2834 (defun Info-fontify-node ()
2835 ;; Only fontify the node if it hasn't already been done.
2836 (unless (let ((where (next-property-change (point-min))))
2837 (and where (not (= where (point-max)))))
2838 (save-excursion
2839 (let ((inhibit-read-only t)
2840 (case-fold-search t)
2841 paragraph-markers)
2842 (goto-char (point-min))
2844 (goto-char (match-end 0))
2846 (goto-char (match-end 0))
2847 (let* ((nbeg (match-beginning 2))
2848 (nend (match-end 2))
2849 (tbeg (match-beginning 1))
2850 (tag (match-string 1)))
2851 (if (string-equal tag "Node")
2852 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
2853 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
2854 (put-text-property tbeg nend 'mouse-face 'highlight)
2855 (put-text-property tbeg nend
2856 'help-echo
2857 (concat "Go to node "
2858 (buffer-substring nbeg nend)))
2859 ;; Always set up the text property keymap.
2860 ;; It will either be used in the buffer
2861 ;; or copied in the header line.
2862 (put-text-property tbeg nend 'keymap
2863 (cond
2864 ((equal tag "Prev") Info-prev-link-keymap)
2865 ((equal tag "Next") Info-next-link-keymap)
2866 ((equal tag "Up") Info-up-link-keymap))))))
2867 (when Info-use-header-line
2868 (goto-char (point-min))
2869 (let ((header-end (line-end-position))
2870 header)
2871 ;; If we find neither Next: nor Prev: link, show the entire
2872 ;; node header. Otherwise, don't show the File: and Node:
2873 ;; parts, to avoid wasting precious space on information that
2874 ;; is available in the mode line.
2875 (if (re-search-forward
2877 header-end t)
2878 (progn
2879 (goto-char (match-beginning 1))
2880 (setq header (buffer-substring (point) header-end)))
2882 (setq header
2883 (concat "No next, prev or up links -- "
2884 (buffer-substring (point) header-end)))
2885 (setq header (buffer-substring (point) header-end))))
2887 (put-text-property (point-min) (1+ (point-min))
2888 'header-line (Info-escape-percent header))
2889 ;; Hide the part of the first line
2890 ;; that is in the header, if it is just part.
2891 (unless (bobp)
2892 ;; Hide the punctuation at the end, too.
2894 (put-text-property (point) header-end 'invisible t)))))
2895 (goto-char (point-min))
2897 nil t)
2898 (let* ((c (preceding-char))
2899 (face
2900 (cond ((= c ?*) 'Info-title-1-face)
2901 ((= c ?=) 'Info-title-2-face)
2902 ((= c ?-) 'Info-title-3-face)
2903 (t 'Info-title-4-face))))
2904 (put-text-property (match-beginning 1) (match-end 1)
2905 'font-lock-face face))
2906 ;; This is a serious problem for trying to handle multiple
2907 ;; frame types at once. We want this text to be invisible
2908 ;; on frames that can display the font above.
2909 (when (memq (framep (selected-frame)) '(x pc w32 mac))
2910 (add-text-properties (1- (match-beginning 2)) (match-end 2)
2911 '(invisible t front-sticky nil rear-nonsticky t))))
2912 (goto-char (point-min))
2913 (while (re-search-forward "\\(\\*Note[ \t]*\\)\n?[ \t]*\\([^:]*\\)\\(:[^.,:(]*\\(([^)]*)[^.,:]*\\)?[,:]?\n?\\)" nil t)
2915 (let ((start (match-beginning 0))
2916 (next (point))
2917 (hide-tag Info-hide-note-references)
2918 other-tag)
2919 (when hide-tag
2920 ;; *Note is often used where *note should have been
2921 (goto-char start)
2922 (skip-syntax-backward " ")
2923 (setq other-tag
2924 (cond ((memq (char-before) '(nil ?\. ?! ??))
2925 "See ")
2926 ((memq (char-before) '(?\, ?\; ?\: ?-))
2927 "see ")
2928 ((memq (char-before) '(?\( ?\[ ?\{))
2929 ;; Check whether the paren is preceded by
2930 ;; an end of sentence
2931 (skip-syntax-backward " (")
2932 (if (memq (char-before) '(nil ?\. ?! ??))
2933 "See "
2934 "see "))
2936 "See ")))
2937 (goto-char next))
2938 (if hide-tag
2939 (add-text-properties (match-beginning 1) (match-end 1)
2940 '(invisible t front-sticky nil rear-nonsticky t)))
2941 (add-text-properties
2942 (match-beginning 2) (match-end 2)
2943 (cons 'help-echo
2944 (cons (if (match-end 4)
2945 (concat "mouse-2: go to " (match-string 4))
2946 "mouse-2: go to this node")
2947 '(font-lock-face info-xref
2948 mouse-face highlight))))
2949 (when (eq Info-hide-note-references t)
2950 (add-text-properties (match-beginning 3) (match-end 3)
2951 '(invisible t front-sticky nil rear-nonsticky t)))
2952 (when other-tag
2953 (save-excursion
2954 (goto-char (match-beginning 1))
2955 (insert other-tag)))
2956 (when (and Info-refill-paragraphs
2957 (or hide-tag (eq Info-hide-note-references t)))
2958 (push (set-marker (make-marker) start)
2959 paragraph-markers)))))
2961 (when (and Info-refill-paragraphs
2962 paragraph-markers)
2963 (let ((fill-nobreak-invisible t)
2964 (fill-individual-varying-indent nil)
2967 (adaptive-fill-mode nil))
2968 (goto-char (point-max))
2969 (while paragraph-markers
2970 (let ((m (car paragraph-markers)))
2971 (setq paragraph-markers (cdr paragraph-markers))
2972 (when (< m (point))
2973 (goto-char m)
2974 (beginning-of-line)
2975 (let ((beg (point)))
2976 (when (zerop (forward-paragraph))
2977 (fill-individual-paragraphs beg (point) nil nil)
2978 (goto-char beg))))
2979 (set-marker m nil)))))
2981 (goto-char (point-min))
2984 ;; Don't take time to annotate huge menus
2985 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
2986 (let ((n 0)
2987 cont)
2988 (while (re-search-forward
2991 nil t)
2992 (setq n (1+ n))
2993 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
2994 (put-text-property (match-beginning 0)
2995 (1+ (match-beginning 0))
2996 'font-lock-face 'info-menu-5))
2997 (add-text-properties
2998 (match-beginning 1) (match-end 1)
2999 (cons 'help-echo
3000 (cons
3001 (if (match-end 3)
3002 (concat "mouse-2: go to " (match-string 3))
3003 "mouse-2: go to this node")
3004 '(font-lock-face info-xref
3005 mouse-face highlight))))
3006 (when (eq Info-hide-note-references t)
3007 (put-text-property (match-beginning 2) (1- (match-end 6))
3008 'invisible t)
3009 ;; We need a stretchable space like :align-to but with
3010 ;; a minimum value.
3011 (put-text-property (1- (match-end 6)) (match-end 6) 'display
3012 (if (>= 22 (- (match-end 1)
3013 (match-beginning 0)))
3014 '(space :align-to 24)
3015 '(space :width 2)))
3016 (setq cont (looking-at "."))
3017 (while (and (= (forward-line 1) 0)
3019 (put-text-property (match-beginning 1) (1- (match-end 1))
3020 'invisible t)
3021 (put-text-property (1- (match-end 1)) (match-end 1)
3022 'display
3023 (if cont
3024 '(space :align-to 26)
3025 '(space :align-to 24)))
3026 (setq cont t))))))
3028 (Info-fontify-menu-headers)
3029 (set-buffer-modified-p nil)))))
3030 \f
3032 ;; When an Info buffer is killed, make sure the associated tags buffer
3033 ;; is killed too.
3034 (defun Info-kill-buffer ()
3035 (and (eq major-mode 'Info-mode)
3036 Info-tag-table-buffer
3037 (kill-buffer Info-tag-table-buffer)))
3039 (add-hook 'kill-buffer-hook 'Info-kill-buffer)
3041 ;;; Speedbar support:
3042 ;; These functions permit speedbar to display the "tags" in the
3043 ;; current info node.
3044 (eval-when-compile (require 'speedbar))
3046 (defvar Info-speedbar-key-map nil
3047 "Keymap used when in the info display mode.")
3049 (defun Info-install-speedbar-variables ()
3050 "Install those variables used by speedbar to enhance Info."
3051 (if Info-speedbar-key-map
3052 nil
3053 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
3055 ;; Basic tree features
3056 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
3057 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
3058 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
3059 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
3060 )
3062 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
3063 Info-speedbar-key-map
3064 Info-speedbar-hierarchy-buttons)))
3066 (defvar Info-speedbar-menu-items
3067 '(["Browse Node" speedbar-edit-line t]
3068 ["Expand Node" speedbar-expand-line
3069 (save-excursion (beginning-of-line)
3071 ["Contract Node" speedbar-contract-line
3072 (save-excursion (beginning-of-line)
3073 (looking-at "[0-9]+: *.-. "))]
3074 )
3075 "Additional menu-items to add to speedbar frame.")
3077 ;; Make sure our special speedbar major mode is loaded
3078 (if (featurep 'speedbar)
3079 (Info-install-speedbar-variables)
3080 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
3082 ;;; Info hierarchy display method
3083 ;;;###autoload
3084 (defun Info-speedbar-browser ()
3085 "Initialize speedbar to display an info node browser.
3086 This will add a speedbar major display mode."
3087 (interactive)
3088 (require 'speedbar)
3089 ;; Make sure that speedbar is active
3090 (speedbar-frame-mode 1)
3091 ;; Now, throw us into Info mode on speedbar.
3092 (speedbar-change-initial-expansion-list "Info")
3093 )
3095 (eval-when-compile (defvar speedbar-attached-frame))
3097 (defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
3098 "Display an Info directory hierarchy in speedbar.
3099 DIRECTORY is the current directory in the attached frame.
3100 DEPTH is the current indentation depth.
3101 NODE is an optional argument that is used to represent the
3102 specific node to expand."
3103 (if (and (not node)
3104 (save-excursion (goto-char (point-min))
3105 (let ((case-fold-search t))
3106 (looking-at "Info Nodes:"))))
3107 ;; Update our "current node" maybe?
3108 nil
3109 ;; We cannot use the generic list code, that depends on all leaves
3110 ;; being known at creation time.
3111 (if (not node)
3113 (let ((completions nil)
3114 (cf (selected-frame)))
3115 (select-frame speedbar-attached-frame)
3116 (save-window-excursion
3117 (setq completions
3118 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
3119 (select-frame cf)
3120 (if completions
3121 (speedbar-with-writable
3122 (dolist (completion completions)
3123 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
3124 (cdr completion)
3125 (car completion)
3126 'Info-speedbar-goto-node
3127 (cdr completion)
3128 'info-xref depth))
3129 t)
3130 nil))))
3132 (defun Info-speedbar-goto-node (text node indent)
3133 "When user clicks on TEXT, go to an info NODE.
3134 The INDENT level is ignored."
3135 (select-frame speedbar-attached-frame)
3136 (let* ((buff (or (get-buffer "*info*")
3137 (progn (info) (get-buffer "*info*"))))
3138 (bwin (get-buffer-window buff 0)))
3139 (if bwin
3140 (progn
3141 (select-window bwin)
3142 (raise-frame (window-frame bwin)))
3143 (if speedbar-power-click
3144 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
3145 (select-frame speedbar-attached-frame)
3146 (switch-to-buffer buff)))
3148 (error "Invalid node %s" node)
3149 (Info-find-node (match-string 1 node) (match-string 2 node))
3150 ;; If we do a find-node, and we were in info mode, restore
3151 ;; the old default method. Once we are in info mode, it makes
3152 ;; sense to return to whatever method the user was using before.
3153 (if (string= speedbar-initial-expansion-list-name "Info")
3154 (speedbar-change-initial-expansion-list
3155 speedbar-previously-used-expansion-list-name)))))
3157 (defun Info-speedbar-expand-node (text token indent)
3158 "Expand the node the user clicked on.
3159 TEXT is the text of the button we clicked on, a + or - item.
3160 TOKEN is data related to this node (NAME . FILE).
3161 INDENT is the current indentation depth."
3162 (cond ((string-match "+" text) ;we have to expand this file
3163 (speedbar-change-expand-button-char ?-)
3164 (if (speedbar-with-writable
3165 (save-excursion
3166 (end-of-line) (forward-char 1)
3167 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
3168 (speedbar-change-expand-button-char ?-)
3169 (speedbar-change-expand-button-char ??)))
3170 ((string-match "-" text) ;we have to contract this node
3171 (speedbar-change-expand-button-char ?+)
3172 (speedbar-delete-subblock indent))
3173 (t (error "Ooops... not sure what to do")))
3174 (speedbar-center-buffer-smartly))
3176 (defun Info-speedbar-fetch-file-nodes (nodespec)
3177 "Fetch the subnodes from the info NODESPEC.
3178 NODESPEC is a string of the form: (file)node.
3179 Optional THISFILE represends the filename of"
3180 (save-excursion
3181 ;; Set up a buffer we can use to fake-out Info.
3182 (set-buffer (get-buffer-create "*info-browse-tmp*"))
3183 (if (not (equal major-mode 'Info-mode))
3184 (Info-mode))
3185 ;; Get the node into this buffer
3187 (error "Invalid node specification %s" nodespec)
3188 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
3189 ;; Scan the created buffer
3190 (goto-char (point-min))
3191 (let ((completions nil)
3192 (case-fold-search t)
3194 (match-string 1 nodespec))))
3195 ;; Always skip the first one...
3198 (let ((name (match-string 1)))
3199 (push (cons name
3201 (match-string 1)
3203 (concat (match-string 1) "Top")
3204 (concat "(" thisfile ")"
3206 (match-string 1)
3207 name)))))
3208 completions)))
3209 (nreverse completions))))
3211 ;;; Info mode node listing
3212 ;; FIXME: Seems not to be used. -stef
3213 (defun Info-speedbar-buttons (buffer)
3214 "Create a speedbar display to help navigation in an Info file.
3215 BUFFER is the buffer speedbar is requesting buttons for."
3216 (if (save-excursion (goto-char (point-min))
3217 (let ((case-fold-search t))
3218 (not (looking-at "Info Nodes:"))))
3219 (erase-buffer))
3220 (Info-speedbar-hierarchy-buttons nil 0)
3221 )
3223 (dolist (mess '("^Node has no Previous$"
3224 "^No menu in this node$"
3225 "^Node has no Next$"
3226 "^No cross-references in this node^"
3227 search-failed
3229 (add-to-list 'debug-ignored-errors mess))
3231 (provide 'info)
3233 ;;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
3234 ;;; info.el ends here