1 ;;;; define-grob-properties.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2008 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 (circled-tip ,boolean? "Put a circle at start/end of hairpins (al/del
138 (clip-edges ,boolean? "Allow outward pointing beamlets at the
140 (collapse-height ,ly:dimension? "Minimum height of system start
141 delimiter. If equal or smaller, the bracket/brace/line is removed.")
142 (color ,color? "The color of this grob.")
143 (common-shortest-duration ,ly:moment? "The most common shortest
144 note length. This is used in spacing. Enlarging this sets the score
146 (concaveness ,number? "A beam is concave if its inner stems are
147 closer to the beam than the two outside stems. This number is a
148 measure of the closeness of the inner stems. It is used for damping
149 the slope of the beam.")
150 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
151 this grob looks as a continued break.")
152 (control-points ,list? "List of offsets (number pairs) that form
153 control points for the tie, slur, or bracket shape. For B@'eziers,
154 this should list the control points of a third-order B@'ezier curve.")
156 (damping ,number? "Amount of beam slope damping.")
157 (dash-fraction ,number? "Size of the dashes, relative to
158 @code{dash-period}. Should be between @code{0.0} (no line) and
159 @code{1.0} (continuous line).")
160 (dash-period ,number? "The length of one dash together with
161 whitespace. If negative, no line is drawn at all.")
162 (default-direction ,ly:dir? "Direction determined by note head
164 (digit-names ,vector "Names for string finger digits.")
165 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
166 @code{#X}), then this property determines whether the object is placed
167 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
168 other object. Otherwise, it determines whether the object is placed
169 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also
170 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
171 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1}, @code{#CENTER}=@code{0}.")
172 (dot-count ,integer? "The number of dots.")
173 (dot-negative-kern ,number? "The space to remove between a dot
174 and a slash in percent repeat glyphs. Larger values bring the two
175 elements closer together.")
176 (dot-placement-list ,list? "List
177 consisting of @code{(@var{description} @var{string-number}
178 @var{fret-number} @var{finger-number})}
179 entries used to define fret diagrams.")
180 (duration-log ,integer? "The 2-log of the note head duration,
181 i.e., @code{0} = whole note, @code{1} = half note, etc.")
183 (eccentricity ,number? "How asymmetrical to make a slur.
184 Positive means move the center to the right.")
185 (edge-height ,pair? "A pair of numbers specifying the heights of
186 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
187 (edge-text ,pair? "A pair specifying the texts to be set at the
188 edges: @code{(@var{left-text} . @var{right-text})}.")
189 (expand-limit ,integer? "Maximum number of measures expanded in
191 (extra-X-extent ,number-pair? "A grob is enlarged in
192 X@tie{}dimension by this much.")
193 (extra-Y-extent ,number-pair? "A grob is enlarged in
194 Y@tie{}dimension by this much.")
196 (extra-dy ,number? "Slope glissandi this much extra.")
197 (extra-offset ,number-pair? "A pair representing an offset. This
198 offset is added just before outputting the symbol, so the typesetting
199 engine is completely oblivious to it. The values are measured in
200 @code{staff-space} units of the staff's @code{StaffSymbol}.")
201 (extra-spacing-height ,number-pair? "In the horizontal spacing
202 problem, we increase the height of each item by this amount (by adding
203 the @q{car} to the bottom of the item and adding the @q{cdr} to the top
204 of the item. In order to make a grob infinitely high (to prevent the
205 horizontal spacing problem from placing any other grobs above or below
206 this grob), set this to @code{(-inf.0 . +inf.0)}.")
207 (extra-spacing-width ,number-pair? "In the horizontal spacing
208 problem, we pad each item by this amount (by adding the @q{car} on the
209 left side of the item and adding the @q{cdr} on the right side of the
210 item). In order to make a grob take up no horizontal space at all,
211 set this to @code{(+inf.0 . -inf.0)}.")
212 (flag ,ly:stencil? "A function returning the full flag stencil for
213 the @code{Stem}, which is passed to the function as the only argument.
214 The default ly:stem::calc-stencil function uses the @code{flag-style}
215 property to determine the correct glyph for the
216 flag. By providing your own function, you can create arbitrary flags.")
217 (flag-count ,number? "The number of tremolo beams.")
218 (flag-style ,symbol? "A symbol determining what style of flag
219 glyph is typeset on a @code{Stem}. Valid options include @code{'()} for
220 standard flags, @code{'mensural} and @code{'no-flag}, which switches off
222 (font-encoding ,symbol? "The font encoding is the broadest
223 category for selecting a font. Currently, only lilypond's system fonts
224 (Emmentaler and Aybabtu) are using this property. Available values are
225 @code{fetaMusic} (Emmentaler), @code{fetaBraces} (Aybabtu),
226 @code{fetaNumber} (Emmentaler), and @code{fetaDynamic} (Emmentaler).")
227 (font-family ,symbol? "The font family is the broadest category
228 for selecting text fonts. Options include: @code{sans},
230 (font-name ,string? "Specifies a file name (without extension)
231 of the font to load. This setting overrides selection using
232 @code{font-family}, @code{font-series} and @code{font-shape}.")
233 (font-series ,symbol? "Select the series of a font. Choices
234 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
235 (font-shape ,symbol? "Select the shape of a font. Choices
236 include @code{upright}, @code{italic}, @code{caps}.")
237 (font-size ,number? "The font size, compared to the
238 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
239 @code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
240 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2 larger.
241 Fractional values are allowed.")
242 (force-hshift ,number? "This specifies a manual shift for notes
243 in collisions. The unit is the note head width of the first voice
244 note. This is used by @rinternals{note-collision-interface}.")
245 (fraction ,number-pair? "Numerator and denominator of a time
247 (french-beaming ,boolean? "Use French beaming style for this
248 stem. The stem stops at the innermost beams.")
250 (fret-diagram-details ,list? "An alist of detailed grob properties
251 for fret diagrams. Each alist entry consists of a
252 (@code{property} . @code{value}) pair.
253 The properties which can be included in fret-diagram-details
254 include the following:
257 @code{barre-type} -- Type of barre indication used.
258 Choices include @code{curved}, @code{straight}, and
259 @code{none}. Default @code{curved}.
261 @code{capo-thickness} -- Thickness of capo indicator, in
262 multiples of fret-space. Default value 0.5.
264 @code{dot-color} -- Color of dots. Options include
265 @code{black} and @code{white}. Default @code{black}.
267 @code{dot-label-font-mag} -- Magnification for font used to
268 label fret dots. Default value 1.
270 @code{dot-position} -- Location of dot in fret space. Default
271 0.6 for dots without labels, 0.95-@code{dot-radius} for dots with
274 @code{dot-radius} -- Radius of dots, in terms of fret spaces.
275 Default value 0.425 for labeled dots, 0.25 for unlabeled dots.
277 @code{finger-code} -- Code for the type of fingering indication used.
278 Options include @code{none}, @code{in-dot}, and
279 @code{below-string}. Default @code{none} for markup fret diagrams,
280 @code{below-string} for @code{FretBoards} fret diagrams.
282 @code{fret-count} -- The number of frets. Default 4.
284 @code{fret-label-font-mag} -- The magnification of the font used to label
285 the lowest fret number. Default 0.5
287 @code{fret-label-vertical-offset} -- The offset of the fret label
288 from the center of the fret in direction parallel to strings. Default 0.
290 @code{label-dir} -- Side to which the fret label is attached.
291 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down;
292 @code{1}, @code{#RIGHT}, or @code{#UP} for right or up.
293 Default @code{#RIGHT}.
295 @code{mute-string} -- Character string to be used to indicate muted
296 string. Default \"x\".
298 @code{number-type} -- Type of numbers to use in fret label. Choices
299 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}. Default
302 @code{open-string} -- Character string to be used to indicate open
303 string. Default \"o\".
305 @code{orientation} -- Orientation of fret-diagram. Options include
306 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
307 Default @code{normal}.
309 @code{string-count} -- The number of strings. Default 6.
311 @code{string-label-font-mag} -- The magnification of the font used to label
312 fingerings at the string, rather than in the dot. Default value 0.6 for
313 @code{normal} orientation, 0.5 for @code{landscape} and
314 @code{opposing-landscape}.
316 @code{top-fret-thickness} -- The thickness of the top fret line, as a multiple
317 of the standard thickness. Default value 3.
319 @code{xo-font-magnification} -- Magnification used for mute and
320 open string indicators. Default value 0.5.
322 @code{xo-padding} -- Padding for open and mute indicators from top fret.
327 ;; ugh: double, change.
328 (full-length-padding ,number? "How much padding to use at the right side of a full-length tuplet bracket.")
329 (full-length-to-extent ,boolean? "Run to the extent of the column for a full-length tuplet bracket.")
331 (full-size-change ,boolean? "Don't make a change clef smaller.")
333 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
334 (gap-count ,integer? "Number of gapped beams for tremolo.")
335 (glyph ,string? "A string determining what @q{style} of glyph is
336 typeset. Valid choices depend on the function that is reading this
338 (glyph-name-alist ,list? "An alist of key-string pairs.")
339 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
341 (hair-thickness ,number? "Thickness of the thin line in a bar
343 (harp-pedal-details ,list? "An alist of detailed grob properties
344 for harp pedal diagrams. Each alist entry consists of a
345 (@code{property} . @code{value}) pair.
346 The properties which can be included in harp-pedal-details
347 include the following:
350 @code{box-offset} -- Vertical shift of the center of flat / sharp pedal
351 boxes above / below the horizontal line. Default value 0.8.
353 @code{box-width} -- Width of each pedal box. Default value 0.4.
355 @code{box-height} -- Height of each pedal box. Default value 1.0.
357 @code{space-before-divider} -- Space between boxes before the first divider
358 (so that the diagram can be made symmetric). Default value 0.8.
360 @code{space-after-divider} -- Space between boxes after the first divider.
363 @code{circle-thickness} -- Thickness (in unit of the line-thickness) of the
364 ellipse around circled pedals. Default value 0.5.
366 @code{circle-x-padding} -- Padding in X direction of the ellipse around
367 circled pedals. Default value 0.15.
369 @code{circle-y-padding} -- Padding in Y direction of the ellipse around
370 circled pedals. Default value 0.2.
373 (head-direction ,ly:dir? "Are the note heads left or right in a
375 (height ,ly:dimension? "Height of an object in
376 @code{staff-space} units.")
377 (height-limit ,ly:dimension? "Maximum slur height: The longer the
378 slur, the closer it is to this height.")
379 (horizontal-shift ,integer? "An integer that identifies ranking
380 of @code{NoteColumn}s for horizontal shifting. This is used by
381 @rinternals{note-collision-interface}.")
382 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
383 left and one to the right of this grob.")
385 (ignore-collision ,boolean? "If set, don't do note collision
386 resolution on this @code{NoteColumn}.")
387 (implicit ,boolean? "Is this an implicit bass figure?")
388 (inspect-index ,integer? "If debugging is set, set beam and slur
389 configuration to this index, and print the respective scores.")
390 (inspect-quants ,number-pair? "If debugging is set,
391 set beam and slur quants to this position, and print the respective
394 (keep-fixed-while-stretching ,boolean? "A grob with this property
395 set to true is fixed relative to the staff above it when systems are
397 (keep-inside-line ,boolean? "If set, this column cannot have
398 objects sticking into the margin.")
399 (kern ,ly:dimension? "Amount of extra white space to add. For
400 bar lines, this is the amount of space after a thick line.")
401 (knee ,boolean? "Is this beam kneed?")
402 (knee-spacing-correction ,number? "Factor for the optical
403 correction amount for kneed beams. Set between @code{0} for no
404 correction and @code{1} for full correction.")
406 (labels ,list? "List of labels (symbols) placed on a column")
407 (layer ,integer? "The output layer (a value between 0 and@tie{}2:
408 Layers define the order of printing objects. Objects in lower layers
409 are overprinted by objects in higher layers.")
410 (ledger-line-thickness ,number-pair? "The thickness of ledger
411 lines. It is the sum of 2@tie{}numbers: The first is the factor for
412 line thickness, and the second for staff space. Both contributions
414 (left-bound-info ,list? "An alist of properties for determining
415 attachments of spanners to edges.")
416 (left-padding ,ly:dimension? "The amount of space that is put
417 left to an object (e.g., a group of accidentals).")
418 (length ,ly:dimension? "User override for the stem length of
420 (length-fraction ,number? "Multiplier for lengths. Used for
421 determining ledger lines and stem lengths.")
422 (line-break-penalty ,number? "Penalty for a line break at this
423 column. This affects the choices of the line breaker; it avoids a
424 line break at a column with a positive penalty and prefers a line break
425 at a column with a negative penalty.")
426 (line-break-permission ,symbol? "Instructs the line breaker on
427 whether to put a line break at this column. Can be @code{force} or
429 (line-break-system-details ,list? "An alist of properties to use
430 if this column is the start of a system.")
431 (line-count ,integer? "The number of staff lines.")
432 (line-positions ,list? "Vertical positions of staff lines.")
433 (line-thickness ,number? "The thickness of the tie or slur
435 (long-text ,markup? "Text markup. See @ruser{Formatting
438 (max-beam-connect ,integer? "Maximum number of beams to connect
439 to beams from this stem. Further beams are typeset as beamlets.")
440 (max-stretch ,number? "The maximum amount that this
441 @code{VerticalAxisGroup} can be vertically stretched (for example, in
442 order to better fill a page).")
443 (measure-count ,integer? "The number of measures for a
444 multi-measure rest.")
445 (measure-length ,ly:moment? "Length of a measure. Used in some
446 spacing situations.")
447 (merge-differently-dotted ,boolean? "Merge note heads in
448 collisions, even if they have a different number of dots. This is
449 normal notation for some types of polyphonic music.
451 @code{merge-differently-dotted} only applies to opposing stem
452 directions (i.e., voice 1 &@tie{}2).")
453 (merge-differently-headed ,boolean? "Merge note heads in
454 collisions, even if they have different note heads. The
455 smaller of the two heads is rendered invisible. This is used in
456 polyphonic guitar notation. The value of this setting is used by
457 @rinternals{note-collision-interface}.
459 @code{merge-differently-headed} only applies to opposing stem
460 directions (i.e., voice 1 &@tie{}2).")
461 (minimum-X-extent ,number-pair? "Minimum size of an object in
462 X@tie{}dimension, measured in @code{staff-space} units.")
463 (minimum-Y-extent ,number-pair? "Minimum size of an object in
464 Y@tie{}dimension, measured in @code{staff-space} units.")
465 (minimum-distance ,ly:dimension? "Minimum distance between rest
467 (minimum-length ,ly:dimension? "Try to make a spanner at least
468 this long, normally in the horizontal direction. This requires an
469 appropriate callback for the @code{springs-and-rods} property. If
470 added to a @code{Tie}, this sets the minimum distance between
472 (minimum-length-fraction ,number? "Minimum length of ledger line
473 as fraction of note head size.")
474 (minimum-space ,ly:dimension? "Minimum distance that the victim
475 should move (after padding).")
477 (neutral-direction ,ly:dir? "Which direction to take in the
478 center of the staff.")
479 (neutral-position ,number? "Position (in half staff spaces) where
480 to flip the direction of custos stem.")
481 (next ,ly:grob? "Object that is next relation (e.g., the lyric
482 syllable following an extender.")
483 (no-alignment ,boolean? "If set, don't place this grob in a
484 @code{VerticalAlignment}; rather, place it using its own @code{Y-offset}
486 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
488 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
489 get stems extending to the middle staff line.")
490 (non-default ,boolean? "Set for manually specified clefs.")
491 (non-musical ,boolean? "True if the grob belongs to a
492 @code{NonMusicalPaperColumn}.")
493 (note-names ,vector? "Vector of strings containing names for
494 easy-notation note heads.")
496 (outside-staff-horizontal-padding ,number? "By default, an
497 outside-staff-object can be placed so that is it very close to another
498 grob horizontally. If this property is set, the outside-staff-object
499 is raised so that it is not so close to its neighbor.")
500 (outside-staff-padding ,number? "The padding to place between
501 this grob and the staff when spacing according to
502 @code{outside-staff-priority}.")
503 (outside-staff-priority ,number? "If set, the grob is positioned
504 outside the staff in such a way as to avoid all collisions.
505 In case of a potential collision, the grob with the smaller
506 @code{outside-staff-priority} is closer to the staff.")
508 (packed-spacing ,boolean? "If set, the notes are spaced as
509 tightly as possible.")
510 (padding ,ly:dimension? "Add this much extra space between
511 objects that are next to each other.")
512 (padding-pairs ,list? "An alist mapping @code{(@var{name} . @var{name})}
514 (page-break-penalty ,number? "Penalty for page break at this
515 column. This affects the choices of the page breaker; it avoids a
516 page break at a column with a positive penalty and prefers a page break
517 at a column with a negative penalty.")
518 (page-break-permission ,symbol? "Instructs the page breaker on
519 whether to put a page break at this column. Can be @code{force} or
521 (page-turn-penalty ,number? "Penalty for a page turn at this
522 column. This affects the choices of the page breaker; it avoids a
523 page turn at a column with a positive penalty and prefers a page turn
524 at a column with a negative penalty.")
525 (page-turn-permission ,symbol? "Instructs the page breaker on
526 whether to put a page turn at this column. Can be @code{force} or
528 (parenthesized ,boolean? "Parenthesize this grob.")
529 (positions ,number-pair? "Pair of staff coordinates
530 @code{(@var{left} . @var{right})}, where both @var{left} and
531 @var{right} are in @code{staff-space} units of the current staff.
532 For slurs, this value selects which slur candidate to use; if
533 extreme positions are requested, the closest one is taken.")
534 (prefer-dotted-right ,boolean? "For note collisions, prefer to
535 shift dotted up-note to the right, rather than shifting just the
538 (ratio ,number? "Parameter for slur shape. The higher this
539 number, the quicker the slur attains its @code{height-limit}.")
540 (remove-empty ,boolean? "If set, remove group if it contains no
542 (remove-first ,boolean? "Remove the first staff of an orchestral
544 (restore-first ,boolean? "Print a natural before the
546 (rhythmic-location ,rhythmic-location? "Where (bar number,
547 measure position) in the score.")
548 (right-bound-info ,list? "An alist of properties for determining
549 attachments of spanners to edges.")
550 (right-padding ,ly:dimension? "Space to insert on the right side
551 of an object (e.g., between note and its accidentals).")
552 (rotation ,list? "Number of degrees to rotate this object, and
553 what point to rotate around. For example, @code{#'(45 0 0)} rotates
554 by 45 degrees around the center of this object.")
556 (same-direction-correction ,number? "Optical correction amount
557 for stems that are placed in tight configurations. This amount is
558 used for stems with the same direction to compensate for note head to
560 (script-priority ,number? "A sorting key that determines in what
561 order a script is within a stack of scripts.")
562 (self-alignment-X ,number? "Specify alignment of an object. The
563 value @code{-1} means left aligned, @code{0}@tie{}centered, and
564 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
565 values may also be specified.")
566 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
568 (toward-stem-shift ,number? "Amount by which scripts are shifted
569 toward the stem if their direction coincides with the stem direction.
570 @code{0.0} means keep the default position (centered on the note head),
571 @code{1.0} means centered on the stem. Interpolated values are possible.")
572 (shorten-pair ,number-pair? "The lengths to shorten a
573 text-spanner on both sides, for example a pedal bracket. Positive
574 values shorten the text-spanner, while negative values lengthen it.")
575 (shortest-duration-space ,ly:dimension? "Start with this much
576 space for the shortest duration. This is expressed in
577 @code{spacing-increment} as unit. See also
578 @rinternals{spacing-spanner-interface}.")
579 (shortest-playing-duration ,ly:moment? "The duration of the
580 shortest note playing here.")
581 (shortest-starter-duration ,ly:moment? "The duration of the
582 shortest note that starts here.")
583 (side-axis ,number? "If the value is @code{#X} (or
584 equivalently@tie{}@code{0}), the object is placed horizontally next
585 to the other object. If the value is @code{#Y} or@tie{}@code{1}, it
586 is placed vertically.")
587 (side-relative-direction ,ly:dir? "Multiply direction of
588 @code{direction-source} with this to get the direction of this
590 (size ,number? "Size of object, relative to standard size.")
591 (skyline-horizontal-padding ,number? "For determining the vertical
592 distance between two staves, it is possible to have a configuration which
593 would result in a tight interleaving of grobs from the top staff and the
594 bottom staff. The larger this parameter is, the farther apart the staves
595 are placed in such a configuration.")
596 (slash-negative-kern ,number? "The space to remove between
597 slashes in percent repeat glyphs. Larger values bring the two
598 elements closer together.")
599 (slope ,number? "The slope of this object.")
600 (slur-padding ,number? "Extra distance between slur and script.")
601 (space-alist ,list? "A table that specifies distances between
602 prefatory items, like clef and time-signature. The format is an alist
603 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
604 . @var{distance})}, where @var{type} can be the symbols
605 @code{minimum-space} or @code{extra-space}.")
606 (space-to-barline ,boolean? "If set, the distance between a note
607 and the following non-musical column will be measured to the bar line
608 instead of to the beginning of the non-musical column. If there is a
609 clef change followed by a bar line, for example, this means that we will
610 try to space the non-musical column as though the clef is not there.")
611 (spacing-increment ,number? "Add this much space for a doubled
612 duration. Typically, the width of a note head. See also
613 @rinternals{spacing-spanner-interface}.")
614 (springs-and-rods ,boolean? "Dummy variable for triggering
616 (stacking-dir ,ly:dir? "Stack objects in which direction?")
617 (staff-padding ,ly:dimension? "Maintain this much space between
618 reference points and the staff. Its effect is to align objects of
619 differing sizes (like the dynamics @b{p} and @b{f}) on their
621 (staff-position ,number? "Vertical position, measured in half
622 staff spaces, counted from the middle line.")
623 (staff-space ,ly:dimension? "Amount of space between staff lines,
624 expressed in global @code{staff-space}.")
625 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})} pair
626 where the stem attaches to the notehead.")
627 (stem-end-position ,number? "Where does the stem end (the end is
628 opposite to the support-head)?")
630 (stem-spacing-correction ,number? "Optical correction amount for
631 stems that are placed in tight configurations. For opposite
632 directions, this amount is the correction for two normal sized stems
633 that overlap completely.")
634 (stemlet-length ,number? "How long should a stem over a rest
636 (stencil ,ly:stencil? "The symbol to print.")
637 (stencils ,list? "Multiple stencils, used as intermediate
639 (strict-grace-spacing ,boolean? "If set, main notes are spaced
640 normally, then grace notes are put left of the musical columns fot the main notes.")
641 (strict-note-spacing ,boolean? "If set, unbroken columns
642 with non-musical material (clefs, bar lines, etc.) are not spaced
643 separately, but put before musical columns.")
644 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
646 (style ,symbol? "This setting determines in what style a grob is
647 typeset. Valid choices depend on the @code{stencil} callback reading
650 (text ,markup? "Text markup. See @ruser{Formatting text}.")
651 ;;FIXME -- Should both be the same?
652 (text-direction ,ly:dir? "This controls the ordering of the
653 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
654 should use @code{LEFT}.")
655 (thick-thickness ,number? "Bar line thickness, measured in
656 @code{line-thickness}.")
657 (thickness ,number? "Line thickness, generally measured in
658 @code{line-thickness}.")
659 (thin-kern ,number? "The space after a hair-line in a bar line.")
660 (threshold ,number-pair? "@code{(@var{min} . @var{max})}, where
661 @var{min} and @var{max} are dimensions in staff space.")
662 (to-barline ,boolean? "If true, the spanner will stop at the bar line
663 just before it would otherwise stop.")
664 (tie-configuration ,list? "List of @code{(@var{position} .
665 @var{dir})} pairs, indicating the desired tie configuration, where
666 @var{position} is the offset from the center of the staff in staff
667 space and @var{dir} indicates the direction of the tie
668 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
669 in the list causes the corresponding tie to be formatted
671 (transparent ,boolean? "This makes the grob invisible.")
673 (uniform-stretching ,boolean? "If set, items stretch
674 proportionally to their durations. This looks better in complex
675 polyphonic patterns.")
676 (used ,boolean? "If set, this spacing column is kept in the
679 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
680 one below this grob.")
682 (when ,ly:moment? "Global time step associated with this column
684 (width ,ly:dimension? "The width of a grob measured in staff
686 (word-space ,ly:dimension? "Space to insert between words in
689 (zigzag-length ,ly:dimension? "The length of the lines of a
690 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
691 gives 60-degree zigzags.")
692 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
693 This number is adjusted slightly so that the glissando line can
694 be constructed from a whole number of squiggles.")
702 (define (define-internal-grob-property symbol type? description)
703 (define-grob-property symbol type? description)
704 (set-object-property! symbol 'backend-internal #t)
709 (define-public all-internal-grob-properties
712 (apply define-internal-grob-property x))
716 ;; grobs & grob arrays. (alphabetical)
717 (X-common ,ly:grob? "Common reference point for axis group.")
719 (Y-common ,ly:grob? "See @code{X-common}.")
721 (accidental-grob ,ly:grob? "The accidental for this note.")
722 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
723 @var{groblist})} entries.")
724 (adjacent-pure-heights ,vector? "Used by a @code{VerticalAxisGroup} to
725 cache the @code{Y-extent}s of different column ranges.")
726 (adjacent-hairpins ,ly:grob-array? "A list of directly neighboring
728 (all-elements ,ly:grob-array? "A list of all grobs in this line. Its
729 function is to protect objects from being garbage collected.")
730 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
731 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
732 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
734 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
735 This may differ from @code{Y-extent} because it does not include the dots in
737 (bars ,ly:grob-array? "A list of bar line pointers.")
738 (beam ,ly:grob? "A pointer to the beam, if applicable.")
739 (bounded-by-me ,ly:grob-array? "A list of spanners that have this
740 column as start/begin point. Only columns that have grobs or act as
742 (bracket ,ly:grob? "The bracket for a number.")
744 (columns ,ly:grob-array? "A list of grobs, typically containing
745 @code{PaperColumn} or @code{NoteColumn} objects.")
746 (conditional-elements ,ly:grob-array? "Internal use only.")
747 (cross-staff ,boolean? "For a beam or a stem, this is true if we
748 depend on inter-staff spacing.")
750 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
751 set, which grob to get the direction from.")
752 (dot ,ly:grob? "A reference to a @code{Dots} object.")
753 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
755 (elements ,ly:grob-array? "A list of grobs; the type is depending on
756 the grob where this is set in.")
757 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
758 in addition to notes and stems.")
760 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
761 (forced ,boolean? "Manually forced accidental.")
763 (glyph-name ,string? "The glyph name within the font.")
764 (grace-spacing ,ly:grob? "A run of grace notes.")
766 (heads ,ly:grob-array? "A list of note heads.")
768 (important-column-ranks ,vector? "A cache of columns that contain
769 @code{items-worth-living} data.")
770 (items-worth-living ,ly:grob-array? "A list of interesting items. If
771 empty in a particular staff, then that staff is erased.")
773 (left-items ,ly:grob-array? "DOCME")
774 (left-neighbors ,ly:grob-array? "A list of @code{spacing-wishes} grobs
775 that are close to the current column.
777 The closest @code{spacing-wishes} determine the actual distances between the
780 (normal-stems ,ly:grob-array? "An array of visible stems.")
781 (note-columns ,pair? "A list of @code{NoteColumn} grobs.")
782 (note-head ,ly:grob? "A single note head.")
783 (note-heads ,ly:grob-array? "A list of note head grobs.")
784 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
786 (pure-Y-common ,ly:grob? "A cache of the
787 @code{common_refpoint_of_array} of the @code{elements} grob set.")
788 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
789 cyclic dependencies.")
790 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
791 relevant for finding the @code{pure-Y-extent}.")
792 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
793 relevant for finding the @code{pure-Y-extent}.")
795 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
796 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
797 (rests ,ly:grob-array? "A list of rest objects.")
798 (right-items ,ly:grob-array? "DOCME")
799 (right-neighbors ,ly:grob-array? "See @code{left-neighbors}.")
801 (separation-item ,ly:grob? "A separation item.")
802 (side-support-elements ,ly:grob-array? "The side support, a list of
804 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
805 (spaceable-staves ,ly:grob-array? "Objects to be spaced during page
807 (spacing ,ly:grob? "The spacing spanner governing this section.")
808 (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing
810 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
811 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
812 (stems ,ly:grob-array? "A list of stem objects, corresponding to the
813 notes that the arpeggio has to be before.")
815 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
816 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
817 (tuplet-number ,ly:grob? "The number for a bracket.")
818 (tuplets ,ly:grob-array? "A list of smaller tuplet brackets.")
822 (begin-of-line-visible ,boolean? "Used for marking @code{ChordNames}
823 that should only show changes.")
825 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
826 translator) that was the cause for this grob.")
827 (delta-position ,number? "The vertical position difference.")
828 (details ,list? "Alist of parameters for detailed grob behavior.
830 More information on the allowed parameters can be found by inspecting
831 @file{lily/slur-scoring.cc}, @file{lily/beam-quanting.cc}, and
832 @file{lily/tie-formatting-problem.cc}. Setting @code{debug-tie-scoring},
833 @code{debug-beam-scoring} or @code{debug-slur-scoring} also provides
836 (font ,ly:font-metric? "A cached font metric object.")
838 (head-width ,ly:dimension? "The width of this ligature head.")
840 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
841 @var{strength}))} pairs.")
842 (interfaces ,list? "A list of symbols indicating the interfaces
843 supported by this object. It is initialized from the @code{meta} field.")
845 (least-squares-dy ,number? "The ideal beam slope, without damping.")
847 (meta ,list? "Provide meta information. It is an alist with the
848 entries @code{name} and @code{interfaces}.")
849 (minimum-distances ,list? "A list of rods that have the format
850 @code{(@var{obj} . @var{dist})}.")
852 (positioning-done ,boolean? "Used to signal that a positioning element
853 did its job. This ensures that a positioning is only done once.")
854 (pure-Y-extent ,number-pair? "The estimated height of a system.")
856 (quant-score ,string? "The beam quanting score; stored for
858 (quantize-position ,boolean? "If set, a vertical alignment is aligned
859 to be within staff spaces.")
860 (quantized-positions ,number-pair? "The beam positions after
863 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
864 acts as an index for looking up a @code{Stencil} object.")
865 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
866 Internally used to distribute beam shortening over stems.")
867 (skyline-distance ,number? "The distance between this staff and the
868 next one, as determined by a skyline algorithm.")
869 (stem-info ,pair? "A cache of stem parameters.")
871 (use-breve-rest ,boolean? "Use breve rests for measures longer
878 ;; There are too many properties for ancient notation;
879 ;; probably neume-types (a list of symbols) would also work.
881 ;; However, such a list would consist of a couple of dozens of
882 ;; entries, since head prefixes may be combined in many ways. If
883 ;; the macros in `gregorian.ly' would directly set prefix-set,
884 ;; all the head prefixes could be junked; however, such macros
885 ;; would be quite numerous, I guess. --jr
887 (add-cauda ,boolean? "Does this flexa require an additional cauda on
889 (add-join ,boolean? "Is this ligature head-joined with the next one
890 by a vertical line?")
891 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
892 an additional stem on the right side?")
893 (ascendens ,boolean? "Is this neume of ascending type?")
894 (auctum ,boolean? "Is this neume liquescentically augmented?")
896 (cavum ,boolean? "Is this neume outlined?")
897 (context-info ,integer? "Within a ligature, the final glyph or shape of
898 a head may be affected by the left and/or right neighbour head.
899 @code{context-info} holds for each head such information about the left and
900 right neighbour, encoded as a bit mask.")
902 (descendens ,boolean? "Is this neume of descendent type?")
903 (deminutum ,boolean? "Is this neume deminished?")
905 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
906 grob (in @code{staff-space} units).")
907 (flexa-width ,ly:dimension? "The width of a flexa shape in a
908 ligature grob in (in @code{staff-space} units).")
910 (inclinatum ,boolean? "Is this neume an inclinatum?")
912 (join-heads ,boolean? "Whether to join the note heads of an ambitus
913 grob with a vertical line.")
914 (join-right-amount ,number? "DOCME")
916 (linea ,boolean? "Attach vertical lines to this neume?")
918 (oriscus ,boolean? "Is this neume an oriscus?")
920 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
922 (prefix-set ,number? "A bit mask that holds all Gregorian head
923 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
924 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
925 similar to a note head that is part of a ligature.")
927 (quilisma ,boolean? "Is this neume a quilisma?")
929 (stropha ,boolean? "Is this neume a stropha?")
931 (virga ,boolean? "Is this neume a virga?")
933 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
937 (define-public all-backend-properties
939 all-internal-grob-properties
940 all-user-grob-properties))