]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-music-types.scm
Run grand-replace for 2010.
[lilypond.git] / scm / define-music-types.scm
index ba4459b8a32a671404fd62ce0c446f3cb4606954..f01dd2ca7e5f94e1083cb17c023e0a3ce5f0daa6 100644 (file)
@@ -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--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2010 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.
 
@@ -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 Notation Reference 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))
        ))
 
@@ -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 define-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)))