Fix #765: Display method for \ottava.

Since \ottava currently uses ApplyContext to set the relevant context
properties which trigger creation of an ottava bracket, the information
useful to its display method (i.e., the octavation) is inaccessible: the only
music property which can be extracted is the argument to ApplyContext, its
procedure.

By wrapping the existing code which creates an ottava bracket (make-ottava-set)
in a synthetic event, the octavation can be passed as a music property, thus making
it accessible from a display method.

* input/regression/display-lily-tests.ly:

  add test for \ottava

* ly/music-functions-init.ly (ottava):

  create ottava bracket via synthetic OttavaMusic

* scm/define-music-display-methods.scm:

  add display method for \ottava, which simply catches OttavaMusic and reads
  'ottava-number

* scm/define-music-properties.scm (all-music-properties):

  add 'ottava-number

* scm/define-music-types.scm:

  copy make-ottava-set from scm/music-functions.scm

  add OttavaMusic: uses a sequential iterator to call make-ottava-set via its
  elements-callback

* scm/music-functions.scm:

  add ly:context-property as procedure-with-setter

  remove make-ottava-set

diff --git a/input/regression/display-lily-tests.ly b/input/regression/display-lily-tests.ly
index 2e0aa7c23a6347450e7fbe78d84f3e881cc03b64..1d8d0097a9e8ec592eaa700b8604a65a2b794829 100644 (file)
--- a/input/regression/display-lily-tests.ly
+++ b/input/regression/display-lily-tests.ly
@@ -233,6 +233,8 @@ stderr of this run."
 \test "" ##[ \cueDuring #"foo" #1 { c d } #]
 \test "" ##[ \quoteDuring #"foo" { c d } #]
 
+%% \ottava
+\test "" ##[ \ottava #1 #] % OttavaMusic
 
 %% end test.
 

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index f26e0a1154fc698174c88b8910e73d3bcf0161e1..0e5093e8a5b8c899ba5ad5eda25d6d9957742027 100644 (file)
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -405,9 +405,10 @@ octaveCheck =
               'pitch (pitch-of-note pitch-note)))
 
 ottava =
-#(define-music-function (parser location octave) (number?)
+#(define-music-function (parser location octave) (integer?)
    (_i "Set the octavation.")
