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