Node: Scheme functions, Next: , Previous: Backend, Up: Top



Scheme functions

ly:add-interface a b c Function
Add an interface description.

ly:add-moment a b Function
Add two moments.

ly:all-grob-interfaces Function
Get a hash table with all interface descriptions.

ly:bracket a iv t p Function
Make a bracket in direction a. The extent of the bracket is given by iv. The wings protude by an amount of p, which may be negative. The thickness is given by t.

ly:context-find context name Function
Find a parent of context that has name or alias name. Return #f if not found.

ly:context-id context Function
Return the id string of context, i.e. for \context Voice = one .. return the string one.

ly:context-name context Function
Return the name of context, i.e. for \context Voice = one .. return the symbol Voice.

ly:context-parent context Function
Return the parent of context, #f if none.

ly:context-property c name Function
Return the value of name from context c

ly:context-property-where-defined context name Function
Return the context above context where name is defined.

ly:context-pushpop-property context grob eltprop val Function
Do a single \override or \revert operation in context. The grob definition grob is extended with eltprop (if val is specified) or reverted (if unspecified).

ly:context-set-property! context name val Function
Set value of property name in context context to val.

ly:context-unset-property context name Function
Unset value of property name in context context.

ly:context? x Function
Is x a Context object?

ly:dimension? d Function
Return d is a number. Used to distinguish length variables from normal numbers.

ly:dir? s Function
type predicate. A direction is -1, 0 or 1, where -1 represents left or down and 1 represents right or up.

ly:div-moment a b Function
Divide two moments.

ly:duration-dot-count dur Function
Extract the dot count from dur

ly:duration-factor dur Function
Extract the compression factor from dur. Return as a pair.

ly:duration-log dur Function
Extract the duration log from dur

ly:duration<? p1 p2 Function
Is p1 shorter than p2?

ly:duration? x Function
Is x a Duration object?

ly:export arg Function
Export a Scheme object to the parser, so it is treated as an identifier.

ly:find-glyph-by-name font name Function
This function retrieves a Stencil for the glyph named name in font. The font must be available as an AFM file. If the glyph is not found, #f is returned.

ly:font-metric? x Function
Is x a Font_metric object?

ly:fontify-atom met f Function
Add a font selection command for the font metric met to f.

ly:format-output context outname Function
Given a Score context in its final state,process it and return the (rendered) result.

ly:get-all-function-documentation Function
Get a hash table with all lilypond Scheme extension functions.

ly:get-all-translators Function
Return a list of all translator objects that may be instantiated.

ly:get-default-font grob Function
Return the default font for grob gr.

ly:get-glyph font index Function
This function retrieves a Stencil for the glyph numbered index in font.

ly:get-option var Function
Get a global option setting. Supported options include
old-relative-used
Report whether old-relative compatibility mode is necessary
old-relative
Report whether old-relative compatibility mode is used
verbose
Report whether we are running in verbose mode

ly:grob-alist-chain g global Function
Get an alist chain for grob g, with global as the global default. If unspecified, font-defaults from the paper block is taken.

ly:grob-extent grob refp axis Function
Get the extent in axis direction of grob relative to the grob refp

ly:grob-original grob Function
Return the unbroken original Grob of grob.

ly:grob-paper g Function
Get \paper definition from grob g.

ly:grob-parent grob axis Function
Get the parent of grob. axis is 0 for the X-axis, 1 for the Y-axis.

ly:grob-pq-less? a b Function
Compare 2 grob priority queue entries. Internal

ly:grob-property grob sym Function
Return the value of a value in grob g of property sym. It will return ' () (end-of-list) if sym is undefined in g.

ly:grob-script-priority-less a b Function
Compare two grobs by script priority. For internal use.

ly:grob-set-property! grob sym val Function
Set sym in grob grob to value val

ly:grob-staff-position sg Function
Return the Y-position of sg relative to the staff.

ly:grob-suicide g Function
Kill g.

ly:grob-system g Function
Return the System Grob of g.

ly:grob-translate-axis! g d a Function
Translate g on axis a over distance d.

ly:grob? x Function
Is x a Grob object?

ly:gulp-file name Function
Read the file name, and return its contents in a string. The file is looked up using the search path.

ly:input-location sip Function
Return input location in sip as (filename line column).

ly:input-location? x Function
Return #t if x is an input location.

ly:input-message sip msg Function
Print msg as a GNU compliant error message, pointing to thelocation in sip.

ly:intlog2 d Function
The 2-logarithm of 1/d.

ly:item-break-dir it Function
The break status dir of item it. -1 is end of line, 0 unbroken, and 1 begin of line.

ly:item? g Function
Is g an Item object?

ly:iterator? x Function
Is x a Music_iterator object?

ly:make-bare-music type props Function
Make a C++ music object of type type, initialize with props.

This function is for internal use, and is only called by make-music, which is the preferred interface for creating music objects.

ly:make-duration length dotcount num den Function
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 num and den.

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.

ly:make-moment n d gn gd Function
Create the rational number with main timing n/d, and optional grace timin gn/gd.

Moment is a point in musical time. It is 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.

ly:make-pitch octave note alter Function
octave is specified by an integer, zero for the octave containing middle C. note is a number from 0 to 6, with 0 corresponding to C and 6 corresponding to B. The alter is zero for a natural, negative for flats, or positive for sharps.

ly:make-stencil expr xext yext Function

Stencils are a device independent output expressions.They carry two pieces of information:

1: a specification of how to print this object. This specification is processed by the output backends, for example scm/output-tex.scm.

2: the vertical and horizontal extents of the object.

ly:moment<? a b Function
Compare two moments.

ly:moment? x Function
Is x a Moment object?

ly:mul-moment a b Function
Multiply two moments.

