1 1;;;; framework-tex.scm --
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2004--2005 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)
20 (define (output-formats)
21 (define formats (ly:output-formats))
22 (set! formats (completize-formats formats))
23 (if (member "ps" formats)
24 (set! formats (cons "dvi" formats)))
25 (if (member "dvi" formats)
26 (set! formats (cons "tex" formats)))
30 (define framework-tex-module (current-module))
31 (define-public (sanitize-tex-string s)
32 (if (ly:get-option 'safe)
33 (regexp-substitute/global
35 (regexp-substitute/global #f "([{}])" s 'pre "\\" 1 'post)
36 'pre "$\\backslash$" 'post)
39 (define (symbol->tex-key sym)
40 (regexp-substitute/global
41 #f "_" (sanitize-tex-string (symbol->string sym)) 'pre "X" 'post))
43 (define (tex-number-def prefix key number)
45 "\\def\\" prefix (symbol->tex-key key) "{" number "}%\n"))
47 (define-public (digits->letters str)
48 (regexp-substitute/global
50 (regexp-substitute/global
57 (+ (char->integer #\A)
58 (- (char->integer #\0))
59 (char->integer (string-ref (match:substring match 1) 0)))
65 (define-public (tex-font-command-raw name magnification)
68 (digits->letters (format "~a" name))
70 (string-encode-integer
71 (inexact->exact (round (* 1000 magnification))))))
73 (define-public (tex-font-command font)
75 (ly:font-file-name font) (ly:font-magnification font)))
77 (define (otf-font-load-command paper font)
78 (let* ((sub-fonts (ly:font-sub-fonts font)))
83 (format #f "\\font\\~a=~a scaled ~a%\n"
85 sub-name (ly:font-magnification font))
90 (ly:font-magnification font)
91 (ly:paper-outputscale paper)))))))
94 (define (simple-font-load-command paper font)
96 "\\font\\~a=~a scaled ~a%\n"
97 (tex-font-command font)
98 (ly:font-file-name font)
101 (ly:font-magnification font)
102 (ly:paper-outputscale paper))))))
104 (define (font-load-command paper font)
105 (if (pair? (ly:font-sub-fonts font))
106 (otf-font-load-command paper font)
107 (simple-font-load-command paper font)))
109 (define (define-fonts paper)
112 "\\def\\lilypondpaperunit{mm}%\n"
113 (tex-number-def "lilypondpaper" 'outputscale
114 (number->string (exact->inexact
115 (ly:paper-outputscale paper))))
116 (tex-string-def "lilypondpaper" 'papersize
117 (eval 'papersizename (ly:output-def-scope paper)))
119 (tex-string-def "lilypondpaper" 'inputencoding
120 (eval 'inputencoding (ly:output-def-scope paper)))
123 (map (lambda (x) (font-load-command paper x))
124 (ly:paper-fonts paper)))))
126 (define (tex-string-def prefix key str)
127 (if (equal? "" (sans-surrounding-whitespace (sanitize-tex-string str)))
128 (string-append "\\let\\" prefix (symbol->tex-key key) "\\undefined%\n")
129 (string-append "\\def\\" prefix (symbol->tex-key key)
130 "{" (sanitize-tex-string str) "}%\n")))
132 (define (header paper page-count classic?)
133 (let ((scale (ly:output-def-lookup paper 'outputscale))
134 (texpaper (string-append
135 (ly:output-def-lookup paper 'papersizename)
137 (landscape? (eq? #t (ly:output-def-lookup paper 'landscape))))
139 "% Generated by LilyPond "
140 (lilypond-version) "\n"
141 "% at " "time-stamp,FIXME" "\n"
143 (tex-string-def "lilypond" 'classic "1")
146 (if (ly:get-option 'safe)
151 "lilypondpaper" 'linewidth
152 (ly:number->string (* scale (ly:output-def-lookup paper 'linewidth))))
153 "\\def\\lilyponddocumentclassoptions{"
154 (sanitize-tex-string texpaper)
155 (if landscape? ",landscape" "")
158 "lilypondpaper" 'interscoreline
160 (* scale (ly:output-def-lookup paper 'interscoreline)))))))
164 "\\def\\scaletounit{ "
165 (number->string (cond
166 ((equal? (ly:unit) "mm") (/ 72.0 25.4))
167 ((equal? (ly:unit) "pt") (/ 72.0 72.27))
168 (else (error "unknown unit" (ly:unit)))))
170 "\\ifx\\lilypondstart\\undefined\n"
171 " \\input lilyponddefs\n"
174 "\\lilypondspecial\n"
175 "\\lilypondpostscript\n"))
177 (define (dump-page putter page last? with-extents?)
178 (ly:outputter-dump-string
180 (format "\\lybox{~a}{~a}{%\n"
182 (interval-start (ly:stencil-extent page X))
185 (- (interval-start (ly:stencil-extent page Y)))
187 (ly:outputter-dump-stencil putter page)
188 (ly:outputter-dump-string
192 "}%\n\\vfill\n\\lilypondpagebreak\n")))
194 (define-public (output-framework basename book scopes fields)
195 (let* ((filename (format "~a.tex" basename))
196 (outputter (ly:make-paper-outputter filename "tex"))
197 (paper (ly:paper-book-paper book))
198 (pages (ly:paper-book-pages book))
199 (last-page (car (last-pair pages)))
201 (eq? #t (ly:output-def-lookup paper 'dump-extents))))
204 (ly:outputter-dump-string outputter x))
206 (header paper (length pages) #f)
209 (ly:outputter-dump-string outputter "\\lilypondnopagebreak\n")
212 (dump-page outputter page (eq? last-page page) with-extents))
214 (ly:outputter-dump-string outputter "\\lilypondend\n")
215 (ly:outputter-close outputter)
216 (postprocess-output book framework-tex-module filename
219 (define (dump-line putter line last?)
220 (ly:outputter-dump-string
222 (format "\\lybox{~a}{~a}{%\n"
224 (max 0 (interval-end (ly:paper-system-extent line X))))
226 (interval-length (ly:paper-system-extent line Y)))))
228 (ly:outputter-dump-stencil putter (ly:paper-system-stencil line))
229 (ly:outputter-dump-string
233 "}\\interscoreline\n")))
235 (define-public (output-classic-framework
236 basename book scopes fields)
237 (let* ((filename (format "~a.tex" basename))
238 (outputter (ly:make-paper-outputter filename "tex"))
239 (paper (ly:paper-book-paper book))
240 (lines (ly:paper-book-systems book))
241 (last-line (car (last-pair lines))))
244 (ly:outputter-dump-string outputter x))
247 (header paper (length lines) #f)
248 "\\def\\lilypondclassic{1}%\n"
249 (output-scopes scopes fields basename)
254 (lambda (line) (dump-line outputter line (eq? line last-line))) lines)
255 (ly:outputter-dump-string outputter "\\lilypondend\n")
256 (ly:outputter-close outputter)
257 (postprocess-output book framework-tex-module filename
261 (define-public (output-preview-framework
262 basename book scopes fields)
263 (let* ((filename (format "~a.tex" basename))
264 (outputter (ly:make-paper-outputter filename
266 (paper (ly:paper-book-paper book))
267 (lines (ly:paper-book-systems book))
268 (first-notes-index (list-index
269 (lambda (s) (not (ly:paper-system-title? s)))
274 (ly:outputter-dump-string outputter x))
278 (header paper (length lines) #f)
279 "\\def\\lilypondclassic{1}%\n"
280 (output-scopes scopes fields basename)
286 (dump-line outputter lst (not (ly:paper-system-title? lst))))
287 (take lines (1+ first-notes-index)))
288 (ly:outputter-dump-string outputter "\\lilypondend\n")
289 (ly:outputter-close outputter)
290 (postprocess-output book framework-tex-module filename
295 (define-public (convert-to-pdf book name)
296 (let* ((defs (ly:paper-book-paper book))
297 (papersizename (ly:output-def-lookup defs 'papersizename)))
298 (postscript->pdf (if (string? papersizename) papersizename "a4")
300 (basename name ".tex")
303 (define-public (convert-to-png book name)
304 (let* ((defs (ly:paper-book-paper book))
305 (resolution (ly:output-def-lookup defs 'pngresolution))
306 (papersizename (ly:output-def-lookup defs 'papersizename)))
308 (if (number? resolution) resolution (ly:get-option 'resolution))
309 (if (string? papersizename) papersizename "a4")
310 (string-append (basename name ".tex") ".ps"))))
312 (define-public (convert-to-ps book name)
313 (let* ((paper (ly:paper-book-paper book))
314 (preview? (string-contains name ".preview"))
316 (papersizename (ly:output-def-lookup paper 'papersizename))
317 (landscape? (eq? #t (ly:output-def-lookup paper 'landscape)))
318 (base (basename name ".tex"))
319 (ps-name (format "~a.ps" base ".ps"))
320 (cmd (string-append "dvips "
325 ;; careful: papersizename is user-set.
326 (sanitize-command-option papersizename)
328 (if landscape? "-t landscape " "")
329 (if (ly:kpathsea-find-file "lm.map")
331 (if (ly:kpathsea-find-file "ecrm10.pfa")
332 "-u+ec-mftrace.map " "")
333 "-u+lilypond.map -Ppdf " ""
336 (if (access? ps-name W_OK)
337 (delete-file ps-name)))
338 (if (not (ly:get-option 'verbose))
340 (format (current-error-port) (_ "Converting to `~a'...")
341 (string-append base ".dvi"))
342 (newline (current-error-port))))
345 (define-public (convert-to-dvi book name)
346 (let* ((curr-extra-mem
348 (regexp-substitute/global
350 (ly:kpathsea-expand-variable "$extra_mem_top")
352 (base (basename name ".tex"))
354 #f "latex \\\\nonstopmode \\\\input '~a'" name)))
356 ;; FIXME: latex 'foo bar' works, but \input 'foe bar' does not?
357 (if (string-index name (char-set #\space #\ht #\newline #\cr))
360 (_"TeX file name must not contain whitespace: `~a'") name)))
362 (setenv "extra_mem_top" (number->string (max curr-extra-mem 1024000)))
363 (let ((dvi-name (string-append base ".dvi")))
364 (if (access? dvi-name W_OK)
365 (delete-file dvi-name)))
366 (if (not (ly:get-option 'verbose))
368 (format (current-error-port) (_ "Converting to `~a'...")
369 (string-append base ".dvi"))
370 (newline (current-error-port))))
372 ;; FIXME: set in environment?
373 (if (ly:get-option 'safe)
374 (set! cmd (string-append "openout_any=p " cmd)))
378 (define-public (convert-to-tex book name)