]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/lily.scm
Doc-es: various updates.
[lilypond.git] / scm / lily.scm
index f227adc5b99377995e8cd35fbc955c8db44f053c..4b3c9c7e1c4cad55c64a53fe611d1effcf692612 100644 (file)
@@ -1,6 +1,6 @@
 ;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;
-;;;; Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
+;;;; Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;; Han-Wen Nienhuys <hanwen@xs4all.nl>
 ;;;;
 ;;;; LilyPond is free software: you can redistribute it and/or modify
 (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.
@@ -68,6 +86,7 @@
 ;;
 
 (define lilypond-declarations '())
+(define lilypond-exports '())
 (define after-session-hook (make-hook))
 
 (define-public (call-after-session thunk)
       (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
@@ -89,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)
@@ -140,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))))
@@ -169,183 +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) and scale down result to prevent jaggies in
+                       "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
+     #t
+     "Create .tex, .texi, .count files in the
 EPS backend.")
     (backend
-      ps
-"Select backend.  Possible values: 'eps, 'null,
+     ps
+     "Select backend.  Possible values: 'eps, 'null,
 'ps, 'scm, 'socket, 'svg.")
     (check-internal-types
-      #f
-"Check every property assignment for types.")
+     #f
+     "Check every property assignment for types.")
     (clip-systems
-      #f
-"Generate cut-out snippets of a score.")
+     #f
+     "Generate cut-out snippets of a score.")
     (datadir
-      #f
-"LilyPond prefix for data files (read-only).")
+     #f
+     "LilyPond prefix for data files (read-only).")
     (debug-gc
-      #f
-"Dump memory debugging statistics.")
+     #f
+     "Dump memory debugging statistics.")
     (debug-gc-assert-parsed-dead
-      #f
-"For memory debugging: Ensure that all
+     #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.")
+     #f
+     "Debug the flex lexer.")
     (debug-page-breaking-scoring
-      #f
-"Dump scores for many different page breaking
+     #f
+     "Dump scores for many different page breaking
 configurations.")
     (debug-parser
-      #f
-"Debug the bison parser.")
+     #f
+     "Debug the bison parser.")
     (debug-property-callbacks
-      #f
-"Debug cyclic callback chains.")
+     #f
+     "Debug cyclic callback chains.")
     (debug-skylines
-      #f
-"Debug skylines.")
+     #f
+     "Debug skylines.")
     (delete-intermediate-files
-      #t
-"Delete unusable, intermediate PostScript files.")
+     #t
+     "Delete unusable, intermediate PostScript files.")
     (dump-profile
-      #f
-"Dump memory and time information for each file.")
+     #f
+     "Dump memory and time information for each file.")
     (dump-cpu-profile
-      #f
-"Dump timing information (system-dependent).")
+     #f
+     "Dump timing information (system-dependent).")
     (dump-signatures
-      #f
-"Dump output signatures of each system.  Used for
+     #f
+     "Dump output signatures of each system.  Used for
 regression testing.")
+    (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
+     #f
+     "Pad left edge of the output EPS bounding box by
 given amount (in mm).")
+    (font-export-dir
+     #f
+     "Directory for exporting fonts as PostScript files.")
     (gs-load-fonts
-      #f
-"Load fonts via Ghostscript.")
+     #f
+     "Load fonts via Ghostscript.")
     (gs-load-lily-fonts
-      #f
-"Load only LilyPond fonts via Ghostscript.")
+     #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
+     #f
+     "Run LilyPond from a GUI and redirect stderr to
 a log file.")
     (help
-      #f
-"Show this help.")
+     #f
+     "Show this help.")
     (include-book-title-preview
-      #t
-"Include book titles in preview images.")
+     #t
+     "Include book titles in preview images.")
     (include-eps-fonts
-      #t
-"Include fonts in separate-system EPS files.")
+     #t
+     "Include fonts in separate-system EPS files.")
     (include-settings
-      #f
-"Include file for global settings, included before the score is processed.")
+     #f
+     "Include file for global settings, included before the score is processed.")
     (job-count
-      #f
-"Process in parallel, using the given number of
+     #f
+     "Process in parallel, using the given number of
 jobs.")
     (log-file
-      #f
-"If string FOO is given as argument, redirect
+     #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,
+     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
+     #f
+     "Convert text strings to paths when glyphs belong
 to a music font.")
     (point-and-click
-      #t
-"Add point & click links to PDF output.")
+     #t
+     "Add point & click links to PDF and SVG output.")
     (paper-size
-      "a4"
-"Set default paper size.")
+     "a4"
+     "Set default paper size.")
     (pixmap-format
-      "png16m"
-"Set GhostScript's output format for pixel images.")
+     "png16m"
+     "Set GhostScript's output format for pixel images.")
     (preview
-      #f
-"Create preview images also.")
+     #f
+     "Create preview images also.")
     (print-pages
-      #t
-"Print pages in the normal way.")
+     #t
+     "Print pages in the normal way.")
     (protected-scheme-parsing
-      #t
-"Continue when errors in inline scheme are caught
+     #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.")
+     #f
+     "Keep statistics of get_property() calls.")
     (resolution
-      101
-"Set resolution for generating PNG pixmaps to
+     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
+     #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)")
+     #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.")
+     #f
+     "Run in safer mode.")
     (separate-log-files
-      #f
-"For input files `FILE1.ly', `FILE2.ly', ...
+     #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.")
+     #f
+     "List available font names.")
     (strict-infinity-checking
-      #f
-"Force a crash on encountering Inf and NaN
+     #f
+     "Force a crash on encountering Inf and NaN
 floating point exceptions.")
     (strip-output-dir
-      #t
-"Don't use directories from input files while
+     #t
+     "Don't use directories from input files while
 constructing output file names.")
+    (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.")
+     #f
+     "Use woff font files in SVG backend.")
     (trace-memory-frequency
-      #f
-"Record Scheme cell usage this many times per
+     #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'.")
+     #f
+     "Record coverage of Scheme files in `FILE.cov'.")
     (verbose ,(ly:verbose-output?)
-"Verbose output, i.e. loglevel at least DEBUG (read-only).")
+             "Verbose output, i.e. loglevel at least DEBUG (read-only).")
     (warning-as-error
-      #f
-"Change all warning and programming_error
+     #f
+     "Change all warning and programming_error
 messages into errors.")
     ))
 
@@ -405,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)
@@ -420,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.
@@ -440,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))
 
@@ -485,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
@@ -541,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"
@@ -551,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"
@@ -652,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")
@@ -662,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")
@@ -687,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")
@@ -707,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")
@@ -717,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")
     ))
 
@@ -742,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)
@@ -841,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))
@@ -898,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))