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
|
;;; sui.scm -- Skribe URL Indices
;;;
;;; Copyright (C) 2005, 2006, 2007, 2008, 2009, 2012,
;;; 2015, 2018 Ludovic Court�s <ludo@gnu.org>
;;; Copyright (C) 2003, 2004 Manuel Serrano
;;;
;;;
;;; This program is free software; you can redistribute it and/or modify
;;; it under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or
;;; (at your option) any later version.
;;;
;;; This program is distributed in the hope that it will be useful,
;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with this program; if not, write to the Free Software
;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
;;; USA.
(define-module (skribilo sui)
#:use-module (skribilo ast)
#:autoload (skribilo parameters) (*verbose* *destination-file*
*sui-path*)
#:autoload (skribilo reader) (make-reader)
#:autoload (skribilo engine) (find-engine)
#:autoload (skribilo evaluator) (evaluate-document)
#:use-module (skribilo condition)
#:use-module (skribilo utils strings)
#:use-module (skribilo utils syntax)
#:use-module (skribilo utils files)
#:use-module (ice-9 match)
#:use-module (srfi srfi-1)
#:autoload (srfi srfi-34) (raise)
#:use-module (srfi srfi-35)
#:export (load-sui sui-ref->url sui-title sui-file sui-key
sui-find-ref sui-search-ref sui-filter
document-sui sui-referenced-file sui-marks sui-blocks))
(skribilo-module-syntax)
;;; Author: Manuel Serrano, Ludovic Court�s
;;; Commentary:
;;;
;;; Library dealing with Skribe URL Indices (SUI).
;;;
;;; Code:
;;;
;;; Error conditions.
;;;
(define-condition-type &sui-error &skribilo-error
sui-error?)
(define-condition-type &invalid-sui-error &sui-error
invalid-sui-error?
(sexp invalid-sui-error:sexp))
(define (handle-sui-error c)
;; Issue a user-friendly error message for error condition C.
(define (show-location sexp)
(let* ((props (and (pair? sexp) (source-properties sexp)))
(file (and props (assoc-ref props 'filename)))
(line (and props (assoc-ref props 'line)))
(column (and props (assoc-ref props 'column))))
(if (and file line column)
(format (current-error-port) "~a:~a:~a: "
file line column))))
(cond ((invalid-sui-error? c)
(let ((sexp (invalid-sui-error:sexp c)))
(show-location sexp)
(format (current-error-port)
(G_ "invalid SUI form: ~A~%")
sexp)))
(else
(format (current-error-port)
(G_ "undefined SUI error: ~A~%")
c))))
(register-error-condition-handler! sui-error? handle-sui-error)
;*---------------------------------------------------------------------*/
;* *sui-table* ... */
;*---------------------------------------------------------------------*/
;; FIXME: Remove global state.
(define *sui-table* (make-hash-table))
;*---------------------------------------------------------------------*/
;* load-sui ... */
;* ------------------------------------------------------------- */
;* Returns a SUI sexp if already loaded. Load it otherwise. */
;* Raise an error if the file cannot be open. */
;*---------------------------------------------------------------------*/
(define (load-sui file)
(let* ((path (search-path (*sui-path*) file))
(sexp (and path (hash-ref *sui-table* path))))
(if (not path)
(raise (condition (&file-search-error (file-name file)
(path (*sui-path*)))))
(or sexp
(begin
(when (> (*verbose*) 0)
(format (current-error-port) " [loading sui: ~a]\n" path))
(let ((p (open-input-file path))
(read (make-reader 'skribe)))
(if (not (input-port? p))
(raise (condition (&file-open-error
(file-name path))))
(unwind-protect
(let ((sexp (read p)))
(match sexp
(('sui (? string?) . _)
(hash-set! *sui-table* path sexp))
(else
(raise (condition (&invalid-sui-error
(sexp sexp))))))
sexp)
(close-input-port p)))))))))
;*---------------------------------------------------------------------*/
;* sui-ref->url ... */
;*---------------------------------------------------------------------*/
(define (sui-ref->url dir sui ident opts)
(let ((refs (sui-find-ref sui ident opts)))
(and (pair? refs)
(let ((base (sui-file sui))
(file (car (car refs)))
(mark (cdr (car refs))))
(format #f "~a/~a#~a" dir (or file base) mark)))))
;*---------------------------------------------------------------------*/
;* sui-title ... */
;*---------------------------------------------------------------------*/
(define (sui-title sexp)
(match sexp
(('sui (and title (? string?)) . _)
title)
(else
(raise (condition (&invalid-sui-error
(sexp sexp)))))))
;*---------------------------------------------------------------------*/
;* sui-file ... */
;*---------------------------------------------------------------------*/
(define (sui-file sexp)
(sui-key sexp :file))
;*---------------------------------------------------------------------*/
;* sui-key ... */
;*---------------------------------------------------------------------*/
(define (sui-key sexp key)
(match sexp
(('sui _ . rest)
(let loop ((rest rest))
(and (pair? rest)
(if (eq? (car rest) key)
(and (pair? (cdr rest))
(cadr rest))
(loop (cdr rest))))))
(else
(raise (condition (&invalid-sui-error
(sexp sexp)))))))
;*---------------------------------------------------------------------*/
;* sui-find-ref ... */
;*---------------------------------------------------------------------*/
(define (sui-find-ref sui ident opts)
(let ((ident (assq :ident opts))
(mark (assq :mark opts))
(class (let ((c (assq :class opts)))
(and (pair? c) (cadr c))))
(chapter (assq :chapter opts))
(section (assq :section opts))
(subsection (assq :subsection opts))
(subsubsection (assq :subsubsection opts)))
(match sui
(('sui (? string?) . refs)
(cond
(mark (sui-search-ref 'marks refs (cadr mark) class))
(chapter (sui-search-ref 'chapters refs (cadr chapter) class))
(section (sui-search-ref 'sections refs (cadr section) class))
(subsection (sui-search-ref 'subsections refs (cadr subsection) class))
(subsubsection (sui-search-ref 'subsubsections refs (cadr subsubsection) class))
(ident (sui-search-all-refs refs (cadr ident) class))
(else '())))
(else
(raise (condition (&invalid-sui-error
(sexp sui))))))))
;*---------------------------------------------------------------------*/
;* sui-search-all-refs ... */
;*---------------------------------------------------------------------*/
(define (sui-search-all-refs refs id class)
;; Search any kind of object with ident ID among REFS.
(define (find-mark full-ref)
(let loop ((ref full-ref))
(and (not (null? ref))
(or (and (eq? (car ref) :mark)
(string=? (cadr ref) id)
(let ((f (memq :file full-ref))
(c (memq :mark full-ref)))
(list (cons (and (pair? f) (cadr f))
(and (pair? c) (cadr c))))))
(loop (cdr ref))))))
(let loop ((ref-kind refs))
(and (not (null? ref-kind))
(or (and (pair? (car ref-kind))
(let liip ((refs (cdar ref-kind)))
(and (not (null? refs))
(or (find-mark (car refs))
(liip (cdr refs))))))
(loop (cdr ref-kind))))))
;*---------------------------------------------------------------------*/
;* sui-search-ref ... */
;*---------------------------------------------------------------------*/
(define (sui-search-ref kind refs val class)
(define (find-ref refs val class)
(map (lambda (r)
(let ((f (memq :file r))
(c (memq :mark r)))
(cons (and (pair? f) (cadr f)) (and (pair? c) (cadr c)))))
(filter (if class
(lambda (m)
(and (pair? m)
(string? (car m))
(string=? (car m) val)
(let ((c (memq :class m)))
(and (pair? c)
(eq? (cadr c) class)))))
(lambda (m)
(and (pair? m)
(string? (car m))
(string=? (car m) val))))
refs)))
(let loop ((refs refs))
(if (pair? refs)
(if (and (pair? (car refs)) (eq? (caar refs) kind))
(find-ref (cdar refs) val class)
(loop (cdr refs)))
'())))
;*---------------------------------------------------------------------*/
;* sui-filter ... */
;*---------------------------------------------------------------------*/
(define (sui-filter sui pred1 pred2)
(match sui
(('sui (? string?) . refs)
(let loop ((refs refs)
(res '()))
(if (pair? refs)
(if (pred1 (car refs))
(loop (cdr refs)
(cons (filter pred2 (cdar refs)) res))
(loop (cdr refs) res))
(reverse! res))))
(else
(raise (condition (&invalid-sui-error
(sexp sui)))))))
;*---------------------------------------------------------------------*/
;* document-sui ... */
;*---------------------------------------------------------------------*/
(define (document-sui n e)
(define (sui)
(display "(sui \"")
(evaluate-document (markup-option n :title) (find-engine 'html))
(display "\"\n")
(format #t " :file ~s\n" (sui-referenced-file n e))
(sui-marks n e)
(sui-blocks 'chapter n e)
(sui-blocks 'section n e)
(sui-blocks 'subsection n e)
(sui-blocks 'subsubsection n e)
(display " )\n"))
(if (string? (*destination-file*))
(let ((f (format #f "~a.sui" (file-prefix (*destination-file*)))))
(with-output-to-file f sui))
(sui)))
;*---------------------------------------------------------------------*/
;* sui-referenced-file ... */
;*---------------------------------------------------------------------*/
(define (sui-referenced-file n e)
;; Hack to avoid a compile-time dependency on the HTML engine, which would
;; create a dependency loop:
;; (package base) -> (sui) -> (engine html) -> (package base).
(let* ((html-file (@ (skribilo engine html) html-file))
(file (html-file n e)))
(if (member (file-suffix file) '("skb" "sui" "skr" "html"))
(string-append (strip-ref-base (file-prefix file)) ".html")
file)))
;*---------------------------------------------------------------------*/
;* sui-marks ... */
;*---------------------------------------------------------------------*/
(define (sui-marks n e)
(display " (marks")
(for-each (lambda (m)
(format #t "\n (~s" (markup-ident m))
(format #t " :file ~s" (sui-referenced-file m e))
(format #t " :mark ~s" (markup-ident m))
(when (markup-class m)
(format #t " :class ~s" (markup-class m)))
(display ")"))
(search-down (lambda (n) (is-markup? n 'mark)) n))
(display ")\n"))
;*---------------------------------------------------------------------*/
;* sui-blocks ... */
;*---------------------------------------------------------------------*/
(define (sui-blocks kind n e)
(format #t " (~as" kind)
(for-each (lambda (chap)
(display "\n (\"")
(evaluate-document (markup-option chap :title)
(find-engine 'html))
(format #t "\" :file ~s" (sui-referenced-file chap e))
(format #t " :mark ~s" (markup-ident chap))
(when (markup-class chap)
(format #t " :class ~s" (markup-class chap)))
(display ")"))
(container-search-down (lambda (n) (is-markup? n kind)) n))
(display ")\n"))
;;; Local Variables:
;;; coding: latin-1
;;; End:
|
