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

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

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

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

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

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

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

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

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

;;; Code:

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

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


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

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

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

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

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

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

(defface info-menu-5
80 81
  '((((class color)) :foreground "red1")
    (t :underline t))
82
  "Face for every third `*' in an Info menu."
83 84 85
  :group 'info)

(defface info-xref
86 87
  '((((class color) (background light)) :foreground "blue" :underline t)
    (((class color) (background dark)) :foreground "cyan" :underline t)
88
    (t :underline t))
89 90 91
  "Face for Info cross-references."
  :group 'info)

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

(defcustom Info-fontify-visited-nodes t
  "*Non-nil means to fontify visited nodes in a different face."
101
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
102 103 104
  :type 'boolean
  :group 'info)

105
(defcustom Info-fontify-maximum-menu-size 100000
106
  "*Maximum size of menu to fontify if `font-lock-mode' is non-nil."
107 108
  :type 'integer
  :group 'info)
109

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

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

(defface info-header-node
122
  '((t :inherit info-node))
Miles Bader's avatar
Miles Bader committed
123 124 125
  "Face for Info nodes in a node header."
  :group 'info)

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

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

If you run the Emacs executable from the `src' directory in the Emacs
151 152 153 154
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
155

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

162
(defcustom Info-scroll-prefer-subnodes nil
163 164 165 166 167 168 169 170 171
  "*If non-nil, \\<Info-mode-map>\\[Info-scroll-up] in a menu visits subnodes.
If this is non-nil, and you scroll far enough in a node that its menu
appears on the screen, the next \\<Info-mode-map>\\[Info-scroll-up]
moves to a subnode indicated by the following menu item.  This means
that you visit a subnode before getting to the end of the menu.

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

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

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

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

204 205 206 207 208 209 210 211 212
(defcustom Info-isearch-search t
  "*If non-nil, isearch invoked in Info mode uses `Info-search' function.
This allows isearch to search through multiple nodes.
When isearch fails, it wraps and restarts the search from the
top/final node depending on search direction."
  :version "22.1"
  :type 'boolean
  :group 'info)

213 214
(defvar Info-isearch-initial-node nil)

215 216 217 218
(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
219 220 221 222 223 224
  "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
225 226 227
  :type 'hook
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
228 229 230
(defvar Info-edit-mode-hook nil
  "Hooks run when `Info-edit-mode' is called.")

Jim Blandy's avatar
Jim Blandy committed
231
(defvar Info-current-file nil
232 233
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
234 235
It doesn't contain directory names or file name extensions added by Info.
Can also be t when using `Info-on-current-buffer'.")
Jim Blandy's avatar
Jim Blandy committed
236 237

(defvar Info-current-subfile nil
Dave Love's avatar
Dave Love committed
238 239
  "Info subfile that is actually in the *info* buffer now.
nil if current info file is not split into subfiles.")
Jim Blandy's avatar
Jim Blandy committed
240 241 242 243

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

244
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
245 246 247
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

248 249 250
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

251 252 253
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

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

257 258 259 260 261
(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
262

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

321
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
322 323 324 325
;; 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
326 327
      (concat filename suffix)
    (let* ((sans-exts (file-name-sans-extension filename))
328 329 330
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
331
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
332
      ;; get rid of the one in SUFFIX (unless suffix is empty).
333
      (or (and (<= ext-len 0)
334
	       (not (eq (aref filename (1- (length filename))) ?.)))
335
	  (= (length suffix) 0)
336
	  (setq suffix (substring suffix 1)))
337 338
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
339 340 341 342 343
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

344 345 346 347
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

348 349 350
(defun info-insert-file-contents (filename &optional visit)
  "Insert the contents of an info file in the current buffer.
Do the right thing if the file has been compressed or zipped."
351
  (let* ((tail Info-suffix-list)
352 353 354
	 (lfn (if (fboundp 'msdos-long-file-names)
		  (msdos-long-file-names)
		t))
355 356 357
	 (check-short (and (fboundp 'msdos-long-file-names)
			   lfn))
	 fullname decoder done)
358
    (if (info-file-exists-p filename)
359 360
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
361 362 363 364 365 366 367 368
	(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))))
369
      ;; Try adding suffixes to FILENAME and see if we can find something.
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
      (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))))))
386 387
	(setq tail (cdr tail)))
      (or tail
388
	  (error "Can't find %s or any compressed version of it" filename)))
389 390 391 392 393
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
394
    (if decoder
395 396 397 398 399 400
	(progn
	  (insert-file-contents-literally fullname visit)
	  (let ((buffer-read-only nil)
		(coding-system-for-write 'no-conversion)
		(default-directory (or (file-name-directory fullname)
				       default-directory)))
401 402 403 404
	    (or (consp decoder)
		(setq decoder (list decoder)))
	    (apply 'call-process-region (point-min) (point-max)
		   (car decoder) t t nil (cdr decoder))))
405
      (insert-file-contents fullname visit))))
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 434 435 436 437 438 439 440 441 442 443 444
(defun Info-default-dirs ()
  (let ((source (expand-file-name "info/" source-directory))
	(sibling (if installation-directory
		     (expand-file-name "info/" installation-directory)
		   (if invocation-directory
		       (let ((infodir (expand-file-name
				       "../info/"
				       invocation-directory)))
			 (if (file-exists-p infodir)
			     infodir
			   (setq infodir (expand-file-name
					  "../../../info/"
					  invocation-directory))
			   (and (file-exists-p infodir)
				infodir))))))
	alternative)
    (setq alternative
	  (if (and sibling (file-exists-p sibling))
	      ;; Uninstalled, Emacs builddir != srcdir.
	      sibling
	    ;; Uninstalled, builddir == srcdir
	    source))
    (if (or (member alternative Info-default-directory-list)
	    ;; On DOS/NT, we use movable executables always,
	    ;; and we must always find the Info dir at run time.
	    (if (memq system-type '(ms-dos windows-nt))
		nil
	      ;; Use invocation-directory for Info
	      ;; only if we used it for exec-directory also.
	      (not (string= exec-directory
			    (expand-file-name "lib-src/"
					      installation-directory))))
	    (not (file-exists-p alternative)))
	Info-default-directory-list
      ;; `alternative' contains the Info files that came with this
      ;; version, so we should look there first.  `Info-insert-dir'
      ;; currently expects to find `alternative' first on the list.
      (cons alternative
445 446 447
	    ;; Don't drop the last part, it might contain non-Emacs stuff.
	    ;; (reverse (cdr (reverse
	    Info-default-directory-list)))) ;; )))
448

449
(defun info-initialize ()
Dave Love's avatar
Dave Love committed
450
  "Initialize `Info-directory-list', if that hasn't been done yet."
451
  (unless Info-directory-list
452
    (let ((path (getenv "INFOPATH")))
453
      (setq Info-directory-list
454 455
	    (prune-directory-list
	     (if path
456 457 458 459 460 461
		 (if (string-match ":\\'" path)
		     (append (split-string (substring path 0 -1)
					   (regexp-quote path-separator))
			     (Info-default-dirs))
		   (split-string path (regexp-quote path-separator)))
	       (Info-default-dirs)))))))
462

463 464 465 466 467
;;;###autoload
(defun info-other-window (&optional file)
  "Like `info' but show the Info buffer in another window."
  (interactive (if current-prefix-arg
		   (list (read-file-name "Info file name: " nil nil t))))
468
  (let (same-window-buffer-names same-window-regexps)
469
    (info file)))
470

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

473
;;;###autoload (put 'info 'info-file "emacs")
Jim Blandy's avatar
Jim Blandy committed
474
;;;###autoload
475
(defun info (&optional file buffer)
Jim Blandy's avatar
Jim Blandy committed
476 477 478
  "Enter Info, the documentation browser.
Optional argument FILE specifies the file to examine;
the default is the top-level directory of Info.
Dave Love's avatar
Dave Love committed
479 480
Called from a program, FILE may specify an Info node of the form
`(FILENAME)NODENAME'.
481 482 483 484
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
485

486 487
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
488 489
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
490 491

The search path for Info files is in the variable `Info-directory-list'.
492
The top-level Info directory is made by combining all the files named `dir'
Richard M. Stallman's avatar
Richard M. Stallman committed
493
in all the directories in that path."
494 495 496 497 498 499 500 501
  (interactive (list
                (if (and current-prefix-arg (not (numberp current-prefix-arg)))
                    (read-file-name "Info file name: " nil nil t))
                (if (numberp current-prefix-arg)
                    (format "*info*<%s>" current-prefix-arg))))
  (pop-to-buffer (or buffer "*info*"))
  (if (and buffer (not (eq major-mode 'Info-mode)))
      (Info-mode))
Jim Blandy's avatar
Jim Blandy committed
502
  (if file
503 504 505 506 507 508 509 510
      ;; If argument already contains parentheses, don't add another set
      ;; since the argument will then be parsed improperly.  This also
      ;; has the added benefit of allowing node names to be included
      ;; following the parenthesized filename.
      (if (and (stringp file) (string-match "(.*)" file))
	  (Info-goto-node file)
	(Info-goto-node (concat "(" file ")")))
    (if (zerop (buffer-size))
Juri Linkov's avatar
Juri Linkov committed
511
        (Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
512

513 514
;;;###autoload
(defun info-emacs-manual ()
515
  "Display the Emacs manual in Info mode."
516 517 518
  (interactive)
  (info "emacs"))

519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
;;;###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)))
536

Stefan Monnier's avatar
Stefan Monnier committed
537
;; See if the accessible portion of the buffer begins with a node
538 539 540 541 542 543 544 545 546
;; 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
547
;; REGEXP, if the function succeeds, nil otherwise.
548
(defun Info-node-at-bob-matching (regexp)
549 550
  (and (bobp)				; are we at beginning of buffer?
       (looking-at "\^_")		; does it begin with node delimiter?
551 552 553
       (let (beg)
	 (forward-line 1)
	 (setq beg (point))
554
	 (forward-line 1)		; does the line after delimiter match REGEXP?
555 556
	 (re-search-backward regexp beg t))))

Juri Linkov's avatar
Juri Linkov committed
557 558 559 560
(defun Info-find-file (filename &optional noerror)
  "Return expanded FILENAME, or t, if FILENAME is \"dir\".
Optional second argument NOERROR, if t, means if file is not found
just return nil (no error)."
Jim Blandy's avatar
Jim Blandy committed
561 562
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
563
  (if (stringp filename)
Jim Blandy's avatar
Jim Blandy committed
564
      (let (temp temp-downcase found)
565
        (setq filename (substitute-in-file-name filename))
Juri Linkov's avatar
Juri Linkov committed
566
	(cond
Jesper Harder's avatar
Jesper Harder committed
567 568 569 570
	 ((string= (downcase filename) "dir")
	  (setq found t))
	 ((string= filename "apropos")
	  (setq found 'apropos))
Juri Linkov's avatar
Juri Linkov committed
571 572 573 574
	 ((string= filename "history")
	  (setq found 'history))
	 ((string= filename "toc")
	  (setq found 'toc))
Jesper Harder's avatar
Jesper Harder committed
575 576
	 (t
	  (let ((dirs (if (string-match "^\\./" filename)
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
                          ;; If specified name starts with `./'
                          ;; then just try current directory.
                          '("./")
                        (if (file-name-absolute-p filename)
                            ;; No point in searching for an
                            ;; absolute file name
                            '(nil)
                          (if Info-additional-directory-list
                              (append Info-directory-list
                                      Info-additional-directory-list)
                            Info-directory-list)))))
            ;; Search the directory list for file FILENAME.
            (while (and dirs (not found))
              (setq temp (expand-file-name filename (car dirs)))
              (setq temp-downcase
                    (expand-file-name (downcase filename) (car dirs)))
              ;; Try several variants of specified name.
594
              (let ((suffix-list Info-suffix-list)
595 596 597
		    (lfn (if (fboundp 'msdos-long-file-names)
			     (msdos-long-file-names)
			   t)))
598 599 600
                (while (and suffix-list (not found))
                  (cond ((info-file-exists-p
                          (info-insert-file-contents-1
601
                           temp (car (car suffix-list)) lfn))
602 603 604
                         (setq found temp))
                        ((info-file-exists-p
                          (info-insert-file-contents-1
605 606 607 608 609 610 611 612
                           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)))
613
                  (setq suffix-list (cdr suffix-list))))
Jesper Harder's avatar
Jesper Harder committed
614
              (setq dirs (cdr dirs))))))
