scm/define-music-properties.scm

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