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 (barsize-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 (default-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) )
156 (meta . ,(grob-description "DotColumn" dot-column-interface axis-group-interface))
160 (molecule-callback . ,Dots::brew_molecule)
162 (staff-position . 0.0)
163 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
164 (meta . ,(grob-description "Dots" font-interface dots-interface ))
167 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
170 (font-family . music)
173 (break-align-symbol . Staff_bar)
174 (visibility-lambda . ,begin-of-line-invisible)
175 (meta . ,(grob-description "DoublePercentRepeat" font-interface percent-repeat-interface))
179 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
180 (molecule-callback . ,Text_item::brew_molecule)
181 (script-priority . 100)
183 (font-family . dynamic)
184 (font-shape . italic)
185 (self-alignment-Y . 0)
186 (meta . ,(grob-description "DynamicText" font-interface text-interface dynamic-interface))
189 (DynamicLineSpanner . (
192 (minimum-space . 1.2)
194 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
198 (break-align-symbol . Left_edge_item)
199 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
201 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
205 (molecule-callback . ,Text_item::brew_molecule)
206 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
209 (self-alignment-X . 0)
210 (font-family . number)
211 (font-relative-size . -3)
212 (font-shape . upright)
213 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
218 (horizontal-space . 1.2)
220 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
221 (meta . ,(grob-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
224 (HaraKiriVerticalGroup . (
225 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
226 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
228 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
231 (molecule-callback . ,Hairpin::brew_molecule)
234 (spacing-procedure . ,Spanner::set_spacing_rods)
235 (minimum-length . 2.0)
236 (if-text-padding . 1.0)
237 (width-correct . -1.0)
239 (dash-thickness . 1.2)
241 (self-alignment-Y . 0)
242 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
243 (meta . ,(grob-description "Hairpin" hairpin-interface dynamic-interface))
248 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
249 ,Side_position_interface::aligned_on_support_refpoints
252 (self-alignment-Y . 0)
253 (molecule-callback . ,Text_item::brew_molecule)
254 (break-align-symbol . Instrument_name)
255 (visibility-lambda . ,begin-of-line-visible)
257 (font-family . roman)
258 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
262 (molecule-callback . ,Key_item::brew_molecule)
263 (break-align-symbol . Key_item)
264 (visibility-lambda . ,begin-of-line-visible)
266 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
273 (minimum-length . 0.5)
274 (molecule-callback . ,Hyphen_spanner::brew_molecule)
275 (Y-extent-callback . ,Grob::point_dimension_callback)
276 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
281 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
285 (molecule-callback . ,Lyric_extender::brew_molecule)
286 (height . 0.8) ; stafflinethickness;
287 (right-trim-amount . 0.5)
288 (Y-extent-callback . ,Grob::point_dimension_callback)
289 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
293 (molecule-callback . ,Text_item::brew_molecule)
294 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
295 (self-alignment-X . 0)
298 (font-family . roman)
299 (font-shape . upright)
300 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
304 (molecule-callback . ,Text_item::brew_molecule)
305 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
306 (self-alignment-X . 0)
310 (font-family . number)
311 (font-shape . upright)
312 (font-relative-size . 1)
313 (visibility-lambda . ,end-of-line-invisible)
315 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
318 (MultiMeasureRest . (
319 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
320 (molecule-callback . ,Multi_measure_rest::brew_molecule)
321 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
324 (padding . 2.0) ; staffspace
325 (minimum-width . 12.5) ; staffspace
326 (font-family . number)
327 (font-relative-size . 1)
328 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface rest-interface font-interface ))
333 (meta . ,(grob-description "NoteCollision"
334 note-collision-interface axis-group-interface
340 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
345 (molecule-callback . ,Note_head::brew_molecule)
346 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
347 (attachment-angle . ,(* 20/360 3.14159))
348 (meta . ,(grob-description "NoteHead"
349 rhythmic-head-interface font-interface
350 note-head-interface ))
356 (X-extent-callback . #f)
357 (Y-extent-callback . #f)
358 (molecule-callback . ,Line_spanner::brew_molecule)
359 (meta . ,(grob-description "Glissando"
360 line-spanner-interface))
366 (X-extent-callback . #f)
367 (Y-extent-callback . #f)
368 (molecule-callback . ,Line_spanner::brew_molecule)
369 (meta . ,(grob-description "VoiceFollower"
370 line-spanner-interface))
374 (molecule-callback . ,Text_item::brew_molecule)
375 (font-family . roman)
376 (meta . ,(grob-description "NoteName"
377 note-name-interface font-interface
382 (self-alignment-X . 0)
384 (visibility-lambda . ,begin-of-line-visible)
385 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
386 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
387 (molecule-callback . ,Text_item::brew_molecule)
388 (font-shape . italic)
389 (font-family . roman)
390 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
395 (before-grace-spacing-factor . 1.2)
396 (before-musical-spacing-factor . 0.4)
397 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
400 (molecule-callback . ,Slur::brew_molecule)
402 (spacing-procedure . ,Spanner::set_spacing_rods)
403 (minimum-length . 1.5)
404 (after-line-breaking-callback . ,Slur::after_line_breaking)
405 (extremity-rules . ,default-slur-extremity-rules)
406 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
407 (de-uglify-parameters . ( 1.5 0.8 -2.0))
408 (Y-extent-callback . ,Slur::height)
409 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
410 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
411 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
412 (bezier-area-steps . 1.0)))
415 (attachment . (#f . #f))
416 (attachment-offset . ((0 . 0) . (0 . 0)))
418 (meta . ,(grob-description "PhrasingSlur" slur-interface))
421 (NonMusicalPaperColumn . (
423 (before-musical-spacing-factor . 1.0)
424 (column-space-strength . 2.0)
425 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
429 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
430 (molecule-callback . ,Multi_measure_rest::percent)
433 (minimum-width . 12.5) ; staffspace
434 (font-family . music)
435 (meta . ,(grob-description "PercentRepeat" multi-measure-rest-interface font-interface percent-repeat-interface))
440 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
443 (meta . ,(grob-description "RepeatSlash" percent-repeat-interface))
446 (after-line-breaking-callback . ,Rest::after_line_breaking)
447 (X-extent-callback . ,Rest::extent_callback)
448 (Y-extent-callback . ,Rest::extent_callback)
449 (molecule-callback . ,Rest::brew_molecule)
450 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
451 (minimum-beam-collision-distance . 1.5)
452 (meta . ,(grob-description "Rest"
453 rhythmic-head-interface
454 staff-symbol-referencer-interface
458 (minimum-distance . 0.75)
459 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
463 ;; don't set direction here: it breaks staccato.
464 (molecule-callback . ,Script::brew_molecule)
465 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
466 (before-line-breaking-callback . ,Script::before_line_breaking)
467 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
471 (before-line-breaking-callback . ,Script_column::before_line_breaking)
472 (meta . ,(grob-description "ScriptColumn" script-column-interface))
476 (molecule-callback . ,Slur::brew_molecule)
478 (spacing-procedure . ,Spanner::set_spacing_rods)
479 (minimum-length . 1.5)
480 (after-line-breaking-callback . ,Slur::after_line_breaking)
481 (extremity-rules . ,default-slur-extremity-rules)
482 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
483 (de-uglify-parameters . ( 1.5 0.8 -2.0))
484 (Y-extent-callback . ,Slur::height)
485 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
486 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
487 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
488 (bezier-area-steps . 1.0)))
491 (attachment . (#f . #f))
492 (attachment-offset . ((0 . 0) . (0 . 0)))
494 (meta . ,(grob-description "Slur" slur-interface))
498 (spacing-procedure . ,Spacing_spanner::set_springs)
499 (stem-spacing-correction . 0.5)
500 (arithmetic-basicspace . 2.0)
501 (arithmetic-multiplier . ,(* 0.9 1.32))
502 ;; assume that notes at least this long are present.
503 (maximum-duration-for-spacing . ,(make-moment 1 8))
504 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
507 (break-align-symbol . Staff_bar)
508 (barsize-procedure . ,Span_bar::get_bar_size)
509 (molecule-callback . ,Bar::brew_molecule)
510 (visibility-lambda . ,begin-of-line-invisible)
511 (X-extent-callback . ,Span_bar::width_callback)
512 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
516 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
520 ;; Ross. page 151 lists other values, we opt for a leaner look
524 (hair-thickness . 1.6)
525 (thick-thickness . 6.0)
526 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
531 (molecule-callback . ,Text_item::brew_molecule)
532 (break-align-symbol . Clef_item)
533 (visibility-lambda . ,begin-of-line-visible)
534 (font-family . roman)
535 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
539 (molecule-callback . ,Staff_symbol::brew_molecule)
543 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
546 (molecule-callback . ,Text_item::brew_molecule)
548 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
549 (Y-offset-callbacks .
550 (,Side_position_interface::aligned_side
551 ,Side_position_interface::centered_on_parent))
552 (no-spacing-rods . #t)
553 (font-shape . italic)
554 (self-alignment-X . 0)
555 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
559 (before-line-breaking-callback . ,Stem::before_line_breaking)
560 (molecule-callback . ,Stem::brew_molecule)
562 (beamed-lengths . (0.0 2.5 2.0 1.5))
563 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
565 ;; Stems in unnatural (forced) direction should be shortened,
566 ;; according to [Roush & Gourlay]. Their suggestion to knock off
567 ;; a whole staffspace seems a bit drastical: we'll do half.
569 (lengths . (3.5 3.5 3.5 4.5 5.0))
570 (stem-shorten . (0.5))
571 ; if stem is on middle line, choose this direction.
572 (default-neutral-direction . 1)
573 (X-offset-callbacks . (,Stem::off_callback))
574 (X-extent-callback . ,Stem::dim_callback)
575 (Y-extent-callback . ,Stem::height)
576 (meta . ,(grob-description "Stem" stem-interface font-interface))
580 (molecule-callback . ,Stem_tremolo::brew_molecule)
581 (Y-extent-callback . ,Stem_tremolo::height)
582 (X-extent-callback . #f)
584 (beam-width . 2.0) ; staff-space
585 (beam-thickness . 0.42) ; staff-space
586 (beam-space-function . ,default-beam-space-function)
587 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
591 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
593 (SeparatingGroupSpanner . (
594 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
595 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
599 (no-spacing-rods . #t)
600 (molecule-callback . ,Sustain_pedal::brew_molecule)
601 (self-alignment-X . 0)
603 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
604 (Y-offset-callbacks .
605 (,Side_position_interface::aligned_side
606 ,Side_position_interface::centered_on_parent))
608 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
612 (SystemStartDelimiter . (
613 (molecule-callback . ,System_start_delimiter::brew_molecule)
614 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
615 ;; ugh, in practice, brace has height of 4.1 staff-spaces
616 (brace-collapse-height . 4.1)
617 (bracket-collapse-height . 1)
624 (bracket-thick . 0.25)
625 (Y-extent-callback . #f)
626 (font-family . braces)
627 ;; if you want to set point-size, you cannot set
628 ;; relative-size, as no font will be found for other
630 ;;(font-design-size . 20)
631 ;;(font-relative-size . #f)
632 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
636 (molecule-callback . ,Text_item::brew_molecule)
637 (no-spacing-rods . #t)
641 (font-family . roman)
642 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
645 (molecule-callback . ,Text_spanner::brew_molecule)
646 (font-family . roman)
649 ;; urg, only for (de)cresc. text spanners
650 (if-text-padding . 1.0)
654 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
657 (molecule-callback . ,Tie::brew_molecule)
658 (spacing-procedure . ,Spanner::set_spacing_rods)
659 (staffline-clearance . 0.35)
660 (details . ((ratio . 0.333) (height-limit . 1.0)))
663 (minimum-length . 2.5)
664 (meta . ,(grob-description "Tie" tie-interface ))
668 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
669 (meta . ,(grob-description "TieColumn" tie-column-interface ))
673 (molecule-callback . ,Time_signature::brew_molecule)
674 (break-align-symbol . Time_signature)
675 (visibility-lambda . ,all-visible)
677 (font-family . number)
678 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
685 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
686 (molecule-callback . ,Tuplet_bracket::brew_molecule)
687 (font-family . roman)
688 (font-shape . italic)
689 (font-relative-size . -1)
690 (meta . ,(grob-description "TupletBracket" text-interface
691 tuplet-bracket-interface font-interface))
695 (molecule-callback . ,Text_item::brew_molecule)
696 (font-shape . italic)
697 (no-spacing-rods . #t)
698 (self-alignment-X . 0)
700 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
701 (Y-offset-callbacks .
702 (,Side_position_interface::aligned_side
703 ,Side_position_interface::centered_on_parent))
704 (meta . ,(grob-description "UnaChordaPedal" text-interface font-interface))
708 (molecule-callback . ,Volta_spanner::brew_molecule)
713 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
714 (thickness . 1.6) ; stafflinethickness
715 (height . 2.0) ; staffspace;
717 (font-family . number)
718 (font-relative-size . -2)
719 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
722 (VerticalAlignment . (
724 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
725 (X-extent-callback . #f)
727 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
730 (VerticalAxisGroup . (
732 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
738 ; (display (map pair? all-grob-descriptions))