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 (y-dy-callbacks . (,Beam::least_squares
61 ,Beam::cancel_suspect_slope
65 ,Beam::do_quantise_y))
67 (thickness . 0.48) ; in staff-space
68 (before-line-breaking-callback . ,Beam::before_line_breaking)
69 (after-line-breaking-callback . ,Beam::after_line_breaking)
70 (default-neutral-direction . 1)
71 (dir-function . ,beam-dir-majority)
72 (height-quants . ,default-beam-dy-quants)
73 (vertical-position-quant-function . ,default-beam-y-quants)
74 (beamed-stem-shorten . (0.5))
75 (outer-stem-length-limit . 0.2)
77 (flag-width-function . ,default-beam-flag-width-function)
78 (space-function . ,default-beam-space-function)
81 (meta . ,(grob-description "Beam" beam-interface))
88 (X-offset-callbacks . (,Break_align_interface::self_align_callback))
89 (space-alist . ,default-break-align-space-alist)
90 (meta . ,(grob-description "BreakAlignment"
91 axis-group-interface align-interface
98 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
100 (meta . ,(grob-description "BreakAlignGroup" axis-group-interface))
104 (break-align-symbol . Breathing_sign)
106 (molecule-callback . ,Breathing_sign::brew_molecule)
107 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
108 (visibility-lambda . ,begin-of-line-invisible)
109 (meta . ,(grob-description "BreathingSign" break-aligned-interface))
113 (molecule-callback . ,Clef::brew_molecule)
114 (before-line-breaking-callback . ,Clef::before_line_breaking)
116 (font-family . music)
117 (break-align-symbol . Clef_item)
118 (visibility-lambda . ,begin-of-line-visible)
119 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
120 (meta . ,(grob-description "Clef" clef-interface font-interface break-aligned-interface ))
124 (molecule-callback . ,Chord_name::brew_molecule)
125 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
126 (chord-name-function . ,default-chord-name-function)
127 (font-family . roman)
128 (meta . ,(grob-description "ChordName" font-interface text-interface chord-name-interface))
132 (break-align-symbol . Custos)
134 (molecule-callback . ,Custos::brew_molecule)
135 (visibility-lambda . ,end-of-line-visible)
137 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
138 (meta . ,(grob-description "Custos" custos-interface staff-symbol-interface break-aligned-interface) )
142 (molecule-callback . ,Hairpin::brew_molecule)
146 (if-text-padding . 1.0)
147 (width-correct . -1.0)
149 (dash-thickness . 1.2)
151 (self-alignment-Y . 0)
152 (Y-offset-callbacks . (,Side_position::aligned_on_self))
153 (meta . ,(grob-description "Hairpin" hairpin-interface))
158 (meta . ,(grob-description "DotColumn" dot-column-interface axis-group-interface))
162 (molecule-callback . ,Dots::brew_molecule)
164 (staff-position . 0.0)
165 (Y-offset-callbacks . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
166 (meta . ,(grob-description "Dots" font-interface dot-interface ))
170 (Y-offset-callbacks . (,Side_position::aligned_on_self))
171 (molecule-callback . ,Text_item::brew_molecule)
172 (script-priority . 100)
174 (font-family . dynamic)
175 (font-shape . italic)
176 (self-alignment-Y . 0)
177 (meta . ,(grob-description "DynamicText" font-interface text-interface ))
180 (DynamicLineSpanner . (
183 (minimum-space . 1.2)
184 (meta . ,(grob-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
188 (break-align-symbol . Left_edge_item)
189 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
191 (meta . ,(grob-description "LeftEdge" break-aligned-interface))
195 (molecule-callback . ,Text_item::brew_molecule)
196 (X-offset-callbacks . (,Side_position::centered_on_parent ,Side_position::aligned_on_self))
198 (self-alignment-X . 0)
199 (font-family . number)
200 (font-relative-size . -3)
201 (font-shape . upright)
202 (meta . ,(grob-description "Fingering" finger-interface font-interface text-script-interface text-interface side-position-interface))
207 (horizontal-space . 1.2)
209 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
210 (meta . ,(grob-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
213 (HaraKiriVerticalGroup . (
214 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
215 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
217 (meta . ,(grob-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
223 (minimum-length . 0.5)
224 (molecule-callback . ,Hyphen_spanner::brew_molecule)
225 (Y-extent-callback . ,Grob::point_dimension_callback)
226 (meta . ,(grob-description "LyricHyphen" lyric-hyphen-interface ))
231 (Y-offset-callbacks . (,Side_position::centered_on_parent
232 ,Side_position::aligned_on_self))
233 (self-alignment-Y . 0)
234 (molecule-callback . ,Text_item::brew_molecule)
235 (break-align-symbol . Instrument_name)
236 (visibility-lambda . ,begin-of-line-visible)
237 (font-family . roman)
238 (meta . ,(grob-description "InstrumentName" font-interface text-interface break-aligned-interface))
242 (molecule-callback . ,Key_item::brew_molecule)
243 (break-align-symbol . Key_item)
244 (visibility-lambda . ,begin-of-line-visible)
246 (meta . ,(grob-description "KeySignature" key-signature-interface font-interface break-aligned-interface))
250 (molecule-callback . ,Local_key_item::brew_molecule)
251 (X-offset-callbacks . (,Side_position::aligned_side))
254 (right-padding . 0.4)
255 (meta . ,(grob-description "Accidentals" accidentals-interface font-interface side-position-interface))
260 (meta . ,(grob-description "LineOfScore" line-of-score-interface axis-group-interface))
264 (molecule-callback . ,Lyric_extender::brew_molecule)
265 (height . 0.8) ; stafflinethickness;
266 (right-trim-amount . 0.5)
267 (Y-extent-callback . ,Grob::point_dimension_callback)
268 (meta . ,(grob-description "LyricExtender" lyric-extender-interface))
272 (molecule-callback . ,Text_item::brew_molecule)
273 (X-offset-callbacks . (,Side_position::aligned_on_self))
274 (self-alignment-X . 0)
277 (font-family . roman)
278 (font-shape . upright)
279 (meta . ,(grob-description "LyricText" lyric-syllable-interface text-interface font-interface ))
283 (molecule-callback . ,Text_item::brew_molecule)
286 (font-family . number)
287 (font-shape . upright)
288 (font-relative-size . 1)
289 (visibility-lambda . ,end-of-line-invisible)
291 (meta . ,(grob-description "RehearsalMark" mark-interface side-position-interface))
294 (MultiMeasureRest . (
295 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
296 (molecule-callback . ,Multi_measure_rest::brew_molecule)
299 (padding . 2.0) ; staffspace
300 (minimum-width . 12.5) ; staffspace
301 (font-family . number)
302 (font-relative-size . 1)
303 (meta . ,(grob-description "MultiMeasureRest" multi-measure-rest-interface font-interface ))
308 (meta . ,(grob-description "NoteCollision"
309 note-collision-interface axis-group-interface
315 (meta . ,(grob-description "NoteColumn" axis-group-interface note-column-interface))
320 (molecule-callback . ,Note_head::brew_molecule)
321 (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
322 (meta . ,(grob-description "NoteHead"
323 rhythmic-head-interface font-interface
324 note-head-interface ))
330 (X-extent-callback . #f)
331 (Y-extent-callback . #f)
332 (molecule-callback . ,Line_spanner::brew_molecule)
333 (meta . ,(grob-description "Glissando"
334 line-spanner-interface))
340 (X-extent-callback . #f)
341 (Y-extent-callback . #f)
342 (molecule-callback . ,Line_spanner::brew_molecule)
343 (meta . ,(grob-description "FollowThread"
344 line-spanner-interface))
348 (molecule-callback . ,Text_item::brew_molecule)
349 (font-family . roman)
350 (meta . ,(grob-description "NoteName"
351 note-name-interface font-interface
356 (self-alignment-X . 0)
358 (visibility-lambda . ,begin-of-line-visible)
359 (X-offset-callbacks . (,Side_position::centered_on_parent ,Side_position::aligned_on_self))
360 (Y-offset-callbacks . (,Side_position::aligned_side))
361 (molecule-callback . ,Text_item::brew_molecule)
362 (font-shape . italic)
363 (font-family . roman)
364 (meta . ,(grob-description "OctavateEight" text-interface font-interface ))
369 (before-grace-spacing-factor . 1.2)
370 (before-musical-spacing-factor . 0.4)
371 (meta . ,(grob-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
373 (NonMusicalPaperColumn . (
375 (before-musical-spacing-factor . 1.0)
376 (column-space-strength . 2.0)
377 (meta . ,(grob-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
381 (after-line-breaking-callback . ,Rest::after_line_breaking)
382 (X-extent-callback . ,Rest::extent_callback)
383 (Y-extent-callback . ,Rest::extent_callback)
384 (molecule-callback . ,Rest::brew_molecule)
385 (minimum-beam-collision-distance . 1.5)
386 (meta . ,(grob-description "Rest"
387 rhythmic-head-interface
391 (minimum-distance . 0.75)
392 (meta . ,(grob-description "RestCollision" rest-collision-interface ))
396 (molecule-callback . ,Script::brew_molecule)
397 (X-offset-callbacks . (,Side_position::centered_on_parent))
398 (after-line-breaking-callback . ,Script::after_line_breaking)
399 (meta . ,(grob-description "Script" script-interface side-position-interface font-interface))
403 (before-line-breaking-callback . ,Script_column::before_line_breaking)
404 (meta . ,(grob-description "ScriptColumn" script-column-interface))
408 (molecule-callback . ,Slur::brew_molecule)
410 (spacing-procedure . ,Slur::set_spacing_rods)
411 (minimum-length . 1.5)
412 (after-line-breaking-callback . ,Slur::after_line_breaking)
413 (extremity-rules . ,default-slur-extremity-rules)
414 (extremity-offset-alist . ,default-slur-extremity-offset-alist)
415 (de-uglify-parameters . ( 1.5 0.8 -2.0))
416 (Y-extent-callback . ,Slur::height)
417 (details . ((height-limit . 2.0) (ratio . 0.333) (force-blowfit . 0.5)
418 (bezier-pct-c0 . -0.2) (bezier-pct-c3 . 0.000006)
419 (bezier-pct-out-max . 0.8) (bezier-pct-in-max . 1.2)
420 (bezier-area-steps . 1.0)))
423 (attachment . (#f . #f))
424 (attachment-offset . ((0 . 0) . (0 . 0)))
426 (meta . ,(grob-description "Slur" slur-interface))
430 (spacing-procedure . ,Spacing_spanner::set_springs)
431 (stem-spacing-correction . 0.5)
432 (arithmetic-basicspace . 2.0)
433 (arithmetic-multiplier . ,(* 0.9 1.32))
434 ;; assume that notes at least this long are present.
435 (maximum-duration-for-spacing . ,(make-moment 1 8))
436 (meta . ,(grob-description "SpacingSpanner" spacing-spanner-interface))
439 (break-align-symbol . Staff_bar)
440 (barsize-procedure . ,Span_bar::get_bar_size)
441 (molecule-callback . ,Bar::brew_molecule)
442 (visibility-lambda . ,begin-of-line-invisible)
443 (X-extent-callback . ,Span_bar::width_callback)
444 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
448 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
452 ;; Ross. page 151 lists other values, we opt for a leaner look
456 (hair-thickness . 1.6)
457 (thick-thickness . 6.0)
458 (meta . ,(grob-description "SpanBar" span-bar-interface bar-line-interface ))
463 (molecule-callback . ,Text_item::brew_molecule)
464 (break-align-symbol . Clef_item)
465 (visibility-lambda . ,begin-of-line-visible)
466 (font-family . roman)
467 (meta . ,(grob-description "StanzaNumber" break-aligned-interface text-interface font-interface))
471 (molecule-callback . ,Staff_symbol::brew_molecule)
474 (meta . ,(grob-description "StaffSymbol" staff-symbol-interface ))
477 (molecule-callback . ,Text_item::brew_molecule)
478 (X-offset-callbacks . (,Side_position::aligned_on_self))
479 (Y-offset-callbacks .
480 (,Side_position::aligned_side
481 ,Side_position::centered_on_parent))
482 (no-spacing-rods . #t)
483 (font-shape . italic)
484 (self-alignment-X . 0)
485 (meta . ,(grob-description "SostenutoPedal" text-interface font-interface))
489 (before-line-breaking-callback . ,Stem::before_line_breaking)
490 (molecule-callback . ,Stem::brew_molecule)
492 (beamed-lengths . (0.0 2.5 2.0 1.5))
493 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
495 ;; Stems in unnatural (forced) direction should be shortened,
496 ;; according to [Roush & Gourlay]. Their suggestion to knock off
497 ;; a whole staffspace seems a bit drastical: we'll do half.
499 (lengths . (3.5 3.5 3.5 4.5 5.0))
500 (stem-shorten . (0.5))
501 ; if stem is on middle line, choose this direction.
502 (default-neutral-direction . 1)
503 (X-offset-callbacks . (,Stem::off_callback))
504 (X-extent-callback . ,Stem::dim_callback)
505 (Y-extent-callback . ,Stem::height)
506 (meta . ,(grob-description "Stem" stem-interface font-interface))
510 (molecule-callback . ,Stem_tremolo::brew_molecule)
511 (Y-extent-callback . ,Stem_tremolo::height)
512 (X-extent-callback . #f)
514 (beam-width . 2.0) ; staff-space
515 (beam-thickness . 0.42) ; staff-space
516 (beam-space-function . ,default-beam-space-function)
517 (meta . ,(grob-description "StemTremolo" stem-tremolo-interface ))
521 (meta . ,(grob-description "SeparationItem" separation-item-interface ))
523 (SeparatingGroupSpanner . (
524 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
525 (meta . ,(grob-description "SeparatingGroupSpanner" separation-spanner-interface))
529 (no-spacing-rods . #t)
530 (molecule-callback . ,Sustain_pedal::brew_molecule)
531 (self-alignment-X . 0)
532 (X-offset-callbacks . (,Side_position::aligned_on_self))
533 (Y-offset-callbacks .
534 (,Side_position::aligned_side
535 ,Side_position::centered_on_parent))
537 (meta . ,(grob-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
541 (SystemStartDelimiter . (
542 (molecule-callback . ,System_start_delimiter::brew_molecule)
543 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
544 ;; ugh, in practice, brace has height of 4.1 staff-spaces
545 (brace-collapse-height . 4.1)
546 (bracket-collapse-height . 1)
553 (bracket-thick . 0.25)
554 (Y-extent-callback . #f)
555 (font-family . braces)
556 ;; if you want to set point-size, you cannot set
557 ;; relative-size, as no font will be found for other
559 ;;(font-point-size . 20)
560 ;;(font-relative-size . #f)
561 (meta . ,(grob-description "SystemStartDelimiter" system-start-delimiter-interface font-interface))
565 (molecule-callback . ,Text_item::brew_molecule)
566 (no-spacing-rods . #t)
568 (font-family . roman)
569 (font-shape . italic)
570 (meta . ,(grob-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
573 (molecule-callback . ,Text_spanner::brew_molecule)
574 (font-shape . italic)
575 (font-family . roman)
578 ;; urg, only for (de)cresc. text spanners
579 (if-text-padding . 1.0)
583 (meta . ,(grob-description "TextSpanner" text-spanner-interface font-interface))
586 (molecule-callback . ,Tie::brew_molecule)
587 (spacing-procedure . ,Tie::set_spacing_rods)
588 (staffline-clearance . 0.35)
589 (details . ((ratio . 0.333) (height-limit . 1.0)))
592 (minimum-length . 2.5)
593 (meta . ,(grob-description "Tie" tie-interface ))
597 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
598 (meta . ,(grob-description "TieColumn" tie-column-interface ))
602 (molecule-callback . ,Time_signature::brew_molecule)
603 (break-align-symbol . Time_signature)
604 (visibility-lambda . ,all-visible)
606 (font-family . number)
607 (meta . ,(grob-description "TimeSignature" time-signature-interface font-interface))
614 (after-line-breaking-callback . ,Tuplet_spanner::after_line_breaking)
615 (molecule-callback . ,Tuplet_spanner::brew_molecule)
616 (font-family . roman)
617 (font-shape . italic)
618 (font-relative-size . -1)
619 (meta . ,(grob-description "TupletBracket" text-interface
620 tuplet-bracket-interface font-interface))
624 (molecule-callback . ,Text_item::brew_molecule)
625 (font-shape . italic)
626 (no-spacing-rods . #t)
627 (self-alignment-X . 0)
628 (X-offset-callbacks . (,Side_position::aligned_on_self))
629 (Y-offset-callbacks .
630 (,Side_position::aligned_side
631 ,Side_position::centered_on_parent))
632 (meta . ,(grob-description "UnaChordaPedal" text-interface font-interface))
636 (molecule-callback . ,Volta_spanner::brew_molecule)
641 (Y-offset-callbacks . (,Side_position::aligned_side))
642 (thickness . 1.6) ; stafflinethickness
643 (height . 2.0) ; staffspace;
645 (font-family . number)
646 (font-relative-size . -2)
647 (meta . ,(grob-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
650 (VerticalAlignment . (
652 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
653 (X-extent-callback . #f)
655 (meta . ,(grob-description "VerticalAlignment" align-interface axis-group-interface))
658 (VerticalAxisGroup . (
660 (meta . ,(grob-description "VerticalAxisGroup" axis-group-interface))
666 ; (display (map pair? all-grob-descriptions))