]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/align-interface.cc
* mf/GNUmakefile: always trace pfa fonts.
[lilypond.git] / lily / align-interface.cc
index 9d5a00abf52c975cbc657d7299738e7f361fd8ac..5f7306d2b1340ac8aee0099221be2a2c811ba20e 100644 (file)
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 2000--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
 
 #include "align-interface.hh"
-#include "dimension-cache.hh"
-#include "score-element.hh"
+#include "grob.hh"
 #include "group-interface.hh"
 #include "axis-group-interface.hh"
+#include "hara-kiri-group-spanner.hh"
+#include "paper-def.hh"
 
-/*
-  This callback is set in the children of the align element. It does
-  not compute anything, but a side effect of a->do_side_processing ()
-  is that the elements are placed correctly.  */
-Real
-Align_interface::alignment_callback (Dimension_cache const *c)
+MAKE_SCHEME_CALLBACK (Align_interface,alignment_callback,2);
+SCM
+Align_interface::alignment_callback (SCM element_smob, SCM axis)
 {
-  Axis ax = c->axis ();
-  Score_element * sc = c->element_l ()->parent_l (ax);
-
-  if (sc && sc->get_elt_property ("alignment-done") == SCM_UNDEFINED) 
+  Grob * me = unsmob_grob (element_smob);
+  Axis ax = (Axis)gh_scm2int (axis);
+  Grob * par = me->get_parent (ax);
+  if (par && !to_boolean (par->get_grob_property ("alignment-done")))
     {
-      Align_interface (sc).do_side_processing (ax);
+      Align_interface::align_elements_to_extents (par, ax);
     }
-  return 0.0;
+  return gh_double2scm (0.0);
 }
 
+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->get_parent (ax);
+  if (par && !to_boolean (par->get_grob_property ("alignment-done")))
+    {
+      Align_interface::align_to_fixed_distance (par, ax);
+    }
+  return gh_double2scm (0.0);
+}
 
-Real
-Align_interface::center_on_element (Dimension_cache const *c)
+/*
+  merge with align-to-extents? 
+ */
+void
+Align_interface::align_to_fixed_distance (Grob *me , Axis a)
 {
-  Score_element *me = c->element_l ();
-  Score_element *cent = unsmob_element (me->get_elt_property ("group-center-element"));
+  me->set_grob_property ("alignment-done", SCM_BOOL_T);
+  
+  SCM d =   me->get_grob_property ("stacking-dir");
+  
+  Direction stacking_dir = gh_number_p (d) ? to_dir (d) : CENTER;
+  if (!stacking_dir)
+    stacking_dir = DOWN;
+
+  SCM force = me->get_grob_property ("forced-distance");
 
-  if (cent)
+  Real dy = 0.0;
+  if (gh_number_p (force))
     {
-      Real r = cent->relative_coordinate (me,  c->axis ());
-      return -r;
+      dy = gh_scm2double (force);
+    }
+  
+  Link_array<Grob> elems
+    = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
+
+  Real where_f=0;
+
+  Interval v;
+  v.set_empty ();
+  Array<Real> translates;
+  
+  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]-> live())
+       elems.del(j);
+    }
+
+  for (int j =0; j < elems.size (); j++)
+    {
+      where_f += stacking_dir * dy;
+      translates.push (where_f);
+      v.unite (Interval (where_f, where_f));
+    }
+
+  /*
+    TODO: support self-alignment-{Y,X}
+   */
+  for (int i = 0; i < translates.size (); i++)
+    {
+      elems[i]->translate_axis (translates[i] - v.center (), a);
     }
-  return 0;
 }
 
 /*
   Hairy function to put elements where they should be. Can be tweaked
-  from the outside by setting minimum-space and extra-space in its
-  children */
+  from the outside by setting extra-space in its
+  children
+
+  We assume that the children the refpoints of the children are still
+  found at 0.0 -- we will fuck up with thresholds if children's
+  extents are already moved to locations such as (-16, -8), since the
+  dy needed to put things in a row doesn't relate to the distances
+  between original refpoints.
+
+  TODO: maybe we should rethink and throw out thresholding altogether.
+  The original function has been taken over by
+  align_to_fixed_distance().
+*/
 void
