]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/side-position-interface.cc
release: 1.5.29
[lilypond.git] / lily / side-position-interface.cc
index f93dd1856fe12c73b95a04f049cf7973c830dea1..2e83ee183c082527306229df7f1c409f2a85f741 100644 (file)
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1998--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1998--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
 #include <math.h>              // ceil.
 
 #include "side-position-interface.hh"
-#include "staff-symbol.hh"
 #include "debug.hh"
 #include "warn.hh"
 #include "dimensions.hh"
-#include "dimension-cache.hh"
 #include "staff-symbol-referencer.hh"
-
-Side_position_interface::Side_position_interface (Score_element const *e)
-{
-  elt_l_ = (Score_element*)e;
-}
-
+#include "group-interface.hh"
+#include "directional-element-interface.hh"
 
 void
-Side_position_interface::add_support (Score_element*e)
+Side_position_interface::add_support (Grob*me, Grob*e)
 {
-  SCM sup = elt_l_->get_elt_property ("side-support");
-  elt_l_->set_elt_property ("side-support",
-                           gh_cons (e->self_scm_,sup));
+  Pointer_group_interface::add_grob (me, ly_symbol2scm ("side-support-elements"), e);
 }
 
 
 
 Direction
-Side_position_interface::get_direction () const
+Side_position_interface::get_direction (Grob*me)
 {
-  SCM d = elt_l_->get_elt_property ("direction");
-  if (isdir_b (d))
-    return to_dir (d) ? to_dir (d) : DOWN;
+  SCM d = me->get_grob_property ("direction");
+  if (isdir_b (d) && to_dir (d))
+    return to_dir (d);
 
-  Direction relative_dir = UP;
-  SCM reldir = elt_l_->get_elt_property ("side-relative-direction");   // should use a lambda.
+  Direction relative_dir = Direction (1);
+  SCM reldir = me->get_grob_property ("side-relative-direction");      // should use a lambda.
   if (isdir_b (reldir))
     {
       relative_dir = to_dir (reldir);
     }
   
-  SCM other_elt = elt_l_->get_elt_property ("direction-source");
-  Score_element * e = unsmob_element(other_elt);
+  SCM other_elt = me->get_grob_property ("direction-source");
+  Grob * e = unsmob_grob (other_elt);
   if (e)
     {
-      return (Direction)(relative_dir * Side_position_interface (e).get_direction ());
+      return (Direction) (relative_dir * Directional_element_interface::get (e));
     }
   
-  return DOWN;
+  return CENTER;
 }
   
-/*
-   Callback that does the aligning. Puts the element next to the support
- */
 
