scm/ly-syntax-constructors.scm

   1 ;;;; define-syntax.scm -- Defines functions for syntax expressions
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 2006 Erik Sandberg <mandolaerik@gmail.com>
   6
   7 ;; TODO: use separate module for syntax
   8 ;; constructors. Also create wrapper around the constructor?
   9 (define define-ly-syntax define-public)
  10
  11 ;; A ly-syntax constructor takes two extra parameters, parser and
  12 ;; location. These are mainly used for reporting errors and
  13 ;; warnings. This function is a syntactic sugar which uses the
  14 ;; location arg to set the origin of the returned music object; this
  15 ;; behaviour is usually desired
  16 (defmacro define-ly-syntax-loc (args . body)
  17   (primitive-eval `(define-ly-syntax ,args
  18                      (let ((m ,(cons 'begin body)))
  19                        (set! (ly:music-property m 'origin) ,(third args))
  20                        m))))
  21
  22 ;; Like define-ly-syntax-loc, but adds parser and location
  23 ;; parameters. Useful for simple constructors that don't need to
  24 ;; report errors.
  25 (defmacro define-ly-syntax-simple (args . body)
  26   (primitive-eval `(define-ly-syntax ,(cons* (car args)
  27                                              'parser
  28                                              'location
  29                                              (cdr args))
  30                      (let ((m ,(cons 'begin body)))
  31                        (set! (ly:music-property m 'origin) location)
  32                        m))))
  33
  34 ;; Music function: Apply function and check return value.
  35 (define-ly-syntax-loc (music-function parser loc fun args)
  36   (let ((m (apply fun (cons* parser loc args))))
  37     (if (ly:music? m)
  38         m
  39         (begin
  40           (ly:parser-error parser (_ "Music head function must return Music object") loc)
  41           (make-music 'Music)))))
  42
  43 (define-ly-syntax-simple (void-music)
  44   (make-music 'Music))
  45
  46 (define-ly-syntax-simple (sequential-music mlist)
  47   (make-sequential-music mlist))
  48
  49 (define-ly-syntax-simple (simultaneous-music mlist)
  50   (make-simultaneous-music mlist))
  51
  52 (define-ly-syntax-simple (event-chord mlist)
  53   (make-music 'EventChord
  54               'elements mlist))
  55
  56 (define-ly-syntax-simple (unrelativable-music mus)
  57   (make-music 'UnrelativableMusic
  58               'element mus))
  59
  60 (define-ly-syntax-simple (context-change type id)
  61   (make-music 'ContextChange
  62               'change-to-type type
  63               'change-to-id id))
  64
  65 (define-ly-syntax-simple (voice-separator)
  66   (make-music 'VoiceSeparator))
  67
  68 (define-ly-syntax-simple (bar-check)
  69   (make-music 'BarCheck))
  70
  71 (define-ly-syntax-simple (time-scaled-music fraction music)
  72   (make-music 'TimeScaledMusic
  73               'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
  74               'numerator (car fraction)
  75               'denominator (cdr fraction)))
  76
  77 (define-ly-syntax-simple (transpose-music pitch music)
  78   (make-music 'TransposedMusic
  79               'element (ly:music-transpose music pitch)))
  80
  81 (define-ly-syntax-simple (tempo duration tempo)
  82   (context-spec-music
  83    (make-sequential-music
  84     (list
  85      (make-property-set 'tempoWholesPerMinute
  86                         (ly:moment-mul (ly:make-moment tempo 1)
  87                                        (ly:duration-length duration)))
  88      (make-property-set 'tempoUnitDuration duration)
  89      (make-property-set 'tempoUnitCount tempo)))
  90    'Score))
  91
  92 (define-ly-syntax-simple (skip-music dur)
  93   (make-music 'SkipMusic
  94               'duration dur))
  95
  96 (define-ly-syntax-simple (repeat type num body alts)
  97   (make-repeat type num body alts))
  98
  99 (define (script-to-mmrest-text music)
 100   "Extract 'direction and 'text from SCRIPT-MUSIC, and transform MultiMeasureTextEvent"
 101   (if (memq 'script-event (ly:music-property music 'types))
 102
 103       (let ((dir (ly:music-property music 'direction))
 104             (p   (make-music 'MultiMeasureTextEvent
 105                              'text (ly:music-property music 'text))))
 106         (if (ly:dir? dir)
 107             (set! (ly:music-property p 'direction) dir))
 108         p)
 109       music))
 110
 111 (define-ly-syntax (multi-measure-rest parser location duration articulations)
 112   (make-music 'MultiMeasureRestMusic
 113               'articulations (map script-to-mmrest-text articulations)
 114               'duration duration
 115               'origin location))
 116
 117 (define-ly-syntax-simple (context-specification type id mus ops create-new)
 118   (let* ((type-sym (if (symbol? type) type (string->symbol type)))
 119          (csm (context-spec-music mus type-sym id)))
 120     (set! (ly:music-property csm 'property-operations) ops)
 121     (if create-new (set! (ly:music-property csm 'create-new) #t))
 122     csm))
 123
 124 (define-ly-syntax (property-operation parser location once ctx music-type symbol . args)
 125   (let* ((props (case music-type
 126                   ((PropertySet) (list 'value (car args)))
 127                   ((PropertyUnset) '())
 128                   ((OverrideProperty) (list 'grob-value (car args)
 129                                             'grob-property-path (cdr args)
 130                                             'pop-first #t))
 131                   ((RevertProperty) (list 'grob-property-path args))
 132                   (else (ly:error (_ "Invalid property operation ~a") music-type))))
 133          (oprops (if once (cons* 'once once props) props))
 134          (m (apply make-music music-type
 135                    'symbol symbol
 136                    'origin location
 137                    oprops)))
 138     (make-music 'ContextSpeccedMusic
 139                 'element m
 140                 'context-type ctx
 141                 'origin location)))
 142
 143 ;; TODO: It seems that this function rarely returns anything useful.
 144 (define (get-first-context-id type mus)
 145   "Find the name of a ContextSpeccedMusic with given type"
 146   (let ((id (ly:music-property mus 'context-id)))
 147     (if (and (eq? (ly:music-property mus 'type) 'ContextSpeccedMusic)
 148              (eq? (ly:music-property mus 'context-type) type)
 149              (string? id)
 150              (not (string-null? id)))
 151         id
 152         '())))
 153
 154 (define unique-counter -1)
 155 (define (get-next-unique-voice-name)
 156   (set! unique-counter (1+ unique-counter))
 157   (call-with-output-string (lambda (p) (format p "uniqueContext~s" unique-counter))))
 158
 159 (define (lyric-combine-music sync music loc)
 160   (make-music 'LyricCombineMusic
 161               'element music
 162               'associated-context sync
 163               'origin loc))
 164
 165 (define-ly-syntax (lyric-combine parser location voice music)
 166   (lyric-combine-music voice music location))
 167
 168 (define-ly-syntax (add-lyrics parser location music addlyrics-list)
 169   (let* ((existing-voice-name (get-first-context-id 'Voice music))
 170          (voice-name (if (string? existing-voice-name)
 171                          existing-voice-name
 172                          (get-next-unique-voice-name)))
 173          (voice (if (string? existing-voice-name)
 174                     (music)
 175                     (make-music 'ContextSpeccedMusic
 176                                 'element music
 177                                 'context-type 'Voice
 178                                 'context-id voice-name
 179                                 'origin (ly:music-property music 'origin))))
 180          (lyricstos (map (lambda (mus)
 181                            (let* ((loc (ly:music-property mus 'origin))
 182                                   (lyr (lyric-combine-music voice-name mus loc)))
 183                              (make-music 'ContextSpeccedMusic
 184                                          'create-new #t
 185                                          'context-type 'Lyrics
 186                                          'element lyr
 187                                          'origin loc)))
 188                          addlyrics-list)))
 189     (make-simultaneous-music (cons voice lyricstos))))