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

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

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

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

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

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

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

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

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

;;; Code:

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


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

42
(defcustom Info-enable-edit nil
43
  "*Non-nil means the \\<Info-mode-map>\\[Info-edit] command in Info can edit the current node.
44 45 46
This is convenient if you want to write info files by hand.
However, we recommend that you not do this.
It is better to write a Texinfo file and generate the Info file from that,
47 48 49
because that gives you a printed manual as well."
  :type 'boolean
  :group 'info)
Jim Blandy's avatar
Jim Blandy committed
50

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

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

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

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

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

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

81
(defvar Info-directory-list
82
  (let ((path (getenv "INFOPATH"))
83
	(source (expand-file-name "info/" source-directory))
84
	(sibling (if installation-directory
85 86
		     (expand-file-name "info/" installation-directory)))
	alternative)
87
    (if path
88
	(split-string path (regexp-quote path-separator))
89
      (if (and sibling (file-exists-p sibling))
90 91
	  (setq alternative sibling)	; uninstalled, Emacs builddir != srcdir
	(setq alternative source))	; uninstalled, builddir != srcdir
92 93
      (if (or (member alternative Info-default-directory-list)
	      (not (file-exists-p alternative))
94
	      ;; On DOS/NT, we use movable executables always,
95
	      ;; and we must always find the Info dir at run time.
96
	      (if (or (eq system-type 'ms-dos) (eq system-type 'windows-nt))
97 98 99 100
		  nil
		;; Use invocation-directory for Info only if we used it for
		;; exec-directory also.
		(not (string= exec-directory
101 102
			      (expand-file-name "lib-src/"
						installation-directory)))))
103
	  Info-default-directory-list
104 105 106 107 108
	;; `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)))))))
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 113
if there is no INFOPATH variable in the environment.
The last element of `Info-default-directory-list' is the directory
114
where Emacs installs the Info files that come with it.
115 116 117 118 119

If you run the Emacs executable from the `src' directory in the Emacs
source tree, the `info' directory in the source tree is used as the last
element, in place of the installation Info directory.  This is useful
when you run a version of Emacs without installing it.")
Jim Blandy's avatar
Jim Blandy committed
120

121
(defcustom Info-additional-directory-list nil
122
  "List of additional directories to search for Info documentation files.
123 124 125
These directories are not searched for merging the `dir' file."
  :type '(repeat directory)
  :group 'info)
126

Jim Blandy's avatar
Jim Blandy committed
127
(defvar Info-current-file nil
128 129 130
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
It doesn't contain directory names or file name extensions added by Info.")
Jim Blandy's avatar
Jim Blandy committed
131 132 133 134 135 136 137 138

(defvar Info-current-subfile nil
  "Info subfile that is actually in the *info* buffer now,
or nil if current info file is not split into subfiles.")

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

139
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
140 141 142
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

143 144 145
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

146 147 148
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

149 150 151
(defvar Info-index-alternatives nil
  "List of possible matches for last Info-index command.")

152 153 154
(defvar Info-standalone nil
  "Non-nil if Emacs was started solely as an Info browser.")

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

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

223 224 225 226
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

227 228 229
(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."
230 231 232
  (let ((tail Info-suffix-list)
	fullname decoder)
    (if (file-exists-p filename)
233 234
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
235 236 237 238 239 240 241 242
	(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))))
243
      ;; Try adding suffixes to FILENAME and see if we can find something.
244
      (while (and tail
245 246
		  (not (info-file-exists-p (info-insert-file-contents-1
					    filename (car (car tail))))))
247
	(setq tail (cdr tail)))
248 249
      ;; If we found a file with a suffix, set DECODER according to the suffix
      ;; and set FULLNAME to the file's actual name.
250
      (setq fullname (info-insert-file-contents-1 filename (car (car tail)))
251 252
	    decoder (cdr (car tail)))
      (or tail
253
	  (error "Can't find %s or any compressed version of it" filename)))
254 255 256 257 258
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
259
    (if decoder
260 261 262 263 264 265 266 267
	(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))))
268

269 270 271 272 273 274 275 276
;;;###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)))
  
277
;;;###autoload (add-hook 'same-window-buffer-names "*info*")
278

Jim Blandy's avatar
Jim Blandy committed
279 280 281 282 283 284 285
;;;###autoload
(defun info (&optional file)
  "Enter Info, the documentation browser.
Optional argument FILE specifies the file to examine;
the default is the top-level directory of Info.

In interactive use, a prefix argument directs this command
Richard M. Stallman's avatar
Richard M. Stallman committed
286 287 288 289 290
to read a file name from the minibuffer.

The search path for Info files is in the variable `Info-directory-list'.
The top-level Info directory is made by combining all the files named `dir' 
in all the directories in that path."
Jim Blandy's avatar
Jim Blandy committed
291 292 293
  (interactive (if current-prefix-arg
		   (list (read-file-name "Info file name: " nil nil t))))
  (if file
294 295 296 297 298 299 300 301 302
      (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 ")"))))
303 304 305
    (if (get-buffer "*info*")
	(pop-to-buffer "*info*")
      (Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
306

307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
;;;###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)))

325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
;; See if the the accessible portion of the buffer begins with a node
;; delimiter, and the node header line which follows matches REGEXP.
;; Typically, this test will be followed by a loop that examines the
;; rest of the buffer with (search-forward "\n\^_"), and it's a pity
;; to have the overhead of this special test inside the loop.

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

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

Jim Blandy's avatar
Jim Blandy committed
345 346 347 348 349 350 351 352
;; Go to an info node specified as separate filename and nodename.
;; no-going-back is non-nil if recovering from an error in this function;
;; it says do not attempt further (recursive) error recovery.
(defun Info-find-node (filename nodename &optional no-going-back)
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
  (if filename
      (let (temp temp-downcase found)
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
        (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
394
  ;; Go into info buffer.
395
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
396
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
397 398 399 400 401
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
402 403
      ;; Bind case-fold-search in case the user sets it to nil.
      (let ((case-fold-search t))
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
        ;; 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)
442
                            (buffer-disable-undo (current-buffer))
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
                            (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.
          (let ((guesspos (point-min))
                (regexp
                 (concat "\\(Node:\\|Ref:\\) *"
                         (regexp-quote nodename)
                         " *[,\t\n\177]")))

            ;; First, search a tag table, if any
            (if (marker-position Info-tag-table-marker)

                (let (found-in-tag-table
478
		      found-anchor
479 480 481 482 483 484 485 486 487
                      found-mode
                      (m Info-tag-table-marker))
                  (save-excursion
                    (set-buffer (marker-buffer m))
                    (goto-char m)
                    (beginning-of-line) ; so re-search will work.

                    ;; Search tag table
                    (setq found-in-tag-table
488 489 490
                          (re-search-forward regexp nil t)
			  found-anchor
			  (string-equal "Ref:" (match-string 1)))
491
                    (if found-in-tag-table
492
                        (setq guesspos (1+ (read (current-buffer)))))
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
                    (setq found-mode major-mode))

                  ;; Indirect file among split files
                  (if found-in-tag-table
                      (progn
                        ;; If this is an indirect file, determine
                        ;; which file really holds this node and
                        ;; read it in.
                        (if (not (eq found-mode 'Info-mode))
                            ;; Note that the current buffer must be
                            ;; the *info* buffer on entry to
                            ;; Info-read-subfile.  Thus the hackery
                            ;; above.
                            (setq guesspos (Info-read-subfile guesspos)))))

                  ;; Handle anchor
509
                  (if found-anchor (goto-char guesspos)
510 511

                    ;; Else we may have a node, which we search for:
512 513
		    (goto-char (max (point-min)
				    (- (byte-to-position guesspos) 1000)))
514 515 516
                    ;; Now search from our advised position
                    ;; (or from beg of buffer)
                    ;; to find the actual node.
517 518 519 520 521 522
		    ;; First, check whether the node is right
		    ;; where we are, in case the buffer begins
		    ;; with a node.
		    (or (Info-node-at-bob-matching regexp)
			(catch 'foo
			  (while (search-forward "\n\^_" nil t)
523
			    (forward-line 1)
524 525 526 527 528 529 530 531 532
			    (let ((beg (point)))
			      (forward-line 1)
			      (if (re-search-backward regexp beg t)
				  (progn
				    (beginning-of-line)
				    (throw 'foo t)))))
			  (error
			   "No such anchor in tag table or node in tag table or file: %s"
			   nodename)))))
533 534 535
	      (goto-char (max (point-min) (- guesspos 1000)))
	      ;; Now search from our advised position (or from beg of buffer)
	      ;; to find the actual node.
536 537 538 539 540
	      ;; First, check whether the node is right where we are, in case
	      ;; the buffer begins with a node.
	      (or (Info-node-at-bob-matching regexp)
		  (catch 'foo
		    (while (search-forward "\n\^_" nil t)
541
		      (forward-line 1)
542 543 544 545 546
		      (let ((beg (point)))
			(forward-line 1)
			(if (re-search-backward regexp beg t)
			    (throw 'foo t))))
		    (error "No such node: %s" nodename)))))
547 548
          (Info-select-node)
	  (goto-char (point-min))))
Jim Blandy's avatar
Jim Blandy committed
549 550
    ;; If we did not finish finding the specified node,
    ;; go back to the previous one.
551
    (or Info-current-node no-going-back (null Info-history)
552 553 554 555
        (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
556

557 558
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
559 560
(defvar Info-dir-contents nil)

561 562 563 564
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

565 566 567 568
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

569 570
(defvar Info-dir-file-name nil)

571
;; Construct the Info directory node by merging the files named `dir'
572 573 574
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
575
(defun Info-insert-dir ()
576 577 578 579 580
  (if (and Info-dir-contents Info-dir-file-attributes
	   ;; Verify that none of the files we used has changed
	   ;; since we used it.
	   (eval (cons 'and
		       (mapcar '(lambda (elt)
581 582 583 584
				  (let ((curr (file-attributes 
					       ;; Handle symlinks
					       (file-truename (car elt)))))
				    
585 586 587 588
				    ;; Don't compare the access time.
				    (if curr (setcar (nthcdr 4 curr) 0))
				    (setcar (nthcdr 4 (cdr elt)) 0)
				    (equal (cdr elt) curr)))
589
			       Info-dir-file-attributes))))
590 591 592
      (progn
	(insert Info-dir-contents)
	(goto-char (point-min)))
593
    (let ((dirs Info-directory-list)
594 595
	  ;; Bind this in case the user sets it to nil.
	  (case-fold-search t)
596 597
	  ;; This is set non-nil if we find a problem in some input files.
	  problems
598
	  buffers buffer others nodes dirs-done)
599

600 601
      (setq Info-dir-file-attributes nil)

602
      ;; Search the directory list for the directory file.
603
      (while dirs
604 605 606 607 608
	(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.
609 610 611 612 613 614 615 616 617 618 619
	      (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)))))
620 621 622 623
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
624 625 626 627
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
628
		      (set-buffer (generate-new-buffer " info dir"))
629 630 631
		      (condition-case nil
			  (progn
			    (insert-file-contents file)
632 633
			    (make-local-variable 'Info-dir-file-name)
			    (setq Info-dir-file-name file)
634 635 636 637 638
			    (setq buffers (cons (current-buffer) buffers)
				  Info-dir-file-attributes
				  (cons (cons file attrs)
					Info-dir-file-attributes)))
			(error (kill-buffer (current-buffer))))))))
639 640
	  (or (cdr dirs) (setq Info-dir-contents-directory
			       (file-name-as-directory (car dirs))))
641 642
	  (setq dirs (cdr dirs))))
      
643
      (or buffers
644
	  (error "Can't find the Info directory node"))
645
      ;; Distinguish the dir file that comes with Emacs from all the
646
      ;; others.  Yes, that is really what this is supposed to do.
647 648 649 650
      ;; 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))
