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)
13 ;;; WARNING: the meta field should be the last one.
15 ;; TODO: junk the meta field in favor of something more compact?
16 (define all-grob-descriptions
19 (molecule-callback . ,Local_key_item::brew_molecule)
20 (X-offset-callbacks . (,Side_position_interface::aligned_side))
21 (after-line-breaking-callback . ,Local_key_item::after_line_breaking)
25 (paren-cautionaries . #t)
27 (meta . ,(grob-description accidentals-interface font-interface side-position-interface))
31 (X-extent-callback . ,Arpeggio::width_callback)
32 (Y-extent-callback . #f)
33 (molecule-callback . ,Arpeggio::brew_molecule)
34 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
35 (X-offset-callbacks . (,Side_position_interface::aligned_side))
37 (staff-position . 0.0)
38 (meta . ,(grob-description arpeggio-interface side-position-interface font-interface))
42 (break-align-symbol . Staff_bar)
44 (break-glyph-function . ,default-break-barline)
45 (bar-size-procedure . ,Bar::get_staff_bar_size)
46 (molecule-callback . ,Bar::brew_molecule)
47 (visibility-lambda . ,all-visible)
49 (before-line-breaking-callback . ,Bar::before_line_breaking)
51 ;; Ross. page 151 lists other values, we opt for a leaner look
55 (hair-thickness . 1.6)
56 (thick-thickness . 6.0)
57 (meta . ,(grob-description bar-line-interface font-interface))
61 (molecule-callback . ,Text_item::brew_molecule)
63 (visibility-lambda . ,begin-of-line-visible)
67 (font-relative-size . -1)
68 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
69 (meta . ,(grob-description
70 side-position-interface
71 text-interface font-interface break-aligned-interface))
75 (molecule-callback . ,brew-bass-figure)
76 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
78 (font-family . number)
79 (font-relative-size . -1)
83 (meta . ,(grob-description text-interface font-interface ))
86 ;; todo: clean this up a bit: the list is getting
88 (molecule-callback . ,Beam::brew_molecule)
89 (y-dy-callbacks . (,Beam::least_squares
90 ,Beam::cancel_suspect_slope
94 ,Beam::do_quantise_y))
96 (thickness . 0.48) ; in staff-space
97 (before-line-breaking-callback . ,Beam::before_line_breaking)
98 (after-line-breaking-callback . ,Beam::after_line_breaking)
99 (neutral-direction . -1)
100 (dir-function . ,beam-dir-majority)
101 (height-quants . ,default-beam-dy-quants)
102 (vertical-position-quant-function . ,default-beam-y-quants)
103 (beamed-stem-shorten . (0.5))
104 (outer-stem-length-limit . 0.2)
106 (flag-width-function . ,default-beam-flag-width-function)
107 (space-function . ,default-beam-space-function)
110 (meta . ,(grob-description beam-interface))
117 (space-alist . ,default-break-align-space-alist)
118 (meta . ,(grob-description
119 axis-group-interface align-interface
126 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
128 (meta . ,(grob-description axis-group-interface))
132 (break-align-symbol . Breathing_sign)
134 (molecule-callback . ,Text_item::brew_molecule)
136 (font-family . music)
137 (text . "scripts-rcomma")
138 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
139 (visibility-lambda . ,begin-of-line-invisible)
140 (meta . ,(grob-description break-aligned-interface text-interface font-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 (neutral-position . 0)
169 (neutral-direction . -1)
170 (adjust-if-on-staffline . #t)
171 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
172 (font-family . music)
173 (meta . ,(grob-description custos-interface staff-symbol-referencer-interface break-aligned-interface) )
180 (X-extent-callback . ,Axis_group_interface::group_extent_callback)
182 (X-offset-callbacks . (,Dot_column::side_position))
183 (meta . ,(grob-description dot-column-interface axis-group-interface))
187 (molecule-callback . ,Dots::brew_molecule)
189 (staff-position . 0.0)
190 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
191 (meta . ,(grob-description font-interface dots-interface ))
194 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
197 (font-family . music)
200 (break-align-symbol . Staff_bar)
201 (visibility-lambda . ,begin-of-line-invisible)
202 (meta . ,(grob-description font-interface percent-repeat-interface))
206 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
207 (molecule-callback . ,Text_item::brew_molecule)
208 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
209 (self-alignment-X . 0)
211 (no-spacing-rods . #t)
212 (script-priority . 100)
214 (font-family . dynamic)
215 (font-shape . italic)
216 (self-alignment-Y . 0)
217 (meta . ,(grob-description font-interface text-interface dynamic-interface))
220 (DynamicLineSpanner . (
223 (minimum-space . 1.2)
225 (meta . ,(grob-description dynamic-interface axis-group-interface side-position-interface))
229 (break-align-symbol . Left_edge_item)
230 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
232 (meta . ,(grob-description break-aligned-interface))
236 (molecule-callback . ,Text_item::brew_molecule)
237 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
240 (self-alignment-X . 0)
241 (self-alignment-Y . 0)
242 (font-family . number)
243 (font-relative-size . -3)
244 (font-shape . upright)
245 (meta . ,(grob-description finger-interface font-interface text-script-interface text-interface side-position-interface))
249 (HaraKiriVerticalGroup . (
250 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
251 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
253 (meta . ,(grob-description axis-group-interface hara-kiri-group-interface))
256 (molecule-callback . ,Hairpin::brew_molecule)
259 (spacing-procedure . ,Spanner::set_spacing_rods)
260 (minimum-length . 2.0)
261 (if-text-padding . 1.0)
262 (width-correct . -1.0)
264 (dash-thickness . 1.2)
266 (self-alignment-Y . 0)
267 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
268 (meta . ,(grob-description hairpin-interface dynamic-interface))
273 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
274 ,Side_position_interface::aligned_on_support_refpoints
277 (self-alignment-Y . 0)
278 (molecule-callback . ,Text_item::brew_molecule)
279 (break-align-symbol . Instrument_name)
280 (visibility-lambda . ,begin-of-line-visible)
282 (font-family . roman)
283 (meta . ,(grob-description font-interface text-interface break-aligned-interface))
287 (molecule-callback . ,Key_item::brew_molecule)
288 (break-align-symbol . Key_item)
289 (visibility-lambda . ,begin-of-line-visible)
291 (meta . ,(grob-description key-signature-interface font-interface break-aligned-interface))
298 (minimum-length . 0.5)
299 (maximum-length . 100)
300 (molecule-callback . ,Hyphen_spanner::brew_molecule)
301 (Y-extent-callback . ,Grob::point_dimension_callback)
302 (meta . ,(grob-description lyric-hyphen-interface ))
307 (meta . ,(grob-description line-of-score-interface axis-group-interface))
311 (molecule-callback . ,Lyric_extender::brew_molecule)
312 (height . 0.8) ; stafflinethickness;
313 (right-trim-amount . 0.5)
314 (Y-extent-callback . ,Grob::point_dimension_callback)
315 (meta . ,(grob-description lyric-extender-interface))
319 (molecule-callback . ,Text_item::brew_molecule)
320 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
321 (self-alignment-X . 0)
324 (ignore-length-mismatch . #f)
325 (begin-alignment . 4)
327 (font-family . roman)
328 (font-shape . upright)
329 (meta . ,(grob-description lyric-syllable-interface text-interface font-interface ))
334 (auto-properties . #f)
336 (porrectus-width . 2.4)
337 (line-thickness . 1.0)
340 (molecule-callback . ,Porrectus::brew_molecule)
341 (meta . ,(grob-description porrectus-interface))
345 (molecule-callback . ,Text_item::brew_molecule)
346 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
347 (self-alignment-X . 0)
351 (font-family . roman)
352 (font-shape . upright)
353 (font-relative-size . 1)
354 (visibility-lambda . ,end-of-line-invisible)
356 (meta . ,(grob-description mark-interface side-position-interface))
359 (MultiMeasureRest . (
360 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
361 (molecule-callback . ,Multi_measure_rest::brew_molecule)
362 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
365 (padding . 2.0) ; staffspace
366 (minimum-width . 12.5) ; staffspace
367 (font-family . number)
368 (font-relative-size . 1)
369 (meta . ,(grob-description multi-measure-rest-interface rest-interface font-interface ))
373 ;; Ugh, should not be hard-coded.
375 (meta . ,(grob-description
376 note-collision-interface axis-group-interface
382 (meta . ,(grob-description axis-group-interface note-column-interface))
387 (molecule-callback . ,Note_head::brew_molecule)
388 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
389 (stem-attachment-function . ,note-head-style->attachment-coordinates)
390 (meta . ,(grob-description rhythmic-head-interface font-interface note-head-interface))
396 (X-extent-callback . #f)
397 (Y-extent-callback . #f)
398 (molecule-callback . ,Line_spanner::brew_molecule)
399 (meta . ,(grob-description line-spanner-interface))
405 (X-extent-callback . #f)
406 (Y-extent-callback . #f)
407 (molecule-callback . ,Line_spanner::brew_molecule)
408 (meta . ,(grob-description line-spanner-interface))
412 (molecule-callback . ,Text_item::brew_molecule)
413 (font-family . roman)
414 (meta . ,(grob-description note-name-interface font-interface))
418 (self-alignment-X . 0)
420 (visibility-lambda . ,begin-of-line-visible)
421 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
422 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
423 (molecule-callback . ,Text_item::brew_molecule)
424 (font-shape . italic)
425 (font-family . roman)
426 (meta . ,(grob-description text-interface font-interface ))
431 ; (molecule-callback . ,Paper_column::brew_molecule) (font-name . "cmr8")
432 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
435 (molecule-callback . ,Slur::brew_molecule)
437 (spacing-procedure . ,Spanner::set_spacing_rods)
438 (minimum-length . 1.5)
439 (after-line-breaking-callback . ,Slur::after_line_breaking)
440 (extremity-rules . ,default-slur-extremity-rules)
441 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
442 (de-uglify-parameters . ( 1.5 0.8 -2.0))
443 (Y-extent-callback . ,Slur::height)
444 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
445 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
446 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
447 (bezier-area-steps . 1.0)))
450 (attachment . (#f . #f))
451 (attachment-offset . ((0 . 0) . (0 . 0)))
453 (meta . ,(grob-description slur-interface))
456 (NonMusicalPaperColumn . (
458 ; (molecule-callback . ,Paper_column::brew_molecule) (font-name . "cmr8")
459 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
463 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
464 (molecule-callback . ,Multi_measure_rest::percent)
467 (minimum-width . 12.5) ; staffspace
468 (font-family . music)
469 (meta . ,(grob-description multi-measure-rest-interface font-interface percent-repeat-interface))
474 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
477 (meta . ,(grob-description percent-repeat-interface))
480 (after-line-breaking-callback . ,Rest::after_line_breaking)
481 (X-extent-callback . ,Rest::extent_callback)
482 (Y-extent-callback . ,Rest::extent_callback)
483 (molecule-callback . ,Rest::brew_molecule)
484 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
485 (minimum-beam-collision-distance . 1.5)
486 (meta . ,(grob-description
487 rhythmic-head-interface
488 staff-symbol-referencer-interface
492 (minimum-distance . 0.75)
493 (meta . ,(grob-description rest-collision-interface ))
497 ;; don't set direction here: it breaks staccato.
498 (molecule-callback . ,Script::brew_molecule)
500 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
501 (before-line-breaking-callback . ,Script::before_line_breaking)
502 (font-family . music)
503 (meta . ,(grob-description script-interface side-position-interface font-interface))
507 (before-line-breaking-callback . ,Script_column::before_line_breaking)
508 (meta . ,(grob-description script-column-interface))
512 (molecule-callback . ,Slur::brew_molecule)
514 (spacing-procedure . ,Spanner::set_spacing_rods)
515 (minimum-length . 1.5)
516 (after-line-breaking-callback . ,Slur::after_line_breaking)
517 (extremity-rules . ,default-slur-extremity-rules)
518 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
519 (de-uglify-parameters . ( 1.5 0.8 -2.0))
520 (Y-extent-callback . ,Slur::height)
521 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
522 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
523 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
524 (bezier-area-steps . 1.0)))
527 (attachment . (#f . #f))
528 (attachment-offset . ((0 . 0) . (0 . 0)))
530 (meta . ,(grob-description slur-interface))
534 (spacing-procedure . ,Third_spacing_spanner::set_springs)
535 (grace-space-factor . 0.8)
537 ;; TODO: change naming -- unintuitive
538 (arithmetic-basicspace . 2.0)
539 (arithmetic-multiplier . ,(* 0.9 1.32))
541 ;; assume that notes at least this long are present.
542 (maximum-duration-for-spacing . ,(make-moment 1 8))
543 (meta . ,(grob-description spacing-spanner-interface))
546 (break-align-symbol . Staff_bar)
547 (bar-size-procedure . ,Span_bar::get_bar_size)
548 (molecule-callback . ,Span_bar::brew_molecule)
549 (visibility-lambda . ,begin-of-line-invisible)
550 (X-extent-callback . ,Span_bar::width_callback)
553 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
557 ;; Ross. page 151 lists other values, we opt for a leaner look
561 (hair-thickness . 1.6)
562 (thick-thickness . 6.0)
563 (meta . ,(grob-description span-bar-interface bar-line-interface ))
568 (molecule-callback . ,Text_item::brew_molecule)
569 (break-align-symbol . Clef_item)
570 (visibility-lambda . ,begin-of-line-visible)
571 (font-family . roman)
572 (meta . ,(grob-description break-aligned-interface text-interface font-interface))
577 (X-extent-callback . #f)
578 (Y-extent-callback . #f)
580 (meta . ,(grob-description staff-spacing-interface))
583 (X-extent-callback . #f)
584 (Y-extent-callback . #f)
585 (stem-spacing-correction . 0.5)
587 (meta . ,(grob-description note-spacing-interface))
591 (molecule-callback . ,Staff_symbol::brew_molecule)
595 (meta . ,(grob-description staff-symbol-interface ))
598 (molecule-callback . ,Text_item::brew_molecule)
600 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
601 (Y-offset-callbacks .
602 (,Side_position_interface::aligned_side
603 ,Side_position_interface::centered_on_parent))
604 (no-spacing-rods . #t)
605 (font-shape . italic)
606 (self-alignment-X . 0)
607 (meta . ,(grob-description text-interface font-interface))
611 (before-line-breaking-callback . ,Stem::before_line_breaking)
612 (molecule-callback . ,Stem::brew_molecule)
614 (beamed-lengths . (0.0 2.5 2.0 1.5))
615 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
617 ;; Stems in unnatural (forced) direction should be shortened,
618 ;; according to [Roush & Gourlay]. Their suggestion to knock off
619 ;; a whole staffspace seems a bit drastical: we'll do half.
621 (lengths . (3.5 3.5 3.5 4.5 5.0))
622 (stem-shorten . (0.5))
623 ; if stem is on middle line, choose this direction.
624 (neutral-direction . -1)
625 (X-offset-callbacks . (,Stem::off_callback))
626 (X-extent-callback . ,Stem::dim_callback)
627 (Y-extent-callback . ,Stem::height)
628 (adjust-if-on-staffline . #t)
629 (font-family . music)
630 (meta . ,(grob-description stem-interface font-interface))
634 (molecule-callback . ,Stem_tremolo::brew_molecule)
635 (Y-extent-callback . ,Stem_tremolo::height)
636 (X-extent-callback . #f)
638 (beam-width . 2.0) ; staff-space
639 (beam-thickness . 0.42) ; staff-space
640 (beam-space-function . ,default-beam-space-function)
641 (meta . ,(grob-description stem-tremolo-interface ))
645 (meta . ,(grob-description separation-item-interface ))
647 (SeparatingGroupSpanner . (
648 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
649 (meta . ,(grob-description separation-spanner-interface))
653 (no-spacing-rods . #t)
654 (molecule-callback . ,Sustain_pedal::brew_molecule)
655 (self-alignment-X . 0)
657 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
658 (Y-offset-callbacks .
659 (,Side_position_interface::aligned_side
660 ,Side_position_interface::centered_on_parent))
662 (meta . ,(grob-description sustain-pedal-interface side-position-interface font-interface))
665 (SystemStartBrace . (
667 (molecule-callback . ,System_start_delimiter::brew_molecule)
668 (collapse-height . 5.0)
669 (font-family . braces)
670 (Y-extent-callback . #f)
671 (meta . ,(grob-description system-start-delimiter-interface font-interface))
673 (SystemStartBracket . (
674 (Y-extent-callback . #f)
675 (molecule-callback . ,System_start_delimiter::brew_molecule)
681 (bracket-collapse-height . 1)
683 (meta . ,(grob-description system-start-delimiter-interface ))
686 (Y-extent-callback . #f)
687 (molecule-callback . ,System_start_delimiter::brew_molecule)
690 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
691 (meta . ,(grob-description system-start-delimiter-interface ))
695 (molecule-callback . ,Text_item::brew_molecule)
696 (no-spacing-rods . #t)
699 ;; todo: add X self alignment?
701 (font-family . roman)
702 (meta . ,(grob-description text-script-interface text-interface side-position-interface font-interface ))
705 (molecule-callback . ,Text_spanner::brew_molecule)
706 (font-family . roman)
709 ;; urg, only for (de)cresc. text spanners
710 (if-text-padding . 1.0)
714 (meta . ,(grob-description text-spanner-interface font-interface))
717 (molecule-callback . ,Tie::brew_molecule)
718 (spacing-procedure . ,Spanner::set_spacing_rods)
719 (staffline-clearance . 0.35)
720 (details . ((ratio . 0.333) (height-limit . 1.0)))
724 (minimum-length . 2.5)
725 (meta . ,(grob-description tie-interface ))
729 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
730 (meta . ,(grob-description tie-column-interface ))
734 (molecule-callback . ,Time_signature::brew_molecule)
735 (break-align-symbol . Time_signature)
736 (visibility-lambda . ,all-visible)
739 (font-family . number)
740 (meta . ,(grob-description time-signature-interface font-interface))
746 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
747 (molecule-callback . ,Tuplet_bracket::brew_molecule)
748 (font-family . roman)
749 (font-shape . italic)
750 (font-relative-size . -1)
751 (meta . ,(grob-description text-interface
752 tuplet-bracket-interface font-interface))
756 (molecule-callback . ,Text_item::brew_molecule)
757 (font-family . roman)
758 (font-shape . italic)
759 (no-spacing-rods . #t)
760 (self-alignment-X . 0)
762 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
763 (Y-offset-callbacks .
764 (,Side_position_interface::aligned_side
765 ,Side_position_interface::centered_on_parent))
766 (meta . ,(grob-description text-interface font-interface))
770 (molecule-callback . ,Volta_spanner::brew_molecule)
775 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
776 (thickness . 1.6) ; stafflinethickness
777 (height . 2.0) ; staffspace;
779 (font-family . number)
780 (font-relative-size . -2)
781 (meta . ,(grob-description volta-bracket-interface side-position-interface font-interface))
783 (VerticalAlignment . (
785 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
786 (X-extent-callback . #f)
789 (meta . ,(grob-description align-interface axis-group-interface))
791 (VerticalAxisGroup . (
793 (meta . ,(grob-description axis-group-interface))
800 (define (completize-grob-entry x)
801 "transplant assoc key into 'name entry of 'meta of X
803 (let* ((name-sym (car x))
805 (metaentry (cdr (assoc 'meta entry)))
806 (new-metaentry (assoc-set! metaentry 'name name-sym))
809 (cons name-sym (assoc-set! entry 'meta new-metaentry))
812 (set! all-grob-descriptions (map completize-grob-entry all-grob-descriptions))
816 ; (display (map pair? all-grob-descriptions))
819 ;; make sure that \property Foo.Bar =\turnOff doesn't complain
822 ; (display (car x)) (newline)
824 (set-object-property! (car x) 'translation-type? list?))
825 all-grob-descriptions)