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 ;;; WARNING: the meta field should be the last one.
22 (define all-grob-descriptions
25 (molecule-callback . ,Local_key_item::brew_molecule)
26 (X-offset-callbacks . (,Side_position_interface::aligned_side))
27 (after-line-breaking-callback . ,Local_key_item::after_line_breaking)
31 (paren-cautionaries . #t)
32 (meta . ,(grob-description accidentals-interface font-interface side-position-interface))
36 (X-extent-callback . ,Arpeggio::width_callback)
37 (Y-extent-callback . #f)
38 (molecule-callback . ,Arpeggio::brew_molecule)
39 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
40 (X-offset-callbacks . (,Side_position_interface::aligned_side))
42 (staff-position . 0.0)
43 (meta . ,(grob-description arpeggio-interface side-position-interface font-interface))
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 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
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 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-interface))
120 (space-alist . ,default-break-align-space-alist)
121 (meta . ,(grob-description
122 axis-group-interface align-interface
129 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
131 (meta . ,(grob-description 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 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-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 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-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 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 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 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 font-interface text-interface dynamic-interface))
216 (DynamicLineSpanner . (
219 (minimum-space . 1.2)
221 (meta . ,(grob-description 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 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 (self-alignment-Y . 0)
238 (font-family . number)
239 (font-relative-size . -3)
240 (font-shape . upright)
241 (meta . ,(grob-description finger-interface font-interface text-script-interface text-interface side-position-interface))
245 (HaraKiriVerticalGroup . (
246 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
247 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
249 (meta . ,(grob-description axis-group-interface hara-kiri-group-interface))
252 (molecule-callback . ,Hairpin::brew_molecule)
255 (spacing-procedure . ,Spanner::set_spacing_rods)
256 (minimum-length . 2.0)
257 (if-text-padding . 1.0)
258 (width-correct . -1.0)
260 (dash-thickness . 1.2)
262 (self-alignment-Y . 0)
263 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
264 (meta . ,(grob-description hairpin-interface dynamic-interface))
269 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
270 ,Side_position_interface::aligned_on_support_refpoints
273 (self-alignment-Y . 0)
274 (molecule-callback . ,Text_item::brew_molecule)
275 (break-align-symbol . Instrument_name)
276 (visibility-lambda . ,begin-of-line-visible)
278 (font-family . roman)
279 (meta . ,(grob-description font-interface text-interface break-aligned-interface))
283 (molecule-callback . ,Key_item::brew_molecule)
284 (break-align-symbol . Key_item)
285 (visibility-lambda . ,begin-of-line-visible)
287 (meta . ,(grob-description key-signature-interface font-interface break-aligned-interface))
294 (minimum-length . 0.5)
295 (maximum-length . 100)
296 (molecule-callback . ,Hyphen_spanner::brew_molecule)
297 (Y-extent-callback . ,Grob::point_dimension_callback)
298 (meta . ,(grob-description lyric-hyphen-interface ))
303 (meta . ,(grob-description line-of-score-interface axis-group-interface))
307 (molecule-callback . ,Lyric_extender::brew_molecule)
308 (height . 0.8) ; stafflinethickness;
309 (right-trim-amount . 0.5)
310 (Y-extent-callback . ,Grob::point_dimension_callback)
311 (meta . ,(grob-description lyric-extender-interface))
315 (molecule-callback . ,Text_item::brew_molecule)
316 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
317 (self-alignment-X . 0)
320 (ignore-length-mismatch . #f)
321 (begin-alignment . 4)
323 (font-family . roman)
324 (font-shape . upright)
325 (meta . ,(grob-description lyric-syllable-interface text-interface font-interface ))
330 (auto-properties . #f)
332 (porrectus-width . 2.4)
333 (line-thickness . 1.0)
336 (molecule-callback . ,Porrectus::brew_molecule)
337 (meta . ,(grob-description porrectus-interface))
341 (molecule-callback . ,Text_item::brew_molecule)
342 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
343 (self-alignment-X . 0)
347 (font-family . roman)
348 (font-shape . upright)
349 (font-relative-size . 1)
350 (visibility-lambda . ,end-of-line-invisible)
352 (meta . ,(grob-description mark-interface side-position-interface))
355 (MultiMeasureRest . (
356 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
357 (molecule-callback . ,Multi_measure_rest::brew_molecule)
358 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
361 (padding . 2.0) ; staffspace
362 (minimum-width . 12.5) ; staffspace
363 (font-family . number)
364 (font-relative-size . 1)
365 (meta . ,(grob-description multi-measure-rest-interface rest-interface font-interface ))
369 ;; Ugh, should not be hard-coded.
371 (meta . ,(grob-description
372 note-collision-interface axis-group-interface
378 (meta . ,(grob-description axis-group-interface note-column-interface))
383 (molecule-callback . ,Note_head::brew_molecule)
384 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
385 (stem-attachment-function . ,note-head-style->attachment-coordinates)
386 (meta . ,(grob-description rhythmic-head-interface font-interface note-head-interface))
392 (X-extent-callback . #f)
393 (Y-extent-callback . #f)
394 (molecule-callback . ,Line_spanner::brew_molecule)
395 (meta . ,(grob-description line-spanner-interface))
401 (X-extent-callback . #f)
402 (Y-extent-callback . #f)
403 (molecule-callback . ,Line_spanner::brew_molecule)
404 (meta . ,(grob-description line-spanner-interface))
408 (molecule-callback . ,Text_item::brew_molecule)
409 (font-family . roman)
410 (meta . ,(grob-description note-name-interface font-interface))
414 (self-alignment-X . 0)
416 (visibility-lambda . ,begin-of-line-visible)
417 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
418 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
419 (molecule-callback . ,Text_item::brew_molecule)
420 (font-shape . italic)
421 (font-family . roman)
422 (meta . ,(grob-description text-interface font-interface ))
427 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
430 (molecule-callback . ,Slur::brew_molecule)
432 (spacing-procedure . ,Spanner::set_spacing_rods)
433 (minimum-length . 1.5)
434 (after-line-breaking-callback . ,Slur::after_line_breaking)
435 (extremity-rules . ,default-slur-extremity-rules)
436 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
437 (de-uglify-parameters . ( 1.5 0.8 -2.0))
438 (Y-extent-callback . ,Slur::height)
439 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
440 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
441 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
442 (bezier-area-steps . 1.0)))
445 (attachment . (#f . #f))
446 (attachment-offset . ((0 . 0) . (0 . 0)))
448 (meta . ,(grob-description slur-interface))
451 (NonMusicalPaperColumn . (
453 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
457 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
458 (molecule-callback . ,Multi_measure_rest::percent)
461 (minimum-width . 12.5) ; staffspace
462 (font-family . music)
463 (meta . ,(grob-description multi-measure-rest-interface font-interface percent-repeat-interface))
468 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
471 (meta . ,(grob-description percent-repeat-interface))
474 (after-line-breaking-callback . ,Rest::after_line_breaking)
475 (X-extent-callback . ,Rest::extent_callback)
476 (Y-extent-callback . ,Rest::extent_callback)
477 (molecule-callback . ,Rest::brew_molecule)
478 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
479 (minimum-beam-collision-distance . 1.5)
480 (meta . ,(grob-description
481 rhythmic-head-interface
482 staff-symbol-referencer-interface
486 (minimum-distance . 0.75)
487 (meta . ,(grob-description rest-collision-interface ))
491 ;; don't set direction here: it breaks staccato.
492 (molecule-callback . ,Script::brew_molecule)
494 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
495 (before-line-breaking-callback . ,Script::before_line_breaking)
496 (meta . ,(grob-description script-interface side-position-interface font-interface))
500 (before-line-breaking-callback . ,Script_column::before_line_breaking)
501 (meta . ,(grob-description script-column-interface))
505 (molecule-callback . ,Slur::brew_molecule)
507 (spacing-procedure . ,Spanner::set_spacing_rods)
508 (minimum-length . 1.5)
509 (after-line-breaking-callback . ,Slur::after_line_breaking)
510 (extremity-rules . ,default-slur-extremity-rules)
511 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
512 (de-uglify-parameters . ( 1.5 0.8 -2.0))
513 (Y-extent-callback . ,Slur::height)
514 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
515 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
516 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
517 (bezier-area-steps . 1.0)))
520 (attachment . (#f . #f))
521 (attachment-offset . ((0 . 0) . (0 . 0)))
523 (meta . ,(grob-description slur-interface))
527 (spacing-procedure . ,Third_spacing_spanner::set_springs)
528 (grace-space-factor . 0.8)
530 ;; TODO: change naming -- unintuitive
531 (arithmetic-basicspace . 2.0)
532 (arithmetic-multiplier . ,(* 0.9 1.32))
534 ;; assume that notes at least this long are present.
535 (maximum-duration-for-spacing . ,(make-moment 1 8))
536 (meta . ,(grob-description spacing-spanner-interface))
539 (break-align-symbol . Staff_bar)
540 (bar-size-procedure . ,Span_bar::get_bar_size)
541 (molecule-callback . ,Span_bar::brew_molecule)
542 (visibility-lambda . ,begin-of-line-invisible)
543 (X-extent-callback . ,Span_bar::width_callback)
546 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
550 ;; Ross. page 151 lists other values, we opt for a leaner look
554 (hair-thickness . 1.6)
555 (thick-thickness . 6.0)
556 (meta . ,(grob-description span-bar-interface bar-line-interface ))
561 (molecule-callback . ,Text_item::brew_molecule)
562 (break-align-symbol . Clef_item)
563 (visibility-lambda . ,begin-of-line-visible)
564 (font-family . roman)
565 (meta . ,(grob-description break-aligned-interface text-interface font-interface))
570 (X-extent-callback . #f)
571 (Y-extent-callback . #f)
573 (meta . ,(grob-description staff-spacing-interface))
576 (X-extent-callback . #f)
577 (Y-extent-callback . #f)
578 (stem-spacing-correction . 0.)
580 (meta . ,(grob-description note-spacing-interface))
584 (molecule-callback . ,Staff_symbol::brew_molecule)
588 (meta . ,(grob-description staff-symbol-interface ))
591 (molecule-callback . ,Text_item::brew_molecule)
593 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
594 (Y-offset-callbacks .
595 (,Side_position_interface::aligned_side
596 ,Side_position_interface::centered_on_parent))
597 (no-spacing-rods . #t)
598 (font-shape . italic)
599 (self-alignment-X . 0)
600 (meta . ,(grob-description text-interface font-interface))
604 (before-line-breaking-callback . ,Stem::before_line_breaking)
605 (molecule-callback . ,Stem::brew_molecule)
607 (beamed-lengths . (0.0 2.5 2.0 1.5))
608 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
610 ;; Stems in unnatural (forced) direction should be shortened,
611 ;; according to [Roush & Gourlay]. Their suggestion to knock off
612 ;; a whole staffspace seems a bit drastical: we'll do half.
614 (lengths . (3.5 3.5 3.5 4.5 5.0))
615 (stem-shorten . (0.5))
616 ; if stem is on middle line, choose this direction.
617 (neutral-direction . -1)
618 (X-offset-callbacks . (,Stem::off_callback))
619 (X-extent-callback . ,Stem::dim_callback)
620 (Y-extent-callback . ,Stem::height)
621 (meta . ,(grob-description stem-interface font-interface))
625 (molecule-callback . ,Stem_tremolo::brew_molecule)
626 (Y-extent-callback . ,Stem_tremolo::height)
627 (X-extent-callback . #f)
629 (beam-width . 2.0) ; staff-space
630 (beam-thickness . 0.42) ; staff-space
631 (beam-space-function . ,default-beam-space-function)
632 (meta . ,(grob-description stem-tremolo-interface ))
636 (meta . ,(grob-description separation-item-interface ))
638 (SeparatingGroupSpanner . (
639 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
640 (meta . ,(grob-description separation-spanner-interface))
644 (no-spacing-rods . #t)
645 (molecule-callback . ,Sustain_pedal::brew_molecule)
646 (self-alignment-X . 0)
648 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
649 (Y-offset-callbacks .
650 (,Side_position_interface::aligned_side
651 ,Side_position_interface::centered_on_parent))
653 (meta . ,(grob-description sustain-pedal-interface side-position-interface font-interface))
656 ;; TODO: should split in 3
657 (SystemStartBrace . (
659 (molecule-callback . ,System_start_delimiter::brew_molecule)
660 (collapse-height . 5.0)
661 (font-family . braces)
662 (Y-extent-callback . #f)
663 (meta . ,(grob-description system-start-delimiter-interface font-interface))
665 (SystemStartBracket . (
666 (Y-extent-callback . #f)
667 (molecule-callback . ,System_start_delimiter::brew_molecule)
673 (bracket-collapse-height . 1)
675 (meta . ,(grob-description system-start-delimiter-interface ))
678 (Y-extent-callback . #f)
679 (molecule-callback . ,System_start_delimiter::brew_molecule)
682 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
683 (meta . ,(grob-description system-start-delimiter-interface ))
687 (molecule-callback . ,Text_item::brew_molecule)
688 (no-spacing-rods . #t)
691 ;; todo: add X self alignment?
693 (font-family . roman)
694 (meta . ,(grob-description text-script-interface text-interface side-position-interface font-interface ))
697 (molecule-callback . ,Text_spanner::brew_molecule)
698 (font-family . roman)
701 ;; urg, only for (de)cresc. text spanners
702 (if-text-padding . 1.0)
706 (meta . ,(grob-description text-spanner-interface font-interface))
709 (molecule-callback . ,Tie::brew_molecule)
710 (spacing-procedure . ,Spanner::set_spacing_rods)
711 (staffline-clearance . 0.35)
712 (details . ((ratio . 0.333) (height-limit . 1.0)))
716 (minimum-length . 2.5)
717 (meta . ,(grob-description tie-interface ))
721 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
722 (meta . ,(grob-description tie-column-interface ))
726 (molecule-callback . ,Time_signature::brew_molecule)
727 (break-align-symbol . Time_signature)
728 (visibility-lambda . ,all-visible)
731 (font-family . number)
732 (meta . ,(grob-description time-signature-interface font-interface))
738 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
739 (molecule-callback . ,Tuplet_bracket::brew_molecule)
740 (font-family . roman)
741 (font-shape . italic)
742 (font-relative-size . -1)
743 (meta . ,(grob-description text-interface
744 tuplet-bracket-interface font-interface))
748 (molecule-callback . ,Text_item::brew_molecule)
749 (font-family . roman)
750 (font-shape . italic)
751 (no-spacing-rods . #t)
752 (self-alignment-X . 0)
754 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
755 (Y-offset-callbacks .
756 (,Side_position_interface::aligned_side
757 ,Side_position_interface::centered_on_parent))
758 (meta . ,(grob-description text-interface font-interface))
762 (molecule-callback . ,Volta_spanner::brew_molecule)
767 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
768 (thickness . 1.6) ; stafflinethickness
769 (height . 2.0) ; staffspace;
771 (font-family . number)
772 (font-relative-size . -2)
773 (meta . ,(grob-description volta-bracket-interface side-position-interface font-interface))
775 (VerticalAlignment . (
777 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
778 (X-extent-callback . #f)
781 (meta . ,(grob-description align-interface axis-group-interface))
783 (VerticalAxisGroup . (
785 (meta . ,(grob-description axis-group-interface))
792 (define (completize-grob-entry x)
793 "transplant assoc key into 'name entry of 'meta of X
795 (let* ((name-sym (car x))
797 (metaentry (cdr (assoc 'meta entry)))
798 (new-metaentry (assoc-set! metaentry 'name name-sym))
801 (cons name-sym (assoc-set! entry 'meta new-metaentry))
804 (set! all-grob-descriptions (map completize-grob-entry all-grob-descriptions))
806 ; (display (map pair? all-grob-descriptions))