1 ;;;; grob-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
8 ; distances are given in stafflinethickness (thicknesses) and
9 ; staffspace (distances)
11 (define all-grob-descriptions
13 (X-extent-callback . ,Arpeggio::width_callback)
14 (Y-extent-callback . #f)
15 (molecule-callback . ,Arpeggio::brew_molecule)
16 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
17 (X-offset-callbacks . (,Side_position::aligned_side))
19 (staff-position . 0.0)
20 (meta . ,(grob-description "Arpeggio" arpeggio-interface side-position-interface font-interface))
23 (autoBeamSettings . ,auto-beam-settings)
26 (break-align-symbol . Staff_bar)
28 (break-glyph-function . ,default-break-barline)
29 (barsize-procedure . ,Bar::get_staff_bar_size)
30 (molecule-callback . ,Bar::brew_molecule)
31 (visibility-lambda . ,all-visible)
33 (before-line-breaking-callback . ,Bar::before_line_breaking)
35 ;; Ross. page 151 lists other values, we opt for a leaner look
39 (hair-thickness . 1.6)
40 (thick-thickness . 6.0)
41 (meta . ,(grob-description "BarLine" bar-line-interface font-interface))
45 (molecule-callback . ,Text_item::brew_molecule)
47 (visibility-lambda . ,begin-of-line-visible)
51 (font-relative-size . -1)
52 (Y-offset-callbacks . (,Side_position::aligned_side))
53 (meta . ,(grob-description "BarNumber"
54 side-position-interface
55 text-interface font-interface break-aligned-interface))
59 ;; todo: clean this up a bit: the list is getting
61 (molecule-callback . ,Beam::brew_molecule)
62 (y-dy-callbacks . (,Beam::least_squares
63 ,Beam::cancel_suspect_slope
67 ,Beam::do_quantise_y))
69 (thickness . 0.48) ; in staff-space
70 (before-line-breaking-callback . ,Beam::before_line_breaking)
71 (after-line-breaking-callback . ,Beam::after_line_breaking)
72 (default-neutral-direction . 1)
73 (dir-function . ,beam-dir-majority)
74 (height-quants . ,default-beam-dy-quants)
75 (vertical-position-quant-function . ,default-beam-y-quants)
76 (beamed-stem-shorten . (0.5))
77 (outer-stem-length-limit . 0.2)
79 (flag-width-function . ,default-beam-flag-width-function)
80 (space-function . ,default-beam-space-function)
83 (meta . ,(grob-description "Beam" beam-interface))
90 (X-offset-callbacks . (,Break_align_interface::self_align_callback))
91 (space-alist . ,default-break-align-space-alist)
92 (meta . ,(grob-description "BreakAlignment"
93 axis-group-interface align-interface
100 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
102 (meta . ,(grob-description "BreakAlignGroup" axis-group-interface))
106 (break-align-symbol . Breathing_sign)
108 (molecule-callback . ,Breathing_sign::brew_molecule)
109 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
110 (visibility-lambda . ,begin-of-line-invisible)
111 (meta . ,(grob-description "BreathingSign" break-aligned-interface))
115 (molecule-callback . ,Clef::brew_molecule)
116 (before-line-breaking-callback . ,Clef::before_line_breaking)
118 (font-family . music)
119 (break-align-symbol . Clef_item)
120 (visibility-lambda . ,begin-of-line-visible)
121 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
122 (meta . ,(grob-description "Clef" clef-interface font-interface break-aligned-interface ))
126 (molecule-callback . ,Chord_name::brew_molecule)
127 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
128 (chord-name-function . ,default-chord-name-function)
129 (font-family . roman)
130 (meta . ,(grob-description "ChordName" font-interface text-interface chord-name-interface))
134 (break-align-symbol . Custos)
136 (molecule-callback . ,Custos::brew_molecule)
137 (visibility-lambda . ,end-of-line-visible)
139 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
140 (meta . ,(grob-description "Custos" custos-interface staff-symbol-interface break-aligned-interface) )
144 (molecule-callback . ,Hairpin::brew_molecule)
148 (if-text-padding . 1.0)
149 (width-correct . -1.0)
151 (dash-thickness . 1.2)
153 (self-alignment-Y . 0)
154 (Y-offset-callbacks . (,Side_position::aligned_on_self))
155 (meta . ,(grob-description "Hairpin" hairpin-interface))
160 (meta . ,(grob-description "DotColumn" dot-column-interface axis-group-interface))
164 (molecule-callback . ,Dots::brew_molecule)
166 (staff-position . 0.0)
167 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
168 (meta . ,(grob-description "Dots" font-interface dot-interface ))
172 (Y-offset-callbacks . (,Side_position::aligned_on_self))
173 (molecule-callback . ,Text_item::brew_molecule)
174 (script-priority . 100)
176 (font-family . dynamic)
177 (font-shape . italic)
178 (self-alignment-Y . 0)
179 (meta . ,(grob-description "DynamicText" font-interface text-interface ))
182 (DynamicLineSpanner . (
185 (minimum-space . 1.2)
186 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
190 (break-align-symbol . Left_edge_item)
191 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
193 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
197 (molecule-callback . ,Text_item::brew_molecule)
198 (X-offset-callbacks . (,Side_position::centered_on_parent ,Side_position::aligned_on_self))
200 (self-alignment-X . 0)
201 (font-family . number)
202 (font-relative-size . -3)
203 (font-shape . upright)
204 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
209 (horizontal-space . 1.2)
211 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
212 (meta . ,(grob-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
215 (HaraKiriVerticalGroup . (
216 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
217 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
219 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
225 (minimum-length . 0.5)
226 (molecule-callback . ,Hyphen_spanner::brew_molecule)
227 (Y-extent-callback . ,Grob::point_dimension_callback)
228 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
233 (Y-offset-callbacks . (,Side_position::centered_on_parent
234 ,Side_position::aligned_on_self))
235 (self-alignment-Y . 0)
236 (molecule-callback . ,Text_item::brew_molecule)
237 (break-align-symbol . Instrument_name)
238 (visibility-lambda . ,begin-of-line-visible)
240 (font-family . roman)
241 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
245 (molecule-callback . ,Key_item::brew_molecule)
246 (break-align-symbol . Key_item)
247 (visibility-lambda . ,begin-of-line-visible)
249 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
253 (molecule-callback . ,Local_key_item::brew_molecule)
254 (X-offset-callbacks . (,Side_position::aligned_side))
257 (right-padding . 0.4)
258 (meta . ,(grob-description "Accidentals" accidentals-interface font-interface side-position-interface))
263 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
267 (molecule-callback . ,Lyric_extender::brew_molecule)
268 (height . 0.8) ; stafflinethickness;
269 (right-trim-amount . 0.5)
270 (Y-extent-callback . ,Grob::point_dimension_callback)
271 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
275 (molecule-callback . ,Text_item::brew_molecule)
276 (X-offset-callbacks . (,Side_position::aligned_on_self))
277 (self-alignment-X . 0)
280 (font-family . roman)
281 (font-shape . upright)
282 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
286 (molecule-callback . ,Text_item::brew_molecule)
287 (X-offset-callbacks . (,Side_position::aligned_on_self))
288 (self-alignment-X . 0)
292 (font-family . number)
293 (font-shape . upright)
294 (font-relative-size . 1)
295 (visibility-lambda . ,end-of-line-invisible)
297 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
300 (MultiMeasureRest . (
301 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
302 (molecule-callback . ,Multi_measure_rest::brew_molecule)
305 (padding . 2.0) ; staffspace
306 (minimum-width . 12.5) ; staffspace
307 (font-family . number)
308 (font-relative-size . 1)
309 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface font-interface ))
314 (meta . ,(grob-description "NoteCollision"
315 note-collision-interface axis-group-interface
321 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
326 (molecule-callback . ,Note_head::brew_molecule)
327 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
328 (meta . ,(grob-description "NoteHead"
329 rhythmic-head-interface font-interface
330 note-head-interface ))
336 (X-extent-callback . #f)
337 (Y-extent-callback . #f)
338 (molecule-callback . ,Line_spanner::brew_molecule)
339 (meta . ,(grob-description "Glissando"
340 line-spanner-interface))
346 (X-extent-callback . #f)
347 (Y-extent-callback . #f)
348 (molecule-callback . ,Line_spanner::brew_molecule)
349 (meta . ,(grob-description "FollowThread"
350 line-spanner-interface))
354 (molecule-callback . ,Text_item::brew_molecule)
355 (font-family . roman)
356 (meta . ,(grob-description "NoteName"
357 note-name-interface font-interface
362 (self-alignment-X . 0)
364 (visibility-lambda . ,begin-of-line-visible)
365 (X-offset-callbacks . (,Side_position::centered_on_parent ,Side_position::aligned_on_self))
366 (Y-offset-callbacks . (,Side_position::aligned_side))
367 (molecule-callback . ,Text_item::brew_molecule)
368 (font-shape . italic)
369 (font-family . roman)
370 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
375 (before-grace-spacing-factor . 1.2)
376 (before-musical-spacing-factor . 0.4)
377 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
380 (molecule-callback . ,Slur::brew_molecule)
382 (spacing-procedure . ,Slur::set_spacing_rods)
383 (minimum-length . 1.5)
384 (after-line-breaking-callback . ,Slur::after_line_breaking)
385 (extremity-rules . ,default-slur-extremity-rules)
386 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
387 (de-uglify-parameters . ( 1.5 0.8 -2.0))
388 (Y-extent-callback . ,Slur::height)
389 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
390 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
391 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
392 (bezier-area-steps . 1.0)))
395 (attachment . (#f . #f))
396 (attachment-offset . ((0 . 0) . (0 . 0)))
398 (meta . ,(grob-description "PhrasingSlur" slur-interface))
400 (NonMusicalPaperColumn . (
402 (before-musical-spacing-factor . 1.0)
403 (column-space-strength . 2.0)
404 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
408 (after-line-breaking-callback . ,Rest::after_line_breaking)
409 (X-extent-callback . ,Rest::extent_callback)
410 (Y-extent-callback . ,Rest::extent_callback)
411 (molecule-callback . ,Rest::brew_molecule)
412 (minimum-beam-collision-distance . 1.5)
413 (meta . ,(grob-description "Rest"
414 rhythmic-head-interface
418 (minimum-distance . 0.75)
419 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
423 (molecule-callback . ,Script::brew_molecule)
424 (X-offset-callbacks . (,Side_position::centered_on_parent))
425 (after-line-breaking-callback . ,Script::after_line_breaking)
426 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
430 (before-line-breaking-callback . ,Script_column::before_line_breaking)
431 (meta . ,(grob-description "ScriptColumn" script-column-interface))
435 (molecule-callback . ,Slur::brew_molecule)
437 (spacing-procedure . ,Slur::set_spacing_rods)
438 (minimum-length . 1.5)
439 (after-line-breaking-callback . ,Slur::after_line_breaking)
440 (extremity-rules . ,default-slur-extremity-rules)
441 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
442 (de-uglify-parameters . ( 1.5 0.8 -2.0))
443 (Y-extent-callback . ,Slur::height)
444 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
445 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
446 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
447 (bezier-area-steps . 1.0)))
450 (attachment . (#f . #f))
451 (attachment-offset . ((0 . 0) . (0 . 0)))
453 (meta . ,(grob-description "Slur" slur-interface))
457 (spacing-procedure . ,Spacing_spanner::set_springs)
458 (stem-spacing-correction . 0.5)
459 (arithmetic-basicspace . 2.0)
460 (arithmetic-multiplier . ,(* 0.9 1.32))
461 ;; assume that notes at least this long are present.
462 (maximum-duration-for-spacing . ,(make-moment 1 8))
463 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
466 (break-align-symbol . Staff_bar)
467 (barsize-procedure . ,Span_bar::get_bar_size)
468 (molecule-callback . ,Bar::brew_molecule)
469 (visibility-lambda . ,begin-of-line-invisible)
470 (X-extent-callback . ,Span_bar::width_callback)
471 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
475 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
479 ;; Ross. page 151 lists other values, we opt for a leaner look
483 (hair-thickness . 1.6)
484 (thick-thickness . 6.0)
485 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
490 (molecule-callback . ,Text_item::brew_molecule)
491 (break-align-symbol . Clef_item)
492 (visibility-lambda . ,begin-of-line-visible)
493 (font-family . roman)
494 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
498 (molecule-callback . ,Staff_symbol::brew_molecule)
501 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
504 (molecule-callback . ,Text_item::brew_molecule)
505 (X-offset-callbacks . (,Side_position::aligned_on_self))
506 (Y-offset-callbacks .
507 (,Side_position::aligned_side
508 ,Side_position::centered_on_parent))
509 (no-spacing-rods . #t)
510 (font-shape . italic)
511 (self-alignment-X . 0)
512 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
516 (before-line-breaking-callback . ,Stem::before_line_breaking)
517 (molecule-callback . ,Stem::brew_molecule)
519 (beamed-lengths . (0.0 2.5 2.0 1.5))
520 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
522 ;; Stems in unnatural (forced) direction should be shortened,
523 ;; according to [Roush & Gourlay]. Their suggestion to knock off
524 ;; a whole staffspace seems a bit drastical: we'll do half.
526 (lengths . (3.5 3.5 3.5 4.5 5.0))
527 (stem-shorten . (0.5))
528 ; if stem is on middle line, choose this direction.
529 (default-neutral-direction . 1)
530 (X-offset-callbacks . (,Stem::off_callback))
531 (X-extent-callback . ,Stem::dim_callback)
532 (Y-extent-callback . ,Stem::height)
533 (meta . ,(grob-description "Stem" stem-interface font-interface))
537 (molecule-callback . ,Stem_tremolo::brew_molecule)
538 (Y-extent-callback . ,Stem_tremolo::height)
539 (X-extent-callback . #f)
541 (beam-width . 2.0) ; staff-space
542 (beam-thickness . 0.42) ; staff-space
543 (beam-space-function . ,default-beam-space-function)
544 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
548 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
550 (SeparatingGroupSpanner . (
551 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
552 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
556 (no-spacing-rods . #t)
557 (molecule-callback . ,Sustain_pedal::brew_molecule)
558 (self-alignment-X . 0)
559 (X-offset-callbacks . (,Side_position::aligned_on_self))
560 (Y-offset-callbacks .
561 (,Side_position::aligned_side
562 ,Side_position::centered_on_parent))
564 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
568 (SystemStartDelimiter . (
569 (molecule-callback . ,System_start_delimiter::brew_molecule)
570 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
571 ;; ugh, in practice, brace has height of 4.1 staff-spaces
572 (brace-collapse-height . 4.1)
573 (bracket-collapse-height . 1)
580 (bracket-thick . 0.25)
581 (Y-extent-callback . #f)
582 (font-family . braces)
583 ;; if you want to set point-size, you cannot set
584 ;; relative-size, as no font will be found for other
586 ;;(font-point-size . 20)
587 ;;(font-relative-size . #f)
588 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
592 (molecule-callback . ,Text_item::brew_molecule)
593 (no-spacing-rods . #t)
596 (font-family . roman)
597 (font-shape . italic)
598 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
601 (molecule-callback . ,Text_spanner::brew_molecule)
602 (font-shape . italic)
603 (font-family . roman)
606 ;; urg, only for (de)cresc. text spanners
607 (if-text-padding . 1.0)
611 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
614 (molecule-callback . ,Tie::brew_molecule)
615 (spacing-procedure . ,Tie::set_spacing_rods)
616 (staffline-clearance . 0.35)
617 (details . ((ratio . 0.333) (height-limit . 1.0)))
620 (minimum-length . 2.5)
621 (meta . ,(grob-description "Tie" tie-interface ))
625 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
626 (meta . ,(grob-description "TieColumn" tie-column-interface ))
630 (molecule-callback . ,Time_signature::brew_molecule)
631 (break-align-symbol . Time_signature)
632 (visibility-lambda . ,all-visible)
634 (font-family . number)
635 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
642 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
643 (molecule-callback . ,Tuplet_bracket::brew_molecule)
644 (font-family . roman)
645 (font-shape . italic)
646 (font-relative-size . -1)
647 (meta . ,(grob-description "TupletBracket" text-interface
648 tuplet-bracket-interface font-interface))
652 (molecule-callback . ,Text_item::brew_molecule)
653 (font-shape . italic)
654 (no-spacing-rods . #t)
655 (self-alignment-X . 0)
656 (X-offset-callbacks . (,Side_position::aligned_on_self))
657 (Y-offset-callbacks .
658 (,Side_position::aligned_side
659 ,Side_position::centered_on_parent))
660 (meta . ,(grob-description "UnaChordaPedal" text-interface font-interface))
664 (molecule-callback . ,Volta_spanner::brew_molecule)
669 (Y-offset-callbacks . (,Side_position::aligned_side))
670 (thickness . 1.6) ; stafflinethickness
671 (height . 2.0) ; staffspace;
673 (font-family . number)
674 (font-relative-size . -2)
675 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
678 (VerticalAlignment . (
680 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
681 (X-extent-callback . #f)
683 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
686 (VerticalAxisGroup . (
688 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
694 ; (display (map pair? all-grob-descriptions))