]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/align-interface.cc
* The grand 2005-2006 replace.
[lilypond.git] / lily / align-interface.cc
index 2f9a52aae9bbd23127d5fae5ff03e9ed02f31794..dfccf028858eb5ded3eb133a73a64ccdc9e9a856 100644 (file)
@@ -3,11 +3,10 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2000--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "align-interface.hh"
-
 #include "spanner.hh"
 #include "item.hh"
 #include "axis-group-interface.hh"
 #include "hara-kiri-group-spanner.hh"
 #include "grob-array.hh"
 
-MAKE_SCHEME_CALLBACK (Align_interface, alignment_callback, 2);
+/*
+  TODO: for vertical spacing, should also include a rod & spring
+  scheme of sorts into this: the alignment should default to a certain
+  distance between element refpoints, unless bbox force a bigger
+  distance.
+ */
+
+MAKE_SCHEME_CALLBACK (Align_interface, calc_positioning_done, 1);
 SCM
-Align_interface::alignment_callback (SCM element_smob, SCM axis)
+Align_interface::calc_positioning_done (SCM smob)
 {
-  Grob *me = unsmob_grob (element_smob);
+  Grob *me = unsmob_grob (smob);
+  SCM axis = scm_car (me->get_property ("axes"));
   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 scm_from_double (0.0);
+
+  SCM force = me->get_property ("forced-distance");
+  if (scm_is_number (force))
+    Align_interface::align_to_fixed_distance (me, ax);
+  else
+    Align_interface::align_elements_to_extents (me, ax);
+
+  return SCM_BOOL_T;
 }
 
-MAKE_SCHEME_CALLBACK (Align_interface, fixed_distance_alignment_callback, 2);
+/*
+  merge with align-to-extents?
+*/
+MAKE_SCHEME_CALLBACK(Align_interface, stretch_after_break, 1)
 SCM
-Align_interface::fixed_distance_alignment_callback (SCM element_smob, SCM axis)
+Align_interface::stretch_after_break (SCM grob)
 {
-  Grob *me = unsmob_grob (element_smob);
-  Axis ax = (Axis)scm_to_int (axis);
-  Grob *par = me->get_parent (ax);
-  if (par && !to_boolean (par->get_property ("positioning-done")))
+  Grob *me = unsmob_grob (grob);
+
+  Spanner *me_spanner = dynamic_cast<Spanner *> (me);
+  extract_grob_set (me, "elements", elems);
+  if (me_spanner && elems.size ())
     {
-      Align_interface::align_to_fixed_distance (par, ax);
+      Grob *common = common_refpoint_of_array (elems, me, Y_AXIS);
+
+      /* force position callbacks */
+      for (int i = 0; i < elems.size (); i++)
+       elems[i]->relative_coordinate (common, Y_AXIS);
+
+      SCM details =  me_spanner->get_bound (LEFT)->get_property ("line-break-system-details");
+      SCM extra_space_handle = scm_assoc (ly_symbol2scm ("fixed-alignment-extra-space"), details);
+      
+      Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle)
+                                           ? scm_cdr (extra_space_handle)
+                                           : SCM_EOL,
+                                           0.0);
+
+      Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
+                                              DOWN);
+      Real delta  = extra_space / elems.size() * stacking_dir;
+      for (int i = 0; i < elems.size (); i++)
+       elems[i]->translate_axis (i * delta, Y_AXIS);
     }
-  return scm_from_double (0.0);
+  
+  return SCM_UNSPECIFIED;
 }
 
 /*
@@ -49,20 +81,15 @@ Align_interface::fixed_distance_alignment_callback (SCM element_smob, SCM axis)
 void
 Align_interface::align_to_fixed_distance (Grob *me, Axis a)
 {
-  me->set_property ("positioning-done", SCM_BOOL_T);
-
-  SCM d = me->get_property ("stacking-dir");
-
-  Direction stacking_dir = scm_is_number (d) ? to_dir (d) : CENTER;
-  if (!stacking_dir)
-    stacking_dir = DOWN;
+  Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
+                                          DOWN);
 
   Real dy = robust_scm2double (me->get_property ("forced-distance"), 0.0);
 
   extract_grob_set (me, "elements", elem_source);
 
-  Link_array<Grob> elems  (elem_source); // writable..
-  
+  Link_array<Grob> elems (elem_source); // writable..
+
   Real where_f = 0;
 
   Interval v;
@@ -77,8 +104,6 @@ Align_interface::align_to_fixed_distance (Grob *me, Axis a)
        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]))
@@ -99,9 +124,7 @@ Align_interface::align_to_fixed_distance (Grob *me, Axis a)
     TODO: support self-alignment-{Y, X}
   */
   for (int i = 0; i < translates.size (); i++)
-    {
-      elems[i]->translate_axis (translates[i] - v.center (), a);
-    }
+    elems[i]->translate_axis (translates[i] - v.center (), a);
 }
 
 /*
@@ -119,24 +142,35 @@ Align_interface::align_to_fixed_distance (Grob *me, Axis a)
   The original function has been taken over by
   align_to_fixed_distance ().
 */
