1 %%%% -*- Mode: Scheme -*-
3 %%%% This file is part of LilyPond, the GNU music typesetter.
5 %%%% Copyright (C) 2003--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 %%%% Jan Nieuwenhuizen <janneke@gnu.org>
8 %%%% LilyPond is free software: you can redistribute it and/or modify
9 %%%% it under the terms of the GNU General Public License as published by
10 %%%% the Free Software Foundation, either version 3 of the License, or
11 %%%% (at your option) any later version.
13 %%%% LilyPond is distributed in the hope that it will be useful,
14 %%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
15 %%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 %%%% GNU General Public License for more details.
18 %%%% You should have received a copy of the GNU General Public License
19 %%%% along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
24 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25 %% this file is alphabetically sorted.
26 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28 %% need SRFI-1 for filter; optargs for lambda*
29 #(use-modules (srfi srfi-1)
32 %% TODO: using define-music-function in a .scm causes crash.
35 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
36 (_i "Create an acciaccatura from the following music expression"))
38 %% keep these two together
39 "instrument-definitions" = #'()
40 addInstrumentDefinition =
41 #(define-void-function
42 (parser location name lst) (string? list?)
43 (_i "Create instrument @var{name} with properties @var{list}.")
44 (set! instrument-definitions (acons name lst instrument-definitions)))
47 #(define-void-function (parser location name music) (string? ly:music?)
48 (_i "Define @var{music} as a quotable music expression named
50 (add-quotable parser name music))
52 %% keep these two together
53 afterGraceFraction = #(cons 6 8)
55 #(define-music-function (parser location main grace) (ly:music? ly:music?)
56 (_i "Create @var{grace} note(s) after a @var{main} music expression.")
57 (let ((main-length (ly:music-length main))
58 (fraction (ly:parser-lookup parser 'afterGraceFraction)))
59 (make-simultaneous-music
62 (make-sequential-music
65 (make-music 'SkipMusic
66 'duration (ly:make-duration
68 (* (ly:moment-main-numerator main-length)
70 (* (ly:moment-main-denominator main-length)
72 (make-music 'GraceMusic
76 %% music identifiers not allowed at top-level,
77 %% so this is a music-function instead.
79 #(define-music-function (location parser) ()
80 (_i "Allow a page turn. May be used at toplevel (ie between scores or
81 markups), or inside a score.")
82 (make-music 'EventChord
84 'page-turn-permission 'allow
85 'elements (list (make-music 'PageTurnEvent
86 'break-permission 'allow))))
89 #(define-music-function (parser location tag more music)
90 (symbol? ly:music? ly:music?)
91 (_i "Append @var{more} to the @code{elements} of all music
92 expressions in @var{music} that are tagged with @var{tag}.")
93 (music-map (lambda (m)
94 (if (memq tag (ly:music-property m 'tags))
95 (set! (ly:music-property m 'elements)
96 (append (ly:music-property m 'elements)
102 #(define-music-function (parser location proc) (procedure?)
103 (_i "Modify context properties with Scheme procedure @var{proc}.")
104 (make-music 'ApplyContext
108 #(define-music-function (parser location func music) (procedure? ly:music?)
109 (_i"Apply procedure @var{func} to @var{music}.")
113 #(define-music-function (parser location ctx proc) (symbol? procedure?)
114 (_i "Apply function @code{proc} to every layout object in context @code{ctx}")
115 (make-music 'ApplyOutputEvent
120 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
121 (_i "Create an appoggiatura from @var{music}"))
123 % for regression testing purposes.
125 #(define-music-function (parser location l r) (pair? pair?)
126 (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
127 (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
129 % for regression testing purposes.
131 #(define-music-function (parser location comp) (procedure?)
132 (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
133 (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
136 #(define-music-function (parser location music) (ly:music?)
137 (_i "Make voices that switch between staves automatically")
138 (make-autochange-music parser music))
143 #(define-music-function (parser location grob-name offset text)
144 (symbol? number-pair? markup?)
145 (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
146 (use like @code{\\once})")
147 (make-music 'AnnotateOutputEvent
149 'X-offset (car offset)
150 'Y-offset (cdr offset)
154 #(define-music-function (parser location offset text) (number-pair? markup?)
155 (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
156 (make-music 'AnnotateOutputEvent
157 'X-offset (car offset)
158 'Y-offset (cdr offset)
162 #(define-music-function (parser location type) (string?)
163 (_i "Insert a bar line of type @var{type}")
165 (make-property-set 'whichBar type)
169 #(define-music-function (parser location n) (integer?)
170 (_i "Print a warning if the current bar number is not @var{n}.")
171 (make-music 'ApplyContext
174 (let ((cbn (ly:context-property c 'currentBarNumber)))
175 (if (and (number? cbn) (not (= cbn n)))
176 (ly:input-warning location
177 "Barcheck failed got ~a expect ~a"
181 #(define-event-function (parser location delta) (real?)
182 (_i "Create a fall or doit of pitch interval @var{delta}.")
183 (make-music 'BendAfterEvent
187 #(define-void-function (parser location newfilename) (string?)
188 (_i "Direct output for the current book block to @var{newfilename}.")
189 (set! (paper-variable parser #f 'output-filename) newfilename))
192 #(define-void-function (parser location newsuffix) (string?)
193 (_i "Set the output filename suffix for the current book block to
195 (set! (paper-variable parser #f 'output-suffix) newsuffix))
197 %% \breathe is defined as a music function rather than an event identifier to
198 %% ensure it gets useful input location information: as an event identifier,
199 %% it would have to be wrapped in an EventChord to prevent it from being
200 %% treated as a post_event by the parser
202 #(define-music-function (parser location) ()
203 (_i "Insert a breath mark.")
204 (make-music 'BreathingEvent))
207 #(define-music-function (parser location type) (string?)
208 (_i "Set the current clef to @var{type}.")
209 (make-clef-set type))
213 #(define-music-function (parser location args) (pair?)
214 (_i "Create compound time signatures. The argument is a Scheme list of
215 lists. Each list describes one fraction, with the last entry being the
216 denominator, while the first entries describe the summands in the
217 enumerator. If the time signature consists of just one fraction,
218 the list can be given directly, i.e. not as a list containing a single list.
219 For example, a time signature of (3+1)/8 + 2/4 would be created as
220 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
221 as @code{\\compoundMeter #'((3 2 8))} or shorter
222 @code{\\compoundMeter #'(3 2 8)}.")
223 (let* ((mlen (calculate-compound-measure-length args))
224 (beat (calculate-compound-base-beat args))
225 (beatGrouping (calculate-compound-beat-grouping args))
226 (timesig (cons (ly:moment-main-numerator mlen)
227 (ly:moment-main-denominator mlen))))
229 \once \override Staff.TimeSignature #'stencil = #(lambda (grob)
230 (grob-interpret-markup grob (format-compound-time args)))
231 \set Timing.timeSignatureFraction = $timesig
232 \set Timing.baseMoment = $beat
233 \set Timing.beatStructure = $beatGrouping
234 \set Timing.beamExceptions = #'()
235 \set Timing.measureLength = $mlen
240 #(define-music-function (parser location type) (string?)
241 (_i "Set the current cue clef to @var{type}.")
242 (make-cue-clef-set type))
244 #(define-music-function (parser location) ()
245 (_i "Unset the current cue clef.")
246 (make-cue-clef-unset))
249 #(define-music-function
250 (parser location what dir main-music) (string? ly:dir? ly:music?)
251 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
252 in a CueVoice oriented by @var{dir}.")
253 (make-music 'QuoteMusic
255 'quoted-context-type 'Voice
256 'quoted-context-id "cue"
257 'quoted-music-name what
258 'quoted-voice-direction dir))
261 #(define-music-function
262 (parser location what dir clef main-music) (string? ly:dir? string? ly:music?)
263 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
264 in a CueVoice oriented by @var{dir}.")
265 (make-music 'QuoteMusic
267 'quoted-context-type 'Voice
268 'quoted-context-id "cue"
269 'quoted-music-name what
270 'quoted-music-clef clef
271 'quoted-voice-direction dir))
276 #(define-music-function (parser location music) (ly:music?)
277 (_i "Display the LilyPond input representation of @var{music}
280 (display-lily-music music parser)
284 #(define-music-function (parser location music) (ly:music?)
285 (_i "Display the internal representation of @var{music} to the console.")
287 (display-scheme-music music)
293 #(define-music-function (parser location music) (ly:music?)
294 (_i "Terminate the next spanner prematurely after exactly one note
295 without the need of a specific end spanner.")
296 (if (memq (ly:music-property music 'name) '(EventChord NoteEvent))
297 (let* ((start-span-evs (filter (lambda (ev)
298 (equal? (ly:music-property ev 'span-direction)
300 (extract-typed-music music 'span-event)))
303 (let ((c (music-clone m)))
304 (set! (ly:music-property c 'span-direction) STOP)
307 (end-ev-chord (make-music 'EventChord
308 'elements stop-span-evs))
309 (total (make-music 'SequentialMusic
310 'elements (list music
315 (ly:input-message location (_ "argument endSpanners is not an EventChord: ~a") music)
319 #(define-music-function (parser location music) (ly:music?)
320 (_i "Compatibility function wrapping @code{EventChord} around
321 isolated rhythmic events occuring since version 2.15.28, after
322 expanding repeat chords @samp{q}.")
323 (event-chord-wrap! music parser))
326 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
327 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
328 (let ((orig-duration (ly:music-length argument))
329 (multiplier (ly:make-moment 1 1)))
333 (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
335 (ly:music-compress mus multiplier)
336 (set! multiplier (ly:moment-mul factor multiplier)))))
337 (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
340 (ly:moment-div orig-duration (ly:music-length argument)))
345 #(define-music-function (parser location mark offset grob-name footnote music)
346 ((markup?) number-pair? (symbol?) markup? (ly:music?))
347 (_i "Make the markup @var{footnote} a footnote on @var{music}. The
348 footnote is marked with a markup @var{mark} moved by @var{offset} with
349 respect to the marked music.
351 If @var{mark} is not given or specified as @var{\\default}, it is
352 replaced by an automatically generated sequence number. If a symbol
353 @var{grob-name} is specified, then grobs of that type will be marked
354 if they have @var{music} as their ultimate cause; by default all grobs
355 having @var{music} as their @emph{direct} cause will be marked,
356 similar to the way @code{\\tweak} works.
358 If @var{music} is given as @code{\\default}, a footnote event
359 affecting @emph{all} grobs matching @var{grob-name} at a given time
360 step is generated. This may be required for creating footnotes on
361 time signatures, clefs, and other items not cooperating with
364 Like with @code{\\tweak}, if you use a footnote on a following
365 post-event, the @code{\\footnote} command itself needs to be attached
366 to the preceding note or rest as a post-event with @code{-}.")
367 (let ((mus (make-music
369 'X-offset (car offset)
370 'Y-offset (cdr offset)
371 'automatically-numbered (not mark)
372 'text (or mark (make-null-markup))
373 'footnote-text footnote
374 'symbol (or grob-name '()))))
377 (set! (ly:music-property music 'tweaks)
379 (cons grob-name 'footnote-music)
382 (ly:music-property music 'tweaks)))
387 #(def-grace-function startGraceMusic stopGraceMusic
388 (_i "Insert @var{music} as grace notes."))
391 #(define-scheme-function (parser location descriptions) (list?)
392 (_i "Create a context modification from @var{descriptions}, a list
393 in the format of @code{all-grob-descriptions}.")
396 (list 'assign (car p) (list (cdr p))))
399 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
400 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
401 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
403 \set harmonicDots = ##t
404 \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
405 \override NoteHead #'Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height
406 (lambda (grob start end)
407 (ly:grob::stencil-height grob)))
408 \override NoteHead #'stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
409 (ly:note-head::print grob))
411 (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
413 \revert TabNoteHead #'stencil
414 \revert NoteHead #'Y-extent
415 \revert NoteHead #'stencil
418 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
419 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
420 harmonics played on a fretted instrument by touching the strings at the point
421 given through @var{ratio}.")
423 \set harmonicDots = ##t
424 \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
425 \override NoteHead #'Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height
426 (lambda (grob start end)
427 (ly:grob::stencil-height grob)))
428 \override NoteHead #'stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
429 (ly:note-head::print grob))
431 (calc-harmonic-pitch (ratio->pitch ratio) music))
433 \revert TabNoteHead #'stencil
434 \revert NoteHead #'Y-extent
435 \revert NoteHead #'stencil
439 #(define-music-function
440 (parser location name) (string?)
441 (_i "Switch instrument to @var{name}, which must be predefined with
442 @code{\\addInstrumentDefinition}.")
443 (let* ((handle (assoc name instrument-definitions))
444 (instrument-def (if handle (cdr handle) '())))
447 (ly:input-warning location "No such instrument: ~a" name))
449 (make-music 'SimultaneousMusic
461 #(define-music-function (parser location tag music) (symbol? ly:music?)
462 (_i "Include only elements of @var{music} that are tagged with @var{tag}.")
465 (let* ((tags (ly:music-property m 'tags))
466 (res (memq tag tags)))
473 #(define-music-function (parser location tonic pitch-alist)
474 ((ly:pitch? '()) (list? '()))
475 (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
476 If both are null, just generate @code{KeyChangeEvent}.")
477 (cond ((null? tonic) (make-music 'KeyChangeEvent))
479 (ly:parser-error parser (_ "second argument must be pitch list")
481 (make-music 'SequentialMusic 'void #t))
484 (make-music 'KeyChangeEvent
485 'tonic (ly:make-pitch 0 0 0)
486 'pitch-alist pitch-alist)
490 #(define-music-function (parser location music) (ly:music?)
491 (_i "Remove cue notes from @var{music}.")
494 (if (and (string? (ly:music-property mus 'quoted-music-name))
495 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
496 (ly:music-property mus 'element)
503 #(define-music-function (parser location label) (symbol?)
504 (_i "Create @var{label} as a bookmarking label.")
505 (make-music 'EventChord
508 'elements (list (make-music 'LabelEvent
509 'page-label label))))
513 #(define-void-function (parser location language) (string?)
514 (_i "Set note names for language @var{language}.")
515 (note-names-language parser language))
517 languageSaveAndChange =
518 #(define-void-function (parser location language) (string?)
519 (_i "Store the previous pitchnames alist, and set a new one.")
520 (set! previous-pitchnames pitchnames)
521 (note-names-language parser language))
524 #(define-void-function (parser location) ()
525 (_i "Restore a previously-saved pitchnames alist.")
526 (if previous-pitchnames
528 (set! pitchnames previous-pitchnames)
529 (ly:parser-set-note-names parser pitchnames))
530 (ly:input-warning location (_ "No other language was defined previously. Ignoring."))))
534 #(define-music-function (parser location arg) (ly:music?)
535 (_i "Display chords in @var{arg} as clusters.")
536 (music-map note-to-cluster arg))
539 #(define-music-function (parser location around to scale music)
540 (ly:pitch? ly:pitch? ly:music? ly:music?)
541 (_i "Invert @var{music} about @var{around} using @var{scale} and
542 transpose from @var{around} to @var{to}.")
543 (let ((inverter (make-modal-inverter around to scale)))
544 (change-pitches music inverter)
548 #(define-music-function (parser location from to scale music)
549 (ly:pitch? ly:pitch? ly:music? ly:music?)
550 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
552 (let ((transposer (make-modal-transposer from to scale)))
553 (change-pitches music transposer)
557 #(define-music-function
558 (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
559 (_i "Invert @var{music} about @var{around} and
560 transpose from @var{around} to @var{to}.")
561 (music-invert around to music))
564 #(define-music-function
565 (parser location label) ((scheme? '()))
566 "Make the music for the \\mark command."
567 (let* ((set (and (integer? label)
568 (context-spec-music (make-property-set 'rehearsalMark label)
570 (ev (make-music 'MarkEvent
574 (make-sequential-music (list set ev))
576 (set! (ly:music-property ev 'label) label)
580 #(define-music-function (parser location proc mus) (procedure? ly:music?)
581 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
582 (music-map proc mus))
584 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
585 %% because music identifiers are not allowed at top-level.
587 #(define-music-function (location parser) ()
588 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
589 markups), or inside a score.")
590 (make-music 'EventChord
592 'page-break-permission 'forbid
593 'elements (list (make-music 'PageBreakEvent
594 'break-permission '()))))
597 #(define-music-function (location parser) ()
598 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
599 markups), or inside a score.")
600 (make-music 'EventChord
602 'page-turn-permission 'forbid
603 'elements (list (make-music 'PageTurnEvent
604 'break-permission '()))))
609 #(define-music-function (parser location pitch) (ly:pitch?)
611 (make-music 'RelativeOctaveCheck
615 #(define-music-function (parser location music) (ly:music?)
616 (_i "Set @code{once} to @code{#t} on all layout instruction events in @var{music}.")
619 (cond ((music-is-of-type? m 'layout-instruction-event)
620 (set! (ly:music-property m 'once) #t))
621 ((ly:duration? (ly:music-property m 'duration))
622 (ly:music-warning m (_ "Cannot apply \\once to timed music"))))
627 #(define-music-function (parser location octave) (integer?)
628 (_i "Set the octavation.")
629 (make-music 'OttavaMusic
630 'ottava-number octave))
632 overrideTimeSignatureSettings =
633 #(define-music-function
634 (parser location time-signature base-moment beat-structure beam-exceptions)
635 (pair? pair? cheap-list? cheap-list?)
637 (_i "Override @code{timeSignatureSettings}
638 for time signatures of @var{time-signature} to have settings
639 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
641 ;; TODO -- add warning if largest value of grouping is
642 ;; greater than time-signature.
643 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
644 (override-time-signature-setting time-signature setting)))
647 #(define-music-function (parser location name property value)
648 (string? symbol? scheme?)
650 (_i "Set @var{property} to @var{value} in all grobs named @var{name}.
651 The @var{name} argument is a string of the form @code{\"Context.GrobName\"}
652 or @code{\"GrobName\"}.")
654 (let ((name-components (string-split name #\.))
655 (context-name 'Bottom)
658 (if (> 2 (length name-components))
659 (set! grob-name (string->symbol (car name-components)))
661 (set! grob-name (string->symbol (list-ref name-components 1)))
662 (set! context-name (string->symbol (list-ref name-components 0)))))
664 (make-music 'ApplyOutputEvent
665 'context-type context-name
667 (lambda (grob orig-context context)
669 (cdr (assoc 'name (ly:grob-property grob 'meta)))
671 (set! (ly:grob-property grob property) value))))))
675 %% pageBreak and pageTurn are music functions (iso music indentifiers),
676 %% because music identifiers are not allowed at top-level.
678 #(define-music-function (location parser) ()
679 (_i "Force a page break. May be used at toplevel (i.e., between scores or
680 markups), or inside a score.")
681 (make-music 'EventChord
683 'line-break-permission 'force
684 'page-break-permission 'force
685 'elements (list (make-music 'LineBreakEvent
686 'break-permission 'force)
687 (make-music 'PageBreakEvent
688 'break-permission 'force))))
691 #(define-music-function (location parser) ()
692 (_i "Force a page turn between two scores or top-level markups.")
693 (make-music 'EventChord
695 'line-break-permission 'force
696 'page-break-permission 'force
697 'page-turn-permission 'force
698 'elements (list (make-music 'LineBreakEvent
699 'break-permission 'force)
700 (make-music 'PageBreakEvent
701 'break-permission 'force)
702 (make-music 'PageTurnEvent
703 'break-permission 'force))))
706 #(define-void-function (parser location voice-ids music) (list? ly:music?)
707 (_i "Define parallel music sequences, separated by '|' (bar check signs),
708 and assign them to the identifiers provided in @var{voice-ids}.
710 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
712 @var{music}: a music sequence, containing BarChecks as limiting expressions.
717 \\parallelMusic #'(A B C) {
727 (let* ((voices (apply circular-list (make-list (length voice-ids) (list))))
728 (current-voices voices)
729 (current-sequence (list))
734 (define (push-music m)
735 "Push the music expression into the current sequence"
736 (set! current-sequence (cons m current-sequence)))
737 (define (change-voice)
738 "Stores the previously built sequence into the current voice and
739 change to the following voice."
740 (list-set! current-voices 0 (cons (make-music 'SequentialMusic
741 'elements (reverse! current-sequence))
742 (car current-voices)))
743 (set! current-sequence (list))
744 (set! current-voices (cdr current-voices)))
745 (define (bar-check? m)
746 "Checks whether m is a bar check."
747 (eq? (ly:music-property m 'name) 'BarCheck))
748 (define (music-origin music)
749 "Recursively search an origin location stored in music."
750 (cond ((null? music) #f)
751 ((not (null? (ly:music-property music 'origin)))
752 (ly:music-property music 'origin))
753 (else (or (music-origin (ly:music-property music 'element))
754 (let ((origins (remove not (map music-origin
755 (ly:music-property music 'elements)))))
756 (and (not (null? origins)) (car origins)))))))
757 (while (music-is-of-type? music 'music-wrapper-music)
759 (set! music (ly:music-property wrapper 'element)))
761 (set! (ly:music-property wrapper 'element)
762 (make-music 'SequentialMusic
765 (make-music 'SequentialMusic
768 ;; first, split the music and fill in voices
769 ;; We flatten direct layers of SequentialMusic since they are
770 ;; pretty much impossible to avoid when writing music functions.
771 (let rec ((music music))
772 (for-each (lambda (m)
773 (if (eq? (ly:music-property m 'name) 'SequentialMusic)
777 (if (bar-check? m) (change-voice)))))
778 (ly:music-property music 'elements)))
779 (if (not (null? current-sequence)) (change-voice))
780 ;; un-circularize `voices' and reorder the voices
781 (set! voices (map-in-order (lambda (dummy seqs)
785 ;; set origin location of each sequence in each voice
786 ;; for better type error tracking
787 (for-each (lambda (voice)
788 (for-each (lambda (seq)
789 (set! (ly:music-property seq 'origin)
790 (or (music-origin seq) location)))
794 ;; check sequence length
795 (apply for-each (lambda* (#:rest seqs)
796 (let ((moment-reference (ly:music-length (car seqs))))
797 (for-each (lambda (seq moment)
798 (if (not (equal? moment moment-reference))
799 (ly:music-warning seq
800 "Bars in parallel music don't have the same length")))
801 seqs (map-in-order ly:music-length seqs))))
804 ;; bind voice identifiers to the voices
805 (for-each (lambda (voice-id voice)
806 (ly:parser-define! parser voice-id
807 (let ((v (ly:music-deep-copy original)))
808 (set! (ly:music-property
809 (car (extract-named-music
816 #(define-music-function (parser loc arg) (ly:music?)
817 (_i "Tag @var{arg} to be parenthesized.")
819 (if (memq 'event-chord (ly:music-property arg 'types))
820 ;; arg is an EventChord -> set the parenthesize property
821 ;; on all child notes and rests
824 (if (or (memq 'note-event (ly:music-property ev 'types))
825 (memq 'rest-event (ly:music-property ev 'types)))
826 (set! (ly:music-property ev 'parenthesize) #t)))
827 (ly:music-property arg 'elements))
828 ;; No chord, simply set property for this expression:
829 (set! (ly:music-property arg 'parenthesize) #t))
833 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
834 (_i "Take the music in @var{part1} and @var{part2} and typeset so
835 that they share a staff.")
836 (make-part-combine-music parser
837 (list part1 part2) #f))
840 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
841 (_i "Take the music in @var{part1} and @var{part2} and typeset so
842 that they share a staff with stems directed upward.")
843 (make-part-combine-music parser
844 (list part1 part2) UP))
847 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
848 (_i "Take the music in @var{part1} and @var{part2} and typeset so
849 that they share a staff with stems directed downward.")
850 (make-part-combine-music parser
851 (list part1 part2) DOWN))
854 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
855 (_i "Override the part-combiner.")
856 (make-music 'EventChord
857 'elements (list (make-music 'PartCombineForceEvent
860 partcombineApart = \partcombineForce #'apart ##f
861 partcombineApartOnce = \partcombineForce #'apart ##t
862 partcombineChords = \partcombineForce #'chords ##f
863 partcombineChordsOnce = \partcombineForce #'chords ##t
864 partcombineUnisono = \partcombineForce #'unisono ##f
865 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
866 partcombineSoloI = \partcombineForce #'solo1 ##f
867 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
868 partcombineSoloII = \partcombineForce #'solo2 ##f
869 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
870 partcombineAutomatic = \partcombineForce ##f ##f
871 partcombineAutomaticOnce = \partcombineForce ##f ##t
874 #(define-music-function (parser location dur) (ly:duration?)
875 (_i "Make a partial measure.")
877 ;; We use `descend-to-context' here instead of `context-spec-music' to
878 ;; ensure \partial still works if the Timing_translator is moved
880 (context-spec-music (make-music 'PartialSet
882 'partial-duration dur)
887 #(define-music-function
888 (parser location main-note secondary-note)
889 (ly:music? ly:music?)
890 (_i "Print a trill with @var{main-note} as the main note of the trill and
891 print @var{secondary-note} as a stemless note head in parentheses.")
892 (let* ((get-notes (lambda (ev-chord)
893 (extract-named-music ev-chord 'NoteEvent)))
894 (sec-note-events (get-notes secondary-note))
895 (trill-events (extract-named-music main-note 'TrillSpanEvent)))
896 (if (pair? sec-note-events)
898 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
899 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
901 (if (ly:pitch? trill-pitch)
902 (for-each (lambda (m)
903 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
905 (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
906 (display sec-note-events)))
909 (for-each (lambda (m)
910 (ly:music-set-property! m 'force-accidental forced))
915 #(define-music-function (parser location tag more music)
916 (symbol? ly:music? ly:music?)
917 (_i "Add @var{more} to the front of @code{elements} of all music
918 expressions in @var{music} that are tagged with @var{tag}.")
919 (music-map (lambda (m)
920 (if (memq tag (ly:music-property m 'tags))
921 (set! (ly:music-property m 'elements)
922 (cons more (ly:music-property m 'elements))))
927 #(define-music-function (parser location what main-music) (string? ly:music?)
928 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
929 of the quoted voice, as specified in an @code{\\addQuote} command.
930 @var{main-music} is used to indicate the length of music to be quoted;
931 usually contains spacers or multi-measure rests.")
932 (make-music 'QuoteMusic
934 'quoted-music-name what))
937 #(define-music-function (parser location pitch music)
938 ((ly:pitch? (ly:make-pitch 0 0 0)) ly:music?)
939 (_i "Make @var{music} relative to @var{pitch} (default @code{c'}).")
940 (ly:make-music-relative! music pitch)
941 (make-music 'RelativeOctaveMusic
945 #(define-music-function (parser location tag music) (symbol? ly:music?)
946 (_i "Remove elements of @var{music} that are tagged with @var{tag}.")
949 (let* ((tags (ly:music-property m 'tags))
950 (res (memq tag tags)))
954 resetRelativeOctave =
955 #(define-music-function (parser location pitch) (ly:pitch?)
956 (_i "Set the octave inside a \\relative section.")
958 (make-music 'SequentialMusic
959 'to-relative-callback
960 (lambda (music last-pitch) pitch)))
963 #(define-music-function (parser location music)
965 (_i "Return @var{music} in reverse order.")
966 (retrograde-music music))
968 revertTimeSignatureSettings =
969 #(define-music-function
970 (parser location time-signature)
973 (_i "Revert @code{timeSignatureSettings}
974 for time signatures of @var{time-signature}.")
975 (revert-time-signature-setting time-signature))
978 #(define-event-function (parser location finger) (number-or-string?)
979 (_i "Apply @var{finger} as a fingering indication.")
984 (if (string? finger) 'text 'digit)
988 #(define-music-function (parser location fraction music)
989 (fraction? ly:music?)
990 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
991 (ly:music-compress music
992 (ly:make-moment (car fraction) (cdr fraction))))
995 #(define-scheme-function (parser location ctx music)
996 ((symbol?) ly:music?)
997 (_i "Take the layout instruction events from @var{music}, optionally
998 restricted to those applying to context type @var{ctx}, and return
999 a context modification duplicating their effect.")
1000 (let ((mods (ly:make-context-mod)))
1002 (if (music-is-of-type? m 'layout-instruction-event)
1005 (case (ly:music-property m 'name)
1008 (ly:music-property m 'symbol)
1009 (ly:music-property m 'value)))
1012 (ly:music-property m 'symbol)))
1015 (ly:music-property m 'symbol)
1016 (ly:music-property m 'grob-value)
1017 (ly:music-property m 'grob-property-path)))
1020 (ly:music-property m 'symbol)
1021 (ly:music-property m 'grob-property-path)))))
1022 (case (ly:music-property m 'name)
1024 (ly:add-context-mod mods
1026 (ly:music-property m 'procedure))))
1027 ((ContextSpeccedMusic)
1029 (eq? ctx (ly:music-property m 'context-type)))
1030 (musicop (ly:music-property m 'element))))
1032 (let ((callback (ly:music-property m 'elements-callback)))
1033 (if (procedure? callback)
1034 (for-each musicop (callback m))))))))
1039 #(define-music-function (parser location grob offsets)
1041 (_i "Offset control-points of @var{grob} by @var{offsets}. The argument
1042 is a list of number pairs or list of such lists. Each element of a pair
1043 represents an offset to one of the coordinates of a control-point.")
1044 (define ((shape-curve offsets) grob)
1045 (let* ((orig (ly:grob-original grob))
1046 (siblings (if (ly:spanner? grob)
1047 (ly:spanner-broken-into orig) '()))
1048 (total-found (length siblings))
1049 (function (assoc-get 'control-points
1050 (reverse (ly:grob-basic-properties grob))))
1051 (coords (function grob)))
1053 (define (offset-control-points offsets)
1057 (lambda (x y) (coord-translate x y))
1060 (define (helper sibs offs)
1062 (if (eq? (car sibs) grob)
1063 (offset-control-points (car offs))
1064 (helper (cdr sibs) (cdr offs)))
1067 ;; we work with lists of lists
1068 (if (or (null? offsets)
1069 (not (list? (car offsets))))
1070 (set! offsets (list offsets)))
1072 (if (>= total-found 2)
1073 (helper siblings offsets)
1074 (offset-control-points (car offsets)))))
1077 \once \override $grob #'control-points = #(shape-curve offsets)
1081 #(define-music-function (parser location dur dots arg)
1082 (integer? integer? ly:music?)
1083 (_i "Change the duration of @var{arg} by adding @var{dur} to the
1084 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1088 (shift-one-duration-log x dur dots)) arg))
1091 #(define-music-function (parser location dur) (ly:duration?)
1092 (_i "Skip forward by @var{dur}.")
1093 (make-music 'SkipMusic
1098 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1099 (_i "Create slashed graces (slashes through stems, but no slur) from
1100 the following music expression"))
1103 #(define-music-function (parser location parameters) (list?)
1104 (_i "Set the system stretch, by reading the 'system-stretch property of
1105 the `parameters' assoc list.")
1107 \overrideProperty #"Score.NonMusicalPaperColumn"
1108 #'line-break-system-details
1109 #(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1110 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
1114 #(define-music-function (parser location style heads music)
1115 (symbol? list-or-symbol? ly:music?)
1116 (_i "Set @var{heads} in @var{music} to @var{style}.")
1117 (style-note-heads heads style music))
1120 #(define-music-function (parser location tag arg) (symbol? ly:music?)
1122 (_i "Add @var{tag} to the @code{tags} property of @var{arg}.")
1125 (ly:music-property arg 'tags)
1127 (ly:music-property arg 'tags)))
1131 #(define-music-function (parser location beat-structure fraction)
1132 ((number-list? '()) fraction?)
1133 (_i "Set @var{fraction} as time signature, with optional
1134 number list @var{beat-structure} before it.")
1135 (make-music 'TimeSignatureMusic
1136 'numerator (car fraction)
1137 'denominator (cdr fraction)
1138 'beat-structure beat-structure))
1141 #(define-music-function (parser location fraction music)
1142 (fraction? ly:music?)
1143 (_i "Scale @var{music} in time by @var{fraction}.")
1144 (make-music 'TimeScaledMusic
1145 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1146 'numerator (car fraction)
1147 'denominator (cdr fraction)))
1150 #(define-music-function
1151 (parser location from to music)
1152 (ly:pitch? ly:pitch? ly:music?)
1154 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1155 (make-music 'TransposedMusic
1156 'element (ly:music-transpose music (ly:pitch-diff to from))))
1158 transposedCueDuring =
1159 #(define-music-function
1160 (parser location what dir pitch main-music)
1161 (string? ly:dir? ly:pitch? ly:music?)
1163 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1164 using the transposition defined by @var{pitch}. This happens
1165 simultaneously with @var{main-music}, which is usually a rest. The
1166 argument @var{dir} determines whether the cue notes should be notated
1167 as a first or second voice.")
1169 (make-music 'QuoteMusic
1171 'quoted-context-type 'Voice
1172 'quoted-context-id "cue"
1173 'quoted-music-name what
1174 'quoted-voice-direction dir
1175 'quoted-transposition pitch))
1178 #(define-music-function (parser location pitch) (ly:pitch?)
1179 (_i "Set instrument transposition")
1182 (make-property-set 'instrumentTransposition
1183 (ly:pitch-negate pitch))
1187 #(define-music-function (parser location grob prop value music)
1188 ((string?) symbol? scheme? ly:music?)
1189 (_i "Add a tweak to the following @var{music}.
1190 Layout objects created by @var{music} get their property @var{prop}
1191 set to @var{value}. If @var{grob} is specified, like with
1193 \\tweak Accidental #'color #red cis'
1195 an indirectly created grob (@samp{Accidental} is caused by
1196 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1198 (if (not (object-property prop 'backend-type?))
1200 (ly:input-warning location (_ "cannot find property type-check for ~a") prop)
1201 (ly:warning (_ "doing assignment anyway"))))
1203 (ly:music-property music 'tweaks)
1204 (acons (if grob (cons (string->symbol grob) prop) prop)
1206 (ly:music-property music 'tweaks)))
1210 #(define-music-function (parser location music) (ly:music?)
1211 (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1212 @code{\\repeat percent} commands in @var{music} to be interpreted
1213 as @code{\\repeat unfold}.")
1214 (unfold-repeats music))
1217 #(define-void-function (parser location arg) (scheme?)
1218 (_i "Accept a scheme argument, return a void expression.
1219 Use this if you want to have a scheme expression evaluated
1220 because of its side-effects, but its value ignored."))
1223 #(define-music-function (parser location sym val music)
1224 (symbol? scheme? ly:music?)
1225 (_i "Set @var{sym} to @var{val} in @var{music}.")
1227 (set! (ly:music-property music sym) val)