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

3
;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4
;;   2000, 2001, 2002, 2003, 2004, 2005 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, 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
(defgroup info nil
41
  "Info subsystem."
42 43 44 45
  :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.
48
Each element of the stack is a list (FILENAME NODENAME BUFFERPOS).")
Jim Blandy's avatar
Jim Blandy committed
49

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

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

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
  '((((min-colors 88)
87 88
      (class color) (background light)) :foreground "blue1" :underline t)
    (((class color) (background light)) :foreground "blue" :underline t)
89
    (((min-colors 88)
90
      (class color) (background dark)) :foreground "cyan1" :underline t)
91
    (((class color) (background dark)) :foreground "cyan" :underline t)
92
    (t :underline t))
93 94 95
  "Face for Info cross-references."
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
96
(defface info-xref-visited
97
  '((default :inherit info-xref)
98
    (((class color) (background light)) :foreground "magenta4")
99
    (((class color) (background dark)) :foreground "violet"))
Juri Linkov's avatar
Juri Linkov committed
100 101 102 103 104
  "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."
105
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
106 107 108
  :type 'boolean
  :group 'info)

109
(defcustom Info-fontify-maximum-menu-size 100000
110
  "*Maximum size of menu to fontify if `font-lock-mode' is non-nil."
111 112
  :type 'integer
  :group 'info)
113

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

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

(defface info-header-node
126
  '((t :inherit info-node))
Miles Bader's avatar
Miles Bader committed
127 128 129
  "Face for Info nodes in a node header."
  :group 'info)

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

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

If you run the Emacs executable from the `src' directory in the Emacs
155 156 157 158
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
159

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

166
(defcustom Info-scroll-prefer-subnodes nil
167 168 169 170 171 172 173 174 175
  "*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."
176
  :version "22.1"
177 178 179
  :type 'boolean
  :group 'info)

180
(defcustom Info-hide-note-references t
181
  "*If non-nil, hide the tag and section reference in *note and * menu items.
Juri Linkov's avatar
Juri Linkov committed
182 183
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."
184
  :version "22.1"
Juri Linkov's avatar
Juri Linkov committed
185
  :type '(choice (const :tag "No hiding" nil)
186
		 (const :tag "Replace tag and hide reference" t)
Juri Linkov's avatar
Juri Linkov committed
187 188
		 (const :tag "Hide tag and reference" hide)
		 (other :tag "Only replace tag" tag))
189 190
  :group 'info)

Kim F. Storm's avatar
Kim F. Storm committed
191 192 193 194
(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."
195
  :version "22.1"
Kim F. Storm's avatar
Kim F. Storm committed
196 197 198
  :type 'boolean
  :group 'info)

199
(defcustom Info-search-whitespace-regexp "\\s-+"
Juri Linkov's avatar
Juri Linkov committed
200 201 202 203 204 205 206 207
  "*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)

208
(defcustom Info-isearch-search t
209 210 211 212 213 214 215 216 217 218 219
  "*If non-nil, isearch in Info searches through multiple nodes.
Before leaving the initial Info node, where isearch was started,
it fails once with the error message [initial node], and with
subsequent C-s/C-r continues through other nodes without failing
with this error message in other nodes.  When isearch fails for
the rest of the manual, it wraps aroung the whole manual and
restarts the search from the top/final node depending on
search direction.

Setting this option to nil restores the default isearch behavior
with wrapping around the current Info node."
220 221 222 223
  :version "22.1"
  :type 'boolean
  :group 'info)

224 225
(defvar Info-isearch-initial-node nil)

226 227 228 229
(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
230 231 232 233 234 235
  "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
236 237 238
  :type 'hook
  :group 'info)

Juri Linkov's avatar
Juri Linkov committed
239 240 241
(defvar Info-edit-mode-hook nil
  "Hooks run when `Info-edit-mode' is called.")

Jim Blandy's avatar
Jim Blandy committed
242
(defvar Info-current-file nil
243 244
  "Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
245 246
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
247 248

(defvar Info-current-subfile nil
Dave Love's avatar
Dave Love committed
249 250
  "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
251 252 253 254

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

255
(defvar Info-tag-table-marker nil
Jim Blandy's avatar
Jim Blandy committed
256 257 258
  "Marker pointing at beginning of current Info file's tag table.
Marker points nowhere if file has no tag table.")

259 260 261
(defvar Info-tag-table-buffer nil
  "Buffer used for indirect tag tables.")

262 263 264
(defvar Info-current-file-completions nil
  "Cached completion list for current Info file.")

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

268 269 270 271 272
(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
273

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

332
;; Concatenate SUFFIX onto FILENAME.  SUFFIX should start with a dot.
333 334 335 336
;; 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
337 338
      (concat filename suffix)
    (let* ((sans-exts (file-name-sans-extension filename))
339 340 341
	   ;; How long is the extension in FILENAME (not counting the dot).
	   (ext-len (max 0 (- (length filename) (length sans-exts) 1)))
	   ext-left)
342
      ;; SUFFIX starts with a dot.  If FILENAME already has one,
343
      ;; get rid of the one in SUFFIX (unless suffix is empty).
344
      (or (and (<= ext-len 0)
345
	       (not (eq (aref filename (1- (length filename))) ?.)))
346
	  (= (length suffix) 0)
347
	  (setq suffix (substring suffix 1)))
348 349
      ;; How many chars of that extension should we keep?
      (setq ext-left (min ext-len (max 0 (- 3 (length suffix)))))
350 351 352 353 354
      ;; Get rid of the rest of the extension, and add SUFFIX.
      (concat (substring filename 0 (- (length filename)
				       (- ext-len ext-left)))
	      suffix))))

355 356 357 358
(defun info-file-exists-p (filename)
  (and (file-exists-p filename)
       (not (file-directory-p filename))))

359 360 361
(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."
362
  (let* ((tail Info-suffix-list)
363 364 365
	 (lfn (if (fboundp 'msdos-long-file-names)
		  (msdos-long-file-names)
		t))
366 367 368
	 (check-short (and (fboundp 'msdos-long-file-names)
			   lfn))
	 fullname decoder done)
369
    (if (info-file-exists-p filename)
370 371
	;; FILENAME exists--see if that name contains a suffix.
	;; If so, set DECODE accordingly.
372 373 374 375 376 377 378 379
	(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))))
380
      ;; Try adding suffixes to FILENAME and see if we can find something.
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
      (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))))))
397 398
	(setq tail (cdr tail)))
      (or tail
399
	  (error "Can't find %s or any compressed version of it" filename)))
