]> git.donarmstrong.com Git - lilypond.git/blob - scm/define-grob-properties.scm
(print_trailer): only define glyph names when
[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--2005  Han-Wen Nienhuys <hanwen@cs.uu.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-callback ,procedure? "Procedure that calculates the
26 extent of this object. If this value is set to @code{#f}, the object
27 is empty in the X direction.  The procedure takes a grob and axis
28 argument, and returns a number-pair.
29 ")
30
31      (X-offset-callbacks ,list? "A list of functions determining this
32 objects' position relative to its parent. The last one in the list is
33 called first.  The functions take a grob and axis argument. ")
34
35      (Y-extent-callback ,procedure? "see @code{X-extent-callback}.")
36      (Y-offset-callbacks ,list? "see @code{X-offset-callbacks}.")
37
38      (accidentals ,list? "List of alteration numbers")
39      (alteration-alist ,list? "List of @code{(@var{pitch}
40 . @var{accidental})} pairs for key signature.")
41      (add-stem-support ,boolean? "If set, the Stem object is included in this script's support") 
42     
43      (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
44 @code{0}: around center of width, @code{1}: right side.")
45      (arpeggio-direction ,ly:dir? "If set, put an
46 arrow on the arpeggio squiggly line.")
47   
48      (auto-knee-gap ,ly:dimension? "If a gap is found between note heads
49 where a horizontal beam fits that is larger than this number, make a kneed beam.")
50      (axes ,list? "list of axis numbers.
51 In the case of alignment grobs, this should contain only one number.")
52
53      (balloon-text ,markup? "Text to add to help balloon")
54      (balloon-text-props ,list? "Font properties
55 for balloon text.")
56      (balloon-text-offset ,number-pair?
57                           "Where to put text relative to balloon.")
58      (balloon-padding ,ly:dimension? "Text to add to help balloon")
59      (balloon-original-callback ,procedure? "The
60 original stencil drawer to draw the balloon around.")
61
62
63      (bar-size ,ly:dimension? "size of a bar line.")
64      (bar-size-procedure ,procedure? "Procedure that computes the size of a bar line.")
65      (barre-type ,symbol? "Type of barre indication used in a fret diagram.
66 Choices include @code{curved} and @code{straight}.")
67      (base-shortest-duration ,ly:moment?
68                              "Spacing is based on the shortest notes in a piece. Normally, pieces are spaced as if notes 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? "thickness, measured in staffspace.")
72      (beam-width ,ly:dimension? "width of the tremolo sign.")
73      (beamed-lengths ,list? "list of stem lengths given beam multiplicity .")
74      (beamed-minimum-free-lengths ,list? "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.")
75      (beamed-extreme-minimum-free-lengths ,list? "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.")
76
77      (beamed-stem-shorten ,list? "How much to shorten beamed stems,
78 when their direction is forced. It is a list, since the value is different
79 depending on the number flags/beams.")
80      (beaming ,pair?
81               "Pair of number lists. Each number list specifies which
82 beams to make. 0 is the central beam, 1 is the next beam toward the
83 note etc. This information is used to determine how to connect the
84 beaming patterns from stem to stem inside a beam.")
85
86
87      (before-line-breaking-callback ,procedure? "This procedure is
88 called before line breaking, but after splitting breakable items at
89 potential line breaks.")
90      (between-cols ,pair? "Where to attach a loose column to")
91      (bound-padding ,number? "The amount of padding to insert around spanner bounds.")
92      (bracket-flare ,number-pair? "A pair of numbers specifying how
93 much edges of brackets should slant outward.  Value 0.0 means straight
94 edges")
95      (break-align-symbol ,symbol? "This key is used for aligning and
96 spacing breakable items.")
97      (break-align-orders ,vector? " Defines the order in which
98 prefatory matter (clefs, key signatures) appears. The format is a
99 vector of length 3, where each element is one order for end-of-line,
100 middle of line, and start-of-line respectively. An order is a list of
101 symbols.
102
103 For example, clefs are put after key signatures by setting
104
105 @example
106         \\override Score.BreakAlignment #'break-align-orders = #(make-vector  3
107           '(span-bar
108           breathing-sign
109           staff-bar
110           key
111           clef
112           time-signature))
113 @end example")
114      (break-glyph-function ,procedure? "This function determines the
115 appearance of a bar line at the line break.  It takes a glyph and
116 break-direction and returns the glyph at a line break.")
117      (break-overshoot ,number-pair? "How much does a broken spanner
118 stick out of its bounds?")
119      (bracket-visibility ,boolean-or-symbol? "This controls the
120 visibility of the tuplet bracket.  Setting it to false will prevent
121 printing of the bracket. Setting the property to @code{'if-no-beam}
122 will make it print only if there is no beam associated with this
123 tuplet bracket.")
124      (break-visibility ,vector? "A vector of 3 booleans, #(end-of-line unbroken begin-of-line).
125 #t means visible, #f means killed.")
126
127      (breakable ,boolean? "Can this object appear at a line break,
128 like clefs and bar lines?")
129      (c0-position ,integer? "An integer indicating the position of
130 middle C.")
131      (cautionary-style ,symbol? "How to print cautionary
132 accidentals. Choices are @code{smaller} or
133 @code{parentheses}.")
134      (cautionary ,boolean? "Is this a cautionary accidental?")
135      (concaveness ,number? "A beam is concave when its inner stems are
136 closer to the beam than the two outside stems. This number is a
137 measure of the closeness of the inner stems. It is used for damping
138 the slope of the beam.")
139      (collapse-height ,ly:dimension? "Minimum height of system start delimiter.  If equal or smaller, the bracket is removed.")
140
141      (color ,color? "The color of this grob.")
142
143      (context ,ly:context? "Originating context of the grob")
144      
145      ;;DOCME
146      (control-points ,list? "List of 4 offsets (number-pairs) that form control points for the  tie/slur shape.")
147
148      (damping ,number? "Amount of beam slope damping. 0: no, 1: yes,
149 100000: horizontal beams.")
150      (dash-period ,number? "the length of one dash + white space. If
151 negative, no line is drawn at all.")
152      
153      (dash-fraction ,number? "Size of the dashes, relative to
154 dash-period. Should be between 0.0 (no line) and 1.0 (continuous
155 line).")
156
157      (arrow ,boolean? "Add an arrow to the line.")
158      (arrow-length ,number? "Arrow length.")
159      (arrow-width ,number? "Arrow width.")
160
161      ;; todo: why is this tunable?
162      (dir-function ,procedure? "The function to determine the
163 direction of a beam. Choices include: 
164
165 @table @code
166 @item beam-dir-majority
167 number count of up or down notes
168 @item beam-dir-mean
169 mean center distance of all notes
170 @item beam-dir-median.
171 mean center distance weighted per note
172 @end table
173
174 ")
175      
176      (direction ,ly:dir? "Up or down, left or right?")
177      (dot-color ,symbol? "Color of dots.  Options include 
178 @code{black} and @code{white}.")
179      (dot-radius ,number? "Radius of dots.")
180      (dot-count ,integer? "The number of dots.")
181      (duration-log ,integer? "The 2-log of the note head duration, i.e. 0=whole note, 1 = half note, etc.")
182      (edge-height ,pair? "A pair of number specifying the heights of
183 the vertical edges '(@var{left-height} . @var{right-height}).")
184      (edge-text ,pair? "A pair specifying the texts to be set at the
185 edges '(@var{left-text} . @var{right-text}).")
186      (eccentricity ,number? "How asymmetrical to make a slur. Positive means move the center to the right.")
187      
188      (enclose-bounds ,number?
189                      "How much of the bound a spanner should enclose:
190 +1 = completely, 0 = center, -1 not at all.")
191
192      (expand-limit ,integer? "maximum number of measures expanded in church rests.")
193
194      ;; remove me? 
195      (extra-X-extent ,number-pair? "A grob is enlarged in X dimension
196 by this much.")
197      (extra-Y-extent ,number-pair? "See @code{extra-Y-extent}.")
198      
199      (X-extent ,number-pair? "Hard coded extent in X direction. ")
200      (Y-extent ,number-pair? "See @code{X-extent}.")
201
202      (extra-offset ,number-pair? "A pair representing an offset. This
203 offset is added just before outputting the symbol, so the typesetting
204 engine is completely oblivious to it.")
205
206      (finger-code ,symbol? "Code for the type of fingering indication in a
207 fret diagram.  Options include @code{none}, @code{in-dot}, and @code{below-string}.")
208      (flag-count ,number? "The number of tremolo beams.")
209      (flag-style ,symbol?
210                  "a string determining what style of flag-glyph is
211 typeset on a Stem. Valid options include @code{()} and
212 @code{mensural}.  Additionally, @code{\"no-flag\"} switches off the
213 flag.")
214      
215      (flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
216      (strict-note-spacing ,boolean? "If set, unbroken columns
217 with non-musical material (clefs, barlines, etc.) are not spaced
218 separately, but put before musical columns.")
219      (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
220      (font-encoding ,symbol? "The font encoding is the broadest
221 category for selecting a font. Options include: @code{fetaMusic},
222 @code{fetaNumber}, @code{TeX-text}, @code{TeX-math}, @code{fetaBraces},
223 @code{fetaDynamic}")
224      (font-name ,string? "Specifies a file name (without extension) of
225 the font to load.  This setting override selection using
226 @code{font-family}, @code{font-series} and @code{font-shape}.")
227      (font-magnification ,number? "Magnification of the font, when it
228 is selected with @code{font-name}.")
229
230      (font-size ,number? "The font size, compared the `normal'
231 size.  0 is style-sheet's normal size, -1 is smaller, +1 is bigger.
232 Each step of 1 is approximately 12% larger, 6 steps are exactly a
233 factor 2 larger. Fractional values are allowed.")
234
235      (font-series ,symbol? "Select the series of a font. Choices
236 include @code{medium}, @code{bold}, @code{bold-narrow}, etc.")
237      (font-shape ,symbol? "Select the shape of a font. Choices include @code{upright},
238 @code{italic}, @code{caps}.")
239
240      (forced-distance ,ly:dimension? "A fixed distance between object
241 reference points in an alignment.")
242
243      (force-hshift ,number? "This specifies a manual shift for notes
244 in collisions. The unit is the note head width of the first voice
245 note.  This is used by @internalsref{note-collision-interface}.")
246
247      (fraction ,number-pair? "Numerator and denominator of a time
248 signature object.")
249      (french-beaming ,boolean? "Use French beaming style for this
250 stem. The stem will stop at the innermost beams.")
251      (fret-count ,integer? "The number of frets in a fret diagram.")
252
253      ;; ugh: double, change.
254      (full-size-change ,boolean? "Don't make a change clef smaller.")
255      (non-default ,boolean? "Set for manually specified clefs.")
256
257
258      (glyph ,string? "a string determining what (style) of glyph is
259 typeset. Valid choices depend on the function that is reading this
260 property.")
261      (glyph-name ,string? "a name of character within font.")
262      (glyph-name-procedure ,procedure? "Return the name of a character
263 within font, to use for printing a symbol.")
264
265      (gap ,ly:dimension? "Size of a gap in a variable symbol.")
266      (gap-count ,integer? "Number of gapped beams for tremolo.")
267      (grace-space-factor ,number? "Space grace notes at this fraction
268 of the @code{spacing-increment}.")
269
270      (grow-direction ,ly:dir? "Crescendo or decrescendo?")
271      (hair-thickness ,number? "Thickness of the thin line in a bar line.")
272      (height ,ly:dimension? "Height of an object in staffspace.")
273      (height-limit ,ly:dimension? "Maximum slur height: the longer the
274 slur, the closer it is to this height.")
275
276      (horizontal-shift ,integer? "An integer that identifies ranking
277 of note-column for horizontal shifting. This is used by
278 @internalsref{note-collision-interface}.")
279      (avoid-slur ,symbol? "Method of handling slur collisions.
280 Choices are @code{around}, @code{inside}, @code{outside}.  If unset, script
281 and slur ignore eachother.")
282      (inspect-quants ,number-pair? "If debugging is set,
283 set beam quant to this position, and print the respective scores.")
284
285      (keep-inside-line ,boolean? "If set, this column cannot have
286 things sticking into the margin.")
287      (kern ,ly:dimension? "Amount of extra white space to add. For
288 bar line, this is the amount of space after a thick line.")
289      (knee ,boolean? "Is this beam kneed?")
290      (knee-spacing-correction ,number? "Factor for the optical
291 correction amount for kneed beams. Set between 0 for no correction and
292 1 for full correction.")
293      (label-dir ,ly:dir? "Side to which label is attached. @code{-1} for left, @code{1} for right.")
294      (layer ,number? "The output layer [0..2]: layers define the order
295 of printing objects. Objects in lower layers are overprinted by
296 objects in higher layers.")
297      (ledger-line-thickness ,number-pair?
298                             "The thickness of ledger lines: it is the
299 sum of 2 numbers.  The first is the factor for line thickness, and the
300 second for staff space. Both contributions are added.")
301      (left-position ,number? "Vertical position of left part of spanner.")
302      (left-padding ,ly:dimension? "The amount of space that is put
303 left to a group of accidentals.")
304      (length ,ly:dimension? "User override for the stem length of
305 unbeamed stems.")
306      (length-fraction ,number? "Length of ledger line as fraction of note head size.")
307      (lengths ,list? "Default stem lengths. The list gives a length
308 for each flag-count.")
309      (line-break-system-details ,list?
310                                 "Alist of properties to use when this
311 column is the start of a system.")
312      
313      (line-count ,integer? "The number of staff lines.")
314      (measure-length ,ly:moment? "Length of a
315 measure. Used in some spacing situations.")
316
317      (measure-count ,integer? "The number of measures for a
318 multimeasure rest.")
319      (merge-differently-headed ,boolean? "Merge
320 note heads in collisions, even if they have different note heads. The
321 smaller of the two heads will be rendered invisible. This used
322 polyphonic guitar notation. The value of this setting is used by
323 @internalsref{note-collision-interface} .")
324
325      (merge-differently-dotted ,boolean? "Merge note heads in
326 collisions, even if they have a different number of dots. This normal
327 notation for some types of polyphonic music. ")
328
329      (minimum-length-fraction ,number? "Minimum length of ledger line as fraction of note head size.")
330      (minimum-distance ,ly:dimension? "Minimum distance between rest
331 and notes or beam.")
332      (minimum-X-extent ,number-pair? "Minimum size of an object in X
333 dimension, measured in staff space.")
334      (minimum-Y-extent ,number-pair? "See @code{minimum-Y-extent}.")
335      (minimum-length ,ly:dimension? "Try to make a spanner at least
336 this long. This requires an appropriate routine for the
337 @code{spacing-procedure} property.")
338      (minimum-space ,ly:dimension? "Minimum distance that the victim
339 should move (after padding).")
340      (neutral-direction ,ly:dir? "Which direction to take in the
341 center of the staff.")
342      (neutral-position ,number? "Position (in half staff spaces) where
343 to flip the direction of custos stem.")
344
345      (next ,ly:grob? "Object that is next relation (eg. the lyric syllable following an extender.")
346      (note-names ,vector? "Vector of strings containing names for
347 easy-notation note heads.")
348      (no-ledgers ,boolean? "If set, don't draw ledger lines on this object.")
349      (no-spacing-rods ,boolean? "Items with this property do not cause
350 spacing constraints.")
351      (no-stem-extend ,boolean? "If set, notes with ledger lines do not
352 get stems extending to the middle staff line.")
353      (number-type ,symbol? "Type of numbers to use in label.  Choices
354 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")
355      (number-visibility ,boolean-or-symbol? "Like
356 @code{bracket-visibility}, but for the number.")
357
358
359
360      (packed-spacing ,boolean? "If set, the notes are spaced as
361 tightly as possible.")
362      (padding ,ly:dimension? "Add this much extra space between
363 objects that are next to each other.")
364      (page-penalty ,number? "Penalty for page break at
365 this column.  10000 or more means forbid linebreak, -10000 or less
366 means force page break.  Other values influence page breaking decisions
367 as a real penalty.")
368      (penalty ,number? "Penalty for line break at
369 this column.  10000 or more means forbid line break, -10000 or less
370 means force line break.  Other values influence line breaking decisions
371 as a real penalty.")
372
373      (positions ,pair?
374                 "Pair of staff coordinates @code{(@var{left}
375 . @var{right})}, where both @var{left} and @var{right} are in the
376 staff-space unit of the current staff.")
377      (print-function ,procedure? "Function taking grob as argument,
378 returning a @code{Stencil} object.")
379      
380      (ratio ,number? "Parameter for slur shape. The higher this number, the
381 quicker the slur attains it @code{height-limit}.")
382      (remove-first ,boolean? "Remove the first staff of a orchestral score?")
383      (right-padding ,ly:dimension? "Space to insert between note and
384 accidentals.")
385      (right-position ,number? "Vertical position of right part of spanner.")
386      (script-priority ,number? "A sorting key that determines in what
387 order a script is within a stack of scripts.")
388
389      (self-alignment-X ,number? "Specify alignment of an object.  The
390 value -1 means left aligned, 0 centered, and 1 right-aligned in X
391 direction. Values in between may also be specified.")
392      (self-alignment-Y ,number? "like @code{self-alignment-X} but for
393 Y axis.")
394
395      (shorten-pair ,number-pair? "The lengths to shorten a
396 text-spanner on both sides, for example a pedal bracket")
397      (common-shortest-duration ,ly:moment?
398                                "The most common shortest note length.
399 This is used in spacing. Enlarging this will set the score tighter.")
400      (shortest-duration-space ,ly:dimension? "Start with this much
401 space for the shortest duration. This is expressed in
402 @code{spacing-increment} as unit. See also
403 @internalsref{spacing-spanner-interface}.")
404      (shortest-playing-duration ,ly:moment? "The duration of the shortest playing here.")
405      (shortest-starter-duration ,ly:moment? "The duration of the shortest
406 note that starts here.")
407      (side-relative-direction ,ly:dir?
408                               "Multiply direction of
409 @code{direction-source} with this to get the direction of this
410 object.")
411      (size ,number? "Size of object, relative to standard size.")
412      (slope ,number? "The slope of this object.")
413      (slur-padding ,number? "Extra distance between slur and script.")
414      (slur-details ,list?
415                    "An alist of scoring parameters for slur formatting")
416      (space-alist ,list? "A table that specifies distances between
417 prefatory items, like clef and time-signature. The format is an alist
418 of spacing tuples: @code{(@var{break-align-symbol} @var{type}
419 . @var{distance})}, where @var{type} can be the symbols
420 @code{minimum-space} or @code{extra-space}.")
421      (space-function ,procedure? "Calculate the vertical space between
422 two beams. This function takes a beam grob and the maximum number of
423 beams.")
424
425      (spacing-increment ,number? "Add this much space for a doubled
426 duration. Typically, the width of a note head. See also
427 @internalsref{spacing-spanner-interface}.")
428
429      (spacing-procedure ,procedure? "Procedure for calculating spacing
430 parameters.  The routine is called after
431 @code{before-line-breaking-callback}.")
432      (stacking-dir ,ly:dir? "Stack objects in which direction?")
433      (staff-space ,ly:dimension? "Amount of space between staff lines,
434 expressed in global staffspace.")
435      (staff-position ,number? "Vertical position, measured in half
436 staff spaces, counted from the middle line.")
437      
438      (stemlet-length ,number? "How long should a stem over a rest be?")
439      (stem-attachment-function ,procedure? "A function that calculates
440 where a stem attaches to the note head? This is a fallback when this
441 information is not specified in the font.  The function takes a grob
442 and axis argument, and returns a (@var{x} . @var{y}) pair, specifying
443 location in terms of note head bounding box.")
444
445      (stem-end-position ,number? "Where does the stem end (the end is opposite to the support-head.")
446
447      (stem-shorten ,list? "How much a stem in a forced direction
448 should be shortened. The list gives an amount depending on the number
449 of flags/beams.")
450
451      ;;[TODO: doco]
452      (stem-spacing-correction ,number? "Optical correction amount for
453 stems that are placed in tight configurations. For opposite
454 directions, this amount is the correction for two normal sized stems
455 that overlap completely.")
456
457      (same-direction-correction ,number? "Optical correction amount
458 for stems that are placed in tight configurations. This amount is used
459 for stems with the same direction to compensate for note-head to stem distance.")
460      (string-count ,integer? "The number of strings in a fret diagram.")
461      (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
462      
463      (style ,symbol? "This setting determines in what style a grob is
464 typeset. Valid choices depend on the @code{print-function} that is
465 reading this property.")
466      (text ,markup? "Text markup.  See @usermanref{Text markup}.")
467 ;;FIXME -- Should both be the same?
468      (text-direction ,ly:dir? "This controls the ordering of the
469 words. The default RIGHT is for roman text. Arabic or hebrew should
470 use LEFT.")
471      (thick-thickness ,number? "Bar line thickness, measured in
472 @code{linethickness}.")
473      (thickness ,number? "Bar line thickness, measured in
474 @code{linethickness}.")
475      (thin-kern ,number? "The space after a hair-line in a bar line.")
476
477      (threshold ,number-pair? "(@var{min} . @var{max}), where
478 @var{min} and @var{max} are dimensions in staff space.")
479      (tie-configuration ,list? "List of (@var{position} . @var{dir})
480 pairs, indicating the desired tie configuration.")
481      (transparent ,boolean? "This is almost the same as setting
482 @code{print-function} to @code{#f}, but this retains the dimensions of
483 this grob, which means that grobs can be erased individually.")
484      (uniform-stretching ,boolean? "If set, items stretch proportional
485 to their durations. This looks better in complex polyphonic patterns")
486      (used ,boolean? "If set, this spacing column is kept in the spacing problem")
487      (when ,ly:moment? "Global time step associated with this column
488 happen?")
489      (word-space ,ly:dimension? "space to insert between words in texts.")
490      (width ,ly:dimension? "The width of a grob measured in staff space.")
491      (x-gap ,ly:dimension? "The horizontal gap between note head and tie.")
492      (zigzag-length ,ly:dimension? "The length of the lines of a
493 zigzag, relative to @code{zigzag-width}. A value of 1 gives 60-degree
494 zigzags.")
495      (zigzag-width ,ly:dimension? "The width of one
496 zigzag-squiggle. This number will be adjusted slightly so that the
497 glissando line can be constructed from a whole number of squiggles.")
498
499      (avoid-note-head ,boolean? "If set, the stem of a chord does not
500 pass through all note heads, but starts at the last note head. ")
501      (staff-padding ,ly:dimension?
502                     "Maintain this much space between reference points
503 and the staff.  Its effect is to align objects of differing
504 sizes (like the dynamic @b{p} and @b{f}) on their baselines.")
505
506      )))
507
508
509 ;;;;;;;;;;;;;;;;
510 ;;   INTERNAL
511
512
513 (define (define-internal-grob-property symbol type? description)
514   (define-grob-property symbol type? description)
515   (set-object-property! symbol 'backend-internal #t)
516   symbol
517   )
518
519
520 (define-public all-internal-grob-properties
521   (map
522    (lambda (x)
523      (apply define-internal-grob-property x))
524    
525    `(
526      (axis-group-parent-X ,ly:grob? "Containing X axis group")
527      (axis-group-parent-Y ,ly:grob? "Containing Y axis group")
528      (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
529      (adjacent-hairpins ,ly:grob-array? "List of directly neighboring hairpins")
530      (after-line-breaking-callback ,procedure? "This procedure is called after line breaking. Its return value is ignored.")     
531      (all-elements ,ly:grob-array? "list of all grobs in this line. Its
532 function is to protect objects from being garbage collected.")
533      (arpeggio ,ly:grob? "pointer to arpeggio object.")
534      (beam ,ly:grob? "pointer to the beam, if applicable.")
535      (direction-source ,ly:grob? "in case side-relative-direction is
536 set, which grob to get the direction from .")
537      (dot ,ly:grob? "reference to Dots object.")
538      (figures ,ly:grob-array? "Figured bass objects for continuation line.")
539      (pedal-text ,ly:grob? "Pointer to the text of a mixed-style piano pedal.")
540      (stem ,ly:grob? "pointer to Stem object.")
541      (tremolo-flag ,ly:grob? "The tremolo object on a stem.")
542      (tie ,ly:grob? "")
543      (staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
544      (rest ,ly:grob? "the staff symbol grob that we're in.")
545      (rests ,ly:grob-array? "A list of rest objects.")
546      (rest-collision ,ly:grob? "rest collision that a rest is in.")
547      (accidental-grob ,ly:grob? "Accidental for this note.")
548      (bars ,ly:grob-array? "list of bar line pointers.")
549      (bounded-by-me ,ly:grob-array? "list of spanners that have this
550 column as start/begin point. Only columns that have grobs or act as
551 bounds are spaced.")
552      (columns ,ly:grob-array? "list of grobs, typically containing
553 paper-columns or note-column objects.")
554      (conditional-elements ,ly:grob-array? "Internal use only")
555      (dependencies ,ly:grob-array? "list of score-grob pointers that indicate
556 who to compute first for certain global passes.")
557      (encompass-objects ,ly:grob-array? "Objects that a slur should avoid
558 in addition to notes and stems.")
559      (elements ,ly:grob-array? "list of grobs, type depending on the Grob
560 where this is set in.")
561      (heads ,ly:grob-array? "List of note heads.")
562      (items-worth-living ,ly:grob-array? "A list of interesting items. If
563 empty in a particular staff, then that staff is erased.")
564      (details ,list? "alist of parameters for detailed grob behavior.")
565      (note-heads ,ly:grob-array? "List of note head grobs")
566      (note-head ,ly:grob? "A single note head")
567      (side-support-elements ,ly:grob-array? "the support, a list of grobs.")
568      (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing objects.")
569      (stems ,ly:grob-array? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
570      (tuplets ,ly:grob-array? "list of smaller tuplet brackets")
571
572      (left-neighbors ,ly:grob-array? " List of
573 spacing-wish grobs that are close to the current column.
574
575 The closest spacing-wishes determine the actual distances between the
576 columns.
577 ")
578      (right-neighbors ,ly:grob-array? "see left-neighbors")
579      (left-items ,ly:grob-array? "")
580      (right-items ,ly:grob-array? "")
581      (cause ,scheme? "Any kind of causation objects (i.e. music, or perhaps translator) that was the cause for this grob.  ")
582      (font ,ly:font-metric? "Cached font metric object")
583
584      (positioning-done ,boolean?
585                        "Used to signal that a positioning element
586 did its job. This ensures that a positioning is only done once.")
587
588
589      (script-stencil ,pair? "Pair (@code{type} . @code{arg}), which
590 acts as an index for looking up a Stencil object.")
591
592      (meta ,list? "Contains meta information. It is an alist with the
593 entries @code{name} and @code{interfaces}.")
594
595
596      ;; TODO: use interface for this!
597      (chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
598      (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")
599
600      (quant-score ,string? "Beam quanting score -- can be stored for
601 debugging")
602      
603      (least-squares-dy ,number? 
604                        "ideal beam slope, without damping.")
605      (ligature-primitive-callback ,procedure? "callback that brews ligature head.")
606      (stem-info ,pair? "caching of stem parameters")
607      (note-columns ,pair? "list of NoteColumn grobs.")
608
609      (position-callbacks ,list? "list of
610 functions set spanner positions.")
611
612 ;;; add-join would be enough if in Mensural_ligature::brew_ligature_primitive
613 ;;; the next note could be seen
614      (join-right-amount ,number? "")
615
616      (delta-pitch ,number? "the interval between this and the next note, or, more precisely, their vertical distance; this is used in ligatures for calculation of the height of vertical joins flexa shapes")
617      (head-width ,ly:dimension? "width of this ligature head")
618
619      ;; [TODO: change this]
620      (primitive ,integer? "Pointer to a ligature primitive, i.e. an item similar to a note head that is part of a ligature. ")
621      (stencil ,ly:stencil? "Cached output of the print-function.")
622      (ideal-distances ,list? "(@var{obj} . (@var{dist} . @var{strength})) pairs.")
623      (minimum-distances ,list? "list of rods, that have the format (@var{obj} . @var{dist}).")
624
625      (interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
626      (shorten ,ly:dimension? "The amount of space that a
627 stem. Internally used to distribute beam shortening over stems. ")
628      (slur ,ly:grob? "A pointer to a slur object")
629      (use-breve-rest ,boolean? "Use breve rests for measures longer
630 than a whole rest.")
631      
632
633      (spaceable-staves ,ly:grob-array? "Objects to be spaced during page layout.")
634
635      ;; ancient notation
636
637      ;;;;;;; TODO:
638      ;; there are too many properties for ancient notation
639      ;; probably neume-types (a list of symbols) would also work.
640      
641      (auctum ,boolean? "is this neume augmented?")
642      (ascendens ,boolean? "is this neume of an ascending?")
643      (add-cauda ,boolean? "does this flexa require an additional cauda on the left side?")
644      (add-join ,boolean? "is this ligature head joined with the next one by a vertical line?")
645      (cavum ,boolean? "is this neume outlined?")
646      (descendens ,boolean? "is this neume of a descendent type?")
647      (deminutum ,boolean? "is this neume deminished?")
648      (flexa-height ,ly:dimension? "height of a flexa shape in a ligature grob in staff_space.")
649      (flexa-width ,ly:dimension? "width of a flexa shape in a ligature grob in staff_space.")
650      (join-heads ,boolean? "Whether to join the note heads of an ambitus grob with a vertical line.")
651      (linea ,boolean? "attach vertical lines to this neume?")
652   
653  
654      (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
655      (context-info ,integer? "DOCME")
656      (inclinatum ,boolean? "is this neume an inclinatum?")
657      (oriscus ,boolean? "is this neume an oriscus?")
658      (quilisma ,boolean? "is this neume a quilisma?")
659      (pes-or-flexa ,boolean? "shall this neume be joined with the previous head?")
660      ;; DOCME
661      (prefix-set ,number? "")
662      (stropha ,boolean? "Is this neume a stropha?")
663      (virga ,boolean? "Is this neume a virga?")
664      (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
665      
666      ;; end ancient notation
667
668      )))
669
670 (define-public all-backend-properties
671   (append
672    all-internal-grob-properties
673    all-user-grob-properties))