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)
80 (meta . ,(grob-description text-interface font-interface ))
83 ;; todo: clean this up a bit: the list is getting
85 (molecule-callback . ,Beam::brew_molecule)
86 (y-dy-callbacks . (,Beam::least_squares
87 ,Beam::cancel_suspect_slope
91 ,Beam::do_quantise_y))
93 (thickness . 0.48) ; in staff-space
94 (before-line-breaking-callback . ,Beam::before_line_breaking)
95 (after-line-breaking-callback . ,Beam::after_line_breaking)
96 (neutral-direction . -1)
97 (dir-function . ,beam-dir-majority)
98 (height-quants . ,default-beam-dy-quants)
99 (vertical-position-quant-function . ,default-beam-y-quants)
100 (beamed-stem-shorten . (0.5))
101 (outer-stem-length-limit . 0.2)
103 (flag-width-function . ,default-beam-flag-width-function)
104 (space-function . ,default-beam-space-function)
107 (meta . ,(grob-description beam-interface))
114 (space-alist . ,default-break-align-space-alist)
115 (meta . ,(grob-description
116 axis-group-interface align-interface
123 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
125 (meta . ,(grob-description axis-group-interface))
129 (break-align-symbol . Breathing_sign)
131 (molecule-callback . ,Text_item::brew_molecule)
133 (font-family . music)
134 (text . "scripts-rcomma")
135 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
136 (visibility-lambda . ,begin-of-line-invisible)
137 (meta . ,(grob-description break-aligned-interface text-interface font-interface))
141 (molecule-callback . ,Clef::brew_molecule)
142 (before-line-breaking-callback . ,Clef::before_line_breaking)
144 (font-family . music)
145 (break-align-symbol . Clef_item)
146 (visibility-lambda . ,begin-of-line-visible)
147 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
148 (meta . ,(grob-description clef-interface font-interface break-aligned-interface ))
152 (molecule-callback . ,Chord_name::brew_molecule)
153 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
154 (chord-name-function . ,default-chord-name-function)
155 (font-family . roman)
156 (meta . ,(grob-description font-interface text-interface chord-name-interface))
160 (break-align-symbol . Custos)
162 (molecule-callback . ,Custos::brew_molecule)
163 (visibility-lambda . ,end-of-line-visible)
165 (neutral-position . 0)
166 (neutral-direction . -1)
167 (adjust-if-on-staffline . #t)
168 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
169 (font-family . music)
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 (self-alignment-Y . 0)
239 (font-family . number)
240 (font-relative-size . -3)
241 (font-shape . upright)
242 (meta . ,(grob-description finger-interface font-interface text-script-interface text-interface side-position-interface))
246 (HaraKiriVerticalGroup . (
247 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
248 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
250 (meta . ,(grob-description axis-group-interface hara-kiri-group-interface))
253 (molecule-callback . ,Hairpin::brew_molecule)
256 (spacing-procedure . ,Spanner::set_spacing_rods)
257 (minimum-length . 2.0)
258 (if-text-padding . 1.0)
259 (width-correct . -1.0)
261 (dash-thickness . 1.2)
263 (self-alignment-Y . 0)
264 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
265 (meta . ,(grob-description hairpin-interface dynamic-interface))
270 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
271 ,Side_position_interface::aligned_on_support_refpoints
274 (self-alignment-Y . 0)
275 (molecule-callback . ,Text_item::brew_molecule)
276 (break-align-symbol . Instrument_name)
277 (visibility-lambda . ,begin-of-line-visible)
279 (font-family . roman)
280 (meta . ,(grob-description font-interface text-interface break-aligned-interface))
284 (molecule-callback . ,Key_item::brew_molecule)
285 (break-align-symbol . Key_item)
286 (visibility-lambda . ,begin-of-line-visible)
288 (meta . ,(grob-description key-signature-interface font-interface break-aligned-interface))
295 (minimum-length . 0.5)
296 (maximum-length . 100)
297 (molecule-callback . ,Hyphen_spanner::brew_molecule)
298 (Y-extent-callback . ,Grob::point_dimension_callback)
299 (meta . ,(grob-description lyric-hyphen-interface ))
304 (meta . ,(grob-description line-of-score-interface axis-group-interface))
308 (molecule-callback . ,Lyric_extender::brew_molecule)
309 (height . 0.8) ; stafflinethickness;
310 (right-trim-amount . 0.5)
311 (Y-extent-callback . ,Grob::point_dimension_callback)
312 (meta . ,(grob-description lyric-extender-interface))
316 (molecule-callback . ,Text_item::brew_molecule)
317 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
318 (self-alignment-X . 0)
321 (ignore-length-mismatch . #f)
322 (begin-alignment . 4)
324 (font-family . roman)
325 (font-shape . upright)
326 (meta . ,(grob-description lyric-syllable-interface text-interface font-interface ))
331 (auto-properties . #f)
333 (porrectus-width . 2.4)
334 (line-thickness . 1.0)
337 (molecule-callback . ,Porrectus::brew_molecule)
338 (meta . ,(grob-description porrectus-interface))
342 (molecule-callback . ,Text_item::brew_molecule)
343 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
344 (self-alignment-X . 0)
348 (font-family . roman)
349 (font-shape . upright)
350 (font-relative-size . 1)
351 (visibility-lambda . ,end-of-line-invisible)
353 (meta . ,(grob-description mark-interface side-position-interface))
356 (MultiMeasureRest . (
357 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
358 (molecule-callback . ,Multi_measure_rest::brew_molecule)
359 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
362 (padding . 2.0) ; staffspace
363 (minimum-width . 12.5) ; staffspace
364 (font-family . number)
365 (font-relative-size . 1)
366 (meta . ,(grob-description multi-measure-rest-interface rest-interface font-interface ))
370 ;; Ugh, should not be hard-coded.
372 (meta . ,(grob-description
373 note-collision-interface axis-group-interface
379 (meta . ,(grob-description axis-group-interface note-column-interface))
384 (molecule-callback . ,Note_head::brew_molecule)
385 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
386 (stem-attachment-function . ,note-head-style->attachment-coordinates)
387 (meta . ,(grob-description rhythmic-head-interface font-interface note-head-interface))
393 (X-extent-callback . #f)
394 (Y-extent-callback . #f)
395 (molecule-callback . ,Line_spanner::brew_molecule)
396 (meta . ,(grob-description line-spanner-interface))
402 (X-extent-callback . #f)
403 (Y-extent-callback . #f)
404 (molecule-callback . ,Line_spanner::brew_molecule)
405 (meta . ,(grob-description line-spanner-interface))
409 (molecule-callback . ,Text_item::brew_molecule)
410 (font-family . roman)
411 (meta . ,(grob-description note-name-interface font-interface))
415 (self-alignment-X . 0)
417 (visibility-lambda . ,begin-of-line-visible)
418 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
419 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
420 (molecule-callback . ,Text_item::brew_molecule)
421 (font-shape . italic)
422 (font-family . roman)
423 (meta . ,(grob-description text-interface font-interface ))
428 ; (molecule-callback . ,Paper_column::brew_molecule) (font-name . "cmr8")
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 ; (molecule-callback . ,Paper_column::brew_molecule) (font-name . "cmr8")
456 (meta . ,(grob-description paper-column-interface axis-group-interface spaceable-element-interface))
460 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
461 (molecule-callback . ,Multi_measure_rest::percent)
464 (minimum-width . 12.5) ; staffspace
465 (font-family . music)
466 (meta . ,(grob-description multi-measure-rest-interface font-interface percent-repeat-interface))
471 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
474 (meta . ,(grob-description percent-repeat-interface))
477 (after-line-breaking-callback . ,Rest::after_line_breaking)
478 (X-extent-callback . ,Rest::extent_callback)
479 (Y-extent-callback . ,Rest::extent_callback)
480 (molecule-callback . ,Rest::brew_molecule)
481 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
482 (minimum-beam-collision-distance . 1.5)
483 (meta . ,(grob-description
484 rhythmic-head-interface
485 staff-symbol-referencer-interface
489 (minimum-distance . 0.75)
490 (meta . ,(grob-description rest-collision-interface ))
494 ;; don't set direction here: it breaks staccato.
495 (molecule-callback . ,Script::brew_molecule)
497 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
498 (before-line-breaking-callback . ,Script::before_line_breaking)
499 (font-family . music)
500 (meta . ,(grob-description script-interface side-position-interface font-interface))
504 (before-line-breaking-callback . ,Script_column::before_line_breaking)
505 (meta . ,(grob-description script-column-interface))
509 (molecule-callback . ,Slur::brew_molecule)
511 (spacing-procedure . ,Spanner::set_spacing_rods)
512 (minimum-length . 1.5)
513 (after-line-breaking-callback . ,Slur::after_line_breaking)
514 (extremity-rules . ,default-slur-extremity-rules)
515 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
516 (de-uglify-parameters . ( 1.5 0.8 -2.0))
517 (Y-extent-callback . ,Slur::height)
518 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
519 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
520 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
521 (bezier-area-steps . 1.0)))
524 (attachment . (#f . #f))
525 (attachment-offset . ((0 . 0) . (0 . 0)))
527 (meta . ,(grob-description slur-interface))
531 (spacing-procedure . ,Third_spacing_spanner::set_springs)
532 (grace-space-factor . 0.8)
534 ;; TODO: change naming -- unintuitive
535 (arithmetic-basicspace . 2.0)
536 (arithmetic-multiplier . ,(* 0.9 1.32))
538 ;; assume that notes at least this long are present.
539 (maximum-duration-for-spacing . ,(make-moment 1 8))
540 (meta . ,(grob-description spacing-spanner-interface))
543 (break-align-symbol . Staff_bar)
544 (bar-size-procedure . ,Span_bar::get_bar_size)
545 (molecule-callback . ,Span_bar::brew_molecule)
546 (visibility-lambda . ,begin-of-line-invisible)
547 (X-extent-callback . ,Span_bar::width_callback)
550 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
554 ;; Ross. page 151 lists other values, we opt for a leaner look
558 (hair-thickness . 1.6)
559 (thick-thickness . 6.0)
560 (meta . ,(grob-description span-bar-interface bar-line-interface ))
565 (molecule-callback . ,Text_item::brew_molecule)
566 (break-align-symbol . Clef_item)
567 (visibility-lambda . ,begin-of-line-visible)
568 (font-family . roman)
569 (meta . ,(grob-description break-aligned-interface text-interface font-interface))
574 (X-extent-callback . #f)
575 (Y-extent-callback . #f)
577 (meta . ,(grob-description staff-spacing-interface))
580 (X-extent-callback . #f)
581 (Y-extent-callback . #f)
582 (stem-spacing-correction . 0.)
584 (meta . ,(grob-description note-spacing-interface))
588 (molecule-callback . ,Staff_symbol::brew_molecule)
592 (meta . ,(grob-description staff-symbol-interface ))
595 (molecule-callback . ,Text_item::brew_molecule)
597 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
598 (Y-offset-callbacks .
599 (,Side_position_interface::aligned_side
600 ,Side_position_interface::centered_on_parent))
601 (no-spacing-rods . #t)
602 (font-shape . italic)
603 (self-alignment-X . 0)
604 (meta . ,(grob-description text-interface font-interface))
608 (before-line-breaking-callback . ,Stem::before_line_breaking)
609 (molecule-callback . ,Stem::brew_molecule)
611 (beamed-lengths . (0.0 2.5 2.0 1.5))
612 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
614 ;; Stems in unnatural (forced) direction should be shortened,
615 ;; according to [Roush & Gourlay]. Their suggestion to knock off
616 ;; a whole staffspace seems a bit drastical: we'll do half.
618 (lengths . (3.5 3.5 3.5 4.5 5.0))
619 (stem-shorten . (0.5))
620 ; if stem is on middle line, choose this direction.
621 (neutral-direction . -1)
622 (X-offset-callbacks . (,Stem::off_callback))
623 (X-extent-callback . ,Stem::dim_callback)
624 (Y-extent-callback . ,Stem::height)
625 (adjust-if-on-staffline . #t)
626 (font-family . music)
627 (meta . ,(grob-description stem-interface font-interface))
631 (molecule-callback . ,Stem_tremolo::brew_molecule)
632 (Y-extent-callback . ,Stem_tremolo::height)
633 (X-extent-callback . #f)
635 (beam-width . 2.0) ; staff-space
636 (beam-thickness . 0.42) ; staff-space
637 (beam-space-function . ,default-beam-space-function)
638 (meta . ,(grob-description stem-tremolo-interface ))
642 (meta . ,(grob-description separation-item-interface ))
644 (SeparatingGroupSpanner . (
645 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
646 (meta . ,(grob-description separation-spanner-interface))
650 (no-spacing-rods . #t)
651 (molecule-callback . ,Sustain_pedal::brew_molecule)
652 (self-alignment-X . 0)
654 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
655 (Y-offset-callbacks .
656 (,Side_position_interface::aligned_side
657 ,Side_position_interface::centered_on_parent))
659 (meta . ,(grob-description sustain-pedal-interface side-position-interface font-interface))
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
819 ; (display (car x)) (newline)
821 (set-object-property! (car x) 'translation-type? list?))
822 all-grob-descriptions)