-Real
-Side_position_interface::side_position (Dimension_cache const * c)
+MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_extents, 2);
+SCM
+Side_position_interface::aligned_on_support_extents (SCM element_smob, SCM axis)
 {
-  Score_element * me =  (c->element_l ());
+  Grob *me = unsmob_grob (element_smob);
+  Axis a = (Axis) gh_scm2int (axis);
 
-  Interval dim;
-  Axis  axis = c->axis ();
-  Score_element *common = me->parent_l (axis);
-  SCM support = me->get_elt_property ("side-support");
-  for (SCM s = support; s != SCM_EOL; s = gh_cdr (s))
+  return general_side_position (me, a, true);
+}
+
+
+/*
+ Puts the element next to the support, optionally taking in
+ account the extent of the support.
+*/
+SCM
+Side_position_interface::general_side_position (Grob * me, Axis a, bool use_extents)
+{
+  Grob *common = me->get_parent (a);
+
+  /*
+    As this is only used as a callback, this is called only once. We
+    could wipe SIDE-SUPPORT-ELEMENTS after we retrieve it to conserve
+    memory; however -- we should look more into benefits of such actions?
+
+    The benefit is small, it seems: total GC times taken don't
+    differ. Would this also hamper Generational GC ?
+    
+  */
+  SCM support = me->get_grob_property ("side-support-elements");
+    // me->remove_grob_property ("side-support-elements");
+  for (SCM s = support; s != SCM_EOL; s = ly_cdr (s))
     {
-      Score_element * e  = unsmob_element ( gh_car (s));
+      Grob * e  = unsmob_grob (ly_car (s));
       if (e)
-       common = common->common_refpoint (e, axis);
+       common = common->common_refpoint (e, a);
     }
   
-  for (SCM s = support; s != SCM_EOL; s = gh_cdr (s))
+  Interval dim;
+  for (SCM s = support; s != SCM_EOL; s = ly_cdr (s))
     {
-
-      Score_element * e  = unsmob_element ( gh_car (s));
+      Grob * e  = unsmob_grob (ly_car (s));
       if (e)
-       {
-         Real coord = e->relative_coordinate (common, axis);
-
-         dim.unite (coord + e->extent (axis));
-       }
+       if (use_extents)
+         dim.unite (e->extent (common, a));
+       else
+         {
+           Real x = e->relative_coordinate (common, a);
+           dim.unite (Interval (x,x));
+         }
     }
 
   if (dim.empty_b ())
     {
-      dim = Interval(0,0);
+      dim = Interval (0,0);
     }
 
-  Direction dir = Side_position_interface (me).get_direction ();
+  Direction dir = Side_position_interface::get_direction (me);
     
-  Real off =  me->parent_l (axis)->relative_coordinate (common, axis);
-  SCM minimum = me->remove_elt_property ("minimum-space");
+  Real off =  me->get_parent (a)->relative_coordinate (common, a);
+  SCM minimum = me->remove_grob_property ("minimum-space");
 
-  Real total_off = dim[dir] + off;
-  SCM padding = me->remove_elt_property ("padding");
+  Real total_off = dim.linear_combination (dir) + off;
+  SCM padding = me->remove_grob_property ("padding");
   if (gh_number_p (padding))
     {
       total_off += gh_scm2double (padding) * dir;
     }
-  if (gh_number_p (minimum) && total_off * dir < gh_scm2double (minimum))
+
+  if (gh_number_p (minimum) 
+      && dir
+      && total_off * dir < gh_scm2double (minimum))
     {
       total_off = gh_scm2double (minimum) * dir;
     }
+
   if (fabs (total_off) > 100 CM)
     programming_error ("Huh ? Improbable staff side dim.");
 
-  return total_off;
+  return gh_double2scm (total_off);
+}
+
+/*
+  Cut & paste (ugh.)
+ */
+MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_refpoints,2);
+SCM
+Side_position_interface::aligned_on_support_refpoints (SCM smob, SCM axis)
+{
+  Grob *me = unsmob_grob (smob);
+  Axis a = (Axis) gh_scm2int (axis);
+
+  return  general_side_position (me, a, false); 
 }
 
+
 /**
   callback that centers the element on itself
+
+  Requires that self-alignment-{X,Y} be set.
  */
-Real
-Side_position_interface::aligned_on_self (Dimension_cache const *c)
+MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_self,2);
+SCM
+Side_position_interface::aligned_on_self (SCM element_smob, SCM axis)
 {
+  Grob *me = unsmob_grob (element_smob);
+  Axis a = (Axis) gh_scm2int (axis);
   String s ("self-alignment-");
-  Axis ax = c->axis ();
-  s +=  (ax == X_AXIS) ? "X" : "Y";
-  Score_element *elm = c->element_l ();
-  SCM align (elm->get_elt_property (s));
-  if (isdir_b (align))
+
+  s += (a == X_AXIS) ? "X" : "Y";
+
+  SCM align (me->get_grob_property (s.ch_C ()));
+  if (gh_number_p (align))
     {
-      Direction d = to_dir (align);
-      Interval ext(elm->extent (ax));
+      Interval ext (me->extent (me,a));
 
       if (ext.empty_b ())
        {
          programming_error ("I'm empty. Can't align on self");
-         return 0.0;
+         return gh_double2scm (0.0);
        }
-      else if (d)
+      else
        {
-         return - ext[d];
+         return gh_double2scm (- ext.linear_combination (gh_scm2double (align)));
        }
-      return - ext.center ();
     }
-  else
-    return 0.0;
+  else if (unsmob_grob (align))
+    {
+      return gh_double2scm (- unsmob_grob (align)->relative_coordinate (me,  a));
+    }
+  return gh_double2scm (0.0);
 }
 
 
