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
14 (molecule-callback . ,Local_key_item::brew_molecule)
15 (X-offset-callbacks . (,Side_position_interface::aligned_side))
16 (after-line-breaking-callback . ,Local_key_item::after_line_breaking)
20 (meta . ,(grob-description "Accidentals" accidentals-interface font-interface side-position-interface))
24 (X-extent-callback . ,Arpeggio::width_callback)
25 (Y-extent-callback . #f)
26 (molecule-callback . ,Arpeggio::brew_molecule)
27 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
28 (X-offset-callbacks . (,Side_position_interface::aligned_side))
30 (staff-position . 0.0)
31 (meta . ,(grob-description "Arpeggio" arpeggio-interface side-position-interface font-interface))
34 (autoBeamSettings . ,auto-beam-settings)
37 (break-align-symbol . Staff_bar)
39 (break-glyph-function . ,default-break-barline)
40 (barsize-procedure . ,Bar::get_staff_bar_size)
41 (molecule-callback . ,Bar::brew_molecule)
42 (visibility-lambda . ,all-visible)
44 (before-line-breaking-callback . ,Bar::before_line_breaking)
46 ;; Ross. page 151 lists other values, we opt for a leaner look
50 (hair-thickness . 1.6)
51 (thick-thickness . 6.0)
52 (meta . ,(grob-description "BarLine" bar-line-interface font-interface))
56 (molecule-callback . ,Text_item::brew_molecule)
58 (visibility-lambda . ,begin-of-line-visible)
62 (font-relative-size . -1)
63 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
64 (meta . ,(grob-description "BarNumber"
65 side-position-interface
66 text-interface font-interface break-aligned-interface))
70 ;; todo: clean this up a bit: the list is getting
72 (molecule-callback . ,Beam::brew_molecule)
73 (y-dy-callbacks . (,Beam::least_squares
74 ,Beam::cancel_suspect_slope
78 ,Beam::do_quantise_y))
80 (thickness . 0.48) ; in staff-space
81 (before-line-breaking-callback . ,Beam::before_line_breaking)
82 (after-line-breaking-callback . ,Beam::after_line_breaking)
83 (default-neutral-direction . 1)
84 (dir-function . ,beam-dir-majority)
85 (height-quants . ,default-beam-dy-quants)
86 (vertical-position-quant-function . ,default-beam-y-quants)
87 (beamed-stem-shorten . (0.5))
88 (outer-stem-length-limit . 0.2)
90 (flag-width-function . ,default-beam-flag-width-function)
91 (space-function . ,default-beam-space-function)
94 (meta . ,(grob-description "Beam" beam-interface))
101 (space-alist . ,default-break-align-space-alist)
102 (meta . ,(grob-description "BreakAlignment"
103 axis-group-interface align-interface
110 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
112 (meta . ,(grob-description "BreakAlignGroup" axis-group-interface))
116 (break-align-symbol . Breathing_sign)
118 (molecule-callback . ,Breathing_sign::brew_molecule)
119 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
120 (visibility-lambda . ,begin-of-line-invisible)
121 (meta . ,(grob-description "BreathingSign" break-aligned-interface))
125 (molecule-callback . ,Clef::brew_molecule)
126 (before-line-breaking-callback . ,Clef::before_line_breaking)
128 (font-family . music)
129 (break-align-symbol . Clef_item)
130 (visibility-lambda . ,begin-of-line-visible)
131 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
132 (meta . ,(grob-description "Clef" clef-interface font-interface break-aligned-interface ))
136 (molecule-callback . ,Chord_name::brew_molecule)
137 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
138 (chord-name-function . ,default-chord-name-function)
139 (font-family . roman)
140 (meta . ,(grob-description "ChordName" font-interface text-interface chord-name-interface))
144 (break-align-symbol . Custos)
146 (molecule-callback . ,Custos::brew_molecule)
147 (visibility-lambda . ,end-of-line-visible)
149 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
150 (meta . ,(grob-description "Custos" custos-interface staff-symbol-referencer-interface break-aligned-interface) )
156 (meta . ,(grob-description "DotColumn" dot-column-interface axis-group-interface))
160 (molecule-callback . ,Dots::brew_molecule)
162 (staff-position . 0.0)
163 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
164 (meta . ,(grob-description "Dots" font-interface dots-interface ))
167 . ((molecule-callback . ,Percent_repeat_item_interface::double_percent)
170 (font-family . music)
173 (break-align-symbol . Staff_bar)
174 (visibility-lambda . ,begin-of-line-invisible)
175 (meta . ,(grob-description "DoublePercentRepeat" font-interface percent-repeat-interface))
179 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
180 (molecule-callback . ,Text_item::brew_molecule)
181 (no-spacing-rods . #t)
182 (script-priority . 100)
184 (font-family . dynamic)
185 (font-shape . italic)
186 (self-alignment-Y . 0)
187 (meta . ,(grob-description "DynamicText" font-interface text-interface dynamic-interface))
190 (DynamicLineSpanner . (
193 (minimum-space . 1.2)
195 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
199 (break-align-symbol . Left_edge_item)
200 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
202 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
206 (molecule-callback . ,Text_item::brew_molecule)
207 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
210 (self-alignment-X . 0)
211 (font-family . number)
212 (font-relative-size . -3)
213 (font-shape . upright)
214 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
219 (horizontal-space . 1.2)
221 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
222 (meta . ,(grob-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
225 (HaraKiriVerticalGroup . (
226 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
227 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
229 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
232 (molecule-callback . ,Hairpin::brew_molecule)
235 (spacing-procedure . ,Spanner::set_spacing_rods)
236 (minimum-length . 2.0)
237 (if-text-padding . 1.0)
238 (width-correct . -1.0)
240 (dash-thickness . 1.2)
242 (self-alignment-Y . 0)
243 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
244 (meta . ,(grob-description "Hairpin" hairpin-interface dynamic-interface))
249 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
250 ,Side_position_interface::aligned_on_support_refpoints
253 (self-alignment-Y . 0)
254 (molecule-callback . ,Text_item::brew_molecule)
255 (break-align-symbol . Instrument_name)
256 (visibility-lambda . ,begin-of-line-visible)
258 (font-family . roman)
259 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
263 (molecule-callback . ,Key_item::brew_molecule)
264 (break-align-symbol . Key_item)
265 (visibility-lambda . ,begin-of-line-visible)
267 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
274 (minimum-length . 0.5)
275 (molecule-callback . ,Hyphen_spanner::brew_molecule)
276 (Y-extent-callback . ,Grob::point_dimension_callback)
277 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
282 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
286 (molecule-callback . ,Lyric_extender::brew_molecule)
287 (height . 0.8) ; stafflinethickness;
288 (right-trim-amount . 0.5)
289 (Y-extent-callback . ,Grob::point_dimension_callback)
290 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
294 (molecule-callback . ,Text_item::brew_molecule)
295 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
296 (self-alignment-X . 0)
299 (font-family . roman)
300 (font-shape . upright)
301 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
305 (molecule-callback . ,Text_item::brew_molecule)
306 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
307 (self-alignment-X . 0)
311 (font-family . number)
312 (font-shape . upright)
313 (font-relative-size . 1)
314 (visibility-lambda . ,end-of-line-invisible)
316 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
319 (MultiMeasureRest . (
320 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
321 (molecule-callback . ,Multi_measure_rest::brew_molecule)
322 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
325 (padding . 2.0) ; staffspace
326 (minimum-width . 12.5) ; staffspace
327 (font-family . number)
328 (font-relative-size . 1)
329 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface rest-interface font-interface ))
334 (meta . ,(grob-description "NoteCollision"
335 note-collision-interface axis-group-interface
341 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
346 (molecule-callback . ,Note_head::brew_molecule)
347 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
348 (attachment-slope . 0.17)
349 (meta . ,(grob-description "NoteHead"
350 rhythmic-head-interface font-interface
351 note-head-interface ))
357 (X-extent-callback . #f)
358 (Y-extent-callback . #f)
359 (molecule-callback . ,Line_spanner::brew_molecule)
360 (meta . ,(grob-description "Glissando"
361 line-spanner-interface))
367 (X-extent-callback . #f)
368 (Y-extent-callback . #f)
369 (molecule-callback . ,Line_spanner::brew_molecule)
370 (meta . ,(grob-description "VoiceFollower"
371 line-spanner-interface))
375 (molecule-callback . ,Text_item::brew_molecule)
376 (font-family . roman)
377 (meta . ,(grob-description "NoteName"
378 note-name-interface font-interface
383 (self-alignment-X . 0)
385 (visibility-lambda . ,begin-of-line-visible)
386 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
387 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
388 (molecule-callback . ,Text_item::brew_molecule)
389 (font-shape . italic)
390 (font-family . roman)
391 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
396 (before-grace-spacing-factor . 1.2)
397 (before-musical-spacing-factor . 0.4)
398 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
401 (molecule-callback . ,Slur::brew_molecule)
403 (spacing-procedure . ,Spanner::set_spacing_rods)
404 (minimum-length . 1.5)
405 (after-line-breaking-callback . ,Slur::after_line_breaking)
406 (extremity-rules . ,default-slur-extremity-rules)
407 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
408 (de-uglify-parameters . ( 1.5 0.8 -2.0))
409 (Y-extent-callback . ,Slur::height)
410 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
411 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
412 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
413 (bezier-area-steps . 1.0)))
416 (attachment . (#f . #f))
417 (attachment-offset . ((0 . 0) . (0 . 0)))
419 (meta . ,(grob-description "PhrasingSlur" slur-interface))
422 (NonMusicalPaperColumn . (
424 (before-musical-spacing-factor . 1.0)
425 (column-space-strength . 2.0)
426 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
430 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
431 (molecule-callback . ,Multi_measure_rest::percent)
434 (minimum-width . 12.5) ; staffspace
435 (font-family . music)
436 (meta . ,(grob-description "PercentRepeat" multi-measure-rest-interface font-interface percent-repeat-interface))
441 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
444 (meta . ,(grob-description "RepeatSlash" percent-repeat-interface))
447 (after-line-breaking-callback . ,Rest::after_line_breaking)
448 (X-extent-callback . ,Rest::extent_callback)
449 (Y-extent-callback . ,Rest::extent_callback)
450 (molecule-callback . ,Rest::brew_molecule)
451 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
452 (minimum-beam-collision-distance . 1.5)
453 (meta . ,(grob-description "Rest"
454 rhythmic-head-interface
455 staff-symbol-referencer-interface
459 (minimum-distance . 0.75)
460 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
464 ;; don't set direction here: it breaks staccato.
465 (molecule-callback . ,Script::brew_molecule)
466 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
467 (before-line-breaking-callback . ,Script::before_line_breaking)
468 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
472 (before-line-breaking-callback . ,Script_column::before_line_breaking)
473 (meta . ,(grob-description "ScriptColumn" script-column-interface))
477 (molecule-callback . ,Slur::brew_molecule)
479 (spacing-procedure . ,Spanner::set_spacing_rods)
480 (minimum-length . 1.5)
481 (after-line-breaking-callback . ,Slur::after_line_breaking)
482 (extremity-rules . ,default-slur-extremity-rules)
483 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
484 (de-uglify-parameters . ( 1.5 0.8 -2.0))
485 (Y-extent-callback . ,Slur::height)
486 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
487 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
488 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
489 (bezier-area-steps . 1.0)))
492 (attachment . (#f . #f))
493 (attachment-offset . ((0 . 0) . (0 . 0)))
495 (meta . ,(grob-description "Slur" slur-interface))
499 (spacing-procedure . ,Spacing_spanner::set_springs)
500 (stem-spacing-correction . 0.5)
501 (arithmetic-basicspace . 2.0)
502 (arithmetic-multiplier . ,(* 0.9 1.32))
503 ;; assume that notes at least this long are present.
504 (maximum-duration-for-spacing . ,(make-moment 1 8))
505 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
508 (break-align-symbol . Staff_bar)
509 (barsize-procedure . ,Span_bar::get_bar_size)
510 (molecule-callback . ,Bar::brew_molecule)
511 (visibility-lambda . ,begin-of-line-invisible)
512 (X-extent-callback . ,Span_bar::width_callback)
513 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
517 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
521 ;; Ross. page 151 lists other values, we opt for a leaner look
525 (hair-thickness . 1.6)
526 (thick-thickness . 6.0)
527 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
532 (molecule-callback . ,Text_item::brew_molecule)
533 (break-align-symbol . Clef_item)
534 (visibility-lambda . ,begin-of-line-visible)
535 (font-family . roman)
536 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
540 (molecule-callback . ,Staff_symbol::brew_molecule)
544 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
547 (molecule-callback . ,Text_item::brew_molecule)
549 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
550 (Y-offset-callbacks .
551 (,Side_position_interface::aligned_side
552 ,Side_position_interface::centered_on_parent))
553 (no-spacing-rods . #t)
554 (font-shape . italic)
555 (self-alignment-X . 0)
556 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
560 (before-line-breaking-callback . ,Stem::before_line_breaking)
561 (molecule-callback . ,Stem::brew_molecule)
563 (beamed-lengths . (0.0 2.5 2.0 1.5))
564 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
566 ;; Stems in unnatural (forced) direction should be shortened,
567 ;; according to [Roush & Gourlay]. Their suggestion to knock off
568 ;; a whole staffspace seems a bit drastical: we'll do half.
570 (lengths . (3.5 3.5 3.5 4.5 5.0))
571 (stem-shorten . (0.5))
572 ; if stem is on middle line, choose this direction.
573 (default-neutral-direction . 1)
574 (X-offset-callbacks . (,Stem::off_callback))
575 (X-extent-callback . ,Stem::dim_callback)
576 (Y-extent-callback . ,Stem::height)
577 (meta . ,(grob-description "Stem" stem-interface font-interface))
581 (molecule-callback . ,Stem_tremolo::brew_molecule)
582 (Y-extent-callback . ,Stem_tremolo::height)
583 (X-extent-callback . #f)
585 (beam-width . 2.0) ; staff-space
586 (beam-thickness . 0.42) ; staff-space
587 (beam-space-function . ,default-beam-space-function)
588 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
592 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
594 (SeparatingGroupSpanner . (
595 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
596 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
600 (no-spacing-rods . #t)
601 (molecule-callback . ,Sustain_pedal::brew_molecule)
602 (self-alignment-X . 0)
604 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
605 (Y-offset-callbacks .
606 (,Side_position_interface::aligned_side
607 ,Side_position_interface::centered_on_parent))
609 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
613 (SystemStartDelimiter . (
614 (molecule-callback . ,System_start_delimiter::brew_molecule)
615 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
616 ;; ugh, in practice, brace has height of 4.1 staff-spaces
617 (brace-collapse-height . 4.1)
618 (bracket-collapse-height . 1)
625 (bracket-thick . 0.25)
626 (Y-extent-callback . #f)
627 (font-family . braces)
628 ;; if you want to set point-size, you cannot set
629 ;; relative-size, as no font will be found for other
631 ;;(font-design-size . 20)
632 ;;(font-relative-size . #f)
633 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
637 (molecule-callback . ,Text_item::brew_molecule)
638 (no-spacing-rods . #t)
641 ;; todo: add X self alignment?
643 (font-family . roman)
644 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
647 (molecule-callback . ,Text_spanner::brew_molecule)
648 (font-family . roman)
651 ;; urg, only for (de)cresc. text spanners
652 (if-text-padding . 1.0)
656 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
659 (molecule-callback . ,Tie::brew_molecule)
660 (spacing-procedure . ,Spanner::set_spacing_rods)
661 (staffline-clearance . 0.35)
662 (details . ((ratio . 0.333) (height-limit . 1.0)))
665 (minimum-length . 2.5)
666 (meta . ,(grob-description "Tie" tie-interface ))
670 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
671 (meta . ,(grob-description "TieColumn" tie-column-interface ))
675 (molecule-callback . ,Time_signature::brew_molecule)
676 (break-align-symbol . Time_signature)
677 (visibility-lambda . ,all-visible)
679 (font-family . number)
680 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
687 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
688 (molecule-callback . ,Tuplet_bracket::brew_molecule)
689 (font-family . roman)
690 (font-shape . italic)
691 (font-relative-size . -1)
692 (meta . ,(grob-description "TupletBracket" text-interface
693 tuplet-bracket-interface font-interface))
697 (molecule-callback . ,Text_item::brew_molecule)
698 (font-shape . italic)
699 (no-spacing-rods . #t)
700 (self-alignment-X . 0)
702 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
703 (Y-offset-callbacks .
704 (,Side_position_interface::aligned_side
705 ,Side_position_interface::centered_on_parent))
706 (meta . ,(grob-description "UnaChordaPedal" text-interface font-interface))
710 (molecule-callback . ,Volta_spanner::brew_molecule)
715 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
716 (thickness . 1.6) ; stafflinethickness
717 (height . 2.0) ; staffspace;
719 (font-family . number)
720 (font-relative-size . -2)
721 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
724 (VerticalAlignment . (
726 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
727 (X-extent-callback . #f)
729 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
732 (VerticalAxisGroup . (
734 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
740 ; (display (map pair? all-grob-descriptions))