]> git.donarmstrong.com Git - lilypond.git/blobdiff - ly/music-functions-init.ly
Merge branch 'master' into dev/texi2html
[lilypond.git] / ly / music-functions-init.ly
index 5f425fc717a7d0d0dfddc6fc997ba221e0d087ff..a9d38dbad13b9508f3bbf44370c4a5b104e7181f 100644 (file)
@@ -1,6 +1,6 @@
 % -*-Scheme-*-
 
-\version "2.9.12"
+\version "2.10.0"
 
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -9,24 +9,17 @@
 
 %% need SRFI-1 filter 
 
-#(use-modules (srfi srfi-1))  
-%% FIXME: guile-1.7 required?
-%#(use-modules (scm display-lily))invalid module name for use-syntax ((srfi srfi-39))
-
-#(use-modules (scm display-lily))
-#(display-lily-init parser)
-
+#(use-modules (srfi srfi-1))
 
 acciaccatura =
 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic)
 
-addquote =
+addQuote =
 #(define-music-function (parser location name music) (string? ly:music?)
-   "Add a piece of music to be quoted "
-   (add-quotable name music)
+   (_i "Add a piece of music to be quoted ")
+   (add-quotable parser name music)
    (make-music 'SequentialMusic 'void #t))
 
-
 afterGraceFraction =
 #(cons 6 8)
 
@@ -96,7 +89,7 @@ assertBeamSlope =
 
 autochange =
 #(define-music-function (parser location music) (ly:music?)
-               (make-autochange-music music))
+               (make-autochange-music parser music))
 
 applyContext =
 #(define-music-function (parser location proc) (procedure?)
@@ -104,6 +97,25 @@ applyContext =
                    'origin location
                    'procedure proc))
 
+
+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))
+
+balloonText =
+#(define-music-function (parser location offset text) (number-pair? markup?)
+   
+    (make-music 'AnnotateOutputEvent
+               'X-offset (car offset)
+               'Y-offset (cdr offset)
+               'text text))
+
+
 bar =
 #(define-music-function (parser location type)
    (string?)
@@ -125,6 +137,12 @@ barNumberCheck =
                                         cbn n))))))
 
 
+bendAfter =
+#(define-music-function (parser location delta) (real?)
+             
+  (make-music 'BendAfterEvent
+   'delta-step delta))
+
 %% why a function?
 breathe =
 #(define-music-function (parser location) ()
@@ -132,27 +150,15 @@ breathe =
               '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?)
-   
-   "Set the current clef."
+   (_i "Set the current clef.")
 
    (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)
@@ -165,22 +171,48 @@ cueDuring =
              'quoted-voice-direction dir
              'origin location))
 
-
 displayLilyMusic =
 #(define-music-function (parser location music) (ly:music?)
-   (display-lily-music music)
+   (newline)
+   (display-lily-music music parser)
    music)
 
 displayMusic =
 #(define-music-function (parser location music) (ly:music?)
