1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
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.
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.
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/>.
19 ; for define-safe-public when byte-compiling using Guile V2
20 (use-modules (scm safe-utility-defs))
22 ;; TODO: should link back into user manual.
24 (define-public music-descriptions
27 . ((description . "Create a dynamic mark.
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))
36 . ((description . "Create a alternative event.")
37 (types . (general-music event alternative-event))
41 . ((description . "Print an annotation of an output element.")
42 (types . (general-music event annotate-output-event))
46 . ((description . "Call the argument with the current context during
48 (types . (general-music apply-context))
49 (iterator-ctor . ,ly:apply-context-iterator::constructor)
53 . ((description . "Call the argument with all current grobs during
56 Syntax: @code{\\applyOutput #'@var{context} @var{func}}
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))
64 . ((description . "Make an arpeggio on this note.
66 Syntax: @w{@var{note}@code{-\\arpeggio}}")
67 (types . (general-music post-event arpeggio-event event))
70 ;; todo: use articulation-event for slur as well.
71 ;; separate non articulation scripts
73 . ((description . "Add an articulation marking to a note.
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))
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))
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)
100 . ((description . "Print a bass-figure text.")
101 (types . (general-music event rhythmic-event bass-figure-event))
105 . ((description . "Start or stop a beam.
107 Syntax for manual control: @code{c8-[ c c-] c8}")
108 (types . (general-music post-event event beam-event span-event))
112 . ((description . "Specify that a note may not auto-beamed.")
113 (types . (general-music post-event event beam-forbid-event))
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))
122 . ((description . "A drop/@/fall/@/doit jazz articulation.")
123 (types . (general-music post-event bend-after-event event))))
126 . ((description . "Create a @q{breath mark} or @q{comma}.
128 Syntax: @var{note}@code{\\breathe}")
130 (types . (general-music event breathing-event))
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))
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))
149 . ((description . "Change staves in Piano staff.
151 Syntax: @code{\\change Staff = @var{new-id}}")
152 (iterator-ctor . ,ly:change-iterator::constructor)
153 (types . (general-music translator-change-instruction))
157 . ((description . "Interpret the argument music within a
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))
166 . ((description . "Begin or end a crescendo.
168 Syntax: @var{note}@code{\\<} @dots{} @var{note}@code{\\!}
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
177 . ((description . "Begin or end a decrescendo.
179 Syntax: @var{note}@code{\\>} @dots{} @var{note}@code{\\!}
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
188 . ((description . "Used internally to signal double percent repeats.")
189 (types . (general-music event double-percent-event rhythmic-event))
193 . ((description . "Begin or end an episema.")
194 (types . (general-music post-event span-event event episema-event))
198 . ((description . "Atomic music event.")
199 (types . (general-music event))
203 . ((description . "Explicitly entered chords.
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}.
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))
220 . ((description . "Extend lyrics.")
221 (types . (general-music post-event extender-event event))
225 . ((description . "Specify what finger to use for this note.")
226 (types . (general-music post-event fingering-event event))
230 . ((description . "Footnote a grob.")
231 (types . (general-music event footnote-event))
235 . ((description . "Start a glissando on this note.")
236 (types . (general-music post-event glissando-event event))
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))
248 . ((description . "Mark a note as harmonic.")
249 (types . (general-music post-event event harmonic-event))
253 . ((description . "A hyphen between lyric syllables.")
254 (types . (general-music post-event hyphen-event event))
258 . ((description . "Change the key signature.
260 Syntax: @code{\\key} @var{name} @var{scale}")
261 (to-relative-callback . ,(lambda (x p) p))
262 (types . (general-music key-change-event event))
266 . ((description . "Place a bookmarking label.")
267 (types . (general-music label-event event))
271 . ((description . "Don't damp this chord.
273 Syntax: @var{note}@code{\\laissezVibrer}")
274 (types . (general-music post-event event laissez-vibrer-event))
278 . ((description . "Start or end a ligature.")
279 (types . (general-music span-event ligature-event event))
283 . ((description . "Allow, forbid or force a line break.")
284 (types . (general-music line-break-event break-event event))
288 . ((description . "Align lyrics to the start of notes.
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)
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))
304 . ((description . "Insert a rehearsal mark.
306 Syntax: @code{\\mark} @var{marker}
308 Example: @code{\\mark \"A\"}")
309 (types . (general-music mark-event event))
313 . ((description . "Used to signal the start and end of a measure count.")
314 (types . (general-music measure-counter-event span-event event))
317 (MultiMeasureRestEvent
318 . ((description . "Used internally by @code{MultiMeasureRestMusic}
320 (types . (general-music event rhythmic-event
321 multi-measure-rest-event))
324 (MultiMeasureRestMusic
325 . ((description . "Rests that may be compressed into Multi rests.
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))
333 (MultiMeasureTextEvent
334 . ((description . "Texts on multi measure rests.
336 Syntax: @code{R-\\markup @{ \\roman \"bla\" @}}
338 Note the explicit font switch.")
339 (types . (general-music post-event event multi-measure-text-event))
343 . ((description . "Generic type for music expressions.")
344 (types . (general-music))
348 . ((description . "A note.
350 Outside of chords, any events in @code{articulations} with a listener
351 are broadcast like chord articulations, the others are retained.
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
360 . ((description . "Start or stop grouping brackets.")
361 (types . (general-music post-event event note-grouping-event))
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))
372 . ((description . "Extend the definition of a graphical object.
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)
382 . ((description . "Allow, forbid or force a page break.")
383 (types . (general-music break-event page-break-event event))
387 . ((description . "Allow, forbid or force a page turn.")
388 (types . (general-music break-event page-turn-event event))
391 (PartCombineForceEvent
392 . ((description . "Override the part-combiner's strategy.")
393 (types . (general-music part-combine-force-event event))
397 . ((description . "Create an anacrusis or upbeat (partial measure).")
398 (iterator-ctor . ,ly:partial-iterator::constructor)
399 (types . (general-music partial-set))
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)
412 . ((description . "Used internally to signal percent repeats.")
413 (types . (general-music event percent-event rhythmic-event))
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))
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
428 (types . (general-music pes-or-flexa-event event))
432 . ((description . "Start or end phrasing slur.
434 Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}")
436 (types . (general-music post-event span-event event phrasing-slur-event))
440 . ((description . "Set a context property.
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)
448 . ((description . "Restore the default setting for a context
449 property. See @ref{PropertySet}.
451 Syntax: @code{\\unset @var{context}.@var{prop}}")
452 (types . (layout-instruction-event general-music))
453 (iterator-ctor . ,ly:property-unset-iterator::constructor)
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))
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))
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))
480 . ((description . "Repeat music in different ways.")
481 (types . (general-music repeated-music))
485 . ((description . "Used internally to signal beat repeats.")
486 (types . (general-music event repeat-slash-event rhythmic-event))
490 . ((description . "Ties for starting a second volta bracket.")
491 (types . (general-music post-event event repeat-tie-event))
495 . ((description . "A Rest.
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))
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)
510 . ((description . "Add an articulation mark to a note.")
511 (types . (general-music event))
515 . ((description . "Music expressions concatenated.
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))
526 . ((description . "Music playing together.
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))
538 . ((description . "Filler that takes up duration, but does not
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))
547 . ((description . "Filler that takes up duration, does not
548 print anything, and also does not create staves or voices implicitly.
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))
557 . ((description . "Start or end slur.
559 Syntax: @var{note}@code{(} and @var{note}@code{)}")
561 (types . (general-music post-event span-event event slur-event))
565 . ((description . "Print @q{Solo@tie{}1}.")
566 (part-combine-status . solo1)
567 (types . (general-music event part-combine-event solo-one-event))
571 . ((description . "Print @q{Solo@tie{}2}.")
572 (part-combine-status . solo2)
573 (types . (general-music event part-combine-event solo-two-event))
577 . ((description . "Depress or release sostenuto pedal.")
578 (types . (general-music post-event event pedal-event sostenuto-event))
582 . ((description . "Start a new spacing section.")
583 (types . (general-music event spacing-section-event))))
586 . ((description . "Event for anything that is started at a
587 different time than stopped.")
588 (types . (general-music event))
592 . ((description . "Start or stop a staff symbol.")
593 (types . (general-music event span-event staff-span-event))
597 . ((description . "Specify on which string to play this note.
599 Syntax: @code{\\@var{number}}")
600 (types . (general-music post-event string-number-event event))
604 . ((description . "Specify with which finger to pluck a string.
606 Syntax: @code{\\rightHandFinger @var{text}}")
607 (types . (general-music post-event stroke-finger-event event))
611 . ((description . "Depress or release sustain pedal.")
612 (types . (general-music post-event event pedal-event sustain-event))
616 . ((description . "A metronome mark or tempo indication.")
617 (types . (general-music event tempo-change-event))
621 . ((description . "Print text.")
622 (types . (general-music post-event script-event text-script-event event))
626 . ((description . "Start a text spanner, for example, an
628 (types . (general-music post-event span-event event text-span-event))
632 . ((description . "A tie.
634 Syntax: @w{@var{note}@code{-~}}")
635 (types . (general-music post-event tie-event event))
639 . ((description . "Multiply durations, as in tuplets.
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))
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))
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))
667 . ((description . "Unmeasured tremolo.")
668 (types . (general-music post-event event tremolo-event))
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))
681 . ((description . "Tremolo over two stems.")
682 (types . (general-music event span-event tremolo-span-event))
686 . ((description . "Start a trill spanner.")
687 (types . (general-music post-event span-event event trill-span-event))
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))
697 . ((description . "Depress or release una-corda pedal.")
698 (types . (general-music post-event event pedal-event una-corda-event))
701 (UnfoldedRepeatedMusic
702 . ((description . "Repeated music which is fully written
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)
711 . ((description . "Print @q{a@tie{}2}.")
712 (part-combine-status . unisono)
713 (types . (general-music event part-combine-event unisono-event))))
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))
725 . ((description . "Separate polyphonic voices in simultaneous music.
727 Syntax: @code{\\\\}")
728 (types . (separator general-music))
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))
741 (set! music-descriptions
742 (sort music-descriptions alist<?))
744 (define-public music-name-to-property-table (make-hash-table 59))
747 ;; transport description to an object property.
751 (set-object-property! (car x)
753 (cdr (assq 'description (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)
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
765 (make-music 'OverrideProperty
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))))
779 (set! (ly:music-property m (car mus-props)) (cadr mus-props))
780 (set-props (cddr mus-props)))))
781 (set-props music-properties)
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
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)))