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