]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/coherent-ligature-engraver.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / coherent-ligature-engraver.cc
index 091403154ec68cf04395189e597533e3f267b854..ff1691ef643312fe78fd2ab2519216ff02b36402 100644 (file)
@@ -1,17 +1,19 @@
 /*
   coherent-ligature-engraver.cc -- implement Coherent_ligature_engraver
-  
+
   source file of the GNU LilyPond music typesetter
-  
-  (c)  2003 Juergen Reuter <reuter@ipd.uka.de>
- */
+
+  (c) 2003--2006 Juergen Reuter <reuter@ipd.uka.de>
+*/
 
 #include "coherent-ligature-engraver.hh"
-#include "item.hh"
+
 #include "warn.hh"
 #include "staff-symbol-referencer.hh"
 #include "spanner.hh"
 #include "paper-column.hh"
+#include "pitch.hh"
+#include "pointer-group-interface.hh"
 
 /*
  * This abstract class serves as common superclass for all ligature
  *
  * - collect all accidentals that occur within the ligature and put
  * them at the left side of the ligature (TODO; see function
- * collect_accidentals()),
+ * collect_accidentals ()),
  *
  * - collapse superflous space after each ligature (TODO).
  *
  * Concrete subclasses must implement function build_ligature (Spanner
- * *, Array<Grob_info>).  This function is responsible for actually
+ * *, vector<Grob_info>).  This function is responsible for actually
  * building the ligature by transforming the array of noteheads.
  *
  * Currently, there are two subclasses: Gregorian_ligature_engraver
@@ -50,9 +52,8 @@
  * any further accidental for that pitch within that ligature
  * (actually, in such a case, the user should split the ligature into
  * two separate ligatures).  Similarly, any object that, in ordinary
- * notation, may be put to the left or to the right of a
- * note-head/ligature-head, should be collected and put before or
- * after the ligature.
+ * notation, may be put to the left or to the right of a note-head,
+ * should be collected and put before or after the ligature.
  *
  * TODO: make spacing more robust: do not screw up spacing if user
  * erroneously puts rest in ligature.
  * of the ligature (to preemptively avoid collision with adjacent
  * notes); or maybe just additionally create a
  * mensural/vaticana/whatever-ligature grob (e.g. via
- * Mensural_ligature::brew_molecule(SCM)) that just consists of a
+ * Mensural_ligature::print (SCM)) that just consists of a
  * bounding box around all primitives of the ligature.
  *
- * TODO: Maybe move functions fold_up_primitives() and
- * join_primitives() from subclasses to here?  N.B. it is not
+ * TODO: Maybe move functions fold_up_primitives () and
+ * join_primitives () from subclasses to here?  N.B. it is not
  * appropriate to put these into Ligature_engraver, since, for
  * example, Ligature_bracket_engraver does not share any of this code.
  */
  * TODO: Let superflous space after each ligature collapse.  The
  * following code should help in doing so (though it does not yet
  * fully work).  Just put the following code into
- * Spacing_spanner::do_measure().  I put it temporarily here as memo
+ * Spacing_spanner::do_measure ().  I put it temporarily here as memo
  * until it really works and I also get Han-Wen's/Jan's permission to
  * add it to the spacing spanner code.
  */
-#if 0 // experimental code to collapse spacing after ligature
-      SCM incr_scm = lc->get_grob_property ("forced-spacing");
-      if (incr_scm != SCM_EOL) /* (Paper_column::musical_b (l)) */
-       {
-         me->warning (_f ("gotcha: ptr=%ul", lc));//debug
-         ly_display_scm (lc->self_scm ());
-         Real distance;
-         if (incr_scm != SCM_EOL)
-           {
-             distance = gh_scm2double (incr_scm);
-           }
-         else
-           {
-             me->warning ("distance undefined, assuming 0.1");
-             distance = 0.1;
-           }
-         me->warning (_f ("distance=%f", distance));//debug
-         Real strength = 1.0;
-         Spaceable_grob::add_spring (lc, rc, distance, strength, false);
-         if (Item *rb = r->find_prebroken_piece (LEFT))
-           Spaceable_grob::add_spring (lc, rb, distance, strength, false);
+#if 0 /* experimental code to collapse spacing after ligature */
+SCM incr_scm = lc->get_property ("forced-spacing");
+if (incr_scm != SCM_EOL) /* (Paper_column::is_musical (l)) */
+  {
+    me->warning (_f ("gotcha: ptr=%ul", lc));//debug
+    ly_display_scm (lc->self_scm ());
+    Real distance;
+    if (incr_scm != SCM_EOL)
+      distance = scm_to_double (incr_scm);
+    else
+      {
+       me->warning (_ ("distance undefined, assuming 0.1"));
+       distance = 0.1;
+      }
+    me->warning (_f ("distance=%f", distance));//debug
+    Real inverse_strength = 1.0;
+    Spaceable_grob::add_spring (lc, rc, distance, inverse_strength);
+    if (Item *rb = r->find_prebroken_piece (LEFT))
+      Spaceable_grob::add_spring (lc, rb, distance, inverse_strength);
 
-         continue;
-       }
+    continue;
+  }
 #endif
 
