scm/define-music-properties.scm

   1 ;;;; music-property-description.scm -- part of generated backend documentation
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c) 1998--2008  Han-Wen Nienhuys <hanwen@xs4all.nl>
   6 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8 (define (music-property-description symbol type? description)
   9   (if (not (equal? #f (object-property symbol 'music-doc)))
  10       (ly:error (_ "symbol ~S redefined") symbol))
  11   (set-object-property! symbol 'music-type? type?)
  12   (set-object-property! symbol 'music-doc description)
  13   symbol)
  14
  15 (define-public all-music-properties
  16   (map
  17    (lambda (x) (apply music-property-description x))
  18    `(
  19      (X-offset ,number?
  20                "Offset of resulting grob; only used for balloon texts.")
  21      (Y-offset ,number?
  22                "Offset of resulting grob; only used for balloon texts.")
  23
  24      (alteration ,number? "Alteration for figured bass.")
  25      (absolute-octave ,integer?
  26                       "The absolute octave for a octave check note.")
  27      (articulations ,ly:music-list?
  28                     "Articulation events specifically for this note.")
  29      (articulation-type ,string? "Key for script definitions alist.
  30
  31 TODO: Consider making type into symbol.")
  32      (augmented ,boolean? "This figure is for an augmented figured bass
  33 (with @code{+} sign).")
  34      (augmented-slash ,boolean? "This figure is for an augmented figured bass
  35 (back-slashed number).")
  36      (associated-context ,string? "Name of the Voice context associated with
  37 this @code{\\newaddlyrics} section.")
  38
  39      (bass ,boolean? "Set if this note is a bass note in a chord.")
  40      (bracket-start ,boolean? "Start a bracket here.
  41
  42 TODO: Use SpanEvents?")
  43      (bracket-stop ,boolean? "Stop a bracket here.")
  44      (break-penalty ,number? "Penalty for line break hint.")
  45      (break-permission ,symbol?
  46                        "Whether to allow, forbid or force a line break.")
  47
  48      (cautionary ,boolean? "If set, this alteration needs a
  49 cautionary accidental.")
  50      (change-to-id ,string? "Name of the context to change to.")
  51      (change-to-type ,symbol? "Type of the context to change to.")
  52      (compress-procedure ,procedure? "Compress this music expression.
  53 Arg@tie{}1: the music, arg@tie{}2: factor.")
  54      (context-id ,string? "Name of context.")
  55      (context-type ,symbol?  "Type of context.")
  56      (create-new ,boolean? "Create a fresh context.")
  57
  58      (delta-step ,number? "How much should a fall change pitch?")
  59      (descend-only ,boolean? "If set, this @code{\\context} only descends
  60 in the context tree.")
  61      (denominator ,integer? "Denominator in a time signature.")
  62      (digit ,integer? "Digit for fingering.")
  63      (diminished ,boolean? "This bass figure should be slashed.")
  64      (direction ,ly:dir? "Print this up or down?")
  65      (drum-type ,symbol? "Which percussion instrument to play this note on.")
  66      (duration ,ly:duration? "Duration of this note or lyric.")
  67
  68      (error-found ,boolean?
  69                   "If true, a parsing error was found in this expression.")
  70      (element ,ly:music? "The single child of a Music_wrapper music object,
  71 or the body of a repeat.")
  72      (elements ,ly:music-list? "A list of elements for sequential of
  73 simultaneous music, or the alternatives of repeated music.")
  74      (elements-callback ,procedure? "Return a list of children, for use by
  75 a sequential iterator.  Takes a single music parameter.")
  76      (expected-beam-count ,integer? "Expected number of non-tremolo beams
  77 in a tremolo repeat.")
  78
  79      (figure ,integer? "A bass figure.")
  80      (force-accidental ,boolean? "If set, a cautionary accidental should
  81 always be printed on this note.")
  82
  83      (grob-property ,symbol? "The symbol of the grob property to set.")
  84      (grob-property-path ,list? "A list of symbols, locating a nested grob
  85 property, e.g., @code{(beamed-lengths details)}.")
  86      (grob-value ,scheme? "The value of the grob property to set.")
  87
  88      (input-tag ,scheme? "Arbitrary marker to relate input and output.")
  89      (inversion ,boolean? "If set, this chord note is inverted.")
  90      (iterator-ctor ,procedure? "Function to construct a
  91 @code{music-event-iterator} object for this music.")
  92
  93      (label ,markup? "Label of a mark.")
  94      (last-pitch ,ly:pitch? "The last pitch after relativization.")
  95      (length ,ly:moment? "The duration of this music.")
  96      (length-callback ,procedure? "How to compute the duration of this music.
  97 This property can only be defined as initializer in
  98 @file{scm/@/define-music-types.scm}.")
  99      (line-break-permission ,symbol? "When the music is at top-level,
 100 whether to allow, forbid or force a line break.")
 101
 102      (metronome-count ,number? "How many beats in a minute?")
 103
 104      (name ,symbol? "Name of this music object.")
 105      (no-continuation ,boolean? "If set, disallow continuation lines.")
 106      (numerator ,integer? "Numerator of a time signature.")
 107
 108      (once ,boolean? "Apply this operation only during one time step?")
 109      (octavation ,integer? "This pitch was octavated by how many octaves?
 110 For chord inversions, this is negative.")
 111      (origin ,ly:input-location? "Where was this piece of music defined?")
 112
 113      (page-break-permission ,symbol? "When the music is at top-level,
 114 whether to allow, forbid or force a page break.")
 115      (page-label ,symbol? "The label of a page marker.")
 116      (page-marker ,boolean? "If true, and the music expression is found at
 117 top-level, a page marker object is instanciated instead of a score.")
 118      (page-turn-permission ,symbol? "When the music is at top-level,
 119 whether to allow, forbid or force a page turn.")
 120      (part-combine-status ,symbol? "Change to what kind of state?
 121 Options are @code{solo1}, @code{solo2} and @code{unisono}.")
 122      (parenthesize ,boolean? "Enclose resulting objects in parentheses?")
 123      (pitch ,ly:pitch? "The pitch of this note.")
 124      (pitch-alist ,list? "A list of pitches jointly forming the scale
 125 of a key signature.")
 126      (pop-first ,boolean? "Do a revert before we try to do a override
 127 on some grob property.")
 128      (prob-property ,symbol? "The symbol of the prob property to set.")
 129      (procedure ,procedure? "The function to run with @code{\\applycontext}.
 130 It must take a single argument, being the context.")
 131      (property-operations ,list? "Do these operations for instantiating
 132 the context.")
 133
 134      (quoted-events ,vector? "A vector of with @code{moment} and
 135 @code{event-list} entries.")
 136      (quoted-music-name ,string? "The name of the voice to quote.")
 137      (quoted-voice-direction ,ly:dir? "Should the quoted voice be up-stem
 138 or down-stem?")
 139      (quoted-context-type ,symbol? "The name of the context to
 140 direct quotes to, e.g., @code{Voice}.")
 141      (quoted-context-id ,string? "The ID of the context to direct quotes to,
 142 e.g., @code{cue}.")
 143      (quoted-transposition ,ly:pitch? "The pitch used for the quote,
 144 overriding @code{\\transposition}.")
 145
 146      (repeat-count ,integer? "Do a @code{\\repeat} how often?")
 147
 148      (span-direction ,ly:dir? "Does this start or stop a spanner?")
 149      (span-type ,string? "What kind of spanner should be created?
 150
 151 TODO: Consider making type into symbol.")
 152      (split-list ,list? "Splitting moments for part combiner.")
 153      (start-callback ,procedure? "Function to compute the negative length
 154 of starting grace notes.  This property can only be defined as initializer
 155 in @file{scm/@/define-music-types.scm}.")
 156      (string-number ,integer? "The number of the string in
 157 a @code{StringNumberEvent.}")
 158      (symbol ,symbol? "Grob name to perform an override or revert on.")
 159
 160      (tags ,list? "List of symbols that for denoting extra details, e.g.,
 161 @code{\\tag #'part @dots{}} could tag a piece of music as only being active
 162 in a part.")
 163      (text-type ,symbol?
 164                 "Particular type of text script (e.g., finger, dynamic).")
 165      (text ,markup? "Markup expression to be printed.")
 166      (tempo-unit ,ly:duration? "The unit for the metronome count.")
 167      (to-relative-callback ,procedure? "How to transform a piece of music
 168 to relative pitches.")
 169      (tonic ,ly:pitch? "Base of the scale.")
 170      (tremolo-type ,integer? "Speed of tremolo, e.g., 16 for @code{c4:16}.")
 171      (trill-pitch ,ly:pitch? "Pitch of other note of the trill.")
 172      (type ,symbol? "The type of this music object.
 173 Determines iteration in some cases.")
 174      (types ,list? "The types of this music object; determines by what
 175 engraver this music expression is processed.")
 176      (tweaks ,list? "An alist of properties to override in the backend
 177 for the grob made of this event.")
 178
 179      (untransposable ,boolean? "If set, this music is not transposed.")
 180
 181      (value ,scheme? "Assignment value for a translation property.")
 182      (void ,boolean? "If this property is @code{#t}, then the
 183 music expression is to be discarded by the toplevel music handler.")
 184
 185      (what ,symbol? "What to change for auto-change.
 186
 187 FIXME: Naming.")
 188     )))