1 ;;;; define-grob-properties.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
8 (define (define-grob-property symbol type? description)
9 (if (not (equal? (object-property symbol 'backend-doc) #f))
10 (ly:error (_ "symbol ~S redefined") symbol))
12 (set-object-property! symbol 'backend-type? type?)
13 (set-object-property! symbol 'backend-doc description)
16 ;; put this in an alist?
18 all-user-grob-properties
22 (apply define-grob-property x))
28 (add-stem-support ,boolean? "If set, the @code{Stem} object is
29 included in this script's support.")
30 (after-line-breaking ,boolean? "Dummy property, used to trigger
31 callback for @code{after-line-breaking}.")
32 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
33 @code{0}: around center of width, @code{1}: right side.")
34 (allow-loose-spacing ,boolean? "If set, column can be detached
36 (allow-span-bar ,boolean? "If false, no inter-staff bar line will
37 be created below this bar line.")
38 (alteration ,number? "Alteration numbers for accidental.")
39 (alteration-alist ,list? "List of @code{(@var{pitch}
40 . @var{accidental})} pairs for key signature.")
41 (annotation ,string? "Annotate a grob for debug purposes.")
42 (arpeggio-direction ,ly:dir? "If set, put an arrow on the
43 arpeggio squiggly line.")
44 (arrow-length ,number? "Arrow length.")
45 (arrow-width ,number? "Arrow width.")
46 (auto-knee-gap ,ly:dimension? "If a gap is found between note
47 heads where a horizontal beam fits that is larger than this number,
49 (average-spacing-wishes ,boolean? "If set, the spacing wishes are
50 averaged over staves.")
51 (avoid-note-head ,boolean? "If set, the stem of a chord does not
52 pass through all note heads, but starts at the last note head.")
53 (avoid-slur ,symbol? "Method of handling slur collisions.
54 Choices are @code{around}, @code{inside}, @code{outside}. If unset,
55 scripts and slurs ignore each other. @code{around} only moves the
56 script if there is a collision; @code{outside} always moves the
58 (axes ,list? "List of axis numbers. In the case of alignment
59 grobs, this should contain only one number.")
65 (bar-size ,ly:dimension? "The size of a bar line.")
66 (base-shortest-duration ,ly:moment? "Spacing is based on the
67 shortest notes in a piece. Normally, pieces are spaced as if notes at
68 least as short as this are present.")
69 (baseline-skip ,ly:dimension? "Distance between base lines of
70 multiple lines of text.")
71 (beam-thickness ,ly:dimension? "Beam thickness, measured in
72 @code{staff-space} units.")
73 (beam-width ,ly:dimension? "Width of the tremolo sign.")
74 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
75 when their direction is forced. It is a list, since the value is
76 different depending on the number of flags and beams.")
77 (beaming ,pair? "Pair of number lists. Each number list
78 specifies which beams to make. @code{0}@tie{}is the central beam,
79 @code{1}@tie{}is the next beam toward the note, etc. This information
80 is used to determine how to connect the beaming patterns from stem to
82 (beamlet-default-length ,pair? "A pair of numbers. The first
83 number specifies the default length of a beamlet that sticks out of
84 the left hand side of this stem; the second number specifies the
85 default length of the beamlet to the right. The actual length of a
86 beamlet is determined by taking either the default length or the
87 length specified by @code{beamlet-max-length-proportion}, whichever is
89 (beamlet-max-length-proportion ,pair? "The maximum length of a
90 beamlet, as a proportion of the distance between two adjacent stems.")
91 (before-line-breaking ,boolean? "Dummy property, used to trigger
92 a callback function.")
93 (between-cols ,pair? "Where to attach a loose column to.")
94 (bound-padding ,number? "The amount of padding to insert around
96 (bound-details ,list? "An alist of properties for determining
97 attachments of spanners to edges.")
98 (bracket-flare ,number-pair? "A pair of numbers specifying how
99 much edges of brackets should slant outward. Value @code{0.0} means
101 (bracket-visibility ,boolean-or-symbol? "This controls the
102 visibility of the tuplet bracket. Setting it to false prevents
103 printing of the bracket. Setting the property to @code{if-no-beam}
104 makes it print only if there is no beam associated with this tuplet
106 (break-align-anchor ,number? "Grobs aligned to this break-align
107 grob will have their X-offsets shifted by this number. In bar lines,
108 for example, this is used to position grobs relative to the (visual)
109 center of the bar line.")
110 (break-align-anchor-alignment ,number? "Read by
111 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
112 aligning an anchor to a grob's extent")
113 (break-align-symbol ,symbol? "This key is used for aligning and
114 spacing breakable items.")
115 (break-align-symbols ,list? "A list of symbols that determine
116 which break-aligned grobs to align this to. If the grob selected by
117 the first symbol in the list is invisible due to break-visibility, we
118 will align to the next grob (and so on).")
119 (break-align-orders ,vector? "Defines the order in which
120 prefatory matter (clefs, key signatures) appears. The format is a
121 vector of length@tie{}3, where each element is one order for
122 end-of-line, middle of line, and start-of-line, respectively. An
123 order is a list of symbols.
125 For example, clefs are put after key signatures by setting
128 \\override Score.BreakAlignment #'break-align-orders =
129 #(make-vector 3 '(span-bar
136 (break-overshoot ,number-pair? "How much does a broken spanner
137 stick out of its bounds?")
138 (break-visibility ,vector? "A vector of 3@tie{}booleans,
139 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
140 @code{#t} means visible, @code{#f} means killed.")
141 (breakable ,boolean? "Allow breaks here.")
147 (c0-position ,integer? "An integer indicating the position of
149 (circled-tip ,boolean? "Put a circle at start/end of
150 hairpins (al/del niente).")
151 (clip-edges ,boolean? "Allow outward pointing beamlets at the
153 (collapse-height ,ly:dimension? "Minimum height of system start
154 delimiter. If equal or smaller, the bracket/brace/line is removed.")
155 (color ,color? "The color of this grob.")
156 (common-shortest-duration ,ly:moment? "The most common shortest
157 note length. This is used in spacing. Enlarging this sets the score
159 (concaveness ,number? "A beam is concave if its inner stems are
160 closer to the beam than the two outside stems. This number is a
161 measure of the closeness of the inner stems. It is used for damping
162 the slope of the beam.")
163 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
164 this grob looks as a continued break.")
165 (control-points ,list? "List of offsets (number pairs) that form
166 control points for the tie, slur, or bracket shape. For B@'eziers,
167 this should list the control points of a third-order B@'ezier curve.")
173 (damping ,number? "Amount of beam slope damping.")
174 (dash-fraction ,number? "Size of the dashes, relative to
175 @code{dash-period}. Should be between @code{0.0} (no line) and
176 @code{1.0} (continuous line).")
177 (dash-period ,number? "The length of one dash together with
178 whitespace. If negative, no line is drawn at all.")
179 (default-direction ,ly:dir? "Direction determined by note head
181 (digit-names ,vector "Names for string finger digits.")
182 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
183 @code{#X}), then this property determines whether the object is placed
184 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
185 other object. Otherwise, it determines whether the object is placed
186 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also
187 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
188 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1},
189 @code{#CENTER}=@code{0}.")
190 (dot-count ,integer? "The number of dots.")
191 (dot-negative-kern ,number? "The space to remove between a dot
192 and a slash in percent repeat glyphs. Larger values bring the two
193 elements closer together.")
194 (dot-placement-list ,list? "List consisting of
195 @code{(@var{description} @var{string-number} @var{fret-number}
196 @var{finger-number})} entries used to define fret diagrams.")
197 (duration-log ,integer? "The 2-log of the note head duration,
198 i.e., @code{0} = whole note, @code{1} = half note, etc.")
204 (eccentricity ,number? "How asymmetrical to make a slur.
205 Positive means move the center to the right.")
206 (edge-height ,pair? "A pair of numbers specifying the heights of
207 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
208 (edge-text ,pair? "A pair specifying the texts to be set at the
209 edges: @code{(@var{left-text} . @var{right-text})}.")
210 (expand-limit ,integer? "Maximum number of measures expanded in
212 (extra-X-extent ,number-pair? "A grob is enlarged in
213 X@tie{}dimension by this much.")
214 (extra-Y-extent ,number-pair? "A grob is enlarged in
215 Y@tie{}dimension by this much.")
217 (extra-dy ,number? "Slope glissandi this much extra.")
218 (extra-offset ,number-pair? "A pair representing an offset. This
219 offset is added just before outputting the symbol, so the typesetting
220 engine is completely oblivious to it. The values are measured in
221 @code{staff-space} units of the staff's @code{StaffSymbol}.")
222 (extra-spacing-height ,number-pair? "In the horizontal spacing
223 problem, we increase the height of each item by this amount (by adding
224 the @q{car} to the bottom of the item and adding the @q{cdr} to the
225 top of the item). In order to make a grob infinitely high (to prevent
226 the horizontal spacing problem from placing any other grobs above or
227 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
228 (extra-spacing-width ,number-pair? "In the horizontal spacing
229 problem, we pad each item by this amount (by adding the @q{car} on the
230 left side of the item and adding the @q{cdr} on the right side of the
231 item). In order to make a grob take up no horizontal space at all,
232 set this to @code{(+inf.0 . -inf.0)}.")
238 (flag ,ly:stencil? "A function returning the full flag stencil
239 for the @code{Stem}, which is passed to the function as the only
240 argument. The default ly:stem::calc-stencil function uses the
241 @code{flag-style} property to determine the correct glyph for the
242 flag. By providing your own function, you can create arbitrary
244 (flag-count ,number? "The number of tremolo beams.")
245 (flag-style ,symbol? "A symbol determining what style of flag
246 glyph is typeset on a @code{Stem}. Valid options include @code{'()}
247 for standard flags, @code{'mensural} and @code{'no-flag}, which
248 switches off the flag.")
249 (font-encoding ,symbol? "The font encoding is the broadest
250 category for selecting a font. Currently, only lilypond's system
251 fonts (Emmentaler and Aybabtu) are using this property. Available
252 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces} (Aybabtu),
253 @code{fetaNumber} (Emmentaler), and @code{fetaDynamic} (Emmentaler).")
254 (font-family ,symbol? "The font family is the broadest category
255 for selecting text fonts. Options include: @code{sans},
257 (font-name ,string? "Specifies a file name (without extension) of
258 the font to load. This setting overrides selection using
259 @code{font-family}, @code{font-series} and @code{font-shape}.")
260 (font-series ,symbol? "Select the series of a font. Choices
261 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
262 (font-shape ,symbol? "Select the shape of a font. Choices
263 include @code{upright}, @code{italic}, @code{caps}.")
264 (font-size ,number? "The font size, compared to the
265 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
266 @code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
267 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
268 larger. Fractional values are allowed.")
269 (force-hshift ,number? "This specifies a manual shift for notes
270 in collisions. The unit is the note head width of the first voice
271 note. This is used by @rinternals{note-collision-interface}.")
272 (fraction ,number-pair? "Numerator and denominator of a time
274 (french-beaming ,boolean? "Use French beaming style for this
275 stem. The stem stops at the innermost beams.")
276 (fret-diagram-details ,list? "An alist of detailed grob
277 properties for fret diagrams. Each alist entry consists of a
278 @code{(@var{property} . @var{value})} pair. The properties which can
279 be included in @code{fret-diagram-details} include the following:
283 @code{barre-type} -- Type of barre indication used. Choices include
284 @code{curved}, @code{straight}, and @code{none}. Default
287 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
288 fret-space. Default value@tie{}0.5.
290 @code{dot-color} -- Color of dots. Options include @code{black} and
291 @code{white}. Default @code{black}.
293 @code{dot-label-font-mag} -- Magnification for font used to label fret
294 dots. Default value@tie{}1.
296 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
297 dots without labels, 0.95-@code{dot-radius} for dots with labels.
299 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
300 value 0.425 for labeled dots, 0.25 for unlabeled dots.
302 @code{finger-code} -- Code for the type of fingering indication used.
303 Options include @code{none}, @code{in-dot}, and @code{below-string}.
304 Default @code{none} for markup fret diagrams, @code{below-string} for
305 @code{FretBoards} fret diagrams.
307 @code{fret-count} -- The number of frets. Default@tie{}4.
309 @code{fret-label-font-mag} -- The magnification of the font used to
310 label the lowest fret number. Default@tie{}0.5.
312 @code{fret-label-vertical-offset} -- The offset of the fret label from
313 the center of the fret in direction parallel to strings.
316 @code{label-dir} -- Side to which the fret label is attached.
317 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1},
318 @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}.
320 @code{mute-string} -- Character string to be used to indicate muted
321 string. Default @code{\"x\"}.
323 @code{number-type} -- Type of numbers to use in fret label. Choices
324 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.
325 Default @code{roman-lower}.
327 @code{open-string} -- Character string to be used to indicate open
328 string. Default @code{\"o\"}.
330 @code{orientation} -- Orientation of fret-diagram. Options include
331 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
332 Default @code{normal}.
334 @code{string-count} -- The number of strings. Default@tie{}6.
336 @code{string-label-font-mag} -- The magnification of the font used to
337 label fingerings at the string, rather than in the dot. Default value
338 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
339 @code{opposing-landscape}.
341 @code{string-thickness-factor} -- Factor for changing thickness of
342 each string in the fret diagram. Thickness of string @var{k} is given
344 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
347 @code{top-fret-thickness} -- The thickness of the top fret line, as a
348 multiple of the standard thickness. Default value@tie{}3.
350 @code{xo-font-magnification} -- Magnification used for mute and open
351 string indicators. Default value@tie{}0.5.
353 @code{xo-padding} -- Padding for open and mute indicators from top
354 fret. Default value 0.25.
356 ;; ugh: double, change.
357 (full-length-padding ,number? "How much padding to use at the
358 right side of a full-length tuplet bracket.")
359 (full-length-to-extent ,boolean? "Run to the extent of the column
360 for a full-length tuplet bracket.")
361 (full-measure-extra-space ,number? "Extra space that is allocated
362 at the beginning of a measure with only one note. This property is
363 read from the NonMusicalPaperColumn that begins the measure.")
364 (full-size-change ,boolean? "Don't make a change clef smaller.")
370 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
371 (gap-count ,integer? "Number of gapped beams for tremolo.")
372 (glyph ,string? "A string determining what @q{style} of glyph is
373 typeset. Valid choices depend on the function that is reading this
375 (glyph-name-alist ,list? "An alist of key-string pairs.")
376 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
382 (hair-thickness ,number? "Thickness of the thin line in a bar
384 (harp-pedal-details ,list? "An alist of detailed grob properties
385 for harp pedal diagrams. Each alist entry consists of a
386 @code{(@var{property} . @var{value})} pair. The properties which can
387 be included in harp-pedal-details include the following:
391 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
392 boxes above/below the horizontal line. Default value@tie{}0.8.
394 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
396 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
398 @code{space-before-divider} -- Space between boxes before the first
399 divider (so that the diagram can be made symmetric). Default
402 @code{space-after-divider} -- Space between boxes after the first
403 divider. Default value@tie{}0.8.
405 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
406 of the ellipse around circled pedals. Default value@tie{}0.5.
408 @code{circle-x-padding} -- Padding in X direction of the ellipse
409 around circled pedals. Default value 0.15.
411 @code{circle-y-padding} -- Padding in Y direction of the ellipse
412 around circled pedals. Default value@tie{}0.2.
414 (head-direction ,ly:dir? "Are the note heads left or right in a
416 (height ,ly:dimension? "Height of an object in @code{staff-space}
418 (height-limit ,ly:dimension? "Maximum slur height: The longer the
419 slur, the closer it is to this height.")
420 (horizontal-shift ,integer? "An integer that identifies ranking
421 of @code{NoteColumn}s for horizontal shifting. This is used by
422 @rinternals{note-collision-interface}.")
423 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
424 left and one to the right of this grob.")
430 (ignore-collision ,boolean? "If set, don't do note collision
431 resolution on this @code{NoteColumn}.")
432 (implicit ,boolean? "Is this an implicit bass figure?")
433 (inspect-index ,integer? "If debugging is set, set beam and slur
434 configuration to this index, and print the respective scores.")
435 (inspect-quants ,number-pair? "If debugging is set, set beam and
436 slur quants to this position, and print the respective scores.")
442 (keep-fixed-while-stretching ,boolean? "A grob with this property
443 set to true is fixed relative to the staff above it when systems are
445 (keep-inside-line ,boolean? "If set, this column cannot have
446 objects sticking into the margin.")
447 (kern ,ly:dimension? "Amount of extra white space to add. For
448 bar lines, this is the amount of space after a thick line.")
449 (knee ,boolean? "Is this beam kneed?")
450 (knee-spacing-correction ,number? "Factor for the optical
451 correction amount for kneed beams. Set between @code{0} for no
452 correction and @code{1} for full correction.")
458 (labels ,list? "List of labels (symbols) placed on a column")
459 (layer ,integer? "The output layer (a value between 0
460 and@tie{}2): Layers define the order of printing objects. Objects in
461 lower layers are overprinted by objects in higher layers.")
462 (ledger-line-thickness ,number-pair? "The thickness of ledger
463 lines. It is the sum of 2@tie{}numbers: The first is the factor for
464 line thickness, and the second for staff space. Both contributions
466 (left-bound-info ,list? "An alist of properties for determining
467 attachments of spanners to edges.")
468 (left-padding ,ly:dimension? "The amount of space that is put
469 left to an object (e.g., a group of accidentals).")
470 (length ,ly:dimension? "User override for the stem length of
472 (length-fraction ,number? "Multiplier for lengths. Used for
473 determining ledger lines and stem lengths.")
474 (line-break-penalty ,number? "Penalty for a line break at this
475 column. This affects the choices of the line breaker; it avoids a
476 line break at a column with a positive penalty and prefers a line
477 break at a column with a negative penalty.")
478 (line-break-permission ,symbol? "Instructs the line breaker on
479 whether to put a line break at this column. Can be @code{force} or
481 (line-break-system-details ,list? "An alist of properties to use
482 if this column is the start of a system.")
483 (line-count ,integer? "The number of staff lines.")
484 (line-positions ,list? "Vertical positions of staff lines.")
485 (line-thickness ,number? "The thickness of the tie or slur
487 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
493 (max-beam-connect ,integer? "Maximum number of beams to connect
494 to beams from this stem. Further beams are typeset as beamlets.")
495 (max-stretch ,number? "The maximum amount that this
496 @code{VerticalAxisGroup} can be vertically stretched (for example, in
497 order to better fill a page).")
498 (measure-count ,integer? "The number of measures for a
499 multi-measure rest.")
500 (measure-length ,ly:moment? "Length of a measure. Used in some
501 spacing situations.")
502 (merge-differently-dotted ,boolean? "Merge note heads in
503 collisions, even if they have a different number of dots. This is
504 normal notation for some types of polyphonic music.
506 @code{merge-differently-dotted} only applies to opposing stem
507 directions (i.e., voice 1 &@tie{}2).")
508 (merge-differently-headed ,boolean? "Merge note heads in
509 collisions, even if they have different note heads. The smaller of
510 the two heads is rendered invisible. This is used in polyphonic
511 guitar notation. The value of this setting is used by
512 @rinternals{note-collision-interface}.
514 @code{merge-differently-headed} only applies to opposing stem
515 directions (i.e., voice 1 &@tie{}2).")
516 (minimum-X-extent ,number-pair? "Minimum size of an object in
517 X@tie{}dimension, measured in @code{staff-space} units.")
518 (minimum-Y-extent ,number-pair? "Minimum size of an object in
519 Y@tie{}dimension, measured in @code{staff-space} units.")
520 (minimum-distance ,ly:dimension? "Minimum distance between rest
522 (minimum-length ,ly:dimension? "Try to make a spanner at least
523 this long, normally in the horizontal direction. This requires an
524 appropriate callback for the @code{springs-and-rods} property. If
525 added to a @code{Tie}, this sets the minimum distance between
527 (minimum-length-fraction ,number? "Minimum length of ledger line
528 as fraction of note head size.")
529 (minimum-space ,ly:dimension? "Minimum distance that the victim
530 should move (after padding).")
536 (neutral-direction ,ly:dir? "Which direction to take in the
537 center of the staff.")
538 (neutral-position ,number? "Position (in half staff spaces) where
539 to flip the direction of custos stem.")
540 (next ,ly:grob? "Object that is next relation (e.g., the lyric
541 syllable following an extender).")
542 (no-alignment ,boolean? "If set, don't place this grob in a
543 @code{VerticalAlignment}; rather, place it using its own
544 @code{Y-offset} callback.")
545 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
547 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
548 get stems extending to the middle staff line.")
549 (non-default ,boolean? "Set for manually specified clefs.")
550 (non-musical ,boolean? "True if the grob belongs to a
551 @code{NonMusicalPaperColumn}.")
552 (note-names ,vector? "Vector of strings containing names for
553 easy-notation note heads.")
559 (outside-staff-horizontal-padding ,number? "By default, an
560 outside-staff-object can be placed so that is it very close to another
561 grob horizontally. If this property is set, the outside-staff-object
562 is raised so that it is not so close to its neighbor.")
563 (outside-staff-padding ,number? "The padding to place between
564 this grob and the staff when spacing according to
565 @code{outside-staff-priority}.")
566 (outside-staff-priority ,number? "If set, the grob is positioned
567 outside the staff in such a way as to avoid all collisions. In case
568 of a potential collision, the grob with the smaller
569 @code{outside-staff-priority} is closer to the staff.")
575 (packed-spacing ,boolean? "If set, the notes are spaced as
576 tightly as possible.")
577 (padding ,ly:dimension? "Add this much extra space between
578 objects that are next to each other.")
579 (padding-pairs ,list? "An alist mapping @code{(@var{name}
580 . @var{name})} to distances.")
581 (page-break-penalty ,number? "Penalty for page break at this
582 column. This affects the choices of the page breaker; it avoids a
583 page break at a column with a positive penalty and prefers a page
584 break at a column with a negative penalty.")
585 (page-break-permission ,symbol? "Instructs the page breaker on
586 whether to put a page break at this column. Can be @code{force} or
588 (page-turn-penalty ,number? "Penalty for a page turn at this
589 column. This affects the choices of the page breaker; it avoids a
590 page turn at a column with a positive penalty and prefers a page turn
591 at a column with a negative penalty.")
592 (page-turn-permission ,symbol? "Instructs the page breaker on
593 whether to put a page turn at this column. Can be @code{force} or
595 (parenthesized ,boolean? "Parenthesize this grob.")
596 (positions ,number-pair? "Pair of staff coordinates
597 @code{(@var{left} . @var{right})}, where both @var{left} and
598 @var{right} are in @code{staff-space} units of the current staff. For
599 slurs, this value selects which slur candidate to use; if extreme
600 positions are requested, the closest one is taken.")
601 (prefer-dotted-right ,boolean? "For note collisions, prefer to
602 shift dotted up-note to the right, rather than shifting just the
609 (ratio ,number? "Parameter for slur shape. The higher this
610 number, the quicker the slur attains its @code{height-limit}.")
611 (remove-empty ,boolean? "If set, remove group if it contains no
613 (remove-first ,boolean? "Remove the first staff of an orchestral
615 (restore-first ,boolean? "Print a natural before the
617 (rhythmic-location ,rhythmic-location? "Where (bar number,
618 measure position) in the score.")
619 (right-bound-info ,list? "An alist of properties for determining
620 attachments of spanners to edges.")
621 (right-padding ,ly:dimension? "Space to insert on the right side
622 of an object (e.g., between note and its accidentals).")
623 (rotation ,list? "Number of degrees to rotate this object, and
624 what point to rotate around. For example, @code{#'(45 0 0)} rotates
625 by 45 degrees around the center of this object.")
631 (same-direction-correction ,number? "Optical correction amount
632 for stems that are placed in tight configurations. This amount is
633 used for stems with the same direction to compensate for note head to
635 (script-priority ,number? "A sorting key that determines in what
636 order a script is within a stack of scripts.")
637 (self-alignment-X ,number? "Specify alignment of an object. The
638 value @code{-1} means left aligned, @code{0}@tie{}centered, and
639 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
640 values may also be specified.")
641 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
643 (toward-stem-shift ,number? "Amount by which scripts are shifted
644 toward the stem if their direction coincides with the stem direction.
645 @code{0.0} means keep the default position (centered on the note
646 head), @code{1.0} means centered on the stem. Interpolated values are
648 (shorten-pair ,number-pair? "The lengths to shorten a
649 text-spanner on both sides, for example a pedal bracket. Positive
650 values shorten the text-spanner, while negative values lengthen it.")
651 (shortest-duration-space ,ly:dimension? "Start with this much
652 space for the shortest duration. This is expressed in
653 @code{spacing-increment} as unit. See also
654 @rinternals{spacing-spanner-interface}.")
655 (shortest-playing-duration ,ly:moment? "The duration of the
656 shortest note playing here.")
657 (shortest-starter-duration ,ly:moment? "The duration of the
658 shortest note that starts here.")
659 (side-axis ,number? "If the value is @code{#X} (or
660 equivalently@tie{}@code{0}), the object is placed horizontally next to
661 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is
663 (side-relative-direction ,ly:dir? "Multiply direction of
664 @code{direction-source} with this to get the direction of this
666 (size ,number? "Size of object, relative to standard size.")
667 (skyline-horizontal-padding ,number? "For determining the
668 vertical distance between two staves, it is possible to have a
669 configuration which would result in a tight interleaving of grobs from
670 the top staff and the bottom staff. The larger this parameter is, the
671 farther apart the staves are placed in such a configuration.")
672 (slash-negative-kern ,number? "The space to remove between
673 slashes in percent repeat glyphs. Larger values bring the two
674 elements closer together.")
675 (slope ,number? "The slope of this object.")
676 (slur-padding ,number? "Extra distance between slur and script.")
677 (space-alist ,list? "A table that specifies distances between
678 prefatory items, like clef and time-signature. The format is an alist
679 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
680 . @var{distance})}, where @var{type} can be the symbols
681 @code{minimum-space} or @code{extra-space}.")
682 (space-to-barline ,boolean? "If set, the distance between a note
683 and the following non-musical column will be measured to the bar line
684 instead of to the beginning of the non-musical column. If there is a
685 clef change followed by a bar line, for example, this means that we
686 will try to space the non-musical column as though the clef is not
688 (spacing-increment ,number? "Add this much space for a doubled
689 duration. Typically, the width of a note head. See also
690 @rinternals{spacing-spanner-interface}.")
691 (springs-and-rods ,boolean? "Dummy variable for triggering
693 (stacking-dir ,ly:dir? "Stack objects in which direction?")
694 (staff-padding ,ly:dimension? "Maintain this much space between
695 reference points and the staff. Its effect is to align objects of
696 differing sizes (like the dynamics @b{p} and @b{f}) on their
698 (staff-position ,number? "Vertical position, measured in half
699 staff spaces, counted from the middle line.")
700 (staff-space ,ly:dimension? "Amount of space between staff lines,
701 expressed in global @code{staff-space}.")
702 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
703 pair where the stem attaches to the notehead.")
704 (stem-end-position ,number? "Where does the stem end (the end is
705 opposite to the support-head)?")
707 (stem-spacing-correction ,number? "Optical correction amount for
708 stems that are placed in tight configurations. For opposite
709 directions, this amount is the correction for two normal sized stems
710 that overlap completely.")
711 (stemlet-length ,number? "How long should be a stem over a
713 (stencil ,ly:stencil? "The symbol to print.")
714 (stencils ,list? "Multiple stencils, used as intermediate
716 (strict-grace-spacing ,boolean? "If set, main notes are spaced
717 normally, then grace notes are put left of the musical columns fot the
719 (strict-note-spacing ,boolean? "If set, unbroken columns with
720 non-musical material (clefs, bar lines, etc.) are not spaced
721 separately, but put before musical columns.")
722 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
724 (style ,symbol? "This setting determines in what style a grob is
725 typeset. Valid choices depend on the @code{stencil} callback reading
732 (text ,markup? "Text markup. See @ruser{Formatting text}.")
733 ;;FIXME -- Should both be the same?
734 (text-direction ,ly:dir? "This controls the ordering of the
735 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
736 should use @code{LEFT}.")
737 (thick-thickness ,number? "Bar line thickness, measured in
738 @code{line-thickness}.")
739 (thickness ,number? "Line thickness, generally measured in
740 @code{line-thickness}.")
741 (thin-kern ,number? "The space after a hair-line in a bar line.")
742 (threshold ,number-pair? "@code{(@var{min} . @var{max})}, where
743 @var{min} and @var{max} are dimensions in staff space.")
744 (tie-configuration ,list? "List of @code{(@var{position} .
745 @var{dir})} pairs, indicating the desired tie configuration, where
746 @var{position} is the offset from the center of the staff in staff
747 space and @var{dir} indicates the direction of the tie
748 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
749 in the list causes the corresponding tie to be formatted
751 (to-barline ,boolean? "If true, the spanner will stop at the bar
752 line just before it would otherwise stop.")
753 (transparent ,boolean? "This makes the grob invisible.")
759 (uniform-stretching ,boolean? "If set, items stretch
760 proportionally to their durations. This looks better in complex
761 polyphonic patterns.")
762 (used ,boolean? "If set, this spacing column is kept in the
769 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
770 one below this grob.")
776 (when ,ly:moment? "Global time step associated with this column
778 (width ,ly:dimension? "The width of a grob measured in staff
780 (word-space ,ly:dimension? "Space to insert between words in
787 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
788 (X-offset ,number? "The horizontal amount that this object is
789 moved relative to its X-parent.")
795 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
796 (Y-offset ,number? "The vertical amount that this object is moved
797 relative to its Y-parent.")
802 (zigzag-length ,ly:dimension? "The length of the lines of a
803 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
804 gives 60-degree zigzags.")
805 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
806 This number is adjusted slightly so that the glissando line can be
807 constructed from a whole number of squiggles.")
815 (define (define-internal-grob-property symbol type? description)
816 (define-grob-property symbol type? description)
817 (set-object-property! symbol 'backend-internal #t)
822 (define-public all-internal-grob-properties
825 (apply define-internal-grob-property x))
829 ;; grobs & grob arrays. (alphabetical)
830 (X-common ,ly:grob? "Common reference point for axis group.")
832 (Y-common ,ly:grob? "See @code{X-common}.")
834 (accidental-grob ,ly:grob? "The accidental for this note.")
835 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
836 @var{groblist})} entries.")
837 (adjacent-pure-heights ,vector? "Used by a @code{VerticalAxisGroup} to
838 cache the @code{Y-extent}s of different column ranges.")
839 (adjacent-hairpins ,ly:grob-array? "A list of directly neighboring
841 (all-elements ,ly:grob-array? "A list of all grobs in this line. Its
842 function is to protect objects from being garbage collected.")
843 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
844 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
845 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
847 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
848 This may differ from @code{Y-extent} because it does not include the dots in
850 (bars ,ly:grob-array? "A list of bar line pointers.")
851 (beam ,ly:grob? "A pointer to the beam, if applicable.")
852 (bounded-by-me ,ly:grob-array? "A list of spanners that have this
853 column as start/begin point. Only columns that have grobs or act as
855 (bracket ,ly:grob? "The bracket for a number.")
857 (columns ,ly:grob-array? "A list of grobs, typically containing
858 @code{PaperColumn} or @code{NoteColumn} objects.")
859 (conditional-elements ,ly:grob-array? "Internal use only.")
860 (cross-staff ,boolean? "For a beam or a stem, this is true if we
861 depend on inter-staff spacing.")
863 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
864 set, which grob to get the direction from.")
865 (dot ,ly:grob? "A reference to a @code{Dots} object.")
866 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
868 (elements ,ly:grob-array? "A list of grobs; the type is depending on
869 the grob where this is set in.")
870 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
871 in addition to notes and stems.")
873 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
874 (forced ,boolean? "Manually forced accidental.")
876 (glyph-name ,string? "The glyph name within the font.")
877 (grace-spacing ,ly:grob? "A run of grace notes.")
879 (heads ,ly:grob-array? "A list of note heads.")
881 (important-column-ranks ,vector? "A cache of columns that contain
882 @code{items-worth-living} data.")
883 (items-worth-living ,ly:grob-array? "A list of interesting items. If
884 empty in a particular staff, then that staff is erased.")
886 (left-items ,ly:grob-array? "DOCME")
887 (left-neighbors ,ly:grob-array? "A list of @code{spacing-wishes} grobs
888 that are close to the current column.
890 The closest @code{spacing-wishes} determine the actual distances between the
893 (normal-stems ,ly:grob-array? "An array of visible stems.")
894 (note-columns ,pair? "A list of @code{NoteColumn} grobs.")
895 (note-head ,ly:grob? "A single note head.")
896 (note-heads ,ly:grob-array? "A list of note head grobs.")
897 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
899 (pure-Y-common ,ly:grob? "A cache of the
900 @code{common_refpoint_of_array} of the @code{elements} grob set.")
901 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
902 cyclic dependencies.")
903 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
904 relevant for finding the @code{pure-Y-extent}.")
905 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
906 relevant for finding the @code{pure-Y-extent}.")
908 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
909 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
910 (rests ,ly:grob-array? "A list of rest objects.")
911 (right-items ,ly:grob-array? "DOCME")
912 (right-neighbors ,ly:grob-array? "See @code{left-neighbors}.")
914 (separation-item ,ly:grob? "A separation item.")
915 (side-support-elements ,ly:grob-array? "The side support, a list of
917 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
918 (spaceable-staves ,ly:grob-array? "Objects to be spaced during page
920 (spacing ,ly:grob? "The spacing spanner governing this section.")
921 (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing
923 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
924 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
925 (stems ,ly:grob-array? "A list of stem objects, corresponding to the
926 notes that the arpeggio has to be before.")
928 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
929 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
930 (tuplet-number ,ly:grob? "The number for a bracket.")
931 (tuplets ,ly:grob-array? "A list of smaller tuplet brackets.")
935 (begin-of-line-visible ,boolean? "Used for marking @code{ChordNames}
936 that should only show changes.")
938 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
939 translator) that was the cause for this grob.")
940 (delta-position ,number? "The vertical position difference.")
941 (details ,list? "Alist of parameters for detailed grob behavior.
943 More information on the allowed parameters can be found by inspecting
944 @file{lily/slur-scoring.cc}, @file{lily/beam-quanting.cc}, and
945 @file{lily/tie-formatting-problem.cc}. Setting @code{debug-tie-scoring},
946 @code{debug-beam-scoring} or @code{debug-slur-scoring} also provides
949 (font ,ly:font-metric? "A cached font metric object.")
951 (head-width ,ly:dimension? "The width of this ligature head.")
953 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
954 @var{strength}))} pairs.")
955 (interfaces ,list? "A list of symbols indicating the interfaces
956 supported by this object. It is initialized from the @code{meta} field.")
958 (least-squares-dy ,number? "The ideal beam slope, without damping.")
960 (meta ,list? "Provide meta information. It is an alist with the
961 entries @code{name} and @code{interfaces}.")
962 (minimum-distances ,list? "A list of rods that have the format
963 @code{(@var{obj} . @var{dist})}.")
965 (positioning-done ,boolean? "Used to signal that a positioning element
966 did its job. This ensures that a positioning is only done once.")
967 (pure-Y-extent ,number-pair? "The estimated height of a system.")
969 (quant-score ,string? "The beam quanting score; stored for
971 (quantize-position ,boolean? "If set, a vertical alignment is aligned
972 to be within staff spaces.")
973 (quantized-positions ,number-pair? "The beam positions after
976 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
977 acts as an index for looking up a @code{Stencil} object.")
978 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
979 Internally used to distribute beam shortening over stems.")
980 (skyline-distance ,number? "The distance between this staff and the
981 next one, as determined by a skyline algorithm.")
982 (stem-info ,pair? "A cache of stem parameters.")
984 (use-breve-rest ,boolean? "Use breve rests for measures longer
991 ;; There are too many properties for ancient notation;
992 ;; probably neume-types (a list of symbols) would also work.
994 ;; However, such a list would consist of a couple of dozens of
995 ;; entries, since head prefixes may be combined in many ways. If
996 ;; the macros in `gregorian.ly' would directly set prefix-set,
997 ;; all the head prefixes could be junked; however, such macros
998 ;; would be quite numerous, I guess. --jr
1000 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1002 (add-join ,boolean? "Is this ligature head-joined with the next one
1003 by a vertical line?")
1004 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1005 an additional stem on the right side?")
1006 (ascendens ,boolean? "Is this neume of ascending type?")
1007 (auctum ,boolean? "Is this neume liquescentically augmented?")
1009 (cavum ,boolean? "Is this neume outlined?")
1010 (context-info ,integer? "Within a ligature, the final glyph or shape of
1011 a head may be affected by the left and/or right neighbour head.
1012 @code{context-info} holds for each head such information about the left and
1013 right neighbour, encoded as a bit mask.")
1015 (descendens ,boolean? "Is this neume of descendent type?")
1016 (deminutum ,boolean? "Is this neume deminished?")
1018 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1019 grob (in @code{staff-space} units).")
1020 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1021 ligature grob in (in @code{staff-space} units).")
1023 (inclinatum ,boolean? "Is this neume an inclinatum?")
1025 (join-heads ,boolean? "Whether to join the note heads of an ambitus
1026 grob with a vertical line.")
1027 (join-right-amount ,number? "DOCME")
1029 (linea ,boolean? "Attach vertical lines to this neume?")
1031 (oriscus ,boolean? "Is this neume an oriscus?")
1033 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1035 (prefix-set ,number? "A bit mask that holds all Gregorian head
1036 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1037 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1038 similar to a note head that is part of a ligature.")
1040 (quilisma ,boolean? "Is this neume a quilisma?")
1042 (stropha ,boolean? "Is this neume a stropha?")
1044 (virga ,boolean? "Is this neume a virga?")
1046 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1050 (define-public all-backend-properties
1052 all-internal-grob-properties
1053 all-user-grob-properties))