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

3
;; Copyright (C) 1985-1986, 1992-2011  Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

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

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

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

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

Eric S. Raymond's avatar
Eric S. Raymond committed
23 24
;;; Commentary:

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

;;; Code:

35
(eval-when-compile (require 'cl))
Dave Love's avatar
Dave Love committed
36

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


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

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

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

55 56 57 58 59 60 61 62 63
(defcustom Info-history-skip-intermediate-nodes t
  "Non-nil means don't record intermediate Info nodes to the history.
Intermediate Info nodes are nodes visited by Info internally in the process of
searching the node to display.  Intermediate nodes are not presented
to the user."
  :type 'boolean
  :group 'info
  :version "24.1")

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

73
(defvar Info-enable-active-nodes nil
Jim Blandy's avatar
Jim Blandy committed
74 75
  "Non-nil allows Info to execute Lisp code associated with nodes.
The Lisp code is executed when the node is selected.")
76
(put 'Info-enable-active-nodes 'risky-local-variable t)
Jim Blandy's avatar
Jim Blandy committed
77

78
(defface info-node
79 80 81
  '((((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))
82 83 84
  "Face for Info node names."
  :group 'info)

85 86 87 88 89 90 91 92
(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)
93
(define-obsolete-face-alias 'Info-title-1-face 'info-title-1 "22.1")
94 95 96 97 98 99

(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)
100
(define-obsolete-face-alias 'Info-title-2-face 'info-title-2 "22.1")
101 102 103 104 105 106

(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)
107
(define-obsolete-face-alias 'Info-title-3-face 'info-title-3 "22.1")
108 109 110 111 112 113

(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)
114
(define-obsolete-face-alias 'Info-title-4-face 'info-title-4 "22.1")
115 116 117 118 119 120 121 122 123 124 125 126

(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
127 128
  '((((class color)) :foreground "red1")
    (t :underline t))
129
  "Face for every third `*' in an Info menu."
130
  :group 'info)
131
(define-obsolete-face-alias 'info-menu-5 'info-menu-star "22.1")
132 133

(defface info-xref
134 135
  '((t :inherit link))
  "Face for unvisited Info cross-references."
136 137
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
138
(defface info-xref-visited
139
  '((t :inherit (link-visited info-xref)))
Juri Linkov's avatar
Juri Linkov committed
140
  "Face for visited Info cross-references."
141
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
142 143 144
  :group 'info)

(defcustom Info-fontify-visited-nodes t
Lute Kamstra's avatar
Lute Kamstra committed
145
  "Non-nil to fontify references to visited nodes in `info-xref-visited' face."
146
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
147 148 149
  :type 'boolean
  :group 'info)

150
(defcustom Info-fontify-maximum-menu-size 100000
Lute Kamstra's avatar
Lute Kamstra committed
151
  "Maximum size of menu to fontify if `font-lock-mode' is non-nil.
152
Set to nil to disable node fontification."
153 154
  :type 'integer
  :group 'info)
155

Miles Bader's avatar
Miles Bader committed
156
(defcustom Info-use-header-line t
Lute Kamstra's avatar
Lute Kamstra committed
157
  "Non-nil means to put the beginning-of-node links in an Emacs header-line.
Miles Bader's avatar
Miles Bader committed
158 159 160 161 162
A header-line does not scroll with the rest of the buffer."
  :type 'boolean
  :group 'info)

(defface info-header-xref
163
  '((t :inherit info-xref))
Miles Bader's avatar
Miles Bader committed
164 165 166 167
  "Face for Info cross-references in a node header."
  :group 'info)

(defface info-header-node
168
  '((t :inherit info-node))
Miles Bader's avatar
Miles Bader committed
169 170 171
  "Face for Info nodes in a node header."
  :group 'info)

172
(defvar Info-directory-list nil
Jim Blandy's avatar
Jim Blandy committed
173
  "List of directories to search for Info documentation files.
174
If nil, meaning not yet initialized, Info uses the environment
175
variable INFOPATH to initialize it, or `Info-default-directory-list'
176
if there is no INFOPATH variable in the environment, or the
177
concatenation of the two if INFOPATH ends with a `path-separator'.
178 179

When `Info-directory-list' is initialized from the value of
180 181 182 183 184 185 186
`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
187 188
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
189 190 191 192 193 194
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.
195 196

If you run the Emacs executable from the `src' directory in the Emacs
197 198 199 200
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
201

202
(defcustom Info-additional-directory-list nil
203
  "List of additional directories to search for Info documentation files.
204
These directories are searched after those in `Info-directory-list'."
205 206
  :type '(repeat directory)
  :group 'info)
207

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

211 212 213 214 215 216 217 218
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."
219
  :version "22.1"
220 221 222
  :type 'boolean
  :group 'info)

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

Kim F. Storm's avatar
Kim F. Storm committed
236
(defcustom Info-refill-paragraphs nil
Lute Kamstra's avatar
Lute Kamstra committed
237
  "If non-nil, attempt to refill paragraphs with hidden references.
238
This refilling may accidentally remove explicit line breaks in the Info
239 240
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."
241
  :version "22.1"
Kim F. Storm's avatar
Kim F. Storm committed
242 243 244
  :type 'boolean
  :group 'info)

245 246 247
(defcustom Info-breadcrumbs-depth 4
  "Depth of breadcrumbs to display.
0 means do not display breadcrumbs."
248 249 250
  :version "23.1"
  :type 'integer
  :group 'info)
251

252
(defcustom Info-search-whitespace-regexp "\\s-+"
Lute Kamstra's avatar
Lute Kamstra committed
253
  "If non-nil, regular expression to match a sequence of whitespace chars.
Juri Linkov's avatar
Juri Linkov committed
254 255 256 257 258 259 260
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)

261
(defcustom Info-isearch-search t
Lute Kamstra's avatar
Lute Kamstra committed
262
  "If non-nil, isearch in Info searches through multiple nodes.
263 264 265 266
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
Paul Eggert's avatar
Paul Eggert committed
267
the rest of the manual, it wraps around the whole manual and
268 269 270 271 272
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."
273 274 275 276
  :version "22.1"
  :type 'boolean
  :group 'info)

277
(defvar Info-isearch-initial-node nil)
278 279
(defvar Info-isearch-initial-history nil)
(defvar Info-isearch-initial-history-list nil)
280

281 282 283 284
(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
285 286 287 288 289 290
  "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
291 292 293
  :type 'hook
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
294 295 296
(defvar Info-edit-mode-hook nil
  "Hooks run when `Info-edit-mode' is called.")

Jim Blandy's avatar
Jim Blandy committed
297
(defvar Info-current-file nil
298 299
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
300
It doesn't contain directory names or file name extensions added by Info.")
Jim Blandy's avatar
Jim Blandy committed
301 302

(defvar Info-current-subfile nil
Dave Love's avatar
Dave Love committed
303
  "Info subfile that is actually in the *info* buffer now.
304
It is nil if current Info file is not split into subfiles.")
Jim Blandy's avatar
Jim Blandy committed
305 306 307 308

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

309
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
310 311 312
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

313 314 315
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

316 317 318
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

319 320 321
(defvar Info-file-supports-index-cookies nil
  "Non-nil if current Info file supports index cookies.")

322 323 324 325 326
(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.")

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

330 331 332 333 334
(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
335

336 337
(defvar Info-standalone nil
  "Non-nil if Emacs was started solely as an Info browser.")
Juri Linkov's avatar
Juri Linkov committed
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354

(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
355 356
symbols `find-node' that define what HANDLER function to call instead
of calling the default corresponding function to override it.")
Juri Linkov's avatar
Juri Linkov committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384

(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)))

385

386
(defvar Info-suffix-list
387 388
  ;; The MS-DOS list should work both when long file names are
  ;; supported (Windows 9X), and when only 8+3 file names are available.
389
  (if (eq system-type 'ms-dos)
390 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 430 431 432 433
      '( (".gz"       . "gunzip")
	 (".z"        . "gunzip")
	 (".bz2"      . ("bzip2" "-dc"))
	 (".inz"      . "gunzip")
	 (".igz"      . "gunzip")
	 (".info.Z"   . "gunzip")
	 (".info.gz"  . "gunzip")
	 ("-info.Z"   . "gunzip")
	 ("-info.gz"  . "gunzip")
	 ("/index.gz" . "gunzip")
	 ("/index.z"  . "gunzip")
	 (".inf"      . nil)
	 (".info"     . nil)
	 ("-info"     . nil)
	 ("/index"    . nil)
	 (""          . nil))
    '( (".info.Z"    . "uncompress")
       (".info.Y"    . "unyabba")
       (".info.gz"   . "gunzip")
       (".info.z"    . "gunzip")
       (".info.bz2"  . ("bzip2" "-dc"))
       (".info.xz"   . "unxz")
       (".info"      . nil)
       ("-info.Z"    . "uncompress")
       ("-info.Y"    . "unyabba")
       ("-info.gz"   . "gunzip")
       ("-info.bz2"  . ("bzip2" "-dc"))
       ("-info.z"    . "gunzip")
       ("-info.xz"   . "unxz")
       ("-info"      . nil)
       ("/index.Z"   . "uncompress")
       ("/index.Y"   . "unyabba")
       ("/index.gz"  . "gunzip")
       ("/index.z"   . "gunzip")
       ("/index.bz2" . ("bzip2" "-dc"))
       ("/index.xz"  . "unxz")
       ("/index"     . nil)
       (".Z"         . "uncompress")
       (".Y"         . "unyabba")
       (".gz"        . "gunzip")
       (".z"         . "gunzip")
       (".bz2"       . ("bzip2" "-dc"))
       (".xz"        . "unxz")
       (""           . nil)))
434 435
  "List of file name suffixes and associated decoding commands.
Each entry should be (SUFFIX . STRING); the file is given to
436 437 438 439 440 441
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.
442 443
Because the SUFFIXes are tried in order, the empty string should
be last in the list.")
444

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

468 469 470 471
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

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

(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
536
makeinfo versions output them in index nodes, so we can rely
537 538 539 540 541 542
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
543
	       (Info-virtual-file-p file))
544 545 546 547 548 549 550 551
           (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]+\\)"
552
			(line-beginning-position 4) t)
553 554 555 556 557 558 559
		       (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)))

560

561 562 563 564 565 566
(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
567
				       "../share/info/"
568 569 570 571
				       invocation-directory)))
			 (if (file-exists-p infodir)
			     infodir
			   (setq infodir (expand-file-name
572
					  "../../../share/info/"
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
					  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
599 600 601
	    ;; Don't drop the last part, it might contain non-Emacs stuff.
	    ;; (reverse (cdr (reverse
	    Info-default-directory-list)))) ;; )))
602

603
(defun info-initialize ()
Dave Love's avatar
Dave Love committed
604
  "Initialize `Info-directory-list', if that hasn't been done yet."
605
  (unless Info-directory-list
Ralph Schleicher's avatar
Ralph Schleicher committed
606 607
    (let ((path (getenv "INFOPATH"))
	  (sep (regexp-quote path-separator)))
608
      (setq Info-directory-list
609 610
	    (prune-directory-list
	     (if path
Ralph Schleicher's avatar
Ralph Schleicher committed
611 612
		 (if (string-match-p (concat sep "\\'") path)
		     (append (split-string (substring path 0 -1) sep)
613
			     (Info-default-dirs))
Ralph Schleicher's avatar
Ralph Schleicher committed
614
		   (split-string path sep))
615
	       (Info-default-dirs)))))))
616

617
;;;###autoload
618
(defun info-other-window (&optional file-or-node)
619 620 621
  "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))))
622
  (info-setup file-or-node (switch-to-buffer-other-window "*info*")))
623

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

637 638
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
639 640
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
641 642

The search path for Info files is in the variable `Info-directory-list'.
643
The top-level Info directory is made by combining all the files named `dir'
Juri Linkov's avatar
Juri Linkov committed
644 645 646
in all the directories in that path.

See a list of available Info commands in `Info-mode'."
647 648 649 650 651
  (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))))
652 653
  (info-setup file-or-node
	      (pop-to-buffer-same-window (or buffer "*info*"))))
654 655 656

(defun info-setup (file-or-node buffer)
  "Display Info node FILE-OR-NODE in BUFFER."
657 658
  (if (and buffer (not (eq major-mode 'Info-mode)))
      (Info-mode))
659
  (if file-or-node
660 661 662 663
      ;; 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.
664
      (Info-goto-node
665 666 667
       (if (and (stringp file-or-node) (string-match "(.*)" file-or-node))
           file-or-node
         (concat "(" file-or-node ")")))
668 669 670 671
    (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
672

673 674
;;;###autoload
(defun info-emacs-manual ()
675
  "Display the Emacs manual in Info mode."
676 677 678
  (interactive)
  (info "emacs"))

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

Juri Linkov's avatar
Juri Linkov committed
717
(defun Info-find-file (filename &optional noerror)
718
  "Return expanded FILENAME, or t if FILENAME is \"dir\".
Juri Linkov's avatar
Juri Linkov committed
719 720
Optional second argument NOERROR, if t, means if file is not found
just return nil (no error)."
Jim Blandy's avatar
Jim Blandy committed
721 722
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
Juri Linkov's avatar
Juri Linkov committed
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
  (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)))))
742 743 744 745 746
	;; Fall back on the installation directory if we can't find
	;; the info node anywhere else.
	(when installation-directory
	  (setq dirs (append dirs (list (expand-file-name
					 "info" installation-directory)))))
Juri Linkov's avatar
Juri Linkov committed
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
	;; 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
780 781

(defun Info-find-node (filename nodename &optional no-going-back)
782
  "Go to an Info node specified as separate FILENAME and NODENAME.
Juri Linkov's avatar
Juri Linkov committed
783 784 785 786
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))
787
  ;; Go into Info buffer.
788
  (or (eq major-mode 'Info-mode) (switch-to-buffer "*info*"))
789 790 791
  ;; Record the node we are leaving, if we were in one.
  (and (not no-going-back)
       Info-current-file
792 793
       (push (list Info-current-file Info-current-node (point))
             Info-history))
794 795
  (Info-find-node-2 filename nodename no-going-back))

796
;;;###autoload
797
(defun Info-on-current-buffer (&optional nodename)
798 799 800
  "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'."
801 802 803
  (interactive
   (list (if current-prefix-arg
	     (completing-read "Node name: " (Info-build-node-completions)
804 805
			      nil t "Top"))))
  (unless nodename (setq nodename "Top"))
806
  (info-initialize)
807
  (Info-mode)
808 809 810 811
  (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))))
812 813
  (Info-find-node-2 nil nodename))

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

853
(defun Info-revert-buffer-function (_ignore-auto noconfirm)
854 855 856 857
  (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)))

858 859 860 861 862 863 864 865 866 867
(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."
868
  (let ((case-fold-search case-fold))
869
    (with-current-buffer (marker-buffer marker)
870
      (goto-char marker)
871

872 873 874 875
      ;; Search tag table
      (beginning-of-line)
      (when (re-search-forward regexp nil t)
	(list (string-equal "Ref:" (match-string 1))
876
	      (+ (point-min) (read (current-buffer)))
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 902 903
	      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
904 905 906 907 908 909 910 911 912 913
      (if (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)
            (if (re-search-backward regexp beg t)
                (setq found (line-beginning-position)))))))
    found))
914

915 916 917 918 919 920 921 922 923
(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)))
924

925
(defun Info-find-node-2 (filename nodename &optional no-going-back)
926
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
927 928 929 930 931
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
932
      (let ((case-fold-search t)
Juri Linkov's avatar
Juri Linkov committed
933 934 935
	    (virtual-fun (Info-virtual-fun 'find-node
					   (or filename Info-current-file)
					   nodename))
936
	    anchorpos)
Juri Linkov's avatar
Juri Linkov committed
937 938 939 940
	(cond
	 ((functionp virtual-fun)
	  (let ((filename (or filename Info-current-file)))
	    (setq buffer-read-only nil)
941 942 943 944
	    (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
945 946 947 948 949 950 951 952 953 954 955 956 957
	    (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))
958 959 960 961 962
	    (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
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
	    (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)
	    )))

1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
        ;; 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.
1024
	  (let ((guesspos (point-min))
1025
		(regexp (concat "\\(Node:\\|Ref:\\) *\\("
1026
				(if (stringp nodename)
1027 1028
				    (regexp-quote nodename)
				  "")
1029
				"\\) *[,\t\n\177]")))
1030

1031
	    (catch 'foo
1032

1033
	      ;; First, search a tag table, if any
1034 1035 1036
	      (when (marker-position Info-tag-table-marker)
		(let* ((m Info-tag-table-marker)
		       (found (Info-find-in-tag-table m regexp)))
1037

1038 1039 1040
		  (when found
		    ;; FOUND is (ANCHOR POS MODE).
		    (setq guesspos (nth 1 found))
1041

1042 1043 1044 1045 1046 1047 1048
		    ;; 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)))
1049 1050

		    ;; Handle anchor
1051 1052 1053
		    (when (nth 0 found)
		      (goto-char