651

652 653 654
      ;; 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.
655
      (insert-buffer buffer)
656

657 658
      ;; Look at each of the other buffers one by one.
      (while others
659 660
	(let ((other (car others))
	      this-buffer-nodes)
661 662 663 664 665 666 667 668 669
	  ;; 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))
670 671 672
		(or (search-backward "\n\^_" nil 'move)
		    (looking-at "\^_")
		    (signal 'search-failed (list "\n\^_")))
673 674
		(search-forward "Node: ")
		(setq nodename (Info-following-node-name))
675
		(search-forward "\n\^_" nil 'move)
676 677
		(beginning-of-line)
		(setq end (point))
678 679 680 681 682 683 684
		(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))))
685 686 687 688 689 690 691
	(setq others (cdr others)))
      ;; Add to the main menu a menu item for each other node.
      (re-search-forward "^\\* Menu:")
      (forward-line 1)
      (let ((menu-items '("top"))
	    (nodes nodes)
	    (case-fold-search t)
692
	    (end (save-excursion (search-forward "\^_" nil t) (point))))
693 694
	(while nodes
	  (let ((nodename (car (car nodes))))
695 696
	    (save-excursion
	      (or (member (downcase nodename) menu-items)
697
		  (re-search-forward (concat "^\\* +"
698 699 700 701 702 703
					     (regexp-quote nodename)
					     "::")
				     end t)
		  (progn
		    (insert "* " nodename "::" "\n")
		    (setq menu-items (cons nodename menu-items))))))
704 705 706 707 708 709 710
	  (setq nodes (cdr nodes))))
      ;; Now take each node of each of the other buffers
      ;; and merge it into the main buffer.
      (while nodes
	(let ((nodename (car (car nodes))))
	  (goto-char (point-min))
	  ;; Find the like-named node in the main buffer.
711
	  (if (re-search-forward (concat "^\^_.*\n.*Node: "
712 713 714 715
					 (regexp-quote nodename)
					 "[,\n\t]")
				 nil t)
	      (progn
716
		(search-forward "\n\^_" nil 'move)
717 718
		(beginning-of-line)
		(insert "\n"))
719 720
	    ;; If none exists, add one.
	    (goto-char (point-max))
721
	    (insert "\^_\nFile: dir\tNode: " nodename "\n\n* Menu:\n\n"))
722 723
	  ;; Merge the text from the other buffer's menu
	  ;; into the menu in the like-named node in the main buffer.
724
	  (apply 'insert-buffer-substring (cdr (car nodes))))
725 726 727 728
	(setq nodes (cdr nodes)))
      ;; Kill all the buffers we just made.
      (while buffers
	(kill-buffer (car buffers))
729
	(setq buffers (cdr buffers)))
730 731 732 733
      (goto-char (point-min))
      (if problems
	  (message "Composing main Info directory...problems encountered, see `*Messages*'")
	(message "Composing main Info directory...done")))
734 735
    (setq Info-dir-contents (buffer-string)))
  (setq default-directory Info-dir-contents-directory))
736

737 738
;; 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
739
(defun Info-read-subfile (nodepos)
740 741
  ;; 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
742 743
  (let (lastfilepos
	lastfilename)
744 745 746 747
    (if (numberp nodepos)
	(save-excursion
	  (set-buffer (marker-buffer Info-tag-table-marker))
	  (goto-char (point-min))
748 749
	  (or (looking-at "\^_")
	      (search-forward "\n\^_"))
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
	  (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))
769 770
    ;; Assume previous buffer is in Info-mode.
    ;; (set-buffer (get-buffer "*info*"))
Jim Blandy's avatar
Jim Blandy committed
771 772 773 774 775
    (or (equal Info-current-subfile lastfilename)
	(let ((buffer-read-only nil))
	  (setq buffer-file-name nil)
	  (widen)
	  (erase-buffer)
776
	  (info-insert-file-contents lastfilename)
Jim Blandy's avatar
Jim Blandy committed
777 778 779
	  (set-buffer-modified-p nil)
	  (setq Info-current-subfile lastfilename)))
    (goto-char (point-min))
780 781 782
    (if (looking-at "\^_")
	(forward-char 1)
      (search-forward "\n\^_"))
783 784
    (if (numberp nodepos)
	(+ (- nodepos lastfilepos) (point)))))
Jim Blandy's avatar
Jim Blandy committed
785 786 787

;; Select the info node that point is in.
(defun Info-select-node ()
788 789 790 791
  ;; Bind this in case the user sets it to nil.
  (let ((case-fold-search t))
    (save-excursion
     ;; Find beginning of node.
792 793 794 795 796
     (if (search-backward "\n\^_" nil 'move)
	 (forward-line 2)
       (if (looking-at "\^_")
	   (forward-line 1)
	 (signal 'search-failed (list "\n\^_"))))
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
     ;; Get nodename spelled as it is in the node.
     (re-search-forward "Node:[ \t]*")
     (setq Info-current-node
	   (buffer-substring-no-properties (point)
					   (progn
					    (skip-chars-forward "^,\t\n")
					    (point))))
     (Info-set-mode-line)
     ;; Find the end of it, and narrow.
     (beginning-of-line)
     (let (active-expression)
       (narrow-to-region (point)
			 (if (re-search-forward "\n[\^_\f]" nil t)
			     (prog1
			      (1- (point))
			      (if (looking-at "[\n\^_\f]*execute: ")
				  (progn
				    (goto-char (match-end 0))
				    (setq active-expression
					  (read (current-buffer))))))
			   (point-max)))
       (if Info-enable-active-nodes (eval active-expression))
       (if Info-fontify (Info-fontify-node))
       (run-hooks 'Info-selection-hook)))))
Jim Blandy's avatar
Jim Blandy committed
821 822 823 824

(defun Info-set-mode-line ()
  (setq mode-line-buffer-identification
	(concat
825
	 "  Info:  ("
Jim Blandy's avatar
Jim Blandy committed
826 827 828 829 830 831 832 833 834 835 836
	 (if Info-current-file
	     (file-name-nondirectory Info-current-file)
	   "")
	 ")"
	 (or Info-current-node ""))))

;; Go to an info node specified with a filename-and-nodename string
;; of the sort that is found in pointers in nodes.

(defun Info-goto-node (nodename)
  "Go to info node named NAME.  Give just NODENAME or (FILENAME)NODENAME."
837
  (interactive (list (Info-read-node-name "Goto node: ")))
Jim Blandy's avatar
Jim Blandy committed
838 839 840 841 842 843 844 845 846 847 848
  (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))))
849
    (if transient-mark-mode (deactivate-mark))
Jim Blandy's avatar
Jim Blandy committed
850 851
    (Info-find-node (if (equal filename "") nil filename)
		    (if (equal nodename "") "Top" nodename))))
852

853 854
(defvar Info-read-node-completion-table)

855
;; This function is used as the "completion table" while reading a node name.
856
;; It does completion using the alist in Info-read-node-completion-table
857 858 859 860 861 862
;; 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
863
	     (try-completion string Info-read-node-completion-table predicate)))
864 865 866
	  ((eq code t)
	   (if no-completion
	       nil
867
	     (all-completions string Info-read-node-completion-table predicate)))
868 869 870
	  ((eq code 'lambda)
	   (if no-completion
	       t
871
	     (assoc string Info-read-node-completion-table))))))
872

873 874
(defun Info-read-node-name (prompt &optional default)
  (let* ((completion-ignore-case t)
875
	 (Info-read-node-completion-table (Info-build-node-completions))
876
	 (nodename (completing-read prompt 'Info-read-node-name-1 nil t)))
877 878 879 880 881 882 883
    (if (equal nodename "")
	(or default
	    (Info-read-node-name prompt))
      nodename)))

(defun Info-build-node-completions ()
  (or Info-current-file-completions
884 885
      (let ((compl nil)
	    ;; Bind this in case the user sets it to nil.
886 887
	    (case-fold-search t)
	    (node-regexp "Node: *\\([^,\n]*\\) *[,\n\t]"))
888 889 890
	(save-excursion
	  (save-restriction
	    (if (marker-buffer Info-tag-table-marker)
891 892
		(let ((marker Info-tag-table-marker))
		  (set-buffer (marker-buffer marker))
893
		  (widen)
894
		  (goto-char marker)
895 896 897 898 899 900 901
		  (while (re-search-forward "\nNode: \\(.*\\)\177" nil t)
		    (setq compl
			  (cons (list (buffer-substring (match-beginning 1)
							(match-end 1)))
				compl))))
	      (widen)
	      (goto-char (point-min))
902 903 904 905 906
	      ;; If the buffer begins with a node header, process that first.
	      (if (Info-node-at-bob-matching node-regexp)
		  (setq compl (list (buffer-substring (match-beginning 1)
						      (match-end 1)))))
	      ;; Now for the rest of the nodes.
907 908 909 910
	      (while (search-forward "\n\^_" nil t)
		(forward-line 1)
		(let ((beg (point)))
		  (forward-line 1)
911
		  (if (re-search-backward node-regexp beg t)
912 913 914 915 916
		      (setq compl 
			    (cons (list (buffer-substring (match-beginning 1)
							  (match-end 1)))
				  compl))))))))
	(setq Info-current-file-completions compl))))
Jim Blandy's avatar
Jim Blandy committed
917

Jim Blandy's avatar
Jim Blandy committed
918 919
(defun Info-restore-point (hl)
  "If this node has been visited, restore the point value when we left."
920 921
  (while hl
    (if (and (equal (nth 0 (car hl)) Info-current-file)
922 923
	     ;; Use string-equal, not equal, to ignore text props.
	     (string-equal (nth 1 (car hl)) Info-current-node))
924
	(progn
925 926
	  (goto-char (nth 2 (car hl)))
	  (setq hl nil))		;terminate the while at next iter
927
      (setq hl (cdr hl)))))
Jim Blandy's avatar
Jim Blandy committed
928

Jim Blandy's avatar
Jim Blandy committed
929
(defvar Info-last-search nil
930
  "Default regexp for \\<Info-mode-map>\\[Info-search] command to search for.")
Jim Blandy's avatar
Jim Blandy committed
931 932 933 934

(defun Info-search (regexp)
  "Search for REGEXP, starting from point, and select node it's found in."
  (interactive "sSearch (regexp): ")
935
  (if transient-mark-mode (deactivate-mark))
Jim Blandy's avatar
Jim Blandy committed
936 937 938 939 940 941 942
  (if (equal regexp "")
      (setq regexp Info-last-search)
    (setq Info-last-search regexp))
  (let ((found ()) current
	(onode Info-current-node)
	(ofile Info-current-file)
	(opoint (point))
943
	(ostart (window-start))
Jim Blandy's avatar
Jim Blandy committed
944 945 946 947 948 949 950 951 952 953 954 955
	(osubfile Info-current-subfile))
    (save-excursion
      (save-restriction
	(widen)
	(if (null Info-current-subfile)
	    (progn (re-search-forward regexp) (setq found (point)))
	  (condition-case err
	      (progn (re-search-forward regexp) (setq found (point)))
	    (search-failed nil)))))
    (if (not found) ;can only happen in subfile case -- else would have erred
	(unwind-protect
	    (let ((list ()))
956 957
	      (save-excursion
		(set-buffer (marker-buffer Info-tag-table-marker))
Jim Blandy's avatar
Jim Blandy committed
958
		(goto-char (point-min))
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
		(search-forward "\n\^_\nIndirect:")
		(save-restriction
		  (narrow-to-region (point)
				    (progn (search-forward "\n\^_")
					   (1- (point))))
		  (goto-char (point-min))
		  (search-forward (concat "\n" osubfile ": "))
		  (beginning-of-line)
		  (while (not (eobp))
		    (re-search-forward "\\(^.*\\): [0-9]+$")
		    (goto-char (+ (match-end 1) 2))
		    (setq list (cons (cons (read (current-buffer))
					   (buffer-substring
					    (match-beginning 1) (match-end 1)))
				     list))
		    (goto-char (1+ (match-end 0))))
		  (setq list (nreverse list)
			current (car (car list))
			list (cdr list))))
Jim Blandy's avatar
Jim Blandy committed
978 979 980 981
	      (while list
		(message "Searching subfile %s..." (cdr (car list)))
		(Info-read-subfile (car (car list)))
		(setq list (cdr list))
982
;;		(goto-char (point-min))
Jim Blandy's avatar
Jim Blandy committed
983 984 985 986 987 988
		(if (re-search-forward regexp nil t)
		    (setq found (point) list ())))
	      (if found
		  (message "")
		(signal 'search-failed (list regexp))))
	  (if (not found)
989
	      (progn (Info-read-subfile osubfile)
Jim Blandy's avatar
Jim Blandy committed
990
		     (goto-char opoint)
991 992
		     (Info-select-node)
		     (set-window-start (selected-window) ostart)))))
Jim Blandy's avatar
Jim Blandy committed
993 994 995
    (widen)
    (goto-char found)
    (Info-select-node)
996 997
    ;; Use string-equal, not equal, to ignore text props.
    (or (and (string-equal onode Info-current-node)
Jim Blandy's avatar
Jim Blandy committed
998 999 1000 1001 1002 1003 1004 1005
	     (equal ofile Info-current-file))
	(setq Info-history (cons (list ofile onode opoint)
				 Info-history)))))

;; Extract the value of the node-pointer named NAME.
;; If there is none, use ERRORNAME in the error message; 
;; if ERRORNAME is nil, just return nil.
(defun Info-extract-pointer (name &optional errorname)
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
  ;; Bind this in case the user sets it to nil.
  (let ((case-fold-search t))
    (save-excursion
      (goto-char (point-min))
      (forward-line 1)
      (if (re-search-backward (concat name ":") nil t)
	  (progn
	    (goto-char (match-end 0))
	    (Info-following-node-name))
	(if (eq errorname t)
	    nil
	  (error "Node has no %s" (capitalize (or errorname name))))))))
Jim Blandy's avatar
Jim Blandy committed
1018

1019 1020
;; Return the node name in the buffer following point.
;; ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
1021
;; saying which chars may appear in the node name.
Jim Blandy's avatar
Jim Blandy committed
1022 1023
(defun Info-following-node-name (&optional allowedchars)
  (skip-chars-forward " \t")
1024
  (buffer-substring-no-properties
Jim Blandy's avatar
Jim Blandy committed
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
   (point)
   (progn
     (while (looking-at (concat "[" (or allowedchars "^,\t\n") "]"))
       (skip-chars-forward (concat (or allowedchars "^,\t\n") "("))
       (if (looking-at "(")
	   (skip-chars-forward "^)")))
     (skip-chars-backward " ")
     (point))))

(defun Info-next ()
  "Go to the next node of this node."
  (interactive)
  (Info-goto-node (Info-extract-pointer "next")))

(defun Info-prev ()
  "Go to the previous node of this node."
  (interactive)
  (Info-goto-node (Info-extract-pointer "prev[ious]*" "previous")))

1044 1045 1046
(defun Info-up (&optional same-file)
  "Go to the superior node of this node.
If SAME-FILE is non-nil, do not move to a different Info file."
Jim Blandy's avatar
Jim Blandy committed
1047
  (interactive)
1048 1049 1050 1051 1052
  (let ((node (Info-extract-pointer "up")))
    (and same-file
	 (string-match "^(" node)
	 (error "Up node is in another Info file"))
    (Info-goto-node node))
Jim Blandy's avatar
Jim Blandy committed
1053
  (Info-restore-point Info-history))
Jim Blandy's avatar
Jim Blandy committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078

(defun Info-last ()
  "Go back to the last node visited."
  (interactive)
  (or Info-history
      (error "This is the first Info node you looked at"))
  (let (filename nodename opoint)
    (setq filename (car (car Info-history)))
    (setq nodename (car (cdr (car Info-history))))
    (setq opoint (car (cdr (cdr (car Info-history)))))
    (setq Info-history (cdr Info-history))
    (Info-find-node filename nodename)
    (setq Info-history (cdr Info-history))
    (goto-char opoint)))

(defun Info-directory ()
  "Go to the Info directory node."
  (interactive)
  (Info-find-node "dir" "top"))

(defun Info-follow-reference (footnotename)
  "Follow cross reference named NAME to the node it refers to.
NAME may be an abbreviation of the reference name."
  (interactive
   (let ((completion-ignore-case t)
1079
	 (case-fold-search t)
1080
	 completions default alt-default (start-point (point)) str i bol eol)
Jim Blandy's avatar
Jim Blandy committed
1081
     (save-excursion
1082 1083 1084 1085 1086 1087
       ;; Store end and beginning of line.
       (end-of-line)
       (setq eol (point))
       (beginning-of-line)
       (setq bol (point))

Jim Blandy's avatar
Jim Blandy committed
1088 1089 1090 1091 1092 1093 1094
       (goto-char (point-min))
       (while (re-search-forward "\\*note[ \n\t]*\\([^:]*\\):" nil t)
	 (setq str (buffer-substring
		    (match-beginning 1)
		    (1- (point))))
	 ;; See if this one should be the default.
	 (and (null default)
1095
	      (<= (match-beginning 0) start-point)
Jim Blandy's avatar
Jim Blandy committed
1096 1097
	      (<= start-point (point))
	      (setq default t))
1098 1099 1100 1101 1102
	 ;; See if this one should be the alternate default.
	 (and (null alt-default)
	      (and (<= bol (match-beginning 0))
		   (<= (point) eol))
	      (setq alt-default t))