X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=ly%2Fmusic-functions-init.ly;h=69b08f0705f5af9cae95a3e46d6dd6f1839ebc31;hb=a8123b45452ed8e1028f2f2270e4ff71054d0b3e;hp=c88759853991c1f7265c931bd3b37bbf49d64dc7;hpb=c27cdd423527bcd4d019bb54e2ab5fe470fba9a6;p=lilypond.git

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index c887598539..69b08f0705 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,28 +96,30 @@ 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))
 
 
-balloonText =
-#(define-music-function (parser location offset text) (number-pair? markup?)
+balloonGrobText =
+#(define-music-function (parser location grob-name offset text) (symbol? number-pair? markup?)
    
     (make-music 'AnnotateOutputEvent
+		'symbol grob-name
 		'X-offset (car offset)
 		'Y-offset (cdr offset)
 		'text text))
 
-balloonGrobText =
-#(define-music-function (parser location grob-name offset text) (symbol? number-pair? markup?)
+balloonText =
+#(define-music-function (parser location offset text) (number-pair? markup?)
    
     (make-music 'AnnotateOutputEvent
-		'symbol grob-name
 		'X-offset (car offset)
 		'Y-offset (cdr offset)
 		'text text))
 
+
 bar =
 #(define-music-function (parser location type)
    (string?)
@@ -125,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 
@@ -136,37 +142,32 @@ barNumberCheck =
 					 cbn n))))))
 
 
+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))))
 
-bendAfter =
-#(define-music-function (parser location delta) (integer?)
-	      
-  (make-music 'BendAfterEvent
-   'delta-step delta))
 
 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))
 
 
-compressMusic =
-#(define-music-function
-		  (parser location fraction music) (number-pair? ly:music?)
-		  (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction))))
-
-
 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
@@ -177,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)
@@ -190,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))
@@ -215,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)))
@@ -240,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))
@@ -257,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) '()))
@@ -275,9 +280,29 @@ instrumentSwitch =
       'Staff)))
 
 
+%% Parser used to read page-layout file, and then retreive score tweaks.
+#(define page-layout-parser #f)
+
+includePageLayoutFile = 
+#(define-music-function (parser location) ()
+   (_i "Include the file @var{<basename>-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))))
+	 (if (access? tweak-filename R_OK)
+	     (begin
+	       (ly:message "Including tweak file ~a" tweak-filename)
+               (set! page-layout-parser (ly:parser-clone parser))
+	       (ly:parser-parse-string page-layout-parser
+                                       (format #f "\\include \"~a\""
+                                               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))
@@ -287,12 +312,22 @@ keepWithTag =
       res)))
    music))
 
-
+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))
+           (res (memq tag tags)))
+     (not res)))
+ music))
 
 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))
@@ -301,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
@@ -311,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 =
@@ -417,28 +453,23 @@ markups), or inside a score.")
 	       'elements (list (make-music 'PageTurnEvent
 					   'break-permission 'allow))))
 
