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 (ignore-length-mismatch . #f)
320 (begin-alignment . 4)
322 (font-family . roman)
323 (font-shape . upright)
324 (meta . ,(grob-description lyric-syllable-interface text-interface font-interface ))
329 (auto-properties . #f)
331 (porrectus-width . 2.4)
332 (line-thickness . 1.0)
335 (molecule-callback . ,Porrectus::brew_molecule)
336 (meta . ,(grob-description porrectus-interface))
340 (molecule-callback . ,Text_item::brew_molecule)
341 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
342 (self-alignment-X . 0)
346 (font-family . roman)
347 (font-shape . upright)
348 (font-relative-size . 1)
349 (visibility-lambda . ,end-of-line-invisible)
351 (meta . ,(grob-description mark-interface side-position-interface))
354 (MultiMeasureRest . (
355 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
356 (molecule-callback . ,Multi_measure_rest::brew_molecule)
357 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
360 (padding . 2.0) ; staffspace
361 (minimum-width . 12.5) ; staffspace
362 (font-family . number)
363 (font-relative-size . 1)
364 (meta . ,(grob-description multi-measure-rest-interface rest-interface font-interface ))
368 ;; Ugh, should not be hard-coded.
370 (meta . ,(grob-description
371 note-collision-interface axis-group-interface
377 (meta . ,(grob-description axis-group-interface note-column-interface))
382 (molecule-callback . ,Note_head::brew_molecule)
383 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
384 (stem-attachment-function . ,note-head-style->attachment-coordinates)
385 (meta . ,(grob-description rhythmic-head-interface font-interface note-head-interface))
391 (X-extent-callback . #f)
392 (Y-extent-callback . #f)
393 (molecule-callback . ,Line_spanner::brew_molecule)
394 (meta . ,(grob-description line-spanner-interface))
400 (X-extent-callback . #f)
401 (Y-extent-callback . #f)
402 (molecule-callback . ,Line_spanner::brew_molecule)
403 (meta . ,(grob-description line-spanner-interface))
407 (molecule-callback . ,Text_item::brew_molecule)
408 (font-family . roman)
409 (meta . ,(grob-description note-name-interface font-interface))
413 (self-alignment-X . 0)
415 (visibility-lambda . ,begin-of-line-visible)
416 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
417 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
418 (molecule-callback . ,Text_item::brew_molecule)
419 (font-shape . italic)
420 (font-family . roman)
421 (meta . ,(grob-description text-interface font-interface ))
426 (before-grace-spacing-factor . 1.2)
427 (before-musical-spacing-factor . 0.4)
428 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
431 (molecule-callback . ,Slur::brew_molecule)
433 (spacing-procedure . ,Spanner::set_spacing_rods)
434 (minimum-length . 1.5)
435 (after-line-breaking-callback . ,Slur::after_line_breaking)
436 (extremity-rules . ,default-slur-extremity-rules)
437 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
438 (de-uglify-parameters . ( 1.5 0.8 -2.0))
439 (Y-extent-callback . ,Slur::height)
440 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
441 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
442 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
443 (bezier-area-steps . 1.0)))
446 (attachment . (#f . #f))
447 (attachment-offset . ((0 . 0) . (0 . 0)))
449 (meta . ,(grob-description slur-interface))
452 (NonMusicalPaperColumn . (
454 (before-musical-spacing-factor . 1.0)
455 (column-space-strength . 2.0)
456 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
460 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
461 (molecule-callback . ,Multi_measure_rest::percent)
464 (minimum-width . 12.5) ; staffspace
465 (font-family . music)
466 (meta . ,(grob-description multi-measure-rest-interface font-interface percent-repeat-interface))
471 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
474 (meta . ,(grob-description percent-repeat-interface))
477 (after-line-breaking-callback . ,Rest::after_line_breaking)
478 (X-extent-callback . ,Rest::extent_callback)
479 (Y-extent-callback . ,Rest::extent_callback)
480 (molecule-callback . ,Rest::brew_molecule)
481 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
482 (minimum-beam-collision-distance . 1.5)
483 (meta . ,(grob-description
484 rhythmic-head-interface
485 staff-symbol-referencer-interface
489 (minimum-distance . 0.75)
490 (meta . ,(grob-description rest-collision-interface ))
494 ;; don't set direction here: it breaks staccato.
495 (molecule-callback . ,Script::brew_molecule)
497 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
498 (before-line-breaking-callback . ,Script::before_line_breaking)
499 (meta . ,(grob-description script-interface side-position-interface font-interface))
503 (before-line-breaking-callback . ,Script_column::before_line_breaking)
504 (meta . ,(grob-description script-column-interface))
508 (molecule-callback . ,Slur::brew_molecule)
510 (spacing-procedure . ,Spanner::set_spacing_rods)
511 (minimum-length . 1.5)
512 (after-line-breaking-callback . ,Slur::after_line_breaking)
513 (extremity-rules . ,default-slur-extremity-rules)
514 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
515 (de-uglify-parameters . ( 1.5 0.8 -2.0))
516 (Y-extent-callback . ,Slur::height)
517 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
518 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
519 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
520 (bezier-area-steps . 1.0)))
523 (attachment . (#f . #f))
524 (attachment-offset . ((0 . 0) . (0 . 0)))
526 (meta . ,(grob-description slur-interface))
530 (spacing-procedure . ,New_spacing_spanner::set_springs)
531 (stem-spacing-correction . 0.5)
532 (grace-space-factor . 0.8)
534 ;; TODO: change naming -- unintuitive
535 (arithmetic-basicspace . 2.0)
536 (arithmetic-multiplier . ,(* 0.9 1.32))
537 ;; assume that notes at least this long are present.
538 (maximum-duration-for-spacing . ,(make-moment 1 8))
539 (meta . ,(grob-description spacing-spanner-interface))
542 (break-align-symbol . Staff_bar)
543 (bar-size-procedure . ,Span_bar::get_bar_size)
544 (molecule-callback . ,Span_bar::brew_molecule)
545 (visibility-lambda . ,begin-of-line-invisible)
546 (X-extent-callback . ,Span_bar::width_callback)
549 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
553 ;; Ross. page 151 lists other values, we opt for a leaner look
557 (hair-thickness . 1.6)
558 (thick-thickness . 6.0)
559 (meta . ,(grob-description span-bar-interface bar-line-interface ))
564 (molecule-callback . ,Text_item::brew_molecule)
565 (break-align-symbol . Clef_item)
566 (visibility-lambda . ,begin-of-line-visible)
567 (font-family . roman)
568 (meta . ,(grob-description break-aligned-interface text-interface font-interface))
572 (molecule-callback . ,Staff_symbol::brew_molecule)
576 (meta . ,(grob-description staff-symbol-interface ))
579 (molecule-callback . ,Text_item::brew_molecule)
581 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
582 (Y-offset-callbacks .
583 (,Side_position_interface::aligned_side
584 ,Side_position_interface::centered_on_parent))
585 (no-spacing-rods . #t)
586 (font-shape . italic)
587 (self-alignment-X . 0)
588 (meta . ,(grob-description text-interface font-interface))
592 (before-line-breaking-callback . ,Stem::before_line_breaking)
593 (molecule-callback . ,Stem::brew_molecule)
595 (beamed-lengths . (0.0 2.5 2.0 1.5))
596 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
598 ;; Stems in unnatural (forced) direction should be shortened,
599 ;; according to [Roush & Gourlay]. Their suggestion to knock off
600 ;; a whole staffspace seems a bit drastical: we'll do half.
602 (lengths . (3.5 3.5 3.5 4.5 5.0))
603 (stem-shorten . (0.5))
604 ; if stem is on middle line, choose this direction.
605 (neutral-direction . -1)
606 (X-offset-callbacks . (,Stem::off_callback))
607 (X-extent-callback . ,Stem::dim_callback)
608 (Y-extent-callback . ,Stem::height)
609 (meta . ,(grob-description stem-interface font-interface))
613 (molecule-callback . ,Stem_tremolo::brew_molecule)
614 (Y-extent-callback . ,Stem_tremolo::height)
615 (X-extent-callback . #f)
617 (beam-width . 2.0) ; staff-space
618 (beam-thickness . 0.42) ; staff-space
619 (beam-space-function . ,default-beam-space-function)
620 (meta . ,(grob-description stem-tremolo-interface ))
624 (meta . ,(grob-description separation-item-interface ))
626 (SeparatingGroupSpanner . (
627 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
628 (meta . ,(grob-description separation-spanner-interface))
632 (no-spacing-rods . #t)
633 (molecule-callback . ,Sustain_pedal::brew_molecule)
634 (self-alignment-X . 0)
636 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
637 (Y-offset-callbacks .
638 (,Side_position_interface::aligned_side
639 ,Side_position_interface::centered_on_parent))
641 (meta . ,(grob-description sustain-pedal-interface side-position-interface font-interface))
644 ;; TODO: should split in 3
645 (SystemStartBrace . (
647 (molecule-callback . ,System_start_delimiter::brew_molecule)
648 (collapse-height . 5.0)
649 (font-family . braces)
650 (Y-extent-callback . #f)
651 (meta . ,(grob-description system-start-delimiter-interface font-interface))
653 (SystemStartBracket . (
654 (Y-extent-callback . #f)
655 (molecule-callback . ,System_start_delimiter::brew_molecule)
661 (bracket-collapse-height . 1)
663 (meta . ,(grob-description system-start-delimiter-interface ))
666 (Y-extent-callback . #f)
667 (molecule-callback . ,System_start_delimiter::brew_molecule)
670 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
671 (meta . ,(grob-description system-start-delimiter-interface ))
675 (molecule-callback . ,Text_item::brew_molecule)
676 (no-spacing-rods . #t)
679 ;; todo: add X self alignment?
681 (font-family . roman)
682 (meta . ,(grob-description text-script-interface text-interface side-position-interface font-interface ))
685 (molecule-callback . ,Text_spanner::brew_molecule)
686 (font-family . roman)
689 ;; urg, only for (de)cresc. text spanners
690 (if-text-padding . 1.0)
694 (meta . ,(grob-description text-spanner-interface font-interface))
697 (molecule-callback . ,Tie::brew_molecule)
698 (spacing-procedure . ,Spanner::set_spacing_rods)
699 (staffline-clearance . 0.35)
700 (details . ((ratio . 0.333) (height-limit . 1.0)))
704 (minimum-length . 2.5)
705 (meta . ,(grob-description tie-interface ))
709 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
710 (meta . ,(grob-description tie-column-interface ))
714 (molecule-callback . ,Time_signature::brew_molecule)
715 (break-align-symbol . Time_signature)
716 (visibility-lambda . ,all-visible)
719 (font-family . number)
720 (meta . ,(grob-description time-signature-interface font-interface))
726 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
727 (molecule-callback . ,Tuplet_bracket::brew_molecule)
728 (font-family . roman)
729 (font-shape . italic)
730 (font-relative-size . -1)
731 (meta . ,(grob-description text-interface
732 tuplet-bracket-interface font-interface))
736 (molecule-callback . ,Text_item::brew_molecule)
737 (font-family . roman)
738 (font-shape . italic)
739 (no-spacing-rods . #t)
740 (self-alignment-X . 0)
742 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
743 (Y-offset-callbacks .
744 (,Side_position_interface::aligned_side
745 ,Side_position_interface::centered_on_parent))
746 (meta . ,(grob-description text-interface font-interface))
750 (molecule-callback . ,Volta_spanner::brew_molecule)
755 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
756 (thickness . 1.6) ; stafflinethickness
757 (height . 2.0) ; staffspace;
759 (font-family . number)
760 (font-relative-size . -2)
761 (meta . ,(grob-description volta-bracket-interface side-position-interface font-interface))
763 (VerticalAlignment . (
765 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
766 (X-extent-callback . #f)
769 (meta . ,(grob-description align-interface axis-group-interface))
771 (VerticalAxisGroup . (
773 (meta . ,(grob-description axis-group-interface))
780 (define (completize-grob-entry x)
781 "transplant assoc key into 'name entry of 'meta of X
783 (let* ((name-sym (car x))
785 (metaentry (cdr (assoc 'meta entry)))
786 (new-metaentry (assoc-set! metaentry 'name name-sym))
789 (cons name-sym (assoc-set! entry 'meta new-metaentry))
792 (set! all-grob-descriptions (map completize-grob-entry all-grob-descriptions))
794 ; (display (map pair? all-grob-descriptions))