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

3
;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 97, 98, 99 Free Software
Karl Heuer's avatar
Karl Heuer committed
4
;; 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:

Dave Love's avatar
Dave Love committed
32 33
(eval-when-compile (require 'jka-compr))

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


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

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

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

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

63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
(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)

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

83
(defvar Info-directory-list nil
Jim Blandy's avatar
Jim Blandy committed
84
  "List of directories to search for Info documentation files.
Jim Blandy's avatar
Jim Blandy committed
85
nil means not yet initialized.  In this case, Info uses the environment
86
variable INFOPATH to initialize it, or `Info-default-directory-list'
87 88
if there is no INFOPATH variable in the environment.
The last element of `Info-default-directory-list' is the directory
89
where Emacs installs the Info files that come with it.
90 91 92 93 94

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
95

96
(defcustom Info-additional-directory-list nil
97
  "List of additional directories to search for Info documentation files.
98 99 100
These directories are not searched for merging the `dir' file."
  :type '(repeat directory)
  :group 'info)
101

Jim Blandy's avatar
Jim Blandy committed
102
(defvar Info-current-file nil
103 104 105
  "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
106 107 108 109 110 111 112 113

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

114
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
115 116 117
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

118 119 120
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

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
(defvar Info-standalone nil
  "Non-nil if Emacs was started solely as an Info browser.")
129

130
(defvar Info-suffix-list
131 132
  ;; The MS-DOS list should work both when long file names are
  ;; supported (Windows 9X), and when only 8+3 file names are available.
133 134 135
  (if (eq system-type 'ms-dos)
      '( (".gz"      . "gunzip")
	 (".z"       . "gunzip")
136 137 138 139 140 141 142 143
	 (".inz"     . "gunzip")
	 (".igz"     . "gunzip")
	 (".info.Z"  . "gunzip")
	 (".info.gz" . "gunzip")
	 ("-info.Z"  . "gunzip")
	 ("-info.gz" . "gunzip")
	 ("/index.gz". "gunzip")
	 ("/index.z" . "gunzip")
144
	 (".inf"     . nil)
145 146 147
	 (".info"    . nil)
	 ("-info"    . nil)
	 ("/index"   . nil)
148
	 (""         . nil))
149 150 151 152
    '( (".info.Z".    "uncompress")
       (".info.Y".    "unyabba")
       (".info.gz".   "gunzip")
       (".info.z".    "gunzip")
Dave Love's avatar
Dave Love committed
153
       (".info.bz2" . "bzip2 -dc")
154 155 156 157
       (".info".      nil)
       ("-info.Z".   "uncompress")
       ("-info.Y".   "unyabba")
       ("-info.gz".  "gunzip")
Dave Love's avatar
Dave Love committed
158
       ("-info.bz2" . "bzip2 -dc")
159 160 161 162 163 164
       ("-info.z".   "gunzip")
       ("-info".     nil)
       ("/index.Z".   "uncompress")
       ("/index.Y".   "unyabba")
       ("/index.gz".  "gunzip")
       ("/index.z".   "gunzip")
Dave Love's avatar
Dave Love committed
165
       ("/index.bz2". "bzip2 -dc")
166 167 168 169 170
       ("/index".     nil)
       (".Z".         "uncompress")
       (".Y".         "unyabba")
       (".gz".        "gunzip")
       (".z".         "gunzip")
Dave Love's avatar
Dave Love committed
171
       (".bz2" .      "bzip2 -dc")
172
       ("".           nil)))
173 174
  "List of file name suffixes and associated decoding commands.
Each entry should be (SUFFIX . STRING); the file is given to
175 176 177
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.")
178

179
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
180 181 182 183 184 185
;; 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))
186 187 188
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
189
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
190
      ;; get rid of the one in SUFFIX (unless suffix is empty).
191
      (or (and (<= ext-len 0)
192
	       (not (eq (aref filename (1- (length filename))) ?.)))
193
	  (= (length suffix) 0)
194
	  (setq suffix (substring suffix 1)))
195 196
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
197 198 199 200 201
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

202 203 204 205
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

206 207 208
(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."
209 210 211
  (let ((tail Info-suffix-list)
	fullname decoder)
    (if (file-exists-p filename)
212 213
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
214 215 216 217 218 219 220 221
	(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))))
222
      ;; Try adding suffixes to FILENAME and see if we can find something.
223
      (while (and tail
224 225
		  (not (info-file-exists-p (info-insert-file-contents-1
					    filename (car (car tail))))))
226
	(setq tail (cdr tail)))
227 228
      ;; If we found a file with a suffix, set DECODER according to the suffix
      ;; and set FULLNAME to the file's actual name.
229
      (setq fullname (info-insert-file-contents-1 filename (car (car tail)))
230 231
	    decoder (cdr (car tail)))
      (or tail
232
	  (error "Can't find %s or any compressed version of it" filename)))
233 234 235 236 237
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
238
    (if decoder
239 240 241 242 243 244 245 246
	(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))))
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272

;; Initialize Info-directory-list, if that hasn't been done yet.
(defun info-initialize ()
  (unless Info-directory-list
    (let ((path (getenv "INFOPATH"))
	  (source (expand-file-name "info/" source-directory))
	  (sibling (if installation-directory
		       (expand-file-name "info/" installation-directory)))
	  alternative)
      (setq Info-directory-list
	    (if path
		(split-string path (regexp-quote path-separator))
	      (if (and sibling (file-exists-p sibling))
		  ;; Uninstalled, Emacs builddir != srcdir.
		  (setq alternative sibling)
		;; Uninstalled, builddir == srcdir
		(setq alternative source))
	      (if (or (member alternative Info-default-directory-list)
		      ;; On DOS/NT, we use movable executables always,
		      ;; and we must always find the Info dir at run time.
		      (if (memq system-type '(ms-dos windows-nt))
			  nil
			;; Use invocation-directory for Info
			;; only if we used it for exec-directory also.
			(not (string= exec-directory
				      (expand-file-name "lib-src/"
273 274
							installation-directory))))
		      (not (file-exists-p alternative)))
275 276 277 278 279 280
		  Info-default-directory-list
		;; `alternative' contains the Info files that came with this
		;; version, so we should look there first.  `Info-insert-dir'
		;; currently expects to find `alternative' first on the list.
		(cons alternative
		      (reverse (cdr (reverse Info-default-directory-list))))))))))
