X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=ly%2Fmusic-functions-init.ly;h=9036f61e94d3a59ca7ee58032ff311e69abd85c8;hb=53e6d49;hp=3b272121175121e7eec84cbc7af0310155ec1fe0;hpb=569714401fbe0e814f0282059f157aa36a54c706;p=lilypond.git diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly index 3b27212117..9036f61e94 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.15.18" +\version "2.16.0" %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -36,7 +36,7 @@ acciaccatura = (_i "Create an acciaccatura from the following music expression")) %% keep these two together -"instrument-definitions" = #'() +instrument-definitions = #'() addInstrumentDefinition = #(define-void-function (parser location name lst) (string? list?) @@ -85,6 +85,26 @@ markups), or inside a score.") 'elements (list (make-music 'PageTurnEvent 'break-permission 'allow)))) +alterBroken = +#(define-music-function (parser location name property arg) + (symbol-list? symbol? list?) + (_i "Override @var{property} for pieces of broken spanner @var{name} with +values @var{arg}.") + ;; only apply override if grob is a spanner + (let ((description + (assoc-get (last name) all-grob-descriptions))) + (if (and description + (member 'spanner-interface + (assoc-get 'interfaces + (assoc-get 'meta description)))) + #{ + \override $name $property = + #(value-for-spanner-piece arg) + #} + (begin + (ly:input-warning location (_ "not a spanner name, `~a'") name) + (make-music 'SequentialMusic 'void #t))))) + appendToTag = #(define-music-function (parser location tag more music) (symbol? ly:music? ly:music?) @@ -178,7 +198,7 @@ barNumberCheck = cbn n)))))) bendAfter = -#(define-music-function (parser location delta) (real?) +#(define-event-function (parser location delta) (real?) (_i "Create a fall or doit of pitch interval @var{delta}.") (make-music 'BendAfterEvent 'delta-step delta)) @@ -227,7 +247,7 @@ as @code{\\compoundMeter #'((3 2 8))} or shorter (ly:moment-main-denominator mlen)))) #{ \once \override Staff.TimeSignature #'stencil = #(lambda (grob) - (grob-interpret-markup grob (format-compound-time args))) + (grob-interpret-markup grob (format-compound-time args))) \set Timing.timeSignatureFraction = $timesig \set Timing.baseMoment = $beat \set Timing.beatStructure = $beatGrouping @@ -235,11 +255,22 @@ as @code{\\compoundMeter #'((3 2 8))} or shorter \set Timing.measureLength = $mlen #} )) +crossStaff = +#(define-music-function (parser location notes) (ly:music?) + (_i "Create cross-staff stems") + #{ + \override Stem #'cross-staff = #cross-staff-connect + \override Flag #'style = #'no-flag + $notes + \revert Stem #'cross-staff + \revert Flag #'style +#}) cueClef = #(define-music-function (parser location type) (string?) (_i "Set the current cue clef to @var{type}.") (make-cue-clef-set type)) + cueClefUnset = #(define-music-function (parser location) () (_i "Unset the current cue clef.") @@ -293,27 +324,22 @@ endSpanners = #(define-music-function (parser location music) (ly:music?) (_i "Terminate the next spanner prematurely after exactly one note without the need of a specific end spanner.") - (if (memq (ly:music-property music 'name) '(EventChord NoteEvent)) - (let* ((start-span-evs (filter (lambda (ev) - (equal? (ly:music-property ev 'span-direction) - START)) - (extract-typed-music music 'span-event))) - (stop-span-evs - (map (lambda (m) - (let ((c (music-clone m))) - (set! (ly:music-property c 'span-direction) STOP) - c)) - start-span-evs)) - (end-ev-chord (make-music 'EventChord - 'elements stop-span-evs)) - (total (make-music 'SequentialMusic - 'elements (list music - end-ev-chord)))) - total) - - (begin - (ly:input-message location (_ "argument endSpanners is not an EventChord: ~a") music) - music))) + (let* ((start-span-evs (filter (lambda (ev) + (equal? (ly:music-property ev 'span-direction) + START)) + (extract-typed-music music 'span-event))) + (stop-span-evs + (map (lambda (m) + (let ((c (music-clone m))) + (set! (ly:music-property c 'span-direction) STOP) + c)) + start-span-evs)) + (end-ev-chord (make-music 'EventChord + 'elements stop-span-evs)) + (total (make-music 'SequentialMusic + 'elements (list music + end-ev-chord)))) + total)) eventChords = #(define-music-function (parser location music) (ly:music?) @@ -342,23 +368,49 @@ featherDurations= argument)) footnote = -#(define-music-function (parser location text offset grob-name footnote) - ((markup?) number-pair? (symbol? '()) markup?) - (_i "Attach @var{text} at @var{offset} with @var{text} referring to -@var{footnote}. If @var{text} is given as @code{\\default}, use -autonumbering instead. Note that, for this to take effect, -auto-numbering must be turned on in the paper block. Otherwise, no -number will appear. Footnotes are applied like articulations. If a -symbol @var{grob-name} is specified, all grobs of that kind at the -current time step are affected.") - (make-music - 'FootnoteEvent - 'X-offset (car offset) - 'Y-offset (cdr offset) - 'automatically-numbered (not text) - 'text (or text (make-null-markup)) - 'footnote-text footnote - 'symbol grob-name)) +#(define-music-function (parser location mark offset grob-name footnote music) + ((markup?) number-pair? (symbol?) markup? (ly:music?)) + (_i "Make the markup @var{footnote} a footnote on @var{music}. The +footnote is marked with a markup @var{mark} moved by @var{offset} with +respect to the marked music. + +If @var{mark} is not given or specified as @var{\\default}, it is +replaced by an automatically generated sequence number. If a symbol +@var{grob-name} is specified, then grobs of that type will be marked +if they have @var{music} as their ultimate cause; by default all grobs +having @var{music} as their @emph{direct} cause will be marked, +similar to the way @code{\\tweak} works. + +If @var{music} is given as @code{\\default}, a footnote event +affecting @emph{all} grobs matching @var{grob-name} at a given time +step is generated. This may be required for creating footnotes on +time signatures, clefs, and other items not cooperating with +@code{\\tweak}. + +Like with @code{\\tweak}, if you use a footnote on a following +post-event, the @code{\\footnote} command itself needs to be attached +to the preceding note or rest as a post-event with @code{-}.") + (let ((mus (make-music + 'FootnoteEvent + 'X-offset (car offset) + 'Y-offset (cdr offset) + 'automatically-numbered (not mark) + 'text (or mark (make-null-markup)) + 'footnote-text footnote + 'symbol (or grob-name '())))) + (cond (music + (set! (ly:music-property music 'tweaks) + (acons (if grob-name + (cons grob-name 'footnote-music) + 'footnote-music) + mus + (ly:music-property music 'tweaks))) + music) + (grob-name mus) + (else + (ly:input-warning location + (_ "\\footnote requires music or grob-name")) + (make-music 'Music))))) grace = #(def-grace-function startGraceMusic stopGraceMusic @@ -374,37 +426,69 @@ in the format of @code{all-grob-descriptions}.") descriptions))) 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 - (list - #{ - \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label fret) - #} - (make-harmonic - (calc-harmonic-pitch pitch music)) - #{ - \revert TabNoteHead #'stencil - #})))) + (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble +harmonics played on a fretted instrument by touching the strings at @var{fret}.") + #{ + \set harmonicDots = ##t + \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label (number->string fret)) + \override NoteHead #'Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height + (lambda (grob start end) + (ly:grob::stencil-height grob))) + \override NoteHead #'stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed) + (ly:note-head::print grob)) + $(make-harmonic + (calc-harmonic-pitch (fret->pitch (number->string fret)) music)) + \unset harmonicDots + \revert TabNoteHead #'stencil + \revert NoteHead #'Y-extent + \revert NoteHead #'stencil + #}) 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 + (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble +harmonics played on a fretted instrument by touching the strings at the point given through @var{ratio}.") - (let ((pitch (ratio->pitch ratio)) - (fret (ratio->fret ratio))) - (make-sequential-music - (list - #{ - \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label fret) - #} - (make-harmonic - (calc-harmonic-pitch pitch music)) - #{ - \revert TabNoteHead #'stencil - #})))) + #{ + \set harmonicDots = ##t + \override TabNoteHead #'stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio)) + \override NoteHead #'Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height + (lambda (grob start end) + (ly:grob::stencil-height grob))) + \override NoteHead #'stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed) + (ly:note-head::print grob)) + $(make-harmonic + (calc-harmonic-pitch (ratio->pitch ratio) music)) + \unset harmonicDots + \revert TabNoteHead #'stencil + \revert NoteHead #'Y-extent + \revert NoteHead #'stencil + #}) + +hide = +#(define-music-function (parser location item) (symbol-list-or-music?) + (_i "Set @var{item}'s @samp{transparent} property to @code{#t}, +making it invisible while still retaining its dimensions. + +If @var{item} is a symbol list of form @code{GrobName} or +@code{Context.GrobName}, the result is an override for the grob name +specified by it. If @var{item} is a music expression, the result is +the same music expression with an appropriate tweak applied to it.") + (if (ly:music? item) + #{ \tweak #'transparent ##t $item #} + #{ \override $item #'transparent = ##t #})) + +inStaffSegno = +#(define-music-function (parser location) () + (_i "Put the segno variant 'varsegno' at this position into the staff, +compatible with the repeat command.") + (make-music 'ApplyContext + 'procedure + (lambda (ctx) + (let ((score-ctx (ly:context-find ctx 'Score))) + (if (ly:context? score-ctx) + (let ((old-rc (ly:context-property score-ctx 'repeatCommands '()))) + (if (eq? (memq 'segno-display old-rc) #f) + (ly:context-set-property! score-ctx 'repeatCommands (cons 'segno-display old-rc))))))))) instrumentSwitch = #(define-music-function @@ -582,6 +666,19 @@ octaveCheck = (make-music 'RelativeOctaveCheck 'pitch pitch)) +omit = +#(define-music-function (parser location item) (symbol-list-or-music?) + (_i "Set @var{item}'s @samp{stencil} property to @code{#f}, +effectively omitting it without taking up space. + +If @var{item} is a symbol list of form @code{GrobName} or +@code{Context.GrobName}, the result is an override for the grob name +specified by it. If @var{item} is a music expression, the result is +the same music expression with an appropriate tweak applied to it.") + (if (ly:music? item) + #{ \tweak #'stencil ##f $item #} + #{ \override $item #'stencil = ##f #})) + once = #(define-music-function (parser location music) (ly:music?) (_i "Set @code{once} to @code{#t} on all layout instruction events in @var{music}.") @@ -616,30 +713,27 @@ of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.") overrideProperty = #(define-music-function (parser location name property value) - (string? symbol? scheme?) + (symbol-list? symbol? scheme?) (_i "Set @var{property} to @var{value} in all grobs named @var{name}. -The @var{name} argument is a string of the form @code{\"Context.GrobName\"} -or @code{\"GrobName\"}.") - - (let ((name-components (string-split name #\.)) - (context-name 'Bottom) - (grob-name #f)) +The @var{name} argument is a symbol list of the form @code{Context.GrobName} +or @code{GrobName}.") + (if (<= 1 (length name) 2) + (make-music 'ApplyOutputEvent + 'context-type (if (null? (cdr name)) 'Bottom + (car name)) + 'procedure + (lambda (grob orig-context context) + (if (equal? + (cdr (assoc 'name (ly:grob-property grob 'meta))) + (last name)) + (set! (ly:grob-property grob property) value)))) + (begin + (ly:parser-error parser (_ "bad grob name") location) + (make-music 'Music)))) + - (if (> 2 (length name-components)) - (set! grob-name (string->symbol (car name-components))) - (begin - (set! grob-name (string->symbol (list-ref name-components 1))) - (set! context-name (string->symbol (list-ref name-components 0))))) - (make-music 'ApplyOutputEvent - 'context-type context-name - 'procedure - (lambda (grob orig-context context) - (if (equal? - (cdr (assoc 'name (ly:grob-property grob 'meta))) - grob-name) - (set! (ly:grob-property grob property) value)))))) @@ -946,7 +1040,7 @@ for time signatures of @var{time-signature}.") (revert-time-signature-setting time-signature)) rightHandFinger = -#(define-music-function (parser location finger) (number-or-string?) +#(define-event-function (parser location finger) (number-or-string?) (_i "Apply @var{finger} as a fingering indication.") (make-music @@ -982,24 +1076,85 @@ a context modification duplicating their effect.") (list 'unset (ly:music-property m 'symbol))) ((OverrideProperty) - (list 'push - (ly:music-property m 'symbol) - (ly:music-property m 'grob-value) - (ly:music-property m 'grob-property-path))) + (cons* 'push + (ly:music-property m 'symbol) + (ly:music-property m 'grob-value) + (cond + ((ly:music-property m 'grob-property #f) => list) + (else + (ly:music-property m 'grob-property-path))))) ((RevertProperty) - (list 'pop - (ly:music-property m 'symbol) - (ly:music-property m 'grob-property-path))))) + (cons* 'pop + (ly:music-property m 'symbol) + (cond + ((ly:music-property m 'grob-property #f) => list) + (else + (ly:music-property m 'grob-property-path))))))) (case (ly:music-property m 'name) - ((SequentialMusic SimultaneousMusic) - (for-each musicop (ly:music-property m 'elements))) + ((ApplyContext) + (ly:add-context-mod mods + (list 'apply + (ly:music-property m 'procedure)))) ((ContextSpeccedMusic) (if (or (not ctx) (eq? ctx (ly:music-property m 'context-type))) - (musicop (ly:music-property m 'element))))))) + (musicop (ly:music-property m 'element)))) + (else + (let ((callback (ly:music-property m 'elements-callback))) + (if (procedure? callback) + (for-each musicop (callback m)))))))) (musicop music) mods)) +shape = +#(define-music-function (parser location offsets item) + (list? symbol-list-or-music?) + (_i "Offset control-points of @var{item} by @var{offsets}. The +argument is a list of number pairs or list of such lists. Each +element of a pair represents an offset to one of the coordinates of a +control-point. If @var{item} is a string, the result is +@code{\\once\\override} for the specified grob type. If @var{item} is +a music expression, the result is the same music expression with an +appropriate tweak applied.") + (define (shape-curve grob) + (let* ((orig (ly:grob-original grob)) + (siblings (if (ly:spanner? grob) + (ly:spanner-broken-into orig) '())) + (total-found (length siblings)) + (function (assoc-get 'control-points + (reverse (ly:grob-basic-properties grob)))) + (coords (function grob))) + + (define (offset-control-points offsets) + (if (null? offsets) + coords + (map + (lambda (x y) (coord-translate x y)) + coords offsets))) + + (define (helper sibs offs) + (if (pair? offs) + (if (eq? (car sibs) grob) + (offset-control-points (car offs)) + (helper (cdr sibs) (cdr offs))) + coords)) + + ;; we work with lists of lists + (if (or (null? offsets) + (not (list? (car offsets)))) + (set! offsets (list offsets))) + + (if (>= total-found 2) + (helper siblings offsets) + (offset-control-points (car offsets))))) + (if (ly:music? item) + #{ + \tweak #'control-points #shape-curve $item + #} + #{ + \once \override $item #'control-points = #shape-curve + #})) + shiftDurations = #(define-music-function (parser location dur dots arg) (integer? integer? ly:music?) @@ -1010,6 +1165,31 @@ shiftDurations = (lambda (x) (shift-one-duration-log x dur dots)) arg)) +single = +#(define-music-function (parser location overrides music) + (ly:music? ly:music?) + (_i "Convert @var{overrides} to tweaks and apply them to @var{music}. +This does not convert @code{\\revert}, @code{\\set} or @code{\\unset} +and ignores nested overrides.") + (set! (ly:music-property music 'tweaks) + (fold-some-music + (lambda (m) (eq? (ly:music-property m 'name) + 'OverrideProperty)) + (lambda (m tweaks) + (let ((p (cond + ((ly:music-property m 'grob-property #f) => list) + (else + (ly:music-property m 'grob-property-path))))) + (if (pair? (cdr p)) + tweaks ;ignore nested properties + (acons (cons (ly:music-property m 'symbol) ;grob name + (car p)) ;grob property + (ly:music-property m 'grob-value) + tweaks)))) + (ly:music-property music 'tweaks) + overrides)) + music) + skip = #(define-music-function (parser location dur) (ly:duration?) (_i "Skip forward by @var{dur}.") @@ -1035,7 +1215,7 @@ the `parameters' assoc list.") styledNoteHeads = #(define-music-function (parser location style heads music) - (symbol? list-or-symbol? ly:music?) + (symbol? symbol-list-or-symbol? ly:music?) (_i "Set @var{heads} in @var{music} to @var{style}.") (style-note-heads heads style music)) @@ -1050,6 +1230,47 @@ tag = (ly:music-property arg 'tags))) arg) +temporary = +#(define-music-function (parser location music) + (ly:music?) + (_i "Make any @code{\\override} in @var{music} replace an existing +grob property value only temporarily, restoring the old value when a +corresponding @code{\\revert} is executed. This is achieved by +clearing the @samp{pop-first} property normally set on +@code{\\override}s. + +An @code{\\override}/@/@code{\\revert} sequence created by using +@code{\\temporary} and @code{\\undo} on the same music containing +overrides will cancel out perfectly or cause a@tie{}warning. + +Non-property-related music is ignored, warnings are generated for any +property-changing music that isn't an @code{\\override}.") + (define warned #f) + (for-some-music + (lambda (m) + (and (or (music-is-of-type? m 'layout-instruction-event) + (music-is-of-type? m 'context-specification) + (music-is-of-type? m 'apply-context) + (music-is-of-type? m 'time-signature-music)) + (case (ly:music-property m 'name) + ((OverrideProperty) + (if (ly:music-property m 'pop-first #f) + (set! (ly:music-property m 'pop-first) '())) + (if (ly:music-property m 'once #f) + (set! (ly:music-property m 'once) '())) + #t) + ((ContextSpeccedMusic) + #f) + (else + (if (not warned) + (begin + (ly:input-warning location (_ "Cannot make ~a revertible") + (ly:music-property m 'name)) + (set! warned #t))) + #t)))) + music) + music) + time = #(define-music-function (parser location beat-structure fraction) ((number-list? '()) fraction?) @@ -1107,21 +1328,80 @@ transposition = 'Staff)) tweak = -#(define-music-function (parser location sym val arg) - (symbol? scheme? ly:music?) - (_i "Add @code{sym . val} to the @code{tweaks} property of @var{arg}.") - - (if (equal? (object-property sym 'backend-type?) #f) +#(define-music-function (parser location grob prop value music) + ((string?) symbol? scheme? ly:music?) + (_i "Add a tweak to the following @var{music}. +Layout objects created by @var{music} get their property @var{prop} +set to @var{value}. If @var{grob} is specified, like with +@example +\\tweak Accidental #'color #red cis' +@end example +an indirectly created grob (@samp{Accidental} is caused by +@samp{NoteHead}) can be tweaked; otherwise only directly created grobs +are affected.") + (if (not (object-property prop 'backend-type?)) (begin - (ly:input-warning location (_ "cannot find property type-check for ~a") sym) + (ly:input-warning location (_ "cannot find property type-check for ~a") prop) (ly:warning (_ "doing assignment anyway")))) (set! - (ly:music-property arg 'tweaks) - (acons sym val - (ly:music-property arg 'tweaks))) - arg) - + (ly:music-property music 'tweaks) + (acons (if grob (cons (string->symbol grob) prop) prop) + value + (ly:music-property music 'tweaks))) + music) +undo = +#(define-music-function (parser location music) + (ly:music?) + (_i "Convert @code{\\override} and @code{\\set} in @var{music} to +@code{\\revert} and @code{\\unset}, respectively. Any reverts and +unsets already in @var{music} cause a warning. Non-property-related music is ignored.") + (define warned #f) + (let loop + ((music music)) + (let + ((lst + (fold-some-music + (lambda (m) (or (music-is-of-type? m 'layout-instruction-event) + (music-is-of-type? m 'context-specification) + (music-is-of-type? m 'apply-context) + (music-is-of-type? m 'time-signature-music))) + (lambda (m overrides) + (case (ly:music-property m 'name) + ((OverrideProperty) + (cons + (make-music 'RevertProperty + 'symbol (ly:music-property m 'symbol) + 'grob-property-path + (cond + ((ly:music-property m 'grob-property #f) => list) + (else + (ly:music-property m 'grob-property-path)))) + overrides)) + ((PropertySet) + (cons + (make-music 'PropertyUnset + 'symbol (ly:music-property m 'symbol)) + overrides)) + ((ContextSpeccedMusic) + (cons + (make-music 'ContextSpeccedMusic + 'element (loop (ly:music-property m 'element)) + 'context-type (ly:music-property m 'context-type)) + overrides)) + (else + (if (not warned) + (begin + (ly:input-warning location (_ "Cannot revert ~a") + (ly:music-property m 'name)) + (set! warned #t))) + overrides))) + '() + music))) + (cond + ((null? lst) (make-music 'Music)) + ((null? (cdr lst)) (car lst)) + (else (make-sequential-music lst)))))) unfoldRepeats = #(define-music-function (parser location music) (ly:music?)