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--2003  Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8
   9 (define-public all-music-properties '())
  10
  11 (define (music-property-description symbol type? description)
  12  (if (not (equal? #f (object-property symbol 'music-doc)))
  13       (begin
  14         (ly:warn (string-append "Redefining " (symbol->string symbol) "\n"))
  15         (exit 2)
  16       ))
  17  (set-object-property! symbol 'music-type? type?)
  18  (set-object-property! symbol 'music-doc description)
  19  (set! all-music-properties (cons symbol all-music-properties))
  20  )
  21
  22
  23
  24 (music-property-description 'iterator-ctor procedure? "Function to construct music-event-iterator object for this Music")
  25 (music-property-description 'duration ly:duration? "Duration of this note/lyric.")
  26 (music-property-description 'metronome-count number? "How many beats in a minute?")
  27 (music-property-description 'span-type string? "What kind of spanner should be created?
  28
  29 TODO: consider making type into symbol")
  30 (music-property-description 'absolute-octave integer?
  31                             "The absolute octave for a octave check note.")
  32 (music-property-description 'articulations music-list?
  33                             "Articulation events specifically for this note.")
  34 (music-property-description 'articulation-type string? "key for script definitions alist.
  35
  36 TODO: consider making type into symbol ")
  37 (music-property-description 'associated-context string? "Name of the Voice context associated with this \\newaddlyrics section")
  38 (music-property-description 'bass boolean? "Set if this note is a bass note in a chord")
  39 (music-property-description 'cautionary boolean? "If set, this alteration needs cautionary accidental")
  40 (music-property-description 'change-to-id string? "name of the context to change to ")
  41 (music-property-description 'change-to-type symbol? "type of the context to change to.")
  42 (music-property-description 'compress-procedure procedure? "compress this music expression. Argument 1: the music, arg 2: factor")
  43 (music-property-description 'context-id string? "name of context")
  44 (music-property-description 'context-type symbol?  "type of context")
  45 (music-property-description 'denominator integer? "denominator in a time signature")
  46 (music-property-description 'digit integer? "digit for fingering")
  47 (music-property-description 'direction ly:dir? "Print this up or down?")
  48 (music-property-description 'tags list? "List of symbols that for denoting extra details,
  49 eg. @code{\\tag #'part ...} could tag a piece of music as only being active in a part.")
  50
  51
  52 (music-property-description 'text-type symbol? "Particular type of text script (eg. finger, dynamic).")
  53 (music-property-description 'tempo-unit ly:duration? "The unit for the metronome count.")
  54 (music-property-description 'tonic ly:pitch? "Base of the scale")
  55 (music-property-description 'element ly:music? "The single child of a Music_wrapper music object, or the body of a repeat.")
  56 (music-property-description 'elements music-list? "A list of elements for sequential of simultaneous music, or the alternatives of repeated music. ")
  57 (music-property-description 'force-accidental boolean? "If set, a cautionary accidental should always be printed on this note")
  58 (music-property-description 'grob-property symbol? "The symbol of the grob property to set. ")
  59 (music-property-description 'grob-value scheme? "The value of the grob property to set")
  60 (music-property-description 'inversion boolean? "If set, this chord note is inverted.")
  61 (music-property-description 'label markup? "label of a mark.")
  62 (music-property-description 'last-pitch ly:pitch? "The last pitch after relativization.")
  63 (music-property-description 'length procedure? "How to compute the duration of this music")
  64 (music-property-description 'internal-class-name string? "C++ class to use for this Music object")
  65 (music-property-description 'name symbol? "Name of this music object")
  66 (music-property-description 'numerator integer? "numerator of a time signature")
  67 (music-property-description 'once boolean? "Apply this operation only during one time step?")
  68 (music-property-description 'octavation  integer?
  69                             "This pitch was octavated by how many octaves?
  70 For chord inversions, this is negative.")
  71 (music-property-description 'origin ly:input-location? "where was this piece of music defined?")
  72 (music-property-description 'penalty number? "Penalty for break hint.")
  73 (music-property-description 'pitch ly:pitch? "the pitch of this note")
  74 (music-property-description 'pitch-alist list? "list of pitches jointly forming the scale of a key signature")
  75 (music-property-description 'pop-first boolean? "Do a revert before we try to do a override on some grob property.")
  76 (music-property-description 'procedure procedure?
  77                             "The function to run with \\applycontext. It must take a single argument, being the context.")
  78 (music-property-description 'property-operations list?
  79                             "Do these operations for instantiating the context.")
  80 (music-property-description 'predicate procedure? "the predicate of a \\outputproperty")
  81 (music-property-description 'type symbol? "The type of this music object. Determines iteration in some cases.")
  82 (music-property-description 'types list? "The types of this music object. Determines iteration in some cases.")
  83 (music-property-description 'repeat-count  integer? "do a @code{\repeat} how ofen?")
  84 (music-property-description 'span-direction ly:dir? "Does this start or stop a spanner?")
  85
  86 (music-property-description 'start-moment-function procedure? "Function to compute the negative length of
  87 starting grace notes.")
  88 (music-property-description 'string-number integer? "The number of the string in a String_number_req")
  89 (music-property-description 'symbol symbol? "Grob name to perform an override/revert on.")
  90 (music-property-description 'text markup? "markup expression to be printed")
  91 ;; markup?
  92 (music-property-description 'tremolo-type integer? "")
  93 (music-property-description 'value scheme? "Assignment value for a
  94 translation property")
  95 (music-property-description 'what symbol? "What to change for auto-change. FIXME, naming")
  96
  97 (music-property-description 'figure string? "a `figure' (which may be
  98 a string) for figured bass")
  99 (music-property-description 'alteration number? "alteration for figured bass")
 100 (music-property-description 'bracket-start boolean? "start a bracket
 101 here. TODO: use span requests?")
 102 (music-property-description 'bracket-stop boolean? "stop a bracket here.")
 103