info.el 69.1 KB
Newer Older
1
;;; info.el --- info package for Emacs.
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1985, 1986, 1992, 1993, 1994 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Keywords: help
Eric S. Raymond's avatar
Eric S. Raymond committed
7

Jim Blandy's avatar
Jim Blandy committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
13 14 15 16 17 18 19 20
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Jim Blandy's avatar
Jim Blandy committed
24

Eric S. Raymond's avatar
Eric S. Raymond committed
25 26
;;; Commentary:

Erik Naggum's avatar
Erik Naggum committed
27
;; Note that nowadays we expect info files to be made using makeinfo.
Eric S. Raymond's avatar
Eric S. Raymond committed
28 29 30

;;; Code:

Jim Blandy's avatar
Jim Blandy committed
31 32 33 34 35
(defvar Info-history nil
  "List of info nodes user has visited.
Each element of list is a list (FILENAME NODENAME BUFFERPOS).")

(defvar Info-enable-edit nil
36
  "*Non-nil means the \\<Info-mode-map>\\[Info-edit] command in Info can edit the current node.
37 38 39 40
This is convenient if you want to write info files by hand.
However, we recommend that you not do this.
It is better to write a Texinfo file and generate the Info file from that,
because that gives you a printed manual as well.")
Jim Blandy's avatar
Jim Blandy committed
41

42
(defvar Info-enable-active-nodes nil
Jim Blandy's avatar
Jim Blandy committed
43 44
  "Non-nil allows Info to execute Lisp code associated with nodes.
The Lisp code is executed when the node is selected.")
45
(put 'Info-enable-active-nodes 'risky-local-variable t)
Jim Blandy's avatar
Jim Blandy committed
46

47 48 49
(defvar Info-fontify t
  "*Non-nil enables highlighting and fonts in Info nodes.")

50 51
(defvar Info-fontify-maximum-menu-size 30000
  "*Maximum size of menu to fontify if `Info-fontify' is non-nil.")
52

53
(defvar Info-directory-list
54
  (let ((path (getenv "INFOPATH"))
55 56 57 58
	;; This is for older Emacs versions
	;; which might get this info.el from the Texinfo distribution.
	(path-separator (if (boundp 'path-separator) path-separator
			  (if (eq system-type 'ms-dos) ";" ":")))
59
	(source (expand-file-name "info/" source-directory))
60
	(sibling (if installation-directory
61 62
		     (expand-file-name "info/" installation-directory)))
	alternative)
63 64 65 66
    (if path
	(let ((list nil)
	      idx)
	  (while (> (length path) 0)
67
	    (setq idx (or (string-match path-separator path) (length path))
68 69 70 71
		  list (cons (substring path 0 idx) list)
		  path (substring path (min (1+ idx)
					    (length path)))))
	  (nreverse list))
72 73 74 75 76
      (if (and sibling (file-exists-p sibling))
	  (setq alternative sibling)
	(setq alternative source))
      (if (or (member alternative Info-default-directory-list)
	      (not (file-exists-p alternative))
77
	      ;; On DOS/NT, we use movable executables always,
78
	      ;; and we must always find the Info dir at run time.
79
	      (if (or (eq system-type 'ms-dos) (eq system-type 'windows-nt))
80 81 82 83
		  nil
		;; Use invocation-directory for Info only if we used it for
		;; exec-directory also.
		(not (string= exec-directory
84 85
			      (expand-file-name "lib-src/"
						installation-directory)))))
86
	  Info-default-directory-list
87 88
	(reverse (cons alternative
		       (cdr (reverse Info-default-directory-list)))))))
Jim Blandy's avatar
Jim Blandy committed
89
  "List of directories to search for Info documentation files.
Jim Blandy's avatar
Jim Blandy committed
90
nil means not yet initialized.  In this case, Info uses the environment
91
variable INFOPATH to initialize it, or `Info-default-directory-list'
92 93
if there is no INFOPATH variable in the environment.
The last element of `Info-default-directory-list' is the directory
94
where Emacs installs the Info files that come with it.
95 96 97 98 99

If you run the Emacs executable from the `src' directory in the Emacs
source tree, the `info' directory in the source tree is used as the last
element, in place of the installation Info directory.  This is useful
when you run a version of Emacs without installing it.")
Jim Blandy's avatar
Jim Blandy committed
100

101 102 103 104
(defvar Info-additional-directory-list nil
  "List of additional directories to search for Info documentation files.
These directories are not searched for merging the `dir' file.")

Jim Blandy's avatar
Jim Blandy committed
105
(defvar Info-current-file nil
106 107 108
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
It doesn't contain directory names or file name extensions added by Info.")
Jim Blandy's avatar
Jim Blandy committed
109 110 111 112 113 114 115 116 117 118 119 120

(defvar Info-current-subfile nil
  "Info subfile that is actually in the *info* buffer now,
or nil if current info file is not split into subfiles.")

(defvar Info-current-node nil
  "Name of node that Info is now looking at, or nil.")

(defvar Info-tag-table-marker (make-marker)
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

121 122 123
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

124 125 126
(defvar Info-index-alternatives nil
  "List of possible matches for last Info-index command.")

127 128 129
(defvar Info-standalone nil
  "Non-nil if Emacs was started solely as an Info browser.")

130 131 132 133
(defvar Info-suffix-list
  (if (eq system-type 'ms-dos)
      '( (".gz"      . "gunzip")
	 (".z"       . "gunzip")
134
	 (".inf"     . nil)
135 136 137 138 139 140 141 142 143 144 145
	 (""         . nil))
    '( (".info.Z"  . "uncompress")
       (".info.Y"  . "unyabba")
       (".info.gz" . "gunzip")
       (".info.z"  . "gunzip")
       (".info"    . nil)
       (".Z"       . "uncompress")
       (".Y"       . "unyabba")
       (".gz"      . "gunzip")
       (".z"       . "gunzip")
       (""         . nil)))
146 147
  "List of file name suffixes and associated decoding commands.
Each entry should be (SUFFIX . STRING); the file is given to
148 149 150
the command as standard input.  If STRING is nil, no decoding is done.
Because the SUFFIXes are tried in order, the empty string should
be last in the list.")
151

152
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
153 154 155 156 157 158
;; First, on ms-dos, delete some of the extension in FILENAME
;; to make room.
(defun info-insert-file-contents-1 (filename suffix)
  (if (not (eq system-type 'ms-dos))
      (concat filename suffix)
    (let* ((sans-exts (file-name-sans-extension filename))
159 160 161
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
162
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
163
      ;; get rid of the one in SUFFIX (unless suffix is empty).
164
      (or (and (<= ext-len 0)
165
	       (not (eq (aref filename (1- (length filename))) ?.)))
166
	  (= (length suffix) 0)
167
	  (setq suffix (substring suffix 1)))
168 169
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
170 171 172 173 174
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

175 176 177
(defun info-insert-file-contents (filename &optional visit)
  "Insert the contents of an info file in the current buffer.
Do the right thing if the file has been compressed or zipped."
178 179 180
  (let ((tail Info-suffix-list)
	fullname decoder)
    (if (file-exists-p filename)
181 182
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
183 184 185 186 187 188 189 190
	(progn
	  (while (and tail
		      (not (string-match
			    (concat (regexp-quote (car (car tail))) "$")
			    filename)))
	    (setq tail (cdr tail)))
	  (setq fullname filename
		decoder (cdr (car tail))))
191
      ;; Try adding suffixes to FILENAME and see if we can find something.
192
      (while (and tail
193 194
		  (not (file-exists-p (info-insert-file-contents-1
				       filename (car (car tail))))))
195
	(setq tail (cdr tail)))
196 197
      ;; If we found a file with a suffix, set DECODER according to the suffix
      ;; and set FULLNAME to the file's actual name.
198
      (setq fullname (info-insert-file-contents-1 filename (car (car tail)))
199 200
	    decoder (cdr (car tail)))
      (or tail
201
	  (error "Can't find %s or any compressed version of it" filename)))
202 203 204 205 206
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
207 208
    (insert-file-contents fullname visit)
    (if decoder
209
	(let ((buffer-read-only nil)
210 211
	      (default-directory (or (file-name-directory fullname)
				     default-directory)))
212
	  (call-process-region (point-min) (point-max) decoder t t)))))
213

214
;;;###autoload (add-hook 'same-window-buffer-names "*info*")
215

Jim Blandy's avatar
Jim Blandy committed
216 217 218 219 220 221 222
;;;###autoload
(defun info (&optional file)
  "Enter Info, the documentation browser.
Optional argument FILE specifies the file to examine;
the default is the top-level directory of Info.

In interactive use, a prefix argument directs this command
Richard M. Stallman's avatar
Richard M. Stallman committed
223 224 225 226 227
to read a file name from the minibuffer.

The search path for Info files is in the variable `Info-directory-list'.
The top-level Info directory is made by combining all the files named `dir' 
in all the directories in that path."
Jim Blandy's avatar
Jim Blandy committed
228 229 230 231 232
  (interactive (if current-prefix-arg
		   (list (read-file-name "Info file name: " nil nil t))))
  (if file
      (Info-goto-node (concat "(" file ")"))
    (if (get-buffer "*info*")
233
	(pop-to-buffer "*info*")
Jim Blandy's avatar
Jim Blandy committed
234 235
      (Info-directory))))

236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
;;;###autoload
(defun info-standalone ()
  "Run Emacs as a standalone Info reader.
Usage:  emacs -f info-standalone [filename]
In standalone mode, \\<Info-mode-map>\\[Info-exit] exits Emacs itself."
  (setq Info-standalone t)
  (if (and command-line-args-left
	   (not (string-match "^-" (car command-line-args-left))))
      (condition-case err
	  (progn
	    (info (car command-line-args-left))
	    (setq command-line-args-left (cdr command-line-args-left)))
	(error (send-string-to-terminal
		(format "%s\n" (if (eq (car-safe err) 'error)
				   (nth 1 err) err)))
	       (save-buffers-kill-emacs)))
    (info)))

Jim Blandy's avatar
Jim Blandy committed
254 255 256 257 258 259 260 261 262
;; Go to an info node specified as separate filename and nodename.
;; no-going-back is non-nil if recovering from an error in this function;
;; it says do not attempt further (recursive) error recovery.
(defun Info-find-node (filename nodename &optional no-going-back)
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
  (if filename
      (let (temp temp-downcase found)
	(setq filename (substitute-in-file-name filename))
263
	(if (string= (downcase filename) "dir")
264 265 266 267 268
	    (setq found t)
	  (let ((dirs (if (string-match "^\\./" filename)
			  ;; If specified name starts with `./'
			  ;; then just try current directory.
			  '("./")
269 270 271 272 273 274 275 276
			(if (file-name-absolute-p filename)
			    ;; No point in searching for an
			    ;; absolute file name
			    '(nil)
			  (if Info-additional-directory-list
			      (append Info-directory-list
				      Info-additional-directory-list)
			    Info-directory-list)))))
277 278 279 280 281 282
	    ;; Search the directory list for file FILENAME.
	    (while (and dirs (not found))
	      (setq temp (expand-file-name filename (car dirs)))
	      (setq temp-downcase
		    (expand-file-name (downcase filename) (car dirs)))
	      ;; Try several variants of specified name.
283 284 285
	      (let ((suffix-list Info-suffix-list))
		(while (and suffix-list (not found))
		  (cond ((file-exists-p
286 287
			  (info-insert-file-contents-1
			   temp (car (car suffix-list))))
288 289
			 (setq found temp))
			((file-exists-p
290 291
			  (info-insert-file-contents-1
			   temp-downcase (car (car suffix-list))))
292 293
			 (setq found temp-downcase)))
		  (setq suffix-list (cdr suffix-list))))
294
	      (setq dirs (cdr dirs)))))
Jim Blandy's avatar
Jim Blandy committed
295 296 297 298 299 300 301 302 303
	(if found
	    (setq filename found)
	  (error "Info file %s does not exist" filename))))
  ;; Record the node we are leaving.
  (if (and Info-current-file (not no-going-back))
      (setq Info-history
	    (cons (list Info-current-file Info-current-node (point))
		  Info-history)))
  ;; Go into info buffer.
304
  (pop-to-buffer "*info*")
305
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
306 307 308 309 310 311 312 313 314 315 316 317
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
      (progn
	;; Switch files if necessary
	(or (null filename)
	    (equal Info-current-file filename)
	    (let ((buffer-read-only nil))
	      (setq Info-current-file nil
		    Info-current-subfile nil
318
		    Info-current-file-completions nil
319
		    Info-index-alternatives nil
Jim Blandy's avatar
Jim Blandy committed
320 321
		    buffer-file-name nil)
	      (erase-buffer)
322 323
	      (if (eq filename t)
		  (Info-insert-dir)
324
		(info-insert-file-contents filename t)
325
		(setq default-directory (file-name-directory filename)))
Jim Blandy's avatar
Jim Blandy committed
326 327 328 329 330
	      (set-buffer-modified-p nil)
	      ;; See whether file has a tag table.  Record the location if yes.
	      (set-marker Info-tag-table-marker nil)
	      (goto-char (point-max))
	      (forward-line -8)
331 332
	      ;; Use string-equal, not equal, to ignore text props.
	      (or (string-equal nodename "*")
Jim Blandy's avatar
Jim Blandy committed
333 334 335 336 337 338 339 340 341 342 343 344 345 346
		  (not (search-forward "\^_\nEnd tag table\n" nil t))
		  (let (pos)
		    ;; We have a tag table.  Find its beginning.
		    ;; Is this an indirect file?
		    (search-backward "\nTag table:\n")
		    (setq pos (point))
		    (if (save-excursion
			  (forward-line 2)
			  (looking-at "(Indirect)\n"))
			;; It is indirect.  Copy it to another buffer
			;; and record that the tag table is in that buffer.
			(save-excursion
			  (let ((buf (current-buffer)))
			    (set-buffer (get-buffer-create " *info tag table*"))
347
                            (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
348 349 350 351 352
			    (setq case-fold-search t)
			    (erase-buffer)
			    (insert-buffer-substring buf)
			    (set-marker Info-tag-table-marker
					(match-end 0))))
Jim Blandy's avatar
Jim Blandy committed
353
		      (set-marker Info-tag-table-marker pos))))
Jim Blandy's avatar
Jim Blandy committed
354
	      (setq Info-current-file
355
		    (if (eq filename t) "dir" filename))))
356 357
	;; Use string-equal, not equal, to ignore text props.
	(if (string-equal nodename "*")
Jim Blandy's avatar
Jim Blandy committed
358 359 360
	    (progn (setq Info-current-node nodename)
		   (Info-set-mode-line))
	  ;; Search file for a suitable node.
361 362 363 364 365
	  (let ((guesspos (point-min))
		(regexp (concat "Node: *" (regexp-quote nodename) " *[,\t\n\177]")))
	    ;; First get advice from tag table if file has one.
	    ;; Also, if this is an indirect info file,
	    ;; read the proper subfile into this buffer.
Jim Blandy's avatar
Jim Blandy committed
366 367 368 369
	    (if (marker-position Info-tag-table-marker)
		(save-excursion
		  (set-buffer (marker-buffer Info-tag-table-marker))
		  (goto-char Info-tag-table-marker)
370
		  (if (re-search-forward regexp nil t)
Jim Blandy's avatar
Jim Blandy committed
371 372 373 374 375 376 377 378
		      (progn
			(setq guesspos (read (current-buffer)))
			;; If this is an indirect file,
			;; determine which file really holds this node
			;; and read it in.
			(if (not (eq (current-buffer) (get-buffer "*info*")))
			    (setq guesspos
				  (Info-read-subfile guesspos))))
379
		    (error "No such node: %s" nodename))))
380 381 382
	    (goto-char (max (point-min) (- guesspos 1000)))
	    ;; Now search from our advised position (or from beg of buffer)
	    ;; to find the actual node.
Jim Blandy's avatar
Jim Blandy committed
383 384 385 386 387 388 389 390 391 392 393
	    (catch 'foo
	      (while (search-forward "\n\^_" nil t)
		(forward-line 1)
		(let ((beg (point)))
		  (forward-line 1)
		  (if (re-search-backward regexp beg t)
		      (throw 'foo t))))
	      (error "No such node: %s" nodename)))
	  (Info-select-node)))
    ;; If we did not finish finding the specified node,
    ;; go back to the previous one.
394
    (or Info-current-node no-going-back (null Info-history)
Jim Blandy's avatar
Jim Blandy committed
395 396 397 398 399 400
	(let ((hist (car Info-history)))
	  (setq Info-history (cdr Info-history))
	  (Info-find-node (nth 0 hist) (nth 1 hist) t)
	  (goto-char (nth 2 hist)))))
  (goto-char (point-min)))

401 402
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
403 404
(defvar Info-dir-contents nil)

405 406 407 408
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

409 410 411 412
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

413
;; Construct the Info directory node by merging the files named `dir'
414 415 416
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
417
(defun Info-insert-dir ()
418 419 420 421 422
  (if (and Info-dir-contents Info-dir-file-attributes
	   ;; Verify that none of the files we used has changed
	   ;; since we used it.
	   (eval (cons 'and
		       (mapcar '(lambda (elt)
423 424 425 426 427
				  (let ((curr (file-attributes (car elt))))
				    ;; Don't compare the access time.
				    (if curr (setcar (nthcdr 4 curr) 0))
				    (setcar (nthcdr 4 (cdr elt)) 0)
				    (equal (cdr elt) curr)))
428
			       Info-dir-file-attributes))))
429 430
      (insert Info-dir-contents)
    (let ((dirs Info-directory-list)
431
	  buffers buffer others nodes dirs-done)
432

433 434
      (setq Info-dir-file-attributes nil)

435
      ;; Search the directory list for the directory file.
436
      (while dirs
437 438 439 440 441
	(let ((truename (file-truename (expand-file-name (car dirs)))))
	  (or (member truename dirs-done)
	      (member (directory-file-name truename) dirs-done)
	      ;; Try several variants of specified name.
	      ;; Try upcasing, appending `.info', or both.
442 443 444 445 446 447 448 449 450 451 452
	      (let* (file
		     (attrs
		      (or
		       (progn (setq file (expand-file-name "dir" truename))
			      (file-attributes file))
		       (progn (setq file (expand-file-name "DIR" truename))
			      (file-attributes file))
		       (progn (setq file (expand-file-name "dir.info" truename))
			      (file-attributes file))
		       (progn (setq file (expand-file-name "DIR.INFO" truename))
			      (file-attributes file)))))
453 454 455 456
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
457 458 459 460 461 462 463 464 465 466
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
		      (set-buffer (generate-new-buffer "info dir"))
		      (insert-file-contents file)
		      (setq buffers (cons (current-buffer) buffers)
			    Info-dir-file-attributes
			    (cons (cons file attrs)
				  Info-dir-file-attributes))))))
467 468
	  (or (cdr dirs) (setq Info-dir-contents-directory
			       (file-name-as-directory (car dirs))))
469 470
	  (setq dirs (cdr dirs))))
      
471
      (or buffers
472
	  (error "Can't find the Info directory node"))
473
      ;; Distinguish the dir file that comes with Emacs from all the
474 475
      ;; others.  Yes, that is really what this is supposed to do.
      ;; If it doesn't work, fix it.
476 477
      (setq buffer (car buffers)
	    others (cdr buffers))
478

479 480 481
      ;; Insert the entire original dir file as a start; note that we've
      ;; already saved its default directory to use as the default
      ;; directory for the whole concatenation.
482
      (insert-buffer buffer)
483

484 485 486 487 488 489 490 491 492 493 494 495
      ;; Look at each of the other buffers one by one.
      (while others
	(let ((other (car others)))
	  ;; In each, find all the menus.
	  (save-excursion
	    (set-buffer other)
	    (goto-char (point-min))
	    ;; Find each menu, and add an elt to NODES for it.
	    (while (re-search-forward "^\\* Menu:" nil t)
	      (let (beg nodename end)
		(forward-line 1)
		(setq beg (point))
496
		(search-backward "\n\^_")
497 498
		(search-forward "Node: ")
		(setq nodename (Info-following-node-name))
499
		(search-forward "\n\^_" nil 'move)
500 501 502 503 504 505 506 507 508 509
		(beginning-of-line)
		(setq end (point))
		(setq nodes (cons (list nodename other beg end) nodes))))))
	(setq others (cdr others)))
      ;; Add to the main menu a menu item for each other node.
      (re-search-forward "^\\* Menu:")
      (forward-line 1)
      (let ((menu-items '("top"))
	    (nodes nodes)
	    (case-fold-search t)
510
	    (end (save-excursion (search-forward "\^_" nil t) (point))))
511 512
	(while nodes
	  (let ((nodename (car (car nodes))))
513 514 515 516 517 518 519 520 521
	    (save-excursion
	      (or (member (downcase nodename) menu-items)
		  (re-search-forward (concat "^\\* "
					     (regexp-quote nodename)
					     "::")
				     end t)
		  (progn
		    (insert "* " nodename "::" "\n")
		    (setq menu-items (cons nodename menu-items))))))
522 523 524 525 526 527 528
	  (setq nodes (cdr nodes))))
      ;; Now take each node of each of the other buffers
      ;; and merge it into the main buffer.
      (while nodes
	(let ((nodename (car (car nodes))))
	  (goto-char (point-min))
	  ;; Find the like-named node in the main buffer.
529
	  (if (re-search-forward (concat "\n\^_.*\n.*Node: "
530 531 532 533
					 (regexp-quote nodename)
					 "[,\n\t]")
				 nil t)
	      (progn
534
		(search-forward "\n\^_" nil 'move)
535 536
		(beginning-of-line)
		(insert "\n"))
537 538
	    ;; If none exists, add one.
	    (goto-char (point-max))
539
	    (insert "\^_\nFile: dir\tNode: " nodename "\n\n* Menu:\n\n"))
540 541
	  ;; Merge the text from the other buffer's menu
	  ;; into the menu in the like-named node in the main buffer.
542
	  (apply 'insert-buffer-substring (cdr (car nodes))))
543 544 545 546
	(setq nodes (cdr nodes)))
      ;; Kill all the buffers we just made.
      (while buffers
	(kill-buffer (car buffers))
547 548
	(setq buffers (cdr buffers)))
      (message "Composing main Info directory...done"))
549 550
    (setq Info-dir-contents (buffer-string)))
  (setq default-directory Info-dir-contents-directory))
551

Jim Blandy's avatar
Jim Blandy committed
552
(defun Info-read-subfile (nodepos)
553 554
  ;; NODEPOS is either a position (in the Info file as a whole,
  ;; not relative to a subfile) or the name of a subfile.
Jim Blandy's avatar
Jim Blandy committed
555 556
  (let (lastfilepos
	lastfilename)
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
    (if (numberp nodepos)
	(save-excursion
	  (set-buffer (marker-buffer Info-tag-table-marker))
	  (goto-char (point-min))
	  (search-forward "\n\^_")
	  (forward-line 2)
	  (catch 'foo
	    (while (not (looking-at "\^_"))
	      (if (not (eolp))
		  (let ((beg (point))
			thisfilepos thisfilename)
		    (search-forward ": ")
		    (setq thisfilename  (buffer-substring beg (- (point) 2)))
		    (setq thisfilepos (read (current-buffer)))
		    ;; read in version 19 stops at the end of number.
		    ;; Advance to the next line.
		    (forward-line 1)
		    (if (> thisfilepos nodepos)
			(throw 'foo t))
		    (setq lastfilename thisfilename)
		    (setq lastfilepos thisfilepos))
		(forward-line 1)))))
      (setq lastfilename nodepos)
      (setq lastfilepos 0))
Jim Blandy's avatar
Jim Blandy committed
581 582 583 584 585 586
    (set-buffer (get-buffer "*info*"))
    (or (equal Info-current-subfile lastfilename)
	(let ((buffer-read-only nil))
	  (setq buffer-file-name nil)
	  (widen)
	  (erase-buffer)
587
	  (info-insert-file-contents lastfilename)
Jim Blandy's avatar
Jim Blandy committed
588 589 590 591
	  (set-buffer-modified-p nil)
	  (setq Info-current-subfile lastfilename)))
    (goto-char (point-min))
    (search-forward "\n\^_")
592 593
    (if (numberp nodepos)
	(+ (- nodepos lastfilepos) (point)))))
Jim Blandy's avatar
Jim Blandy committed
594 595 596 597 598 599 600 601 602 603

;; Select the info node that point is in.
(defun Info-select-node ()
  (save-excursion
   ;; Find beginning of node.
   (search-backward "\n\^_")
   (forward-line 2)
   ;; Get nodename spelled as it is in the node.
   (re-search-forward "Node:[ \t]*")
   (setq Info-current-node
604 605 606 607
	 (buffer-substring-no-properties (point)
					 (progn
					  (skip-chars-forward "^,\t\n")
					  (point))))
Jim Blandy's avatar
Jim Blandy committed
608 609 610 611 612 613 614 615 616 617 618 619 620 621
   (Info-set-mode-line)
   ;; Find the end of it, and narrow.
   (beginning-of-line)
   (let (active-expression)
     (narrow-to-region (point)
		       (if (re-search-forward "\n[\^_\f]" nil t)
			   (prog1
			    (1- (point))
			    (if (looking-at "[\n\^_\f]*execute: ")
				(progn
				  (goto-char (match-end 0))
				  (setq active-expression
					(read (current-buffer))))))
			 (point-max)))
622
     (if Info-enable-active-nodes (eval active-expression))
623
     (if Info-fontify (Info-fontify-node))
624
     (run-hooks 'Info-selection-hook))))
Jim Blandy's avatar
Jim Blandy committed
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640

(defun Info-set-mode-line ()
  (setq mode-line-buffer-identification
	(concat
	 "Info:  ("
	 (if Info-current-file
	     (file-name-nondirectory Info-current-file)
	   "")
	 ")"
	 (or Info-current-node ""))))

;; Go to an info node specified with a filename-and-nodename string
;; of the sort that is found in pointers in nodes.

(defun Info-goto-node (nodename)
  "Go to info node named NAME.  Give just NODENAME or (FILENAME)NODENAME."
641
  (interactive (list (Info-read-node-name "Goto node: ")))
Jim Blandy's avatar
Jim Blandy committed
642 643 644 645 646 647 648 649 650 651 652
  (let (filename)
    (string-match "\\s *\\((\\s *\\([^\t)]*\\)\\s *)\\s *\\|\\)\\(.*\\)"
		  nodename)
    (setq filename (if (= (match-beginning 1) (match-end 1))
		       ""
		     (substring nodename (match-beginning 2) (match-end 2)))
	  nodename (substring nodename (match-beginning 3) (match-end 3)))
    (let ((trim (string-match "\\s *\\'" filename)))
      (if trim (setq filename (substring filename 0 trim))))
    (let ((trim (string-match "\\s *\\'" nodename)))
      (if trim (setq nodename (substring nodename 0 trim))))
653
    (if transient-mark-mode (deactivate-mark))
Jim Blandy's avatar
Jim Blandy committed
654 655
    (Info-find-node (if (equal filename "") nil filename)
		    (if (equal nodename "") "Top" nodename))))
656

657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
;; This function is used as the "completion table" while reading a node name.
;; It does completion using the alist in completion-table
;; unless STRING starts with an open-paren.
(defun Info-read-node-name-1 (string predicate code)
  (let ((no-completion (and (> (length string) 0) (eq (aref string 0) ?\())))
    (cond ((eq code nil)
	   (if no-completion
	       string
	     (try-completion string completion-table predicate)))
	  ((eq code t)
	   (if no-completion
	       nil
	     (all-completions string completion-table predicate)))
	  ((eq code 'lambda)
	   (if no-completion
	       t
	     (assoc string completion-table))))))

675 676
(defun Info-read-node-name (prompt &optional default)
  (let* ((completion-ignore-case t)
677 678
	 (completion-table (Info-build-node-completions))
	 (nodename (completing-read prompt 'Info-read-node-name-1)))
679 680 681 682 683 684 685 686 687 688 689 690 691
    (if (equal nodename "")
	(or default
	    (Info-read-node-name prompt))
      nodename)))

(defun Info-build-node-completions ()
  (or Info-current-file-completions
      (let ((compl nil))
	(save-excursion
	  (save-restriction
	    (if (marker-buffer Info-tag-table-marker)
		(progn
		  (set-buffer (marker-buffer Info-tag-table-marker))
692
		  (widen)
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
		  (goto-char Info-tag-table-marker)
		  (while (re-search-forward "\nNode: \\(.*\\)\177" nil t)
		    (setq compl
			  (cons (list (buffer-substring (match-beginning 1)
							(match-end 1)))
				compl))))
	      (widen)
	      (goto-char (point-min))
	      (while (search-forward "\n\^_" nil t)
		(forward-line 1)
		(let ((beg (point)))
		  (forward-line 1)
		  (if (re-search-backward "Node: *\\([^,\n]*\\) *[,\n\t]"
					  beg t)
		      (setq compl 
			    (cons (list (buffer-substring (match-beginning 1)
							  (match-end 1)))
				  compl))))))))
	(setq Info-current-file-completions compl))))
Jim Blandy's avatar
Jim Blandy committed
712

Jim Blandy's avatar
Jim Blandy committed
713 714
(defun Info-restore-point (hl)
  "If this node has been visited, restore the point value when we left."
715 716
  (while hl
    (if (and (equal (nth 0 (car hl)) Info-current-file)
717 718
	     ;; Use string-equal, not equal, to ignore text props.
	     (string-equal (nth 1 (car hl)) Info-current-node))
719
	(progn
720 721
	  (goto-char (nth 2 (car hl)))
	  (setq hl nil))		;terminate the while at next iter
722
      (setq hl (cdr hl)))))
Jim Blandy's avatar
Jim Blandy committed
723

Jim Blandy's avatar
Jim Blandy committed
724
(defvar Info-last-search nil
725
  "Default regexp for \\<Info-mode-map>\\[Info-search] command to search for.")
Jim Blandy's avatar
Jim Blandy committed
726 727 728 729

(defun Info-search (regexp)
  "Search for REGEXP, starting from point, and select node it's found in."
  (interactive "sSearch (regexp): ")
730
  (if transient-mark-mode (deactivate-mark))
Jim Blandy's avatar
Jim Blandy committed
731 732 733 734 735 736 737
  (if (equal regexp "")
      (setq regexp Info-last-search)
    (setq Info-last-search regexp))
  (let ((found ()) current
	(onode Info-current-node)
	(ofile Info-current-file)
	(opoint (point))
738
	(ostart (window-start))
Jim Blandy's avatar
Jim Blandy committed
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
	(osubfile Info-current-subfile))
    (save-excursion
      (save-restriction
	(widen)
	(if (null Info-current-subfile)
	    (progn (re-search-forward regexp) (setq found (point)))
	  (condition-case err
	      (progn (re-search-forward regexp) (setq found (point)))
	    (search-failed nil)))))
    (if (not found) ;can only happen in subfile case -- else would have erred
	(unwind-protect
	    (let ((list ()))
	      (set-buffer (marker-buffer Info-tag-table-marker))
	      (goto-char (point-min))
	      (search-forward "\n\^_\nIndirect:")
	      (save-restriction
		(narrow-to-region (point)
				  (progn (search-forward "\n\^_")
					 (1- (point))))
		(goto-char (point-min))
		(search-forward (concat "\n" osubfile ": "))
		(beginning-of-line)
		(while (not (eobp))
		  (re-search-forward "\\(^.*\\): [0-9]+$")
		  (goto-char (+ (match-end 1) 2))
		  (setq list (cons (cons (read (current-buffer))
					 (buffer-substring (match-beginning 1)
							   (match-end 1)))
				   list))
		  (goto-char (1+ (match-end 0))))
		(setq list (nreverse list)
		      current (car (car list))
		      list (cdr list)))
	      (while list
		(message "Searching subfile %s..." (cdr (car list)))
		(Info-read-subfile (car (car list)))
		(setq list (cdr list))
776
;;		(goto-char (point-min))
Jim Blandy's avatar
Jim Blandy committed
777 778 779 780 781 782
		(if (re-search-forward regexp nil t)
		    (setq found (point) list ())))
	      (if found
		  (message "")
		(signal 'search-failed (list regexp))))
	  (if (not found)
783
	      (progn (Info-read-subfile osubfile)
Jim Blandy's avatar
Jim Blandy committed
784
		     (goto-char opoint)
785 786
		     (Info-select-node)
		     (set-window-start (selected-window) ostart)))))
Jim Blandy's avatar
Jim Blandy committed
787 788 789
    (widen)
    (goto-char found)
    (Info-select-node)
790 791
    ;; Use string-equal, not equal, to ignore text props.
    (or (and (string-equal onode Info-current-node)
Jim Blandy's avatar
Jim Blandy committed
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
	     (equal ofile Info-current-file))
	(setq Info-history (cons (list ofile onode opoint)
				 Info-history)))))

;; Extract the value of the node-pointer named NAME.
;; If there is none, use ERRORNAME in the error message; 
;; if ERRORNAME is nil, just return nil.
(defun Info-extract-pointer (name &optional errorname)
  (save-excursion
   (goto-char (point-min))
   (forward-line 1)
   (if (re-search-backward (concat name ":") nil t)
       (progn
	 (goto-char (match-end 0))
	 (Info-following-node-name))
     (if (eq errorname t)
	 nil
809
       (error "Node has no %s" (capitalize (or errorname name)))))))
Jim Blandy's avatar
Jim Blandy committed
810

811 812 813
;; Return the node name in the buffer following point.
;; ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
;; saying which chas may appear in the node name.
Jim Blandy's avatar
Jim Blandy committed
814 815
(defun Info-following-node-name (&optional allowedchars)
  (skip-chars-forward " \t")
816
  (buffer-substring-no-properties
Jim Blandy's avatar
Jim Blandy committed
817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
   (point)
   (progn
     (while (looking-at (concat "[" (or allowedchars "^,\t\n") "]"))
       (skip-chars-forward (concat (or allowedchars "^,\t\n") "("))
       (if (looking-at "(")
	   (skip-chars-forward "^)")))
     (skip-chars-backward " ")
     (point))))

(defun Info-next ()
  "Go to the next node of this node."
  (interactive)
  (Info-goto-node (Info-extract-pointer "next")))

(defun Info-prev ()
  "Go to the previous node of this node."
  (interactive)
  (Info-goto-node (Info-extract-pointer "prev[ious]*" "previous")))

(defun Info-up ()
  "Go to the superior node of this node."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
839 840
  (Info-goto-node (Info-extract-pointer "up"))
  (Info-restore-point Info-history))
Jim Blandy's avatar
Jim Blandy committed
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865

(defun Info-last ()
  "Go back to the last node visited."
  (interactive)
  (or Info-history
      (error "This is the first Info node you looked at"))
  (let (filename nodename opoint)
    (setq filename (car (car Info-history)))
    (setq nodename (car (cdr (car Info-history))))
    (setq opoint (car (cdr (cdr (car Info-history)))))
    (setq Info-history (cdr Info-history))
    (Info-find-node filename nodename)
    (setq Info-history (cdr Info-history))
    (goto-char opoint)))

(defun Info-directory ()
  "Go to the Info directory node."
  (interactive)
  (Info-find-node "dir" "top"))

(defun Info-follow-reference (footnotename)
  "Follow cross reference named NAME to the node it refers to.
NAME may be an abbreviation of the reference name."
  (interactive
   (let ((completion-ignore-case t)
866
	 completions default alt-default (start-point (point)) str i bol eol)
Jim Blandy's avatar
Jim Blandy committed
867
     (save-excursion
868 869 870 871 872 873
       ;; Store end and beginning of line.
       (end-of-line)
       (setq eol (point))
       (beginning-of-line)
       (setq bol (point))

Jim Blandy's avatar
Jim Blandy committed
874 875 876 877 878 879 880
       (goto-char (point-min))
       (while (re-search-forward "\\*note[ \n\t]*\\([^:]*\\):" nil t)
	 (setq str (buffer-substring
		    (match-beginning 1)
		    (1- (point))))
	 ;; See if this one should be the default.
	 (and (null default)
881
	      (<= (match-beginning 0) start-point)
Jim Blandy's avatar
Jim Blandy committed
882 883
	      (<= start-point (point))
	      (setq default t))
884 885 886 887 888
	 ;; See if this one should be the alternate default.
	 (and (null alt-default)
	      (and (<= bol (match-beginning 0))
		   (<= (point) eol))
	      (setq alt-default t))
Jim Blandy's avatar
Jim Blandy committed
889 890 891 892 893 894 895
	 (setq i 0)
	 (while (setq i (string-match "[ \n\t]+" str i))
	   (setq str (concat (substring str 0 i) " "
			     (substring str (match-end 0))))
	   (setq i (1+ i)))
	 ;; Record as a completion and perhaps as default.
	 (if (eq default t) (setq default str))
896
	 (if (eq alt-default t) (setq alt-default str))
Jim Blandy's avatar
Jim Blandy committed
897 898 899
	 (setq completions
	       (cons (cons str nil)
		     completions))))
900 901 902 903 904 905
     ;; If no good default was found, try an alternate.
     (or default
	 (setq default alt-default))
     ;; If only one cross-reference found, then make it default.
     (if (eq (length completions) 1)
         (setq default (car (car completions))))
Jim Blandy's avatar
Jim Blandy committed
906
     (if completions
907 908 909 910 911 912 913
	 (let ((input (completing-read (if default
					   (concat "Follow reference named: ("
						   default ") ")
					 "Follow reference named: ")
				       completions nil t)))
	   (list (if (equal input "")
		     default input)))
Jim Blandy's avatar
Jim Blandy committed
914
       (error "No cross-references in this node"))))
915
  (let (target beg i (str (concat "\\*note " (regexp-quote footnotename))))
Jim Blandy's avatar
Jim Blandy committed
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
    (while (setq i (string-match " " str i))
      (setq str (concat (substring str 0 i) "[ \t\n]+" (substring str (1+ i))))
      (setq i (+ i 6)))
    (save-excursion
      (goto-char (point-min))
      (or (re-search-forward str nil t)
	  (error "No cross-reference named %s" footnotename))
      (goto-char (+ (match-beginning 0) 5))
      (setq target
	    (Info-extract-menu-node-name "Bad format cross reference" t)))
    (while (setq i (string-match "[ \t\n]+" target i))
      (setq target (concat (substring target 0 i) " "
			   (substring target (match-end 0))))
      (setq i (+ i 1)))
    (Info-goto-node target)))

(defun Info-extract-menu-node-name (&optional errmessage multi-line)
  (skip-chars-forward " \t\n")
  (let ((beg (point))
	str i)
    (skip-chars-forward "^:")
    (forward-char 1)
    (setq str
	  (if (looking-at ":")
940
	      (buffer-substring-no-properties beg (1- (point)))
Jim Blandy's avatar
Jim Blandy committed
941 942 943 944
	    (skip-chars-forward " \t\n")
	    (Info-following-node-name (if multi-line "^.,\t" "^.,\t\n"))))
    (while (setq i (string-match "\n" str i))
      (aset str i ?\ ))
945 946 947
    ;; Collapse multiple spaces.
    (while (string-match "  +" str)
      (setq str (replace-match " " t t str)))
Jim Blandy's avatar
Jim Blandy committed
948 949
    str))

950
;; No one calls this.
951 952
;;(defun Info-menu-item-sequence (list)
;;  (while list
953
;;    (Info-menu (car list))
954
;;    (setq list (cdr list))))
Jim Blandy's avatar
Jim Blandy committed
955

956 957 958 959 960 961 962 963 964 965
(defun Info-complete-menu-item (string predicate action)
  (let ((case-fold-search t))
    (cond ((eq action nil)
	   (let (completions
		 (pattern (concat "\n\\* \\("
				  (regexp-quote string)
				  "[^:\t\n]*\\):")))
	     (save-excursion
	       (set-buffer Info-complete-menu-buffer)
	       (goto-char (point-min))
966
	       (search-forward "\n* Menu:")
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
	       (while (re-search-forward pattern nil t)
		 (setq completions (cons (cons (format "%s"
						       (buffer-substring
							(match-beginning 1)
							(match-end 1)))
					       (match-beginning 1))
					 completions))))
	     (try-completion string completions predicate)))
	  ((eq action t)
	   (let (completions
		 (pattern (concat "\n\\* \\("
				  (regexp-quote string)
				  "[^:\t\n]*\\):")))
	     (save-excursion
	       (set-buffer Info-complete-menu-buffer)
	       (goto-char (point-min))
983
	       (search-forward "\n* Menu:")
984 985 986 987 988 989 990 991 992 993 994 995
	       (while (re-search-forward pattern nil t)
		 (setq completions (cons (cons (format "%s"
						       (buffer-substring
							(match-beginning 1)
							(match-end 1)))
					       (match-beginning 1))
					 completions))))
	     (all-completions string completions predicate)))
	  (t
	   (save-excursion
	     (set-buffer Info-complete-menu-buffer)
	     (goto-char (point-min))
996
	     (search-forward "\n* Menu:")
997 998 999 1000 1001 1002
	     (re-search-forward (concat "\n\\* "
					(regexp-quote string)
					":")
				nil t))))))


Jim Blandy's avatar
Jim Blandy committed
1003 1004 1005 1006 1007 1008 1009 1010
(defun Info-menu (menu-item)
  "Go to node for menu item named (or abbreviated) NAME.
Completion is allowed, and the menu item point is on is the default."
  (interactive
   (let ((completions '())
	 ;; If point is within a menu item, use that item as the default
	 (default nil)
	 (p (point))
1011
	 beg
Jim Blandy's avatar
Jim Blandy committed
1012 1013 1014 1015 1016
	 (last nil))
     (save-excursion
       (goto-char (point-min))
       (if (not (search-forward "\n* menu:" nil t))
	   (error "No menu in this node"))
1017 1018 1019 1020 1021 1022 1023 1024 1025
       (setq beg (point))
       (and (< (point) p)
	    (save-excursion
	      (goto-char p)
	      (end-of-line)
	      (re-search-backward "\n\\* \\([^:\t\n]*\\):" beg t)
	      (setq default (format "%s" (buffer-substring
					  (match-beginning 1)
					  (match-end 1)))))))
Jim Blandy's avatar
Jim Blandy committed
1026 1027
     (let ((item nil))
       (while (null item)
1028 1029
	 (setq item (let ((completion-ignore-case t)
			  (Info-complete-menu-buffer (current-buffer)))
Jim Blandy's avatar
Jim Blandy committed
1030 1031 1032 1033
		      (completing-read (if default
					   (format "Menu item (default %s): "
						   default)
					   "Menu item: ")
1034
				       'Info-complete-menu-item nil t)))
Jim Blandy's avatar
Jim Blandy committed
1035 1036 1037
	 ;; we rely on the fact that completing-read accepts an input
	 ;; of "" even when the require-match argument is true and ""
	 ;; is not a valid possibility
Jim Blandy's avatar
Jim Blandy committed
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
	 (if (string= item "")
	     (if default
		 (setq item default)
	         ;; ask again
	         (setq item nil))))
       (list item))))
  ;; there is a problem here in that if several menu items have the same
  ;; name you can only go to the node of the first with this command.
  (Info-goto-node (Info-extract-menu-item menu-item)))
  
(defun Info-extract-menu-item (menu-item)
  (setq menu-item (regexp-quote menu-item))
  (save-excursion
    (goto-char (point-min))
    (or (search-forward "\n* menu:" nil t)
	(error "No menu in this node"))
1054 1055
    (or (re-search-forward (concat "\n\\* " menu-item ":") nil t)
	(re-search-forward (concat "\n\\* " menu-item) nil t)
Jim Blandy's avatar
Jim Blandy committed
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
	(error "No such item in menu"))
    (beginning-of-line)
    (forward-char 2)
    (Info-extract-menu-node-name)))

;; If COUNT is nil, use the last item in the menu.
(defun Info-extract-menu-counting (count)
  (save-excursion
    (goto-char (point-min))
    (or (search-forward "\n* menu:" nil t)
	(error "No menu in this node"))
    (if count
	(or (search-forward "\n* " nil t count)
	    (error "Too few items in menu"))
      (while (search-forward "\n* " nil t)
	nil))
    (Info-extract-menu-node-name)))

1074 1075 1076
(defun Info-nth-menu-item ()
  "Go to the node of the Nth menu item.
N is the digit argument used to invoke this command."
Jim Blandy's avatar
Jim Blandy committed
1077
  (interactive)
1078 1079 1080
  (Info-goto-node
   (Info-extract-menu-counting
    (- (aref (this-command-keys) (1- (length (this-command-keys)))) ?0))))
Jim Blandy's avatar
Jim Blandy committed
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113

(defun Info-top-node ()
  "Go to the Top node of this file."
  (interactive)
  (Info-goto-node "Top"))

(defun Info-final-node ()
  "Go to the final node in this file."
  (interactive)
  (Info-goto-node "Top")
  (let (Info-history)
    ;; Go to the last node in the menu of Top.
    (Info-goto-node (Info-extract-menu-counting nil))
    ;; If the last node in the menu is not last in pointer structure,
    ;; move forward until we can't go any farther. 
    (while (Info-forward-node t t) nil)
    ;; Then keep moving down to last subnode, unless we reach an index.
    (while (and (not (string-match "\\<index\\>" Info-current-node))
		(save-excursion (search-forward "\n* Menu:" nil t)))
      (Info-goto-node (Info-extract-menu-counting nil)))))

(defun Info-forward-node (&optional not-down no-error)
  "Go forward one node, considering all nodes as forming one sequence."
  (interactive)
  (goto-char (point-min))
  (forward-line 1)
  ;; three possibilities, in order of priority:
  ;;     1. next node is in a menu in this node (but not in an index)
  ;;     2. next node is next at same level
  ;;     3. next node is up and next
  (cond ((and (not not-down)
              (save-excursion (search-forward "\n* menu:" nil t))
	      (not (string-match "\\<index\\>" Info-current-node)))
1114
	 (Info-goto-node (Info-extract-menu-counting 1))
Jim Blandy's avatar
Jim Blandy committed
1115 1116 1117 1118 1119
         t)
        ((save-excursion (search-backward "next:" nil t))
         (Info-next)
         t)
        ((and (save-excursion (search-backward "up:" nil t))
1120 1121 1122
	      ;; Use string-equal, not equal, to ignore text props.
	      (not (string-equal (downcase (Info-extract-pointer "up"))
				 "top")))
Jim Blandy's avatar
Jim Blandy committed
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
         (let ((old-node Info-current-node))
           (Info-up)
           (let (Info-history success)
             (unwind-protect
                 (setq success (Info-forward-node t no-error))
               (or success (Info-goto-node old-node))))))
        (no-error nil)
        (t (error "No pointer forward from this node"))))

(defun Info-backward-node ()
  "Go backward one node, considering all nodes as forming one sequence."
  (interactive)
  (let ((prevnode (Info-extract-pointer "prev[ious]*" t))
	(upnode