1 ;;;; grob-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2000 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::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 (meta . ,(grob-description "BarNumber"
53 text-interface font-interface break-aligned-interface))
57 ;; todo: clean this up a bit: the list is getting
59 (molecule-callback . ,Beam::brew_molecule)
60 (thickness . 0.48) ; in staff-space
61 (before-line-breaking-callback . ,Beam::before_line_breaking)
62 (after-line-breaking-callback . ,Beam::after_line_breaking)
63 (default-neutral-direction . 1)
64 (dir-function . ,beam-dir-majority)
65 (height-quants . ,default-beam-dy-quants)
66 (vertical-position-quant-function . ,default-beam-y-quants)
67 (beamed-stem-shorten . (0.5))
68 (outer-stem-length-limit . 0.2)
70 (flag-width-function . ,default-beam-flag-width-function)
71 (space-function . ,default-beam-space-function)
73 (meta . ,(grob-description "Beam" beam-interface))
80 (X-offset-callbacks . (,Break_align_interface::self_align_callback))
81 (space-alist . ,default-break-align-space-alist)
82 (meta . ,(grob-description "BreakAlignment"
83 axis-group-interface align-interface
90 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
92 (meta . ,(grob-description "BreakAlignGroup" axis-group-interface))
96 (break-align-symbol . Breathing_sign)
98 (molecule-callback . ,Breathing_sign::brew_molecule)
99 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
100 (visibility-lambda . ,begin-of-line-invisible)
101 (meta . ,(grob-description "BreathingSign" break-aligned-interface))
105 (molecule-callback . ,Clef::brew_molecule)
106 (before-line-breaking-callback . ,Clef::before_line_breaking)
108 (font-family . music)
109 (break-align-symbol . Clef_item)
110 (visibility-lambda . ,begin-of-line-visible)
111 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
112 (meta . ,(grob-description "Clef" clef-interface font-interface break-aligned-interface ))
116 (molecule-callback . ,Chord_name::brew_molecule)
117 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
118 (chord-name-function . ,default-chord-name-function)
119 (font-family . roman)
120 (meta . ,(grob-description "ChordName" font-interface text-interface chord-name-interface))
124 (break-align-symbol . Custos)
126 (molecule-callback . ,Custos::brew_molecule)
127 (visibility-lambda . ,end-of-line-visible)
129 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
130 (meta . ,(grob-description "Custos" custos-interface staff-symbol-interface break-aligned-interface) )
134 (molecule-callback . ,Hairpin::brew_molecule)
138 (if-text-padding . 1.0)
139 (width-correct . -1.0)
141 (dash-thickness . 1.2)
143 (self-alignment-Y . 0)
144 (Y-offset-callbacks . (,Side_position::aligned_on_self))
145 (meta . ,(grob-description "Hairpin" hairpin-interface))
150 (meta . ,(grob-description "DotColumn" dot-column-interface axis-group-interface))
154 (molecule-callback . ,Dots::brew_molecule)
156 (staff-position . 0.0)
157 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
158 (meta . ,(grob-description "Dots" font-interface dot-interface ))
162 (Y-offset-callbacks . (,Side_position::aligned_on_self))
163 (molecule-callback . ,Text_item::brew_molecule)
164 (script-priority . 100)
166 (font-family . dynamic)
167 (font-shape . italic)
168 (self-alignment-Y . 0)
169 (meta . ,(grob-description "DynamicText" font-interface text-interface ))
172 (DynamicLineSpanner . (
175 (minimum-space . 1.2)
176 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
180 (break-align-symbol . Left_edge_item)
181 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
183 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
187 (molecule-callback . ,Text_item::brew_molecule)
188 (X-offset-callbacks . (,Side_position::centered_on_parent ,Side_position::aligned_on_self))
190 (self-alignment-X . 0)
191 (font-family . number)
192 (font-relative-size . -3)
193 (font-shape . upright)
194 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
199 (horizontal-space . 1.2)
201 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
202 (meta . ,(grob-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
205 (HaraKiriVerticalGroup . (
206 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
207 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
209 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
215 (minimum-length . 0.5)
216 (molecule-callback . ,Hyphen_spanner::brew_molecule)
217 (Y-extent-callback . ,Grob::point_dimension_callback)
218 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
223 (Y-offset-callbacks . (,Side_position::centered_on_parent
224 ,Side_position::aligned_on_self))
225 (self-alignment-Y . 0)
226 (molecule-callback . ,Text_item::brew_molecule)
227 (break-align-symbol . Instrument_name)
228 (visibility-lambda . ,begin-of-line-visible)
229 (font-family . roman)
230 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
234 (molecule-callback . ,Key_item::brew_molecule)
235 (break-align-symbol . Key_item)
236 (visibility-lambda . ,begin-of-line-visible)
238 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
242 (molecule-callback . ,Local_key_item::brew_molecule)
243 (X-offset-callbacks . (,Side_position::aligned_side))
246 (right-padding . 0.4)
247 (meta . ,(grob-description "Accidentals" accidentals-interface font-interface side-position-interface))
252 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
256 (molecule-callback . ,Lyric_extender::brew_molecule)
257 (height . 0.8) ; stafflinethickness;
258 (right-trim-amount . 0.5)
259 (Y-extent-callback . ,Grob::point_dimension_callback)
260 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
264 (molecule-callback . ,Text_item::brew_molecule)
265 (X-offset-callbacks . (,Side_position::aligned_on_self))
266 (self-alignment-X . 0)
269 (font-family . roman)
270 (font-shape . upright)
271 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
275 (molecule-callback . ,Text_item::brew_molecule)
278 (font-family . number)
279 (font-shape . upright)
280 (font-relative-size . 1)
281 (visibility-lambda . ,end-of-line-invisible)
283 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
286 (MultiMeasureRest . (
287 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
288 (molecule-callback . ,Multi_measure_rest::brew_molecule)
291 (padding . 2.0) ; staffspace
292 (minimum-width . 12.5) ; staffspace
293 (font-family . number)
294 (font-relative-size . 1)
295 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface font-interface ))
300 (meta . ,(grob-description "NoteCollision"
301 note-collision-interface axis-group-interface
307 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
312 (molecule-callback . ,Note_head::brew_molecule)
313 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
314 (meta . ,(grob-description "NoteHead"
315 rhythmic-head-interface font-interface
316 note-head-interface ))
322 (X-extent-callback . #f)
323 (Y-extent-callback . #f)
324 (molecule-callback . ,Line_spanner::brew_molecule)
325 (meta . ,(grob-description "Glissando"
326 line-spanner-interface))
332 (X-extent-callback . #f)
333 (Y-extent-callback . #f)
334 (molecule-callback . ,Line_spanner::brew_molecule)
335 (meta . ,(grob-description "FollowThread"
336 line-spanner-interface))
340 (molecule-callback . ,Text_item::brew_molecule)
341 (font-family . roman)
342 (meta . ,(grob-description "NoteName"
343 note-name-interface font-interface
348 (self-alignment-X . 0)
350 (visibility-lambda . ,begin-of-line-visible)
351 (X-offset-callbacks . (,Side_position::centered_on_parent ,Side_position::aligned_on_self))
352 (Y-offset-callbacks . (,Side_position::aligned_side))
353 (molecule-callback . ,Text_item::brew_molecule)
354 (font-shape . italic)
355 (font-family . roman)
356 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
361 (before-grace-spacing-factor . 1.2)
362 (before-musical-spacing-factor . 0.4)
363 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
365 (NonMusicalPaperColumn . (
367 (before-musical-spacing-factor . 1.0)
368 (column-space-strength . 2.0)
369 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
373 (after-line-breaking-callback . ,Rest::after_line_breaking)
374 (X-extent-callback . ,Rest::extent_callback)
375 (Y-extent-callback . ,Rest::extent_callback)
376 (molecule-callback . ,Rest::brew_molecule)
377 (minimum-beam-collision-distance . 1.5)
378 (meta . ,(grob-description "Rest"
379 rhythmic-head-interface
383 (minimum-distance . 0.75)
384 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
388 (molecule-callback . ,Script::brew_molecule)
389 (X-offset-callbacks . (,Side_position::centered_on_parent))
390 (after-line-breaking-callback . ,Script::after_line_breaking)
391 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
395 (before-line-breaking-callback . ,Script_column::before_line_breaking)
396 (meta . ,(grob-description "ScriptColumn" script-column-interface))
400 (molecule-callback . ,Slur::brew_molecule)
402 (spacing-procedure . ,Slur::set_spacing_rods)
403 (minimum-length . 1.5)
404 (after-line-breaking-callback . ,Slur::after_line_breaking)
405 (extremity-rules . ,default-slur-extremity-rules)
406 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
407 (de-uglify-parameters . ( 1.5 0.8 -2.0))
408 (Y-extent-callback . ,Slur::height)
409 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
410 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
411 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
412 (bezier-area-steps . 1.0)))
415 (attachment . (#f . #f))
416 (attachment-offset . ((0 . 0) . (0 . 0)))
418 (meta . ,(grob-description "Slur" slur-interface))
422 (spacing-procedure . ,Spacing_spanner::set_springs)
423 (stem-spacing-correction . 0.5)
424 (arithmetic-basicspace . 2.0)
425 (arithmetic-multiplier . ,(* 0.9 1.32))
426 ;; assume that notes at least this long are present.
427 (maximum-duration-for-spacing . ,(make-moment 1 8))
428 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
431 (break-align-symbol . Staff_bar)
432 (barsize-procedure . ,Span_bar::get_bar_size)
433 (molecule-callback . ,Bar::brew_molecule)
434 (visibility-lambda . ,begin-of-line-invisible)
435 (X-extent-callback . ,Span_bar::width_callback)
436 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
440 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
444 ;; Ross. page 151 lists other values, we opt for a leaner look
448 (hair-thickness . 1.6)
449 (thick-thickness . 6.0)
450 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
455 (molecule-callback . ,Text_item::brew_molecule)
456 (break-align-symbol . Clef_item)
457 (visibility-lambda . ,begin-of-line-visible)
458 (font-family . roman)
459 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
463 (molecule-callback . ,Staff_symbol::brew_molecule)
466 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
469 (molecule-callback . ,Text_item::brew_molecule)
470 (X-offset-callbacks . (,Side_position::aligned_on_self))
471 (Y-offset-callbacks .
472 (,Side_position::aligned_side
473 ,Side_position::centered_on_parent))
474 (no-spacing-rods . #t)
475 (font-shape . italic)
476 (self-alignment-X . 0)
477 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
481 (before-line-breaking-callback . ,Stem::before_line_breaking)
482 (molecule-callback . ,Stem::brew_molecule)
484 (beamed-lengths . (0.0 2.5 2.0 1.5))
485 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
487 ;; Stems in unnatural (forced) direction should be shortened,
488 ;; according to [Roush & Gourlay]. Their suggestion to knock off
489 ;; a whole staffspace seems a bit drastical: we'll do half.
491 (lengths . (3.5 3.5 3.5 4.5 5.0))
492 (stem-shorten . (0.5))
493 ; if stem is on middle line, choose this direction.
494 (default-neutral-direction . 1)
495 (X-offset-callbacks . (,Stem::off_callback))
496 (X-extent-callback . ,Stem::dim_callback)
497 (Y-extent-callback . ,Stem::height)
498 (meta . ,(grob-description "Stem" stem-interface font-interface))
502 (molecule-callback . ,Stem_tremolo::brew_molecule)
503 (Y-extent-callback . ,Stem_tremolo::height)
504 (X-extent-callback . #f)
506 (beam-width . 2.0) ; staff-space
507 (beam-thickness . 0.42) ; staff-space
508 (beam-space-function . ,default-beam-space-function)
509 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
513 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
515 (SeparatingGroupSpanner . (
516 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
517 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
521 (no-spacing-rods . #t)
522 (molecule-callback . ,Sustain_pedal::brew_molecule)
523 (self-alignment-X . 0)
524 (X-offset-callbacks . (,Side_position::aligned_on_self))
525 (Y-offset-callbacks .
526 (,Side_position::aligned_side
527 ,Side_position::centered_on_parent))
529 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
533 (SystemStartDelimiter . (
534 (molecule-callback . ,System_start_delimiter::brew_molecule)
535 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
536 (collapse-height . 1.0)
543 (bracket-thick . 0.25)
544 (bracket-width . 2.0)
545 (Y-extent-callback . #f)
546 (font-family . braces)
547 ;; if you want to set point-size, you cannot set
548 ;; relative-size, as no font will be found for other
550 ;;(font-point-size . 20)
551 ;;(font-relative-size . #f)
552 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
556 (molecule-callback . ,Text_item::brew_molecule)
557 (no-spacing-rods . #t)
559 (font-family . roman)
560 (font-shape . italic)
561 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
564 (molecule-callback . ,Text_spanner::brew_molecule)
565 (font-shape . italic)
566 (font-family . roman)
569 ;; urg, only for (de)cresc. text spanners
570 (if-text-padding . 1.0)
574 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
577 (molecule-callback . ,Tie::brew_molecule)
578 (spacing-procedure . ,Tie::set_spacing_rods)
579 (staffline-clearance . 0.35)
580 (details . ((ratio . 0.333) (height-limit . 1.0)))
583 (minimum-length . 2.5)
584 (meta . ,(grob-description "Tie" tie-interface ))
588 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
589 (meta . ,(grob-description "TieColumn" tie-column-interface ))
593 (molecule-callback . ,Time_signature::brew_molecule)
594 (break-align-symbol . Time_signature)
595 (visibility-lambda . ,all-visible)
597 (font-family . number)
598 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
605 (after-line-breaking-callback . ,Tuplet_spanner::after_line_breaking)
606 (molecule-callback . ,Tuplet_spanner::brew_molecule)
607 (font-family . roman)
608 (font-shape . italic)
609 (font-relative-size . -1)
610 (meta . ,(grob-description "TupletBracket" text-interface
611 tuplet-bracket-interface font-interface))
615 (molecule-callback . ,Text_item::brew_molecule)
616 (font-shape . italic)
617 (no-spacing-rods . #t)
618 (self-alignment-X . 0)
619 (X-offset-callbacks . (,Side_position::aligned_on_self))
620 (Y-offset-callbacks .
621 (,Side_position::aligned_side
622 ,Side_position::centered_on_parent))
623 (meta . ,(grob-description "UnaChordaPedal" text-interface font-interface))
627 (molecule-callback . ,Volta_spanner::brew_molecule)
632 (Y-offset-callbacks . (,Side_position::aligned_side))
633 (thickness . 1.6) ; stafflinethickness
634 (height . 2.0) ; staffspace;
636 (font-family . number)
637 (font-relative-size . -2)
638 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
641 (VerticalAlignment . (
643 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
644 (X-extent-callback . #f)
646 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
649 (VerticalAxisGroup . (
651 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
657 ; (display (map pair? all-grob-descriptions))