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

Colin Walters's avatar
Colin Walters committed
3
;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002
4
;;  Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

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

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

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

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

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

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

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

;;; Code:

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
(defface info-node
59 60 61
  '((((class color) (background light)) (:foreground "brown" :weight bold :slant italic))
    (((class color) (background dark)) (:foreground "white" :weight bold :slant italic))
    (t (:weight bold :slant italic)))
62 63 64 65
  "Face for Info node names."
  :group 'info)

(defface info-menu-5
66 67
  '((((class color)) (:foreground "red1"))
    (t (:underline t)))
68
  "Face for every third `*' in an Info menu."
69 70 71
  :group 'info)

(defface info-xref
72 73 74
  '((((class color) (background light)) (:foreground "magenta4" :weight bold))
    (((class color) (background dark)) (:foreground "cyan" :weight bold))
    (t (:weight bold)))
75 76 77
  "Face for Info cross-references."
  :group 'info)

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

Miles Bader's avatar
Miles Bader committed
83 84 85 86 87 88 89
(defcustom Info-use-header-line t
  "*Non-nil means to put the beginning-of-node links in an emacs header-line.
A header-line does not scroll with the rest of the buffer."
  :type 'boolean
  :group 'info)

(defface info-header-xref
90
  '((t (:inherit info-xref)))
Miles Bader's avatar
Miles Bader committed
91 92 93 94
  "Face for Info cross-references in a node header."
  :group 'info)

(defface info-header-node
95
  '((t (:inherit info-node)))
Miles Bader's avatar
Miles Bader committed
96 97 98
  "Face for Info nodes in a node header."
  :group 'info)

99
(defvar Info-directory-list nil
Jim Blandy's avatar
Jim Blandy committed
100
  "List of directories to search for Info documentation files.
Jim Blandy's avatar
Jim Blandy committed
101
nil means not yet initialized.  In this case, Info uses the environment
102
variable INFOPATH to initialize it, or `Info-default-directory-list'
103
if there is no INFOPATH variable in the environment.
104 105

When `Info-directory-list' is initialized from the value of
106 107 108 109 110 111 112
`Info-default-directory-list', and Emacs is installed in one of the
standard directories, the directory of Info files that come with Emacs
is put last (so that local Info files override standard ones).

When `Info-directory-list' is initialized from the value of
`Info-default-directory-list', and Emacs is not installed in one
of the standard directories, the first element of the resulting
113 114
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
115 116 117 118 119 120
version of Emacs you are using, will always be found first.  This
is useful when you install an experimental version of Emacs without
removing the standard installation.

If you want to override the order of directories in
`Info-default-directory-list', set INFOPATH in the environment.
121 122

If you run the Emacs executable from the `src' directory in the Emacs
123 124 125 126
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
127

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

135 136 137 138 139 140 141 142 143 144 145 146 147
(defcustom Info-scroll-prefer-subnodes t
  "*If non-nil, \\<Info-mode-map>\\[Info-scroll-up] in a menu visits subnodes.
If this is non-nil, and you scroll far enough in a node that its menu
appears on the screen, the next \\<Info-mode-map>\\[Info-scroll-up]
moves to a subnode indicated by the following menu item.  This means
that you visit a subnode before getting to the end of the menu.

Setting this option to nil results in behavior similar to the stand-alone
Info reader program, which visits the first subnode from the menu only
when you hit the end of the current node."
  :type 'boolean
  :group 'info)

148
(defcustom Info-mode-hook '(turn-on-font-lock)
Colin Walters's avatar
Colin Walters committed
149 150 151 152
  "Hooks run when `info-mode' is called."
  :type 'hook
  :group 'info)

Jim Blandy's avatar
Jim Blandy committed
153
(defvar Info-current-file nil
154 155
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
156 157
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
158 159

(defvar Info-current-subfile nil
Dave Love's avatar
Dave Love committed
160 161
  "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
162 163 164 165

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

166
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
167 168 169
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

170 171 172
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

173 174 175
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

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

179 180
(defvar Info-standalone nil
  "Non-nil if Emacs was started solely as an Info browser.")
181

182
(defvar Info-suffix-list
183 184
  ;; The MS-DOS list should work both when long file names are
  ;; supported (Windows 9X), and when only 8+3 file names are available.
185 186 187
  (if (eq system-type 'ms-dos)
      '( (".gz"      . "gunzip")
	 (".z"       . "gunzip")
188
	 (".bz2"     . ("bzip2" "-dc"))
189 190 191 192 193 194 195 196
	 (".inz"     . "gunzip")
	 (".igz"     . "gunzip")
	 (".info.Z"  . "gunzip")
	 (".info.gz" . "gunzip")
	 ("-info.Z"  . "gunzip")
	 ("-info.gz" . "gunzip")
	 ("/index.gz". "gunzip")
	 ("/index.z" . "gunzip")
197
	 (".inf"     . nil)
198 199 200
	 (".info"    . nil)
	 ("-info"    . nil)
	 ("/index"   . nil)
201
	 (""         . nil))
202 203 204 205
    '( (".info.Z".    "uncompress")
       (".info.Y".    "unyabba")
       (".info.gz".   "gunzip")
       (".info.z".    "gunzip")
206
       (".info.bz2" . ("bzip2" "-dc"))
207 208 209 210
       (".info".      nil)
       ("-info.Z".   "uncompress")
       ("-info.Y".   "unyabba")
       ("-info.gz".  "gunzip")
211
       ("-info.bz2" . ("bzip2" "-dc"))
212 213 214 215 216 217
       ("-info.z".   "gunzip")
       ("-info".     nil)
       ("/index.Z".   "uncompress")
       ("/index.Y".   "unyabba")
       ("/index.gz".  "gunzip")
       ("/index.z".   "gunzip")
218
       ("/index.bz2". ("bzip2" "-dc"))
219 220 221 222 223
       ("/index".     nil)
       (".Z".         "uncompress")
       (".Y".         "unyabba")
       (".gz".        "gunzip")
       (".z".         "gunzip")
224
       (".bz2" .      ("bzip2" "-dc"))
225
       ("".           nil)))
226 227
  "List of file name suffixes and associated decoding commands.
Each entry should be (SUFFIX . STRING); the file is given to
228 229 230 231 232 233
the command as standard input.

STRING may be a list of strings.  In that case, the first element is
the command name, and the rest are arguments to that command.

If STRING is nil, no decoding is done.
234 235
Because the SUFFIXes are tried in order, the empty string should
be last in the list.")
236

237
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
238 239 240 241
;; First, on MS-DOS with no long file names support, delete some of
;; the extension in FILENAME to make room.
(defun info-insert-file-contents-1 (filename suffix lfn)
  (if lfn	; long file names are supported
242 243
      (concat filename suffix)
    (let* ((sans-exts (file-name-sans-extension filename))
244 245 246
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
247
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
248
      ;; get rid of the one in SUFFIX (unless suffix is empty).
249
      (or (and (<= ext-len 0)
250
	       (not (eq (aref filename (1- (length filename))) ?.)))
251
	  (= (length suffix) 0)
252
	  (setq suffix (substring suffix 1)))
253 254
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
255 256 257 258 259
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

260 261 262 263
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

264 265 266
(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."
267 268 269 270 271 272
  (let* ((tail Info-suffix-list)
	 (lfn (or (not (fboundp 'msdos-long-file-names))
		  (msdos-long-file-names)))
	 (check-short (and (fboundp 'msdos-long-file-names)
			   lfn))
	 fullname decoder done)
273
    (if (info-file-exists-p filename)
274 275
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
276 277 278 279 280 281 282 283
	(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))))
284
      ;; Try adding suffixes to FILENAME and see if we can find something.
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
      (while (and tail (not done))
	(setq fullname (info-insert-file-contents-1 filename
						    (car (car tail)) lfn))
	(if (info-file-exists-p fullname)
	    (setq done t
		  ;; If we found a file with a suffix, set DECODER
		  ;; according to the suffix.
		  decoder (cdr (car tail)))
	  ;; When the MS-DOS port runs on Windows, we need to check
	  ;; the short variant of a long file name as well.
	  (when check-short
	    (setq fullname (info-insert-file-contents-1 filename
							(car (car tail)) nil))
	    (if (info-file-exists-p fullname)
		(setq done t
		      decoder (cdr (car tail))))))
301 302
	(setq tail (cdr tail)))
      (or tail
303
	  (error "Can't find %s or any compressed version of it" filename)))
304 305 306 307 308
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
309
    (if decoder
310 311 312 313 314 315
	(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)))
316 317 318 319
	    (or (consp decoder)
		(setq decoder (list decoder)))
	    (apply 'call-process-region (point-min) (point-max)
		   (car decoder) t t nil (cdr decoder))))
320
      (insert-file-contents fullname visit))))
321 322

(defun info-initialize ()
Dave Love's avatar
Dave Love committed
323
  "Initialize `Info-directory-list', if that hasn't been done yet."
324 325 326 327
  (unless Info-directory-list
    (let ((path (getenv "INFOPATH"))
	  (source (expand-file-name "info/" source-directory))
	  (sibling (if installation-directory
328
		       (expand-file-name "info/" installation-directory)
329
		     (if invocation-directory
330 331 332 333 334 335 336 337 338 339
			 (let ((infodir (expand-file-name
					 "../info/"
					 invocation-directory)))
			   (if (file-exists-p infodir)
			       infodir
			     (setq infodir (expand-file-name
					    "../../../info/"
					    invocation-directory))
			     (and (file-exists-p infodir)
				  infodir))))))
340 341
	  alternative)
      (setq Info-directory-list
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
	    (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)))))))))))
