Doc-de: updating includes, learning, notation

[lilypond.git] / scm / define-music-types.scm

diff --git a/scm/define-music-types.scm b/scm/define-music-types.scm
index a0762025de6455f6345082dd0af0d035045c352d..8dbc6decc04276d15e18220d396aafecc6e00408 100644 (file)
--- a/scm/define-music-types.scm
+++ b/scm/define-music-types.scm
@@ -1,6 +1,6 @@
 ;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;
-;;;; Copyright (C) 1998--2010 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
@@ -16,21 +16,10 @@
 ;;;; 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.
+; 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
   `(
@@ -43,6 +32,11 @@ Syntax: @var{note}@code{\\x}, where @code{\\x} is a dynamic mark like
        (types . (general-music event dynamic-event absolute-dynamic-event))
        ))
 
+    (AlternativeEvent
+     . ((description . "Create a alternative event.")
+        (types . (general-music event alternative-event))
+       ))
+
     (AnnotateOutputEvent
      . ((description . "Print an annotation of an output element.")
        (types . (general-music event annotate-output-event))
@@ -69,7 +63,7 @@ context, and 3.@tie{}the context where @var{func} is called.")
     (ArpeggioEvent
      . ((description . "Make an arpeggio on this note.
 
-Syntax: @var{note}@code{-\\arpeggio}")
+Syntax: @w{@var{note}@code{-\\arpeggio}}")
        (types . (general-music arpeggio-event event))
        ))
 
@@ -81,7 +75,7 @@ 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}).
+(such as @w{@code{-.}}, @w{@code{->}}, @code{\\tenuto}, @code{\\downbow}).
 See the Notation Reference for details.")
        (types . (general-music event articulation-event script-event))
        ))
@@ -125,7 +119,7 @@ Syntax for manual control: @code{c8-[ c c-] c8}")
        ))
 
     (BendAfterEvent
-     . ((description . "A drop/fall/doit jazz articulation.")
+     . ((description . "A drop/@/fall/@/doit jazz articulation.")
        (types . (general-music bend-after-event event))))
 
     (BreathingEvent
@@ -189,6 +183,11 @@ An alternative syntax is @var{note}@code{\\decr} @dots{}
                  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 span-event event episema-event))
@@ -218,6 +217,11 @@ An alternative syntax is @var{note}@code{\\decr} @dots{}
        (types . (general-music 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))
@@ -336,6 +340,13 @@ Note the explicit font switch.")
        (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.
 
@@ -356,6 +367,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.")
@@ -371,7 +393,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)
@@ -389,6 +411,7 @@ goes down).")
      . ((description . "Start or end phrasing slur.
 
 Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}")
+        (spanner-id . "")
        (types . (general-music span-event event phrasing-slur-event))
        ))
 
@@ -446,6 +469,11 @@ 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))
@@ -515,6 +543,7 @@ Syntax: @code{\\skip} @var{duration}")
      . ((description . "Start or end slur.
 
 Syntax: @var{note}@code{(} and @var{note}@code{)}")
+        (spanner-id . "")
        (types . (general-music span-event event slur-event))
        ))
 
@@ -569,6 +598,11 @@ Syntax: @code{\\rightHandFinger @var{text}}")
        (types . (general-music 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))
@@ -583,7 +617,7 @@ octavation.")
     (TieEvent
      . ((description . "A tie.
 
-Syntax: @var{note}@code{-~}")
+Syntax: @w{@var{note}@code{-~}}")
        (types . (general-music tie-event event))
        ))
 
@@ -598,6 +632,13 @@ Syntax: @code{\\times @var{fraction} @var{music}}, e.g.,
        (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)
@@ -676,6 +717,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))
@@ -685,7 +727,7 @@ Syntax: @code{\\\\}")
 (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.