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 (digits->letters str)
36 (regexp-substitute/global
38 (regexp-substitute/global
45 (+ (char->integer #\A)
46 (- (char->integer #\0))
47 (char->integer (string-ref (match:substring match 1) 0)))
53 (define-public (tex-font-command-raw name magnification)
56 (digits->letters (format "~a" name))
58 (string-encode-integer
59 (inexact->exact (round (* 1000 magnification))))))
61 (define-public (tex-font-command font)
63 (ly:font-file-name font) (ly:font-magnification font)))
65 (define (otf-font-load-command paper font)
66 (let* ((sub-fonts (ly:font-sub-fonts font)))
71 (format #f "\\font\\~a=~a scaled ~a%\n"
73 sub-name (ly:font-magnification font))
78 (ly:font-magnification font)
79 (ly:paper-outputscale paper)))))))
82 (define (simple-font-load-command paper font)
83 (let* ((coding-alist (ly:font-encoding-alist font))
84 (font-encoding (assoc-get 'output-name coding-alist)))
86 "\\font\\lilypond" (tex-font-command font) "="
87 (if (or (equal? (ly:font-encoding font) "cork-lm")
88 ;; FIXME: encoding: FontSpecific for cork-lm
89 (string-prefix? "lm" (ly:font-file-name font)))
91 (ly:font-file-name font)
93 (ly:number->string (inexact->exact
95 (ly:font-magnification font)
96 (ly:paper-outputscale paper)))))
98 "\\def\\" (tex-font-command font) "{%\n"
99 ;; UGH. Should be handled via alist.
100 (if (or (equal? "Extended-TeX-Font-Encoding---Latin" font-encoding)
102 " \\lilypondfontencoding{T1}"
104 "\\lilypond" (tex-font-command font)
107 (define (font-load-command paper font)
108 (if (pair? (ly:font-sub-fonts font))
109 (otf-font-load-command paper font)
110 (simple-font-load-command paper font)))
112 (define (define-fonts paper)
115 "\\def\\lilypondpaperunit{mm}%\n"
116 (tex-number-def "lilypondpaper" 'outputscale
117 (number->string (exact->inexact
118 (ly:paper-outputscale paper))))
119 (tex-string-def "lilypondpaper" 'papersize
120 (eval 'papersizename (ly:output-def-scope paper)))
122 (tex-string-def "lilypondpaper" 'inputencoding
123 (eval 'inputencoding (ly:output-def-scope paper)))
126 (map (lambda (x) (font-load-command paper x))
127 (ly:paper-fonts paper)))))
129 (define (header-to-file fn key val)
130 (set! key (symbol->string key))
131 (if (not (equal? "-" fn))
132 (set! fn (string-append fn "." key)))
134 (format (_ "Writing header field `~a' to `~a'...")
136 (if (equal? "-" fn) "<stdout>" fn))
137 (current-error-port))
140 (display val (open-file fn "w")))
141 (newline (current-error-port))
144 (define (output-scopes scopes fields basename)
145 (define (output-scope scope)
150 (let ((val (if (variable-bound? var) (variable-ref var) "")))
151 (if (and (memq sym fields) (string? val))
152 (header-to-file basename sym val))
155 (apply string-append (map output-scope scopes)))
157 (define (tex-string-def prefix key str)
158 (if (equal? "" (sans-surrounding-whitespace (sanitize-tex-string str)))
159 (string-append "\\let\\" prefix (symbol->tex-key key) "\\undefined%\n")
160 (string-append "\\def\\" prefix (symbol->tex-key key)
161 "{" (sanitize-tex-string str) "}%\n")))
163 (define (header paper page-count classic?)
164 (let ((scale (ly:output-def-lookup paper 'outputscale))
165 (texpaper (string-append
166 (ly:output-def-lookup paper 'papersizename)
168 (landscape? (eq? #t (ly:output-def-lookup paper 'landscape))))
170 "% Generated by LilyPond "
171 (lilypond-version) "\n"
172 "% at " "time-stamp,FIXME" "\n"
174 (tex-string-def "lilypond" 'classic "1")
177 (if (ly:get-option 'safe)
182 "lilypondpaper" 'linewidth
183 (ly:number->string (* scale (ly:output-def-lookup paper 'linewidth))))
184 "\\def\\lilyponddocumentclassoptions{"
185 (sanitize-tex-string texpaper)
186 (if landscape? ",landscape" "")
189 "lilypondpaper" 'interscoreline
191 (* scale (ly:output-def-lookup paper 'interscoreline)))))))
195 "\\def\\scaletounit{ "
196 (number->string (cond
197 ((equal? (ly:unit) "mm") (/ 72.0 25.4))
198 ((equal? (ly:unit) "pt") (/ 72.0 72.27))
199 (else (error "unknown unit" (ly:unit)))))
201 "\\ifx\\lilypondstart\\undefined\n"
202 " \\input lilyponddefs\n"
205 "\\lilypondspecial\n"
206 "\\lilypondpostscript\n"))
208 (define (dump-page putter page last? with-extents?)
209 (ly:outputter-dump-string
211 (format "\\lybox{~a}{~a}{%\n"
213 (interval-start (ly:stencil-extent page X))
216 (- (interval-start (ly:stencil-extent page Y)))
218 (ly:outputter-dump-stencil putter page)
219 (ly:outputter-dump-string
223 "}%\n\\vfill\n\\lilypondpagebreak\n")))
225 (define-public (output-framework outputter book scopes fields basename )
226 (let* ((paper (ly:paper-book-paper book))
227 (pages (ly:paper-book-pages book))
228 (last-page (car (last-pair pages)))
230 (eq? #t (ly:output-def-lookup paper 'dump-extents))))
233 (ly:outputter-dump-string outputter x))
235 (header paper (length pages) #f)
238 (ly:outputter-dump-string outputter "\\lilypondnopagebreak\n")
241 (dump-page outputter page (eq? last-page page) with-extents))
243 (ly:outputter-dump-string outputter "\\lilypondend\n")))
245 (define (dump-line putter line last?)
246 (ly:outputter-dump-string
248 (format "\\lybox{~a}{~a}{%\n"
250 (max 0 (interval-end (ly:paper-system-extent line X))))
252 (interval-length (ly:paper-system-extent line Y)))))
254 (ly:outputter-dump-stencil putter (ly:paper-system-stencil line))
255 (ly:outputter-dump-string
259 "}\\interscoreline\n")))
261 (define-public (output-classic-framework
262 outputter book scopes fields basename)
263 (let* ((paper (ly:paper-book-paper book))
264 (lines (ly:paper-book-systems book))
265 (last-line (car (last-pair lines))))
268 (ly:outputter-dump-string outputter x))
271 (header paper (length lines) #f)
272 "\\def\\lilypondclassic{1}%\n"
273 (output-scopes scopes fields basename)
278 (lambda (line) (dump-line outputter line (eq? line last-line))) lines)
279 (ly:outputter-dump-string outputter "\\lilypondend\n")))
281 (define-public (output-preview-framework
282 outputter book scopes fields basename )
283 (let* ((paper (ly:paper-book-paper book))
284 (lines (ly:paper-book-systems book))
285 (first-notes-index (list-index
286 (lambda (s) (not (ly:paper-system-title? s)))
291 (ly:outputter-dump-string outputter x))
295 (header paper (length lines) #f)
296 "\\def\\lilypondclassic{1}%\n"
297 (output-scopes scopes fields basename)
303 (dump-line outputter lst (not (ly:paper-system-title? lst))))
304 (take lines (1+ first-notes-index)))
305 (ly:outputter-dump-string outputter "\\lilypondend\n")))
307 (define-public (convert-to-pdf book name)
308 (let* ((defs (ly:paper-book-paper book))
309 (papersizename (ly:output-def-lookup defs 'papersizename)))
310 (postscript->pdf (if (string? papersizename) papersizename "a4")
312 (basename name ".tex")
315 (define-public (convert-to-png book name)
316 (let* ((defs (ly:paper-book-paper book))
317 (resolution (ly:output-def-lookup defs 'pngresolution)))
319 (if (number? resolution)
321 (ly:get-option 'resolution))
322 (string-append (basename name ".tex") ".ps"))))
324 (define-public (convert-to-ps book name)
325 (let* ((paper (ly:paper-book-paper book))
326 (preview? (string-contains name ".preview"))
328 (papersizename (ly:output-def-lookup paper 'papersizename))
329 (landscape? (eq? #t (ly:output-def-lookup paper 'landscape)))
330 (base (basename name ".tex"))
331 (cmd (string-append "dvips "
336 ;; careful: papersizename is user-set.
337 (sanitize-command-option papersizename)
339 (if landscape? "-t landscape " "")
340 (if (ly:kpathsea-find-file "lm.map")
342 (if (ly:kpathsea-find-file "ecrm10.pfa")
343 "-u+ec-mftrace.map " "")
344 "-u+lilypond.map -Ppdf " ""
346 (let ((ps-name (string-append base ".ps")))
347 (if (access? ps-name W_OK)
348 (delete-file ps-name)))
349 (if (not (ly:get-option 'verbose))
351 (format (current-error-port) (_ "Converting to `~a.ps'...") base)
352 (newline (current-error-port))))
355 (define-public (convert-to-dvi book name)
356 (let* ((curr-extra-mem
358 (regexp-substitute/global
360 (ly:kpathsea-expand-variable "$extra_mem_top")
362 (base (basename name ".tex"))
364 "latex \\\\nonstopmode \\\\input " name)))
365 (setenv "extra_mem_top" (number->string (max curr-extra-mem 1024000)))
366 (let ((dvi-name (string-append base ".dvi")))
367 (if (access? dvi-name W_OK)
368 (delete-file dvi-name)))
369 (if (not (ly:get-option 'verbose))
371 (format (current-error-port) (_ "Converting to `~a.dvi'...") base)
372 (newline (current-error-port))))
374 ;; fixme: set in environment?
375 (if (ly:get-option 'safe)
376 (set! cmd (string-append "openout_any=p " cmd)))
380 (define-public (convert-to-tex book name)