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