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 . "Internally used to group a set of events.")
204 (iterator-ctor . ,ly:event-chord-iterator::constructor)
205 (length-callback . ,ly:music-sequence::maximum-length-callback)
206 (to-relative-callback .
207 ,ly:music-sequence::event-chord-relative-callback)
208 (types . (general-music event-chord simultaneous-music))
212 . ((description . "Extend lyrics.")
213 (types . (general-music post-event extender-event event))
217 . ((description . "Specify what finger to use for this note.")
218 (types . (general-music post-event fingering-event event))
222 . ((description . "Footnote a grob.")
223 (types . (general-music event footnote-event))
227 . ((description . "Start a glissando on this note.")
228 (types . (general-music post-event glissando-event event))
232 . ((description . "Interpret the argument as grace notes.")
233 (start-callback . ,ly:grace-music::start-callback)
234 (length . ,ZERO-MOMENT)
235 (iterator-ctor . ,ly:grace-iterator::constructor)
236 (types . (grace-music music-wrapper-music general-music))
240 . ((description . "Mark a note as harmonic.")
241 (types . (general-music post-event event harmonic-event))
245 . ((description . "A hyphen between lyric syllables.")
246 (types . (general-music post-event hyphen-event event))
250 . ((description . "Change the key signature.
252 Syntax: @code{\\key} @var{name} @var{scale}")
253 (to-relative-callback . ,(lambda (x p) p))
254 (types . (general-music key-change-event event))
258 . ((description . "Place a bookmarking label.")
259 (types . (general-music label-event event))
263 . ((description . "Don't damp this chord.
265 Syntax: @var{note}@code{\\laissezVibrer}")
266 (types . (general-music post-event event laissez-vibrer-event))
270 . ((description . "Start or end a ligature.")
271 (types . (general-music span-event ligature-event event))
275 . ((description . "Allow, forbid or force a line break.")
276 (types . (general-music line-break-event break-event event))
280 . ((description . "Align lyrics to the start of notes.
282 Syntax: @code{\\lyricsto} @var{voicename} @var{lyrics}")
283 (length . ,ZERO-MOMENT)
284 (types . (general-music lyric-combine-music))
285 (iterator-ctor . ,ly:lyric-combine-music-iterator::constructor)
289 . ((description . "A lyric syllable. Must be entered in lyrics mode,
290 i.e., @code{\\lyrics @{ twinkle4 twinkle4 @} }.")
291 (iterator-ctor . ,ly:rhythmic-music-iterator::constructor)
292 (types . (general-music rhythmic-event lyric-event event))
296 . ((description . "Insert a rehearsal mark.
298 Syntax: @code{\\mark} @var{marker}
300 Example: @code{\\mark \"A\"}")
301 (types . (general-music mark-event event))
304 (MultiMeasureRestEvent
305 . ((description . "Used internally by @code{MultiMeasureRestMusic}
307 (types . (general-music event rhythmic-event
308 multi-measure-rest-event))
311 (MultiMeasureRestMusic
312 . ((description . "Rests that may be compressed into Multi rests.
314 Syntax: @code{R2.*4} for 4 measures in 3/4 time.")
315 (iterator-ctor . ,ly:sequential-iterator::constructor)
316 (elements-callback . ,mm-rest-child-list)
317 (types . (general-music multi-measure-rest))
320 (MultiMeasureTextEvent
321 . ((description . "Texts on multi measure rests.
323 Syntax: @code{R-\\markup @{ \\roman \"bla\" @}}
325 Note the explicit font switch.")
326 (types . (general-music post-event event multi-measure-text-event))
330 . ((description . "Generic type for music expressions.")
331 (types . (general-music))
335 . ((description . "A note.")
336 (iterator-ctor . ,ly:rhythmic-music-iterator::constructor)
337 (types . (general-music event note-event rhythmic-event
342 . ((description . "Start or stop grouping brackets.")
343 (types . (general-music post-event event note-grouping-event))
347 . ((description . "Start or stop an ottava bracket.")
348 (iterator-ctor . ,ly:sequential-iterator::constructor)
349 (elements-callback . ,make-ottava-set)
350 (types . (general-music ottava-music))
354 . ((description . "Extend the definition of a graphical object.
356 Syntax: @code{\\override} [ @var{context} @code{.} ]
357 @var{object} @var{property} @code{=} @var{value}")
358 (types . (general-music layout-instruction-event
359 override-property-event))
360 (iterator-ctor . ,ly:push-property-iterator::constructor)
364 . ((description . "Allow, forbid or force a page break.")
365 (types . (general-music break-event page-break-event event))
369 . ((description . "Allow, forbid or force a page turn.")
370 (types . (general-music break-event page-turn-event event))
373 (PartCombineForceEvent
374 . ((description . "Override the part-combiner's strategy.")
375 (types . (general-music part-combine-force-event event))
379 . ((description . "Create an anacrusis or upbeat (partial measure).")
380 (iterator-ctor . ,ly:partial-iterator::constructor)
381 (types . (general-music partial-set))
385 . ((description . "Combine two parts on a staff, either merged or
386 as separate voices.")
387 (length-callback . ,ly:music-sequence::maximum-length-callback)
388 (start-callback . ,ly:music-sequence::minimum-start-callback)
389 (types . (general-music part-combine-music))
390 (iterator-ctor . ,ly:part-combine-iterator::constructor)
394 . ((description . "Used internally to signal percent repeats.")
395 (types . (general-music event percent-event rhythmic-event))
398 (PercentRepeatedMusic
399 . ((description . "Repeats encoded by percents and slashes.")
400 (iterator-ctor . ,ly:percent-repeat-iterator::constructor)
401 (start-callback . ,ly:repeated-music::first-start)
402 (length-callback . ,ly:repeated-music::unfolded-music-length)
403 (types . (general-music repeated-music percent-repeated-music))
407 . ((description . "Within a ligature, mark the previous and the
408 following note to form a pes (if melody goes up) or a flexa (if melody
410 (types . (general-music pes-or-flexa-event event))
414 . ((description . "Start or end phrasing slur.
416 Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}")
418 (types . (general-music post-event span-event event phrasing-slur-event))
422 . ((description . "Set a context property.
424 Syntax: @code{\\set @var{context}.@var{prop} = @var{scheme-val}}")
425 (types . (layout-instruction-event general-music))
426 (iterator-ctor . ,ly:property-iterator::constructor)
430 . ((description . "Restore the default setting for a context
431 property. See @ref{PropertySet}.
433 Syntax: @code{\\unset @var{context}.@var{prop}}")
434 (types . (layout-instruction-event general-music))
435 (iterator-ctor . ,ly:property-unset-iterator::constructor)
439 . ((description . "Quote preprocessed snippets of music.")
440 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
441 (length-callback . ,ly:music-wrapper::length-callback)
442 (start-callback . ,ly:music-wrapper::start-callback)
443 (types . (general-music music-wrapper-music))
447 . ((description . "Check if a pitch is in the correct octave.")
448 (to-relative-callback . ,ly:relative-octave-check::relative-callback)
449 (types . (general-music relative-octave-check))
453 . ((description . "Music that was entered in relative octave notation.")
454 (to-relative-callback . ,ly:relative-octave-music::relative-callback)
455 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
456 (length-callback . ,ly:music-wrapper::length-callback)
457 (start-callback . ,ly:music-wrapper::start-callback)
458 (types . (music-wrapper-music general-music relative-octave-music))
462 . ((description . "A chord repetition")
463 (to-relative-callback . ,ly:music-sequence::repeated-chord-relative-callback)
464 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
465 (start-callback . ,ly:music-wrapper::start-callback)
466 (length-callback . ,ly:music-wrapper::length-callback)
467 (types . (general-music music-wrapper-music))
471 . ((description . "Repeat music in different ways.")
472 (types . (general-music repeated-music))
476 . ((description . "Used internally to signal beat repeats.")
477 (types . (general-music event repeat-slash-event rhythmic-event))
481 . ((description . "Ties for starting a second volta bracket.")
482 (types . (general-music post-event event repeat-tie-event))
486 . ((description . "A Rest.
488 Syntax: @code{r4} for a quarter rest.")
489 (iterator-ctor . ,ly:rhythmic-music-iterator::constructor)
490 (types . (general-music event rhythmic-event rest-event))
494 . ((description . "The opposite of @ref{OverrideProperty}: remove a
495 previously added property from a graphical object definition.")
496 (types . (general-music layout-instruction-event))
497 (iterator-ctor . ,ly:pop-property-iterator::constructor)
501 . ((description . "Add an articulation mark to a note.")
502 (types . (general-music event))
506 . ((description . "Music expressions concatenated.
508 Syntax: @code{\\sequential @{ @dots{} @}} or simply @code{@{ @dots{} @}}")
509 (length-callback . ,ly:music-sequence::cumulative-length-callback)
510 (start-callback . ,ly:music-sequence::first-start-callback)
511 (elements-callback . ,(lambda (m) (ly:music-property m 'elements)))
512 (iterator-ctor . ,ly:sequential-iterator::constructor)
513 (types . (general-music sequential-music))
517 . ((description . "Music playing together.
519 Syntax: @code{\\simultaneous @{ @dots{} @}} or @code{<< @dots{} >>}")
520 (iterator-ctor . ,ly:simultaneous-music-iterator::constructor)
521 (start-callback . ,ly:music-sequence::minimum-start-callback)
522 (length-callback . ,ly:music-sequence::maximum-length-callback)
523 (to-relative-callback .
524 ,ly:music-sequence::simultaneous-relative-callback)
525 (types . (general-music simultaneous-music))
529 . ((description . "Filler that takes up duration, but does not
532 Syntax: @code{s4} for a skip equivalent to a quarter rest.")
533 (iterator-ctor . ,ly:rhythmic-music-iterator::constructor)
534 (types . (general-music event rhythmic-event skip-event))
538 . ((description . "Filler that takes up duration, does not
539 print anything, and also does not create staves or voices implicitly.
541 Syntax: @code{\\skip} @var{duration}")
542 (length-callback . ,ly:music-duration-length)
543 (iterator-ctor . ,ly:simple-music-iterator::constructor)
544 (types . (general-music event rhythmic-event skip-event))
548 . ((description . "Start or end slur.
550 Syntax: @var{note}@code{(} and @var{note}@code{)}")
552 (types . (general-music post-event span-event event slur-event))
556 . ((description . "Print @q{Solo@tie{}1}.")
557 (part-combine-status . solo1)
558 (types . (general-music event part-combine-event solo-one-event))
562 . ((description . "Print @q{Solo@tie{}2}.")
563 (part-combine-status . solo2)
564 (types . (general-music event part-combine-event solo-two-event))
568 . ((description . "Depress or release sostenuto pedal.")
569 (types . (general-music post-event event pedal-event sostenuto-event))
573 . ((description . "Start a new spacing section.")
574 (types . (general-music event spacing-section-event))))
577 . ((description . "Event for anything that is started at a
578 different time than stopped.")
579 (types . (general-music event))
583 . ((description . "Start or stop a staff symbol.")
584 (types . (general-music event span-event staff-span-event))
588 . ((description . "Specify on which string to play this note.
590 Syntax: @code{\\@var{number}}")
591 (types . (general-music post-event string-number-event event))
595 . ((description . "Specify with which finger to pluck a string.
597 Syntax: @code{\\rightHandFinger @var{text}}")
598 (types . (general-music post-event stroke-finger-event event))
602 . ((description . "Depress or release sustain pedal.")
603 (types . (general-music post-event event pedal-event sustain-event))
607 . ((description . "A metronome mark or tempo indication.")
608 (types . (general-music event tempo-change-event))
612 . ((description . "Print text.")
613 (types . (general-music post-event script-event text-script-event event))
617 . ((description . "Start a text spanner, for example, an
619 (types . (general-music post-event span-event event text-span-event))
623 . ((description . "A tie.
625 Syntax: @w{@var{note}@code{-~}}")
626 (types . (general-music post-event tie-event event))
630 . ((description . "Multiply durations, as in tuplets.
632 Syntax: @code{\\times @var{fraction} @var{music}}, e.g.,
633 @code{\\times 2/3 @{ @dots{} @}} for triplets.")
634 (length-callback . ,ly:music-wrapper::length-callback)
635 (start-callback . ,ly:music-wrapper::start-callback)
636 (iterator-ctor . ,ly:tuplet-iterator::constructor)
637 (types . (time-scaled-music music-wrapper-music general-music))
641 . ((description . "Set a new time signature")
642 (iterator-ctor . ,ly:sequential-iterator::constructor)
643 (elements-callback . ,make-time-signature-set)
644 (types . (general-music time-signature-music))
648 . ((description . "Music that has been transposed.")
649 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
650 (start-callback . ,ly:music-wrapper::start-callback)
651 (length-callback . ,ly:music-wrapper::length-callback)
652 (to-relative-callback .
653 ,ly:relative-octave-music::no-relative-callback)
654 (types . (music-wrapper-music general-music transposed-music))
658 . ((description . "Unmeasured tremolo.")
659 (types . (general-music post-event event tremolo-event))
662 (TremoloRepeatedMusic
663 . ((description . "Repeated notes denoted by tremolo beams.")
664 (iterator-ctor . ,ly:chord-tremolo-iterator::constructor)
665 (start-callback . ,ly:repeated-music::first-start)
666 ;; the length of the repeat is handled by shifting the note logs
667 (length-callback . ,ly:repeated-music::folded-music-length)
668 (types . (general-music repeated-music tremolo-repeated-music))
672 . ((description . "Tremolo over two stems.")
673 (types . (general-music event span-event tremolo-span-event))
677 . ((description . "Start a trill spanner.")
678 (types . (general-music post-event span-event event trill-span-event))
682 . ((description . "Used internally to signal where tuplet
683 brackets start and stop.")
684 (types . (tuplet-span-event span-event event general-music post-event))
688 . ((description . "Depress or release una-corda pedal.")
689 (types . (general-music post-event event pedal-event una-corda-event))
692 (UnfoldedRepeatedMusic
693 . ((description . "Repeated music which is fully written
695 (iterator-ctor . ,ly:unfolded-repeat-iterator::constructor)
696 (start-callback . ,ly:repeated-music::first-start)
697 (types . (general-music repeated-music unfolded-repeated-music))
698 (length-callback . ,ly:repeated-music::unfolded-music-length)
702 . ((description . "Print @q{a@tie{}2}.")
703 (part-combine-status . unisono)
704 (types . (general-music event part-combine-event unisono-event))))
707 . ((description . "Music that cannot be converted from relative
708 to absolute notation. For example, transposed music.")
709 (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
710 (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
711 (length-callback . ,ly:music-wrapper::length-callback)
712 (types . (music-wrapper-music general-music unrelativable-music))
716 . ((description . "Separate polyphonic voices in simultaneous music.
718 Syntax: @code{\\\\}")
719 (types . (separator general-music))
723 . ((description . "Repeats with alternatives placed sequentially.")
724 (iterator-ctor . ,ly:volta-repeat-iterator::constructor)
725 (elements-callback . ,make-volta-set)
726 (start-callback . ,ly:repeated-music::first-start)
727 (length-callback . ,ly:repeated-music::volta-music-length)
728 (types . (general-music repeated-music volta-repeated-music))
732 (set! music-descriptions
733 (sort music-descriptions alist<?))
735 (define-public music-name-to-property-table (make-hash-table 59))
738 ;; transport description to an object property.
742 (set-object-property! (car x)
744 (cdr (assq 'description (cdr x))))
746 (set! lst (assoc-set! lst 'name (car x)))
747 (set! lst (assq-remove! lst 'description))
748 (hashq-set! music-name-to-property-table (car x) lst)
752 (define-safe-public (make-music name . music-properties)
753 "Create a music object of given name, and set its properties
754 according to @code{music-properties}, a list of alternating property symbols
756 (make-music 'OverrideProperty
758 'grob-property 'thickness
759 'grob-value (* 2 1.5))"
760 (if (not (symbol? name))
761 (ly:error (_ "symbol expected: ~S") name))
762 (let ((props (hashq-ref music-name-to-property-table name '())))
763 (if (not (pair? props))
764 (ly:error (_ "cannot find music object: ~S") name))
765 (let ((m (ly:make-music props)))
766 (define (set-props mus-props)
767 (if (and (not (null? mus-props))
768 (not (null? (cdr mus-props))))
770 (set! (ly:music-property m (car mus-props)) (cadr mus-props))
771 (set-props (cddr mus-props)))))
772 (set-props music-properties)
775 (define-public (make-repeated-music name)
776 (let* ((repeated-music (assoc-get name '(("volta" . VoltaRepeatedMusic)
777 ("unfold" . UnfoldedRepeatedMusic)
778 ("percent" . PercentRepeatedMusic)
779 ("tremolo" . TremoloRepeatedMusic))))
780 (repeated-music-name (if repeated-music
783 (ly:warning (_ "unknown repeat type `~S'") name)
784 (ly:warning (_ "See define-music-types.scm for supported repeats"))
785 'VoltaRepeatedMusic))))
786 (make-music repeated-music-name)))