1 ;;;; This file is part of LilyPond, the GNU music typesetter.
3 ;;;; Copyright (C) 1998--2011 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?
28 (define-public all-user-grob-properties
31 (apply define-grob-property x))
37 (add-stem-support ,boolean? "If set, the @code{Stem} object is
38 included in this script's support.")
39 (after-line-breaking ,boolean? "Dummy property, used to trigger
40 callback for @code{after-line-breaking}.")
41 (align-dir ,ly:dir? "Which side to align? @w{@code{-1}}: left side,
42 @code{0}: around center of width, @code{1}: right side.")
43 (allow-loose-spacing ,boolean? "If set, column can be detached
45 (allow-span-bar ,boolean? "If false, no inter-staff bar line will
46 be created below this bar line.")
47 (alteration ,number? "Alteration numbers for accidental.")
48 (alteration-alist ,list? "List of @code{(@var{pitch}
49 . @var{accidental})} pairs for key signature.")
50 (annotation ,string? "Annotate a grob for debug purposes.")
51 (annotation-balloon ,boolean? "Print the balloon around an annotation.")
52 (annotation-line ,boolean? "Print the line from an annotation to the
53 grob that it annotates.")
54 (arpeggio-direction ,ly:dir? "If set, put an arrow on the
55 arpeggio squiggly line.")
56 (arrow-length ,number? "Arrow length.")
57 (arrow-width ,number? "Arrow width.")
58 (auto-knee-gap ,ly:dimension? "If a gap is found between note
59 heads where a horizontal beam fits that is larger than this number,
61 (automatically-numbered ,boolean? "Should a footnote be automatically
63 (average-spacing-wishes ,boolean? "If set, the spacing wishes are
64 averaged over staves.")
65 (avoid-note-head ,boolean? "If set, the stem of a chord does not
66 pass through all note heads, but starts at the last note head.")
67 (avoid-slur ,symbol? "Method of handling slur collisions.
68 Choices are @code{inside}, @code{outside}, @code{around}, and
69 @code{ignore}. @code{inside} adjusts the slur if needed to keep the
70 grob inside the slur. @code{outside} moves the grob vertically to the
71 outside of the slur. @code{around} moves the grob vertically to the
72 outside of the slur only if there is a collision. @code{ignore} does
73 not move either. In grobs whose notational significance depends on
74 vertical position (such as accidentals, clefs, etc.), @code{outside}
75 and @code{around} behave like @code{ignore}.")
76 (axes ,list? "List of axis numbers. In the case of alignment
77 grobs, this should contain only one number.")
83 (base-shortest-duration ,ly:moment? "Spacing is based on the
84 shortest notes in a piece. Normally, pieces are spaced as if notes at
85 least as short as this are present.")
86 (baseline-skip ,ly:dimension? "Distance between base lines of
87 multiple lines of text.")
88 (beam-thickness ,ly:dimension? "Beam thickness, measured in
89 @code{staff-space} units.")
90 (beam-width ,ly:dimension? "Width of the tremolo sign.")
91 (beamed-stem-shorten ,list? "How much to shorten beamed stems,
92 when their direction is forced. It is a list, since the value is
93 different depending on the number of flags and beams.")
94 (beaming ,pair? "Pair of number lists. Each number list
95 specifies which beams to make. @code{0}@tie{}is the central beam,
96 @code{1}@tie{}is the next beam toward the note, etc. This information
97 is used to determine how to connect the beaming patterns from stem to
99 (beamlet-default-length ,pair? "A pair of numbers. The first
100 number specifies the default length of a beamlet that sticks out of
101 the left hand side of this stem; the second number specifies the
102 default length of the beamlet to the right. The actual length of a
103 beamlet is determined by taking either the default length or the
104 length specified by @code{beamlet-max-length-proportion}, whichever is
106 (beamlet-max-length-proportion ,pair? "The maximum length of a
107 beamlet, as a proportion of the distance between two adjacent stems.")
108 (before-line-breaking ,boolean? "Dummy property, used to trigger
109 a callback function.")
110 (between-cols ,pair? "Where to attach a loose column to.")
111 (bound-details ,list? "An alist of properties for determining
112 attachments of spanners to edges.")
113 (bound-padding ,number? "The amount of padding to insert around
115 (bracket-flare ,number-pair? "A pair of numbers specifying how
116 much edges of brackets should slant outward. Value @code{0.0} means
118 (bracket-visibility ,boolean-or-symbol? "This controls the
119 visibility of the tuplet bracket. Setting it to false prevents
120 printing of the bracket. Setting the property to @code{if-no-beam}
121 makes it print only if there is no beam associated with this tuplet
123 (break-align-anchor ,number? "Grobs aligned to this break-align
124 grob will have their X-offsets shifted by this number. In bar lines,
125 for example, this is used to position grobs relative to the (visual)
126 center of the bar line.")
127 (break-align-anchor-alignment ,number? "Read by
128 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
129 aligning an anchor to a grob's extent.")
130 (break-align-orders ,vector? "Defines the order in which
131 prefatory matter (clefs, key signatures) appears. The format is a
132 vector of length@tie{}3, where each element is one order for
133 end-of-line, middle of line, and start-of-line, respectively. An
134 order is a list of symbols.
136 For example, clefs are put after key signatures by setting
139 \\override Score.BreakAlignment #'break-align-orders =
140 #(make-vector 3 '(span-bar
147 (break-align-symbol ,symbol? "This key is used for aligning and
148 spacing breakable items.")
149 (break-align-symbols ,list? "A list of symbols that determine
150 which break-aligned grobs to align this to. If the grob selected by
151 the first symbol in the list is invisible due to break-visibility, we
152 will align to the next grob (and so on). Choices are @code{left-edge},
153 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar},
154 @code{key-cancellation}, @code{key-signature}, @code{time-signature},
156 (break-overshoot ,number-pair? "How much does a broken spanner
157 stick out of its bounds?")
158 (break-visibility ,vector? "A vector of 3@tie{}booleans,
159 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
160 @code{#t} means visible, @code{#f} means killed.")
161 (breakable ,boolean? "Allow breaks here.")
167 (c0-position ,integer? "An integer indicating the position of
169 (circled-tip ,boolean? "Put a circle at start/@/end of
170 hairpins (al/@/del niente).")
171 (clip-edges ,boolean? "Allow outward pointing beamlets at the
173 (collapse-height ,ly:dimension? "Minimum height of system start
174 delimiter. If equal or smaller, the bracket/@/brace/@/line is removed.")
175 (collision-interfaces ,list? "A list of interfaces for which
176 automatic beam-collision resolution is run.")
177 (collision-voice-only ,boolean? "Does automatic beam collsion apply
178 only to the voice in which the beam was created?")
179 (color ,color? "The color of this grob.")
180 (common-shortest-duration ,ly:moment? "The most common shortest
181 note length. This is used in spacing. Enlarging this sets the score
183 (concaveness ,number? "A beam is concave if its inner stems are
184 closer to the beam than the two outside stems. This number is a
185 measure of the closeness of the inner stems. It is used for damping
186 the slope of the beam.")
187 (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
188 this grob looks as a continued break.")
189 (consistent-broken-slope ,boolean? "Keep a beam's slope across line
191 (control-points ,list? "List of offsets (number pairs) that form
192 control points for the tie, slur, or bracket shape. For B@'eziers,
193 this should list the control points of a third-order B@'ezier curve.")
198 (damping ,number? "Amount of beam slope damping.")
199 (dash-definition ,pair? "List of @code{dash-elements} defining the
200 dash structure. Each @code{dash-element} has a starting t value,
201 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
202 (dash-fraction ,number? "Size of the dashes, relative to
203 @code{dash-period}. Should be between @code{0.0} (no line) and
204 @code{1.0} (continuous line).")
205 (dash-period ,number? "The length of one dash together with
206 whitespace. If negative, no line is drawn at all.")
207 (default-direction ,ly:dir? "Direction determined by note head
209 (default-staff-staff-spacing ,list? "The settings to use for
210 @code{staff-staff-spacing} when it is unset, for ungrouped staves
211 and for grouped staves that do not have the relevant
212 @code{StaffGrouper} property set (@code{staff-staff-spacing} or
213 @code{staffgroup-staff-spacing}).")
214 (details ,list? "Alist of parameters for detailed grob behavior.
215 More information on the allowed parameters for a grob can be found by
216 looking at the top of the Internals Reference page for each interface
217 having a @code{details} property.")
218 (digit-names ,vector? "Names for string finger digits.")
219 (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
220 @code{X}), then this property determines whether the object is placed
221 @code{LEFT}, @code{CENTER} or @code{RIGHT} with respect to the
222 other object. Otherwise, it determines whether the object is placed
223 @code{UP}, @code{CENTER} or @code{DOWN}. Numerical values may also
224 be used: @code{UP}=@code{1}, @code{DOWN}=@w{@code{-1}},
225 @code{LEFT}=@w{@code{-1}}, @code{RIGHT}=@code{1},
226 @code{CENTER}=@code{0}.")
227 (dot-count ,integer? "The number of dots.")
228 (dot-negative-kern ,number? "The space to remove between a dot
229 and a slash in percent repeat glyphs. Larger values bring the two
230 elements closer together.")
231 (dot-placement-list ,list? "List consisting of
232 @code{(@var{description} @var{string-number} @var{fret-number}
233 @var{finger-number})} entries used to define fret diagrams.")
234 (duration-log ,integer? "The 2-log of the note head duration,
235 i.e., @code{0} = whole note, @code{1} = half note, etc.")
241 (eccentricity ,number? "How asymmetrical to make a slur.
242 Positive means move the center to the right.")
243 (edge-height ,pair? "A pair of numbers specifying the heights of
244 the vertical edges: @code{(@var{left-height} . @var{right-height})}.")
245 (edge-text ,pair? "A pair specifying the texts to be set at the
246 edges: @code{(@var{left-text} . @var{right-text})}.")
247 (elements-filtered ,boolean? "Callback to filter an element list.")
248 (round-up-exceptions ,list? "A list of pairs where car is the numerator
249 and cdr the denominator of a moment. Each pair in this list means that
250 the multi-measure rests of the corresponding length will be rounded up to
251 the longer rest. See @var{round-up-to-longer-rest}.")
252 (expand-limit ,integer? "Maximum number of measures expanded in
255 (extra-dy ,number? "Slope glissandi this much extra.")
256 (extra-offset ,number-pair? "A pair representing an offset. This
257 offset is added just before outputting the symbol, so the typesetting
258 engine is completely oblivious to it. The values are measured in
259 @code{staff-space} units of the staff's @code{StaffSymbol}.")
260 (extra-spacing-height ,number-pair? "In the horizontal spacing
261 problem, we increase the height of each item by this amount (by adding
262 the @q{car} to the bottom of the item and adding the @q{cdr} to the
263 top of the item). In order to make a grob infinitely high (to prevent
264 the horizontal spacing problem from placing any other grobs above or
265 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
266 (extra-spacing-width ,number-pair? "In the horizontal spacing
267 problem, we pad each item by this amount (by adding the @q{car} on the
268 left side of the item and adding the @q{cdr} on the right side of the
269 item). In order to make a grob take up no horizontal space at all,
270 set this to @code{(+inf.0 . -inf.0)}.")
271 (extra-X-extent ,number-pair? "A grob is enlarged in
272 X@tie{}dimension by this much.")
273 (extra-Y-extent ,number-pair? "A grob is enlarged in
274 Y@tie{}dimension by this much.")
280 (flag-count ,number? "The number of tremolo beams.")
281 (font-encoding ,symbol? "The font encoding is the broadest
282 category for selecting a font. Currently, only lilypond's system
283 fonts (Emmentaler) are using this property. Available
284 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces},
285 @code{fetaText} (Emmentaler).")
286 (font-family ,symbol? "The font family is the broadest category
287 for selecting text fonts. Options include: @code{sans},
289 (font-name ,string? "Specifies a file name (without extension) of
290 the font to load. This setting overrides selection using
291 @code{font-family}, @code{font-series} and @code{font-shape}.")
292 (font-series ,symbol? "Select the series of a font. Choices
293 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
294 (font-shape ,symbol? "Select the shape of a font. Choices
295 include @code{upright}, @code{italic}, @code{caps}.")
296 (font-size ,number? "The font size, compared to the
297 @q{normal}@tie{}size. @code{0}@tie{}is style-sheet's normal size,
298 @w{@code{-1}} is smaller, @code{+1} is bigger. Each step of@tie{}1 is
299 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
300 larger. Fractional values are allowed.")
301 (footnote ,boolean? "Should this be a footnote or in-note?")
302 (footnote-text ,markup? "A footnote for the grob.")
303 (force-hshift ,number? "This specifies a manual shift for notes
304 in collisions. The unit is the note head width of the first voice
305 note. This is used by @rinternals{note-collision-interface}.")
306 (fraction ,number-pair? "Numerator and denominator of a time
308 (french-beaming ,boolean? "Use French beaming style for this
309 stem. The stem stops at the innermost beams.")
310 (fret-diagram-details ,list? "An alist of detailed grob
311 properties for fret diagrams. Each alist entry consists of a
312 @code{(@var{property} . @var{value})} pair. The properties which can
313 be included in @code{fret-diagram-details} include the following:
317 @code{barre-type} -- Type of barre indication used. Choices include
318 @code{curved}, @code{straight}, and @code{none}. Default
321 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
322 fret-space. Default value@tie{}0.5.
324 @code{dot-color} -- Color of dots. Options include @code{black} and
325 @code{white}. Default @code{black}.
327 @code{dot-label-font-mag} -- Magnification for font used to label fret
328 dots. Default value@tie{}1.
330 @code{dot-position} -- Location of dot in fret space. Default 0.6 for
331 dots without labels, 0.95-@code{dot-radius} for dots with labels.
333 @code{dot-radius} -- Radius of dots, in terms of fret spaces. Default
334 value 0.425 for labeled dots, 0.25 for unlabeled dots.
336 @code{finger-code} -- Code for the type of fingering indication used.
337 Options include @code{none}, @code{in-dot}, and @code{below-string}.
338 Default @code{none} for markup fret diagrams, @code{below-string} for
339 @code{FretBoards} fret diagrams.
341 @code{fret-count} -- The number of frets. Default@tie{}4.
343 @code{fret-label-custom-format} -- The format string to be used label
344 the lowest fret number, when @code{number-type} equals to
345 @code{custom}. Default@tie{}\"~a\".
347 @code{fret-label-font-mag} -- The magnification of the font used to
348 label the lowest fret number. Default@tie{}0.5.
350 @code{fret-label-vertical-offset} -- The offset of the fret label from
351 the center of the fret in direction parallel to strings.
354 @code{label-dir} -- Side to which the fret label is attached.
355 @w{@code{-1}}, @code{LEFT}, or @code{DOWN} for left or down; @code{1},
356 @code{RIGHT}, or @code{UP} for right or up. Default @code{RIGHT}.
358 @code{mute-string} -- Character string to be used to indicate muted
359 string. Default @code{\"x\"}.
361 @code{number-type} -- Type of numbers to use in fret label. Choices
362 include @code{roman-lower}, @code{roman-upper}, @code{arabic} and
363 @code{custom}. In the later case, the format string is supplied by
364 the @code{fret-label-custom-format} property.
365 Default @code{roman-lower}.
367 @code{open-string} -- Character string to be used to indicate open
368 string. Default @code{\"o\"}.
370 @code{orientation} -- Orientation of fret-diagram. Options include
371 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
372 Default @code{normal}.
374 @code{string-count} -- The number of strings. Default@tie{}6.
376 @code{string-label-font-mag} -- The magnification of the font used to
377 label fingerings at the string, rather than in the dot. Default value
378 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
379 @code{opposing-landscape}.
381 @code{string-thickness-factor} -- Factor for changing thickness of
382 each string in the fret diagram. Thickness of string @var{k} is given
384 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
387 @code{top-fret-thickness} -- The thickness of the top fret line, as a
388 multiple of the standard thickness. Default value@tie{}3.
390 @code{xo-font-magnification} -- Magnification used for mute and open
391 string indicators. Default value@tie{}0.5.
393 @code{xo-padding} -- Padding for open and mute indicators from top
394 fret. Default value 0.25.
396 ;; ugh: double, change.
397 (full-length-padding ,number? "How much padding to use at the
398 right side of a full-length tuplet bracket.")
399 (full-length-to-extent ,boolean? "Run to the extent of the column
400 for a full-length tuplet bracket.")
401 (full-measure-extra-space ,number? "Extra space that is allocated
402 at the beginning of a measure with only one note. This property is
403 read from the NonMusicalPaperColumn that begins the measure.")
404 (full-size-change ,boolean? "Don't make a change clef smaller.")
410 (gap ,ly:dimension? "Size of a gap in a variable symbol.")
411 (gap-count ,integer? "Number of gapped beams for tremolo.")
412 (glissando-skip ,boolean? "Should this @code{NoteHead} be skipped
414 (glyph ,string? "A string determining what @q{style} of glyph is
415 typeset. Valid choices depend on the function that is reading this
417 (glyph-name ,string? "The glyph name within the font.")
418 (glyph-name-alist ,list? "An alist of key-string pairs.")
419 (graphical ,boolean? "Display in graphical (vs. text) form.")
420 (grow-direction ,ly:dir? "Crescendo or decrescendo?")
426 (hair-thickness ,number? "Thickness of the thin line in a bar
428 (harp-pedal-details ,list? "An alist of detailed grob properties
429 for harp pedal diagrams. Each alist entry consists of a
430 @code{(@var{property} . @var{value})} pair. The properties which can
431 be included in harp-pedal-details include the following:
435 @code{box-offset} -- Vertical shift of the center of flat/@/sharp pedal
436 boxes above/@/below the horizontal line. Default value@tie{}0.8.
438 @code{box-width} -- Width of each pedal box. Default value@tie{}0.4.
440 @code{box-height} -- Height of each pedal box. Default value@tie{}1.0.
442 @code{space-before-divider} -- Space between boxes before the first
443 divider (so that the diagram can be made symmetric). Default
446 @code{space-after-divider} -- Space between boxes after the first
447 divider. Default value@tie{}0.8.
449 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
450 of the ellipse around circled pedals. Default value@tie{}0.5.
452 @code{circle-x-padding} -- Padding in X direction of the ellipse
453 around circled pedals. Default value 0.15.
455 @code{circle-y-padding} -- Padding in Y direction of the ellipse
456 around circled pedals. Default value@tie{}0.2.
458 (head-direction ,ly:dir? "Are the note heads left or right in a
460 (height ,ly:dimension? "Height of an object in @code{staff-space}
462 (height-limit ,ly:dimension? "Maximum slur height: The longer the
463 slur, the closer it is to this height.")
464 (hide-tied-accidental-after-break ,boolean? "If set, an accidental
465 that appears on a tied note after a line break will not be displayed.")
466 (horizontal-shift ,integer? "An integer that identifies ranking
467 of @code{NoteColumn}s for horizontal shifting. This is used by
468 @rinternals{note-collision-interface}.")
469 (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
470 left and one to the right of this grob.")
476 (ignore-collision ,boolean? "If set, don't do note collision
477 resolution on this @code{NoteColumn}.")
478 (implicit ,boolean? "Is this an implicit bass figure?")
479 (inspect-index ,integer? "If debugging is set, set beam and slur
480 configuration to this index, and print the respective scores.")
481 (inspect-quants ,number-pair? "If debugging is set, set beam and
482 slur quants to this position, and print the respective scores.")
488 (keep-inside-line ,boolean? "If set, this column cannot have
489 objects sticking into the margin.")
490 (kern ,ly:dimension? "Amount of extra white space to add. For
491 bar lines, this is the amount of space after a thick line.")
492 (knee ,boolean? "Is this beam kneed?")
493 (knee-spacing-correction ,number? "Factor for the optical
494 correction amount for kneed beams. Set between @code{0} for no
495 correction and @code{1} for full correction.")
501 (labels ,list? "List of labels (symbols) placed on a column.")
502 (layer ,integer? "An integer which determines the order of printing
503 objects. Objects with the lowest value of layer are drawn first, then
504 objects with progressively higher values are drawn, so objects with
505 higher values overwrite objects with lower values. By default most
506 objects are assigned a layer value of 1.")
507 (ledger-extra ,ly:dimension? "Extra distance from staff line to draw ledger
509 (ledger-line-thickness ,number-pair? "The thickness of ledger
510 lines. It is the sum of 2@tie{}numbers: The first is the factor for
511 line thickness, and the second for staff space. Both contributions
513 (ledger-positions ,list? "Repeating pattern for the vertical positions
514 of ledger lines. Bracketed groups are always shown together.")
515 (left-bound-info ,list? "An alist of properties for determining
516 attachments of spanners to edges.")
517 (left-padding ,ly:dimension? "The amount of space that is put
518 left to an object (e.g., a lyric extender).")
519 (length ,ly:dimension? "User override for the stem length of
521 (length-fraction ,number? "Multiplier for lengths. Used for
522 determining ledger lines and stem lengths.")
523 (line-break-penalty ,number? "Penalty for a line break at this
524 column. This affects the choices of the line breaker; it avoids a
525 line break at a column with a positive penalty and prefers a line
526 break at a column with a negative penalty.")
527 (line-break-permission ,symbol? "Instructs the line breaker on
528 whether to put a line break at this column. Can be @code{force} or
530 (line-break-system-details ,list? "An alist of properties to use
531 if this column is the start of a system.")
532 (line-count ,integer? "The number of staff lines.")
533 (line-positions ,list? "Vertical positions of staff lines.")
534 (line-thickness ,number? "The thickness of the tie or slur
536 (long-text ,markup? "Text markup. See @ruser{Formatting text}.")
542 (max-beam-connect ,integer? "Maximum number of beams to connect
543 to beams from this stem. Further beams are typeset as beamlets.")
544 (max-stretch ,number? "The maximum amount that this
545 @code{VerticalAxisGroup} can be vertically stretched (for example, in
546 order to better fill a page).")
547 (measure-count ,integer? "The number of measures for a
548 multi-measure rest.")
549 (measure-length ,ly:moment? "Length of a measure. Used in some
550 spacing situations.")
551 (merge-differently-dotted ,boolean? "Merge note heads in
552 collisions, even if they have a different number of dots. This is
553 normal notation for some types of polyphonic music.
555 @code{merge-differently-dotted} only applies to opposing stem
556 directions (i.e., voice 1 &@tie{}2).")
557 (merge-differently-headed ,boolean? "Merge note heads in
558 collisions, even if they have different note heads. The smaller of
559 the two heads is rendered invisible. This is used in polyphonic
560 guitar notation. The value of this setting is used by
561 @rinternals{note-collision-interface}.
563 @code{merge-differently-headed} only applies to opposing stem
564 directions (i.e., voice 1 &@tie{}2).")
565 (minimum-distance ,ly:dimension? "Minimum distance between rest
567 (minimum-length ,ly:dimension? "Try to make a spanner at least
568 this long, normally in the horizontal direction. This requires an
569 appropriate callback for the @code{springs-and-rods} property. If
570 added to a @code{Tie}, this sets the minimum distance between
572 (minimum-length-fraction ,number? "Minimum length of ledger line
573 as fraction of note head size.")
574 (minimum-space ,ly:dimension? "Minimum distance that the victim
575 should move (after padding).")
576 (minimum-X-extent ,number-pair? "Minimum size of an object in
577 X@tie{}dimension, measured in @code{staff-space} units.")
578 (minimum-Y-extent ,number-pair? "Minimum size of an object in
579 Y@tie{}dimension, measured in @code{staff-space} units.")
585 (neutral-direction ,ly:dir? "Which direction to take in the
586 center of the staff.")
587 (neutral-position ,number? "Position (in half staff spaces) where
588 to flip the direction of custos stem.")
589 (next ,ly:grob? "Object that is next relation (e.g., the lyric
590 syllable following an extender).")
591 (no-alignment ,boolean? "If set, don't place this grob in a
592 @code{VerticalAlignment}; rather, place it using its own
593 @code{Y-offset} callback.")
594 (no-ledgers ,boolean? "If set, don't draw ledger lines on this
596 (no-stem-extend ,boolean? "If set, notes with ledger lines do not
597 get stems extending to the middle staff line.")
598 (non-break-align-symbols ,list? "A list of symbols that determine
599 which NON-break-aligned interfaces to align this to.")
600 (non-default ,boolean? "Set for manually specified clefs.")
601 (non-musical ,boolean? "True if the grob belongs to a
602 @code{NonMusicalPaperColumn}.")
603 (nonstaff-nonstaff-spacing ,list? "The spacing alist
604 controlling the distance between the current non-staff line and
605 the next non-staff line in the direction of @code{staff-affinity},
606 if both are on the same side of the related staff, and
607 @code{staff-affinity} is either @code{UP} or @code{DOWN}. See
608 @code{staff-staff-spacing} for a description of the alist
610 (nonstaff-relatedstaff-spacing ,list? "The spacing alist
611 controlling the distance between the current non-staff line and
612 the nearest staff in the direction of @code{staff-affinity}, if
613 there are no non-staff lines between the two, and
614 @code{staff-affinity} is either @code{UP} or @code{DOWN}. If
615 @code{staff-affinity} is @code{CENTER}, then
616 @code{nonstaff-relatedstaff-spacing} is used for the nearest
617 staves on @emph{both} sides, even if other non-staff lines appear
618 between the current one and either of the staves. See
619 @code{staff-staff-spacing} for a description of the alist
621 (nonstaff-unrelatedstaff-spacing ,list? "The spacing alist
622 controlling the distance between the current non-staff line and
623 the nearest staff in the opposite direction from
624 @code{staff-affinity}, if there are no other non-staff lines
625 between the two, and @code{staff-affinity} is either @code{UP} or
626 @code{DOWN}. See @code{staff-staff-spacing} for a description of
627 the alist structure.")
628 (normalized-endpoints ,pair? "Represents left and right placement
629 over the total spanner, where the width of the spanner is normalized
631 (note-names ,vector? "Vector of strings containing names for
632 easy-notation note heads.")
638 (outside-staff-horizontal-padding ,number? "By default, an
639 outside-staff-object can be placed so that is it very close to another
640 grob horizontally. If this property is set, the outside-staff-object
641 is raised so that it is not so close to its neighbor.")
642 (outside-staff-padding ,number? "The padding to place between
643 this grob and the staff when spacing according to
644 @code{outside-staff-priority}.")
645 (outside-staff-priority ,number? "If set, the grob is positioned
646 outside the staff in such a way as to avoid all collisions. In case
647 of a potential collision, the grob with the smaller
648 @code{outside-staff-priority} is closer to the staff.")
654 (packed-spacing ,boolean? "If set, the notes are spaced as
655 tightly as possible.")
656 (padding ,ly:dimension? "Add this much extra space between
657 objects that are next to each other.")
658 (padding-pairs ,list? "An alist mapping @code{(@var{name}
659 . @var{name})} to distances.")
660 (page-break-penalty ,number? "Penalty for page break at this
661 column. This affects the choices of the page breaker; it avoids a
662 page break at a column with a positive penalty and prefers a page
663 break at a column with a negative penalty.")
664 (page-break-permission ,symbol? "Instructs the page breaker on
665 whether to put a page break at this column. Can be @code{force} or
667 (page-turn-penalty ,number? "Penalty for a page turn at this
668 column. This affects the choices of the page breaker; it avoids a
669 page turn at a column with a positive penalty and prefers a page turn
670 at a column with a negative penalty.")
671 (page-turn-permission ,symbol? "Instructs the page breaker on
672 whether to put a page turn at this column. Can be @code{force} or
674 (parenthesized ,boolean? "Parenthesize this grob.")
675 (positions ,number-pair? "Pair of staff coordinates
676 @code{(@var{left} . @var{right})}, where both @var{left} and
677 @var{right} are in @code{staff-space} units of the current staff. For
678 slurs, this value selects which slur candidate to use; if extreme
679 positions are requested, the closest one is taken.")
680 (prefer-dotted-right ,boolean? "For note collisions, prefer to
681 shift dotted up-note to the right, rather than shifting just the
688 (ratio ,number? "Parameter for slur shape. The higher this
689 number, the quicker the slur attains its @code{height-limit}.")
690 (remove-empty ,boolean? "If set, remove group if it contains no
692 (remove-first ,boolean? "Remove the first staff of an orchestral
694 (replacement-alist ,list? "Alist of strings.
695 The key is a string of the pattern to be replaced. The value is a
696 string of what should be displayed. Useful for ligatures.")
697 (restore-first ,boolean? "Print a natural before the
699 (rhythmic-location ,rhythmic-location? "Where (bar number,
700 measure position) in the score.")
701 (right-bound-info ,list? "An alist of properties for determining
702 attachments of spanners to edges.")
703 (right-padding ,ly:dimension? "Space to insert on the right side
704 of an object (e.g., between note and its accidentals).")
705 (rotation ,list? "Number of degrees to rotate this object, and
706 what point to rotate around. For example, @code{'(45 0 0)} rotates
707 by 45 degrees around the center of this object.")
708 (round-up-to-longer-rest ,boolean? "Displays the longer multi-measure
709 rest when the length of a measure is between two values of
710 @code{usable-duration-logs}. For example, displays a breve instead of a whole
717 (same-direction-correction ,number? "Optical correction amount
718 for stems that are placed in tight configurations. This amount is
719 used for stems with the same direction to compensate for note head to
721 (script-priority ,number? "A sorting key that determines in what
722 order a script is within a stack of scripts.")
723 (self-alignment-X ,number? "Specify alignment of an object. The
724 value @w{@code{-1}} means left aligned, @code{0}@tie{}centered, and
725 @code{1}@tie{}right-aligned in X@tie{}direction. Other numerical
726 values may also be specified.")
727 (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
729 (shorten-pair ,number-pair? "The lengths to shorten a
730 text-spanner on both sides, for example a pedal bracket. Positive
731 values shorten the text-spanner, while negative values lengthen it.")
732 (shortest-duration-space ,ly:dimension? "Start with this much
733 space for the shortest duration. This is expressed in
734 @code{spacing-increment} as unit. See also
735 @rinternals{spacing-spanner-interface}.")
736 (shortest-playing-duration ,ly:moment? "The duration of the
737 shortest note playing here.")
738 (shortest-starter-duration ,ly:moment? "The duration of the
739 shortest note that starts here.")
740 (side-axis ,number? "If the value is @code{X} (or
741 equivalently@tie{}@code{0}), the object is placed horizontally next to
742 the other object. If the value is @code{Y} or@tie{}@code{1}, it is
744 (side-relative-direction ,ly:dir? "Multiply direction of
745 @code{direction-source} with this to get the direction of this
747 (simple-Y ,boolean? "Should the Y placement of a spanner
748 disregard changes in system heights?")
749 (size ,number? "Size of object, relative to standard size.")
750 (skip-quanting ,boolean? "Should beam quanting be skipped?")
751 (skyline-horizontal-padding ,number? "For determining the
752 vertical distance between two staves, it is possible to have a
753 configuration which would result in a tight interleaving of grobs from
754 the top staff and the bottom staff. The larger this parameter is, the
755 farther apart the staves are placed in such a configuration.")
756 (skyline-vertical-padding ,number? "The amount by which the left
757 and right skylines of a column are padded vertically, beyond the
758 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent
759 grobs in the column. Increase this to prevent interleaving of grobs
760 from adjacent columns.")
761 (slash-negative-kern ,number? "The space to remove between
762 slashes in percent repeat glyphs. Larger values bring the two
763 elements closer together.")
764 (slope ,number? "The slope of this object.")
765 (slur-padding ,number? "Extra distance between slur and script.")
766 (space-alist ,list? "A table that specifies distances between
767 prefatory items, like clef and time-signature. The format is an alist
768 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
769 . @var{distance})}, where @var{type} can be the symbols
770 @code{minimum-space} or @code{extra-space}.")
771 (space-to-barline ,boolean? "If set, the distance between a note
772 and the following non-musical column will be measured to the bar line
773 instead of to the beginning of the non-musical column. If there is a
774 clef change followed by a bar line, for example, this means that we
775 will try to space the non-musical column as though the clef is not
777 (spacing-increment ,number? "Add this much space for a doubled
778 duration. Typically, the width of a note head. See also
779 @rinternals{spacing-spanner-interface}.")
780 (spacing-pair ,pair? "A pair of alignment symbols which set an object's
781 spacing relative to its left and right @code{BreakAlignment}s.
783 For example, a @code{MultiMeasureRest} will ignore prefatory items at its
784 bounds (i.e., clefs, key signatures and time signatures) using the following
788 \\override MultiMeasureRest
789 #'spacing-pair = #'(staff-bar . staff-bar)
791 (spanner-id ,string? "An identifier to distinguish concurrent spanners.")
792 (springs-and-rods ,boolean? "Dummy variable for triggering
794 (stacking-dir ,ly:dir? "Stack objects in which direction?")
795 (staff-affinity ,ly:dir? "The direction of the staff to use
796 for spacing the current non-staff line. Choices are @code{UP},
797 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff
798 line will be placed equidistant between the two nearest staves on
799 either side, unless collisions or other spacing constraints
800 prevent this. Setting @code{staff-affinity} for a staff causes it
801 to be treated as a non-staff line. Setting @code{staff-affinity}
802 to @code{#f} causes a non-staff line to be treated as a staff.")
803 (staff-padding ,ly:dimension? "Maintain this much space between
804 reference points and the staff. Its effect is to align objects of
805 differing sizes (like the dynamics @b{p} and @b{f}) on their
807 (staff-position ,number? "Vertical position, measured in half
808 staff spaces, counted from the middle line.")
809 (staff-space ,ly:dimension? "Amount of space between staff lines,
810 expressed in global @code{staff-space}.")
811 (staff-staff-spacing ,list? "When applied to a staff-group's
812 @code{StaffGrouper} grob, this spacing alist controls the distance
813 between consecutive staves within the staff-group. When applied
814 to a staff's @code{VerticalAxisGroup} grob, it controls the
815 distance between the staff and the nearest staff below it in the
816 same system, replacing any settings inherited from the
817 @code{StaffGrouper} grob of the containing staff-group, if there
818 is one. This property remains in effect even when non-staff lines
819 appear between staves. The alist can contain the following keys:
824 @code{basic-distance} -- the vertical distance, measured in
825 staff-spaces, between the reference points of the two items when
826 no collisions would result, and no stretching or compressing is in
830 @code{minimum-distance} -- the smallest allowable vertical
831 distance, measured in staff-spaces, between the reference points
832 of the two items, when compressing is in effect.
835 @code{padding} -- the minimum required amount of unobstructed
836 vertical whitespace between the bounding boxes (or skylines) of
837 the two items, measured in staff-spaces.
840 @code{stretchability} -- a unitless measure of the dimension's
841 relative propensity to stretch. If zero, the distance will not
842 stretch (unless collisions would result).
845 (staffgroup-staff-spacing ,list? "The spacing alist
846 controlling the distance between the last staff of the current
847 staff-group and the staff just below it in the same system, even
848 if one or more non-staff lines exist between the two staves. If
849 the @code{staff-staff-spacing} property of the staff's
850 @code{VerticalAxisGroup} grob is set, that is used instead. See
851 @code{staff-staff-spacing} for a description of the alist
853 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
854 pair where the stem attaches to the notehead.")
855 (stem-begin-position ,number? "User override for the
856 begin position of a stem.")
858 (stem-spacing-correction ,number? "Optical correction amount for
859 stems that are placed in tight configurations. For opposite
860 directions, this amount is the correction for two normal sized stems
861 that overlap completely.")
862 (stemlet-length ,number? "How long should be a stem over a
864 (stencil ,ly:stencil? "The symbol to print.")
865 (stencils ,list? "Multiple stencils, used as intermediate
867 (strict-grace-spacing ,boolean? "If set, main notes are spaced
868 normally, then grace notes are put left of the musical columns for the
870 (strict-note-spacing ,boolean? "If set, unbroken columns with
871 non-musical material (clefs, bar lines, etc.) are not spaced
872 separately, but put before musical columns.")
873 (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
875 (style ,symbol? "This setting determines in what style a grob is
876 typeset. Valid choices depend on the @code{stencil} callback reading
883 (text ,markup? "Text markup. See @ruser{Formatting text}.")
884 ;;FIXME -- Should both be the same?
885 (text-direction ,ly:dir? "This controls the ordering of the
886 words. The default @code{RIGHT} is for roman text. Arabic or Hebrew
887 should use @code{LEFT}.")
888 (thick-thickness ,number? "Bar line thickness, measured in
889 @code{line-thickness}.")
890 (thickness ,number? "Line thickness, generally measured in
891 @code{line-thickness}.")
892 (thin-kern ,number? "The space after a hair-line in a bar line.")
893 (tie-configuration ,list? "List of @code{(@var{position} .
894 @var{dir})} pairs, indicating the desired tie configuration, where
895 @var{position} is the offset from the center of the staff in staff
896 space and @var{dir} indicates the direction of the tie
897 (@code{1}=>up, @w{@code{-1}}=>down, @code{0}=>center). A non-pair entry
898 in the list causes the corresponding tie to be formatted
900 (to-barline ,boolean? "If true, the spanner will stop at the bar
901 line just before it would otherwise stop.")
902 (toward-stem-shift ,number? "Amount by which scripts are shifted
903 toward the stem if their direction coincides with the stem direction.
904 @code{0.0} means keep the default position (centered on the note
905 head), @code{1.0} means centered on the stem. Interpolated values are
907 (transparent ,boolean? "This makes the grob invisible.")
913 (uniform-stretching ,boolean? "If set, items stretch
914 proportionally to their durations. This looks better in complex
915 polyphonic patterns.")
916 (used ,boolean? "If set, this spacing column is kept in the
918 (usable-duration-logs ,list? "List of @code{duration-log}s that
919 can be used in typesetting the grob.")
920 (use-skylines ,boolean? "Should skylines be used for side
926 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
927 one below this grob.")
933 (when ,ly:moment? "Global time step associated with this column
935 (whiteout ,boolean? "If true, the grob is printed over a white
936 background to white-out underlying material, if the grob is visible.
937 Usually #f by default.")
938 (width ,ly:dimension? "The width of a grob measured in staff
940 (word-space ,ly:dimension? "Space to insert between words in
947 (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
948 (X-offset ,number? "The horizontal amount that this object is
949 moved relative to its X-parent.")
950 (X-positions ,number-pair? "Pair of X staff coordinates of a spanner
951 in the form @code{(@var{left} . @var{right})}, where both @var{left} and
952 @var{right} are in @code{staff-space} units of the current staff.")
958 (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
959 (Y-offset ,number? "The vertical amount that this object is moved
960 relative to its Y-parent.")
965 (zigzag-length ,ly:dimension? "The length of the lines of a
966 zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1}
967 gives 60-degree zigzags.")
968 (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
969 This number is adjusted slightly so that the glissando line can be
970 constructed from a whole number of squiggles.")
978 (define (define-internal-grob-property symbol type? description)
979 (define-grob-property symbol type? description)
980 (set-object-property! symbol 'backend-internal #t)
985 (define-public all-internal-grob-properties
988 (apply define-internal-grob-property x))
992 ;; grobs & grob arrays. (alphabetical)
993 (accidental-grob ,ly:grob? "The accidental for this note.")
994 (accidental-grobs ,list? "An alist with @code{(@var{notename} .
995 @var{groblist})} entries.")
996 (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
998 (all-elements ,ly:grob-array? "An array of all grobs in this line. Its
999 function is to protect objects from being garbage collected.")
1000 (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
1001 (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
1002 (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
1004 (bars ,ly:grob-array? "An array of bar line pointers.")
1005 (beam ,ly:grob? "A pointer to the beam, if applicable.")
1006 (bound-alignment-interfaces ,list "Interfaces to be used
1007 for positioning elements that align with a column.")
1008 (bounded-by-me ,ly:grob-array? "An array of spanners that have this
1009 column as start/@/begin point. Only columns that have grobs or act as
1010 bounds are spaced.")
1011 (bracket ,ly:grob? "The bracket for a number.")
1013 (columns ,ly:grob-array? "An array of grobs, typically containing
1014 @code{PaperColumn} or @code{NoteColumn} objects.")
1015 (conditional-elements ,ly:grob-array? "Internal use only.")
1016 (covered-grobs ,ly:grob-array? "Grobs that could potentially collide
1019 (direction-source ,ly:grob? "In case @code{side-relative-direction} is
1020 set, which grob to get the direction from.")
1021 (display-cautionary ,boolean? "Should the grob be displayed as a cautionary grob?")
1022 (dot ,ly:grob? "A reference to a @code{Dots} object.")
1023 (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
1025 (elements ,ly:grob-array? "An array of grobs; the type is depending on
1026 the grob where this is set in.")
1027 (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
1028 in addition to notes and stems.")
1030 (figures ,ly:grob-array? "Figured bass objects for continuation line.")
1031 (flag ,ly:grob? "A pointer to a @code{Flag} object.")
1032 (footnote-stencil ,ly:stencil? "The stencil of a system's footnotes.")
1034 (glissando-index ,integer? "The index of a glissando in its note
1036 (grace-spacing ,ly:grob? "A run of grace notes.")
1038 (heads ,ly:grob-array? "An array of note heads.")
1040 (items-worth-living ,ly:grob-array? "An array of interesting items. If
1041 empty in a particular staff, then that staff is erased.")
1042 (in-note-direction ,ly:dir? "Direction to place in-notes above a system.")
1043 (in-note-padding ,number? "Padding between in-notes.")
1044 (in-note-stencil ,ly:stencil? "The stencil of a system's in-notes.")
1046 (keep-alive-with ,ly:grob-array? "An array of other
1047 @code{VerticalAxisGroup}s. If any of them are alive, then we will stay alive.")
1049 (left-items ,ly:grob-array? "DOCME")
1050 (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
1053 (normal-stems ,ly:grob-array? "An array of visible stems.")
1054 (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
1055 (note-head ,ly:grob? "A single note head.")
1056 (note-heads ,ly:grob-array? "An array of note head grobs.")
1057 (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
1059 (pure-relevant-grobs ,ly:grob-array? "All the grobs (items and spanners)
1060 that are relevant for finding the @code{pure-Y-extent}")
1061 (pure-relevant-items ,ly:grob-array? "A subset of elements that are
1062 relevant for finding the @code{pure-Y-extent}.")
1063 (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
1064 relevant for finding the @code{pure-Y-extent}.")
1065 (pure-Y-common ,ly:grob? "A cache of the
1066 @code{common_refpoint_of_array} of the @code{elements} grob set.")
1068 (rest ,ly:grob? "A pointer to a @code{Rest} object.")
1069 (rest-collision ,ly:grob? "A rest collision that a rest is in.")
1070 (rests ,ly:grob-array? "An array of rest objects.")
1071 (right-items ,ly:grob-array? "DOCME")
1072 (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
1074 (side-support-elements ,ly:grob-array? "The side support, an array of
1076 (slur ,ly:grob? "A pointer to a @code{Slur} object.")
1077 (spacing ,ly:grob? "The spacing spanner governing this section.")
1078 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
1080 (span-start ,boolean? "Is the note head at the start of a spanner?")
1081 (spanner-broken ,boolean? "Indicates whether spanner
1082 alignment should be broken after the current spanner.")
1083 (spanner-placement ,ly:dir? "The place of an annotation on a spanner.
1084 @code{LEFT} is for the first spanner, and @code{RIGHT} is for the last.
1085 @code{CENTER} will place it on the broken spanner that falls closest to the
1086 center of the length of the entire spanner, although this behavior is
1087 unpredictable in situations with lots of rhythmic diversity. For predictable
1088 results, use @code{LEFT} and @code{RIGHT}.")
1089 (staff-grouper ,ly:grob? "The staff grouper we belong to.")
1090 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
1091 (stem ,ly:grob? "A pointer to a @code{Stem} object.")
1092 (stems ,ly:grob-array? "An array of stem objects.")
1094 (tie ,ly:grob? "A pointer to a @code{Tie} object.")
1095 (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
1096 (tuplet-number ,ly:grob? "The number for a bracket.")
1097 (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
1098 (X-common ,ly:grob? "Common reference point for axis group.")
1099 (Y-common ,ly:grob? "See @code{X-common}.")
1103 (adjacent-pure-heights ,pair? "A pair of vectors. Used by a
1104 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
1107 (bar-extent ,number-pair? "The Y-extent of the actual bar line.
1108 This may differ from @code{Y-extent} because it does not include the dots in
1109 a repeat bar line.")
1110 (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
1111 @code{FretBoard} be visible only at beginning of line or at
1114 (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1115 translator) that was the cause for this grob.")
1116 (cross-staff ,boolean? "For a beam or a stem, this is true if we
1117 depend on inter-staff spacing.")
1119 (delta-position ,number? "The vertical position difference.")
1121 (font ,ly:font-metric? "A cached font metric object.")
1122 (forced ,boolean? "Manually forced accidental.")
1124 (head-width ,ly:dimension? "The width of this ligature head.")
1126 (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1127 @var{strength}))} pairs.")
1128 (important-column-ranks ,vector? "A cache of columns that contain
1129 @code{items-worth-living} data.")
1130 (interfaces ,list? "A list of symbols indicating the interfaces
1131 supported by this object. It is initialized from the @code{meta} field.")
1133 (least-squares-dy ,number? "The ideal beam slope, without damping.")
1135 (maybe-loose ,boolean? "Used to mark a breakable column that is
1136 loose if and only if it is in the middle of a line.")
1137 (meta ,list? "Provide meta information. It is an alist with the
1138 entries @code{name} and @code{interfaces}.")
1139 (minimum-distances ,list? "A list of rods that have the format
1140 @code{(@var{obj} . @var{dist})}.")
1142 (positioning-done ,boolean? "Used to signal that a positioning element
1143 did its job. This ensures that a positioning is only done once.")
1144 (pure-Y-extent ,number-pair? "The estimated height of a system.")
1145 (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1146 cyclic dependencies.")
1147 (quantize-position ,boolean? "If set, a vertical alignment is aligned
1148 to be within staff spaces.")
1149 (quantized-positions ,number-pair? "The beam positions after
1152 (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1153 acts as an index for looking up a @code{Stencil} object.")
1154 (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1155 Internally used to distribute beam shortening over stems.")
1156 (stem-info ,pair? "A cache of stem parameters.")
1157 (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1158 top-margin of the page) of the system to which this staff belongs.")
1165 ;; There are too many properties for ancient notation;
1166 ;; probably neume-types (a list of symbols) would also work.
1168 ;; However, such a list would consist of a couple of dozens of
1169 ;; entries, since head prefixes may be combined in many ways. If
1170 ;; the macros in `gregorian.ly' would directly set prefix-set,
1171 ;; all the head prefixes could be junked; however, such macros
1172 ;; would be quite numerous, I guess. --jr
1174 (add-cauda ,boolean? "Does this flexa require an additional cauda on
1176 (add-join ,boolean? "Is this ligature head-joined with the next one
1177 by a vertical line?")
1178 (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1179 an additional stem on the right side?")
1180 (ascendens ,boolean? "Is this neume of ascending type?")
1181 (auctum ,boolean? "Is this neume liquescentically augmented?")
1183 (cavum ,boolean? "Is this neume outlined?")
1184 (context-info ,integer? "Within a ligature, the final glyph or shape of
1185 a head may be affected by the left and/@/or right neighbour head.
1186 @code{context-info} holds for each head such information about the left and
1187 right neighbour, encoded as a bit mask.")
1189 (deminutum ,boolean? "Is this neume deminished?")
1190 (descendens ,boolean? "Is this neume of descendent type?")
1192 (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1193 grob (in @code{staff-space} units).")
1194 (flexa-interval ,integer? "The interval spanned by the two notes of a
1195 flexa shape (1 is a second, 7 is an octave).")
1196 (flexa-width ,ly:dimension? "The width of a flexa shape in a
1197 ligature grob in (in @code{staff-space} units).")
1198 (ligature-flexa ,boolean? "request joining note to the previous one
1201 (inclinatum ,boolean? "Is this neume an inclinatum?")
1204 (linea ,boolean? "Attach vertical lines to this neume?")
1206 (oriscus ,boolean? "Is this neume an oriscus?")
1208 (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1210 (prefix-set ,number? "A bit mask that holds all Gregorian head
1211 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1212 (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1213 similar to a note head that is part of a ligature.")
1215 (quilisma ,boolean? "Is this neume a quilisma?")
1217 (stropha ,boolean? "Is this neume a stropha?")
1219 (virga ,boolean? "Is this neume a virga?")
1221 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1225 (define-public all-backend-properties
1227 all-internal-grob-properties
1228 all-user-grob-properties))