281

282 283 284 285 286 287 288 289
;;;###autoload
(defun info-other-window (&optional file)
  "Like `info' but show the Info buffer in another window."
  (interactive (if current-prefix-arg
		   (list (read-file-name "Info file name: " nil nil t))))
  (let (same-window-buffer-names)
    (info file)))
  
290
;;;###autoload (add-hook 'same-window-buffer-names "*info*")
291

Jim Blandy's avatar
Jim Blandy committed
292 293 294 295 296
;;;###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.
Dave Love's avatar
Dave Love committed
297 298
Called from a program, FILE may specify an Info node of the form
`(FILENAME)NODENAME'.
Jim Blandy's avatar
Jim Blandy committed
299 300

In interactive use, a prefix argument directs this command
Richard M. Stallman's avatar
Richard M. Stallman committed
301 302 303 304 305
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
306 307 308
  (interactive (if current-prefix-arg
		   (list (read-file-name "Info file name: " nil nil t))))
  (if file
309 310 311 312 313 314 315 316 317
      (progn
	(pop-to-buffer "*info*")
	;; If argument already contains parentheses, don't add another set
	;; since the argument will then be parsed improperly.  This also
	;; has the added benefit of allowing node names to be included
	;; following the parenthesized filename.
	(if (and (stringp file) (string-match "(.*)" file))
	    (Info-goto-node file)
	  (Info-goto-node (concat "(" file ")"))))
318 319 320
    (if (get-buffer "*info*")
	(pop-to-buffer "*info*")
      (Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
321

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
;;;###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)))
339

340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
;; See if the the accessible portion of the buffer begins with a node
;; delimiter, and the node header line which follows matches REGEXP.
;; Typically, this test will be followed by a loop that examines the
;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
;; to have the overhead of this special test inside the loop.

;; This function changes match-data, but supposedly the caller might
;; want to use the results of re-search-backward.

;; The return value is the value of point at the beginning of matching
;; REGERXP, if the function succeeds, nil otherwise.
(defun Info-node-at-bob-matching (regexp)
  (and (bobp)			; are we at beginning of buffer?
       (looking-at "\^_")	; does it begin with node delimiter?
       (let (beg)
	 (forward-line 1)
	 (setq beg (point))
	 (forward-line 1)	; does the line after delimiter match REGEXP?
	 (re-search-backward regexp beg t))))

Jim Blandy's avatar
Jim Blandy committed
360 361 362 363
;; 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)
364
  (info-initialize)
Jim Blandy's avatar
Jim Blandy committed
365 366 367 368
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
  (if filename
      (let (temp temp-downcase found)
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
        (setq filename (substitute-in-file-name filename))
        (if (string= (downcase filename) "dir")
            (setq found t)
          (let ((dirs (if (string-match "^\\./" filename)
                          ;; If specified name starts with `./'
                          ;; then just try current directory.
                          '("./")
                        (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)))))
            ;; 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.
              (let ((suffix-list Info-suffix-list))
                (while (and suffix-list (not found))
                  (cond ((info-file-exists-p
                          (info-insert-file-contents-1
                           temp (car (car suffix-list))))
                         (setq found temp))
                        ((info-file-exists-p
                          (info-insert-file-contents-1
                           temp-downcase (car (car suffix-list))))
                         (setq found temp-downcase)))
                  (setq suffix-list (cdr suffix-list))))
              (setq dirs (cdr dirs)))))
        (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)))
