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