scm/lily.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
   4 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
   5 ;;;;
   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.
  10 ;;;;
  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.
  15 ;;;;
  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/>.
  18
  19 ;; Internationalisation: (_i "to be translated") gets an entry in the
  20 ;; POT file; (gettext ...) must be invoked explicitly to do the actual
  21 ;; "translation".
  22 ;;
  23 ;; (define-macro (_i x) x)
  24 ;; (define-macro-public _i (x) x)
  25 ;; (define-public-macro _i (x) x)
  26 ;; Abbrv-PWR!
  27
  28 (defmacro-public _i (x) x)
  29
  30 ;;; Boolean thunk - are we integrating Guile V2.0 or higher with LilyPond?
  31 (define-public (guile-v2)
  32   (string>? (version) "1.9.10"))
  33
  34 (read-enable 'positions)
  35 (if (not (guile-v2))
  36     (debug-enable 'debug)
  37     (begin
  38       (debug-enable 'backtrace)
  39       (debug-set! show-file-name #t)))
  40
  41 (define-public PLATFORM
  42   (string->symbol
  43    (string-downcase
  44     (car (string-tokenize (utsname:sysname (uname)))))))
  45
  46 (define scheme-options-definitions
  47   `(
  48     ;; NAMING: either
  49
  50     ;; - [subject-]object-object-verb +"ing"
  51     ;; - [subject-]-verb-object-object
  52
  53     ;; Avoid overlong lines in `lilypond -dhelp'!  Strings should not
  54     ;; be longer than 48 characters per line.
  55
  56     (anti-alias-factor 1
  57 "Render at higher resolution (using given factor)
  58 and scale down result to prevent jaggies in
  59 PNG images.")
  60     (aux-files #t
  61 "Create .tex, .texi, .count files in the
  62 EPS backend.")
  63     (backend ps
  64 "Select backend.  Possible values: 'eps, 'null,
  65 'ps, 'scm, 'socket, 'svg.")
  66     (check-internal-types #f
  67 "Check every property assignment for types.")
  68     (clip-systems #f
  69 "Generate cut-out snippets of a score.")
  70     (datadir #f
  71 "LilyPond prefix for data files (read-only).")
  72     (debug-gc #f
  73 "Dump memory debugging statistics.")
  74     (debug-gc-assert-parsed-dead #f
  75 "For memory debugging: Ensure that all
  76 references to parsed objects are dead.  This is
  77 an internal option, and is switched on
  78 automatically for `-ddebug-gc'.")
  79     (debug-lexer #f
  80 "Debug the flex lexer.")
  81     (debug-page-breaking-scoring #f
  82 "Dump scores for many different page breaking
  83 configurations.")
  84     (debug-parser #f
  85 "Debug the bison parser.")
  86     (debug-property-callbacks #f
  87 "Debug cyclic callback chains.")
  88     (debug-skylines #f
  89 "Debug skylines.")
  90     (delete-intermediate-files #t
  91 "Delete unusable, intermediate PostScript files.")
  92     (dump-profile #f
  93 "Dump memory and time information for each file.")
  94     (dump-cpu-profile #f
  95 "Dump timing information (system-dependent).")
  96     (dump-signatures #f
  97 "Dump output signatures of each system.  Used for
  98 regression testing.")
  99     (eps-box-padding #f
 100 "Pad left edge of the output EPS bounding box by
 101 given amount (in mm).")
 102     (gs-load-fonts #f
 103 "Load fonts via Ghostscript.")
 104     (gs-load-lily-fonts #f
 105 "Load only LilyPond fonts via Ghostscript.")
 106     (gui #f
 107 "Run LilyPond from a GUI and redirect stderr to
 108 a log file.")
 109     (help #f
 110 "Show this help.")
 111     (include-book-title-preview #t
 112 "Include book titles in preview images.")
 113     (include-eps-fonts #t
 114 "Include fonts in separate-system EPS files.")
 115     (include-settings #f
 116 "Include file for global settings, included before the score is processed.")
 117     (job-count #f
 118 "Process in parallel, using the given number of
 119 jobs.")
 120     (log-file #f
 121 "If string FOO is given as argument, redirect
 122 output to log file `FOO.log'.")
 123     (max-markup-depth 1024
 124 "Maximum depth for the markup tree. If a markup has more levels,
 125 assume it will not terminate on its own, print a warning and return a
 126 null markup instead.")
 127     (midi-extension ,(if (eq? PLATFORM 'windows)
 128                          "mid"
 129                          "midi")
 130 "Set the default file extension for MIDI output
 131 file to given string.")
 132     (music-strings-to-paths #f
 133 "Convert text strings to paths when glyphs belong
 134 to a music font.")
 135     (old-relative #f
 136 "Make \\relative mode for simultaneous music work
 137 similar to chord syntax.")
 138     (point-and-click #t
 139 "Add point & click links to PDF output.")
 140     (paper-size "a4"
 141 "Set default paper size.")
 142     (pixmap-format "png16m"
 143 "Set GhostScript's output format for pixel images.")
 144     (preview #f
 145 "Create preview images also.")
 146     (print-pages #t
 147 "Print pages in the normal way.")
 148     (protected-scheme-parsing #t
 149 "Continue when errors in inline scheme are caught
 150 in the parser.  If #f, halt on errors and print
 151 a stack trace.")
 152     (profile-property-accesses #f
 153 "Keep statistics of get_property() calls.")
 154     (resolution 101
 155 "Set resolution for generating PNG pixmaps to
 156 given value (in dpi).")
 157     (read-file-list #f
 158 "Specify name of a file which contains a list of
 159 input files to be processed.")
 160     (relative-includes #f
 161 "When processing an \\include command, look for
 162 the included file relative to the current file
 163 (instead of the root file)")
 164     (safe #f
 165 "Run in safer mode.")
 166     (separate-log-files #f
 167 "For input files `FILE1.ly', `FILE2.ly', ...
 168 output log data to files `FILE1.log',
 169 `FILE2.log', ...")
 170     (show-available-fonts #f
 171 "List available font names.")
 172     (strict-infinity-checking #f
 173 "Force a crash on encountering Inf and NaN
 174 floating point exceptions.")
 175     (strip-output-dir #t
 176 "Don't use directories from input files while
 177 constructing output file names.")
 178     (svg-woff #f
 179 "Use woff font files in SVG backend.")
 180     (trace-memory-frequency #f
 181 "Record Scheme cell usage this many times per
 182 second.  Dump results to `FILE.stacks' and
 183 `FILE.graph'.")
 184     (trace-scheme-coverage #f
 185 "Record coverage of Scheme files in `FILE.cov'.")
 186     (verbose ,(ly:verbose-output?)
 187 "Verbose output, i.e. loglevel at least DEBUG (read-only).")
 188     (warning-as-error #f
 189 "Change all warning and programming_error
 190 messages into errors.")
 191     ))
 192
 193 ;; Need to do this in the beginning.  Other parts of the Scheme
 194 ;; initialization depend on these options.
 195
 196 (for-each (lambda (x)
 197             (ly:add-option (car x) (cadr x) (caddr x)))
 198           scheme-options-definitions)
 199
 200 (for-each (lambda (x)
 201             (ly:set-option (car x) (cdr x)))
 202           (eval-string (ly:command-line-options)))
 203
 204 (debug-set! stack 0)
 205
 206 (if (defined? 'set-debug-cell-accesses!)
 207     (set-debug-cell-accesses! #f))
 208
 209 ;;(set-debug-cell-accesses! 1000)
 210
 211 (use-modules (ice-9 regex)
 212              (ice-9 safe)
 213              (ice-9 format)
 214              (ice-9 rdelim)
 215              (ice-9 optargs)
 216              (oop goops)
 217              (srfi srfi-1)
 218              (srfi srfi-13)
 219              (srfi srfi-14)
 220              (scm clip-region)
 221              (scm memory-trace)
 222              (scm coverage)
 223              (scm safe-utility-defs))
 224
 225 (define-public _ gettext)
 226 ;;; There are new modules defined in Guile V2.0 which we need to use.
 227 ;;
 228 ;;  Modules and scheme files loaded by lily.scm use currying
 229 ;;  in Guile V2 this needs a module which is not present in Guile V1.8
 230 ;;
 231
 232 (cond
 233   ((guile-v2)
 234    (ly:debug (_ "Using (ice-9 curried-definitions) module\n"))
 235    (use-modules (ice-9 curried-definitions)))
 236   (else
 237     (ly:debug (_ "Guile 1.8\n"))))
 238
 239 ;; TODO add in modules for V1.8.7 deprecated in V2.0 and integrated
 240 ;; into Guile base code, like (ice-9 syncase).
 241 ;;
 242
 243 (define-public fancy-format
 244   format)
 245
 246 (define-public (ergonomic-simple-format dest . rest)
 247   "Like ice-9's @code{format}, but without the memory consumption."
 248   (if (string? dest)
 249       (apply simple-format (cons #f (cons dest rest)))
 250       (apply simple-format (cons dest rest))))
 251
 252 (define format
 253   ergonomic-simple-format)
 254
 255 ;; my display
 256 (define-public (myd k v)
 257   (display k)
 258   (display ": ")
 259   (display v)
 260   (display ", ")
 261   v)
 262
 263 (define-public (print . args)
 264   (apply format (cons (current-output-port) args)))
 265
 266
 267 ;;; General settings.
 268 ;;;
 269 ;;; Debugging evaluator is slower.  This should have a more sensible
 270 ;;; default.
 271
 272
 273 (if (or (ly:get-option 'verbose)
 274         (ly:get-option 'trace-memory-frequency)
 275         (ly:get-option 'trace-scheme-coverage))
 276     (begin
 277       (ly:set-option 'protected-scheme-parsing #f)
 278       (debug-enable 'backtrace)
 279       (read-enable 'positions)))
 280
 281 (if (ly:get-option 'trace-scheme-coverage)
 282     (coverage:enable))
 283
 284 (define-public parser #f)
 285
 286 (define music-string-to-path-backends
 287   '(svg))
 288
 289 (if (memq (ly:get-option 'backend) music-string-to-path-backends)
 290     (ly:set-option 'music-strings-to-paths #t))
 291
 292
 293 (define-public (ly:load x)
 294   (let* ((file-name (%search-load-path x)))
 295     (ly:debug "[~A" file-name)
 296     (if (not file-name)
 297         (ly:error (_ "cannot find: ~A") x))
 298     (primitive-load-path file-name)  ;; to support Guile V2 autocompile
 299     ;; TODO: Any chance to use ly:debug here? Need to extend it to prevent
 300     ;;       a newline in this case
 301     (if (ly:get-option 'verbose)
 302         (ly:progress "]\n"))))
 303
 304 (define-public DOS
 305   (let ((platform (string-tokenize
 306                    (vector-ref (uname) 0) char-set:letter+digit)))
 307     (if (null? (cdr platform)) #f
 308         (member (string-downcase (cadr platform)) '("95" "98" "me")))))
 309
 310 (define (slashify x)
 311   (if (string-index x #\\)
 312       x
 313       (string-regexp-substitute
 314         "//*" "/"
 315         (string-regexp-substitute "\\\\" "/" x))))
 316
 317 (define-public (ly-getcwd)
 318   (if (eq? PLATFORM 'windows)
 319       (slashify (getcwd))
 320       (getcwd)))
 321
 322 (define-public (is-absolute? file-name)
 323   (let ((file-name-length (string-length file-name)))
 324     (if (= file-name-length 0)
 325         #f
 326         (or (eq? (string-ref file-name 0) #\/)
 327             (and (eq? PLATFORM 'windows)
 328                  (> file-name-length 2)
 329                  (eq? (string-ref file-name 1) #\:)
 330                  (eq? (string-ref file-name 2) #\/))))))
 331
 332 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 333 ;;; If necessary, emulate Guile V2 module_export_all! for Guile V1.8.n
 334 (cond-expand
 335  ((not guile-v2)
 336   (define (module-export-all! mod)
 337     (define (fresh-interface!)
 338       (let ((iface (make-module)))
 339         (set-module-name! iface (module-name mod))
 340         ;; for guile 2: (set-module-version! iface (module-version mod))
 341         (set-module-kind! iface 'interface)
 342         (set-module-public-interface! mod iface)
 343         iface))
 344     (let ((iface (or (module-public-interface mod)
 345                      (fresh-interface!))))
 346       (set-module-obarray! iface (module-obarray mod))))))
 347
 348
 349 (define-safe-public (lilypond-version)
 350   (string-join
 351    (map (lambda (x) (if (symbol? x)
 352                         (symbol->string x)
 353                         (number->string x)))
 354         (ly:version))
 355    "."))
 356
 357 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 358 ;; init pitch system
 359
 360 (ly:set-default-scale (ly:make-scale #(0 1 2 5/2 7/2 9/2 11/2)))
 361
 362 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 363 ;; other files.
 364
 365 ;;
 366 ;;  List of Scheme files to be loaded into the (lily) module.
 367 ;;
 368 ;;  - Library definitions, need to be at the head of the list
 369 (define init-scheme-files-lib
 370   '("lily-library.scm"
 371     "output-lib.scm"))
 372 ;;  - Files containing definitions used later by other files later in load
 373 (define init-scheme-files-used
 374   '("markup-macros.scm"
 375     "parser-ly-from-scheme.scm"))
 376 ;;  - Main body of files to be loaded
 377 (define init-scheme-files-body
 378   '("file-cache.scm"
 379     "define-event-classes.scm"
 380     "define-music-callbacks.scm"
 381     "define-music-types.scm"
 382     "define-note-names.scm"
 383     "c++.scm"
 384     "chord-entry.scm"
 385     "stencil.scm"
 386     "define-markup-commands.scm"
 387     "markup.scm"
 388     "modal-transforms.scm"
 389     "chord-generic-names.scm"
 390     "chord-ignatzek-names.scm"
 391     "music-functions.scm"
 392     "part-combiner.scm"
 393     "autochange.scm"
 394     "define-music-properties.scm"
 395     "time-signature-settings.scm"
 396     "auto-beam.scm"
 397     "chord-name.scm"
 398     "bezier-tools.scm"
 399     "ly-syntax-constructors.scm"
 400
 401     "define-context-properties.scm"
 402     "translation-functions.scm"
 403     "script.scm"
 404     "midi.scm"
 405     "layout-beam.scm"
 406     "parser-clef.scm"
 407     "layout-slur.scm"
 408     "font.scm"
 409     "encoding.scm"
 410
 411     "bar-line.scm"
 412     "flag-styles.scm"
 413     "fret-diagrams.scm"
 414     "tablature.scm"
 415     "harp-pedals.scm"
 416     "define-woodwind-diagrams.scm"
 417     "display-woodwind-diagrams.scm"
 418     "predefined-fretboards.scm"
 419     "define-grob-properties.scm"
 420     "define-grobs.scm"
 421     "define-grob-interfaces.scm"
 422     "define-stencil-commands.scm"
 423     "titling.scm"
 424     "text.scm"
 425
 426     "paper.scm"
 427     "backend-library.scm"
 428     "x11-color.scm"))
 429 ;;  - Files to be loaded last
 430 (define init-scheme-files-tail
 431 ;;  - must be after everything has been defined
 432   '("safe-lily.scm"))
 433 ;;
 434 ;; Now construct the load list
 435 ;;
 436 (define init-scheme-files
 437   (append init-scheme-files-lib
 438           init-scheme-files-used
 439           init-scheme-files-body
 440           init-scheme-files-tail))
 441
 442 (for-each ly:load init-scheme-files)
 443
 444 (define-public r5rs-primary-predicates
 445   `((,boolean? . "boolean")
 446     (,char? . "character")
 447     (,number? . "number")
 448     (,pair? . "pair")
 449     (,port? . "port")
 450     (,procedure? . "procedure")
 451     (,string? . "string")
 452     (,symbol? . "symbol")
 453     (,vector? . "vector")))
 454
 455 (define-public r5rs-secondary-predicates
 456   `((,char-alphabetic? . "alphabetic character")
 457     (,char-lower-case? . "lower-case character")
 458     (,char-numeric? . "numeric character")
 459     (,char-upper-case? . "upper-case character")
 460     (,char-whitespace? . "whitespace character")
 461
 462     (,complex? . "complex number")
 463     (,even? . "even number")
 464     (,exact? . "exact number")
 465     (,inexact? . "inexact number")
 466     (,integer? . "integer")
 467     (,negative? . "negative number")
 468     (,odd? . "odd number")
 469     (,positive? . "positive number")
 470     (,rational? . "rational number")
 471     (,real? . "real number")
 472     (,zero? . "zero")
 473
 474     (,list? . "list")
 475     (,null? . "null")
 476
 477     (,input-port? . "input port")
 478     (,output-port? . "output port")
 479
 480     ;; would this ever be used?
 481     (,eof-object? . "end-of-file object")
 482     ))
 483
 484 (define-public guile-predicates
 485   `((,hash-table? . "hash table")
 486   ))
 487
 488 (define-public lilypond-scheme-predicates
 489   `((,boolean-or-symbol? . "boolean or symbol")
 490     (,color? . "color")
 491     (,cheap-list? . "list")
 492     (,fraction? . "fraction, as pair")
 493     (,grob-list? . "list of grobs")
 494     (,index? . "non-negative integer")
 495     ;; this is built on cheap-list
 496     (,list-or-symbol? . "list or symbol")
 497     (,markup? . "markup")
 498     (,markup-command-list? . "markup command list")
 499     (,markup-list? . "markup list")
 500     (,moment-pair? . "pair of moment objects")
 501     (,number-list? . "number list")
 502     (,number-or-grob? . "number or grob")
 503     (,number-or-pair? . "number or pair")
 504     (,number-or-string? . "number or string")
 505     (,number-pair? . "pair of numbers")
 506     (,rhythmic-location? . "rhythmic location")
 507     (,scheme? . "any type")
 508     (,string-or-pair? . "string or pair")
 509     (,string-or-symbol? . "string or symbol")
 510     (,void? . "void")
 511     ))
 512
 513 (define-public lilypond-exported-predicates
 514   `((,ly:book? . "book")
 515     (,ly:box? . "box")
 516     (,ly:context? . "context")
 517     (,ly:context-def? . "context definition")
 518     (,ly:context-mod? . "context modification")
 519     (,ly:dimension? . "dimension, in staff space")
 520     (,ly:dir? . "direction")
 521     (,ly:dispatcher? . "dispatcher")
 522     (,ly:duration? . "duration")
 523     (,ly:event? . "post event")
 524     (,ly:font-metric? . "font metric")
 525     (,ly:grob? . "graphical (layout) object")
 526     (,ly:grob-array? . "array of grobs")
 527     (,ly:input-location? . "input location")
 528     (,ly:item? . "item")
 529     (,ly:iterator? . "iterator")
 530     (,ly:lily-lexer? . "lily-lexer")
 531     (,ly:lily-parser? . "lily-parser")
 532     (,ly:listener? . "listener")
 533     (,ly:moment? . "moment")
 534     (,ly:music? . "music")
 535     (,ly:music-function? . "music function")
 536     (,ly:music-list? . "list of music objects")
 537     (,ly:music-output? . "music output")
 538     (,ly:otf-font? . "OpenType font")
 539     (,ly:output-def? . "output definition")
 540     (,ly:page-marker? . "page marker")
 541     (,ly:pango-font? . "pango font")
 542     (,ly:paper-book? . "paper book")
 543     (,ly:paper-system? . "paper-system Prob")
 544     (,ly:pitch? . "pitch")
 545     (,ly:prob? . "property object")
 546     (,ly:score? . "score")
 547     (,ly:simple-closure? . "simple closure")
 548     (,ly:skyline? . "skyline")
 549     (,ly:skyline-pair? . "pair of skylines")
 550     (,ly:source-file? . "source file")
 551     (,ly:spanner? . "spanner")
 552     (,ly:spring? . "spring")
 553     (,ly:stencil? . "stencil")
 554     (,ly:stream-event? . "stream event")
 555     (,ly:translator? . "translator")
 556     (,ly:translator-group? . "translator group")
 557     (,ly:unpure-pure-container? . "unpure/pure container")
 558     ))
 559
 560
 561 (set! type-p-name-alist
 562       (append r5rs-primary-predicates
 563               r5rs-secondary-predicates
 564               guile-predicates
 565               lilypond-scheme-predicates
 566               lilypond-exported-predicates))
 567
 568
 569 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 570 ;; timing
 571
 572 (define (profile-measurements)
 573   (let* ((t (times))
 574          (stats (gc-stats)))
 575     (list (- (+ (tms:cutime t)
 576                 (tms:utime t))
 577              (assoc-get 'gc-time-taken stats))
 578           (assoc-get 'total-cells-allocated  stats 0))))
 579
 580 (define (dump-profile base last this)
 581   (let* ((outname (format #f "~a.profile" (dir-basename base ".ly")))
 582          (diff (map (lambda (y) (apply - y)) (zip this last))))
 583     (ly:progress "\nWriting timing to ~a..." outname)
 584     (format (open-file outname "w")
 585             "time: ~a\ncells: ~a\n"
 586             (if (ly:get-option 'dump-cpu-profile)
 587                 (car diff)
 588                 0)
 589             (cadr diff))))
 590
 591 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 592 ;; debug memory leaks
 593
 594 (define gc-dumping
 595   #f)
 596
 597 (define gc-protect-stat-count
 598   0)
 599
 600 (define-public (dump-live-object-stats outfile)
 601   (for-each (lambda (x)
 602               (format outfile "~a: ~a\n" (car x) (cdr x)))
 603             (sort (gc-live-object-stats)
 604                   (lambda (x y)
 605                     (string<? (car x) (car y))))))
 606
 607 (define-public (dump-gc-protects)
 608   (set! gc-protect-stat-count (1+ gc-protect-stat-count))
 609   (let* ((protects (sort (hash-table->alist (ly:protects))
 610                          (lambda (a b)
 611                            (< (object-address (car a))
 612                               (object-address (car b))))))
 613         (out-file-name (string-append
 614                        "gcstat-" (number->string gc-protect-stat-count)
 615                        ".scm"))
 616         (outfile (open-file out-file-name "w")))
 617     (set! gc-dumping #t)
 618     (ly:progress "Dumping GC statistics ~a...\n" out-file-name)
 619     (for-each (lambda (y)
 620                 (let ((x (car y))
 621                       (c (cdr y)))
 622                   (format outfile "~a (~a) = ~a\n" (object-address x) c x)))
 623               (filter
 624                (lambda (x)
 625                  (not (symbol? (car x))))
 626                protects))
 627     (format outfile "\nprotected symbols: ~a\n"
 628             (apply + (map (lambda (obj-count)
 629                             (if (symbol? (car obj-count))
 630                                 (cdr obj-count)
 631                                 0))
 632                           protects)))
 633
 634     ;; (display (ly:smob-protects))
 635     (newline outfile)
 636     (if (defined? 'gc-live-object-stats)
 637         (let* ((stats #f))
 638           (ly:progress "Live object statistics: GC'ing\n")
 639           (ly:reset-all-fonts)
 640           (gc)
 641           (gc)
 642           (ly:progress "Asserting dead objects\n")
 643           (ly:set-option 'debug-gc-assert-parsed-dead #t)
 644           (gc)
 645           (ly:set-option 'debug-gc-assert-parsed-dead #f)
 646           (for-each
 647            (lambda (x)
 648              (ly:programming-error "Parsed object should be dead: ~a" x))
 649            (ly:parsed-undead-list!))
 650           (set! stats (gc-live-object-stats))
 651           (ly:progress "Dumping live object statistics.\n")
 652           (dump-live-object-stats outfile)))
 653     (newline outfile)
 654     (let* ((stats (gc-stats)))
 655       (for-each (lambda (sym)
 656                   (format outfile "~a ~a ~a\n"
 657                           gc-protect-stat-count
 658                           sym
 659                           (assoc-get sym stats "?")))
 660                 '(protected-objects bytes-malloced cell-heap-size)))
 661     (set! gc-dumping #f)
 662     (close-port outfile)))
 663
 664 (define (check-memory)
 665   "Read `/proc/self' to check up on memory use."
 666   (define (gulp-file name)
 667     (let* ((file (open-input-file name))
 668            (text (read-delimited "" file)))
 669       (close file)
 670       text))
 671
 672   (let* ((stat (gulp-file "/proc/self/status"))
 673          (lines (string-split stat #\newline))
 674          (interesting (filter identity
 675                               (map
 676                                (lambda (l)
 677                                  (string-match "^VmData:[ \t]*([0-9]*) kB" l))
 678                                lines)))
 679          (mem (string->number (match:substring (car interesting) 1))))
 680     (format #t "VMDATA: ~a\n" mem)
 681     (display (gc-stats))
 682     (newline)
 683     (if (> mem 500000)
 684         (begin (dump-gc-protects)
 685                (raise 1)))))
 686
 687 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 688
 689 (define (multi-fork count)
 690   "Split this process into COUNT helpers.  Returns either a list of
 691 PIDs or the number of the process."
 692   (define (helper count acc)
 693     (if (> count 0)
 694         (let* ((pid (primitive-fork)))
 695               (if (= pid 0)
 696                   (1- count)
 697                   (helper (1- count) (cons pid acc))))
 698         acc))
 699
 700   (helper count '()))
 701
 702 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 703
 704 (define* (ly:exit status #:optional (silently #f))
 705   "Exit function for lilypond"
 706   (if (not silently)
 707       (case status
 708         ((0) (ly:basic-progress (_ "Success: compilation successfully completed")))
 709         ((1) (ly:warning (_ "Compilation completed with warnings or errors")))
 710         (else (ly:message ""))))
 711   (exit status))
 712
 713 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 714
 715 (define-public (lilypond-main files)
 716   "Entry point for LilyPond."
 717   (eval-string (ly:command-line-code))
 718   (if (ly:get-option 'help)
 719       (begin (ly:option-usage)
 720              (ly:exit 0 #t)))
 721   (if (ly:get-option 'show-available-fonts)
 722       (begin (ly:font-config-display-fonts)
 723              (ly:exit 0 #t)))
 724   (if (ly:get-option 'gui)
 725       (gui-main files))
 726   (if (null? files)
 727       (begin (ly:usage)
 728              (ly:exit 2 #t)))
 729   (if (ly:get-option 'read-file-list)
 730       (set! files
 731             (filter (lambda (s)
 732                       (> (string-length s) 0))
 733                     (apply append
 734                            (map (lambda (f)
 735                                   (string-split (string-delete (ly:gulp-file f) #\cr) #\nl))
 736                                 files)))))
 737   (if (and (number? (ly:get-option 'job-count))
 738            (>= (length files) (ly:get-option 'job-count)))
 739       (let* ((count (ly:get-option 'job-count))
 740              (split-todo (split-list files count))
 741              (joblist (multi-fork count))
 742              (errors '()))
 743         (if (not (string-or-symbol? (ly:get-option 'log-file)))
 744             (ly:set-option 'log-file "lilypond-multi-run"))
 745         (if (number? joblist)
 746             (begin (ly:set-option
 747                     'log-file (format #f "~a-~a"
 748                                       (ly:get-option 'log-file) joblist))
 749                     (set! files (vector-ref split-todo joblist)))
 750             (begin (ly:progress "\nForking into jobs:  ~a\n" joblist)
 751                    (for-each
 752                     (lambda (pid)
 753                       (let* ((stat (cdr (waitpid pid))))
 754                         (if (not (= stat 0))
 755                             (set! errors
 756                                   (acons (list-element-index joblist pid)
 757                                  stat errors)))))
 758                     joblist)
 759                    (for-each
 760                     (lambda (x)
 761                       (let* ((job (car x))
 762                              (state (cdr x))
 763                              (logfile (format #f "~a-~a.log"
 764                                               (ly:get-option 'log-file) job))
 765                              (log (ly:gulp-file logfile))
 766                              (len (string-length log))
 767                              (tail (substring  log (max 0 (- len 1024)))))
 768                         (if (status:term-sig state)
 769                             (ly:message
 770                              "\n\n~a\n"
 771                              (format #f (_ "job ~a terminated with signal: ~a")
 772                                      job (status:term-sig state)))
 773                             (ly:message
 774                              (_ "logfile ~a (exit ~a):\n~a")
 775                              logfile (status:exit-val state) tail))))
 776                       errors)
 777                      (if (pair? errors)
 778                          (ly:error "Children ~a exited with errors."
 779                                    (map car errors)))
 780                      ;; must overwrite individual entries
 781                      (if (ly:get-option 'dump-profile)
 782                          (dump-profile "lily-run-total"
 783                                        '(0 0) (profile-measurements)))
 784                      (if (null? errors)
 785                          (ly:exit 0 #f)
 786                          (ly:exit 1 #f))))))
 787
 788   (if (string-or-symbol? (ly:get-option 'log-file))
 789       (ly:stderr-redirect (format #f "~a.log" (ly:get-option 'log-file)) "w"))
 790   (let ((failed (lilypond-all files)))
 791     (if (ly:get-option 'trace-scheme-coverage)
 792         (begin
 793           (coverage:show-all (lambda (f)
 794                                (string-contains f "lilypond")))))
 795     (if (pair? failed)
 796         (begin (ly:error (_ "failed files: ~S") (string-join failed))
 797                (ly:exit 1 #f))
 798         (begin
 799           (ly:exit 0 #f)))))
 800
 801
 802 (define-public (lilypond-all files)
 803   (let* ((failed '())
 804          (separate-logs (ly:get-option 'separate-log-files))
 805          (ping-log
 806           (and separate-logs
 807                (if (string-or-symbol? (ly:get-option 'log-file))
 808                    (open-file (format #f "~a.log" (ly:get-option 'log-file))
 809                               "a")
 810                    (fdes->outport 2))))
 811          (do-measurements (ly:get-option 'dump-profile))
 812          (handler (lambda (key failed-file)
 813                     (set! failed (append (list failed-file) failed)))))
 814     (gc)
 815     (for-each
 816      (lambda (x)
 817        (let* ((start-measurements (if do-measurements
 818                                       (profile-measurements)
 819                                       #f))
 820               (base (dir-basename x ".ly"))
 821               (all-settings (ly:all-options)))
 822          (if separate-logs
 823              (ly:stderr-redirect (format #f "~a.log" base) "w"))
 824          (if ping-log
 825              (format ping-log "Processing ~a\n" base))
 826          (if (ly:get-option 'trace-memory-frequency)
 827              (mtrace:start-trace  (ly:get-option 'trace-memory-frequency)))
 828          (lilypond-file handler x)
 829          (ly:check-expected-warnings)
 830          (if start-measurements
 831              (dump-profile x start-measurements (profile-measurements)))
 832          (if (ly:get-option 'trace-memory-frequency)
 833              (begin (mtrace:stop-trace)
 834                     (mtrace:dump-results base)))
 835          (for-each (lambda (s)
 836                      (ly:set-option (car s) (cdr s)))
 837                    all-settings)
 838          (ly:set-option 'debug-gc-assert-parsed-dead #t)
 839          (gc)
 840          (ly:set-option 'debug-gc-assert-parsed-dead #f)
 841          (for-each
 842           (lambda (x)
 843             (ly:programming-error "Parsed object should be dead: ~a" x))
 844           (ly:parsed-undead-list!))
 845          (if (ly:get-option 'debug-gc)
 846              (dump-gc-protects)
 847              (ly:reset-all-fonts))
 848          (flush-all-ports)))
 849      files)
 850
 851     ;; Ensure a notice re failed files is written to aggregate logfile.
 852     (if ping-log
 853         (format ping-log "Failed files: ~a\n" failed))
 854     (if (ly:get-option 'dump-profile)
 855         (dump-profile "lily-run-total" '(0 0) (profile-measurements)))
 856     failed))
 857
 858 (define-public lilypond-declarations '())
 859
 860 (define (lilypond-file handler file-name)
 861   (catch 'ly-file-failed
 862          (lambda () (ly:parse-file file-name))
 863          (lambda (x . args) (handler x file-name))))
 864
 865 (use-modules (scm editor))
 866
 867 (define-public (gui-main files)
 868   (if (null? files)
 869       (gui-no-files-handler))
 870   (if (not (string? (ly:get-option 'log-file)))
 871       (let* ((base (dir-basename (car files) ".ly"))
 872              (log-name (string-append base ".log")))
 873         (if (not (ly:get-option 'gui))
 874             (ly:message (_ "Redirecting output to ~a...") log-name))
 875         (ly:stderr-redirect log-name "w")
 876         (ly:message "# -*-compilation-*-"))
 877       (let ((failed (lilypond-all files)))
 878         (if (pair? failed)
 879             (begin
 880               ;; ugh
 881               (ly:stderr-redirect "foo" "r")
 882               (system (get-editor-command log-name 0 0 0))
 883               (ly:error (_ "failed files: ~S") (string-join failed))
 884               ;; not reached?
 885               (exit 1))
 886             (ly:exit 0 #f)))))
 887
 888 (define (gui-no-files-handler)
 889   (let* ((ly (string-append (ly:effective-prefix) "/ly/"))
 890          ;; FIXME: soft-code, localize
 891          (welcome-ly (string-append ly "Welcome_to_LilyPond.ly"))
 892          (cmd (get-editor-command welcome-ly 0 0 0)))
 893     (ly:message (_ "Invoking `~a'...\n") cmd)
 894     (system cmd)
 895     (ly:exit 1 #f)))