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