ly:music-compress m factor Function
Compress music object m by moment factor.

ly:music-deep-copy m Function
Copy m and all sub expressions of m

ly:music-duration-compress mus fact Function
Compress mus by factor fact, which is a Moment.

ly:music-duration-length mus Function
Extract the duration field from mus, and return the length.

ly:music-length mus Function
Get the length of music expression mus, and return as a Moment object.

ly:music-list? lst Function
Type predicate: return true if lst is a list of music objects.

ly:music-mutable-properties mus Function
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.

ly:music-name mus Function
Return the name of music.

ly:music-property mus sym Function
Get the property sym of music expression mus. If sym is undefined, return ' ().

ly:music-set-property! mus sym val Function
Set property sym in music expression mus to val.

ly:music-transpose m p Function
Transpose m such that central C is mapped to p. Return m.

ly:music? x Function
Is x a Music object?

ly:number->string s Function
Convert num to a string without generating many decimals.

ly:option-usage Function
Print ly-set-option usage

ly:output-def-clone def Function
Clone def.

ly:output-def-scope def Function
Get the variable scope inside def.

ly:paper-book? x Function
Is x a Paper_book object?

ly:paper-def? def Function
Is def a paper definition?

ly:paper-get-font paper chain Function
Return a font metric satisfying the font-qualifiers in the alist chain chain. (An alist chain is a list of alists, containing grob properties).

ly:paper-get-number paper name Function
Return the paper variable name.

ly:paper-line-break-score line Function
Return the score for breaking after line.

ly:paper-line-height line Function
Return the height of line.

ly:paper-line-number line Function
Return the number of line.

ly:paper-line? x Function
Is x a Paper_line object?

ly:paper-lookup pap sym Function
Lookup sym in pap. Return the value or '() if undefined.

ly:pitch-alteration pp Function
Extract the alteration from pitch p.

ly:pitch-diff pitch root Function
Return pitch delta such that pitch transposed by delta equals root

ly:pitch-notename pp Function
Extract the note name from pitch pp.

ly:pitch-octave pp Function
Extract the octave from pitch p.

ly:pitch-quartertones pp Function
Calculate the number of quarter tones of p from middle C.

ly:pitch-semitones pp Function
calculate the number of semitones of p from middle C.

ly:pitch-steps p Function
Number of steps counted from middle C of the pitch p.

ly:pitch-transpose p delta Function
Transpose p by the amount delta, where delta is relative to middle C.

ly:pitch<? p1 p2 Function
Is p1 lexicographically smaller than p2?

ly:pitch? x Function
Is x a Pitch object?

ly:protects Function
Return hash of protected objects.

ly:ragged-page-breaks lines book text first last Function
Return a vector with line numbers of page breaks.

ly:round-filled-box xext yext blot Function
Make a Stencil that prints a black box of dimensions xext, yext and roundness blot.

ly:run-translator mus output-def Function
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.

ly:set-option var val Function
Set a global option value. Supported options include
help
List all options.
midi-debug
If set to true, generate human readable MIDI
internal-type-checking
Set paranoia for property assignments
parse-protect
If protection is switched on, errors in inline scheme are caught in the parser. If off, GUILE will halt on errors, and give a stack trace. Default is protected evaluation.
old-relative
Relative for simultaneous music functions similar to chord syntax
new-relative
Relative for simultaneous music functions similar to sequential music

This function is useful to call from the command line: lilypond -e "(ly-set-option 'midi-debug #t)".

ly:set-point-and-click what Function
Set the options for Point-and-click source specials output. The argument is a symbol. Possible options are none (no source specials), line and line-column

ly:spanner-broken-into spanner Function
Return broken-into list for spanner.

ly:spanner-get-bound slur dir Function
Get one of the bounds of spanner. dir is -1 for left, and 1 for right.

ly:spanner? g Function
Is g a spanner object?

ly:stencil-add args Function
Combine stencils. Takes any number of arguments.

ly:stencil-align-to! stil axis dir Function
Align stil using its own extents. dir is a number -1, 1 are left and right respectively. Other values are interpolated (so 0 means the center.

ly:stencil-combine-at-edge first axis direction second padding minimum Function
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. If this puts the reference points closer than minimum, they are moved by the latter amount.

ly:stencil-extent stil axis Function
Return a pair of numbers signifying the extent of stil in axis direction (0 or 1 for x and y axis respectively).

ly:stencil-get-expr stil Function
Return the expression of stil.

ly:stencil-moved-to-edge first axis direction second padding minimum Function
Similar to ly:stencil-combine-edge, but returns second positioned to be next to first.

ly:stencil-set-extent! stil axis np Function
Set the extent of stil (extent must be a pair of numbers) in axis direction (0 or 1 for x- and y-axis respectively).

ly:stencil-translate stil offset Function
Return a stil, but translated by offset (a pair of numbers).

ly:stencil-translate-axis stil amount axis Function
Return a copy of stil but translated by amount in axis direction.

ly:stencil? x Function
Is x a Stencil object?

ly:text-dimension font text Function
Given the font metric in font and the string text, compute the extents of that text in that font. The return value is a pair of number-pairs.

ly:translator-description me Function
Return an alist of properties of translator me.

ly:translator-name trans Function
Return the type name of the translator object trans. The name is a symbol.

ly:translator? x Function
Is x a Translator object?

ly:transpose-key-alist l pit Function
Make a new key alist of l transposed by pitch pit

ly:unit Function
Return the unit used for lengths as a string.

ly:version Function
Return the current lilypond version as a list, e.g. (1 3 127 uu1).

ly:warn str Function
Scheme callable function to issue the warning msg.

Read comments on this page, or add one.

This page is for LilyPond-2.2.0 (stable-branch).

Report errors to <bug-lilypond@gnu.org>.