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