lily/separation-item.cc

   1 /*
   2   separation-item.cc -- implement Separation_item
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "separation-item.hh"
  10
  11 #include "lookup.hh"
  12 #include "stencil.hh"
  13 #include "skyline.hh"
  14 #include "paper-column.hh"
  15 #include "warn.hh"
  16 #include "pointer-group-interface.hh"
  17 #include "accidental-placement.hh"
  18
  19 void
  20 Separation_item::add_item (Grob *s, Item *i)
  21 {
  22   assert (i);
  23   Pointer_group_interface::add_grob (s, ly_symbol2scm ("elements"), i);
  24 }
  25
  26 void
  27 Separation_item::add_conditional_item (Grob *me, Grob *e)
  28 {
  29   Pointer_group_interface::add_grob (me, ly_symbol2scm ("conditional-elements"), e);
  30 }
  31
  32 void
  33 Separation_item::set_skyline_distance (Drul_array<Item *> items,
  34                                        Real padding)
  35 {
  36   Drul_array<Skyline_pair*> lines (Skyline_pair::unsmob (items[LEFT]->get_property ("horizontal-skylines")),
  37                                    Skyline_pair::unsmob (items[RIGHT]->get_property ("horizontal-skylines")));
  38   Skyline right = conditional_skyline (items[RIGHT], items[LEFT]);
  39   right.merge ((*lines[RIGHT])[LEFT]);
  40
  41   Real dist = padding + (*lines[LEFT])[RIGHT].distance (right);
  42   if (dist > 0)
  43     {
  44       Rod rod;
  45
  46       rod.item_drul_ = items;
  47
  48       rod.distance_ = dist;
  49       rod.add_to_cols ();
  50     }
  51 }
  52
  53 bool
  54 Separation_item::set_distance (Drul_array<Item *> items,
  55                                Real padding)
  56 {
  57   set_skyline_distance (items, padding);
  58   return true;
  59 }
  60
  61 /*
  62   Return the width of ME given that we are considering the object on
  63   the LEFT.
  64 */
  65 Skyline
  66 Separation_item::conditional_skyline (Grob *me, Grob *left)
  67 {
  68   vector<Box> bs = boxes (me, left);
  69   return Skyline (bs, 0.1, Y_AXIS, LEFT);
  70 }
  71
  72
  73 MAKE_SCHEME_CALLBACK (Separation_item, calc_skylines,1);
  74 SCM
  75 Separation_item::calc_skylines (SCM smob)
  76 {
  77   Item *me = unsmob_item (smob);
  78   vector<Box> bs = boxes (me, 0);
  79   /* todo: the horizon_padding is somewhat arbitrary */
  80   return Skyline_pair (bs, 0.1, Y_AXIS).smobbed_copy ();
  81 }
  82
  83 /* if left is non-NULL, get the boxes corresponding to the
  84    conditional-elements (conditioned on the grob LEFT). This
  85    sounds more general than it is: conditional-elements are
  86    always accidentals attached to a tied note.
  87 */
  88 vector<Box>
  89 Separation_item::boxes (Grob *me, Grob *left)
  90 {
  91   Item *item = dynamic_cast<Item *> (me);
  92
  93   int very_large = INT_MAX;
  94   Paper_column *pc = item->get_column ();
  95   vector<Box> out;
  96   extract_grob_set (me, left ? "conditional-elements" : "elements", read_only_elts);
  97   vector<Grob*> elts;
  98
  99   if (left)
 100     elts = Accidental_placement::get_break_reminder_accidentals (read_only_elts, left);
 101   else
 102     elts = read_only_elts;
 103
 104   Grob *ycommon = common_refpoint_of_array (elts, me, Y_AXIS);
 105
 106   for (vsize i = 0; i < elts.size (); i++)
 107     {
 108       Item *il = dynamic_cast<Item *> (elts[i]);
 109       if (pc != il->get_column ())
 110         {
 111           continue;
 112         }
 113
 114       Interval y (il->pure_height (ycommon, 0, very_large));
 115       Interval x (il->extent (pc, X_AXIS));
 116
 117       Interval extra = robust_scm2interval (elts[i]->get_property ("extra-spacing-width"),
 118                                             Interval (0, 0));
 119       x[LEFT] += extra[LEFT];
 120       x[RIGHT] += extra[RIGHT];
 121       if (to_boolean (elts[i]->get_property ("infinite-spacing-height")))
 122         y = Interval (-infinity_f, infinity_f);
 123
 124       out.push_back (Box (x, y));
 125     }
 126
 127   return out;
 128 }
 129
 130 Interval
 131 Separation_item::width (Grob *me)
 132 {
 133   SCM sw = me->get_property ("X-extent");
 134   return ly_scm2interval (sw);
 135 }
 136
 137 Interval
 138 Separation_item::relative_width (Grob *me, Grob *common)
 139 {
 140   Interval iv = width (me);
 141
 142   return dynamic_cast<Item *> (me)->get_column ()->relative_coordinate (common, X_AXIS) + iv;
 143 }
 144
 145 /*
 146   Try to find the break-aligned symbol in SEPARATION_ITEM that is
 147   sticking out at direction D. The x size is put in LAST_EXT
 148 */
 149 Grob *
 150 Separation_item::extremal_break_aligned_grob (Grob *me,
 151                                               Direction d,
 152                                               Interval *last_ext)
 153 {
 154   Grob *col = dynamic_cast<Item *> (me)->get_column ();
 155   last_ext->set_empty ();
 156   Grob *last_grob = 0;
 157
 158   extract_grob_set (me, "elements", elts);
 159   for (vsize i = elts.size (); i--;)
 160     {
 161       Grob *break_item = elts[i];
 162       if (!scm_is_symbol (break_item->get_property ("break-align-symbol")))
 163         continue;
 164
 165       if (!scm_is_pair (break_item->get_property ("space-alist")))
 166         continue;
 167
 168       Interval ext = break_item->extent (col, X_AXIS);
 169
 170       if (ext.is_empty ())
 171         continue;
 172
 173       if (!last_grob
 174           || (last_grob && d * (ext[d]- (*last_ext)[d]) > 0))
 175         {
 176           *last_ext = ext;
 177           last_grob = break_item;
 178         }
 179     }
 180
 181   return last_grob;
 182 }
 183
 184 extern bool debug_skylines;
 185 MAKE_SCHEME_CALLBACK (Separation_item, print, 1)
 186 SCM
 187 Separation_item::print (SCM smob)
 188 {
 189   if (!debug_skylines)
 190     return SCM_BOOL_F;
 191
 192   Grob *me = unsmob_grob (smob);
 193   Stencil ret;
 194   if (Skyline_pair *s = Skyline_pair::unsmob (me->get_property ("horizontal-skylines")))
 195     {
 196       ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[LEFT].to_points (Y_AXIS)).in_color (255, 255, 0));
 197       ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[RIGHT].to_points (Y_AXIS)).in_color (0, 255, 255));
 198     }
 199   return ret.smobbed_copy ();
 200 }
 201
 202 ADD_INTERFACE (Separation_item,
 203                "Item that computes widths to generate spacing rods. "
 204                "This is done in concert with @ref{separating-group-spanner-interface}.",
 205
 206                "X-extent "
 207                "conditional-elements "
 208                "elements "
 209                "padding "
 210                "horizontal-skylines "
 211                );