X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=ly%2Fmusic-functions-init.ly;h=44999b6c35551055d0673bd60a2df343ec2ba089;hb=0ed6c4f5d241424be86f34fda2cc298932cb37b0;hp=10af2cfefb8f720f02b034d67d9894b0e08a02b4;hpb=49f9b097ce73335f8a6b3436c43df1aed8a77288;p=lilypond.git diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly index 10af2cfefb..44999b6c35 100644 --- a/ly/music-functions-init.ly +++ b/ly/music-functions-init.ly @@ -1,6 +1,6 @@ % -*-Scheme-*- -\version "2.10.0" +\version "2.12.0" %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -12,11 +12,13 @@ #(use-modules (srfi srfi-1)) acciaccatura = -#(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic) +#(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic + (_i "Create an acciaccatura from the following music expression")) addQuote = #(define-music-function (parser location name music) (string? ly:music?) - (_i "Add a piece of music to be quoted ") + (_i "Define @var{music} as a quotable music expression named +@var{name}") (add-quotable parser name music) (make-music 'SequentialMusic 'void #t)) @@ -27,7 +29,7 @@ afterGrace = #(define-music-function (parser location 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))) @@ -50,7 +52,8 @@ afterGrace = applyMusic = #(define-music-function (parser location func music) (procedure? ly:music?) - (func music)) + (_i"Apply procedure @var{func} to @var{music}.") + (func music)) applyOutput = @@ -93,6 +96,7 @@ autochange = applyContext = #(define-music-function (parser location proc) (procedure?) + (_i "Modify context properties with Scheme procedure @var{proc}.") (make-music 'ApplyContext 'origin location 'procedure proc)) @@ -126,6 +130,7 @@ bar = 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 @@ -139,30 +144,30 @@ barNumberCheck = bendAfter = #(define-music-function (parser location delta) (real?) - + (_i "Create a fall or doit of pitch interval @var{delta}.") (make-music 'BendAfterEvent 'delta-step delta)) %% why a function? breathe = #(define-music-function (parser location) () + (_i "Insert a breath mark.") (make-music 'EventChord 'origin location 'elements (list (make-music 'BreathingEvent)))) clef = -#(define-music-function (parser location type) - (string?) - (_i "Set the current clef.") - +#(define-music-function (parser location type) (string?) + (_i "Set the current clef to @var{type}.") (make-clef-set type)) cueDuring = #(define-music-function - (parser location what dir main-music) - (string? ly:dir? ly:music?) + (parser location 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 'Voice @@ -173,12 +178,15 @@ cueDuring = displayLilyMusic = #(define-music-function (parser location music) (ly:music?) + (_i "Display the LilyPond input representation of @var{music} +to the console.") (newline) (display-lily-music music parser) music) displayMusic = #(define-music-function (parser location music) (ly:music?) + (_i "Display the internal representation of @var{music} to the console.") (newline) (display-scheme-music music) music) @@ -186,6 +194,7 @@ displayMusic = 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 (eq? (ly:music-property music 'name) 'EventChord) (let* ((elts (ly:music-property music 'elements)) @@ -211,9 +220,7 @@ endSpanners = featherDurations= #(define-music-function (parser location factor argument) (ly:moment? ly:music?) - (_i "Rearrange durations in ARGUMENT so there is an -acceleration/deceleration. ") - + (_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))) @@ -236,15 +243,15 @@ acceleration/deceleration. ") argument)) grace = -#(def-grace-function startGraceMusic stopGraceMusic) - +#(def-grace-function startGraceMusic stopGraceMusic + (_i "Insert @var{music} as grace notes.")) "instrument-definitions" = #'() addInstrumentDefinition = #(define-music-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)) @@ -253,6 +260,8 @@ addInstrumentDefinition = instrumentSwitch = #(define-music-function (parser location name) (string?) + (_i "Switch instrument to @var{name}, which must be predefined with +@var{\addInstrumentDefinition}.") (let* ((handle (assoc name instrument-definitions)) (instrument-def (if handle (cdr handle) '())) @@ -276,8 +285,8 @@ instrumentSwitch = includePageLayoutFile = #(define-music-function (parser location) () - (_i "If page breaks and tweak dump is not asked, and the file --page-layout.ly exists, include it.") + (_i "Include the file @var{-page-layout.ly}. Deprecated as +part of two-pass spacing.") (if (not (ly:get-option 'dump-tweaks)) (let ((tweak-filename (format #f "~a-page-layout.ly" (ly:parser-output-name parser)))) @@ -290,11 +299,10 @@ includePageLayoutFile = tweak-filename)))))) (make-music 'SequentialMusic 'void #t)) - - keepWithTag = #(define-music-function (parser location tag music) (symbol? ly:music?) + (_i "Include only elements of @var{music} that are tagged with @var{tag}.") (music-filter (lambda (m) (let* ((tags (ly:music-property m 'tags)) @@ -307,6 +315,7 @@ keepWithTag = removeWithTag = #(define-music-function (parser location tag music) (symbol? ly:music?) + (_i "Remove elements of @var{music} that are tagged with @var{tag}.") (music-filter (lambda (m) (let* ((tags (ly:music-property m 'tags)) @@ -318,6 +327,7 @@ killCues = #(define-music-function (parser location music) (ly:music?) + (_i "Remove cue notes from @var{music}.") (music-map (lambda (mus) (if (string? (ly:music-property mus 'quoted-music-name)) @@ -326,7 +336,7 @@ killCues = label = #(define-music-function (parser location label) (symbol?) - (_i "Place a bookmarking label, either at top-level or inside music.") + (_i "Create @var{label} as a bookmarking label") (make-music 'EventChord 'page-marker #t 'page-label label @@ -336,6 +346,7 @@ label = makeClusters = #(define-music-function (parser location arg) (ly:music?) + (_i "Display chords in @var{arg} as clusters") (music-map note-to-cluster arg)) musicMap = @@ -343,20 +354,10 @@ musicMap = (music-map proc mus)) - -oldaddlyrics = -#(define-music-function (parser location music lyrics) (ly:music? ly:music?) - - (make-music 'OldLyricCombineMusic - 'origin location - 'elements (list music lyrics))) - - overrideProperty = #(define-music-function (parser location name property value) (string? 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\"}") @@ -693,7 +694,8 @@ scoreTweak = (make-music 'SequentialMusic))) -tag = #(define-music-function (parser location tag arg) +tag = +#(define-music-function (parser location tag arg) (symbol? ly:music?) (_i "Add @var{tag} to the @code{tags} property of @var{arg}.") @@ -737,16 +739,20 @@ transposition = (ly:pitch-negate (pitch-of-note pitch-note))) 'Staff)) -tweak = #(define-music-function (parser location sym val arg) - (symbol? scheme? ly:music?) +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}.") - (_i "Add @code{sym . val} to the @code{tweaks} property of @var{arg}.") - - (set! - (ly:music-property arg 'tweaks) - (acons sym val - (ly:music-property arg 'tweaks))) - arg) + (if (equal? (object-property sym 'backend-type?) #f) + (begin + (ly:warning (_ "cannot find property type-check for ~a") sym) + (ly:warning (_ "doing assignment anyway")))) + (set! + (ly:music-property arg 'tweaks) + (acons sym val + (ly:music-property arg 'tweaks))) + arg)