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 #(define-music-function (parser location music)
37 (_i "Make @var{music} absolute. This does not actually change the
38 music itself but rather hides it from surrounding @code{\\relative}
40 (make-music 'RelativeOctaveMusic 'element music))
43 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
44 (_i "Create an acciaccatura from the following music expression"))
46 %% keep these two together
47 instrument-definitions = #'()
48 addInstrumentDefinition =
49 #(define-void-function
50 (parser location name lst) (string? list?)
51 (_i "Create instrument @var{name} with properties @var{list}.")
52 (set! instrument-definitions (acons name lst instrument-definitions)))
55 #(define-void-function (parser location name music) (string? ly:music?)
56 (_i "Define @var{music} as a quotable music expression named
58 (add-quotable parser name music))
60 %% keep these two together
61 afterGraceFraction = #(cons 6 8)
63 #(define-music-function (parser location main grace) (ly:music? ly:music?)
64 (_i "Create @var{grace} note(s) after a @var{main} music expression.")
65 (let ((main-length (ly:music-length main))
66 (fraction (ly:parser-lookup parser 'afterGraceFraction)))
67 (make-simultaneous-music
70 (make-sequential-music
73 (make-music 'SkipMusic
74 'duration (ly:make-duration
76 (* (ly:moment-main-numerator main-length)
78 (* (ly:moment-main-denominator main-length)
80 (make-music 'GraceMusic
84 %% music identifiers not allowed at top-level,
85 %% so this is a music-function instead.
87 #(define-music-function (location parser) ()
88 (_i "Allow a page turn. May be used at toplevel (ie between scores or
89 markups), or inside a score.")
90 (make-music 'EventChord
92 'page-turn-permission 'allow
93 'elements (list (make-music 'PageTurnEvent
94 'break-permission 'allow))))
97 #(define-music-function (parser location property arg item)
98 (symbol-list-or-symbol? list? symbol-list-or-music?)
99 (_i "Override @var{property} for pieces of broken spanner @var{item}
100 with values @var{arg}. @var{item} may either be music in the form of
101 a starting spanner event, or a symbol list in the form
102 @samp{Context.Grob} or just @samp{Grob}. Iff @var{item} is in the
103 form of a spanner event, @var{property} may also have the form
104 @samp{Grob.property} for specifying a directed tweak.")
106 (if (eq? (ly:music-property item 'span-direction) START)
107 #{ \tweak #property #(value-for-spanner-piece arg) #item #}
109 (ly:music-warning item (_ "not a spanner"))
111 (let* ((p (check-grob-path item parser location
115 (name (and p (second p)))
117 (and name (assoc-get name all-grob-descriptions))))
119 (member 'spanner-interface
120 (assoc-get 'interfaces
121 (assoc-get 'meta description))))
123 \override #item . #property =
124 #(value-for-spanner-piece arg)
127 (ly:input-warning location (_ "not a spanner name, `~a'") name)
128 (make-music 'Music))))))
131 #(define-music-function (parser location tag more music)
132 (symbol? ly:music? ly:music?)
133 (_i "Append @var{more} to the @code{elements} of all music
134 expressions in @var{music} that are tagged with @var{tag}.")
135 (music-map (lambda (m)
136 (if (memq tag (ly:music-property m 'tags))
137 (set! (ly:music-property m 'elements)
138 (append (ly:music-property m 'elements)
144 #(define-music-function (parser location proc) (procedure?)
145 (_i "Modify context properties with Scheme procedure @var{proc}.")
146 (make-music 'ApplyContext
150 #(define-music-function (parser location func music) (procedure? ly:music?)
151 (_i"Apply procedure @var{func} to @var{music}.")
155 #(define-music-function (parser location ctx proc) (symbol? procedure?)
156 (_i "Apply function @code{proc} to every layout object in context @code{ctx}")
157 (make-music 'ApplyOutputEvent
162 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
163 (_i "Create an appoggiatura from @var{music}"))
165 % for regression testing purposes.
167 #(define-music-function (parser location l r) (pair? pair?)
168 (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
169 (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
171 % for regression testing purposes.
173 #(define-music-function (parser location comp) (procedure?)
174 (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
175 (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
178 #(define-music-function (parser location music) (ly:music?)
179 (_i "Make voices that switch between staves automatically")
180 (make-autochange-music parser music))
185 #(define-music-function (parser location grob-name offset text)
186 (symbol? number-pair? markup?)
187 (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
188 (use like @code{\\once})")
191 (make-music 'AnnotateOutputEvent
193 'X-offset (car offset)
194 'Y-offset (cdr offset)
198 #(define-event-function (parser location offset text) (number-pair? markup?)
199 (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
200 (make-music 'AnnotateOutputEvent
201 'X-offset (car offset)
202 'Y-offset (cdr offset)
206 #(define-music-function (parser location type) (string?)
207 (_i "Insert a bar line of type @var{type}")
209 (make-property-set 'whichBar type)
213 #(define-music-function (parser location n) (integer?)
214 (_i "Print a warning if the current bar number is not @var{n}.")
215 (make-music 'ApplyContext
218 (let ((cbn (ly:context-property c 'currentBarNumber)))
219 (if (and (number? cbn) (not (= cbn n)))
220 (ly:input-warning location
221 "Barcheck failed got ~a expect ~a"
225 #(define-event-function (parser location delta) (real?)
226 (_i "Create a fall or doit of pitch interval @var{delta}.")
227 (make-music 'BendAfterEvent
231 #(define-void-function (parser location newfilename) (string?)
232 (_i "Direct output for the current book block to @var{newfilename}.")
233 (set! (paper-variable parser #f 'output-filename) newfilename))
236 #(define-void-function (parser location newsuffix) (string?)
237 (_i "Set the output filename suffix for the current book block to
239 (set! (paper-variable parser #f 'output-suffix) newsuffix))
241 %% \breathe is defined as a music function rather than an event identifier to
242 %% ensure it gets useful input location information: as an event identifier,
243 %% it would have to be wrapped in an EventChord to prevent it from being
244 %% treated as a post_event by the parser
246 #(define-music-function (parser location) ()
247 (_i "Insert a breath mark.")
248 (make-music 'BreathingEvent))
251 #(define-music-function (parser location type) (string?)
252 (_i "Set the current clef to @var{type}.")
253 (make-clef-set type))
257 #(define-music-function (parser location args) (pair?)
258 (_i "Create compound time signatures. The argument is a Scheme list of
259 lists. Each list describes one fraction, with the last entry being the
260 denominator, while the first entries describe the summands in the
261 enumerator. If the time signature consists of just one fraction,
262 the list can be given directly, i.e. not as a list containing a single list.
263 For example, a time signature of (3+1)/8 + 2/4 would be created as
264 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
265 as @code{\\compoundMeter #'((3 2 8))} or shorter
266 @code{\\compoundMeter #'(3 2 8)}.")
267 (let* ((mlen (calculate-compound-measure-length args))
268 (beat (calculate-compound-base-beat args))
269 (beatGrouping (calculate-compound-beat-grouping args))
270 (timesig (cons (ly:moment-main-numerator mlen)
271 (ly:moment-main-denominator mlen))))
273 \once \override Staff.TimeSignature.stencil = #(lambda (grob)
274 (grob-interpret-markup grob (format-compound-time args)))
275 \set Timing.timeSignatureFraction = #timesig
276 \set Timing.baseMoment = #beat
277 \set Timing.beatStructure = #beatGrouping
278 \set Timing.beamExceptions = #'()
279 \set Timing.measureLength = #mlen
283 #(define-music-function (parser location notes) (ly:music?)
284 (_i "Create cross-staff stems")
286 \temporary \override Stem.cross-staff = #cross-staff-connect
287 \temporary \override Flag.style = #'no-flag
289 \revert Stem.cross-staff
294 #(define-music-function (parser location type) (string?)
295 (_i "Set the current cue clef to @var{type}.")
296 (make-cue-clef-set type))
299 #(define-music-function (parser location) ()
300 (_i "Unset the current cue clef.")
301 (make-cue-clef-unset))
304 #(define-music-function
305 (parser location what dir main-music) (string? ly:dir? ly:music?)
306 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
307 in a CueVoice oriented by @var{dir}.")
308 (make-music 'QuoteMusic
310 'quoted-context-type 'Voice
311 'quoted-context-id "cue"
312 'quoted-music-name what
313 'quoted-voice-direction dir))
316 #(define-music-function
317 (parser location what dir clef main-music) (string? ly:dir? string? ly:music?)
318 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
319 in a CueVoice oriented by @var{dir}.")
320 (make-music 'QuoteMusic
322 'quoted-context-type 'Voice
323 'quoted-context-id "cue"
324 'quoted-music-name what
325 'quoted-music-clef clef
326 'quoted-voice-direction dir))
331 #(define-music-function (parser location music) (ly:music?)
332 (_i "Display the LilyPond input representation of @var{music}
335 (display-lily-music music parser)
339 #(define-music-function (parser location music) (ly:music?)
340 (_i "Display the internal representation of @var{music} to the console.")
342 (display-scheme-music music)
348 #(define-music-function (parser location music) (ly:music?)
349 (_i "Terminate the next spanner prematurely after exactly one note
350 without the need of a specific end spanner.")
351 (let* ((start-span-evs (filter (lambda (ev)
352 (equal? (ly:music-property ev 'span-direction)
354 (extract-typed-music music 'span-event)))
357 (music-clone m 'span-direction STOP))
359 (end-ev-chord (make-music 'EventChord
360 'elements stop-span-evs))
361 (total (make-music 'SequentialMusic
362 'elements (list music
367 #(define-music-function (parser location music) (ly:music?)
368 (_i "Compatibility function wrapping @code{EventChord} around
369 isolated rhythmic events occuring since version 2.15.28, after
370 expanding repeat chords @samp{q}.")
371 (event-chord-wrap! music parser))
374 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
375 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
376 (let ((orig-duration (ly:music-length argument))
377 (multiplier (ly:make-moment 1 1)))
381 (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
383 (ly:music-compress mus multiplier)
384 (set! multiplier (ly:moment-mul factor multiplier)))))
385 (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
388 (ly:moment-div orig-duration (ly:music-length argument)))
393 #(define-event-function (parser location finger) (number-or-markup?)
394 (_i "Apply @var{finger} as a fingering indication.")
398 (if (number? finger) 'digit 'text)
402 #(define-music-function (parser location mark offset footnote item)
403 ((markup?) number-pair? markup? symbol-list-or-music?)
404 (_i "Make the markup @var{footnote} a footnote on @var{item}. The
405 footnote is marked with a markup @var{mark} moved by @var{offset} with
406 respect to the marked music.
408 If @var{mark} is not given or specified as @var{\\default}, it is
409 replaced by an automatically generated sequence number. If @var{item}
410 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
411 grobs of that type will be marked at the current time step in the
412 given context (default @code{Bottom}).
414 If @var{item} is music, the music will get a footnote attached to a
415 grob immediately attached to the event, like @var{\\tweak} does. For
416 attaching a footnote to an @emph{indirectly} caused grob, write
417 @code{\\single\\footnote}, use @var{item} to specify the grob, and
418 follow it with the music to annotate.
420 Like with @code{\\tweak}, if you use a footnote on a following
421 post-event, the @code{\\footnote} command itself needs to be attached
422 to the preceding note or rest as a post-event with @code{-}.")
423 (let ((mus (make-music
425 'X-offset (car offset)
426 'Y-offset (cdr offset)
427 'automatically-numbered (not mark)
428 'text (or mark (make-null-markup))
429 'footnote-text footnote)))
430 #{ \tweak footnote-music #mus #item #}))
433 #(def-grace-function startGraceMusic stopGraceMusic
434 (_i "Insert @var{music} as grace notes."))
437 #(define-scheme-function (parser location descriptions) (list?)
438 (_i "Create a context modification from @var{descriptions}, a list
439 in the format of @code{all-grob-descriptions}.")
442 (list 'assign (car p) (list (cdr p))))
445 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
446 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
447 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
449 \set harmonicDots = ##t
450 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
451 \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
452 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
453 (ly:note-head::print grob))
455 (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
457 \revert TabNoteHead.stencil
458 \revert NoteHead.Y-extent
459 \revert NoteHead.stencil
462 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
463 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
464 harmonics played on a fretted instrument by touching the strings at the point
465 given through @var{ratio}.")
467 \set harmonicDots = ##t
468 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
469 \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height
470 (lambda (grob start end)
471 (ly:grob::stencil-height grob)))
472 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
473 (ly:note-head::print grob))
475 (calc-harmonic-pitch (ratio->pitch ratio) music))
477 \revert TabNoteHead.stencil
478 \revert NoteHead.Y-extent
479 \revert NoteHead.stencil
483 #(define-music-function (parser location item) (symbol-list-or-music?)
484 (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
485 making it invisible while still retaining its dimensions.
487 If @var{item} is a symbol list of form @code{GrobName} or
488 @code{Context.GrobName}, the result is an override for the grob name
489 specified by it. If @var{item} is a music expression, the result is
490 the same music expression with an appropriate tweak applied to it.")
492 #{ \tweak transparent ##t #item #}
493 #{ \override #item . transparent = ##t #}))
496 #(define-music-function (parser location) ()
497 (_i "Put the segno variant 'varsegno' at this position into the staff,
498 compatible with the repeat command.")
499 (make-music 'ApplyContext
502 (let ((score-ctx (ly:context-find ctx 'Score)))
503 (if (ly:context? score-ctx)
504 (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
505 (if (eq? (memq 'segno-display old-rc) #f)
506 (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
509 #(define-music-function
510 (parser location name) (string?)
511 (_i "Switch instrument to @var{name}, which must be predefined with
512 @code{\\addInstrumentDefinition}.")
513 (let* ((handle (assoc name instrument-definitions))
514 (instrument-def (if handle (cdr handle) '())))
517 (ly:input-warning location "No such instrument: ~a" name))
519 (make-music 'SimultaneousMusic
531 #(define-music-function (parser location tag music)
532 (symbol-list-or-symbol? ly:music?)
533 (_i "Include only elements of @var{music} that are either untagged
534 or tagged with one of the tags in @var{tag}. @var{tag} may be either
535 a single symbol or a list of symbols.")
539 (let ((music-tags (ly:music-property m 'tags)))
540 (or (null? music-tags)
541 (memq tag music-tags))))
543 (let ((music-tags (ly:music-property m 'tags)))
544 (or (null? music-tags)
545 (any (lambda (t) (memq t music-tags)) tag)))))
549 #(define-music-function (parser location tonic pitch-alist)
550 ((ly:pitch? '()) (list? '()))
551 (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
552 If both are null, just generate @code{KeyChangeEvent}.")
553 (cond ((null? tonic) (make-music 'KeyChangeEvent))
555 (ly:parser-error parser (_ "second argument must be pitch list")
557 (make-music 'SequentialMusic 'void #t))
560 (make-music 'KeyChangeEvent
561 'tonic (ly:make-pitch 0 0 0)
562 'pitch-alist pitch-alist)
566 #(define-music-function (parser location music) (ly:music?)
567 (_i "Remove cue notes from @var{music}.")
570 (if (and (string? (ly:music-property mus 'quoted-music-name))
571 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
572 (ly:music-property mus 'element)
579 #(define-music-function (parser location label) (symbol?)
580 (_i "Create @var{label} as a bookmarking label.")
581 (make-music 'EventChord
584 'elements (list (make-music 'LabelEvent
585 'page-label label))))
589 #(define-void-function (parser location language) (string?)
590 (_i "Set note names for language @var{language}.")
591 (note-names-language parser language))
593 languageSaveAndChange =
594 #(define-void-function (parser location language) (string?)
595 (_i "Store the previous pitchnames alist, and set a new one.")
596 (set! previous-pitchnames pitchnames)
597 (note-names-language parser language))
600 #(define-void-function (parser location) ()
601 (_i "Restore a previously-saved pitchnames alist.")
602 (if previous-pitchnames
604 (set! pitchnames previous-pitchnames)
605 (ly:parser-set-note-names parser pitchnames))
606 (ly:input-warning location (_ "No other language was defined previously. Ignoring."))))
610 #(define-music-function (parser location arg) (ly:music?)
611 (_i "Display chords in @var{arg} as clusters.")
612 (music-map note-to-cluster arg))
615 #(define-music-function (parser location around to scale music)
616 (ly:pitch? ly:pitch? ly:music? ly:music?)
617 (_i "Invert @var{music} about @var{around} using @var{scale} and
618 transpose from @var{around} to @var{to}.")
619 (let ((inverter (make-modal-inverter around to scale)))
620 (change-pitches music inverter)
624 #(define-music-function (parser location from to scale music)
625 (ly:pitch? ly:pitch? ly:music? ly:music?)
626 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
628 (let ((transposer (make-modal-transposer from to scale)))
629 (change-pitches music transposer)
633 #(define-music-function
634 (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
635 (_i "Invert @var{music} about @var{around} and
636 transpose from @var{around} to @var{to}.")
637 (music-invert around to music))
640 #(define-music-function
641 (parser location label) ((scheme? '()))
642 "Make the music for the \\mark command."
643 (let* ((set (and (integer? label)
644 (context-spec-music (make-property-set 'rehearsalMark label)
646 (ev (make-music 'MarkEvent
650 (make-sequential-music (list set ev))
652 (set! (ly:music-property ev 'label) label)
656 #(define-music-function (parser location proc mus) (procedure? ly:music?)
657 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
658 (music-map proc mus))
660 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
661 %% because music identifiers are not allowed at top-level.
663 #(define-music-function (location parser) ()
664 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
665 markups), or inside a score.")
666 (make-music 'EventChord
668 'page-break-permission 'forbid
669 'elements (list (make-music 'PageBreakEvent
670 'break-permission '()))))
673 #(define-music-function (location parser) ()
674 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
675 markups), or inside a score.")
676 (make-music 'EventChord
678 'page-turn-permission 'forbid
679 'elements (list (make-music 'PageTurnEvent
680 'break-permission '()))))
685 #(define-music-function (parser location pitch) (ly:pitch?)
687 (make-music 'RelativeOctaveCheck
691 #(define-music-function (parser location item) (symbol-list-or-music?)
692 (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
693 effectively omitting it without taking up space.
695 If @var{item} is a symbol list of form @code{GrobName} or
696 @code{Context.GrobName}, the result is an override for the grob name
697 specified by it. If @var{item} is a music expression, the result is
698 the same music expression with an appropriate tweak applied to it.")
700 #{ \tweak stencil ##f #item #}
701 #{ \override #item . stencil = ##f #}))
704 #(define-music-function (parser location music) (ly:music?)
705 (_i "Set @code{once} to @code{#t} on all layout instruction events in @var{music}.")
708 (cond ((music-is-of-type? m 'layout-instruction-event)
709 (set! (ly:music-property m 'once) #t))
710 ((ly:duration? (ly:music-property m 'duration))
711 (ly:music-warning m (_ "Cannot apply \\once to timed music"))))
716 #(define-music-function (parser location octave) (integer?)
717 (_i "Set the octavation.")
718 (make-music 'OttavaMusic
719 'ottava-number octave))
721 overrideTimeSignatureSettings =
722 #(define-music-function
723 (parser location time-signature base-moment beat-structure beam-exceptions)
724 (pair? pair? cheap-list? cheap-list?)
726 (_i "Override @code{timeSignatureSettings}
727 for time signatures of @var{time-signature} to have settings
728 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
730 ;; TODO -- add warning if largest value of grouping is
731 ;; greater than time-signature.
732 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
733 (override-time-signature-setting time-signature setting)))
736 #(define-music-function (parser location grob-property-path value)
737 (symbol-list? scheme?)
739 (_i "Set the grob property specified by @var{grob-property-path} to
740 @var{value}. @var{grob-property-path} is a symbol list of the form
741 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
742 with subproperties given as well.")
743 (let ((p (check-grob-path grob-property-path parser location
747 (make-music 'ApplyOutputEvent
748 'context-type (first p)
750 (lambda (grob orig-context context)
752 (cdr (assoc 'name (ly:grob-property grob 'meta)))
754 (ly:grob-set-nested-property!
755 grob (cddr p) value))))
756 (make-music 'Music))))
763 %% pageBreak and pageTurn are music functions (iso music indentifiers),
764 %% because music identifiers are not allowed at top-level.
766 #(define-music-function (location parser) ()
767 (_i "Force a page break. May be used at toplevel (i.e., between scores or
768 markups), or inside a score.")
769 (make-music 'EventChord
771 'line-break-permission 'force
772 'page-break-permission 'force
773 'elements (list (make-music 'LineBreakEvent
774 'break-permission 'force)
775 (make-music 'PageBreakEvent
776 'break-permission 'force))))
779 #(define-music-function (location parser) ()
780 (_i "Force a page turn between two scores or top-level markups.")
781 (make-music 'EventChord
783 'line-break-permission 'force
784 'page-break-permission 'force
785 'page-turn-permission 'force
786 'elements (list (make-music 'LineBreakEvent
787 'break-permission 'force)
788 (make-music 'PageBreakEvent
789 'break-permission 'force)
790 (make-music 'PageTurnEvent
791 'break-permission 'force))))
794 #(define-void-function (parser location voice-ids music) (list? ly:music?)
795 (_i "Define parallel music sequences, separated by '|' (bar check signs),
796 and assign them to the identifiers provided in @var{voice-ids}.
798 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
800 @var{music}: a music sequence, containing BarChecks as limiting expressions.
805 \\parallelMusic #'(A B C) {
815 (define (bar-check? m)
816 "Checks whether m is a bar check."
817 (eq? (ly:music-property m 'name) 'BarCheck))
818 (define (recurse-and-split music)
819 "This returns either a list of music split along barchecks, or
821 (let ((elt (ly:music-property music 'element))
822 (elts (ly:music-property music 'elements)))
823 (cond ((ly:music? elt)
824 (let ((lst (recurse-and-split elt)))
828 (let ((res (music-clone music 'element x)))
829 (if (ly:input-location?
830 (ly:music-property x 'origin))
831 (set! (ly:music-property res 'origin)
832 (ly:music-property x 'origin)))
835 ((any bar-check? elts)
836 (let* ((voices (apply circular-list
837 (make-list (length voice-ids)
839 (current-voices voices)
840 (current-sequence '()))
843 (define (push-music m)
844 "Push the music expression into the current sequence"
845 (set! current-sequence (cons m current-sequence)))
846 (define (change-voice)
847 "Stores the previously built sequence into the current voice and
848 change to the following voice."
849 (set-car! current-voices
850 (cons (reverse! current-sequence)
851 (car current-voices)))
852 (set! current-sequence '())
853 (set! current-voices (cdr current-voices)))
854 (for-each (lambda (m)
855 (let ((split? (recurse-and-split m)))
864 (if (bar-check? m) (change-voice))))))
866 (if (pair? current-sequence) (change-voice))
867 ;; un-circularize `voices' and reorder the voices
869 (set! voices (map reverse!
870 (list-head voices (length voice-ids))))
872 ;; check sequence length
873 (apply for-each (lambda seqs
874 (define (seq-len seq)
875 (reduce ly:moment-add
877 (map ly:music-length seq)))
878 (let ((moment-reference (seq-len (car seqs))))
879 (for-each (lambda (seq)
880 (if (not (equal? (seq-len seq)
886 (_ "Bars in parallel music don't have the same length"))))
891 (set! lst (concatenate! lst))
892 (let ((res (music-clone music 'elements lst)))
894 (ly:input-location? (ly:music-property
897 (set! (ly:music-property res 'origin)
898 (ly:music-property (car lst) 'origin)))
902 (let ((voices (recurse-and-split music)))
905 ;; bind voice identifiers to the voices
906 (for-each (lambda (voice-id voice)
907 (ly:parser-define! parser voice-id voice))
909 (ly:music-warning music
910 (_ "ignoring parallel music without barchecks")))))
913 #(define-music-function (parser loc arg) (ly:music?)
914 (_i "Tag @var{arg} to be parenthesized.")
916 (if (memq 'event-chord (ly:music-property arg 'types))
917 ;; arg is an EventChord -> set the parenthesize property
918 ;; on all child notes and rests
921 (if (or (memq 'note-event (ly:music-property ev 'types))
922 (memq 'rest-event (ly:music-property ev 'types)))
923 (set! (ly:music-property ev 'parenthesize) #t)))
924 (ly:music-property arg 'elements))
925 ;; No chord, simply set property for this expression:
926 (set! (ly:music-property arg 'parenthesize) #t))
930 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
931 (_i "Take the music in @var{part1} and @var{part2} and typeset so
932 that they share a staff.")
933 (make-part-combine-music parser
934 (list part1 part2) #f))
937 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
938 (_i "Take the music in @var{part1} and @var{part2} and typeset so
939 that they share a staff with stems directed upward.")
940 (make-part-combine-music parser
941 (list part1 part2) UP))
944 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
945 (_i "Take the music in @var{part1} and @var{part2} and typeset so
946 that they share a staff with stems directed downward.")
947 (make-part-combine-music parser
948 (list part1 part2) DOWN))
951 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
952 (_i "Override the part-combiner.")
953 (make-music 'EventChord
954 'elements (list (make-music 'PartCombineForceEvent
957 partcombineApart = \partcombineForce #'apart ##f
958 partcombineApartOnce = \partcombineForce #'apart ##t
959 partcombineChords = \partcombineForce #'chords ##f
960 partcombineChordsOnce = \partcombineForce #'chords ##t
961 partcombineUnisono = \partcombineForce #'unisono ##f
962 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
963 partcombineSoloI = \partcombineForce #'solo1 ##f
964 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
965 partcombineSoloII = \partcombineForce #'solo2 ##f
966 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
967 partcombineAutomatic = \partcombineForce ##f ##f
968 partcombineAutomaticOnce = \partcombineForce ##f ##t
971 #(define-music-function (parser location dur) (ly:duration?)
972 (_i "Make a partial measure.")
974 ;; We use `descend-to-context' here instead of `context-spec-music' to
975 ;; ensure \partial still works if the Timing_translator is moved
977 (context-spec-music (make-music 'PartialSet
979 'partial-duration dur)
984 #(define-music-function
985 (parser location main-note secondary-note)
986 (ly:music? ly:music?)
987 (_i "Print a trill with @var{main-note} as the main note of the trill and
988 print @var{secondary-note} as a stemless note head in parentheses.")
989 (let* ((get-notes (lambda (ev-chord)
990 (extract-named-music ev-chord 'NoteEvent)))
991 (sec-note-events (get-notes secondary-note))
992 (trill-events (extract-named-music main-note 'TrillSpanEvent)))
993 (if (pair? sec-note-events)
995 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
996 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
998 (if (ly:pitch? trill-pitch)
999 (for-each (lambda (m)
1000 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1002 (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
1003 (display sec-note-events)))
1006 (for-each (lambda (m)
1007 (ly:music-set-property! m 'force-accidental forced))
1012 #(define-music-function (parser location tag more music)
1013 (symbol? ly:music? ly:music?)
1014 (_i "Add @var{more} to the front of @code{elements} of all music
1015 expressions in @var{music} that are tagged with @var{tag}.")
1016 (music-map (lambda (m)
1017 (if (memq tag (ly:music-property m 'tags))
1018 (set! (ly:music-property m 'elements)
1019 (cons more (ly:music-property m 'elements))))
1024 #(define-music-function (parser location what main-music) (string? ly:music?)
1025 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
1026 of the quoted voice, as specified in an @code{\\addQuote} command.
1027 @var{main-music} is used to indicate the length of music to be quoted;
1028 usually contains spacers or multi-measure rests.")
1029 (make-music 'QuoteMusic
1031 'quoted-music-name what))
1034 #(define-music-function (parser location pitch music)
1035 (ly:pitch? ly:music?)
1036 (_i "Make @var{music} relative to @var{pitch}.")
1037 (ly:make-music-relative! music pitch)
1038 (make-music 'RelativeOctaveMusic
1042 #(define-music-function (parser location tag music)
1043 (symbol-list-or-symbol? ly:music?)
1044 (_i "Remove elements of @var{music} that are tagged with one of the
1045 tags in @var{tag}. @var{tag} may be either a single symbol or a list
1050 (not (memq tag (ly:music-property m 'tags))))
1052 (let ((music-tags (ly:music-property m 'tags)))
1053 (or (null? music-tags)
1054 (not (any (lambda (t) (memq t music-tags)) tag))))))
1057 resetRelativeOctave =
1058 #(define-music-function (parser location pitch) (ly:pitch?)
1059 (_i "Set the octave inside a \\relative section.")
1061 (make-music 'SequentialMusic
1062 'to-relative-callback
1063 (lambda (music last-pitch) pitch)))
1066 #(define-music-function (parser location music)
1068 (_i "Return @var{music} in reverse order.")
1069 (retrograde-music music))
1071 revertTimeSignatureSettings =
1072 #(define-music-function
1073 (parser location time-signature)
1076 (_i "Revert @code{timeSignatureSettings}
1077 for time signatures of @var{time-signature}.")
1078 (revert-time-signature-setting time-signature))
1081 #(define-event-function (parser location finger) (number-or-markup?)
1082 (_i "Apply @var{finger} as a fingering indication.")
1086 (if (number? finger) 'digit 'text)
1090 #(define-music-function (parser location fraction music)
1091 (fraction? ly:music?)
1092 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1093 (ly:music-compress music
1094 (ly:make-moment (car fraction) (cdr fraction))))
1097 #(define-scheme-function (parser location ctx music)
1098 ((symbol?) ly:music?)
1099 (_i "Take the layout instruction events from @var{music}, optionally
1100 restricted to those applying to context type @var{ctx}, and return
1101 a context modification duplicating their effect.")
1102 (let ((mods (ly:make-context-mod)))
1104 (if (music-is-of-type? m 'layout-instruction-event)
1107 (case (ly:music-property m 'name)
1110 (ly:music-property m 'symbol)
1111 (ly:music-property m 'value)))
1114 (ly:music-property m 'symbol)))
1117 (ly:music-property m 'symbol)
1118 (ly:music-property m 'grob-value)
1120 ((ly:music-property m 'grob-property #f) => list)
1122 (ly:music-property m 'grob-property-path)))))
1125 (ly:music-property m 'symbol)
1127 ((ly:music-property m 'grob-property #f) => list)
1129 (ly:music-property m 'grob-property-path)))))))
1130 (case (ly:music-property m 'name)
1132 (ly:add-context-mod mods
1134 (ly:music-property m 'procedure))))
1135 ((ContextSpeccedMusic)
1137 (eq? ctx (ly:music-property m 'context-type)))
1138 (musicop (ly:music-property m 'element))))
1140 (let ((callback (ly:music-property m 'elements-callback)))
1141 (if (procedure? callback)
1142 (for-each musicop (callback m))))))))
1147 #(define-music-function (parser location offsets item)
1148 (list? symbol-list-or-music?)
1149 (_i "Offset control-points of @var{item} by @var{offsets}. The
1150 argument is a list of number pairs or list of such lists. Each
1151 element of a pair represents an offset to one of the coordinates of a
1152 control-point. If @var{item} is a string, the result is
1153 @code{\\once\\override} for the specified grob type. If @var{item} is
1154 a music expression, the result is the same music expression with an
1155 appropriate tweak applied.")
1156 (define (shape-curve grob)
1157 (let* ((orig (ly:grob-original grob))
1158 (siblings (if (ly:spanner? grob)
1159 (ly:spanner-broken-into orig) '()))
1160 (total-found (length siblings))
1161 (function (assoc-get 'control-points
1162 (reverse (ly:grob-basic-properties grob))))
1163 (coords (function grob)))
1165 (define (offset-control-points offsets)
1169 (lambda (x y) (coord-translate x y))
1172 (define (helper sibs offs)
1174 (if (eq? (car sibs) grob)
1175 (offset-control-points (car offs))
1176 (helper (cdr sibs) (cdr offs)))
1179 ;; we work with lists of lists
1180 (if (or (null? offsets)
1181 (not (list? (car offsets))))
1182 (set! offsets (list offsets)))
1184 (if (>= total-found 2)
1185 (helper siblings offsets)
1186 (offset-control-points (car offsets)))))
1187 #{ \tweak control-points #shape-curve #item #})
1190 #(define-music-function (parser location dur dots arg)
1191 (integer? integer? ly:music?)
1192 (_i "Change the duration of @var{arg} by adding @var{dur} to the
1193 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1197 (shift-one-duration-log x dur dots)) arg))
1200 #(define-music-function (parser location overrides music)
1201 (ly:music? ly:music?)
1202 (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1203 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1204 (set! (ly:music-property music 'tweaks)
1206 (lambda (m) (eq? (ly:music-property m 'name)
1210 ((ly:music-property m 'grob-property #f) => list)
1212 (ly:music-property m 'grob-property-path)))))
1213 (acons (cons (ly:music-property m 'symbol) ;grob name
1215 p ;grob property path
1216 (car p))) ;grob property
1217 (ly:music-property m 'grob-value)
1219 (ly:music-property music 'tweaks)
1224 #(define-music-function (parser location dur) (ly:duration?)
1225 (_i "Skip forward by @var{dur}.")
1226 (make-music 'SkipMusic
1231 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1232 (_i "Create slashed graces (slashes through stems, but no slur) from
1233 the following music expression"))
1236 #(define-music-function (parser location parameters) (list?)
1237 (_i "Set the system stretch, by reading the 'system-stretch property of
1238 the `parameters' assoc list.")
1240 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1241 #(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1242 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
1246 #(define-music-function (parser location style heads music)
1247 (symbol? symbol-list-or-symbol? ly:music?)
1248 (_i "Set @var{heads} in @var{music} to @var{style}.")
1249 (style-note-heads heads style music))
1252 #(define-music-function (parser location tag music) (symbol-list-or-symbol? ly:music?)
1253 (_i "Tag the following @var{music} with @var{tag} and return the
1254 result, by adding the single symbol or symbol list @var{tag} to the
1255 @code{tags} property of @var{music}.")
1258 (ly:music-property music 'tags)
1259 ((if (symbol? tag) cons append)
1261 (ly:music-property music 'tags)))
1265 #(define-music-function (parser location music)
1267 (_i "Make any @code{\\override} in @var{music} replace an existing
1268 grob property value only temporarily, restoring the old value when a
1269 corresponding @code{\\revert} is executed. This is achieved by
1270 clearing the @samp{pop-first} property normally set on
1273 An @code{\\override}/@/@code{\\revert} sequence created by using
1274 @code{\\temporary} and @code{\\undo} on the same music containing
1275 overrides will cancel out perfectly or cause a@tie{}warning.
1277 Non-property-related music is ignored, warnings are generated for any
1278 property-changing music that isn't an @code{\\override}.")
1282 (and (or (music-is-of-type? m 'layout-instruction-event)
1283 (music-is-of-type? m 'context-specification)
1284 (music-is-of-type? m 'apply-context)
1285 (music-is-of-type? m 'time-signature-music))
1286 (case (ly:music-property m 'name)
1288 (if (ly:music-property m 'pop-first #f)
1289 (set! (ly:music-property m 'pop-first) '()))
1290 (if (ly:music-property m 'once #f)
1291 (set! (ly:music-property m 'once) '()))
1293 ((ContextSpeccedMusic)
1298 (ly:input-warning location (_ "Cannot make ~a revertible")
1299 (ly:music-property m 'name))
1306 #(define-music-function (parser location beat-structure fraction)
1307 ((number-list? '()) fraction?)
1308 (_i "Set @var{fraction} as time signature, with optional
1309 number list @var{beat-structure} before it.")
1310 (make-music 'TimeSignatureMusic
1311 'numerator (car fraction)
1312 'denominator (cdr fraction)
1313 'beat-structure beat-structure))
1316 #(define-music-function (parser location fraction music)
1317 (fraction? ly:music?)
1318 (_i "Scale @var{music} in time by @var{fraction}.")
1319 (make-music 'TimeScaledMusic
1320 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1321 'numerator (car fraction)
1322 'denominator (cdr fraction)))
1325 #(define-music-function
1326 (parser location from to music)
1327 (ly:pitch? ly:pitch? ly:music?)
1329 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1330 (make-music 'TransposedMusic
1331 'element (ly:music-transpose music (ly:pitch-diff to from))))
1333 transposedCueDuring =
1334 #(define-music-function
1335 (parser location what dir pitch main-music)
1336 (string? ly:dir? ly:pitch? ly:music?)
1338 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1339 using the transposition defined by @var{pitch}. This happens
1340 simultaneously with @var{main-music}, which is usually a rest. The
1341 argument @var{dir} determines whether the cue notes should be notated
1342 as a first or second voice.")
1344 (make-music 'QuoteMusic
1346 'quoted-context-type 'Voice
1347 'quoted-context-id "cue"
1348 'quoted-music-name what
1349 'quoted-voice-direction dir
1350 ;; following is inverse of instrumentTransposition for
1351 ;; historical reasons
1352 'quoted-transposition pitch))
1355 #(define-music-function (parser location pitch) (ly:pitch?)
1356 (_i "Set instrument transposition")
1359 (make-property-set 'instrumentTransposition pitch)
1363 #(define-music-function (parser location ratio tuplet-span music)
1364 (fraction? (ly:duration? '()) ly:music?)
1365 (_i "Scale the given @var{music} to tuplets. @var{ratio} is a
1366 fraction that specifies how many notes are played in place of the
1367 nominal value: it will be @samp{3/2} for triplets, namely three notes
1368 being played in place of two. If the optional duration
1369 @var{tuplet-span} is specified, it is used instead of
1370 @code{tupletSpannerDuration} for grouping the tuplets.
1373 \\tuplet 3/2 4 @{ c8 c c c c c @}
1375 will result in two groups of three tuplets, each group lasting for a
1377 (make-music 'TimeScaledMusic
1378 'element (ly:music-compress
1380 (ly:make-moment (cdr ratio) (car ratio)))
1381 'numerator (cdr ratio)
1382 'denominator (car ratio)
1383 'duration tuplet-span))
1386 #(define-music-function (parser location tuplet-span)
1388 (_i "Set @code{tupletSpannerDuration}, the length into which
1389 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1390 own will group its tuplets, to the duration @var{tuplet-span}. To
1391 revert to the default of not subdividing the contents of a @code{\\tuplet}
1392 command without explicit @samp{tuplet-span}, use
1394 \\tupletSpan \\default
1398 #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1399 #{ \unset tupletSpannerDuration #}))
1402 #(define-music-function (parser location prop value item)
1403 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1404 (_i "Add a tweak to the following @var{item}, usually music.
1405 Layout objects created by @var{item} get their property @var{prop}
1406 set to @var{value}. If @var{prop} has the form @samp{Grob.property}, like with
1408 \\tweak Accidental.color #red cis'
1410 an indirectly created grob (@samp{Accidental} is caused by
1411 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1414 As a special case, @var{item} may be a symbol list specifying a grob
1415 path, in which case @code{\\once\\override} is called on it instead of
1416 creating tweaked music. This is mainly useful when using
1417 @code{\\tweak} as as a component for building other functions.
1419 @var{prop} can contain additional elements in which case a nested
1420 property (inside of an alist) is tweaked.")
1421 (if (ly:music? item)
1422 (let ((p (check-grob-path prop parser location
1427 (set! (ly:music-property item 'tweaks)
1428 (acons (cond ((pair? (cddr p)) p)
1430 (cons (car p) (cadr p)))
1433 (ly:music-property item 'tweaks))))
1435 ;; We could just throw this at \override and let it sort this
1436 ;; out on its own, but this way we should get better error
1438 (let ((a (check-grob-path item parser location
1439 #:default 'Bottom #:min 2 #:max 2))
1440 (b (check-grob-path prop parser location
1443 #{ \once\override #(append a b) = #value #}
1444 (make-music 'Music)))))
1447 #(define-music-function (parser location music)
1449 (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1450 @code{\\revert} and @code{\\unset}, respectively. Any reverts and
1451 unsets already in @var{music} cause a warning. Non-property-related music is ignored.")
1458 (lambda (m) (or (music-is-of-type? m 'layout-instruction-event)
1459 (music-is-of-type? m 'context-specification)
1460 (music-is-of-type? m 'apply-context)
1461 (music-is-of-type? m 'time-signature-music)))
1462 (lambda (m overrides)
1463 (case (ly:music-property m 'name)
1466 (make-music 'RevertProperty
1467 'symbol (ly:music-property m 'symbol)
1470 ((ly:music-property m 'grob-property #f) => list)
1472 (ly:music-property m 'grob-property-path))))
1476 (make-music 'PropertyUnset
1477 'symbol (ly:music-property m 'symbol))
1479 ((ContextSpeccedMusic)
1481 (make-music 'ContextSpeccedMusic
1482 'element (loop (ly:music-property m 'element))
1483 'context-type (ly:music-property m 'context-type))
1488 (ly:input-warning location (_ "Cannot revert ~a")
1489 (ly:music-property m 'name))
1495 ((null? lst) (make-music 'Music))
1496 ((null? (cdr lst)) (car lst))
1497 (else (make-sequential-music lst))))))
1500 #(define-music-function (parser location music) (ly:music?)
1501 (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1502 @code{\\repeat percent} commands in @var{music} to be interpreted
1503 as @code{\\repeat unfold}.")
1504 (unfold-repeats music))
1507 #(define-void-function (parser location arg) (scheme?)
1508 (_i "Accept a scheme argument, return a void expression.
1509 Use this if you want to have a scheme expression evaluated
1510 because of its side-effects, but its value ignored."))
1513 #(define-music-function (parser location sym val music)
1514 (symbol? scheme? ly:music?)
1515 (_i "Set @var{sym} to @var{val} in @var{music}.")
1517 (set! (ly:music-property music sym) val)