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 default-alteration-alist
13 (0 . ((raise . 0.5) (music "accidentals-0")))
14 (-1 . ((raise . 0.5) (music "accidentals--1")))
15 (-2 . ((raise . 0.5) (music "accidentals--2")))
16 (1 . ((raise . 0.5) (music "accidentals-1")))
17 (2 . ((raise . 0.5) (music "accidentals-2")))
21 (define all-grob-descriptions
24 (molecule-callback . ,Local_key_item::brew_molecule)
25 (X-offset-callbacks . (,Side_position_interface::aligned_side))
26 (after-line-breaking-callback . ,Local_key_item::after_line_breaking)
30 (meta . ,(grob-description "Accidentals" accidentals-interface font-interface side-position-interface))
34 (X-extent-callback . ,Arpeggio::width_callback)
35 (Y-extent-callback . #f)
36 (molecule-callback . ,Arpeggio::brew_molecule)
37 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
38 (X-offset-callbacks . (,Side_position_interface::aligned_side))
40 (staff-position . 0.0)
41 (meta . ,(grob-description "Arpeggio" arpeggio-interface side-position-interface font-interface))
44 (autoBeamSettings . ,auto-beam-settings)
47 (break-align-symbol . Staff_bar)
49 (break-glyph-function . ,default-break-barline)
50 (bar-size-procedure . ,Bar::get_staff_bar_size)
51 (molecule-callback . ,Bar::brew_molecule)
52 (visibility-lambda . ,all-visible)
54 (before-line-breaking-callback . ,Bar::before_line_breaking)
56 ;; Ross. page 151 lists other values, we opt for a leaner look
60 (hair-thickness . 1.6)
61 (thick-thickness . 6.0)
62 (meta . ,(grob-description "BarLine" bar-line-interface font-interface))
66 (molecule-callback . ,Text_item::brew_molecule)
68 (visibility-lambda . ,begin-of-line-visible)
72 (font-relative-size . -1)
73 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
74 (meta . ,(grob-description "BarNumber"
75 side-position-interface
76 text-interface font-interface break-aligned-interface))
80 (molecule-callback . ,Text_item::brew_molecule)
81 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
83 (accidental-alist . ,default-alteration-alist)
84 (font-family . number)
85 (font-relative-size . -1)
86 (meta . ,(grob-description "BassFigure" text-interface font-interface ))
89 ;; todo: clean this up a bit: the list is getting
91 (molecule-callback . ,Beam::brew_molecule)
92 (y-dy-callbacks . (,Beam::least_squares
93 ,Beam::cancel_suspect_slope
97 ,Beam::do_quantise_y))
99 (thickness . 0.48) ; in staff-space
100 (before-line-breaking-callback . ,Beam::before_line_breaking)
101 (after-line-breaking-callback . ,Beam::after_line_breaking)
102 (neutral-direction . -1)
103 (dir-function . ,beam-dir-majority)
104 (height-quants . ,default-beam-dy-quants)
105 (vertical-position-quant-function . ,default-beam-y-quants)
106 (beamed-stem-shorten . (0.5))
107 (outer-stem-length-limit . 0.2)
109 (flag-width-function . ,default-beam-flag-width-function)
110 (space-function . ,default-beam-space-function)
113 (meta . ,(grob-description "Beam" beam-interface))
120 (space-alist . ,default-break-align-space-alist)
121 (meta . ,(grob-description "BreakAlignment"
122 axis-group-interface align-interface
129 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
131 (meta . ,(grob-description "BreakAlignGroup" axis-group-interface))
135 (break-align-symbol . Breathing_sign)
137 (molecule-callback . ,Breathing_sign::brew_molecule)
138 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
139 (visibility-lambda . ,begin-of-line-invisible)
140 (meta . ,(grob-description "BreathingSign" break-aligned-interface))
144 (molecule-callback . ,Clef::brew_molecule)
145 (before-line-breaking-callback . ,Clef::before_line_breaking)
147 (font-family . music)
148 (break-align-symbol . Clef_item)
149 (visibility-lambda . ,begin-of-line-visible)
150 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
151 (meta . ,(grob-description "Clef" clef-interface font-interface break-aligned-interface ))
155 (molecule-callback . ,Chord_name::brew_molecule)
156 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
157 (chord-name-function . ,default-chord-name-function)
158 (font-family . roman)
159 (meta . ,(grob-description "ChordName" font-interface text-interface chord-name-interface))
163 (break-align-symbol . Custos)
165 (molecule-callback . ,Custos::brew_molecule)
166 (visibility-lambda . ,end-of-line-visible)
168 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
169 (meta . ,(grob-description "Custos" custos-interface staff-symbol-referencer-interface break-aligned-interface) )
176 (X-extent-callback . ,Axis_group_interface::group_extent_callback)
178 (X-offset-callbacks . (,Dot_column::side_position))
179 (meta . ,(grob-description "DotColumn" dot-column-interface axis-group-interface))
183 (molecule-callback . ,Dots::brew_molecule)
185 (staff-position . 0.0)
186 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
187 (meta . ,(grob-description "Dots" font-interface dots-interface ))
190 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
193 (font-family . music)
196 (break-align-symbol . Staff_bar)
197 (visibility-lambda . ,begin-of-line-invisible)
198 (meta . ,(grob-description "DoublePercentRepeat" font-interface percent-repeat-interface))
202 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
203 (molecule-callback . ,Text_item::brew_molecule)
204 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
205 (self-alignment-X . 0)
207 (no-spacing-rods . #t)
208 (script-priority . 100)
210 (font-family . dynamic)
211 (font-shape . italic)
212 (self-alignment-Y . 0)
213 (meta . ,(grob-description "DynamicText" font-interface text-interface dynamic-interface))
216 (DynamicLineSpanner . (
219 (minimum-space . 1.2)
221 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
225 (break-align-symbol . Left_edge_item)
226 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
228 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
232 (molecule-callback . ,Text_item::brew_molecule)
233 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
236 (self-alignment-X . 0)
237 (font-family . number)
238 (font-relative-size . -3)
239 (font-shape . upright)
240 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
244 (HaraKiriVerticalGroup . (
245 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
246 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
248 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
251 (molecule-callback . ,Hairpin::brew_molecule)
254 (spacing-procedure . ,Spanner::set_spacing_rods)
255 (minimum-length . 2.0)
256 (if-text-padding . 1.0)
257 (width-correct . -1.0)
259 (dash-thickness . 1.2)
261 (self-alignment-Y . 0)
262 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
263 (meta . ,(grob-description "Hairpin" hairpin-interface dynamic-interface))
268 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
269 ,Side_position_interface::aligned_on_support_refpoints
272 (self-alignment-Y . 0)
273 (molecule-callback . ,Text_item::brew_molecule)
274 (break-align-symbol . Instrument_name)
275 (visibility-lambda . ,begin-of-line-visible)
277 (font-family . roman)
278 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
282 (molecule-callback . ,Key_item::brew_molecule)
283 (break-align-symbol . Key_item)
284 (visibility-lambda . ,begin-of-line-visible)
286 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
293 (minimum-length . 0.5)
294 (maximum-length . 100)
295 (molecule-callback . ,Hyphen_spanner::brew_molecule)
296 (Y-extent-callback . ,Grob::point_dimension_callback)
297 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
302 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
306 (molecule-callback . ,Lyric_extender::brew_molecule)
307 (height . 0.8) ; stafflinethickness;
308 (right-trim-amount . 0.5)
309 (Y-extent-callback . ,Grob::point_dimension_callback)
310 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
314 (molecule-callback . ,Text_item::brew_molecule)
315 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
316 (self-alignment-X . 0)
319 (font-family . roman)
320 (font-shape . upright)
321 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
329 (molecule-callback . ,Porrectus::brew_molecule)
330 (meta . ,(grob-description "Porrectus"
331 porrectus-interface))
335 (molecule-callback . ,Text_item::brew_molecule)
336 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
337 (self-alignment-X . 0)
341 (font-family . roman)
342 (font-shape . upright)
343 (font-relative-size . 1)
344 (visibility-lambda . ,end-of-line-invisible)
346 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
349 (MultiMeasureRest . (
350 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
351 (molecule-callback . ,Multi_measure_rest::brew_molecule)
352 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
355 (padding . 2.0) ; staffspace
356 (minimum-width . 12.5) ; staffspace
357 (font-family . number)
358 (font-relative-size . 1)
359 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface rest-interface font-interface ))
363 ;; Ugh, should not be hard-coded.
365 (meta . ,(grob-description "NoteCollision"
366 note-collision-interface axis-group-interface
372 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
377 (molecule-callback . ,Note_head::brew_molecule)
378 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
379 (stem-attachment-function
380 . ,note-head-style->attachment-coordinates)
381 (meta . ,(grob-description "NoteHead"
382 rhythmic-head-interface font-interface
383 note-head-interface ))
389 (X-extent-callback . #f)
390 (Y-extent-callback . #f)
391 (molecule-callback . ,Line_spanner::brew_molecule)
392 (meta . ,(grob-description "Glissando"
393 line-spanner-interface))
399 (X-extent-callback . #f)
400 (Y-extent-callback . #f)
401 (molecule-callback . ,Line_spanner::brew_molecule)
402 (meta . ,(grob-description "VoiceFollower"
403 line-spanner-interface))
407 (molecule-callback . ,Text_item::brew_molecule)
408 (font-family . roman)
409 (meta . ,(grob-description "NoteName"
410 note-name-interface font-interface
415 (self-alignment-X . 0)
417 (visibility-lambda . ,begin-of-line-visible)
418 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
419 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
420 (molecule-callback . ,Text_item::brew_molecule)
421 (font-shape . italic)
422 (font-family . roman)
423 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
428 (before-grace-spacing-factor . 1.2)
429 (before-musical-spacing-factor . 0.4)
430 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
433 (molecule-callback . ,Slur::brew_molecule)
435 (spacing-procedure . ,Spanner::set_spacing_rods)
436 (minimum-length . 1.5)
437 (after-line-breaking-callback . ,Slur::after_line_breaking)
438 (extremity-rules . ,default-slur-extremity-rules)
439 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
440 (de-uglify-parameters . ( 1.5 0.8 -2.0))
441 (Y-extent-callback . ,Slur::height)
442 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
443 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
444 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
445 (bezier-area-steps . 1.0)))
448 (attachment . (#f . #f))
449 (attachment-offset . ((0 . 0) . (0 . 0)))
451 (meta . ,(grob-description "PhrasingSlur" slur-interface))
454 (NonMusicalPaperColumn . (
456 (before-musical-spacing-factor . 1.0)
457 (column-space-strength . 2.0)
458 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
462 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
463 (molecule-callback . ,Multi_measure_rest::percent)
466 (minimum-width . 12.5) ; staffspace
467 (font-family . music)
468 (meta . ,(grob-description "PercentRepeat" multi-measure-rest-interface font-interface percent-repeat-interface))
473 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
476 (meta . ,(grob-description "RepeatSlash" percent-repeat-interface))
479 (after-line-breaking-callback . ,Rest::after_line_breaking)
480 (X-extent-callback . ,Rest::extent_callback)
481 (Y-extent-callback . ,Rest::extent_callback)
482 (molecule-callback . ,Rest::brew_molecule)
483 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
484 (minimum-beam-collision-distance . 1.5)
485 (meta . ,(grob-description "Rest"
486 rhythmic-head-interface
487 staff-symbol-referencer-interface
491 (minimum-distance . 0.75)
492 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
496 ;; don't set direction here: it breaks staccato.
497 (molecule-callback . ,Script::brew_molecule)
499 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
500 (before-line-breaking-callback . ,Script::before_line_breaking)
501 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
505 (before-line-breaking-callback . ,Script_column::before_line_breaking)
506 (meta . ,(grob-description "ScriptColumn" script-column-interface))
510 (molecule-callback . ,Slur::brew_molecule)
512 (spacing-procedure . ,Spanner::set_spacing_rods)
513 (minimum-length . 1.5)
514 (after-line-breaking-callback . ,Slur::after_line_breaking)
515 (extremity-rules . ,default-slur-extremity-rules)
516 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
517 (de-uglify-parameters . ( 1.5 0.8 -2.0))
518 (Y-extent-callback . ,Slur::height)
519 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
520 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
521 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
522 (bezier-area-steps . 1.0)))
525 (attachment . (#f . #f))
526 (attachment-offset . ((0 . 0) . (0 . 0)))
528 (meta . ,(grob-description "Slur" slur-interface))
532 (spacing-procedure . ,New_spacing_spanner::set_springs)
533 (stem-spacing-correction . 0.5)
534 (grace-space-factor . 0.8)
536 ;; TODO: change naming -- unintuitive
537 (arithmetic-basicspace . 2.0)
538 (arithmetic-multiplier . ,(* 0.9 1.32))
539 ;; assume that notes at least this long are present.
540 (maximum-duration-for-spacing . ,(make-moment 1 8))
541 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
544 (break-align-symbol . Staff_bar)
545 (bar-size-procedure . ,Span_bar::get_bar_size)
546 (molecule-callback . ,Span_bar::brew_molecule)
547 (visibility-lambda . ,begin-of-line-invisible)
548 (X-extent-callback . ,Span_bar::width_callback)
551 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
555 ;; Ross. page 151 lists other values, we opt for a leaner look
559 (hair-thickness . 1.6)
560 (thick-thickness . 6.0)
561 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
566 (molecule-callback . ,Text_item::brew_molecule)
567 (break-align-symbol . Clef_item)
568 (visibility-lambda . ,begin-of-line-visible)
569 (font-family . roman)
570 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
574 (molecule-callback . ,Staff_symbol::brew_molecule)
578 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
581 (molecule-callback . ,Text_item::brew_molecule)
583 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
584 (Y-offset-callbacks .
585 (,Side_position_interface::aligned_side
586 ,Side_position_interface::centered_on_parent))
587 (no-spacing-rods . #t)
588 (font-shape . italic)
589 (self-alignment-X . 0)
590 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
594 (before-line-breaking-callback . ,Stem::before_line_breaking)
595 (molecule-callback . ,Stem::brew_molecule)
597 (beamed-lengths . (0.0 2.5 2.0 1.5))
598 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
600 ;; Stems in unnatural (forced) direction should be shortened,
601 ;; according to [Roush & Gourlay]. Their suggestion to knock off
602 ;; a whole staffspace seems a bit drastical: we'll do half.
604 (lengths . (3.5 3.5 3.5 4.5 5.0))
605 (stem-shorten . (0.5))
606 ; if stem is on middle line, choose this direction.
607 (neutral-direction . -1)
608 (X-offset-callbacks . (,Stem::off_callback))
609 (X-extent-callback . ,Stem::dim_callback)
610 (Y-extent-callback . ,Stem::height)
611 (meta . ,(grob-description "Stem" stem-interface font-interface))
615 (molecule-callback . ,Stem_tremolo::brew_molecule)
616 (Y-extent-callback . ,Stem_tremolo::height)
617 (X-extent-callback . #f)
619 (beam-width . 2.0) ; staff-space
620 (beam-thickness . 0.42) ; staff-space
621 (beam-space-function . ,default-beam-space-function)
622 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
626 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
628 (SeparatingGroupSpanner . (
629 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
630 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
634 (no-spacing-rods . #t)
635 (molecule-callback . ,Sustain_pedal::brew_molecule)
636 (self-alignment-X . 0)
638 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
639 (Y-offset-callbacks .
640 (,Side_position_interface::aligned_side
641 ,Side_position_interface::centered_on_parent))
643 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
646 ;; TODO: should split in 3
647 (SystemStartDelimiter . (
648 (molecule-callback . ,System_start_delimiter::brew_molecule)
649 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
650 ;; really 4.0, but 5 to be on safe side.
651 (brace-collapse-height . 5.0)
652 (bracket-collapse-height . 1)
659 (bracket-thick . 0.25)
660 (Y-extent-callback . #f)
661 (font-family . braces)
662 ;; if you want to set point-size, you cannot set
663 ;; relative-size, as no font will be found for other
665 ;;(font-design-size . 20)
666 ;;(font-relative-size . #f)
667 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
671 (molecule-callback . ,Text_item::brew_molecule)
672 (no-spacing-rods . #t)
675 ;; todo: add X self alignment?
677 (font-family . roman)
678 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
681 (molecule-callback . ,Text_spanner::brew_molecule)
682 (font-family . roman)
685 ;; urg, only for (de)cresc. text spanners
686 (if-text-padding . 1.0)
690 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
693 (molecule-callback . ,Tie::brew_molecule)
694 (spacing-procedure . ,Spanner::set_spacing_rods)
695 (staffline-clearance . 0.35)
696 (details . ((ratio . 0.333) (height-limit . 1.0)))
700 (minimum-length . 2.5)
701 (meta . ,(grob-description "Tie" tie-interface ))
705 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
706 (meta . ,(grob-description "TieColumn" tie-column-interface ))
710 (molecule-callback . ,Time_signature::brew_molecule)
711 (break-align-symbol . Time_signature)
712 (visibility-lambda . ,all-visible)
715 (font-family . number)
716 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
722 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
723 (molecule-callback . ,Tuplet_bracket::brew_molecule)
724 (font-family . roman)
725 (font-shape . italic)
726 (font-relative-size . -1)
727 (meta . ,(grob-description "TupletBracket" text-interface
728 tuplet-bracket-interface font-interface))
732 (molecule-callback . ,Text_item::brew_molecule)
733 (font-family . roman)
734 (font-shape . italic)
735 (no-spacing-rods . #t)
736 (self-alignment-X . 0)
738 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
739 (Y-offset-callbacks .
740 (,Side_position_interface::aligned_side
741 ,Side_position_interface::centered_on_parent))
742 (meta . ,(grob-description "UnaCordaPedal" text-interface font-interface))
746 (molecule-callback . ,Volta_spanner::brew_molecule)
751 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
752 (thickness . 1.6) ; stafflinethickness
753 (height . 2.0) ; staffspace;
755 (font-family . number)
756 (font-relative-size . -2)
757 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
760 (VerticalAlignment . (
762 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
763 (X-extent-callback . #f)
766 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
769 (VerticalAxisGroup . (
771 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
777 ; (display (map pair? all-grob-descriptions))