info.el 96.5 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) (background light)) (:foreground "brown" :bold t :italic t))
    (((class color) (background dark)) (:foreground "white" :bold t :italic t))
66
    (t (:bold t :italic t)))
67 68 69 70
  "Face for Info node names."
  :group 'info)

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

(defface info-xref
77 78
  '((((class color) (background light)) (:foreground "magenta4" :bold t))
    (((class color) (background dark)) (:foreground "cyan" :bold t))
79
    (t (:bold t)))
80 81 82
  "Face for Info cross-references."
  :group 'info)

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

Miles Bader's avatar
Miles Bader committed
88 89 90 91 92 93 94
(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
95
  '((t (:inherit info-xref)))
Miles Bader's avatar
Miles Bader committed
96 97 98 99
  "Face for Info cross-references in a node header."
  :group 'info)

(defface info-header-node
100 101 102 103 104
  '(;; Because header-lines on tty's are usually reverse-video, the
    ;; normal info-node colors probably won't look good, so just stick
    ;; with bold-italic
    (((type tty) (class color)) (:bold t :italic t))
    (t (:inherit info-node)))
Miles Bader's avatar
Miles Bader committed
105 106 107
  "Face for Info nodes in a node header."
  :group 'info)

108
(defvar Info-directory-list nil
Jim Blandy's avatar
Jim Blandy committed
109
  "List of directories to search for Info documentation files.
Jim Blandy's avatar
Jim Blandy committed
110
nil means not yet initialized.  In this case, Info uses the environment
111
variable INFOPATH to initialize it, or `Info-default-directory-list'
112
if there is no INFOPATH variable in the environment.
113 114 115 116 117 118 119

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.)
120 121

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

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

Jim Blandy's avatar
Jim Blandy committed
133
(defvar Info-current-file nil
134 135
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
136 137
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
138 139

(defvar Info-current-subfile nil
Dave Love's avatar
Dave Love committed
140 141
  "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
142 143 144 145

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

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

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

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

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

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

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

235 236 237 238
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

239 240 241
(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."
242 243 244
  (let ((tail Info-suffix-list)
	fullname decoder)
    (if (file-exists-p filename)
245 246
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
247 248 249 250 251 252 253 254
	(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))))
255
      ;; Try adding suffixes to FILENAME and see if we can find something.
256
      (while (and tail
257 258
		  (not (info-file-exists-p (info-insert-file-contents-1
					    filename (car (car tail))))))
259
	(setq tail (cdr tail)))
260 261
      ;; If we found a file with a suffix, set DECODER according to the suffix
      ;; and set FULLNAME to the file's actual name.
262
      (setq fullname (info-insert-file-contents-1 filename (car (car tail)))
263 264
	    decoder (cdr (car tail)))
      (or tail
265
	  (error "Can't find %s or any compressed version of it" filename)))
266 267 268 269 270
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
271
    (if decoder
272 273 274 275 276 277 278 279
	(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))))
280 281

(defun info-initialize ()
Dave Love's avatar
Dave Love committed
282
  "Initialize `Info-directory-list', if that hasn't been done yet."
283 284 285 286 287 288 289
  (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
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
	    (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)))))))))))
315

316 317 318 319 320 321 322
;;;###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)))
323

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

