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, 1);
  20 SCM
  21 Hara_kiri_group_spanner::y_extent (SCM element_smob)
  22 {
  23   Grob *me = unsmob_grob (element_smob);
  24   consider_suicide (me);
  25   return Axis_group_interface::generic_group_extent (me, Y_AXIS);
  26 }
  27
  28 void
  29 Hara_kiri_group_spanner::consider_suicide (Grob *me)
  30 {
  31   Spanner *sp = dynamic_cast<Spanner *> (me);
  32
  33   extract_grob_set (me, "items-worth-living", worth);
  34   if (worth.size ())
  35     return;
  36
  37   bool remove_first = to_boolean (me->get_property ("remove-first"));
  38   if (!remove_first
  39        && ((sp->original_ && broken_spanner_index (sp) == 0)
  40            || Paper_column::get_rank (sp->get_bound (LEFT)->get_column ())
  41            == 0))
  42     return;
  43
  44   Link_array<Grob> childs;
  45   Axis_group_interface::get_children (me, &childs);
  46   for (int i = 0; i < childs.size (); i++)
  47     childs[i]->suicide ();
  48
  49   /*
  50     very appropriate name here :-)
  51   */
  52   me->suicide ();
  53 }
  54
  55 /*
  56   We can't rely on offsets and dimensions of elements in a hara-kiri
  57   group. Use a callback to make sure that hara-kiri has been done
  58   before asking for offsets.  */
  59 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, force_hara_kiri_callback, 2);
  60 SCM
  61 Hara_kiri_group_spanner::force_hara_kiri_callback (SCM element_smob, SCM axis)
  62 {
  63   Grob *me = unsmob_grob (element_smob);
  64   (void) axis;
  65
  66   assert (scm_to_int (axis) == Y_AXIS);
  67   consider_suicide (me);
  68   return scm_from_double (0.0);
  69 }
  70
  71 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, force_hara_kiri_in_parent_callback, 2);
  72 SCM
  73 Hara_kiri_group_spanner::force_hara_kiri_in_parent_callback (SCM element_smob, SCM axis)
  74 {
  75   Grob *daughter = unsmob_grob (element_smob);
  76   Axis a = (Axis) scm_to_int (axis);
  77   assert (a == Y_AXIS);
  78   force_hara_kiri_callback (daughter->get_parent (a)->self_scm (), axis);
  79   return scm_from_double (0.0);
  80 }
  81
  82 void
  83 Hara_kiri_group_spanner::add_element (Grob *me, Grob *e)
  84 {
  85   //  e->add_offset_callback (force_hara_kiri_in_parent_callback, Y_AXIS);
  86   Axis_group_interface::add_element (me, e);
  87 }
  88
  89 void
  90 Hara_kiri_group_spanner::add_interesting_item (Grob *me, Grob *n)
  91 {
  92   Pointer_group_interface::add_grob (me, ly_symbol2scm ("items-worth-living"), n);
  93 }
  94
  95 ADD_INTERFACE (Hara_kiri_group_spanner, "hara-kiri-group-interface",
  96                "A group spanner that  keeps track of interesting items.  If it "
  97                "doesn't contain any after linebreaking, then it "
  98                "will remove itself and all its children.",
  99
 100
 101                /* properties */
 102                "items-worth-living "
 103                "remove-first");
 104