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 . ,Text_item::brew_molecule)
120 (font-family . music)
121 (text . "scripts-rcomma")
122 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
123 (visibility-lambda . ,begin-of-line-invisible)
124 (meta . ,(grob-description "BreathingSign" break-aligned-interface text-interface font-interface))
128 (molecule-callback . ,Clef::brew_molecule)
129 (before-line-breaking-callback . ,Clef::before_line_breaking)
131 (font-family . music)
132 (break-align-symbol . Clef_item)
133 (visibility-lambda . ,begin-of-line-visible)
134 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
135 (meta . ,(grob-description "Clef" clef-interface font-interface break-aligned-interface ))
139 (molecule-callback . ,Chord_name::brew_molecule)
140 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
141 (chord-name-function . ,default-chord-name-function)
142 (font-family . roman)
143 (meta . ,(grob-description "ChordName" font-interface text-interface chord-name-interface))
147 (break-align-symbol . Custos)
149 (molecule-callback . ,Custos::brew_molecule)
150 (visibility-lambda . ,end-of-line-visible)
152 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
153 (meta . ,(grob-description "Custos" custos-interface staff-symbol-referencer-interface break-aligned-interface) )
160 (X-extent-callback . ,Axis_group_interface::group_extent_callback)
162 (X-offset-callbacks . (,Dot_column::side_position))
163 (meta . ,(grob-description "DotColumn" dot-column-interface axis-group-interface))
167 (molecule-callback . ,Dots::brew_molecule)
169 (staff-position . 0.0)
170 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
171 (meta . ,(grob-description "Dots" font-interface dots-interface ))
174 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
177 (font-family . music)
180 (break-align-symbol . Staff_bar)
181 (visibility-lambda . ,begin-of-line-invisible)
182 (meta . ,(grob-description "DoublePercentRepeat" font-interface percent-repeat-interface))
186 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
187 (molecule-callback . ,Text_item::brew_molecule)
188 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
189 (self-alignment-X . 0)
191 (no-spacing-rods . #t)
192 (script-priority . 100)
194 (font-family . dynamic)
195 (font-shape . italic)
196 (self-alignment-Y . 0)
197 (meta . ,(grob-description "DynamicText" font-interface text-interface dynamic-interface))
200 (DynamicLineSpanner . (
203 (minimum-space . 1.2)
205 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
209 (break-align-symbol . Left_edge_item)
210 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
212 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
216 (molecule-callback . ,Text_item::brew_molecule)
217 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
220 (self-alignment-X . 0)
221 (font-family . number)
222 (font-relative-size . -3)
223 (font-shape . upright)
224 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
229 (horizontal-space . 1.2)
231 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
232 (meta . ,(grob-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
235 (HaraKiriVerticalGroup . (
236 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
237 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
239 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
242 (molecule-callback . ,Hairpin::brew_molecule)
245 (spacing-procedure . ,Spanner::set_spacing_rods)
246 (minimum-length . 2.0)
247 (if-text-padding . 1.0)
248 (width-correct . -1.0)
250 (dash-thickness . 1.2)
252 (self-alignment-Y . 0)
253 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
254 (meta . ,(grob-description "Hairpin" hairpin-interface dynamic-interface))
259 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
260 ,Side_position_interface::aligned_on_support_refpoints
263 (self-alignment-Y . 0)
264 (molecule-callback . ,Text_item::brew_molecule)
265 (break-align-symbol . Instrument_name)
266 (visibility-lambda . ,begin-of-line-visible)
268 (font-family . roman)
269 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
273 (molecule-callback . ,Key_item::brew_molecule)
274 (break-align-symbol . Key_item)
275 (visibility-lambda . ,begin-of-line-visible)
277 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
284 (minimum-length . 0.5)
285 (maximum-length . 100)
286 (molecule-callback . ,Hyphen_spanner::brew_molecule)
287 (Y-extent-callback . ,Grob::point_dimension_callback)
288 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
293 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
297 (molecule-callback . ,Lyric_extender::brew_molecule)
298 (height . 0.8) ; stafflinethickness;
299 (right-trim-amount . 0.5)
300 (Y-extent-callback . ,Grob::point_dimension_callback)
301 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
305 (molecule-callback . ,Text_item::brew_molecule)
306 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
307 (self-alignment-X . 0)
310 (ignore-length-mismatch . #f)
311 (begin-alignment . 4)
313 (font-family . roman)
314 (font-shape . upright)
315 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
319 (molecule-callback . ,Text_item::brew_molecule)
320 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
321 (self-alignment-X . 0)
325 (font-family . roman)
326 (font-shape . upright)
327 (font-relative-size . 1)
328 (visibility-lambda . ,end-of-line-invisible)
330 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
333 (MultiMeasureRest . (
334 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
335 (molecule-callback . ,Multi_measure_rest::brew_molecule)
336 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
339 (padding . 2.0) ; staffspace
340 (minimum-width . 12.5) ; staffspace
341 (font-family . number)
342 (font-relative-size . 1)
343 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface rest-interface font-interface ))
347 ;; Ugh, should not be hard-coded.
349 (meta . ,(grob-description "NoteCollision"
350 note-collision-interface axis-group-interface
356 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
361 (molecule-callback . ,Note_head::brew_molecule)
362 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
363 (stem-attachment-function
364 . ,note-head-style->attachment-coordinates)
365 (meta . ,(grob-description "NoteHead"
366 rhythmic-head-interface font-interface
367 note-head-interface ))
373 (X-extent-callback . #f)
374 (Y-extent-callback . #f)
375 (molecule-callback . ,Line_spanner::brew_molecule)
376 (meta . ,(grob-description "Glissando"
377 line-spanner-interface))
383 (X-extent-callback . #f)
384 (Y-extent-callback . #f)
385 (molecule-callback . ,Line_spanner::brew_molecule)
386 (meta . ,(grob-description "VoiceFollower"
387 line-spanner-interface))
391 (molecule-callback . ,Text_item::brew_molecule)
392 (font-family . roman)
393 (meta . ,(grob-description "NoteName"
394 note-name-interface font-interface
399 (self-alignment-X . 0)
401 (visibility-lambda . ,begin-of-line-visible)
402 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
403 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
404 (molecule-callback . ,Text_item::brew_molecule)
405 (font-shape . italic)
406 (font-family . roman)
407 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
412 (before-grace-spacing-factor . 1.2)
413 (before-musical-spacing-factor . 0.4)
414 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
417 (molecule-callback . ,Slur::brew_molecule)
419 (spacing-procedure . ,Spanner::set_spacing_rods)
420 (minimum-length . 1.5)
421 (after-line-breaking-callback . ,Slur::after_line_breaking)
422 (extremity-rules . ,default-slur-extremity-rules)
423 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
424 (de-uglify-parameters . ( 1.5 0.8 -2.0))
425 (Y-extent-callback . ,Slur::height)
426 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
427 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
428 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
429 (bezier-area-steps . 1.0)))
432 (attachment . (#f . #f))
433 (attachment-offset . ((0 . 0) . (0 . 0)))
435 (meta . ,(grob-description "PhrasingSlur" slur-interface))
438 (NonMusicalPaperColumn . (
440 (before-musical-spacing-factor . 1.0)
441 (column-space-strength . 2.0)
442 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
446 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
447 (molecule-callback . ,Multi_measure_rest::percent)
450 (minimum-width . 12.5) ; staffspace
451 (font-family . music)
452 (meta . ,(grob-description "PercentRepeat" multi-measure-rest-interface font-interface percent-repeat-interface))
457 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
460 (meta . ,(grob-description "RepeatSlash" percent-repeat-interface))
463 (after-line-breaking-callback . ,Rest::after_line_breaking)
464 (X-extent-callback . ,Rest::extent_callback)
465 (Y-extent-callback . ,Rest::extent_callback)
466 (molecule-callback . ,Rest::brew_molecule)
467 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
468 (minimum-beam-collision-distance . 1.5)
469 (meta . ,(grob-description "Rest"
470 rhythmic-head-interface
471 staff-symbol-referencer-interface
475 (minimum-distance . 0.75)
476 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
480 ;; don't set direction here: it breaks staccato.
481 (molecule-callback . ,Script::brew_molecule)
483 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
484 (before-line-breaking-callback . ,Script::before_line_breaking)
485 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
489 (before-line-breaking-callback . ,Script_column::before_line_breaking)
490 (meta . ,(grob-description "ScriptColumn" script-column-interface))
494 (molecule-callback . ,Slur::brew_molecule)
496 (spacing-procedure . ,Spanner::set_spacing_rods)
497 (minimum-length . 1.5)
498 (after-line-breaking-callback . ,Slur::after_line_breaking)
499 (extremity-rules . ,default-slur-extremity-rules)
500 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
501 (de-uglify-parameters . ( 1.5 0.8 -2.0))
502 (Y-extent-callback . ,Slur::height)
503 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
504 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
505 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
506 (bezier-area-steps . 1.0)))
509 (attachment . (#f . #f))
510 (attachment-offset . ((0 . 0) . (0 . 0)))
512 (meta . ,(grob-description "Slur" slur-interface))
516 (spacing-procedure . ,Spacing_spanner::set_springs)
517 (stem-spacing-correction . 0.5)
518 (arithmetic-basicspace . 2.0)
519 (arithmetic-multiplier . ,(* 0.9 1.32))
520 ;; assume that notes at least this long are present.
521 (maximum-duration-for-spacing . ,(make-moment 1 8))
522 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
525 (break-align-symbol . Staff_bar)
526 (bar-size-procedure . ,Span_bar::get_bar_size)
527 (molecule-callback . ,Span_bar::brew_molecule)
528 (visibility-lambda . ,begin-of-line-invisible)
529 (X-extent-callback . ,Span_bar::width_callback)
530 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
534 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
538 ;; Ross. page 151 lists other values, we opt for a leaner look
542 (hair-thickness . 1.6)
543 (thick-thickness . 6.0)
544 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
549 (molecule-callback . ,Text_item::brew_molecule)
550 (break-align-symbol . Clef_item)
551 (visibility-lambda . ,begin-of-line-visible)
552 (font-family . roman)
553 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
557 (molecule-callback . ,Staff_symbol::brew_molecule)
561 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
564 (molecule-callback . ,Text_item::brew_molecule)
566 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
567 (Y-offset-callbacks .
568 (,Side_position_interface::aligned_side
569 ,Side_position_interface::centered_on_parent))
570 (no-spacing-rods . #t)
571 (font-shape . italic)
572 (self-alignment-X . 0)
573 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
577 (before-line-breaking-callback . ,Stem::before_line_breaking)
578 (molecule-callback . ,Stem::brew_molecule)
580 (beamed-lengths . (0.0 2.5 2.0 1.5))
581 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
583 ;; Stems in unnatural (forced) direction should be shortened,
584 ;; according to [Roush & Gourlay]. Their suggestion to knock off
585 ;; a whole staffspace seems a bit drastical: we'll do half.
587 (lengths . (3.5 3.5 3.5 4.5 5.0))
588 (stem-shorten . (0.5))
589 ; if stem is on middle line, choose this direction.
590 (neutral-direction . -1)
591 (X-offset-callbacks . (,Stem::off_callback))
592 (X-extent-callback . ,Stem::dim_callback)
593 (Y-extent-callback . ,Stem::height)
594 (meta . ,(grob-description "Stem" stem-interface font-interface))
598 (molecule-callback . ,Stem_tremolo::brew_molecule)
599 (Y-extent-callback . ,Stem_tremolo::height)
600 (X-extent-callback . #f)
602 (beam-width . 2.0) ; staff-space
603 (beam-thickness . 0.42) ; staff-space
604 (beam-space-function . ,default-beam-space-function)
605 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
609 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
611 (SeparatingGroupSpanner . (
612 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
613 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
617 (no-spacing-rods . #t)
618 (molecule-callback . ,Sustain_pedal::brew_molecule)
619 (self-alignment-X . 0)
621 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
622 (Y-offset-callbacks .
623 (,Side_position_interface::aligned_side
624 ,Side_position_interface::centered_on_parent))
626 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
629 ;; TODO: should split in 3
630 (SystemStartDelimiter . (
631 (molecule-callback . ,System_start_delimiter::brew_molecule)
632 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
633 ;; really 4.0, but 5 to be on safe side.
634 (brace-collapse-height . 5.0)
635 (bracket-collapse-height . 1)
642 (bracket-thick . 0.25)
643 (Y-extent-callback . #f)
644 (font-family . braces)
645 ;; if you want to set point-size, you cannot set
646 ;; relative-size, as no font will be found for other
648 ;;(font-design-size . 20)
649 ;;(font-relative-size . #f)
650 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
654 (molecule-callback . ,Text_item::brew_molecule)
655 (no-spacing-rods . #t)
658 ;; todo: add X self alignment?
660 (font-family . roman)
661 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
664 (molecule-callback . ,Text_spanner::brew_molecule)
665 (font-family . roman)
668 ;; urg, only for (de)cresc. text spanners
669 (if-text-padding . 1.0)
673 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
676 (molecule-callback . ,Tie::brew_molecule)
677 (spacing-procedure . ,Spanner::set_spacing_rods)
678 (staffline-clearance . 0.35)
679 (details . ((ratio . 0.333) (height-limit . 1.0)))
683 (minimum-length . 2.5)
684 (meta . ,(grob-description "Tie" tie-interface ))
688 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
689 (meta . ,(grob-description "TieColumn" tie-column-interface ))
693 (molecule-callback . ,Time_signature::brew_molecule)
694 (break-align-symbol . Time_signature)
695 (visibility-lambda . ,all-visible)
698 (font-family . number)
699 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
706 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
707 (molecule-callback . ,Tuplet_bracket::brew_molecule)
708 (font-family . roman)
709 (font-shape . italic)
710 (font-relative-size . -1)
711 (meta . ,(grob-description "TupletBracket" text-interface
712 tuplet-bracket-interface font-interface))
716 (molecule-callback . ,Text_item::brew_molecule)
717 (font-family . roman)
718 (font-shape . italic)
719 (no-spacing-rods . #t)
720 (self-alignment-X . 0)
722 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
723 (Y-offset-callbacks .
724 (,Side_position_interface::aligned_side
725 ,Side_position_interface::centered_on_parent))
726 (meta . ,(grob-description "UnaCordaPedal" text-interface font-interface))
730 (molecule-callback . ,Volta_spanner::brew_molecule)
735 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
736 (thickness . 1.6) ; stafflinethickness
737 (height . 2.0) ; staffspace;
739 (font-family . number)
740 (font-relative-size . -2)
741 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
744 (VerticalAlignment . (
746 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
747 (X-extent-callback . #f)
750 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
753 (VerticalAxisGroup . (
755 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
761 ; (display (map pair? all-grob-descriptions))