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 = #(cons 6 8)
61 #(define-music-function (main grace) (ly:music? ly:music?)
62 (_i "Create @var{grace} note(s) after a @var{main} music expression.")
63 (let ((main-length (ly:music-length main))
64 (fraction (ly:parser-lookup 'afterGraceFraction)))
65 (make-simultaneous-music
68 (make-sequential-music
71 (make-music 'SkipMusic
72 'duration (ly:make-duration
74 (* (ly:moment-main-numerator main-length)
76 (* (ly:moment-main-denominator main-length)
78 (make-music 'GraceMusic
82 %% music identifiers not allowed at top-level,
83 %% so this is a music-function instead.
85 #(define-music-function () ()
86 (_i "Allow a page turn. May be used at toplevel (ie between scores or
87 markups), or inside a score.")
88 (make-music 'EventChord
90 'page-turn-permission 'allow
91 'elements (list (make-music 'PageTurnEvent
92 'break-permission 'allow))))
95 #(define-music-function (property arg item)
96 (symbol-list-or-symbol? list? symbol-list-or-music?)
97 (_i "Override @var{property} for pieces of broken spanner @var{item}
98 with values @var{arg}. @var{item} may either be music in the form of
99 a starting spanner event, or a symbol list in the form
100 @samp{Context.Grob} or just @samp{Grob}. Iff @var{item} is in the
101 form of a spanner event, @var{property} may also have the form
102 @samp{Grob.property} for specifying a directed tweak.")
104 (if (eq? (ly:music-property item 'span-direction) START)
105 (tweak property (value-for-spanner-piece arg) item)
107 (ly:music-warning item (_ "not a spanner"))
109 (let* ((p (check-grob-path item (*location*)
113 (name (and p (second p)))
115 (and name (assoc-get name all-grob-descriptions))))
117 (member 'spanner-interface
118 (assoc-get 'interfaces
119 (assoc-get 'meta description))))
120 (propertyOverride (append item (if (symbol? property)
123 (value-for-spanner-piece arg))
125 (ly:input-warning (*location*) (_ "not a spanner name, `~a'") name)
126 (make-music 'Music))))))
129 #(define-music-function (tag more music)
130 (symbol? ly:music? ly:music?)
131 (_i "Append @var{more} to the @code{elements} of all music
132 expressions in @var{music} that are tagged with @var{tag}.")
133 (music-map (lambda (m)
134 (if (memq tag (ly:music-property m 'tags))
135 (set! (ly:music-property m 'elements)
136 (append (ly:music-property m 'elements)
142 #(define-music-function (proc) (procedure?)
143 (_i "Modify context properties with Scheme procedure @var{proc}.")
144 (make-music 'ApplyContext
148 #(define-music-function (func music) (procedure? ly:music?)
149 (_i"Apply procedure @var{func} to @var{music}.")
153 #(define-music-function (target proc) (symbol-list-or-symbol? procedure?)
154 (_i "Apply function @code{proc} to every layout object matched by
155 @var{target} which takes the form @code{Context} or @code{Context.Grob}.")
156 (let ((p (check-grob-path target (*location*) #:max 2)))
158 (make-music 'ApplyOutputEvent
160 'context-type (car p)
162 (list (cons 'symbol (cadr p)))
164 (make-music 'Music))))
167 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
168 (_i "Create an appoggiatura from @var{music}"))
170 % for regression testing purposes.
172 #(define-music-function (l r) (pair? pair?)
173 (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
174 (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
176 % for regression testing purposes.
178 #(define-music-function (comp) (procedure?)
179 (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
180 (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
183 #(define-music-function (pitch clef-1 clef-2 music)
184 ((ly:pitch? (ly:make-pitch 0 0)) (ly:context-mod?)(ly:context-mod?) ly:music?)
185 (_i "Make voices that switch between staves automatically. As an option the
186 pitch where to switch staves may be specified. The clefs for the staves are
187 optional as well. Setting clefs works only for implicitly instantiated
189 (let ;; keep the contexts alive for the full duration
190 ((skip (make-duration-of-length (ly:music-length music)))
191 (clef-1 (or clef-1 #{ \with { \clef "treble" } #}))
192 (clef-2 (or clef-2 #{ \with { \clef "bass" } #})))
193 (make-simultaneous-music
195 (descend-to-context (make-autochange-music pitch music) 'Staff
197 (context-spec-music (make-skip-music skip) 'Staff
199 (context-spec-music (make-skip-music skip) 'Staff
203 #(define-music-function (grob-name offset text)
204 (symbol? number-pair? markup?)
205 (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
206 (use like @code{\\once})")
209 (make-music 'AnnotateOutputEvent
211 'X-offset (car offset)
212 'Y-offset (cdr offset)
216 #(define-event-function (offset text) (number-pair? markup?)
217 (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
218 (make-music 'AnnotateOutputEvent
219 'X-offset (car offset)
220 'Y-offset (cdr offset)
224 #(define-music-function (type) (string?)
225 (_i "Insert a bar line of type @var{type}")
227 (make-property-set 'whichBar type)
231 #(define-music-function (n) (integer?)
232 (_i "Print a warning if the current bar number is not @var{n}.")
233 (make-music 'ApplyContext
236 (let ((cbn (ly:context-property c 'currentBarNumber)))
237 (if (and (number? cbn) (not (= cbn n)))
238 (ly:input-warning (*location*)
239 "Barcheck failed got ~a expect ~a"
243 #(define-scheme-function (music) (ly:music?)
244 (_i "Extract a value suitable for setting
245 @code{Timing.beamExceptions} from the given pattern with explicit
246 beams in @var{music}. A bar check @code{|} has to be used between
247 bars of patterns in order to reset the timing.")
248 (extract-beam-exceptions music))
251 #(define-event-function (delta) (real?)
252 (_i "Create a fall or doit of pitch interval @var{delta}.")
253 (make-music 'BendAfterEvent
257 #(define-void-function (newfilename) (string?)
258 (_i "Direct output for the current book block to @var{newfilename}.")
259 (set! (paper-variable #f 'output-filename) newfilename))
262 #(define-void-function (newsuffix) (string?)
263 (_i "Set the output filename suffix for the current book block to
265 (set! (paper-variable #f 'output-suffix) newsuffix))
267 %% \breathe is defined as a music function rather than an event identifier to
268 %% ensure it gets useful input location information: as an event identifier,
269 %% it would have to be wrapped in an EventChord to prevent it from being
270 %% treated as a post_event by the parser
272 #(define-music-function () ()
273 (_i "Insert a breath mark.")
274 (make-music 'BreathingEvent))
277 #(define-music-function (type) (string?)
278 (_i "Set the current clef to @var{type}.")
279 (make-clef-set type))
283 #(define-music-function (args) (pair?)
284 (_i "Create compound time signatures. The argument is a Scheme list of
285 lists. Each list describes one fraction, with the last entry being the
286 denominator, while the first entries describe the summands in the
287 enumerator. If the time signature consists of just one fraction,
288 the list can be given directly, i.e. not as a list containing a single list.
289 For example, a time signature of (3+1)/8 + 2/4 would be created as
290 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
291 as @code{\\compoundMeter #'((3 2 8))} or shorter
292 @code{\\compoundMeter #'(3 2 8)}.")
293 (let* ((mlen (calculate-compound-measure-length args))
294 (beat (calculate-compound-base-beat args))
295 (beatGrouping (calculate-compound-beat-grouping args))
296 (timesig (cons (ly:moment-main-numerator mlen)
297 (ly:moment-main-denominator mlen))))
299 \once \override Timing.TimeSignature.stencil = #(lambda (grob)
300 (grob-interpret-markup grob (make-compound-meter-markup args)))
301 \set Timing.timeSignatureFraction = #timesig
302 \set Timing.baseMoment = #beat
303 \set Timing.beatStructure = #beatGrouping
304 \set Timing.beamExceptions = #'()
305 \set Timing.measureLength = #mlen
309 #(define-music-function (music) (ly:music?)
310 (_i "Remove the empty bars created by multi-measure rests,
311 leaving just the first bar containing the MM rest itself.")
314 (if (eq? 'MultiMeasureRestMusic (ly:music-property m 'name))
315 #{ \once \set Score.skipBars = ##t #m #}
320 #(define-music-function (notes) (ly:music?)
321 (_i "Create cross-staff stems")
323 \temporary \override Stem.cross-staff = #cross-staff-connect
324 \temporary \override Flag.style = #'no-flag
326 \revert Stem.cross-staff
331 #(define-music-function (type) (string?)
332 (_i "Set the current cue clef to @var{type}.")
333 (make-cue-clef-set type))
336 #(define-music-function () ()
337 (_i "Unset the current cue clef.")
338 (make-cue-clef-unset))
341 #(define-music-function
342 (what dir main-music) (string? ly:dir? ly:music?)
343 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
344 in a CueVoice oriented by @var{dir}.")
345 (make-music 'QuoteMusic
347 'quoted-context-type 'CueVoice
348 'quoted-context-id "cue"
349 'quoted-music-name what
350 'quoted-voice-direction dir))
353 #(define-music-function
354 (what dir clef main-music) (string? ly:dir? string? ly:music?)
355 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
356 in a CueVoice oriented by @var{dir}.")
357 (make-music 'QuoteMusic
359 'quoted-context-type 'CueVoice
360 'quoted-context-id "cue"
361 'quoted-music-name what
362 'quoted-music-clef clef
363 'quoted-voice-direction dir))
368 #(define-music-function (port music) ((output-port?) ly:music?)
369 (_i "Display the LilyPond input representation of @var{music}
370 to @var{port}, defaulting to the console.")
371 (let ((port (or port (current-output-port))))
373 (display-lily-music music port))
377 #(define-music-function (port music) ((output-port?) ly:music?)
378 (_i "Display the internal representation of @var{music} to
379 @var{port}, default to the console.")
380 (let ((port (or port (current-output-port))))
382 (display-scheme-music music port))
386 #(define-scheme-function (port expr) ((output-port?) scheme?)
387 (_i "Display the internal representation of @var{expr} to
388 @var{port}, default to the console.")
389 (let ((port (or port (current-output-port))))
391 (display-scheme-music expr port))
397 #(define-music-function (music) (ly:music?)
398 (_i "Terminate the next spanner prematurely after exactly one note
399 without the need of a specific end spanner.")
400 (let* ((start-span-evs (filter (lambda (ev)
401 (equal? (ly:music-property ev 'span-direction)
403 (extract-typed-music music 'span-event)))
406 (music-clone m 'span-direction STOP))
408 (end-ev-chord (make-music 'EventChord
409 'elements stop-span-evs))
410 (total (make-music 'SequentialMusic
411 'elements (list music
416 #(define-music-function (music) (ly:music?)
417 (_i "Compatibility function wrapping @code{EventChord} around
418 isolated rhythmic events occuring since version 2.15.28, after
419 expanding repeat chords @samp{q}.")
420 (event-chord-wrap! music))
423 #(define-music-function (factor argument) (ly:moment? ly:music?)
424 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
425 (let ((orig-duration (ly:music-length argument))
426 (multiplier (ly:make-moment 1 1)))
430 (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
432 (ly:music-compress mus multiplier)
433 (set! multiplier (ly:moment-mul factor multiplier)))))
434 (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
437 (ly:moment-div orig-duration (ly:music-length argument)))
442 #(define-event-function (finger) (number-or-markup?)
443 (_i "Apply @var{finger} as a fingering indication.")
447 (if (number? finger) 'digit 'text)
451 #(define-music-function (pitch music)
452 (ly:pitch? ly:music?)
453 (_i "Use the octave of @var{pitch} as the default octave for @var{music}.")
454 (let ((octave-marks (1+ (ly:pitch-octave pitch))))
455 (cond ((not (= 0 octave-marks))
456 (ly:music-transpose music (ly:make-pitch octave-marks 0 0))
457 ;;In order to leave unchanged the notes in any enclosed
458 ;; \absolute or \fixed or \relative, make a cancelling shift
460 (ly:music-transpose m (ly:make-pitch (- octave-marks) 0 0)))
461 (extract-named-music music 'RelativeOctaveMusic)))))
462 (make-music 'RelativeOctaveMusic 'element music))
465 #(define-music-function (mark offset footnote item)
466 ((markup?) number-pair? markup? symbol-list-or-music?)
467 (_i "Make the markup @var{footnote} a footnote on @var{item}. The
468 footnote is marked with a markup @var{mark} moved by @var{offset} with
469 respect to the marked music.
471 If @var{mark} is not given or specified as @var{\\default}, it is
472 replaced by an automatically generated sequence number. If @var{item}
473 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
474 grobs of that type will be marked at the current time step in the
475 given context (default @code{Bottom}).
477 If @var{item} is music, the music will get a footnote attached to a
478 grob immediately attached to the event, like @var{\\tweak} does. For
479 attaching a footnote to an @emph{indirectly} caused grob, write
480 @code{\\single\\footnote}, use @var{item} to specify the grob, and
481 follow it with the music to annotate.
483 Like with @code{\\tweak}, if you use a footnote on a following
484 post-event, the @code{\\footnote} command itself needs to be attached
485 to the preceding note or rest as a post-event with @code{-}.")
486 (let ((mus (make-music
488 'X-offset (car offset)
489 'Y-offset (cdr offset)
490 'automatically-numbered (not mark)
491 'text (or mark (make-null-markup))
492 'footnote-text footnote)))
493 (once (propertyTweak 'footnote-music mus item))))
496 #(def-grace-function startGraceMusic stopGraceMusic
497 (_i "Insert @var{music} as grace notes."))
500 #(define-scheme-function (descriptions) (list?)
501 (_i "Create a context modification from @var{descriptions}, a list
502 in the format of @code{all-grob-descriptions}.")
505 (list 'assign (car p) (ly:make-grob-properties (cdr p))))
508 harmonicByFret = #(define-music-function (fret music) (number? ly:music?)
509 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
510 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
512 \set harmonicDots = ##t
513 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
514 \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
515 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
516 (ly:note-head::print grob))
518 (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
520 \revert TabNoteHead.stencil
521 \revert NoteHead.Y-extent
522 \revert NoteHead.stencil
525 harmonicByRatio = #(define-music-function (ratio music) (number? ly:music?)
526 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
527 harmonics played on a fretted instrument by touching the strings at the point
528 given through @var{ratio}.")
530 \set harmonicDots = ##t
531 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
532 \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height)
533 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
534 (ly:note-head::print grob))
536 (calc-harmonic-pitch (ratio->pitch ratio) music))
538 \revert TabNoteHead.stencil
539 \revert NoteHead.Y-extent
540 \revert NoteHead.stencil
544 #(define-music-function (item) (symbol-list-or-music?)
545 (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
546 making it invisible while still retaining its dimensions.
548 If @var{item} is a symbol list of form @code{GrobName} or
549 @code{Context.GrobName}, the result is an override for the grob name
550 specified by it. If @var{item} is a music expression, the result is
551 the same music expression with an appropriate tweak applied to it.")
552 (propertyTweak 'transparent #t item))
555 #(define-music-function () ()
556 (_i "Put the segno variant 'varsegno' at this position into the staff,
557 compatible with the repeat command.")
558 (make-music 'ApplyContext
561 (let ((score-ctx (ly:context-find ctx 'Score)))
562 (if (ly:context? score-ctx)
563 (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
564 (if (eq? (memq 'segno-display old-rc) #f)
565 (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
568 #(define-music-function
570 (_i "Switch instrument to @var{name}, which must be predefined with
571 @code{\\addInstrumentDefinition}.")
572 (let* ((handle (assoc name instrument-definitions))
573 (instrument-def (if handle (cdr handle) '())))
576 (ly:input-warning (*location*) "No such instrument: ~a" name))
578 (make-music 'SimultaneousMusic
590 #(define-music-function (tags music)
591 (symbol-list-or-symbol? ly:music?)
592 (_i "Include only elements of @var{music} that are tagged with one
593 of the tags in @var{tags}. @var{tags} may be either a single symbol
594 or a list of symbols.
596 Each tag may be declared as a member of at most one tag group (defined
597 with @code{\\tagGroup}). If none of a @var{music} element's tags
598 share a tag group with one of the specified @var{tags}, the element is
601 (tags-keep-predicate tags)
605 #(define-music-function (tonic pitch-alist)
606 ((ly:pitch? '()) (list? '()))
607 (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
608 If both are null, just generate @code{KeyChangeEvent}.")
609 (cond ((null? tonic) (make-music 'KeyChangeEvent))
611 (ly:parser-error (_ "second argument must be pitch list")
613 (make-music 'SequentialMusic 'void #t))
616 (make-music 'KeyChangeEvent
617 'tonic (ly:make-pitch 0 0 0)
618 'pitch-alist pitch-alist)
622 #(define-music-function (music) (ly:music?)
623 (_i "Remove cue notes from @var{music}.")
626 (if (and (string? (ly:music-property mus 'quoted-music-name))
627 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
628 (ly:music-property mus 'element)
635 #(define-music-function (label) (symbol?)
636 (_i "Create @var{label} as a bookmarking label.")
637 (make-music 'EventChord
640 'elements (list (make-music 'LabelEvent
641 'page-label label))))
645 #(define-void-function (language) (string?)
646 (_i "Set note names for language @var{language}.")
647 (note-names-language language))
649 languageSaveAndChange =
650 #(define-void-function (language) (string?)
651 (_i "Store the previous pitchnames alist, and set a new one.")
652 (set! previous-pitchnames pitchnames)
653 (note-names-language language))
656 #(define-void-function () ()
657 (_i "Restore a previously-saved pitchnames alist.")
658 (if previous-pitchnames
660 (set! pitchnames previous-pitchnames)
661 (ly:parser-set-note-names pitchnames))
662 (ly:input-warning (*location*) (_ "No other language was defined previously. Ignoring."))))
666 #(define-music-function (mag music) (positive? ly:music?)
667 (_i "Magnify the notation of @var{music} without changing the
668 staff-size, using @var{mag} as a size factor. Stems, beams,
669 slurs, ties, and horizontal spacing are adjusted automatically.")
671 ;; these props are NOT allowed to shrink below default size
672 (define unshrinkable-props
678 (Slur line-thickness)
680 (PhrasingSlur line-thickness)
681 (PhrasingSlur thickness)
686 (LaissezVibrerTie line-thickness)
687 (LaissezVibrerTie thickness)
688 (RepeatTie line-thickness)
689 (RepeatTie thickness)
692 ;; these props ARE allowed to shrink below default size
693 (define shrinkable-props
694 (let ((baseline-skip-props
695 (find-named-props 'baseline-skip all-grob-descriptions))
697 (find-named-props 'word-space all-grob-descriptions)))
702 ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed
703 ;; override at the 'Score level
704 ;(SpacingSpanner spacing-increment)
706 ;; lengths and heights
707 (Beam length-fraction)
708 (Stem length-fraction)
709 (Stem beamlet-default-length)
710 (Stem double-stem-separation)
712 (Slur minimum-length)
713 (PhrasingSlur height-limit)
714 (PhrasingSlur minimum-length)
716 ;; Beam.beam-thickness is dealt with separately below
720 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
722 #(scale-fontSize 'magnifyMusic mag)
723 #(scale-props 'magnifyMusic mag #f unshrinkable-props)
724 #(scale-props 'magnifyMusic mag #t shrinkable-props)
725 #(scale-beam-thickness mag)
729 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
731 %% reverse engineer the former fontSize value instead of using \unset
732 #(revert-fontSize 'magnifyMusic mag)
733 #(revert-props 'magnifyMusic mag (append unshrinkable-props
735 '((Beam beam-thickness))))
740 #(define-music-function (mag) (positive?)
741 (_i "Change the size of the staff, adjusting notation size and
742 horizontal spacing automatically, using @var{mag} as a size factor.")
744 ;; these props are NOT allowed to shrink below default size
745 (define unshrinkable-props
746 '((StaffSymbol thickness)))
748 ;; these props ARE allowed to shrink below default size
749 (define shrinkable-props
750 (let* ((baseline-skip-props
751 (find-named-props 'baseline-skip all-grob-descriptions))
753 (find-named-props 'word-space all-grob-descriptions))
755 (find-named-props 'space-alist all-grob-descriptions)))
761 ;; override at the 'Score level
762 (SpacingSpanner spacing-increment)
764 (StaffSymbol staff-space)
767 (BarLine hair-thickness)
768 (BarLine thick-thickness)
769 (Stem beamlet-default-length)
770 (Stem double-stem-separation)
776 %% revert settings from last time
777 %% (but only if \magnifyStaff has already been used
778 %% and the staff magnification is changing)
779 #(revert-fontSize 'magnifyStaff mag)
780 #(revert-props 'magnifyStaff mag (append unshrinkable-props
784 %% (but only if staff magnification is changing
785 %% and does not equal 1)
786 #(scale-fontSize 'magnifyStaff mag)
787 #(scale-props 'magnifyStaff mag #f unshrinkable-props)
788 #(scale-props 'magnifyStaff mag #t shrinkable-props)
790 %% this might cause problems until Issue 3990 is fixed
794 \set Staff.magnifyStaffValue = #mag
798 #(define-music-function (arg) (ly:music?)
799 (_i "Display chords in @var{arg} as clusters.")
800 (music-map note-to-cluster arg))
803 #(define-music-function (around to scale music)
804 (ly:pitch? ly:pitch? ly:music? ly:music?)
805 (_i "Invert @var{music} about @var{around} using @var{scale} and
806 transpose from @var{around} to @var{to}.")
807 (let ((inverter (make-modal-inverter around to scale)))
808 (change-pitches music inverter)
812 #(define-music-function (from to scale music)
813 (ly:pitch? ly:pitch? ly:music? ly:music?)
814 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
816 (let ((transposer (make-modal-transposer from to scale)))
817 (change-pitches music transposer)
821 #(define-music-function
822 (around to music) (ly:pitch? ly:pitch? ly:music?)
823 (_i "Invert @var{music} about @var{around} and
824 transpose from @var{around} to @var{to}.")
825 (music-invert around to music))
828 #(define-music-function
829 (label) ((number-or-markup?))
830 "Make the music for the \\mark command."
831 (let* ((set (and (integer? label)
832 (context-spec-music (make-property-set 'rehearsalMark label)
834 (ev (make-music 'MarkEvent
835 'origin (*location*))))
838 (make-sequential-music (list set ev))
840 (if label (set! (ly:music-property ev 'label) label))
844 #(define-music-function (path markupfun music)
845 (symbol-list-or-symbol? markup-function? ly:music?)
846 (_i "This applies the given markup function @var{markupfun} to all markup
847 music properties matching @var{path} in @var{music}.
851 \\new Voice @{ g'2 c'' @}
853 \\markupMap LyricEvent.text
854 \\markup \\with-color #red \\etc
859 (let* ((p (check-music-path path (*location*)))
860 (name (and p (car p)))
861 (prop (and p (cadr p))))
865 (if (or (not name) (eq? (ly:music-property m 'name) name))
866 (let ((text (ly:music-property m prop)))
868 (set! (ly:music-property m prop)
869 (list markupfun text)))))
875 #(define-music-function (proc mus) (procedure? ly:music?)
876 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
877 (music-map proc mus))
879 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
880 %% because music identifiers are not allowed at top-level.
882 #(define-music-function () ()
883 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
884 markups), or inside a score.")
885 (make-music 'EventChord
887 'page-break-permission 'forbid
888 'elements (list (make-music 'PageBreakEvent
889 'break-permission '()))))
892 #(define-music-function () ()
893 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
894 markups), or inside a score.")
895 (make-music 'EventChord
897 'page-turn-permission 'forbid
898 'elements (list (make-music 'PageTurnEvent
899 'break-permission '()))))
904 #(define-music-function (pitch) (ly:pitch?)
906 (make-music 'RelativeOctaveCheck
910 #(define-music-function (property offsets item)
911 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
912 (_i "Offset the default value of @var{property} of @var{item} by
913 @var{offsets}. If @var{item} is a string, the result is
914 @code{\\override} for the specified grob type. If @var{item} is
915 a music expression, the result is the same music expression with an
916 appropriate tweak applied.")
918 ; In case of a tweak, grob property path is Grob.property
919 (let ((prop-path (check-grob-path
920 (if (symbol? property)
922 property) (*location*)
923 #:start 1 #:default #t #:min 2 #:max 2)))
925 ; If the head of the grob property path is a symbol--i.e.,
926 ; a grob name, produce a directed tweak. Otherwise, create
928 (if (symbol? (car prop-path))
929 (tweak prop-path (offsetter (second prop-path) offsets) item)
930 (tweak (second prop-path)
931 (offsetter (second prop-path) offsets)
934 ; In case of an override, grob property path is Context.Grob.property.
935 (let ((prop-path (check-grob-path
937 (if (symbol? property)
939 property)) (*location*)
940 #:default 'Bottom #:min 3 #:max 3)))
942 (propertyOverride prop-path (offsetter (third prop-path) offsets))
943 (make-music 'Music)))))
946 #(define-music-function (item) (symbol-list-or-music?)
947 (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
948 effectively omitting it without taking up space.
950 If @var{item} is a symbol list of form @code{GrobName} or
951 @code{Context.GrobName}, the result is an override for the grob name
952 specified by it. If @var{item} is a music expression, the result is
953 the same music expression with an appropriate tweak applied to it.")
954 (propertyTweak 'stencil #f item))
957 #(define-music-function (music) (ly:music?)
958 (_i "Set @code{once} to @code{#t} on all layout instruction events
959 in @var{music}. This will complain about music with an actual
960 duration. As a special exception, if @var{music} contains
961 @samp{tweaks} it will be silently ignored in order to allow for
962 @code{\\once \\propertyTweak} to work as both one-time override and proper
964 (if (not (pair? (ly:music-property music 'tweaks)))
967 (cond ((music-is-of-type? m 'layout-instruction-event)
968 (set! (ly:music-property m 'once) #t)
970 ((ly:duration? (ly:music-property m 'duration))
971 (ly:music-warning m (_ "Cannot apply \\once to timed music"))
978 #(define-music-function (octave) (integer?)
979 (_i "Set the octavation.")
980 (make-music 'OttavaMusic
981 'ottava-number octave))
983 overrideTimeSignatureSettings =
984 #(define-music-function
985 (time-signature base-moment beat-structure beam-exceptions)
986 (fraction? fraction? list? list?)
988 (_i "Override @code{timeSignatureSettings}
989 for time signatures of @var{time-signature} to have settings
990 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
992 ;; TODO -- add warning if largest value of grouping is
993 ;; greater than time-signature.
994 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
995 (override-time-signature-setting time-signature setting)))
998 #(define-music-function (grob-property-path value)
999 (symbol-list? scheme?)
1001 (_i "Set the grob property specified by @var{grob-property-path} to
1002 @var{value}. @var{grob-property-path} is a symbol list of the form
1003 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1004 with subproperties given as well.
1006 As opposed to @code{\\override} which overrides the context-dependent
1007 defaults with which a grob is created, this command uses
1008 @code{Output_property_engraver} at the grob acknowledge stage. This
1009 may be necessary for overriding values set after the initial grob
1011 (let ((p (check-grob-path grob-property-path (*location*)
1015 (make-music 'ApplyOutputEvent
1016 'context-type (first p)
1018 (lambda (grob orig-context context)
1020 (cdr (assoc 'name (ly:grob-property grob 'meta)))
1022 (ly:grob-set-nested-property!
1023 grob (cddr p) value))))
1024 (make-music 'Music))))
1031 %% pageBreak and pageTurn are music functions (iso music indentifiers),
1032 %% because music identifiers are not allowed at top-level.
1034 #(define-music-function () ()
1035 (_i "Force a page break. May be used at toplevel (i.e., between scores or
1036 markups), or inside a score.")
1037 (make-music 'EventChord
1039 'line-break-permission 'force
1040 'page-break-permission 'force
1041 'elements (list (make-music 'LineBreakEvent
1042 'break-permission 'force)
1043 (make-music 'PageBreakEvent
1044 'break-permission 'force))))
1047 #(define-music-function () ()
1048 (_i "Force a page turn between two scores or top-level markups.")
1049 (make-music 'EventChord
1051 'line-break-permission 'force
1052 'page-break-permission 'force
1053 'page-turn-permission 'force
1054 'elements (list (make-music 'LineBreakEvent
1055 'break-permission 'force)
1056 (make-music 'PageBreakEvent
1057 'break-permission 'force)
1058 (make-music 'PageTurnEvent
1059 'break-permission 'force))))
1062 #(define-void-function (voice-ids music) (list? ly:music?)
1063 (_i "Define parallel music sequences, separated by '|' (bar check signs),
1064 and assign them to the identifiers provided in @var{voice-ids}.
1066 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
1068 @var{music}: a music sequence, containing BarChecks as limiting expressions.
1073 \\parallelMusic #'(A B C) {
1083 The last bar checks in a sequence are not copied to the result in
1084 order to facilitate ending the last entry at non-bar boundaries.
1086 (define voice-count (length voice-ids))
1087 (define (bar-check? m)
1088 "Checks whether m is a bar check."
1089 (eq? (ly:music-property m 'name) 'BarCheck))
1090 (define (recurse-and-split-list lst)
1091 "Return either a list of music lists split along barchecks, or @code{#f}."
1092 (if (any bar-check? lst)
1093 (let* ((voices (apply circular-list (make-list voice-count '())))
1094 (current-voices voices)
1095 (current-sequence '()))
1098 (define (push-music m)
1099 "Push the music expression into the current sequence"
1100 (set! current-sequence (cons m current-sequence)))
1101 (define (change-voice)
1102 "Store the previously built sequence into the current voice and
1103 change to the following voice."
1104 (set-car! current-voices
1105 (cons current-sequence
1106 (car current-voices)))
1107 (set! current-sequence '())
1108 (set! current-voices (cdr current-voices)))
1109 (for-each (lambda (m)
1110 (let ((split? (recurse-and-split m)))
1119 (if (bar-check? m) (change-voice))))))
1121 (if (pair? current-sequence) (change-voice))
1122 ;; Un-circularize voices
1123 (set! voices (list-head voices voice-count))
1125 ;; Remove trailing bar checks to facilitate ending a
1126 ;; sequence on a non-bar, reverse partial sequences and sequences
1131 (if (and (pair? l) (pair? (car l))
1132 (bar-check? (caar l)))
1133 (cons (cdar l) (cdr l))
1137 ;; check sequence length
1138 (apply for-each (lambda seqs
1139 (define (seq-len seq)
1140 (reduce ly:moment-add
1142 (map ly:music-length seq)))
1143 (let ((moment-reference (seq-len (car seqs))))
1144 (for-each (lambda (seq)
1145 (if (not (equal? (seq-len seq)
1151 (_ "Bars in parallel music don't have the same length"))))
1154 (map concatenate! voices))
1155 (let ((deeper (map recurse-and-split lst)))
1156 (and (any pair? deeper)
1160 (ly:music-deep-copy (make-list voice-count m))))
1162 (define (recurse-and-split music)
1163 "This returns either a list of music split along barchecks, or
1165 (let* ((elt (ly:music-property music 'element))
1166 (elts (ly:music-property music 'elements))
1167 (split-elt (and (ly:music? elt) (recurse-and-split elt)))
1168 (split-elts (and (pair? elts) (recurse-and-split-list elts))))
1169 (and (or split-elt split-elts)
1172 (let ((m (ly:music-deep-copy music
1173 ;;; reassigning the origin of the parent only
1174 ;;; makes sense if the first expression in the
1175 ;;; result is from a distributed origin
1176 (or (and (ly:music? e) e)
1177 (and (pair? es) (car es))))))
1179 (set! (ly:music-property m 'element) e))
1181 (set! (ly:music-property m 'elements) es))
1183 (or split-elt (circular-list #f))
1184 (or split-elts (circular-list #f))))))
1185 (let ((voices (recurse-and-split music)))
1188 ;; bind voice identifiers to the voices
1189 (for-each (lambda (voice-id voice)
1190 (ly:parser-define! voice-id voice))
1192 (ly:music-warning music
1193 (_ "ignoring parallel music without barchecks")))))
1196 #(define-music-function (arg) (ly:music?)
1197 (_i "Tag @var{arg} to be parenthesized.")
1199 (if (memq 'event-chord (ly:music-property arg 'types))
1200 ;; arg is an EventChord -> set the parenthesize property
1201 ;; on all child notes and rests
1204 (if (or (memq 'note-event (ly:music-property ev 'types))
1205 (memq 'rest-event (ly:music-property ev 'types)))
1206 (set! (ly:music-property ev 'parenthesize) #t)))
1207 (ly:music-property arg 'elements))
1208 ;; No chord, simply set property for this expression:
1209 (set! (ly:music-property arg 'parenthesize) #t))
1212 #(define (make-directed-part-combine-music direction chord-range part1 part2
1213 one-context-settings
1214 two-context-settings
1215 shared-context-settings)
1217 (let* ((pc-music (make-music 'PartCombineMusic))
1218 (m1 (context-spec-music (make-non-relative-music part1) 'Voice "one"))
1219 (m2 (context-spec-music (make-non-relative-music part2) 'Voice "two"))
1220 (listener (ly:parser-lookup 'partCombineListener))
1221 (evs2 (recording-group-emulate m2 listener))
1222 (evs1 (recording-group-emulate m1 listener))
1224 (if (and (assoc "one" evs1) (assoc "two" evs2))
1225 (determine-split-list (reverse! (assoc-get "one" evs1) '())
1226 (reverse! (assoc-get "two" evs2) '())
1229 (L1 (ly:music-length part1))
1230 (L2 (ly:music-length part2))
1231 ;; keep the contexts alive for the full duration
1232 (skip (make-skip-music (make-duration-of-length
1233 (if (ly:moment<? L1 L2) L2 L1)))))
1235 (set! (ly:music-property pc-music 'elements)
1237 'PartCombinePartMusic
1239 'context-change-list
1240 (make-part-combine-context-changes
1241 default-part-combine-context-change-state-machine-one
1244 'PartCombinePartMusic
1246 'context-change-list
1247 (make-part-combine-context-changes
1248 default-part-combine-context-change-state-machine-two
1251 (set! (ly:music-property pc-music 'direction) direction)
1253 #{ \context Staff <<
1254 \context Voice = "one" \with #one-context-settings { #skip }
1255 \context Voice = "two" \with #two-context-settings { #skip }
1256 \context Voice = "shared" \with #shared-context-settings { #skip }
1257 \context Voice = "solo" { #skip }
1258 \context NullVoice = "null" { #skip }
1260 #(make-part-combine-marks
1261 default-part-combine-mark-state-machine split-list)
1265 #(define-music-function (chord-range part1 part2)
1266 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1267 (_i "Take the music in @var{part1} and @var{part2} and return
1268 a music expression containing simultaneous voices, where @var{part1}
1269 and @var{part2} are combined into one voice where appropriate.
1270 Optional @var{chord-range} sets the distance in steps between notes
1271 that may be combined into a chord or unison.")
1272 (make-directed-part-combine-music #f chord-range part1 part2
1273 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1274 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1278 #(define-music-function (chord-range part1 part2)
1279 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1280 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1281 that they share a staff with stems directed upward.")
1282 (make-directed-part-combine-music UP chord-range part1 part2
1283 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1284 #{ \with { \voiceThree \override DynamicLineSpanner.direction = #UP } #}
1285 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} ))
1288 #(define-music-function (chord-range part1 part2)
1289 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1290 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1291 that they share a staff with stems directed downward.")
1292 (make-directed-part-combine-music DOWN chord-range part1 part2
1293 #{ \with { \voiceFour \override DynamicLineSpanner.direction = #DOWN } #}
1294 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1295 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} ))
1297 %% Part combine forcing to be found in ly/property-init.ly
1300 #(define-music-function (dur) (ly:duration?)
1301 (_i "Make a partial measure.")
1303 ;; We use `descend-to-context' here instead of `context-spec-music' to
1304 ;; ensure \partial still works if the Timing_translator is moved
1306 (context-spec-music (make-music 'PartialSet
1307 'origin (*location*)
1313 #(define-music-function
1314 (main-note secondary-note)
1315 (ly:music? ly:music?)
1316 (_i "Print a trill with @var{main-note} as the main note of the trill and
1317 print @var{secondary-note} as a stemless note head in parentheses.")
1318 (let* ((get-notes (lambda (ev-chord)
1319 (extract-named-music ev-chord 'NoteEvent)))
1320 (sec-note-events (get-notes secondary-note))
1321 (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1322 (if (pair? sec-note-events)
1324 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1325 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1327 (if (ly:pitch? trill-pitch)
1328 (for-each (lambda (m)
1329 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1331 (ly:input-warning (*location*) (_ "Second argument of \\pitchedTrill should be single note: "))
1332 (display sec-note-events)))
1335 (for-each (lambda (m)
1336 (ly:music-set-property! m 'force-accidental forced))
1341 #(define-music-function (grob-property-path value)
1342 (symbol-list? scheme?)
1343 (_i "Set the grob property specified by @var{grob-property-path} to
1344 @var{value}. @var{grob-property-path} is a symbol list of the form
1345 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1346 with subproperties given as well. This music function is mostly intended
1347 for use from Scheme as a substitute for the built-in @code{\\override}
1349 (let ((p (check-grob-path grob-property-path (*location*)
1354 (make-music 'OverrideProperty
1356 'origin (*location*)
1358 'grob-property-path (cddr p)
1361 (make-music 'Music))))
1364 #(define-music-function (grob-property-path)
1366 (_i "Revert the grob property specified by @var{grob-property-path} to
1367 its previous value. @var{grob-property-path} is a symbol list of the form
1368 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1369 with subproperties given as well. This music function is mostly intended
1370 for use from Scheme as a substitute for the built-in @code{\\revert}
1372 (let ((p (check-grob-path grob-property-path (*location*)
1377 (make-music 'RevertProperty
1379 'origin (*location*)
1380 'grob-property-path (cddr p))
1382 (make-music 'Music))))
1385 #(define-music-function (property-path value)
1386 (symbol-list-or-symbol? scheme?)
1387 (_i "Set the context property specified by @var{property-path} to
1388 @var{value}. This music function is mostly intended for use from
1389 Scheme as a substitute for the built-in @code{\\set} command.")
1390 (let ((p (check-context-path property-path (*location*))))
1393 (make-music 'PropertySet
1396 'origin (*location*))
1398 (make-music 'Music))))
1401 #(define-music-function (prop value item)
1402 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1403 (_i "Add a tweak to the following @var{item}, usually music.
1404 This generally behaves like @code{\\tweak} but will turn into an
1405 @code{\\override} when @var{item} is a symbol list.
1407 In that case, @var{item} specifies the grob path to override. This is
1408 mainly useful when using @code{\\propertyTweak} as as a component for
1409 building other functions like @code{\\omit}. It is not the default
1410 behavior for @code{\\tweak} since many input strings in
1411 @code{\\lyricmode} can serve equally as music or as symbols which
1412 causes surprising behavior when tweaking lyrics using the less
1413 specific semantics of @code{\\propertyTweak}.
1415 @var{prop} can contain additional elements in which case a nested
1416 property (inside of an alist) is tweaked.")
1417 ;; Why not instead make the parser treat strings preferably as
1418 ;; music in lyrics mode rather than as symbol? Because then
1420 ;; \tweak text "whatever" mylyrics
1422 ;; will try putting a lyric event with text "whatever" in the text
1423 ;; property of lyrics. So we want expressions allowing both
1424 ;; strings and lyrics to deliver strings: more complex conversions
1425 ;; should only be attempted when the simple uses don't match the
1427 (if (ly:music? item)
1428 (if (music-is-of-type? item 'context-specification)
1429 ;; This is essentially dealing with the case
1430 ;; \propertyTweak color #red \propertyTweak font-size #3 NoteHead
1431 ;; namely when stacked tweaks end in a symbol list
1432 ;; rather than a music expression.
1434 ;; We have a tweak here to convert into an override,
1435 ;; so we need to know the grob to apply it to. That's
1436 ;; easy if we have a directed tweak, and otherwise we
1437 ;; need to find the symbol in the expression itself.
1438 (let* ((p (check-grob-path prop (*location*)
1442 (elt (ly:music-property item 'element))
1443 (seq (if (music-is-of-type? elt 'sequential-music)
1445 (make-sequential-music (list elt))))
1446 (elts (ly:music-property seq 'elements))
1447 (symbol (if (symbol? (car p))
1450 (ly:music-property (car elts)
1452 (if (symbol? symbol)
1454 (set! (ly:music-property seq 'elements)
1455 (cons (make-music 'OverrideProperty
1457 'grob-property-path (cdr p)
1460 'origin (*location*))
1462 (set! (ly:music-property item 'element) seq))
1464 (ly:parser-error (_ "Cannot \\propertyTweak")
1466 (ly:music-message item (_ "untweakable"))))
1468 (tweak prop value item))
1469 (propertyOverride (append item (if (symbol? prop) (list prop) prop))
1473 #(define-music-function (property-path)
1474 (symbol-list-or-symbol?)
1475 (_i "Unset the context property specified by @var{property-path}.
1476 This music function is mostly intended for use from Scheme as a
1477 substitute for the built-in @code{\\unset} command.")
1478 (let ((p (check-context-path property-path (*location*))))
1481 (make-music 'PropertyUnset
1483 'origin (*location*))
1485 (make-music 'Music))))
1488 #(define-music-function (tag more music)
1489 (symbol? ly:music? ly:music?)
1490 (_i "Add @var{more} to the front of @code{elements} of all music
1491 expressions in @var{music} that are tagged with @var{tag}.")
1492 (music-map (lambda (m)
1493 (if (memq tag (ly:music-property m 'tags))
1494 (set! (ly:music-property m 'elements)
1495 (cons more (ly:music-property m 'elements))))
1500 #(define-music-function (what main-music) (string? ly:music?)
1501 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
1502 of the quoted voice, as specified in an @code{\\addQuote} command.
1503 @var{main-music} is used to indicate the length of music to be quoted;
1504 usually contains spacers or multi-measure rests.")
1505 (make-music 'QuoteMusic
1507 'quoted-music-name what))
1511 #(define-music-function (pitch music)
1512 ((ly:pitch?) ly:music?)
1513 (_i "Make @var{music} relative to @var{pitch}. If @var{pitch} is
1514 omitted, the first note in @var{music} is given in absolute pitch.")
1515 ;; When \relative has no clear decision (can only happen with
1516 ;; scales with an even number of steps), it goes down (see
1517 ;; pitch.cc). The following formula puts out f for both the normal
1518 ;; 7-step scale as well as for a "shortened" scale missing the
1519 ;; final b. In either case, a first note of c will end up as c,
1520 ;; namely pitch (-1, 0, 0).
1521 (ly:make-music-relative! music
1526 ;; size of current scale:
1527 (ly:pitch-steps (ly:make-pitch 1 0))
1529 (make-music 'RelativeOctaveMusic
1533 #(define-music-function (tags music)
1534 (symbol-list-or-symbol? ly:music?)
1535 (_i "Remove elements of @var{music} that are tagged with one of the
1536 tags in @var{tags}. @var{tags} may be either a single symbol or a list
1539 (tags-remove-predicate tags)
1542 resetRelativeOctave =
1543 #(define-music-function (pitch) (ly:pitch?)
1544 (_i "Set the octave inside a \\relative section.")
1546 (make-music 'SequentialMusic
1547 'to-relative-callback
1548 (lambda (music last-pitch) pitch)))
1551 #(define-music-function (music)
1553 (_i "Return @var{music} in reverse order.")
1554 (retrograde-music music))
1556 revertTimeSignatureSettings =
1557 #(define-music-function
1561 (_i "Revert @code{timeSignatureSettings}
1562 for time signatures of @var{time-signature}.")
1563 (revert-time-signature-setting time-signature))
1566 #(define-event-function (finger) (number-or-markup?)
1567 (_i "Apply @var{finger} as a fingering indication.")
1571 (if (number? finger) 'digit 'text)
1575 #(define-music-function (fraction music)
1576 (fraction? ly:music?)
1577 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1578 (ly:music-compress music
1579 (ly:make-moment (car fraction) (cdr fraction))))
1582 #(define-scheme-function (ctx music)
1583 ((symbol?) ly:music?)
1584 (_i "Take the layout instruction events from @var{music}, optionally
1585 restricted to those applying to context type @var{ctx}, and return
1586 a context modification duplicating their effect.")
1587 (let ((mods (ly:make-context-mod)))
1589 (if (music-is-of-type? m 'layout-instruction-event)
1592 (case (ly:music-property m 'name)
1595 (ly:music-property m 'symbol)
1596 (ly:music-property m 'value)))
1599 (ly:music-property m 'symbol)))
1602 (ly:music-property m 'symbol)
1603 (ly:music-property m 'grob-value)
1605 ((ly:music-property m 'grob-property #f) => list)
1607 (ly:music-property m 'grob-property-path)))))
1610 (ly:music-property m 'symbol)
1612 ((ly:music-property m 'grob-property #f) => list)
1614 (ly:music-property m 'grob-property-path)))))))
1615 (case (ly:music-property m 'name)
1617 (ly:add-context-mod mods
1619 (ly:music-property m 'procedure))))
1620 ((ContextSpeccedMusic)
1622 (eq? ctx (ly:music-property m 'context-type)))
1623 (musicop (ly:music-property m 'element))))
1625 (let ((callback (ly:music-property m 'elements-callback)))
1626 (if (procedure? callback)
1627 (for-each musicop (callback m))))))))
1632 #(define-music-function (offsets item)
1633 (list? symbol-list-or-music?)
1634 (_i "Offset control-points of @var{item} by @var{offsets}. The
1635 argument is a list of number pairs or list of such lists. Each
1636 element of a pair represents an offset to one of the coordinates of a
1637 control-point. If @var{item} is a string, the result is
1638 @code{\\once\\override} for the specified grob type. If @var{item} is
1639 a music expression, the result is the same music expression with an
1640 appropriate tweak applied.")
1641 (define (shape-curve grob coords)
1642 (let* ((orig (ly:grob-original grob))
1643 (siblings (if (ly:spanner? grob)
1644 (ly:spanner-broken-into orig) '()))
1645 (total-found (length siblings)))
1646 (define (offset-control-points offsets)
1650 (lambda (x y) (coord-translate x y))
1653 (define (helper sibs offs)
1655 (if (eq? (car sibs) grob)
1656 (offset-control-points (car offs))
1657 (helper (cdr sibs) (cdr offs)))
1660 ;; we work with lists of lists
1661 (if (or (null? offsets)
1662 (not (list? (car offsets))))
1663 (set! offsets (list offsets)))
1665 (if (>= total-found 2)
1666 (helper siblings offsets)
1667 (offset-control-points (car offsets)))))
1668 (once (propertyTweak 'control-points
1669 (grob-transformer 'control-points shape-curve)
1673 #(define-music-function (dur dots arg)
1674 (integer? integer? ly:music?)
1675 (_i "Change the duration of @var{arg} by adding @var{dur} to the
1676 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1678 (shift-duration-log arg dur dots))
1681 #(define-music-function (overrides music)
1682 (ly:music? ly:music?)
1683 (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1684 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1685 (set! (ly:music-property music 'tweaks)
1687 (lambda (m) (eq? (ly:music-property m 'name)
1691 ((ly:music-property m 'grob-property #f) => list)
1693 (ly:music-property m 'grob-property-path)))))
1694 (acons (cons (ly:music-property m 'symbol) ;grob name
1696 p ;grob property path
1697 (car p))) ;grob property
1698 (ly:music-property m 'grob-value)
1700 (ly:music-property music 'tweaks)
1705 #(define-music-function (dur) (ly:duration?)
1706 (_i "Skip forward by @var{dur}.")
1707 (make-music 'SkipMusic
1712 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1713 (_i "Create slashed graces (slashes through stems, but no slur) from
1714 the following music expression"))
1717 #(define-music-function (parameters) (list?)
1718 (_i "Set the system stretch, by reading the 'system-stretch property of
1719 the `parameters' assoc list.")
1721 '(Score NonMusicalPaperColumn line-break-system-details)
1722 (list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1723 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))))
1726 #(define-music-function (style heads music)
1727 (symbol? symbol-list-or-symbol? ly:music?)
1728 (_i "Set @var{heads} in @var{music} to @var{style}.")
1729 (style-note-heads heads style music))
1732 #(define-music-function (tags music) (symbol-list-or-symbol? ly:music?)
1733 (_i "Tag the following @var{music} with @var{tags} and return the
1734 result, by adding the single symbol or symbol list @var{tags} to the
1735 @code{tags} property of @var{music}.")
1738 (ly:music-property music 'tags)
1739 ((if (symbol? tags) cons append)
1741 (ly:music-property music 'tags)))
1745 #(define-void-function (tags) (symbol-list?)
1746 (_i "Define a tag group comprising the symbols in the symbol list
1747 @var{tags}. Tag groups must not overlap.")
1748 (let ((err (define-tag-group tags)))
1749 (if err (ly:parser-error err (*location*)))))
1752 #(define-music-function (music)
1754 (_i "Make any @code{\\override} in @var{music} replace an existing
1755 grob property value only temporarily, restoring the old value when a
1756 corresponding @code{\\revert} is executed. This is achieved by
1757 clearing the @samp{pop-first} property normally set on
1760 An @code{\\override}/@/@code{\\revert} sequence created by using
1761 @code{\\temporary} and @code{\\undo} on the same music containing
1762 overrides will cancel out perfectly or cause a@tie{}warning.
1764 Non-property-related music is ignored, warnings are generated for any
1765 property-changing music that isn't an @code{\\override}.")
1769 (and (or (music-is-of-type? m 'layout-instruction-event)
1770 (music-is-of-type? m 'context-specification)
1771 (music-is-of-type? m 'apply-context)
1772 (music-is-of-type? m 'time-signature-music))
1773 (case (ly:music-property m 'name)
1775 (if (ly:music-property m 'pop-first #f)
1776 (set! (ly:music-property m 'pop-first) '()))
1777 (if (ly:music-property m 'once #f)
1778 (set! (ly:music-property m 'once) '()))
1780 ((ContextSpeccedMusic)
1785 (ly:input-warning (*location*) (_ "Cannot make ~a revertible")
1786 (ly:music-property m 'name))
1793 #(define-music-function (beat-structure fraction)
1794 ((number-list? '()) fraction?)
1795 (_i "Set @var{fraction} as time signature, with optional
1796 number list @var{beat-structure} before it.")
1797 (make-music 'TimeSignatureMusic
1798 'numerator (car fraction)
1799 'denominator (cdr fraction)
1800 'beat-structure beat-structure))
1803 #(define-music-function (fraction music)
1804 (fraction? ly:music?)
1805 (_i "Scale @var{music} in time by @var{fraction}.")
1806 (make-music 'TimeScaledMusic
1807 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1808 'numerator (car fraction)
1809 'denominator (cdr fraction)))
1812 #(define-music-function
1814 (ly:pitch? ly:pitch? ly:music?)
1816 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1817 (make-music 'TransposedMusic
1818 'element (ly:music-transpose music (ly:pitch-diff to from))))
1820 transposedCueDuring =
1821 #(define-music-function
1822 (what dir pitch main-music)
1823 (string? ly:dir? ly:pitch? ly:music?)
1825 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1826 using the transposition defined by @var{pitch}. This happens
1827 simultaneously with @var{main-music}, which is usually a rest. The
1828 argument @var{dir} determines whether the cue notes should be notated
1829 as a first or second voice.")
1831 (make-music 'QuoteMusic
1833 'quoted-context-type 'CueVoice
1834 'quoted-context-id "cue"
1835 'quoted-music-name what
1836 'quoted-voice-direction dir
1837 ;; following is inverse of instrumentTransposition for
1838 ;; historical reasons
1839 'quoted-transposition pitch))
1842 #(define-music-function (pitch) (ly:pitch?)
1843 (_i "Set instrument transposition")
1846 (make-property-set 'instrumentTransposition pitch)
1850 #(define-music-function (ratio tuplet-span music)
1851 (fraction? (ly:duration? '()) ly:music?)
1852 (_i "Scale the given @var{music} to tuplets. @var{ratio} is a
1853 fraction that specifies how many notes are played in place of the
1854 nominal value: it will be @samp{3/2} for triplets, namely three notes
1855 being played in place of two. If the optional duration
1856 @var{tuplet-span} is specified, it is used instead of
1857 @code{tupletSpannerDuration} for grouping the tuplets.
1860 \\tuplet 3/2 4 @{ c8 c c c c c @}
1862 will result in two groups of three tuplets, each group lasting for a
1864 (make-music 'TimeScaledMusic
1865 'element (ly:music-compress
1867 (ly:make-moment (cdr ratio) (car ratio)))
1868 'numerator (cdr ratio)
1869 'denominator (car ratio)
1870 'duration tuplet-span))
1873 #(define-music-function (tuplet-span)
1875 (_i "Set @code{tupletSpannerDuration}, the length into which
1876 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1877 own will group its tuplets, to the duration @var{tuplet-span}. To
1878 revert to the default of not subdividing the contents of a @code{\\tuplet}
1879 command without explicit @samp{tuplet-span}, use
1881 \\tupletSpan \\default
1885 #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1886 #{ \unset tupletSpannerDuration #}))
1889 #(define-music-function (prop value music)
1890 (symbol-list-or-symbol? scheme? ly:music?)
1891 (_i "Add a tweak to the following @var{music}.
1892 Layout objects created by @var{music} get their property @var{prop}
1893 set to @var{value}. If @var{prop} has the form @samp{Grob.property}, like with
1895 \\tweak Accidental.color #red cis'
1897 an indirectly created grob (@samp{Accidental} is caused by
1898 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1901 @var{prop} can contain additional elements in which case a nested
1902 property (inside of an alist) is tweaked.")
1903 (let ((p (check-grob-path prop (*location*)
1908 ;; p now contains at least two elements. The first
1909 ;; element is #t when no grob has been explicitly
1910 ;; specified, otherwise it is a grob name.
1912 (set! (ly:music-property music 'tweaks)
1913 (acons (cond ((pair? (cddr p)) p)
1915 (cons (car p) (cadr p)))
1918 (ly:music-property music 'tweaks)))))
1923 #(define-music-function (music)
1925 (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1926 @code{\\revert} and @code{\\unset}, respectively. Any reverts and
1927 unsets already in @var{music} cause a warning. Non-property-related music is ignored.")
1934 (music-type-predicate '(layout-instruction-event
1935 context-specification
1937 time-signature-music))
1938 (lambda (m overrides)
1939 (case (ly:music-property m 'name)
1942 (make-music 'RevertProperty
1943 'symbol (ly:music-property m 'symbol)
1946 ((ly:music-property m 'grob-property #f) => list)
1948 (ly:music-property m 'grob-property-path))))
1952 (make-music 'PropertyUnset
1953 'symbol (ly:music-property m 'symbol))
1955 ((ContextSpeccedMusic)
1957 (make-music 'ContextSpeccedMusic
1958 'element (loop (ly:music-property m 'element))
1959 'context-type (ly:music-property m 'context-type))
1964 (ly:input-warning (*location*) (_ "Cannot revert ~a")
1965 (ly:music-property m 'name))
1971 ((null? lst) (make-music 'Music))
1972 ((null? (cdr lst)) (car lst))
1973 (else (make-sequential-music lst))))))
1976 #(define-music-function (music) (ly:music?)
1977 (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1978 @code{\\repeat percent} commands in @var{music} to be interpreted
1979 as @code{\\repeat unfold}.")
1980 (unfold-repeats music))
1983 #(define-void-function (arg) (scheme?)
1984 (_i "Accept a scheme argument, return a void expression.
1985 Use this if you want to have a scheme expression evaluated
1986 because of its side-effects, but its value ignored."))
1989 #(define-music-function (sym val music)
1990 (symbol? scheme? ly:music?)
1991 (_i "Set @var{sym} to @var{val} in @var{music}.")
1993 (set! (ly:music-property music sym) val)