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