@@ -158,105 +195,108 @@ directed_round (Real f, Direction d)
 
 /*
   Callback that quantises in staff-spaces, rounding in the direction
-  of the elements "direction" elt property. */
-Real
-Side_position_interface::quantised_position (Dimension_cache const *c)
+  of the elements "direction" elt property.
+
+  Only rounds when we're inside the staff, as determined by
+  Staff_symbol_referencer::staff_radius () */
+MAKE_SCHEME_CALLBACK (Side_position_interface,quantised_position,2);
+SCM
+Side_position_interface::quantised_position (SCM element_smob, SCM)
 {
-  Score_element * me =  (c->element_l ());
-  Side_position_interface s(me);
-  Direction d = s.get_direction ();
-  Staff_symbol_referencer_interface si (me);
+  Grob *me = unsmob_grob (element_smob);
+  
+  
+  Direction d = Side_position_interface::get_direction (me);
 
-  if (si.has_interface_b ())
+  if (Staff_symbol_referencer::has_interface (me))
     {
-      Real p = si.position_f ();
+      Real p = Staff_symbol_referencer::position_f (me);
       Real rp = directed_round (p, d);
+      Real rad = Staff_symbol_referencer::staff_radius (me) *2 ;
+      int ip = int (rp);
 
-      int ip = int  (rp);
-      if ((ip % 2) == 0)
+      if (abs (ip) <= rad && Staff_symbol_referencer::on_staffline (me,ip))
        {
          ip += d;
          rp += d;
        }
 
-      return (rp - p) * si.staff_space () / 2.0;
+      return gh_double2scm ((rp - p) * Staff_symbol_referencer::staff_space (me) / 2.0);
     }
-  return 0.0;
+  return gh_double2scm (0.0);
 }
 
 /*
   Position next to support, taking into account my own dimensions and padding.
  */
-Real
-Side_position_interface::aligned_side (Dimension_cache const *c)
+MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_side,2);
+SCM
+Side_position_interface::aligned_side (SCM element_smob, SCM axis)
 {
-  Score_element * me =  (c->element_l ());
-  Side_position_interface s(me);
-  Direction d = s.get_direction ();
-  Axis ax = c->axis ();
-  Real o = side_position (c);
+  Grob *me = unsmob_grob (element_smob);
+  Axis a = (Axis) gh_scm2int (axis);
+  
+  Direction d = Side_position_interface::get_direction (me);
+  
+  Real o = gh_scm2double (aligned_on_support_extents (element_smob,axis));
 
-  Interval iv =  me->extent (ax);
+  Interval iv =  me->extent (me, a);
 
   if (!iv.empty_b ())
     {
+      if (!d)
+       {
+         programming_error ("Direction unknown, but aligned-side wanted.");
+         d = DOWN;
+       }
       o += - iv[-d];
 
-      SCM pad = me->get_elt_property ("padding");
+      SCM pad = me->get_grob_property ("padding");
       if (gh_number_p (pad))
        o += d *gh_scm2double (pad) ; 
     }
-  return o;
+  return gh_double2scm (o);
 }
 
 /*
   Position centered on parent.
  */
