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