+
 void
 Align_interface::align_elements_to_extents (Grob *me, Axis a)
 {
+  Real extra_space = 0.0;
   Spanner *me_spanner = dynamic_cast<Spanner *> (me);
   if (a == Y_AXIS
-      && me_spanner
-      && me_spanner->get_bound (LEFT)->break_status_dir () == CENTER)
+      && me_spanner)
     {
-      me_spanner->warning (_("vertical alignment called before line-breaking. Only do cross-staff spanners with PianoStaff."));
+#if 0
+      /*
+       TODO: messes up for figured bass alignments. 
+       */
+      if (me_spanner->get_bound (LEFT)->break_status_dir () == CENTER)
+       me->warning (_ ("vertical alignment called before line-breaking. "
+                       "Only do cross-staff spanners with PianoStaff."));
+#endif
+
+      SCM details =  me_spanner->get_bound (LEFT)->get_property ("line-break-system-details");
+      SCM extra_space_handle = scm_assoc (ly_symbol2scm ("alignment-extra-space"), details);
+
+      extra_space = robust_scm2double (scm_is_pair (extra_space_handle)
+                                      ? scm_cdr (extra_space_handle)
+                                      : SCM_EOL,
+                                      extra_space);
     }
   
-  me->set_property ("positioning-done", SCM_BOOL_T);
-
-  SCM d = me->get_property ("stacking-dir");
-
-  Direction stacking_dir = scm_is_number (d) ? to_dir (d) : CENTER;
-  if (!stacking_dir)
-    stacking_dir = DOWN;
+  Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
+                                              DOWN);
 
   Interval threshold = robust_scm2interval (me->get_property ("threshold"),
                                            Interval (0, Interval::infinity ()));
@@ -164,19 +198,13 @@ 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];
-
-  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]));
+  SCM align ((a == X_AXIS)
+            ? me->get_property ("self-alignment-X")
+            : me->get_property ("self-alignment-Y"));
 
   Array<Real> translates;
   Interval total;
-  Real where_f = 0;
+  Real where = 0;
 
   for (int j = 0; j < elems.size (); j++)
     {
@@ -189,17 +217,15 @@ Align_interface::align_elements_to_extents (Grob *me, Axis a)
       */
       dy *= stacking_dir;
       if (j)
-       {
-         dy = min (max (dy, threshold[SMALLER]),
-                   threshold[BIGGER]);
-       }
+       dy = min (max (dy, threshold[SMALLER]), threshold[BIGGER]);
 
-      where_f += stacking_dir * dy;
-      total.unite (dims[j] + where_f);
-      translates.push (where_f);
+      where += stacking_dir * (dy + extra_space / elems.size ());
+      total.unite (dims[j] + where);
+      translates.push (where);
     }
 
   Real center_offset = 0.0;
+  
   /*
     also move the grobs that were empty, to maintain spatial order.
   */
@@ -212,9 +238,7 @@ Align_interface::align_elements_to_extents (Grob *me, Axis a)
       while (j < all_grobs.size ())
        {
          if (i < elems.size () && all_grobs[j] == elems[i])
-           {
-             w = translates[i++];
-           }
+           w = translates[i++];
          all_translates.push (w);
          j++;
        }
@@ -237,16 +261,19 @@ Align_interface::axis (Grob *me)
 }
 
 void
-Align_interface::add_element (Grob *me, Grob *element, SCM call_back)
+Align_interface::add_element (Grob *me, Grob *element)
 {
-  element->add_offset_callback (call_back, Align_interface::axis (me));
+  Axis a = Align_interface::axis (me);
+  SCM sym = axis_offset_symbol (a);
+  SCM proc = axis_parent_positioning (a);
+    
+  element->internal_set_property (sym, proc);
   Axis_group_interface::add_element (me, element);
 }
 
 void
-Align_interface::set_axis (Grob *me, Axis a)
+Align_interface::set_ordered (Grob *me)
 {
-  Axis_group_interface::set_axes (me, a, a);
   SCM ga_scm = me->get_object ("elements");
   Grob_array *ga = unsmob_grob_array (ga_scm);
   if (!ga)
@@ -257,7 +284,6 @@ Align_interface::set_axis (Grob *me, Axis a)
     }
 
   ga->set_ordered (true);
-  
 }
 
 /*
@@ -279,10 +305,25 @@ find_fixed_alignment_parent (Grob *g)
   return 0;
 }
 
-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 "
+ADD_INTERFACE (Align_interface,
+              "align-interface",
+              
+              "Order grobs from top to bottom, left to right, right to left or bottom "
+              "to top.  "
+              "For vertical alignments of staves, the @code{break-system-details} of "
+              "the left @internalsref{NonMusicalPaperColumn} may be set to tune vertical spacing "
+              "Set @code{alignment-extra-space} to add extra space for staves. Set "
+              "@code{fixed-alignment-extra-space} to force staves in PianoStaves further apart."
+              ,
+              
+              /*
+                properties
+               */
+              "forced-distance "
+              "stacking-dir "
+              "align-dir "
+              "threshold "
+              "positioning-done "
               "elements axes");
 
 struct Foobar