]> git.donarmstrong.com Git - lilypond.git/blob - scm/define-music-types.scm
Implements rhythmic-music-iterator
[lilypond.git] / scm / define-music-types.scm
1 ;;;; This file is part of LilyPond, the GNU music typesetter.
2 ;;;;
3 ;;;; Copyright (C) 1998--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
5 ;;;;
6 ;;;; LilyPond is free software: you can redistribute it and/or modify
7 ;;;; it under the terms of the GNU General Public License as published by
8 ;;;; the Free Software Foundation, either version 3 of the License, or
9 ;;;; (at your option) any later version.
10 ;;;;
11 ;;;; LilyPond is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 ;;;; GNU General Public License for more details.
15 ;;;;
16 ;;;; You should have received a copy of the GNU General Public License
17 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
18
19 ; for define-safe-public when byte-compiling using Guile V2
20 (use-modules (scm safe-utility-defs))
21
22 ;; TODO: should link back into user manual.
23
24 (define-public music-descriptions
25   `(
26     (AbsoluteDynamicEvent
27      . ((description . "Create a dynamic mark.
28
29 Syntax: @var{note}@code{\\x}, where @code{\\x} is a dynamic mark like
30 @code{\\ppp} or @code{\\sfz}.  A complete list is in file
31 @file{ly/@/dynamic-scripts-init.ly}.")
32         (types . (general-music post-event event dynamic-event absolute-dynamic-event))
33         ))
34
35     (AlternativeEvent
36      . ((description . "Create a alternative event.")
37         (types . (general-music event alternative-event))
38         ))
39
40     (AnnotateOutputEvent
41      . ((description . "Print an annotation of an output element.")
42         (types . (general-music event annotate-output-event))
43         ))
44
45     (ApplyContext
46      . ((description . "Call the argument with the current context during
47 interpreting phase.")
48         (types . (general-music apply-context))
49         (iterator-ctor . ,ly:apply-context-iterator::constructor)
50         ))
51
52     (ApplyOutputEvent
53      . ((description . "Call the argument with all current grobs during
54 interpreting phase.
55
56 Syntax: @code{\\applyOutput #'@var{context} @var{func}}
57
58 Arguments to @var{func} are 1.@tie{}the grob, 2.@tie{}the originating
59 context, and 3.@tie{}the context where @var{func} is called.")
60         (types . (general-music event apply-output-event))
61         ))
62
63     (ArpeggioEvent
64      . ((description . "Make an arpeggio on this note.
65
66 Syntax: @w{@var{note}@code{-\\arpeggio}}")
67         (types . (general-music post-event arpeggio-event event))
68         ))
69
70     ;; todo: use articulation-event for slur as well.
71     ;; separate non articulation scripts
72     (ArticulationEvent
73      . ((description . "Add an articulation marking to a note.
74
75 Syntax: @var{note}@code{x}@code{y}, where @code{x} is a direction
76 (@code{^} for up or @code{_} for down), or LilyPond's choice
77 (no direction specified), and where @code{y} is an articulation
78 (such as @w{@code{-.}}, @w{@code{->}}, @code{\\tenuto}, @code{\\downbow}).
79 See the Notation Reference for details.")
80         (types . (general-music post-event event articulation-event script-event))
81         ))
82
83     (AutoChangeMusic
84      . ((description . "Used for making voices that switch between
85 piano staves automatically.")
86         (iterator-ctor . ,ly:auto-change-iterator::constructor)
87         (start-callback . ,ly:music-wrapper::start-callback)
88         (length-callback . ,ly:music-wrapper::length-callback)
89         (types . (general-music music-wrapper-music auto-change-instruction))
90         ))
91
92     (BarCheck
93      . ((description . "Check whether this music coincides with
94 the start of the measure.")
95         (types . (general-music bar-check))
96         (iterator-ctor . ,ly:bar-check-iterator::constructor)
97         ))
98
99     (BassFigureEvent
100      . ((description . "Print a bass-figure text.")
101         (types . (general-music event rhythmic-event bass-figure-event))
102         ))
103
104     (BeamEvent
105      . ((description . "Start or stop a beam.
106
107 Syntax for manual control: @code{c8-[ c c-] c8}")
108         (types . (general-music post-event event beam-event span-event))
109         ))
110
111     (BeamForbidEvent
112      . ((description . "Specify that a note may not auto-beamed.")
113         (types . (general-music post-event event beam-forbid-event))
114         ))
115
116     (BreakDynamicSpanEvent
117      . ((description . "End an alignment spanner for dynamics here.")
118         (types . (general-music post-event break-span-event break-dynamic-span-event event))
119         ))
120
121     (BendAfterEvent
122      . ((description . "A drop/@/fall/@/doit jazz articulation.")
123         (types . (general-music post-event bend-after-event event))))
124
125     (BreathingEvent
126      . ((description . "Create a @q{breath mark} or @q{comma}.
127
128 Syntax: @var{note}@code{\\breathe}")
129
130         (types . (general-music event breathing-event))
131         ))
132
133     (ClusterNoteEvent
134      . ((description . "A note that is part of a cluster.")
135         ;; not a note-event, to ensure that Note_heads_engraver doesn't eat it.
136         (types . (general-music cluster-note-event melodic-event
137                   rhythmic-event event))
138         ))
139
140     (CompletizeExtenderEvent
141      . ((description . "Used internally to signal the end of a lyrics block to
142 ensure extenders are completed correctly when a @code{Lyrics} context ends
143 before its associated @code{Voice} context.")
144         (types . (general-music completize-extender-event event))
145         ))
146
147     (ContextChange
148      . ((description . "Change staves in Piano staff.
149
150 Syntax: @code{\\change Staff = @var{new-id}}")
151         (iterator-ctor . ,ly:change-iterator::constructor)
152         (types . (general-music translator-change-instruction))
153         ))
154
155     (ContextSpeccedMusic
156      . ((description . "Interpret the argument music within a
157 specific context.")
158         (iterator-ctor . ,ly:context-specced-music-iterator::constructor)
159         (length-callback . ,ly:music-wrapper::length-callback)
160         (start-callback . ,ly:music-wrapper::start-callback)
161         (types . (context-specification general-music music-wrapper-music))
162         ))
163
164     (CrescendoEvent
165      . ((description . "Begin or end a crescendo.
166
167 Syntax: @var{note}@code{\\<} @dots{} @var{note}@code{\\!}
168
169 An alternative syntax is @var{note}@code{\\cr} @dots{}
170 @var{note}@code{\\endcr}.")
171         (types . (general-music post-event span-event span-dynamic-event crescendo-event
172                   event))
173         ))
174
175     (DecrescendoEvent
176      . ((description . "Begin or end a decrescendo.
177
178 Syntax: @var{note}@code{\\>} @dots{} @var{note}@code{\\!}
179
180 An alternative syntax is @var{note}@code{\\decr} @dots{}
181 @var{note}@code{\\enddecr}.")
182         (types . (general-music post-event span-event span-dynamic-event decrescendo-event
183                   event))
184         ))
185
186     (DoublePercentEvent
187      . ((description . "Used internally to signal double percent repeats.")
188         (types . (general-music event double-percent-event rhythmic-event))
189         ))
190
191     (EpisemaEvent
192      . ((description . "Begin or end an episema.")
193         (types . (general-music post-event span-event event episema-event))
194         ))
195
196     (Event
197      . ((description . "Atomic music event.")
198         (types . (general-music event))
199         ))
200
201     (EventChord
202      . ((description . "Internally used to group a set of events.")
203         (iterator-ctor . ,ly:event-chord-iterator::constructor)
204         (length-callback . ,ly:music-sequence::maximum-length-callback)
205         (to-relative-callback .
206          ,ly:music-sequence::event-chord-relative-callback)
207         (types . (general-music event-chord simultaneous-music))
208         ))
209
210     (ExtenderEvent
211      . ((description . "Extend lyrics.")
212         (types . (general-music post-event extender-event event))
213         ))
214
215     (FingeringEvent
216      . ((description . "Specify what finger to use for this note.")
217         (types . (general-music post-event fingering-event event))
218         ))
219
220     (FootnoteEvent
221      . ((description . "Footnote a grob.")
222         (types . (general-music event footnote-event))
223         ))
224
225     (GlissandoEvent
226      . ((description . "Start a glissando on this note.")
227         (types . (general-music post-event glissando-event event))
228         ))
229
230     (GraceMusic
231      . ((description . "Interpret the argument as grace notes.")
232         (start-callback . ,ly:grace-music::start-callback)
233         (length . ,ZERO-MOMENT)
234         (iterator-ctor . ,ly:grace-iterator::constructor)
235         (types . (grace-music music-wrapper-music general-music))
236         ))
237
238     (HarmonicEvent
239      . ((description . "Mark a note as harmonic.")
240         (types . (general-music post-event event harmonic-event))
241         ))
242
243     (HyphenEvent
244      . ((description . "A hyphen between lyric syllables.")
245         (types . (general-music post-event hyphen-event event))
246         ))
247
248     (KeyChangeEvent
249      . ((description . "Change the key signature.
250
251 Syntax: @code{\\key} @var{name} @var{scale}")
252         (to-relative-callback . ,(lambda (x p) p))
253         (types . (general-music key-change-event event))
254         ))
255
256     (LabelEvent
257      . ((description . "Place a bookmarking label.")
258         (types . (general-music label-event event))
259         ))
260
261     (LaissezVibrerEvent
262      . ((description . "Don't damp this chord.
263
264 Syntax: @var{note}@code{\\laissezVibrer}")
265         (types . (general-music post-event event laissez-vibrer-event))
266         ))
267
268     (LigatureEvent
269      . ((description . "Start or end a ligature.")
270         (types . (general-music span-event ligature-event event))
271         ))
272
273     (LineBreakEvent
274      . ((description . "Allow, forbid or force a line break.")
275         (types . (general-music line-break-event break-event event))
276         ))
277
278     (LyricCombineMusic
279      . ((description . "Align lyrics to the start of notes.
280
281 Syntax: @code{\\lyricsto} @var{voicename} @var{lyrics}")
282         (length . ,ZERO-MOMENT)
283         (types . (general-music lyric-combine-music))
284         (iterator-ctor . ,ly:lyric-combine-music-iterator::constructor)
285         ))
286
287     (LyricEvent
288      . ((description . "A lyric syllable.  Must be entered in lyrics mode,
289 i.e., @code{\\lyrics @{ twinkle4 twinkle4 @} }.")
290         (types . (general-music rhythmic-event lyric-event event))
291         ))
292
293     (MarkEvent
294      . ((description . "Insert a rehearsal mark.
295
296 Syntax: @code{\\mark} @var{marker}
297
298 Example: @code{\\mark \"A\"}")
299         (types . (general-music mark-event event))
300         ))
301
302     (MultiMeasureRestEvent
303      . ((description . "Used internally by @code{MultiMeasureRestMusic}
304 to signal rests.")
305         (types . (general-music event rhythmic-event
306                   multi-measure-rest-event))
307         ))
308
309     (MultiMeasureRestMusic
310      . ((description . "Rests that may be compressed into Multi rests.
311
312 Syntax: @code{R2.*4} for 4 measures in 3/4 time.")
313         (iterator-ctor . ,ly:sequential-iterator::constructor)
314         (elements-callback . ,mm-rest-child-list)
315         (types . (general-music multi-measure-rest))
316         ))
317
318     (MultiMeasureTextEvent
319      . ((description . "Texts on multi measure rests.
320
321 Syntax: @code{R-\\markup @{ \\roman \"bla\" @}}
322
323 Note the explicit font switch.")
324         (types . (general-music post-event event multi-measure-text-event))
325         ))
326
327     (Music
328      . ((description . "Generic type for music expressions.")
329         (types . (general-music))
330         ))
331
332     (NoteEvent
333      . ((description . "A note.")
334         (iterator-ctor . ,ly:rhythmic-music-iterator::constructor)
335         (types . (general-music event note-event rhythmic-event
336                   melodic-event))
337         ))
338
339     (NoteGroupingEvent
340      . ((description . "Start or stop grouping brackets.")
341         (types . (general-music post-event event note-grouping-event))
342         ))
343
344     (OttavaMusic
345      . ((description . "Start or stop an ottava bracket.")
346         (iterator-ctor . ,ly:sequential-iterator::constructor)
347         (elements-callback . ,make-ottava-set)
348         (types . (general-music ottava-music))
349         ))
350
351     (OverrideProperty
352      . ((description . "Extend the definition of a graphical object.
353
354 Syntax: @code{\\override} [ @var{context} @code{.} ]
355 @var{object} @var{property} @code{=} @var{value}")
356         (types . (general-music layout-instruction-event
357                   override-property-event))
358         (iterator-ctor . ,ly:push-property-iterator::constructor)
359         ))
360
361     (PageBreakEvent
362      . ((description . "Allow, forbid or force a page break.")
363         (types . (general-music break-event page-break-event event))
364         ))
365
366     (PageTurnEvent
367      . ((description . "Allow, forbid or force a page turn.")
368         (types . (general-music break-event page-turn-event event))
369         ))
370
371     (PartCombineForceEvent
372      . ((description . "Override the part-combiner's strategy.")
373         (types . (general-music part-combine-force-event event))
374         ))
375
376     (PartialSet
377      . ((description . "Create an anacrusis or upbeat (partial measure).")
378         (iterator-ctor . ,ly:partial-iterator::constructor)
379         (types . (general-music partial-set))
380         ))
381
382     (PartCombineMusic
383      . ((description . "Combine two parts on a staff, either merged or
384 as separate voices.")
385         (length-callback . ,ly:music-sequence::maximum-length-callback)
386         (start-callback . ,ly:music-sequence::minimum-start-callback)
387         (types . (general-music part-combine-music))
388         (iterator-ctor . ,ly:part-combine-iterator::constructor)
389         ))
390
391     (PercentEvent
392      . ((description . "Used internally to signal percent repeats.")
393         (types . (general-music event percent-event rhythmic-event))
394         ))
395
396     (PercentRepeatedMusic
397      . ((description . "Repeats encoded by percents and slashes.")
398         (iterator-ctor . ,ly:percent-repeat-iterator::constructor)
399         (start-callback .  ,ly:repeated-music::first-start)
400         (length-callback . ,ly:repeated-music::unfolded-music-length)
401         (types . (general-music repeated-music percent-repeated-music))
402         ))
403
404     (PesOrFlexaEvent
405      . ((description . "Within a ligature, mark the previous and the
406 following note to form a pes (if melody goes up) or a flexa (if melody
407 goes down).")
408         (types . (general-music pes-or-flexa-event event))
409         ))
410
411     (PhrasingSlurEvent
412      . ((description . "Start or end phrasing slur.
413
414 Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}")
415         (spanner-id . "")
416         (types . (general-music post-event span-event event phrasing-slur-event))
417         ))
418
419     (PropertySet
420      . ((description . "Set a context property.
421
422 Syntax: @code{\\set @var{context}.@var{prop} = @var{scheme-val}}")
423         (types . (layout-instruction-event general-music))
424         (iterator-ctor . ,ly:property-iterator::constructor)
425         ))
426
427     (PropertyUnset
428      . ((description . "Restore the default setting for a context
429 property.  See @ref{PropertySet}.
430
431 Syntax: @code{\\unset @var{context}.@var{prop}}")
432         (types . (layout-instruction-event general-music))
433         (iterator-ctor . ,ly:property-unset-iterator::constructor)
434         ))
435
436     (QuoteMusic
437      . ((description . "Quote preprocessed snippets of music.")
438         (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
439         (length-callback . ,ly:music-wrapper::length-callback)
440         (start-callback . ,ly:music-wrapper::start-callback)
441         (types . (general-music music-wrapper-music))
442         ))
443
444     (RelativeOctaveCheck
445      . ((description . "Check if a pitch is in the correct octave.")
446         (to-relative-callback . ,ly:relative-octave-check::relative-callback)
447         (types . (general-music relative-octave-check))
448         ))
449
450     (RelativeOctaveMusic
451      . ((description . "Music that was entered in relative octave notation.")
452         (to-relative-callback . ,ly:relative-octave-music::relative-callback)
453         (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
454         (length-callback . ,ly:music-wrapper::length-callback)
455         (start-callback . ,ly:music-wrapper::start-callback)
456         (types . (music-wrapper-music general-music relative-octave-music))
457         ))
458
459     (RepeatedChord
460      . ((description . "A chord repetition")
461         (to-relative-callback . ,ly:music-sequence::repeated-chord-relative-callback)
462         (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
463         (start-callback . ,ly:music-wrapper::start-callback)
464         (length-callback . ,ly:music-wrapper::length-callback)
465         (types . (general-music music-wrapper-music))
466         ))
467
468     (RepeatedMusic
469      . ((description . "Repeat music in different ways.")
470         (types . (general-music repeated-music))
471         ))
472
473     (RepeatSlashEvent
474      . ((description . "Used internally to signal beat repeats.")
475         (types . (general-music event repeat-slash-event rhythmic-event))
476         ))
477
478     (RepeatTieEvent
479      . ((description . "Ties for starting a second volta bracket.")
480         (types . (general-music post-event event repeat-tie-event))
481         ))
482
483     (RestEvent
484      . ((description . "A Rest.
485
486 Syntax: @code{r4} for a quarter rest.")
487         (iterator-ctor . ,ly:rhythmic-music-iterator::constructor)
488         (types . (general-music event rhythmic-event rest-event))
489         ))
490
491     (RevertProperty
492      . ((description . "The opposite of @ref{OverrideProperty}: remove a
493 previously added property from a graphical object definition.")
494         (types . (general-music layout-instruction-event))
495         (iterator-ctor . ,ly:pop-property-iterator::constructor)
496         ))
497
498     (ScriptEvent
499      . ((description . "Add an articulation mark to a note.")
500         (types . (general-music event))
501         ))
502
503     (SequentialMusic
504      . ((description . "Music expressions concatenated.
505
506 Syntax: @code{\\sequential @{ @dots{} @}} or simply @code{@{ @dots{} @}}")
507         (length-callback . ,ly:music-sequence::cumulative-length-callback)
508         (start-callback . ,ly:music-sequence::first-start-callback)
509         (elements-callback . ,(lambda (m) (ly:music-property m 'elements)))
510         (iterator-ctor . ,ly:sequential-iterator::constructor)
511         (types . (general-music sequential-music))
512         ))
513
514     (SimultaneousMusic
515      . ((description . "Music playing together.
516
517 Syntax: @code{\\simultaneous @{ @dots{} @}} or @code{<< @dots{} >>}")
518         (iterator-ctor . ,ly:simultaneous-music-iterator::constructor)
519         (start-callback . ,ly:music-sequence::minimum-start-callback)
520         (length-callback . ,ly:music-sequence::maximum-length-callback)
521         (to-relative-callback .
522          ,ly:music-sequence::simultaneous-relative-callback)
523         (types . (general-music simultaneous-music))
524         ))
525
526     (SkipEvent
527      . ((description . "Filler that takes up duration, but does not
528 print anything.
529
530 Syntax: @code{s4} for a skip equivalent to a quarter rest.")
531         (types . (general-music event rhythmic-event skip-event))
532         ))
533
534     (SkipMusic
535      . ((description . "Filler that takes up duration, does not
536 print anything, and also does not create staves or voices implicitly.
537
538 Syntax: @code{\\skip} @var{duration}")
539         (length-callback . ,ly:music-duration-length)
540         (iterator-ctor . ,ly:simple-music-iterator::constructor)
541         (types . (general-music event rhythmic-event skip-event))
542         ))
543
544     (SlurEvent
545      . ((description . "Start or end slur.
546
547 Syntax: @var{note}@code{(} and @var{note}@code{)}")
548         (spanner-id . "")
549         (types . (general-music post-event span-event event slur-event))
550         ))
551
552     (SoloOneEvent
553      . ((description . "Print @q{Solo@tie{}1}.")
554         (part-combine-status . solo1)
555         (types . (general-music event part-combine-event solo-one-event))
556         ))
557
558     (SoloTwoEvent
559      . ((description . "Print @q{Solo@tie{}2}.")
560         (part-combine-status . solo2)
561         (types . (general-music event part-combine-event solo-two-event))
562         ))
563
564     (SostenutoEvent
565      . ((description . "Depress or release sostenuto pedal.")
566         (types . (general-music post-event event pedal-event sostenuto-event))
567         ))
568
569     (SpacingSectionEvent
570      . ((description . "Start a new spacing section.")
571         (types . (general-music event spacing-section-event))))
572
573     (SpanEvent
574      . ((description . "Event for anything that is started at a
575 different time than stopped.")
576         (types . (general-music event))
577         ))
578
579     (StaffSpanEvent
580      . ((description . "Start or stop a staff symbol.")
581         (types . (general-music event span-event staff-span-event))
582      ))
583
584     (StringNumberEvent
585      . ((description . "Specify on which string to play this note.
586
587 Syntax: @code{\\@var{number}}")
588         (types . (general-music post-event string-number-event event))
589         ))
590
591     (StrokeFingerEvent
592      . ((description . "Specify with which finger to pluck a string.
593
594 Syntax: @code{\\rightHandFinger @var{text}}")
595         (types . (general-music post-event stroke-finger-event event))
596         ))
597
598     (SustainEvent
599      . ((description . "Depress or release sustain pedal.")
600         (types . (general-music post-event event pedal-event sustain-event))
601         ))
602
603     (TempoChangeEvent
604      . ((description . "A metronome mark or tempo indication.")
605         (types . (general-music event tempo-change-event))
606         ))
607
608     (TextScriptEvent
609      . ((description . "Print text.")
610         (types . (general-music post-event script-event text-script-event event))
611         ))
612
613     (TextSpanEvent
614      . ((description . "Start a text spanner, for example, an
615 octavation.")
616         (types . (general-music post-event span-event event text-span-event))
617         ))
618
619     (TieEvent
620      . ((description . "A tie.
621
622 Syntax: @w{@var{note}@code{-~}}")
623         (types . (general-music post-event tie-event event))
624         ))
625
626     (TimeScaledMusic
627      . ((description . "Multiply durations, as in tuplets.
628
629 Syntax: @code{\\times @var{fraction} @var{music}}, e.g.,
630 @code{\\times 2/3 @{ @dots{} @}} for triplets.")
631         (length-callback . ,ly:music-wrapper::length-callback)
632         (start-callback . ,ly:music-wrapper::start-callback)
633         (iterator-ctor . ,ly:tuplet-iterator::constructor)
634         (types . (time-scaled-music music-wrapper-music general-music))
635         ))
636
637     (TimeSignatureMusic
638      . ((description . "Set a new time signature")
639         (iterator-ctor . ,ly:sequential-iterator::constructor)
640         (elements-callback . ,make-time-signature-set)
641         (types . (general-music time-signature-music))
642         ))
643
644     (TransposedMusic
645      . ((description . "Music that has been transposed.")
646         (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
647         (start-callback . ,ly:music-wrapper::start-callback)
648         (length-callback . ,ly:music-wrapper::length-callback)
649         (to-relative-callback .
650          ,ly:relative-octave-music::no-relative-callback)
651         (types . (music-wrapper-music general-music transposed-music))
652         ))
653
654     (TremoloEvent
655      . ((description . "Unmeasured tremolo.")
656         (types . (general-music post-event event tremolo-event))
657         ))
658
659     (TremoloRepeatedMusic
660      . ((description . "Repeated notes denoted by tremolo beams.")
661         (iterator-ctor . ,ly:chord-tremolo-iterator::constructor)
662         (start-callback .  ,ly:repeated-music::first-start)
663         ;; the length of the repeat is handled by shifting the note logs
664         (length-callback . ,ly:repeated-music::folded-music-length)
665         (types . (general-music repeated-music tremolo-repeated-music))
666         ))
667
668     (TremoloSpanEvent
669      . ((description . "Tremolo over two stems.")
670         (types . (general-music event span-event tremolo-span-event))
671         ))
672
673     (TrillSpanEvent
674      . ((description . "Start a trill spanner.")
675         (types . (general-music post-event span-event event trill-span-event))
676         ))
677
678     (TupletSpanEvent
679      . ((description . "Used internally to signal where tuplet
680 brackets start and stop.")
681         (types . (tuplet-span-event span-event event general-music post-event))
682        ))
683
684     (UnaCordaEvent
685      . ((description . "Depress or release una-corda pedal.")
686         (types . (general-music post-event event pedal-event una-corda-event))
687         ))
688
689     (UnfoldedRepeatedMusic
690      . ((description . "Repeated music which is fully written
691 (and played) out.")
692         (iterator-ctor . ,ly:unfolded-repeat-iterator::constructor)
693         (start-callback .  ,ly:repeated-music::first-start)
694         (types . (general-music repeated-music unfolded-repeated-music))
695         (length-callback . ,ly:repeated-music::unfolded-music-length)
696         ))
697
698     (UnisonoEvent
699      . ((description . "Print @q{a@tie{}2}.")
700         (part-combine-status . unisono)
701         (types . (general-music event part-combine-event unisono-event))))
702
703     (UnrelativableMusic
704      . ((description . "Music that cannot be converted from relative
705 to absolute notation.  For example, transposed music.")
706         (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
707         (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
708         (length-callback . ,ly:music-wrapper::length-callback)
709         (types . (music-wrapper-music general-music unrelativable-music))
710         ))
711
712     (VoiceSeparator
713      . ((description . "Separate polyphonic voices in simultaneous music.
714
715 Syntax: @code{\\\\}")
716         (types . (separator general-music))
717         ))
718
719     (VoltaRepeatedMusic
720      . ((description . "Repeats with alternatives placed sequentially.")
721         (iterator-ctor . ,ly:volta-repeat-iterator::constructor)
722         (elements-callback . ,make-volta-set)
723         (start-callback .  ,ly:repeated-music::first-start)
724         (length-callback . ,ly:repeated-music::volta-music-length)
725         (types . (general-music repeated-music volta-repeated-music))
726         ))
727     ))
728
729 (set! music-descriptions
730       (sort music-descriptions alist<?))
731
732 (define-public music-name-to-property-table (make-hash-table 59))
733
734 ;; init hash table,
735 ;; transport description to an object property.
736 (set!
737  music-descriptions
738  (map (lambda (x)
739         (set-object-property! (car x)
740                               'music-description
741                               (cdr (assq 'description (cdr x))))
742         (let ((lst (cdr x)))
743           (set! lst (assoc-set! lst 'name (car x)))
744           (set! lst (assq-remove! lst 'description))
745           (hashq-set! music-name-to-property-table (car x) lst)
746           (cons (car x) lst)))
747       music-descriptions))
748
749 (define-safe-public (make-music name . music-properties)
750   "Create a music object of given name, and set its properties
751 according to @code{music-properties}, a list of alternating property symbols
752 and values. E.g:
753   (make-music 'OverrideProperty
754               'symbol 'Stem
755               'grob-property 'thickness
756               'grob-value (* 2 1.5))"
757   (if (not (symbol? name))
758       (ly:error (_ "symbol expected: ~S") name))
759   (let ((props (hashq-ref music-name-to-property-table name '())))
760     (if (not (pair? props))
761         (ly:error (_ "cannot find music object: ~S") name))
762     (let ((m (ly:make-music props)))
763       (define (set-props mus-props)
764         (if (and (not (null? mus-props))
765                  (not (null? (cdr mus-props))))
766             (begin
767               (set! (ly:music-property m (car mus-props)) (cadr mus-props))
768               (set-props (cddr mus-props)))))
769       (set-props music-properties)
770       m)))
771
772 (define-public (make-repeated-music name)
773   (let* ((repeated-music (assoc-get name '(("volta" . VoltaRepeatedMusic)
774                                            ("unfold" . UnfoldedRepeatedMusic)
775                                            ("percent" . PercentRepeatedMusic)
776                                            ("tremolo" . TremoloRepeatedMusic))))
777          (repeated-music-name (if repeated-music
778                                   repeated-music
779                                   (begin
780                                     (ly:warning (_ "unknown repeat type `~S'") name)
781                                     (ly:warning (_ "See define-music-types.scm for supported repeats"))
782                                     'VoltaRepeatedMusic))))
783     (make-music repeated-music-name)))