]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/accidental-placement.cc
Refactor accidental-placement.
[lilypond.git] / lily / accidental-placement.cc
index 0e0c3ce9a6b6a1ba86f153ddf453692cc77264fc..0f14cc9a83e94e021e173075c6b1dfa4ddc9b7ff 100644 (file)
@@ -3,20 +3,22 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2002--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 2002--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 
-
 #include "accidental-placement.hh"
-#include "skyline.hh"
+
+#include "item.hh"
+#include "rhythmic-head.hh"
+#include "accidental-interface.hh"
 #include "music.hh"
-#include "pitch.hh"
-#include "warn.hh"
+#include "note-collision.hh"
 #include "note-column.hh"
 #include "pointer-group-interface.hh"
-#include "note-collision.hh"
-#include "accidental-interface.hh"
+#include "skyline.hh"
+#include "stream-event.hh"
+#include "warn.hh"
 
 
 void
@@ -26,10 +28,10 @@ Accidental_placement::add_accidental (Grob *me, Grob *a)
   a->set_property ("X-offset", Grob::x_parent_positioning_proc);
   SCM cause = a->get_parent (Y_AXIS)->get_property ("cause");
 
-  Music *mcause = unsmob_music (cause);
+  Stream_event *mcause = unsmob_stream_event (cause);
   if (!mcause)
     {
-      programming_error ("note head has no music cause");
+      programming_error ("note head has no event cause");
       return;
     }
 
@@ -57,8 +59,8 @@ Accidental_placement::add_accidental (Grob *me, Grob *a)
 */
 void
 Accidental_placement::split_accidentals (Grob *accs,
-                                        Link_array<Grob> *break_reminder,
-                                        Link_array<Grob> *real_acc)
+                                        vector<Grob*> *break_reminder,
+                                        vector<Grob*> *real_acc)
 {
   for (SCM acs = accs->get_object ("accidental-grobs"); scm_is_pair (acs);
        acs = scm_cdr (acs))
@@ -66,63 +68,43 @@ Accidental_placement::split_accidentals (Grob *accs,
       {
        Grob *a = unsmob_grob (scm_car (s));
 
-       if (unsmob_grob (a->get_object ("tie")))
-         break_reminder->push (a);
+       if (unsmob_grob (a->get_object ("tie"))
+           && !to_boolean (a->get_property ("forced")))
+         break_reminder->push_back (a);
        else
-         real_acc->push (a);
+         real_acc->push_back (a);
       }
 }
 
-/*
-  Accidentals are special, because they appear and disappear after
-  ties at will.
-*/
-Interval
-Accidental_placement::get_relevant_accidental_extent (Grob *me,
-                                                     Item *item_col,
-                                                     Grob *left_object)
+vector<Grob*>
+Accidental_placement::get_relevant_accidentals (vector<Grob*> const &elts, Grob *left)
 {
-  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));
+  vector<Grob*> br;
+  vector<Grob*> ra;
+  vector<Grob*> ret;
+  bool right = dynamic_cast<Item *> (left)->break_status_dir () == RIGHT;
 
-  if (!extent.is_empty ())
+  for (vsize i = 0; i < elts.size (); i++)
     {
-      Real p = robust_scm2double (me->get_property ("left-padding"), 0.2);
-      extent[LEFT] -= p;
-    }
+      split_accidentals (elts[i], &br, &ra);
+      
+      ret.insert (ret.end (), ra.begin (), ra.end ());
 
-  return extent;
+      if (right)
+       ret.insert (ret.end (), br.begin (), br.end ());
+    }
+  return ret;
 }
 
 struct Accidental_placement_entry
 {
-  Array<Skyline_entry> left_skyline_;
-  Array<Skyline_entry> right_skyline_;
+  Skyline left_skyline_;
+  Skyline right_skyline_;
   Interval vertical_extent_;
-  Array<Box> extents_;
-  Link_array<Grob> grobs_;
-  Real offset_;
-  int notename_;
-  Accidental_placement_entry ()
-  {
-    offset_ = 0.0;
-    notename_ = -1;
-  }
+  vector<Box> extents_;
+  vector<Grob*> grobs_;
 };
 
