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 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 '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 (*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))))
122 (propertyOverride (append item (if (symbol? property)
125 (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 (target proc) (symbol-list-or-symbol? procedure?)
156 (_i "Apply function @code{proc} to every layout object matched by
157 @var{target} which takes the form @code{Context} or @code{Context.Grob}.")
158 (let ((p (check-grob-path target (*location*) #:max 2)))
160 (make-music 'ApplyOutputEvent
162 'context-type (car p)
164 (list (cons 'symbol (cadr p)))
166 (make-music 'Music))))
169 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
170 (_i "Create an appoggiatura from @var{music}"))
172 % for regression testing purposes.
174 #(define-music-function (l r) (pair? pair?)
175 (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
176 (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
178 % for regression testing purposes.
180 #(define-music-function (comp) (procedure?)
181 (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
182 (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
185 #(define-music-function (pitch clef-1 clef-2 music)
186 ((ly:pitch? (ly:make-pitch 0 0)) (ly:context-mod?)(ly:context-mod?) ly:music?)
187 (_i "Make voices that switch between staves automatically. As an option the
188 pitch where to switch staves may be specified. The clefs for the staves are
189 optional as well. Setting clefs works only for implicitly instantiated
191 (let ;; keep the contexts alive for the full duration
192 ((skip (make-duration-of-length (ly:music-length music)))
193 (clef-1 (or clef-1 #{ \with { \clef "treble" } #}))
194 (clef-2 (or clef-2 #{ \with { \clef "bass" } #})))
195 (make-simultaneous-music
197 (descend-to-context (make-autochange-music pitch music) 'Staff
199 (context-spec-music (make-skip-music skip) 'Staff
201 (context-spec-music (make-skip-music skip) 'Staff
205 #(define-music-function (grob-name offset text)
206 (symbol? number-pair? markup?)
207 (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
208 (use like @code{\\once})")
211 (make-music 'AnnotateOutputEvent
213 'X-offset (car offset)
214 'Y-offset (cdr offset)
218 #(define-event-function (offset text) (number-pair? markup?)
219 (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
220 (make-music 'AnnotateOutputEvent
221 'X-offset (car offset)
222 'Y-offset (cdr offset)
226 #(define-music-function (type) (string?)
227 (_i "Insert a bar line of type @var{type}")
229 (make-property-set 'whichBar type)
233 #(define-music-function (n) (integer?)
234 (_i "Print a warning if the current bar number is not @var{n}.")
235 (make-music 'ApplyContext
238 (let ((cbn (ly:context-property c 'currentBarNumber)))
239 (if (and (number? cbn) (not (= cbn n)))
240 (ly:input-warning (*location*)
241 "Barcheck failed got ~a expect ~a"
245 #(define-scheme-function (music) (ly:music?)
246 (_i "Extract a value suitable for setting
247 @code{Timing.beamExceptions} from the given pattern with explicit
248 beams in @var{music}. A bar check @code{|} has to be used between
249 bars of patterns in order to reset the timing.")
250 (extract-beam-exceptions music))
253 #(define-event-function (delta) (real?)
254 (_i "Create a fall or doit of pitch interval @var{delta}.")
255 (make-music 'BendAfterEvent
259 #(define-void-function (newfilename) (string?)
260 (_i "Direct output for the current book block to @var{newfilename}.")
261 (set! (paper-variable #f 'output-filename) newfilename))
264 #(define-void-function (newsuffix) (string?)
265 (_i "Set the output filename suffix for the current book block to
267 (set! (paper-variable #f 'output-suffix) newsuffix))
269 %% \breathe is defined as a music function rather than an event identifier to
270 %% ensure it gets useful input location information: as an event identifier,
271 %% it would have to be wrapped in an EventChord to prevent it from being
272 %% treated as a post_event by the parser
274 #(define-music-function () ()
275 (_i "Insert a breath mark.")
276 (make-music 'BreathingEvent))
279 #(define-music-function (type) (string?)
280 (_i "Set the current clef to @var{type}.")
281 (make-clef-set type))
285 #(define-music-function (args) (pair?)
286 (_i "Create compound time signatures. The argument is a Scheme list of
287 lists. Each list describes one fraction, with the last entry being the
288 denominator, while the first entries describe the summands in the
289 enumerator. If the time signature consists of just one fraction,
290 the list can be given directly, i.e. not as a list containing a single list.
291 For example, a time signature of (3+1)/8 + 2/4 would be created as
292 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
293 as @code{\\compoundMeter #'((3 2 8))} or shorter
294 @code{\\compoundMeter #'(3 2 8)}.")
295 (let* ((mlen (calculate-compound-measure-length args))
296 (beat (calculate-compound-base-beat args))
297 (beatGrouping (calculate-compound-beat-grouping args))
298 (timesig (cons (ly:moment-main-numerator mlen)
299 (ly:moment-main-denominator mlen))))
301 \once \override Timing.TimeSignature.stencil = #(lambda (grob)
302 (grob-interpret-markup grob (make-compound-meter-markup args)))
303 \set Timing.timeSignatureFraction = #timesig
304 \set Timing.baseMoment = #beat
305 \set Timing.beatStructure = #beatGrouping
306 \set Timing.beamExceptions = #'()
307 \set Timing.measureLength = #mlen
311 #(define-music-function (music) (ly:music?)
312 (_i "Remove the empty bars created by multi-measure rests,
313 leaving just the first bar containing the MM rest itself.")
316 (if (eq? 'MultiMeasureRestMusic (ly:music-property m 'name))
317 #{ \once \set Score.skipBars = ##t #m #}
322 #(define-music-function (notes) (ly:music?)
323 (_i "Create cross-staff stems")
325 \temporary \override Stem.cross-staff = #cross-staff-connect
326 \temporary \override Flag.style = #'no-flag
328 \revert Stem.cross-staff
333 #(define-music-function (type) (string?)
334 (_i "Set the current cue clef to @var{type}.")
335 (make-cue-clef-set type))
338 #(define-music-function () ()
339 (_i "Unset the current cue clef.")
340 (make-cue-clef-unset))
343 #(define-music-function
344 (what dir main-music) (string? ly:dir? ly:music?)
345 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
346 in a CueVoice oriented by @var{dir}.")
347 (make-music 'QuoteMusic
349 'quoted-context-type 'CueVoice
350 'quoted-context-id "cue"
351 'quoted-music-name what
352 'quoted-voice-direction dir))
355 #(define-music-function
356 (what dir clef main-music) (string? ly:dir? string? ly:music?)
357 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
358 in a CueVoice oriented by @var{dir}.")
359 (make-music 'QuoteMusic
361 'quoted-context-type 'CueVoice
362 'quoted-context-id "cue"
363 'quoted-music-name what
364 'quoted-music-clef clef
365 'quoted-voice-direction dir))
370 #(define-music-function (port music) ((output-port?) ly:music?)
371 (_i "Display the LilyPond input representation of @var{music}
372 to @var{port}, defaulting to the console.")
373 (let ((port (or port (current-output-port))))
375 (display-lily-music music port))
379 #(define-music-function (port music) ((output-port?) ly:music?)
380 (_i "Display the internal representation of @var{music} to
381 @var{port}, default to the console.")
382 (let ((port (or port (current-output-port))))
384 (display-scheme-music music port))
388 #(define-scheme-function (port expr) ((output-port?) scheme?)
389 (_i "Display the internal representation of @var{expr} to
390 @var{port}, default to the console.")
391 (let ((port (or port (current-output-port))))
393 (display-scheme-music expr port))
399 #(define-music-function (music) (ly:music?)
400 (_i "Terminate the next spanner prematurely after exactly one note
401 without the need of a specific end spanner.")
402 (let* ((start-span-evs (filter (lambda (ev)
403 (equal? (ly:music-property ev 'span-direction)
405 (extract-typed-music music 'span-event)))
408 (music-clone m 'span-direction STOP))
410 (end-ev-chord (make-music 'EventChord
411 'elements stop-span-evs))
412 (total (make-music 'SequentialMusic
413 'elements (list music
418 #(define-music-function (music) (ly:music?)
419 (_i "Compatibility function wrapping @code{EventChord} around
420 isolated rhythmic events occuring since version 2.15.28, after
421 expanding repeat chords @samp{q}.")
422 (event-chord-wrap! music))
425 #(define-music-function (factor argument) (ly:moment? ly:music?)
426 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
427 (let ((orig-duration (ly:music-length argument))
428 (multiplier (ly:make-moment 1 1)))
432 (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
434 (ly:music-compress mus multiplier)
435 (set! multiplier (ly:moment-mul factor multiplier)))))
436 (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
439 (ly:moment-div orig-duration (ly:music-length argument)))
444 #(define-event-function (finger) (number-or-markup?)
445 (_i "Apply @var{finger} as a fingering indication.")
449 (if (number? finger) 'digit 'text)
453 #(define-music-function (pitch music)
454 (ly:pitch? ly:music?)
455 (_i "Use the octave of @var{pitch} as the default octave for @var{music}.")
456 (let ((octave-marks (1+ (ly:pitch-octave pitch))))
457 (cond ((not (= 0 octave-marks))
458 (ly:music-transpose music (ly:make-pitch octave-marks 0 0))
459 ;;In order to leave unchanged the notes in any enclosed
460 ;; \absolute or \fixed or \relative, make a cancelling shift
462 (ly:music-transpose m (ly:make-pitch (- octave-marks) 0 0)))
463 (extract-named-music music 'RelativeOctaveMusic)))))
464 (make-music 'RelativeOctaveMusic 'element music))
467 #(define-music-function (mark offset footnote item)
468 ((markup?) number-pair? markup? symbol-list-or-music?)
469 (_i "Make the markup @var{footnote} a footnote on @var{item}. The
470 footnote is marked with a markup @var{mark} moved by @var{offset} with
471 respect to the marked music.
473 If @var{mark} is not given or specified as @var{\\default}, it is
474 replaced by an automatically generated sequence number. If @var{item}
475 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
476 grobs of that type will be marked at the current time step in the
477 given context (default @code{Bottom}).
479 If @var{item} is music, the music will get a footnote attached to a
480 grob immediately attached to the event, like @var{\\tweak} does. For
481 attaching a footnote to an @emph{indirectly} caused grob, write
482 @code{\\single\\footnote}, use @var{item} to specify the grob, and
483 follow it with the music to annotate.
485 Like with @code{\\tweak}, if you use a footnote on a following
486 post-event, the @code{\\footnote} command itself needs to be attached
487 to the preceding note or rest as a post-event with @code{-}.")
488 (let ((mus (make-music
490 'X-offset (car offset)
491 'Y-offset (cdr offset)
492 'automatically-numbered (not mark)
493 'text (or mark (make-null-markup))
494 'footnote-text footnote)))
495 (once (propertyTweak 'footnote-music mus item))))
498 #(def-grace-function startGraceMusic stopGraceMusic
499 (_i "Insert @var{music} as grace notes."))
502 #(define-scheme-function (descriptions) (list?)
503 (_i "Create a context modification from @var{descriptions}, a list
504 in the format of @code{all-grob-descriptions}.")
507 (list 'assign (car p) (ly:make-grob-properties (cdr p))))
510 harmonicByFret = #(define-music-function (fret music) (number? ly:music?)
511 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
512 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
514 \set harmonicDots = ##t
515 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
516 \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
517 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
518 (ly:note-head::print grob))
520 (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
522 \revert TabNoteHead.stencil
523 \revert NoteHead.Y-extent
524 \revert NoteHead.stencil
527 harmonicByRatio = #(define-music-function (ratio music) (number? ly:music?)
528 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
529 harmonics played on a fretted instrument by touching the strings at the point
530 given through @var{ratio}.")
532 \set harmonicDots = ##t
533 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
534 \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height)
535 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
536 (ly:note-head::print grob))
538 (calc-harmonic-pitch (ratio->pitch ratio) music))
540 \revert TabNoteHead.stencil
541 \revert NoteHead.Y-extent
542 \revert NoteHead.stencil
546 #(define-music-function (item) (symbol-list-or-music?)
547 (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
548 making it invisible while still retaining its dimensions.
550 If @var{item} is a symbol list of form @code{GrobName} or
551 @code{Context.GrobName}, the result is an override for the grob name
552 specified by it. If @var{item} is a music expression, the result is
553 the same music expression with an appropriate tweak applied to it.")
554 (propertyTweak 'transparent #t item))
557 #(define-music-function () ()
558 (_i "Put the segno variant 'varsegno' at this position into the staff,
559 compatible with the repeat command.")
560 (make-music 'ApplyContext
563 (let ((score-ctx (ly:context-find ctx 'Score)))
564 (if (ly:context? score-ctx)
565 (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
566 (if (eq? (memq 'segno-display old-rc) #f)
567 (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
570 #(define-music-function
572 (_i "Switch instrument to @var{name}, which must be predefined with
573 @code{\\addInstrumentDefinition}.")
574 (let* ((handle (assoc name instrument-definitions))
575 (instrument-def (if handle (cdr handle) '())))
578 (ly:input-warning (*location*) "No such instrument: ~a" name))
580 (make-music 'SimultaneousMusic
592 #(define-music-function (tags music)
593 (symbol-list-or-symbol? ly:music?)
594 (_i "Include only elements of @var{music} that are tagged with one
595 of the tags in @var{tags}. @var{tags} may be either a single symbol
596 or a list of symbols.
598 Each tag may be declared as a member of at most one tag group (defined
599 with @code{\\tagGroup}). If none of a @var{music} element's tags
600 share a tag group with one of the specified @var{tags}, the element is
603 (tags-keep-predicate tags)
607 #(define-music-function (tonic pitch-alist)
608 ((ly:pitch? '()) (list? '()))
609 (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
610 If both are null, just generate @code{KeyChangeEvent}.")
611 (cond ((null? tonic) (make-music 'KeyChangeEvent))
613 (ly:parser-error (_ "second argument must be pitch list")
615 (make-music 'SequentialMusic 'void #t))
618 (make-music 'KeyChangeEvent
619 'tonic (ly:make-pitch 0 0 0)
620 'pitch-alist pitch-alist)
624 #(define-music-function (music) (ly:music?)
625 (_i "Remove cue notes from @var{music}.")
628 (if (and (string? (ly:music-property mus 'quoted-music-name))
629 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
630 (ly:music-property mus 'element)
637 #(define-music-function (label) (symbol?)
638 (_i "Create @var{label} as a bookmarking label.")
639 (make-music 'EventChord
642 'elements (list (make-music 'LabelEvent
643 'page-label label))))
647 #(define-void-function (language) (string?)
648 (_i "Set note names for language @var{language}.")
649 (note-names-language language))
651 languageSaveAndChange =
652 #(define-void-function (language) (string?)
653 (_i "Store the previous pitchnames alist, and set a new one.")
654 (set! previous-pitchnames pitchnames)
655 (note-names-language language))
658 #(define-void-function () ()
659 (_i "Restore a previously-saved pitchnames alist.")
660 (if previous-pitchnames
662 (set! pitchnames previous-pitchnames)
663 (ly:parser-set-note-names pitchnames))
664 (ly:input-warning (*location*) (_ "No other language was defined previously. Ignoring."))))
668 #(define-music-function (mag music) (positive? ly:music?)
669 (_i "Magnify the notation of @var{music} without changing the
670 staff-size, using @var{mag} as a size factor. Stems, beams,
671 slurs, ties, and horizontal spacing are adjusted automatically.")
673 ;; these props are NOT allowed to shrink below default size
674 (define unshrinkable-props
680 (Slur line-thickness)
682 (PhrasingSlur line-thickness)
683 (PhrasingSlur thickness)
688 (LaissezVibrerTie line-thickness)
689 (LaissezVibrerTie thickness)
690 (RepeatTie line-thickness)
691 (RepeatTie thickness)
694 ;; these props ARE allowed to shrink below default size
695 (define shrinkable-props
696 (let ((baseline-skip-props
697 (find-named-props 'baseline-skip all-grob-descriptions))
699 (find-named-props 'word-space all-grob-descriptions)))
704 ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed
705 ;; override at the 'Score level
706 ;(SpacingSpanner spacing-increment)
708 ;; lengths and heights
709 (Beam length-fraction)
710 (Stem length-fraction)
711 (Stem beamlet-default-length)
712 (Stem double-stem-separation)
714 (Slur minimum-length)
715 (PhrasingSlur height-limit)
716 (PhrasingSlur minimum-length)
718 ;; Beam.beam-thickness is dealt with separately below
722 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
724 #(scale-fontSize 'magnifyMusic mag)
725 #(scale-props 'magnifyMusic mag #f unshrinkable-props)
726 #(scale-props 'magnifyMusic mag #t shrinkable-props)
727 #(scale-beam-thickness mag)
731 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
733 %% reverse engineer the former fontSize value instead of using \unset
734 #(revert-fontSize 'magnifyMusic mag)
735 #(revert-props 'magnifyMusic mag (append unshrinkable-props
737 '((Beam beam-thickness))))
742 #(define-music-function (mag) (positive?)
743 (_i "Change the size of the staff, adjusting notation size and
744 horizontal spacing automatically, using @var{mag} as a size factor.")
746 ;; these props are NOT allowed to shrink below default size
747 (define unshrinkable-props
748 '((StaffSymbol thickness)))
750 ;; these props ARE allowed to shrink below default size
751 (define shrinkable-props
752 (let* ((baseline-skip-props
753 (find-named-props 'baseline-skip all-grob-descriptions))
755 (find-named-props 'word-space all-grob-descriptions))
757 (find-named-props 'space-alist all-grob-descriptions)))
763 ;; override at the 'Score level
764 (SpacingSpanner spacing-increment)
766 (StaffSymbol staff-space)
769 (BarLine hair-thickness)
770 (BarLine thick-thickness)
771 (Stem beamlet-default-length)
772 (Stem double-stem-separation)
778 %% revert settings from last time
779 %% (but only if \magnifyStaff has already been used
780 %% and the staff magnification is changing)
781 #(revert-fontSize 'magnifyStaff mag)
782 #(revert-props 'magnifyStaff mag (append unshrinkable-props
786 %% (but only if staff magnification is changing
787 %% and does not equal 1)
788 #(scale-fontSize 'magnifyStaff mag)
789 #(scale-props 'magnifyStaff mag #f unshrinkable-props)
790 #(scale-props 'magnifyStaff mag #t shrinkable-props)
792 %% this might cause problems until Issue 3990 is fixed
796 \set Staff.magnifyStaffValue = #mag
800 #(define-music-function (arg) (ly:music?)
801 (_i "Display chords in @var{arg} as clusters.")
802 (music-map note-to-cluster arg))
805 #(define-music-function (around to scale music)
806 (ly:pitch? ly:pitch? ly:music? ly:music?)
807 (_i "Invert @var{music} about @var{around} using @var{scale} and
808 transpose from @var{around} to @var{to}.")
809 (let ((inverter (make-modal-inverter around to scale)))
810 (change-pitches music inverter)
814 #(define-music-function (from to scale music)
815 (ly:pitch? ly:pitch? ly:music? ly:music?)
816 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
818 (let ((transposer (make-modal-transposer from to scale)))
819 (change-pitches music transposer)
823 #(define-music-function
824 (around to music) (ly:pitch? ly:pitch? ly:music?)
825 (_i "Invert @var{music} about @var{around} and
826 transpose from @var{around} to @var{to}.")
827 (music-invert around to music))
830 #(define-music-function
831 (label) ((number-or-markup?))
832 "Make the music for the \\mark command."
833 (let* ((set (and (integer? label)
834 (context-spec-music (make-property-set 'rehearsalMark label)
836 (ev (make-music 'MarkEvent
837 'origin (*location*))))
840 (make-sequential-music (list set ev))
842 (if label (set! (ly:music-property ev 'label) label))
846 #(define-music-function (path markupfun music)
847 (symbol-list-or-symbol? markup-function? ly:music?)
848 (_i "This applies the given markup function @var{markupfun} to all markup
849 music properties matching @var{path} in @var{music}.
853 \\new Voice @{ g'2 c'' @}
855 \\markupMap LyricEvent.text
856 \\markup \\with-color #red \\etc
861 (let* ((p (check-music-path path (*location*)))
862 (name (and p (car p)))
863 (prop (and p (cadr p))))
867 (if (or (not name) (eq? (ly:music-property m 'name) name))
868 (let ((text (ly:music-property m prop)))
870 (set! (ly:music-property m prop)
871 (list markupfun text)))))
877 #(define-music-function (proc mus) (procedure? ly:music?)
878 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
879 (music-map proc mus))
881 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
882 %% because music identifiers are not allowed at top-level.
884 #(define-music-function () ()
885 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
886 markups), or inside a score.")
887 (make-music 'EventChord
889 'page-break-permission 'forbid
890 'elements (list (make-music 'PageBreakEvent
891 'break-permission '()))))
894 #(define-music-function () ()
895 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
896 markups), or inside a score.")
897 (make-music 'EventChord
899 'page-turn-permission 'forbid
900 'elements (list (make-music 'PageTurnEvent
901 'break-permission '()))))
906 #(define-music-function (pitch) (ly:pitch?)
908 (make-music 'RelativeOctaveCheck
912 #(define-music-function (property offsets item)
913 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
914 (_i "Offset the default value of @var{property} of @var{item} by
915 @var{offsets}. If @var{item} is a string, the result is
916 @code{\\override} for the specified grob type. If @var{item} is
917 a music expression, the result is the same music expression with an
918 appropriate tweak applied.")
920 ; In case of a tweak, grob property path is Grob.property
921 (let ((prop-path (check-grob-path
922 (if (symbol? property)
924 property) (*location*)
925 #:start 1 #:default #t #:min 2 #:max 2)))
927 ; If the head of the grob property path is a symbol--i.e.,
928 ; a grob name, produce a directed tweak. Otherwise, create
930 (if (symbol? (car prop-path))
931 (tweak prop-path (offsetter (second prop-path) offsets) item)
932 (tweak (second prop-path)
933 (offsetter (second prop-path) offsets)
936 ; In case of an override, grob property path is Context.Grob.property.
937 (let ((prop-path (check-grob-path
939 (if (symbol? property)
941 property)) (*location*)
942 #:default 'Bottom #:min 3 #:max 3)))
944 (propertyOverride prop-path (offsetter (third prop-path) offsets))
945 (make-music 'Music)))))
948 #(define-music-function (item) (symbol-list-or-music?)
949 (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
950 effectively omitting it without taking up space.
952 If @var{item} is a symbol list of form @code{GrobName} or
953 @code{Context.GrobName}, the result is an override for the grob name
954 specified by it. If @var{item} is a music expression, the result is
955 the same music expression with an appropriate tweak applied to it.")
956 (propertyTweak 'stencil #f item))
959 #(define-music-function (music) (ly:music?)
960 (_i "Set @code{once} to @code{#t} on all layout instruction events
961 in @var{music}. This will complain about music with an actual
962 duration. As a special exception, if @var{music} contains
963 @samp{tweaks} it will be silently ignored in order to allow for
964 @code{\\once \\propertyTweak} to work as both one-time override and proper
966 (if (not (pair? (ly:music-property music 'tweaks)))
969 (cond ((music-is-of-type? m 'layout-instruction-event)
970 (set! (ly:music-property m 'once) #t)
972 ((ly:duration? (ly:music-property m 'duration))
973 (ly:music-warning m (_ "Cannot apply \\once to timed music"))
980 #(define-music-function (octave) (integer?)
981 (_i "Set the octavation.")
982 (make-music 'OttavaMusic
983 'ottava-number octave))
985 overrideTimeSignatureSettings =
986 #(define-music-function
987 (time-signature base-moment beat-structure beam-exceptions)
988 (fraction? fraction? list? list?)
990 (_i "Override @code{timeSignatureSettings}
991 for time signatures of @var{time-signature} to have settings
992 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
994 ;; TODO -- add warning if largest value of grouping is
995 ;; greater than time-signature.
996 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
997 (override-time-signature-setting time-signature setting)))
1000 #(define-music-function (grob-property-path value)
1001 (symbol-list? scheme?)
1003 (_i "Set the grob property specified by @var{grob-property-path} to
1004 @var{value}. @var{grob-property-path} is a symbol list of the form
1005 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1006 with subproperties given as well.
1008 As opposed to @code{\\override} which overrides the context-dependent
1009 defaults with which a grob is created, this command uses
1010 @code{Output_property_engraver} at the grob acknowledge stage. This
1011 may be necessary for overriding values set after the initial grob
1013 (let ((p (check-grob-path grob-property-path (*location*)
1017 (make-music 'ApplyOutputEvent
1018 'context-type (first p)
1020 (lambda (grob orig-context context)
1022 (cdr (assoc 'name (ly:grob-property grob 'meta)))
1024 (ly:grob-set-nested-property!
1025 grob (cddr p) value))))
1026 (make-music 'Music))))
1033 %% pageBreak and pageTurn are music functions (iso music indentifiers),
1034 %% because music identifiers are not allowed at top-level.
1036 #(define-music-function () ()
1037 (_i "Force a page break. May be used at toplevel (i.e., between scores or
1038 markups), or inside a score.")
1039 (make-music 'EventChord
1041 'line-break-permission 'force
1042 'page-break-permission 'force
1043 'elements (list (make-music 'LineBreakEvent
1044 'break-permission 'force)
1045 (make-music 'PageBreakEvent
1046 'break-permission 'force))))
1049 #(define-music-function () ()
1050 (_i "Force a page turn between two scores or top-level markups.")
1051 (make-music 'EventChord
1053 'line-break-permission 'force
1054 'page-break-permission 'force
1055 'page-turn-permission 'force
1056 'elements (list (make-music 'LineBreakEvent
1057 'break-permission 'force)
1058 (make-music 'PageBreakEvent
1059 'break-permission 'force)
1060 (make-music 'PageTurnEvent
1061 'break-permission 'force))))
1064 #(define-void-function (voice-ids music) (list? ly:music?)
1065 (_i "Define parallel music sequences, separated by '|' (bar check signs),
1066 and assign them to the identifiers provided in @var{voice-ids}.
1068 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
1070 @var{music}: a music sequence, containing BarChecks as limiting expressions.
1075 \\parallelMusic #'(A B C) {
1085 The last bar checks in a sequence are not copied to the result in
1086 order to facilitate ending the last entry at non-bar boundaries.
1088 (define voice-count (length voice-ids))
1089 (define (bar-check? m)
1090 "Checks whether m is a bar check."
1091 (eq? (ly:music-property m 'name) 'BarCheck))
1092 (define (recurse-and-split-list lst)
1093 "Return either a list of music lists split along barchecks, or @code{#f}."
1094 (if (any bar-check? lst)
1095 (let* ((voices (apply circular-list (make-list voice-count '())))
1096 (current-voices voices)
1097 (current-sequence '()))
1100 (define (push-music m)
1101 "Push the music expression into the current sequence"
1102 (set! current-sequence (cons m current-sequence)))
1103 (define (change-voice)
1104 "Store the previously built sequence into the current voice and
1105 change to the following voice."
1106 (set-car! current-voices
1107 (cons current-sequence
1108 (car current-voices)))
1109 (set! current-sequence '())
1110 (set! current-voices (cdr current-voices)))
1111 (for-each (lambda (m)
1112 (let ((split? (recurse-and-split m)))
1121 (if (bar-check? m) (change-voice))))))
1123 (if (pair? current-sequence) (change-voice))
1124 ;; Un-circularize voices
1125 (set! voices (list-head voices voice-count))
1127 ;; Remove trailing bar checks to facilitate ending a
1128 ;; sequence on a non-bar, reverse partial sequences and sequences
1133 (if (and (pair? l) (pair? (car l))
1134 (bar-check? (caar l)))
1135 (cons (cdar l) (cdr l))
1139 ;; check sequence length
1140 (apply for-each (lambda seqs
1141 (define (seq-len seq)
1142 (reduce ly:moment-add
1144 (map ly:music-length seq)))
1145 (let ((moment-reference (seq-len (car seqs))))
1146 (for-each (lambda (seq)
1147 (if (not (equal? (seq-len seq)
1153 (_ "Bars in parallel music don't have the same length"))))
1156 (map concatenate! voices))
1157 (let ((deeper (map recurse-and-split lst)))
1158 (and (any pair? deeper)
1162 (ly:music-deep-copy (make-list voice-count m))))
1164 (define (recurse-and-split music)
1165 "This returns either a list of music split along barchecks, or
1167 (let* ((elt (ly:music-property music 'element))
1168 (elts (ly:music-property music 'elements))
1169 (split-elt (and (ly:music? elt) (recurse-and-split elt)))
1170 (split-elts (and (pair? elts) (recurse-and-split-list elts))))
1171 (and (or split-elt split-elts)
1174 (let ((m (ly:music-deep-copy music
1175 ;;; reassigning the origin of the parent only
1176 ;;; makes sense if the first expression in the
1177 ;;; result is from a distributed origin
1178 (or (and (ly:music? e) e)
1179 (and (pair? es) (car es))))))
1181 (set! (ly:music-property m 'element) e))
1183 (set! (ly:music-property m 'elements) es))
1185 (or split-elt (circular-list #f))
1186 (or split-elts (circular-list #f))))))
1187 (let ((voices (recurse-and-split music)))
1190 ;; bind voice identifiers to the voices
1191 (for-each (lambda (voice-id voice)
1192 (ly:parser-define! voice-id voice))
1194 (ly:music-warning music
1195 (_ "ignoring parallel music without barchecks")))))
1198 #(define-music-function (arg) (ly:music?)
1199 (_i "Tag @var{arg} to be parenthesized.")
1201 (if (memq 'event-chord (ly:music-property arg 'types))
1202 ;; arg is an EventChord -> set the parenthesize property
1203 ;; on all child notes and rests
1206 (if (or (memq 'note-event (ly:music-property ev 'types))
1207 (memq 'rest-event (ly:music-property ev 'types)))
1208 (set! (ly:music-property ev 'parenthesize) #t)))
1209 (ly:music-property arg 'elements))
1210 ;; No chord, simply set property for this expression:
1211 (set! (ly:music-property arg 'parenthesize) #t))
1214 #(define (make-directed-part-combine-music direction chord-range part1 part2
1215 one-context-settings
1216 two-context-settings
1217 shared-context-settings)
1219 (let* ((pc-music (make-music 'PartCombineMusic))
1220 (m1 (context-spec-music (make-non-relative-music part1) 'Voice "one"))
1221 (m2 (context-spec-music (make-non-relative-music part2) 'Voice "two"))
1222 (listener (ly:parser-lookup 'partCombineListener))
1223 (evs2 (recording-group-emulate m2 listener))
1224 (evs1 (recording-group-emulate m1 listener))
1226 (if (and (assoc "one" evs1) (assoc "two" evs2))
1227 (determine-split-list (reverse! (assoc-get "one" evs1) '())
1228 (reverse! (assoc-get "two" evs2) '())
1231 (L1 (ly:music-length part1))
1232 (L2 (ly:music-length part2))
1233 ;; keep the contexts alive for the full duration
1234 (skip (make-skip-music (make-duration-of-length
1235 (if (ly:moment<? L1 L2) L2 L1)))))
1237 (set! (ly:music-property pc-music 'elements)
1239 'PartCombinePartMusic
1241 'context-change-list
1242 (make-part-combine-context-changes
1243 default-part-combine-context-change-state-machine-one
1246 'PartCombinePartMusic
1248 'context-change-list
1249 (make-part-combine-context-changes
1250 default-part-combine-context-change-state-machine-two
1253 (set! (ly:music-property pc-music 'direction) direction)
1255 #{ \context Staff <<
1256 \context Voice = "one" \with #one-context-settings { #skip }
1257 \context Voice = "two" \with #two-context-settings { #skip }
1258 \context Voice = "shared" \with #shared-context-settings { #skip }
1259 \context Voice = "solo" { #skip }
1260 \context NullVoice = "null" { #skip }
1262 #(make-part-combine-marks
1263 default-part-combine-mark-state-machine split-list)
1267 #(define-music-function (chord-range part1 part2)
1268 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1269 (_i "Take the music in @var{part1} and @var{part2} and return
1270 a music expression containing simultaneous voices, where @var{part1}
1271 and @var{part2} are combined into one voice where appropriate.
1272 Optional @var{chord-range} sets the distance in steps between notes
1273 that may be combined into a chord or unison.")
1274 (make-directed-part-combine-music #f chord-range part1 part2
1275 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1276 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1280 #(define-music-function (chord-range part1 part2)
1281 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1282 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1283 that they share a staff with stems directed upward.")
1284 (make-directed-part-combine-music UP chord-range part1 part2
1285 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1286 #{ \with { \voiceThree \override DynamicLineSpanner.direction = #UP } #}
1287 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} ))
1290 #(define-music-function (chord-range part1 part2)
1291 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1292 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1293 that they share a staff with stems directed downward.")
1294 (make-directed-part-combine-music DOWN chord-range part1 part2
1295 #{ \with { \voiceFour \override DynamicLineSpanner.direction = #DOWN } #}
1296 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1297 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} ))
1300 #(define-music-function (type once) (boolean-or-symbol? boolean?)
1301 (_i "Override the part-combiner.")
1302 (make-music 'EventChord
1303 'elements (list (make-music 'PartCombineForceEvent
1306 partcombineApart = \partcombineForce #'apart ##f
1307 partcombineApartOnce = \partcombineForce #'apart ##t
1308 partcombineChords = \partcombineForce #'chords ##f
1309 partcombineChordsOnce = \partcombineForce #'chords ##t
1310 partcombineUnisono = \partcombineForce #'unisono ##f
1311 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
1312 partcombineSoloI = \partcombineForce #'solo1 ##f
1313 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
1314 partcombineSoloII = \partcombineForce #'solo2 ##f
1315 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
1316 partcombineAutomatic = \partcombineForce ##f ##f
1317 partcombineAutomaticOnce = \partcombineForce ##f ##t
1320 #(define-music-function (dur) (ly:duration?)
1321 (_i "Make a partial measure.")
1323 ;; We use `descend-to-context' here instead of `context-spec-music' to
1324 ;; ensure \partial still works if the Timing_translator is moved
1326 (context-spec-music (make-music 'PartialSet
1327 'origin (*location*)
1333 #(define-music-function
1334 (main-note secondary-note)
1335 (ly:music? ly:music?)
1336 (_i "Print a trill with @var{main-note} as the main note of the trill and
1337 print @var{secondary-note} as a stemless note head in parentheses.")
1338 (let* ((get-notes (lambda (ev-chord)
1339 (extract-named-music ev-chord 'NoteEvent)))
1340 (sec-note-events (get-notes secondary-note))
1341 (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1342 (if (pair? sec-note-events)
1344 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1345 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1347 (if (ly:pitch? trill-pitch)
1348 (for-each (lambda (m)
1349 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1351 (ly:input-warning (*location*) (_ "Second argument of \\pitchedTrill should be single note: "))
1352 (display sec-note-events)))
1355 (for-each (lambda (m)
1356 (ly:music-set-property! m 'force-accidental forced))
1361 #(define-music-function (grob-property-path value)
1362 (symbol-list? scheme?)
1363 (_i "Set the grob property specified by @var{grob-property-path} to
1364 @var{value}. @var{grob-property-path} is a symbol list of the form
1365 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1366 with subproperties given as well. This music function is mostly intended
1367 for use from Scheme as a substitute for the built-in @code{\\override}
1369 (let ((p (check-grob-path grob-property-path (*location*)
1374 (make-music 'OverrideProperty
1376 'origin (*location*)
1378 'grob-property-path (cddr p)
1381 (make-music 'Music))))
1384 #(define-music-function (grob-property-path)
1386 (_i "Revert the grob property specified by @var{grob-property-path} to
1387 its previous value. @var{grob-property-path} is a symbol list of the form
1388 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1389 with subproperties given as well. This music function is mostly intended
1390 for use from Scheme as a substitute for the built-in @code{\\revert}
1392 (let ((p (check-grob-path grob-property-path (*location*)
1397 (make-music 'RevertProperty
1399 'origin (*location*)
1400 'grob-property-path (cddr p))
1402 (make-music 'Music))))
1405 #(define-music-function (property-path value)
1406 (symbol-list-or-symbol? scheme?)
1407 (_i "Set the context property specified by @var{property-path} to
1408 @var{value}. This music function is mostly intended for use from
1409 Scheme as a substitute for the built-in @code{\\set} command.")
1410 (let ((p (check-context-path property-path (*location*))))
1413 (make-music 'PropertySet
1416 'origin (*location*))
1418 (make-music 'Music))))
1421 #(define-music-function (prop value item)
1422 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1423 (_i "Add a tweak to the following @var{item}, usually music.
1424 This generally behaves like @code{\\tweak} but will turn into an
1425 @code{\\override} when @var{item} is a symbol list.
1427 In that case, @var{item} specifies the grob path to override. This is
1428 mainly useful when using @code{\\propertyTweak} as as a component for
1429 building other functions like @code{\\omit}. It is not the default
1430 behavior for @code{\\tweak} since many input strings in
1431 @code{\\lyricmode} can serve equally as music or as symbols which
1432 causes surprising behavior when tweaking lyrics using the less
1433 specific semantics of @code{\\propertyTweak}.
1435 @var{prop} can contain additional elements in which case a nested
1436 property (inside of an alist) is tweaked.")
1437 ;; Why not instead make the parser treat strings preferably as
1438 ;; music in lyrics mode rather than as symbol? Because then
1440 ;; \tweak text "whatever" mylyrics
1442 ;; will try putting a lyric event with text "whatever" in the text
1443 ;; property of lyrics. So we want expressions allowing both
1444 ;; strings and lyrics to deliver strings: more complex conversions
1445 ;; should only be attempted when the simple uses don't match the
1447 (if (ly:music? item)
1448 (tweak prop value item)
1449 (propertyOverride (append item (if (symbol? prop) (list prop) prop))
1453 #(define-music-function (property-path)
1454 (symbol-list-or-symbol?)
1455 (_i "Unset the context property specified by @var{property-path}.
1456 This music function is mostly intended for use from Scheme as a
1457 substitute for the built-in @code{\\unset} command.")
1458 (let ((p (check-context-path property-path (*location*))))
1461 (make-music 'PropertyUnset
1463 'origin (*location*))
1465 (make-music 'Music))))
1468 #(define-music-function (tag more music)
1469 (symbol? ly:music? ly:music?)
1470 (_i "Add @var{more} to the front of @code{elements} of all music
1471 expressions in @var{music} that are tagged with @var{tag}.")
1472 (music-map (lambda (m)
1473 (if (memq tag (ly:music-property m 'tags))
1474 (set! (ly:music-property m 'elements)
1475 (cons more (ly:music-property m 'elements))))
1480 #(define-music-function (what main-music) (string? ly:music?)
1481 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
1482 of the quoted voice, as specified in an @code{\\addQuote} command.
1483 @var{main-music} is used to indicate the length of music to be quoted;
1484 usually contains spacers or multi-measure rests.")
1485 (make-music 'QuoteMusic
1487 'quoted-music-name what))
1491 #(define-music-function (pitch music)
1492 ((ly:pitch?) ly:music?)
1493 (_i "Make @var{music} relative to @var{pitch}. If @var{pitch} is
1494 omitted, the first note in @var{music} is given in absolute pitch.")
1495 ;; When \relative has no clear decision (can only happen with
1496 ;; scales with an even number of steps), it goes down (see
1497 ;; pitch.cc). The following formula puts out f for both the normal
1498 ;; 7-step scale as well as for a "shortened" scale missing the
1499 ;; final b. In either case, a first note of c will end up as c,
1500 ;; namely pitch (-1, 0, 0).
1501 (ly:make-music-relative! music
1506 ;; size of current scale:
1507 (ly:pitch-steps (ly:make-pitch 1 0))
1509 (make-music 'RelativeOctaveMusic
1513 #(define-music-function (tags music)
1514 (symbol-list-or-symbol? ly:music?)
1515 (_i "Remove elements of @var{music} that are tagged with one of the
1516 tags in @var{tags}. @var{tags} may be either a single symbol or a list
1519 (tags-remove-predicate tags)
1522 resetRelativeOctave =
1523 #(define-music-function (pitch) (ly:pitch?)
1524 (_i "Set the octave inside a \\relative section.")
1526 (make-music 'SequentialMusic
1527 'to-relative-callback
1528 (lambda (music last-pitch) pitch)))
1531 #(define-music-function (music)
1533 (_i "Return @var{music} in reverse order.")
1534 (retrograde-music music))
1536 revertTimeSignatureSettings =
1537 #(define-music-function
1541 (_i "Revert @code{timeSignatureSettings}
1542 for time signatures of @var{time-signature}.")
1543 (revert-time-signature-setting time-signature))
1546 #(define-event-function (finger) (number-or-markup?)
1547 (_i "Apply @var{finger} as a fingering indication.")
1551 (if (number? finger) 'digit 'text)
1555 #(define-music-function (fraction music)
1556 (fraction? ly:music?)
1557 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1558 (ly:music-compress music
1559 (ly:make-moment (car fraction) (cdr fraction))))
1562 #(define-scheme-function (ctx music)
1563 ((symbol?) ly:music?)
1564 (_i "Take the layout instruction events from @var{music}, optionally
1565 restricted to those applying to context type @var{ctx}, and return
1566 a context modification duplicating their effect.")
1567 (let ((mods (ly:make-context-mod)))
1569 (if (music-is-of-type? m 'layout-instruction-event)
1572 (case (ly:music-property m 'name)
1575 (ly:music-property m 'symbol)
1576 (ly:music-property m 'value)))
1579 (ly:music-property m 'symbol)))
1582 (ly:music-property m 'symbol)
1583 (ly:music-property m 'grob-value)
1585 ((ly:music-property m 'grob-property #f) => list)
1587 (ly:music-property m 'grob-property-path)))))
1590 (ly:music-property m 'symbol)
1592 ((ly:music-property m 'grob-property #f) => list)
1594 (ly:music-property m 'grob-property-path)))))))
1595 (case (ly:music-property m 'name)
1597 (ly:add-context-mod mods
1599 (ly:music-property m 'procedure))))
1600 ((ContextSpeccedMusic)
1602 (eq? ctx (ly:music-property m 'context-type)))
1603 (musicop (ly:music-property m 'element))))
1605 (let ((callback (ly:music-property m 'elements-callback)))
1606 (if (procedure? callback)
1607 (for-each musicop (callback m))))))))
1612 #(define-music-function (offsets item)
1613 (list? symbol-list-or-music?)
1614 (_i "Offset control-points of @var{item} by @var{offsets}. The
1615 argument is a list of number pairs or list of such lists. Each
1616 element of a pair represents an offset to one of the coordinates of a
1617 control-point. If @var{item} is a string, the result is
1618 @code{\\once\\override} for the specified grob type. If @var{item} is
1619 a music expression, the result is the same music expression with an
1620 appropriate tweak applied.")
1621 (define (shape-curve grob)
1622 (let* ((orig (ly:grob-original grob))
1623 (siblings (if (ly:spanner? grob)
1624 (ly:spanner-broken-into orig) '()))
1625 (total-found (length siblings))
1626 (function (assoc-get 'control-points
1627 (reverse (ly:grob-basic-properties grob))))
1628 (coords (function grob)))
1630 (define (offset-control-points offsets)
1634 (lambda (x y) (coord-translate x y))
1637 (define (helper sibs offs)
1639 (if (eq? (car sibs) grob)
1640 (offset-control-points (car offs))
1641 (helper (cdr sibs) (cdr offs)))
1644 ;; we work with lists of lists
1645 (if (or (null? offsets)
1646 (not (list? (car offsets))))
1647 (set! offsets (list offsets)))
1649 (if (>= total-found 2)
1650 (helper siblings offsets)
1651 (offset-control-points (car offsets)))))
1652 (once (propertyTweak 'control-points shape-curve item)))
1655 #(define-music-function (dur dots arg)
1656 (integer? integer? ly:music?)
1657 (_i "Change the duration of @var{arg} by adding @var{dur} to the
1658 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1660 (shift-duration-log arg dur dots))
1663 #(define-music-function (overrides music)
1664 (ly:music? ly:music?)
1665 (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1666 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1667 (set! (ly:music-property music 'tweaks)
1669 (lambda (m) (eq? (ly:music-property m 'name)
1673 ((ly:music-property m 'grob-property #f) => list)
1675 (ly:music-property m 'grob-property-path)))))
1676 (acons (cons (ly:music-property m 'symbol) ;grob name
1678 p ;grob property path
1679 (car p))) ;grob property
1680 (ly:music-property m 'grob-value)
1682 (ly:music-property music 'tweaks)
1687 #(define-music-function (dur) (ly:duration?)
1688 (_i "Skip forward by @var{dur}.")
1689 (make-music 'SkipMusic
1694 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1695 (_i "Create slashed graces (slashes through stems, but no slur) from
1696 the following music expression"))
1699 #(define-music-function (parameters) (list?)
1700 (_i "Set the system stretch, by reading the 'system-stretch property of
1701 the `parameters' assoc list.")
1703 '(Score NonMusicalPaperColumn line-break-system-details)
1704 (list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1705 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))))
1708 #(define-music-function (style heads music)
1709 (symbol? symbol-list-or-symbol? ly:music?)
1710 (_i "Set @var{heads} in @var{music} to @var{style}.")
1711 (style-note-heads heads style music))
1714 #(define-music-function (tags music) (symbol-list-or-symbol? ly:music?)
1715 (_i "Tag the following @var{music} with @var{tags} and return the
1716 result, by adding the single symbol or symbol list @var{tags} to the
1717 @code{tags} property of @var{music}.")
1720 (ly:music-property music 'tags)
1721 ((if (symbol? tags) cons append)
1723 (ly:music-property music 'tags)))
1727 #(define-void-function (tags) (symbol-list?)
1728 (_i "Define a tag group comprising the symbols in the symbol list
1729 @var{tags}. Tag groups must not overlap.")
1730 (let ((err (define-tag-group tags)))
1731 (if err (ly:parser-error err (*location*)))))
1734 #(define-music-function (music)
1736 (_i "Make any @code{\\override} in @var{music} replace an existing
1737 grob property value only temporarily, restoring the old value when a
1738 corresponding @code{\\revert} is executed. This is achieved by
1739 clearing the @samp{pop-first} property normally set on
1742 An @code{\\override}/@/@code{\\revert} sequence created by using
1743 @code{\\temporary} and @code{\\undo} on the same music containing
1744 overrides will cancel out perfectly or cause a@tie{}warning.
1746 Non-property-related music is ignored, warnings are generated for any
1747 property-changing music that isn't an @code{\\override}.")
1751 (and (or (music-is-of-type? m 'layout-instruction-event)
1752 (music-is-of-type? m 'context-specification)
1753 (music-is-of-type? m 'apply-context)
1754 (music-is-of-type? m 'time-signature-music))
1755 (case (ly:music-property m 'name)
1757 (if (ly:music-property m 'pop-first #f)
1758 (set! (ly:music-property m 'pop-first) '()))
1759 (if (ly:music-property m 'once #f)
1760 (set! (ly:music-property m 'once) '()))
1762 ((ContextSpeccedMusic)
1767 (ly:input-warning (*location*) (_ "Cannot make ~a revertible")
1768 (ly:music-property m 'name))
1775 #(define-music-function (beat-structure fraction)
1776 ((number-list? '()) fraction?)
1777 (_i "Set @var{fraction} as time signature, with optional
1778 number list @var{beat-structure} before it.")
1779 (make-music 'TimeSignatureMusic
1780 'numerator (car fraction)
1781 'denominator (cdr fraction)
1782 'beat-structure beat-structure))
1785 #(define-music-function (fraction music)
1786 (fraction? ly:music?)
1787 (_i "Scale @var{music} in time by @var{fraction}.")
1788 (make-music 'TimeScaledMusic
1789 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1790 'numerator (car fraction)
1791 'denominator (cdr fraction)))
1794 #(define-music-function
1796 (ly:pitch? ly:pitch? ly:music?)
1798 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1799 (make-music 'TransposedMusic
1800 'element (ly:music-transpose music (ly:pitch-diff to from))))
1802 transposedCueDuring =
1803 #(define-music-function
1804 (what dir pitch main-music)
1805 (string? ly:dir? ly:pitch? ly:music?)
1807 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1808 using the transposition defined by @var{pitch}. This happens
1809 simultaneously with @var{main-music}, which is usually a rest. The
1810 argument @var{dir} determines whether the cue notes should be notated
1811 as a first or second voice.")
1813 (make-music 'QuoteMusic
1815 'quoted-context-type 'CueVoice
1816 'quoted-context-id "cue"
1817 'quoted-music-name what
1818 'quoted-voice-direction dir
1819 ;; following is inverse of instrumentTransposition for
1820 ;; historical reasons
1821 'quoted-transposition pitch))
1824 #(define-music-function (pitch) (ly:pitch?)
1825 (_i "Set instrument transposition")
1828 (make-property-set 'instrumentTransposition pitch)
1832 #(define-music-function (ratio tuplet-span music)
1833 (fraction? (ly:duration? '()) ly:music?)
1834 (_i "Scale the given @var{music} to tuplets. @var{ratio} is a
1835 fraction that specifies how many notes are played in place of the
1836 nominal value: it will be @samp{3/2} for triplets, namely three notes
1837 being played in place of two. If the optional duration
1838 @var{tuplet-span} is specified, it is used instead of
1839 @code{tupletSpannerDuration} for grouping the tuplets.
1842 \\tuplet 3/2 4 @{ c8 c c c c c @}
1844 will result in two groups of three tuplets, each group lasting for a
1846 (make-music 'TimeScaledMusic
1847 'element (ly:music-compress
1849 (ly:make-moment (cdr ratio) (car ratio)))
1850 'numerator (cdr ratio)
1851 'denominator (car ratio)
1852 'duration tuplet-span))
1855 #(define-music-function (tuplet-span)
1857 (_i "Set @code{tupletSpannerDuration}, the length into which
1858 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1859 own will group its tuplets, to the duration @var{tuplet-span}. To
1860 revert to the default of not subdividing the contents of a @code{\\tuplet}
1861 command without explicit @samp{tuplet-span}, use
1863 \\tupletSpan \\default
1867 #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1868 #{ \unset tupletSpannerDuration #}))
1871 #(define-music-function (prop value music)
1872 (symbol-list-or-symbol? scheme? ly:music?)
1873 (_i "Add a tweak to the following @var{music}.
1874 Layout objects created by @var{music} get their property @var{prop}
1875 set to @var{value}. If @var{prop} has the form @samp{Grob.property}, like with
1877 \\tweak Accidental.color #red cis'
1879 an indirectly created grob (@samp{Accidental} is caused by
1880 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1883 @var{prop} can contain additional elements in which case a nested
1884 property (inside of an alist) is tweaked.")
1885 (let ((p (check-grob-path prop (*location*)
1890 ;; p now contains at least two elements. The first
1891 ;; element is #t when no grob has been explicitly
1892 ;; specified, otherwise it is a grob name.
1893 ((music-is-of-type? music 'context-specification)
1894 ;; This is essentially dealing with the case
1895 ;; \tweak color #red \propertyTweak font-size #3 NoteHead
1896 ;; namely when stacked tweaks end in a symbol list
1897 ;; rather than a music expression.
1899 ;; We have a tweak here to convert into an override,
1900 ;; so we need to know the grob to apply it to. That's
1901 ;; easy if we have a directed tweak, and otherwise we
1902 ;; need to find the symbol in the expression itself.
1903 (let* ((elt (ly:music-property music 'element))
1904 (seq (if (music-is-of-type? elt 'sequential-music)
1906 (make-sequential-music (list elt))))
1907 (elts (ly:music-property seq 'elements))
1908 (symbol (if (symbol? (car p))
1911 (ly:music-property (car elts)
1913 (if (symbol? symbol)
1915 (set! (ly:music-property seq 'elements)
1916 (cons (make-music 'OverrideProperty
1918 'grob-property-path (cdr p)
1921 'origin (*location*))
1923 (set! (ly:music-property music 'element) seq))
1925 (ly:parser-error (_ "Cannot \\tweak")
1927 (ly:music-message music (_ "untweakable"))))))
1929 (set! (ly:music-property music 'tweaks)
1930 (acons (cond ((pair? (cddr p)) p)
1932 (cons (car p) (cadr p)))
1935 (ly:music-property music 'tweaks)))))
1940 #(define-music-function (music)
1942 (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1943 @code{\\revert} and @code{\\unset}, respectively. Any reverts and
1944 unsets already in @var{music} cause a warning. Non-property-related music is ignored.")
1951 (music-type-predicate '(layout-instruction-event
1952 context-specification
1954 time-signature-music))
1955 (lambda (m overrides)
1956 (case (ly:music-property m 'name)
1959 (make-music 'RevertProperty
1960 'symbol (ly:music-property m 'symbol)
1963 ((ly:music-property m 'grob-property #f) => list)
1965 (ly:music-property m 'grob-property-path))))
1969 (make-music 'PropertyUnset
1970 'symbol (ly:music-property m 'symbol))
1972 ((ContextSpeccedMusic)
1974 (make-music 'ContextSpeccedMusic
1975 'element (loop (ly:music-property m 'element))
1976 'context-type (ly:music-property m 'context-type))
1981 (ly:input-warning (*location*) (_ "Cannot revert ~a")
1982 (ly:music-property m 'name))
1988 ((null? lst) (make-music 'Music))
1989 ((null? (cdr lst)) (car lst))
1990 (else (make-sequential-music lst))))))
1993 #(define-music-function (music) (ly:music?)
1994 (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1995 @code{\\repeat percent} commands in @var{music} to be interpreted
1996 as @code{\\repeat unfold}.")
1997 (unfold-repeats music))
2000 #(define-void-function (arg) (scheme?)
2001 (_i "Accept a scheme argument, return a void expression.
2002 Use this if you want to have a scheme expression evaluated
2003 because of its side-effects, but its value ignored."))
2006 #(define-music-function (sym val music)
2007 (symbol? scheme? ly:music?)
2008 (_i "Set @var{sym} to @var{val} in @var{music}.")
2010 (set! (ly:music-property music sym) val)