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_interface::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_interface::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 (space-alist . ,default-break-align-space-alist)
91 (meta . ,(grob-description "BreakAlignment"
92 axis-group-interface align-interface
99 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
101 (meta . ,(grob-description "BreakAlignGroup" axis-group-interface))
105 (break-align-symbol . Breathing_sign)
107 (molecule-callback . ,Breathing_sign::brew_molecule)
108 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
109 (visibility-lambda . ,begin-of-line-invisible)
110 (meta . ,(grob-description "BreathingSign" break-aligned-interface))
114 (molecule-callback . ,Clef::brew_molecule)
115 (before-line-breaking-callback . ,Clef::before_line_breaking)
117 (font-family . music)
118 (break-align-symbol . Clef_item)
119 (visibility-lambda . ,begin-of-line-visible)
120 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
121 (meta . ,(grob-description "Clef" clef-interface font-interface break-aligned-interface ))
125 (molecule-callback . ,Chord_name::brew_molecule)
126 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
127 (chord-name-function . ,default-chord-name-function)
128 (font-family . roman)
129 (meta . ,(grob-description "ChordName" font-interface text-interface chord-name-interface))
133 (break-align-symbol . Custos)
135 (molecule-callback . ,Custos::brew_molecule)
136 (visibility-lambda . ,end-of-line-visible)
138 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
139 (meta . ,(grob-description "Custos" custos-interface staff-symbol-referencer-interface break-aligned-interface) )
143 (molecule-callback . ,Hairpin::brew_molecule)
146 (spacing-procedure . ,Spanner::set_spacing_rods)
147 (minimum-length . 2.0)
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_interface::aligned_on_self))
155 (meta . ,(grob-description "Hairpin" hairpin-interface dynamic-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 dots-interface ))
172 (Y-offset-callbacks . (,Side_position_interface::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 dynamic-interface))
182 (DynamicLineSpanner . (
185 (minimum-space . 1.2)
187 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
191 (break-align-symbol . Left_edge_item)
192 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
194 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
198 (molecule-callback . ,Text_item::brew_molecule)
199 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
202 (self-alignment-X . 0)
203 (font-family . number)
204 (font-relative-size . -3)
205 (font-shape . upright)
206 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
211 (horizontal-space . 1.2)
213 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
214 (meta . ,(grob-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
217 (HaraKiriVerticalGroup . (
218 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
219 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
221 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
227 (minimum-length . 0.5)
228 (molecule-callback . ,Hyphen_spanner::brew_molecule)
229 (Y-extent-callback . ,Grob::point_dimension_callback)
230 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
235 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
236 ,Side_position_interface::aligned_on_support_refpoints
239 (self-alignment-Y . 0)
240 (molecule-callback . ,Text_item::brew_molecule)
241 (break-align-symbol . Instrument_name)
242 (visibility-lambda . ,begin-of-line-visible)
244 (font-family . roman)
245 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
249 (molecule-callback . ,Key_item::brew_molecule)
250 (break-align-symbol . Key_item)
251 (visibility-lambda . ,begin-of-line-visible)
253 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
257 (molecule-callback . ,Local_key_item::brew_molecule)
258 (X-offset-callbacks . (,Side_position_interface::aligned_side))
259 (after-line-breaking-callback . ,Local_key_item::after_line_breaking)
262 (right-padding . 0.4)
263 (meta . ,(grob-description "Accidentals" accidentals-interface font-interface side-position-interface))
268 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
272 (molecule-callback . ,Lyric_extender::brew_molecule)
273 (height . 0.8) ; stafflinethickness;
274 (right-trim-amount . 0.5)
275 (Y-extent-callback . ,Grob::point_dimension_callback)
276 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
280 (molecule-callback . ,Text_item::brew_molecule)
281 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
282 (self-alignment-X . 0)
285 (font-family . roman)
286 (font-shape . upright)
287 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
291 (molecule-callback . ,Text_item::brew_molecule)
292 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
293 (self-alignment-X . 0)
297 (font-family . number)
298 (font-shape . upright)
299 (font-relative-size . 1)
300 (visibility-lambda . ,end-of-line-invisible)
302 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
305 (MultiMeasureRest . (
306 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
307 (molecule-callback . ,Multi_measure_rest::brew_molecule)
308 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
311 (padding . 2.0) ; staffspace
312 (minimum-width . 12.5) ; staffspace
313 (font-family . number)
314 (font-relative-size . 1)
315 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface rest-interface font-interface ))
320 (meta . ,(grob-description "NoteCollision"
321 note-collision-interface axis-group-interface
327 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
332 (molecule-callback . ,Note_head::brew_molecule)
333 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
334 (attachment-angle . ,(* 20/360 3.14159))
335 (meta . ,(grob-description "NoteHead"
336 rhythmic-head-interface font-interface
337 note-head-interface ))
343 (X-extent-callback . #f)
344 (Y-extent-callback . #f)
345 (molecule-callback . ,Line_spanner::brew_molecule)
346 (meta . ,(grob-description "Glissando"
347 line-spanner-interface))
353 (X-extent-callback . #f)
354 (Y-extent-callback . #f)
355 (molecule-callback . ,Line_spanner::brew_molecule)
356 (meta . ,(grob-description "VoiceFollower"
357 line-spanner-interface))
361 (molecule-callback . ,Text_item::brew_molecule)
362 (font-family . roman)
363 (meta . ,(grob-description "NoteName"
364 note-name-interface font-interface
369 (self-alignment-X . 0)
371 (visibility-lambda . ,begin-of-line-visible)
372 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
373 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
374 (molecule-callback . ,Text_item::brew_molecule)
375 (font-shape . italic)
376 (font-family . roman)
377 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
382 (before-grace-spacing-factor . 1.2)
383 (before-musical-spacing-factor . 0.4)
384 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
387 (molecule-callback . ,Slur::brew_molecule)
389 (spacing-procedure . ,Spanner::set_spacing_rods)
390 (minimum-length . 1.5)
391 (after-line-breaking-callback . ,Slur::after_line_breaking)
392 (extremity-rules . ,default-slur-extremity-rules)
393 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
394 (de-uglify-parameters . ( 1.5 0.8 -2.0))
395 (Y-extent-callback . ,Slur::height)
396 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
397 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
398 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
399 (bezier-area-steps . 1.0)))
402 (attachment . (#f . #f))
403 (attachment-offset . ((0 . 0) . (0 . 0)))
405 (meta . ,(grob-description "PhrasingSlur" slur-interface))
408 (NonMusicalPaperColumn . (
410 (before-musical-spacing-factor . 1.0)
411 (column-space-strength . 2.0)
412 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
416 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
417 (molecule-callback . ,Multi_measure_rest::percent)
420 (padding . 2.0) ; staffspace
421 (minimum-width . 12.5) ; staffspace
422 (font-family . music)
423 (meta . ,(grob-description "PercentRepeat" multi-measure-rest-interface font-interface))
428 (after-line-breaking-callback . ,Rest::after_line_breaking)
429 (X-extent-callback . ,Rest::extent_callback)
430 (Y-extent-callback . ,Rest::extent_callback)
431 (molecule-callback . ,Rest::brew_molecule)
432 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
433 (minimum-beam-collision-distance . 1.5)
434 (meta . ,(grob-description "Rest"
435 rhythmic-head-interface
436 staff-symbol-referencer-interface
440 (minimum-distance . 0.75)
441 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
445 ;; don't set direction here: it breaks staccato.
446 (molecule-callback . ,Script::brew_molecule)
447 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
448 (before-line-breaking-callback . ,Script::before_line_breaking)
449 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
453 (before-line-breaking-callback . ,Script_column::before_line_breaking)
454 (meta . ,(grob-description "ScriptColumn" script-column-interface))
458 (molecule-callback . ,Slur::brew_molecule)
460 (spacing-procedure . ,Spanner::set_spacing_rods)
461 (minimum-length . 1.5)
462 (after-line-breaking-callback . ,Slur::after_line_breaking)
463 (extremity-rules . ,default-slur-extremity-rules)
464 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
465 (de-uglify-parameters . ( 1.5 0.8 -2.0))
466 (Y-extent-callback . ,Slur::height)
467 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
468 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
469 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
470 (bezier-area-steps . 1.0)))
473 (attachment . (#f . #f))
474 (attachment-offset . ((0 . 0) . (0 . 0)))
476 (meta . ,(grob-description "Slur" slur-interface))
480 (spacing-procedure . ,Spacing_spanner::set_springs)
481 (stem-spacing-correction . 0.5)
482 (arithmetic-basicspace . 2.0)
483 (arithmetic-multiplier . ,(* 0.9 1.32))
484 ;; assume that notes at least this long are present.
485 (maximum-duration-for-spacing . ,(make-moment 1 8))
486 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
489 (break-align-symbol . Staff_bar)
490 (barsize-procedure . ,Span_bar::get_bar_size)
491 (molecule-callback . ,Bar::brew_molecule)
492 (visibility-lambda . ,begin-of-line-invisible)
493 (X-extent-callback . ,Span_bar::width_callback)
494 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
498 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
502 ;; Ross. page 151 lists other values, we opt for a leaner look
506 (hair-thickness . 1.6)
507 (thick-thickness . 6.0)
508 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
513 (molecule-callback . ,Text_item::brew_molecule)
514 (break-align-symbol . Clef_item)
515 (visibility-lambda . ,begin-of-line-visible)
516 (font-family . roman)
517 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
521 (molecule-callback . ,Staff_symbol::brew_molecule)
525 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
528 (molecule-callback . ,Text_item::brew_molecule)
530 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
531 (Y-offset-callbacks .
532 (,Side_position_interface::aligned_side
533 ,Side_position_interface::centered_on_parent))
534 (no-spacing-rods . #t)
535 (font-shape . italic)
536 (self-alignment-X . 0)
537 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
541 (before-line-breaking-callback . ,Stem::before_line_breaking)
542 (molecule-callback . ,Stem::brew_molecule)
544 (beamed-lengths . (0.0 2.5 2.0 1.5))
545 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
547 ;; Stems in unnatural (forced) direction should be shortened,
548 ;; according to [Roush & Gourlay]. Their suggestion to knock off
549 ;; a whole staffspace seems a bit drastical: we'll do half.
551 (lengths . (3.5 3.5 3.5 4.5 5.0))
552 (stem-shorten . (0.5))
553 ; if stem is on middle line, choose this direction.
554 (default-neutral-direction . 1)
555 (X-offset-callbacks . (,Stem::off_callback))
556 (X-extent-callback . ,Stem::dim_callback)
557 (Y-extent-callback . ,Stem::height)
558 (meta . ,(grob-description "Stem" stem-interface font-interface))
562 (molecule-callback . ,Stem_tremolo::brew_molecule)
563 (Y-extent-callback . ,Stem_tremolo::height)
564 (X-extent-callback . #f)
566 (beam-width . 2.0) ; staff-space
567 (beam-thickness . 0.42) ; staff-space
568 (beam-space-function . ,default-beam-space-function)
569 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
573 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
575 (SeparatingGroupSpanner . (
576 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
577 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
581 (no-spacing-rods . #t)
582 (molecule-callback . ,Sustain_pedal::brew_molecule)
583 (self-alignment-X . 0)
585 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
586 (Y-offset-callbacks .
587 (,Side_position_interface::aligned_side
588 ,Side_position_interface::centered_on_parent))
590 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
594 (SystemStartDelimiter . (
595 (molecule-callback . ,System_start_delimiter::brew_molecule)
596 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
597 ;; ugh, in practice, brace has height of 4.1 staff-spaces
598 (brace-collapse-height . 4.1)
599 (bracket-collapse-height . 1)
606 (bracket-thick . 0.25)
607 (Y-extent-callback . #f)
608 (font-family . braces)
609 ;; if you want to set point-size, you cannot set
610 ;; relative-size, as no font will be found for other
612 ;;(font-design-size . 20)
613 ;;(font-relative-size . #f)
614 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
618 (molecule-callback . ,Text_item::brew_molecule)
619 (no-spacing-rods . #t)
623 (font-family . roman)
624 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
627 (molecule-callback . ,Text_spanner::brew_molecule)
628 (font-family . roman)
631 ;; urg, only for (de)cresc. text spanners
632 (if-text-padding . 1.0)
636 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
639 (molecule-callback . ,Tie::brew_molecule)
640 (spacing-procedure . ,Spanner::set_spacing_rods)
641 (staffline-clearance . 0.35)
642 (details . ((ratio . 0.333) (height-limit . 1.0)))
645 (minimum-length . 2.5)
646 (meta . ,(grob-description "Tie" tie-interface ))
650 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
651 (meta . ,(grob-description "TieColumn" tie-column-interface ))
655 (molecule-callback . ,Time_signature::brew_molecule)
656 (break-align-symbol . Time_signature)
657 (visibility-lambda . ,all-visible)
659 (font-family . number)
660 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
667 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
668 (molecule-callback . ,Tuplet_bracket::brew_molecule)
669 (font-family . roman)
670 (font-shape . italic)
671 (font-relative-size . -1)
672 (meta . ,(grob-description "TupletBracket" text-interface
673 tuplet-bracket-interface font-interface))
677 (molecule-callback . ,Text_item::brew_molecule)
678 (font-shape . italic)
679 (no-spacing-rods . #t)
680 (self-alignment-X . 0)
682 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
683 (Y-offset-callbacks .
684 (,Side_position_interface::aligned_side
685 ,Side_position_interface::centered_on_parent))
686 (meta . ,(grob-description "UnaChordaPedal" text-interface font-interface))
690 (molecule-callback . ,Volta_spanner::brew_molecule)
695 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
696 (thickness . 1.6) ; stafflinethickness
697 (height . 2.0) ; staffspace;
699 (font-family . number)
700 (font-relative-size . -2)
701 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
704 (VerticalAlignment . (
706 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
707 (X-extent-callback . #f)
709 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
712 (VerticalAxisGroup . (
714 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
720 ; (display (map pair? all-grob-descriptions))