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

Stefan Monnier's avatar
Stefan Monnier committed
3
;; Copyright (C) 1985,86,92,93,94,95,96,97,98,99,2000,01,02,03,2004
4
;;  Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

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

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

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

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

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

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

Erik Naggum's avatar
Erik Naggum committed
28
;; Note that nowadays we expect info files to be made using makeinfo.
29 30 31 32
;; 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
33 34
;; 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
35 36 37

;;; Code:

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

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


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

Juri Linkov's avatar
Juri Linkov committed
50 51 52 53
(defvar Info-history-list nil
  "List of all info nodes user has visited.
Each element of list is a list (FILENAME NODENAME).")

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

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

68
(defface info-node
69 70 71
  '((((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))
72 73 74 75
  "Face for Info node names."
  :group 'info)

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

(defface info-xref
82 83
  '((((class color) (background light)) :foreground "blue" :underline t)
    (((class color) (background dark)) :foreground "cyan" :underline t)
84
    (t :underline t))
85 86 87
  "Face for Info cross-references."
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
88
(defface info-xref-visited
89 90
  '((t :inherit info-xref)
    (((class color) (background light)) :foreground "magenta4")
91
    (((class color) (background dark)) :foreground "magenta3")) ;"violet"?
Juri Linkov's avatar
Juri Linkov committed
92 93 94 95 96 97 98 99 100
  "Face for visited Info cross-references."
  :group 'info)

(defcustom Info-fontify-visited-nodes t
  "*Non-nil means to fontify visited nodes in a different face."
  :version "21.4"
  :type 'boolean
  :group 'info)

101
(defcustom Info-fontify-maximum-menu-size 100000
102
  "*Maximum size of menu to fontify if `font-lock-mode' is non-nil."
103 104
  :type 'integer
  :group 'info)
105

Miles Bader's avatar
Miles Bader committed
106
(defcustom Info-use-header-line t
107
  "*Non-nil means to put the beginning-of-node links in an Emacs header-line.
Miles Bader's avatar
Miles Bader committed
108 109 110 111 112
A header-line does not scroll with the rest of the buffer."
  :type 'boolean
  :group 'info)

(defface info-header-xref
113
  '((t :inherit info-xref))
Miles Bader's avatar
Miles Bader committed
114 115 116 117
  "Face for Info cross-references in a node header."
  :group 'info)

(defface info-header-node
118
  '((t :inherit info-node))
Miles Bader's avatar
Miles Bader committed
119 120 121
  "Face for Info nodes in a node header."
  :group 'info)

122
(defvar Info-directory-list nil
Jim Blandy's avatar
Jim Blandy committed
123
  "List of directories to search for Info documentation files.
124
If nil, meaning not yet initialized, Info uses the environment
125
variable INFOPATH to initialize it, or `Info-default-directory-list'
126 127
if there is no INFOPATH variable in the environment, or the
concatenation of the two if INFOPATH ends with a colon.
128 129

When `Info-directory-list' is initialized from the value of
130 131 132 133 134 135 136
`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
137 138
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
139 140 141 142 143 144
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.
145 146

If you run the Emacs executable from the `src' directory in the Emacs
147 148 149 150
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
151

152
(defcustom Info-additional-directory-list nil
153
  "List of additional directories to search for Info documentation files.
154
These directories are searched after those in `Info-directory-list'."
155 156
  :type '(repeat directory)
  :group 'info)
157

158
(defcustom Info-scroll-prefer-subnodes nil
159 160 161 162 163 164 165 166 167
  "*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."
168
  :version "21.4"
169 170 171
  :type 'boolean
  :group 'info)

172
(defcustom Info-hide-note-references t
173
  "*If non-nil, hide the tag and section reference in *note and * menu items.
Juri Linkov's avatar
Juri Linkov committed
174 175
If value is non-nil but not `hide', also replaces the \"*note\" with \"see\".
If value is non-nil but not t or `hide', the reference section is still shown."
176
  :version "21.4"
Juri Linkov's avatar
Juri Linkov committed
177
  :type '(choice (const :tag "No hiding" nil)
178
		 (const :tag "Replace tag and hide reference" t)
Juri Linkov's avatar
Juri Linkov committed
179 180
		 (const :tag "Hide tag and reference" hide)
		 (other :tag "Only replace tag" tag))
181 182
  :group 'info)

Kim F. Storm's avatar
Kim F. Storm committed
183 184 185 186 187 188 189 190
(defcustom Info-refill-paragraphs nil
  "*If non-nil, attempt to refill paragraphs with hidden references.
This refilling may accidentally remove explicit line breaks in the info
file, so be prepared for a few surprises if you enable this feature."
  :version "21.4"
  :type 'boolean
  :group 'info)

191
(defcustom Info-search-whitespace-regexp "\\s-+"
Juri Linkov's avatar
Juri Linkov committed
192 193 194 195 196 197 198 199
  "*If non-nil, regular expression to match a sequence of whitespace chars.
This applies to Info search for regular expressions.
You might want to use something like \"[ \\t\\r\\n]+\" instead.
In the Customization buffer, that is `[' followed by a space,
a tab, a carriage return (control-M), a newline, and `]+'."
  :type 'regexp
  :group 'info)

200 201 202 203
(defcustom Info-mode-hook
  ;; Try to obey obsolete Info-fontify settings.
  (unless (and (boundp 'Info-fontify) (null Info-fontify))
    '(turn-on-font-lock))
Juri Linkov's avatar
Juri Linkov committed
204 205 206 207 208 209
  "Hooks run when `Info-mode' is called."
  :type 'hook
  :group 'info)

(defcustom Info-selection-hook nil
  "Hooks run when `Info-select-node' is called."
Colin Walters's avatar
Colin Walters committed
210 211 212
  :type 'hook
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
213 214 215
(defvar Info-edit-mode-hook nil
  "Hooks run when `Info-edit-mode' is called.")

Jim Blandy's avatar
Jim Blandy committed
216
(defvar Info-current-file nil
217 218
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
219 220
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
221 222

(defvar Info-current-subfile nil
Dave Love's avatar
Dave Love committed
223 224
  "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
225 226 227 228

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

229
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
230 231 232
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

233 234 235
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

236 237 238
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

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

242 243 244 245 246
(defvar Info-point-loc nil
  "Point location within a selected node.
If string, the point is moved to the proper occurrence of the
name of the followed cross reference within a selected node.
If number, the point is moved to the corresponding line.")
Juri Linkov's avatar
Juri Linkov committed
247

248 249
(defvar Info-standalone nil
  "Non-nil if Emacs was started solely as an Info browser.")
250

251
(defvar Info-suffix-list
252 253
  ;; The MS-DOS list should work both when long file names are
  ;; supported (Windows 9X), and when only 8+3 file names are available.
254 255 256
  (if (eq system-type 'ms-dos)
      '( (".gz"      . "gunzip")
	 (".z"       . "gunzip")
257
	 (".bz2"     . ("bzip2" "-dc"))
258 259 260 261 262 263 264 265
	 (".inz"     . "gunzip")
	 (".igz"     . "gunzip")
	 (".info.Z"  . "gunzip")
	 (".info.gz" . "gunzip")
	 ("-info.Z"  . "gunzip")
	 ("-info.gz" . "gunzip")
	 ("/index.gz". "gunzip")
	 ("/index.z" . "gunzip")
266
	 (".inf"     . nil)
267 268 269
	 (".info"    . nil)
	 ("-info"    . nil)
	 ("/index"   . nil)
270
	 (""         . nil))
271 272 273 274
    '( (".info.Z".    "uncompress")
       (".info.Y".    "unyabba")
       (".info.gz".   "gunzip")
       (".info.z".    "gunzip")
275
       (".info.bz2" . ("bzip2" "-dc"))
276 277 278 279
       (".info".      nil)
       ("-info.Z".   "uncompress")
       ("-info.Y".   "unyabba")
       ("-info.gz".  "gunzip")
280
       ("-info.bz2" . ("bzip2" "-dc"))
281 282 283 284 285 286
       ("-info.z".   "gunzip")
       ("-info".     nil)
       ("/index.Z".   "uncompress")
       ("/index.Y".   "unyabba")
       ("/index.gz".  "gunzip")
       ("/index.z".   "gunzip")
287
       ("/index.bz2". ("bzip2" "-dc"))
288 289 290 291 292
       ("/index".     nil)
       (".Z".         "uncompress")
       (".Y".         "unyabba")
       (".gz".        "gunzip")
       (".z".         "gunzip")
293
       (".bz2" .      ("bzip2" "-dc"))
294
       ("".           nil)))
295 296
  "List of file name suffixes and associated decoding commands.
Each entry should be (SUFFIX . STRING); the file is given to
297 298 299 300 301 302
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.
303 304
Because the SUFFIXes are tried in order, the empty string should
be last in the list.")
305

306
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
307 308 309 310
;; 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
311 312
      (concat filename suffix)
    (let* ((sans-exts (file-name-sans-extension filename))
313 314 315
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
316
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
317
      ;; get rid of the one in SUFFIX (unless suffix is empty).
318
      (or (and (<= ext-len 0)
319
	       (not (eq (aref filename (1- (length filename))) ?.)))
320
	  (= (length suffix) 0)
321
	  (setq suffix (substring suffix 1)))
322 323
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
324 325 326 327 328
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

329 330 331 332
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

333 334 335
(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."
336
  (let* ((tail Info-suffix-list)
337 338 339
	 (lfn (if (fboundp 'msdos-long-file-names)
		  (msdos-long-file-names)
		t))
340 341 342
	 (check-short (and (fboundp 'msdos-long-file-names)
			   lfn))
	 fullname decoder done)
343
    (if (info-file-exists-p filename)
344 345
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
346 347 348 349 350 351 352 353
	(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))))
354
      ;; Try adding suffixes to FILENAME and see if we can find something.
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
      (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))))))
371 372
	(setq tail (cdr tail)))
      (or tail
373
	  (error "Can't find %s or any compressed version of it" filename)))
374 375 376 377 378
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
379
    (if decoder
380 381 382 383 384 385
	(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)))
386 387 388 389
	    (or (consp decoder)
		(setq decoder (list decoder)))
	    (apply 'call-process-region (point-min) (point-max)
		   (car decoder) t t nil (cdr decoder))))
390
      (insert-file-contents fullname visit))))
391

392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
(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
430 431 432
	    ;; Don't drop the last part, it might contain non-Emacs stuff.
	    ;; (reverse (cdr (reverse
	    Info-default-directory-list)))) ;; )))
433

434
(defun info-initialize ()
Dave Love's avatar
Dave Love committed
435
  "Initialize `Info-directory-list', if that hasn't been done yet."
436
  (unless Info-directory-list
437
    (let ((path (getenv "INFOPATH")))
438
      (setq Info-directory-list
439 440
	    (prune-directory-list
	     (if path
441 442 443 444 445 446
		 (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)))))))
447

448 449 450 451 452
;;;###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))))
453
  (let (same-window-buffer-names same-window-regexps)
454
    (info file)))
455

456
;;;###autoload (add-hook 'same-window-regexps "\\*info\\*\\(\\|<[0-9]+>\\)")
457

458
;;;###autoload (put 'info 'info-file "emacs")
Jim Blandy's avatar
Jim Blandy committed
459
;;;###autoload
460
(defun info (&optional file buffer)
Jim Blandy's avatar
Jim Blandy committed
461 462 463
  "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
464 465
Called from a program, FILE may specify an Info node of the form
`(FILENAME)NODENAME'.
466 467 468 469
Optional argument BUFFER specifies the Info buffer name;
the default buffer name is *info*.  If BUFFER exists,
just switch to BUFFER.  Otherwise, create a new buffer
with the top-level Info directory.
Jim Blandy's avatar
Jim Blandy committed
470

471 472
In interactive use, a non-numeric prefix argument directs
this command to read a file name from the minibuffer.
Juri Linkov's avatar
Juri Linkov committed
473 474
A numeric prefix argument selects an Info buffer with the prefix number
appended to the Info buffer name.
Richard M. Stallman's avatar
Richard M. Stallman committed
475 476

The search path for Info files is in the variable `Info-directory-list'.
477
The top-level Info directory is made by combining all the files named `dir'
Richard M. Stallman's avatar
Richard M. Stallman committed
478
in all the directories in that path."
479 480 481 482 483 484 485 486
  (interactive (list
                (if (and current-prefix-arg (not (numberp current-prefix-arg)))
                    (read-file-name "Info file name: " nil nil t))
                (if (numberp current-prefix-arg)
                    (format "*info*<%s>" current-prefix-arg))))
  (pop-to-buffer (or buffer "*info*"))
  (if (and buffer (not (eq major-mode 'Info-mode)))
      (Info-mode))
Jim Blandy's avatar
Jim Blandy committed
487
  (if file
488 489 490 491 492 493 494 495
      ;; 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 ")")))
    (if (zerop (buffer-size))
Juri Linkov's avatar
Juri Linkov committed
496
        (Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
497

498 499
;;;###autoload
(defun info-emacs-manual ()
500
  "Display the Emacs manual in Info mode."
501 502 503
  (interactive)
  (info "emacs"))

504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
;;;###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)))
521

Stefan Monnier's avatar
Stefan Monnier committed
522
;; See if the accessible portion of the buffer begins with a node
523 524 525 526 527 528 529 530 531
;; 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
532
;; REGEXP, if the function succeeds, nil otherwise.
533
(defun Info-node-at-bob-matching (regexp)
534 535
  (and (bobp)				; are we at beginning of buffer?
       (looking-at "\^_")		; does it begin with node delimiter?
536 537 538
       (let (beg)
	 (forward-line 1)
	 (setq beg (point))
539
	 (forward-line 1)		; does the line after delimiter match REGEXP?
540 541
	 (re-search-backward regexp beg t))))

Juri Linkov's avatar
Juri Linkov committed
542 543 544 545
(defun Info-find-file (filename &optional noerror)
  "Return expanded FILENAME, or t, if FILENAME is \"dir\".
Optional second argument NOERROR, if t, means if file is not found
just return nil (no error)."
Jim Blandy's avatar
Jim Blandy committed
546 547
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
548
  (if (stringp filename)
Jim Blandy's avatar
Jim Blandy committed
549
      (let (temp temp-downcase found)
550
        (setq filename (substitute-in-file-name filename))
Juri Linkov's avatar
Juri Linkov committed
551
	(cond
Jesper Harder's avatar
Jesper Harder committed
552 553 554 555
	 ((string= (downcase filename) "dir")
	  (setq found t))
	 ((string= filename "apropos")
	  (setq found 'apropos))
Juri Linkov's avatar
Juri Linkov committed
556 557 558 559
	 ((string= filename "history")
	  (setq found 'history))
	 ((string= filename "toc")
	  (setq found 'toc))
Jesper Harder's avatar
Jesper Harder committed
560 561
	 (t
	  (let ((dirs (if (string-match "^\\./" filename)
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
                          ;; 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.
579
              (let ((suffix-list Info-suffix-list)
580 581 582
		    (lfn (if (fboundp 'msdos-long-file-names)
			     (msdos-long-file-names)
			   t)))
583 584 585
                (while (and suffix-list (not found))
                  (cond ((info-file-exists-p
                          (info-insert-file-contents-1
586
                           temp (car (car suffix-list)) lfn))
587 588 589
                         (setq found temp))
                        ((info-file-exists-p
                          (info-insert-file-contents-1
590 591 592 593 594 595 596 597
                           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)))
598
                  (setq suffix-list (cdr suffix-list))))
Jesper Harder's avatar
Jesper Harder committed
599
              (setq dirs (cdr dirs))))))
600 601
        (if found
            (setq filename found)
Juri Linkov's avatar
Juri Linkov committed
602 603 604 605 606 607 608 609 610 611 612
          (if noerror
              (setq filename nil)
            (error "Info file %s does not exist" filename)))
        filename)))

(defun Info-find-node (filename nodename &optional no-going-back)
  "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."
  (info-initialize)
  (setq filename (Info-find-file filename))
613 614 615 616 617
  ;; 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
618
  ;; Go into info buffer.
619
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
620 621 622 623 624
  (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
625
else defaults to \"Top\"."
626 627 628
  (interactive
   (list (if current-prefix-arg
	     (completing-read "Node name: " (Info-build-node-completions)
629 630
			      nil t "Top"))))
  (unless nodename (setq nodename "Top"))
631
  (info-initialize)
632 633 634 635
  (Info-mode)
  (set (make-local-variable 'Info-current-file) t)
  (Info-find-node-2 nil nodename))

636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
;; 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
660
	  (goto-char (point-min))
661 662
	  (forward-line wline)
	  (set-window-start (selected-window) (point))
663
	  (goto-char (point-min))
664 665 666 667 668 669
	  (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))))))

670 671 672 673 674 675 676 677 678 679
(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."
680
  (let ((case-fold-search case-fold))
681 682 683
    (save-excursion
      (set-buffer (marker-buffer marker))
      (goto-char marker)
684

685 686 687 688
      ;; Search tag table
      (beginning-of-line)
      (when (re-search-forward regexp nil t)
	(list (string-equal "Ref:" (match-string 1))
689
	      (+ (point-min) (read (current-buffer)))
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
	      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)))
728

729 730 731 732 733 734 735 736 737
(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)))
738

739
(defun Info-find-node-2 (filename nodename &optional no-going-back)
740
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
741 742 743 744 745
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
746 747
      (let ((case-fold-search t)
	    anchorpos)
748 749 750 751 752 753 754 755 756
        ;; 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)
Jesper Harder's avatar
Jesper Harder committed
757 758 759 760 761
	      (cond
	       ((eq filename t)
		(Info-insert-dir))
	       ((eq filename 'apropos)
		(insert-buffer-substring " *info-apropos*"))
Juri Linkov's avatar
Juri Linkov committed
762 763 764 765
	       ((eq filename 'history)
		(insert-buffer-substring " *info-history*"))
	       ((eq filename 'toc)
		(insert-buffer-substring " *info-toc*"))
Jesper Harder's avatar
Jesper Harder committed
766
	       (t
767
                (info-insert-file-contents filename nil)
Jesper Harder's avatar
Jesper Harder committed
768
                (setq default-directory (file-name-directory filename))))
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
              (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)
794
                            (buffer-disable-undo (current-buffer))
795 796 797 798 799 800 801 802
                            (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
Jesper Harder's avatar
Jesper Harder committed
803 804 805
		    (cond
		     ((eq filename t) "dir")
		     ((eq filename 'apropos) "apropos")
Juri Linkov's avatar
Juri Linkov committed
806 807
		     ((eq filename 'history) "history")
		     ((eq filename 'toc) "toc")
Jesper Harder's avatar
Jesper Harder committed
808 809
		     (t filename)))
	      ))
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
        ;; 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.
826
	  (let ((guesspos (point-min))
827
		(regexp (concat "\\(Node:\\|Ref:\\) *\\("
828
				(if (stringp nodename)
829 830
				    (regexp-quote nodename)
				  "")
831
				"\\) *[,\t\n\177]")))
832

833
	    (catch 'foo
834

835
	      ;; First, search a tag table, if any
836 837 838
	      (when (marker-position Info-tag-table-marker)
		(let* ((m Info-tag-table-marker)
		       (found (Info-find-in-tag-table m regexp)))
839

840 841 842
		  (when found
		    ;; FOUND is (ANCHOR POS MODE).
		    (setq guesspos (nth 1 found))
843

844 845 846 847 848 849 850
		    ;; 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)))
851 852

		    ;; Handle anchor
853 854 855
		    (when (nth 0 found)
		      (goto-char (setq anchorpos guesspos))
		      (throw 'foo t)))))
856 857 858 859

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

861 862 863 864 865 866 867
	      ;; 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)
868 869 870 871 872 873 874 875 876 877 878
		  (throw 'foo t)))

              (when (string-match "\\([^.]+\\)\\." nodename)
                (let (Info-point-loc)
                  (Info-find-node-2
                   filename (match-string 1 nodename) no-going-back))
                (widen)
                (throw 'foo t))

              ;; No such anchor in tag table or node in tag table or file
              (error "No such node or anchor: %s" nodename))
879 880

	    (Info-select-node)
Juri Linkov's avatar
Juri Linkov committed
881 882 883 884 885 886 887 888 889
	    (goto-char (point-min))
	    (cond (anchorpos
                   (let ((new-history (list Info-current-file
                                            (substring-no-properties nodename))))
                     ;; Add anchors to the history too
                     (setq Info-history-list
                           (cons new-history
                                 (delete new-history Info-history-list))))
                   (goto-char anchorpos))
890 891 892 893 894 895
                  ((numberp Info-point-loc)
                   (forward-line (1- Info-point-loc))
                   (setq Info-point-loc nil))
		  ((stringp Info-point-loc)
		   (Info-find-index-name Info-point-loc)
		   (setq Info-point-loc nil))))))
Jim Blandy's avatar
Jim Blandy committed
896 897
    ;; If we did not finish finding the specified node,
    ;; go back to the previous one.
898
    (or Info-current-node no-going-back (null Info-history)
899 900 901 902
        (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
903

904 905
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
906 907
(defvar Info-dir-contents nil)

908 909 910 911
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

912 913 914 915
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

916 917
(defvar Info-dir-file-name nil)

918
;; Construct the Info directory node by merging the files named `dir'
919 920 921
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
922
(defun Info-insert-dir ()
923 924 925 926
  (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
927 928 929 930 931 932 933 934 935
		       (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)))
936
			       Info-dir-file-attributes))))
