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 (font-family . music)
175 (meta . ,(grob-description custos-interface staff-symbol-referencer-interface break-aligned-interface) )
182 (X-extent-callback . ,Axis_group_interface::group_extent_callback)
184 (X-offset-callbacks . (,Dot_column::side_position))
185 (meta . ,(grob-description dot-column-interface axis-group-interface))
189 (molecule-callback . ,Dots::brew_molecule)
191 (staff-position . 0.0)
192 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
193 (meta . ,(grob-description font-interface dots-interface ))
196 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
199 (font-family . music)
202 (break-align-symbol . Staff_bar)
203 (visibility-lambda . ,begin-of-line-invisible)
204 (meta . ,(grob-description font-interface percent-repeat-interface))
208 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
209 (molecule-callback . ,Text_item::brew_molecule)
210 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
211 (self-alignment-X . 0)
213 (no-spacing-rods . #t)
214 (script-priority . 100)
216 (font-family . dynamic)
217 (font-shape . italic)
218 (self-alignment-Y . 0)
219 (meta . ,(grob-description font-interface text-interface dynamic-interface))
222 (DynamicLineSpanner . (
225 (minimum-space . 1.2)
227 (meta . ,(grob-description dynamic-interface axis-group-interface side-position-interface))
231 (break-align-symbol . Left_edge_item)
232 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
234 (meta . ,(grob-description break-aligned-interface))
238 (molecule-callback . ,Text_item::brew_molecule)
239 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
242 (self-alignment-X . 0)
243 (self-alignment-Y . 0)
244 (font-family . number)
245 (font-relative-size . -3)
246 (font-shape . upright)
247 (meta . ,(grob-description finger-interface font-interface text-script-interface text-interface side-position-interface))
251 (HaraKiriVerticalGroup . (
252 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
253 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
255 (meta . ,(grob-description axis-group-interface hara-kiri-group-interface))
258 (molecule-callback . ,Hairpin::brew_molecule)
261 (spacing-procedure . ,Spanner::set_spacing_rods)
262 (minimum-length . 2.0)
263 (if-text-padding . 1.0)
264 (width-correct . -1.0)
266 (dash-thickness . 1.2)
268 (self-alignment-Y . 0)
269 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
270 (meta . ,(grob-description hairpin-interface dynamic-interface))
275 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
276 ,Side_position_interface::aligned_on_support_refpoints
279 (self-alignment-Y . 0)
280 (molecule-callback . ,Text_item::brew_molecule)
281 (break-align-symbol . Instrument_name)
282 (visibility-lambda . ,begin-of-line-visible)
284 (font-family . roman)
285 (meta . ,(grob-description font-interface text-interface break-aligned-interface))
289 (molecule-callback . ,Key_item::brew_molecule)
290 (break-align-symbol . Key_item)
291 (visibility-lambda . ,begin-of-line-visible)
293 (meta . ,(grob-description key-signature-interface font-interface break-aligned-interface))
300 (minimum-length . 0.5)
301 (maximum-length . 100)
302 (molecule-callback . ,Hyphen_spanner::brew_molecule)
303 (Y-extent-callback . ,Grob::point_dimension_callback)
304 (meta . ,(grob-description lyric-hyphen-interface ))
309 (meta . ,(grob-description line-of-score-interface axis-group-interface))
313 (molecule-callback . ,Lyric_extender::brew_molecule)
314 (height . 0.8) ; stafflinethickness;
315 (right-trim-amount . 0.5)
316 (Y-extent-callback . ,Grob::point_dimension_callback)
317 (meta . ,(grob-description lyric-extender-interface))
321 (molecule-callback . ,Text_item::brew_molecule)
322 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
323 (self-alignment-X . 0)
326 (ignore-length-mismatch . #f)
327 (begin-alignment . 4)
329 (font-family . roman)
330 (font-shape . upright)
331 (meta . ,(grob-description lyric-syllable-interface text-interface font-interface ))
336 (auto-properties . #f)
338 (porrectus-width . 2.4)
339 (line-thickness . 1.0)
342 (molecule-callback . ,Porrectus::brew_molecule)
343 (meta . ,(grob-description porrectus-interface))
347 (molecule-callback . ,Text_item::brew_molecule)
348 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
349 (self-alignment-X . 0)
353 (font-family . roman)
354 (font-shape . upright)
355 (font-relative-size . 1)
356 (visibility-lambda . ,end-of-line-invisible)
358 (meta . ,(grob-description mark-interface side-position-interface))
361 (MultiMeasureRest . (
362 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
363 (molecule-callback . ,Multi_measure_rest::brew_molecule)
364 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
367 (padding . 2.0) ; staffspace
368 (minimum-width . 12.5) ; staffspace
369 (font-family . number)
370 (font-relative-size . 1)
371 (meta . ,(grob-description multi-measure-rest-interface rest-interface font-interface ))
375 ;; Ugh, should not be hard-coded.
377 (meta . ,(grob-description
378 note-collision-interface axis-group-interface
384 (meta . ,(grob-description axis-group-interface note-column-interface))
389 (molecule-callback . ,Note_head::brew_molecule)
390 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
391 (stem-attachment-function . ,note-head-style->attachment-coordinates)
392 (meta . ,(grob-description rhythmic-head-interface font-interface note-head-interface))
398 (X-extent-callback . #f)
399 (Y-extent-callback . #f)
400 (molecule-callback . ,Line_spanner::brew_molecule)
401 (meta . ,(grob-description line-spanner-interface))
407 (X-extent-callback . #f)
408 (Y-extent-callback . #f)
409 (molecule-callback . ,Line_spanner::brew_molecule)
410 (meta . ,(grob-description line-spanner-interface))
414 (molecule-callback . ,Text_item::brew_molecule)
415 (font-family . roman)
416 (meta . ,(grob-description note-name-interface font-interface))
420 (self-alignment-X . 0)
422 (visibility-lambda . ,begin-of-line-visible)
423 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
424 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
425 (molecule-callback . ,Text_item::brew_molecule)
426 (font-shape . italic)
427 (font-family . roman)
428 (meta . ,(grob-description text-interface font-interface ))
433 ; (molecule-callback . ,Paper_column::brew_molecule) (font-name . "cmr8")
434 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
437 (molecule-callback . ,Slur::brew_molecule)
439 (spacing-procedure . ,Spanner::set_spacing_rods)
440 (minimum-length . 1.5)
441 (after-line-breaking-callback . ,Slur::after_line_breaking)
442 (extremity-rules . ,default-slur-extremity-rules)
443 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
444 (de-uglify-parameters . ( 1.5 0.8 -2.0))
445 (Y-extent-callback . ,Slur::height)
446 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
447 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
448 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
449 (bezier-area-steps . 1.0)))
452 (attachment . (#f . #f))
453 (attachment-offset . ((0 . 0) . (0 . 0)))
455 (meta . ,(grob-description slur-interface))
458 (NonMusicalPaperColumn . (
460 ; (molecule-callback . ,Paper_column::brew_molecule) (font-name . "cmr8")
461 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
465 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
466 (molecule-callback . ,Multi_measure_rest::percent)
469 (minimum-width . 12.5) ; staffspace
470 (font-family . music)
471 (meta . ,(grob-description multi-measure-rest-interface font-interface percent-repeat-interface))
476 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
479 (meta . ,(grob-description percent-repeat-interface))
482 (after-line-breaking-callback . ,Rest::after_line_breaking)
483 (X-extent-callback . ,Rest::extent_callback)
484 (Y-extent-callback . ,Rest::extent_callback)
485 (molecule-callback . ,Rest::brew_molecule)
486 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
487 (minimum-beam-collision-distance . 1.5)
488 (meta . ,(grob-description
489 rhythmic-head-interface
490 staff-symbol-referencer-interface
494 (minimum-distance . 0.75)
495 (meta . ,(grob-description rest-collision-interface ))
499 ;; don't set direction here: it breaks staccato.
500 (molecule-callback . ,Script::brew_molecule)
502 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
503 (before-line-breaking-callback . ,Script::before_line_breaking)
504 (meta . ,(grob-description script-interface side-position-interface font-interface))
508 (before-line-breaking-callback . ,Script_column::before_line_breaking)
509 (meta . ,(grob-description script-column-interface))
513 (molecule-callback . ,Slur::brew_molecule)
515 (spacing-procedure . ,Spanner::set_spacing_rods)
516 (minimum-length . 1.5)
517 (after-line-breaking-callback . ,Slur::after_line_breaking)
518 (extremity-rules . ,default-slur-extremity-rules)
519 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
520 (de-uglify-parameters . ( 1.5 0.8 -2.0))
521 (Y-extent-callback . ,Slur::height)
522 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
523 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
524 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
525 (bezier-area-steps . 1.0)))
528 (attachment . (#f . #f))
529 (attachment-offset . ((0 . 0) . (0 . 0)))
531 (meta . ,(grob-description slur-interface))
535 (spacing-procedure . ,Third_spacing_spanner::set_springs)
536 (grace-space-factor . 0.8)
538 ;; TODO: change naming -- unintuitive
539 (arithmetic-basicspace . 2.0)
540 (arithmetic-multiplier . ,(* 0.9 1.32))
542 ;; assume that notes at least this long are present.
543 (maximum-duration-for-spacing . ,(make-moment 1 8))
544 (meta . ,(grob-description spacing-spanner-interface))
547 (break-align-symbol . Staff_bar)
548 (bar-size-procedure . ,Span_bar::get_bar_size)
549 (molecule-callback . ,Span_bar::brew_molecule)
550 (visibility-lambda . ,begin-of-line-invisible)
551 (X-extent-callback . ,Span_bar::width_callback)
554 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
558 ;; Ross. page 151 lists other values, we opt for a leaner look
562 (hair-thickness . 1.6)
563 (thick-thickness . 6.0)
564 (meta . ,(grob-description span-bar-interface bar-line-interface ))
569 (molecule-callback . ,Text_item::brew_molecule)
570 (break-align-symbol . Clef_item)
571 (visibility-lambda . ,begin-of-line-visible)
572 (font-family . roman)
573 (meta . ,(grob-description break-aligned-interface text-interface font-interface))
578 (X-extent-callback . #f)
579 (Y-extent-callback . #f)
581 (meta . ,(grob-description staff-spacing-interface))
584 (X-extent-callback . #f)
585 (Y-extent-callback . #f)
586 (stem-spacing-correction . 0.)
588 (meta . ,(grob-description note-spacing-interface))
592 (molecule-callback . ,Staff_symbol::brew_molecule)
596 (meta . ,(grob-description staff-symbol-interface ))
599 (molecule-callback . ,Text_item::brew_molecule)
601 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
602 (Y-offset-callbacks .
603 (,Side_position_interface::aligned_side
604 ,Side_position_interface::centered_on_parent))
605 (no-spacing-rods . #t)
606 (font-shape . italic)
607 (self-alignment-X . 0)
608 (meta . ,(grob-description text-interface font-interface))
612 (before-line-breaking-callback . ,Stem::before_line_breaking)
613 (molecule-callback . ,Stem::brew_molecule)
615 (beamed-lengths . (0.0 2.5 2.0 1.5))
616 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
618 ;; Stems in unnatural (forced) direction should be shortened,
619 ;; according to [Roush & Gourlay]. Their suggestion to knock off
620 ;; a whole staffspace seems a bit drastical: we'll do half.
622 (lengths . (3.5 3.5 3.5 4.5 5.0))
623 (stem-shorten . (0.5))
624 ; if stem is on middle line, choose this direction.
625 (neutral-direction . -1)
626 (X-offset-callbacks . (,Stem::off_callback))
627 (X-extent-callback . ,Stem::dim_callback)
628 (Y-extent-callback . ,Stem::height)
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 ;; TODO: should split in 3
666 (SystemStartBrace . (
668 (molecule-callback . ,System_start_delimiter::brew_molecule)
669 (collapse-height . 5.0)
670 (font-family . braces)
671 (Y-extent-callback . #f)
672 (meta . ,(grob-description system-start-delimiter-interface font-interface))
674 (SystemStartBracket . (
675 (Y-extent-callback . #f)
676 (molecule-callback . ,System_start_delimiter::brew_molecule)
682 (bracket-collapse-height . 1)
684 (meta . ,(grob-description system-start-delimiter-interface ))
687 (Y-extent-callback . #f)
688 (molecule-callback . ,System_start_delimiter::brew_molecule)
691 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
692 (meta . ,(grob-description system-start-delimiter-interface ))
696 (molecule-callback . ,Text_item::brew_molecule)
697 (no-spacing-rods . #t)
700 ;; todo: add X self alignment?
702 (font-family . roman)
703 (meta . ,(grob-description text-script-interface text-interface side-position-interface font-interface ))
706 (molecule-callback . ,Text_spanner::brew_molecule)
707 (font-family . roman)
710 ;; urg, only for (de)cresc. text spanners
711 (if-text-padding . 1.0)
715 (meta . ,(grob-description text-spanner-interface font-interface))
718 (molecule-callback . ,Tie::brew_molecule)
719 (spacing-procedure . ,Spanner::set_spacing_rods)
720 (staffline-clearance . 0.35)
721 (details . ((ratio . 0.333) (height-limit . 1.0)))
725 (minimum-length . 2.5)
726 (meta . ,(grob-description tie-interface ))
730 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
731 (meta . ,(grob-description tie-column-interface ))
735 (molecule-callback . ,Time_signature::brew_molecule)
736 (break-align-symbol . Time_signature)
737 (visibility-lambda . ,all-visible)
740 (font-family . number)
741 (meta . ,(grob-description time-signature-interface font-interface))
747 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
748 (molecule-callback . ,Tuplet_bracket::brew_molecule)
749 (font-family . roman)
750 (font-shape . italic)
751 (font-relative-size . -1)
752 (meta . ,(grob-description text-interface
753 tuplet-bracket-interface font-interface))
757 (molecule-callback . ,Text_item::brew_molecule)
758 (font-family . roman)
759 (font-shape . italic)
760 (no-spacing-rods . #t)
761 (self-alignment-X . 0)
763 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
764 (Y-offset-callbacks .
765 (,Side_position_interface::aligned_side
766 ,Side_position_interface::centered_on_parent))
767 (meta . ,(grob-description text-interface font-interface))
771 (molecule-callback . ,Volta_spanner::brew_molecule)
776 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
777 (thickness . 1.6) ; stafflinethickness
778 (height . 2.0) ; staffspace;
780 (font-family . number)
781 (font-relative-size . -2)
782 (meta . ,(grob-description volta-bracket-interface side-position-interface font-interface))
784 (VerticalAlignment . (
786 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
787 (X-extent-callback . #f)
790 (meta . ,(grob-description align-interface axis-group-interface))
792 (VerticalAxisGroup . (
794 (meta . ,(grob-description axis-group-interface))
801 (define (completize-grob-entry x)
802 "transplant assoc key into 'name entry of 'meta of X
804 (let* ((name-sym (car x))
806 (metaentry (cdr (assoc 'meta entry)))
807 (new-metaentry (assoc-set! metaentry 'name name-sym))
810 (cons name-sym (assoc-set! entry 'meta new-metaentry))
813 (set! all-grob-descriptions (map completize-grob-entry all-grob-descriptions))
817 ; (display (map pair? all-grob-descriptions))
820 ;; make sure that \property Foo.Bar =\turnOff doesn't complain
822 (map (lambda (x) (set-object-property! (car x) 'translator-type? list?))
823 all-grob-descriptions)