X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=ly%2Fmusic-functions-init.ly;h=4e7e1d41050cdc8923058ab52bf1ac8babc53821;hb=4c43f23aacb1c65b88cdd4602ae46f1540422a3b;hp=65b4a6db7aff6330e5c55d4d37469c5cafdfb8d8;hpb=730d4eb3e0328e8ba0b376f8191a5bb6ae7f904c;p=lilypond.git diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly index 65b4a6db7a..4e7e1d4105 100644 --- a/ly/music-functions-init.ly +++ b/ly/music-functions-init.ly @@ -2,7 +2,7 @@ %%%% This file is part of LilyPond, the GNU music typesetter. %%%% -%%%% Copyright (C) 2003--2014 Han-Wen Nienhuys +%%%% Copyright (C) 2003--2015 Han-Wen Nienhuys %%%% Jan Nieuwenhuizen %%%% %%%% LilyPond is free software: you can redistribute it and/or modify @@ -18,7 +18,7 @@ %%%% You should have received a copy of the GNU General Public License %%%% along with LilyPond. If not, see . -\version "2.17.11" +\version "2.19.22" %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -27,16 +27,16 @@ %% need SRFI-1 for filter; optargs for lambda* #(use-modules (srfi srfi-1) - (ice-9 optargs)) + (ice-9 optargs)) %% TODO: using define-music-function in a .scm causes crash. absolute = -#(define-music-function (parser location music) +#(define-music-function (music) (ly:music?) (_i "Make @var{music} absolute. This does not actually change the music itself but rather hides it from surrounding @code{\\relative} -commands.") +and @code{\\fixed} commands.") (make-music 'RelativeOctaveMusic 'element music)) acciaccatura = @@ -47,54 +47,54 @@ acciaccatura = instrument-definitions = #'() addInstrumentDefinition = #(define-void-function - (parser location name lst) (string? list?) + (name lst) (string? list?) (_i "Create instrument @var{name} with properties @var{list}.") (set! instrument-definitions (acons name lst instrument-definitions))) addQuote = -#(define-void-function (parser location name music) (string? ly:music?) +#(define-void-function (name music) (string? ly:music?) (_i "Define @var{music} as a quotable music expression named @var{name}") - (add-quotable parser name music)) + (add-quotable name music)) %% keep these two together afterGraceFraction = #(cons 6 8) afterGrace = -#(define-music-function (parser location main grace) (ly:music? ly:music?) +#(define-music-function (main grace) (ly:music? ly:music?) (_i "Create @var{grace} note(s) after a @var{main} music expression.") (let ((main-length (ly:music-length main)) - (fraction (ly:parser-lookup parser 'afterGraceFraction))) + (fraction (ly:parser-lookup 'afterGraceFraction))) (make-simultaneous-music (list main (make-sequential-music - (list + (list - (make-music 'SkipMusic - 'duration (ly:make-duration - 0 0 - (* (ly:moment-main-numerator main-length) - (car fraction)) - (* (ly:moment-main-denominator main-length) - (cdr fraction)))) - (make-music 'GraceMusic - 'element grace))))))) + (make-music 'SkipMusic + 'duration (ly:make-duration + 0 0 + (* (ly:moment-main-numerator main-length) + (car fraction)) + (* (ly:moment-main-denominator main-length) + (cdr fraction)))) + (make-music 'GraceMusic + 'element grace))))))) %% music identifiers not allowed at top-level, %% so this is a music-function instead. allowPageTurn = -#(define-music-function (location parser) () +#(define-music-function () () (_i "Allow a page turn. May be used at toplevel (ie between scores or markups), or inside a score.") (make-music 'EventChord - 'page-marker #t - 'page-turn-permission 'allow - 'elements (list (make-music 'PageTurnEvent - 'break-permission 'allow)))) + 'page-marker #t + 'page-turn-permission 'allow + 'elements (list (make-music 'PageTurnEvent + 'break-permission 'allow)))) alterBroken = -#(define-music-function (parser location property arg item) +#(define-music-function (property arg item) (symbol-list-or-symbol? list? symbol-list-or-music?) (_i "Override @var{property} for pieces of broken spanner @var{item} with values @var{arg}. @var{item} may either be music in the form of @@ -104,11 +104,11 @@ form of a spanner event, @var{property} may also have the form @samp{Grob.property} for specifying a directed tweak.") (if (ly:music? item) (if (eq? (ly:music-property item 'span-direction) START) - #{ \tweak #property #(value-for-spanner-piece arg) #item #} + (tweak property (value-for-spanner-piece arg) item) (begin (ly:music-warning item (_ "not a spanner")) item)) - (let* ((p (check-grob-path item parser location + (let* ((p (check-grob-path item (*location*) #:default 'Bottom #:min 2 #:max 2)) @@ -124,39 +124,39 @@ form of a spanner event, @var{property} may also have the form #(value-for-spanner-piece arg) #} (begin - (ly:input-warning location (_ "not a spanner name, `~a'") name) + (ly:input-warning (*location*) (_ "not a spanner name, `~a'") name) (make-music 'Music)))))) appendToTag = -#(define-music-function (parser location tag more music) +#(define-music-function (tag more music) (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 (lambda (m) - (if (memq tag (ly:music-property m 'tags)) - (set! (ly:music-property m 'elements) - (append (ly:music-property m 'elements) - (list more)))) - m) - music)) + (if (memq tag (ly:music-property m 'tags)) + (set! (ly:music-property m 'elements) + (append (ly:music-property m 'elements) + (list more)))) + m) + music)) applyContext = -#(define-music-function (parser location proc) (procedure?) +#(define-music-function (proc) (procedure?) (_i "Modify context properties with Scheme procedure @var{proc}.") (make-music 'ApplyContext - 'procedure proc)) + 'procedure proc)) applyMusic = -#(define-music-function (parser location func music) (procedure? ly:music?) +#(define-music-function (func music) (procedure? ly:music?) (_i"Apply procedure @var{func} to @var{music}.") (func music)) applyOutput = -#(define-music-function (parser location ctx proc) (symbol? procedure?) +#(define-music-function (ctx proc) (symbol? procedure?) (_i "Apply function @code{proc} to every layout object in context @code{ctx}") (make-music 'ApplyOutputEvent - 'procedure proc - 'context-type ctx)) + 'procedure proc + 'context-type ctx)) appoggiatura = #(def-grace-function startAppoggiaturaMusic stopAppoggiaturaMusic @@ -164,25 +164,25 @@ appoggiatura = % for regression testing purposes. assertBeamQuant = -#(define-music-function (parser location l r) (pair? pair?) +#(define-music-function (l r) (pair? pair?) (_i "Testing function: check whether the beam quants @var{l} and @var{r} are correct") (make-grob-property-override 'Beam 'positions (check-quant-callbacks l r))) % for regression testing purposes. assertBeamSlope = -#(define-music-function (parser location comp) (procedure?) +#(define-music-function (comp) (procedure?) (_i "Testing function: check whether the slope of the beam is the same as @code{comp}") (make-grob-property-override 'Beam 'positions (check-slope-callbacks comp))) autochange = -#(define-music-function (parser location music) (ly:music?) +#(define-music-function (music) (ly:music?) (_i "Make voices that switch between staves automatically") - (make-autochange-music parser music)) + (make-autochange-music music)) balloonGrobText = -#(define-music-function (parser location grob-name offset text) +#(define-music-function (grob-name offset text) (symbol? number-pair? markup?) (_i "Attach @var{text} to @var{grob-name} at offset @var{offset} (use like @code{\\once})") @@ -195,34 +195,34 @@ balloonGrobText = 'text text)))) balloonText = -#(define-event-function (parser location offset text) (number-pair? markup?) +#(define-event-function (offset text) (number-pair? markup?) (_i "Attach @var{text} at @var{offset} (use like @code{\\tweak})") (make-music 'AnnotateOutputEvent - 'X-offset (car offset) - 'Y-offset (cdr offset) - 'text text)) + 'X-offset (car offset) + 'Y-offset (cdr offset) + 'text text)) bar = -#(define-music-function (parser location type) (string?) +#(define-music-function (type) (string?) (_i "Insert a bar line of type @var{type}") (context-spec-music (make-property-set 'whichBar type) 'Timing)) barNumberCheck = -#(define-music-function (parser location n) (integer?) +#(define-music-function (n) (integer?) (_i "Print a warning if the current bar number is not @var{n}.") (make-music 'ApplyContext - 'procedure - (lambda (c) - (let ((cbn (ly:context-property c 'currentBarNumber))) - (if (and (number? cbn) (not (= cbn n))) - (ly:input-warning location - "Barcheck failed got ~a expect ~a" - cbn n)))))) + 'procedure + (lambda (c) + (let ((cbn (ly:context-property c 'currentBarNumber))) + (if (and (number? cbn) (not (= cbn n))) + (ly:input-warning (*location*) + "Barcheck failed got ~a expect ~a" + cbn n)))))) beamExceptions = -#(define-scheme-function (parser location music) (ly:music?) +#(define-scheme-function (music) (ly:music?) (_i "Extract a value suitable for setting @code{Timing.beamExceptions} from the given pattern with explicit beams in @var{music}. A bar check @code{|} has to be used between @@ -230,47 +230,39 @@ bars of patterns in order to reset the timing.") (extract-beam-exceptions music)) bendAfter = -#(define-event-function (parser location delta) (real?) +#(define-event-function (delta) (real?) (_i "Create a fall or doit of pitch interval @var{delta}.") (make-music 'BendAfterEvent - 'delta-step delta)) + 'delta-step delta)) bookOutputName = -#(define-void-function (parser location newfilename) (string?) +#(define-void-function (newfilename) (string?) (_i "Direct output for the current book block to @var{newfilename}.") - (set! (paper-variable parser #f 'output-filename) newfilename)) + (set! (paper-variable #f 'output-filename) newfilename)) bookOutputSuffix = -#(define-void-function (parser location newsuffix) (string?) +#(define-void-function (newsuffix) (string?) (_i "Set the output filename suffix for the current book block to @var{newsuffix}.") - (set! (paper-variable parser #f 'output-suffix) newsuffix)) + (set! (paper-variable #f '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, %% it would have to be wrapped in an EventChord to prevent it from being %% treated as a post_event by the parser breathe = -#(define-music-function (parser location) () +#(define-music-function () () (_i "Insert a breath mark.") - (make-music 'BreathingEvent - 'midi-length - (lambda (len context) - ;;Shorten by half, or by up to a second, but always by a power of 2 - (let* ((desired (min (ly:moment-main (seconds->moment 1 context)) - (* (ly:moment-main len) 1/2))) - (scale (inexact->exact (ceiling (/ (log desired) (log 1/2))))) - (breath (ly:make-moment (expt 1/2 scale)))) - (ly:moment-sub (ly:make-moment (ly:moment-main len)) breath))))) + (make-music 'BreathingEvent)) clef = -#(define-music-function (parser location type) (string?) +#(define-music-function (type) (string?) (_i "Set the current clef to @var{type}.") (make-clef-set type)) compoundMeter = -#(define-music-function (parser location args) (pair?) +#(define-music-function (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 @@ -287,7 +279,7 @@ as @code{\\compoundMeter #'((3 2 8))} or shorter (ly:moment-main-denominator mlen)))) #{ \once \override Timing.TimeSignature.stencil = #(lambda (grob) - (grob-interpret-markup grob (format-compound-time args))) + (grob-interpret-markup grob (make-compound-meter-markup args))) \set Timing.timeSignatureFraction = #timesig \set Timing.baseMoment = #beat \set Timing.beatStructure = #beatGrouping @@ -295,8 +287,19 @@ as @code{\\compoundMeter #'((3 2 8))} or shorter \set Timing.measureLength = #mlen #} )) +compressMMRests = +#(define-music-function (music) (ly:music?) + (_i "Remove the empty bars created by multi-measure rests, +leaving just the first bar containing the MM rest itself.") + (music-map + (lambda (m) + (if (eq? 'MultiMeasureRestMusic (ly:music-property m 'name)) + #{ \once \set Score.skipBars = ##t #m #} + #{ #m #} )) + music)) + crossStaff = -#(define-music-function (parser location notes) (ly:music?) +#(define-music-function (notes) (ly:music?) (_i "Create cross-staff stems") #{ \temporary \override Stem.cross-staff = #cross-staff-connect @@ -307,53 +310,53 @@ crossStaff = #}) cueClef = -#(define-music-function (parser location type) (string?) +#(define-music-function (type) (string?) (_i "Set the current cue clef to @var{type}.") (make-cue-clef-set type)) cueClefUnset = -#(define-music-function (parser location) () +#(define-music-function () () (_i "Unset the current cue clef.") (make-cue-clef-unset)) cueDuring = #(define-music-function - (parser location what dir main-music) (string? ly:dir? ly:music?) + (what dir main-music) (string? ly:dir? ly:music?) (_i "Insert contents of quote @var{what} corresponding to @var{main-music}, in a CueVoice oriented by @var{dir}.") (make-music 'QuoteMusic - 'element main-music - 'quoted-context-type 'CueVoice - 'quoted-context-id "cue" - 'quoted-music-name what - 'quoted-voice-direction dir)) + 'element main-music + 'quoted-context-type 'CueVoice + 'quoted-context-id "cue" + 'quoted-music-name what + 'quoted-voice-direction dir)) cueDuringWithClef = #(define-music-function - (parser location what dir clef main-music) (string? ly:dir? string? ly:music?) + (what dir clef main-music) (string? ly:dir? string? ly:music?) (_i "Insert contents of quote @var{what} corresponding to @var{main-music}, in a CueVoice oriented by @var{dir}.") (make-music 'QuoteMusic - 'element main-music - 'quoted-context-type 'CueVoice - 'quoted-context-id "cue" - 'quoted-music-name what - 'quoted-music-clef clef - 'quoted-voice-direction dir)) + 'element main-music + 'quoted-context-type 'CueVoice + 'quoted-context-id "cue" + 'quoted-music-name what + 'quoted-music-clef clef + 'quoted-voice-direction dir)) displayLilyMusic = -#(define-music-function (parser location port music) ((output-port?) ly:music?) +#(define-music-function (port music) ((output-port?) ly:music?) (_i "Display the LilyPond input representation of @var{music} to @var{port}, defaulting to the console.") (let ((port (or port (current-output-port)))) (newline port) - (display-lily-music music parser port)) + (display-lily-music music port)) music) displayMusic = -#(define-music-function (parser location port music) ((output-port?) ly:music?) +#(define-music-function (port music) ((output-port?) ly:music?) (_i "Display the internal representation of @var{music} to @var{port}, default to the console.") (let ((port (or port (current-output-port)))) @@ -362,7 +365,7 @@ displayMusic = music) displayScheme = -#(define-scheme-function (parser location port expr) ((output-port?) scheme?) +#(define-scheme-function (port expr) ((output-port?) scheme?) (_i "Display the internal representation of @var{expr} to @var{port}, default to the console.") (let ((port (or port (current-output-port)))) @@ -373,43 +376,43 @@ displayScheme = endSpanners = -#(define-music-function (parser location music) (ly:music?) +#(define-music-function (music) (ly:music?) (_i "Terminate the next spanner prematurely after exactly one note without the need of a specific end spanner.") (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) - (music-clone m 'span-direction STOP)) + (equal? (ly:music-property ev 'span-direction) + START)) + (extract-typed-music music 'span-event))) + (stop-span-evs + (map (lambda (m) + (music-clone m 'span-direction STOP)) start-span-evs)) - (end-ev-chord (make-music 'EventChord - 'elements stop-span-evs)) - (total (make-music 'SequentialMusic - 'elements (list music - end-ev-chord)))) + (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?) +#(define-music-function (music) (ly:music?) (_i "Compatibility function wrapping @code{EventChord} around isolated rhythmic events occuring since version 2.15.28, after expanding repeat chords @samp{q}.") - (event-chord-wrap! music parser)) + (event-chord-wrap! music)) featherDurations= -#(define-music-function (parser location factor argument) (ly:moment? ly:music?) +#(define-music-function (factor argument) (ly:moment? ly:music?) (_i "Adjust durations of music in @var{argument} by rational @var{factor}.") (let ((orig-duration (ly:music-length argument)) - (multiplier (ly:make-moment 1 1))) + (multiplier (ly:make-moment 1 1))) (for-each (lambda (mus) - (if (< 0 (ly:moment-main-denominator (ly:music-length mus))) - (begin - (ly:music-compress mus multiplier) - (set! multiplier (ly:moment-mul factor multiplier))))) + (if (< 0 (ly:moment-main-denominator (ly:music-length mus))) + (begin + (ly:music-compress mus multiplier) + (set! multiplier (ly:moment-mul factor multiplier))))) (extract-named-music argument '(EventChord NoteEvent RestEvent SkipEvent))) (ly:music-compress argument @@ -418,7 +421,7 @@ featherDurations= argument)) finger = -#(define-event-function (parser location finger) (number-or-markup?) +#(define-event-function (finger) (number-or-markup?) (_i "Apply @var{finger} as a fingering indication.") (make-music @@ -426,8 +429,22 @@ finger = (if (number? finger) 'digit 'text) finger)) +fixed = +#(define-music-function (pitch music) + (ly:pitch? ly:music?) + (_i "Use the octave of @var{pitch} as the default octave for @var{music}.") + (let ((octave-marks (1+ (ly:pitch-octave pitch)))) + (cond ((not (= 0 octave-marks)) + (ly:music-transpose music (ly:make-pitch octave-marks 0 0)) + ;;In order to leave unchanged the notes in any enclosed + ;; \absolute or \fixed or \relative, make a cancelling shift + (map (lambda (m) + (ly:music-transpose m (ly:make-pitch (- octave-marks) 0 0))) + (extract-named-music music 'RelativeOctaveMusic))))) + (make-music 'RelativeOctaveMusic 'element music)) + footnote = -#(define-music-function (parser location mark offset footnote item) +#(define-music-function (mark offset footnote item) ((markup?) number-pair? markup? symbol-list-or-music?) (_i "Make the markup @var{footnote} a footnote on @var{item}. The footnote is marked with a markup @var{mark} moved by @var{offset} with @@ -449,28 +466,28 @@ 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))) - #{ \once \tweak footnote-music #mus #item #})) + 'FootnoteEvent + 'X-offset (car offset) + 'Y-offset (cdr offset) + 'automatically-numbered (not mark) + 'text (or mark (make-null-markup)) + 'footnote-text footnote))) + (once (tweak 'footnote-music mus item)))) grace = #(def-grace-function startGraceMusic stopGraceMusic (_i "Insert @var{music} as grace notes.")) grobdescriptions = -#(define-scheme-function (parser location descriptions) (list?) +#(define-scheme-function (descriptions) (list?) (_i "Create a context modification from @var{descriptions}, a list in the format of @code{all-grob-descriptions}.") (ly:make-context-mod (map (lambda (p) - (list 'assign (car p) (list (cdr p)))) - descriptions))) + (list 'assign (car p) (ly:make-grob-properties (cdr p)))) + descriptions))) -harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?) +harmonicByFret = #(define-music-function (fret music) (number? ly:music?) (_i "Convert @var{music} into mixed harmonics; the resulting notes resemble harmonics played on a fretted instrument by touching the strings at @var{fret}.") #{ @@ -487,16 +504,14 @@ harmonics played on a fretted instrument by touching the strings at @var{fret}." \revert NoteHead.stencil #}) -harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?) +harmonicByRatio = #(define-music-function (ratio music) (number? ly:music?) (_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}.") #{ \set harmonicDots = ##t \temporary \override TabNoteHead.stencil = #(tab-note-head::print-custom-fret-label (ratio->fret ratio)) - \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height - (lambda (grob start end) - (ly:grob::stencil-height grob))) + \temporary \override NoteHead.Y-extent = #(ly:make-unpure-pure-container ly:grob::stencil-height) \temporary \override NoteHead.stencil = #(lambda (grob) (ly:grob-set-property! grob 'style 'harmonic-mixed) (ly:note-head::print grob)) #(make-harmonic @@ -508,7 +523,7 @@ given through @var{ratio}.") #}) hide = -#(define-music-function (parser location item) (symbol-list-or-music?) +#(define-music-function (item) (symbol-list-or-music?) (_i "Set @var{item}'s @samp{transparent} property to @code{#t}, making it invisible while still retaining its dimensions. @@ -516,10 +531,10 @@ 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.") - #{ \tweak transparent ##t #item #}) + (tweak 'transparent #t item)) inStaffSegno = -#(define-music-function (parser location) () +#(define-music-function () () (_i "Put the segno variant 'varsegno' at this position into the staff, compatible with the repeat command.") (make-music 'ApplyContext @@ -533,107 +548,104 @@ compatible with the repeat command.") instrumentSwitch = #(define-music-function - (parser location name) (string?) + (name) (string?) (_i "Switch instrument to @var{name}, which must be predefined with @code{\\addInstrumentDefinition}.") (let* ((handle (assoc name instrument-definitions)) - (instrument-def (if handle (cdr handle) '()))) + (instrument-def (if handle (cdr handle) '()))) (if (not handle) - (ly:input-warning location "No such instrument: ~a" name)) + (ly:input-warning (*location*) "No such instrument: ~a" name)) (context-spec-music (make-music 'SimultaneousMusic - 'elements - (map (lambda (kv) - (make-property-set - (car kv) - (cdr kv))) - instrument-def)) + 'elements + (map (lambda (kv) + (make-property-set + (car kv) + (cdr kv))) + instrument-def)) 'Staff))) keepWithTag = -#(define-music-function (parser location tag music) +#(define-music-function (tags music) (symbol-list-or-symbol? ly:music?) - (_i "Include only elements of @var{music} that are either untagged -or tagged with one of the tags in @var{tag}. @var{tag} may be either -a single symbol or a list of symbols.") + (_i "Include only elements of @var{music} that are tagged with one +of the tags in @var{tags}. @var{tags} may be either a single symbol +or a list of symbols. + +Each tag may be declared as a member of at most one tag group (defined +with @code{\\tagGroup}). If none of a @var{music} element's tags +share a tag group with one of the specified @var{tags}, the element is +retained.") (music-filter - (if (symbol? tag) - (lambda (m) - (let ((music-tags (ly:music-property m 'tags))) - (or (null? music-tags) - (memq tag music-tags)))) - (lambda (m) - (let ((music-tags (ly:music-property m 'tags))) - (or (null? music-tags) - (any (lambda (t) (memq t music-tags)) tag))))) + (tags-keep-predicate tags) music)) key = -#(define-music-function (parser location tonic pitch-alist) +#(define-music-function (tonic pitch-alist) ((ly:pitch? '()) (list? '())) (_i "Set key to @var{tonic} and scale @var{pitch-alist}. If both are null, just generate @code{KeyChangeEvent}.") (cond ((null? tonic) (make-music 'KeyChangeEvent)) - ((null? pitch-alist) - (ly:parser-error parser (_ "second argument must be pitch list") - location) - (make-music 'SequentialMusic 'void #t)) - (else - (ly:music-transpose - (make-music 'KeyChangeEvent - 'tonic (ly:make-pitch 0 0 0) - 'pitch-alist pitch-alist) - tonic)))) + ((null? pitch-alist) + (ly:parser-error (_ "second argument must be pitch list") + (*location*)) + (make-music 'SequentialMusic 'void #t)) + (else + (ly:music-transpose + (make-music 'KeyChangeEvent + 'tonic (ly:make-pitch 0 0 0) + 'pitch-alist pitch-alist) + tonic)))) killCues = -#(define-music-function (parser location music) (ly:music?) +#(define-music-function (music) (ly:music?) (_i "Remove cue notes from @var{music}.") (music-map (lambda (mus) (if (and (string? (ly:music-property mus 'quoted-music-name)) - (string=? (ly:music-property mus 'quoted-context-id "") "cue")) - (ly:music-property mus 'element) - mus)) + (string=? (ly:music-property mus 'quoted-context-id "") "cue")) + (ly:music-property mus 'element) + mus)) music)) label = -#(define-music-function (parser location label) (symbol?) +#(define-music-function (label) (symbol?) (_i "Create @var{label} as a bookmarking label.") (make-music 'EventChord - 'page-marker #t - 'page-label label - 'elements (list (make-music 'LabelEvent - 'page-label label)))) + 'page-marker #t + 'page-label label + 'elements (list (make-music 'LabelEvent + 'page-label label)))) language = -#(define-void-function (parser location language) (string?) +#(define-void-function (language) (string?) (_i "Set note names for language @var{language}.") - (note-names-language parser language)) + (note-names-language language)) languageSaveAndChange = -#(define-void-function (parser location language) (string?) +#(define-void-function (language) (string?) (_i "Store the previous pitchnames alist, and set a new one.") (set! previous-pitchnames pitchnames) - (note-names-language parser language)) + (note-names-language language)) languageRestore = -#(define-void-function (parser location) () +#(define-void-function () () (_i "Restore a previously-saved pitchnames alist.") (if previous-pitchnames (begin (set! pitchnames previous-pitchnames) - (ly:parser-set-note-names parser pitchnames)) - (ly:input-warning location (_ "No other language was defined previously. Ignoring.")))) + (ly:parser-set-note-names pitchnames)) + (ly:input-warning (*location*) (_ "No other language was defined previously. Ignoring.")))) magnifyMusic = -#(define-music-function (parser location mag music) (positive? ly:music?) +#(define-music-function (mag music) (positive? ly:music?) (_i "Magnify the notation of @var{music} without changing the staff-size, using @var{mag} as a size factor. Stems, beams, slurs, ties, and horizontal spacing are adjusted automatically.") @@ -661,22 +673,30 @@ slurs, ties, and horizontal spacing are adjusted automatically.") ;; these props ARE allowed to shrink below default size (define shrinkable-props - '( - ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed - ;; override at the 'Score level - ;(SpacingSpanner spacing-increment) - - ;; lengths and heights - (Beam length-fraction) - (Stem length-fraction) - (Stem beamlet-default-length) - (Slur height-limit) - (Slur minimum-length) - (PhrasingSlur height-limit) - (PhrasingSlur minimum-length) - - ;; Beam.beam-thickness is dealt with separately below - )) + (let ((baseline-skip-props + (find-named-props 'baseline-skip all-grob-descriptions)) + (word-space-props + (find-named-props 'word-space all-grob-descriptions))) + (append + baseline-skip-props + word-space-props + '( + ;; TODO: uncomment spacing-increment here once Issue 3987 is fixed + ;; override at the 'Score level + ;(SpacingSpanner spacing-increment) + + ;; lengths and heights + (Beam length-fraction) + (Stem length-fraction) + (Stem beamlet-default-length) + (Stem double-stem-separation) + (Slur height-limit) + (Slur minimum-length) + (PhrasingSlur height-limit) + (PhrasingSlur minimum-length) + + ;; Beam.beam-thickness is dealt with separately below + )))) #{ \context Bottom { %% TODO: uncomment \newSpacingSection once Issue 3990 is fixed @@ -699,7 +719,7 @@ slurs, ties, and horizontal spacing are adjusted automatically.") #}) magnifyStaff = -#(define-music-function (parser location mag) (positive?) +#(define-music-function (mag) (positive?) (_i "Change the size of the staff, adjusting notation size and horizontal spacing automatically, using @var{mag} as a size factor.") @@ -709,9 +729,15 @@ horizontal spacing automatically, using @var{mag} as a size factor.") ;; these props ARE allowed to shrink below default size (define shrinkable-props - (let ((space-alist-props - (find-all-space-alist-props all-grob-descriptions))) + (let* ((baseline-skip-props + (find-named-props 'baseline-skip all-grob-descriptions)) + (word-space-props + (find-named-props 'word-space all-grob-descriptions)) + (space-alist-props + (find-named-props 'space-alist all-grob-descriptions))) (append + baseline-skip-props + word-space-props space-alist-props '( ;; override at the 'Score level @@ -723,6 +749,7 @@ horizontal spacing automatically, using @var{mag} as a size factor.") (BarLine hair-thickness) (BarLine thick-thickness) (Stem beamlet-default-length) + (Stem double-stem-separation) )))) #{ @@ -736,7 +763,8 @@ horizontal spacing automatically, using @var{mag} as a size factor.") shrinkable-props)) %% scale settings - %% (but only if staff magnification is changing) + %% (but only if staff magnification is changing + %% and does not equal 1) #(scale-fontSize 'magnifyStaff mag) #(scale-props 'magnifyStaff mag #f unshrinkable-props) #(scale-props 'magnifyStaff mag #t shrinkable-props) @@ -749,12 +777,12 @@ horizontal spacing automatically, using @var{mag} as a size factor.") #}) makeClusters = -#(define-music-function (parser location arg) (ly:music?) +#(define-music-function (arg) (ly:music?) (_i "Display chords in @var{arg} as clusters.") (music-map note-to-cluster arg)) modalInversion = -#(define-music-function (parser location around to scale music) +#(define-music-function (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}.") @@ -763,7 +791,7 @@ transpose from @var{around} to @var{to}.") music)) modalTranspose = -#(define-music-function (parser location from to scale music) +#(define-music-function (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}.") @@ -773,64 +801,64 @@ using @var{scale}.") inversion = #(define-music-function - (parser location around to music) (ly:pitch? ly:pitch? ly:music?) + (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)) mark = #(define-music-function - (parser location label) ((scheme? '())) + (label) ((scheme? '())) "Make the music for the \\mark command." (let* ((set (and (integer? label) - (context-spec-music (make-property-set 'rehearsalMark label) - 'Score))) - (ev (make-music 'MarkEvent - 'origin location))) + (context-spec-music (make-property-set 'rehearsalMark label) + 'Score))) + (ev (make-music 'MarkEvent + 'origin (*location*)))) (if set - (make-sequential-music (list set ev)) - (begin - (set! (ly:music-property ev 'label) label) - ev)))) + (make-sequential-music (list set ev)) + (begin + (set! (ly:music-property ev 'label) label) + ev)))) musicMap = -#(define-music-function (parser location proc mus) (procedure? ly:music?) +#(define-music-function (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 = -#(define-music-function (location parser) () +#(define-music-function () () (_i "Forbid a page break. May be used at toplevel (i.e., between scores or markups), or inside a score.") (make-music 'EventChord - 'page-marker #t - 'page-break-permission 'forbid - 'elements (list (make-music 'PageBreakEvent - 'break-permission '())))) + 'page-marker #t + 'page-break-permission 'forbid + 'elements (list (make-music 'PageBreakEvent + 'break-permission '())))) noPageTurn = -#(define-music-function (location parser) () +#(define-music-function () () (_i "Forbid a page turn. May be used at toplevel (i.e., between scores or markups), or inside a score.") (make-music 'EventChord - 'page-marker #t - 'page-turn-permission 'forbid - 'elements (list (make-music 'PageTurnEvent - 'break-permission '())))) + 'page-marker #t + 'page-turn-permission 'forbid + 'elements (list (make-music 'PageTurnEvent + 'break-permission '())))) octaveCheck = -#(define-music-function (parser location pitch) (ly:pitch?) +#(define-music-function (pitch) (ly:pitch?) (_i "Octave check.") (make-music 'RelativeOctaveCheck 'pitch pitch)) offset = -#(define-music-function (parser location property offsets item) +#(define-music-function (property offsets item) (symbol-list-or-symbol? scheme? symbol-list-or-music?) (_i "Offset the default value of @var{property} of @var{item} by @var{offsets}. If @var{item} is a string, the result is @@ -842,28 +870,24 @@ appropriate tweak applied.") (let ((prop-path (check-grob-path (if (symbol? property) (list property) - property) - parser location + property) (*location*) #:start 1 #:default #t #:min 2 #:max 2))) (if prop-path ; If the head of the grob property path is a symbol--i.e., ; a grob name, produce a directed tweak. Otherwise, create ; an ordinary tweak. (if (symbol? (car prop-path)) - #{ - \tweak #prop-path #(offsetter (second prop-path) offsets) #item - #} - #{ - \tweak #(second prop-path) #(offsetter (second prop-path) offsets) #item - #}) + (tweak prop-path (offsetter (second prop-path) offsets) item) + (tweak (second prop-path) + (offsetter (second prop-path) offsets) + item)) item)) ; In case of an override, grob property path is Context.Grob.property. (let ((prop-path (check-grob-path (append item (if (symbol? property) (list property) - property)) - parser location + property)) (*location*) #:default 'Bottom #:min 3 #:max 3))) (if prop-path #{ @@ -872,7 +896,7 @@ appropriate tweak applied.") (make-music 'Music))))) omit = -#(define-music-function (parser location item) (symbol-list-or-music?) +#(define-music-function (item) (symbol-list-or-music?) (_i "Set @var{item}'s @samp{stencil} property to @code{#f}, effectively omitting it without taking up space. @@ -880,10 +904,10 @@ 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.") - #{ \tweak stencil ##f #item #}) + (tweak 'stencil #f item)) once = -#(define-music-function (parser location music) (ly:music?) +#(define-music-function (music) (ly:music?) (_i "Set @code{once} to @code{#t} on all layout instruction events in @var{music}. This will complain about music with an actual duration. As a special exception, if @var{music} contains @@ -904,14 +928,41 @@ tweak.") music) ottava = -#(define-music-function (parser location octave) (integer?) +#(define-music-function (octave) (integer?) (_i "Set the octavation.") (make-music 'OttavaMusic - 'ottava-number octave)) + 'ottava-number octave)) + +#(ly:expect-warning + (ly:translate-cpp-warning-scheme "identifier name is a keyword: `%s'") + "override") +override = +#(define-music-function (grob-property-path value) + (symbol-list? scheme?) + (_i "Set the grob property specified by @var{grob-property-path} to +@var{value}. @var{grob-property-path} is a symbol list of the form +@code{Context.GrobName.property} or @code{GrobName.property}, possibly +with subproperties given as well. Because @code{\\override} is a +reserved word with special syntax in LilyPond input, this music +function will generally only be accessible from Scheme.") + (let ((p (check-grob-path grob-property-path (*parser*) (*location*) + #:default 'Bottom + #:min 3))) + (if p + (context-spec-music + (make-music 'OverrideProperty + 'symbol (cadr p) + 'origin (*location*) + 'grob-value value + 'grob-property-path (cddr p) + 'pop-first #t) + (car p)) + (make-music 'Music)))) + overrideTimeSignatureSettings = #(define-music-function - (parser location time-signature base-moment beat-structure beam-exceptions) + (time-signature base-moment beat-structure beam-exceptions) (fraction? fraction? list? list?) (_i "Override @code{timeSignatureSettings} @@ -919,19 +970,25 @@ for time signatures of @var{time-signature} to have settings of @var{base-moment}, @var{beat-structure}, and @var{beam-exceptions}.") ;; TODO -- add warning if largest value of grouping is - ;; greater than time-signature. + ;; greater than time-signature. (let ((setting (make-setting base-moment beat-structure beam-exceptions))) (override-time-signature-setting time-signature setting))) overrideProperty = -#(define-music-function (parser location grob-property-path value) +#(define-music-function (grob-property-path value) (symbol-list? scheme?) (_i "Set the grob property specified by @var{grob-property-path} to @var{value}. @var{grob-property-path} is a symbol list of the form @code{Context.GrobName.property} or @code{GrobName.property}, possibly -with subproperties given as well.") - (let ((p (check-grob-path grob-property-path parser location +with subproperties given as well. + +As opposed to @code{\\override} which overrides the context-dependent +defaults with which a grob is created, this command uses +@code{Output_property_engraver} at the grob acknowledge stage. This +may be necessary for overriding values set after the initial grob +creation.") + (let ((p (check-grob-path grob-property-path (*location*) #:default 'Bottom #:min 3))) (if p @@ -954,35 +1011,35 @@ with subproperties given as well.") %% pageBreak and pageTurn are music functions (iso music indentifiers), %% because music identifiers are not allowed at top-level. pageBreak = -#(define-music-function (location parser) () +#(define-music-function () () (_i "Force a page break. May be used at toplevel (i.e., between scores or markups), or inside a score.") (make-music 'EventChord - 'page-marker #t - 'line-break-permission 'force - 'page-break-permission 'force - 'elements (list (make-music 'LineBreakEvent - 'break-permission 'force) - (make-music 'PageBreakEvent - 'break-permission 'force)))) + 'page-marker #t + 'line-break-permission 'force + 'page-break-permission 'force + 'elements (list (make-music 'LineBreakEvent + 'break-permission 'force) + (make-music 'PageBreakEvent + 'break-permission 'force)))) pageTurn = -#(define-music-function (location parser) () +#(define-music-function () () (_i "Force a page turn between two scores or top-level markups.") (make-music 'EventChord - 'page-marker #t - 'line-break-permission 'force - 'page-break-permission 'force - 'page-turn-permission 'force - 'elements (list (make-music 'LineBreakEvent - 'break-permission 'force) - (make-music 'PageBreakEvent - 'break-permission 'force) - (make-music 'PageTurnEvent - 'break-permission 'force)))) + 'page-marker #t + 'line-break-permission 'force + 'page-break-permission 'force + 'page-turn-permission 'force + 'elements (list (make-music 'LineBreakEvent + 'break-permission 'force) + (make-music 'PageBreakEvent + 'break-permission 'force) + (make-music 'PageTurnEvent + 'break-permission 'force)))) parallelMusic = -#(define-void-function (parser location voice-ids music) (list? ly:music?) +#(define-void-function (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}. @@ -1002,6 +1059,9 @@ Example: B = { d d | e e | } C = { e e | f f | } @end verbatim + +The last bar checks in a sequence are not copied to the result in +order to facilitate ending the last entry at non-bar boundaries. ") (define voice-count (length voice-ids)) (define (bar-check? m) @@ -1022,7 +1082,7 @@ Example: "Store the previously built sequence into the current voice and change to the following voice." (set-car! current-voices - (cons (reverse! current-sequence) + (cons current-sequence (car current-voices))) (set! current-sequence '()) (set! current-voices (cdr current-voices))) @@ -1039,9 +1099,21 @@ change to the following voice." (if (bar-check? m) (change-voice)))))) lst) (if (pair? current-sequence) (change-voice)) - ;; un-circularize `voices' and reorder the voices - (set! voices (map reverse! - (list-head voices voice-count))) + ;; Un-circularize voices + (set! voices (list-head voices voice-count)) + + ;; Remove trailing bar checks to facilitate ending a + ;; sequence on a non-bar, reverse partial sequences and sequences + (set! voices (map! + (lambda (l) + (map! reverse! + (reverse! + (if (and (pair? l) (pair? (car l)) + (bar-check? (caar l))) + (cons (cdar l) (cdr l)) + l)))) + voices)) + ;; check sequence length (apply for-each (lambda seqs (define (seq-len seq) @@ -1096,56 +1168,91 @@ change to the following voice." ;; ;; bind voice identifiers to the voices (for-each (lambda (voice-id voice) - (ly:parser-define! parser voice-id voice)) + (ly:parser-define! voice-id voice)) voice-ids voices) (ly:music-warning music (_ "ignoring parallel music without barchecks"))))) parenthesize = -#(define-music-function (parser loc arg) (ly:music?) +#(define-music-function (arg) (ly:music?) (_i "Tag @var{arg} to be parenthesized.") (if (memq 'event-chord (ly:music-property arg 'types)) ;; arg is an EventChord -> set the parenthesize property ;; on all child notes and rests (for-each - (lambda (ev) - (if (or (memq 'note-event (ly:music-property ev 'types)) - (memq 'rest-event (ly:music-property ev 'types))) - (set! (ly:music-property ev 'parenthesize) #t))) - (ly:music-property arg 'elements)) + (lambda (ev) + (if (or (memq 'note-event (ly:music-property ev 'types)) + (memq 'rest-event (ly:music-property ev 'types))) + (set! (ly:music-property ev 'parenthesize) #t))) + (ly:music-property arg 'elements)) ;; No chord, simply set property for this expression: (set! (ly:music-property arg 'parenthesize) #t)) arg) +#(define (make-directed-part-combine-music direction chord-range part1 part2 + one-context-settings + two-context-settings + shared-context-settings) + + (let* ((pc-music (make-part-combine-music (list part1 part2) direction chord-range)) + (L1 (ly:music-length part1)) + (L2 (ly:music-length part2)) + ;; keep the contexts alive for the full duration + (skip (make-skip-music (make-duration-of-length + (if (ly:moment> #} )) + partcombine = -#(define-music-function (parser location part1 part2) (ly:music? ly:music?) - (_i "Take the music in @var{part1} and @var{part2} and typeset so -that they share a staff.") - (make-part-combine-music parser - (list part1 part2) #f)) +#(define-music-function (chord-range part1 part2) + ((number-pair? '(0 . 8)) ly:music? ly:music?) + (_i "Take the music in @var{part1} and @var{part2} and return +a music expression containing simultaneous voices, where @var{part1} +and @var{part2} are combined into one voice where appropriate. +Optional @var{chord-range} sets the distance in steps between notes +that may be combined into a chord or unison.") + (make-directed-part-combine-music #f chord-range part1 part2 + #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} + #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} + #{ #} )) partcombineUp = -#(define-music-function (parser location part1 part2) (ly:music? ly:music?) +#(define-music-function (chord-range part1 part2) + ((number-pair? '(0 . 8)) ly:music? ly:music?) (_i "Take the music in @var{part1} and @var{part2} and typeset so that they share a staff with stems directed upward.") - (make-part-combine-music parser - (list part1 part2) UP)) + (make-directed-part-combine-music UP chord-range part1 part2 + #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} + #{ \with { \voiceThree \override DynamicLineSpanner.direction = #UP } #} + #{ \with { \voiceOne \override DynamicLineSpanner.direction = #UP } #} )) partcombineDown = -#(define-music-function (parser location part1 part2) (ly:music? ly:music?) +#(define-music-function (chord-range part1 part2) + ((number-pair? '(0 . 8)) ly:music? ly:music?) (_i "Take the music in @var{part1} and @var{part2} and typeset so that they share a staff with stems directed downward.") - (make-part-combine-music parser - (list part1 part2) DOWN)) + (make-directed-part-combine-music DOWN chord-range part1 part2 + #{ \with { \voiceFour \override DynamicLineSpanner.direction = #DOWN } #} + #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} + #{ \with { \voiceTwo \override DynamicLineSpanner.direction = #DOWN } #} )) partcombineForce = -#(define-music-function (location parser type once) (symbol-or-boolean? boolean?) +#(define-music-function (type once) (boolean-or-symbol? boolean?) (_i "Override the part-combiner.") (make-music 'EventChord - 'elements (list (make-music 'PartCombineForceEvent - 'forced-type type - 'once once)))) + 'elements (list (make-music 'PartCombineForceEvent + 'forced-type type + 'once once)))) partcombineApart = \partcombineForce #'apart ##f partcombineApartOnce = \partcombineForce #'apart ##t partcombineChords = \partcombineForce #'chords ##f @@ -1160,26 +1267,26 @@ partcombineAutomatic = \partcombineForce ##f ##f partcombineAutomaticOnce = \partcombineForce ##f ##t partial = -#(define-music-function (parser location dur) (ly:duration?) +#(define-music-function (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 - 'duration dur) - 'Timing) + 'origin (*location*) + 'duration dur) + 'Timing) 'Score)) pitchedTrill = #(define-music-function - (parser location main-note secondary-note) + (main-note secondary-note) (ly:music? ly:music?) (_i "Print a trill with @var{main-note} as the main note of the trill and print @var{secondary-note} as a stemless note head in parentheses.") (let* ((get-notes (lambda (ev-chord) - (extract-named-music ev-chord 'NoteEvent))) + (extract-named-music ev-chord 'NoteEvent))) (sec-note-events (get-notes secondary-note)) (trill-events (extract-named-music main-note 'TrillSpanEvent))) (if (pair? sec-note-events) @@ -1191,7 +1298,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:input-warning location (_ "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) @@ -1201,19 +1308,19 @@ print @var{secondary-note} as a stemless note head in parentheses.") main-note)) pushToTag = -#(define-music-function (parser location tag more music) +#(define-music-function (tag more music) (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 (lambda (m) - (if (memq tag (ly:music-property m 'tags)) - (set! (ly:music-property m 'elements) - (cons more (ly:music-property m 'elements)))) - m) - music)) + (if (memq tag (ly:music-property m 'tags)) + (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?) +#(define-music-function (what main-music) (string? ly:music?) (_i "Indicate a section of music to be quoted. @var{what} indicates the name of the quoted voice, as specified in an @code{\\addQuote} command. @var{main-music} is used to indicate the length of music to be quoted; @@ -1222,8 +1329,33 @@ usually contains spacers or multi-measure rests.") 'element main-music 'quoted-music-name what)) +#(ly:expect-warning + (ly:translate-cpp-warning-scheme "identifier name is a keyword: `%s'") + "revert") +revert = +#(define-music-function (grob-property-path) + (symbol-list?) + (_i "Revert the grob property specified by @var{grob-property-path} to +its previous value. @var{grob-property-path} is a symbol list of the form +@code{Context.GrobName.property} or @code{GrobName.property}, possibly +with subproperties given as well. Because @code{\\revert} is a +reserved word with special syntax in LilyPond input, this music +function will generally only be accessible from Scheme.") + (let ((p (check-grob-path grob-property-path (*parser*) (*location*) + #:default 'Bottom + #:min 3))) + (if p + (context-spec-music + (make-music 'RevertProperty + 'symbol (cadr p) + 'origin (*location*) + 'grob-property-path (cddr p)) + (car p)) + (make-music 'Music)))) + + relative = -#(define-music-function (parser location pitch music) +#(define-music-function (pitch music) ((ly:pitch?) ly:music?) (_i "Make @var{music} relative to @var{pitch}. If @var{pitch} is omitted, the first note in @var{music} is given in absolute pitch.") @@ -1242,26 +1374,20 @@ omitted, the first note in @var{music} is given in absolute pitch.") (ly:pitch-steps (ly:make-pitch 1 0)) 2)))) (make-music 'RelativeOctaveMusic - 'element music)) + 'element music)) removeWithTag = -#(define-music-function (parser location tag music) +#(define-music-function (tags music) (symbol-list-or-symbol? ly:music?) (_i "Remove elements of @var{music} that are tagged with one of the -tags in @var{tag}. @var{tag} may be either a single symbol or a list +tags in @var{tags}. @var{tags} may be either a single symbol or a list of symbols.") (music-filter - (if (symbol? tag) - (lambda (m) - (not (memq tag (ly:music-property m 'tags)))) - (lambda (m) - (let ((music-tags (ly:music-property m 'tags))) - (or (null? music-tags) - (not (any (lambda (t) (memq t music-tags)) tag)))))) + (tags-remove-predicate tags) music)) resetRelativeOctave = -#(define-music-function (parser location pitch) (ly:pitch?) +#(define-music-function (pitch) (ly:pitch?) (_i "Set the octave inside a \\relative section.") (make-music 'SequentialMusic @@ -1269,14 +1395,14 @@ resetRelativeOctave = (lambda (music last-pitch) pitch))) retrograde = -#(define-music-function (parser location music) +#(define-music-function (music) (ly:music?) (_i "Return @var{music} in reverse order.") (retrograde-music music)) revertTimeSignatureSettings = #(define-music-function - (parser location time-signature) + (time-signature) (pair?) (_i "Revert @code{timeSignatureSettings} @@ -1284,7 +1410,7 @@ for time signatures of @var{time-signature}.") (revert-time-signature-setting time-signature)) rightHandFinger = -#(define-event-function (parser location finger) (number-or-markup?) +#(define-event-function (finger) (number-or-markup?) (_i "Apply @var{finger} as a fingering indication.") (make-music @@ -1293,14 +1419,14 @@ rightHandFinger = finger)) scaleDurations = -#(define-music-function (parser location fraction music) +#(define-music-function (fraction music) (fraction? ly:music?) (_i "Multiply the duration of events in @var{music} by @var{fraction}.") (ly:music-compress music - (ly:make-moment (car fraction) (cdr fraction)))) + (ly:make-moment (car fraction) (cdr fraction)))) settingsFrom = -#(define-scheme-function (parser location ctx music) +#(define-scheme-function (ctx music) ((symbol?) ly:music?) (_i "Take the layout instruction events from @var{music}, optionally restricted to those applying to context type @var{ctx}, and return @@ -1308,49 +1434,49 @@ a context modification duplicating their effect.") (let ((mods (ly:make-context-mod))) (define (musicop m) (if (music-is-of-type? m 'layout-instruction-event) - (ly:add-context-mod - mods - (case (ly:music-property m 'name) - ((PropertySet) - (list 'assign - (ly:music-property m 'symbol) - (ly:music-property m 'value))) - ((PropertyUnset) - (list 'unset - (ly:music-property m 'symbol))) - ((OverrideProperty) - (cons* 'push - (ly:music-property m 'symbol) - (ly:music-property m 'grob-value) + (ly:add-context-mod + mods + (case (ly:music-property m 'name) + ((PropertySet) + (list 'assign + (ly:music-property m 'symbol) + (ly:music-property m 'value))) + ((PropertyUnset) + (list 'unset + (ly:music-property m 'symbol))) + ((OverrideProperty) + (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) - (cons* 'pop - (ly:music-property m 'symbol) + ((RevertProperty) + (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) - ((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)))) - (else - (let ((callback (ly:music-property m 'elements-callback))) - (if (procedure? callback) - (for-each musicop (callback m)))))))) + (case (ly:music-property m 'name) + ((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)))) + (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) +#(define-music-function (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 @@ -1390,10 +1516,10 @@ appropriate tweak applied.") (if (>= total-found 2) (helper siblings offsets) (offset-control-points (car offsets))))) - #{ \once \tweak control-points #shape-curve #item #}) + (once (tweak 'control-points shape-curve item))) shiftDurations = -#(define-music-function (parser location dur dots arg) +#(define-music-function (dur dots arg) (integer? integer? ly:music?) (_i "Change the duration of @var{arg} by adding @var{dur} to the @code{durlog} of @var{arg} and @var{dots} to the @code{dots} of @var{arg}.") @@ -1401,7 +1527,7 @@ shiftDurations = (shift-duration-log arg dur dots)) single = -#(define-music-function (parser location overrides music) +#(define-music-function (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}.") @@ -1425,10 +1551,10 @@ This does not convert @code{\\revert}, @code{\\set} or @code{\\unset}.") music) skip = -#(define-music-function (parser location dur) (ly:duration?) +#(define-music-function (dur) (ly:duration?) (_i "Skip forward by @var{dur}.") (make-music 'SkipMusic - 'duration dur)) + 'duration dur)) slashedGrace = @@ -1437,36 +1563,42 @@ slashedGrace = the following music expression")) spacingTweaks = -#(define-music-function (parser location parameters) (list?) +#(define-music-function (parameters) (list?) (_i "Set the system stretch, by reading the 'system-stretch property of the `parameters' assoc list.") - #{ - \overrideProperty Score.NonMusicalPaperColumn.line-break-system-details - #(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters))) - (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters)))) - #}) + (overrideProperty + '(Score NonMusicalPaperColumn line-break-system-details) + (list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters))) + (cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters)))))) styledNoteHeads = -#(define-music-function (parser location style heads music) +#(define-music-function (style heads music) (symbol? symbol-list-or-symbol? ly:music?) (_i "Set @var{heads} in @var{music} to @var{style}.") (style-note-heads heads style music)) tag = -#(define-music-function (parser location tag music) (symbol-list-or-symbol? ly:music?) - (_i "Tag the following @var{music} with @var{tag} and return the -result, by adding the single symbol or symbol list @var{tag} to the +#(define-music-function (tags music) (symbol-list-or-symbol? ly:music?) + (_i "Tag the following @var{music} with @var{tags} and return the +result, by adding the single symbol or symbol list @var{tags} to the @code{tags} property of @var{music}.") (set! (ly:music-property music 'tags) - ((if (symbol? tag) cons append) - tag + ((if (symbol? tags) cons append) + tags (ly:music-property music 'tags))) music) +tagGroup = +#(define-void-function (tags) (symbol-list?) + (_i "Define a tag group comprising the symbols in the symbol list +@var{tags}. Tag groups must not overlap.") + (let ((err (define-tag-group tags))) + (if err (ly:parser-error err (*location*))))) + temporary = -#(define-music-function (parser location music) +#(define-music-function (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 @@ -1499,7 +1631,7 @@ property-changing music that isn't an @code{\\override}.") (else (if (not warned) (begin - (ly:input-warning location (_ "Cannot make ~a revertible") + (ly:input-warning (*location*) (_ "Cannot make ~a revertible") (ly:music-property m 'name)) (set! warned #t))) #t)))) @@ -1507,7 +1639,7 @@ property-changing music that isn't an @code{\\override}.") music) time = -#(define-music-function (parser location beat-structure fraction) +#(define-music-function (beat-structure fraction) ((number-list? '()) fraction?) (_i "Set @var{fraction} as time signature, with optional number list @var{beat-structure} before it.") @@ -1517,17 +1649,17 @@ number list @var{beat-structure} before it.") 'beat-structure beat-structure)) times = -#(define-music-function (parser location fraction music) +#(define-music-function (fraction music) (fraction? ly:music?) (_i "Scale @var{music} in time by @var{fraction}.") (make-music 'TimeScaledMusic - 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction))) - 'numerator (car fraction) - 'denominator (cdr fraction))) + 'element (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction))) + 'numerator (car fraction) + 'denominator (cdr fraction))) transpose = #(define-music-function - (parser location from to music) + (from to music) (ly:pitch? ly:pitch? ly:music?) (_i "Transpose @var{music} from pitch @var{from} to pitch @var{to}.") @@ -1536,27 +1668,27 @@ transpose = transposedCueDuring = #(define-music-function - (parser location what dir pitch main-music) + (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}. This happens -simultaneously with @var{main-music}, which is usually a rest. The +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.") (make-music 'QuoteMusic - 'element main-music - 'quoted-context-type 'CueVoice - 'quoted-context-id "cue" - 'quoted-music-name what - 'quoted-voice-direction dir + 'element main-music + 'quoted-context-type 'CueVoice + 'quoted-context-id "cue" + 'quoted-music-name what + 'quoted-voice-direction dir ;; following is inverse of instrumentTransposition for ;; historical reasons - 'quoted-transposition pitch)) + 'quoted-transposition pitch)) transposition = -#(define-music-function (parser location pitch) (ly:pitch?) +#(define-music-function (pitch) (ly:pitch?) (_i "Set instrument transposition") (context-spec-music @@ -1564,7 +1696,7 @@ transposition = 'Staff)) tuplet = -#(define-music-function (parser location ratio tuplet-span music) +#(define-music-function (ratio tuplet-span music) (fraction? (ly:duration? '()) ly:music?) (_i "Scale the given @var{music} to tuplets. @var{ratio} is a fraction that specifies how many notes are played in place of the @@ -1587,7 +1719,7 @@ quarter note.") 'duration tuplet-span)) tupletSpan = -#(define-music-function (parser location tuplet-span) +#(define-music-function (tuplet-span) ((ly:duration?)) (_i "Set @code{tupletSpannerDuration}, the length into which @code{\\tuplet} without an explicit @samp{tuplet-span} argument of its @@ -1603,7 +1735,7 @@ command without explicit @samp{tuplet-span}, use #{ \unset tupletSpannerDuration #})) tweak = -#(define-music-function (parser location prop value item) +#(define-music-function (prop value item) (symbol-list-or-symbol? scheme? symbol-list-or-music?) (_i "Add a tweak to the following @var{item}, usually music. Layout objects created by @var{item} get their property @var{prop} @@ -1627,7 +1759,7 @@ convenient. @var{prop} can contain additional elements in which case a nested property (inside of an alist) is tweaked.") (if (ly:music? item) - (let ((p (check-grob-path prop parser location + (let ((p (check-grob-path prop (*location*) #:start 1 #:default #t #:min 2))) @@ -1644,15 +1776,14 @@ property (inside of an alist) is tweaked.") ;; out on its own, but this way we should get better error ;; diagnostics. (let ((p (check-grob-path - (append item (if (symbol? prop) (list prop) prop)) - parser location + (append item (if (symbol? prop) (list prop) prop)) (*location*) #:default 'Bottom #:min 3))) (if p #{ \override #p = #value #} (make-music 'Music))))) undo = -#(define-music-function (parser location music) +#(define-music-function (music) (ly:music?) (_i "Convert @code{\\override} and @code{\\set} in @var{music} to @code{\\revert} and @code{\\unset}, respectively. Any reverts and @@ -1693,7 +1824,7 @@ unsets already in @var{music} cause a warning. Non-property-related music is ig (else (if (not warned) (begin - (ly:input-warning location (_ "Cannot revert ~a") + (ly:input-warning (*location*) (_ "Cannot revert ~a") (ly:music-property m 'name)) (set! warned #t))) overrides))) @@ -1705,20 +1836,20 @@ unsets already in @var{music} cause a warning. Non-property-related music is ig (else (make-sequential-music lst)))))) unfoldRepeats = -#(define-music-function (parser location music) (ly:music?) +#(define-music-function (music) (ly:music?) (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or @code{\\repeat percent} commands in @var{music} to be interpreted as @code{\\repeat unfold}.") (unfold-repeats music)) void = -#(define-void-function (parser location arg) (scheme?) +#(define-void-function (arg) (scheme?) (_i "Accept a scheme argument, return a void expression. Use this if you want to have a scheme expression evaluated because of its side-effects, but its value ignored.")) withMusicProperty = -#(define-music-function (parser location sym val music) +#(define-music-function (sym val music) (symbol? scheme? ly:music?) (_i "Set @var{sym} to @var{val} in @var{music}.")