X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Flily.scm;h=4b3c9c7e1c4cad55c64a53fe611d1effcf692612;hb=b872748c6aa8bb721ced458691b38ac2fac5dfc8;hp=3d179dd2cb2e6d6e66a3840706582586f463cda4;hpb=d52cc1ba72627a3da014d83979e1e0d5167219c4;p=lilypond.git diff --git a/scm/lily.scm b/scm/lily.scm index 3d179dd2cb..4b3c9c7e1c 100644 --- a/scm/lily.scm +++ b/scm/lily.scm @@ -1,6 +1,6 @@ ;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; Copyright (C) 1998--2012 Jan Nieuwenhuizen +;;;; Copyright (C) 1998--2015 Jan Nieuwenhuizen ;;;; Han-Wen Nienhuys ;;;; ;;;; LilyPond is free software: you can redistribute it and/or modify @@ -41,9 +41,52 @@ (define-public PLATFORM (string->symbol (string-downcase - (car (string-tokenize (utsname:sysname (uname))))))) + (car (string-tokenize (utsname:sysname (uname)) char-set:letter))))) + +;; We don't use (srfi srfi-39) (parameter objects) here because that +;; does not give us a name/handle to the underlying fluids themselves. + +(define %parser (make-fluid)) +(define %location (make-fluid)) +;; No public setters: should not get overwritten in action +(define-public (*parser*) (fluid-ref %parser)) +(define-public (*location*) (fluid-ref %location)) +;; but properly scoped location should be fine +(defmacro-public with-location (loc . body) + `(with-fluids ((,%location ,loc)) ,@body)) + +;; It would be nice to convert occurences of parser/location to +;; (*parser*)/(*location*) using the syncase module but it is utterly +;; broken in GUILE 1 and would require changing a lot of unrelated +;; innocuous constructs which just happen to fall apart with +;; inscrutable error messages. + +;; +;; Session-handling variables and procedures. +;; +;; A "session" corresponds to one .ly file processed on a LilyPond +;; command line. Every session gets to see a reasonably fresh state +;; of LilyPond and should work independently from previous files. +;; +;; Session management relies on cooperation, namely the user not +;; trying to change variables and data structures internal to +;; LilyPond. It is not proof against in-place modification of data +;; structures (as they are just reinitialized with the original +;; identities), and it is not proof against tampering with internals. +;; +;; As a consequence, session management is not sufficient for +;; separating multiple independent .ly files in "-dsafe" mode: you +;; should give each its own LilyPond process when reliable separation +;; is mandatory. +;; +;; For standard tasks and programming practices, multiple sessions in +;; the same LilyPond job should work reasonably independently and +;; without "bleed-over" while still loading and compiling the +;; relevant .scm and .ly files only once. +;; (define lilypond-declarations '()) +(define lilypond-exports '()) (define after-session-hook (make-hook)) (define-public (call-after-session thunk) @@ -51,7 +94,16 @@ (ly:error (_ "call-after-session used after session start"))) (add-hook! after-session-hook thunk #t)) -(defmacro-public define-session (name value) +(define (make-session-variable name value) + (if (ly:undead? lilypond-declarations) + (ly:error (_ "define-session used after session start"))) + (let ((var (module-make-local-var! (current-module) name))) + (if (variable-bound? var) + (ly:error (_ "symbol ~S redefined") name)) + (variable-set! var value) + var)) + +(defmacro define-session (name value) "This defines a variable @var{name} with the starting value @var{value} that is reinitialized at the start of each session. A@tie{}session basically corresponds to one LilyPond file on the @@ -65,17 +117,22 @@ to their front or replacing them altogether, not by modifying parts of them. It is an error to call @code{define-session} after the first session has started." (define (add-session-variable name value) - (if (ly:undead? lilypond-declarations) - (ly:error (_ "define-session used after session start"))) - (let ((var (make-variable value))) - (module-add! (current-module) name var) - (set! lilypond-declarations (cons var lilypond-declarations)))) + (set! lilypond-declarations + (cons (make-session-variable name value) lilypond-declarations))) `(,add-session-variable ',name ,value)) -(defmacro-public define-session-public (name value) - "Like @code{define-session}, but also exports @var{name}." +(defmacro define-session-public (name value) + "Like @code{define-session}, but also exports @var{name} into parser modules." + (define (add-session-variable name value) + (set! lilypond-exports + (acons name (make-session-variable name value) lilypond-exports))) `(begin - (define-session ,name ,value) + ;; this is a bit icky: we place the variable right into every + ;; parser module so that both set! and define will affect the + ;; original variable in the (lily) module. However, we _also_ + ;; export it normally from (lily) for the sake of other modules + ;; not sharing the name space of the parser. + (,add-session-variable ',name ,value) (export ,name))) (define (session-terminate) @@ -96,13 +153,13 @@ variables in the current module as well as those defined with ignore @var{thunk} and instead just reinitialize all recorded variables to their value after the initial call of @var{thunk}." -;; We need to save the variables of the current module along with -;; their values: functions defined in the module might refer to the -;; variables. + ;; We need to save the variables of the current module along with + ;; their values: functions defined in the module might refer to the + ;; variables. -;; The entries in lilypond-declarations consist of a cons* consisting -;; of symbol, variable, and value. Variables defined with -;; define-session have the symbol set to #f. + ;; The entries in lilypond-declarations consist of a cons* consisting + ;; of symbol, variable, and value. Variables defined with + ;; define-session have the symbol set to #f. (if (ly:undead? lilypond-declarations) (begin @@ -116,7 +173,16 @@ variables to their value after the initial call of @var{thunk}." (module-add! (current-module) (car p) var)))) (ly:get-undead lilypond-declarations))) (begin + ;; import all public session variables natively into parser + ;; module. That makes them behave identically under define/set! + (for-each (lambda (v) + (module-add! (current-module) (car v) (cdr v))) + lilypond-exports) + ;; Initialize first session (thunk) + ;; lilypond-exports is no longer needed since we will grab its + ;; values from (current-module). + (set! lilypond-exports #f) (set! lilypond-interfaces (filter (lambda (m) (eq? 'interface (module-kind m))) (module-uses (current-module)))) @@ -145,136 +211,198 @@ variables to their value after the initial call of @var{thunk}." ;; be longer than 48 characters per line. (anti-alias-factor 1 -"Render at higher resolution (using given factor) + "Render at higher resolution (using given factor) and scale down result to prevent jaggies in PNG images.") - (aux-files #t -"Create .tex, .texi, .count files in the + (aux-files + #t + "Create .tex, .texi, .count files in the EPS backend.") - (backend ps -"Select backend. Possible values: 'eps, 'null, + (backend + ps + "Select backend. Possible values: 'eps, 'null, 'ps, 'scm, 'socket, 'svg.") - (check-internal-types #f -"Check every property assignment for types.") - (clip-systems #f -"Generate cut-out snippets of a score.") - (datadir #f -"LilyPond prefix for data files (read-only).") - (debug-gc #f -"Dump memory debugging statistics.") - (debug-gc-assert-parsed-dead #f -"For memory debugging: Ensure that all + (check-internal-types + #f + "Check every property assignment for types.") + (clip-systems + #f + "Generate cut-out snippets of a score.") + (datadir + #f + "LilyPond prefix for data files (read-only).") + (debug-gc + #f + "Dump memory debugging statistics.") + (debug-gc-assert-parsed-dead + #f + "For memory debugging: Ensure that all references to parsed objects are dead. This is an internal option, and is switched on automatically for `-ddebug-gc'.") - (debug-lexer #f -"Debug the flex lexer.") - (debug-page-breaking-scoring #f -"Dump scores for many different page breaking + (debug-lexer + #f + "Debug the flex lexer.") + (debug-page-breaking-scoring + #f + "Dump scores for many different page breaking configurations.") - (debug-parser #f -"Debug the bison parser.") - (debug-property-callbacks #f -"Debug cyclic callback chains.") - (debug-skylines #f -"Debug skylines.") - (delete-intermediate-files #t -"Delete unusable, intermediate PostScript files.") - (dump-profile #f -"Dump memory and time information for each file.") - (dump-cpu-profile #f -"Dump timing information (system-dependent).") - (dump-signatures #f -"Dump output signatures of each system. Used for + (debug-parser + #f + "Debug the bison parser.") + (debug-property-callbacks + #f + "Debug cyclic callback chains.") + (debug-skylines + #f + "Debug skylines.") + (delete-intermediate-files + #t + "Delete unusable, intermediate PostScript files.") + (dump-profile + #f + "Dump memory and time information for each file.") + (dump-cpu-profile + #f + "Dump timing information (system-dependent).") + (dump-signatures + #f + "Dump output signatures of each system. Used for regression testing.") - (eps-box-padding #f -"Pad left edge of the output EPS bounding box by + (embed-source-code + #f + "Embed the source files inside the generated PDF document.") + (eps-box-padding + #f + "Pad left edge of the output EPS bounding box by given amount (in mm).") - (gs-load-fonts #f -"Load fonts via Ghostscript.") - (gs-load-lily-fonts #f -"Load only LilyPond fonts via Ghostscript.") - (gui #f -"Run LilyPond from a GUI and redirect stderr to + (font-export-dir + #f + "Directory for exporting fonts as PostScript files.") + (gs-load-fonts + #f + "Load fonts via Ghostscript.") + (gs-load-lily-fonts + #f + "Load only LilyPond fonts via Ghostscript.") + (gs-never-embed-fonts + #f + "Make Ghostscript embed only TrueType fonts and no other font format.") + (gui + #f + "Run LilyPond from a GUI and redirect stderr to a log file.") - (help #f -"Show this help.") - (include-book-title-preview #t -"Include book titles in preview images.") - (include-eps-fonts #t -"Include fonts in separate-system EPS files.") - (include-settings #f -"Include file for global settings, included before the score is processed.") - (job-count #f -"Process in parallel, using the given number of + (help + #f + "Show this help.") + (include-book-title-preview + #t + "Include book titles in preview images.") + (include-eps-fonts + #t + "Include fonts in separate-system EPS files.") + (include-settings + #f + "Include file for global settings, included before the score is processed.") + (job-count + #f + "Process in parallel, using the given number of jobs.") - (log-file #f -"If string FOO is given as argument, redirect + (log-file + #f + "If string FOO is given as argument, redirect output to log file `FOO.log'.") - (max-markup-depth 1024 -"Maximum depth for the markup tree. If a markup has more levels, + (max-markup-depth + 1024 + "Maximum depth for the markup tree. If a markup has more levels, assume it will not terminate on its own, print a warning and return a null markup instead.") (midi-extension ,(if (eq? PLATFORM 'windows) "mid" "midi") -"Set the default file extension for MIDI output + "Set the default file extension for MIDI output file to given string.") - (music-strings-to-paths #f -"Convert text strings to paths when glyphs belong + (music-strings-to-paths + #f + "Convert text strings to paths when glyphs belong to a music font.") - (point-and-click #t -"Add point & click links to PDF output.") - (paper-size "a4" -"Set default paper size.") - (pixmap-format "png16m" -"Set GhostScript's output format for pixel images.") - (preview #f -"Create preview images also.") - (print-pages #t -"Print pages in the normal way.") - (protected-scheme-parsing #t -"Continue when errors in inline scheme are caught + (point-and-click + #t + "Add point & click links to PDF and SVG output.") + (paper-size + "a4" + "Set default paper size.") + (pixmap-format + "png16m" + "Set GhostScript's output format for pixel images.") + (preview + #f + "Create preview images also.") + (print-pages + #t + "Print pages in the normal way.") + (protected-scheme-parsing + #t + "Continue when errors in inline scheme are caught in the parser. If #f, halt on errors and print a stack trace.") - (profile-property-accesses #f -"Keep statistics of get_property() calls.") - (resolution 101 -"Set resolution for generating PNG pixmaps to + (profile-property-accesses + #f + "Keep statistics of get_property() calls.") + (resolution + 101 + "Set resolution for generating PNG pixmaps to given value (in dpi).") - (read-file-list #f -"Specify name of a file which contains a list of + (read-file-list + #f + "Specify name of a file which contains a list of input files to be processed.") - (relative-includes #f -"When processing an \\include command, look for -the included file relative to the current file -(instead of the root file)") - (safe #f -"Run in safer mode.") - (separate-log-files #f -"For input files `FILE1.ly', `FILE2.ly', ... + (relative-includes + #f + "When processing an \\include command, look for +the included file relative to the current file\ +\n(instead of the root file)") + (safe + #f + "Run in safer mode.") + (separate-log-files + #f + "For input files `FILE1.ly', `FILE2.ly', ... output log data to files `FILE1.log', `FILE2.log', ...") - (show-available-fonts #f -"List available font names.") - (strict-infinity-checking #f -"Force a crash on encountering Inf and NaN + (show-available-fonts + #f + "List available font names.") + (strict-infinity-checking + #f + "Force a crash on encountering Inf and NaN floating point exceptions.") - (strip-output-dir #t -"Don't use directories from input files while + (strip-output-dir + #t + "Don't use directories from input files while constructing output file names.") - (svg-woff #f -"Use woff font files in SVG backend.") - (trace-memory-frequency #f -"Record Scheme cell usage this many times per + (strokeadjust + #f + "Set the PostScript strokeadjust operator explicitly. +This employs different drawing primitives, resulting in +large PDF file size increases but often markedly better +PDF previews.") + (svg-woff + #f + "Use woff font files in SVG backend.") + (trace-memory-frequency + #f + "Record Scheme cell usage this many times per second. Dump results to `FILE.stacks' and `FILE.graph'.") - (trace-scheme-coverage #f -"Record coverage of Scheme files in `FILE.cov'.") + (trace-scheme-coverage + #f + "Record coverage of Scheme files in `FILE.cov'.") (verbose ,(ly:verbose-output?) -"Verbose output, i.e. loglevel at least DEBUG (read-only).") - (warning-as-error #f -"Change all warning and programming_error + "Verbose output, i.e. loglevel at least DEBUG (read-only).") + (warning-as-error + #f + "Change all warning and programming_error messages into errors.") )) @@ -308,7 +436,7 @@ messages into errors.") (scm clip-region) (scm memory-trace) (scm coverage) - (scm safe-utility-defs)) + (scm safe-utility-defs)) (define-public _ gettext) ;;; There are new modules defined in Guile V2.0 which we need to use. @@ -318,11 +446,11 @@ messages into errors.") ;; (cond - ((guile-v2) - (ly:debug (_ "Using (ice-9 curried-definitions) module\n")) - (use-modules (ice-9 curried-definitions))) - (else - (ly:debug (_ "Guile 1.8\n")))) + ((guile-v2) + (ly:debug (_ "Using (ice-9 curried-definitions) module\n")) + (use-modules (ice-9 curried-definitions))) + (else + (ly:debug (_ "Guile 1.8\n")))) ;; TODO add in modules for V1.8.7 deprecated in V2.0 and integrated ;; into Guile base code, like (ice-9 syncase). @@ -334,8 +462,8 @@ messages into errors.") (define-public (ergonomic-simple-format dest . rest) "Like ice-9's @code{format}, but without the memory consumption." (if (string? dest) - (apply simple-format (cons #f (cons dest rest))) - (apply simple-format (cons dest rest)))) + (apply simple-format #f dest rest) + (apply simple-format dest rest))) (define format ergonomic-simple-format) @@ -349,7 +477,7 @@ messages into errors.") v) (define-public (print . args) - (apply format (cons (current-output-port) args))) + (apply format (current-output-port) args)) ;;; General settings. @@ -369,8 +497,6 @@ messages into errors.") (if (ly:get-option 'trace-scheme-coverage) (coverage:enable)) -(define-public parser #f) - (define music-string-to-path-backends '(svg)) @@ -398,8 +524,8 @@ messages into errors.") (if (string-index x #\\) x (string-regexp-substitute - "//*" "/" - (string-regexp-substitute "\\\\" "/" x)))) + "//*" "/" + (string-regexp-substitute "\\\\" "/" x)))) (define-public (ly-getcwd) (if (eq? PLATFORM 'windows) @@ -414,7 +540,8 @@ messages into errors.") (and (eq? PLATFORM 'windows) (> file-name-length 2) (eq? (string-ref file-name 1) #\:) - (eq? (string-ref file-name 2) #\/)))))) + (or (eq? (string-ref file-name 2) #\\) + (eq? (string-ref file-name 2) #\/))))))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; If necessary, emulate Guile V2 module_export_all! for Guile V1.8.n @@ -470,9 +597,9 @@ messages into errors.") "c++.scm" "chord-entry.scm" "skyline.scm" - "stencil.scm" - "define-markup-commands.scm" "markup.scm" + "define-markup-commands.scm" + "stencil.scm" "modal-transforms.scm" "chord-generic-names.scm" "chord-ignatzek-names.scm" @@ -480,11 +607,11 @@ messages into errors.") "part-combiner.scm" "autochange.scm" "define-music-properties.scm" + "time-signature.scm" "time-signature-settings.scm" "auto-beam.scm" "chord-name.scm" "bezier-tools.scm" - "ly-syntax-constructors.scm" "define-context-properties.scm" "translation-functions.scm" @@ -517,7 +644,7 @@ messages into errors.") "x11-color.scm")) ;; - Files to be loaded last (define init-scheme-files-tail -;; - must be after everything has been defined + ;; - must be after everything has been defined '("safe-lily.scm")) ;; ;; Now construct the load list @@ -572,7 +699,7 @@ messages into errors.") (define-public guile-predicates `((,hash-table? . "hash table") - )) + )) (define-public lilypond-scheme-predicates `((,boolean-or-symbol? . "boolean or symbol") @@ -581,6 +708,10 @@ messages into errors.") (,fraction? . "fraction, as pair") (,grob-list? . "list of grobs") (,index? . "non-negative integer") + (,key? . "index or symbol") + (,key-list? . "list of indexes or symbols") + (,key-list-or-music? . "key list or music") + (,key-list-or-symbol? . "key list or symbol") (,markup? . "markup") (,markup-command-list? . "markup command list") (,markup-list? . "markup list") @@ -591,6 +722,8 @@ messages into errors.") (,number-or-pair? . "number or pair") (,number-or-string? . "number or string") (,number-pair? . "pair of numbers") + (,number-pair-list? . "list of number pairs") + (,rational-or-procedure? . "an exact rational or procedure") (,rhythmic-location? . "rhythmic location") (,scheme? . "any type") (,string-or-pair? . "string or pair") @@ -616,6 +749,7 @@ messages into errors.") (,ly:font-metric? . "font metric") (,ly:grob? . "graphical (layout) object") (,ly:grob-array? . "array of grobs") + (,ly:grob-properties? . "grob properties") (,ly:input-location? . "input location") (,ly:item? . "item") (,ly:iterator? . "iterator") @@ -636,7 +770,6 @@ messages into errors.") (,ly:pitch? . "pitch") (,ly:prob? . "property object") (,ly:score? . "score") - (,ly:simple-closure? . "simple closure") (,ly:skyline? . "skyline") (,ly:skyline-pair? . "pair of skylines") (,ly:source-file? . "source file") @@ -646,6 +779,7 @@ messages into errors.") (,ly:stream-event? . "stream event") (,ly:translator? . "translator") (,ly:translator-group? . "translator group") + (,ly:undead? . "undead container") (,ly:unpure-pure-container? . "unpure/pure container") )) @@ -671,8 +805,8 @@ messages into errors.") (define (dump-profile base last this) (let* ((outname (format #f "~a.profile" (dir-basename base ".ly"))) - (diff (map (lambda (y) (apply - y)) (zip this last)))) - (ly:progress "\nWriting timing to ~a..." outname) + (diff (map - this last))) + (ly:progress "\nWriting timing to ~a...\n" outname) (format (open-file outname "w") "time: ~a\ncells: ~a\n" (if (ly:get-option 'dump-cpu-profile) @@ -706,10 +840,10 @@ messages into errors.") (lambda (a b) (< (object-address (car a)) (object-address (car b)))))) - (out-file-name (string-append - "gcstat-" (number->string gc-protect-stat-count) - ".scm")) - (outfile (open-file out-file-name "w"))) + (out-file-name (string-append + "gcstat-" (number->string gc-protect-stat-count) + ".scm")) + (outfile (open-file out-file-name "w"))) (set! gc-dumping #t) (ly:progress "Dumping GC statistics ~a...\n" out-file-name) (for-each (lambda (y) @@ -739,13 +873,13 @@ messages into errors.") (ly:set-option 'debug-gc-assert-parsed-dead #t) (gc) (ly:set-option 'debug-gc-assert-parsed-dead #f) - (for-each - (lambda (x) - (if (not (hashq-ref gc-zombies x)) - (begin - (ly:programming-error "Parsed object should be dead: ~a" x) - (hashq-set! gc-zombies x #t)))) - (ly:parsed-undead-list!)) + (for-each + (lambda (x) + (if (not (hashq-ref gc-zombies x)) + (begin + (ly:programming-error "Parsed object should be dead: ~a" x) + (hashq-set! gc-zombies x #t)))) + (ly:parsed-undead-list!)) (set! stats (gc-live-object-stats)) (ly:progress "Dumping live object statistics.\n") (dump-live-object-stats outfile))) @@ -770,11 +904,10 @@ messages into errors.") (let* ((stat (gulp-file "/proc/self/status")) (lines (string-split stat #\newline)) - (interesting (filter identity - (map - (lambda (l) - (string-match "^VmData:[ \t]*([0-9]*) kB" l)) - lines))) + (interesting (filter-map + (lambda (l) + (string-match "^VmData:[ \t]*([0-9]*) kB" l)) + lines)) (mem (string->number (match:substring (car interesting) 1)))) (format #t "VMDATA: ~a\n" mem) (display (gc-stats)) @@ -791,9 +924,9 @@ PIDs or the number of the process." (define (helper count acc) (if (> count 0) (let* ((pid (primitive-fork))) - (if (= pid 0) - (1- count) - (helper (1- count) (cons pid acc)))) + (if (= pid 0) + (1- count) + (helper (1- count) (cons pid acc)))) acc)) (helper count '())) @@ -827,12 +960,15 @@ PIDs or the number of the process." (ly:exit 2 #t))) (if (ly:get-option 'read-file-list) (set! files - (filter (lambda (s) - (> (string-length s) 0)) - (apply append - (map (lambda (f) - (string-split (string-delete (ly:gulp-file f) #\cr) #\nl)) - files))))) + (remove string-null? + (append-map + (lambda (f) + (string-split + (if (guile-v2) + (string-delete #\cr (ly:gulp-file f)) + (string-delete (ly:gulp-file f) #\cr)) + #\nl)) + files)))) (if (and (number? (ly:get-option 'job-count)) (>= (length files) (ly:get-option 'job-count))) (let* ((count (ly:get-option 'job-count)) @@ -845,7 +981,7 @@ PIDs or the number of the process." (begin (ly:set-option 'log-file (format #f "~a-~a" (ly:get-option 'log-file) joblist)) - (set! files (vector-ref split-todo joblist))) + (set! files (vector-ref split-todo joblist))) (begin (ly:progress "\nForking into jobs: ~a\n" joblist) (for-each (lambda (pid) @@ -853,7 +989,7 @@ PIDs or the number of the process." (if (not (= stat 0)) (set! errors (acons (list-element-index joblist pid) - stat errors))))) + stat errors))))) joblist) (for-each (lambda (x) @@ -872,17 +1008,17 @@ PIDs or the number of the process." (ly:message (_ "logfile ~a (exit ~a):\n~a") logfile (status:exit-val state) tail)))) - errors) - (if (pair? errors) - (ly:error "Children ~a exited with errors." - (map car errors))) - ;; must overwrite individual entries - (if (ly:get-option 'dump-profile) - (dump-profile "lily-run-total" - '(0 0) (profile-measurements))) - (if (null? errors) - (ly:exit 0 #f) - (ly:exit 1 #f)))))) + errors) + (if (pair? errors) + (ly:error "Children ~a exited with errors." + (map car errors))) + ;; must overwrite individual entries + (if (ly:get-option 'dump-profile) + (dump-profile "lily-run-total" + '(0 0) (profile-measurements))) + (if (null? errors) + (ly:exit 0 #f) + (ly:exit 1 #f)))))) (if (string-or-symbol? (ly:get-option 'log-file)) (ly:stderr-redirect (format #f "~a.log" (ly:get-option 'log-file)) "w"))