-Real
-Side_position_interface::centered_on_parent (Dimension_cache const *c)
+MAKE_SCHEME_CALLBACK (Side_position_interface,centered_on_parent,2);
+SCM
+Side_position_interface::centered_on_parent (SCM element_smob, SCM axis)
 {
+  Grob *me = unsmob_grob (element_smob);
+  Axis a = (Axis) gh_scm2int (axis);
+  Grob *him = me->get_parent (a);
 
-  Score_element *me = c->element_l ();
-  Axis a = c->axis ();
-  Score_element *him = me->parent_l (a);
-
-  return him->extent (a).center ();  
+  return gh_double2scm (him->extent (him,a).center ());  
 }
 
 
 void
-Side_position_interface::add_staff_support ()
+Side_position_interface::add_staff_support (Grob*me)
 {
-  Staff_symbol_referencer_interface si (elt_l_);
-  if (si.staff_symbol_l ())
+  Grob* st = Staff_symbol_referencer::staff_symbol_l (me);
+  if (st && get_axis (me) == Y_AXIS)
     {
-      add_support (si.staff_symbol_l ());
+      add_support (me,st);
     }
 }
 
 void
-Side_position_interface::set_axis (Axis a)
+Side_position_interface::set_axis (Grob*me, Axis a)
 {
-  // prop transparent ? 
-  if (elt_l_->get_elt_property ("side-support") == SCM_UNDEFINED)
-    elt_l_->set_elt_property ("side-support" ,SCM_EOL);
-
-  if (!elt_l_->has_offset_callback_b (aligned_side, a))
-    elt_l_->add_offset_callback (aligned_side, a);
+  me->add_offset_callback (Side_position_interface::aligned_side_proc, a);
 }
 
 
-void
-Side_position_interface::set_quantised (Axis a)
-{
-  elt_l_->add_offset_callback (quantised_position, a);
-}
 
+// ugh. doesn't cactch all variants. 
 Axis
-Side_position_interface::get_axis () const
+Side_position_interface::get_axis (Grob*me)
 {
-  if (elt_l_->has_offset_callback_b (&side_position, X_AXIS)
-      || elt_l_->has_offset_callback_b (&aligned_side , X_AXIS))
+  if (me->has_offset_callback_b (Side_position_interface::aligned_side_proc, X_AXIS)
+      || me->has_offset_callback_b (Side_position_interface::aligned_side_proc , X_AXIS))
     return X_AXIS;
 
   
@@ -264,40 +304,34 @@ Side_position_interface::get_axis () const
 }
 
 void
-Side_position_interface::set_direction (Direction d) 
+Side_position_interface::set_direction (Grob*me, Direction d)
 {
-  elt_l_->set_elt_property ("direction", gh_int2scm (d));
+  me->set_grob_property ("direction", gh_int2scm (d));
 }
 
 void
-Side_position_interface::set_minimum_space (Real m)
+Side_position_interface::set_minimum_space (Grob*me, Real m)
 {
-  elt_l_->set_elt_property ("minimum-space", gh_double2scm (m));
+  me->set_grob_property ("minimum-space", gh_double2scm (m));
 }
 
 void
-Side_position_interface::set_padding (Real p)
+Side_position_interface::set_padding (Grob*me, Real p)
 {
-  elt_l_->set_elt_property ("padding", gh_double2scm (p));
+  me->set_grob_property ("padding", gh_double2scm (p));
 }
 
 bool
-Side_position_interface::has_interface_b () const
+Side_position_interface::has_interface (Grob*me) 
 {
-  return elt_l_->get_elt_property ("side-support") != SCM_UNDEFINED;
+  return me->has_interface (ly_symbol2scm ("side-position-interface"));
 }
 
 bool
-Side_position_interface::supported_b () const
+Side_position_interface::supported_b (Grob*me) 
 {
-  SCM s =elt_l_->get_elt_property  ("side-support"); 
-  return s != SCM_UNDEFINED && s != SCM_EOL;
+  SCM s = me->get_grob_property ("side-support-elements"); 
+  return gh_pair_p (s);
 }
 
 
-Side_position_interface
-side_position (Score_element* e)
-{
-  Side_position_interface si (e);
-  return si;
-}