info.el 76 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 4
;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 97 Free Software
;; Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

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

Jim Blandy's avatar
Jim Blandy committed
9 10 11 12
;; 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
13
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
14 15 16 17 18 19 20 21
;; 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
22 23 24
;; 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
25

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

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

;;; Code:

32 33 34 35 36 37
(defgroup info nil
  "Info subsystem"
  :group 'help
  :group 'docs)


Jim Blandy's avatar
Jim Blandy committed
38 39 40 41
(defvar Info-history nil
  "List of info nodes user has visited.
Each element of list is a list (FILENAME NODENAME BUFFERPOS).")

42
(defcustom Info-enable-edit nil
43
  "*Non-nil means the \\<Info-mode-map>\\[Info-edit] command in Info can edit the current node.
44 45 46
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,
47 48 49
because that gives you a printed manual as well."
  :type 'boolean
  :group 'info)
Jim Blandy's avatar
Jim Blandy committed
50

51
(defvar Info-enable-active-nodes nil
Jim Blandy's avatar
Jim Blandy committed
52 53
  "Non-nil allows Info to execute Lisp code associated with nodes.
The Lisp code is executed when the node is selected.")
54
(put 'Info-enable-active-nodes 'risky-local-variable t)
Jim Blandy's avatar
Jim Blandy committed
55

56 57 58 59
(defcustom Info-fontify t
  "*Non-nil enables highlighting and fonts in Info nodes."
  :type 'boolean
  :group 'info)
60

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
(defface info-node
  '((t (:bold t :italic t)))
  "Face for Info node names."
  :group 'info)

(defface info-menu-5
  '((t (:underline t)))
  "Face for the fifth and tenth `*' in an Info menu."
  :group 'info)

(defface info-xref
  '((t (:bold t)))
  "Face for Info cross-references."
  :group 'info)

76 77 78 79
(defcustom Info-fontify-maximum-menu-size 30000
  "*Maximum size of menu to fontify if `Info-fontify' is non-nil."
  :type 'integer
  :group 'info)
80

81
(defvar Info-directory-list
82
  (let ((path (getenv "INFOPATH"))
83 84 85 86
	;; 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) ";" ":")))
87
	(source (expand-file-name "info/" source-directory))
88
	(sibling (if installation-directory
89 90
		     (expand-file-name "info/" installation-directory)))
	alternative)
91 92 93 94
    (if path
	(let ((list nil)
	      idx)
	  (while (> (length path) 0)
95
	    (setq idx (or (string-match path-separator path) (length path))
96 97 98 99
		  list (cons (substring path 0 idx) list)
		  path (substring path (min (1+ idx)
					    (length path)))))
	  (nreverse list))
100 101 102 103 104
      (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))
105
	      ;; On DOS/NT, we use movable executables always,
106
	      ;; and we must always find the Info dir at run time.
107
	      (if (or (eq system-type 'ms-dos) (eq system-type 'windows-nt))
108 109 110 111
		  nil
		;; Use invocation-directory for Info only if we used it for
		;; exec-directory also.
		(not (string= exec-directory
112 113
			      (expand-file-name "lib-src/"
						installation-directory)))))
114
	  Info-default-directory-list
115 116
	(reverse (cons alternative
		       (cdr (reverse Info-default-directory-list)))))))
Jim Blandy's avatar
Jim Blandy committed
117
  "List of directories to search for Info documentation files.
Jim Blandy's avatar
Jim Blandy committed
118
nil means not yet initialized.  In this case, Info uses the environment
119
variable INFOPATH to initialize it, or `Info-default-directory-list'
120 121
if there is no INFOPATH variable in the environment.
The last element of `Info-default-directory-list' is the directory
122
where Emacs installs the Info files that come with it.
123 124 125 126 127

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
128

129
(defcustom Info-additional-directory-list nil
130
  "List of additional directories to search for Info documentation files.
131 132 133
These directories are not searched for merging the `dir' file."
  :type '(repeat directory)
  :group 'info)
134

Jim Blandy's avatar
Jim Blandy committed
135
(defvar Info-current-file nil
136 137 138
  "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
139 140 141 142 143 144 145 146

(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.")

147
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
148 149 150
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

151 152 153
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

154 155 156
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

157 158 159
(defvar Info-index-alternatives nil
  "List of possible matches for last Info-index command.")

160 161 162
(defvar Info-standalone nil
  "Non-nil if Emacs was started solely as an Info browser.")

163
(defvar Info-suffix-list
164 165
  ;; The MS-DOS list should work both when long file names are
  ;; supported (Windows 9X), and when only 8+3 file names are available.
166 167 168
  (if (eq system-type 'ms-dos)
      '( (".gz"      . "gunzip")
	 (".z"       . "gunzip")
169 170 171 172 173 174 175 176
	 (".inz"     . "gunzip")
	 (".igz"     . "gunzip")
	 (".info.Z"  . "gunzip")
	 (".info.gz" . "gunzip")
	 ("-info.Z"  . "gunzip")
	 ("-info.gz" . "gunzip")
	 ("/index.gz". "gunzip")
	 ("/index.z" . "gunzip")
177
	 (".inf"     . nil)
178 179 180
	 (".info"    . nil)
	 ("-info"    . nil)
	 ("/index"   . nil)
181
	 (""         . nil))
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
    '( (".info.Z".    "uncompress")
       (".info.Y".    "unyabba")
       (".info.gz".   "gunzip")
       (".info.z".    "gunzip")
       (".info".      nil)
       ("-info.Z".   "uncompress")
       ("-info.Y".   "unyabba")
       ("-info.gz".  "gunzip")
       ("-info.z".   "gunzip")
       ("-info".     nil)
       ("/index.Z".   "uncompress")
       ("/index.Y".   "unyabba")
       ("/index.gz".  "gunzip")
       ("/index.z".   "gunzip")
       ("/index".     nil)
       (".Z".         "uncompress")
       (".Y".         "unyabba")
       (".gz".        "gunzip")
       (".z".         "gunzip")
       ("".           nil)))
202 203
  "List of file name suffixes and associated decoding commands.
Each entry should be (SUFFIX . STRING); the file is given to
204 205 206
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.")
207

208
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
209 210 211 212 213 214
;; 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))
215 216 217
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
218
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
219
      ;; get rid of the one in SUFFIX (unless suffix is empty).
220
      (or (and (<= ext-len 0)
221
	       (not (eq (aref filename (1- (length filename))) ?.)))
222
	  (= (length suffix) 0)
223
	  (setq suffix (substring suffix 1)))
224 225
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
226 227 228 229 230
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

231 232 233 234
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

235 236 237
(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."
238 239 240
  (let ((tail Info-suffix-list)
	fullname decoder)
    (if (file-exists-p filename)
241 242
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
243 244 245 246 247 248 249 250
	(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))))
251
      ;; Try adding suffixes to FILENAME and see if we can find something.
252
      (while (and tail
253 254
		  (not (info-file-exists-p (info-insert-file-contents-1
					    filename (car (car tail))))))
255
	(setq tail (cdr tail)))
256 257
      ;; If we found a file with a suffix, set DECODER according to the suffix
      ;; and set FULLNAME to the file's actual name.
258
      (setq fullname (info-insert-file-contents-1 filename (car (car tail)))
259 260
	    decoder (cdr (car tail)))
      (or tail
261
	  (error "Can't find %s or any compressed version of it" filename)))
262 263 264 265 266
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
267
    (if decoder
268 269 270 271 272 273 274 275
	(progn
	  (insert-file-contents-literally fullname visit)
	  (let ((buffer-read-only nil)
		(coding-system-for-write 'no-conversion)
		(default-directory (or (file-name-directory fullname)
				       default-directory)))
	    (call-process-region (point-min) (point-max) decoder t t)))
      (insert-file-contents fullname visit))))
276

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

Jim Blandy's avatar
Jim Blandy committed
279 280 281 282 283 284 285
;;;###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
286 287 288 289 290
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
291 292 293
  (interactive (if current-prefix-arg
		   (list (read-file-name "Info file name: " nil nil t))))
  (if file
294 295 296 297 298
      (progn (pop-to-buffer "*info*")
	     (Info-goto-node (concat "(" file ")")))
    (if (get-buffer "*info*")
	(pop-to-buffer "*info*")
      (Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
299

300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
;;;###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
318 319 320 321 322 323 324 325 326
;; 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))
327
	(if (string= (downcase filename) "dir")
328 329 330 331 332
	    (setq found t)
	  (let ((dirs (if (string-match "^\\./" filename)
			  ;; If specified name starts with `./'
			  ;; then just try current directory.
			  '("./")
333 334 335 336 337 338 339 340
			(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)))))
