1;;; informat.el --- info support functions package for Emacs 2 3;; Copyright (C) 1986, 2001, 2002, 2003, 2004, 2005, 4;; 2006, 2007 Free Software Foundation, Inc. 5 6;; Maintainer: FSF 7;; Keywords: help 8 9;; This file is part of GNU Emacs. 10 11;; GNU Emacs is free software; you can redistribute it and/or modify 12;; it under the terms of the GNU General Public License as published by 13;; the Free Software Foundation; either version 2, or (at your option) 14;; any later version. 15 16;; GNU Emacs is distributed in the hope that it will be useful, 17;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19;; GNU General Public License for more details. 20 21;; You should have received a copy of the GNU General Public License 22;; along with GNU Emacs; see the file COPYING. If not, write to the 23;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 24;; Boston, MA 02110-1301, USA. 25 26;;; Commentary: 27 28;; Nowadays, the Texinfo formatting commands always tagify a buffer 29;; (as does `makeinfo') since @anchor commands need tag tables. 30 31;;; Code: 32 33(require 'info) 34 35;;;###autoload 36(defun Info-tagify (&optional input-buffer-name) 37 "Create or update Info file tag table in current buffer or in a region." 38 (interactive) 39 ;; Save and restore point and restrictions. 40 ;; save-restrictions would not work 41 ;; because it records the old max relative to the end. 42 ;; We record it relative to the beginning. 43 (if input-buffer-name 44 (message "Tagifying region in %s ..." input-buffer-name) 45 (message 46 "Tagifying %s ..." (file-name-nondirectory (buffer-file-name)))) 47 (let ((omin (point-min)) 48 (omax (point-max)) 49 (nomax (= (point-max) (1+ (buffer-size)))) 50 (opoint (point))) 51 (unwind-protect 52 (progn 53 (widen) 54 (goto-char (point-min)) 55 (if (search-forward "\^_\nIndirect:\n" nil t) 56 (message 57 "Cannot tagify split info file. Run this before splitting.") 58 (let (tag-list 59 refillp 60 (case-fold-search t) 61 (regexp 62 (concat 63 "\\(" 64 65 66 "\\(" 67 "@anchor" ; match-string 2 matches @anchor 68 "\\)" 69 "\\(-no\\|-yes\\)" ; match-string 3 matches -no or -yes 70 "\\(" 71 "-refill" 72 "\\)" 73 74 "\\(" 75 "{" 76 "\\)" 77 "\\(" 78 "[^}]+" ; match-string 6 matches arg to anchor 79 "\\)" 80 "\\(" 81 "}" 82 "\\)" 83 84 "\\|" 85 86 "\\(" 87 "\n\^_\\(\^L\\)?" 88 "\\)" 89 90 "\\(" 91 "\n\\(File:[ \t]*\\([^,\n\t]*\\)[,\t\n]+[ \t\n]*\\)?" 92 "Node:[ \t]*" 93 "\\(" 94 "[^,\n\t]*" ; match-string 13 matches arg to node name 95 "\\)" 96 "[,\t\n]" 97 "\\)" 98 99 "\\)" 100 ))) 101 (while (re-search-forward regexp nil t) 102 (if (string-equal "@anchor" (match-string 2)) 103 (progn 104 ;; kludge lest lose match-data 105 (if (string-equal "-yes" (match-string 3)) 106 (setq refillp t)) 107 (setq tag-list 108 (cons (list 109 (concat "Ref: " (match-string 6)) 110 (match-beginning 0)) 111 tag-list)) 112 (if (eq refillp t) 113 ;; set start and end so texinfo-format-refill works 114 (let ((texinfo-command-start (match-beginning 0)) 115 (texinfo-command-end (match-end 0))) 116 (texinfo-format-refill)) 117 (delete-region (match-beginning 0) (match-end 0)))) 118 ;; else this is a Node 119 (setq tag-list 120 (cons (list 121 (concat "Node: " (match-string-no-properties 13)) 122 (1+ (match-beginning 10))) 123 tag-list)))) 124 125 (goto-char (point-max)) 126 (forward-line -8) 127 (let ((buffer-read-only nil)) 128 (if (search-forward "\^_\nEnd tag table\n" nil t) 129 (let ((end (point))) 130 (search-backward "\nTag table:\n") 131 (beginning-of-line) 132 (delete-region (point) end))) 133 (goto-char (point-max)) 134 (or (bolp) 135 (newline)) 136 (insert "\^_\f\nTag table:\n") 137 (if (eq major-mode 'info-mode) 138 (move-marker Info-tag-table-marker (point))) 139 (setq tag-list (nreverse tag-list)) 140 (while tag-list 141 (insert (car (car tag-list)) ?\177) 142 (princ (car (cdr (car tag-list))) (current-buffer)) 143 (insert ?\n) 144 (setq tag-list (cdr tag-list))) 145 (insert "\^_\nEnd tag table\n"))))) 146 (goto-char opoint) 147 (narrow-to-region omin (if nomax (1+ (buffer-size)) 148 (min omax (point-max)))))) 149 (if input-buffer-name 150 (message "Tagifying region in %s done" input-buffer-name) 151 (message 152 "Tagifying %s done" (file-name-nondirectory (buffer-file-name))))) 153 154 155;;;###autoload 156(defun Info-split () 157 "Split an info file into an indirect file plus bounded-size subfiles. 158Each subfile will be up to 50,000 characters plus one node. 159 160To use this command, first visit a large Info file that has a tag 161table. The buffer is modified into a (small) indirect info file which 162should be saved in place of the original visited file. 163 164The subfiles are written in the same directory the original file is 165in, with names generated by appending `-' and a number to the original 166file name. The indirect file still functions as an Info file, but it 167contains just the tag table and a directory of subfiles." 168 169 (interactive) 170 (if (< (buffer-size) 70000) 171 (error "This is too small to be worth splitting")) 172 (goto-char (point-min)) 173 (search-forward "\^_") 174 (forward-char -1) 175 (let ((start (point)) 176 (chars-deleted 0) 177 subfiles 178 (subfile-number 1) 179 (case-fold-search t) 180 (filename (file-name-sans-versions buffer-file-name))) 181 (goto-char (point-max)) 182 (forward-line -8) 183 (setq buffer-read-only nil) 184 (or (search-forward "\^_\nEnd tag table\n" nil t) 185 (error "Tag table required; use M-x Info-tagify")) 186 (search-backward "\nTag table:\n") 187 (if (looking-at "\nTag table:\n\^_") 188 (error "Tag table is just a skeleton; use M-x Info-tagify")) 189 (beginning-of-line) 190 (forward-char 1) 191 (save-restriction 192 (narrow-to-region (point-min) (point)) 193 (goto-char (point-min)) 194 (while (< (1+ (point)) (point-max)) 195 (goto-char (min (+ (point) 50000) (point-max))) 196 (search-forward "\^_" nil 'move) 197 (setq subfiles 198 (cons (list (+ start chars-deleted) 199 (concat (file-name-nondirectory filename) 200 (format "-%d" subfile-number))) 201 subfiles)) 202 ;; Put a newline at end of split file, to make Unix happier. 203 (insert "\n") 204 (write-region (point-min) (point) 205 (concat filename (format "-%d" subfile-number))) 206 (delete-region (1- (point)) (point)) 207 ;; Back up over the final ^_. 208 (forward-char -1) 209 (setq chars-deleted (+ chars-deleted (- (point) start))) 210 (delete-region start (point)) 211 (setq subfile-number (1+ subfile-number)))) 212 (while subfiles 213 (goto-char start) 214 (insert (nth 1 (car subfiles)) 215 (format ": %d" (1- (car (car subfiles)))) 216 "\n") 217 (setq subfiles (cdr subfiles))) 218 (goto-char start) 219 (insert "\^_\nIndirect:\n") 220 (search-forward "\nTag Table:\n") 221 (insert "(Indirect)\n"))) 222 223(defvar Info-validate-allnodes) 224(defvar Info-validate-thisnode) 225(defvar Info-validate-lossages) 226 227;;;###autoload 228(defun Info-validate () 229 "Check current buffer for validity as an Info file. 230Check that every node pointer points to an existing node." 231 (interactive) 232 (save-excursion 233 (save-restriction 234 (widen) 235 (goto-char (point-min)) 236 (if (search-forward "\nTag table:\n(Indirect)\n" nil t) 237 (error "Don't yet know how to validate indirect info files: \"%s\"" 238 (buffer-name (current-buffer)))) 239 (goto-char (point-min)) 240 (let ((Info-validate-allnodes '(("*"))) 241 (regexp "Node:[ \t]*\\([^,\n\t]*\\)[,\t\n]") 242 (case-fold-search t) 243 (tags-losing nil) 244 (Info-validate-lossages ())) 245 (while (search-forward "\n\^_" nil t) 246 (forward-line 1) 247 (let ((beg (point))) 248 (forward-line 1) 249 (if (re-search-backward regexp beg t) 250 (let ((name (downcase 251 (buffer-substring-no-properties 252 (match-beginning 1) 253 (progn 254 (goto-char (match-end 1)) 255 (skip-chars-backward " \t") 256 (point)))))) 257 (if (assoc name Info-validate-allnodes) 258 (setq Info-validate-lossages 259 (cons (list name "Duplicate node-name" nil) 260 Info-validate-lossages)) 261 (setq Info-validate-allnodes 262 (cons (list name 263 (progn 264 (end-of-line) 265 (and (re-search-backward 266 "prev[ious]*:" beg t) 267 (progn 268 (goto-char (match-end 0)) 269 (downcase 270 (Info-following-node-name))))) 271 beg) 272 Info-validate-allnodes))))))) 273 (goto-char (point-min)) 274 (while (search-forward "\n\^_" nil t) 275 (forward-line 1) 276 (let ((beg (point)) 277 Info-validate-thisnode next) 278 (forward-line 1) 279 (if (re-search-backward regexp beg t) 280 (save-restriction 281 (let ((md (match-data))) 282 (search-forward "\n\^_" nil 'move) 283 (narrow-to-region beg (point)) 284 (set-match-data md)) 285 (setq Info-validate-thisnode (downcase 286 (buffer-substring-no-properties 287 (match-beginning 1) 288 (progn 289 (goto-char (match-end 1)) 290 (skip-chars-backward " \t") 291 (point))))) 292 (end-of-line) 293 (and (search-backward "next:" nil t) 294 (setq next (Info-validate-node-name "invalid Next")) 295 (assoc next Info-validate-allnodes) 296 (if (equal (car (cdr (assoc next Info-validate-allnodes))) 297 Info-validate-thisnode) 298 ;; allow multiple `next' pointers to one node 299 (let ((tem Info-validate-lossages)) 300 (while tem 301 (if (and (equal (car (cdr (car tem))) 302 "should have Previous") 303 (equal (car (car tem)) 304 next)) 305 (setq Info-validate-lossages 306 (delq (car tem) Info-validate-lossages))) 307 (setq tem (cdr tem)))) 308 (setq Info-validate-lossages 309 (cons (list next 310 "should have Previous" 311 Info-validate-thisnode) 312 Info-validate-lossages)))) 313 (end-of-line) 314 (if (re-search-backward "prev[ious]*:" nil t) 315 (Info-validate-node-name "invalid Previous")) 316 (end-of-line) 317 (if (search-backward "up:" nil t) 318 (Info-validate-node-name "invalid Up")) 319 (if (re-search-forward "\n* Menu:" nil t) 320 (while (re-search-forward "\n\\* " nil t) 321 (Info-validate-node-name 322 (concat "invalid menu item " 323 (buffer-substring (point) 324 (save-excursion 325 (skip-chars-forward "^:") 326 (point)))) 327 (Info-extract-menu-node-name)))) 328 (goto-char (point-min)) 329 (while (re-search-forward "\\*note[ \n]*[^:\t]*:" nil t) 330 (goto-char (+ (match-beginning 0) 5)) 331 (skip-chars-forward " \n") 332 (Info-validate-node-name 333 (concat "invalid reference " 334 (buffer-substring (point) 335 (save-excursion 336 (skip-chars-forward "^:") 337 (point)))) 338 (Info-extract-menu-node-name "Bad format cross-reference"))))))) 339 (setq tags-losing (not (Info-validate-tags-table))) 340 (if (or Info-validate-lossages tags-losing) 341 (with-output-to-temp-buffer " *problems in info file*" 342 (while Info-validate-lossages 343 (princ "In node \"") 344 (princ (car (car Info-validate-lossages))) 345 (princ "\", ") 346 (let ((tem (nth 1 (car Info-validate-lossages)))) 347 (cond ((string-match "\n" tem) 348 (princ (substring tem 0 (match-beginning 0))) 349 (princ "...")) 350 (t 351 (princ tem)))) 352 (if (nth 2 (car Info-validate-lossages)) 353 (progn 354 (princ ": ") 355 (let ((tem (nth 2 (car Info-validate-lossages)))) 356 (cond ((string-match "\n" tem) 357 (princ (substring tem 0 (match-beginning 0))) 358 (princ "...")) 359 (t 360 (princ tem)))))) 361 (terpri) 362 (setq Info-validate-lossages (cdr Info-validate-lossages))) 363 (if tags-losing (princ "\nTags table must be recomputed\n"))) 364 ;; Here if info file is valid. 365 ;; If we already made a list of problems, clear it out. 366 (save-excursion 367 (if (get-buffer " *problems in info file*") 368 (progn 369 (set-buffer " *problems in info file*") 370 (kill-buffer (current-buffer))))) 371 (message "File appears valid")))))) 372 373(defun Info-validate-node-name (kind &optional name) 374 (if name 375 nil 376 (goto-char (match-end 0)) 377 (skip-chars-forward " \t") 378 (if (= (following-char) ?\() 379 nil 380 (setq name 381 (buffer-substring-no-properties 382 (point) 383 (progn 384 (skip-chars-forward "^,\t\n") 385 (skip-chars-backward " ") 386 (point)))))) 387 (if (null name) 388 nil 389 (setq name (downcase name)) 390 (or (and (> (length name) 0) (= (aref name 0) ?\()) 391 (assoc name Info-validate-allnodes) 392 (setq Info-validate-lossages 393 (cons (list Info-validate-thisnode kind name) 394 Info-validate-lossages)))) 395 name) 396 397(defun Info-validate-tags-table () 398 (goto-char (point-min)) 399 (if (not (search-forward "\^_\nEnd tag table\n" nil t)) 400 t 401 (not (catch 'losing 402 (let* ((end (match-beginning 0)) 403 (start (progn (search-backward "\nTag table:\n") 404 (1- (match-end 0)))) 405 tem) 406 (setq tem Info-validate-allnodes) 407 (while tem 408 (goto-char start) 409 (or (equal (car (car tem)) "*") 410 (search-forward (concat "Node: " 411 (car (car tem)) 412 "\177") 413 end t) 414 (throw 'losing 'x)) 415 (setq tem (cdr tem))) 416 (goto-char (1+ start)) 417 (while (looking-at ".*Node: \\(.*\\)\177\\([0-9]+\\)$") 418 (setq tem (downcase (buffer-substring-no-properties 419 (match-beginning 1) 420 (match-end 1)))) 421 (setq tem (assoc tem Info-validate-allnodes)) 422 (if (or (not tem) 423 (< 1000 (progn 424 (goto-char (match-beginning 2)) 425 (setq tem (- (car (cdr (cdr tem))) 426 (read (current-buffer)))) 427 (if (> tem 0) tem (- tem))))) 428 (throw 'losing 'y)) 429 (forward-line 1))) 430 (if (looking-at "\^_\n") 431 (forward-line 1)) 432 (or (looking-at "End tag table\n") 433 (throw 'losing 'z)) 434 nil)))) 435 436;;;###autoload 437(defun batch-info-validate () 438 "Runs `Info-validate' on the files remaining on the command line. 439Must be used only with -batch, and kills Emacs on completion. 440Each file will be processed even if an error occurred previously. 441For example, invoke \"emacs -batch -f batch-info-validate $info/ ~/*.info\"" 442 (if (not noninteractive) 443 (error "batch-info-validate may only be used -batch")) 444 (let ((version-control t) 445 (auto-save-default nil) 446 (find-file-run-dired nil) 447 (kept-old-versions 259259) 448 (kept-new-versions 259259)) 449 (let ((error 0) 450 file 451 (files ())) 452 (while command-line-args-left 453 (setq file (expand-file-name (car command-line-args-left))) 454 (cond ((not (file-exists-p file)) 455 (message ">> %s does not exist!" file) 456 (setq error 1 457 command-line-args-left (cdr command-line-args-left))) 458 ((file-directory-p file) 459 (setq command-line-args-left (nconc (directory-files file) 460 (cdr command-line-args-left)))) 461 (t 462 (setq files (cons file files) 463 command-line-args-left (cdr command-line-args-left))))) 464 (while files 465 (setq file (car files) 466 files (cdr files)) 467 (let ((lose nil)) 468 (condition-case err 469 (progn 470 (if buffer-file-name (kill-buffer (current-buffer))) 471 (find-file file) 472 (buffer-disable-undo (current-buffer)) 473 (set-buffer-modified-p nil) 474 (fundamental-mode) 475 (let ((case-fold-search nil)) 476 (goto-char (point-max)) 477 (cond ((search-backward "\n\^_\^L\nTag table:\n" nil t) 478 (message "%s already tagified" file)) 479 ((< (point-max) 30000) 480 (message "%s too small to bother tagifying" file)) 481 (t 482 (Info-tagify)))) 483 (let ((loss-name " *problems in info file*")) 484 (message "Checking validity of info file %s..." file) 485 (if (get-buffer loss-name) 486 (kill-buffer loss-name)) 487 (Info-validate) 488 (if (not (get-buffer loss-name)) 489 nil ;(message "Checking validity of info file %s... OK" file) 490 (message "----------------------------------------------------------------------") 491 (message ">> PROBLEMS IN INFO FILE %s" file) 492 (save-excursion 493 (set-buffer loss-name) 494 (princ (buffer-substring-no-properties 495 (point-min) (point-max)))) 496 (message "----------------------------------------------------------------------") 497 (setq error 1 lose t))) 498 (if (and (buffer-modified-p) 499 (not lose)) 500 (progn (message "Saving modified %s" file) 501 (save-buffer)))) 502 (error (message ">> Error: %s" (prin1-to-string err)))))) 503 (kill-emacs error)))) 504 505(provide 'informat) 506 507;;; arch-tag: 581c440e-5be1-4f31-b005-2d5824bbf569 508;;; informat.el ends here 509