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)
321 (font-family . roman)
322 (font-shape . upright)
323 (meta . ,(grob-description lyric-syllable-interface text-interface font-interface ))
328 (auto-properties . #f)
330 (porrectus-width . 2.4)
331 (line-thickness . 1.0)
334 (molecule-callback . ,Porrectus::brew_molecule)
335 (meta . ,(grob-description porrectus-interface))
339 (molecule-callback . ,Text_item::brew_molecule)
340 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
341 (self-alignment-X . 0)
345 (font-family . roman)
346 (font-shape . upright)
347 (font-relative-size . 1)
348 (visibility-lambda . ,end-of-line-invisible)
350 (meta . ,(grob-description mark-interface side-position-interface))
353 (MultiMeasureRest . (
354 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
355 (molecule-callback . ,Multi_measure_rest::brew_molecule)
356 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
359 (padding . 2.0) ; staffspace
360 (minimum-width . 12.5) ; staffspace
361 (font-family . number)
362 (font-relative-size . 1)
363 (meta . ,(grob-description multi-measure-rest-interface rest-interface font-interface ))
367 ;; Ugh, should not be hard-coded.
369 (meta . ,(grob-description
370 note-collision-interface axis-group-interface
376 (meta . ,(grob-description axis-group-interface note-column-interface))
381 (molecule-callback . ,Note_head::brew_molecule)
382 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
383 (stem-attachment-function . ,note-head-style->attachment-coordinates)
384 (meta . ,(grob-description rhythmic-head-interface font-interface note-head-interface))
390 (X-extent-callback . #f)
391 (Y-extent-callback . #f)
392 (molecule-callback . ,Line_spanner::brew_molecule)
393 (meta . ,(grob-description line-spanner-interface))
399 (X-extent-callback . #f)
400 (Y-extent-callback . #f)
401 (molecule-callback . ,Line_spanner::brew_molecule)
402 (meta . ,(grob-description line-spanner-interface))
406 (molecule-callback . ,Text_item::brew_molecule)
407 (font-family . roman)
408 (meta . ,(grob-description note-name-interface font-interface))
412 (self-alignment-X . 0)
414 (visibility-lambda . ,begin-of-line-visible)
415 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
416 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
417 (molecule-callback . ,Text_item::brew_molecule)
418 (font-shape . italic)
419 (font-family . roman)
420 (meta . ,(grob-description text-interface font-interface ))
425 (before-grace-spacing-factor . 1.2)
426 (before-musical-spacing-factor . 0.4)
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 (before-musical-spacing-factor . 1.0)
454 (column-space-strength . 2.0)
455 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
459 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
460 (molecule-callback . ,Multi_measure_rest::percent)
463 (minimum-width . 12.5) ; staffspace
464 (font-family . music)
465 (meta . ,(grob-description multi-measure-rest-interface font-interface percent-repeat-interface))
470 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
473 (meta . ,(grob-description percent-repeat-interface))
476 (after-line-breaking-callback . ,Rest::after_line_breaking)
477 (X-extent-callback . ,Rest::extent_callback)
478 (Y-extent-callback . ,Rest::extent_callback)
479 (molecule-callback . ,Rest::brew_molecule)
480 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
481 (minimum-beam-collision-distance . 1.5)
482 (meta . ,(grob-description
483 rhythmic-head-interface
484 staff-symbol-referencer-interface
488 (minimum-distance . 0.75)
489 (meta . ,(grob-description rest-collision-interface ))
493 ;; don't set direction here: it breaks staccato.
494 (molecule-callback . ,Script::brew_molecule)
496 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
497 (before-line-breaking-callback . ,Script::before_line_breaking)
498 (meta . ,(grob-description script-interface side-position-interface font-interface))
502 (before-line-breaking-callback . ,Script_column::before_line_breaking)
503 (meta . ,(grob-description script-column-interface))
507 (molecule-callback . ,Slur::brew_molecule)
509 (spacing-procedure . ,Spanner::set_spacing_rods)
510 (minimum-length . 1.5)
511 (after-line-breaking-callback . ,Slur::after_line_breaking)
512 (extremity-rules . ,default-slur-extremity-rules)
513 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
514 (de-uglify-parameters . ( 1.5 0.8 -2.0))
515 (Y-extent-callback . ,Slur::height)
516 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
517 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
518 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
519 (bezier-area-steps . 1.0)))
522 (attachment . (#f . #f))
523 (attachment-offset . ((0 . 0) . (0 . 0)))
525 (meta . ,(grob-description slur-interface))
529 (spacing-procedure . ,New_spacing_spanner::set_springs)
530 (stem-spacing-correction . 0.5)
531 (grace-space-factor . 0.8)
533 ;; TODO: change naming -- unintuitive
534 (arithmetic-basicspace . 2.0)
535 (arithmetic-multiplier . ,(* 0.9 1.32))
536 ;; assume that notes at least this long are present.
537 (maximum-duration-for-spacing . ,(make-moment 1 8))
538 (meta . ,(grob-description spacing-spanner-interface))
541 (break-align-symbol . Staff_bar)
542 (bar-size-procedure . ,Span_bar::get_bar_size)
543 (molecule-callback . ,Span_bar::brew_molecule)
544 (visibility-lambda . ,begin-of-line-invisible)
545 (X-extent-callback . ,Span_bar::width_callback)
548 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
552 ;; Ross. page 151 lists other values, we opt for a leaner look
556 (hair-thickness . 1.6)
557 (thick-thickness . 6.0)
558 (meta . ,(grob-description span-bar-interface bar-line-interface ))
563 (molecule-callback . ,Text_item::brew_molecule)
564 (break-align-symbol . Clef_item)
565 (visibility-lambda . ,begin-of-line-visible)
566 (font-family . roman)
567 (meta . ,(grob-description break-aligned-interface text-interface font-interface))
571 (molecule-callback . ,Staff_symbol::brew_molecule)
575 (meta . ,(grob-description staff-symbol-interface ))
578 (molecule-callback . ,Text_item::brew_molecule)
580 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
581 (Y-offset-callbacks .
582 (,Side_position_interface::aligned_side
583 ,Side_position_interface::centered_on_parent))
584 (no-spacing-rods . #t)
585 (font-shape . italic)
586 (self-alignment-X . 0)
587 (meta . ,(grob-description text-interface font-interface))
591 (before-line-breaking-callback . ,Stem::before_line_breaking)
592 (molecule-callback . ,Stem::brew_molecule)
594 (beamed-lengths . (0.0 2.5 2.0 1.5))
595 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
597 ;; Stems in unnatural (forced) direction should be shortened,
598 ;; according to [Roush & Gourlay]. Their suggestion to knock off
599 ;; a whole staffspace seems a bit drastical: we'll do half.
601 (lengths . (3.5 3.5 3.5 4.5 5.0))
602 (stem-shorten . (0.5))
603 ; if stem is on middle line, choose this direction.
604 (neutral-direction . -1)
605 (X-offset-callbacks . (,Stem::off_callback))
606 (X-extent-callback . ,Stem::dim_callback)
607 (Y-extent-callback . ,Stem::height)
608 (meta . ,(grob-description stem-interface font-interface))
612 (molecule-callback . ,Stem_tremolo::brew_molecule)
613 (Y-extent-callback . ,Stem_tremolo::height)
614 (X-extent-callback . #f)
616 (beam-width . 2.0) ; staff-space
617 (beam-thickness . 0.42) ; staff-space
618 (beam-space-function . ,default-beam-space-function)
619 (meta . ,(grob-description stem-tremolo-interface ))
623 (meta . ,(grob-description separation-item-interface ))
625 (SeparatingGroupSpanner . (
626 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
627 (meta . ,(grob-description separation-spanner-interface))
631 (no-spacing-rods . #t)
632 (molecule-callback . ,Sustain_pedal::brew_molecule)
633 (self-alignment-X . 0)
635 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
636 (Y-offset-callbacks .
637 (,Side_position_interface::aligned_side
638 ,Side_position_interface::centered_on_parent))
640 (meta . ,(grob-description sustain-pedal-interface side-position-interface font-interface))
643 ;; TODO: should split in 3
644 (SystemStartBrace . (
646 (molecule-callback . ,System_start_delimiter::brew_molecule)
647 (collapse-height . 5.0)
648 (font-family . braces)
649 (Y-extent-callback . #f)
650 (meta . ,(grob-description system-start-delimiter-interface font-interface))
652 (SystemStartBracket . (
653 (Y-extent-callback . #f)
654 (molecule-callback . ,System_start_delimiter::brew_molecule)
660 (bracket-collapse-height . 1)
662 (meta . ,(grob-description system-start-delimiter-interface ))
665 (Y-extent-callback . #f)
666 (molecule-callback . ,System_start_delimiter::brew_molecule)
669 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
670 (meta . ,(grob-description system-start-delimiter-interface ))
674 (molecule-callback . ,Text_item::brew_molecule)
675 (no-spacing-rods . #t)
678 ;; todo: add X self alignment?
680 (font-family . roman)
681 (meta . ,(grob-description text-script-interface text-interface side-position-interface font-interface ))
684 (molecule-callback . ,Text_spanner::brew_molecule)
685 (font-family . roman)
688 ;; urg, only for (de)cresc. text spanners
689 (if-text-padding . 1.0)
693 (meta . ,(grob-description text-spanner-interface font-interface))
696 (molecule-callback . ,Tie::brew_molecule)
697 (spacing-procedure . ,Spanner::set_spacing_rods)
698 (staffline-clearance . 0.35)
699 (details . ((ratio . 0.333) (height-limit . 1.0)))
703 (minimum-length . 2.5)
704 (meta . ,(grob-description tie-interface ))
708 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
709 (meta . ,(grob-description tie-column-interface ))
713 (molecule-callback . ,Time_signature::brew_molecule)
714 (break-align-symbol . Time_signature)
715 (visibility-lambda . ,all-visible)
718 (font-family . number)
719 (meta . ,(grob-description time-signature-interface font-interface))
725 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
726 (molecule-callback . ,Tuplet_bracket::brew_molecule)
727 (font-family . roman)
728 (font-shape . italic)
729 (font-relative-size . -1)
730 (meta . ,(grob-description text-interface
731 tuplet-bracket-interface font-interface))
735 (molecule-callback . ,Text_item::brew_molecule)
736 (font-family . roman)
737 (font-shape . italic)
738 (no-spacing-rods . #t)
739 (self-alignment-X . 0)
741 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
742 (Y-offset-callbacks .
743 (,Side_position_interface::aligned_side
744 ,Side_position_interface::centered_on_parent))
745 (meta . ,(grob-description text-interface font-interface))
749 (molecule-callback . ,Volta_spanner::brew_molecule)
754 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
755 (thickness . 1.6) ; stafflinethickness
756 (height . 2.0) ; staffspace;
758 (font-family . number)
759 (font-relative-size . -2)
760 (meta . ,(grob-description volta-bracket-interface side-position-interface font-interface))
762 (VerticalAlignment . (
764 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
765 (X-extent-callback . #f)
768 (meta . ,(grob-description align-interface axis-group-interface))
770 (VerticalAxisGroup . (
772 (meta . ,(grob-description axis-group-interface))
779 (define (completize-grob-entry x)
780 "transplant assoc key into 'name entry of 'meta of X
782 (let* ((name-sym (car x))
784 (metaentry (cdr (assoc 'meta entry)))
785 (new-metaentry (assoc-set! metaentry 'name name-sym))
788 (cons name-sym (assoc-set! entry 'meta new-metaentry))
791 (set! all-grob-descriptions (map completize-grob-entry all-grob-descriptions))
793 ; (display (map pair? all-grob-descriptions))