1 ;;;; backend-library.scm -- helpers for the backends.
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 2005--2009 Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
8 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
11 (use-modules (scm ps-to-png)
14 (define-public (ly:system command . rest)
16 (dev-null "/dev/null")
17 (silenced (if (or (ly:get-option 'verbose)
18 (not (access? dev-null W_OK)))
20 (format #f "~a > ~a 2>&1 " command dev-null))))
21 (if (ly:get-option 'verbose)
23 (ly:message (_ "Invoking `~a'...") command))
28 (system-with-env silenced (car rest))
33 (ly:message (_ "`~a' failed (~a)") command status)
35 ;; hmmm. what's the best failure option?
36 (throw 'ly-file-failed)))))
38 (define-public (system-with-env cmd env)
40 "Execute CMD in fork, with ENV (a list of strings) as the environment"
42 ;; laziness: should use execle?
44 ((pid (primitive-fork)))
52 (cdr (waitpid pid)))))
54 (define-public (sanitize-command-option str)
55 "Kill dubious shell quoting"
59 (regexp-substitute/global #f "[^-_ 0-9,.a-zA-Z'\"\\]" str 'pre 'post)
62 (define-public (search-executable names)
63 (define (helper path lst)
66 (if (search-path path (car lst)) (car lst)
67 (helper path (cdr lst)))))
69 (let ((path (parse-path (getenv "PATH"))))
72 (define-public (search-gs)
74 ;; must be sure that we don't catch stuff from old GUBs.
75 (search-executable '("gs")))
77 (define-public (postscript->pdf paper-width paper-height name)
78 (let* ((pdf-name (string-append
79 (dir-basename name ".ps" ".eps")
81 (is-eps (string-match "\\.eps$" name))
82 (paper-size-string (if is-eps
84 (ly:format "-dDEVICEWIDTHPOINTS=~$\
85 -dDEVICEHEIGHTPOINTS=~$"
86 paper-width paper-height)))
88 (cmd (simple-format #f
93 -dCompatibilityLevel=1.4\
103 (if (ly:get-option 'verbose) "" "-q")
104 (if (or (ly:get-option 'gs-load-fonts)
105 (ly:get-option 'gs-load-lily-fonts))
111 ;; The wrapper on windows cannot handle `=' signs,
112 ;; gs has a workaround with #.
113 (if (eq? PLATFORM 'windows)
115 (set! cmd (string-regexp-substitute "=" "#" cmd))
116 (set! cmd (string-regexp-substitute "-dSAFER " "" cmd))
117 (if (access? pdf-name W_OK)
118 (delete-file pdf-name))))
120 (ly:message (_ "Converting to `~a'...") pdf-name)
124 (define-public (postscript->png resolution paper-width paper-height name)
125 (let* ((verbose (ly:get-option 'verbose))
128 ;; Do not try to guess the name of the png file,
129 ;; GS produces PNG files like BASE-page%d.png.
130 (ly:message (_ "Converting to ~a...") "PNG")
132 #:resolution resolution
133 #:page-width paper-width
134 #:page-height paper-height
135 #:rename-page-1 rename-page-1
137 #:anti-alias-factor (ly:get-option 'anti-alias-factor)
138 #:pixmap-format (ly:get-option 'pixmap-format))
141 (define-public (postprocess-output paper-book module filename formats)
142 (let* ((completed (completize-formats formats))
143 (base (string-regexp-substitute "\\.[a-z]+$" "" filename))
144 (intermediate (remove (lambda (x) (member x formats)) completed)))
146 (for-each (lambda (f)
147 ((eval (string->symbol (format "convert-to-~a" f))
148 module) paper-book filename)) completed)
149 (if (ly:get-option 'delete-intermediate-files)
150 (for-each (lambda (f)
151 (delete-file (string-append base "." f))) intermediate))))
153 (define-public (completize-formats formats)
154 (define new-fmts '())
155 (if (member "png" formats)
156 (set! formats (cons "ps" formats)))
157 (if (member "pdf" formats)
158 (set! formats (cons "ps" formats)))
159 (for-each (lambda (x)
160 (if (member x formats) (set! new-fmts (cons x new-fmts))))
162 (uniq-list (reverse new-fmts)))
164 (define (header-to-file file-name key value)
165 (set! key (symbol->string key))
166 (if (not (equal? "-" file-name))
167 (set! file-name (string-append file-name "." key)))
168 (ly:message (_ "Writing header field `~a' to `~a'...")
170 (if (equal? "-" file-name) "<stdout>" file-name))
171 (if (equal? file-name "-")
173 (let ((port (open-file file-name "w")))
180 (define-public (output-scopes scopes fields basename)
181 (define (output-scope scope)
186 (let ((val (if (variable-bound? var) (variable-ref var) "")))
187 (if (and (memq sym fields) (string? val))
188 (header-to-file basename sym val))
191 (apply string-append (map output-scope scopes)))
193 (define-public (backend-testing output-module)
194 (define (missing-stencil-expression name)
196 (ly:warning (_ "missing stencil expression `~S'") name)
200 (if (not (module-defined? output-module x))
201 (module-define! output-module x
202 (lambda* (#:optional y . z)
203 (missing-stencil-expression x)))))
204 (ly:all-stencil-commands)))