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-relative-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 =
 193 left aligned, 0 = center, 1 right-aligned in X direction. <p> Set to
 194 an element pointer, if you want that element to be the center.  In
 195 this case, the center element should have this object as a reference
 196 point.
 197 ")
 198     (property-description 'self-alignment-Y number? "like self-alignment-X but for Y axis")
 199
 200     )
 201   ))
 202
 203 (define accidentals-interface
 204   (lily-interface
 205    'accidentals-interface
 206    "Accidentals"
 207    (list
 208     (property-description 'left-padding number? "space left of accs")
 209     (property-description 'right-padding number? "space right of accs")
 210     )
 211    ))
 212
 213 (define line-of-score-interface
 214   (lily-interface
 215    'line-of-score-interface
 216    "Super element, parent of all:
 217 <p>
 218    The columns of a score that form one line.  The toplevel element.
 219    Any element has a Line_of_score as both X and Y reference
 220    point. The Paper_score contains one element of this type. Control
 221    enters the Score_element dependency calculation from this single
 222    Line_of_score object."
 223    (list
 224     (property-description 'between-system-string string? "string
 225  to dump between two systems. Useful for forcing pagebreaks")
 226     (property-description 'spacing-procedure procedure? "procedure taking
 227 graphical element as argument. This is called after before-line-breaking-callback, but before the actual line breaking itself.  Return value is ignored")
 228     (property-description 'before-line-breaking-callback procedure?
 229                           "Procedure taking graphical element as argument.
 230 This procedure is called (using dependency resolution) before line breaking, but after generating discretionary items. Return value is ignored")
 231     (property-description 'after-line-breaking-callback procedure?
 232                           "Procedure taking graphical element as argument.
 233 This procedure is called (using dependency resolution) after line breaking. Return value is ignored")
 234     (property-description 'all-elements list? "list of all score elements in this line. Needed for protecting elements from GC.")
 235     (property-description 'columns list? "list of all paper columns")
 236     )))
 237
 238 (define note-head-interface
 239   (lily-interface
 240    'note-head-interface
 241    "Note head"
 242    (list
 243     (property-description 'style symbol? "symbol that sets note head style")
 244     )
 245    ))
 246
 247 (define note-name-interface
 248   (lily-interface
 249    'note-name-interface
 250    "Note name"
 251    (list
 252     (property-description 'style symbol? "symbol that sets note name style")
 253     )
 254    ))
 255
 256
 257 (define rhythmic-head-interface
 258   (lily-interface
 259    'rhythmic-head-interface
 260    "Note head or rest"
 261    (list
 262     (property-description 'dot ly-element? "reference to Dots object.")
 263     (property-description 'stem ly-element? "pointer to Stem object")
 264     (property-description 'duration-log integer? "2-log of the notehead duration")
 265     )))
 266
 267 (define rest-interface
 268   (lily-interface
 269    'rest-interface
 270    "a rest"
 271    (list
 272     (property-description 'style string? "string specifying glyph style"))))
 273
 274 (define tuplet-bracket-interface
 275   (lily-interface
 276    'tuplet-bracket-interface
 277    "A bracket with a number in the middle, used for tuplets."
 278    (list
 279     (property-description 'beams list? "list of beam ptrs.")
 280     (property-description 'columns list? " list of note-columns.")
 281     (property-description 'number-gap number? "")
 282     (property-description 'delta-y number? "amount of ascension")
 283     (property-description 'thick number? "thickness, in stafflinethickness")
 284     )
 285 ))
 286
 287
 288 (define align-interface
 289   (lily-interface
 290    'align-interface
 291    " Order elements top to bottom/left to right/right to left etc."
 292    (list
 293     (property-description 'stacking-dir  dir? "stack contents of elements in which direction ?")
 294     (property-description 'align-dir  dir? "Which side to align? -1: left side, 0: around center of width, 1: right side")
 295     (property-description 'threshold  number-pair? "(cons MIN MAX), where MIN and MAX are dimensions in staffspace")
 296     (property-description 'alignment-done  boolean? "boolean to administrate whether we've done the alignment already (to ensure that the process is done only once)")
 297     (property-description 'center-element ly-element? "element which will be at the
 298 center of the group after aligning (when using
 299 Align_interface::center_on_element). ")
 300     (property-description 'elements  list? "to be aligned elements ")
 301     (property-description 'axes  list? "list of axis numbers. Should contain only one number.")
 302     )))
 303
 304 (define aligned-interface
 305   (lily-interface
 306    'aligned-interface
 307    "read by align-interface"
 308    (list
 309     (property-description 'minimum-space number-pair? "(cons LEFT RIGHT)")
 310     (property-description 'extra-space number-pair? "(cons LEFT RIGHT)")
 311     )))
 312
 313 (define break-aligned-interface
 314   (lily-interface
 315    'break-aligned-interface
 316    "Items that are aligned in prefatory matter"
 317    (list
 318     (property-description 'break-align-symbol symbol? "the index in the spacing table (symbol) of the to be aligned item.")
 319     (property-description 'visibility-lambda procedure? "a function that takes the break direction and returns a  cons of booleans containing (TRANSPARENT . EMPTY)")
 320     (property-description 'breakable boolean? "boolean indicating if this is a breakable item (clef, barline, key sig, etc.)")
 321     )))
 322
 323 (define chord-name-interface
 324   (lily-interface
 325    'chord-name-interface
 326    "generate a chord name"
 327    (list
 328     (property-description 'pitches list? "list of musical-pitch")
 329     (property-description 'inversion list? " musical-pitch, optional")
 330     (property-description 'bass list? " musical-pitch, optional")
 331    )))
 332
 333 (define time-signature-interface
 334   (lily-interface
 335    'time-signature-interface
 336    "A time signature, in different styles"
 337    (list
 338     (property-description 'fraction number-pair? "")
 339     (property-description 'style string? "")
 340     )))
 341
 342 (define bar-line-interface
 343   (lily-interface
 344    'bar-line-interface
 345    "Bar line"
 346    (list
 347     (property-description 'barsize-procedure procedure? "how to compute the size of a bar line")
 348     (property-description 'kern number? "space after a thick line")
 349     (property-description 'thin-kern number? "space after a hair-line")
 350     (property-description 'hair-thickness number? "thickness, measured in stafflinethickness")
 351     (property-description 'thick-thickness number? "thickness, measured in stafflinethickness")
 352     (property-description 'glyph string? "what kind barline? A concatenation of |, : and .")
 353     (property-description 'bar-size number? "")
 354     (property-description 'break-glyph-function procedure? "function taking glyph and break-direction, returning the glyph at a line break")
 355    )))
 356
 357
 358
 359
 360 (define hairpin-interface
 361   (lily-interface
 362    'hairpin-interface
 363    "hairpin crescendo"
 364    (list
 365     (property-description 'grow-direction dir? "crescendo or decrescendo?")
 366     (property-description 'thickness number? "thickness, measured in stafflinethickness")
 367     (property-description 'height number? "height, measured in staffspace in ")
 368     )))
 369
 370 (define arpeggio-interface
 371   (lily-interface
 372    'arpeggio-interface
 373    "arpeggio"
 374    (list
 375     (property-description 'stems list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
 376     )
 377    )
 378   )
 379
 380 (define note-collision-interface
 381   (lily-interface
 382    'note-collision-interface
 383    "note collision"
 384    (list
 385     (property-description 'note-width 'number? "unit for horizontal translation, measured in staff-space.")
 386     )   )  )
 387 (define dot-interface
 388   (lily-interface
 389    'dots-interface
 390    "The dots to go with a notehead/rest.  A separate interface, since they
 391   are a party in collision resolution."
 392    (list
 393     (property-description 'dot-count integer? "number of dots")
 394     )))
 395
 396 (define text-interface
 397   (lily-interface
 398    'text-interface
 399    "A scheme markup text"
 400    (list
 401     (property-description 'text (lambda (x) (or (string? x) (list? x))) "
 402 Scheme markup text.  It is defined as follows:
 403 <p>
 404
 405 TEXT : STRING | (MARKUP SENTENCE)<br>
 406 MARKUP: PROPERTY | ABBREV<br>
 407 SENTENCE: TEXT | SENTENCE TEXT<br>
 408 PROPERTY: (key . value)<br>
 409 ABBREV: rows lines roman music bold italic named super sub text, or any font-style
 410 <p>
 411
 412 So, TEXT is either a string, or a list of which the CAR is a MARKUP.
 413 MARKUP is either a CONS: an element property '(key . value) or a symbol:
 414 a predefined abbreviation for a list of element properties.
 415 <p>
 416
 417 The following abbreviations are currently defined:
 418 <dl>
 419 <dt>rows<dd> horizontal mode: set all text on one line (default)
 420 <dt>lines<dd> vertical mode: set every text on new line
 421 <dt>roman<dd> select roman font
 422 <dt>music<dd> select feta font
 423 <dt>bold<dd> select bold series
 424 <dt>italic<dd> select italic shape
 425 <dt>named<dd> lookup by character name
 426 <dt>text<dd> plain text lookup (by character value)
 427 <dt>super<dd> superscript
 428 <dt>sub<dd> subscript
 429 <dt> any font-style<dd> finger volta timesig mmrest mark script large Large dynamic
 430 </dl>
 431 " )
 432     (property-description 'font-style symbol? "font definition for a special purpose, one of: finger volta timesig mark script large Large dynamic")
 433     (property-description 'font-series symbol? "partial font definition: medium, bold")
 434     (property-description 'font-shape symbol?  "partial font definition: upright or italic")
 435     (property-description 'font-family symbol? "partial font definition: music roman braces dynamic math ...")
 436     (property-description 'font-name symbol? "partial font definition: base name of font file FIXME: should override other partials")
 437     (property-description 'font-point-size number? "partial font definition: exact font size in points FIXME: should override font-relative-size")
 438     (property-description 'font-relative-size number? "partial font definition: the relative size, 0 is style-sheet's normal size, -1 is smaller, +1 is bigger")
 439     (property-description 'align number? "the alignment of the text, 0 is horizontal, 1 is vertical")
 440     (property-description 'lookup symbol? "lookup method: 'value for plain text, 'name for character-name")
 441     (property-description 'raise number? "height for text to be raised (a negative value lowers the text")
 442     (property-description 'kern number? "amount of extra white space to add before text.  This is `relative'(?) to the current alignment.")
 443     (property-description 'magnify number? "the magnification factor.  FIXME: doesn't work for feta fonts")
 444     )))
 445
 446
 447 (define dot-column-interface
 448   (lily-interface
 449    'dot-column-interface
 450    "Interface that groups dots so they form a column"
 451    (list
 452     )))
 453
 454 (define dynamic-interface
 455   (lily-interface
 456    'dynamic-interface
 457    "Any kind of loudness sign"
 458    '()
 459     ))
 460
 461
 462 (define finger-interface
 463   (lily-interface
 464    'finger-interface
 465    "A fingering instruction"
 466    '()
 467     ))
 468
 469 (define separation-spanner-interface
 470   (lily-interface
 471    'separation-spanner-interface
 472    "Spanner that containing <code>separation-item-interface</code> elements to calculate rods"
 473    '()
 474   ))
 475 (define text-script-interface
 476   (lily-interface
 477    'text-script-interface
 478    "Any text script"
 479    '()
 480     ))
 481
 482 (define grace-alignment-interface
 483   (lily-interface
 484    'grace-alignment-interface
 485    "put grace notes in line"
 486    (list
 487     (property-description 'horizontal-space number? "amount of space to add after a note (in staff-space)")
 488     )
 489    ))
 490
 491 (define hara-kiri-group-interface
 492   (lily-interface
 493    'hara-kiri-group-interface
 494    "  As Vertical_group_spanner, but keep track of interesting items.  If
 495   we don't contain any interesting items after linebreaking, then
 496   gracefully commit suicide.  Objective: don't disgrace Lily by
 497   typesetting empty lines in orchestral scores."
 498    (list
 499     (property-description 'items-worth-living list? "list of interesting items. If empty in a particular system, clear that system.")
 500
 501
 502     )))
 503
 504 (define lyric-hyphen-interface
 505   (lily-interface
 506    'lyric-hyphen-interface
 507    "A centred hyphen is a simple line between lyrics used to divide
 508 syllables.   The length of the hyphen line should stretch based on the
 509   size of the gap between syllables."
 510    (list
 511
 512     (property-description 'thickness number? "thickness of line (in stafflinethickness)")
 513     (property-description 'height number? "vertical offset  (in staffspace)")
 514
 515     (property-description 'minimum-length number? "try to make the hyphens at least this long. Also works as a scaling parameter for the length")
 516     (property-description 'word-space number? "elongate left by this much (FIXME: cumbersome semantics)")
 517     )))
 518
 519 (define key-signature-interface
 520   (lily-interface
 521    'key-signature-interface
 522    "A group of  accidentals."
 523    (list
 524     (property-description 'c0-position  integer? "integer indicating the position of central C")
 525     (property-description 'old-accidentals  list? "list of (pitch, accidental) pairs")
 526     (property-description 'new-accidentals  list? "list of (pitch, accidental) pairs")
 527     )))
 528
 529 (define lyric-extender-interface
 530   (lily-interface
 531    'lyric-extender-interface
 532    "The extender is a simple line at the baseline of the lyric
 533   that helps show the length of a melissima (tied/slurred note)."
 534    (list
 535     (property-description 'word-space  number? "")
 536     (property-description 'height  number? "in stafflinethickness")
 537     (property-description 'right-trim-amount  number? "")
 538     )))
 539
 540
 541 (define lyric-syllable-interface
 542   (lily-interface
 543    'lyric-syllable-interface
 544    "a single piece of lyrics"
 545    (list
 546     (property-description 'word-space  number? "")
 547     )))
 548
 549
 550 (define mark-interface
 551   (lily-interface
 552    'mark-interface
 553    "a rehearsal mark"
 554    (list
 555     )))
 556
 557 (define multi-measure-rest-interface
 558   (lily-interface
 559    'multi-measure-rest-interface
 560    "A rest that spans a whole number of measures."
 561    (list
 562
 563     (property-description 'columns  list? "list of paper-columns")
 564     (property-description 'expand-limit  integer? "maximum number of measures expanded in church rests")
 565     (property-description 'minimum-width number? "minimum-width of rest symbol, in staffspace")
 566     (property-description 'padding  number? "padding between number and rest. Measured in staffspace.")
 567     )))
 568
 569 (define paper-column-interface
 570   (lily-interface
 571    'paper-column-interface
 572    ""
 573    (list
 574     (property-description 'when moment? "when does this column happen?")
 575     (property-description 'bounded-by-me list? "list of spanners that have this
 576 column as start/begin point. Only columns that have elements or act as bounds are spaced.")
 577     (property-description 'dir-list  list? "list of stem directions")
 578     (property-description 'shortest-playing-duration  moment? "duration of the shortest playing in that column.")
 579     (property-description 'shortest-starter-duration  moment? "duration of the shortest notes that starts exactly in this column.")
 580     (property-description 'contains-grace  boolean? "Used to widen entries for grace notes.")
 581     (property-description 'extra-space  number-pair? "pair of distances")
 582     (property-description 'stretch-distance number-pair? "pair of distances")
 583     )))
 584
 585 (define spaceable-element-interface
 586   (lily-interface
 587    'spaceable-element-interface
 588    "An element (generally a Paper_column) that takes part in the
 589 spacing problem. "
 590    (list
 591      (property-description 'minimum-distances list? "list of rods (ie. (OBJ . DIST) pairs)")
 592      (property-description 'ideal-distances  list? "(OBJ . (DIST . STRENGTH)) pairs")
 593      (property-description 'dir-list list? "list of stem directions, needed for optical spacing correction.")
 594      )))
 595
 596 (define rest-collision-interface
 597   (lily-interface
 598    'rest-collision-interface
 599    "Move around ordinary rests (not multi-measure-rests) to avoid
 600 conflicts."
 601    (list
 602     (property-description 'maximum-rest-count integer? "kill off rests so we don't more than this number left.")
 603     (property-description 'minimum-distance number? "minimum distance between notes and rests.")
 604     (property-description 'elements list? "list of elements (NoteColumn,
 605 generally) participating in the collision. The
 606 <code>rest-collision</code> property in <code>elements</code> is set
 607 to a pointer to the collision")
 608     )))
 609
 610 (define script-interface
 611   (lily-interface
 612    'script-interface
 613    ""
 614    (list
 615     (property-description 'script-priority number? "A sorting key that determines in what order a script is within a stack of scripts")
 616     )))
 617
 618 (define script-column-interface
 619   (lily-interface
 620    'script-column-interface
 621    "An interface that sorts scripts according to their <code>script-priority</code>"
 622    (list )))
 623
 624
 625 (define spacing-spanner-interface
 626   (lily-interface
 627    'spacing-spanner-interface
 628    ""
 629    (list
 630     (property-description 'maximum-duration-for-spacing moment? "space as if a duration of this type is available in this measure.")
 631     )))
 632
 633 (define staff-symbol-interface
 634   (lily-interface
 635    'staff-symbol-interface
 636    "This spanner draws the lines of a staff.  The middle line is
 637 position 0."
 638    (list
 639     (property-description 'staff-space number? "Amount of line leading relative to global staffspace")
 640     (property-description 'line-count integer? "Number of staff lines")
 641     )))
 642
 643 (define stem-tremolo-interface
 644   (lily-interface
 645    'stem-tremolo-interface
 646    ""
 647    (list
 648     (property-description 'stem ly-element? "pointer to the stem object.")
 649     (property-description 'beam-width number? "width of the tremolo sign")
 650     (property-description 'beam-thickness number? "thickness, measured in staffspace")
 651     (property-description 'beam-space-function procedure? "function returning space given multiplicity")
 652     )))
 653
 654 (define separation-item-interface
 655   (lily-interface
 656    'separation-item-interface
 657    "Item that computes widths to generate spacing rods.
 658 <p>
 659 Calc dimensions for the Separating_group_spanner; this has to be
 660    an item to get dependencies correct.  It can't be an element_group
 661    since these usually are in a different X_group
 662 "
 663    (list
 664     (property-description 'elements list? " -- list of items.")
 665      )))
 666
 667 (define sustain-pedal-interface
 668   (lily-interface
 669    'sustain-pedal-interface
 670    ""
 671    (list
 672     )))
 673 (define system-start-delimiter
 674   (lily-interface
 675    'system-start-delimiter
 676    ""
 677    (list
 678     (property-description 'collapse-height number? "")
 679     (property-description 'thickness number? "thickness, measured in stafflinethickness")
 680
 681     ; Should collapse into (bracket . ((height . ) ... ))
 682     ;
 683     (property-description 'arch-height number? "")
 684     (property-description 'arch-angle number? "")
 685     (property-description 'arch-thick number? "")
 686     (property-description 'arch-width number? "")
 687     (property-description 'bracket-thick number? "")
 688     (property-description 'bracket-width number? "")
 689     (property-description 'glyph symbol? "bar-line, bracket or brace")
 690     )))
 691
 692 (define text-spanner-interface
 693   (lily-interface
 694    'text-spanner-interface
 695    "generic text spanner"
 696    (list
 697     (property-description 'dash-period  number? "the length of one dash + white space")
 698     (property-description 'dash-length number? "the length of a dash")
 699     (property-description 'line-thickness number? "the thickness[stafflinethickness] of the line")
 700     (property-description 'edge-height pair? "a cons that specifies the heights of the vertical egdes '(LEFT-height . RIGHT-height)")
 701     (property-description 'edge-text pair? "a cons that specifies the texts to be set at the edges '(LEFT-text . RIGHT-text)")
 702     (property-description 'type string? "one of: line, dashed-line or dotted-line") ; SYMBOL!!?
 703     )
 704 ))
 705
 706 (define text-script-interface
 707   (lily-interface
 708    'text-script-interface
 709    ""
 710    (list
 711
 712     )))
 713
 714
 715 (define tie-interface
 716   (lily-interface
 717    'tie-interface
 718    "A tie connecting two noteheads."
 719    (list
 720     (property-description 'staffline-clearance number? "don't get closer than this to stafflines.")
 721     (property-description 'control-points list? "List of 4 offsets (number-pairs) controlling the tie shape")
 722     (property-description 'heads pair? "pair of element pointers, pointing to the two heads of the  tie. ")
 723     (property-description 'details list? "alist of parameters for the curve shape")
 724     (property-description 'thickness number? "thickness, measured in stafflinethickness")
 725     (property-description 'x-gap number? "horizontal gap between notehead and tie")
 726     (property-description 'direction dir? "up or down?")
 727     (property-description 'minimum-length number? "minimum length in staffspace")
 728     )))
 729
 730
 731
 732 (define tie-column-interface
 733   (lily-interface
 734    'tie-column-interface
 735    "that sets tie directions in a tied chord"
 736    (list
 737     )))
 738
 739 (define volta-bracket-interface
 740   (lily-interface
 741    'volta-bracket-interface
 742    "Volta bracket with number"
 743    (list
 744     (property-description 'bars  list? "list of barline ptrs.")
 745     (property-description 'thickness  number? "thickness, measured in stafflinethickness")
 746     (property-description 'height  number? "in staffspace ")
 747     )))
 748
 749 (define span-bar-interface
 750   (lily-interface
 751    'span-bar-interface
 752    ""
 753    (list
 754     )))
 755