367

368 369 370 371 372 373 374
;;;###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)))
375

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

Jim Blandy's avatar
Jim Blandy committed
378 379 380 381 382
;;;###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
383 384
Called from a program, FILE may specify an Info node of the form
`(FILENAME)NODENAME'.
Jim Blandy's avatar
Jim Blandy committed
385 386

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

The search path for Info files is in the variable `Info-directory-list'.
390
The top-level Info directory is made by combining all the files named `dir'
Richard M. Stallman's avatar
Richard M. Stallman committed
391
in all the directories in that path."
Jim Blandy's avatar
Jim Blandy committed
392 393 394
  (interactive (if current-prefix-arg
		   (list (read-file-name "Info file name: " nil nil t))))
  (if file
395 396 397 398 399 400 401 402 403
      (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 ")"))))
404 405 406
    (if (get-buffer "*info*")
	(pop-to-buffer "*info*")
      (Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
407

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
;;;###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)))
425

Stefan Monnier's avatar
Stefan Monnier committed
426
;; See if the accessible portion of the buffer begins with a node
427 428 429 430 431 432 433 434 435
;; 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
Stefan Monnier's avatar
Stefan Monnier committed
436
;; REGEXP, if the function succeeds, nil otherwise.
437
(defun Info-node-at-bob-matching (regexp)
438 439
  (and (bobp)				; are we at beginning of buffer?
       (looking-at "\^_")		; does it begin with node delimiter?
440 441 442
       (let (beg)
	 (forward-line 1)
	 (setq beg (point))
443
	 (forward-line 1)		; does the line after delimiter match REGEXP?
444 445
	 (re-search-backward regexp beg t))))

Jim Blandy's avatar
Jim Blandy committed
446
(defun Info-find-node (filename nodename &optional no-going-back)
Dave Love's avatar
Dave Love committed
447 448 449
  "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."
450
  (info-initialize)
Jim Blandy's avatar
Jim Blandy committed
451 452
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
453
  (if (stringp filename)
Jim Blandy's avatar
Jim Blandy committed
454
      (let (temp temp-downcase found)
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
        (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.
476 477 478
              (let ((suffix-list Info-suffix-list)
		    (lfn (or (not (fboundp 'msdos-long-file-names))
			     (msdos-long-file-names))))
479 480 481
                (while (and suffix-list (not found))
                  (cond ((info-file-exists-p
                          (info-insert-file-contents-1
482
                           temp (car (car suffix-list)) lfn))
483 484 485
                         (setq found temp))
                        ((info-file-exists-p
                          (info-insert-file-contents-1
486 487 488 489 490 491 492 493
                           temp-downcase (car (car suffix-list)) lfn))
                         (setq found temp-downcase))
			((and (fboundp 'msdos-long-file-names)
			      lfn
			      (info-file-exists-p
			       (info-insert-file-contents-1
				temp (car (car suffix-list)) nil)))
			 (setq found temp)))
494 495 496 497 498 499 500 501 502 503
                  (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
504
  ;; Go into info buffer.
505
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
506 507 508 509 510
  (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
511
else defaults to \"Top\"."
512 513 514
  (interactive
   (list (if current-prefix-arg
	     (completing-read "Node name: " (Info-build-node-completions)
515 516
			      nil t "Top"))))
  (unless nodename (setq nodename "Top"))
517
  (info-initialize)
518 519 520 521
  (Info-mode)
  (set (make-local-variable 'Info-current-file) t)
  (Info-find-node-2 nil nodename))

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
(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))
542
	      (+ (point-min) (read (current-buffer)))
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 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 583 584 585 586 587 588 589 590 591
	      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)))
  
592
(defun Info-find-node-2 (filename nodename &optional no-going-back)
593
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
594 595 596 597 598
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
599 600
      (let ((case-fold-search t)
	    anchorpos)
601 602 603 604 605 606 607 608 609 610 611
        ;; 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)
612
                (info-insert-file-contents filename nil)
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
                (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)
639
                            (buffer-disable-undo (current-buffer))
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
                            (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.
665
	  (let ((guesspos (point-min))
666
		(regexp (concat "\\(Node:\\|Ref:\\) *\\("
667
				(if (stringp nodename)
668 669
				    (regexp-quote nodename)
				  "")
670
				"\\) *[,\t\n\177]"))
671
		(nodepos nil))
672

673
	    (catch 'foo
674
	      
675
	      ;; First, search a tag table, if any
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
	      (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)))
691 692

		    ;; Handle anchor
693 694 695
		    (when (nth 0 found)
		      (goto-char (setq anchorpos guesspos))
		      (throw 'foo t)))))
696 697 698 699

	      ;; Else we may have a node, which we search for:
	      (goto-char (max (point-min)
			      (- (byte-to-position guesspos) 1000)))
700 701 702 703 704 705 706 707 708 709 710
	      
	      ;; 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)))
711 712 713

	    (Info-select-node)
	    (goto-char (or anchorpos (point-min))))))
Jim Blandy's avatar
Jim Blandy committed
714 715
    ;; If we did not finish finding the specified node,
    ;; go back to the previous one.
716
    (or Info-current-node no-going-back (null Info-history)
717 718 719 720
        (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
721

722 723
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
724 725
(defvar Info-dir-contents nil)

726 727 728 729
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

730 731 732 733
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

734 735
(defvar Info-dir-file-name nil)

736
;; Construct the Info directory node by merging the files named `dir'
737 738 739
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
740
(defun Info-insert-dir ()
741 742 743 744
  (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
745 746 747 748 749 750 751 752 753
		       (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)))
