;;;;
;;;; source file of the GNU LilyPond music typesetter
;;;;
-;;;; (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; (c) 1998--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
(define (define-grob-property symbol type? description)
(if (not (equal? (object-property symbol 'backend-doc) #f))
(begin
- (ly:warn (string-append "Redefining " (symbol->string symbol) "\n"))
- (exit 2)
- ))
+ (ly:warn-append "Redefining ~S" symbol)
+ (exit 2)))
(set-object-property! symbol 'backend-type? type?)
(set-object-property! symbol 'backend-doc description)
- symbol
- )
+ symbol)
;; put this in an alist?
(define-public
(Y-offset-callbacks ,list? "see @code{X-offset-callbacks}.")
(accidentals ,list? "List of alteration numbers.")
-
-
+ (add-stem-support ,boolean? "If set, the Stem object is included in this script's support")
+
(align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
@code{0}: around center of width, @code{1}: right side.")
-;;TODO -- change to fret-alignment?
- (alignment ,ly:dir? "Alignment for fret diagram. See @code {align-dir}.")
(arch-angle ,number? "Turning angle of the hook of a system brace" )
(arch-height ,ly:dimension? "Height of the hook of a system brace.")
(arch-thick ,number? "Thickness of the hook of system brace.")
(arch-width ,ly:dimension? "Width of the hook of a system brace.")
(arpeggio-direction ,ly:dir? "If set, put an
arrow on the arpeggio squiggly line.")
- (attachment ,pair? "Pair of symbols
-indicating how a slur should be attached at the ends. The format is
-'(@var{left-type} . @var{right-type}), where both @var{type}s are
-symbols. The values of these symbols may be @code{alongside-stem},
-@code{stem}, @code{head} or @code{loose-end}.")
- (attachment-offset ,pair? "cons of offsets,
-'(@var{left-offset} . @var{right-offset}). This offset is added to
-the attachments to prevent ugly slurs. [fixme: we need more
-documentation here].")
-
-
+
(auto-knee-gap ,ly:dimension? "If a gap is found between note heads
-where a horizontal beam fits that is larger than this number, make a kneed beam.")
+where a horizontal beam fits that is larger than this number, make a kneed beam.")
(axes ,list? "list of axis numbers.
In the case of alignment grobs, this should contain only one number.")
(bar-size-procedure ,procedure? "Procedure that computes the size of a bar line.")
(barre-type ,symbol? "Type of barre indication used in a fret diagram.
Choices include @code{curved} and @code{straight}.")
- (barre-vertical-offset ,number? "Offset for barre indication on fret
-diagram, from center of dot, in terms of dot radius.")
(base-shortest-duration ,ly:moment?
"Spacing is based on the shortest notes in a piece. Normally, pieces are spaced as if notes at least as short as this are present.")
(baseline-skip ,ly:dimension? "Distance between base lines of
(beamed-minimum-free-lengths ,list? "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.")
(beamed-extreme-minimum-free-lengths ,list? "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.")
- (beamed-stem-shorten ,list? " How much to shorten beamed stems,
-when their direction is forced. It is a list, since the value is different
+ (beamed-stem-shorten ,list? "How much to shorten beamed stems,
+when their direction is forced. It is a list, since the value is different
depending on the number flags/beams.")
(beaming ,pair?
"Pair of number lists. Each number list specifies which
beaming patterns from stem to stem inside a beam.")
- (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.")
(before-line-breaking-callback ,procedure? "This procedure is
called before line breaking, but after splitting breakable items at
potential line breaks.")
(between-cols ,pair? "Where to attach a loose column to")
- (bezier-height ,number? "Height of bezier sandwich used for curved
-barre indicator in fret diagrams.")
- (bezier-thick, ,number? "Thickness of bezier sandwich used for curved
-barre indicator in fret diagrams.")
+ (bound-padding ,number? "The amount of padding to insert around spanner bounds.")
+ (bracket-flare ,number-pair? "A pair of numbers specifying how
+much edges of brackets should slant outward. Value 0.0 means straight
+edges")
(bracket-thick ,number? "width of a system start bracket.")
(break-align-symbol ,symbol? "This key is used for aligning and
spacing breakable items.")
accidentals. Choices are @code{smaller} or
@code{parentheses}.")
(cautionary ,boolean? "Is this a cautionary accidental?")
- (concaveness-gap ,ly:dimension? "A beam is printed horizontally
-if its concaveness-gap is larger than this value. The concaveness-gap
-is the distance of an inner note head to the line between two outer
-note heads. ")
- (concaveness-threshold ,number? "A beam is printed horizontally
-if its concaveness is bigger than this threshold.
-
-Concaveness is calculated as the sum of the vertical distances of
-inner note heads that fall outside the interval of the two outer
-note heads, to the vertically nearest outer note head, divided by the
-square of the inner notes involved.")
+ (concaveness ,number? "A beam is concave when its inner stems are
+closer to the beam than the two outside stems. This number is a
+measure of the closeness of the inner stems. It is used for damping
+the slope of the beam.")
(collapse-height ,ly:dimension? "Minimum height of system start delimiter. If equal or smaller, the bracket is removed.")
+ (context ,ly:context? "Originating context of the grob")
+
;;DOCME
-
(control-points ,list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape.")
- (damping ,integer? "Amount of beam slope damping. 0: no, 1: yes,
+ (damping ,number? "Amount of beam slope damping. 0: no, 1: yes,
100000: horizontal beams.")
(dash-period ,number? "the length of one dash + white space. If
negative, no line is drawn at all.")
;; [FIXME: use dash-period/dash length; see text-spanner]
(dashed ,number? " number representing the length of the dashes.")
- (neutral-direction ,ly:dir? "Which direction to take in the
-center of the staff.")
- (neutral-position ,number? "Position (in half staff spaces) where
-to flip the direction of custos stem.")
-
;; todo: why is this tunable?
(dir-function ,procedure? "The function to determine the
direction of a beam. Choices include:
@table @code
-@item beam-dir-majority
+@item beam-dir-majority
number count of up or down notes
@item beam-dir-mean
mean center distance of all notes
-@item beam-dir-median.
+@item beam-dir-median.
mean center distance weighted per note
@end table
")
(direction ,ly:dir? "Up or down, left or right?")
- (dot-color ,symbol? "Color of dots in fret diagram. Options include
+ (dot-color ,symbol? "Color of dots. Options include
@code{black} and @code{white}.")
- (dot-label-font-mag ,number? "Magnification of font used to label dots in
-fret diagram.")
- (dot-position ,number? "Position of dot for fret diagram, in terms of
-fret spacing. 0.5 is middle of fret space, 1.0 is on bottom fret line,
-0.0 is on top fret line. Generally slightly above 0.5.")
- (dot-radius ,number? "Radius of dots used in fret diagrams, in terms of
-fret spacing.")
+ (dot-radius ,number? "Radius of dots.")
(dot-count ,integer? "The number of dots.")
(duration-log ,integer? "The 2-log of the note head duration, i.e. 0=whole note, 1 = half note, etc.")
(edge-height ,pair? "A pair of number specifying the heights of
the vertical edges '(@var{left-height} . @var{right-height}).")
- (bracket-flare ,number-pair? "A pair of numbers specifying how
-much edges of brackets should slant outward. Value 0.0 means straight
-edges")
-
(edge-text ,pair? "A pair specifying the texts to be set at the
edges '(@var{left-text} . @var{right-text}).")
+ (excentricity ,number? "How asymmetrical to make a slur. Positive means move the center to the right.")
+
(expand-limit ,integer? "maximum number of measures expanded in church rests.")
;; remove me?
offset is added just before outputting the symbol, so the typesetting
engine is completely oblivious to it.")
- ;; docme.
- (extremity-offset-alist ,list? "The offset adds to the centre of
-the note head, or stem.
-
-Format: alist (attachment stem-dir*dir slur-dir*dir) -> offset.
-")
-
- ;;
- (extremity-function ,procedure? "A function that calculates the
-attachment of a slur-end. The function takes a slur and direction argument and returns a symbol.")
(finger-code ,symbol? "Code for the type of fingering indication in a
fret diagram. Options include @code{none}, @code{in-dot}, and @code{below-string}.")
- (finger-xoffset ,number? "X offset of the text labeling fingering below
-the string of a fret-diagram, in units of string spaces.")
- (finger-yoffset ,number? "Y offset of the text labeling fingering below
-the string of a fret-diagram, in units of fret spaces.")
-
(flag-style ,symbol?
"a string determining what style of flag-glyph is
typeset on a Stem. Valid options include @code{()} and
@code{mensural}. Additionally, @code{\"no-flag\"} switches off the
flag.")
- (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
(flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
(font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
(font-encoding ,symbol? "The font encoding is the broadest
(font-shape ,symbol? "Select the shape of a font. Choices include @code{upright},
@code{italic}, @code{caps}.")
+ (forced-distance ,ly:dimension? "A fixed distance between object
+reference points in an alignment.")
+
(force-hshift ,number? "This specifies a manual shift for notes
in collisions. The unit is the note head width of the first voice
note. This is used by @internalsref{note-collision-interface}.")
(french-beaming ,boolean? "Use French beaming style for this
stem. The stem will stop at the innermost beams.")
(fret-count ,integer? "The number of frets in a fret diagram.")
- (fret-label-vertical-offset ,number? "Vertical offset of text used to
-label the top fret in a fret diagram.")
+
;; ugh: double, change.
(full-size-change ,boolean? "Don't make a change clef smaller.")
(non-default ,boolean? "Set for manually specified clefs.")
(horizontal-shift ,integer? "An integer that identifies ranking
of note-column for horizontal shifting. This is used by
@internalsref{note-collision-interface}.")
+ (inside-slur ,boolean? "If set, this script should be inside the
+slur. If set to false, the script places itself around the slur. If
+unset, script and slur ignore each other ")
(inspect-quants ,number-pair? "If debugging is set,
set beam quant to this position, and print the respective scores.")
-
+
+ (allow-outside-line ,boolean? "If set, allow this column to
+things sticking into the margin.")
(kern ,ly:dimension? "Amount of extra white space to add. For
bar line, this is the amount of space after a thick line.")
(knee ,boolean? "Is this beam kneed?")
(knee-spacing-correction ,number? "Factor for the optical
correction amount for kneed beams. Set between 0 for no correction and
1 for full correction.")
- (label-font-magnification ,number? "Magnification of font used to
-label the top fret on a fret diagram")
+ (label-dir ,ly:dir? "Side to which label is attached. @code{-1} for left, @code{1} for right.")
(layer ,number? "The output layer [0..2]: layers define the order
of printing objects. Objects in lower layers are overprinted by
objects in higher layers.")
should move (after padding).")
(print-function ,procedure? "Function taking grob as argument,
returning a @code{Stencil} object.")
+ (neutral-direction ,ly:dir? "Which direction to take in the
+center of the staff.")
+ (neutral-position ,number? "Position (in half staff spaces) where
+to flip the direction of custos stem.")
+
(new-accidentals ,list? "List of @code{(@var{pitch}
. @var{accidental})} pairs.")
+ (next ,ly:grob? "Object that is next relation (eg. the lyric syllable following an extender.")
(note-names ,vector? "Vector of strings containing names for
easy-notation note heads.")
+ (no-ledgers ,boolean? "If set, don't draw ledger lines on this object.")
(no-spacing-rods ,boolean? "Items with this property do not cause
spacing constraints.")
(no-stem-extend ,boolean? "If set, notes with ledger lines do not
get stems extending to the middle staff line.")
-
+ (number-type ,symbol? "Type of numbers to use in label. Choices
+include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")
+
(old-accidentals ,list? "List of @code{(@var{pitch} . @var{accidental})
pairs.}")
means force line break. Other values influence line breaking decisions
as a real penalty.")
- (pitch-max ,ly:pitch? "Top pitch for ambitus.")
- (pitch-min ,ly:pitch? "Bottom pitch for ambitus.")
-
(positions ,pair?
"Pair of staff coordinates @code{(@var{left}
. @var{right})}, where both @var{left} and @var{right} are in the
"Multiply direction of
@code{direction-source} with this to get the direction of this
object.")
-;;TODO -- change size to fret-diagram-size
- (size ,number? "Size of fret diagram.")
+ (size ,number? "Size of object, relative to standard size.")
(slope ,number? "The slope of this object.")
- (slope-limit ,number? "Set slope to zero if slope is running away
-steeper than this.")
-
+ (slur-padding ,number? "Extra distance between slur and script.")
+ (slur-details ,list?
+ "An alist of scoring parameters for slur formatting")
(space-alist ,list? "A table that specifies distances between
prefatory items, like clef and time-signature. The format is an alist
of spacing tuples: @code{(@var{break-align-symbol} @var{type}
staff spaces, counted from the middle line.")
(staffline-clearance ,ly:dimension? "How far away ties keep from
staff lines.")
-
+ (stemlet-length ,number? "How long should a stem over a rest be?")
(stem-attachment-function ,procedure? "A function that calculates
where a stem attaches to the note head? This is a fallback when this
information is not specified in the font. The function takes a grob
stems that are placed in tight configurations. For opposite
directions, this amount is the correction for two normal sized stems
that overlap completely.")
+
+
(string-count ,integer? "The number of strings in a fret diagram.")
- (string-label-font-mag ,number? "Mangification for font used to label
-finger indications below strings in fret diagram")
+ (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
+
(style ,symbol? "This setting determines in what style a grob is
typeset. Valid choices depend on the @code{print-function} that is
reading this property.")
@code{linethickness}.")
(thickness ,number? "Bar line thickness, measured in
@code{linethickness}.")
-;;TODO -- change to fret-thickness
- (thickness ,number? "Thickness of fret and string lines in a fret
-diagram. Multiplier on bar thickness.")
(thin-kern ,number? "The space after a hair-line in a bar line.")
- (forced-distance ,ly:dimension? "A fixed distance between object
-reference points in an alignment.")
(threshold ,number-pair? "(@var{min} . @var{max}), where
@var{min} and @var{max} are dimensions in staff space.")
- (top-fret-thickness ,number? "Thickness of the top fret in a fret
-diagram, as a multiplier of the standard fret thickness.")
(transparent ,boolean? "This is almost the same as setting
@code{print-function} to @code{#f}, but this retains the dimensions of
this grob, which means that grobs can be erased individually.")
words in texts.")
(width ,ly:dimension? "The width of a grob measured in staff space.")
(x-gap ,ly:dimension? "The horizontal gap between note head and tie.")
- (xo-font-mag ,number? "Magnification for the font used to label mute
-and open strings in a fret diagram.")
- (xo-horizontal-offset ,number? "Horizontal offset for characters used
-to label mute and open strings in a fret diagram.")
- (xo-padding ,number? "Vertical padding for mute and open indicators
-in fret diagram.")
- (y-free ,ly:dimension? "The minimal vertical gap between slur and
-note heads or stems.")
(y-offset ,ly:dimension? "Extra vertical offset for ties away
from the center line.")
(zigzag-length ,ly:dimension? "The length of the lines of a
(apply define-internal-grob-property x))
`(
+ (axis-group-parent-X ,ly:grob? "Containing X axis group")
+ (axis-group-parent-Y ,ly:grob? "Containing Y axis group")
(accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
+ (adjacent-hairpins ,grob-list? "List of directly neighboring hairpins")
(after-line-breaking-callback ,procedure? "This procedure is called after line breaking. Its return value is ignored.")
(all-elements ,grob-list? "list of all grobs in this line. Its
function is to protect objects from being garbage collected.")
(center-element ,ly:grob? "grob which will be at the center of
the group after aligning (when using
Align_interface::center_on_element).")
+ (tweak-count ,number? "Number of otherwise unique Grobs.")
+ (tweak-rank ,number? "Identify otherwise unique Grobs.")
(direction-source ,ly:grob? "in case side-relative-direction is
set, which grob to get the direction from .")
(dot ,ly:grob? "reference to Dots object.")
(tie ,ly:grob? "")
(staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
(rest ,ly:grob? "the staff symbol grob that we're in.")
+ (rests ,grob-list? "A list of rest objects.")
(rest-collision ,ly:grob? "rest collision that a rest is in.")
(accidental-grob ,ly:grob? "Accidental for this note.")
(bars ,grob-list? "list of bar line pointers.")
paper-columns or note-column objects.")
(conditional-elements ,grob-list? "Internal use only")
(dependencies ,grob-list? "list of score-grob pointers that indicate who to compute first for certain global passes.")
+ (encompass-objects ,grob-list? "Objects that a slur should avoid
+in addition to notes and stems.")
(elements ,grob-list? "list of grobs, type depending on the Grob where this is set in.")
(heads ,grob-list? "List of note heads.")
(items-worth-living ,grob-list? "A list of interesting items. If
(chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
(begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")
(head-pair ,pair? "Pair of grob pointers, pointing to the two heads of the tie.")
- (quant-score ,number? "Beam quanting score -- can be stored for
+ (quant-score ,string? "Beam quanting score -- can be stored for
debugging")
(least-squares-dy ,number?
"ideal beam slope, without damping.")
(stem-info ,pair? "caching of stem parameters")
(note-columns ,pair? "list of NoteColumn grobs.")
- (if-text-padding ,number? "padding in case texts are there.")
(position-callbacks ,list? "list of
functions set spanner positions.")
;; [TODO: change this]
(primitive ,integer? "Pointer to a ligature primitive, i.e. an item similar to a note head that is part of a ligature. ")
(stencil ,ly:stencil? "Cached output of the print-function.")
- (de-uglify-parameters ,list? "list of 3 real constants. They
-define the valid areas for the middle control points. They are
-empirical.")
(ideal-distances ,list? "(@var{obj} . (@var{dist} . @var{strength})) pairs.")
(minimum-distances ,list? "list of rods, that have the format (@var{obj} . @var{dist}).")
(interfaces ,list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
(shorten ,ly:dimension? "The amount of space that a
stem. Internally used to distribute beam shortening over stems. ")
-
+ (slur ,ly:grob? "A pointer to a slur object")
(use-breve-rest ,boolean? "Use breve rests for measures longer
than a whole rest.")
-
+ (spaceable-staves ,grob-list? "Objects to be spaced during page layout.")
;; ancient notation
(join-left ,boolean? "is this ligature head joined with the previous one by a vertical line?")
(context-info ,integer? "DOCME")
(inclinatum ,boolean? "is this neume an inclinatum?")
- (note-head-style ,string? "name of the font character to be used as note heads in the ambitus grob.")
(oriscus ,boolean? "is this neume an oriscus?")
(quilisma ,boolean? "is this neume a quilisma?")
(pes-or-flexa ,boolean? "shall this neume be joined with the previous head?")
;; end ancient notation
- ; ugh.
- (accidentals-style ,symbol? "style for ambitus.")
-
)))
(define-public all-backend-properties
(append
all-internal-grob-properties
all-user-grob-properties))
-
projects / lilypond.git / blobdiff