-                (display-scheme-music music)
-                music)
+   (newline)
+   (display-scheme-music music)
+   music)
+
+
+endSpanners =
+#(define-music-function (parser location music) (ly:music?)
+   (if (eq? (ly:music-property music 'name) 'EventChord)
+       (let*
+          ((elts (ly:music-property music 'elements))
+           (start-span-evs (filter (lambda (ev)
+                               (and (music-has-type ev 'span-event)
+                                    (equal? (ly:music-property ev 'span-direction)
+                                            START)))
+                             elts))
+           (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)
+       
+       (ly:input-message location (_ "argument endSpanners is not an EventChord: ~a" music))))
 
 featherDurations=
 #(define-music-function (parser location factor argument) (ly:moment? ly:music?)
-
-   "Rearrange durations in ARGUMENT so there is an
-acceleration/deceleration. "
+   (_i "Rearrange durations in ARGUMENT so there is an
+acceleration/deceleration. ")
    
    (let*
        ((orig-duration (ly:music-length argument))
@@ -239,6 +271,27 @@ 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 "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))
+
+
+
 keepWithTag =
 #(define-music-function
   (parser location tag music) (symbol? ly:music?)
@@ -251,7 +304,15 @@ keepWithTag =
       res)))
    music))
 
-
+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))
 
 killCues =
 #(define-music-function
@@ -262,7 +323,15 @@ killCues =
       (if (string? (ly:music-property mus 'quoted-music-name))
          (ly:music-property mus 'element)
          mus)) music))
-   
+
+label = 
+#(define-music-function (parser location label) (symbol?)
+   (_i "Place a bookmarking label, either at top-level or inside music.")
+   (make-music 'EventChord
+              'page-marker #t
+              'page-label label
+              'elements (list (make-music 'LabelEvent
+                                          'page-label label)))) 
 
 makeClusters =
 #(define-music-function
@@ -288,9 +357,9 @@ overrideProperty =
    (string? symbol? scheme?)
 
 
-   "Set @var{property} to @var{value} in all grobs named @var{name}.
+   (_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\"}"
+or @code{\"GrobName\"}")
 
    (let*
        ((name-components (string-split name #\.))
@@ -313,24 +382,73 @@ or @code{\"GrobName\"}"
                        grob-name)
                       (set! (ly:grob-property grob property) value))))))
 
-
-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))
+%% These are music functions (iso music indentifiers), because music identifiers
+%% are not allowed at top-level.
+pageBreak =
+#(define-music-function (location parser) ()
+   (_i "Force a page break. May be used at toplevel (ie 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))))
+
+noPageBreak =
+#(define-music-function (location parser) ()
+   (_i "Forbid a page break. May be used at toplevel (ie 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 '()))))
+
+pageTurn =
+#(define-music-function (location parser) ()
+   (_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))))
+
+noPageTurn =
+#(define-music-function (location parser) ()
+   (_i "Forbid 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 'forbid
+              'elements (list (make-music 'PageTurnEvent
+                                          'break-permission '()))))
+
+allowPageTurn =
+#(define-music-function (location parser) ()
+   (_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))))
 
 %% Todo:
 %% doing
 %% define-music-function in a .scm causes crash.
 
-octave =
+octaveCheck =
 #(define-music-function (parser location pitch-note) (ly:music?)
-   "octave check"
+   (_i "octave check")
 
    (make-music 'RelativeOctaveCheck
               'origin location
@@ -338,7 +456,8 @@ octave =
               ))
 partcombine =
 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
-                (make-part-combine-music (list part1 part2)))
+                (make-part-combine-music parser
+                                        (list part1 part2)))
 
              
 pitchedTrill =
