X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-music-types.scm;h=0ed92520443c7d10f5fafa5fae77856644c6529c;hb=b94ad43c250b87cf4ad352cc47e2f81692904ad3;hp=a6e1cbe178a4e2f7077bcd49f3eba5b198a52a80;hpb=17098f34eace028d047ee7f9cd6f81a84e0e7537;p=lilypond.git diff --git a/scm/define-music-types.scm b/scm/define-music-types.scm index a6e1cbe178..0ed9252044 100644 --- a/scm/define-music-types.scm +++ b/scm/define-music-types.scm @@ -1,9 +1,20 @@ -;;;; define-music-types.scm -- +;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; source file of the GNU LilyPond music typesetter -;;;; -;;;; (c) 1998--2007 Han-Wen Nienhuys +;;;; Copyright (C) 1998--2009 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. @@ -71,7 +82,7 @@ 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}). -See the user manual for details.") +See the Notation Reference for details.") (types . (general-music event articulation-event script-event)) )) @@ -120,6 +131,13 @@ Syntax: @var{note}@code{\\breathe}") (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)) + )) + (ContextChange . ((description . "Change staves in Piano staff. @@ -128,13 +146,6 @@ Syntax: @code{\\change Staff = @var{new-id}}") (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.") @@ -147,25 +158,25 @@ 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)) - )) - (Event . ((description . "Atomic music event.") (types . (general-music event)) @@ -180,6 +191,11 @@ You can also use @code{\\<}, @code{\\!}, @code{\\cresc}, and (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)) @@ -363,14 +379,16 @@ Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}") (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) )) @@ -398,9 +416,13 @@ Syntax: @code{\\property @var{context}.@var{prop} = @var{scheme-val}}") (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 @@ -408,6 +430,11 @@ Syntax: @code{\\property @var{context}.@var{prop} = @var{scheme-val}}") (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. @@ -532,7 +559,8 @@ Syntax: @code{\\rightHandFinger @var{text}}") )) (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)) )) @@ -546,7 +574,7 @@ Syntax: @var{note}@code{-~}") (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) @@ -579,12 +607,12 @@ Syntax: @code{\\times @var{fraction} @var{music}}, e.g. )) (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)) )) @@ -660,7 +688,7 @@ Syntax: @code{\\\\}") (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 @@ -682,14 +710,14 @@ and values. E.g: m))) (define-public (make-repeated-music name) - (let* ((handle (assoc name '(("volta" . VoltaRepeatedMusic) - ("unfold" . UnfoldedRepeatedMusic) - ("percent" . PercentRepeatedMusic) - ("tremolo" . TremoloRepeatedMusic)))) - (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)))