]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/accidental-placement.cc
* lily/accidental-placement.cc (split_accidentals): new function
[lilypond.git] / lily / accidental-placement.cc
index 5a8693b8abb17b95dd0c138193a46082245d1c74..c05932ecee0e40a62f2a112858239666bc353b31 100644 (file)
@@ -17,7 +17,12 @@ source file of the GNU LilyPond music typesetter
 #include "accidental-placement.hh"
 #include "note-column.hh"
 #include "group-interface.hh"
+#include "note-collision.hh"
+#include "accidental-interface.hh"
 
+/*
+  Hmm. why not group-extent? 
+ */
 MAKE_SCHEME_CALLBACK(Accidental_placement,extent_callback, 2);
 SCM
 Accidental_placement::extent_callback(SCM s, SCM axis)
@@ -84,6 +89,64 @@ Accidental_placement::add_accidental (Grob* me, Grob* a)
   me->set_grob_property ("accidentals", accs);
 }
 
+/*
+  Split into break reminders.
+ */
+void
+Accidental_placement::split_accidentals (Grob * accs,
+                                        Link_array<Grob> *break_reminder,
+                                        Link_array<Grob> *real_acc)
+{
+  for (SCM acs =accs->get_grob_property ("accidentals"); gh_pair_p (acs);
+       acs =gh_cdr (acs))
+    for (SCM s = gh_cdar (acs); gh_pair_p (s); s = gh_cdr (s))
+      {
+       Grob *a = unsmob_grob (gh_car (s));
+
+       if (unsmob_grob (a->get_grob_property ("tie")))
+         break_reminder->push (a);
+       else
+         real_acc->push (a);
+      }
+}
+
+/*
+  Accidentals are special, because they appear and disappear before
+  and after ties at will.
+*/
+Interval
+Accidental_placement::get_relevant_accidental_extent (Grob *me,
+                                                     Item *item_col,
+                                                     Grob *left_object)
+{
+  Link_array<Grob> br, ra;
+  Link_array<Grob> *which = 0;
+
+  Accidental_placement::split_accidentals (me, &br, &ra);
+  br.concat (ra);
+  
+  if (dynamic_cast<Item*>(left_object)->break_status_dir () == RIGHT)
+    which = & br;
+  else
+    which = & ra;
+  
+  Interval extent;
+  for (int i = 0; i < which->size(); i++)
+    {
+      extent.unite (which->elem(i)->extent (item_col, X_AXIS));
+    }
+
+  if (!extent.empty_b())
+    {
+      Real p = gh_scm2double (me->get_grob_property ("left-padding"));
+      extent[LEFT] -= p;
+    }
+  
+  return extent;
+}
+
+
+
 struct Accidental_placement_entry
 {
   Array<Skyline_entry> left_skyline_;
@@ -100,13 +163,66 @@ struct Accidental_placement_entry
   }
 };
 
+static Interval all_accidental_vertical_extent;
+Real ape_priority (Accidental_placement_entry const * a)
+{
+  return a->vertical_extent_[UP];
+}
+
+  
 
 int ape_compare (Accidental_placement_entry *const &a,
                 Accidental_placement_entry *const &b)
 {
-  return sign (a->vertical_extent_.length () - b->vertical_extent_.length());
+  return sign (ape_priority (a) - ape_priority(b));
 }
 
