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