@@ -351,36 +470,35 @@ pitchedTrill =
                      (lambda (m) (eq? 'NoteEvent (ly:music-property m 'name)))
                      (ly:music-property ev-chord 'elements))))
        (sec-note-events (get-notes secondary-note))
-       (trill-events (filter (lambda (m) (memq 'trill-span-event (ly:music-property m 'types)))
-                             (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)))
+       (trill-events (filter (lambda (m) (music-has-type m 'trill-span-event))
+                             (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?)
-   "Tag @var{arg} to be parenthesized."
 
-   (set! (ly:music-property arg 'parenthesize) #t)
-   arg)
+
 
 %% for lambda*
 #(use-modules (ice-9 optargs))
 
 parallelMusic =
 #(define-music-function (parser location voice-ids music) (list? ly:music?)
-  "Define parallel music sequences, separated by '|' (bar check signs),
+  (_i "Define parallel music sequences, separated by '|' (bar check signs),
 and assign them to the identifiers provided in @var{voice-ids}.
 
 @var{voice-ids}: a list of music identifiers (symbols containing only letters)
@@ -388,6 +506,8 @@ and assign them to the identifiers provided in @var{voice-ids}.
 @var{music}: a music sequence, containing BarChecks as limiting expressions.
 
 Example:
+
+@verbatim
   \\parallelMusic #'(A B C) {
     c c | d d | e e |
     d d | e e | f f |
@@ -396,7 +516,8 @@ Example:
   A = { c c | d d | }
   B = { d d | e e | }
   C = { e e | f f | }
-"
+@end verbatim
+")
   (let* ((voices (apply circular-list (make-list (length voice-ids) (list))))
          (current-voices voices)
          (current-sequence (list)))
@@ -468,6 +589,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)
@@ -483,7 +621,7 @@ resetRelativeOctave  =
 #(define-music-function
     (parser location reference-note)
     (ly:music?)
-    "Set the octave inside a \\relative section."
+    (_i "Set the octave inside a \\relative section.")
 
    (let*
     ((notes (ly:music-property reference-note 'elements))
@@ -498,11 +636,16 @@ 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?)
-   ""
-
+   (_i "")
    
    (music-map
     (lambda (x)
@@ -510,44 +653,32 @@ shiftDurations =
 
 spacingTweaks =
 #(define-music-function (parser location parameters) (list?)
-   "Set the system stretch, by reading the 'system-stretch property of
-   the `parameters' assoc 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))))
+        #$(list (cons 'alignment-extra-space (cdr (assoc 'system-stretch parameters)))
+               (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) ()
-   "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:clone-parser 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) (string?)
-   "Define a StringFingerEvent"
-   (make-music 'StringFingerEvent
-              'origin location
-              'text finger))
+#(define-music-function (parser location finger) (number-or-string?)
+   (_i "Define a StrokeFingerEvent")
+   
+   (apply make-music
+         (append
+          (list 
+           'StrokeFingerEvent
+           'origin location)
+          (if  (string? finger)
+               (list 'text finger)
+               (list 'digit finger)))))
 
 scoreTweak =
 #(define-music-function (parser location name) (string?)
-   "Include the score tweak, if exists."
+   (_i "Include the score tweak, if exists.")
    (if (and page-layout-parser (not (ly:get-option 'dump-tweaks)))
        (let ((tweak-music (ly:parser-lookup page-layout-parser
                                             (string->symbol name))))
@@ -556,16 +687,30 @@ 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)
   (string? ly:dir? ly:music? ly:music?)
 
-  "Insert notes from the part @var{what} into a voice called @code{cue},
+  (_i "Insert notes from the part @var{what} into a voice called @code{cue},
 using the transposition defined by @var{pitch-note}.  This happens
 simultaneously with @var{main-music}, which is usually a rest.  The
 argument @var{dir} determines whether the cue notes should be notated
-as a first or second voice."
+as a first or second voice.")
 
   (make-music 'QuoteMusic
              'element main-music
@@ -580,19 +725,17 @@ as a first or second voice."
 
 transposition =
 #(define-music-function (parser location pitch-note) (ly:music?)
-   "Set instrument transposition"
+   (_i "Set instrument transposition")
 
    (context-spec-music
     (make-property-set 'instrumentTransposition
-                      (ly:pitch-diff (ly:make-pitch 0 0 0) (pitch-of-note pitch-note)))
-        'Staff
-))
+                      (ly:pitch-negate (pitch-of-note pitch-note)))
+        'Staff))
 
 tweak = #(define-music-function (parser location sym val arg)
           (symbol? scheme? ly:music?)
 
-          "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)
@@ -600,16 +743,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?)
-
-   "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 =
@@ -620,9 +753,7 @@ unfoldRepeats =
 
 withMusicProperty =
 #(define-music-function (parser location sym val music) (symbol? scheme? ly:music?)
-   "Set @var{sym} to @var{val} in @var{music}."
+   (_i "Set @var{sym} to @var{val} in @var{music}.")
 
    (set! (ly:music-property music sym) val)
    music)
-
-