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 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
182 (self-alignment-X . 0)
184 (no-spacing-rods . #t)
185 (script-priority . 100)
187 (font-family . dynamic)
188 (font-shape . italic)
189 (self-alignment-Y . 0)
190 (meta . ,(grob-description "DynamicText" font-interface text-interface dynamic-interface))
193 (DynamicLineSpanner . (
196 (minimum-space . 1.2)
198 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
202 (break-align-symbol . Left_edge_item)
203 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
205 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
209 (molecule-callback . ,Text_item::brew_molecule)
210 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
213 (self-alignment-X . 0)
214 (font-family . number)
215 (font-relative-size . -3)
216 (font-shape . upright)
217 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
222 (horizontal-space . 1.2)
224 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
225 (meta . ,(grob-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
228 (HaraKiriVerticalGroup . (
229 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
230 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
232 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
235 (molecule-callback . ,Hairpin::brew_molecule)
238 (spacing-procedure . ,Spanner::set_spacing_rods)
239 (minimum-length . 2.0)
240 (if-text-padding . 1.0)
241 (width-correct . -1.0)
243 (dash-thickness . 1.2)
245 (self-alignment-Y . 0)
246 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self))
247 (meta . ,(grob-description "Hairpin" hairpin-interface dynamic-interface))
252 (Y-offset-callbacks . (,Side_position_interface::aligned_on_self
253 ,Side_position_interface::aligned_on_support_refpoints
256 (self-alignment-Y . 0)
257 (molecule-callback . ,Text_item::brew_molecule)
258 (break-align-symbol . Instrument_name)
259 (visibility-lambda . ,begin-of-line-visible)
261 (font-family . roman)
262 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
266 (molecule-callback . ,Key_item::brew_molecule)
267 (break-align-symbol . Key_item)
268 (visibility-lambda . ,begin-of-line-visible)
270 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
277 (minimum-length . 0.5)
278 (molecule-callback . ,Hyphen_spanner::brew_molecule)
279 (Y-extent-callback . ,Grob::point_dimension_callback)
280 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
285 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
289 (molecule-callback . ,Lyric_extender::brew_molecule)
290 (height . 0.8) ; stafflinethickness;
291 (right-trim-amount . 0.5)
292 (Y-extent-callback . ,Grob::point_dimension_callback)
293 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
297 (molecule-callback . ,Text_item::brew_molecule)
298 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
299 (self-alignment-X . 0)
302 (font-family . roman)
303 (font-shape . upright)
304 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
308 (molecule-callback . ,Text_item::brew_molecule)
309 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
310 (self-alignment-X . 0)
314 (font-family . number)
315 (font-shape . upright)
316 (font-relative-size . 1)
317 (visibility-lambda . ,end-of-line-invisible)
319 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
322 (MultiMeasureRest . (
323 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
324 (molecule-callback . ,Multi_measure_rest::brew_molecule)
325 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
328 (padding . 2.0) ; staffspace
329 (minimum-width . 12.5) ; staffspace
330 (font-family . number)
331 (font-relative-size . 1)
332 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface rest-interface font-interface ))
337 (meta . ,(grob-description "NoteCollision"
338 note-collision-interface axis-group-interface
344 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
349 (molecule-callback . ,Note_head::brew_molecule)
350 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
351 (stem-attachment-function
352 . ,note-head-style->attachment-coordinates)
353 (meta . ,(grob-description "NoteHead"
354 rhythmic-head-interface font-interface
355 note-head-interface ))
361 (X-extent-callback . #f)
362 (Y-extent-callback . #f)
363 (molecule-callback . ,Line_spanner::brew_molecule)
364 (meta . ,(grob-description "Glissando"
365 line-spanner-interface))
371 (X-extent-callback . #f)
372 (Y-extent-callback . #f)
373 (molecule-callback . ,Line_spanner::brew_molecule)
374 (meta . ,(grob-description "VoiceFollower"
375 line-spanner-interface))
379 (molecule-callback . ,Text_item::brew_molecule)
380 (font-family . roman)
381 (meta . ,(grob-description "NoteName"
382 note-name-interface font-interface
387 (self-alignment-X . 0)
389 (visibility-lambda . ,begin-of-line-visible)
390 (X-offset-callbacks . (,Side_position_interface::centered_on_parent ,Side_position_interface::aligned_on_self))
391 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
392 (molecule-callback . ,Text_item::brew_molecule)
393 (font-shape . italic)
394 (font-family . roman)
395 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
400 (before-grace-spacing-factor . 1.2)
401 (before-musical-spacing-factor . 0.4)
402 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
405 (molecule-callback . ,Slur::brew_molecule)
407 (spacing-procedure . ,Spanner::set_spacing_rods)
408 (minimum-length . 1.5)
409 (after-line-breaking-callback . ,Slur::after_line_breaking)
410 (extremity-rules . ,default-slur-extremity-rules)
411 (extremity-offset-alist . ,default-phrasing-slur-extremity-offset-alist)
412 (de-uglify-parameters . ( 1.5 0.8 -2.0))
413 (Y-extent-callback . ,Slur::height)
414 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
415 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
416 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
417 (bezier-area-steps . 1.0)))
420 (attachment . (#f . #f))
421 (attachment-offset . ((0 . 0) . (0 . 0)))
423 (meta . ,(grob-description "PhrasingSlur" slur-interface))
426 (NonMusicalPaperColumn . (
428 (before-musical-spacing-factor . 1.0)
429 (column-space-strength . 2.0)
430 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
434 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
435 (molecule-callback . ,Multi_measure_rest::percent)
438 (minimum-width . 12.5) ; staffspace
439 (font-family . music)
440 (meta . ,(grob-description "PercentRepeat" multi-measure-rest-interface font-interface percent-repeat-interface))
445 (molecule-callback . , Percent_repeat_item_interface::beat_slash)
448 (meta . ,(grob-description "RepeatSlash" percent-repeat-interface))
451 (after-line-breaking-callback . ,Rest::after_line_breaking)
452 (X-extent-callback . ,Rest::extent_callback)
453 (Y-extent-callback . ,Rest::extent_callback)
454 (molecule-callback . ,Rest::brew_molecule)
455 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
456 (minimum-beam-collision-distance . 1.5)
457 (meta . ,(grob-description "Rest"
458 rhythmic-head-interface
459 staff-symbol-referencer-interface
463 (minimum-distance . 0.75)
464 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
468 ;; don't set direction here: it breaks staccato.
469 (molecule-callback . ,Script::brew_molecule)
470 (X-offset-callbacks . (,Side_position_interface::centered_on_parent))
471 (before-line-breaking-callback . ,Script::before_line_breaking)
472 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
476 (before-line-breaking-callback . ,Script_column::before_line_breaking)
477 (meta . ,(grob-description "ScriptColumn" script-column-interface))
481 (molecule-callback . ,Slur::brew_molecule)
483 (spacing-procedure . ,Spanner::set_spacing_rods)
484 (minimum-length . 1.5)
485 (after-line-breaking-callback . ,Slur::after_line_breaking)
486 (extremity-rules . ,default-slur-extremity-rules)
487 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
488 (de-uglify-parameters . ( 1.5 0.8 -2.0))
489 (Y-extent-callback . ,Slur::height)
490 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
491 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
492 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
493 (bezier-area-steps . 1.0)))
496 (attachment . (#f . #f))
497 (attachment-offset . ((0 . 0) . (0 . 0)))
499 (meta . ,(grob-description "Slur" slur-interface))
503 (spacing-procedure . ,Spacing_spanner::set_springs)
504 (stem-spacing-correction . 0.5)
505 (arithmetic-basicspace . 2.0)
506 (arithmetic-multiplier . ,(* 0.9 1.32))
507 ;; assume that notes at least this long are present.
508 (maximum-duration-for-spacing . ,(make-moment 1 8))
509 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
512 (break-align-symbol . Staff_bar)
513 (barsize-procedure . ,Span_bar::get_bar_size)
514 (molecule-callback . ,Bar::brew_molecule)
515 (visibility-lambda . ,begin-of-line-invisible)
516 (X-extent-callback . ,Span_bar::width_callback)
517 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
521 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
525 ;; Ross. page 151 lists other values, we opt for a leaner look
529 (hair-thickness . 1.6)
530 (thick-thickness . 6.0)
531 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
536 (molecule-callback . ,Text_item::brew_molecule)
537 (break-align-symbol . Clef_item)
538 (visibility-lambda . ,begin-of-line-visible)
539 (font-family . roman)
540 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
544 (molecule-callback . ,Staff_symbol::brew_molecule)
548 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
551 (molecule-callback . ,Text_item::brew_molecule)
553 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
554 (Y-offset-callbacks .
555 (,Side_position_interface::aligned_side
556 ,Side_position_interface::centered_on_parent))
557 (no-spacing-rods . #t)
558 (font-shape . italic)
559 (self-alignment-X . 0)
560 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
564 (before-line-breaking-callback . ,Stem::before_line_breaking)
565 (molecule-callback . ,Stem::brew_molecule)
567 (beamed-lengths . (0.0 2.5 2.0 1.5))
568 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
570 ;; Stems in unnatural (forced) direction should be shortened,
571 ;; according to [Roush & Gourlay]. Their suggestion to knock off
572 ;; a whole staffspace seems a bit drastical: we'll do half.
574 (lengths . (3.5 3.5 3.5 4.5 5.0))
575 (stem-shorten . (0.5))
576 ; if stem is on middle line, choose this direction.
577 (default-neutral-direction . 1)
578 (X-offset-callbacks . (,Stem::off_callback))
579 (X-extent-callback . ,Stem::dim_callback)
580 (Y-extent-callback . ,Stem::height)
581 (meta . ,(grob-description "Stem" stem-interface font-interface))
585 (molecule-callback . ,Stem_tremolo::brew_molecule)
586 (Y-extent-callback . ,Stem_tremolo::height)
587 (X-extent-callback . #f)
589 (beam-width . 2.0) ; staff-space
590 (beam-thickness . 0.42) ; staff-space
591 (beam-space-function . ,default-beam-space-function)
592 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
596 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
598 (SeparatingGroupSpanner . (
599 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
600 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
604 (no-spacing-rods . #t)
605 (molecule-callback . ,Sustain_pedal::brew_molecule)
606 (self-alignment-X . 0)
608 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
609 (Y-offset-callbacks .
610 (,Side_position_interface::aligned_side
611 ,Side_position_interface::centered_on_parent))
613 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
616 ;; TODO: should split in 3
617 (SystemStartDelimiter . (
618 (molecule-callback . ,System_start_delimiter::brew_molecule)
619 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
620 ;; really 4.0, but 5 to be on safe side.
621 (brace-collapse-height . 5.0)
622 (bracket-collapse-height . 1)
629 (bracket-thick . 0.25)
630 (Y-extent-callback . #f)
631 (font-family . braces)
632 ;; if you want to set point-size, you cannot set
633 ;; relative-size, as no font will be found for other
635 ;;(font-design-size . 20)
636 ;;(font-relative-size . #f)
637 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
641 (molecule-callback . ,Text_item::brew_molecule)
642 (no-spacing-rods . #t)
645 ;; todo: add X self alignment?
647 (font-family . roman)
648 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
651 (molecule-callback . ,Text_spanner::brew_molecule)
652 (font-family . roman)
655 ;; urg, only for (de)cresc. text spanners
656 (if-text-padding . 1.0)
660 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
663 (molecule-callback . ,Tie::brew_molecule)
664 (spacing-procedure . ,Spanner::set_spacing_rods)
665 (staffline-clearance . 0.35)
666 (details . ((ratio . 0.333) (height-limit . 1.0)))
669 (minimum-length . 2.5)
670 (meta . ,(grob-description "Tie" tie-interface ))
674 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
675 (meta . ,(grob-description "TieColumn" tie-column-interface ))
679 (molecule-callback . ,Time_signature::brew_molecule)
680 (break-align-symbol . Time_signature)
681 (visibility-lambda . ,all-visible)
684 (font-family . number)
685 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
692 (after-line-breaking-callback . ,Tuplet_bracket::after_line_breaking)
693 (molecule-callback . ,Tuplet_bracket::brew_molecule)
694 (font-family . roman)
695 (font-shape . italic)
696 (font-relative-size . -1)
697 (meta . ,(grob-description "TupletBracket" text-interface
698 tuplet-bracket-interface font-interface))
702 (molecule-callback . ,Text_item::brew_molecule)
703 (font-shape . italic)
704 (no-spacing-rods . #t)
705 (self-alignment-X . 0)
707 (X-offset-callbacks . (,Side_position_interface::aligned_on_self))
708 (Y-offset-callbacks .
709 (,Side_position_interface::aligned_side
710 ,Side_position_interface::centered_on_parent))
711 (meta . ,(grob-description "UnaCordaPedal" text-interface font-interface))
715 (molecule-callback . ,Volta_spanner::brew_molecule)
720 (Y-offset-callbacks . (,Side_position_interface::aligned_side))
721 (thickness . 1.6) ; stafflinethickness
722 (height . 2.0) ; staffspace;
724 (font-family . number)
725 (font-relative-size . -2)
726 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
729 (VerticalAlignment . (
731 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
732 (X-extent-callback . #f)
734 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
737 (VerticalAxisGroup . (
739 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
745 ; (display (map pair? all-grob-descriptions))