From c116009aaed941d49e778848d63c5b0f6186b730 Mon Sep 17 00:00:00 2001 From: fred Date: Wed, 27 Mar 2002 00:34:31 +0000 Subject: [PATCH] lilypond-1.3.116 --- scm/auto-beam.scm | 5 +- scm/backend-documentation-lib.scm | 52 ++-- scm/backend-property.scm | 406 ++++++++++++++--------------- scm/documentation-lib.scm | 4 +- scm/engraver-documentation-lib.scm | 4 +- scm/generate-documentation.scm | 10 +- scm/interface.scm | 30 +-- scm/lily.scm | 4 +- scm/translator-properties.scm | 18 +- 9 files changed, 273 insertions(+), 260 deletions(-) diff --git a/scm/auto-beam.scm b/scm/auto-beam.scm index ec78e2b2f6..73a01b0360 100644 --- a/scm/auto-beam.scm +++ b/scm/auto-beam.scm @@ -60,6 +60,9 @@ ((end 1 16 2 4) . ,(make-moment 1 4)) ((end 1 32 2 4) . ,(make-moment 1 8)) + ;; It seems that, because of a bug in the previous auto-beamer, + ;; we had the effect of this setting x + ;; ((end * * 2 8) . ,(make-moment 2 8)) ((end * * 4 8) . ,(make-moment 1 4)) ((end 1 16 4 8) . ,(make-moment 1 4)) @@ -78,7 +81,7 @@ ((end * * 12 8) . ,(make-moment 3 8)) ((end 1 16 12 8) . ,(make-moment 3 8)) ((end 1 32 12 8) . ,(make-moment 1 8)) - (meta . ,(element-description "autoBeamSettings")) + (meta . ,(grob-description "autoBeamSettings")) )) ;;; Users may override in most cases, simply by issuing diff --git a/scm/backend-documentation-lib.scm b/scm/backend-documentation-lib.scm index 0667b1bc49..3125d7cc17 100644 --- a/scm/backend-documentation-lib.scm +++ b/scm/backend-documentation-lib.scm @@ -25,10 +25,10 @@ desc) )) -(define (document-element-property sym element-description only-doc-if-set) +(define (document-grob-property sym grob-description only-doc-if-set) (let* ( - (handle (assoc sym element-description)) + (handle (assoc sym grob-description)) (defval (if (eq? handle #f) "" (scm->texi (cdr handle)) @@ -43,22 +43,22 @@ defval))) )) -(define (document-interface where interface element-description) +(define (document-interface where interface grob-description) " " - (let* ((level (if (eq? where 'element) 3 2)) + (let* ((level (if (eq? where 'grob) 3 2)) (name (car interface)) (desc (cadr interface)) (props (caddr interface)) (docfunc (lambda (x) - (document-element-property - x element-description (eq? where 'element)))) + (document-grob-property + x grob-description (eq? where 'grob)))) (docs (map docfunc props)) ) (string-append - (texi-section level (string-append (interface-name (symbol->string name))) (eq? where 'element)) ;gur. + (texi-section level (string-append (interface-name (symbol->string name))) (eq? where 'grob)) ;gur. desc (description-list->texi docs) @@ -72,8 +72,8 @@ (node (interface-name name)) (document-interface 'self interface '())))) -;; First level element description -(define (document-element iname description) +;; First level grob description +(define (document-grob iname description) (processing iname) (let* ((metah (assoc 'meta description)) @@ -84,51 +84,51 @@ (name (cdr (assoc 'name meta))) (ifaces (cdr (assoc 'interface-descriptions meta))) - (ifacedoc (map (lambda (x) (document-interface 'element x description)) + (ifacedoc (map (lambda (x) (document-interface 'grob x description)) (reverse ifaces)))) (string-append - (node (element-name name)) - (texi-section 2 (element-name name) #f) + (node (grob-name name)) + (texi-section 2 (grob-name name) #f) "\n" - (let* ((element (string->symbol name)) + (let* ((grob (string->symbol name)) (engravers (apply append (map (lambda (x) (let ((engraver (car x)) (objs (cadddr x))) - (if (member element objs) + (if (member grob objs) (list engraver) '()))) engraver-description-alist)))) (string-append - name " elements are created by: " + name " grobs are created by: " (human-listify (map reffy (map engraver-name engravers))))) (apply string-append ifacedoc)))) -(define (document-all-elements name) +(define (document-all-grobs name) (let* ((doc (apply string-append - (map (lambda (x) (document-element (car x) (cdr x))) - all-element-descriptions))) - (names (map car all-element-descriptions))) + (map (lambda (x) (document-grob (car x) (cdr x))) + all-grob-descriptions))) + (names (map car all-grob-descriptions))) (string-append - (texi-node-menu name (map (lambda (x) (cons (element-name x) "")) + (texi-node-menu name (map (lambda (x) (cons (grob-name x) "")) names)) doc))) ;; testin.. -- how to do this (eval-string (ly-gulp-file "interface.scm")) (define xinterface-description-alist - `( - (general-element . ,general-element-interface) - (beam . ,beam-interface) - (clef . ,clef-interface) - (slur . ,slur-interface) - )) + `( + (general-grob . ,general-grob-interface) + (beam . ,beam-interface) + (clef . ,clef-interface) + (slur . ,slur-interface) + )) ;; burp, need these for running outside of LilyPond (if #f diff --git a/scm/backend-property.scm b/scm/backend-property.scm index f78f582867..c098361b9b 100644 --- a/scm/backend-property.scm +++ b/scm/backend-property.scm @@ -1,6 +1,6 @@ (define all-backend-properties '()) -(define (elt-property-description symbol type? description) +(define (grob-property-description symbol type? description) (set-object-property! symbol 'backend-type? type?) (set-object-property! symbol 'backend-doc description) (set! all-backend-properties (cons symbol all-backend-properties)) @@ -10,235 +10,235 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(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.") -(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") -(elt-property-description 'Y-extent-callback procedure? "see @code{X-extent-callback}") -(elt-property-description 'Y-offset-callbacks list? "see @code{X-offset-callbacks}") -(elt-property-description 'after-line-breaking-callback procedure? "Procedure taking graphical element as argument. +(grob-property-description 'X-extent-callback procedure? "procedure taking an grob and axis argument, returning a number-pair. The return value is the extent of the grob.") +(grob-property-description 'X-offset-callbacks list? "list of functions, each taking an grob and axis argument. The function determine the position relative to this grob's parent. The last one in the list is called first") +(grob-property-description 'Y-extent-callback procedure? "see @code{X-extent-callback}") +(grob-property-description 'Y-offset-callbacks list? "see @code{X-offset-callbacks}") +(grob-property-description 'after-line-breaking-callback procedure? "Procedure taking a grob as argument. This procedure is called (using dependency resolution) after line breaking. Return value is ignored") -(elt-property-description 'align number? "the alignment of the text, 0 is horizontal, 1 is vertical") -(elt-property-description 'align-dir dir? "Which side to align? -1: left side, 0: around center of width, 1: right side") -(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)") -(elt-property-description 'all-elements list? "list of all score elements in this line. Needed for protecting elements from GC.") -(elt-property-description 'arch-angle number? "") -(elt-property-description 'arch-height number? "") -(elt-property-description 'arch-thick number? "") -(elt-property-description 'arch-width number? "") -(elt-property-description 'arithmetic-basicspace number? "") -(elt-property-description 'arithmetic-multiplier number? "see arithmetic-basicspace") -(elt-property-description 'attachment pair? "cons of symbols, '(LEFT-TYPE . RIGHT-TYPE), where both types may be alongside-stem, stem, head or loose-end") -(elt-property-description 'attachment-offset pair? "cons of offsets, '(LEFT-offset . RIGHT-offset). This offset is added to the attachments to prevent ugly slurs.") -(elt-property-description 'axes list? "list of axis numbers. Should contain only one number.") -(elt-property-description 'axes list? "list of axis (number) in which this group works") -(elt-property-description 'bar-size number? "") -(elt-property-description 'bars list? "list of barline ptrs.") -(elt-property-description 'barsize-procedure procedure? "how to compute the size of a bar line") -(elt-property-description 'bass list? " musical-pitch, optional") -(elt-property-description 'beam ly-grob? "pointer to the beam, if applicable") -(elt-property-description 'beam-space-function procedure? "function returning space given multiplicity") -(elt-property-description 'beam-space-function procedure? "function returning space given multiplicity") -(elt-property-description 'beam-thickness number? "thickness, measured in staffspace") -(elt-property-description 'beam-thickness number? "thickness, measured in staffspace") -(elt-property-description 'beam-width number? "width of the tremolo sign") -(elt-property-description 'beam-width number? "width of the tremolo sign") -(elt-property-description 'beamed-lengths list? "list of stem lengths given beam multiplicity ") -(elt-property-description 'beamed-minimum-lengths list? "list of minimum stem lengths given beam multiplicity") -(elt-property-description 'beamed-stem-shorten number? "shorten beamed stems in forced direction") -(elt-property-description 'beaming number-pair? "number of beams extending to left and right") -(elt-property-description 'beams list? "list of beam ptrs.") -(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.") -(elt-property-description 'before-grace-spacing-factor number? " stretch space this much if there are grace notes before the column") -(elt-property-description 'before-line-breaking-callback procedure? "Procedure taking graphical element as argument. +(grob-property-description 'align number? "the alignment of the text, 0 is horizontal, 1 is vertical") +(grob-property-description 'align-dir dir? "Which side to align? -1: left side, 0: around center of width, 1: right side") +(grob-property-description 'alignment-done boolean? "boolean to administrate whether we've done the alignment already (to ensure that the process is done only once)") +(grob-property-description 'all-elements list? "list of all grobs in this line. Needed for protecting grobs from GC.") +(grob-property-description 'arch-angle number? "") +(grob-property-description 'arch-height number? "") +(grob-property-description 'arch-thick number? "") +(grob-property-description 'arch-width number? "") +(grob-property-description 'arithmetic-basicspace number? "") +(grob-property-description 'arithmetic-multiplier number? "see arithmetic-basicspace") +(grob-property-description 'attachment pair? "cons of symbols, '(LEFT-TYPE . RIGHT-TYPE), where both types may be alongside-stem, stem, head or loose-end") +(grob-property-description 'attachment-offset pair? "cons of offsets, '(LEFT-offset . RIGHT-offset). This offset is added to the attachments to prevent ugly slurs.") +(grob-property-description 'axes list? "list of axis numbers. Should contain only one number.") +(grob-property-description 'axes list? "list of axis (number) in which this group works") +(grob-property-description 'bar-size number? "") +(grob-property-description 'bars list? "list of barline ptrs.") +(grob-property-description 'barsize-procedure procedure? "how to compute the size of a bar line") +(grob-property-description 'bass list? " musical-pitch, optional") +(grob-property-description 'beam ly-grob? "pointer to the beam, if applicable") +(grob-property-description 'beam-space-function procedure? "function returning space given multiplicity") +(grob-property-description 'beam-space-function procedure? "function returning space given multiplicity") +(grob-property-description 'beam-thickness number? "thickness, measured in staffspace") +(grob-property-description 'beam-thickness number? "thickness, measured in staffspace") +(grob-property-description 'beam-width number? "width of the tremolo sign") +(grob-property-description 'beam-width number? "width of the tremolo sign") +(grob-property-description 'beamed-lengths list? "list of stem lengths given beam multiplicity ") +(grob-property-description 'beamed-minimum-lengths list? "list of minimum stem lengths given beam multiplicity") +(grob-property-description 'beamed-stem-shorten number? "shorten beamed stems in forced direction") +(grob-property-description 'beaming number-pair? "number of beams extending to left and right") +(grob-property-description 'beams list? "list of beam ptrs.") +(grob-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.") +(grob-property-description 'before-grace-spacing-factor number? " stretch space this much if there are grace notes before the column") +(grob-property-description 'before-line-breaking-callback procedure? "Procedure taking grob as argument. This procedure is called (using dependency resolution) before line breaking, but after generating discretionary items. Return value is ignored") -(elt-property-description 'before-musical-spacing-factor number? "space before musical columns (eg. taken by accidentals) get this much +(grob-property-description 'before-musical-spacing-factor number? "space before musical columns (eg. taken by accidentals) get this much stretched when they follow a musical column, in absence of grace notes. 0.0 means no extra space (accidentals are ignored)") -(elt-property-description 'between-system-string string? "string +(grob-property-description 'between-system-string string? "string to dump between two systems. Useful for forcing pagebreaks") -(elt-property-description 'bounded-by-me list? "list of spanners that have this -column as start/begin point. Only columns that have elements or act as bounds are spaced.") -(elt-property-description 'bracket-thick number? "") -(elt-property-description 'bracket-width number? "") -(elt-property-description 'break-align-symbol symbol? "the index in the spacing table (symbol) of the to be aligned item.") -(elt-property-description 'break-glyph-function procedure? "function taking glyph and break-direction, returning the glyph at a line break") -(elt-property-description 'breakable boolean? "boolean indicating if this is a breakable item (clef, barline, key sig, etc.)") -(elt-property-description 'c0-position integer? "integer indicating the position of central C") +(grob-property-description 'bounded-by-me list? "list of spanners that have this +column as start/begin point. Only columns that have grobs or act as bounds are spaced.") +(grob-property-description 'bracket-thick number? "") +(grob-property-description 'bracket-width number? "") +(grob-property-description 'break-align-symbol symbol? "the index in the spacing table (symbol) of the to be aligned item.") +(grob-property-description 'break-glyph-function procedure? "function taking glyph and break-direction, returning the glyph at a line break") +(grob-property-description 'breakable boolean? "boolean indicating if this is a breakable item (clef, barline, key sig, etc.)") +(grob-property-description 'c0-position integer? "integer indicating the position of central C") -(elt-property-description 'center-element ly-grob? "element which will +(grob-property-description 'center-element ly-grob? "grob which will be at the center of the group after aligning (when using Align_interface::center_on_element). ") -(elt-property-description 'collapse-height number? "") -(elt-property-description 'column-space-strength number? "relative strength of space following breakable columns (eg. prefatory matter)") -(elt-property-description 'columns list? "list of paper-columns") -(elt-property-description 'columns list? " list of note-columns.") -(elt-property-description 'columns list? "list of all paper columns") -(elt-property-description 'contains-grace boolean? "Used to widen entries for grace notes.") -(elt-property-description 'control-points list? "List of 4 offsets (number-pairs) controlling the tie shape") -(elt-property-description 'control-points list? "[internal] control points of bezier curve") -(elt-property-description 'damping integer? "amount of beam slope damping should beam slope be damped? 0: no, 1: yes, 100000: horizontal beams ") -(elt-property-description 'damping number? "damping factor.") -(elt-property-description 'dash-length number? "the length of a dash") -(elt-property-description 'dash-period number? "the length of one dash + white space") -(elt-property-description 'dashed number? "[FIXME: use dash-period/dash length; see text-spanner] number representing the length of the dashes.") -(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.") -(elt-property-description 'default-neutral-direction dir? "Where to go if we're in the middle of the staff") -(elt-property-description 'default-neutral-direction dir? "which +(grob-property-description 'collapse-height number? "") +(grob-property-description 'column-space-strength number? "relative strength of space following breakable columns (eg. prefatory matter)") +(grob-property-description 'columns list? "list of paper-columns") +(grob-property-description 'columns list? " list of note-columns.") +(grob-property-description 'columns list? "list of all paper columns") +(grob-property-description 'contains-grace boolean? "Used to widen entries for grace notes.") +(grob-property-description 'control-points list? "List of 4 offsets (number-pairs) controlling the tie shape") +(grob-property-description 'control-points list? "[internal] control points of bezier curve") +(grob-property-description 'damping integer? "amount of beam slope damping should beam slope be damped? 0: no, 1: yes, 100000: horizontal beams ") +(grob-property-description 'damping number? "damping factor.") +(grob-property-description 'dash-length number? "the length of a dash") +(grob-property-description 'dash-period number? "the length of one dash + white space") +(grob-property-description 'dashed number? "[FIXME: use dash-period/dash length; see text-spanner] number representing the length of the dashes.") +(grob-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.") +(grob-property-description 'default-neutral-direction dir? "Where to go if we're in the middle of the staff") +(grob-property-description 'default-neutral-direction dir? "which direction to choose if we're in the middle of the staff ") -(elt-property-description 'delta-y number? "amount of ascension") -(elt-property-description 'dependencies list? "list of score-element pointers that indicate who to compute first for certain global passes") -(elt-property-description 'details list? "alist of parameters for the curve shape") -(elt-property-description 'details list? "alist containing contaning a few magic constants.") -(elt-property-description 'dir-forced boolean? "set if direction has been forced; read by Beam.") -(elt-property-description 'dir-function procedure? "function of type (count total)->direction. Default value: beam-dir-majority, also available: beam-dir-mean, beam-dir-median.") -(elt-property-description 'dir-list list? "list of stem directions, needed for optical spacing correction.") -(elt-property-description 'direction dir? "up or down, left or right?") -(elt-property-description 'direction-source ly-grob? "in case side-relative-direction is set, which element to get the direction from ") -(elt-property-description 'dot ly-grob? "reference to Dots object.") -(elt-property-description 'dot-count integer? "number of dots") -(elt-property-description 'duration-log integer? "2-log of the notehead duration") -(elt-property-description 'duration-log integer? "log of the duration, ie. 0=whole note, 1 = half note, etc.") -(elt-property-description 'edge-height pair? "a cons that specifies the heights of the vertical egdes '(LEFT-height . RIGHT-height)") -(elt-property-description 'edge-text pair? "a cons that specifies the texts to be set at the edges '(LEFT-text . RIGHT-text)") -(elt-property-description 'elements list? " -- list of items.") -(elt-property-description 'elements list? "list of elements (NoteColumn, +(grob-property-description 'delta-y number? "amount of ascension") +(grob-property-description 'dependencies list? "list of score-grob pointers that indicate who to compute first for certain global passes") +(grob-property-description 'details list? "alist of parameters for the curve shape") +(grob-property-description 'details list? "alist containing contaning a few magic constants.") +(grob-property-description 'dir-forced boolean? "set if direction has been forced; read by Beam.") +(grob-property-description 'dir-function procedure? "function of type (count total)->direction. Default value: beam-dir-majority, also available: beam-dir-mean, beam-dir-median.") +(grob-property-description 'dir-list list? "list of stem directions, needed for optical spacing correction.") +(grob-property-description 'direction dir? "up or down, left or right?") +(grob-property-description 'direction-source ly-grob? "in case side-relative-direction is set, which grob to get the direction from ") +(grob-property-description 'dot ly-grob? "reference to Dots object.") +(grob-property-description 'dot-count integer? "number of dots") +(grob-property-description 'duration-log integer? "2-log of the notehead duration") +(grob-property-description 'duration-log integer? "log of the duration, ie. 0=whole note, 1 = half note, etc.") +(grob-property-description 'edge-height pair? "a cons that specifies the heights of the vertical egdes '(LEFT-height . RIGHT-height)") +(grob-property-description 'edge-text pair? "a cons that specifies the texts to be set at the edges '(LEFT-text . RIGHT-text)") +(grob-property-description 'elements list? " -- list of items.") +(grob-property-description 'elements list? "list of grobs (NoteColumn, generally) participating in the collision. The @code{rest-collision} property in @code{elements} is set to a pointer to the collision") -(elt-property-description 'elements list? "to be aligned elements ") -(elt-property-description 'expand-limit integer? "maximum number of measures expanded in church rests") -(elt-property-description 'extra-extent-X number-pair? "enlarge in X dimension by this much, measured in staff space") -(elt-property-description 'extra-extent-Y number-pair? "see @code{extra-extent-Y}") -(elt-property-description 'extra-offset number-pair? "pair of reals (a cons) forcing an extra offset before outputting") -(elt-property-description 'extra-space number-pair? "pair of distances") -(elt-property-description 'extra-space number-pair? "(cons LEFT RIGHT)") -(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.") +(grob-property-description 'elements list? "to be aligned grobs ") +(grob-property-description 'expand-limit integer? "maximum number of measures expanded in church rests") +(grob-property-description 'extra-extent-X number-pair? "enlarge in X dimension by this much, measured in staff space") +(grob-property-description 'extra-extent-Y number-pair? "see @code{extra-extent-Y}") +(grob-property-description 'extra-offset number-pair? "pair of reals (a cons) forcing an extra offset before outputting") +(grob-property-description 'extra-space number-pair? "pair of distances") +(grob-property-description 'extra-space number-pair? "(cons LEFT RIGHT)") +(grob-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.") -(elt-property-description 'extremity-rules list? "an alist (procedure +(grob-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.") -(elt-property-description 'flag-style string? "") -(elt-property-description 'flag-width-function procedure? "") -(elt-property-description 'font-family symbol? "partial font +(grob-property-description 'flag-style string? "") +(grob-property-description 'flag-width-function procedure? "") +(grob-property-description 'font-family symbol? "partial font definition: music roman braces dynamic math ...") -(elt-property-description 'font-name symbol? "partial font definition: +(grob-property-description 'font-name symbol? "partial font definition: base name of font file FIXME: should override other partials") -(elt-property-description 'font-point-size number? "partial font definition: exact font size in points FIXME: should override font-relative-size") -(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") -(elt-property-description 'font-relative-size integer? "") -(elt-property-description 'font-series symbol? "partial font definition: medium, bold") -(elt-property-description 'font-shape symbol? "partial font definition: upright or italic") +(grob-property-description 'font-point-size number? "partial font definition: exact font size in points FIXME: should override font-relative-size") +(grob-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") +(grob-property-description 'font-relative-size integer? "") +(grob-property-description 'font-series symbol? "partial font definition: medium, bold") +(grob-property-description 'font-shape symbol? "partial font definition: upright or italic") -(elt-property-description 'font-style symbol? "a precooked set of font +(grob-property-description 'font-style symbol? "a precooked set of font definitions, eg. finger volta timesig mark script large Large dynamic") -(elt-property-description 'force-hshift number? "amount of +(grob-property-description 'force-hshift number? "amount of collision_note_width that overides automatic collision settings. This is used by @ref{note-collision-interface}") -(elt-property-description 'fraction number-pair? "") -(elt-property-description 'full-size-change boolean? "if set, don't make a change clef smaller.") +(grob-property-description 'fraction number-pair? "") +(grob-property-description 'full-size-change boolean? "if set, don't make a change clef smaller.") -(elt-property-description 'glyph symbol? "a string determining what (style) of glyph is typeset. Valid choices depend on the function that is reading this property. ") -(elt-property-description 'gap number? "Size of a gap in a variable symbol") -(elt-property-description 'glyph-name string? "a name of character within font") +(grob-property-description 'glyph symbol? "a string determining what (style) of glyph is typeset. Valid choices depend on the function that is reading this property. ") +(grob-property-description 'gap number? "Size of a gap in a variable symbol") +(grob-property-description 'glyph-name string? "a name of character within font") -(elt-property-description 'grow-direction dir? "crescendo or decrescendo?") -(elt-property-description 'hair-thickness number? "thickness, measured in stafflinethickness") -(elt-property-description 'heads pair? "pair of element pointers, pointing to the two heads of the tie. ") -(elt-property-description 'heads list? "list of note heads") -(elt-property-description 'height number? "in staffspace ") -(elt-property-description 'height-quants procedure? "function of type (beam staff-line-thickness) -> list of quants. Default value: default-beam-dy-quants. +(grob-property-description 'grow-direction dir? "crescendo or decrescendo?") +(grob-property-description 'hair-thickness number? "thickness, measured in stafflinethickness") +(grob-property-description 'heads pair? "pair of grob pointers, pointing to the two heads of the tie. ") +(grob-property-description 'heads list? "list of note heads") +(grob-property-description 'height number? "in staffspace ") +(grob-property-description 'height-quants procedure? "function of type (beam staff-line-thickness) -> list of quants. Default value: default-beam-dy-quants. ") -(elt-property-description 'horizontal-shift integer? "integer that identifies ranking of note-column for horizontal shifting. This is used by @ref{note-collision-interface}") -(elt-property-description 'horizontal-space number? "amount of space to add after a note (in staff-space)") -(elt-property-description 'ideal-distances list? "(OBJ . (DIST . STRENGTH)) pairs") -(elt-property-description 'interfaces list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.") -(elt-property-description 'inversion list? " musical-pitch, optional") -(elt-property-description 'items-worth-living list? "list of interesting items. If empty in a particular system, clear that system.") -(elt-property-description 'kern number? "amount of extra white space to add before text. This is `relative'(?) to the current alignment.") -(elt-property-description 'kern number? "space after a thick line") -(elt-property-description 'left-padding number? "space left of accs") -(elt-property-description 'lengths list? "Stem length given multiplicity of flag") -(elt-property-description 'line-count integer? "Number of staff lines") -(elt-property-description 'line-thickness number? "the thickness[stafflinethickness] of the line") -(elt-property-description 'lookup symbol? "lookup method: 'value for plain text, 'name for character-name") -(elt-property-description 'magnify number? "the magnification factor. FIXME: doesn't work for feta fonts") -(elt-property-description 'maximum-duration-for-spacing moment? "space as if a duration of this type is available in this measure.") -(elt-property-description 'maximum-rest-count integer? "kill off rests so we don't more than this number left.") -(elt-property-description 'merge-differently-dotted boolean? " Merge noteheads in collisions, even if they have a different number of dots. This normal notation for some types of polyphonic music. The value of this setting is used by @ref{note-collision-interface} ") -(elt-property-description 'minimum-distance number? "minimum distance between notes and rests.") -(elt-property-description 'minimum-distances list? "list of rods (ie. (OBJ . DIST) pairs)") -(elt-property-description 'minimum-extent-X number-pair? "minimum size in X dimension, measured in staff space") -(elt-property-description 'minimum-extent-Y number-pair? "see @code{minimum-extent-Y}") -(elt-property-description 'minimum-length number? "minimum length in staffspace") +(grob-property-description 'horizontal-shift integer? "integer that identifies ranking of note-column for horizontal shifting. This is used by @ref{note-collision-interface}") +(grob-property-description 'horizontal-space number? "amount of space to add after a note (in staff-space)") +(grob-property-description 'ideal-distances list? "(OBJ . (DIST . STRENGTH)) pairs") +(grob-property-description 'interfaces list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.") +(grob-property-description 'inversion list? " musical-pitch, optional") +(grob-property-description 'items-worth-living list? "list of interesting items. If empty in a particular system, clear that system.") +(grob-property-description 'kern number? "amount of extra white space to add before text. This is `relative'(?) to the current alignment.") +(grob-property-description 'kern number? "space after a thick line") +(grob-property-description 'left-padding number? "space left of accs") +(grob-property-description 'lengths list? "Stem length given multiplicity of flag") +(grob-property-description 'line-count integer? "Number of staff lines") +(grob-property-description 'line-thickness number? "the thickness[stafflinethickness] of the line") +(grob-property-description 'lookup symbol? "lookup method: 'value for plain text, 'name for character-name") +(grob-property-description 'magnify number? "the magnification factor. FIXME: doesn't work for feta fonts") +(grob-property-description 'maximum-duration-for-spacing moment? "space as if a duration of this type is available in this measure.") +(grob-property-description 'maximum-rest-count integer? "kill off rests so we don't more than this number left.") +(grob-property-description 'merge-differently-dotted boolean? " Merge noteheads in collisions, even if they have a different number of dots. This normal notation for some types of polyphonic music. The value of this setting is used by @ref{note-collision-interface} ") +(grob-property-description 'minimum-distance number? "minimum distance between notes and rests.") +(grob-property-description 'minimum-distances list? "list of rods (ie. (OBJ . DIST) pairs)") +(grob-property-description 'minimum-extent-X number-pair? "minimum size in X dimension, measured in staff space") +(grob-property-description 'minimum-extent-Y number-pair? "see @code{minimum-extent-Y}") +(grob-property-description 'minimum-length number? "minimum length in staffspace") -(elt-property-description 'minimum-length number? "try to make the +(grob-property-description 'minimum-length number? "try to make the hyphens at least this long. Also works as a scaling parameter for the length") ;; FIXME. -(elt-property-description 'minimum-space number-pair? "(cons LEFT RIGHT)") -(elt-property-description 'minimum-space number? "minimum distance that the victim should move (after padding)") +(grob-property-description 'minimum-space number-pair? "(cons LEFT RIGHT)") +(grob-property-description 'minimum-space number? "minimum distance that the victim should move (after padding)") -(elt-property-description 'minimum-width number? "minimum-width of rest symbol, in staffspace") -(elt-property-description 'molecule-callback procedure? "Function taking graphical element as argument, returning a Scheme encoded Molecule.") -(elt-property-description 'new-accidentals list? "list of (pitch, accidental) pairs") -(elt-property-description 'no-spacing-rods boolean? "read from elements: boolean that makes Separation_item ignore this item (MOVE ME TO ITEM)") -(elt-property-description 'non-default boolean? "not set because of existence of a bar?") -(elt-property-description 'note-width 'number? "unit for horizontal translation, measured in staff-space.") -(elt-property-description 'number-gap number? "") -(elt-property-description 'old-accidentals list? "list of (pitch, accidental) pairs") -(elt-property-description 'origin ly-input-location? "location in input file of the definition") -(elt-property-description 'outer-stem-length-limit number? "catch +(grob-property-description 'minimum-width number? "minimum-width of rest symbol, in staffspace") +(grob-property-description 'molecule-callback procedure? "Function taking grob as argument, returning a Scheme encoded Molecule.") +(grob-property-description 'new-accidentals list? "list of (pitch, accidental) pairs") +(grob-property-description 'no-spacing-rods boolean? "read from grobs: boolean that makes Separation_item ignore this item (MOVE ME TO ITEM)") +(grob-property-description 'non-default boolean? "not set because of existence of a bar?") +(grob-property-description 'note-width 'number? "unit for horizontal translation, measured in staff-space.") +(grob-property-description 'number-gap number? "") +(grob-property-description 'old-accidentals list? "list of (pitch, accidental) pairs") +(grob-property-description 'origin ly-input-location? "location in input file of the definition") +(grob-property-description 'outer-stem-length-limit number? "catch suspect beam slopes, set slope to zero if outer stem is lengthened more than this (in staffspace)") -(elt-property-description 'padding number? "add this much extra space between objects that are next to each other") +(grob-property-description 'padding number? "add this much extra space between objects that are next to each other") -(elt-property-description 'parallel-beam boolean? "internal: true if there is a beam just as wide as the bracket ") -(elt-property-description 'pitches list? "list of musical-pitch") -(elt-property-description 'raise number? "height for text to be raised (a negative value lowers the text") -(elt-property-description 'right-padding number? "space right of accs") -(elt-property-description 'right-trim-amount number? "") -(elt-property-description 'script-priority number? "A sorting key that determines in what order a script is within a stack of scripts") -(elt-property-description 'self-alignment-X number? "real number: -1 = +(grob-property-description 'parallel-beam boolean? "internal: true if there is a beam just as wide as the bracket ") +(grob-property-description 'pitches list? "list of musical-pitch") +(grob-property-description 'raise number? "height for text to be raised (a negative value lowers the text") +(grob-property-description 'right-padding number? "space right of accs") +(grob-property-description 'right-trim-amount number? "") +(grob-property-description 'script-priority number? "A sorting key that determines in what order a script is within a stack of scripts") +(grob-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. -In this case, the center element should have this object as a + Set to an grob pointer, if you want that grob to be the center. +In this case, the center grob should have this object as a reference point. ") -(elt-property-description 'self-alignment-Y number? "like self-alignment-X but for Y axis") -(elt-property-description 'shortest-playing-duration moment? "duration of the shortest playing in that column.") -(elt-property-description 'shortest-starter-duration moment? "duration of the shortest notes that starts exactly in this column.") -(elt-property-description 'side-relative-direction dir? "if set: get the direction from a different object, and multiply by this.") -(elt-property-description 'side-support list? "the support, a list of score elements") -(elt-property-description 'slope-limit number? "set slope to zero if slope is running away steeper than this.") -(elt-property-description 'space-function procedure? "function of type multiplicity -> real (in staffspace)") -(elt-property-description 'spacing-procedure procedure? "procedure -taking graphical element as argument. This is called after +(grob-property-description 'self-alignment-Y number? "like self-alignment-X but for Y axis") +(grob-property-description 'shortest-playing-duration moment? "duration of the shortest playing in that column.") +(grob-property-description 'shortest-starter-duration moment? "duration of the shortest notes that starts exactly in this column.") +(grob-property-description 'side-relative-direction dir? "if set: get the direction from a different object, and multiply by this.") +(grob-property-description 'side-support list? "the support, a list of grobs") +(grob-property-description 'slope-limit number? "set slope to zero if slope is running away steeper than this.") +(grob-property-description 'space-function procedure? "function of type multiplicity -> real (in staffspace)") +(grob-property-description 'spacing-procedure procedure? "procedure +taking grob as argument. This is called after before-line-breaking-callback, but before the actual line breaking itself. Return value is ignored") -(elt-property-description 'stacking-dir dir? "stack contents of elements in which direction ?") -(elt-property-description 'staff-space number? "Amount of line leading relative to global staffspace") -(elt-property-description 'staffline-clearance number? "don't get closer than this to stafflines.") -(elt-property-description 'stem ly-grob? "pointer to the stem object.") -(elt-property-description 'stem ly-grob? "pointer to Stem object") -(elt-property-description 'stem-centered boolean? "Center stems on note heads. Useful for mensural notation") -(elt-property-description 'stem-end-position number? "Where does the stem end (the end is opposite to the support-head") -(elt-property-description 'stem-length number? "length of stem") -(elt-property-description 'stem-shorten list? "shorten stems in forced directions given flag multiplicity") -(elt-property-description 'stem-spacing-correction number? "optical correction amount.") -(elt-property-description 'stems list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.") -(elt-property-description 'stretch-distance number-pair? "pair of distances") -(elt-property-description 'style symbol? "a string determining what style of glyph is typeset. Valid choices depend on the function that is reading this property. ") -(elt-property-description 'support-head ly-grob? "the note head at +(grob-property-description 'stacking-dir dir? "stack contents of grobs in which direction ?") +(grob-property-description 'staff-space number? "Amount of line leading relative to global staffspace") +(grob-property-description 'staffline-clearance number? "don't get closer than this to stafflines.") +(grob-property-description 'stem ly-grob? "pointer to the stem object.") +(grob-property-description 'stem ly-grob? "pointer to Stem object") +(grob-property-description 'stem-centered boolean? "Center stems on note heads. Useful for mensural notation") +(grob-property-description 'stem-end-position number? "Where does the stem end (the end is opposite to the support-head") +(grob-property-description 'stem-length number? "length of stem") +(grob-property-description 'stem-shorten list? "shorten stems in forced directions given flag multiplicity") +(grob-property-description 'stem-spacing-correction number? "optical correction amount.") +(grob-property-description 'stems list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.") +(grob-property-description 'stretch-distance number-pair? "pair of distances") +(grob-property-description 'style symbol? "a string determining what style of glyph is typeset. Valid choices depend on the function that is reading this property. ") +(grob-property-description 'support-head ly-grob? "the note head at one end of the stem") -(elt-property-description 'text markup? " +(grob-property-description 'text markup? " Scheme markup text. It is defined as follows: @example @@ -252,8 +252,8 @@ ABBREV: rows lines roman music bold italic named super sub text, or any font-sty @end example So, TEXT is either a string, or a list of which the CAR is a MARKUP. -MARKUP is either a CONS: an element property '(key . value) or a symbol: -a predefined abbreviation for a list of element properties. +MARKUP is either a CONS: an grob property '(key . value) or a symbol: +a predefined abbreviation for a list of grob properties. The following abbreviations are currently defined: @@ -282,30 +282,30 @@ horizontal mode: set all text on one line (default) finger volta timesig mmrest mark script large Large dynamic @end table ") -(elt-property-description 'thick number? "thickness, in stafflinethickness") -(elt-property-description 'thick-thickness number? "thickness, measured in stafflinethickness") -(elt-property-description 'thickness number? "thickness, measured in stafflinethickness") -(elt-property-description 'thin-kern number? "space after a hair-line") -(elt-property-description 'forced-distance number? "forced distance for an alignment") -(elt-property-description 'threshold number-pair? "(cons MIN MAX), where MIN and MAX are dimensions in staffspace") -(elt-property-description 'transparent boolean? "This is almost the +(grob-property-description 'thick number? "thickness, in stafflinethickness") +(grob-property-description 'thick-thickness number? "thickness, measured in stafflinethickness") +(grob-property-description 'thickness number? "thickness, measured in stafflinethickness") +(grob-property-description 'thin-kern number? "space after a hair-line") +(grob-property-description 'forced-distance number? "forced distance for an alignment") +(grob-property-description 'threshold number-pair? "(cons MIN MAX), where MIN and MAX are dimensions in staffspace") +(grob-property-description 'transparent boolean? "This is almost the same as setting molecule-callback to #f, but this retains the -dimensions of this element, which means that you can erase elements +dimensions of this grob, which means that you can erase grobs individually. ") -(elt-property-description 'tuplet-bracket-visibility boolean-or-symbol? " +(grob-property-description 'tuplet-bracket-visibility boolean-or-symbol? " This controls the visibility of the tuplet bracket. Setting it to false will prevent printing of the bracket. Setting the property to #'if-no-beam will make it print only if there is no beam associated with this tuplet bracket.") -(elt-property-description 'tuplet-number-visibility boolean-or-symbol? " +(grob-property-description 'tuplet-number-visibility boolean-or-symbol? " Like @code{tuplet-bracket-visibility}, but for the number.") -(elt-property-description 'type symbol? "one of: line, dashed-line or dotted-line") -(elt-property-description 'vertical-position-quant-function procedure? " +(grob-property-description 'type symbol? "one of: line, dashed-line or dotted-line") +(grob-property-description 'vertical-position-quant-function procedure? " function of type (beam multiplicity dy staff-line-thickness) -> real. Default value: default-beam-y-quants, also available: beam-traditional-y-quants. ") -(elt-property-description 'visibility-lambda procedure? "a function that takes the break direction and returns a cons of booleans containing (TRANSPARENT . EMPTY)") -(elt-property-description 'when moment? "when does this column happen?") -(elt-property-description 'word-space number? "elongate left by this much (FIXME: cumbersome semantics)") -(elt-property-description 'x-gap number? "horizontal gap between notehead and tie") -(elt-property-description 'y-free number? "minimal vertical gap between slur and noteheads or stems") -(elt-property-description 'y-position number? "position of left edge") +(grob-property-description 'visibility-lambda procedure? "a function that takes the break direction and returns a cons of booleans containing (TRANSPARENT . EMPTY)") +(grob-property-description 'when moment? "when does this column happen?") +(grob-property-description 'word-space number? "elongate left by this much (FIXME: cumbersome semantics)") +(grob-property-description 'x-gap number? "horizontal gap between notehead and tie") +(grob-property-description 'y-free number? "minimal vertical gap between slur and noteheads or stems") +(grob-property-description 'y-position number? "position of left edge") diff --git a/scm/documentation-lib.scm b/scm/documentation-lib.scm index 2d24e64165..0593eac0a9 100644 --- a/scm/documentation-lib.scm +++ b/scm/documentation-lib.scm @@ -133,8 +133,8 @@ Add a ref if REF is set (define (engraver-name name) name) -(define (element-name name) - (string-append "Element " name)) +(define (grob-name name) + (string-append "Grob " name)) (define (interface-name name) name) diff --git a/scm/engraver-documentation-lib.scm b/scm/engraver-documentation-lib.scm index aaddcb2ee7..e886d6fb64 100644 --- a/scm/engraver-documentation-lib.scm +++ b/scm/engraver-documentation-lib.scm @@ -43,8 +43,8 @@ "" (string-append "This engraver creates \n " - (human-listify (map reffy (map element-name objs))) - " elements.") + (human-listify (map reffy (map grob-name objs))) + " grobs.") ) "\n\n" diff --git a/scm/generate-documentation.scm b/scm/generate-documentation.scm index 6ad3c5246a..0234671732 100644 --- a/scm/generate-documentation.scm +++ b/scm/generate-documentation.scm @@ -33,7 +33,7 @@ (document-paper "LilyPond interpretation contexts") (document-all-engravers "LilyPond engravers") (document-all-engraver-properties "LilyPond context properties") - (document-all-elements "LilyPond backend") + (document-all-grobs "LilyPond backend") (document-all-interfaces "LilyPond interfaces") (document-all-backend-properties "LilyPond backend properties") ) @@ -50,11 +50,11 @@ ;; we can't use (dir) and top if we're included by lilypond.tely "LilyPond internals" name "(lilypond.info)" '(("LilyPond interpretation contexts" . "Hierarchy and grouping of Engravers") - ("LilyPond engravers" . "Engravers create Elements") + ("LilyPond engravers" . "Engravers create Grobs") ("LilyPond context properties" . "context properties") - ("LilyPond backend" . "Detailed description of all Elements") - ("LilyPond interfaces" . "Element Interfaces") - ("LilyPond backend properties" . "Element properties"))) + ("LilyPond backend" . "Detailed description of all Grobs") + ("LilyPond interfaces" . "Grob Interfaces") + ("LilyPond backend properties" . "Grob properties"))) diff --git a/scm/interface.scm b/scm/interface.scm index 91209c9db6..565ef7d959 100644 --- a/scm/interface.scm +++ b/scm/interface.scm @@ -17,8 +17,8 @@ ) -(define (element-description name . interfaces) - (let* ((ifs (cons general-element-interface interfaces)) +(define (grob-description name . interfaces) + (let* ((ifs (cons general-grob-interface interfaces)) (props (map caddr ifs)) ; (prop-typep-pairs (map (lambda (x) (cons (car x) (cadr x))) ; (apply append props))) @@ -29,14 +29,14 @@ (cons 'interfaces syms) (cons 'interface-descriptions ifs) ; (cons 'interface-descriptions (cadr merged)) - ;; description of the element itself? + ;; description of the grob itself? ; (cons 'properties prop-typep-pairs) ))) -(define general-element-interface +(define general-grob-interface (lily-interface - 'general-element-interface - "All elements support this" + 'general-grob-interface + "All grobs support this" '( X-offset-callbacks Y-offset-callbacks @@ -94,7 +94,7 @@ (define axis-group-interface (lily-interface 'axis-group-interface - "a group of coupled elements" + "a group of coupled grobs" '( axes ))) @@ -189,11 +189,11 @@ (define line-of-score-interface (lily-interface 'line-of-score-interface - "Super element, parent of all: + "Super grob, parent of all: -The columns of a score that form one line. The toplevel element. Any -element has a Line_of_score as both X and Y reference point. The -Paper_score contains one element of this type. Control enters the +The columns of a score that form one line. The toplevel grob. Any +grob has a Line_of_score as both X and Y reference point. The +Paper_score contains one grob of this type. Control enters the Grob dependency calculation from this single Line_of_score object." '( @@ -260,7 +260,7 @@ object." (define align-interface (lily-interface 'align-interface - " Order elements top to bottom/left to right/right to left etc." + " Order grobs top to bottom/left to right/right to left etc." '( stacking-dir align-dir @@ -440,7 +440,7 @@ font-point-size font-relative-size) (define separation-spanner-interface (lily-interface 'separation-spanner-interface - "Spanner that containing @code{separation-item-interface} elements to calculate rods" + "Spanner that containing @code{separation-item-interface} grobs to calculate rods" '() )) (define text-script-interface @@ -554,7 +554,7 @@ contains-grace extra-space stretch-distance )) (define spaceable-element-interface (lily-interface 'spaceable-element-interface - "An element (generally a Paper_column) that takes part in the + "An grob (generally a Paper_column) that takes part in the spacing problem. " '( minimum-distances @@ -667,7 +667,7 @@ position 0." "Item that computes widths to generate spacing rods. Calc dimensions for the Separating_group_spanner; this has to be - an item to get dependencies correct. It can't be an element_group + an item to get dependencies correct. It can't be an grob_group since these usually are in a different X_group " '( diff --git a/scm/lily.scm b/scm/lily.scm index 228c6d3a78..060b82bb28 100644 --- a/scm/lily.scm +++ b/scm/lily.scm @@ -39,7 +39,7 @@ ((dir? obj) "direction") ((number-pair? obj) "pair of numbers") ((ly-input-location? obj) "input location") - ((ly-grob? obj) "graphic element") + ((ly-grob? obj) "grob (GRaphical OBject)") ((pair? obj) "pair") ((integer? obj) "integer") ((list? obj) "list") @@ -62,7 +62,7 @@ ((eq? predicate dir?) "direction") ((eq? predicate number-pair?) "pair of numbers") ((eq? predicate ly-input-location?) "input location") - ((eq? predicate ly-grob?) "graphic element") + ((eq? predicate ly-grob?) "Grob") ((eq? predicate pair?) "pair") ((eq? predicate integer?) "integer") ((eq? predicate list?) "list") diff --git a/scm/translator-properties.scm b/scm/translator-properties.scm index 751081619a..d2513d0a37 100644 --- a/scm/translator-properties.scm +++ b/scm/translator-properties.scm @@ -60,7 +60,17 @@ The head of the list: ) @end example") -(translator-property-description 'automaticPhrasing boolean? "") +(translator-property-description 'automaticPhrasing boolean? " If set, +the @ref{Lyric_phrasing_engraver} will match note heads of context +called Voice X to syllables from LyricsVoice called +X-. This feature is turned on by default. See the example +file @file{lyrics-multi-stanza.ly}. + +") +(translator-property-description 'automaticMelismata boolean? " If +set, \addlyrics will assume that beams, slurs and ties signal +melismata, and align lyrics accordingly. +") (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note. ") (translator-property-description 'barCheckNoSynchronize boolean? "If set, don't reset measurePosition when finding a bbarcheck. This @@ -191,8 +201,8 @@ r1 r1*3 R1*3property Score.skipBars=1 r1*3 R1*3 @end example ") -(translator-property-description 'slurBeginAttachment symbol? "translates to the car of Slur.element-property 'attachment.") -(translator-property-description 'slurEndAttachment symbol? "translates to the cdr of Slur.element-property 'attachment.") +(translator-property-description 'slurBeginAttachment symbol? "translates to the car of grob-property 'attachment.") +(translator-property-description 'slurEndAttachment symbol? "translates to the cdr of grob-property 'attachment.") (translator-property-description 'slurMelismaBusy boolean? "") (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set") (translator-property-description 'solo boolean? "set if solo is detected") @@ -234,7 +244,7 @@ Switch off for cadenzas.") If set to true, tuplet bracket creation is switched off entirely. This has the same effect as setting both @code{tupletNumberVisibility} and @code{tupletBracketVisibility} to -@code{#f}, but as this does not even create elements, this setting +@code{#f}, but as this does not even create any grobs, this setting uses less memory and time.") (translator-property-description 'tupletSpannerDuration moment? " Normally a tuplet bracket is as wide as the -- 2.39.5