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