informat.el 16.9 KB
Newer Older
1 2
;;; informat.el --- info support functions package for Emacs

3
;; Copyright (C) 1986, 2001-2020 Free Software Foundation, Inc.
4

5
;; Maintainer: emacs-devel@gnu.org
6
;; Keywords: help
7

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

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

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

;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Jim Blandy's avatar
Jim Blandy committed
22

23 24 25 26 27
;;; Commentary:

;; Nowadays, the Texinfo formatting commands always tagify a buffer
;; (as does `makeinfo') since @anchor commands need tag tables.

28 29
;;; Code:

Jim Blandy's avatar
Jim Blandy committed
30 31
(require 'info)

32
(declare-function texinfo-format-refill "texinfmt" ())
33

34 35 36 37
;; From texinfmt.el
(defvar texinfo-command-start)
(defvar texinfo-command-end)

Jim Blandy's avatar
Jim Blandy committed
38
;;;###autoload
39 40
(defun Info-tagify (&optional input-buffer-name)
  "Create or update Info file tag table in current buffer or in a region."
Jim Blandy's avatar
Jim Blandy committed
41 42 43 44 45 46 47 48
  (interactive)
  ;; Save and restore point and restrictions.
  ;; save-restrictions would not work
  ;; because it records the old max relative to the end.
  ;; We record it relative to the beginning.
  (let ((omin (point-min))
	(omax (point-max))
	(nomax (= (point-max) (1+ (buffer-size))))
49 50 51 52 53 54 55 56
	(opoint (point))
	(msg (format "Tagifying %s..."
		     (cond (input-buffer-name
			    (format "region in %s" input-buffer-name))
			   (buffer-file-name
			    (file-name-nondirectory (buffer-file-name)))
			   (t "buffer")))))
    (message "%s" msg)
Jim Blandy's avatar
Jim Blandy committed
57
    (unwind-protect
58
    (progn
59
      (widen)
60 61
      (goto-char (point-min))
      (if (search-forward "\^_\nIndirect:\n" nil t)
62 63
          (message
           "Cannot tagify split info file.  Run this before splitting.")
64 65 66
        (let (tag-list
              refillp
              (case-fold-search t)
67
              (regexp
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
               (concat
                "\\("


                "\\("
                "@anchor"        ; match-string 2 matches @anchor
                "\\)"
                "\\(-no\\|-yes\\)"  ; match-string 3 matches -no or -yes
                "\\("
                "-refill"
                "\\)"

                "\\("
                "{"
                "\\)"
                "\\("
                "[^}]+"          ; match-string 6 matches arg to anchor
                "\\)"
                "\\("
                "}"
                "\\)"

                "\\|"

                "\\("
93
                "\n\^_\\(\^L\\)?"
94 95 96
                "\\)"

                "\\("
97
                "\n\\(File:[ \t]*\\([^,\n\t]*\\)[,\t\n]+[ \t\n]*\\)?"
98 99
                "Node:[ \t]*"
                "\\("
100
                "[^,\n\t]*"      ; match-string 13 matches arg to node name
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
                "\\)"
                "[,\t\n]"
                "\\)"

                "\\)"
                )))
          (while (re-search-forward regexp nil t)
            (if (string-equal "@anchor" (match-string 2))
                (progn
                  ;; kludge lest lose match-data
                  (if (string-equal "-yes" (match-string 3))
                      (setq refillp t))
                  (setq tag-list
                        (cons (list
                               (concat "Ref: " (match-string 6))
                               (match-beginning 0))
                              tag-list))
                  (if (eq refillp t)
                      ;; set start and end so texinfo-format-refill works
                      (let ((texinfo-command-start (match-beginning 0))
                            (texinfo-command-end (match-end 0)))
                        (texinfo-format-refill))
                  (delete-region  (match-beginning 0) (match-end 0))))
              ;; else this is a Node
              (setq tag-list
126
                    (cons (list
127 128
                           (concat "Node: " (match-string-no-properties 13))
                           (1+ (match-beginning 10)))
129 130
                          tag-list))))

Jim Blandy's avatar
Jim Blandy committed
131 132 133 134 135 136 137 138 139
	      (goto-char (point-max))
	      (forward-line -8)
	      (let ((buffer-read-only nil))
		(if (search-forward "\^_\nEnd tag table\n" nil t)
		    (let ((end (point)))
		      (search-backward "\nTag table:\n")
		      (beginning-of-line)
		      (delete-region (point) end)))
		(goto-char (point-max))
140 141 142
		(or (bolp)
		    (newline))
		(insert "\^_\f\nTag table:\n")
143 144
		(if (eq major-mode 'info-mode)
		    (move-marker Info-tag-table-marker (point)))
145 146 147
		(setq tag-list (nreverse tag-list))
		(while tag-list
		  (insert (car (car tag-list)) ?\177)
148
		  (princ (car (cdr (car tag-list))) (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
149
		  (insert ?\n)
150
		  (setq tag-list (cdr tag-list)))
Jim Blandy's avatar
Jim Blandy committed
151 152 153
		(insert "\^_\nEnd tag table\n")))))
      (goto-char opoint)
      (narrow-to-region omin (if nomax (1+ (buffer-size))
154 155
			       (min omax (point-max)))))
    (message "%sdone" msg)))
156

Jim Blandy's avatar
Jim Blandy committed
157

158 159 160 161 162 163 164
;;;###autoload
(defcustom Info-split-threshold 262144
  "The number of characters by which `Info-split' splits an info file."
  :type 'integer
  :version "23.1"
  :group 'texinfo)

Jim Blandy's avatar
Jim Blandy committed
165 166 167
;;;###autoload
(defun Info-split ()
  "Split an info file into an indirect file plus bounded-size subfiles.
168 169
Each subfile will be up to the number of characters that
`Info-split-threshold' specifies, plus one node.
Jim Blandy's avatar
Jim Blandy committed
170 171 172 173 174 175 176 177 178 179 180

To use this command, first visit a large Info file that has a tag
table.  The buffer is modified into a (small) indirect info file which
should be saved in place of the original visited file.

The subfiles are written in the same directory the original file is
in, with names generated by appending `-' and a number to the original
file name.  The indirect file still functions as an Info file, but it
contains just the tag table and a directory of subfiles."

  (interactive)
181
  (if (< (buffer-size) (+ 20000 Info-split-threshold))
Jim Blandy's avatar
Jim Blandy committed
182 183 184 185 186
      (error "This is too small to be worth splitting"))
  (goto-char (point-min))
  (search-forward "\^_")
  (forward-char -1)
  (let ((start (point))
187
	(chars-deleted 0)
Jim Blandy's avatar
Jim Blandy committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
	subfiles
	(subfile-number 1)
	(case-fold-search t)
	(filename (file-name-sans-versions buffer-file-name)))
    (goto-char (point-max))
    (forward-line -8)
    (setq buffer-read-only nil)
    (or (search-forward "\^_\nEnd tag table\n" nil t)
	(error "Tag table required; use M-x Info-tagify"))
    (search-backward "\nTag table:\n")
    (if (looking-at "\nTag table:\n\^_")
	(error "Tag table is just a skeleton; use M-x Info-tagify"))
    (beginning-of-line)
    (forward-char 1)
    (save-restriction
      (narrow-to-region (point-min) (point))
      (goto-char (point-min))
      (while (< (1+ (point)) (point-max))
206
	(goto-char (min (+ (point) Info-split-threshold) (point-max)))
Jim Blandy's avatar
Jim Blandy committed
207 208
	(search-forward "\^_" nil 'move)
	(setq subfiles
209
	      (cons (list (+ start chars-deleted)
Jim Blandy's avatar
Jim Blandy committed
210 211 212 213 214 215 216 217 218 219
			  (concat (file-name-nondirectory filename)
				  (format "-%d" subfile-number)))
		    subfiles))
	;; Put a newline at end of split file, to make Unix happier.
	(insert "\n")
	(write-region (point-min) (point)
		      (concat filename (format "-%d" subfile-number)))
	(delete-region (1- (point)) (point))
	;; Back up over the final ^_.
	(forward-char -1)
220
	(setq chars-deleted (+ chars-deleted (- (point) start)))
Jim Blandy's avatar
Jim Blandy committed
221 222 223 224 225
	(delete-region start (point))
	(setq subfile-number (1+ subfile-number))))
    (while subfiles
      (goto-char start)
      (insert (nth 1 (car subfiles))
226
	      (format ": %d" (1- (car (car subfiles))))
Jim Blandy's avatar
Jim Blandy committed
227 228 229 230 231 232 233
	      "\n")
      (setq subfiles (cdr subfiles)))
    (goto-char start)
    (insert "\^_\nIndirect:\n")
    (search-forward "\nTag Table:\n")
    (insert "(Indirect)\n")))

234 235 236 237
(defvar Info-validate-allnodes)
(defvar Info-validate-thisnode)
(defvar Info-validate-lossages)

Jim Blandy's avatar
Jim Blandy committed
238 239 240 241 242 243 244 245 246 247 248 249 250
;;;###autoload
(defun Info-validate ()
  "Check current buffer for validity as an Info file.
Check that every node pointer points to an existing node."
  (interactive)
  (save-excursion
    (save-restriction
      (widen)
      (goto-char (point-min))
      (if (search-forward "\nTag table:\n(Indirect)\n" nil t)
	  (error "Don't yet know how to validate indirect info files: \"%s\""
		 (buffer-name (current-buffer))))
      (goto-char (point-min))
251
      (let ((Info-validate-allnodes '(("*")))
Jim Blandy's avatar
Jim Blandy committed
252 253 254
	    (regexp "Node:[ \t]*\\([^,\n\t]*\\)[,\t\n]")
	    (case-fold-search t)
	    (tags-losing nil)
255
	    (Info-validate-lossages ()))
Jim Blandy's avatar
Jim Blandy committed
256 257 258 259 260 261
	(while (search-forward "\n\^_" nil t)
	  (forward-line 1)
	  (let ((beg (point)))
	    (forward-line 1)
	    (if (re-search-backward regexp beg t)
		(let ((name (downcase
262 263 264 265 266 267 268 269
			     (buffer-substring-no-properties
			      (match-beginning 1)
			      (progn
				(goto-char (match-end 1))
				(skip-chars-backward " \t")
				(point))))))
		  (if (assoc name Info-validate-allnodes)
		      (setq Info-validate-lossages
Jim Blandy's avatar
Jim Blandy committed
270
			    (cons (list name "Duplicate node-name" nil)
271 272 273 274 275 276 277 278 279 280 281 282 283
				  Info-validate-lossages))
		    (setq Info-validate-allnodes
			  (cons (list name
				      (progn
					(end-of-line)
					(and (re-search-backward
					      "prev[ious]*:" beg t)
					     (progn
					       (goto-char (match-end 0))
					       (downcase
						(Info-following-node-name)))))
				      beg)
				Info-validate-allnodes)))))))
Jim Blandy's avatar
Jim Blandy committed
284 285 286 287
	(goto-char (point-min))
	(while (search-forward "\n\^_" nil t)
	  (forward-line 1)
	  (let ((beg (point))
288
		Info-validate-thisnode next)
Jim Blandy's avatar
Jim Blandy committed
289 290 291
	    (forward-line 1)
	    (if (re-search-backward regexp beg t)
		(save-restriction
292 293 294 295
		  (let ((md (match-data)))
		    (search-forward "\n\^_" nil 'move)
		    (narrow-to-region beg (point))
		    (set-match-data md))
296 297 298 299 300 301 302
		  (setq Info-validate-thisnode (downcase
						(buffer-substring-no-properties
						 (match-beginning 1)
						 (progn
						   (goto-char (match-end 1))
						   (skip-chars-backward " \t")
						   (point)))))
Jim Blandy's avatar
Jim Blandy committed
303 304 305
		  (end-of-line)
		  (and (search-backward "next:" nil t)
		       (setq next (Info-validate-node-name "invalid Next"))
306 307 308
		       (assoc next Info-validate-allnodes)
		       (if (equal (car (cdr (assoc next Info-validate-allnodes)))
				  Info-validate-thisnode)
Jim Blandy's avatar
Jim Blandy committed
309
			   ;; allow multiple `next' pointers to one node
310
			   (let ((tem Info-validate-lossages))
Jim Blandy's avatar
Jim Blandy committed
311 312 313 314 315
			     (while tem
			       (if (and (equal (car (cdr (car tem)))
					       "should have Previous")
					(equal (car (car tem))
					       next))
316 317
				   (setq Info-validate-lossages
					 (delq (car tem) Info-validate-lossages)))
Jim Blandy's avatar
Jim Blandy committed
318
			       (setq tem (cdr tem))))
319
			 (setq Info-validate-lossages
Jim Blandy's avatar
Jim Blandy committed
320 321
			       (cons (list next
					   "should have Previous"
322 323
					   Info-validate-thisnode)
				     Info-validate-lossages))))
Jim Blandy's avatar
Jim Blandy committed
324 325 326 327 328 329 330 331 332
		  (end-of-line)
		  (if (re-search-backward "prev[ious]*:" nil t)
		      (Info-validate-node-name "invalid Previous"))
		  (end-of-line)
		  (if (search-backward "up:" nil t)
		      (Info-validate-node-name "invalid Up"))
		  (if (re-search-forward "\n* Menu:" nil t)
		      (while (re-search-forward "\n\\* " nil t)
			(Info-validate-node-name
333 334 335 336 337 338
			 (concat "invalid menu item "
				 (buffer-substring (point)
						   (save-excursion
						     (skip-chars-forward "^:")
						     (point))))
			 (Info-extract-menu-node-name))))
Jim Blandy's avatar
Jim Blandy committed
339 340 341 342 343 344 345 346 347 348 349 350
		  (goto-char (point-min))
		  (while (re-search-forward "\\*note[ \n]*[^:\t]*:" nil t)
		    (goto-char (+ (match-beginning 0) 5))
		    (skip-chars-forward " \n")
		    (Info-validate-node-name
		     (concat "invalid reference "
			     (buffer-substring (point)
					       (save-excursion
						 (skip-chars-forward "^:")
						 (point))))
		     (Info-extract-menu-node-name "Bad format cross-reference")))))))
	(setq tags-losing (not (Info-validate-tags-table)))
351
	(if (or Info-validate-lossages tags-losing)
Jim Blandy's avatar
Jim Blandy committed
352
	    (with-output-to-temp-buffer " *problems in info file*"
353
	      (while Info-validate-lossages
Jim Blandy's avatar
Jim Blandy committed
354
		(princ "In node \"")
355
		(princ (car (car Info-validate-lossages)))
Jim Blandy's avatar
Jim Blandy committed
356
		(princ "\", ")
357
		(let ((tem (nth 1 (car Info-validate-lossages))))
Jim Blandy's avatar
Jim Blandy committed
358 359 360 361 362
		  (cond ((string-match "\n" tem)
			 (princ (substring tem 0 (match-beginning 0)))
			 (princ "..."))
			(t
			 (princ tem))))
363
		(if (nth 2 (car Info-validate-lossages))
Jim Blandy's avatar
Jim Blandy committed
364 365
		    (progn
		      (princ ": ")
366
		      (let ((tem (nth 2 (car Info-validate-lossages))))
Jim Blandy's avatar
Jim Blandy committed
367 368 369 370 371 372
			(cond ((string-match "\n" tem)
			       (princ (substring tem 0 (match-beginning 0)))
			       (princ "..."))
			      (t
			       (princ tem))))))
		(terpri)
373
		(setq Info-validate-lossages (cdr Info-validate-lossages)))
Jim Blandy's avatar
Jim Blandy committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
	      (if tags-losing (princ "\nTags table must be recomputed\n")))
	  ;; Here if info file is valid.
	  ;; If we already made a list of problems, clear it out.
	  (save-excursion
	    (if (get-buffer " *problems in info file*")
		(progn
		  (set-buffer " *problems in info file*")
		  (kill-buffer (current-buffer)))))
	  (message "File appears valid"))))))

(defun Info-validate-node-name (kind &optional name)
  (if name
      nil
    (goto-char (match-end 0))
    (skip-chars-forward " \t")
    (if (= (following-char) ?\()
	nil
      (setq name
392
	    (buffer-substring-no-properties
Jim Blandy's avatar
Jim Blandy committed
393 394
	     (point)
	     (progn
395 396 397
	       (skip-chars-forward "^,\t\n")
	       (skip-chars-backward " ")
	       (point))))))
Jim Blandy's avatar
Jim Blandy committed
398 399 400 401
  (if (null name)
      nil
    (setq name (downcase name))
    (or (and (> (length name) 0) (= (aref name 0) ?\())
402 403 404 405
	(assoc name Info-validate-allnodes)
	(setq Info-validate-lossages
	      (cons (list Info-validate-thisnode kind name)
		    Info-validate-lossages))))
Jim Blandy's avatar
Jim Blandy committed
406 407 408 409 410 411 412 413 414 415 416
  name)

(defun Info-validate-tags-table ()
  (goto-char (point-min))
  (if (not (search-forward "\^_\nEnd tag table\n" nil t))
      t
    (not (catch 'losing
	   (let* ((end (match-beginning 0))
		  (start (progn (search-backward "\nTag table:\n")
				(1- (match-end 0))))
		  tem)
417
	     (setq tem Info-validate-allnodes)
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421 422 423 424 425 426 427 428
	     (while tem
	       (goto-char start)
	       (or (equal (car (car tem)) "*")
		   (search-forward (concat "Node: "
					   (car (car tem))
					   "\177")
				   end t)
		   (throw 'losing 'x))
	       (setq tem (cdr tem)))
	     (goto-char (1+ start))
	     (while (looking-at ".*Node: \\(.*\\)\177\\([0-9]+\\)$")
429
	       (setq tem (downcase (buffer-substring-no-properties
Jim Blandy's avatar
Jim Blandy committed
430 431
				     (match-beginning 1)
				     (match-end 1))))
432
	       (setq tem (assoc tem Info-validate-allnodes))
Jim Blandy's avatar
Jim Blandy committed
433 434 435 436 437 438
	       (if (or (not tem)
		       (< 1000 (progn
				 (goto-char (match-beginning 2))
				 (setq tem (- (car (cdr (cdr tem)))
					      (read (current-buffer))))
				 (if (> tem 0) tem (- tem)))))
439 440 441 442
		   (throw 'losing 'y))
	       (forward-line 1)))
	   (if (looking-at "\^_\n")
	       (forward-line 1))
Jim Blandy's avatar
Jim Blandy committed
443 444 445 446 447 448 449 450 451 452 453
	   (or (looking-at "End tag table\n")
	       (throw 'losing 'z))
	   nil))))

;;;###autoload
(defun batch-info-validate ()
  "Runs `Info-validate' on the files remaining on the command line.
Must be used only with -batch, and kills Emacs on completion.
Each file will be processed even if an error occurred previously.
For example, invoke \"emacs -batch -f batch-info-validate $info/ ~/*.info\""
  (if (not noninteractive)
454
      (error "batch-info-validate may only be used -batch"))
Jim Blandy's avatar
Jim Blandy committed
455 456 457 458 459 460 461 462 463 464 465 466 467
  (let ((version-control t)
	(auto-save-default nil)
	(find-file-run-dired nil)
	(kept-old-versions 259259)
	(kept-new-versions 259259))
    (let ((error 0)
	  file
	  (files ()))
      (while command-line-args-left
	(setq file (expand-file-name (car command-line-args-left)))
	(cond ((not (file-exists-p file))
	       (message ">> %s does not exist!" file)
	       (setq error 1
468
		     command-line-args-left (cdr command-line-args-left)))
Jim Blandy's avatar
Jim Blandy committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
	      ((file-directory-p file)
	       (setq command-line-args-left (nconc (directory-files file)
					      (cdr command-line-args-left))))
	      (t
	       (setq files (cons file files)
		     command-line-args-left (cdr command-line-args-left)))))
      (while files
	(setq file (car files)
	      files (cdr files))
	(let ((lose nil))
	  (condition-case err
	      (progn
		(if buffer-file-name (kill-buffer (current-buffer)))
		(find-file file)
		(buffer-disable-undo (current-buffer))
		(set-buffer-modified-p nil)
		(fundamental-mode)
		(let ((case-fold-search nil))
		  (goto-char (point-max))
		  (cond ((search-backward "\n\^_\^L\nTag table:\n" nil t)
			 (message "%s already tagified" file))
			((< (point-max) 30000)
			 (message "%s too small to bother tagifying" file))
			(t
Jim Blandy's avatar
Jim Blandy committed
493
			 (Info-tagify))))
Jim Blandy's avatar
Jim Blandy committed
494 495 496 497 498 499 500 501 502
		(let ((loss-name " *problems in info file*"))
		  (message "Checking validity of info file %s..." file)
		  (if (get-buffer loss-name)
		      (kill-buffer loss-name))
		  (Info-validate)
		  (if (not (get-buffer loss-name))
		      nil ;(message "Checking validity of info file %s... OK" file)
		    (message "----------------------------------------------------------------------")
		    (message ">> PROBLEMS IN INFO FILE %s" file)
503
		    (with-current-buffer loss-name
504 505
		      (princ (buffer-substring-no-properties
			      (point-min) (point-max))))
Jim Blandy's avatar
Jim Blandy committed
506 507 508 509 510 511 512 513
		    (message "----------------------------------------------------------------------")
		    (setq error 1 lose t)))
		(if (and (buffer-modified-p)
			 (not lose))
		    (progn (message "Saving modified %s" file)
			   (save-buffer))))
	    (error (message ">> Error: %s" (prin1-to-string err))))))
      (kill-emacs error))))
514

Richard M. Stallman's avatar
Richard M. Stallman committed
515 516
(provide 'informat)

517
;;; informat.el ends here