-static Interval all_accidental_vertical_extent;
 Real ape_priority (Accidental_placement_entry const *a)
 {
   return a->vertical_extent_[UP];
@@ -134,6 +116,12 @@ int ape_compare (Accidental_placement_entry *const &a,
   return sign (ape_priority (a) - ape_priority (b));
 }
 
+bool ape_less (Accidental_placement_entry *const &a,
+              Accidental_placement_entry *const &b)
+{
+  return ape_priority (a) < ape_priority (b);
+}
+
 int ape_rcompare (Accidental_placement_entry *const &a,
                  Accidental_placement_entry *const &b)
 {
@@ -149,31 +137,194 @@ int ape_rcompare (Accidental_placement_entry *const &a,
   placement
 */
 void
-stagger_apes (Link_array<Accidental_placement_entry> *apes)
+stagger_apes (vector<Accidental_placement_entry*> *apes)
 {
-  Link_array<Accidental_placement_entry> asc = *apes;
+  vector<Accidental_placement_entry*> asc = *apes;
 
-  asc.sort (&ape_compare);
+  vector_sort (asc, &ape_less);
 
   apes->clear ();
 
-  int i = 0;
   int parity = 1;
-  while (i < asc.size ())
+  for (vsize i = 0; i < asc.size ();)
     {
       Accidental_placement_entry *a = 0;
       if (parity)
-       a = asc.pop ();
+       {
+         a = asc.back ();
+         asc.pop_back ();
+       }
       else
        a = asc[i++];
 
-      apes->push (a);
+      apes->push_back (a);
       parity = !parity;
     }
 
-  apes->reverse ();
+  reverse (*apes);
+}
+
+static vector<Accidental_placement_entry*>
+build_apes (SCM accs)
+{
+  vector<Accidental_placement_entry*> apes;
+  for (SCM s = accs; scm_is_pair (s); s = scm_cdr (s))
+    {
+      Accidental_placement_entry *ape = new Accidental_placement_entry;
+
+      for (SCM t = scm_cdar (s); scm_is_pair (t); t = scm_cdr (t))
+       ape->grobs_.push_back (unsmob_grob (scm_car (t)));
+
+      apes.push_back (ape);
+    }
+
+  return apes;
+}
+
+static void
+set_ape_skylines (Accidental_placement_entry *ape,
+                 Grob **common)
+{
+  for (vsize i = ape->grobs_.size (); i--;)
+    {
+      Grob *a = ape->grobs_[i];
+      vector<Box> boxes = Accidental_interface::accurate_boxes (a, common);
+      ape->extents_.insert (ape->extents_.end (), boxes.begin (), boxes.end ());
+
+      for (vsize j = boxes.size (); j--;)
+       ape->vertical_extent_.unite (boxes[j][Y_AXIS]);
+    }
+  ape->left_skyline_ = Skyline (ape->extents_, 0, Y_AXIS, LEFT);
+  ape->right_skyline_ = Skyline (ape->extents_, 0, Y_AXIS, RIGHT);
+}
+
+static vector<Grob*>
+extract_heads_and_stems (vector<Accidental_placement_entry*> const &apes)
+{
+  vector<Grob*> note_cols;
+  vector<Grob*> ret;
+
+  for (vsize i = apes.size (); i--;)
+    {
+      Accidental_placement_entry *ape = apes[i];
+      for (vsize j = ape->grobs_.size (); j--;)
+       {
+         Grob *acc = ape->grobs_[j];
+         Grob *head = acc->get_parent (Y_AXIS);
+         Grob *col = head->get_parent (X_AXIS);
+
+         if (Note_column::has_interface (col))
+           note_cols.push_back (col);
+         else
+           ret.push_back (head);
+       }
+    }
+
+  /*
+    This is a little kludgy: in case there are note columns without
+    accidentals, we get them from the Note_collision objects.
+  */
+  for (vsize i = note_cols.size (); i--;)
+    {
+      Grob *c = note_cols[i]->get_parent (X_AXIS);
+      if (Note_collision_interface::has_interface (c))
+       {
+         extract_grob_set (c, "elements", columns);
+         concat (note_cols, columns);
+       }
+    }
+
+  /* Now that we have all of the columns, grab all of the note-heads */
+  for (vsize i = note_cols.size (); i--;)
+    concat (ret, extract_grob_array (note_cols[i], "note-heads"));
+
+  /* Now that we have all of the heads, grab all of the stems */
+  for (vsize i = ret.size (); i--;)
+    if (Grob *s = Rhythmic_head::get_stem (ret[i]))
+      ret.push_back (s);
+
+
+  vector_sort (ret, less<Grob*> ());
+  uniq (ret);
+  return ret;
+}
+
+static Grob*
+common_refpoint_of_accidentals (vector<Accidental_placement_entry*> const &apes, Axis a)
+{
+  Grob *ret = 0;
+
+  for (vsize i = apes.size (); i--;)
+    for (vsize j = apes[i]->grobs_.size (); j--;)
+      {
+       if (!ret)
+         ret = apes[i]->grobs_[j];
+       else
+         ret = ret->common_refpoint (apes[i]->grobs_[j], a);
+      }
+
+  return ret;
+}
+
+static Skyline
+build_heads_skyline (vector<Grob*> const &heads_and_stems,
+                    Grob **common)
+{
+  vector<Box> head_extents;
+  for (vsize i = heads_and_stems.size (); i--;)
+    head_extents.push_back (Box (heads_and_stems[i]->extent (common[X_AXIS], X_AXIS),
+                                heads_and_stems[i]->pure_height (common[Y_AXIS], 0, INT_MAX)));
+
+  return Skyline (head_extents, 0, Y_AXIS, LEFT);
 }
 
+/*
+  Position the apes, starting from the right, so that they don't collide.
+  Return the total width.
+*/
+static Interval
+position_apes (Grob *me,
+              vector<Accidental_placement_entry*> const &apes,
+              Skyline const &heads_skyline)
+{
+  Real padding = robust_scm2double (me->get_property ("padding"), 0.2);
+  Skyline left_skyline = heads_skyline;
+  left_skyline.raise (-robust_scm2double (me->get_property ("right-padding"), 0));
+  
+  /*
+    Add accs entries right-to-left.
+  */
+  Interval width;
+  Real last_offset = 0.0;
+  for (vsize i = apes.size (); i-- > 0;)
+    {
+      Accidental_placement_entry *ape = apes[i];
+
+      Real offset = -ape->right_skyline_.distance (left_skyline);
+      if (isinf (offset))
+       offset = last_offset;
+      else
+       offset -= padding;
+
+      Skyline new_left_skyline = ape->left_skyline_;
+      new_left_skyline.raise (offset);
+      new_left_skyline.merge (left_skyline);
+      left_skyline = new_left_skyline;
+
+      /* Shift all of the accidentals in this ape */
+      for (vsize j = ape->grobs_.size (); j--;)
+       ape->grobs_[j]->translate_axis (offset, X_AXIS);
+
+      for (vsize j = ape->extents_.size (); j--;)
+       width.unite (offset + ape->extents_[j][X_AXIS]);
+
+      last_offset = offset;
+    }
+
+  return width;
+}
+
+
 /*
   This routine computes placements of accidentals. During
   add_accidental (), accidentals are already grouped by note, so that
@@ -215,7 +366,7 @@ stagger_apes (Link_array<Accidental_placement_entry> *apes)
 
 */
 
-MAKE_SCHEME_CALLBACK(Accidental_placement, calc_positioning_done, 1);
+MAKE_SCHEME_CALLBACK (Accidental_placement, calc_positioning_done, 1);
 SCM
 Accidental_placement::calc_positioning_done (SCM smob)
 {
@@ -223,188 +374,46 @@ Accidental_placement::calc_positioning_done (SCM smob)
   if (!me->is_live ())
     return SCM_BOOL_T;
 
+  me->set_property ("positioning-done", SCM_BOOL_T);
+  
   SCM accs = me->get_object ("accidental-grobs");
   if (!scm_is_pair (accs))
     return SCM_BOOL_T;
 
-  /*
-    TODO: there is a bug in this code. If two accs are on the same
-    Y-position, they share an Ape, and will be printed in overstrike.
-  */
-  Link_array<Accidental_placement_entry> apes;
-  for (SCM s = accs; scm_is_pair (s); s = scm_cdr (s))
-    {
-      Accidental_placement_entry *ape = new Accidental_placement_entry;
-      ape->notename_ = scm_to_int (scm_caar (s));
-
-      for (SCM t = scm_cdar (s); scm_is_pair (t); t = scm_cdr (t))
-       ape->grobs_.push (unsmob_grob (scm_car (t)));
-
-      apes.push (ape);
-    }
+  vector<Accidental_placement_entry*> apes = build_apes (accs);
 
   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];
-      for (int j = ape->grobs_.size (); j--;)
-       {
-         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);
-         if (Note_column::has_interface (col))
-           note_cols.push (col);
-         else
-           heads.push (head);
-       }
-    }
-
-  /*
-    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))
-       {
-         extract_grob_set (c, "elements", gs);
-
-         note_cols.concat (gs);
-       }
-    }
-
-  for (int i = note_cols.size (); i--;)
-    heads.concat (extract_grob_array (note_cols[i], "note-heads"));
-
-  heads.default_sort ();
-  heads.uniq ();
-  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);
+  vector<Grob*> heads_and_stems = extract_heads_and_stems (apes);
 
-         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);
-           }
-       }
-    }
+  common[Y_AXIS] = common_refpoint_of_accidentals (apes, Y_AXIS);
+  common[Y_AXIS] = common_refpoint_of_array (heads_and_stems, common[Y_AXIS], Y_AXIS);
+  common[X_AXIS] = common_refpoint_of_array (heads_and_stems, me, X_AXIS);
 
-  Interval total;
-  for (int i = apes.size (); i--;)
-    {
-      Interval y;
+  for (vsize i = apes.size (); i--;)
+    set_ape_skylines (apes[i], common);
+  Skyline heads_skyline = build_heads_skyline (heads_and_stems, common);
 
-      for (int j = apes[i]->extents_.size (); j--;)
-       y.unite (apes[i]->extents_[j][Y_AXIS]);
-      apes[i]->vertical_extent_ = y;
-      total.unite (y);
-    }
-  all_accidental_vertical_extent = total;
   stagger_apes (&apes);
+  Interval width = position_apes (me, apes, heads_skyline);
 
-  Accidental_placement_entry *head_ape = new Accidental_placement_entry;
-  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 (common[X_AXIS], X_AXIS),
-            heads[i]->extent (common[Y_AXIS], Y_AXIS));
-
-      insert_extent_into_skyline (&head_skyline, b, Y_AXIS, LEFT);
-    }
-
-  head_ape->left_skyline_ = head_skyline;
-  head_ape->offset_ = 0.0;
-
-  Real padding = robust_scm2double (me->get_property ("padding"), 0.2);
-
-  Array<Skyline_entry> left_skyline = head_ape->left_skyline_;
-  heighten_skyline (&left_skyline,
-                   -robust_scm2double (me->get_property ("right-padding"), 0));
-  /*
-    Add accs entries right-to-left.
-  */
-  for (int i = apes.size (); i-- > 0;)
-    {
-      Real offset
-       = -skyline_meshing_distance (apes[i]->right_skyline_, left_skyline);
-      if (isinf (offset))
-       offset = (i < apes.size () - 1) ? apes[i + 1]->offset_ : 0.0;
-      else
-       offset -= padding;
-
-      apes[i]->offset_ = offset;
-
-      Array<Skyline_entry> new_left_skyline = apes[i]->left_skyline_;
-      heighten_skyline (&new_left_skyline, apes[i]->offset_);
-      merge_skyline (&new_left_skyline, left_skyline, LEFT);
-      left_skyline = new_left_skyline;
-    }
-
-  for (int i = apes.size (); i--;)
-    {
-      Accidental_placement_entry *ape = apes[i];
-      for (int j = ape->grobs_.size (); j--;)
-       ape->grobs_[j]->translate_axis (ape->offset_, X_AXIS);
-    }
-
-  Interval left_extent, right_extent;
-  Accidental_placement_entry *ape = apes[0];
-
-  for (int i = ape->extents_.size (); i--;)
-    left_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
-
-  ape = apes.top ();
-  for (int i = ape->extents_.size (); i--;)
-    right_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]);
-
-  left_extent[LEFT] -= robust_scm2double (me->get_property ("left-padding"), 0);
-  Interval width (left_extent[LEFT], right_extent[RIGHT]);
-
-  SCM scm_width = ly_interval2scm (width);
   me->flush_extent_cache (X_AXIS);
-  me->set_property ("X-extent", scm_width);
+  me->set_property ("X-extent", ly_interval2scm (width));
 
-  for (int i = apes.size (); i--;)
-    delete apes[i];
+  junk_pointers (apes);
 
   return SCM_BOOL_T;
 }
 
 ADD_INTERFACE (Accidental_placement,
-              "accidental-placement-interface",
               "Resolve accidental collisions.",
 
               /* properties */
               "accidental-grobs "
+              "direction "
               "left-padding "
               "padding "
               "positioning-done "
-              "right-padding ")
+              "right-padding "
+              "script-priority "
+              )