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

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

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

Jim Blandy's avatar
Jim Blandy committed
10 11 12 13
;; 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
14
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
15 16 17 18 19 20 21 22
;; 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
23 24 25
;; 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
26

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

Erik Naggum's avatar
Erik Naggum committed
29
;; Note that nowadays we expect info files to be made using makeinfo.
30 31 32 33
;; In particular we make these assumptions:
;;  - a menu item MAY contain colons but not colon-space ": "
;;  - a menu item ending with ": " (but not ":: ") is an index entry
;;  - a node name MAY NOT contain a colon
34 35
;; This distinction is to support indexing of computer programming
;; language terms that may contain ":" but not ": ".
Eric S. Raymond's avatar
Eric S. Raymond committed
36 37 38

;;; Code:

Dave Love's avatar
Dave Love committed
39 40
(eval-when-compile (require 'jka-compr))

41 42 43 44 45 46
(defgroup info nil
  "Info subsystem"
  :group 'help
  :group 'docs)


Jim Blandy's avatar
Jim Blandy committed
47 48 49 50
(defvar Info-history nil
  "List of info nodes user has visited.
Each element of list is a list (FILENAME NODENAME BUFFERPOS).")

51
(defcustom Info-enable-edit nil
52
  "*Non-nil means the \\<Info-mode-map>\\[Info-edit] command in Info can edit the current node.
53 54 55
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,
56 57 58
because that gives you a printed manual as well."
  :type 'boolean
  :group 'info)
Jim Blandy's avatar
Jim Blandy committed
59

60
(defvar Info-enable-active-nodes nil
Jim Blandy's avatar
Jim Blandy committed
61 62
  "Non-nil allows Info to execute Lisp code associated with nodes.
The Lisp code is executed when the node is selected.")
63
(put 'Info-enable-active-nodes 'risky-local-variable t)
Jim Blandy's avatar
Jim Blandy committed
64

65
(defface info-node
66 67 68
  '((((class color) (background light)) (:foreground "brown" :weight bold :slant italic))
    (((class color) (background dark)) (:foreground "white" :weight bold :slant italic))
    (t (:weight bold :slant italic)))
69 70 71 72
  "Face for Info node names."
  :group 'info)

(defface info-menu-5
73 74
  '((((class color)) (:foreground "red1"))
    (t (:underline t)))
75
  "Face for every third `*' in an Info menu."
76 77 78
  :group 'info)

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

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

Miles Bader's avatar
Miles Bader committed
90
(defcustom Info-use-header-line t
91
  "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
Miles Bader's avatar
Miles Bader committed
92 93 94 95 96
A header-line does not scroll with the rest of the buffer."
  :type 'boolean
  :group 'info)

(defface info-header-xref
97
  '((t (:inherit info-xref)))
Miles Bader's avatar
Miles Bader committed
98 99 100 101
  "Face for Info cross-references in a node header."
  :group 'info)

(defface info-header-node
102
  '((t (:inherit info-node)))
Miles Bader's avatar
Miles Bader committed
103 104 105
  "Face for Info nodes in a node header."
  :group 'info)

106
(defvar Info-directory-list nil
Jim Blandy's avatar
Jim Blandy committed
107
  "List of directories to search for Info documentation files.
108
If nil, meaning not yet initialized, Info uses the environment
109
variable INFOPATH to initialize it, or `Info-default-directory-list'
110 111
if there is no INFOPATH variable in the environment, or the
concatenation of the two if INFOPATH ends with a colon.
112 113

When `Info-directory-list' is initialized from the value of
114 115 116 117 118 119 120
`Info-default-directory-list', and Emacs is installed in one of the
standard directories, the directory of Info files that come with Emacs
is put last (so that local Info files override standard ones).

When `Info-directory-list' is initialized from the value of
`Info-default-directory-list', and Emacs is not installed in one
of the standard directories, the first element of the resulting
121 122
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
123 124 125 126 127 128
version of Emacs you are using, will always be found first.  This
is useful when you install an experimental version of Emacs without
removing the standard installation.

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

If you run the Emacs executable from the `src' directory in the Emacs
131 132 133 134
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
135

136
(defcustom Info-additional-directory-list nil
137
  "List of additional directories to search for Info documentation files.
138
These directories are searched after those in `Info-directory-list'."
139 140
  :type '(repeat directory)
  :group 'info)
141

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

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

155
(defcustom Info-hide-note-references t
156 157
  "*If non-nil, hide the tag and section reference in *note and * menu items.
Also replaces the \"*note\" text with \"see\".
158
If value is non-nil but not t, the reference section is still shown."
159
  :version "21.4"
160 161 162
  :type '(choice (const :tag "No reformatting" nil)
		 (const :tag "Replace tag and hide reference" t)
		 (other :tag "Replace only tag" tag))
163 164
  :group 'info)

165 166 167 168
(defcustom Info-mode-hook
  ;; Try to obey obsolete Info-fontify settings.
  (unless (and (boundp 'Info-fontify) (null Info-fontify))
    '(turn-on-font-lock))
Colin Walters's avatar
Colin Walters committed
169 170 171 172
  "Hooks run when `info-mode' is called."
  :type 'hook
  :group 'info)

Jim Blandy's avatar
Jim Blandy committed
173
(defvar Info-current-file nil
174 175
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
176 177
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
178 179

(defvar Info-current-subfile nil
Dave Love's avatar
Dave Love committed
180 181
  "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
182 183 184 185

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

186
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
187 188 189
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

190 191 192
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

193 194 195
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

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

199 200
(defvar Info-standalone nil
  "Non-nil if Emacs was started solely as an Info browser.")
201

202
(defvar Info-suffix-list
203 204
  ;; The MS-DOS list should work both when long file names are
  ;; supported (Windows 9X), and when only 8+3 file names are available.
205 206 207
  (if (eq system-type 'ms-dos)
      '( (".gz"      . "gunzip")
	 (".z"       . "gunzip")
208
	 (".bz2"     . ("bzip2" "-dc"))
209 210 211 212 213 214 215 216
	 (".inz"     . "gunzip")
	 (".igz"     . "gunzip")
	 (".info.Z"  . "gunzip")
	 (".info.gz" . "gunzip")
	 ("-info.Z"  . "gunzip")
	 ("-info.gz" . "gunzip")
	 ("/index.gz". "gunzip")
	 ("/index.z" . "gunzip")
217
	 (".inf"     . nil)
218 219 220
	 (".info"    . nil)
	 ("-info"    . nil)
	 ("/index"   . nil)
221
	 (""         . nil))
222 223 224 225
    '( (".info.Z".    "uncompress")
       (".info.Y".    "unyabba")
       (".info.gz".   "gunzip")
       (".info.z".    "gunzip")
226
       (".info.bz2" . ("bzip2" "-dc"))
227 228 229 230
       (".info".      nil)
       ("-info.Z".   "uncompress")
       ("-info.Y".   "unyabba")
       ("-info.gz".  "gunzip")
231
       ("-info.bz2" . ("bzip2" "-dc"))
232 233 234 235 236 237
       ("-info.z".   "gunzip")
       ("-info".     nil)
       ("/index.Z".   "uncompress")
       ("/index.Y".   "unyabba")
       ("/index.gz".  "gunzip")
       ("/index.z".   "gunzip")
238
       ("/index.bz2". ("bzip2" "-dc"))
239 240 241 242 243
       ("/index".     nil)
       (".Z".         "uncompress")
       (".Y".         "unyabba")
       (".gz".        "gunzip")
       (".z".         "gunzip")
244
       (".bz2" .      ("bzip2" "-dc"))
245
       ("".           nil)))
246 247
  "List of file name suffixes and associated decoding commands.
Each entry should be (SUFFIX . STRING); the file is given to
248 249 250 251 252 253
the command as standard input.

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

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

257
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
258 259 260 261
;; First, on MS-DOS with no long file names support, delete some of
;; the extension in FILENAME to make room.
(defun info-insert-file-contents-1 (filename suffix lfn)
  (if lfn	; long file names are supported
262 263
      (concat filename suffix)
    (let* ((sans-exts (file-name-sans-extension filename))
264 265 266
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
267
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
268
      ;; get rid of the one in SUFFIX (unless suffix is empty).
269
      (or (and (<= ext-len 0)
270
	       (not (eq (aref filename (1- (length filename))) ?.)))
271
	  (= (length suffix) 0)
272
	  (setq suffix (substring suffix 1)))
273 274
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
275 276 277 278 279
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

280 281 282 283
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

284 285 286
(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."
287
  (let* ((tail Info-suffix-list)
288 289 290
	 (lfn (if (fboundp 'msdos-long-file-names)
		  (msdos-long-file-names)
		t))
291 292 293
	 (check-short (and (fboundp 'msdos-long-file-names)
			   lfn))
	 fullname decoder done)
294
    (if (info-file-exists-p filename)
295 296
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
297 298 299 300 301 302 303 304
	(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))))
305
      ;; Try adding suffixes to FILENAME and see if we can find something.
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
      (while (and tail (not done))
	(setq fullname (info-insert-file-contents-1 filename
						    (car (car tail)) lfn))
	(if (info-file-exists-p fullname)
	    (setq done t
		  ;; If we found a file with a suffix, set DECODER
		  ;; according to the suffix.
		  decoder (cdr (car tail)))
	  ;; When the MS-DOS port runs on Windows, we need to check
	  ;; the short variant of a long file name as well.
	  (when check-short
	    (setq fullname (info-insert-file-contents-1 filename
							(car (car tail)) nil))
	    (if (info-file-exists-p fullname)
		(setq done t
		      decoder (cdr (car tail))))))
322 323
	(setq tail (cdr tail)))
      (or tail
324
	  (error "Can't find %s or any compressed version of it" filename)))
325 326 327 328 329
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
330
    (if decoder
331 332 333 334 335 336
	(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)))
337 338 339 340
	    (or (consp decoder)
		(setq decoder (list decoder)))
	    (apply 'call-process-region (point-min) (point-max)
		   (car decoder) t t nil (cdr decoder))))
341
      (insert-file-contents fullname visit))))
342

343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
(defun Info-default-dirs ()
  (let ((source (expand-file-name "info/" source-directory))
	(sibling (if installation-directory
		     (expand-file-name "info/" installation-directory)
		   (if invocation-directory
		       (let ((infodir (expand-file-name
				       "../info/"
				       invocation-directory)))
			 (if (file-exists-p infodir)
			     infodir
			   (setq infodir (expand-file-name
					  "../../../info/"
					  invocation-directory))
			   (and (file-exists-p infodir)
				infodir))))))
	alternative)
    (setq alternative
	  (if (and sibling (file-exists-p sibling))
	      ;; Uninstalled, Emacs builddir != srcdir.
	      sibling
	    ;; Uninstalled, builddir == srcdir
	    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)))))))

383
(defun info-initialize ()
Dave Love's avatar
Dave Love committed
384
  "Initialize `Info-directory-list', if that hasn't been done yet."
385
  (unless Info-directory-list
386
    (let ((path (getenv "INFOPATH")))
387
      (setq Info-directory-list
388 389
	    (prune-directory-list
	     (if path
390 391 392 393 394 395
		 (if (string-match ":\\'" path)
		     (append (split-string (substring path 0 -1)
					   (regexp-quote path-separator))
			     (Info-default-dirs))
		   (split-string path (regexp-quote path-separator)))
	       (Info-default-dirs)))))))
396

397 398 399 400 401 402 403
;;;###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)))
404

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

Jim Blandy's avatar
Jim Blandy committed
407 408 409 410 411
;;;###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
412 413
Called from a program, FILE may specify an Info node of the form
`(FILENAME)NODENAME'.
Jim Blandy's avatar
Jim Blandy committed
414 415

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

The search path for Info files is in the variable `Info-directory-list'.
419
The top-level Info directory is made by combining all the files named `dir'
Richard M. Stallman's avatar
Richard M. Stallman committed
420
in all the directories in that path."
Jim Blandy's avatar
Jim Blandy committed
421 422 423
  (interactive (if current-prefix-arg
		   (list (read-file-name "Info file name: " nil nil t))))
  (if file
424 425 426 427 428 429 430 431 432
      (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 ")"))))
433 434 435
    (if (get-buffer "*info*")
	(pop-to-buffer "*info*")
      (Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
436

437 438
;;;###autoload
(defun info-emacs-manual ()
439
  "Display the Emacs manual in Info mode."
440 441 442
  (interactive)
  (info "emacs"))

443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
;;;###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)))
460

Stefan Monnier's avatar
Stefan Monnier committed
461
;; See if the accessible portion of the buffer begins with a node
462 463 464 465 466 467 468 469 470
;; 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
471
;; REGEXP, if the function succeeds, nil otherwise.
472
(defun Info-node-at-bob-matching (regexp)
473 474
  (and (bobp)				; are we at beginning of buffer?
       (looking-at "\^_")		; does it begin with node delimiter?
475 476 477
       (let (beg)
	 (forward-line 1)
	 (setq beg (point))
478
	 (forward-line 1)		; does the line after delimiter match REGEXP?
479 480
	 (re-search-backward regexp beg t))))

Jim Blandy's avatar
Jim Blandy committed
481
(defun Info-find-node (filename nodename &optional no-going-back)
Dave Love's avatar
Dave Love committed
482 483 484
  "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."
485
  (info-initialize)
Jim Blandy's avatar
Jim Blandy committed
486 487
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
488
  (if (stringp filename)
Jim Blandy's avatar
Jim Blandy committed
489
      (let (temp temp-downcase found)
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
        (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.
511
              (let ((suffix-list Info-suffix-list)
512 513 514
		    (lfn (if (fboundp 'msdos-long-file-names)
			     (msdos-long-file-names)
			   t)))
515 516 517
                (while (and suffix-list (not found))
                  (cond ((info-file-exists-p
                          (info-insert-file-contents-1
518
                           temp (car (car suffix-list)) lfn))
519 520 521
                         (setq found temp))
                        ((info-file-exists-p
                          (info-insert-file-contents-1
522 523 524 525 526 527 528 529
                           temp-downcase (car (car suffix-list)) lfn))
                         (setq found temp-downcase))
			((and (fboundp 'msdos-long-file-names)
			      lfn
			      (info-file-exists-p
			       (info-insert-file-contents-1
				temp (car (car suffix-list)) nil)))
			 (setq found temp)))
530 531 532 533 534 535 536 537 538 539
                  (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
540
  ;; Go into info buffer.
541
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
542 543 544 545 546
  (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
547
else defaults to \"Top\"."
548 549 550
  (interactive
   (list (if current-prefix-arg
	     (completing-read "Node name: " (Info-build-node-completions)
551 552
			      nil t "Top"))))
  (unless nodename (setq nodename "Top"))
553
  (info-initialize)
554 555 556 557
  (Info-mode)
  (set (make-local-variable 'Info-current-file) t)
  (Info-find-node-2 nil nodename))

558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
;; but at least it keeps this routine (which is only for the benefit of
;; makeinfo-buffer) out of the way of normal operations.
;;
(defun Info-revert-find-node (filename nodename)
  "Go to an info node FILENAME and NODENAME, re-reading disk contents.
When *info* is already displaying FILENAME and NODENAME, the window position
is preserved, if possible."
  (pop-to-buffer "*info*")
  (let ((old-filename Info-current-file)
	(old-nodename Info-current-node)
	(pcolumn      (current-column))
	(pline        (count-lines (point-min) (line-beginning-position)))
	(wline        (count-lines (point-min) (window-start)))
	(old-history  Info-history)
	(new-history (and Info-current-file
			  (list Info-current-file Info-current-node (point)))))
    (kill-buffer (current-buffer))
    (Info-find-node filename nodename)
    (setq Info-history old-history)
    (if (and (equal old-filename Info-current-file)
	     (equal old-nodename Info-current-node))
	(progn
	  ;; note goto-line is no good, we want to measure from point-min
	  (beginning-of-buffer)
	  (forward-line wline)
	  (set-window-start (selected-window) (point))
	  (beginning-of-buffer)
	  (forward-line pline)
	  (move-to-column pcolumn))
      ;; only add to the history when coming from a different file+node
      (if new-history
	  (setq Info-history (cons new-history Info-history))))))

592 593 594 595 596 597 598 599 600 601
(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."
602
  (let ((case-fold-search case-fold))
603 604 605
    (save-excursion
      (set-buffer (marker-buffer marker))
      (goto-char marker)
606

607 608 609 610
      ;; Search tag table
      (beginning-of-line)
      (when (re-search-forward regexp nil t)
	(list (string-equal "Ref:" (match-string 1))
611
	      (+ (point-min) (read (current-buffer)))
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
	      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)))
650

651 652 653 654 655 656 657 658 659
(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)))
660

661
(defun Info-find-node-2 (filename nodename &optional no-going-back)
662
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
663 664 665 666 667
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
668 669
      (let ((case-fold-search t)
	    anchorpos)
670 671 672 673 674 675 676 677 678 679 680
        ;; 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)
681
                (info-insert-file-contents filename nil)
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
                (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)
708
                            (buffer-disable-undo (current-buffer))
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
                            (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.
734
	  (let ((guesspos (point-min))
735
		(regexp (concat "\\(Node:\\|Ref:\\) *\\("
736
				(if (stringp nodename)
737 738
				    (regexp-quote nodename)
				  "")
739
				"\\) *[,\t\n\177]")))
740

741
	    (catch 'foo
742

743
	      ;; First, search a tag table, if any
744 745 746
	      (when (marker-position Info-tag-table-marker)
		(let* ((m Info-tag-table-marker)
		       (found (Info-find-in-tag-table m regexp)))
747

748 749 750
		  (when found
		    ;; FOUND is (ANCHOR POS MODE).
		    (setq guesspos (nth 1 found))
751

752 753 754 755 756 757 758
		    ;; 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)))
759 760

		    ;; Handle anchor
761 762 763
		    (when (nth 0 found)
		      (goto-char (setq anchorpos guesspos))
		      (throw 'foo t)))))
764 765 766 767

	      ;; Else we may have a node, which we search for:
	      (goto-char (max (point-min)
			      (- (byte-to-position guesspos) 1000)))
768

769 770 771 772 773 774 775 776 777 778
	      ;; 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)))
779 780 781

	    (Info-select-node)
	    (goto-char (or anchorpos (point-min))))))
Jim Blandy's avatar
Jim Blandy committed
782 783
    ;; If we did not finish finding the specified node,
    ;; go back to the previous one.
784
    (or Info-current-node no-going-back (null Info-history)
785 786 787 788
        (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
789

790 791
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
792 793
(defvar Info-dir-contents nil)

794 795 796 797
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

798 799 800 801
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

802 803
(defvar Info-dir-file-name nil)

804
;; Construct the Info directory node by merging the files named `dir'
805 806 807
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
808
(defun Info-insert-dir ()
809 810 811 812
  (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
813 814 815 816 817 818 819 820 821
		       (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)))
822
			       Info-dir-file-attributes))))
823 824 825
      (progn
	(insert Info-dir-contents)
	(goto-char (point-min)))
826
    (let ((dirs (if Info-additional-directory-list
Richard M. Stallman's avatar
Richard M. Stallman committed
827 828 829
		    (append Info-directory-list
			    Info-additional-directory-list)
		  Info-directory-list))
830
	  (dir-file-attrs nil)
831 832
	  ;; Bind this in case the user sets it to nil.
	  (case-fold-search t)
833 834
	  ;; This is set non-nil if we find a problem in some input files.
	  problems
835
	  buffers buffer others nodes dirs-done)
836 837

      ;; Search the directory list for the directory file.
838
      (while dirs
839 840 841 842 843
	(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.
844 845 846 847 848 849 850 851 852 853 854
	      (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)))))
855 856 857 858
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
859 860 861 862
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
863
		      (set-buffer (generate-new-buffer " info dir"))
864 865 866
		      (condition-case nil
			  (progn
			    (insert-file-contents file)
867 868
			    (set (make-local-variable 'Info-dir-file-name)
				 file)
869
			    (push (current-buffer) buffers)
870
			    (push (cons file attrs) dir-file-attrs))
871
			(error (kill-buffer (current-buffer))))))))
872 873 874
	  (unless (cdr dirs)
	    (set (make-local-variable 'Info-dir-contents-directory)
		 (file-name-as-directory (car dirs))))
875
	  (setq dirs (cdr dirs))))
