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