X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-music-types.scm;h=e0190eda5516c419eb6763affa58e968b082ae20;hb=3af0951f9a11677240efa6228683dd4fcea13eaf;hp=b3855c34dbf0eb679a655547c0d4b6cab45f396c;hpb=68f8545bd6a0221ee1100336e4ad49399a7ffaa4;p=lilypond.git diff --git a/scm/define-music-types.scm b/scm/define-music-types.scm index b3855c34db..e0190eda55 100644 --- a/scm/define-music-types.scm +++ b/scm/define-music-types.scm @@ -1,761 +1,823 @@ -;;;; define-music-types.scm -- +;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; source file of the GNU LilyPond music typesetter -;;;; -;;;; (c) 1998--2006 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 +;;;; 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 `( (AbsoluteDynamicEvent - . ( - (description . "Creates a dynamic mark. + . ((description . "Create a dynamic mark. + +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 . (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 . (event annotate-output-event post-event)) + )) -Syntax: @var{note}@code{\\x}, -where x is one of \\ppp, \\pp, \\p, \\mp, \\mf, \\f, \\ff, \\fff.") - (types . (general-music event dynamic-event absolute-dynamic-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) - )) - (ApplyOutputEvent - . ( - (description . " -Call the argument with all current grobs during interpreting phase. + . ((description . "Call the argument with the current context during +interpreting phase.") + (types . (apply-context)) + (iterator-ctor . ,ly:apply-context-iterator::constructor) + )) -Syntax + (ApplyOutputEvent + . ((description . "Call the argument with all current grobs during +interpreting phase. -\\applyOutput #'Context FUNC +Syntax: @code{\\applyOutput #'@var{context} @var{func}} -arguments to func are 1. the grob, 2. the originating context, -3. context where FUNC is called. +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 . (event apply-output-event)) + )) -") - (types . (general-music event apply-output-event)) - )) - (ArpeggioEvent - . ( - (description . "Make an arpeggio on this note. + (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 + ;; separate non articulation scripts (ArticulationEvent - . ( - (description . "Adds an articulation marking to a note. + . ((description . "Add an articulation marking to a note. -Syntax: -@var{note}@code{X}@code{Y}, where X is a direction (up @code{^}, down -@code{_}, or LilyPond's choice (no direction specified)), and where Y -is an articulation (such as @code{-.}, @code{->}, @code{\\tenuto}, -@code{\\downbow}). See the user manual for details.") +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 . (post-event event articulation-event script-event)) + )) - (types . (general-music 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)) - )) + . ((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 . (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) - )) + . ((description . "Check whether this music coincides with +the start of the measure.") + (types . (bar-check)) + (iterator-ctor . ,ly:bar-check-iterator::constructor) + )) + (BassFigureEvent - . ( - (description . "Print a bass-figure text") + . ((description . "Print a bass-figure text.") + (types . (event rhythmic-event bass-figure-event)) + )) - (types . (general-music event rhythmic-event bass-figure-event)) - )) (BeamEvent - . ( - (description . "Starts or stops a beam. + . ((description . "Start or stop a beam. + +Syntax for manual control: @code{c8-[ c c-] c8}") + (types . (post-event event beam-event span-event)) + )) + + (BeamForbidEvent + . ((description . "Specify that a note may not auto-beamed.") + (types . (post-event event beam-forbid-event)) + )) + + (BreakDynamicSpanEvent + . ((description . "End an alignment spanner for dynamics here.") + (types . (post-event break-span-event break-dynamic-span-event event)) + )) -Syntax for manual control: -c8-[ c c-] c8") - (types . (general-music event beam-event span-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 . "Creates a `breath mark' or `comma'. + . ((description . "Create a @q{breath mark} or @q{comma}. -Syntax: -@var{note}\\breathe.") - - (types . (general-music event breathing-event)) - )) - (ContextChange - . ( - (description . "Change staffs in Piano staff. +Syntax: @var{note}@code{\\breathe}") -Syntax @code{\\translator Staff = @var{new-id}}.") - (iterator-ctor . , ly:change-iterator::constructor) - (types . (general-music translator-change-instruction)) - )) + (types . (event breathing-event)) + (midi-length . ,breathe::midi-length))) (ClusterNoteEvent - . ((description . "A note that is part of a cluster.") + . ((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 . (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 . (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 . (translator-change-instruction)) + )) - ;; not a note-event, to ensure that Note_engraver doesn't eat it. - (types . (general-music cluster-note-event melodic-event rhythmic-event event)) - )) - (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)) - )) - + . ((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 music-wrapper-music)) + )) + (CrescendoEvent - . ( - (description . "Begins or ends a crescendo. + . ((description . "Begin or end a crescendo. + +Syntax: @var{note}@code{\\<} @dots{} @var{note}@code{\\!} -Syntax: @var{note}\\cr -... @var{note}\\rc (you can also use \\<, \\!, \\cresc, and -\\endcresc. See the user manual for details.).") +An alternative syntax is @var{note}@code{\\cr} @dots{} +@var{note}@code{\\endcr}.") + (types . (post-event span-event span-dynamic-event crescendo-event + event)) + )) - (types . (general-music dynamic-event crescendo-event event)) - )) (DecrescendoEvent - . ( - (description . "See @ref{CrescendoEvent}.") + . ((description . "Begin or end a decrescendo. - (types . (general-music dynamic-event decrescendo-event event)) - )) - - (ExtenderEvent - . ( - (description . "Extend lyrics.") +Syntax: @var{note}@code{\\>} @dots{} @var{note}@code{\\!} + +An alternative syntax is @var{note}@code{\\decr} @dots{} +@var{note}@code{\\enddecr}.") + (types . (post-event span-event span-dynamic-event decrescendo-event + event)) + )) - (types . (general-music extender-event event)) - )) + (DoublePercentEvent + . ((description . "Used internally to signal double percent repeats.") + (types . (event double-percent-event rhythmic-event)) + )) + + (EpisemaEvent + . ((description . "Begin or end an episema.") + (types . (post-event span-event event episema-event)) + )) (Event - . ( - (description . "Atomic music event.") - (types . (general-music event)) - )) - + . ((description . "Atomic 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 . (post-event extender-event event)) + )) + (FingeringEvent - . ( - (description . "Specify what finger to use for this note.") - (types . (general-music fingering-event event)) - )) - (BeamForbidEvent - . ( - (description . "Specify that a note may not auto-beamed ") - (types . (general-music event beam-forbid-event)) - )) + . ((description . "Specify what finger to use for this note.") + (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)) - )) - + . ((description . "Start a glissando on this note.") + (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)) - )) - (NoteGroupingEvent - . ( - (description . "Start or stop grouping brackets.") - (types . (general-music event note-grouping-event)) - )) + . ((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)) + )) + (HarmonicEvent - . ( - (description . "Mark a note as harmonic") - (types . (general-music event harmonic-event)) - )) + . ((description . "Mark a note as harmonic.") + (types . (post-event event harmonic-event)) + )) + (HyphenEvent - . ( - (description . "A hyphen between lyric syllables.") + . ((description . "A hyphen between lyric syllables.") + (types . (post-event hyphen-event event)) + )) - (types . (general-music hyphen-event event)) - )) - (KeyChangeEvent - . ( - (description . "Change the key signature. + . ((description . "Change the key signature. + +Syntax: @code{\\key} @var{name} @var{scale}") + (to-relative-callback . ,(lambda (x p) p)) + (types . (key-change-event event)) + )) + + (LabelEvent + . ((description . "Place a bookmarking label.") + (types . (label-event event)) + )) -Syntax: @code{\\key } @var{name} @var{scale}.") - (to-relative-callback . ,(lambda (x p) p)) - (types . (general-music key-change-event event)) - )) (LaissezVibrerEvent . ((description . "Don't damp this chord. -Syntax: @var{note}\\laissezVibrer.") +Syntax: @var{note}@code{\\laissezVibrer}") + (types . (post-event event laissez-vibrer-event)) + )) - (types . (general-music event laissez-vibrer-event)) - )) (LigatureEvent - . ( - (description . "Start or end a ligature.") - (span-type . ligature) - (types . (general-music span-event ligature-event event)) - )) + . ((description . "Start or end a ligature.") + (types . (span-event ligature-event event)) + )) + (LineBreakEvent - . ( - (description . "Allow, forbid or force a line break.") - (types . (general-music line-break-event break-event event)) - )) - + . ((description . "Allow, forbid or force a line break.") + (types . (line-break-event break-event event)) + )) + (LyricCombineMusic - . ( - (description . "Align lyrics to the start of notes. + . ((description . "Align lyrics to the start of notes. -Syntax @var{\\lyricsto }@var{voicename} @var{lyrics}.") - (length . ,ZERO-MOMENT) - (types . (general-music lyric-combine-music)) - (iterator-ctor . ,ly:lyric-combine-music-iterator::constructor) - )) +Syntax: @code{\\lyricsto} @var{voicename} @var{lyrics}") + (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 @} } .") + . ((description . "A lyric syllable. Must be entered in lyrics mode, +i.e., @code{\\lyrics @{ twinkle4 twinkle4 @} }.") + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) + (types . (rhythmic-event lyric-event event)) + )) - (types . (general-music rhythmic-event lyric-event event)) - )) (MarkEvent - . ( - (description . "Insert a rehearsal mark. + . ((description . "Insert a rehearsal mark. + +Syntax: @code{\\mark} @var{marker} -Syntax: @code{\\mark} @var{marker}, -e.g. @code{\\mark \"A\"}.") +Example: @code{\\mark \"A\"}") + (types . (mark-event event)) + )) - (types . (general-music mark-event event)) - )) - (ManualMelismaEvent - . ( - (description . "Start or stop a melisma. + (MeasureCounterEvent + . ((description . "Used to signal the start and end of a measure count.") + (types . (measure-counter-event span-event event)) + )) -Syntax: @code{c4\\melisma d\\melismaEnd}.") - (types . (general-music melisma-span-event event)) - )) + (MultiMeasureRestEvent + . ((description . "Used internally by @code{MultiMeasureRestMusic} +to signal rests.") + (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. + . ((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)) - )) +Syntax: @code{R2.*4} for 4 measures in 3/4 time.") + (iterator-ctor . ,ly:sequential-iterator::constructor) + (elements-callback . ,mm-rest-child-list) + (types . (multi-measure-rest)) + )) - (MultiMeasureRestEvent - . ( - (description . "Used internally by MultiMeasureRestMusic to signal rests") - (types . (general-music event rhythmic-event multi-measure-rest-event)) - )) - (MultiMeasureTextEvent - . ( - (description . "Texts on mm rests. + . ((description . "Texts on multi measure rests. -Syntax -@code{R-\\markup @{ \\roman \"bla\" @}}. Note the explicit font switch.") - (types . (general-music event multi-measure-text-event)) - )) +Syntax: @code{R-\\markup @{ \\roman \"bla\" @}} + +Note the explicit font switch.") + (types . (post-event event multi-measure-text-event)) + )) (Music - . ( - (description . "Generic type for music expressions.") + . ((description . "Generic type for music expressions.") + (types . ()) + )) - (types . (general-music)) - )) (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 . (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 . (ottava-music)) + )) + (OverrideProperty - . ( - (description . "Extend the definition of a graphical object. + . ((description . "Extend the definition of a graphical object. -SYNTAX +Syntax: @code{\\override} [ @var{context} @code{.} ] +@var{object} @var{property} @code{=} @var{value}") + (types . (layout-instruction-event override-property-event)) + (iterator-ctor . ,ly:push-property-iterator::constructor) + (untransposable . #t) + )) -@code{\\override [ @var{Ctxt} . ] @var{Obj} @var{prop} = @var{val}} -") - (types . (general-music layout-instruction-event override-property-event)) - (iterator-ctor . ,ly:push-property-iterator::constructor) - )) (PageBreakEvent - . ( - (description . "Allow, forbid or force a page break.") - (types . (general-music break-event page-break-event event)) - )) + . ((description . "Allow, forbid or force a page break.") + (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)) - )) + . ((description . "Allow, forbid or force a page turn.") + (types . (break-event page-turn-event event)) + )) + + (PartialSet + . ((description . "Create an anacrusis or upbeat (partial measure).") + (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 + . ((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 . (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 . (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 . (pes-or-flexa-event event)) + )) + (PhrasingSlurEvent - . ( - (description . "Start or end phrasing slur. + . ((description . "Start or end phrasing slur. -Syntax NOTE \\( and \\) NOTE") - (types . (general-music span-event event phrasing-slur-event)) - )) - - (PropertySet - . ( - (description . "Set a context property. +Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}") + (spanner-id . "") + (types . (post-event span-event event phrasing-slur-event)) + )) -Syntax: @code{\\property @var{context}.@var{prop} = @var{scheme-val}}.") - (types . (layout-instruction-event general-music)) - (iterator-ctor . ,ly:property-iterator::constructor) - )) + (PostEvents + . ((description . "Container for several postevents. - (PropertyUnset - . ( - (description . "Remove the definition of a context @code{\\property}.") +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)))) - (types . (layout-instruction-event general-music)) - (iterator-ctor . ,ly:property-unset-iterator::constructor) - )) + (PropertySet + . ((description . "Set a context property. - (PercentEvent - . ( - (description . "Used internally to signal percent repeats.") - (types . (general-music event percent-event)) - )) +Syntax: @code{\\set @var{context}.@var{prop} = @var{scheme-val}}") + (types . (layout-instruction-event)) + (iterator-ctor . ,ly:property-iterator::constructor) + (untransposable . #t) + )) - (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).") + (PropertyUnset + . ((description . "Restore the default setting for a context +property. See @ref{PropertySet}. - (types . (general-music pes-or-flexa-event event)) - )) +Syntax: @code{\\unset @var{context}.@var{prop}}") + (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)) - )) - + . ((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 . (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 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)) - )) + . ((description . "Repeat music in different ways.") + (types . (repeated-music)) + )) + + (RepeatSlashEvent + . ((description . "Used internally to signal beat repeats.") + (types . (event repeat-slash-event rhythmic-event)) + )) + (RepeatTieEvent - . ( - (description . "Ties for starting a second volta bracket.") - (types . (general-music event repeat-tie-event)) - )) + . ((description . "Ties for starting a second volta bracket.") + (types . (post-event event repeat-tie-event)) + )) + (RestEvent - . ( - (description . "A Rest. + . ((description . "A Rest. -Syntax @code{r4} for a quarter rest. ") +Syntax: @code{r4} for a quarter rest.") + (iterator-ctor . ,ly:rhythmic-music-iterator::constructor) + (types . (event rhythmic-event rest-event)) + )) - (types . (general-music event rhythmic-event rest-event)) - )) (RevertProperty - . ( - (description . "The opposite of @ref{OverrideProperty}: remove a -previously added property from a graphical object definition - ") + . ((description . "The opposite of @ref{OverrideProperty}: remove a +previously added property from a graphical object definition.") + (types . (layout-instruction-event)) + (iterator-ctor . ,ly:pop-property-iterator::constructor) + )) - (types . (general-music layout-instruction-event)) - (iterator-ctor . , ly:pop-property-iterator::constructor) - )) + (ScriptEvent + . ((description . "Add an articulation mark to a note.") + (types . (event)) + )) (SequentialMusic - . ( - (description . "Music expressions concatenated. - -Syntax \\sequential @{..@} or simply @{..@} .") + . ((description . "Music expressions concatenated. - (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)) - )) +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 . (sequential-music)) + )) - (SoloOneEvent - . ( - (description . "Print Solo.1") - (part-combine-status . solo1) - (types . (general-music event part-combine-event solo-one-event)) - )) - (SoloTwoEvent - . ( - (description . "Print Solo.2") - (part-combine-status . solo2) - (types . (general-music event part-combine-event solo-two-event)) - )) - (UnisonoEvent - . ((description . "Print a2") - (part-combine-status . unisono) - (types . (general-music event part-combine-event unisono-event)))) - (SimultaneousMusic - . ( - (description . "Music playing together. + . ((description . "Music playing together. -SYNTAX +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 . (simultaneous-music)) + )) + + (SkipEvent + . ((description . "Filler that takes up duration, but does not +print anything. -@code{ \\simultaneous @{ .. @}} or << .. >>.") +Syntax: @code{s4} for a skip equivalent to a quarter rest.") + (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 . (event skip-event)) + )) - (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)) - )) - (SlurEvent - . ( - (description . "Start or end slur. + . ((description . "Start or end slur. -Syntax NOTE( and NOTE) ") +Syntax: @var{note}@code{(} and @var{note}@code{)}") + (spanner-id . "") + (types . (post-event span-event event slur-event)) + )) - (types . (general-music span-event event slur-event)) - )) - - (StaffSpanEvent - . ((description . "Start or stop a staff symbol.") - (types . (general-music event span-event staff-span-event)) - )) - - (TextSpanEvent - . ( - (description . "Start a text spanner like 8va.....|") - (types . (general-music span-event event text-span-event)) - )) - - (TrillSpanEvent - . ( - (description . "Start a trill spanner tr~~~") - (types . (general-music span-event event trill-span-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)) - )) + (SoloOneEvent + . ((description . "Print @q{Solo@tie{}1}.") + (part-combine-status . solo1) + (types . (event part-combine-event solo-one-event)) + )) - (TimeScaledMusic - . ( - (description . "Multiply durations, as in tuplets. - -Syntax @code{\\times @var{fraction} @var{music}}, e.g. -@code{\\times 2/3 @{ ... @}} for triplets. - ") - (length-callback . ,ly:music-wrapper::length-callback) - (start-callback . ,ly:music-wrapper::start-callback) - (iterator-ctor . ,ly:time-scaled-music-iterator::constructor) - (types . (time-scaled-music music-wrapper-music general-music)) - )) + (SoloTwoEvent + . ((description . "Print @q{Solo@tie{}2}.") + (part-combine-status . solo2) + (types . (event part-combine-event solo-two-event)) + )) - (TupletSpanEvent - . ( - (description . "Used internally to signal where tuplet brackets start and stop.") - (types . (tuplet-span-event span-event event general-music)) - )) + (SostenutoEvent + . ((description . "Depress or release sostenuto pedal.") + (types . (post-event event pedal-event sostenuto-event)) + )) - (UnrelativableMusic - . ( - (description . "Music that can not 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)) - )) + (SpacingSectionEvent + . ((description . "Start a new spacing section.") + (types . (event spacing-section-event)))) - (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)) - )) - (ScriptEvent - . ( - (description . "Add an articulation mark to a note. ") + (SpanEvent + . ((description . "Event for anything that is started at a +different time than stopped.") + (types . (event)) + )) - (types . (general-music event)) - )) + (StaffSpanEvent + . ((description . "Start or stop a staff symbol.") + (types . (event span-event staff-span-event)) + )) - (SkipMusic - . ( - (description . "Filler that takes up duration, does not print anything, and also -does not create staffs or voices implicitly. + (StringNumberEvent + . ((description . "Specify on which string to play this note. +Syntax: @code{\\@var{number}}") + (types . (post-event string-number-event event)) + )) + (StrokeFingerEvent + . ((description . "Specify with which finger to pluck a string. -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)) - )) - - (SkipEvent - . ( - (description . "Filler that takes up duration, but does not print anything. +Syntax: @code{\\rightHandFinger @var{text}}") + (types . (post-event stroke-finger-event event)) + )) + (SustainEvent + . ((description . "Depress or release sustain pedal.") + (types . (post-event event pedal-event sustain-event)) + )) + (TempoChangeEvent + . ((description . "A metronome mark or tempo indication.") + (types . (event tempo-change-event)) + )) -Syntax: @code{s}@var{duration}") + (TextScriptEvent + . ((description . "Print text.") + (types . (post-event script-event text-script-event event)) + )) - (types . (general-music event rhythmic-event skip-event)) - )) + (TextSpanEvent + . ((description . "Start a text spanner, for example, an +octavation.") + (types . (post-event span-event event text-span-event)) + )) - (SpacingSectionEvent - . ((description . "Start a new spacing section") - (types . (general-music event spacing-section-event)))) - - (SpanEvent - . ( - (description . "Event for anything that is started at a different time than stopped.") + (TieEvent + . ((description . "A tie. - (types . (general-music event)) - )) - - (SustainEvent - . ( - (description . "Depress or release sustain pedal. ") - (types . (general-music event pedal-event sustain-event)) - )) - - (SostenutoEvent - . ( - (description . "Depress or release sostenuto pedal. ") - (types . (general-music event pedal-event sostenuto-pedal-event)) - )) - - (UnaCordaEvent - . ( - (description . "Depress or release una-corda pedal.") - (types . (general-music event pedal-event una-corda-pedal-event)) - )) - - (StringNumberEvent - . ( - (description . "Specify on which string to play this note. +Syntax: @w{@var{note}@code{-~}}") + (types . (post-event tie-event event)) + )) -Syntax: @code{\\@var{number}}.") + (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)) + )) + + (TimeSignatureMusic + . ((description . "Set a new time signature") + (iterator-ctor . ,ly:sequential-iterator::constructor) + (elements-callback . ,make-time-signature-set) + (types . (time-signature-music)) + )) + + (TimeSignatureEvent + . ((description . "An event created when setting a new time signature") + (types . (event time-signature-event)) + )) - (types . (general-music string-number-event 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 transposed-music)) + )) - (TextScriptEvent - . ( - (description . "") - (types . (general-music script-event text-script-event event)) - )) - (TieEvent - . ( - (description . "A tie. Entered as @var{note}-~.") - (types . (general-music tie-event event)) - )) (TremoloEvent - . ( - (description . "Un measured tremolo.") - (types . (general-music event tremolo-event)) - )) - + . ((description . "Unmeasured tremolo.") + (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) + (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)) - )) + . ((description . "Tremolo over two stems.") + (types . (event span-event tremolo-span-event)) + )) + + (TrillSpanEvent + . ((description . "Start a trill spanner.") + (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 post-event)) + )) + + (UnaCordaEvent + . ((description . "Depress or release una-corda pedal.") + (types . (post-event event pedal-event una-corda-event)) + )) + + (UnfoldedRepeatedMusic + . ((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 . (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) + (start-callback . ,ly:music-wrapper::start-callback) + (types . (music-wrapper-music unrelativable-music)) + )) (VoiceSeparator - . ( - (description . "Separate polyphonic voices in simultaneous music. + . ((description . "Separate polyphonic voices in simultaneous music. Syntax: @code{\\\\}") - - (types . (separator general-music)) - )) + (types . (separator)) + )) (VoltaRepeatedMusic - . ( - (iterator-ctor . ,ly:volta-repeat-iterator::constructor) - (description . "") - (start-callback . ,ly:repeated-music::first-start) - (length-callback . ,ly:repeated-music::volta-music-length) - (types . (general-music repeated-music volta-repeated-music)) - )) - - (UnfoldedRepeatedMusic - . ( - (iterator-ctor . ,ly:unfolded-repeat-iterator::constructor) - (description . "") - (start-callback . ,ly:repeated-music::first-start) - (types . (general-music repeated-music unfolded-repeated-music)) - (length-callback . ,ly:repeated-music::unfolded-music-length) - )) - (PercentRepeatedMusic - . ( - (description . "Repeats encoded by percents.") - (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)) - )) - - (TremoloRepeatedMusic - . ( - (iterator-ctor . ,ly:chord-tremolo-iterator::constructor) - (description . "Repeated notes denoted by tremolo beams.") - (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)) - - )) - - (FoldedRepeatedMusic - . ( - (description . "Repeats with alternatives placed in parallel. ") - (iterator-ctor . ,ly:folded-repeat-iterator::constructor) - (start-callback . ,ly:repeated-music::minimum-start) - (length-callback . ,ly:repeated-music::folded-music-length) - (types . (general-music repeated-music folded-repeated-music)) - )) + . ((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 . (repeated-music volta-repeated-music)) + )) )) (set! music-descriptions (sort music-descriptions alist