[ << Tabelle del manuale della notazione ] | [Top][Contents][Index] | [ Schema riassuntivo >> ] |
[ < LilyPond exported predicates ] | [ Up : Tabelle del manuale della notazione ] | [ Schema riassuntivo > ] |
A.22 Funzioni Scheme
- Function: add-bar-glyph-print-procedure glyph proc
Specify the single glyph glyph that calls print procedure proc. The procedure proc has to be defined in the form
(make-...-bar-line grob extent)
even if the extent is not used within the routine.
- Function: ly:add-context-mod contextmods modification
Adds the given context modification to the list contextmods of context modifications.
- Function: ly:add-interface iface desc props
Add a new grob interface. iface is the interface name, desc is the interface description, and props is the list of user-settable properties for the interface.
- Function: ly:add-listener callback disp cl
Add the single-argument procedure callback as listener to the dispatcher disp. Whenever disp hears an event of class cl, it calls callback with it.
- Function: add-music-fonts node family name brace design-size-alist factor
Set up music fonts.
Arguments:
- node is the font tree to modify.
- family is the family name of the music font.
- name is the basename for the music font. ‘name-<designsize>.otf’ should be the music font,
- brace is the basename for the brace font. ‘brace-brace.otf’ should have piano braces.
-
design-size-alist is a list of
(rounded . designsize)
.rounded
is a suffix for font filenames, whiledesignsize
should be the actual design size. The latter is used for text fonts loaded through pango/fontconfig. - factor is a size factor relative to the default size that is being used. This is used to select the proper design size for the text fonts.
- Function: add-new-clef clef-name clef-glyph clef-position transposition c0-position
Append the entries for a clef symbol to supported clefs and
c0-pitch-alist
.
- Function: ly:add-option sym val description
Add a program option sym. val is the default value and description is a string description.
- Function: add-simple-time-signature-style style proc
Specify the procedure
proc
returning markup for a time signature style style. The procedure is called with one argument, the pair(numerator . denominator)
.
- Function: add-stroke-glyph stencil grob dir stroke-style flag-style
Load and add a stroke (represented by a glyph in the font) to the given flag stencil.
- Function: add-stroke-straight stencil grob dir log stroke-style offset length thickness stroke-thickness
Add the stroke for acciaccatura to the given flag stencil. The stroke starts for up-flags at ‘upper-end-of-flag + (0,length/2)’ and ends at ‘(0, vertical-center-of-flag-end) - (flag-x-width/2, flag-x-width + flag-thickness)’. Here ‘length’ is the whole length, while ‘flag-x-width’ is just the x-extent and thus depends on the angle! Other combinations don’t look as good.
For down-stems the y-coordinates are simply mirrored.
- Function: ly:all-output-backend-commands
Return the list of extra output backend commands that are used internally in ‘lily/stencil-interpret.cc’.
- Function: ly:all-stencil-commands
Return the list of stencil commands that can be defined in the output modules (‘output-*.scm’).
- Function: allow-volta-hook bar-glyph
Allow the volta bracket hook being drawn over bar line bar-glyph.
- Function: ly:angle x y
Calculates angle in degrees of given vector. With one argument, x is a number pair indicating the vector. With two arguments, x and y specify the respective coordinates.
- Function: arrow-stencil x y thick staff-space grob
Returns a right-pointing, filled arrow-head, where x determines the basic horizontal position and y determines the basic vertical position. Both values are adjusted using staff-space, which is
StaffSymbol
’s staff space. thick is the used line thickness.
- Function: arrow-stencil-maker start? end?
Return a function drawing a line from current point to
destination
, with optional arrows ofmax-size
on start and end controlled by start? and end?.
- Function: ly:assoc-get key alist default-value strict-checking
Return value if key in alist, else default-value (or
#f
if not specified). If strict-checking is set to#t
and key is not in alist, a programming_error is output.
- Function: ly:axis-group-interface::add-element grob grob-element
Set grob the parent of grob-element on all axes of grob.
- Function: ly:bar-line::calc-anchor grob
Calculate the anchor position of a bar line. The anchor is used for the correct placement of bar numbers etc.
- Function: bar-line::calc-break-visibility grob
Calculate the visibility of a bar line at line breaks.
- Function: bar-line::calc-glyph-name grob
Determine the
glyph-name
of the bar line depending on the line break status.
- Function: bar-line::calc-glyph-name-for-direction glyph dir
Determine the
glyph-name
of the bar line depending on the line break status.
- Function: bar-line::draw-filled-box x-ext y-ext thickness extent grob
Return a straight bar-line created by
ly:round-filled-box
looking at x-ext, y-ext, thickness. The blot is calculated bybar-line::calc-blot
, which needs extent and grob. y-ext is not necessarily of same value as extent.
- Function: bar-line::widen-bar-extent-on-span grob extent
Widens the bar line extent towards span bars adjacent to grob grob.
- Function: base-length time-signature time-signature-settings
Get
baseMoment
rational value for time-signature from time-signature-settings.
- Function: ly:basic-progress str rest
A Scheme callable function to issue a basic progress message str. The message is formatted with
format
and rest.
- Function: beam-exceptions time-signature time-signature-settings
Get
beamExceptions
value for time-signature from time-signature-settings.
- Function: beat-structure base-length time-signature time-signature-settings
Get
beatStructure
value in base-length units for time-signature from time-signature-settings.
- Function: bend::arrow-head-stencil thickness x-y-coords height width dir
Returns an arrow head stencil. Calculated from the given dimensions height and width, translated to x-y-coords, the end of the bend-spanners (curved) line.
- Function: bend::calc-bend-x-begin bend-spanner bounding-noteheads factor quarter-tone-diffs
Calculates the starting values in X-direction of the bend. After a line break, the values from the right bound are taken minus 1.5 staff-spaces. For bends-down or if grob-property
'style
equals to'pre-bend
,'hold
or'pre-bend-hold
,interval-center
is applied the topmost note head of the starting note heads. In any other case the right edge of the starting note head is used. The value ofBendSpanner.details.horizontal-left-padding
is added, which may be changed by an appropriate override. Returns a list of the same length as the amount of bend-starting note heads.
- Function: bend::calc-bend-x-end bend-spanner top-left-tab-nhd top-right-tab-nhd
Calculates the ending X-coordinate of bend-spanner. At the line end take the items of
BreakAlignGroup
into account and a little padding. Ends an unbroken spanner or the last of a broken one in the middle of the topmost note head of its bounding note column.
- Function: bend::target-cautionary spanner
Sets
'display-cautionary
of all relevant note heads of spanners right bound to true. As a result they appear parenthesized. This procedure is the default value of'before-line-breaking
.
- Function: bend::text-string spanner
Takes a spanner-grob, calculates a list with the quarter tone diffs between the pitches of starting and ending bound. Because bending to different amounts is very unlikely, only the first element of this list is returned as a string.
- Function: bend-spanner::print grob
Returns the final stencil. A line and curve, arrow head and a text representing the amount a string is bent.
- Function: ly:book-process book-smob default-paper default-layout output
Print book. output is passed to the backend unchanged. For example, it may be a string (for file based outputs) or a socket (for network based output).
- Function: ly:book-process-to-systems book-smob default-paper default-layout output
Print book. output is passed to the backend unchanged. For example, it may be a string (for file based outputs) or a socket (for network based output).
- Function: box-grob-stencil grob
Make a box of exactly the extents of the grob. The box precisely encloses the contents.
- Function: ly:bracket a iv t p
Make a bracket in direction a. The extent of the bracket is given by iv. The wings protrude by an amount of p, which may be negative. The thickness is given by t.
- Function: bracketify-stencil stil axis thick protrusion padding
Add brackets around stil, producing a new stencil.
- Function: break-alignable-interface::self-alignment-of-anchor g
Return a value for g’s
self-alignment-X
that will place g on the same side of the reference point defined by abreak-aligned
item such as aClef
.
- Function: break-alignable-interface::self-alignment-opposite-of-anchor g
Return a value for g’s
self-alignment-X
that will place g on the opposite side of the reference point defined by abreak-aligned
item such as aClef
.
- Function: break-alignment-list end-of-line middle begin-of-line
Return a callback that calculates a value based on a grob’s break direction.
- Function: calc-harmonic-pitch pitch music
Calculate the harmonic pitches in music given pitch as the non-harmonic pitch.
- Function: centered-text-interface::print grob
Print some text between two non-musical columns according to the
spacing-pair
property.
- Function: ly:chain-assoc-get key achain default-value strict-checking
Return value for key from a list of alists achain. If no entry is found, return default-value or
#f
if default-value is not specified. With strict-checking set to#t
, a programming_error is output in such cases.
- Function: change-pitches music converter
Recurse through music, applying converter to pitches. Converter is typically a transposer or an inverter as defined above in this module, but may be user-defined. The converter function must take a single pitch as its argument and return a new pitch. These are LilyPond scheme pitches, e.g.
(ly:make-pitch 0 2 0)
- Function: check-context-path path . lambda*:G59
Check a context property path specification path, a symbol list (or a single symbol), for validity and possibly complete it. Returns the completed specification, or
#f
when rising an error (using optionallylocation
).
- Function: ly:check-expected-warnings
Check whether all expected warnings have really been triggered.
- Function: check-grob-path path . rest
Check a grob path specification path, a symbol list (or a single symbol), for validity and possibly complete it. Returns the completed specification, or
#f
if invalid. If optional parser is given, a syntax error is raised in that case, optionally using location. If an optional keyword argument#:start start
is given, the parsing starts at the given index in the sequence ‘Context.Grob.property.sub-property...’, with the default of ‘0’ implying the full path.If there is no valid first element of path fitting at the given path location, an optionally given
#:default default
is used as the respective element instead without checking it for validity at this position.The resulting path after possibly prepending default can be constrained in length by optional arguments
#:min min
and#:max max
, defaulting to ‘1’ and unlimited, respectively.
- Function: check-music-path path . rest
Check a music property path specification path, a symbol list (or a single symbol), for validity and possibly complete it. Returns the completed specification, or
#f
when rising an error (using optionallylocation
).
- Function: circle-stencil stencil thickness padding
Add a circle around stencil, producing a new stencil.
- Function: clef-transposition-markup oct style
The transposition sign formatting function. oct is supposed to be a string holding the transposition number, style determines the way the transposition number is displayed.
- Function: collect-music-aux score-handler music
Pass music to score-handler, with preprocessing for page layout instructions.
- Function: constante-hairpin grob
Create hairpin based on a list of coords in
(cons x y)
form.x
is the portion of the width consumed for a given line andy
is the portion of the height. For example,'((0 . 0) (0.3 . 0.7) (0.8 . 0.9) (1.0 . 1.0))
means that at the point where the hairpin has consumed 30% of its width, it must be at 70% of its height. Once it is to 80% width, it must be at 90% height. It finishes at 100% width and 100% height. If coords does not begin with'(0 . 0)
the final hairpin may have an open tip. For example ’(0 . 0.5) will cause an open end of 50% of the usual height. mirrored? indicates if the hairpin is mirrored over the Y-axis or if just the upper part is drawn. Returns a function that accepts a hairpin grob as an argument and draws the stencil based on its coordinates.#(define simple-hairpin (elbowed-hairpin '((0 . 0)(1.0 . 1.0)) #t)) \relative c' { \override Hairpin #'stencil = #simple-hairpin a\p\< a a a\f }
- Function: construct-chord-elements root duration modifications
Build a chord on root using modifiers in modifications.
NoteEvents
have duration duration.Notes: Natural 11 is left from chord if not explicitly specified.
Entry point for the parser.
- Function: ly:context-def-lookup def sym val
Return the value of sym in context definition def (e.g.,
\Voice
). If no value is found, return val or'()
if val is undefined. sym can be any of ‘default-child’, ‘consists’, ‘description’, ‘aliases’, ‘accepts’, ‘property-ops’, ‘context-name’, ‘group-type’.
- Function: ly:context-def-modify def mod
Return the result of applying the context-mod mod to the context definition def. Does not change def.
- Function: ly:context-events-below context
Return a
stream-distributor
that distributes all events from context and all its subcontexts.
- Function: ly:context-find context name
Find a parent of context that has name or alias name. Return
#f
if not found.
- Function: ly:context-grob-definition context name
Return the definition of name (a symbol) within context as an alist.
- Function: ly:context-id context
Return the ID string of context, i.e., for
\context Voice = "one" …
return the stringone
.
- Function: ly:context-matched-pop-property context grob cell
This undoes a particular
\override
,\once \override
or\once \revert
when given the specific alist pair to undo.
- Function: ly:context-name context
Return the name of context, i.e., for
\context Voice = "one" …
return the symbolVoice
.
- Function: ly:context-property context sym def
Return the value for property sym in context. If def is given, and property value is
'()
, return def.
- Function: ly:context-property-where-defined context name
Return the context above context where name is defined.
- Function: ly:context-pushpop-property context grob eltprop val
Do
\temporary \override
or\revert
operation in context. The grob definition grob is extended with eltprop (if val is specified) or reverted (if unspecified).
- Function: ly:context-set-property! context name val
Set value of property name in context context to val.
- Function: copy-repeat-chord original-chord repeat-chord duration event-types
Copies all events in event-types (be sure to include
rhythmic-events
) from original-chord over to repeat-chord with their articulations filtered as well. Any duration is replaced with the specified duration.
- Function: create-glyph-flag flag-style dir-modifier grob
Create a flag stencil by looking up the glyph from the font.
- Function: cross-staff-connect stem
Set cross-staff property of the stem to this function to connect it to other stems automatically
- Function: css->colorlist code
Turn a CSS-like color string into an
rgb-color
list. The given string may be either a predefined color name or a hexadecimal color code, in which case it must be prefixed with ‘#’ and entered between double quotes. Alpha channel information is supported (as eight-character color codes, or four chars in shorthand mode), and will be passed to the output backend – that may or may not use it.
- Function: ly:debug str rest
A Scheme callable function to issue a debug message str. The message is formatted with
format
and rest.
- Function: default-flag grob
Create a flag stencil for the stem. Its style will be derived from the
'style
Flag property. By default,lilypond
uses a C++ Function (which is slightly faster) to do exactly the same as this function. However, if one wants to modify the default flags, this function can be used to obtain the default flag stencil, which can then be modified at will. The correct way to do this is:\override Flag #'stencil = #default-flag \override Flag #'style = #'mensural
- Function: define-bar-line bar-glyph eol-glyph bol-glyph span-glyph
Define a bar glyph bar-glyph and its substitute at the end of a line (eol-glyph), at the beginning of a new line (bol-glyph) and as a span bar (span-glyph) respectively.
- Function: define-event-class class parent
Defines a new event
class
derived fromparent
, a previously defined event class.
- Function: define-fonts paper define-font define-pango-pf
Return a string of all fonts used in paper, invoking the functions define-font and define-pango-pf for producing the actual font definition.
- Function: define-tag-group tags
Define a tag-group consisting of the given tags, a list of symbols. Returns
#f
if successful, and an error message if there is a conflicting tag group definition.
- Function: determine-split-list evl1 evl2 chord-range
evl1 and evl2 should be ascending. chord-range is a pair of numbers (min . max) defining the distance in steps between notes that may be combined into a chord or unison.
- Function: determine-string-fret-finger context notes specified-info rest
Determine string numbers and frets for playing notes as a chord, given specified information specified-info. specified-info is a list with two list elements, specified strings
defined-strings
and specified fingeringsdefined-fingers
. Only a fingering of 0 will affect the fret selection, as it specifies an open string. Ifdefined-strings
is'()
, the context propertydefaultStrings
will be used as a list of defined strings. Will look for predefined fretboards ifpredefinedFretboardTable
is not#f
. If rest is present, it contains theFretBoard
grob, and a fretboard will be created. Otherwise, a list of(string fret finger)
lists will be returned. If the context-propertysupportNonIntegerFret
is set#t
, micro-tones are supported for TabStaff, but not not for FretBoards.
- Function: ly:dimension? d
Is d a dimension? Used to distinguish length variables from normal numbers.
- Function: ly:dir? s
Is s a direction? Valid directions are
-1
,0
, or1
, where-1
represents left or down,1
represents right or up, and0
represents a neutral direction.
- Function: ly:directed direction magnitude
Calculates an
(x . y)
pair with optional magnitude (defaulting to1.0
) and direction specified either as an angle in degrees or a coordinate pair giving the direction. If magnitude is a pair, the respective coordinates are scaled independently, useful for ellipse drawings.
- Function: display-music music . lambda*:G40
Display music, not done with
music-map
for clarity of presentation.
- Function: display-scheme-music obj . lambda*:G42
Displays ‘obj’, typically a music expression, in a friendly fashion, which often can be read back in order to generate an equivalent expression.
- Function: dodecaphonic-no-repeat-rule context pitch barnum measurepos
An accidental rule that typesets an accidental before every note (just as in the dodecaphonic accidental style) except if the note is immediately preceded by a note with the same pitch. This is a common accidental style in contemporary notation.
- Function: duration-dot-factor dotcount
Given a count of the dots used to extend a musical duration, return the numeric factor by which they increase the duration.
- Function: duration-length dur
Return the overall length of a duration, as a number of whole notes. (Not to be confused with ly:duration-length, which returns a less-useful moment object.)
- Function: duration-line::calc grob
Return list of values needed to print a stencil for
DurationLine
.
- Function: duration-log-factor lognum
Given a logarithmic duration number, return the length of the duration, as a number of whole notes.
- Function: duration-visual dur
Given a duration object, return the visual part of the duration (base note length and dot count), in the form of a duration object with non-visual scale factor 1.
- Function: duration-visual-length dur
Given a duration object, return the length of the visual part of the duration (base note length and dot count), as a number of whole notes.
- Function: dynamic-text-spanner::before-line-breaking grob
Monitor left bound of
DynamicTextSpanner
for absolute dynamics. If found, ensureDynamicText
does not collide with spanner text by changing'attach-dir
and'padding
. Reads the'right-padding
property ofDynamicText
to fine tune space between the two text elements.
- Function: ellipse-stencil stencil thickness x-padding y-padding
Add an ellipse around stencil, padded by the padding pair, producing a new stencil.
- Function: ly:encode-string-for-pdf str
Encode the given string to either Latin1 (which is a subset of the PDFDocEncoding) or if that’s not possible to full UTF-16BE with Byte-Order-Mark (BOM).
- Function: ly:engraver-announce-end-grob engraver grob cause
Announce the end of a grob (i.e., the end of a spanner) originating from given engraver instance, with grob being a grob. cause should either be another grob or a music event.
- Function: ly:engraver-make-grob engraver grob-name cause
Create a grob originating from given engraver instance, with given grob-name, a symbol. cause should either be another grob or a music event.
- Function: ly:error str rest
A Scheme callable function to issue the error str. The error is formatted with
format
and rest.
- Function: eval-carefully symbol module . default
Check whether all symbols in expr symbol are reachable in module module. In that case evaluate, otherwise print a warning and set an optional default.
- Function: event-chord-reduce music
Reduces event chords in music to their first note event, retaining only the chord articulations. Returns the modified music.
- Function: event-chord-wrap! music
Wrap isolated rhythmic events and non-postevent events in music inside of an
EventChord
. Chord repeats ‘q’ are expanded using the default settings of the parser.
- Function: event-has-articulation? event-type stream-event
Is event-type in the
articulations
list of stream-event?
- Function: ly:event-property sev sym val
Get the property sym of stream event sev. If sym is undefined, return val or
'()
if val is not specified.
- Function: expand-repeat-chords! event-types music
Walks through music and fills repeated chords (notable by having a duration in
duration
) with the notes from their respective predecessor chord.
- Function: expand-repeat-notes! music
Walks through music and gives pitchless notes (not having a pitch in
pitch
or a drum type indrum-type
) the pitch(es) from the predecessor note/chord if available.
- Function: ly:expect-warning str rest
A Scheme callable function to register a warning to be expected and subsequently suppressed. If the warning is not encountered, a warning about the missing warning will be shown. The message should be translated with
(_ ...)
and changing parameters given after the format string.
- Function: extract-beam-exceptions music
Creates a value useful for setting
beamExceptions
from music.
- Function: extract-music music pred?
Return a flat list of all music matching pred? inside of music, not recursing into matches themselves.
- Function: extract-named-music music music-name
Return a flat list of all music named music-name (either a single event symbol or a list of alternatives) inside of music, not recursing into matches themselves.
- Function: ly:extract-subfont-from-collection collection-file-name idx subfont-file-name
Extract the subfont of index idx in TrueType collection (TTC) or OpenType/CFF collection (OTC) file collection_file_name and write it to file subfont_file_name.
- Function: extract-typed-music music type
Return a flat list of all music with type (either a single type symbol or a list of alternatives) inside of music, not recursing into matches themselves.
- Function: find-named-props prop-name grob-descriptions
Used by
\magnifyMusic
and\magnifyStaff
. When grob-descriptions is equal to theall-grob-descriptions
alist (defined in ‘scm/define-grobs.scm’), this will find all grobs that can have a value for the prop-name property, and return them as a list in the following format:'((grob prop-name) (grob prop-name) ...)
- Function: find-pitch-entry keysig pitch accept-global accept-local
Return the first entry in keysig that matches pitch by notename and octave. Alteration is not considered. accept-global states whether key signature entries should be included. accept-local states whether local accidentals should be included. If no matching entry is found, #f is returned.
- Function: finger-glide::print grob
The stencil printing procedure for grob
FingerGlideSpanner
. Depending on the grob propertystyle
several forms of appearance are printed. Possible settings for grob propertystyle
arezigzag
,trill
,dashed-line
,dotted-line
,stub-left
,stub-right
,stub-both
,bow
,none
andline
, which is the default.
- Function: flared-hairpin grob
Create hairpin based on a list of coords in
(cons x y)
form.x
is the portion of the width consumed for a given line andy
is the portion of the height. For example,'((0 . 0) (0.3 . 0.7) (0.8 . 0.9) (1.0 . 1.0))
means that at the point where the hairpin has consumed 30% of its width, it must be at 70% of its height. Once it is to 80% width, it must be at 90% height. It finishes at 100% width and 100% height. If coords does not begin with'(0 . 0)
the final hairpin may have an open tip. For example ’(0 . 0.5) will cause an open end of 50% of the usual height. mirrored? indicates if the hairpin is mirrored over the Y-axis or if just the upper part is drawn. Returns a function that accepts a hairpin grob as an argument and draws the stencil based on its coordinates.#(define simple-hairpin (elbowed-hairpin '((0 . 0)(1.0 . 1.0)) #t)) \relative c' { \override Hairpin #'stencil = #simple-hairpin a\p\< a a a\f }
- Function: flip-stencil axis stil
Flip stencil stil in the direction of axis. Value
X
(or0
) for axis flips it horizontally. ValueY
(or1
) flips it vertically. stil is flipped in place; its position, the coordinates of its bounding box, remains the same.
- Function: fold-some-music pred? proc init music
This works recursively on music like
fold
does on a list, calling ‘(pred? music)’ on every music element. If#f
is returned for an element, it is processed recursively with the same initial value of ‘previous’, otherwise ‘(proc music previous)’ replaces ‘previous’ and no recursion happens. The top music is processed using init for ‘previous’.
- Function: ly:font-design-size font
Given the font metric font, return the design size, relative to the current output-scale.
- Function: ly:font-get-glyph font name
Return a stencil from font for the glyph named name. If the glyph is not available, return an empty stencil.
Note that this command can only be used to access glyphs from fonts loaded with
ly:system-font-load
; currently, this means either the Emmentaler or Emmentaler-Brace fonts, corresponding to the font encodingsfetaMusic
andfetaBraces
, respectively.
- Function: ly:font-glyph-name-to-charcode font name
Return the character code for glyph name in font.
Note that this command can only be used to access glyphs from fonts loaded with
ly:system-font-load
; currently, this means either the Emmentaler or Emmentaler-Brace fonts, corresponding to the font encodingsfetaMusic
andfetaBraces
, respectively.
- Function: ly:font-glyph-name-to-index font name
Return the index for name in font.
Note that this command can only be used to access glyphs from fonts loaded with
ly:system-font-load
; currently, this means either the Emmentaler or Emmentaler-Brace fonts, corresponding to the font encodingsfetaMusic
andfetaBraces
, respectively.
- Function: ly:font-index-to-charcode font index
Return the character code for index in font.
Note that this command can only be used to access glyphs from fonts loaded with
ly:system-font-load
; currently, this means either the Emmentaler or Emmentaler-Brace fonts, corresponding to the font encodingsfetaMusic
andfetaBraces
, respectively.
- Function: ly:font-magnification font
Given the font metric font, return the magnification, relative to the current output-scale.
- Function: ly:font-sub-fonts font
Given the font metric font of an OpenType font, return the names of the subfonts within font.
- Function: for-some-music stop? music
Walk through music, process all elements calling stop? and only recurse if this returns
#f
.
- Function: ly:format str rest
LilyPond specific format, supporting
~a
and~[0-9]f
. Basic support for~s
is also provided.
- Function: ly:format-output context
Given a global context in its final state, process it and return the
Music_output
object in its final state.
- Function: fret-parse-terse-definition-string props definition-string
Parse a fret diagram string that uses terse syntax; return a pair containing: props, modified to include the string-count determined by the definition-string, and a fret-indication list with the appropriate values
- Function: function-chain arg function-list
Applies a list of functions in function-list to arg. Each element of function-list is structured
(cons function '(arg2 arg3 ...))
. If function takes arguments besides arg, they are provided in function-list.Example: Executing ‘(function-chain 1 `((,+ 1) (,- 2) (,+ 3) (,/)))’ returns ‘1/3’.
- Function: ly:generic-bound-extent grob common
Determine the extent of grob relative to common along the X axis, finding its extent as a bound when it a has
bound-alignment-interfaces
property list set and otherwise the full extent.
- Function: ly:get-all-function-documentation
Get a hash table with all LilyPond Scheme extension functions.
- Function: get-bound-note-heads spanner
Takes a spanner grob and returns a pair containing all note heads of the intial starting and the final
NoteColumn
.
- Function: ly:get-cff-offset font-file-name idx
Get the offset of ’CFF’ table for font_file_name, returning it as an integer. The optional idx argument is useful for OpenType/CFF collections (OTC) only; it specifies the font index within the OTC. The default value of idx is 0.
- Function: get-chord-shape shape-code tuning base-chord-shapes
Return the chord shape associated with shape-code and tuning in the hash-table base-chord-shapes.
- Function: ly:get-context-mods contextmod
Returns the list of context modifications stored in contextmod.
- Function: ly:get-font-format font-file-name idx
Get the font format for font_file_name, returning it as a symbol. The optional idx argument is useful for TrueType Collections (TTC) and OpenType/CFF collections (OTC) only; it specifies the font index within the TTC/OTC. The default value of idx is 0.
- Function: ly:get-spacing-spec from-scm to-scm
Return the spacing spec going between the two given grobs, from_scm and to_scm.
- Function: get-tweakable-music mus
When tweaking music, returns a list of music expressions where the tweaks should be applied. Relevant for music wrappers and event chords.
- Function: grob::all-objects grob
Return a list of the names and contents of all properties having type
ly:grob?
orly:grob-array?
for all interfaces supported by grob grob.
- Function: grob::compose-function func data
This creates a callback entity to be stored in a grob property, based on the grob property data data (which can be plain data, a callback itself, or an unpure-pure-container).
Function or unpure-pure-container func accepts a grob and a value and returns another value. Depending on the type of data, func is used for building a grob callback or an unpure-pure-container.
- Function: grob::offset-function func data . rest
This creates a callback entity to be stored in a grob property, based on the grob property data data (which can be plain data, a callback itself, or an unpure-pure-container).
Function func accepts a grob and returns a value that is added to the value resulting from data. Optional argument plus defaults to
+
but may be changed to allow for using a different underlying accumulation.If data is
#f
or'()
, it is not included in the sum.
- Function: grob::rhythmic-location grob
Return a pair consisting of the measure number and moment within the measure of grob grob.
- Function: grob::unpure-Y-extent-from-stencil pure-function
The unpure height will come from a stencil whereas the pure height will come from
pure-function
.
- Function: ly:grob-alist-chain grob global
Get an alist chain for grob grob, with global as the global default. If unspecified,
font-defaults
from the layout block is taken.
- Function: ly:grob-chain-callback grob proc sym
Find the callback that is stored as property sym of grob grob and chain proc to the head of this, meaning that it is called using grob and the previous callback’s result.
- Function: ly:grob-common-refpoint grob other axis
Find the common refpoint of grob and other for axis.
- Function: ly:grob-common-refpoint-of-array grob others axis
Find the common refpoint of grob and others (a grob-array) for axis.
- Function: grob-elts::X-extent grob
Take the grob grob, get its
'elements
, calculate their'X-extent
and return the minimum and maximum value as a pair. If'elements
is empty return'(0 . 0)
- Function: ly:grob-extent grob refp axis
Get the extent in axis direction of grob relative to the grob refp.
- Function: ly:grob-get-vertical-axis-group-index grob
Get the index of the vertical axis group the grob grob belongs to; return
-1
if none is found.
- Function: ly:grob-object grob sym val
Return the value of a pointer in grob grob of property sym. When sym is undefined in grob, it returns val if specified or
'()
(end-of-list) otherwise. The kind of properties this taps into differs from regular properties. It is used to store links between grobs, either grobs or grob arrays. For instance, a note head has astem
property, the stem grob it belongs to. Just after line breaking, all those grobs are scanned and replaced by their relevant broken versions when applicable.
- Function: ly:grob-parent grob axis
Get the parent of grob. axis is 0 for the X-axis, 1 for the Y-axis.
- Function: ly:grob-property grob sym val
Return the value for property sym of grob. If no value is found, return val or
'()
if val is not specified.
- Function: ly:grob-property-data grob sym
Return the value for property sym of grob, but do not process callbacks.
- Function: ly:grob-pure-height grob refp beg end val
Return the pure height of grob given refpoint refp. If no value is found, return val or
'()
if val is not specified.
- Function: ly:grob-pure-property grob sym beg end val
Return the pure value for property sym of grob. If no value is found, return val or
'()
if val is not specified.
- Function: ly:grob-relative-coordinate grob refp axis
Get the coordinate in axis direction of grob relative to the grob refp.
- Function: ly:grob-robust-relative-extent grob refp axis
Get the extent in axis direction of grob relative to the grob refp, or
(0,0)
if empty.
- Function: ly:grob-set-nested-property! grob symlist val
Set nested property symlist in grob grob to value val.
- Function: ly:grob-set-parent! grob axis parent-grob
Set parent-grob the parent of grob grob in axis axis.
- Function: ly:grob-spanned-rank-interval grob
Returns a pair with the
rank
of the furthest left column and therank
of the furthest right column spanned bygrob
.
- Function: grob-transformer property func
Create an override value good for applying func to either pure or unpure values. func is called with the respective grob as first argument and the default value (after resolving all callbacks) as the second.
- Function: ly:gulp-file name size
Read size characters from the file name, and return its contents in a string. If size is undefined, the entire file is read. The file is looked up using the search path.
- Function: ly:gulp-file-utf8 name size
Read size characters from the file name, and return its contents in a string decoded from UTF-8. If size is undefined, the entire file is read. The file is looked up using the search path.
- Function: ly:has-glyph-names? font-file-name idx
Does the font for font_file_name have glyph names? The optional idx argument is useful for TrueType Collections (TTC) and OpenType/CFF collections (OTC) only; it specifies the font index within the TTC/OTC. The default value of idx is 0.
- Function: hook-stencil x y staff-space thick blot grob
Returns a hook-stencil, where x determines the horizontal position and y determines the basic vertical position. The final stencil is adjusted vertically using staff-space, which is
StaffSymbol
’s staff space, and uses blot, which is the current'blot-diameter
. The stencil’s thickness is usually taken from grob'details
, thick serves as a fallback value.
- Function: ly:input-both-locations sip
Return input location in sip as
(file-name first-line first-column last-line last-column)
.
- Function: ly:input-file-line-char-column sip
Return input location in sip as
(file-name line char column)
.
- Function: ly:input-message sip msg rest
Print msg as a GNU compliant error message, pointing to the location in sip. msg is interpreted similar to
format
’s argument, using rest.
- Function: ly:input-warning sip msg rest
Print msg as a GNU compliant warning message, pointing to the location in sip. msg is interpreted similar to
format
’s argument, using rest.
- Function: ly:interpret-music-expression mus ctx
Interpret the music expression mus in the global context ctx. The context is returned in its final state.
- Function: interval-index interval dir
Interpolate interval between between left (dir=-1) and right (dir=+1).
- Function: invalidate-alterations context
Invalidate alterations in context.
Elements of
'localAlterations
corresponding to local alterations of the key signature have the form'((octave . notename) . (alter barnum . measurepos))
. Replace them with a version wherealter
is set to'clef
to force a repetition of accidentals.Entries that conform with the current key signature are not invalidated.
- Function: ly:item-break-dir it
The break status direction of item it.
-1
means end of line,0
unbroken, and1
beginning of line.
- Function: ly:item-get-column it
Return the
PaperColumn
orNonMusicalPaperColumn
associated with thisItem
.
- Function: layout-set-absolute-staff-size sz
Set the absolute staff size inside of a
\layout{}
block. sz is in points.
- Function: ly:length x y
Calculates magnitude of given vector. With one argument, x is a number pair indicating the vector. With two arguments, x and y specify the respective coordinates.
- Function: ly:line-interface::line grob startx starty endx endy
Make a line using layout information from grob grob.
- Function: list-insert-separator lst between
Create new list, inserting between between elements of lst.
- Function: lookup-markup-command code
Return (FUNCTION . SIGNATURE) for a markup command, or return #f
- Function: ly:make-book paper header scores
Make a
\book
of paper and header (which may be#f
as well) containing\scores
.
- Function: make-bow-stencil start stop thickness angularity bow-height orientation
Create a bow stencil. It starts at point start, ends at point stop. thickness is the thickness of the bow. The higher the value of number angularity, the more angular the shape of the bow. bow-height determines the height of the bow. orientation determines, whether the bow is concave or convex. Both variables are supplied to support independent usage.
Done by calculating a horizontal unit-bow first, then moving all control-points to the correct positions. Limitation: s-curves are currently not supported.
- Function: make-circle-stencil radius thickness fill
Make a circle of radius radius and thickness thickness.
- Function: make-clef-set clef-name
Generate the clef setting commands for a clef with name clef-name.
- Function: make-connected-line points grob
Takes a list of points, points. Returns a line connecting points, using
ly:line-interface::line
, gets layout information from grob
- Function: make-connected-path-stencil pointlist thickness x-scale y-scale connect fill
Make a connected path described by the list pointlist, beginning at point ’(0 . 0), with thickness thickness, and scaled by x-scale in the X direction and y-scale in the Y direction. connect and fill are boolean arguments that specify if the path should be connected or filled, respectively.
- Function: ly:make-context-mod mod-list
Creates a context modification, optionally initialized via the list of modifications mod-list.
- Function: make-cue-clef-set clef-name
Generate the clef setting commands for a cue clef with name clef-name.
- Function: ly:make-duration length dotcount num den
length is the negative logarithm (base 2) of the duration: 1 is a half note, 2 is a quarter note, 3 is an eighth note, etc. The number of dots after the note is given by the optional argument dotcount.
The duration factor is optionally given by integers num and den, alternatively by a single rational number.
A duration is a musical duration, i.e., a length of time described by a power of two (whole, half, quarter, etc.) and a number of augmentation dots.
- Function: make-ellipse-stencil x-radius y-radius thickness fill
Make an ellipse of x radius x-radius, y radius
y-radius
, and thickness thickness with fill defined byfill
.
- Function: ly:make-global-context output-def
Set up a global interpretation context, using the output block output-def. The context is returned.
- Function: ly:make-global-translator global
Create a translator group and connect it to the global context global. The translator group is returned.
- Function: make-glyph-time-signature-markup style fraction
Make markup for a symbolic time signature. If the music font does not have a glyph for the requested style and fraction, issue a warning and make a numbered time signature instead.
- Function: ly:make-grob-properties alist
This packages the given property list alist in a grob property container stored in a context property with the name of a grob.
- Function: make-grob-property-override grob gprop val
Make a
Music
expression that overrides gprop to val in grob. This is a\temporary \override
, making it possible to\revert
to any previous value afterwards.
- Function: make-grob-property-set grob gprop val
Make a
Music
expression that overrides a gprop to val in grob. Does a pop first, i.e. this is not a\temporary \override
.
- Function: make-line-stencil width startx starty endx endy
Make a line stencil of given linewidth and set its extents accordingly.
- Function: ly:make-listener callback
This is a compatibility wrapper for creating a "listener" for use with
ly:add-listener
from a callback taking a single argument. Since listeners are equivalent to callbacks, this is no longer needed.
- Function: ly:make-moment m g gn gd
Create the moment with rational main timing m, and optional grace timing g.
A moment is a point in musical time. It consists of a pair of rationals (m, g), where m is the timing for the main notes, and g the timing for grace notes. In absence of grace notes, g is zero.
For compatibility reasons, it is possible to write two numbers specifying numerator and denominator instead of the rationals. These forms cannot be mixed, and the two-argument form is disambiguated by the sign of the second argument: if it is positive, it can only be a denominator and not a grace timing.
- Function: ly:make-music props
Make a C++
Music
object and initialize it with props.This function is for internal use and is only called by
make-music
, which is the preferred interface for creating music objects.
- Function: make-music name . music-properties
Create a music object of given name, and set its properties according to
music-properties
, a list of alternating property symbols and values. E.g:(make-music 'OverrideProperty 'symbol 'Stem 'grob-property 'thickness 'grob-value (* 2 1.5))
Instead of a successive symbol and value, an entry in the list may also be an alist or a music object in which case its elements, respectively its mutable property list (properties not inherent to the type of the music object) will get taken.
The argument list will be interpreted left-to-right, so later entries override earlier ones.
- Function: ly:make-music-function signature func
Make a function to process music, to be used for the parser. func is the function, and signature describes its arguments. signature’s cdr is a list containing either
ly:music?
predicates or other type predicates. Its car is the syntax function to call.
- Function: make-oval-stencil x-radius y-radius thickness fill
Make an oval from two Bezier curves, of x radius x-radius, y radius
y-radius
, and thickness thickness with fill defined byfill
.
- Function: ly:make-page-permission-marker symbol permission
Return page marker with page breaking and turning permissions.
- Function: ly:make-pango-description-string chain size
Make a
PangoFontDescription
string for the property alist chain at size size.
- Function: ly:make-paper-outputter port alist default-callback
Create an outputter dumping to
port
.alist
should map symbols to procedures. Seeoutput-ps.scm
for an example. Ifdefault_callback
is given, it is called for unsupported expressions
- Function: make-part-combine-context-changes state-machine split-list
Generate a sequence of part combiner context changes from a split list
- Function: make-part-combine-marks state-machine split-list
Generate a sequence of part combiner events from a split list
- Function: make-partial-ellipse-stencil x-radius y-radius start-angle end-angle thick connect fill
Create an elliptical arc x-radius is the X radius of the arc. y-radius is the Y radius of the arc. start-angle is the starting angle of the arc in degrees. end-angle is the ending angle of the arc in degrees. thick is the thickness of the line. connect is a boolean flag indicating if the end should be connected to the start by a line. fill is a boolean flag indicating if the shape should be filled.
- Function: make-path-stencil path thickness x-scale y-scale fill
Make a stencil based on the path described by the list path, with thickness thickness, and scaled by x-scale in the X direction and y-scale in the Y direction. fill is a boolean argument that specifies if the path should be filled. Valid path commands are: moveto rmoveto lineto rlineto curveto rcurveto closepath, and their standard SVG single letter equivalents: M m L l C c Z z.
- Function: ly:make-pitch octave note alter
octave is specified by an integer, zero for the octave containing middle C. note is a number indexing the global default scale, with 0 corresponding to pitch C and 6 usually corresponding to pitch B. Optional alter is a rational number of 200-cent whole tones for alteration.
- Function: make-repeat name times main alts
Create a repeat music expression, with all properties initialized properly.
- Function: ly:make-rotation angle center
Make a transform rotating by angle in degrees. If center is given as a pair of coordinates, it is the center of the rotation, otherwise the rotation is around (0 . 0).
- Function: ly:make-scale steps
Create a scale. The argument is a vector of rational numbers, each of which represents the number of 200 cent tones of a pitch above the tonic.
- Function: ly:make-scaling scale scaley
Create a scaling transform from argument scale and optionally scaley. When both arguments are given, they must be real and give the scale in x and y direction. If only scale is given, it may also be complex to indicate a scaled rotation in the manner of complex number rotations, or a pair of reals for specifying different scales in x and y direction like with the first calling convention.
- Function: make-semitone->pitch pitches
Convert pitches, an unordered list of note values covering (after disregarding octaves) all absolute pitches in need of conversion, into a function converting semitone numbers (absolute pitch missing enharmonic information) back into note values.
For a key signature without accidentals
c cis d es e f fis g gis a bes b
might be a good choice, covering Bb major to A major and their parallel keys, and melodic/harmonic C minor to A minor.
- Function: ly:make-spring ideal min-dist
Make a spring. ideal is the ideal distance of the spring, and min-dist is the minimum distance.
- Function: ly:make-stencil expr xext yext
Stencils are device independent output expressions. They carry two pieces of information:
- A specification of how to print this object. This specification is processed by the output backends, for example ‘scm/output-ps.scm’.
-
The vertical and horizontal extents of the object, given as pairs. If an extent is unspecified (or if you use
empty-interval
as its value), it is taken to be empty.
- Function: make-stencil-boxer thickness padding callback
Return function that adds a box around the grob passed as argument.
- Function: make-stencil-circler thickness padding callback
Return function that adds a circle around the grob passed as argument.
- Function: ly:make-stream-event cl proplist
Create a stream event of class cl with the given mutable property list.
- Function: make-tmpfile basename
Returns a temp file as port. If basename is #f, a file under $TMPDIR is created.
- Function: ly:make-transform xx yx xy yy x0 y0
Create a transform. Without options, it is an identity transform. Given four arguments xx, yx, xy, and yy, it is a linear transform, given six arguments (with x0 and y0 last), it is an affine transform. Transforms can be called as functions on other transforms (concatening them) or on points given either as complex number or real number pair. See also
ly:make-rotation
,ly:make-scaling
, andly:make-translation
.
- Function: ly:make-translation x y
Make a transform translating by x and y. If only x is given, it can also be a complex number or a pair of numbers indicating the offset to use.
- Function: ly:make-unpure-pure-container unpure pure
Make an unpure-pure container. unpure should be an unpure expression, and pure should be a pure expression. If pure is omitted, the value of unpure will be used twice, except that a callback is given two extra arguments that are ignored for the sake of pure calculations.
- Function: map-selected-alist-keys function keys alist
Return alist with function applied to all of the values in list keys.
For example:
guile> (map-selected-alist-keys - '(a b) '((a . 1) (b . -2) (c . 3) (d . 4)))
((a . -1) (b . 2) (c . 3) (d . 4)
- Function: map-some-music map? music
Walk through music, transform all elements calling map? and only recurse if this returns
#f
.elements
orarticulations
that are not music expressions are discarded: this allows some amount of filtering.map-some-music
may overwrite the original music.
- Function: markup-command-list? x
Determine if ‘x’ is a markup command list, ie. a list composed of a markup list function and its arguments.
- Function: measure-counter::text grob
A number for a measure count. Broken measures are numbered in parentheses. When the counter spans several measures (like with compressed multi-measure rests), it displays a measure range.
- Function: mensural-flag grob
Mensural flags: Create the flag stencil by loading the glyph from the font. Flags are always aligned with staff lines, so we need to check the end point of the stem: For stems ending on staff lines, use different flags than for notes between staff lines. The idea is that flags are always vertically aligned with the staff lines, regardless of whether the note head is on a staff line or between two staff lines. In other words, the inner end of a flag always touches a staff line.
- Function: ly:message str rest
A Scheme callable function to issue the message str. The message is formatted with
format
and rest.
- Function: ly:minimal-breaking pb
Break (pages and lines) the
Paper_book
object pb without looking for optimal spacing: stack as many lines on a page before moving to the next one.
- Function: modern-straight-flag grob
Modern straight flag style (for composers like Stockhausen, Boulez, etc.). The angles are 18 and 22 degrees and thus smaller than for the ancient style of Bach, etc.
- Function: ly:modules-lookup modules sym def
Look up sym in the list modules, returning the first occurence. If not found, return def or
#f
if def isn’t specified.
- Function: music->make-music obj
Generate an expression that, once evaluated, may return an object equivalent to obj, that is, for a music expression, a
(make-music ...)
form.
- Function: music-clone music . music-properties
Clone music and set properties according to music-properties, a list of alternating property symbols and values:
(music-clone start-span 'span-direction STOP)
Only properties that are not overriden by music-properties are actually fully cloned.
- Function: ly:music-deep-copy m origin
Copy m and all sub expressions of m. m may be an arbitrary type; cons cells and music are copied recursively. If origin is given, it is used as the origin for one level of music by calling
ly:set-origin!
on the copy.
- Function: ly:music-length mus
Get the length of music expression mus and return it as a
Moment
object.
- Function: music-map function music
Apply function to music and all of the music it contains.
First it recurses over the children, then the function is applied to music.
- Function: ly:music-mutable-properties mus
Return an alist containing the mutable properties of mus. The immutable properties are not available, since they are constant and initialized by the
make-music
function.
- Function: ly:music-property mus sym val
Return the value for property sym of music expression mus. If no value is found, return val or
'()
if val is not specified.
- Function: music-selective-filter descend? pred? music
Recursively filter out music expressions that do not satisfy pred?, but refrain from filtering the subexpressions of music that does not satisfy descend?.
- Function: music-selective-map descend? function music
Apply function recursively to music, but refrain from mapping subexpressions of music that does not satisfy descend?.
- Function: ly:music-start mus
Get the start of music expression mus and return it as a
Moment
object.
- Function: music-type-predicate types
Returns a predicate function that can be used for checking music to have one of the types listed in types.
- Function: neo-modern-accidental-rule context pitch barnum measurepos
An accidental rule that typesets an accidental if it differs from the key signature and does not directly follow a note on the same staff line. This rule should not be used alone because it does neither look at bar lines nor different accidentals at the same note name.
- Function: note-column::main-extent grob
Return extent of the noteheads in the ’main column’ (i.e., excluding any suspended noteheads), or extent of the rest (if there are no heads).
- Function: ly:note-column-accidentals note-column
Return the
AccidentalPlacement
grob from note-column if any, orSCM_EOL
otherwise.
- Function: ly:note-column-dot-column note-column
Return the
DotColumn
grob from note-column if any, orSCM_EOL
otherwise.
- Function: ly:note-head::stem-attachment font-metric glyph-name direction
Get attachment in font-metric for attaching a stem to notehead glyph-name in the direction direction (default UP).
- Function: note-name->markup pitch lowercase?
Return pitch markup for pitch, including accidentals printed as glyphs. If lowercase? is set to false, the note names are capitalized.
- Function: note-name->string pitch . language
Return pitch string for pitch, without accidentals or octaves. Current input language is used for pitch names, except if an other language is specified.
- Function: number-format number-type num . custom-format
Print NUM accordingly to the requested NUMBER-TYPE. Choices include
roman-lower
(by default),roman-upper
,arabic
andcustom
. In the latter case, CUSTOM-FORMAT must be supplied and will be applied to NUM.
- Function: offset-fret fret-offset diagram-definition
Add fret-offset to each fret indication in diagram-definition and return the resulting verbose
fret-diagram-definition
.
- Function: offsetter property offsets
Apply offsets to the default values of property of grob. Offsets are restricted to immutable properties and values of type
number
,number-pair
, ornumber-pair-list
.
- Function: old-straight-flag grob
Old straight flag style (for composers like Bach). The angles of the flags are both 45 degrees.
- Function: ly:one-line-auto-height-breaking pb
Put each score on a single line, and put each line on its own page. Modify the paper-width setting so that every page is wider than the widest line. Modify the paper-height setting to fit the height of the tallest line.
- Function: ly:one-line-breaking pb
Put each score on a single line, and put each line on its own page. Modify the paper-width setting so that every page is wider than the widest line.
- Function: ly:one-page-breaking pb
Put each score on a single page. The paper-height settings are modified so each score fits on one page, and the height of the page matches the height of the full score.
- Function: ly:optimal-breaking pb
Optimally break (pages and lines) the
Paper_book
object pb to minimize badness in bother vertical and horizontal spacing.
- Function: ly:option-usage port
Print
ly:set-option
usage. Optional port argumentfor the destination defaults to current output port.
- Function: ly:otf->cff otf-file-name idx
Convert the contents of an OTF file to a CFF file, returning it as a string. The optional idx argument is useful for OpenType/CFF collections (OTC) only; it specifies the font index within the OTC. The default value of idx is 0.
- Function: ly:otf-font-glyph-info font glyph
Given the font metric font of an OpenType font, return the information about named glyph glyph (a string).
- Function: ly:otf-font-table-data font tag
Extract a table tag from font. Return empty string for non-existent tag.
- Function: ly:output-def-lookup def sym val
Return the value of sym in output definition def (e.g.,
\paper
). If no value is found, return val or'()
if val is undefined.
- Function: ly:output-find-context-def output-def context-name
Return an alist of all context defs (matching context-name if given) in output-def.
- Function: output-module? module
Returns
#t
if module belongs to an output module usually carrying context definitions (\midi
or\layout
).
- Function: oval-stencil stencil thickness x-padding y-padding
Add an oval around
stencil
, padded by the padding pair, producing a new stencil.
- Function: override-time-signature-setting time-signature setting
Override the time signature settings for the context in time-signature, with the new setting alist setting.
- Function: ly:page-turn-breaking pb
Optimally break (pages and lines) the
Paper_book
object pb such that page turns only happen in specified places, returning its pages.
- Function: ly:pango-font-physical-fonts f
Return alist of
(ps-name file-name font-index)
lists for Pango font f.
- Function: ly:paper-book-paper pb
Return the paper output definition (
\paper
) inPaper_book
object pb.
- Function: ly:paper-column::break-align-width col align-syms
Determine the extent along the X-axis of a grob used for break-alignment organized by column col. The grob is specified by align-syms, which contains either a single
break-align-symbol
or a list of such symbols.
- Function: ly:paper-column::print
Optional stencil for
PaperColumn
orNonMusicalPaperColumn
. Draws therank number
of each column, its moment in time, a blue arrow showing the ideal distance, and a red arrow showing the minimum distance between columns.
- Function: ly:paper-fonts def
Return a list containing the fonts from output definition def (e.g.,
\paper
).
- Function: ly:paper-get-font def chain
Find a font metric in output definition def satisfying the font-qualifiers in alist chain chain, and return it. (An alist chain is a list of alists, containing grob properties.)
- Function: ly:paper-get-number def sym
Return the value of variable sym in output definition def as a double.
- Function: ly:paper-score-paper-systems paper-score
Return vector of
paper_system
objects from paper-score.
- Function: ly:paper-system-minimum-distance sys1 sys2
Measure the minimum distance between these two paper-systems, using their stored skylines if possible and falling back to their extents otherwise.
- Function: parenthesize-stencil stencil half-thickness width angularity padding
Add parentheses around stencil, returning a new stencil.
- Function: ly:parse-string-expression parser-smob ly-code filename line
Parse the string ly-code with parser-smob. Return the contained music expression. filename and line are optional source indicators.
- Function: parse-terse-string terse-definition
Parse a
fret-diagram-terse
definition string terse-definition and return a marking list, which can be used with a fretboard grob.
- Function: ly:parsed-undead-list!
Return the list of objects that have been found live that should have been dead, and clear that list.
- Function: ly:parser-clone closures location
Return a clone of current parser. An association list of port positions to closures can be specified in closures in order to have
$
and#
interpreted in their original lexical environment. If location is a valid location, it becomes the source of all music expressions inside.
- Function: ly:parser-error msg input
Display an error message and make current parser fail. Without a current parser, trigger an ordinary error.
- Function: ly:parser-has-error? parser
Does parser (defaulting to current parser) have an error flag?
- Function: ly:parser-include-string ly-code
Include the string ly-code into the input stream for current parser. Can only be used in immediate Scheme expressions (
$
instead of#
).
- Function: ly:parser-lookup symbol
Look up symbol in current parser’s module. Return
'()
if not defined.
- Function: ly:parser-output-name parser
Return the base name of the output file. If
parser
is left off, use currently active parser.
- Function: ly:parser-parse-string parser-smob ly-code
Parse the string ly-code with parser-smob. Upon failure, throw
ly-file-failed
key.
- Function: ly:parser-set-note-names names
Replace current note names in parser. names is an alist of symbols. This only has effect if the current mode is notes.
- Function: ly:performance-write performance filename name
Write performance to filename storing name as the name of the performance in the file metadata.
- Function: ly:pitch-diff pitch root
Return pitch delta such that root transposed by delta equals pitch.
- Function: ly:pitch-transpose p delta
Transpose p by the amount delta, where delta is relative to middle C.
- Function: ly:pointer-group-interface::add-grob grob sym grob-element
Add grob-element to grob’s sym grob array.
- Function: polar->rectangular radius angle-in-degrees
Return polar coordinates (radius, angle-in-degrees) as rectangular coordinates
(x-length . y-length)
.
- Function: ly:position-on-line? sg spos
Return whether spos is on a line of the staff associated with the grob sg (even on an extender line).
- Function: ly:prob-property prob sym val
Return the value for property sym of Prob object prob. If no value is found, return val or
'()
if val is not specified.
- Function: ly:programming-error str rest
A Scheme callable function to issue the internal warning str. The message is formatted with
format
and rest.
- Function: ly:progress str rest
A Scheme callable function to print progress str. The message is formatted with
format
and rest.
- Function: ly:property-lookup-stats sym
Return hash table with a property access corresponding to sym. Choices are
prob
,grob
, andcontext
.
- Function: ly:pure-call data grob start end rest
Convert property data (unpure-pure container or procedure) to value in a pure context defined by grob, start, end, and possibly rest arguments.
- Function: pure-chain-offset-callback grob start end prev-offset
Sometimes, a chained offset callback is unpure and there is no way to write a pure function that estimates its behavior. In this case, we use a pure equivalent that will simply pass the previous calculated offset value.
- Function: read-lily-expression chr port
Read a lilypond music expression enclosed within
#{
and#}
from port and return the corresponding Scheme music expression. ‘$’ and ‘#’ introduce immediate and normal Scheme forms.
- Function: recording-group-emulate music odef
Interpret music according to odef, but store all events in a chronological list, similar to the
Recording_group_engraver
in LilyPond version 2.8 and earlier.
- Function: ly:register-translator creator name description
Register a translator creator (usually a descriptive alist or a function/closure returning one when given a context argument) with the given symbol name and the given description alist.
- Function: ly:relative-group-extent elements common axis
Determine the extent of elements relative to common in the axis direction.
- Function: ly:rename-file oldname newname
Rename oldname to newname. In contrast to Guile’s rename-file, this replaces the destination if it already exists. On Windows, fall back to copying the file contents if newname cannot be deleted.
- Function: retrieve-glyph-flag flag-style dir dir-modifier grob
Load the correct flag glyph from the font.
- Function: revert-fontSize func-name mag
Used by
\magnifyMusic
and\magnifyStaff
. Calculate the previousfontSize
value (before scaling) by factoring out the magnification factor mag (if func-name is'magnifyMusic
), or by factoring out the context propertymagnifyStaffValue
(if func-name is'magnifyStaff
). Revert thefontSize
in the appropriate context accordingly.With
\magnifyMusic
, the scaling is reverted after the music block it operates on.\magnifyStaff
does not operate on a music block, so the scaling from a previous call (if there is one) is reverted before the new scaling takes effect.
- Function: revert-props func-name mag props
Used by
\magnifyMusic
and\magnifyStaff
. Revert each prop in props in the appropriate context. func-name is either'magnifyMusic
or'magnifyStaff
. The props list is formatted like:'((Stem thickness) (Slur line-thickness) ...)
- Function: ly:round-filled-box xext yext blot
Make a
Stencil
object that prints a black box of dimensions xext, yext and roundness blot.
- Function: ly:round-polygon points blot extroversion filled-scm
Make a
Stencil
object that prints a black polygon with corners at the points defined by points (list of coordinate pairs) and roundness blot. Optionalextroversion shifts the outline outward, with thedefault of 0 keeping the middle of the line just on the polygon.
- Function: rounded-box-stencil stencil thickness padding blot
Add a rounded box around stencil, producing a new stencil.
- Function: ly:run-translator mus output-def
Process mus according to output-def. An interpretation context is set up, and mus is interpreted with it. The context is returned in its final state.
Optionally, this routine takes an object-key to to uniquely identify the score block containing it.
- Function: scale-beam-thickness mag
Used by
\magnifyMusic
. ScalingBeam.beam-thickness
exactly to the mag value will not work. This uses two reference values forbeam-thickness
to determine an acceptable value when scaling, then does the equivalent of a\temporary \override
with the new value.
- Function: scale-fontSize func-name mag
Used by
\magnifyMusic
and\magnifyStaff
. Look up the currentfontSize
in the appropriate context and scale it by the magnification factor mag. func-name is either'magnifyMusic
or'magnifyStaff
.
- Function: scale-props func-name mag allowed-to-shrink? props
Used by
\magnifyMusic
and\magnifyStaff
. For each prop in props, find the current value of the requested prop, scale it by the magnification factor mag, and do the equivalent of a\temporary \override
with the new value in the appropriate context. If allowed-to-shrink? is#f
, don’t let the new value be less than the current value. func-name is either'magnifyMusic
or'magnifyStaff
. The props list is formatted like:'((Stem thickness) (Slur line-thickness) ...)
- Function: ly:score-embedded-format score layout
Run score through layout (an output definition) scaled to correct output-scale already, returning a list of layout-lines.
- Function: select-head-glyph style log
Select a note head glyph string based on note head style style and duration-log log.
- Function: self-alignment-interface::self-aligned-on-breakable grob
Return the
X-offset
that places grob according to itsself-alignment-X
over the reference point defined by thebreak-align-anchor-alignment
of abreak-aligned
item such as aClef
.
- Function: ly:separation-item::print
Optional stencil for
PaperColumn
orNonMusicalPaperColumn
. This function drawshorizontal-skylines
of eachPaperColumn
, showing the shapes used to determine the minimum distances betweenPaperColumns
at the note-spacing step, before staves have been spaced (vertically) on the page.
- Function: sequential-music-to-chord-exceptions seq . rest
Transform sequential music SEQ of type
<<c d e>>-\markup{ foobar }
to(cons CDE-PITCHES FOOBAR-MARKUP)
, or to(cons DE-PITCHES FOOBAR-MARKUP)
if OMIT-ROOT is given and non-false.
- Function: set-accidental-style style . rest
Set accidental style to style. Optionally take a context argument, e.g.
'Staff
or'Voice
. The context defaults toStaff
, except for piano styles, which useGrandStaff
as a context.
- Function: ly:set-default-scale scale
Set the global default scale. This determines the tuning of pitches with no accidentals or key signatures. The first pitch is C. Alterations are calculated relative to this scale. The number of pitches in this scale determines the number of scale steps that make up an octave. Usually the 7-note major scale.
- Function: ly:set-grob-creation-callback cb
Specify a procedure that will be called every time a new grob is created. The callback will receive as arguments the grob that was created, the name of the C++ source file that caused the grob to be created, and the corresponding line number in the C++ source file. Call with
#f
as argument to unset the callback.
- Function: ly:set-grob-modification-callback cb
Specify a procedure that will be called every time LilyPond modifies a grob property. The callback will receive as arguments the grob that is being modified, the name of the C++ file in which the modification was requested, the line number in the C++ file in which the modification was requested, the name of the function in which the modification was requested, the property to be changed, and the new value for the property. Call with
#f
as argument to unset the callback.
- Function: ly:set-middle-C! context
Set the
middleCPosition
variable in context based on the variablesmiddleCClefPosition
andmiddleCOffset
.
- Function: ly:set-origin! m origin
This sets the origin given in origin to m. m will typically be a music expression or a list of music. List structures are searched recursively, but recursion stops at the changed music expressions themselves. origin is generally of type
ly:input-location?
, defaulting to(*location*)
. Other valid values fororigin
are a music expression which is then used as the source of location information, or#f
or'()
in which case no action is performed. The return value is m itself.
- Function: ly:set-property-cache-callback cb
Specify a procedure that will be called whenever lilypond calculates a callback function and caches the result. The callback will receive as arguments the grob whose property it is, the name of the property, the name of the callback that calculated the property, and the new (cached) value of the property. Call with
#f
as argument to unset the callback.
- Function: shift-one-duration-log music shift dot
Add shift to
duration-log
of'duration
in music and optionally dot to any note encountered. The number of dots in the shifted music may not be less than zero.
- Function: shift-right-at-line-begin g
Shift an item to the right, but only at the start of the line.
- Function: skip->rest mus
Replace mus by
RestEvent
of the same duration if it is aSkipEvent
. Useful for extracting parts from crowded scores.
- Function: ly:solve-spring-rod-problem springs rods length ragged
Solve a spring and rod problem for count objects, that are connected by count-1 springs, and an arbitrary number of rods. count is implicitly given by springs and rods. The springs argument has the format
(ideal, inverse_hook)
and rods is of the form(idx1, idx2, distance)
.length is a number, ragged a boolean.
The function returns a list containing the force (positive for stretching, negative for compressing and
#f
for non-satisfied constraints) followed by spring-count+1 positions of the objects.
- Function: ly:source-files parser-smob
A list of input files that have been opened up to here, including the files that have been closed already. a PARSER may optionally be specified.
- Function: ly:span-bar::before-line-breaking grob
A dummy callback that kills the Grob grob if it contains no elements.
- Function: ly:span-bar::calc-glyph-name grob
Return the
'glyph-name
of the corresponding BarLine grob. The corresponding SpanBar glyph is computed withinspan-bar::compound-bar-line
.
- Function: ly:spanner-bound spanner dir
Get one of the bounds of spanner. dir is
-1
for left, and1
for right.
- Function: ly:spanner-set-bound! spanner dir item
Set grob item as bound in direction dir for spanner.
- Function: ly:spawn command rest
Simple interface to g_spawn_sync str. The error is formatted with
format
and rest.
- Function: split-list-by-separator lst pred
Split lst at each element that satisfies pred, and return the parts (with the separators removed) as a list of lists. For example, executing ‘(split-list-by-separator '(a 0 b c 1 d) number?)’ returns ‘((a) (b c) (d))’.
- Function: ly:spring-set-inverse-compress-strength! spring strength
Set the inverse compress strength of spring.
- Function: ly:spring-set-inverse-stretch-strength! spring strength
Set the inverse stretch strength of spring.
- Function: stack-stencil-line space stencils
Adjoin a list of stencils along the X axis, leaving space between the end of each stencil and the beginning of the following stencil. Stencils with empty Y extent are not given space before them and don’t avoid overlapping other stencils.
- Function: stack-stencils axis dir padding stils
Stack stencils stils in direction axis, dir, using padding.
- Function: stack-stencils-padding-list axis dir paddings stils
Stack stencils stils in direction axis, dir, using a list of paddings.
- Function: ly:staff-symbol-line-thickness grob
Returns the current staff-line thickness in the staff associated with grob, expressed as a multiple of the current staff-space height.
- Function: ly:staff-symbol-staff-space grob
Returns the current staff-space height in the staff associated with grob, expressed as a multiple of the default height of a staff-space in the traditional five-line staff.
- Function: ly:stderr-redirect fd-or-file-name mode
Redirect stderr to fd if the first parameter is an integer, or to file-name, opened with mode.
- Function: ly:stencil-aligned-to stil axis dir
Align stil using its own extents. dir is a number.
-1
and1
are left and right, respectively. Other values are interpolated (so0
means the center).
- Function: ly:stencil-combine-at-edge first axis direction second padding
Construct a stencil by putting second next to first. axis can be 0 (x-axis) or 1 (y-axis). direction can be -1 (left or down) or 1 (right or up). The stencils are juxtaposed with padding as extra space. first and second may also be
'()
or#f
.
- Function: ly:stencil-empty? stil axis
Return whether stil is empty. If an optional axis is supplied, the emptiness check is restricted to that axis.
- Function: ly:stencil-extent stil axis
Return a pair of numbers signifying the extent of stil in axis direction (
0
or1
for x and y axis, respectively).
- Function: ly:stencil-in-color stc r g b a
Put stc in a different color.Accepts either three values for r,g, b and an optional valuefor a, or a single CSS-like string.
- Function: ly:stencil-outline stil outline
Return a stencil with the stencil expression (inking) of stencil stil but with outline and dimensions from stencil outline.
- Function: ly:stencil-rotate stil angle x y
Return a stencil stil rotated angle degrees around the relative offset (x, y). E.g., an offset of (-1, 1) will rotate the stencil around the left upper corner.
- Function: ly:stencil-rotate-absolute stil angle x y
Return a stencil stil rotated angle degrees around point (x, y), given in absolute coordinates.
- Function: ly:stencil-scale stil x y
Scale stencil stil using the horizontal and vertical scaling factors x and y. Negative values will flip or mirror stil without changing its origin; this may result in collisions unless it is repositioned.
- Function: ly:stencil-stack first axis direction second padding mindist
Construct a stencil by stacking second next to first. axis can be 0 (x-axis) or 1 (y-axis). direction can be -1 (left or down) or 1 (right or up). The stencils are juxtaposed with padding as extra space. first and second may also be
'()
or#f
. As opposed toly:stencil-combine-at-edge
, metrics are suited for successively accumulating lines of stencils. Also, second stencil is drawn last.If mindist is specified, reference points are placed apart at least by this distance. If either of the stencils is spacing, padding and mindist do not apply.
- Function: ly:stencil-translate stil offset
Return a stil, but translated by offset (a pair of numbers).
- Function: ly:stencil-translate-axis stil amount axis
Return a copy of stil but translated by amount in axis direction.
- Function: stencil-whiteout stil . lambda*:G28
style, thickness and line-thickness are optional arguments. If set, style determines the shape of the white background. Given
'outline
the white background is produced bystencil-whiteout-outline
, given'rounded-box
it is produced bystencil-whiteout-box
with rounded corners, given other arguments (e.g.'box
) or when unspecified it defaults tostencil-whiteout-box
with square corners. If thickness is specified it determines how far, as a multiple of line-thickness, the white background extends past the extents of stencil stil. If thickness has not been specified, an appropriate default is chosen based on style.
- Function: stencil-whiteout-box stil . lambda*:G26
thickness is how far, as a multiple of line-thickness, the white outline extends past the extents of stencil stil.
- Function: stencil-whiteout-outline stil . lambda*:G24
This function works by creating a series of white or color stencils radially offset from the original stencil with angles from 0 to 2*pi, at an increment of
angle-inc
, and with radii fromradial-inc
to thickness. thickness is how big the white outline is, as a multiple of line-thickness. radial-increments is how many copies of the white stencil we make on our way out to thickness. angle-increments is how many copies of the white stencil we make between 0 and 2*pi.
- Function: straight-flag flag-thickness flag-spacing upflag-angle upflag-length downflag-angle downflag-length
Create a stencil for a straight flag. flag-thickness and flag-spacing are given in staff spaces, upflag-angle and downflag-angle are given in degrees, and upflag-length and downflag-length are given in staff spaces.
All lengths are scaled according to the font size of the note.
- Function: ly:string-percent-encode str
Encode all characters in string str with hexadecimal percent escape sequences, with the following exceptions: characters
-
,.
,/
, and_
; and characters in ranges0-9
,A-Z
, anda-z
.
- Function: style-note-heads heads style music
Set style for all heads in music. Works both inside of and outside of chord construct.
- Function: ly:system-font-load name
Load the OpenType system font ‘name.otf’. Fonts loaded with this command must contain three additional SFNT font tables called
LILC
,LILF
, andLILY
, needed for typesetting musical elements. Currently, only the Emmentaler and the Emmentaler-Brace fonts fulfill these requirements.Note that only
ly:font-get-glyph
and derived code (like\lookup
) can access glyphs from the system fonts; text strings are handled exclusively via the Pango interface.
- Function: tag-group-get tag
Return the tag group (as a list of symbols) that the given tag symbol belongs to,
#f
if none.
- Function: tags-keep-predicate tags
Returns a predicate that returns
#f
for any music that is to be removed by\keepWithTag
on the given symbol or list of symbols tags.
- Function: tags-remove-predicate tags
Returns a predicate that returns
#f
for any music that is to be removed by\removeWithTag
on the given symbol or list of symbols tags.
- Function: teaching-accidental-rule context pitch barnum measurepos
An accidental rule that typesets a cautionary accidental if it is included in the key signature and does not directly follow a note on the same staff line.
- Function: ly:text-interface::interpret-markup
Convert a text markup into a stencil. Takes three arguments, layout, props, and markup.
layout is a
\layout
block; it may be obtained from a grob withly:grob-layout
. props is an alist chain, i.e. a list of alists. This is typically obtained with(ly:grob-alist-chain grob (ly:output-def-lookup layout 'text-font-defaults))
. markup is the markup text to be processed.
- Function: ly:transform->list transform
Convert a transform matrix to a list of six values. Values are xx, yx, xy, yy, x0, y0.
- Function: ly:translate-cpp-warning-scheme str
Translates a string in C++ printf format and modifies it to use it for scheme formatting.
- Function: ly:translator-description creator
Return an alist of properties of translator definition creator.
- Function: ly:translator-name creator
Return the type name of the translator definition creator. The name is a symbol.
- Function: ly:ttf->pfa ttf-file-name idx
Convert the contents of a TrueType font file to PostScript Type 42 font, returning it as a string. The optional idx argument is useful for TrueType collections (TTC) only; it specifies the font index within the TTC. The default value of idx is 0.
- Function: ly:ttf-ps-name ttf-file-name idx
Extract the PostScript name from a TrueType font. The optional idx argument is useful for TrueType collections (TTC) only; it specifies the font index within the TTC. The default value of idx is 0.
- Function: ly:type1->pfa type1-file-name
Convert the contents of a Type 1 font in PFB format to PFA format. If the file is already in PFA format, pass through it.
- Function: unfold-repeats types music
Replace repeats of the types given by types with unfolded repeats. If types is an empty list,
repeated-music
is taken, unfolding all.
- Function: unfold-repeats-fully music
Unfolds repeats and expands the resulting
unfolded-repeated-music
.
- Function: unity-if-multimeasure context dur
Given a context and a duration, return
1
if the duration is longer than themeasureLength
in that context, and#f
otherwise. This supports historic use ofCompletion_heads_engraver
to splitc1*3
into three whole notes.
- Function: ly:unpure-call data grob rest
Convert property data (unpure-pure container or procedure) to value in an unpure context defined by grob and possibly rest arguments.
- Function: ly:version? op ver
Use operator op to compare the currently executed LilyPond version with a given version ver, which is passed as a list of numbers.
- Function: voicify-music m . lambda*:G79
Recursively split chords that are separated with
\\
. Optional id can be a list of context ids to use. If numeric, they also indicate a voice type override. If id is just a single number, that’s where numbering starts.
- Function: volta-bracket::calc-hook-visibility bar-glyph
Determine the visibility of the volta bracket end hook, returning
#t
if no hook should be drawn.
- Function: ly:volta-bracket::calc-shorten-pair grob
Calculate the
shorten-pair
values for an ideal placement of the volta brackets relative to the bar lines.
- Function: ly:warning str rest
A Scheme callable function to issue the warning str. The message is formatted with
format
and rest.
- Function: ly:warning-located location str rest
A Scheme callable function to issue the warning str at the specified location in an input file. The message is formatted with
format
and rest.
- Function: write-me message x
Return x. Display message and write x. Handy for debugging, possibly turned off.
[ << Tabelle del manuale della notazione ] | [Top][Contents][Index] | [ Schema riassuntivo >> ] |
[ < LilyPond exported predicates ] | [ Up : Tabelle del manuale della notazione ] | [ Schema riassuntivo > ] |