X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=ly%2Fmusic-functions-init.ly;h=e0b36696bab23c20eefaede5e1c1e634baa87faa;hb=e12188443ed992f223f0d7fd45965003de94588f;hp=8cfaa81d31bf4708cda3488e74a00efa60cc1df2;hpb=55ac733b69643a6bc6a83b706c65cb56efd388ef;p=lilypond.git diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly index 8cfaa81d31..e0b36696ba 100644 --- a/ly/music-functions-init.ly +++ b/ly/music-functions-init.ly @@ -18,7 +18,7 @@ %%%% You should have received a copy of the GNU General Public License %%%% along with LilyPond. If not, see . -\version "2.13.29" +\version "2.14.0" %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -38,18 +38,16 @@ acciaccatura = %% keep these two together "instrument-definitions" = #'() addInstrumentDefinition = -#(define-music-function +#(define-scheme-function (parser location name lst) (string? list?) (_i "Create instrument @var{name} with properties @var{list}.") - (set! instrument-definitions (acons name lst instrument-definitions)) - (make-music 'SequentialMusic 'void #t)) + (set! instrument-definitions (acons name lst instrument-definitions))) addQuote = -#(define-music-function (parser location name music) (string? ly:music?) +#(define-scheme-function (parser location name music) (string? ly:music?) (_i "Define @var{music} as a quotable music expression named @var{name}") - (add-quotable parser name music) - (make-music 'SequentialMusic 'void #t)) + (add-quotable parser name music)) %% keep these two together afterGraceFraction = #(cons 6 8) @@ -87,11 +85,25 @@ markups), or inside a score.") 'elements (list (make-music 'PageTurnEvent 'break-permission 'allow)))) +appendToTag = +#(define-music-function (parser location tag music more) + (symbol? ly:music? ly:music?) + (_i "Append @var{more} to the @code{elements} of all music +expressions in @var{music} that are tagged with @var{tag}.") + (music-map-copy (lambda (m) + (if (memq tag (ly:music-property m 'tags)) + (begin + (set! m (music-clone m)) + (set! (ly:music-property m 'elements) + (append (ly:music-property m 'elements) + (list more))))) + m) + music)) + applyContext = #(define-music-function (parser location proc) (procedure?) (_i "Modify context properties with Scheme procedure @var{proc}.") (make-music 'ApplyContext - 'origin location 'procedure proc)) applyMusic = @@ -103,7 +115,6 @@ applyOutput = #(define-music-function (parser location ctx proc) (symbol? procedure?) (_i "Apply function @code{proc} to every layout object in context @code{ctx}") (make-music 'ApplyOutputEvent - 'origin location 'procedure proc 'context-type ctx)) @@ -170,12 +181,11 @@ barNumberCheck = #(define-music-function (parser location n) (integer?) (_i "Print a warning if the current bar number is not @var{n}.") (make-music 'ApplyContext - 'origin location 'procedure (lambda (c) (let ((cbn (ly:context-property c 'currentBarNumber))) (if (and (number? cbn) (not (= cbn n))) - (ly:input-message location + (ly:input-warning location "Barcheck failed got ~a expect ~a" cbn n)))))) @@ -186,17 +196,15 @@ bendAfter = 'delta-step delta)) bookOutputName = -#(define-music-function (parser location newfilename) (string?) +#(define-scheme-function (parser location newfilename) (string?) (_i "Direct output for the current book block to @var{newfilename}.") - (set! book-filename newfilename) - (make-music 'SequentialMusic 'void #t)) + (set! book-filename newfilename)) bookOutputSuffix = -#(define-music-function (parser location newsuffix) (string?) +#(define-scheme-function (parser location newsuffix) (string?) (_i "Set the output filename suffix for the current book block to @var{newsuffix}.") - (set! book-output-suffix newsuffix) - (make-music 'SequentialMusic 'void #t)) + (set! book-output-suffix newsuffix)) %% \breathe is defined as a music function rather than an event identifier to %% ensure it gets useful input location information: as an event identifier, @@ -207,13 +215,39 @@ breathe = (_i "Insert a breath mark.") (make-music 'BreathingEvent)) - - clef = #(define-music-function (parser location type) (string?) (_i "Set the current clef to @var{type}.") (make-clef-set type)) + +compoundMeter = +#(define-music-function (parser location args) (pair?) + (_i "Create compound time signatures. The argument is a Scheme list of +lists. Each list describes one fraction, with the last entry being the +denominator, while the first entries describe the summands in the +enumerator. If the time signature consists of just one fraction, +the list can be given directly, i.e. not as a list containing a single list. +For example, a time signature of (3+1)/8 + 2/4 would be created as +@code{\\compoundMeter #'((3 1 8) (2 4))}, and a time signature of (3+2)/8 +as @code{\\compoundMeter #'((3 2 8))} or shorter +@code{\\compoundMeter #'(3 2 8)}.") + (let* ((mlen (calculate-compound-measure-length args)) + (beat (calculate-compound-base-beat args)) + (beatGrouping (calculate-compound-beat-grouping args)) + (timesig (cons (ly:moment-main-numerator mlen) + (ly:moment-main-denominator mlen)))) + #{ + \once \override Staff.TimeSignature #'stencil = #(lambda (grob) + (grob-interpret-markup grob (format-compound-time $args))) + \set Timing.timeSignatureFraction = $timesig + \set Timing.baseMoment = $beat + \set Timing.beatStructure = $beatGrouping + \set Timing.beamExceptions = #'() + \set Timing.measureLength = $mlen + #} )) + + cueClef = #(define-music-function (parser location type) (string?) (_i "Set the current cue clef to @var{type}.") @@ -317,13 +351,70 @@ featherDurations= argument)) +footnoteGrob = +#(define-music-function (parser location grob-name offset text footnote) + (symbol? number-pair? markup? markup?) + (_i "Attach @var{text} to @var{grob-name} at offset @var{offset}, +with @var{text} referring to @var{footnote} (use like @code{\\once})") + (make-music 'FootnoteEvent + 'automatically-numbered #f + 'symbol grob-name + 'X-offset (car offset) + 'Y-offset (cdr offset) + 'text text + 'footnote-text footnote)) + +autoFootnoteGrob = +#(define-music-function (parser location grob-name offset footnote) + (symbol? number-pair? markup?) + (_i "Footnote @var{grob-name} with the text in @var{footnote} +allowing for the footnote to be automatically numbered such that +the number appears at @var{offset}. Note that, for this to take effect, +auto-numbering must be turned on in the paper block. Otherwise, no +number will appear. Use like @code{\\once})") + (make-music 'FootnoteEvent + 'automatically-numbered #t + 'symbol grob-name + 'X-offset (car offset) + 'Y-offset (cdr offset) + 'text (make-null-markup) + 'footnote-text footnote)) +footnote = +#(define-music-function (parser location offset text footnote) + (number-pair? markup? markup?) + (_i "Attach @var{text} at @var{offset} with @var{text} referring +to @var{footnote} (use like @code{\\tweak})") + (make-music 'FootnoteEvent + 'automatically-numbered #f + 'X-offset (car offset) + 'Y-offset (cdr offset) + 'text text + 'footnote-text footnote)) + +autoFootnote = +#(define-music-function (parser location offset footnote) + (number-pair? markup?) + (_i "Footnote the item after which this comes with the text in +@var{footnote} allowing for the footnote to be automatically numbered +such that the number appears at @var{offset}. Note that, for this to +take effect, auto-numbering must be turned on in the paper block. +Otherwise, no number will appear. Use like @code{\\tweak})") + (make-music 'FootnoteEvent + 'automatically-numbered #t + 'X-offset (car offset) + 'Y-offset (cdr offset) + 'text (make-null-markup) + 'footnote-text footnote)) + grace = #(def-grace-function startGraceMusic stopGraceMusic (_i "Insert @var{music} as grace notes.")) harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?) + (_i "Convert @var{music} into harmonics; the resulting notes resemble +harmonics played on a fretted instrument by touching the strings above @var{fret}.") (let* ((fret (number->string fret)) (pitch (fret->pitch fret))) (make-sequential-music @@ -338,6 +429,9 @@ harmonicByFret = #(define-music-function (parser location fret music) (number? l #})))) harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?) + (_i "Convert @var{music} into harmonics; the resulting notes resemble +harmonics played on a fretted instrument by touching the strings above the point +given through @var{ratio}.") (let ((pitch (ratio->pitch ratio)) (fret (ratio->fret ratio))) (make-sequential-music @@ -360,7 +454,7 @@ instrumentSwitch = (instrument-def (if handle (cdr handle) '()))) (if (not handle) - (ly:input-message location "No such instrument: ~a" name)) + (ly:input-warning location "No such instrument: ~a" name)) (context-spec-music (make-music 'SimultaneousMusic 'elements @@ -409,27 +503,24 @@ label = language = -#(define-music-function (parser location language) (string?) +#(define-scheme-function (parser location language) (string?) (_i "Set note names for language @var{language}.") - (note-names-language parser language) - (make-music 'Music 'void #t)) + (note-names-language parser language)) languageSaveAndChange = -#(define-music-function (parser location language) (string?) +#(define-scheme-function (parser location language) (string?) (_i "Store the previous pitchnames alist, and set a new one.") (set! previous-pitchnames pitchnames) - (note-names-language parser language) - (make-music 'Music 'void #t)) + (note-names-language parser language)) languageRestore = -#(define-music-function (parser location) () +#(define-scheme-function (parser location) () (_i "Restore a previously-saved pitchnames alist.") (if previous-pitchnames (begin (set! pitchnames previous-pitchnames) (ly:parser-set-note-names parser pitchnames)) - (ly:warning (_ "No other language was defined previously. Ignoring."))) - (make-music 'Music 'void #t)) + (ly:input-warning location (_ "No other language was defined previously. Ignoring.")))) makeClusters = @@ -437,13 +528,36 @@ makeClusters = (_i "Display chords in @var{arg} as clusters.") (music-map note-to-cluster arg)) +modalInversion = +#(define-music-function (parser location around to scale music) + (ly:pitch? ly:pitch? ly:music? ly:music?) + (_i "Invert @var{music} about @var{around} using @var{scale} and +transpose from @var{around} to @var{to}.") + (let ((inverter (make-modal-inverter around to scale))) + (change-pitches music inverter) + music)) + +modalTranspose = +#(define-music-function (parser location from to scale music) + (ly:pitch? ly:pitch? ly:music? ly:music?) + (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to} +using @var{scale}.") + (let ((transposer (make-modal-transposer from to scale))) + (change-pitches music transposer) + music)) + +inversion = +#(define-music-function + (parser location around to music) (ly:pitch? ly:pitch? ly:music?) + (_i "Invert @var{music} about @var{around} and +transpose from @var{around} to @var{to}.") + (music-invert around to music)) + musicMap = #(define-music-function (parser location proc mus) (procedure? ly:music?) (_i "Apply @var{proc} to @var{mus} and all of the music it contains.") (music-map proc mus)) - - %% noPageBreak and noPageTurn are music functions (not music indentifiers), %% because music identifiers are not allowed at top-level. noPageBreak = @@ -469,11 +583,10 @@ markups), or inside a score.") octaveCheck = -#(define-music-function (parser location pitch-note) (ly:music?) +#(define-music-function (parser location pitch) (ly:pitch?) (_i "Octave check.") (make-music 'RelativeOctaveCheck - 'origin location - 'pitch (pitch-of-note pitch-note))) + 'pitch pitch)) ottava = #(define-music-function (parser location octave) (integer?) @@ -514,7 +627,6 @@ or @code{\"GrobName\"}.") (set! context-name (string->symbol (list-ref name-components 0))))) (make-music 'ApplyOutputEvent - 'origin location 'context-type context-name 'procedure (lambda (grob orig-context context) @@ -556,7 +668,7 @@ pageTurn = 'break-permission 'force)))) parallelMusic = -#(define-music-function (parser location voice-ids music) (list? ly:music?) +#(define-scheme-function (parser location voice-ids music) (list? ly:music?) (_i "Define parallel music sequences, separated by '|' (bar check signs), and assign them to the identifiers provided in @var{voice-ids}. @@ -607,7 +719,7 @@ Example: (and (not (null? origins)) (car origins))))))) ;; ;; first, split the music and fill in voices - (map-in-order (lambda (m) + (for-each (lambda (m) (push-music m) (if (bar-check? m) (change-voice))) (ly:music-property music 'elements)) @@ -631,20 +743,18 @@ Example: (let ((moment-reference (ly:music-length (car seqs)))) (for-each (lambda (seq moment) (if (not (equal? moment moment-reference)) - (ly:music-message seq + (ly:music-warning seq "Bars in parallel music don't have the same length"))) seqs (map-in-order ly:music-length seqs)))) voices) ;; ;; bind voice identifiers to the voices - (map (lambda (voice-id voice) + (for-each (lambda (voice-id voice) (ly:parser-define! parser voice-id (make-music 'SequentialMusic 'origin location 'elements voice))) - voice-ids voices)) - ;; Return an empty sequence. This function is actually a "void" function. - (make-music 'SequentialMusic 'void #t)) + voice-ids voices))) parenthesize = #(define-music-function (parser loc arg) (ly:music?) @@ -653,7 +763,7 @@ parenthesize = (if (memq 'event-chord (ly:music-property arg 'types)) ;; arg is an EventChord -> set the parenthesize property ;; on all child notes and rests - (map + (for-each (lambda (ev) (if (or (memq 'note-event (ly:music-property ev 'types)) (memq 'rest-event (ly:music-property ev 'types))) @@ -690,6 +800,18 @@ partcombineSoloIIOnce = \partcombineForce #'solo2 ##t partcombineAutomatic = \partcombineForce ##f ##f partcombineAutomaticOnce = \partcombineForce ##f ##t +partial = +#(define-music-function (parser location dur) (ly:duration?) + (_i "Make a partial measure.") + + ;; We use `descend-to-context' here instead of `context-spec-music' to + ;; ensure \partial still works if the Timing_translator is moved + (descend-to-context + (context-spec-music (make-music 'PartialSet + 'origin location + 'partial-duration dur) + 'Timing) + 'Score)) pitchedTrill = #(define-music-function @@ -714,7 +836,7 @@ print @var{secondary-note} as a stemless note head in parentheses.") (for-each (lambda (m) (ly:music-set-property! m 'pitch trill-pitch)) trill-events) (begin - (ly:warning (_ "Second argument of \\pitchedTrill should be single note: ")) + (ly:input-warning location (_ "Second argument of \\pitchedTrill should be single note: ")) (display sec-note-events))) (if (eq? forced #t) @@ -723,6 +845,20 @@ print @var{secondary-note} as a stemless note head in parentheses.") trill-events))))) main-note)) +pushToTag = +#(define-music-function (parser location tag music more) + (symbol? ly:music? ly:music?) + (_i "Add @var{more} to the front of @code{elements} of all music +expressions in @var{music} that are tagged with @var{tag}.") + (music-map-copy (lambda (m) + (if (memq tag (ly:music-property m 'tags)) + (begin + (set! m (music-clone m)) + (set! (ly:music-property m 'elements) + (cons more (ly:music-property m 'elements))))) + m) + music)) + quoteDuring = #(define-music-function (parser location what main-music) (string? ly:music?) (_i "Indicate a section of music to be quoted. @var{what} indicates the name @@ -731,8 +867,7 @@ of the quoted voice, as specified in an @code{\\addQuote} command. usually contains spacers or multi-measure rests.") (make-music 'QuoteMusic 'element main-music - 'quoted-music-name what - 'origin location)) + 'quoted-music-name what)) removeWithTag = #(define-music-function (parser location tag music) (symbol? ly:music?) @@ -745,18 +880,18 @@ removeWithTag = music)) resetRelativeOctave = -#(define-music-function (parser location reference-note) (ly:music?) +#(define-music-function (parser location pitch) (ly:pitch?) (_i "Set the octave inside a \\relative section.") - (let* ((notes (ly:music-property reference-note 'elements)) - (pitch (ly:music-property (car notes) 'pitch))) - - (set! (ly:music-property reference-note 'elements) '()) - (set! (ly:music-property reference-note 'to-relative-callback) - (lambda (music last-pitch) - pitch)) + (make-music 'SequentialMusic + 'to-relative-callback + (lambda (music last-pitch) pitch))) - reference-note)) +retrograde = +#(define-music-function (parser location music) + (ly:music?) + (_i "Return @var{music} in reverse order.") + (retrograde-music music)) revertTimeSignatureSettings = #(define-music-function @@ -771,16 +906,11 @@ rightHandFinger = #(define-music-function (parser location finger) (number-or-string?) (_i "Apply @var{finger} as a fingering indication.") - (apply make-music - (append - (list - 'StrokeFingerEvent - 'origin location) - (if (string? finger) - (list 'text finger) - (list 'digit finger))))) - - + (make-music + 'StrokeFingerEvent + 'origin location + (if (string? finger) 'text 'digit) + finger)) scaleDurations = #(define-music-function (parser location fraction music) @@ -792,12 +922,24 @@ scaleDurations = shiftDurations = #(define-music-function (parser location dur dots arg) (integer? integer? ly:music?) - (_i "Scale @var{arg} up by a factor of @var{2^dur*(2-(1/2)^dots)}.") + (_i "Scale @var{arg} up by a factor of 2^@var{dur}*(2-(1/2)^@var{dots}).") (music-map (lambda (x) (shift-one-duration-log x dur dots)) arg)) +skip = +#(define-music-function (parser location dur) (ly:duration?) + (_i "Skip forward by @var{dur}.") + (make-music 'SkipMusic + 'duration dur)) + + +slashedGrace = +#(def-grace-function startSlashedGraceMusic stopSlashedGraceMusic + (_i "Create slashed graces (slashes through stems, but no slur) from +the following music expression")) + spacingTweaks = #(define-music-function (parser location parameters) (list?) (_i "Set the system stretch, by reading the 'system-stretch property of @@ -834,13 +976,22 @@ tag = (ly:music-property arg 'tags))) arg) +transpose = +#(define-music-function + (parser location from to music) + (ly:pitch? ly:pitch? ly:music?) + + (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.") + (make-music 'TransposedMusic + 'element (ly:music-transpose music (ly:pitch-diff to from)))) + transposedCueDuring = #(define-music-function - (parser location what dir pitch-note main-music) - (string? ly:dir? ly:music? ly:music?) + (parser location what dir pitch main-music) + (string? ly:dir? ly:pitch? ly:music?) (_i "Insert notes from the part @var{what} into a voice called @code{cue}, -using the transposition defined by @var{pitch-note}. This happens +using the transposition defined by @var{pitch}. This happens simultaneously with @var{main-music}, which is usually a rest. The argument @var{dir} determines whether the cue notes should be notated as a first or second voice.") @@ -851,16 +1002,15 @@ as a first or second voice.") 'quoted-context-id "cue" 'quoted-music-name what 'quoted-voice-direction dir - 'quoted-transposition (pitch-of-note pitch-note) - 'origin location)) + 'quoted-transposition pitch)) transposition = -#(define-music-function (parser location pitch-note) (ly:music?) +#(define-music-function (parser location pitch) (ly:pitch?) (_i "Set instrument transposition") (context-spec-music (make-property-set 'instrumentTransposition - (ly:pitch-negate (pitch-of-note pitch-note))) + (ly:pitch-negate pitch)) 'Staff)) tweak = @@ -870,7 +1020,7 @@ tweak = (if (equal? (object-property sym 'backend-type?) #f) (begin - (ly:warning (_ "cannot find property type-check for ~a") sym) + (ly:input-warning location (_ "cannot find property type-check for ~a") sym) (ly:warning (_ "doing assignment anyway")))) (set! (ly:music-property arg 'tweaks)