1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
4 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
6 ;;;; LilyPond is free software: you can redistribute it and/or modify
7 ;;;; it under the terms of the GNU General Public License as published by
8 ;;;; the Free Software Foundation, either version 3 of the License, or
9 ;;;; (at your option) any later version.
11 ;;;; LilyPond is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;;; GNU General Public License for more details.
16 ;;;; You should have received a copy of the GNU General Public License
17 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
19 ;; Internationalisation: (_i "to be translated") gets an entry in the
20 ;; POT file; (gettext ...) must be invoked explicitly to do the actual
23 ;; (define-macro (_i x) x)
24 ;; (define-macro-public _i (x) x)
25 ;; (define-public-macro _i (x) x)
28 (defmacro-public _i (x) x)
30 ;;; Boolean thunk - are we integrating Guile V2.0 or higher with LilyPond?
31 (define-public (guile-v2)
32 (string>? (version) "1.9.10"))
34 (read-enable 'positions)
38 (debug-enable 'backtrace)
39 (debug-set! show-file-name #t)))
41 (define-public PLATFORM
44 (car (string-tokenize (utsname:sysname (uname)) char-set:letter)))))
46 ;; We don't use (srfi srfi-39) (parameter objects) here because that
47 ;; does not give us a name/handle to the underlying fluids themselves.
49 (define %parser (make-fluid))
50 (define %location (make-fluid))
51 ;; No public setters: should not get overwritten in action
52 (define-public (*parser*) (fluid-ref %parser))
53 (define-public (*location*) (fluid-ref %location))
54 ;; but properly scoped location should be fine
55 (defmacro-public with-location (loc . body)
56 `(with-fluids ((,%location ,loc)) ,@body))
58 ;; It would be nice to convert occurences of parser/location to
59 ;; (*parser*)/(*location*) using the syncase module but it is utterly
60 ;; broken in GUILE 1 and would require changing a lot of unrelated
61 ;; innocuous constructs which just happen to fall apart with
62 ;; inscrutable error messages.
65 ;; Session-handling variables and procedures.
67 ;; A "session" corresponds to one .ly file processed on a LilyPond
68 ;; command line. Every session gets to see a reasonably fresh state
69 ;; of LilyPond and should work independently from previous files.
71 ;; Session management relies on cooperation, namely the user not
72 ;; trying to change variables and data structures internal to
73 ;; LilyPond. It is not proof against in-place modification of data
74 ;; structures (as they are just reinitialized with the original
75 ;; identities), and it is not proof against tampering with internals.
77 ;; As a consequence, session management is not sufficient for
78 ;; separating multiple independent .ly files in "-dsafe" mode: you
79 ;; should give each its own LilyPond process when reliable separation
82 ;; For standard tasks and programming practices, multiple sessions in
83 ;; the same LilyPond job should work reasonably independently and
84 ;; without "bleed-over" while still loading and compiling the
85 ;; relevant .scm and .ly files only once.
88 (define lilypond-declarations '())
89 (define after-session-hook (make-hook))
91 (define-public (call-after-session thunk)
92 (if (ly:undead? lilypond-declarations)
93 (ly:error (_ "call-after-session used after session start")))
94 (add-hook! after-session-hook thunk #t))
96 (defmacro-public define-session (name value)
97 "This defines a variable @var{name} with the starting value
98 @var{value} that is reinitialized at the start of each session.
99 A@tie{}session basically corresponds to one LilyPond file on the
100 command line. The value is recorded at the start of the first session
101 after loading all initialization files and before loading the user
102 file and is reinstated for all of the following sessions. This
103 happens just by replacing the value, not by copying structures, so you
104 should not destructively modify them. For example, lists defined in
105 this manner should be changed within a session only be adding material
106 to their front or replacing them altogether, not by modifying parts of
107 them. It is an error to call @code{define-session} after the first
108 session has started."
109 (define (add-session-variable name value)
110 (if (ly:undead? lilypond-declarations)
111 (ly:error (_ "define-session used after session start")))
112 (let ((var (make-variable value)))
113 (module-add! (current-module) name var)
114 (set! lilypond-declarations (cons var lilypond-declarations))))
115 `(,add-session-variable ',name ,value))
117 (defmacro-public define-session-public (name value)
118 "Like @code{define-session}, but also exports @var{name}."
120 (define-session ,name ,value)
123 (define (session-terminate)
124 (if (ly:undead? lilypond-declarations)
127 (lambda (p) (variable-set! (cadr p) (cddr p)))
128 (ly:get-undead lilypond-declarations))
129 (run-hook after-session-hook))))
131 (define lilypond-interfaces #f)
133 (define-public (session-initialize thunk)
134 "Initialize this session. The first session in a LilyPond run is
135 initialized by calling @var{thunk}, then recording the values of all
136 variables in the current module as well as those defined with
137 @code{define-session}. Subsequent calls of @code{session-initialize}
138 ignore @var{thunk} and instead just reinitialize all recorded
139 variables to their value after the initial call of @var{thunk}."
141 ;; We need to save the variables of the current module along with
142 ;; their values: functions defined in the module might refer to the
145 ;; The entries in lilypond-declarations consist of a cons* consisting
146 ;; of symbol, variable, and value. Variables defined with
147 ;; define-session have the symbol set to #f.
149 (if (ly:undead? lilypond-declarations)
151 (module-use-interfaces! (current-module) (reverse lilypond-interfaces))
156 (variable-set! var val)
158 (module-add! (current-module) (car p) var))))
159 (ly:get-undead lilypond-declarations)))
162 (set! lilypond-interfaces
163 (filter (lambda (m) (eq? 'interface (module-kind m)))
164 (module-uses (current-module))))
165 (let ((decl (map! (lambda (v)
166 (cons* #f v (variable-ref v)))
167 lilypond-declarations)))
170 (let ((val (variable-ref v)))
171 (if (not (ly:lily-parser? val))
177 (set! lilypond-declarations (ly:make-undead decl))))))
179 (define scheme-options-definitions
183 ;; - [subject-]object-object-verb +"ing"
184 ;; - [subject-]-verb-object-object
186 ;; Avoid overlong lines in `lilypond -dhelp'! Strings should not
187 ;; be longer than 48 characters per line.
190 "Render at higher resolution (using given factor)
191 and scale down result to prevent jaggies in
195 "Create .tex, .texi, .count files in the
199 "Select backend. Possible values: 'eps, 'null,
200 'ps, 'scm, 'socket, 'svg.")
201 (check-internal-types
203 "Check every property assignment for types.")
206 "Generate cut-out snippets of a score.")
209 "LilyPond prefix for data files (read-only).")
212 "Dump memory debugging statistics.")
213 (debug-gc-assert-parsed-dead
215 "For memory debugging: Ensure that all
216 references to parsed objects are dead. This is
217 an internal option, and is switched on
218 automatically for `-ddebug-gc'.")
221 "Debug the flex lexer.")
222 (debug-page-breaking-scoring
224 "Dump scores for many different page breaking
228 "Debug the bison parser.")
229 (debug-property-callbacks
231 "Debug cyclic callback chains.")
235 (delete-intermediate-files
237 "Delete unusable, intermediate PostScript files.")
240 "Dump memory and time information for each file.")
243 "Dump timing information (system-dependent).")
246 "Dump output signatures of each system. Used for
247 regression testing.")
250 "Embed the source files inside the generated PDF document.")
253 "Pad left edge of the output EPS bounding box by
254 given amount (in mm).")
257 "Load fonts via Ghostscript.")
260 "Load only LilyPond fonts via Ghostscript.")
263 "Run LilyPond from a GUI and redirect stderr to
268 (include-book-title-preview
270 "Include book titles in preview images.")
273 "Include fonts in separate-system EPS files.")
276 "Include file for global settings, included before the score is processed.")
279 "Process in parallel, using the given number of
283 "If string FOO is given as argument, redirect
284 output to log file `FOO.log'.")
287 "Maximum depth for the markup tree. If a markup has more levels,
288 assume it will not terminate on its own, print a warning and return a
289 null markup instead.")
290 (midi-extension ,(if (eq? PLATFORM 'windows)
293 "Set the default file extension for MIDI output
294 file to given string.")
295 (music-strings-to-paths
297 "Convert text strings to paths when glyphs belong
301 "Add point & click links to PDF and SVG output.")
304 "Set default paper size.")
307 "Set GhostScript's output format for pixel images.")
310 "Create preview images also.")
313 "Print pages in the normal way.")
314 (protected-scheme-parsing
316 "Continue when errors in inline scheme are caught
317 in the parser. If #f, halt on errors and print
319 (profile-property-accesses
321 "Keep statistics of get_property() calls.")
324 "Set resolution for generating PNG pixmaps to
325 given value (in dpi).")
328 "Specify name of a file which contains a list of
329 input files to be processed.")
332 "When processing an \\include command, look for
333 the included file relative to the current file\
334 \n(instead of the root file)")
337 "Run in safer mode.")
340 "For input files `FILE1.ly', `FILE2.ly', ...
341 output log data to files `FILE1.log',
343 (show-available-fonts
345 "List available font names.")
346 (strict-infinity-checking
348 "Force a crash on encountering Inf and NaN
349 floating point exceptions.")
352 "Don't use directories from input files while
353 constructing output file names.")
356 "Set the PostScript strokeadjust operator explicitly.
357 This employs different drawing primitives, resulting in
358 large PDF file size increases but often markedly better
362 "Use woff font files in SVG backend.")
363 (trace-memory-frequency
365 "Record Scheme cell usage this many times per
366 second. Dump results to `FILE.stacks' and
368 (trace-scheme-coverage
370 "Record coverage of Scheme files in `FILE.cov'.")
371 (verbose ,(ly:verbose-output?)
372 "Verbose output, i.e. loglevel at least DEBUG (read-only).")
375 "Change all warning and programming_error
376 messages into errors.")
379 ;; Need to do this in the beginning. Other parts of the Scheme
380 ;; initialization depend on these options.
382 (for-each (lambda (x)
383 (ly:add-option (car x) (cadr x) (caddr x)))
384 scheme-options-definitions)
386 (for-each (lambda (x)
387 (ly:set-option (car x) (cdr x)))
388 (eval-string (ly:command-line-options)))
392 (if (defined? 'set-debug-cell-accesses!)
393 (set-debug-cell-accesses! #f))
395 ;;(set-debug-cell-accesses! 1000)
397 (use-modules (ice-9 regex)
409 (scm safe-utility-defs))
411 (define-public _ gettext)
412 ;;; There are new modules defined in Guile V2.0 which we need to use.
414 ;; Modules and scheme files loaded by lily.scm use currying
415 ;; in Guile V2 this needs a module which is not present in Guile V1.8
420 (ly:debug (_ "Using (ice-9 curried-definitions) module\n"))
421 (use-modules (ice-9 curried-definitions)))
423 (ly:debug (_ "Guile 1.8\n"))))
425 ;; TODO add in modules for V1.8.7 deprecated in V2.0 and integrated
426 ;; into Guile base code, like (ice-9 syncase).
429 (define-public fancy-format
432 (define-public (ergonomic-simple-format dest . rest)
433 "Like ice-9's @code{format}, but without the memory consumption."
435 (apply simple-format #f dest rest)
436 (apply simple-format dest rest)))
439 ergonomic-simple-format)
442 (define-public (myd k v)
449 (define-public (print . args)
450 (apply format (current-output-port) args))
453 ;;; General settings.
455 ;;; Debugging evaluator is slower. This should have a more sensible
459 (if (or (ly:get-option 'verbose)
460 (ly:get-option 'trace-memory-frequency)
461 (ly:get-option 'trace-scheme-coverage))
463 (ly:set-option 'protected-scheme-parsing #f)
464 (debug-enable 'backtrace)
465 (read-enable 'positions)))
467 (if (ly:get-option 'trace-scheme-coverage)
470 (define music-string-to-path-backends
473 (if (memq (ly:get-option 'backend) music-string-to-path-backends)
474 (ly:set-option 'music-strings-to-paths #t))
476 (define-public (ly:load x)
477 (let* ((file-name (%search-load-path x)))
478 (ly:debug "[~A" file-name)
480 (ly:error (_ "cannot find: ~A") x))
481 (primitive-load-path file-name) ;; to support Guile V2 autocompile
482 ;; TODO: Any chance to use ly:debug here? Need to extend it to prevent
483 ;; a newline in this case
484 (if (ly:get-option 'verbose)
485 (ly:progress "]\n"))))
488 (let ((platform (string-tokenize
489 (vector-ref (uname) 0) char-set:letter+digit)))
490 (if (null? (cdr platform)) #f
491 (member (string-downcase (cadr platform)) '("95" "98" "me")))))
494 (if (string-index x #\\)
496 (string-regexp-substitute
498 (string-regexp-substitute "\\\\" "/" x))))
500 (define-public (ly-getcwd)
501 (if (eq? PLATFORM 'windows)
505 (define-public (is-absolute? file-name)
506 (let ((file-name-length (string-length file-name)))
507 (if (= file-name-length 0)
509 (or (eq? (string-ref file-name 0) #\/)
510 (and (eq? PLATFORM 'windows)
511 (> file-name-length 2)
512 (eq? (string-ref file-name 1) #\:)
513 (or (eq? (string-ref file-name 2) #\\)
514 (eq? (string-ref file-name 2) #\/)))))))
516 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
517 ;;; If necessary, emulate Guile V2 module_export_all! for Guile V1.8.n
520 (define (module-export-all! mod)
521 (define (fresh-interface!)
522 (let ((iface (make-module)))
523 (set-module-name! iface (module-name mod))
524 ;; for guile 2: (set-module-version! iface (module-version mod))
525 (set-module-kind! iface 'interface)
526 (set-module-public-interface! mod iface)
528 (let ((iface (or (module-public-interface mod)
529 (fresh-interface!))))
530 (set-module-obarray! iface (module-obarray mod))))))
533 (define-safe-public (lilypond-version)
535 (map (lambda (x) (if (symbol? x)
541 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
544 (ly:set-default-scale (ly:make-scale #(0 1 2 5/2 7/2 9/2 11/2)))
546 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
550 ;; List of Scheme files to be loaded into the (lily) module.
552 ;; - Library definitions, need to be at the head of the list
553 (define init-scheme-files-lib
556 ;; - Files containing definitions used later by other files later in load
557 (define init-scheme-files-used
558 '("markup-macros.scm"
559 "parser-ly-from-scheme.scm"))
560 ;; - Main body of files to be loaded
561 (define init-scheme-files-body
563 "define-event-classes.scm"
564 "define-music-callbacks.scm"
565 "define-music-types.scm"
566 "define-note-names.scm"
571 "define-markup-commands.scm"
573 "modal-transforms.scm"
574 "chord-generic-names.scm"
575 "chord-ignatzek-names.scm"
576 "music-functions.scm"
579 "define-music-properties.scm"
581 "time-signature-settings.scm"
586 "define-context-properties.scm"
587 "translation-functions.scm"
601 "define-woodwind-diagrams.scm"
602 "display-woodwind-diagrams.scm"
603 "predefined-fretboards.scm"
604 "define-grob-properties.scm"
606 "define-grob-interfaces.scm"
607 "define-stencil-commands.scm"
608 "scheme-engravers.scm"
613 "backend-library.scm"
615 ;; - Files to be loaded last
616 (define init-scheme-files-tail
617 ;; - must be after everything has been defined
620 ;; Now construct the load list
622 (define init-scheme-files
623 (append init-scheme-files-lib
624 init-scheme-files-used
625 init-scheme-files-body
626 init-scheme-files-tail))
628 (for-each ly:load init-scheme-files)
630 (define-public r5rs-primary-predicates
631 `((,boolean? . "boolean")
632 (,char? . "character")
633 (,number? . "number")
636 (,procedure? . "procedure")
637 (,string? . "string")
638 (,symbol? . "symbol")
639 (,vector? . "vector")))
641 (define-public r5rs-secondary-predicates
642 `((,char-alphabetic? . "alphabetic character")
643 (,char-lower-case? . "lower-case character")
644 (,char-numeric? . "numeric character")
645 (,char-upper-case? . "upper-case character")
646 (,char-whitespace? . "whitespace character")
648 (,complex? . "complex number")
649 (,even? . "even number")
650 (,exact? . "exact number")
651 (,inexact? . "inexact number")
652 (,integer? . "integer")
653 (,negative? . "negative number")
654 (,odd? . "odd number")
655 (,positive? . "positive number")
656 (,rational? . "rational number")
657 (,real? . "real number")
663 (,input-port? . "input port")
664 (,output-port? . "output port")
666 ;; would this ever be used?
667 (,eof-object? . "end-of-file object")
670 (define-public guile-predicates
671 `((,hash-table? . "hash table")
674 (define-public lilypond-scheme-predicates
675 `((,boolean-or-symbol? . "boolean or symbol")
677 (,cheap-list? . "list")
678 (,fraction? . "fraction, as pair")
679 (,grob-list? . "list of grobs")
680 (,index? . "non-negative integer")
681 (,key? . "index or symbol")
682 (,key-list? . "list of indexes or symbols")
683 (,key-list-or-music? . "key list or music")
684 (,key-list-or-symbol? . "key list or symbol")
685 (,markup? . "markup")
686 (,markup-command-list? . "markup command list")
687 (,markup-list? . "markup list")
688 (,moment-pair? . "pair of moment objects")
689 (,number-list? . "number list")
690 (,number-or-grob? . "number or grob")
691 (,number-or-markup? . "number or markup")
692 (,number-or-pair? . "number or pair")
693 (,number-or-string? . "number or string")
694 (,number-pair? . "pair of numbers")
695 (,number-pair-list? . "list of number pairs")
696 (,rational-or-procedure? . "an exact rational or procedure")
697 (,rhythmic-location? . "rhythmic location")
698 (,scheme? . "any type")
699 (,string-or-pair? . "string or pair")
700 (,string-or-music? . "string or music")
701 (,string-or-symbol? . "string or symbol")
702 (,symbol-list? . "symbol list")
703 (,symbol-list-or-music? . "symbol list or music")
704 (,symbol-list-or-symbol? . "symbol list or symbol")
708 (define-public lilypond-exported-predicates
709 `((,ly:book? . "book")
711 (,ly:context? . "context")
712 (,ly:context-def? . "context definition")
713 (,ly:context-mod? . "context modification")
714 (,ly:dimension? . "dimension, in staff space")
715 (,ly:dir? . "direction")
716 (,ly:dispatcher? . "dispatcher")
717 (,ly:duration? . "duration")
718 (,ly:event? . "post event")
719 (,ly:font-metric? . "font metric")
720 (,ly:grob? . "graphical (layout) object")
721 (,ly:grob-array? . "array of grobs")
722 (,ly:grob-properties? . "grob properties")
723 (,ly:input-location? . "input location")
725 (,ly:iterator? . "iterator")
726 (,ly:lily-lexer? . "lily-lexer")
727 (,ly:lily-parser? . "lily-parser")
728 (,ly:listener? . "listener")
729 (,ly:moment? . "moment")
730 (,ly:music? . "music")
731 (,ly:music-function? . "music function")
732 (,ly:music-list? . "list of music objects")
733 (,ly:music-output? . "music output")
734 (,ly:otf-font? . "OpenType font")
735 (,ly:output-def? . "output definition")
736 (,ly:page-marker? . "page marker")
737 (,ly:pango-font? . "pango font")
738 (,ly:paper-book? . "paper book")
739 (,ly:paper-system? . "paper-system Prob")
740 (,ly:pitch? . "pitch")
741 (,ly:prob? . "property object")
742 (,ly:score? . "score")
743 (,ly:skyline? . "skyline")
744 (,ly:skyline-pair? . "pair of skylines")
745 (,ly:source-file? . "source file")
746 (,ly:spanner? . "spanner")
747 (,ly:spring? . "spring")
748 (,ly:stencil? . "stencil")
749 (,ly:stream-event? . "stream event")
750 (,ly:translator? . "translator")
751 (,ly:translator-group? . "translator group")
752 (,ly:undead? . "undead container")
753 (,ly:unpure-pure-container? . "unpure/pure container")
757 (set! type-p-name-alist
758 (append r5rs-primary-predicates
759 r5rs-secondary-predicates
761 lilypond-scheme-predicates
762 lilypond-exported-predicates))
765 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
768 (define (profile-measurements)
771 (list (- (+ (tms:cutime t)
773 (assoc-get 'gc-time-taken stats))
774 (assoc-get 'total-cells-allocated stats 0))))
776 (define (dump-profile base last this)
777 (let* ((outname (format #f "~a.profile" (dir-basename base ".ly")))
778 (diff (map - this last)))
779 (ly:progress "\nWriting timing to ~a...\n" outname)
780 (format (open-file outname "w")
781 "time: ~a\ncells: ~a\n"
782 (if (ly:get-option 'dump-cpu-profile)
787 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
788 ;; debug memory leaks
793 (define gc-protect-stat-count
796 ;; Undead objects that should be ignored after the first time round
798 (make-weak-key-hash-table 0))
800 (define-public (dump-live-object-stats outfile)
801 (for-each (lambda (x)
802 (format outfile "~a: ~a\n" (car x) (cdr x)))
803 (sort (gc-live-object-stats)
805 (string<? (car x) (car y))))))
807 (define-public (dump-gc-protects)
808 (set! gc-protect-stat-count (1+ gc-protect-stat-count))
809 (let* ((protects (sort (hash-table->alist (ly:protects))
811 (< (object-address (car a))
812 (object-address (car b))))))
813 (out-file-name (string-append
814 "gcstat-" (number->string gc-protect-stat-count)
816 (outfile (open-file out-file-name "w")))
818 (ly:progress "Dumping GC statistics ~a...\n" out-file-name)
819 (for-each (lambda (y)
822 (format outfile "~a (~a) = ~a\n" (object-address x) c x)))
825 (not (symbol? (car x))))
827 (format outfile "\nprotected symbols: ~a\n"
828 (apply + (map (lambda (obj-count)
829 (if (symbol? (car obj-count))
834 ;; (display (ly:smob-protects))
836 (if (defined? 'gc-live-object-stats)
838 (ly:progress "Live object statistics: GC'ing\n")
842 (ly:progress "Asserting dead objects\n")
843 (ly:set-option 'debug-gc-assert-parsed-dead #t)
845 (ly:set-option 'debug-gc-assert-parsed-dead #f)
848 (if (not (hashq-ref gc-zombies x))
850 (ly:programming-error "Parsed object should be dead: ~a" x)
851 (hashq-set! gc-zombies x #t))))
852 (ly:parsed-undead-list!))
853 (set! stats (gc-live-object-stats))
854 (ly:progress "Dumping live object statistics.\n")
855 (dump-live-object-stats outfile)))
857 (let* ((stats (gc-stats)))
858 (for-each (lambda (sym)
859 (format outfile "~a ~a ~a\n"
860 gc-protect-stat-count
862 (assoc-get sym stats "?")))
863 '(protected-objects bytes-malloced cell-heap-size)))
865 (close-port outfile)))
867 (define (check-memory)
868 "Read `/proc/self' to check up on memory use."
869 (define (gulp-file name)
870 (let* ((file (open-input-file name))
871 (text (read-delimited "" file)))
875 (let* ((stat (gulp-file "/proc/self/status"))
876 (lines (string-split stat #\newline))
877 (interesting (filter-map
879 (string-match "^VmData:[ \t]*([0-9]*) kB" l))
881 (mem (string->number (match:substring (car interesting) 1))))
882 (format #t "VMDATA: ~a\n" mem)
886 (begin (dump-gc-protects)
889 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
891 (define (multi-fork count)
892 "Split this process into COUNT helpers. Returns either a list of
893 PIDs or the number of the process."
894 (define (helper count acc)
896 (let* ((pid (primitive-fork)))
899 (helper (1- count) (cons pid acc))))
904 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
906 (define* (ly:exit status #:optional (silently #f))
907 "Exit function for lilypond"
910 ((0) (ly:basic-progress (_ "Success: compilation successfully completed")))
911 ((1) (ly:warning (_ "Compilation completed with warnings or errors")))
912 (else (ly:message ""))))
915 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
917 (define-public (lilypond-main files)
918 "Entry point for LilyPond."
919 (eval-string (ly:command-line-code))
920 (if (ly:get-option 'help)
921 (begin (ly:option-usage)
923 (if (ly:get-option 'show-available-fonts)
924 (begin (ly:font-config-display-fonts)
926 (if (ly:get-option 'gui)
931 (if (ly:get-option 'read-file-list)
936 (string-split (string-delete (ly:gulp-file f) #\cr) #\nl))
938 (if (and (number? (ly:get-option 'job-count))
939 (>= (length files) (ly:get-option 'job-count)))
940 (let* ((count (ly:get-option 'job-count))
941 (split-todo (split-list files count))
942 (joblist (multi-fork count))
944 (if (not (string-or-symbol? (ly:get-option 'log-file)))
945 (ly:set-option 'log-file "lilypond-multi-run"))
946 (if (number? joblist)
947 (begin (ly:set-option
948 'log-file (format #f "~a-~a"
949 (ly:get-option 'log-file) joblist))
950 (set! files (vector-ref split-todo joblist)))
951 (begin (ly:progress "\nForking into jobs: ~a\n" joblist)
954 (let* ((stat (cdr (waitpid pid))))
957 (acons (list-element-index joblist pid)
964 (logfile (format #f "~a-~a.log"
965 (ly:get-option 'log-file) job))
966 (log (ly:gulp-file logfile))
967 (len (string-length log))
968 (tail (substring log (max 0 (- len 1024)))))
969 (if (status:term-sig state)
972 (format #f (_ "job ~a terminated with signal: ~a")
973 job (status:term-sig state)))
975 (_ "logfile ~a (exit ~a):\n~a")
976 logfile (status:exit-val state) tail))))
979 (ly:error "Children ~a exited with errors."
981 ;; must overwrite individual entries
982 (if (ly:get-option 'dump-profile)
983 (dump-profile "lily-run-total"
984 '(0 0) (profile-measurements)))
989 (if (string-or-symbol? (ly:get-option 'log-file))
990 (ly:stderr-redirect (format #f "~a.log" (ly:get-option 'log-file)) "w"))
991 (let ((failed (lilypond-all files)))
992 (if (ly:get-option 'trace-scheme-coverage)
994 (coverage:show-all (lambda (f)
995 (string-contains f "lilypond")))))
997 (begin (ly:error (_ "failed files: ~S") (string-join failed))
1003 (define-public (lilypond-all files)
1005 (separate-logs (ly:get-option 'separate-log-files))
1008 (if (string-or-symbol? (ly:get-option 'log-file))
1009 (open-file (format #f "~a.log" (ly:get-option 'log-file))
1011 (fdes->outport 2))))
1012 (do-measurements (ly:get-option 'dump-profile))
1013 (handler (lambda (key failed-file)
1014 (set! failed (append (list failed-file) failed)))))
1018 (let* ((start-measurements (if do-measurements
1019 (profile-measurements)
1021 (base (dir-basename x ".ly"))
1022 (all-settings (ly:all-options)))
1024 (ly:stderr-redirect (format #f "~a.log" base) "w"))
1026 (format ping-log "Processing ~a\n" base))
1027 (if (ly:get-option 'trace-memory-frequency)
1028 (mtrace:start-trace (ly:get-option 'trace-memory-frequency)))
1029 (lilypond-file handler x)
1030 (ly:check-expected-warnings)
1032 (if start-measurements
1033 (dump-profile x start-measurements (profile-measurements)))
1034 (if (ly:get-option 'trace-memory-frequency)
1035 (begin (mtrace:stop-trace)
1036 (mtrace:dump-results base)))
1037 (for-each (lambda (s)
1038 (ly:set-option (car s) (cdr s)))
1040 (ly:set-option 'debug-gc-assert-parsed-dead #t)
1042 (ly:set-option 'debug-gc-assert-parsed-dead #f)
1045 (if (not (hashq-ref gc-zombies x))
1047 (ly:programming-error "Parsed object should be dead: ~a" x)
1048 (hashq-set! gc-zombies x #t))))
1049 (ly:parsed-undead-list!))
1050 (if (ly:get-option 'debug-gc)
1052 (ly:reset-all-fonts))
1056 ;; Ensure a notice re failed files is written to aggregate logfile.
1058 (format ping-log "Failed files: ~a\n" failed))
1059 (if (ly:get-option 'dump-profile)
1060 (dump-profile "lily-run-total" '(0 0) (profile-measurements)))
1063 (define (lilypond-file handler file-name)
1064 (catch 'ly-file-failed
1065 (lambda () (ly:parse-file file-name))
1066 (lambda (x . args) (handler x file-name))))
1068 (use-modules (scm editor))
1070 (define-public (gui-main files)
1072 (gui-no-files-handler))
1073 (if (not (string? (ly:get-option 'log-file)))
1074 (let* ((base (dir-basename (car files) ".ly"))
1075 (log-name (string-append base ".log")))
1076 (if (not (ly:get-option 'gui))
1077 (ly:message (_ "Redirecting output to ~a...") log-name))
1078 (ly:stderr-redirect log-name "w")
1079 (ly:message "# -*-compilation-*-"))
1080 (let ((failed (lilypond-all files)))
1084 (ly:stderr-redirect "foo" "r")
1085 (system (get-editor-command log-name 0 0 0))
1086 (ly:error (_ "failed files: ~S") (string-join failed))
1091 (define (gui-no-files-handler)
1092 (let* ((ly (string-append (ly:effective-prefix) "/ly/"))
1093 ;; FIXME: soft-code, localize
1094 (welcome-ly (string-append ly "Welcome_to_LilyPond.ly"))
1095 (cmd (get-editor-command welcome-ly 0 0 0)))
1096 (ly:message (_ "Invoking `~a'...\n") cmd)