Jim Blandy's avatar
Jim Blandy committed
410
  ;; Go into info buffer.
411
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
412
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
413 414 415 416 417
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
418
      ;; Bind case-fold-search in case the user sets it to nil.
419 420
      (let ((case-fold-search t)
	    anchorpos)
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
        ;; 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
                    Info-current-file-completions nil
                    buffer-file-name nil)
              (erase-buffer)
              (if (eq filename t)
                  (Info-insert-dir)
                (info-insert-file-contents filename t)
                (setq default-directory (file-name-directory filename)))
              (set-buffer-modified-p nil)
              ;; See whether file has a tag table.  Record the location if yes.
              (goto-char (point-max))
              (forward-line -8)
              ;; Use string-equal, not equal, to ignore text props.
              (if (not (or (string-equal nodename "*")
                           (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.
                        (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)
459
                            (buffer-disable-undo (current-buffer))
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
                            (setq case-fold-search t)
                            (erase-buffer)
                            (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))
              (setq Info-current-file
                    (if (eq filename t) "dir" filename))))
        ;; Use string-equal, not equal, to ignore text props.
        (if (string-equal nodename "*")
            (progn (setq Info-current-node nodename)
                   (Info-set-mode-line))
          ;; Possibilities:
          ;;
          ;; 1. Anchor found in tag table
          ;; 2. Anchor *not* in tag table
          ;;
          ;; 3. Node found in tag table
          ;; 4. Node *not* found in tag table, but found in file
          ;; 5. Node *not* in tag table, and *not* in file
          ;;
          ;; *Or* the same, but in an indirect subfile.

          ;; Search file for a suitable node.
485 486 487 488 489 490
	  (let ((guesspos (point-min))
		(regexp
		 (concat "\\(Node:\\|Ref:\\) *\\("
			 (regexp-quote nodename)
			 "\\) *[,\t\n\177]"))
		(nodepos nil))
491 492 493

            ;; First, search a tag table, if any
            (if (marker-position Info-tag-table-marker)
494
		(let ((found-in-tag-table t)
495
		      found-anchor
496 497
		      found-mode
		      (m Info-tag-table-marker))
498 499 500 501 502 503
                  (save-excursion
                    (set-buffer (marker-buffer m))
                    (goto-char m)
                    (beginning-of-line) ; so re-search will work.

                    ;; Search tag table
504 505 506 507 508 509 510 511 512 513
		    (catch 'foo
		      (while (re-search-forward regexp nil t)
			(setq found-anchor
			      (string-equal "Ref:" (match-string 1)))
			(or nodepos (setq nodepos (point))
			(if (string-equal (match-string 2) nodename)
			    (throw 'foo t))))
		      (if nodepos
			  (goto-char nodepos)
			(setq found-in-tag-table nil)))
514
                    (if found-in-tag-table
515
                        (setq guesspos (1+ (read (current-buffer)))))
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
                    (setq found-mode major-mode))

                  ;; Indirect file among split files
                  (if found-in-tag-table
                      (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)))))

                  ;; Handle anchor
532 533
                  (if found-anchor
		      (goto-char (setq anchorpos guesspos))
534 535

                    ;; Else we may have a node, which we search for:
536 537 538 539 540 541 542
		    (let ((guesschar
			   (or (byte-to-position guesspos)
			       (if (< (position-bytes (point-max)) guesspos)
				   (point-max)
				 (point-min)))))
		      (goto-char (max (point-min)
				      (- guesschar 1000))))
543 544 545
                    ;; Now search from our advised position
                    ;; (or from beg of buffer)
                    ;; to find the actual node.
546 547 548
		    ;; First, check whether the node is right
		    ;; where we are, in case the buffer begins
		    ;; with a node.
549
		    (setq nodepos nil)
550 551 552
		    (or (Info-node-at-bob-matching regexp)
			(catch 'foo
			  (while (search-forward "\n\^_" nil t)
553
			    (forward-line 1)
554 555 556
			    (let ((beg (point)))
			      (forward-line 1)
			      (if (re-search-backward regexp beg t)
557 558 559 560 561 562 563 564 565 566 567 568 569
				  (if (string-equal (match-string 2) nodename)
				      (progn
					(beginning-of-line)
					(throw 'foo t))
				    (or nodepos
				      (setq nodepos (point)))))))
			  (if nodepos
			      (progn
				(goto-char nodepos)
				(beginning-of-line))
			    (error
			     "No such anchor in tag table or node in tag table or file: %s"
			     nodename))))))
570 571 572
	      (goto-char (max (point-min) (- guesspos 1000)))
	      ;; Now search from our advised position (or from beg of buffer)
	      ;; to find the actual node.
573 574
	      ;; First, check whether the node is right where we are, in case
	      ;; the buffer begins with a node.
575
	      (setq nodepos nil)
576 577 578
	      (or (Info-node-at-bob-matching regexp)
		  (catch 'foo
		    (while (search-forward "\n\^_" nil t)
579
		      (forward-line 1)
580 581 582
		      (let ((beg (point)))
			(forward-line 1)
			(if (re-search-backward regexp beg t)
583 584 585 586 587 588 589
			    (if (string-equal (match-string 2) nodename)
				(throw 'foo t)
			      (or nodepos
				  (setq nodepos (point)))))))
		    (if nodepos
			(goto-char nodepos)
		      (error "No such node: %s" nodename))))))
590
          (Info-select-node)
591
	  (goto-char (or anchorpos (point-min)))))
Jim Blandy's avatar
Jim Blandy committed
592 593
    ;; If we did not finish finding the specified node,
    ;; go back to the previous one.
594
    (or Info-current-node no-going-back (null Info-history)
595 596 597 598
        (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))))))
