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
14 (molecule-callback . ,Local_key_item::brew_molecule)
15 (X-offset-callbacks . (,Side_position_interface::aligned_side))
16 (after-line-breaking-callback . ,Local_key_item::after_line_breaking)
20 (meta . ,(grob-description "Accidentals" accidentals-interface font-interface side-position-interface))
24 (X-extent-callback . ,Arpeggio::width_callback)
25 (Y-extent-callback . #f)
26 (molecule-callback . ,Arpeggio::brew_molecule)
27 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
28 (X-offset-callbacks . (,Side_position_interface::aligned_side))
30 (staff-position . 0.0)
31 (meta . ,(grob-description "Arpeggio" arpeggio-interface side-position-interface font-interface))
34 (autoBeamSettings . ,auto-beam-settings)
37 (break-align-symbol . Staff_bar)
39 (break-glyph-function . ,default-break-barline)
40 (bar-size-procedure . ,Bar::get_staff_bar_size)
41 (molecule-callback . ,Bar::brew_molecule)
42 (visibility-lambda . ,all-visible)
44 (before-line-breaking-callback . ,Bar::before_line_breaking)
46 ;; Ross. page 151 lists other values, we opt for a leaner look
50 (hair-thickness . 1.6)
51 (thick-thickness . 6.0)
52 (meta . ,(grob-description "BarLine" bar-line-interface font-interface))
56 (molecule-callback . ,Text_item::brew_molecule)
58 (visibility-lambda . ,begin-of-line-visible)
62 (font-relative-size . -1)
63 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
64 (meta . ,(grob-description "BarNumber"
65 side-position-interface
66 text-interface font-interface break-aligned-interface))
70 ;; todo: clean this up a bit: the list is getting
72 (molecule-callback . ,Beam::brew_molecule)
73 (y-dy-callbacks . (,Beam::least_squares
74 ,Beam::cancel_suspect_slope
78 ,Beam::do_quantise_y))
80 (thickness . 0.48) ; in staff-space
81 (before-line-breaking-callback . ,Beam::before_line_breaking)
82 (after-line-breaking-callback . ,Beam::after_line_breaking)
83 (neutral-direction . -1)
84 (dir-function . ,beam-dir-majority)
85 (height-quants . ,default-beam-dy-quants)
86 (vertical-position-quant-function . ,default-beam-y-quants)
87 (beamed-stem-shorten . (0.5))
88 (outer-stem-length-limit . 0.2)
90 (flag-width-function . ,default-beam-flag-width-function)
91 (space-function . ,default-beam-space-function)
94 (meta . ,(grob-description "Beam" beam-interface))
101 (space-alist . ,default-break-align-space-alist)
102 (meta . ,(grob-description "BreakAlignment"
103 axis-group-interface align-interface
110 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
112 (meta . ,(grob-description "BreakAlignGroup" axis-group-interface))
116 (break-align-symbol . Breathing_sign)
118 (molecule-callback . ,Breathing_sign::brew_molecule)
119 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
120 (visibility-lambda . ,begin-of-line-invisible)
121 (meta . ,(grob-description "BreathingSign" break-aligned-interface))
125 (molecule-callback . ,Clef::brew_molecule)
126 (before-line-breaking-callback . ,Clef::before_line_breaking)
128 (font-family . music)
129 (break-align-symbol . Clef_item)
130 (visibility-lambda . ,begin-of-line-visible)
131 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
132 (meta . ,(grob-description "Clef" clef-interface font-interface break-aligned-interface ))
136 (molecule-callback . ,Chord_name::brew_molecule)
137 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
138 (chord-name-function . ,default-chord-name-function)
139 (font-family . roman)
140 (meta . ,(grob-description "ChordName" font-interface text-interface chord-name-interface))
144 (break-align-symbol . Custos)
146 (molecule-callback . ,Custos::brew_molecule)
147 (visibility-lambda . ,end-of-line-visible)
149 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
150 (meta . ,(grob-description "Custos" custos-interface staff-symbol-referencer-interface break-aligned-interface) )
157 (X-extent-callback . ,Axis_group_interface::group_extent_callback)
159 (X-offset-callbacks . (,Dot_column::side_position))
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 ))
171 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
174 (font-family . music)
177 (break-align-symbol . Staff_bar)
178 (visibility-lambda . ,begin-of-line-invisible)
179 (meta . ,(grob-description "DoublePercentRepeat" font-interface percent-repeat-interface))
183 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
184 (molecule-callback . ,Text_item::brew_molecule)
185 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
186 (self-alignment-X . 0)
188 (no-spacing-rods . #t)
189 (script-priority . 100)
191 (font-family . dynamic)
192 (font-shape . italic)
193 (self-alignment-Y . 0)
194 (meta . ,(grob-description "DynamicText" font-interface text-interface dynamic-interface))
197 (DynamicLineSpanner . (
200 (minimum-space . 1.2)
202 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
206 (break-align-symbol . Left_edge_item)
207 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
209 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
213 (molecule-callback . ,Text_item::brew_molecule)
214 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
217 (self-alignment-X . 0)
218 (font-family . number)
219 (font-relative-size . -3)
220 (font-shape . upright)
221 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
226 (horizontal-space . 1.2)
228 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
229 (meta . ,(grob-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
232 (HaraKiriVerticalGroup . (
233 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
234 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
236 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
239 (molecule-callback . ,Hairpin::brew_molecule)
242 (spacing-procedure . ,Spanner::set_spacing_rods)
243 (minimum-length . 2.0)
244 (if-text-padding . 1.0)
245 (width-correct . -1.0)
247 (dash-thickness . 1.2)
249 (self-alignment-Y . 0)
250 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
251 (meta . ,(grob-description "Hairpin" hairpin-interface dynamic-interface))
256 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
257 ,Side_position_interface::aligned_on_support_refpoints
260 (self-alignment-Y . 0)
261 (molecule-callback . ,Text_item::brew_molecule)
262 (break-align-symbol . Instrument_name)
263 (visibility-lambda . ,begin-of-line-visible)
265 (font-family . roman)
266 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
270 (molecule-callback . ,Key_item::brew_molecule)
271 (break-align-symbol . Key_item)
272 (visibility-lambda . ,begin-of-line-visible)
274 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
281 (minimum-length . 0.5)
282 (maximum-length . 100)
283 (molecule-callback . ,Hyphen_spanner::brew_molecule)
284 (Y-extent-callback . ,Grob::point_dimension_callback)
285 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
290 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
294 (molecule-callback . ,Lyric_extender::brew_molecule)
295 (height . 0.8) ; stafflinethickness;
296 (right-trim-amount . 0.5)
297 (Y-extent-callback . ,Grob::point_dimension_callback)
298 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
302 (molecule-callback . ,Text_item::brew_molecule)
303 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
304 (self-alignment-X . 0)
307 (ignore-length-mismatch . #f)
308 (begin-alignment . 4)
310 (font-family . roman)
311 (font-shape . upright)
312 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
316 (molecule-callback . ,Text_item::brew_molecule)
317 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
318 (self-alignment-X . 0)
322 (font-family . roman)
323 (font-shape . upright)
324 (font-relative-size . 1)
325 (visibility-lambda . ,end-of-line-invisible)
327 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
330 (MultiMeasureRest . (
331 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
332 (molecule-callback . ,Multi_measure_rest::brew_molecule)
333 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
336 (padding . 2.0) ; staffspace
337 (minimum-width . 12.5) ; staffspace
338 (font-family . number)
339 (font-relative-size . 1)
340 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface rest-interface font-interface ))
344 ;; Ugh, should not be hard-coded.
346 (meta . ,(grob-description "NoteCollision"
347 note-collision-interface axis-group-interface
353 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
358 (molecule-callback . ,Note_head::brew_molecule)
359 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
360 (stem-attachment-function
361 . ,note-head-style->attachment-coordinates)
362 (meta . ,(grob-description "NoteHead"
363 rhythmic-head-interface font-interface
364 note-head-interface ))
370 (X-extent-callback . #f)
371 (Y-extent-callback . #f)
372 (molecule-callback . ,Line_spanner::brew_molecule)
373 (meta . ,(grob-description "Glissando"
374 line-spanner-interface))
380 (X-extent-callback . #f)
381 (Y-extent-callback . #f)
382 (molecule-callback . ,Line_spanner::brew_molecule)
383 (meta . ,(grob-description "VoiceFollower"
384 line-spanner-interface))
388 (molecule-callback . ,Text_item::brew_molecule)
389 (font-family . roman)
390 (meta . ,(grob-description "NoteName"
391 note-name-interface font-interface
396 (self-alignment-X . 0)
398 (visibility-lambda . ,begin-of-line-visible)
399 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
400 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
401 (molecule-callback . ,Text_item::brew_molecule)
402 (font-shape . italic)
403 (font-family . roman)
404 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
409 (before-grace-spacing-factor . 1.2)
410 (before-musical-spacing-factor . 0.4)
411 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
414 (molecule-callback . ,Slur::brew_molecule)
416 (spacing-procedure . ,Spanner::set_spacing_rods)
417 (minimum-length . 1.5)
418 (after-line-breaking-callback . ,Slur::after_line_breaking)
419 (extremity-rules . ,default-slur-extremity-rules)
420 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
421 (de-uglify-parameters . ( 1.5 0.8 -2.0))
422 (Y-extent-callback . ,Slur::height)
423 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
424 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
425 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
426 (bezier-area-steps . 1.0)))
429 (attachment . (#f . #f))
430 (attachment-offset . ((0 . 0) . (0 . 0)))
432 (meta . ,(grob-description "PhrasingSlur" slur-interface))
435 (NonMusicalPaperColumn . (
437 (before-musical-spacing-factor . 1.0)
438 (column-space-strength . 2.0)
439 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
443 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
444 (molecule-callback . ,Multi_measure_rest::percent)
447 (minimum-width . 12.5) ; staffspace
448 (font-family . music)
449 (meta . ,(grob-description "PercentRepeat" multi-measure-rest-interface font-interface percent-repeat-interface))
454 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
457 (meta . ,(grob-description "RepeatSlash" percent-repeat-interface))
460 (after-line-breaking-callback . ,Rest::after_line_breaking)
461 (X-extent-callback . ,Rest::extent_callback)
462 (Y-extent-callback . ,Rest::extent_callback)
463 (molecule-callback . ,Rest::brew_molecule)
464 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
465 (minimum-beam-collision-distance . 1.5)
466 (meta . ,(grob-description "Rest"
467 rhythmic-head-interface
468 staff-symbol-referencer-interface
472 (minimum-distance . 0.75)
473 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
477 ;; don't set direction here: it breaks staccato.
478 (molecule-callback . ,Script::brew_molecule)
480 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
481 (before-line-breaking-callback . ,Script::before_line_breaking)
482 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
486 (before-line-breaking-callback . ,Script_column::before_line_breaking)
487 (meta . ,(grob-description "ScriptColumn" script-column-interface))
491 (molecule-callback . ,Slur::brew_molecule)
493 (spacing-procedure . ,Spanner::set_spacing_rods)
494 (minimum-length . 1.5)
495 (after-line-breaking-callback . ,Slur::after_line_breaking)
496 (extremity-rules . ,default-slur-extremity-rules)
497 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
498 (de-uglify-parameters . ( 1.5 0.8 -2.0))
499 (Y-extent-callback . ,Slur::height)
500 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
501 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
502 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
503 (bezier-area-steps . 1.0)))
506 (attachment . (#f . #f))
507 (attachment-offset . ((0 . 0) . (0 . 0)))
509 (meta . ,(grob-description "Slur" slur-interface))
513 (spacing-procedure . ,Spacing_spanner::set_springs)
514 (stem-spacing-correction . 0.5)
515 (arithmetic-basicspace . 2.0)
516 (arithmetic-multiplier . ,(* 0.9 1.32))
517 ;; assume that notes at least this long are present.
518 (maximum-duration-for-spacing . ,(make-moment 1 8))
519 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
522 (break-align-symbol . Staff_bar)
523 (bar-size-procedure . ,Span_bar::get_bar_size)
524 (molecule-callback . ,Span_bar::brew_molecule)
525 (visibility-lambda . ,begin-of-line-invisible)
526 (X-extent-callback . ,Span_bar::width_callback)
527 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
531 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
535 ;; Ross. page 151 lists other values, we opt for a leaner look
539 (hair-thickness . 1.6)
540 (thick-thickness . 6.0)
541 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
546 (molecule-callback . ,Text_item::brew_molecule)
547 (break-align-symbol . Clef_item)
548 (visibility-lambda . ,begin-of-line-visible)
549 (font-family . roman)
550 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
554 (molecule-callback . ,Staff_symbol::brew_molecule)
558 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
561 (molecule-callback . ,Text_item::brew_molecule)
563 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
564 (Y-offset-callbacks .
565 (,Side_position_interface::aligned_side
566 ,Side_position_interface::centered_on_parent))
567 (no-spacing-rods . #t)
568 (font-shape . italic)
569 (self-alignment-X . 0)
570 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
574 (before-line-breaking-callback . ,Stem::before_line_breaking)
575 (molecule-callback . ,Stem::brew_molecule)
577 (beamed-lengths . (0.0 2.5 2.0 1.5))
578 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
580 ;; Stems in unnatural (forced) direction should be shortened,
581 ;; according to [Roush & Gourlay]. Their suggestion to knock off
582 ;; a whole staffspace seems a bit drastical: we'll do half.
584 (lengths . (3.5 3.5 3.5 4.5 5.0))
585 (stem-shorten . (0.5))
586 ; if stem is on middle line, choose this direction.
587 (neutral-direction . -1)
588 (X-offset-callbacks . (,Stem::off_callback))
589 (X-extent-callback . ,Stem::dim_callback)
590 (Y-extent-callback . ,Stem::height)
591 (meta . ,(grob-description "Stem" stem-interface font-interface))
595 (molecule-callback . ,Stem_tremolo::brew_molecule)
596 (Y-extent-callback . ,Stem_tremolo::height)
597 (X-extent-callback . #f)
599 (beam-width . 2.0) ; staff-space
600 (beam-thickness . 0.42) ; staff-space
601 (beam-space-function . ,default-beam-space-function)
602 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
606 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
608 (SeparatingGroupSpanner . (
609 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
610 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
614 (no-spacing-rods . #t)
615 (molecule-callback . ,Sustain_pedal::brew_molecule)
616 (self-alignment-X . 0)
618 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
619 (Y-offset-callbacks .
620 (,Side_position_interface::aligned_side
621 ,Side_position_interface::centered_on_parent))
623 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
626 ;; TODO: should split in 3
627 (SystemStartDelimiter . (
628 (molecule-callback . ,System_start_delimiter::brew_molecule)
629 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
630 ;; really 4.0, but 5 to be on safe side.
631 (brace-collapse-height . 5.0)
632 (bracket-collapse-height . 1)
639 (bracket-thick . 0.25)
640 (Y-extent-callback . #f)
641 (font-family . braces)
642 ;; if you want to set point-size, you cannot set
643 ;; relative-size, as no font will be found for other
645 ;;(font-design-size . 20)
646 ;;(font-relative-size . #f)
647 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
651 (molecule-callback . ,Text_item::brew_molecule)
652 (no-spacing-rods . #t)
655 ;; todo: add X self alignment?
657 (font-family . roman)
658 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
661 (molecule-callback . ,Text_spanner::brew_molecule)
662 (font-family . roman)
665 ;; urg, only for (de)cresc. text spanners
666 (if-text-padding . 1.0)
670 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
673 (molecule-callback . ,Tie::brew_molecule)
674 (spacing-procedure . ,Spanner::set_spacing_rods)
675 (staffline-clearance . 0.35)
676 (details . ((ratio . 0.333) (height-limit . 1.0)))
680 (minimum-length . 2.5)
681 (meta . ,(grob-description "Tie" tie-interface ))
685 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
686 (meta . ,(grob-description "TieColumn" tie-column-interface ))
690 (molecule-callback . ,Time_signature::brew_molecule)
691 (break-align-symbol . Time_signature)
692 (visibility-lambda . ,all-visible)
695 (font-family . number)
696 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
703 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
704 (molecule-callback . ,Tuplet_bracket::brew_molecule)
705 (font-family . roman)
706 (font-shape . italic)
707 (font-relative-size . -1)
708 (meta . ,(grob-description "TupletBracket" text-interface
709 tuplet-bracket-interface font-interface))
713 (molecule-callback . ,Text_item::brew_molecule)
714 (font-family . roman)
715 (font-shape . italic)
716 (no-spacing-rods . #t)
717 (self-alignment-X . 0)
719 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
720 (Y-offset-callbacks .
721 (,Side_position_interface::aligned_side
722 ,Side_position_interface::centered_on_parent))
723 (meta . ,(grob-description "UnaCordaPedal" text-interface font-interface))
727 (molecule-callback . ,Volta_spanner::brew_molecule)
732 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
733 (thickness . 1.6) ; stafflinethickness
734 (height . 2.0) ; staffspace;
736 (font-family . number)
737 (font-relative-size . -2)
738 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
741 (VerticalAlignment . (
743 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
744 (X-extent-callback . #f)
747 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
750 (VerticalAxisGroup . (
752 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
758 ; (display (map pair? all-grob-descriptions))