-
Notifications
You must be signed in to change notification settings - Fork 0
/
chicken-doc-text.scm
349 lines (328 loc) · 16.8 KB
/
chicken-doc-text.scm
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
(module chicken-doc-text (write-sxml-as-text
chicken-doc-ansi-colors)
(import scheme)
(import (only srfi-1 filter-map reduce make-list))
(cond-expand
(chicken-4
(import chicken)
(use data-structures srfi-13 ports)
(require-library srfi-1)
(use fmt fmt-unicode)
(use sxml-transforms)
(use matchable)
)
(else
(import (chicken base))
(import (chicken string) srfi-13)
(import (chicken port))
(import fmt fmt-unicode)
(import sxml-transforms)
(import matchable)
)
)
(define chicken-doc-ansi-colors (make-parameter #f))
(define walk pre-post-order*)
;; sxml-transforms does not allow us to pass state around so we
;; use parameters and preorder traversal; it also does not let
;; us obtain the current stylesheet bindings, so we must approximate
;; them with a letrec
(define (make-text-stylesheet doc #!key (wrap 78) (warnings #f))
(define (flatten-frags frags)
(with-output-to-string (lambda () (SRV:send-reply frags))))
(define (indent-and-wrap-with-bullet indent wrap prefix items)
;; we could have caller combine indent and prefix into prefix
(define (split-first-line s)
(cond ((string-index s #\newline)
=> (lambda (i) (cons (substring s 0 i)
(substring s (+ i 1)))))
(else (cons s #f))))
(let* ((prefix (string-append (make-string indent #\space) prefix)))
(if (not wrap)
`(,prefix ,items #\newline)
(match
;; split required to extract indented lists in items ("rest") -- rethink this?
(split-first-line (flatten-frags items))
((line1 . rest)
`(,(fmt #f (with-width
wrap
(fmt-unicode
(columnar (string-length prefix) (dsp prefix)
(wrap-lines line1)))))
,rest))))))
(define (extract-dl-items dl) ; returns ( (term . defs) ...)
(let loop ((dl dl)
(L '())
(dt #f) ; the unknown term
(dd '()))
(if (null? dl)
(if dt
(let ((L (cons (cons dt (reverse dd)) L))) ; remaining dt
(reverse L))
'())
(match (car dl)
(('dt . term)
(if dt
(loop (cdr dl) (cons (cons dt (reverse dd)) L) term '())
(loop (cdr dl) L term '()))) ; skip until first dt
(('dd . def)
(loop (cdr dl) L dt (cons def dd)))))))
(define (extract-table-items table cell-ss)
;; returns ( (td td ...) (td td ...) )
;; with TD flattened into strings and wrapped
(let ((cell-ss `((@ *preorder* . ,drop-tag)
. ,cell-ss)))
(filter-map (match-lambda (('tr . tds)
(filter-map
(match-lambda (('td . body)
(flatten-frags (pre-post-order* body cell-ss)))
;; we don't pass the "th" identity back, so we can't
;; do further processing, such as centering
(('th . body)
(string-upcase
(flatten-frags (pre-post-order* body cell-ss))))
(else #f))
tds))
(else #f)) ; usu. whitespace and (@ ...)
table)))
;; special formatter for table top/bottom
(define (fill char) (lambda (st) ((cat (make-string (fmt-width st) char)) st)))
;(define (fill char) (lambda (st) ((pad-char char (pad/both (fmt-width st))) st)))
(define (drop-tag tag body) '())
(define (text-warning . args)
(when warnings (apply warning args)))
(define (drop-tag-noisily tag body)
(text-warning "dropped" (cons tag body))
'())
(let* ((wrap (and wrap (not (zero? wrap)) (max wrap 0)))
(list-indent (make-parameter 2))
(hr-glyph (if wrap (make-string wrap #\-) "--------"))
(underline (if (chicken-doc-ansi-colors)
(lambda (x) `("\x1b[4m" ,x "\x1b[0m"))
(lambda (x) `("_" ,x "_"))))
(teletypify (if (chicken-doc-ansi-colors)
(lambda (x) `("\x1b[4m" ,x "\x1b[0m"))
(lambda (x) `("`" ,x "`"))))
(italicize (if (chicken-doc-ansi-colors)
(lambda (x) `("\x1b[4m" ,x "\x1b[0m"))
(lambda (x) `("/" ,x "/"))))
(embolden (if (chicken-doc-ansi-colors)
(lambda (x) `("\x1b[1m" ,x "\x1b[0m"))
(lambda (x) `("*" ,x "*")))))
(letrec
((ss #f)
(inline-ss #f)
(default-elts
`((*text* . ,(lambda (tag text) text))
(*default* . ,drop-tag-noisily)))
(inline-elts
`((b . ,(lambda (tag body) (embolden body)))
(i . ,(lambda (tag body) (italicize body)))
(tt . ,(lambda (tag body) (teletypify body)))
(sub . ,(lambda (tag body) body))
(sup . ,(lambda (tag body) body))
(big . ,(lambda (tag body) body))
(small . ,(lambda (tag body) body))
(link . ,(lambda (tag href+desc)
(match href+desc
((or (href) (href #f)) ;; like #!optional; can probably remove #f
href)
((href desc)
`(,desc #\space #\( ,href #\))))))
;; Internal hyperlinks aren't very useful, so just show the description when available.
;; However, if the described href is a fragment not matching the description,
;; print both.
(int-link . ,(lambda (tag href+desc)
(match href+desc
((or (href) (href #f) (href ""))
(underline href))
((href desc)
(if (char=? (string-ref href 0) #\#)
(let ((hre (substring href 1)))
(if (equal? desc hre)
(underline desc)
`(,desc #\space #\( ,(underline hre) #\))))
(underline desc))))))))
(block-elts
`((section . ,(lambda (tag level+name+body)
(match level+name+body
((level name . body)
`(#\newline
,(case level
((2) "==")
((3) "===")
((4) "====")
((5) "=====")
((6) "======")
(else "======"))
" " ,name #\newline ,body)))))
,@(let ((parse-LIs
(lambda (items prefix)
(let ((index 0))
`(#\newline
,(pre-post-order*
items
`((li *preorder* .
,(lambda (tag items)
(set! index (+ index 1)) ; grr
(let ((p (prefix index))
(i (list-indent)))
(indent-and-wrap-with-bullet
i wrap p
(parameterize ((list-indent (+ i (string-length p))))
;; NB the transformer won't correctly handle
;; block elements other than nested lists
(pre-post-order* items ss)))))))))))))
`((ul *preorder* .
,(lambda (tag items)
(parse-LIs items (lambda (i) "* "))))
(ol *preorder* .
,(lambda (tag items)
(parse-LIs items (lambda (i) (string-append
(number->string i) ". ")))))))
(dl *preorder* .
,(lambda (tag items)
`(#\newline
,(map (match-lambda
((term . defs)
(let* ((term (flatten-frags (pre-post-order* term inline-ss)))
(bullet (string-append "- " term ": ")))
;; Indent the term's description to align with the term.
;; If this indent exceeds 25% of the output width, just
;; align to the "- " bullet as in a normal list.
(let* ((indent-limit (inexact->exact (truncate (* .25 wrap))))
(desc-indent-limit (max 0 (- indent-limit (list-indent)))))
(if (> (string-length bullet) desc-indent-limit)
(indent-and-wrap-with-bullet
(list-indent) wrap "- "
(cons (string-append term ": ")
(pre-post-order* defs inline-ss)))
(indent-and-wrap-with-bullet
(list-indent) wrap bullet
;; FIXME: multiple defs should be displayed separately
(pre-post-order* defs inline-ss)))))))
(extract-dl-items items)))))
(p . ,(lambda (tag body)
(let ((str (flatten-frags body))) ; FIXME remove if no wrap
`(#\newline
,(if wrap
(fmt #f (with-width wrap (fmt-unicode (wrap-lines str))))
(list str #\newline)))))) ; need extra NL if no wrap-lines
(pre . ,(lambda (tag body)
`(#\newline " " ; dumb
,(string-intersperse (string-split (flatten-frags body) "\n" #t)
"\n ")
#\newline ; hmm
)
))
(highlight . ,(lambda (tag lang+body)
(match lang+body
((lang . body)
;; use PRE output for now; ignore LANG
`(#\newline " " ; dumb
,(string-intersperse (string-split (flatten-frags body) "\n" #t)
"\n ")
#\newline ; hmm
)))
))
(def ((sig *preorder*
. ,(lambda (tag sigs)
(list (map (lambda (s)
(match s
((type sig . alist)
;; don't bother filtering by valid types
`(#\newline "-- " ,type ": "
,(walk sig inline-ss)))))
sigs)
#\newline))))
. ,(lambda (tag body) body))
(hr .
,(lambda (tag body)
`(#\newline ,hr-glyph #\newline)))
;; (fmt #f (columnar "| " (wrap-lines col1) " | " (wrap-lines col2)
;; " | " (wrap-lines col3) " |"))
(table *preorder* .
,(lambda (tag elts)
;; Using columnar essentially requires that wrapping is enabled,
;; so if not, set it to 76 just for tables. *FIXME*
(let* ((wrap (if (or (not wrap) (zero? wrap)) 76 wrap))
(rows (extract-table-items elts inline-ss))
(ncol (reduce max 0 (map length rows)))
(sep (fmt #f (with-width
wrap
(apply columnar
`(" +-"
,@(intersperse
(make-list ncol (fill #\-))
"-+-")
"-+"))))))
(list
#\newline
;;sep
(map (lambda (row)
;; first pad row to uniform number of columns
(let* ((len (length row))
(row (if (> ncol len)
(append row (make-list (- ncol len) ""))
row)))
(list
sep
(fmt #f (with-width
wrap
(fmt-unicode
(apply columnar
`(" | "
,@(intersperse
(map wrap-lines row) " | ")
" |"))))))))
rows)
sep))))
(blockquote
. ,(lambda (tag body)
(let ((str (flatten-frags body)))
`(#\newline
,(if wrap
(fmt #f (with-width wrap (fmt-unicode (columnar " > " (wrap-lines str)))))
(list " > " str #\newline))))))
;; (examples (example (expr ...) (result ...)) ...) => (pre ...)
;; Some extraneous NLs are deleted, not all; newline output is crappy
;; (init ...) clause ignored
(examples *preorder*
. ,(lambda (tag body)
(pre-post-order*
body
`((example *preorder*
. ,(lambda (tag body)
(pre-post-order*
`(pre .
,(pre-post-order*
body
`((init *preorder*
. ,(lambda (tag body)
`(,body #\newline)))
(expr *preorder*
. ,(lambda (tag body)
body))
(result *preorder*
. ,(lambda (tag body)
`("\n; Result: " ,body)))
(*default* . ,drop-tag))))
ss)))
(*default* . ,drop-tag)))))
(tags *preorder* . ,drop-tag)
(toc *preorder* . ,drop-tag))))
;; This rigamarole is needed because we relied on letrec acting like letrec*,
;; but CHICKEN 4.8.3 made letrec standard-compliant. Since we can't rely on
;; letrec* in earlier versions, we hack it this way.
(set! ss `(,@block-elts
,@inline-elts
,@default-elts))
(set! inline-ss `(,@inline-elts
,@default-elts))
ss)))
(define (write-sxml-as-text doc wrap-col #!key (warnings #f))
(SRV:send-reply
(pre-post-order* doc
(make-text-stylesheet doc
wrap: wrap-col
warnings: warnings))))
)