1 ;;;; output-ps.scm -- implement Scheme output routines for PostScript
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>
8 ;;;; Note: currently misused as testbed for titles with markup, see
9 ;;;; input/test/title-markup.ly
12 ;;;; * papersize in header
13 ;;;; * special characters, encoding.
14 ;;;; + implement encoding switch (switches? input/output??),
15 ;;;; + move encoding definitions to ENCODING.ps files, or
16 ;;;; + find out which program's PS(?) encoding code we can use?
17 ;;;; * text setting, kerning.
18 ;;;; * document output-interface
20 (debug-enable 'backtrace)
22 (define-module (scm output-ps)
24 #:export (define-fonts
70 ;; alist containing fontname -> fontcommand assoc (both strings)
72 (define page-number 0)
74 ;; /lilypondpaperoutputscale 1.75729901757299 def
75 ;;/lily-output-units 2.83464 def %% milimeter
76 ;;/output-scale lilypondpaperoutputscale lily-output-units mul def
78 ;; output-scale = 1.75729901757299 * 2.83464 = 4.9813100871731003736
80 (define OUTPUT-SCALE 4.98)
83 ;;; helper functions, not part of output interface
84 (define (escape-parentheses s)
85 (regexp-substitute/global #f "(^|[^\\])([\\(\\)])" s 'pre 1 "\\" 2 'post))
87 (define (offset-add a b)
88 (cons (+ (car a) (car b))
91 ;; ("ecmb12" . "ISOLatin1Encoding")))
93 (define (ps-encoding text)
94 (escape-parentheses text))
97 (define (ps-string-def prefix key val)
98 (string-append "/" prefix (symbol->string key) " ("
99 (escape-parentheses val)
102 (define (ps-number-def prefix key val)
103 (let ((s (if (integer? val)
104 (ly:number->string val)
105 (ly:number->string (exact->inexact val)))))
106 (string-append "/" prefix (symbol->string key) " " s " def\n")))
108 (define (tex-font? fontname)
109 (equal? (substring fontname 0 2) "cm"))
113 ;;; Lily output interface, PostScript implementation --- cleanup and docme
116 ;;; Output-interface functions
117 (define (beam width slope thick blot)
119 (ly:numbers->string (list slope width thick blot)) " draw_beam" ))
122 (define (bezier-sandwich l thick)
124 (string-join (map ly:number-pair->string l) " ")
126 (ly:number->string thick)
127 " draw_bezier_sandwich"))
129 (define (bracket arch_angle arch_width arch_height height arch_thick thick)
132 (list arch_angle arch_width arch_height height arch_thick thick))
135 (define (char font i)
137 (font-command font) " setfont "
138 "(\\" (ly:inexact->string i 8) ") show" ))
141 (string-append "% " s "\n"))
143 (define (dashed-line thick on off dx dy)
145 (ly:number->string dx) " "
146 (ly:number->string dy) " "
147 (ly:number->string thick)
149 (ly:number->string on) " "
150 (ly:number->string off)
151 " ] 0 draw_dashed_line"))
153 ;; what the heck is this interface ?
154 (define (dashed-slur thick dash l)
156 (string-join (map ly:number-pair->string l) " ")
158 (ly:number->string thick)
160 (ly:number->string dash)
163 (ly:number->string (* 10 thick))
164 " ] 0 draw_dashed_slur"))
166 (define (font-command font)
169 (string-encode-integer
170 (hashq (ly:font-name font) 1000000))
172 (string-encode-integer
173 (inexact->exact (round (* 1000 (ly:font-magnification font)))))))
175 (define (define-fonts paper font-list)
176 (define (define-font command fontname scaling)
178 "/" command " { /" fontname " findfont "
180 (ly:number->string scaling) " output-scale div scalefont } bind def\n"))
181 ;;(ly:number->string scaling) " scalefont } bind def\n"))
183 (define (reencode-font raw encoding command)
185 raw " " encoding " /" command " reencode-font\n"
186 "/" command "{ /" command " findfont 1 scalefont } bind def\n"))
188 ;; frobnicate NAME to jibe with external definitions.
189 (define (possibly-mangle-fontname fontname)
191 ((tex-font? fontname)
192 ;; FIXME: we need proper Fontmap for CM fonts, like so:
193 ;; /CMR10 (cmr10.pfb);
194 ;; (string-upcase fontname)
195 (string-append fontname ".pfb"))
196 ((or (equal? (substring fontname 0 4) "feta")
197 (equal? (substring fontname 0 4) "parm"))
198 (regexp-substitute/global
199 #f "(feta|parmesan)([a-z-]*)([0-9]+)"
200 fontname 'pre "GNU-LilyPond-" 1 2 "-" 3 'post))
203 (define (font-load-command paper font)
204 (let* ((command (font-command font))
205 (fontname (ly:font-name font))
206 (mangled (possibly-mangle-fontname fontname))
207 (coding (ly:font-encoding font))
208 (encoding (vector-ref coding 2))
209 (designsize (ly:font-design-size font))
210 (magnification (* (ly:font-magnification font)))
211 (ops (ly:paper-lookup paper 'outputscale))
212 (scaling (* ops magnification designsize)))
218 (format (current-error-port) "fontname ~S\n" fontname)
219 (format (current-error-port) "command ~S\n" command)
220 (format (current-error-port) "encoding ~S\n" coding)
221 (format (current-error-port) "encoding name ~S\n" encoding)
222 (format (current-error-port) "mangled ~S\n" mangled)
223 (format (current-error-port) "designsize ~S\n" designsize)
224 (format (current-error-port) "magnification ~S\n" magnification)
225 (format (current-error-port) "ops ~S\n" ops)
226 (format (current-error-port) "scaling ~S\n" scaling)))
228 (if (or (equal? encoding "ISOLatin1Encoding")
230 (equal? fontname "feta20")
231 (equal? fontname "parmesan20"))
232 (define-font command mangled scaling)
233 ;; FIXME: should rather tag encoded font
234 (let ((raw (string-append command "-raw"))
235 (vector (get-coding-command encoding))
236 (filename (get-coding-filename encoding)))
238 (ly:kpathsea-gulp-file filename)
239 (define-font raw mangled scaling)
240 (reencode-font raw vector command))))))
243 (map (lambda (x) (font-load-command paper x)) font-list)))
245 (define (define-origin file line col) "")
247 (define (dot x y radius)
251 (list x y radius)) " draw_dot"))
253 (define (draw-line thick x1 y1 x2 y2)
255 "1 setlinecap 1 setlinejoin "
256 (ly:number->string thick) " setlinewidth "
257 (ly:number->string x1) " "
258 (ly:number->string y1) " moveto "
259 (ly:number->string x2) " "
260 (ly:number->string y2) " lineto stroke"))
263 "\nend-lilypond-output\n")
265 (define (ez-ball ch letter-col ball-col)
268 (ly:numbers->string (list letter-col ball-col))
269 " /Helvetica-Bold " ;; ugh
272 (define (filledbox breapth width depth height)
273 (string-append (ly:numbers->string (list breapth width depth height))
276 (define (header creator time-stamp page-count-)
277 (set! page-count page-count-)
281 "%%Creator: " creator " " time-stamp "\n"
282 "%%Pages: " (number->string page-count) "\n"
283 "%%PageOrder: Ascend\n"
284 ;; FIXME: TODO get from paper
285 ;; "%%DocumentPaperSizes: a6\n"
286 ;;(string-append "GNU LilyPond (" (lilypond-version) "), ")
287 ;; (strftime "%c" (localtime (current-time))))
288 ;; FIXME: duplicated in every backend
291 (string-append "Engraved by LilyPond (version " (lilypond-version) ")"))))
295 (ly:gulp-file "lilyponddefs.ps")
296 (ly:gulp-file "music-drawing-routines.ps")))
298 (define (horizontal-line x1 x2 th)
299 (draw-line th x1 0 x2 0))
301 (define (lily-def key val)
302 (let ((prefix "lilypondpaper"))
304 (substring key 0 (min (string-length prefix) (string-length key)))
306 (string-append "/" key " {" val "} bind def\n")
307 (string-append "/" key " (" val ") def\n"))))
309 (define (no-origin) "")
311 ;; FIXME: duplictates output-scopes, duplicated in other backends
312 ;; FIXME: silly interface name
313 (define (output-paper-def pd)
314 (let ((prefix "lilypondpaper"))
316 (define (scope-entry->string key var)
317 (if (variable-bound? var)
318 (let ((val (variable-ref var)))
320 ((string? val) (ps-string-def prefix key val))
321 ((number? val) (ps-number-def prefix key val))
327 (module-map scope-entry->string (ly:output-def-scope pd)))))
329 ;; FIXME: duplicated in other output backends
330 ;; FIXME: silly interface name
331 (define (output-scopes paper scopes fields basename)
332 (let ((prefix "lilypond"))
334 ;; FIXME: duplicates output-paper's scope-entry->string, mostly
335 (define (scope-entry->string key var)
336 (if (variable-bound? var)
337 (let ((val (variable-ref var)))
338 (if (and (memq key fields) (string? val))
339 (header-to-file basename key val))
341 ((string? val) (ps-string-def prefix key val))
342 ((number? val) (ps-number-def prefix key val))
346 (define (output-scope scope)
347 (apply string-append (module-map scope-entry->string scope)))
349 (string-append (apply string-append (map output-scope scopes)))))
351 ;; hmm, looks like recursing call is always last statement, does guile
353 (define (output-stencil port expr offset)
355 (let ((head (car expr)))
357 ((ly:input-location? head)
358 (display (apply define-origin (ly:input-location head)) port)
359 (output-stencil port (cadr expr) offset))
360 ((eq? head 'no-origin)
361 (display (expression->string head) port)
362 (output-stencil port (cadr expr) offset))
363 ((eq? head 'translate-stencil)
364 (output-stencil port (caddr expr) (offset-add offset (cadr expr))))
365 ((eq? head 'combine-stencil)
366 (output-stencil port (cadr expr) offset)
367 (output-stencil port (caddr expr) offset))
369 (display (placebox (car offset) (cdr offset)
370 (expression->string expr)) port))))))
372 (define (placebox x y s)
374 (ly:number->string x) " " (ly:number->string y) " { " s " } place-box\n"))
376 (define (polygon points blotdiameter)
378 (ly:numbers->string points) " "
379 (ly:number->string (/ (length points) 2)) " "
380 (ly:number->string blotdiameter)
383 (define (repeat-slash wid slope thick)
385 (ly:numbers->string (list wid slope thick))
386 " draw_repeat_slash"))
388 (define (round-filled-box x y width height blotdiam)
391 (list x y width height blotdiam)) " draw_round_box"))
393 (define (new-start-system origin dim)
395 "\n" (ly:number-pair->string origin) " start-system\n"
397 "set-ps-scale-to-lily-scale\n"))
399 (define (stem breapth width depth height)
401 (ly:numbers->string (list breapth width depth height))
404 (define (stop-system)
407 (define stop-last-system stop-system)
409 (define (symmetric-x-triangle thick w h)
411 (ly:numbers->string (list h w thick))
412 " draw_symmetric_x_triangle"))
414 (define (text font s)
416 ;; (string-append "(" (escape-parentheses s) ") show "))
419 (font-command font) " setfont "
420 "(" (ps-encoding s) ") show"))
425 (define (zigzag-line centre? zzw zzh thick dx dy)
427 (if centre? "true" "false") " "
428 (ly:number->string zzw) " "
429 (ly:number->string zzh) " "
430 (ly:number->string thick) " "
432 (ly:number->string dx) " "
433 (ly:number->string dy)
434 " draw_zigzag_line"))
437 (set! page-number (+ page-number 1))
439 "%%Page: " (number->string page-number) " " (number->string page-count) "\n"
442 (define (stop-page last?)