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

Dave Love's avatar
Dave Love committed
3
;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 97, 98, 99, 2000 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
(defface info-node
64 65
  '((((class color)) (:foreground "brown" :bold t :italic t))
    (t (:bold t :italic t)))
66 67 68 69
  "Face for Info node names."
  :group 'info)

(defface info-menu-5
70 71
  '((((class color)) (:foreground "red1"))
    (t (:underline t)))
72 73 74 75
  "Face for the fifth and tenth `*' in an Info menu."
  :group 'info)

(defface info-xref
76 77
  '((((class color)) (:foreground "magenta4" :bold t))
    (t (:bold t)))
78 79 80
  "Face for Info cross-references."
  :group 'info)

81
(defcustom Info-fontify-maximum-menu-size 100000
82 83 84
  "*Maximum size of menu to fontify if `Info-fontify' is non-nil."
  :type 'integer
  :group 'info)
85

86
(defvar Info-directory-list nil
Jim Blandy's avatar
Jim Blandy committed
87
  "List of directories to search for Info documentation files.
Jim Blandy's avatar
Jim Blandy committed
88
nil means not yet initialized.  In this case, Info uses the environment
89
variable INFOPATH to initialize it, or `Info-default-directory-list'
90
if there is no INFOPATH variable in the environment.
91 92 93 94 95 96 97

When `Info-directory-list' is initialized from the value of
`Info-default-directory-list', the first element of the resulting
list is the directory where Emacs installs the Info files that
come with it.  This is so that Emacs's own manual, which suits the
version of Emacs you are using, will always be found first.  (If
you want to override that, set INFOPATH in the environment.)
98 99

If you run the Emacs executable from the `src' directory in the Emacs
100 101 102 103
source tree, and INFOPATH is not defined, the `info' directory in the
source tree is used as the first element of `Info-directory-list', 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
104

105
(defcustom Info-additional-directory-list nil
106
  "List of additional directories to search for Info documentation files.
107 108 109
These directories are not searched for merging the `dir' file."
  :type '(repeat directory)
  :group 'info)
110

Jim Blandy's avatar
Jim Blandy committed
111
(defvar Info-current-file nil
112 113
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
114 115
It doesn't contain directory names or file name extensions added by Info.
Can also be t when using `Info-on-current-buffer'.")
Jim Blandy's avatar
Jim Blandy committed
116 117

(defvar Info-current-subfile nil
Dave Love's avatar
Dave Love committed
118 119
  "Info subfile that is actually in the *info* buffer now.
nil if current info file is not split into subfiles.")
Jim Blandy's avatar
Jim Blandy committed
120 121 122 123

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

124
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
125 126 127
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

128 129 130
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

131 132 133
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

134
(defvar Info-index-alternatives nil
Dave Love's avatar
Dave Love committed
135
  "List of possible matches for last `Info-index' command.")
136

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

190
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
191 192 193 194 195 196
;; 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))
197 198 199
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
200
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
201
      ;; get rid of the one in SUFFIX (unless suffix is empty).
202
      (or (and (<= ext-len 0)
203
	       (not (eq (aref filename (1- (length filename))) ?.)))
204
	  (= (length suffix) 0)
205
	  (setq suffix (substring suffix 1)))
206 207
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
208 209 210 211 212
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

213 214 215 216
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

217 218 219
(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."
220 221 222
  (let ((tail Info-suffix-list)
	fullname decoder)
    (if (file-exists-p filename)
223 224
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
225 226 227 228 229 230 231 232
	(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))))
233
      ;; Try adding suffixes to FILENAME and see if we can find something.
234
      (while (and tail
235 236
		  (not (info-file-exists-p (info-insert-file-contents-1
					    filename (car (car tail))))))
237
	(setq tail (cdr tail)))
238 239
      ;; If we found a file with a suffix, set DECODER according to the suffix
      ;; and set FULLNAME to the file's actual name.
240
      (setq fullname (info-insert-file-contents-1 filename (car (car tail)))
241 242
	    decoder (cdr (car tail)))
      (or tail
243
	  (error "Can't find %s or any compressed version of it" filename)))
244 245 246 247 248
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
249
    (if decoder
250 251 252 253 254 255 256 257
	(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))))