Jim Blandy's avatar
Jim Blandy committed
599

600 601
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
602 603
(defvar Info-dir-contents nil)

604 605 606 607
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

608 609 610 611
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

612 613
(defvar Info-dir-file-name nil)

614
;; Construct the Info directory node by merging the files named `dir'
615 616 617
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
618
(defun Info-insert-dir ()
619 620 621 622 623
  (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)
624 625 626 627
				  (let ((curr (file-attributes 
					       ;; Handle symlinks
					       (file-truename (car elt)))))
				    
628 629 630 631
				    ;; Don't compare the access time.
				    (if curr (setcar (nthcdr 4 curr) 0))
				    (setcar (nthcdr 4 (cdr elt)) 0)
				    (equal (cdr elt) curr)))
632
			       Info-dir-file-attributes))))
633 634 635
      (progn
	(insert Info-dir-contents)
	(goto-char (point-min)))
636
    (let ((dirs Info-directory-list)
637 638
	  ;; Bind this in case the user sets it to nil.
	  (case-fold-search t)
639 640
	  ;; This is set non-nil if we find a problem in some input files.
	  problems
641
	  buffers buffer others nodes dirs-done)
642

643 644
      (setq Info-dir-file-attributes nil)

645
      ;; Search the directory list for the directory file.
646
      (while dirs
647 648 649 650 651
	(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.
652 653 654 655 656 657 658 659 660 661 662
	      (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)))))
663 664 665 666
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
667 668 669 670
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
671
		      (set-buffer (generate-new-buffer " info dir"))
672 673 674
		      (condition-case nil
			  (progn
			    (insert-file-contents file)
675 676
			    (make-local-variable 'Info-dir-file-name)
			    (setq Info-dir-file-name file)
677 678 679 680 681
			    (setq buffers (cons (current-buffer) buffers)
				  Info-dir-file-attributes
				  (cons (cons file attrs)
					Info-dir-file-attributes)))
			(error (kill-buffer (current-buffer))))))))
682 683
	  (or (cdr dirs) (setq Info-dir-contents-directory
			       (file-name-as-directory (car dirs))))
684 685
	  (setq dirs (cdr dirs))))
      
686
      (or buffers
687
	  (error "Can't find the Info directory node"))
688
      ;; Distinguish the dir file that comes with Emacs from all the
689
      ;; others.  Yes, that is really what this is supposed to do.
690 691 692 693
      ;; The definition of `Info-directory-list' puts it first on that
      ;; list and so last in `buffers' at this point.
      (setq buffer (car (last buffers))
	    others (delq buffer buffers))
694

695 696 697
      ;; 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.
698
      (insert-buffer buffer)
699

700 701
      ;; Look at each of the other buffers one by one.
      (while others
702 703
	(let ((other (car others))
	      this-buffer-nodes)
704 705 706 707 708 709 710 711 712
	  ;; 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))
713 714 715
		(or (search-backward "\n\^_" nil 'move)
		    (looking-at "\^_")
		    (signal 'search-failed (list "\n\^_")))
716 717
		(search-forward "Node: ")
		(setq nodename (Info-following-node-name))
718
		(search-forward "\n\^_" nil 'move)
719 720
		(beginning-of-line)
		(setq end (point))
721 722 723 724 725 726 727
		(setq this-buffer-nodes
		      (cons (list nodename other beg end)
			    this-buffer-nodes))))
	    (if (assoc-ignore-case "top" this-buffer-nodes)
		(setq nodes (nconc this-buffer-nodes nodes))
	      (setq problems t)
	      (message "No `top' node in %s" Info-dir-file-name))))
