]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/ly-syntax-constructors.scm
Imported Upstream version 2.16.0
[lilypond.git] / scm / ly-syntax-constructors.scm
index ee798233611a6a65361f1fae414962848a9f3cfa..9cbec5fc4f55f61c6b28f17e558109da84e0a4b4 100644 (file)
@@ -1,12 +1,24 @@
-;;;; define-syntax.scm -- Defines functions for syntax expressions
+;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;
-;;;;  source file of the GNU LilyPond music typesetter
-;;;; 
-;;;; (c) 2006 Erik Sandberg <mandolaerik@gmail.com>
+;;;; Copyright (C) 2006--2012 Erik Sandberg <mandolaerik@gmail.com>
+;;;;
+;;;; LilyPond is free software: you can redistribute it and/or modify
+;;;; it under the terms of the GNU General Public License as published by
+;;;; the Free Software Foundation, either version 3 of the License, or
+;;;; (at your option) any later version.
+;;;;
+;;;; LilyPond is distributed in the hope that it will be useful,
+;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;;; GNU General Public License for more details.
+;;;;
+;;;; You should have received a copy of the GNU General Public License
+;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 
 ;; TODO: use separate module for syntax
 ;; constructors. Also create wrapper around the constructor?
-(define define-ly-syntax define-public)
+(defmacro define-ly-syntax (args . body)
+  `(define-public ,args ,(cons 'begin body)))
 
 ;; A ly-syntax constructor takes two extra parameters, parser and
 ;; location. These are mainly used for reporting errors and
 ;; location arg to set the origin of the returned music object; this
 ;; behaviour is usually desired
 (defmacro define-ly-syntax-loc (args . body)
-  (primitive-eval `(define-ly-syntax ,args
-                    (let ((m ,(cons 'begin body)))
-                      (set! (ly:music-property m 'origin) ,(third args))
-                      m))))
-
+  `(define-public ,args
+     (let ((m ,(cons 'begin body)))
+       (set! (ly:music-property m 'origin) ,(third args))
+       m)))
 ;; Like define-ly-syntax-loc, but adds parser and location
 ;; parameters. Useful for simple constructors that don't need to
 ;; report errors.
 (defmacro define-ly-syntax-simple (args . body)
-  (primitive-eval `(define-ly-syntax ,(cons* (car args) 
-                                            'parser
-                                            'location 
-                                            (cdr args))
-                    (let ((m ,(cons 'begin body)))
-                      (set! (ly:music-property m 'origin) location)
-                      m))))
+  `(define-public ,(cons* (car args)
+                         'parser
+                         'location
+                         (cdr args))
+     (let ((m ,(cons 'begin body)))
+       (set! (ly:music-property m 'origin) location)
+       m)))
 
 ;; Music function: Apply function and check return value.
-(define-ly-syntax-loc (music-function parser loc fun args)
-  (let ((m (apply fun (cons* parser loc args))))
-    (if (ly:music? m)
-       m
+;; args are in reverse order, rest may specify additional ones
+;;
+;; If args is not a proper list, an error has been flagged earlier
+;; and no fallback value had been available.  In this case,
+;; we don't call the function but rather return the general
+;; fallback.
+(define-ly-syntax (music-function parser loc fun args . rest)
+  (let* ((sig (ly:music-function-signature fun))
+        (pred (if (pair? (car sig)) (caar sig) (car sig)))
+        (good (proper-list? args))
+        (m (and good (apply (ly:music-function-extract fun)
+                            parser loc (reverse! args rest)))))
+    (if (and good (pred m))
+       (begin
+         (if (ly:music? m)
+             (set! (ly:music-property m 'origin) loc))
+         m)
        (begin
-         (ly:parser-error parser (_ "Music head function must return Music object") loc)
-         (make-music 'Music)))))
+         (if good
+             (ly:parser-error parser
+                              (format #f (_ "~a function cannot return ~a")
+                                      (type-name pred) m)
+                              loc))
+         (and (pair? (car sig)) (cdar sig))))))
+
+(define-ly-syntax (argument-error parser location n pred arg)
+  (ly:parser-error
+   parser
+   (format #f
+          (_ "wrong type for argument ~a.  Expecting ~a, found ~s")
+          n (type-name pred) arg)
+   location))
 
 (define-ly-syntax-simple (void-music)
   (make-music 'Music))
 (define-ly-syntax-simple (bar-check)
   (make-music 'BarCheck))
 
-(define-ly-syntax-simple (time-scaled-music fraction music)
-  (make-music 'TimeScaledMusic
-             'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
-             'numerator (car fraction)
-             'denominator (cdr fraction)))
-
-(define-ly-syntax-simple (transpose-music pitch music)
-  (make-music 'TransposedMusic
-             'element (ly:music-transpose music pitch)))
-
-(define-ly-syntax-simple (tempo text duration tempo)
-  (let ((props (list
-                 (make-property-set 'tempoWholesPerMinute
-                       (ly:moment-mul (ly:make-moment tempo 1)
-                                      (ly:duration-length duration)))
-                 (make-property-set 'tempoUnitDuration duration)
-                 (make-property-set 'tempoUnitCount tempo))))
-    (set! props (cons 
-            (if text (make-property-set 'tempoText text)
-                     (make-property-unset 'tempoText)) 
-            props))
-    (context-spec-music
-      (make-sequential-music props)
-      'Score)))
-
-(define-ly-syntax-simple (tempoText text)
-  (context-spec-music
-   (make-sequential-music
-    (list
-     (make-property-unset 'tempoUnitDuration)
-     (make-property-unset 'tempoUnitCount)
-     (make-property-set 'tempoText text)))
-   'Score))
-
-(define-ly-syntax-simple (skip-music dur)
-  (make-music 'SkipMusic
-             'duration dur))
+(define-ly-syntax (tempo parser location text . rest)
+  (let* ((unit (and (pair? rest)
+                   (car rest)))
+        (count (and unit
+                    (cadr rest)))
+        (range-tempo? (pair? count))
+        (tempo-change (make-music 'TempoChangeEvent
+                                  'origin location
+                                  'text text
+                                  'tempo-unit unit
+                                  'metronome-count count))
+        (tempo-set
+         (and unit
+              (context-spec-music
+               (make-property-set 'tempoWholesPerMinute
+                                  (ly:moment-mul
+                                   (ly:make-moment
+                                    (if range-tempo?
+                                        (round (/ (+ (car count) (cdr count))
+                                                  2))
+                                        count)
+                                    1)
+                                   (ly:duration-length unit)))
+               'Score))))
+
+    (if tempo-set
+       (make-sequential-music (list tempo-change tempo-set))
+       tempo-change)))
 
 (define-ly-syntax-simple (repeat type num body alts)
   (make-repeat type num body alts))
 
 (define (script-to-mmrest-text music)
-  "Extract 'direction and 'text from SCRIPT-MUSIC, and transform MultiMeasureTextEvent"
+  "Extract @code{'direction} and @code{'text} from @var{music}, and transform
+into a @code{MultiMeasureTextEvent}."
 
   (if (memq 'script-event (ly:music-property music 'types))
-      
-      (let*
-         ((dir (ly:music-property music 'direction))
-          (tags (ly:music-property music 'tags))
-          (p   (make-music 'MultiMeasureTextEvent
-                            'tags tags
-                            'text (ly:music-property music 'text))))
+      (let* ((location (ly:music-property music 'origin))
+            (dir (ly:music-property music 'direction))
+            (tags (ly:music-property music 'tags))
+            (p (make-music 'MultiMeasureTextEvent
+                           'origin location
+                           'tags tags
+                           'text (ly:music-property music 'text))))
        (if (ly:dir? dir)
            (set! (ly:music-property p 'direction) dir))
        p)
              'duration duration
              'origin location))
 
-(define-ly-syntax-simple (context-specification type id mus ops create-new)
+(define-ly-syntax (repetition-chord parser location duration articulations)
+  (make-music 'EventChord
+             'duration duration
+             'elements articulations
+             'origin location))
+
+(define-ly-syntax-simple (context-specification type id ops create-new mus)
   (let* ((type-sym (if (symbol? type) type (string->symbol type)))
         (csm (context-spec-music mus type-sym id)))
     (set! (ly:music-property csm 'property-operations) ops)
     (if create-new (set! (ly:music-property csm 'create-new) #t))
     csm))
 
-(define-ly-syntax (property-operation parser location once ctx music-type symbol . args)
+(define-ly-syntax (property-operation parser location ctx music-type symbol . args)
   (let* ((props (case music-type
                  ((PropertySet) (list 'value (car args)))
                  ((PropertyUnset) '())
                       (list 'grob-property-path (car args))
                       (list 'grob-property-path args)))
                  (else (ly:error (_ "Invalid property operation ~a") music-type))))
-        (oprops (if once (cons* 'once once props) props))
         (m (apply make-music music-type
                   'symbol symbol
                   'origin location
-                  oprops)))
+                  props)))
     (make-music 'ContextSpeccedMusic
                'element m
                'context-type ctx
   (set! unique-counter (1+ unique-counter))
   (call-with-output-string (lambda (p) (format p "uniqueContext~s" unique-counter))))
 
+(define-ly-syntax-simple (lyric-event text duration)
+  (make-lyric-event text duration))
+
 (define (lyric-combine-music sync music loc)
+  ;; CompletizeExtenderEvent is added following the last lyric in MUSIC
+  ;; to signal to the Extender_engraver that any pending extender should
+  ;; be completed if the lyrics end before the associated voice.
+  (append! (ly:music-property music 'elements)
+          (list (make-music 'CompletizeExtenderEvent)))
   (make-music 'LyricCombineMusic
              'element music
              'associated-context sync