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