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