]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/side-position-interface.cc
* lily/include/group-interface.hh (extract_grob_array): rename
[lilypond.git] / lily / side-position-interface.cc
index 42ae7dfd04d13d0688b992c68d81044c9c25ee4b..371f13fe5a8a6c5b79d33707c3c003ffbd52b5d1 100644 (file)
@@ -1,14 +1,17 @@
 /*   
-  staff-side.cc --  implement Staff_side_element
+  side-position-interface.cc -- implement Side_position_interface
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1998--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
-#include <math.h>              // ceil.
 
 #include "side-position-interface.hh"
+
+#include <math.h>              // ceil.
+
+#include "note-head.hh"
 #include "warn.hh"
 #include "warn.hh"
 #include "dimensions.hh"
@@ -16,6 +19,7 @@
 #include "group-interface.hh"
 #include "directional-element-interface.hh"
 #include "staff-symbol-referencer.hh"
+#include "string-convert.hh"
 
 void
 Side_position_interface::add_support (Grob*me, Grob*e)
@@ -26,18 +30,18 @@ Side_position_interface::add_support (Grob*me, Grob*e)
 Direction
 Side_position_interface::get_direction (Grob*me)
 {
-  SCM d = me->get_grob_property ("direction");
+  SCM d = me->get_property ("direction");
   if (is_direction (d) && to_dir (d))
     return to_dir (d);
 
   Direction relative_dir = Direction (1);
-  SCM reldir = me->get_grob_property ("side-relative-direction");      // should use a lambda.
+  SCM reldir = me->get_property ("side-relative-direction");   // should use a lambda.
   if (is_direction (reldir))
     {
       relative_dir = to_dir (reldir);
     }
   
-  SCM other_elt = me->get_grob_property ("direction-source");
+  SCM other_elt = me->get_property ("direction-source");
   Grob * e = unsmob_grob (other_elt);
   if (e)
     {
@@ -48,80 +52,88 @@ Side_position_interface::get_direction (Grob*me)
 }
   
 
-MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_extents, 2);
+MAKE_SCHEME_CALLBACK (Side_position_interface, aligned_on_support_extents, 2);
 SCM
 Side_position_interface::aligned_on_support_extents (SCM element_smob, SCM axis)
 {
   Grob *me = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (axis);
+  Axis a = (Axis) scm_to_int (axis);
 
   return general_side_position (me, a, true);
 }
 
 
-/*
- Puts the element next to the support, optionally taking in
- account the extent of the support.
-*/
+/* Put 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)
+Side_position_interface::general_side_position (Grob *me, Axis a, bool use_extents)
 {
   Real ss = Staff_symbol_referencer::staff_space (me);
-  SCM support = me->get_grob_property ("side-support-elements");
+  SCM support = me->get_property ("side-support-elements");
   Grob *common = common_refpoint_of_list (support, me->get_parent (a), a);
-  
+  Grob * st = Staff_symbol_referencer::get_staff_symbol (me);
+  bool include_staff = (st
+                       && a == Y_AXIS
+                       && scm_is_number (me->get_property ("staff-padding")));
+
   Interval dim;
-  for (SCM s = support; s != SCM_EOL; s = ly_cdr (s))
+  if (include_staff)
     {
-      Grob * e  = unsmob_grob (ly_car (s));
+      common = st->common_refpoint (common, Y_AXIS);
+      dim = st->extent (common, Y_AXIS);
+    }
+    
+  for (SCM s = support; s != SCM_EOL; s = scm_cdr (s))
+    {
+      Grob *e = unsmob_grob (scm_car (s));
       if (e)
        if (use_extents)
          dim.unite (e->extent (common, a));
        else
          {
            Real x = e->relative_coordinate (common, a);
-           dim.unite (Interval (x,x));
+           dim.unite (Interval (x, x));
          }
     }
 
   if (dim.is_empty ())
-    {
-      dim = Interval (0,0);
-    }
+    dim = Interval (0, 0);
 
   Direction dir = Side_position_interface::get_direction (me);
     
-  Real off =  me->get_parent (a)->relative_coordinate (common, a);
-  Real  minimum_space = ss * robust_scm2double (me->get_grob_property ("minimum-space"),  -1);
+  Real off = me->get_parent (a)->relative_coordinate (common, a);
+  Real minimum_space = ss * robust_scm2double (me->get_property ("minimum-space"),  -1);
 
   Real total_off = dim.linear_combination (dir) - off;
-  total_off += dir * ss * robust_scm2double (me->get_grob_property ("padding"), 0);
+  total_off += dir * ss * robust_scm2double (me->get_property ("padding"), 0);
 
   if (minimum_space >= 0
       && dir
       && total_off * dir < minimum_space)
-    {
-      total_off = minimum_space * dir;
-    }
+    total_off = minimum_space * dir;
 
+  /* FIXME: 100CM should relate to paper size.  */
   if (fabs (total_off) > 100 CM)
-    programming_error ("Huh ? Improbable staff side dim.");
-
-
-  
-  
-  return gh_double2scm (total_off);
+    {
+      String msg
+       =  String_convert::form_string ("Improbable offset for grob %s: %f%s",
+                                       me->name ().to_str0 (), total_off,
+                                       INTERNAL_UNIT);
+      
+      programming_error (msg);
+    }
+  return scm_make_real (total_off);
 }
 
 /*
   Cut & paste (ugh.)
  */
-MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_refpoints,2);
+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);
+  Axis a = (Axis) scm_to_int (axis);
 
   return general_side_position (me, a, false); 
 }
@@ -144,7 +156,7 @@ directed_round (Real f, Direction d)
 
   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);
