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