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