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--2006  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? "Offset of resulting grob; only used for balloon texts.")
  20      (Y-offset ,number? "Offset of resulting grob; only used for balloon texts. ")
  21
  22      (alteration ,number? "alteration for figured bass")
  23
  24      (absolute-octave ,integer?
  25                       "The absolute octave for a octave check note.")
  26      (articulations ,ly:music-list?
  27                     "Articulation events specifically for this note.")
  28      (articulation-type ,string? "key for script definitions alist.
  29
  30 TODO: consider making type into symbol ")
  31      (augmented ,boolean? "This figure is for an augmented figured bass (with +) sign.")
  32      (associated-context ,string? "Name of the Voice context associated with this \\newaddlyrics section")
  33      (bass ,boolean? "Set if this note is a bass note in a chord")
  34      (bracket-start ,boolean? "start a bracket
  35 here. TODO: use SpanEvents?")
  36      (bracket-stop ,boolean? "stop a bracket here.")
  37      (break-penalty ,number? "Penalty for line break hint.")
  38      (break-permission ,symbol? "Whether to allow, forbid or force a line break.")
  39      (cautionary ,boolean? "If set, this alteration needs cautionary accidental")
  40      (change-to-id ,string? "name of the context to change to ")
  41      (change-to-type ,symbol? "type of the context to change to.")
  42      (compress-procedure ,procedure? "compress this music expression. Argument 1: the music, arg 2: factor")
  43      (context-id ,string? "name of context")
  44      (context-type ,symbol?  "type of context")
  45      (create-new ,boolean? "Create a fresh context.")
  46      (delta-step ,number? "How much should a fall change pitch?")
  47      (descend-only ,boolean? "If set, this @code{\\context} will only descend in the context tree.")
  48      (denominator ,integer? "denominator in a time signature")
  49      (digit ,integer? "digit for fingering")
  50      (diminished ,boolean? "This bass figure should be slashed.")
  51      (direction ,ly:dir? "Print this up or down?")
  52      (drum-type ,symbol? "Which percussion instrument to play this note on.")
  53      (duration ,ly:duration? "Duration of this note/lyric.")
  54      (error-found ,boolean? "If true, a parsing error was found in this expression")
  55      (element ,ly:music? "The single child of a Music_wrapper music object, or the body of a repeat.")
  56      (elements ,ly:music-list? "A list of elements for sequential of simultaneous music, or the alternatives of repeated music. ")
  57      (elements-callback ,procedure? "Return a list of children, for use by a sequential iterator. Takes a single Music parameter")
  58      (expected-beam-count ,integer? "Expected number of non-tremolo beams in a tremolo repeat")
  59      (figure ,integer? "a bass figure")
  60      (force-accidental ,boolean? "If set, a cautionary accidental should always be printed on this note")
  61      (grob-property ,symbol? "The symbol of the grob property to set. ")
  62      (grob-property-path ,list? "A list of symbols, locating a nested grob property, e.g. (beamed-lengths details). ")
  63      (grob-value ,scheme? "The value of the grob property to set")
  64      (input-tag ,scheme? "Arbitrary marker to relate input and output")
  65      (inversion ,boolean? "If set, this chord note is inverted.")
  66      (iterator-ctor ,procedure? "Function to construct music-event-iterator object for this Music")
  67
  68      (label ,markup? "label of a mark.")
  69      (last-pitch ,ly:pitch? "The last pitch after relativization.")
  70      (length ,ly:moment? "The duration of this music")
  71      (length-callback ,procedure? "How to compute the duration of this music. This property can only be defined as initializer in @file{define-music-types.scm}.")
  72      (metronome-count ,number? "How many beats in a minute?")
  73      (name ,symbol? "Name of this music object")
  74      (no-continuation ,boolean? "If set, disallow continuation lines")
  75      (numerator ,integer? "numerator of a time signature")
  76      (once ,boolean? "Apply this operation only during one time step?")
  77      (octavation ,integer? "This pitch was octavated by how many octaves? For chord inversions, this is negative.")
  78      (origin ,ly:input-location? "where was this piece of music defined?")
  79      (part-combine-status ,symbol?
  80                           "Change to what kind of state? Options are
  81 solo1, solo2 and unisono")
  82      (parenthesize ,boolean? "Enclose resulting objects in parentheses?")
  83      (pitch ,ly:pitch? "the pitch of this note")
  84      (pitch-alist ,list? "list of pitches jointly forming the scale of a key signature")
  85      (pop-first ,boolean? "Do a revert before we try to do a override on some grob property.")
  86      (prob-property ,symbol? "The symbol of the prob property to set. ")
  87      (procedure ,procedure?
  88                 "The function to run with \\applycontext.
  89 It must take a single argument, being the context.")
  90      (property-operations ,list?
  91                           "Do these operations for instantiating the context.")
  92      (quoted-events ,vector? "A vector of with moment/event-list entries.")
  93      (quoted-music-name ,string? "The name of the voice to quote.")
  94      (quoted-voice-direction ,ly:dir? "Should the quoted voice be up-stem or down-stem?")
  95      (quoted-context-type ,symbol? "The name of the context to direct quotes to, eg., @code{Voice}.")
  96      (quoted-context-id ,string? "The id of the context to direct quotes to, eg., @code{cue}.")
  97      (quoted-transposition ,ly:pitch? "The pitch used for the quote, overriding \\transposition")
  98      (to-relative-callback ,procedure? "How to transform a piece of music to relative pitches")
  99      (repeat-count  ,integer? "do a @code{\repeat} how ofen?")
 100      (span-direction ,ly:dir? "Does this start or stop a spanner?")
 101      (span-type ,string? "What kind of spanner should be created?
 102
 103 TODO: consider making type into symbol")
 104      (split-list ,list? "splitting moments for part combiner.")
 105      (start-callback ,procedure? "Function to compute the negative
 106 length of starting grace notes.  This property can only be defined as
 107 initializer in @file{define-music-types.scm}.")
 108      (string-number ,integer? "The number of the string in a StringNumberEvent")
 109      (symbol ,symbol? "Grob name to perform an override/revert on.")
 110      (tags ,list? "List of symbols that for denoting extra details,
 111 e.g. @code{\\tag #'part ...} could tag a piece of music as only being active in a part.")
 112      (text-type ,symbol? "Particular type of text script (e.g. finger, dynamic).")
 113
 114      (text ,markup? "markup expression to be printed")
 115      (tempo-unit ,ly:duration? "The unit for the metronome count.")
 116      (tonic ,ly:pitch? "Base of the scale")
 117      (tremolo-type ,integer? "speed of tremolo, e.g. 16 for c4:16")
 118      (trill-pitch ,ly:pitch? "Pitch of other note of the trill.")
 119      (type ,symbol? "The type of this music object. Determines iteration in some cases.")
 120      (types ,list? "The types of this music object; determines by what
 121 engraver this music expression is processed.")
 122      (tweaks ,list? "An alist of properties to override in the backend
 123 -for the grob made of this event.")
 124      (value ,scheme? "Assignment value for a
 125 translation property")
 126      (void ,boolean? "If this property is #t, then the music expression is to be
 127 discarded by the toplevel music handler.")
 128      (what ,symbol? "What to change for auto-change. FIXME, naming")
 129      (untransposable ,boolean? "If set, this music is not transposed.")
 130      )))