754
			       Info-dir-file-attributes))))
755 756 757
      (progn
	(insert Info-dir-contents)
	(goto-char (point-min)))
758 759 760 761
    (let ((dirs (if Info-additional-directory-list
                              (append Info-directory-list
                                      Info-additional-directory-list)
                            Info-directory-list))
762 763
	  ;; Bind this in case the user sets it to nil.
	  (case-fold-search t)
764 765
	  ;; This is set non-nil if we find a problem in some input files.
	  problems
766
	  buffers buffer others nodes dirs-done)
767

768 769
      (setq Info-dir-file-attributes nil)

770
      ;; Search the directory list for the directory file.
771
      (while dirs
772 773 774 775 776
	(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.
777 778 779 780 781 782 783 784 785 786 787
	      (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)))))
788 789 790 791
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
792 793 794 795
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
796
		      (set-buffer (generate-new-buffer " info dir"))
797 798 799
		      (condition-case nil
			  (progn
			    (insert-file-contents file)
800 801
			    (make-local-variable 'Info-dir-file-name)
			    (setq Info-dir-file-name file)
802 803 804 805 806
			    (setq buffers (cons (current-buffer) buffers)
				  Info-dir-file-attributes
				  (cons (cons file attrs)
					Info-dir-file-attributes)))
			(error (kill-buffer (current-buffer))))))))
