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