]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/align-interface.cc
new file.
[lilypond.git] / lily / align-interface.cc
index 8211c349af283717552e9abeba981fac6f614c2b..0486f09d3a68b2cf7a5e5f345f4920f85340d26f 100644 (file)
@@ -1,44 +1,44 @@
 /*   
-  align-interface.cc --  implement Align_interface
+  align-interface.cc -- implement Align_interface
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 2000--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 2000--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
 
 #include "align-interface.hh"
-#include "grob.hh"
-#include "group-interface.hh"
+
 #include "axis-group-interface.hh"
-#include "paper-def.hh"
+#include "hara-kiri-group-spanner.hh"
+#include "output-def.hh"
 
-MAKE_SCHEME_CALLBACK (Align_interface,alignment_callback,2);
+MAKE_SCHEME_CALLBACK (Align_interface, alignment_callback, 2);
 SCM
 Align_interface::alignment_callback (SCM element_smob, SCM axis)
 {
   Grob * me = unsmob_grob (element_smob);
-  Axis ax = (Axis)gh_scm2int (axis);
-  Grob * par = me->parent_l (ax);
-  if (par && !to_boolean (par->get_grob_property ("alignment-done")))
+  Axis ax = (Axis)scm_to_int (axis);
+  Grob * par = me->get_parent (ax);
+  if (par && !to_boolean (par->get_property ("positioning-done")))
     {
       Align_interface::align_elements_to_extents (par, ax);
     }
-  return gh_double2scm (0.0);
+  return scm_make_real (0.0);
 }
 
-MAKE_SCHEME_CALLBACK (Align_interface,fixed_distance_alignment_callback,2);
+MAKE_SCHEME_CALLBACK (Align_interface, fixed_distance_alignment_callback, 2);
 SCM
 Align_interface::fixed_distance_alignment_callback (SCM element_smob, SCM axis)
 {
   Grob * me = unsmob_grob (element_smob);
-  Axis ax = (Axis)gh_scm2int (axis);
-  Grob * par = me->parent_l (ax);
-  if (par && !to_boolean (par->get_grob_property ("alignment-done")))
+  Axis ax = (Axis)scm_to_int (axis);
+  Grob * par = me->get_parent (ax);
+  if (par && !to_boolean (par->get_property ("positioning-done")))
     {
       Align_interface::align_to_fixed_distance (par, ax);
     }
-  return gh_double2scm (0.0);
+  return scm_make_real (0.0);
 }
 
 /*
@@ -47,34 +47,45 @@ Align_interface::fixed_distance_alignment_callback (SCM element_smob, SCM axis)
 void
 Align_interface::align_to_fixed_distance (Grob *me , Axis a)
 {
-  me->set_grob_property ("alignment-done", SCM_BOOL_T);
+  me->set_property ("positioning-done", SCM_BOOL_T);
   
-  SCM d =   me->get_grob_property ("stacking-dir");
-
+  SCM d =   me->get_property ("stacking-dir");
   
-  Direction stacking_dir = gh_number_p (d) ? to_dir (d) : CENTER;
+  Direction stacking_dir = scm_is_number (d) ? to_dir (d) : CENTER;
   if (!stacking_dir)
     stacking_dir = DOWN;
 
-
-  SCM force = me->get_grob_property ("forced-distance");
-
-  Real dy = 0.0;
-  if (gh_number_p (force))
-    {
-      dy = gh_scm2double (force);
-    }
+  Real dy = robust_scm2double (me->get_property ("forced-distance"), 0.0);
   
   Link_array<Grob> elems
-    = Pointer_group_interface__extract_elements (me, (Grob*) 0, "elements");
+    = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
 
-  Real where_f=0;
+  Real where_f = 0;
 
   Interval v;
   v.set_empty ();
   Array<Real> translates;
   
-  for (int j=0 ;  j < elems.size (); j++) 
+  for (int j = elems.size (); j--; ) 
+    {
+      /*
+       This is not very elegant, in that we need special support for
+       hara-kiri. Unfortunately, the generic wiring of
+       force_hara_kiri_callback () (extent and offset callback) is
+       such that we might get into a loop if we call extent () or
+       offset () the elements.
+       
+        
+       */
+      if (a == Y_AXIS
+         && Hara_kiri_group_spanner::has_interface (elems[j]))
+       Hara_kiri_group_spanner::consider_suicide (elems[j]);
+
+      if (!elems[j]->is_live ())
+       elems.del (j);
+    }
+
+  for (int j = 0; j < elems.size (); j++)
     {
       where_f += stacking_dir * dy;
       translates.push (where_f);
@@ -82,7 +93,7 @@ Align_interface::align_to_fixed_distance (Grob *me , Axis a)
     }
 
   /*
-    TODO: support self-alignment-{Y,X}
+    TODO: support self-alignment-{Y, X}
    */
   for (int i = 0; i < translates.size (); i++)
     {
@@ -92,7 +103,7 @@ Align_interface::align_to_fixed_distance (Grob *me , Axis a)
 
 /*
   Hairy function to put elements where they should be. Can be tweaked
-  from the outside by setting minimum-space and extra-space in its
+  from the outside by setting extra-space in its
   children
 
   We assume that the children the refpoints of the children are still
@@ -103,60 +114,33 @@ Align_interface::align_to_fixed_distance (Grob *me , Axis a)
 
   TODO: maybe we should rethink and throw out thresholding altogether.
   The original function has been taken over by
-  align_to_fixed_distance().
+  align_to_fixed_distance ().
 */
 void
 Align_interface::align_elements_to_extents (Grob * me, Axis a)
 {
-  me->set_grob_property ("alignment-done", SCM_BOOL_T);
+  me->set_property ("positioning-done", SCM_BOOL_T);
   
-  SCM d =   me->get_grob_property ("stacking-dir");
-
+  SCM d =   me->get_property ("stacking-dir");
   
-  Direction stacking_dir = gh_number_p (d) ? to_dir (d) : CENTER;
+  Direction stacking_dir = scm_is_number (d) ? to_dir (d) : CENTER;
   if (!stacking_dir)
     stacking_dir = DOWN;
-
-
   
-  Interval threshold = Interval (0, Interval::infinity ());
-  SCM thr = me->get_grob_property ("threshold");
-  if (gh_pair_p (thr))
-    {
-      threshold[SMALLER] = gh_scm2double (ly_car (thr));
-      threshold[BIGGER] = gh_scm2double (ly_cdr (thr));      
-    }
-
+  Interval threshold = robust_scm2interval (me->get_property ("threshold"),
+                                           Interval (0, Interval::infinity ()));
   
   Array<Interval> dims;
 
   Link_array<Grob> elems;
   Link_array<Grob> all_grobs
-    = Pointer_group_interface__extract_elements (me, (Grob*) 0, "elements");
-  for (int i=0; i < all_grobs.size (); i++) 
+    = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
+  for (int i = 0; i < all_grobs.size (); i++) 
     {
       Interval y = all_grobs[i]->extent (me, a);
-      if (!y.empty_b ())
+      if (!y.is_empty ())
        {
-         Grob *e =dynamic_cast<Grob*> (all_grobs[i]);
-
-         // todo: fucks up if item both in Halign & Valign. 
-         SCM min_dims = e->remove_grob_property ("minimum-space");
-         if (gh_pair_p (min_dims) &&
-             gh_number_p (ly_car (min_dims))
-             && gh_number_p (ly_cdr (min_dims)))
-           {
-             y.unite (ly_scm2interval (min_dims));
-           }
-         
-         SCM extra_dims = e->remove_grob_property ("extra-space");
-         if (gh_pair_p (extra_dims) &&
-             gh_number_p (ly_car (extra_dims))
-             && gh_number_p (ly_cdr (extra_dims)))
-           {
-             y[LEFT] += gh_scm2double (ly_car (extra_dims));
-             y[RIGHT] += gh_scm2double (ly_cdr (extra_dims));
-           }
+         Grob *e = dynamic_cast<Grob*> (all_grobs[i]);
 
          elems.push (e);
          dims.push (y);          
@@ -170,18 +154,21 @@ Align_interface::align_elements_to_extents (Grob * me, Axis a)
     prevent ugly cyclic dependencies that arise when you combine
     self-alignment on a child with alignment of children.
   */
+ static SCM  prop_syms[2];
 
-  String s ("self-alignment-");
-
-  s += (a == X_AXIS) ? "X" : "Y";
-
-  SCM align (me->get_grob_property (s.ch_C ()));
-     
+  if (!prop_syms[0])
+    {
+      prop_syms[X_AXIS] = ly_symbol2scm ("self-alignment-X");
+      prop_syms[Y_AXIS] = ly_symbol2scm ("self-alignment-Y");
+    }
+  
+  SCM align (me->internal_get_property (prop_syms[a]));
+  
   Array<Real> translates ;
   Interval total;
-  Real where_f=0;
+  Real where_f = 0;
   
-  for (int j=0 ;  j < elems.size (); j++) 
+  for (int j = 0 ;  j < elems.size (); j++) 
     {
       Real dy = -  dims[j][-stacking_dir];
       if (j)
@@ -204,17 +191,15 @@ Align_interface::align_elements_to_extents (Grob * me, Axis a)
     }
 
   
-  Grob * align_center = unsmob_grob (align);
   Real center_offset = 0.0;
-  
   /*
     also move the grobs that were empty, to maintain spatial order. 
-   */
+  */
   Array<Real> all_translates;
   if (translates.size ())
     {
-      int i =0;
-      int j =0;
+      int i = 0;
+      int j = 0;
       Real w = translates[0];
       while (j  < all_grobs.size ())
        {
@@ -222,9 +207,7 @@ Align_interface::align_elements_to_extents (Grob * me, Axis a)
            {
              w = translates[i++];
            }
-         if (all_grobs[j] == align_center)
-           center_offset = w;
-         all_translates .push (w);
+         all_translates.push (w);
          j++;
        }
 
@@ -233,10 +216,8 @@ Align_interface::align_elements_to_extents (Grob * me, Axis a)
        FIXME: uncommenting freaks out the Y-alignment of
        line-of-score.
        */
-      // Real align_param = isdir_b (align)  ? gh_scm2double (align) : 0.0;
-      
-      if (gh_number_p (align))
-       center_offset = total.linear_combination (gh_scm2double (align));
+      if (scm_is_number (align))
+       center_offset = total.linear_combination (scm_to_double (align));
 
       for (int j = 0 ;  j < all_grobs.size (); j++)
        all_grobs[j]->translate_axis (all_translates[j] - center_offset, a);
@@ -245,53 +226,55 @@ Align_interface::align_elements_to_extents (Grob * me, Axis a)
 Axis
 Align_interface::axis (Grob*me)
 {
-  return  Axis (gh_scm2int (ly_car (me->get_grob_property ("axes"))));
-}
-
-
-/*
-  should  use generic Scm funcs.
- */
-int
-Align_interface::get_count (Grob*me,Grob*s)
-{
-  SCM e = me->get_grob_property ("elements");
-  int c =0;
-  while (gh_pair_p (e))
-    {
-      if (ly_car (e) == s->self_scm ())
-       break;
-      c++;
-      e = ly_cdr (e);
-    }
-  return c;
+  return  Axis (scm_to_int (scm_car (me->get_property ("axes"))));
 }
 
 void
-Align_interface::add_element (Grob*me,Grob* s, SCM cb)
+Align_interface::add_element (Grob*me, Grob* s, SCM cb)
 {
   s->add_offset_callback (cb, Align_interface::axis (me));
   Axis_group_interface::add_element (me, s);
 }
 
-
 void
-Align_interface::set_interface (Grob*me)
+Align_interface::set_axis (Grob*me, Axis a)
 {
-  me->set_interface (ly_symbol2scm ("align-interface"));
-
-  Axis_group_interface::set_interface (me);
+  Axis_group_interface::set_axes (me, a, a);
 }
 
-void
-Align_interface::set_axis (Grob*me,Axis a)
+
+/*
+  Find Y-axis parent of G that has a #'forced-distance property. This
+  has the effect of finding the piano-staff given an object in that
+  piano staff.
+ */
+Grob *
+find_fixed_alignment_parent  (Grob *g)
 {
-  Axis_group_interface::set_axes (me, a,a);
+  while (g)
+    {
+      if (scm_is_number (g->get_property ("forced-distance")))
+       return g;
+
+      g = g->get_parent (Y_AXIS);
+    }
+
+  return 0;
 }
 
-bool
-Align_interface::has_interface (Grob*me)
+
+
+
+ADD_INTERFACE (Align_interface, "align-interface",
+              "Order grobs from top to bottom, left to right, right to left or bottom"
+              "to top."
+              ,
+              "forced-distance stacking-dir align-dir threshold positioning-done "
+              "center-element elements axes");
+
+
+struct Foobar
 {
-  return me && me->has_interface (ly_symbol2scm ("align-interface"));
-}
+  bool has_interface (Grob*);
+};