-Coherent_ligature_engraver::Coherent_ligature_engraver ()
-{
-}
-
 /*
  * TODO: move this function to class Item?
  */
 void
 Coherent_ligature_engraver::get_set_column (Item *item, Paper_column *column)
 {
-  Item *parent = dynamic_cast<Item*> (item->get_parent (X_AXIS));
+  Item *parent = dynamic_cast<Item *> (item->get_parent (X_AXIS));
   if (!parent)
     {
       programming_error ("failed tweaking paper column in ligature");
       return;
     }
 
-  String name = parent->name ();
-  if (!String::compare (name, "PaperColumn"))
+  string name = parent->name ();
+  if (name != "PaperColumn")
     {
       // Change column not only for targeted item (NoteColumn), but
       // also for all associated grobs (NoteSpacing, SeparationItem).
       Grob *sl = Staff_symbol_referencer::get_staff_symbol (item);
-      for (SCM tail = parent->get_grob_property ("elements");
-          gh_pair_p (tail);
-          tail = ly_cdr (tail))
+
+      extract_item_set (parent, "elements", elements);
+
+      for (vsize i = elements.size (); i--;)
        {
-         Item *sibling = unsmob_item (ly_car (tail));
-         if ((sibling) &&
-             (Staff_symbol_referencer::get_staff_symbol (sibling) == sl))
+         Item *sibling = elements[i];
+         if ((sibling)
+             && (Staff_symbol_referencer::get_staff_symbol (sibling) == sl))
            {
-#if 0 // experimental code to collapse spacing after ligature
+#if 0 /* experimental code to collapse spacing after ligature */
              Grob *sibling_parent = sibling->get_parent (X_AXIS);
              sibling_parent->warning (_f ("Coherent_ligature_engraver: "
-                                          "setting `spacing-increment = "
+                                          "setting `spacing-increment="
                                           "0.01': ptr=%ul", parent));
-             sibling_parent->set_grob_property("forced-spacing",
-                                             gh_double2scm (0.01));
+             sibling_parent->set_property ("forced-spacing",
+                                           scm_from_double (0.01));
 #endif
              sibling->set_parent (column, X_AXIS);
            }
        }
     }
   else
-    {
-      get_set_column (parent, column);
-    }
+    get_set_column (parent, column);
 }
 
 /*
@@ -165,38 +159,47 @@ Coherent_ligature_engraver::get_set_column (Item *item, Paper_column *column)
  * occurs within the broken ligatures any more.
  */
 void
-Coherent_ligature_engraver::collect_accidentals (Spanner *, Array<Grob_info>)
+Coherent_ligature_engraver::collect_accidentals (Spanner *, vector<Grob_info>)
 {
   /* TODO */
 }
 
 void
-Coherent_ligature_engraver::build_ligature (Spanner *, Array<Grob_info>)
+compute_delta_pitches (vector<Grob_info> primitives)
 {
-  programming_error ("Cohrent_ligature_engraver::build_ligature (): "
-                    "this is an abstract method that should not be called, "
-                    "but overridden by a subclass");
+  int prev_pitch = 0;
+  int delta_pitch = 0;
+  Item *prev_primitive = 0, *primitive = 0;
+  for (vsize i = 0; i < primitives.size (); i++)
+    {
+      primitive = dynamic_cast<Item *> (primitives[i].grob ());
+      Music *music_cause = primitives[i].music_cause ();
+      int pitch
+       = unsmob_pitch (music_cause->get_property ("pitch"))->steps ();
+      if (prev_primitive)
+       {
+         delta_pitch = pitch - prev_pitch;
+         prev_primitive->set_property ("delta-pitch",
+                                       scm_from_int (delta_pitch));
+       }
+      prev_pitch = pitch;
+      prev_primitive = primitive;
+    }
+  primitive->set_property ("delta-pitch", scm_from_int (0));
 }
 
 void
 Coherent_ligature_engraver::typeset_ligature (Spanner *ligature,
-                                             Array<Grob_info> primitives)
+                                             vector<Grob_info> primitives)
 {
+  // compute some commonly needed context info stored as grob
+  // properties
+  compute_delta_pitches (primitives);
+
   // prepare ligature for typesetting
   build_ligature (ligature, primitives);
   collect_accidentals (ligature, primitives);
-
-  // now actually typeset
-  for (int i = 0; i < primitives.size (); i++)
-    {
-      typeset_grob (primitives[i].grob_);
-    }
 }
 
-ENTER_DESCRIPTION (Coherent_ligature_engraver,
-/* descr */       "This is an abstract class.  Subclasses such as Gregorian_ligature_engraver handle ligatures by glueing special ligature heads together.",
-/* creats*/       "",
-/* accepts */     "ligature-event abort-event",
-/* acks  */      "ligature-head-interface note-head-interface rest-interface",
-/* reads */       "",
-/* write */       "");
+// no ADD_ACKNOWLEDGER / ADD_ACKNOWLEDGER / ADD_TRANSLATOR macro calls
+// since this class is abstract