]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/hara-kiri-group-spanner.cc
Run `make grand-replace'.
[lilypond.git] / lily / hara-kiri-group-spanner.cc
index ae50f446850f800cf90ba1d9785f4b4c705aac22..859ae78df4d98c18dbf9df3cf2813bfe68fd1c4b 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1998--2000 Jan Nieuwenhuizen <janneke@gnu.org>
-  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1998--2008 Jan Nieuwenhuizen <janneke@gnu.org>
+  Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include "axis-group-interface.hh"
-#include "spanner.hh"
 #include "hara-kiri-group-spanner.hh"
-#include "debug.hh"
-#include "item.hh"
 
+#include "paper-column.hh"
+#include "pointer-group-interface.hh"
+#include "axis-group-interface.hh"
+#include "spanner.hh"
+#include "warn.hh"
 
-MAKE_SCHEME_CALLBACK(Hara_kiri_group_spanner,y_extent,2);
+MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, y_extent, 1);
 SCM
-Hara_kiri_group_spanner::y_extent (SCM element_smob, SCM scm_axis)
+Hara_kiri_group_spanner::y_extent (SCM smob)
 {
-  Grob *me = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (scm_axis);
+  Grob *me = unsmob_grob (smob);
+  consider_suicide (me);
+  return Axis_group_interface::generic_group_extent (me, Y_AXIS);
+}
 
-  assert (a == Y_AXIS);
+MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, calc_skylines, 1);
+SCM
+Hara_kiri_group_spanner::calc_skylines (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
   consider_suicide (me);
-  return  Axis_group_interface::group_extent_callback (me->self_scm (), scm_axis);
+  return Axis_group_interface::calc_skylines (smob);
 }
 
+MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, pure_height, 3);
+SCM
+Hara_kiri_group_spanner::pure_height (SCM smob, SCM start_scm, SCM end_scm)
+{
+  Grob *me = unsmob_grob (smob);
+  int start = robust_scm2int (start_scm, 0);
+  int end = robust_scm2int (end_scm, INT_MAX);
 
-void
-Hara_kiri_group_spanner::consider_suicide(Grob*me)
+  if (request_suicide (me, start, end))
+    return ly_interval2scm (Interval ());
+
+  return ly_interval2scm (Axis_group_interface::pure_group_height (me, start, end));
+}
+
+/* there is probably a way that doesn't involve re-implementing a binary
+   search (I would love some proper closures right now) */
+bool find_in_range (SCM vector, int low, int hi, int min, int max)
 {
-  SCM worth = me->get_grob_property ("items-worth-living");
-  if (gh_pair_p (worth))
-    return ;
+  if (low >= hi)
+    return false;
+
+  int mid = low + (hi - low) / 2;
+  int val = scm_to_int (scm_c_vector_ref (vector, mid));
+  if (val >= min && val <= max)
+    return true;
+  else if (val < min)
+    return find_in_range (vector, mid+1, hi, min, max);
+  return find_in_range (vector, low, mid, min, max);
+}
 
-  Link_array<Grob> childs = Axis_group_interface::get_children (me);
-  for (int i = 0; i < childs.size (); i++)
-    childs[i]->suicide ();
+bool
+Hara_kiri_group_spanner::request_suicide (Grob *me, int start, int end)
+{
+  if (!to_boolean (me->get_property ("remove-empty")))
+    return false;
+
+  bool remove_first = to_boolean (me->get_property ("remove-first"));
+  if (!remove_first && start <= 0)
+    return false;
+
+  SCM important = me->get_property ("important-column-ranks");
+  if (scm_is_vector (important))
+    {
+      int len = scm_c_vector_length (important);
+      if (find_in_range (important, 0, len, start, end))
+       return false;
+    }
+  else /* build the important-columns-cache */
+    {
+      extract_grob_set (me, "items-worth-living", worth);
+      vector<int> ranks;
+
+      for (vsize i = 0; i < worth.size (); i++)
+       {
+         Interval_t<int> iv = worth[i]->spanned_rank_interval ();
+         for (int j = iv[LEFT]; j <= iv[RIGHT]; j++)
+           ranks.push_back (j);
+       }
+      vector_sort (ranks, less<int> ());
+      uniq (ranks);
+
+      SCM scm_vec = scm_c_make_vector (ranks.size (), SCM_EOL);
+      for (vsize i = 0; i < ranks.size (); i++)
+       scm_vector_set_x (scm_vec, scm_from_int (i), scm_from_int (ranks[i]));
+      me->set_property ("important-column-ranks", scm_vec);
+
+      return request_suicide (me, start, end);
+    }
+
+  return true;
+}
 
+void
+Hara_kiri_group_spanner::consider_suicide (Grob *me)
+{
+  Spanner *sp = dynamic_cast<Spanner*> (me);
+  int left = sp->get_bound (LEFT)->get_column ()->get_rank ();
+  int right = sp->get_bound (RIGHT)->get_column ()->get_rank ();
+  if (!request_suicide (me, left, right))
+    return;
+
+  vector<Grob*> childs;
+  Axis_group_interface::get_children (me, &childs);
+  for (vsize i = 0; i < childs.size (); i++)
+    childs[i]->suicide ();
 
   /*
     very appropriate name here :-)
-   */
+  */
   me->suicide ();
 }
 
-
-
 /*
   We can't rely on offsets and dimensions of elements in a hara-kiri
   group. Use a callback to make sure that hara-kiri has been done
   before asking for offsets.  */
-MAKE_SCHEME_CALLBACK(Hara_kiri_group_spanner,force_hara_kiri_callback,2);
+MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, force_hara_kiri_callback, 1);
 SCM
-Hara_kiri_group_spanner::force_hara_kiri_callback (SCM element_smob, SCM axis)
+Hara_kiri_group_spanner::force_hara_kiri_callback (SCM smob)
 {
-  Grob *me = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (axis);
-  assert (a == Y_AXIS);
+  Grob *me = unsmob_grob (smob);
   consider_suicide (me);
-  return gh_double2scm (0.0);
+  return scm_from_double (0.0);
 }
 
-
-MAKE_SCHEME_CALLBACK(Hara_kiri_group_spanner,force_hara_kiri_in_parent_callback,2);
+MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, force_hara_kiri_in_y_parent_callback, 1);
 SCM
-Hara_kiri_group_spanner::force_hara_kiri_in_parent_callback (SCM element_smob, SCM axis)
+Hara_kiri_group_spanner::force_hara_kiri_in_y_parent_callback (SCM smob)
 {
-  Grob *daughter = unsmob_grob (element_smob);
-  Axis a = (Axis) gh_scm2int (axis);
-  assert (a == Y_AXIS);
-  force_hara_kiri_callback (daughter->parent_l (a)->self_scm (), axis);
-  return gh_double2scm ( 0.0);
+  Grob *daughter = unsmob_grob (smob);
+  force_hara_kiri_callback (daughter->get_parent (Y_AXIS)->self_scm ());
+  return scm_from_double (0.0);
 }
 
 void
-Hara_kiri_group_spanner::add_element (Grob * me, Grob *e)
+Hara_kiri_group_spanner::add_interesting_item (Grob *me, Grob *n)
 {
-  //  e->add_offset_callback (force_hara_kiri_in_parent_callback, Y_AXIS);
-  Axis_group_interface::add_element (me, e);
+  Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("items-worth-living"), n);
 }
 
+ADD_INTERFACE (Hara_kiri_group_spanner,
+              "A group spanner that keeps track of interesting items.  If it"
+              " doesn't contain any after line breaking, it removes itself"
+              " and all its children.",
 
-void
-Hara_kiri_group_spanner::set_interface (Grob*me)
-{
-  me->set_interface (ly_symbol2scm ("hara-kiri-group-interface"));
-}
+              /* properties */
+              "items-worth-living "
+              "important-column-ranks "
+              "remove-empty "
+              "remove-first "
+              );
 
 
-bool
-Hara_kiri_group_spanner::has_interface (Grob*me)
-{
-  return me->has_interface (ly_symbol2scm ("hara-kiri-group-interface"));
-}
-
-void 
-Hara_kiri_group_spanner::add_interesting_item (Grob* me,Grob* n)
-{
-  me->add_dependency (n);
-  Pointer_group_interface::add_element (me, "items-worth-living",n);
-}