615 616
        (if found
            (setq filename found)
Juri Linkov's avatar
Juri Linkov committed
617 618 619 620 621 622 623 624 625 626 627
          (if noerror
              (setq filename nil)
            (error "Info file %s does not exist" filename)))
        filename)))

(defun Info-find-node (filename nodename &optional no-going-back)
  "Go to an info node specified as separate FILENAME and NODENAME.
NO-GOING-BACK is non-nil if recovering from an error in this function;
it says do not attempt further (recursive) error recovery."
  (info-initialize)
  (setq filename (Info-find-file filename))
628 629 630 631 632
  ;; Record the node we are leaving.
  (if (and Info-current-file (not no-going-back))
      (setq Info-history
            (cons (list Info-current-file Info-current-node (point))
                  Info-history)))
Jim Blandy's avatar
Jim Blandy committed
633
  ;; Go into info buffer.
634
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
635 636 637 638 639
  (Info-find-node-2 filename nodename no-going-back))

(defun Info-on-current-buffer (&optional nodename)
  "Use the `Info-mode' to browse the current info buffer.
If a prefix arg is provided, it queries for the NODENAME which
640
else defaults to \"Top\"."
641 642 643
  (interactive
   (list (if current-prefix-arg
	     (completing-read "Node name: " (Info-build-node-completions)
644 645
			      nil t "Top"))))
  (unless nodename (setq nodename "Top"))
646
  (info-initialize)
647 648 649 650
  (Info-mode)
  (set (make-local-variable 'Info-current-file) t)
  (Info-find-node-2 nil nodename))

651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
;; but at least it keeps this routine (which is only for the benefit of
;; makeinfo-buffer) out of the way of normal operations.
;;
(defun Info-revert-find-node (filename nodename)
  "Go to an info node FILENAME and NODENAME, re-reading disk contents.
When *info* is already displaying FILENAME and NODENAME, the window position
is preserved, if possible."
  (pop-to-buffer "*info*")
  (let ((old-filename Info-current-file)
	(old-nodename Info-current-node)
	(pcolumn      (current-column))
	(pline        (count-lines (point-min) (line-beginning-position)))
	(wline        (count-lines (point-min) (window-start)))
	(old-history  Info-history)
	(new-history (and Info-current-file
			  (list Info-current-file Info-current-node (point)))))
    (kill-buffer (current-buffer))
    (Info-find-node filename nodename)
    (setq Info-history old-history)
    (if (and (equal old-filename Info-current-file)
	     (equal old-nodename Info-current-node))
	(progn
	  ;; note goto-line is no good, we want to measure from point-min
675
	  (goto-char (point-min))
676 677
	  (forward-line wline)
	  (set-window-start (selected-window) (point))
678
	  (goto-char (point-min))
679 680 681 682 683 684
	  (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))))))

685 686 687 688 689 690 691 692 693 694
(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."
695
  (let ((case-fold-search case-fold))
696 697 698
    (save-excursion
      (set-buffer (marker-buffer marker))
      (goto-char marker)
699

700 701 702 703
      ;; Search tag table
      (beginning-of-line)
      (when (re-search-forward regexp nil t)
	(list (string-equal "Ref:" (match-string 1))
704
	      (+ (point-min) (read (current-buffer)))
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
	      major-mode)))))

(defun Info-find-in-tag-table (marker regexp)
  "Find a node in a tag table.
MARKER specifies the buffer and position to start searching at.
REGEXP is a regular expression matching nodes or references.  Its first
group should match `Node:' or `Ref:'.
If a match was found, value is a list (FOUND-ANCHOR POS MODE), where
FOUND-ANCHOR is non-nil if a `Ref:' was matched, POS is the position
where the match was found, and MODE is `major-mode' of the buffer in
which the match was found.
This function tries to find a case-sensitive match first, then a
case-insensitive match is tried."
  (let ((result (Info-find-in-tag-table-1 marker regexp nil)))
    (when (null (car result))
      (setq result (Info-find-in-tag-table-1 marker regexp t)))
    result))

(defun Info-find-node-in-buffer-1 (regexp case-fold)
  "Find a node or anchor in the current buffer.
REGEXP is a regular expression matching nodes or references.  Its first
group should match `Node:' or `Ref:'.
CASE-FOLD t means search for a case-insensitive match.
Value is the position at which a match was found, or nil if not found."
  (let ((case-fold-search case-fold)
	found)
    (save-excursion
      (when (Info-node-at-bob-matching regexp)
	(setq found (point)))
      (while (and (not found)
		  (search-forward "\n\^_" nil t))
	(forward-line 1)
	(let ((beg (point)))
	  (forward-line 1)
	  (when (re-search-backward regexp beg t)
	    (beginning-of-line)
	    (setq found (point)))))
      found)))
743

744 745 746 747 748 749 750 751 752
(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)))
753

