1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 2006--2015 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 (define-module (scm ly-syntax-constructors)
20 #:use-module (srfi srfi-1)
21 #:use-module (scm display-lily))
23 (define-public (music-function-call-error fun m)
24 (let* ((sigcar (car (ly:music-function-signature fun)))
25 (pred? (if (pair? sigcar) (car sigcar) sigcar)))
27 (format #f (_ "~a function cannot return ~a")
29 (value->lily-string m))
32 (if (ly:music? (cdr sigcar))
33 (ly:music-deep-copy (cdr sigcar) (*location*))
36 ;; Music function: Apply function and check return value.
37 ;; args are in reverse order.
39 ;; If args is not a proper list, an error has been flagged earlier
40 ;; and no fallback value had been available. In this case,
41 ;; we don't call the function but rather return the general
43 (define-public (music-function fun args)
44 (let* ((sigcar (car (ly:music-function-signature fun)))
45 (pred? (if (pair? sigcar) (car sigcar) sigcar))
47 (m (and good (apply (ly:music-function-extract fun) (reverse! args)))))
50 (if (ly:music? m) (ly:set-origin! m) m)
51 (music-function-call-error fun m))
53 (if (ly:music? (cdr sigcar))
54 (ly:music-deep-copy (cdr sigcar) (*location*))
57 (define-public (argument-error n pred arg)
60 (_ "wrong type for argument ~a. Expecting ~a, found ~s")
61 n (type-name pred) (music->make-music arg))
64 ;; Used for chaining several music functions together. `final'
65 ;; contains the last argument and still needs typechecking.
66 (define (music-function-chain call final)
67 (let* ((fun (car call))
68 (siglast (last (ly:music-function-signature fun)))
69 (pred? (if (pair? siglast) (car siglast) siglast)))
71 (music-function fun (cons final (cdr call)))
73 (argument-error (length call) pred? final)
74 ;; call music function just for the error return value
75 (music-function fun #f)))))
77 (define-public (partial-music-function call-list)
78 (let* ((good (every list? call-list))
79 (sig (ly:music-function-signature (caar call-list))))
81 (ly:make-music-function
82 (cons (car sig) (list-tail sig (length (car call-list))))
84 ;; Every time we use music-function, it destructively
85 ;; reverses its list of arguments. Changing the calling
86 ;; convention would be non-trivial since we do error
87 ;; propagation to the reversed argument list by making it
88 ;; a non-proper list. So we just create a fresh copy of
89 ;; all argument lists for each call. We also want to
90 ;; avoid reusing any music expressions without copying and
91 ;; want to let them point to the location of the music
92 ;; function call rather than its definition.
93 (let ((call-list (ly:music-deep-copy call-list (*location*))))
94 (fold music-function-chain
95 (music-function (caar call-list)
96 (reverse! rest (cdar call-list)))
97 (cdr call-list))))))))
99 (define-public (void-music)
100 (ly:set-origin! (make-music 'Music)))
102 (define-public (sequential-music mlist)
103 (ly:set-origin! (make-sequential-music mlist)))
105 (define-public (simultaneous-music mlist)
106 (ly:set-origin! (make-simultaneous-music mlist)))
108 (define-public (event-chord mlist)
109 (ly:set-origin! (make-music 'EventChord
112 (define-public (unrelativable-music mus)
113 (ly:set-origin! (make-music 'UnrelativableMusic
116 (define-public (context-change type id)
117 (ly:set-origin! (make-music 'ContextChange
121 (define-public (tempo text . rest)
122 (let* ((unit (and (pair? rest)
126 (range-tempo? (pair? count))
127 (tempo-change (ly:set-origin! (make-music 'TempoChangeEvent
130 'metronome-count count)))
134 (make-property-set 'tempoWholesPerMinute
138 (round (/ (+ (car count) (cdr count))
142 (ly:duration-length unit)))
146 (make-sequential-music (list tempo-change tempo-set))
149 (define-public (repeat type num body alts)
150 (ly:set-origin! (make-repeat type num body alts)))
152 (define (script-to-mmrest-text music)
153 "Extract @code{'direction} and @code{'text} from @var{music}, and transform
154 into a @code{MultiMeasureTextEvent}."
156 (if (music-is-of-type? music 'script-event)
157 (make-music 'MultiMeasureTextEvent music)
160 (define-public (multi-measure-rest duration articulations)
161 (ly:set-origin! (make-music 'MultiMeasureRestMusic
162 'articulations (map script-to-mmrest-text articulations)
163 'duration duration)))
165 (define-public (repetition-chord duration articulations)
166 (ly:set-origin! (make-music 'EventChord
168 'elements articulations)))
170 (define-public (context-specification type id ops create-new mus)
171 (let ((csm (context-spec-music mus type id)))
172 (set! (ly:music-property csm 'property-operations) ops)
173 (if create-new (set! (ly:music-property csm 'create-new) #t))
174 (ly:set-origin! csm)))
176 (define-public (composed-markup-list commands markups)
177 ;; `markups' being a list of markups, eg (markup1 markup2 markup3),
178 ;; and `commands' a list of commands with their scheme arguments, in reverse order,
179 ;; eg: ((italic) (raise 4) (bold)), maps the commands on each markup argument, eg:
180 ;; ((bold (raise 4 (italic markup1)))
181 ;; (bold (raise 4 (italic markup2)))
182 ;; (bold (raise 4 (italic markup3))))
184 (define (compose arg)
186 (lambda (cmd prev) (append cmd (list prev)))
189 (let loop ((markups markups) (completed '()))
190 (cond ((null? markups) (reverse! completed))
191 ((markup? (car markups))
193 (cons (compose (car markups)) completed)))
196 (lambda () (break! markup? markups))
197 (lambda (complex rest)
200 (make-map-markup-commands-markup-list
201 compose complex) completed))))))))
203 (define-public (partial-markup commands)
204 ;; Like composed-markup-list, except that the result is a single
205 ;; markup command that can be applied to one markup
206 (define (compose arg)
208 (lambda (cmd prev) (append cmd (list prev)))
211 (let ((chain (lambda (layout props arg)
212 (interpret-markup layout props (compose arg)))))
213 (set-object-property! chain 'markup-signature (list markup?))
216 (define-public (property-set context property value)
217 (ly:set-origin! (context-spec-music
219 (make-music 'PropertySet
224 (define-public (property-unset context property)
225 (ly:set-origin! (context-spec-music
227 (make-music 'PropertyUnset
231 (define-public (property-override context path value)
232 (ly:set-origin! (context-spec-music
234 (make-music 'OverrideProperty
236 'grob-property-path (cdr path)
241 (define-public (property-revert context path)
242 (ly:set-origin! (context-spec-music
244 (make-music 'RevertProperty
246 'grob-property-path (cdr path)))
249 ;; The signature here is slightly fishy since the "fallback return
250 ;; value" is not actually music but #f. This used to be (void-music)
251 ;; but triggered "Parsed object should be dead" warnings for music
252 ;; objects outside of the current parser session/module. The called
253 ;; functions always deliver music and are used from the parser in a
254 ;; manner where only the last argument is provided from outside the
255 ;; parser, and its predicate "scheme?" is always true. So the
256 ;; fallback value will never get used and its improper type is no
258 (define-public property-override-function
259 (ly:make-music-function
260 (list (cons ly:music? #f) symbol? symbol-list? scheme?)
263 (define-public property-set-function
264 (ly:make-music-function
265 (list (cons ly:music? #f) symbol? symbol? scheme?)
268 (define (get-first-context-id! mus)
269 "Find the name of a ContextSpeccedMusic, possibly naming it"
270 (let ((id (ly:music-property mus 'context-id)))
271 (if (eq? (ly:music-property mus 'name) 'ContextSpeccedMusic)
272 (if (and (string? id)
273 (not (string-null? id)))
275 ;; We may reliably give a new context a unique name, but
276 ;; not an existing one
277 (if (ly:music-property mus 'create-new #f)
278 (let ((id (get-next-unique-voice-name)))
279 (set! (ly:music-property mus 'context-id) id)
284 (define-public (lyric-event text duration)
285 (ly:set-origin! (make-lyric-event text duration)))
287 (define-public (lyric-combine sync sync-type music)
288 ;; CompletizeExtenderEvent is added following the last lyric in MUSIC
289 ;; to signal to the Extender_engraver that any pending extender should
290 ;; be completed if the lyrics end before the associated voice.
291 (append! (ly:music-property music 'elements)
292 (list (make-music 'CompletizeExtenderEvent)))
294 (make-music 'LyricCombineMusic
296 'associated-context sync
297 'associated-context-type sync-type)))
299 (define-public (add-lyrics music addlyrics-list)
300 (let* ((existing-voice-name (get-first-context-id! music))
301 (voice-name (if (string? existing-voice-name)
303 (get-next-unique-voice-name)))
304 (voice (if (string? existing-voice-name)
306 (make-music 'ContextSpeccedMusic
309 'context-id voice-name
310 'origin (ly:music-property music 'origin))))
311 (voice-type (ly:music-property voice 'context-type))
315 (ly:music-property (car mus+mods) 'origin)
316 (ly:set-origin! (make-music 'ContextSpeccedMusic
318 'context-type 'Lyrics
319 'property-operations (cdr mus+mods)
322 voice-name voice-type
325 (make-simultaneous-music (cons voice lyricstos))))