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