341 342 343 344 345 346
	    ;; 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.
347 348
	      (let ((suffix-list Info-suffix-list))
		(while (and suffix-list (not found))
349
		  (cond ((info-file-exists-p
350 351
			  (info-insert-file-contents-1
			   temp (car (car suffix-list))))
352
			 (setq found temp))
353
			((info-file-exists-p
354 355
			  (info-insert-file-contents-1
			   temp-downcase (car (car suffix-list))))
356 357
			 (setq found temp-downcase)))
		  (setq suffix-list (cdr suffix-list))))
358
	      (setq dirs (cdr dirs)))))
Jim Blandy's avatar
Jim Blandy committed
359 360 361 362
	(if found
	    (setq filename found)
	  (error "Info file %s does not exist" filename))))
  ;; Go into info buffer.
363
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
364
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
365 366
  (or (eq major-mode 'Info-mode)
      (Info-mode))
367 368 369 370 371
  ;; 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)))
Jim Blandy's avatar
Jim Blandy committed
372 373 374 375 376 377 378 379 380 381
  (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
382
		    Info-current-file-completions nil
Jim Blandy's avatar
Jim Blandy committed
383 384
		    buffer-file-name nil)
	      (erase-buffer)
385 386
	      (if (eq filename t)
		  (Info-insert-dir)
387
		(info-insert-file-contents filename t)
388
		(setq default-directory (file-name-directory filename)))
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392
	      (set-buffer-modified-p nil)
	      ;; See whether file has a tag table.  Record the location if yes.
	      (goto-char (point-max))
	      (forward-line -8)
