info.el 208 KB
Newer Older
1
;; info.el --- Info package for Emacs  -*- lexical-binding:t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

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

5
;; Maintainer: emacs-devel@gnu.org
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 36
(eval-when-compile (require 'cl-lib))

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


43
(defvar-local 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-local 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
(defvar Info-enable-active-nodes nil
Jim Blandy's avatar
Jim Blandy committed
65 66
  "Non-nil allows Info to execute Lisp code associated with nodes.
The Lisp code is executed when the node is selected.")
67
(put 'Info-enable-active-nodes 'risky-local-variable t)
Jim Blandy's avatar
Jim Blandy committed
68

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

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
(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)

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

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

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

(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
114 115
  '((((class color)) :foreground "red1")
    (t :underline t))
116
  "Face for every third `*' in an Info menu."
117 118 119
  :group 'info)

(defface info-xref
120 121
  '((t :inherit link))
  "Face for unvisited Info cross-references."
122 123
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
124
(defface info-xref-visited
125
  '((t :inherit (link-visited info-xref)))
Juri Linkov's avatar
Juri Linkov committed
126
  "Face for visited Info cross-references."
127
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
128 129 130
  :group 'info)

(defcustom Info-fontify-visited-nodes t
Lute Kamstra's avatar
Lute Kamstra committed
131
  "Non-nil to fontify references to visited nodes in `info-xref-visited' face."
132
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
133 134 135
  :type 'boolean
  :group 'info)

136 137
;; It's unfortunate that nil means no fontification, as opposed to no limit,
;; since that differs from font-lock-maximum-size.
138
(defcustom Info-fontify-maximum-menu-size 400000
Lute Kamstra's avatar
Lute Kamstra committed
139
  "Maximum size of menu to fontify if `font-lock-mode' is non-nil.
140 141 142 143
Set to nil to disable node fontification; set to t for no limit."
  :type '(choice (const :tag "No fontification" nil)
		 (const :tag "No size limit" t)
		 (integer :tag "Up to this many characters"))
144
  :version "25.1"			; 100k -> 400k
145
  :group 'info)
146

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

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

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

163 164 165 166 167 168
(defface info-index-match
  '((t :inherit match))
  "Face used to highlight matches in an index entry."
  :group 'info
  :version "24.4")

Glenn Morris's avatar
Glenn Morris committed
169 170 171 172 173
;; This is a defcustom largely so that we can get the benefit
;; of custom-initialize-delay.  Perhaps it would work to make it a
;; defvar and explicitly give it a standard-value property, and
;; call custom-initialize-delay on it.
;; The progn forces the autoloader to include the whole thing, not
174 175 176 177 178
;; just an abbreviated version.  The value is initialized at startup
;; time, when command-line calls custom-reevaluate-setting on all
;; the defcustoms in custom-delayed-init-variables.  This is
;; somewhat sub-optimal, as ideally this should be done when Info
;; mode is first invoked.
Glenn Morris's avatar
Glenn Morris committed
179 180 181 182 183 184 185 186 187 188 189 190
;;;###autoload
(progn
(defcustom Info-default-directory-list
  (let* ((config-dir
	  (file-name-as-directory
	   ;; Self-contained NS build with info/ in the app-bundle.
	   (or (and (featurep 'ns)
		    (let ((dir (expand-file-name "../info" data-directory)))
		      (if (file-directory-p dir) dir)))
	       configure-info-directory)))
	 (prefixes
	  ;; Directory trees in which to look for info subdirectories
191
	  (prune-directory-list '("/usr/local/" "/usr/" "/opt/")))
Glenn Morris's avatar
Glenn Morris committed
192 193
	 (suffixes
	  ;; Subdirectories in each directory tree that may contain info
194 195
	  ;; directories.
	  '("share/" ""))
Glenn Morris's avatar
Glenn Morris committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
	 (standard-info-dirs
	  (apply #'nconc
		 (mapcar (lambda (pfx)
			   (let ((dirs
				  (mapcar (lambda (sfx)
					    (concat pfx sfx "info/"))
					  suffixes)))
			     (prune-directory-list dirs)))
			 prefixes)))
	 ;; If $(prefix)/share/info is not one of the standard info
	 ;; directories, they are probably installing an experimental
	 ;; version of Emacs, so make sure that experimental version's Info
	 ;; files override the ones in standard directories.
	 (dirs
	  (if (member config-dir standard-info-dirs)
	      ;; FIXME?  What is the point of adding it again at the end
	      ;; when it is already present earlier in the list?
	      (nconc standard-info-dirs (list config-dir))
	    (cons config-dir standard-info-dirs))))
    (if (not (eq system-type 'windows-nt))
	dirs
      ;; Include the info directory near where Emacs executable was installed.
      (let* ((instdir (file-name-directory invocation-directory))
	     (dir1 (expand-file-name "../info/" instdir))
	     (dir2 (expand-file-name "../../../info/" instdir)))
	(cond ((file-exists-p dir1) (append dirs (list dir1)))
	      ((file-exists-p dir2) (append dirs (list dir2)))
	      (t dirs)))))

  "Default list of directories to search for Info documentation files.
They are searched in the order they are given in the list.
Therefore, the directory of Info files that come with Emacs
normally should come last (so that local files override standard ones),
unless Emacs is installed into a non-standard directory.  In the latter
case, the directory of Info files that come with Emacs should be
first in this list.

Once Info is started, the list of directories to search
comes from the variable `Info-directory-list'.
This variable `Info-default-directory-list' is used as the default
for initializing `Info-directory-list' when Info is started, unless
the environment variable INFOPATH is set.

Although this is a customizable variable, that is mainly for technical
reasons.  Normally, you should either set INFOPATH or customize
`Info-additional-directory-list', rather than changing this variable."
  :initialize 'custom-initialize-delay
  :type '(repeat directory)
  :group 'info))

246
(defvar Info-directory-list nil
Jim Blandy's avatar
Jim Blandy committed
247
  "List of directories to search for Info documentation files.
248
If nil, meaning not yet initialized, Info uses the environment
249
variable INFOPATH to initialize it, or `Info-default-directory-list'
250
if there is no INFOPATH variable in the environment, or the
251
concatenation of the two if INFOPATH ends with a `path-separator'.
252 253

When `Info-directory-list' is initialized from the value of
254 255 256 257 258 259 260
`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
261 262
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
263 264 265 266 267 268
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.
269 270

If you run the Emacs executable from the `src' directory in the Emacs
271 272 273 274
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
275

276
(defcustom Info-additional-directory-list nil
277
  "List of additional directories to search for Info documentation files.
278
These directories are searched after those in `Info-directory-list'."
279 280
  :type '(repeat directory)
  :group 'info)
281

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

285 286 287 288 289 290 291 292
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."
293
  :version "22.1"
294 295 296
  :type 'boolean
  :group 'info)

297
(defcustom Info-hide-note-references t
Lute Kamstra's avatar
Lute Kamstra committed
298
  "If non-nil, hide the tag and section reference in *note and * menu items.
Juri Linkov's avatar
Juri Linkov committed
299
If value is non-nil but not `hide', also replaces the \"*note\" with \"see\".
300
If value is non-nil but not t or `hide', the reference section is still shown.
301
nil completely disables this feature.  If this is non-nil, you might
302
want to set `Info-refill-paragraphs'."
303
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
304
  :type '(choice (const :tag "No hiding" nil)
305
		 (const :tag "Replace tag and hide reference" t)
Juri Linkov's avatar
Juri Linkov committed
306 307
		 (const :tag "Hide tag and reference" hide)
		 (other :tag "Only replace tag" tag))
308 309 310 311 312 313
  :set (lambda (sym val)
	 (set sym val)
	 (dolist (buffer (buffer-list))
	   (with-current-buffer buffer
	     (when (eq major-mode 'Info-mode)
	       (revert-buffer t t)))))
314 315
  :group 'info)

Kim F. Storm's avatar
Kim F. Storm committed
316
(defcustom Info-refill-paragraphs nil
Lute Kamstra's avatar
Lute Kamstra committed
317
  "If non-nil, attempt to refill paragraphs with hidden references.
318
This refilling may accidentally remove explicit line breaks in the Info
319 320
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."
321
  :version "22.1"
Kim F. Storm's avatar
Kim F. Storm committed
322 323 324
  :type 'boolean
  :group 'info)

325 326 327
(defcustom Info-breadcrumbs-depth 4
  "Depth of breadcrumbs to display.
0 means do not display breadcrumbs."
328 329 330
  :version "23.1"
  :type 'integer
  :group 'info)
331

332
(defcustom Info-search-whitespace-regexp "\\s-+"
Lute Kamstra's avatar
Lute Kamstra committed
333
  "If non-nil, regular expression to match a sequence of whitespace chars.
Juri Linkov's avatar
Juri Linkov committed
334 335 336 337 338 339 340
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)

341
(defcustom Info-isearch-search t
Lute Kamstra's avatar
Lute Kamstra committed
342
  "If non-nil, isearch in Info searches through multiple nodes.
343
Before leaving the initial Info node, where isearch was started,
344
it fails once with the error message [end of node], and with
345 346
subsequent C-s/C-r continues through other nodes without failing
with this error message in other nodes.  When isearch fails for
347 348 349
the rest of the manual, it displays the error message [end of manual],
wraps around the whole manual and restarts the search from the top/final
node depending on search direction.
350 351 352

Setting this option to nil restores the default isearch behavior
with wrapping around the current Info node."
353 354 355 356
  :version "22.1"
  :type 'boolean
  :group 'info)

357
(defvar Info-isearch-initial-node nil)
358 359
(defvar Info-isearch-initial-history nil)
(defvar Info-isearch-initial-history-list nil)
360

361 362 363 364
(defcustom Info-mode-hook
  ;; Try to obey obsolete Info-fontify settings.
  (unless (and (boundp 'Info-fontify) (null Info-fontify))
    '(turn-on-font-lock))
Eli Zaretskii's avatar
Eli Zaretskii committed
365
  "Hook run when activating Info Mode."
Juri Linkov's avatar
Juri Linkov committed
366 367 368 369
  :type 'hook
  :group 'info)

(defcustom Info-selection-hook nil
Eli Zaretskii's avatar
Eli Zaretskii committed
370
  "Hook run when an Info node is selected as the current node."
Colin Walters's avatar
Colin Walters committed
371 372 373
  :type 'hook
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
374
(defvar Info-edit-mode-hook nil
Eli Zaretskii's avatar
Eli Zaretskii committed
375
  "Hook run when `Info-edit-mode' is activated.")
Juri Linkov's avatar
Juri Linkov committed
376

Glenn Morris's avatar
Glenn Morris committed
377 378 379
(make-obsolete-variable 'Info-edit-mode-hook
			"editing Info nodes by hand is not recommended." "24.4")

380
(defvar-local Info-current-file nil
381 382
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
383
It doesn't contain directory names or file name extensions added by Info.")
Jim Blandy's avatar
Jim Blandy committed
384

385
(defvar-local Info-current-subfile nil
Dave Love's avatar
Dave Love committed
386
  "Info subfile that is actually in the *info* buffer now.
387
It is nil if current Info file is not split into subfiles.")
Jim Blandy's avatar
Jim Blandy committed
388

389
(defvar-local Info-current-node nil
Jim Blandy's avatar
Jim Blandy committed
390 391
  "Name of node that Info is now looking at, or nil.")

392
(defvar-local Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
393 394 395
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

396
(defvar-local Info-tag-table-buffer nil
397 398
  "Buffer used for indirect tag tables.")

399
(defvar-local Info-current-file-completions nil
400 401
  "Cached completion list for current Info file.")

402 403 404 405
(defvar Info-file-completions nil
  "Cached completion alist of visited Info files.
Each element of the alist is (FILE . COMPLETIONS)")

406
(defvar-local Info-file-supports-index-cookies nil
407 408
  "Non-nil if current Info file supports index cookies.")

409 410 411 412 413
(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.")

414
(defvar-local Info-index-alternatives nil
Dave Love's avatar
Dave Love committed
415
  "List of possible matches for last `Info-index' command.")
416

417 418 419 420 421
(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
422

423 424
(defvar Info-standalone nil
  "Non-nil if Emacs was started solely as an Info browser.")
Juri Linkov's avatar
Juri Linkov committed
425

426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
(defvar Info-file-attributes nil
  "Alist of file attributes of visited Info files.
Each element is a list (FILE-NAME FILE-ATTRIBUTES...).")

(defvar Info-toc-nodes nil
  "Alist of cached parent-children node information in visited Info files.
Each element is (FILE (NODE-NAME PARENT SECTION CHILDREN) ...)
where PARENT is the parent node extracted from the Up pointer,
SECTION is the section name in the Top node where this node is placed,
CHILDREN is a list of child nodes extracted from the node menu.")

(defvar Info-index-nodes nil
  "Alist of cached index node names of visited Info files.
Each element has the form (INFO-FILE INDEX-NODE-NAMES-LIST).")

Juri Linkov's avatar
Juri Linkov committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
(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
457 458
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
459

460
(defvar-local Info-current-node-virtual nil
Juri Linkov's avatar
Juri Linkov committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
  "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)))

487

488
(defvar Info-suffix-list
489 490
  ;; The MS-DOS list should work both when long file names are
  ;; supported (Windows 9X), and when only 8+3 file names are available.
491
  (if (eq system-type 'ms-dos)
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
      '( (".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)))
536 537
  "List of file name suffixes and associated decoding commands.
Each entry should be (SUFFIX . STRING); the file is given to
538 539 540 541 542 543
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.
544 545
Because the SUFFIXes are tried in order, the empty string should
be last in the list.")
546

547
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
548 549 550 551
;; 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
552 553
      (concat filename suffix)
    (let* ((sans-exts (file-name-sans-extension filename))
554 555 556
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
557
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
558
      ;; get rid of the one in SUFFIX (unless suffix is empty).
559
      (or (and (<= ext-len 0)
560
	       (not (eq (aref filename (1- (length filename))) ?.)))
561
	  (= (length suffix) 0)
562
	  (setq suffix (substring suffix 1)))
563 564
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
565 566 567 568 569
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

570 571 572 573
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

574
(defun info-insert-file-contents (filename &optional visit)
575
  "Insert the contents of an Info file in the current buffer.
576
Do the right thing if the file has been compressed or zipped."
577
  (let* ((tail Info-suffix-list)
578
	 (jka-compr-verbose nil)
579 580 581
	 (lfn (if (fboundp 'msdos-long-file-names)
		  (msdos-long-file-names)
		t))
582 583 584
	 (check-short (and (fboundp 'msdos-long-file-names)
			   lfn))
	 fullname decoder done)
585
    (if (info-file-exists-p filename)
586 587
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
588 589 590 591 592 593 594 595
	(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))))
596
      ;; Try adding suffixes to FILENAME and see if we can find something.
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
      (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))))))
613 614
	(setq tail (cdr tail)))
      (or tail
615
	  (error "Can't find %s or any compressed version of it" filename)))
616
    ;; check for conflict with jka-compr
617
    (if (and (jka-compr-installed-p)
618 619
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
620
    (if decoder
621 622
	(progn
	  (insert-file-contents-literally fullname visit)
623
	  (let ((inhibit-read-only t)
624
		(coding-system-for-write 'no-conversion)
Eli Zaretskii's avatar
Eli Zaretskii committed
625
		(inhibit-null-byte-detection t) ; Index nodes include null bytes
626 627
		(default-directory (or (file-name-directory fullname)
				       default-directory)))
628 629
	    (or (consp decoder)
		(setq decoder (list decoder)))
630
	    (apply #'call-process-region (point-min) (point-max)
631
		   (car decoder) t t nil (cdr decoder))))
Eli Zaretskii's avatar
Eli Zaretskii committed
632
      (let ((inhibit-null-byte-detection t)) ; Index nodes include null bytes
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
	(insert-file-contents fullname visit)))

    ;; Clear the caches of modified Info files.
    (let* ((attribs-old (cdr (assoc fullname Info-file-attributes)))
	   (modtime-old (and attribs-old (nth 5 attribs-old)))
	   (attribs-new (and (stringp fullname) (file-attributes fullname)))
	   (modtime-new (and attribs-new (nth 5 attribs-new))))
      (when (and modtime-old modtime-new
		 (> (float-time modtime-new) (float-time modtime-old)))
	(setq Info-index-nodes (remove (assoc (or Info-current-file filename)
					      Info-index-nodes)
				       Info-index-nodes))
	(setq Info-toc-nodes (remove (assoc (or Info-current-file filename)
					    Info-toc-nodes)
				     Info-toc-nodes)))
      ;; Add new modtime to `Info-file-attributes'.
      (setq Info-file-attributes
	    (cons (cons fullname attribs-new)
		  (remove (assoc fullname Info-file-attributes)
			  Info-file-attributes))))))
653 654 655 656

(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
657
makeinfo versions output them in index nodes, so we can rely
658 659 660 661 662 663
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
664
	       (Info-virtual-file-p file))
665 666 667 668 669 670 671 672
           (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]+\\)"
673
			(line-beginning-position 4) t)
674 675 676 677 678 679 680
		       (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)))

681

682 683 684 685 686 687
(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
688
				       "../share/info/"
689 690 691 692
				       invocation-directory)))
			 (if (file-exists-p infodir)
			     infodir
			   (setq infodir (expand-file-name
693
					  "../../../share/info/"
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
					  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
720 721 722
	    ;; Don't drop the last part, it might contain non-Emacs stuff.
	    ;; (reverse (cdr (reverse
	    Info-default-directory-list)))) ;; )))
723

724
(defun info-initialize ()
Dave Love's avatar
Dave Love committed
725
  "Initialize `Info-directory-list', if that hasn't been done yet."
726
  (unless Info-directory-list
Ralph Schleicher's avatar
Ralph Schleicher committed
727 728
    (let ((path (getenv "INFOPATH"))
	  (sep (regexp-quote path-separator)))
729
      (setq Info-directory-list
730 731
	    (prune-directory-list
	     (if path
Ralph Schleicher's avatar
Ralph Schleicher committed
732 733
		 (if (string-match-p (concat sep "\\'") path)
		     (append (split-string (substring path 0 -1) sep)
734
			     (Info-default-dirs))
Ralph Schleicher's avatar
Ralph Schleicher committed
735
		   (split-string path sep))
736 737 738 739 740 741 742 743 744 745 746 747 748
	       (Info-default-dirs))))
      ;; For a self-contained (ie relocatable) NS build, AFAICS we
      ;; always want the included info directory to be at the head of
      ;; the search path, unless it's already in INFOPATH somewhere.
      ;; It's at the head of Info-default-directory-list,
      ;; but there's no way to get it at the head of Info-directory-list
      ;; except by doing it here.
      (and path
	   (featurep 'ns)
	   (let ((dir (expand-file-name "../info" data-directory)))
	     (and (file-directory-p dir)
		  (not (member dir (split-string path ":" t)))
		  (push dir Info-directory-list)))))))
749

750
;;;###autoload
751
(defun info-other-window (&optional file-or-node buffer)
752
  "Like `info' but show the Info buffer in another window."
753 754 755 756 757 758 759
  (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))))
  (info-setup file-or-node
	      (switch-to-buffer-other-window (or buffer "*info*"))))
760

761
;;;###autoload (put 'info 'info-file (purecopy "emacs"))
Jim Blandy's avatar
Jim Blandy committed
762
;;;###autoload
763
(defun info (&optional file-or-node buffer)
Jim Blandy's avatar
Jim Blandy committed
764
  "Enter Info, the documentation browser.
765
Optional argument FILE-OR-NODE specifies the file to examine;
Jim Blandy's avatar
Jim Blandy committed
766
the default is the top-level directory of Info.
767
Called from a program, FILE-OR-NODE may specify an Info node of the form
768
\"(FILENAME)NODENAME\".
769 770 771 772
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
773

774 775
In interactive use, a non-numeric prefix argument directs
this command to read a file name from the minibuffer.
776

Eli Zaretskii's avatar
Eli Zaretskii committed
777
A numeric prefix argument of N selects an Info buffer named \"*info*<N>\".
Richard M. Stallman's avatar
Richard M. Stallman committed
778 779

The search path for Info files is in the variable `Info-directory-list'.
780
The top-level Info directory is made by combining all the files named `dir'
Juri Linkov's avatar
Juri Linkov committed
781 782 783
in all the directories in that path.

See a list of available Info commands in `Info-mode'."
784 785 786 787 788
  (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))))
789 790
  (info-setup file-or-node
	      (pop-to-buffer-same-window (or buffer "*info*"))))
791 792 793

(defun info-setup (file-or-node buffer)
  "Display Info node FILE-OR-NODE in BUFFER."
794
  (if (and buffer (not (derived-mode-p 'Info-mode)))
795
      (Info-mode))
796
  (if file-or-node
797 798 799 800
      ;; 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.
801
      (Info-goto-node
802 803 804
       (if (and (stringp file-or-node) (string-match "(.*)" file-or-node))
           file-or-node
         (concat "(" file-or-node ")")))
805 806 807 808
    (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
809

810 811
;;;###autoload
(defun info-emacs-manual ()
812
  "Display the Emacs manual in Info mode."
813 814 815
  (interactive)
  (info "emacs"))

816 817 818 819 820 821
;;;###autoload
(defun info-emacs-bug ()
  "Display the \"Reporting Bugs\" section of the Emacs manual in Info mode."
  (interactive)
  (info "(emacs)Bugs"))

822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
;;;###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)))
839

Stefan Monnier's avatar
Stefan Monnier committed
840
;; See if the accessible portion of the buffer begins with a node
841 842 843 844 845 846 847 848 849
;; 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
850
;; REGEXP, if the function succeeds, nil otherwise.
851
(defun Info-node-at-bob-matching (regexp)
852 853
  (and (bobp)				; are we at beginning of buffer?
       (looking-at "\^_")		; does it begin with node delimiter?
854 855 856
       (let (beg)
	 (forward-line 1)
	 (setq beg (point))
857
	 (forward-line 1)		; does the line after delimiter match REGEXP?
858 859
	 (re-search-backward regexp beg t))))

Juri Linkov's avatar
Juri Linkov committed
860
(defun Info-find-file (filename &optional noerror)
861
  "Return expanded FILENAME, or t if FILENAME is \"dir\".
Juri Linkov's avatar
Juri Linkov committed
862 863
Optional second argument NOERROR, if t, means if file is not found
just return nil (no error)."
Jim Blandy's avatar
Jim Blandy committed
864 865
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
Juri Linkov's avatar
Juri Linkov committed
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
  (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)))))
885 886 887 888 889
	;; 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
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
	;; 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)
921 922 923 924
	  ;; If there is no previous Info file, go to the directory.
	  (unless Info-current-file
	    (Info-directory))
	  (user-error "Info file %s does not exist" filename)))
Juri Linkov's avatar
Juri Linkov committed
925
      filename))))
Juri Linkov's avatar
Juri Linkov committed
926

927
(defun Info-find-node (filename nodename &optional no-going-back strict-case)
928
  "Go to an Info node specified as separate FILENAME and NODENAME.
Juri Linkov's avatar
Juri Linkov committed
929
NO-GOING-BACK is non-nil if recovering from an error in this function;
930 931 932 933 934
it says do not attempt further (recursive) error recovery.

This function first looks for a case-sensitive match for NODENAME;
if none is found it then tries a case-insensitive match (unless
STRICT-CASE is non-nil)."
Juri Linkov's avatar
Juri Linkov committed
935 936
  (info-initialize)
  (setq filename (Info-find-file filename))
937
  ;; Go into Info buffer.
938
  (or (derived-mode-p 'Info-mode) (switch-to-buffer "*info*"))
939 940 941
  ;; Record the node we are leaving, if we were in one.
  (and (not no-going-back)
       Info-current-file
942 943
       (push (list Info-current-file Info-current-node (point))
             Info-history))
944
  (Info-find-node-2 filename nodename no-going-back strict-case))
945

946
;;;###autoload
947
(defun Info-on-current-buffer (&optional nodename)
948 949 950
  "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'."
951 952 953
  (interactive
   (list (if current-prefix-arg
	     (completing-read "Node name: " (Info-build-node-completions)
954 955
			      nil t "Top"))))
  (unless nodename (setq nodename "Top"))
956
  (info-initialize)
957
  (Info-mode)
958 959 960 961
  (setq Info-current-file
        (or buffer-file-name
            ;; If called on a non-file buffer, make a fake file name.
            (concat default-directory (buffer-name))))
962 963
  (Info-find-node-2 nil nodename))

964
(defun Info-revert-find-node (filename nodename)
965
  "Go to an Info node FILENAME and NODENAME, re-reading disk contents.
966 967
When *info* is already displaying FILENAME and NODENAME, the window position
is preserved, if possible."
968
  (or (derived-mode-p 'Info-mode) (switch-to-buffer "*info*"))
969 970
  (let ((old-filename Info-current-file)
	(old-nodename Info-current-node)
971
	(window-selected (eq (selected-window) (get-buffer-window)))
972 973 974
	(pcolumn      (current-column))
	(pline        (count-lines (point-min) (line-beginning-position)))
	(wline        (count-lines (point-min) (window-start)))
975 976
	(new-history  (and Info-current-file
			   (list Info-current-file Info-current-node (point)))))
977 978
    ;; When `Info-current-file' is nil, `Info-find-node-2' rereads the file.
    (setq Info-current-file nil)
979 980 981 982 983
    (Info-find-node filename nodename)
    (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
984 985 986 987
	  (when window-selected
	    (goto-char (point-min))
	    (forward-line wline)
	    (set-window-start (selected-window) (point)))
988
	  (goto-char (point-min))
989 990 991 992 993 994
	  (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))))))

995
(defun Info-revert-buffer-function (_ignore-auto noconfirm)
996 997 998 999
  (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)))

1000 1001 1002 1003 1004 1005 1006
(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
1007
FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the file position
1008 1009
where the match was found, and MODE is `major-mode' of the buffer in
which the match was found."
1010
  (let ((case-fold-search case-fold))
1011
    (with-current-buffer (marker-buffer marker)
1012
      (goto-char marker)
1013

1014 1015 1016 1017
      ;; Search tag table
      (beginning-of-line)
      (when (re-search-forward regexp nil t)
	(list (string-equal "Ref:" (match-string 1))
1018
              (read (current-buffer))
1019 1020
	      major-mode)))))

1021
(defun Info-find-in-tag-table (marker regexp &optional strict-case)
1022 1023 1024 1025 1026
  "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
1027
FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the file position
1028 1029 1030
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
1031 1032
case-insensitive match is tried (unless optional argument STRICT-CASE
is non-nil)."
1033
  (let ((result (Info-find-in-tag-table-1 marker regexp nil)))
1034 1035
    (or strict-case (car result)
	(setq result (Info-find-in-tag-table-1 marker regexp t)))
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
    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
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
      (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))
1057

1058
(defun Info-find-node-in-buffer (regexp &optional strict-case)
1059 1060 1061 1062 1063
  "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,
1064 1065
a case-insensitive match is tried (unless optional argument STRICT-CASE
is non-nil)."
1066
  (or (Info-find-node-in-buffer-1 regexp nil)
1067 1068
      (and (not strict-case)
	   (Info-find-node-in-buffer-1 regexp t))))
1069

1070
(defun Info-find-node-2 (filename nodename &optional no-going-back strict-case)
1071
  (buffer-disable-undo (current-buffer))
1072
  (or (derived-mode-p 'Info-mode)
Jim Blandy's avatar
Jim Blandy committed
1073 1074 1075 1076
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
1077
      (let ((case-fold-search t)
Juri Linkov's avatar
Juri Linkov committed
1078 1079 1080
	    (virtual-fun (Info-virtual-fun 'find-node
					   (or filename Info-current-file)
					   nodename))
1081
	    anchorpos)
Juri Linkov's avatar
Juri Linkov committed
1082 1083 1084 1085
	(cond
	 ((functionp virtual-fun)
	  (let ((filename (or filename Info-current-file)))
	    (setq buffer-read-only nil)
1086 1087 1088 1089
	    (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
1090 1091 1092 1093 1094
	    (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)
1095
	    (setq Info-current-node-virtual t)))
Juri Linkov's avatar
Juri Linkov committed
1096 1097 1098 1099 1100 1101 1102
	 ((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))
1103 1104
	    (when Info-current-node-virtual
	      ;; When moving from a virtual node.
1105
	      (setq Info-current-node-virtual nil)
1106 1107
	      (if (null filename)
		  (setq filename Info-current-file)))
Juri Linkov's avatar
Juri Linkov committed
1108 1109 1110 1111 1112
	    (setq Info-current-file nil
		  Info-current-subfile nil
		  Info-current-file-completions nil
		  buffer-file-name nil)
	    (erase-buffer)
1113 1114 1115 1116
            ;; Erase any memory of the previous coding-system, so that
            ;; info-insert-file-contents sets the buffer's encoding to
            ;; what the Info file specifies.
            (set-buffer-file-coding-system 'undecided t)
Juri Linkov's avatar
Juri Linkov committed
1117 1118 1119
	    (info-insert-file-contents filename nil)
	    (setq default-directory (file-name-directory filename))
	    (set-buffer-modified-p nil)
1120
	    (setq Info-file-supports-index-cookies
Juri Linkov's avatar
Juri Linkov committed
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
		 (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)
	    )))

1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
        ;; 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.
1173
	  (let ((guesspos (point-min))
1174
		(regexp (concat "\\(Node:\\|Ref:\\) *\\("
1175
				(if (stringp nodename)
1176 1177
				    (regexp-quote nodename)
				  "")
1178
				"\\) *[,\t\n\177]")))
1179

1180
	    (catch 'foo
1181

1182
	      ;; First, search a tag table, if any
1183