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     (MeasureCounterEvent
 313      . ((description . "Used to signal the start and end of a measure count.")
 314         (types . (general-music measure-counter-event span-event event))
 315         ))
 316
 317     (MultiMeasureRestEvent
 318      . ((description . "Used internally by @code{MultiMeasureRestMusic}
 319 to signal rests.")
 320         (types . (general-music event rhythmic-event
 321                   multi-measure-rest-event))
 322         ))
 323
 324     (MultiMeasureRestMusic
 325      . ((description . "Rests that may be compressed into Multi rests.
 326
 327 Syntax: @code{R2.*4} for 4 measures in 3/4 time.")
 328         (iterator-ctor . ,ly:sequential-iterator::constructor)
 329         (elements-callback . ,mm-rest-child-list)
 330         (types . (general-music multi-measure-rest))
 331         ))
 332
 333     (MultiMeasureTextEvent
 334      . ((description . "Texts on multi measure rests.
 335
 336 Syntax: @code{R-\\markup @{ \\roman \"bla\" @}}
 337
 338 Note the explicit font switch.")
 339         (types . (general-music post-event event multi-measure-text-event))
 340         ))
 341
 342     (Music
 343      . ((description . "Generic type for music expressions.")
 344         (types . (general-music))
 345         ))
 346
 347     (NoteEvent
 348      . ((description . "A note.
 349
 350 Outside of chords, any events in @code{articulations} with a listener
 351 are broadcast like chord articulations, the others are retained.
 352
 353 For iteration inside of chords, @xref{EventChord}.")
 354         (iterator-ctor . ,ly:rhythmic-music-iterator::constructor)
 355         (types . (general-music event note-event rhythmic-event
 356                   melodic-event))
 357         ))
 358
 359     (NoteGroupingEvent
 360      . ((description . "Start or stop grouping brackets.")
 361         (types . (general-music post-event event note-grouping-event))
 362         ))
 363
 364     (OttavaMusic
 365      . ((description . "Start or stop an ottava bracket.")
 366         (iterator-ctor . ,ly:sequential-iterator::constructor)
 367         (elements-callback . ,make-ottava-set)
 368         (types . (general-music ottava-music))
 369         ))
 370
 371     (OverrideProperty
 372      . ((description . "Extend the definition of a graphical object.
 373
 374 Syntax: @code{\\override} [ @var{context} @code{.} ]
 375 @var{object} @var{property} @code{=} @var{value}")
 376         (types . (general-music layout-instruction-event
 377                   override-property-event))
 378         (iterator-ctor . ,ly:push-property-iterator::constructor)
 379         ))
 380
 381     (PageBreakEvent
 382      . ((description . "Allow, forbid or force a page break.")
 383         (types . (general-music break-event page-break-event event))
 384         ))
 385
 386     (PageTurnEvent
 387      . ((description . "Allow, forbid or force a page turn.")
 388         (types . (general-music break-event page-turn-event event))
 389         ))
 390
 391     (PartCombineForceEvent
 392      . ((description . "Override the part-combiner's strategy.")
 393         (types . (general-music part-combine-force-event event))
 394         ))
 395
 396     (PartialSet
 397      . ((description . "Create an anacrusis or upbeat (partial measure).")
 398         (iterator-ctor . ,ly:partial-iterator::constructor)
 399         (types . (general-music partial-set))
 400         ))
 401
 402     (PartCombineMusic
 403      . ((description . "Combine two parts on a staff, either merged or
 404 as separate voices.")
 405         (length-callback . ,ly:music-sequence::maximum-length-callback)
 406         (start-callback . ,ly:music-sequence::minimum-start-callback)
 407         (types . (general-music part-combine-music))
 408         (iterator-ctor . ,ly:part-combine-iterator::constructor)
 409         ))
 410
 411     (PercentEvent
 412      . ((description . "Used internally to signal percent repeats.")
 413         (types . (general-music event percent-event rhythmic-event))
 414         ))
 415
 416     (PercentRepeatedMusic
 417      . ((description . "Repeats encoded by percents and slashes.")
 418         (iterator-ctor . ,ly:percent-repeat-iterator::constructor)
 419         (start-callback .  ,ly:repeated-music::first-start)
 420         (length-callback . ,ly:repeated-music::unfolded-music-length)
 421         (types . (general-music repeated-music percent-repeated-music))
 422         ))
 423
 424     (PesOrFlexaEvent
 425      . ((description . "Within a ligature, mark the previous and the
 426 following note to form a pes (if melody goes up) or a flexa (if melody
 427 goes down).")
 428         (types . (general-music pes-or-flexa-event event))
 429         ))
 430
 431     (PhrasingSlurEvent
 432      . ((description . "Start or end phrasing slur.
 433
 434 Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}")
 435         (spanner-id . "")
 436         (types . (general-music post-event span-event event phrasing-slur-event))
 437         ))
 438
 439     (PropertySet
 440      . ((description . "Set a context property.
 441
 442 Syntax: @code{\\set @var{context}.@var{prop} = @var{scheme-val}}")
 443         (types . (layout-instruction-event general-music))
 444         (iterator-ctor . ,ly:property-iterator::constructor)
 445         ))
 446
 447     (PropertyUnset
 448      . ((description . "Restore the default setting for a context
 449 property.  See @ref{PropertySet}.
 450
 451 Syntax: @code{\\unset @var{context}.@var{prop}}")
 452         (types . (layout-instruction-event general-music))
 453         (iterator-ctor . ,ly:property-unset-iterator::constructor)
 454         ))
 455
 456     (QuoteMusic
 457      . ((description . "Quote preprocessed snippets of music.")
 458         (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
 459         (length-callback . ,ly:music-wrapper::length-callback)
 460         (start-callback . ,ly:music-wrapper::start-callback)
 461         (types . (general-music music-wrapper-music))
 462         ))
 463
 464     (RelativeOctaveCheck
 465      . ((description . "Check if a pitch is in the correct octave.")
 466         (to-relative-callback . ,ly:relative-octave-check::relative-callback)
 467         (types . (general-music relative-octave-check))
 468         ))
 469
 470     (RelativeOctaveMusic
 471      . ((description . "Music that was entered in relative octave notation.")
 472         (to-relative-callback . ,ly:relative-octave-music::relative-callback)
 473         (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
 474         (length-callback . ,ly:music-wrapper::length-callback)
 475         (start-callback . ,ly:music-wrapper::start-callback)
 476         (types . (music-wrapper-music general-music relative-octave-music))
 477         ))
 478
 479     (RepeatedMusic
 480      . ((description . "Repeat music in different ways.")
 481         (types . (general-music repeated-music))
 482         ))
 483
 484     (RepeatSlashEvent
 485      . ((description . "Used internally to signal beat repeats.")
 486         (types . (general-music event repeat-slash-event rhythmic-event))
 487         ))
 488
 489     (RepeatTieEvent
 490      . ((description . "Ties for starting a second volta bracket.")
 491         (types . (general-music post-event event repeat-tie-event))
 492         ))
 493
 494     (RestEvent
 495      . ((description . "A Rest.
 496
 497 Syntax: @code{r4} for a quarter rest.")
 498         (iterator-ctor . ,ly:rhythmic-music-iterator::constructor)
 499         (types . (general-music event rhythmic-event rest-event))
 500         ))
 501
 502     (RevertProperty
 503      . ((description . "The opposite of @ref{OverrideProperty}: remove a
 504 previously added property from a graphical object definition.")
 505         (types . (general-music layout-instruction-event))
 506         (iterator-ctor . ,ly:pop-property-iterator::constructor)
 507         ))
 508
 509     (ScriptEvent
 510      . ((description . "Add an articulation mark to a note.")
 511         (types . (general-music event))
 512         ))
 513
 514     (SequentialMusic
 515      . ((description . "Music expressions concatenated.
 516
 517 Syntax: @code{\\sequential @{ @dots{} @}} or simply @code{@{ @dots{} @}}")
 518         (length-callback . ,ly:music-sequence::cumulative-length-callback)
 519         (start-callback . ,ly:music-sequence::first-start-callback)
 520         (elements-callback . ,(lambda (m) (ly:music-property m 'elements)))
 521         (iterator-ctor . ,ly:sequential-iterator::constructor)
 522         (types . (general-music sequential-music))
 523         ))
 524
 525     (SimultaneousMusic
 526      . ((description . "Music playing together.
 527
 528 Syntax: @code{\\simultaneous @{ @dots{} @}} or @code{<< @dots{} >>}")
 529         (iterator-ctor . ,ly:simultaneous-music-iterator::constructor)
 530         (start-callback . ,ly:music-sequence::minimum-start-callback)
 531         (length-callback . ,ly:music-sequence::maximum-length-callback)
 532         (to-relative-callback .
 533          ,ly:music-sequence::simultaneous-relative-callback)
 534         (types . (general-music simultaneous-music))
 535         ))
 536
 537     (SkipEvent
 538      . ((description . "Filler that takes up duration, but does not
 539 print anything.
 540
 541 Syntax: @code{s4} for a skip equivalent to a quarter rest.")
 542         (iterator-ctor . ,ly:rhythmic-music-iterator::constructor)
 543         (types . (general-music event rhythmic-event skip-event))
 544         ))
 545
 546     (SkipMusic
 547      . ((description . "Filler that takes up duration, does not
 548 print anything, and also does not create staves or voices implicitly.
 549
 550 Syntax: @code{\\skip} @var{duration}")
 551         (length-callback . ,ly:music-duration-length)
 552         (iterator-ctor . ,ly:simple-music-iterator::constructor)
 553         (types . (general-music event skip-event))
 554         ))
 555
 556     (SlurEvent
 557      . ((description . "Start or end slur.
 558
 559 Syntax: @var{note}@code{(} and @var{note}@code{)}")
 560         (spanner-id . "")
 561         (types . (general-music post-event span-event event slur-event))
 562         ))
 563
 564     (SoloOneEvent
 565      . ((description . "Print @q{Solo@tie{}1}.")
 566         (part-combine-status . solo1)
 567         (types . (general-music event part-combine-event solo-one-event))
 568         ))
 569
 570     (SoloTwoEvent
 571      . ((description . "Print @q{Solo@tie{}2}.")
 572         (part-combine-status . solo2)
 573         (types . (general-music event part-combine-event solo-two-event))
 574         ))
 575
 576     (SostenutoEvent
 577      . ((description . "Depress or release sostenuto pedal.")
 578         (types . (general-music post-event event pedal-event sostenuto-event))
 579         ))
 580
 581     (SpacingSectionEvent
 582      . ((description . "Start a new spacing section.")
 583         (types . (general-music event spacing-section-event))))
 584
 585     (SpanEvent
 586      . ((description . "Event for anything that is started at a
 587 different time than stopped.")
 588         (types . (general-music event))
 589         ))
 590
 591     (StaffSpanEvent
 592      . ((description . "Start or stop a staff symbol.")
 593         (types . (general-music event span-event staff-span-event))
 594      ))
 595
 596     (StringNumberEvent
 597      . ((description . "Specify on which string to play this note.
 598
 599 Syntax: @code{\\@var{number}}")
 600         (types . (general-music post-event string-number-event event))
 601         ))
 602
 603     (StrokeFingerEvent
 604      . ((description . "Specify with which finger to pluck a string.
 605
 606 Syntax: @code{\\rightHandFinger @var{text}}")
 607         (types . (general-music post-event stroke-finger-event event))
 608         ))
 609
 610     (SustainEvent
 611      . ((description . "Depress or release sustain pedal.")
 612         (types . (general-music post-event event pedal-event sustain-event))
 613         ))
 614
 615     (TempoChangeEvent
 616      . ((description . "A metronome mark or tempo indication.")
 617         (types . (general-music event tempo-change-event))
 618         ))
 619
 620     (TextScriptEvent
 621      . ((description . "Print text.")
 622         (types . (general-music post-event script-event text-script-event event))
 623         ))
 624
 625     (TextSpanEvent
 626      . ((description . "Start a text spanner, for example, an
 627 octavation.")
 628         (types . (general-music post-event span-event event text-span-event))
 629         ))
 630
 631     (TieEvent
 632      . ((description . "A tie.
 633
 634 Syntax: @w{@var{note}@code{-~}}")
 635         (types . (general-music post-event tie-event event))
 636         ))
 637
 638     (TimeScaledMusic
 639      . ((description . "Multiply durations, as in tuplets.
 640
 641 Syntax: @code{\\times @var{fraction} @var{music}}, e.g.,
 642 @code{\\times 2/3 @{ @dots{} @}} for triplets.")
 643         (length-callback . ,ly:music-wrapper::length-callback)
 644         (start-callback . ,ly:music-wrapper::start-callback)
 645         (iterator-ctor . ,ly:tuplet-iterator::constructor)
 646         (types . (time-scaled-music music-wrapper-music general-music))
 647         ))
 648
 649     (TimeSignatureMusic
 650      . ((description . "Set a new time signature")
 651         (iterator-ctor . ,ly:sequential-iterator::constructor)
 652         (elements-callback . ,make-time-signature-set)
 653         (types . (general-music time-signature-music))
 654         ))
 655
 656     (TransposedMusic
 657      . ((description . "Music that has been transposed.")
 658         (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
 659         (start-callback . ,ly:music-wrapper::start-callback)
 660         (length-callback . ,ly:music-wrapper::length-callback)
 661         (to-relative-callback .
 662          ,ly:relative-octave-music::no-relative-callback)
 663         (types . (music-wrapper-music general-music transposed-music))
 664         ))
 665
 666     (TremoloEvent
 667      . ((description . "Unmeasured tremolo.")
 668         (types . (general-music post-event event tremolo-event))
 669         ))
 670
 671     (TremoloRepeatedMusic
 672      . ((description . "Repeated notes denoted by tremolo beams.")
 673         (iterator-ctor . ,ly:chord-tremolo-iterator::constructor)
 674         (start-callback .  ,ly:repeated-music::first-start)
 675         ;; the length of the repeat is handled by shifting the note logs
 676         (length-callback . ,ly:repeated-music::folded-music-length)
 677         (types . (general-music repeated-music tremolo-repeated-music))
 678         ))
 679
 680     (TremoloSpanEvent
 681      . ((description . "Tremolo over two stems.")
 682         (types . (general-music event span-event tremolo-span-event))
 683         ))
 684
 685     (TrillSpanEvent
 686      . ((description . "Start a trill spanner.")
 687         (types . (general-music post-event span-event event trill-span-event))
 688         ))
 689
 690     (TupletSpanEvent
 691      . ((description . "Used internally to signal where tuplet
 692 brackets start and stop.")
 693         (types . (tuplet-span-event span-event event general-music post-event))
 694        ))
 695
 696     (UnaCordaEvent
 697      . ((description . "Depress or release una-corda pedal.")
 698         (types . (general-music post-event event pedal-event una-corda-event))
 699         ))
 700
 701     (UnfoldedRepeatedMusic
 702      . ((description . "Repeated music which is fully written
 703 (and played) out.")
 704         (iterator-ctor . ,ly:unfolded-repeat-iterator::constructor)
 705         (start-callback .  ,ly:repeated-music::first-start)
 706         (types . (general-music repeated-music unfolded-repeated-music))
 707         (length-callback . ,ly:repeated-music::unfolded-music-length)
 708         ))
 709
 710     (UnisonoEvent
 711      . ((description . "Print @q{a@tie{}2}.")
 712         (part-combine-status . unisono)
 713         (types . (general-music event part-combine-event unisono-event))))
 714
 715     (UnrelativableMusic
 716      . ((description . "Music that cannot be converted from relative
 717 to absolute notation.  For example, transposed music.")
 718         (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
 719         (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
 720         (length-callback . ,ly:music-wrapper::length-callback)
 721         (types . (music-wrapper-music general-music unrelativable-music))
 722         ))
 723
 724     (VoiceSeparator
 725      . ((description . "Separate polyphonic voices in simultaneous music.
 726
 727 Syntax: @code{\\\\}")
 728         (types . (separator general-music))
 729         ))
 730
 731     (VoltaRepeatedMusic
 732      . ((description . "Repeats with alternatives placed sequentially.")
 733         (iterator-ctor . ,ly:volta-repeat-iterator::constructor)
 734         (elements-callback . ,make-volta-set)
 735         (start-callback .  ,ly:repeated-music::first-start)
 736         (length-callback . ,ly:repeated-music::volta-music-length)
 737         (types . (general-music repeated-music volta-repeated-music))
 738         ))
 739     ))
 740
 741 (set! music-descriptions
 742       (sort music-descriptions alist<?))
 743
 744 (define-public music-name-to-property-table (make-hash-table 59))
 745
 746 ;; init hash table,
 747 ;; transport description to an object property.
 748 (set!
 749  music-descriptions
 750  (map (lambda (x)
 751         (set-object-property! (car x)
 752                               'music-description
 753                               (cdr (assq 'description (cdr x))))
 754         (let ((lst (cdr x)))
 755           (set! lst (assoc-set! lst 'name (car x)))
 756           (set! lst (assq-remove! lst 'description))
 757           (hashq-set! music-name-to-property-table (car x) lst)
 758           (cons (car x) lst)))
 759       music-descriptions))
 760
 761 (define-safe-public (make-music name . music-properties)
 762   "Create a music object of given name, and set its properties
 763 according to @code{music-properties}, a list of alternating property symbols
 764 and values. E.g:
 765   (make-music 'OverrideProperty
 766               'symbol 'Stem
 767               'grob-property 'thickness
 768               'grob-value (* 2 1.5))"
 769   (if (not (symbol? name))
 770       (ly:error (_ "symbol expected: ~S") name))
 771   (let ((props (hashq-ref music-name-to-property-table name '())))
 772     (if (not (pair? props))
 773         (ly:error (_ "cannot find music object: ~S") name))
 774     (let ((m (ly:make-music props)))
 775       (define (set-props mus-props)
 776         (if (and (not (null? mus-props))
 777                  (not (null? (cdr mus-props))))
 778             (begin
 779               (set! (ly:music-property m (car mus-props)) (cadr mus-props))
 780               (set-props (cddr mus-props)))))
 781       (set-props music-properties)
 782       m)))
 783
 784 (define-public (make-repeated-music name)
 785   (let* ((repeated-music (assoc-get name '(("volta" . VoltaRepeatedMusic)
 786                                            ("unfold" . UnfoldedRepeatedMusic)
 787                                            ("percent" . PercentRepeatedMusic)
 788                                            ("tremolo" . TremoloRepeatedMusic))))
 789          (repeated-music-name (if repeated-music
 790                                   repeated-music
 791                                   (begin
 792                                     (ly:warning (_ "unknown repeat type `~S'") name)
 793                                     (ly:warning (_ "See define-music-types.scm for supported repeats"))
 794                                     'VoltaRepeatedMusic))))
 795     (make-music repeated-music-name)))