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))
28 (add-stem-support ,boolean? "If set, the @code{Stem} object is
29 included in this script's support.")
30 (after-line-breaking ,boolean? "Dummy property, used to trigger
31 callback for @code{after-line-breaking}.")
32 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
33 @code{0}: around center of width, @code{1}: right side.")
34 (allow-loose-spacing ,boolean? "If set, column can be detached
36 (allow-span-bar ,boolean? "If false, no inter-staff bar line will
37 be created below this bar line.")
38 (alteration ,number? "Alteration numbers for accidental.")
39 (alteration-alist ,list? "List of @code{(@var{pitch}
40 . @var{accidental})} pairs for key signature.")
41 (annotation ,string? "Annotate a grob for debug purposes.")
42 (arpeggio-direction ,ly:dir? "If set, put an arrow on the
43 arpeggio squiggly line.")
44 (arrow-length ,number? "Arrow length.")
45 (arrow-width ,number? "Arrow width.")
46 (auto-knee-gap ,ly:dimension? "If a gap is found between note
47 heads where a horizontal beam fits that is larger than this number,
49 (average-spacing-wishes ,boolean? "If set, the spacing wishes are
50 averaged over staves.")
51 (avoid-note-head ,boolean? "If set, the stem of a chord does not
52 pass through all note heads, but starts at the last note head.")
53 (avoid-slur ,symbol? "Method of handling slur collisions.
54 Choices are @code{around}, @code{inside}, @code{outside}. If unset,
55 scripts and slurs ignore each other. @code{around} only moves the
56 script if there is a collision; @code{outside} always moves the
58 (axes ,list? "List of axis numbers. In the case of alignment
59 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 at
68 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 information
80 is used to determine how to connect the beaming patterns from stem to
82 (beamlet-default-length ,pair? "A pair of numbers. The first
83 number specifies the default length of a beamlet that sticks out of
84 the left hand side of this stem; the second number specifies the
85 default length of the beamlet to the right. The actual length of a
86 beamlet is determined by taking either the default length or the
87 length specified by @code{beamlet-max-length-proportion}, whichever is
89 (beamlet-max-length-proportion ,pair? "The maximum length of a
90 beamlet, as a proportion of the distance between two adjacent stems.")
91 (before-line-breaking ,boolean? "Dummy property, used to trigger
92 a callback function.")
93 (between-cols ,pair? "Where to attach a loose column to.")
94 (bound-padding ,number? "The amount of padding to insert around
96 (bound-details ,list? "An alist of properties for determining
97 attachments of spanners to edges.")
98 (bracket-flare ,number-pair? "A pair of numbers specifying how
99 much edges of brackets should slant outward. Value @code{0.0} means
101 (bracket-visibility ,boolean-or-symbol? "This controls the
102 visibility of the tuplet bracket. Setting it to false prevents
103 printing of the bracket. Setting the property to @code{if-no-beam}
104 makes it print only if there is no beam associated with this tuplet
106 (break-align-anchor ,number? "Grobs aligned to this break-align
107 grob will have their X-offsets shifted by this number. In bar lines,
108 for example, this is used to position grobs relative to the (visual)
109 center of the bar line.")
110 (break-align-anchor-alignment ,number? "Read by
111 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
112 aligning an anchor to a grob's extent")
113 (break-align-symbol ,symbol? "This key is used for aligning and
114 spacing breakable items.")
115 (break-align-symbols ,list? "A list of symbols that determine
116 which break-aligned grobs to align this to. If the grob selected by
117 the first symbol in the list is invisible due to break-visibility, we
118 will align to the next grob (and so on).")
119 (break-align-orders ,vector? "Defines the order in which
120 prefatory matter (clefs, key signatures) appears. The format is a
121 vector of length@tie{}3, where each element is one order for
122 end-of-line, middle of line, and start-of-line, respectively. An
123 order is a list of symbols.
125 For example, clefs are put after key signatures by setting
128 \\override Score.BreakAlignment #'break-align-orders =
129 #(make-vector 3 '(span-bar
136 (break-overshoot ,number-pair? "How much does a broken spanner
137 stick out of its bounds?")
138 (break-visibility ,vector? "A vector of 3@tie{}booleans,
139 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
140 @code{#t} means visible, @code{#f} means killed.")
141 (breakable ,boolean? "Allow breaks here.")
147 (c0-position ,integer? "An integer indicating the position of
149 (circled-tip ,boolean? "Put a circle at start/end of
150 hairpins (al/del niente).")
151 (clip-edges ,boolean? "Allow outward pointing beamlets at the
153 (collapse-height ,ly:dimension? "Minimum height of system start
154 delimiter. If equal or smaller, the bracket/brace/line is removed.")
155 (color ,color? "The color of this grob.")
156 (common-shortest-duration ,ly:moment? "The most common shortest
157 note length. This is used in spacing. Enlarging this sets the score
159 (concaveness ,number? "A beam is concave if its inner stems are
160 closer to the beam than the two outside stems. This number is a
161 measure of the closeness of the inner stems. It is used for damping
162 the slope of the beam.")
163 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
164 this grob looks as a continued break.")
165 (control-points ,list? "List of offsets (number pairs) that form
166 control points for the tie, slur, or bracket shape. For B@'eziers,
167 this should list the control points of a third-order B@'ezier curve.")
173 (damping ,number? "Amount of beam slope damping.")
174 (dash-fraction ,number? "Size of the dashes, relative to
175 @code{dash-period}. Should be between @code{0.0} (no line) and
176 @code{1.0} (continuous line).")
177 (dash-period ,number? "The length of one dash together with
178 whitespace. If negative, no line is drawn at all.")
179 (default-direction ,ly:dir? "Direction determined by note head
181 (details ,list? "Alist of parameters for detailed grob behavior.
182 More information on the allowed parameters for a grob can be found by
183 looking at the top of the Internals Reference page for each interface
184 having a @code{details} property.")
185 (digit-names ,vector "Names for string finger digits.")
186 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
187 @code{#X}), then this property determines whether the object is placed
188 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
189 other object. Otherwise, it determines whether the object is placed
190 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also
191 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
192 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1},
193 @code{#CENTER}=@code{0}.")
194 (dot-count ,integer? "The number of dots.")
195 (dot-negative-kern ,number? "The space to remove between a dot
196 and a slash in percent repeat glyphs. Larger values bring the two
197 elements closer together.")
198 (dot-placement-list ,list? "List consisting of
199 @code{(@var{description} @var{string-number} @var{fret-number}
200 @var{finger-number})} entries used to define fret diagrams.")
201 (duration-log ,integer? "The 2-log of the note head duration,
202 i.e., @code{0} = whole note, @code{1} = half note, etc.")
208 (eccentricity ,number? "How asymmetrical to make a slur.
209 Positive means move the center to the right.")
210 (edge-height ,pair? "A pair of numbers specifying the heights of
211 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
212 (edge-text ,pair? "A pair specifying the texts to be set at the
213 edges: @code{(@var{left-text} . @var{right-text})}.")
214 (expand-limit ,integer? "Maximum number of measures expanded in
216 (extra-X-extent ,number-pair? "A grob is enlarged in
217 X@tie{}dimension by this much.")
218 (extra-Y-extent ,number-pair? "A grob is enlarged in
219 Y@tie{}dimension by this much.")
221 (extra-dy ,number? "Slope glissandi this much extra.")
222 (extra-offset ,number-pair? "A pair representing an offset. This
223 offset is added just before outputting the symbol, so the typesetting
224 engine is completely oblivious to it. The values are measured in
225 @code{staff-space} units of the staff's @code{StaffSymbol}.")
226 (extra-spacing-height ,number-pair? "In the horizontal spacing
227 problem, we increase the height of each item by this amount (by adding
228 the @q{car} to the bottom of the item and adding the @q{cdr} to the
229 top of the item). In order to make a grob infinitely high (to prevent
230 the horizontal spacing problem from placing any other grobs above or
231 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
232 (extra-spacing-width ,number-pair? "In the horizontal spacing
233 problem, we pad each item by this amount (by adding the @q{car} on the
234 left side of the item and adding the @q{cdr} on the right side of the
235 item). In order to make a grob take up no horizontal space at all,
236 set this to @code{(+inf.0 . -inf.0)}.")
242 (flag ,ly:stencil? "A function returning the full flag stencil
243 for the @code{Stem}, which is passed to the function as the only
244 argument. The default ly:stem::calc-stencil function uses the
245 @code{flag-style} property to determine the correct glyph for the
246 flag. By providing your own function, you can create arbitrary
248 (flag-count ,number? "The number of tremolo beams.")
249 (flag-style ,symbol? "A symbol determining what style of flag
250 glyph is typeset on a @code{Stem}. Valid options include @code{'()}
251 for standard flags, @code{'mensural} and @code{'no-flag}, which
252 switches off the flag.")
253 (font-encoding ,symbol? "The font encoding is the broadest
254 category for selecting a font. Currently, only lilypond's system
255 fonts (Emmentaler and Aybabtu) are using this property. Available
256 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces} (Aybabtu),
257 @code{fetaNumber} (Emmentaler), and @code{fetaDynamic} (Emmentaler).")
258 (font-family ,symbol? "The font family is the broadest category
259 for selecting text fonts. Options include: @code{sans},
261 (font-name ,string? "Specifies a file name (without extension) of
262 the font to load. This setting overrides selection using
263 @code{font-family}, @code{font-series} and @code{font-shape}.")
264 (font-series ,symbol? "Select the series of a font. Choices
265 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
266 (font-shape ,symbol? "Select the shape of a font. Choices
267 include @code{upright}, @code{italic}, @code{caps}.")
268 (font-size ,number? "The font size, compared to the
269 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
270 @code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
271 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
272 larger. Fractional values are allowed.")
273 (force-hshift ,number? "This specifies a manual shift for notes
274 in collisions. The unit is the note head width of the first voice
275 note. This is used by @rinternals{note-collision-interface}.")
276 (fraction ,number-pair? "Numerator and denominator of a time
278 (french-beaming ,boolean? "Use French beaming style for this
279 stem. The stem stops at the innermost beams.")
280 (fret-diagram-details ,list? "An alist of detailed grob
281 properties for fret diagrams. Each alist entry consists of a
282 @code{(@var{property} . @var{value})} pair. The properties which can
283 be included in @code{fret-diagram-details} include the following:
287 @code{barre-type} -- Type of barre indication used. Choices include
288 @code{curved}, @code{straight}, and @code{none}. Default
291 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
292 fret-space. Default value@tie{}0.5.
294 @code{dot-color} -- Color of dots. Options include @code{black} and
295 @code{white}. Default @code{black}.
297 @code{dot-label-font-mag} -- Magnification for font used to label fret
298 dots. Default value@tie{}1.
300 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
301 dots without labels, 0.95-@code{dot-radius} for dots with labels.
303 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
304 value 0.425 for labeled dots, 0.25 for unlabeled dots.
306 @code{finger-code} -- Code for the type of fingering indication used.
307 Options include @code{none}, @code{in-dot}, and @code{below-string}.
308 Default @code{none} for markup fret diagrams, @code{below-string} for
309 @code{FretBoards} fret diagrams.
311 @code{fret-count} -- The number of frets. Default@tie{}4.
313 @code{fret-label-font-mag} -- The magnification of the font used to
314 label the lowest fret number. Default@tie{}0.5.
316 @code{fret-label-vertical-offset} -- The offset of the fret label from
317 the center of the fret in direction parallel to strings.
320 @code{label-dir} -- Side to which the fret label is attached.
321 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1},
322 @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}.
324 @code{mute-string} -- Character string to be used to indicate muted
325 string. Default @code{\"x\"}.
327 @code{number-type} -- Type of numbers to use in fret label. Choices
328 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.
329 Default @code{roman-lower}.
331 @code{open-string} -- Character string to be used to indicate open
332 string. Default @code{\"o\"}.
334 @code{orientation} -- Orientation of fret-diagram. Options include
335 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
336 Default @code{normal}.
338 @code{string-count} -- The number of strings. Default@tie{}6.
340 @code{string-label-font-mag} -- The magnification of the font used to
341 label fingerings at the string, rather than in the dot. Default value
342 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
343 @code{opposing-landscape}.
345 @code{string-thickness-factor} -- Factor for changing thickness of
346 each string in the fret diagram. Thickness of string @var{k} is given
348 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
351 @code{top-fret-thickness} -- The thickness of the top fret line, as a
352 multiple of the standard thickness. Default value@tie{}3.
354 @code{xo-font-magnification} -- Magnification used for mute and open
355 string indicators. Default value@tie{}0.5.
357 @code{xo-padding} -- Padding for open and mute indicators from top
358 fret. Default value 0.25.
360 ;; ugh: double, change.
361 (full-length-padding ,number? "How much padding to use at the
362 right side of a full-length tuplet bracket.")
363 (full-length-to-extent ,boolean? "Run to the extent of the column
364 for a full-length tuplet bracket.")
365 (full-measure-extra-space ,number? "Extra space that is allocated
366 at the beginning of a measure with only one note. This property is
367 read from the NonMusicalPaperColumn that begins the measure.")
368 (full-size-change ,boolean? "Don't make a change clef smaller.")
374 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
375 (gap-count ,integer? "Number of gapped beams for tremolo.")
376 (glyph ,string? "A string determining what @q{style} of glyph is
377 typeset. Valid choices depend on the function that is reading this
379 (glyph-name-alist ,list? "An alist of key-string pairs.")
380 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
386 (hair-thickness ,number? "Thickness of the thin line in a bar
388 (harp-pedal-details ,list? "An alist of detailed grob properties
389 for harp pedal diagrams. Each alist entry consists of a
390 @code{(@var{property} . @var{value})} pair. The properties which can
391 be included in harp-pedal-details include the following:
395 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
396 boxes above/below the horizontal line. Default value@tie{}0.8.
398 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
400 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
402 @code{space-before-divider} -- Space between boxes before the first
403 divider (so that the diagram can be made symmetric). Default
406 @code{space-after-divider} -- Space between boxes after the first
407 divider. Default value@tie{}0.8.
409 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
410 of the ellipse around circled pedals. Default value@tie{}0.5.
412 @code{circle-x-padding} -- Padding in X direction of the ellipse
413 around circled pedals. Default value 0.15.
415 @code{circle-y-padding} -- Padding in Y direction of the ellipse
416 around circled pedals. Default value@tie{}0.2.
418 (head-direction ,ly:dir? "Are the note heads left or right in a
420 (height ,ly:dimension? "Height of an object in @code{staff-space}
422 (height-limit ,ly:dimension? "Maximum slur height: The longer the
423 slur, the closer it is to this height.")
424 (horizontal-shift ,integer? "An integer that identifies ranking
425 of @code{NoteColumn}s for horizontal shifting. This is used by
426 @rinternals{note-collision-interface}.")
427 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
428 left and one to the right of this grob.")
434 (ignore-collision ,boolean? "If set, don't do note collision
435 resolution on this @code{NoteColumn}.")
436 (implicit ,boolean? "Is this an implicit bass figure?")
437 (inspect-index ,integer? "If debugging is set, set beam and slur
438 configuration to this index, and print the respective scores.")
439 (inspect-quants ,number-pair? "If debugging is set, set beam and
440 slur quants to this position, and print the respective scores.")
446 (keep-fixed-while-stretching ,boolean? "A grob with this property
447 set to true is fixed relative to the staff above it when systems are
449 (keep-inside-line ,boolean? "If set, this column cannot have
450 objects sticking into the margin.")
451 (kern ,ly:dimension? "Amount of extra white space to add. For
452 bar lines, this is the amount of space after a thick line.")
453 (knee ,boolean? "Is this beam kneed?")
454 (knee-spacing-correction ,number? "Factor for the optical
455 correction amount for kneed beams. Set between @code{0} for no
456 correction and @code{1} for full correction.")
462 (labels ,list? "List of labels (symbols) placed on a column")
463 (layer ,integer? "The output layer (a value between 0
464 and@tie{}2): Layers define the order of printing objects. Objects in
465 lower layers are overprinted by objects in higher layers.")
466 (ledger-line-thickness ,number-pair? "The thickness of ledger
467 lines. It is the sum of 2@tie{}numbers: The first is the factor for
468 line thickness, and the second for staff space. Both contributions
470 (left-bound-info ,list? "An alist of properties for determining
471 attachments of spanners to edges.")
472 (left-padding ,ly:dimension? "The amount of space that is put
473 left to an object (e.g., a group of accidentals).")
474 (length ,ly:dimension? "User override for the stem length of
476 (length-fraction ,number? "Multiplier for lengths. Used for
477 determining ledger lines and stem lengths.")
478 (line-break-penalty ,number? "Penalty for a line break at this
479 column. This affects the choices of the line breaker; it avoids a
480 line break at a column with a positive penalty and prefers a line
481 break at a column with a negative penalty.")
482 (line-break-permission ,symbol? "Instructs the line breaker on
483 whether to put a line break at this column. Can be @code{force} or
485 (line-break-system-details ,list? "An alist of properties to use
486 if this column is the start of a system.")
487 (line-count ,integer? "The number of staff lines.")
488 (line-positions ,list? "Vertical positions of staff lines.")
489 (line-thickness ,number? "The thickness of the tie or slur
491 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
497 (max-beam-connect ,integer? "Maximum number of beams to connect
498 to beams from this stem. Further beams are typeset as beamlets.")
499 (max-stretch ,number? "The maximum amount that this
500 @code{VerticalAxisGroup} can be vertically stretched (for example, in
501 order to better fill a page).")
502 (measure-count ,integer? "The number of measures for a
503 multi-measure rest.")
504 (measure-length ,ly:moment? "Length of a measure. Used in some
505 spacing situations.")
506 (merge-differently-dotted ,boolean? "Merge note heads in
507 collisions, even if they have a different number of dots. This is
508 normal notation for some types of polyphonic music.
510 @code{merge-differently-dotted} only applies to opposing stem
511 directions (i.e., voice 1 &@tie{}2).")
512 (merge-differently-headed ,boolean? "Merge note heads in
513 collisions, even if they have different note heads. The smaller of
514 the two heads is rendered invisible. This is used in polyphonic
515 guitar notation. The value of this setting is used by
516 @rinternals{note-collision-interface}.
518 @code{merge-differently-headed} only applies to opposing stem
519 directions (i.e., voice 1 &@tie{}2).")
520 (minimum-X-extent ,number-pair? "Minimum size of an object in
521 X@tie{}dimension, measured in @code{staff-space} units.")
522 (minimum-Y-extent ,number-pair? "Minimum size of an object in
523 Y@tie{}dimension, measured in @code{staff-space} units.")
524 (minimum-distance ,ly:dimension? "Minimum distance between rest
526 (minimum-length ,ly:dimension? "Try to make a spanner at least
527 this long, normally in the horizontal direction. This requires an
528 appropriate callback for the @code{springs-and-rods} property. If
529 added to a @code{Tie}, this sets the minimum distance between
531 (minimum-length-fraction ,number? "Minimum length of ledger line
532 as fraction of note head size.")
533 (minimum-space ,ly:dimension? "Minimum distance that the victim
534 should move (after padding).")
540 (neutral-direction ,ly:dir? "Which direction to take in the
541 center of the staff.")
542 (neutral-position ,number? "Position (in half staff spaces) where
543 to flip the direction of custos stem.")
544 (next ,ly:grob? "Object that is next relation (e.g., the lyric
545 syllable following an extender).")
546 (no-alignment ,boolean? "If set, don't place this grob in a
547 @code{VerticalAlignment}; rather, place it using its own
548 @code{Y-offset} callback.")
549 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
551 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
552 get stems extending to the middle staff line.")
553 (non-default ,boolean? "Set for manually specified clefs.")
554 (non-musical ,boolean? "True if the grob belongs to a
555 @code{NonMusicalPaperColumn}.")
556 (note-names ,vector? "Vector of strings containing names for
557 easy-notation note heads.")
563 (outside-staff-horizontal-padding ,number? "By default, an
564 outside-staff-object can be placed so that is it very close to another
565 grob horizontally. If this property is set, the outside-staff-object
566 is raised so that it is not so close to its neighbor.")
567 (outside-staff-padding ,number? "The padding to place between
568 this grob and the staff when spacing according to
569 @code{outside-staff-priority}.")
570 (outside-staff-priority ,number? "If set, the grob is positioned
571 outside the staff in such a way as to avoid all collisions. In case
572 of a potential collision, the grob with the smaller
573 @code{outside-staff-priority} is closer to the staff.")
579 (packed-spacing ,boolean? "If set, the notes are spaced as
580 tightly as possible.")
581 (padding ,ly:dimension? "Add this much extra space between
582 objects that are next to each other.")
583 (padding-pairs ,list? "An alist mapping @code{(@var{name}
584 . @var{name})} to distances.")
585 (page-break-penalty ,number? "Penalty for page break at this
586 column. This affects the choices of the page breaker; it avoids a
587 page break at a column with a positive penalty and prefers a page
588 break at a column with a negative penalty.")
589 (page-break-permission ,symbol? "Instructs the page breaker on
590 whether to put a page break at this column. Can be @code{force} or
592 (page-turn-penalty ,number? "Penalty for a page turn at this
593 column. This affects the choices of the page breaker; it avoids a
594 page turn at a column with a positive penalty and prefers a page turn
595 at a column with a negative penalty.")
596 (page-turn-permission ,symbol? "Instructs the page breaker on
597 whether to put a page turn at this column. Can be @code{force} or
599 (parenthesized ,boolean? "Parenthesize this grob.")
600 (positions ,number-pair? "Pair of staff coordinates
601 @code{(@var{left} . @var{right})}, where both @var{left} and
602 @var{right} are in @code{staff-space} units of the current staff. For
603 slurs, this value selects which slur candidate to use; if extreme
604 positions are requested, the closest one is taken.")
605 (prefer-dotted-right ,boolean? "For note collisions, prefer to
606 shift dotted up-note to the right, rather than shifting just the
613 (ratio ,number? "Parameter for slur shape. The higher this
614 number, the quicker the slur attains its @code{height-limit}.")
615 (remove-empty ,boolean? "If set, remove group if it contains no
617 (remove-first ,boolean? "Remove the first staff of an orchestral
619 (restore-first ,boolean? "Print a natural before the
621 (rhythmic-location ,rhythmic-location? "Where (bar number,
622 measure position) in the score.")
623 (right-bound-info ,list? "An alist of properties for determining
624 attachments of spanners to edges.")
625 (right-padding ,ly:dimension? "Space to insert on the right side
626 of an object (e.g., between note and its accidentals).")
627 (rotation ,list? "Number of degrees to rotate this object, and
628 what point to rotate around. For example, @code{#'(45 0 0)} rotates
629 by 45 degrees around the center of this object.")
635 (same-direction-correction ,number? "Optical correction amount
636 for stems that are placed in tight configurations. This amount is
637 used for stems with the same direction to compensate for note head to
639 (script-priority ,number? "A sorting key that determines in what
640 order a script is within a stack of scripts.")
641 (self-alignment-X ,number? "Specify alignment of an object. The
642 value @code{-1} means left aligned, @code{0}@tie{}centered, and
643 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
644 values may also be specified.")
645 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
647 (toward-stem-shift ,number? "Amount by which scripts are shifted
648 toward the stem if their direction coincides with the stem direction.
649 @code{0.0} means keep the default position (centered on the note
650 head), @code{1.0} means centered on the stem. Interpolated values are
652 (shorten-pair ,number-pair? "The lengths to shorten a
653 text-spanner on both sides, for example a pedal bracket. Positive
654 values shorten the text-spanner, while negative values lengthen it.")
655 (shortest-duration-space ,ly:dimension? "Start with this much
656 space for the shortest duration. This is expressed in
657 @code{spacing-increment} as unit. See also
658 @rinternals{spacing-spanner-interface}.")
659 (shortest-playing-duration ,ly:moment? "The duration of the
660 shortest note playing here.")
661 (shortest-starter-duration ,ly:moment? "The duration of the
662 shortest note that starts here.")
663 (side-axis ,number? "If the value is @code{#X} (or
664 equivalently@tie{}@code{0}), the object is placed horizontally next to
665 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is
667 (side-relative-direction ,ly:dir? "Multiply direction of
668 @code{direction-source} with this to get the direction of this
670 (size ,number? "Size of object, relative to standard size.")
671 (skyline-horizontal-padding ,number? "For determining the
672 vertical distance between two staves, it is possible to have a
673 configuration which would result in a tight interleaving of grobs from
674 the top staff and the bottom staff. The larger this parameter is, the
675 farther apart the staves are placed in such a configuration.")
676 (slash-negative-kern ,number? "The space to remove between
677 slashes in percent repeat glyphs. Larger values bring the two
678 elements closer together.")
679 (slope ,number? "The slope of this object.")
680 (slur-padding ,number? "Extra distance between slur and script.")
681 (space-alist ,list? "A table that specifies distances between
682 prefatory items, like clef and time-signature. The format is an alist
683 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
684 . @var{distance})}, where @var{type} can be the symbols
685 @code{minimum-space} or @code{extra-space}.")
686 (space-to-barline ,boolean? "If set, the distance between a note
687 and the following non-musical column will be measured to the bar line
688 instead of to the beginning of the non-musical column. If there is a
689 clef change followed by a bar line, for example, this means that we
690 will try to space the non-musical column as though the clef is not
692 (spacing-increment ,number? "Add this much space for a doubled
693 duration. Typically, the width of a note head. See also
694 @rinternals{spacing-spanner-interface}.")
695 (springs-and-rods ,boolean? "Dummy variable for triggering
697 (stacking-dir ,ly:dir? "Stack objects in which direction?")
698 (staff-padding ,ly:dimension? "Maintain this much space between
699 reference points and the staff. Its effect is to align objects of
700 differing sizes (like the dynamics @b{p} and @b{f}) on their
702 (staff-position ,number? "Vertical position, measured in half
703 staff spaces, counted from the middle line.")
704 (staff-space ,ly:dimension? "Amount of space between staff lines,
705 expressed in global @code{staff-space}.")
706 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
707 pair where the stem attaches to the notehead.")
708 (stem-end-position ,number? "Where does the stem end (the end is
709 opposite to the support-head)?")
711 (stem-spacing-correction ,number? "Optical correction amount for
712 stems that are placed in tight configurations. For opposite
713 directions, this amount is the correction for two normal sized stems
714 that overlap completely.")
715 (stemlet-length ,number? "How long should be a stem over a
717 (stencil ,ly:stencil? "The symbol to print.")
718 (stencils ,list? "Multiple stencils, used as intermediate
720 (strict-grace-spacing ,boolean? "If set, main notes are spaced
721 normally, then grace notes are put left of the musical columns fot the
723 (strict-note-spacing ,boolean? "If set, unbroken columns with
724 non-musical material (clefs, bar lines, etc.) are not spaced
725 separately, but put before musical columns.")
726 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
728 (style ,symbol? "This setting determines in what style a grob is
729 typeset. Valid choices depend on the @code{stencil} callback reading
736 (text ,markup? "Text markup. See @ruser{Formatting text}.")
737 ;;FIXME -- Should both be the same?
738 (text-direction ,ly:dir? "This controls the ordering of the
739 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
740 should use @code{LEFT}.")
741 (thick-thickness ,number? "Bar line thickness, measured in
742 @code{line-thickness}.")
743 (thickness ,number? "Line thickness, generally measured in
744 @code{line-thickness}.")
745 (thin-kern ,number? "The space after a hair-line in a bar line.")
746 (threshold ,number-pair? "@code{(@var{min} . @var{max})}, where
747 @var{min} and @var{max} are dimensions in staff space.")
748 (tie-configuration ,list? "List of @code{(@var{position} .
749 @var{dir})} pairs, indicating the desired tie configuration, where
750 @var{position} is the offset from the center of the staff in staff
751 space and @var{dir} indicates the direction of the tie
752 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
753 in the list causes the corresponding tie to be formatted
755 (to-barline ,boolean? "If true, the spanner will stop at the bar
756 line just before it would otherwise stop.")
757 (transparent ,boolean? "This makes the grob invisible.")
763 (uniform-stretching ,boolean? "If set, items stretch
764 proportionally to their durations. This looks better in complex
765 polyphonic patterns.")
766 (used ,boolean? "If set, this spacing column is kept in the
773 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
774 one below this grob.")
780 (when ,ly:moment? "Global time step associated with this column
782 (width ,ly:dimension? "The width of a grob measured in staff
784 (word-space ,ly:dimension? "Space to insert between words in
791 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
792 (X-offset ,number? "The horizontal amount that this object is
793 moved relative to its X-parent.")
799 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
800 (Y-offset ,number? "The vertical amount that this object is moved
801 relative to its Y-parent.")
806 (zigzag-length ,ly:dimension? "The length of the lines of a
807 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
808 gives 60-degree zigzags.")
809 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
810 This number is adjusted slightly so that the glissando line can be
811 constructed from a whole number of squiggles.")
819 (define (define-internal-grob-property symbol type? description)
820 (define-grob-property symbol type? description)
821 (set-object-property! symbol 'backend-internal #t)
826 (define-public all-internal-grob-properties
829 (apply define-internal-grob-property x))
833 ;; grobs & grob arrays. (alphabetical)
834 (X-common ,ly:grob? "Common reference point for axis group.")
836 (Y-common ,ly:grob? "See @code{X-common}.")
838 (accidental-grob ,ly:grob? "The accidental for this note.")
839 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
840 @var{groblist})} entries.")
841 (adjacent-pure-heights ,vector? "Used by a @code{VerticalAxisGroup} to
842 cache the @code{Y-extent}s of different column ranges.")
843 (adjacent-hairpins ,ly:grob-array? "A list of directly neighboring
845 (all-elements ,ly:grob-array? "A list of all grobs in this line. Its
846 function is to protect objects from being garbage collected.")
847 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
848 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
849 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
851 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
852 This may differ from @code{Y-extent} because it does not include the dots in
854 (bars ,ly:grob-array? "A list of bar line pointers.")
855 (beam ,ly:grob? "A pointer to the beam, if applicable.")
856 (bounded-by-me ,ly:grob-array? "A list of spanners that have this
857 column as start/begin point. Only columns that have grobs or act as
859 (bracket ,ly:grob? "The bracket for a number.")
861 (columns ,ly:grob-array? "A list of grobs, typically containing
862 @code{PaperColumn} or @code{NoteColumn} objects.")
863 (conditional-elements ,ly:grob-array? "Internal use only.")
864 (cross-staff ,boolean? "For a beam or a stem, this is true if we
865 depend on inter-staff spacing.")
867 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
868 set, which grob to get the direction from.")
869 (dot ,ly:grob? "A reference to a @code{Dots} object.")
870 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
872 (elements ,ly:grob-array? "A list of grobs; the type is depending on
873 the grob where this is set in.")
874 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
875 in addition to notes and stems.")
877 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
878 (forced ,boolean? "Manually forced accidental.")
880 (glyph-name ,string? "The glyph name within the font.")
881 (grace-spacing ,ly:grob? "A run of grace notes.")
883 (heads ,ly:grob-array? "A list of note heads.")
885 (important-column-ranks ,vector? "A cache of columns that contain
886 @code{items-worth-living} data.")
887 (items-worth-living ,ly:grob-array? "A list of interesting items. If
888 empty in a particular staff, then that staff is erased.")
890 (left-items ,ly:grob-array? "DOCME")
891 (left-neighbors ,ly:grob-array? "A list of @code{spacing-wishes} grobs
892 that are close to the current column.
894 The closest @code{spacing-wishes} determine the actual distances between the
897 (normal-stems ,ly:grob-array? "An array of visible stems.")
898 (note-columns ,pair? "A list of @code{NoteColumn} grobs.")
899 (note-head ,ly:grob? "A single note head.")
900 (note-heads ,ly:grob-array? "A list of note head grobs.")
901 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
903 (pure-Y-common ,ly:grob? "A cache of the
904 @code{common_refpoint_of_array} of the @code{elements} grob set.")
905 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
906 cyclic dependencies.")
907 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
908 relevant for finding the @code{pure-Y-extent}.")
909 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
910 relevant for finding the @code{pure-Y-extent}.")
912 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
913 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
914 (rests ,ly:grob-array? "A list of rest objects.")
915 (right-items ,ly:grob-array? "DOCME")
916 (right-neighbors ,ly:grob-array? "See @code{left-neighbors}.")
918 (separation-item ,ly:grob? "A separation item.")
919 (side-support-elements ,ly:grob-array? "The side support, a list of
921 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
922 (spaceable-staves ,ly:grob-array? "Objects to be spaced during page
924 (spacing ,ly:grob? "The spacing spanner governing this section.")
925 (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing
927 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
928 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
929 (stems ,ly:grob-array? "A list of stem objects, corresponding to the
930 notes that the arpeggio has to be before.")
932 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
933 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
934 (tuplet-number ,ly:grob? "The number for a bracket.")
935 (tuplets ,ly:grob-array? "A list of smaller tuplet brackets.")
939 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
940 @code{FretBoard} be visible only at beginning of line or at
943 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
944 translator) that was the cause for this grob.")
946 (delta-position ,number? "The vertical position difference.")
948 (font ,ly:font-metric? "A cached font metric object.")
950 (head-width ,ly:dimension? "The width of this ligature head.")
952 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
953 @var{strength}))} pairs.")
954 (interfaces ,list? "A list of symbols indicating the interfaces
955 supported by this object. It is initialized from the @code{meta} field.")
957 (least-squares-dy ,number? "The ideal beam slope, without damping.")
959 (meta ,list? "Provide meta information. It is an alist with the
960 entries @code{name} and @code{interfaces}.")
961 (minimum-distances ,list? "A list of rods that have the format
962 @code{(@var{obj} . @var{dist})}.")
964 (positioning-done ,boolean? "Used to signal that a positioning element
965 did its job. This ensures that a positioning is only done once.")
966 (pure-Y-extent ,number-pair? "The estimated height of a system.")
968 (quant-score ,string? "The beam quanting score; stored for
970 (quantize-position ,boolean? "If set, a vertical alignment is aligned
971 to be within staff spaces.")
972 (quantized-positions ,number-pair? "The beam positions after
975 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
976 acts as an index for looking up a @code{Stencil} object.")
977 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
978 Internally used to distribute beam shortening over stems.")
979 (skyline-distance ,number? "The distance between this staff and the
980 next one, as determined by a skyline algorithm.")
981 (stem-info ,pair? "A cache of stem parameters.")
983 (use-breve-rest ,boolean? "Use breve rests for measures longer
990 ;; There are too many properties for ancient notation;
991 ;; probably neume-types (a list of symbols) would also work.
993 ;; However, such a list would consist of a couple of dozens of
994 ;; entries, since head prefixes may be combined in many ways. If
995 ;; the macros in `gregorian.ly' would directly set prefix-set,
996 ;; all the head prefixes could be junked; however, such macros
997 ;; would be quite numerous, I guess. --jr
999 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1001 (add-join ,boolean? "Is this ligature head-joined with the next one
1002 by a vertical line?")
1003 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1004 an additional stem on the right side?")
1005 (ascendens ,boolean? "Is this neume of ascending type?")
1006 (auctum ,boolean? "Is this neume liquescentically augmented?")
1008 (cavum ,boolean? "Is this neume outlined?")
1009 (context-info ,integer? "Within a ligature, the final glyph or shape of
1010 a head may be affected by the left and/or right neighbour head.
1011 @code{context-info} holds for each head such information about the left and
1012 right neighbour, encoded as a bit mask.")
1014 (descendens ,boolean? "Is this neume of descendent type?")
1015 (deminutum ,boolean? "Is this neume deminished?")
1017 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1018 grob (in @code{staff-space} units).")
1019 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1020 ligature grob in (in @code{staff-space} units).")
1022 (inclinatum ,boolean? "Is this neume an inclinatum?")
1024 (join-heads ,boolean? "Whether to join the note heads of an ambitus
1025 grob with a vertical line.")
1026 (join-right-amount ,number? "DOCME")
1028 (linea ,boolean? "Attach vertical lines to this neume?")
1030 (oriscus ,boolean? "Is this neume an oriscus?")
1032 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1034 (prefix-set ,number? "A bit mask that holds all Gregorian head
1035 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1036 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1037 similar to a note head that is part of a ligature.")
1039 (quilisma ,boolean? "Is this neume a quilisma?")
1041 (stropha ,boolean? "Is this neume a stropha?")
1043 (virga ,boolean? "Is this neume a virga?")
1045 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1049 (define-public all-backend-properties
1051 all-internal-grob-properties
1052 all-user-grob-properties))