2 ; should include default value?
4 ;;; ::::::: should generate documentation for score elements from here.
6 (define (property-description symbol type? description)
7 (list symbol type? description))
9 (define (lily-interface symbol description props)
17 (define (merge-interfaces ifs)
19 (apply append (map car ifs))
20 (apply append (map cadr ifs))
21 (apply append (map caddr ifs))
24 (define (uniqued-alist alist acc)
26 (if (assoc (caar alist) acc)
27 (uniqued-alist (cdr alist) acc)
28 (uniqued-alist (cdr alist) (cons (car alist) acc)
31 (define (element-description name . interfaces)
32 (let* ((ifs (cons general-element-interface interfaces))
33 (props (map caddr ifs))
36 (list (cons 'separator "\n\n\n") ;easy printing.
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))
46 (define general-element-interface
48 'general-element-interface
49 "All elements support this"
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
69 (property-description 'molecule-callback procedure? "Function taking graphical element as argument, returning a Scheme encoded Molecule")
73 (define beam-interface
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.")
102 (define clef-interface
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")
113 (define axis-group-interface
115 'axis-group-interface
116 "a group of coupled elements"
118 (property-description 'axes list? "list of axis (number) in which this group works")
121 (define note-column-interface
123 'note-column-interface
124 "Stem and noteheads combined"
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.")
132 (define stem-interface
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.")
159 (define slur-interface
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.")
181 (define side-position-interface
183 'side-position-interface
184 "Position a victim object (this one) next to other objects (the support)."
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")
198 (define accidentals-interface
200 'accidentals-interface
203 (property-description 'left-padding number? "space left of accs")
204 (property-description 'right-padding number? "space right of accs")
208 (define line-of-score-interface
210 'line-of-score-interface
211 "Super element, parent of all:
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."
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")
233 (define note-head-interface
238 (property-description 'style symbol? "symbol that sets note head style")
242 (define note-name-interface
247 (property-description 'style symbol? "symbol that sets note name style")
252 (define rhythmic-head-interface
254 'rhythmic-head-interface
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")
262 (define rest-interface
267 (property-description 'style string? "string specifying glyph style"))))
269 (define tuplet-bracket-interface
271 'tuplet-bracket-interface
272 "A bracket with a number in the middle, used for tuplets."
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")
283 (define align-interface
286 " Order elements top to bottom/left to right/right to left etc."
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.")
300 (define aligned-interface
303 "read by align-interface"
305 (property-description 'minimum-space number-pair? "(cons LEFT RIGHT)")
306 (property-description 'extra-space number-pair? "(cons LEFT RIGHT)")
309 (define break-aligned-interface
311 'break-aligned-interface
312 "Items that are aligned in prefatory matter"
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.)")
319 (define chord-name-interface
321 'chord-name-interface
322 "generate a chord name"
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")
329 (define time-signature-interface
331 'time-signature-interface
332 "A time signature, in different styles"
334 (property-description 'fraction number-pair? "")
335 (property-description 'style string? "")
338 (define bar-line-interface
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")
356 (define hairpin-interface
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 ")
366 (define arpeggio-interface
371 (property-description 'stems list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
376 (define note-collision-interface
378 'note-collision-interface
381 (property-description 'note-width 'number? "unit for horizontal translation, measured in staff-space.")
383 (define dot-interface
386 "The dots to go with a notehead/rest. A separate interface, since they
387 are a party in collision resolution."
389 (property-description 'dot-count integer? "number of dots")
392 (define text-interface
395 "A scheme markup text"
397 (property-description 'text (lambda (x) (or (string? x) (list? x))) "
398 Scheme markup text. It is defined as follows:
401 TEXT : STRING | (MARKUP SENTENCE)<br>
402 MARKUP: PROPERTY | ABBREV<br>
403 SENTENCE: TEXT | SENTENCE TEXT<br>
404 PROPERTY: (key . value)<br>
405 ABBREV: rows lines roman music bold italic named super sub text, or any font-style
408 So, TEXT is either a string, or a list of which the CAR is a MARKUP.
409 MARKUP is either a CONS: an element property '(key . value) or a symbol:
410 a predefined abbreviation for a list of element properties.
413 The following abbreviations are currently defined:
415 <dt>rows<dd> horizontal mode: set all text on one line (default)
416 <dt>lines<dd> vertical mode: set every text on new line
417 <dt>roman<dd> select roman font
418 <dt>music<dd> select feta font
419 <dt>bold<dd> select bold series
420 <dt>italic<dd> select italic shape
421 <dt>named<dd> lookup by character name
422 <dt>text<dd> plain text lookup (by character value)
423 <dt>super<dd> superscript
424 <dt>sub<dd> subscript
425 <dt> any font-style<dd> finger volta timesig mmrest mark script large Large dynamic
428 (property-description 'font-style string? "font definition for a special purpose, one of: finger volta timesig mark script large Large dynamic")
429 (property-description 'font-series string? "partial font definition: medium, bold")
430 (property-description 'font-shape string? "partial font definition: upright or italic")
431 (property-description 'font-family string? "partial font definition: music roman braces dynamic math ...")
432 (property-description 'font-name string? "partial font definition: base name of font file FIXME: should override other partials")
433 (property-description 'font-point string? "partial font definition: exact font size in points FIXME: should override font-size")
434 (property-description 'font-size string? "partial font definition: the relative size, 0 is style-sheet's normal size, -1 is smaller, +1 is bigger")
435 (property-description 'align number? "the alignment of the text, 0 is horizontal, 1 is vertical")
436 (property-description 'lookup symbol? "lookup method: 'value for plain text, 'name for character-name")
437 (property-description 'raise number? "height for text to be raised (a negative value lowers the text")
438 (property-description 'kern number? "amount of extra white space to add before text. This is `relative'(?) to the current alignment.")
439 (property-description 'magnify number? "the magnification factor. FIXME: doesn't work for feta fonts")
443 (define dot-column-interface
445 'dot-column-interface
446 "Interface that groups dots so they form a column"
450 (define dynamic-interface
453 "Any kind of loudness sign"
458 (define finger-interface
461 "A fingering instruction"
465 (define separation-spanner-interface
467 'separation-spanner-interface
468 "Spanner that containing <code>separation-item-interface</code> elements to calculate rods"
471 (define text-script-interface
473 'text-script-interface
478 (define grace-alignment-interface
480 'grace-alignment-interface
481 "put grace notes in line"
483 (property-description 'horizontal-space number? "amount of space to add after a note (in staff-space)")
487 (define hara-kiri-group-interface
489 'hara-kiri-group-interface
490 " As Vertical_group_spanner, but keep track of interesting items. If
491 we don't contain any interesting items after linebreaking, then
492 gracefully commit suicide. Objective: don't disgrace Lily by
493 typesetting empty lines in orchestral scores."
495 (property-description 'items-worth-living list? "list of interesting items. If empty in a particular system, clear that system.")
500 (define lyric-hyphen-interface
502 'lyric-hyphen-interface
503 "A centred hyphen is a simple line between lyrics used to divide
504 syllables. The length of the hyphen line should stretch based on the
505 size of the gap between syllables."
508 (property-description 'thickness number? "thickness of line (in stafflinethickness)")
509 (property-description 'height number? "vertical offset (in staffspace)")
511 (property-description 'minimum-length number? "try to make the hyphens at least this long. Also works as a scaling parameter for the length")
512 (property-description 'word-space number? "elongate left by this much (FIXME: cumbersome semantics)")
515 (define key-signature-interface
517 'key-signature-interface
518 "A group of accidentals."
520 (property-description 'c0-position integer? "integer indicating the position of central C")
521 (property-description 'old-accidentals list? "list of (pitch, accidental) pairs")
522 (property-description 'new-accidentals list? "list of (pitch, accidental) pairs")
525 (define lyric-extender-interface
527 'lyric-extender-interface
528 "The extender is a simple line at the baseline of the lyric
529 that helps show the length of a melissima (tied/slurred note)."
531 (property-description 'word-space number? "")
532 (property-description 'height number? "in stafflinethickness")
533 (property-description 'right-trim-amount number? "")
537 (define lyric-syllable-interface
539 'lyric-syllable-interface
540 "a single piece of lyrics"
542 (property-description 'word-space number? "")
546 (define mark-interface
553 (define multi-measure-rest-interface
555 'multi-measure-rest-interface
556 "A rest that spans a whole number of measures."
559 (property-description 'columns list? "list of paper-columns")
560 (property-description 'expand-limit integer? "maximum number of measures expanded in church rests")
561 (property-description 'minimum-width number? "minimum-width of rest symbol, in staffspace")
562 (property-description 'padding number? "padding between number and rest. Measured in staffspace.")
565 (define paper-column-interface
567 'paper-column-interface
570 (property-description 'when moment? "when does this column happen?")
571 (property-description 'bounded-by-me list? "list of spanners that have this
572 column as start/begin point. Only columns that have elements or act as bounds are spaced.")
573 (property-description 'dir-list list? "list of stem directions")
574 (property-description 'shortest-playing-duration moment? "duration of the shortest playing in that column.")
575 (property-description 'shortest-starter-duration moment? "duration of the shortest notes that starts exactly in this column.")
576 (property-description 'contains-grace boolean? "Used to widen entries for grace notes.")
577 (property-description 'extra-space number-pair? "pair of distances")
578 (property-description 'stretch-distance number-pair? "pair of distances")
581 (define spaceable-element-interface
583 'spaceable-element-interface
584 "An element (generally a Paper_column) that takes part in the
587 (property-description 'minimum-distances list? "list of rods (ie. (OBJ . DIST) pairs)")
588 (property-description 'ideal-distances list? "(OBJ . (DIST . STRENGTH)) pairs")
589 (property-description 'dir-list list? "list of stem directions, needed for optical spacing correction.")
592 (define rest-collision-interface
594 'rest-collision-interface
595 "Move around ordinary rests (not multi-measure-rests) to avoid
598 (property-description 'maximum-rest-count integer? "kill off rests so we don't more than this number left.")
599 (property-description 'minimum-distance number? "minimum distance between notes and rests.")
600 (property-description 'elements list? "list of elements (NoteColumn,
601 generally) participating in the collision. The
602 <code>rest-collision</code> property in <code>elements</code> is set
603 to a pointer to the collision")
606 (define script-interface
611 (property-description 'script-priority number? "A sorting key that determines in what order a script is within a stack of scripts")
614 (define script-column-interface
616 'script-column-interface
617 "An interface that sorts scripts according to their <code>script-priority</code>"
621 (define spacing-spanner-interface
623 'spacing-spanner-interface
626 (property-description 'maximum-duration-for-spacing moment? "space as if a duration of this type is available in this measure.")
629 (define staff-symbol-interface
631 'staff-symbol-interface
632 "This spanner draws the lines of a staff. The middle line is
635 (property-description 'staff-space number? "Amount of line leading relative to global staffspace")
636 (property-description 'line-count integer? "Number of staff lines")
639 (define stem-tremolo-interface
641 'stem-tremolo-interface
644 (property-description 'stem ly-element? "pointer to the stem object.")
645 (property-description 'beam-width number? "width of the tremolo sign")
646 (property-description 'beam-thickness number? "thickness, measured in staffspace")
647 (property-description 'beam-space-function procedure? "function returning space given multiplicity")
650 (define separation-item-interface
652 'separation-item-interface
653 "Item that computes widths to generate spacing rods.
655 Calc dimensions for the Separating_group_spanner; this has to be
656 an item to get dependencies correct. It can't be an element_group
657 since these usually are in a different X_group
660 (property-description 'elements list? " -- list of items.")
663 (define sustain-pedal-interface
665 'sustain-pedal-interface
669 (define system-start-delimiter
671 'system-start-delimiter
674 (property-description 'collapse-height number? "")
675 (property-description 'thickness number? "thickness, measured in stafflinethickness")
677 ; Should collapse into (bracket . ((height . ) ... ))
679 (property-description 'arch-height number? "")
680 (property-description 'arch-angle number? "")
681 (property-description 'arch-thick number? "")
682 (property-description 'arch-width number? "")
683 (property-description 'bracket-thick number? "")
684 (property-description 'bracket-width number? "")
685 (property-description 'glyph symbol? "bar-line, bracket or brace")
688 (define text-spanner-interface
690 'text-spanner-interface
691 "generic text spanner"
693 (property-description 'dash-period number? "the length of one dash + white space")
694 (property-description 'dash-length number? "the length of a dash")
695 (property-description 'line-thickness number? "the thickness[stafflinethickness] of the line")
696 (property-description 'edge-height pair? "a cons that specifies the heights of the vertical egdes '(LEFT-height . RIGHT-height)")
697 (property-description 'edge-text pair? "a cons that specifies the texts to be set at the edges '(LEFT-text . RIGHT-text)")
698 (property-description 'type string? "one of: line, dashed-line or dotted-line") ; SYMBOL!!?
702 (define text-script-interface
704 'text-script-interface
711 (define tie-interface
714 "A tie connecting two noteheads."
716 (property-description 'staffline-clearance number? "don't get closer than this to stafflines.")
717 (property-description 'control-points list? "List of 4 offsets (number-pairs) controlling the tie shape")
718 (property-description 'heads pair? "pair of element pointers, pointing to the two heads of the tie. ")
719 (property-description 'details list? "alist of parameters for the curve shape")
720 (property-description 'thickness number? "thickness, measured in stafflinethickness")
721 (property-description 'x-gap number? "horizontal gap between notehead and tie")
722 (property-description 'direction dir? "up or down?")
723 (property-description 'minimum-length number? "minimum length in staffspace")
728 (define tie-column-interface
730 'tie-column-interface
731 "that sets tie directions in a tied chord"
735 (define volta-bracket-interface
737 'volta-bracket-interface
738 "Volta bracket with number"
740 (property-description 'bars list? "list of barline ptrs.")
741 (property-description 'thickness number? "thickness, measured in stafflinethickness")
742 (property-description 'height number? "in staffspace ")
745 (define span-bar-interface