1 %%%% -*- Mode: Scheme -*-
3 %%%% This file is part of LilyPond, the GNU music typesetter.
5 %%%% Copyright (C) 2003--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 %%%% Jan Nieuwenhuizen <janneke@gnu.org>
8 %%%% LilyPond is free software: you can redistribute it and/or modify
9 %%%% it under the terms of the GNU General Public License as published by
10 %%%% the Free Software Foundation, either version 3 of the License, or
11 %%%% (at your option) any later version.
13 %%%% LilyPond is distributed in the hope that it will be useful,
14 %%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
15 %%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 %%%% GNU General Public License for more details.
18 %%%% You should have received a copy of the GNU General Public License
19 %%%% along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
24 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25 %% this file is alphabetically sorted.
26 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28 %% need SRFI-1 for filter; optargs for lambda*
29 #(use-modules (srfi srfi-1)
32 %% TODO: using define-music-function in a .scm causes crash.
35 #(define-music-function (music)
37 (_i "Make @var{music} absolute. This does not actually change the
38 music itself but rather hides it from surrounding @code{\\relative}
39 and @code{\\fixed} commands.")
40 (make-music 'RelativeOctaveMusic 'element music))
43 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
44 (_i "Create an acciaccatura from the following music expression"))
46 %% keep these two together
47 instrument-definitions = #'()
48 addInstrumentDefinition =
49 #(define-void-function
50 (name lst) (string? list?)
51 (_i "Create instrument @var{name} with properties @var{list}.")
52 (set! instrument-definitions (acons name lst instrument-definitions)))
55 #(define-void-function (name music) (string? ly:music?)
56 (_i "Define @var{music} as a quotable music expression named
58 (add-quotable name music))
60 %% keep these two together
61 afterGraceFraction = #(cons 6 8)
63 #(define-music-function (main grace) (ly:music? ly:music?)
64 (_i "Create @var{grace} note(s) after a @var{main} music expression.")
65 (let ((main-length (ly:music-length main))
66 (fraction (ly:parser-lookup 'afterGraceFraction)))
67 (make-simultaneous-music
70 (make-sequential-music
73 (make-music 'SkipMusic
74 'duration (ly:make-duration
76 (* (ly:moment-main-numerator main-length)
78 (* (ly:moment-main-denominator main-length)
80 (make-music 'GraceMusic
84 %% music identifiers not allowed at top-level,
85 %% so this is a music-function instead.
87 #(define-music-function () ()
88 (_i "Allow a page turn. May be used at toplevel (ie between scores or
89 markups), or inside a score.")
90 (make-music 'EventChord
92 'page-turn-permission 'allow
93 'elements (list (make-music 'PageTurnEvent
94 'break-permission 'allow))))
97 #(define-music-function (property arg item)
98 (symbol-list-or-symbol? list? symbol-list-or-music?)
99 (_i "Override @var{property} for pieces of broken spanner @var{item}
100 with values @var{arg}. @var{item} may either be music in the form of
101 a starting spanner event, or a symbol list in the form
102 @samp{Context.Grob} or just @samp{Grob}. Iff @var{item} is in the
103 form of a spanner event, @var{property} may also have the form
104 @samp{Grob.property} for specifying a directed tweak.")
106 (if (eq? (ly:music-property item 'span-direction) START)
107 (tweak property (value-for-spanner-piece arg) item)
109 (ly:music-warning item (_ "not a spanner"))
111 (let* ((p (check-grob-path item (*location*)
115 (name (and p (second p)))
117 (and name (assoc-get name all-grob-descriptions))))
119 (member 'spanner-interface
120 (assoc-get 'interfaces
121 (assoc-get 'meta description))))
122 (propertyOverride (append item (if (symbol? property)
125 (value-for-spanner-piece arg))
127 (ly:input-warning (*location*) (_ "not a spanner name, `~a'") name)
128 (make-music 'Music))))))
131 #(define-music-function (tag more music)
132 (symbol? ly:music? ly:music?)
133 (_i "Append @var{more} to the @code{elements} of all music
134 expressions in @var{music} that are tagged with @var{tag}.")
135 (music-map (lambda (m)
136 (if (memq tag (ly:music-property m 'tags))
137 (set! (ly:music-property m 'elements)
138 (append (ly:music-property m 'elements)
144 #(define-music-function (proc) (procedure?)
145 (_i "Modify context properties with Scheme procedure @var{proc}.")
146 (make-music 'ApplyContext
150 #(define-music-function (func music) (procedure? ly:music?)
151 (_i"Apply procedure @var{func} to @var{music}.")
155 #(define-music-function (ctx proc) (symbol? procedure?)
156 (_i "Apply function @code{proc} to every layout object in context @code{ctx}")
157 (make-music 'ApplyOutputEvent
162 #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic
163 (_i "Create an appoggiatura from @var{music}"))
165 % for regression testing purposes.
167 #(define-music-function (l r) (pair? pair?)
168 (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct")
169 (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r)))
171 % for regression testing purposes.
173 #(define-music-function (comp) (procedure?)
174 (_i "Testing function: check whether the slope of the beam is the same as @code{comp}")
175 (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp)))
178 #(define-music-function (music) (ly:music?)
179 (_i "Make voices that switch between staves automatically")
180 (let ;; keep the contexts alive for the full duration
181 ((skip (make-skip-music (make-duration-of-length
182 (ly:music-length music)))))
185 \context Staff = "up" <<
186 #(make-autochange-music music)
189 \context Staff = "down" \with {
190 clefGlyph = "clefs.F"
193 middleCClefPosition = 6
201 #(define-music-function (grob-name offset text)
202 (symbol? number-pair? markup?)
203 (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
204 (use like @code{\\once})")
207 (make-music 'AnnotateOutputEvent
209 'X-offset (car offset)
210 'Y-offset (cdr offset)
214 #(define-event-function (offset text) (number-pair? markup?)
215 (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
216 (make-music 'AnnotateOutputEvent
217 'X-offset (car offset)
218 'Y-offset (cdr offset)
222 #(define-music-function (type) (string?)
223 (_i "Insert a bar line of type @var{type}")
225 (make-property-set 'whichBar type)
229 #(define-music-function (n) (integer?)
230 (_i "Print a warning if the current bar number is not @var{n}.")
231 (make-music 'ApplyContext
234 (let ((cbn (ly:context-property c 'currentBarNumber)))
235 (if (and (number? cbn) (not (= cbn n)))
236 (ly:input-warning (*location*)
237 "Barcheck failed got ~a expect ~a"
241 #(define-scheme-function (music) (ly:music?)
242 (_i "Extract a value suitable for setting
243 @code{Timing.beamExceptions} from the given pattern with explicit
244 beams in @var{music}. A bar check @code{|} has to be used between
245 bars of patterns in order to reset the timing.")
246 (extract-beam-exceptions music))
249 #(define-event-function (delta) (real?)
250 (_i "Create a fall or doit of pitch interval @var{delta}.")
251 (make-music 'BendAfterEvent
255 #(define-void-function (newfilename) (string?)
256 (_i "Direct output for the current book block to @var{newfilename}.")
257 (set! (paper-variable #f 'output-filename) newfilename))
260 #(define-void-function (newsuffix) (string?)
261 (_i "Set the output filename suffix for the current book block to
263 (set! (paper-variable #f 'output-suffix) newsuffix))
265 %% \breathe is defined as a music function rather than an event identifier to
266 %% ensure it gets useful input location information: as an event identifier,
267 %% it would have to be wrapped in an EventChord to prevent it from being
268 %% treated as a post_event by the parser
270 #(define-music-function () ()
271 (_i "Insert a breath mark.")
272 (make-music 'BreathingEvent))
275 #(define-music-function (type) (string?)
276 (_i "Set the current clef to @var{type}.")
277 (make-clef-set type))
281 #(define-music-function (args) (pair?)
282 (_i "Create compound time signatures. The argument is a Scheme list of
283 lists. Each list describes one fraction, with the last entry being the
284 denominator, while the first entries describe the summands in the
285 enumerator. If the time signature consists of just one fraction,
286 the list can be given directly, i.e. not as a list containing a single list.
287 For example, a time signature of (3+1)/8 + 2/4 would be created as
288 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
289 as @code{\\compoundMeter #'((3 2 8))} or shorter
290 @code{\\compoundMeter #'(3 2 8)}.")
291 (let* ((mlen (calculate-compound-measure-length args))
292 (beat (calculate-compound-base-beat args))
293 (beatGrouping (calculate-compound-beat-grouping args))
294 (timesig (cons (ly:moment-main-numerator mlen)
295 (ly:moment-main-denominator mlen))))
297 \once \override Timing.TimeSignature.stencil = #(lambda (grob)
298 (grob-interpret-markup grob (make-compound-meter-markup args)))
299 \set Timing.timeSignatureFraction = #timesig
300 \set Timing.baseMoment = #beat
301 \set Timing.beatStructure = #beatGrouping
302 \set Timing.beamExceptions = #'()
303 \set Timing.measureLength = #mlen
307 #(define-music-function (music) (ly:music?)
308 (_i "Remove the empty bars created by multi-measure rests,
309 leaving just the first bar containing the MM rest itself.")
312 (if (eq? 'MultiMeasureRestMusic (ly:music-property m 'name))
313 #{ \once \set Score.skipBars = ##t #m #}
318 #(define-music-function (notes) (ly:music?)
319 (_i "Create cross-staff stems")
321 \temporary \override Stem.cross-staff = #cross-staff-connect
322 \temporary \override Flag.style = #'no-flag
324 \revert Stem.cross-staff
329 #(define-music-function (type) (string?)
330 (_i "Set the current cue clef to @var{type}.")
331 (make-cue-clef-set type))
334 #(define-music-function () ()
335 (_i "Unset the current cue clef.")
336 (make-cue-clef-unset))
339 #(define-music-function
340 (what dir main-music) (string? ly:dir? ly:music?)
341 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
342 in a CueVoice oriented by @var{dir}.")
343 (make-music 'QuoteMusic
345 'quoted-context-type 'CueVoice
346 'quoted-context-id "cue"
347 'quoted-music-name what
348 'quoted-voice-direction dir))
351 #(define-music-function
352 (what dir clef main-music) (string? ly:dir? string? ly:music?)
353 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
354 in a CueVoice oriented by @var{dir}.")
355 (make-music 'QuoteMusic
357 'quoted-context-type 'CueVoice
358 'quoted-context-id "cue"
359 'quoted-music-name what
360 'quoted-music-clef clef
361 'quoted-voice-direction dir))
366 #(define-music-function (port music) ((output-port?) ly:music?)
367 (_i "Display the LilyPond input representation of @var{music}
368 to @var{port}, defaulting to the console.")
369 (let ((port (or port (current-output-port))))
371 (display-lily-music music port))
375 #(define-music-function (port music) ((output-port?) ly:music?)
376 (_i "Display the internal representation of @var{music} to
377 @var{port}, default to the console.")
378 (let ((port (or port (current-output-port))))
380 (display-scheme-music music port))
384 #(define-scheme-function (port expr) ((output-port?) scheme?)
385 (_i "Display the internal representation of @var{expr} to
386 @var{port}, default to the console.")
387 (let ((port (or port (current-output-port))))
389 (display-scheme-music expr port))
395 #(define-music-function (music) (ly:music?)
396 (_i "Terminate the next spanner prematurely after exactly one note
397 without the need of a specific end spanner.")
398 (let* ((start-span-evs (filter (lambda (ev)
399 (equal? (ly:music-property ev 'span-direction)
401 (extract-typed-music music 'span-event)))
404 (music-clone m 'span-direction STOP))
406 (end-ev-chord (make-music 'EventChord
407 'elements stop-span-evs))
408 (total (make-music 'SequentialMusic
409 'elements (list music
414 #(define-music-function (music) (ly:music?)
415 (_i "Compatibility function wrapping @code{EventChord} around
416 isolated rhythmic events occuring since version 2.15.28, after
417 expanding repeat chords @samp{q}.")
418 (event-chord-wrap! music))
421 #(define-music-function (factor argument) (ly:moment? ly:music?)
422 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
423 (let ((orig-duration (ly:music-length argument))
424 (multiplier (ly:make-moment 1 1)))
428 (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
430 (ly:music-compress mus multiplier)
431 (set! multiplier (ly:moment-mul factor multiplier)))))
432 (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
435 (ly:moment-div orig-duration (ly:music-length argument)))
440 #(define-event-function (finger) (number-or-markup?)
441 (_i "Apply @var{finger} as a fingering indication.")
445 (if (number? finger) 'digit 'text)
449 #(define-music-function (pitch music)
450 (ly:pitch? ly:music?)
451 (_i "Use the octave of @var{pitch} as the default octave for @var{music}.")
452 (let ((octave-marks (1+ (ly:pitch-octave pitch))))
453 (cond ((not (= 0 octave-marks))
454 (ly:music-transpose music (ly:make-pitch octave-marks 0 0))
455 ;;In order to leave unchanged the notes in any enclosed
456 ;; \absolute or \fixed or \relative, make a cancelling shift
458 (ly:music-transpose m (ly:make-pitch (- octave-marks) 0 0)))
459 (extract-named-music music 'RelativeOctaveMusic)))))
460 (make-music 'RelativeOctaveMusic 'element music))
463 #(define-music-function (mark offset footnote item)
464 ((markup?) number-pair? markup? symbol-list-or-music?)
465 (_i "Make the markup @var{footnote} a footnote on @var{item}. The
466 footnote is marked with a markup @var{mark} moved by @var{offset} with
467 respect to the marked music.
469 If @var{mark} is not given or specified as @var{\\default}, it is
470 replaced by an automatically generated sequence number. If @var{item}
471 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
472 grobs of that type will be marked at the current time step in the
473 given context (default @code{Bottom}).
475 If @var{item} is music, the music will get a footnote attached to a
476 grob immediately attached to the event, like @var{\\tweak} does. For
477 attaching a footnote to an @emph{indirectly} caused grob, write
478 @code{\\single\\footnote}, use @var{item} to specify the grob, and
479 follow it with the music to annotate.
481 Like with @code{\\tweak}, if you use a footnote on a following
482 post-event, the @code{\\footnote} command itself needs to be attached
483 to the preceding note or rest as a post-event with @code{-}.")
484 (let ((mus (make-music
486 'X-offset (car offset)
487 'Y-offset (cdr offset)
488 'automatically-numbered (not mark)
489 'text (or mark (make-null-markup))
490 'footnote-text footnote)))
491 (once (tweak 'footnote-music mus item))))
494 #(def-grace-function startGraceMusic stopGraceMusic
495 (_i "Insert @var{music} as grace notes."))
498 #(define-scheme-function (descriptions) (list?)
499 (_i "Create a context modification from @var{descriptions}, a list
500 in the format of @code{all-grob-descriptions}.")
503 (list 'assign (car p) (ly:make-grob-properties (cdr p))))
506 harmonicByFret = #(define-music-function (fret music) (number? ly:music?)
507 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
508 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
510 \set harmonicDots = ##t
511 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
512 \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
513 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
514 (ly:note-head::print grob))
516 (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
518 \revert TabNoteHead.stencil
519 \revert NoteHead.Y-extent
520 \revert NoteHead.stencil
523 harmonicByRatio = #(define-music-function (ratio music) (number? ly:music?)
524 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
525 harmonics played on a fretted instrument by touching the strings at the point
526 given through @var{ratio}.")
528 \set harmonicDots = ##t
529 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
530 \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height)
531 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
532 (ly:note-head::print grob))
534 (calc-harmonic-pitch (ratio->pitch ratio) music))
536 \revert TabNoteHead.stencil
537 \revert NoteHead.Y-extent
538 \revert NoteHead.stencil
542 #(define-music-function (item) (symbol-list-or-music?)
543 (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
544 making it invisible while still retaining its dimensions.
546 If @var{item} is a symbol list of form @code{GrobName} or
547 @code{Context.GrobName}, the result is an override for the grob name
548 specified by it. If @var{item} is a music expression, the result is
549 the same music expression with an appropriate tweak applied to it.")
550 (tweak 'transparent #t item))
553 #(define-music-function () ()
554 (_i "Put the segno variant 'varsegno' at this position into the staff,
555 compatible with the repeat command.")
556 (make-music 'ApplyContext
559 (let ((score-ctx (ly:context-find ctx 'Score)))
560 (if (ly:context? score-ctx)
561 (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
562 (if (eq? (memq 'segno-display old-rc) #f)
563 (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
566 #(define-music-function
568 (_i "Switch instrument to @var{name}, which must be predefined with
569 @code{\\addInstrumentDefinition}.")
570 (let* ((handle (assoc name instrument-definitions))
571 (instrument-def (if handle (cdr handle) '())))
574 (ly:input-warning (*location*) "No such instrument: ~a" name))
576 (make-music 'SimultaneousMusic
588 #(define-music-function (tags music)
589 (symbol-list-or-symbol? ly:music?)
590 (_i "Include only elements of @var{music} that are tagged with one
591 of the tags in @var{tags}. @var{tags} may be either a single symbol
592 or a list of symbols.
594 Each tag may be declared as a member of at most one tag group (defined
595 with @code{\\tagGroup}). If none of a @var{music} element's tags
596 share a tag group with one of the specified @var{tags}, the element is
599 (tags-keep-predicate tags)
603 #(define-music-function (tonic pitch-alist)
604 ((ly:pitch? '()) (list? '()))
605 (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
606 If both are null, just generate @code{KeyChangeEvent}.")
607 (cond ((null? tonic) (make-music 'KeyChangeEvent))
609 (ly:parser-error (_ "second argument must be pitch list")
611 (make-music 'SequentialMusic 'void #t))
614 (make-music 'KeyChangeEvent
615 'tonic (ly:make-pitch 0 0 0)
616 'pitch-alist pitch-alist)
620 #(define-music-function (music) (ly:music?)
621 (_i "Remove cue notes from @var{music}.")
624 (if (and (string? (ly:music-property mus 'quoted-music-name))
625 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
626 (ly:music-property mus 'element)
633 #(define-music-function (label) (symbol?)
634 (_i "Create @var{label} as a bookmarking label.")
635 (make-music 'EventChord
638 'elements (list (make-music 'LabelEvent
639 'page-label label))))
643 #(define-void-function (language) (string?)
644 (_i "Set note names for language @var{language}.")
645 (note-names-language language))
647 languageSaveAndChange =
648 #(define-void-function (language) (string?)
649 (_i "Store the previous pitchnames alist, and set a new one.")
650 (set! previous-pitchnames pitchnames)
651 (note-names-language language))
654 #(define-void-function () ()
655 (_i "Restore a previously-saved pitchnames alist.")
656 (if previous-pitchnames
658 (set! pitchnames previous-pitchnames)
659 (ly:parser-set-note-names pitchnames))
660 (ly:input-warning (*location*) (_ "No other language was defined previously. Ignoring."))))
664 #(define-music-function (mag music) (positive? ly:music?)
665 (_i "Magnify the notation of @var{music} without changing the
666 staff-size, using @var{mag} as a size factor. Stems, beams,
667 slurs, ties, and horizontal spacing are adjusted automatically.")
669 ;; these props are NOT allowed to shrink below default size
670 (define unshrinkable-props
676 (Slur line-thickness)
678 (PhrasingSlur line-thickness)
679 (PhrasingSlur thickness)
684 (LaissezVibrerTie line-thickness)
685 (LaissezVibrerTie thickness)
686 (RepeatTie line-thickness)
687 (RepeatTie thickness)
690 ;; these props ARE allowed to shrink below default size
691 (define shrinkable-props
692 (let ((baseline-skip-props
693 (find-named-props 'baseline-skip all-grob-descriptions))
695 (find-named-props 'word-space all-grob-descriptions)))
700 ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed
701 ;; override at the 'Score level
702 ;(SpacingSpanner spacing-increment)
704 ;; lengths and heights
705 (Beam length-fraction)
706 (Stem length-fraction)
707 (Stem beamlet-default-length)
708 (Stem double-stem-separation)
710 (Slur minimum-length)
711 (PhrasingSlur height-limit)
712 (PhrasingSlur minimum-length)
714 ;; Beam.beam-thickness is dealt with separately below
718 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
720 #(scale-fontSize 'magnifyMusic mag)
721 #(scale-props 'magnifyMusic mag #f unshrinkable-props)
722 #(scale-props 'magnifyMusic mag #t shrinkable-props)
723 #(scale-beam-thickness mag)
727 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
729 %% reverse engineer the former fontSize value instead of using \unset
730 #(revert-fontSize 'magnifyMusic mag)
731 #(revert-props 'magnifyMusic mag (append unshrinkable-props
733 '((Beam beam-thickness))))
738 #(define-music-function (mag) (positive?)
739 (_i "Change the size of the staff, adjusting notation size and
740 horizontal spacing automatically, using @var{mag} as a size factor.")
742 ;; these props are NOT allowed to shrink below default size
743 (define unshrinkable-props
744 '((StaffSymbol thickness)))
746 ;; these props ARE allowed to shrink below default size
747 (define shrinkable-props
748 (let* ((baseline-skip-props
749 (find-named-props 'baseline-skip all-grob-descriptions))
751 (find-named-props 'word-space all-grob-descriptions))
753 (find-named-props 'space-alist all-grob-descriptions)))
759 ;; override at the 'Score level
760 (SpacingSpanner spacing-increment)
762 (StaffSymbol staff-space)
765 (BarLine hair-thickness)
766 (BarLine thick-thickness)
767 (Stem beamlet-default-length)
768 (Stem double-stem-separation)
774 %% revert settings from last time
775 %% (but only if \magnifyStaff has already been used
776 %% and the staff magnification is changing)
777 #(revert-fontSize 'magnifyStaff mag)
778 #(revert-props 'magnifyStaff mag (append unshrinkable-props
782 %% (but only if staff magnification is changing
783 %% and does not equal 1)
784 #(scale-fontSize 'magnifyStaff mag)
785 #(scale-props 'magnifyStaff mag #f unshrinkable-props)
786 #(scale-props 'magnifyStaff mag #t shrinkable-props)
788 %% this might cause problems until Issue 3990 is fixed
792 \set Staff.magnifyStaffValue = #mag
796 #(define-music-function (arg) (ly:music?)
797 (_i "Display chords in @var{arg} as clusters.")
798 (music-map note-to-cluster arg))
801 #(define-music-function (around to scale music)
802 (ly:pitch? ly:pitch? ly:music? ly:music?)
803 (_i "Invert @var{music} about @var{around} using @var{scale} and
804 transpose from @var{around} to @var{to}.")
805 (let ((inverter (make-modal-inverter around to scale)))
806 (change-pitches music inverter)
810 #(define-music-function (from to scale music)
811 (ly:pitch? ly:pitch? ly:music? ly:music?)
812 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
814 (let ((transposer (make-modal-transposer from to scale)))
815 (change-pitches music transposer)
819 #(define-music-function
820 (around to music) (ly:pitch? ly:pitch? ly:music?)
821 (_i "Invert @var{music} about @var{around} and
822 transpose from @var{around} to @var{to}.")
823 (music-invert around to music))
826 #(define-music-function
827 (label) ((number-or-markup?))
828 "Make the music for the \\mark command."
829 (let* ((set (and (integer? label)
830 (context-spec-music (make-property-set 'rehearsalMark label)
832 (ev (make-music 'MarkEvent
833 'origin (*location*))))
836 (make-sequential-music (list set ev))
838 (if label (set! (ly:music-property ev 'label) label))
842 #(define-music-function (proc mus) (procedure? ly:music?)
843 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
844 (music-map proc mus))
846 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
847 %% because music identifiers are not allowed at top-level.
849 #(define-music-function () ()
850 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
851 markups), or inside a score.")
852 (make-music 'EventChord
854 'page-break-permission 'forbid
855 'elements (list (make-music 'PageBreakEvent
856 'break-permission '()))))
859 #(define-music-function () ()
860 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
861 markups), or inside a score.")
862 (make-music 'EventChord
864 'page-turn-permission 'forbid
865 'elements (list (make-music 'PageTurnEvent
866 'break-permission '()))))
871 #(define-music-function (pitch) (ly:pitch?)
873 (make-music 'RelativeOctaveCheck
877 #(define-music-function (property offsets item)
878 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
879 (_i "Offset the default value of @var{property} of @var{item} by
880 @var{offsets}. If @var{item} is a string, the result is
881 @code{\\override} for the specified grob type. If @var{item} is
882 a music expression, the result is the same music expression with an
883 appropriate tweak applied.")
885 ; In case of a tweak, grob property path is Grob.property
886 (let ((prop-path (check-grob-path
887 (if (symbol? property)
889 property) (*location*)
890 #:start 1 #:default #t #:min 2 #:max 2)))
892 ; If the head of the grob property path is a symbol--i.e.,
893 ; a grob name, produce a directed tweak. Otherwise, create
895 (if (symbol? (car prop-path))
896 (tweak prop-path (offsetter (second prop-path) offsets) item)
897 (tweak (second prop-path)
898 (offsetter (second prop-path) offsets)
901 ; In case of an override, grob property path is Context.Grob.property.
902 (let ((prop-path (check-grob-path
904 (if (symbol? property)
906 property)) (*location*)
907 #:default 'Bottom #:min 3 #:max 3)))
909 (propertyOverride prop-path (offsetter (third prop-path) offsets))
910 (make-music 'Music)))))
913 #(define-music-function (item) (symbol-list-or-music?)
914 (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
915 effectively omitting it without taking up space.
917 If @var{item} is a symbol list of form @code{GrobName} or
918 @code{Context.GrobName}, the result is an override for the grob name
919 specified by it. If @var{item} is a music expression, the result is
920 the same music expression with an appropriate tweak applied to it.")
921 (tweak 'stencil #f item))
924 #(define-music-function (music) (ly:music?)
925 (_i "Set @code{once} to @code{#t} on all layout instruction events
926 in @var{music}. This will complain about music with an actual
927 duration. As a special exception, if @var{music} contains
928 @samp{tweaks} it will be silently ignored in order to allow for
929 @code{\\once \\tweak} to work as both one-time override and proper
931 (if (not (pair? (ly:music-property music 'tweaks)))
934 (cond ((music-is-of-type? m 'layout-instruction-event)
935 (set! (ly:music-property m 'once) #t)
937 ((ly:duration? (ly:music-property m 'duration))
938 (ly:music-warning m (_ "Cannot apply \\once to timed music"))
945 #(define-music-function (octave) (integer?)
946 (_i "Set the octavation.")
947 (make-music 'OttavaMusic
948 'ottava-number octave))
950 overrideTimeSignatureSettings =
951 #(define-music-function
952 (time-signature base-moment beat-structure beam-exceptions)
953 (fraction? fraction? list? list?)
955 (_i "Override @code{timeSignatureSettings}
956 for time signatures of @var{time-signature} to have settings
957 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
959 ;; TODO -- add warning if largest value of grouping is
960 ;; greater than time-signature.
961 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
962 (override-time-signature-setting time-signature setting)))
965 #(define-music-function (grob-property-path value)
966 (symbol-list? scheme?)
968 (_i "Set the grob property specified by @var{grob-property-path} to
969 @var{value}. @var{grob-property-path} is a symbol list of the form
970 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
971 with subproperties given as well.
973 As opposed to @code{\\override} which overrides the context-dependent
974 defaults with which a grob is created, this command uses
975 @code{Output_property_engraver} at the grob acknowledge stage. This
976 may be necessary for overriding values set after the initial grob
978 (let ((p (check-grob-path grob-property-path (*location*)
982 (make-music 'ApplyOutputEvent
983 'context-type (first p)
985 (lambda (grob orig-context context)
987 (cdr (assoc 'name (ly:grob-property grob 'meta)))
989 (ly:grob-set-nested-property!
990 grob (cddr p) value))))
991 (make-music 'Music))))
998 %% pageBreak and pageTurn are music functions (iso music indentifiers),
999 %% because music identifiers are not allowed at top-level.
1001 #(define-music-function () ()
1002 (_i "Force a page break. May be used at toplevel (i.e., between scores or
1003 markups), or inside a score.")
1004 (make-music 'EventChord
1006 'line-break-permission 'force
1007 'page-break-permission 'force
1008 'elements (list (make-music 'LineBreakEvent
1009 'break-permission 'force)
1010 (make-music 'PageBreakEvent
1011 'break-permission 'force))))
1014 #(define-music-function () ()
1015 (_i "Force a page turn between two scores or top-level markups.")
1016 (make-music 'EventChord
1018 'line-break-permission 'force
1019 'page-break-permission 'force
1020 'page-turn-permission 'force
1021 'elements (list (make-music 'LineBreakEvent
1022 'break-permission 'force)
1023 (make-music 'PageBreakEvent
1024 'break-permission 'force)
1025 (make-music 'PageTurnEvent
1026 'break-permission 'force))))
1029 #(define-void-function (voice-ids music) (list? ly:music?)
1030 (_i "Define parallel music sequences, separated by '|' (bar check signs),
1031 and assign them to the identifiers provided in @var{voice-ids}.
1033 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
1035 @var{music}: a music sequence, containing BarChecks as limiting expressions.
1040 \\parallelMusic #'(A B C) {
1050 The last bar checks in a sequence are not copied to the result in
1051 order to facilitate ending the last entry at non-bar boundaries.
1053 (define voice-count (length voice-ids))
1054 (define (bar-check? m)
1055 "Checks whether m is a bar check."
1056 (eq? (ly:music-property m 'name) 'BarCheck))
1057 (define (recurse-and-split-list lst)
1058 "Return either a list of music lists split along barchecks, or @code{#f}."
1059 (if (any bar-check? lst)
1060 (let* ((voices (apply circular-list (make-list voice-count '())))
1061 (current-voices voices)
1062 (current-sequence '()))
1065 (define (push-music m)
1066 "Push the music expression into the current sequence"
1067 (set! current-sequence (cons m current-sequence)))
1068 (define (change-voice)
1069 "Store the previously built sequence into the current voice and
1070 change to the following voice."
1071 (set-car! current-voices
1072 (cons current-sequence
1073 (car current-voices)))
1074 (set! current-sequence '())
1075 (set! current-voices (cdr current-voices)))
1076 (for-each (lambda (m)
1077 (let ((split? (recurse-and-split m)))
1086 (if (bar-check? m) (change-voice))))))
1088 (if (pair? current-sequence) (change-voice))
1089 ;; Un-circularize voices
1090 (set! voices (list-head voices voice-count))
1092 ;; Remove trailing bar checks to facilitate ending a
1093 ;; sequence on a non-bar, reverse partial sequences and sequences
1098 (if (and (pair? l) (pair? (car l))
1099 (bar-check? (caar l)))
1100 (cons (cdar l) (cdr l))
1104 ;; check sequence length
1105 (apply for-each (lambda seqs
1106 (define (seq-len seq)
1107 (reduce ly:moment-add
1109 (map ly:music-length seq)))
1110 (let ((moment-reference (seq-len (car seqs))))
1111 (for-each (lambda (seq)
1112 (if (not (equal? (seq-len seq)
1118 (_ "Bars in parallel music don't have the same length"))))
1121 (map concatenate! voices))
1122 (let ((deeper (map recurse-and-split lst)))
1123 (and (any pair? deeper)
1127 (ly:music-deep-copy (make-list voice-count m))))
1129 (define (recurse-and-split music)
1130 "This returns either a list of music split along barchecks, or
1132 (let* ((elt (ly:music-property music 'element))
1133 (elts (ly:music-property music 'elements))
1134 (split-elt (and (ly:music? elt) (recurse-and-split elt)))
1135 (split-elts (and (pair? elts) (recurse-and-split-list elts))))
1136 (and (or split-elt split-elts)
1139 (let ((m (ly:music-deep-copy music
1140 ;;; reassigning the origin of the parent only
1141 ;;; makes sense if the first expression in the
1142 ;;; result is from a distributed origin
1143 (or (and (ly:music? e) e)
1144 (and (pair? es) (car es))))))
1146 (set! (ly:music-property m 'element) e))
1148 (set! (ly:music-property m 'elements) es))
1150 (or split-elt (circular-list #f))
1151 (or split-elts (circular-list #f))))))
1152 (let ((voices (recurse-and-split music)))
1155 ;; bind voice identifiers to the voices
1156 (for-each (lambda (voice-id voice)
1157 (ly:parser-define! voice-id voice))
1159 (ly:music-warning music
1160 (_ "ignoring parallel music without barchecks")))))
1163 #(define-music-function (arg) (ly:music?)
1164 (_i "Tag @var{arg} to be parenthesized.")
1166 (if (memq 'event-chord (ly:music-property arg 'types))
1167 ;; arg is an EventChord -> set the parenthesize property
1168 ;; on all child notes and rests
1171 (if (or (memq 'note-event (ly:music-property ev 'types))
1172 (memq 'rest-event (ly:music-property ev 'types)))
1173 (set! (ly:music-property ev 'parenthesize) #t)))
1174 (ly:music-property arg 'elements))
1175 ;; No chord, simply set property for this expression:
1176 (set! (ly:music-property arg 'parenthesize) #t))
1179 #(define (make-directed-part-combine-music direction chord-range part1 part2
1180 one-context-settings
1181 two-context-settings
1182 shared-context-settings)
1184 (let* ((pc-music (make-music 'PartCombineMusic))
1185 (m1 (context-spec-music (make-non-relative-music part1) 'Voice "one"))
1186 (m2 (context-spec-music (make-non-relative-music part2) 'Voice "two"))
1187 (listener (ly:parser-lookup 'partCombineListener))
1188 (evs2 (recording-group-emulate m2 listener))
1189 (evs1 (recording-group-emulate m1 listener))
1191 (if (and (assoc "one" evs1) (assoc "two" evs2))
1192 (determine-split-list (reverse! (assoc-get "one" evs1) '())
1193 (reverse! (assoc-get "two" evs2) '())
1196 (L1 (ly:music-length part1))
1197 (L2 (ly:music-length part2))
1198 ;; keep the contexts alive for the full duration
1199 (skip (make-skip-music (make-duration-of-length
1200 (if (ly:moment<? L1 L2) L2 L1)))))
1202 (set! (ly:music-property pc-music 'elements)
1204 'PartCombinePartMusic
1206 'context-change-list
1207 (make-part-combine-context-changes
1208 default-part-combine-context-change-state-machine-one
1211 'PartCombinePartMusic
1213 'context-change-list
1214 (make-part-combine-context-changes
1215 default-part-combine-context-change-state-machine-two
1218 (set! (ly:music-property pc-music 'direction) direction)
1220 #{ \context Staff <<
1221 \context Voice = "one" \with #one-context-settings { #skip }
1222 \context Voice = "two" \with #two-context-settings { #skip }
1223 \context Voice = "shared" \with #shared-context-settings { #skip }
1224 \context Voice = "solo" { #skip }
1225 \context NullVoice = "null" { #skip }
1227 #(make-part-combine-marks
1228 default-part-combine-mark-state-machine split-list)
1232 #(define-music-function (chord-range part1 part2)
1233 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1234 (_i "Take the music in @var{part1} and @var{part2} and return
1235 a music expression containing simultaneous voices, where @var{part1}
1236 and @var{part2} are combined into one voice where appropriate.
1237 Optional @var{chord-range} sets the distance in steps between notes
1238 that may be combined into a chord or unison.")
1239 (make-directed-part-combine-music #f chord-range part1 part2
1240 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1241 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1245 #(define-music-function (chord-range part1 part2)
1246 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1247 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1248 that they share a staff with stems directed upward.")
1249 (make-directed-part-combine-music UP chord-range part1 part2
1250 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1251 #{ \with { \voiceThree \override DynamicLineSpanner.direction = #UP } #}
1252 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} ))
1255 #(define-music-function (chord-range part1 part2)
1256 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1257 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1258 that they share a staff with stems directed downward.")
1259 (make-directed-part-combine-music DOWN chord-range part1 part2
1260 #{ \with { \voiceFour \override DynamicLineSpanner.direction = #DOWN } #}
1261 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1262 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} ))
1265 #(define-music-function (type once) (boolean-or-symbol? boolean?)
1266 (_i "Override the part-combiner.")
1267 (make-music 'EventChord
1268 'elements (list (make-music 'PartCombineForceEvent
1271 partcombineApart = \partcombineForce #'apart ##f
1272 partcombineApartOnce = \partcombineForce #'apart ##t
1273 partcombineChords = \partcombineForce #'chords ##f
1274 partcombineChordsOnce = \partcombineForce #'chords ##t
1275 partcombineUnisono = \partcombineForce #'unisono ##f
1276 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
1277 partcombineSoloI = \partcombineForce #'solo1 ##f
1278 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
1279 partcombineSoloII = \partcombineForce #'solo2 ##f
1280 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
1281 partcombineAutomatic = \partcombineForce ##f ##f
1282 partcombineAutomaticOnce = \partcombineForce ##f ##t
1285 #(define-music-function (dur) (ly:duration?)
1286 (_i "Make a partial measure.")
1288 ;; We use `descend-to-context' here instead of `context-spec-music' to
1289 ;; ensure \partial still works if the Timing_translator is moved
1291 (context-spec-music (make-music 'PartialSet
1292 'origin (*location*)
1298 #(define-music-function
1299 (main-note secondary-note)
1300 (ly:music? ly:music?)
1301 (_i "Print a trill with @var{main-note} as the main note of the trill and
1302 print @var{secondary-note} as a stemless note head in parentheses.")
1303 (let* ((get-notes (lambda (ev-chord)
1304 (extract-named-music ev-chord 'NoteEvent)))
1305 (sec-note-events (get-notes secondary-note))
1306 (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1307 (if (pair? sec-note-events)
1309 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1310 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1312 (if (ly:pitch? trill-pitch)
1313 (for-each (lambda (m)
1314 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1316 (ly:input-warning (*location*) (_ "Second argument of \\pitchedTrill should be single note: "))
1317 (display sec-note-events)))
1320 (for-each (lambda (m)
1321 (ly:music-set-property! m 'force-accidental forced))
1326 #(define-music-function (grob-property-path value)
1327 (symbol-list? scheme?)
1328 (_i "Set the grob property specified by @var{grob-property-path} to
1329 @var{value}. @var{grob-property-path} is a symbol list of the form
1330 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1331 with subproperties given as well. This music function is mostly intended
1332 for use from Scheme as a substitute for the built-in @code{\\override}
1334 (let ((p (check-grob-path grob-property-path (*location*)
1339 (make-music 'OverrideProperty
1341 'origin (*location*)
1343 'grob-property-path (cddr p)
1346 (make-music 'Music))))
1349 #(define-music-function (grob-property-path)
1351 (_i "Revert the grob property specified by @var{grob-property-path} to
1352 its previous value. @var{grob-property-path} is a symbol list of the form
1353 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
1354 with subproperties given as well. This music function is mostly intended
1355 for use from Scheme as a substitute for the built-in @code{\\revert}
1357 (let ((p (check-grob-path grob-property-path (*location*)
1362 (make-music 'RevertProperty
1364 'origin (*location*)
1365 'grob-property-path (cddr p))
1367 (make-music 'Music))))
1370 #(define-music-function (property-path value)
1371 (symbol-list-or-symbol? scheme?)
1372 (_i "Set the context property specified by @var{property-path} to
1373 @var{value}. This music function is mostly intended for use from
1374 Scheme as a substitute for the built-in @code{\\set} command.")
1375 (let ((p (check-context-path property-path (*location*))))
1378 (make-music 'PropertySet
1381 'origin (*location*))
1383 (make-music 'Music))))
1386 #(define-music-function (property-path)
1387 (symbol-list-or-symbol?)
1388 (_i "Unset the context property specified by @var{property-path}.
1389 This music function is mostly intended for use from Scheme as a
1390 substitute for the built-in @code{\\unset} command.")
1391 (let ((p (check-context-path property-path (*location*))))
1394 (make-music 'PropertyUnset
1396 'origin (*location*))
1398 (make-music 'Music))))
1401 #(define-music-function (tag more music)
1402 (symbol? ly:music? ly:music?)
1403 (_i "Add @var{more} to the front of @code{elements} of all music
1404 expressions in @var{music} that are tagged with @var{tag}.")
1405 (music-map (lambda (m)
1406 (if (memq tag (ly:music-property m 'tags))
1407 (set! (ly:music-property m 'elements)
1408 (cons more (ly:music-property m 'elements))))
1413 #(define-music-function (what main-music) (string? ly:music?)
1414 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
1415 of the quoted voice, as specified in an @code{\\addQuote} command.
1416 @var{main-music} is used to indicate the length of music to be quoted;
1417 usually contains spacers or multi-measure rests.")
1418 (make-music 'QuoteMusic
1420 'quoted-music-name what))
1424 #(define-music-function (pitch music)
1425 ((ly:pitch?) ly:music?)
1426 (_i "Make @var{music} relative to @var{pitch}. If @var{pitch} is
1427 omitted, the first note in @var{music} is given in absolute pitch.")
1428 ;; When \relative has no clear decision (can only happen with
1429 ;; scales with an even number of steps), it goes down (see
1430 ;; pitch.cc). The following formula puts out f for both the normal
1431 ;; 7-step scale as well as for a "shortened" scale missing the
1432 ;; final b. In either case, a first note of c will end up as c,
1433 ;; namely pitch (-1, 0, 0).
1434 (ly:make-music-relative! music
1439 ;; size of current scale:
1440 (ly:pitch-steps (ly:make-pitch 1 0))
1442 (make-music 'RelativeOctaveMusic
1446 #(define-music-function (tags music)
1447 (symbol-list-or-symbol? ly:music?)
1448 (_i "Remove elements of @var{music} that are tagged with one of the
1449 tags in @var{tags}. @var{tags} may be either a single symbol or a list
1452 (tags-remove-predicate tags)
1455 resetRelativeOctave =
1456 #(define-music-function (pitch) (ly:pitch?)
1457 (_i "Set the octave inside a \\relative section.")
1459 (make-music 'SequentialMusic
1460 'to-relative-callback
1461 (lambda (music last-pitch) pitch)))
1464 #(define-music-function (music)
1466 (_i "Return @var{music} in reverse order.")
1467 (retrograde-music music))
1469 revertTimeSignatureSettings =
1470 #(define-music-function
1474 (_i "Revert @code{timeSignatureSettings}
1475 for time signatures of @var{time-signature}.")
1476 (revert-time-signature-setting time-signature))
1479 #(define-event-function (finger) (number-or-markup?)
1480 (_i "Apply @var{finger} as a fingering indication.")
1484 (if (number? finger) 'digit 'text)
1488 #(define-music-function (fraction music)
1489 (fraction? ly:music?)
1490 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1491 (ly:music-compress music
1492 (ly:make-moment (car fraction) (cdr fraction))))
1495 #(define-scheme-function (ctx music)
1496 ((symbol?) ly:music?)
1497 (_i "Take the layout instruction events from @var{music}, optionally
1498 restricted to those applying to context type @var{ctx}, and return
1499 a context modification duplicating their effect.")
1500 (let ((mods (ly:make-context-mod)))
1502 (if (music-is-of-type? m 'layout-instruction-event)
1505 (case (ly:music-property m 'name)
1508 (ly:music-property m 'symbol)
1509 (ly:music-property m 'value)))
1512 (ly:music-property m 'symbol)))
1515 (ly:music-property m 'symbol)
1516 (ly:music-property m 'grob-value)
1518 ((ly:music-property m 'grob-property #f) => list)
1520 (ly:music-property m 'grob-property-path)))))
1523 (ly:music-property m 'symbol)
1525 ((ly:music-property m 'grob-property #f) => list)
1527 (ly:music-property m 'grob-property-path)))))))
1528 (case (ly:music-property m 'name)
1530 (ly:add-context-mod mods
1532 (ly:music-property m 'procedure))))
1533 ((ContextSpeccedMusic)
1535 (eq? ctx (ly:music-property m 'context-type)))
1536 (musicop (ly:music-property m 'element))))
1538 (let ((callback (ly:music-property m 'elements-callback)))
1539 (if (procedure? callback)
1540 (for-each musicop (callback m))))))))
1545 #(define-music-function (offsets item)
1546 (list? symbol-list-or-music?)
1547 (_i "Offset control-points of @var{item} by @var{offsets}. The
1548 argument is a list of number pairs or list of such lists. Each
1549 element of a pair represents an offset to one of the coordinates of a
1550 control-point. If @var{item} is a string, the result is
1551 @code{\\once\\override} for the specified grob type. If @var{item} is
1552 a music expression, the result is the same music expression with an
1553 appropriate tweak applied.")
1554 (define (shape-curve grob)
1555 (let* ((orig (ly:grob-original grob))
1556 (siblings (if (ly:spanner? grob)
1557 (ly:spanner-broken-into orig) '()))
1558 (total-found (length siblings))
1559 (function (assoc-get 'control-points
1560 (reverse (ly:grob-basic-properties grob))))
1561 (coords (function grob)))
1563 (define (offset-control-points offsets)
1567 (lambda (x y) (coord-translate x y))
1570 (define (helper sibs offs)
1572 (if (eq? (car sibs) grob)
1573 (offset-control-points (car offs))
1574 (helper (cdr sibs) (cdr offs)))
1577 ;; we work with lists of lists
1578 (if (or (null? offsets)
1579 (not (list? (car offsets))))
1580 (set! offsets (list offsets)))
1582 (if (>= total-found 2)
1583 (helper siblings offsets)
1584 (offset-control-points (car offsets)))))
1585 (once (tweak 'control-points shape-curve item)))
1588 #(define-music-function (dur dots arg)
1589 (integer? integer? ly:music?)
1590 (_i "Change the duration of @var{arg} by adding @var{dur} to the
1591 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1593 (shift-duration-log arg dur dots))
1596 #(define-music-function (overrides music)
1597 (ly:music? ly:music?)
1598 (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1599 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1600 (set! (ly:music-property music 'tweaks)
1602 (lambda (m) (eq? (ly:music-property m 'name)
1606 ((ly:music-property m 'grob-property #f) => list)
1608 (ly:music-property m 'grob-property-path)))))
1609 (acons (cons (ly:music-property m 'symbol) ;grob name
1611 p ;grob property path
1612 (car p))) ;grob property
1613 (ly:music-property m 'grob-value)
1615 (ly:music-property music 'tweaks)
1620 #(define-music-function (dur) (ly:duration?)
1621 (_i "Skip forward by @var{dur}.")
1622 (make-music 'SkipMusic
1627 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1628 (_i "Create slashed graces (slashes through stems, but no slur) from
1629 the following music expression"))
1632 #(define-music-function (parameters) (list?)
1633 (_i "Set the system stretch, by reading the 'system-stretch property of
1634 the `parameters' assoc list.")
1636 '(Score NonMusicalPaperColumn line-break-system-details)
1637 (list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1638 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))))
1641 #(define-music-function (style heads music)
1642 (symbol? symbol-list-or-symbol? ly:music?)
1643 (_i "Set @var{heads} in @var{music} to @var{style}.")
1644 (style-note-heads heads style music))
1647 #(define-music-function (tags music) (symbol-list-or-symbol? ly:music?)
1648 (_i "Tag the following @var{music} with @var{tags} and return the
1649 result, by adding the single symbol or symbol list @var{tags} to the
1650 @code{tags} property of @var{music}.")
1653 (ly:music-property music 'tags)
1654 ((if (symbol? tags) cons append)
1656 (ly:music-property music 'tags)))
1660 #(define-void-function (tags) (symbol-list?)
1661 (_i "Define a tag group comprising the symbols in the symbol list
1662 @var{tags}. Tag groups must not overlap.")
1663 (let ((err (define-tag-group tags)))
1664 (if err (ly:parser-error err (*location*)))))
1667 #(define-music-function (music)
1669 (_i "Make any @code{\\override} in @var{music} replace an existing
1670 grob property value only temporarily, restoring the old value when a
1671 corresponding @code{\\revert} is executed. This is achieved by
1672 clearing the @samp{pop-first} property normally set on
1675 An @code{\\override}/@/@code{\\revert} sequence created by using
1676 @code{\\temporary} and @code{\\undo} on the same music containing
1677 overrides will cancel out perfectly or cause a@tie{}warning.
1679 Non-property-related music is ignored, warnings are generated for any
1680 property-changing music that isn't an @code{\\override}.")
1684 (and (or (music-is-of-type? m 'layout-instruction-event)
1685 (music-is-of-type? m 'context-specification)
1686 (music-is-of-type? m 'apply-context)
1687 (music-is-of-type? m 'time-signature-music))
1688 (case (ly:music-property m 'name)
1690 (if (ly:music-property m 'pop-first #f)
1691 (set! (ly:music-property m 'pop-first) '()))
1692 (if (ly:music-property m 'once #f)
1693 (set! (ly:music-property m 'once) '()))
1695 ((ContextSpeccedMusic)
1700 (ly:input-warning (*location*) (_ "Cannot make ~a revertible")
1701 (ly:music-property m 'name))
1708 #(define-music-function (beat-structure fraction)
1709 ((number-list? '()) fraction?)
1710 (_i "Set @var{fraction} as time signature, with optional
1711 number list @var{beat-structure} before it.")
1712 (make-music 'TimeSignatureMusic
1713 'numerator (car fraction)
1714 'denominator (cdr fraction)
1715 'beat-structure beat-structure))
1718 #(define-music-function (fraction music)
1719 (fraction? ly:music?)
1720 (_i "Scale @var{music} in time by @var{fraction}.")
1721 (make-music 'TimeScaledMusic
1722 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1723 'numerator (car fraction)
1724 'denominator (cdr fraction)))
1727 #(define-music-function
1729 (ly:pitch? ly:pitch? ly:music?)
1731 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1732 (make-music 'TransposedMusic
1733 'element (ly:music-transpose music (ly:pitch-diff to from))))
1735 transposedCueDuring =
1736 #(define-music-function
1737 (what dir pitch main-music)
1738 (string? ly:dir? ly:pitch? ly:music?)
1740 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1741 using the transposition defined by @var{pitch}. This happens
1742 simultaneously with @var{main-music}, which is usually a rest. The
1743 argument @var{dir} determines whether the cue notes should be notated
1744 as a first or second voice.")
1746 (make-music 'QuoteMusic
1748 'quoted-context-type 'CueVoice
1749 'quoted-context-id "cue"
1750 'quoted-music-name what
1751 'quoted-voice-direction dir
1752 ;; following is inverse of instrumentTransposition for
1753 ;; historical reasons
1754 'quoted-transposition pitch))
1757 #(define-music-function (pitch) (ly:pitch?)
1758 (_i "Set instrument transposition")
1761 (make-property-set 'instrumentTransposition pitch)
1765 #(define-music-function (ratio tuplet-span music)
1766 (fraction? (ly:duration? '()) ly:music?)
1767 (_i "Scale the given @var{music} to tuplets. @var{ratio} is a
1768 fraction that specifies how many notes are played in place of the
1769 nominal value: it will be @samp{3/2} for triplets, namely three notes
1770 being played in place of two. If the optional duration
1771 @var{tuplet-span} is specified, it is used instead of
1772 @code{tupletSpannerDuration} for grouping the tuplets.
1775 \\tuplet 3/2 4 @{ c8 c c c c c @}
1777 will result in two groups of three tuplets, each group lasting for a
1779 (make-music 'TimeScaledMusic
1780 'element (ly:music-compress
1782 (ly:make-moment (cdr ratio) (car ratio)))
1783 'numerator (cdr ratio)
1784 'denominator (car ratio)
1785 'duration tuplet-span))
1788 #(define-music-function (tuplet-span)
1790 (_i "Set @code{tupletSpannerDuration}, the length into which
1791 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1792 own will group its tuplets, to the duration @var{tuplet-span}. To
1793 revert to the default of not subdividing the contents of a @code{\\tuplet}
1794 command without explicit @samp{tuplet-span}, use
1796 \\tupletSpan \\default
1800 #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1801 #{ \unset tupletSpannerDuration #}))
1804 #(define-music-function (prop value item)
1805 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1806 (_i "Add a tweak to the following @var{item}, usually music.
1807 Layout objects created by @var{item} get their property @var{prop}
1808 set to @var{value}. If @var{prop} has the form @samp{Grob.property}, like with
1810 \\tweak Accidental.color #red cis'
1812 an indirectly created grob (@samp{Accidental} is caused by
1813 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1816 As a special case, @var{item} may be a symbol list specifying a grob
1817 path, in which case @code{\\override} is called on it instead of
1818 creating tweaked music. This is mainly useful when using
1819 @code{\\tweak} as as a component for building other functions.
1821 If this use case would call for @code{\\once \\override} rather than a
1822 plain @code{\\override}, writing @code{\\once \\tweak @dots{}} can be
1825 @var{prop} can contain additional elements in which case a nested
1826 property (inside of an alist) is tweaked.")
1827 (if (ly:music? item)
1828 (let ((p (check-grob-path prop (*location*)
1833 (set! (ly:music-property item 'tweaks)
1834 (acons (cond ((pair? (cddr p)) p)
1836 (cons (car p) (cadr p)))
1839 (ly:music-property item 'tweaks))))
1841 (propertyOverride (append item (if (symbol? prop) (list prop) prop)) value)))
1844 #(define-music-function (music)
1846 (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1847 @code{\\revert} and @code{\\unset}, respectively. Any reverts and
1848 unsets already in @var{music} cause a warning. Non-property-related music is ignored.")
1855 (lambda (m) (or (music-is-of-type? m 'layout-instruction-event)
1856 (music-is-of-type? m 'context-specification)
1857 (music-is-of-type? m 'apply-context)
1858 (music-is-of-type? m 'time-signature-music)))
1859 (lambda (m overrides)
1860 (case (ly:music-property m 'name)
1863 (make-music 'RevertProperty
1864 'symbol (ly:music-property m 'symbol)
1867 ((ly:music-property m 'grob-property #f) => list)
1869 (ly:music-property m 'grob-property-path))))
1873 (make-music 'PropertyUnset
1874 'symbol (ly:music-property m 'symbol))
1876 ((ContextSpeccedMusic)
1878 (make-music 'ContextSpeccedMusic
1879 'element (loop (ly:music-property m 'element))
1880 'context-type (ly:music-property m 'context-type))
1885 (ly:input-warning (*location*) (_ "Cannot revert ~a")
1886 (ly:music-property m 'name))
1892 ((null? lst) (make-music 'Music))
1893 ((null? (cdr lst)) (car lst))
1894 (else (make-sequential-music lst))))))
1897 #(define-music-function (music) (ly:music?)
1898 (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1899 @code{\\repeat percent} commands in @var{music} to be interpreted
1900 as @code{\\repeat unfold}.")
1901 (unfold-repeats music))
1904 #(define-void-function (arg) (scheme?)
1905 (_i "Accept a scheme argument, return a void expression.
1906 Use this if you want to have a scheme expression evaluated
1907 because of its side-effects, but its value ignored."))
1910 #(define-music-function (sym val music)
1911 (symbol? scheme? ly:music?)
1912 (_i "Set @var{sym} to @var{val} in @var{music}.")
1914 (set! (ly:music-property music sym) val)