lily/hara-kiri-group-spanner.cc

   1 /*
   2   hara-kiri-vertical-group-spanner.cc -- implement Hara_kiri_group_spanner
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2005 Jan Nieuwenhuizen <janneke@gnu.org>
   7   Han-Wen Nienhuys <hanwen@cs.uu.nl>
   8 */
   9
  10 #include "hara-kiri-group-spanner.hh"
  11
  12 #include "paper-column.hh"
  13 #include "pointer-group-interface.hh"
  14 #include "axis-group-interface.hh"
  15 #include "spanner.hh"
  16 #include "warn.hh"
  17 #include "item.hh"
  18
  19 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, y_extent, 2);
  20 SCM
  21 Hara_kiri_group_spanner::y_extent (SCM element_smob, SCM scm_axis)
  22 {
  23   Grob *me = unsmob_grob (element_smob);
  24   (void) scm_axis;
  25
  26   assert (scm_to_int (scm_axis) == Y_AXIS);
  27   consider_suicide (me);
  28   return Axis_group_interface::group_extent_callback (me->self_scm (), scm_axis);
  29 }
  30
  31 void
  32 Hara_kiri_group_spanner::consider_suicide (Grob *me)
  33 {
  34   Spanner *sp = dynamic_cast<Spanner *> (me);
  35
  36   extract_grob_set (me, "items-worth-living", worth);
  37   if (worth.size ())
  38     return;
  39
  40   bool remove_first = to_boolean (me->get_property ("remove-first"));
  41   if (!remove_first
  42        && ((sp->original_ && broken_spanner_index (sp) == 0)
  43            || Paper_column::get_rank (sp->get_bound (LEFT)->get_column ())
  44            == 0))
  45     return;
  46
  47   Link_array<Grob> childs;
  48   Axis_group_interface::get_children (me, &childs);
  49   for (int i = 0; i < childs.size (); i++)
  50     childs[i]->suicide ();
  51
  52   /*
  53     very appropriate name here :-)
  54   */
  55   me->suicide ();
  56 }
  57
  58 /*
  59   We can't rely on offsets and dimensions of elements in a hara-kiri
  60   group. Use a callback to make sure that hara-kiri has been done
  61   before asking for offsets.  */
  62 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, force_hara_kiri_callback, 2);
  63 SCM
  64 Hara_kiri_group_spanner::force_hara_kiri_callback (SCM element_smob, SCM axis)
  65 {
  66   Grob *me = unsmob_grob (element_smob);
  67   (void) axis;
  68
  69   assert (scm_to_int (axis) == Y_AXIS);
  70   consider_suicide (me);
  71   return scm_from_double (0.0);
  72 }
  73
  74 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, force_hara_kiri_in_parent_callback, 2);
  75 SCM
  76 Hara_kiri_group_spanner::force_hara_kiri_in_parent_callback (SCM element_smob, SCM axis)
  77 {
  78   Grob *daughter = unsmob_grob (element_smob);
  79   Axis a = (Axis) scm_to_int (axis);
  80   assert (a == Y_AXIS);
  81   force_hara_kiri_callback (daughter->get_parent (a)->self_scm (), axis);
  82   return scm_from_double (0.0);
  83 }
  84
  85 void
  86 Hara_kiri_group_spanner::add_element (Grob *me, Grob *e)
  87 {
  88   //  e->add_offset_callback (force_hara_kiri_in_parent_callback, Y_AXIS);
  89   Axis_group_interface::add_element (me, e);
  90 }
  91
  92 void
  93 Hara_kiri_group_spanner::add_interesting_item (Grob *me, Grob *n)
  94 {
  95   me->add_dependency (n);
  96   Pointer_group_interface::add_grob (me, ly_symbol2scm ("items-worth-living"), n);
  97 }
  98
  99 ADD_INTERFACE (Hara_kiri_group_spanner, "hara-kiri-group-interface",
 100                "A group spanner that  keeps track of interesting items.  If it "
 101                "doesn't contain any after linebreaking, then it "
 102                "will remove itself and all its children.",
 103                "items-worth-living remove-first");
 104