-Align_interface::do_side_processing (Axis a)
+Align_interface::align_elements_to_extents (Grob * me, Axis a)
 {
-  elt_l_->set_elt_property ("alignment-done", SCM_BOOL_T);
+  me->set_grob_property ("alignment-done", SCM_BOOL_T);
   
-  SCM d =   elt_l_->get_elt_property ("stacking-dir");
-  Direction stacking_dir = gh_number_p(d) ? to_dir (d) : CENTER;
+  SCM d =   me->get_grob_property ("stacking-dir");
+  
+  Direction stacking_dir = gh_number_p (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));      
+    }
 
   
   Array<Interval> dims;
 
-  Link_array<Score_element> elems;
-  Link_array<Score_element> all_elts
-    = Group_interface__extract_elements (  elt_l_, (Score_element*) 0, "elements");
-  for (int i=0; i < all_elts.size(); i++) 
+  Link_array<Grob> elems;
+  Link_array<Grob> all_grobs
+    = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
+  for (int i=0; i < all_grobs.size (); i++) 
     {
-      Interval y = all_elts[i]->extent(a) + all_elts[i]->relative_coordinate (elt_l_, a);
-      if (!y.empty_b())
+      Interval y = all_grobs[i]->extent (me, a);
+      if (!y.empty_b ())
        {
-         Score_element *e =dynamic_cast<Score_element*>(all_elts[i]);
-
-         // todo: fucks up if item both in Halign & Valign. 
-         SCM min_dims = e->remove_elt_property ("minimum-space");
-         if (gh_pair_p (min_dims) &&
-             gh_number_p (gh_car (min_dims))
-             && gh_number_p (gh_cdr (min_dims)))
-           {
-             y.unite (Interval (gh_scm2double (gh_car  (min_dims)),
-                                gh_scm2double (gh_cdr (min_dims))));
-           }
-         
-         SCM extra_dims = e->remove_elt_property ("extra-space");
-         if (gh_pair_p (extra_dims) &&
-             gh_number_p (gh_car (extra_dims))
-             && gh_number_p (gh_cdr (extra_dims)))
-           {
-             y[LEFT] += gh_scm2double (gh_car  (extra_dims));
-             y[RIGHT] += gh_scm2double (gh_cdr (extra_dims));
-           }
+         Grob *e =dynamic_cast<Grob*> (all_grobs[i]);
 
          elems.push (e);
          dims.push (y);          
        }
     }
-
   
-  Interval threshold = Interval (0, Interval::infinity ());
-  SCM thr = elt_l_->get_elt_property ("threshold");
-  if (gh_pair_p (thr))
+  /*
+    Read self-alignment-X and self-alignment-Y. This may seem like
+    code duplication. (and really: it is), but this is necessary to
+    prevent ugly cyclic dependencies that arise when you combine
+    self-alignment on a child with alignment of children.
+  */
+ static SCM  prop_syms[2];
+
+  if (!prop_syms[0])
     {
-      threshold[SMALLER] = gh_scm2double (gh_car (thr));
-      threshold[BIGGER] = gh_scm2double (gh_cdr (thr));      
+      prop_syms[X_AXIS] = ly_symbol2scm ("self-alignment-X");
+      prop_syms[Y_AXIS] = ly_symbol2scm ("self-alignment-Y");
     }
-
+  
+  SCM align (me->internal_get_grob_property (prop_syms[a]));
+  
+  Array<Real> translates ;
+  Interval total;
   Real where_f=0;
