1 %%%% -*- Mode: Scheme -*-
3 %%%% This file is part of LilyPond, the GNU music typesetter.
5 %%%% Copyright (C) 2003--2015 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 (music)
37 (_i "Make @var{music} absolute. This does not actually change the
38 music itself but rather hides it from surrounding @code{\\relative}
39 and @code{\\fixed} commands.")
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 (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 (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 (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 () ()
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 (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 (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 (proc) (procedure?)
145 (_i "Modify context properties with Scheme procedure @var{proc}.")
146 (make-music 'ApplyContext
150 #(define-music-function (func music) (procedure? ly:music?)
151 (_i"Apply procedure @var{func} to @var{music}.")
155 #(define-music-function (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 (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 (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 (music) (ly:music?)
179 (_i "Make voices that switch between staves automatically")
180 (make-autochange-music (*parser*) music))
185 #(define-music-function (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 (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 (type) (string?)
207 (_i "Insert a bar line of type @var{type}")
209 (make-property-set 'whichBar type)
213 #(define-music-function (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 (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 (delta) (real?)
234 (_i "Create a fall or doit of pitch interval @var{delta}.")
235 (make-music 'BendAfterEvent
239 #(define-void-function (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 (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 () ()
255 (_i "Insert a breath mark.")
256 (make-music 'BreathingEvent))
259 #(define-music-function (type) (string?)
260 (_i "Set the current clef to @var{type}.")
261 (make-clef-set type))
265 #(define-music-function (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 (music) (ly:music?)
292 (_i "Remove the empty bars created by multi-measure rests,
293 leaving just the first bar containing the MM rest itself.")
296 (if (eq? 'MultiMeasureRestMusic (ly:music-property m 'name))
297 #{ \once \set Score.skipBars = ##t #m #}
302 #(define-music-function (notes) (ly:music?)
303 (_i "Create cross-staff stems")
305 \temporary \override Stem.cross-staff = #cross-staff-connect
306 \temporary \override Flag.style = #'no-flag
308 \revert Stem.cross-staff
313 #(define-music-function (type) (string?)
314 (_i "Set the current cue clef to @var{type}.")
315 (make-cue-clef-set type))
318 #(define-music-function () ()
319 (_i "Unset the current cue clef.")
320 (make-cue-clef-unset))
323 #(define-music-function
324 (what dir main-music) (string? ly:dir? ly:music?)
325 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
326 in a CueVoice oriented by @var{dir}.")
327 (make-music 'QuoteMusic
329 'quoted-context-type 'CueVoice
330 'quoted-context-id "cue"
331 'quoted-music-name what
332 'quoted-voice-direction dir))
335 #(define-music-function
336 (what dir clef main-music) (string? ly:dir? string? ly:music?)
337 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
338 in a CueVoice oriented by @var{dir}.")
339 (make-music 'QuoteMusic
341 'quoted-context-type 'CueVoice
342 'quoted-context-id "cue"
343 'quoted-music-name what
344 'quoted-music-clef clef
345 'quoted-voice-direction dir))
350 #(define-music-function (port music) ((output-port?) ly:music?)
351 (_i "Display the LilyPond input representation of @var{music}
352 to @var{port}, defaulting to the console.")
353 (let ((port (or port (current-output-port))))
355 (display-lily-music music (*parser*) port))
359 #(define-music-function (port music) ((output-port?) ly:music?)
360 (_i "Display the internal representation of @var{music} to
361 @var{port}, default to the console.")
362 (let ((port (or port (current-output-port))))
364 (display-scheme-music music port))
368 #(define-scheme-function (port expr) ((output-port?) scheme?)
369 (_i "Display the internal representation of @var{expr} to
370 @var{port}, default to the console.")
371 (let ((port (or port (current-output-port))))
373 (display-scheme-music expr port))
379 #(define-music-function (music) (ly:music?)
380 (_i "Terminate the next spanner prematurely after exactly one note
381 without the need of a specific end spanner.")
382 (let* ((start-span-evs (filter (lambda (ev)
383 (equal? (ly:music-property ev 'span-direction)
385 (extract-typed-music music 'span-event)))
388 (music-clone m 'span-direction STOP))
390 (end-ev-chord (make-music 'EventChord
391 'elements stop-span-evs))
392 (total (make-music 'SequentialMusic
393 'elements (list music
398 #(define-music-function (music) (ly:music?)
399 (_i "Compatibility function wrapping @code{EventChord} around
400 isolated rhythmic events occuring since version 2.15.28, after
401 expanding repeat chords @samp{q}.")
402 (event-chord-wrap! music (*parser*)))
405 #(define-music-function (factor argument) (ly:moment? ly:music?)
406 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
407 (let ((orig-duration (ly:music-length argument))
408 (multiplier (ly:make-moment 1 1)))
412 (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
414 (ly:music-compress mus multiplier)
415 (set! multiplier (ly:moment-mul factor multiplier)))))
416 (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
419 (ly:moment-div orig-duration (ly:music-length argument)))
424 #(define-event-function (finger) (number-or-markup?)
425 (_i "Apply @var{finger} as a fingering indication.")
429 (if (number? finger) 'digit 'text)
433 #(define-music-function (pitch music)
434 (ly:pitch? ly:music?)
435 (_i "Use the octave of @var{pitch} as the default octave for @var{music}.")
436 (let ((octave-marks (1+ (ly:pitch-octave pitch))))
437 (cond ((not (= 0 octave-marks))
438 (ly:music-transpose music (ly:make-pitch octave-marks 0 0))
439 ;;In order to leave unchanged the notes in any enclosed
440 ;; \absolute or \fixed or \relative, make a cancelling shift
442 (ly:music-transpose m (ly:make-pitch (- octave-marks) 0 0)))
443 (extract-named-music music 'RelativeOctaveMusic)))))
444 (make-music 'RelativeOctaveMusic 'element music))
447 #(define-music-function (mark offset footnote item)
448 ((markup?) number-pair? markup? symbol-list-or-music?)
449 (_i "Make the markup @var{footnote} a footnote on @var{item}. The
450 footnote is marked with a markup @var{mark} moved by @var{offset} with
451 respect to the marked music.
453 If @var{mark} is not given or specified as @var{\\default}, it is
454 replaced by an automatically generated sequence number. If @var{item}
455 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
456 grobs of that type will be marked at the current time step in the
457 given context (default @code{Bottom}).
459 If @var{item} is music, the music will get a footnote attached to a
460 grob immediately attached to the event, like @var{\\tweak} does. For
461 attaching a footnote to an @emph{indirectly} caused grob, write
462 @code{\\single\\footnote}, use @var{item} to specify the grob, and
463 follow it with the music to annotate.
465 Like with @code{\\tweak}, if you use a footnote on a following
466 post-event, the @code{\\footnote} command itself needs to be attached
467 to the preceding note or rest as a post-event with @code{-}.")
468 (let ((mus (make-music
470 'X-offset (car offset)
471 'Y-offset (cdr offset)
472 'automatically-numbered (not mark)
473 'text (or mark (make-null-markup))
474 'footnote-text footnote)))
475 (once (tweak 'footnote-music mus item))))
478 #(def-grace-function startGraceMusic stopGraceMusic
479 (_i "Insert @var{music} as grace notes."))
482 #(define-scheme-function (descriptions) (list?)
483 (_i "Create a context modification from @var{descriptions}, a list
484 in the format of @code{all-grob-descriptions}.")
487 (list 'assign (car p) (ly:make-grob-properties (cdr p))))
490 harmonicByFret = #(define-music-function (fret 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 @var{fret}.")
494 \set harmonicDots = ##t
495 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
496 \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
497 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
498 (ly:note-head::print grob))
500 (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
502 \revert TabNoteHead.stencil
503 \revert NoteHead.Y-extent
504 \revert NoteHead.stencil
507 harmonicByRatio = #(define-music-function (ratio music) (number? ly:music?)
508 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
509 harmonics played on a fretted instrument by touching the strings at the point
510 given through @var{ratio}.")
512 \set harmonicDots = ##t
513 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
514 \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height)
515 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
516 (ly:note-head::print grob))
518 (calc-harmonic-pitch (ratio->pitch ratio) music))
520 \revert TabNoteHead.stencil
521 \revert NoteHead.Y-extent
522 \revert NoteHead.stencil
526 #(define-music-function (item) (symbol-list-or-music?)
527 (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
528 making it invisible while still retaining its dimensions.
530 If @var{item} is a symbol list of form @code{GrobName} or
531 @code{Context.GrobName}, the result is an override for the grob name
532 specified by it. If @var{item} is a music expression, the result is
533 the same music expression with an appropriate tweak applied to it.")
534 (tweak 'transparent #t item))
537 #(define-music-function () ()
538 (_i "Put the segno variant 'varsegno' at this position into the staff,
539 compatible with the repeat command.")
540 (make-music 'ApplyContext
543 (let ((score-ctx (ly:context-find ctx 'Score)))
544 (if (ly:context? score-ctx)
545 (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
546 (if (eq? (memq 'segno-display old-rc) #f)
547 (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
550 #(define-music-function
552 (_i "Switch instrument to @var{name}, which must be predefined with
553 @code{\\addInstrumentDefinition}.")
554 (let* ((handle (assoc name instrument-definitions))
555 (instrument-def (if handle (cdr handle) '())))
558 (ly:input-warning (*location*) "No such instrument: ~a" name))
560 (make-music 'SimultaneousMusic
572 #(define-music-function (tags music)
573 (symbol-list-or-symbol? ly:music?)
574 (_i "Include only elements of @var{music} that are tagged with one
575 of the tags in @var{tags}. @var{tags} may be either a single symbol
576 or a list of symbols.
578 Each tag may be declared as a member of at most one tag group (defined
579 with @code{\\tagGroup}). If none of a @var{music} element's tags
580 share a tag group with one of the specified @var{tags}, the element is
583 (tags-keep-predicate tags)
587 #(define-music-function (tonic pitch-alist)
588 ((ly:pitch? '()) (list? '()))
589 (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
590 If both are null, just generate @code{KeyChangeEvent}.")
591 (cond ((null? tonic) (make-music 'KeyChangeEvent))
593 (ly:parser-error (*parser*) (_ "second argument must be pitch list")
595 (make-music 'SequentialMusic 'void #t))
598 (make-music 'KeyChangeEvent
599 'tonic (ly:make-pitch 0 0 0)
600 'pitch-alist pitch-alist)
604 #(define-music-function (music) (ly:music?)
605 (_i "Remove cue notes from @var{music}.")
608 (if (and (string? (ly:music-property mus 'quoted-music-name))
609 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
610 (ly:music-property mus 'element)
617 #(define-music-function (label) (symbol?)
618 (_i "Create @var{label} as a bookmarking label.")
619 (make-music 'EventChord
622 'elements (list (make-music 'LabelEvent
623 'page-label label))))
627 #(define-void-function (language) (string?)
628 (_i "Set note names for language @var{language}.")
629 (note-names-language (*parser*) language))
631 languageSaveAndChange =
632 #(define-void-function (language) (string?)
633 (_i "Store the previous pitchnames alist, and set a new one.")
634 (set! previous-pitchnames pitchnames)
635 (note-names-language (*parser*) language))
638 #(define-void-function () ()
639 (_i "Restore a previously-saved pitchnames alist.")
640 (if previous-pitchnames
642 (set! pitchnames previous-pitchnames)
643 (ly:parser-set-note-names (*parser*) pitchnames))
644 (ly:input-warning (*location*) (_ "No other language was defined previously. Ignoring."))))
648 #(define-music-function (mag music) (positive? ly:music?)
649 (_i "Magnify the notation of @var{music} without changing the
650 staff-size, using @var{mag} as a size factor. Stems, beams,
651 slurs, ties, and horizontal spacing are adjusted automatically.")
653 ;; these props are NOT allowed to shrink below default size
654 (define unshrinkable-props
660 (Slur line-thickness)
662 (PhrasingSlur line-thickness)
663 (PhrasingSlur thickness)
668 (LaissezVibrerTie line-thickness)
669 (LaissezVibrerTie thickness)
670 (RepeatTie line-thickness)
671 (RepeatTie thickness)
674 ;; these props ARE allowed to shrink below default size
675 (define shrinkable-props
676 (let ((baseline-skip-props
677 (find-named-props 'baseline-skip all-grob-descriptions))
679 (find-named-props 'word-space all-grob-descriptions)))
684 ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed
685 ;; override at the 'Score level
686 ;(SpacingSpanner spacing-increment)
688 ;; lengths and heights
689 (Beam length-fraction)
690 (Stem length-fraction)
691 (Stem beamlet-default-length)
692 (Stem double-stem-separation)
694 (Slur minimum-length)
695 (PhrasingSlur height-limit)
696 (PhrasingSlur minimum-length)
698 ;; Beam.beam-thickness is dealt with separately below
702 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
704 #(scale-fontSize 'magnifyMusic mag)
705 #(scale-props 'magnifyMusic mag #f unshrinkable-props)
706 #(scale-props 'magnifyMusic mag #t shrinkable-props)
707 #(scale-beam-thickness mag)
711 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
713 %% reverse engineer the former fontSize value instead of using \unset
714 #(revert-fontSize 'magnifyMusic mag)
715 #(revert-props 'magnifyMusic mag (append unshrinkable-props
717 '((Beam beam-thickness))))
722 #(define-music-function (mag) (positive?)
723 (_i "Change the size of the staff, adjusting notation size and
724 horizontal spacing automatically, using @var{mag} as a size factor.")
726 ;; these props are NOT allowed to shrink below default size
727 (define unshrinkable-props
728 '((StaffSymbol thickness)))
730 ;; these props ARE allowed to shrink below default size
731 (define shrinkable-props
732 (let* ((baseline-skip-props
733 (find-named-props 'baseline-skip all-grob-descriptions))
735 (find-named-props 'word-space all-grob-descriptions))
737 (find-named-props 'space-alist all-grob-descriptions)))
743 ;; override at the 'Score level
744 (SpacingSpanner spacing-increment)
746 (StaffSymbol staff-space)
749 (BarLine hair-thickness)
750 (BarLine thick-thickness)
751 (Stem beamlet-default-length)
752 (Stem double-stem-separation)
758 %% revert settings from last time
759 %% (but only if \magnifyStaff has already been used
760 %% and the staff magnification is changing)
761 #(revert-fontSize 'magnifyStaff mag)
762 #(revert-props 'magnifyStaff mag (append unshrinkable-props
766 %% (but only if staff magnification is changing
767 %% and does not equal 1)
768 #(scale-fontSize 'magnifyStaff mag)
769 #(scale-props 'magnifyStaff mag #f unshrinkable-props)
770 #(scale-props 'magnifyStaff mag #t shrinkable-props)
772 %% this might cause problems until Issue 3990 is fixed
776 \set Staff.magnifyStaffValue = #mag
780 #(define-music-function (arg) (ly:music?)
781 (_i "Display chords in @var{arg} as clusters.")
782 (music-map note-to-cluster arg))
785 #(define-music-function (around to scale music)
786 (ly:pitch? ly:pitch? ly:music? ly:music?)
787 (_i "Invert @var{music} about @var{around} using @var{scale} and
788 transpose from @var{around} to @var{to}.")
789 (let ((inverter (make-modal-inverter around to scale)))
790 (change-pitches music inverter)
794 #(define-music-function (from to scale music)
795 (ly:pitch? ly:pitch? ly:music? ly:music?)
796 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
798 (let ((transposer (make-modal-transposer from to scale)))
799 (change-pitches music transposer)
803 #(define-music-function
804 (around to music) (ly:pitch? ly:pitch? ly:music?)
805 (_i "Invert @var{music} about @var{around} and
806 transpose from @var{around} to @var{to}.")
807 (music-invert around to music))
810 #(define-music-function
811 (label) ((scheme? '()))
812 "Make the music for the \\mark command."
813 (let* ((set (and (integer? label)
814 (context-spec-music (make-property-set 'rehearsalMark label)
816 (ev (make-music 'MarkEvent
817 'origin (*location*))))
820 (make-sequential-music (list set ev))
822 (set! (ly:music-property ev 'label) label)
826 #(define-music-function (proc mus) (procedure? ly:music?)
827 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
828 (music-map proc mus))
830 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
831 %% because music identifiers are not allowed at top-level.
833 #(define-music-function () ()
834 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
835 markups), or inside a score.")
836 (make-music 'EventChord
838 'page-break-permission 'forbid
839 'elements (list (make-music 'PageBreakEvent
840 'break-permission '()))))
843 #(define-music-function () ()
844 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
845 markups), or inside a score.")
846 (make-music 'EventChord
848 'page-turn-permission 'forbid
849 'elements (list (make-music 'PageTurnEvent
850 'break-permission '()))))
855 #(define-music-function (pitch) (ly:pitch?)
857 (make-music 'RelativeOctaveCheck
861 #(define-music-function (property offsets item)
862 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
863 (_i "Offset the default value of @var{property} of @var{item} by
864 @var{offsets}. If @var{item} is a string, the result is
865 @code{\\override} for the specified grob type. If @var{item} is
866 a music expression, the result is the same music expression with an
867 appropriate tweak applied.")
869 ; In case of a tweak, grob property path is Grob.property
870 (let ((prop-path (check-grob-path
871 (if (symbol? property)
874 (*parser*) (*location*)
875 #:start 1 #:default #t #:min 2 #:max 2)))
877 ; If the head of the grob property path is a symbol--i.e.,
878 ; a grob name, produce a directed tweak. Otherwise, create
880 (if (symbol? (car prop-path))
881 (tweak prop-path (offsetter (second prop-path) offsets) item)
882 (tweak (second prop-path)
883 (offsetter (second prop-path) offsets)
886 ; In case of an override, grob property path is Context.Grob.property.
887 (let ((prop-path (check-grob-path
889 (if (symbol? property)
892 (*parser*) (*location*)
893 #:default 'Bottom #:min 3 #:max 3)))
896 \override #prop-path = #(offsetter (third prop-path) offsets)
898 (make-music 'Music)))))
901 #(define-music-function (item) (symbol-list-or-music?)
902 (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
903 effectively omitting it without taking up space.
905 If @var{item} is a symbol list of form @code{GrobName} or
906 @code{Context.GrobName}, the result is an override for the grob name
907 specified by it. If @var{item} is a music expression, the result is
908 the same music expression with an appropriate tweak applied to it.")
909 (tweak 'stencil #f item))
912 #(define-music-function (music) (ly:music?)
913 (_i "Set @code{once} to @code{#t} on all layout instruction events
914 in @var{music}. This will complain about music with an actual
915 duration. As a special exception, if @var{music} contains
916 @samp{tweaks} it will be silently ignored in order to allow for
917 @code{\\once \\tweak} to work as both one-time override and proper
919 (if (not (pair? (ly:music-property music 'tweaks)))
922 (cond ((music-is-of-type? m 'layout-instruction-event)
923 (set! (ly:music-property m 'once) #t)
925 ((ly:duration? (ly:music-property m 'duration))
926 (ly:music-warning m (_ "Cannot apply \\once to timed music"))
933 #(define-music-function (octave) (integer?)
934 (_i "Set the octavation.")
935 (make-music 'OttavaMusic
936 'ottava-number octave))
938 overrideTimeSignatureSettings =
939 #(define-music-function
940 (time-signature base-moment beat-structure beam-exceptions)
941 (fraction? fraction? list? list?)
943 (_i "Override @code{timeSignatureSettings}
944 for time signatures of @var{time-signature} to have settings
945 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
947 ;; TODO -- add warning if largest value of grouping is
948 ;; greater than time-signature.
949 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
950 (override-time-signature-setting time-signature setting)))
953 #(define-music-function (grob-property-path value)
954 (symbol-list? scheme?)
956 (_i "Set the grob property specified by @var{grob-property-path} to
957 @var{value}. @var{grob-property-path} is a symbol list of the form
958 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
959 with subproperties given as well.")
960 (let ((p (check-grob-path grob-property-path (*parser*) (*location*)
964 (make-music 'ApplyOutputEvent
965 'context-type (first p)
967 (lambda (grob orig-context context)
969 (cdr (assoc 'name (ly:grob-property grob 'meta)))
971 (ly:grob-set-nested-property!
972 grob (cddr p) value))))
973 (make-music 'Music))))
980 %% pageBreak and pageTurn are music functions (iso music indentifiers),
981 %% because music identifiers are not allowed at top-level.
983 #(define-music-function () ()
984 (_i "Force a page break. May be used at toplevel (i.e., between scores or
985 markups), or inside a score.")
986 (make-music 'EventChord
988 'line-break-permission 'force
989 'page-break-permission 'force
990 'elements (list (make-music 'LineBreakEvent
991 'break-permission 'force)
992 (make-music 'PageBreakEvent
993 'break-permission 'force))))
996 #(define-music-function () ()
997 (_i "Force a page turn between two scores or top-level markups.")
998 (make-music 'EventChord
1000 'line-break-permission 'force
1001 'page-break-permission 'force
1002 'page-turn-permission 'force
1003 'elements (list (make-music 'LineBreakEvent
1004 'break-permission 'force)
1005 (make-music 'PageBreakEvent
1006 'break-permission 'force)
1007 (make-music 'PageTurnEvent
1008 'break-permission 'force))))
1011 #(define-void-function (voice-ids music) (list? ly:music?)
1012 (_i "Define parallel music sequences, separated by '|' (bar check signs),
1013 and assign them to the identifiers provided in @var{voice-ids}.
1015 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
1017 @var{music}: a music sequence, containing BarChecks as limiting expressions.
1022 \\parallelMusic #'(A B C) {
1032 The last bar checks in a sequence are not copied to the result in
1033 order to facilitate ending the last entry at non-bar boundaries.
1035 (define voice-count (length voice-ids))
1036 (define (bar-check? m)
1037 "Checks whether m is a bar check."
1038 (eq? (ly:music-property m 'name) 'BarCheck))
1039 (define (recurse-and-split-list lst)
1040 "Return either a list of music lists split along barchecks, or @code{#f}."
1041 (if (any bar-check? lst)
1042 (let* ((voices (apply circular-list (make-list voice-count '())))
1043 (current-voices voices)
1044 (current-sequence '()))
1047 (define (push-music m)
1048 "Push the music expression into the current sequence"
1049 (set! current-sequence (cons m current-sequence)))
1050 (define (change-voice)
1051 "Store the previously built sequence into the current voice and
1052 change to the following voice."
1053 (set-car! current-voices
1054 (cons current-sequence
1055 (car current-voices)))
1056 (set! current-sequence '())
1057 (set! current-voices (cdr current-voices)))
1058 (for-each (lambda (m)
1059 (let ((split? (recurse-and-split m)))
1068 (if (bar-check? m) (change-voice))))))
1070 (if (pair? current-sequence) (change-voice))
1071 ;; Un-circularize voices
1072 (set! voices (list-head voices voice-count))
1074 ;; Remove trailing bar checks to facilitate ending a
1075 ;; sequence on a non-bar, reverse partial sequences and sequences
1080 (if (and (pair? l) (pair? (car l))
1081 (bar-check? (caar l)))
1082 (cons (cdar l) (cdr l))
1086 ;; check sequence length
1087 (apply for-each (lambda seqs
1088 (define (seq-len seq)
1089 (reduce ly:moment-add
1091 (map ly:music-length seq)))
1092 (let ((moment-reference (seq-len (car seqs))))
1093 (for-each (lambda (seq)
1094 (if (not (equal? (seq-len seq)
1100 (_ "Bars in parallel music don't have the same length"))))
1103 (map concatenate! voices))
1104 (let ((deeper (map recurse-and-split lst)))
1105 (and (any pair? deeper)
1109 (ly:music-deep-copy (make-list voice-count m))))
1111 (define (recurse-and-split music)
1112 "This returns either a list of music split along barchecks, or
1114 (let* ((elt (ly:music-property music 'element))
1115 (elts (ly:music-property music 'elements))
1116 (split-elt (and (ly:music? elt) (recurse-and-split elt)))
1117 (split-elts (and (pair? elts) (recurse-and-split-list elts))))
1118 (and (or split-elt split-elts)
1121 (apply music-clone music
1123 ;; reassigning the origin of the parent only
1124 ;; makes sense if the first expression in the
1125 ;; result is from a distributed origin
1128 (and (ly:music? e) (ly:music-property e 'origin #f))
1129 (and (pair? es) (ly:music-property (car es) 'origin #f)))))
1130 (if origin (list 'origin origin) '()))
1131 (if (ly:music? e) (list 'element e) '())
1132 (if (pair? es) (list 'elements es) '()))))
1133 (or split-elt (circular-list #f))
1134 (or split-elts (circular-list #f))))))
1135 (let ((voices (recurse-and-split music)))
1138 ;; bind voice identifiers to the voices
1139 (for-each (lambda (voice-id voice)
1140 (ly:parser-define! (*parser*) voice-id voice))
1142 (ly:music-warning music
1143 (_ "ignoring parallel music without barchecks")))))
1146 #(define-music-function (arg) (ly:music?)
1147 (_i "Tag @var{arg} to be parenthesized.")
1149 (if (memq 'event-chord (ly:music-property arg 'types))
1150 ;; arg is an EventChord -> set the parenthesize property
1151 ;; on all child notes and rests
1154 (if (or (memq 'note-event (ly:music-property ev 'types))
1155 (memq 'rest-event (ly:music-property ev 'types)))
1156 (set! (ly:music-property ev 'parenthesize) #t)))
1157 (ly:music-property arg 'elements))
1158 ;; No chord, simply set property for this expression:
1159 (set! (ly:music-property arg 'parenthesize) #t))
1162 #(define (make-directed-part-combine-music
1163 parser direction chord-range part1 part2
1164 one-context-settings
1165 two-context-settings
1166 shared-context-settings)
1168 (let* ((pc-music (make-part-combine-music
1169 parser (list part1 part2) direction chord-range))
1170 (L1 (ly:music-length part1))
1171 (L2 (ly:music-length part2))
1172 ;; keep the contexts alive for the full duration
1173 (skip (make-skip-music (make-duration-of-length
1174 (if (ly:moment<? L1 L2) L2 L1)))))
1175 #{ \context Staff <<
1176 \context Voice = "one" \with #one-context-settings { #skip }
1177 \context Voice = "two" \with #two-context-settings { #skip }
1178 \context Voice = "shared" \with #shared-context-settings { #skip }
1179 \context Voice = "solo" { #skip }
1180 \context NullVoice = "null" { #skip }
1182 #(make-part-combine-marks
1183 default-part-combine-mark-state-machine
1184 (ly:music-property pc-music 'split-list))
1188 #(define-music-function (chord-range part1 part2)
1189 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1190 (_i "Take the music in @var{part1} and @var{part2} and return
1191 a music expression containing simultaneous voices, where @var{part1}
1192 and @var{part2} are combined into one voice where appropriate.
1193 Optional @var{chord-range} sets the distance in steps between notes
1194 that may be combined into a chord or unison.")
1195 (make-directed-part-combine-music (*parser*) #f chord-range part1 part2
1196 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1197 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1201 #(define-music-function (chord-range part1 part2)
1202 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1203 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1204 that they share a staff with stems directed upward.")
1205 (make-directed-part-combine-music (*parser*) UP chord-range part1 part2
1206 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1207 #{ \with { \voiceThree \override DynamicLineSpanner.direction = #UP } #}
1208 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} ))
1211 #(define-music-function (chord-range part1 part2)
1212 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1213 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1214 that they share a staff with stems directed downward.")
1215 (make-directed-part-combine-music (*parser*) DOWN chord-range part1 part2
1216 #{ \with { \voiceFour \override DynamicLineSpanner.direction = #DOWN } #}
1217 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1218 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} ))
1221 #(define-music-function (type once) (boolean-or-symbol? boolean?)
1222 (_i "Override the part-combiner.")
1223 (make-music 'EventChord
1224 'elements (list (make-music 'PartCombineForceEvent
1227 partcombineApart = \partcombineForce #'apart ##f
1228 partcombineApartOnce = \partcombineForce #'apart ##t
1229 partcombineChords = \partcombineForce #'chords ##f
1230 partcombineChordsOnce = \partcombineForce #'chords ##t
1231 partcombineUnisono = \partcombineForce #'unisono ##f
1232 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
1233 partcombineSoloI = \partcombineForce #'solo1 ##f
1234 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
1235 partcombineSoloII = \partcombineForce #'solo2 ##f
1236 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
1237 partcombineAutomatic = \partcombineForce ##f ##f
1238 partcombineAutomaticOnce = \partcombineForce ##f ##t
1241 #(define-music-function (dur) (ly:duration?)
1242 (_i "Make a partial measure.")
1244 ;; We use `descend-to-context' here instead of `context-spec-music' to
1245 ;; ensure \partial still works if the Timing_translator is moved
1247 (context-spec-music (make-music 'PartialSet
1248 'origin (*location*)
1254 #(define-music-function
1255 (main-note secondary-note)
1256 (ly:music? ly:music?)
1257 (_i "Print a trill with @var{main-note} as the main note of the trill and
1258 print @var{secondary-note} as a stemless note head in parentheses.")
1259 (let* ((get-notes (lambda (ev-chord)
1260 (extract-named-music ev-chord 'NoteEvent)))
1261 (sec-note-events (get-notes secondary-note))
1262 (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1263 (if (pair? sec-note-events)
1265 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1266 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1268 (if (ly:pitch? trill-pitch)
1269 (for-each (lambda (m)
1270 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1272 (ly:input-warning (*location*) (_ "Second argument of \\pitchedTrill should be single note: "))
1273 (display sec-note-events)))
1276 (for-each (lambda (m)
1277 (ly:music-set-property! m 'force-accidental forced))
1282 #(define-music-function (tag more music)
1283 (symbol? ly:music? ly:music?)
1284 (_i "Add @var{more} to the front of @code{elements} of all music
1285 expressions in @var{music} that are tagged with @var{tag}.")
1286 (music-map (lambda (m)
1287 (if (memq tag (ly:music-property m 'tags))
1288 (set! (ly:music-property m 'elements)
1289 (cons more (ly:music-property m 'elements))))
1294 #(define-music-function (what main-music) (string? ly:music?)
1295 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
1296 of the quoted voice, as specified in an @code{\\addQuote} command.
1297 @var{main-music} is used to indicate the length of music to be quoted;
1298 usually contains spacers or multi-measure rests.")
1299 (make-music 'QuoteMusic
1301 'quoted-music-name what))
1304 #(define-music-function (pitch music)
1305 ((ly:pitch?) ly:music?)
1306 (_i "Make @var{music} relative to @var{pitch}. If @var{pitch} is
1307 omitted, the first note in @var{music} is given in absolute pitch.")
1308 ;; When \relative has no clear decision (can only happen with
1309 ;; scales with an even number of steps), it goes down (see
1310 ;; pitch.cc). The following formula puts out f for both the normal
1311 ;; 7-step scale as well as for a "shortened" scale missing the
1312 ;; final b. In either case, a first note of c will end up as c,
1313 ;; namely pitch (-1, 0, 0).
1314 (ly:make-music-relative! music
1319 ;; size of current scale:
1320 (ly:pitch-steps (ly:make-pitch 1 0))
1322 (make-music 'RelativeOctaveMusic
1326 #(define-music-function (tags music)
1327 (symbol-list-or-symbol? ly:music?)
1328 (_i "Remove elements of @var{music} that are tagged with one of the
1329 tags in @var{tags}. @var{tags} may be either a single symbol or a list
1332 (tags-remove-predicate tags)
1335 resetRelativeOctave =
1336 #(define-music-function (pitch) (ly:pitch?)
1337 (_i "Set the octave inside a \\relative section.")
1339 (make-music 'SequentialMusic
1340 'to-relative-callback
1341 (lambda (music last-pitch) pitch)))
1344 #(define-music-function (music)
1346 (_i "Return @var{music} in reverse order.")
1347 (retrograde-music music))
1349 revertTimeSignatureSettings =
1350 #(define-music-function
1354 (_i "Revert @code{timeSignatureSettings}
1355 for time signatures of @var{time-signature}.")
1356 (revert-time-signature-setting time-signature))
1359 #(define-event-function (finger) (number-or-markup?)
1360 (_i "Apply @var{finger} as a fingering indication.")
1364 (if (number? finger) 'digit 'text)
1368 #(define-music-function (fraction music)
1369 (fraction? ly:music?)
1370 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1371 (ly:music-compress music
1372 (ly:make-moment (car fraction) (cdr fraction))))
1375 #(define-scheme-function (ctx music)
1376 ((symbol?) ly:music?)
1377 (_i "Take the layout instruction events from @var{music}, optionally
1378 restricted to those applying to context type @var{ctx}, and return
1379 a context modification duplicating their effect.")
1380 (let ((mods (ly:make-context-mod)))
1382 (if (music-is-of-type? m 'layout-instruction-event)
1385 (case (ly:music-property m 'name)
1388 (ly:music-property m 'symbol)
1389 (ly:music-property m 'value)))
1392 (ly:music-property m 'symbol)))
1395 (ly:music-property m 'symbol)
1396 (ly:music-property m 'grob-value)
1398 ((ly:music-property m 'grob-property #f) => list)
1400 (ly:music-property m 'grob-property-path)))))
1403 (ly:music-property m 'symbol)
1405 ((ly:music-property m 'grob-property #f) => list)
1407 (ly:music-property m 'grob-property-path)))))))
1408 (case (ly:music-property m 'name)
1410 (ly:add-context-mod mods
1412 (ly:music-property m 'procedure))))
1413 ((ContextSpeccedMusic)
1415 (eq? ctx (ly:music-property m 'context-type)))
1416 (musicop (ly:music-property m 'element))))
1418 (let ((callback (ly:music-property m 'elements-callback)))
1419 (if (procedure? callback)
1420 (for-each musicop (callback m))))))))
1425 #(define-music-function (offsets item)
1426 (list? symbol-list-or-music?)
1427 (_i "Offset control-points of @var{item} by @var{offsets}. The
1428 argument is a list of number pairs or list of such lists. Each
1429 element of a pair represents an offset to one of the coordinates of a
1430 control-point. If @var{item} is a string, the result is
1431 @code{\\once\\override} for the specified grob type. If @var{item} is
1432 a music expression, the result is the same music expression with an
1433 appropriate tweak applied.")
1434 (define (shape-curve grob)
1435 (let* ((orig (ly:grob-original grob))
1436 (siblings (if (ly:spanner? grob)
1437 (ly:spanner-broken-into orig) '()))
1438 (total-found (length siblings))
1439 (function (assoc-get 'control-points
1440 (reverse (ly:grob-basic-properties grob))))
1441 (coords (function grob)))
1443 (define (offset-control-points offsets)
1447 (lambda (x y) (coord-translate x y))
1450 (define (helper sibs offs)
1452 (if (eq? (car sibs) grob)
1453 (offset-control-points (car offs))
1454 (helper (cdr sibs) (cdr offs)))
1457 ;; we work with lists of lists
1458 (if (or (null? offsets)
1459 (not (list? (car offsets))))
1460 (set! offsets (list offsets)))
1462 (if (>= total-found 2)
1463 (helper siblings offsets)
1464 (offset-control-points (car offsets)))))
1465 (once (tweak 'control-points shape-curve item)))
1468 #(define-music-function (dur dots arg)
1469 (integer? integer? ly:music?)
1470 (_i "Change the duration of @var{arg} by adding @var{dur} to the
1471 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1473 (shift-duration-log arg dur dots))
1476 #(define-music-function (overrides music)
1477 (ly:music? ly:music?)
1478 (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1479 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1480 (set! (ly:music-property music 'tweaks)
1482 (lambda (m) (eq? (ly:music-property m 'name)
1486 ((ly:music-property m 'grob-property #f) => list)
1488 (ly:music-property m 'grob-property-path)))))
1489 (acons (cons (ly:music-property m 'symbol) ;grob name
1491 p ;grob property path
1492 (car p))) ;grob property
1493 (ly:music-property m 'grob-value)
1495 (ly:music-property music 'tweaks)
1500 #(define-music-function (dur) (ly:duration?)
1501 (_i "Skip forward by @var{dur}.")
1502 (make-music 'SkipMusic
1507 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1508 (_i "Create slashed graces (slashes through stems, but no slur) from
1509 the following music expression"))
1512 #(define-music-function (parameters) (list?)
1513 (_i "Set the system stretch, by reading the 'system-stretch property of
1514 the `parameters' assoc list.")
1516 '(Score NonMusicalPaperColumn line-break-system-details)
1517 (list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1518 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))))
1521 #(define-music-function (style heads music)
1522 (symbol? symbol-list-or-symbol? ly:music?)
1523 (_i "Set @var{heads} in @var{music} to @var{style}.")
1524 (style-note-heads heads style music))
1527 #(define-music-function (tags music) (symbol-list-or-symbol? ly:music?)
1528 (_i "Tag the following @var{music} with @var{tags} and return the
1529 result, by adding the single symbol or symbol list @var{tags} to the
1530 @code{tags} property of @var{music}.")
1533 (ly:music-property music 'tags)
1534 ((if (symbol? tags) cons append)
1536 (ly:music-property music 'tags)))
1540 #(define-void-function (tags) (symbol-list?)
1541 (_i "Define a tag group comprising the symbols in the symbol list
1542 @var{tags}. Tag groups must not overlap.")
1543 (let ((err (define-tag-group tags)))
1544 (if err (ly:parser-error (*parser*) err (*location*)))))
1547 #(define-music-function (music)
1549 (_i "Make any @code{\\override} in @var{music} replace an existing
1550 grob property value only temporarily, restoring the old value when a
1551 corresponding @code{\\revert} is executed. This is achieved by
1552 clearing the @samp{pop-first} property normally set on
1555 An @code{\\override}/@/@code{\\revert} sequence created by using
1556 @code{\\temporary} and @code{\\undo} on the same music containing
1557 overrides will cancel out perfectly or cause a@tie{}warning.
1559 Non-property-related music is ignored, warnings are generated for any
1560 property-changing music that isn't an @code{\\override}.")
1564 (and (or (music-is-of-type? m 'layout-instruction-event)
1565 (music-is-of-type? m 'context-specification)
1566 (music-is-of-type? m 'apply-context)
1567 (music-is-of-type? m 'time-signature-music))
1568 (case (ly:music-property m 'name)
1570 (if (ly:music-property m 'pop-first #f)
1571 (set! (ly:music-property m 'pop-first) '()))
1572 (if (ly:music-property m 'once #f)
1573 (set! (ly:music-property m 'once) '()))
1575 ((ContextSpeccedMusic)
1580 (ly:input-warning (*location*) (_ "Cannot make ~a revertible")
1581 (ly:music-property m 'name))
1588 #(define-music-function (beat-structure fraction)
1589 ((number-list? '()) fraction?)
1590 (_i "Set @var{fraction} as time signature, with optional
1591 number list @var{beat-structure} before it.")
1592 (make-music 'TimeSignatureMusic
1593 'numerator (car fraction)
1594 'denominator (cdr fraction)
1595 'beat-structure beat-structure))
1598 #(define-music-function (fraction music)
1599 (fraction? ly:music?)
1600 (_i "Scale @var{music} in time by @var{fraction}.")
1601 (make-music 'TimeScaledMusic
1602 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1603 'numerator (car fraction)
1604 'denominator (cdr fraction)))
1607 #(define-music-function
1609 (ly:pitch? ly:pitch? ly:music?)
1611 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1612 (make-music 'TransposedMusic
1613 'element (ly:music-transpose music (ly:pitch-diff to from))))
1615 transposedCueDuring =
1616 #(define-music-function
1617 (what dir pitch main-music)
1618 (string? ly:dir? ly:pitch? ly:music?)
1620 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1621 using the transposition defined by @var{pitch}. This happens
1622 simultaneously with @var{main-music}, which is usually a rest. The
1623 argument @var{dir} determines whether the cue notes should be notated
1624 as a first or second voice.")
1626 (make-music 'QuoteMusic
1628 'quoted-context-type 'CueVoice
1629 'quoted-context-id "cue"
1630 'quoted-music-name what
1631 'quoted-voice-direction dir
1632 ;; following is inverse of instrumentTransposition for
1633 ;; historical reasons
1634 'quoted-transposition pitch))
1637 #(define-music-function (pitch) (ly:pitch?)
1638 (_i "Set instrument transposition")
1641 (make-property-set 'instrumentTransposition pitch)
1645 #(define-music-function (ratio tuplet-span music)
1646 (fraction? (ly:duration? '()) ly:music?)
1647 (_i "Scale the given @var{music} to tuplets. @var{ratio} is a
1648 fraction that specifies how many notes are played in place of the
1649 nominal value: it will be @samp{3/2} for triplets, namely three notes
1650 being played in place of two. If the optional duration
1651 @var{tuplet-span} is specified, it is used instead of
1652 @code{tupletSpannerDuration} for grouping the tuplets.
1655 \\tuplet 3/2 4 @{ c8 c c c c c @}
1657 will result in two groups of three tuplets, each group lasting for a
1659 (make-music 'TimeScaledMusic
1660 'element (ly:music-compress
1662 (ly:make-moment (cdr ratio) (car ratio)))
1663 'numerator (cdr ratio)
1664 'denominator (car ratio)
1665 'duration tuplet-span))
1668 #(define-music-function (tuplet-span)
1670 (_i "Set @code{tupletSpannerDuration}, the length into which
1671 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1672 own will group its tuplets, to the duration @var{tuplet-span}. To
1673 revert to the default of not subdividing the contents of a @code{\\tuplet}
1674 command without explicit @samp{tuplet-span}, use
1676 \\tupletSpan \\default
1680 #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1681 #{ \unset tupletSpannerDuration #}))
1684 #(define-music-function (prop value item)
1685 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1686 (_i "Add a tweak to the following @var{item}, usually music.
1687 Layout objects created by @var{item} get their property @var{prop}
1688 set to @var{value}. If @var{prop} has the form @samp{Grob.property}, like with
1690 \\tweak Accidental.color #red cis'
1692 an indirectly created grob (@samp{Accidental} is caused by
1693 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1696 As a special case, @var{item} may be a symbol list specifying a grob
1697 path, in which case @code{\\override} is called on it instead of
1698 creating tweaked music. This is mainly useful when using
1699 @code{\\tweak} as as a component for building other functions.
1701 If this use case would call for @code{\\once \\override} rather than a
1702 plain @code{\\override}, writing @code{\\once \\tweak @dots{}} can be
1705 @var{prop} can contain additional elements in which case a nested
1706 property (inside of an alist) is tweaked.")
1707 (if (ly:music? item)
1708 (let ((p (check-grob-path prop (*parser*) (*location*)
1713 (set! (ly:music-property item 'tweaks)
1714 (acons (cond ((pair? (cddr p)) p)
1716 (cons (car p) (cadr p)))
1719 (ly:music-property item 'tweaks))))
1721 ;; We could just throw this at \override and let it sort this
1722 ;; out on its own, but this way we should get better error
1724 (let ((p (check-grob-path
1725 (append item (if (symbol? prop) (list prop) prop))
1726 (*parser*) (*location*)
1727 #:default 'Bottom #:min 3)))
1729 #{ \override #p = #value #}
1730 (make-music 'Music)))))
1733 #(define-music-function (music)
1735 (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1736 @code{\\revert} and @code{\\unset}, respectively. Any reverts and
1737 unsets already in @var{music} cause a warning. Non-property-related music is ignored.")
1744 (lambda (m) (or (music-is-of-type? m 'layout-instruction-event)
1745 (music-is-of-type? m 'context-specification)
1746 (music-is-of-type? m 'apply-context)
1747 (music-is-of-type? m 'time-signature-music)))
1748 (lambda (m overrides)
1749 (case (ly:music-property m 'name)
1752 (make-music 'RevertProperty
1753 'symbol (ly:music-property m 'symbol)
1756 ((ly:music-property m 'grob-property #f) => list)
1758 (ly:music-property m 'grob-property-path))))
1762 (make-music 'PropertyUnset
1763 'symbol (ly:music-property m 'symbol))
1765 ((ContextSpeccedMusic)
1767 (make-music 'ContextSpeccedMusic
1768 'element (loop (ly:music-property m 'element))
1769 'context-type (ly:music-property m 'context-type))
1774 (ly:input-warning (*location*) (_ "Cannot revert ~a")
1775 (ly:music-property m 'name))
1781 ((null? lst) (make-music 'Music))
1782 ((null? (cdr lst)) (car lst))
1783 (else (make-sequential-music lst))))))
1786 #(define-music-function (music) (ly:music?)
1787 (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1788 @code{\\repeat percent} commands in @var{music} to be interpreted
1789 as @code{\\repeat unfold}.")
1790 (unfold-repeats music))
1793 #(define-void-function (arg) (scheme?)
1794 (_i "Accept a scheme argument, return a void expression.
1795 Use this if you want to have a scheme expression evaluated
1796 because of its side-effects, but its value ignored."))
1799 #(define-music-function (sym val music)
1800 (symbol? scheme? ly:music?)
1801 (_i "Set @var{sym} to @var{val} in @var{music}.")
1803 (set! (ly:music-property music sym) val)