]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/accidental-placement.cc
2003 -> 2004
[lilypond.git] / lily / accidental-placement.cc
index 84e3c6c245dc8a62d083008e2e94a661190d4bda..10ebcbc66d9500ab11fd72fe4ecbb748f42d9bbf 100644 (file)
@@ -3,7 +3,7 @@ accidental-placement.cc --  implement Accidental_placement
 
 source file of the GNU LilyPond music typesetter
 
-(c) 2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+(c) 2002--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 
  */
 
@@ -17,19 +17,8 @@ source file of the GNU LilyPond music typesetter
 #include "accidental-placement.hh"
 #include "note-column.hh"
 #include "group-interface.hh"
-
-MAKE_SCHEME_CALLBACK(Accidental_placement,extent_callback, 2);
-SCM
-Accidental_placement::extent_callback(SCM s, SCM axis)
-{
-  Grob * me =unsmob_grob (s);
-  Axis a = Axis (gh_scm2int (axis));
-
-  assert (a == X_AXIS);
-
-  SCM w = position_accidentals (me);
-  return w;
-}
+#include "note-collision.hh"
+#include "accidental-interface.hh"
 
 MAKE_SCHEME_CALLBACK(Accidental_placement,alignment_callback, 2);
 SCM
@@ -38,17 +27,16 @@ Accidental_placement::alignment_callback(SCM s, SCM )
   Grob * me =unsmob_grob (s);
 
   Grob * par = me->get_parent (X_AXIS);
-  if (!to_boolean (par->get_grob_property ("alignment-done")))
+  if (!to_boolean (par->get_grob_property ("positioning-done")))
     {
-      par->set_grob_property ("alignment-done", SCM_BOOL_T);
+      par->set_grob_property ("positioning-done", SCM_BOOL_T);
       position_accidentals (par);
     }
 
-  return gh_int2scm (0);
+  return scm_int2num (0);
 }
 
 
-
 void
 Accidental_placement::add_accidental (Grob* me, Grob* a)
 {
@@ -65,10 +53,10 @@ Accidental_placement::add_accidental (Grob* me, Grob* a)
 
   Pitch *p= unsmob_pitch (mcause->get_mus_property ("pitch"));
 
-  int n = p->notename_i_;
+  int n = p->get_notename ();
 
-  SCM accs = me->get_grob_property ("accidentals");
-  SCM key = gh_int2scm (n);
+  SCM accs = me->get_grob_property ("accidental-grobs");
+  SCM key = scm_int2num (n);
   SCM entry = scm_assq (key, accs);
   if (entry == SCM_BOOL_F)
     {
@@ -81,9 +69,67 @@ Accidental_placement::add_accidental (Grob* me, Grob* a)
 
   accs = scm_assq_set_x (accs,  key, entry);
 
-  me->set_grob_property ("accidentals", accs);
+  me->set_grob_property ("accidental-grobs", 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 ("accidental-grobs"); 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 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.is_empty ())
+    {
+      Real p = robust_scm2double (me->get_grob_property ("left-padding"), 0.2);
+      extent[LEFT] -= p;
+    }
+  
+  return extent;
+}
+
+
+
 struct Accidental_placement_entry
 {
   Array<Skyline_entry> left_skyline_;
@@ -103,16 +149,7 @@ struct Accidental_placement_entry
 static Interval all_accidental_vertical_extent;
 Real ape_priority (Accidental_placement_entry const * a)
 {
-  Real c = a->vertical_extent_.center();
-
-  /*
-    far from center means we can fold more. Hopefully.
-   */
-  Real center_distance =
-    fabs(c - all_accidental_vertical_extent[LEFT]) >?
-    fabs(c - all_accidental_vertical_extent[RIGHT]);
-  
-  return 20 * a->vertical_extent_.length  ()  + center_distance;
+  return a->vertical_extent_[UP];
 }
 
   
@@ -123,9 +160,53 @@ int ape_compare (Accidental_placement_entry *const &a,
   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));
+}
+
+
 /*
-  Return: width as SCM interval.
 
+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();
+}
+
+  
+
+/*
 
   This routine computes placements of accidentals. During
   add_accidental(), accidentals are already grouped by note, so that
@@ -148,18 +229,35 @@ 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.
 */
 