728 729 730 731 732 733 734
	(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)
735
	    (end (save-excursion (search-forward "\^_" nil t) (point))))
736 737
	(while nodes
	  (let ((nodename (car (car nodes))))
738 739
	    (save-excursion
	      (or (member (downcase nodename) menu-items)
740
		  (re-search-forward (concat "^\\* +"
741 742 743 744 745 746
					     (regexp-quote nodename)
					     "::")
				     end t)
		  (progn
		    (insert "* " nodename "::" "\n")
		    (setq menu-items (cons nodename menu-items))))))
747 748 749 750 751 752 753
	  (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.
754
	  (if (re-search-forward (concat "^\^_.*\n.*Node: "
755 756 757 758
					 (regexp-quote nodename)
					 "[,\n\t]")
				 nil t)
	      (progn
759
		(search-forward "\n\^_" nil 'move)
760 761
		(beginning-of-line)
		(insert "\n"))
762 763
	    ;; If none exists, add one.
	    (goto-char (point-max))
764
	    (insert "\^_\nFile: dir\tNode: " nodename "\n\n* Menu:\n\n"))
765 766
	  ;; Merge the text from the other buffer's menu
	  ;; into the menu in the like-named node in the main buffer.
767
	  (apply 'insert-buffer-substring (cdr (car nodes))))
768 769 770 771
	(setq nodes (cdr nodes)))
      ;; Kill all the buffers we just made.
      (while buffers
	(kill-buffer (car buffers))
772
	(setq buffers (cdr buffers)))
773 774 775 776
      (goto-char (point-min))
      (if problems
	  (message "Composing main Info directory...problems encountered, see `*Messages*'")
	(message "Composing main Info directory...done")))
777 778
    (setq Info-dir-contents (buffer-string)))
  (setq default-directory Info-dir-contents-directory))
779