807 808
	  (or (cdr dirs) (setq Info-dir-contents-directory
			       (file-name-as-directory (car dirs))))
809
	  (setq dirs (cdr dirs))))
810

811
      (or buffers
812
	  (error "Can't find the Info directory node"))
813
      ;; Distinguish the dir file that comes with Emacs from all the
814
      ;; others.  Yes, that is really what this is supposed to do.
815 816 817 818
      ;; 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))
819

820 821 822
      ;; 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.
823
      (insert-buffer buffer)
824

825 826
      ;; Look at each of the other buffers one by one.
      (while others
827
	(let ((other (car others))
828 829
	      ;; Bind this in case the user sets it to nil.
	      (case-fold-search t)
830
	      this-buffer-nodes)
831 832 833 834 835 836 837 838
	  ;; 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)
839 840
		(while (and (eolp) (not (eobp)))
		  (forward-line 1))
841
		(setq beg (point))
842 843 844
		(or (search-backward "\n\^_" nil 'move)
		    (looking-at "\^_")
		    (signal 'search-failed (list "\n\^_")))
845 846
		(search-forward "Node: ")
		(setq nodename (Info-following-node-name))
847
		(search-forward "\n\^_" nil 'move)
848 849
		(beginning-of-line)
		(setq end (point))
850 851 852 853 854 855 856
		(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))))
857
	(setq others (cdr others)))
Dave Love's avatar
Dave Love committed
858 859
      ;; Add to the main menu a menu item for each other node.
      (let ((case-fold-search t)
860
	    (re-search-forward "^\\* Menu:")))
861 862 863 864
      (forward-line 1)
      (let ((menu-items '("top"))
	    (nodes nodes)
	    (case-fold-search t)
865
	    (end (save-excursion (search-forward "\^_" nil t) (point))))
866 867
	(while nodes
	  (let ((nodename (car (car nodes))))
868 869
	    (save-excursion
	      (or (member (downcase nodename) menu-items)
870
		  (re-search-forward (concat "^\\* +"
871 872 873 874 875 876
					     (regexp-quote nodename)
					     "::")
				     end t)
		  (progn
		    (insert "* " nodename "::" "\n")
		    (setq menu-items (cons nodename menu-items))))))
877 878 879 880
	  (setq nodes (cdr nodes))))
      ;; Now take each node of each of the other buffers
      ;; and merge it into the main buffer.
      (while nodes
881 882
	(let ((case-fold-search t)
	      (nodename (car (car nodes))))
883 884
	  (goto-char (point-min))
	  ;; Find the like-named node in the main buffer.
885
	  (if (re-search-forward (concat "^\^_.*\n.*Node: "
886 887 888 889
					 (regexp-quote nodename)
					 "[,\n\t]")
				 nil t)
	      (progn
890
		(search-forward "\n\^_" nil 'move)
891 892
		(beginning-of-line)
		(insert "\n"))
893 894
	    ;; If none exists, add one.
	    (goto-char (point-max))
895
	    (insert "\^_\nFile: dir\tNode: " nodename "\n\n* Menu:\n\n"))
896 897
	  ;; Merge the text from the other buffer's menu
	  ;; into the menu in the like-named node in the main buffer.
898
	  (apply 'insert-buffer-substring (cdr (car nodes))))
899 900 901 902
	(setq nodes (cdr nodes)))
      ;; Kill all the buffers we just made.
      (while buffers
	(kill-buffer (car buffers))
903
	(setq buffers (cdr buffers)))
904 905 906 907
      (goto-char (point-min))
      (if problems
	  (message "Composing main Info directory...problems encountered, see `*Messages*'")
	(message "Composing main Info directory...done")))
908 909
    (setq Info-dir-contents (buffer-string)))
  (setq default-directory Info-dir-contents-directory))
910

911 912
;; 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
913
(defun Info-read-subfile (nodepos)
914 915
  ;; 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
916 917
  (let (lastfilepos
	lastfilename)
918 919 920 921
    (if (numberp nodepos)
	(save-excursion
	  (set-buffer (marker-buffer Info-tag-table-marker))
	  (goto-char (point-min))
922 923
	  (or (looking-at "\^_")
	      (search-forward "\n\^_"))
924 925 926 927 928 929 930 931
	  (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)))
932
		    (setq thisfilepos (+ (point-min) (read (current-buffer))))
933 934 935 936 937 938 939 940 941 942
		    ;; 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))
943 944
    ;; Assume previous buffer is in Info-mode.
    ;; (set-buffer (get-buffer "*info*"))
Jim Blandy's avatar
Jim Blandy committed
945 946 947 948 949
    (or (equal Info-current-subfile lastfilename)
	(let ((buffer-read-only nil))
	  (setq buffer-file-name nil)
	  (widen)
	  (erase-buffer)
950
	  (info-insert-file-contents lastfilename)
Jim Blandy's avatar
Jim Blandy committed
951 952
	  (set-buffer-modified-p nil)
	  (setq Info-current-subfile lastfilename)))
953 954
    ;; Widen in case we are in the same subfile as before.
    (widen)
Jim Blandy's avatar
Jim Blandy committed
955
    (goto-char (point-min))
956 957 958
    (if (looking-at "\^_")
	(forward-char 1)
      (search-forward "\n\^_"))
959 960
    (if (numberp nodepos)
	(+ (- nodepos lastfilepos) (point)))))