Jim Blandy's avatar
Jim Blandy committed
326 327 328 329 330
;;;###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
331 332
Called from a program, FILE may specify an Info node of the form
`(FILENAME)NODENAME'.
Jim Blandy's avatar
Jim Blandy committed
333 334

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

The search path for Info files is in the variable `Info-directory-list'.
338
The top-level Info directory is made by combining all the files named `dir'
Richard M. Stallman's avatar
Richard M. Stallman committed
339
in all the directories in that path."
Jim Blandy's avatar
Jim Blandy committed
340 341 342
  (interactive (if current-prefix-arg
		   (list (read-file-name "Info file name: " nil nil t))))
  (if file
343 344 345 346 347 348 349 350 351
      (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 ")"))))
352 353 354
    (if (get-buffer "*info*")
	(pop-to-buffer "*info*")
      (Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
355

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
;;;###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)))
373

Stefan Monnier's avatar
Stefan Monnier committed
374
;; See if the accessible portion of the buffer begins with a node
375 376 377 378 379 380 381 382 383
;; 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
384
;; REGEXP, if the function succeeds, nil otherwise.
385
(defun Info-node-at-bob-matching (regexp)
386 387
  (and (bobp)				; are we at beginning of buffer?
       (looking-at "\^_")		; does it begin with node delimiter?
388 389 390
       (let (beg)
	 (forward-line 1)
	 (setq beg (point))
391
	 (forward-line 1)		; does the line after delimiter match REGEXP?
392 393
	 (re-search-backward regexp beg t))))

Jim Blandy's avatar
Jim Blandy committed
394
(defun Info-find-node (filename nodename &optional no-going-back)
Dave Love's avatar
Dave Love committed
395 396 397
  "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."
398
  (info-initialize)
Jim Blandy's avatar
Jim Blandy committed
399 400
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
401
  (if (stringp filename)
Jim Blandy's avatar
Jim Blandy committed
402
      (let (temp temp-downcase found)
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
        (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
444
  ;; Go into info buffer.
445
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
446 447 448 449 450 451 452 453 454 455 456
  (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")))
457
  (info-initialize)
458 459 460 461
  (Info-mode)
  (set (make-local-variable 'Info-current-file) t)
  (Info-find-node-2 nil nodename))

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 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
(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)))
  
532
(defun Info-find-node-2 (filename nodename &optional no-going-back)
533
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
534 535 536 537 538
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
539 540
      (let ((case-fold-search t)
	    anchorpos)
541 542 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
        ;; 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)
579
                            (buffer-disable-undo (current-buffer))
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
                            (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.
605
	  (let ((guesspos (point-min))
606
		(regexp (concat "\\(Node:\\|Ref:\\) *\\("
607 608 609
				(if (stringp nodename) 
				    (regexp-quote nodename)
				  "")
610
				"\\) *[,\t\n\177]"))
611
		(nodepos nil))
612

613
	    (catch 'foo
614
	      
615
	      ;; First, search a tag table, if any
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
	      (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)))
631 632

		    ;; Handle anchor
633 634 635
		    (when (nth 0 found)
		      (goto-char (setq anchorpos guesspos))
		      (throw 'foo t)))))
636 637 638 639

	      ;; Else we may have a node, which we search for:
	      (goto-char (max (point-min)
			      (- (byte-to-position guesspos) 1000)))
640 641 642 643 644 645 646 647 648 649 650
	      
	      ;; 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)))
651 652 653

	    (Info-select-node)
	    (goto-char (or anchorpos (point-min))))))
Jim Blandy's avatar
Jim Blandy committed
654 655
    ;; If we did not finish finding the specified node,
    ;; go back to the previous one.
656
    (or Info-current-node no-going-back (null Info-history)
657 658 659 660
        (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
661

662 663
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
664 665
(defvar Info-dir-contents nil)

666 667 668 669
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

670 671 672 673
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

674 675
(defvar Info-dir-file-name nil)

676
;; Construct the Info directory node by merging the files named `dir'
677 678 679
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
680
(defun Info-insert-dir ()
681 682 683 684
  (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
685 686 687 688 689 690 691 692 693
		       (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)))
694
			       Info-dir-file-attributes))))
695 696 697
      (progn
	(insert Info-dir-contents)
	(goto-char (point-min)))
698 699 700 701
    (let ((dirs (if Info-additional-directory-list
                              (append Info-directory-list
                                      Info-additional-directory-list)
                            Info-directory-list))
702 703
	  ;; Bind this in case the user sets it to nil.
	  (case-fold-search t)
704 705
	  ;; This is set non-nil if we find a problem in some input files.
	  problems
706
	  buffers buffer others nodes dirs-done)
707

708 709
      (setq Info-dir-file-attributes nil)

710
      ;; Search the directory list for the directory file.
711
      (while dirs
712 713 714 715 716
	(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.
717 718 719 720 721 722 723 724 725 726 727
	      (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)))))