937 938 939
      (progn
	(insert Info-dir-contents)
	(goto-char (point-min)))
940
    (let ((dirs (if Info-additional-directory-list
Richard M. Stallman's avatar
Richard M. Stallman committed
941 942 943
		    (append Info-directory-list
			    Info-additional-directory-list)
		  Info-directory-list))
944
	  (dir-file-attrs nil)
945 946
	  ;; Bind this in case the user sets it to nil.
	  (case-fold-search t)
947 948
	  ;; This is set non-nil if we find a problem in some input files.
	  problems
949
	  buffers buffer others nodes dirs-done)
950 951

      ;; Search the directory list for the directory file.
952
      (while dirs
953 954 955 956 957
	(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.
958 959 960 961 962 963 964 965 966 967 968
	      (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)))))
969 970 971 972
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
973 974 975 976
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
977
		      (set-buffer (generate-new-buffer " info dir"))
978 979 980
		      (condition-case nil
			  (progn
			    (insert-file-contents file)
981 982
			    (set (make-local-variable 'Info-dir-file-name)
				 file)
983
			    (push (current-buffer) buffers)
984
			    (push (cons file attrs) dir-file-attrs))
985
			(error (kill-buffer (current-buffer))))))))
986 987 988
	  (unless (cdr dirs)
	    (set (make-local-variable 'Info-dir-contents-directory)
		 (file-name-as-directory (car dirs))))
989
	  (setq dirs (cdr dirs))))
990

991
      (or buffers
992
	  (error "Can't find the Info directory node"))
993

994
      ;; Distinguish the dir file that comes with Emacs from all the
995
      ;; others.  Yes, that is really what this is supposed to do.
996 997 998 999
      ;; 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))
1000

1001 1002 1003
      ;; 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.
1004
      (insert-buffer buffer)
1005

1006
      ;; Look at each of the other buffers one by one.
1007 1008
      (dolist (other others)
	(let (this-buffer-nodes)
1009
	  ;; In each, find all the menus.
1010
	  (with-current-buffer other
1011 1012 1013
	    (goto-char (point-min))
	    ;; Find each menu, and add an elt to NODES for it.
	    (while (re-search-forward "^\\* Menu:" nil t)
1014 1015 1016 1017
	      (while (and (zerop (forward-line 1)) (eolp)))
	      (let ((beg (point))
		    nodename end)
		(re-search-backward "^\^_")
1018
		(search-forward "Node: ")
Juri Linkov's avatar
Juri Linkov committed
1019
		(setq nodename (Info-following-node-name))
1020
		(search-forward "\n\^_" nil 'move)
1021 1022
		(beginning-of-line)
		(setq end (point))
Stefan Monnier's avatar