-removeWithTag = 
-#(define-music-function
-  (parser location tag music) (symbol? ly:music?)
-  (music-filter
-   (lambda (m)
-    (let* ((tags (ly:music-property m 'tags))
-           (res (memq tag tags)))
-     (not res)))
- music))
-
 %% Todo:
 %% doing
 %% define-music-function in a .scm causes crash.
 
-octave =
+octaveCheck =
 #(define-music-function (parser location pitch-note) (ly:music?)
    (_i "octave check")
 
    (make-music 'RelativeOctaveCheck
 	       'origin location
 	       'pitch (pitch-of-note pitch-note) 
-	       ))
+           ))
+
+ottava = #(define-music-function (parser location octave) (number?)
+  (_i "set the octavation ")
+  (make-ottava-set octave))
+
 partcombine =
 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
                 (make-part-combine-music parser
@@ -456,28 +487,27 @@ pitchedTrill =
 		      (ly:music-property ev-chord 'elements))))
 	(sec-note-events (get-notes secondary-note))
 	(trill-events (filter (lambda (m) (music-has-type m 'trill-span-event))
-			      (ly:music-property main-note 'elements)))
-
-	(trill-pitch
-	 (if (pair? sec-note-events)
-	     (ly:music-property (car sec-note-events) 'pitch)
-	     )))
-     
-     (if (ly:pitch? trill-pitch)
-	 (for-each (lambda (m) (ly:music-set-property! m 'pitch trill-pitch))
-		   trill-events)
-	 (begin
-	   (ly:warning (_ "Second argument of \\pitchedTrill should be single note: "))
-	   (display sec-note-events)))
+			      (ly:music-property main-note 'elements))))
 
+     (if (pair? sec-note-events)
+	 (begin
+	   (let*
+	       ((trill-pitch (ly:music-property (car sec-note-events) 'pitch))
+		(forced (ly:music-property (car sec-note-events ) 'force-accidental)))
+	     
+	     (if (ly:pitch? trill-pitch)
+		 (for-each (lambda (m) (ly:music-set-property! m 'pitch trill-pitch))
+			   trill-events)
+		 (begin
+		   (ly:warning (_ "Second argument of \\pitchedTrill should be single note: "))
+		   (display sec-note-events)))
+
+	     (if (eq? forced #t)
+		 (for-each (lambda (m) (ly:music-set-property! m 'force-accidental forced))
+			   trill-events)))))
      main-note))
-   
-parenthesize =
-#(define-music-function (parser loc arg) (ly:music?)
-   (_i "Tag @var{arg} to be parenthesized.")
 
-   (set! (ly:music-property arg 'parenthesize) #t)
-   arg)
+
 
 %% for lambda*
 #(use-modules (ice-9 optargs))
@@ -575,6 +605,23 @@ Example:
 
 
 
+parenthesize =
+#(define-music-function (parser loc 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
+     (map
+       (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)
+
+
 quoteDuring = #
 (define-music-function
   (parser location what main-music)
@@ -605,6 +652,12 @@ resetRelativeOctave  =
     reference-note))
 
 
+scaleDurations =
+#(define-music-function
+		  (parser location fraction music) (number-pair? ly:music?)
+		  (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction))))
+
+
 
 shiftDurations =
 #(define-music-function (parser location dur dots arg) (integer? integer? ly:music?)
@@ -625,25 +678,6 @@ the `parameters' assoc list.")
 		(cons 'system-Y-extent (cdr (assoc 'system-Y-extent parameters))))
    #})
 
-%% Parser used to read page-layout file, and then retreive score tweaks.
-#(define page-layout-parser #f)
-
-includePageLayoutFile = 
-#(define-music-function (parser location) ()
-   (_i "If page breaks and tweak dump is not asked, and the file
-<basename>-page-layout.ly exists, include it.")
-   (if (not (ly:get-option 'dump-tweaks))
-       (let ((tweak-filename (format #f "~a-page-layout.ly"
-				     (ly:parser-output-name parser))))
-	 (if (access? tweak-filename R_OK)
-	     (begin
-	       (ly:message "Including tweak file ~a" tweak-filename)
-               (set! page-layout-parser (ly:parser-clone parser))
-	       (ly:parser-parse-string page-layout-parser
-                                       (format #f "\\include \"~a\""
-                                               tweak-filename))))))
-   (make-music 'SequentialMusic 'void #t))
-
 
 rightHandFinger =
 #(define-music-function (parser location finger) (number-or-string?)
@@ -669,6 +703,20 @@ scoreTweak =
              (make-music 'SequentialMusic)))
        (make-music 'SequentialMusic)))
 
+
+tag = #(define-music-function (parser location tag arg)
+   (symbol? ly:music?)
+
+   (_i "Add @var{tag} to the @code{tags} property of @var{arg}.")
+
+   (set!
+    (ly:music-property arg 'tags)
+    (cons tag
+	  (ly:music-property arg 'tags)))
+   arg)
+
+
+
 transposedCueDuring =
 #(define-music-function
   (parser location what dir pitch-note main-music)
@@ -711,16 +759,6 @@ tweak = #(define-music-function (parser location sym val arg)
 		   (ly:music-property arg 'tweaks)))
 	   arg)
 
-tag = #(define-music-function (parser location tag arg)
-   (symbol? ly:music?)
-
-   (_i "Add @var{tag} to the @code{tags} property of @var{arg}.")
-
-   (set!
-    (ly:music-property arg 'tags)
-    (cons tag
-	  (ly:music-property arg 'tags)))
-   arg)
 
 
 unfoldRepeats =
@@ -735,5 +773,3 @@ withMusicProperty =
 
    (set! (ly:music-property music sym) val)
    music)
-
-