728 729 730 731
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
732 733 734 735
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
736
		      (set-buffer (generate-new-buffer " info dir"))
737 738 739
		      (condition-case nil
			  (progn
			    (insert-file-contents file)
740 741
			    (make-local-variable 'Info-dir-file-name)
			    (setq Info-dir-file-name file)
742 743 744 745 746
			    (setq buffers (cons (current-buffer) buffers)
				  Info-dir-file-attributes
				  (cons (cons file attrs)
					Info-dir-file-attributes)))
			(error (kill-buffer (current-buffer))))))))
747 748
	  (or (cdr dirs) (setq Info-dir-contents-directory
			       (file-name-as-directory (car dirs))))
749
	  (setq dirs (cdr dirs))))
750

751
      (or buffers
752
	  (error "Can't find the Info directory node"))
753
      ;; Distinguish the dir file that comes with Emacs from all the
754
      ;; others.  Yes, that is really what this is supposed to do.
755 756 757 758
      ;; 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))
759

760 761 762
      ;; 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.
763
      (insert-buffer buffer)
764

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

849 850
;; 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
851
(defun Info-read-subfile (nodepos)
852 853
  ;; 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
854 855
  (let (lastfilepos
	lastfilename)
856 857 858 859
    (if (numberp nodepos)
	(save-excursion
	  (set-buffer (marker-buffer Info-tag-table-marker))
	  (goto-char (point-min))
860 861
	  (or (looking-at "\^_")
	      (search-forward "\n\^_"))
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
	  (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))
881 882
    ;; Assume previous buffer is in Info-mode.
    ;; (set-buffer (get-buffer "*info*"))
Jim Blandy's avatar
Jim Blandy committed
883 884 885 886 887
    (or (equal Info-current-subfile lastfilename)
	(let ((buffer-read-only nil))
	  (setq buffer-file-name nil)
	  (widen)
	  (erase-buffer)
888
	  (info-insert-file-contents lastfilename)
Jim Blandy's avatar
Jim Blandy committed
889 890 891
	  (set-buffer-modified-p nil)
	  (setq Info-current-subfile lastfilename)))
    (goto-char (point-min))
892 893 894
    (if (looking-at "\^_")
	(forward-char 1)
      (search-forward "\n\^_"))
895 896
    (if (numberp nodepos)
	(+ (- nodepos lastfilepos) (point)))))
Jim Blandy's avatar
Jim Blandy committed
897

Miles Bader's avatar
Miles Bader committed
898 899 900
(defvar Info-header-line nil
  "If the info node header is hidden, the text of the header.")

Jim Blandy's avatar
Jim Blandy committed
901
(defun Info-select-node ()
Dave Love's avatar
Dave Love committed
902 903
"Select the info node that point is in.
Bind this in case the user sets it to nil."
904 905
  (let ((case-fold-search t))
    (save-excursion
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
      ;; 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
923
	;; Narrow to the node contents
924 925 926 927 928 929 930 931 932 933 934 935
	(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))
Miles Bader's avatar
Miles Bader committed
936 937 938
	(if Info-use-header-line
	    (Info-setup-header-line)
	  (setq Info-header-line nil))
939
	(run-hooks 'Info-selection-hook)))))
Jim Blandy's avatar
Jim Blandy committed
940 941 942

(defun Info-set-mode-line ()
  (setq mode-line-buffer-identification
943
	(nconc (propertized-buffer-identification "%b")
944 945 946 947 948 949 950 951
	       (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
952

Miles Bader's avatar
Miles Bader committed
953 954 955 956 957 958 959 960 961 962
;; Skip the node header and make it into a header-line.  This function
;; should be called when the node is already narrowed.
(defun Info-setup-header-line ()
  (goto-char (point-min))
  (forward-line 1)
  (set (make-local-variable 'Info-header-line)
       (buffer-substring (point-min) (1- (point))))
  (setq header-line-format 'Info-header-line)
  (narrow-to-region (point) (point-max)))

Jim Blandy's avatar
Jim Blandy committed
963 964 965
;; Go to an info node specified with a filename-and-nodename string
;; of the sort that is found in pointers in nodes.

966 967
(defun Info-goto-node (nodename &optional fork)
  "Go to info node named NAME.  Give just NODENAME or (FILENAME)NODENAME.
968 969
If FORK is non-nil (interactively with a prefix arg), show the node in
a new info buffer.
970
If FORK is a string, it is the name to use for the new buffer."
971
  (interactive (list (Info-read-node-name "Go to node: ") current-prefix-arg))
972
  (info-initialize)
973
  (if fork
974 975
      (set-buffer
       (clone-buffer (concat "*info-" (if (stringp fork) fork nodename) "*") t)))
Jim Blandy's avatar
Jim Blandy committed
976 977 978 979 980 981 982 983 984 985 986
  (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))))
987
    (if transient-mark-mode (deactivate-mark))
Jim Blandy's avatar
Jim Blandy committed
988 989
    (Info-find-node (if (equal filename "") nil filename)
		    (if (equal nodename "") "Top" nodename))))
990

991 992
(defvar Info-read-node-completion-table)

993
;; This function is used as the "completion table" while reading a node name.
994
;; It does completion using the alist in Info-read-node-completion-table
995 996 997 998 999 1000
;; 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
1001
	     (try-completion string Info-read-node-completion-table predicate)))
1002 1003 1004
	  ((eq code t)
	   (if no-completion
	       nil
1005
	     (all-completions string Info-read-node-completion-table predicate)))
1006 1007 1008
	  ((eq code 'lambda)
	   (if no-completion
	       t
1009
	     (assoc string Info-read-node-completion-table))))))
1010

1011 1012
(defun Info-read-node-name (prompt &optional default)
  (let* ((completion-ignore-case t)
1013
	 (Info-read-node-completion-table (Info-build-node-completions))
1014
	 (nodename (completing-read prompt 'Info-read-node-name-1 nil t)))
1015 1016 1017 1018 1019 1020 1021
    (if (equal nodename "")
	(or default
	    (Info-read-node-name prompt))
      nodename)))

(defun Info-build-node-completions ()
  (or Info-current-file-completions
1022 1023
      (let ((compl nil)
	    ;; Bind this in case the user sets it to nil.
1024 1025
	    (case-fold-search t)
	    (node-regexp "Node: *\\([^,\n]*\\) *[,\n\t]"))
1026 1027 1028
	(save-excursion
	  (save-restriction
	    (if (marker-buffer Info-tag-table-marker)
1029 1030
		(let ((marker Info-tag-table-marker))
		  (set-buffer (marker-buffer marker))
1031
		  (widen)
1032
		  (goto-char marker)
Dave Love's avatar
Dave Love committed
1033
		  (while (re-search-forward "\n\\(Node\\|Ref\\): \\(.*\\)\177" nil t)
1034
		    (setq compl
Dave Love's avatar
Dave Love committed
1035
			  (cons (list (match-string-no-properties 2))
1036 1037 1038
				compl))))
	      (widen)
	      (goto-char (point-min))
1039 1040
	      ;; If the buffer begins with a node header, process that first.
	      (if (Info-node-at-bob-matching node-regexp)
1041
		  (setq compl (list (match-string-no-properties 1))))
1042
	      ;; Now for the rest of the nodes.
1043 1044 1045 1046
	      (while (search-forward "\n\^_" nil t)
		(forward-line 1)
		(let ((beg (point)))
		  (forward-line 1)
1047
		  (if (re-search-backward node-regexp beg t)
1048
		      (setq compl
1049
			    (cons (list (match-string-no-properties 1))