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 . ,Text_item::brew_molecule)
141 (font-family . music)
142 (text . "scripts-rcomma")
143 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
144 (visibility-lambda . ,begin-of-line-invisible)
145 (meta . ,(grob-description break-aligned-interface text-interface font-interface))
149 (molecule-callback . ,Clef::brew_molecule)
150 (before-line-breaking-callback . ,Clef::before_line_breaking)
152 (font-family . music)
153 (break-align-symbol . Clef_item)
154 (visibility-lambda . ,begin-of-line-visible)
155 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
156 (meta . ,(grob-description clef-interface font-interface break-aligned-interface ))
160 (molecule-callback . ,Chord_name::brew_molecule)
161 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
162 (chord-name-function . ,default-chord-name-function)
163 (font-family . roman)
164 (meta . ,(grob-description font-interface text-interface chord-name-interface))
168 (break-align-symbol . Custos)
170 (molecule-callback . ,Custos::brew_molecule)
171 (visibility-lambda . ,end-of-line-visible)
173 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
174 (meta . ,(grob-description custos-interface staff-symbol-referencer-interface break-aligned-interface) )
181 (X-extent-callback . ,Axis_group_interface::group_extent_callback)
183 (X-offset-callbacks . (,Dot_column::side_position))
184 (meta . ,(grob-description dot-column-interface axis-group-interface))
188 (molecule-callback . ,Dots::brew_molecule)
190 (staff-position . 0.0)
191 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
192 (meta . ,(grob-description font-interface dots-interface ))
195 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
198 (font-family . music)
201 (break-align-symbol . Staff_bar)
202 (visibility-lambda . ,begin-of-line-invisible)
203 (meta . ,(grob-description font-interface percent-repeat-interface))
207 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
208 (molecule-callback . ,Text_item::brew_molecule)
209 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
210 (self-alignment-X . 0)
212 (no-spacing-rods . #t)
213 (script-priority . 100)
215 (font-family . dynamic)
216 (font-shape . italic)
217 (self-alignment-Y . 0)
218 (meta . ,(grob-description font-interface text-interface dynamic-interface))
221 (DynamicLineSpanner . (
224 (minimum-space . 1.2)
226 (meta . ,(grob-description dynamic-interface axis-group-interface side-position-interface))
230 (break-align-symbol . Left_edge_item)
231 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
233 (meta . ,(grob-description break-aligned-interface))
237 (molecule-callback . ,Text_item::brew_molecule)
238 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
241 (self-alignment-X . 0)
242 (self-alignment-Y . 0)
243 (font-family . number)
244 (font-relative-size . -3)
245 (font-shape . upright)
246 (meta . ,(grob-description finger-interface font-interface text-script-interface text-interface side-position-interface))
250 (HaraKiriVerticalGroup . (
251 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
252 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
254 (meta . ,(grob-description axis-group-interface hara-kiri-group-interface))
257 (molecule-callback . ,Hairpin::brew_molecule)
260 (spacing-procedure . ,Spanner::set_spacing_rods)
261 (minimum-length . 2.0)
262 (if-text-padding . 1.0)
263 (width-correct . -1.0)
265 (dash-thickness . 1.2)
267 (self-alignment-Y . 0)
268 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
269 (meta . ,(grob-description hairpin-interface dynamic-interface))
274 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
275 ,Side_position_interface::aligned_on_support_refpoints
278 (self-alignment-Y . 0)
279 (molecule-callback . ,Text_item::brew_molecule)
280 (break-align-symbol . Instrument_name)
281 (visibility-lambda . ,begin-of-line-visible)
283 (font-family . roman)
284 (meta . ,(grob-description font-interface text-interface break-aligned-interface))
288 (molecule-callback . ,Key_item::brew_molecule)
289 (break-align-symbol . Key_item)
290 (visibility-lambda . ,begin-of-line-visible)
292 (meta . ,(grob-description key-signature-interface font-interface break-aligned-interface))
299 (minimum-length . 0.5)
300 (maximum-length . 100)
301 (molecule-callback . ,Hyphen_spanner::brew_molecule)
302 (Y-extent-callback . ,Grob::point_dimension_callback)
303 (meta . ,(grob-description lyric-hyphen-interface ))
308 (meta . ,(grob-description line-of-score-interface axis-group-interface))
312 (molecule-callback . ,Lyric_extender::brew_molecule)
313 (height . 0.8) ; stafflinethickness;
314 (right-trim-amount . 0.5)
315 (Y-extent-callback . ,Grob::point_dimension_callback)
316 (meta . ,(grob-description lyric-extender-interface))
320 (molecule-callback . ,Text_item::brew_molecule)
321 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
322 (self-alignment-X . 0)
325 (ignore-length-mismatch . #f)
326 (begin-alignment . 4)
328 (font-family . roman)
329 (font-shape . upright)
330 (meta . ,(grob-description lyric-syllable-interface text-interface font-interface ))
335 (auto-properties . #f)
337 (porrectus-width . 2.4)
338 (line-thickness . 1.0)
341 (molecule-callback . ,Porrectus::brew_molecule)
342 (meta . ,(grob-description porrectus-interface))
346 (molecule-callback . ,Text_item::brew_molecule)
347 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
348 (self-alignment-X . 0)
352 (font-family . roman)
353 (font-shape . upright)
354 (font-relative-size . 1)
355 (visibility-lambda . ,end-of-line-invisible)
357 (meta . ,(grob-description mark-interface side-position-interface))
360 (MultiMeasureRest . (
361 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
362 (molecule-callback . ,Multi_measure_rest::brew_molecule)
363 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
366 (padding . 2.0) ; staffspace
367 (minimum-width . 12.5) ; staffspace
368 (font-family . number)
369 (font-relative-size . 1)
370 (meta . ,(grob-description multi-measure-rest-interface rest-interface font-interface ))
374 ;; Ugh, should not be hard-coded.
376 (meta . ,(grob-description
377 note-collision-interface axis-group-interface
383 (meta . ,(grob-description axis-group-interface note-column-interface))
388 (molecule-callback . ,Note_head::brew_molecule)
389 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
390 (stem-attachment-function . ,note-head-style->attachment-coordinates)
391 (meta . ,(grob-description rhythmic-head-interface font-interface note-head-interface))
397 (X-extent-callback . #f)
398 (Y-extent-callback . #f)
399 (molecule-callback . ,Line_spanner::brew_molecule)
400 (meta . ,(grob-description line-spanner-interface))
406 (X-extent-callback . #f)
407 (Y-extent-callback . #f)
408 (molecule-callback . ,Line_spanner::brew_molecule)
409 (meta . ,(grob-description line-spanner-interface))
413 (molecule-callback . ,Text_item::brew_molecule)
414 (font-family . roman)
415 (meta . ,(grob-description note-name-interface font-interface))
419 (self-alignment-X . 0)
421 (visibility-lambda . ,begin-of-line-visible)
422 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
423 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
424 (molecule-callback . ,Text_item::brew_molecule)
425 (font-shape . italic)
426 (font-family . roman)
427 (meta . ,(grob-description text-interface font-interface ))
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 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
462 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
463 (molecule-callback . ,Multi_measure_rest::percent)
466 (minimum-width . 12.5) ; staffspace
467 (font-family . music)
468 (meta . ,(grob-description multi-measure-rest-interface font-interface percent-repeat-interface))
473 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
476 (meta . ,(grob-description percent-repeat-interface))
479 (after-line-breaking-callback . ,Rest::after_line_breaking)
480 (X-extent-callback . ,Rest::extent_callback)
481 (Y-extent-callback . ,Rest::extent_callback)
482 (molecule-callback . ,Rest::brew_molecule)
483 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
484 (minimum-beam-collision-distance . 1.5)
485 (meta . ,(grob-description
486 rhythmic-head-interface
487 staff-symbol-referencer-interface
491 (minimum-distance . 0.75)
492 (meta . ,(grob-description rest-collision-interface ))
496 ;; don't set direction here: it breaks staccato.
497 (molecule-callback . ,Script::brew_molecule)
499 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
500 (before-line-breaking-callback . ,Script::before_line_breaking)
501 (meta . ,(grob-description script-interface side-position-interface font-interface))
505 (before-line-breaking-callback . ,Script_column::before_line_breaking)
506 (meta . ,(grob-description script-column-interface))
510 (molecule-callback . ,Slur::brew_molecule)
512 (spacing-procedure . ,Spanner::set_spacing_rods)
513 (minimum-length . 1.5)
514 (after-line-breaking-callback . ,Slur::after_line_breaking)
515 (extremity-rules . ,default-slur-extremity-rules)
516 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
517 (de-uglify-parameters . ( 1.5 0.8 -2.0))
518 (Y-extent-callback . ,Slur::height)
519 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
520 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
521 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
522 (bezier-area-steps . 1.0)))
525 (attachment . (#f . #f))
526 (attachment-offset . ((0 . 0) . (0 . 0)))
528 (meta . ,(grob-description slur-interface))
532 (spacing-procedure . ,Third_spacing_spanner::set_springs)
533 (grace-space-factor . 0.8)
535 ;; TODO: change naming -- unintuitive
536 (arithmetic-basicspace . 2.0)
537 (arithmetic-multiplier . ,(* 0.9 1.32))
539 ;; assume that notes at least this long are present.
540 (maximum-duration-for-spacing . ,(make-moment 1 8))
541 (meta . ,(grob-description spacing-spanner-interface))
544 (break-align-symbol . Staff_bar)
545 (bar-size-procedure . ,Span_bar::get_bar_size)
546 (molecule-callback . ,Span_bar::brew_molecule)
547 (visibility-lambda . ,begin-of-line-invisible)
548 (X-extent-callback . ,Span_bar::width_callback)
551 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
555 ;; Ross. page 151 lists other values, we opt for a leaner look
559 (hair-thickness . 1.6)
560 (thick-thickness . 6.0)
561 (meta . ,(grob-description span-bar-interface bar-line-interface ))
566 (molecule-callback . ,Text_item::brew_molecule)
567 (break-align-symbol . Clef_item)
568 (visibility-lambda . ,begin-of-line-visible)
569 (font-family . roman)
570 (meta . ,(grob-description break-aligned-interface text-interface font-interface))
575 (X-extent-callback . #f)
576 (Y-extent-callback . #f)
578 (meta . ,(grob-description staff-spacing-interface))
581 (X-extent-callback . #f)
582 (Y-extent-callback . #f)
583 (stem-spacing-correction . 0.)
585 (meta . ,(grob-description note-spacing-interface))
589 (molecule-callback . ,Staff_symbol::brew_molecule)
593 (meta . ,(grob-description staff-symbol-interface ))
596 (molecule-callback . ,Text_item::brew_molecule)
598 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
599 (Y-offset-callbacks .
600 (,Side_position_interface::aligned_side
601 ,Side_position_interface::centered_on_parent))
602 (no-spacing-rods . #t)
603 (font-shape . italic)
604 (self-alignment-X . 0)
605 (meta . ,(grob-description text-interface font-interface))
609 (before-line-breaking-callback . ,Stem::before_line_breaking)
610 (molecule-callback . ,Stem::brew_molecule)
612 (beamed-lengths . (0.0 2.5 2.0 1.5))
613 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
615 ;; Stems in unnatural (forced) direction should be shortened,
616 ;; according to [Roush & Gourlay]. Their suggestion to knock off
617 ;; a whole staffspace seems a bit drastical: we'll do half.
619 (lengths . (3.5 3.5 3.5 4.5 5.0))
620 (stem-shorten . (0.5))
621 ; if stem is on middle line, choose this direction.
622 (neutral-direction . -1)
623 (X-offset-callbacks . (,Stem::off_callback))
624 (X-extent-callback . ,Stem::dim_callback)
625 (Y-extent-callback . ,Stem::height)
626 (meta . ,(grob-description stem-interface font-interface))
630 (molecule-callback . ,Stem_tremolo::brew_molecule)
631 (Y-extent-callback . ,Stem_tremolo::height)
632 (X-extent-callback . #f)
634 (beam-width . 2.0) ; staff-space
635 (beam-thickness . 0.42) ; staff-space
636 (beam-space-function . ,default-beam-space-function)
637 (meta . ,(grob-description stem-tremolo-interface ))
641 (meta . ,(grob-description separation-item-interface ))
643 (SeparatingGroupSpanner . (
644 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
645 (meta . ,(grob-description separation-spanner-interface))
649 (no-spacing-rods . #t)
650 (molecule-callback . ,Sustain_pedal::brew_molecule)
651 (self-alignment-X . 0)
653 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
654 (Y-offset-callbacks .
655 (,Side_position_interface::aligned_side
656 ,Side_position_interface::centered_on_parent))
658 (meta . ,(grob-description sustain-pedal-interface side-position-interface font-interface))
661 ;; TODO: should split in 3
662 (SystemStartBrace . (
664 (molecule-callback . ,System_start_delimiter::brew_molecule)
665 (collapse-height . 5.0)
666 (font-family . braces)
667 (Y-extent-callback . #f)
668 (meta . ,(grob-description system-start-delimiter-interface font-interface))
670 (SystemStartBracket . (
671 (Y-extent-callback . #f)
672 (molecule-callback . ,System_start_delimiter::brew_molecule)
678 (bracket-collapse-height . 1)
680 (meta . ,(grob-description system-start-delimiter-interface ))
683 (Y-extent-callback . #f)
684 (molecule-callback . ,System_start_delimiter::brew_molecule)
687 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
688 (meta . ,(grob-description system-start-delimiter-interface ))
692 (molecule-callback . ,Text_item::brew_molecule)
693 (no-spacing-rods . #t)
696 ;; todo: add X self alignment?
698 (font-family . roman)
699 (meta . ,(grob-description text-script-interface text-interface side-position-interface font-interface ))
702 (molecule-callback . ,Text_spanner::brew_molecule)
703 (font-family . roman)
706 ;; urg, only for (de)cresc. text spanners
707 (if-text-padding . 1.0)
711 (meta . ,(grob-description text-spanner-interface font-interface))
714 (molecule-callback . ,Tie::brew_molecule)
715 (spacing-procedure . ,Spanner::set_spacing_rods)
716 (staffline-clearance . 0.35)
717 (details . ((ratio . 0.333) (height-limit . 1.0)))
721 (minimum-length . 2.5)
722 (meta . ,(grob-description tie-interface ))
726 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
727 (meta . ,(grob-description tie-column-interface ))
731 (molecule-callback . ,Time_signature::brew_molecule)
732 (break-align-symbol . Time_signature)
733 (visibility-lambda . ,all-visible)
736 (font-family . number)
737 (meta . ,(grob-description time-signature-interface font-interface))
743 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
744 (molecule-callback . ,Tuplet_bracket::brew_molecule)
745 (font-family . roman)
746 (font-shape . italic)
747 (font-relative-size . -1)
748 (meta . ,(grob-description text-interface
749 tuplet-bracket-interface font-interface))
753 (molecule-callback . ,Text_item::brew_molecule)
754 (font-family . roman)
755 (font-shape . italic)
756 (no-spacing-rods . #t)
757 (self-alignment-X . 0)
759 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
760 (Y-offset-callbacks .
761 (,Side_position_interface::aligned_side
762 ,Side_position_interface::centered_on_parent))
763 (meta . ,(grob-description text-interface font-interface))
767 (molecule-callback . ,Volta_spanner::brew_molecule)
772 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
773 (thickness . 1.6) ; stafflinethickness
774 (height . 2.0) ; staffspace;
776 (font-family . number)
777 (font-relative-size . -2)
778 (meta . ,(grob-description volta-bracket-interface side-position-interface font-interface))
780 (VerticalAlignment . (
782 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
783 (X-extent-callback . #f)
786 (meta . ,(grob-description align-interface axis-group-interface))
788 (VerticalAxisGroup . (
790 (meta . ,(grob-description axis-group-interface))
797 (define (completize-grob-entry x)
798 "transplant assoc key into 'name entry of 'meta of X
800 (let* ((name-sym (car x))
802 (metaentry (cdr (assoc 'meta entry)))
803 (new-metaentry (assoc-set! metaentry 'name name-sym))
806 (cons name-sym (assoc-set! entry 'meta new-metaentry))
809 (set! all-grob-descriptions (map completize-grob-entry all-grob-descriptions))
813 ; (display (map pair? all-grob-descriptions))
816 ;; make sure that \property Foo.Bar =\turnOff doesn't complain
818 (map (lambda (x) (set-object-property! (car x) 'translator-type? list?))
819 all-grob-descriptions)