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