+int ape_rcompare (Accidental_placement_entry *const &a,
+                Accidental_placement_entry *const &b)
+{
+  return -sign (ape_priority (a) - ape_priority(b));
+}
+
+
+/*
+
+TODO: should favor
+
+  b
+ b
+
+placement
+*/
+void
+stagger_apes (Link_array<Accidental_placement_entry> *apes)
+{
+  Link_array<Accidental_placement_entry> asc = *apes;
+
+
+  asc.sort (&ape_compare);
+
+  apes->clear();
+
+  int i =0;
+  int parity = 1;
+  while (i < asc.size())
+    {
+      Accidental_placement_entry * a = 0;      
+      if (parity)
+       a = asc.pop();
+      else
+       a = asc[i++];
+
+      apes->push (a);
+      parity = !parity;
+    }
+
+  apes->reverse();
+}
+
+  
+
 /*
   Return: width as SCM interval.
 
@@ -132,11 +248,9 @@ int ape_compare (Accidental_placement_entry *const &a,
    The naturals should be left of the C as well; they should
    be separate accs.
 
-   TODO: Try to combine Apes before sorting them: this will allow a
-   better placement.
+   Note that this placement problem looks NP hard, so we just use a
+   simple strategy, not an optimal choice.
 
-   Note that this placement problem is almost certainly NP hard, so we
-   just use a simple strategy, not an optimal choice.
 */
 
 SCM