-  for (int i=0 ;  i < elems.size(); i++) 
+  
+  for (int j=0 ;  j < elems.size (); j++) 
     {
-      Real dy = - stacking_dir * dims[i][-stacking_dir];
-      if (i)
-       dy += stacking_dir * dims[i-1][stacking_dir];
+      Real dy = -  dims[j][-stacking_dir];
+      if (j)
+       dy += dims[j-1][stacking_dir];
 
-      if (i)
+
+      /*
+       we want dy to be > 0
+       */
+      dy *= stacking_dir; 
+      if (j)
        {
-         dy = (dy >? threshold[SMALLER] )
+         dy = (dy >? threshold[SMALLER])
            <? threshold[BIGGER];
        }
 
       where_f += stacking_dir * dy;
-      elems[i]->translate_axis (where_f, a);
+      total.unite (dims[j] +   where_f);
+      translates.push (where_f);
     }
-}
 
+  
+  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;
+      Real w = translates[0];
+      while (j  < all_grobs.size ())
+       {
+         if (i < elems.size () && all_grobs[j] == elems[i])
+           {
+             w = translates[i++];
+           }
+         if (all_grobs[j] == align_center)
+           center_offset = w;
+         all_translates .push (w);
+         j++;
+       }
 
-Axis
-Align_interface::axis ()const
-{
-  return  Axis (gh_scm2int (gh_car (elt_l_->get_elt_property ("axes"))));
-}
 
+      /*
+       FIXME: uncommenting freaks out the Y-alignment of
+       line-of-score.
+       */
+      // Real align_param = is_direction (align)  ? gh_scm2double (align) : 0.0;
+      
+      if (gh_number_p (align))
+       center_offset = total.linear_combination (gh_scm2double (align));
 
-/*
-  should  use generic Scm funcs.
- */
-int
-Align_interface::get_count (Score_element*s)const
-{
-  SCM e = elt_l_->get_elt_property ("elements");
-  int c =0;
-  while (gh_pair_p (e))
-    {
-      if (gh_car (e) == s->self_scm_)
-       break;
-      c++;
-      e = gh_cdr (e);
+      for (int j = 0 ;  j < all_grobs.size (); j++)
+       all_grobs[j]->translate_axis (all_translates[j] - center_offset, a);
     }
-  return c;
 }
-
-void
-Align_interface::add_element (Score_element* s)
+Axis
+Align_interface::axis (Grob*me)
 {
-  s->add_offset_callback (alignment_callback, axis ());
-  Axis_group_interface (elt_l_).add_element (s);
-  
+  return  Axis (gh_scm2int (ly_car (me->get_grob_property ("axes"))));
 }
 
-Align_interface::Align_interface (Score_element const*s)
+void
+Align_interface::add_element (Grob*me,Grob* s, SCM cb)
 {
-  elt_l_ = (Score_element*)s;
+  s->add_offset_callback (cb, Align_interface::axis (me));
+  Axis_group_interface::add_element (me, s);
 }
 
 void
-Align_interface::set_interface ()
+Align_interface::set_axis (Grob*me,Axis a)
 {
-  Axis_group_interface (elt_l_).set_interface ();
-
-  Group_interface (elt_l_, "interfaces").add_thing (ly_symbol2scm ("Alignment"));
+  Axis_group_interface::set_axes (me, a,a);
 }
 
-void
-Align_interface::set_axis (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 (elt_l_).set_axes (a,a );
+  while (g)
+    {
+      if (gh_number_p (g->get_grob_property ("forced-distance")))
+       return g;
+
+      g = g->get_parent (Y_AXIS);
+    }
+
+  return 0;
 }
 
-bool
-Align_interface::has_interface_b ()
+
+
+
+ADD_INTERFACE (Align_interface, "align-interface",
+  " Order grobs top to bottom/left to right/right to left etc.",
+  "forced-distance stacking-dir align-dir threshold alignment-done center-element elements axes");
+
+
+struct Foobar
 {
-  SCM memq = scm_memq (ly_symbol2scm ("Alignment"),
-             elt_l_->get_elt_property ("interfaces"));
-  
-  return (memq != SCM_BOOL_F);
-}
+  bool has_interface (Grob*);
+};