1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2006--2010 Erik Sandberg <mandolaerik@gmail.com>
5 ;;;; LilyPond is free software: you can redistribute it and/or modify
6 ;;;; it under the terms of the GNU General Public License as published by
7 ;;;; the Free Software Foundation, either version 3 of the License, or
8 ;;;; (at your option) any later version.
10 ;;;; LilyPond is distributed in the hope that it will be useful,
11 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ;;;; GNU General Public License for more details.
15 ;;;; You should have received a copy of the GNU General Public License
16 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
18 ;; TODO: use separate module for syntax
19 ;; constructors. Also create wrapper around the constructor?
20 (define define-ly-syntax define-public)
22 ;; A ly-syntax constructor takes two extra parameters, parser and
23 ;; location. These are mainly used for reporting errors and
24 ;; warnings. This function is a syntactic sugar which uses the
25 ;; location arg to set the origin of the returned music object; this
26 ;; behaviour is usually desired
27 (defmacro define-ly-syntax-loc (args . body)
28 (primitive-eval `(define-ly-syntax ,args
29 (let ((m ,(cons 'begin body)))
30 (set! (ly:music-property m 'origin) ,(third args))
33 ;; Like define-ly-syntax-loc, but adds parser and location
34 ;; parameters. Useful for simple constructors that don't need to
36 (defmacro define-ly-syntax-simple (args . body)
37 (primitive-eval `(define-ly-syntax ,(cons* (car args)
41 (let ((m ,(cons 'begin body)))
42 (set! (ly:music-property m 'origin) location)
45 ;; Music function: Apply function and check return value.
46 (define-ly-syntax-loc (music-function parser loc fun args)
47 (let ((m (apply fun (cons* parser loc args))))
51 (ly:parser-error parser (_ "Music head function must return Music object") loc)
52 (make-music 'Music)))))
54 (define-ly-syntax-simple (void-music)
57 (define-ly-syntax-simple (sequential-music mlist)
58 (make-sequential-music mlist))
60 (define-ly-syntax-simple (simultaneous-music mlist)
61 (make-simultaneous-music mlist))
63 (define-ly-syntax-simple (event-chord mlist)
64 (make-music 'EventChord
67 (define-ly-syntax-simple (unrelativable-music mus)
68 (make-music 'UnrelativableMusic
71 (define-ly-syntax-simple (context-change type id)
72 (make-music 'ContextChange
76 (define-ly-syntax-simple (voice-separator)
77 (make-music 'VoiceSeparator))
79 (define-ly-syntax-simple (bar-check)
80 (make-music 'BarCheck))
82 (define-ly-syntax-simple (time-scaled-music fraction music)
83 (make-music 'TimeScaledMusic
84 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
85 'numerator (car fraction)
86 'denominator (cdr fraction)))
88 (define-ly-syntax-simple (transpose-music pitch music)
89 (make-music 'TransposedMusic
90 'element (ly:music-transpose music pitch)))
92 (define-ly-syntax-simple (tempo text duration tempo)
94 (make-property-set 'tempoWholesPerMinute
95 (ly:moment-mul (ly:make-moment tempo 1)
96 (ly:duration-length duration)))
97 (make-property-set 'tempoUnitDuration duration)
98 (make-property-set 'tempoUnitCount tempo))))
100 (if text (make-property-set 'tempoText text)
101 (make-property-unset 'tempoText))
104 (make-sequential-music props)
107 (define-ly-syntax-simple (tempoText text)
109 (make-sequential-music
111 (make-property-unset 'tempoUnitDuration)
112 (make-property-unset 'tempoUnitCount)
113 (make-property-set 'tempoText text)))
116 (define-ly-syntax-simple (skip-music dur)
117 (make-music 'SkipMusic
120 (define-ly-syntax-simple (repeat type num body alts)
121 (make-repeat type num body alts))
123 (define (script-to-mmrest-text music)
124 "Extract @code{'direction} and @code{'text} from @var{music}, and transform
125 into a @code{MultiMeasureTextEvent}."
127 (if (memq 'script-event (ly:music-property music 'types))
128 (let* ((location (ly:music-property music 'origin))
129 (dir (ly:music-property music 'direction))
130 (tags (ly:music-property music 'tags))
131 (p (make-music 'MultiMeasureTextEvent
134 'text (ly:music-property music 'text))))
136 (set! (ly:music-property p 'direction) dir))
140 (define-ly-syntax (multi-measure-rest parser location duration articulations)
141 (make-music 'MultiMeasureRestMusic
142 'articulations (map script-to-mmrest-text articulations)
146 (define-ly-syntax (repetition-chord parser location previous-chord repetition-function duration articulations)
147 (make-music 'RepeatedChord
148 'original-chord previous-chord
149 'element (repetition-function previous-chord location duration articulations)
152 (define-ly-syntax-simple (context-specification type id mus ops create-new)
153 (let* ((type-sym (if (symbol? type) type (string->symbol type)))
154 (csm (context-spec-music mus type-sym id)))
155 (set! (ly:music-property csm 'property-operations) ops)
156 (if create-new (set! (ly:music-property csm 'create-new) #t))
159 (define-ly-syntax (property-operation parser location once ctx music-type symbol . args)
160 (let* ((props (case music-type
161 ((PropertySet) (list 'value (car args)))
162 ((PropertyUnset) '())
163 ((OverrideProperty) (list 'grob-value (car args)
164 'grob-property-path (if (list? (cadr args))
169 (if (list? (car args))
170 (list 'grob-property-path (car args))
171 (list 'grob-property-path args)))
172 (else (ly:error (_ "Invalid property operation ~a") music-type))))
173 (oprops (if once (cons* 'once once props) props))
174 (m (apply make-music music-type
178 (make-music 'ContextSpeccedMusic
183 ;; TODO: It seems that this function rarely returns anything useful.
184 (define (get-first-context-id type mus)
185 "Find the name of a ContextSpeccedMusic with given type"
186 (let ((id (ly:music-property mus 'context-id)))
187 (if (and (eq? (ly:music-property mus 'type) 'ContextSpeccedMusic)
188 (eq? (ly:music-property mus 'context-type) type)
190 (not (string-null? id)))
194 (define unique-counter -1)
195 (define (get-next-unique-voice-name)
196 (set! unique-counter (1+ unique-counter))
197 (call-with-output-string (lambda (p) (format p "uniqueContext~s" unique-counter))))
199 (define (lyric-combine-music sync music loc)
200 ;; CompletizeExtenderEvent is added following the last lyric in MUSIC
201 ;; to signal to the Extender_engraver that any pending extender should
202 ;; be completed if the lyrics end before the associated voice.
203 (append! (ly:music-property music 'elements)
204 (list (make-music 'CompletizeExtenderEvent)))
205 (make-music 'LyricCombineMusic
207 'associated-context sync
210 (define-ly-syntax (lyric-combine parser location voice music)
211 (lyric-combine-music voice music location))
213 (define-ly-syntax (add-lyrics parser location music addlyrics-list)
214 (let* ((existing-voice-name (get-first-context-id 'Voice music))
215 (voice-name (if (string? existing-voice-name)
217 (get-next-unique-voice-name)))
218 (voice (if (string? existing-voice-name)
220 (make-music 'ContextSpeccedMusic
223 'context-id voice-name
224 'origin (ly:music-property music 'origin))))
225 (lyricstos (map (lambda (mus)
226 (let* ((loc (ly:music-property mus 'origin))
227 (lyr (lyric-combine-music voice-name mus loc)))
228 (make-music 'ContextSpeccedMusic
230 'context-type 'Lyrics
234 (make-simultaneous-music (cons voice lyricstos))))
236 (define-ly-syntax (make-mark-set parser location label)
237 "Make the music for the \\mark command."
238 (let* ((set (and (integer? label)
239 (context-spec-music (make-property-set 'rehearsalMark label)
241 (ev (make-music 'MarkEvent))
242 (ch (make-event-chord (list ev))))
244 (set! (ly:music-property ev 'origin) location)
246 (make-sequential-music (list set ch))
248 (set! (ly:music-property ev 'label) label)
251 (define-ly-syntax (partial parser location dur)
252 "Make a partial measure."
254 ;; We use `descend-to-context' here instead of `context-spec-music' to
255 ;; ensure \partial still works if the Timing_translator is moved
257 (context-spec-music (make-music 'PartialSet
259 'partial-duration dur)