scm/define-music-properties.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 1998--2014  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 (define (music-property-description symbol type? description)
  20   (if (not (equal? #f (object-property symbol 'music-doc)))
  21       (ly:error (_ "symbol ~S redefined") symbol))
  22   (set-object-property! symbol 'music-type? type?)
  23   (set-object-property! symbol 'music-doc description)
  24   symbol)
  25
  26 (define-public all-music-properties
  27   (map
  28    (lambda (x) (apply music-property-description x))
  29    `(
  30      (absolute-octave ,integer?
  31                       "The absolute octave for an octave check note.")
  32      (alteration ,number? "Alteration for figured bass.")
  33      (alternative-dir ,ly:dir? "Indicates if an AlternativeMusic is the
  34 First (-1), Middle (0), or Last (1) of group of alternate endings.")
  35      (alternative-increment ,integer? "The number of times an alternative's
  36 lettering should be incremented.")
  37      (articulation-type ,string? "Key for script definitions alist.
  38
  39 TODO: Consider making type into symbol.")
  40      (articulations ,ly:music-list?
  41                     "Articulation events specifically for this note.")
  42      (associated-context ,string? "Name of the context associated with
  43 this @code{\\lyricsto} section.")
  44      (associated-context-type ,symbol? "Type of the context associated with
  45 this @code{\\lyricsto} section.")
  46      (augmented ,boolean? "This figure is for an augmented figured
  47 bass (with @code{+} sign).")
  48      (augmented-slash ,boolean? "This figure is for an augmented
  49 figured bass (back-slashed number).")
  50      (automatically-numbered ,boolean? "Should a footnote be automatically
  51 numbered?")
  52      (autosplit-end ,boolean? "Duration of event was truncated by automatic
  53 splitting in @code{Completion_heads_engraver}.")
  54
  55      (bass ,boolean? "Set if this note is a bass note in a chord.")
  56      (beat-structure ,list? "A beatStructure to be used in autobeaming.")
  57      (bracket-start ,boolean? "Start a bracket here.
  58
  59 TODO: Use SpanEvents?")
  60      (bracket-stop ,boolean? "Stop a bracket here.")
  61      (break-penalty ,number? "Penalty for line break hint.")
  62      (break-permission ,symbol?
  63                        "Whether to allow, forbid or force a line break.")
  64
  65      (cautionary ,boolean? "If set, this alteration needs a
  66 cautionary accidental.")
  67      (change-to-id ,string? "Name of the context to change to.")
  68      (change-to-type ,symbol? "Type of the context to change to.")
  69      (class ,symbol? "The class name of an event class.")
  70      (compress-procedure ,procedure? "Compress this music expression.
  71 Arg@tie{}1: the music, arg@tie{}2: factor.")
  72      (context ,ly:context? "The context to which an event is sent.")
  73      (context-id ,string? "Name of context.")
  74      (context-type ,symbol?  "Type of context.")
  75      (create-new ,boolean? "Create a fresh context.")
  76
  77      (delta-step ,number? "How much should a fall change pitch?")
  78      (denominator ,integer? "Denominator in a time signature.")
  79      (descend-only ,boolean? "If set, this @code{\\context} only descends
  80 in the context tree.")
  81      (digit ,integer? "Digit for fingering.")
  82      (diminished ,boolean? "This bass figure should be slashed.")
  83      (direction ,ly:dir? "Print this up or down?")
  84      (drum-type ,symbol? "Which percussion instrument to play this note on.")
  85      (duration ,ly:duration? "Duration of this note or lyric.")
  86
  87      (element ,ly:music? "The single child of a Music_wrapper music object,
  88 or the body of a repeat.")
  89      (elements ,ly:music-list? "A list of elements for sequential of
  90 simultaneous music, or the alternatives of repeated music.")
  91      (elements-callback ,procedure? "Return a list of children, for use by
  92 a sequential iterator.  Takes a single music parameter.")
  93      (error-found ,boolean?
  94                   "If true, a parsing error was found in this expression.")
  95      (events ,list? "A list of events contained in this event.")
  96
  97      (figure ,integer? "A bass figure.")
  98      (footnote-text ,markup? "Text to appear in a footnote.")
  99      (force-accidental ,boolean? "If set, a cautionary accidental should
 100 always be printed on this note.")
 101      (forced-type ,symbol? "Override for the part-combiner.")
 102
 103      (grob-property ,symbol? "The symbol of the grob property to set.")
 104      (grob-property-path ,list? "A list of symbols, locating a nested grob
 105 property, e.g., @code{(beamed-lengths details)}.")
 106      (grob-value ,scheme? "The value of the grob property to set.")
 107
 108      (id ,symbol? "The ID of an event.")
 109      (input-tag ,scheme? "Arbitrary marker to relate input and output.")
 110      (inversion ,boolean? "If set, this chord note is inverted.")
 111      (iterator-ctor ,procedure? "Function to construct a
 112 @code{music-event-iterator} object for this music.")
 113
 114      (label ,markup? "Label of a mark.")
 115      (last-pitch ,ly:pitch? "The last pitch after relativization.")
 116      (length ,ly:moment? "The duration of this music.")
 117      (length-callback ,procedure? "How to compute the duration of this music.
 118 This property can only be defined as initializer in
 119 @file{scm/@/define-music-types.scm}.")
 120      (line-break-permission ,symbol? "When the music is at top-level,
 121 whether to allow, forbid or force a line break.")
 122
 123      (metronome-count ,number-or-pair? "How many beats in a minute?")
 124      (midi-extra-velocity ,integer? "How much louder or softer should
 125 this note be in MIDI output? The default is 0.")
 126      (midi-length ,procedure? "Function to determine how long to play
 127 a note in MIDI. It should take a moment (the written length of the
 128 note) and a context, and return a moment (the length to play the
 129 note).")
 130      (moment ,ly:moment? "The moment at which an event happens.")
 131      (music-cause ,ly:music? "The music object that is the cause of
 132 an event.")
 133
 134      (name ,symbol? "Name of this music object.")
 135      (no-continuation ,boolean? "If set, disallow continuation lines.")
 136      (numerator ,integer? "Numerator of a time signature.")
 137
 138      (octavation ,integer? "This pitch was octavated by how many octaves?
 139 For chord inversions, this is negative.")
 140      (once ,boolean? "Apply this operation only during one time step?")
 141      (ops ,scheme? "The operations to apply during the creation of a
 142 context.")
 143      (origin ,ly:input-location? "Where was this piece of music defined?")
 144      (ottava-number ,integer? "The octavation for @code{\\ottava}.")
 145
 146      (page-break-permission ,symbol? "When the music is at top-level,
 147 whether to allow, forbid or force a page break.")
 148      (page-label ,symbol? "The label of a page marker.")
 149      (page-marker ,boolean? "If true, and the music expression is found at
 150 top-level, a page marker object is instanciated instead of a score.")
 151      (page-turn-permission ,symbol? "When the music is at top-level,
 152 whether to allow, forbid or force a page turn.")
 153      (parenthesize ,boolean? "Enclose resulting objects in parentheses?")
 154      (part-combine-status ,symbol? "Change to what kind of state?
 155 Options are @code{solo1}, @code{solo2} and @code{unisono}.")
 156      (pitch ,ly:pitch? "The pitch of this note.")
 157      (pitch-alist ,list? "A list of pitches jointly forming the scale
 158 of a key signature.")
 159      (pop-first ,boolean? "Do a revert before we try to do an override
 160 on some grob property.")
 161      (prob-property ,symbol? "The symbol of the prob property to set.")
 162      (procedure ,procedure? "The function to run with @code{\\applycontext}.
 163 It must take a single argument, being the context.")
 164      (property-operations ,list? "Do these operations for instantiating
 165 the context.")
 166      (property-path ,symbol? "The path of a property.")
 167
 168      (quoted-context-id ,string? "The ID of the context to direct quotes to,
 169 e.g., @code{cue}.")
 170      (quoted-context-type ,symbol? "The name of the context to
 171 direct quotes to, e.g., @code{Voice}.")
 172      (quoted-events ,vector? "A vector of with @code{moment} and
 173 @code{event-list} entries.")
 174      (quoted-music-clef ,string? "The clef of the voice to quote.")
 175      (quoted-music-name ,string? "The name of the voice to quote.")
 176      (quoted-transposition ,ly:pitch? "The pitch used for the quote,
 177 overriding @code{\\transposition}.")
 178      (quoted-voice-direction ,ly:dir? "Should the quoted voice be up-stem
 179 or down-stem?")
 180
 181      (repeat-count ,integer? "Do a @code{\\repeat} how often?")
 182
 183      (slash-count ,integer? "The number of slashes in a single-beat repeat.
 184 If zero, signals a beat containing varying durations.")
 185      (span-direction ,ly:dir? "Does this start or stop a spanner?")
 186      (span-type ,symbol? "What kind of dynamic spanner should be created?
 187 Options are @code{'text} and @code{'hairpin}.")
 188      (span-text ,markup? "The displayed text for dynamic text
 189 spanners (e.g., cresc.)")
 190      (spanner-id ,string? "Identifier to distinguish concurrent spanners.")
 191      (split-list ,list? "Splitting moments for part combiner.")
 192      (start-callback ,procedure? "Function to compute the negative length
 193 of starting grace notes.  This property can only be defined as initializer
 194 in @file{scm/@/define-music-types.scm}.")
 195      (string-number ,integer? "The number of the string in
 196 a @code{StringNumberEvent}.")
 197      (symbol ,symbol? "Grob name to perform an override or revert on.")
 198
 199      (tags ,list? "List of symbols that for denoting extra details, e.g.,
 200 @code{\\tag #'part @dots{}} could tag a piece of music as only being active
 201 in a part.")
 202      (tempo-unit ,ly:duration? "The unit for the metronome count.")
 203      (text ,markup? "Markup expression to be printed.")
 204      (to-relative-callback ,procedure? "How to transform a piece of music
 205 to relative pitches.")
 206      (tonic ,ly:pitch? "Base of the scale.")
 207      (tremolo-type ,integer? "Speed of tremolo, e.g., 16 for @code{c4:16}.")
 208      (trill-pitch ,ly:pitch? "Pitch of other note of the trill.")
 209      (tweaks ,list? "An alist of properties to override in the backend
 210 for the grob made of this event.")
 211      (type ,symbol? "The type of this music object.
 212 Determines iteration in some cases.")
 213      (types ,list? "The types of this music object; determines by what
 214 engraver this music expression is processed.")
 215
 216      (untransposable ,boolean? "If set, this music is not transposed.")
 217
 218      (value ,scheme? "Assignment value for a translation property.")
 219      (void ,boolean? "If this property is @code{#t}, then the
 220 music expression is to be discarded by the toplevel music handler.")
 221      (volta-repeats ,list? "A list that is transformed into a volta
 222 repeat element list.")
 223
 224      (what ,symbol? "What to change for auto-change.
 225
 226 FIXME: Naming.")
 227
 228      (X-offset ,number?
 229                "Offset of resulting grob; only used for balloon texts.")
 230
 231      (Y-offset ,number?
 232                "Offset of resulting grob; only used for balloon texts.")
 233      )))