]> git.donarmstrong.com Git - lilypond.git/blob - scm/element-descriptions.scm
4ea382e3e70169797668c8c4493c5dab4fe39bf5
[lilypond.git] / scm / element-descriptions.scm
1
2 ; distances are given in stafflinethickness (thicknesses) and
3 ; staffspace (distances)
4
5 (define all-element-descriptions
6   `((Arpeggio . (
7                (X-extent-callback . ,Arpeggio::width_callback)
8                (molecule-callback . ,Arpeggio::brew_molecule)
9                (Y-offset-callbacks . (,Staff_symbol_referencer::callback))
10                (X-offset-callbacks . (,Side_position::aligned_side))
11                (direction . -1)
12                (staff-position . 0.0)
13                (meta . ,(element-description "Arpeggio" arpeggio-interface side-position-interface font-interface))
14                ))
15   
16         (BarLine . (
17                 (break-align-symbol . Staff_bar)
18                 (glyph . "|")
19                 (break-glyph-function . ,default-break-barline)
20                 (barsize-procedure . ,Bar::get_staff_bar_size)
21                 (molecule-callback . ,Bar::brew_molecule)          
22                 (visibility-lambda . ,all-visible)
23                 (breakable . #t)
24                 (before-line-breaking-callback . ,Bar::before_line_breaking)
25                 ;;
26                 ;; Ross. page 151 lists other values, we opt for a leaner look
27                 ;; 
28                 (kern . 3.0)
29                 (thin-kern . 3.0)
30                 (hair-thickness . 1.6)
31                 (thick-thickness . 6.0)
32                 (meta . ,(element-description  "BarLine" bar-line-interface font-interface))
33         ))
34
35         (BarNumber . (
36                 (molecule-callback . ,Text_item::brew_molecule)
37                 (breakable . #t)
38                 (visibility-lambda . ,begin-of-line-visible)
39                 (padding . 1.0)
40                 (direction . 1)
41                 (font-family . roman)
42                 (font-relative-size . -1)
43                 (meta . ,(element-description "BarNumber"
44                         text-interface  font-interface break-aligned-interface))
45         ))
46
47         (Beam . ,basic-beam-properties)
48          
49         (BreakAlignment . (
50                 (breakable . #t)
51                 (stacking-dir . 1)
52                 (axes 0)
53                 (X-offset-callbacks . (,Break_align_interface::self_align_callback))
54                 (space-alist . ,default-break-align-space-alist) 
55                 (meta . ,(element-description "BreakAlignment"
56                         axis-group-interface align-interface
57                         )
58                 )
59         ))
60
61         (BreakAlignGroup . (
62                 (axes  . (0))
63                 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
64                 
65                 (meta . ,(element-description "BreakAlignGroup" axis-group-interface))
66         ))
67
68         (BreathingSign . (
69                 (break-align-symbol . Breathing_sign)
70                 (breakable . #t )
71                 (molecule-callback . ,Breathing_sign::brew_molecule)
72                 (Y-offset-callbacks . (,Breathing_sign::offset_callback))
73                 (visibility-lambda . ,begin-of-line-invisible)
74                 (meta . ,(element-description "BreathingSign"  break-aligned-interface))
75         ))
76
77         (Clef . (
78            (molecule-callback . ,Clef::brew_molecule)
79            (before-line-breaking-callback . ,Clef::before_line_breaking)
80            (breakable . #t)
81            (font-family . music)           
82            (break-align-symbol . Clef_item)
83            (visibility-lambda . ,begin-of-line-visible)
84            (Y-offset-callbacks  . (,Staff_symbol_referencer::callback)) 
85            (meta . ,(element-description "Clef" clef-interface font-interface break-aligned-interface ))
86         ))
87
88         (ChordNames . (
89                 (molecule-callback . ,Chord_name::brew_molecule)
90                 (after-line-breaking-callback . ,Chord_name::after_line_breaking)
91                 (chord-name-function . ,default-chord-name-function)
92                 (font-family . roman)
93                 (meta . ,(element-description "ChordNames"  font-interface text-interface chord-name-interface))
94         ))
95
96         (NoteCollision . (
97                 (axes 0 1)
98                 (note-width . 1.65)
99                 (meta . ,(element-description "NoteCollision"
100                    note-collision-interface axis-group-interface
101                 ))
102         ))
103
104         (Crescendo . (
105                 (molecule-callback . ,Crescendo::brew_molecule)
106                 (thickness . 1.0)
107                 (shorten-for-letter  .  4.0)
108                 (height . 0.6666)
109                 (dash-thickness . 1.2)
110                 (dash-length . 4.0)
111                 (self-alignment-Y . 0)
112                 (Y-offset-callbacks . (,Side_position::aligned_on_self))
113                 (meta . ,(element-description "Crescendo" hairpin-interface))
114         ))
115
116         (DotColumn . (
117                 (axes 0 )
118                 (meta . ,(element-description "DotColumn" dot-column-interface  axis-group-interface))
119         ))
120
121         (Dots . (
122                 (molecule-callback . ,Dots::brew_molecule)
123                 (dot-count . 1)
124                (font-family . music)            
125                 (staff-position . 0.0)
126                 (Y-offset-callbacks  . (,Dots::quantised_position_callback ,Staff_symbol_referencer::callback))
127                 (meta . ,(element-description "Dots"  font-interface dot-interface ))
128         ))
129         
130         (DynamicText . (
131                 (Y-offset-callbacks . (,Side_position::aligned_on_self))
132                 (molecule-callback . ,Text_item::brew_molecule)
133                 (script-priority . 100)
134                 (font-series . bold)
135                 (font-family . dynamic)
136                 (self-alignment-Y . 0)
137                 (meta . ,(element-description "DynamicText" font-interface  text-interface ))
138         ))
139         
140         (DynamicLineSpanner . (
141                 (axes . ( 1))
142                 (padding . 3)
143                 (minimum-space . 6)
144                 (meta . ,(element-description "DynamicLineSpanner" dynamic-interface axis-group-interface side-position-interface))
145         ))
146         
147         (LeftEdge . (
148                 (break-align-symbol . Left_edge_item)
149                 (X-offset-callbacks . (,Break_align_interface::alignment_callback))
150                 (breakable . #t)
151                 (meta . ,(element-description "LeftEdge" break-aligned-interface))
152         ))
153         
154         (Fingering . (
155                 (molecule-callback . ,Text_item::brew_molecule)
156                 (X-offset-callbacks . (,Side_position::centered_on_parent ,Side_position::aligned_on_self))
157                 (padding .      3.0)
158                 (self-alignment-X . 0)
159                 (font-family . number)
160                 (font-relative-size . -3)
161                 (font-shape . upright)
162                 (meta . ,(element-description "Fingering" finger-interface  font-interface text-script-interface text-interface side-position-interface))
163         ))
164
165         (GraceAlignment . (
166                 (axes . (0))
167                 (horizontal-space . 1.2)
168                 (padding . 1.0)
169                 (before-line-breaking-callback . ,Grace_align_item::before_line_breaking)
170                 (meta . ,(element-description "GraceAlignment" axis-group-interface align-interface grace-alignment-interface))
171         ))
172         
173         (HaraKiriVerticalGroup . (
174                 (Y-offset-callbacks . (,Hara_kiri_group_spanner::force_hara_kiri_callback))
175                 (Y-extent-callback . ,Hara_kiri_group_spanner::y_extent)
176                 (axes 1)
177                 (meta . ,(element-description "HaraKiriVerticalGroup" axis-group-interface hara-kiri-group-interface))
178         ))
179
180         (LyricHyphen . (
181                 (thickness . 1.0)
182                 (height . 0.4)
183                 (minimum-length .  0.5) 
184                 (molecule-callback . ,Hyphen_spanner::brew_molecule)
185                 (Y-extent-callback . ,Score_element::point_dimension_callback)
186                 (meta . ,(element-description "LyricHyphen" lyric-hyphen-interface ))
187         ))
188         
189         (InstrumentName . (
190                 (breakable . #t)
191                 (Y-offset-callbacks . (,Side_position::centered_on_parent
192                                        ,Side_position::aligned_on_self))
193                 (self-alignment-Y . 0)
194                 (molecule-callback . ,Text_item::brew_molecule)         
195                 (break-align-symbol . Instrument_name)
196                 (visibility-lambda . ,begin-of-line-visible)
197                 (font-family . roman)
198                 (meta . ,(element-description "InstrumentName"  font-interface  text-interface break-aligned-interface))
199         ))
200         
201         (KeySignature . (
202           (molecule-callback . ,Key_item::brew_molecule)
203           (break-align-symbol . Key_item)
204           (visibility-lambda . ,begin-of-line-visible)
205           (breakable . #t)
206           (meta . ,(element-description "KeySignature" key-signature-interface  font-interface  break-aligned-interface))
207         ))
208         
209         (Accidentals . (
210                 (molecule-callback . ,Local_key_item::brew_molecule)
211                 (X-offset-callbacks . (,Side_position::aligned_side))
212                 (direction . -1)
213                 (left-padding . 0.2)
214                 (right-padding . 0.4)
215                 (meta . ,(element-description "Accidentals"  accidentals-interface font-interface ))
216         ))
217         
218         (LineOfScore . (
219                 (axes . (0 1))
220                 (meta . ,(element-description "LineOfScore"  line-of-score-interface axis-group-interface))
221         ))
222         
223         (LyricExtender . (
224                 (molecule-callback . ,Lyric_extender::brew_molecule)
225                 (height . 0.8) ; stafflinethickness;
226                 (right-trim-amount . 0.5)
227                 (Y-extent-callback . ,Score_element::point_dimension_callback)
228                 (meta . ,(element-description "LyricExtender"  lyric-extender-interface))
229         ))
230         
231         (LyricText . (
232                 (molecule-callback . ,Text_item::brew_molecule)
233                 (X-offset-callbacks . (,Side_position::aligned_on_self))
234                 (self-alignment-X . 0)
235                 (non-rhythmic . #t)
236                 (word-space . 0.6)
237                 (font-family . roman)
238                 (font-shape . upright)
239                 (font-relative-size . 0)
240                 (meta . ,(element-description "LyricText" lyric-syllable-interface text-interface font-interface ))
241         ))
242         
243         (RehearsalMark . (
244                 (molecule-callback . ,Text_item::brew_molecule) 
245                 (breakable . #t)
246                 (font-family . number)
247                 (font-relative-size . 1)
248                 (visibility-lambda . ,end-of-line-invisible)
249                 (padding . 4.0)
250                 (meta . ,(element-description "RehearsalMark"  mark-interface side-position-interface))
251         ))
252         
253         (MultiMeasureRest . (
254                 (spacing-procedure . ,Multi_measure_rest::set_spacing_rods)
255                 (molecule-callback . ,Multi_measure_rest::brew_molecule)
256                 (staff-position . 0)
257                 (expand-limit . 10)
258                 (padding . 2.0) ; staffspace
259                 (minimum-width . 12.5) ; staffspace
260                 (font-family . number)
261                 (font-relative-size . 1)
262                 (meta . ,(element-description "MultiMeasureRest" multi-measure-rest-interface  font-interface ))
263         ))
264         
265         (NoteColumn . (
266                 (axes . (0 1))
267                 (meta . ,(element-description "NoteColumn"  axis-group-interface note-column-interface))
268         ))
269
270         (NoteHead . (
271                 (style . default)
272                 (molecule-callback . ,Note_head::brew_molecule)
273                 (Y-offset-callbacks  . (,Staff_symbol_referencer::callback)) 
274                 (meta . ,(element-description  "NoteHead"
275                         rhythmic-head-interface font-interface 
276                         note-head-interface ))
277         ))
278
279         (NoteName . (
280                 (style . default)
281                 (molecule-callback . ,Text_item::brew_molecule)
282                 (meta . ,(element-description  "NoteName"
283                                                note-name-interface font-interface
284                                                general-element-interface))
285                 ))
286
287         (OctavateEight . (
288                 (self-alignment-X . 0)
289                 (text . "8")
290                 (visibility-lambda . ,begin-of-line-visible)
291                 (X-offset-callbacks . (,Side_position::centered_on_parent ,Side_position::aligned_on_self))
292                 (Y-offset-callbacks . (,Side_position::aligned_side))
293                 (molecule-callback . ,Text_item::brew_molecule)
294                 (font-shape . italic)
295                 (meta . ,(element-description "OctavateEight" text-interface font-interface ))
296         ))
297         
298         (PaperColumn . (
299                 (axes 0)
300                 (before-grace-spacing-factor . 1.2)
301                 (before-musical-spacing-factor . 0.4)
302                 (meta . ,(element-description "PaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
303         ))
304         (NonMusicalPaperColumn . (
305                 (axes 0)
306                 (before-musical-spacing-factor . 1.0)
307                 (column-space-strength . 2.0)
308                 (meta . ,(element-description "NonMusicalPaperColumn" paper-column-interface axis-group-interface spaceable-element-interface))
309         ))
310         
311         (Rest . (
312                 (after-line-breaking-callback . ,Rest::after_line_breaking)
313                 (molecule-callback . ,Rest::brew_molecule)
314                 (minimum-beam-collision-distance . 1.5)
315                 (meta . ,(element-description  "Rest"
316                         rhythmic-head-interface
317                         rest-interface ))
318         ))
319         (RestCollision . (
320                 (minimum-distance . 0.75)
321                 (meta . ,(element-description "RestCollision" rest-collision-interface ))
322         ))
323
324         (Script . (
325                 (molecule-callback . ,Script::brew_molecule)
326                 (X-offset-callbacks . (,Side_position::centered_on_parent))
327                 (meta . ,(element-description "Script" script-interface side-position-interface font-interface))
328         ))
329         
330         (ScriptColumn . (
331                 (before-line-breaking-callback . ,Script_column::before_line_breaking)
332                 (meta . ,(element-description "ScriptColumn" script-column-interface))
333         ))
334         
335         (Slur . ,default-basic-slur-properties)
336         (SpacingSpanner . (
337                 (spacing-procedure . ,Spacing_spanner::set_springs)
338                 (stem-spacing-correction . 0.5)
339                 (arithmetic-basicspace . 2.0)
340                 (arithmetic-multiplier . ,(* 0.9 1.32))
341                 ;; assume that notes at least this long are present.
342                 (maximum-duration-for-spacing . ,(make-moment 1 8))
343                 (meta . ,(element-description "SpacingSpanner"  spacing-spanner-interface))
344         ))
345         (SpanBar . (
346
347                 (break-align-symbol . Staff_bar)
348                 (barsize-procedure . ,Span_bar::get_bar_size) 
349                 (molecule-callback . ,Bar::brew_molecule)
350                 (visibility-lambda . ,begin-of-line-invisible)
351                 (X-extent-callback . ,Span_bar::width_callback)
352                 (Y-offset-callbacks . (,Span_bar::center_on_spanned_callback))
353                 
354                 (breakable . #t)
355                 (glyph . "|")
356                 (before-line-breaking-callback . ,Span_bar::before_line_breaking)
357                 ;; ugh duplication! 
358                 
359                 ;;
360                 ;; Ross. page 151 lists other values, we opt for a leaner look
361                 ;; 
362                 (kern . 3.0)
363                 (thin-kern . 3.0)
364                 (hair-thickness . 1.6)
365                 (thick-thickness . 6.0)
366                 (meta . ,(element-description "SpanBar" span-bar-interface bar-line-interface ))
367         ))
368
369         (StanzaNumber . (
370                 (breakable . #t)
371                 (molecule-callback . ,Text_item::brew_molecule)         
372                 (break-align-symbol . Clef_item)
373                 (visibility-lambda . ,begin-of-line-visible)
374                 (font-family . roman)
375                 (meta . ,(element-description "StanzaNumber" break-aligned-interface text-interface font-interface))
376         ))
377
378         (StaffSymbol . (
379                 (molecule-callback . ,Staff_symbol::brew_molecule)
380                 (staff-space . 1.0)
381                 (line-count . 5 )
382                 (meta . ,(element-description "StaffSymbol" staff-symbol-interface ))
383         ))
384         (SostenutoPedal . (
385                 (molecule-callback . ,Text_item::brew_molecule)
386                 (X-offset-callbacks . (,Side_position::aligned_on_self))
387                 (Y-offset-callbacks .
388                  (,Side_position::aligned_side
389                   ,Side_position::centered_on_parent))
390                 (no-spacing-rods . #t)
391                 (font-shape . italic)
392                 (self-alignment-X . 0)
393                 (meta . ,(element-description "SostenutoPedal" text-interface  font-interface))
394         ))
395
396         (Stem . (
397                 (before-line-breaking-callback . ,Stem::before_line_breaking)
398                 (molecule-callback . ,Stem::brew_molecule)
399                 (thickness . 0.8)
400                 (beamed-lengths . (0.0 2.5 2.0 1.5))
401                 (beamed-minimum-lengths . (0.0 1.5 1.25 1.0))
402                 
403 ;;  Stems in unnatural (forced) direction should be shortened,
404 ;;  according to [Roush & Gourlay].  Their suggestion to knock off
405 ;;  a whole staffspace seems a bit drastical: we'll do half.
406
407                 (lengths . (3.5 3.5 3.5 4.5 5.0))
408                 (stem-shorten . (0.5))
409                 ; if stem is on middle line, choose this direction.
410                 (default-neutral-direction . 1)
411                 (X-offset-callbacks . (,Stem::off_callback))            
412                 (meta . ,(element-description  "Stem" stem-interface  font-interface))
413         ))
414
415         (StemTremolo . (
416                 (molecule-callback . ,Stem_tremolo::brew_molecule)
417                 (beam-width . 2.0) ; staff-space
418                 (beam-thickness . 0.42) ; staff-space
419                 (beam-space-function . ,default-beam-space-function)
420                 (meta . ,(element-description "StemTremolo" stem-tremolo-interface ))
421         ))
422
423         (SeparationItem . (
424                 (meta . ,(element-description "SeparationItem" separation-item-interface ))
425         ))
426         (SeparatingGroupSpanner . (
427                 (spacing-procedure . ,Separating_group_spanner::set_spacing_rods)
428                 (meta . ,(element-description "SeparatingGroupSpanner" separation-spanner-interface))
429         ))
430
431         (SustainPedal . (
432                 (no-spacing-rods . #t)
433                 (molecule-callback . ,Sustain_pedal::brew_molecule)
434                 (self-alignment-X . 0)
435                 (X-offset-callbacks . (,Side_position::aligned_on_self))
436                 (Y-offset-callbacks .
437                                     (,Side_position::aligned_side
438                                      ,Side_position::centered_on_parent))
439
440                 (meta . ,(element-description "SustainPedal" sustain-pedal-interface side-position-interface font-interface))
441         ))
442
443         (SystemStartDelimiter . (
444                 (molecule-callback . ,System_start_delimiter::brew_molecule)
445                 (after-line-breaking-callback . ,System_start_delimiter::after_line_breaking)
446                 (collapse-height . 1.0)
447                 (thickness . 1.6)
448                 (arch-height . 1.5)
449                 (arch-angle . 50.0)
450                 (arch-thick . 0.25)
451                 (glyph . bar-line)
452                 (arch-width . 1.5)
453                 (bracket-thick . 0.25)
454                 (bracket-width . 2.0)
455                 (font-family . braces)
456                 (font-point-size . 20)
457                 (Y-extent-callback . #f)
458                 (meta . ,(element-description "SystemStartDelimiter" system-start-delimiter font-interface))
459         ))
460
461         (TextScript . (
462                 (molecule-callback . ,Text_item::brew_molecule)
463                 (no-spacing-rods . #t)
464                 (padding . 0.5)
465                 (font-family . roman)
466                 (font-shape . italic)
467                 (font-relative-size . 0)
468                 (meta . ,(element-description "TextScript" text-script-interface text-interface side-position-interface font-interface ))
469         ))
470         (TextSpanner . (
471                 (molecule-callback . ,Text_spanner::brew_molecule)
472                 (font-shape . italic)
473                 (type . "line")
474                 (direction . 1)
475                 (meta . ,(element-description "TextSpanner" text-spanner-interface  font-interface))            
476         ))
477         (Tie . (
478                 (molecule-callback . ,Tie::brew_molecule)
479                 (spacing-procedure . ,Tie::set_spacing_rods)
480                 (staffline-clearance . 0.35)
481                 (details . ((ratio . 0.333) (height-limit . 1.0)))
482                 (thickness . 1.2)
483                 (x-gap . 0.2)
484                 (minimum-length  . 2.5)
485                 (meta . ,(element-description "Tie" tie-interface ))
486         ))
487
488         (TieColumn . (
489                 (after-line-breaking-callback . ,Tie_column::after_line_breaking)
490                 (meta . ,(element-description "TieColumn" tie-column-interface ))
491         ))
492
493         (TimeSignature . (
494                 (molecule-callback . ,Time_signature::brew_molecule)
495                 (break-align-symbol . Time_signature)
496                 (visibility-lambda . ,all-visible)
497                 (breakable . #t)
498                 (font-family . number)
499                 (meta . ,(element-description "TimeSignature" time-signature-interface  font-interface))
500         ))
501
502         (TupletBracket . (
503                 (number-gap . 2.0)   
504                 (delta-y . 0)
505                 (thick . 1.0)
506                 (after-line-breaking-callback . ,Tuplet_spanner::after_line_breaking)
507                 (molecule-callback . ,Tuplet_spanner::brew_molecule)
508                 (font-shape . italic)
509                 (font-relative-size . -1)
510                 (meta .  ,(element-description "TupletBracket" text-interface
511                            tuplet-bracket-interface font-interface))
512         ))
513
514         (UnaChordaPedal . (
515                 (molecule-callback . ,Text_item::brew_molecule)
516                 (font-shape . italic)
517                 (no-spacing-rods . #t)
518                 (self-alignment-X . 0)
519                 (X-offset-callbacks . (,Side_position::aligned_on_self))
520                 (Y-offset-callbacks .
521                  (,Side_position::aligned_side
522                   ,Side_position::centered_on_parent))
523                 (meta . ,(element-description "UnaChordaPedal" text-interface font-interface))
524         ))
525
526         (VoltaBracket . (
527                 (molecule-callback . ,Volta_spanner::brew_molecule)
528         
529                 (direction . 1)
530                 (padding . 1)
531                 (font-style . volta)
532                 (Y-offset-callbacks . (,Side_position::aligned_side))
533                 (thickness . 1.6)  ;  stafflinethickness
534                 (height . 2.0) ; staffspace;
535                 (minimum-space . 25)
536                 (font-family . number)
537                 (font-relative-size . -2)
538                 (meta . ,(element-description "VoltaBracket" volta-bracket-interface side-position-interface font-interface))
539         ))
540
541         (VerticalAlignment . (
542                 (axes 1)
543                 (Y-extent-callback . ,Axis_group_interface::group_extent_callback)
544                 (X-extent-callback . #f)
545                 (stacking-dir . -1)
546                 (meta . ,(element-description "VerticalAlignment" align-interface axis-group-interface))
547         ))
548
549         (VerticalAxisGroup . (
550                 (axes 1)
551                 (meta . ,(element-description "VerticalAxisGroup" axis-group-interface))
552         ))
553 ))
554
555
556
557 ;  (display  (map pair? all-element-descriptions))
558