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