@@ -144,6 +258,10 @@ Accidental_placement::position_accidentals (Grob * me)
 {
   SCM accs = me->get_grob_property ("accidentals");
 
+  /*
+    TODO: there is a bug in this code. If two accs are on the same
+    Y-position, they share an Ape, and will be pritned in overstrike.
+   */
   Link_array<Accidental_placement_entry> apes;
   for (SCM s = accs; gh_pair_p (s); s =gh_cdr (s))
     {
@@ -157,24 +275,25 @@ Accidental_placement::position_accidentals (Grob * me)
     }
 
 
-  Grob *commony =0 ;
-  for (int i= apes.size (); i--;)
-    commony = common_refpoint_of_array  (apes[i]->grobs_, commony, Y_AXIS);
+  Grob *common[] = {me, 0};
 
+  /*
+    First we must extract *all* pointers. We can only determine
+    extents if we're sure that we've found the right common refpoint
+   */
   Link_array<Grob> note_cols, heads;
   for (int i= apes.size (); i--;)
-    {
+    { 
       Accidental_placement_entry * ape = apes[i];
-      ape->left_skyline_ = empty_skyline ( LEFT);
-      ape->right_skyline_ = empty_skyline ( RIGHT);
-   
-      for (int j = apes[i]->grobs_.size(); j--;)
+      for (int j = ape->grobs_.size(); j--;)
        {
-         Grob * a = apes[i]->grobs_[j];
-         Box b;
-         b[X_AXIS] = a->extent (me, X_AXIS);
-         b[Y_AXIS] = a->extent (commony, Y_AXIS);
+         Grob * a = ape->grobs_[j];
 
+         if (common[Y_AXIS])
+           common[Y_AXIS] = common[Y_AXIS]->common_refpoint (a, Y_AXIS);
+         else
+           common[Y_AXIS] = a;
+         
          Grob *head = a->get_parent (Y_AXIS);
 
          Grob * col = head->get_parent (X_AXIS);
@@ -182,18 +301,24 @@ Accidental_placement::position_accidentals (Grob * me)
            note_cols.push (col);
          else
            heads.push (head);
-         
-         ape->extents_.push (b);
-         
-         /*
-           TODO: replace the extents of a flat by combination of two
-           bboxes, so that we use the shape of the flat better.
-         */
-         insert_extent_into_skyline (&ape->left_skyline_, b, Y_AXIS, LEFT);
-         insert_extent_into_skyline (&ape->right_skyline_ , b,Y_AXIS, RIGHT);
        }
     }
 
+  /*
+    This is a little kludgy: to get all notes, we look if there are
+    collisions as well.
+   */
+  for (int i = note_cols.size() ; i--;)
+    {
+      Grob *c = note_cols[i]->get_parent (X_AXIS);
+      if (Note_collision_interface::has_interface (c))
+       {
+         Link_array<Grob> gs =
+           Pointer_group_interface__extract_grobs (c, (Grob*)0, "elements");
+      
+         note_cols.concat (gs);
+       }
+    }
   
   for (int i = note_cols.size() ; i--;)
     {
@@ -204,8 +329,32 @@ Accidental_placement::position_accidentals (Grob * me)
     }
   heads.default_sort();
   heads.uniq();
-  commony = common_refpoint_of_array (heads, commony, Y_AXIS);
+  common[Y_AXIS] = common_refpoint_of_array (heads, common[Y_AXIS], Y_AXIS);
+
   
+  for (int i= apes.size (); i--;)
+    {
+      Accidental_placement_entry * ape = apes[i];
+      ape->left_skyline_ = empty_skyline (LEFT);
+      ape->right_skyline_ = empty_skyline (RIGHT);
+   
+      for (int j = apes[i]->grobs_.size(); j--;)
+       {
+         Grob * a = apes[i]->grobs_[j];
+
+         Array<Box> boxes = Accidental_interface::accurate_boxes (a, common);
+         
+         ape->extents_.concat (boxes);
+         for (int j  = boxes.size(); j--;)
+           {
+             insert_extent_into_skyline (&ape->left_skyline_, boxes[j], Y_AXIS, LEFT);
+             insert_extent_into_skyline (&ape->right_skyline_ , boxes[j], Y_AXIS, RIGHT);
+           }
+       }
+    }
+
+
+  Interval total;
   for (int i = apes.size(); i--;)
     {
       Interval y ;
@@ -215,18 +364,19 @@ Accidental_placement::position_accidentals (Grob * me)
          y.unite (apes[i]->extents_[j][Y_AXIS]);
        }
       apes[i]->vertical_extent_ = y;
+      total.unite (y);
     }
-  
-  apes.sort (&ape_compare);  
+  all_accidental_vertical_extent = total;
+  stagger_apes (&apes);
 
   Accidental_placement_entry * head_ape = new Accidental_placement_entry;
-  Grob *commonx = common_refpoint_of_array (heads, me, X_AXIS);  
+  common[X_AXIS] = common_refpoint_of_array (heads, common[X_AXIS], X_AXIS);  
   Array<Skyline_entry> head_skyline (empty_skyline (LEFT));
   Array<Box> head_extents;
   for (int i = heads.size(); i--;)
     {
-      Box b(heads[i]->extent (commonx, X_AXIS),
-           heads[i]->extent (commony, Y_AXIS));
+      Box b(heads[i]->extent (common[X_AXIS] , X_AXIS),
+           heads[i]->extent (common[Y_AXIS], Y_AXIS));
 
       insert_extent_into_skyline (&head_skyline, b , Y_AXIS, LEFT);
     }
@@ -238,26 +388,33 @@ Accidental_placement::position_accidentals (Grob * me)
   if (gh_number_p (rs))
     head_ape->offset_ -= gh_scm2double (rs);
 
-  Real padding = 0.1;
+  
+  Real padding = 0.2;
+  SCM spad = me->get_grob_property ("padding");
+  if (gh_number_p (spad))
+    padding = gh_scm2double (spad);
+
+
+  /*
+    TODO:
+
+    There is a bug in this code: the left_skylines should be
+    accumulated, otherwise the b will collide with bb in
+
+      bb
+    b 
+      n 
+    
+   */
   apes.push (head_ape);
   for (int i= apes.size () -1 ; i-- > 0;)
     {
       Accidental_placement_entry *ape = apes[i];
       Real d = 0.0;
-      /*
-       confusing naming: left_skyline is a skyline pointing to the
-       left. It is on the right of the curent entry.
-       */
-
       int j = i+1;
       do {
-       Array<Skyline_entry> const *right_sky =
-         (j < apes.size())
-         ? &apes[j]->left_skyline_
-         : &head_skyline;
-
        d = - skyline_meshing_distance (ape->right_skyline_,
-                                            *right_sky);
+                                       apes[j]->left_skyline_);
 
        if (!isinf(d)
            || j + 1 == apes.size())
@@ -313,4 +470,4 @@ Accidental_placement::position_accidentals (Grob * me)
 ADD_INTERFACE(Accidental_placement,
              "accidental-placement-interface",
              "Take care of complex accidental collisions.",
-             "left-padding right-padding accidentals alignment-done")
+             "left-padding padding right-padding accidentals alignment-done")