2 ;;;; grob-description.scm -- part of generated backend documentation
4 ;;;; source file of the GNU LilyPond music typesetter
6 ;;;; (c) 1998--20.301 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 ; distances are given in stafflinethickness (thicknesses) and
10 ; staffspace (distances)
12 (define default-alteration-alist
14 (0 . ((raise . 0.5) (music "accidentals-0")))
15 (-1 . ((raise . 0.5) (music "accidentals--1")))
16 (-2 . ((raise . 0.5) (music "accidentals--2")))
17 (1 . ((raise . 0.5) (music "accidentals-1")))
18 (2 . ((raise . 0.5) (music "accidentals-2")))
22 ;;; WARNING: the meta field should be the last one.
23 (define all-grob-descriptions
26 (molecule-callback . ,Local_key_item::brew_molecule)
27 (X-offset-callbacks . (,Side_position_interface::aligned_side))
28 (after-line-breaking-callback . ,Local_key_item::after_line_breaking)
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 (font-family . number)
238 (font-relative-size . -3)
239 (font-shape . upright)
240 (meta . ,(grob-description 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 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-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 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 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 lyric-hyphen-interface ))
302 (meta . ,(grob-description 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 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 lyric-syllable-interface text-interface font-interface ))
326 (auto-properties . #f)
328 (porrectus-width . 2.4)
329 (line-thickness . 1.0)
332 (molecule-callback . ,Porrectus::brew_molecule)
333 (meta . ,(grob-description porrectus-interface))
337 (molecule-callback . ,Text_item::brew_molecule)
338 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
339 (self-alignment-X . 0)
343 (font-family . roman)
344 (font-shape . upright)
345 (font-relative-size . 1)
346 (visibility-lambda . ,end-of-line-invisible)
348 (meta . ,(grob-description mark-interface side-position-interface))
351 (MultiMeasureRest . (
352 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
353 (molecule-callback . ,Multi_measure_rest::brew_molecule)
354 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
357 (padding . 2.0) ; staffspace
358 (minimum-width . 12.5) ; staffspace
359 (font-family . number)
360 (font-relative-size . 1)
361 (meta . ,(grob-description multi-measure-rest-interface rest-interface font-interface ))
365 ;; Ugh, should not be hard-coded.
367 (meta . ,(grob-description
368 note-collision-interface axis-group-interface
374 (meta . ,(grob-description axis-group-interface note-column-interface))
379 (molecule-callback . ,Note_head::brew_molecule)
380 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
381 (stem-attachment-function . ,note-head-style->attachment-coordinates)
382 (meta . ,(grob-description rhythmic-head-interface font-interface note-head-interface))
388 (X-extent-callback . #f)
389 (Y-extent-callback . #f)
390 (molecule-callback . ,Line_spanner::brew_molecule)
391 (meta . ,(grob-description line-spanner-interface))
397 (X-extent-callback . #f)
398 (Y-extent-callback . #f)
399 (molecule-callback . ,Line_spanner::brew_molecule)
400 (meta . ,(grob-description line-spanner-interface))
404 (molecule-callback . ,Text_item::brew_molecule)
405 (font-family . roman)
406 (meta . ,(grob-description note-name-interface font-interface))
410 (self-alignment-X . 0)
412 (visibility-lambda . ,begin-of-line-visible)
413 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
414 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
415 (molecule-callback . ,Text_item::brew_molecule)
416 (font-shape . italic)
417 (font-family . roman)
418 (meta . ,(grob-description text-interface font-interface ))
423 (before-grace-spacing-factor . 1.2)
424 (before-musical-spacing-factor . 0.4)
425 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
428 (molecule-callback . ,Slur::brew_molecule)
430 (spacing-procedure . ,Spanner::set_spacing_rods)
431 (minimum-length . 1.5)
432 (after-line-breaking-callback . ,Slur::after_line_breaking)
433 (extremity-rules . ,default-slur-extremity-rules)
434 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
435 (de-uglify-parameters . ( 1.5 0.8 -2.0))
436 (Y-extent-callback . ,Slur::height)
437 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
438 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
439 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
440 (bezier-area-steps . 1.0)))
443 (attachment . (#f . #f))
444 (attachment-offset . ((0 . 0) . (0 . 0)))
446 (meta . ,(grob-description slur-interface))
449 (NonMusicalPaperColumn . (
451 (before-musical-spacing-factor . 1.0)
452 (column-space-strength . 2.0)
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 . ,New_spacing_spanner::set_springs)
528 (stem-spacing-correction . 0.5)
529 (grace-space-factor . 0.8)
531 ;; TODO: change naming -- unintuitive
532 (arithmetic-basicspace . 2.0)
533 (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))
569 (molecule-callback . ,Staff_symbol::brew_molecule)
573 (meta . ,(grob-description staff-symbol-interface ))
576 (molecule-callback . ,Text_item::brew_molecule)
578 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
579 (Y-offset-callbacks .
580 (,Side_position_interface::aligned_side
581 ,Side_position_interface::centered_on_parent))
582 (no-spacing-rods . #t)
583 (font-shape . italic)
584 (self-alignment-X . 0)
585 (meta . ,(grob-description text-interface font-interface))
589 (before-line-breaking-callback . ,Stem::before_line_breaking)
590 (molecule-callback . ,Stem::brew_molecule)
592 (beamed-lengths . (0.0 2.5 2.0 1.5))
593 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
595 ;; Stems in unnatural (forced) direction should be shortened,
596 ;; according to [Roush & Gourlay]. Their suggestion to knock off
597 ;; a whole staffspace seems a bit drastical: we'll do half.
599 (lengths . (3.5 3.5 3.5 4.5 5.0))
600 (stem-shorten . (0.5))
601 ; if stem is on middle line, choose this direction.
602 (neutral-direction . -1)
603 (X-offset-callbacks . (,Stem::off_callback))
604 (X-extent-callback . ,Stem::dim_callback)
605 (Y-extent-callback . ,Stem::height)
606 (meta . ,(grob-description stem-interface font-interface))
610 (molecule-callback . ,Stem_tremolo::brew_molecule)
611 (Y-extent-callback . ,Stem_tremolo::height)
612 (X-extent-callback . #f)
614 (beam-width . 2.0) ; staff-space
615 (beam-thickness . 0.42) ; staff-space
616 (beam-space-function . ,default-beam-space-function)
617 (meta . ,(grob-description stem-tremolo-interface ))
621 (meta . ,(grob-description separation-item-interface ))
623 (SeparatingGroupSpanner . (
624 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
625 (meta . ,(grob-description separation-spanner-interface))
629 (no-spacing-rods . #t)
630 (molecule-callback . ,Sustain_pedal::brew_molecule)
631 (self-alignment-X . 0)
633 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
634 (Y-offset-callbacks .
635 (,Side_position_interface::aligned_side
636 ,Side_position_interface::centered_on_parent))
638 (meta . ,(grob-description sustain-pedal-interface side-position-interface font-interface))
641 ;; TODO: should split in 3
642 (SystemStartBrace . (
644 (molecule-callback . ,System_start_delimiter::brew_molecule)
645 (collapse-height . 5.0)
646 (font-family . braces)
647 (Y-extent-callback . #f)
648 (meta . ,(grob-description system-start-delimiter-interface font-interface))
650 (SystemStartBracket . (
651 (Y-extent-callback . #f)
652 (molecule-callback . ,System_start_delimiter::brew_molecule)
658 (bracket-collapse-height . 1)
660 (meta . ,(grob-description system-start-delimiter-interface ))
663 (Y-extent-callback . #f)
664 (molecule-callback . ,System_start_delimiter::brew_molecule)
667 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
668 (meta . ,(grob-description system-start-delimiter-interface ))
672 (molecule-callback . ,Text_item::brew_molecule)
673 (no-spacing-rods . #t)
676 ;; todo: add X self alignment?
678 (font-family . roman)
679 (meta . ,(grob-description text-script-interface text-interface side-position-interface font-interface ))
682 (molecule-callback . ,Text_spanner::brew_molecule)
683 (font-family . roman)
686 ;; urg, only for (de)cresc. text spanners
687 (if-text-padding . 1.0)
691 (meta . ,(grob-description text-spanner-interface font-interface))
694 (molecule-callback . ,Tie::brew_molecule)
695 (spacing-procedure . ,Spanner::set_spacing_rods)
696 (staffline-clearance . 0.35)
697 (details . ((ratio . 0.333) (height-limit . 1.0)))
701 (minimum-length . 2.5)
702 (meta . ,(grob-description tie-interface ))
706 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
707 (meta . ,(grob-description tie-column-interface ))
711 (molecule-callback . ,Time_signature::brew_molecule)
712 (break-align-symbol . Time_signature)
713 (visibility-lambda . ,all-visible)
716 (font-family . number)
717 (meta . ,(grob-description time-signature-interface font-interface))
723 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
724 (molecule-callback . ,Tuplet_bracket::brew_molecule)
725 (font-family . roman)
726 (font-shape . italic)
727 (font-relative-size . -1)
728 (meta . ,(grob-description text-interface
729 tuplet-bracket-interface font-interface))
733 (molecule-callback . ,Text_item::brew_molecule)
734 (font-family . roman)
735 (font-shape . italic)
736 (no-spacing-rods . #t)
737 (self-alignment-X . 0)
739 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
740 (Y-offset-callbacks .
741 (,Side_position_interface::aligned_side
742 ,Side_position_interface::centered_on_parent))
743 (meta . ,(grob-description text-interface font-interface))
747 (molecule-callback . ,Volta_spanner::brew_molecule)
752 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
753 (thickness . 1.6) ; stafflinethickness
754 (height . 2.0) ; staffspace;
756 (font-family . number)
757 (font-relative-size . -2)
758 (meta . ,(grob-description 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 align-interface axis-group-interface))
768 (VerticalAxisGroup . (
770 (meta . ,(grob-description axis-group-interface))
777 (define (completize-grob-entry x)
778 "transplant assoc key into 'name entry of 'meta of X
780 (let* ((name-sym (car x))
782 (metaentry (cdr (assoc 'meta entry)))
783 (new-metaentry (assoc-set! metaentry 'name name-sym))
786 (cons name-sym (assoc-set! entry 'meta new-metaentry))
789 (set! all-grob-descriptions (map completize-grob-entry all-grob-descriptions))
791 ; (display (map pair? all-grob-descriptions))