1 ;;;; grob-property-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2007 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))
25 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
26 (X-offset ,number? "The horizontal amount that this object is
27 moved relative to its X-parent.")
28 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
29 (Y-offset ,number? "The vertical amount that this object is moved
30 relative to its Y-parent.")
32 (add-stem-support ,boolean? "If set, the @code{Stem} object is
33 included in this script's support.")
34 (after-line-breaking ,boolean? "Dummy property, used to trigger
35 callback for @code{after-line-breaking}.")
36 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
37 @code{0}: around center of width, @code{1}: right side.")
38 (allow-loose-spacing ,boolean? "If set, column can be detached
40 (allow-span-bar ,boolean? "If false, no inter-staff bar line will
41 be created below this bar line.")
42 (alteration ,number? "Alteration numbers for accidental.")
43 (alteration-alist ,list? "List of @code{(@var{pitch}
44 . @var{accidental})} pairs for key signature.")
45 (annotation ,string? "Annotate a grob for debug purposes.")
46 (arpeggio-direction ,ly:dir? "If set, put an arrow on the
47 arpeggio squiggly line.")
48 (arrow-length ,number? "Arrow length.")
49 (arrow-width ,number? "Arrow width.")
50 (auto-knee-gap ,ly:dimension? "If a gap is found between note
51 heads where a horizontal beam fits that is larger than this number,
53 (average-spacing-wishes ,boolean? "If set, the spacing wishes
54 are averaged over staves.")
55 (avoid-note-head ,boolean? "If set, the stem of a chord does not
56 pass through all note heads, but starts at the last note head.")
57 (avoid-slur ,symbol? "Method of handling slur collisions.
58 Choices are @code{around}, @code{inside}, @code{outside}. If unset,
59 scripts and slurs ignore each other. @code{around} only moves the
60 script if there is a collision; @code{outside} always moves the
62 (axes ,list? "List of axis numbers. In the case of alignment
63 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
68 at 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
80 information is used to determine how to connect the beaming patterns
81 from stem to stem inside a beam.")
82 (before-line-breaking ,boolean? "Dummy property, used to trigger
83 a callback function.")
84 (between-cols ,pair? "Where to attach a loose column to.")
85 (bound-padding ,number? "The amount of padding to insert around
87 (bound-details ,list? "An alist of properties for determining
88 attachments of spanners to edges.")
89 (bracket-flare ,number-pair? "A pair of numbers specifying how
90 much edges of brackets should slant outward. Value @code{0.0} means
92 (bracket-visibility ,boolean-or-symbol? "This controls the
93 visibility of the tuplet bracket. Setting it to false prevents
94 printing of the bracket. Setting the property to @code{if-no-beam}
95 makes it print only if there is no beam associated with this tuplet
97 (break-align-anchor ,number? "Grobs aligned to this break-align
98 grob will have their X-offsets shifted by this number. In bar lines,
99 for example, this is used to position grobs relative to the (visual)
100 center of the bar line.")
101 (break-align-anchor-alignment ,number? "Read by
102 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for aligning
103 an anchor to a grob's extent")
104 (break-align-symbol ,symbol? "This key is used for aligning and
105 spacing breakable items.")
106 (break-align-symbols ,list? "A list of symbols that determine
107 which break-aligned grobs to align this to. If the grob selected by
108 the first symbol in the list is invisible due to break-visibility,
109 we will align to the next grob (and so on).")
110 (break-align-orders ,vector? "Defines the order in which
111 prefatory matter (clefs, key signatures) appears. The format is a
112 vector of length@tie{}3, where each element is one order for
113 end-of-line, middle of line, and start-of-line, respectively. An
114 order is a list of symbols.
116 For example, clefs are put after key signatures by setting
119 \\override Score.BreakAlignment #'break-align-orders =
120 #(make-vector 3 '(span-bar
127 (break-overshoot ,number-pair? "How much does a broken spanner
128 stick out of its bounds?")
129 (break-visibility ,vector? "A vector of 3@tie{}booleans,
130 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
131 @code{#t} means visible, @code{#f} means killed.")
132 (breakable ,boolean? "Allow breaks here.")
134 (c0-position ,integer? "An integer indicating the position of
136 (clip-edges ,boolean? "Allow outward pointing beamlets at the
138 (collapse-height ,ly:dimension? "Minimum height of system start
139 delimiter. If equal or smaller, the bracket/brace/line is removed.")
140 (color ,color? "The color of this grob.")
141 (common-shortest-duration ,ly:moment? "The most common shortest
142 note length. This is used in spacing. Enlarging this sets the score
144 (concaveness ,number? "A beam is concave if its inner stems are
145 closer to the beam than the two outside stems. This number is a
146 measure of the closeness of the inner stems. It is used for damping
147 the slope of the beam.")
148 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
149 this grob looks as a continued break.")
150 (control-points ,list? "List of offsets (number pairs) that form
151 control points for the tie, slur, or bracket shape. For B@'eziers,
152 this should list the control points of a third-order B@'ezier curve.")
154 (damping ,number? "Amount of beam slope damping.")
155 (dash-fraction ,number? "Size of the dashes, relative to
156 @code{dash-period}. Should be between @code{0.0} (no line) and
157 @code{1.0} (continuous line).")
158 (dash-period ,number? "The length of one dash together with
159 whitespace. If negative, no line is drawn at all.")
160 (default-direction ,ly:dir? "Direction determined by note head
162 (digit-names ,vector "Names for string finger digits.")
163 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
164 @code{#X}), then this property determines whether the object is placed
165 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
166 other object. Otherwise, it determines whether the object is placed
167 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also
168 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
169 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1}, @code{#CENTER}=@code{0}.")
170 (dot-count ,integer? "The number of dots.")
171 (dot-placement-list ,list? "List
172 consisting of @code{(@var{description} @var{string-number}
173 @var{fret-number} @var{finger-number})}
174 entries used to define fret diagrams.")
175 (duration-log ,integer? "The 2-log of the note head duration,
176 i.e., @code{0} = whole note, @code{1} = half note, etc.")
178 (eccentricity ,number? "How asymmetrical to make a slur.
179 Positive means move the center to the right.")
180 (edge-height ,pair? "A pair of numbers specifying the heights of
181 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
182 (edge-text ,pair? "A pair specifying the texts to be set at the
183 edges: @code{(@var{left-text} . @var{right-text})}.")
184 (expand-limit ,integer? "Maximum number of measures expanded in
186 (extra-X-extent ,number-pair? "A grob is enlarged in
187 X@tie{}dimension by this much.")
188 (extra-Y-extent ,number-pair? "A grob is enlarged in
189 Y@tie{}dimension by this much.")
191 (extra-dy ,number? "Slope glissandi this much extra.")
192 (extra-offset ,number-pair? "A pair representing an offset. This
193 offset is added just before outputting the symbol, so the typesetting
194 engine is completely oblivious to it. The values are measured in
195 @code{staff-space} units of the staff's @code{StaffSymbol}.")
196 (extra-spacing-height ,number-pair? "In the horizontal spacing
197 problem, we increase the height of each item by this amount (by adding
198 the @q{car} to the bottom of the item and adding the @q{cdr} to the top
199 of the item. In order to make a grob infinitely high (to prevent the
200 horizontal spacing problem from placing any other grobs above or below
201 this grob), set this to @code{(-inf.0 . +inf.0)}.")
202 (extra-spacing-width ,number-pair? "In the horizontal spacing
203 problem, we pad each item by this amount (by adding the @q{car} on the
204 left side of the item and adding the @q{cdr} on the right side of the
205 item). In order to make a grob take up no horizontal space at all,
206 set this to @code{(+inf.0 . -inf.0)}.")
207 (flag-count ,number? "The number of tremolo beams.")
208 (flag-style ,symbol? "A string determining what style of flag
209 glyph is typeset on a @code{Stem}. Valid options include @code{()}
210 and @code{mensural}. Additionally, @code{no-flag} switches off the
212 (font-encoding ,symbol? "The font encoding is the broadest
213 category for selecting a font. Options include: @code{fetaMusic},
214 @code{fetaNumber}, @code{TeX-text}, @code{TeX-math},
215 @code{fetaBraces}, @code{fetaDynamic}.")
216 (font-family ,symbol? "The font family is the broadest category
217 for selecting text fonts. Options include: @code{sans},
219 (font-name ,string? "Specifies a file name (without extension)
220 of the font to load. This setting overrides selection using
221 @code{font-family}, @code{font-series} and @code{font-shape}.")
222 (font-series ,symbol? "Select the series of a font. Choices
223 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
224 (font-shape ,symbol? "Select the shape of a font. Choices
225 include @code{upright}, @code{italic}, @code{caps}.")
226 (font-size ,number? "The font size, compared to the
227 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
228 @code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
229 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2 larger.
230 Fractional values are allowed.")
231 (force-hshift ,number? "This specifies a manual shift for notes
232 in collisions. The unit is the note head width of the first voice
233 note. This is used by @rinternals{note-collision-interface}.")
234 (forced ,boolean? "Manually forced accidental.")
235 (fraction ,number-pair? "Numerator and denominator of a time
237 (french-beaming ,boolean? "Use French beaming style for this
238 stem. The stem stops at the innermost beams.")
240 (fret-diagram-details ,list? "An alist of detailed grob properties
241 for fret diagrams. Each alist entry consists of a
242 (@code{property} . @code{value}) pair.
243 The properties which can be included in fret-diagram-details
244 include the following:
247 @code{barre-type} -- Type of barre indication used.
248 Choices include @code{curved}, @code{straight}, and
249 @code{none}. Default @code{curved}.
251 @code{dot-color} -- Color of dots. Options include
252 @code{black} and @code{white}. Default @code{black}.
254 @code{dot-label-font-mag} -- Magnification for font used to
255 label fret dots. Default value 1.
257 @code{dot-radius} -- Radius of dots, in terms of fret spaces.
258 Default value 0.425 for labeled dots, 0.25 for unlabeled dots.
260 @code{finger-code} -- Code for the type of fingering indication used.
261 Options include @code{none}, @code{in-dot}, and
262 @code{below-string}. Default @code{none} for markup fret diagrams,
263 @code{below-string} for @code{FretBoards} fret diagrams.
265 @code{fret-count} -- The number of frets. Default 4.
267 @code{fret-label-font-mag} -- The magnification of the font used to label
268 the lowest fret number. Default 0.5
270 @code{fret-label-vertical-offset} -- The vertical offset of the fret label
271 from the fret. Default -0.2
273 @code{label-dir} -- Side to which the fret label is attached.
274 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down;
275 @code{1}, @code{#RIGHT}, or @code{#UP} for right or up.
276 Default @code{#RIGHT}.
278 @code{mute-string} -- Character string to be used to indicate muted
279 string. Default \"x\".
281 @code{number-type} -- Type of numbers to use in fret label. Choices
282 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}. Default
285 @code{open-string} -- Character string to be used to indicate open
286 string. Default \"o\".
288 @code{orientation} -- Orientation of fret-diagram. Options include
289 @code{normal} and @code{landscape}. Default @code{normal}.
291 @code{string-count} -- The number of strings. Default 6.
293 @code{string-label-font-mag} -- The magnification of the font used to label
294 fingerings at the string, rather than in the dot. Default value 0.6.
296 @code{top-fret-thickness} -- The thickness of the top fret line, as a multiple
297 of the standard thickness. Default value 3.
299 @code{xo-font-magnification} -- Magnification used for mute and
300 open string indicators. Default value 0.5.
302 @code{xo-padding} -- Padding for open and mute indicators from top fret.
307 ;; ugh: double, change.
308 (full-length-padding ,number? "How much padding to use at the right side of a full-length tuplet bracket.")
309 (full-length-to-extent ,boolean? "Run to the extent of the column for a full-length tuplet bracket.")
311 (full-size-change ,boolean? "Don't make a change clef smaller.")
313 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
314 (gap-count ,integer? "Number of gapped beams for tremolo.")
315 (glyph ,string? "A string determining what @q{style} of glyph is
316 typeset. Valid choices depend on the function that is reading this
318 (glyph-name-alist ,list? "An alist of key-string pairs.")
319 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
321 (hair-thickness ,number? "Thickness of the thin line in a bar
323 (harp-pedal-details ,list? "An alist of detailed grob properties
324 for harp pedal diagrams. Each alist entry consists of a
325 (@code{property} . @code{value}) pair.
326 The properties which can be included in harp-pedal-details
327 include the following:
330 @code{box-offset} -- Vertical shift of the center of flat / sharp pedal
331 boxes above / below the horizontal line. Default value 0.8.
333 @code{box-width} -- Width of each pedal box. Default value 0.4.
335 @code{box-height} -- Height of each pedal box. Default value 1.0.
337 @code{space-before-divider} -- Space between boxes before the first divider
338 (so that the diagram can be made symmetric). Default value 0.8.
340 @code{space-after-divider} -- Space between boxes after the first divider.
344 (head-direction ,ly:dir? "Are the note heads left or right in a
346 (height ,ly:dimension? "Height of an object in
347 @code{staff-space} units.")
348 (height-limit ,ly:dimension? "Maximum slur height: The longer the
349 slur, the closer it is to this height.")
350 (horizontal-shift ,integer? "An integer that identifies ranking
351 of @code{NoteColumn}s for horizontal shifting. This is used by
352 @rinternals{note-collision-interface}.")
353 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
354 left and one to the right of this grob.")
356 (ignore-collision ,boolean? "If set, don't do note collision
357 resolution on this @code{NoteColumn}.")
358 (implicit ,boolean? "Is this an implicit bass figure?")
359 (inspect-index ,integer? "If debugging is set, set beam and slur
360 configuration to this index, and print the respective scores.")
361 (inspect-quants ,number-pair? "If debugging is set,
362 set beam and slur quants to this position, and print the respective
365 (keep-fixed-while-stretching ,boolean? "A grob with this property
366 set to true is fixed relative to the staff above it when systems are
368 (keep-inside-line ,boolean? "If set, this column cannot have
369 objects sticking into the margin.")
370 (kern ,ly:dimension? "Amount of extra white space to add. For
371 bar lines, this is the amount of space after a thick line.")
372 (knee ,boolean? "Is this beam kneed?")
373 (knee-spacing-correction ,number? "Factor for the optical
374 correction amount for kneed beams. Set between @code{0} for no
375 correction and @code{1} for full correction.")
377 (labels ,list? "List of labels (symbols) placed on a column")
378 (layer ,integer? "The output layer (a value between 0 and@tie{}2:
379 Layers define the order of printing objects. Objects in lower layers
380 are overprinted by objects in higher layers.")
381 (ledger-line-thickness ,number-pair? "The thickness of ledger
382 lines. It is the sum of 2@tie{}numbers: The first is the factor for
383 line thickness, and the second for staff space. Both contributions
385 (left-bound-info ,list? "An alist of properties for determining
386 attachments of spanners to edges.")
387 (left-padding ,ly:dimension? "The amount of space that is put
388 left to an object (e.g., a group of accidentals).")
389 (length ,ly:dimension? "User override for the stem length of
391 (length-fraction ,number? "Multiplier for lengths. Used for
392 determining ledger lines and stem lengths.")
393 (line-break-penalty ,number? "Penalty for a line break at this
394 column. This affects the choices of the line breaker; it avoids a
395 line break at a column with a positive penalty and prefers a line break
396 at a column with a negative penalty.")
397 (line-break-permission ,symbol? "Instructs the line breaker on
398 whether to put a line break at this column. Can be @code{force} or
400 (line-break-system-details ,list? "An alist of properties to use
401 if this column is the start of a system.")
402 (line-count ,integer? "The number of staff lines.")
403 (line-positions ,list? "Vertical positions of staff lines.")
404 (line-thickness ,number? "The thickness of the tie or slur
406 (long-text ,markup? "Text markup. See @ruser{Formatting
409 (max-beam-connect ,integer? "Maximum number of beams to connect
410 to beams from this stem. Further beams are typeset as beamlets.")
411 (max-stretch ,number? "The maximum amount that this
412 @code{VerticalAxisGroup} can be vertically stretched (for example, in
413 order to better fill a page).")
414 (measure-count ,integer? "The number of measures for a
415 multi-measure rest.")
416 (measure-length ,ly:moment? "Length of a measure. Used in some
417 spacing situations.")
418 (merge-differently-dotted ,boolean? "Merge note heads in
419 collisions, even if they have a different number of dots. This is
420 normal notation for some types of polyphonic music.
422 @code{merge-differently-dotted} only applies to opposing stem
423 directions (i.e., voice 1 &@tie{}2).")
424 (merge-differently-headed ,boolean? "Merge note heads in
425 collisions, even if they have different note heads. The
426 smaller of the two heads is rendered invisible. This is used in
427 polyphonic guitar notation. The value of this setting is used by
428 @rinternals{note-collision-interface}.
430 @code{merge-differently-headed} only applies to opposing stem
431 directions (i.e., voice 1 &@tie{}2).")
432 (minimum-X-extent ,number-pair? "Minimum size of an object in
433 X@tie{}dimension, measured in @code{staff-space} units.")
434 (minimum-Y-extent ,number-pair? "Minimum size of an object in
435 Y@tie{}dimension, measured in @code{staff-space} units.")
436 (minimum-distance ,ly:dimension? "Minimum distance between rest
438 (minimum-length ,ly:dimension? "Try to make a spanner at least
439 this long, normally in the horizontal direction. This requires an
440 appropriate callback for the @code{springs-and-rods} property. If
441 added to a @code{Tie}, this sets the minimum distance between
443 (minimum-length-fraction ,number? "Minimum length of ledger line
444 as fraction of note head size.")
445 (minimum-space ,ly:dimension? "Minimum distance that the victim
446 should move (after padding).")
448 (neutral-direction ,ly:dir? "Which direction to take in the
449 center of the staff.")
450 (neutral-position ,number? "Position (in half staff spaces) where
451 to flip the direction of custos stem.")
452 (next ,ly:grob? "Object that is next relation (e.g., the lyric
453 syllable following an extender.")
454 (no-alignment ,boolean? "If set, don't place this grob in a
455 @code{VerticalAlignment}; rather, place it using its own @code{Y-offset}
457 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
459 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
460 get stems extending to the middle staff line.")
461 (non-default ,boolean? "Set for manually specified clefs.")
462 (non-musical ,boolean? "True if the grob belongs to a
463 @code{NonMusicalPaperColumn}.")
464 (note-names ,vector? "Vector of strings containing names for
465 easy-notation note heads.")
467 (outside-staff-horizontal-padding ,number? "By default, an
468 outside-staff-object can be placed so that is it very close to another
469 grob horizontally. If this property is set, the outside-staff-object
470 is raised so that it is not so close to its neighbor.")
471 (outside-staff-padding ,number? "The padding to place between
472 this grob and the staff when spacing according to
473 @code{outside-staff-priority}.")
474 (outside-staff-priority ,number? "If set, the grob is positioned
475 outside the staff in such a way as to avoid all collisions.
476 In case of a potential collision, the grob with the smaller
477 @code{outside-staff-priority} is closer to the staff.")
479 (packed-spacing ,boolean? "If set, the notes are spaced as
480 tightly as possible.")
481 (padding ,ly:dimension? "Add this much extra space between
482 objects that are next to each other.")
483 (page-break-penalty ,number? "Penalty for page break at this
484 column. This affects the choices of the page breaker; it avoids a
485 page break at a column with a positive penalty and prefers a page break
486 at a column with a negative penalty.")
487 (page-break-permission ,symbol? "Instructs the page breaker on
488 whether to put a page break at this column. Can be @code{force} or
490 (page-turn-penalty ,number? "Penalty for a page turn at this
491 column. This affects the choices of the page breaker; it avoids a
492 page turn at a column with a positive penalty and prefers a page turn
493 at a column with a negative penalty.")
494 (page-turn-permission ,symbol? "Instructs the page breaker on
495 whether to put a page turn at this column. Can be @code{force} or
497 (parenthesized ,boolean? "Parenthesize this grob.")
498 (positions ,number-pair? "Pair of staff coordinates
499 @code{(@var{left} . @var{right})}, where both @var{left} and
500 @var{right} are in @code{staff-space} units of the current staff.
501 For slurs, this value selects which slur candidate to use; if
502 extreme positions are requested, the closest one is taken.")
503 (prefer-dotted-right ,boolean? "For note collisions, prefer to
504 shift dotted up-note to the right, rather than shifting just the
507 (ratio ,number? "Parameter for slur shape. The higher this
508 number, the quicker the slur attains its @code{height-limit}.")
509 (remove-empty ,boolean? "If set, remove group if it contains no
511 (remove-first ,boolean? "Remove the first staff of a orchestral
513 (restore-first ,boolean? "Print a natural before the
515 (rhythmic-location ,rhythmic-location? "Where (bar number,
516 measure position) in the score.")
517 (right-bound-info ,list? "An alist of properties for determining
518 attachments of spanners to edges.")
519 (right-padding ,ly:dimension? "Space to insert on the right side
520 of an object (e.g., between note and its accidentals).")
521 (rotation ,list? "Number of degrees to rotate this object, and
522 what point to rotate around. For example, @code{#'(45 0 0)} rotates
523 by 45 degrees around the center of this object.")
525 (same-direction-correction ,number? "Optical correction amount
526 for stems that are placed in tight configurations. This amount is
527 used for stems with the same direction to compensate for note head to
529 (script-priority ,number? "A sorting key that determines in what
530 order a script is within a stack of scripts.")
531 (self-alignment-X ,number? "Specify alignment of an object. The
532 value @code{-1} means left aligned, @code{0}@tie{}centered, and
533 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
534 values may also be specified.")
535 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
537 (shorten-pair ,number-pair? "The lengths to shorten a
538 text-spanner on both sides, for example a pedal bracket. Positive
539 values shorten the text-spanner, while negative values lengthen it.")
540 (shortest-duration-space ,ly:dimension? "Start with this much
541 space for the shortest duration. This is expressed in
542 @code{spacing-increment} as unit. See also
543 @rinternals{spacing-spanner-interface}.")
544 (shortest-playing-duration ,ly:moment? "The duration of the
545 shortest note playing here.")
546 (shortest-starter-duration ,ly:moment? "The duration of the
547 shortest note that starts here.")
548 (side-axis ,number? "If the value is @code{#X} (or
549 equivalently@tie{}@code{0}), the object is placed horizontally next
550 to the other object. If the value is @code{#Y} or@tie{}@code{1}, it
551 is placed vertically.")
552 (side-relative-direction ,ly:dir? "Multiply direction of
553 @code{direction-source} with this to get the direction of this
555 (size ,number? "Size of object, relative to standard size.")
556 (slope ,number? "The slope of this object.")
557 (slur-padding ,number? "Extra distance between slur and script.")
558 (space-alist ,list? "A table that specifies distances between
559 prefatory items, like clef and time-signature. The format is an alist
560 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
561 . @var{distance})}, where @var{type} can be the symbols
562 @code{minimum-space} or @code{extra-space}.")
563 (space-to-barline ,boolean? "If set, the distance between a note
564 and the following non-musical column will be measured to the bar line
565 instead of to the beginning of the non-musical column. If there is a
566 clef change followed by a bar line, for example, this means that we will
567 try to space the non-musical column as though the clef is not there.")
568 (spacing-increment ,number? "Add this much space for a doubled
569 duration. Typically, the width of a note head. See also
570 @rinternals{spacing-spanner-interface}.")
571 (springs-and-rods ,boolean? "Dummy variable for triggering
573 (stacking-dir ,ly:dir? "Stack objects in which direction?")
574 (staff-padding ,ly:dimension? "Maintain this much space between
575 reference points and the staff. Its effect is to align objects of
576 differing sizes (like the dynamics @b{p} and @b{f}) on their
578 (staff-position ,number? "Vertical position, measured in half
579 staff spaces, counted from the middle line.")
580 (staff-space ,ly:dimension? "Amount of space between staff lines,
581 expressed in global @code{staff-space}.")
582 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})} pair
583 where the stem attaches to the notehead.")
584 (stem-end-position ,number? "Where does the stem end (the end is
585 opposite to the support-head)?")
587 (stem-spacing-correction ,number? "Optical correction amount for
588 stems that are placed in tight configurations. For opposite
589 directions, this amount is the correction for two normal sized stems
590 that overlap completely.")
591 (stemlet-length ,number? "How long should a stem over a rest
593 (stencil ,ly:stencil? "The symbol to print.")
594 (stencils ,list? "Multiple stencils, used as intermediate
596 (strict-grace-spacing ,boolean? "If set, grace notes
597 are not spaced separately, but put before musical columns.")
598 (strict-note-spacing ,boolean? "If set, unbroken columns
599 with non-musical material (clefs, bar lines, etc.) are not spaced
600 separately, but put before musical columns.")
601 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
603 (style ,symbol? "This setting determines in what style a grob is
604 typeset. Valid choices depend on the @code{stencil} callback reading
607 (text ,markup? "Text markup. See @ruser{Formatting text}.")
608 ;;FIXME -- Should both be the same?
609 (text-direction ,ly:dir? "This controls the ordering of the
610 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
611 should use @code{LEFT}.")
612 (thick-thickness ,number? "Bar line thickness, measured in
613 @code{line-thickness}.")
614 (thickness ,number? "Line thickness, generally measured in
615 @code{line-thickness}.")
616 (thin-kern ,number? "The space after a hair-line in a bar line.")
617 (threshold ,number-pair? "@code{(@var{min} . @var{max})}, where
618 @var{min} and @var{max} are dimensions in staff space.")
619 (to-barline ,boolean? "If true, the spanner will stop at the bar line
620 just before it would otherwise stop.")
621 (tie-configuration ,list? "List of @code{(@var{position} .
622 @var{dir})} pairs, indicating the desired tie configuration, where
623 @var{position} is the offset from the center of the staff in staff
624 space and @var{dir} indicates the direction of the tie
625 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
626 in the list causes the corresponding tie to be formatted
628 (transparent ,boolean? "This makes the grob invisible.")
630 (uniform-stretching ,boolean? "If set, items stretch
631 proportionally to their durations. This looks better in complex
632 polyphonic patterns.")
633 (used ,boolean? "If set, this spacing column is kept in the
636 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
637 one below this grob.")
639 (when ,ly:moment? "Global time step associated with this column
641 (width ,ly:dimension? "The width of a grob measured in staff
643 (word-space ,ly:dimension? "Space to insert between words in
646 (zigzag-length ,ly:dimension? "The length of the lines of a
647 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
648 gives 60-degree zigzags.")
649 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
650 This number is adjusted slightly so that the glissando line can
651 be constructed from a whole number of squiggles.")
659 (define (define-internal-grob-property symbol type? description)
660 (define-grob-property symbol type? description)
661 (set-object-property! symbol 'backend-internal #t)
666 (define-public all-internal-grob-properties
669 (apply define-internal-grob-property x))
673 ;; grobs & grob arrays. (alphabetical)
674 (X-common ,ly:grob? "Common reference point for axis group.")
676 (Y-common ,ly:grob? "See @code{X-common}.")
678 (accidental-grob ,ly:grob? "The accidental for this note.")
679 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
680 @var{groblist})} entries.")
681 (adjacent-pure-heights ,vector? "Used by a @code{VerticalAxisGroup} to
682 cache the @code{Y-extent}s of different column ranges.")
683 (adjacent-hairpins ,ly:grob-array? "A list of directly neighboring
685 (all-elements ,ly:grob-array? "A list of all grobs in this line. Its
686 function is to protect objects from being garbage collected.")
687 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
688 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
689 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
691 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
692 This may differ from @code{Y-extent} because it does not include the dots in
694 (bars ,ly:grob-array? "A list of bar line pointers.")
695 (beam ,ly:grob? "A pointer to the beam, if applicable.")
696 (bounded-by-me ,ly:grob-array? "A list of spanners that have this
697 column as start/begin point. Only columns that have grobs or act as
699 (bracket ,ly:grob? "The bracket for a number.")
701 (columns ,ly:grob-array? "A list of grobs, typically containing
702 @code{PaperColumn} or @code{NoteColumn} objects.")
703 (conditional-elements ,ly:grob-array? "Internal use only.")
704 (cross-staff ,boolean? "For a beam or a stem, this is true if we
705 depend on inter-staff spacing.")
707 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
708 set, which grob to get the direction from.")
709 (dot ,ly:grob? "A reference to a @code{Dots} object.")
710 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
712 (elements ,ly:grob-array? "A list of grobs; the type is depending on
713 the grob where this is set in.")
714 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
715 in addition to notes and stems.")
717 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
719 (glyph-name ,string? "The glyph name within the font.")
720 (grace-spacing ,ly:grob? "A run of grace notes.")
722 (heads ,ly:grob-array? "A list of note heads.")
724 (important-column-ranks ,vector? "A cache of columns that contain
725 @code{items-worth-living} data.")
726 (items-worth-living ,ly:grob-array? "A list of interesting items. If
727 empty in a particular staff, then that staff is erased.")
729 (left-items ,ly:grob-array? "DOCME")
730 (left-neighbors ,ly:grob-array? "A list of @code{spacing-wishes} grobs
731 that are close to the current column.
733 The closest @code{spacing-wishes} determine the actual distances between the
736 (normal-stems ,ly:grob-array? "An array of visible stems.")
737 (note-columns ,pair? "A list of @code{NoteColumn} grobs.")
738 (note-head ,ly:grob? "A single note head.")
739 (note-heads ,ly:grob-array? "A list of note head grobs.")
741 (padding-pairs ,list? "An alist mapping @code{(@var{name} . @var{name})}
743 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
745 (pure-Y-common ,ly:grob? "A cache of the
746 @code{common_refpoint_of_array} of the @code{elements} grob set.")
747 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
748 cyclic dependencies.")
749 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
750 relevant for finding the @code{pure-Y-extent}.")
751 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
752 relevant for finding the @code{pure-Y-extent}.")
754 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
755 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
756 (rests ,ly:grob-array? "A list of rest objects.")
757 (right-items ,ly:grob-array? "DOCME")
758 (right-neighbors ,ly:grob-array? "See @code{left-neighbors}.")
760 (separation-item ,ly:grob? "A separation item.")
761 (side-support-elements ,ly:grob-array? "The side support, a list of
763 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
764 (spaceable-staves ,ly:grob-array? "Objects to be spaced during page
766 (spacing ,ly:grob? "The spacing spanner governing this section.")
767 (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing
769 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
770 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
771 (stems ,ly:grob-array? "A list of stem objects, corresponding to the
772 notes that the arpeggio has to be before.")
774 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
775 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
776 (tuplet-number ,ly:grob? "The number for a bracket.")
777 (tuplets ,ly:grob-array? "A list of smaller tuplet brackets.")
781 (begin-of-line-visible ,boolean? "Used for marking @code{ChordNames}
782 that should only show changes.")
784 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
785 translator) that was the cause for this grob.")
786 (circled-tip ,boolean? "Put a circle at start/end of hairpins (al/del
789 (delta-position ,number? "The vertical position difference.")
790 (details ,list? "Alist of parameters for detailed grob behavior.
792 More information on the allowed parameters can be found by inspecting
793 @file{lily/slur-scoring.cc}, @file{lily/beam-quanting.cc}, and
794 @file{lily/tie-formatting-problem.cc}. Setting @code{debug-tie-scoring},
795 @code{debug-beam-scoring} or @code{debug-slur-scoring} also provides
798 (font ,ly:font-metric? "A cached font metric object.")
800 (head-width ,ly:dimension? "The width of this ligature head.")
802 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
803 @var{strength}))} pairs.")
804 (interfaces ,list? "A list of symbols indicating the interfaces
805 supported by this object. It is initialized from the @code{meta} field.")
807 (least-squares-dy ,number? "The ideal beam slope, without damping.")
809 (meta ,list? "Provide meta information. It is an alist with the
810 entries @code{name} and @code{interfaces}.")
811 (minimum-distances ,list? "A list of rods that have the format
812 @code{(@var{obj} . @var{dist})}.")
814 (positioning-done ,boolean? "Used to signal that a positioning element
815 did its job. This ensures that a positioning is only done once.")
816 (pure-Y-extent ,number-pair? "The estimated height of a system.")
818 (quant-score ,string? "The beam quanting score; stored for
820 (quantize-position ,boolean? "If set, a vertical alignment is aligned
821 to be within staff spaces.")
822 (quantized-positions ,number-pair? "The beam positions after
825 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
826 acts as an index for looking up a @code{Stencil} object.")
827 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
828 Internally used to distribute beam shortening over stems.")
829 (skyline-distance ,number? "The distance between this staff and the
830 next one, as determined by a skyline algorithm.")
831 (skyline-horizontal-padding ,number? "For determining the vertical
832 distance between two staves, it is possible to have a configuration which
833 would result in a tight interleaving of grobs from the top staff and the
834 bottom staff. The larger this parameter is, the farther apart the staves
835 are placed in such a configuration.")
836 (stem-info ,pair? "A cache of stem parameters.")
838 (use-breve-rest ,boolean? "Use breve rests for measures longer
845 ;; There are too many properties for ancient notation;
846 ;; probably neume-types (a list of symbols) would also work.
848 ;; However, such a list would consist of a couple of dozens of
849 ;; entries, since head prefixes may be combined in many ways. If
850 ;; the macros in `gregorian-init.ly' would directly set prefix-set,
851 ;; all the head prefixes could be junked; however, such macros
852 ;; would be quite numerous, I guess. --jr
854 (add-cauda ,boolean? "Does this flexa require an additional cauda on
856 (add-join ,boolean? "Is this ligature head-joined with the next one
857 by a vertical line?")
858 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
859 an additional stem on the right side?")
860 (ascendens ,boolean? "Is this neume of ascending type?")
861 (auctum ,boolean? "Is this neume liquescentically augmented?")
863 (cavum ,boolean? "Is this neume outlined?")
864 (context-info ,integer? "Within a ligature, the final glyph or shape of
865 a head may be affected by the left and/or right neighbour head.
866 @code{context-info} holds for each head such information about the left and
867 right neighbour, encoded as a bit mask.")
869 (descendens ,boolean? "Is this neume of descendent type?")
870 (deminutum ,boolean? "Is this neume deminished?")
872 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
873 grob (in @code{staff-space} units).")
874 (flexa-width ,ly:dimension? "The width of a flexa shape in a
875 ligature grob in (in @code{staff-space} units).")
877 (inclinatum ,boolean? "Is this neume an inclinatum?")
879 (join-heads ,boolean? "Whether to join the note heads of an ambitus
880 grob with a vertical line.")
881 (join-right-amount ,number? "DOCME")
883 (linea ,boolean? "Attach vertical lines to this neume?")
885 (oriscus ,boolean? "Is this neume an oriscus?")
887 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
889 (prefix-set ,number? "A bit mask that holds all Gregorian head
890 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
891 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
892 similar to a note head that is part of a ligature.")
894 (quilisma ,boolean? "Is this neume a quilisma?")
896 (stropha ,boolean? "Is this neume a stropha?")
898 (virga ,boolean? "Is this neume a virga?")
900 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
904 (define-public all-backend-properties
906 all-internal-grob-properties
907 all-user-grob-properties))