scm/define-context-properties.scm

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