1 ;;;; framework-tex.scm --
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 (define-module (scm framework-tex)
8 #:export (output-framework-tex
9 output-classic-framework-tex))
11 (use-modules (ice-9 regex)
19 (define-public (sanitize-tex-string s)
20 (if (ly:get-option 'safe)
21 (regexp-substitute/global
23 (regexp-substitute/global #f "([{}])" s 'pre "\\" 1 'post )
24 'pre "$\\backslash$" 'post)
27 (define (symbol->tex-key sym)
28 (regexp-substitute/global
29 #f "_" (sanitize-tex-string (symbol->string sym)) 'pre "X" 'post) )
31 (define (tex-number-def prefix key number)
33 "\\def\\" prefix (symbol->tex-key key) "{" number "}%\n"))
35 (define-public (tex-font-command font)
38 (string-encode-integer
39 (hashq (ly:font-filename font) 1000000))
41 (string-encode-integer
42 (inexact->exact (round (* 1000 (ly:font-magnification font)))))))
44 (define (font-load-command paper font)
45 (let* ((coding-alist (ly:font-encoding-alist font))
46 (font-encoding (assoc-get 'output-name coding-alist)))
48 "\\font\\lilypond" (tex-font-command font) "="
49 (ly:font-filename font)
51 (ly:number->string (inexact->exact
53 (ly:font-magnification font)
54 (ly:paper-outputscale paper)))))
56 "\\def\\" (tex-font-command font) "{%\n"
57 ;; UGH. Should be handled via alist.
58 (if (or (equal? "Extended-TeX-Font-Encoding---Latin" font-encoding)
60 " \\lilypondfontencoding{T1}"
62 "\\lilypond" (tex-font-command font)
65 (define (define-fonts paper)
68 "\\def\\lilypondpaperunit{mm}%\n"
69 (tex-number-def "lilypondpaper" 'outputscale
70 (number->string (exact->inexact
71 (ly:paper-outputscale paper))))
72 (tex-string-def "lilypondpaper" 'papersize
73 (eval 'papersizename (ly:output-def-scope paper)))
75 (tex-string-def "lilypondpaper" 'inputencoding
76 (eval 'inputencoding (ly:output-def-scope paper)))
79 (map (lambda (x) (font-load-command paper x))
80 (ly:paper-fonts paper)))))
82 (define (header-to-file fn key val)
83 (set! key (symbol->string key))
84 (if (not (equal? "-" fn))
85 (set! fn (string-append fn "." key)))
87 (format (_ "Writing header field `~a' to `~a'...")
89 (if (equal? "-" fn) "<stdout>" fn))
93 (display val (open-file fn "w")))
94 (newline (current-error-port))
97 (define (output-scopes scopes fields basename)
98 (define (output-scope scope)
103 (let ((val (if (variable-bound? var) (variable-ref var) "")))
104 (if (and (memq sym fields) (string? val))
105 (header-to-file basename sym val))
108 (apply string-append (map output-scope scopes)))
110 (define (tex-string-def prefix key str)
111 (if (equal? "" (sans-surrounding-whitespace (sanitize-tex-string str)))
112 (string-append "\\let\\" prefix (symbol->tex-key key) "\\undefined%\n")
113 (string-append "\\def\\" prefix (symbol->tex-key key)
114 "{" (sanitize-tex-string str) "}%\n")))
116 (define (header paper page-count classic?)
117 (let ((scale (ly:output-def-lookup paper 'outputscale))
118 (texpaper (string-append
119 (ly:output-def-lookup paper 'papersizename)
121 (landscape? (eq? #t (ly:output-def-lookup paper 'landscape))))
123 "% Generated by LilyPond "
124 (lilypond-version) "\n"
125 "% at " "time-stamp,FIXME" "\n"
127 (tex-string-def "lilypond" 'classic "1")
130 (if (ly:get-option 'safe)
135 "lilypondpaper" 'linewidth
136 (ly:number->string (* scale (ly:output-def-lookup paper 'linewidth))))
137 "\\def\\lilyponddocumentclassoptions{"
138 (sanitize-tex-string texpaper)
139 (if landscape? ",landscape" "")
142 "lilypondpaper" 'interscoreline
144 (* scale (ly:output-def-lookup paper 'interscoreline)))))))
148 "\\def\\scaletounit{ "
149 (number->string (cond
150 ((equal? (ly:unit) "mm") (/ 72.0 25.4))
151 ((equal? (ly:unit) "pt") (/ 72.0 72.27))
152 (else (error "unknown unit" (ly:unit)))))
154 "\\ifx\\lilypondstart\\undefined\n"
155 " \\input lilyponddefs\n"
158 "\\lilypondspecial\n"
159 "\\lilypondpostscript\n"))
161 (define (dump-page putter page last? with-extents?)
162 (ly:outputter-dump-string
164 (format "\\lybox{~a}{~a}{%\n"
166 (interval-start (ly:stencil-extent page X))
169 (- (interval-start (ly:stencil-extent page Y)))
171 (ly:outputter-dump-stencil putter page)
172 (ly:outputter-dump-string
176 "}%\n\\vfill\n\\lilypondpagebreak\n")))
178 (define-public (output-framework outputter book scopes fields basename )
179 (let* ((paper (ly:paper-book-paper book))
180 (pages (ly:paper-book-pages book))
181 (last-page (car (last-pair pages)))
183 (eq? #t (ly:output-def-lookup paper 'dump-extents))))
186 (ly:outputter-dump-string outputter x))
188 (header paper (length pages) #f)
191 (ly:outputter-dump-string outputter "\\lilypondnopagebreak\n")
194 (dump-page outputter page (eq? last-page page) with-extents))
196 (ly:outputter-dump-string outputter "\\lilypondend\n")))
198 (define (dump-line putter line last?)
199 (ly:outputter-dump-string
201 (format "\\lybox{~a}{~a}{%\n"
203 (max 0 (interval-end (ly:paper-system-extent line X))))
205 (interval-length (ly:paper-system-extent line Y)))))
207 (ly:outputter-dump-stencil putter (ly:paper-system-stencil line))
208 (ly:outputter-dump-string
212 "}\\interscoreline\n")))
214 (define-public (output-classic-framework
215 outputter book scopes fields basename)
216 (let* ((paper (ly:paper-book-paper book))
217 (lines (ly:paper-book-systems book))
218 (last-line (car (last-pair lines))))
221 (ly:outputter-dump-string outputter x))
224 (header paper (length lines) #f)
225 "\\def\\lilypondclassic{1}%\n"
226 (output-scopes scopes fields basename)
231 (lambda (line) (dump-line outputter line (eq? line last-line))) lines)
232 (ly:outputter-dump-string outputter "\\lilypondend\n")))
234 (define-public (output-preview-framework
235 outputter book scopes fields basename )
236 (let* ((paper (ly:paper-book-paper book))
237 (lines (ly:paper-book-systems book))
238 (first-notes-index (list-index
239 (lambda (s) (not (ly:paper-system-title? s)))
244 (ly:outputter-dump-string outputter x))
248 (header paper (length lines) #f)
249 "\\def\\lilypondclassic{1}%\n"
250 (output-scopes scopes fields basename)
256 (dump-line outputter l (not (ly:paper-system-title? l))))
257 (take lines (1+ first-notes-index)))
258 (ly:outputter-dump-string outputter "\\lilypondend\n")))
260 (define-public (convert-to-pdf book name)
261 (let* ((defs (ly:paper-book-paper book))
262 (papersizename (ly:output-def-lookup defs 'papersizename)))
263 (postscript->pdf (if (string? papersizename) papersizename "a4")
265 (basename name ".tex")
268 (define-public (convert-to-png book name)
269 (let* ((defs (ly:paper-book-paper book))
270 (resolution (ly:output-def-lookup defs 'pngresolution)))
272 (if (number? resolution)
274 (ly:get-option 'resolution))
275 (string-append (basename name ".tex") ".ps"))))
277 (define-public (convert-to-ps book name)
278 (let* ((paper (ly:paper-book-paper book))
279 (preview? (string-contains name ".preview"))
281 (papersizename (ly:output-def-lookup paper 'papersizename))
282 (landscape? (eq? #t (ly:output-def-lookup paper 'landscape)))
283 (base (basename name ".tex"))
284 (cmd (string-append "dvips "
290 ;; careful: papersizename is user-set.
291 (sanitize-command-option papersizename)))
296 " -u+ec-mftrace.map -u+lilypond.map -Ppdf "
299 (let ((ps-name (string-append base ".ps")))
300 (if (access? ps-name W_OK)
301 (delete-file ps-name)))
302 (if (not (ly:get-option 'verbose))
304 (format (current-error-port) (_ "Converting to `~a.ps'...") base)
305 (newline (current-error-port))))
308 (define-public (convert-to-dvi book name)
309 (let* ((curr-extra-mem
311 (regexp-substitute/global
313 (ly:kpathsea-expand-variable "$extra_mem_top")
315 (base (basename name ".tex"))
317 "latex \\\\nonstopmode \\\\input " name)))
318 (setenv "extra_mem_top" (number->string (max curr-extra-mem 1024000)))
319 (let ((dvi-name (string-append base ".dvi")))
320 (if (access? dvi-name W_OK)
321 (delete-file dvi-name)))
322 (if (not (ly:get-option 'verbose))
324 (format (current-error-port) (_ "Converting to `~a.dvi'...") base)
325 (newline (current-error-port))))
327 ;; fixme: set in environment?
328 (if (ly:get-option 'safe)
329 (set! cmd (string-append "openout_any=p " cmd)))
333 (define-public (convert-to-tex book name)