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
|
;;; module.scm -- Integration of Skribe code as Guile modules.
;;;
;;; Copyright 2005, 2006 Ludovic Court�s <ludovic.courtes@laas.fr>
;;;
;;;
;;; 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 2 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 module)
:autoload (skribilo reader) (make-reader)
:use-module (skribilo debug)
:use-module (srfi srfi-1)
:use-module (ice-9 optargs)
:use-module (srfi srfi-39)
:use-module (skribilo utils syntax)
:export (make-run-time-module *skribilo-user-module*))
(fluid-set! current-reader %skribilo-module-reader)
;;; Author: Ludovic Court�s
;;;
;;; Commentary:
;;;
;;; This (fake) module defines a macro called `define-skribe-module' which
;;; allows to package Skribe code (which uses Skribe built-ins and most
;;; importantly a Skribe syntax) as a Guile module. This module
;;; automatically exports the macro as a core binding so that future
;;; `use-modules' referring to Skribe modules will work as expected.
;;;
;;; Code:
(define %skribilo-user-imports
;; List of modules that should be imported by any good Skribilo module.
'((srfi srfi-1) ;; lists
(srfi srfi-13) ;; strings
(ice-9 optargs) ;; `define*'
(skribilo package base) ;; the core markups
(skribilo utils syntax) ;; `unless', `when', etc.
(skribilo utils compat) ;; `skribe-load-path', etc.
(skribilo utils keywords) ;; `the-body', `the-options'
(skribilo utils strings) ;; `make-string-replace', etc.
(skribilo module)
(skribilo ast) ;; `<document>', `document?', etc.
(skribilo config)
(skribilo biblio)
(skribilo lib) ;; `define-markup', `unwind-protect', etc.
(skribilo resolve)
(skribilo engine)
(skribilo writer)
(skribilo output)
(skribilo evaluator)
(skribilo debug)
(skribilo location)
))
(define %skribilo-user-autoloads
;; List of auxiliary modules that may be lazily autoloaded.
'(((skribilo engine lout) . (!lout
lout-illustration
;; FIXME: The following should eventually be
;; removed from here.
lout-structure-number-string))
((skribilo engine latex) . (!latex LaTeX TeX))
((skribilo engine html) . (html-markup-class html-class
html-width))
((skribilo utils images) . (convert-image))
((skribilo index) . (index? make-index-table default-index
resolve-the-index))
((skribilo source) . (source-read-lines source-fontify
language? language-extractor
language-fontifier source-fontify))
((skribilo coloring lisp) . (skribe scheme lisp))
((skribilo coloring xml) . (xml))
((skribilo prog) . (make-prog-body resolve-line))
((skribilo color) .
(skribe-color->rgb skribe-get-used-colors skribe-use-color!))
((skribilo sui) . (load-sui))
((ice-9 and-let-star) . (and-let*))
((ice-9 receive) . (receive))))
;; The very macro to turn a legacy Skribe file (which uses Skribe's syntax)
;; into a Guile module.
(define-macro (define-skribe-module name . options)
`(begin
(define-module ,name
:use-module ((skribilo reader) :select (%default-reader))
:use-module (srfi srfi-1)
,@(append-map (lambda (mod)
(list :autoload (car mod) (cdr mod)))
%skribilo-user-autoloads)
,@options)
;; Pull all the bindings that Skribe code may expect, plus those needed
;; to actually create and read the module.
;; TODO: These should be auto-loaded.
,(cons 'use-modules %skribilo-user-imports)
;; Change the current reader to a Skribe-compatible reader. If this
;; primitive is not provided by Guile (i.e., version <= 1.7.2), then it
;; should be provided by `guile-reader' (version >= 0.3) as a core
;; binding and installed by `(skribilo utils syntax)'.
(fluid-set! current-reader %default-reader)))
;; Make it available to the top-level module.
(module-define! the-root-module
'define-skribe-module define-skribe-module)
;;;
;;; MAKE-RUN-TIME-MODULE
;;;
(define (make-run-time-module)
"Return a new module that imports all the necessary bindings required for
execution of Skribilo/Skribe code."
(let* ((the-module (make-module))
(autoloads (map (lambda (name+bindings)
(make-autoload-interface the-module
(car name+bindings)
(cdr name+bindings)))
%skribilo-user-autoloads)))
(set-module-name! the-module '(skribilo-user))
(module-use-interfaces! the-module
(cons the-root-module
(append (map resolve-interface
%skribilo-user-imports)
autoloads)))
the-module))
;; The current module in which the document is evaluated.
(define *skribilo-user-module* (make-parameter (make-run-time-module)))
;;; module.scm ends here
|
