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 (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))
225 (HaraKiriVerticalGroup . (
226 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
227 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
229 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
232 (molecule-callback . ,Hairpin::brew_molecule)
235 (spacing-procedure . ,Spanner::set_spacing_rods)
236 (minimum-length . 2.0)
237 (if-text-padding . 1.0)
238 (width-correct . -1.0)
240 (dash-thickness . 1.2)
242 (self-alignment-Y . 0)
243 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
244 (meta . ,(grob-description "Hairpin" hairpin-interface dynamic-interface))
249 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
250 ,Side_position_interface::aligned_on_support_refpoints
253 (self-alignment-Y . 0)
254 (molecule-callback . ,Text_item::brew_molecule)
255 (break-align-symbol . Instrument_name)
256 (visibility-lambda . ,begin-of-line-visible)
258 (font-family . roman)
259 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
263 (molecule-callback . ,Key_item::brew_molecule)
264 (break-align-symbol . Key_item)
265 (visibility-lambda . ,begin-of-line-visible)
267 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
274 (minimum-length . 0.5)
275 (maximum-length . 100)
276 (molecule-callback . ,Hyphen_spanner::brew_molecule)
277 (Y-extent-callback . ,Grob::point_dimension_callback)
278 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
283 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
287 (molecule-callback . ,Lyric_extender::brew_molecule)
288 (height . 0.8) ; stafflinethickness;
289 (right-trim-amount . 0.5)
290 (Y-extent-callback . ,Grob::point_dimension_callback)
291 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
295 (molecule-callback . ,Text_item::brew_molecule)
296 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
297 (self-alignment-X . 0)
300 (font-family . roman)
301 (font-shape . upright)
302 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
306 (molecule-callback . ,Text_item::brew_molecule)
307 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
308 (self-alignment-X . 0)
312 (font-family . roman)
313 (font-shape . upright)
314 (font-relative-size . 1)
315 (visibility-lambda . ,end-of-line-invisible)
317 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
320 (MultiMeasureRest . (
321 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
322 (molecule-callback . ,Multi_measure_rest::brew_molecule)
323 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
326 (padding . 2.0) ; staffspace
327 (minimum-width . 12.5) ; staffspace
328 (font-family . number)
329 (font-relative-size . 1)
330 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface rest-interface font-interface ))
334 ;; Ugh, should not be hard-coded.
336 (meta . ,(grob-description "NoteCollision"
337 note-collision-interface axis-group-interface
343 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
348 (molecule-callback . ,Note_head::brew_molecule)
349 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
350 (stem-attachment-function
351 . ,note-head-style->attachment-coordinates)
352 (meta . ,(grob-description "NoteHead"
353 rhythmic-head-interface font-interface
354 note-head-interface ))
360 (X-extent-callback . #f)
361 (Y-extent-callback . #f)
362 (molecule-callback . ,Line_spanner::brew_molecule)
363 (meta . ,(grob-description "Glissando"
364 line-spanner-interface))
370 (X-extent-callback . #f)
371 (Y-extent-callback . #f)
372 (molecule-callback . ,Line_spanner::brew_molecule)
373 (meta . ,(grob-description "VoiceFollower"
374 line-spanner-interface))
378 (molecule-callback . ,Text_item::brew_molecule)
379 (font-family . roman)
380 (meta . ,(grob-description "NoteName"
381 note-name-interface font-interface
386 (self-alignment-X . 0)
388 (visibility-lambda . ,begin-of-line-visible)
389 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
390 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
391 (molecule-callback . ,Text_item::brew_molecule)
392 (font-shape . italic)
393 (font-family . roman)
394 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
399 (before-grace-spacing-factor . 1.2)
400 (before-musical-spacing-factor . 0.4)
401 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
404 (molecule-callback . ,Slur::brew_molecule)
406 (spacing-procedure . ,Spanner::set_spacing_rods)
407 (minimum-length . 1.5)
408 (after-line-breaking-callback . ,Slur::after_line_breaking)
409 (extremity-rules . ,default-slur-extremity-rules)
410 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
411 (de-uglify-parameters . ( 1.5 0.8 -2.0))
412 (Y-extent-callback . ,Slur::height)
413 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
414 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
415 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
416 (bezier-area-steps . 1.0)))
419 (attachment . (#f . #f))
420 (attachment-offset . ((0 . 0) . (0 . 0)))
422 (meta . ,(grob-description "PhrasingSlur" slur-interface))
425 (NonMusicalPaperColumn . (
427 (before-musical-spacing-factor . 1.0)
428 (column-space-strength . 2.0)
429 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
433 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
434 (molecule-callback . ,Multi_measure_rest::percent)
437 (minimum-width . 12.5) ; staffspace
438 (font-family . music)
439 (meta . ,(grob-description "PercentRepeat" multi-measure-rest-interface font-interface percent-repeat-interface))
444 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
447 (meta . ,(grob-description "RepeatSlash" percent-repeat-interface))
450 (after-line-breaking-callback . ,Rest::after_line_breaking)
451 (X-extent-callback . ,Rest::extent_callback)
452 (Y-extent-callback . ,Rest::extent_callback)
453 (molecule-callback . ,Rest::brew_molecule)
454 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
455 (minimum-beam-collision-distance . 1.5)
456 (meta . ,(grob-description "Rest"
457 rhythmic-head-interface
458 staff-symbol-referencer-interface
462 (minimum-distance . 0.75)
463 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
467 ;; don't set direction here: it breaks staccato.
468 (molecule-callback . ,Script::brew_molecule)
470 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
471 (before-line-breaking-callback . ,Script::before_line_breaking)
472 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
476 (before-line-breaking-callback . ,Script_column::before_line_breaking)
477 (meta . ,(grob-description "ScriptColumn" script-column-interface))
481 (molecule-callback . ,Slur::brew_molecule)
483 (spacing-procedure . ,Spanner::set_spacing_rods)
484 (minimum-length . 1.5)
485 (after-line-breaking-callback . ,Slur::after_line_breaking)
486 (extremity-rules . ,default-slur-extremity-rules)
487 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
488 (de-uglify-parameters . ( 1.5 0.8 -2.0))
489 (Y-extent-callback . ,Slur::height)
490 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
491 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
492 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
493 (bezier-area-steps . 1.0)))
496 (attachment . (#f . #f))
497 (attachment-offset . ((0 . 0) . (0 . 0)))
499 (meta . ,(grob-description "Slur" slur-interface))
503 (spacing-procedure . ,New_spacing_spanner::set_springs)
504 (stem-spacing-correction . 0.5)
505 (grace-space-factor . 0.8)
507 ;; TODO: change naming -- unintuitive
508 (arithmetic-basicspace . 2.0)
509 (arithmetic-multiplier . ,(* 0.9 1.32))
510 ;; assume that notes at least this long are present.
511 (maximum-duration-for-spacing . ,(make-moment 1 8))
512 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
515 (break-align-symbol . Staff_bar)
516 (bar-size-procedure . ,Span_bar::get_bar_size)
517 (molecule-callback . ,Span_bar::brew_molecule)
518 (visibility-lambda . ,begin-of-line-invisible)
519 (X-extent-callback . ,Span_bar::width_callback)
522 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
526 ;; Ross. page 151 lists other values, we opt for a leaner look
530 (hair-thickness . 1.6)
531 (thick-thickness . 6.0)
532 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
537 (molecule-callback . ,Text_item::brew_molecule)
538 (break-align-symbol . Clef_item)
539 (visibility-lambda . ,begin-of-line-visible)
540 (font-family . roman)
541 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
545 (molecule-callback . ,Staff_symbol::brew_molecule)
549 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
552 (molecule-callback . ,Text_item::brew_molecule)
554 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
555 (Y-offset-callbacks .
556 (,Side_position_interface::aligned_side
557 ,Side_position_interface::centered_on_parent))
558 (no-spacing-rods . #t)
559 (font-shape . italic)
560 (self-alignment-X . 0)
561 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
565 (before-line-breaking-callback . ,Stem::before_line_breaking)
566 (molecule-callback . ,Stem::brew_molecule)
568 (beamed-lengths . (0.0 2.5 2.0 1.5))
569 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
571 ;; Stems in unnatural (forced) direction should be shortened,
572 ;; according to [Roush & Gourlay]. Their suggestion to knock off
573 ;; a whole staffspace seems a bit drastical: we'll do half.
575 (lengths . (3.5 3.5 3.5 4.5 5.0))
576 (stem-shorten . (0.5))
577 ; if stem is on middle line, choose this direction.
578 (neutral-direction . -1)
579 (X-offset-callbacks . (,Stem::off_callback))
580 (X-extent-callback . ,Stem::dim_callback)
581 (Y-extent-callback . ,Stem::height)
582 (meta . ,(grob-description "Stem" stem-interface font-interface))
586 (molecule-callback . ,Stem_tremolo::brew_molecule)
587 (Y-extent-callback . ,Stem_tremolo::height)
588 (X-extent-callback . #f)
590 (beam-width . 2.0) ; staff-space
591 (beam-thickness . 0.42) ; staff-space
592 (beam-space-function . ,default-beam-space-function)
593 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
597 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
599 (SeparatingGroupSpanner . (
600 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
601 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
605 (no-spacing-rods . #t)
606 (molecule-callback . ,Sustain_pedal::brew_molecule)
607 (self-alignment-X . 0)
609 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
610 (Y-offset-callbacks .
611 (,Side_position_interface::aligned_side
612 ,Side_position_interface::centered_on_parent))
614 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
617 ;; TODO: should split in 3
618 (SystemStartDelimiter . (
619 (molecule-callback . ,System_start_delimiter::brew_molecule)
620 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
621 ;; really 4.0, but 5 to be on safe side.
622 (brace-collapse-height . 5.0)
623 (bracket-collapse-height . 1)
630 (bracket-thick . 0.25)
631 (Y-extent-callback . #f)
632 (font-family . braces)
633 ;; if you want to set point-size, you cannot set
634 ;; relative-size, as no font will be found for other
636 ;;(font-design-size . 20)
637 ;;(font-relative-size . #f)
638 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
642 (molecule-callback . ,Text_item::brew_molecule)
643 (no-spacing-rods . #t)
646 ;; todo: add X self alignment?
648 (font-family . roman)
649 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
652 (molecule-callback . ,Text_spanner::brew_molecule)
653 (font-family . roman)
656 ;; urg, only for (de)cresc. text spanners
657 (if-text-padding . 1.0)
661 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
664 (molecule-callback . ,Tie::brew_molecule)
665 (spacing-procedure . ,Spanner::set_spacing_rods)
666 (staffline-clearance . 0.35)
667 (details . ((ratio . 0.333) (height-limit . 1.0)))
671 (minimum-length . 2.5)
672 (meta . ,(grob-description "Tie" tie-interface ))
676 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
677 (meta . ,(grob-description "TieColumn" tie-column-interface ))
681 (molecule-callback . ,Time_signature::brew_molecule)
682 (break-align-symbol . Time_signature)
683 (visibility-lambda . ,all-visible)
686 (font-family . number)
687 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
694 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
695 (molecule-callback . ,Tuplet_bracket::brew_molecule)
696 (font-family . roman)
697 (font-shape . italic)
698 (font-relative-size . -1)
699 (meta . ,(grob-description "TupletBracket" text-interface
700 tuplet-bracket-interface font-interface))
704 (molecule-callback . ,Text_item::brew_molecule)
705 (font-family . roman)
706 (font-shape . italic)
707 (no-spacing-rods . #t)
708 (self-alignment-X . 0)
710 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
711 (Y-offset-callbacks .
712 (,Side_position_interface::aligned_side
713 ,Side_position_interface::centered_on_parent))
714 (meta . ,(grob-description "UnaCordaPedal" text-interface font-interface))
718 (molecule-callback . ,Volta_spanner::brew_molecule)
723 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
724 (thickness . 1.6) ; stafflinethickness
725 (height . 2.0) ; staffspace;
727 (font-family . number)
728 (font-relative-size . -2)
729 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
732 (VerticalAlignment . (
734 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
735 (X-extent-callback . #f)
738 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
741 (VerticalAxisGroup . (
743 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
749 ; (display (map pair? all-grob-descriptions))