1 ;;;; grob-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2001 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 all-grob-descriptions
13 (X-extent-callback . ,Arpeggio::width_callback)
14 (Y-extent-callback . #f)
15 (molecule-callback . ,Arpeggio::brew_molecule)
16 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
17 (X-offset-callbacks . (,Side_position_interface::aligned_side))
19 (staff-position . 0.0)
20 (meta . ,(grob-description "Arpeggio" arpeggio-interface side-position-interface font-interface))
23 (autoBeamSettings . ,auto-beam-settings)
26 (break-align-symbol . Staff_bar)
28 (break-glyph-function . ,default-break-barline)
29 (barsize-procedure . ,Bar::get_staff_bar_size)
30 (molecule-callback . ,Bar::brew_molecule)
31 (visibility-lambda . ,all-visible)
33 (before-line-breaking-callback . ,Bar::before_line_breaking)
35 ;; Ross. page 151 lists other values, we opt for a leaner look
39 (hair-thickness . 1.6)
40 (thick-thickness . 6.0)
41 (meta . ,(grob-description "BarLine" bar-line-interface font-interface))
45 (molecule-callback . ,Text_item::brew_molecule)
47 (visibility-lambda . ,begin-of-line-visible)
51 (font-relative-size . -1)
52 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
53 (meta . ,(grob-description "BarNumber"
54 side-position-interface
55 text-interface font-interface break-aligned-interface))
59 ;; todo: clean this up a bit: the list is getting
61 (molecule-callback . ,Beam::brew_molecule)
62 (y-dy-callbacks . (,Beam::least_squares
63 ,Beam::cancel_suspect_slope
67 ,Beam::do_quantise_y))
69 (thickness . 0.48) ; in staff-space
70 (before-line-breaking-callback . ,Beam::before_line_breaking)
71 (after-line-breaking-callback . ,Beam::after_line_breaking)
72 (default-neutral-direction . 1)
73 (dir-function . ,beam-dir-majority)
74 (height-quants . ,default-beam-dy-quants)
75 (vertical-position-quant-function . ,default-beam-y-quants)
76 (beamed-stem-shorten . (0.5))
77 (outer-stem-length-limit . 0.2)
79 (flag-width-function . ,default-beam-flag-width-function)
80 (space-function . ,default-beam-space-function)
83 (meta . ,(grob-description "Beam" beam-interface))
90 (space-alist . ,default-break-align-space-alist)
91 (meta . ,(grob-description "BreakAlignment"
92 axis-group-interface align-interface
99 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
101 (meta . ,(grob-description "BreakAlignGroup" axis-group-interface))
105 (break-align-symbol . Breathing_sign)
107 (molecule-callback . ,Breathing_sign::brew_molecule)
108 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
109 (visibility-lambda . ,begin-of-line-invisible)
110 (meta . ,(grob-description "BreathingSign" break-aligned-interface))
114 (molecule-callback . ,Clef::brew_molecule)
115 (before-line-breaking-callback . ,Clef::before_line_breaking)
117 (font-family . music)
118 (break-align-symbol . Clef_item)
119 (visibility-lambda . ,begin-of-line-visible)
120 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
121 (meta . ,(grob-description "Clef" clef-interface font-interface break-aligned-interface ))
125 (molecule-callback . ,Chord_name::brew_molecule)
126 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
127 (chord-name-function . ,default-chord-name-function)
128 (font-family . roman)
129 (meta . ,(grob-description "ChordName" font-interface text-interface chord-name-interface))
133 (break-align-symbol . Custos)
135 (molecule-callback . ,Custos::brew_molecule)
136 (visibility-lambda . ,end-of-line-visible)
138 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
139 (meta . ,(grob-description "Custos" custos-interface staff-symbol-referencer-interface break-aligned-interface) )
143 (molecule-callback . ,Hairpin::brew_molecule)
147 (if-text-padding . 1.0)
148 (width-correct . -1.0)
150 (dash-thickness . 1.2)
152 (self-alignment-Y . 0)
153 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
154 (meta . ,(grob-description "Hairpin" hairpin-interface dynamic-interface))
159 (meta . ,(grob-description "DotColumn" dot-column-interface axis-group-interface))
163 (molecule-callback . ,Dots::brew_molecule)
165 (staff-position . 0.0)
166 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
167 (meta . ,(grob-description "Dots" font-interface dots-interface ))
171 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
172 (molecule-callback . ,Text_item::brew_molecule)
173 (script-priority . 100)
175 (font-family . dynamic)
176 (font-shape . italic)
177 (self-alignment-Y . 0)
178 (meta . ,(grob-description "DynamicText" font-interface text-interface dynamic-interface))
181 (DynamicLineSpanner . (
184 (minimum-space . 1.2)
186 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
190 (break-align-symbol . Left_edge_item)
191 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
193 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
197 (molecule-callback . ,Text_item::brew_molecule)
198 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
201 (self-alignment-X . 0)
202 (font-family . number)
203 (font-relative-size . -3)
204 (font-shape . upright)
205 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
210 (horizontal-space . 1.2)
212 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
213 (meta . ,(grob-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
216 (HaraKiriVerticalGroup . (
217 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
218 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
220 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
226 (minimum-length . 0.5)
227 (molecule-callback . ,Hyphen_spanner::brew_molecule)
228 (Y-extent-callback . ,Grob::point_dimension_callback)
229 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
234 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
235 ,Side_position_interface::aligned_on_support_refpoints
238 (self-alignment-Y . 0)
239 (molecule-callback . ,Text_item::brew_molecule)
240 (break-align-symbol . Instrument_name)
241 (visibility-lambda . ,begin-of-line-visible)
243 (font-family . roman)
244 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
248 (molecule-callback . ,Key_item::brew_molecule)
249 (break-align-symbol . Key_item)
250 (visibility-lambda . ,begin-of-line-visible)
252 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
256 (molecule-callback . ,Local_key_item::brew_molecule)
257 (X-offset-callbacks . (,Side_position_interface::aligned_side))
258 (after-line-breaking-callback . ,Local_key_item::after_line_breaking)
261 (right-padding . 0.4)
262 (meta . ,(grob-description "Accidentals" accidentals-interface font-interface side-position-interface))
267 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
271 (molecule-callback . ,Lyric_extender::brew_molecule)
272 (height . 0.8) ; stafflinethickness;
273 (right-trim-amount . 0.5)
274 (Y-extent-callback . ,Grob::point_dimension_callback)
275 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
279 (molecule-callback . ,Text_item::brew_molecule)
280 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
281 (self-alignment-X . 0)
284 (font-family . roman)
285 (font-shape . upright)
286 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
290 (molecule-callback . ,Text_item::brew_molecule)
291 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
292 (self-alignment-X . 0)
296 (font-family . number)
297 (font-shape . upright)
298 (font-relative-size . 1)
299 (visibility-lambda . ,end-of-line-invisible)
301 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
304 (MultiMeasureRest . (
305 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
306 (molecule-callback . ,Multi_measure_rest::brew_molecule)
309 (padding . 2.0) ; staffspace
310 (minimum-width . 12.5) ; staffspace
311 (font-family . number)
312 (font-relative-size . 1)
313 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface rest-interface font-interface ))
318 (meta . ,(grob-description "NoteCollision"
319 note-collision-interface axis-group-interface
325 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
330 (molecule-callback . ,Note_head::brew_molecule)
331 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
332 (attachment-angle . ,(* 20/360 3.14159))
333 (meta . ,(grob-description "NoteHead"
334 rhythmic-head-interface font-interface
335 note-head-interface ))
341 (X-extent-callback . #f)
342 (Y-extent-callback . #f)
343 (molecule-callback . ,Line_spanner::brew_molecule)
344 (meta . ,(grob-description "Glissando"
345 line-spanner-interface))
351 (X-extent-callback . #f)
352 (Y-extent-callback . #f)
353 (molecule-callback . ,Line_spanner::brew_molecule)
354 (meta . ,(grob-description "FollowThread"
355 line-spanner-interface))
359 (molecule-callback . ,Text_item::brew_molecule)
360 (font-family . roman)
361 (meta . ,(grob-description "NoteName"
362 note-name-interface font-interface
367 (self-alignment-X . 0)
369 (visibility-lambda . ,begin-of-line-visible)
370 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
371 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
372 (molecule-callback . ,Text_item::brew_molecule)
373 (font-shape . italic)
374 (font-family . roman)
375 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
380 (before-grace-spacing-factor . 1.2)
381 (before-musical-spacing-factor . 0.4)
382 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
385 (molecule-callback . ,Slur::brew_molecule)
387 (spacing-procedure . ,Slur::set_spacing_rods)
388 (minimum-length . 1.5)
389 (after-line-breaking-callback . ,Slur::after_line_breaking)
390 (extremity-rules . ,default-slur-extremity-rules)
391 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
392 (de-uglify-parameters . ( 1.5 0.8 -2.0))
393 (Y-extent-callback . ,Slur::height)
394 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
395 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
396 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
397 (bezier-area-steps . 1.0)))
400 (attachment . (#f . #f))
401 (attachment-offset . ((0 . 0) . (0 . 0)))
403 (meta . ,(grob-description "PhrasingSlur" slur-interface))
405 (NonMusicalPaperColumn . (
407 (before-musical-spacing-factor . 1.0)
408 (column-space-strength . 2.0)
409 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
413 (after-line-breaking-callback . ,Rest::after_line_breaking)
414 (X-extent-callback . ,Rest::extent_callback)
415 (Y-extent-callback . ,Rest::extent_callback)
416 (molecule-callback . ,Rest::brew_molecule)
417 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
418 (minimum-beam-collision-distance . 1.5)
419 (meta . ,(grob-description "Rest"
420 rhythmic-head-interface
421 staff-symbol-referencer-interface
425 (minimum-distance . 0.75)
426 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
430 ;; don't set direction here: it breaks staccato.
431 (molecule-callback . ,Script::brew_molecule)
432 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
433 (after-line-breaking-callback . ,Script::after_line_breaking)
434 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
438 (before-line-breaking-callback . ,Script_column::before_line_breaking)
439 (meta . ,(grob-description "ScriptColumn" script-column-interface))
443 (molecule-callback . ,Slur::brew_molecule)
445 (spacing-procedure . ,Slur::set_spacing_rods)
446 (minimum-length . 1.5)
447 (after-line-breaking-callback . ,Slur::after_line_breaking)
448 (extremity-rules . ,default-slur-extremity-rules)
449 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
450 (de-uglify-parameters . ( 1.5 0.8 -2.0))
451 (Y-extent-callback . ,Slur::height)
452 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
453 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
454 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
455 (bezier-area-steps . 1.0)))
458 (attachment . (#f . #f))
459 (attachment-offset . ((0 . 0) . (0 . 0)))
461 (meta . ,(grob-description "Slur" slur-interface))
465 (spacing-procedure . ,Spacing_spanner::set_springs)
466 (stem-spacing-correction . 0.5)
467 (arithmetic-basicspace . 2.0)
468 (arithmetic-multiplier . ,(* 0.9 1.32))
469 ;; assume that notes at least this long are present.
470 (maximum-duration-for-spacing . ,(make-moment 1 8))
471 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
474 (break-align-symbol . Staff_bar)
475 (barsize-procedure . ,Span_bar::get_bar_size)
476 (molecule-callback . ,Bar::brew_molecule)
477 (visibility-lambda . ,begin-of-line-invisible)
478 (X-extent-callback . ,Span_bar::width_callback)
479 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
483 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
487 ;; Ross. page 151 lists other values, we opt for a leaner look
491 (hair-thickness . 1.6)
492 (thick-thickness . 6.0)
493 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
498 (molecule-callback . ,Text_item::brew_molecule)
499 (break-align-symbol . Clef_item)
500 (visibility-lambda . ,begin-of-line-visible)
501 (font-family . roman)
502 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
506 (molecule-callback . ,Staff_symbol::brew_molecule)
510 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
513 (molecule-callback . ,Text_item::brew_molecule)
515 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
516 (Y-offset-callbacks .
517 (,Side_position_interface::aligned_side
518 ,Side_position_interface::centered_on_parent))
519 (no-spacing-rods . #t)
520 (font-shape . italic)
521 (self-alignment-X . 0)
522 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
526 (before-line-breaking-callback . ,Stem::before_line_breaking)
527 (molecule-callback . ,Stem::brew_molecule)
529 (beamed-lengths . (0.0 2.5 2.0 1.5))
530 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
532 ;; Stems in unnatural (forced) direction should be shortened,
533 ;; according to [Roush & Gourlay]. Their suggestion to knock off
534 ;; a whole staffspace seems a bit drastical: we'll do half.
536 (lengths . (3.5 3.5 3.5 4.5 5.0))
537 (stem-shorten . (0.5))
538 ; if stem is on middle line, choose this direction.
539 (default-neutral-direction . 1)
540 (X-offset-callbacks . (,Stem::off_callback))
541 (X-extent-callback . ,Stem::dim_callback)
542 (Y-extent-callback . ,Stem::height)
543 (meta . ,(grob-description "Stem" stem-interface font-interface))
547 (molecule-callback . ,Stem_tremolo::brew_molecule)
548 (Y-extent-callback . ,Stem_tremolo::height)
549 (X-extent-callback . #f)
551 (beam-width . 2.0) ; staff-space
552 (beam-thickness . 0.42) ; staff-space
553 (beam-space-function . ,default-beam-space-function)
554 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
558 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
560 (SeparatingGroupSpanner . (
561 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
562 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
566 (no-spacing-rods . #t)
567 (molecule-callback . ,Sustain_pedal::brew_molecule)
568 (self-alignment-X . 0)
570 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
571 (Y-offset-callbacks .
572 (,Side_position_interface::aligned_side
573 ,Side_position_interface::centered_on_parent))
575 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
579 (SystemStartDelimiter . (
580 (molecule-callback . ,System_start_delimiter::brew_molecule)
581 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
582 ;; ugh, in practice, brace has height of 4.1 staff-spaces
583 (brace-collapse-height . 4.1)
584 (bracket-collapse-height . 1)
591 (bracket-thick . 0.25)
592 (Y-extent-callback . #f)
593 (font-family . braces)
594 ;; if you want to set point-size, you cannot set
595 ;; relative-size, as no font will be found for other
597 ;;(font-point-size . 20)
598 ;;(font-relative-size . #f)
599 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
603 (molecule-callback . ,Text_item::brew_molecule)
604 (no-spacing-rods . #t)
608 (font-family . roman)
609 (font-shape . italic)
610 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
613 (molecule-callback . ,Text_spanner::brew_molecule)
614 (font-shape . italic)
615 (font-family . roman)
618 ;; urg, only for (de)cresc. text spanners
619 (if-text-padding . 1.0)
623 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
626 (molecule-callback . ,Tie::brew_molecule)
627 (spacing-procedure . ,Tie::set_spacing_rods)
628 (staffline-clearance . 0.35)
629 (details . ((ratio . 0.333) (height-limit . 1.0)))
632 (minimum-length . 2.5)
633 (meta . ,(grob-description "Tie" tie-interface ))
637 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
638 (meta . ,(grob-description "TieColumn" tie-column-interface ))
642 (molecule-callback . ,Time_signature::brew_molecule)
643 (break-align-symbol . Time_signature)
644 (visibility-lambda . ,all-visible)
646 (font-family . number)
647 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
654 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
655 (molecule-callback . ,Tuplet_bracket::brew_molecule)
656 (font-family . roman)
657 (font-shape . italic)
658 (font-relative-size . -1)
659 (meta . ,(grob-description "TupletBracket" text-interface
660 tuplet-bracket-interface font-interface))
664 (molecule-callback . ,Text_item::brew_molecule)
665 (font-shape . italic)
666 (no-spacing-rods . #t)
667 (self-alignment-X . 0)
669 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
670 (Y-offset-callbacks .
671 (,Side_position_interface::aligned_side
672 ,Side_position_interface::centered_on_parent))
673 (meta . ,(grob-description "UnaChordaPedal" text-interface font-interface))
677 (molecule-callback . ,Volta_spanner::brew_molecule)
682 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
683 (thickness . 1.6) ; stafflinethickness
684 (height . 2.0) ; staffspace;
686 (font-family . number)
687 (font-relative-size . -2)
688 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
691 (VerticalAlignment . (
693 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
694 (X-extent-callback . #f)
696 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
699 (VerticalAxisGroup . (
701 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
707 ; (display (map pair? all-grob-descriptions))