393
	      ;; Use string-equal, not equal, to ignore text props.
394 395 396
	      (if (not (or (string-equal nodename "*")
			   (not
			    (search-forward "\^_\nEnd tag table\n" nil t))))
Jim Blandy's avatar
Jim Blandy committed
397 398 399 400 401 402 403 404 405 406
		  (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.
407 408 409 410 411 412 413
			(let ((buf (current-buffer))
			      (tagbuf
			       (or Info-tag-table-buffer
				   (generate-new-buffer " *info tag table*"))))
			  (setq Info-tag-table-buffer tagbuf)
			  (save-excursion
			    (set-buffer tagbuf)
414
                            (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
415 416
			    (setq case-fold-search t)
			    (erase-buffer)
417 418 419 420 421
			    (insert-buffer-substring buf))
			  (set-marker Info-tag-table-marker
				      (match-end 0) tagbuf))
		      (set-marker Info-tag-table-marker pos)))
		(set-marker Info-tag-table-marker nil))
Jim Blandy's avatar
Jim Blandy committed
422
	      (setq Info-current-file
423
		    (if (eq filename t) "dir" filename))))
424 425
	;; Use string-equal, not equal, to ignore text props.
	(if (string-equal nodename "*")
Jim Blandy's avatar
Jim Blandy committed
426 427 428
	    (progn (setq Info-current-node nodename)
		   (Info-set-mode-line))
	  ;; Search file for a suitable node.
429 430 431 432 433
	  (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
434 435
	    (if (marker-position Info-tag-table-marker)
		(save-excursion
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
		  (let ((m Info-tag-table-marker)
			found found-mode)
		    (save-excursion
		      (set-buffer (marker-buffer m))
		      (goto-char m)
		      (beginning-of-line) ;so re-search will work.
		      (setq found (re-search-forward regexp nil t))
		      (if found
			  (setq guesspos (read (current-buffer))))
		      (setq found-mode major-mode))
		    (if found
			(progn
			  ;; If this is an indirect file, determine
			  ;; which file really holds this node and
			  ;; read it in.
			  (if (not (eq found-mode 'Info-mode))
			      ;; Note that the current buffer must be
			      ;; the *info* buffer on entry to
			      ;; Info-read-subfile.  Thus the hackery
			      ;; above.
			      (setq guesspos (Info-read-subfile guesspos))))
		      (error "No such node: %s" nodename)))))
458 459 460
	    (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
461 462 463 464 465 466 467 468 469 470 471
	    (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.
472
    (or Info-current-node no-going-back (null Info-history)
Jim Blandy's avatar
Jim Blandy committed
473 474 475 476 477 478
	(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)))

479 480
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
481 482
(defvar Info-dir-contents nil)

483 484 485 486
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

487 488 489 490
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

491
;; Construct the Info directory node by merging the files named `dir'
492 493 494
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
495
(defun Info-insert-dir ()
496 497 498 499 500
  (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)
501 502 503 504 505
				  (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)))
506
			       Info-dir-file-attributes))))
507 508
      (insert Info-dir-contents)
    (let ((dirs Info-directory-list)
509
	  buffers buffer others nodes dirs-done)
510

511 512
      (setq Info-dir-file-attributes nil)

513
      ;; Search the directory list for the directory file.
514
      (while dirs
515 516 517 518 519
	(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.
520 521 522 523 524 525 526 527 528 529 530
	      (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)))))
531 532 533 534
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
535 536 537 538
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
539
		      (set-buffer (generate-new-buffer " info dir"))
540 541 542 543 544
		      (insert-file-contents file)
		      (setq buffers (cons (current-buffer) buffers)
			    Info-dir-file-attributes
			    (cons (cons file attrs)
				  Info-dir-file-attributes))))))
545 546
	  (or (cdr dirs) (setq Info-dir-contents-directory
			       (file-name-as-directory (car dirs))))
547 548
	  (setq dirs (cdr dirs))))
      
549
      (or buffers
550
	  (error "Can't find the Info directory node"))
551
      ;; Distinguish the dir file that comes with Emacs from all the
552 553
      ;; others.  Yes, that is really what this is supposed to do.
      ;; If it doesn't work, fix it.
554 555
      (setq buffer (car buffers)
	    others (cdr buffers))
556

557 558 559
      ;; 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.
560
      (insert-buffer buffer)
561

562 563 564 565 566 567 568 569 570 571 572 573
      ;; 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))
574
		(search-backward "\n\^_")
575 576
		(search-forward "Node: ")
		(setq nodename (Info-following-node-name))
577
		(search-forward "\n\^_" nil 'move)
578 579 580 581 582 583 584 585 586 587
		(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)
588
	    (end (save-excursion (search-forward "\^_" nil t) (point))))
589 590
	(while nodes
	  (let ((nodename (car (car nodes))))
591 592
	    (save-excursion
	      (or (member (downcase nodename) menu-items)
593
		  (re-search-forward (concat "^\\* +"
594 595 596 597 598 599
					     (regexp-quote nodename)
					     "::")
				     end t)
		  (progn
		    (insert "* " nodename "::" "\n")
		    (setq menu-items (cons nodename menu-items))))))
600 601 602 603 604 605 606
	  (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.
607
	  (if (re-search-forward (concat "\n\^_.*\n.*Node: "
608 609 610 611
					 (regexp-quote nodename)
					 "[,\n\t]")
				 nil t)
	      (progn
612
		(search-forward "\n\^_" nil 'move)
613 614
		(beginning-of-line)
		(insert "\n"))
615 616
	    ;; If none exists, add one.
	    (goto-char (point-max))
617
	    (insert "\^_\nFile: dir\tNode: " nodename "\n\n* Menu:\n\n"))
618 619
	  ;; Merge the text from the other buffer's menu
	  ;; into the menu in the like-named node in the main buffer.
620
	  (apply 'insert-buffer-substring (cdr (car nodes))))
621 622 623 624
	(setq nodes (cdr nodes)))
      ;; Kill all the buffers we just made.
      (while buffers
	(kill-buffer (car buffers))
625 626
	(setq buffers (cdr buffers)))
      (message "Composing main Info directory...done"))
627 628
    (setq Info-dir-contents (buffer-string)))
  (setq default-directory Info-dir-contents-directory))
629

630 631
;; Note that on entry to this function the current-buffer must be the
;; *info* buffer; not the info tags buffer.
Jim Blandy's avatar
Jim Blandy committed
632
(defun Info-read-subfile (nodepos)
633 634
  ;; 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
635 636
  (let (lastfilepos
	lastfilename)
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
    (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))
661 662
    ;; Assume previous buffer is in Info-mode.
    ;; (set-buffer (get-buffer "*info*"))
Jim Blandy's avatar
Jim Blandy committed
663 664 665 666 667
    (or (equal Info-current-subfile lastfilename)
	(let ((buffer-read-only nil))
	  (setq buffer-file-name nil)
	  (widen)
	  (erase-buffer)
668
	  (info-insert-file-contents lastfilename)
Jim Blandy's avatar
Jim Blandy committed
669 670 671 672
	  (set-buffer-modified-p nil)
	  (setq Info-current-subfile lastfilename)))
    (goto-char (point-min))
    (search-forward "\n\^_")
673 674
    (if (numberp nodepos)
	(+ (- nodepos lastfilepos) (point)))))
Jim Blandy's avatar
Jim Blandy committed
675 676 677 678 679 680 681 682 683 684

;; 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
685 686 687 688
	 (buffer-substring-no-properties (point)
					 (progn
					  (skip-chars-forward "^,\t\n")
					  (point))))
Jim Blandy's avatar
Jim Blandy committed
689 690 691 692 693 694 695 696 697 698 699 700 701 702
   (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)))
703
     (if Info-enable-active-nodes (eval active-expression))
704
     (if Info-fontify (Info-fontify-node))
705
     (run-hooks 'Info-selection-hook))))
Jim Blandy's avatar
Jim Blandy committed
706 707 708 709

(defun Info-set-mode-line ()
  (setq mode-line-buffer-identification
	(concat
710
	 "  Info:  ("
Jim Blandy's avatar
Jim Blandy committed
711 712 713 714 715 716 717 718 719 720 721
	 (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."
722
  (interactive (list (Info-read-node-name "Goto node: ")))
Jim Blandy's avatar
Jim Blandy committed
723 724 725 726 727 728 729 730 731 732 733
  (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))))
734
    (if transient-mark-mode (deactivate-mark))
Jim Blandy's avatar
Jim Blandy committed
735 736
    (Info-find-node (if (equal filename "") nil filename)
		    (if (equal nodename "") "Top" nodename))))
737

738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
;; 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))))))

756 757
(defun Info-read-node-name (prompt &optional default)
  (let* ((completion-ignore-case t)
758
	 (completion-table (Info-build-node-completions))
759
	 (nodename (completing-read prompt 'Info-read-node-name-1 nil t)))
760 761 762 763 764 765 766 767 768 769 770
    (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)
771 772
		(let ((marker Info-tag-table-marker))
		  (set-buffer (marker-buffer marker))
773
		  (widen)
774
		  (goto-char marker)
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
		  (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
793

Jim Blandy's avatar
Jim Blandy committed
794 795
(defun Info-restore-point (hl)
  "If this node has been visited, restore the point value when we left."
796 797
  (while hl
    (if (and (equal (nth 0 (car hl)) Info-current-file)
798 799
	     ;; Use string-equal, not equal, to ignore text props.
	     (string-equal (nth 1 (car hl)) Info-current-node))
800
	(progn
801 802
	  (goto-char (nth 2 (car hl)))
	  (setq hl nil))		;terminate the while at next iter
803
      (setq hl (cdr hl)))))
Jim Blandy's avatar
Jim Blandy committed
804

Jim Blandy's avatar
Jim Blandy committed
805
(defvar Info-last-search nil
806
  "Default regexp for \\<Info-mode-map>\\[Info-search] command to search for.")
Jim Blandy's avatar
Jim Blandy committed
807 808 809 810

(defun Info-search (regexp)
  "Search for REGEXP, starting from point, and select node it's found in."
  (interactive "sSearch (regexp): ")
811
  (if transient-mark-mode (deactivate-mark))
Jim Blandy's avatar
Jim Blandy committed
812 813 814 815 816 817 818
  (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))
819
	(ostart (window-start))
Jim Blandy's avatar
Jim Blandy committed
820 821 822 823 824 825 826 827 828 829 830 831
	(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 ()))
832 833
	      (save-excursion
		(set-buffer (marker-buffer Info-tag-table-marker))
Jim Blandy's avatar
Jim Blandy committed
834
		(goto-char (point-min))
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
		(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))))
Jim Blandy's avatar
Jim Blandy committed
854 855 856 857
	      (while list
		(message "Searching subfile %s..." (cdr (car list)))
		(Info-read-subfile (car (car list)))
		(setq list (cdr list))
858
;;		(goto-char (point-min))
Jim Blandy's avatar
Jim Blandy committed
859 860 861 862 863 864
		(if (re-search-forward regexp nil t)
		    (setq found (point) list ())))
	      (if found
		  (message "")
		(signal 'search-failed (list regexp))))
	  (if (not found)
865
	      (progn (Info-read-subfile osubfile)
Jim Blandy's avatar
Jim Blandy committed
866
		     (goto-char opoint)
867 868
		     (Info-select-node)
		     (set-window-start (selected-window) ostart)))))
Jim Blandy's avatar
Jim Blandy committed
869 870 871
    (widen)
    (goto-char found)
    (Info-select-node)
872 873
    ;; Use string-equal, not equal, to ignore text props.
    (or (and (string-equal onode Info-current-node)
Jim Blandy's avatar
Jim Blandy committed
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
	     (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
891
       (error "Node has no %s" (capitalize (or errorname name)))))))
Jim Blandy's avatar
Jim Blandy committed
892

893 894
;; Return the node name in the buffer following point.
;; ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
895
;; saying which chars may appear in the node name.
Jim Blandy's avatar
Jim Blandy committed
896 897
(defun Info-following-node-name (&optional allowedchars)
  (skip-chars-forward " \t")
898
  (buffer-substring-no-properties
Jim Blandy's avatar
Jim Blandy committed
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
   (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")))

918 919 920
(defun Info-up (&optional same-file)
  "Go to the superior node of this node.
If SAME-FILE is non-nil, do not move to a different Info file."
Jim Blandy's avatar
Jim Blandy committed
921
  (interactive)
922 923 924 925 926
  (let ((node (Info-extract-pointer "up")))
    (and same-file
	 (string-match "^(" node)
	 (error "Up node is in another Info file"))
    (Info-goto-node node))
Jim Blandy's avatar
Jim Blandy committed
927
  (Info-restore-point Info-history))
Jim Blandy's avatar
Jim Blandy committed
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952

(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)
953
	 completions default alt-default (start-point (point)) str i bol eol)
Jim Blandy's avatar
Jim Blandy committed
954
     (save-excursion
955 956 957 958 959 960
       ;; 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
961 962 963 964 965 966 967
       (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)
968
	      (<= (match-beginning 0) start-point)
Jim Blandy's avatar
Jim Blandy committed
969 970
	      (<= start-point (point))
	      (setq default t))
971 972 973 974 975
	 ;; 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
976 977 978 979 980 981 982
	 (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))
983
	 (if (eq alt-default t) (setq alt-default str))
984 985 986 987 988 989 990 991 992 993 994 995
	 ;; Don't add this string if it's a duplicate.
	 ;; We use a loop instead of "(assoc str completions)" because
	 ;; we want to do a case-insensitive compare.
	 (let ((tail completions)
	       (tem (downcase str)))
	   (while (and tail
		       (not (string-equal tem (downcase (car (car tail))))))
	     (setq tail (cdr tail)))
	   (or tail
	       (setq completions
		     (cons (cons str nil)
			   completions))))))
996 997 998 999 1000 1001
     ;; 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
1002
     (if completions
1003 1004 1005 1006 1007 1008 1009
	 (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
1010
       (error "No cross-references in this node"))))
1011
  (let (target beg i (str (concat "\\*note " (regexp-quote footnotename))))
Jim Blandy's avatar
Jim Blandy committed
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
    (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 ":")
1036
	      (buffer-substring-no-properties beg (1- (point)))
Jim Blandy's avatar
Jim Blandy committed
1037 1038 1039 1040
	    (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 ?\ ))
1041 1042 1043
    ;; Collapse multiple spaces.
    (while (string-match "  +" str)
      (setq str (replace-match " " t t str)))
Jim Blandy's avatar
Jim Blandy committed
1044 1045
    str))

1046
;; No one calls this.
1047 1048
;;(defun Info-menu-item-sequence (list)
;;  (while list
1049
;;    (Info-menu (car list))
1050
;;    (setq list (cdr list))))
Jim Blandy's avatar
Jim Blandy committed
1051

1052 1053 1054 1055
(defun Info-complete-menu-item (string predicate action)
  (let ((case-fold-search t))
    (cond ((eq action nil)
	   (let (completions
1056
		 (pattern (concat "\n\\* +\\("
1057 1058 1059 1060 1061
				  (regexp-quote string)
				  "[^:\t\n]*\\):")))
	     (save-excursion
	       (set-buffer Info-complete-menu-buffer)
	       (goto-char (point-min))
1062
	       (search-forward "\n* Menu:")
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
	       (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
1073
		 (pattern (concat "\n\\* +\\("
1074 1075 1076 1077 1078
				  (regexp-quote string)
				  "[^:\t\n]*\\):")))
	     (save-excursion
	       (set-buffer Info-complete-menu-buffer)
	       (goto-char (point-min))
1079
	       (search-forward "\n* Menu:")
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
	       (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))
1092
	     (search-forward "\n* Menu:")
1093
	     (re-search-forward (concat "\n\\* +"
1094 1095 1096 1097 1098
					(regexp-quote string)
					":")
				nil t))))))


Jim Blandy's avatar
Jim Blandy committed
1099 1100 1101 1102 1103 1104 1105 1106
(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))
1107
	 beg
Jim Blandy's avatar
Jim Blandy committed
1108 1109 1110 1111 1112
	 (last nil))
     (save-excursion
       (goto-char (point-min))
       (if (not (search-forward "\n* menu:" nil t))
	   (error "No menu in this node"))
1113 1114 1115 1116 1117
       (setq beg (point))
       (and (< (point) p)
	    (save-excursion
	      (goto-char p)
	      (end-of-line)
1118
	      (re-search-backward "\n\\* +\\([^:\t\n]*\\):" beg t)
1119 1120 1121
	      (setq default (format "%s" (buffer-substring
					  (match-beginning 1)
					  (match-end 1)))))))
Jim Blandy's avatar
Jim Blandy committed
1122 1123
     (let ((item nil))
       (while (null item)
1124 1125
	 (setq item (let ((completion-ignore-case t)
			  (Info-complete-menu-buffer (current-buffer)))
Jim Blandy's avatar
Jim Blandy committed
1126 1127 1128 1129
		      (completing-read (if default
					   (format "Menu item (default %s): "
						   default)
					   "Menu item: ")
1130
				       'Info-complete-menu-item nil t)))
Jim Blandy's avatar
Jim Blandy committed
1131 1132 1133
	 ;; 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