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