scm/define-context-properties.scm

   1 ;;;; translator-property-description.scm -- part of backend documentation
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  1998--2004  Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8
   9 (define-public all-translation-properties '())
  10
  11 (define (translator-property-description symbol type? description)
  12  (if (not (equal? #f (object-property symbol 'translation-doc)))
  13       (begin
  14         (ly:warn  "Redefining ~S " symbol)
  15         (exit 2)
  16       ))
  17
  18   (set-object-property! symbol 'translation-type? type?)
  19   (set-object-property! symbol 'translation-doc description)
  20   (set! all-translation-properties (cons symbol all-translation-properties))
  21   symbol
  22   )
  23
  24 (define-public all-user-translation-properties
  25   (map
  26    (lambda (x)
  27      (apply translator-property-description x))
  28    `(
  29      (aDueText ,string? "Text to print at a unisono passage.")
  30      (alignBassFigureAccidentals ,boolean?
  31                                  "If true, then the accidentals are aligned in bass figure context.")
  32
  33      (allowBeamBreak ,boolean? "If true allow line breaks for  beams over bar lines.")
  34      (associatedVoice ,string? "Name of the
  35 @code{Voice} that has the melody for this @code{Lyrics} line.")
  36      (autoBeamSettings ,list? "Specifies
  37 when automatically generated beams should begin and end.
  38 See @usermanref{Setting automatic beam behavior} for more information.
  39 ")
  40      (autoAccidentals ,list? "List of
  41 different ways to typeset an accidental.
  42
  43 For determining when to print an accidental, several different rules
  44 are tried.  The rule that gives the highest number of accidentals is
  45 used.  Each rule consists of
  46
  47 @table @var
  48
  49 @item context:
  50       In which context is the rule applied. For example, if
  51 @var{context} is @internalsref{Score} then all staves share
  52 accidentals, and if @var{context} is @internalsref{Staff} then all
  53 voices in the same staff share accidentals, but staves do not.
  54
  55 @item octavation:
  56       Whether the accidental changes all octaves or only the current
  57       octave. Valid choices are
  58
  59      @table @samp
  60       @item same-octave:
  61       This is the default algorithm. Accidentals are typeset if the note changes
  62       the accidental of that note in that octave. Accidentals lasts to the end of the measure
  63       and then as many measures as specified in the value. I.e. 1 means to the end
  64       of next measure, -1 means to the end of previous measure (that is: no duration at all), etc. #t means forever.
  65       @item any-octave:
  66       Accidentals are typeset if the note is different from
  67       the previous note on the same pitch in any octave. The value has same meaning as in
  68       same-octave.
  69       @end table
  70
  71 @item laziness
  72
  73 Over how many bar lines the accidental lasts.
  74 If @var{laziness} is @code{-1} then the accidental is forget
  75 immediately, and if @var{laziness} is @code{#t} then the accidental
  76 lasts forever.
  77 @end table
  78 ")
  79      (autoBeaming ,boolean? "If set to true then beams are generated
  80 automatically.")
  81
  82      (autoCautionaries ,list? "List similar to
  83 @code{autoAccidentals}, but it controls cautionary accidentals rather than
  84 normal ones. Both lists are tried, and the one giving the most accidentals
  85 wins. In case of draw, a normal accidental is typeset.
  86 ")
  87      (automaticBars ,boolean? " If set to true then bar lines will not be
  88 printed automatically; they must be explicitly created with
  89 @code{\\bar} command.  Unlike the @code{\\cadenza} keyword, measures
  90 are still counted.  Bar generation will resume according to that count
  91 if this property is unset.
  92 ")
  93
  94      (barAlways ,boolean? "If set to true a bar line is drawn after each
  95 note.")
  96
  97      (barCheckSynchronize ,boolean? "If true then reset @code{measurePosition}
  98 when finding a barcheck.")
  99
 100      (barNumberVisibility ,procedure? "Procedure that takes an int and
 101 returns whether the corresponding bar number should be printed")
 102      (bassFigureFormatFunction ,procedure? "Procedure that is called
 103 to produce the formatting for a @code{BassFigure} grob. It takes a
 104 list of @code{BassFigureEvent}s, a context, and the grob to format.")
 105      (beatLength ,ly:moment? "The length of one beat in this time signature.")
 106      (beatGrouping ,list?
 107                    "List of beatgroups, e.g., in 5/8 time @code{'(2
 108 3)}.")
 109
 110
 111
 112      (middleCPosition ,number? "Place of the middle C, measured in half
 113 staffspaces.  Usually determined by looking at @code{clefPosition} and
 114 @code{clefGlyph}.")
 115
 116      (chordNameFunction ,procedure?
 117                         "The function that converts lists of pitches to chord names.")
 118      (chordNoteNamer ,procedure?
 119                      "Function that converts from a pitch object to a text markup. Used for single pitches.")
 120      (chordRootNamer ,procedure?
 121                      "Function that converts from a pitch object to a text markup. Used for chords.")
 122      (chordNameExceptions ,list?
 123                           "Alist of chord exceptions.
 124 Contains (@var{chord} . @var{markup}) entries.")
 125      (chordNameExceptionsFull ,list?
 126                               "Alist of chord exceptions.
 127 Contains (@var{chord} . @var{markup}) entries.")
 128      (chordNameExceptionsPartial
 129       ,list?
 130       "Alist of partial chord exceptions. Contains (@var{chord} . (@var{prefix-markup} @var{suffix-markup})) entries.")
 131
 132      (chordNameSeparator ,markup?
 133                          "The markup object used to separate
 134  parts of a chord name.")
 135      (chordChanges ,boolean? "Only show changes in chords scheme?")
 136      (clefGlyph ,string? "Name of the symbol within the music font.")
 137      (clefOctavation ,integer? "Add
 138 this much extra octavation. Values of 7 and -7 are common.")
 139
 140      (clefPosition ,number? "Where should the center of the clef
 141 symbol go, measured in half staff spaces from the center of the staff.")
 142
 143      (connectArpeggios ,boolean? " If set, connect arpeggios across
 144 piano staff.")
 145      (createKeyOnClefChange ,boolean? "Print a key signature whenever the clef is changed.")
 146      (createSpacing ,boolean? "Create StaffSpacing objects? Should be set for staves.")
 147      (crescendoText ,markup? "Text to print at start of non-hairpin crescendo, i.e.: @samp{cresc.}")
 148      (crescendoSpanner ,symbol? "Type of spanner to be used for crescendi.
 149 One of: @samp{hairpin}, @samp{line}, @samp{dashed-line},
 150 @samp{dotted-line}.  If unset, hairpin type is used.")
 151      (decrescendoText ,markup? "Text to print at start of non-hairpin decrescendo, i.e.: @samp{dim.}")
 152
 153      (drumPitchTable ,hash-table? "A table mapping percussion
 154 instruments (symbols) to pitches.")
 155
 156      (drumStyleTable ,hash-table? "A hash table containing mapping
 157 drums to layout settings.  Predefined values: @samp{drums-style},
 158 @samp{timbales-style}, @samp{congas-style}, @samp{bongos-style} and
 159 @samp{percussion-style}.
 160
 161 The layout style is a hash table, containing the drum-pitches (e.g. the
 162 symbol @samp{hihat}) as key, and a list (@var{notehead-style}
 163 @var{script} @var{vertical-position}) as values.
 164  ")
 165      (currentBarNumber ,integer? "Contains the current barnumber. This property is incremented at
 166 every bar line.
 167 ")
 168      (defaultBarType ,string? "Sets the default type of bar line.
 169 See @code{whichBar} for information on available bar types.
 170
 171 This variable is  read by @internalsref{Timing_engraver} at
 172 @internalsref{Score} level.
 173 ")
 174
 175      (decrescendoSpanner ,symbol? "See @code{crescendoSpanner}.")
 176      (doubleSlurs ,boolean?
 177                   "When set, two slurs are created for every slurred
 178 note, one above and one below the chord.")
 179      (explicitClefVisibility ,procedure? "@samp{break-visibility} function for clef changes.")
 180
 181      (explicitKeySignatureVisibility ,procedure?
 182 "@samp{break-visibility} function for explicit key
 183 changes. @samp{\\override} of @samp{#'break-visibility} will set the
 184 visibility for normal (i.e. at the start of the line) key signatures.")
 185
 186      (extraNatural ,boolean? "Whether to typeset an
 187 extra natural sign before accidentals changing from a non-natural to
 188 another non-natural.")
 189
 190      (extraVerticalExtent ,number-pair?
 191                           "extra vertical extent, same format as @var{minimumVerticalExtent}")
 192
 193
 194      (followVoice ,boolean? "if set, note heads are tracked across staff
 195 switches by a thin line")
 196
 197      (fontSize ,number?
 198                "The relative size of all grobs in a context. ")
 199
 200      (fingeringOrientations ,list?
 201                             "List of symbols, containing
 202 @samp{left}, @samp{right}, @samp{up} and/or @samp{down}. This list
 203 determines where fingerings are put relative to the chord being
 204 fingered.")
 205
 206      (forceClef ,boolean? "Show clef symbol, even if it has not
 207 changed. Only active for the first clef after the property is set, not
 208 for the full staff.")
 209
 210      (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
 211 get accidentals.")
 212      (highStringOne ,boolean? "Whether the 1st string is the string with
 213 highest pitch on the instrument. This used by the automatic string
 214 selector for tab notation.")
 215
 216      (ignoreMelismata ,boolean? "Ignore melismata for this @internalsref{Lyrics} line.")
 217      (instr ,markup? "See @code{instrument}")
 218
 219      (instrument ,markup? "The name to print left of a staff.  The
 220 @code{instrument} property labels the staff in the first system, and
 221 the @code{instr} property labels following lines.")
 222      (instrumentEqualizer ,procedure? "
 223 Function taking a string (instrument name), and returning a (@var{min} . @var{max}) pair of numbers for the loudness range of the instrument.
 224 ")
 225      (instrumentTransposition ,ly:pitch? "Define the transposition of the instrument. This is used to transpose the MIDI output, and @code{\\quote}s.")
 226
 227      (keyAccidentalOrder ,list? " Alist that defines in what order
 228 alterations should be printed.  The format is (@var{name}
 229 . @var{alter}), where @var{name} is from 0 .. 6 and @var{alter} from -1, 1.
 230 ")
 231
 232      (keySignature ,list? "The current key signature. This is an alist
 233 containing (@var{name} . @var{alter}) or ((@var{octave} . @var{name}) . @var{alter}).
 234  where @var{name} is from 0.. 6 and
 235 @var{alter} from -4 (double flat) to 4 (double sharp).
 236 ")
 237
 238      (majorSevenSymbol ,markup? "How should
 239 the major 7th be formatted in a chord name?")
 240      (markFormatter ,procedure? "Procedure
 241 taking as arguments context and rehearsal mark. It should return the
 242 formatted mark as a markup object.")
 243
 244      (measureLength ,ly:moment? "Length of one
 245 measure in the current time signature.")
 246
 247      (measurePosition ,ly:moment? "How much of the current measure
 248 have we had.  This can be set manually to create incomplete
 249 measures.")
 250
 251      (melismaBusyProperties ,list? "List of properties (symbols) to
 252 determine whether a melisma is playing.  Setting this property will
 253 influence how lyrics are aligned to notes.  For example, if set to
 254 @code{#'(melismaBusy beamMelismaBusy)}, only manual melismata and
 255 manual beams are considered. Possible values include
 256 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
 257 @code{beamMelismaBusy}")
 258
 259
 260      (metronomeMarkFormatter ,procedure? "How to produce a metronome
 261 markup.  Called with 2 arguments, event and context.")
 262      (midiInstrument ,string? "Name of the MIDI instrument to use ")
 263      (midiMinimumVolume ,number? "Sets the minimum loudness for MIDI. Ranges from 0 to 1.")
 264      (midiMaximumVolume ,number? "Analogous to @code{midiMinimumVolume}.")
 265      (minimumFret ,number? "The tablature auto string-selecting mechanism
 266 selects the highest string with a fret at least @var{minimumFret}")
 267      (minimumVerticalExtent ,number-pair? "minimum vertical extent, same
 268 format as @var{verticalExtent}")
 269      (ottavation ,string? "If set, the text for an ottava spanner. Changing
 270 this creates a new text spanner. ")
 271      (pedalSustainStrings ,list? "List of string to print for
 272 sustain-pedal. Format is (@var{up} @var{updown} @var{down}), where
 273 each of the three is the string to print when this is done with the
 274 pedal.")
 275      (pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
 276      (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
 277      (pedalSustainStyle ,symbol? "A symbol that indicates how to print
 278 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
 279      (pedalUnaCordaStyle ,symbol? "see @code{pedalSustainStyle}.")
 280      (pedalSostenutoStyle ,symbol? "see @code{pedalSustainStyle}.")
 281      (printKeyCancellation ,boolean? "Print restoration alterations before a key signature change. ")
 282      (printPartCombineTexts ,boolean? "set Solo/A due texts in the part combiner?")
 283      (printOctaveNames ,boolean? "Print octave marks for the NoteNames context.")
 284      (recordEventSequence ,procedure? "When
 285 @internalsref{Recording_group_engraver} is in this context, then upon
 286 termination of the context, this function is called with current
 287 context and a list of music objects.  The list of contains entries
 288 with start times, music objects and whether they are processed in this
 289 context.")
 290
 291
 292      (rehearsalMark ,integer? "The last rehearsal mark printed.")
 293      (repeatCommands ,list? "This property is read to find any command of the form @code{(volta . @var{x})}, where @var{x} is a string or @code{#f}")
 294      (restNumberThreshold ,number?
 295                           "If a multimeasure rest takes less
 296 than this number of measures, no number is printed. ")
 297
 298      (skipBars ,boolean? "If set to true, then
 299 skip the empty bars that are produced by multimeasure notes and rests.
 300 These bars will not appear on the printed output.  If not set (the
 301 default) multimeasure notes and rests expand into their full length,
 302 printing the appropriate number of empty bars so that synchronization
 303 with other voices is preserved.
 304
 305
 306 @example
 307 @@lilypond[fragment,verbatim,center]
 308 r1 r1*3 R1*3  \\\\property Score.skipBars= ##t r1*3 R1*3
 309 @@end lilypond
 310 @end example
 311 ")
 312      (skipTypesetting ,boolean?
 313                       "When true, all no typesetting is done, speeding
 314 up  the interpretation phase. This speeds up debugging large scores.")
 315      (soloIIText ,string? "text for begin of solo for voice ``two'' when part-combining.")
 316      (soloText ,string? "text for begin of solo when part-combining.")
 317      (squashedPosition ,integer? " Vertical position of
 318 squashing for @internalsref{Pitch_squash_engraver}.")
 319
 320      (stringOneTopmost ,boolean? "Whether the 1st string is printed on the
 321 top line of the tablature.")
 322
 323      (stanza ,markup? "Stanza `number' to print before the start of a
 324 verse. Use in Lyrics context.")
 325
 326      (stemLeftBeamCount ,integer? " Specify the number of beams to draw on
 327 the left side of the next note.  Overrides automatic beaming.  The
 328 value is only used once, and then it is erased.")
 329
 330      (stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
 331
 332      (stringTunings ,list? "The tablature strings tuning. It is a list
 333 of the pitch (in semitones) of each string (starting with the lower
 334 one).")
 335
 336      (subdivideBeams ,boolean? "If set, multiple beams will be subdivided
 337 at beat positions by only drawing one beam over the beat.")
 338
 339      (systemStartDelimiter ,symbol? "Which grob to make for the start of
 340 the system/staff? Set to @code{SystemStartBrace},
 341 @code{SystemStartBracket} or @code{SystemStartBar}.")
 342
 343      (tablatureFormat ,procedure? "Function formatting a tab note head; it
 344 takes a string number, a list of string tunings and Pitch object. It
 345 returns the text as a string.")
 346
 347      (timeSignatureFraction ,number-pair?
 348                             "pair of numbers, signifying the time
 349 signature. For example @code{#'(4 . 4)} is a 4/4 time signature.")
 350
 351      (timing ,boolean? " Keep administration of measure length, position, bar number, etc?
 352 Switch off for cadenzas.")
 353      (tonic ,ly:pitch?
 354             "The tonic of the current scale")
 355
 356      (tremoloFlags ,integer? "Number of tremolo flags to add if no
 357 number is specified.")
 358
 359      (tupletNumberFormatFunction
 360       ,procedure?
 361       "Function taking a music as input, producing a string. This function
 362 is called to determine the text to print on a tuplet bracket.")
 363
 364      (tupletSpannerDuration ,ly:moment? "
 365 Normally a tuplet bracket is as wide as the
 366 @code{\\times} expression that gave rise to it. By setting this
 367 property, you can make brackets last shorter. Example
 368
 369 @example
 370 @@lilypond[verbatim,fragment]
 371 context Voice \\times 2/3 @{
 372   property Voice.tupletSpannerDuration = #(ly:make-moment 1 4)
 373   c-[8 c c-] c-[ c c-]
 374 @}
 375 @@end lilypond
 376 @end example
 377 .")
 378      (verticalAlignmentChildCallback ,procedure? "What callback to add
 379 to children of a vertical alignment.  It determines what
 380 procedure is used on the alignment itself.")
 381      (verticalExtent ,number-pair? "Hard coded vertical extent.  The format
 382 is a pair of dimensions, for example, this sets the sizes of a staff
 383 to 10 (5+5) staffspaces high.
 384
 385 @example
 386 \\set Staff.verticalExtent = #'(-5.0 . 5.0)
 387 @end example
 388
 389
 390 This does not work for Voice or any other context  that doesn't form a
 391 vertical group.")
 392
 393      (vocalName ,markup? "Name of a vocal line.")
 394      (vocNam ,markup? "Name of a vocal line, short version.")
 395
 396      (voltaOnThisStaff ,boolean?
 397                        "Normally, volta brackets are put only on the
 398 topmost staff.  This variable overrides this behavior, when set to
 399 @code{#t} or @code{#f}.")
 400
 401      (voltaSpannerDuration ,ly:moment? "This specifies the maximum duration
 402 to use for the brackets printed for @code{\\alternative}.  This can be
 403 used to shrink the length of brackets in the situation where one
 404 alternative is very large.")
 405
 406      (whichBar
 407       ,string?
 408       "This property is read to determine what type of bar line to create.
 409
 410 Example:
 411 @example
 412 \\set Staff.whichBar = \"|:\"
 413 @end example
 414
 415 This will create a start-repeat bar in this staff only.
 416 Valid values are described in @internalsref{bar-line-interface}.
 417 ")
 418      )))
 419
 420 (define-public all-internal-translation-properties
 421   (map
 422    (lambda (x)
 423      (set-object-property! (car x) 'internal-translation #t)
 424      (apply translator-property-description x)
 425
 426      )
 427
 428    `((slurMelismaBusy ,boolean? "Signal if a slur is present.")
 429      (originalCentralCPosition
 430       ,integer?
 431       "Used for temporary overriding middle C in octavation brackets. ")
 432      (melismaBusy ,boolean? "Signifies
 433 whether a melisma is active. This can be used to signal melismas on
 434 top of those automatically detected. ")
 435      (graceSettings ,vector?
 436                     "Overrides for grace notes. This property should
 437 be manipulated through the @code{add-grace-property} function.")
 438      (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
 439 current breakable (clef, key signature, etc.) items.")
 440      (currentMusicalColumn ,ly:grob? "Grob that is X-parent to all
 441 non-breakable items (note heads, lyrics, etc.).")
 442      (breakableSeparationItem ,ly:grob?
 443                               "The breakable items in this time step,
 444 for this staff.")
 445
 446      (localKeySignature ,list? "the key signature at this point in the
 447 measure.  The format is the same as for keySignature, but can also
 448 contain ((@var{octave} . @var{name}) . (@var{alter} . @var{barnumber}))
 449 pairs. It is reset at every bar line."  )
 450
 451
 452      (localKeySignatureChanges ,list? "Experimental. [DOCME]")
 453
 454      (finalizations ,list? "List of expressions to evaluate before proceeding to next time step. Internal variable.")
 455      (busyGrobs ,list? "a queue of (@var{end-moment} . @var{GROB})
 456 conses. This is for internal (C++) use only.  This property contains
 457 the grobs which are still busy (e.g. note heads, spanners, etc.)
 458 ")
 459      (barCheckLastFail ,ly:moment? "Where in  the measure did the last barcheck fail?")
 460      (associatedVoiceContext ,ly:context? "The context object of the Voice that has the melody for this Lyrics.")
 461      (acceptHashTable ,vector? "Internal
 462 variable: store table with MusicName to Engraver entries.")
 463      (acknowledgeHashTable ,vector?
 464                            "Internal variable: store interface to engraver smob table for current
 465 context.")
 466
 467      (beamMelismaBusy ,boolean? "Signal if a beam is present.")
 468      (dynamicAbsoluteVolumeFunction ,procedure? "[DOCUMENT-ME]")
 469
 470      (lastKeySignature ,list? "Last key signature before a key
 471 signature change.")
 472
 473      (scriptDefinitions ,list? "Description of scripts. This is used by
 474 Script_engraver for typesetting note-super/subscripts. See
 475 @file{scm/script.scm} for more information
 476 ")
 477      (quotes ,hash-table? "Hash table, mapping names to music-event vectors.")
 478      (stavesFound ,grob-list? "list of all staff-symbols found.")
 479      (instrumentSupport ,grob-list? "list of grobs to attach instrument name
 480 to.")
 481      (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
 482      )
 483    ))
 484
 485 (define-public all-translation-properties
 486   (append all-user-translation-properties
 487           all-internal-translation-properties))
 488
 489 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 490
 491 (define-public default-melisma-properties '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy))