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))
259 #(define-music-function (parser location type) (string?)
260 (_i "Set the current clef to @var{type}.")
261 (make-clef-set type))
265 #(define-music-function (parser location args) (pair?)
266 (_i "Create compound time signatures. The argument is a Scheme list of
267 lists. Each list describes one fraction, with the last entry being the
268 denominator, while the first entries describe the summands in the
269 enumerator. If the time signature consists of just one fraction,
270 the list can be given directly, i.e. not as a list containing a single list.
271 For example, a time signature of (3+1)/8 + 2/4 would be created as
272 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
273 as @code{\\compoundMeter #'((3 2 8))} or shorter
274 @code{\\compoundMeter #'(3 2 8)}.")
275 (let* ((mlen (calculate-compound-measure-length args))
276 (beat (calculate-compound-base-beat args))
277 (beatGrouping (calculate-compound-beat-grouping args))
278 (timesig (cons (ly:moment-main-numerator mlen)
279 (ly:moment-main-denominator mlen))))
281 \once \override Timing.TimeSignature.stencil = #(lambda (grob)
282 (grob-interpret-markup grob (make-compound-meter-markup args)))
283 \set Timing.timeSignatureFraction = #timesig
284 \set Timing.baseMoment = #beat
285 \set Timing.beatStructure = #beatGrouping
286 \set Timing.beamExceptions = #'()
287 \set Timing.measureLength = #mlen
291 #(define-music-function (parser location notes) (ly:music?)
292 (_i "Create cross-staff stems")
294 \temporary \override Stem.cross-staff = #cross-staff-connect
295 \temporary \override Flag.style = #'no-flag
297 \revert Stem.cross-staff
302 #(define-music-function (parser location type) (string?)
303 (_i "Set the current cue clef to @var{type}.")
304 (make-cue-clef-set type))
307 #(define-music-function (parser location) ()
308 (_i "Unset the current cue clef.")
309 (make-cue-clef-unset))
312 #(define-music-function
313 (parser location what dir main-music) (string? ly:dir? ly:music?)
314 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
315 in a CueVoice oriented by @var{dir}.")
316 (make-music 'QuoteMusic
318 'quoted-context-type 'CueVoice
319 'quoted-context-id "cue"
320 'quoted-music-name what
321 'quoted-voice-direction dir))
324 #(define-music-function
325 (parser location what dir clef main-music) (string? ly:dir? string? ly:music?)
326 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
327 in a CueVoice oriented by @var{dir}.")
328 (make-music 'QuoteMusic
330 'quoted-context-type 'CueVoice
331 'quoted-context-id "cue"
332 'quoted-music-name what
333 'quoted-music-clef clef
334 'quoted-voice-direction dir))
339 #(define-music-function (parser location port music) ((output-port?) ly:music?)
340 (_i "Display the LilyPond input representation of @var{music}
341 to @var{port}, defaulting to the console.")
342 (let ((port (or port (current-output-port))))
344 (display-lily-music music parser port))
348 #(define-music-function (parser location port music) ((output-port?) ly:music?)
349 (_i "Display the internal representation of @var{music} to
350 @var{port}, default to the console.")
351 (let ((port (or port (current-output-port))))
353 (display-scheme-music music port))
357 #(define-scheme-function (parser location port expr) ((output-port?) scheme?)
358 (_i "Display the internal representation of @var{expr} to
359 @var{port}, default to the console.")
360 (let ((port (or port (current-output-port))))
362 (display-scheme-music expr port))
368 #(define-music-function (parser location music) (ly:music?)
369 (_i "Terminate the next spanner prematurely after exactly one note
370 without the need of a specific end spanner.")
371 (let* ((start-span-evs (filter (lambda (ev)
372 (equal? (ly:music-property ev 'span-direction)
374 (extract-typed-music music 'span-event)))
377 (music-clone m 'span-direction STOP))
379 (end-ev-chord (make-music 'EventChord
380 'elements stop-span-evs))
381 (total (make-music 'SequentialMusic
382 'elements (list music
387 #(define-music-function (parser location music) (ly:music?)
388 (_i "Compatibility function wrapping @code{EventChord} around
389 isolated rhythmic events occuring since version 2.15.28, after
390 expanding repeat chords @samp{q}.")
391 (event-chord-wrap! music parser))
394 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
395 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
396 (let ((orig-duration (ly:music-length argument))
397 (multiplier (ly:make-moment 1 1)))
401 (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
403 (ly:music-compress mus multiplier)
404 (set! multiplier (ly:moment-mul factor multiplier)))))
405 (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
408 (ly:moment-div orig-duration (ly:music-length argument)))
413 #(define-event-function (parser location finger) (number-or-markup?)
414 (_i "Apply @var{finger} as a fingering indication.")
418 (if (number? finger) 'digit 'text)
422 #(define-music-function (parser location mark offset footnote item)
423 ((markup?) number-pair? markup? symbol-list-or-music?)
424 (_i "Make the markup @var{footnote} a footnote on @var{item}. The
425 footnote is marked with a markup @var{mark} moved by @var{offset} with
426 respect to the marked music.
428 If @var{mark} is not given or specified as @var{\\default}, it is
429 replaced by an automatically generated sequence number. If @var{item}
430 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
431 grobs of that type will be marked at the current time step in the
432 given context (default @code{Bottom}).
434 If @var{item} is music, the music will get a footnote attached to a
435 grob immediately attached to the event, like @var{\\tweak} does. For
436 attaching a footnote to an @emph{indirectly} caused grob, write
437 @code{\\single\\footnote}, use @var{item} to specify the grob, and
438 follow it with the music to annotate.
440 Like with @code{\\tweak}, if you use a footnote on a following
441 post-event, the @code{\\footnote} command itself needs to be attached
442 to the preceding note or rest as a post-event with @code{-}.")
443 (let ((mus (make-music
445 'X-offset (car offset)
446 'Y-offset (cdr offset)
447 'automatically-numbered (not mark)
448 'text (or mark (make-null-markup))
449 'footnote-text footnote)))
450 #{ \once \tweak footnote-music #mus #item #}))
453 #(def-grace-function startGraceMusic stopGraceMusic
454 (_i "Insert @var{music} as grace notes."))
457 #(define-scheme-function (parser location descriptions) (list?)
458 (_i "Create a context modification from @var{descriptions}, a list
459 in the format of @code{all-grob-descriptions}.")
462 (list 'assign (car p) (ly:make-grob-properties (cdr p))))
465 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
466 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
467 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
469 \set harmonicDots = ##t
470 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
471 \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
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 (fret->pitch (number->string fret)) music))
477 \revert TabNoteHead.stencil
478 \revert NoteHead.Y-extent
479 \revert NoteHead.stencil
482 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
483 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
484 harmonics played on a fretted instrument by touching the strings at the point
485 given through @var{ratio}.")
487 \set harmonicDots = ##t
488 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
489 \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height
490 (lambda (grob start end)
491 (ly:grob::stencil-height grob)))
492 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
493 (ly:note-head::print grob))
495 (calc-harmonic-pitch (ratio->pitch ratio) music))
497 \revert TabNoteHead.stencil
498 \revert NoteHead.Y-extent
499 \revert NoteHead.stencil
503 #(define-music-function (parser location item) (symbol-list-or-music?)
504 (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
505 making it invisible while still retaining its dimensions.
507 If @var{item} is a symbol list of form @code{GrobName} or
508 @code{Context.GrobName}, the result is an override for the grob name
509 specified by it. If @var{item} is a music expression, the result is
510 the same music expression with an appropriate tweak applied to it.")
511 #{ \tweak transparent ##t #item #})
514 #(define-music-function (parser location) ()
515 (_i "Put the segno variant 'varsegno' at this position into the staff,
516 compatible with the repeat command.")
517 (make-music 'ApplyContext
520 (let ((score-ctx (ly:context-find ctx 'Score)))
521 (if (ly:context? score-ctx)
522 (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
523 (if (eq? (memq 'segno-display old-rc) #f)
524 (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
527 #(define-music-function
528 (parser location name) (string?)
529 (_i "Switch instrument to @var{name}, which must be predefined with
530 @code{\\addInstrumentDefinition}.")
531 (let* ((handle (assoc name instrument-definitions))
532 (instrument-def (if handle (cdr handle) '())))
535 (ly:input-warning location "No such instrument: ~a" name))
537 (make-music 'SimultaneousMusic
549 #(define-music-function (parser location tags music)
550 (symbol-list-or-symbol? ly:music?)
551 (_i "Include only elements of @var{music} that are tagged with one
552 of the tags in @var{tags}. @var{tags} may be either a single symbol
553 or a list of symbols.
555 Each tag may be declared as a member of at most one tag group (defined
556 with @code{\\tagGroup}). If none of a @var{music} element's tags
557 share a tag group with one of the specified @var{tags}, the element is
560 (tags-keep-predicate tags)
564 #(define-music-function (parser location tonic pitch-alist)
565 ((ly:pitch? '()) (list? '()))
566 (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
567 If both are null, just generate @code{KeyChangeEvent}.")
568 (cond ((null? tonic) (make-music 'KeyChangeEvent))
570 (ly:parser-error parser (_ "second argument must be pitch list")
572 (make-music 'SequentialMusic 'void #t))
575 (make-music 'KeyChangeEvent
576 'tonic (ly:make-pitch 0 0 0)
577 'pitch-alist pitch-alist)
581 #(define-music-function (parser location music) (ly:music?)
582 (_i "Remove cue notes from @var{music}.")
585 (if (and (string? (ly:music-property mus 'quoted-music-name))
586 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
587 (ly:music-property mus 'element)
594 #(define-music-function (parser location label) (symbol?)
595 (_i "Create @var{label} as a bookmarking label.")
596 (make-music 'EventChord
599 'elements (list (make-music 'LabelEvent
600 'page-label label))))
604 #(define-void-function (parser location language) (string?)
605 (_i "Set note names for language @var{language}.")
606 (note-names-language parser language))
608 languageSaveAndChange =
609 #(define-void-function (parser location language) (string?)
610 (_i "Store the previous pitchnames alist, and set a new one.")
611 (set! previous-pitchnames pitchnames)
612 (note-names-language parser language))
615 #(define-void-function (parser location) ()
616 (_i "Restore a previously-saved pitchnames alist.")
617 (if previous-pitchnames
619 (set! pitchnames previous-pitchnames)
620 (ly:parser-set-note-names parser pitchnames))
621 (ly:input-warning location (_ "No other language was defined previously. Ignoring."))))
625 #(define-music-function (parser location mag music) (positive? ly:music?)
626 (_i "Magnify the notation of @var{music} without changing the
627 staff-size, using @var{mag} as a size factor. Stems, beams,
628 slurs, ties, and horizontal spacing are adjusted automatically.")
630 ;; these props are NOT allowed to shrink below default size
631 (define unshrinkable-props
637 (Slur line-thickness)
639 (PhrasingSlur line-thickness)
640 (PhrasingSlur thickness)
645 (LaissezVibrerTie line-thickness)
646 (LaissezVibrerTie thickness)
647 (RepeatTie line-thickness)
648 (RepeatTie thickness)
651 ;; these props ARE allowed to shrink below default size
652 (define shrinkable-props
653 (let ((baseline-skip-props
654 (find-named-props 'baseline-skip all-grob-descriptions))
656 (find-named-props 'word-space all-grob-descriptions)))
661 ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed
662 ;; override at the 'Score level
663 ;(SpacingSpanner spacing-increment)
665 ;; lengths and heights
666 (Beam length-fraction)
667 (Stem length-fraction)
668 (Stem beamlet-default-length)
669 (Stem double-stem-separation)
671 (Slur minimum-length)
672 (PhrasingSlur height-limit)
673 (PhrasingSlur minimum-length)
675 ;; Beam.beam-thickness is dealt with separately below
679 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
681 #(scale-fontSize 'magnifyMusic mag)
682 #(scale-props 'magnifyMusic mag #f unshrinkable-props)
683 #(scale-props 'magnifyMusic mag #t shrinkable-props)
684 #(scale-beam-thickness mag)
688 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
690 %% reverse engineer the former fontSize value instead of using \unset
691 #(revert-fontSize 'magnifyMusic mag)
692 #(revert-props 'magnifyMusic mag (append unshrinkable-props
694 '((Beam beam-thickness))))
699 #(define-music-function (parser location mag) (positive?)
700 (_i "Change the size of the staff, adjusting notation size and
701 horizontal spacing automatically, using @var{mag} as a size factor.")
703 ;; these props are NOT allowed to shrink below default size
704 (define unshrinkable-props
705 '((StaffSymbol thickness)))
707 ;; these props ARE allowed to shrink below default size
708 (define shrinkable-props
709 (let* ((baseline-skip-props
710 (find-named-props 'baseline-skip all-grob-descriptions))
712 (find-named-props 'word-space all-grob-descriptions))
714 (find-named-props 'space-alist all-grob-descriptions)))
720 ;; override at the 'Score level
721 (SpacingSpanner spacing-increment)
723 (StaffSymbol staff-space)
726 (BarLine hair-thickness)
727 (BarLine thick-thickness)
728 (Stem beamlet-default-length)
729 (Stem double-stem-separation)
735 %% revert settings from last time
736 %% (but only if \magnifyStaff has already been used
737 %% and the staff magnification is changing)
738 #(revert-fontSize 'magnifyStaff mag)
739 #(revert-props 'magnifyStaff mag (append unshrinkable-props
743 %% (but only if staff magnification is changing
744 %% and does not equal 1)
745 #(scale-fontSize 'magnifyStaff mag)
746 #(scale-props 'magnifyStaff mag #f unshrinkable-props)
747 #(scale-props 'magnifyStaff mag #t shrinkable-props)
749 %% this might cause problems until Issue 3990 is fixed
753 \set Staff.magnifyStaffValue = #mag
757 #(define-music-function (parser location arg) (ly:music?)
758 (_i "Display chords in @var{arg} as clusters.")
759 (music-map note-to-cluster arg))
762 #(define-music-function (parser location around to scale music)
763 (ly:pitch? ly:pitch? ly:music? ly:music?)
764 (_i "Invert @var{music} about @var{around} using @var{scale} and
765 transpose from @var{around} to @var{to}.")
766 (let ((inverter (make-modal-inverter around to scale)))
767 (change-pitches music inverter)
771 #(define-music-function (parser location from to scale music)
772 (ly:pitch? ly:pitch? ly:music? ly:music?)
773 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
775 (let ((transposer (make-modal-transposer from to scale)))
776 (change-pitches music transposer)
780 #(define-music-function
781 (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
782 (_i "Invert @var{music} about @var{around} and
783 transpose from @var{around} to @var{to}.")
784 (music-invert around to music))
787 #(define-music-function
788 (parser location label) ((scheme? '()))
789 "Make the music for the \\mark command."
790 (let* ((set (and (integer? label)
791 (context-spec-music (make-property-set 'rehearsalMark label)
793 (ev (make-music 'MarkEvent
797 (make-sequential-music (list set ev))
799 (set! (ly:music-property ev 'label) label)
803 #(define-music-function (parser location proc mus) (procedure? ly:music?)
804 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
805 (music-map proc mus))
807 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
808 %% because music identifiers are not allowed at top-level.
810 #(define-music-function (location parser) ()
811 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
812 markups), or inside a score.")
813 (make-music 'EventChord
815 'page-break-permission 'forbid
816 'elements (list (make-music 'PageBreakEvent
817 'break-permission '()))))
820 #(define-music-function (location parser) ()
821 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
822 markups), or inside a score.")
823 (make-music 'EventChord
825 'page-turn-permission 'forbid
826 'elements (list (make-music 'PageTurnEvent
827 'break-permission '()))))
832 #(define-music-function (parser location pitch) (ly:pitch?)
834 (make-music 'RelativeOctaveCheck
838 #(define-music-function (parser location property offsets item)
839 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
840 (_i "Offset the default value of @var{property} of @var{item} by
841 @var{offsets}. If @var{item} is a string, the result is
842 @code{\\override} for the specified grob type. If @var{item} is
843 a music expression, the result is the same music expression with an
844 appropriate tweak applied.")
846 ; In case of a tweak, grob property path is Grob.property
847 (let ((prop-path (check-grob-path
848 (if (symbol? property)
852 #:start 1 #:default #t #:min 2 #:max 2)))
854 ; If the head of the grob property path is a symbol--i.e.,
855 ; a grob name, produce a directed tweak. Otherwise, create
857 (if (symbol? (car prop-path))
859 \tweak #prop-path #(offsetter (second prop-path) offsets) #item
862 \tweak #(second prop-path) #(offsetter (second prop-path) offsets) #item
865 ; In case of an override, grob property path is Context.Grob.property.
866 (let ((prop-path (check-grob-path
868 (if (symbol? property)
872 #:default 'Bottom #:min 3 #:max 3)))
875 \override #prop-path = #(offsetter (third prop-path) offsets)
877 (make-music 'Music)))))
880 #(define-music-function (parser location item) (symbol-list-or-music?)
881 (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
882 effectively omitting it without taking up space.
884 If @var{item} is a symbol list of form @code{GrobName} or
885 @code{Context.GrobName}, the result is an override for the grob name
886 specified by it. If @var{item} is a music expression, the result is
887 the same music expression with an appropriate tweak applied to it.")
888 #{ \tweak stencil ##f #item #})
891 #(define-music-function (parser location music) (ly:music?)
892 (_i "Set @code{once} to @code{#t} on all layout instruction events
893 in @var{music}. This will complain about music with an actual
894 duration. As a special exception, if @var{music} contains
895 @samp{tweaks} it will be silently ignored in order to allow for
896 @code{\\once \\tweak} to work as both one-time override and proper
898 (if (not (pair? (ly:music-property music 'tweaks)))
901 (cond ((music-is-of-type? m 'layout-instruction-event)
902 (set! (ly:music-property m 'once) #t)
904 ((ly:duration? (ly:music-property m 'duration))
905 (ly:music-warning m (_ "Cannot apply \\once to timed music"))
912 #(define-music-function (parser location octave) (integer?)
913 (_i "Set the octavation.")
914 (make-music 'OttavaMusic
915 'ottava-number octave))
917 overrideTimeSignatureSettings =
918 #(define-music-function
919 (parser location time-signature base-moment beat-structure beam-exceptions)
920 (fraction? fraction? list? list?)
922 (_i "Override @code{timeSignatureSettings}
923 for time signatures of @var{time-signature} to have settings
924 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
926 ;; TODO -- add warning if largest value of grouping is
927 ;; greater than time-signature.
928 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
929 (override-time-signature-setting time-signature setting)))
932 #(define-music-function (parser location grob-property-path value)
933 (symbol-list? scheme?)
935 (_i "Set the grob property specified by @var{grob-property-path} to
936 @var{value}. @var{grob-property-path} is a symbol list of the form
937 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
938 with subproperties given as well.")
939 (let ((p (check-grob-path grob-property-path parser location
943 (make-music 'ApplyOutputEvent
944 'context-type (first p)
946 (lambda (grob orig-context context)
948 (cdr (assoc 'name (ly:grob-property grob 'meta)))
950 (ly:grob-set-nested-property!
951 grob (cddr p) value))))
952 (make-music 'Music))))
959 %% pageBreak and pageTurn are music functions (iso music indentifiers),
960 %% because music identifiers are not allowed at top-level.
962 #(define-music-function (location parser) ()
963 (_i "Force a page break. May be used at toplevel (i.e., between scores or
964 markups), or inside a score.")
965 (make-music 'EventChord
967 'line-break-permission 'force
968 'page-break-permission 'force
969 'elements (list (make-music 'LineBreakEvent
970 'break-permission 'force)
971 (make-music 'PageBreakEvent
972 'break-permission 'force))))
975 #(define-music-function (location parser) ()
976 (_i "Force a page turn between two scores or top-level markups.")
977 (make-music 'EventChord
979 'line-break-permission 'force
980 'page-break-permission 'force
981 'page-turn-permission 'force
982 'elements (list (make-music 'LineBreakEvent
983 'break-permission 'force)
984 (make-music 'PageBreakEvent
985 'break-permission 'force)
986 (make-music 'PageTurnEvent
987 'break-permission 'force))))
990 #(define-void-function (parser location voice-ids music) (list? ly:music?)
991 (_i "Define parallel music sequences, separated by '|' (bar check signs),
992 and assign them to the identifiers provided in @var{voice-ids}.
994 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
996 @var{music}: a music sequence, containing BarChecks as limiting expressions.
1001 \\parallelMusic #'(A B C) {
1011 (define voice-count (length voice-ids))
1012 (define (bar-check? m)
1013 "Checks whether m is a bar check."
1014 (eq? (ly:music-property m 'name) 'BarCheck))
1015 (define (recurse-and-split-list lst)
1016 "Return either a list of music lists split along barchecks, or @code{#f}."
1017 (if (any bar-check? lst)
1018 (let* ((voices (apply circular-list (make-list voice-count '())))
1019 (current-voices voices)
1020 (current-sequence '()))
1023 (define (push-music m)
1024 "Push the music expression into the current sequence"
1025 (set! current-sequence (cons m current-sequence)))
1026 (define (change-voice)
1027 "Store the previously built sequence into the current voice and
1028 change to the following voice."
1029 (set-car! current-voices
1030 (cons (reverse! current-sequence)
1031 (car current-voices)))
1032 (set! current-sequence '())
1033 (set! current-voices (cdr current-voices)))
1034 (for-each (lambda (m)
1035 (let ((split? (recurse-and-split m)))
1044 (if (bar-check? m) (change-voice))))))
1046 (if (pair? current-sequence) (change-voice))
1047 ;; un-circularize `voices' and reorder the voices
1048 (set! voices (map reverse!
1049 (list-head voices voice-count)))
1050 ;; check sequence length
1051 (apply for-each (lambda seqs
1052 (define (seq-len seq)
1053 (reduce ly:moment-add
1055 (map ly:music-length seq)))
1056 (let ((moment-reference (seq-len (car seqs))))
1057 (for-each (lambda (seq)
1058 (if (not (equal? (seq-len seq)
1064 (_ "Bars in parallel music don't have the same length"))))
1067 (map concatenate! voices))
1068 (let ((deeper (map recurse-and-split lst)))
1069 (and (any pair? deeper)
1073 (ly:music-deep-copy (make-list voice-count m))))
1075 (define (recurse-and-split music)
1076 "This returns either a list of music split along barchecks, or
1078 (let* ((elt (ly:music-property music 'element))
1079 (elts (ly:music-property music 'elements))
1080 (split-elt (and (ly:music? elt) (recurse-and-split elt)))
1081 (split-elts (and (pair? elts) (recurse-and-split-list elts))))
1082 (and (or split-elt split-elts)
1085 (apply music-clone music
1087 ;; reassigning the origin of the parent only
1088 ;; makes sense if the first expression in the
1089 ;; result is from a distributed origin
1092 (and (ly:music? e) (ly:music-property e 'origin #f))
1093 (and (pair? es) (ly:music-property (car es) 'origin #f)))))
1094 (if origin (list 'origin origin) '()))
1095 (if (ly:music? e) (list 'element e) '())
1096 (if (pair? es) (list 'elements es) '()))))
1097 (or split-elt (circular-list #f))
1098 (or split-elts (circular-list #f))))))
1099 (let ((voices (recurse-and-split music)))
1102 ;; bind voice identifiers to the voices
1103 (for-each (lambda (voice-id voice)
1104 (ly:parser-define! parser voice-id voice))
1106 (ly:music-warning music
1107 (_ "ignoring parallel music without barchecks")))))
1110 #(define-music-function (parser loc arg) (ly:music?)
1111 (_i "Tag @var{arg} to be parenthesized.")
1113 (if (memq 'event-chord (ly:music-property arg 'types))
1114 ;; arg is an EventChord -> set the parenthesize property
1115 ;; on all child notes and rests
1118 (if (or (memq 'note-event (ly:music-property ev 'types))
1119 (memq 'rest-event (ly:music-property ev 'types)))
1120 (set! (ly:music-property ev 'parenthesize) #t)))
1121 (ly:music-property arg 'elements))
1122 ;; No chord, simply set property for this expression:
1123 (set! (ly:music-property arg 'parenthesize) #t))
1127 #(define-music-function (parser location chord-range part1 part2)
1128 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1129 (_i "Take the music in @var{part1} and @var{part2} and return
1130 a music expression containing simultaneous voices, where @var{part1}
1131 and @var{part2} are combined into one voice where appropriate.
1132 Optional @var{chord-range} sets the distance in steps between notes
1133 that may be combined into a chord or unison.")
1134 (make-part-combine-music parser
1135 (list part1 part2) #f chord-range))
1138 #(define-music-function (parser location chord-range part1 part2)
1139 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1140 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1141 that they share a staff with stems directed upward.")
1142 (make-part-combine-music parser
1143 (list part1 part2) UP chord-range))
1146 #(define-music-function (parser location chord-range part1 part2)
1147 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1148 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1149 that they share a staff with stems directed downward.")
1150 (make-part-combine-music parser
1151 (list part1 part2) DOWN chord-range))
1154 #(define-music-function (location parser type once) (symbol-or-boolean? boolean?)
1155 (_i "Override the part-combiner.")
1156 (make-music 'EventChord
1157 'elements (list (make-music 'PartCombineForceEvent
1160 partcombineApart = \partcombineForce #'apart ##f
1161 partcombineApartOnce = \partcombineForce #'apart ##t
1162 partcombineChords = \partcombineForce #'chords ##f
1163 partcombineChordsOnce = \partcombineForce #'chords ##t
1164 partcombineUnisono = \partcombineForce #'unisono ##f
1165 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
1166 partcombineSoloI = \partcombineForce #'solo1 ##f
1167 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
1168 partcombineSoloII = \partcombineForce #'solo2 ##f
1169 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
1170 partcombineAutomatic = \partcombineForce ##f ##f
1171 partcombineAutomaticOnce = \partcombineForce ##f ##t
1174 #(define-music-function (parser location dur) (ly:duration?)
1175 (_i "Make a partial measure.")
1177 ;; We use `descend-to-context' here instead of `context-spec-music' to
1178 ;; ensure \partial still works if the Timing_translator is moved
1180 (context-spec-music (make-music 'PartialSet
1187 #(define-music-function
1188 (parser location main-note secondary-note)
1189 (ly:music? ly:music?)
1190 (_i "Print a trill with @var{main-note} as the main note of the trill and
1191 print @var{secondary-note} as a stemless note head in parentheses.")
1192 (let* ((get-notes (lambda (ev-chord)
1193 (extract-named-music ev-chord 'NoteEvent)))
1194 (sec-note-events (get-notes secondary-note))
1195 (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1196 (if (pair? sec-note-events)
1198 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1199 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1201 (if (ly:pitch? trill-pitch)
1202 (for-each (lambda (m)
1203 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1205 (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
1206 (display sec-note-events)))
1209 (for-each (lambda (m)
1210 (ly:music-set-property! m 'force-accidental forced))
1215 #(define-music-function (parser location tag more music)
1216 (symbol? ly:music? ly:music?)
1217 (_i "Add @var{more} to the front of @code{elements} of all music
1218 expressions in @var{music} that are tagged with @var{tag}.")
1219 (music-map (lambda (m)
1220 (if (memq tag (ly:music-property m 'tags))
1221 (set! (ly:music-property m 'elements)
1222 (cons more (ly:music-property m 'elements))))
1227 #(define-music-function (parser location what main-music) (string? ly:music?)
1228 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
1229 of the quoted voice, as specified in an @code{\\addQuote} command.
1230 @var{main-music} is used to indicate the length of music to be quoted;
1231 usually contains spacers or multi-measure rests.")
1232 (make-music 'QuoteMusic
1234 'quoted-music-name what))
1237 #(define-music-function (parser location pitch music)
1238 ((ly:pitch?) ly:music?)
1239 (_i "Make @var{music} relative to @var{pitch}. If @var{pitch} is
1240 omitted, the first note in @var{music} is given in absolute pitch.")
1241 ;; When \relative has no clear decision (can only happen with
1242 ;; scales with an even number of steps), it goes down (see
1243 ;; pitch.cc). The following formula puts out f for both the normal
1244 ;; 7-step scale as well as for a "shortened" scale missing the
1245 ;; final b. In either case, a first note of c will end up as c,
1246 ;; namely pitch (-1, 0, 0).
1247 (ly:make-music-relative! music
1252 ;; size of current scale:
1253 (ly:pitch-steps (ly:make-pitch 1 0))
1255 (make-music 'RelativeOctaveMusic
1259 #(define-music-function (parser location tags music)
1260 (symbol-list-or-symbol? ly:music?)
1261 (_i "Remove elements of @var{music} that are tagged with one of the
1262 tags in @var{tags}. @var{tags} may be either a single symbol or a list
1265 (tags-remove-predicate tags)
1268 resetRelativeOctave =
1269 #(define-music-function (parser location pitch) (ly:pitch?)
1270 (_i "Set the octave inside a \\relative section.")
1272 (make-music 'SequentialMusic
1273 'to-relative-callback
1274 (lambda (music last-pitch) pitch)))
1277 #(define-music-function (parser location music)
1279 (_i "Return @var{music} in reverse order.")
1280 (retrograde-music music))
1282 revertTimeSignatureSettings =
1283 #(define-music-function
1284 (parser location time-signature)
1287 (_i "Revert @code{timeSignatureSettings}
1288 for time signatures of @var{time-signature}.")
1289 (revert-time-signature-setting time-signature))
1292 #(define-event-function (parser location finger) (number-or-markup?)
1293 (_i "Apply @var{finger} as a fingering indication.")
1297 (if (number? finger) 'digit 'text)
1301 #(define-music-function (parser location fraction music)
1302 (fraction? ly:music?)
1303 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1304 (ly:music-compress music
1305 (ly:make-moment (car fraction) (cdr fraction))))
1308 #(define-scheme-function (parser location ctx music)
1309 ((symbol?) ly:music?)
1310 (_i "Take the layout instruction events from @var{music}, optionally
1311 restricted to those applying to context type @var{ctx}, and return
1312 a context modification duplicating their effect.")
1313 (let ((mods (ly:make-context-mod)))
1315 (if (music-is-of-type? m 'layout-instruction-event)
1318 (case (ly:music-property m 'name)
1321 (ly:music-property m 'symbol)
1322 (ly:music-property m 'value)))
1325 (ly:music-property m 'symbol)))
1328 (ly:music-property m 'symbol)
1329 (ly:music-property m 'grob-value)
1331 ((ly:music-property m 'grob-property #f) => list)
1333 (ly:music-property m 'grob-property-path)))))
1336 (ly:music-property m 'symbol)
1338 ((ly:music-property m 'grob-property #f) => list)
1340 (ly:music-property m 'grob-property-path)))))))
1341 (case (ly:music-property m 'name)
1343 (ly:add-context-mod mods
1345 (ly:music-property m 'procedure))))
1346 ((ContextSpeccedMusic)
1348 (eq? ctx (ly:music-property m 'context-type)))
1349 (musicop (ly:music-property m 'element))))
1351 (let ((callback (ly:music-property m 'elements-callback)))
1352 (if (procedure? callback)
1353 (for-each musicop (callback m))))))))
1358 #(define-music-function (parser location offsets item)
1359 (list? symbol-list-or-music?)
1360 (_i "Offset control-points of @var{item} by @var{offsets}. The
1361 argument is a list of number pairs or list of such lists. Each
1362 element of a pair represents an offset to one of the coordinates of a
1363 control-point. If @var{item} is a string, the result is
1364 @code{\\once\\override} for the specified grob type. If @var{item} is
1365 a music expression, the result is the same music expression with an
1366 appropriate tweak applied.")
1367 (define (shape-curve grob)
1368 (let* ((orig (ly:grob-original grob))
1369 (siblings (if (ly:spanner? grob)
1370 (ly:spanner-broken-into orig) '()))
1371 (total-found (length siblings))
1372 (function (assoc-get 'control-points
1373 (reverse (ly:grob-basic-properties grob))))
1374 (coords (function grob)))
1376 (define (offset-control-points offsets)
1380 (lambda (x y) (coord-translate x y))
1383 (define (helper sibs offs)
1385 (if (eq? (car sibs) grob)
1386 (offset-control-points (car offs))
1387 (helper (cdr sibs) (cdr offs)))
1390 ;; we work with lists of lists
1391 (if (or (null? offsets)
1392 (not (list? (car offsets))))
1393 (set! offsets (list offsets)))
1395 (if (>= total-found 2)
1396 (helper siblings offsets)
1397 (offset-control-points (car offsets)))))
1398 #{ \once \tweak control-points #shape-curve #item #})
1401 #(define-music-function (parser location dur dots arg)
1402 (integer? integer? ly:music?)
1403 (_i "Change the duration of @var{arg} by adding @var{dur} to the
1404 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1406 (shift-duration-log arg dur dots))
1409 #(define-music-function (parser location overrides music)
1410 (ly:music? ly:music?)
1411 (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1412 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1413 (set! (ly:music-property music 'tweaks)
1415 (lambda (m) (eq? (ly:music-property m 'name)
1419 ((ly:music-property m 'grob-property #f) => list)
1421 (ly:music-property m 'grob-property-path)))))
1422 (acons (cons (ly:music-property m 'symbol) ;grob name
1424 p ;grob property path
1425 (car p))) ;grob property
1426 (ly:music-property m 'grob-value)
1428 (ly:music-property music 'tweaks)
1433 #(define-music-function (parser location dur) (ly:duration?)
1434 (_i "Skip forward by @var{dur}.")
1435 (make-music 'SkipMusic
1440 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1441 (_i "Create slashed graces (slashes through stems, but no slur) from
1442 the following music expression"))
1445 #(define-music-function (parser location parameters) (list?)
1446 (_i "Set the system stretch, by reading the 'system-stretch property of
1447 the `parameters' assoc list.")
1449 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1450 #(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1451 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
1455 #(define-music-function (parser location style heads music)
1456 (symbol? symbol-list-or-symbol? ly:music?)
1457 (_i "Set @var{heads} in @var{music} to @var{style}.")
1458 (style-note-heads heads style music))
1461 #(define-music-function (parser location tags music) (symbol-list-or-symbol? ly:music?)
1462 (_i "Tag the following @var{music} with @var{tags} and return the
1463 result, by adding the single symbol or symbol list @var{tags} to the
1464 @code{tags} property of @var{music}.")
1467 (ly:music-property music 'tags)
1468 ((if (symbol? tags) cons append)
1470 (ly:music-property music 'tags)))
1474 #(define-void-function (parser location tags) (symbol-list?)
1475 (_i "Define a tag group comprising the symbols in the symbol list
1476 @var{tags}. Tag groups must not overlap.")
1477 (let ((err (define-tag-group tags)))
1478 (if err (ly:parser-error parser err location))))
1481 #(define-music-function (parser location music)
1483 (_i "Make any @code{\\override} in @var{music} replace an existing
1484 grob property value only temporarily, restoring the old value when a
1485 corresponding @code{\\revert} is executed. This is achieved by
1486 clearing the @samp{pop-first} property normally set on
1489 An @code{\\override}/@/@code{\\revert} sequence created by using
1490 @code{\\temporary} and @code{\\undo} on the same music containing
1491 overrides will cancel out perfectly or cause a@tie{}warning.
1493 Non-property-related music is ignored, warnings are generated for any
1494 property-changing music that isn't an @code{\\override}.")
1498 (and (or (music-is-of-type? m 'layout-instruction-event)
1499 (music-is-of-type? m 'context-specification)
1500 (music-is-of-type? m 'apply-context)
1501 (music-is-of-type? m 'time-signature-music))
1502 (case (ly:music-property m 'name)
1504 (if (ly:music-property m 'pop-first #f)
1505 (set! (ly:music-property m 'pop-first) '()))
1506 (if (ly:music-property m 'once #f)
1507 (set! (ly:music-property m 'once) '()))
1509 ((ContextSpeccedMusic)
1514 (ly:input-warning location (_ "Cannot make ~a revertible")
1515 (ly:music-property m 'name))
1522 #(define-music-function (parser location beat-structure fraction)
1523 ((number-list? '()) fraction?)
1524 (_i "Set @var{fraction} as time signature, with optional
1525 number list @var{beat-structure} before it.")
1526 (make-music 'TimeSignatureMusic
1527 'numerator (car fraction)
1528 'denominator (cdr fraction)
1529 'beat-structure beat-structure))
1532 #(define-music-function (parser location fraction music)
1533 (fraction? ly:music?)
1534 (_i "Scale @var{music} in time by @var{fraction}.")
1535 (make-music 'TimeScaledMusic
1536 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1537 'numerator (car fraction)
1538 'denominator (cdr fraction)))
1541 #(define-music-function
1542 (parser location from to music)
1543 (ly:pitch? ly:pitch? ly:music?)
1545 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1546 (make-music 'TransposedMusic
1547 'element (ly:music-transpose music (ly:pitch-diff to from))))
1549 transposedCueDuring =
1550 #(define-music-function
1551 (parser location what dir pitch main-music)
1552 (string? ly:dir? ly:pitch? ly:music?)
1554 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1555 using the transposition defined by @var{pitch}. This happens
1556 simultaneously with @var{main-music}, which is usually a rest. The
1557 argument @var{dir} determines whether the cue notes should be notated
1558 as a first or second voice.")
1560 (make-music 'QuoteMusic
1562 'quoted-context-type 'CueVoice
1563 'quoted-context-id "cue"
1564 'quoted-music-name what
1565 'quoted-voice-direction dir
1566 ;; following is inverse of instrumentTransposition for
1567 ;; historical reasons
1568 'quoted-transposition pitch))
1571 #(define-music-function (parser location pitch) (ly:pitch?)
1572 (_i "Set instrument transposition")
1575 (make-property-set 'instrumentTransposition pitch)
1579 #(define-music-function (parser location ratio tuplet-span music)
1580 (fraction? (ly:duration? '()) ly:music?)
1581 (_i "Scale the given @var{music} to tuplets. @var{ratio} is a
1582 fraction that specifies how many notes are played in place of the
1583 nominal value: it will be @samp{3/2} for triplets, namely three notes
1584 being played in place of two. If the optional duration
1585 @var{tuplet-span} is specified, it is used instead of
1586 @code{tupletSpannerDuration} for grouping the tuplets.
1589 \\tuplet 3/2 4 @{ c8 c c c c c @}
1591 will result in two groups of three tuplets, each group lasting for a
1593 (make-music 'TimeScaledMusic
1594 'element (ly:music-compress
1596 (ly:make-moment (cdr ratio) (car ratio)))
1597 'numerator (cdr ratio)
1598 'denominator (car ratio)
1599 'duration tuplet-span))
1602 #(define-music-function (parser location tuplet-span)
1604 (_i "Set @code{tupletSpannerDuration}, the length into which
1605 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1606 own will group its tuplets, to the duration @var{tuplet-span}. To
1607 revert to the default of not subdividing the contents of a @code{\\tuplet}
1608 command without explicit @samp{tuplet-span}, use
1610 \\tupletSpan \\default
1614 #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1615 #{ \unset tupletSpannerDuration #}))
1618 #(define-music-function (parser location prop value item)
1619 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1620 (_i "Add a tweak to the following @var{item}, usually music.
1621 Layout objects created by @var{item} get their property @var{prop}
1622 set to @var{value}. If @var{prop} has the form @samp{Grob.property}, like with
1624 \\tweak Accidental.color #red cis'
1626 an indirectly created grob (@samp{Accidental} is caused by
1627 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1630 As a special case, @var{item} may be a symbol list specifying a grob
1631 path, in which case @code{\\override} is called on it instead of
1632 creating tweaked music. This is mainly useful when using
1633 @code{\\tweak} as as a component for building other functions.
1635 If this use case would call for @code{\\once \\override} rather than a
1636 plain @code{\\override}, writing @code{\\once \\tweak @dots{}} can be
1639 @var{prop} can contain additional elements in which case a nested
1640 property (inside of an alist) is tweaked.")
1641 (if (ly:music? item)
1642 (let ((p (check-grob-path prop parser location
1647 (set! (ly:music-property item 'tweaks)
1648 (acons (cond ((pair? (cddr p)) p)
1650 (cons (car p) (cadr p)))
1653 (ly:music-property item 'tweaks))))
1655 ;; We could just throw this at \override and let it sort this
1656 ;; out on its own, but this way we should get better error
1658 (let ((p (check-grob-path
1659 (append item (if (symbol? prop) (list prop) prop))
1661 #:default 'Bottom #:min 3)))
1663 #{ \override #p = #value #}
1664 (make-music 'Music)))))
1667 #(define-music-function (parser location music)
1669 (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1670 @code{\\revert} and @code{\\unset}, respectively. Any reverts and
1671 unsets already in @var{music} cause a warning. Non-property-related music is ignored.")
1678 (lambda (m) (or (music-is-of-type? m 'layout-instruction-event)
1679 (music-is-of-type? m 'context-specification)
1680 (music-is-of-type? m 'apply-context)
1681 (music-is-of-type? m 'time-signature-music)))
1682 (lambda (m overrides)
1683 (case (ly:music-property m 'name)
1686 (make-music 'RevertProperty
1687 'symbol (ly:music-property m 'symbol)
1690 ((ly:music-property m 'grob-property #f) => list)
1692 (ly:music-property m 'grob-property-path))))
1696 (make-music 'PropertyUnset
1697 'symbol (ly:music-property m 'symbol))
1699 ((ContextSpeccedMusic)
1701 (make-music 'ContextSpeccedMusic
1702 'element (loop (ly:music-property m 'element))
1703 'context-type (ly:music-property m 'context-type))
1708 (ly:input-warning location (_ "Cannot revert ~a")
1709 (ly:music-property m 'name))
1715 ((null? lst) (make-music 'Music))
1716 ((null? (cdr lst)) (car lst))
1717 (else (make-sequential-music lst))))))
1720 #(define-music-function (parser location music) (ly:music?)
1721 (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1722 @code{\\repeat percent} commands in @var{music} to be interpreted
1723 as @code{\\repeat unfold}.")
1724 (unfold-repeats music))
1727 #(define-void-function (parser location arg) (scheme?)
1728 (_i "Accept a scheme argument, return a void expression.
1729 Use this if you want to have a scheme expression evaluated
1730 because of its side-effects, but its value ignored."))
1733 #(define-music-function (parser location sym val music)
1734 (symbol? scheme? ly:music?)
1735 (_i "Set @var{sym} to @var{val} in @var{music}.")
1737 (set! (ly:music-property music sym) val)