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