]> git.donarmstrong.com Git - lilypond.git/blob - scm/define-grob-properties.scm
Doc: CG: add warning about non-sequential reading.
[lilypond.git] / scm / define-grob-properties.scm
1 ;;;; This file is part of LilyPond, the GNU music typesetter.
2 ;;;;
3 ;;;; Copyright (C) 1998--2009  Han-Wen Nienhuys <hanwen@xs4all.nl>
4 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
5 ;;;;
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.
10 ;;;;
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.
15 ;;;;
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/>.
18
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))
22
23   (set-object-property! symbol 'backend-type? type?)
24   (set-object-property! symbol 'backend-doc description)
25   symbol)
26
27 ;; put this in an alist?
28 (define-public
29   all-user-grob-properties
30
31   (map
32    (lambda (x)
33      (apply define-grob-property x))
34
35    `(
36 ;;
37 ;; a
38 ;;
39      (add-stem-support ,boolean? "If set, the @code{Stem} object is
40 included in this script's support.")
41      (after-last-staff-spacing ,list? "An alist of spacing variables
42 that controls the spacing after the last staff in this staff group.
43 See @var{next-staff-spacing} for a description of the elements of
44 this alist.")
45      (after-line-breaking ,boolean? "Dummy property, used to trigger
46 callback for @code{after-line-breaking}.")
47      (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
48 @code{0}: around center of width, @code{1}: right side.")
49      (allow-loose-spacing ,boolean? "If set, column can be detached
50 from main spacing.")
51      (allow-span-bar ,boolean? "If false, no inter-staff bar line will
52 be created below this bar line.")
53      (alteration ,number? "Alteration numbers for accidental.")
54      (alteration-alist ,list? "List of @code{(@var{pitch}
55 . @var{accidental})} pairs for key signature.")
56      (annotation ,string? "Annotate a grob for debug purposes.")
57      (arpeggio-direction ,ly:dir? "If set, put an arrow on the
58 arpeggio squiggly line.")
59      (arrow-length ,number? "Arrow length.")
60      (arrow-width ,number? "Arrow width.")
61      (auto-knee-gap ,ly:dimension? "If a gap is found between note
62 heads where a horizontal beam fits that is larger than this number,
63 make a kneed beam.")
64      (average-spacing-wishes ,boolean? "If set, the spacing wishes are
65 averaged over staves.")
66      (avoid-note-head ,boolean? "If set, the stem of a chord does not
67 pass through all note heads, but starts at the last note head.")
68      (avoid-slur ,symbol? "Method of handling slur collisions.
69 Choices are @code{inside}, @code{outside}, @code{around}, and
70 @code{ignore}.  @code{inside} adjusts the slur if needed to keep the
71 grob inside the slur.  @code{outside} moves the grob vertically to the
72 outside of the slur.  @code{around} moves the grob vertically to the
73 outside of the slur only if there is a collision.  @code{ignore} does
74 not move either.  In grobs whose notational significance depends on
75 vertical position (such as accidentals, clefs, etc.), @code{outside}
76 and @code{around} behave like @code{ignore}.")
77      (axes ,list? "List of axis numbers.  In the case of alignment
78 grobs, this should contain only one number.")
79
80
81 ;;
82 ;; b
83 ;;
84      (bar-size ,ly:dimension? "The size of a bar line.")
85      (base-shortest-duration ,ly:moment? "Spacing is based on the
86 shortest notes in a piece.  Normally, pieces are spaced as if notes at
87 least as short as this are present.")
88      (baseline-skip ,ly:dimension? "Distance between base lines of
89 multiple lines of text.")
90      (beam-thickness ,ly:dimension? "Beam thickness, measured in
91 @code{staff-space} units.")
92      (beam-width ,ly:dimension? "Width of the tremolo sign.")
93      (beamed-stem-shorten ,list? "How much to shorten beamed stems,
94 when their direction is forced.  It is a list, since the value is
95 different depending on the number of flags and beams.")
96      (beaming ,pair? "Pair of number lists.  Each number list
97 specifies which beams to make.  @code{0}@tie{}is the central beam,
98 @code{1}@tie{}is the next beam toward the note, etc.  This information
99 is used to determine how to connect the beaming patterns from stem to
100 stem inside a beam.")
101      (beamlet-default-length ,pair? "A pair of numbers.  The first
102 number specifies the default length of a beamlet that sticks out of
103 the left hand side of this stem; the second number specifies the
104 default length of the beamlet to the right.  The actual length of a
105 beamlet is determined by taking either the default length or the
106 length specified by @code{beamlet-max-length-proportion}, whichever is
107 smaller.")
108      (beamlet-max-length-proportion ,pair? "The maximum length of a
109 beamlet, as a proportion of the distance between two adjacent stems.")
110      (before-line-breaking ,boolean? "Dummy property, used to trigger
111 a callback function.")
112      (between-cols ,pair? "Where to attach a loose column to.")
113      (between-staff-spacing ,list? "An alist of spacing variables
114 that controls the spacing between staves within this staff group.
115 See @var{next-staff-spacing} for a description of the elements of
116 this alist.")
117      (bound-details ,list? "An alist of properties for determining
118 attachments of spanners to edges.")
119      (bound-padding ,number? "The amount of padding to insert around
120 spanner bounds.")
121      (bracket-flare ,number-pair? "A pair of numbers specifying how
122 much edges of brackets should slant outward.  Value @code{0.0} means
123 straight edges.")
124      (bracket-visibility ,boolean-or-symbol? "This controls the
125 visibility of the tuplet bracket.  Setting it to false prevents
126 printing of the bracket.  Setting the property to @code{if-no-beam}
127 makes it print only if there is no beam associated with this tuplet
128 bracket.")
129      (break-align-anchor ,number? "Grobs aligned to this break-align
130 grob will have their X-offsets shifted by this number.  In bar lines,
131 for example, this is used to position grobs relative to the (visual)
132 center of the bar line.")
133      (break-align-anchor-alignment ,number? "Read by
134 @code{ly:break-aligned-interface::calc-extent-aligned-anchor} for
135 aligning an anchor to a grob's extent.")
136      (break-align-orders ,vector? "Defines the order in which
137 prefatory matter (clefs, key signatures) appears.  The format is a
138 vector of length@tie{}3, where each element is one order for
139 end-of-line, middle of line, and start-of-line, respectively.  An
140 order is a list of symbols.
141
142 For example, clefs are put after key signatures by setting
143
144 @example
145 \\override Score.BreakAlignment #'break-align-orders =
146   #(make-vector 3 '(span-bar
147                     breathing-sign
148                     staff-bar
149                     key
150                     clef
151                     time-signature))
152 @end example")
153      (break-align-symbol ,symbol? "This key is used for aligning and
154 spacing breakable items.")
155      (break-align-symbols ,list? "A list of symbols that determine
156 which break-aligned grobs to align this to.  If the grob selected by
157 the first symbol in the list is invisible due to break-visibility, we
158 will align to the next grob (and so on).  Choices are @code{left-edge},
159 @code{ambitus}, @code{breathing-sign}, @code{clef}, @code{staff-bar},
160 @code{key-cancellation}, @code{key-signature}, @code{time-signature},
161 and @code{custos}.")
162      (break-overshoot ,number-pair? "How much does a broken spanner
163 stick out of its bounds?")
164      (break-visibility ,vector? "A vector of 3@tie{}booleans,
165 @code{#(@var{end-of-line} @var{unbroken} @var{begin-of-line})}.
166 @code{#t} means visible, @code{#f} means killed.")
167      (breakable ,boolean? "Allow breaks here.")
168
169
170 ;;
171 ;; c
172 ;;
173      (c0-position ,integer? "An integer indicating the position of
174 middle@tie{}C.")
175      (circled-tip ,boolean? "Put a circle at start/end of
176 hairpins (al/del niente).")
177      (clip-edges ,boolean? "Allow outward pointing beamlets at the
178 edges of beams?")
179      (collapse-height ,ly:dimension? "Minimum height of system start
180 delimiter.  If equal or smaller, the bracket/brace/line is removed.")
181      (color ,color? "The color of this grob.")
182      (common-shortest-duration ,ly:moment? "The most common shortest
183 note length.  This is used in spacing.  Enlarging this sets the score
184 tighter.")
185      (concaveness ,number? "A beam is concave if its inner stems are
186 closer to the beam than the two outside stems.  This number is a
187 measure of the closeness of the inner stems.  It is used for damping
188 the slope of the beam.")
189      (connect-to-neighbor ,pair? "Pair of booleans, indicating whether
190 this grob looks as a continued break.")
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.")
194
195
196 ;;
197 ;; d
198 ;;
199      (damping ,number? "Amount of beam slope damping.")
200      (dash-definition ,pair? "List of @code{dash-elements} defining the
201 dash structure.  Each @code{dash-element} has a starting t value,
202 an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")
203      (dash-fraction ,number? "Size of the dashes, relative to
204 @code{dash-period}.  Should be between @code{0.0} (no line) and
205 @code{1.0} (continuous line).")
206      (dash-period ,number? "The length of one dash together with
207 whitespace.  If negative, no line is drawn at all.")
208      (default-direction ,ly:dir? "Direction determined by note head
209 positions.")
210      (default-next-staff-spacing ,list? "An alist of spacing variables
211 that controls the spacing between this staff and the next.
212 See @var{next-staff-spacing} for a description of the elements of
213 this alist.")
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}=@code{-1},
225 @code{#LEFT}=@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.")
236
237
238 ;;
239 ;; e
240 ;;
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      (expand-limit ,integer? "Maximum number of measures expanded in
248 church rests.")
249      ;; remove me?
250      (extra-dy ,number? "Slope glissandi this much extra.")
251      (extra-offset ,number-pair? "A pair representing an offset.  This
252 offset is added just before outputting the symbol, so the typesetting
253 engine is completely oblivious to it.  The values are measured in
254 @code{staff-space} units of the staff's @code{StaffSymbol}.")
255      (extra-spacing-height ,number-pair? "In the horizontal spacing
256 problem, we increase the height of each item by this amount (by adding
257 the @q{car} to the bottom of the item and adding the @q{cdr} to the
258 top of the item).  In order to make a grob infinitely high (to prevent
259 the horizontal spacing problem from placing any other grobs above or
260 below this grob), set this to @code{(-inf.0 . +inf.0)}.")
261      (extra-spacing-width ,number-pair? "In the horizontal spacing
262 problem, we pad each item by this amount (by adding the @q{car} on the
263 left side of the item and adding the @q{cdr} on the right side of the
264 item).  In order to make a grob take up no horizontal space at all,
265 set this to @code{(+inf.0 . -inf.0)}.")
266      (extra-X-extent ,number-pair? "A grob is enlarged in
267 X@tie{}dimension by this much.")
268      (extra-Y-extent ,number-pair? "A grob is enlarged in
269 Y@tie{}dimension by this much.")
270
271
272 ;;
273 ;; f
274 ;;
275      (flag ,ly:stencil? "A function returning the full flag stencil
276 for the @code{Stem}, which is passed to the function as the only
277 argument.  The default ly:stem::calc-stencil function uses the
278 @code{flag-style} property to determine the correct glyph for the
279 flag.  By providing your own function, you can create arbitrary
280 flags.")
281      (flag-count ,number? "The number of tremolo beams.")
282      (flag-style ,symbol? "A symbol determining what style of flag
283 glyph is typeset on a @code{Stem}.  Valid options include @code{'()}
284 for standard flags, @code{'mensural} and @code{'no-flag}, which
285 switches off the flag.")
286      (font-encoding ,symbol? "The font encoding is the broadest
287 category for selecting a font.  Currently, only lilypond's system
288 fonts (Emmentaler and Aybabtu) are using this property.  Available
289 values are @code{fetaMusic} (Emmentaler), @code{fetaBraces} (Aybabtu),
290 @code{fetaNumber} (Emmentaler), and @code{fetaDynamic} (Emmentaler).")
291      (font-family ,symbol? "The font family is the broadest category
292 for selecting text fonts.  Options include: @code{sans},
293 @code{roman}.")
294      (font-name ,string? "Specifies a file name (without extension) of
295 the font to load.  This setting overrides selection using
296 @code{font-family}, @code{font-series} and @code{font-shape}.")
297      (font-series ,symbol? "Select the series of a font.  Choices
298 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
299      (font-shape ,symbol? "Select the shape of a font.  Choices
300 include @code{upright}, @code{italic}, @code{caps}.")
301      (font-size ,number? "The font size, compared to the
302 @q{normal}@tie{}size.  @code{0}@tie{}is style-sheet's normal size,
303 @code{-1} is smaller, @code{+1} is bigger.  Each step of@tie{}1 is
304 approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2
305 larger.  Fractional values are allowed.")
306      (force-hshift ,number? "This specifies a manual shift for notes
307 in collisions.  The unit is the note head width of the first voice
308 note.  This is used by @rinternals{note-collision-interface}.")
309      (fraction ,number-pair? "Numerator and denominator of a time
310 signature object.")
311      (french-beaming ,boolean? "Use French beaming style for this
312 stem.  The stem stops at the innermost beams.")
313      (fret-diagram-details ,list? "An alist of detailed grob
314 properties for fret diagrams.  Each alist entry consists of a
315 @code{(@var{property} .  @var{value})} pair.  The properties which can
316 be included in @code{fret-diagram-details} include the following:
317
318 @itemize @bullet
319 @item
320 @code{barre-type} -- Type of barre indication used.  Choices include
321 @code{curved}, @code{straight}, and @code{none}.  Default
322 @code{curved}.
323 @item
324 @code{capo-thickness} -- Thickness of capo indicator, in multiples of
325 fret-space.  Default value@tie{}0.5.
326 @item
327 @code{dot-color} -- Color of dots.  Options include @code{black} and
328 @code{white}.  Default @code{black}.
329 @item
330 @code{dot-label-font-mag} -- Magnification for font used to label fret
331 dots.  Default value@tie{}1.
332 @item
333 @code{dot-position} -- Location of dot in fret space.  Default 0.6 for
334 dots without labels, 0.95-@code{dot-radius} for dots with labels.
335 @item
336 @code{dot-radius} -- Radius of dots, in terms of fret spaces.  Default
337 value 0.425 for labeled dots, 0.25 for unlabeled dots.
338 @item
339 @code{finger-code} -- Code for the type of fingering indication used.
340 Options include @code{none}, @code{in-dot}, and @code{below-string}.
341 Default @code{none} for markup fret diagrams, @code{below-string} for
342 @code{FretBoards} fret diagrams.
343 @item
344 @code{fret-count} -- The number of frets.  Default@tie{}4.
345 @item
346 @code{fret-label-font-mag} -- The magnification of the font used to
347 label the lowest fret number.  Default@tie{}0.5.
348 @item
349 @code{fret-label-vertical-offset} -- The offset of the fret label from
350 the center of the fret in direction parallel to strings.
351 Default@tie{}0.
352 @item
353 @code{label-dir} -- Side to which the fret label is attached.
354 @code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down; @code{1},
355 @code{#RIGHT}, or @code{#UP} for right or up.  Default @code{#RIGHT}.
356 @item
357 @code{mute-string} -- Character string to be used to indicate muted
358 string.  Default @code{\"x\"}.
359 @item
360 @code{number-type} -- Type of numbers to use in fret label.  Choices
361 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.
362 Default @code{roman-lower}.
363 @item
364 @code{open-string} -- Character string to be used to indicate open
365 string.  Default @code{\"o\"}.
366 @item
367 @code{orientation} -- Orientation of fret-diagram.  Options include
368 @code{normal}, @code{landscape}, and @code{opposing-landscape}.
369 Default @code{normal}.
370 @item
371 @code{string-count} -- The number of strings.  Default@tie{}6.
372 @item
373 @code{string-label-font-mag} -- The magnification of the font used to
374 label fingerings at the string, rather than in the dot.  Default value
375 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and
376 @code{opposing-landscape}.
377 @item
378 @code{string-thickness-factor} -- Factor for changing thickness of
379 each string in the fret diagram.  Thickness of string @var{k} is given
380 by @code{thickness}
381 * (1+@code{string-thickness-factor})@tie{}^ (@var{k}-1).
382 Default@tie{}0.
383 @item
384 @code{top-fret-thickness} -- The thickness of the top fret line, as a
385 multiple of the standard thickness.  Default value@tie{}3.
386 @item
387 @code{xo-font-magnification} -- Magnification used for mute and open
388 string indicators.  Default value@tie{}0.5.
389 @item
390 @code{xo-padding} -- Padding for open and mute indicators from top
391 fret.  Default value 0.25.
392 @end itemize")
393      ;; ugh: double, change.
394      (full-length-padding ,number? "How much padding to use at the
395 right side of a full-length tuplet bracket.")
396      (full-length-to-extent ,boolean? "Run to the extent of the column
397 for a full-length tuplet bracket.")
398      (full-measure-extra-space ,number? "Extra space that is allocated
399 at the beginning of a measure with only one note.  This property is
400 read from the NonMusicalPaperColumn that begins the measure.")
401      (full-size-change ,boolean? "Don't make a change clef smaller.")
402
403
404 ;;
405 ;; g
406 ;;
407      (gap ,ly:dimension? "Size of a gap in a variable symbol.")
408      (gap-count ,integer? "Number of gapped beams for tremolo.")
409      (glyph ,string? "A string determining what @q{style} of glyph is
410 typeset.  Valid choices depend on the function that is reading this
411 property.")
412      (glyph-name ,string? "The glyph name within the font.")
413      (glyph-name-alist ,list? "An alist of key-string pairs.")
414      (grow-direction ,ly:dir? "Crescendo or decrescendo?")
415
416
417 ;;
418 ;; h
419 ;;
420      (hair-thickness ,number? "Thickness of the thin line in a bar
421 line.")
422      (harp-pedal-details ,list? "An alist of detailed grob properties
423 for harp pedal diagrams.  Each alist entry consists of a
424 @code{(@var{property} . @var{value})} pair.  The properties which can
425 be included in harp-pedal-details include the following:
426
427 @itemize @bullet
428 @item
429 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
430 boxes above/below the horizontal line.  Default value@tie{}0.8.
431 @item
432 @code{box-width} -- Width of each pedal box.  Default value@tie{}0.4.
433 @item
434 @code{box-height} -- Height of each pedal box.  Default value@tie{}1.0.
435 @item
436 @code{space-before-divider} -- Space between boxes before the first
437 divider (so that the diagram can be made symmetric).  Default
438 value@tie{}0.8.
439 @item
440 @code{space-after-divider} -- Space between boxes after the first
441 divider.  Default value@tie{}0.8.
442 @item
443 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
444 of the ellipse around circled pedals.  Default value@tie{}0.5.
445 @item
446 @code{circle-x-padding} -- Padding in X direction of the ellipse
447 around circled pedals.  Default value 0.15.
448 @item
449 @code{circle-y-padding} -- Padding in Y direction of the ellipse
450 around circled pedals.  Default value@tie{}0.2.
451 @end itemize")
452      (head-direction ,ly:dir? "Are the note heads left or right in a
453 semitie?")
454      (height ,ly:dimension? "Height of an object in @code{staff-space}
455 units.")
456      (height-limit ,ly:dimension? "Maximum slur height: The longer the
457 slur, the closer it is to this height.")
458      (hide-tied-accidental-after-break ,boolean? "If set, an accidental
459 that appears on a tied note after a line break will not be displayed.")
460      (horizontal-shift ,integer? "An integer that identifies ranking
461 of @code{NoteColumn}s for horizontal shifting.  This is used by
462 @rinternals{note-collision-interface}.")
463      (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the
464 left and one to the right of this grob.")
465
466
467 ;;
468 ;; i
469 ;;
470      (ignore-collision ,boolean? "If set, don't do note collision
471 resolution on this @code{NoteColumn}.")
472      (implicit ,boolean? "Is this an implicit bass figure?")
473      (inspect-index ,integer? "If debugging is set, set beam and slur
474 configuration to this index, and print the respective scores.")
475      (inspect-quants ,number-pair? "If debugging is set, set beam and
476 slur quants to this position, and print the respective scores.")
477      (inter-loose-line-spacing ,list? "Specifies how to vertically
478 position a non-spaced line relative to the other non-spaced lines
479 around it.  See @var{next-staff-spacing} for the format of this list.")
480      (inter-staff-spacing ,list? "Specifies how to vertically
481 position a non-spaced line relative to the staff for which it
482 has affinity.  See @var{next-staff-spacing} for the format of this list.")
483
484
485 ;;
486 ;; k
487 ;;
488      (keep-fixed-while-stretching ,boolean? "A grob with this property
489 set to true is fixed relative to the staff above it when systems are
490 stretched.")
491      (keep-inside-line ,boolean? "If set, this column cannot have
492 objects sticking into the margin.")
493      (kern ,ly:dimension? "Amount of extra white space to add.  For
494 bar lines, this is the amount of space after a thick line.")
495      (knee ,boolean? "Is this beam kneed?")
496      (knee-spacing-correction ,number? "Factor for the optical
497 correction amount for kneed beams.  Set between @code{0} for no
498 correction and @code{1} for full correction.")
499
500
501 ;;
502 ;; l
503 ;;
504      (labels ,list? "List of labels (symbols) placed on a column.")
505      (layer ,integer? "The output layer (a value between 0
506 and@tie{}2): Layers define the order of printing objects.  Objects in
507 lower layers are overprinted by objects in higher layers.")
508      (ledger-line-thickness ,number-pair? "The thickness of ledger
509 lines.  It is the sum of 2@tie{}numbers: The first is the factor for
510 line thickness, and the second for staff space.  Both contributions
511 are added.")
512      (left-bound-info ,list? "An alist of properties for determining
513 attachments of spanners to edges.")
514      (left-padding ,ly:dimension? "The amount of space that is put
515 left to an object (e.g., a group of accidentals).")
516      (length ,ly:dimension? "User override for the stem length of
517 unbeamed stems.")
518      (length-fraction ,number? "Multiplier for lengths.  Used for
519 determining ledger lines and stem lengths.")
520      (line-break-penalty ,number? "Penalty for a line break at this
521 column.  This affects the choices of the line breaker; it avoids a
522 line break at a column with a positive penalty and prefers a line
523 break at a column with a negative penalty.")
524      (line-break-permission ,symbol? "Instructs the line breaker on
525 whether to put a line break at this column.  Can be @code{force} or
526 @code{allow}.")
527      (line-break-system-details ,list? "An alist of properties to use
528 if this column is the start of a system.")
529      (line-count ,integer? "The number of staff lines.")
530      (line-positions ,list? "Vertical positions of staff lines.")
531      (line-thickness ,number? "The thickness of the tie or slur
532 contour.")
533      (long-text ,markup? "Text markup.  See @ruser{Formatting text}.")
534
535
536 ;;
537 ;; m
538 ;;
539      (max-beam-connect ,integer? "Maximum number of beams to connect
540 to beams from this stem.  Further beams are typeset as beamlets.")
541      (max-stretch ,number? "The maximum amount that this
542 @code{VerticalAxisGroup} can be vertically stretched (for example, in
543 order to better fill a page).")
544      (measure-count ,integer? "The number of measures for a
545 multi-measure rest.")
546      (measure-length ,ly:moment? "Length of a measure.  Used in some
547 spacing situations.")
548      (merge-differently-dotted ,boolean? "Merge note heads in
549 collisions, even if they have a different number of dots.  This is
550 normal notation for some types of polyphonic music.
551
552 @code{merge-differently-dotted} only applies to opposing stem
553 directions (i.e., voice 1 &@tie{}2).")
554      (merge-differently-headed ,boolean? "Merge note heads in
555 collisions, even if they have different note heads.  The smaller of
556 the two heads is rendered invisible.  This is used in polyphonic
557 guitar notation.  The value of this setting is used by
558 @rinternals{note-collision-interface}.
559
560 @code{merge-differently-headed} only applies to opposing stem
561 directions (i.e., voice 1 &@tie{}2).")
562      (minimum-distance ,ly:dimension? "Minimum distance between rest
563 and notes or beam.")
564      (minimum-length ,ly:dimension? "Try to make a spanner at least
565 this long, normally in the horizontal direction.  This requires an
566 appropriate callback for the @code{springs-and-rods} property.  If
567 added to a @code{Tie}, this sets the minimum distance between
568 noteheads.")
569      (minimum-length-fraction ,number? "Minimum length of ledger line
570 as fraction of note head size.")
571      (minimum-space ,ly:dimension? "Minimum distance that the victim
572 should move (after padding).")
573      (minimum-X-extent ,number-pair? "Minimum size of an object in
574 X@tie{}dimension, measured in @code{staff-space} units.")
575      (minimum-Y-extent ,number-pair? "Minimum size of an object in
576 Y@tie{}dimension, measured in @code{staff-space} units.")
577
578
579 ;;
580 ;; n
581 ;;
582      (neutral-direction ,ly:dir? "Which direction to take in the
583 center of the staff.")
584      (neutral-position ,number? "Position (in half staff spaces) where
585 to flip the direction of custos stem.")
586      (next ,ly:grob? "Object that is next relation (e.g., the lyric
587 syllable following an extender).")
588      (next-staff-spacing ,list? "An alist of properties used to position
589 the next staff in the system.  The symbols that can be defined in the alist
590 are
591 @itemize @bullet
592 @item @var{space} -- the amount of stretchable space between the center
593 of this staff and the center of the next staff;
594 @item @var{padding} -- the minimum amount of whitespace that must be
595 present between this staff and the next staff;
596 @item @var{stretchability} -- the ease with which the stretchable
597 space increases when the system to which this staff belongs is stretched.
598 If this is zero, the distance to the next staff will be fixed either at
599 @var{space} or at @var{padding} plus the minimum distance to ensure
600 there is no overlap, whichever is larger;
601 @item @var{minimum-distance} -- the minimum distance to place between
602 the center of this staff and the center of the next. This differs
603 from @var{padding} in that the height of a staff has no effect on
604 the application of @var{minimum-distance} (whereas the height of a
605 staff is crucial for @var{padding}).
606 @end itemize")
607      (no-alignment ,boolean? "If set, don't place this grob in a
608 @code{VerticalAlignment}; rather, place it using its own
609 @code{Y-offset} callback.")
610      (no-ledgers ,boolean? "If set, don't draw ledger lines on this
611 object.")
612      (no-stem-extend ,boolean? "If set, notes with ledger lines do not
613 get stems extending to the middle staff line.")
614      (non-affinity-spacing ,list? "An alist of spacing variables
615 that controls the spacing from a loose line (see @var{staff-affinity})
616 to the staff for which the loose line does not have affinity.
617 See @var{next-staff-spacing} for a description of the elements of
618 this alist.")
619      (non-default ,boolean? "Set for manually specified clefs.")
620      (non-musical ,boolean? "True if the grob belongs to a
621 @code{NonMusicalPaperColumn}.")
622      (note-names ,vector? "Vector of strings containing names for
623 easy-notation note heads.")
624
625
626 ;;
627 ;; o
628 ;;
629      (outside-staff-horizontal-padding ,number? "By default, an
630 outside-staff-object can be placed so that is it very close to another
631 grob horizontally.  If this property is set, the outside-staff-object
632 is raised so that it is not so close to its neighbor.")
633      (outside-staff-padding ,number? "The padding to place between
634 this grob and the staff when spacing according to
635 @code{outside-staff-priority}.")
636      (outside-staff-priority ,number? "If set, the grob is positioned
637 outside the staff in such a way as to avoid all collisions.  In case
638 of a potential collision, the grob with the smaller
639 @code{outside-staff-priority} is closer to the staff.")
640
641
642 ;;
643 ;; p
644 ;;
645      (packed-spacing ,boolean? "If set, the notes are spaced as
646 tightly as possible.")
647      (padding ,ly:dimension? "Add this much extra space between
648 objects that are next to each other.")
649      (padding-pairs ,list? "An alist mapping @code{(@var{name}
650 . @var{name})} to distances.")
651      (page-break-penalty ,number? "Penalty for page break at this
652 column.  This affects the choices of the page breaker; it avoids a
653 page break at a column with a positive penalty and prefers a page
654 break at a column with a negative penalty.")
655      (page-break-permission ,symbol? "Instructs the page breaker on
656 whether to put a page break at this column.  Can be @code{force} or
657 @code{allow}.")
658      (page-turn-penalty ,number? "Penalty for a page turn at this
659 column.  This affects the choices of the page breaker; it avoids a
660 page turn at a column with a positive penalty and prefers a page turn
661 at a column with a negative penalty.")
662      (page-turn-permission ,symbol? "Instructs the page breaker on
663 whether to put a page turn at this column.  Can be @code{force} or
664 @code{allow}.")
665      (parenthesized ,boolean? "Parenthesize this grob.")
666      (positions ,number-pair? "Pair of staff coordinates
667 @code{(@var{left} . @var{right})}, where both @var{left} and
668 @var{right} are in @code{staff-space} units of the current staff.  For
669 slurs, this value selects which slur candidate to use; if extreme
670 positions are requested, the closest one is taken.")
671      (prefer-dotted-right ,boolean? "For note collisions, prefer to
672 shift dotted up-note to the right, rather than shifting just the
673 dot.")
674
675
676 ;;
677 ;; r
678 ;;
679      (ratio ,number? "Parameter for slur shape.  The higher this
680 number, the quicker the slur attains its @code{height-limit}.")
681      (remove-empty ,boolean? "If set, remove group if it contains no
682 interesting items.")
683      (remove-first ,boolean? "Remove the first staff of an orchestral
684 score?")
685      (restore-first ,boolean? "Print a natural before the
686 accidental.")
687      (rhythmic-location ,rhythmic-location? "Where (bar number,
688 measure position) in the score.")
689      (right-bound-info ,list? "An alist of properties for determining
690 attachments of spanners to edges.")
691      (right-padding ,ly:dimension? "Space to insert on the right side
692 of an object (e.g., between note and its accidentals).")
693      (rotation ,list? "Number of degrees to rotate this object, and
694 what point to rotate around.  For example, @code{#'(45 0 0)} rotates
695 by 45 degrees around the center of this object.")
696
697
698 ;;
699 ;; s
700 ;;
701      (same-direction-correction ,number? "Optical correction amount
702 for stems that are placed in tight configurations.  This amount is
703 used for stems with the same direction to compensate for note head to
704 stem distance.")
705      (script-priority ,number? "A sorting key that determines in what
706 order a script is within a stack of scripts.")
707      (self-alignment-X ,number? "Specify alignment of an object.  The
708 value @code{-1} means left aligned, @code{0}@tie{}centered, and
709 @code{1}@tie{}right-aligned in X@tie{}direction.  Other numerical
710 values may also be specified.")
711      (self-alignment-Y ,number? "Like @code{self-alignment-X} but for
712 the Y@tie{}axis.")
713      (shorten-pair ,number-pair? "The lengths to shorten a
714 text-spanner on both sides, for example a pedal bracket.  Positive
715 values shorten the text-spanner, while negative values lengthen it.")
716      (shortest-duration-space ,ly:dimension? "Start with this much
717 space for the shortest duration.  This is expressed in
718 @code{spacing-increment} as unit.  See also
719 @rinternals{spacing-spanner-interface}.")
720      (shortest-playing-duration ,ly:moment? "The duration of the
721 shortest note playing here.")
722      (shortest-starter-duration ,ly:moment? "The duration of the
723 shortest note that starts here.")
724      (side-axis ,number? "If the value is @code{#X} (or
725 equivalently@tie{}@code{0}), the object is placed horizontally next to
726 the other object.  If the value is @code{#Y} or@tie{}@code{1}, it is
727 placed vertically.")
728      (side-relative-direction ,ly:dir? "Multiply direction of
729 @code{direction-source} with this to get the direction of this
730 object.")
731      (size ,number? "Size of object, relative to standard size.")
732      (skyline-horizontal-padding ,number? "For determining the
733 vertical distance between two staves, it is possible to have a
734 configuration which would result in a tight interleaving of grobs from
735 the top staff and the bottom staff.  The larger this parameter is, the
736 farther apart the staves are placed in such a configuration.")
737      (slash-negative-kern ,number? "The space to remove between
738 slashes in percent repeat glyphs.  Larger values bring the two
739 elements closer together.")
740      (slope ,number? "The slope of this object.")
741      (slur-padding ,number? "Extra distance between slur and script.")
742      (space-alist ,list? "A table that specifies distances between
743 prefatory items, like clef and time-signature.  The format is an alist
744 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
745 . @var{distance})}, where @var{type} can be the symbols
746 @code{minimum-space} or @code{extra-space}.")
747      (space-to-barline ,boolean? "If set, the distance between a note
748 and the following non-musical column will be measured to the bar line
749 instead of to the beginning of the non-musical column.  If there is a
750 clef change followed by a bar line, for example, this means that we
751 will try to space the non-musical column as though the clef is not
752 there.")
753      (spacing-increment ,number? "Add this much space for a doubled
754 duration.  Typically, the width of a note head.  See also
755 @rinternals{spacing-spanner-interface}.")
756      (springs-and-rods ,boolean? "Dummy variable for triggering
757 spacing routines.")
758      (stacking-dir ,ly:dir? "Stack objects in which direction?")
759      (staff-affinity ,ly:dir? "The direction of the staff to which this
760 line should stick.")
761      (staff-padding ,ly:dimension? "Maintain this much space between
762 reference points and the staff.  Its effect is to align objects of
763 differing sizes (like the dynamics @b{p} and @b{f}) on their
764 baselines.")
765      (staff-position ,number? "Vertical position, measured in half
766 staff spaces, counted from the middle line.")
767      (staff-space ,ly:dimension? "Amount of space between staff lines,
768 expressed in global @code{staff-space}.")
769      (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})}
770 pair where the stem attaches to the notehead.")
771      (stem-end-position ,number? "Where does the stem end (the end is
772 opposite to the support-head)?")
773      ;;[TODO: doco]
774      (stem-spacing-correction ,number? "Optical correction amount for
775 stems that are placed in tight configurations.  For opposite
776 directions, this amount is the correction for two normal sized stems
777 that overlap completely.")
778      (stemlet-length ,number? "How long should be a stem over a
779 rest?")
780      (stencil ,ly:stencil? "The symbol to print.")
781      (stencils ,list? "Multiple stencils, used as intermediate
782 value.")
783      (strict-grace-spacing ,boolean? "If set, main notes are spaced
784 normally, then grace notes are put left of the musical columns for the
785 main notes.")
786      (strict-note-spacing ,boolean? "If set, unbroken columns with
787 non-musical material (clefs, bar lines, etc.) are not spaced
788 separately, but put before musical columns.")
789      (stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
790 through flag on.")
791      (style ,symbol? "This setting determines in what style a grob is
792 typeset.  Valid choices depend on the @code{stencil} callback reading
793 this property.")
794
795
796 ;;
797 ;; t
798 ;;
799      (text ,markup? "Text markup.  See @ruser{Formatting text}.")
800 ;;FIXME -- Should both be the same?
801      (text-direction ,ly:dir? "This controls the ordering of the
802 words.  The default @code{RIGHT} is for roman text.  Arabic or Hebrew
803 should use @code{LEFT}.")
804      (thick-thickness ,number? "Bar line thickness, measured in
805 @code{line-thickness}.")
806      (thickness ,number? "Line thickness, generally measured in
807 @code{line-thickness}.")
808      (thin-kern ,number? "The space after a hair-line in a bar line.")
809      (tie-configuration ,list? "List of @code{(@var{position} .
810 @var{dir})} pairs, indicating the desired tie configuration, where
811 @var{position} is the offset from the center of the staff in staff
812 space and @var{dir} indicates the direction of the tie
813 (@code{1}=>up, @code{-1}=>down, @code{0}=>center).  A non-pair entry
814 in the list causes the corresponding tie to be formatted
815 automatically.")
816      (to-barline ,boolean? "If true, the spanner will stop at the bar
817 line just before it would otherwise stop.")
818      (toward-stem-shift ,number? "Amount by which scripts are shifted
819 toward the stem if their direction coincides with the stem direction.
820 @code{0.0} means keep the default position (centered on the note
821 head), @code{1.0} means centered on the stem.  Interpolated values are
822 possible.")
823      (transparent ,boolean? "This makes the grob invisible.")
824
825
826 ;;
827 ;; u
828 ;;
829      (uniform-stretching ,boolean? "If set, items stretch
830 proportionally to their durations.  This looks better in complex
831 polyphonic patterns.")
832      (used ,boolean? "If set, this spacing column is kept in the
833 spacing problem.")
834
835
836 ;;
837 ;; v
838 ;;
839      (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and
840 one below this grob.")
841
842
843 ;;
844 ;; w
845 ;;
846      (when ,ly:moment? "Global time step associated with this column
847 happen?")
848      (width ,ly:dimension? "The width of a grob measured in staff
849 space.")
850      (word-space ,ly:dimension? "Space to insert between words in
851 texts.")
852
853
854 ;;
855 ;; x
856 ;;
857      (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.")
858      (X-offset ,number? "The horizontal amount that this object is
859 moved relative to its X-parent.")
860
861
862 ;;
863 ;; y
864 ;;
865      (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.")
866      (Y-offset ,number? "The vertical amount that this object is moved
867 relative to its Y-parent.")
868
869 ;;
870 ;; z
871 ;;
872      (zigzag-length ,ly:dimension? "The length of the lines of a
873 zigzag, relative to @code{zigzag-width}.  A value of@tie{}@code{1}
874 gives 60-degree zigzags.")
875      (zigzag-width ,ly:dimension? "The width of one zigzag squiggle.
876 This number is adjusted slightly so that the glissando line can be
877 constructed from a whole number of squiggles.")
878      )))
879
880
881 ;;;;;;;;;;;;;;;;
882 ;;   INTERNAL
883
884
885 (define (define-internal-grob-property symbol type? description)
886   (define-grob-property symbol type? description)
887   (set-object-property! symbol 'backend-internal #t)
888   symbol
889   )
890
891
892 (define-public all-internal-grob-properties
893   (map
894    (lambda (x)
895      (apply define-internal-grob-property x))
896
897    `(
898      ;;;;;;;;;;;;;;;;
899      ;; grobs & grob arrays.  (alphabetical)
900      (accidental-grob ,ly:grob? "The accidental for this note.")
901      (accidental-grobs ,list? "An alist with @code{(@var{notename} .
902 @var{groblist})} entries.")
903      (adjacent-spanners ,ly:grob-array? "An array of directly neighboring
904 dynamic spanners.")
905      (all-elements ,ly:grob-array? "An array of all grobs in this line.  Its
906 function is to protect objects from being garbage collected.")
907      (arpeggio ,ly:grob? "A pointer to an @code{Arpeggio} object.")
908      (axis-group-parent-X ,ly:grob? "Containing X@tie{}axis group.")
909      (axis-group-parent-Y ,ly:grob? "Containing Y@tie{}axis group.")
910
911      (bars ,ly:grob-array? "An array of bar line pointers.")
912      (beam ,ly:grob? "A pointer to the beam, if applicable.")
913      (bounded-by-me ,ly:grob-array? "An array of spanners that have this
914 column as start/begin point.  Only columns that have grobs or act as
915 bounds are spaced.")
916      (bracket ,ly:grob? "The bracket for a number.")
917
918      (columns ,ly:grob-array? "An array of grobs, typically containing
919 @code{PaperColumn} or @code{NoteColumn} objects.")
920      (conditional-elements ,ly:grob-array? "Internal use only.")
921
922      (direction-source ,ly:grob? "In case @code{side-relative-direction} is
923 set, which grob to get the direction from.")
924      (dot ,ly:grob? "A reference to a @code{Dots} object.")
925      (dots ,ly:grob-array? "Multiple @code{Dots} objects.")
926
927      (elements ,ly:grob-array? "An array of grobs; the type is depending on
928 the grob where this is set in.")
929      (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
930 in addition to notes and stems.")
931
932      (figures ,ly:grob-array? "Figured bass objects for continuation line.")
933
934      (grace-spacing ,ly:grob? "A run of grace notes.")
935
936      (heads ,ly:grob-array? "An array of note heads.")
937
938      (items-worth-living ,ly:grob-array? "An array of interesting items.  If
939 empty in a particular staff, then that staff is erased.")
940
941      (left-items ,ly:grob-array? "DOCME")
942      (left-neighbor ,ly:grob? "The right-most column that has a spacing-wish
943 for this column.")
944
945      (normal-stems ,ly:grob-array? "An array of visible stems.")
946      (note-columns ,ly:grob-array? "An array of @code{NoteColumn} grobs.")
947      (note-head ,ly:grob? "A single note head.")
948      (note-heads ,ly:grob-array? "An array of note head grobs.")
949      (pedal-text ,ly:grob? "A pointer to the text of a mixed-style piano
950 pedal.")
951      (pure-relevant-items ,ly:grob-array? "A subset of elements that are
952 relevant for finding the @code{pure-Y-extent}.")
953      (pure-relevant-spanners ,ly:grob-array? "A subset of elements that are
954 relevant for finding the @code{pure-Y-extent}.")
955      (pure-Y-common ,ly:grob? "A cache of the
956 @code{common_refpoint_of_array} of the @code{elements} grob set.")
957
958      (rest ,ly:grob? "A pointer to a @code{Rest} object.")
959      (rest-collision ,ly:grob? "A rest collision that a rest is in.")
960      (rests ,ly:grob-array? "An array of rest objects.")
961      (right-items ,ly:grob-array? "DOCME")
962      (right-neighbor ,ly:grob? "See @code{left-neighbor}.")
963
964      (separation-item ,ly:grob? "A pointer to a @code{SeparationItem}
965 object.")
966      (side-support-elements ,ly:grob-array? "The side support, an array of
967 grobs.")
968      (slur ,ly:grob? "A pointer to a @code{Slur} object.")
969      (spaceable-staves ,ly:grob-array? "Objects to be spaced during page
970 layout.")
971      (spacing ,ly:grob? "The spacing spanner governing this section.")
972      (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing
973 objects.")
974      (staff-grouper ,ly:grob? "The staff grouper we belong to.")
975      (staff-symbol ,ly:grob? "The staff symbol grob that we are in.")
976      (stem ,ly:grob? "A pointer to a @code{Stem} object.")
977      (stems ,ly:grob-array? "An array of stem objects.")
978
979      (tie ,ly:grob? "A pointer to a @code{Tie} object.")
980      (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
981      (tuplet-number ,ly:grob? "The number for a bracket.")
982      (tuplets ,ly:grob-array? "An array of smaller tuplet brackets.")
983      (X-common ,ly:grob? "Common reference point for axis group.")
984      (Y-common ,ly:grob? "See @code{X-common}.")
985
986      ;;;;;;;;;;;;;;;;
987      ;; other
988      (adjacent-pure-heights ,pair? "A pair of vectors.  Used by a
989 @code{VerticalAxisGroup} to cache the @code{Y-extent}s of different column
990 ranges.")
991      
992      (bar-extent ,number-pair? "The Y-extent of the actual bar line.
993 This may differ from @code{Y-extent} because it does not include the dots in
994 a repeat bar line.")
995      (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or
996 @code{FretBoard} be visible only at beginning of line or at
997 chord changes.")
998
999      (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
1000 translator) that was the cause for this grob.")
1001      (cross-staff ,boolean? "For a beam or a stem, this is true if we
1002 depend on inter-staff spacing.")
1003
1004      (delta-position ,number? "The vertical position difference.")
1005
1006      (font ,ly:font-metric? "A cached font metric object.")
1007      (forced ,boolean? "Manually forced accidental.")
1008
1009      (head-width ,ly:dimension? "The width of this ligature head.")
1010
1011      (ideal-distances ,list? "@code{(@var{obj} . (@var{dist} .
1012 @var{strength}))} pairs.")
1013      (important-column-ranks ,vector? "A cache of columns that contain
1014 @code{items-worth-living} data.")
1015      (interfaces ,list? "A list of symbols indicating the interfaces
1016 supported by this object.  It is initialized from the @code{meta} field.")
1017
1018      (least-squares-dy ,number? "The ideal beam slope, without damping.")
1019
1020      (maybe-loose ,boolean? "Used to mark a breakable column that is
1021 loose if and only if it is in the middle of a line.")
1022      (meta ,list? "Provide meta information.  It is an alist with the
1023 entries @code{name} and @code{interfaces}.")
1024      (minimum-distances ,list? "A list of rods that have the format
1025 @code{(@var{obj} . @var{dist})}.")
1026
1027      (positioning-done ,boolean? "Used to signal that a positioning element
1028 did its job.  This ensures that a positioning is only done once.")
1029      (pure-Y-extent ,number-pair? "The estimated height of a system.")
1030      (pure-Y-offset-in-progress ,boolean? "A debugging aid for catching
1031 cyclic dependencies.")
1032
1033      (quant-score ,string? "The beam quanting score; stored for
1034 debugging.")
1035      (quantize-position ,boolean? "If set, a vertical alignment is aligned
1036 to be within staff spaces.")
1037      (quantized-positions ,number-pair? "The beam positions after
1038 quanting.")
1039
1040      (script-stencil ,pair? "A pair @code{(@var{type} . @var{arg})} which
1041 acts as an index for looking up a @code{Stencil} object.")
1042      (shorten ,ly:dimension? "The amount of space that a stem is shortened.
1043 Internally used to distribute beam shortening over stems.")
1044      (skyline-distance ,number? "The distance between this staff and the
1045 next one, as determined by a skyline algorithm.")
1046      (stem-info ,pair? "A cache of stem parameters.")
1047      (system-Y-offset ,number? "The Y-offset (relative to the bottom of the
1048 top-margin of the page) of the system to which this staff belongs.")
1049
1050      (use-breve-rest ,boolean? "Use breve rests for measures longer
1051 than a whole rest.")
1052
1053      ;;;;;;;;;;;;;;;;
1054      ;; ancient notation
1055
1056      ;;;;;;; TODO:
1057      ;; There are too many properties for ancient notation;
1058      ;; probably neume-types (a list of symbols) would also work.
1059
1060      ;; However, such a list would consist of a couple of dozens of
1061      ;; entries, since head prefixes may be combined in many ways.  If
1062      ;; the macros in `gregorian.ly' would directly set prefix-set,
1063      ;; all the head prefixes could be junked; however, such macros
1064      ;; would be quite numerous, I guess.  --jr
1065
1066      (add-cauda ,boolean? "Does this flexa require an additional cauda on
1067 the left side?")
1068      (add-join ,boolean? "Is this ligature head-joined with the next one
1069 by a vertical line?")
1070      (add-stem ,boolean? "Is this ligature head a virga and therefore needs
1071 an additional stem on the right side?")
1072      (ascendens ,boolean? "Is this neume of ascending type?")
1073      (auctum ,boolean? "Is this neume liquescentically augmented?")
1074
1075      (cavum ,boolean? "Is this neume outlined?")
1076      (context-info ,integer? "Within a ligature, the final glyph or shape of
1077 a head may be affected by the left and/or right neighbour head.
1078 @code{context-info} holds for each head such information about the left and
1079 right neighbour, encoded as a bit mask.")
1080
1081      (deminutum ,boolean? "Is this neume deminished?")
1082      (descendens ,boolean? "Is this neume of descendent type?")
1083
1084      (flexa-height ,ly:dimension? "The height of a flexa shape in a ligature
1085 grob (in @code{staff-space} units).")
1086      (flexa-width ,ly:dimension? "The width of a flexa shape in a
1087 ligature grob in (in @code{staff-space} units).")
1088
1089      (inclinatum ,boolean? "Is this neume an inclinatum?")
1090
1091      (join-right-amount ,number? "A length used for calculating the
1092 Y-extent of mensural ligatures.")
1093
1094      (linea ,boolean? "Attach vertical lines to this neume?")
1095
1096      (oriscus ,boolean? "Is this neume an oriscus?")
1097
1098      (pes-or-flexa ,boolean? "Shall this neume be joined with the previous
1099 head?")
1100      (prefix-set ,number? "A bit mask that holds all Gregorian head
1101 prefixes, such as @code{\\virga} or @code{\\quilisma}.")
1102      (primitive ,integer? "A pointer to a ligature primitive, i.e., an item
1103 similar to a note head that is part of a ligature.")
1104
1105      (quilisma ,boolean? "Is this neume a quilisma?")
1106
1107      (stropha ,boolean? "Is this neume a stropha?")
1108
1109      (virga ,boolean? "Is this neume a virga?")
1110
1111      (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
1112
1113      )))
1114
1115 (define-public all-backend-properties
1116   (append
1117    all-internal-grob-properties
1118    all-user-grob-properties))