Jim Blandy's avatar
Jim Blandy committed
961

Miles Bader's avatar
Miles Bader committed
962 963
(defvar Info-header-line nil
  "If the info node header is hidden, the text of the header.")
964
(put 'Info-header-line 'risky-local-variable t)
Miles Bader's avatar
Miles Bader committed
965

Jim Blandy's avatar
Jim Blandy committed
966
(defun Info-select-node ()
Dave Love's avatar
Dave Love committed
967 968
"Select the info node that point is in.
Bind this in case the user sets it to nil."
969 970
  (let ((case-fold-search t))
    (save-excursion
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987
      ;; 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)
Miles Bader's avatar
Miles Bader committed
988
	;; Narrow to the node contents
989 990 991 992 993 994 995 996 997 998 999
	(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))
Colin Walters's avatar
Colin Walters committed
1000
	(Info-fontify-node)
Miles Bader's avatar
Miles Bader committed
1001
	(if Info-use-header-line
1002 1003 1004 1005 1006 1007 1008 1009
	    (progn
	      (setq Info-header-line
		    (get-text-property (point-min) 'header-line))
	      (setq header-line-format 'Info-header-line)
;;; It is useful to be able to copy the links line out of the buffer
;;; with M-w.
;;;           (narrow-to-region (1+ header-end) (point-max))
	      )
1010 1011
	  (setq Info-header-line nil)
	  (setq header-line-format nil)) ; so the header line isn't displayed
1012
	(run-hooks 'Info-selection-hook)))))
Jim Blandy's avatar
Jim Blandy committed
1013 1014 1015

(defun Info-set-mode-line ()
  (setq mode-line-buffer-identification
1016
	(nconc (propertized-buffer-identification "%b")
1017 1018 1019 1020 1021 1022 1023 1024
	       (list
		(concat " ("
			(file-name-nondirectory
			 (if (stringp Info-current-file)
			     Info-current-file
			   (or buffer-file-name "")))
			") "
			(or Info-current-node ""))))))
Jim Blandy's avatar
Jim Blandy committed
1025 1026 1027 1028

;; Go to an info node specified with a filename-and-nodename string
;; of the sort that is found in pointers in nodes.

1029
(defun Info-goto-node (nodename &optional fork)
Eli Zaretskii's avatar
Eli Zaretskii committed
1030
  "Go to info node named NODENAME.  Give just NODENAME or (FILENAME)NODENAME.
1031 1032 1033 1034
If NODENAME is of the form (FILENAME)NODENAME, the node is in the Info file
FILENAME; otherwise, NODENAME should be in the current Info file (or one of
its sub-files).
Completion is available, but only for node names in the current Info file.
1035 1036
If FORK is non-nil (interactively with a prefix arg), show the node in
a new info buffer.
1037
If FORK is a string, it is the name to use for the new buffer."
1038
  (interactive (list (Info-read-node-name "Go to node: ") current-prefix-arg))
1039
  (info-initialize)
1040
  (if fork
1041 1042
      (set-buffer
       (clone-buffer (concat "*info-" (if (stringp fork) fork nodename) "*") t)))
Jim Blandy's avatar
Jim Blandy committed
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
  (let (filename)
    (string-match "\\s *\\((\\s *\\([^\t)]*\\)\\s *)\\s *\\|\\)\\(.*\\)"
		  nodename)
    (setq filename (if (= (match-beginning 1)