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--2006 Jan Nieuwenhuizen <janneke@gnu.org>
   7   Han-Wen Nienhuys <hanwen@xs4all.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 smob)
  22 {
  23   Grob *me = unsmob_grob (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   if (!to_boolean (me->get_property ("remove-empty")))
  33     return ;
  34
  35   extract_grob_set (me, "items-worth-living", worth);
  36   if (worth.size ())
  37     return;
  38
  39   bool remove_first = to_boolean (me->get_property ("remove-first"));
  40   if (!remove_first
  41        && ((sp->original () && broken_spanner_index (sp) == 0)
  42            || Paper_column::get_rank (sp->get_bound (LEFT)->get_column ())
  43            == 0))
  44     return;
  45
  46   vector<Grob*> childs;
  47   Axis_group_interface::get_children (me, &childs);
  48   for (vsize i = 0; i < childs.size (); i++)
  49     childs[i]->suicide ();
  50
  51   /*
  52     very appropriate name here :-)
  53   */
  54   me->suicide ();
  55 }
  56
  57 /*
  58   We can't rely on offsets and dimensions of elements in a hara-kiri
  59   group. Use a callback to make sure that hara-kiri has been done
  60   before asking for offsets.  */
  61 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, after_line_breaking, 1);
  62 SCM
  63 Hara_kiri_group_spanner::after_line_breaking (SCM smob)
  64 {
  65   Grob *me = unsmob_grob (smob);
  66   consider_suicide (me);
  67   return SCM_UNSPECIFIED;
  68 }
  69
  70 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, force_hara_kiri_callback, 1);
  71 SCM
  72 Hara_kiri_group_spanner::force_hara_kiri_callback (SCM smob)
  73 {
  74   Grob *me = unsmob_grob (smob);
  75   consider_suicide (me);
  76   return scm_from_double (0.0);
  77 }
  78
  79 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, force_hara_kiri_in_y_parent_callback, 1);
  80 SCM
  81 Hara_kiri_group_spanner::force_hara_kiri_in_y_parent_callback (SCM smob)
  82 {
  83   Grob *daughter = unsmob_grob (smob);
  84   force_hara_kiri_callback (daughter->get_parent (Y_AXIS)->self_scm ());
  85   return scm_from_double (0.0);
  86 }
  87
  88 void
  89 Hara_kiri_group_spanner::add_interesting_item (Grob *me, Grob *n)
  90 {
  91   Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("items-worth-living"), n);
  92 }
  93
  94 ADD_INTERFACE (Hara_kiri_group_spanner, "hara-kiri-group-interface",
  95                "A group spanner that  keeps track of interesting items.  If it "
  96                "doesn't contain any after linebreaking, then it "
  97                "will remove itself and all its children.",
  98
  99
 100                /* properties */
 101                "items-worth-living "
 102                "remove-empty "
 103                "remove-first "
 104                );
 105
 106