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