File: html-to-xdoc.el

package info (click to toggle)
acl2 8.6%2Bdfsg-2
  • links: PTS
  • area: main
  • in suites: trixie
  • size: 1,111,420 kB
  • sloc: lisp: 17,818,294; java: 125,359; python: 28,122; javascript: 23,458; cpp: 18,851; ansic: 11,569; perl: 7,678; xml: 5,591; sh: 3,976; makefile: 3,833; ruby: 2,633; yacc: 1,126; ml: 763; awk: 295; csh: 233; lex: 197; php: 178; tcl: 49; asm: 23; haskell: 17
file content (275 lines) | stat: -rw-r--r-- 8,792 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
93
94
95
96
97
98
99
100
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
; Copyright (C) 2024, ForrestHunt, Inc.
; Written by Matt Kaufmann
; License: A 3-clause BSD license.  See the LICENSE file distributed with ACL2.
; Release approved by DARPA with "DISTRIBUTION STATEMENT A. Approved
; for public release. Distribution is unlimited."

; These utilities have been used as part of a process of converting to
; XDOC an HTML file that was already created using latex2html.  There
; is little documentation, but it may be helpful in future projects,
; in which case it may be straightforward to add documentation at that
; time.

; This file assumes that ctl-t-keymap has been defined, and might more
; generally assume that emacs-acl2.el has been loaded.

(defun within-tag (start-tag end-tag)
  (let ((saved-point (point)))
    (cond ((search-backward start-tag nil t)
	   (let ((p (match-beginning 0)))
	     (goto-char saved-point)
	     (cond ((search-backward end-tag nil t)
		    (goto-char saved-point)
		    (< (match-end 0) p))
		   (t t))))
	  (t nil))))

(defun html-end-paragraphs ()
  (interactive)
  (save-excursion
    (goto-char (point-min))
    (while (search-forward "\n\n" nil t)
      (let ((p0 (match-beginning 0)))
	(when (not (or (within-tag "<ul>" "</ul>")
		       (within-tag "<ol>" "</ol>")
		       (within-tag "<dl>" "</dl>")
		       (within-tag "<pre>" "</pre>")))
	  (goto-char p0)
	  (insert "\n</p>")
;;; Move past newlines.
	  (while (looking-at "\n")
	    (forward-char 1)))))))

(defun html-fix-p-tag-within-lists ()
  (interactive)
  (save-excursion
    (goto-char (point-min))
    (while (search-forward "<p>" nil t)
      (let ((p0 (match-end 0)))
	(when (or (within-tag "<ul>" "</ul>")
		  (within-tag "<ol>" "</ol>")
		  (within-tag "<dl>" "</dl>"))
; Deliberately omitted <pre> above.
	  (goto-char (- p0 1))
	  (insert "/"))))))

(defun html-fix-string (old new)
  (interactive)
  (save-excursion
    (goto-char (point-min))
    (while (search-forward old nil t)
      (replace-match new nil t))))

(defun html-fix-strings ()
  (interactive)
  (html-fix-string "\\" "\\\\")
  (html-fix-string "\"" "\\\"")
  (html-fix-string "&ldots;" "&hellip;")
; Latex2html has translated \ptt{<<=} to <tt>&laquo;=</tt>.
  (html-fix-string "&laquo;=" "&lt;&lt;="))

(defun html-remove-comments ()
  (interactive)
  (save-excursion
    (goto-char (point-min))
    (while (search-forward "<!--" nil t)
      (let ((beg (match-beginning 0)))
	(search-forward "-->")
; Avoid blank lines that could cause paragraph markers to be added.
	(while (looking-at "\n") (forward-char 1))
	(delete-region beg (point))))))

(defun html-balance-br ()
  (interactive)
  (html-fix-string "<br>" "<br/>"))

(defun html-error-on-bad-stuff ()
  (interactive)
  (let ((saved-point (point)))
    (goto-char (point-min))
    (cond
     ((search-forward "<sup>" nil t)
      (goto-char (match-beginning 0))
      (error "Need to deal with <sup> here."))
     ((search-forward "<!-- MATH" nil t)
      (goto-char (match-beginning 0))
      (error "Need to deal with MATH comment here."))
     ((search-forward ".svg" nil t)
      (goto-char (match-beginning 0))
      (error "Need to deal with image here."))
     ((search-forward "<br/>" nil t)
      (goto-char (match-beginning 0))
      (error "Found <br/>; need to deal with <br> tags manually."))
     (t (goto-char saved-point)))))

(defun html-convert-tt ()
  (interactive)
  (goto-char (point-min))
  (while (search-forward "<span  class=\"texttt\">" nil t)
    (let ((p1 (match-beginning 0))
	  (p2 (match-end 0)))
      (search-forward "</span>")
      (let ((p3 (match-beginning 0))
	    (p4 (match-end 0)))
	(goto-char p2)
	(cond
	 ((search-forward "<span" p3 t)
	  (goto-char (match-beginning 0))
	  (error "Unable to handle nested span tags within texttt"))
	 (t
	  (delete-region p3 p4)
	  (goto-char p3)
	  (insert "</tt>")
	  (delete-region p1 p2)
	  (goto-char p1)
	  (insert "<tt>")))))))

