1 ;;;; grob-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--20.301 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 (arpeggio-type . plain)
32 (meta . ,(grob-description "Arpeggio" arpeggio-interface side-position-interface font-interface))
35 (autoBeamSettings . ,auto-beam-settings)
38 (break-align-symbol . Staff_bar)
40 (break-glyph-function . ,default-break-barline)
41 (bar-size-procedure . ,Bar::get_staff_bar_size)
42 (molecule-callback . ,Bar::brew_molecule)
43 (visibility-lambda . ,all-visible)
45 (before-line-breaking-callback . ,Bar::before_line_breaking)
47 ;; Ross. page 151 lists other values, we opt for a leaner look
51 (hair-thickness . 1.6)
52 (thick-thickness . 6.0)
53 (meta . ,(grob-description "BarLine" bar-line-interface font-interface))
57 (molecule-callback . ,Text_item::brew_molecule)
59 (visibility-lambda . ,begin-of-line-visible)
63 (font-relative-size . -1)
64 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
65 (meta . ,(grob-description "BarNumber"
66 side-position-interface
67 text-interface font-interface break-aligned-interface))
71 ;; todo: clean this up a bit: the list is getting
73 (molecule-callback . ,Beam::brew_molecule)
74 (y-dy-callbacks . (,Beam::least_squares
75 ,Beam::cancel_suspect_slope
79 ,Beam::do_quantise_y))
81 (thickness . 0.48) ; in staff-space
82 (before-line-breaking-callback . ,Beam::before_line_breaking)
83 (after-line-breaking-callback . ,Beam::after_line_breaking)
84 (neutral-direction . -1)
85 (dir-function . ,beam-dir-majority)
86 (height-quants . ,default-beam-dy-quants)
87 (vertical-position-quant-function . ,default-beam-y-quants)
88 (beamed-stem-shorten . (0.5))
89 (outer-stem-length-limit . 0.2)
91 (flag-width-function . ,default-beam-flag-width-function)
92 (space-function . ,default-beam-space-function)
95 (meta . ,(grob-description "Beam" beam-interface))
102 (space-alist . ,default-break-align-space-alist)
103 (meta . ,(grob-description "BreakAlignment"
104 axis-group-interface align-interface
111 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
113 (meta . ,(grob-description "BreakAlignGroup" axis-group-interface))
117 (break-align-symbol . Breathing_sign)
119 (molecule-callback . ,Breathing_sign::brew_molecule)
120 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
121 (visibility-lambda . ,begin-of-line-invisible)
122 (meta . ,(grob-description "BreathingSign" break-aligned-interface))
126 (molecule-callback . ,Clef::brew_molecule)
127 (before-line-breaking-callback . ,Clef::before_line_breaking)
129 (font-family . music)
130 (break-align-symbol . Clef_item)
131 (visibility-lambda . ,begin-of-line-visible)
132 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
133 (meta . ,(grob-description "Clef" clef-interface font-interface break-aligned-interface ))
137 (molecule-callback . ,Chord_name::brew_molecule)
138 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
139 (chord-name-function . ,default-chord-name-function)
140 (font-family . roman)
141 (meta . ,(grob-description "ChordName" font-interface text-interface chord-name-interface))
145 (break-align-symbol . Custos)
147 (molecule-callback . ,Custos::brew_molecule)
148 (visibility-lambda . ,end-of-line-visible)
150 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
151 (meta . ,(grob-description "Custos" custos-interface staff-symbol-referencer-interface break-aligned-interface) )
158 (X-extent-callback . ,Axis_group_interface::group_extent_callback)
160 (X-offset-callbacks . (,Dot_column::side_position))
161 (meta . ,(grob-description "DotColumn" dot-column-interface axis-group-interface))
165 (molecule-callback . ,Dots::brew_molecule)
167 (staff-position . 0.0)
168 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
169 (meta . ,(grob-description "Dots" font-interface dots-interface ))
172 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
175 (font-family . music)
178 (break-align-symbol . Staff_bar)
179 (visibility-lambda . ,begin-of-line-invisible)
180 (meta . ,(grob-description "DoublePercentRepeat" font-interface percent-repeat-interface))
184 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
185 (molecule-callback . ,Text_item::brew_molecule)
186 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
187 (self-alignment-X . 0)
189 (no-spacing-rods . #t)
190 (script-priority . 100)
192 (font-family . dynamic)
193 (font-shape . italic)
194 (self-alignment-Y . 0)
195 (meta . ,(grob-description "DynamicText" font-interface text-interface dynamic-interface))
198 (DynamicLineSpanner . (
201 (minimum-space . 1.2)
203 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
207 (break-align-symbol . Left_edge_item)
208 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
210 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
214 (molecule-callback . ,Text_item::brew_molecule)
215 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
218 (self-alignment-X . 0)
219 (font-family . number)
220 (font-relative-size . -3)
221 (font-shape . upright)
222 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
226 (HaraKiriVerticalGroup . (
227 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
228 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
230 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
233 (molecule-callback . ,Hairpin::brew_molecule)
236 (spacing-procedure . ,Spanner::set_spacing_rods)
237 (minimum-length . 2.0)
238 (if-text-padding . 1.0)
239 (width-correct . -1.0)
241 (dash-thickness . 1.2)
243 (self-alignment-Y . 0)
244 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
245 (meta . ,(grob-description "Hairpin" hairpin-interface dynamic-interface))
250 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
251 ,Side_position_interface::aligned_on_support_refpoints
254 (self-alignment-Y . 0)
255 (molecule-callback . ,Text_item::brew_molecule)
256 (break-align-symbol . Instrument_name)
257 (visibility-lambda . ,begin-of-line-visible)
259 (font-family . roman)
260 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
264 (molecule-callback . ,Key_item::brew_molecule)
265 (break-align-symbol . Key_item)
266 (visibility-lambda . ,begin-of-line-visible)
268 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
275 (minimum-length . 0.5)
276 (maximum-length . 100)
277 (molecule-callback . ,Hyphen_spanner::brew_molecule)
278 (Y-extent-callback . ,Grob::point_dimension_callback)
279 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
284 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
288 (molecule-callback . ,Lyric_extender::brew_molecule)
289 (height . 0.8) ; stafflinethickness;
290 (right-trim-amount . 0.5)
291 (Y-extent-callback . ,Grob::point_dimension_callback)
292 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
296 (molecule-callback . ,Text_item::brew_molecule)
297 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
298 (self-alignment-X . 0)
301 (font-family . roman)
302 (font-shape . upright)
303 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
307 (molecule-callback . ,Text_item::brew_molecule)
308 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
309 (self-alignment-X . 0)
313 (font-family . roman)
314 (font-shape . upright)
315 (font-relative-size . 1)
316 (visibility-lambda . ,end-of-line-invisible)
318 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
321 (MultiMeasureRest . (
322 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
323 (molecule-callback . ,Multi_measure_rest::brew_molecule)
324 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
327 (padding . 2.0) ; staffspace
328 (minimum-width . 12.5) ; staffspace
329 (font-family . number)
330 (font-relative-size . 1)
331 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface rest-interface font-interface ))
335 ;; Ugh, should not be hard-coded.
337 (meta . ,(grob-description "NoteCollision"
338 note-collision-interface axis-group-interface
344 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
349 (molecule-callback . ,Note_head::brew_molecule)
350 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
351 (stem-attachment-function
352 . ,note-head-style->attachment-coordinates)
353 (meta . ,(grob-description "NoteHead"
354 rhythmic-head-interface font-interface
355 note-head-interface ))
361 (X-extent-callback . #f)
362 (Y-extent-callback . #f)
363 (molecule-callback . ,Line_spanner::brew_molecule)
364 (meta . ,(grob-description "Glissando"
365 line-spanner-interface))
371 (X-extent-callback . #f)
372 (Y-extent-callback . #f)
373 (molecule-callback . ,Line_spanner::brew_molecule)
374 (meta . ,(grob-description "VoiceFollower"
375 line-spanner-interface))
379 (molecule-callback . ,Text_item::brew_molecule)
380 (font-family . roman)
381 (meta . ,(grob-description "NoteName"
382 note-name-interface font-interface
387 (self-alignment-X . 0)
389 (visibility-lambda . ,begin-of-line-visible)
390 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
391 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
392 (molecule-callback . ,Text_item::brew_molecule)
393 (font-shape . italic)
394 (font-family . roman)
395 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
400 (before-grace-spacing-factor . 1.2)
401 (before-musical-spacing-factor . 0.4)
402 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
405 (molecule-callback . ,Slur::brew_molecule)
407 (spacing-procedure . ,Spanner::set_spacing_rods)
408 (minimum-length . 1.5)
409 (after-line-breaking-callback . ,Slur::after_line_breaking)
410 (extremity-rules . ,default-slur-extremity-rules)
411 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
412 (de-uglify-parameters . ( 1.5 0.8 -2.0))
413 (Y-extent-callback . ,Slur::height)
414 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
415 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
416 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
417 (bezier-area-steps . 1.0)))
420 (attachment . (#f . #f))
421 (attachment-offset . ((0 . 0) . (0 . 0)))
423 (meta . ,(grob-description "PhrasingSlur" slur-interface))
426 (NonMusicalPaperColumn . (
428 (before-musical-spacing-factor . 1.0)
429 (column-space-strength . 2.0)
430 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
434 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
435 (molecule-callback . ,Multi_measure_rest::percent)
438 (minimum-width . 12.5) ; staffspace
439 (font-family . music)
440 (meta . ,(grob-description "PercentRepeat" multi-measure-rest-interface font-interface percent-repeat-interface))
445 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
448 (meta . ,(grob-description "RepeatSlash" percent-repeat-interface))
451 (after-line-breaking-callback . ,Rest::after_line_breaking)
452 (X-extent-callback . ,Rest::extent_callback)
453 (Y-extent-callback . ,Rest::extent_callback)
454 (molecule-callback . ,Rest::brew_molecule)
455 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
456 (minimum-beam-collision-distance . 1.5)
457 (meta . ,(grob-description "Rest"
458 rhythmic-head-interface
459 staff-symbol-referencer-interface
463 (minimum-distance . 0.75)
464 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
468 ;; don't set direction here: it breaks staccato.
469 (molecule-callback . ,Script::brew_molecule)
471 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
472 (before-line-breaking-callback . ,Script::before_line_breaking)
473 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
477 (before-line-breaking-callback . ,Script_column::before_line_breaking)
478 (meta . ,(grob-description "ScriptColumn" script-column-interface))
482 (molecule-callback . ,Slur::brew_molecule)
484 (spacing-procedure . ,Spanner::set_spacing_rods)
485 (minimum-length . 1.5)
486 (after-line-breaking-callback . ,Slur::after_line_breaking)
487 (extremity-rules . ,default-slur-extremity-rules)
488 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
489 (de-uglify-parameters . ( 1.5 0.8 -2.0))
490 (Y-extent-callback . ,Slur::height)
491 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
492 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
493 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
494 (bezier-area-steps . 1.0)))
497 (attachment . (#f . #f))
498 (attachment-offset . ((0 . 0) . (0 . 0)))
500 (meta . ,(grob-description "Slur" slur-interface))
504 (spacing-procedure . ,New_spacing_spanner::set_springs)
505 (stem-spacing-correction . 0.5)
506 (grace-space-factor . 0.8)
508 ;; TODO: change naming -- unintuitive
509 (arithmetic-basicspace . 2.0)
510 (arithmetic-multiplier . ,(* 0.9 1.32))
511 ;; assume that notes at least this long are present.
512 (maximum-duration-for-spacing . ,(make-moment 1 8))
513 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
516 (break-align-symbol . Staff_bar)
517 (bar-size-procedure . ,Span_bar::get_bar_size)
518 (molecule-callback . ,Span_bar::brew_molecule)
519 (visibility-lambda . ,begin-of-line-invisible)
520 (X-extent-callback . ,Span_bar::width_callback)
523 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
527 ;; Ross. page 151 lists other values, we opt for a leaner look
531 (hair-thickness . 1.6)
532 (thick-thickness . 6.0)
533 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
538 (molecule-callback . ,Text_item::brew_molecule)
539 (break-align-symbol . Clef_item)
540 (visibility-lambda . ,begin-of-line-visible)
541 (font-family . roman)
542 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
546 (molecule-callback . ,Staff_symbol::brew_molecule)
550 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
553 (molecule-callback . ,Text_item::brew_molecule)
555 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
556 (Y-offset-callbacks .
557 (,Side_position_interface::aligned_side
558 ,Side_position_interface::centered_on_parent))
559 (no-spacing-rods . #t)
560 (font-shape . italic)
561 (self-alignment-X . 0)
562 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
566 (before-line-breaking-callback . ,Stem::before_line_breaking)
567 (molecule-callback . ,Stem::brew_molecule)
569 (beamed-lengths . (0.0 2.5 2.0 1.5))
570 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
572 ;; Stems in unnatural (forced) direction should be shortened,
573 ;; according to [Roush & Gourlay]. Their suggestion to knock off
574 ;; a whole staffspace seems a bit drastical: we'll do half.
576 (lengths . (3.5 3.5 3.5 4.5 5.0))
577 (stem-shorten . (0.5))
578 ; if stem is on middle line, choose this direction.
579 (neutral-direction . -1)
580 (X-offset-callbacks . (,Stem::off_callback))
581 (X-extent-callback . ,Stem::dim_callback)
582 (Y-extent-callback . ,Stem::height)
583 (meta . ,(grob-description "Stem" stem-interface font-interface))
587 (molecule-callback . ,Stem_tremolo::brew_molecule)
588 (Y-extent-callback . ,Stem_tremolo::height)
589 (X-extent-callback . #f)
591 (beam-width . 2.0) ; staff-space
592 (beam-thickness . 0.42) ; staff-space
593 (beam-space-function . ,default-beam-space-function)
594 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
598 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
600 (SeparatingGroupSpanner . (
601 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
602 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
606 (no-spacing-rods . #t)
607 (molecule-callback . ,Sustain_pedal::brew_molecule)
608 (self-alignment-X . 0)
610 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
611 (Y-offset-callbacks .
612 (,Side_position_interface::aligned_side
613 ,Side_position_interface::centered_on_parent))
615 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
618 ;; TODO: should split in 3
619 (SystemStartDelimiter . (
620 (molecule-callback . ,System_start_delimiter::brew_molecule)
621 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
622 ;; really 4.0, but 5 to be on safe side.
623 (brace-collapse-height . 5.0)
624 (bracket-collapse-height . 1)
631 (bracket-thick . 0.25)
632 (Y-extent-callback . #f)
633 (font-family . braces)
634 ;; if you want to set point-size, you cannot set
635 ;; relative-size, as no font will be found for other
637 ;;(font-design-size . 20)
638 ;;(font-relative-size . #f)
639 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
643 (molecule-callback . ,Text_item::brew_molecule)
644 (no-spacing-rods . #t)
647 ;; todo: add X self alignment?
649 (font-family . roman)
650 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
653 (molecule-callback . ,Text_spanner::brew_molecule)
654 (font-family . roman)
657 ;; urg, only for (de)cresc. text spanners
658 (if-text-padding . 1.0)
662 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
665 (molecule-callback . ,Tie::brew_molecule)
666 (spacing-procedure . ,Spanner::set_spacing_rods)
667 (staffline-clearance . 0.35)
668 (details . ((ratio . 0.333) (height-limit . 1.0)))
672 (minimum-length . 2.5)
673 (meta . ,(grob-description "Tie" tie-interface ))
677 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
678 (meta . ,(grob-description "TieColumn" tie-column-interface ))
682 (molecule-callback . ,Time_signature::brew_molecule)
683 (break-align-symbol . Time_signature)
684 (visibility-lambda . ,all-visible)
687 (font-family . number)
688 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
695 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
696 (molecule-callback . ,Tuplet_bracket::brew_molecule)
697 (font-family . roman)
698 (font-shape . italic)
699 (font-relative-size . -1)
700 (meta . ,(grob-description "TupletBracket" text-interface
701 tuplet-bracket-interface font-interface))
705 (molecule-callback . ,Text_item::brew_molecule)
706 (font-family . roman)
707 (font-shape . italic)
708 (no-spacing-rods . #t)
709 (self-alignment-X . 0)
711 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
712 (Y-offset-callbacks .
713 (,Side_position_interface::aligned_side
714 ,Side_position_interface::centered_on_parent))
715 (meta . ,(grob-description "UnaCordaPedal" text-interface font-interface))
719 (molecule-callback . ,Volta_spanner::brew_molecule)
724 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
725 (thickness . 1.6) ; stafflinethickness
726 (height . 2.0) ; staffspace;
728 (font-family . number)
729 (font-relative-size . -2)
730 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
733 (VerticalAlignment . (
735 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
736 (X-extent-callback . #f)
739 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
742 (VerticalAxisGroup . (
744 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
750 ; (display (map pair? all-grob-descriptions))