scm/lily.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 1998--2011 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
 224 (define-public _ gettext)
 225 ;;; There are new modules defined in Guile V2.0 which we need to use.
 226 ;;
 227 ;;  Modules and scheme files loaded by lily.scm use currying
 228 ;;  in Guile V2 this needs a module which is not present in Guile V1.8
 229 ;;
 230
 231 (cond
 232   ((guile-v2)
 233    (ly:debug (_ "Using (ice-9 curried-definitions) module\n"))
 234    (use-modules (ice-9 curried-definitions)))
 235   (else
 236     (ly:debug (_ "Guile 1.8\n"))))
 237
 238 ;; TODO add in modules for V1.8.7 deprecated in V2.0 and integrated
 239 ;; into Guile base code, like (ice-9 syncase).
 240 ;;
 241
 242 (define-public fancy-format
 243   format)
 244
 245 (define-public (ergonomic-simple-format dest . rest)
 246   "Like ice-9's @code{format}, but without the memory consumption."
 247   (if (string? dest)
 248       (apply simple-format (cons #f (cons dest rest)))
 249       (apply simple-format (cons dest rest))))
 250
 251 (define format
 252   ergonomic-simple-format)
 253
 254 ;; my display
 255 (define-public (myd k v)
 256   (display k)
 257   (display ": ")
 258   (display v)
 259   (display ", ")
 260   v)
 261
 262 (define-public (print . args)
 263   (apply format (cons (current-output-port) args)))
 264
 265
 266 ;;; General settings.
 267 ;;;
 268 ;;; Debugging evaluator is slower.  This should have a more sensible
 269 ;;; default.
 270
 271
 272 (if (or (ly:get-option 'verbose)
 273         (ly:get-option 'trace-memory-frequency)
 274         (ly:get-option 'trace-scheme-coverage))
 275     (begin
 276       (ly:set-option 'protected-scheme-parsing #f)
 277       (debug-enable 'backtrace)
 278       (read-enable 'positions)))
 279
 280 (if (ly:get-option 'trace-scheme-coverage)
 281     (coverage:enable))
 282
 283 (define-public parser #f)
 284
 285 (define music-string-to-path-backends
 286   '(svg))
 287
 288 (if (memq (ly:get-option 'backend) music-string-to-path-backends)
 289     (ly:set-option 'music-strings-to-paths #t))
 290
 291
 292 (define-public (ly:load x)
 293   (let* ((file-name (%search-load-path x)))
 294     (ly:debug "[~A" file-name)
 295     (if (not file-name)
 296         (ly:error (_ "cannot find: ~A") x))
 297     (primitive-load-path file-name)  ;; to support Guile V2 autocompile
 298     ;; TODO: Any chance to use ly:debug here? Need to extend it to prevent
 299     ;;       a newline in this case
 300     (if (ly:get-option 'verbose)
 301         (ly:progress "]\n"))))
 302
 303 (define-public DOS
 304   (let ((platform (string-tokenize
 305                    (vector-ref (uname) 0) char-set:letter+digit)))
 306     (if (null? (cdr platform)) #f
 307         (member (string-downcase (cadr platform)) '("95" "98" "me")))))
 308
 309 (define (slashify x)
 310   (if (string-index x #\\)
 311       x
 312       (string-regexp-substitute
 313         "//*" "/"
 314         (string-regexp-substitute "\\\\" "/" x))))
 315
 316 (define-public (ly-getcwd)
 317   (if (eq? PLATFORM 'windows)
 318       (slashify (getcwd))
 319       (getcwd)))
 320
 321 (define-public (is-absolute? file-name)
 322   (let ((file-name-length (string-length file-name)))
 323     (if (= file-name-length 0)
 324         #f
 325         (or (eq? (string-ref file-name 0) #\/)
 326             (and (eq? PLATFORM 'windows)
 327                  (> file-name-length 2)
 328                  (eq? (string-ref file-name 1) #\:)
 329                  (eq? (string-ref file-name 2) #\/))))))
 330
 331 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 332 ;;; If necessary, emulate Guile V2 module_export_all! for Guile V1.8.n
 333 (cond-expand
 334  ((not guile-v2)
 335   (define (module-export-all! mod)
 336     (define (fresh-interface!)
 337       (let ((iface (make-module)))
 338         (set-module-name! iface (module-name mod))
 339         ;; for guile 2: (set-module-version! iface (module-version mod))
 340         (set-module-kind! iface 'interface)
 341         (set-module-public-interface! mod iface)
 342         iface))
 343     (let ((iface (or (module-public-interface mod)
 344                      (fresh-interface!))))
 345       (set-module-obarray! iface (module-obarray mod))))))
 346
 347 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 348 (define (type-check-arg location arg args pred?)
 349   "Typecheck an argument after previous arguments.
 350 Print a message at LOCATION if predicate fails and return #f"
 351   (or (pred? arg)
 352       (begin
 353         (ly:input-warning
 354          location
 355          (_ "wrong type for argument ~a.  Expecting ~a, found ~s")
 356          (1+ (length args)) (type-name pred?) arg)
 357         #f)))
 358
 359 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 360 ;; Safe definitions utility
 361
 362 (define safe-objects
 363   (list))
 364
 365 (define-macro (define-safe-public arglist . body)
 366   "Define a variable, export it, and mark it as safe, i.e. usable in
 367 LilyPond safe mode.  The syntax is the same as `define*-public'."
 368   (define (get-symbol arg)
 369     (if (pair? arg)
 370         (get-symbol (car arg))
 371         arg))
 372
 373   (let ((safe-symbol (get-symbol arglist)))
 374     `(begin
 375        (define*-public ,arglist
 376          ,@body)
 377        (set! safe-objects (cons (cons ',safe-symbol ,safe-symbol)
 378                                 safe-objects))
 379        ,safe-symbol)))
 380
 381 (define-safe-public (lilypond-version)
 382   (string-join
 383    (map (lambda (x) (if (symbol? x)
 384                         (symbol->string x)
 385                         (number->string x)))
 386         (ly:version))
 387    "."))
 388
 389 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 390 ;; init pitch system
 391
 392 (ly:set-default-scale (ly:make-scale #(0 1 2 5/2 7/2 9/2 11/2)))
 393
 394 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 395 ;; other files.
 396
 397 ;;
 398 ;;  List of Scheme files to be loaded into the (lily) module.
 399 ;;
 400 ;;  - Library definitions, need to be at the head of the list
 401 (define init-scheme-files-lib
 402   '("lily-library.scm"
 403     "output-lib.scm"))
 404 ;;  - Files containing definitions used later by other files later in load
 405 (define init-scheme-files-used
 406   '("markup-macros.scm"))
 407 ;;  - Main body of files to be loaded
 408 (define init-scheme-files-body
 409   '("file-cache.scm"
 410     "define-event-classes.scm"
 411     "define-music-callbacks.scm"
 412     "define-music-types.scm"
 413     "define-note-names.scm"
 414     "c++.scm"
 415     "chord-entry.scm"
 416     "stencil.scm"
 417     "define-markup-commands.scm"
 418     "markup.scm"
 419     "modal-transforms.scm"
 420     "chord-generic-names.scm"
 421     "chord-ignatzek-names.scm"
 422     "music-functions.scm"
 423     "part-combiner.scm"
 424     "autochange.scm"
 425     "define-music-properties.scm"
 426     "time-signature-settings.scm"
 427     "auto-beam.scm"
 428     "chord-name.scm"
 429     "bezier-tools.scm"
 430     "parser-ly-from-scheme.scm"
 431     "ly-syntax-constructors.scm"
 432
 433     "define-context-properties.scm"
 434     "translation-functions.scm"
 435     "script.scm"
 436     "midi.scm"
 437     "layout-beam.scm"
 438     "parser-clef.scm"
 439     "layout-slur.scm"
 440     "font.scm"
 441     "encoding.scm"
 442
 443     "flag-styles.scm"
 444     "fret-diagrams.scm"
 445     "tablature.scm"
 446     "harp-pedals.scm"
 447     "define-woodwind-diagrams.scm"
 448     "display-woodwind-diagrams.scm"
 449     "predefined-fretboards.scm"
 450     "define-grob-properties.scm"
 451     "define-grobs.scm"
 452     "define-grob-interfaces.scm"
 453     "define-stencil-commands.scm"
 454     "titling.scm"
 455
 456     "paper.scm"
 457     "backend-library.scm"
 458     "x11-color.scm"))
 459 ;;  - Files to be loaded last
 460 (define init-scheme-files-tail
 461 ;;  - must be after everything has been defined
 462   '("safe-lily.scm"))
 463 ;;
 464 ;; Now construct the load list
 465 ;;
 466 (define init-scheme-files
 467   (append init-scheme-files-lib
 468           init-scheme-files-used
 469           init-scheme-files-body
 470           init-scheme-files-tail))
 471
 472 (for-each ly:load init-scheme-files)
 473
 474 (define-public r5rs-primary-predicates
 475   `((,boolean? . "boolean")
 476     (,char? . "character")
 477     (,number? . "number")
 478     (,pair? . "pair")
 479     (,port? . "port")
 480     (,procedure? . "procedure")
 481     (,string? . "string")
 482     (,symbol? . "symbol")
 483     (,vector? . "vector")))
 484
 485 (define-public r5rs-secondary-predicates
 486   `((,char-alphabetic? . "alphabetic character")
 487     (,char-lower-case? . "lower-case character")
 488     (,char-numeric? . "numeric character")
 489     (,char-upper-case? . "upper-case character")
 490     (,char-whitespace? . "whitespace character")
 491
 492     (,complex? . "complex number")
 493     (,even? . "even number")
 494     (,exact? . "exact number")
 495     (,inexact? . "inexact number")
 496     (,integer? . "integer")
 497     (,negative? . "negative number")
 498     (,odd? . "odd number")
 499     (,positive? . "positive number")
 500     (,rational? . "rational number")
 501     (,real? . "real number")
 502     (,zero? . "zero")
 503
 504     (,list? . "list")
 505     (,null? . "null")
 506
 507     (,input-port? . "input port")
 508     (,output-port? . "output port")
 509
 510     ;; would this ever be used?
 511     (,eof-object? . "end-of-file object")
 512     ))
 513
 514 (define-public guile-predicates
 515   `((,hash-table? . "hash table")
 516   ))
 517
 518 (define-public lilypond-scheme-predicates
 519   `((,boolean-or-symbol? . "boolean or symbol")
 520     (,color? . "color")
 521     (,cheap-list? . "list")
 522     (,grob-list? . "list of grobs")
 523     ;; this is built on cheap-list
 524     (,list-or-symbol? . "list or symbol")
 525     (,markup? . "markup")
 526     (,markup-command-list? . "markup command list")
 527     (,markup-list? . "markup list")
 528     (,moment-pair? . "pair of moment objects")
 529     (,number-or-grob? . "number or grob")
 530     (,number-or-pair? . "number or pair")
 531     (,number-or-string? . "number or string")
 532     (,number-pair? . "pair of numbers")
 533     (,rhythmic-location? . "rhythmic location")
 534     (,scheme? . "any type")
 535     (,string-or-pair? . "string or pair")
 536     (,string-or-symbol? . "string or symbol")
 537     ))
 538
 539 (define-public lilypond-exported-predicates
 540   `((,ly:box? . "box")
 541     (,ly:context? . "context")
 542     (,ly:dimension? . "dimension, in staff space")
 543     (,ly:dir? . "direction")
 544     (,ly:dispatcher? . "dispatcher")
 545     (,ly:duration? . "duration")
 546     (,ly:event? . "event")
 547     (,ly:font-metric? . "font metric")
 548     (,ly:grob? . "graphical (layout) object")
 549     (,ly:grob-array? . "array of grobs")
 550     (,ly:input-location? . "input location")
 551     (,ly:item? . "item")
 552     (,ly:iterator? . "iterator")
 553     (,ly:lily-lexer? . "lily-lexer")
 554     (,ly:lily-parser? . "lily-parser")
 555     (,ly:listener? . "listener")
 556     (,ly:moment? . "moment")
 557     (,ly:music? . "music")
 558     (,ly:music-function? . "music function")
 559     (,ly:music-list? . "list of music objects")
 560     (,ly:music-output? . "music output")
 561     (,ly:otf-font? . "OpenType font")
 562     (,ly:output-def? . "output definition")
 563     (,ly:page-marker? . "page marker")
 564     (,ly:pango-font? . "pango font")
 565     (,ly:paper-book? . "paper book")
 566     (,ly:paper-system? . "paper-system Prob")
 567     (,ly:pitch? . "pitch")
 568     (,ly:prob? . "property object")
 569     (,ly:score? . "score")
 570     (,ly:simple-closure? . "simple closure")
 571     (,ly:skyline? . "skyline")
 572     (,ly:skyline-pair? . "pair of skylines")
 573     (,ly:source-file? . "source file")
 574     (,ly:spanner? . "spanner")
 575     (,ly:stencil? . "stencil")
 576     (,ly:stream-event? . "stream event")
 577     (,ly:translator? . "translator")
 578     (,ly:translator-group? . "translator group")
 579     ))
 580
 581
 582 (set! type-p-name-alist
 583       (append r5rs-primary-predicates
 584               r5rs-secondary-predicates
 585               guile-predicates
 586               lilypond-scheme-predicates
 587               lilypond-exported-predicates))
 588
 589
 590 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 591 ;; timing
 592
 593 (define (profile-measurements)
 594   (let* ((t (times))
 595          (stats (gc-stats)))
 596     (list (- (+ (tms:cutime t)
 597                 (tms:utime t))
 598              (assoc-get 'gc-time-taken stats))
 599           (assoc-get 'total-cells-allocated  stats 0))))
 600
 601 (define (dump-profile base last this)
 602   (let* ((outname (format #f "~a.profile" (dir-basename base ".ly")))
 603          (diff (map (lambda (y) (apply - y)) (zip this last))))
 604     (ly:progress "\nWriting timing to ~a..." outname)
 605     (format (open-file outname "w")
 606             "time: ~a\ncells: ~a\n"
 607             (if (ly:get-option 'dump-cpu-profile)
 608                 (car diff)
 609                 0)
 610             (cadr diff))))
 611
 612 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 613 ;; debug memory leaks
 614
 615 (define gc-dumping
 616   #f)
 617
 618 (define gc-protect-stat-count
 619   0)
 620
 621 (define-public (dump-live-object-stats outfile)
 622   (for-each (lambda (x)
 623               (format outfile "~a: ~a\n" (car x) (cdr x)))
 624             (sort (gc-live-object-stats)
 625                   (lambda (x y)
 626                     (string<? (car x) (car y))))))
 627
 628 (define-public (dump-gc-protects)
 629   (set! gc-protect-stat-count (1+ gc-protect-stat-count))
 630   (let* ((protects (sort (hash-table->alist (ly:protects))
 631                          (lambda (a b)
 632                            (< (object-address (car a))
 633                               (object-address (car b))))))
 634         (out-file-name (string-append
 635                        "gcstat-" (number->string gc-protect-stat-count)
 636                        ".scm"))
 637         (outfile (open-file out-file-name "w")))
 638     (set! gc-dumping #t)
 639     (ly:progress "Dumping GC statistics ~a...\n" out-file-name)
 640     (for-each (lambda (y)
 641                 (let ((x (car y))
 642                       (c (cdr y)))
 643                   (format outfile "~a (~a) = ~a\n" (object-address x) c x)))
 644               (filter
 645                (lambda (x)
 646                  (not (symbol? (car x))))
 647                protects))
 648     (format outfile "\nprotected symbols: ~a\n"
 649             (apply + (map (lambda (obj-count)
 650                             (if (symbol? (car obj-count))
 651                                 (cdr obj-count)
 652                                 0))
 653                           protects)))
 654
 655     ;; (display (ly:smob-protects))
 656     (newline outfile)
 657     (if (defined? 'gc-live-object-stats)
 658         (let* ((stats #f))
 659           (ly:progress "Live object statistics: GC'ing\n")
 660           (ly:reset-all-fonts)
 661           (gc)
 662           (gc)
 663           (ly:progress "Asserting dead objects\n")
 664           (ly:set-option 'debug-gc-assert-parsed-dead #t)
 665           (gc)
 666           (ly:set-option 'debug-gc-assert-parsed-dead #f)
 667           (set! stats (gc-live-object-stats))
 668           (ly:progress "Dumping live object statistics.\n")
 669           (dump-live-object-stats outfile)))
 670     (newline outfile)
 671     (let* ((stats (gc-stats)))
 672       (for-each (lambda (sym)
 673                   (format outfile "~a ~a ~a\n"
 674                           gc-protect-stat-count
 675                           sym
 676                           (assoc-get sym stats "?")))
 677                 '(protected-objects bytes-malloced cell-heap-size)))
 678     (set! gc-dumping #f)
 679     (close-port outfile)))
 680
 681 (define (check-memory)
 682   "Read `/proc/self' to check up on memory use."
 683   (define (gulp-file name)
 684     (let* ((file (open-input-file name))
 685            (text (read-delimited "" file)))
 686       (close file)
 687       text))
 688
 689   (let* ((stat (gulp-file "/proc/self/status"))
 690          (lines (string-split stat #\newline))
 691          (interesting (filter identity
 692                               (map
 693                                (lambda (l)
 694                                  (string-match "^VmData:[ \t]*([0-9]*) kB" l))
 695                                lines)))
 696          (mem (string->number (match:substring (car interesting) 1))))
 697     (format #t "VMDATA: ~a\n" mem)
 698     (display (gc-stats))
 699     (newline)
 700     (if (> mem 500000)
 701         (begin (dump-gc-protects)
 702                (raise 1)))))
 703
 704 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 705
 706 (define (multi-fork count)
 707   "Split this process into COUNT helpers.  Returns either a list of
 708 PIDs or the number of the process."
 709   (define (helper count acc)
 710     (if (> count 0)
 711         (let* ((pid (primitive-fork)))
 712               (if (= pid 0)
 713                   (1- count)
 714                   (helper (1- count) (cons pid acc))))
 715         acc))
 716
 717   (helper count '()))
 718
 719 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 720
 721 (define* (ly:exit status #:optional (silently #f))
 722   "Exit function for lilypond"
 723   (if (not silently)
 724       (case status
 725         ((0) (ly:basic-progress (_ "Success: compilation successfully completed")))
 726         ((1) (ly:warning (_ "Compilation completed with warnings or errors")))
 727         (else (ly:message ""))))
 728   (exit status))
 729
 730 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 731
 732 (define-public (lilypond-main files)
 733   "Entry point for LilyPond."
 734   (eval-string (ly:command-line-code))
 735   (if (ly:get-option 'help)
 736       (begin (ly:option-usage)
 737              (ly:exit 0 #t)))
 738   (if (ly:get-option 'show-available-fonts)
 739       (begin (ly:font-config-display-fonts)
 740              (ly:exit 0 #t)))
 741   (if (ly:get-option 'gui)
 742       (gui-main files))
 743   (if (null? files)
 744       (begin (ly:usage)
 745              (ly:exit 2 #t)))
 746   (if (ly:get-option 'read-file-list)
 747       (set! files
 748             (filter (lambda (s)
 749                       (> (string-length s) 0))
 750                     (apply append
 751                            (map (lambda (f)
 752                                   (string-split (ly:gulp-file f) #\nl))
 753                                 files)))))
 754   (if (and (number? (ly:get-option 'job-count))
 755            (>= (length files) (ly:get-option 'job-count)))
 756       (let* ((count (ly:get-option 'job-count))
 757              (split-todo (split-list files count))
 758              (joblist (multi-fork count))
 759              (errors '()))
 760         (if (not (string-or-symbol? (ly:get-option 'log-file)))
 761             (ly:set-option 'log-file "lilypond-multi-run"))
 762         (if (number? joblist)
 763             (begin (ly:set-option
 764                     'log-file (format #f "~a-~a"
 765                                       (ly:get-option 'log-file) joblist))
 766                     (set! files (vector-ref split-todo joblist)))
 767             (begin (ly:progress "\nForking into jobs:  ~a\n" joblist)
 768                    (for-each
 769                     (lambda (pid)
 770                       (let* ((stat (cdr (waitpid pid))))
 771                         (if (not (= stat 0))
 772                             (set! errors
 773                                   (acons (list-element-index joblist pid)
 774                                  stat errors)))))
 775                     joblist)
 776                    (for-each
 777                     (lambda (x)
 778                       (let* ((job (car x))
 779                              (state (cdr x))
 780                              (logfile (format #f "~a-~a.log"
 781                                               (ly:get-option 'log-file) job))
 782                              (log (ly:gulp-file logfile))
 783                              (len (string-length log))
 784                              (tail (substring  log (max 0 (- len 1024)))))
 785                         (if (status:term-sig state)
 786                             (ly:message
 787                              "\n\n~a\n"
 788                              (format #f (_ "job ~a terminated with signal: ~a")
 789                                      job (status:term-sig state)))
 790                             (ly:message
 791                              (_ "logfile ~a (exit ~a):\n~a")
 792                              logfile (status:exit-val state) tail))))
 793                       errors)
 794                      (if (pair? errors)
 795                          (ly:error "Children ~a exited with errors."
 796                                    (map car errors)))
 797                      ;; must overwrite individual entries
 798                      (if (ly:get-option 'dump-profile)
 799                          (dump-profile "lily-run-total"
 800                                        '(0 0) (profile-measurements)))
 801                      (if (null? errors)
 802                          (ly:exit 0 #f)
 803                          (ly:exit 1 #f))))))
 804
 805   (if (string-or-symbol? (ly:get-option 'log-file))
 806       (ly:stderr-redirect (format #f "~a.log" (ly:get-option 'log-file)) "w"))
 807   (let ((failed (lilypond-all files)))
 808     (if (ly:get-option 'trace-scheme-coverage)
 809         (begin
 810           (coverage:show-all (lambda (f)
 811                                (string-contains f "lilypond")))))
 812     (if (pair? failed)
 813         (begin (ly:error (_ "failed files: ~S") (string-join failed))
 814                (ly:exit 1 #f))
 815         (begin
 816           (ly:exit 0 #f)))))
 817
 818
 819 (define-public (lilypond-all files)
 820   (let* ((failed '())
 821          (separate-logs (ly:get-option 'separate-log-files))
 822          (ping-log
 823           (if separate-logs
 824               (open-file (if (string-or-symbol? (ly:get-option 'log-file))
 825                              (format #f "~a.log" (ly:get-option 'log-file))
 826                      "/dev/stderr") "a") #f))
 827          (do-measurements (ly:get-option 'dump-profile))
 828          (handler (lambda (key failed-file)
 829                     (set! failed (append (list failed-file) failed)))))
 830     (gc)
 831     (for-each
 832      (lambda (x)
 833        (let* ((start-measurements (if do-measurements
 834                                       (profile-measurements)
 835                                       #f))
 836               (base (dir-basename x ".ly"))
 837               (all-settings (ly:all-options)))
 838          (if separate-logs
 839              (ly:stderr-redirect (format #f "~a.log" base) "w"))
 840          (if ping-log
 841              (format ping-log "Processing ~a\n" base))
 842          (if (ly:get-option 'trace-memory-frequency)
 843              (mtrace:start-trace  (ly:get-option 'trace-memory-frequency)))
 844          (lilypond-file handler x)
 845          (if start-measurements
 846              (dump-profile x start-measurements (profile-measurements)))
 847          (if (ly:get-option 'trace-memory-frequency)
 848              (begin (mtrace:stop-trace)
 849                     (mtrace:dump-results base)))
 850          (for-each (lambda (s)
 851                      (ly:set-option (car s) (cdr s)))
 852                    all-settings)
 853          (ly:set-option 'debug-gc-assert-parsed-dead #t)
 854          (gc)
 855          (ly:set-option 'debug-gc-assert-parsed-dead #f)
 856          (if (ly:get-option 'debug-gc)
 857              (dump-gc-protects)
 858              (ly:reset-all-fonts))
 859          (flush-all-ports)))
 860      files)
 861
 862     ;; Ensure a notice re failed files is written to aggregate logfile.
 863     (if ping-log
 864         (format ping-log "Failed files: ~a\n" failed))
 865     (if (ly:get-option 'dump-profile)
 866         (dump-profile "lily-run-total" '(0 0) (profile-measurements)))
 867     failed))
 868
 869 (define (lilypond-file handler file-name)
 870   (catch 'ly-file-failed
 871          (lambda () (ly:parse-file file-name))
 872          (lambda (x . args) (handler x file-name))))
 873
 874 (use-modules (scm editor))
 875
 876 (define-public (gui-main files)
 877   (if (null? files)
 878       (gui-no-files-handler))
 879   (if (not (string? (ly:get-option 'log-file)))
 880       (let* ((base (dir-basename (car files) ".ly"))
 881              (log-name (string-append base ".log")))
 882         (if (not (ly:get-option 'gui))
 883             (ly:message (_ "Redirecting output to ~a...") log-name))
 884         (ly:stderr-redirect log-name "w")
 885         (ly:message "# -*-compilation-*-"))
 886       (let ((failed (lilypond-all files)))
 887         (if (pair? failed)
 888             (begin
 889               ;; ugh
 890               (ly:stderr-redirect "foo" "r")
 891               (system (get-editor-command log-name 0 0 0))
 892               (ly:error (_ "failed files: ~S") (string-join failed))
 893               ;; not reached?
 894               (exit 1))
 895             (ly:exit 0 #f)))))
 896
 897 (define (gui-no-files-handler)
 898   (let* ((ly (string-append (ly:effective-prefix) "/ly/"))
 899          ;; FIXME: soft-code, localize
 900          (welcome-ly (string-append ly "Welcome_to_LilyPond.ly"))
 901          (cmd (get-editor-command welcome-ly 0 0 0)))
 902     (ly:message (_ "Invoking `~a'...\n") cmd)
 903     (system cmd)
 904     (ly:exit 1 #f)))