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