+MAKE_SCHEME_CALLBACK (Side_position_interface, quantised_position, 2);
 SCM
 Side_position_interface::quantised_position (SCM element_smob, SCM)
 {
@@ -160,30 +172,37 @@ Side_position_interface::quantised_position (SCM element_smob, SCM)
       Real rad = Staff_symbol_referencer::staff_radius (me) *2 ;
       int ip = int (rp);
 
-      if (abs (ip) <= rad && Staff_symbol_referencer::on_staffline (me,ip))
+      Grob *head = me->get_parent (X_AXIS);
+       
+      if (Staff_symbol_referencer::on_staffline (me, ip)
+         && ((abs (ip) <= rad)
+             || (Note_head::has_interface (head)
+                 && sign (Staff_symbol_referencer::get_position (head))
+                 == -d)
+             ))
        {
          ip += d;
          rp += d;
        }
-
-      return gh_double2scm ((rp - p) * Staff_symbol_referencer::staff_space (me) / 2.0);
+      
+      return scm_make_real ((rp - p) * Staff_symbol_referencer::staff_space (me) / 2.0);
     }
-  return gh_double2scm (0.0);
+  return scm_make_real (0.0);
 }
 
 /*
   Position next to support, taking into account my own dimensions and padding.
  */
-MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_side,2);
+MAKE_SCHEME_CALLBACK (Side_position_interface, aligned_side, 2);
 SCM
 Side_position_interface::aligned_side (SCM element_smob, SCM axis)
 {
   Grob *me = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (axis);
+  Axis a = (Axis) scm_to_int (axis);
   
   Direction d = Side_position_interface::get_direction (me);
   
-  Real o = gh_scm2double (aligned_on_support_extents (element_smob,axis));
+  Real o = scm_to_double (aligned_on_support_extents (element_smob, axis));
 
   Interval iv =  me->extent (me, a);
 
@@ -197,46 +216,29 @@ Side_position_interface::aligned_side (SCM element_smob, SCM axis)
       o += - iv[-d];
     }
 
+  /*
+  Maintain a minimum distance to the staff. This is similar to side
+  position with padding, but it will put adjoining objects on a row if
+  stuff sticks out of the staff a little.
+ */
   Grob * st = Staff_symbol_referencer::get_staff_symbol (me);
   if (st && a == Y_AXIS
-      && gh_number_p (me->get_grob_property ("staff-padding")))
+      && scm_is_number (me->get_property ("staff-padding")))
     {
-      Real padding=
+      Real padding =
       Staff_symbol_referencer::staff_space (me)
-      * gh_scm2double (me->get_grob_property ("staff-padding"));
+      * scm_to_double (me->get_property ("staff-padding"));
   
       Grob *common = me->common_refpoint (st, Y_AXIS);
       
       Interval staff_size = st->extent (common, Y_AXIS);
-      Interval me_ext = me->extent (common, a);
       Real diff =  d*staff_size[d] + padding - d*(o + iv[-d]);
       o += (d*  (diff >? 0));
     }
       
-  return gh_double2scm (o);
+  return scm_make_real (o);
 }
 
-/*
-  Maintain a minimum distance to the staff. This is similar to side
-  position with padding, but it will put adjoining objects on a row if
-  stuff sticks out of the staff a little.
- */
-MAKE_SCHEME_CALLBACK (Side_position_interface,out_of_staff,2);
-SCM
-Side_position_interface::out_of_staff (SCM element_smob, SCM axis)
-{
-  return gh_double2scm (0);
-}
-
-void
-Side_position_interface::add_staff_support (Grob*me)
-{
-  Grob* st = Staff_symbol_referencer::get_staff_symbol (me);
-  if (st && get_axis (me) == Y_AXIS)
-    {
-      add_support (me,st);
-    }
-}
 
 void
 Side_position_interface::set_axis (Grob*me, Axis a)
@@ -244,55 +246,24 @@ Side_position_interface::set_axis (Grob*me, Axis a)
   me->add_offset_callback (Side_position_interface::aligned_side_proc, a);
 }
 
-
-
-// ugh. doesn't cactch all variants. 
+// ugh. doesn't catch all variants. 
 Axis
 Side_position_interface::get_axis (Grob*me)
 {
-  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))
+  if (me->has_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS)
+      || me->has_offset_callback (Side_position_interface::aligned_side_proc , X_AXIS))
     return X_AXIS;
-
   
   return Y_AXIS;
 }
 
-void
-Side_position_interface::set_direction (Grob*me, Direction d)
-{
-  me->set_grob_property ("direction", gh_int2scm (d));
-}
-
-void
-Side_position_interface::set_minimum_space (Grob*me, Real m)
-{
-  me->set_grob_property ("minimum-space", gh_double2scm (m));
-}
-
-void
-Side_position_interface::set_padding (Grob*me, Real p)
-{
-  me->set_grob_property ("padding", gh_double2scm (p));
-}
-
-
-bool
-Side_position_interface::supported_b (Grob*me) 
-{
-  SCM s = me->get_grob_property ("side-support-elements"); 
-  return gh_pair_p (s);
-}
-
-
-
 
-ADD_INTERFACE (Side_position_interface,"side-position-interface",
+ADD_INTERFACE (Side_position_interface, "side-position-interface",
               "Position a victim object (this one) next to other objects (the "
-              "support).  In this case, the property @code{direction} signifies where to put the  "
+              "support).   The property @code{direction} signifies where to put the  "
               "victim object relative to the support (left or right, up or down?)\n\n "
-              "The @code{out_of_staff} routine puts objects at a distance of the staff. If the property "
-              "@code{staff-padding} is not defined, the routine doesn't do anything." 
+              "The routine also takes the size the staff into account if "
+              "@code{staff-padding} is set. If undefined, the staff symbol is ignored." 
               ,
               "staff-padding side-support-elements direction-source "
               "direction side-relative-direction minimum-space padding");