400 401 402 403 404
    ;; check for conflict with jka-compr
    (if (and (featurep 'jka-compr)
	     (jka-compr-installed-p)
	     (jka-compr-get-compression-info fullname))
	(setq decoder nil))
405
    (if decoder
406 407 408 409 410 411
	(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)))
412 413 414 415
	    (or (consp decoder)
		(setq decoder (list decoder)))
	    (apply 'call-process-region (point-min) (point-max)
		   (car decoder) t t nil (cdr decoder))))
416
      (insert-file-contents fullname visit))))
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 445 446 447 448 449 450 451 452 453 454 455
(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
456 457 458
	    ;; Don't drop the last part, it might contain non-Emacs stuff.
	    ;; (reverse (cdr (reverse
	    Info-default-directory-list)))) ;; )))
459

460
(defun info-initialize ()
Dave Love's avatar
Dave Love committed
461
  "Initialize `Info-directory-list', if that hasn't been done yet."
462
  (unless Info-directory-list
463
    (let ((path (getenv "INFOPATH")))
464
      (setq Info-directory-list
465 466
	    (prune-directory-list
	     (if path
467 468 469 470 471 472
		 (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)))))))
473

474 475 476 477 478
;;;###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))))
479
  (let (same-window-buffer-names same-window-regexps)
480
    (info file)))
481

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

