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--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "align-interface.hh"
  10 #include "spanner.hh"
  11 #include "item.hh"
  12 #include "axis-group-interface.hh"
  13 #include "pointer-group-interface.hh"
  14 #include "hara-kiri-group-spanner.hh"
  15 #include "grob-array.hh"
  16 #include "international.hh"
  17 #include "system.hh"
  18 #include "warn.hh"
  19
  20 /*
  21   TODO: for vertical spacing, should also include a rod & spring
  22   scheme of sorts into this: the alignment should default to a certain
  23   distance between element refpoints, unless bbox force a bigger
  24   distance.
  25  */
  26
  27 MAKE_SCHEME_CALLBACK (Align_interface, calc_positioning_done, 1);
  28 SCM
  29 Align_interface::calc_positioning_done (SCM smob)
  30 {
  31   Grob *me = unsmob_grob (smob);
  32   SCM axis = scm_car (me->get_property ("axes"));
  33   Axis ax = Axis (scm_to_int (axis));
  34
  35   SCM force = me->get_property ("forced-distance");
  36   if (scm_is_number (force))
  37     Align_interface::align_to_fixed_distance (me, ax);
  38   else
  39     Align_interface::align_elements_to_extents (me, ax);
  40
  41   return SCM_BOOL_T;
  42 }
  43
  44 /*
  45   merge with align-to-extents?
  46 */
  47 MAKE_SCHEME_CALLBACK(Align_interface, stretch_after_break, 1)
  48 SCM
  49 Align_interface::stretch_after_break (SCM grob)
  50 {
  51   Grob *me = unsmob_grob (grob);
  52
  53   Spanner *me_spanner = dynamic_cast<Spanner *> (me);
  54   extract_grob_set (me, "elements", elems);
  55
  56   if (me_spanner && elems.size ())
  57     {
  58       Grob *common = common_refpoint_of_array (elems, me, Y_AXIS);
  59
  60       /* force position callbacks */
  61       for (vsize i = 0; i < elems.size (); i++)
  62         elems[i]->relative_coordinate (common, Y_AXIS);
  63
  64       SCM details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details");
  65       SCM extra_space_handle = scm_assoc (ly_symbol2scm ("fixed-alignment-extra-space"), details);
  66
  67       Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle)
  68                                             ? scm_cdr (extra_space_handle)
  69                                             : SCM_EOL,
  70                                             0.0);
  71
  72       Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
  73                                                DOWN);
  74       Real delta  = extra_space / elems.size() * stacking_dir;
  75       for (vsize i = 0; i < elems.size (); i++)
  76         elems[i]->translate_axis (i * delta, Y_AXIS);
  77     }
  78
  79   return SCM_UNSPECIFIED;
  80 }
  81
  82 /*
  83   merge with align-to-extents?
  84 */
  85 void
  86 Align_interface::align_to_fixed_distance (Grob *me, Axis a)
  87 {
  88   Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
  89                                            DOWN);
  90
  91   Real dy = robust_scm2double (me->get_property ("forced-distance"), 0.0);
  92
  93   extract_grob_set (me, "elements", elem_source);
  94
  95   vector<Grob*> elems (elem_source); // writable..
  96
  97   Real where = 0;
  98
  99   Interval v;
 100   v.set_empty ();
 101   vector<Real> translates;
 102
 103   for (vsize j = elems.size (); j--;)
 104     {
 105       /*
 106         This is not very elegant, in that we need special support for
 107         hara-kiri. Unfortunately, the generic wiring of
 108         force_hara_kiri_callback () (extent and offset callback) is
 109         such that we might get into a loop if we call extent () or
 110         offset () the elements.
 111       */
 112       if (a == Y_AXIS
 113           && Hara_kiri_group_spanner::has_interface (elems[j]))
 114         Hara_kiri_group_spanner::consider_suicide (elems[j]);
 115
 116       if (!elems[j]->is_live ())
 117         elems.erase (elems.begin () + j);
 118     }
 119
 120   for (vsize j = 0; j < elems.size (); j++)
 121     {
 122       where += stacking_dir * dy;
 123       translates.push_back (where);
 124       v.unite (Interval (where, where));
 125     }
 126
 127   for (vsize i = 0; i < translates.size (); i++)
 128     elems[i]->translate_axis (translates[i] - v.center (), a);
 129 }
 130
 131 /* for each grob, find its upper and lower skylines. If the grob has
 132    an empty extent, delete it from the list instead. If the extent is
 133    non-empty but there is no skyline available (or pure is true), just
 134    create a flat skyline from the bounding box */
 135 static void
 136 get_skylines (Grob *me,
 137               vector<Grob*> *const elements,
 138               Axis a,
 139               bool pure, int start, int end,
 140               vector<Skyline_pair> *const ret)
 141 {
 142   /* each child's skyline was calculated according to the common refpoint of its
 143      elements. Here we need all the skylines to be positioned with respect to
 144      a single refpoint, so we need the common refpoint of the common refpoints
 145      of the elements of the children */
 146   vector<Grob*> child_refpoints;
 147   for (vsize i = 0; i < elements->size (); i++)
 148     {
 149       extract_grob_set ((*elements)[i], "elements", child_elts);
 150       Grob *child_common = common_refpoint_of_array (child_elts, (*elements)[i], other_axis (a));
 151       child_refpoints.push_back (child_common);
 152     }
 153   Grob *common_refpoint = common_refpoint_of_array (child_refpoints, me, other_axis (a));
 154
 155   for (vsize i = elements->size (); i--;)
 156     {
 157       Grob *g = (*elements)[i];
 158       Interval extent = g->maybe_pure_extent (g, a, pure, start, end);
 159       Interval other_extent = pure ? Interval (-infinity_f, infinity_f)
 160         : g->extent (common_refpoint, other_axis (a));
 161       Box b;
 162       b[a] = extent;
 163       b[other_axis (a)] = other_extent;
 164
 165       if (extent.is_empty ())
 166         {
 167           elements->erase (elements->begin () + i);
 168           continue;
 169         }
 170
 171       Skyline_pair skylines;
 172       if (!pure
 173           && Skyline_pair::unsmob (g->get_property ("skylines")))
 174         skylines = *Skyline_pair::unsmob (g->get_property ("skylines"));
 175       else
 176         {
 177           if (!pure)
 178             programming_error ("no skylines for alignment-child\n");
 179
 180           skylines = Skyline_pair (b, 0, other_axis (a));
 181         }
 182
 183       /* each skyline is calculated relative to (potentially) a different other_axis
 184          coordinate. In order to compare the skylines effectively, we need to shift them
 185          to some absolute reference point */
 186       if (!pure)
 187         {
 188           /* this is perhaps an abuse of minimum-?-extent: maybe we should create
 189              another property? But it seems that the only (current) use of
 190              minimum-Y-extent is to separate vertically-aligned elements */
 191           SCM min_extent = g->get_property (a == X_AXIS ? "minimum-X-extent" : "minimum-Y-extent");
 192           if (is_number_pair (min_extent))
 193             {
 194               b[a] = ly_scm2interval (min_extent);
 195               skylines.insert (b, 0, other_axis (a));
 196             }
 197
 198           Real offset = child_refpoints[i]->relative_coordinate (common_refpoint, other_axis (a));
 199           skylines.shift (offset);
 200         }
 201
 202
 203       ret->push_back (skylines);
 204     }
 205   reverse (*ret);
 206 }
 207
 208 vector<Real>
 209 Align_interface::get_extents_aligned_translates (Grob *me,
 210                                                  vector<Grob*> const &all_grobs,
 211                                                  Axis a,
 212                                                  bool pure, int start, int end)
 213 {
 214   Spanner *me_spanner = dynamic_cast<Spanner *> (me);
 215
 216
 217   SCM line_break_details = SCM_EOL;
 218   if (a == Y_AXIS && me_spanner)
 219     {
 220       if (pure)
 221         line_break_details = get_root_system (me)->column (start)->get_property ("line-break-system-details");
 222       else
 223         line_break_details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details");
 224
 225       if (!me->get_system () && !pure)
 226         me->warning (_ ("vertical alignment called before line-breaking.\n"
 227                         "Only do cross-staff spanners with PianoStaff."));
 228
 229     }
 230
 231   Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
 232                                            DOWN);
 233
 234   vector<Grob*> elems (all_grobs); // writable copy
 235   vector<Skyline_pair> skylines;
 236
 237   get_skylines (me, &elems, a, pure, start, end, &skylines);
 238
 239   Real where = 0;
 240   SCM extra_space_handle = scm_assq (ly_symbol2scm ("alignment-extra-space"), line_break_details);
 241   Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle)
 242                                         ? scm_cdr (extra_space_handle)
 243                                         : SCM_EOL,
 244                                         0.0);
 245
 246   Real padding = robust_scm2double (me->get_property ("padding"), 0.0);
 247   vector<Real> translates;
 248   for (vsize j = 0; j < elems.size (); j++)
 249     {
 250       Real dy = 0;
 251       if (j == 0)
 252         dy = skylines[j][-stacking_dir].max_height ();
 253       else
 254         dy = skylines[j-1][stacking_dir].distance (skylines[j][-stacking_dir]);
 255
 256       where += stacking_dir * max (0.0, dy + padding + extra_space / elems.size ());
 257       translates.push_back (where);
 258     }
 259
 260   SCM offsets_handle = scm_assq (ly_symbol2scm ("alignment-offsets"),
 261                                  line_break_details);
 262   if (scm_is_pair (offsets_handle))
 263     {
 264       vsize i = 0;
 265
 266       for (SCM s = scm_cdr (offsets_handle);
 267            scm_is_pair (s) && i < translates.size (); s = scm_cdr (s), i++)
 268         {
 269           if (scm_is_number (scm_car (s)))
 270             translates[i] = scm_to_double (scm_car (s));
 271         }
 272     }
 273
 274   vector<Real> all_translates;
 275
 276   if (!translates.empty ())
 277     {
 278       Real w = translates[0];
 279       for  (vsize i = 0, j = 0; j < all_grobs.size (); j++)
 280         {
 281           if (i < elems.size () && all_grobs[j] == elems[i])
 282             w = translates[i++];
 283           all_translates.push_back (w);
 284         }
 285     }
 286   return all_translates;
 287 }
 288
 289 void
 290 Align_interface::align_elements_to_extents (Grob *me, Axis a)
 291 {
 292   extract_grob_set (me, "elements", all_grobs);
 293
 294   vector<Real> translates = get_extents_aligned_translates (me, all_grobs, a, false, 0, 0);
 295   if (translates.size ())
 296     for (vsize j = 0; j < all_grobs.size (); j++)
 297       all_grobs[j]->translate_axis (translates[j], a);
 298 }
 299
 300 Real
 301 Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end)
 302 {
 303   extract_grob_set (me, "elements", all_grobs);
 304   SCM dy_scm = me->get_property ("forced-distance");
 305
 306   if (scm_is_number (dy_scm))
 307     {
 308       Real dy = scm_to_double (dy_scm) * robust_scm2dir (me->get_property ("stacking-dir"), DOWN);
 309       Real pos = 0;
 310       for (vsize i = 0; i < all_grobs.size (); i++)
 311         {
 312           if (all_grobs[i] == ch)
 313             return pos;
 314           if (!Hara_kiri_group_spanner::has_interface (all_grobs[i])
 315               || !Hara_kiri_group_spanner::request_suicide (all_grobs[i], start, end))
 316             pos += dy;
 317         }
 318     }
 319   else
 320     {
 321       vector<Real> translates = get_extents_aligned_translates (me, all_grobs, Y_AXIS, true, start, end);
 322
 323       if (translates.size ())
 324         {
 325           for (vsize i = 0; i < all_grobs.size (); i++)
 326             if (all_grobs[i] == ch)
 327               return translates[i];
 328         }
 329       else
 330         return 0;
 331     }
 332
 333   programming_error (_ ("tried to get a translation for something that is no child of mine"));
 334   return 0;
 335 }
 336
 337 Axis
 338 Align_interface::axis (Grob *me)
 339 {
 340   return Axis (scm_to_int (scm_car (me->get_property ("axes"))));
 341 }
 342
 343 void
 344 Align_interface::add_element (Grob *me, Grob *element)
 345 {
 346   Axis a = Align_interface::axis (me);
 347   SCM sym = axis_offset_symbol (a);
 348   SCM proc = axis_parent_positioning (a);
 349
 350   element->set_property (sym, proc);
 351   Axis_group_interface::add_element (me, element);
 352 }
 353
 354 void
 355 Align_interface::set_ordered (Grob *me)
 356 {
 357   SCM ga_scm = me->get_object ("elements");
 358   Grob_array *ga = unsmob_grob_array (ga_scm);
 359   if (!ga)
 360     {
 361       ga_scm = Grob_array::make_array ();
 362       ga = unsmob_grob_array (ga_scm);
 363       me->set_object ("elements", ga_scm);
 364     }
 365
 366   ga->set_ordered (true);
 367 }
 368
 369 /*
 370   Find Y-axis parent of G that has a #'forced-distance property. This
 371   has the effect of finding the piano-staff given an object in that
 372   piano staff.
 373 */
 374 Grob *
 375 find_fixed_alignment_parent (Grob *g)
 376 {
 377   while (g)
 378     {
 379       if (scm_is_number (g->get_property ("forced-distance")))
 380         return g;
 381
 382       g = g->get_parent (Y_AXIS);
 383     }
 384
 385   return 0;
 386 }
 387
 388 ADD_INTERFACE (Align_interface,
 389
 390                "Order grobs from top to bottom, left to right, right to left or bottom "
 391                "to top.  "
 392                "For vertical alignments of staves, the @code{break-system-details} of "
 393                "the left @internalsref{NonMusicalPaperColumn} may be set to tune vertical spacing "
 394                "Set @code{alignment-extra-space} to add extra space for staves. Set "
 395                "@code{fixed-alignment-extra-space} to force staves in PianoStaves further apart."
 396                ,
 397
 398                /*
 399                  properties
 400                 */
 401                "align-dir "
 402                "axes "
 403                "elements "
 404                "forced-distance "
 405                "padding "
 406                "positioning-done "
 407                "stacking-dir "
 408                "threshold "
 409                );