+/*
+  TODO: there should be more space in the following situation
+
+
+    Natural + downstem
+
+    |_       
+    | |    X
+    |_|   | 
+      |   |
+      
+ */
 SCM
 Accidental_placement::position_accidentals (Grob * me)
 {
-  SCM accs = me->get_grob_property ("accidentals");
+  if (!me->live ())
+    return SCM_UNSPECIFIED;
+  
+  SCM accs = me->get_grob_property ("accidental-grobs");
 
+  /*
+    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; gh_pair_p (s); s =gh_cdr (s))
     {
@@ -173,7 +271,7 @@ Accidental_placement::position_accidentals (Grob * me)
     }
 
 
-  Grob *commony =0 ;
+  Grob *common[] = {me, 0};
 
   /*
     First we must extract *all* pointers. We can only determine
@@ -186,8 +284,12 @@ Accidental_placement::position_accidentals (Grob * me)
       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;
          
-         commony = commony->common_refpoint (a, Y_AXIS);
          Grob *head = a->get_parent (Y_AXIS);
 
          Grob * col = head->get_parent (X_AXIS);
@@ -197,6 +299,22 @@ Accidental_placement::position_accidentals (Grob * me)
            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))
+       {
+         Link_array<Grob> gs =
+           Pointer_group_interface__extract_grobs (c, (Grob*)0, "elements");
+      
+         note_cols.concat (gs);
+       }
+    }
   
   for (int i = note_cols.size() ; i--;)
     {
@@ -207,30 +325,27 @@ 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);
+      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];
-         Box b;
-         b[X_AXIS] = a->extent (me, X_AXIS);
-         b[Y_AXIS] = a->extent (commony, Y_AXIS);
 
-         ape->extents_.push (b);
+         Array<Box> boxes = Accidental_interface::accurate_boxes (a, common);
          
-         /*
-           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);
+         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);
+           }
        }
     }
 
@@ -248,16 +363,16 @@ Accidental_placement::position_accidentals (Grob * me)
       total.unite (y);
     }
   all_accidental_vertical_extent = total;
-  apes.sort (&ape_compare);  
+  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);
     }
@@ -265,36 +380,32 @@ Accidental_placement::position_accidentals (Grob * me)
   head_ape-> left_skyline_ = head_skyline;
   head_ape->offset_ = 0.0;
 
-  SCM rs = me->get_grob_property ("right-padding");
-  if (gh_number_p (rs))
-    head_ape->offset_ -= gh_scm2double (rs);
+  head_ape->offset_ -= robust_scm2double ( me->get_grob_property ("right-padding"), 0);
+
+  
+  Real padding = robust_scm2double (me->get_grob_property ("padding"),0.2);
 
-  Real padding = 0.1;
-  apes.push (head_ape);
-  for (int i= apes.size () -1 ; i-- > 0;)
+  Array<Skyline_entry> left_skyline = head_ape->left_skyline_;
+  /*
+    Add accs entries right-to-left.
+   */
+  for (int i= apes.size (); i-- > 0;)
     {
-      Accidental_placement_entry *ape = apes[i];
-      Real d = 0.0;
-      int j = i+1;
-      do {
-       d = - skyline_meshing_distance (ape->right_skyline_,
-                                       apes[j]->left_skyline_);
-
-       if (!isinf(d)
-           || j + 1 == apes.size())
-         break;
-       
-       j = j+ 1;
-      } while (1);
-
-      if (isinf(d))
-       d = 0.0;
-      
-      d -= padding;
-      ape->offset_ += apes[j]->offset_ + d;
-    }
+      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;
+    }      
 
-  apes.pop();
   for (int i = apes.size(); i--;)
     {
       Accidental_placement_entry* ape = apes[i];
@@ -315,9 +426,8 @@ Accidental_placement::position_accidentals (Grob * me)
   for (int i = ape->extents_.size(); i--;)
     right_extent.unite (ape->offset_  + ape->extents_[i][X_AXIS]);
 
-  SCM ls = me->get_grob_property ("left-padding");
-  if (gh_number_p (rs))
-    left_extent[LEFT] -= gh_scm2double (ls);
+  
+  left_extent[LEFT] -= robust_scm2double (me->get_grob_property ("left-padding"), 0);
 
   
   Interval width(left_extent[LEFT], right_extent[RIGHT]);
@@ -328,10 +438,10 @@ Accidental_placement::position_accidentals (Grob * me)
   for (int i = apes.size(); i--;)
     delete apes[i];
 
-  return scm_width;
+  return SCM_UNSPECIFIED;
 }
 
 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 accidental-grobs positioning-done")