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-file-name 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 (if (or (equal? (ly:font-encoding font) "cork-lm")
50 ;; FIXME: encoding: FontSpecific for cork-lm
51 (string-prefix? "lm" (ly:font-file-name font)))
53 (ly:font-file-name font)
55 (ly:number->string (inexact->exact
57 (ly:font-magnification font)
58 (ly:paper-outputscale paper)))))
60 "\\def\\" (tex-font-command font) "{%\n"
61 ;; UGH. Should be handled via alist.
62 (if (or (equal? "Extended-TeX-Font-Encoding---Latin" font-encoding)
64 " \\lilypondfontencoding{T1}"
66 "\\lilypond" (tex-font-command font)
69 (define (define-fonts paper)
72 "\\def\\lilypondpaperunit{mm}%\n"
73 (tex-number-def "lilypondpaper" 'outputscale
74 (number->string (exact->inexact
75 (ly:paper-outputscale paper))))
76 (tex-string-def "lilypondpaper" 'papersize
77 (eval 'papersizename (ly:output-def-scope paper)))
79 (tex-string-def "lilypondpaper" 'inputencoding
80 (eval 'inputencoding (ly:output-def-scope paper)))
83 (map (lambda (x) (font-load-command paper x))
84 (ly:paper-fonts paper)))))
86 (define (header-to-file fn key val)
87 (set! key (symbol->string key))
88 (if (not (equal? "-" fn))
89 (set! fn (string-append fn "." key)))
91 (format (_ "Writing header field `~a' to `~a'...")
93 (if (equal? "-" fn) "<stdout>" fn))
97 (display val (open-file fn "w")))
98 (newline (current-error-port))
101 (define (output-scopes scopes fields basename)
102 (define (output-scope scope)
107 (let ((val (if (variable-bound? var) (variable-ref var) "")))
108 (if (and (memq sym fields) (string? val))
109 (header-to-file basename sym val))
112 (apply string-append (map output-scope scopes)))
114 (define (tex-string-def prefix key str)
115 (if (equal? "" (sans-surrounding-whitespace (sanitize-tex-string str)))
116 (string-append "\\let\\" prefix (symbol->tex-key key) "\\undefined%\n")
117 (string-append "\\def\\" prefix (symbol->tex-key key)
118 "{" (sanitize-tex-string str) "}%\n")))
120 (define (header paper page-count classic?)
121 (let ((scale (ly:output-def-lookup paper 'outputscale))
122 (texpaper (string-append
123 (ly:output-def-lookup paper 'papersizename)
125 (landscape? (eq? #t (ly:output-def-lookup paper 'landscape))))
127 "% Generated by LilyPond "
128 (lilypond-version) "\n"
129 "% at " "time-stamp,FIXME" "\n"
131 (tex-string-def "lilypond" 'classic "1")
134 (if (ly:get-option 'safe)
139 "lilypondpaper" 'linewidth
140 (ly:number->string (* scale (ly:output-def-lookup paper 'linewidth))))
141 "\\def\\lilyponddocumentclassoptions{"
142 (sanitize-tex-string texpaper)
143 (if landscape? ",landscape" "")
146 "lilypondpaper" 'interscoreline
148 (* scale (ly:output-def-lookup paper 'interscoreline)))))))
152 "\\def\\scaletounit{ "
153 (number->string (cond
154 ((equal? (ly:unit) "mm") (/ 72.0 25.4))
155 ((equal? (ly:unit) "pt") (/ 72.0 72.27))
156 (else (error "unknown unit" (ly:unit)))))
158 "\\ifx\\lilypondstart\\undefined\n"
159 " \\input lilyponddefs\n"
162 "\\lilypondspecial\n"
163 "\\lilypondpostscript\n"))
165 (define (dump-page putter page last? with-extents?)
166 (ly:outputter-dump-string
168 (format "\\lybox{~a}{~a}{%\n"
170 (interval-start (ly:stencil-extent page X))
173 (- (interval-start (ly:stencil-extent page Y)))
175 (ly:outputter-dump-stencil putter page)
176 (ly:outputter-dump-string
180 "}%\n\\vfill\n\\lilypondpagebreak\n")))
182 (define-public (output-framework outputter book scopes fields basename )
183 (let* ((paper (ly:paper-book-paper book))
184 (pages (ly:paper-book-pages book))
185 (last-page (car (last-pair pages)))
187 (eq? #t (ly:output-def-lookup paper 'dump-extents))))
190 (ly:outputter-dump-string outputter x))
192 (header paper (length pages) #f)
195 (ly:outputter-dump-string outputter "\\lilypondnopagebreak\n")
198 (dump-page outputter page (eq? last-page page) with-extents))
200 (ly:outputter-dump-string outputter "\\lilypondend\n")))
202 (define (dump-line putter line last?)
203 (ly:outputter-dump-string
205 (format "\\lybox{~a}{~a}{%\n"
207 (max 0 (interval-end (ly:paper-system-extent line X))))
209 (interval-length (ly:paper-system-extent line Y)))))
211 (ly:outputter-dump-stencil putter (ly:paper-system-stencil line))
212 (ly:outputter-dump-string
216 "}\\interscoreline\n")))
218 (define-public (output-classic-framework
219 outputter book scopes fields basename)
220 (let* ((paper (ly:paper-book-paper book))
221 (lines (ly:paper-book-systems book))
222 (last-line (car (last-pair lines))))
225 (ly:outputter-dump-string outputter x))
228 (header paper (length lines) #f)
229 "\\def\\lilypondclassic{1}%\n"
230 (output-scopes scopes fields basename)
235 (lambda (line) (dump-line outputter line (eq? line last-line))) lines)
236 (ly:outputter-dump-string outputter "\\lilypondend\n")))
238 (define-public (output-preview-framework
239 outputter book scopes fields basename )
240 (let* ((paper (ly:paper-book-paper book))
241 (lines (ly:paper-book-systems book))
242 (first-notes-index (list-index
243 (lambda (s) (not (ly:paper-system-title? s)))
248 (ly:outputter-dump-string outputter x))
252 (header paper (length lines) #f)
253 "\\def\\lilypondclassic{1}%\n"
254 (output-scopes scopes fields basename)
260 (dump-line outputter l (not (ly:paper-system-title? l))))
261 (take lines (1+ first-notes-index)))
262 (ly:outputter-dump-string outputter "\\lilypondend\n")))
264 (define-public (convert-to-pdf book name)
265 (let* ((defs (ly:paper-book-paper book))
266 (papersizename (ly:output-def-lookup defs 'papersizename)))
267 (postscript->pdf (if (string? papersizename) papersizename "a4")
269 (basename name ".tex")
272 (define-public (convert-to-png book name)
273 (let* ((defs (ly:paper-book-paper book))
274 (resolution (ly:output-def-lookup defs 'pngresolution)))
276 (if (number? resolution)
278 (ly:get-option 'resolution))
279 (string-append (basename name ".tex") ".ps"))))
281 (define-public (convert-to-ps book name)
282 (let* ((paper (ly:paper-book-paper book))
283 (preview? (string-contains name ".preview"))
285 (papersizename (ly:output-def-lookup paper 'papersizename))
286 (landscape? (eq? #t (ly:output-def-lookup paper 'landscape)))
287 (base (basename name ".tex"))
288 (cmd (string-append "dvips "
293 ;; careful: papersizename is user-set.
294 (sanitize-command-option papersizename)
296 (if landscape? "-t landscape " "")
297 (if (ly:kpathsea-find-file "lm.map")
299 (if (ly:kpathsea-find-file "ecrm10.pfa")
300 "-u+ec-mftrace.map " "")
301 "-u+lilypond.map -Ppdf " ""
303 (let ((ps-name (string-append base ".ps")))
304 (if (access? ps-name W_OK)
305 (delete-file ps-name)))
306 (if (not (ly:get-option 'verbose))
308 (format (current-error-port) (_ "Converting to `~a.ps'...") base)
309 (newline (current-error-port))))
312 (define-public (convert-to-dvi book name)
313 (let* ((curr-extra-mem
315 (regexp-substitute/global
317 (ly:kpathsea-expand-variable "$extra_mem_top")
319 (base (basename name ".tex"))
321 "latex \\\\nonstopmode \\\\input " name)))
322 (setenv "extra_mem_top" (number->string (max curr-extra-mem 1024000)))
323 (let ((dvi-name (string-append base ".dvi")))
324 (if (access? dvi-name W_OK)
325 (delete-file dvi-name)))
326 (if (not (ly:get-option 'verbose))
328 (format (current-error-port) (_ "Converting to `~a.dvi'...") base)
329 (newline (current-error-port))))
331 ;; fixme: set in environment?
332 (if (ly:get-option 'safe)
333 (set! cmd (string-append "openout_any=p " cmd)))
337 (define-public (convert-to-tex book name)