754
(defun Info-find-node-2 (filename nodename &optional no-going-back)
755
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
756 757 758 759 760
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
761 762
      (let ((case-fold-search t)
	    anchorpos)
763 764 765 766 767 768 769 770 771
        ;; Switch files if necessary
        (or (null filename)
            (equal Info-current-file filename)
            (let ((buffer-read-only nil))
              (setq Info-current-file nil
                    Info-current-subfile nil
                    Info-current-file-completions nil
                    buffer-file-name nil)
              (erase-buffer)
Jesper Harder's avatar
Jesper Harder committed
772 773 774 775 776
	      (cond
	       ((eq filename t)
		(Info-insert-dir))
	       ((eq filename 'apropos)
		(insert-buffer-substring " *info-apropos*"))
Juri Linkov's avatar
Juri Linkov committed
777 778 779 780
	       ((eq filename 'history)
		(insert-buffer-substring " *info-history*"))
	       ((eq filename 'toc)
		(insert-buffer-substring " *info-toc*"))
Jesper Harder's avatar
Jesper Harder committed
781
	       (t
782
                (info-insert-file-contents filename nil)
Jesper Harder's avatar
Jesper Harder committed
783
                (setq default-directory (file-name-directory filename))))
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
              (set-buffer-modified-p nil)
              ;; See whether file has a tag table.  Record the location if yes.
              (goto-char (point-max))
              (forward-line -8)
              ;; Use string-equal, not equal, to ignore text props.
              (if (not (or (string-equal nodename "*")
                           (not
                            (search-forward "\^_\nEnd tag table\n" nil t))))
                  (let (pos)
                    ;; We have a tag table.  Find its beginning.
                    ;; Is this an indirect file?
                    (search-backward "\nTag table:\n")
                    (setq pos (point))
                    (if (save-excursion
                          (forward-line 2)
                          (looking-at "(Indirect)\n"))
                        ;; It is indirect.  Copy it to another buffer
                        ;; and record that the tag table is in that buffer.
                        (let ((buf (current-buffer))
                              (tagbuf
                               (or Info-tag-table-buffer
                                   (generate-new-buffer " *info tag table*"))))
                          (setq Info-tag-table-buffer tagbuf)
                          (save-excursion
                            (set-buffer tagbuf)
809
                            (buffer-disable-undo (current-buffer))
810 811 812 813 814 815 816 817
                            (setq case-fold-search t)
                            (erase-buffer)
                            (insert-buffer-substring buf))
                          (set-marker Info-tag-table-marker
                                      (match-end 0) tagbuf))
                      (set-marker Info-tag-table-marker pos)))
                (set-marker Info-tag-table-marker nil))
              (setq Info-current-file
Jesper Harder's avatar
Jesper Harder committed
818 819 820
		    (cond
		     ((eq filename t) "dir")
		     ((eq filename 'apropos) "apropos")
Juri Linkov's avatar
Juri Linkov committed
821 822
		     ((eq filename 'history) "history")
		     ((eq filename 'toc) "toc")
Jesper Harder's avatar
Jesper Harder committed
823 824
		     (t filename)))
	      ))
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
        ;; 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.
841
	  (let ((guesspos (point-min))
842
		(regexp (concat "\\(Node:\\|Ref:\\) *\\("
843
				(if (stringp nodename)
844 845
				    (regexp-quote nodename)
				  "")
846
				"\\) *[,\t\n\177]")))
847

848
	    (catch 'foo
849

850
	      ;; First, search a tag table, if any
851 852 853
	      (when (marker-position Info-tag-table-marker)
		(let* ((m Info-tag-table-marker)
		       (found (Info-find-in-tag-table m regexp)))
854

855 856 857
		  (when found
		    ;; FOUND is (ANCHOR POS MODE).
		    (setq guesspos (nth 1 found))
858

859 860 861 862 863 864 865
		    ;; 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)))
866 867

		    ;; Handle anchor
868 869 870
		    (when (nth 0 found)
		      (goto-char (setq anchorpos guesspos))
		      (throw 'foo t)))))
871 872 873 874

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

876 877 878 879 880 881 882
	      ;; Now search from our advised position (or from beg of
	      ;; buffer) to find the actual node.  First, check
	      ;; whether the node is right where we are, in case the
	      ;; buffer begins with a node.
	      (let ((pos (Info-find-node-in-buffer regexp)))
		(when pos
		  (goto-char pos)
883 884 885 886 887 888 889 890 891 892 893
		  (throw 'foo t)))

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

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

	    (Info-select-node)
Juri Linkov's avatar
Juri Linkov committed
896 897 898 899 900 901 902 903 904
	    (goto-char (point-min))
	    (cond (anchorpos
                   (let ((new-history (list Info-current-file
                                            (substring-no-properties nodename))))
                     ;; Add anchors to the history too
                     (setq Info-history-list
                           (cons new-history
                                 (delete new-history Info-history-list))))
                   (goto-char anchorpos))
905 906 907 908 909 910
                  ((numberp Info-point-loc)
                   (forward-line (1- Info-point-loc))
                   (setq Info-point-loc nil))
		  ((stringp Info-point-loc)
		   (Info-find-index-name Info-point-loc)
		   (setq Info-point-loc nil))))))
Jim Blandy's avatar
Jim Blandy committed
911 912
    ;; If we did not finish finding the specified node,
    ;; go back to the previous one.
913
    (or Info-current-node no-going-back (null Info-history)
914 915 916 917
        (let ((hist (car Info-history)))
          (setq Info-history (cdr Info-history))
          (Info-find-node (nth 0 hist) (nth 1 hist) t)
          (goto-char (nth 2 hist))))))
Jim Blandy's avatar
Jim Blandy committed
918

919 920
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
921 922
(defvar Info-dir-contents nil)

923 924 925 926
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

927 928 929 930
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

931 932
(defvar Info-dir-file-name nil)

933
;; Construct the Info directory node by merging the files named `dir'
934 935 936
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
937
(defun Info-insert-dir ()
938 939 940 941
  (if (and Info-dir-contents Info-dir-file-attributes
	   ;; Verify that none of the files we used has changed
	   ;; since we used it.
	   (eval (cons 'and
942 943 944 945 946 947 948 949 950
		       (mapcar (lambda (elt)
				 (let ((curr (file-attributes
					      ;; Handle symlinks
					      (file-truename (car elt)))))

				   ;; Don't compare the access time.
				   (if curr (setcar (nthcdr 4 curr) 0))
				   (setcar (nthcdr 4 (cdr elt)) 0)
				   (equal (cdr elt) curr)))
951
			       Info-dir-file-attributes))))
952 953 954
      (progn
	(insert Info-dir-contents)
	(goto-char (point-min)))
955
    (let ((dirs (if Info-additional-directory-list
Richard M. Stallman's avatar
Richard M. Stallman committed
956 957 958
		    (append Info-directory-list
			    Info-additional-directory-list)
		  Info-directory-list))
959
	  (dir-file-attrs nil)
960 961
	  ;; Bind this in case the user sets it to nil.
	  (case-fold-search t)
962 963
	  ;; This is set non-nil if we find a problem in some input files.
	  problems
964
	  buffers buffer others nodes dirs-done)
965 966

      ;; Search the directory list for the directory file.
967
      (while dirs
968 969 970 971 972
	(let ((truename (file-truename (expand-file-name (car dirs)))))
	  (or (member truename dirs-done)
	      (member (directory-file-name truename) dirs-done)
	      ;; Try several variants of specified name.
	      ;; Try upcasing, appending `.info', or both.
973 974 975 976 977 978 979 980 981 982 983
	      (let* (file
		     (attrs
		      (or
		       (progn (setq file (expand-file-name "dir" truename))
			      (file-attributes file))
		       (progn (setq file (expand-file-name "DIR" truename))
			      (file-attributes file))
		       (progn (setq file (expand-file-name "dir.info" truename))
			      (file-attributes file))
		       (progn (setq file (expand-file-name "DIR.INFO" truename))
			      (file-attributes file)))))
984 985 986 987
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
988 989 990 991
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
992
		      (set-buffer (generate-new-buffer " info dir"))
993 994 995
		      (condition-case nil
			  (progn
			    (insert-file-contents file)
996 997
			    (set (make-local-variable 'Info-dir-file-name)
				 file)
998
			    (push (current-buffer) buffers)
999
			    (push (cons file attrs) dir-file-attrs))
1000
			(error (kill-buffer (current-buffer))))))))
1001 1002 1003
	  (unless (cdr dirs)
	    (set (make-local-variable 'Info-dir-contents-directory)
		 (file-name-as-directory (car dirs))))
1004
	  (setq dirs (cdr dirs))))
1005

1006
      (or buffers
1007
	  (error "Can't find the Info directory node"))
1008

1009
      ;; Distinguish the dir file that comes with Emacs from all the
1010
      ;; others.  Yes, that is really what this is supposed to do.
1011 1012 1013 1014
      ;; The definition of `Info-directory-list' puts it first on that
      ;; list and so last in `buffers' at this point.
      (setq buffer (car (last buffers))
	    others (delq buffer buffers))
1015

1016 1017 1018
      ;; Insert the entire original dir file as a start; note that we've
      ;; already saved its default directory to use as the default
      ;; directory for the whole concatenation.
1019
      (insert-buffer buffer)
1020

1021
      ;; Look at each of the other buffers one by one.
1022 1023
      (dolist (other others)
	(let (this-buffer-nodes)
1024
	  ;; In each, find all the menus.
1025
	  (with-current-buffer other
1026 1027 1028
	    (goto-char (point-min))
	    ;; Find each menu, and add an elt to NODES for it.
	    (while (re-search-forward "^\\* Menu:" nil t)
1029 1030 1031 1032
	      (while (and (zerop (forward-line 1)) (eolp)))
	      (let ((beg (point))
		    nodename end)
		(re-search-backward "^\^_")
1033
		(search-forward "Node: ")
Juri Linkov's avatar
Juri Linkov committed
1034
		(setq nodename (Info-following-node-name))
1035
		(search-forward "\n\^_" nil 'move)
1036 1037
		(beginning-of-line)
		(setq end (point))
1038
		(push (list nodename other beg end) this-buffer-nodes)))
1039
	    (if (assoc-string "top" this-buffer-nodes t)
1040 1041
		(setq nodes (nconc this-buffer-nodes nodes))
	      (setq problems t)
1042
	      (message "No `top' node in %s" Info-dir-file-name)))))
Dave Love's avatar
Dave Love committed
1043
      ;; Add to the main menu a menu item for each other node.
1044
      (re-search-forward "^\\* Menu:")
1045 1046
      (forward-line 1)
      (let ((menu-items '("top"))
1047
	    (end (save-excursion (search-forward "\^_" nil t) (point))))
1048 1049
	(dolist (node nodes)
	  (let ((nodename (car node)))
1050 1051
	    (save-excursion
	      (or (member (downcase nodename) menu-items)
1052
		  (re-search-forward (concat "^\\* +"
1053 1054 1055 1056 1057
					     (regexp-quote nodename)
					     "::")
				     end t)
		  (progn
		    (insert "* " nodename "::" "\n")
1058
		    (push nodename menu-items)))))))
1059 1060
      ;; Now take each node of each of the other buffers
      ;; and merge it into the main buffer.
1061
      (dolist (node nodes)
1062
	(let ((case-fold-search t)
1063
	      (nodename (car node)))
1064 1065
	  (goto-char (point-min))
	  ;; Find the like-named node in the main buffer.
1066
	  (if (re-search-forward (concat "^\^_.*\n.*Node: "
1067 1068 1069 1070
					 (regexp-quote nodename)
					 "[,\n\t]")
				 nil t)
	      (progn
1071
		(search-forward "\n\^_" nil 'move)
1072 1073
		(beginning-of-line)
		(insert "\n"))
1074 1075
	    ;; If none exists, add one.
	    (goto-char (point-max))
1076
	    (insert "\^_\nFile: dir\tNode: " nodename "\n\n* Menu:\n\n"))
1077 1078
	  ;; Merge the text from the other buffer's menu
	  ;; into the menu in the like-named node in the main buffer.
1079 1080
	  (apply 'insert-buffer-substring (cdr node))))
      (Info-dir-remove-duplicates)
1081 1082
      ;; Kill all the buffers we just made, including the special one excised.
      (mapc 'kill-buffer (cons buffer buffers))
1083 1084 1085
      (goto-char (point-min))
      (if problems
	  (message "Composing main Info directory...problems encountered, see `*Messages*'")
1086 1087 1088
	(message "Composing main Info directory...done"))
      (set (make-local-variable 'Info-dir-contents) (buffer-string))
      (set (make-local-variable 'Info-dir-file-attributes) dir-file-attrs)))
1089
  (setq default-directory Info-dir-contents-directory))
1090

1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
(defvar Info-streamline-headings
  '(("Emacs" . "Emacs")
    ("Programming" . "Programming")
    ("Libraries" . "Libraries")
    ("World Wide Web\\|Net Utilities" . "Net Utilities"))
  "List of elements (RE . NAME) to merge headings matching RE to NAME.")

(defun Info-dir-remove-duplicates ()
  (let (limit)
    (goto-char (point-min))
    ;; Remove duplicate headings in the same menu.
    (while (search-forward "\n* Menu:" nil t)
1103
      (setq limit (save-excursion (search-forward "\n\^_" nil t)))
1104 1105 1106 1107