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

3 4 5
;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
;;   1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
;;   2010  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
;; This file is part of GNU Emacs.

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

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Jim Blandy's avatar
Jim Blandy committed
24

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

27
;; Note that nowadays we expect Info files to be made using makeinfo.
28 29 30 31
;; 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
32 33
;; 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
34 35 36

;;; Code:

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

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


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

49
(defvar Info-history-forward nil
50
  "Stack of Info nodes user has visited with `Info-history-back' command.
51
Each element of the stack is a list (FILENAME NODENAME BUFFERPOS).")
52

Juri Linkov's avatar
Juri Linkov committed
53
(defvar Info-history-list nil
54
  "List of all Info nodes user has visited.
55
Each element of the list is a list (FILENAME NODENAME).")
Juri Linkov's avatar
Juri Linkov committed
56

57
(defcustom Info-enable-edit nil
Lute Kamstra's avatar
Lute Kamstra committed
58
  "Non-nil means the \\<Info-mode-map>\\[Info-edit] command in Info can edit the current node.
59
This is convenient if you want to write Info files by hand.
60 61
However, we recommend that you not do this.
It is better to write a Texinfo file and generate the Info file from that,
62 63 64
because that gives you a printed manual as well."
  :type 'boolean
  :group 'info)
Jim Blandy's avatar
Jim Blandy committed
65

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

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

78 79 80 81 82 83 84 85
(defface info-title-1
  '((((type tty pc) (class color) (background light))
     :foreground "green" :weight bold)
    (((type tty pc) (class color) (background dark))
     :foreground "yellow" :weight bold)
    (t :height 1.2 :inherit info-title-2))
  "Face for info titles at level 1."
  :group 'info)
86
(define-obsolete-face-alias 'Info-title-1-face 'info-title-1 "22.1")
87 88 89 90 91 92

(defface info-title-2
  '((((type tty pc) (class color)) :foreground "lightblue" :weight bold)
    (t :height 1.2 :inherit info-title-3))
  "Face for info titles at level 2."
  :group 'info)
93
(define-obsolete-face-alias 'Info-title-2-face 'info-title-2 "22.1")
94 95 96 97 98 99

(defface info-title-3
  '((((type tty pc) (class color)) :weight bold)
    (t :height 1.2 :inherit info-title-4))
  "Face for info titles at level 3."
  :group 'info)
100
(define-obsolete-face-alias 'Info-title-3-face 'info-title-3 "22.1")
101 102 103 104 105 106

(defface info-title-4
  '((((type tty pc) (class color)) :weight bold)
    (t :weight bold :inherit variable-pitch))
  "Face for info titles at level 4."
  :group 'info)
107
(define-obsolete-face-alias 'Info-title-4-face 'info-title-4 "22.1")
108 109 110 111 112 113 114 115 116 117 118 119

(defface info-menu-header
  '((((type tty pc))
     :underline t
     :weight bold)
    (t
     :inherit variable-pitch
     :weight bold))
  "Face for headers in Info menus."
  :group 'info)

(defface info-menu-star
120 121
  '((((class color)) :foreground "red1")
    (t :underline t))
122
  "Face for every third `*' in an Info menu."
123
  :group 'info)
124
(define-obsolete-face-alias 'info-menu-5 'info-menu-star "22.1")
125 126

(defface info-xref
127 128
  '((t :inherit link))
  "Face for unvisited Info cross-references."
129 130
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
131
(defface info-xref-visited
132
  '((t :inherit (link-visited info-xref)))
Juri Linkov's avatar
Juri Linkov committed
133
  "Face for visited Info cross-references."
134
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
135 136 137
  :group 'info)

(defcustom Info-fontify-visited-nodes t
Lute Kamstra's avatar
Lute Kamstra committed
138
  "Non-nil to fontify references to visited nodes in `info-xref-visited' face."
139
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
140 141 142
  :type 'boolean
  :group 'info)

143
(defcustom Info-fontify-maximum-menu-size 100000
Lute Kamstra's avatar
Lute Kamstra committed
144
  "Maximum size of menu to fontify if `font-lock-mode' is non-nil.
145
Set to nil to disable node fontification."
146 147
  :type 'integer
  :group 'info)
148

Miles Bader's avatar
Miles Bader committed
149
(defcustom Info-use-header-line t
Lute Kamstra's avatar
Lute Kamstra committed
150
  "Non-nil means to put the beginning-of-node links in an Emacs header-line.
Miles Bader's avatar
Miles Bader committed
151 152 153 154 155
A header-line does not scroll with the rest of the buffer."
  :type 'boolean
  :group 'info)

(defface info-header-xref
156
  '((t :inherit info-xref))
Miles Bader's avatar
Miles Bader committed
157 158 159 160
  "Face for Info cross-references in a node header."
  :group 'info)

(defface info-header-node
161
  '((t :inherit info-node))
Miles Bader's avatar
Miles Bader committed
162 163 164
  "Face for Info nodes in a node header."
  :group 'info)

165
(defvar Info-directory-list nil
Jim Blandy's avatar
Jim Blandy committed
166
  "List of directories to search for Info documentation files.
167
If nil, meaning not yet initialized, Info uses the environment
168
variable INFOPATH to initialize it, or `Info-default-directory-list'
169 170
if there is no INFOPATH variable in the environment, or the
concatenation of the two if INFOPATH ends with a colon.
171 172

When `Info-directory-list' is initialized from the value of
173 174 175 176 177 178 179
`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
180 181
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
182 183 184 185 186 187
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.
188 189

If you run the Emacs executable from the `src' directory in the Emacs
190 191 192 193
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
194

195
(defcustom Info-additional-directory-list nil
196
  "List of additional directories to search for Info documentation files.
197
These directories are searched after those in `Info-directory-list'."
198 199
  :type '(repeat directory)
  :group 'info)
200

201
(defcustom Info-scroll-prefer-subnodes nil
Lute Kamstra's avatar
Lute Kamstra committed
202
  "If non-nil, \\<Info-mode-map>\\[Info-scroll-up] in a menu visits subnodes.
203

204 205 206 207 208 209 210 211
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."
212
  :version "22.1"
213 214 215
  :type 'boolean
  :group 'info)

216
(defcustom Info-hide-note-references t
Lute Kamstra's avatar
Lute Kamstra committed
217
  "If non-nil, hide the tag and section reference in *note and * menu items.
Juri Linkov's avatar
Juri Linkov committed
218
If value is non-nil but not `hide', also replaces the \"*note\" with \"see\".
219
If value is non-nil but not t or `hide', the reference section is still shown.
220 221
`nil' completely disables this feature.  If this is non-nil, you might
want to set `Info-refill-paragraphs'."
222
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
223
  :type '(choice (const :tag "No hiding" nil)
224
		 (const :tag "Replace tag and hide reference" t)
Juri Linkov's avatar
Juri Linkov committed
225 226
		 (const :tag "Hide tag and reference" hide)
		 (other :tag "Only replace tag" tag))
227 228
  :group 'info)

Kim F. Storm's avatar
Kim F. Storm committed
229
(defcustom Info-refill-paragraphs nil
Lute Kamstra's avatar
Lute Kamstra committed
230
  "If non-nil, attempt to refill paragraphs with hidden references.
231
This refilling may accidentally remove explicit line breaks in the Info
232 233
file, so be prepared for a few surprises if you enable this feature.
This only has an effect if `Info-hide-note-references' is non-nil."
234
  :version "22.1"
Kim F. Storm's avatar
Kim F. Storm committed
235 236 237
  :type 'boolean
  :group 'info)

238 239 240
(defcustom Info-breadcrumbs-depth 4
  "Depth of breadcrumbs to display.
0 means do not display breadcrumbs."
241 242 243
  :version "23.1"
  :type 'integer
  :group 'info)
244

245
(defcustom Info-search-whitespace-regexp "\\s-+"
Lute Kamstra's avatar
Lute Kamstra committed
246
  "If non-nil, regular expression to match a sequence of whitespace chars.
Juri Linkov's avatar
Juri Linkov committed
247 248 249 250 251 252 253
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)

254
(defcustom Info-isearch-search t
Lute Kamstra's avatar
Lute Kamstra committed
255
  "If non-nil, isearch in Info searches through multiple nodes.
256 257 258 259 260 261 262 263 264 265
Before leaving the initial Info node, where isearch was started,
it fails once with the error message [initial node], and with
subsequent C-s/C-r continues through other nodes without failing
with this error message in other nodes.  When isearch fails for
the rest of the manual, it wraps aroung the whole manual and
restarts the search from the top/final node depending on
search direction.

Setting this option to nil restores the default isearch behavior
with wrapping around the current Info node."
266 267 268 269
  :version "22.1"
  :type 'boolean
  :group 'info)

270
(defvar Info-isearch-initial-node nil)
271 272
(defvar Info-isearch-initial-history nil)
(defvar Info-isearch-initial-history-list nil)
273

274 275 276 277
(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
278 279 280 281 282 283
  "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
284 285 286
  :type 'hook
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
287 288 289
(defvar Info-edit-mode-hook nil
  "Hooks run when `Info-edit-mode' is called.")

Jim Blandy's avatar
Jim Blandy committed
290
(defvar Info-current-file nil
291 292
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
293
It doesn't contain directory names or file name extensions added by Info.")
Jim Blandy's avatar
Jim Blandy committed
294 295

(defvar Info-current-subfile nil
Dave Love's avatar
Dave Love committed
296
  "Info subfile that is actually in the *info* buffer now.
297
It is nil if current Info file is not split into subfiles.")
Jim Blandy's avatar
Jim Blandy committed
298 299 300 301

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

302
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
303 304 305
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

306 307 308
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

309 310 311
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

312 313 314
(defvar Info-file-supports-index-cookies nil
  "Non-nil if current Info file supports index cookies.")

315 316 317 318 319
(defvar Info-file-supports-index-cookies-list nil
  "List of Info files with information about index cookies support.
Each element of the list is a list (FILENAME SUPPORTS-INDEX-COOKIES)
where SUPPORTS-INDEX-COOKIES can be either t or nil.")

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

323 324 325 326 327
(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
328

329 330
(defvar Info-standalone nil
  "Non-nil if Emacs was started solely as an Info browser.")
Juri Linkov's avatar
Juri Linkov committed
331 332 333 334 335 336 337 338 339 340 341 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

(defvar Info-virtual-files nil
  "List of definitions of virtual Info files.
Each element of the list has the format (FILENAME (OPERATION . HANDLER) ...)
where FILENAME is a regexp that matches a class of virtual Info file names.
It should be carefully chosen to not cause file name clashes with
existing file names.  OPERATION is one of the following operation
symbols `find-file', `find-node', `toc-nodes' that define what HANDLER
function to call instead of calling the default corresponding function
to override it.")

(defvar Info-virtual-nodes nil
  "List of definitions of virtual Info nodes.
Each element of the list has the format (NODENAME (OPERATION . HANDLER) ...)
where NODENAME is a regexp that matches a class of virtual Info node names.
It should be carefully chosen to not cause node name clashes with
existing node names.  OPERATION is one of the following operation
symbols `find-node' that define what HANDLER
function to call instead of calling the default corresponding function
to override it.")

(defvar Info-current-node-virtual nil
  "Non-nil if the current Info node is virtual.")

(defun Info-virtual-file-p (filename)
  "Check if Info file FILENAME is virtual."
  (Info-virtual-fun 'find-file filename nil))

(defun Info-virtual-fun (op filename nodename)
  "Find a function that handles operations on virtual manuals.
OP is an operation symbol (`find-file', `find-node' or `toc-nodes'),
FILENAME is a virtual Info file name, NODENAME is a virtual Info
node name.  Return a function found either in `Info-virtual-files'
or `Info-virtual-nodes'."
  (or (and (stringp filename) ; some legacy code can still use a symbol
	   (cdr-safe (assoc op (assoc-default filename
					      Info-virtual-files
					      'string-match))))
      (and (stringp nodename) ; some legacy code can still use a symbol
	   (cdr-safe (assoc op (assoc-default nodename
					      Info-virtual-nodes
					      'string-match))))))

(defun Info-virtual-call (virtual-fun &rest args)
  "Call a function that handles operations on virtual manuals."
  (when (functionp virtual-fun)
    (or (apply virtual-fun args) t)))

379

380
(defvar Info-suffix-list
381 382
  ;; The MS-DOS list should work both when long file names are
  ;; supported (Windows 9X), and when only 8+3 file names are available.
383 384 385
  (if (eq system-type 'ms-dos)
      '( (".gz"      . "gunzip")
	 (".z"       . "gunzip")
386
	 (".bz2"     . ("bzip2" "-dc"))
387 388 389 390 391 392 393 394
	 (".inz"     . "gunzip")
	 (".igz"     . "gunzip")
	 (".info.Z"  . "gunzip")
	 (".info.gz" . "gunzip")
	 ("-info.Z"  . "gunzip")
	 ("-info.gz" . "gunzip")
	 ("/index.gz". "gunzip")
	 ("/index.z" . "gunzip")
395
	 (".inf"     . nil)
396 397 398
	 (".info"    . nil)
	 ("-info"    . nil)
	 ("/index"   . nil)
399
	 (""         . nil))
400 401 402 403
    '( (".info.Z".    "uncompress")
       (".info.Y".    "unyabba")
       (".info.gz".   "gunzip")
       (".info.z".    "gunzip")
404
       (".info.bz2" . ("bzip2" "-dc"))
405
       (".info.xz".   "unxz")
406 407 408 409
       (".info".      nil)
       ("-info.Z".   "uncompress")
       ("-info.Y".   "unyabba")
       ("-info.gz".  "gunzip")
410
       ("-info.bz2" . ("bzip2" "-dc"))
411
       ("-info.z".   "gunzip")
412
       ("-info.xz".  "unxz")
413 414 415 416 417
       ("-info".     nil)
       ("/index.Z".   "uncompress")
       ("/index.Y".   "unyabba")
       ("/index.gz".  "gunzip")
       ("/index.z".   "gunzip")
418
       ("/index.bz2". ("bzip2" "-dc"))
419
       ("/index.xz".  "unxz")
420 421 422 423 424
       ("/index".     nil)
       (".Z".         "uncompress")
       (".Y".         "unyabba")
       (".gz".        "gunzip")
       (".z".         "gunzip")
425
       (".bz2" .      ("bzip2" "-dc"))
426
       (".xz".        "unxz")
427
       ("".           nil)))
428 429
  "List of file name suffixes and associated decoding commands.
Each entry should be (SUFFIX . STRING); the file is given to
430 431 432 433 434 435
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.
436 437
Because the SUFFIXes are tried in order, the empty string should
be last in the list.")
438

439
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
440 441 442 443
;; 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
444 445
      (concat filename suffix)
    (let* ((sans-exts (file-name-sans-extension filename))
446 447 448
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
449
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
450
      ;; get rid of the one in SUFFIX (unless suffix is empty).
451
      (or (and (<= ext-len 0)
452
	       (not (eq (aref filename (1- (length filename))) ?.)))
453
	  (= (length suffix) 0)
454
	  (setq suffix (substring suffix 1)))
455 456
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
457 458 459 460 461
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

462 463 464 465
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

466
(defun info-insert-file-contents (filename &optional visit)
467
  "Insert the contents of an Info file in the current buffer.
468
Do the right thing if the file has been compressed or zipped."
469
  (let* ((tail Info-suffix-list)
470 471 472
	 (lfn (if (fboundp 'msdos-long-file-names)
		  (msdos-long-file-names)
		t))
473 474 475
	 (check-short (and (fboundp 'msdos-long-file-names)
			   lfn))
	 fullname decoder done)
476
    (if (info-file-exists-p filename)
477 478
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
479 480 481 482 483 484 485 486
	(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))))
487
      ;; Try adding suffixes to FILENAME and see if we can find something.
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
      (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))))))
504 505
	(setq tail (cdr tail)))
      (or tail
506
	  (error "Can't find %s or any compressed version of it" filename)))
507
    ;; check for conflict with jka-compr
508
    (if (and (jka-compr-installed-p)
509 510
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
511
    (if decoder
512 513
	(progn
	  (insert-file-contents-literally fullname visit)
514
	  (let ((inhibit-read-only t)
515
		(coding-system-for-write 'no-conversion)
Eli Zaretskii's avatar
Eli Zaretskii committed
516
		(inhibit-null-byte-detection t) ; Index nodes include null bytes
517 518
		(default-directory (or (file-name-directory fullname)
				       default-directory)))
519 520 521 522
	    (or (consp decoder)
		(setq decoder (list decoder)))
	    (apply 'call-process-region (point-min) (point-max)
		   (car decoder) t t nil (cdr decoder))))
Eli Zaretskii's avatar
Eli Zaretskii committed
523 524
      (let ((inhibit-null-byte-detection t)) ; Index nodes include null bytes
	(insert-file-contents fullname visit)))))
525 526 527 528

(defun Info-file-supports-index-cookies (&optional file)
  "Return non-nil value if FILE supports Info index cookies.
Info index cookies were first introduced in 4.7, and all later
529
makeinfo versions output them in index nodes, so we can rely
530 531 532 533 534 535
solely on the makeinfo version.  This function caches the information
in `Info-file-supports-index-cookies-list'."
  (or file (setq file Info-current-file))
  (or (assoc file Info-file-supports-index-cookies-list)
      ;; Skip virtual Info files
      (and (or (not (stringp file))
Juri Linkov's avatar
Juri Linkov committed
536
	       (Info-virtual-file-p file))
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
           (setq Info-file-supports-index-cookies-list
		 (cons (cons file nil) Info-file-supports-index-cookies-list)))
      (save-excursion
	(let ((found nil))
	  (goto-char (point-min))
	  (condition-case ()
	      (if (and (re-search-forward
			"makeinfo[ \n]version[ \n]\\([0-9]+.[0-9]+\\)"
			(line-beginning-position 3) t)
		       (not (version< (match-string 1) "4.7")))
		  (setq found t))
	    (error nil))
	  (setq Info-file-supports-index-cookies-list
		(cons (cons file found) Info-file-supports-index-cookies-list)))))
  (cdr (assoc file Info-file-supports-index-cookies-list)))

553

554 555 556 557 558 559
(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
560
				       "../share/info/"
561 562 563 564
				       invocation-directory)))
			 (if (file-exists-p infodir)
			     infodir
			   (setq infodir (expand-file-name
565
					  "../../../share/info/"
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
					  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
592 593 594
	    ;; Don't drop the last part, it might contain non-Emacs stuff.
	    ;; (reverse (cdr (reverse
	    Info-default-directory-list)))) ;; )))
595

596
(defun info-initialize ()
Dave Love's avatar
Dave Love committed
597
  "Initialize `Info-directory-list', if that hasn't been done yet."
598
  (unless Info-directory-list
599
    (let ((path (getenv "INFOPATH")))
600
      (setq Info-directory-list
601 602
	    (prune-directory-list
	     (if path
603 604 605 606 607 608
		 (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)))))))
609

610
;;;###autoload
611
(defun info-other-window (&optional file-or-node)
612 613 614
  "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))))
615
  (let (same-window-buffer-names same-window-regexps)
616
    (info file-or-node)))
617

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

620
;;;###autoload (put 'info 'info-file (purecopy "emacs"))
Jim Blandy's avatar
Jim Blandy committed
621
;;;###autoload
622
(defun info (&optional file-or-node buffer)
Jim Blandy's avatar
Jim Blandy committed
623
  "Enter Info, the documentation browser.
624
Optional argument FILE-OR-NODE specifies the file to examine;
Jim Blandy's avatar
Jim Blandy committed
625
the default is the top-level directory of Info.
626
Called from a program, FILE-OR-NODE may specify an Info node of the form
Dave Love's avatar
Dave Love committed
627
`(FILENAME)NODENAME'.
628 629 630 631
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
632

633 634
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
635 636
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
637 638

The search path for Info files is in the variable `Info-directory-list'.
639
The top-level Info directory is made by combining all the files named `dir'
Juri Linkov's avatar
Juri Linkov committed
640 641 642
in all the directories in that path.

See a list of available Info commands in `Info-mode'."
643 644 645 646 647 648 649 650
  (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))
651
  (if file-or-node
652 653 654 655
      ;; 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.
656
      (Info-goto-node
657 658 659
       (if (and (stringp file-or-node) (string-match "(.*)" file-or-node))
           file-or-node
         (concat "(" file-or-node ")")))
660 661 662 663
    (if (and (zerop (buffer-size))
	     (null Info-history))
	;; If we just created the Info buffer, go to the directory.
	(Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
664

665 666
;;;###autoload
(defun info-emacs-manual ()
667
  "Display the Emacs manual in Info mode."
668 669 670
  (interactive)
  (info "emacs"))

671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
;;;###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)))
688

Stefan Monnier's avatar
Stefan Monnier committed
689
;; See if the accessible portion of the buffer begins with a node
690 691 692 693 694 695 696 697 698
;; 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
699
;; REGEXP, if the function succeeds, nil otherwise.
700
(defun Info-node-at-bob-matching (regexp)
701 702
  (and (bobp)				; are we at beginning of buffer?
       (looking-at "\^_")		; does it begin with node delimiter?
703 704 705
       (let (beg)
	 (forward-line 1)
	 (setq beg (point))
706
	 (forward-line 1)		; does the line after delimiter match REGEXP?
707 708
	 (re-search-backward regexp beg t))))

Juri Linkov's avatar
Juri Linkov committed
709 710 711 712
(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
713 714
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
Juri Linkov's avatar
Juri Linkov committed
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
  (cond
   ((Info-virtual-call
     (Info-virtual-fun 'find-file filename nil)
     filename noerror))
   ((stringp filename)
    (let (temp temp-downcase found)
      (setq filename (substitute-in-file-name filename))
      (let ((dirs (if (string-match "^\\./" filename)
		      ;; If specified name starts with `./'
		      ;; then just try current directory.
		      '("./")
		    (if (file-name-absolute-p filename)
			;; No point in searching for an
			;; absolute file name
			'(nil)
		      (if Info-additional-directory-list
			  (append Info-directory-list
				  Info-additional-directory-list)
			Info-directory-list)))))
	;; Search the directory list for file FILENAME.
	(while (and dirs (not found))
	  (setq temp (expand-file-name filename (car dirs)))
	  (setq temp-downcase
		(expand-file-name (downcase filename) (car dirs)))
	  ;; Try several variants of specified name.
	  (let ((suffix-list Info-suffix-list)
		(lfn (if (fboundp 'msdos-long-file-names)
			 (msdos-long-file-names)
		       t)))
	    (while (and suffix-list (not found))
	      (cond ((info-file-exists-p
		      (info-insert-file-contents-1
		       temp (car (car suffix-list)) lfn))
		     (setq found temp))
		    ((info-file-exists-p
		      (info-insert-file-contents-1
		       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)))
	      (setq suffix-list (cdr suffix-list))))
	  (setq dirs (cdr dirs))))
      (if found
	  (setq filename found)
	(if noerror
	    (setq filename nil)
	  (error "Info file %s does not exist" filename)))
      filename))))
Juri Linkov's avatar
Juri Linkov committed
767 768

(defun Info-find-node (filename nodename &optional no-going-back)
769
  "Go to an Info node specified as separate FILENAME and NODENAME.
Juri Linkov's avatar
Juri Linkov committed
770 771 772 773
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))
774
  ;; Go into Info buffer.
775
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
776 777 778
  ;; Record the node we are leaving, if we were in one.
  (and (not no-going-back)
       Info-current-file
779 780
       (push (list Info-current-file Info-current-node (point))
             Info-history))
781 782
  (Info-find-node-2 filename nodename no-going-back))

783
;;;###autoload
784
(defun Info-on-current-buffer (&optional nodename)
785 786 787
  "Use Info mode to browse the current Info buffer.
With a prefix arg, this queries for the node name to visit first;
otherwise, that defaults to `Top'."
788 789 790
  (interactive
   (list (if current-prefix-arg
	     (completing-read "Node name: " (Info-build-node-completions)
791 792
			      nil t "Top"))))
  (unless nodename (setq nodename "Top"))
793
  (info-initialize)
794
  (Info-mode)
795 796 797 798
  (set (make-local-variable 'Info-current-file)
       (or buffer-file-name
	   ;; If called on a non-file buffer, make a fake file name.
	   (concat default-directory (buffer-name))))
799 800
  (Info-find-node-2 nil nodename))

801
;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
802 803
;; but at least it keeps this routine (which is for makeinfo-buffer and
;; Info-revert-buffer-function) out of the way of normal operations.
804 805
;;
(defun Info-revert-find-node (filename nodename)
806
  "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
807 808
When *info* is already displaying FILENAME and NODENAME, the window position
is preserved, if possible."
809
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
810 811
  (let ((old-filename Info-current-file)
	(old-nodename Info-current-node)
812
	(old-buffer-name (buffer-name))
813 814 815
	(pcolumn      (current-column))
	(pline        (count-lines (point-min) (line-beginning-position)))
	(wline        (count-lines (point-min) (window-start)))
816
	(old-history-forward Info-history-forward)
817
	(old-history  Info-history)
818 819
	(new-history  (and Info-current-file
			   (list Info-current-file Info-current-node (point)))))
820
    (kill-buffer (current-buffer))
821 822
    (pop-to-buffer (or old-buffer-name "*info*"))
    (Info-mode)
823
    (Info-find-node filename nodename)
824
    (setq Info-history-forward old-history-forward)
825 826 827 828 829
    (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
830
	  (goto-char (point-min))
831 832
	  (forward-line wline)
	  (set-window-start (selected-window) (point))
833
	  (goto-char (point-min))
834 835 836 837 838 839
	  (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))))))

840 841 842 843 844
(defun Info-revert-buffer-function (ignore-auto noconfirm)
  (when (or noconfirm (y-or-n-p "Revert info buffer? "))
    (Info-revert-find-node Info-current-file Info-current-node)
    (message "Reverted %s" Info-current-file)))

845 846 847 848 849 850 851 852 853 854
(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."
855
  (let ((case-fold-search case-fold))
856
    (with-current-buffer (marker-buffer marker)
857
      (goto-char marker)
858

859 860 861 862
      ;; Search tag table
      (beginning-of-line)
      (when (re-search-forward regexp nil t)
	(list (string-equal "Ref:" (match-string 1))
863
	      (+ (point-min) (read (current-buffer)))
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
	      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)))
902

903 904 905 906 907 908 909 910 911
(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)))
912

913
(defun Info-find-node-2 (filename nodename &optional no-going-back)
914
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
915 916 917 918 919
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
920
      (let ((case-fold-search t)
Juri Linkov's avatar
Juri Linkov committed
921 922 923
	    (virtual-fun (Info-virtual-fun 'find-node
					   (or filename Info-current-file)
					   nodename))
924
	    anchorpos)
Juri Linkov's avatar
Juri Linkov committed
925 926 927 928
	(cond
	 ((functionp virtual-fun)
	  (let ((filename (or filename Info-current-file)))
	    (setq buffer-read-only nil)
929 930 931 932
	    (setq Info-current-file filename
		  Info-current-subfile nil
		  Info-current-file-completions nil
		  buffer-file-name nil)
Juri Linkov's avatar
Juri Linkov committed
933 934 935 936 937 938 939 940 941 942 943 944 945
	    (erase-buffer)
	    (Info-virtual-call virtual-fun filename nodename no-going-back)
	    (set-marker Info-tag-table-marker nil)
	    (setq buffer-read-only t)
	    (set-buffer-modified-p nil)
	    (set (make-local-variable 'Info-current-node-virtual) t)))
	 ((not (and
		;; Reread a file when moving from a virtual node.
		(not Info-current-node-virtual)
		(or (null filename)
		    (equal Info-current-file filename))))
	  ;; Switch files if necessary
	  (let ((inhibit-read-only t))
946 947 948 949 950
	    (when Info-current-node-virtual
	      ;; When moving from a virtual node.
	      (set (make-local-variable 'Info-current-node-virtual) nil)
	      (if (null filename)
		  (setq filename Info-current-file)))
Juri Linkov's avatar
Juri Linkov committed
951 952 953 954 955 956 957 958 959 960 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
	    (setq Info-current-file nil
		  Info-current-subfile nil
		  Info-current-file-completions nil
		  buffer-file-name nil)
	    (erase-buffer)
	    (info-insert-file-contents filename nil)
	    (setq default-directory (file-name-directory filename))
	    (set-buffer-modified-p nil)
	    (set (make-local-variable 'Info-file-supports-index-cookies)
		 (Info-file-supports-index-cookies filename))

	    ;; 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)
			(with-current-buffer tagbuf
			  (buffer-disable-undo (current-buffer))
			  (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 filename)
	    )))

996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
        ;; 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.
1012
	  (let ((guesspos (point-min))
1013
		(regexp (concat "\\(Node:\\|Ref:\\) *\\("
1014
				(if (stringp nodename)
1015 1016
				    (regexp-quote nodename)
				  "")
1017
				"\\) *[,\t\n\177]")))
1018

1019
	    (catch 'foo
1020

1021
	      ;; First, search a tag table, if any
1022 1023 1024
	      (when (marker-position Info-tag-table-marker)
		(let* ((m Info-tag-table-marker)
		       (found (Info-find-in-tag-table m regexp)))
1025

1026 1027 1028
		  (when found
		    ;; FOUND is (ANCHOR POS MODE).
		    (setq guesspos (nth 1 found))
1029

1030 1031 1032 1033 1034 1035 1036
		    ;; 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)))
1037 1038

		    ;; Handle anchor
1039 1040 1041
		    (when (nth 0 found)
		      (goto-char (setq anchorpos guesspos))
		      (throw 'foo t)))))
1042 1043 1044 1045

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

1047