]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/axis-group-interface.cc
Merge branch 'jneeman' of git+ssh://jneem@git.sv.gnu.org/srv/git/lilypond into jneeman
[lilypond.git] / lily / axis-group-interface.cc
index 1d509f04d1923b436c0f4866d2767e2b085fea32..4319bb8b92cd0594311142bed40928dddeec28ae 100644 (file)
@@ -9,14 +9,14 @@
 #include "axis-group-interface.hh"
 
 #include "align-interface.hh"
+#include "directional-element-interface.hh"
 #include "pointer-group-interface.hh"
-#include "grob.hh"
 #include "grob-array.hh"
 #include "hara-kiri-group-spanner.hh"
 #include "international.hh"
-#include "item.hh"
 #include "paper-column.hh"
 #include "paper-score.hh"
+#include "separation-item.hh"
 #include "system.hh"
 #include "warn.hh"
 
@@ -27,17 +27,17 @@ Axis_group_interface::add_element (Grob *me, Grob *e)
   if (!scm_is_pair (axes))
     programming_error ("axes should be nonempty");
 
-  for (SCM ax = axes; ax != SCM_EOL; ax = scm_cdr (ax))
+  for (SCM ax = axes; scm_is_pair (ax); ax = scm_cdr (ax))
     {
       Axis a = (Axis) scm_to_int (scm_car (ax));
 
       if (!e->get_parent (a))
        e->set_parent (me, a);
 
-      e->internal_set_object ((a == X_AXIS)
-                             ? ly_symbol2scm ("axis-group-parent-X")
-                             : ly_symbol2scm ("axis-group-parent-Y"),
-                             me->self_scm ());
+      e->set_object ((a == X_AXIS)
+                    ? ly_symbol2scm ("axis-group-parent-X")
+                    : ly_symbol2scm ("axis-group-parent-Y"),
+                    me->self_scm ());
     }
 
   /* must be ordered, because Align_interface also uses
@@ -88,6 +88,8 @@ Axis_group_interface::cached_pure_height (Grob *me,
       if (end == r)
        end_index = i;
     }
+  if (end == INT_MAX)
+    end_index = breaks.size () - 1;
 
   if (start_index == VPOS || end_index == VPOS)
     {
@@ -177,10 +179,53 @@ Axis_group_interface::pure_height (SCM smob, SCM start_scm, SCM end_scm)
 
   return pure_group_height (me, start, end);
 }
+
+MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_skylines, 1);
+SCM
+Axis_group_interface::calc_skylines (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  extract_grob_set (me, "elements", elts);
+  return skyline_spacing (me, elts).smobbed_copy ();
+}
+
+/* whereas calc_skylines calculates skylines for axis-groups with a lot of
+   visible children, combine_skylines is designed for axis-groups whose only
+   children are other axis-groups (ie. VerticalAlignment). Rather than
+   calculating all the skylines from scratch, we just merge the skylines
+   of the children.
+*/
+MAKE_SCHEME_CALLBACK (Axis_group_interface, combine_skylines, 1);
+SCM
+Axis_group_interface::combine_skylines (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  extract_grob_set (me, "elements", elements);
+  Grob *y_common = common_refpoint_of_array (elements, me, Y_AXIS);
+
+  assert (y_common == me);
+
+  Skyline_pair ret;
+  for (vsize i = 0; i < elements.size (); i++)
+    {
+      SCM skyline_scm = elements[i]->get_property ("skylines");
+      if (Skyline_pair::unsmob (skyline_scm))
+       {
+         Real offset = elements[i]->relative_coordinate (y_common, Y_AXIS);
+         Skyline_pair other = *Skyline_pair::unsmob (skyline_scm);
+         other.raise (offset);
+         ret.merge (other);
+       }
+    }
+  return ret.smobbed_copy ();
+}
   
 SCM
 Axis_group_interface::generic_group_extent (Grob *me, Axis a)
 {
+  /* trigger the callback to do skyline-spacing on the children */
+  (void) me->get_property ("skylines");
+
   extract_grob_set (me, "elements", elts);
   Grob *common = common_refpoint_of_array (elts, me, a);
 
@@ -251,7 +296,145 @@ Axis_group_interface::get_children (Grob *me, vector<Grob*> *found)
     }
 }
 