258 259

(defun info-initialize ()
Dave Love's avatar
Dave Love committed
260
  "Initialize `Info-directory-list', if that hasn't been done yet."
261 262 263 264 265 266 267
  (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
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
	    (prune-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/"
							 installation-directory))))
		       (not (file-exists-p alternative)))
		   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)))))))))))
293

294 295 296 297 298 299 300
;;;###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)))
301

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

Jim Blandy's avatar
Jim Blandy committed
304 305 306 307 308
;;;###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
309 310
Called from a program, FILE may specify an Info node of the form
`(FILENAME)NODENAME'.
Jim Blandy's avatar
Jim Blandy committed
311 312

In interactive use, a prefix argument directs this command
Richard M. Stallman's avatar
Richard M. Stallman committed
313 314 315
to read a file name from the minibuffer.

The search path for Info files is in the variable `Info-directory-list'.
316
The top-level Info directory is made by combining all the files named `dir'
Richard M. Stallman's avatar
Richard M. Stallman committed
317
in all the directories in that path."
Jim Blandy's avatar
Jim Blandy committed
318 319 320
  (interactive (if current-prefix-arg
		   (list (read-file-name "Info file name: " nil nil t))))
  (if file
321 322 323 324 325 326 327 328 329
      (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 ")"))))
330 331 332
    (if (get-buffer "*info*")
	(pop-to-buffer "*info*")
      (Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
333

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
;;;###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)))
351

352 353 354 355 356 357 358 359 360 361 362 363
;; 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)
364 365
  (and (bobp)				; are we at beginning of buffer?
       (looking-at "\^_")		; does it begin with node delimiter?
366 367 368
       (let (beg)
	 (forward-line 1)
	 (setq beg (point))
369
	 (forward-line 1)		; does the line after delimiter match REGEXP?
370 371
	 (re-search-backward regexp beg t))))

Jim Blandy's avatar
Jim Blandy committed
372
(defun Info-find-node (filename nodename &optional no-going-back)
Dave Love's avatar
Dave Love committed
373 374 375
  "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."
376
  (info-initialize)
Jim Blandy's avatar
Jim Blandy committed
377 378
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
379
  (if (stringp filename)
Jim Blandy's avatar
Jim Blandy committed
380
      (let (temp temp-downcase found)
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 410 411 412 413 414 415 416 417 418 419 420 421
        (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
422
  ;; Go into info buffer.
423
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
424 425 426 427 428 429 430 431 432 433 434
  (Info-find-node-2 filename nodename no-going-back))

(defun Info-on-current-buffer (&optional nodename)
  "Use the `Info-mode' to browse the current info buffer.
If a prefix arg is provided, it queries for the NODENAME which
else defaults to `Top'."
  (interactive
   (list (if current-prefix-arg
	     (completing-read "Node name: " (Info-build-node-completions)
			      nil t "Top")
	   "Top")))
435
  (info-initialize)
436 437 438 439
  (Info-mode)
  (set (make-local-variable 'Info-current-file) t)
  (Info-find-node-2 nil nodename))

440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 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 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
(defun Info-find-in-tag-table-1 (marker regexp case-fold)
  "Find a node in a tag table.
MARKER specifies the buffer and position to start searching at.
REGEXP is a regular expression matching nodes or references.  Its first
group should match `Node:' or `Ref:'.
CASE-FOLD t means search for a case-insensitive match.
If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
where the match was found, and MODE is `major-mode' of the buffer in
which the match was found."
  (let ((case-fold-search case-fold)
	found-mode guesspos found-anchor)
    (save-excursion
      (set-buffer (marker-buffer marker))
      (goto-char marker)
    
      ;; Search tag table
      (beginning-of-line)
      (when (re-search-forward regexp nil t)
	(list (string-equal "Ref:" (match-string 1))
	      (1+ (read (current-buffer)))
	      major-mode)))))

(defun Info-find-in-tag-table (marker regexp)
  "Find a node in a tag table.
MARKER specifies the buffer and position to start searching at.
REGEXP is a regular expression matching nodes or references.  Its first
group should match `Node:' or `Ref:'.
If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
where the match was found, and MODE is `major-mode' of the buffer in
which the match was found.
This function tries to find a case-sensitive match first, then a
case-insensitive match is tried."
  (let ((result (Info-find-in-tag-table-1 marker regexp nil)))
    (when (null (car result))
      (setq result (Info-find-in-tag-table-1 marker regexp t)))
    result))

(defun Info-find-node-in-buffer-1 (regexp case-fold)
  "Find a node or anchor in the current buffer.
REGEXP is a regular expression matching nodes or references.  Its first
group should match `Node:' or `Ref:'.
CASE-FOLD t means search for a case-insensitive match.
Value is the position at which a match was found, or nil if not found."
  (let ((case-fold-search case-fold)
	found)
    (save-excursion
      (when (Info-node-at-bob-matching regexp)
	(setq found (point)))
      (while (and (not found)
		  (search-forward "\n\^_" nil t))
	(forward-line 1)
	(let ((beg (point)))
	  (forward-line 1)
	  (when (re-search-backward regexp beg t)
	    (beginning-of-line)
	    (setq found (point)))))
      found)))
		  
