new file.

[lilypond.git] / lily / side-position-interface.cc

diff --git a/lily/side-position-interface.cc b/lily/side-position-interface.cc
index 54ff667d6ebc9dccdd1ebd80c02deadd2d9f4d31..371f13fe5a8a6c5b79d33707c3c003ffbd52b5d1 100644 (file)
--- a/lily/side-position-interface.cc
+++ b/lily/side-position-interface.cc
@@ -1,15 +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--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1998--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
+
+#include "side-position-interface.hh"
+
 #include <math.h>              // ceil.
 
 #include "note-head.hh"
-#include "side-position-interface.hh"
 #include "warn.hh"
 #include "warn.hh"
 #include "dimensions.hh"
@@ -17,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)
@@ -49,7 +52,7 @@ 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)
 {
@@ -60,12 +63,10 @@ Side_position_interface::aligned_on_support_extents (SCM element_smob, SCM axis)
 }
 
 
-/*
- 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_property ("side-support-elements");
@@ -82,28 +83,26 @@ Side_position_interface::general_side_position (Grob * me, Axis a, bool use_exte
       dim = st->extent (common, Y_AXIS);
     }
     
-  for (SCM s = support; s != SCM_EOL; s = ly_cdr (s))
+  for (SCM s = support; s != SCM_EOL; s = scm_cdr (s))
     {
-      Grob * e  = unsmob_grob (ly_car (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_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_property ("padding"), 0);
@@ -111,23 +110,25 @@ Side_position_interface::general_side_position (Grob * me, Axis a, bool use_exte
   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.");
-
-
-  
-  
+    {
+      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)
 {
@@ -155,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)
 {
@@ -173,7 +174,7 @@ Side_position_interface::quantised_position (SCM element_smob, SCM)
 
       Grob *head = me->get_parent (X_AXIS);
        
-      if (Staff_symbol_referencer::on_staffline (me,ip)
+      if (Staff_symbol_referencer::on_staffline (me, ip)
          && ((abs (ip) <= rad)
              || (Note_head::has_interface (head)
                  && sign (Staff_symbol_referencer::get_position (head))
@@ -192,7 +193,7 @@ Side_position_interface::quantised_position (SCM element_smob, SCM)
 /*
   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)
 {
@@ -201,7 +202,7 @@ Side_position_interface::aligned_side (SCM element_smob, SCM axis)
   
   Direction d = Side_position_interface::get_direction (me);
   
-  Real o = scm_to_double (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);
 
@@ -224,7 +225,7 @@ Side_position_interface::aligned_side (SCM element_smob, SCM axis)
   if (st && a == Y_AXIS
       && scm_is_number (me->get_property ("staff-padding")))
     {
-      Real padding=
+      Real padding =
       Staff_symbol_referencer::staff_space (me)
       * scm_to_double (me->get_property ("staff-padding"));
   
@@ -257,7 +258,7 @@ Side_position_interface::get_axis (Grob*me)
 }
 
 
-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).   The property @code{direction} signifies where to put the  "
               "victim object relative to the support (left or right, up or down?)\n\n "