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{inside}, @code{outside}, @code{around}, and
55 @code{ignore}. @code{inside} adjusts the slur if needed to keep the
56 grob inside the slur. @code{outside} moves the grob vertically to the
57 outside of the slur. @code{around} moves the grob vertically to the
58 outside of the slur only if there is a collision. @code{ignore} does
59 not move either. In grobs whose notational significance depends on
60 vertical position (such as accidentals, clefs, etc.), @code{outside}
61 and @code{around} behave like @code{ignore}.")
62 (axes ,list? "List of axis numbers. In the case of alignment
63 grobs, this should contain only one number.")
69 (bar-size ,ly:dimension? "The size of a bar line.")
70 (base-shortest-duration ,ly:moment? "Spacing is based on the
71 shortest notes in a piece. Normally, pieces are spaced as if notes at
72 least as short as this are present.")
73 (baseline-skip ,ly:dimension? "Distance between base lines of
74 multiple lines of text.")
75 (beam-thickness ,ly:dimension? "Beam thickness, measured in
76 @code{staff-space} units.")
77 (beam-width ,ly:dimension? "Width of the tremolo sign.")
78 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
79 when their direction is forced. It is a list, since the value is
80 different depending on the number of flags and beams.")
81 (beaming ,pair? "Pair of number lists. Each number list
82 specifies which beams to make. @code{0}@tie{}is the central beam,
83 @code{1}@tie{}is the next beam toward the note, etc. This information
84 is used to determine how to connect the beaming patterns from stem to
86 (beamlet-default-length ,pair? "A pair of numbers. The first
87 number specifies the default length of a beamlet that sticks out of
88 the left hand side of this stem; the second number specifies the
89 default length of the beamlet to the right. The actual length of a
90 beamlet is determined by taking either the default length or the
91 length specified by @code{beamlet-max-length-proportion}, whichever is
93 (beamlet-max-length-proportion ,pair? "The maximum length of a
94 beamlet, as a proportion of the distance between two adjacent stems.")
95 (before-line-breaking ,boolean? "Dummy property, used to trigger
96 a callback function.")
97 (between-cols ,pair? "Where to attach a loose column to.")
98 (bound-padding ,number? "The amount of padding to insert around
100 (bound-details ,list? "An alist of properties for determining
101 attachments of spanners to edges.")
102 (bracket-flare ,number-pair? "A pair of numbers specifying how
103 much edges of brackets should slant outward. Value @code{0.0} means
105 (bracket-visibility ,boolean-or-symbol? "This controls the
106 visibility of the tuplet bracket. Setting it to false prevents
107 printing of the bracket. Setting the property to @code{if-no-beam}
108 makes it print only if there is no beam associated with this tuplet
110 (break-align-anchor ,number? "Grobs aligned to this break-align
111 grob will have their X-offsets shifted by this number. In bar lines,
112 for example, this is used to position grobs relative to the (visual)
113 center of the bar line.")
114 (break-align-anchor-alignment ,number? "Read by
115 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
116 aligning an anchor to a grob's extent.")
117 (break-align-symbol ,symbol? "This key is used for aligning and
118 spacing breakable items.")
119 (break-align-symbols ,list? "A list of symbols that determine
120 which break-aligned grobs to align this to. If the grob selected by
121 the first symbol in the list is invisible due to break-visibility, we
122 will align to the next grob (and so on). Choices are @code{left-edge},
123 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar},
124 @code{key-cancellation}, @code{key-signature}, @code{time-signature},
126 (break-align-orders ,vector? "Defines the order in which
127 prefatory matter (clefs, key signatures) appears. The format is a
128 vector of length@tie{}3, where each element is one order for
129 end-of-line, middle of line, and start-of-line, respectively. An
130 order is a list of symbols.
132 For example, clefs are put after key signatures by setting
135 \\override Score.BreakAlignment #'break-align-orders =
136 #(make-vector 3 '(span-bar
143 (break-overshoot ,number-pair? "How much does a broken spanner
144 stick out of its bounds?")
145 (break-visibility ,vector? "A vector of 3@tie{}booleans,
146 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
147 @code{#t} means visible, @code{#f} means killed.")
148 (breakable ,boolean? "Allow breaks here.")
154 (c0-position ,integer? "An integer indicating the position of
156 (circled-tip ,boolean? "Put a circle at start/end of
157 hairpins (al/del niente).")
158 (clip-edges ,boolean? "Allow outward pointing beamlets at the
160 (collapse-height ,ly:dimension? "Minimum height of system start
161 delimiter. If equal or smaller, the bracket/brace/line is removed.")
162 (color ,color? "The color of this grob.")
163 (common-shortest-duration ,ly:moment? "The most common shortest
164 note length. This is used in spacing. Enlarging this sets the score
166 (concaveness ,number? "A beam is concave if its inner stems are
167 closer to the beam than the two outside stems. This number is a
168 measure of the closeness of the inner stems. It is used for damping
169 the slope of the beam.")
170 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
171 this grob looks as a continued break.")
172 (control-points ,list? "List of offsets (number pairs) that form
173 control points for the tie, slur, or bracket shape. For B@'eziers,
174 this should list the control points of a third-order B@'ezier curve.")
180 (damping ,number? "Amount of beam slope damping.")
181 (dash-definition ,pair? "List of @code{dash-elements} defining the
182 dash structure. Each @code{dash-element} has a starting t value,
183 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
184 (dash-fraction ,number? "Size of the dashes, relative to
185 @code{dash-period}. Should be between @code{0.0} (no line) and
186 @code{1.0} (continuous line).")
187 (dash-period ,number? "The length of one dash together with
188 whitespace. If negative, no line is drawn at all.")
189 (default-direction ,ly:dir? "Direction determined by note head
191 (details ,list? "Alist of parameters for detailed grob behavior.
192 More information on the allowed parameters for a grob can be found by
193 looking at the top of the Internals Reference page for each interface
194 having a @code{details} property.")
195 (digit-names ,vector "Names for string finger digits.")
196 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
197 @code{#X}), then this property determines whether the object is placed
198 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
199 other object. Otherwise, it determines whether the object is placed
200 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also
201 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
202 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1},
203 @code{#CENTER}=@code{0}.")
204 (dot-count ,integer? "The number of dots.")
205 (dot-negative-kern ,number? "The space to remove between a dot
206 and a slash in percent repeat glyphs. Larger values bring the two
207 elements closer together.")
208 (dot-placement-list ,list? "List consisting of
209 @code{(@var{description} @var{string-number} @var{fret-number}
210 @var{finger-number})} entries used to define fret diagrams.")
211 (duration-log ,integer? "The 2-log of the note head duration,
212 i.e., @code{0} = whole note, @code{1} = half note, etc.")
218 (eccentricity ,number? "How asymmetrical to make a slur.
219 Positive means move the center to the right.")
220 (edge-height ,pair? "A pair of numbers specifying the heights of
221 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
222 (edge-text ,pair? "A pair specifying the texts to be set at the
223 edges: @code{(@var{left-text} . @var{right-text})}.")
224 (expand-limit ,integer? "Maximum number of measures expanded in
226 (extra-X-extent ,number-pair? "A grob is enlarged in
227 X@tie{}dimension by this much.")
228 (extra-Y-extent ,number-pair? "A grob is enlarged in
229 Y@tie{}dimension by this much.")
231 (extra-dy ,number? "Slope glissandi this much extra.")
232 (extra-offset ,number-pair? "A pair representing an offset. This
233 offset is added just before outputting the symbol, so the typesetting
234 engine is completely oblivious to it. The values are measured in
235 @code{staff-space} units of the staff's @code{StaffSymbol}.")
236 (extra-spacing-height ,number-pair? "In the horizontal spacing
237 problem, we increase the height of each item by this amount (by adding
238 the @q{car} to the bottom of the item and adding the @q{cdr} to the
239 top of the item). In order to make a grob infinitely high (to prevent
240 the horizontal spacing problem from placing any other grobs above or
241 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
242 (extra-spacing-width ,number-pair? "In the horizontal spacing
243 problem, we pad each item by this amount (by adding the @q{car} on the
244 left side of the item and adding the @q{cdr} on the right side of the
245 item). In order to make a grob take up no horizontal space at all,
246 set this to @code{(+inf.0 . -inf.0)}.")
252 (flag ,ly:stencil? "A function returning the full flag stencil
253 for the @code{Stem}, which is passed to the function as the only
254 argument. The default ly:stem::calc-stencil function uses the
255 @code{flag-style} property to determine the correct glyph for the
256 flag. By providing your own function, you can create arbitrary
258 (flag-count ,number? "The number of tremolo beams.")
259 (flag-style ,symbol? "A symbol determining what style of flag
260 glyph is typeset on a @code{Stem}. Valid options include @code{'()}
261 for standard flags, @code{'mensural} and @code{'no-flag}, which
262 switches off the flag.")
263 (font-encoding ,symbol? "The font encoding is the broadest
264 category for selecting a font. Currently, only lilypond's system
265 fonts (Emmentaler and Aybabtu) are using this property. Available
266 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces} (Aybabtu),
267 @code{fetaNumber} (Emmentaler), and @code{fetaDynamic} (Emmentaler).")
268 (font-family ,symbol? "The font family is the broadest category
269 for selecting text fonts. Options include: @code{sans},
271 (font-name ,string? "Specifies a file name (without extension) of
272 the font to load. This setting overrides selection using
273 @code{font-family}, @code{font-series} and @code{font-shape}.")
274 (font-series ,symbol? "Select the series of a font. Choices
275 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
276 (font-shape ,symbol? "Select the shape of a font. Choices
277 include @code{upright}, @code{italic}, @code{caps}.")
278 (font-size ,number? "The font size, compared to the
279 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
280 @code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
281 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
282 larger. Fractional values are allowed.")
283 (force-hshift ,number? "This specifies a manual shift for notes
284 in collisions. The unit is the note head width of the first voice
285 note. This is used by @rinternals{note-collision-interface}.")
286 (fraction ,number-pair? "Numerator and denominator of a time
288 (french-beaming ,boolean? "Use French beaming style for this
289 stem. The stem stops at the innermost beams.")
290 (fret-diagram-details ,list? "An alist of detailed grob
291 properties for fret diagrams. Each alist entry consists of a
292 @code{(@var{property} . @var{value})} pair. The properties which can
293 be included in @code{fret-diagram-details} include the following:
297 @code{barre-type} -- Type of barre indication used. Choices include
298 @code{curved}, @code{straight}, and @code{none}. Default
301 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
302 fret-space. Default value@tie{}0.5.
304 @code{dot-color} -- Color of dots. Options include @code{black} and
305 @code{white}. Default @code{black}.
307 @code{dot-label-font-mag} -- Magnification for font used to label fret
308 dots. Default value@tie{}1.
310 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
311 dots without labels, 0.95-@code{dot-radius} for dots with labels.
313 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
314 value 0.425 for labeled dots, 0.25 for unlabeled dots.
316 @code{finger-code} -- Code for the type of fingering indication used.
317 Options include @code{none}, @code{in-dot}, and @code{below-string}.
318 Default @code{none} for markup fret diagrams, @code{below-string} for
319 @code{FretBoards} fret diagrams.
321 @code{fret-count} -- The number of frets. Default@tie{}4.
323 @code{fret-label-font-mag} -- The magnification of the font used to
324 label the lowest fret number. Default@tie{}0.5.
326 @code{fret-label-vertical-offset} -- The offset of the fret label from
327 the center of the fret in direction parallel to strings.
330 @code{label-dir} -- Side to which the fret label is attached.
331 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1},
332 @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}.
334 @code{mute-string} -- Character string to be used to indicate muted
335 string. Default @code{\"x\"}.
337 @code{number-type} -- Type of numbers to use in fret label. Choices
338 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.
339 Default @code{roman-lower}.
341 @code{open-string} -- Character string to be used to indicate open
342 string. Default @code{\"o\"}.
344 @code{orientation} -- Orientation of fret-diagram. Options include
345 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
346 Default @code{normal}.
348 @code{string-count} -- The number of strings. Default@tie{}6.
350 @code{string-label-font-mag} -- The magnification of the font used to
351 label fingerings at the string, rather than in the dot. Default value
352 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
353 @code{opposing-landscape}.
355 @code{string-thickness-factor} -- Factor for changing thickness of
356 each string in the fret diagram. Thickness of string @var{k} is given
358 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
361 @code{top-fret-thickness} -- The thickness of the top fret line, as a
362 multiple of the standard thickness. Default value@tie{}3.
364 @code{xo-font-magnification} -- Magnification used for mute and open
365 string indicators. Default value@tie{}0.5.
367 @code{xo-padding} -- Padding for open and mute indicators from top
368 fret. Default value 0.25.
370 ;; ugh: double, change.
371 (full-length-padding ,number? "How much padding to use at the
372 right side of a full-length tuplet bracket.")
373 (full-length-to-extent ,boolean? "Run to the extent of the column
374 for a full-length tuplet bracket.")
375 (full-measure-extra-space ,number? "Extra space that is allocated
376 at the beginning of a measure with only one note. This property is
377 read from the NonMusicalPaperColumn that begins the measure.")
378 (full-size-change ,boolean? "Don't make a change clef smaller.")
384 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
385 (gap-count ,integer? "Number of gapped beams for tremolo.")
386 (glyph ,string? "A string determining what @q{style} of glyph is
387 typeset. Valid choices depend on the function that is reading this
389 (glyph-name-alist ,list? "An alist of key-string pairs.")
390 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
396 (hair-thickness ,number? "Thickness of the thin line in a bar
398 (harp-pedal-details ,list? "An alist of detailed grob properties
399 for harp pedal diagrams. Each alist entry consists of a
400 @code{(@var{property} . @var{value})} pair. The properties which can
401 be included in harp-pedal-details include the following:
405 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
406 boxes above/below the horizontal line. Default value@tie{}0.8.
408 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
410 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
412 @code{space-before-divider} -- Space between boxes before the first
413 divider (so that the diagram can be made symmetric). Default
416 @code{space-after-divider} -- Space between boxes after the first
417 divider. Default value@tie{}0.8.
419 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
420 of the ellipse around circled pedals. Default value@tie{}0.5.
422 @code{circle-x-padding} -- Padding in X direction of the ellipse
423 around circled pedals. Default value 0.15.
425 @code{circle-y-padding} -- Padding in Y direction of the ellipse
426 around circled pedals. Default value@tie{}0.2.
428 (head-direction ,ly:dir? "Are the note heads left or right in a
430 (height ,ly:dimension? "Height of an object in @code{staff-space}
432 (height-limit ,ly:dimension? "Maximum slur height: The longer the
433 slur, the closer it is to this height.")
434 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
435 that appears on a tied note after a line break will not be displayed.")
436 (horizontal-shift ,integer? "An integer that identifies ranking
437 of @code{NoteColumn}s for horizontal shifting. This is used by
438 @rinternals{note-collision-interface}.")
439 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
440 left and one to the right of this grob.")
446 (ignore-collision ,boolean? "If set, don't do note collision
447 resolution on this @code{NoteColumn}.")
448 (implicit ,boolean? "Is this an implicit bass figure?")
449 (inspect-index ,integer? "If debugging is set, set beam and slur
450 configuration to this index, and print the respective scores.")
451 (inspect-quants ,number-pair? "If debugging is set, set beam and
452 slur quants to this position, and print the respective scores.")
458 (keep-fixed-while-stretching ,boolean? "A grob with this property
459 set to true is fixed relative to the staff above it when systems are
461 (keep-inside-line ,boolean? "If set, this column cannot have
462 objects sticking into the margin.")
463 (kern ,ly:dimension? "Amount of extra white space to add. For
464 bar lines, this is the amount of space after a thick line.")
465 (knee ,boolean? "Is this beam kneed?")
466 (knee-spacing-correction ,number? "Factor for the optical
467 correction amount for kneed beams. Set between @code{0} for no
468 correction and @code{1} for full correction.")
474 (labels ,list? "List of labels (symbols) placed on a column.")
475 (layer ,integer? "The output layer (a value between 0
476 and@tie{}2): Layers define the order of printing objects. Objects in
477 lower layers are overprinted by objects in higher layers.")
478 (ledger-line-thickness ,number-pair? "The thickness of ledger
479 lines. It is the sum of 2@tie{}numbers: The first is the factor for
480 line thickness, and the second for staff space. Both contributions
482 (left-bound-info ,list? "An alist of properties for determining
483 attachments of spanners to edges.")
484 (left-padding ,ly:dimension? "The amount of space that is put
485 left to an object (e.g., a group of accidentals).")
486 (length ,ly:dimension? "User override for the stem length of
488 (length-fraction ,number? "Multiplier for lengths. Used for
489 determining ledger lines and stem lengths.")
490 (line-break-penalty ,number? "Penalty for a line break at this
491 column. This affects the choices of the line breaker; it avoids a
492 line break at a column with a positive penalty and prefers a line
493 break at a column with a negative penalty.")
494 (line-break-permission ,symbol? "Instructs the line breaker on
495 whether to put a line break at this column. Can be @code{force} or
497 (line-break-system-details ,list? "An alist of properties to use
498 if this column is the start of a system.")
499 (line-count ,integer? "The number of staff lines.")
500 (line-positions ,list? "Vertical positions of staff lines.")
501 (line-thickness ,number? "The thickness of the tie or slur
503 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
509 (max-beam-connect ,integer? "Maximum number of beams to connect
510 to beams from this stem. Further beams are typeset as beamlets.")
511 (max-stretch ,number? "The maximum amount that this
512 @code{VerticalAxisGroup} can be vertically stretched (for example, in
513 order to better fill a page).")
514 (measure-count ,integer? "The number of measures for a
515 multi-measure rest.")
516 (measure-length ,ly:moment? "Length of a measure. Used in some
517 spacing situations.")
518 (merge-differently-dotted ,boolean? "Merge note heads in
519 collisions, even if they have a different number of dots. This is
520 normal notation for some types of polyphonic music.
522 @code{merge-differently-dotted} only applies to opposing stem
523 directions (i.e., voice 1 &@tie{}2).")
524 (merge-differently-headed ,boolean? "Merge note heads in
525 collisions, even if they have different note heads. The smaller of
526 the two heads is rendered invisible. This is used in polyphonic
527 guitar notation. The value of this setting is used by
528 @rinternals{note-collision-interface}.
530 @code{merge-differently-headed} only applies to opposing stem
531 directions (i.e., voice 1 &@tie{}2).")
532 (minimum-X-extent ,number-pair? "Minimum size of an object in
533 X@tie{}dimension, measured in @code{staff-space} units.")
534 (minimum-Y-extent ,number-pair? "Minimum size of an object in
535 Y@tie{}dimension, measured in @code{staff-space} units.")
536 (minimum-distance ,ly:dimension? "Minimum distance between rest
538 (minimum-length ,ly:dimension? "Try to make a spanner at least
539 this long, normally in the horizontal direction. This requires an
540 appropriate callback for the @code{springs-and-rods} property. If
541 added to a @code{Tie}, this sets the minimum distance between
543 (minimum-length-fraction ,number? "Minimum length of ledger line
544 as fraction of note head size.")
545 (minimum-space ,ly:dimension? "Minimum distance that the victim
546 should move (after padding).")
552 (neutral-direction ,ly:dir? "Which direction to take in the
553 center of the staff.")
554 (neutral-position ,number? "Position (in half staff spaces) where
555 to flip the direction of custos stem.")
556 (next ,ly:grob? "Object that is next relation (e.g., the lyric
557 syllable following an extender).")
558 (no-alignment ,boolean? "If set, don't place this grob in a
559 @code{VerticalAlignment}; rather, place it using its own
560 @code{Y-offset} callback.")
561 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
563 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
564 get stems extending to the middle staff line.")
565 (non-default ,boolean? "Set for manually specified clefs.")
566 (non-musical ,boolean? "True if the grob belongs to a
567 @code{NonMusicalPaperColumn}.")
568 (note-names ,vector? "Vector of strings containing names for
569 easy-notation note heads.")
575 (outside-staff-horizontal-padding ,number? "By default, an
576 outside-staff-object can be placed so that is it very close to another
577 grob horizontally. If this property is set, the outside-staff-object
578 is raised so that it is not so close to its neighbor.")
579 (outside-staff-padding ,number? "The padding to place between
580 this grob and the staff when spacing according to
581 @code{outside-staff-priority}.")
582 (outside-staff-priority ,number? "If set, the grob is positioned
583 outside the staff in such a way as to avoid all collisions. In case
584 of a potential collision, the grob with the smaller
585 @code{outside-staff-priority} is closer to the staff.")
591 (packed-spacing ,boolean? "If set, the notes are spaced as
592 tightly as possible.")
593 (padding ,ly:dimension? "Add this much extra space between
594 objects that are next to each other.")
595 (padding-pairs ,list? "An alist mapping @code{(@var{name}
596 . @var{name})} to distances.")
597 (page-break-penalty ,number? "Penalty for page break at this
598 column. This affects the choices of the page breaker; it avoids a
599 page break at a column with a positive penalty and prefers a page
600 break at a column with a negative penalty.")
601 (page-break-permission ,symbol? "Instructs the page breaker on
602 whether to put a page break at this column. Can be @code{force} or
604 (page-turn-penalty ,number? "Penalty for a page turn at this
605 column. This affects the choices of the page breaker; it avoids a
606 page turn at a column with a positive penalty and prefers a page turn
607 at a column with a negative penalty.")
608 (page-turn-permission ,symbol? "Instructs the page breaker on
609 whether to put a page turn at this column. Can be @code{force} or
611 (parenthesized ,boolean? "Parenthesize this grob.")
612 (positions ,number-pair? "Pair of staff coordinates
613 @code{(@var{left} . @var{right})}, where both @var{left} and
614 @var{right} are in @code{staff-space} units of the current staff. For
615 slurs, this value selects which slur candidate to use; if extreme
616 positions are requested, the closest one is taken.")
617 (prefer-dotted-right ,boolean? "For note collisions, prefer to
618 shift dotted up-note to the right, rather than shifting just the
625 (ratio ,number? "Parameter for slur shape. The higher this
626 number, the quicker the slur attains its @code{height-limit}.")
627 (remove-empty ,boolean? "If set, remove group if it contains no
629 (remove-first ,boolean? "Remove the first staff of an orchestral
631 (restore-first ,boolean? "Print a natural before the
633 (rhythmic-location ,rhythmic-location? "Where (bar number,
634 measure position) in the score.")
635 (right-bound-info ,list? "An alist of properties for determining
636 attachments of spanners to edges.")
637 (right-padding ,ly:dimension? "Space to insert on the right side
638 of an object (e.g., between note and its accidentals).")
639 (rotation ,list? "Number of degrees to rotate this object, and
640 what point to rotate around. For example, @code{#'(45 0 0)} rotates
641 by 45 degrees around the center of this object.")
647 (same-direction-correction ,number? "Optical correction amount
648 for stems that are placed in tight configurations. This amount is
649 used for stems with the same direction to compensate for note head to
651 (script-priority ,number? "A sorting key that determines in what
652 order a script is within a stack of scripts.")
653 (self-alignment-X ,number? "Specify alignment of an object. The
654 value @code{-1} means left aligned, @code{0}@tie{}centered, and
655 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
656 values may also be specified.")
657 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
659 (toward-stem-shift ,number? "Amount by which scripts are shifted
660 toward the stem if their direction coincides with the stem direction.
661 @code{0.0} means keep the default position (centered on the note
662 head), @code{1.0} means centered on the stem. Interpolated values are
664 (shorten-pair ,number-pair? "The lengths to shorten a
665 text-spanner on both sides, for example a pedal bracket. Positive
666 values shorten the text-spanner, while negative values lengthen it.")
667 (shortest-duration-space ,ly:dimension? "Start with this much
668 space for the shortest duration. This is expressed in
669 @code{spacing-increment} as unit. See also
670 @rinternals{spacing-spanner-interface}.")
671 (shortest-playing-duration ,ly:moment? "The duration of the
672 shortest note playing here.")
673 (shortest-starter-duration ,ly:moment? "The duration of the
674 shortest note that starts here.")
675 (side-axis ,number? "If the value is @code{#X} (or
676 equivalently@tie{}@code{0}), the object is placed horizontally next to
677 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is
679 (side-relative-direction ,ly:dir? "Multiply direction of
680 @code{direction-source} with this to get the direction of this
682 (size ,number? "Size of object, relative to standard size.")
683 (skyline-horizontal-padding ,number? "For determining the
684 vertical distance between two staves, it is possible to have a
685 configuration which would result in a tight interleaving of grobs from
686 the top staff and the bottom staff. The larger this parameter is, the
687 farther apart the staves are placed in such a configuration.")
688 (slash-negative-kern ,number? "The space to remove between
689 slashes in percent repeat glyphs. Larger values bring the two
690 elements closer together.")
691 (slope ,number? "The slope of this object.")
692 (slur-padding ,number? "Extra distance between slur and script.")
693 (space-alist ,list? "A table that specifies distances between
694 prefatory items, like clef and time-signature. The format is an alist
695 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
696 . @var{distance})}, where @var{type} can be the symbols
697 @code{minimum-space} or @code{extra-space}.")
698 (space-to-barline ,boolean? "If set, the distance between a note
699 and the following non-musical column will be measured to the bar line
700 instead of to the beginning of the non-musical column. If there is a
701 clef change followed by a bar line, for example, this means that we
702 will try to space the non-musical column as though the clef is not
704 (spacing-increment ,number? "Add this much space for a doubled
705 duration. Typically, the width of a note head. See also
706 @rinternals{spacing-spanner-interface}.")
707 (springs-and-rods ,boolean? "Dummy variable for triggering
709 (stacking-dir ,ly:dir? "Stack objects in which direction?")
710 (staff-padding ,ly:dimension? "Maintain this much space between
711 reference points and the staff. Its effect is to align objects of
712 differing sizes (like the dynamics @b{p} and @b{f}) on their
714 (staff-position ,number? "Vertical position, measured in half
715 staff spaces, counted from the middle line.")
716 (staff-space ,ly:dimension? "Amount of space between staff lines,
717 expressed in global @code{staff-space}.")
718 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
719 pair where the stem attaches to the notehead.")
720 (stem-end-position ,number? "Where does the stem end (the end is
721 opposite to the support-head)?")
723 (stem-spacing-correction ,number? "Optical correction amount for
724 stems that are placed in tight configurations. For opposite
725 directions, this amount is the correction for two normal sized stems
726 that overlap completely.")
727 (stemlet-length ,number? "How long should be a stem over a
729 (stencil ,ly:stencil? "The symbol to print.")
730 (stencils ,list? "Multiple stencils, used as intermediate
732 (strict-grace-spacing ,boolean? "If set, main notes are spaced
733 normally, then grace notes are put left of the musical columns for the
735 (strict-note-spacing ,boolean? "If set, unbroken columns with
736 non-musical material (clefs, bar lines, etc.) are not spaced
737 separately, but put before musical columns.")
738 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
740 (style ,symbol? "This setting determines in what style a grob is
741 typeset. Valid choices depend on the @code{stencil} callback reading
748 (text ,markup? "Text markup. See @ruser{Formatting text}.")
749 ;;FIXME -- Should both be the same?
750 (text-direction ,ly:dir? "This controls the ordering of the
751 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
752 should use @code{LEFT}.")
753 (thick-thickness ,number? "Bar line thickness, measured in
754 @code{line-thickness}.")
755 (thickness ,number? "Line thickness, generally measured in
756 @code{line-thickness}.")
757 (thin-kern ,number? "The space after a hair-line in a bar line.")
758 (threshold ,number-pair? "@code{(@var{min} . @var{max})}, where
759 @var{min} and @var{max} are dimensions in staff space.")
760 (tie-configuration ,list? "List of @code{(@var{position} .
761 @var{dir})} pairs, indicating the desired tie configuration, where
762 @var{position} is the offset from the center of the staff in staff
763 space and @var{dir} indicates the direction of the tie
764 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
765 in the list causes the corresponding tie to be formatted
767 (to-barline ,boolean? "If true, the spanner will stop at the bar
768 line just before it would otherwise stop.")
769 (transparent ,boolean? "This makes the grob invisible.")
775 (uniform-stretching ,boolean? "If set, items stretch
776 proportionally to their durations. This looks better in complex
777 polyphonic patterns.")
778 (used ,boolean? "If set, this spacing column is kept in the
785 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
786 one below this grob.")
792 (when ,ly:moment? "Global time step associated with this column
794 (width ,ly:dimension? "The width of a grob measured in staff
796 (word-space ,ly:dimension? "Space to insert between words in
803 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
804 (X-offset ,number? "The horizontal amount that this object is
805 moved relative to its X-parent.")
811 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
812 (Y-offset ,number? "The vertical amount that this object is moved
813 relative to its Y-parent.")
818 (zigzag-length ,ly:dimension? "The length of the lines of a
819 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
820 gives 60-degree zigzags.")
821 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
822 This number is adjusted slightly so that the glissando line can be
823 constructed from a whole number of squiggles.")
831 (define (define-internal-grob-property symbol type? description)
832 (define-grob-property symbol type? description)
833 (set-object-property! symbol 'backend-internal #t)
838 (define-public all-internal-grob-properties
841 (apply define-internal-grob-property x))
845 ;; grobs & grob arrays. (alphabetical)
846 (X-common ,ly:grob? "Common reference point for axis group.")
848 (Y-common ,ly:grob? "See @code{X-common}.")
850 (accidental-grob ,ly:grob? "The accidental for this note.")
851 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
852 @var{groblist})} entries.")
853 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
854 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
856 (adjacent-hairpins ,ly:grob-array? "A list of directly neighboring
858 (all-elements ,ly:grob-array? "A list of all grobs in this line. Its
859 function is to protect objects from being garbage collected.")
860 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
861 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
862 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
864 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
865 This may differ from @code{Y-extent} because it does not include the dots in
867 (bars ,ly:grob-array? "A list of bar line pointers.")
868 (beam ,ly:grob? "A pointer to the beam, if applicable.")
869 (bounded-by-me ,ly:grob-array? "A list of spanners that have this
870 column as start/begin point. Only columns that have grobs or act as
872 (bracket ,ly:grob? "The bracket for a number.")
874 (columns ,ly:grob-array? "A list of grobs, typically containing
875 @code{PaperColumn} or @code{NoteColumn} objects.")
876 (conditional-elements ,ly:grob-array? "Internal use only.")
877 (cross-staff ,boolean? "For a beam or a stem, this is true if we
878 depend on inter-staff spacing.")
880 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
881 set, which grob to get the direction from.")
882 (dot ,ly:grob? "A reference to a @code{Dots} object.")
883 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
885 (elements ,ly:grob-array? "A list of grobs; the type is depending on
886 the grob where this is set in.")
887 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
888 in addition to notes and stems.")
890 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
891 (forced ,boolean? "Manually forced accidental.")
893 (glyph-name ,string? "The glyph name within the font.")
894 (grace-spacing ,ly:grob? "A run of grace notes.")
896 (heads ,ly:grob-array? "A list of note heads.")
898 (important-column-ranks ,vector? "A cache of columns that contain
899 @code{items-worth-living} data.")
900 (items-worth-living ,ly:grob-array? "A list of interesting items. If
901 empty in a particular staff, then that staff is erased.")
903 (left-items ,ly:grob-array? "DOCME")
904 (left-neighbors ,ly:grob-array? "A list of @code{spacing-wishes} grobs
905 that are close to the current column.
907 The closest @code{spacing-wishes} determine the actual distances between the
910 (normal-stems ,ly:grob-array? "An array of visible stems.")
911 (note-columns ,pair? "A list of @code{NoteColumn} grobs.")
912 (note-head ,ly:grob? "A single note head.")
913 (note-heads ,ly:grob-array? "A list of note head grobs.")
914 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
916 (pure-Y-common ,ly:grob? "A cache of the
917 @code{common_refpoint_of_array} of the @code{elements} grob set.")
918 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
919 cyclic dependencies.")
920 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
921 relevant for finding the @code{pure-Y-extent}.")
922 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
923 relevant for finding the @code{pure-Y-extent}.")
925 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
926 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
927 (rests ,ly:grob-array? "A list of rest objects.")
928 (right-items ,ly:grob-array? "DOCME")
929 (right-neighbors ,ly:grob-array? "See @code{left-neighbors}.")
931 (separation-item ,ly:grob? "A separation item.")
932 (side-support-elements ,ly:grob-array? "The side support, a list of
934 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
935 (spaceable-staves ,ly:grob-array? "Objects to be spaced during page
937 (spacing ,ly:grob? "The spacing spanner governing this section.")
938 (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing
940 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
941 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
942 (stems ,ly:grob-array? "A list of stem objects, corresponding to the
943 notes that the arpeggio has to be before.")
945 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
946 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
947 (tuplet-number ,ly:grob? "The number for a bracket.")
948 (tuplets ,ly:grob-array? "A list of smaller tuplet brackets.")
952 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
953 @code{FretBoard} be visible only at beginning of line or at
956 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
957 translator) that was the cause for this grob.")
959 (delta-position ,number? "The vertical position difference.")
961 (font ,ly:font-metric? "A cached font metric object.")
963 (head-width ,ly:dimension? "The width of this ligature head.")
965 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
966 @var{strength}))} pairs.")
967 (interfaces ,list? "A list of symbols indicating the interfaces
968 supported by this object. It is initialized from the @code{meta} field.")
970 (least-squares-dy ,number? "The ideal beam slope, without damping.")
972 (meta ,list? "Provide meta information. It is an alist with the
973 entries @code{name} and @code{interfaces}.")
974 (minimum-distances ,list? "A list of rods that have the format
975 @code{(@var{obj} . @var{dist})}.")
977 (positioning-done ,boolean? "Used to signal that a positioning element
978 did its job. This ensures that a positioning is only done once.")
979 (pure-Y-extent ,number-pair? "The estimated height of a system.")
981 (quant-score ,string? "The beam quanting score; stored for
983 (quantize-position ,boolean? "If set, a vertical alignment is aligned
984 to be within staff spaces.")
985 (quantized-positions ,number-pair? "The beam positions after
988 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
989 acts as an index for looking up a @code{Stencil} object.")
990 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
991 Internally used to distribute beam shortening over stems.")
992 (skyline-distance ,number? "The distance between this staff and the
993 next one, as determined by a skyline algorithm.")
994 (stem-info ,pair? "A cache of stem parameters.")
996 (use-breve-rest ,boolean? "Use breve rests for measures longer
1003 ;; There are too many properties for ancient notation;
1004 ;; probably neume-types (a list of symbols) would also work.
1006 ;; However, such a list would consist of a couple of dozens of
1007 ;; entries, since head prefixes may be combined in many ways. If
1008 ;; the macros in `gregorian.ly' would directly set prefix-set,
1009 ;; all the head prefixes could be junked; however, such macros
1010 ;; would be quite numerous, I guess. --jr
1012 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1014 (add-join ,boolean? "Is this ligature head-joined with the next one
1015 by a vertical line?")
1016 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1017 an additional stem on the right side?")
1018 (ascendens ,boolean? "Is this neume of ascending type?")
1019 (auctum ,boolean? "Is this neume liquescentically augmented?")
1021 (cavum ,boolean? "Is this neume outlined?")
1022 (context-info ,integer? "Within a ligature, the final glyph or shape of
1023 a head may be affected by the left and/or right neighbour head.
1024 @code{context-info} holds for each head such information about the left and
1025 right neighbour, encoded as a bit mask.")
1027 (descendens ,boolean? "Is this neume of descendent type?")
1028 (deminutum ,boolean? "Is this neume deminished?")
1030 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1031 grob (in @code{staff-space} units).")
1032 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1033 ligature grob in (in @code{staff-space} units).")
1035 (inclinatum ,boolean? "Is this neume an inclinatum?")
1037 (join-heads ,boolean? "Whether to join the note heads of an ambitus
1038 grob with a vertical line.")
1039 (join-right-amount ,number? "DOCME")
1041 (linea ,boolean? "Attach vertical lines to this neume?")
1043 (oriscus ,boolean? "Is this neume an oriscus?")
1045 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1047 (prefix-set ,number? "A bit mask that holds all Gregorian head
1048 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1049 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1050 similar to a note head that is part of a ligature.")
1052 (quilisma ,boolean? "Is this neume a quilisma?")
1054 (stropha ,boolean? "Is this neume a stropha?")
1056 (virga ,boolean? "Is this neume a virga?")
1058 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1062 (define-public all-backend-properties
1064 all-internal-grob-properties
1065 all-user-grob-properties))