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 (paren-cautionaries . #t)
33 (meta . ,(grob-description accidentals-interface font-interface side-position-interface))
37 (X-extent-callback . ,Arpeggio::width_callback)
38 (Y-extent-callback . #f)
39 (molecule-callback . ,Arpeggio::brew_molecule)
40 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
41 (X-offset-callbacks . (,Side_position_interface::aligned_side))
43 (staff-position . 0.0)
44 (meta . ,(grob-description arpeggio-interface side-position-interface font-interface))
48 (break-align-symbol . Staff_bar)
50 (break-glyph-function . ,default-break-barline)
51 (bar-size-procedure . ,Bar::get_staff_bar_size)
52 (molecule-callback . ,Bar::brew_molecule)
53 (visibility-lambda . ,all-visible)
55 (before-line-breaking-callback . ,Bar::before_line_breaking)
57 ;; Ross. page 151 lists other values, we opt for a leaner look
61 (hair-thickness . 1.6)
62 (thick-thickness . 6.0)
63 (meta . ,(grob-description bar-line-interface font-interface))
67 (molecule-callback . ,Text_item::brew_molecule)
69 (visibility-lambda . ,begin-of-line-visible)
73 (font-relative-size . -1)
74 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
75 (meta . ,(grob-description
76 side-position-interface
77 text-interface font-interface break-aligned-interface))
81 (molecule-callback . ,Text_item::brew_molecule)
82 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
84 (accidental-alist . ,default-alteration-alist)
85 (font-family . number)
86 (font-relative-size . -1)
87 (meta . ,(grob-description text-interface font-interface ))
90 ;; todo: clean this up a bit: the list is getting
92 (molecule-callback . ,Beam::brew_molecule)
93 (y-dy-callbacks . (,Beam::least_squares
94 ,Beam::cancel_suspect_slope
98 ,Beam::do_quantise_y))
100 (thickness . 0.48) ; in staff-space
101 (before-line-breaking-callback . ,Beam::before_line_breaking)
102 (after-line-breaking-callback . ,Beam::after_line_breaking)
103 (neutral-direction . -1)
104 (dir-function . ,beam-dir-majority)
105 (height-quants . ,default-beam-dy-quants)
106 (vertical-position-quant-function . ,default-beam-y-quants)
107 (beamed-stem-shorten . (0.5))
108 (outer-stem-length-limit . 0.2)
110 (flag-width-function . ,default-beam-flag-width-function)
111 (space-function . ,default-beam-space-function)
114 (meta . ,(grob-description beam-interface))
121 (space-alist . ,default-break-align-space-alist)
122 (meta . ,(grob-description
123 axis-group-interface align-interface
130 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
132 (meta . ,(grob-description axis-group-interface))
136 (break-align-symbol . Breathing_sign)
138 (molecule-callback . ,Breathing_sign::brew_molecule)
139 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
140 (visibility-lambda . ,begin-of-line-invisible)
141 (meta . ,(grob-description break-aligned-interface))
145 (molecule-callback . ,Clef::brew_molecule)
146 (before-line-breaking-callback . ,Clef::before_line_breaking)
148 (font-family . music)
149 (break-align-symbol . Clef_item)
150 (visibility-lambda . ,begin-of-line-visible)
151 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
152 (meta . ,(grob-description clef-interface font-interface break-aligned-interface ))
156 (molecule-callback . ,Chord_name::brew_molecule)
157 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
158 (chord-name-function . ,default-chord-name-function)
159 (font-family . roman)
160 (meta . ,(grob-description font-interface text-interface chord-name-interface))
164 (break-align-symbol . Custos)
166 (molecule-callback . ,Custos::brew_molecule)
167 (visibility-lambda . ,end-of-line-visible)
169 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
170 (meta . ,(grob-description custos-interface staff-symbol-referencer-interface break-aligned-interface) )
177 (X-extent-callback . ,Axis_group_interface::group_extent_callback)
179 (X-offset-callbacks . (,Dot_column::side_position))
180 (meta . ,(grob-description dot-column-interface axis-group-interface))
184 (molecule-callback . ,Dots::brew_molecule)
186 (staff-position . 0.0)
187 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
188 (meta . ,(grob-description font-interface dots-interface ))
191 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
194 (font-family . music)
197 (break-align-symbol . Staff_bar)
198 (visibility-lambda . ,begin-of-line-invisible)
199 (meta . ,(grob-description font-interface percent-repeat-interface))
203 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
204 (molecule-callback . ,Text_item::brew_molecule)
205 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
206 (self-alignment-X . 0)
208 (no-spacing-rods . #t)
209 (script-priority . 100)
211 (font-family . dynamic)
212 (font-shape . italic)
213 (self-alignment-Y . 0)
214 (meta . ,(grob-description font-interface text-interface dynamic-interface))
217 (DynamicLineSpanner . (
220 (minimum-space . 1.2)
222 (meta . ,(grob-description dynamic-interface axis-group-interface side-position-interface))
226 (break-align-symbol . Left_edge_item)
227 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
229 (meta . ,(grob-description break-aligned-interface))
233 (molecule-callback . ,Text_item::brew_molecule)
234 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
237 (self-alignment-X . 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 (before-grace-spacing-factor . 1.2)
428 (before-musical-spacing-factor . 0.4)
429 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
432 (molecule-callback . ,Slur::brew_molecule)
434 (spacing-procedure . ,Spanner::set_spacing_rods)
435 (minimum-length . 1.5)
436 (after-line-breaking-callback . ,Slur::after_line_breaking)
437 (extremity-rules . ,default-slur-extremity-rules)
438 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
439 (de-uglify-parameters . ( 1.5 0.8 -2.0))
440 (Y-extent-callback . ,Slur::height)
441 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
442 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
443 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
444 (bezier-area-steps . 1.0)))
447 (attachment . (#f . #f))
448 (attachment-offset . ((0 . 0) . (0 . 0)))
450 (meta . ,(grob-description slur-interface))
453 (NonMusicalPaperColumn . (
455 (before-musical-spacing-factor . 1.0)
456 (column-space-strength . 2.0)
457 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
461 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
462 (molecule-callback . ,Multi_measure_rest::percent)
465 (minimum-width . 12.5) ; staffspace
466 (font-family . music)
467 (meta . ,(grob-description multi-measure-rest-interface font-interface percent-repeat-interface))
472 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
475 (meta . ,(grob-description percent-repeat-interface))
478 (after-line-breaking-callback . ,Rest::after_line_breaking)
479 (X-extent-callback . ,Rest::extent_callback)
480 (Y-extent-callback . ,Rest::extent_callback)
481 (molecule-callback . ,Rest::brew_molecule)
482 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
483 (minimum-beam-collision-distance . 1.5)
484 (meta . ,(grob-description
485 rhythmic-head-interface
486 staff-symbol-referencer-interface
490 (minimum-distance . 0.75)
491 (meta . ,(grob-description rest-collision-interface ))
495 ;; don't set direction here: it breaks staccato.
496 (molecule-callback . ,Script::brew_molecule)
498 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
499 (before-line-breaking-callback . ,Script::before_line_breaking)
500 (meta . ,(grob-description script-interface side-position-interface font-interface))
504 (before-line-breaking-callback . ,Script_column::before_line_breaking)
505 (meta . ,(grob-description script-column-interface))
509 (molecule-callback . ,Slur::brew_molecule)
511 (spacing-procedure . ,Spanner::set_spacing_rods)
512 (minimum-length . 1.5)
513 (after-line-breaking-callback . ,Slur::after_line_breaking)
514 (extremity-rules . ,default-slur-extremity-rules)
515 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
516 (de-uglify-parameters . ( 1.5 0.8 -2.0))
517 (Y-extent-callback . ,Slur::height)
518 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
519 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
520 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
521 (bezier-area-steps . 1.0)))
524 (attachment . (#f . #f))
525 (attachment-offset . ((0 . 0) . (0 . 0)))
527 (meta . ,(grob-description slur-interface))
531 (spacing-procedure . ,Spacing_spanner::set_springs)
532 (stem-spacing-correction . 0.5)
533 (grace-space-factor . 0.8)
535 ;; TODO: change naming -- unintuitive
536 (arithmetic-basicspace . 2.0)
537 (arithmetic-multiplier . ,(* 0.9 1.32))
538 ;; assume that notes at least this long are present.
539 (maximum-duration-for-spacing . ,(make-moment 1 8))
540 (meta . ,(grob-description spacing-spanner-interface))
543 (break-align-symbol . Staff_bar)
544 (bar-size-procedure . ,Span_bar::get_bar_size)
545 (molecule-callback . ,Span_bar::brew_molecule)
546 (visibility-lambda . ,begin-of-line-invisible)
547 (X-extent-callback . ,Span_bar::width_callback)
550 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
554 ;; Ross. page 151 lists other values, we opt for a leaner look
558 (hair-thickness . 1.6)
559 (thick-thickness . 6.0)
560 (meta . ,(grob-description span-bar-interface bar-line-interface ))
565 (molecule-callback . ,Text_item::brew_molecule)
566 (break-align-symbol . Clef_item)
567 (visibility-lambda . ,begin-of-line-visible)
568 (font-family . roman)
569 (meta . ,(grob-description break-aligned-interface text-interface font-interface))
573 (molecule-callback . ,Staff_symbol::brew_molecule)
577 (meta . ,(grob-description staff-symbol-interface ))
580 (molecule-callback . ,Text_item::brew_molecule)
582 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
583 (Y-offset-callbacks .
584 (,Side_position_interface::aligned_side
585 ,Side_position_interface::centered_on_parent))
586 (no-spacing-rods . #t)
587 (font-shape . italic)
588 (self-alignment-X . 0)
589 (meta . ,(grob-description text-interface font-interface))
593 (before-line-breaking-callback . ,Stem::before_line_breaking)
594 (molecule-callback . ,Stem::brew_molecule)
596 (beamed-lengths . (0.0 2.5 2.0 1.5))
597 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
599 ;; Stems in unnatural (forced) direction should be shortened,
600 ;; according to [Roush & Gourlay]. Their suggestion to knock off
601 ;; a whole staffspace seems a bit drastical: we'll do half.
603 (lengths . (3.5 3.5 3.5 4.5 5.0))
604 (stem-shorten . (0.5))
605 ; if stem is on middle line, choose this direction.
606 (neutral-direction . -1)
607 (X-offset-callbacks . (,Stem::off_callback))
608 (X-extent-callback . ,Stem::dim_callback)
609 (Y-extent-callback . ,Stem::height)
610 (meta . ,(grob-description stem-interface font-interface))
614 (molecule-callback . ,Stem_tremolo::brew_molecule)
615 (Y-extent-callback . ,Stem_tremolo::height)
616 (X-extent-callback . #f)
618 (beam-width . 2.0) ; staff-space
619 (beam-thickness . 0.42) ; staff-space
620 (beam-space-function . ,default-beam-space-function)
621 (meta . ,(grob-description stem-tremolo-interface ))
625 (meta . ,(grob-description separation-item-interface ))
627 (SeparatingGroupSpanner . (
628 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
629 (meta . ,(grob-description separation-spanner-interface))
633 (no-spacing-rods . #t)
634 (molecule-callback . ,Sustain_pedal::brew_molecule)
635 (self-alignment-X . 0)
637 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
638 (Y-offset-callbacks .
639 (,Side_position_interface::aligned_side
640 ,Side_position_interface::centered_on_parent))
642 (meta . ,(grob-description sustain-pedal-interface side-position-interface font-interface))
645 ;; TODO: should split in 3
646 (SystemStartBrace . (
648 (molecule-callback . ,System_start_delimiter::brew_molecule)
649 (collapse-height . 5.0)
650 (font-family . braces)
651 (Y-extent-callback . #f)
652 (meta . ,(grob-description system-start-delimiter-interface font-interface))
654 (SystemStartBracket . (
655 (Y-extent-callback . #f)
656 (molecule-callback . ,System_start_delimiter::brew_molecule)
662 (bracket-collapse-height . 1)
664 (meta . ,(grob-description system-start-delimiter-interface ))
667 (Y-extent-callback . #f)
668 (molecule-callback . ,System_start_delimiter::brew_molecule)
671 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
672 (meta . ,(grob-description system-start-delimiter-interface ))
676 (molecule-callback . ,Text_item::brew_molecule)
677 (no-spacing-rods . #t)
680 ;; todo: add X self alignment?
682 (font-family . roman)
683 (meta . ,(grob-description text-script-interface text-interface side-position-interface font-interface ))
686 (molecule-callback . ,Text_spanner::brew_molecule)
687 (font-family . roman)
690 ;; urg, only for (de)cresc. text spanners
691 (if-text-padding . 1.0)
695 (meta . ,(grob-description text-spanner-interface font-interface))
698 (molecule-callback . ,Tie::brew_molecule)
699 (spacing-procedure . ,Spanner::set_spacing_rods)
700 (staffline-clearance . 0.35)
701 (details . ((ratio . 0.333) (height-limit . 1.0)))
705 (minimum-length . 2.5)
706 (meta . ,(grob-description tie-interface ))
710 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
711 (meta . ,(grob-description tie-column-interface ))
715 (molecule-callback . ,Time_signature::brew_molecule)
716 (break-align-symbol . Time_signature)
717 (visibility-lambda . ,all-visible)
720 (font-family . number)
721 (meta . ,(grob-description time-signature-interface font-interface))
727 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
728 (molecule-callback . ,Tuplet_bracket::brew_molecule)
729 (font-family . roman)
730 (font-shape . italic)
731 (font-relative-size . -1)
732 (meta . ,(grob-description text-interface
733 tuplet-bracket-interface font-interface))
737 (molecule-callback . ,Text_item::brew_molecule)
738 (font-family . roman)
739 (font-shape . italic)
740 (no-spacing-rods . #t)
741 (self-alignment-X . 0)
743 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
744 (Y-offset-callbacks .
745 (,Side_position_interface::aligned_side
746 ,Side_position_interface::centered_on_parent))
747 (meta . ,(grob-description text-interface font-interface))
751 (molecule-callback . ,Volta_spanner::brew_molecule)
756 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
757 (thickness . 1.6) ; stafflinethickness
758 (height . 2.0) ; staffspace;
760 (font-family . number)
761 (font-relative-size . -2)
762 (meta . ,(grob-description volta-bracket-interface side-position-interface font-interface))
764 (VerticalAlignment . (
766 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
767 (X-extent-callback . #f)
770 (meta . ,(grob-description align-interface axis-group-interface))
772 (VerticalAxisGroup . (
774 (meta . ,(grob-description axis-group-interface))
781 (define (completize-grob-entry x)
782 "transplant assoc key into 'name entry of 'meta of X
784 (let* ((name-sym (car x))
786 (metaentry (cdr (assoc 'meta entry)))
787 (new-metaentry (assoc-set! metaentry 'name name-sym))
790 (cons name-sym (assoc-set! entry 'meta new-metaentry))
793 (set! all-grob-descriptions (map completize-grob-entry all-grob-descriptions))
795 ; (display (map pair? all-grob-descriptions))