X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-music-types.scm;h=1090d332b49aec21b01fcf852f1f19fc158f7889;hb=65025034b83aac9c6ad14ce9a0fb65639634575c;hp=4085957e032d29178d8b4ccb8bef402d8e843b8c;hpb=a066a93ee74edebb9d238a1bac93c3bc7e8e6e4a;p=lilypond.git diff --git a/scm/define-music-types.scm b/scm/define-music-types.scm index 4085957e03..1090d332b4 100644 --- a/scm/define-music-types.scm +++ b/scm/define-music-types.scm @@ -1,6 +1,6 @@ ;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys +;;;; Copyright (C) 1998--2012 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen ;;;; ;;;; LilyPond is free software: you can redistribute it and/or modify @@ -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,12 +29,17 @@ 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 . (general-music post-event event dynamic-event absolute-dynamic-event)) + )) + + (AlternativeEvent + . ((description . "Create a alternative event.") + (types . (general-music event alternative-event)) )) (AnnotateOutputEvent . ((description . "Print an annotation of an output element.") - (types . (general-music event annotate-output-event)) + (types . (general-music event annotate-output-event post-event)) )) (ApplyContext @@ -56,7 +64,7 @@ context, and 3.@tie{}the context where @var{func} is called.") . ((description . "Make an arpeggio on this note. Syntax: @w{@var{note}@code{-\\arpeggio}}") - (types . (general-music arpeggio-event event)) + (types . (general-music post-event arpeggio-event event)) )) ;; todo: use articulation-event for slur as well. @@ -64,12 +72,12 @@ Syntax: @w{@var{note}@code{-\\arpeggio}}") (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 @w{@code{-.}}, @w{@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 . (general-music post-event event articulation-event script-event)) )) (AutoChangeMusic @@ -97,22 +105,22 @@ the start of the measure.") . ((description . "Start or stop a beam. Syntax for manual control: @code{c8-[ c c-] c8}") - (types . (general-music event beam-event span-event)) + (types . (general-music 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 . (general-music 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 . (general-music 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)))) + (types . (general-music post-event bend-after-event event)))) (BreathingEvent . ((description . "Create a @q{breath mark} or @q{comma}. @@ -125,6 +133,7 @@ Syntax: @var{note}@code{\\breathe}") (ClusterNoteEvent . ((description . "A note that is part of a cluster.") ;; not a note-event, to ensure that Note_heads_engraver doesn't eat it. + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) (types . (general-music cluster-note-event melodic-event rhythmic-event event)) )) @@ -160,7 +169,7 @@ 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 + (types . (general-music post-event span-event span-dynamic-event crescendo-event event)) )) @@ -171,7 +180,7 @@ 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 + (types . (general-music post-event span-event span-dynamic-event decrescendo-event event)) )) @@ -182,7 +191,7 @@ An alternative syntax is @var{note}@code{\\decr} @dots{} (EpisemaEvent . ((description . "Begin or end an episema.") - (types . (general-music span-event event episema-event)) + (types . (general-music post-event span-event event episema-event)) )) (Event @@ -191,9 +200,17 @@ An alternative syntax is @var{note}@code{\\decr} @dots{} )) (EventChord - . ((description . "Internally used to group a set of events.") + . ((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::maximum-length-callback) + (length-callback . ,ly:music-sequence::event-chord-length-callback) (to-relative-callback . ,ly:music-sequence::event-chord-relative-callback) (types . (general-music event-chord simultaneous-music)) @@ -201,12 +218,12 @@ An alternative syntax is @var{note}@code{\\decr} @dots{} (ExtenderEvent . ((description . "Extend lyrics.") - (types . (general-music extender-event event)) + (types . (general-music post-event extender-event event)) )) (FingeringEvent . ((description . "Specify what finger to use for this note.") - (types . (general-music fingering-event event)) + (types . (general-music post-event fingering-event event)) )) (FootnoteEvent @@ -216,7 +233,7 @@ An alternative syntax is @var{note}@code{\\decr} @dots{} (GlissandoEvent . ((description . "Start a glissando on this note.") - (types . (general-music glissando-event event)) + (types . (general-music post-event glissando-event event)) )) (GraceMusic @@ -229,12 +246,12 @@ An alternative syntax is @var{note}@code{\\decr} @dots{} (HarmonicEvent . ((description . "Mark a note as harmonic.") - (types . (general-music event harmonic-event)) + (types . (general-music post-event event harmonic-event)) )) (HyphenEvent . ((description . "A hyphen between lyric syllables.") - (types . (general-music hyphen-event event)) + (types . (general-music post-event hyphen-event event)) )) (KeyChangeEvent @@ -254,7 +271,7 @@ Syntax: @code{\\key} @var{name} @var{scale}") . ((description . "Don't damp this chord. Syntax: @var{note}@code{\\laissezVibrer}") - (types . (general-music event laissez-vibrer-event)) + (types . (general-music post-event event laissez-vibrer-event)) )) (LigatureEvent @@ -279,6 +296,7 @@ Syntax: @code{\\lyricsto} @var{voicename} @var{lyrics}") (LyricEvent . ((description . "A lyric syllable. Must be entered in lyrics mode, i.e., @code{\\lyrics @{ twinkle4 twinkle4 @} }.") + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) (types . (general-music rhythmic-event lyric-event event)) )) @@ -291,6 +309,11 @@ Example: @code{\\mark \"A\"}") (types . (general-music mark-event event)) )) + (MeasureCounterEvent + . ((description . "Used to signal the start and end of a measure count.") + (types . (general-music measure-counter-event span-event event)) + )) + (MultiMeasureRestEvent . ((description . "Used internally by @code{MultiMeasureRestMusic} to signal rests.") @@ -313,7 +336,7 @@ 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 . (general-music post-event event multi-measure-text-event)) )) (Music @@ -322,14 +345,20 @@ Note the explicit font switch.") )) (NoteEvent - . ((description . "A note.") + . ((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 . (general-music event note-event rhythmic-event melodic-event)) )) (NoteGroupingEvent . ((description . "Start or stop grouping brackets.") - (types . (general-music event note-grouping-event)) + (types . (general-music post-event event note-grouping-event)) )) (OttavaMusic @@ -347,6 +376,7 @@ Syntax: @code{\\override} [ @var{context} @code{.} ] (types . (general-music layout-instruction-event override-property-event)) (iterator-ctor . ,ly:push-property-iterator::constructor) + (untransposable . #t) )) (PageBreakEvent @@ -404,15 +434,22 @@ goes down).") Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}") (spanner-id . "") - (types . (general-music span-event event phrasing-slur-event)) + (types . (general-music 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) + (untransposable . #t) )) (PropertyUnset @@ -447,15 +484,6 @@ Syntax: @code{\\unset @var{context}.@var{prop}}") (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)) - )) - (RepeatedMusic . ((description . "Repeat music in different ways.") (types . (general-music repeated-music)) @@ -468,13 +496,14 @@ Syntax: @code{\\unset @var{context}.@var{prop}}") (RepeatTieEvent . ((description . "Ties for starting a second volta bracket.") - (types . (general-music event repeat-tie-event)) + (types . (general-music post-event event repeat-tie-event)) )) (RestEvent . ((description . "A Rest. Syntax: @code{r4} for a quarter rest.") + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) (types . (general-music event rhythmic-event rest-event)) )) @@ -518,6 +547,7 @@ Syntax: @code{\\simultaneous @{ @dots{} @}} or @code{<< @dots{} >>}") print anything. Syntax: @code{s4} for a skip equivalent to a quarter rest.") + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) (types . (general-music event rhythmic-event skip-event)) )) @@ -528,7 +558,7 @@ 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)) + (types . (general-music event skip-event)) )) (SlurEvent @@ -536,7 +566,7 @@ Syntax: @code{\\skip} @var{duration}") Syntax: @var{note}@code{(} and @var{note}@code{)}") (spanner-id . "") - (types . (general-music span-event event slur-event)) + (types . (general-music post-event span-event event slur-event)) )) (SoloOneEvent @@ -553,7 +583,7 @@ Syntax: @var{note}@code{(} and @var{note}@code{)}") (SostenutoEvent . ((description . "Depress or release sostenuto pedal.") - (types . (general-music event pedal-event sostenuto-event)) + (types . (general-music post-event event pedal-event sostenuto-event)) )) (SpacingSectionEvent @@ -575,19 +605,19 @@ different time than stopped.") . ((description . "Specify on which string to play this note. Syntax: @code{\\@var{number}}") - (types . (general-music string-number-event event)) + (types . (general-music 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 . (general-music post-event stroke-finger-event event)) )) (SustainEvent . ((description . "Depress or release sustain pedal.") - (types . (general-music event pedal-event sustain-event)) + (types . (general-music post-event event pedal-event sustain-event)) )) (TempoChangeEvent @@ -597,20 +627,20 @@ Syntax: @code{\\rightHandFinger @var{text}}") (TextScriptEvent . ((description . "Print text.") - (types . (general-music script-event text-script-event event)) + (types . (general-music 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 . (general-music post-event span-event event text-span-event)) )) (TieEvent . ((description . "A tie. Syntax: @w{@var{note}@code{-~}}") - (types . (general-music tie-event event)) + (types . (general-music post-event tie-event event)) )) (TimeScaledMusic @@ -643,7 +673,7 @@ Syntax: @code{\\times @var{fraction} @var{music}}, e.g., (TremoloEvent . ((description . "Unmeasured tremolo.") - (types . (general-music event tremolo-event)) + (types . (general-music post-event event tremolo-event)) )) (TremoloRepeatedMusic @@ -662,18 +692,18 @@ Syntax: @code{\\times @var{fraction} @var{music}}, e.g., (TrillSpanEvent . ((description . "Start a trill spanner.") - (types . (general-music span-event event trill-span-event)) + (types . (general-music 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 general-music post-event)) )) (UnaCordaEvent . ((description . "Depress or release una-corda pedal.") - (types . (general-music event pedal-event una-corda-event)) + (types . (general-music post-event event pedal-event una-corda-event)) )) (UnfoldedRepeatedMusic @@ -709,6 +739,7 @@ Syntax: @code{\\\\}") (VoltaRepeatedMusic . ((description . "Repeats with alternatives placed sequentially.") (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 . (general-music repeated-music volta-repeated-music))