* s/gnu-linux.h (LIBS_SYSTEM): Remove, same as default.
[bpt/emacs.git] / lisp / info.el
CommitLineData
baa7f3de 1;; info.el --- info package for Emacs
e5167999 2
83040cb0 3;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
114f9c96 4;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
e1af69b4 5;; Free Software Foundation, Inc.
3a801d0c 6
e5167999 7;; Maintainer: FSF
fd7fa35a 8;; Keywords: help
e5167999 9
a384cab3
JB
10;; This file is part of GNU Emacs.
11
eb3fa2cf 12;; GNU Emacs is free software: you can redistribute it and/or modify
a384cab3 13;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
a384cab3
JB
16
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.
21
22;; You should have received a copy of the GNU General Public License
eb3fa2cf 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
a384cab3 24
e5167999
ER
25;;; Commentary:
26
185cff95 27;; Note that nowadays we expect Info files to be made using makeinfo.
921e5fe6
TTN
28;; In particular we make these assumptions:
29;; - a menu item MAY contain colons but not colon-space ": "
30;; - a menu item ending with ": " (but not ":: ") is an index entry
31;; - a node name MAY NOT contain a colon
505b68d5
TTN
32;; This distinction is to support indexing of computer programming
33;; language terms that may contain ":" but not ": ".
e5167999
ER
34
35;;; Code:
36
43f8b275 37(eval-when-compile (require 'jka-compr) (require 'cl))
bc6262c8 38
ded3e3d8 39(defgroup info nil
fc039bdc 40 "Info subsystem."
ded3e3d8
RS
41 :group 'help
42 :group 'docs)
43
44
a384cab3 45(defvar Info-history nil
185cff95 46 "Stack of Info nodes user has visited.
db90d225 47Each element of the stack is a list (FILENAME NODENAME BUFFERPOS).")
a384cab3 48
424b9d3e 49(defvar Info-history-forward nil
185cff95 50 "Stack of Info nodes user has visited with `Info-history-back' command.
db90d225 51Each element of the stack is a list (FILENAME NODENAME BUFFERPOS).")
424b9d3e 52
8a7757f6 53(defvar Info-history-list nil
185cff95 54 "List of all Info nodes user has visited.
db90d225 55Each element of the list is a list (FILENAME NODENAME).")
8a7757f6 56
ded3e3d8 57(defcustom Info-enable-edit nil
9201cc28 58 "Non-nil means the \\<Info-mode-map>\\[Info-edit] command in Info can edit the current node.
185cff95 59This is convenient if you want to write Info files by hand.
ada0a60d
RS
60However, we recommend that you not do this.
61It is better to write a Texinfo file and generate the Info file from that,
ded3e3d8
RS
62because that gives you a printed manual as well."
63 :type 'boolean
64 :group 'info)
a384cab3 65
67f445d7 66(defvar Info-enable-active-nodes nil
a384cab3
JB
67 "Non-nil allows Info to execute Lisp code associated with nodes.
68The Lisp code is executed when the node is selected.")
67f445d7 69(put 'Info-enable-active-nodes 'risky-local-variable t)
a384cab3 70
93480d70 71(defface info-node
508bce68
SM
72 '((((class color) (background light)) :foreground "brown" :weight bold :slant italic)
73 (((class color) (background dark)) :foreground "white" :weight bold :slant italic)
74 (t :weight bold :slant italic))
93480d70
RS
75 "Face for Info node names."
76 :group 'info)
77
185cff95
JL
78(defface info-title-1
79 '((((type tty pc) (class color) (background light))
80 :foreground "green" :weight bold)
81 (((type tty pc) (class color) (background dark))
82 :foreground "yellow" :weight bold)
83 (t :height 1.2 :inherit info-title-2))
84 "Face for info titles at level 1."
85 :group 'info)
c4f6e489 86(define-obsolete-face-alias 'Info-title-1-face 'info-title-1 "22.1")
185cff95
JL
87
88(defface info-title-2
89 '((((type tty pc) (class color)) :foreground "lightblue" :weight bold)
90 (t :height 1.2 :inherit info-title-3))
91 "Face for info titles at level 2."
92 :group 'info)
c4f6e489 93(define-obsolete-face-alias 'Info-title-2-face 'info-title-2 "22.1")
185cff95
JL
94
95(defface info-title-3
96 '((((type tty pc) (class color)) :weight bold)
97 (t :height 1.2 :inherit info-title-4))
98 "Face for info titles at level 3."
99 :group 'info)
c4f6e489 100(define-obsolete-face-alias 'Info-title-3-face 'info-title-3 "22.1")
185cff95
JL
101
102(defface info-title-4
103 '((((type tty pc) (class color)) :weight bold)
104 (t :weight bold :inherit variable-pitch))
105 "Face for info titles at level 4."
106 :group 'info)
c4f6e489 107(define-obsolete-face-alias 'Info-title-4-face 'info-title-4 "22.1")
185cff95
JL
108
109(defface info-menu-header
110 '((((type tty pc))
111 :underline t
112 :weight bold)
113 (t
114 :inherit variable-pitch
115 :weight bold))
116 "Face for headers in Info menus."
117 :group 'info)
118
119(defface info-menu-star
508bce68
SM
120 '((((class color)) :foreground "red1")
121 (t :underline t))
ccfb7415 122 "Face for every third `*' in an Info menu."
93480d70 123 :group 'info)
c33d614d 124(define-obsolete-face-alias 'info-menu-5 'info-menu-star "22.1")
93480d70
RS
125
126(defface info-xref
de8ad208
JL
127 '((t :inherit link))
128 "Face for unvisited Info cross-references."
93480d70
RS
129 :group 'info)
130
8a7757f6 131(defface info-xref-visited
fd5b25da 132 '((t :inherit (link-visited info-xref)))
8a7757f6 133 "Face for visited Info cross-references."
de8ad208 134 :version "22.1"
8a7757f6
JL
135 :group 'info)
136
137(defcustom Info-fontify-visited-nodes t
9201cc28 138 "Non-nil to fontify references to visited nodes in `info-xref-visited' face."
bf247b6e 139 :version "22.1"
8a7757f6
JL
140 :type 'boolean
141 :group 'info)
142
7a7821c2 143(defcustom Info-fontify-maximum-menu-size 100000
9201cc28 144 "Maximum size of menu to fontify if `font-lock-mode' is non-nil.
3d0fc0b7 145Set to nil to disable node fontification."
ded3e3d8
RS
146 :type 'integer
147 :group 'info)
bdf62a4d 148
50ac70af 149(defcustom Info-use-header-line t
9201cc28 150 "Non-nil means to put the beginning-of-node links in an Emacs header-line.
50ac70af
MB
151A header-line does not scroll with the rest of the buffer."
152 :type 'boolean
153 :group 'info)
154
155(defface info-header-xref
508bce68 156 '((t :inherit info-xref))
50ac70af
MB
157 "Face for Info cross-references in a node header."
158 :group 'info)
159
160(defface info-header-node
508bce68 161 '((t :inherit info-node))
50ac70af
MB
162 "Face for Info nodes in a node header."
163 :group 'info)
164
7d3766a8 165(defvar Info-directory-list nil
a384cab3 166 "List of directories to search for Info documentation files.
fc4d14c5 167If nil, meaning not yet initialized, Info uses the environment
44c327f9 168variable INFOPATH to initialize it, or `Info-default-directory-list'
dde7f979
SM
169if there is no INFOPATH variable in the environment, or the
170concatenation of the two if INFOPATH ends with a colon.
778911b9
EZ
171
172When `Info-directory-list' is initialized from the value of
4dddb0b7
EZ
173`Info-default-directory-list', and Emacs is installed in one of the
174standard directories, the directory of Info files that come with Emacs
175is put last (so that local Info files override standard ones).
176
177When `Info-directory-list' is initialized from the value of
178`Info-default-directory-list', and Emacs is not installed in one
179of the standard directories, the first element of the resulting
778911b9
EZ
180list is the directory where Emacs installs the Info files that
181come with it. This is so that Emacs's own manual, which suits the
4dddb0b7
EZ
182version of Emacs you are using, will always be found first. This
183is useful when you install an experimental version of Emacs without
184removing the standard installation.
185
186If you want to override the order of directories in
187`Info-default-directory-list', set INFOPATH in the environment.
5da0f945
RS
188
189If you run the Emacs executable from the `src' directory in the Emacs
778911b9
EZ
190source tree, and INFOPATH is not defined, the `info' directory in the
191source tree is used as the first element of `Info-directory-list', in
192place of the installation Info directory. This is useful when you run
193a version of Emacs without installing it.")
a384cab3 194
ded3e3d8 195(defcustom Info-additional-directory-list nil
bdf62a4d 196 "List of additional directories to search for Info documentation files.
e9b1d996 197These directories are searched after those in `Info-directory-list'."
ded3e3d8
RS
198 :type '(repeat directory)
199 :group 'info)
bdf62a4d 200
610bc96b 201(defcustom Info-scroll-prefer-subnodes nil
9201cc28 202 "If non-nil, \\<Info-mode-map>\\[Info-scroll-up] in a menu visits subnodes.
185cff95 203
7a53d8c8
EZ
204If this is non-nil, and you scroll far enough in a node that its menu
205appears on the screen, the next \\<Info-mode-map>\\[Info-scroll-up]
206moves to a subnode indicated by the following menu item. This means
207that you visit a subnode before getting to the end of the menu.
208
209Setting this option to nil results in behavior similar to the stand-alone
210Info reader program, which visits the first subnode from the menu only
211when you hit the end of the current node."
bf247b6e 212 :version "22.1"
7a53d8c8
EZ
213 :type 'boolean
214 :group 'info)
215
a9efebd0 216(defcustom Info-hide-note-references t
9201cc28 217 "If non-nil, hide the tag and section reference in *note and * menu items.
8a7757f6 218If value is non-nil but not `hide', also replaces the \"*note\" with \"see\".
185cff95 219If value is non-nil but not t or `hide', the reference section is still shown.
a0b8485f
GM
220`nil' completely disables this feature. If this is non-nil, you might
221want to set `Info-refill-paragraphs'."
bf247b6e 222 :version "22.1"
8a7757f6 223 :type '(choice (const :tag "No hiding" nil)
0452a274 224 (const :tag "Replace tag and hide reference" t)
8a7757f6
JL
225 (const :tag "Hide tag and reference" hide)
226 (other :tag "Only replace tag" tag))
a9efebd0
KS
227 :group 'info)
228
bb1e1730 229(defcustom Info-refill-paragraphs nil
9201cc28 230 "If non-nil, attempt to refill paragraphs with hidden references.
185cff95 231This refilling may accidentally remove explicit line breaks in the Info
a0b8485f
GM
232file, so be prepared for a few surprises if you enable this feature.
233This only has an effect if `Info-hide-note-references' is non-nil."
bf247b6e 234 :version "22.1"
bb1e1730
KS
235 :type 'boolean
236 :group 'info)
237
66fc722f
JL
238(defcustom Info-breadcrumbs-depth 4
239 "Depth of breadcrumbs to display.
2400 means do not display breadcrumbs."
241 :type 'integer)
242
180ee7c7 243(defcustom Info-search-whitespace-regexp "\\s-+"
9201cc28 244 "If non-nil, regular expression to match a sequence of whitespace chars.
8a7757f6
JL
245This applies to Info search for regular expressions.
246You might want to use something like \"[ \\t\\r\\n]+\" instead.
247In the Customization buffer, that is `[' followed by a space,
248a tab, a carriage return (control-M), a newline, and `]+'."
249 :type 'regexp
250 :group 'info)
251
98e77be5 252(defcustom Info-isearch-search t
9201cc28 253 "If non-nil, isearch in Info searches through multiple nodes.
6270bbe7
JL
254Before leaving the initial Info node, where isearch was started,
255it fails once with the error message [initial node], and with
256subsequent C-s/C-r continues through other nodes without failing
257with this error message in other nodes. When isearch fails for
258the rest of the manual, it wraps aroung the whole manual and
259restarts the search from the top/final node depending on
260search direction.
261
262Setting this option to nil restores the default isearch behavior
263with wrapping around the current Info node."
98e77be5
JL
264 :version "22.1"
265 :type 'boolean
266 :group 'info)
267
d457219d
JL
268(defvar Info-isearch-initial-node nil)
269
dde7f979
SM
270(defcustom Info-mode-hook
271 ;; Try to obey obsolete Info-fontify settings.
272 (unless (and (boundp 'Info-fontify) (null Info-fontify))
273 '(turn-on-font-lock))
8a7757f6
JL
274 "Hooks run when `Info-mode' is called."
275 :type 'hook
276 :group 'info)
277
278(defcustom Info-selection-hook nil
279 "Hooks run when `Info-select-node' is called."
544e5562
CW
280 :type 'hook
281 :group 'info)
282
8a7757f6
JL
283(defvar Info-edit-mode-hook nil
284 "Hooks run when `Info-edit-mode' is called.")
285
a384cab3 286(defvar Info-current-file nil
d6be34f3
RS
287 "Info file that Info is now looking at, or nil.
288This is the name that was specified in Info, not the actual file name.
d590dbd2 289It doesn't contain directory names or file name extensions added by Info.")
a384cab3
JB
290
291(defvar Info-current-subfile nil
fdf4b680 292 "Info subfile that is actually in the *info* buffer now.
ef9644f5 293It is nil if current Info file is not split into subfiles.")
a384cab3
JB
294
295(defvar Info-current-node nil
296 "Name of node that Info is now looking at, or nil.")
297
c5fe2ff1 298(defvar Info-tag-table-marker nil
a384cab3
JB
299 "Marker pointing at beginning of current Info file's tag table.
300Marker points nowhere if file has no tag table.")
301
c5fe2ff1
RS
302(defvar Info-tag-table-buffer nil
303 "Buffer used for indirect tag tables.")
304
552775bd
RS
305(defvar Info-current-file-completions nil
306 "Cached completion list for current Info file.")
307
94b10022
JL
308(defvar Info-file-supports-index-cookies nil
309 "Non-nil if current Info file supports index cookies.")
310
66fc722f
JL
311(defvar Info-file-supports-index-cookies-list nil
312 "List of Info files with information about index cookies support.
313Each element of the list is a list (FILENAME SUPPORTS-INDEX-COOKIES)
314where SUPPORTS-INDEX-COOKIES can be either t or nil.")
315
1143a6b0 316(defvar Info-index-alternatives nil
fdf4b680 317 "List of possible matches for last `Info-index' command.")
1143a6b0 318
836bb478
JL
319(defvar Info-point-loc nil
320 "Point location within a selected node.
321If string, the point is moved to the proper occurrence of the
322name of the followed cross reference within a selected node.
323If number, the point is moved to the corresponding line.")
8a7757f6 324
552775bd
RS
325(defvar Info-standalone nil
326 "Non-nil if Emacs was started solely as an Info browser.")
6a013a49
JL
327
328(defvar Info-virtual-files nil
329 "List of definitions of virtual Info files.
330Each element of the list has the format (FILENAME (OPERATION . HANDLER) ...)
331where FILENAME is a regexp that matches a class of virtual Info file names.
332It should be carefully chosen to not cause file name clashes with
333existing file names. OPERATION is one of the following operation
334symbols `find-file', `find-node', `toc-nodes' that define what HANDLER
335function to call instead of calling the default corresponding function
336to override it.")
337
338(defvar Info-virtual-nodes nil
339 "List of definitions of virtual Info nodes.
340Each element of the list has the format (NODENAME (OPERATION . HANDLER) ...)
341where NODENAME is a regexp that matches a class of virtual Info node names.
342It should be carefully chosen to not cause node name clashes with
343existing node names. OPERATION is one of the following operation
344symbols `find-node' that define what HANDLER
345function to call instead of calling the default corresponding function
346to override it.")
347
348(defvar Info-current-node-virtual nil
349 "Non-nil if the current Info node is virtual.")
350
351(defun Info-virtual-file-p (filename)
352 "Check if Info file FILENAME is virtual."
353 (Info-virtual-fun 'find-file filename nil))
354
355(defun Info-virtual-fun (op filename nodename)
356 "Find a function that handles operations on virtual manuals.
357OP is an operation symbol (`find-file', `find-node' or `toc-nodes'),
358FILENAME is a virtual Info file name, NODENAME is a virtual Info
359node name. Return a function found either in `Info-virtual-files'
360or `Info-virtual-nodes'."
361 (or (and (stringp filename) ; some legacy code can still use a symbol
362 (cdr-safe (assoc op (assoc-default filename
363 Info-virtual-files
364 'string-match))))
365 (and (stringp nodename) ; some legacy code can still use a symbol
366 (cdr-safe (assoc op (assoc-default nodename
367 Info-virtual-nodes
368 'string-match))))))
369
370(defun Info-virtual-call (virtual-fun &rest args)
371 "Call a function that handles operations on virtual manuals."
372 (when (functionp virtual-fun)
373 (or (apply virtual-fun args) t)))
374
7d3766a8 375\f
bd0c9168 376(defvar Info-suffix-list
3c19e6c1
RS
377 ;; The MS-DOS list should work both when long file names are
378 ;; supported (Windows 9X), and when only 8+3 file names are available.
bd0c9168
RS
379 (if (eq system-type 'ms-dos)
380 '( (".gz" . "gunzip")
381 (".z" . "gunzip")
544e210f 382 (".bz2" . ("bzip2" "-dc"))
3c19e6c1
RS
383 (".inz" . "gunzip")
384 (".igz" . "gunzip")
385 (".info.Z" . "gunzip")
386 (".info.gz" . "gunzip")
387 ("-info.Z" . "gunzip")
388 ("-info.gz" . "gunzip")
389 ("/index.gz". "gunzip")
390 ("/index.z" . "gunzip")
9b842cab 391 (".inf" . nil)
3c19e6c1
RS
392 (".info" . nil)
393 ("-info" . nil)
394 ("/index" . nil)
bd0c9168 395 ("" . nil))
a70dc410
RS
396 '( (".info.Z". "uncompress")
397 (".info.Y". "unyabba")
398 (".info.gz". "gunzip")
399 (".info.z". "gunzip")
544e210f 400 (".info.bz2" . ("bzip2" "-dc"))
a70dc410
RS
401 (".info". nil)
402 ("-info.Z". "uncompress")
403 ("-info.Y". "unyabba")
404 ("-info.gz". "gunzip")
544e210f 405 ("-info.bz2" . ("bzip2" "-dc"))
a70dc410
RS
406 ("-info.z". "gunzip")
407 ("-info". nil)
408 ("/index.Z". "uncompress")
409 ("/index.Y". "unyabba")
410 ("/index.gz". "gunzip")
411 ("/index.z". "gunzip")
544e210f 412 ("/index.bz2". ("bzip2" "-dc"))
a70dc410
RS
413 ("/index". nil)
414 (".Z". "uncompress")
415 (".Y". "unyabba")
416 (".gz". "gunzip")
417 (".z". "gunzip")
544e210f 418 (".bz2" . ("bzip2" "-dc"))
a70dc410 419 ("". nil)))
1143a6b0
ER
420 "List of file name suffixes and associated decoding commands.
421Each entry should be (SUFFIX . STRING); the file is given to
544e210f
KH
422the command as standard input.
423
424STRING may be a list of strings. In that case, the first element is
425the command name, and the rest are arguments to that command.
426
427If STRING is nil, no decoding is done.
97f99202
KH
428Because the SUFFIXes are tried in order, the empty string should
429be last in the list.")
1143a6b0 430
c8e9dd54 431;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
e0c1e774
EZ
432;; First, on MS-DOS with no long file names support, delete some of
433;; the extension in FILENAME to make room.
434(defun info-insert-file-contents-1 (filename suffix lfn)
435 (if lfn ; long file names are supported
bd0c9168
RS
436 (concat filename suffix)
437 (let* ((sans-exts (file-name-sans-extension filename))
c8e9dd54
RS
438 ;; How long is the extension in FILENAME (not counting the dot).
439 (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
440 ext-left)
9b842cab 441 ;; SUFFIX starts with a dot. If FILENAME already has one,
1583fe94 442 ;; get rid of the one in SUFFIX (unless suffix is empty).
c8e9dd54 443 (or (and (<= ext-len 0)
9b842cab 444 (not (eq (aref filename (1- (length filename))) ?.)))
1583fe94 445 (= (length suffix) 0)
9b842cab 446 (setq suffix (substring suffix 1)))
c8e9dd54
RS
447 ;; How many chars of that extension should we keep?
448 (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
bd0c9168
RS
449 ;; Get rid of the rest of the extension, and add SUFFIX.
450 (concat (substring filename 0 (- (length filename)
451 (- ext-len ext-left)))
452 suffix))))
453
9c7924d5
RS
454(defun info-file-exists-p (filename)
455 (and (file-exists-p filename)
456 (not (file-directory-p filename))))
457
1143a6b0 458(defun info-insert-file-contents (filename &optional visit)
185cff95 459 "Insert the contents of an Info file in the current buffer.
1143a6b0 460Do the right thing if the file has been compressed or zipped."
e0c1e774 461 (let* ((tail Info-suffix-list)
ab5a535c
KS
462 (lfn (if (fboundp 'msdos-long-file-names)
463 (msdos-long-file-names)
464 t))
e0c1e774
EZ
465 (check-short (and (fboundp 'msdos-long-file-names)
466 lfn))
467 fullname decoder done)
b8fa4e87 468 (if (info-file-exists-p filename)
bd0c9168
RS
469 ;; FILENAME exists--see if that name contains a suffix.
470 ;; If so, set DECODE accordingly.
97f99202
KH
471 (progn
472 (while (and tail
473 (not (string-match
474 (concat (regexp-quote (car (car tail))) "$")
475 filename)))
476 (setq tail (cdr tail)))
477 (setq fullname filename
478 decoder (cdr (car tail))))
bd0c9168 479 ;; Try adding suffixes to FILENAME and see if we can find something.
e0c1e774
EZ
480 (while (and tail (not done))
481 (setq fullname (info-insert-file-contents-1 filename
482 (car (car tail)) lfn))
483 (if (info-file-exists-p fullname)
484 (setq done t
485 ;; If we found a file with a suffix, set DECODER
486 ;; according to the suffix.
487 decoder (cdr (car tail)))
488 ;; When the MS-DOS port runs on Windows, we need to check
489 ;; the short variant of a long file name as well.
490 (when check-short
491 (setq fullname (info-insert-file-contents-1 filename
492 (car (car tail)) nil))
493 (if (info-file-exists-p fullname)
494 (setq done t
495 decoder (cdr (car tail))))))
97f99202 496 (setq tail (cdr tail)))
97f99202 497 (or tail
bd0c9168 498 (error "Can't find %s or any compressed version of it" filename)))
e175bda2 499 ;; check for conflict with jka-compr
70746649 500 (if (and (jka-compr-installed-p)
e175bda2
RS
501 (jka-compr-get-compression-info fullname))
502 (setq decoder nil))
97f99202 503 (if decoder
3c19e6c1
RS
504 (progn
505 (insert-file-contents-literally fullname visit)
e8dab975 506 (let ((inhibit-read-only t)
3c19e6c1 507 (coding-system-for-write 'no-conversion)
8b5e8b42 508 (inhibit-null-byte-detection t) ; Index nodes include null bytes
3c19e6c1
RS
509 (default-directory (or (file-name-directory fullname)
510 default-directory)))
544e210f
KH
511 (or (consp decoder)
512 (setq decoder (list decoder)))
513 (apply 'call-process-region (point-min) (point-max)
514 (car decoder) t t nil (cdr decoder))))
8b5e8b42
EZ
515 (let ((inhibit-null-byte-detection t)) ; Index nodes include null bytes
516 (insert-file-contents fullname visit)))))
66fc722f
JL
517
518(defun Info-file-supports-index-cookies (&optional file)
519 "Return non-nil value if FILE supports Info index cookies.
520Info index cookies were first introduced in 4.7, and all later
2a567197 521makeinfo versions output them in index nodes, so we can rely
66fc722f
JL
522solely on the makeinfo version. This function caches the information
523in `Info-file-supports-index-cookies-list'."
524 (or file (setq file Info-current-file))
525 (or (assoc file Info-file-supports-index-cookies-list)
526 ;; Skip virtual Info files
527 (and (or (not (stringp file))
6a013a49 528 (Info-virtual-file-p file))
66fc722f
JL
529 (setq Info-file-supports-index-cookies-list
530 (cons (cons file nil) Info-file-supports-index-cookies-list)))
531 (save-excursion
532 (let ((found nil))
533 (goto-char (point-min))
534 (condition-case ()
535 (if (and (re-search-forward
536 "makeinfo[ \n]version[ \n]\\([0-9]+.[0-9]+\\)"
537 (line-beginning-position 3) t)
538 (not (version< (match-string 1) "4.7")))
539 (setq found t))
540 (error nil))
541 (setq Info-file-supports-index-cookies-list
542 (cons (cons file found) Info-file-supports-index-cookies-list)))))
543 (cdr (assoc file Info-file-supports-index-cookies-list)))
544
7d3766a8 545\f
3a59b662
SM
546(defun Info-default-dirs ()
547 (let ((source (expand-file-name "info/" source-directory))
548 (sibling (if installation-directory
549 (expand-file-name "info/" installation-directory)
550 (if invocation-directory
551 (let ((infodir (expand-file-name
41a1027e 552 "../share/info/"
3a59b662
SM
553 invocation-directory)))
554 (if (file-exists-p infodir)
555 infodir
556 (setq infodir (expand-file-name
41a1027e 557 "../../../share/info/"
3a59b662
SM
558 invocation-directory))
559 (and (file-exists-p infodir)
560 infodir))))))
561 alternative)
562 (setq alternative
563 (if (and sibling (file-exists-p sibling))
564 ;; Uninstalled, Emacs builddir != srcdir.
565 sibling
566 ;; Uninstalled, builddir == srcdir
567 source))
568 (if (or (member alternative Info-default-directory-list)
569 ;; On DOS/NT, we use movable executables always,
570 ;; and we must always find the Info dir at run time.
571 (if (memq system-type '(ms-dos windows-nt))
572 nil
573 ;; Use invocation-directory for Info
574 ;; only if we used it for exec-directory also.
575 (not (string= exec-directory
576 (expand-file-name "lib-src/"
577 installation-directory))))
578 (not (file-exists-p alternative)))
579 Info-default-directory-list
580 ;; `alternative' contains the Info files that came with this
581 ;; version, so we should look there first. `Info-insert-dir'
582 ;; currently expects to find `alternative' first on the list.
583 (cons alternative
a025fccf
SM
584 ;; Don't drop the last part, it might contain non-Emacs stuff.
585 ;; (reverse (cdr (reverse
586 Info-default-directory-list)))) ;; )))
3a59b662 587
7d3766a8 588(defun info-initialize ()
fdf4b680 589 "Initialize `Info-directory-list', if that hasn't been done yet."
7d3766a8 590 (unless Info-directory-list
3a59b662 591 (let ((path (getenv "INFOPATH")))
7d3766a8 592 (setq Info-directory-list
78e7e8a0
MB
593 (prune-directory-list
594 (if path
3a59b662
SM
595 (if (string-match ":\\'" path)
596 (append (split-string (substring path 0 -1)
597 (regexp-quote path-separator))
598 (Info-default-dirs))
599 (split-string path (regexp-quote path-separator)))
600 (Info-default-dirs)))))))
1143a6b0 601
a6e4564e 602;;;###autoload
94807253 603(defun info-other-window (&optional file-or-node)
a6e4564e
RS
604 "Like `info' but show the Info buffer in another window."
605 (interactive (if current-prefix-arg
606 (list (read-file-name "Info file name: " nil nil t))))
836bb478 607 (let (same-window-buffer-names same-window-regexps)
94807253 608 (info file-or-node)))
399c88ad 609
6bdad9ae 610;;;###autoload (add-hook 'same-window-regexps (purecopy "\\*info\\*\\(\\|<[0-9]+>\\)"))
211d6309 611
6bdad9ae 612;;;###autoload (put 'info 'info-file (purecopy "emacs"))
a384cab3 613;;;###autoload
94807253 614(defun info (&optional file-or-node buffer)
a384cab3 615 "Enter Info, the documentation browser.
94807253 616Optional argument FILE-OR-NODE specifies the file to examine;
a384cab3 617the default is the top-level directory of Info.
94807253 618Called from a program, FILE-OR-NODE may specify an Info node of the form
83d5c772 619`(FILENAME)NODENAME'.
836bb478
JL
620Optional argument BUFFER specifies the Info buffer name;
621the default buffer name is *info*. If BUFFER exists,
622just switch to BUFFER. Otherwise, create a new buffer
623with the top-level Info directory.
a384cab3 624
836bb478
JL
625In interactive use, a non-numeric prefix argument directs
626this command to read a file name from the minibuffer.
bc224645
JL
627A numeric prefix argument selects an Info buffer with the prefix number
628appended to the Info buffer name.
e341dab2
RS
629
630The search path for Info files is in the variable `Info-directory-list'.
399c88ad 631The top-level Info directory is made by combining all the files named `dir'
88e1d519
JL
632in all the directories in that path.
633
634See a list of available Info commands in `Info-mode'."
836bb478
JL
635 (interactive (list
636 (if (and current-prefix-arg (not (numberp current-prefix-arg)))
637 (read-file-name "Info file name: " nil nil t))
638 (if (numberp current-prefix-arg)
639 (format "*info*<%s>" current-prefix-arg))))
640 (pop-to-buffer (or buffer "*info*"))
641 (if (and buffer (not (eq major-mode 'Info-mode)))
642 (Info-mode))
94807253 643 (if file-or-node
60705054
SM
644 ;; If argument already contains parentheses, don't add another set
645 ;; since the argument will then be parsed improperly. This also
646 ;; has the added benefit of allowing node names to be included
647 ;; following the parenthesized filename.
83040cb0 648 (Info-goto-node
94807253
JL
649 (if (and (stringp file-or-node) (string-match "(.*)" file-or-node))
650 file-or-node
651 (concat "(" file-or-node ")")))
b0dd5bf5
RS
652 (if (and (zerop (buffer-size))
653 (null Info-history))
654 ;; If we just created the Info buffer, go to the directory.
655 (Info-directory))))
a384cab3 656
c3717746
RS
657;;;###autoload
658(defun info-emacs-manual ()
3a8803c0 659 "Display the Emacs manual in Info mode."
c3717746
RS
660 (interactive)
661 (info "emacs"))
662
552775bd
RS
663;;;###autoload
664(defun info-standalone ()
665 "Run Emacs as a standalone Info reader.
666Usage: emacs -f info-standalone [filename]
667In standalone mode, \\<Info-mode-map>\\[Info-exit] exits Emacs itself."
668 (setq Info-standalone t)
669 (if (and command-line-args-left
670 (not (string-match "^-" (car command-line-args-left))))
671 (condition-case err
672 (progn
673 (info (car command-line-args-left))
674 (setq command-line-args-left (cdr command-line-args-left)))
675 (error (send-string-to-terminal
676 (format "%s\n" (if (eq (car-safe err) 'error)
677 (nth 1 err) err)))
678 (save-buffers-kill-emacs)))
679 (info)))
7d3766a8 680\f
983dfbf8 681;; See if the accessible portion of the buffer begins with a node
11638562
EZ
682;; delimiter, and the node header line which follows matches REGEXP.
683;; Typically, this test will be followed by a loop that examines the
684;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
685;; to have the overhead of this special test inside the loop.
686
687;; This function changes match-data, but supposedly the caller might
688;; want to use the results of re-search-backward.
689
690;; The return value is the value of point at the beginning of matching
983dfbf8 691;; REGEXP, if the function succeeds, nil otherwise.
11638562 692(defun Info-node-at-bob-matching (regexp)
760d5cb3
GM
693 (and (bobp) ; are we at beginning of buffer?
694 (looking-at "\^_") ; does it begin with node delimiter?
11638562
EZ
695 (let (beg)
696 (forward-line 1)
697 (setq beg (point))
760d5cb3 698 (forward-line 1) ; does the line after delimiter match REGEXP?
11638562
EZ
699 (re-search-backward regexp beg t))))
700
8a7757f6
JL
701(defun Info-find-file (filename &optional noerror)
702 "Return expanded FILENAME, or t, if FILENAME is \"dir\".
703Optional second argument NOERROR, if t, means if file is not found
704just return nil (no error)."
a384cab3
JB
705 ;; Convert filename to lower case if not found as specified.
706 ;; Expand it.
6a013a49
JL
707 (cond
708 ((Info-virtual-call
709 (Info-virtual-fun 'find-file filename nil)
710 filename noerror))
711 ((stringp filename)
712 (let (temp temp-downcase found)
713 (setq filename (substitute-in-file-name filename))
714 (let ((dirs (if (string-match "^\\./" filename)
715 ;; If specified name starts with `./'
716 ;; then just try current directory.
717 '("./")
718 (if (file-name-absolute-p filename)
719 ;; No point in searching for an
720 ;; absolute file name
721 '(nil)
722 (if Info-additional-directory-list
723 (append Info-directory-list
724 Info-additional-directory-list)
725 Info-directory-list)))))
726 ;; Search the directory list for file FILENAME.
727 (while (and dirs (not found))
728 (setq temp (expand-file-name filename (car dirs)))
729 (setq temp-downcase
730 (expand-file-name (downcase filename) (car dirs)))
731 ;; Try several variants of specified name.
732 (let ((suffix-list Info-suffix-list)
733 (lfn (if (fboundp 'msdos-long-file-names)
734 (msdos-long-file-names)
735 t)))
736 (while (and suffix-list (not found))
737 (cond ((info-file-exists-p
738 (info-insert-file-contents-1
739 temp (car (car suffix-list)) lfn))
740 (setq found temp))
741 ((info-file-exists-p
742 (info-insert-file-contents-1
743 temp-downcase (car (car suffix-list)) lfn))
744 (setq found temp-downcase))
745 ((and (fboundp 'msdos-long-file-names)
746 lfn
747 (info-file-exists-p
748 (info-insert-file-contents-1
749 temp (car (car suffix-list)) nil)))
750 (setq found temp)))
751 (setq suffix-list (cdr suffix-list))))
752 (setq dirs (cdr dirs))))
753 (if found
754 (setq filename found)
755 (if noerror
756 (setq filename nil)
757 (error "Info file %s does not exist" filename)))
758 filename))))
8a7757f6
JL
759
760(defun Info-find-node (filename nodename &optional no-going-back)
185cff95 761 "Go to an Info node specified as separate FILENAME and NODENAME.
8a7757f6
JL
762NO-GOING-BACK is non-nil if recovering from an error in this function;
763it says do not attempt further (recursive) error recovery."
764 (info-initialize)
765 (setq filename (Info-find-file filename))
185cff95 766 ;; Go into Info buffer.
6270bbe7 767 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
b0dd5bf5
RS
768 ;; Record the node we are leaving, if we were in one.
769 (and (not no-going-back)
770 Info-current-file
159dfdde
SM
771 (push (list Info-current-file Info-current-node (point))
772 Info-history))
4fceda3c
SM
773 (Info-find-node-2 filename nodename no-going-back))
774
d590dbd2 775;;;###autoload
4fceda3c 776(defun Info-on-current-buffer (&optional nodename)
70746649
RS
777 "Use Info mode to browse the current Info buffer.
778With a prefix arg, this queries for the node name to visit first;
779otherwise, that defaults to `Top'."
4fceda3c
SM
780 (interactive
781 (list (if current-prefix-arg
782 (completing-read "Node name: " (Info-build-node-completions)
07e91aa3
SM
783 nil t "Top"))))
784 (unless nodename (setq nodename "Top"))
75296efc 785 (info-initialize)
4fceda3c 786 (Info-mode)
d590dbd2
CY
787 (set (make-local-variable 'Info-current-file)
788 (or buffer-file-name
789 ;; If called on a non-file buffer, make a fake file name.
790 (concat default-directory (buffer-name))))
4fceda3c
SM
791 (Info-find-node-2 nil nodename))
792
f584b4c7 793;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
e56f84d7
TTN
794;; but at least it keeps this routine (which is for makeinfo-buffer and
795;; Info-revert-buffer-function) out of the way of normal operations.
f584b4c7
RS
796;;
797(defun Info-revert-find-node (filename nodename)
185cff95 798 "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
f584b4c7
RS
799When *info* is already displaying FILENAME and NODENAME, the window position
800is preserved, if possible."
801 (pop-to-buffer "*info*")
802 (let ((old-filename Info-current-file)
803 (old-nodename Info-current-node)
804 (pcolumn (current-column))
805 (pline (count-lines (point-min) (line-beginning-position)))
806 (wline (count-lines (point-min) (window-start)))
807 (old-history Info-history)
96639c89
JL
808 (new-history (and Info-current-file
809 (list Info-current-file Info-current-node (point)))))
f584b4c7
RS
810 (kill-buffer (current-buffer))
811 (Info-find-node filename nodename)
812 (setq Info-history old-history)
813 (if (and (equal old-filename Info-current-file)
814 (equal old-nodename Info-current-node))
815 (progn
816 ;; note goto-line is no good, we want to measure from point-min
cb7de2e7 817 (goto-char (point-min))
f584b4c7
RS
818 (forward-line wline)
819 (set-window-start (selected-window) (point))
cb7de2e7 820 (goto-char (point-min))
f584b4c7
RS
821 (forward-line pline)
822 (move-to-column pcolumn))
823 ;; only add to the history when coming from a different file+node
824 (if new-history
825 (setq Info-history (cons new-history Info-history))))))
826
e56f84d7
TTN
827(defun Info-revert-buffer-function (ignore-auto noconfirm)
828 (when (or noconfirm (y-or-n-p "Revert info buffer? "))
829 (Info-revert-find-node Info-current-file Info-current-node)
830 (message "Reverted %s" Info-current-file)))
831
357d11de
GM
832(defun Info-find-in-tag-table-1 (marker regexp case-fold)
833 "Find a node in a tag table.
834MARKER specifies the buffer and position to start searching at.
835REGEXP is a regular expression matching nodes or references. Its first
836group should match `Node:' or `Ref:'.
837CASE-FOLD t means search for a case-insensitive match.
838If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
839FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
840where the match was found, and MODE is `major-mode' of the buffer in
841which the match was found."
dde7f979 842 (let ((case-fold-search case-fold))
e8dab975 843 (with-current-buffer (marker-buffer marker)
357d11de 844 (goto-char marker)
921e5fe6 845
357d11de
GM
846 ;; Search tag table
847 (beginning-of-line)
848 (when (re-search-forward regexp nil t)
849 (list (string-equal "Ref:" (match-string 1))
365d2503 850 (+ (point-min) (read (current-buffer)))
357d11de
GM
851 major-mode)))))
852
853(defun Info-find-in-tag-table (marker regexp)
854 "Find a node in a tag table.
855MARKER specifies the buffer and position to start searching at.
856REGEXP is a regular expression matching nodes or references. Its first
857group should match `Node:' or `Ref:'.
858If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
859FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
860where the match was found, and MODE is `major-mode' of the buffer in
861which the match was found.
862This function tries to find a case-sensitive match first, then a
863case-insensitive match is tried."
864 (let ((result (Info-find-in-tag-table-1 marker regexp nil)))
865 (when (null (car result))
866 (setq result (Info-find-in-tag-table-1 marker regexp t)))
867 result))
868
869(defun Info-find-node-in-buffer-1 (regexp case-fold)
870 "Find a node or anchor in the current buffer.
871REGEXP is a regular expression matching nodes or references. Its first
872group should match `Node:' or `Ref:'.
873CASE-FOLD t means search for a case-insensitive match.
874Value is the position at which a match was found, or nil if not found."
875 (let ((case-fold-search case-fold)
876 found)
877 (save-excursion
878 (when (Info-node-at-bob-matching regexp)
879 (setq found (point)))
880 (while (and (not found)
881 (search-forward "\n\^_" nil t))
882 (forward-line 1)
883 (let ((beg (point)))
884 (forward-line 1)
885 (when (re-search-backward regexp beg t)
886 (beginning-of-line)
887 (setq found (point)))))
888 found)))
921e5fe6 889
357d11de
GM
890(defun Info-find-node-in-buffer (regexp)
891 "Find a node or anchor in the current buffer.
892REGEXP is a regular expression matching nodes or references. Its first
893group should match `Node:' or `Ref:'.
894Value is the position at which a match was found, or nil if not found.
895This function looks for a case-sensitive match first. If none is found,
896a case-insensitive match is tried."
897 (or (Info-find-node-in-buffer-1 regexp nil)
898 (Info-find-node-in-buffer-1 regexp t)))
921e5fe6 899
4fceda3c 900(defun Info-find-node-2 (filename nodename &optional no-going-back)
9e5c2f50 901 (buffer-disable-undo (current-buffer))
a384cab3
JB
902 (or (eq major-mode 'Info-mode)
903 (Info-mode))
904 (widen)
905 (setq Info-current-node nil)
906 (unwind-protect
8bdf4b20 907 (let ((case-fold-search t)
6a013a49
JL
908 (virtual-fun (Info-virtual-fun 'find-node
909 (or filename Info-current-file)
910 nodename))
8bdf4b20 911 anchorpos)
6a013a49
JL
912 (cond
913 ((functionp virtual-fun)
914 (let ((filename (or filename Info-current-file)))
6a013a49 915 (setq buffer-read-only nil)
30760c8b
JL
916 (setq Info-current-file filename
917 Info-current-subfile nil
918 Info-current-file-completions nil
919 buffer-file-name nil)
6a013a49 920 (erase-buffer)
6a013a49
JL
921 (Info-virtual-call virtual-fun filename nodename no-going-back)
922 (set-marker Info-tag-table-marker nil)
923 (setq buffer-read-only t)
924 (set-buffer-modified-p nil)
925 (set (make-local-variable 'Info-current-node-virtual) t)))
926 ((not (and
927 ;; Reread a file when moving from a virtual node.
928 (not Info-current-node-virtual)
929 (or (null filename)
930 (equal Info-current-file filename))))
931 ;; Switch files if necessary
932 (let ((inhibit-read-only t))
30760c8b
JL
933 (when Info-current-node-virtual
934 ;; When moving from a virtual node.
935 (set (make-local-variable 'Info-current-node-virtual) nil)
936 (if (null filename)
937 (setq filename Info-current-file)))
6a013a49
JL
938 (setq Info-current-file nil
939 Info-current-subfile nil
940 Info-current-file-completions nil
941 buffer-file-name nil)
942 (erase-buffer)
943 (info-insert-file-contents filename nil)
944 (setq default-directory (file-name-directory filename))
945 (set-buffer-modified-p nil)
946 (set (make-local-variable 'Info-file-supports-index-cookies)
947 (Info-file-supports-index-cookies filename))
948
949 ;; See whether file has a tag table. Record the location if yes.
950 (goto-char (point-max))
951 (forward-line -8)
952 ;; Use string-equal, not equal, to ignore text props.
953 (if (not (or (string-equal nodename "*")
954 (not
955 (search-forward "\^_\nEnd tag table\n" nil t))))
956 (let (pos)
957 ;; We have a tag table. Find its beginning.
958 ;; Is this an indirect file?
959 (search-backward "\nTag table:\n")
960 (setq pos (point))
961 (if (save-excursion
962 (forward-line 2)
963 (looking-at "(Indirect)\n"))
964 ;; It is indirect. Copy it to another buffer
965 ;; and record that the tag table is in that buffer.
966 (let ((buf (current-buffer))
967 (tagbuf
968 (or Info-tag-table-buffer
969 (generate-new-buffer " *info tag table*"))))
970 (setq Info-tag-table-buffer tagbuf)
971 (with-current-buffer tagbuf
972 (buffer-disable-undo (current-buffer))
973 (setq case-fold-search t)
974 (erase-buffer)
975 (insert-buffer-substring buf))
976 (set-marker Info-tag-table-marker
977 (match-end 0) tagbuf))
978 (set-marker Info-tag-table-marker pos)))
979 (set-marker Info-tag-table-marker nil))
980 (setq Info-current-file filename)
981 )))
982
37a3ff5b
RS
983 ;; Use string-equal, not equal, to ignore text props.
984 (if (string-equal nodename "*")
985 (progn (setq Info-current-node nodename)
986 (Info-set-mode-line))
987 ;; Possibilities:
988 ;;
989 ;; 1. Anchor found in tag table
990 ;; 2. Anchor *not* in tag table
991 ;;
992 ;; 3. Node found in tag table
993 ;; 4. Node *not* found in tag table, but found in file
994 ;; 5. Node *not* in tag table, and *not* in file
995 ;;
996 ;; *Or* the same, but in an indirect subfile.
997
998 ;; Search file for a suitable node.
8bdf4b20 999 (let ((guesspos (point-min))
357d11de 1000 (regexp (concat "\\(Node:\\|Ref:\\) *\\("
4ce5c223 1001 (if (stringp nodename)
dd31e4e8
GM
1002 (regexp-quote nodename)
1003 "")
dde7f979 1004 "\\) *[,\t\n\177]")))
37a3ff5b 1005
82172606 1006 (catch 'foo
921e5fe6 1007
82172606 1008 ;; First, search a tag table, if any
357d11de
GM
1009 (when (marker-position Info-tag-table-marker)
1010 (let* ((m Info-tag-table-marker)
1011 (found (Info-find-in-tag-table m regexp)))
921e5fe6 1012
357d11de
GM
1013 (when found
1014 ;; FOUND is (ANCHOR POS MODE).
1015 (setq guesspos (nth 1 found))
921e5fe6 1016
357d11de
GM
1017 ;; If this is an indirect file, determine which
1018 ;; file really holds this node and read it in.
1019 (unless (eq (nth 2 found) 'Info-mode)
1020 ;; Note that the current buffer must be the
1021 ;; *info* buffer on entry to
1022 ;; Info-read-subfile. Thus the hackery above.
1023 (setq guesspos (Info-read-subfile guesspos)))
82172606
DL
1024
1025 ;; Handle anchor
357d11de
GM
1026 (when (nth 0 found)
1027 (goto-char (setq anchorpos guesspos))
1028 (throw 'foo t)))))
82172606
DL
1029
1030 ;; Else we may have a node, which we search for:
1031 (goto-char (max (point-min)
1032 (- (byte-to-position guesspos) 1000)))
921e5fe6 1033
357d11de
GM
1034 ;; Now search from our advised position (or from beg of
1035 ;; buffer) to find the actual node. First, check
1036 ;; whether the node is right where we are, in case the
1037 ;; buffer begins with a node.
1038 (let ((pos (Info-find-node-in-buffer regexp)))
1039 (when pos
1040 (goto-char pos)
141b49f5
JL
1041 (throw 'foo t)))
1042
1043 (when (string-match "\\([^.]+\\)\\." nodename)
1044 (let (Info-point-loc)
1045 (Info-find-node-2
1046 filename (match-string 1 nodename) no-going-back))
1047 (widen)
1048 (throw 'foo t))
1049
1050 ;; No such anchor in tag table or node in tag table or file
1051 (error "No such node or anchor: %s" nodename))
82172606
DL
1052
1053 (Info-select-node)
8a7757f6 1054 (goto-char (point-min))
73bde1a8
JL
1055 (forward-line 1) ; skip header line
1056 (when (> Info-breadcrumbs-depth 0) ; skip breadcrumbs line
1057 (forward-line 1))
1058
8a7757f6
JL
1059 (cond (anchorpos
1060 (let ((new-history (list Info-current-file
1061 (substring-no-properties nodename))))
1062 ;; Add anchors to the history too
1063 (setq Info-history-list
1064 (cons new-history
1065 (delete new-history Info-history-list))))
1066 (goto-char anchorpos))
836bb478 1067 ((numberp Info-point-loc)
3fbb3dc4 1068 (forward-line (- Info-point-loc 2))
836bb478
JL
1069 (setq Info-point-loc nil))
1070 ((stringp Info-point-loc)
1071 (Info-find-index-name Info-point-loc)
1072 (setq Info-point-loc nil))))))
a384cab3
JB
1073 ;; If we did not finish finding the specified node,
1074 ;; go back to the previous one.
4db579ab 1075 (or Info-current-node no-going-back (null Info-history)
37a3ff5b
RS
1076 (let ((hist (car Info-history)))
1077 (setq Info-history (cdr Info-history))
1078 (Info-find-node (nth 0 hist) (nth 1 hist) t)
1079 (goto-char (nth 2 hist))))))
a384cab3 1080
44c327f9
JB
1081;; Cache the contents of the (virtual) dir file, once we have merged
1082;; it for the first time, so we can save time subsequently.
7ea13762
RS
1083(defvar Info-dir-contents nil)
1084
44c327f9
JB
1085;; Cache for the directory we decided to use for the default-directory
1086;; of the merged dir text.
1087(defvar Info-dir-contents-directory nil)
1088
c142ab2d
RS
1089;; Record the file attributes of all the files from which we
1090;; constructed Info-dir-contents.
1091(defvar Info-dir-file-attributes nil)
1092
4fba3b2c
RS
1093(defvar Info-dir-file-name nil)
1094
7ea13762 1095;; Construct the Info directory node by merging the files named `dir'
44c327f9
JB
1096;; from various directories. Set the *info* buffer's
1097;; default-directory to the first directory we actually get any text
1098;; from.
7ea13762 1099(defun Info-insert-dir ()
c142ab2d
RS
1100 (if (and Info-dir-contents Info-dir-file-attributes
1101 ;; Verify that none of the files we used has changed
1102 ;; since we used it.
1103 (eval (cons 'and
b461e32d
SM
1104 (mapcar (lambda (elt)
1105 (let ((curr (file-attributes
1106 ;; Handle symlinks
1107 (file-truename (car elt)))))
1108
1109 ;; Don't compare the access time.
1110 (if curr (setcar (nthcdr 4 curr) 0))
1111 (setcar (nthcdr 4 (cdr elt)) 0)
1112 (equal (cdr elt) curr)))
c142ab2d 1113 Info-dir-file-attributes))))
4fba3b2c
RS
1114 (progn
1115 (insert Info-dir-contents)
1116 (goto-char (point-min)))
dd31e4e8 1117 (let ((dirs (if Info-additional-directory-list
b34dcc82
RS
1118 (append Info-directory-list
1119 Info-additional-directory-list)
1120 Info-directory-list))
1bd19a31 1121 (dir-file-attrs nil)
1bcedb3b
RS
1122 ;; Bind this in case the user sets it to nil.
1123 (case-fold-search t)
4fba3b2c
RS
1124 ;; This is set non-nil if we find a problem in some input files.
1125 problems
f4008b6e 1126 buffers buffer others nodes dirs-done)
44c327f9
JB
1127
1128 ;; Search the directory list for the directory file.
7ea13762 1129 (while dirs
8d1abb42
RS
1130 (let ((truename (file-truename (expand-file-name (car dirs)))))
1131 (or (member truename dirs-done)
1132 (member (directory-file-name truename) dirs-done)
1133 ;; Try several variants of specified name.
1134 ;; Try upcasing, appending `.info', or both.
825d6f08
RS
1135 (let* (file
1136 (attrs
1137 (or
1138 (progn (setq file (expand-file-name "dir" truename))
1139 (file-attributes file))
1140 (progn (setq file (expand-file-name "DIR" truename))
1141 (file-attributes file))
1142 (progn (setq file (expand-file-name "dir.info" truename))
1143 (file-attributes file))
1144 (progn (setq file (expand-file-name "DIR.INFO" truename))
1145 (file-attributes file)))))
8d1abb42
RS
1146 (setq dirs-done
1147 (cons truename
1148 (cons (directory-file-name truename)
1149 dirs-done)))
825d6f08 1150 (if attrs
e8dab975 1151 (with-current-buffer (generate-new-buffer " info dir")
825d6f08
RS
1152 (or buffers
1153 (message "Composing main Info directory..."))
9d499629 1154 (condition-case nil
8b5e8b42
EZ
1155 ;; Index nodes include null bytes. DIR
1156 ;; files should not have indices, but who
1157 ;; knows...
1158 (let ((inhibit-null-byte-detection t))
9d499629 1159 (insert-file-contents file)
1bd19a31
MB
1160 (set (make-local-variable 'Info-dir-file-name)
1161 file)
6af7040d 1162 (push (current-buffer) buffers)
1bd19a31 1163 (push (cons file attrs) dir-file-attrs))
9d499629 1164 (error (kill-buffer (current-buffer))))))))
1bd19a31
MB
1165 (unless (cdr dirs)
1166 (set (make-local-variable 'Info-dir-contents-directory)
1167 (file-name-as-directory (car dirs))))
825d6f08 1168 (setq dirs (cdr dirs))))
399c88ad 1169
4db579ab 1170 (or buffers
81e14cb2 1171 (error "Can't find the Info directory node"))
1bd19a31 1172
44c327f9 1173 ;; Distinguish the dir file that comes with Emacs from all the
f4008b6e 1174 ;; others. Yes, that is really what this is supposed to do.
f601cd3e
DL
1175 ;; The definition of `Info-directory-list' puts it first on that
1176 ;; list and so last in `buffers' at this point.
1177 (setq buffer (car (last buffers))
1178 others (delq buffer buffers))
44c327f9 1179
debcea0c
KH
1180 ;; Insert the entire original dir file as a start; note that we've
1181 ;; already saved its default directory to use as the default
1182 ;; directory for the whole concatenation.
69672704 1183 (save-excursion (insert-buffer-substring buffer))
44c327f9 1184
7ea13762 1185 ;; Look at each of the other buffers one by one.
6af7040d
SM
1186 (dolist (other others)
1187 (let (this-buffer-nodes)
7ea13762 1188 ;; In each, find all the menus.
6af7040d 1189 (with-current-buffer other
7ea13762
RS
1190 (goto-char (point-min))
1191 ;; Find each menu, and add an elt to NODES for it.
1192 (while (re-search-forward "^\\* Menu:" nil t)
6af7040d
SM
1193 (while (and (zerop (forward-line 1)) (eolp)))
1194 (let ((beg (point))
1195 nodename end)
1196 (re-search-backward "^\^_")
7ea13762 1197 (search-forward "Node: ")
89b064a9 1198 (setq nodename (Info-following-node-name))
3a6ade8a 1199 (search-forward "\n\^_" nil 'move)
7ea13762
RS
1200 (beginning-of-line)
1201 (setq end (point))
6af7040d 1202 (push (list nodename other beg end) this-buffer-nodes)))
9f4aee27 1203 (if (assoc-string "top" this-buffer-nodes t)
4fba3b2c
RS
1204 (setq nodes (nconc this-buffer-nodes nodes))
1205 (setq problems t)
6af7040d 1206 (message "No `top' node in %s" Info-dir-file-name)))))
fdf4b680 1207 ;; Add to the main menu a menu item for each other node.
6af7040d 1208 (re-search-forward "^\\* Menu:")
7ea13762
RS
1209 (forward-line 1)
1210 (let ((menu-items '("top"))
3a6ade8a 1211 (end (save-excursion (search-forward "\^_" nil t) (point))))
6af7040d
SM
1212 (dolist (node nodes)
1213 (let ((nodename (car node)))
c3a29d70
RS
1214 (save-excursion
1215 (or (member (downcase nodename) menu-items)
b37daea4 1216 (re-search-forward (concat "^\\* +"
c3a29d70
RS
1217 (regexp-quote nodename)
1218 "::")
1219 end t)
1220 (progn
1221 (insert "* " nodename "::" "\n")
6af7040d 1222 (push nodename menu-items)))))))
7ea13762
RS
1223 ;; Now take each node of each of the other buffers
1224 ;; and merge it into the main buffer.
6af7040d 1225 (dolist (node nodes)
760d5cb3 1226 (let ((case-fold-search t)
6af7040d 1227 (nodename (car node)))
7ea13762
RS
1228 (goto-char (point-min))
1229 ;; Find the like-named node in the main buffer.
ba42ce14 1230 (if (re-search-forward (concat "^\^_.*\n.*Node: "
7ea13762
RS
1231 (regexp-quote nodename)
1232 "[,\n\t]")
1233 nil t)
1234 (progn
3a6ade8a 1235 (search-forward "\n\^_" nil 'move)
25869acf
RS
1236 (beginning-of-line)
1237 (insert "\n"))
7ea13762
RS
1238 ;; If none exists, add one.
1239 (goto-char (point-max))
dfbf6104 1240 (insert "\^_\nFile: dir\tNode: " nodename "\n\n* Menu:\n\n"))
7ea13762
RS
1241 ;; Merge the text from the other buffer's menu
1242 ;; into the menu in the like-named node in the main buffer.
6af7040d
SM
1243 (apply 'insert-buffer-substring (cdr node))))
1244 (Info-dir-remove-duplicates)
dc9bec22
TTN
1245 ;; Kill all the buffers we just made, including the special one excised.
1246 (mapc 'kill-buffer (cons buffer buffers))
4fba3b2c
RS
1247 (goto-char (point-min))
1248 (if problems
1249 (message "Composing main Info directory...problems encountered, see `*Messages*'")
1bd19a31
MB
1250 (message "Composing main Info directory...done"))
1251 (set (make-local-variable 'Info-dir-contents) (buffer-string))
1252 (set (make-local-variable 'Info-dir-file-attributes) dir-file-attrs)))
44c327f9 1253 (setq default-directory Info-dir-contents-directory))
7ea13762 1254
6af7040d
SM
1255(defvar Info-streamline-headings
1256 '(("Emacs" . "Emacs")
1257 ("Programming" . "Programming")
1258 ("Libraries" . "Libraries")
1259 ("World Wide Web\\|Net Utilities" . "Net Utilities"))
1260 "List of elements (RE . NAME) to merge headings matching RE to NAME.")
1261
1262(defun Info-dir-remove-duplicates ()
1263 (let (limit)
1264 (goto-char (point-min))
1265 ;; Remove duplicate headings in the same menu.
1266 (while (search-forward "\n* Menu:" nil t)
141b49f5 1267 (setq limit (save-excursion (search-forward "\n\^_" nil t)))
6af7040d
SM
1268 ;; Look for the next heading to unify.
1269 (while (re-search-forward "^\\(\\w.*\\)\n\\*" limit t)
1270 (let ((name (match-string 1))
1271 (start (match-beginning 0))
1272 (entries nil) re)
1273 ;; Check whether this heading should be streamlined.
1274 (save-match-data
1275 (dolist (x Info-streamline-headings)
1276 (when (string-match (car x) name)
1277 (setq name (cdr x))
1278 (setq re (car x)))))
1279 (if re (replace-match name t t nil 1))
1280 (goto-char (if (re-search-forward "^[^* \n\t]" limit t)
1281 (match-beginning 0)
1282 (or limit (point-max))))
1283 ;; Look for other headings of the same category and merge them.
1284 (save-excursion
1285 (while (re-search-forward "^\\(\\w.*\\)\n\\*" limit t)
1286 (when (if re (save-match-data (string-match re (match-string 1)))
1287 (equal name (match-string 1)))
1288 (forward-line 0)
1289 ;; Delete redundant heading.
1290 (delete-region (match-beginning 0) (point))
1291 ;; Push the entries onto `text'.
1292 (push
1293 (delete-and-extract-region
1294 (point)
1295 (if (re-search-forward "^[^* \n\t]" nil t)
1296 (match-beginning 0)
2d19a2a4
JL
1297 (or limit (point-max))))
1298 entries)
1299 (forward-line 0))))
6af7040d
SM
1300 ;; Insert the entries just found.
1301 (while (= (line-beginning-position 0) (1- (point)))
1302 (backward-char))
1303 (dolist (entry (nreverse entries))
1304 (insert entry)
1305 (while (= (line-beginning-position 0) (1- (point)))
1306 (delete-region (1- (point)) (point))))
921e5fe6 1307
6af7040d 1308 ;; Now remove duplicate entries under the same heading.
3bfd723a
MR
1309 (let (seen)
1310 (save-restriction
1311 (narrow-to-region start (point))
1312 (goto-char (point-min))
1313 (while (re-search-forward "^* \\([^:\n]+:\\(:\\|[^.\n]+\\).\\)" nil 'move)
1314 ;; Fold case straight away; `member-ignore-case' here wasteful.
1315 (let ((x (downcase (match-string 1))))
1316 (if (member x seen)
1317 (delete-region
1318 (match-beginning 0)
1319 (if (re-search-forward "^[^ \t]" nil 'move)
1320 (goto-char (match-beginning 0))
1321 (point-max)))
1322 (push x seen)))))))))))
6af7040d 1323
c5fe2ff1
RS
1324;; Note that on entry to this function the current-buffer must be the
1325;; *info* buffer; not the info tags buffer.
a384cab3 1326(defun Info-read-subfile (nodepos)
a361deba
RS
1327 ;; NODEPOS is either a position (in the Info file as a whole,
1328 ;; not relative to a subfile) or the name of a subfile.
a384cab3
JB
1329 (let (lastfilepos
1330 lastfilename)
a361deba 1331 (if (numberp nodepos)
e8dab975 1332 (with-current-buffer (marker-buffer Info-tag-table-marker)
a361deba 1333 (goto-char (point-min))
ba42ce14
EZ
1334 (or (looking-at "\^_")
1335 (search-forward "\n\^_"))
a361deba
RS
1336 (forward-line 2)
1337 (catch 'foo
1338 (while (not (looking-at "\^_"))
1339 (if (not (eolp))
1340 (let ((beg (point))
1341 thisfilepos thisfilename)
1342 (search-forward ": ")
1343 (setq thisfilename (buffer-substring beg (- (point) 2)))
365d2503 1344 (setq thisfilepos (+ (point-min) (read (current-buffer))))
a361deba
RS
1345 ;; read in version 19 stops at the end of number.
1346 ;; Advance to the next line.
1347 (forward-line 1)
1348 (if (> thisfilepos nodepos)
1349 (throw 'foo t))
1350 (setq lastfilename thisfilename)
1351 (setq lastfilepos thisfilepos))
1352 (forward-line 1)))))
1353 (setq lastfilename nodepos)
1354 (setq lastfilepos 0))
c5fe2ff1
RS
1355 ;; Assume previous buffer is in Info-mode.
1356 ;; (set-buffer (get-buffer "*info*"))
a384cab3 1357 (or (equal Info-current-subfile lastfilename)
e8dab975 1358 (let ((inhibit-read-only t))
a384cab3
JB
1359 (setq buffer-file-name nil)
1360 (widen)
1361 (erase-buffer)
1143a6b0 1362 (info-insert-file-contents lastfilename)
a384cab3
JB
1363 (set-buffer-modified-p nil)
1364 (setq Info-current-subfile lastfilename)))
b0e52598
RS
1365 ;; Widen in case we are in the same subfile as before.
1366 (widen)
a384cab3 1367 (goto-char (point-min))
ba42ce14
EZ
1368 (if (looking-at "\^_")
1369 (forward-char 1)
1370 (search-forward "\n\^_"))
a361deba
RS
1371 (if (numberp nodepos)
1372 (+ (- nodepos lastfilepos) (point)))))
a384cab3 1373
ec9b1372 1374(defun Info-unescape-quotes (value)
1ed6e0c3 1375 "Unescape double quotes and backslashes in VALUE."
ec9b1372
KB
1376 (let ((start 0)
1377 (unquote value))
1378 (while (string-match "[^\\\"]*\\(\\\\\\)[\\\\\"]" unquote start)
1379 (setq unquote (replace-match "" t t unquote 1))
1380 (setq start (- (match-end 0) 1)))
1381 unquote))
1382
1383;; As of Texinfo 4.6, makeinfo writes constructs like
1384;; \0\h[image param=value ...\h\0]
1385;; into the Info file for handling images.
1386(defun Info-split-parameter-string (parameter-string)
1387 "Return alist of (\"KEY\" . \"VALUE\") from PARAMETER-STRING; a
1ed6e0c3
JPW
1388whitespace separated list of KEY=VALUE pairs. If VALUE contains
1389whitespace or double quotes, it must be quoted in double quotes and
1390any double quotes or backslashes must be escaped (\\\",\\\\)."
ec9b1372
KB
1391 (let ((start 0)
1392 (parameter-alist))
1393 (while (string-match
1394 "\\s *\\([^=]+\\)=\\(?:\\([^\\s \"]+\\)\\|\\(?:\"\\(\\(?:[^\\\"]\\|\\\\[\\\\\"]\\)*\\)\"\\)\\)"
1395 parameter-string start)
1396 (setq start (match-end 0))
1397 (push (cons (match-string 1 parameter-string)
1398 (or (match-string 2 parameter-string)
1399 (Info-unescape-quotes
1400 (match-string 3 parameter-string))))
1401 parameter-alist))
1402 parameter-alist))
1403
1404(defun Info-display-images-node ()
1405 "Display images in current node."
1406 (save-excursion
1407 (let ((inhibit-read-only t)
dde7f979 1408 (case-fold-search t))
ec9b1372
KB
1409 (goto-char (point-min))
1410 (while (re-search-forward
1411 "\\(\0\b[[]image\\(\\(?:[^\b]\\|[^\0]+\b\\)*\\)\0\b[]]\\)"
1412 nil t)
1413 (let* ((start (match-beginning 1))
1414 (parameter-alist (Info-split-parameter-string (match-string 2)))
d3425b35
NR
1415 (src (cdr (assoc-string "src" parameter-alist))))
1416 (if (display-images-p)
1417 (let* ((image-file (if src (if (file-name-absolute-p src) src
1418 (concat default-directory src))
1419 ""))
1420 (image (if (file-exists-p image-file)
1421 (create-image image-file)
1422 "[broken image]")))
1423 (if (not (get-text-property start 'display))
1424 (add-text-properties
1425 start (point) `(display ,image rear-nonsticky (display)))))
1426 ;; text-only display, show alternative text if provided, or
1427 ;; otherwise a clue that there's meant to be a picture
1428 (delete-region start (point))
1429 (insert (or (cdr (assoc-string "text" parameter-alist))
1430 (cdr (assoc-string "alt" parameter-alist))
1431 (and src
1432 (concat "[image:" src "]"))
1433 "[image]"))))))
ec9b1372
KB
1434 (set-buffer-modified-p nil)))
1435
0c1b7af5
JL
1436;; Texinfo 4.7 adds cookies of the form ^@^H[NAME CONTENTS ^@^H].
1437;; Hide any construct of the general form ^@[^@-^_][ ... ^@[^@-^_]],
1438;; including one optional trailing newline.
1439(defun Info-hide-cookies-node ()
e37c1854 1440 "Hide unrecognized cookies in current node."
0c1b7af5
JL
1441 (save-excursion
1442 (let ((inhibit-read-only t)
1443 (case-fold-search t))
1444 (goto-char (point-min))
1445 (while (re-search-forward
1446 "\\(\0[\0-\37][[][^\0]*\0[\0-\37][]]\n?\\)"
1447 nil t)
1448 (let* ((start (match-beginning 1)))
d3de1c8e
JL
1449 (if (and (not (get-text-property start 'invisible))
1450 (not (get-text-property start 'display)))
0c1b7af5
JL
1451 (put-text-property start (point) 'invisible t)))))
1452 (set-buffer-modified-p nil)))
1453
a384cab3 1454(defun Info-select-node ()
185cff95 1455 "Select the Info node that point is in."
b038485e 1456 ;; Bind this in case the user sets it to nil.
1bcedb3b
RS
1457 (let ((case-fold-search t))
1458 (save-excursion
760d5cb3
GM
1459 ;; Find beginning of node.
1460 (if (search-backward "\n\^_" nil 'move)
1461 (forward-line 2)
1462 (if (looking-at "\^_")
1463 (forward-line 1)
1464 (signal 'search-failed (list "\n\^_"))))
1465 ;; Get nodename spelled as it is in the node.
1466 (re-search-forward "Node:[ \t]*")
1467 (setq Info-current-node
1468 (buffer-substring-no-properties (point)
1469 (progn
1470 (skip-chars-forward "^,\t\n")
1471 (point))))
1472 (Info-set-mode-line)
1473 ;; Find the end of it, and narrow.
1474 (beginning-of-line)
1475 (let (active-expression)
50ac70af 1476 ;; Narrow to the node contents
760d5cb3
GM
1477 (narrow-to-region (point)
1478 (if (re-search-forward "\n[\^_\f]" nil t)
1479 (prog1
1480 (1- (point))
1481 (if (looking-at "[\n\^_\f]*execute: ")
1482 (progn
1483 (goto-char (match-end 0))
1484 (setq active-expression
1485 (read (current-buffer))))))
1486 (point-max)))
1487 (if Info-enable-active-nodes (eval active-expression))
8a7757f6
JL
1488 ;; Add a new unique history item to full history list
1489 (let ((new-history (list Info-current-file Info-current-node)))
1490 (setq Info-history-list
424b9d3e
JL
1491 (cons new-history (delete new-history Info-history-list)))
1492 (setq Info-history-forward nil))
141b49f5
JL
1493 (if (not (eq Info-fontify-maximum-menu-size nil))
1494 (Info-fontify-node))
ec9b1372 1495 (Info-display-images-node)
0c1b7af5 1496 (Info-hide-cookies-node)
760d5cb3 1497 (run-hooks 'Info-selection-hook)))))
a384cab3 1498
8eafa165
JL
1499(defvar Info-mode-line-node-keymap
1500 (let ((map (make-sparse-keymap)))
8aab8422
CY
1501 (define-key map [mode-line mouse-1] 'Info-mouse-scroll-up)
1502 (define-key map [mode-line mouse-3] 'Info-mouse-scroll-down)
8eafa165
JL
1503 map)
1504 "Keymap to put on the Info node name in the mode line.")
1505
a384cab3
JB
1506(defun Info-set-mode-line ()
1507 (setq mode-line-buffer-identification
313fe58a 1508 (nconc (propertized-buffer-identification "%b")
918e364a 1509 (list
8eafa165
JL
1510 (concat
1511 " ("
1512 (if (stringp Info-current-file)
fd5b25da
JL
1513 (replace-regexp-in-string
1514 "%" "%%" (file-name-nondirectory Info-current-file))
bec275ed 1515 (format "*%S*" Info-current-file))
8eafa165
JL
1516 ") "
1517 (if Info-current-node
fd5b25da
JL
1518 (propertize (replace-regexp-in-string
1519 "%" "%%" Info-current-node)
8eafa165
JL
1520 'face 'mode-line-buffer-id
1521 'help-echo
1522 "mouse-1: scroll forward, mouse-3: scroll back"
1523 'mouse-face 'mode-line-highlight
1524 'local-map Info-mode-line-node-keymap)
1525 ""))))))
a384cab3 1526\f
185cff95 1527;; Go to an Info node specified with a filename-and-nodename string
a384cab3
JB
1528;; of the sort that is found in pointers in nodes.
1529
83040cb0
SM
1530;; Don't autoload this function: the correct entry point for other packages
1531;; to use is `info'. --Stef
1532;; ;;;###autoload
4fceda3c 1533(defun Info-goto-node (nodename &optional fork)
185cff95 1534 "Go to Info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
dc414be1
EZ
1535If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
1536FILENAME; otherwise, NODENAME should be in the current Info file (or one of
1537its sub-files).
1538Completion is available, but only for node names in the current Info file.
7210b6f5 1539If FORK is non-nil (interactively with a prefix arg), show the node in
185cff95 1540a new Info buffer.
4fceda3c 1541If FORK is a string, it is the name to use for the new buffer."
d1268e52 1542 (interactive (list (Info-read-node-name "Go to node: ") current-prefix-arg))
d0e41cba 1543 (info-initialize)
4fceda3c 1544 (if fork
760d5cb3
GM
1545 (set-buffer
1546 (clone-buffer (concat "*info-" (if (stringp fork) fork nodename) "*") t)))
a384cab3
JB
1547 (let (filename)
1548 (string-match "\\s *\\((\\s *\\([^\t)]*\\)\\s *)\\s *\\|\\)\\(.*\\)"
1549 nodename)
1550 (setq filename (if (= (match-beginning 1) (match-end 1))
1551 ""
c60c12be
SM
1552 (match-string 2 nodename))
1553 nodename (match-string 3 nodename))
836bb478 1554 (let ((trim (string-match "\\s +\\'" filename)))
a384cab3 1555 (if trim (setq filename (substring filename 0 trim))))
836bb478 1556 (let ((trim (string-match "\\s +\\'" nodename)))
a384cab3 1557 (if trim (setq nodename (substring nodename 0 trim))))
e579232c 1558 (if transient-mark-mode (deactivate-mark))
a384cab3
JB
1559 (Info-find-node (if (equal filename "") nil filename)
1560 (if (equal nodename "") "Top" nodename))))
552775bd 1561
ddf89211
RS
1562(defvar Info-read-node-completion-table)
1563
e8dab975 1564(defun Info-read-node-name-2 (dirs suffixes string pred action)
a89da416
RS
1565 "Virtual completion table for file names input in Info node names.
1566PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
e8dab975
SM
1567 (setq suffixes (remove "" suffixes))
1568 (when (file-name-absolute-p string)
1569 (setq dirs (list (file-name-directory string))))
1570 (let ((names nil)
1571 (suffix (concat (regexp-opt suffixes t) "\\'"))
1572 (string-dir (file-name-directory string)))
a89da416
RS
1573 (dolist (dir dirs)
1574 (unless dir
1575 (setq dir default-directory))
1576 (if string-dir (setq dir (expand-file-name string-dir dir)))
1577 (when (file-directory-p dir)
1578 (dolist (file (file-name-all-completions
1579 (file-name-nondirectory string) dir))
1580 ;; If the file name has no suffix or a standard suffix,
1581 ;; include it.
1582 (and (or (null (file-name-extension file))
1583 (string-match suffix file))
185cff95 1584 ;; But exclude subfiles of split Info files.
a89da416
RS
1585 (not (string-match "-[0-9]+\\'" file))
1586 ;; And exclude backup files.
1587 (not (string-match "~\\'" file))
1588 (push (if string-dir (concat string-dir file) file) names))
1589 ;; If the file name ends in a standard suffix,
1590 ;; add the unsuffixed name as a completion option.
1591 (when (string-match suffix file)
1592 (setq file (substring file 0 (match-beginning 0)))
1593 (push (if string-dir (concat string-dir file) file) names)))))
e8dab975 1594 (complete-with-action action names string pred)))
a89da416 1595
03524be6 1596;; This function is used as the "completion table" while reading a node name.
ddf89211 1597;; It does completion using the alist in Info-read-node-completion-table
03524be6
RS
1598;; unless STRING starts with an open-paren.
1599(defun Info-read-node-name-1 (string predicate code)
365d2503
SM
1600 (cond
1601 ;; First complete embedded file names.
1602 ((string-match "\\`([^)]*\\'" string)
e2947429
SM
1603 (completion-table-with-context
1604 "("
e8dab975
SM
1605 (apply-partially 'completion-table-with-terminator ")"
1606 (apply-partially 'Info-read-node-name-2
1607 Info-directory-list
1608 (mapcar 'car Info-suffix-list)))
e2947429 1609 (substring string 1)
e8dab975 1610 predicate
e2947429
SM
1611 code))
1612
365d2503
SM
1613 ;; If a file name was given, then any node is fair game.
1614 ((string-match "\\`(" string)
1615 (cond
1616 ((eq code nil) string)
1617 ((eq code t) nil)
1618 (t t)))
1619 ;; Otherwise use Info-read-node-completion-table.
e2947429
SM
1620 (t (complete-with-action
1621 code Info-read-node-completion-table string predicate))))
03524be6 1622
a89da416 1623;; Arrange to highlight the proper letters in the completion list buffer.
e2947429 1624
a89da416 1625
f75d05eb 1626(defun Info-read-node-name (prompt)
552775bd 1627 (let* ((completion-ignore-case t)
ddf89211 1628 (Info-read-node-completion-table (Info-build-node-completions))
b6d61ffa 1629 (nodename (completing-read prompt 'Info-read-node-name-1 nil t)))
552775bd 1630 (if (equal nodename "")
f75d05eb 1631 (Info-read-node-name prompt)
552775bd
RS
1632 nodename)))
1633
1634(defun Info-build-node-completions ()
1635 (or Info-current-file-completions
1bcedb3b
RS
1636 (let ((compl nil)
1637 ;; Bind this in case the user sets it to nil.
11638562
EZ
1638 (case-fold-search t)
1639 (node-regexp "Node: *\\([^,\n]*\\) *[,\n\t]"))
552775bd
RS
1640 (save-excursion
1641 (save-restriction
746c9f14
CY
1642 (or Info-tag-table-marker
1643 (error "No Info tags found"))
552775bd 1644 (if (marker-buffer Info-tag-table-marker)
c5fe2ff1
RS
1645 (let ((marker Info-tag-table-marker))
1646 (set-buffer (marker-buffer marker))
cedb118c 1647 (widen)
c5fe2ff1 1648 (goto-char marker)
fdf4b680 1649 (while (re-search-forward "\n\\(Node\\|Ref\\): \\(.*\\)\177" nil t)
552775bd 1650 (setq compl
fdf4b680 1651 (cons (list (match-string-no-properties 2))
552775bd
RS
1652 compl))))
1653 (widen)
1654 (goto-char (point-min))
11638562
EZ
1655 ;; If the buffer begins with a node header, process that first.
1656 (if (Info-node-at-bob-matching node-regexp)
110d4e80 1657 (setq compl (list (match-string-no-properties 1))))
11638562 1658 ;; Now for the rest of the nodes.
552775bd
RS
1659 (while (search-forward "\n\^_" nil t)
1660 (forward-line 1)
1661 (let ((beg (point)))
1662 (forward-line 1)
11638562 1663 (if (re-search-backward node-regexp beg t)
399c88ad 1664 (setq compl
110d4e80 1665 (cons (list (match-string-no-properties 1))
552775bd 1666 compl))))))))
87d2b5a2 1667 (setq compl (cons '("*") compl))
07b1b912 1668 (set (make-local-variable 'Info-current-file-completions) compl))))
a384cab3 1669\f
aea2a8da
JB
1670(defun Info-restore-point (hl)
1671 "If this node has been visited, restore the point value when we left."
cedb118c
RS
1672 (while hl
1673 (if (and (equal (nth 0 (car hl)) Info-current-file)
e90d1271
RS
1674 ;; Use string-equal, not equal, to ignore text props.
1675 (string-equal (nth 1 (car hl)) Info-current-node))
cedb118c 1676 (progn
d96504df
KH
1677 (goto-char (nth 2 (car hl)))
1678 (setq hl nil)) ;terminate the while at next iter
cedb118c 1679 (setq hl (cdr hl)))))
aea2a8da 1680\f
2c80a618
GM
1681(defvar Info-search-history nil
1682 "The history list for `Info-search'.")
a384cab3 1683
8a7757f6
JL
1684(defvar Info-search-case-fold nil
1685 "The value of `case-fold-search' from previous `Info-search' command.")
1686
0b02cda9
JL
1687(defun Info-search (regexp &optional bound noerror count direction)
1688 "Search for REGEXP, starting from point, and select node it's found in.
1689If DIRECTION is `backward', search in the reverse direction."
bbc96600
EZ
1690 (interactive (list (read-string
1691 (if Info-search-history
5b76833f
RF
1692 (format "Regexp search%s (default %s): "
1693 (if case-fold-search "" " case-sensitively")
bbc96600 1694 (car Info-search-history))
8a7757f6 1695 (format "Regexp search%s: "
5b76833f 1696 (if case-fold-search "" " case-sensitively")))
bbc96600 1697 nil 'Info-search-history)))
f9be2e35 1698 (deactivate-mark)
2c80a618
GM
1699 (when (equal regexp "")
1700 (setq regexp (car Info-search-history)))
c47b5bbe 1701 (when regexp
774f8aee 1702 (let (found beg-found give-up
0b02cda9 1703 (backward (eq direction 'backward))
c47b5bbe
DL
1704 (onode Info-current-node)
1705 (ofile Info-current-file)
1706 (opoint (point))
0b02cda9
JL
1707 (opoint-min (point-min))
1708 (opoint-max (point-max))
c47b5bbe
DL
1709 (ostart (window-start))
1710 (osubfile Info-current-subfile))
8a7757f6 1711 (setq Info-search-case-fold case-fold-search)
c47b5bbe
DL
1712 (save-excursion
1713 (save-restriction
1714 (widen)
ca53db33
JL
1715 (when backward
1716 ;; Hide Info file header for backward search
1717 (narrow-to-region (save-excursion
1718 (goto-char (point-min))
1719 (search-forward "\n\^_")
1720 (1- (point)))
1721 (point-max)))
774f8aee 1722 (while (and (not give-up)
0ec3382b 1723 (or (null found)
a2c72e6c 1724 (not (funcall isearch-filter-predicate beg-found found))))
9ca9f7f3
JL
1725 (let ((search-spaces-regexp
1726 (if (or (not isearch-mode) isearch-regexp)
1727 Info-search-whitespace-regexp)))
5d4faeda
RS
1728 (if (if backward
1729 (re-search-backward regexp bound t)
1730 (re-search-forward regexp bound t))
1731 (setq found (point) beg-found (if backward (match-end 0)
1732 (match-beginning 0)))
1733 (setq give-up t))))))
d457219d
JL
1734
1735 (when (and isearch-mode Info-isearch-search
1736 (not Info-isearch-initial-node)
1737 (not bound)
1738 (or give-up (and found (not (and (> found opoint-min)
1739 (< found opoint-max))))))
1740 (signal 'search-failed (list regexp "initial node")))
1741
774f8aee
RS
1742 ;; If no subfiles, give error now.
1743 (if give-up
c47b5bbe 1744 (if (null Info-current-subfile)
9ca9f7f3
JL
1745 (let ((search-spaces-regexp
1746 (if (or (not isearch-mode) isearch-regexp)
1747 Info-search-whitespace-regexp)))
180ee7c7
JL
1748 (if backward
1749 (re-search-backward regexp)
1750 (re-search-forward regexp)))
774f8aee
RS
1751 (setq found nil)))
1752
d457219d
JL
1753 (if (and bound (not found))
1754 (signal 'search-failed (list regexp)))
1755
0b02cda9 1756 (unless (or found bound)
774f8aee
RS
1757 (unwind-protect
1758 ;; Try other subfiles.
1759 (let ((list ()))
e8dab975 1760 (with-current-buffer (marker-buffer Info-tag-table-marker)
774f8aee
RS
1761 (goto-char (point-min))
1762 (search-forward "\n\^_\nIndirect:")
1763 (save-restriction
1764 (narrow-to-region (point)
1765 (progn (search-forward "\n\^_")
1766 (1- (point))))
c5fe2ff1 1767 (goto-char (point-min))
774f8aee
RS
1768 ;; Find the subfile we just searched.
1769 (search-forward (concat "\n" osubfile ": "))
1770 ;; Skip that one.
0b02cda9 1771 (forward-line (if backward 0 1))
866920e3 1772 (if backward (forward-char -1))
774f8aee
RS
1773 ;; Make a list of all following subfiles.
1774 ;; Each elt has the form (VIRT-POSITION . SUBFILENAME).
0b02cda9
JL
1775 (while (not (if backward (bobp) (eobp)))
1776 (if backward
1777 (re-search-backward "\\(^.*\\): [0-9]+$")
1778 (re-search-forward "\\(^.*\\): [0-9]+$"))
774f8aee
RS
1779 (goto-char (+ (match-end 1) 2))
1780 (setq list (cons (cons (+ (point-min)
1781 (read (current-buffer)))
1782 (match-string-no-properties 1))
1783 list))
0b02cda9
JL
1784 (goto-char (if backward
1785 (1- (match-beginning 0))
1786 (1+ (match-end 0)))))
774f8aee
RS
1787 ;; Put in forward order
1788 (setq list (nreverse list))))
1789 (while list
1790 (message "Searching subfile %s..." (cdr (car list)))
1791 (Info-read-subfile (car (car list)))
ca53db33
JL
1792 (when backward
1793 ;; Hide Info file header for backward search
1794 (narrow-to-region (save-excursion
1795 (goto-char (point-min))
1796 (search-forward "\n\^_")
1797 (1- (point)))
1798 (point-max))
1799 (goto-char (point-max)))
774f8aee
RS
1800 (setq list (cdr list))
1801 (setq give-up nil found nil)
1802 (while (and (not give-up)
0ec3382b 1803 (or (null found)
a2c72e6c 1804 (not (funcall isearch-filter-predicate beg-found found))))
9ca9f7f3
JL
1805 (let ((search-spaces-regexp
1806 (if (or (not isearch-mode) isearch-regexp)
1807 Info-search-whitespace-regexp)))
180ee7c7
JL
1808 (if (if backward
1809 (re-search-backward regexp nil t)
1810 (re-search-forward regexp nil t))
1811 (setq found (point) beg-found (if backward (match-end 0)
1812 (match-beginning 0)))
1813 (setq give-up t))))
774f8aee
RS
1814 (if give-up
1815 (setq found nil))
c47b5bbe 1816 (if found
774f8aee
RS
1817 (setq list nil)))
1818 (if found
1819 (message "")
1820 (signal 'search-failed (list regexp))))
1821 (if (not found)
1822 (progn (Info-read-subfile osubfile)
1823 (goto-char opoint)
1824 (Info-select-node)
1825 (set-window-start (selected-window) ostart)))))
0b02cda9
JL
1826
1827 (if (and (string= osubfile Info-current-subfile)
1828 (> found opoint-min)
1829 (< found opoint-max))
1830 ;; Search landed in the same node
1831 (goto-char found)
1832 (widen)
1833 (goto-char found)
1834 (save-match-data (Info-select-node)))
1835
760d5cb3
GM
1836 ;; Use string-equal, not equal, to ignore text props.
1837 (or (and (string-equal onode Info-current-node)
1838 (equal ofile Info-current-file))
866920e3
JL
1839 (and isearch-mode isearch-wrapped
1840 (eq opoint (if isearch-forward opoint-min opoint-max)))
760d5cb3
GM
1841 (setq Info-history (cons (list ofile onode opoint)
1842 Info-history))))))
8a7757f6
JL
1843
1844(defun Info-search-case-sensitively ()
1845 "Search for a regexp case-sensitively."
1846 (interactive)
1847 (let ((case-fold-search nil))
1848 (call-interactively 'Info-search)))
1849
1850(defun Info-search-next ()
1851 "Search for next regexp from a previous `Info-search' command."
1852 (interactive)
1853 (let ((case-fold-search Info-search-case-fold))
1854 (if Info-search-history
1855 (Info-search (car Info-search-history))
1856 (call-interactively 'Info-search))))
0b02cda9
JL
1857
1858(defun Info-search-backward (regexp &optional bound noerror count)
1859 "Search for REGEXP in the reverse direction."
1860 (interactive (list (read-string
1861 (if Info-search-history
5b76833f
RF
1862 (format "Regexp search%s backward (default %s): "
1863 (if case-fold-search "" " case-sensitively")
0b02cda9
JL
1864 (car Info-search-history))
1865 (format "Regexp search%s backward: "
5b76833f 1866 (if case-fold-search "" " case-sensitively")))
0b02cda9
JL
1867 nil 'Info-search-history)))
1868 (Info-search regexp bound noerror count 'backward))
1869
1870(defun Info-isearch-search ()
9553cf63 1871 (if Info-isearch-search
98e77be5 1872 (lambda (string &optional bound noerror count)
d457219d
JL
1873 (if isearch-word
1874 (Info-search (concat "\\b" (replace-regexp-in-string
69672704 1875 "\\W+" "\\W+"
d457219d 1876 (replace-regexp-in-string
69672704
JL
1877 "^\\W+\\|\\W+$" "" string)
1878 nil t)
74a131b6
JL
1879 ;; Lax version of word search
1880 (if (or isearch-nonincremental
1881 (eq (length string)
1882 (length (isearch-string-state
1883 (car isearch-cmds)))))
1884 "\\b"))
d457219d
JL
1885 bound noerror count
1886 (unless isearch-forward 'backward))
1887 (Info-search (if isearch-regexp string (regexp-quote string))
1888 bound noerror count
98db7a38
JB
1889 (unless isearch-forward 'backward)))
1890 (point))
98e77be5
JL
1891 (let ((isearch-search-fun-function nil))
1892 (isearch-search-fun))))
0b02cda9
JL
1893
1894(defun Info-isearch-wrap ()
d457219d
JL
1895 (if Info-isearch-search
1896 (if Info-isearch-initial-node
1897 (progn
1898 (if isearch-forward (Info-top-node) (Info-final-node))
1899 (goto-char (if isearch-forward (point-min) (point-max))))
1900 (setq Info-isearch-initial-node Info-current-node)
1901 (setq isearch-wrapped nil))
0b02cda9
JL
1902 (goto-char (if isearch-forward (point-min) (point-max)))))
1903
1904(defun Info-isearch-push-state ()
1905 `(lambda (cmd)
bec275ed 1906 (Info-isearch-pop-state cmd ',Info-current-file ',Info-current-node)))
0b02cda9
JL
1907
1908(defun Info-isearch-pop-state (cmd file node)
bec275ed
JL
1909 (or (and (equal Info-current-file file)
1910 (equal Info-current-node node))
0b02cda9
JL
1911 (progn (Info-find-node file node) (sit-for 0))))
1912
d457219d 1913(defun Info-isearch-start ()
74a131b6
JL
1914 (setq Info-isearch-initial-node
1915 ;; Don't stop at initial node for nonincremental search.
1916 ;; Otherwise this variable is set after first search failure.
1917 (and isearch-nonincremental Info-current-node)))
0ec3382b 1918
3fbb3dc4
JL
1919(defun Info-isearch-filter (beg-found found)
1920 "Test whether the current search hit is a visible useful text.
1921Return non-nil if the text from BEG-FOUND to FOUND is visible
1922and is not in the header line or a tag table."
0ec3382b
JL
1923 (save-match-data
1924 (let ((backward (< found beg-found)))
1925 (not
1926 (or
744059ae
JL
1927 (and (not (eq search-invisible t))
1928 (if backward
1929 (or (text-property-not-all found beg-found 'invisible nil)
1930 (text-property-not-all found beg-found 'display nil))
1931 (or (text-property-not-all beg-found found 'invisible nil)
1932 (text-property-not-all beg-found found 'display nil))))
0ec3382b
JL
1933 ;; Skip node header line
1934 (and (save-excursion (forward-line -1)
1935 (looking-at "\^_"))
1936 (forward-line (if backward -1 1)))
1937 ;; Skip Tag Table node
1938 (save-excursion
1939 (and (search-backward "\^_" nil t)
1940 (looking-at
1941 "\^_\n\\(Tag Table\\|Local Variables\\)"))))))))
1942
a384cab3 1943\f
a384cab3 1944(defun Info-extract-pointer (name &optional errorname)
fdf4b680
DL
1945 "Extract the value of the node-pointer named NAME.
1946If there is none, use ERRORNAME in the error message;
c60c12be
SM
1947if ERRORNAME is nil, just return nil."
1948 ;; Bind this in case the user sets it to nil.
1bcedb3b
RS
1949 (let ((case-fold-search t))
1950 (save-excursion
c60c12be
SM
1951 (goto-char (point-min))
1952 (let ((bound (point)))
1953 (forward-line 1)
1954 (cond ((re-search-backward
1955 (concat name ":" (Info-following-node-name-re)) bound t)
bec275ed 1956 (match-string-no-properties 1))
c60c12be
SM
1957 ((not (eq errorname t))
1958 (error "Node has no %s"
1959 (capitalize (or errorname name)))))))))
1960
1961(defun Info-following-node-name-re (&optional allowedchars)
1962 "Return a regexp matching a node name.
fdf4b680 1963ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
c60c12be
SM
1964saying which chars may appear in the node name.
1965Submatch 1 is the complete node name.
1966Submatch 2 if non-nil is the parenthesized file name part of the node name.
1967Submatch 3 is the local part of the node name.
1968End of submatch 0, 1, and 3 are the same, so you can safely concat."
1969 (concat "[ \t]*" ;Skip leading space.
1970 "\\(\\(([^)]+)\\)?" ;Node name can start with a file name.
1971 "\\([" (or allowedchars "^,\t\n") "]*" ;Any number of allowed chars.
1972 "[" (or allowedchars "^,\t\n") " ]" ;The last char can't be a space.
1973 "\\|\\)\\)")) ;Allow empty node names.
a384cab3 1974
718e6bc7
RS
1975;;; For compatibility; other files have used this name.
1976(defun Info-following-node-name ()
1977 (and (looking-at (Info-following-node-name-re))
bec275ed 1978 (match-string-no-properties 1)))
718e6bc7 1979
a384cab3
JB
1980(defun Info-next ()
1981 "Go to the next node of this node."
1982 (interactive)
222a6c9b
CY
1983 ;; In case another window is currently selected
1984 (save-window-excursion
1985 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
1986 (Info-goto-node (Info-extract-pointer "next"))))
a384cab3
JB
1987
1988(defun Info-prev ()
1989 "Go to the previous node of this node."
1990 (interactive)
222a6c9b
CY
1991 ;; In case another window is currently selected
1992 (save-window-excursion
1993 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
1994 (Info-goto-node (Info-extract-pointer "prev[ious]*" "previous"))))
a384cab3 1995
5dab2fb4
RS
1996(defun Info-up (&optional same-file)
1997 "Go to the superior node of this node.
1998If SAME-FILE is non-nil, do not move to a different Info file."
a384cab3 1999 (interactive)
222a6c9b
CY
2000 ;; In case another window is currently selected
2001 (save-window-excursion
2002 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
2003 (let ((old-node Info-current-node)
2004 (old-file Info-current-file)
2005 (node (Info-extract-pointer "up")) p)
d590dbd2 2006 (and same-file
222a6c9b
CY
2007 (string-match "^(" node)
2008 (error "Up node is in another Info file"))
2009 (Info-goto-node node)
2010 (setq p (point))
2011 (goto-char (point-min))
bec275ed
JL
2012 (if (and (stringp old-file)
2013 (search-forward "\n* Menu:" nil t)
222a6c9b
CY
2014 (re-search-forward
2015 (if (string-equal old-node "Top")
2016 (concat "\n\\*[^:]+: +(" (file-name-nondirectory old-file) ")")
2017 (concat "\n\\* +\\(" (regexp-quote old-node)
2018 ":\\|[^:]+: +" (regexp-quote old-node) "\\)"))
2019 nil t))
2020 (progn (beginning-of-line) (if (looking-at "^\\* ") (forward-char 2)))
2021 (goto-char p)
2022 (Info-restore-point Info-history)))))
a384cab3 2023
424b9d3e
JL
2024(defun Info-history-back ()
2025 "Go back in the history to the last node visited."
a384cab3
JB
2026 (interactive)
2027 (or Info-history
2028 (error "This is the first Info node you looked at"))
424b9d3e
JL
2029 (let ((history-forward
2030 (cons (list Info-current-file Info-current-node (point))
2031 Info-history-forward))
2032 filename nodename opoint)
a384cab3
JB
2033 (setq filename (car (car Info-history)))
2034 (setq nodename (car (cdr (car Info-history))))
2035 (setq opoint (car (cdr (cdr (car Info-history)))))
2036 (setq Info-history (cdr Info-history))
2037 (Info-find-node filename nodename)
2038 (setq Info-history (cdr Info-history))
424b9d3e
JL
2039 (setq Info-history-forward history-forward)
2040 (goto-char opoint)))
2041
2042(defalias 'Info-last 'Info-history-back)
2043
2044(defun Info-history-forward ()
2045 "Go forward in the history of visited nodes."
2046 (interactive)
2047 (or Info-history-forward
2048 (error "This is the last Info node you looked at"))
2049 (let ((history-forward (cdr Info-history-forward))
2050 filename nodename opoint)
2051 (setq filename (car (car Info-history-forward)))
2052 (setq nodename (car (cdr (car Info-history-forward))))
2053 (setq opoint (car (cdr (cdr (car Info-history-forward)))))
2054 (Info-find-node filename nodename)
2055 (setq Info-history-forward history-forward)
a384cab3 2056 (goto-char opoint)))
6a013a49
JL
2057\f
2058(add-to-list 'Info-virtual-files
2059 '("\\`dir\\'"
2060 (toc-nodes . Info-directory-toc-nodes)
2061 (find-file . Info-directory-find-file)
2062 (find-node . Info-directory-find-node)
2063 ))
2064
2065(defun Info-directory-toc-nodes (filename)
2066 "Directory-specific implementation of Info-directory-toc-nodes."
2067 `(,filename
2068 ("Top" nil nil nil)))
2069
2070(defun Info-directory-find-file (filename &optional noerror)
2071 "Directory-specific implementation of Info-find-file."
2072 filename)
2073
2074(defun Info-directory-find-node (filename nodename &optional no-going-back)
2075 "Directory-specific implementation of Info-find-node-2."
2076 (Info-insert-dir))
a384cab3 2077
48e5b471 2078;;;###autoload
a384cab3
JB
2079(defun Info-directory ()
2080 "Go to the Info directory node."
2081 (interactive)
2082 (Info-find-node "dir" "top"))
2083\f
6a013a49
JL
2084(add-to-list 'Info-virtual-files
2085 '("\\`\\*History\\*\\'"
2086 (toc-nodes . Info-history-toc-nodes)
2087 (find-file . Info-history-find-file)
2088 (find-node . Info-history-find-node)
2089 ))
2090
2091(defun Info-history-toc-nodes (filename)
2092 "History-specific implementation of Info-history-toc-nodes."
2093 `(,filename
2094 ("Top" nil nil nil)))
2095
2096(defun Info-history-find-file (filename &optional noerror)
2097 "History-specific implementation of Info-find-file."
2098 filename)
2099
2100(defun Info-history-find-node (filename nodename &optional no-going-back)
2101 "History-specific implementation of Info-find-node-2."
2102 (insert (format "\n\^_\nFile: %s, Node: %s, Up: (dir)\n\n"
2103 (or filename Info-current-file) nodename))
2104 (insert "Recently Visited Nodes\n")
2105 (insert "**********************\n\n")
2106 (insert "* Menu:\n\n")
2107 (let ((hl (delete '("*History*" "Top") Info-history-list)))
2108 (while hl
2109 (let ((file (nth 0 (car hl)))
2110 (node (nth 1 (car hl))))
2111 (if (stringp file)
2112 (insert "* " node ": ("
2113 (propertize (or (file-name-directory file) "") 'invisible t)
2114 (file-name-nondirectory file)
2115 ")" node ".\n")))
2116 (setq hl (cdr hl)))))
2117
8a7757f6 2118(defun Info-history ()
89b064a9 2119 "Go to a node with a menu of visited nodes."
8a7757f6 2120 (interactive)
6a013a49
JL
2121 (Info-find-node "*History*" "Top")
2122 (Info-next-reference)
2123 (Info-next-reference))
2124\f
2125(add-to-list 'Info-virtual-nodes
2126 '("\\`\\*TOC\\*\\'"
2127 (find-node . Info-toc-find-node)
2128 ))
2129
2130(defun Info-toc-find-node (filename nodename &optional no-going-back)
2131 "Toc-specific implementation of Info-find-node-2."
2132 (let* ((curr-file (substring-no-properties (or filename Info-current-file)))
2133 (curr-node (substring-no-properties (or nodename Info-current-node)))
2134 (node-list (Info-toc-nodes curr-file)))
2135 (insert (format "\n\^_\nFile: %s, Node: %s, Up: Top\n\n"
2136 curr-file curr-node))
2137 (insert "Table of Contents\n")
2138 (insert "*****************\n\n")
2139 (insert "*Note Top::\n")
2140 (Info-toc-insert
2141 (nth 3 (assoc "Top" node-list)) ; get Top nodes
2142 node-list 0 curr-file)
2143 (unless (bobp)
2144 (let ((Info-hide-note-references 'hide)
2145 (Info-fontify-visited-nodes nil))
2146 (setq Info-current-file filename Info-current-node "*TOC*")
2147 (goto-char (point-min))
2148 (narrow-to-region (or (re-search-forward "\n[\^_\f]\n" nil t)
2149 (point-min))
2150 (point-max))
2151 (Info-fontify-node)
2152 (widen)))))
8a7757f6 2153
8a7757f6 2154(defun Info-toc ()
bc224645
JL
2155 "Go to a node with table of contents of the current Info file.
2156Table of contents is created from the tree structure of menus."
8a7757f6 2157 (interactive)
6a013a49
JL
2158 (Info-find-node Info-current-file "*TOC*")
2159 (let ((prev-node (nth 1 (car Info-history))) p)
2160 (goto-char (point-min))
2161 (if (setq p (search-forward (concat "*Note " prev-node ":") nil t))
2162 (setq p (- p (length prev-node) 2)))
2163 (goto-char (or p (point-min)))))
8a7757f6 2164
6a013a49 2165(defun Info-toc-insert (nodes node-list level curr-file)
8a7757f6
JL
2166 "Insert table of contents with references to nodes."
2167 (let ((section "Top"))
2168 (while nodes
2169 (let ((node (assoc (car nodes) node-list)))
586f9284
JL
2170 (unless (member (nth 2 node) (list nil section))
2171 (insert (setq section (nth 2 node)) "\n"))
8a7757f6 2172 (insert (make-string level ?\t))
6a013a49
JL
2173 (insert "*Note " (car nodes) ":: \n")
2174 (Info-toc-insert (nth 3 node) node-list (1+ level) curr-file)
8a7757f6
JL
2175 (setq nodes (cdr nodes))))))
2176
6a013a49 2177(defun Info-toc-build (file)
8a7757f6 2178 "Build table of contents from menus of Info FILE and its subfiles."
8a7757f6 2179 (with-temp-buffer
ea99d5c8
JL
2180 (let* ((file (and (stringp file) (Info-find-file file)))
2181 (default-directory (or (and (stringp file)
2182 (file-name-directory file))
141b49f5 2183 default-directory))
ea99d5c8 2184 (main-file (and (stringp file) file))
141b49f5
JL
2185 (sections '(("Top" "Top")))
2186 nodes subfiles)
2187 (while (or main-file subfiles)
586f9284 2188 ;; (or main-file (message "Searching subfile %s..." (car subfiles)))
8a7757f6 2189 (erase-buffer)
141b49f5
JL
2190 (info-insert-file-contents (or main-file (car subfiles)))
2191 (goto-char (point-min))
8a7757f6
JL
2192 (while (and (search-forward "\n\^_\nFile:" nil 'move)
2193 (search-forward "Node: " nil 'move))
586f9284
JL
2194 (let* ((nodename (substring-no-properties (Info-following-node-name)))
2195 (bound (- (or (save-excursion (search-forward "\n\^_" nil t))
2196 (point-max)) 2))
2197 (upnode (and (re-search-forward
2198 (concat "Up:" (Info-following-node-name-re))
2199 bound t)
2200 (match-string-no-properties 1)))
2201 (section "Top")
2202 menu-items)
2203 (when (string-match "(" upnode) (setq upnode nil))
141b49f5 2204 (when (and (not (Info-index-node nodename file))
8a7757f6
JL
2205 (re-search-forward "^\\* Menu:" bound t))
2206 (forward-line 1)
2207 (beginning-of-line)
2208 (setq bound (or (and (equal nodename "Top")
2209 (save-excursion
2210 (re-search-forward
2211 "^[ \t-]*The Detailed Node Listing" nil t)))
2212 bound))
2213 (while (< (point) bound)
2214 (cond
2215 ;; Menu item line
2216 ((looking-at "^\\* +[^:]+:")
2217 (beginning-of-line)
2218 (forward-char 2)
2219 (let ((menu-node-name (substring-no-properties
2220 (Info-extract-menu-node-name))))
2221 (setq menu-items (cons menu-node-name menu-items))
2222 (if (equal nodename "Top")
2223 (setq sections
2224 (cons (list menu-node-name section) sections)))))
2225 ;; Other non-empty strings in the Top node are section names
2226 ((and (equal nodename "Top")
2227 (looking-at "^\\([^ \t\n*=.-][^:\n]*\\)"))
2228 (setq section (match-string-no-properties 1))))
2229 (forward-line 1)
2230 (beginning-of-line)))
586f9284 2231 (setq nodes (cons (list nodename upnode
8a7757f6
JL
2232 (cadr (assoc nodename sections))
2233 (nreverse menu-items))
2234 nodes))
2235 (goto-char bound)))
141b49f5 2236 (if main-file
8a7757f6
JL
2237 (save-excursion
2238 (goto-char (point-min))
2239 (if (search-forward "\n\^_\nIndirect:" nil t)
2240 (let ((bound (save-excursion (search-forward "\n\^_" nil t))))
2241 (while (re-search-forward "^\\(.*\\): [0-9]+$" bound t)
2242 (setq subfiles (cons (match-string-no-properties 1)
2243 subfiles)))))
2244 (setq subfiles (nreverse subfiles)
141b49f5 2245 main-file nil))
8a7757f6
JL
2246 (setq subfiles (cdr subfiles))))
2247 (message "")
2248 (nreverse nodes))))
586f9284
JL
2249
2250(defvar Info-toc-nodes nil
2251 "Alist of cached parent-children node information in visited Info files.
2252Each element is (FILE (NODE-NAME PARENT SECTION CHILDREN) ...)
2253where PARENT is the parent node extracted from the Up pointer,
2254SECTION is the section name in the Top node where this node is placed,
2255CHILDREN is a list of child nodes extracted from the node menu.")
2256
6a013a49
JL
2257(defun Info-toc-nodes (filename)
2258 "Return a node list of Info FILENAME with parent-children information.
586f9284 2259This information is cached in the variable `Info-toc-nodes' with the help
6a013a49
JL
2260of the function `Info-toc-build'."
2261 (cond
2262 ((Info-virtual-call
2263 (Info-virtual-fun 'toc-nodes (or filename Info-current-file) nil)
2264 filename))
2265 (t
2266 (or filename (setq filename Info-current-file))
2267 (or (assoc filename Info-toc-nodes)
2268 ;; Skip virtual Info files
2269 (and (or (not (stringp filename))
2270 (Info-virtual-file-p filename))
2271 (push (cons filename nil) Info-toc-nodes))
2272 ;; Scan the entire manual and cache the result in Info-toc-nodes
2273 (let ((nodes (Info-toc-build filename)))
2274 (push (cons filename nodes) Info-toc-nodes)
2275 nodes)
2276 ;; If there is an error, still add nil to the cache
2277 (push (cons filename nil) Info-toc-nodes))
2278 (cdr (assoc filename Info-toc-nodes)))))
586f9284 2279
8a7757f6
JL
2280\f
2281(defun Info-follow-reference (footnotename &optional fork)
fdf4b680 2282 "Follow cross reference named FOOTNOTENAME to the node it refers to.
8a7757f6
JL
2283FOOTNOTENAME may be an abbreviation of the reference name.
2284If FORK is non-nil (interactively with a prefix arg), show the node in
185cff95 2285a new Info buffer. If FORK is a string, it is the name to use for the
8a7757f6 2286new buffer."
a384cab3
JB
2287 (interactive
2288 (let ((completion-ignore-case t)
1bcedb3b 2289 (case-fold-search t)
67bc89ab 2290 completions default alt-default (start-point (point)) str i bol eol)
a384cab3 2291 (save-excursion
67bc89ab
RS
2292 ;; Store end and beginning of line.
2293 (end-of-line)
2294 (setq eol (point))
2295 (beginning-of-line)
2296 (setq bol (point))
2297
a384cab3 2298 (goto-char (point-min))
8a7757f6 2299 (while (re-search-forward "\\*note[ \n\t]+\\([^:]*\\):" nil t)
c60c12be 2300 (setq str (match-string-no-properties 1))
a384cab3
JB
2301 ;; See if this one should be the default.
2302 (and (null default)
1f179e27 2303 (<= (match-beginning 0) start-point)
a384cab3
JB
2304 (<= start-point (point))
2305 (setq default t))
67bc89ab
RS
2306 ;; See if this one should be the alternate default.
2307 (and (null alt-default)
2308 (and (<= bol (match-beginning 0))
2309 (<= (point) eol))
2310 (setq alt-default t))
a384cab3
JB
2311 (setq i 0)
2312 (while (setq i (string-match "[ \n\t]+" str i))
2313 (setq str (concat (substring str 0 i) " "
2314 (substring str (match-end 0))))
2315 (setq i (1+ i)))
2316 ;; Record as a completion and perhaps as default.
2317 (if (eq default t) (setq default str))
67bc89ab 2318 (if (eq alt-default t) (setq alt-default str))
ec6d29af 2319 ;; Don't add this string if it's a duplicate.
c60c12be
SM
2320 (or (assoc-string str completions t)
2321 (push str completions))))
67bc89ab
RS
2322 ;; If no good default was found, try an alternate.
2323 (or default
2324 (setq default alt-default))
2325 ;; If only one cross-reference found, then make it default.
2326 (if (eq (length completions) 1)
c60c12be 2327 (setq default (car completions)))
a384cab3 2328 (if completions
b0ebdfe5 2329 (let ((input (completing-read (if default
968b7671 2330 (concat
5b76833f
RF
2331 "Follow reference named (default "
2332 default "): ")
b0ebdfe5
RS
2333 "Follow reference named: ")
2334 completions nil t)))
2335 (list (if (equal input "")
8a7757f6 2336 default input) current-prefix-arg))
a384cab3 2337 (error "No cross-references in this node"))))
ebf8f7e1
RS
2338
2339 (unless footnotename
2340 (error "No reference was specified"))
2341
dde7f979 2342 (let (target i (str (concat "\\*note " (regexp-quote footnotename)))
1bcedb3b 2343 (case-fold-search t))
a384cab3
JB
2344 (while (setq i (string-match " " str i))
2345 (setq str (concat (substring str 0 i) "[ \t\n]+" (substring str (1+ i))))
2346 (setq i (+ i 6)))
2347 (save-excursion
8a7757f6
JL
2348 ;; Move point to the beginning of reference if point is on reference
2349 (or (looking-at "\\*note[ \n\t]+")
2350 (and (looking-back "\\*note[ \n\t]+")
2351 (goto-char (match-beginning 0)))
2352 (if (and (save-excursion
2353 (goto-char (+ (point) 5)) ; skip a possible *note
2354 (re-search-backward "\\*note[ \n\t]+" nil t)
836bb478 2355 (looking-at str))
8a7757f6
JL
2356 (<= (point) (match-end 0)))
2357 (goto-char (match-beginning 0))))
2358 ;; Go to the reference closest to point
2359 (let ((next-ref (save-excursion (and (re-search-forward str nil t)
2360 (+ (match-beginning 0) 5))))
2361 (prev-ref (save-excursion (and (re-search-backward str nil t)
2362 (+ (match-beginning 0) 5)))))
2363 (goto-char (cond ((and next-ref prev-ref)
2364 (if (< (abs (- next-ref (point)))
2365 (abs (- prev-ref (point))))
2366 next-ref prev-ref))
2367 ((or next-ref prev-ref))
2368 ((error "No cross-reference named %s" footnotename))))
2369 (setq target (Info-extract-menu-node-name t))))
a384cab3
JB
2370 (while (setq i (string-match "[ \t\n]+" target i))
2371 (setq target (concat (substring target 0 i) " "
2372 (substring target (match-end 0))))
2373 (setq i (+ i 1)))
8a7757f6 2374 (Info-goto-node target fork)))
a384cab3 2375
e057da52
SM
2376(defconst Info-menu-entry-name-re "\\(?:[^:]\\|:[^:,.;() \t\n]\\)*"
2377 ;; We allow newline because this is also used in Info-follow-reference,
2378 ;; where the xref name might be wrapped over two lines.
c60c12be
SM
2379 "Regexp that matches a menu entry name upto but not including the colon.
2380Because of ambiguities, this should be concatenated with something like
2381`:' and `Info-following-node-name-re'.")
2382
836bb478 2383(defun Info-extract-menu-node-name (&optional multi-line index-node)
a384cab3 2384 (skip-chars-forward " \t\n")
c60c12be
SM
2385 (when (looking-at (concat Info-menu-entry-name-re ":\\(:\\|"
2386 (Info-following-node-name-re
836bb478
JL
2387 (cond
2388 (index-node "^,\t\n")
2389 (multi-line "^.,\t")
2390 (t "^.,\t\n")))
2391 "\\)"
2392 (if index-node
2393 "\\.\\(?:[ \t\n]+(line +\\([0-9]+\\))\\)?"
2394 "")))
2395 (if index-node
2396 (setq Info-point-loc
2397 (if (match-beginning 5)
2398 (string-to-number (match-string 5))
bec275ed
JL
2399 (buffer-substring-no-properties
2400 (match-beginning 0) (1- (match-beginning 1)))))
02c9f5cd 2401;;; Uncomment next line to use names of cross-references in non-index nodes:
836bb478
JL
2402;;; (setq Info-point-loc
2403;;; (buffer-substring (match-beginning 0) (1- (match-beginning 1))))
2404 )
c60c12be
SM
2405 (replace-regexp-in-string
2406 "[ \n]+" " "
bec275ed 2407 (or (match-string-no-properties 2)
c60c12be 2408 ;; If the node name is the menu entry name (using `entry::').
bec275ed
JL
2409 (buffer-substring-no-properties
2410 (match-beginning 0) (1- (match-beginning 1)))))))
a384cab3 2411
e8adde3f 2412;; No one calls this.
9e5c2f50
RS
2413;;(defun Info-menu-item-sequence (list)
2414;; (while list
e8adde3f 2415;; (Info-menu (car list))
9e5c2f50 2416;; (setq list (cdr list))))
a384cab3 2417
6356e646 2418(defvar Info-complete-menu-buffer)
e4e8ee63 2419(defvar Info-complete-next-re nil)
141b49f5 2420(defvar Info-complete-nodes nil)
e4e8ee63 2421(defvar Info-complete-cache nil)
6356e646 2422
c60c12be
SM
2423(defconst Info-node-spec-re
2424 (concat (Info-following-node-name-re "^.,:") "[,:.]")
a1637357
SM
2425 "Regexp to match the text after a : until the terminating `.'.")
2426
e8adde3f 2427(defun Info-complete-menu-item (string predicate action)
2d12f5c2
SM
2428 ;; This uses two dynamically bound variables:
2429 ;; - `Info-complete-menu-buffer' which contains the buffer in which
2430 ;; is the menu of items we're trying to complete.
2431 ;; - `Info-complete-next-re' which, if non-nil, indicates that we should
2432 ;; also look for menu items in subsequent nodes as long as those
2433 ;; nodes' names match `Info-complete-next-re'. This feature is currently
141b49f5
JL
2434 ;; not used.
2435 ;; - `Info-complete-nodes' which, if non-nil, indicates that we should
2436 ;; also look for menu items in these nodes. This feature is currently
2d12f5c2 2437 ;; only used for completion in Info-index.
0defe758
LK
2438
2439 ;; Note that `Info-complete-menu-buffer' could be current already,
2440 ;; so we want to save point.
e8dab975 2441 (with-current-buffer Info-complete-menu-buffer
494858be
SM
2442 (save-excursion
2443 (let ((completion-ignore-case t)
2444 (case-fold-search t)
2445 (orignode Info-current-node)
2446 nextnode)
2447 (goto-char (point-min))
2448 (search-forward "\n* Menu:")
c2a37b78
SM
2449 (cond
2450 ((eq (car-safe action) 'boundaries) nil)
2451 ((eq action 'lambda)
2452 (re-search-forward
2453 (concat "\n\\* +" (regexp-quote string) ":") nil t))
2454 (t
494858be
SM
2455 (let ((pattern (concat "\n\\* +\\("
2456 (regexp-quote string)
c2a37b78
SM
2457 Info-menu-entry-name-re "\\):"
2458 Info-node-spec-re))
494858be
SM
2459 completions
2460 (complete-nodes Info-complete-nodes))
2461 ;; Check the cache.
2462 (if (and (equal (nth 0 Info-complete-cache) Info-current-file)
2463 (equal (nth 1 Info-complete-cache) Info-current-node)
2464 (equal (nth 2 Info-complete-cache) Info-complete-next-re)
2465 (equal (nth 5 Info-complete-cache) Info-complete-nodes)
2466 (let ((prev (nth 3 Info-complete-cache)))
2467 (eq t (compare-strings string 0 (length prev)
2468 prev 0 nil t))))
2469 ;; We can reuse the previous list.
2470 (setq completions (nth 4 Info-complete-cache))
2471 ;; The cache can't be used.
2472 (while
2473 (progn
2474 (while (re-search-forward pattern nil t)
2475 (push (match-string-no-properties 1)
2476 completions))
2477 ;; Check subsequent nodes if applicable.
2478 (or (and Info-complete-next-re
2479 (setq nextnode (Info-extract-pointer "next" t))
2480 (string-match Info-complete-next-re nextnode))
2481 (and complete-nodes
2482 (setq complete-nodes (cdr complete-nodes)
2483 nextnode (car complete-nodes)))))
2484 (Info-goto-node nextnode))
2485 ;; Go back to the start node (for the next completion).
2486 (unless (equal Info-current-node orignode)
2487 (Info-goto-node orignode))
2488 ;; Update the cache.
2489 (set (make-local-variable 'Info-complete-cache)
d5850019
JB
2490 (list Info-current-file Info-current-node
2491 Info-complete-next-re string completions
2492 Info-complete-nodes)))
c2a37b78 2493 (complete-with-action action completions string predicate))))))))
e8adde3f
RS
2494
2495
4fceda3c 2496(defun Info-menu (menu-item &optional fork)
dc414be1
EZ
2497 "Go to the node pointed to by the menu item named (or abbreviated) MENU-ITEM.
2498The menu item should one of those listed in the current node's menu.
2499Completion is allowed, and the default menu item is the one point is on.
7210b6f5 2500If FORK is non-nil (interactively with a prefix arg), show the node in
185cff95 2501a new Info buffer. If FORK is a string, it is the name to use for the
7210b6f5 2502new buffer."
a384cab3 2503 (interactive
c2a37b78 2504 (let (;; If point is within a menu item, use that item as the default
a384cab3
JB
2505 (default nil)
2506 (p (point))
211d6309 2507 beg
760d5cb3 2508 (case-fold-search t))
a384cab3
JB
2509 (save-excursion
2510 (goto-char (point-min))
2511 (if (not (search-forward "\n* menu:" nil t))
2512 (error "No menu in this node"))
e8adde3f
RS
2513 (setq beg (point))
2514 (and (< (point) p)
2515 (save-excursion
2516 (goto-char p)
2517 (end-of-line)
00d32b3f
SM
2518 (if (re-search-backward (concat "\n\\* +\\("
2519 Info-menu-entry-name-re
2520 "\\):") beg t)
110d4e80 2521 (setq default (match-string-no-properties 1))))))
a384cab3
JB
2522 (let ((item nil))
2523 (while (null item)
e8adde3f
RS
2524 (setq item (let ((completion-ignore-case t)
2525 (Info-complete-menu-buffer (current-buffer)))
a384cab3
JB
2526 (completing-read (if default
2527 (format "Menu item (default %s): "
2528 default)
760d5cb3 2529 "Menu item: ")
e8adde3f 2530 'Info-complete-menu-item nil t)))
aea2a8da
JB
2531 ;; we rely on the fact that completing-read accepts an input
2532 ;; of "" even when the require-match argument is true and ""
2533 ;; is not a valid possibility
a384cab3
JB
2534 (if (string= item "")
2535 (if default
2536 (setq item default)
760d5cb3
GM
2537 ;; ask again
2538 (setq item nil))))
4fceda3c 2539 (list item current-prefix-arg))))
a384cab3
JB
2540 ;; there is a problem here in that if several menu items have the same
2541 ;; name you can only go to the node of the first with this command.
4fceda3c 2542 (Info-goto-node (Info-extract-menu-item menu-item) (if fork menu-item)))
399c88ad 2543
a384cab3
JB
2544(defun Info-extract-menu-item (menu-item)
2545 (setq menu-item (regexp-quote menu-item))
1bcedb3b
RS
2546 (let ((case-fold-search t))
2547 (save-excursion
760d5cb3
GM
2548 (let ((case-fold-search t))
2549 (goto-char (point-min))
2550 (or (search-forward "\n* menu:" nil t)
2551 (error "No menu in this node"))
2552 (or (re-search-forward (concat "\n\\* +" menu-item ":") nil t)
2553 (re-search-forward (concat "\n\\* +" menu-item) nil t)
2554 (error "No such item in menu"))
2555 (beginning-of-line)
2556 (forward-char 2)
141b49f5 2557 (Info-extract-menu-node-name nil (Info-index-node))))))
a384cab3
JB
2558
2559;; If COUNT is nil, use the last item in the menu.
c24d4826 2560(defun Info-extract-menu-counting (count &optional no-detail)
1bcedb3b
RS
2561 (let ((case-fold-search t))
2562 (save-excursion
c24d4826
MR
2563 (let ((case-fold-search t)
2564 (bound (when (and no-detail
2565 (re-search-forward
2566 "^[ \t-]*The Detailed Node Listing" nil t))
2567 (match-beginning 0))))
760d5cb3 2568 (goto-char (point-min))
c24d4826 2569 (or (search-forward "\n* menu:" bound t)
760d5cb3
GM
2570 (error "No menu in this node"))
2571 (if count
c24d4826 2572 (or (search-forward "\n* " bound t count)
760d5cb3 2573 (error "Too few items in menu"))
c24d4826 2574 (while (search-forward "\n* " bound t)
760d5cb3 2575 nil))
141b49f5 2576 (Info-extract-menu-node-name nil (Info-index-node))))))
a384cab3 2577
e38e7367
RM
2578(defun Info-nth-menu-item ()
2579 "Go to the node of the Nth menu item.
2580N is the digit argument used to invoke this command."
a384cab3 2581 (interactive)
e38e7367
RM
2582 (Info-goto-node
2583 (Info-extract-menu-counting
2584 (- (aref (this-command-keys) (1- (length (this-command-keys)))) ?0))))
a384cab3
JB
2585
2586(defun Info-top-node ()
2587 "Go to the Top node of this file."
2588 (interactive)
2589 (Info-goto-node "Top"))
2590
2591(defun Info-final-node ()
2592 "Go to the final node in this file."
2593 (interactive)
2594 (Info-goto-node "Top")
760d5cb3
GM
2595 (let ((Info-history nil)
2596 (case-fold-search t))
c24d4826
MR
2597 ;; Go to the last node in the menu of Top. But don't delve into
2598 ;; detailed node listings.
2599 (Info-goto-node (Info-extract-menu-counting nil t))
a384cab3 2600 ;; If the last node in the menu is not last in pointer structure,
c24d4826
MR
2601 ;; move forward (but not down- or upward - see bug#1116) until we
2602 ;; can't go any farther.
2603 (while (Info-forward-node t t t) nil)
a384cab3 2604 ;; Then keep moving down to last subnode, unless we reach an index.
141b49f5 2605 (while (and (not (Info-index-node))
a384cab3
JB
2606 (save-excursion (search-forward "\n* Menu:" nil t)))
2607 (Info-goto-node (Info-extract-menu-counting nil)))))
2608
c24d4826 2609(defun Info-forward-node (&optional not-down not-up no-error)
a384cab3
JB
2610 "Go forward one node, considering all nodes as forming one sequence."
2611 (interactive)
2612 (goto-char (point-min))
2613 (forward-line 1)
760d5cb3
GM
2614 (let ((case-fold-search t))
2615 ;; three possibilities, in order of priority:
2616 ;; 1. next node is in a menu in this node (but not in an index)
2617 ;; 2. next node is next at same level
2618 ;; 3. next node is up and next
2619 (cond ((and (not not-down)
2620 (save-excursion (search-forward "\n* menu:" nil t))
141b49f5 2621 (not (Info-index-node)))
760d5cb3
GM
2622 (Info-goto-node (Info-extract-menu-counting 1))
2623 t)
6af7040d 2624 ((save-excursion (search-backward "next:" nil t))
760d5cb3
GM
2625 (Info-next)
2626 t)
c24d4826
MR
2627 ((and (not not-up)
2628 (save-excursion (search-backward "up:" nil t))
760d5cb3
GM
2629 ;; Use string-equal, not equal, to ignore text props.
2630 (not (string-equal (downcase (Info-extract-pointer "up"))
2631 "top")))
2632 (let ((old-node Info-current-node))
2633 (Info-up)
2634 (let (Info-history success)
2635 (unwind-protect
c24d4826 2636 (setq success (Info-forward-node t nil no-error))
760d5cb3
GM
2637 (or success (Info-goto-node old-node))))))
2638 (no-error nil)
2639 (t (error "No pointer forward from this node")))))
a384cab3
JB
2640
2641(defun Info-backward-node ()
2642 "Go backward one node, considering all nodes as forming one sequence."
2643 (interactive)
2644 (let ((prevnode (Info-extract-pointer "prev[ious]*" t))
760d5cb3
GM
2645 (upnode (Info-extract-pointer "up" t))
2646 (case-fold-search t))
a384cab3
JB
2647 (cond ((and upnode (string-match "(" upnode))
2648 (error "First node in file"))
2649 ((and upnode (or (null prevnode)
e90d1271
RS
2650 ;; Use string-equal, not equal,
2651 ;; to ignore text properties.
2652 (string-equal (downcase prevnode)
2653 (downcase upnode))))
a384cab3
JB
2654 (Info-up))
2655 (prevnode
2656 ;; If we move back at the same level,
2657 ;; go down to find the last subnode*.
2658 (Info-prev)
2659 (let (Info-history)
141b49f5 2660 (while (and (not (Info-index-node))
a384cab3
JB
2661 (save-excursion (search-forward "\n* Menu:" nil t)))
2662 (Info-goto-node (Info-extract-menu-counting nil)))))
2663 (t
2664 (error "No pointer backward from this node")))))
2665
2666(defun Info-exit ()
2667 "Exit Info by selecting some other buffer."
2668 (interactive)
552775bd
RS
2669 (if Info-standalone
2670 (save-buffers-kill-emacs)
4643e92f 2671 (quit-window)))
a384cab3 2672
253db917 2673(defun Info-next-menu-item ()
3a8803c0 2674 "Go to the node of the next menu item."
253db917 2675 (interactive)
fdf4b680 2676 ;; Bind this in case the user sets it to nil.
760d5cb3
GM
2677 (let* ((case-fold-search t)
2678 (node
2679 (save-excursion
2680 (forward-line -1)
2681 (search-forward "\n* menu:" nil t)
2682 (and (search-forward "\n* " nil t)
2683 (Info-extract-menu-node-name)))))
fadfb77f
RS
2684 (if node (Info-goto-node node)
2685 (error "No more items in menu"))))
253db917
ER
2686
2687(defun Info-last-menu-item ()
3a8803c0 2688 "Go to the node of the previous menu item."
253db917
ER
2689 (interactive)
2690 (save-excursion
2691 (forward-line 1)
fdf4b680 2692 ;; Bind this in case the user sets it to nil.
760d5cb3
GM
2693 (let* ((case-fold-search t)
2694 (beg (save-excursion
2695 (and (search-backward "\n* menu:" nil t)
2696 (point)))))
0a56332b
RS
2697 (or (and beg (search-backward "\n* " beg t))
2698 (error "No previous items in menu")))
2699 (Info-goto-node (save-excursion
2700 (goto-char (match-end 0))
2701 (Info-extract-menu-node-name)))))
253db917 2702
552775bd 2703(defmacro Info-no-error (&rest body)
253db917
ER
2704 (list 'condition-case nil (cons 'progn (append body '(t))) '(error nil)))
2705
2706(defun Info-next-preorder ()
3c9179ea
RS
2707 "Go to the next subnode or the next node, or go up a level."
2708 (interactive)
2709 (cond ((Info-no-error (Info-next-menu-item)))
2710 ((Info-no-error (Info-next)))
5dab2fb4 2711 ((Info-no-error (Info-up t))
ed690657
KH
2712 ;; Since we have already gone thru all the items in this menu,
2713 ;; go up to the end of this node.
b54d0f0e
RS
2714 (goto-char (point-max))
2715 ;; Since logically we are done with the node with that menu,
fd3d78f2
JL
2716 ;; move on from it. But don't add intermediate nodes
2717 ;; to the history on recursive calls.
2718 (let (Info-history)
2719 (Info-next-preorder)))
3c9179ea
RS
2720 (t
2721 (error "No more nodes"))))
253db917
ER
2722
2723(defun Info-last-preorder ()
2724 "Go to the last node, popping up a level if there is none."
2725 (interactive)
0a56332b
RS
2726 (cond ((Info-no-error
2727 (Info-last-menu-item)
2728 ;; If we go down a menu item, go to the end of the node
2729 ;; so we can scroll back through it.
ed690657 2730 (goto-char (point-max)))
b54d0f0e
RS
2731 ;; Keep going down, as long as there are nested menu nodes.
2732 (while (Info-no-error
2733 (Info-last-menu-item)
2734 ;; If we go down a menu item, go to the end of the node
2735 ;; so we can scroll back through it.
2736 (goto-char (point-max))))
ed690657 2737 (recenter -1))
c2def7a0
MB
2738 ((and (Info-no-error (Info-extract-pointer "prev"))
2739 (not (equal (Info-extract-pointer "up")
5dab2fb4
RS
2740 (Info-extract-pointer "prev"))))
2741 (Info-no-error (Info-prev))
ed690657 2742 (goto-char (point-max))
b54d0f0e
RS
2743 (while (Info-no-error
2744 (Info-last-menu-item)
2745 ;; If we go down a menu item, go to the end of the node
2746 ;; so we can scroll back through it.
2747 (goto-char (point-max))))
ed690657 2748 (recenter -1))
5dab2fb4 2749 ((Info-no-error (Info-up t))
ed690657 2750 (goto-char (point-min))
760d5cb3
GM
2751 (let ((case-fold-search t))
2752 (or (search-forward "\n* Menu:" nil t)
2753 (goto-char (point-max)))))
ed690657 2754 (t (error "No previous nodes"))))
253db917
ER
2755
2756(defun Info-scroll-up ()
3f32dc86 2757 "Scroll one screenful forward in Info, considering all nodes as one sequence.
280d11ed 2758Once you scroll far enough in a node that its menu appears on the screen
7a53d8c8
EZ
2759but after point, the next scroll moves into its first subnode, unless
2760`Info-scroll-prefer-subnodes' is nil.
280d11ed 2761
7a53d8c8
EZ
2762When you scroll past the end of a node, that goes to the next node if
2763`Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
2764if this node has no successor, it moves to the parent node's successor,
2765and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
2766the menu of a node, it moves to subnode indicated by the following menu
2767item. (That case won't normally result from this command, but can happen
2768in other ways.)"
280d11ed 2769
253db917 2770 (interactive)
0a56332b
RS
2771 (if (or (< (window-start) (point-min))
2772 (> (window-start) (point-max)))
2773 (set-window-start (selected-window) (point)))
760d5cb3
GM
2774 (let* ((case-fold-search t)
2775 (virtual-end (save-excursion
2776 (goto-char (point-min))
7a53d8c8
EZ
2777 (if (and Info-scroll-prefer-subnodes
2778 (search-forward "\n* Menu:" nil t))
760d5cb3
GM
2779 (point)
2780 (point-max)))))
0a56332b
RS
2781 (if (or (< virtual-end (window-start))
2782 (pos-visible-in-window-p virtual-end))
7a53d8c8
EZ
2783 (cond
2784 (Info-scroll-prefer-subnodes (Info-next-preorder))
2785 ((Info-no-error (Info-goto-node (Info-extract-menu-counting 1))))
2786 (t (Info-next-preorder)))
0a56332b 2787 (scroll-up))))
253db917 2788
8aab8422
CY
2789(defun Info-mouse-scroll-up (e)
2790 "Scroll one screenful forward in Info, using the mouse.
2791See `Info-scroll-up'."
2792 (interactive "e")
2793 (save-selected-window
2794 (if (eventp e)
2795 (select-window (posn-window (event-start e))))
2796 (Info-scroll-up)))
2797
253db917 2798(defun Info-scroll-down ()
3f32dc86 2799 "Scroll one screenful back in Info, considering all nodes as one sequence.
c2def7a0
MB
2800If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
2801is non-nil, this goes to its last subnode. When you scroll past the
2802beginning of a node, that goes to the previous node or back up to the
2803parent node."
253db917 2804 (interactive)
0a56332b
RS
2805 (if (or (< (window-start) (point-min))
2806 (> (window-start) (point-max)))
2807 (set-window-start (selected-window) (point)))
760d5cb3
GM
2808 (let* ((case-fold-search t)
2809 (current-point (point))
c2def7a0
MB
2810 (virtual-end
2811 (and Info-scroll-prefer-subnodes
2812 (save-excursion
2813 (beginning-of-line)
2814 (setq current-point (point))
2815 (goto-char (point-min))
2816 (search-forward "\n* Menu:"
2817 current-point
2818 t)))))
3a8803c0 2819 (if (or virtual-end
7afe24e3 2820 (pos-visible-in-window-p (point-min) nil t))
0a56332b
RS
2821 (Info-last-preorder)
2822 (scroll-down))))
253db917 2823
8aab8422
CY
2824(defun Info-mouse-scroll-down (e)
2825 "Scroll one screenful backward in Info, using the mouse.
2826See `Info-scroll-down'."
2827 (interactive "e")
2828 (save-selected-window
2829 (if (eventp e)
2830 (select-window (posn-window (event-start e))))
2831 (Info-scroll-down)))
2832
56cda6f5 2833(defun Info-next-reference (&optional recur)
552775bd
RS
2834 "Move cursor to the next cross-reference or menu item in the node."
2835 (interactive)
4ba89826 2836 (let ((pat "\\*note[ \n\t]+\\([^:]+\\):\\|^\\* .*:\\|[hf]t?tps?://")
1bcedb3b
RS
2837 (old-pt (point))
2838 (case-fold-search t))
552775bd
RS
2839 (or (eobp) (forward-char 1))
2840 (or (re-search-forward pat nil t)
2841 (progn
2842 (goto-char (point-min))
2843 (or (re-search-forward pat nil t)
2844 (progn
2845 (goto-char old-pt)
2846 (error "No cross references in this node")))))
8a7757f6 2847 (goto-char (or (match-beginning 1) (match-beginning 0)))
552775bd 2848 (if (looking-at "\\* Menu:")
56cda6f5
RS
2849 (if recur
2850 (error "No cross references in this node")
185cff95
JL
2851 (Info-next-reference t))
2852 (if (looking-at "^\\* ")
2853 (forward-char 2)))))
552775bd 2854
56cda6f5 2855(defun Info-prev-reference (&optional recur)
552775bd
RS
2856 "Move cursor to the previous cross-reference or menu item in the node."
2857 (interactive)
4ba89826 2858 (let ((pat "\\*note[ \n\t]+\\([^:]+\\):\\|^\\* .*:\\|[hf]t?tps?://")
1bcedb3b
RS
2859 (old-pt (point))
2860 (case-fold-search t))
552775bd
RS
2861 (or (re-search-backward pat nil t)
2862 (progn
2863 (goto-char (point-max))
2864 (or (re-search-backward pat nil t)
2865 (progn
2866 (goto-char old-pt)
2867 (error "No cross references in this node")))))
8a7757f6 2868 (goto-char (or (match-beginning 1) (match-beginning 0)))
552775bd 2869 (if (looking-at "\\* Menu:")
56cda6f5
RS
2870 (if recur
2871 (error "No cross references in this node")
185cff95
JL
2872 (Info-prev-reference t))
2873 (if (looking-at "^\\* ")
2874 (forward-char 2)))))
141b49f5
JL
2875\f
2876(defvar Info-index-nodes nil
2877 "Alist of cached index node names of visited Info files.
2878Each element has the form (INFO-FILE INDEX-NODE-NAMES-LIST).")
2879
2880(defun Info-index-nodes (&optional file)
2881 "Return a list of names of all index nodes in Info FILE.
2882If FILE is omitted, it defaults to the current Info file.
50163b00
JL
2883First look in a list of cached index node names. Then scan Info
2884file and its subfiles for nodes with the index cookie. Then try
2885to find index nodes starting from the first node in the top level
2886menu whose name contains the word \"Index\", plus any immediately
2887following nodes whose names also contain the word \"Index\"."
141b49f5
JL
2888 (or file (setq file Info-current-file))
2889 (or (assoc file Info-index-nodes)
2890 ;; Skip virtual Info files
586f9284 2891 (and (or (not (stringp file))
6a013a49 2892 (Info-virtual-file-p file))
50163b00 2893 (setq Info-index-nodes (cons (cons file nil) Info-index-nodes)))
66fc722f 2894 (if (Info-file-supports-index-cookies file)
94b10022
JL
2895 ;; Find nodes with index cookie
2896 (let* ((default-directory (or (and (stringp file)
2897 (file-name-directory
2898 (setq file (Info-find-file file))))
2899 default-directory))
2900 Info-history Info-history-list Info-fontify-maximum-menu-size
c2a37b78 2901 (main-file file) subfiles nodes)
94b10022
JL
2902 (condition-case nil
2903 (with-temp-buffer
2904 (while (or main-file subfiles)
2905 (erase-buffer)
2906 (info-insert-file-contents (or main-file (car subfiles)))
2907 (goto-char (point-min))
2908 (while (search-forward "\0\b[index\0\b]" nil 'move)
2909 (save-excursion
2910 (re-search-backward "^\^_")
2911 (search-forward "Node: ")
2912 (setq nodes (cons (Info-following-node-name) nodes))))
2913 (if main-file
2914 (save-excursion
2915 (goto-char (point-min))
2916 (if (search-forward "\n\^_\nIndirect:" nil t)
2917 (let ((bound (save-excursion (search-forward "\n\^_" nil t))))
2918 (while (re-search-forward "^\\(.*\\): [0-9]+$" bound t)
2919 (setq subfiles (cons (match-string-no-properties 1)
2920 subfiles)))))
2921 (setq subfiles (nreverse subfiles)
2922 main-file nil))
2923 (setq subfiles (cdr subfiles)))))
2924 (error nil))
2925 (if nodes
2926 (setq nodes (nreverse nodes)
2927 Info-index-nodes (cons (cons file nodes) Info-index-nodes)))
2928 nodes)
2929 ;; Else find nodes with the word "Index" in the node name
2930 (let ((case-fold-search t)
66fc722f 2931 Info-history Info-history-list Info-fontify-maximum-menu-size Info-point-loc
94b10022
JL
2932 nodes node)
2933 (condition-case nil
2934 (with-temp-buffer
2935 (Info-mode)
2936 (Info-find-node file "Top")
2937 (when (and (search-forward "\n* menu:" nil t)
2938 (re-search-forward "\n\\* \\(.*\\<Index\\>\\)" nil t))
2939 (goto-char (match-beginning 1))
2940 (setq nodes (list (Info-extract-menu-node-name)))
2941 (Info-goto-node (car nodes))
2942 (while (and (setq node (Info-extract-pointer "next" t))
2943 (string-match "\\<Index\\>" node))
c2a37b78 2944 (push node nodes)
94b10022
JL
2945 (Info-goto-node node))))
2946 (error nil))
2947 (if nodes
2948 (setq nodes (nreverse nodes)
2949 Info-index-nodes (cons (cons file nodes) Info-index-nodes)))
2950 nodes))
50163b00
JL
2951 ;; If file has no index nodes, still add it to the cache
2952 (setq Info-index-nodes (cons (cons file nil) Info-index-nodes)))
141b49f5
JL
2953 (cdr (assoc file Info-index-nodes)))
2954
2955(defun Info-index-node (&optional node file)
2956 "Return non-nil value if NODE is an index node.
2957If NODE is nil, check the current Info node.
2958If FILE is nil, check the current Info file."
66fc722f 2959 (or file (setq file Info-current-file))
6a013a49
JL
2960 (if (and (or (and node (not (equal node Info-current-node)))
2961 (assoc file Info-index-nodes))
2962 (not Info-current-node-virtual))
50163b00
JL
2963 (member (or node Info-current-node) (Info-index-nodes file))
2964 ;; Don't search all index nodes if request is only for the current node
2965 ;; and file is not in the cache of index nodes
6a013a49
JL
2966 (save-match-data
2967 (if (Info-file-supports-index-cookies file)
2968 (save-excursion
2969 (goto-char (+ (or (save-excursion
2970 (search-backward "\n\^_" nil t))
2971 (point-min)) 2))
2972 (search-forward "\0\b[index\0\b]"
2973 (or (save-excursion
2974 (search-forward "\n\^_" nil t))
2975 (point-max)) t))
94b10022 2976 (string-match "\\<Index\\>" (or node Info-current-node ""))))))
552775bd 2977
e4e8ee63 2978(defun Info-goto-index ()
141b49f5
JL
2979 "Go to the first index node."
2980 (let ((node (car (Info-index-nodes))))
2981 (or node (error "No index"))
2982 (Info-goto-node node)))
e4e8ee63 2983
201bc1bd 2984;;;###autoload
1143a6b0 2985(defun Info-index (topic)
4a99f153 2986 "Look up a string TOPIC in the index for this manual and go to that entry.
1143a6b0
ER
2987If there are no exact matches to the specified topic, this chooses
2988the first match which is a case-insensitive substring of a topic.
89b064a9 2989Use the \\<Info-mode-map>\\[Info-index-next] command to see the other matches.
4a99f153 2990Give an empty topic name to go to the Index node itself."
e4e8ee63
SM
2991 (interactive
2992 (list
ea71ffe8
CY
2993 (let ((completion-ignore-case t)
2994 (Info-complete-menu-buffer (clone-buffer))
141b49f5
JL
2995 (Info-complete-nodes (Info-index-nodes))
2996 (Info-history-list nil))
aebd1760
RS
2997 (if (equal Info-current-file "dir")
2998 (error "The Info directory node has no index; use m to select a manual"))
e4e8ee63
SM
2999 (unwind-protect
3000 (with-current-buffer Info-complete-menu-buffer
3001 (Info-goto-index)
3002 (completing-read "Index topic: " 'Info-complete-menu-item))
3003 (kill-buffer Info-complete-menu-buffer)))))
aebd1760
RS
3004 (if (equal Info-current-file "dir")
3005 (error "The Info directory node has no index; use m to select a manual"))
03e8d958
KS
3006 ;; Strip leading colon in topic; index format does not allow them.
3007 (if (and (stringp topic)
3008 (> (length topic) 0)
3009 (= (aref topic 0) ?:))
3010 (setq topic (substring topic 1)))
1143a6b0 3011 (let ((orignode Info-current-node)
836bb478 3012 (pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]*\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
1143a6b0 3013 (regexp-quote topic)))
141b49f5
JL
3014 node (nodes (Info-index-nodes))
3015 (ohist-list Info-history-list)
1bcedb3b 3016 (case-fold-search t))
e700ec12 3017 (Info-goto-index)
1143a6b0
ER
3018 (or (equal topic "")
3019 (let ((matches nil)
3020 (exact nil)
e700ec12
SM
3021 ;; We bind Info-history to nil for internal node-switches so
3022 ;; that we don't put junk in the history. In the first
3023 ;; Info-goto-index call, above, we do update the history
3024 ;; because that is what the user's previous node choice into it.
c696ac76 3025 (Info-history nil)
1143a6b0
ER
3026 found)
3027 (while
3028 (progn
3029 (goto-char (point-min))
3030 (while (re-search-forward pattern nil t)
983dfbf8
SM
3031 (push (list (match-string-no-properties 1)
3032 (match-string-no-properties 2)
3033 Info-current-node
3a8803c0
JPW
3034 (string-to-number (concat "0"
3035 (match-string 3))))
983dfbf8 3036 matches))
141b49f5 3037 (setq nodes (cdr nodes) node (car nodes)))
1143a6b0
ER
3038 (Info-goto-node node))
3039 (or matches
3040 (progn
81e14cb2 3041 (Info-goto-node orignode)
920bdaab 3042 (error "No `%s' in index" topic)))
1143a6b0
ER
3043 ;; Here it is a feature that assoc is case-sensitive.
3044 (while (setq found (assoc topic matches))
3045 (setq exact (cons found exact)
3046 matches (delq found matches)))
141b49f5 3047 (setq Info-history-list ohist-list)
1143a6b0
ER
3048 (setq Info-index-alternatives (nconc exact (nreverse matches)))
3049 (Info-index-next 0)))))
3050
3051(defun Info-index-next (num)
89b064a9 3052 "Go to the next matching index item from the last \\<Info-mode-map>\\[Info-index] command."
1143a6b0
ER
3053 (interactive "p")
3054 (or Info-index-alternatives
882e61bf 3055 (error "No previous `i' command"))
1143a6b0
ER
3056 (while (< num 0)
3057 (setq num (+ num (length Info-index-alternatives))))
3058 (while (> num 0)
3059 (setq Info-index-alternatives
3060 (nconc (cdr Info-index-alternatives)
3061 (list (car Info-index-alternatives)))
3062 num (1- num)))
3063 (Info-goto-node (nth 1 (car Info-index-alternatives)))
3064 (if (> (nth 3 (car Info-index-alternatives)) 0)
3bc71084
JL
3065 ;; Forward 2 lines less because `Info-find-node-2' initially
3066 ;; puts point to the 2nd line.
7187cdae 3067 (forward-line (- (nth 3 (car Info-index-alternatives)) 2))
760d5cb3 3068 (forward-line 3) ; don't search in headers
1143a6b0 3069 (let ((name (car (car Info-index-alternatives))))
920bdaab
RS
3070 (Info-find-index-name name)))
3071 (message "Found `%s' in %s. %s"
1143a6b0
ER
3072 (car (car Info-index-alternatives))
3073 (nth 2 (car Info-index-alternatives))
3074 (if (cdr Info-index-alternatives)
fa62821e
EZ
3075 (format "(%s total; use `%s' for next)"
3076 (length Info-index-alternatives)
3077 (key-description (where-is-internal
3078 'Info-index-next overriding-local-map
3079 t)))
1143a6b0
ER
3080 "(Only match)")))
3081
920bdaab
RS
3082(defun Info-find-index-name (name)
3083 "Move point to the place within the current node where NAME is defined."
1bcedb3b
RS
3084 (let ((case-fold-search t))
3085 (if (or (re-search-forward (format
3086 "[a-zA-Z]+: %s\\( \\|$\\)"
3087 (regexp-quote name)) nil t)
d31c6ecf
RS
3088 ;; Find a function definition with a return type.
3089 (re-search-forward (format
f2fc5b0a 3090 "[a-zA-Z]+: [a-zA-Z0-9_ *&]+ %s\\( \\|$\\)"
d31c6ecf 3091 (regexp-quote name)) nil t)
1bcedb3b
RS
3092 (search-forward (format "`%s'" name) nil t)
3093 (and (string-match "\\`.*\\( (.*)\\)\\'" name)
3094 (search-forward
3095 (format "`%s'" (substring name 0 (match-beginning 1)))
3096 nil t))
bbe054f7
EZ
3097 (search-forward name nil t)
3098 ;; Try again without the " <1>" makeinfo can append
3099 (and (string-match "\\`\\(.*\\) <[0-9]+>\\'" name)
3100 (Info-find-index-name (match-string 1 name))))
3101 (progn (beginning-of-line) t) ;; non-nil for recursive call
1bcedb3b 3102 (goto-char (point-min)))))
6a013a49
JL
3103\f
3104(add-to-list 'Info-virtual-nodes
3105 '("\\`\\*Index.*\\*\\'"
3106 (find-node . Info-virtual-index-find-node)
3107 ))
3108
3109(defvar Info-virtual-index-nodes nil
3110 "Alist of cached matched index search nodes.
3111Each element is ((FILENAME . TOPIC) MATCHES) where
3112FILENAME is the file name of the manual,
3113TOPIC is the search string given as an argument to `Info-virtual-index',
3114MATCHES is a list of index matches found by `Info-index'.")
3115
3116(defun Info-virtual-index-find-node (filename nodename &optional no-going-back)
3117 "Index-specific implementation of Info-find-node-2."
3118 ;; Generate Index-like menu of matches
3119 (if (string-match "^\\*Index for `\\(.+\\)'\\*$" nodename)
3120 ;; Generate Index-like menu of matches
3121 (let* ((topic (match-string 1 nodename))
3122 (matches (cdr (assoc (cons (or filename Info-current-file) topic)
3123 Info-virtual-index-nodes))))
3124 (insert (format "\n\^_\nFile: %s, Node: %s, Up: *Index*\n\n"
3125 (or filename Info-current-file) nodename))
3126 (insert "Info Virtual Index\n")
3127 (insert "******************\n\n")
3128 (insert "Index entries that match `" topic "':\n\n")
3129 (insert "\0\b[index\0\b]\n")
3130 (if (null matches)
3131 (insert "No matches found.\n")
3132 (insert "* Menu:\n\n")
3133 (dolist (entry matches)
3134 (insert (format "* %-38s %s.%s\n"
3135 (format "%s [%s]:" (nth 0 entry) (nth 2 entry))
3136 (nth 1 entry)
3137 (if (nth 3 entry)
3138 (format " (line %s)" (nth 3 entry))
3139 ""))))))
3140 ;; Else, Generate a list of previous search results
3141 (let ((nodes (reverse Info-virtual-index-nodes)))
3142 (insert (format "\n\^_\nFile: %s, Node: %s, Up: Top\n\n"
3143 (or filename Info-current-file) nodename))
3144 (insert "Info Virtual Index\n")
3145 (insert "******************\n\n")
3146 (insert "This is a list of search results produced by\n"
3147 "`Info-virtual-index' for the current manual.\n\n")
3148 (insert "* Menu:\n\n")
3149 (dolist (nodeinfo nodes)
3150 (when (equal (car (nth 0 nodeinfo)) (or filename Info-current-file))
3151 (insert
3152 (format "* %-20s %s.\n"
3153 (format "*Index for `%s'*::" (cdr (nth 0 nodeinfo)))
3154 (cdr (nth 0 nodeinfo)))))))))
3155
3156(defun Info-virtual-index (topic)
3157 "Show a node with all lines in the index containing a string TOPIC.
3158Like `Info-index' but displays a node with index search results.
3159Give an empty topic name to go to the node with links to previous
3160search results."
3161 ;; `interactive' is a copy from `Info-index'
3162 (interactive
3163 (list
3164 (let ((completion-ignore-case t)
3165 (Info-complete-menu-buffer (clone-buffer))
3166 (Info-complete-nodes (Info-index-nodes))
3167 (Info-history-list nil))
3168 (if (equal Info-current-file "dir")
3169 (error "The Info directory node has no index; use m to select a manual"))
3170 (unwind-protect
3171 (with-current-buffer Info-complete-menu-buffer
3172 (Info-goto-index)
3173 (completing-read "Index topic: " 'Info-complete-menu-item))
3174 (kill-buffer Info-complete-menu-buffer)))))
3175 (if (equal topic "")
3176 (Info-find-node Info-current-file "*Index*")
3177 (unless (assoc (cons Info-current-file topic) Info-virtual-index-nodes)
3178 (let ((orignode Info-current-node)
3179 (ohist-list Info-history-list)
3180 nodename)
3181 ;; Reuse `Info-index' to set `Info-index-alternatives'.
3182 (Info-index topic)
3183 (push (cons (cons Info-current-file topic) Info-index-alternatives)
3184 Info-virtual-index-nodes)
3185 ;; Clean up unneccessary side-effects of `Info-index'.
3186 (setq Info-history-list ohist-list)
3187 (Info-goto-node orignode)
3188 (message "")))
3189 (Info-find-node Info-current-file (format "*Index for `%s'*" topic))))
3190\f
3191(add-to-list 'Info-virtual-files
3192 '("\\`\\*Apropos\\*\\'"
3193 (toc-nodes . Info-apropos-toc-nodes)
3194 (find-file . Info-apropos-find-file)
3195 (find-node . Info-apropos-find-node)
3196 ))
3197
3198(defvar Info-apropos-file "*Apropos*"
3199 "Info file name of the virtual manual for matches of `info-apropos'.")
3200
3201(defvar Info-apropos-nodes nil
3202 "Alist of cached apropos matched nodes.
3203Each element is (NODENAME STRING MATCHES) where
3204NODENAME is the name of the node that holds the search result,
3205STRING is the search string given as an argument to `info-apropos',
3206MATCHES is a list of index matches found by `Info-apropos-matches'.")
3207
3208(defun Info-apropos-toc-nodes (filename)
3209 "Apropos-specific implementation of Info-apropos-toc-nodes."
3210 (let ((nodes (mapcar 'car (reverse Info-apropos-nodes))))
3211 `(,filename
3212 ("Top" nil nil ,nodes)
3213 ,@(mapcar (lambda (node) `(,node "Top" nil nil)) nodes))))
3214
3215(defun Info-apropos-find-file (filename &optional noerror)
3216 "Apropos-specific implementation of Info-find-file."
3217 filename)
3218
3219(defun Info-apropos-find-node (filename nodename &optional no-going-back)
3220 "Apropos-specific implementation of Info-find-node-2."
3221 (if (equal nodename "Top")
3222 ;; Generate Top menu
3223 (let ((nodes (reverse Info-apropos-nodes)))
3224 (insert (format "\n\^_\nFile: %s, Node: %s, Up: (dir)\n\n"
3225 Info-apropos-file nodename))
3226 (insert "Apropos Index\n")
3227 (insert "*************\n\n")
3228 (insert "This is a list of search results produced by `info-apropos'.\n\n")
3229 (insert "* Menu:\n\n")
3230 (dolist (nodeinfo nodes)
3231 (insert (format "* %-20s %s.\n"
3232 (format "%s::" (nth 0 nodeinfo))
3233 (nth 1 nodeinfo)))))
3234 ;; Else, Generate Index-like menu of matches
3235 (let* ((nodeinfo (assoc nodename Info-apropos-nodes))
3236 (matches (nth 2 nodeinfo)))
3237 (when matches
3238 (insert (format "\n\^_\nFile: %s, Node: %s, Up: Top\n\n"
3239 Info-apropos-file nodename))
3240 (insert "Apropos Index\n")
3241 (insert "*************\n\n")
3242 (insert "Index entries that match `" (nth 1 nodeinfo) "':\n\n")
3243 (insert "\0\b[index\0\b]\n")
3244 (if (eq matches t)
3245 (insert "No matches found.\n")
3246 (insert "* Menu:\n\n")
3247 (dolist (entry matches)
3248 (insert (format "* %-38s (%s)%s.%s\n"
3249 (format "%s [%s]:" (nth 1 entry) (nth 0 entry))
3250 (nth 0 entry)
3251 (nth 2 entry)
3252 (if (nth 3 entry)
3253 (format " (line %s)" (nth 3 entry))
3254 "")))))))))
3255
3256(defun Info-apropos-matches (string)
3257 "Collect STRING matches from all known Info files on your system.
3258Return a list of matches where each element is in the format
3259\((FILENAME INDEXTEXT NODENAME LINENUMBER))."
ab2f22ad
JH
3260 (interactive "sIndex apropos: ")
3261 (unless (string= string "")
836bb478 3262 (let ((pattern (format "\n\\* +\\([^\n]*%s[^\n]*\\):[ \t]+\\([^\n]+\\)\\.\\(?:[ \t\n]*(line +\\([0-9]+\\))\\)?"
ab2f22ad
JH
3263 (regexp-quote string)))
3264 (ohist Info-history)
37600b6d 3265 (ohist-list Info-history-list)
ab2f22ad
JH
3266 (current-node Info-current-node)
3267 (current-file Info-current-file)
141b49f5
JL
3268 manuals matches node nodes)
3269 (let ((Info-fontify-maximum-menu-size nil))
ab2f22ad 3270 (Info-directory)
59ad6ae5
EZ
3271 ;; current-node and current-file are nil when they invoke info-apropos
3272 ;; as the first Info command, i.e. info-apropos loads info.el. In that
3273 ;; case, we use (DIR)Top instead, to avoid signalling an error after
3274 ;; the search is complete.
3275 (when (null current-node)
3276 (setq current-file Info-current-file)
3277 (setq current-node Info-current-node))
ab2f22ad
JH
3278 (message "Searching indices...")
3279 (goto-char (point-min))
3280 (re-search-forward "\\* Menu: *\n" nil t)
7b30b20c 3281 (while (re-search-forward "\\*.*: *(\\([^)]+\\))" nil t)
9ef5b432
EZ
3282 ;; add-to-list makes sure we don't have duplicates in `manuals',
3283 ;; so that the following dolist loop runs faster.
3284 (add-to-list 'manuals (match-string 1)))
185cff95 3285 (dolist (manual (nreverse manuals))
ab2f22ad 3286 (message "Searching %s" manual)
185cff95
JL
3287 (condition-case err
3288 (if (setq nodes (Info-index-nodes (Info-find-file manual)))
141b49f5
JL
3289 (save-excursion
3290 (Info-find-node manual (car nodes))
3291 (while
3292 (progn
3293 (goto-char (point-min))
3294 (while (re-search-forward pattern nil t)
185cff95
JL
3295 (setq matches
3296 (cons (list manual
3297 (match-string-no-properties 1)
3298 (match-string-no-properties 2)
3299 (match-string-no-properties 3))
3300 matches)))
141b49f5 3301 (setq nodes (cdr nodes) node (car nodes)))
185cff95
JL
3302 (Info-goto-node node))))
3303 (error
3304 (message "%s" (if (eq (car-safe err) 'error)
3305 (nth 1 err) err))
3306 (sit-for 1 t)))))
bec275ed 3307 (Info-find-node current-file current-node)
37600b6d
JH
3308 (setq Info-history ohist
3309 Info-history-list ohist-list)
ab2f22ad 3310 (message "Searching indices...done")
6a013a49 3311 (or (nreverse matches) t))))
ab2f22ad 3312
6a013a49
JL
3313;;;###autoload
3314(defun info-apropos (string)
3315 "Grovel indices of all known Info files on your system for STRING.
3316Build a menu of the possible matches."
3317 (interactive "sIndex apropos: ")
3318 (if (equal string "")
3319 (Info-find-node Info-apropos-file "Top")
3320 (let* ((nodes Info-apropos-nodes) nodename)
3321 (while (and nodes (not (equal string (nth 1 (car nodes)))))
3322 (setq nodes (cdr nodes)))
3323 (if nodes
3324 (Info-find-node Info-apropos-file (car (car nodes)))
3325 (setq nodename (format "Index for `%s'" string))
3326 (push (list nodename string (Info-apropos-matches string))
3327 Info-apropos-nodes)
3328 (Info-find-node Info-apropos-file nodename)))))
3329\f
fcdd8562
JL
3330(add-to-list 'Info-virtual-files
3331 '("\\`\\*Finder.*\\*\\'"
3332 (find-file . Info-finder-find-file)
3333 (find-node . Info-finder-find-node)
3334 ))
3335
3336(defvar Info-finder-file "*Finder*"
3337 "Info file name of the virtual Info keyword finder manual.")
3338
3339(defun Info-finder-find-file (filename &optional noerror)
3340 "Finder-specific implementation of Info-find-file."
3341 filename)
3342
3343(defvar finder-known-keywords)
3344(defvar finder-package-info)
3345(declare-function find-library-name "find-func" (library))
57938a79 3346(declare-function finder-unknown-keywords "finder" ())
fcdd8562
JL
3347(declare-function lm-commentary "lisp-mnt" (&optional file))
3348
3349(defun Info-finder-find-node (filename nodename &optional no-going-back)
3350 "Finder-specific implementation of Info-find-node-2."
3351 (cond
3352 ((equal nodename "Top")
3353 ;; Display Top menu with descriptions of the keywords
3354 (insert (format "\n\^_\nFile: %s, Node: %s, Up: (dir)\n\n"
3355 Info-finder-file nodename))
3356 (insert "Finder Keywords\n")
3357 (insert "***************\n\n")
3358 (insert "* Menu:\n\n")
3359 (mapc
3360 (lambda (assoc)
3361 (let ((keyword (car assoc)))
3362 (insert (format "* %-14s %s.\n"
3363 (concat (symbol-name keyword) "::")
3364 (cdr assoc)))))
57938a79
JL
3365 (cons '(unknown . "unknown keywords")
3366 finder-known-keywords)))
3367 ((equal nodename "unknown")
3368 ;; Display unknown keywords
3369 (insert (format "\n\^_\nFile: %s, Node: %s, Up: Top\n\n"
3370 Info-finder-file nodename))
3371 (insert "Finder Unknown Keywords\n")
3372 (insert "***********************\n\n")
3373 (insert "* Menu:\n\n")
3374 (mapc
3375 (lambda (assoc)
3376 (insert (format "* %-14s %s.\n"
3377 (concat (symbol-name (car assoc)) "::")
3378 (cdr assoc))))
3379 (finder-unknown-keywords)))
fcdd8562
JL
3380 ((string-match-p "\\.el\\'" nodename)
3381 ;; Display commentary section
3382 (insert (format "\n\^_\nFile: %s, Node: %s, Up: Top\n\n"
3383 Info-finder-file nodename))
3384 (insert "Finder Commentary\n")
3385 (insert "*****************\n\n")
3386 (insert
3387 "Commentary section of the package `" nodename "':\n\n")
3388 (let ((str (lm-commentary (find-library-name nodename))))
3389 (if (null str)
3390 (insert "Can't find any Commentary section\n\n")
3391 (insert
3392 (with-temp-buffer
3393 (insert str)
3394 (goto-char (point-min))
3395 (delete-blank-lines)
3396 (goto-char (point-max))
3397 (delete-blank-lines)
3398 (goto-char (point-min))
3399 (while (re-search-forward "^;+ ?" nil t)
3400 (replace-match "" nil nil))
3401 (buffer-string))))))
3402 (t
3403 ;; Display packages that match the keyword
3404 (insert (format "\n\^_\nFile: %s, Node: %s, Up: Top\n\n"
3405 Info-finder-file nodename))
3406 (insert "Finder Packages\n")
3407 (insert "***************\n\n")
3408 (insert
3409 "The following packages match the keyword `" nodename "':\n\n")
3410 (insert "* Menu:\n\n")
3411 (let ((id (intern nodename)))
3412 (mapc
3413 (lambda (x)
3414 (when (memq id (cadr (cdr x)))
3415 (insert (format "* %-16s %s.\n"
3416 (concat (car x) "::")
3417 (cadr x)))))
3418 finder-package-info)))))
3419
3420;;;###autoload
3421(defun info-finder ()
3422 "Display descriptions of the keywords in the Finder virtual manual."
3423 (interactive)
3424 (require 'finder)
3425 (Info-find-node Info-finder-file "Top"))
3426\f
a384cab3
JB
3427(defun Info-undefined ()
3428 "Make command be undefined in Info."
3429 (interactive)
3430 (ding))
3431
3432(defun Info-help ()
3433 "Enter the Info tutorial."
3434 (interactive)
3435 (delete-other-windows)
3436 (Info-find-node "info"
3437 (if (< (window-height) 23)
3438 "Help-Small-Screen"
3439 "Help")))
3440
3441(defun Info-summary ()
3442 "Display a brief summary of all Info commands."
3443 (interactive)
3444 (save-window-excursion
3445 (switch-to-buffer "*Help*")
881c84c7 3446 (setq buffer-read-only nil)
a384cab3
JB
3447 (erase-buffer)
3448 (insert (documentation 'Info-mode))
9d29f94c 3449 (help-mode)
a384cab3
JB
3450 (goto-char (point-min))
3451 (let (ch flag)
3452 (while (progn (setq flag (not (pos-visible-in-window-p (point-max))))
3453 (message (if flag "Type Space to see more"
3454 "Type Space to return to Info"))
fc039bdc 3455 (if (not (eq ?\s (setq ch (read-event))))
dbc4e1c1 3456 (progn (setq unread-command-events (list ch)) nil)
a384cab3 3457 flag))
552775bd
RS
3458 (scroll-up)))
3459 (bury-buffer "*Help*")))
a384cab3
JB
3460\f
3461(defun Info-get-token (pos start all &optional errorstring)
fdf4b680 3462 "Return the token around POS.
a384cab3
JB
3463POS must be somewhere inside the token
3464START is a regular expression which will match the
3465 beginning of the tokens delimited string
3466ALL is a regular expression with a single
90a715f0 3467 parenthesized subpattern which is the token to be
fdf4b680 3468 returned. E.g. '{\(.*\)}' would return any string
a384cab3 3469 enclosed in braces around POS.
fdf4b680 3470ERRORSTRING optional fourth argument, controls action on no match
a384cab3
JB
3471 nil: return nil
3472 t: beep
3473 a string: signal an error, using that string."
1bcedb3b
RS
3474 (let ((case-fold-search t))
3475 (save-excursion
3476 (goto-char pos)
3477 ;; First look for a match for START that goes across POS.
3478 (while (and (not (bobp)) (> (point) (- pos (length start)))
3479 (not (looking-at start)))
3480 (forward-char -1))
3481 ;; If we did not find one, search back for START
3482 ;; (this finds only matches that end at or before POS).
3483 (or (looking-at start)
3484 (progn
3485 (goto-char pos)
3486 (re-search-backward start (max (point-min) (- pos 200)) 'yes)))
3487 (let (found)
3488 (while (and (re-search-forward all (min (point-max) (+ pos 200)) 'yes)
3489 (not (setq found (and (<= (match-beginning 0) pos)
3490 (> (match-end 0) pos))))))
3491 (if (and found (<= (match-beginning 0) pos)
3492 (> (match-end 0) pos))
110d4e80 3493 (match-string-no-properties 1)
1bcedb3b
RS
3494 (cond ((null errorstring)
3495 nil)
3496 ((eq errorstring t)
3497 (beep)
3498 nil)
3499 (t
3500 (error "No %s around position %d" errorstring pos))))))))
a384cab3 3501
981947af 3502(defun Info-mouse-follow-nearest-node (click)
f9969361
RS
3503 "\\<Info-mode-map>Follow a node reference near point.
3504Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
981947af 3505At end of the node's text, moves to the next node, or up if none."
f9969361 3506 (interactive "e")
d1268e52 3507 (mouse-set-point click)
e2469835 3508 (and (not (Info-follow-nearest-node))
981947af 3509 (save-excursion (forward-line 1) (eobp))
ed690657 3510 (Info-next-preorder)))
981947af 3511
8a7757f6 3512(defun Info-follow-nearest-node (&optional fork)
d0b560c6
JB
3513 "Follow a node reference near point.
3514If point is on a reference, follow that reference. Otherwise,
04d6dfe2
R
3515if point is in a menu item description, follow that menu item.
3516
6716bfa4 3517If FORK is non-nil (interactively with a prefix arg), show the node in
04d6dfe2 3518a new Info buffer.
6716bfa4 3519If FORK is a string, it is the name to use for the new buffer."
8a7757f6
JL
3520 (interactive "P")
3521 (or (Info-try-follow-nearest-node fork)
d0b560c6
JB
3522 (when (save-excursion
3523 (search-backward "\n* menu:" nil t))
3524 (save-excursion
3525 (beginning-of-line)
3526 (while (not (or (bobp) (looking-at "[^ \t]\\|[ \t]*$")))
3527 (beginning-of-line 0))
3528 (when (looking-at "\\* +\\([^\t\n]*\\):")
3529 (Info-goto-node
8a7757f6 3530 (Info-extract-menu-item (match-string-no-properties 1)) fork)
d0b560c6 3531 t)))
2cf7c3d1
MR
3532 (and (eq this-command 'Info-mouse-follow-nearest-node)
3533 ;; Don't raise an error when mouse-1 is bound to this - it's
3534 ;; often used to simply select the window or frame.
3535 (eq 'mouse-1 (event-basic-type last-input-event)))
d0b560c6 3536 (error "Point neither on reference nor in menu item description")))
981947af
KH
3537
3538;; Common subroutine.
8a7757f6 3539(defun Info-try-follow-nearest-node (&optional fork)
8aed3f67 3540 "Follow a node reference near point. Return non-nil if successful.
7d1ac206 3541If FORK is non-nil, it is passed to `Info-goto-node'."
6af7040d 3542 (let (node)
a384cab3 3543 (cond
baa7f3de
JB
3544 ((setq node (Info-get-token (point) "[hf]t?tps?://"
3545 "\\([hf]t?tps?://[^ \t\n\"`({<>})']+\\)"))
3546 (browse-url node)
3547 (setq node t))
8a7757f6
JL
3548 ((setq node (Info-get-token (point) "\\*note[ \n\t]+"
3549 "\\*note[ \n\t]+\\([^:]*\\):\\(:\\|[ \n\t]*(\\)?"))
8a7757f6 3550 (Info-follow-reference node fork))
505b68d5 3551 ;; menu item: node name
b37daea4 3552 ((setq node (Info-get-token (point) "\\* +" "\\* +\\([^:]*\\)::"))
8a7757f6 3553 (Info-goto-node node fork))
836bb478 3554 ;; menu item: node name or index entry
505b68d5 3555 ((Info-get-token (point) "\\* +" "\\* +\\(.*\\): ")
631ba13e
RS
3556 (beginning-of-line)
3557 (forward-char 2)
141b49f5 3558 (setq node (Info-extract-menu-node-name nil (Info-index-node)))
8a7757f6 3559 (Info-goto-node node fork))
bc2ada62 3560 ((setq node (Info-get-token (point) "Up: " "Up: \\([^,\n\t]*\\)"))
8a7757f6 3561 (Info-goto-node node fork))
bc2ada62 3562 ((setq node (Info-get-token (point) "Next: " "Next: \\([^,\n\t]*\\)"))
8a7757f6 3563 (Info-goto-node node fork))
bc2ada62 3564 ((setq node (Info-get-token (point) "File: " "File: \\([^,\n\t]*\\)"))
8a7757f6 3565 (Info-goto-node "Top" fork))
bc2ada62 3566 ((setq node (Info-get-token (point) "Prev: " "Prev: \\([^,\n\t]*\\)"))
8a7757f6 3567 (Info-goto-node node fork)))
981947af 3568 node))
a384cab3 3569\f
fdeb777a
SM
3570(defvar Info-mode-map
3571 (let ((map (make-keymap)))
3572 (suppress-keymap map)
3573 (define-key map "." 'beginning-of-buffer)
3574 (define-key map " " 'Info-scroll-up)
3575 (define-key map "\C-m" 'Info-follow-nearest-node)
3576 (define-key map "\t" 'Info-next-reference)
3577 (define-key map "\e\t" 'Info-prev-reference)
3578 (define-key map [(shift tab)] 'Info-prev-reference)
3579 (define-key map [backtab] 'Info-prev-reference)
3580 (define-key map "1" 'Info-nth-menu-item)
3581 (define-key map "2" 'Info-nth-menu-item)
3582 (define-key map "3" 'Info-nth-menu-item)
3583 (define-key map "4" 'Info-nth-menu-item)
3584 (define-key map "5" 'Info-nth-menu-item)
3585 (define-key map "6" 'Info-nth-menu-item)
3586 (define-key map "7" 'Info-nth-menu-item)
3587 (define-key map "8" 'Info-nth-menu-item)
3588 (define-key map "9" 'Info-nth-menu-item)
3589 (define-key map "0" 'undefined)
3590 (define-key map "?" 'Info-summary)
3591 (define-key map "]" 'Info-forward-node)
3592 (define-key map "[" 'Info-backward-node)
3593 (define-key map "<" 'Info-top-node)
3594 (define-key map ">" 'Info-final-node)
3595 (define-key map "b" 'beginning-of-buffer)
3596 (define-key map "d" 'Info-directory)
3597 (define-key map "e" 'Info-edit)
3598 (define-key map "f" 'Info-follow-reference)
3599 (define-key map "g" 'Info-goto-node)
3600 (define-key map "h" 'Info-help)
3601 (define-key map "i" 'Info-index)
6a013a49 3602 (define-key map "I" 'Info-virtual-index)
fdeb777a
SM
3603 (define-key map "l" 'Info-history-back)
3604 (define-key map "L" 'Info-history)
3605 (define-key map "m" 'Info-menu)
3606 (define-key map "n" 'Info-next)
3607 (define-key map "p" 'Info-prev)
3608 (define-key map "q" 'Info-exit)
3609 (define-key map "r" 'Info-history-forward)
3610 (define-key map "s" 'Info-search)
3611 (define-key map "S" 'Info-search-case-sensitively)
fdeb777a
SM
3612 (define-key map "\M-n" 'clone-buffer)
3613 (define-key map "t" 'Info-top-node)
3614 (define-key map "T" 'Info-toc)
3615 (define-key map "u" 'Info-up)
3616 ;; `w' for consistency with `dired-copy-filename-as-kill'.
3617 (define-key map "w" 'Info-copy-current-node-name)
3618 (define-key map "c" 'Info-copy-current-node-name)
3619 ;; `^' for consistency with `dired-up-directory'.
3620 (define-key map "^" 'Info-up)
3621 (define-key map "," 'Info-index-next)
3622 (define-key map "\177" 'Info-scroll-down)
3623 (define-key map [mouse-2] 'Info-mouse-follow-nearest-node)
3624 (define-key map [follow-link] 'mouse-face)
3625 map)
a384cab3 3626 "Keymap containing Info commands.")
fdeb777a 3627
75a209d4
RS
3628
3629(defun Info-check-pointer (item)
fdf4b680 3630 "Non-nil if ITEM is present in this node."
75a209d4
RS
3631 (condition-case nil
3632 (Info-extract-pointer item)
3633 (error nil)))
3634
d4af987a
DL
3635(easy-menu-define
3636 Info-mode-menu Info-mode-map
185cff95 3637 "Menu for Info files."
d4af987a
DL
3638 '("Info"
3639 ["Up" Info-up :active (Info-check-pointer "up")
3640 :help "Go up in the Info tree"]
3641 ["Next" Info-next :active (Info-check-pointer "next")
3642 :help "Go to the next node"]
3643 ["Previous" Info-prev :active (Info-check-pointer "prev[ious]*")
3644 :help "Go to the previous node"]
3645 ["Backward" Info-backward-node
3646 :help "Go backward one node, considering all as a sequence"]
3647 ["Forward" Info-forward-node
3648 :help "Go forward one node, considering all as a sequence"]
7210b6f5
DL
3649 ["Beginning" beginning-of-buffer
3650 :help "Go to beginning of this node"]
d4af987a
DL
3651 ["Top" Info-top-node
3652 :help "Go to top node of file"]
3653 ["Final Node" Info-final-node
3654 :help "Go to final node in this file"]
3655 ("Menu Item" ["You should never see this" report-emacs-bug t])
3656 ("Reference" ["You should never see this" report-emacs-bug t])
3657 ["Search..." Info-search
3658 :help "Search for regular expression in this Info file"]
8a7757f6
JL
3659 ["Search Next" Info-search-next
3660 :help "Search for another occurrence of regular expression"]
d1268e52 3661 ["Go to Node..." Info-goto-node
d4af987a 3662 :help "Go to a named node"]
424b9d3e
JL
3663 ["Back in history" Info-history-back :active Info-history
3664 :help "Go back in history to the last node you were at"]
3665 ["Forward in history" Info-history-forward :active Info-history-forward
3666 :help "Go forward in history"]
8a7757f6 3667 ["History" Info-history :active Info-history-list
bc224645 3668 :help "Go to menu of visited nodes"]
8a7757f6 3669 ["Table of Contents" Info-toc
bc224645 3670 :help "Go to table of contents"]
5938202c
JL
3671 ("Index"
3672 ["Lookup a String..." Info-index
d4af987a 3673 :help "Look for a string in the index items"]
5938202c 3674 ["Next Matching Item" Info-index-next :active Info-index-alternatives
ab2f22ad 3675 :help "Look for another occurrence of previous item"]
30760c8b
JL
3676 ["Lookup a string and display index of results..." Info-virtual-index
3677 :help "Look for a string in the index items and display node with results"]
5938202c 3678 ["Lookup a string in all indices..." info-apropos
ab2f22ad 3679 :help "Look for a string in the indices of all manuals"])
126f5d4d
MB
3680 ["Copy Node Name" Info-copy-current-node-name
3681 :help "Copy the name of the current node into the kill ring"]
8a7757f6
JL
3682 ["Clone Info buffer" clone-buffer
3683 :help "Create a twin copy of the current Info buffer."]
ec03f31e 3684 ["Exit" Info-exit :help "Stop reading Info"]))
75a209d4 3685
7210b6f5
DL
3686
3687(defvar info-tool-bar-map
b88e7560
CY
3688 (let ((map (make-sparse-keymap)))
3689 (tool-bar-local-item-from-menu 'Info-history-back "left-arrow" map Info-mode-map
3690 :rtl "right-arrow")
3691 (tool-bar-local-item-from-menu 'Info-history-forward "right-arrow" map Info-mode-map
3692 :rtl "left-arrow")
3693 (tool-bar-local-item-from-menu 'Info-prev "prev-node" map Info-mode-map
3694 :rtl "next-node")
3695 (tool-bar-local-item-from-menu 'Info-next "next-node" map Info-mode-map
3696 :rtl "prev-node")
3697 (tool-bar-local-item-from-menu 'Info-up "up-node" map Info-mode-map)
3698 (tool-bar-local-item-from-menu 'Info-top-node "home" map Info-mode-map)
3699 (tool-bar-local-item-from-menu 'Info-goto-node "jump-to" map Info-mode-map)
3700 (tool-bar-local-item-from-menu 'Info-index "index" map Info-mode-map)
3701 (tool-bar-local-item-from-menu 'Info-search "search" map Info-mode-map)
3702 (tool-bar-local-item-from-menu 'Info-exit "exit" map Info-mode-map)
3703 map))
7210b6f5 3704
75a209d4
RS
3705(defvar Info-menu-last-node nil)
3706;; Last node the menu was created for.
6d2c8e3e 3707;; Value is a list, (FILE-NAME NODE-NAME).
75a209d4
RS
3708
3709(defun Info-menu-update ()
fdf4b680 3710 "Update the Info menu for the current node."
75a209d4
RS
3711 (condition-case nil
3712 (if (or (not (eq major-mode 'Info-mode))
6d2c8e3e
RS
3713 (equal (list Info-current-file Info-current-node)
3714 Info-menu-last-node))
75a209d4
RS
3715 ()
3716 ;; Update menu menu.
3717 (let* ((Info-complete-menu-buffer (current-buffer))
3718 (items (nreverse (condition-case nil
e4e8ee63 3719 (Info-complete-menu-item "" nil t)
75a209d4 3720 (error nil))))
399c88ad 3721 entries current
75a209d4
RS
3722 (number 0))
3723 (while (and items (< number 9))
3724 (setq current (car items)
3725 items (cdr items)
3726 number (1+ number))
399c88ad 3727 (setq entries (cons `[,current
75a209d4
RS
3728 (Info-menu ,current)
3729 :keys ,(format "%d" number)]
3730 entries)))
3731 (if items
3732 (setq entries (cons ["Other..." Info-menu t] entries)))
3733 (or entries
5d5845dc 3734 (setq entries (list ["No menu" nil nil] nil :active)))
d4af987a 3735 (easy-menu-change '("Info") "Menu Item" (nreverse entries)))
75a209d4
RS
3736 ;; Update reference menu. Code stolen from `Info-follow-reference'.
3737 (let ((items nil)
399c88ad 3738 str i entries current
1bcedb3b
RS
3739 (number 0)
3740 (case-fold-search t))
75a209d4
RS
3741 (save-excursion
3742 (goto-char (point-min))
8a7757f6 3743 (while (re-search-forward "\\*note[ \n\t]+\\([^:]*\\):" nil t)
c60c12be 3744 (setq str (match-string 1))
75a209d4
RS
3745 (setq i 0)
3746 (while (setq i (string-match "[ \n\t]+" str i))
3747 (setq str (concat (substring str 0 i) " "
3748 (substring str (match-end 0))))
3749 (setq i (1+ i)))
3750 (setq items
3751 (cons str items))))
3752 (while (and items (< number 9))
3753 (setq current (car items)
3754 items (cdr items)
3755 number (1+ number))
399c88ad 3756 (setq entries (cons `[,current
75a209d4
RS
3757 (Info-follow-reference ,current)
3758 t]
3759 entries)))
3760 (if items
3761 (setq entries (cons ["Other..." Info-follow-reference t]
3762 entries)))
3763 (or entries
5d5845dc 3764 (setq entries (list ["No references" nil nil] nil :active)))
75a209d4
RS
3765 (easy-menu-change '("Info") "Reference" (nreverse entries)))
3766 ;; Update last seen node.
6d2c8e3e 3767 (setq Info-menu-last-node (list Info-current-file Info-current-node)))
75a209d4
RS
3768 ;; Try to avoid entering infinite beep mode in case of errors.
3769 (error (ding))))
3770
a384cab3 3771\f
50163b00 3772(defun Info-copy-current-node-name (&optional arg)
185cff95
JL
3773 "Put the name of the current Info node into the kill ring.
3774The name of the Info file is prepended to the node name in parentheses.
50163b00
JL
3775With a zero prefix arg, put the name inside a function call to `info'."
3776 (interactive "P")
126f5d4d 3777 (unless Info-current-node
185cff95 3778 (error "No current Info node"))
bec275ed 3779 (let ((node (if (stringp Info-current-file)
e56f84d7 3780 (concat "(" (file-name-nondirectory Info-current-file) ") "
bec275ed 3781 Info-current-node))))
50163b00
JL
3782 (if (zerop (prefix-numeric-value arg))
3783 (setq node (concat "(info \"" node "\")")))
bec275ed
JL
3784 (unless (stringp Info-current-file)
3785 (setq node (format "(Info-find-node '%S '%S)"
3786 Info-current-file Info-current-node)))
50163b00
JL
3787 (kill-new node)
3788 (message "%s" node)))
126f5d4d
MB
3789
3790\f
a384cab3 3791;; Info mode is suitable only for specially formatted data.
68bc119c 3792(put 'Info-mode 'mode-class 'special)
2fa8f8a4 3793(put 'Info-mode 'no-clone-indirect t)
a384cab3 3794
f4f2bca3 3795(defvar tool-bar-map)
e0385bf4 3796(defvar bookmark-make-record-function)
f4f2bca3 3797
80123c9e
LH
3798;; Autoload cookie needed by desktop.el
3799;;;###autoload
a384cab3 3800(defun Info-mode ()
fdf4b680 3801 "Info mode provides commands for browsing through the Info documentation tree.
a384cab3
JB
3802Documentation in Info is divided into \"nodes\", each of which discusses
3803one topic and contains references to other nodes which discuss related
3804topics. Info has commands to follow the references and show you other nodes.
3805
fdf4b680 3806\\<Info-mode-map>\
a384cab3 3807\\[Info-help] Invoke the Info tutorial.
6b136ab9 3808\\[Info-exit] Quit Info: reselect previously selected buffer.
a384cab3
JB
3809
3810Selecting other nodes:
21d5959f
RS
3811\\[Info-mouse-follow-nearest-node]
3812 Follow a node reference you click on.
3813 This works with menu items, cross references, and
3814 the \"next\", \"previous\" and \"up\", depending on where you click.
6b136ab9 3815\\[Info-follow-nearest-node] Follow a node reference near point, like \\[Info-mouse-follow-nearest-node].
a384cab3 3816\\[Info-next] Move to the \"next\" node of this node.
bc2ada62 3817\\[Info-prev] Move to the \"previous\" node of this node.
a384cab3
JB
3818\\[Info-up] Move \"up\" from this node.
3819\\[Info-menu] Pick menu item specified by name (or abbreviation).
e8042313 3820 Picking a menu item causes another node to be selected.
aea2a8da 3821\\[Info-directory] Go to the Info directory node.
8300a5b5
JL
3822\\[Info-top-node] Go to the Top node of this file.
3823\\[Info-final-node] Go to the final node in this file.
3824\\[Info-backward-node] Go backward one node, considering all nodes as forming one sequence.
3825\\[Info-forward-node] Go forward one node, considering all nodes as forming one sequence.
3826\\[Info-next-reference] Move cursor to next cross-reference or menu item.
3827\\[Info-prev-reference] Move cursor to previous cross-reference or menu item.
a384cab3 3828\\[Info-follow-reference] Follow a cross reference. Reads name of reference.
424b9d3e
JL
3829\\[Info-history-back] Move back in history to the last node you were at.
3830\\[Info-history-forward] Move forward in history to the node you returned from after using \\[Info-history-back].
bc224645
JL
3831\\[Info-history] Go to menu of visited nodes.
3832\\[Info-toc] Go to table of contents of the current Info file.
a384cab3
JB
3833
3834Moving within a node:
177c3549 3835\\[Info-scroll-up] Normally, scroll forward a full screen.
e8042313
PJ
3836 Once you scroll far enough in a node that its menu appears on the
3837 screen but after point, the next scroll moves into its first
3838 subnode. When after all menu items (or if there is no menu),
3839 move up to the parent node.
177c3549 3840\\[Info-scroll-down] Normally, scroll backward. If the beginning of the buffer is
e8042313
PJ
3841 already visible, try to go to the previous menu entry, or up
3842 if there is none.
399c88ad 3843\\[beginning-of-buffer] Go to beginning of node.
a384cab3 3844
a384cab3 3845Advanced commands:
a384cab3 3846\\[Info-search] Search through this Info file for specified regexp,
e8042313 3847 and select the node in which the next occurrence is found.
bc224645 3848\\[Info-search-case-sensitively] Search through this Info file for specified regexp case-sensitively.
88e1d519 3849\\[isearch-forward], \\[isearch-forward-regexp] Use Isearch to search through multiple Info nodes.
9012c084 3850\\[Info-index] Search for a topic in this manual's Index and go to index entry.
8300a5b5 3851\\[Info-index-next] (comma) Move to the next match from a previous \\<Info-mode-map>\\[Info-index] command.
30760c8b 3852\\[Info-virtual-index] Look for a string and display the index node with results.
8300a5b5
JL
3853\\[info-apropos] Look for a string in the indices of all manuals.
3854\\[Info-goto-node] Move to node specified by name.
3855 You may include a filename as well, as (FILENAME)NODENAME.
38561 .. 9 Pick first ... ninth item in node's menu.
3857 Every third `*' is highlighted to help pick the right number.
3858\\[Info-copy-current-node-name] Put name of current Info node in the kill ring.
3859\\[clone-buffer] Select a new cloned Info buffer in another window.
3860\\[universal-argument] \\[info] Move to new Info file with completion.
3861\\[universal-argument] N \\[info] Select Info buffer with prefix number in the name *info*<N>."
a384cab3
JB
3862 (kill-all-local-variables)
3863 (setq major-mode 'Info-mode)
3864 (setq mode-name "Info")
f73299f3 3865 (setq tab-width 8)
a384cab3 3866 (use-local-map Info-mode-map)
75a209d4 3867 (add-hook 'activate-menubar-hook 'Info-menu-update nil t)
a384cab3
JB
3868 (set-syntax-table text-mode-syntax-table)
3869 (setq local-abbrev-table text-mode-abbrev-table)
3870 (setq case-fold-search t)
3871 (setq buffer-read-only t)
a384cab3
JB
3872 (make-local-variable 'Info-current-file)
3873 (make-local-variable 'Info-current-subfile)
3874 (make-local-variable 'Info-current-node)
3875 (make-local-variable 'Info-tag-table-marker)
c5fe2ff1
RS
3876 (setq Info-tag-table-marker (make-marker))
3877 (make-local-variable 'Info-tag-table-buffer)
3878 (setq Info-tag-table-buffer nil)
a384cab3 3879 (make-local-variable 'Info-history)
424b9d3e 3880 (make-local-variable 'Info-history-forward)
1143a6b0 3881 (make-local-variable 'Info-index-alternatives)
eb033d40
DR
3882 (if Info-use-header-line ; do not override global header lines
3883 (setq header-line-format
3884 '(:eval (get-text-property (point-min) 'header-line))))
7210b6f5 3885 (set (make-local-variable 'tool-bar-map) info-tool-bar-map)
93480d70
RS
3886 ;; This is for the sake of the invisible text we use handling titles.
3887 (make-local-variable 'line-move-ignore-invisible)
3888 (setq line-move-ignore-invisible t)
9d9d10ec 3889 (make-local-variable 'desktop-save-buffer)
ab357a65
RS
3890 (make-local-variable 'widen-automatically)
3891 (setq widen-automatically nil)
9d9d10ec 3892 (setq desktop-save-buffer 'Info-desktop-buffer-misc-data)
34d86208 3893 (add-hook 'kill-buffer-hook 'Info-kill-buffer nil t)
274bcfe0 3894 (add-hook 'clone-buffer-hook 'Info-clone-buffer nil t)
3d12b331 3895 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
d457219d 3896 (add-hook 'isearch-mode-hook 'Info-isearch-start nil t)
0b02cda9
JL
3897 (set (make-local-variable 'isearch-search-fun-function)
3898 'Info-isearch-search)
3899 (set (make-local-variable 'isearch-wrap-function)
3900 'Info-isearch-wrap)
3901 (set (make-local-variable 'isearch-push-state-function)
3902 'Info-isearch-push-state)
a2c72e6c 3903 (set (make-local-variable 'isearch-filter-predicate)
3fbb3dc4 3904 'Info-isearch-filter)
0b02cda9
JL
3905 (set (make-local-variable 'search-whitespace-regexp)
3906 Info-search-whitespace-regexp)
e56f84d7
TTN
3907 (set (make-local-variable 'revert-buffer-function)
3908 'Info-revert-buffer-function)
a384cab3 3909 (Info-set-mode-line)
e0385bf4
KF
3910 (set (make-local-variable 'bookmark-make-record-function)
3911 'Info-bookmark-make-record)
d39f149d 3912 (run-mode-hooks 'Info-mode-hook))
a384cab3 3913
34d86208
JL
3914;; When an Info buffer is killed, make sure the associated tags buffer
3915;; is killed too.
3916(defun Info-kill-buffer ()
3917 (and (eq major-mode 'Info-mode)
3918 Info-tag-table-buffer
3919 (kill-buffer Info-tag-table-buffer)))
3920
274bcfe0
RS
3921;; Placed on `clone-buffer-hook'.
3922(defun Info-clone-buffer ()
4fceda3c
SM
3923 (when (bufferp Info-tag-table-buffer)
3924 (setq Info-tag-table-buffer
4ce5c223
SM
3925 (with-current-buffer Info-tag-table-buffer (clone-buffer))))
3926 (let ((m Info-tag-table-marker))
3927 (when (markerp m)
15533ae2 3928 (setq Info-tag-table-marker
4ce5c223 3929 (if (and (marker-position m) (bufferp Info-tag-table-buffer))
15533ae2
SM
3930 (with-current-buffer Info-tag-table-buffer
3931 (copy-marker (marker-position m)))
3932 (make-marker))))))
4fceda3c 3933
7210b6f5
DL
3934(defvar Info-edit-map (let ((map (make-sparse-keymap)))
3935 (set-keymap-parent map text-mode-map)
3936 (define-key map "\C-c\C-c" 'Info-cease-edit)
3937 map)
a384cab3 3938 "Local keymap used within `e' command of Info.")
a384cab3
JB
3939
3940;; Info-edit mode is suitable only for specially formatted data.
68bc119c 3941(put 'Info-edit-mode 'mode-class 'special)
a384cab3
JB
3942
3943(defun Info-edit-mode ()
3944 "Major mode for editing the contents of an Info node.
a426b157 3945Like text mode with the addition of `Info-cease-edit'
a384cab3
JB
3946which returns to Info mode for browsing.
3947\\{Info-edit-map}"
a384cab3
JB
3948 (use-local-map Info-edit-map)
3949 (setq major-mode 'Info-edit-mode)
3950 (setq mode-name "Info Edit")
3951 (kill-local-variable 'mode-line-buffer-identification)
3952 (setq buffer-read-only nil)
2c609f53 3953 (force-mode-line-update)
e82c28f9 3954 (buffer-enable-undo (current-buffer))
d39f149d 3955 (run-mode-hooks 'Info-edit-mode-hook))
e82c28f9
KH
3956
3957(defun Info-edit ()
3958 "Edit the contents of this Info node.
3959Allowed only if variable `Info-enable-edit' is non-nil."
3960 (interactive)
3961 (or Info-enable-edit
185cff95 3962 (error "Editing Info nodes is not enabled"))
e82c28f9 3963 (Info-edit-mode)
8ab3e50b 3964 (message "%s" (substitute-command-keys
760d5cb3 3965 "Editing: Type \\<Info-edit-map>\\[Info-cease-edit] to return to info")))
a384cab3
JB
3966
3967(defun Info-cease-edit ()
3968 "Finish editing Info node; switch back to Info proper."
3969 (interactive)
3970 ;; Do this first, so nothing has changed if user C-g's at query.
3971 (and (buffer-modified-p)
3972 (y-or-n-p "Save the file? ")
3973 (save-buffer))
3974 (use-local-map Info-mode-map)
3975 (setq major-mode 'Info-mode)
3976 (setq mode-name "Info")
3977 (Info-set-mode-line)
3978 (setq buffer-read-only t)
2c609f53 3979 (force-mode-line-update)
a384cab3
JB
3980 (and (marker-position Info-tag-table-marker)
3981 (buffer-modified-p)
3982 (message "Tags may have changed. Use Info-tagify if necessary")))
f0a8a3f1 3983\f
f88ab1c9 3984(defvar Info-file-list-for-emacs
02c9f5cd 3985 '("ediff" "eudc" "forms" "gnus" "info" ("Info" . "info") ("mh" . "mh-e")
906b3163
EZ
3986 "sc" "message" ("dired" . "dired-x") "viper" "vip" "idlwave"
3987 ("c" . "ccmode") ("c++" . "ccmode") ("objc" . "ccmode")
3988 ("java" . "ccmode") ("idl" . "ccmode") ("pike" . "ccmode")
af718538
EZ
3989 ("skeleton" . "autotype") ("auto-insert" . "autotype")
3990 ("copyright" . "autotype") ("executable" . "autotype")
3991 ("time-stamp" . "autotype") ("quickurl" . "autotype")
3992 ("tempo" . "autotype") ("hippie-expand" . "autotype")
807378ad
EZ
3993 ("cvs" . "pcl-cvs") ("ada" . "ada-mode") "calc"
3994 ("calcAlg" . "calc") ("calcDigit" . "calc") ("calcVar" . "calc")
906b3163
EZ
3995 "ebrowse" "eshell" "cl" "reftex" "speedbar" "widget" "woman"
3996 ("mail-header" . "emacs-mime") ("mail-content" . "emacs-mime")
3997 ("mail-encode" . "emacs-mime") ("mail-decode" . "emacs-mime")
3998 ("rfc2045" . "emacs-mime")
3999 ("rfc2231" . "emacs-mime") ("rfc2047" . "emacs-mime")
4000 ("rfc2045" . "emacs-mime") ("rfc1843" . "emacs-mime")
4001 ("ietf-drums" . "emacs-mime") ("quoted-printable" . "emacs-mime")
4002 ("binhex" . "emacs-mime") ("uudecode" . "emacs-mime")
4003 ("mailcap" . "emacs-mime") ("mm" . "emacs-mime")
4004 ("mml" . "emacs-mime"))
f88ab1c9
RS
4005 "List of Info files that describe Emacs commands.
4006An element can be a file name, or a list of the form (PREFIX . FILE)
4007where PREFIX is a name prefix and FILE is the file to look in.
4008If the element is just a file name, the file name also serves as the prefix.")
4009
f0a8a3f1 4010(defun Info-find-emacs-command-nodes (command)
f88ab1c9 4011 "Return a list of locations documenting COMMAND.
f57b2cd8
RS
4012The `info-file' property of COMMAND says which Info manual to search.
4013If COMMAND has no property, the variable `Info-file-list-for-emacs'
4014defines heuristics for which Info manual to try.
fdf4b680 4015The locations are of the format used in `Info-history', i.e.
02c9f5cd
JL
4016\(FILENAME NODENAME BUFFERPOS\), where BUFFERPOS is the line number
4017in the first element of the returned list (which is treated specially in
4018`Info-goto-emacs-command-node'), and 0 for the rest elements of a list."
4019 (let ((where '()) line-number
b37daea4 4020 (cmd-desc (concat "^\\* +" (regexp-quote (symbol-name command))
f254e21f 4021 "\\( <[0-9]+>\\)?:\\s *\\(.*\\)\\."
02c9f5cd 4022 "\\(?:[ \t\n]+(line +\\([0-9]+\\))\\)?"))
f88ab1c9 4023 (info-file "emacs")) ;default
185cff95 4024 ;; Determine which Info file this command is documented in.
f88ab1c9
RS
4025 (if (get command 'info-file)
4026 (setq info-file (get command 'info-file))
4027 ;; If it doesn't say explicitly, test its name against
4028 ;; various prefixes that we know.
4029 (let ((file-list Info-file-list-for-emacs))
4030 (while file-list
4031 (let* ((elt (car file-list))
4032 (name (if (consp elt)
4033 (car elt)
4034 elt))
4035 (file (if (consp elt) (cdr elt) elt))
cc3f6c32 4036 (case-fold-search nil)
f57b2cd8 4037 (regexp (concat "\\`" (regexp-quote name)
f88ab1c9
RS
4038 "\\(\\'\\|-\\)")))
4039 (if (string-match regexp (symbol-name command))
4040 (setq info-file file file-list nil))
4041 (setq file-list (cdr file-list))))))
218c2cc7 4042 (Info-find-node info-file "Top")
218c2cc7
EZ
4043 ;; Bind Info-history to nil, to prevent the index nodes from
4044 ;; getting into the node history.
4045 (let ((Info-history nil)
141b49f5
JL
4046 (Info-history-list nil)
4047 node (nodes (Info-index-nodes)))
4048 (Info-goto-node (car nodes))
218c2cc7
EZ
4049 (while
4050 (progn
4051 (goto-char (point-min))
4052 (while (re-search-forward cmd-desc nil t)
4053 (setq where
4054 (cons (list Info-current-file
4055 (match-string-no-properties 2)
760d5cb3 4056 0)
02c9f5cd
JL
4057 where))
4058 (setq line-number (and (match-beginning 3)
4059 (string-to-number (match-string 3)))))
141b49f5 4060 (and (setq nodes (cdr nodes) node (car nodes))))
218c2cc7 4061 (Info-goto-node node)))
02c9f5cd
JL
4062 (if (and line-number where)
4063 (cons (list (nth 0 (car where)) (nth 1 (car where)) line-number)
4064 (cdr where))
4065 where)))
f0a8a3f1 4066
6bdad9ae 4067;;;###autoload (put 'Info-goto-emacs-command-node 'info-file (purecopy "emacs"))
f0a8a3f1
RM
4068;;;###autoload
4069(defun Info-goto-emacs-command-node (command)
e0568e86 4070 "Go to the Info node in the Emacs manual for command COMMAND.
30db89f9 4071The command is found by looking up in Emacs manual's indices
f57b2cd8 4072or in another manual found via COMMAND's `info-file' property or
1ed6e0c3
JPW
4073the variable `Info-file-list-for-emacs'.
4074COMMAND must be a symbol or string."
f0a8a3f1 4075 (interactive "CFind documentation for command: ")
fafb00dc
MY
4076 ;; If command is given as a string, convert it to a symbol.
4077 (if (stringp command)
1ed6e0c3 4078 (setq command (intern command)))
f0a8a3f1
RM
4079 (or (commandp command)
4080 (signal 'wrong-type-argument (list 'commandp command)))
4081 (let ((where (Info-find-emacs-command-nodes command)))
4082 (if where
4083 (let ((num-matches (length where)))
4084 ;; Get Info running, and pop to it in another window.
4085 (save-window-excursion
4086 (info))
89b064a9 4087 (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
218c2cc7
EZ
4088 ;; Bind Info-history to nil, to prevent the last Index node
4089 ;; visited by Info-find-emacs-command-nodes from being
4090 ;; pushed onto the history.
02c9f5cd
JL
4091 (let ((Info-history nil) (Info-history-list nil)
4092 (line-number (nth 2 (car where))))
4093 (Info-find-node (nth 0 (car where)) (nth 1 (car where)))
4094 (if (and (integerp line-number) (> line-number 0))
4095 (forward-line (1- line-number))))
f0a8a3f1
RM
4096 (if (> num-matches 1)
4097 (progn
218c2cc7
EZ
4098 ;; (car where) will be pushed onto Info-history
4099 ;; when/if they go to another node. Put the other
4100 ;; nodes that were found on the history.
f0a8a3f1 4101 (setq Info-history (nconc (cdr where) Info-history))
8ab3e50b 4102 (message "Found %d other entr%s. Use %s to see %s."
cedb118c
RS
4103 (1- num-matches)
4104 (if (> num-matches 2) "ies" "y")
424b9d3e 4105 (substitute-command-keys "\\[Info-history-back]")
cedb118c 4106 (if (> num-matches 2) "them" "it")))))
e9b81433 4107 (error "Couldn't find documentation for %s" command))))
f0a8a3f1 4108
6bdad9ae 4109;;;###autoload (put 'Info-goto-emacs-key-command-node 'info-file (purecopy "emacs"))
f0a8a3f1
RM
4110;;;###autoload
4111(defun Info-goto-emacs-key-command-node (key)
30db89f9
EZ
4112 "Go to the node in the Emacs manual which describes the command bound to KEY.
4113KEY is a string.
fdf4b680 4114Interactively, if the binding is `execute-extended-command', a command is read.
30db89f9 4115The command is found by looking up in Emacs manual's indices
f57b2cd8
RS
4116or in another manual found via COMMAND's `info-file' property or
4117the variable `Info-file-list-for-emacs'."
ea33749b 4118 (interactive "kFind documentation for key: ")
f0a8a3f1
RM
4119 (let ((command (key-binding key)))
4120 (cond ((null command)
9e5c2f50 4121 (message "%s is undefined" (key-description key)))
32226619 4122 ((and (called-interactively-p 'interactive)
f0a8a3f1
RM
4123 (eq command 'execute-extended-command))
4124 (Info-goto-emacs-command-node
4125 (read-command "Find documentation for command: ")))
4126 (t
4127 (Info-goto-emacs-command-node command)))))
552775bd 4128\f
efb21aab
RS
4129(defvar Info-next-link-keymap
4130 (let ((keymap (make-sparse-keymap)))
4131 (define-key keymap [header-line mouse-1] 'Info-next)
4132 (define-key keymap [header-line mouse-2] 'Info-next)
4133 (define-key keymap [header-line down-mouse-1] 'ignore)
4134 (define-key keymap [mouse-2] 'Info-next)
3c1498ac 4135 (define-key keymap [follow-link] 'mouse-face)
efb21aab
RS
4136 keymap)
4137 "Keymap to put on the Next link in the text or the header line.")
4138
4139(defvar Info-prev-link-keymap
4140 (let ((keymap (make-sparse-keymap)))
4141 (define-key keymap [header-line mouse-1] 'Info-prev)
4142 (define-key keymap [header-line mouse-2] 'Info-prev)
4143 (define-key keymap [header-line down-mouse-1] 'ignore)
4144 (define-key keymap [mouse-2] 'Info-prev)
3c1498ac 4145 (define-key keymap [follow-link] 'mouse-face)
efb21aab
RS
4146 keymap)
4147 "Keymap to put on the Prev link in the text or the header line.")
4148
efb21aab
RS
4149(defvar Info-up-link-keymap
4150 (let ((keymap (make-sparse-keymap)))
4151 (define-key keymap [header-line mouse-1] 'Info-up)
4152 (define-key keymap [header-line mouse-2] 'Info-up)
4153 (define-key keymap [header-line down-mouse-1] 'ignore)
4154 (define-key keymap [mouse-2] 'Info-up)
3c1498ac 4155 (define-key keymap [follow-link] 'mouse-face)
efb21aab
RS
4156 keymap)
4157 "Keymap to put on the Up link in the text or the header line.")
4158
fdeb777a 4159(defun Info-insert-breadcrumbs ()
586f9284
JL
4160 (let ((nodes (Info-toc-nodes Info-current-file))
4161 (node Info-current-node)
fdeb777a 4162 (crumbs ())
586f9284
JL
4163 (depth Info-breadcrumbs-depth))
4164
4165 ;; Get ancestors from the cached parent-children node info
4166 (while (and (not (equal "Top" node)) (> depth 0))
4167 (setq node (nth 1 (assoc node nodes)))
4168 (if node (push node crumbs))
4169 (setq depth (1- depth)))
4170
4171 ;; Add bottom node.
4172 (when Info-use-header-line
4173 ;; Let it disappear if crumbs is nil.
4174 (nconc crumbs (list Info-current-node)))
4175 (when (or Info-use-header-line crumbs)
4176 ;; Add top node (and continuation if needed).
4177 (setq crumbs
4178 (cons "Top" (if (member (pop crumbs) '(nil "Top"))
4179 crumbs (cons nil crumbs))))
4180 ;; Eliminate duplicate.
4181 (forward-line 1)
4182 (dolist (node crumbs)
4183 (let ((text
4184 (if (not (equal node "Top")) node
4185 (format "(%s)Top"
4186 (if (stringp Info-current-file)
4187 (file-name-nondirectory Info-current-file)
6a013a49 4188 ;; Some legacy code can still use a symbol.
586f9284
JL
4189 Info-current-file)))))
4190 (insert (if (bolp) "" " > ")
4191 (cond
4192 ((null node) "...")
4193 ((equal node Info-current-node)
4194 ;; No point linking to ourselves.
4195 (propertize text 'font-lock-face 'info-header-node))
4196 (t
4197 (concat "*Note " text "::"))))))
4198 (insert "\n"))))
fdeb777a 4199
552775bd 4200(defun Info-fontify-node ()
8a7757f6
JL
4201 "Fontify the node."
4202 (save-excursion
4203 (let* ((inhibit-read-only t)
4204 (case-fold-search t)
4205 paragraph-markers
4206 (not-fontified-p ; the node hasn't already been fontified
f9b27c85 4207 (not (let ((where (next-single-property-change (point-min)
499878f8 4208 'font-lock-face)))
8a7757f6
JL
4209 (and where (not (= where (point-max)))))))
4210 (fontify-visited-p ; visited nodes need to be re-fontified
4211 (and Info-fontify-visited-nodes
4212 ;; Don't take time to refontify visited nodes in huge nodes
3d0fc0b7 4213 Info-fontify-maximum-menu-size
e14105f6
TTN
4214 (< (- (point-max) (point-min)) Info-fontify-maximum-menu-size)))
4215 rbeg rend)
8a7757f6
JL
4216
4217 ;; Fontify header line
4218 (goto-char (point-min))
4219 (when (and not-fontified-p (looking-at "^\\(File: [^,: \t]+,?[ \t]+\\)?"))
4220 (goto-char (match-end 0))
4221 (while (looking-at "[ \t]*\\([^:, \t\n]+\\):[ \t]+\\([^:,\t\n]+\\),?")
4222 (goto-char (match-end 0))
4223 (let* ((nbeg (match-beginning 2))
4224 (nend (match-end 2))
4225 (tbeg (match-beginning 1))
4226 (tag (match-string 1)))
99315976 4227 (if (string-equal (downcase tag) "node")
8a7757f6
JL
4228 (put-text-property nbeg nend 'font-lock-face 'info-header-node)
4229 (put-text-property nbeg nend 'font-lock-face 'info-header-xref)
4230 (put-text-property tbeg nend 'mouse-face 'highlight)
4231 (put-text-property tbeg nend
4232 'help-echo
3c1498ac 4233 (concat "mouse-2: Go to node "
8a7757f6
JL
4234 (buffer-substring nbeg nend)))
4235 ;; Always set up the text property keymap.
4236 ;; It will either be used in the buffer
4237 ;; or copied in the header line.
99315976
JL
4238 (put-text-property
4239 tbeg nend 'keymap
4240 (cond
4241 ((string-equal (downcase tag) "prev") Info-prev-link-keymap)
4242 ((string-equal (downcase tag) "next") Info-next-link-keymap)
4243 ((string-equal (downcase tag) "up" ) Info-up-link-keymap))))))
3bfd723a 4244
fdeb777a
SM
4245 (when (> Info-breadcrumbs-depth 0)
4246 (Info-insert-breadcrumbs))
3bfd723a 4247
fdeb777a 4248 ;; Treat header line.
8a7757f6
JL
4249 (when Info-use-header-line
4250 (goto-char (point-min))
de22f49c
SM
4251 (let* ((header-end (line-end-position))
4252 (header
4253 ;; If we find neither Next: nor Prev: link, show the entire
4254 ;; node header. Otherwise, don't show the File: and Node:
4255 ;; parts, to avoid wasting precious space on information that
4256 ;; is available in the mode line.
4257 (if (re-search-forward
4258 "\\(next\\|up\\|prev[ious]*\\): "
4259 header-end t)
4260 (progn
4261 (goto-char (match-beginning 1))
4262 (buffer-substring (point) header-end))
4263 (if (re-search-forward "node:[ \t]*[^ \t]+[ \t]*"
4264 header-end t)
8a7757f6 4265 (concat "No next, prev or up links -- "
de22f49c
SM
4266 (buffer-substring (point) header-end))
4267 (buffer-substring (point) header-end)))))
8a7757f6 4268 (put-text-property (point-min) (1+ (point-min))
69672704
JL
4269 'header-line
4270 (replace-regexp-in-string
4271 "%"
4272 ;; Preserve text properties on duplicated `%'.
4273 (lambda (s) (concat s s)) header))
8a7757f6
JL
4274 ;; Hide the part of the first line
4275 ;; that is in the header, if it is just part.
fdeb777a
SM
4276 (cond
4277 ((> Info-breadcrumbs-depth 0)
4278 (put-text-property (point-min) (1+ header-end) 'invisible t))
4279 ((not (bobp))
8a7757f6
JL
4280 ;; Hide the punctuation at the end, too.
4281 (skip-chars-backward " \t,")
fdeb777a 4282 (put-text-property (point) header-end 'invisible t))))))
8a7757f6
JL
4283
4284 ;; Fontify titles
4285 (goto-char (point-min))
de22f49c
SM
4286 (when (and font-lock-mode not-fontified-p)
4287 (while (and (re-search-forward "\n\\([^ \t\n].+\\)\n\\(\\*\\*+\\|==+\\|--+\\|\\.\\.+\\)$"
4288 nil t)
4289 ;; Only consider it as an underlined title if the ASCII
4290 ;; underline has the same size as the text. A typical
4291 ;; counter example is when a continuation "..." is alone
4292 ;; on a line.
4dacf0ff
JL
4293 (= (string-width (match-string 1))
4294 (string-width (match-string 2))))
8a7757f6
JL
4295 (let* ((c (preceding-char))
4296 (face
a335c06e
MB
4297 (cond ((= c ?*) 'info-title-1)
4298 ((= c ?=) 'info-title-2)
4299 ((= c ?-) 'info-title-3)
4300 (t 'info-title-4))))
8a7757f6
JL
4301 (put-text-property (match-beginning 1) (match-end 1)
4302 'font-lock-face face))
4303 ;; This is a serious problem for trying to handle multiple
4304 ;; frame types at once. We want this text to be invisible
4305 ;; on frames that can display the font above.
9e2a2647 4306 (when (memq (framep (selected-frame)) '(x pc w32 ns))
8a7757f6
JL
4307 (add-text-properties (1- (match-beginning 2)) (match-end 2)
4308 '(invisible t front-sticky nil rear-nonsticky t)))))
4309
4310 ;; Fontify cross references
4311 (goto-char (point-min))
4312 (when (or not-fontified-p fontify-visited-p)
4313 (while (re-search-forward "\\(\\*Note[ \n\t]+\\)\\([^:]*\\)\\(:[ \t]*\\([^.,:(]*\\)\\(\\(([^)]*)\\)[^.,:]*\\)?[,:]?\n?\\)" nil t)
4314 (let ((start (match-beginning 0))
4315 (next (point))
4316 other-tag)
4317 (when not-fontified-p
4318 (when Info-hide-note-references
fdeb777a
SM
4319 (when (and (not (eq Info-hide-note-references 'hide))
4320 (> (line-number-at-pos) 4)) ; Skip breadcrumbs
fc11ddc8
JL
4321 ;; *Note is often used where *note should have been
4322 (goto-char start)
4323 (skip-syntax-backward " ")
d75baf12
RS
4324 (when (memq (char-before) '(?\( ?\[ ?\{))
4325 ;; Check whether the paren is preceded by
4326 ;; an end of sentence
4327 (skip-syntax-backward " ("))
fc11ddc8 4328 (setq other-tag
e8e6694b
RS
4329 (cond ((save-match-data (looking-back "\\<see"))
4330 "")
dc7ef9f0
CY
4331 ((save-match-data (looking-back "\\<in"))
4332 "")
e8e6694b 4333 ((memq (char-before) '(nil ?\. ?! ??))
fc11ddc8 4334 "See ")
d75baf12
RS
4335 ((save-match-data
4336 (save-excursion
4337 (search-forward "\n\n" start t)))
4338 "See ")
4339 (t "see "))))
8a7757f6
JL
4340 (goto-char next)
4341 (add-text-properties
4342 (match-beginning 1)
4343 (or (save-match-data
4344 ;; Don't hide \n after *Note
4345 (let ((start1 (match-beginning 1)))
4346 (if (string-match "\n" (match-string 1))
4347 (+ start1 (match-beginning 0)))))
4348 (match-end 1))
fc11ddc8 4349 (if other-tag
8a7757f6
JL
4350 `(display ,other-tag front-sticky nil rear-nonsticky t)
4351 '(invisible t front-sticky nil rear-nonsticky t))))
4352 (add-text-properties
4353 (match-beginning 2) (match-end 2)
4354 (list
4355 'help-echo (if (or (match-end 5)
4356 (not (equal (match-string 4) "")))
4357 (concat "mouse-2: go to " (or (match-string 5)
4358 (match-string 4)))
4359 "mouse-2: go to this node")
4360 'mouse-face 'highlight)))
4361 (when (or not-fontified-p fontify-visited-p)
e14105f6
TTN
4362 (setq rbeg (match-beginning 2)
4363 rend (match-end 2))
4364 (put-text-property
4365 rbeg rend
4366 'font-lock-face
4367 ;; Display visited nodes in a different face
4368 (if (and Info-fontify-visited-nodes
4369 (save-match-data
4370 (let* ((node (replace-regexp-in-string
4371 "^[ \t]+" ""
4372 (replace-regexp-in-string
4373 "[ \t\n]+" " "
bec275ed 4374 (or (match-string-no-properties 5)
e14105f6 4375 (and (not (equal (match-string 4) ""))
bec275ed
JL
4376 (match-string-no-properties 4))
4377 (match-string-no-properties 2)))))
d8fbba22
CY
4378 (external-link-p
4379 (string-match "(\\([^)]+\\))\\([^)]*\\)" node))
4380 (file (if external-link-p
4381 (file-name-nondirectory
bec275ed 4382 (match-string-no-properties 1 node))
d8fbba22 4383 Info-current-file))
e14105f6
TTN
4384 (hl Info-history-list)
4385 res)
d8fbba22
CY
4386 (if external-link-p
4387 (setq node (if (equal (match-string 2 node) "")
e14105f6 4388 "Top"
bec275ed 4389 (match-string-no-properties 2 node))))
d590dbd2
CY
4390 (while hl
4391 (if (and (string-equal node (nth 1 (car hl)))
bec275ed
JL
4392 (equal file
4393 (if (and external-link-p
4394 (stringp (caar hl)))
4395 (file-name-nondirectory
4396 (caar hl))
4397 (caar hl))))
d590dbd2
CY
4398 (setq res (car hl) hl nil)
4399 (setq hl (cdr hl))))
e14105f6
TTN
4400 res))) 'info-xref-visited 'info-xref))
4401 ;; For multiline ref, unfontify newline and surrounding whitespace
4402 (save-excursion
4403 (goto-char rbeg)
4404 (save-match-data
4405 (while (re-search-forward "\\s-*\n\\s-*" rend t nil)
4406 (remove-text-properties (match-beginning 0)
4407 (match-end 0)
4408 '(font-lock-face t))))))
8a7757f6
JL
4409 (when not-fontified-p
4410 (when (memq Info-hide-note-references '(t hide))
4411 (add-text-properties (match-beginning 3) (match-end 3)
4412 '(invisible t front-sticky nil rear-nonsticky t))
4413 ;; Unhide the file name of the external reference in parens
89b064a9 4414 (if (and (match-string 6) (not (eq Info-hide-note-references 'hide)))
8a7757f6
JL
4415 (remove-text-properties (match-beginning 6) (match-end 6)
4416 '(invisible t front-sticky nil rear-nonsticky t)))
4417 ;; Unhide newline because hidden newlines cause too long lines
4418 (save-match-data
89b064a9
JL
4419 (let ((beg3 (match-beginning 3))
4420 (end3 (match-end 3)))
4421 (if (and (string-match "\n[ \t]*" (match-string 3))
4422 (not (save-match-data
4423 (save-excursion
4424 (goto-char (1+ end3))
4425 (looking-at "[.)]*$")))))
4426 (remove-text-properties (+ beg3 (match-beginning 0))
4427 (+ beg3 (match-end 0))
8a7757f6
JL
4428 '(invisible t front-sticky nil rear-nonsticky t))))))
4429 (when (and Info-refill-paragraphs Info-hide-note-references)
4430 (push (set-marker (make-marker) start)
4431 paragraph-markers))))))
4432
4433 ;; Refill paragraphs (experimental feature)
4434 (when (and not-fontified-p
4435 Info-refill-paragraphs
4436 paragraph-markers)
4437 (let ((fill-nobreak-invisible t)
4438 (fill-individual-varying-indent nil)
4439 (paragraph-start "\f\\|[ \t]*[-*]\\|[ \t]*$")
4440 (paragraph-separate ".*\\.[ \t]*\n[ \t]\\|[ \t]*[-*]\\|[ \t\f]*$")
4441 (adaptive-fill-mode nil))
4442 (goto-char (point-max))
a73db543
SM
4443 (dolist (m paragraph-markers)
4444 (when (< m (point))
4445 (goto-char m)
4446 (beginning-of-line)
4447 (let ((beg (point)))
4448 (when (zerop (forward-paragraph))
4449 (fill-individual-paragraphs beg (point) nil nil)
4450 (goto-char beg))))
4451 (set-marker m nil))))
8a7757f6
JL
4452
4453 ;; Fontify menu items
4454 (goto-char (point-min))
4455 (when (and (or not-fontified-p fontify-visited-p)
4456 (search-forward "\n* Menu:" nil t)
8a7757f6 4457 ;; Don't take time to annotate huge menus
3d0fc0b7 4458 Info-fontify-maximum-menu-size
8a7757f6
JL
4459 (< (- (point-max) (point)) Info-fontify-maximum-menu-size))
4460 (let ((n 0)
4461 cont)
4462 (while (re-search-forward
1ecc5922
RS
4463 (concat "^\\* Menu:\\|\\(?:^\\* +\\(" Info-menu-entry-name-re "\\)\\(:"
4464 Info-node-spec-re "\\([ \t]*\\)\\)\\)")
8a7757f6 4465 nil t)
1ecc5922
RS
4466 (when (match-beginning 1)
4467 (when not-fontified-p
4468 (setq n (1+ n))
4469 (if (and (<= n 9) (zerop (% n 3))) ; visual aids to help with 1-9 keys
4470 (put-text-property (match-beginning 0)
4471 (1+ (match-beginning 0))
185cff95 4472 'font-lock-face 'info-menu-star)))
1ecc5922
RS
4473 (when not-fontified-p
4474 (add-text-properties
4475 (match-beginning 1) (match-end 1)
4476 (list
4477 'help-echo (if (and (match-end 3)
4478 (not (equal (match-string 3) "")))
4479 (concat "mouse-2: go to " (match-string 3))
4480 "mouse-2: go to this node")
4481 'mouse-face 'highlight)))
4482 (when (or not-fontified-p fontify-visited-p)
a73db543 4483 (put-text-property
1ecc5922 4484 (match-beginning 1) (match-end 1)
a73db543
SM
4485 'font-lock-face
4486 ;; Display visited menu items in a different face
4487 (if (and Info-fontify-visited-nodes
4488 (save-match-data
d8fbba22 4489 (let* ((node (if (equal (match-string 3) "")
bec275ed
JL
4490 (match-string-no-properties 1)
4491 (match-string-no-properties 3)))
d8fbba22
CY
4492 (external-link-p
4493 (string-match "(\\([^)]+\\))\\([^)]*\\)" node))
4494 (file (if external-link-p
4495 (file-name-nondirectory
bec275ed 4496 (match-string-no-properties 1 node))
d8fbba22
CY
4497 Info-current-file))
4498 (hl Info-history-list)
4499 res)
4500 (if external-link-p
4501 (setq node (if (equal (match-string 2 node) "")
a73db543 4502 "Top"
bec275ed 4503 (match-string-no-properties 2 node))))
d590dbd2
CY
4504 (while hl
4505 (if (and (string-equal node (nth 1 (car hl)))
bec275ed
JL
4506 (equal file
4507 (if (and external-link-p
4508 (stringp (caar hl)))
4509 (file-name-nondirectory
4510 (caar hl))
4511 (caar hl))))
d590dbd2
CY
4512 (setq res (car hl) hl nil)
4513 (setq hl (cdr hl))))
a73db543 4514 res))) 'info-xref-visited 'info-xref)))
0f218170
JL
4515 (when (and not-fontified-p
4516 (memq Info-hide-note-references '(t hide))
4517 (not (Info-index-node)))
1ecc5922
RS
4518 (put-text-property (match-beginning 2) (1- (match-end 6))
4519 'invisible t)
4520 ;; Unhide the file name in parens
4521 (if (and (match-end 4) (not (eq (char-after (match-end 4)) ?.)))
4522 (remove-text-properties (match-beginning 4) (match-end 4)
4523 '(invisible t)))
4524 ;; We need a stretchable space like :align-to but with
4525 ;; a minimum value.
4526 (put-text-property (1- (match-end 6)) (match-end 6) 'display
4527 (if (>= 22 (- (match-end 1)
4528 (match-beginning 0)))
4529 '(space :align-to 24)
4530 '(space :width 2)))
4531 (setq cont (looking-at "."))
4532 (while (and (= (forward-line 1) 0)
4533 (looking-at "\\([ \t]+\\)[^*\n]"))
4534 (put-text-property (match-beginning 1) (1- (match-end 1))
4535 'invisible t)
4536 (put-text-property (1- (match-end 1)) (match-end 1)
4537 'display
4538 (if cont
4539 '(space :align-to 26)
4540 '(space :align-to 24)))
4541 (setq cont t)))))))
8a7757f6
JL
4542
4543 ;; Fontify menu headers
4544 ;; Add the face `info-menu-header' to any header before a menu entry
4545 (goto-char (point-min))
4546 (when (and not-fontified-p (re-search-forward "^\\* Menu:" nil t))
4547 (put-text-property (match-beginning 0) (match-end 0)
4548 'font-lock-face 'info-menu-header)
4549 (while (re-search-forward "\n\n\\([^*\n ].*\\)\n\n?[*]" nil t)
4550 (put-text-property (match-beginning 1) (match-end 1)
4551 'font-lock-face 'info-menu-header)))
4552
836bb478
JL
4553 ;; Hide index line numbers
4554 (goto-char (point-min))
141b49f5 4555 (when (and not-fontified-p (Info-index-node))
836bb478
JL
4556 (while (re-search-forward "[ \t\n]*(line +[0-9]+)" nil t)
4557 (put-text-property (match-beginning 0) (match-end 0)
4558 'invisible t)))
4559
8a7757f6
JL
4560 ;; Fontify http and ftp references
4561 (goto-char (point-min))
4562 (when not-fontified-p
68b77b64
GM
4563 (while (re-search-forward "\\(https?\\|ftp\\)://[^ \t\n\"`({<>})']+"
4564 nil t)
8a7757f6
JL
4565 (add-text-properties (match-beginning 0) (match-end 0)
4566 '(font-lock-face info-xref
fdeb777a
SM
4567 mouse-face highlight
4568 help-echo "mouse-2: go to this URL"))))
8a7757f6
JL
4569
4570 (set-buffer-modified-p nil))))
c5fe2ff1 4571\f
3cb6768f
EL
4572;;; Speedbar support:
4573;; These functions permit speedbar to display the "tags" in the
185cff95 4574;; current Info node.
96ee3f29 4575(eval-when-compile (require 'speedbar))
3cb6768f 4576
96ee3f29
KH
4577(defvar Info-speedbar-key-map nil
4578 "Keymap used when in the info display mode.")
3cb6768f 4579
96ee3f29
KH
4580(defun Info-install-speedbar-variables ()
4581 "Install those variables used by speedbar to enhance Info."
4582 (if Info-speedbar-key-map
4583 nil
4584 (setq Info-speedbar-key-map (speedbar-make-specialized-keymap))
4585
4586 ;; Basic tree features
4587 (define-key Info-speedbar-key-map "e" 'speedbar-edit-line)
4588 (define-key Info-speedbar-key-map "\C-m" 'speedbar-edit-line)
4589 (define-key Info-speedbar-key-map "+" 'speedbar-expand-line)
4590 (define-key Info-speedbar-key-map "-" 'speedbar-contract-line)
4591 )
4592
4593 (speedbar-add-expansion-list '("Info" Info-speedbar-menu-items
4594 Info-speedbar-key-map
4595 Info-speedbar-hierarchy-buttons)))
3cb6768f
EL
4596
4597(defvar Info-speedbar-menu-items
96ee3f29
KH
4598 '(["Browse Node" speedbar-edit-line t]
4599 ["Expand Node" speedbar-expand-line
4600 (save-excursion (beginning-of-line)
4601 (looking-at "[0-9]+: *.\\+. "))]
4602 ["Contract Node" speedbar-contract-line
4603 (save-excursion (beginning-of-line)
4604 (looking-at "[0-9]+: *.-. "))]
4605 )
3cb6768f
EL
4606 "Additional menu-items to add to speedbar frame.")
4607
96ee3f29
KH
4608;; Make sure our special speedbar major mode is loaded
4609(if (featurep 'speedbar)
4610 (Info-install-speedbar-variables)
4611 (add-hook 'speedbar-load-hook 'Info-install-speedbar-variables))
4612
4613;;; Info hierarchy display method
4614;;;###autoload
4615(defun Info-speedbar-browser ()
185cff95 4616 "Initialize speedbar to display an Info node browser.
96ee3f29
KH
4617This will add a speedbar major display mode."
4618 (interactive)
4619 (require 'speedbar)
4620 ;; Make sure that speedbar is active
4621 (speedbar-frame-mode 1)
4622 ;; Now, throw us into Info mode on speedbar.
4623 (speedbar-change-initial-expansion-list "Info")
4624 )
4625
4626(defun Info-speedbar-hierarchy-buttons (directory depth &optional node)
4627 "Display an Info directory hierarchy in speedbar.
4628DIRECTORY is the current directory in the attached frame.
4629DEPTH is the current indentation depth.
4630NODE is an optional argument that is used to represent the
4631specific node to expand."
4632 (if (and (not node)
4633 (save-excursion (goto-char (point-min))
1bcedb3b
RS
4634 (let ((case-fold-search t))
4635 (looking-at "Info Nodes:"))))
96ee3f29
KH
4636 ;; Update our "current node" maybe?
4637 nil
4638 ;; We cannot use the generic list code, that depends on all leaves
4639 ;; being known at creation time.
4640 (if (not node)
4641 (speedbar-with-writable (insert "Info Nodes:\n")))
24bbdbef
CY
4642 (let ((completions nil))
4643 (speedbar-select-attached-frame)
5fdc7997
EL
4644 (save-window-excursion
4645 (setq completions
4646 (Info-speedbar-fetch-file-nodes (or node '"(dir)top"))))
222a6c9b 4647 (select-frame (speedbar-current-frame))
96ee3f29
KH
4648 (if completions
4649 (speedbar-with-writable
dde7f979 4650 (dolist (completion completions)
96ee3f29 4651 (speedbar-make-tag-line 'bracket ?+ 'Info-speedbar-expand-node
dde7f979
SM
4652 (cdr completion)
4653 (car completion)
96ee3f29 4654 'Info-speedbar-goto-node
dde7f979
SM
4655 (cdr completion)
4656 'info-xref depth))
96ee3f29
KH
4657 t)
4658 nil))))
399c88ad 4659
96ee3f29 4660(defun Info-speedbar-goto-node (text node indent)
d1268e52 4661 "When user clicks on TEXT, go to an info NODE.
96ee3f29 4662The INDENT level is ignored."
24bbdbef 4663 (speedbar-select-attached-frame)
760d5cb3
GM
4664 (let* ((buff (or (get-buffer "*info*")
4665 (progn (info) (get-buffer "*info*"))))
4666 (bwin (get-buffer-window buff 0)))
4667 (if bwin
4668 (progn
4669 (select-window bwin)
4670 (raise-frame (window-frame bwin)))
4671 (if speedbar-power-click
4672 (let ((pop-up-frames t)) (select-window (display-buffer buff)))
24bbdbef 4673 (speedbar-select-attached-frame)
760d5cb3 4674 (switch-to-buffer buff)))
dde7f979
SM
4675 (if (not (string-match "^(\\([^)]+\\))\\([^.]+\\)$" node))
4676 (error "Invalid node %s" node)
4677 (Info-find-node (match-string 1 node) (match-string 2 node))
760d5cb3
GM
4678 ;; If we do a find-node, and we were in info mode, restore
4679 ;; the old default method. Once we are in info mode, it makes
4680 ;; sense to return to whatever method the user was using before.
4681 (if (string= speedbar-initial-expansion-list-name "Info")
4682 (speedbar-change-initial-expansion-list
4683 speedbar-previously-used-expansion-list-name)))))
96ee3f29
KH
4684
4685(defun Info-speedbar-expand-node (text token indent)
4686 "Expand the node the user clicked on.
4687TEXT is the text of the button we clicked on, a + or - item.
4688TOKEN is data related to this node (NAME . FILE).
4689INDENT is the current indentation depth."
4690 (cond ((string-match "+" text) ;we have to expand this file
4691 (speedbar-change-expand-button-char ?-)
4692 (if (speedbar-with-writable
760d5cb3
GM
4693 (save-excursion
4694 (end-of-line) (forward-char 1)
4695 (Info-speedbar-hierarchy-buttons nil (1+ indent) token)))
96ee3f29
KH
4696 (speedbar-change-expand-button-char ?-)
4697 (speedbar-change-expand-button-char ??)))
4698 ((string-match "-" text) ;we have to contract this node
4699 (speedbar-change-expand-button-char ?+)
4700 (speedbar-delete-subblock indent))
4701 (t (error "Ooops... not sure what to do")))
4702 (speedbar-center-buffer-smartly))
4703
4704(defun Info-speedbar-fetch-file-nodes (nodespec)
4705 "Fetch the subnodes from the info NODESPEC.
db90d225 4706NODESPEC is a string of the form: (file)node."
e8dab975
SM
4707 ;; Set up a buffer we can use to fake-out Info.
4708 (with-current-buffer (get-buffer-create " *info-browse-tmp*")
96ee3f29
KH
4709 (if (not (equal major-mode 'Info-mode))
4710 (Info-mode))
4711 ;; Get the node into this buffer
dde7f979
SM
4712 (if (not (string-match "^(\\([^)]+\\))\\([^.]+\\)$" nodespec))
4713 (error "Invalid node specification %s" nodespec)
4714 (Info-find-node (match-string 1 nodespec) (match-string 2 nodespec)))
96ee3f29
KH
4715 ;; Scan the created buffer
4716 (goto-char (point-min))
4717 (let ((completions nil)
1bcedb3b 4718 (case-fold-search t)
96ee3f29
KH
4719 (thisfile (progn (string-match "^(\\([^)]+\\))" nodespec)
4720 (match-string 1 nodespec))))
4721 ;; Always skip the first one...
4722 (re-search-forward "\n\\* \\([^:\t\n]*\\):" nil t)
4723 (while (re-search-forward "\n\\* \\([^:\t\n]*\\):" nil t)
4724 (let ((name (match-string 1)))
dde7f979
SM
4725 (push (cons name
4726 (if (looking-at " *\\(([^)]+)[^.\n]+\\)\\.")
4727 (match-string 1)
4728 (if (looking-at " *\\(([^)]+)\\)\\.")
4729 (concat (match-string 1) "Top")
4730 (concat "(" thisfile ")"
4731 (if (looking-at " \\([^.]+\\).")
4732 (match-string 1)
4733 name)))))
4734 completions)))
96ee3f29
KH
4735 (nreverse completions))))
4736
4737;;; Info mode node listing
24bbdbef 4738;; This is called by `speedbar-add-localized-speedbar-support'
3cb6768f
EL
4739(defun Info-speedbar-buttons (buffer)
4740 "Create a speedbar display to help navigation in an Info file.
4741BUFFER is the buffer speedbar is requesting buttons for."
96ee3f29 4742 (if (save-excursion (goto-char (point-min))
1bcedb3b
RS
4743 (let ((case-fold-search t))
4744 (not (looking-at "Info Nodes:"))))
96ee3f29 4745 (erase-buffer))
24bbdbef 4746 (Info-speedbar-hierarchy-buttons nil 0))
49116ac0 4747
6270bbe7
JL
4748(dolist (mess '("^First node in file$"
4749 "^No `.*' in index$"
4750 "^No cross-reference named"
4751 "^No cross.references in this node$"
185cff95 4752 "^No current Info node$"
48e5b471 4753 "^No menu in this node$"
6270bbe7
JL
4754 "^No more items in menu$"
4755 "^No more nodes$"
4756 "^No pointer \\(?:forward\\|backward\\) from this node$"
4757 "^No previous `i' command$"
4758 "^No previous items in menu$"
4759 "^No previous nodes$"
4760 "^No such item in menu$"
4761 "^No such node or anchor"
4762 "^Node has no"
4763 "^Point neither on reference nor in menu item description$"
4764 "^This is the \\(?:first\\|last\\) Info node you looked at$"
4765 search-failed))
48e5b471
DL
4766 (add-to-list 'debug-ignored-errors mess))
4767
f3a45db0
LH
4768;;;; Desktop support
4769
4770(defun Info-desktop-buffer-misc-data (desktop-dirname)
4771 "Auxiliary information to be saved in desktop file."
6a013a49 4772 (unless (Info-virtual-file-p Info-current-file)
bec275ed 4773 (list Info-current-file Info-current-node)))
f3a45db0 4774
f3a45db0
LH
4775(defun Info-restore-desktop-buffer (desktop-buffer-file-name
4776 desktop-buffer-name
4777 desktop-buffer-misc)
185cff95 4778 "Restore an Info buffer specified in a desktop file."
f3a45db0
LH
4779 (let ((first (nth 0 desktop-buffer-misc))
4780 (second (nth 1 desktop-buffer-misc)))
4781 (when (and first second)
c9ce1e40
JL
4782 (when desktop-buffer-name
4783 (set-buffer (get-buffer-create desktop-buffer-name))
4784 (Info-mode))
2a3f604d 4785 (Info-find-node first second)
f3a45db0
LH
4786 (current-buffer))))
4787
9e7357b0
AS
4788(add-to-list 'desktop-buffer-mode-handlers
4789 '(Info-mode . Info-restore-desktop-buffer))
80123c9e 4790
23ceed9a 4791;;;; Bookmark support
43f8b275
SM
4792(declare-function bookmark-make-record-default "bookmark" (&optional pos-only))
4793(declare-function bookmark-prop-get "bookmark" (bookmark prop))
4794(declare-function bookmark-default-handler "bookmark" (bmk))
4795(declare-function bookmark-get-bookmark-record "bookmark" (bmk))
e1af69b4 4796
32a091dd 4797(defun Info-bookmark-make-record ()
8559076d
KF
4798 "This implements the `bookmark-make-record-function' type (which see)
4799for Info nodes."
136894c8 4800 `(,Info-current-node
43f8b275
SM
4801 ,@(bookmark-make-record-default 'point-only)
4802 (filename . ,Info-current-file)
32a091dd
SM
4803 (info-node . ,Info-current-node)
4804 (handler . Info-bookmark-jump)))
23ceed9a
TH
4805
4806;;;###autoload
4807(defun Info-bookmark-jump (bmk)
8559076d
KF
4808 "This implements the `handler' function interface for the record
4809type returned by `Info-bookmark-make-record', which see."
43f8b275
SM
4810 (let* ((file (bookmark-prop-get bmk 'filename))
4811 (info-node (bookmark-prop-get bmk 'info-node))
4812 (buf (save-window-excursion ;FIXME: doesn't work with frames!
4813 (Info-find-node file info-node) (current-buffer))))
4814 ;; Use bookmark-default-handler to move to the appropriate location
4815 ;; within the node.
4816 (bookmark-default-handler
348d1e60 4817 `("" (buffer . ,buf) . ,(bookmark-get-bookmark-record bmk)))))
23ceed9a 4818
49116ac0
JB
4819(provide 'info)
4820
83040cb0 4821;; arch-tag: f2480fe2-2139-40c1-a49b-6314991164ac
1a06eabd 4822;;; info.el ends here