1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
6 ;;;; LilyPond is free software: you can redistribute it and/or modify
7 ;;;; it under the terms of the GNU General Public License as published by
8 ;;;; the Free Software Foundation, either version 3 of the License, or
9 ;;;; (at your option) any later version.
11 ;;;; LilyPond is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;;; GNU General Public License for more details.
16 ;;;; You should have received a copy of the GNU General Public License
17 ;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
19 (define (define-grob-property symbol type? description)
20 (if (not (equal? (object-property symbol 'backend-doc) #f))
21 (ly:error (_ "symbol ~S redefined") symbol))
23 (set-object-property! symbol 'backend-type? type?)
24 (set-object-property! symbol 'backend-doc description)
27 ;; put this in an alist?
29 all-user-grob-properties
33 (apply define-grob-property x))
39 (add-stem-support ,boolean? "If set, the @code{Stem} object is
40 included in this script's support.")
41 (after-line-breaking ,boolean? "Dummy property, used to trigger
42 callback for @code{after-line-breaking}.")
43 (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
44 @code{0}: around center of width, @code{1}: right side.")
45 (allow-loose-spacing ,boolean? "If set, column can be detached
47 (allow-span-bar ,boolean? "If false, no inter-staff bar line will
48 be created below this bar line.")
49 (alteration ,number? "Alteration numbers for accidental.")
50 (alteration-alist ,list? "List of @code{(@var{pitch}
51 . @var{accidental})} pairs for key signature.")
52 (annotation ,string? "Annotate a grob for debug purposes.")
53 (arpeggio-direction ,ly:dir? "If set, put an arrow on the
54 arpeggio squiggly line.")
55 (arrow-length ,number? "Arrow length.")
56 (arrow-width ,number? "Arrow width.")
57 (auto-knee-gap ,ly:dimension? "If a gap is found between note
58 heads where a horizontal beam fits that is larger than this number,
60 (average-spacing-wishes ,boolean? "If set, the spacing wishes are
61 averaged over staves.")
62 (avoid-note-head ,boolean? "If set, the stem of a chord does not
63 pass through all note heads, but starts at the last note head.")
64 (avoid-slur ,symbol? "Method of handling slur collisions.
65 Choices are @code{inside}, @code{outside}, @code{around}, and
66 @code{ignore}. @code{inside} adjusts the slur if needed to keep the
67 grob inside the slur. @code{outside} moves the grob vertically to the
68 outside of the slur. @code{around} moves the grob vertically to the
69 outside of the slur only if there is a collision. @code{ignore} does
70 not move either. In grobs whose notational significance depends on
71 vertical position (such as accidentals, clefs, etc.), @code{outside}
72 and @code{around} behave like @code{ignore}.")
73 (axes ,list? "List of axis numbers. In the case of alignment
74 grobs, this should contain only one number.")
80 (bar-size ,ly:dimension? "The size of a bar line.")
81 (base-shortest-duration ,ly:moment? "Spacing is based on the
82 shortest notes in a piece. Normally, pieces are spaced as if notes at
83 least as short as this are present.")
84 (baseline-skip ,ly:dimension? "Distance between base lines of
85 multiple lines of text.")
86 (beam-thickness ,ly:dimension? "Beam thickness, measured in
87 @code{staff-space} units.")
88 (beam-width ,ly:dimension? "Width of the tremolo sign.")
89 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
90 when their direction is forced. It is a list, since the value is
91 different depending on the number of flags and beams.")
92 (beaming ,pair? "Pair of number lists. Each number list
93 specifies which beams to make. @code{0}@tie{}is the central beam,
94 @code{1}@tie{}is the next beam toward the note, etc. This information
95 is used to determine how to connect the beaming patterns from stem to
97 (beamlet-default-length ,pair? "A pair of numbers. The first
98 number specifies the default length of a beamlet that sticks out of
99 the left hand side of this stem; the second number specifies the
100 default length of the beamlet to the right. The actual length of a
101 beamlet is determined by taking either the default length or the
102 length specified by @code{beamlet-max-length-proportion}, whichever is
104 (beamlet-max-length-proportion ,pair? "The maximum length of a
105 beamlet, as a proportion of the distance between two adjacent stems.")
106 (before-line-breaking ,boolean? "Dummy property, used to trigger
107 a callback function.")
108 (between-cols ,pair? "Where to attach a loose column to.")
109 (bound-details ,list? "An alist of properties for determining
110 attachments of spanners to edges.")
111 (bound-padding ,number? "The amount of padding to insert around
113 (bracket-flare ,number-pair? "A pair of numbers specifying how
114 much edges of brackets should slant outward. Value @code{0.0} means
116 (bracket-visibility ,boolean-or-symbol? "This controls the
117 visibility of the tuplet bracket. Setting it to false prevents
118 printing of the bracket. Setting the property to @code{if-no-beam}
119 makes it print only if there is no beam associated with this tuplet
121 (break-align-anchor ,number? "Grobs aligned to this break-align
122 grob will have their X-offsets shifted by this number. In bar lines,
123 for example, this is used to position grobs relative to the (visual)
124 center of the bar line.")
125 (break-align-anchor-alignment ,number? "Read by
126 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
127 aligning an anchor to a grob's extent.")
128 (break-align-orders ,vector? "Defines the order in which
129 prefatory matter (clefs, key signatures) appears. The format is a
130 vector of length@tie{}3, where each element is one order for
131 end-of-line, middle of line, and start-of-line, respectively. An
132 order is a list of symbols.
134 For example, clefs are put after key signatures by setting
137 \\override Score.BreakAlignment #'break-align-orders =
138 #(make-vector 3 '(span-bar
145 (break-align-symbol ,symbol? "This key is used for aligning and
146 spacing breakable items.")
147 (break-align-symbols ,list? "A list of symbols that determine
148 which break-aligned grobs to align this to. If the grob selected by
149 the first symbol in the list is invisible due to break-visibility, we
150 will align to the next grob (and so on). Choices are @code{left-edge},
151 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar},
152 @code{key-cancellation}, @code{key-signature}, @code{time-signature},
154 (break-overshoot ,number-pair? "How much does a broken spanner
155 stick out of its bounds?")
156 (break-visibility ,vector? "A vector of 3@tie{}booleans,
157 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
158 @code{#t} means visible, @code{#f} means killed.")
159 (breakable ,boolean? "Allow breaks here.")
165 (c0-position ,integer? "An integer indicating the position of
167 (circled-tip ,boolean? "Put a circle at start/end of
168 hairpins (al/del niente).")
169 (clip-edges ,boolean? "Allow outward pointing beamlets at the
171 (collapse-height ,ly:dimension? "Minimum height of system start
172 delimiter. If equal or smaller, the bracket/brace/line is removed.")
173 (color ,color? "The color of this grob.")
174 (common-shortest-duration ,ly:moment? "The most common shortest
175 note length. This is used in spacing. Enlarging this sets the score
177 (concaveness ,number? "A beam is concave if its inner stems are
178 closer to the beam than the two outside stems. This number is a
179 measure of the closeness of the inner stems. It is used for damping
180 the slope of the beam.")
181 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
182 this grob looks as a continued break.")
183 (control-points ,list? "List of offsets (number pairs) that form
184 control points for the tie, slur, or bracket shape. For B@'eziers,
185 this should list the control points of a third-order B@'ezier curve.")
191 (damping ,number? "Amount of beam slope damping.")
192 (dash-definition ,pair? "List of @code{dash-elements} defining the
193 dash structure. Each @code{dash-element} has a starting t value,
194 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
195 (dash-fraction ,number? "Size of the dashes, relative to
196 @code{dash-period}. Should be between @code{0.0} (no line) and
197 @code{1.0} (continuous line).")
198 (dash-period ,number? "The length of one dash together with
199 whitespace. If negative, no line is drawn at all.")
200 (default-direction ,ly:dir? "Direction determined by note head
202 (default-staff-staff-spacing ,list? "An alist of spacing variables
203 that controls the spacing between this staff and the next.
204 See @var{staff-staff-spacing} for a description of the elements of
206 (details ,list? "Alist of parameters for detailed grob behavior.
207 More information on the allowed parameters for a grob can be found by
208 looking at the top of the Internals Reference page for each interface
209 having a @code{details} property.")
210 (digit-names ,vector? "Names for string finger digits.")
211 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
212 @code{#X}), then this property determines whether the object is placed
213 @code{#LEFT}, @code{#CENTER} or @code{#RIGHT} with respect to the
214 other object. Otherwise, it determines whether the object is placed
215 @code{#UP}, @code{#CENTER} or @code{#DOWN}. Numerical values may also
216 be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
217 @code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1},
218 @code{#CENTER}=@code{0}.")
219 (dot-count ,integer? "The number of dots.")
220 (dot-negative-kern ,number? "The space to remove between a dot
221 and a slash in percent repeat glyphs. Larger values bring the two
222 elements closer together.")
223 (dot-placement-list ,list? "List consisting of
224 @code{(@var{description} @var{string-number} @var{fret-number}
225 @var{finger-number})} entries used to define fret diagrams.")
226 (duration-log ,integer? "The 2-log of the note head duration,
227 i.e., @code{0} = whole note, @code{1} = half note, etc.")
233 (eccentricity ,number? "How asymmetrical to make a slur.
234 Positive means move the center to the right.")
235 (edge-height ,pair? "A pair of numbers specifying the heights of
236 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
237 (edge-text ,pair? "A pair specifying the texts to be set at the
238 edges: @code{(@var{left-text} . @var{right-text})}.")
239 (expand-limit ,integer? "Maximum number of measures expanded in
242 (extra-dy ,number? "Slope glissandi this much extra.")
243 (extra-offset ,number-pair? "A pair representing an offset. This
244 offset is added just before outputting the symbol, so the typesetting
245 engine is completely oblivious to it. The values are measured in
246 @code{staff-space} units of the staff's @code{StaffSymbol}.")
247 (extra-spacing-height ,number-pair? "In the horizontal spacing
248 problem, we increase the height of each item by this amount (by adding
249 the @q{car} to the bottom of the item and adding the @q{cdr} to the
250 top of the item). In order to make a grob infinitely high (to prevent
251 the horizontal spacing problem from placing any other grobs above or
252 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
253 (extra-spacing-width ,number-pair? "In the horizontal spacing
254 problem, we pad each item by this amount (by adding the @q{car} on the
255 left side of the item and adding the @q{cdr} on the right side of the
256 item). In order to make a grob take up no horizontal space at all,
257 set this to @code{(+inf.0 . -inf.0)}.")
258 (extra-X-extent ,number-pair? "A grob is enlarged in
259 X@tie{}dimension by this much.")
260 (extra-Y-extent ,number-pair? "A grob is enlarged in
261 Y@tie{}dimension by this much.")
267 (flag ,ly:stencil? "A function returning the full flag stencil
268 for the @code{Stem}, which is passed to the function as the only
269 argument. The default ly:stem::calc-stencil function uses the
270 @code{flag-style} property to determine the correct glyph for the
271 flag. By providing your own function, you can create arbitrary
273 (flag-count ,number? "The number of tremolo beams.")
274 (flag-style ,symbol? "A symbol determining what style of flag
275 glyph is typeset on a @code{Stem}. Valid options include @code{'()}
276 for standard flags, @code{'mensural} and @code{'no-flag}, which
277 switches off the flag.")
278 (font-encoding ,symbol? "The font encoding is the broadest
279 category for selecting a font. Currently, only lilypond's system
280 fonts (Emmentaler) are using this property. Available
281 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces},
282 @code{fetaText} (Emmentaler).")
283 (font-family ,symbol? "The font family is the broadest category
284 for selecting text fonts. Options include: @code{sans},
286 (font-name ,string? "Specifies a file name (without extension) of
287 the font to load. This setting overrides selection using
288 @code{font-family}, @code{font-series} and @code{font-shape}.")
289 (font-series ,symbol? "Select the series of a font. Choices
290 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
291 (font-shape ,symbol? "Select the shape of a font. Choices
292 include @code{upright}, @code{italic}, @code{caps}.")
293 (font-size ,number? "The font size, compared to the
294 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
295 @code{-1} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
296 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
297 larger. Fractional values are allowed.")
298 (force-hshift ,number? "This specifies a manual shift for notes
299 in collisions. The unit is the note head width of the first voice
300 note. This is used by @rinternals{note-collision-interface}.")
301 (fraction ,number-pair? "Numerator and denominator of a time
303 (french-beaming ,boolean? "Use French beaming style for this
304 stem. The stem stops at the innermost beams.")
305 (fret-diagram-details ,list? "An alist of detailed grob
306 properties for fret diagrams. Each alist entry consists of a
307 @code{(@var{property} . @var{value})} pair. The properties which can
308 be included in @code{fret-diagram-details} include the following:
312 @code{barre-type} -- Type of barre indication used. Choices include
313 @code{curved}, @code{straight}, and @code{none}. Default
316 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
317 fret-space. Default value@tie{}0.5.
319 @code{dot-color} -- Color of dots. Options include @code{black} and
320 @code{white}. Default @code{black}.
322 @code{dot-label-font-mag} -- Magnification for font used to label fret
323 dots. Default value@tie{}1.
325 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
326 dots without labels, 0.95-@code{dot-radius} for dots with labels.
328 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
329 value 0.425 for labeled dots, 0.25 for unlabeled dots.
331 @code{finger-code} -- Code for the type of fingering indication used.
332 Options include @code{none}, @code{in-dot}, and @code{below-string}.
333 Default @code{none} for markup fret diagrams, @code{below-string} for
334 @code{FretBoards} fret diagrams.
336 @code{fret-count} -- The number of frets. Default@tie{}4.
338 @code{fret-label-font-mag} -- The magnification of the font used to
339 label the lowest fret number. Default@tie{}0.5.
341 @code{fret-label-vertical-offset} -- The offset of the fret label from
342 the center of the fret in direction parallel to strings.
345 @code{label-dir} -- Side to which the fret label is attached.
346 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1},
347 @code{#RIGHT}, or @code{#UP} for right or up. Default @code{#RIGHT}.
349 @code{mute-string} -- Character string to be used to indicate muted
350 string. Default @code{\"x\"}.
352 @code{number-type} -- Type of numbers to use in fret label. Choices
353 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.
354 Default @code{roman-lower}.
356 @code{open-string} -- Character string to be used to indicate open
357 string. Default @code{\"o\"}.
359 @code{orientation} -- Orientation of fret-diagram. Options include
360 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
361 Default @code{normal}.
363 @code{string-count} -- The number of strings. Default@tie{}6.
365 @code{string-label-font-mag} -- The magnification of the font used to
366 label fingerings at the string, rather than in the dot. Default value
367 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
368 @code{opposing-landscape}.
370 @code{string-thickness-factor} -- Factor for changing thickness of
371 each string in the fret diagram. Thickness of string @var{k} is given
373 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
376 @code{top-fret-thickness} -- The thickness of the top fret line, as a
377 multiple of the standard thickness. Default value@tie{}3.
379 @code{xo-font-magnification} -- Magnification used for mute and open
380 string indicators. Default value@tie{}0.5.
382 @code{xo-padding} -- Padding for open and mute indicators from top
383 fret. Default value 0.25.
385 ;; ugh: double, change.
386 (full-length-padding ,number? "How much padding to use at the
387 right side of a full-length tuplet bracket.")
388 (full-length-to-extent ,boolean? "Run to the extent of the column
389 for a full-length tuplet bracket.")
390 (full-measure-extra-space ,number? "Extra space that is allocated
391 at the beginning of a measure with only one note. This property is
392 read from the NonMusicalPaperColumn that begins the measure.")
393 (full-size-change ,boolean? "Don't make a change clef smaller.")
399 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
400 (gap-count ,integer? "Number of gapped beams for tremolo.")
401 (glyph ,string? "A string determining what @q{style} of glyph is
402 typeset. Valid choices depend on the function that is reading this
404 (glyph-name ,string? "The glyph name within the font.")
405 (glyph-name-alist ,list? "An alist of key-string pairs.")
406 (graphical ,boolean? "Display in graphical (vs. text) form.")
407 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
413 (hair-thickness ,number? "Thickness of the thin line in a bar
415 (harp-pedal-details ,list? "An alist of detailed grob properties
416 for harp pedal diagrams. Each alist entry consists of a
417 @code{(@var{property} . @var{value})} pair. The properties which can
418 be included in harp-pedal-details include the following:
422 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
423 boxes above/below the horizontal line. Default value@tie{}0.8.
425 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
427 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
429 @code{space-before-divider} -- Space between boxes before the first
430 divider (so that the diagram can be made symmetric). Default
433 @code{space-after-divider} -- Space between boxes after the first
434 divider. Default value@tie{}0.8.
436 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
437 of the ellipse around circled pedals. Default value@tie{}0.5.
439 @code{circle-x-padding} -- Padding in X direction of the ellipse
440 around circled pedals. Default value 0.15.
442 @code{circle-y-padding} -- Padding in Y direction of the ellipse
443 around circled pedals. Default value@tie{}0.2.
445 (head-direction ,ly:dir? "Are the note heads left or right in a
447 (height ,ly:dimension? "Height of an object in @code{staff-space}
449 (height-limit ,ly:dimension? "Maximum slur height: The longer the
450 slur, the closer it is to this height.")
451 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
452 that appears on a tied note after a line break will not be displayed.")
453 (horizontal-shift ,integer? "An integer that identifies ranking
454 of @code{NoteColumn}s for horizontal shifting. This is used by
455 @rinternals{note-collision-interface}.")
456 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
457 left and one to the right of this grob.")
463 (ignore-collision ,boolean? "If set, don't do note collision
464 resolution on this @code{NoteColumn}.")
465 (implicit ,boolean? "Is this an implicit bass figure?")
466 (inspect-index ,integer? "If debugging is set, set beam and slur
467 configuration to this index, and print the respective scores.")
468 (inspect-quants ,number-pair? "If debugging is set, set beam and
469 slur quants to this position, and print the respective scores.")
475 (keep-inside-line ,boolean? "If set, this column cannot have
476 objects sticking into the margin.")
477 (kern ,ly:dimension? "Amount of extra white space to add. For
478 bar lines, this is the amount of space after a thick line.")
479 (knee ,boolean? "Is this beam kneed?")
480 (knee-spacing-correction ,number? "Factor for the optical
481 correction amount for kneed beams. Set between @code{0} for no
482 correction and @code{1} for full correction.")
488 (labels ,list? "List of labels (symbols) placed on a column.")
489 (layer ,integer? "An integer which determines the order of printing
490 objects. Objects with the lowest value of layer are drawn first, then
491 objects with progressively higher values are drawn, so objects with
492 higher values overwrite objects with lower values. By default most
493 objects are assigned a layer value of 1.")
494 (ledger-line-thickness ,number-pair? "The thickness of ledger
495 lines. It is the sum of 2@tie{}numbers: The first is the factor for
496 line thickness, and the second for staff space. Both contributions
498 (left-bound-info ,list? "An alist of properties for determining
499 attachments of spanners to edges.")
500 (left-padding ,ly:dimension? "The amount of space that is put
501 left to an object (e.g., a lyric extender).")
502 (length ,ly:dimension? "User override for the stem length of
504 (length-fraction ,number? "Multiplier for lengths. Used for
505 determining ledger lines and stem lengths.")
506 (line-break-penalty ,number? "Penalty for a line break at this
507 column. This affects the choices of the line breaker; it avoids a
508 line break at a column with a positive penalty and prefers a line
509 break at a column with a negative penalty.")
510 (line-break-permission ,symbol? "Instructs the line breaker on
511 whether to put a line break at this column. Can be @code{force} or
513 (line-break-system-details ,list? "An alist of properties to use
514 if this column is the start of a system.")
515 (line-count ,integer? "The number of staff lines.")
516 (line-positions ,list? "Vertical positions of staff lines.")
517 (line-thickness ,number? "The thickness of the tie or slur
519 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
525 (max-beam-connect ,integer? "Maximum number of beams to connect
526 to beams from this stem. Further beams are typeset as beamlets.")
527 (max-stretch ,number? "The maximum amount that this
528 @code{VerticalAxisGroup} can be vertically stretched (for example, in
529 order to better fill a page).")
530 (measure-count ,integer? "The number of measures for a
531 multi-measure rest.")
532 (measure-length ,ly:moment? "Length of a measure. Used in some
533 spacing situations.")
534 (merge-differently-dotted ,boolean? "Merge note heads in
535 collisions, even if they have a different number of dots. This is
536 normal notation for some types of polyphonic music.
538 @code{merge-differently-dotted} only applies to opposing stem
539 directions (i.e., voice 1 &@tie{}2).")
540 (merge-differently-headed ,boolean? "Merge note heads in
541 collisions, even if they have different note heads. The smaller of
542 the two heads is rendered invisible. This is used in polyphonic
543 guitar notation. The value of this setting is used by
544 @rinternals{note-collision-interface}.
546 @code{merge-differently-headed} only applies to opposing stem
547 directions (i.e., voice 1 &@tie{}2).")
548 (minimum-distance ,ly:dimension? "Minimum distance between rest
550 (minimum-length ,ly:dimension? "Try to make a spanner at least
551 this long, normally in the horizontal direction. This requires an
552 appropriate callback for the @code{springs-and-rods} property. If
553 added to a @code{Tie}, this sets the minimum distance between
555 (minimum-length-fraction ,number? "Minimum length of ledger line
556 as fraction of note head size.")
557 (minimum-space ,ly:dimension? "Minimum distance that the victim
558 should move (after padding).")
559 (minimum-X-extent ,number-pair? "Minimum size of an object in
560 X@tie{}dimension, measured in @code{staff-space} units.")
561 (minimum-Y-extent ,number-pair? "Minimum size of an object in
562 Y@tie{}dimension, measured in @code{staff-space} units.")
568 (neutral-direction ,ly:dir? "Which direction to take in the
569 center of the staff.")
570 (neutral-position ,number? "Position (in half staff spaces) where
571 to flip the direction of custos stem.")
572 (next ,ly:grob? "Object that is next relation (e.g., the lyric
573 syllable following an extender).")
574 (no-alignment ,boolean? "If set, don't place this grob in a
575 @code{VerticalAlignment}; rather, place it using its own
576 @code{Y-offset} callback.")
577 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
579 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
580 get stems extending to the middle staff line.")
581 (non-break-align-symbols ,list? "A list of symbols that determine
582 which NON-break-aligned interfaces to align this to.")
583 (non-default ,boolean? "Set for manually specified clefs.")
584 (non-musical ,boolean? "True if the grob belongs to a
585 @code{NonMusicalPaperColumn}.")
586 (nonstaff-nonstaff-spacing ,list? "Specifies how to vertically
587 position a non-spaced line relative to the other non-spaced lines
588 around it. See @var{staff-staff-spacing} for the format of this list.")
589 (nonstaff-relatedstaff-spacing ,list? "Specifies how to vertically
590 position a non-spaced line relative to the staff for which it
591 has affinity. See @var{staff-staff-spacing} for the format of this list.")
592 (nonstaff-unrelatedstaff-spacing ,list? "An alist of spacing variables
593 that controls the spacing from a loose line (see @var{staff-affinity})
594 to the staff for which the loose line does not have affinity.
595 See @var{staff-staff-spacing} for a description of the elements of
597 (note-names ,vector? "Vector of strings containing names for
598 easy-notation note heads.")
604 (outside-staff-horizontal-padding ,number? "By default, an
605 outside-staff-object can be placed so that is it very close to another
606 grob horizontally. If this property is set, the outside-staff-object
607 is raised so that it is not so close to its neighbor.")
608 (outside-staff-padding ,number? "The padding to place between
609 this grob and the staff when spacing according to
610 @code{outside-staff-priority}.")
611 (outside-staff-priority ,number? "If set, the grob is positioned
612 outside the staff in such a way as to avoid all collisions. In case
613 of a potential collision, the grob with the smaller
614 @code{outside-staff-priority} is closer to the staff.")
620 (packed-spacing ,boolean? "If set, the notes are spaced as
621 tightly as possible.")
622 (padding ,ly:dimension? "Add this much extra space between
623 objects that are next to each other.")
624 (padding-pairs ,list? "An alist mapping @code{(@var{name}
625 . @var{name})} to distances.")
626 (page-break-penalty ,number? "Penalty for page break at this
627 column. This affects the choices of the page breaker; it avoids a
628 page break at a column with a positive penalty and prefers a page
629 break at a column with a negative penalty.")
630 (page-break-permission ,symbol? "Instructs the page breaker on
631 whether to put a page break at this column. Can be @code{force} or
633 (page-turn-penalty ,number? "Penalty for a page turn at this
634 column. This affects the choices of the page breaker; it avoids a
635 page turn at a column with a positive penalty and prefers a page turn
636 at a column with a negative penalty.")
637 (page-turn-permission ,symbol? "Instructs the page breaker on
638 whether to put a page turn at this column. Can be @code{force} or
640 (parenthesized ,boolean? "Parenthesize this grob.")
641 (positions ,number-pair? "Pair of staff coordinates
642 @code{(@var{left} . @var{right})}, where both @var{left} and
643 @var{right} are in @code{staff-space} units of the current staff. For
644 slurs, this value selects which slur candidate to use; if extreme
645 positions are requested, the closest one is taken.")
646 (prefer-dotted-right ,boolean? "For note collisions, prefer to
647 shift dotted up-note to the right, rather than shifting just the
654 (ratio ,number? "Parameter for slur shape. The higher this
655 number, the quicker the slur attains its @code{height-limit}.")
656 (remove-empty ,boolean? "If set, remove group if it contains no
658 (remove-first ,boolean? "Remove the first staff of an orchestral
660 (restore-first ,boolean? "Print a natural before the
662 (rhythmic-location ,rhythmic-location? "Where (bar number,
663 measure position) in the score.")
664 (right-bound-info ,list? "An alist of properties for determining
665 attachments of spanners to edges.")
666 (right-padding ,ly:dimension? "Space to insert on the right side
667 of an object (e.g., between note and its accidentals).")
668 (rotation ,list? "Number of degrees to rotate this object, and
669 what point to rotate around. For example, @code{#'(45 0 0)} rotates
670 by 45 degrees around the center of this object.")
676 (same-direction-correction ,number? "Optical correction amount
677 for stems that are placed in tight configurations. This amount is
678 used for stems with the same direction to compensate for note head to
680 (script-priority ,number? "A sorting key that determines in what
681 order a script is within a stack of scripts.")
682 (self-alignment-X ,number? "Specify alignment of an object. The
683 value @code{-1} means left aligned, @code{0}@tie{}centered, and
684 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
685 values may also be specified.")
686 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
688 (shorten-pair ,number-pair? "The lengths to shorten a
689 text-spanner on both sides, for example a pedal bracket. Positive
690 values shorten the text-spanner, while negative values lengthen it.")
691 (shortest-duration-space ,ly:dimension? "Start with this much
692 space for the shortest duration. This is expressed in
693 @code{spacing-increment} as unit. See also
694 @rinternals{spacing-spanner-interface}.")
695 (shortest-playing-duration ,ly:moment? "The duration of the
696 shortest note playing here.")
697 (shortest-starter-duration ,ly:moment? "The duration of the
698 shortest note that starts here.")
699 (side-axis ,number? "If the value is @code{#X} (or
700 equivalently@tie{}@code{0}), the object is placed horizontally next to
701 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is
703 (side-relative-direction ,ly:dir? "Multiply direction of
704 @code{direction-source} with this to get the direction of this
706 (size ,number? "Size of object, relative to standard size.")
707 (skyline-horizontal-padding ,number? "For determining the
708 vertical distance between two staves, it is possible to have a
709 configuration which would result in a tight interleaving of grobs from
710 the top staff and the bottom staff. The larger this parameter is, the
711 farther apart the staves are placed in such a configuration.")
712 (slash-negative-kern ,number? "The space to remove between
713 slashes in percent repeat glyphs. Larger values bring the two
714 elements closer together.")
715 (slope ,number? "The slope of this object.")
716 (slur-padding ,number? "Extra distance between slur and script.")
717 (space-alist ,list? "A table that specifies distances between
718 prefatory items, like clef and time-signature. The format is an alist
719 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
720 . @var{distance})}, where @var{type} can be the symbols
721 @code{minimum-space} or @code{extra-space}.")
722 (space-to-barline ,boolean? "If set, the distance between a note
723 and the following non-musical column will be measured to the bar line
724 instead of to the beginning of the non-musical column. If there is a
725 clef change followed by a bar line, for example, this means that we
726 will try to space the non-musical column as though the clef is not
728 (spacing-increment ,number? "Add this much space for a doubled
729 duration. Typically, the width of a note head. See also
730 @rinternals{spacing-spanner-interface}.")
731 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
732 spacing relative to its left and right @code{BreakAlignment}s.
734 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
735 bounds (i.e., clefs, key signatures and time signatures) using the following
739 \\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar)
741 (springs-and-rods ,boolean? "Dummy variable for triggering
743 (stacking-dir ,ly:dir? "Stack objects in which direction?")
744 (staff-affinity ,ly:dir? "The direction of the staff to which this
746 (staff-padding ,ly:dimension? "Maintain this much space between
747 reference points and the staff. Its effect is to align objects of
748 differing sizes (like the dynamics @b{p} and @b{f}) on their
750 (staff-position ,number? "Vertical position, measured in half
751 staff spaces, counted from the middle line.")
752 (staff-space ,ly:dimension? "Amount of space between staff lines,
753 expressed in global @code{staff-space}.")
754 (staff-staff-spacing ,list? "An alist of spacing variables
755 that controls the spacing between staves within this staff group.
756 See @var{staff-staff-spacing} for a description of the elements of
758 (staff-staff-spacing ,list? "An alist of properties used to position
759 the next staff in the system. The symbols that can be defined in the alist
762 @item @var{space} -- the amount of stretchable space between the center
763 of this staff and the center of the next staff;
764 @item @var{padding} -- the minimum amount of whitespace that must be
765 present between this staff and the next staff;
766 @item @var{stretchability} -- the ease with which the stretchable
767 space increases when the system to which this staff belongs is stretched.
768 If this is zero, the distance to the next staff will be fixed either at
769 @var{space} or at @var{padding} plus the minimum distance to ensure
770 there is no overlap, whichever is larger;
771 @item @var{minimum-distance} -- the minimum distance to place between
772 the center of this staff and the center of the next. This differs
773 from @var{padding} in that the height of a staff has no effect on
774 the application of @var{minimum-distance} (whereas the height of a
775 staff is crucial for @var{padding}).
777 (staffgroup-staff-spacing ,list? "An alist of spacing variables
778 that controls the spacing after the last staff in this staff group.
779 See @var{staff-staff-spacing} for a description of the elements of
781 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
782 pair where the stem attaches to the notehead.")
783 (stem-end-position ,number? "Where does the stem end (the end is
784 opposite to the support-head)?")
786 (stem-spacing-correction ,number? "Optical correction amount for
787 stems that are placed in tight configurations. For opposite
788 directions, this amount is the correction for two normal sized stems
789 that overlap completely.")
790 (stemlet-length ,number? "How long should be a stem over a
792 (stencil ,ly:stencil? "The symbol to print.")
793 (stencils ,list? "Multiple stencils, used as intermediate
795 (strict-grace-spacing ,boolean? "If set, main notes are spaced
796 normally, then grace notes are put left of the musical columns for the
798 (strict-note-spacing ,boolean? "If set, unbroken columns with
799 non-musical material (clefs, bar lines, etc.) are not spaced
800 separately, but put before musical columns.")
801 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
803 (style ,symbol? "This setting determines in what style a grob is
804 typeset. Valid choices depend on the @code{stencil} callback reading
811 (text ,markup? "Text markup. See @ruser{Formatting text}.")
812 ;;FIXME -- Should both be the same?
813 (text-direction ,ly:dir? "This controls the ordering of the
814 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
815 should use @code{LEFT}.")
816 (thick-thickness ,number? "Bar line thickness, measured in
817 @code{line-thickness}.")
818 (thickness ,number? "Line thickness, generally measured in
819 @code{line-thickness}.")
820 (thin-kern ,number? "The space after a hair-line in a bar line.")
821 (tie-configuration ,list? "List of @code{(@var{position} .
822 @var{dir})} pairs, indicating the desired tie configuration, where
823 @var{position} is the offset from the center of the staff in staff
824 space and @var{dir} indicates the direction of the tie
825 (@code{1}=>up, @code{-1}=>down, @code{0}=>center). A non-pair entry
826 in the list causes the corresponding tie to be formatted
828 (to-barline ,boolean? "If true, the spanner will stop at the bar
829 line just before it would otherwise stop.")
830 (toward-stem-shift ,number? "Amount by which scripts are shifted
831 toward the stem if their direction coincides with the stem direction.
832 @code{0.0} means keep the default position (centered on the note
833 head), @code{1.0} means centered on the stem. Interpolated values are
835 (transparent ,boolean? "This makes the grob invisible.")
841 (uniform-stretching ,boolean? "If set, items stretch
842 proportionally to their durations. This looks better in complex
843 polyphonic patterns.")
844 (used ,boolean? "If set, this spacing column is kept in the
851 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
852 one below this grob.")
858 (when ,ly:moment? "Global time step associated with this column
860 (whiteout ,boolean? "If true, the grob is printed over a white
861 background to white-out underlying material, if the grob is visible.
862 Usually #f by default.")
863 (width ,ly:dimension? "The width of a grob measured in staff
865 (word-space ,ly:dimension? "Space to insert between words in
872 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
873 (X-offset ,number? "The horizontal amount that this object is
874 moved relative to its X-parent.")
880 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
881 (Y-offset ,number? "The vertical amount that this object is moved
882 relative to its Y-parent.")
887 (zigzag-length ,ly:dimension? "The length of the lines of a
888 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
889 gives 60-degree zigzags.")
890 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
891 This number is adjusted slightly so that the glissando line can be
892 constructed from a whole number of squiggles.")
900 (define (define-internal-grob-property symbol type? description)
901 (define-grob-property symbol type? description)
902 (set-object-property! symbol 'backend-internal #t)
907 (define-public all-internal-grob-properties
910 (apply define-internal-grob-property x))
914 ;; grobs & grob arrays. (alphabetical)
915 (accidental-grob ,ly:grob? "The accidental for this note.")
916 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
917 @var{groblist})} entries.")
918 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
920 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
921 function is to protect objects from being garbage collected.")
922 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
923 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
924 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
926 (bars ,ly:grob-array? "An array of bar line pointers.")
927 (beam ,ly:grob? "A pointer to the beam, if applicable.")
928 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
929 column as start/begin point. Only columns that have grobs or act as
931 (bracket ,ly:grob? "The bracket for a number.")
933 (columns ,ly:grob-array? "An array of grobs, typically containing
934 @code{PaperColumn} or @code{NoteColumn} objects.")
935 (conditional-elements ,ly:grob-array? "Internal use only.")
937 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
938 set, which grob to get the direction from.")
939 (dot ,ly:grob? "A reference to a @code{Dots} object.")
940 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
942 (elements ,ly:grob-array? "An array of grobs; the type is depending on
943 the grob where this is set in.")
944 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
945 in addition to notes and stems.")
947 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
949 (grace-spacing ,ly:grob? "A run of grace notes.")
951 (heads ,ly:grob-array? "An array of note heads.")
953 (items-worth-living ,ly:grob-array? "An array of interesting items. If
954 empty in a particular staff, then that staff is erased.")
956 (keep-alive-with ,ly:grob-array? "An array of other
957 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
959 (left-items ,ly:grob-array? "DOCME")
960 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
963 (normal-stems ,ly:grob-array? "An array of visible stems.")
964 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
965 (note-head ,ly:grob? "A single note head.")
966 (note-heads ,ly:grob-array? "An array of note head grobs.")
967 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
969 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
970 that are relevant for finding the @code{pure-Y-extent}")
971 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
972 relevant for finding the @code{pure-Y-extent}.")
973 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
974 relevant for finding the @code{pure-Y-extent}.")
975 (pure-Y-common ,ly:grob? "A cache of the
976 @code{common_refpoint_of_array} of the @code{elements} grob set.")
978 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
979 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
980 (rests ,ly:grob-array? "An array of rest objects.")
981 (right-items ,ly:grob-array? "DOCME")
982 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
984 (side-support-elements ,ly:grob-array? "The side support, an array of
986 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
987 (spacing ,ly:grob? "The spacing spanner governing this section.")
988 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
990 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
991 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
992 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
993 (stems ,ly:grob-array? "An array of stem objects.")
995 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
996 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
997 (tuplet-number ,ly:grob? "The number for a bracket.")
998 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
999 (X-common ,ly:grob? "Common reference point for axis group.")
1000 (Y-common ,ly:grob? "See @code{X-common}.")
1004 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1005 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1008 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
1009 This may differ from @code{Y-extent} because it does not include the dots in
1010 a repeat bar line.")
1011 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1012 @code{FretBoard} be visible only at beginning of line or at
1015 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1016 translator) that was the cause for this grob.")
1017 (cross-staff ,boolean? "For a beam or a stem, this is true if we
1018 depend on inter-staff spacing.")
1020 (delta-position ,number? "The vertical position difference.")
1022 (font ,ly:font-metric? "A cached font metric object.")
1023 (forced ,boolean? "Manually forced accidental.")
1025 (head-width ,ly:dimension? "The width of this ligature head.")
1027 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1028 @var{strength}))} pairs.")
1029 (important-column-ranks ,vector? "A cache of columns that contain
1030 @code{items-worth-living} data.")
1031 (interfaces ,list? "A list of symbols indicating the interfaces
1032 supported by this object. It is initialized from the @code{meta} field.")
1034 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1036 (maybe-loose ,boolean? "Used to mark a breakable column that is
1037 loose if and only if it is in the middle of a line.")
1038 (meta ,list? "Provide meta information. It is an alist with the
1039 entries @code{name} and @code{interfaces}.")
1040 (minimum-distances ,list? "A list of rods that have the format
1041 @code{(@var{obj} . @var{dist})}.")
1043 (positioning-done ,boolean? "Used to signal that a positioning element
1044 did its job. This ensures that a positioning is only done once.")
1045 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1046 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1047 cyclic dependencies.")
1049 (quant-score ,string? "The beam quanting score; stored for
1051 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1052 to be within staff spaces.")
1053 (quantized-positions ,number-pair? "The beam positions after
1056 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1057 acts as an index for looking up a @code{Stencil} object.")
1058 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1059 Internally used to distribute beam shortening over stems.")
1060 (stem-info ,pair? "A cache of stem parameters.")
1061 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1062 top-margin of the page) of the system to which this staff belongs.")
1064 (use-breve-rest ,boolean? "Use breve rests for measures longer
1065 than a whole rest.")
1071 ;; There are too many properties for ancient notation;
1072 ;; probably neume-types (a list of symbols) would also work.
1074 ;; However, such a list would consist of a couple of dozens of
1075 ;; entries, since head prefixes may be combined in many ways. If
1076 ;; the macros in `gregorian.ly' would directly set prefix-set,
1077 ;; all the head prefixes could be junked; however, such macros
1078 ;; would be quite numerous, I guess. --jr
1080 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1082 (add-join ,boolean? "Is this ligature head-joined with the next one
1083 by a vertical line?")
1084 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1085 an additional stem on the right side?")
1086 (ascendens ,boolean? "Is this neume of ascending type?")
1087 (auctum ,boolean? "Is this neume liquescentically augmented?")
1089 (cavum ,boolean? "Is this neume outlined?")
1090 (context-info ,integer? "Within a ligature, the final glyph or shape of
1091 a head may be affected by the left and/or right neighbour head.
1092 @code{context-info} holds for each head such information about the left and
1093 right neighbour, encoded as a bit mask.")
1095 (deminutum ,boolean? "Is this neume deminished?")
1096 (descendens ,boolean? "Is this neume of descendent type?")
1098 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1099 grob (in @code{staff-space} units).")
1100 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1101 ligature grob in (in @code{staff-space} units).")
1103 (inclinatum ,boolean? "Is this neume an inclinatum?")
1105 (join-right-amount ,number? "A length used for calculating the
1106 Y-extent of mensural ligatures.")
1108 (linea ,boolean? "Attach vertical lines to this neume?")
1110 (oriscus ,boolean? "Is this neume an oriscus?")
1112 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1114 (prefix-set ,number? "A bit mask that holds all Gregorian head
1115 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1116 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1117 similar to a note head that is part of a ligature.")
1119 (quilisma ,boolean? "Is this neume a quilisma?")
1121 (stropha ,boolean? "Is this neume a stropha?")
1123 (virga ,boolean? "Is this neume a virga?")
1125 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1129 (define-public all-backend-properties
1131 all-internal-grob-properties
1132 all-user-grob-properties))