(defun html-remove-span-1 (point1 point2)

; Here point1 and point2 are start and end positions of "<span".

  (search-forward "</span>")
  (let ((point3 (match-beginning 0))
	(point4 (match-end 0)))
    (goto-char point2)
    (cond ((search-forward "class=\"texttt\"" point3 t)) ; just continue
	  ((search-forward "<span" point3 t)
	   (goto-char point1)
	   (error "Unable to handle nested span tags here"))
	  ((not (or (search-forward "class=\"MATH\"" point3 t)
		    (search-forward "class=\"arabic\"" point3 t)))
	   (goto-char point1)
	   (error "Unknown class here!"))
	  (t
	   (goto-char point3)
	   (kill-sexp)
	   (goto-char point1)
	   (kill-sexp)))))

(defun html-remove-span ()
  (interactive)
  (goto-char (point-min))
  (while (search-forward "<span" nil t)
    (html-remove-span-1 (match-beginning 0) (match-end 0))))

(defun html-fix-sub ()
  (interactive)
  (goto-char (point-min))
  (let ((saved-point (point)))
    (while (re-search-forward "</i><sub>\\(.*\\)</sub>" nil t)
;;;                              0        1       2     3
      (let* ((p0 (match-beginning 0))
	     (p1 (match-beginning 1)))
	(goto-char p1)
	(search-forward "</sub>")
	(let* ((p2 (match-beginning 0))
	       (p3 (match-end 0))
	       (subscript (buffer-substring p1 p2)))
	  (goto-char p1)
	  (when (search-forward "sub>" p2 t)
	    (error "Nested subscripts found here; must fix manually"))
	  (delete-region (+ p0 4) p3)
	  (goto-char p0)
	  (insert "_")
	  (insert subscript))))))

(defun html-replace-string (from-string to-string start end)

; This is just a version of replace-string to use in a program, to
; avoid byte compiler warnings in some versions of Emacs.

  (save-excursion
    (goto-char start)
    (while (search-forward from-string end t)
      (replace-match to-string end t))))

(defun html-convert-code-to-tt-and-pre-to-code ()
  (interactive)
  (html-replace-string "<code>" "<tt>" (point-min) (point-max))
  (html-replace-string "</code>" "</tt>" (point-min) (point-max))
  (html-replace-string "<pre>" "<code>" (point-min) (point-max))
  (html-replace-string "</pre>" "</code>" (point-min) (point-max)))

(defun html-remove-monospace-for-tt ()
  (interactive)
  (save-excursion
    (goto-char (point-min))
    (while (search-forward "<span style=\"font-family:monospace\">" nil t)
      (replace-match "<span  class=\"texttt\">"))))

(defun html-convert-tt-atsigns-to-code ()

;;; E.g., convert

;; <span  class="texttt">@@@
;; <em>Base&nbsp;Case:</em>
;; <br>(implies&nbsp;(not&nbsp;(consp&nbsp;x))
;; <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="MATH"><i>&psi;</i></span>)
;; <br>@@@
;; </span>

;;; to:

;; <code>
;; <em>Base Case:</em>
;; (implies (not (consp x))
;;          <span class="MATH"><i>&psi;</i></span>)
;; </code>

  (interactive)
  (goto-char (point-min))
  (while (search-forward "<span  class=\"texttt\">@@@" nil t)
    (let ((p0 (match-beginning 0))
	  (p1 (match-end 0))
	  (newline-br-atsigns-string "\n<br>@@@"))
      (search-forward newline-br-atsigns-string)
      (let ((p2 (+ 1 (match-beginning 0))))
	(html-replace-string "&nbsp;" " " p1 p2)
;;; Now recalculate end points.
	(goto-char p1)
	(search-forward newline-br-atsigns-string)
	(let ((p2 (+ 1 (match-beginning 0))))
	  (html-replace-string "<br>" "" p1 p2)
;;; Now recalculate end points.
	  (search-forward (concat newline-br-atsigns-string "\n</span>"))
	  (replace-match "</code>")
	  (goto-char p0)
	  (delete-region p0 p1)
	  (insert "<code>"))))))

(defun html-convert ()
  (interactive)
  (html-mode)
  (untabify (point-min) (point-max))
  (html-remove-comments)
  (html-error-on-bad-stuff)
  (html-convert-code-to-tt-and-pre-to-code)
  (html-convert-tt-atsigns-to-code)
  (html-balance-br)
  (html-remove-monospace-for-tt)

; It's probably much more common to have $..$ within a texttt
; environment than vice versa.  So we remove the "MATH" (and "arabic")
; stuff first, skipping over texttt.

  (html-remove-span)
  (html-end-paragraphs)
  (html-convert-tt)
  (html-fix-sub)
  (html-fix-p-tag-within-lists)
  (html-fix-strings)
  (indent-rigidly (point-min) (point-max) 1)
  (untabify (point-min) (point-max)))

(define-key ctl-t-keymap "h" 'html-convert)
(define-key ctl-t-keymap "m" 'html-remove-span)

; The following keyboard macro expects one to be on a line of the form
; nodexx.html
; for some "xx".  It switches to a (hopefully new) buffer, "nodexx",
; and inserts the contents of notes-version-6/nodexx.html.
; This probably isn't of general use but I found it useful and it
; might inspire development of a more general utility.

(fset 'node
   [?\C-a ?\C-f ?\C-f ?\C-  ?\C-e ?\M-w ?\C-x ?b ?\C-y backspace backspace backspace backspace backspace return ?\C-x ?i ?n ?o ?t ?e ?s ?- ?v ?e ?r ?s ?i ?o ?n ?- ?6 ?/ ?\C-y return ?\C-s ?< ?a ?  ?i ?d ?= ?\C-n ?\C-n ?\C-n ?\C-n ?\C-a ?\M-< ?\C-w ?\M-> ?\C-  ?\C-p ?\C-p ?\C-p ?\C-p ?\C-p ?\C-w])