]> git.donarmstrong.com Git - lilypond.git/blob - scm/interface.scm
release: 1.3.98
[lilypond.git] / scm / interface.scm
1
2 ; should include default value?
3
4 ;;; ::::::: should generate documentation for score elements from here.
5
6 (define (property-description symbol type? description)
7   (list symbol type? description))
8   
9 (define (lily-interface symbol description props)
10   (list symbol
11         description
12         props
13         )
14   )
15
16
17 (define (merge-interfaces ifs)
18    (list
19     (apply append (map car ifs))
20     (apply append (map cadr ifs))
21     (apply append (map caddr ifs))
22   ))
23
24 (define (uniqued-alist  alist acc)
25   (if (null? alist) acc
26       (if (assoc (caar alist) acc)
27           (uniqued-alist (cdr alist) acc)
28           (uniqued-alist (cdr alist) (cons (car alist) acc)
29   ))))
30
31 (define (element-description name . interfaces)
32   (let* ((ifs (cons general-element-interface interfaces))
33          (props (map caddr ifs))
34          (syms (map car ifs))
35         )
36     (list (cons 'separator "\n\n\n")    ;easy printing.
37           (cons 'name name)
38           (cons 'interfaces syms)
39           (cons 'interface-descriptions ifs)
40           ; (cons 'interface-descriptions (cadr merged))
41           ;; description of the element itself?
42           (cons 'properties (apply append props))
43   )))
44
45
46 (define general-element-interface
47   (lily-interface
48    'general-element-interface
49    "All elements support this"
50    (list
51     (property-description 'X-offset-callbacks list? "list of functions, each taking an element and axis argument. The function determine the position relative to this element's parent. The last one in the list is called first")
52     (property-description 'Y-offset-callbacks list? "see <code> X-offset-callbacks</code>")
53     (property-description 'X-extent-callback procedure? "procedure taking an element and axis argument, returning a number-pair. The return value is the extent of the element.")
54     (property-description 'Y-extent-callback procedure? "see <code> X-extent-callback </code>")
55     (property-description 'font-size integer? "")
56     (property-description 'extra-offset number-pair? "pair of reals (a cons) forcing an extra offset   before outputting")
57     (property-description 'interfaces  list? "list of symbols indicating the interfaces supported by this object. Is initialized from the <code>meta</code> field.")
58     (property-description 'dependencies list? "list of score-element pointers that indicate who to compute first for certain global passes")
59     (property-description 'no-spacing-rods boolean? "read from elements: boolean that makes Separation_item ignore this item (MOVE ME TO ITEM)")
60     (property-description 'extra-extent-X number-pair? "enlarge in X dimension by this much, measured in staff space")
61     (property-description 'extra-extent-Y number-pair? "see <code>extra-extent-Y</code>")
62     (property-description 'minimum-extent-X number-pair? "minimum size in X dimension, measured in staff space")
63     (property-description 'minimum-extent-Y number-pair? "see <code>minimum-extent-Y</code>")
64     (property-description 'origin ly-input-location? "location in input file of the definition")
65     (property-description 'transparent boolean? "This is almost the
66 same as setting molecule-callback to #f, but this retains the
67 dimensions of this element, which means that you can erase elements
68 individually. ")
69     (property-description 'molecule-callback procedure? "Function taking graphical element as argument, returning a Scheme encoded Molecule") 
70     ))
71   )
72
73 (define beam-interface
74   (lily-interface
75    'beam-interface
76    "A beam. "
77    (list
78     (property-description 'y-position number? "position of left edge")
79     (property-description 'height number? "dy")
80     (property-description 'flag-width-function procedure? "")
81     (property-description 'damping integer? "amount of beam slope damping should beam slope be damped? 0: no, 1: yes, 100000: horizontal beams ")
82     (property-description 'default-neutral-direction dir? "which
83 direction to choose if we're in the middle of the staff ")
84     (property-description 'thickness number? "weight of beams, in staffspace")
85     (property-description 'space-function procedure? "function of type multiplicity -> real (in staffspace)")
86     (property-description 'beamed-stem-shorten number? "")
87     (property-description 'height-quants number? "")
88     (property-description 'vertical-position-quant-function procedure? "")
89     (property-description 'dir-function procedure? "")
90     (property-description 'damping number? "damping factor.")
91     (property-description 'outer-stem-length-limit number? "catch
92 suspect beam slopes, set slope to zero if outer stem is lengthened
93 more than this (in staffspace)")
94     (property-description 'slope-limit number? "set slope to zero if slope is running away steeper than this.")
95     )
96 ))
97
98
99
100 ;;;;;;;;;;;;;;;;;;;;
101
102 (define clef-interface
103   (lily-interface
104    'clef-interface
105    "A clef sign"
106    (list
107     (property-description 'non-default boolean? "not set because of existence of a bar?")
108     (property-description 'change boolean? "is this a change clef (smaller size)?")
109     (property-description 'glyph string? "a string determining what glyph is typeset")
110     ))
111   )
112
113 (define axis-group-interface
114   (lily-interface
115    'axis-group-interface
116    "a group of coupled elements"
117    (list
118     (property-description 'axes list? "list of axis (number) in which this group works")
119    )))
120
121 (define note-column-interface
122   (lily-interface
123    'note-column-interface
124    "Stem and noteheads combined"
125    (list
126     (property-description 'horizontal-shift integer? "integer that identifies ranking of note-column for horizontal shifting.")
127     (property-description 'force-hshift number? "amount of collision_note_width that overides automatic collision settings.")
128     (property-description 'merge-differently-dotted boolean? "merge black noteheads with differing dot count in collisions.")
129     ))
130   )
131
132 (define stem-interface
133   (lily-interface
134    'stem-interface
135    "A stem"
136    (list
137     (property-description 'thickness number? "thickness, measured in stafflinethickness")
138     (property-description 'beamed-lengths list? "list of stem lengths given beam multiplicity ")
139     (property-description 'beamed-minimum-lengths list? "list of minimum stem lengths given beam multiplicity")
140     (property-description 'stem-centered boolean? "Center stems on note heads. Useful for mensural notation")
141     (property-description 'lengths list? "Stem length given multiplicity of flag")
142     (property-description 'beam ly-element? "pointer to the beam, if applicable")
143     (property-description 'stem-shorten list? "shorten stems in forced directions given flag multiplicity")
144     (property-description 'duration-log integer? "log of the duration, ie. 0=whole note, 1 = half note, etc.")
145     (property-description 'beaming number-pair? "number of beams extending to left and right")
146     (property-description 'default-neutral-direction dir? "Where to go if we're in the middle of the staff")
147     (property-description 'stem-end-position number? "Where does the stem end (the end is opposite to the support-head")
148     (property-description 'support-head ly-element? "the note head at
149 one end of the stem")
150     (property-description 'heads list? "list of note heads")
151     (property-description 'direction dir? "up or down")
152     (property-description 'stem-length number? "length of stem")
153     (property-description 'style string? "") ; symbol!?
154     (property-description 'flag-style string? "") ; symbol!?
155     (property-description 'dir-forced boolean? "set if direction has been forced; read by Beam.")
156     )))
157
158
159 (define slur-interface
160   (lily-interface
161    'slur-interface
162    "A slur"
163    (list
164     (property-description 'de-uglify-parameters list? "list of 3 real constants. They define the valid areas for the middle control points. Used in de_uglyfy. They are a bit empirical.")
165     (property-description 'details list? "alist containing contaning a few magic constants.")
166     (property-description 'attachment pair? "cons of symbols, '(LEFT-TYPE . RIGHT-TYPE), where both types may be alongside-stem, stem, head or loose-end")
167     (property-description 'direction dir? "up or down?")
168    (property-description 'attachment-offset pair? "cons of offsets, '(LEFT-offset . RIGHT-offset).  This offset is added to the attachments to prevent ugly slurs.")
169      (property-description 'beautiful number? "number that dictates when a slur should be de-uglyfied.  It correlates with the enclosed area between noteheads and slurs.  A value of 0.1 yields only undisturbed slurs, a value of 5 will tolerate quite high blown slurs.")
170      (property-description 'y-free number? "minimal vertical gap between slur and noteheads or stems")
171      (property-description 'control-points list? "[internal] control points of bezier curve")
172      (property-description 'extremity-rules  list? "an alist (procedure slur dir) -> attachment to determine the attachment (see above).  If procedure returns #t, attachment is used.  Otherwise, the next procedure is tried.")
173      (property-description 'extremity-offset-alist list? "an alist (attachment stem-dir*dir slur-dir*dir) -> offset.  The offset adds to the centre of the notehead, or stem.")
174      (property-description 'thickness list? "The thickness[stafflinethickness] of slur in the centre.")
175      (property-description 'dashed number? "[FIXME: use dash-period/dash length; see text-spanner] number representing the length of the dashes.")
176
177     )
178    )
179   )
180
181 (define side-position-interface
182   (lily-interface
183    'side-position-interface
184    "Position a victim object (this one) next to other objects (the support)."
185    (list
186    (property-description 'side-support list? "the support, a list of score elements")
187    (property-description 'direction-source ly-element? "in case side-relative-direction is set, which element  to get the direction from ")
188     (property-description 'direction dir? "where to put the victim object (left or right?)")
189     (property-description 'side-relative-direction dir? "if set: get the direction from a different object, and multiply by this.")
190     (property-description 'minimum-space number? "minimum distance that the victim should move (after padding)")
191     (property-description 'padding number? "add this much extra space between victim and support")
192     (property-description 'self-alignment-X number? "real number: -1 = left aligned, 0 = center, 1 right-aligned in X direction. Set to an element pointer, if you want that element to be the center. ")
193     (property-description 'self-alignment-Y number? "like self-alignment-X but for Y axis")
194     
195     )
196   ))
197
198 (define accidentals-interface
199   (lily-interface
200    'accidentals-interface
201    "Accidentals"
202    (list
203     (property-description 'left-padding number? "space left of accs")
204     (property-description 'right-padding number? "space right of accs")     
205     )
206    ))
207
208 (define line-of-score-interface
209   (lily-interface
210    'line-of-score-interface
211    "Super element, parent of all:
212 <p>
213    The columns of a score that form one line.  The toplevel element.
214    Any element has a Line_of_score as both X and Y reference
215    point. The Paper_score contains one element of this type. Control
216    enters the Score_element dependency calculation from this single
217    Line_of_score object."
218    (list
219     (property-description 'between-system-string string? "string
220  to dump between two systems. Useful for forcing pagebreaks")
221     (property-description 'spacing-procedure procedure? "procedure taking
222 graphical element as argument. This is called after before-line-breaking-callback, but before the actual line breaking itself.  Return value is ignored")
223     (property-description 'before-line-breaking-callback procedure?
224                           "Procedure taking graphical element as argument.
225 This procedure is called (using dependency resolution) before line breaking, but after generating discretionary items. Return value is ignored")
226     (property-description 'after-line-breaking-callback procedure?
227                           "Procedure taking graphical element as argument.
228 This procedure is called (using dependency resolution) after line breaking. Return value is ignored")
229     (property-description 'all-elements list? "list of all score elements in this line. Needed for protecting elements from GC.")
230     (property-description 'columns list? "list of all paper columns")
231     )))
232
233 (define note-head-interface
234   (lily-interface
235    'note-head-interface
236    "Note head"
237    (list
238     (property-description 'style symbol? "symbol that sets note head style")
239     )
240    ))
241
242 (define note-name-interface
243   (lily-interface
244    'note-name-interface
245    "Note name"
246    (list
247     (property-description 'style symbol? "symbol that sets note name style")
248     )
249    ))
250
251
252 (define rhythmic-head-interface
253   (lily-interface
254    'rhythmic-head-interface
255    "Note head or rest"
256    (list
257     (property-description 'dot ly-element? "reference to Dots object.")
258     (property-description 'stem ly-element? "pointer to Stem object")
259     (property-description 'duration-log integer? "2-log of the notehead duration")
260     )))
261
262 (define rest-interface
263   (lily-interface
264    'rest-interface
265    "a rest"
266    (list
267     (property-description 'style string? "string specifying glyph style"))))
268
269 (define tuplet-bracket-interface
270   (lily-interface
271    'tuplet-bracket-interface
272    "A bracket with a number in the middle, used for tuplets." 
273    (list
274     (property-description 'beams list? "list of beam ptrs.")
275     (property-description 'columns list? " list of note-columns.")
276     (property-description 'number-gap number? "")
277     (property-description 'delta-y number? "amount of ascension")
278     (property-description 'thick number? "thickness, in stafflinethickness")
279     )
280 ))
281
282
283 (define align-interface
284   (lily-interface
285    'align-interface
286    " Order elements top to bottom/left to right/right to left etc."
287    (list
288     (property-description 'stacking-dir  dir? "stack contents of elements in which direction ?")
289     (property-description 'align-dir  dir? "Which side to align? -1: left side, 0: centered around center-element if not nil, or around center of width), 1: right side")
290     (property-description 'threshold  number-pair? "(cons MIN MAX), where MIN and MAX are dimensions in staffspace")
291     (property-description 'alignment-done  boolean? "boolean to administrate whether we've done the alignment already (to ensure that the process is done only once)")
292     (property-description 'center-element ly-element? "element which will be at the
293 center of the group after aligning (when using
294 Align_interface::center_on_element). The center element should have
295 this object as a reference point.")
296     (property-description 'elements  list? "to be aligned elements ")
297     (property-description 'axes  list? "list of axis numbers. Should contain only one number.")
298     )))    
299
300 (define aligned-interface
301   (lily-interface
302    'aligned-interface
303    "read by align-interface"
304    (list
305     (property-description 'minimum-space number-pair? "(cons LEFT RIGHT)")
306     (property-description 'extra-space number-pair? "(cons LEFT RIGHT)")
307     )))
308
309 (define break-aligned-interface
310   (lily-interface
311    'break-aligned-interface
312    "Items that are aligned in prefatory matter"
313    (list
314     (property-description 'break-align-symbol symbol? "the index in the spacing table (symbol) of the to be aligned item.")
315     (property-description 'visibility-lambda procedure? "a function that takes the break direction and returns a  cons of booleans containing (TRANSPARENT . EMPTY)")
316     (property-description 'breakable boolean? "boolean indicating if this is a breakable item (clef, barline, key sig, etc.)")
317     )))
318
319 (define chord-name-interface
320   (lily-interface
321    'chord-name-interface
322    "generate a chord name"
323    (list
324     (property-description 'pitches list? "list of musical-pitch")
325     (property-description 'inversion list? " musical-pitch, optional")
326     (property-description 'bass list? " musical-pitch, optional")
327    )))
328
329 (define time-signature-interface
330   (lily-interface
331    'time-signature-interface
332    "A time signature, in different styles"
333    (list
334     (property-description 'fraction number-pair? "")
335     (property-description 'style string? "")
336     )))
337
338 (define bar-line-interface
339   (lily-interface
340    'bar-line-interface
341    "Bar line"
342    (list
343     (property-description 'barsize-procedure procedure? "how to compute the size of a bar line")
344     (property-description 'kern number? "space after a thick line")
345     (property-description 'thin-kern number? "space after a hair-line")
346     (property-description 'hair-thickness number? "thickness, measured in stafflinethickness")
347     (property-description 'thick-thickness number? "thickness, measured in stafflinethickness")
348     (property-description 'glyph string? "what kind barline? A concatenation of |, : and .")
349     (property-description 'bar-size number? "")
350     (property-description 'break-glyph-function procedure? "function taking glyph and break-direction, returning the glyph at a line break")
351    )))
352
353
354
355
356 (define hairpin-interface
357   (lily-interface
358    'hairpin-interface
359    "hairpin crescendo"
360    (list
361     (property-description 'grow-direction dir? "crescendo or decrescendo?")
362     (property-description 'thickness number? "thickness, measured in stafflinethickness")
363     (property-description 'height number? "height, measured in staffspace in ")
364     )))
365
366 (define arpeggio-interface
367   (lily-interface
368    'arpeggio-interface
369    "arpeggio"
370    (list
371     (property-description 'stems list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
372     )
373    )
374   )
375
376 (define note-collision-interface
377   (lily-interface
378    'note-collision-interface
379    "note collision"
380    (list
381     (property-description 'note-width 'number? "unit for horizontal translation, measured in staff-space.")
382     )   )  )
383 (define dot-interface
384   (lily-interface
385    'dots-interface
386    "The dots to go with a notehead/rest.  A separate interface, since they
387   are a party in collision resolution."
388    (list
389     (property-description 'dot-count integer? "number of dots")
390     )))
391
392 (define text-interface
393   (lily-interface
394    'text-interface
395    "A scheme markup text"
396    (list
397     (property-description 'text (lambda (x) (or (string? x) (list? x))) "the scheme markup text.  Either a string, or a list of which the CAR is a markup '(MARKUP text text ...).  MARKUP is either a CONS: an element property '(key . value) or a symbol: an abbreviation for a list of element properties.  These abbreviations are currently defined: rows lines roman music bold italic named super sub text, as well as all font-style's.")
398     (property-description 'font-style string? "font definition for a special purpose, one of: finger volta timesig mark script large Large dynamic")
399     (property-description 'font-series string? "partial font definition: medium, bold")
400     (property-description 'font-shape string?  "partial font definition: upright or italic")
401     (property-description 'font-family string? "partial font definition: music roman braces dynamic math ...")
402     (property-description 'font-name string? "partial font definition: base name of font file FIXME: should override other partials")
403     (property-description 'font-point string? "partial font definition: exact font size in points FIXME: should override font-size")
404     (property-description 'font-size string? "partial font definition: the relative size, 0 is style-sheet's normal size, -1 is smaller, +1 is bigger")
405     (property-description 'align number? "the alignment of the text, 0 is horizontal, 1 is vertical")
406     (property-description 'lookup symbol? "lookup method: 'value for plain text, 'name for character-name")
407     (property-description 'raise number? "height for text to be raised (a negative value lowers the text")
408     (property-description 'kern number? "amount of extra white space to add before text.  This is `relative'(?) to the current alignment.")
409     (property-description 'magnify number? "the magnification factor.  FIXME: doesn't work for feta fonts")
410     )))
411
412
413 (define dot-column-interface
414   (lily-interface
415    'dot-column-interface
416    "Interface that groups dots so they form a column"
417    (list
418     )))
419
420 (define dynamic-interface
421   (lily-interface
422    'dynamic-interface
423    "Any kind of loudness sign"
424    '()
425     ))
426
427
428 (define finger-interface
429   (lily-interface
430    'finger-interface
431    "A fingering instruction"
432    '()
433     ))
434
435 (define separation-spanner-interface
436   (lily-interface
437    'separation-spanner-interface
438    "Spanner that containing <code>separation-item-interface</code> elements to calculate rods"
439    '()
440   ))
441 (define text-script-interface
442   (lily-interface
443    'text-script-interface
444    "Any text script"
445    '()
446     ))
447
448 (define grace-alignment-interface
449   (lily-interface
450    'grace-alignment-interface
451    "put grace notes in line"
452    (list
453     (property-description 'horizontal-space number? "amount of space to add after a note (in staff-space)")
454     )
455    ))
456
457 (define hara-kiri-group-interface
458   (lily-interface
459    'hara-kiri-group-interface
460    "  As Vertical_group_spanner, but keep track of interesting items.  If
461   we don't contain any interesting items after linebreaking, then
462   gracefully commit suicide.  Objective: don't disgrace Lily by
463   typesetting empty lines in orchestral scores."
464    (list
465     (property-description 'items-worth-living list? "list of interesting items. If empty in a particular system, clear that system.")
466
467
468     )))
469
470 (define lyric-hyphen-interface
471   (lily-interface
472    'lyric-hyphen-interface
473    "A centred hyphen is a simple line between lyrics used to divide
474 syllables.   The length of the hyphen line should stretch based on the
475   size of the gap between syllables."
476    (list
477     
478     (property-description 'thickness number? "thickness of line (in stafflinethickness)")
479     (property-description 'height number? "vertical offset  (in staffspace)")
480
481     (property-description 'minimum-length number? "try to make the hyphens at least this long. Also works as a scaling parameter for the length")
482     (property-description 'word-space number? "elongate left by this much (FIXME: cumbersome semantics)")
483     )))
484
485 (define key-signature-interface
486   (lily-interface
487    'key-signature-interface
488    "A group of  accidentals."
489    (list
490     (property-description 'c0-position  integer? "integer indicating the position of central C")
491     (property-description 'old-accidentals  list? "list of (pitch, accidental) pairs")
492     (property-description 'new-accidentals  list? "list of (pitch, accidental) pairs")
493     )))
494
495 (define lyric-extender-interface
496   (lily-interface
497    'lyric-extender-interface
498    "The extender is a simple line at the baseline of the lyric
499   that helps show the length of a melissima (tied/slurred note)."
500    (list
501     (property-description 'word-space  number? "")
502     (property-description 'height  number? "in stafflinethickness")
503     (property-description 'right-trim-amount  number? "")
504     )))
505
506
507 (define lyric-syllable-interface
508   (lily-interface
509    'lyric-syllable-interface
510    "a single piece of lyrics"
511    (list
512     (property-description 'word-space  number? "")
513     )))
514
515
516 (define mark-interface
517   (lily-interface
518    'mark-interface
519    "a rehearsal mark"
520    (list
521     )))
522
523 (define multi-measure-rest-interface
524   (lily-interface
525    'multi-measure-rest-interface
526    "A rest that spans a whole number of measures."
527    (list
528     
529     (property-description 'columns  list? "list of paper-columns")
530     (property-description 'expand-limit  integer? "maximum number of measures expanded in church rests")
531     (property-description 'minimum-width number? "minimum-width of rest symbol, in staffspace")
532     (property-description 'padding  number? "padding between number and rest. Measured in staffspace.")
533     )))
534
535 (define paper-column-interface
536   (lily-interface
537    'paper-column-interface
538    ""
539    (list
540     (property-description 'when moment? "when does this column happen?")
541     (property-description 'bounded-by-me list? "list of spanners that have this
542 column as start/begin point. Only columns that have elements or act as bounds are spaced.")
543     (property-description 'dir-list  list? "list of stem directions")
544     (property-description 'shortest-playing-duration  moment? "duration of the shortest playing in that column.")
545     (property-description 'shortest-starter-duration  moment? "duration of the shortest notes that starts exactly in this column.")
546     (property-description 'contains-grace  boolean? "Used to widen entries for grace notes.")
547     (property-description 'extra-space  number-pair? "pair of distances")
548     (property-description 'stretch-distance number-pair? "pair of distances")
549     )))
550
551 (define spaceable-element-interface
552   (lily-interface
553    'spaceable-element-interface
554    "An element (generally a Paper_column) that takes part in the
555 spacing problem. "
556    (list
557      (property-description 'minimum-distances list? "list of rods (ie. (OBJ . DIST) pairs)")
558      (property-description 'ideal-distances  list? "(OBJ . (DIST . STRENGTH)) pairs")
559      (property-description 'dir-list list? "list of stem directions, needed for optical spacing correction.")
560      )))
561
562 (define rest-collision-interface
563   (lily-interface
564    'rest-collision-interface
565    "Move around ordinary rests (not multi-measure-rests) to avoid
566 conflicts."
567    (list
568     (property-description 'maximum-rest-count integer? "kill off rests so we don't more than this number left.")
569     (property-description 'minimum-distance number? "minimum distance between notes and rests.")
570     (property-description 'elements list? "list of elements (NoteColumn,
571 generally) participating in the collision. The
572 <code>rest-collision</code> property in <code>elements</code> is set
573 to a pointer to the collision")
574     )))
575
576 (define script-interface
577   (lily-interface
578    'script-interface
579    ""
580    (list
581     (property-description 'script-priority number? "A sorting key that determines in what order a script is within a stack of scripts")
582     )))
583
584 (define script-column-interface
585   (lily-interface
586    'script-column-interface
587    "An interface that sorts scripts according to their <code>script-priority</code>"
588    (list )))
589
590
591 (define spacing-spanner-interface
592   (lily-interface
593    'spacing-spanner-interface
594    ""
595    (list
596     (property-description 'maximum-duration-for-spacing moment? "space as if a duration of this type is available in this measure.")
597     )))
598
599 (define staff-symbol-interface
600   (lily-interface
601    'staff-symbol-interface
602    "This spanner draws the lines of a staff.  The middle line is
603 position 0."
604    (list
605     (property-description 'staff-space number? "Amount of line leading relative to global staffspace")
606     (property-description 'line-count integer? "Number of staff lines")
607     )))
608
609 (define stem-tremolo-interface
610   (lily-interface
611    'stem-tremolo-interface
612    ""
613    (list
614     (property-description 'stem ly-element? "pointer to the stem object.")
615     (property-description 'beam-width number? "width of the tremolo sign")
616     (property-description 'beam-thickness number? "thickness, measured in staffspace")
617     (property-description 'beam-space-function procedure? "function returning space given multiplicity")
618     )))
619
620 (define separation-item-interface
621   (lily-interface
622    'separation-item-interface
623    "Item that computes widths to generate spacing rods.
624 <p>
625 Calc dimensions for the Separating_group_spanner; this has to be
626    an item to get dependencies correct.  It can't be an element_group
627    since these usually are in a different X_group
628 "
629    (list
630     (property-description 'elements list? " -- list of items.")
631      )))
632
633 (define sustain-pedal-interface
634   (lily-interface
635    'sustain-pedal-interface
636    ""
637    (list
638     )))
639 (define system-start-delimiter
640   (lily-interface
641    'system-start-delimiter
642    ""
643    (list
644     (property-description 'collapse-height number? "")
645     (property-description 'thickness number? "thickness, measured in stafflinethickness")
646
647     ; Should collapse into (bracket . ((height . ) ... ))
648     ;
649     (property-description 'arch-height number? "")
650     (property-description 'arch-angle number? "")
651     (property-description 'arch-thick number? "")
652     (property-description 'arch-width number? "")
653     (property-description 'bracket-thick number? "")
654     (property-description 'bracket-width number? "")
655     (property-description 'glyph symbol? "bar-line, bracket or brace")
656     )))
657
658 (define text-spanner-interface
659   (lily-interface
660    'text-spanner-interface
661    "generic text spanner"
662    (list
663     (property-description 'dash-period  number? "the length of one dash + white space")
664     (property-description 'dash-length number? "the length of a dash")
665     (property-description 'line-thickness number? "the thickness[stafflinethickness] of the line")
666     (property-description 'edge-height pair? "a cons that specifies the heights of the vertical egdes '(LEFT-height . RIGHT-height)")
667     (property-description 'edge-text pair? "a cons that specifies the texts to be set at the edges '(LEFT-text . RIGHT-text)")
668     (property-description 'type string? "one of: line, dashed-line or dotted-line") ; SYMBOL!!?    
669     )
670 ))
671
672 (define text-script-interface
673   (lily-interface
674    'text-script-interface
675    ""
676    (list
677     
678     )))
679
680
681 (define tie-interface
682   (lily-interface
683    'tie-interface
684    "A tie connecting two noteheads."
685    (list
686     (property-description 'staffline-clearance number? "don't get closer than this to stafflines.")
687     (property-description 'control-points list? "List of 4 offsets (number-pairs) controlling the tie shape")
688     (property-description 'heads pair? "pair of element pointers, pointing to the two heads of the  tie. ")
689     (property-description 'details list? "alist of parameters for the curve shape")
690     (property-description 'thickness number? "thickness, measured in stafflinethickness")
691     (property-description 'x-gap number? "horizontal gap between notehead and tie")
692     (property-description 'direction dir? "up or down?")    
693     (property-description 'minimum-length number? "minimum length in staffspace")
694     )))
695
696
697
698 (define tie-column-interface
699   (lily-interface
700    'tie-column-interface
701    "that sets tie directions in a tied chord"
702    (list
703     )))
704
705 (define volta-bracket-interface
706   (lily-interface
707    'volta-bracket-interface
708    "Volta bracket with number"
709    (list
710     (property-description 'bars  list? "list of barline ptrs.")
711     (property-description 'thickness  number? "thickness, measured in stafflinethickness")
712     (property-description 'height  number? "in staffspace ")
713     )))
714
715 (define span-bar-interface
716   (lily-interface
717    'span-bar-interface
718    ""
719    (list
720     )))
721