876

877
      (or buffers
878
	  (error "Can't find the Info directory node"))
879

880
      ;; Distinguish the dir file that comes with Emacs from all the
881
      ;; others.  Yes, that is really what this is supposed to do.
882 883 884 885
      ;; 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))
886

887 888 889
      ;; 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.
890
      (insert-buffer buffer)
891

892
      ;; Look at each of the other buffers one by one.
893 894
      (dolist (other others)
	(let (this-buffer-nodes)
895
	  ;; In each, find all the menus.
896
	  (with-current-buffer other
897 898 899
	    (goto-char (point-min))
	    ;; Find each menu, and add an elt to NODES for it.
	    (while (re-search-forward "^\\* Menu:" nil t)
900 901 902 903
	      (while (and (zerop (forward-line 1)) (eolp)))
	      (let ((beg (point))
		    nodename end)
		(re-search-backward "^\^_")
904 905
		(search-forward "Node: ")
		(setq nodename (Info-following-node-name))
906
		(search-forward "\n\^_" nil 'move)
907 908
		(beginning-of-line)
		(setq end (point))
909
		(push (list nodename other beg end) this-buffer-nodes)))
910 911 912
	    (if (assoc-ignore-case "top" this-buffer-nodes)
		(setq nodes (nconc this-buffer-nodes nodes))
	      (setq problems t)
913
	      (message "No `top' node in %s" Info-dir-file-name)))))
Dave Love's avatar
Dave Love committed
914
      ;; Add to the main menu a menu item for each other node.
915
      (re-search-forward "^\\* Menu:")
916 917
      (forward-line 1)
      (let ((menu-items '("top"))
918
	    (end (save-excursion (search-forward "\^_" nil t) (point))))
919 920
	(dolist (node nodes)
	  (let ((nodename (car node)))
921 922
	    (save-excursion
	      (or (member (downcase nodename) menu-items)
923
		  (re-search-forward (concat "^\\* +"
924 925 926 927 928
					     (regexp-quote nodename)
					     "::")
				     end t)
		  (progn
		    (insert "* " nodename "::" "\n")
929
		    (push nodename menu-items)))))))
930 931
      ;; Now take each node of each of the other buffers
      ;; and merge it into the main buffer.
932
      (dolist (node nodes)
933
	(let ((case-fold-search t)
934
	      (nodename (car node)))
935 936
	  (goto-char (point-min))
	  ;; Find the like-named node in the main buffer.
937
	  (if (re-search-forward (concat "^\^_.*\n.*Node: "
938 939 940 941
					 (regexp-quote nodename)
					 "[,\n\t]")
				 nil t)
	      (progn
942
		(search-forward "\n\^_" nil 'move)
943 944
		(beginning-of-line)
		(insert "\n"))
945 946
	    ;; If none exists, add one.
	    (goto-char (point-max))
947
	    (insert "\^_\nFile: dir\tNode: " nodename "\n\n* Menu:\n\n"))
948 949
	  ;; Merge the text from the other buffer's menu
	  ;; into the menu in the like-named node in the main buffer.
950 951
	  (apply 'insert-buffer-substring (cdr node))))
      (Info-dir-remove-duplicates)
952
      ;; Kill all the buffers we just made.
953
      (mapc 'kill-buffer buffers)
954 955 956
      (goto-char (point-min))
      (if problems
	  (message "Composing main Info directory...problems encountered, see `*Messages*'")
957 958 959
	(message "Composing main Info directory...done"))
      (set (make-local-variable 'Info-dir-contents) (buffer-string))
      (set (make-local-variable 'Info-dir-file-attributes) dir-file-attrs)))
960
  (setq default-directory Info-dir-contents-directory))
961

962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
(defvar Info-streamline-headings
  '(("Emacs" . "Emacs")
    ("Programming" . "Programming")
    ("Libraries" . "Libraries")
    ("World Wide Web\\|Net Utilities" . "Net Utilities"))
  "List of elements (RE . NAME) to merge headings matching RE to NAME.")

(defun Info-dir-remove-duplicates ()
  (let (limit)
    (goto-char (point-min))
    ;; Remove duplicate headings in the same menu.
    (while (search-forward "\n* Menu:" nil t)
      (setq limit (save-excursion (search-forward "\n" nil t)))
      ;; Look for the next heading to unify.
      (while (re-search-forward "^\\(\\w.*\\)\n\\*" limit t)
	(let ((name (match-string 1))
	      (start (match-beginning 0))
	      (entries nil) re)
	  ;; Check whether this heading should be streamlined.
	  (save-match-data
	    (dolist (x Info-streamline-headings)
	      (when (string-match (car x) name)
		(setq name (cdr x))
		(setq re (car x)))))
	  (if re (replace-match name t t nil 1))
	  (goto-char (if (re-search-forward "^[^* \n\t]" limit t)
			 (match-beginning 0)
		       (or limit (point-max))))
	  ;; Look for other headings of the same category and merge them.
	  (save-excursion
	    (while (re-search-forward "^\\(\\w.*\\)\n\\*" limit t)
	      (when (if re (save-match-data (string-match re (match-string 1)))
		      (equal name (match-string 1)))
		(forward-line 0)
		;; Delete redundant heading.
		(delete-region (match-beginning 0) (point))
		;; Push the entries onto `text'.
		(push
		 (delete-and-extract-region
		  (point)
		  (if (re-search-forward "^[^* \n\t]" nil t)
		      (match-beginning 0)
		    (or limit (point-max)))) entries))))
	  ;; Insert the entries just found.
	  (while (= (line-beginning-position 0) (1- (point)))
	    (backward-char))
	  (dolist (entry (nreverse entries))
	    (insert entry)
	    (while (= (line-beginning-position 0) (1- (point)))
	      (delete-region (1- (point)) (point))))
1012

1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
	  ;; Now remove duplicate entries under the same heading.
	  (let ((seen nil)
		(limit (point)))
	    (goto-char start)
	    (while (re-search-forward "^* \\([^:\n]+:\\(:\\|[^.\n]+\\).\\)"
				      limit 'move)
	      (let ((x (match-string 1)))
	  	(if (member-ignore-case x seen)
	  	    (delete-region (match-beginning 0)
	  			   (progn (re-search-forward "^[^ \t]" nil t)
1023
	  				  (match-beginning 0)))
1024 1025
	  	  (push x seen))))))))))

1026 1027
;; 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
1028
(defun Info-read-subfile (nodepos)
1029 1030
  ;; 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
1031 1032
  (let (lastfilepos
	lastfilename)
1033 1034 1035 1036
    (if (numberp nodepos)
	(save-excursion
	  (set-buffer (marker-buffer Info-tag-table-marker))
	  (goto-char (point-min))
1037 1038
	  (or (looking-at "\^_")
	      (search-forward "\n\^_"))
1039 1040 1041