X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-music-types.scm;h=348bcd0e87228669e281cf379f5fc10332ac6396;hb=HEAD;hp=cdf5c0a6a1e1e92b5a8ef2f301894e0a53a5f031;hpb=60f27730ba854e18724b898f46055e6cd1cbce6f;p=lilypond.git diff --git a/scm/define-music-types.scm b/scm/define-music-types.scm index cdf5c0a6a1..348bcd0e87 100644 --- a/scm/define-music-types.scm +++ b/scm/define-music-types.scm @@ -1,7 +1,7 @@ ;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys -;;;; Jan Nieuwenhuizen +;;;; Copyright (C) 1998--2015 Han-Wen Nienhuys +;;;; Jan Nieuwenhuizen ;;;; ;;;; LilyPond is free software: you can redistribute it and/or modify ;;;; it under the terms of the GNU General Public License as published by @@ -16,6 +16,9 @@ ;;;; You should have received a copy of the GNU General Public License ;;;; along with LilyPond. If not, see . +;; for define-safe-public when byte-compiling using Guile V2 +(use-modules (scm safe-utility-defs)) + ;; TODO: should link back into user manual. (define-public music-descriptions @@ -26,20 +29,25 @@ Syntax: @var{note}@code{\\x}, where @code{\\x} is a dynamic mark like @code{\\ppp} or @code{\\sfz}. A complete list is in file @file{ly/@/dynamic-scripts-init.ly}.") - (types . (general-music event dynamic-event absolute-dynamic-event)) - )) + (types . (post-event event dynamic-event absolute-dynamic-event)) + )) + + (AlternativeEvent + . ((description . "Create an alternative event.") + (types . (event alternative-event)) + )) (AnnotateOutputEvent . ((description . "Print an annotation of an output element.") - (types . (general-music event annotate-output-event)) - )) + (types . (event annotate-output-event post-event)) + )) (ApplyContext . ((description . "Call the argument with the current context during interpreting phase.") - (types . (general-music apply-context)) - (iterator-ctor . ,ly:apply-context-iterator::constructor) - )) + (types . (apply-context)) + (iterator-ctor . ,ly:apply-context-iterator::constructor) + )) (ApplyOutputEvent . ((description . "Call the argument with all current grobs during @@ -49,109 +57,109 @@ Syntax: @code{\\applyOutput #'@var{context} @var{func}} Arguments to @var{func} are 1.@tie{}the grob, 2.@tie{}the originating context, and 3.@tie{}the context where @var{func} is called.") - (types . (general-music event apply-output-event)) - )) + (types . (event apply-output-event)) + )) (ArpeggioEvent . ((description . "Make an arpeggio on this note. -Syntax: @var{note}@code{-\\arpeggio}") - (types . (general-music arpeggio-event event)) - )) +Syntax: @w{@var{note}@code{-\\arpeggio}}") + (types . (post-event arpeggio-event event)) + )) ;; todo: use articulation-event for slur as well. ;; separate non articulation scripts (ArticulationEvent . ((description . "Add an articulation marking to a note. -Syntax: @var{note}@code{x}@code{y}, where @code{x} is a direction -(@code{^} for up or @code{_} for down), or LilyPond's choice -(no direction specified), and where @code{y} is an articulation -(such as @code{-.}, @code{->}, @code{\\tenuto}, @code{\\downbow}). +Syntax: @var{note}@code{x}@code{y}, where @code{x} is a direction\ +\n(@code{^} for up or @code{_} for down), or LilyPond's choice\ +\n(no direction specified), and where @code{y} is an articulation\ +\n(such as @w{@code{-.}}, @w{@code{->}}, @code{\\tenuto}, @code{\\downbow}). See the Notation Reference for details.") - (types . (general-music event articulation-event script-event)) - )) + (types . (post-event event articulation-event script-event)) + )) (AutoChangeMusic . ((description . "Used for making voices that switch between piano staves automatically.") - (iterator-ctor . ,ly:auto-change-iterator::constructor) - (start-callback . ,ly:music-wrapper::start-callback) - (length-callback . ,ly:music-wrapper::length-callback) - (types . (general-music music-wrapper-music auto-change-instruction)) - )) + (iterator-ctor . ,ly:auto-change-iterator::constructor) + (start-callback . ,ly:music-wrapper::start-callback) + (length-callback . ,ly:music-wrapper::length-callback) + (types . (music-wrapper-music auto-change-instruction)) + )) (BarCheck . ((description . "Check whether this music coincides with the start of the measure.") - (types . (general-music bar-check)) - (iterator-ctor . ,ly:bar-check-iterator::constructor) - )) + (types . (bar-check)) + (iterator-ctor . ,ly:bar-check-iterator::constructor) + )) (BassFigureEvent . ((description . "Print a bass-figure text.") - (types . (general-music event rhythmic-event bass-figure-event)) - )) + (types . (event rhythmic-event bass-figure-event)) + )) (BeamEvent . ((description . "Start or stop a beam. Syntax for manual control: @code{c8-[ c c-] c8}") - (types . (general-music event beam-event span-event)) - )) + (types . (post-event event beam-event span-event)) + )) (BeamForbidEvent . ((description . "Specify that a note may not auto-beamed.") - (types . (general-music event beam-forbid-event)) - )) + (types . (post-event event beam-forbid-event)) + )) (BreakDynamicSpanEvent . ((description . "End an alignment spanner for dynamics here.") - (types . (general-music break-span-event break-dynamic-span-event event)) - )) + (types . (post-event break-span-event break-dynamic-span-event event)) + )) (BendAfterEvent - . ((description . "A drop/fall/doit jazz articulation.") - (types . (general-music bend-after-event event)))) + . ((description . "A drop/@/fall/@/doit jazz articulation.") + (types . (post-event bend-after-event event)))) (BreathingEvent . ((description . "Create a @q{breath mark} or @q{comma}. Syntax: @var{note}@code{\\breathe}") - (types . (general-music event breathing-event)) - )) + (types . (event breathing-event)) + (midi-length . ,breathe::midi-length))) (ClusterNoteEvent . ((description . "A note that is part of a cluster.") - ;; not a note-event, to ensure that Note_heads_engraver doesn't eat it. - (types . (general-music cluster-note-event melodic-event - rhythmic-event event)) - )) + ;; not a note-event, to ensure that Note_heads_engraver doesn't eat it. + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) + (types . (cluster-note-event melodic-event rhythmic-event event)) + )) (CompletizeExtenderEvent . ((description . "Used internally to signal the end of a lyrics block to ensure extenders are completed correctly when a @code{Lyrics} context ends before its associated @code{Voice} context.") - (types . (general-music completize-extender-event event)) - )) + (types . (completize-extender-event event)) + )) (ContextChange . ((description . "Change staves in Piano staff. Syntax: @code{\\change Staff = @var{new-id}}") - (iterator-ctor . ,ly:change-iterator::constructor) - (types . (general-music translator-change-instruction)) - )) + (iterator-ctor . ,ly:change-iterator::constructor) + (types . (translator-change-instruction)) + )) (ContextSpeccedMusic . ((description . "Interpret the argument music within a specific context.") - (iterator-ctor . ,ly:context-specced-music-iterator::constructor) - (length-callback . ,ly:music-wrapper::length-callback) - (start-callback . ,ly:music-wrapper::start-callback) - (types . (context-specification general-music music-wrapper-music)) - )) + (iterator-ctor . ,ly:context-specced-music-iterator::constructor) + (length-callback . ,ly:music-wrapper::length-callback) + (start-callback . ,ly:music-wrapper::start-callback) + (types . (context-specification music-wrapper-music)) + )) (CrescendoEvent . ((description . "Begin or end a crescendo. @@ -160,9 +168,9 @@ Syntax: @var{note}@code{\\<} @dots{} @var{note}@code{\\!} An alternative syntax is @var{note}@code{\\cr} @dots{} @var{note}@code{\\endcr}.") - (types . (general-music span-event span-dynamic-event crescendo-event - event)) - )) + (types . (post-event span-event span-dynamic-event crescendo-event + event)) + )) (DecrescendoEvent . ((description . "Begin or end a decrescendo. @@ -171,111 +179,125 @@ Syntax: @var{note}@code{\\>} @dots{} @var{note}@code{\\!} An alternative syntax is @var{note}@code{\\decr} @dots{} @var{note}@code{\\enddecr}.") - (types . (general-music span-event span-dynamic-event decrescendo-event - event)) - )) + (types . (post-event span-event span-dynamic-event decrescendo-event + event)) + )) (DoublePercentEvent . ((description . "Used internally to signal double percent repeats.") - (types . (general-music event double-percent-event rhythmic-event)) - )) + (types . (event double-percent-event rhythmic-event)) + )) (EpisemaEvent . ((description . "Begin or end an episema.") - (types . (general-music span-event event episema-event)) - )) + (types . (post-event span-event event episema-event)) + )) (Event . ((description . "Atomic music event.") - (types . (general-music event)) - )) + (types . (event)) + )) (EventChord - . ((description . "Internally used to group a set of events.") - (iterator-ctor . ,ly:event-chord-iterator::constructor) - (length-callback . ,ly:music-sequence::maximum-length-callback) - (to-relative-callback . - ,ly:music-sequence::event-chord-relative-callback) - (types . (general-music event-chord simultaneous-music)) - )) + . ((description . "Explicitly entered chords. + +When iterated, @code{elements} are converted to events at the current +timestep, followed by any @code{articulations}. Per-chord postevents +attached by the parser just follow any rhythmic events in +@code{elements} instead of utilizing @code{articulations}. + +An unexpanded chord repetition @samp{q} is recognizable by having its +duration stored in @code{duration}.") + (iterator-ctor . ,ly:event-chord-iterator::constructor) + (length-callback . ,ly:music-sequence::event-chord-length-callback) + (to-relative-callback . + ,ly:music-sequence::event-chord-relative-callback) + (types . (event-chord simultaneous-music)) + )) (ExtenderEvent . ((description . "Extend lyrics.") - (types . (general-music extender-event event)) - )) + (types . (post-event extender-event event)) + )) (FingeringEvent . ((description . "Specify what finger to use for this note.") - (types . (general-music fingering-event event)) - )) + (types . (post-event fingering-event event)) + )) + + (FootnoteEvent + . ((description . "Footnote a grob.") + (types . (event footnote-event)) + )) (GlissandoEvent . ((description . "Start a glissando on this note.") - (types . (general-music glissando-event event)) - )) + (types . (post-event glissando-event event)) + )) (GraceMusic . ((description . "Interpret the argument as grace notes.") - (start-callback . ,ly:grace-music::start-callback) - (length . ,ZERO-MOMENT) - (iterator-ctor . ,ly:grace-iterator::constructor) - (types . (grace-music music-wrapper-music general-music)) - )) + (start-callback . ,ly:grace-music::start-callback) + (length . ,ZERO-MOMENT) + (iterator-ctor . ,ly:grace-iterator::constructor) + (types . (grace-music music-wrapper-music)) + )) (HarmonicEvent . ((description . "Mark a note as harmonic.") - (types . (general-music event harmonic-event)) - )) + (types . (post-event event harmonic-event)) + )) (HyphenEvent . ((description . "A hyphen between lyric syllables.") - (types . (general-music hyphen-event event)) - )) + (types . (post-event hyphen-event event)) + )) (KeyChangeEvent . ((description . "Change the key signature. Syntax: @code{\\key} @var{name} @var{scale}") - (to-relative-callback . ,(lambda (x p) p)) - (types . (general-music key-change-event event)) - )) + (to-relative-callback . ,(lambda (x p) p)) + (types . (key-change-event event)) + )) (LabelEvent . ((description . "Place a bookmarking label.") - (types . (general-music label-event event)) - )) + (types . (label-event event)) + )) (LaissezVibrerEvent . ((description . "Don't damp this chord. Syntax: @var{note}@code{\\laissezVibrer}") - (types . (general-music event laissez-vibrer-event)) - )) + (types . (post-event event laissez-vibrer-event)) + )) (LigatureEvent . ((description . "Start or end a ligature.") - (types . (general-music span-event ligature-event event)) - )) + (types . (span-event ligature-event event)) + )) (LineBreakEvent . ((description . "Allow, forbid or force a line break.") - (types . (general-music line-break-event break-event event)) - )) + (types . (line-break-event break-event event)) + )) (LyricCombineMusic . ((description . "Align lyrics to the start of notes. Syntax: @code{\\lyricsto} @var{voicename} @var{lyrics}") - (length . ,ZERO-MOMENT) - (types . (general-music lyric-combine-music)) - (iterator-ctor . ,ly:lyric-combine-music-iterator::constructor) - )) + (length . ,ZERO-MOMENT) + (types . (lyric-combine-music)) + (iterator-ctor . ,ly:lyric-combine-music-iterator::constructor) + )) (LyricEvent . ((description . "A lyric syllable. Must be entered in lyrics mode, i.e., @code{\\lyrics @{ twinkle4 twinkle4 @} }.") - (types . (general-music rhythmic-event lyric-event event)) - )) + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) + (types . (rhythmic-event lyric-event event)) + )) (MarkEvent . ((description . "Insert a rehearsal mark. @@ -283,24 +305,29 @@ i.e., @code{\\lyrics @{ twinkle4 twinkle4 @} }.") Syntax: @code{\\mark} @var{marker} Example: @code{\\mark \"A\"}") - (types . (general-music mark-event event)) - )) + (types . (mark-event event)) + )) + + (MeasureCounterEvent + . ((description . "Used to signal the start and end of a measure count.") + (types . (measure-counter-event span-event event)) + )) (MultiMeasureRestEvent . ((description . "Used internally by @code{MultiMeasureRestMusic} to signal rests.") - (types . (general-music event rhythmic-event - multi-measure-rest-event)) - )) + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) + (types . (event rhythmic-event multi-measure-rest-event)) + )) (MultiMeasureRestMusic . ((description . "Rests that may be compressed into Multi rests. Syntax: @code{R2.*4} for 4 measures in 3/4 time.") - (iterator-ctor . ,ly:sequential-iterator::constructor) - (elements-callback . ,mm-rest-child-list) - (types . (general-music multi-measure-rest)) - )) + (iterator-ctor . ,ly:sequential-iterator::constructor) + (elements-callback . ,mm-rest-child-list) + (types . (multi-measure-rest)) + )) (MultiMeasureTextEvent . ((description . "Texts on multi measure rests. @@ -308,404 +335,424 @@ Syntax: @code{R2.*4} for 4 measures in 3/4 time.") Syntax: @code{R-\\markup @{ \\roman \"bla\" @}} Note the explicit font switch.") - (types . (general-music event multi-measure-text-event)) - )) + (types . (post-event event multi-measure-text-event)) + )) (Music . ((description . "Generic type for music expressions.") - (types . (general-music)) - )) + (types . ()) + )) (NoteEvent - . ((description . "A note.") - (types . (general-music event note-event rhythmic-event - melodic-event)) - )) + . ((description . "A note. + +Outside of chords, any events in @code{articulations} with a listener +are broadcast like chord articulations, the others are retained. + +For iteration inside of chords, @xref{EventChord}.") + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) + (types . (event note-event rhythmic-event melodic-event)) + )) (NoteGroupingEvent . ((description . "Start or stop grouping brackets.") - (types . (general-music event note-grouping-event)) - )) + (types . (post-event event note-grouping-event)) + )) (OttavaMusic . ((description . "Start or stop an ottava bracket.") - (iterator-ctor . ,ly:sequential-iterator::constructor) - (elements-callback . ,make-ottava-set) - (types . (general-music ottava-music)) - )) + (iterator-ctor . ,ly:sequential-iterator::constructor) + (elements-callback . ,make-ottava-set) + (types . (ottava-music)) + )) (OverrideProperty . ((description . "Extend the definition of a graphical object. Syntax: @code{\\override} [ @var{context} @code{.} ] @var{object} @var{property} @code{=} @var{value}") - (types . (general-music layout-instruction-event - override-property-event)) - (iterator-ctor . ,ly:push-property-iterator::constructor) - )) + (types . (layout-instruction-event override-property-event)) + (iterator-ctor . ,ly:push-property-iterator::constructor) + (untransposable . #t) + )) (PageBreakEvent . ((description . "Allow, forbid or force a page break.") - (types . (general-music break-event page-break-event event)) - )) + (types . (break-event page-break-event event)) + )) (PageTurnEvent . ((description . "Allow, forbid or force a page turn.") - (types . (general-music break-event page-turn-event event)) - )) - - (PartCombineForceEvent - . ((description . "Override the part-combiner's strategy.") - (types . (general-music part-combine-force-event event)) - )) + (types . (break-event page-turn-event event)) + )) (PartialSet . ((description . "Create an anacrusis or upbeat (partial measure).") - (iterator-ctor . ,ly:partial-iterator::constructor) - (types . (general-music partial-set)) + (iterator-ctor . ,ly:partial-iterator::constructor) + ;; The length-callback is kind of cheesy since 'elements is + ;; empty. We just use that in order to get a zero length + ;; for the overall timing in spite of having a non-zero + ;; duration field. + (length-callback . ,ly:music-sequence::cumulative-length-callback) + (types . (partial-set)) )) (PartCombineMusic . ((description . "Combine two parts on a staff, either merged or as separate voices.") - (length-callback . ,ly:music-sequence::maximum-length-callback) - (start-callback . ,ly:music-sequence::minimum-start-callback) - (types . (general-music part-combine-music)) - (iterator-ctor . ,ly:part-combine-iterator::constructor) - )) + (length-callback . ,ly:music-sequence::maximum-length-callback) + (start-callback . ,ly:music-sequence::minimum-start-callback) + (types . (part-combine-music)) + (iterator-ctor . ,ly:part-combine-iterator::constructor) + )) + + (PartCombinePartMusic + . ((description . "A part to be combined with other parts on a staff.") + (length-callback . ,ly:music-wrapper::length-callback) + (start-callback . ,ly:music-wrapper::start-callback) + (iterator-ctor . ,ly:part-combine-part-iterator::constructor) + (types . (part-combine-part-music music-wrapper-music)) + )) (PercentEvent . ((description . "Used internally to signal percent repeats.") - (types . (general-music event percent-event rhythmic-event)) - )) + (types . (event percent-event rhythmic-event)) + )) (PercentRepeatedMusic . ((description . "Repeats encoded by percents and slashes.") - (iterator-ctor . ,ly:percent-repeat-iterator::constructor) - (start-callback . ,ly:repeated-music::first-start) - (length-callback . ,ly:repeated-music::unfolded-music-length) - (types . (general-music repeated-music percent-repeated-music)) - )) + (iterator-ctor . ,ly:percent-repeat-iterator::constructor) + (start-callback . ,ly:repeated-music::first-start) + (length-callback . ,ly:repeated-music::unfolded-music-length) + (types . (repeated-music percent-repeated-music)) + )) (PesOrFlexaEvent . ((description . "Within a ligature, mark the previous and the following note to form a pes (if melody goes up) or a flexa (if melody goes down).") - (types . (general-music pes-or-flexa-event event)) - )) + (types . (pes-or-flexa-event event)) + )) (PhrasingSlurEvent . ((description . "Start or end phrasing slur. Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}") - (types . (general-music span-event event phrasing-slur-event)) - )) + (types . (post-event span-event event phrasing-slur-event)) + )) + + (PostEvents + . ((description . "Container for several postevents. + +This can be used to package several events into a single one. Should not be seen outside of the parser.") + (types . (post-event post-event-wrapper)))) (PropertySet . ((description . "Set a context property. Syntax: @code{\\set @var{context}.@var{prop} = @var{scheme-val}}") - (types . (layout-instruction-event general-music)) - (iterator-ctor . ,ly:property-iterator::constructor) - )) + (types . (layout-instruction-event)) + (iterator-ctor . ,ly:property-iterator::constructor) + (untransposable . #t) + )) (PropertyUnset . ((description . "Restore the default setting for a context property. See @ref{PropertySet}. Syntax: @code{\\unset @var{context}.@var{prop}}") - (types . (layout-instruction-event general-music)) - (iterator-ctor . ,ly:property-unset-iterator::constructor) - )) + (types . (layout-instruction-event)) + (iterator-ctor . ,ly:property-unset-iterator::constructor) + )) (QuoteMusic . ((description . "Quote preprocessed snippets of music.") - (iterator-ctor . ,ly:music-wrapper-iterator::constructor) - (length-callback . ,ly:music-wrapper::length-callback) - (start-callback . ,ly:music-wrapper::start-callback) - (types . (general-music music-wrapper-music)) - )) + (iterator-ctor . ,ly:music-wrapper-iterator::constructor) + (length-callback . ,ly:music-wrapper::length-callback) + (start-callback . ,ly:music-wrapper::start-callback) + (types . (music-wrapper-music)) + )) (RelativeOctaveCheck . ((description . "Check if a pitch is in the correct octave.") - (to-relative-callback . ,ly:relative-octave-check::relative-callback) - (types . (general-music relative-octave-check)) - )) + (to-relative-callback . ,ly:relative-octave-check::relative-callback) + (types . (relative-octave-check)) + )) (RelativeOctaveMusic - . ((description . "Music that was entered in relative octave notation.") - (to-relative-callback . ,ly:relative-octave-music::relative-callback) - (iterator-ctor . ,ly:music-wrapper-iterator::constructor) - (length-callback . ,ly:music-wrapper::length-callback) - (start-callback . ,ly:music-wrapper::start-callback) - (types . (music-wrapper-music general-music relative-octave-music)) - )) - - (RepeatedChord - . ((description . "A chord repetition") - (to-relative-callback . ,ly:music-sequence::repeated-chord-relative-callback) - (iterator-ctor . ,ly:music-wrapper-iterator::constructor) - (start-callback . ,ly:music-wrapper::start-callback) - (length-callback . ,ly:music-wrapper::length-callback) - (types . (general-music music-wrapper-music)) - )) + . ((description . "Music in which the assignment of octaves is complete.") + (to-relative-callback . ,ly:relative-octave-music::relative-callback) + (iterator-ctor . ,ly:music-wrapper-iterator::constructor) + (length-callback . ,ly:music-wrapper::length-callback) + (start-callback . ,ly:music-wrapper::start-callback) + (types . (music-wrapper-music relative-octave-music)) + )) (RepeatedMusic . ((description . "Repeat music in different ways.") - (types . (general-music repeated-music)) - )) + (types . (repeated-music)) + )) (RepeatSlashEvent . ((description . "Used internally to signal beat repeats.") - (types . (general-music event repeat-slash-event rhythmic-event)) - )) + (types . (event repeat-slash-event rhythmic-event)) + )) (RepeatTieEvent . ((description . "Ties for starting a second volta bracket.") - (types . (general-music event repeat-tie-event)) - )) + (types . (post-event event repeat-tie-event)) + )) (RestEvent . ((description . "A Rest. Syntax: @code{r4} for a quarter rest.") - (types . (general-music event rhythmic-event rest-event)) - )) + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) + (types . (event rhythmic-event rest-event)) + )) (RevertProperty . ((description . "The opposite of @ref{OverrideProperty}: remove a previously added property from a graphical object definition.") - (types . (general-music layout-instruction-event)) - (iterator-ctor . ,ly:pop-property-iterator::constructor) - )) + (types . (layout-instruction-event)) + (iterator-ctor . ,ly:pop-property-iterator::constructor) + )) (ScriptEvent . ((description . "Add an articulation mark to a note.") - (types . (general-music event)) - )) + (types . (event)) + )) (SequentialMusic . ((description . "Music expressions concatenated. Syntax: @code{\\sequential @{ @dots{} @}} or simply @code{@{ @dots{} @}}") - (length-callback . ,ly:music-sequence::cumulative-length-callback) - (start-callback . ,ly:music-sequence::first-start-callback) - (elements-callback . ,(lambda (m) (ly:music-property m 'elements))) - (iterator-ctor . ,ly:sequential-iterator::constructor) - (types . (general-music sequential-music)) - )) + (length-callback . ,ly:music-sequence::cumulative-length-callback) + (start-callback . ,ly:music-sequence::first-start-callback) + (elements-callback . ,(lambda (m) (ly:music-property m 'elements))) + (iterator-ctor . ,ly:sequential-iterator::constructor) + (types . (sequential-music)) + )) (SimultaneousMusic . ((description . "Music playing together. Syntax: @code{\\simultaneous @{ @dots{} @}} or @code{<< @dots{} >>}") - (iterator-ctor . ,ly:simultaneous-music-iterator::constructor) - (start-callback . ,ly:music-sequence::minimum-start-callback) - (length-callback . ,ly:music-sequence::maximum-length-callback) - (to-relative-callback . - ,ly:music-sequence::simultaneous-relative-callback) - (types . (general-music simultaneous-music)) - )) + (iterator-ctor . ,ly:simultaneous-music-iterator::constructor) + (start-callback . ,ly:music-sequence::minimum-start-callback) + (length-callback . ,ly:music-sequence::maximum-length-callback) + (to-relative-callback . + ,ly:music-sequence::simultaneous-relative-callback) + (types . (simultaneous-music)) + )) (SkipEvent . ((description . "Filler that takes up duration, but does not print anything. Syntax: @code{s4} for a skip equivalent to a quarter rest.") - (types . (general-music event rhythmic-event skip-event)) - )) + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) + (types . (event rhythmic-event skip-event)) + )) (SkipMusic . ((description . "Filler that takes up duration, does not print anything, and also does not create staves or voices implicitly. Syntax: @code{\\skip} @var{duration}") - (length-callback . ,ly:music-duration-length) - (iterator-ctor . ,ly:simple-music-iterator::constructor) - (types . (general-music event rhythmic-event skip-event)) - )) + (length-callback . ,ly:music-duration-length) + (iterator-ctor . ,ly:simple-music-iterator::constructor) + (types . (event skip-event)) + )) (SlurEvent . ((description . "Start or end slur. Syntax: @var{note}@code{(} and @var{note}@code{)}") - (types . (general-music span-event event slur-event)) - )) + (types . (post-event span-event event slur-event)) + )) (SoloOneEvent . ((description . "Print @q{Solo@tie{}1}.") - (part-combine-status . solo1) - (types . (general-music event part-combine-event solo-one-event)) - )) + (part-combine-status . solo1) + (types . (event part-combine-event solo-one-event)) + )) (SoloTwoEvent . ((description . "Print @q{Solo@tie{}2}.") - (part-combine-status . solo2) - (types . (general-music event part-combine-event solo-two-event)) - )) + (part-combine-status . solo2) + (types . (event part-combine-event solo-two-event)) + )) (SostenutoEvent . ((description . "Depress or release sostenuto pedal.") - (types . (general-music event pedal-event sostenuto-event)) - )) + (types . (post-event event pedal-event sostenuto-event)) + )) (SpacingSectionEvent . ((description . "Start a new spacing section.") - (types . (general-music event spacing-section-event)))) + (types . (event spacing-section-event)))) (SpanEvent . ((description . "Event for anything that is started at a different time than stopped.") - (types . (general-music event)) - )) + (types . (event)) + )) (StaffSpanEvent . ((description . "Start or stop a staff symbol.") - (types . (general-music event span-event staff-span-event)) - )) + (types . (event span-event staff-span-event)) + )) (StringNumberEvent . ((description . "Specify on which string to play this note. Syntax: @code{\\@var{number}}") - (types . (general-music string-number-event event)) - )) + (types . (post-event string-number-event event)) + )) (StrokeFingerEvent . ((description . "Specify with which finger to pluck a string. Syntax: @code{\\rightHandFinger @var{text}}") - (types . (general-music stroke-finger-event event)) - )) + (types . (post-event stroke-finger-event event)) + )) (SustainEvent . ((description . "Depress or release sustain pedal.") - (types . (general-music event pedal-event sustain-event)) - )) + (types . (post-event event pedal-event sustain-event)) + )) (TempoChangeEvent . ((description . "A metronome mark or tempo indication.") - (types . (general-music event tempo-change-event)) - )) + (types . (event tempo-change-event)) + )) (TextScriptEvent . ((description . "Print text.") - (types . (general-music script-event text-script-event event)) - )) + (types . (post-event script-event text-script-event event)) + )) (TextSpanEvent . ((description . "Start a text spanner, for example, an octavation.") - (types . (general-music span-event event text-span-event)) - )) + (types . (post-event span-event event text-span-event)) + )) (TieEvent . ((description . "A tie. -Syntax: @var{note}@code{-~}") - (types . (general-music tie-event event)) - )) +Syntax: @w{@var{note}@code{-~}}") + (types . (post-event tie-event event)) + )) (TimeScaledMusic . ((description . "Multiply durations, as in tuplets. Syntax: @code{\\times @var{fraction} @var{music}}, e.g., @code{\\times 2/3 @{ @dots{} @}} for triplets.") - (length-callback . ,ly:music-wrapper::length-callback) - (start-callback . ,ly:music-wrapper::start-callback) - (iterator-ctor . ,ly:tuplet-iterator::constructor) - (types . (time-scaled-music music-wrapper-music general-music)) - )) + (length-callback . ,ly:music-wrapper::length-callback) + (start-callback . ,ly:music-wrapper::start-callback) + (iterator-ctor . ,ly:tuplet-iterator::constructor) + (types . (time-scaled-music music-wrapper-music)) + )) (TimeSignatureMusic . ((description . "Set a new time signature") (iterator-ctor . ,ly:sequential-iterator::constructor) (elements-callback . ,make-time-signature-set) - (types . (general-music time-signature-music)) + (types . (time-signature-music)) + )) + + (TimeSignatureEvent + . ((description . "An event created when setting a new time signature") + (types . (event time-signature-event)) )) (TransposedMusic . ((description . "Music that has been transposed.") - (iterator-ctor . ,ly:music-wrapper-iterator::constructor) - (start-callback . ,ly:music-wrapper::start-callback) - (length-callback . ,ly:music-wrapper::length-callback) - (to-relative-callback . - ,ly:relative-octave-music::no-relative-callback) - (types . (music-wrapper-music general-music transposed-music)) - )) + (iterator-ctor . ,ly:music-wrapper-iterator::constructor) + (start-callback . ,ly:music-wrapper::start-callback) + (length-callback . ,ly:music-wrapper::length-callback) + (to-relative-callback . + ,ly:relative-octave-music::no-relative-callback) + (types . (music-wrapper-music transposed-music)) + )) (TremoloEvent . ((description . "Unmeasured tremolo.") - (types . (general-music event tremolo-event)) - )) + (types . (post-event event tremolo-event)) + )) (TremoloRepeatedMusic . ((description . "Repeated notes denoted by tremolo beams.") - (iterator-ctor . ,ly:chord-tremolo-iterator::constructor) - (start-callback . ,ly:repeated-music::first-start) - ;; the length of the repeat is handled by shifting the note logs - (length-callback . ,ly:repeated-music::folded-music-length) - (types . (general-music repeated-music tremolo-repeated-music)) - )) + (iterator-ctor . ,ly:chord-tremolo-iterator::constructor) + (start-callback . ,ly:repeated-music::first-start) + (length-callback . ,ly:repeated-music::unfolded-music-length) + (types . (repeated-music tremolo-repeated-music)) + )) (TremoloSpanEvent . ((description . "Tremolo over two stems.") - (types . (general-music event span-event tremolo-span-event)) - )) + (types . (event span-event tremolo-span-event)) + )) (TrillSpanEvent . ((description . "Start a trill spanner.") - (types . (general-music span-event event trill-span-event)) - )) + (types . (post-event span-event event trill-span-event)) + )) (TupletSpanEvent . ((description . "Used internally to signal where tuplet brackets start and stop.") - (types . (tuplet-span-event span-event event general-music)) - )) + (types . (tuplet-span-event span-event event post-event)) + )) (UnaCordaEvent . ((description . "Depress or release una-corda pedal.") - (types . (general-music event pedal-event una-corda-event)) - )) + (types . (post-event event pedal-event una-corda-event)) + )) (UnfoldedRepeatedMusic - . ((description . "Repeated music which is fully written -(and played) out.") - (iterator-ctor . ,ly:unfolded-repeat-iterator::constructor) - (start-callback . ,ly:repeated-music::first-start) - (types . (general-music repeated-music unfolded-repeated-music)) - (length-callback . ,ly:repeated-music::unfolded-music-length) - )) + . ((description . "Repeated music which is fully written (and +played) out.") + (iterator-ctor . ,ly:sequential-iterator::constructor) + (elements-callback . ,make-unfolded-set) + (start-callback . ,ly:repeated-music::first-start) + (types . (repeated-music unfolded-repeated-music)) + (length-callback . ,ly:repeated-music::unfolded-music-length) + )) (UnisonoEvent . ((description . "Print @q{a@tie{}2}.") - (part-combine-status . unisono) - (types . (general-music event part-combine-event unisono-event)))) + (part-combine-status . unisono) + (types . (event part-combine-event unisono-event)))) (UnrelativableMusic . ((description . "Music that cannot be converted from relative to absolute notation. For example, transposed music.") - (to-relative-callback . ,ly:relative-octave-music::no-relative-callback) - (iterator-ctor . ,ly:music-wrapper-iterator::constructor) - (length-callback . ,ly:music-wrapper::length-callback) - (types . (music-wrapper-music general-music unrelativable-music)) - )) + (to-relative-callback . ,ly:relative-octave-music::no-relative-callback) + (iterator-ctor . ,ly:music-wrapper-iterator::constructor) + (length-callback . ,ly:music-wrapper::length-callback) + (start-callback . ,ly:music-wrapper::start-callback) + (types . (music-wrapper-music unrelativable-music)) + )) (VoiceSeparator . ((description . "Separate polyphonic voices in simultaneous music. Syntax: @code{\\\\}") - (types . (separator general-music)) - )) + (types . (separator)) + )) (VoltaRepeatedMusic . ((description . "Repeats with alternatives placed sequentially.") - (iterator-ctor . ,ly:volta-repeat-iterator::constructor) - (start-callback . ,ly:repeated-music::first-start) - (length-callback . ,ly:repeated-music::volta-music-length) - (types . (general-music repeated-music volta-repeated-music)) - )) + (iterator-ctor . ,ly:volta-repeat-iterator::constructor) + (elements-callback . ,make-volta-set) + (start-callback . ,ly:repeated-music::first-start) + (length-callback . ,ly:repeated-music::volta-music-length) + (types . (repeated-music volta-repeated-music)) + )) )) (set! music-descriptions @@ -718,48 +765,57 @@ Syntax: @code{\\\\}") (set! music-descriptions (map (lambda (x) - (set-object-property! (car x) - 'music-description - (cdr (assq 'description (cdr x)))) - (let ((lst (cdr x))) - (set! lst (assoc-set! lst 'name (car x))) - (set! lst (assq-remove! lst 'description)) - (hashq-set! music-name-to-property-table (car x) lst) - (cons (car x) lst))) + (set-object-property! (car x) + 'music-description + (cdr (assq 'description (cdr x)))) + (let ((lst (cdr x))) + (set! lst (assoc-set! lst 'name (car x))) + (set! lst (assq-remove! lst 'description)) + (hashq-set! music-name-to-property-table (car x) lst) + (cons (car x) lst))) music-descriptions)) (define-safe-public (make-music name . music-properties) "Create a music object of given name, and set its properties according to @code{music-properties}, a list of alternating property symbols and values. E.g: +@example (make-music 'OverrideProperty - 'symbol 'Stem - 'grob-property 'thickness - 'grob-value (* 2 1.5))" + 'symbol 'Stem + 'grob-property 'thickness + 'grob-value (* 2 1.5)) +@end example +Instead of a successive symbol and value, an entry in the list may +also be an alist or a music object in which case its elements, +respectively its @emph{mutable} property list (properties not inherent +to the type of the music object) will get taken. + +The argument list will be interpreted left-to-right, so later entries +override earlier ones." (if (not (symbol? name)) (ly:error (_ "symbol expected: ~S") name)) (let ((props (hashq-ref music-name-to-property-table name '()))) (if (not (pair? props)) - (ly:error (_ "cannot find music object: ~S") name)) + (ly:error (_ "cannot find music object: ~S") name)) (let ((m (ly:make-music props))) + (define (alist-set-props lst) + (for-each (lambda (e) + (set! (ly:music-property m (car e)) (cdr e))) + (reverse lst))) (define (set-props mus-props) - (if (and (not (null? mus-props)) - (not (null? (cdr mus-props)))) - (begin - (set! (ly:music-property m (car mus-props)) (cadr mus-props)) - (set-props (cddr mus-props))))) + (if (pair? mus-props) + (let ((e (car mus-props)) + (mus-props (cdr mus-props))) + (cond ((symbol? e) + (set! (ly:music-property m e) (car mus-props)) + (set-props (cdr mus-props))) + ((ly:music? e) + (alist-set-props (ly:music-mutable-properties e)) + (set-props mus-props)) + ((cheap-list? e) + (alist-set-props e) + (set-props mus-props)) + (else + (ly:error (_ "bad make-music argument: ~S") e)))))) (set-props music-properties) m))) - -(define-public (make-repeated-music name) - (let* ((repeated-music (assoc-get name '(("volta" . VoltaRepeatedMusic) - ("unfold" . UnfoldedRepeatedMusic) - ("percent" . PercentRepeatedMusic) - ("tremolo" . TremoloRepeatedMusic)))) - (repeated-music-name (if repeated-music - repeated-music - (begin - (ly:warning (_ "unknown repeat type `~S'") name) - (ly:warning (_ "See define-music-types.scm for supported repeats")) - 'VoltaRepeatedMusic)))) - (make-music repeated-music-name)))