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)
33 #(define-music-function (music)
35 (_i "Make @var{music} absolute. This does not actually change the
36 music itself but rather hides it from surrounding @code{\\relative}
37 and @code{\\fixed} commands.")
38 (make-music 'RelativeOctaveMusic 'element music))
41 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
42 (_i "Create an acciaccatura from the following music expression"))
44 %% keep these two together
45 instrument-definitions = #'()
46 addInstrumentDefinition =
47 #(define-void-function
48 (name lst) (string? list?)
49 (_i "Create instrument @var{name} with properties @var{list}.")
50 (set! instrument-definitions (acons name lst instrument-definitions)))
53 #(define-void-function (name music) (string? ly:music?)
54 (_i "Define @var{music} as a quotable music expression named
56 (add-quotable name music))
58 %% keep these two together
59 afterGraceFraction = 3/4
61 #(define-music-function (fraction main grace) ((fraction?) ly:music? ly:music?)
62 (_i "Create @var{grace} note(s) after a @var{main} music expression.
64 The musical position of the grace expression is after a
65 given fraction of the main note's duration has passed. If
66 @var{fraction} is not specified as first argument, it is taken from
67 @code{afterGraceFraction} which has a default value of @code{3/4}.")
68 (let ((main-length (ly:music-length main))
69 (fraction (or fraction (ly:parser-lookup 'afterGraceFraction))))
71 (make-simultaneous-music
74 (make-sequential-music
76 (make-music 'SkipMusic
77 'duration (ly:make-duration
79 (* (ly:moment-main main-length)
80 (/ (car fraction) (cdr fraction)))))
81 (make-music 'GraceMusic
86 %% music identifiers not allowed at top-level,
87 %% so this is a music-function instead.
89 #(define-music-function () ()
90 (_i "Allow a page turn. May be used at toplevel (ie between scores or
91 markups), or inside a score.")
92 (make-music 'EventChord
94 'page-turn-permission 'allow
95 'elements (list (make-music 'PageTurnEvent
96 'break-permission 'allow))))
99 #(define-music-function (property arg item)
100 (key-list-or-symbol? list? key-list-or-music?)
101 (_i "Override @var{property} for pieces of broken spanner @var{item}
102 with values @var{arg}. @var{item} may either be music in the form of
103 a starting spanner event, or a symbol list in the form
104 @samp{Context.Grob} or just @samp{Grob}. Iff @var{item} is in the
105 form of a spanner event, @var{property} may also have the form
106 @samp{Grob.property} for specifying a directed tweak.")
108 (if (or (eqv? (ly:music-property item 'span-direction) START)
109 (music-is-of-type? item 'tie-event))
110 (tweak property (value-for-spanner-piece arg) item)
112 (ly:music-warning item (_ "not a spanner"))
114 (let* ((p (check-grob-path item (*location*)
118 (name (and p (second p)))
120 (and name (assoc-get name all-grob-descriptions))))
122 (member 'spanner-interface
123 (assoc-get 'interfaces
124 (assoc-get 'meta description))))
125 (propertyOverride (append item (if (symbol? property)
128 (value-for-spanner-piece arg))
130 (ly:input-warning (*location*) (_ "not a spanner name, `~a'") name)
131 (make-music 'Music))))))
134 #(define-music-function (tag more music)
135 (symbol? ly:music? ly:music?)
136 (_i "Append @var{more} to the @code{elements} of all music
137 expressions in @var{music} that are tagged with @var{tag}.")
138 (music-map (lambda (m)
139 (if (memq tag (ly:music-property m 'tags))
140 (set! (ly:music-property m 'elements)
141 (append (ly:music-property m 'elements)
147 #(define-music-function (proc) (procedure?)
148 (_i "Modify context properties with Scheme procedure @var{proc}.")
149 (make-music 'ApplyContext
153 #(define-music-function (func music) (procedure? ly:music?)
154 (_i"Apply procedure @var{func} to @var{music}.")
158 #(define-music-function (target proc) (symbol-list-or-symbol? procedure?)
159 (_i "Apply function @code{proc} to every layout object matched by
160 @var{target} which takes the form @code{Context} or @code{Context.Grob}.")
161 (let ((p (check-grob-path target (*location*) #:max 2)))
163 (make-music 'ApplyOutputEvent
165 'context-type (car p)
167 (list (cons 'symbol (cadr p)))
169 (make-music 'Music))))
172 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
173 (_i "Create an appoggiatura from @var{music}"))
175 % for regression testing purposes.
177 #(define-music-function (l r) (pair? pair?)
178 (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
179 (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
181 % for regression testing purposes.
183 #(define-music-function (comp) (procedure?)
184 (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
185 (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
188 #(define-music-function (pitch clef-1 clef-2 music)
189 ((ly:pitch? (ly:make-pitch 0 0)) (ly:context-mod?)(ly:context-mod?) ly:music?)
190 (_i "Make voices that switch between staves automatically. As an option the
191 pitch where to switch staves may be specified. The clefs for the staves are
192 optional as well. Setting clefs works only for implicitly instantiated
194 (let ;; keep the contexts alive for the full duration
195 ((skip (make-duration-of-length (ly:music-length music)))
196 (clef-1 (or clef-1 #{ \with { \clef "treble" } #}))
197 (clef-2 (or clef-2 #{ \with { \clef "bass" } #})))
198 (make-simultaneous-music
200 (descend-to-context (make-autochange-music pitch music) 'Staff
202 (context-spec-music (make-skip-music skip) 'Staff
204 (context-spec-music (make-skip-music skip) 'Staff
208 #(define-music-function (grob-name offset text)
209 (symbol? number-pair? markup?)
210 (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
211 (use like @code{\\once})")
214 (make-music 'AnnotateOutputEvent
216 'X-offset (car offset)
217 'Y-offset (cdr offset)
221 #(define-event-function (offset text) (number-pair? markup?)
222 (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
223 (make-music 'AnnotateOutputEvent
224 'X-offset (car offset)
225 'Y-offset (cdr offset)
229 #(define-music-function (type) (string?)
230 (_i "Insert a bar line of type @var{type}")
232 (make-property-set 'whichBar type)
236 #(define-music-function (n) (integer?)
237 (_i "Print a warning if the current bar number is not @var{n}.")
238 (make-music 'ApplyContext
241 (let ((cbn (ly:context-property c 'currentBarNumber)))
242 (if (and (number? cbn) (not (= cbn n)))
243 (ly:input-warning (*location*)
244 "Barcheck failed got ~a expect ~a"
248 #(define-scheme-function (music) (ly:music?)
249 (_i "Extract a value suitable for setting
250 @code{Timing.beamExceptions} from the given pattern with explicit
251 beams in @var{music}. A bar check @code{|} has to be used between
252 bars of patterns in order to reset the timing.")
253 (extract-beam-exceptions music))
256 #(define-event-function (delta) (real?)
257 (_i "Create a fall or doit of pitch interval @var{delta}.")
258 (make-music 'BendAfterEvent
262 #(define-void-function (newfilename) (string?)
263 (_i "Direct output for the current book block to @var{newfilename}.")
264 (set! (paper-variable #f 'output-filename) newfilename))
267 #(define-void-function (newsuffix) (string?)
268 (_i "Set the output filename suffix for the current book block to
270 (set! (paper-variable #f 'output-suffix) newsuffix))
272 %% \breathe is defined as a music function rather than an event identifier to
273 %% ensure it gets useful input location information: as an event identifier,
274 %% it would have to be wrapped in an EventChord to prevent it from being
275 %% treated as a post_event by the parser
277 #(define-music-function () ()
278 (_i "Insert a breath mark.")
279 (make-music 'BreathingEvent))
282 #(define-music-function (type) (string?)
283 (_i "Set the current clef to @var{type}.")
284 (make-clef-set type))
288 #(define-music-function (args) (pair?)
289 (_i "Create compound time signatures. The argument is a Scheme list of
290 lists. Each list describes one fraction, with the last entry being the
291 denominator, while the first entries describe the summands in the
292 enumerator. If the time signature consists of just one fraction,
293 the list can be given directly, i.e. not as a list containing a single list.
294 For example, a time signature of (3+1)/8 + 2/4 would be created as
295 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
296 as @code{\\compoundMeter #'((3 2 8))} or shorter
297 @code{\\compoundMeter #'(3 2 8)}.")
298 (let* ((mlen (calculate-compound-measure-length args))
299 (beat (calculate-compound-base-beat args))
300 (beatGrouping (calculate-compound-beat-grouping args))
301 (timesig (cons (ly:moment-main-numerator mlen)
302 (ly:moment-main-denominator mlen))))
304 \once \override Timing.TimeSignature.stencil = #(lambda (grob)
305 (grob-interpret-markup grob (make-compound-meter-markup args)))
306 \set Timing.timeSignatureFraction = #timesig
307 \set Timing.baseMoment = #beat
308 \set Timing.beatStructure = #beatGrouping
309 \set Timing.beamExceptions = #'()
310 \set Timing.measureLength = #mlen
314 #(define-music-function (music) (ly:music?)
315 (_i "Remove the empty bars created by multi-measure rests,
316 leaving just the first bar containing the MM rest itself.")
319 (if (eq? 'MultiMeasureRestMusic (ly:music-property m 'name))
320 #{ \once \set Score.skipBars = ##t #m #}
325 #(define-music-function (notes) (ly:music?)
326 (_i "Create cross-staff stems")
328 \temporary \override Stem.cross-staff = #cross-staff-connect
329 \temporary \override Flag.style = #'no-flag
331 \revert Stem.cross-staff
336 #(define-music-function (type) (string?)
337 (_i "Set the current cue clef to @var{type}.")
338 (make-cue-clef-set type))
341 #(define-music-function () ()
342 (_i "Unset the current cue clef.")
343 (make-cue-clef-unset))
346 #(define-music-function
347 (what dir main-music) (string? ly:dir? ly:music?)
348 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
349 in a CueVoice oriented by @var{dir}.")
350 (make-music 'QuoteMusic
352 'quoted-context-type 'CueVoice
353 'quoted-context-id "cue"
354 'quoted-music-name what
355 'quoted-voice-direction dir))
358 #(define-music-function
359 (what dir clef main-music) (string? ly:dir? string? ly:music?)
360 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
361 in a CueVoice oriented by @var{dir}.")
362 (make-music 'QuoteMusic
364 'quoted-context-type 'CueVoice
365 'quoted-context-id "cue"
366 'quoted-music-name what
367 'quoted-music-clef clef
368 'quoted-voice-direction dir))
373 #(define-music-function (port music) ((output-port?) ly:music?)
374 (_i "Display the LilyPond input representation of @var{music}
375 to @var{port}, defaulting to the console.")
376 (let ((port (or port (current-output-port))))
378 (display-lily-music music port))
382 #(define-music-function (port music) ((output-port?) ly:music?)
383 (_i "Display the internal representation of @var{music} to
384 @var{port}, default to the console.")
385 (let ((port (or port (current-output-port))))
387 (display-scheme-music music port))
391 #(define-scheme-function (port expr) ((output-port?) scheme?)
392 (_i "Display the internal representation of @var{expr} to
393 @var{port}, default to the console.")
394 (let ((port (or port (current-output-port))))
396 (display-scheme-music expr port))
402 #(define-music-function (music) (ly:music?)
403 (_i "Terminate the next spanner prematurely after exactly one note
404 without the need of a specific end spanner.")
405 (let* ((start-span-evs (filter (lambda (ev)
406 (equal? (ly:music-property ev 'span-direction)
408 (extract-typed-music music 'span-event)))
411 (music-clone m 'span-direction STOP))
413 (end-ev-chord (make-music 'EventChord
414 'elements stop-span-evs))
415 (total (make-music 'SequentialMusic
416 'elements (list music
421 #(define-music-function (music) (ly:music?)
422 (_i "Compatibility function wrapping @code{EventChord} around
423 isolated rhythmic events occuring since version 2.15.28, after
424 expanding repeat chords @samp{q}.")
425 (event-chord-wrap! music))
428 #(define-music-function (factor argument) (ly:moment? ly:music?)
429 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
430 (let ((orig-duration (ly:music-length argument))
431 (multiplier (ly:make-moment 1 1)))
435 (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
437 (ly:music-compress mus multiplier)
438 (set! multiplier (ly:moment-mul factor multiplier)))))
439 (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
442 (ly:moment-div orig-duration (ly:music-length argument)))
447 #(define-event-function (finger) (number-or-markup?)
448 (_i "Apply @var{finger} as a fingering indication.")
452 (if (number? finger) 'digit 'text)
456 #(define-music-function (pitch music)
457 (ly:pitch? ly:music?)
458 (_i "Use the octave of @var{pitch} as the default octave for @var{music}.")
459 (let ((octave-marks (1+ (ly:pitch-octave pitch))))
460 (cond ((not (= 0 octave-marks))
461 (ly:music-transpose music (ly:make-pitch octave-marks 0 0))
462 ;;In order to leave unchanged the notes in any enclosed
463 ;; \absolute or \fixed or \relative, make a cancelling shift
465 (ly:music-transpose m (ly:make-pitch (- octave-marks) 0 0)))
466 (extract-named-music music 'RelativeOctaveMusic)))))
467 (make-music 'RelativeOctaveMusic 'element music))
470 #(define-music-function (mark offset footnote item)
471 ((markup?) number-pair? markup? symbol-list-or-music?)
472 (_i "Make the markup @var{footnote} a footnote on @var{item}. The
473 footnote is marked with a markup @var{mark} moved by @var{offset} with
474 respect to the marked music.
476 If @var{mark} is not given or specified as @var{\\default}, it is
477 replaced by an automatically generated sequence number. If @var{item}
478 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
479 grobs of that type will be marked at the current time step in the
480 given context (default @code{Bottom}).
482 If @var{item} is music, the music will get a footnote attached to a
483 grob immediately attached to the event, like @var{\\tweak} does. For
484 attaching a footnote to an @emph{indirectly} caused grob, write
485 @code{\\single\\footnote}, use @var{item} to specify the grob, and
486 follow it with the music to annotate.
488 Like with @code{\\tweak}, if you use a footnote on a following
489 post-event, the @code{\\footnote} command itself needs to be attached
490 to the preceding note or rest as a post-event with @code{-}.")
491 (let ((mus (make-music
493 'X-offset (car offset)
494 'Y-offset (cdr offset)
495 'automatically-numbered (not mark)
496 'text (or mark (make-null-markup))
497 'footnote-text footnote)))
498 (once (propertyTweak 'footnote-music mus item))))
501 #(def-grace-function startGraceMusic stopGraceMusic
502 (_i "Insert @var{music} as grace notes."))
505 #(define-scheme-function (descriptions) (list?)
506 (_i "Create a context modification from @var{descriptions}, a list
507 in the format of @code{all-grob-descriptions}.")
510 (list 'assign (car p) (ly:make-grob-properties (cdr p))))
513 harmonicByFret = #(define-music-function (fret music) (number? ly:music?)
514 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
515 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
517 \set harmonicDots = ##t
518 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
519 \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
520 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
521 (ly:note-head::print grob))
523 (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
525 \revert TabNoteHead.stencil
526 \revert NoteHead.Y-extent
527 \revert NoteHead.stencil
530 harmonicByRatio = #(define-music-function (ratio music) (number? ly:music?)
531 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
532 harmonics played on a fretted instrument by touching the strings at the point
533 given through @var{ratio}.")
535 \set harmonicDots = ##t
536 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
537 \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height)
538 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
539 (ly:note-head::print grob))
541 (calc-harmonic-pitch (ratio->pitch ratio) music))
543 \revert TabNoteHead.stencil
544 \revert NoteHead.Y-extent
545 \revert NoteHead.stencil
549 #(define-music-function (item) (symbol-list-or-music?)
550 (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
551 making it invisible while still retaining its dimensions.
553 If @var{item} is a symbol list of form @code{GrobName} or
554 @code{Context.GrobName}, the result is an override for the grob name
555 specified by it. If @var{item} is a music expression, the result is
556 the same music expression with an appropriate tweak applied to it.")
557 (propertyTweak 'transparent #t item))
560 #(define-music-function () ()
561 (_i "Put the segno variant 'varsegno' at this position into the staff,
562 compatible with the repeat command.")
563 (make-music 'ApplyContext
566 (let ((score-ctx (ly:context-find ctx 'Score)))
567 (if (ly:context? score-ctx)
568 (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
569 (if (eq? (memq 'segno-display old-rc) #f)
570 (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
573 #(define-music-function
575 (_i "Switch instrument to @var{name}, which must be predefined with
576 @code{\\addInstrumentDefinition}.")
577 (let* ((handle (assoc name instrument-definitions))
578 (instrument-def (if handle (cdr handle) '())))
581 (ly:input-warning (*location*) "No such instrument: ~a" name))
583 (make-music 'SimultaneousMusic
595 #(define-music-function (tags music)
596 (symbol-list-or-symbol? ly:music?)
597 (_i "Include only elements of @var{music} that are tagged with one
598 of the tags in @var{tags}. @var{tags} may be either a single symbol
599 or a list of symbols.
601 Each tag may be declared as a member of at most one tag group (defined
602 with @code{\\tagGroup}). If none of a @var{music} element's tags
603 share a tag group with one of the specified @var{tags}, the element is
606 (tags-keep-predicate tags)
610 #(define-music-function (tonic pitch-alist)
611 ((ly:pitch? '()) (list? '()))
612 (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
613 If both are null, just generate @code{KeyChangeEvent}.")
614 (cond ((null? tonic) (make-music 'KeyChangeEvent))
616 (ly:parser-error (_ "second argument must be pitch list")
618 (make-music 'SequentialMusic 'void #t))
621 (make-music 'KeyChangeEvent
622 'tonic (ly:make-pitch 0 0 0)
623 'pitch-alist pitch-alist)
627 #(define-music-function (music) (ly:music?)
628 (_i "Remove cue notes from @var{music}.")
631 (if (and (string? (ly:music-property mus 'quoted-music-name))
632 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
633 (ly:music-property mus 'element)
640 #(define-music-function (label) (symbol?)
641 (_i "Create @var{label} as a bookmarking label.")
642 (make-music 'EventChord
645 'elements (list (make-music 'LabelEvent
646 'page-label label))))
650 #(define-void-function (language) (string?)
651 (_i "Set note names for language @var{language}.")
652 (note-names-language language))
654 languageSaveAndChange =
655 #(define-void-function (language) (string?)
656 (_i "Store the previous pitchnames alist, and set a new one.")
657 (set! previous-pitchnames pitchnames)
658 (note-names-language language))
661 #(define-void-function () ()
662 (_i "Restore a previously-saved pitchnames alist.")
663 (if previous-pitchnames
665 (set! pitchnames previous-pitchnames)
666 (ly:parser-set-note-names pitchnames))
667 (ly:input-warning (*location*) (_ "No other language was defined previously. Ignoring."))))
671 #(define-music-function (mag music) (positive? ly:music?)
672 (_i "Magnify the notation of @var{music} without changing the
673 staff-size, using @var{mag} as a size factor. Stems, beams,
674 slurs, ties, and horizontal spacing are adjusted automatically.")
676 ;; these props are NOT allowed to shrink below default size
677 (define unshrinkable-props
683 (Slur line-thickness)
685 (PhrasingSlur line-thickness)
686 (PhrasingSlur thickness)
691 (LaissezVibrerTie line-thickness)
692 (LaissezVibrerTie thickness)
693 (RepeatTie line-thickness)
694 (RepeatTie thickness)
697 ;; these props ARE allowed to shrink below default size
698 (define shrinkable-props
699 (let ((baseline-skip-props
700 (find-named-props 'baseline-skip all-grob-descriptions))
702 (find-named-props 'word-space all-grob-descriptions)))
707 ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed
708 ;; override at the 'Score level
709 ;(SpacingSpanner spacing-increment)
711 ;; lengths and heights
712 (Beam length-fraction)
713 (Stem length-fraction)
714 (Stem beamlet-default-length)
715 (Stem double-stem-separation)
717 (Slur minimum-length)
718 (PhrasingSlur height-limit)
719 (PhrasingSlur minimum-length)
721 ;; Beam.beam-thickness is dealt with separately below
725 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
727 #(scale-fontSize 'magnifyMusic mag)
728 #(scale-props 'magnifyMusic mag #f unshrinkable-props)
729 #(scale-props 'magnifyMusic mag #t shrinkable-props)
730 #(scale-beam-thickness mag)
734 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
736 %% reverse engineer the former fontSize value instead of using \unset
737 #(revert-fontSize 'magnifyMusic mag)
738 #(revert-props 'magnifyMusic mag (append unshrinkable-props
740 '((Beam beam-thickness))))
745 #(define-music-function (mag) (positive?)
746 (_i "Change the size of the staff, adjusting notation size and
747 horizontal spacing automatically, using @var{mag} as a size factor.")
749 ;; these props are NOT allowed to shrink below default size
750 (define unshrinkable-props
751 '((StaffSymbol thickness)))
753 ;; these props ARE allowed to shrink below default size
754 (define shrinkable-props
755 (let* ((baseline-skip-props
756 (find-named-props 'baseline-skip all-grob-descriptions))
758 (find-named-props 'word-space all-grob-descriptions))
760 (find-named-props 'space-alist all-grob-descriptions)))
766 ;; override at the 'Score level
767 (SpacingSpanner spacing-increment)
769 (StaffSymbol staff-space)
772 (BarLine hair-thickness)
773 (BarLine thick-thickness)
774 (Stem beamlet-default-length)
775 (Stem double-stem-separation)
781 %% revert settings from last time
782 %% (but only if \magnifyStaff has already been used
783 %% and the staff magnification is changing)
784 #(revert-fontSize 'magnifyStaff mag)
785 #(revert-props 'magnifyStaff mag (append unshrinkable-props
789 %% (but only if staff magnification is changing
790 %% and does not equal 1)
791 #(scale-fontSize 'magnifyStaff mag)
792 #(scale-props 'magnifyStaff mag #f unshrinkable-props)
793 #(scale-props 'magnifyStaff mag #t shrinkable-props)
795 %% this might cause problems until Issue 3990 is fixed
799 \set Staff.magnifyStaffValue = #mag
803 #(define-music-function (arg) (ly:music?)
804 (_i "Display chords in @var{arg} as clusters.")
805 (music-map note-to-cluster arg))
808 #(define-music-function (around to scale music)
809 (ly:pitch? ly:pitch? ly:music? ly:music?)
810 (_i "Invert @var{music} about @var{around} using @var{scale} and
811 transpose from @var{around} to @var{to}.")
812 (let ((inverter (make-modal-inverter around to scale)))
813 (change-pitches music inverter)
817 #(define-music-function (from to scale music)
818 (ly:pitch? ly:pitch? ly:music? ly:music?)
819 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
821 (let ((transposer (make-modal-transposer from to scale)))
822 (change-pitches music transposer)
826 #(define-music-function
827 (around to music) (ly:pitch? ly:pitch? ly:music?)
828 (_i "Invert @var{music} about @var{around} and
829 transpose from @var{around} to @var{to}.")
830 (music-invert around to music))
833 #(define-music-function
834 (label) ((number-or-markup?))
835 "Make the music for the \\mark command."
836 (let* ((set (and (integer? label)
837 (context-spec-music (make-property-set 'rehearsalMark label)
839 (ev (make-music 'MarkEvent
840 'origin (*location*))))
843 (make-sequential-music (list set ev))
845 (if label (set! (ly:music-property ev 'label) label))
849 #(define-music-function (path markupfun music)
850 (symbol-list-or-symbol? markup-function? ly:music?)
851 (_i "This applies the given markup function @var{markupfun} to all markup
852 music properties matching @var{path} in @var{music}.
856 \\new Voice @{ g'2 c'' @}
858 \\markupMap LyricEvent.text
859 \\markup \\with-color #red \\etc
864 (let* ((p (check-music-path path (*location*)))
865 (name (and p (car p)))
866 (prop (and p (cadr p))))
870 (if (or (not name) (eq? (ly:music-property m 'name) name))
871 (let ((text (ly:music-property m prop)))
873 (set! (ly:music-property m prop)
874 (list markupfun text)))))
880 #(define-music-function (proc mus) (procedure? ly:music?)
881 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
882 (music-map proc mus))
884 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
885 %% because music identifiers are not allowed at top-level.
887 #(define-music-function () ()
888 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
889 markups), or inside a score.")
890 (make-music 'EventChord
892 'page-break-permission 'forbid
893 'elements (list (make-music 'PageBreakEvent
894 'break-permission '()))))
897 #(define-music-function () ()
898 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
899 markups), or inside a score.")
900 (make-music 'EventChord
902 'page-turn-permission 'forbid
903 'elements (list (make-music 'PageTurnEvent
904 'break-permission '()))))
909 #(define-music-function (pitch) (ly:pitch?)
911 (make-music 'RelativeOctaveCheck
915 #(define-music-function (property offsets item)
916 (symbol-list-or-symbol? scheme? key-list-or-music?)
917 (_i "Offset the default value of @var{property} of @var{item} by
918 @var{offsets}. If @var{item} is a string, the result is
919 @code{\\override} for the specified grob type. If @var{item} is
920 a music expression, the result is the same music expression with an
921 appropriate tweak applied.")
923 ; In case of a tweak, grob property path is Grob.property
924 (let ((prop-path (check-grob-path
925 (if (symbol? property)
927 property) (*location*)
928 #:start 1 #:default #t #:min 2 #:max 2)))
930 ; If the head of the grob property path is a symbol--i.e.,
931 ; a grob name, produce a directed tweak. Otherwise, create
933 (if (symbol? (car prop-path))
934 (tweak prop-path (offsetter (second prop-path) offsets) item)
935 (tweak (second prop-path)
936 (offsetter (second prop-path) offsets)
939 ; In case of an override, grob property path is Context.Grob.property.
940 (let ((prop-path (check-grob-path
942 (if (symbol? property)
944 property)) (*location*)
945 #:default 'Bottom #:min 3 #:max 3)))
947 (propertyOverride prop-path (offsetter (third prop-path) offsets))
948 (make-music 'Music)))))
951 #(define-music-function (item) (symbol-list-or-music?)
952 (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
953 effectively omitting it without taking up space.
955 If @var{item} is a symbol list of form @code{GrobName} or
956 @code{Context.GrobName}, the result is an override for the grob name
957 specified by it. If @var{item} is a music expression, the result is
958 the same music expression with an appropriate tweak applied to it.")
959 (propertyTweak 'stencil #f item))
962 #(define-music-function (music) (ly:music?)
963 (_i "Set @code{once} to @code{#t} on all layout instruction events
964 in @var{music}. This will complain about music with an actual
965 duration. As a special exception, if @var{music} contains
966 @samp{tweaks} it will be silently ignored in order to allow for
967 @code{\\once \\propertyTweak} to work as both one-time override and proper
969 (if (not (pair? (ly:music-property music 'tweaks)))
972 (cond ((music-is-of-type? m 'layout-instruction-event)
973 (set! (ly:music-property m 'once) #t)
975 ((ly:duration? (ly:music-property m 'duration))
976 (ly:music-warning m (_ "Cannot apply \\once to timed music"))
983 #(define-music-function (octave) (integer?)
984 (_i "Set the octavation.")
985 (make-music 'OttavaMusic
986 'ottava-number octave))
988 overrideTimeSignatureSettings =
989 #(define-music-function
990 (time-signature base-moment beat-structure beam-exceptions)
991 (fraction? fraction? list? list?)
993 (_i "Override @code{timeSignatureSettings}
994 for time signatures of @var{time-signature} to have settings
995 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
997 ;; TODO -- add warning if largest value of grouping is
998 ;; greater than time-signature.
999 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
1000 (override-time-signature-setting time-signature setting)))
1003 #(define-music-function (grob-property-path value)
1006 (_i "Set the grob property specified by @var{grob-property-path} to
1007 @var{value}. @var{grob-property-path} is a symbol list of the form
1008 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1009 with subproperties given as well.
1011 As opposed to @code{\\override} which overrides the context-dependent
1012 defaults with which a grob is created, this command uses
1013 @code{Output_property_engraver} at the grob acknowledge stage. This
1014 may be necessary for overriding values set after the initial grob
1016 (let ((p (check-grob-path grob-property-path (*location*)
1020 (make-music 'ApplyOutputEvent
1021 'context-type (first p)
1024 (lambda (grob orig-context context)
1025 (ly:grob-set-nested-property! 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 } #} ))
1299 %% Part combine forcing to be found in ly/property-init.ly
1302 #(define-music-function (dur) (ly:duration?)
1303 (_i "Make a partial measure.")
1305 ;; We use `descend-to-context' here instead of `context-spec-music' to
1306 ;; ensure \partial still works if the Timing_translator is moved
1308 (context-spec-music (make-music 'PartialSet
1309 'origin (*location*)
1315 #(define-music-function
1316 (main-note secondary-note)
1317 (ly:music? ly:music?)
1318 (_i "Print a trill with @var{main-note} as the main note of the trill and
1319 print @var{secondary-note} as a stemless note head in parentheses.")
1320 (let* ((get-notes (lambda (ev-chord)
1321 (extract-named-music ev-chord 'NoteEvent)))
1322 (sec-note-events (get-notes secondary-note))
1323 (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1324 (if (pair? sec-note-events)
1326 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1327 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1329 (if (ly:pitch? trill-pitch)
1330 (for-each (lambda (m)
1331 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1333 (ly:input-warning (*location*) (_ "Second argument of \\pitchedTrill should be single note: "))
1334 (display sec-note-events)))
1337 (for-each (lambda (m)
1338 (ly:music-set-property! m 'force-accidental forced))
1343 #(define-music-function (grob-property-path value)
1345 (_i "Set the grob property specified by @var{grob-property-path} to
1346 @var{value}. @var{grob-property-path} is a symbol list of the form
1347 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1348 with subproperties given as well. This music function is mostly intended
1349 for use from Scheme as a substitute for the built-in @code{\\override}
1351 (let ((p (check-grob-path grob-property-path (*location*)
1356 (make-music 'OverrideProperty
1358 'origin (*location*)
1360 'grob-property-path (cddr p)
1363 (make-music 'Music))))
1366 #(define-music-function (grob-property-path)
1368 (_i "Revert the grob property specified by @var{grob-property-path} to
1369 its previous value. @var{grob-property-path} is a symbol list of the form
1370 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1371 with subproperties given as well. This music function is mostly intended
1372 for use from Scheme as a substitute for the built-in @code{\\revert}
1374 (let ((p (check-grob-path grob-property-path (*location*)
1379 (make-music 'RevertProperty
1381 'origin (*location*)
1382 'grob-property-path (cddr p))
1384 (make-music 'Music))))
1387 #(define-music-function (property-path value)
1388 (symbol-list-or-symbol? scheme?)
1389 (_i "Set the context property specified by @var{property-path} to
1390 @var{value}. This music function is mostly intended for use from
1391 Scheme as a substitute for the built-in @code{\\set} command.")
1392 (let ((p (check-context-path property-path (*location*))))
1395 (make-music 'PropertySet
1398 'origin (*location*))
1400 (make-music 'Music))))
1403 #(define-music-function (prop value item)
1404 (key-list-or-symbol? scheme? key-list-or-music?)
1405 (_i "Add a tweak to the following @var{item}, usually music.
1406 This generally behaves like @code{\\tweak} but will turn into an
1407 @code{\\override} when @var{item} is a symbol list.
1409 In that case, @var{item} specifies the grob path to override. This is
1410 mainly useful when using @code{\\propertyTweak} as as a component for
1411 building other functions like @code{\\omit}. It is not the default
1412 behavior for @code{\\tweak} since many input strings in
1413 @code{\\lyricmode} can serve equally as music or as symbols which
1414 causes surprising behavior when tweaking lyrics using the less
1415 specific semantics of @code{\\propertyTweak}.
1417 @var{prop} can contain additional elements in which case a nested
1418 property (inside of an alist) is tweaked.")
1419 ;; Why not instead make the parser treat strings preferably as
1420 ;; music in lyrics mode rather than as symbol? Because then
1422 ;; \tweak text "whatever" mylyrics
1424 ;; will try putting a lyric event with text "whatever" in the text
1425 ;; property of lyrics. So we want expressions allowing both
1426 ;; strings and lyrics to deliver strings: more complex conversions
1427 ;; should only be attempted when the simple uses don't match the
1429 (if (ly:music? item)
1430 (if (music-is-of-type? item 'context-specification)
1431 ;; This is essentially dealing with the case
1432 ;; \propertyTweak color #red \propertyTweak font-size #3 NoteHead
1433 ;; namely when stacked tweaks end in a symbol list
1434 ;; rather than a music expression.
1436 ;; We have a tweak here to convert into an override,
1437 ;; so we need to know the grob to apply it to. That's
1438 ;; easy if we have a directed tweak, and otherwise we
1439 ;; need to find the symbol in the expression itself.
1440 (let* ((p (check-grob-path prop (*location*)
1444 (elt (ly:music-property item 'element))
1445 (seq (if (music-is-of-type? elt 'sequential-music)
1447 (make-sequential-music (list elt))))
1448 (elts (ly:music-property seq 'elements))
1449 (symbol (if (symbol? (car p))
1452 (ly:music-property (car elts)
1454 (if (symbol? symbol)
1456 (set! (ly:music-property seq 'elements)
1457 (cons (make-music 'OverrideProperty
1459 'grob-property-path (cdr p)
1462 'origin (*location*))
1464 (set! (ly:music-property item 'element) seq))
1466 (ly:parser-error (_ "Cannot \\propertyTweak")
1468 (ly:music-message item (_ "untweakable"))))
1470 (tweak prop value item))
1471 (propertyOverride (append item (if (symbol? prop) (list prop) prop))
1475 #(define-music-function (property-path)
1476 (symbol-list-or-symbol?)
1477 (_i "Unset the context property specified by @var{property-path}.
1478 This music function is mostly intended for use from Scheme as a
1479 substitute for the built-in @code{\\unset} command.")
1480 (let ((p (check-context-path property-path (*location*))))
1483 (make-music 'PropertyUnset
1485 'origin (*location*))
1487 (make-music 'Music))))
1490 #(define-music-function (tag more music)
1491 (symbol? ly:music? ly:music?)
1492 (_i "Add @var{more} to the front of @code{elements} of all music
1493 expressions in @var{music} that are tagged with @var{tag}.")
1494 (music-map (lambda (m)
1495 (if (memq tag (ly:music-property m 'tags))
1496 (set! (ly:music-property m 'elements)
1497 (cons more (ly:music-property m 'elements))))
1502 #(define-music-function (what main-music) (string? ly:music?)
1503 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
1504 of the quoted voice, as specified in an @code{\\addQuote} command.
1505 @var{main-music} is used to indicate the length of music to be quoted;
1506 usually contains spacers or multi-measure rests.")
1507 (make-music 'QuoteMusic
1509 'quoted-music-name what))
1512 #(define-music-function (music) (ly:music?)
1513 (_i "Reduce chords contained in @var{music} to single notes,
1514 intended mainly for reusing music in RhythmicStaff. Does not
1515 reduce parallel music.")
1516 (event-chord-reduce music))
1519 #(define-music-function (pitch music)
1520 ((ly:pitch?) ly:music?)
1521 (_i "Make @var{music} relative to @var{pitch}. If @var{pitch} is
1522 omitted, the first note in @var{music} is given in absolute pitch.")
1523 ;; When \relative has no clear decision (can only happen with
1524 ;; scales with an even number of steps), it goes down (see
1525 ;; pitch.cc). The following formula puts out f for both the normal
1526 ;; 7-step scale as well as for a "shortened" scale missing the
1527 ;; final b. In either case, a first note of c will end up as c,
1528 ;; namely pitch (-1, 0, 0).
1529 (ly:make-music-relative! music
1534 ;; size of current scale:
1535 (ly:pitch-steps (ly:make-pitch 1 0))
1537 (make-music 'RelativeOctaveMusic
1541 #(define-music-function (tags music)
1542 (symbol-list-or-symbol? ly:music?)
1543 (_i "Remove elements of @var{music} that are tagged with one of the
1544 tags in @var{tags}. @var{tags} may be either a single symbol or a list
1547 (tags-remove-predicate tags)
1550 resetRelativeOctave =
1551 #(define-music-function (pitch) (ly:pitch?)
1552 (_i "Set the octave inside a \\relative section.")
1554 (make-music 'SequentialMusic
1555 'to-relative-callback
1556 (lambda (music last-pitch) pitch)))
1559 #(define-music-function (music)
1561 (_i "Return @var{music} in reverse order.")
1563 (expand-repeat-notes!
1564 (expand-repeat-chords!
1565 (cons 'rhythmic-event
1566 (ly:parser-lookup '$chord-repeat-events))
1569 revertTimeSignatureSettings =
1570 #(define-music-function
1574 (_i "Revert @code{timeSignatureSettings}
1575 for time signatures of @var{time-signature}.")
1576 (revert-time-signature-setting time-signature))
1579 #(define-event-function (finger) (number-or-markup?)
1580 (_i "Apply @var{finger} as a fingering indication.")
1584 (if (number? finger) 'digit 'text)
1588 #(define-music-function (fraction music)
1589 (fraction? ly:music?)
1590 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1591 (ly:music-compress music
1592 (ly:make-moment (car fraction) (cdr fraction))))
1595 #(define-scheme-function (ctx music)
1596 ((symbol?) ly:music?)
1597 (_i "Take the layout instruction events from @var{music}, optionally
1598 restricted to those applying to context type @var{ctx}, and return
1599 a context modification duplicating their effect.")
1600 (let ((mods (ly:make-context-mod)))
1602 (if (music-is-of-type? m 'layout-instruction-event)
1605 (case (ly:music-property m 'name)
1608 (ly:music-property m 'symbol)
1609 (ly:music-property m 'value)))
1612 (ly:music-property m 'symbol)))
1615 (ly:music-property m 'symbol)
1616 (ly:music-property m 'grob-value)
1618 ((ly:music-property m 'grob-property #f) => list)
1620 (ly:music-property m 'grob-property-path)))))
1623 (ly:music-property m 'symbol)
1625 ((ly:music-property m 'grob-property #f) => list)
1627 (ly:music-property m 'grob-property-path)))))))
1628 (case (ly:music-property m 'name)
1630 (ly:add-context-mod mods
1632 (ly:music-property m 'procedure))))
1633 ((ContextSpeccedMusic)
1635 (eq? ctx (ly:music-property m 'context-type)))
1636 (musicop (ly:music-property m 'element))))
1638 (let ((callback (ly:music-property m 'elements-callback)))
1639 (if (procedure? callback)
1640 (for-each musicop (callback m))))))))
1645 #(define-music-function (offsets item)
1646 (list? key-list-or-music?)
1647 (_i "Offset control-points of @var{item} by @var{offsets}. The
1648 argument is a list of number pairs or list of such lists. Each
1649 element of a pair represents an offset to one of the coordinates of a
1650 control-point. If @var{item} is a string, the result is
1651 @code{\\once\\override} for the specified grob type. If @var{item} is
1652 a music expression, the result is the same music expression with an
1653 appropriate tweak applied.")
1654 (define (shape-curve grob coords)
1655 (let* ((orig (ly:grob-original grob))
1656 (siblings (if (ly:spanner? grob)
1657 (ly:spanner-broken-into orig) '()))
1658 (total-found (length siblings)))
1659 (define (offset-control-points offsets)
1662 (map coord-translate coords offsets)))
1664 (define (helper sibs offs)
1666 (if (eq? (car sibs) grob)
1667 (offset-control-points (car offs))
1668 (helper (cdr sibs) (cdr offs)))
1671 ;; we work with lists of lists
1672 (if (or (null? offsets)
1673 (not (list? (car offsets))))
1674 (set! offsets (list offsets)))
1676 (if (>= total-found 2)
1677 (helper siblings offsets)
1678 (offset-control-points (car offsets)))))
1679 (once (propertyTweak 'control-points
1680 (grob-transformer 'control-points shape-curve)
1684 #(define-music-function (dur dots arg)
1685 (integer? integer? ly:music?)
1686 (_i "Change the duration of @var{arg} by adding @var{dur} to the
1687 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1689 (shift-duration-log arg dur dots))
1692 #(define-music-function (overrides music)
1693 (ly:music? ly:music?)
1694 (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1695 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1696 (set! (ly:music-property music 'tweaks)
1698 (lambda (m) (eq? (ly:music-property m 'name)
1702 ((ly:music-property m 'grob-property #f) => list)
1704 (ly:music-property m 'grob-property-path)))))
1705 (acons (cons (ly:music-property m 'symbol) ;grob name
1707 p ;grob property path
1708 (car p))) ;grob property
1709 (ly:music-property m 'grob-value)
1711 (ly:music-property music 'tweaks)
1716 #(define-music-function (dur) (ly:duration?)
1717 (_i "Skip forward by @var{dur}.")
1718 (make-music 'SkipMusic
1723 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1724 (_i "Create slashed graces (slashes through stems, but no slur) from
1725 the following music expression"))
1728 #(define-music-function (parameters) (list?)
1729 (_i "Set the system stretch, by reading the 'system-stretch property of
1730 the `parameters' assoc list.")
1732 '(Score NonMusicalPaperColumn line-break-system-details)
1733 (list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1734 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))))
1737 #(define-music-function (style heads music)
1738 (symbol? symbol-list-or-symbol? ly:music?)
1739 (_i "Set @var{heads} in @var{music} to @var{style}.")
1740 (style-note-heads heads style music))
1743 #(define-music-function (tags music) (symbol-list-or-symbol? ly:music?)
1744 (_i "Tag the following @var{music} with @var{tags} and return the
1745 result, by adding the single symbol or symbol list @var{tags} to the
1746 @code{tags} property of @var{music}.")
1749 (ly:music-property music 'tags)
1750 ((if (symbol? tags) cons append)
1752 (ly:music-property music 'tags)))
1756 #(define-void-function (tags) (symbol-list?)
1757 (_i "Define a tag group comprising the symbols in the symbol list
1758 @var{tags}. Tag groups must not overlap.")
1759 (let ((err (define-tag-group tags)))
1760 (if err (ly:parser-error err (*location*)))))
1763 #(define-music-function (music)
1765 (_i "Make any @code{\\override} in @var{music} replace an existing
1766 grob property value only temporarily, restoring the old value when a
1767 corresponding @code{\\revert} is executed. This is achieved by
1768 clearing the @samp{pop-first} property normally set on
1771 An @code{\\override}/@/@code{\\revert} sequence created by using
1772 @code{\\temporary} and @code{\\undo} on the same music containing
1773 overrides will cancel out perfectly or cause a@tie{}warning.
1775 Non-property-related music is ignored, warnings are generated for any
1776 property-changing music that isn't an @code{\\override}.")
1780 (and (or (music-is-of-type? m 'layout-instruction-event)
1781 (music-is-of-type? m 'context-specification)
1782 (music-is-of-type? m 'apply-context)
1783 (music-is-of-type? m 'time-signature-music))
1784 (case (ly:music-property m 'name)
1786 (if (ly:music-property m 'pop-first #f)
1787 (set! (ly:music-property m 'pop-first) '()))
1788 (if (ly:music-property m 'once #f)
1789 (set! (ly:music-property m 'once) '()))
1791 ((ContextSpeccedMusic)
1796 (ly:input-warning (*location*) (_ "Cannot make ~a revertible")
1797 (ly:music-property m 'name))
1804 #(define-music-function (beat-structure fraction)
1805 ((number-list? '()) fraction?)
1806 (_i "Set @var{fraction} as time signature, with optional
1807 number list @var{beat-structure} before it.")
1808 (make-music 'TimeSignatureMusic
1809 'numerator (car fraction)
1810 'denominator (cdr fraction)
1811 'beat-structure beat-structure))
1814 #(define-music-function (fraction music)
1815 (fraction? ly:music?)
1816 (_i "Scale @var{music} in time by @var{fraction}.")
1817 (make-music 'TimeScaledMusic
1818 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1819 'numerator (car fraction)
1820 'denominator (cdr fraction)))
1823 #(define-music-function
1825 (ly:pitch? ly:pitch? ly:music?)
1827 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1828 (make-music 'TransposedMusic
1829 'element (ly:music-transpose music (ly:pitch-diff to from))))
1831 transposedCueDuring =
1832 #(define-music-function
1833 (what dir pitch main-music)
1834 (string? ly:dir? ly:pitch? ly:music?)
1836 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1837 using the transposition defined by @var{pitch}. This happens
1838 simultaneously with @var{main-music}, which is usually a rest. The
1839 argument @var{dir} determines whether the cue notes should be notated
1840 as a first or second voice.")
1842 (make-music 'QuoteMusic
1844 'quoted-context-type 'CueVoice
1845 'quoted-context-id "cue"
1846 'quoted-music-name what
1847 'quoted-voice-direction dir
1848 ;; following is inverse of instrumentTransposition for
1849 ;; historical reasons
1850 'quoted-transposition pitch))
1853 #(define-music-function (pitch) (ly:pitch?)
1854 (_i "Set instrument transposition")
1857 (make-property-set 'instrumentTransposition pitch)
1861 #(define-music-function (ratio tuplet-span music)
1862 (fraction? (ly:duration? '()) ly:music?)
1863 (_i "Scale the given @var{music} to tuplets. @var{ratio} is a
1864 fraction that specifies how many notes are played in place of the
1865 nominal value: it will be @samp{3/2} for triplets, namely three notes
1866 being played in place of two. If the optional duration
1867 @var{tuplet-span} is specified, it is used instead of
1868 @code{tupletSpannerDuration} for grouping the tuplets.
1871 \\tuplet 3/2 4 @{ c8 c c c c c @}
1873 will result in two groups of three tuplets, each group lasting for a
1875 (make-music 'TimeScaledMusic
1876 'element (ly:music-compress
1878 (ly:make-moment (cdr ratio) (car ratio)))
1879 'numerator (cdr ratio)
1880 'denominator (car ratio)
1881 'duration tuplet-span))
1884 #(define-music-function (tuplet-span)
1886 (_i "Set @code{tupletSpannerDuration}, the length into which
1887 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1888 own will group its tuplets, to the duration @var{tuplet-span}. To
1889 revert to the default of not subdividing the contents of a @code{\\tuplet}
1890 command without explicit @samp{tuplet-span}, use
1892 \\tupletSpan \\default
1896 #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1897 #{ \unset tupletSpannerDuration #}))
1900 #(define-music-function (prop value music)
1901 (key-list-or-symbol? scheme? ly:music?)
1902 (_i "Add a tweak to the following @var{music}.
1903 Layout objects created by @var{music} get their property @var{prop}
1904 set to @var{value}. If @var{prop} has the form @samp{Grob.property}, like with
1906 \\tweak Accidental.color #red cis'
1908 an indirectly created grob (@samp{Accidental} is caused by
1909 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1912 @var{prop} can contain additional elements in which case a nested
1913 property (inside of an alist) is tweaked.")
1914 (let ((p (check-grob-path prop (*location*)
1919 ;; p now contains at least two elements. The first
1920 ;; element is #t when no grob has been explicitly
1921 ;; specified, otherwise it is a grob name.
1923 (set! (ly:music-property music 'tweaks)
1924 (acons (cond ((pair? (cddr p)) p)
1926 (cons (car p) (cadr p)))
1929 (ly:music-property music 'tweaks)))))
1934 #(define-music-function (music)
1936 (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1937 @code{\\revert} and @code{\\unset}, respectively. Any reverts and
1938 unsets already in @var{music} cause a warning. Non-property-related music is ignored.")
1945 (music-type-predicate '(layout-instruction-event
1946 context-specification
1948 time-signature-music))
1949 (lambda (m overrides)
1950 (case (ly:music-property m 'name)
1953 (make-music 'RevertProperty
1954 'symbol (ly:music-property m 'symbol)
1957 ((ly:music-property m 'grob-property #f) => list)
1959 (ly:music-property m 'grob-property-path))))
1963 (make-music 'PropertyUnset
1964 'symbol (ly:music-property m 'symbol))
1966 ((ContextSpeccedMusic)
1968 (make-music 'ContextSpeccedMusic
1969 'element (loop (ly:music-property m 'element))
1970 'context-type (ly:music-property m 'context-type))
1975 (ly:input-warning (*location*) (_ "Cannot revert ~a")
1976 (ly:music-property m 'name))
1982 ((null? lst) (make-music 'Music))
1983 ((null? (cdr lst)) (car lst))
1984 (else (make-sequential-music lst))))))
1987 #(define-music-function (types music)
1988 ((symbol-list-or-symbol? '()) ly:music?)
1989 (_i "Force @code{\\repeat volta}, @code{\\repeat tremolo} or
1990 @code{\\repeat percent} commands in @var{music} to be interpreted
1991 as @code{\\repeat unfold}, if specified in the optional symbol-list @var{types}.
1992 The default for @var{types} is an empty list, which will force any of those
1993 commands in @var{music} to be interpreted as @code{\\repeat unfold}. Possible
1994 entries are @code{volta}, @code{tremolo} or @code{percent}. Multiple entries
1996 (unfold-repeats types music))
1999 #(define-void-function (arg) (scheme?)
2000 (_i "Accept a scheme argument, return a void expression.
2001 Use this if you want to have a scheme expression evaluated
2002 because of its side-effects, but its value ignored."))
2005 #(define-music-function (sym val music)
2006 (symbol? scheme? ly:music?)
2007 (_i "Set @var{sym} to @var{val} in @var{music}.")
2009 (set! (ly:music-property music sym) val)