(defun Info-find-node-in-buffer (regexp)
  "Find a node or anchor in the current buffer.
REGEXP is a regular expression matching nodes or references.  Its first
group should match `Node:' or `Ref:'.
Value is the position at which a match was found, or nil if not found.
This function looks for a case-sensitive match first.  If none is found,
a case-insensitive match is tried."
  (or (Info-find-node-in-buffer-1 regexp nil)
      (Info-find-node-in-buffer-1 regexp t)))
  
510
(defun Info-find-node-2 (filename nodename &optional no-going-back)
511
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
512 513 514 515 516
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
517 518
      (let ((case-fold-search t)
	    anchorpos)
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
        ;; 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)
557
                            (buffer-disable-undo (current-buffer))
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
                            (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.
583
	  (let ((guesspos (point-min))
584
		(regexp (concat "\\(Node:\\|Ref:\\) *\\("
585 586 587
				(if (stringp nodename) 
				    (regexp-quote nodename)
				  "")
588
				"\\) *[,\t\n\177]"))
589
		(nodepos nil))
590

591
	    (catch 'foo
592
	      
593
	      ;; First, search a tag table, if any
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
	      (when (marker-position Info-tag-table-marker)
		(let* ((m Info-tag-table-marker)
		       (found (Info-find-in-tag-table m regexp)))
		  
		  (when found
		    ;; FOUND is (ANCHOR POS MODE).
		    (setq guesspos (nth 1 found))
		    
		    ;; If this is an indirect file, determine which
		    ;; file really holds this node and read it in.
		    (unless (eq (nth 2 found) '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)))
609 610

		    ;; Handle anchor
611 612 613
		    (when (nth 0 found)
		      (goto-char (setq anchorpos guesspos))
		      (throw 'foo t)))))
614 615 616 617

	      ;; Else we may have a node, which we search for:
	      (goto-char (max (point-min)
			      (- (byte-to-position guesspos) 1000)))
618 619 620 621 622 623 624 625 626 627 628
	      
	      ;; Now search from our advised position (or from beg of
	      ;; buffer) to find the actual node.  First, check
	      ;; whether the node is right where we are, in case the
	      ;; buffer begins with a node.
	      (let ((pos (Info-find-node-in-buffer regexp)))
		(when pos
		  (goto-char pos)
		  (throw 'foo t))
		(error "No such anchor in tag table or node in tag table or file: %s"
		       nodename)))
629 630 631

	    (Info-select-node)
	    (goto-char (or anchorpos (point-min))))))
Jim Blandy's avatar
Jim Blandy committed
632 633
    ;; If we did not finish finding the specified node,
    ;; go back to the previous one.
634
    (or Info-current-node no-going-back (null Info-history)
635 636 637 638
        (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
639

640 641
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
642 643
(defvar Info-dir-contents nil)

644 645 646 647
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

648 649 650 651
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

652 653
(defvar Info-dir-file-name nil)

654
;; Construct the Info directory node by merging the files named `dir'
655 656 657
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
658
(defun Info-insert-dir ()
659 660 661 662
  (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
663 664 665 666 667 668 669 670 671
		       (mapcar (lambda (elt)
				 (let ((curr (file-attributes
					      ;; Handle symlinks
					      (file-truename (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)))
672
			       Info-dir-file-attributes))))
673 674 675
      (progn
	(insert Info-dir-contents)
	(goto-char (point-min)))
676 677 678 679
    (let ((dirs (if Info-additional-directory-list
                              (append Info-directory-list
                                      Info-additional-directory-list)
                            Info-directory-list))
680 681
	  ;; Bind this in case the user sets it to nil.
	  (case-fold-search t)
682 683
	  ;; This is set non-nil if we find a problem in some input files.
	  problems
684
	  buffers buffer others nodes dirs-done)
685

686 687
      (setq Info-dir-file-attributes nil)

688
      ;; Search the directory list for the directory file.
689
      (while dirs
690 691 692 693 694
	(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.
695 696 697 698 699 700 701 702 703 704 705
	      (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)))))
706 707 708 709
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
710 711 712 713
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
714
		      (set-buffer (generate-new-buffer " info dir"))
715 716 717
		      (condition-case nil
			  (progn
			    (insert-file-contents file)
718 719
			    (make-local-variable 'Info-dir-file-name)
			    (setq Info-dir-file-name file)
720 721 722 723 724
			    (setq buffers (cons (current-buffer) buffers)
				  Info-dir-file-attributes
				  (cons (cons file attrs)
					Info-dir-file-attributes)))
			(error (kill-buffer (current-buffer))))))))
725 726
	  (or (cdr dirs) (setq Info-dir-contents-directory
			       (file-name-as-directory (car dirs))))
727
	  (setq dirs (cdr dirs))))
728

729
      (or buffers
730
	  (error "Can't find the Info directory node"))
731
      ;; Distinguish the dir file that comes with Emacs from all the
732
      ;; others.  Yes, that is really what this is supposed to do.
733 734 735 736
      ;; 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))
737

738 739 740
      ;; 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.
741
      (insert-buffer buffer)
742

743 744
      ;; Look at each of the other buffers one by one.
      (while others
745
	(let ((other (car others))
746 747
	      ;; Bind this in case the user sets it to nil.
	      (case-fold-search t)
748
	      this-buffer-nodes)
749 750 751 752 753 754 755 756 757
	  ;; 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))
758 759 760
		(or (search-backward "\n\^_" nil 'move)
		    (looking-at "\^_")
		    (signal 'search-failed (list "\n\^_")))
761 762
		(search-forward "Node: ")
		(setq nodename (Info-following-node-name))
763
		(search-forward "\n\^_" nil 'move)
764 765
		(beginning-of-line)
		(setq end (point))
766 767 768 769 770 771 772
		(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))))
773
	(setq others (cdr others)))
Dave Love's avatar
Dave Love committed
774 775
      ;; Add to the main menu a menu item for each other node.
      (let ((case-fold-search t)
776
	    (re-search-forward "^\\* Menu:")))
777 778 779 780
      (forward-line 1)
      (let ((menu-items '("top"))
	    (nodes nodes)
	    (case-fold-search t)
781
	    (end (save-excursion (search-forward "\^_" nil t) (point))))
782 783
	(while nodes
	  (let ((nodename (car (car nodes))))
784 785
	    (save-excursion
	      (or (member (downcase nodename) menu-items)
786
		  (re-search-forward (concat "^\\* +"
787 788 789 790 791 792
					     (regexp-quote nodename)
					     "::")
				     end t)
		  (progn
		    (insert "* " nodename "::" "\n")
		    (setq menu-items (cons nodename menu-items))))))
793 794 795 796
	  (setq nodes (cdr nodes))))
      ;; Now take each node of each of the other buffers
      ;; and merge it into the main buffer.
      (while nodes
797 798
	(let ((case-fold-search t)
	      (nodename (car (car nodes))))
799 800
	  (goto-char (point-min))
	  ;; Find the like-named node in the main buffer.
801
	  (if (re-search-forward (concat "^\^_.*\n.*Node: "
802 803 804 805
					 (regexp-quote nodename)
					 "[,\n\t]")
				 nil t)
	      (progn
806
		(search-forward "\n\^_" nil 'move)
807 808
		(beginning-of-line)
		(insert "\n"))
809 810
	    ;; If none exists, add one.
	    (goto-char (point-max))
811
	    (insert "\^_\nFile: dir\tNode: " nodename "\n\n* Menu:\n\n"))
812 813
	  ;; Merge the text from the other buffer's menu
	  ;; into the menu in the like-named node in the main buffer.
814
	  (apply 'insert-buffer-substring (cdr (car nodes))))
815 816 817 818
	(setq nodes (cdr nodes)))
      ;; Kill all the buffers we just made.
      (while buffers
	(kill-buffer (car buffers))
819
	(setq buffers (cdr buffers)))
820 821 822 823
      (goto-char (point-min))
      (if problems
	  (message "Composing main Info directory...problems encountered, see `*Messages*'")
	(message "Composing main Info directory...done")))
824 825
    (setq Info-dir-contents (buffer-string)))
  (setq default-directory Info-dir-contents-directory))
826

827 828
;; 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
829
(defun Info-read-subfile (nodepos)
830 831
  ;; 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
832 833
  (let (lastfilepos
	lastfilename)
834 835 836 837
    (if (numberp nodepos)
	(save-excursion
	  (set-buffer (marker-buffer Info-tag-table-marker))
	  (goto-char (point-min))
838 839
	  (or (looking-at "\^_")
	      (search-forward "\n\^_"))
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
	  (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))
859 860
    ;; Assume previous buffer is in Info-mode.
    ;; (set-buffer (get-buffer "*info*"))
Jim Blandy's avatar
Jim Blandy committed
861 862 863 864 865
    (or (equal Info-current-subfile lastfilename)
	(let ((buffer-read-only nil))
	  (setq buffer-file-name nil)
	  (widen)
	  (erase-buffer)
866
	  (info-insert-file-contents lastfilename)
Jim Blandy's avatar
Jim Blandy committed
867 868 869
	  (set-buffer-modified-p nil)
	  (setq Info-current-subfile lastfilename)))
    (goto-char (point-min))
870 871 872
    (if (looking-at "\^_")
	(forward-char 1)
      (search-forward "\n\^_"))
873 874
    (if (numberp nodepos)
	(+ (- nodepos lastfilepos) (point)))))
Jim Blandy's avatar
Jim Blandy committed
875 876

(defun Info-select-node ()
Dave Love's avatar
Dave Love committed
877 878
"Select the info node that point is in.
Bind this in case the user sets it to nil."
879 880
  (let ((case-fold-search t))
    (save-excursion
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
      ;; Find beginning of node.
      (if (search-backward "\n\^_" nil 'move)
	  (forward-line 2)
	(if (looking-at "\^_")
	    (forward-line 1)
	  (signal 'search-failed (list "\n\^_"))))
      ;; 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
911 912 913 914

(defun Info-set-mode-line ()
  (setq mode-line-buffer-identification
	(concat
915 916 917 918 919
	 "  *Info* ("
	 (file-name-nondirectory (if (stringp Info-current-file)
				     Info-current-file
				   (or buffer-file-name "")))
	 ") "
Jim Blandy's avatar
Jim Blandy committed
920 921 922 923 924
	 (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.

925 926 927 928 929
(defun Info-goto-node (nodename &optional fork)
  "Go to info node named NAME.  Give just NODENAME or (FILENAME)NODENAME.
If FORK is non-nil, show the node in a new info buffer.
If FORK is a string, it is the name to use for the new buffer."
  (interactive (list (Info-read-node-name "Goto node: ") current-prefix-arg))
930
  (info-initialize)
931
  (if fork
932 933
      (set-buffer
       (clone-buffer (concat "*info-" (if (stringp fork) fork nodename) "*") t)))
Jim Blandy's avatar
Jim Blandy committed
934 935 936 937 938 939 940 941 942 943 944
  (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))))
945
    (if transient-mark-mode (deactivate-mark))
Jim Blandy's avatar
Jim Blandy committed
946 947
    (Info-find-node (if (equal filename "") nil filename)
		    (if (equal nodename "") "Top" nodename))))
948

949 950
(defvar Info-read-node-completion-table)

951
;; This function is used as the "completion table" while reading a node name.
952
;; It does completion using the alist in Info-read-node-completion-table
953 954 955 956 957 958
;; 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
959
	     (try-completion string Info-read-node-completion-table predicate)))
960 961 962
	  ((eq code t)
	   (if no-completion
	       nil
963
	     (all-completions string Info-read-node-completion-table predicate)))
964 965 966
	  ((eq code 'lambda)
	   (if no-completion
	       t
967
	     (assoc string Info-read-node-completion-table))))))
968

969 970
(defun Info-read-node-name (prompt &optional default)
  (let* ((completion-ignore-case t)
971
	 (Info-read-node-completion-table (Info-build-node-completions))
972
	 (nodename (completing-read prompt 'Info-read-node-name-1 nil t)))
973 974 975 976 977 978 979
    (if (equal nodename "")
	(or default
	    (Info-read-node-name prompt))
      nodename)))

(defun Info-build-node-completions ()
  (or Info-current-file-completions
980 981
      (let ((compl nil)
	    ;; Bind this in case the user sets it to nil.
982 983
	    (case-fold-search t)
	    (node-regexp "Node: *\\([^,\n]*\\) *[,\n\t]"))
984 985 986
	(save-excursion
	  (save-restriction
	    (if (marker-buffer Info-tag-table-marker)
987 988
		(let ((marker Info-tag-table-marker))
		  (set-buffer (marker-buffer marker))
989
		  (widen)
990
		  (goto-char marker)
Dave Love's avatar
Dave Love committed
991
		  (while (re-search-forward "\n\\(Node\\|Ref\\): \\(.*\\)\177" nil t)
992
		    (setq compl
Dave Love's avatar
Dave Love committed
993
			  (cons (list (match-string-no-properties 2))
994 995 996
				compl))))
	      (widen)
	      (goto-char (point-min))
997 998
	      ;; If the buffer begins with a node header, process that first.
	      (if (Info-node-at-bob-matching node-regexp)
999
		  (setq compl (list (match-string-no-properties 1))))
1000
	      ;; Now for the rest of the nodes.
1001 1002 1003 1004
	      (while (search-forward "\n\^_" nil t)
		(forward-line 1)
		(let ((beg (point)))
		  (forward-line 1)
1005
		  (if (re-search-backward node-regexp beg t)
1006
		      (setq compl
1007
			    (cons (list (match-string-no-properties 1))
1008
				  compl))))))))
1009
	(setq compl (cons '("*") compl))
1010
	(setq Info-current-file-completions compl))))
Jim Blandy's avatar
Jim Blandy committed
1011

Jim Blandy's avatar
Jim Blandy committed
1012 1013
(defun Info-restore-point (hl)
  "If this node has been visited, restore the point value when we left."
1014 1015
  (while hl
    (if (and (equal (nth 0 (car hl)) Info-current-file)
1016 1017
	     ;; Use string-equal, not equal, to ignore text props.
	     (string-equal (nth 1 (car hl)) Info-current-node))
1018
	(progn
1019 1020
	  (goto-char (nth 2 (car hl)))
	  (setq hl nil))		;terminate the while at next iter
1021
      (setq hl (cdr hl)))))
Jim Blandy's avatar
Jim Blandy committed
1022

1023 1024
(defvar Info-search-history nil
  "The history list for `Info-search'.")
Jim Blandy's avatar
Jim Blandy committed
1025 1026 1027

(defun Info-search (regexp)
  "Search for REGEXP, starting from point, and select node it's found in."
1028 1029 1030 1031 1032 1033
  (interactive (list (read-string "Regexp search: "
 				  nil 'Info-search-history)))
  (when transient-mark-mode
    (deactivate-mark))
  (when (equal regexp "")
    (setq regexp (car Info-search-history)))
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
  (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
1045
	      (progn (re-search-forward regexp) (setq found (point)))
1046 1047 1048
	    (condition-case err
		(progn (re-search-forward regexp) (setq found (point)))
	      (search-failed nil)))))
1049
      (if (not found)			;can only happen in subfile case -- else would have erred
1050 1051 1052 1053
	  (unwind-protect
	      (let ((list ()))
		(save-excursion
		  (set-buffer (marker-buffer Info-tag-table-marker))
1054
		  (goto-char (point-min))