484
;;;###autoload (put 'info 'info-file "emacs")
Jim Blandy's avatar
Jim Blandy committed
485
;;;###autoload
486
(defun info (&optional file buffer)
Jim Blandy's avatar
Jim Blandy committed
487 488 489
  "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
490 491
Called from a program, FILE may specify an Info node of the form
`(FILENAME)NODENAME'.
492 493 494 495
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
496

497 498
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
499 500
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
501 502

The search path for Info files is in the variable `Info-directory-list'.
503
The top-level Info directory is made by combining all the files named `dir'
Richard M. Stallman's avatar
Richard M. Stallman committed
504
in all the directories in that path."
505 506 507 508 509 510 511 512
  (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
513
  (if file
514 515 516 517
      ;; 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.
518 519 520 521
      (Info-goto-node
       (if (and (stringp file) (string-match "(.*)" file))
           file
         (concat "(" file ")")))
522
    (if (zerop (buffer-size))
Juri Linkov's avatar
Juri Linkov committed
523
        (Info-directory))))
Jim Blandy's avatar
Jim Blandy committed
524

525 526
;;;###autoload
(defun info-emacs-manual ()
527
  "Display the Emacs manual in Info mode."
528 529 530
  (interactive)
  (info "emacs"))

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

Juri Linkov's avatar
Juri Linkov committed
569 570 571 572
(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
573 574
  ;; Convert filename to lower case if not found as specified.
  ;; Expand it.
575
  (if (stringp filename)
Jim Blandy's avatar
Jim Blandy committed
576
      (let (temp temp-downcase found)
577
        (setq filename (substitute-in-file-name filename))
Juri Linkov's avatar
Juri Linkov committed
578
	(cond
Jesper Harder's avatar
Jesper Harder committed
579 580 581 582
	 ((string= (downcase filename) "dir")
	  (setq found t))
	 ((string= filename "apropos")
	  (setq found 'apropos))
Juri Linkov's avatar
Juri Linkov committed
583 584 585 586
	 ((string= filename "history")
	  (setq found 'history))
	 ((string= filename "toc")
	  (setq found 'toc))
Jesper Harder's avatar
Jesper Harder committed
587 588
	 (t
	  (let ((dirs (if (string-match "^\\./" filename)
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
                          ;; 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.
606
              (let ((suffix-list Info-suffix-list)
607 608 609
		    (lfn (if (fboundp 'msdos-long-file-names)
			     (msdos-long-file-names)
			   t)))
610 611 612
                (while (and suffix-list (not found))
                  (cond ((info-file-exists-p
                          (info-insert-file-contents-1
613
                           temp (car (car suffix-list)) lfn))
614 615 616
                         (setq found temp))
                        ((info-file-exists-p
                          (info-insert-file-contents-1
617 618 619 620 621 622 623 624
                           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)))
625
                  (setq suffix-list (cdr suffix-list))))
Jesper Harder's avatar
Jesper Harder committed
626
              (setq dirs (cdr dirs))))))
627 628
        (if found
            (setq filename found)
Juri Linkov's avatar
Juri Linkov committed
629 630 631 632 633 634 635 636 637 638 639
          (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))
640 641
  ;; Go into info buffer.
  (or (eq major-mode 'Info-mode) (pop-to-buffer "*info*"))
642 643 644 645 646
  ;; 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)))
647 648 649 650 651
  (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
652
else defaults to \"Top\"."
653 654 655
  (interactive
   (list (if current-prefix-arg
	     (completing-read "Node name: " (Info-build-node-completions)
656 657
			      nil t "Top"))))
  (unless nodename (setq nodename "Top"))
658
  (info-initialize)
659 660 661 662
  (Info-mode)
  (set (make-local-variable 'Info-current-file) t)
  (Info-find-node-2 nil nodename))

663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
;; 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
687
	  (goto-char (point-min))
688 689
	  (forward-line wline)
	  (set-window-start (selected-window) (point))
690
	  (goto-char (point-min))
691 692 693 694 695 696
	  (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))))))

697 698 699 700 701 702 703 704 705 706
(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."
707
  (let ((case-fold-search case-fold))
708 709 710
    (save-excursion
      (set-buffer (marker-buffer marker))
      (goto-char marker)
711

712 713 714 715
      ;; Search tag table
      (beginning-of-line)
      (when (re-search-forward regexp nil t)
	(list (string-equal "Ref:" (match-string 1))
716
	      (+ (point-min) (read (current-buffer)))
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
	      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)))
755

756 757 758 759 760 761 762 763 764
(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)))
765

766
(defun Info-find-node-2 (filename nodename &optional no-going-back)
767
  (buffer-disable-undo (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
768 769 770 771 772
  (or (eq major-mode 'Info-mode)
      (Info-mode))
  (widen)
  (setq Info-current-node nil)
  (unwind-protect
773 774
      (let ((case-fold-search t)
	    anchorpos)
775 776 777 778 779 780 781 782 783
        ;; 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
784 785 786 787 788
	      (cond
	       ((eq filename t)
		(Info-insert-dir))
	       ((eq filename 'apropos)
		(insert-buffer-substring " *info-apropos*"))
Juri Linkov's avatar
Juri Linkov committed
789 790 791 792
	       ((eq filename 'history)
		(insert-buffer-substring " *info-history*"))
	       ((eq filename 'toc)
		(insert-buffer-substring " *info-toc*"))
Jesper Harder's avatar
Jesper Harder committed
793
	       (t
794
                (info-insert-file-contents filename nil)
Jesper Harder's avatar
Jesper Harder committed
795
                (setq default-directory (file-name-directory filename))))
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
              (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)
821
                            (buffer-disable-undo (current-buffer))
822 823 824 825 826 827 828 829
                            (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
830 831 832
		    (cond
		     ((eq filename t) "dir")
		     ((eq filename 'apropos) "apropos")
Juri Linkov's avatar
Juri Linkov committed
833 834
		     ((eq filename 'history) "history")
		     ((eq filename 'toc) "toc")
Jesper Harder's avatar
Jesper Harder committed
835 836
		     (t filename)))
	      ))
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
        ;; 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.
853
	  (let ((guesspos (point-min))
854
		(regexp (concat "\\(Node:\\|Ref:\\) *\\("
855
				(if (stringp nodename)
856 857
				    (regexp-quote nodename)
				  "")
858
				"\\) *[,\t\n\177]")))
859

860
	    (catch 'foo
861

862
	      ;; First, search a tag table, if any
863 864 865
	      (when (marker-position Info-tag-table-marker)
		(let* ((m Info-tag-table-marker)
		       (found (Info-find-in-tag-table m regexp)))
866

867 868 869
		  (when found
		    ;; FOUND is (ANCHOR POS MODE).
		    (setq guesspos (nth 1 found))
870

871 872 873 874 875 876 877
		    ;; 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)))
878 879

		    ;; Handle anchor
880 881 882
		    (when (nth 0 found)
		      (goto-char (setq anchorpos guesspos))
		      (throw 'foo t)))))
883 884 885 886

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

888 889 890 891 892 893 894
	      ;; 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)
895 896 897 898 899 900 901 902 903 904 905
		  (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))
906 907

	    (Info-select-node)
Juri Linkov's avatar
Juri Linkov committed
908 909 910 911 912 913 914 915 916
	    (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))
917 918 919 920 921 922
                  ((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
923 924
    ;; If we did not finish finding the specified node,
    ;; go back to the previous one.
925
    (or Info-current-node no-going-back (null Info-history)
926 927 928 929
        (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
930

931 932
;; Cache the contents of the (virtual) dir file, once we have merged
;; it for the first time, so we can save time subsequently.
933 934
(defvar Info-dir-contents nil)

935 936 937 938
;; Cache for the directory we decided to use for the default-directory
;; of the merged dir text.
(defvar Info-dir-contents-directory nil)

939 940 941 942
;; Record the file attributes of all the files from which we
;; constructed Info-dir-contents.
(defvar Info-dir-file-attributes nil)

943 944
(defvar Info-dir-file-name nil)

945
;; Construct the Info directory node by merging the files named `dir'
946 947 948
;; from various directories.  Set the *info* buffer's
;; default-directory to the first directory we actually get any text
;; from.
949
(defun Info-insert-dir ()
950 951 952 953
  (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
954 955 956 957 958 959 960 961 962
		       (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)))
963
			       Info-dir-file-attributes))))
