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.
23 ;; TODO: junk the meta field in favor of something more compact?
24 (define all-grob-descriptions
27 (molecule-callback . ,Local_key_item::brew_molecule)
28 (X-offset-callbacks . (,Side_position_interface::aligned_side))
29 (after-line-breaking-callback . ,Local_key_item::after_line_breaking)
33 (paren-cautionaries . #t)
34 (meta . ,(grob-description accidentals-interface font-interface side-position-interface))
38 (X-extent-callback . ,Arpeggio::width_callback)
39 (Y-extent-callback . #f)
40 (molecule-callback . ,Arpeggio::brew_molecule)
41 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
42 (X-offset-callbacks . (,Side_position_interface::aligned_side))
44 (staff-position . 0.0)
45 (meta . ,(grob-description arpeggio-interface side-position-interface font-interface))
49 (break-align-symbol . Staff_bar)
51 (break-glyph-function . ,default-break-barline)
52 (bar-size-procedure . ,Bar::get_staff_bar_size)
53 (molecule-callback . ,Bar::brew_molecule)
54 (visibility-lambda . ,all-visible)
56 (before-line-breaking-callback . ,Bar::before_line_breaking)
58 ;; Ross. page 151 lists other values, we opt for a leaner look
62 (hair-thickness . 1.6)
63 (thick-thickness . 6.0)
64 (meta . ,(grob-description bar-line-interface font-interface))
68 (molecule-callback . ,Text_item::brew_molecule)
70 (visibility-lambda . ,begin-of-line-visible)
74 (font-relative-size . -1)
75 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
76 (meta . ,(grob-description
77 side-position-interface
78 text-interface font-interface break-aligned-interface))
82 (molecule-callback . ,Text_item::brew_molecule)
83 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
85 (accidental-alist . ,default-alteration-alist)
86 (font-family . number)
87 (font-relative-size . -1)
88 (meta . ,(grob-description text-interface font-interface ))
91 ;; todo: clean this up a bit: the list is getting
93 (molecule-callback . ,Beam::brew_molecule)
94 (y-dy-callbacks . (,Beam::least_squares
95 ,Beam::cancel_suspect_slope
99 ,Beam::do_quantise_y))
101 (thickness . 0.48) ; in staff-space
102 (before-line-breaking-callback . ,Beam::before_line_breaking)
103 (after-line-breaking-callback . ,Beam::after_line_breaking)
104 (neutral-direction . -1)
105 (dir-function . ,beam-dir-majority)
106 (height-quants . ,default-beam-dy-quants)
107 (vertical-position-quant-function . ,default-beam-y-quants)
108 (beamed-stem-shorten . (0.5))
109 (outer-stem-length-limit . 0.2)
111 (flag-width-function . ,default-beam-flag-width-function)
112 (space-function . ,default-beam-space-function)
115 (meta . ,(grob-description beam-interface))
122 (space-alist . ,default-break-align-space-alist)
123 (meta . ,(grob-description
124 axis-group-interface align-interface
131 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
133 (meta . ,(grob-description axis-group-interface))
137 (break-align-symbol . Breathing_sign)
139 (molecule-callback . ,Breathing_sign::brew_molecule)
140 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
141 (visibility-lambda . ,begin-of-line-invisible)
142 (meta . ,(grob-description break-aligned-interface))
146 (molecule-callback . ,Clef::brew_molecule)
147 (before-line-breaking-callback . ,Clef::before_line_breaking)
149 (font-family . music)
150 (break-align-symbol . Clef_item)
151 (visibility-lambda . ,begin-of-line-visible)
152 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
153 (meta . ,(grob-description clef-interface font-interface break-aligned-interface ))
157 (molecule-callback . ,Chord_name::brew_molecule)
158 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
159 (chord-name-function . ,default-chord-name-function)
160 (font-family . roman)
161 (meta . ,(grob-description font-interface text-interface chord-name-interface))
165 (break-align-symbol . Custos)
167 (molecule-callback . ,Custos::brew_molecule)
168 (visibility-lambda . ,end-of-line-visible)
170 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
171 (meta . ,(grob-description custos-interface staff-symbol-referencer-interface break-aligned-interface) )
178 (X-extent-callback . ,Axis_group_interface::group_extent_callback)
180 (X-offset-callbacks . (,Dot_column::side_position))
181 (meta . ,(grob-description dot-column-interface axis-group-interface))
185 (molecule-callback . ,Dots::brew_molecule)
187 (staff-position . 0.0)
188 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
189 (meta . ,(grob-description font-interface dots-interface ))
192 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
195 (font-family . music)
198 (break-align-symbol . Staff_bar)
199 (visibility-lambda . ,begin-of-line-invisible)
200 (meta . ,(grob-description font-interface percent-repeat-interface))
204 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
205 (molecule-callback . ,Text_item::brew_molecule)
206 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
207 (self-alignment-X . 0)
209 (no-spacing-rods . #t)
210 (script-priority . 100)
212 (font-family . dynamic)
213 (font-shape . italic)
214 (self-alignment-Y . 0)
215 (meta . ,(grob-description font-interface text-interface dynamic-interface))
218 (DynamicLineSpanner . (
221 (minimum-space . 1.2)
223 (meta . ,(grob-description dynamic-interface axis-group-interface side-position-interface))
227 (break-align-symbol . Left_edge_item)
228 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
230 (meta . ,(grob-description break-aligned-interface))
234 (molecule-callback . ,Text_item::brew_molecule)
235 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
238 (self-alignment-X . 0)
239 (self-alignment-Y . 0)
240 (font-family . number)
241 (font-relative-size . -3)
242 (font-shape . upright)
243 (meta . ,(grob-description finger-interface font-interface text-script-interface text-interface side-position-interface))
247 (HaraKiriVerticalGroup . (
248 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
249 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
251 (meta . ,(grob-description axis-group-interface hara-kiri-group-interface))
254 (molecule-callback . ,Hairpin::brew_molecule)
257 (spacing-procedure . ,Spanner::set_spacing_rods)
258 (minimum-length . 2.0)
259 (if-text-padding . 1.0)
260 (width-correct . -1.0)
262 (dash-thickness . 1.2)
264 (self-alignment-Y . 0)
265 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
266 (meta . ,(grob-description hairpin-interface dynamic-interface))
271 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
272 ,Side_position_interface::aligned_on_support_refpoints
275 (self-alignment-Y . 0)
276 (molecule-callback . ,Text_item::brew_molecule)
277 (break-align-symbol . Instrument_name)
278 (visibility-lambda . ,begin-of-line-visible)
280 (font-family . roman)
281 (meta . ,(grob-description font-interface text-interface break-aligned-interface))
285 (molecule-callback . ,Key_item::brew_molecule)
286 (break-align-symbol . Key_item)
287 (visibility-lambda . ,begin-of-line-visible)
289 (meta . ,(grob-description key-signature-interface font-interface break-aligned-interface))
296 (minimum-length . 0.5)
297 (maximum-length . 100)
298 (molecule-callback . ,Hyphen_spanner::brew_molecule)
299 (Y-extent-callback . ,Grob::point_dimension_callback)
300 (meta . ,(grob-description lyric-hyphen-interface ))
305 (meta . ,(grob-description line-of-score-interface axis-group-interface))
309 (molecule-callback . ,Lyric_extender::brew_molecule)
310 (height . 0.8) ; stafflinethickness;
311 (right-trim-amount . 0.5)
312 (Y-extent-callback . ,Grob::point_dimension_callback)
313 (meta . ,(grob-description lyric-extender-interface))
317 (molecule-callback . ,Text_item::brew_molecule)
318 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
319 (self-alignment-X . 0)
322 (ignore-length-mismatch . #f)
323 (begin-alignment . 4)
325 (font-family . roman)
326 (font-shape . upright)
327 (meta . ,(grob-description lyric-syllable-interface text-interface font-interface ))
332 (auto-properties . #f)
334 (porrectus-width . 2.4)
335 (line-thickness . 1.0)
338 (molecule-callback . ,Porrectus::brew_molecule)
339 (meta . ,(grob-description porrectus-interface))
343 (molecule-callback . ,Text_item::brew_molecule)
344 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
345 (self-alignment-X . 0)
349 (font-family . roman)
350 (font-shape . upright)
351 (font-relative-size . 1)
352 (visibility-lambda . ,end-of-line-invisible)
354 (meta . ,(grob-description mark-interface side-position-interface))
357 (MultiMeasureRest . (
358 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
359 (molecule-callback . ,Multi_measure_rest::brew_molecule)
360 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
363 (padding . 2.0) ; staffspace
364 (minimum-width . 12.5) ; staffspace
365 (font-family . number)
366 (font-relative-size . 1)
367 (meta . ,(grob-description multi-measure-rest-interface rest-interface font-interface ))
371 ;; Ugh, should not be hard-coded.
373 (meta . ,(grob-description
374 note-collision-interface axis-group-interface
380 (meta . ,(grob-description axis-group-interface note-column-interface))
385 (molecule-callback . ,Note_head::brew_molecule)
386 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
387 (stem-attachment-function . ,note-head-style->attachment-coordinates)
388 (meta . ,(grob-description rhythmic-head-interface font-interface note-head-interface))
394 (X-extent-callback . #f)
395 (Y-extent-callback . #f)
396 (molecule-callback . ,Line_spanner::brew_molecule)
397 (meta . ,(grob-description line-spanner-interface))
403 (X-extent-callback . #f)
404 (Y-extent-callback . #f)
405 (molecule-callback . ,Line_spanner::brew_molecule)
406 (meta . ,(grob-description line-spanner-interface))
410 (molecule-callback . ,Text_item::brew_molecule)
411 (font-family . roman)
412 (meta . ,(grob-description note-name-interface font-interface))
416 (self-alignment-X . 0)
418 (visibility-lambda . ,begin-of-line-visible)
419 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
420 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
421 (molecule-callback . ,Text_item::brew_molecule)
422 (font-shape . italic)
423 (font-family . roman)
424 (meta . ,(grob-description text-interface font-interface ))
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 (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 . ,Third_spacing_spanner::set_springs)
530 (grace-space-factor . 0.8)
532 ;; TODO: change naming -- unintuitive
533 (arithmetic-basicspace . 2.0)
534 (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))
572 (X-extent-callback . #f)
573 (Y-extent-callback . #f)
575 (meta . ,(grob-description staff-spacing-interface))
578 (X-extent-callback . #f)
579 (Y-extent-callback . #f)
580 (stem-spacing-correction . 0.)
582 (meta . ,(grob-description note-spacing-interface))
586 (molecule-callback . ,Staff_symbol::brew_molecule)
590 (meta . ,(grob-description staff-symbol-interface ))
593 (molecule-callback . ,Text_item::brew_molecule)
595 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
596 (Y-offset-callbacks .
597 (,Side_position_interface::aligned_side
598 ,Side_position_interface::centered_on_parent))
599 (no-spacing-rods . #t)
600 (font-shape . italic)
601 (self-alignment-X . 0)
602 (meta . ,(grob-description text-interface font-interface))
606 (before-line-breaking-callback . ,Stem::before_line_breaking)
607 (molecule-callback . ,Stem::brew_molecule)
609 (beamed-lengths . (0.0 2.5 2.0 1.5))
610 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
612 ;; Stems in unnatural (forced) direction should be shortened,
613 ;; according to [Roush & Gourlay]. Their suggestion to knock off
614 ;; a whole staffspace seems a bit drastical: we'll do half.
616 (lengths . (3.5 3.5 3.5 4.5 5.0))
617 (stem-shorten . (0.5))
618 ; if stem is on middle line, choose this direction.
619 (neutral-direction . -1)
620 (X-offset-callbacks . (,Stem::off_callback))
621 (X-extent-callback . ,Stem::dim_callback)
622 (Y-extent-callback . ,Stem::height)
623 (meta . ,(grob-description stem-interface font-interface))
627 (molecule-callback . ,Stem_tremolo::brew_molecule)
628 (Y-extent-callback . ,Stem_tremolo::height)
629 (X-extent-callback . #f)
631 (beam-width . 2.0) ; staff-space
632 (beam-thickness . 0.42) ; staff-space
633 (beam-space-function . ,default-beam-space-function)
634 (meta . ,(grob-description stem-tremolo-interface ))
638 (meta . ,(grob-description separation-item-interface ))
640 (SeparatingGroupSpanner . (
641 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
642 (meta . ,(grob-description separation-spanner-interface))
646 (no-spacing-rods . #t)
647 (molecule-callback . ,Sustain_pedal::brew_molecule)
648 (self-alignment-X . 0)
650 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
651 (Y-offset-callbacks .
652 (,Side_position_interface::aligned_side
653 ,Side_position_interface::centered_on_parent))
655 (meta . ,(grob-description sustain-pedal-interface side-position-interface font-interface))
658 ;; TODO: should split in 3
659 (SystemStartBrace . (
661 (molecule-callback . ,System_start_delimiter::brew_molecule)
662 (collapse-height . 5.0)
663 (font-family . braces)
664 (Y-extent-callback . #f)
665 (meta . ,(grob-description system-start-delimiter-interface font-interface))
667 (SystemStartBracket . (
668 (Y-extent-callback . #f)
669 (molecule-callback . ,System_start_delimiter::brew_molecule)
675 (bracket-collapse-height . 1)
677 (meta . ,(grob-description system-start-delimiter-interface ))
680 (Y-extent-callback . #f)
681 (molecule-callback . ,System_start_delimiter::brew_molecule)
684 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
685 (meta . ,(grob-description system-start-delimiter-interface ))
689 (molecule-callback . ,Text_item::brew_molecule)
690 (no-spacing-rods . #t)
693 ;; todo: add X self alignment?
695 (font-family . roman)
696 (meta . ,(grob-description text-script-interface text-interface side-position-interface font-interface ))
699 (molecule-callback . ,Text_spanner::brew_molecule)
700 (font-family . roman)
703 ;; urg, only for (de)cresc. text spanners
704 (if-text-padding . 1.0)
708 (meta . ,(grob-description text-spanner-interface font-interface))
711 (molecule-callback . ,Tie::brew_molecule)
712 (spacing-procedure . ,Spanner::set_spacing_rods)
713 (staffline-clearance . 0.35)
714 (details . ((ratio . 0.333) (height-limit . 1.0)))
718 (minimum-length . 2.5)
719 (meta . ,(grob-description tie-interface ))
723 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
724 (meta . ,(grob-description tie-column-interface ))
728 (molecule-callback . ,Time_signature::brew_molecule)
729 (break-align-symbol . Time_signature)
730 (visibility-lambda . ,all-visible)
733 (font-family . number)
734 (meta . ,(grob-description time-signature-interface font-interface))
740 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
741 (molecule-callback . ,Tuplet_bracket::brew_molecule)
742 (font-family . roman)
743 (font-shape . italic)
744 (font-relative-size . -1)
745 (meta . ,(grob-description text-interface
746 tuplet-bracket-interface font-interface))
750 (molecule-callback . ,Text_item::brew_molecule)
751 (font-family . roman)
752 (font-shape . italic)
753 (no-spacing-rods . #t)
754 (self-alignment-X . 0)
756 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
757 (Y-offset-callbacks .
758 (,Side_position_interface::aligned_side
759 ,Side_position_interface::centered_on_parent))
760 (meta . ,(grob-description text-interface font-interface))
764 (molecule-callback . ,Volta_spanner::brew_molecule)
769 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
770 (thickness . 1.6) ; stafflinethickness
771 (height . 2.0) ; staffspace;
773 (font-family . number)
774 (font-relative-size . -2)
775 (meta . ,(grob-description volta-bracket-interface side-position-interface font-interface))
777 (VerticalAlignment . (
779 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
780 (X-extent-callback . #f)
783 (meta . ,(grob-description align-interface axis-group-interface))
785 (VerticalAxisGroup . (
787 (meta . ,(grob-description axis-group-interface))
794 (define (completize-grob-entry x)
795 "transplant assoc key into 'name entry of 'meta of X
797 (let* ((name-sym (car x))
799 (metaentry (cdr (assoc 'meta entry)))
800 (new-metaentry (assoc-set! metaentry 'name name-sym))
803 (cons name-sym (assoc-set! entry 'meta new-metaentry))
806 (set! all-grob-descriptions (map completize-grob-entry all-grob-descriptions))
810 ; (display (map pair? all-grob-descriptions))
813 ;; make sure that \property Foo.Bar =\turnOff doesn't complain
815 (map (lambda (x) (set-object-property! (car x) 'translator-type? list?))
816 all-grob-descriptions)