X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-music-types.scm;h=dc93024041d961a8918d8c4ed0a79377fee3eed2;hb=e7638b90e908840010125d0c150db8c18a5016c7;hp=0dc1c66bcf58c7c82077e9c484fd2444e2fc9a64;hpb=3d8089a42af6304edb8dad56220e845c84832bb2;p=lilypond.git diff --git a/scm/define-music-types.scm b/scm/define-music-types.scm index 0dc1c66bcf..dc93024041 100644 --- a/scm/define-music-types.scm +++ b/scm/define-music-types.scm @@ -1,25 +1,25 @@ -;;;; define-music-types.scm -- +;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; source file of the GNU LilyPond music typesetter -;;;; -;;;; (c) 1998--2009 Han-Wen Nienhuys +;;;; Copyright (C) 1998--2012 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 +;;;; the Free Software Foundation, either version 3 of the License, or +;;;; (at your option) any later version. +;;;; +;;;; LilyPond is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with LilyPond. If not, see . -;; TODO: should link back into user manual. +; for define-safe-public when byte-compiling using Guile V2 +(use-modules (scm safe-utility-defs)) -(define (mm-rest-child-list music) - "Generate events for multimeasure rests, -to be used by the sequential-iterator" - (let ((location (ly:music-property music 'origin)) - (duration (ly:music-property music 'duration))) - (list (make-music 'BarCheck - 'origin location) - (make-event-chord (cons (make-music 'MultiMeasureRestEvent - 'origin location - 'duration duration) - (ly:music-property music 'articulations))) - (make-music 'BarCheck - 'origin location)))) +;; TODO: should link back into user manual. (define-public music-descriptions `( @@ -29,7 +29,12 @@ to be used by the sequential-iterator" 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 @@ -58,8 +63,8 @@ context, and 3.@tie{}the context where @var{func} is called.") (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 . (general-music post-event arpeggio-event event)) )) ;; todo: use articulation-event for slur as well. @@ -69,10 +74,10 @@ Syntax: @var{note}@code{-\\arpeggio}") 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}). +(no direction specified), and where @code{y} is an articulation +(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 @@ -100,17 +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 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 . (general-music post-event bend-after-event event)))) (BreathingEvent . ((description . "Create a @q{breath mark} or @q{comma}. @@ -123,10 +133,18 @@ 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)) )) + (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)) + )) + (ContextChange . ((description . "Change staves in Piano staff. @@ -151,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)) )) @@ -162,19 +180,37 @@ 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)) )) + (DoublePercentEvent + . ((description . "Used internally to signal double percent repeats.") + (types . (general-music event double-percent-event rhythmic-event)) + )) + + (EpisemaEvent + . ((description . "Begin or end an episema.") + (types . (general-music post-event span-event event episema-event)) + )) + (Event . ((description . "Atomic music event.") (types . (general-music event)) )) (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)) @@ -182,17 +218,22 @@ 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 + . ((description . "Footnote a grob.") + (types . (general-music event footnote-event)) )) (GlissandoEvent . ((description . "Start a glissando on this note.") - (types . (general-music glissando-event event)) + (types . (general-music post-event glissando-event event)) )) (GraceMusic @@ -205,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 @@ -230,12 +271,11 @@ 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 . ((description . "Start or end a ligature.") - (span-type . ligature) (types . (general-music span-event ligature-event event)) )) @@ -256,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)) )) @@ -268,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.") @@ -290,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 @@ -299,14 +345,27 @@ 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 + . ((description . "Start or stop an ottava bracket.") + (iterator-ctor . ,ly:sequential-iterator::constructor) + (elements-callback . ,make-ottava-set) + (types . (general-music ottava-music)) )) (OverrideProperty @@ -329,6 +388,17 @@ Syntax: @code{\\override} [ @var{context} @code{.} ] (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)) + )) + + (PartialSet + . ((description . "Create an anacrusis or upbeat (partial measure).") + (iterator-ctor . ,ly:partial-iterator::constructor) + (types . (general-music partial-set)) + )) + (PartCombineMusic . ((description . "Combine two parts on a staff, either merged or as separate voices.") @@ -344,7 +414,7 @@ as separate voices.") )) (PercentRepeatedMusic - . ((description . "Repeats encoded by percents.") + . ((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) @@ -362,7 +432,8 @@ goes down).") . ((description . "Start or end phrasing slur. Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}") - (types . (general-music span-event event phrasing-slur-event)) + (spanner-id . "") + (types . (general-music post-event span-event event phrasing-slur-event)) )) (PropertySet @@ -410,15 +481,21 @@ Syntax: @code{\\unset @var{context}.@var{prop}}") (types . (general-music repeated-music)) )) + (RepeatSlashEvent + . ((description . "Used internally to signal beat repeats.") + (types . (general-music event repeat-slash-event rhythmic-event)) + )) + (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)) )) @@ -462,6 +539,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)) )) @@ -472,14 +550,15 @@ 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 . ((description . "Start or end slur. Syntax: @var{note}@code{(} and @var{note}@code{)}") - (types . (general-music span-event event slur-event)) + (spanner-id . "") + (types . (general-music post-event span-event event slur-event)) )) (SoloOneEvent @@ -496,7 +575,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 @@ -518,37 +597,42 @@ 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 + . ((description . "A metronome mark or tempo indication.") + (types . (general-music event tempo-change-event)) )) (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: @var{note}@code{-~}") - (types . (general-music tie-event event)) +Syntax: @w{@var{note}@code{-~}}") + (types . (general-music post-event tie-event event)) )) (TimeScaledMusic @@ -558,10 +642,17 @@ 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:time-scaled-music-iterator::constructor) + (iterator-ctor . ,ly:tuplet-iterator::constructor) (types . (time-scaled-music music-wrapper-music general-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)) + )) + (TransposedMusic . ((description . "Music that has been transposed.") (iterator-ctor . ,ly:music-wrapper-iterator::constructor) @@ -574,7 +665,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 @@ -593,18 +684,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 @@ -640,6 +731,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)) @@ -649,7 +741,7 @@ Syntax: @code{\\\\}") (set! music-descriptions (sort music-descriptions alist