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