lily/align-interface.cc

   1 /*
   2   align-interface.cc -- implement Align_interface
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2000--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "align-interface.hh"
  10
  11 #include "spanner.hh"
  12 #include "item.hh"
  13 #include "axis-group-interface.hh"
  14 #include "pointer-group-interface.hh"
  15 #include "hara-kiri-group-spanner.hh"
  16 #include "grob-array.hh"
  17
  18 MAKE_SCHEME_CALLBACK (Align_interface, alignment_callback, 2);
  19 SCM
  20 Align_interface::alignment_callback (SCM element_smob, SCM axis)
  21 {
  22   Grob *me = unsmob_grob (element_smob);
  23   Axis ax = (Axis)scm_to_int (axis);
  24   Grob *par = me->get_parent (ax);
  25   if (par && !to_boolean (par->get_property ("positioning-done")))
  26     Align_interface::align_elements_to_extents (par, ax);
  27   return scm_from_double (0.0);
  28 }
  29
  30 MAKE_SCHEME_CALLBACK (Align_interface, fixed_distance_alignment_callback, 2);
  31 SCM
  32 Align_interface::fixed_distance_alignment_callback (SCM element_smob, SCM axis)
  33 {
  34   Grob *me = unsmob_grob (element_smob);
  35   Axis ax = (Axis)scm_to_int (axis);
  36   Grob *par = me->get_parent (ax);
  37   if (par && !to_boolean (par->get_property ("positioning-done")))
  38     Align_interface::align_to_fixed_distance (par, ax);
  39   return scm_from_double (0.0);
  40 }
  41
  42 /*
  43   merge with align-to-extents?
  44 */
  45 void
  46 Align_interface::align_to_fixed_distance (Grob *me, Axis a)
  47 {
  48   me->set_property ("positioning-done", SCM_BOOL_T);
  49
  50   SCM d = me->get_property ("stacking-dir");
  51
  52   Direction stacking_dir = scm_is_number (d) ? to_dir (d) : CENTER;
  53   if (!stacking_dir)
  54     stacking_dir = DOWN;
  55
  56   Real dy = robust_scm2double (me->get_property ("forced-distance"), 0.0);
  57
  58   extract_grob_set (me, "elements", elem_source);
  59
  60   Link_array<Grob> elems (elem_source); // writable..
  61
  62   Real where_f = 0;
  63
  64   Interval v;
  65   v.set_empty ();
  66   Array<Real> translates;
  67
  68   for (int j = elems.size (); j--;)
  69     {
  70       /*
  71         This is not very elegant, in that we need special support for
  72         hara-kiri. Unfortunately, the generic wiring of
  73         force_hara_kiri_callback () (extent and offset callback) is
  74         such that we might get into a loop if we call extent () or
  75         offset () the elements.
  76
  77
  78       */
  79       if (a == Y_AXIS
  80           && Hara_kiri_group_spanner::has_interface (elems[j]))
  81         Hara_kiri_group_spanner::consider_suicide (elems[j]);
  82
  83       if (!elems[j]->is_live ())
  84         elems.del (j);
  85     }
  86
  87   for (int j = 0; j < elems.size (); j++)
  88     {
  89       where_f += stacking_dir * dy;
  90       translates.push (where_f);
  91       v.unite (Interval (where_f, where_f));
  92     }
  93
  94   /*
  95     TODO: support self-alignment-{Y, X}
  96   */
  97   for (int i = 0; i < translates.size (); i++)
  98     elems[i]->translate_axis (translates[i] - v.center (), a);
  99 }
 100
 101 /*
 102   Hairy function to put elements where they should be. Can be tweaked
 103   from the outside by setting extra-space in its
 104   children
 105
 106   We assume that the children the refpoints of the children are still
 107   found at 0.0 -- we will fuck up with thresholds if children's
 108   extents are already moved to locations such as (-16, -8), since the
 109   dy needed to put things in a row doesn't relate to the distances
 110   between original refpoints.
 111
 112   TODO: maybe we should rethink and throw out thresholding altogether.
 113   The original function has been taken over by
 114   align_to_fixed_distance ().
 115 */
 116 void
 117 Align_interface::align_elements_to_extents (Grob *me, Axis a)
 118 {
 119   Spanner *me_spanner = dynamic_cast<Spanner *> (me);
 120   if (a == Y_AXIS
 121       && me_spanner
 122       && me_spanner->get_bound (LEFT)->break_status_dir () == CENTER)
 123     me_spanner->warning (_ ("vertical alignment called before line-breaking. Only do cross-staff spanners with PianoStaff."));
 124
 125   me->set_property ("positioning-done", SCM_BOOL_T);
 126
 127   SCM d = me->get_property ("stacking-dir");
 128
 129   Direction stacking_dir = scm_is_number (d) ? to_dir (d) : CENTER;
 130   if (!stacking_dir)
 131     stacking_dir = DOWN;
 132
 133   Interval threshold = robust_scm2interval (me->get_property ("threshold"),
 134                                             Interval (0, Interval::infinity ()));
 135
 136   Array<Interval> dims;
 137
 138   Link_array<Grob> elems;
 139
 140   extract_grob_set (me, "elements", all_grobs);
 141   for (int i = 0; i < all_grobs.size (); i++)
 142     {
 143       Interval y = all_grobs[i]->extent (me, a);
 144       if (!y.is_empty ())
 145         {
 146           Grob *e = dynamic_cast<Grob *> (all_grobs[i]);
 147
 148           elems.push (e);
 149           dims.push (y);
 150         }
 151     }
 152
 153   /*
 154     Read self-alignment-X and self-alignment-Y. This may seem like
 155     code duplication. (and really: it is), but this is necessary to
 156     prevent ugly cyclic dependencies that arise when you combine
 157     self-alignment on a child with alignment of children.
 158   */
 159   static SCM prop_syms[2];
 160
 161   if (!prop_syms[0])
 162     {
 163       prop_syms[X_AXIS] = ly_symbol2scm ("self-alignment-X");
 164       prop_syms[Y_AXIS] = ly_symbol2scm ("self-alignment-Y");
 165     }
 166
 167   SCM align (me->internal_get_property (prop_syms[a]));
 168
 169   Array<Real> translates;
 170   Interval total;
 171   Real where_f = 0;
 172
 173   for (int j = 0; j < elems.size (); j++)
 174     {
 175       Real dy = -dims[j][-stacking_dir];
 176       if (j)
 177         dy += dims[j - 1][stacking_dir];
 178
 179       /*
 180         we want dy to be > 0
 181       */
 182       dy *= stacking_dir;
 183       if (j)
 184         dy = min (max (dy, threshold[SMALLER]), threshold[BIGGER]);
 185
 186       where_f += stacking_dir * dy;
 187       total.unite (dims[j] + where_f);
 188       translates.push (where_f);
 189     }
 190
 191   Real center_offset = 0.0;
 192   /*
 193     also move the grobs that were empty, to maintain spatial order.
 194   */
 195   Array<Real> all_translates;
 196   if (translates.size ())
 197     {
 198       int i = 0;
 199       int j = 0;
 200       Real w = translates[0];
 201       while (j < all_grobs.size ())
 202         {
 203           if (i < elems.size () && all_grobs[j] == elems[i])
 204             w = translates[i++];
 205           all_translates.push (w);
 206           j++;
 207         }
 208
 209       /*
 210         FIXME: uncommenting freaks out the Y-alignment of
 211         line-of-score.
 212       */
 213       if (scm_is_number (align))
 214         center_offset = total.linear_combination (scm_to_double (align));
 215
 216       for (int j = 0; j < all_grobs.size (); j++)
 217         all_grobs[j]->translate_axis (all_translates[j] - center_offset, a);
 218     }
 219 }
 220 Axis
 221 Align_interface::axis (Grob *me)
 222 {
 223   return Axis (scm_to_int (scm_car (me->get_property ("axes"))));
 224 }
 225
 226 void
 227 Align_interface::add_element (Grob *me, Grob *element, SCM call_back)
 228 {
 229   element->add_offset_callback (call_back, Align_interface::axis (me));
 230   Axis_group_interface::add_element (me, element);
 231 }
 232
 233 void
 234 Align_interface::set_axis (Grob *me, Axis a)
 235 {
 236   Axis_group_interface::set_axes (me, a, a);
 237   SCM ga_scm = me->get_object ("elements");
 238   Grob_array *ga = unsmob_grob_array (ga_scm);
 239   if (!ga)
 240     {
 241       ga_scm = Grob_array::make_array ();
 242       ga = unsmob_grob_array (ga_scm);
 243       me->set_object ("elements", ga_scm);
 244     }
 245
 246   ga->set_ordered (true);
 247 }
 248
 249 /*
 250   Find Y-axis parent of G that has a #'forced-distance property. This
 251   has the effect of finding the piano-staff given an object in that
 252   piano staff.
 253 */
 254 Grob *
 255 find_fixed_alignment_parent (Grob *g)
 256 {
 257   while (g)
 258     {
 259       if (scm_is_number (g->get_property ("forced-distance")))
 260         return g;
 261
 262       g = g->get_parent (Y_AXIS);
 263     }
 264
 265   return 0;
 266 }
 267
 268 ADD_INTERFACE (Align_interface, "align-interface",
 269                "Order grobs from top to bottom, left to right, right to left or bottom"
 270                "to top.",
 271                "forced-distance stacking-dir align-dir threshold positioning-done "
 272                "elements axes");
 273
 274 struct Foobar
 275 {
 276   bool has_interface (Grob *);
 277 };
 278