-;;;; 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 <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
+;;;;
+;;;; 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 <http://www.gnu.org/licenses/>.
;; TODO: should link back into user manual.
-(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))))
-
(define-public music-descriptions
`(
(AbsoluteDynamicEvent
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
+(no direction specified), and where @code{y} is an articulation
(such as @code{-.}, @code{->}, @code{\\tenuto}, @code{\\downbow}).
-See the user manual for details.")
+See the Notation Reference for details.")
(types . (general-music event articulation-event script-event))
))
(types . (general-music event beam-forbid-event))
))
+ (BreakDynamicSpanEvent
+ . ((description . "End an alignment spanner for dynamics here.")
+ (types . (general-music 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 event breathing-event))
))
+ (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))
+ ))
+
+ (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.
(types . (general-music translator-change-instruction))
))
- (ClusterNoteEvent
- . ((description . "A note that is part of a cluster.")
- ;; 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.")
(CrescendoEvent
. ((description . "Begin or end a crescendo.
-Syntax: @var{note}@code{\\cr} @dots{} @var{note}@code{\\rc}
+Syntax: @var{note}@code{\\<} @dots{} @var{note}@code{\\!}
-You can also use @code{\\<}, @code{\\!}, @code{\\cresc}, and
-@code{\\endcresc}. See the user manual for details.")
+An alternative syntax is @var{note}@code{\\cr} @dots{}
+@var{note}@code{\\endcr}.")
(types . (general-music span-event span-dynamic-event crescendo-event
event))
))
(DecrescendoEvent
- . ((description . "See @ref{CrescendoEvent}.")
+ . ((description . "Begin or end a decrescendo.
+
+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))
))
- (ExtenderEvent
- . ((description . "Extend lyrics.")
- (types . (general-music extender-event event))
+ (EpisemaEvent
+ . ((description . "Begin or end an episema.")
+ (types . (general-music span-event event episema-event))
))
(Event
(types . (general-music event-chord simultaneous-music))
))
+ (ExtenderEvent
+ . ((description . "Extend lyrics.")
+ (types . (general-music extender-event event))
+ ))
+
(FingeringEvent
. ((description . "Specify what finger to use for this note.")
(types . (general-music fingering-event event))
))
- (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))
- ))
-
(GlissandoEvent
. ((description . "Start a glissando on this note.")
(types . (general-music glissando-event event))
(LigatureEvent
. ((description . "Start or end a ligature.")
- (span-type . ligature)
(types . (general-music span-event ligature-event event))
))
(types . (general-music 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
. ((description . "Extend the definition of a graphical object.
(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.")
(PropertySet
. ((description . "Set a context property.
-Syntax: @code{\\property @var{context}.@var{prop} = @var{scheme-val}}")
+Syntax: @code{\\set @var{context}.@var{prop} = @var{scheme-val}}")
(types . (layout-instruction-event general-music))
(iterator-ctor . ,ly:property-iterator::constructor)
))
(PropertyUnset
- . ((description . "Remove the definition of a context
-@code{\\property}.")
+ . ((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 . (music-wrapper-music general-music relative-octave-music))
))
- (RepeatTieEvent
- . ((description . "Ties for starting a second volta bracket.")
- (types . (general-music event repeat-tie-event))
+ (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
(types . (general-music repeated-music))
))
+ (RepeatTieEvent
+ . ((description . "Ties for starting a second volta bracket.")
+ (types . (general-music event repeat-tie-event))
+ ))
+
(RestEvent
. ((description . "A Rest.
))
(TextSpanEvent
- . ((description . "Start a text spanner, e.g., 8va.....|")
+ . ((description . "Start a text spanner, for example, an
+octavation.")
(types . (general-music span-event event text-span-event))
))
(TimeScaledMusic
. ((description . "Multiply durations, as in tuplets.
-Syntax: @code{\\times @var{fraction} @var{music}}, e.g.
+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)
))
(TremoloSpanEvent
- . ((description . "Tremolo over two stems")
+ . ((description . "Tremolo over two stems.")
(types . (general-music event span-event tremolo-span-event))
))
(TrillSpanEvent
- . ((description . "Start a trill spanner tr~~~")
+ . ((description . "Start a trill spanner.")
(types . (general-music span-event event trill-span-event))
))
(set! music-descriptions
(sort music-descriptions alist<?))
-(define-public music-name-to-property-table (make-vector 59 '()))
+(define-public music-name-to-property-table (make-hash-table 59))
;; init hash table,
;; transport description to an object property.
(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 alterning property symbols
+according to @code{music-properties}, a list of alternating property symbols
and values. E.g:
(make-music 'OverrideProperty
'symbol 'Stem
m)))
(define-public (make-repeated-music name)
- (let* ((handle (assoc name '(("volta" . VoltaRepeatedMusic)
- ("unfold" . UnfoldedRepeatedMusic)
- ("percent" . PercentRepeatedMusic)
- ("tremolo" . TremoloRepeatedMusic)
- ("fold" . FoldedRepeatedMusic))))
- (music-name (if (pair? handle)
- (cdr handle)
- (begin
- (ly:warning (_ "unknown repeat type `~S'") name)
- (ly:warning (_ "See music-types.scm for supported repeats"))
- 'VoltaRepeatedMusic))))
- (make-music 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)))