780 781
;; 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
782
(defun Info-read-subfile (nodepos)
783 784
  ;; 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
785 786
  (let (lastfilepos
	lastfilename)
787 788 789 790
    (if (numberp nodepos)
	(save-excursion
	  (set-buffer (marker-buffer Info-tag-table-marker))
	  (goto-char (point-min))
791 792
	  (or (looking-at "\^_")
	      (search-forward "\n\^_"))
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
	  (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))
812 813
    ;; Assume previous buffer is in Info-mode.
    ;; (set-buffer (get-buffer "*info*"))
Jim Blandy's avatar
Jim Blandy committed
814 815 816 817 818
    (or (equal Info-current-subfile lastfilename)
	(let ((buffer-read-only nil))
	  (setq buffer-file-name nil)
	  (widen)
	  (erase-buffer)
819
	  (info-insert-file-contents lastfilename)
Jim Blandy's avatar
Jim Blandy committed
820 821 822
	  (set-buffer-modified-p nil)
	  (setq Info-current-subfile lastfilename)))
    (goto-char (point-min))
823 824 825
    (if (looking-at "\^_")
	(forward-char 1)
      (search-forward "\n\^_"))
826 827
    (if (numberp nodepos)
	(+ (- nodepos lastfilepos) (point)))))
Jim Blandy's avatar
Jim Blandy committed
828 829 830

;; Select the info node that point is in.
(defun Info-select-node ()
831 832 833 834
  ;; Bind this in case the user sets it to nil.
  (let ((case-fold-search t))
    (save-excursion
     ;; Find beginning of node.
835 836 837 838 839
     (if (search-backward "\n\^_" nil 'move)
	 (forward-line 2)
       (if (looking-at "\^_")
	   (forward-line 1)
	 (signal 'search-failed (list "\n\^_"))))
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
     ;; Get nodename spelled as it is in the node.
     (re-search-forward "Node:[ \t]*")
     (setq Info-current-node
	   (buffer-substring-no-properties (point)
					   (progn
					    (skip-chars-forward "^,\t\n")
					    (point))))
     (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)))
       (if Info-enable-active-nodes (eval active-expression))
       (if Info-fontify (Info-fontify-node))
       (run-hooks 'Info-selection-hook)))))
Jim Blandy's avatar
Jim Blandy committed
864 865 866 867

(defun Info-set-mode-line ()
  (setq mode-line-buffer-identification
	(concat
868
	 "  Info:  ("
Jim Blandy's avatar
Jim Blandy committed
869 870 871 872 873 874 875 876 877 878 879
	 (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."
880
  (interactive (list (Info-read-node-name "Goto node: ")))
881
  (info-initialize)
Jim Blandy's avatar
Jim Blandy committed
882 883 884 885 886 887 888 889 890 891 892
  (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))))
893
    (if transient-mark-mode (deactivate-mark))
Jim Blandy's avatar
Jim Blandy committed
894 895
    (Info-find-node (if (equal filename "") nil filename)
		    (if (equal nodename "") "Top" nodename))))
896

897 898
(defvar Info-read-node-completion-table)

899
;; This function is used as the "completion table" while reading a node name.
900
;; It does completion using the alist in Info-read-node-completion-table
901 902 903 904 905 906
;; 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
907
	     (try-completion string Info-read-node-completion-table predicate)))
908 909 910
	  ((eq code t)
	   (if no-completion
	       nil
911
	     (all-completions string Info-read-node-completion-table predicate)))
912 913 914
	  ((eq code 'lambda)
	   (if no-completion
	       t
915
	     (assoc string Info-read-node-completion-table))))))
916

917 918
(defun Info-read-node-name (prompt &optional default)
  (let* ((completion-ignore-case t)
919
	 (Info-read-node-completion-table (Info-build-node-completions))
920
	 (nodename (completing-read prompt 'Info-read-node-name-1 nil t)))
921 922 923 924 925 926 927
    (if (equal nodename "")
	(or default
	    (Info-read-node-name prompt))
      nodename)))

(defun Info-build-node-completions ()
  (or Info-current-file-completions
928 929
      (let ((compl nil)
	    ;; Bind this in case the user sets it to nil.
930 931
	    (case-fold-search t)
	    (node-regexp "Node: *\\([^,\n]*\\) *[,\n\t]"))
932 933 934
	(save-excursion
	  (save-restriction
	    (if (marker-buffer Info-tag-table-marker)
935 936
		(let ((marker Info-tag-table-marker))
		  (set-buffer (marker-buffer marker))
937
		  (widen)
938
		  (goto-char marker)
939 940 941 942 943 944 945
		  (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))
946 947 948 949 950
	      ;; If the buffer begins with a node header, process that first.
	      (if (Info-node-at-bob-matching node-regexp)
		  (setq compl (list (buffer-substring (match-beginning 1)
						      (match-end 1)))))
	      ;; Now for the rest of the nodes.
951 952 953 954
	      (while (search-forward "\n\^_" nil t)
		(forward-line 1)
		(let ((beg (point)))
		  (forward-line 1)
955
		  (if (re-search-backward node-regexp beg t)
956 957 958 959 960
		      (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
961

Jim Blandy's avatar
Jim Blandy committed
962 963
(defun Info-restore-point (hl)
  "If this node has been visited, restore the point value when we left."
964 965
  (while hl
    (if (and (equal (nth 0 (car hl)) Info-current-file)
966 967
	     ;; Use string-equal, not equal, to ignore text props.
	     (string-equal (nth 1 (car hl)) Info-current-node))
968
	(progn
969 970
	  (goto-char (nth 2 (car hl)))
	  (setq hl nil))		;terminate the while at next iter
971
      (setq hl (cdr hl)))))
Jim Blandy's avatar
Jim Blandy committed
972

Jim Blandy's avatar
Jim Blandy committed
973
(defvar Info-last-search nil
974
  "Default regexp for \\<Info-mode-map>\\[Info-search] command to search for.")
Jim Blandy's avatar
Jim Blandy committed
975 976 977 978

(defun Info-search (regexp)
  "Search for REGEXP, starting from point, and select node it's found in."
  (interactive "sSearch (regexp): ")
979
  (if transient-mark-mode (deactivate-mark))
Jim Blandy's avatar
Jim Blandy committed
980 981 982
  (if (equal regexp "")
      (setq regexp Info-last-search)
    (setq Info-last-search regexp))
983 984 985 986 987 988 989 990 991 992 993
  (when regexp
    (let ((found ()) current
	  (onode Info-current-node)
	  (ofile Info-current-file)
	  (opoint (point))
	  (ostart (window-start))
	  (osubfile Info-current-subfile))
      (save-excursion
	(save-restriction
	  (widen)
	  (if (null Info-current-subfile)
Jim Blandy's avatar
Jim Blandy committed
994
	      (progn (re-search-forward regexp) (setq found (point)))
995 996 997 998 999 1000 1001 1002
	    (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 ()))
		(save-excursion
		  (set-buffer (marker-buffer Info-tag-table-marker))
1003
		  (goto-char (point-min))
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
		  (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))
;;;		(goto-char (point-min))
		  (if (re-search-forward regexp nil t)
		      (setq found (point) list ())))
		(if found
		    (message "")
		  (signal 'search-failed (list regexp))))
	    (if (not found)
		(progn (Info-read-subfile osubfile)
		       (goto-char opoint)
		       (Info-select-node)
		       (set-window-start (selected-window) ostart)))))
Jim Blandy's avatar
Jim Blandy committed
1038 1039 1040
    (widen)
    (goto-char found)
    (Info-select-node)
1041 1042
    ;; Use string-equal, not equal, to ignore text props.
    (or (and (string-equal onode Info-current-node)
Jim Blandy's avatar
Jim Blandy committed
1043 1044
	     (equal ofile Info-current-file))
	(setq Info-history (cons (list ofile onode opoint)
1045
				 Info-history))))))
Jim Blandy's avatar
Jim Blandy committed
1046 1047 1048 1049 1050

;; 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)
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
  ;; Bind this in case the user sets it to nil.
  (let ((case-fold-search t))
    (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
	  (error "Node has no %s" (capitalize (or errorname name))))))))
Jim Blandy's avatar
Jim Blandy committed
1063

1064 1065
;; Return the node name in the buffer following point.
;; ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1066
;; saying which chars may appear in the node name.
Jim Blandy's avatar
Jim Blandy committed
1067 1068
(defun Info-following-node-name (&optional allowedchars)
  (skip-chars-forward " \t")
1069
  (buffer-substring-no-properties
Jim Blandy's avatar
Jim Blandy committed
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
   (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")))

1089 1090 1091
(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
1092
  (interactive)
1093 1094 1095 1096 1097
  (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
1098
  (Info-restore-point Info-history))