964 965 966
      (progn
	(insert Info-dir-contents)
	(goto-char (point-min)))
967
    (let ((dirs (if Info-additional-directory-list
Richard M. Stallman's avatar
Richard M. Stallman committed
968 969 970
		    (append Info-directory-list
			    Info-additional-directory-list)
		  Info-directory-list))
971
	  (dir-file-attrs nil)
972 973
	  ;; Bind this in case the user sets it to nil.
	  (case-fold-search t)
974 975
	  ;; This is set non-nil if we find a problem in some input files.
	  problems
976
	  buffers buffer others nodes dirs-done)
977 978

      ;; Search the directory list for the directory file.
979
      (while dirs
980 981 982 983 984
	(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.
985 986 987 988 989 990 991 992 993 994 995
	      (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)))))
996 997 998 999
		(setq dirs-done
		      (cons truename
			    (cons (directory-file-name truename)
				  dirs-done)))
1000 1001 1002 1003
		(if attrs
		    (save-excursion
		      (or buffers
			  (message "Composing main Info directory..."))
1004
		      (set-buffer (generate-new-buffer " info dir"))
1005 1006 1007
		      (condition-case nil
			  (progn
			    (insert-file-contents file)
1008 1009
			    (set (make-local-variable 'Info-dir-file-name)
				 file)
1010
			    (push (current-buffer) buffers)
1011
			    (push (cons file attrs) dir-file-attrs))
1012
			(error (kill-buffer (current-buffer))))))))
