scm/interface.scm

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