1 ;;;; lily.scm -- toplevel Scheme stuff
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
8 ;; Internationalisation: (_i "to be translated") gets an entry in the
9 ;; POT file (gettext ) must be invoked explicitely to do the actual
11 ;;(define-macro (_i x) x)
12 ;;(define-macro-public _i (x) x)
13 ;;(define-public-macro _i (x) x)
15 (defmacro-public _i (x) x)
17 (read-enable 'positions)
20 (define scheme-options-definitions
25 ;; - [subject-]object-object-verb +"ing"
26 ;; - [subject-]-verb-object-object
28 (anti-alias-factor 1 "render at higher resolution and scale down result\nto prevent jaggies in PNG")
29 (backend ps "which backend to use by default; Options: eps, ps [default], scm, svg, tex, texstr)")
30 (check-internal-types #f "check every property assignment for types")
31 (clip-systems #f "Generate cut-out snippets of a score")
32 (datadir #f "LilyPond prefix for data files (Readonly).")
33 (debug-gc #f "dump memory debugging statistics")
34 (debug-gc-assert-parsed-dead #f "for memory debugging:
35 ensure that all refs to parsed objects are dead. This is an internal option, and is switched on automatically for -ddebug-gc.")
36 (debug-lexer #f "debug the flex lexer")
37 (debug-page-breaking-scoring #f "dump scores for many different page breaking configurations")
38 (debug-parser #f "debug the bison parser")
39 (debug-property-callbacks #f "debug cyclic callback chains")
40 (debug-skylines #f "debug skylines")
41 (delete-intermediate-files #f
42 "delete unusable PostScript files")
43 (dump-profile #f "dump memory and time information for each file")
44 (dump-cpu-profile #f "dump timing information (system-dependent)")
45 (dump-signatures #f "dump output signatures of each system. Used for regression testing.")
47 (eps-box-padding #f "Pad EPS bounding box left edge. Guarantee alignment between systems in LaTeX.")
49 "load fonts via Ghostscript.")
50 (gs-load-lily-fonts #f
51 "load only lilypond fonts via Ghostscript.")
52 (gui #f "running from gui; redirect stderr to log file")
53 (help #f "show this help.")
54 (include-book-title-preview #t "include book-titles in preview images.")
55 (include-eps-fonts #t "Include fonts in separate-system EPS files.")
56 (job-count #f "Process in parallel")
57 (log-file #f "redirect output to log FILE.log")
60 "relative for simultaneous music works
61 similar to chord syntax")
62 (point-and-click #t "use point & click")
63 (paper-size "a4" "the default paper size")
64 (pixmap-format "png16m" "GS format to use for pixel images")
65 (preview #f "make a incipit image. ")
66 (print-pages #t "print pages normally. ")
67 (protected-scheme-parsing #t "continue when finding errors in inline
68 scheme are caught in the parser. If off, halt
69 on errors, and print a stack trace.")
70 (profile-property-accesses #f "keep statistics of get_property() calls.")
72 (resolution 101 "resolution for generating PNG bitmaps")
73 (read-file-list #f "Read files to be processed from command line arguments")
75 (safe #f "Run safely")
76 (strict-infinity-checking #f "If yes, crash on encountering Inf/NaN.")
77 (separate-log-files #f "Output to FILE.log per file.")
78 (trace-memory-frequency #f "Record Scheme cell usage this many times per second, and dump to file.")
79 (trace-scheme-coverage #f "Record coverage of Scheme files")
81 "how much verbosity for TTF font embedding?")
82 (show-available-fonts #f
83 "List font names available.")
84 (verbose ,(ly:command-line-verbose?) "value for the --verbose flag")
87 ;; need to do this in the beginning. Other parts of the
88 ;; Scheme init depend on these options.
92 (ly:add-option (car x) (cadr x) (caddr x)))
93 scheme-options-definitions)
97 (ly:set-option (car x) (cdr x)))
98 (eval-string (ly:command-line-options)))
102 (if (defined? 'set-debug-cell-accesses!)
103 (set-debug-cell-accesses! #f))
105 ;(set-debug-cell-accesses! 1000)
107 (use-modules (ice-9 regex)
120 (define-public fancy-format format)
121 (define-public (ergonomic-simple-format dest . rest)
122 "Like ice-9 format, but without the memory consumption."
125 (apply simple-format (cons #f (cons dest rest)))
126 (apply simple-format (cons dest rest))))
128 (define format ergonomic-simple-format)
131 (define-public (myd k v) (display k) (display ": ") (display v) (display ", ")
134 (define-public (print . args)
135 (apply format (cons (current-output-port) args)))
139 ;;; debugging evaluator is slower. This should
140 ;;; have a more sensible default.
142 (if (or (ly:get-option 'verbose)
143 (ly:get-option 'trace-memory-frequencency)
144 (ly:get-option 'trace-scheme-coverage)
147 (ly:set-option 'protected-scheme-parsing #f)
148 (debug-enable 'debug)
149 (debug-enable 'backtrace)
150 (read-enable 'positions)))
153 (if (ly:get-option 'trace-scheme-coverage)
156 (define-public tex-backend?
157 (member (ly:get-option 'backend) '(texstr tex)))
159 (define-public parser #f)
161 (define-public (lilypond-version)
163 (map (lambda (x) (if (symbol? x)
170 ;; TeX C++ code actually hooks into TEX_STRING_HASHLIMIT
171 (define-public TEX_STRING_HASHLIMIT 10000000)
175 ;; gettext wrapper for guile < 1.7.2
176 (if (defined? 'gettext)
177 (define-public _ gettext)
178 (define-public _ ly:gettext))
180 (define-public (ly:load x)
181 (let* ((file-name (%search-load-path x)))
182 (if (ly:get-option 'verbose)
183 (ly:progress "[~A" file-name))
185 (ly:error (_ "cannot find: ~A") x))
186 (primitive-load file-name)
187 (if (ly:get-option 'verbose)
191 ;; #(CYGWIN_NT-5.1 Hostname 1.5.12(0.116/4/2) 2004-11-10 08:34 i686)
194 ;; #(Linux hostname 2.4.27-1-686 #1 Fri Sep 3 06:28:00 UTC 2004 i686)
197 ;; #(Windows XP HOSTNAME build 2600 5.01 Service Pack 1 i686)
201 (define-public PLATFORM
204 (car (string-tokenize (vector-ref (uname) 0) char-set:letter)))))
207 (let ((platform (string-tokenize
208 (vector-ref (uname) 0) char-set:letter+digit)))
209 (if (null? (cdr platform)) #f
210 (member (string-downcase (cadr platform)) '("95" "98" "me")))))
214 (define native-getcwd getcwd)
216 (if (string-index x #\\)
218 (string-regexp-substitute
220 (string-regexp-substitute "\\\\" "/" x))))
221 ;; FIXME: this prints a warning.
222 (define-public (ly-getcwd)
223 (slashify (native-getcwd))))
224 (else (define-public ly-getcwd getcwd)))
226 (define-public (is-absolute? file-name)
227 (let ((file-name-length (string-length file-name)))
228 (if (= file-name-length 0)
230 (or (eq? (string-ref file-name 0) #\/)
231 (and (eq? PLATFORM 'windows)
232 (> file-name-length 2)
233 (eq? (string-ref file-name 1) #\:)
234 (eq? (string-ref file-name 2) #\/))))))
236 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
238 (define (type-check-list location signature arguments)
239 "Typecheck a list of arguments against a list of type
240 predicates. Print a message at LOCATION if any predicate failed."
242 (define (recursion-helper signature arguments count)
243 (define (helper pred? arg count)
244 (if (not (pred? arg))
250 #f (_ "wrong type for argument ~a. Expecting ~a, found ~s")
251 count (type-name pred?) arg))
255 (if (null? signature)
257 (and (helper (car signature) (car arguments) count)
258 (recursion-helper (cdr signature) (cdr arguments) (1+ count)))))
260 (recursion-helper signature arguments 1))
262 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
266 ;;(define-public (output-framework) (write "hello\n"))
268 (define output-tex-module
269 (make-module 1021 (list (resolve-interface '(scm output-tex)))))
270 (define output-ps-module
271 (make-module 1021 (list (resolve-interface '(scm output-ps)))))
273 (define-public (ps-output-expression expr port)
274 (display (eval expr output-ps-module) port))
276 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
277 ;; Safe definitions utility
278 (define safe-objects (list))
280 (define-macro (define-safe-public arglist . body)
281 "Define a variable, export it, and mark it as safe, ie usable in LilyPond safe mode.
282 The syntax is the same as `define*-public'."
283 (define (get-symbol arg)
285 (get-symbol (car arg))
287 (let ((safe-symbol (get-symbol arglist)))
289 (define*-public ,arglist
291 (set! safe-objects (cons (cons ',safe-symbol ,safe-symbol)
295 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
298 (ly:set-default-scale (ly:make-scale #(0 1 2 5/2 7/2 9/2 11/2)))
302 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
310 "define-event-classes.scm"
311 "define-music-types.scm"
314 "chord-ignatzek-names.scm"
316 "chord-generic-names.scm"
319 "music-functions.scm"
322 "define-music-properties.scm"
326 "parser-ly-from-scheme.scm"
327 "ly-syntax-constructors.scm"
329 "define-context-properties.scm"
330 "translation-functions.scm"
340 "define-markup-commands.scm"
341 "define-grob-properties.scm"
343 "define-grob-interfaces.scm"
344 "define-stencil-commands.scm"
348 "backend-library.scm"
351 ;; must be after everything has been defined
355 (for-each ly:load init-scheme-files)
358 (set! type-p-name-alist
360 (,boolean-or-symbol? . "boolean or symbol")
361 (,boolean? . "boolean")
363 (,grob-list? . "list of grobs")
364 (,hash-table? . "hash table")
365 (,input-port? . "input port")
366 (,integer? . "integer")
368 (,ly:context? . "context")
369 (,ly:dimension? . "dimension, in staff space")
370 (,ly:dir? . "direction")
371 (,ly:duration? . "duration")
372 (,ly:grob? . "layout object")
373 (,ly:input-location? . "input location")
374 (,ly:moment? . "moment")
375 (,ly:music? . "music")
376 (,ly:pitch? . "pitch")
377 (,ly:translator? . "translator")
378 (,ly:font-metric? . "font metric")
379 (,ly:simple-closure? . "simple closure")
380 (,markup-list? . "list of markups")
381 (,markup? . "markup")
382 (,ly:music-list? . "list of music")
383 (,number-or-grob? . "number or grob")
384 (,number-or-string? . "number or string")
385 (,number-pair? . "pair of numbers")
386 (,number? . "number")
387 (,output-port? . "output port")
389 (,procedure? . "procedure")
390 (,rhythmic-location? . "rhythmic location")
391 (,scheme? . "any type")
392 (,string? . "string")
393 (,symbol? . "symbol")
394 (,vector? . "vector")))
396 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
399 (define (profile-measurements)
406 (ly:assoc-get 'gc-time-taken stats))
408 (ly:assoc-get 'total-cells-allocated stats 0)
411 (define (dump-profile base last this)
413 ((outname (format "~a.profile" (basename base ".ly")))
414 (diff (map (lambda (y) (apply - y)) (zip this last))))
416 (ly:progress "\nWriting timing to ~a..." outname)
417 (format (open-file outname "w")
418 "time: ~a\ncells: ~a\n"
419 (if (ly:get-option 'dump-cpu-profile)
426 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
429 (define gc-dumping #f)
430 (define gc-protect-stat-count 0)
432 (define-public (dump-live-object-stats outfile)
435 (format outfile "~a: ~a\n" (car x) (cdr x)))
436 (sort (gc-live-object-stats)
438 (string<? (car x) (car y))))))
440 (define-public (dump-gc-protects)
441 (set! gc-protect-stat-count (1+ gc-protect-stat-count))
442 (let* ((protects (sort
443 (hash-table->alist (ly:protects))
445 (< (object-address (car a))
446 (object-address (car b))))))
448 (out-file-name (string-append
449 "gcstat-" (number->string gc-protect-stat-count)
451 (outfile (open-file out-file-name "w")))
454 (display (format "Dumping GC statistics ~a...\n" out-file-name))
460 (format "~a (~a) = ~a\n" (object-address x) c x)
464 (not (symbol? (car x))))
468 (format outfile "\nprotected symbols: ~a\n"
469 (apply + (map (lambda (obj-count) (if (symbol? (car obj-count))
474 ;; (display (ly:smob-protects))
476 (if (defined? 'gc-live-object-stats)
478 (display "Live object statistics: GC'ing\n")
482 (display "Asserting dead objects\n")
483 (ly:set-option 'debug-gc-assert-parsed-dead #t)
485 (ly:set-option 'debug-gc-assert-parsed-dead #f)
487 (set! stats (gc-live-object-stats))
488 (display "Dumping live object statistics.\n")
489 (dump-live-object-stats outfile)))
499 gc-protect-stat-count
501 (let ((sym-stat (assoc sym stats)))
506 '(protected-objects bytes-malloced cell-heap-size
516 (define (check-memory)
517 "read /proc/self to check up on memory use."
518 (define (gulp-file name)
519 (let* ((file (open-input-file name))
520 (text (read-delimited "" file)))
524 ((stat (gulp-file "/proc/self/status"))
525 (lines (string-split stat #\newline))
526 (interesting (filter identity
529 (string-match "^VmData:[ \t]*([0-9]*) kB" l))
531 (mem (string->number (match:substring (car interesting) 1)))
535 (display (format "VMDATA: ~a\n" mem))
544 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
547 (define (multi-fork count)
548 (define (helper count acc)
551 ((pid (primitive-fork)))
554 (helper (1- count) (cons pid acc))))
559 (define-public (lilypond-main files)
560 "Entry point for LilyPond."
563 (eval-string (ly:command-line-code))
565 (if (ly:get-option 'help)
570 (if (ly:get-option 'show-available-fonts)
572 (ly:font-config-display-fonts)
577 (if (ly:get-option 'gui)
585 (if (ly:get-option 'read-file-list)
588 (> (string-length s) 0))
590 (map (lambda (f) (string-split (ly:gulp-file f) #\nl))
594 (if (and (number? (ly:get-option 'job-count))
595 (>= (length files) (ly:get-option 'job-count)))
598 ((count (ly:get-option 'job-count))
599 (split-todo (split-list files count))
600 (joblist (multi-fork count))
603 (if (not (string-or-symbol? (ly:get-option 'log-file)))
604 (ly:set-option 'log-file "lilypond-multi-run"))
606 (if (number? joblist)
608 (ly:set-option 'log-file (format "~a-~a"
609 (ly:get-option 'log-file) joblist))
610 (set! files (vector-ref split-todo joblist)))
613 (ly:progress "\nForking into jobs: ~a\n" joblist)
616 (let* ((stat (cdr (waitpid pid))))
619 (set! errors (acons (list-element-index joblist pid) stat errors)))))
626 (logfile (format "~a-~a.log"
627 (ly:get-option 'log-file) job))
628 (log (ly:gulp-file logfile))
629 (len (string-length log))
630 (tail (substring log (max 0 (- len 1024)))))
632 (if (status:term-sig state)
633 (ly:message "\n\n~a\n"
634 (format (_ "job ~a terminated with signal: ~a")
636 (status:term-sig state)))
637 (ly:message (_ "logfile ~a (exit ~a):\n~a") logfile (status:exit-val state) tail))))
642 (ly:error "Children ~a exited with errors." (map car errors)))
644 ;; must overwrite individual entries
645 (if (ly:get-option 'dump-profile)
646 (dump-profile "lily-run-total" '(0 0) (profile-measurements)))
648 (exit (if (null? errors) 0 1))))))
651 (if (string-or-symbol? (ly:get-option 'log-file))
652 (ly:stderr-redirect (format "~a.log" (ly:get-option 'log-file)) "w"))
655 (let ((failed (lilypond-all files)))
656 (if (ly:get-option 'trace-scheme-coverage)
658 (coverage:show-all (lambda (f) (string-contains f "lilypond"))
664 (ly:error (_ "failed files: ~S") (string-join failed))
667 ;; HACK: be sure to exit with single newline
671 (define-public (lilypond-all files)
673 (separate-logs (ly:get-option 'separate-log-files))
674 (do-measurements (ly:get-option 'dump-profile))
675 (handler (lambda (key failed-file)
676 (set! failed (append (list failed-file) failed)))))
682 ((start-measurements (if do-measurements
683 (profile-measurements)
685 (base (basename x ".ly"))
686 (all-settings (ly:all-options)))
689 (ly:stderr-redirect (format "~a.log" base) "w"))
690 (if (ly:get-option 'trace-memory-frequency)
691 (mtrace:start-trace (ly:get-option 'trace-memory-frequency)))
693 (lilypond-file handler x)
694 (if start-measurements
695 (dump-profile x start-measurements (profile-measurements)))
697 (if (ly:get-option 'trace-memory-frequency)
700 (mtrace:dump-results base)))
704 (ly:set-option (car s) (cdr s)))
707 (ly:clear-anonymous-modules)
708 (ly:set-option 'debug-gc-assert-parsed-dead #t)
710 (ly:set-option 'debug-gc-assert-parsed-dead #f)
713 (if (ly:get-option 'debug-gc)
715 (if (= (random 40) 1)
716 (ly:reset-all-fonts)))))
720 ;; we want the failed-files notice in the aggregrate logfile.
721 (if (ly:get-option 'separate-logs)
723 (if (string-or-symbol? (ly:get-option 'log-file))
724 (format "~a.log" (ly:get-option 'log-file))
727 (if (ly:get-option 'dump-profile)
728 (dump-profile "lily-run-total" '(0 0) (profile-measurements)))
732 (define (lilypond-file handler file-name)
733 (catch 'ly-file-failed
734 (lambda () (ly:parse-file file-name))
735 (lambda (x . args) (handler x file-name))))
737 (use-modules (scm editor))
739 (define-public (gui-main files)
741 (gui-no-files-handler))
743 (if (not (string? (ly:get-option 'log-file)))
744 (let* ((base (basename (car files) ".ly"))
745 (log-name (string-append base ".log")))
746 (if (not (ly:get-option 'gui))
747 (ly:message (_ "Redirecting output to ~a...") log-name))
748 (ly:stderr-redirect log-name "w")
749 (ly:message "# -*-compilation-*-"))
751 (let ((failed (lilypond-all files)))
755 (ly:stderr-redirect "foo" "r")
756 (system (get-editor-command log-name 0 0 0))
757 (ly:error (_ "failed files: ~S") (string-join failed))
762 (define (gui-no-files-handler)
763 (let* ((ly (string-append (ly:effective-prefix) "/ly/"))
764 ;; FIXME: soft-code, localize
765 (welcome-ly (string-append ly "Welcome_to_LilyPond.ly"))
766 (cmd (get-editor-command welcome-ly 0 0 0)))
767 (ly:message (_ "Invoking `~a'...") cmd)