1013 1014 1015
	  (unless (cdr dirs)
	    (set (make-local-variable 'Info-dir-contents-directory)
		 (file-name-as-directory (car dirs))))
1016
	  (setq dirs (cdr dirs))))
1017

1018
      (or buffers
1019
	  (error "Can't find the Info directory node"))
1020

1021
      ;; Distinguish the dir file that comes with Emacs from all the
1022
      ;; others.  Yes, that is really what this is supposed to do.
1023 1024 1025 1026
      ;; 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))
1027

1028 1029 1030
      ;; 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.
1031
      (insert-buffer buffer)
1032

1033
      ;; Look at each of the other buffers one by one.
1034 1035
      (dolist (other others)
	(let (this-buffer-nodes)
1036
	  ;; In each, find all the menus.
1037
	  (with-current-buffer other
1038 1039 1040
	    (goto-char (point-min))
	    ;; Find each menu, and add an elt to NODES for it.
	    (while (re-search-forward "^\\* Menu:" nil t)
1041 1042 1043 1044
	      (while (and (zerop (forward-line 1)) (eolp)))
	      (let ((beg (point))
		    nodename end)
		(re-search-backward "^\^_")
1045
		(search-forward "Node: ")
Juri Linkov's avatar
Juri Linkov committed
1046
		(setq nodename (Info-following-node-name))
1047
		(search-forward "\n\^_" nil 'move)
1048 1049
		(beginning-of-line)
		(setq end (point))
1050
		(push (list nodename other beg end) this-buffer-nodes)))
1051
	    (if (assoc-string "top" this-buffer-nodes t)
1052 1053
		(setq nodes (nconc this-buffer-nodes nodes))
	      (setq problems t)
1054
	      (message "No `top' node in %s" Info-dir-file-name)))))
Dave Love's avatar
Dave Love committed
1055
      ;; Add to the main menu a menu item for each other node.
1056
      (re-search-forward "^\\* Menu:")
1057 1058
      (forward-line 1)
      (let ((menu-items '("top"))
1059
	    (end (save-excursion (search-forward "\^_" nil t) (point))))
1060 1061
	(dolist (node nodes)
	  (let ((nodename (car node)))
1062 1063
	    (save-excursion
	      (or (member (downcase nodename) menu-items)
1064
		  (re-search-forward (concat "^\\* +"
1065 1066 1067 1068 1069
					     (regexp-quote nodename)
					     "::")
				     end t)
		  (progn
		    (insert "* " nodename "::" "\n")
1070
		    (push nodename menu-items)))))))
1071 1072
      ;; Now take each node of each of the other buffers
      ;; and merge it into the main buffer.
1073
      (dolist (node nodes)
1074
	(let ((case-fold-search t)
1075
	      (nodename (car node)))
1076 1077
	  (goto-char (point-min))
	  ;; Find the like-named node in the main buffer.
1078
	  (if (re-search-forward (concat "^\^_.*\n.*Node: "
1079 1080 1081 1082
					 (regexp-quote nodename)
					 "[,\n\t]")
				 nil t)
	      (progn
1083
		(search-forward "\n\^_" nil 'move)
1084 1085
		(beginning-of-line)
		(insert "\n"))
1086