1 ;;; tex.scm -- implement Scheme output routines for TeX
3 ;;; source file of the GNU LilyPond music typesetter
5 ;;; (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;; Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 (define-module (scm output-tex) )
10 ; (debug-enable 'backtrace)
11 (use-modules (scm output-ps)
20 (define this-module (current-module))
26 (define font-name-alist '())
28 (define (tex-encoded-fontswitch name-mag)
29 (let* ((iname-mag (car name-mag))
30 (ename-mag (cdr name-mag)))
34 (string-append "magfont"
35 (string-encode-integer
36 (hashq (car ename-mag) 1000000))
38 (string-encode-integer
39 (inexact->exact (round (* 1000 (cdr ename-mag))))))))))
41 (define (define-fonts internal-external-name-mag-pairs)
42 (set! font-name-alist (map tex-encoded-fontswitch
43 internal-external-name-mag-pairs))
46 (font-load-command (car x) (cdr x)))
47 (map cdr font-name-alist))))
51 ;; urg, how can exp be #unspecified? -- in sketch output
53 ;; set! returns #<unspecified> --hwn
54 (define (fontify name-mag-pair exp)
55 (string-append (select-font name-mag-pair)
62 (define (symbol->tex-key sym)
63 (regexp-substitute/global
64 #f "_" (output-tex-string (symbol->string sym)) 'pre "X" 'post) )
66 (define (tex-string-def prefix key str)
67 (if (equal? "" (sans-surrounding-whitespace (output-tex-string str)))
68 (string-append "\\let\\" prefix (symbol->tex-key key) "\\undefined%\n")
69 (string-append "\\def\\" prefix (symbol->tex-key key) "{" (output-tex-string str) "}%\n")
72 (define (output-paper-def pd)
78 ((val (variable-ref var))
79 (key (symbol->tex-key sym))
84 (tex-string-def "lilypondpaper" sym val))
86 (string-append "\\def\\lilypondpaper" key "{"
89 (number->string (exact->inexact val)))
94 (ly:output-def-scope pd))
97 (define (output-scopes scopes fields basename)
98 (define (output-scope scope)
104 ((val (variable-ref var))
105 (tex-key (symbol->string sym))
107 (if (memq sym fields)
108 (header-to-file basename sym val))
112 (tex-string-def "lilypond" sym val) )
114 (string-append "\\def\\" tex-key "{"
117 (number->string (exact->inexact val)))
126 (map output-scope scopes)) )
129 (define (select-font name-mag-pair)
132 (c (assoc name-mag-pair font-name-alist))
137 (ly:warn (string-append
138 "Programming error: No such font known "
139 (car name-mag-pair) " "
140 (ly:number->string (cdr name-mag-pair))))
142 (display "FAILED\n" (current-error-port))
143 (if #f ;(pair? name-mag-pair))
144 (display (object-type (car name-mag-pair)) (current-error-port))
145 (write name-mag-pair (current-error-port)))
146 (if #f ; (pair? font-name-alist)
148 (object-type (caaar font-name-alist)) (current-error-port))
149 (write font-name-alist (current-error-port)))
151 ;; (format #f "\n%FAILED: (select-font ~S)\n" name-mag-pair))
154 (string-append "\\" (cddr c)))))
156 (define (top-of-file)
158 "% generated by LilyPond "
159 (lilypond-version) " (http://lilypond.org).\n"
160 "\\def\\lilypondtagline{Engraved by LilyPond (version "
168 (define (dot x y radius)
169 (embedded-ps (list 'dot x y radius)))
171 (define (beam width slope thick blot)
172 (embedded-ps (list 'beam width slope thick blot)))
174 (define (bracket arch_angle arch_width arch_height height arch_thick thick)
175 (embedded-ps (list 'bracket arch_angle arch_width arch_height height arch_thick thick)))
177 (define (dashed-slur thick dash l)
178 (embedded-ps (list 'dashed-slur thick dash `(quote ,l))))
181 (string-append "\\char" (inexact->string i 10) " "))
183 (define (dashed-line thick on off dx dy)
184 (embedded-ps (list 'dashed-line thick on off dx dy)))
186 (define (zigzag-line centre? zzw zzh thick dx dy)
187 (embedded-ps (list 'zigzag-line centre? zzw zzh thick dx dy)))
189 (define (symmetric-x-triangle t w h)
190 (embedded-ps (list 'symmetric-x-triangle t w h)))
192 (define (font-load-command name-mag command)
194 "\\font\\" command "="
197 (ly:number->string (inexact->exact (round (* 1000 (cdr name-mag)))))
200 (define (ez-ball c l b)
201 (embedded-ps (list 'ez-ball c l b)))
203 (define (header-to-file fn key val)
204 (set! key (symbol->string key))
205 (if (not (equal? "-" fn))
206 (set! fn (string-append fn "." key))
209 (format "writing header field `~a' to `~a'..."
211 (if (equal? "-" fn) "<stdout>" fn)
213 (current-error-port))
216 (display val (open-file fn "w"))
218 (display "\n" (current-error-port))
222 (define (embedded-ps expr)
224 (with-output-to-string
225 (lambda () (ps-output-expression expr (current-output-port))))))
226 (string-append "\\embeddedps{" ps-string "}")))
229 (string-append "% " s "\n"))
233 ; uncomment for some stats about lily memory
234 ; (display (gc-stats))
240 (define (experimental-on)
243 (define (repeat-slash w a t)
244 (embedded-ps (list 'repeat-slash w a t)))
248 "\\def\\scaletounit{ "
249 (number->string (cond
250 ((equal? (ly:unit) "mm") (/ 72.0 25.4))
251 ((equal? (ly:unit) "pt") (/ 72.0 72.27))
252 (else (error "unknown unit" (ly:unit)))
255 "\\ifx\\lilypondstart\\undefined\n"
256 " \\input lilyponddefs\n"
258 "\\outputscale = \\lilypondpaperoutputscale\\lilypondpaperunit\n"
260 "\\lilypondspecial\n"
261 "\\lilypondpostscript\n"))
263 ;; Note: this string must match the string in lilypond.py!!!
264 (define (header creator generate)
266 "% Generated automatically by: " creator generate "\n"))
268 (define (invoke-char s i)
270 "\n\\" s "{" (inexact->string i 10) "}" ))
273 ;; need to do something to make this really safe.
275 (define-public (output-tex-string s)
276 (if security-paranoia
277 (regexp-substitute/global #f "\\\\" s 'pre "$\\backslash$" 'post)
280 (define (lily-def key val)
282 (regexp-substitute/global
283 #f "_" (output-tex-string key) 'pre "X" 'post))
285 (tex-val (output-tex-string val)))
286 (if (equal? (sans-surrounding-whitespace tex-val) "")
287 (string-append "\\let\\" tex-key "\\undefined\n")
288 (string-append "\\def\\" tex-key "{" tex-val "}%\n"))))
290 (define (number->dim x)
292 ;;ugh ly:* in backend needs compatibility func for standalone output
293 (ly:number->string x) " \\outputscale "))
295 (define (placebox x y s)
296 (string-append "\\lyitem{"
297 (ly:number->string y) "}{"
298 (ly:number->string x) "}{"
301 (define (bezier-sandwich l thick)
302 (embedded-ps (list 'bezier-sandwich `(quote ,l) thick)))
304 (define (start-system wd ht)
305 (string-append "\\leavevmode\n"
306 "\\scoreshift = " (number->dim (* ht 0.5)) "\n"
307 "\\lilypondifundefined{lilypondscoreshift}%\n"
309 " {\\advance\\scoreshift by -\\lilypondscoreshift}%\n"
311 (ly:number->string wd) "}{"
312 (ly:number->string ht) "}{%\n"))
314 (define (stop-system)
315 "}%\n%\n\\interscoreline\n%\n")
316 (define (stop-last-system)
319 (define (horizontal-line x1 x2 th)
320 (filledbox (- x1) (- x2 x1) (* .5 th) (* .5 th )))
322 (define (filledbox breapth width depth height)
323 (if (and #f (defined? 'ps-testing))
325 (string-append (numbers->string (list breapth width depth height))
327 (string-append "\\lyvrule{"
328 (ly:number->string (- breapth)) "}{"
329 (ly:number->string (+ breapth width)) "}{"
330 (ly:number->string depth) "}{"
331 (ly:number->string height) "}")))
333 (define (round-filled-box x y width height blotdiam)
334 (embedded-ps (list 'round-filled-box x y width height blotdiam)))
337 (string-append "\\hbox{" (output-tex-string s) "}"))
339 (define (tuplet ht gapx dx dy thick dir)
340 (embedded-ps (list 'tuplet ht gapx dx dy thick dir)))
342 (define (polygon points blotdiameter)
343 (embedded-ps (list 'polygon `(quote ,points) blotdiameter)))
345 (define (draw-line thick fx fy tx ty)
346 (embedded-ps (list 'draw-line thick fx fy tx ty)))
348 ;; TODO: this should be a default, which is overriden in PS
349 (define (between-system-string string)
352 (define (define-origin file line col)
353 (if (procedure? point-and-click)
354 (string-append "\\special{src:" ;;; \\string ?
355 (point-and-click line col file)
360 ;; no-origin not yet supported by Xdvi
361 (define (no-origin) "")
363 (define-public (tex-output-expression expr port)
364 (display (eval expr this-module) port ))