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