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 (parser location 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 (parser location 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 (parser location name music) (string? ly:music?)
56 (_i "Define @var{music} as a quotable music expression named
58 (add-quotable parser name music))
60 %% keep these two together
61 afterGraceFraction = #(cons 6 8)
63 #(define-music-function (parser location main grace) (ly:music? ly:music?)
64 (_i "Create @var{grace} note(s) after a @var{main} music expression.")
65 (let ((main-length (ly:music-length main))
66 (fraction (ly:parser-lookup parser 'afterGraceFraction)))
67 (make-simultaneous-music
70 (make-sequential-music
73 (make-music 'SkipMusic
74 'duration (ly:make-duration
76 (* (ly:moment-main-numerator main-length)
78 (* (ly:moment-main-denominator main-length)
80 (make-music 'GraceMusic
84 %% music identifiers not allowed at top-level,
85 %% so this is a music-function instead.
87 #(define-music-function (location parser) ()
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 (parser location property arg item)
98 (symbol-list-or-symbol? list? symbol-list-or-music?)
99 (_i "Override @var{property} for pieces of broken spanner @var{item}
100 with values @var{arg}. @var{item} may either be music in the form of
101 a starting spanner event, or a symbol list in the form
102 @samp{Context.Grob} or just @samp{Grob}. Iff @var{item} is in the
103 form of a spanner event, @var{property} may also have the form
104 @samp{Grob.property} for specifying a directed tweak.")
106 (if (eq? (ly:music-property item 'span-direction) START)
107 #{ \tweak #property #(value-for-spanner-piece arg) #item #}
109 (ly:music-warning item (_ "not a spanner"))
111 (let* ((p (check-grob-path item parser location
115 (name (and p (second p)))
117 (and name (assoc-get name all-grob-descriptions))))
119 (member 'spanner-interface
120 (assoc-get 'interfaces
121 (assoc-get 'meta description))))
123 \override #item . #property =
124 #(value-for-spanner-piece arg)
127 (ly:input-warning location (_ "not a spanner name, `~a'") name)
128 (make-music 'Music))))))
131 #(define-music-function (parser location 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 (parser location proc) (procedure?)
145 (_i "Modify context properties with Scheme procedure @var{proc}.")
146 (make-music 'ApplyContext
150 #(define-music-function (parser location func music) (procedure? ly:music?)
151 (_i"Apply procedure @var{func} to @var{music}.")
155 #(define-music-function (parser location 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 (parser location 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 (parser location 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 (parser location music) (ly:music?)
179 (_i "Make voices that switch between staves automatically")
180 (make-autochange-music parser music))
185 #(define-music-function (parser location grob-name offset text)
186 (symbol? number-pair? markup?)
187 (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}
188 (use like @code{\\once})")
191 (make-music 'AnnotateOutputEvent
193 'X-offset (car offset)
194 'Y-offset (cdr offset)
198 #(define-event-function (parser location offset text) (number-pair? markup?)
199 (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})")
200 (make-music 'AnnotateOutputEvent
201 'X-offset (car offset)
202 'Y-offset (cdr offset)
206 #(define-music-function (parser location type) (string?)
207 (_i "Insert a bar line of type @var{type}")
209 (make-property-set 'whichBar type)
213 #(define-music-function (parser location n) (integer?)
214 (_i "Print a warning if the current bar number is not @var{n}.")
215 (make-music 'ApplyContext
218 (let ((cbn (ly:context-property c 'currentBarNumber)))
219 (if (and (number? cbn) (not (= cbn n)))
220 (ly:input-warning location
221 "Barcheck failed got ~a expect ~a"
225 #(define-scheme-function (parser location music) (ly:music?)
226 (_i "Extract a value suitable for setting
227 @code{Timing.beamExceptions} from the given pattern with explicit
228 beams in @var{music}. A bar check @code{|} has to be used between
229 bars of patterns in order to reset the timing.")
230 (extract-beam-exceptions music))
233 #(define-event-function (parser location delta) (real?)
234 (_i "Create a fall or doit of pitch interval @var{delta}.")
235 (make-music 'BendAfterEvent
239 #(define-void-function (parser location newfilename) (string?)
240 (_i "Direct output for the current book block to @var{newfilename}.")
241 (set! (paper-variable parser #f 'output-filename) newfilename))
244 #(define-void-function (parser location newsuffix) (string?)
245 (_i "Set the output filename suffix for the current book block to
247 (set! (paper-variable parser #f 'output-suffix) newsuffix))
249 %% \breathe is defined as a music function rather than an event identifier to
250 %% ensure it gets useful input location information: as an event identifier,
251 %% it would have to be wrapped in an EventChord to prevent it from being
252 %% treated as a post_event by the parser
254 #(define-music-function (parser location) ()
255 (_i "Insert a breath mark.")
256 (make-music 'BreathingEvent))
259 #(define-music-function (parser location type) (string?)
260 (_i "Set the current clef to @var{type}.")
261 (make-clef-set type))
265 #(define-music-function (parser location args) (pair?)
266 (_i "Create compound time signatures. The argument is a Scheme list of
267 lists. Each list describes one fraction, with the last entry being the
268 denominator, while the first entries describe the summands in the
269 enumerator. If the time signature consists of just one fraction,
270 the list can be given directly, i.e. not as a list containing a single list.
271 For example, a time signature of (3+1)/8 + 2/4 would be created as
272 @code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8
273 as @code{\\compoundMeter #'((3 2 8))} or shorter
274 @code{\\compoundMeter #'(3 2 8)}.")
275 (let* ((mlen (calculate-compound-measure-length args))
276 (beat (calculate-compound-base-beat args))
277 (beatGrouping (calculate-compound-beat-grouping args))
278 (timesig (cons (ly:moment-main-numerator mlen)
279 (ly:moment-main-denominator mlen))))
281 \once \override Timing.TimeSignature.stencil = #(lambda (grob)
282 (grob-interpret-markup grob (make-compound-meter-markup args)))
283 \set Timing.timeSignatureFraction = #timesig
284 \set Timing.baseMoment = #beat
285 \set Timing.beatStructure = #beatGrouping
286 \set Timing.beamExceptions = #'()
287 \set Timing.measureLength = #mlen
291 #(define-music-function (parser location music) (ly:music?)
292 (_i "Remove the empty bars created by multi-measure rests,
293 leaving just the first bar containing the MM rest itself.")
296 (if (eq? 'MultiMeasureRestMusic (ly:music-property m 'name))
297 #{ \once \set Score.skipBars = ##t #m #}
302 #(define-music-function (parser location notes) (ly:music?)
303 (_i "Create cross-staff stems")
305 \temporary \override Stem.cross-staff = #cross-staff-connect
306 \temporary \override Flag.style = #'no-flag
308 \revert Stem.cross-staff
313 #(define-music-function (parser location type) (string?)
314 (_i "Set the current cue clef to @var{type}.")
315 (make-cue-clef-set type))
318 #(define-music-function (parser location) ()
319 (_i "Unset the current cue clef.")
320 (make-cue-clef-unset))
323 #(define-music-function
324 (parser location what dir main-music) (string? ly:dir? ly:music?)
325 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
326 in a CueVoice oriented by @var{dir}.")
327 (make-music 'QuoteMusic
329 'quoted-context-type 'CueVoice
330 'quoted-context-id "cue"
331 'quoted-music-name what
332 'quoted-voice-direction dir))
335 #(define-music-function
336 (parser location what dir clef main-music) (string? ly:dir? string? ly:music?)
337 (_i "Insert contents of quote @var{what} corresponding to @var{main-music},
338 in a CueVoice oriented by @var{dir}.")
339 (make-music 'QuoteMusic
341 'quoted-context-type 'CueVoice
342 'quoted-context-id "cue"
343 'quoted-music-name what
344 'quoted-music-clef clef
345 'quoted-voice-direction dir))
350 #(define-music-function (parser location port music) ((output-port?) ly:music?)
351 (_i "Display the LilyPond input representation of @var{music}
352 to @var{port}, defaulting to the console.")
353 (let ((port (or port (current-output-port))))
355 (display-lily-music music parser port))
359 #(define-music-function (parser location port music) ((output-port?) ly:music?)
360 (_i "Display the internal representation of @var{music} to
361 @var{port}, default to the console.")
362 (let ((port (or port (current-output-port))))
364 (display-scheme-music music port))
368 #(define-scheme-function (parser location port expr) ((output-port?) scheme?)
369 (_i "Display the internal representation of @var{expr} to
370 @var{port}, default to the console.")
371 (let ((port (or port (current-output-port))))
373 (display-scheme-music expr port))
379 #(define-music-function (parser location music) (ly:music?)
380 (_i "Terminate the next spanner prematurely after exactly one note
381 without the need of a specific end spanner.")
382 (let* ((start-span-evs (filter (lambda (ev)
383 (equal? (ly:music-property ev 'span-direction)
385 (extract-typed-music music 'span-event)))
388 (music-clone m 'span-direction STOP))
390 (end-ev-chord (make-music 'EventChord
391 'elements stop-span-evs))
392 (total (make-music 'SequentialMusic
393 'elements (list music
398 #(define-music-function (parser location music) (ly:music?)
399 (_i "Compatibility function wrapping @code{EventChord} around
400 isolated rhythmic events occuring since version 2.15.28, after
401 expanding repeat chords @samp{q}.")
402 (event-chord-wrap! music parser))
405 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
406 (_i "Adjust durations of music in @var{argument} by rational @var{factor}.")
407 (let ((orig-duration (ly:music-length argument))
408 (multiplier (ly:make-moment 1 1)))
412 (if (< 0 (ly:moment-main-denominator (ly:music-length mus)))
414 (ly:music-compress mus multiplier)
415 (set! multiplier (ly:moment-mul factor multiplier)))))
416 (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent)))
419 (ly:moment-div orig-duration (ly:music-length argument)))
424 #(define-event-function (parser location finger) (number-or-markup?)
425 (_i "Apply @var{finger} as a fingering indication.")
429 (if (number? finger) 'digit 'text)
433 #(define-music-function (parser location pitch music)
434 (ly:pitch? ly:music?)
435 (_i "Use the octave of @var{pitch} as the default octave for @var{music}.")
436 (let ((octave-marks (1+ (ly:pitch-octave pitch))))
437 (cond ((not (= 0 octave-marks))
438 (ly:music-transpose music (ly:make-pitch octave-marks 0 0))
439 ;;In order to leave unchanged the notes in any enclosed
440 ;; \absolute or \fixed or \relative, make a cancelling shift
442 (ly:music-transpose m (ly:make-pitch (- octave-marks) 0 0)))
443 (extract-named-music music 'RelativeOctaveMusic)))))
444 (make-music 'RelativeOctaveMusic 'element music))
447 #(define-music-function (parser location mark offset footnote item)
448 ((markup?) number-pair? markup? symbol-list-or-music?)
449 (_i "Make the markup @var{footnote} a footnote on @var{item}. The
450 footnote is marked with a markup @var{mark} moved by @var{offset} with
451 respect to the marked music.
453 If @var{mark} is not given or specified as @var{\\default}, it is
454 replaced by an automatically generated sequence number. If @var{item}
455 is a symbol list of form @samp{Grob} or @samp{Context.Grob}, then
456 grobs of that type will be marked at the current time step in the
457 given context (default @code{Bottom}).
459 If @var{item} is music, the music will get a footnote attached to a
460 grob immediately attached to the event, like @var{\\tweak} does. For
461 attaching a footnote to an @emph{indirectly} caused grob, write
462 @code{\\single\\footnote}, use @var{item} to specify the grob, and
463 follow it with the music to annotate.
465 Like with @code{\\tweak}, if you use a footnote on a following
466 post-event, the @code{\\footnote} command itself needs to be attached
467 to the preceding note or rest as a post-event with @code{-}.")
468 (let ((mus (make-music
470 'X-offset (car offset)
471 'Y-offset (cdr offset)
472 'automatically-numbered (not mark)
473 'text (or mark (make-null-markup))
474 'footnote-text footnote)))
475 #{ \once \tweak footnote-music #mus #item #}))
478 #(def-grace-function startGraceMusic stopGraceMusic
479 (_i "Insert @var{music} as grace notes."))
482 #(define-scheme-function (parser location descriptions) (list?)
483 (_i "Create a context modification from @var{descriptions}, a list
484 in the format of @code{all-grob-descriptions}.")
487 (list 'assign (car p) (ly:make-grob-properties (cdr p))))
490 harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?)
491 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
492 harmonics played on a fretted instrument by touching the strings at @var{fret}.")
494 \set harmonicDots = ##t
495 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (number->string fret))
496 \temporary \override NoteHead.Y-extent = #grob::always-Y-extent-from-stencil
497 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
498 (ly:note-head::print grob))
500 (calc-harmonic-pitch (fret->pitch (number->string fret)) music))
502 \revert TabNoteHead.stencil
503 \revert NoteHead.Y-extent
504 \revert NoteHead.stencil
507 harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?)
508 (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble
509 harmonics played on a fretted instrument by touching the strings at the point
510 given through @var{ratio}.")
512 \set harmonicDots = ##t
513 \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio))
514 \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height)
515 \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed)
516 (ly:note-head::print grob))
518 (calc-harmonic-pitch (ratio->pitch ratio) music))
520 \revert TabNoteHead.stencil
521 \revert NoteHead.Y-extent
522 \revert NoteHead.stencil
526 #(define-music-function (parser location item) (symbol-list-or-music?)
527 (_i "Set @var{item}'s @samp{transparent} property to @code{#t},
528 making it invisible while still retaining its dimensions.
530 If @var{item} is a symbol list of form @code{GrobName} or
531 @code{Context.GrobName}, the result is an override for the grob name
532 specified by it. If @var{item} is a music expression, the result is
533 the same music expression with an appropriate tweak applied to it.")
534 #{ \tweak transparent ##t #item #})
537 #(define-music-function (parser location) ()
538 (_i "Put the segno variant 'varsegno' at this position into the staff,
539 compatible with the repeat command.")
540 (make-music 'ApplyContext
543 (let ((score-ctx (ly:context-find ctx 'Score)))
544 (if (ly:context? score-ctx)
545 (let ((old-rc (ly:context-property score-ctx 'repeatCommands '())))
546 (if (eq? (memq 'segno-display old-rc) #f)
547 (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc)))))))))
550 #(define-music-function
551 (parser location name) (string?)
552 (_i "Switch instrument to @var{name}, which must be predefined with
553 @code{\\addInstrumentDefinition}.")
554 (let* ((handle (assoc name instrument-definitions))
555 (instrument-def (if handle (cdr handle) '())))
558 (ly:input-warning location "No such instrument: ~a" name))
560 (make-music 'SimultaneousMusic
572 #(define-music-function (parser location tags music)
573 (symbol-list-or-symbol? ly:music?)
574 (_i "Include only elements of @var{music} that are tagged with one
575 of the tags in @var{tags}. @var{tags} may be either a single symbol
576 or a list of symbols.
578 Each tag may be declared as a member of at most one tag group (defined
579 with @code{\\tagGroup}). If none of a @var{music} element's tags
580 share a tag group with one of the specified @var{tags}, the element is
583 (tags-keep-predicate tags)
587 #(define-music-function (parser location tonic pitch-alist)
588 ((ly:pitch? '()) (list? '()))
589 (_i "Set key to @var{tonic} and scale @var{pitch-alist}.
590 If both are null, just generate @code{KeyChangeEvent}.")
591 (cond ((null? tonic) (make-music 'KeyChangeEvent))
593 (ly:parser-error parser (_ "second argument must be pitch list")
595 (make-music 'SequentialMusic 'void #t))
598 (make-music 'KeyChangeEvent
599 'tonic (ly:make-pitch 0 0 0)
600 'pitch-alist pitch-alist)
604 #(define-music-function (parser location music) (ly:music?)
605 (_i "Remove cue notes from @var{music}.")
608 (if (and (string? (ly:music-property mus 'quoted-music-name))
609 (string=? (ly:music-property mus 'quoted-context-id "") "cue"))
610 (ly:music-property mus 'element)
617 #(define-music-function (parser location label) (symbol?)
618 (_i "Create @var{label} as a bookmarking label.")
619 (make-music 'EventChord
622 'elements (list (make-music 'LabelEvent
623 'page-label label))))
627 #(define-void-function (parser location language) (string?)
628 (_i "Set note names for language @var{language}.")
629 (note-names-language parser language))
631 languageSaveAndChange =
632 #(define-void-function (parser location language) (string?)
633 (_i "Store the previous pitchnames alist, and set a new one.")
634 (set! previous-pitchnames pitchnames)
635 (note-names-language parser language))
638 #(define-void-function (parser location) ()
639 (_i "Restore a previously-saved pitchnames alist.")
640 (if previous-pitchnames
642 (set! pitchnames previous-pitchnames)
643 (ly:parser-set-note-names parser pitchnames))
644 (ly:input-warning location (_ "No other language was defined previously. Ignoring."))))
648 #(define-music-function (parser location mag music) (positive? ly:music?)
649 (_i "Magnify the notation of @var{music} without changing the
650 staff-size, using @var{mag} as a size factor. Stems, beams,
651 slurs, ties, and horizontal spacing are adjusted automatically.")
653 ;; these props are NOT allowed to shrink below default size
654 (define unshrinkable-props
660 (Slur line-thickness)
662 (PhrasingSlur line-thickness)
663 (PhrasingSlur thickness)
668 (LaissezVibrerTie line-thickness)
669 (LaissezVibrerTie thickness)
670 (RepeatTie line-thickness)
671 (RepeatTie thickness)
674 ;; these props ARE allowed to shrink below default size
675 (define shrinkable-props
676 (let ((baseline-skip-props
677 (find-named-props 'baseline-skip all-grob-descriptions))
679 (find-named-props 'word-space all-grob-descriptions)))
684 ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed
685 ;; override at the 'Score level
686 ;(SpacingSpanner spacing-increment)
688 ;; lengths and heights
689 (Beam length-fraction)
690 (Stem length-fraction)
691 (Stem beamlet-default-length)
692 (Stem double-stem-separation)
694 (Slur minimum-length)
695 (PhrasingSlur height-limit)
696 (PhrasingSlur minimum-length)
698 ;; Beam.beam-thickness is dealt with separately below
702 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
704 #(scale-fontSize 'magnifyMusic mag)
705 #(scale-props 'magnifyMusic mag #f unshrinkable-props)
706 #(scale-props 'magnifyMusic mag #t shrinkable-props)
707 #(scale-beam-thickness mag)
711 %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed
713 %% reverse engineer the former fontSize value instead of using \unset
714 #(revert-fontSize 'magnifyMusic mag)
715 #(revert-props 'magnifyMusic mag (append unshrinkable-props
717 '((Beam beam-thickness))))
722 #(define-music-function (parser location mag) (positive?)
723 (_i "Change the size of the staff, adjusting notation size and
724 horizontal spacing automatically, using @var{mag} as a size factor.")
726 ;; these props are NOT allowed to shrink below default size
727 (define unshrinkable-props
728 '((StaffSymbol thickness)))
730 ;; these props ARE allowed to shrink below default size
731 (define shrinkable-props
732 (let* ((baseline-skip-props
733 (find-named-props 'baseline-skip all-grob-descriptions))
735 (find-named-props 'word-space all-grob-descriptions))
737 (find-named-props 'space-alist all-grob-descriptions)))
743 ;; override at the 'Score level
744 (SpacingSpanner spacing-increment)
746 (StaffSymbol staff-space)
749 (BarLine hair-thickness)
750 (BarLine thick-thickness)
751 (Stem beamlet-default-length)
752 (Stem double-stem-separation)
758 %% revert settings from last time
759 %% (but only if \magnifyStaff has already been used
760 %% and the staff magnification is changing)
761 #(revert-fontSize 'magnifyStaff mag)
762 #(revert-props 'magnifyStaff mag (append unshrinkable-props
766 %% (but only if staff magnification is changing
767 %% and does not equal 1)
768 #(scale-fontSize 'magnifyStaff mag)
769 #(scale-props 'magnifyStaff mag #f unshrinkable-props)
770 #(scale-props 'magnifyStaff mag #t shrinkable-props)
772 %% this might cause problems until Issue 3990 is fixed
776 \set Staff.magnifyStaffValue = #mag
780 #(define-music-function (parser location arg) (ly:music?)
781 (_i "Display chords in @var{arg} as clusters.")
782 (music-map note-to-cluster arg))
785 #(define-music-function (parser location around to scale music)
786 (ly:pitch? ly:pitch? ly:music? ly:music?)
787 (_i "Invert @var{music} about @var{around} using @var{scale} and
788 transpose from @var{around} to @var{to}.")
789 (let ((inverter (make-modal-inverter around to scale)))
790 (change-pitches music inverter)
794 #(define-music-function (parser location from to scale music)
795 (ly:pitch? ly:pitch? ly:music? ly:music?)
796 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}
798 (let ((transposer (make-modal-transposer from to scale)))
799 (change-pitches music transposer)
803 #(define-music-function
804 (parser location around to music) (ly:pitch? ly:pitch? ly:music?)
805 (_i "Invert @var{music} about @var{around} and
806 transpose from @var{around} to @var{to}.")
807 (music-invert around to music))
810 #(define-music-function
811 (parser location label) ((scheme? '()))
812 "Make the music for the \\mark command."
813 (let* ((set (and (integer? label)
814 (context-spec-music (make-property-set 'rehearsalMark label)
816 (ev (make-music 'MarkEvent
820 (make-sequential-music (list set ev))
822 (set! (ly:music-property ev 'label) label)
826 #(define-music-function (parser location proc mus) (procedure? ly:music?)
827 (_i "Apply @var{proc} to @var{mus} and all of the music it contains.")
828 (music-map proc mus))
830 %% noPageBreak and noPageTurn are music functions (not music indentifiers),
831 %% because music identifiers are not allowed at top-level.
833 #(define-music-function (location parser) ()
834 (_i "Forbid a page break. May be used at toplevel (i.e., between scores or
835 markups), or inside a score.")
836 (make-music 'EventChord
838 'page-break-permission 'forbid
839 'elements (list (make-music 'PageBreakEvent
840 'break-permission '()))))
843 #(define-music-function (location parser) ()
844 (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or
845 markups), or inside a score.")
846 (make-music 'EventChord
848 'page-turn-permission 'forbid
849 'elements (list (make-music 'PageTurnEvent
850 'break-permission '()))))
855 #(define-music-function (parser location pitch) (ly:pitch?)
857 (make-music 'RelativeOctaveCheck
861 #(define-music-function (parser location property offsets item)
862 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
863 (_i "Offset the default value of @var{property} of @var{item} by
864 @var{offsets}. If @var{item} is a string, the result is
865 @code{\\override} for the specified grob type. If @var{item} is
866 a music expression, the result is the same music expression with an
867 appropriate tweak applied.")
869 ; In case of a tweak, grob property path is Grob.property
870 (let ((prop-path (check-grob-path
871 (if (symbol? property)
875 #:start 1 #:default #t #:min 2 #:max 2)))
877 ; If the head of the grob property path is a symbol--i.e.,
878 ; a grob name, produce a directed tweak. Otherwise, create
880 (if (symbol? (car prop-path))
882 \tweak #prop-path #(offsetter (second prop-path) offsets) #item
885 \tweak #(second prop-path) #(offsetter (second prop-path) offsets) #item
888 ; In case of an override, grob property path is Context.Grob.property.
889 (let ((prop-path (check-grob-path
891 (if (symbol? property)
895 #:default 'Bottom #:min 3 #:max 3)))
898 \override #prop-path = #(offsetter (third prop-path) offsets)
900 (make-music 'Music)))))
903 #(define-music-function (parser location item) (symbol-list-or-music?)
904 (_i "Set @var{item}'s @samp{stencil} property to @code{#f},
905 effectively omitting it without taking up space.
907 If @var{item} is a symbol list of form @code{GrobName} or
908 @code{Context.GrobName}, the result is an override for the grob name
909 specified by it. If @var{item} is a music expression, the result is
910 the same music expression with an appropriate tweak applied to it.")
911 #{ \tweak stencil ##f #item #})
914 #(define-music-function (parser location music) (ly:music?)
915 (_i "Set @code{once} to @code{#t} on all layout instruction events
916 in @var{music}. This will complain about music with an actual
917 duration. As a special exception, if @var{music} contains
918 @samp{tweaks} it will be silently ignored in order to allow for
919 @code{\\once \\tweak} to work as both one-time override and proper
921 (if (not (pair? (ly:music-property music 'tweaks)))
924 (cond ((music-is-of-type? m 'layout-instruction-event)
925 (set! (ly:music-property m 'once) #t)
927 ((ly:duration? (ly:music-property m 'duration))
928 (ly:music-warning m (_ "Cannot apply \\once to timed music"))
935 #(define-music-function (parser location octave) (integer?)
936 (_i "Set the octavation.")
937 (make-music 'OttavaMusic
938 'ottava-number octave))
940 overrideTimeSignatureSettings =
941 #(define-music-function
942 (parser location time-signature base-moment beat-structure beam-exceptions)
943 (fraction? fraction? list? list?)
945 (_i "Override @code{timeSignatureSettings}
946 for time signatures of @var{time-signature} to have settings
947 of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.")
949 ;; TODO -- add warning if largest value of grouping is
950 ;; greater than time-signature.
951 (let ((setting (make-setting base-moment beat-structure beam-exceptions)))
952 (override-time-signature-setting time-signature setting)))
955 #(define-music-function (parser location grob-property-path value)
956 (symbol-list? scheme?)
958 (_i "Set the grob property specified by @var{grob-property-path} to
959 @var{value}. @var{grob-property-path} is a symbol list of the form
960 @code{Context.GrobName.property} or @code{GrobName.property}, possibly
961 with subproperties given as well.")
962 (let ((p (check-grob-path grob-property-path parser location
966 (make-music 'ApplyOutputEvent
967 'context-type (first p)
969 (lambda (grob orig-context context)
971 (cdr (assoc 'name (ly:grob-property grob 'meta)))
973 (ly:grob-set-nested-property!
974 grob (cddr p) value))))
975 (make-music 'Music))))
982 %% pageBreak and pageTurn are music functions (iso music indentifiers),
983 %% because music identifiers are not allowed at top-level.
985 #(define-music-function (location parser) ()
986 (_i "Force a page break. May be used at toplevel (i.e., between scores or
987 markups), or inside a score.")
988 (make-music 'EventChord
990 'line-break-permission 'force
991 'page-break-permission 'force
992 'elements (list (make-music 'LineBreakEvent
993 'break-permission 'force)
994 (make-music 'PageBreakEvent
995 'break-permission 'force))))
998 #(define-music-function (location parser) ()
999 (_i "Force a page turn between two scores or top-level markups.")
1000 (make-music 'EventChord
1002 'line-break-permission 'force
1003 'page-break-permission 'force
1004 'page-turn-permission 'force
1005 'elements (list (make-music 'LineBreakEvent
1006 'break-permission 'force)
1007 (make-music 'PageBreakEvent
1008 'break-permission 'force)
1009 (make-music 'PageTurnEvent
1010 'break-permission 'force))))
1013 #(define-void-function (parser location voice-ids music) (list? ly:music?)
1014 (_i "Define parallel music sequences, separated by '|' (bar check signs),
1015 and assign them to the identifiers provided in @var{voice-ids}.
1017 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
1019 @var{music}: a music sequence, containing BarChecks as limiting expressions.
1024 \\parallelMusic #'(A B C) {
1034 (define voice-count (length voice-ids))
1035 (define (bar-check? m)
1036 "Checks whether m is a bar check."
1037 (eq? (ly:music-property m 'name) 'BarCheck))
1038 (define (recurse-and-split-list lst)
1039 "Return either a list of music lists split along barchecks, or @code{#f}."
1040 (if (any bar-check? lst)
1041 (let* ((voices (apply circular-list (make-list voice-count '())))
1042 (current-voices voices)
1043 (current-sequence '()))
1046 (define (push-music m)
1047 "Push the music expression into the current sequence"
1048 (set! current-sequence (cons m current-sequence)))
1049 (define (change-voice)
1050 "Store the previously built sequence into the current voice and
1051 change to the following voice."
1052 (set-car! current-voices
1053 (cons (reverse! current-sequence)
1054 (car current-voices)))
1055 (set! current-sequence '())
1056 (set! current-voices (cdr current-voices)))
1057 (for-each (lambda (m)
1058 (let ((split? (recurse-and-split m)))
1067 (if (bar-check? m) (change-voice))))))
1069 (if (pair? current-sequence) (change-voice))
1070 ;; un-circularize `voices' and reorder the voices
1071 (set! voices (map reverse!
1072 (list-head voices voice-count)))
1073 ;; check sequence length
1074 (apply for-each (lambda seqs
1075 (define (seq-len seq)
1076 (reduce ly:moment-add
1078 (map ly:music-length seq)))
1079 (let ((moment-reference (seq-len (car seqs))))
1080 (for-each (lambda (seq)
1081 (if (not (equal? (seq-len seq)
1087 (_ "Bars in parallel music don't have the same length"))))
1090 (map concatenate! voices))
1091 (let ((deeper (map recurse-and-split lst)))
1092 (and (any pair? deeper)
1096 (ly:music-deep-copy (make-list voice-count m))))
1098 (define (recurse-and-split music)
1099 "This returns either a list of music split along barchecks, or
1101 (let* ((elt (ly:music-property music 'element))
1102 (elts (ly:music-property music 'elements))
1103 (split-elt (and (ly:music? elt) (recurse-and-split elt)))
1104 (split-elts (and (pair? elts) (recurse-and-split-list elts))))
1105 (and (or split-elt split-elts)
1108 (apply music-clone music
1110 ;; reassigning the origin of the parent only
1111 ;; makes sense if the first expression in the
1112 ;; result is from a distributed origin
1115 (and (ly:music? e) (ly:music-property e 'origin #f))
1116 (and (pair? es) (ly:music-property (car es) 'origin #f)))))
1117 (if origin (list 'origin origin) '()))
1118 (if (ly:music? e) (list 'element e) '())
1119 (if (pair? es) (list 'elements es) '()))))
1120 (or split-elt (circular-list #f))
1121 (or split-elts (circular-list #f))))))
1122 (let ((voices (recurse-and-split music)))
1125 ;; bind voice identifiers to the voices
1126 (for-each (lambda (voice-id voice)
1127 (ly:parser-define! parser voice-id voice))
1129 (ly:music-warning music
1130 (_ "ignoring parallel music without barchecks")))))
1133 #(define-music-function (parser loc arg) (ly:music?)
1134 (_i "Tag @var{arg} to be parenthesized.")
1136 (if (memq 'event-chord (ly:music-property arg 'types))
1137 ;; arg is an EventChord -> set the parenthesize property
1138 ;; on all child notes and rests
1141 (if (or (memq 'note-event (ly:music-property ev 'types))
1142 (memq 'rest-event (ly:music-property ev 'types)))
1143 (set! (ly:music-property ev 'parenthesize) #t)))
1144 (ly:music-property arg 'elements))
1145 ;; No chord, simply set property for this expression:
1146 (set! (ly:music-property arg 'parenthesize) #t))
1149 #(define (make-directed-part-combine-music
1150 parser direction chord-range part1 part2
1151 one-context-settings
1152 two-context-settings
1153 shared-context-settings)
1155 (let ((pc-music (make-part-combine-music
1156 parser (list part1 part2) direction chord-range)))
1157 #{ \context Staff <<
1158 \context Voice = "one" \with #one-context-settings {}
1159 \context Voice = "two" \with #two-context-settings {}
1160 \context Voice = "shared" \with #shared-context-settings {}
1162 #(make-part-combine-marks
1163 default-part-combine-mark-state-machine
1164 (ly:music-property pc-music 'split-list))
1168 #(define-music-function (parser location chord-range part1 part2)
1169 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1170 (_i "Take the music in @var{part1} and @var{part2} and return
1171 a music expression containing simultaneous voices, where @var{part1}
1172 and @var{part2} are combined into one voice where appropriate.
1173 Optional @var{chord-range} sets the distance in steps between notes
1174 that may be combined into a chord or unison.")
1175 (make-directed-part-combine-music parser #f chord-range part1 part2
1176 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1177 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1181 #(define-music-function (parser location chord-range part1 part2)
1182 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1183 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1184 that they share a staff with stems directed upward.")
1185 (make-directed-part-combine-music parser UP chord-range part1 part2
1186 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #}
1187 #{ \with { \voiceThree \override DynamicLineSpanner.direction = #UP } #}
1188 #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} ))
1191 #(define-music-function (parser location chord-range part1 part2)
1192 ((number-pair? '(0 . 8)) ly:music? ly:music?)
1193 (_i "Take the music in @var{part1} and @var{part2} and typeset so
1194 that they share a staff with stems directed downward.")
1195 (make-directed-part-combine-music parser DOWN chord-range part1 part2
1196 #{ \with { \voiceFour \override DynamicLineSpanner.direction = #DOWN } #}
1197 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #}
1198 #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} ))
1201 #(define-music-function (location parser type once) (boolean-or-symbol? boolean?)
1202 (_i "Override the part-combiner.")
1203 (make-music 'EventChord
1204 'elements (list (make-music 'PartCombineForceEvent
1207 partcombineApart = \partcombineForce #'apart ##f
1208 partcombineApartOnce = \partcombineForce #'apart ##t
1209 partcombineChords = \partcombineForce #'chords ##f
1210 partcombineChordsOnce = \partcombineForce #'chords ##t
1211 partcombineUnisono = \partcombineForce #'unisono ##f
1212 partcombineUnisonoOnce = \partcombineForce #'unisono ##t
1213 partcombineSoloI = \partcombineForce #'solo1 ##f
1214 partcombineSoloIOnce = \partcombineForce #'solo1 ##t
1215 partcombineSoloII = \partcombineForce #'solo2 ##f
1216 partcombineSoloIIOnce = \partcombineForce #'solo2 ##t
1217 partcombineAutomatic = \partcombineForce ##f ##f
1218 partcombineAutomaticOnce = \partcombineForce ##f ##t
1221 #(define-music-function (parser location dur) (ly:duration?)
1222 (_i "Make a partial measure.")
1224 ;; We use `descend-to-context' here instead of `context-spec-music' to
1225 ;; ensure \partial still works if the Timing_translator is moved
1227 (context-spec-music (make-music 'PartialSet
1234 #(define-music-function
1235 (parser location main-note secondary-note)
1236 (ly:music? ly:music?)
1237 (_i "Print a trill with @var{main-note} as the main note of the trill and
1238 print @var{secondary-note} as a stemless note head in parentheses.")
1239 (let* ((get-notes (lambda (ev-chord)
1240 (extract-named-music ev-chord 'NoteEvent)))
1241 (sec-note-events (get-notes secondary-note))
1242 (trill-events (extract-named-music main-note 'TrillSpanEvent)))
1243 (if (pair? sec-note-events)
1245 (let* ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
1246 (forced (ly:music-property (car sec-note-events) 'force-accidental)))
1248 (if (ly:pitch? trill-pitch)
1249 (for-each (lambda (m)
1250 (ly:music-set-property! m 'pitch trill-pitch)) trill-events)
1252 (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: "))
1253 (display sec-note-events)))
1256 (for-each (lambda (m)
1257 (ly:music-set-property! m 'force-accidental forced))
1262 #(define-music-function (parser location tag more music)
1263 (symbol? ly:music? ly:music?)
1264 (_i "Add @var{more} to the front of @code{elements} of all music
1265 expressions in @var{music} that are tagged with @var{tag}.")
1266 (music-map (lambda (m)
1267 (if (memq tag (ly:music-property m 'tags))
1268 (set! (ly:music-property m 'elements)
1269 (cons more (ly:music-property m 'elements))))
1274 #(define-music-function (parser location what main-music) (string? ly:music?)
1275 (_i "Indicate a section of music to be quoted. @var{what} indicates the name
1276 of the quoted voice, as specified in an @code{\\addQuote} command.
1277 @var{main-music} is used to indicate the length of music to be quoted;
1278 usually contains spacers or multi-measure rests.")
1279 (make-music 'QuoteMusic
1281 'quoted-music-name what))
1284 #(define-music-function (parser location pitch music)
1285 ((ly:pitch?) ly:music?)
1286 (_i "Make @var{music} relative to @var{pitch}. If @var{pitch} is
1287 omitted, the first note in @var{music} is given in absolute pitch.")
1288 ;; When \relative has no clear decision (can only happen with
1289 ;; scales with an even number of steps), it goes down (see
1290 ;; pitch.cc). The following formula puts out f for both the normal
1291 ;; 7-step scale as well as for a "shortened" scale missing the
1292 ;; final b. In either case, a first note of c will end up as c,
1293 ;; namely pitch (-1, 0, 0).
1294 (ly:make-music-relative! music
1299 ;; size of current scale:
1300 (ly:pitch-steps (ly:make-pitch 1 0))
1302 (make-music 'RelativeOctaveMusic
1306 #(define-music-function (parser location tags music)
1307 (symbol-list-or-symbol? ly:music?)
1308 (_i "Remove elements of @var{music} that are tagged with one of the
1309 tags in @var{tags}. @var{tags} may be either a single symbol or a list
1312 (tags-remove-predicate tags)
1315 resetRelativeOctave =
1316 #(define-music-function (parser location pitch) (ly:pitch?)
1317 (_i "Set the octave inside a \\relative section.")
1319 (make-music 'SequentialMusic
1320 'to-relative-callback
1321 (lambda (music last-pitch) pitch)))
1324 #(define-music-function (parser location music)
1326 (_i "Return @var{music} in reverse order.")
1327 (retrograde-music music))
1329 revertTimeSignatureSettings =
1330 #(define-music-function
1331 (parser location time-signature)
1334 (_i "Revert @code{timeSignatureSettings}
1335 for time signatures of @var{time-signature}.")
1336 (revert-time-signature-setting time-signature))
1339 #(define-event-function (parser location finger) (number-or-markup?)
1340 (_i "Apply @var{finger} as a fingering indication.")
1344 (if (number? finger) 'digit 'text)
1348 #(define-music-function (parser location fraction music)
1349 (fraction? ly:music?)
1350 (_i "Multiply the duration of events in @var{music} by @var{fraction}.")
1351 (ly:music-compress music
1352 (ly:make-moment (car fraction) (cdr fraction))))
1355 #(define-scheme-function (parser location ctx music)
1356 ((symbol?) ly:music?)
1357 (_i "Take the layout instruction events from @var{music}, optionally
1358 restricted to those applying to context type @var{ctx}, and return
1359 a context modification duplicating their effect.")
1360 (let ((mods (ly:make-context-mod)))
1362 (if (music-is-of-type? m 'layout-instruction-event)
1365 (case (ly:music-property m 'name)
1368 (ly:music-property m 'symbol)
1369 (ly:music-property m 'value)))
1372 (ly:music-property m 'symbol)))
1375 (ly:music-property m 'symbol)
1376 (ly:music-property m 'grob-value)
1378 ((ly:music-property m 'grob-property #f) => list)
1380 (ly:music-property m 'grob-property-path)))))
1383 (ly:music-property m 'symbol)
1385 ((ly:music-property m 'grob-property #f) => list)
1387 (ly:music-property m 'grob-property-path)))))))
1388 (case (ly:music-property m 'name)
1390 (ly:add-context-mod mods
1392 (ly:music-property m 'procedure))))
1393 ((ContextSpeccedMusic)
1395 (eq? ctx (ly:music-property m 'context-type)))
1396 (musicop (ly:music-property m 'element))))
1398 (let ((callback (ly:music-property m 'elements-callback)))
1399 (if (procedure? callback)
1400 (for-each musicop (callback m))))))))
1405 #(define-music-function (parser location offsets item)
1406 (list? symbol-list-or-music?)
1407 (_i "Offset control-points of @var{item} by @var{offsets}. The
1408 argument is a list of number pairs or list of such lists. Each
1409 element of a pair represents an offset to one of the coordinates of a
1410 control-point. If @var{item} is a string, the result is
1411 @code{\\once\\override} for the specified grob type. If @var{item} is
1412 a music expression, the result is the same music expression with an
1413 appropriate tweak applied.")
1414 (define (shape-curve grob)
1415 (let* ((orig (ly:grob-original grob))
1416 (siblings (if (ly:spanner? grob)
1417 (ly:spanner-broken-into orig) '()))
1418 (total-found (length siblings))
1419 (function (assoc-get 'control-points
1420 (reverse (ly:grob-basic-properties grob))))
1421 (coords (function grob)))
1423 (define (offset-control-points offsets)
1427 (lambda (x y) (coord-translate x y))
1430 (define (helper sibs offs)
1432 (if (eq? (car sibs) grob)
1433 (offset-control-points (car offs))
1434 (helper (cdr sibs) (cdr offs)))
1437 ;; we work with lists of lists
1438 (if (or (null? offsets)
1439 (not (list? (car offsets))))
1440 (set! offsets (list offsets)))
1442 (if (>= total-found 2)
1443 (helper siblings offsets)
1444 (offset-control-points (car offsets)))))
1445 #{ \once \tweak control-points #shape-curve #item #})
1448 #(define-music-function (parser location dur dots arg)
1449 (integer? integer? ly:music?)
1450 (_i "Change the duration of @var{arg} by adding @var{dur} to the
1451 @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.")
1453 (shift-duration-log arg dur dots))
1456 #(define-music-function (parser location overrides music)
1457 (ly:music? ly:music?)
1458 (_i "Convert @var{overrides} to tweaks and apply them to @var{music}.
1459 This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.")
1460 (set! (ly:music-property music 'tweaks)
1462 (lambda (m) (eq? (ly:music-property m 'name)
1466 ((ly:music-property m 'grob-property #f) => list)
1468 (ly:music-property m 'grob-property-path)))))
1469 (acons (cons (ly:music-property m 'symbol) ;grob name
1471 p ;grob property path
1472 (car p))) ;grob property
1473 (ly:music-property m 'grob-value)
1475 (ly:music-property music 'tweaks)
1480 #(define-music-function (parser location dur) (ly:duration?)
1481 (_i "Skip forward by @var{dur}.")
1482 (make-music 'SkipMusic
1487 #(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic
1488 (_i "Create slashed graces (slashes through stems, but no slur) from
1489 the following music expression"))
1492 #(define-music-function (parser location parameters) (list?)
1493 (_i "Set the system stretch, by reading the 'system-stretch property of
1494 the `parameters' assoc list.")
1496 \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details
1497 #(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
1498 (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
1502 #(define-music-function (parser location style heads music)
1503 (symbol? symbol-list-or-symbol? ly:music?)
1504 (_i "Set @var{heads} in @var{music} to @var{style}.")
1505 (style-note-heads heads style music))
1508 #(define-music-function (parser location tags music) (symbol-list-or-symbol? ly:music?)
1509 (_i "Tag the following @var{music} with @var{tags} and return the
1510 result, by adding the single symbol or symbol list @var{tags} to the
1511 @code{tags} property of @var{music}.")
1514 (ly:music-property music 'tags)
1515 ((if (symbol? tags) cons append)
1517 (ly:music-property music 'tags)))
1521 #(define-void-function (parser location tags) (symbol-list?)
1522 (_i "Define a tag group comprising the symbols in the symbol list
1523 @var{tags}. Tag groups must not overlap.")
1524 (let ((err (define-tag-group tags)))
1525 (if err (ly:parser-error parser err location))))
1528 #(define-music-function (parser location music)
1530 (_i "Make any @code{\\override} in @var{music} replace an existing
1531 grob property value only temporarily, restoring the old value when a
1532 corresponding @code{\\revert} is executed. This is achieved by
1533 clearing the @samp{pop-first} property normally set on
1536 An @code{\\override}/@/@code{\\revert} sequence created by using
1537 @code{\\temporary} and @code{\\undo} on the same music containing
1538 overrides will cancel out perfectly or cause a@tie{}warning.
1540 Non-property-related music is ignored, warnings are generated for any
1541 property-changing music that isn't an @code{\\override}.")
1545 (and (or (music-is-of-type? m 'layout-instruction-event)
1546 (music-is-of-type? m 'context-specification)
1547 (music-is-of-type? m 'apply-context)
1548 (music-is-of-type? m 'time-signature-music))
1549 (case (ly:music-property m 'name)
1551 (if (ly:music-property m 'pop-first #f)
1552 (set! (ly:music-property m 'pop-first) '()))
1553 (if (ly:music-property m 'once #f)
1554 (set! (ly:music-property m 'once) '()))
1556 ((ContextSpeccedMusic)
1561 (ly:input-warning location (_ "Cannot make ~a revertible")
1562 (ly:music-property m 'name))
1569 #(define-music-function (parser location beat-structure fraction)
1570 ((number-list? '()) fraction?)
1571 (_i "Set @var{fraction} as time signature, with optional
1572 number list @var{beat-structure} before it.")
1573 (make-music 'TimeSignatureMusic
1574 'numerator (car fraction)
1575 'denominator (cdr fraction)
1576 'beat-structure beat-structure))
1579 #(define-music-function (parser location fraction music)
1580 (fraction? ly:music?)
1581 (_i "Scale @var{music} in time by @var{fraction}.")
1582 (make-music 'TimeScaledMusic
1583 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))
1584 'numerator (car fraction)
1585 'denominator (cdr fraction)))
1588 #(define-music-function
1589 (parser location from to music)
1590 (ly:pitch? ly:pitch? ly:music?)
1592 (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.")
1593 (make-music 'TransposedMusic
1594 'element (ly:music-transpose music (ly:pitch-diff to from))))
1596 transposedCueDuring =
1597 #(define-music-function
1598 (parser location what dir pitch main-music)
1599 (string? ly:dir? ly:pitch? ly:music?)
1601 (_i "Insert notes from the part @var{what} into a voice called @code{cue},
1602 using the transposition defined by @var{pitch}. This happens
1603 simultaneously with @var{main-music}, which is usually a rest. The
1604 argument @var{dir} determines whether the cue notes should be notated
1605 as a first or second voice.")
1607 (make-music 'QuoteMusic
1609 'quoted-context-type 'CueVoice
1610 'quoted-context-id "cue"
1611 'quoted-music-name what
1612 'quoted-voice-direction dir
1613 ;; following is inverse of instrumentTransposition for
1614 ;; historical reasons
1615 'quoted-transposition pitch))
1618 #(define-music-function (parser location pitch) (ly:pitch?)
1619 (_i "Set instrument transposition")
1622 (make-property-set 'instrumentTransposition pitch)
1626 #(define-music-function (parser location ratio tuplet-span music)
1627 (fraction? (ly:duration? '()) ly:music?)
1628 (_i "Scale the given @var{music} to tuplets. @var{ratio} is a
1629 fraction that specifies how many notes are played in place of the
1630 nominal value: it will be @samp{3/2} for triplets, namely three notes
1631 being played in place of two. If the optional duration
1632 @var{tuplet-span} is specified, it is used instead of
1633 @code{tupletSpannerDuration} for grouping the tuplets.
1636 \\tuplet 3/2 4 @{ c8 c c c c c @}
1638 will result in two groups of three tuplets, each group lasting for a
1640 (make-music 'TimeScaledMusic
1641 'element (ly:music-compress
1643 (ly:make-moment (cdr ratio) (car ratio)))
1644 'numerator (cdr ratio)
1645 'denominator (car ratio)
1646 'duration tuplet-span))
1649 #(define-music-function (parser location tuplet-span)
1651 (_i "Set @code{tupletSpannerDuration}, the length into which
1652 @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its
1653 own will group its tuplets, to the duration @var{tuplet-span}. To
1654 revert to the default of not subdividing the contents of a @code{\\tuplet}
1655 command without explicit @samp{tuplet-span}, use
1657 \\tupletSpan \\default
1661 #{ \set tupletSpannerDuration = #(ly:duration-length tuplet-span) #}
1662 #{ \unset tupletSpannerDuration #}))
1665 #(define-music-function (parser location prop value item)
1666 (symbol-list-or-symbol? scheme? symbol-list-or-music?)
1667 (_i "Add a tweak to the following @var{item}, usually music.
1668 Layout objects created by @var{item} get their property @var{prop}
1669 set to @var{value}. If @var{prop} has the form @samp{Grob.property}, like with
1671 \\tweak Accidental.color #red cis'
1673 an indirectly created grob (@samp{Accidental} is caused by
1674 @samp{NoteHead}) can be tweaked; otherwise only directly created grobs
1677 As a special case, @var{item} may be a symbol list specifying a grob
1678 path, in which case @code{\\override} is called on it instead of
1679 creating tweaked music. This is mainly useful when using
1680 @code{\\tweak} as as a component for building other functions.
1682 If this use case would call for @code{\\once \\override} rather than a
1683 plain @code{\\override}, writing @code{\\once \\tweak @dots{}} can be
1686 @var{prop} can contain additional elements in which case a nested
1687 property (inside of an alist) is tweaked.")
1688 (if (ly:music? item)
1689 (let ((p (check-grob-path prop parser location
1694 (set! (ly:music-property item 'tweaks)
1695 (acons (cond ((pair? (cddr p)) p)
1697 (cons (car p) (cadr p)))
1700 (ly:music-property item 'tweaks))))
1702 ;; We could just throw this at \override and let it sort this
1703 ;; out on its own, but this way we should get better error
1705 (let ((p (check-grob-path
1706 (append item (if (symbol? prop) (list prop) prop))
1708 #:default 'Bottom #:min 3)))
1710 #{ \override #p = #value #}
1711 (make-music 'Music)))))
1714 #(define-music-function (parser location music)
1716 (_i "Convert @code{\\override} and @code{\\set} in @var{music} to
1717 @code{\\revert} and @code{\\unset}, respectively. Any reverts and
1718 unsets already in @var{music} cause a warning. Non-property-related music is ignored.")
1725 (lambda (m) (or (music-is-of-type? m 'layout-instruction-event)
1726 (music-is-of-type? m 'context-specification)
1727 (music-is-of-type? m 'apply-context)
1728 (music-is-of-type? m 'time-signature-music)))
1729 (lambda (m overrides)
1730 (case (ly:music-property m 'name)
1733 (make-music 'RevertProperty
1734 'symbol (ly:music-property m 'symbol)
1737 ((ly:music-property m 'grob-property #f) => list)
1739 (ly:music-property m 'grob-property-path))))
1743 (make-music 'PropertyUnset
1744 'symbol (ly:music-property m 'symbol))
1746 ((ContextSpeccedMusic)
1748 (make-music 'ContextSpeccedMusic
1749 'element (loop (ly:music-property m 'element))
1750 'context-type (ly:music-property m 'context-type))
1755 (ly:input-warning location (_ "Cannot revert ~a")
1756 (ly:music-property m 'name))
1762 ((null? lst) (make-music 'Music))
1763 ((null? (cdr lst)) (car lst))
1764 (else (make-sequential-music lst))))))
1767 #(define-music-function (parser location music) (ly:music?)
1768 (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
1769 @code{\\repeat percent} commands in @var{music} to be interpreted
1770 as @code{\\repeat unfold}.")
1771 (unfold-repeats music))
1774 #(define-void-function (parser location arg) (scheme?)
1775 (_i "Accept a scheme argument, return a void expression.
1776 Use this if you want to have a scheme expression evaluated
1777 because of its side-effects, but its value ignored."))
1780 #(define-music-function (parser location sym val music)
1781 (symbol? scheme? ly:music?)
1782 (_i "Set @var{sym} to @var{val} in @var{music}.")
1784 (set! (ly:music-property music sym) val)