1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2006--2012 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 (defmacro define-ly-syntax (args . body)
21 `(define-public ,args ,@body))
23 ;; A ly-syntax constructor takes two extra parameters, parser and
24 ;; location. These are mainly used for reporting errors and
25 ;; warnings. This function is a syntactic sugar which uses the
26 ;; location arg to set the origin of the returned music object; this
27 ;; behaviour is usually desired
28 (defmacro define-ly-syntax-loc (args . body)
30 (let ((m ,(cons 'begin body)))
31 (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 `(define-public ,(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 ;; args are in reverse order, rest may specify additional ones
48 ;; If args is not a proper list, an error has been flagged earlier
49 ;; and no fallback value had been available. In this case,
50 ;; we don't call the function but rather return the general
52 (define-ly-syntax (music-function parser loc fun args . rest)
53 (let* ((sig (ly:music-function-signature fun))
54 (pred (if (pair? (car sig)) (caar sig) (car sig)))
55 (good (proper-list? args))
56 (m (and good (apply (ly:music-function-extract fun)
57 parser loc (reverse! args rest)))))
58 (if (and good (pred m))
61 (set! (ly:music-property m 'origin) loc))
65 (ly:parser-error parser
66 (format #f (_ "~a function cannot return ~a")
69 (and (pair? (car sig)) (cdar sig))))))
71 (define-ly-syntax (argument-error parser location n pred arg)
75 (_ "wrong type for argument ~a. Expecting ~a, found ~s")
76 n (type-name pred) arg)
79 (define-ly-syntax-simple (void-music)
82 (define-ly-syntax-simple (sequential-music mlist)
83 (make-sequential-music mlist))
85 (define-ly-syntax-simple (simultaneous-music mlist)
86 (make-simultaneous-music mlist))
88 (define-ly-syntax-simple (event-chord mlist)
89 (make-music 'EventChord
92 (define-ly-syntax-simple (unrelativable-music mus)
93 (make-music 'UnrelativableMusic
96 (define-ly-syntax-simple (context-change type id)
97 (make-music 'ContextChange
101 (define-ly-syntax (tempo parser location text . rest)
102 (let* ((unit (and (pair? rest)
106 (range-tempo? (pair? count))
107 (tempo-change (make-music 'TempoChangeEvent
111 'metronome-count count))
115 (make-property-set 'tempoWholesPerMinute
119 (round (/ (+ (car count) (cdr count))
123 (ly:duration-length unit)))
127 (make-sequential-music (list tempo-change tempo-set))
130 (define-ly-syntax-simple (repeat type num body alts)
131 (make-repeat type num body alts))
133 (define (script-to-mmrest-text music)
134 "Extract @code{'direction} and @code{'text} from @var{music}, and transform
135 into a @code{MultiMeasureTextEvent}."
137 (if (music-is-of-type? music 'script-event)
138 (make-music 'MultiMeasureTextEvent music)
141 (define-ly-syntax (multi-measure-rest parser location duration articulations)
142 (make-music 'MultiMeasureRestMusic
143 'articulations (map script-to-mmrest-text articulations)
147 (define-ly-syntax (repetition-chord parser location duration articulations)
148 (make-music 'EventChord
150 'elements articulations
153 (define-ly-syntax-simple (context-specification type id ops create-new mus)
154 (let ((csm (context-spec-music mus type 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 (composed-markup-list parser location commands markups)
160 ;; `markups' being a list of markups, eg (markup1 markup2 markup3),
161 ;; and `commands' a list of commands with their scheme arguments, in reverse order,
162 ;; eg: ((italic) (raise 4) (bold)), maps the commands on each markup argument, eg:
163 ;; ((bold (raise 4 (italic markup1)))
164 ;; (bold (raise 4 (italic markup2)))
165 ;; (bold (raise 4 (italic markup3))))
167 (define (compose arg)
169 (lambda (cmd prev) (append cmd (list prev)))
172 (let loop ((markups markups) (completed '()))
173 (cond ((null? markups) (reverse! completed))
174 ((markup? (car markups))
176 (cons (compose (car markups)) completed)))
179 (lambda () (break! markup? markups))
180 (lambda (complex rest)
183 (make-map-markup-commands-markup-list
184 compose complex) completed))))))))
186 (define-ly-syntax (property-operation parser location ctx music-type symbol . args)
187 (let* ((props (case music-type
188 ((PropertySet) (list 'value (car args)))
189 ((PropertyUnset) '())
190 ((OverrideProperty) (list 'grob-value (car args)
191 'grob-property-path (if (list? (cadr args))
196 (if (list? (car args))
197 (list 'grob-property-path (car args))
198 (list 'grob-property-path args)))
199 (else (ly:error (_ "Invalid property operation ~a") music-type))))
200 (m (apply make-music music-type
204 (make-music 'ContextSpeccedMusic
209 ;; TODO: It seems that this function rarely returns anything useful.
210 (define (get-first-context-id type mus)
211 "Find the name of a ContextSpeccedMusic with given type"
212 (let ((id (ly:music-property mus 'context-id)))
213 (if (and (eq? (ly:music-property mus 'type) 'ContextSpeccedMusic)
214 (eq? (ly:music-property mus 'context-type) type)
216 (not (string-null? id)))
220 (define unique-counter -1)
221 (define (get-next-unique-voice-name)
222 (set! unique-counter (1+ unique-counter))
223 (call-with-output-string (lambda (p) (format p "uniqueContext~s" unique-counter))))
225 (define-ly-syntax-simple (lyric-event text duration)
226 (make-lyric-event text duration))
228 (define (lyric-combine-music sync music loc)
229 ;; CompletizeExtenderEvent is added following the last lyric in MUSIC
230 ;; to signal to the Extender_engraver that any pending extender should
231 ;; be completed if the lyrics end before the associated voice.
232 (append! (ly:music-property music 'elements)
233 (list (make-music 'CompletizeExtenderEvent)))
234 (make-music 'LyricCombineMusic
236 'associated-context sync
239 (define-ly-syntax (lyric-combine parser location voice music)
240 (lyric-combine-music voice music location))
242 (define-ly-syntax (add-lyrics parser location music addlyrics-list)
243 (let* ((existing-voice-name (get-first-context-id 'Voice music))
244 (voice-name (if (string? existing-voice-name)
246 (get-next-unique-voice-name)))
247 (voice (if (string? existing-voice-name)
249 (make-music 'ContextSpeccedMusic
252 'context-id voice-name
253 'origin (ly:music-property music 'origin))))
254 (lyricstos (map (lambda (mus)
255 (let* ((loc (ly:music-property mus 'origin))
256 (lyr (lyric-combine-music voice-name mus loc)))
257 (make-music 'ContextSpeccedMusic
259 'context-type 'Lyrics
263 (make-simultaneous-music (cons voice lyricstos))))