-ADD_INTERFACE (Axis_group_interface, "axis-group-interface",
+bool
+staff_priority_less (Grob * const &g1, Grob * const &g2)
+{
+  Real priority_1 = robust_scm2double (g1->get_property ("outside-staff-priority"), -infinity_f);
+  Real priority_2 = robust_scm2double (g2->get_property ("outside-staff-priority"), -infinity_f);
+
+  if (priority_1 < priority_2)
+    return true;
+  else if (priority_1 > priority_2)
+    return false;
+
+  /* if there is no preference in staff priority, choose the left-most one */
+  Grob *common = g1->common_refpoint (g2, X_AXIS);
+  Real start_1 = g1->extent (common, X_AXIS)[LEFT];
+  Real start_2 = g2->extent (common, X_AXIS)[LEFT];
+  return start_1 < start_2;
+}
+
+static void
+add_boxes (Grob *me, Grob *x_common, Grob *y_common, vector<Box> *const boxes)
+{
+  /* if we are a parent, consider the children's boxes instead of mine */
+  if (Grob_array *elements = unsmob_grob_array (me->get_object ("elements")))
+    {
+      for (vsize i = 0; i < elements->size (); i++)
+       add_boxes (elements->grob (i), x_common, y_common, boxes);
+    }
+  else if (!scm_is_number (me->get_property ("outside-staff-priority")))
+    boxes->push_back (Box (me->extent (x_common, X_AXIS),
+                          me->extent (y_common, Y_AXIS)));
+}
+
+/* We want to avoid situations like this:
+           still more text
+      more text
+   text
+   -------------------
+   staff
+   -------------------
+
+   The point is that "still more text" should be positioned under
+   "more text".  In order to achieve this, we place the grobs in several
+   passes.  We keep track of the right-most horizontal position that has been
+   affected by the current pass so far (actually we keep track of 2
+   positions, one for above the staff, one for below).
+
+   In each pass, we loop through the unplaced grobs from left to right.
+   If the grob overlaps the right-most affected position, we place it
+   (and then update the right-most affected position to point to the right
+   edge of the just-placed grob).  Otherwise, we skip it until the next pass.
+*/
+static void
+add_grobs_of_one_priority (Skyline_pair *const skylines,
+                          vector<Grob*> elements,
+                          Grob *x_common,
+                          Grob *y_common)
+{
+  vector<Box> boxes;
+  Drul_array<Real> last_affected_position;
+
+  reverse (elements);
+  while (!elements.empty ())
+    {
+      last_affected_position[UP] = -infinity_f;
+      last_affected_position[DOWN] = -infinity_f;
+      /* do one pass */
+      for (vsize i = elements.size (); i--;)
+       {
+         Direction dir = get_grob_direction (elements[i]);
+         if (dir == CENTER)
+           {
+             warning (_ ("an outside-staff object should have a direction, defaulting to up"));
+             dir = UP;
+           }
+
+         Box b (elements[i]->extent (x_common, X_AXIS),
+                elements[i]->extent (y_common, Y_AXIS));
+         SCM horizon_padding_scm = elements[i]->get_property ("outside-staff-horizontal-padding");
+         Real horizon_padding = robust_scm2double (horizon_padding_scm, 0.0);
+
+         if (b[X_AXIS][LEFT] - 2*horizon_padding < last_affected_position[dir])
+           continue;
+
+         if (b[X_AXIS].is_empty () || b[Y_AXIS].is_empty ())
+           warning (_f ("outside-staff object %s has an empty extent", elements[i]->name ().c_str ()));
+         else
+           {
+             boxes.clear ();
+             boxes.push_back (b);
+             Skyline other = Skyline (boxes, horizon_padding, X_AXIS, -dir);
+             Real padding = robust_scm2double (elements[i]->get_property ("outside-staff-padding"), 0.5);
+             Real dist = (*skylines)[dir].distance (other) + padding;
+
+             if (dist > 0)
+               {
+                 b.translate (Offset (0, dir*dist));
+                 elements[i]->translate_axis (dir*dist, Y_AXIS);
+               }
+             (*skylines)[dir].insert (b, 0, X_AXIS);
+             elements[i]->set_property ("outside-staff-priority", SCM_BOOL_F);
+             last_affected_position[dir] = b[X_AXIS][RIGHT];
+           }
+         elements.erase (elements.begin () + i);
+       }
+    }
+}
+
+Skyline_pair
+Axis_group_interface::skyline_spacing (Grob *me, vector<Grob*> elements)
+{
+  vector_sort (elements, staff_priority_less);
+  Grob *x_common = common_refpoint_of_array (elements, me, X_AXIS);
+  Grob *y_common = common_refpoint_of_array (elements, me, Y_AXIS);
+
+  assert (y_common == me);
+
+  vsize i = 0;
+  vector<Box> boxes;
+
+  for (i = 0; i < elements.size ()
+        && !scm_is_number (elements[i]->get_property ("outside-staff-priority")); i++)
+    add_boxes (elements[i], x_common, y_common, &boxes);
+
+  Skyline_pair skylines (boxes, 0, X_AXIS);
+  for (; i < elements.size (); i++)
+    {
+      SCM priority = elements[i]->get_property ("outside-staff-priority");
+      vector<Grob*> current_elts;
+      current_elts.push_back (elements[i]);
+      while (i < elements.size () - 1
+            && scm_eq_p (elements[i+1]->get_property ("outside-staff-priority"), priority))
+       current_elts.push_back (elements[++i]);
+
+      add_grobs_of_one_priority (&skylines, current_elts, x_common, y_common);
+    }
+  return skylines;
+}
+
+ADD_INTERFACE (Axis_group_interface,
 
               "An object that groups other layout objects.",
 
@@ -260,5 +443,6 @@ ADD_INTERFACE (Axis_group_interface, "axis-group-interface",
               "elements "
               "common-refpoint-of-elements "
               "pure-relevant-elements "
+              "skylines "
               "cached-pure-extents "
               );