1 %%%% -*- Mode: Scheme -*-
3 %%%% This file is part of LilyPond, the GNU music typesetter.
5 %%%% Copyright (C) 2003--2014 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-scheme-function (parser location music) (ly:music?)
226 (_i "Extract a value suitable for setting
227 @code{Timing.beamExceptions} from the given pattern with explicit
228 beams in @var{music}. A bar check @code{|} has to be used between
229 bars of patterns in order to reset the timing.")
230 (extract-beam-exceptions music))
233 #(define-event-function (parser location delta) (real?)
234 (_i "Create a fall or doit of pitch interval @var{delta}.")
235 (make-music 'BendAfterEvent
239 #(define-void-function (parser location newfilename) (string?)
240 (_i "Direct output for the current book block to @var{newfilename}.")
241 (set! (paper-variable parser #f 'output-filename) newfilename))
244 #(define-void-function (parser location newsuffix) (string?)
245 (_i "Set the output filename suffix for the current book block to
247 (set! (paper-variable parser #f 'output-suffix) newsuffix))
249 %% \breathe is defined as a music function rather than an event identifier to
250 %% ensure it gets useful input location information: as an event identifier,
251 %% it would have to be wrapped in an EventChord to prevent it from being
252 %% treated as a post_event by the parser
254 #(define-music-function (parser location) ()
255 (_i "Insert a breath mark.")
256 (make-music 'BreathingEvent
258 (lambda (len context)
259 ;;Shorten by half, or by up to a second, but always by a power of 2
260 (let* ((desired (min (ly:moment-main (seconds->moment 1 context))
261 (* (ly:moment-main len) 1/2)))
262 (scale (inexact->exact (ceiling (/ (log desired) (log 1/2)))))
263 (breath (ly:make-moment (expt 1/2 scale))))
264 (ly:moment-sub (ly:make-moment (ly:moment-main len)) breath)))))
267 #(define-music-function (parser location type) (string?)
268 (_i "Set the current clef to @var{type}.")
269 (make-clef-set type))
273 #(define-music-function (parser location args) (pair?)
274 (_i "Create compound time signatures. The argument is a Scheme list of
275 lists. Each list describes one fraction, with the last entry being the
276 denominator, while the first entries describe the summands in the
277 enumerator. If the time signature consists of just one fraction,
278 the list can be given directly, i.e. not as a list containing a single list.
279 For example, a time signature of (3+1)/8 + 2/4 would be created as
280 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
281 as @code{\\compoundMeter #'((3 2 8))} or shorter
282 @code{\\compoundMeter #'(3 2 8)}.")
283 (let* ((mlen (calculate-compound-measure-length args))
284 (beat (calculate-compound-base-beat args))
285 (beatGrouping (calculate-compound-beat-grouping args))
286 (timesig (cons (ly:moment-main-numerator mlen)
287 (ly:moment-main-denominator mlen))))
289 \once \override Timing.TimeSignature.stencil = #(lambda (grob)
290 (grob-interpret-markup grob (format-compound-time args)))
291 \set Timing.timeSignatureFraction = #timesig
292 \set Timing.baseMoment = #beat
293 \set Timing.beatStructure = #beatGrouping
294 \set Timing.beamExceptions = #'()
295 \set Timing.measureLength = #mlen
299 #(define-music-function (parser location notes) (ly:music?)
300 (_i "Create cross-staff stems")
302 \temporary \override Stem.cross-staff = #cross-staff-connect
303 \temporary \override Flag.style = #'no-flag
305 \revert Stem.cross-staff
310 #(define-music-function (parser location type) (string?)
311 (_i "Set the current cue clef to @var{type}.")
312 (make-cue-clef-set type))
315 #(define-music-function (parser location) ()
316 (_i "Unset the current cue clef.")
317 (make-cue-clef-unset))
320 #(define-music-function
321 (parser location what dir main-music) (string? ly:dir? ly:music?)
322 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
323 in a CueVoice oriented by @var{dir}.")
324 (make-music 'QuoteMusic
326 'quoted-context-type 'CueVoice
327 'quoted-context-id "cue"
328 'quoted-music-name what
329 'quoted-voice-direction dir))
332 #(define-music-function
333 (parser location what dir clef main-music) (string? ly:dir? string? ly:music?)
334 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
335 in a CueVoice oriented by @var{dir}.")
336 (make-music 'QuoteMusic
338 'quoted-context-type 'CueVoice
339 'quoted-context-id "cue"
340 'quoted-music-name what
341 'quoted-music-clef clef
342 'quoted-voice-direction dir))
347 #(define-music-function (parser location port music) ((output-port?) ly:music?)
348 (_i "Display the LilyPond input representation of @var{music}
349 to @var{port}, defaulting to the console.")
350 (let ((port (or port (current-output-port))))
352 (display-lily-music music parser port))
356 #(define-music-function (parser location port music) ((output-port?) ly:music?)
357 (_i "Display the internal representation of @var{music} to
358 @var{port}, default to the console.")
359 (let ((port (or port (current-output-port))))
361 (display-scheme-music music port))
365 #(define-scheme-function (parser location port expr) ((output-port?) scheme?)
366 (_i "Display the internal representation of @var{expr} to
367 @var{port}, default to the console.")
368 (let ((port (or port (current-output-port))))
370 (display-scheme-music expr port))
376 #(define-music-function (parser location music) (ly:music?)
377 (_i "Terminate the next spanner prematurely after exactly one note
378 without the need of a specific end spanner.")
379 (let* ((start-span-evs (filter (lambda (ev)
380 (equal? (ly:music-property ev 'span-direction)
382 (extract-typed-music music 'span-event)))
385 (music-clone m 'span-direction STOP))
387 (end-ev-chord (make-music 'EventChord
388 'elements stop-span-evs))
389 (total (make-music 'SequentialMusic
390 'elements (list music
395 #(define-music-function (parser location music) (ly:music?)
396 (_i "Compatibility function wrapping @code{EventChord} around
397 isolated rhythmic events occuring since version 2.15.28, after
398 expanding repeat chords @samp{q}.")
399 (event-chord-wrap! music parser))
402 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
403 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
404 (let ((orig-duration (ly:music-length argument))
405 (multiplier (ly:make-moment 1 1)))
409 (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
411 (ly:music-compress mus multiplier)
412 (set! multiplier (ly:moment-mul factor multiplier)))))
413 (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
416 (ly:moment-div orig-duration (ly:music-length argument)))
421 #(define-event-function (parser location finger) (number-or-markup?)
422 (_i "Apply @var{finger} as a fingering indication.")
426 (if (number? finger) 'digit 'text)
430 #(define-music-function (parser location mark offset footnote item)
431 ((markup?) number-pair? markup? symbol-list-or-music?)
432 (_i "Make the markup @var{footnote} a footnote on @var{item}. The
433 footnote is marked with a markup @var{mark} moved by @var{offset} with
434 respect to the marked music.
436 If @var{mark} is not given or specified as @var{\\default}, it is
437 replaced by an automatically generated sequence number. If @var{item}
438 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
439 grobs of that type will be marked at the current time step in the
440 given context (default @code{Bottom}).
442 If @var{item} is music, the music will get a footnote attached to a
443 grob immediately attached to the event, like @var{\\tweak} does. For
444 attaching a footnote to an @emph{indirectly} caused grob, write
445 @code{\\single\\footnote}, use @var{item} to specify the grob, and
446 follow it with the music to annotate.
448 Like with @code{\\tweak}, if you use a footnote on a following
449 post-event, the @code{\\footnote} command itself needs to be attached
450 to the preceding note or rest as a post-event with @code{-}.")
451 (let ((mus (make-music
453 'X-offset (car offset)
454 'Y-offset (cdr offset)
455 'automatically-numbered (not mark)
456 'text (or mark (make-null-markup))
457 'footnote-text footnote)))
458 #{ \once \tweak footnote-music #mus #item #}))
461 #(def-grace-function startGraceMusic stopGraceMusic
462 (_i "Insert @var{music} as grace notes."))
465 #(define-scheme-function (parser location descriptions) (list?)
466 (_i "Create a context modification from @var{descriptions}, a list
467 in the format of @code{all-grob-descriptions}.")
470 (list 'assign (car p) (list (cdr p))))
473 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
474 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
475 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
477 \set harmonicDots = ##t
478 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
479 \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
480 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
481 (ly:note-head::print grob))
483 (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
485 \revert TabNoteHead.stencil
486 \revert NoteHead.Y-extent
487 \revert NoteHead.stencil
490 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
491 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
492 harmonics played on a fretted instrument by touching the strings at the point
493 given through @var{ratio}.")
495 \set harmonicDots = ##t
496 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
497 \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height
498 (lambda (grob start end)
499 (ly:grob::stencil-height grob)))
500 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
501 (ly:note-head::print grob))
503 (calc-harmonic-pitch (ratio->pitch ratio) music))
505 \revert TabNoteHead.stencil
506 \revert NoteHead.Y-extent
507 \revert NoteHead.stencil
511 #(define-music-function (parser location item) (symbol-list-or-music?)
512 (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
513 making it invisible while still retaining its dimensions.
515 If @var{item} is a symbol list of form @code{GrobName} or
516 @code{Context.GrobName}, the result is an override for the grob name
517 specified by it. If @var{item} is a music expression, the result is
518 the same music expression with an appropriate tweak applied to it.")
519 #{ \tweak transparent ##t #item #})
522 #(define-music-function (parser location) ()
523 (_i "Put the segno variant 'varsegno' at this position into the staff,
524 compatible with the repeat command.")
525 (make-music 'ApplyContext
528 (let ((score-ctx (ly:context-find ctx 'Score)))
529 (if (ly:context? score-ctx)
530 (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
531 (if (eq? (memq 'segno-display old-rc) #f)
532 (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
535 #(define-music-function
536 (parser location name) (string?)
537 (_i "Switch instrument to @var{name}, which must be predefined with
538 @code{\\addInstrumentDefinition}.")
539 (let* ((handle (assoc name instrument-definitions))
540 (instrument-def (if handle (cdr handle) '())))
543 (ly:input-warning location "No such instrument: ~a" name))
545 (make-music 'SimultaneousMusic
557 #(define-music-function (parser location tag music)
558 (symbol-list-or-symbol? ly:music?)
559 (_i "Include only elements of @var{music} that are either untagged
560 or tagged with one of the tags in @var{tag}. @var{tag} may be either
561 a single symbol or a list of symbols.")
565 (let ((music-tags (ly:music-property m 'tags)))
566 (or (null? music-tags)
567 (memq tag music-tags))))
569 (let ((music-tags (ly:music-property m 'tags)))
570 (or (null? music-tags)
571 (any (lambda (t) (memq t music-tags)) tag)))))
575 #(define-music-function (parser location tonic pitch-alist)
576 ((ly:pitch? '()) (list? '()))
577 (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
578 If both are null, just generate @code{KeyChangeEvent}.")
579 (cond ((null? tonic) (make-music 'KeyChangeEvent))
581 (ly:parser-error parser (_ "second argument must be pitch list")
583 (make-music 'SequentialMusic 'void #t))
586 (make-music 'KeyChangeEvent
587 'tonic (ly:make-pitch 0 0 0)
588 'pitch-alist pitch-alist)
592 #(define-music-function (parser location music) (ly:music?)
593 (_i "Remove cue notes from @var{music}.")
596 (if (and (string? (ly:music-property mus 'quoted-music-name))
597 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
598 (ly:music-property mus 'element)
605 #(define-music-function (parser location label) (symbol?)
606 (_i "Create @var{label} as a bookmarking label.")
607 (make-music 'EventChord
610 'elements (list (make-music 'LabelEvent
611 'page-label label))))
615 #(define-void-function (parser location language) (string?)
616 (_i "Set note names for language @var{language}.")
617 (note-names-language parser language))
619 languageSaveAndChange =
620 #(define-void-function (parser location language) (string?)
621 (_i "Store the previous pitchnames alist, and set a new one.")
622 (set! previous-pitchnames pitchnames)
623 (note-names-language parser language))
626 #(define-void-function (parser location) ()
627 (_i "Restore a previously-saved pitchnames alist.")
628 (if previous-pitchnames
630 (set! pitchnames previous-pitchnames)
631 (ly:parser-set-note-names parser pitchnames))
632 (ly:input-warning location (_ "No other language was defined previously. Ignoring."))))
636 #(define-music-function (parser location mag music) (positive? ly:music?)
637 (_i "Magnify the notation of @var{music} without changing the
638 staff-size, using @var{mag} as a size factor. Stems, beams,
639 slurs, ties, and horizontal spacing are adjusted automatically.")
641 ;; these props are NOT allowed to shrink below default size
642 (define unshrinkable-props
649 PhrasingSlur.line-thickness
650 PhrasingSlur.thickness
654 LaissezVibrerTie.line-thickness
655 LaissezVibrerTie.thickness
656 RepeatTie.line-thickness
660 ;; these props ARE allowed to shrink below default size
661 (define shrinkable-props
663 ;; override at the 'Score level
664 SpacingSpanner.spacing-increment
666 ;; Beam.beam-thickness is dealt with separately below
668 ;; lengths and heights
671 Stem.beamlet-default-length
674 PhrasingSlur.height-limit
675 PhrasingSlur.minimum-length
677 ;; every Slur.details prop that's
678 ;; not a factor, penalty, ratio, or slope
679 Slur.details.region-size
680 Slur.details.free-head-distance
681 Slur.details.free-slur-distance
682 Slur.details.gap-to-staffline-inside
683 Slur.details.gap-to-staffline-outside
684 Slur.details.extra-encompass-free-distance
685 Slur.details.extra-encompass-collision-distance
686 Slur.details.close-to-edge-length
687 Slur.details.encompass-object-range-overshoot
688 Slur.details.slur-tie-extrema-min-distance
690 ;; every PhrasingSlur.details prop that's
691 ;; not a factor, penalty, ratio, or slope
692 PhrasingSlur.details.region-size
693 PhrasingSlur.details.free-head-distance
694 PhrasingSlur.details.free-slur-distance
695 PhrasingSlur.details.gap-to-staffline-inside
696 PhrasingSlur.details.gap-to-staffline-outside
697 PhrasingSlur.details.extra-encompass-free-distance
698 PhrasingSlur.details.extra-encompass-collision-distance
699 PhrasingSlur.details.close-to-edge-length
700 PhrasingSlur.details.encompass-object-range-overshoot
701 PhrasingSlur.details.slur-tie-extrema-min-distance
703 ;; every Tie.details prop that's
704 ;; not a factor, penalty, ratio, or slope
705 Tie.details.center-staff-line-clearance
706 Tie.details.tip-staff-line-clearance
707 Tie.details.note-head-gap
709 Tie.details.height-limit
710 Tie.details.tie-tie-collision-distance
711 Tie.details.intra-space-threshold
712 Tie.details.outer-tie-vertical-gap
713 Tie.details.multi-tie-region-size
714 Tie.details.single-tie-region-size
715 Tie.details.between-length-limit
720 #(scale-fontSize mag)
721 #(scale-props unshrinkable-props mag #f)
722 #(scale-props shrinkable-props mag #t)
723 #(scale-beam-thickness mag)
728 %% reverse engineer the former fontSize value instead of using \unset
729 #(revert-fontSize mag)
730 #(revert-props (append unshrinkable-props
732 (list 'Beam.beam-thickness)))
737 #(define-music-function (parser location arg) (ly:music?)
738 (_i "Display chords in @var{arg} as clusters.")
739 (music-map note-to-cluster arg))
742 #(define-music-function (parser location around to scale music)
743 (ly:pitch? ly:pitch? ly:music? ly:music?)
744 (_i "Invert @var{music} about @var{around} using @var{scale} and
745 transpose from @var{around} to @var{to}.")
746 (let ((inverter (make-modal-inverter around to scale)))
747 (change-pitches music inverter)
751 #(define-music-function (parser location from to scale music)
752 (ly:pitch? ly:pitch? ly:music? ly:music?)
753 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
755 (let ((transposer (make-modal-transposer from to scale)))
756 (change-pitches music transposer)
760 #(define-music-function
761 (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
762 (_i "Invert @var{music} about @var{around} and
763 transpose from @var{around} to @var{to}.")
764 (music-invert around to music))
767 #(define-music-function
768 (parser location label) ((scheme? '()))
769 "Make the music for the \\mark command."
770 (let* ((set (and (integer? label)
771 (context-spec-music (make-property-set 'rehearsalMark label)
773 (ev (make-music 'MarkEvent
777 (make-sequential-music (list set ev))
779 (set! (ly:music-property ev 'label) label)
783 #(define-music-function (parser location proc mus) (procedure? ly:music?)
784 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
785 (music-map proc mus))
787 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
788 %% because music identifiers are not allowed at top-level.
790 #(define-music-function (location parser) ()
791 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
792 markups), or inside a score.")
793 (make-music 'EventChord
795 'page-break-permission 'forbid
796 'elements (list (make-music 'PageBreakEvent
797 'break-permission '()))))
800 #(define-music-function (location parser) ()
801 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
802 markups), or inside a score.")
803 (make-music 'EventChord
805 'page-turn-permission 'forbid
806 'elements (list (make-music 'PageTurnEvent
807 'break-permission '()))))
812 #(define-music-function (parser location pitch) (ly:pitch?)
814 (make-music 'RelativeOctaveCheck
818 #(define-music-function (parser location property offsets item)
819 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
820 (_i "Offset the default value of @var{property} of @var{item} by
821 @var{offsets}. If @var{item} is a string, the result is
822 @code{\\override} for the specified grob type. If @var{item} is
823 a music expression, the result is the same music expression with an
824 appropriate tweak applied.")
826 ; In case of a tweak, grob property path is Grob.property
827 (let ((prop-path (check-grob-path
828 (if (symbol? property)
832 #:start 1 #:default #t #:min 2 #:max 2)))
834 ; If the head of the grob property path is a symbol--i.e.,
835 ; a grob name, produce a directed tweak. Otherwise, create
837 (if (symbol? (car prop-path))
839 \tweak #prop-path #(offsetter (second prop-path) offsets) #item
842 \tweak #(second prop-path) #(offsetter (second prop-path) offsets) #item
845 ; In case of an override, grob property path is Context.Grob.property.
846 (let ((prop-path (check-grob-path
848 (if (symbol? property)
852 #:default 'Bottom #:min 3 #:max 3)))
855 \override #prop-path = #(offsetter (third prop-path) offsets)
857 (make-music 'Music)))))
860 #(define-music-function (parser location item) (symbol-list-or-music?)
861 (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
862 effectively omitting it without taking up space.
864 If @var{item} is a symbol list of form @code{GrobName} or
865 @code{Context.GrobName}, the result is an override for the grob name
866 specified by it. If @var{item} is a music expression, the result is
867 the same music expression with an appropriate tweak applied to it.")
868 #{ \tweak stencil ##f #item #})
871 #(define-music-function (parser location music) (ly:music?)
872 (_i "Set @code{once} to @code{#t} on all layout instruction events
873 in @var{music}. This will complain about music with an actual
874 duration. As a special exception, if @var{music} contains
875 @samp{tweaks} it will be silently ignored in order to allow for
876 @code{\\once \\tweak} to work as both one-time override and proper
878 (if (not (pair? (ly:music-property music 'tweaks)))
881 (cond ((music-is-of-type? m 'layout-instruction-event)
882 (set! (ly:music-property m 'once) #t)
884 ((ly:duration? (ly:music-property m 'duration))
885 (ly:music-warning m (_ "Cannot apply \\once to timed music"))
892 #(define-music-function (parser location octave) (integer?)
893 (_i "Set the octavation.")
894 (make-music 'OttavaMusic
895 'ottava-number octave))
897 overrideTimeSignatureSettings =
898 #(define-music-function
899 (parser location time-signature base-moment beat-structure beam-exceptions)
900 (fraction? fraction? list? list?)
902 (_i "Override @code{timeSignatureSettings}
903 for time signatures of @var{time-signature} to have settings
904 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
906 ;; TODO -- add warning if largest value of grouping is
907 ;; greater than time-signature.
908 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
909 (override-time-signature-setting time-signature setting)))
912 #(define-music-function (parser location grob-property-path value)
913 (symbol-list? scheme?)
915 (_i "Set the grob property specified by @var{grob-property-path} to
916 @var{value}. @var{grob-property-path} is a symbol list of the form
917 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
918 with subproperties given as well.")
919 (let ((p (check-grob-path grob-property-path parser location
923 (make-music 'ApplyOutputEvent
924 'context-type (first p)
926 (lambda (grob orig-context context)
928 (cdr (assoc 'name (ly:grob-property grob 'meta)))
930 (ly:grob-set-nested-property!
931 grob (cddr p) value))))
932 (make-music 'Music))))
939 %% pageBreak and pageTurn are music functions (iso music indentifiers),
940 %% because music identifiers are not allowed at top-level.
942 #(define-music-function (location parser) ()
943 (_i "Force a page break. May be used at toplevel (i.e., between scores or
944 markups), or inside a score.")
945 (make-music 'EventChord
947 'line-break-permission 'force
948 'page-break-permission 'force
949 'elements (list (make-music 'LineBreakEvent
950 'break-permission 'force)
951 (make-music 'PageBreakEvent
952 'break-permission 'force))))
955 #(define-music-function (location parser) ()
956 (_i "Force a page turn between two scores or top-level markups.")
957 (make-music 'EventChord
959 'line-break-permission 'force
960 'page-break-permission 'force
961 'page-turn-permission 'force
962 'elements (list (make-music 'LineBreakEvent
963 'break-permission 'force)
964 (make-music 'PageBreakEvent
965 'break-permission 'force)
966 (make-music 'PageTurnEvent
967 'break-permission 'force))))
970 #(define-void-function (parser location voice-ids music) (list? ly:music?)
971 (_i "Define parallel music sequences, separated by '|' (bar check signs),
972 and assign them to the identifiers provided in @var{voice-ids}.
974 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
976 @var{music}: a music sequence, containing BarChecks as limiting expressions.
981 \\parallelMusic #'(A B C) {
991 (define voice-count (length voice-ids))
992 (define (bar-check? m)
993 "Checks whether m is a bar check."
994 (eq? (ly:music-property m 'name) 'BarCheck))
995 (define (recurse-and-split-list lst)
996 "Return either a list of music lists split along barchecks, or @code{#f}."
997 (if (any bar-check? lst)
998 (let* ((voices (apply circular-list (make-list voice-count '())))
999 (current-voices voices)
1000 (current-sequence '()))
1003 (define (push-music m)
1004 "Push the music expression into the current sequence"
1005 (set! current-sequence (cons m current-sequence)))
1006 (define (change-voice)
1007 "Store the previously built sequence into the current voice and
1008 change to the following voice."
1009 (set-car! current-voices
1010 (cons (reverse! current-sequence)
1011 (car current-voices)))
1012 (set! current-sequence '())
1013 (set! current-voices (cdr current-voices)))
1014 (for-each (lambda (m)
1015 (let ((split? (recurse-and-split m)))
1024 (if (bar-check? m) (change-voice))))))
1026 (if (pair? current-sequence) (change-voice))
1027 ;; un-circularize `voices' and reorder the voices
1028 (set! voices (map reverse!
1029 (list-head voices voice-count)))
1030 ;; check sequence length
1031 (apply for-each (lambda seqs
1032 (define (seq-len seq)
1033 (reduce ly:moment-add
1035 (map ly:music-length seq)))
1036 (let ((moment-reference (seq-len (car seqs))))
1037 (for-each (lambda (seq)
1038 (if (not (equal? (seq-len seq)
1044 (_ "Bars in parallel music don't have the same length"))))
1047 (map concatenate! voices))
1048 (let ((deeper (map recurse-and-split lst)))
1049 (and (any pair? deeper)
1053 (ly:music-deep-copy (make-list voice-count m))))
1055 (define (recurse-and-split music)
1056 "This returns either a list of music split along barchecks, or
1058 (let* ((elt (ly:music-property music 'element))
1059 (elts (ly:music-property music 'elements))
1060 (split-elt (and (ly:music? elt) (recurse-and-split elt)))
1061 (split-elts (and (pair? elts) (recurse-and-split-list elts))))
1062 (and (or split-elt split-elts)
1065 (apply music-clone music
1067 ;; reassigning the origin of the parent only
1068 ;; makes sense if the first expression in the
1069 ;; result is from a distributed origin
1072 (and (ly:music? e) (ly:music-property e 'origin #f))
1073 (and (pair? es) (ly:music-property (car es) 'origin #f)))))
1074 (if origin (list 'origin origin) '()))
1075 (if (ly:music? e) (list 'element e) '())
1076 (if (pair? es) (list 'elements es) '()))))
1077 (or split-elt (circular-list #f))
1078 (or split-elts (circular-list #f))))))
1079 (let ((voices (recurse-and-split music)))
1082 ;; bind voice identifiers to the voices
1083 (for-each (lambda (voice-id voice)
1084 (ly:parser-define! parser voice-id voice))
1086 (ly:music-warning music
1087 (_ "ignoring parallel music without barchecks")))))
1090 #(define-music-function (parser loc arg) (ly:music?)
1091 (_i "Tag @var{arg} to be parenthesized.")
1093 (if (memq 'event-chord (ly:music-property arg 'types))
1094 ;; arg is an EventChord -> set the parenthesize property
1095 ;; on all child notes and rests
1098 (if (or (memq 'note-event (ly:music-property ev 'types))
1099 (memq 'rest-event (ly:music-property ev 'types)))
1100 (set! (ly:music-property ev 'parenthesize) #t)))
1101 (ly:music-property arg 'elements))
1102 ;; No chord, simply set property for this expression:
1103 (set! (ly:music-property arg 'parenthesize) #t))
1107 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
1108 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1109 that they share a staff.")
1110 (make-part-combine-music parser
1111 (list part1 part2) #f))
1114 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
1115 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1116 that they share a staff with stems directed upward.")
1117 (make-part-combine-music parser
1118 (list part1 part2) UP))
1121 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
1122 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1123 that they share a staff with stems directed downward.")
1124 (make-part-combine-music parser
1125 (list part1 part2) DOWN))
1128 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
1129 (_i "Override the part-combiner.")
1130 (make-music 'EventChord
1131 'elements (list (make-music 'PartCombineForceEvent
1134 partcombineApart = \partcombineForce #'apart ##f
1135 partcombineApartOnce = \partcombineForce #'apart ##t
1136 partcombineChords = \partcombineForce #'chords ##f
1137 partcombineChordsOnce = \partcombineForce #'chords ##t
1138 partcombineUnisono = \partcombineForce #'unisono ##f
1139 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
1140 partcombineSoloI = \partcombineForce #'solo1 ##f
1141 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
1142 partcombineSoloII = \partcombineForce #'solo2 ##f
1143 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
1144 partcombineAutomatic = \partcombineForce ##f ##f
1145 partcombineAutomaticOnce = \partcombineForce ##f ##t
1148 #(define-music-function (parser location dur) (ly:duration?)
1149 (_i "Make a partial measure.")
1151 ;; We use `descend-to-context' here instead of `context-spec-music' to
1152 ;; ensure \partial still works if the Timing_translator is moved
1154 (context-spec-music (make-music 'PartialSet
1161 #(define-music-function
1162 (parser location main-note secondary-note)
1163 (ly:music? ly:music?)
1164 (_i "Print a trill with @var{main-note} as the main note of the trill and
1165 print @var{secondary-note} as a stemless note head in parentheses.")
1166 (let* ((get-notes (lambda (ev-chord)
1167 (extract-named-music ev-chord 'NoteEvent)))
1168 (sec-note-events (get-notes secondary-note))
1169 (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1170 (if (pair? sec-note-events)
1172 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1173 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1175 (if (ly:pitch? trill-pitch)
1176 (for-each (lambda (m)
1177 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1179 (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
1180 (display sec-note-events)))
1183 (for-each (lambda (m)
1184 (ly:music-set-property! m 'force-accidental forced))
1189 #(define-music-function (parser location tag more music)
1190 (symbol? ly:music? ly:music?)
1191 (_i "Add @var{more} to the front of @code{elements} of all music
1192 expressions in @var{music} that are tagged with @var{tag}.")
1193 (music-map (lambda (m)
1194 (if (memq tag (ly:music-property m 'tags))
1195 (set! (ly:music-property m 'elements)
1196 (cons more (ly:music-property m 'elements))))
1201 #(define-music-function (parser location what main-music) (string? ly:music?)
1202 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
1203 of the quoted voice, as specified in an @code{\\addQuote} command.
1204 @var{main-music} is used to indicate the length of music to be quoted;
1205 usually contains spacers or multi-measure rests.")
1206 (make-music 'QuoteMusic
1208 'quoted-music-name what))
1211 #(define-music-function (parser location pitch music)
1212 ((ly:pitch?) ly:music?)
1213 (_i "Make @var{music} relative to @var{pitch}. If @var{pitch} is
1214 omitted, the first note in @var{music} is given in absolute pitch.")
1215 ;; When \relative has no clear decision (can only happen with
1216 ;; scales with an even number of steps), it goes down (see
1217 ;; pitch.cc). The following formula puts out f for both the normal
1218 ;; 7-step scale as well as for a "shortened" scale missing the
1219 ;; final b. In either case, a first note of c will end up as c,
1220 ;; namely pitch (-1, 0, 0).
1221 (ly:make-music-relative! music
1226 ;; size of current scale:
1227 (ly:pitch-steps (ly:make-pitch 1 0))
1229 (make-music 'RelativeOctaveMusic
1233 #(define-music-function (parser location tag music)
1234 (symbol-list-or-symbol? ly:music?)
1235 (_i "Remove elements of @var{music} that are tagged with one of the
1236 tags in @var{tag}. @var{tag} may be either a single symbol or a list
1241 (not (memq tag (ly:music-property m 'tags))))
1243 (let ((music-tags (ly:music-property m 'tags)))
1244 (or (null? music-tags)
1245 (not (any (lambda (t) (memq t music-tags)) tag))))))
1248 resetRelativeOctave =
1249 #(define-music-function (parser location pitch) (ly:pitch?)
1250 (_i "Set the octave inside a \\relative section.")
1252 (make-music 'SequentialMusic
1253 'to-relative-callback
1254 (lambda (music last-pitch) pitch)))
1257 #(define-music-function (parser location music)
1259 (_i "Return @var{music} in reverse order.")
1260 (retrograde-music music))
1262 revertTimeSignatureSettings =
1263 #(define-music-function
1264 (parser location time-signature)
1267 (_i "Revert @code{timeSignatureSettings}
1268 for time signatures of @var{time-signature}.")
1269 (revert-time-signature-setting time-signature))
1272 #(define-event-function (parser location finger) (number-or-markup?)
1273 (_i "Apply @var{finger} as a fingering indication.")
1277 (if (number? finger) 'digit 'text)
1281 #(define-music-function (parser location fraction music)
1282 (fraction? ly:music?)
1283 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1284 (ly:music-compress music
1285 (ly:make-moment (car fraction) (cdr fraction))))
1288 #(define-scheme-function (parser location ctx music)
1289 ((symbol?) ly:music?)
1290 (_i "Take the layout instruction events from @var{music}, optionally
1291 restricted to those applying to context type @var{ctx}, and return
1292 a context modification duplicating their effect.")
1293 (let ((mods (ly:make-context-mod)))
1295 (if (music-is-of-type? m 'layout-instruction-event)
1298 (case (ly:music-property m 'name)
1301 (ly:music-property m 'symbol)
1302 (ly:music-property m 'value)))
1305 (ly:music-property m 'symbol)))
1308 (ly:music-property m 'symbol)
1309 (ly:music-property m 'grob-value)
1311 ((ly:music-property m 'grob-property #f) => list)
1313 (ly:music-property m 'grob-property-path)))))
1316 (ly:music-property m 'symbol)
1318 ((ly:music-property m 'grob-property #f) => list)
1320 (ly:music-property m 'grob-property-path)))))))
1321 (case (ly:music-property m 'name)
1323 (ly:add-context-mod mods
1325 (ly:music-property m 'procedure))))
1326 ((ContextSpeccedMusic)
1328 (eq? ctx (ly:music-property m 'context-type)))
1329 (musicop (ly:music-property m 'element))))
1331 (let ((callback (ly:music-property m 'elements-callback)))
1332 (if (procedure? callback)
1333 (for-each musicop (callback m))))))))
1338 #(define-music-function (parser location offsets item)
1339 (list? symbol-list-or-music?)
1340 (_i "Offset control-points of @var{item} by @var{offsets}. The
1341 argument is a list of number pairs or list of such lists. Each
1342 element of a pair represents an offset to one of the coordinates of a
1343 control-point. If @var{item} is a string, the result is
1344 @code{\\once\\override} for the specified grob type. If @var{item} is
1345 a music expression, the result is the same music expression with an
1346 appropriate tweak applied.")
1347 (define (shape-curve grob)
1348 (let* ((orig (ly:grob-original grob))
1349 (siblings (if (ly:spanner? grob)
1350 (ly:spanner-broken-into orig) '()))
1351 (total-found (length siblings))
1352 (function (assoc-get 'control-points
1353 (reverse (ly:grob-basic-properties grob))))
1354 (coords (function grob)))
1356 (define (offset-control-points offsets)
1360 (lambda (x y) (coord-translate x y))
1363 (define (helper sibs offs)
1365 (if (eq? (car sibs) grob)
1366 (offset-control-points (car offs))
1367 (helper (cdr sibs) (cdr offs)))
1370 ;; we work with lists of lists
1371 (if (or (null? offsets)
1372 (not (list? (car offsets))))
1373 (set! offsets (list offsets)))
1375 (if (>= total-found 2)
1376 (helper siblings offsets)
1377 (offset-control-points (car offsets)))))
1378 #{ \once \tweak control-points #shape-curve #item #})
1381 #(define-music-function (parser location dur dots arg)
1382 (integer? integer? ly:music?)
1383 (_i "Change the duration of @var{arg} by adding @var{dur} to the
1384 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1386 (shift-duration-log arg dur dots))
1389 #(define-music-function (parser location overrides music)
1390 (ly:music? ly:music?)
1391 (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1392 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1393 (set! (ly:music-property music 'tweaks)
1395 (lambda (m) (eq? (ly:music-property m 'name)
1399 ((ly:music-property m 'grob-property #f) => list)
1401 (ly:music-property m 'grob-property-path)))))
1402 (acons (cons (ly:music-property m 'symbol) ;grob name
1404 p ;grob property path
1405 (car p))) ;grob property
1406 (ly:music-property m 'grob-value)
1408 (ly:music-property music 'tweaks)
1413 #(define-music-function (parser location dur) (ly:duration?)
1414 (_i "Skip forward by @var{dur}.")
1415 (make-music 'SkipMusic
1420 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1421 (_i "Create slashed graces (slashes through stems, but no slur) from
1422 the following music expression"))
1425 #(define-music-function (parser location parameters) (list?)
1426 (_i "Set the system stretch, by reading the 'system-stretch property of
1427 the `parameters' assoc list.")
1429 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1430 #(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1431 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
1435 #(define-music-function (parser location style heads music)
1436 (symbol? symbol-list-or-symbol? ly:music?)
1437 (_i "Set @var{heads} in @var{music} to @var{style}.")
1438 (style-note-heads heads style music))
1441 #(define-music-function (parser location tag music) (symbol-list-or-symbol? ly:music?)
1442 (_i "Tag the following @var{music} with @var{tag} and return the
1443 result, by adding the single symbol or symbol list @var{tag} to the
1444 @code{tags} property of @var{music}.")
1447 (ly:music-property music 'tags)
1448 ((if (symbol? tag) cons append)
1450 (ly:music-property music 'tags)))
1454 #(define-music-function (parser location music)
1456 (_i "Make any @code{\\override} in @var{music} replace an existing
1457 grob property value only temporarily, restoring the old value when a
1458 corresponding @code{\\revert} is executed. This is achieved by
1459 clearing the @samp{pop-first} property normally set on
1462 An @code{\\override}/@/@code{\\revert} sequence created by using
1463 @code{\\temporary} and @code{\\undo} on the same music containing
1464 overrides will cancel out perfectly or cause a@tie{}warning.
1466 Non-property-related music is ignored, warnings are generated for any
1467 property-changing music that isn't an @code{\\override}.")
1471 (and (or (music-is-of-type? m 'layout-instruction-event)
1472 (music-is-of-type? m 'context-specification)
1473 (music-is-of-type? m 'apply-context)
1474 (music-is-of-type? m 'time-signature-music))
1475 (case (ly:music-property m 'name)
1477 (if (ly:music-property m 'pop-first #f)
1478 (set! (ly:music-property m 'pop-first) '()))
1479 (if (ly:music-property m 'once #f)
1480 (set! (ly:music-property m 'once) '()))
1482 ((ContextSpeccedMusic)
1487 (ly:input-warning location (_ "Cannot make ~a revertible")
1488 (ly:music-property m 'name))
1495 #(define-music-function (parser location beat-structure fraction)
1496 ((number-list? '()) fraction?)
1497 (_i "Set @var{fraction} as time signature, with optional
1498 number list @var{beat-structure} before it.")
1499 (make-music 'TimeSignatureMusic
1500 'numerator (car fraction)
1501 'denominator (cdr fraction)
1502 'beat-structure beat-structure))
1505 #(define-music-function (parser location fraction music)
1506 (fraction? ly:music?)
1507 (_i "Scale @var{music} in time by @var{fraction}.")
1508 (make-music 'TimeScaledMusic
1509 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1510 'numerator (car fraction)
1511 'denominator (cdr fraction)))
1514 #(define-music-function
1515 (parser location from to music)
1516 (ly:pitch? ly:pitch? ly:music?)
1518 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1519 (make-music 'TransposedMusic
1520 'element (ly:music-transpose music (ly:pitch-diff to from))))
1522 transposedCueDuring =
1523 #(define-music-function
1524 (parser location what dir pitch main-music)
1525 (string? ly:dir? ly:pitch? ly:music?)
1527 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1528 using the transposition defined by @var{pitch}. This happens
1529 simultaneously with @var{main-music}, which is usually a rest. The
1530 argument @var{dir} determines whether the cue notes should be notated
1531 as a first or second voice.")
1533 (make-music 'QuoteMusic
1535 'quoted-context-type 'CueVoice
1536 'quoted-context-id "cue"
1537 'quoted-music-name what
1538 'quoted-voice-direction dir
1539 ;; following is inverse of instrumentTransposition for
1540 ;; historical reasons
1541 'quoted-transposition pitch))
1544 #(define-music-function (parser location pitch) (ly:pitch?)
1545 (_i "Set instrument transposition")
1548 (make-property-set 'instrumentTransposition pitch)
1552 #(define-music-function (parser location ratio tuplet-span music)
1553 (fraction? (ly:duration? '()) ly:music?)
1554 (_i "Scale the given @var{music} to tuplets. @var{ratio} is a
1555 fraction that specifies how many notes are played in place of the
1556 nominal value: it will be @samp{3/2} for triplets, namely three notes
1557 being played in place of two. If the optional duration
1558 @var{tuplet-span} is specified, it is used instead of
1559 @code{tupletSpannerDuration} for grouping the tuplets.
1562 \\tuplet 3/2 4 @{ c8 c c c c c @}
1564 will result in two groups of three tuplets, each group lasting for a
1566 (make-music 'TimeScaledMusic
1567 'element (ly:music-compress
1569 (ly:make-moment (cdr ratio) (car ratio)))
1570 'numerator (cdr ratio)
1571 'denominator (car ratio)
1572 'duration tuplet-span))
1575 #(define-music-function (parser location tuplet-span)
1577 (_i "Set @code{tupletSpannerDuration}, the length into which
1578 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1579 own will group its tuplets, to the duration @var{tuplet-span}. To
1580 revert to the default of not subdividing the contents of a @code{\\tuplet}
1581 command without explicit @samp{tuplet-span}, use
1583 \\tupletSpan \\default
1587 #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1588 #{ \unset tupletSpannerDuration #}))
1591 #(define-music-function (parser location prop value item)
1592 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1593 (_i "Add a tweak to the following @var{item}, usually music.
1594 Layout objects created by @var{item} get their property @var{prop}
1595 set to @var{value}. If @var{prop} has the form @samp{Grob.property}, like with
1597 \\tweak Accidental.color #red cis'
1599 an indirectly created grob (@samp{Accidental} is caused by
1600 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1603 As a special case, @var{item} may be a symbol list specifying a grob
1604 path, in which case @code{\\override} is called on it instead of
1605 creating tweaked music. This is mainly useful when using
1606 @code{\\tweak} as as a component for building other functions.
1608 If this use case would call for @code{\\once \\override} rather than a
1609 plain @code{\\override}, writing @code{\\once \\tweak @dots{}} can be
1612 @var{prop} can contain additional elements in which case a nested
1613 property (inside of an alist) is tweaked.")
1614 (if (ly:music? item)
1615 (let ((p (check-grob-path prop parser location
1620 (set! (ly:music-property item 'tweaks)
1621 (acons (cond ((pair? (cddr p)) p)
1623 (cons (car p) (cadr p)))
1626 (ly:music-property item 'tweaks))))
1628 ;; We could just throw this at \override and let it sort this
1629 ;; out on its own, but this way we should get better error
1631 (let ((p (check-grob-path
1632 (append item (if (symbol? prop) (list prop) prop))
1634 #:default 'Bottom #:min 3)))
1636 #{ \override #p = #value #}
1637 (make-music 'Music)))))
1640 #(define-music-function (parser location music)
1642 (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1643 @code{\\revert} and @code{\\unset}, respectively. Any reverts and
1644 unsets already in @var{music} cause a warning. Non-property-related music is ignored.")
1651 (lambda (m) (or (music-is-of-type? m 'layout-instruction-event)
1652 (music-is-of-type? m 'context-specification)
1653 (music-is-of-type? m 'apply-context)
1654 (music-is-of-type? m 'time-signature-music)))
1655 (lambda (m overrides)
1656 (case (ly:music-property m 'name)
1659 (make-music 'RevertProperty
1660 'symbol (ly:music-property m 'symbol)
1663 ((ly:music-property m 'grob-property #f) => list)
1665 (ly:music-property m 'grob-property-path))))
1669 (make-music 'PropertyUnset
1670 'symbol (ly:music-property m 'symbol))
1672 ((ContextSpeccedMusic)
1674 (make-music 'ContextSpeccedMusic
1675 'element (loop (ly:music-property m 'element))
1676 'context-type (ly:music-property m 'context-type))
1681 (ly:input-warning location (_ "Cannot revert ~a")
1682 (ly:music-property m 'name))
1688 ((null? lst) (make-music 'Music))
1689 ((null? (cdr lst)) (car lst))
1690 (else (make-sequential-music lst))))))
1693 #(define-music-function (parser location music) (ly:music?)
1694 (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1695 @code{\\repeat percent} commands in @var{music} to be interpreted
1696 as @code{\\repeat unfold}.")
1697 (unfold-repeats music))
1700 #(define-void-function (parser location arg) (scheme?)
1701 (_i "Accept a scheme argument, return a void expression.
1702 Use this if you want to have a scheme expression evaluated
1703 because of its side-effects, but its value ignored."))
1706 #(define-music-function (parser location sym val music)
1707 (symbol? scheme? ly:music?)
1708 (_i "Set @var{sym} to @var{val} in @var{music}.")
1710 (set! (ly:music-property music sym) val)