-   (make-ottava-set octave))
+   (make-music 'OttavaMusic
+              'ottava-number octave))
 
 overrideTimeSignatureSettings =
 #(define-music-function

diff --git a/scm/define-music-display-methods.scm b/scm/define-music-display-methods.scm
index f3304dadabdabd41cd6514007a8de0c1b7ac2642..0ee424018b9d6ad0a2f1077608e28ef499df5404 100644 (file)
--- a/scm/define-music-display-methods.scm
+++ b/scm/define-music-display-methods.scm
@@ -512,6 +512,9 @@ Otherwise, return #f."
 (define-display-method SkipMusic (skip parser)
   (format #f "\\skip ~a" (duration->lily-string (ly:music-property skip 'duration) #:force-duration #t)))
 
+(define-display-method OttavaMusic (ottava parser)
+  (format #f "\\ottava #~a" (ly:music-property ottava 'ottava-number)))
+
 ;;;
 ;;; Notes, rests, skips...
 ;;;

diff --git a/scm/define-music-properties.scm b/scm/define-music-properties.scm
index 2af8f923af4abf305fe623d8c09948610b0c4caa..2694e48ec5c7c61d389f1d67a17fd91a96f91d04 100644 (file)
--- a/scm/define-music-properties.scm
+++ b/scm/define-music-properties.scm
@@ -115,6 +115,7 @@ For chord inversions, this is negative.")
      (origin ,ly:input-location? "Where was this piece of music defined?")
      (original-chord ,ly:music? "Original chord of a repeated chord.
 Used by repeated chords in \\relative mode, to determine the first note octave")
+     (ottava-number ,integer? "The octavation for @code{\\ottava}.")
 
      (page-break-permission ,symbol? "When the music is at top-level,
 whether to allow, forbid or force a page break.")

diff --git a/scm/define-music-types.scm b/scm/define-music-types.scm
index a0762025de6455f6345082dd0af0d035045c352d..d9a5f09ac872f35ada7bd598e54115864cf53d73 100644 (file)
--- a/scm/define-music-types.scm
+++ b/scm/define-music-types.scm
@@ -32,6 +32,24 @@ to be used by the sequential-iterator"
          (make-music 'BarCheck
                      'origin location))))
 
+(define (make-ottava-set music)
+  "Set context properties for an ottava bracket."
+  (let ((octavation (ly:music-property music 'ottava-number)))
+
+    (list (context-spec-music
+          (make-apply-context
+           (lambda (context)
+             (let ((offset (* -7 octavation))
+                   (string (assoc-get octavation '((2 . "15ma")
+                                                   (1 . "8va")
+                                                   (0 . #f)
+                                                   (-1 . "8vb")
+                                                   (-2 . "15mb")))))
+               (set! (ly:context-property context 'middleCOffset) offset)
+               (set! (ly:context-property context 'ottavation) string)
+               (ly:set-middle-C! context))))
+          'Staff))))
+
 (define-public music-descriptions
   `(
     (AbsoluteDynamicEvent
@@ -336,6 +354,13 @@ Note the explicit font switch.")
        (types . (general-music event note-grouping-event))
        ))
 
+    (OttavaMusic
+     . ((description . "Start or stop an ottava bracket.")
+       (iterator-ctor . ,ly:sequential-iterator::constructor)
+       (elements-callback . ,make-ottava-set)
+       (types . (general-music ottava-music))
+       ))
+
     (OverrideProperty
      . ((description . "Extend the definition of a graphical object.
 

diff --git a/scm/music-functions.scm b/scm/music-functions.scm
index 011cdaf2abc27eeb3b784bd7c019185b4b66683b..40c68c0c7d3942b002a0325604086f7aab665dcc 100644 (file)
--- a/scm/music-functions.scm
+++ b/scm/music-functions.scm
@@ -48,6 +48,10 @@
   (make-procedure-with-setter ly:prob-property
                              ly:prob-set-property!))
 
+(define-public ly:context-property
+  (make-procedure-with-setter ly:context-property
+                             ly:context-set-property!))
+
 (define-public (music-map function music)
   "Apply @var{function} to @var{music} and all of the music it contains.
 
@@ -487,32 +491,6 @@ i.e.  this is not an override"
   (make-music 'PropertyUnset
              'symbol sym))
 
-(define-public (make-ottava-set octavation)
-  (let ((m (make-music 'ApplyContext)))
-    (define (ottava-modify context)
-      "Either reset middleCPosition to the stored original, or remember
-old middleCPosition, add OCTAVATION to middleCPosition, and set
-OTTAVATION to `8va', or whatever appropriate."
-      (if (number? (ly:context-property         context 'middleCOffset))
-         (let ((where (ly:context-property-where-defined context 'middleCOffset)))
-           (ly:context-unset-property where 'middleCOffset)
-           (ly:context-unset-property where 'ottavation)))
-
-      (let* ((offset (* -7 octavation))
-            (string (assoc-get octavation '((2 . "15ma")
-                                            (1 . "8va")
-                                            (0 . #f)
-                                            (-1 . "8vb")
-                                            (-2 . "15mb")))))
-       (ly:context-set-property! context 'middleCOffset offset)
-       (ly:context-set-property! context 'ottavation string)
-       (ly:set-middle-C! context)))
-    (set! (ly:music-property m 'procedure) ottava-modify)
-    (context-spec-music m 'Staff)))
-
-(define-public (set-octavation ottavation)
-  (ly:export (make-ottava-set ottavation)))
-
 ;;; Need to keep this definition for \time calls from parser
 (define-public (make-time-signature-set num den)
   "Set properties for time signature NUM/DEN."