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--2007 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 #include "paper-column.hh"
  20
  21 /*
  22   TODO: for vertical spacing, should also include a rod & spring
  23   scheme of sorts into this: the alignment should default to a certain
  24   distance between element refpoints, unless bbox force a bigger
  25   distance.
  26  */
  27
  28 MAKE_SCHEME_CALLBACK (Align_interface, calc_positioning_done, 1);
  29 SCM
  30 Align_interface::calc_positioning_done (SCM smob)
  31 {
  32   Grob *me = unsmob_grob (smob);
  33
  34   me->set_property ("positioning-done", SCM_BOOL_T);
  35
  36   SCM axis = scm_car (me->get_property ("axes"));
  37   Axis ax = Axis (scm_to_int (axis));
  38
  39   Align_interface::align_elements_to_extents (me, ax);
  40
  41   return SCM_BOOL_T;
  42 }
  43
  44 /*
  45   TODO: This belongs to the old two-pass spacing. Delete me.
  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 /* for each grob, find its upper and lower skylines. If the grob has
  83    an empty extent, delete it from the list instead. If the extent is
  84    non-empty but there is no skyline available (or pure is true), just
  85    create a flat skyline from the bounding box */
  86 static void
  87 get_skylines (Grob *me,
  88               vector<Grob*> *const elements,
  89               Axis a,
  90               bool pure, int start, int end,
  91               vector<Skyline_pair> *const ret)
  92 {
  93   /* each child's skyline was calculated according to the common refpoint of its
  94      elements. Here we need all the skylines to be positioned with respect to
  95      a single refpoint, so we need the common refpoint of the common refpoints
  96      of the elements of the children */
  97   vector<Grob*> child_refpoints;
  98   for (vsize i = 0; i < elements->size (); i++)
  99     {
 100       Grob *elt = (*elements)[i];
 101       Grob *child_common = unsmob_grob ((a == Y_AXIS)
 102                                         ? elt->get_object ("X-common")
 103                                         : elt->get_object ("Y-common"));
 104
 105       if (!child_common)
 106         {
 107           extract_grob_set (elt, "elements", child_elts);
 108           child_common = common_refpoint_of_array (child_elts, elt, other_axis (a));
 109         }
 110
 111       child_refpoints.push_back (child_common);
 112     }
 113
 114   Grob *other_common = common_refpoint_of_array (child_refpoints, me, other_axis (a));
 115
 116   for (vsize i = elements->size (); i--;)
 117     {
 118       Grob *g = (*elements)[i];
 119       Skyline_pair skylines;
 120
 121       /* each skyline is calculated relative to (potentially) a different other_axis
 122          coordinate. In order to compare the skylines effectively, we need to shift them
 123          to some absolute reference point */
 124       if (!pure)
 125         {
 126           Skyline_pair *skys = Skyline_pair::unsmob (g->get_property (a == Y_AXIS
 127                                                                       ? "vertical-skylines"
 128                                                                       : "horizontal-skylines"));
 129           if (skys)
 130             skylines = *skys;
 131
 132           /* this is perhaps an abuse of minimum-?-extent: maybe we should create
 133              another property? But it seems that the only (current) use of
 134              minimum-Y-extent is to separate vertically-aligned elements */
 135           SCM min_extent = g->get_property (a == X_AXIS
 136                                             ? ly_symbol2scm ("minimum-X-extent")
 137                                             : ly_symbol2scm ("minimum-Y-extent"));
 138
 139           if (is_number_pair (min_extent))
 140             {
 141               Box b;
 142               Interval other_extent = g->extent (other_common, other_axis (a));
 143               b[a] = ly_scm2interval (min_extent);
 144               b[other_axis (a)] = other_extent;
 145               if (!other_extent.is_empty ())
 146                 skylines.insert (b, 0, other_axis (a));
 147             }
 148
 149           Real offset = child_refpoints[i]->relative_coordinate (other_common, other_axis (a));
 150           skylines.shift (offset);
 151         }
 152       else
 153         {
 154           assert (a == Y_AXIS);
 155           Interval extent = g->pure_height (g, start, end);
 156           if (!extent.is_empty ())
 157             {
 158               Box b;
 159               b[a] = extent;
 160               b[other_axis (a)] = Interval (-infinity_f, infinity_f);
 161               skylines.insert (b, 0, other_axis (a));
 162             }
 163         }
 164
 165       if (skylines.is_empty ())
 166         elements->erase (elements->begin () + i);
 167       else
 168         ret->push_back (skylines);
 169     }
 170   reverse (*ret);
 171 }
 172
 173 vector<Real>
 174 Align_interface::get_extents_aligned_translates (Grob *me,
 175                                                  vector<Grob*> const &all_grobs,
 176                                                  Axis a,
 177                                                  bool pure, int start, int end)
 178 {
 179   Spanner *me_spanner = dynamic_cast<Spanner *> (me);
 180
 181
 182   SCM line_break_details = SCM_EOL;
 183   if (a == Y_AXIS && me_spanner)
 184     {
 185       if (pure)
 186         line_break_details = get_root_system (me)->column (start)->get_property ("line-break-system-details");
 187       else
 188         line_break_details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details");
 189
 190       if (!me->get_system () && !pure)
 191         me->warning (_ ("vertical alignment called before line-breaking.\n"
 192                         "Only do cross-staff spanners with PianoStaff."));
 193
 194     }
 195
 196   Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
 197                                            DOWN);
 198
 199   vector<Grob*> elems (all_grobs); // writable copy
 200   vector<Skyline_pair> skylines;
 201
 202   get_skylines (me, &elems, a, pure, start, end, &skylines);
 203
 204   Real where = 0;
 205   /* TODO: extra-space stuff belongs to two-pass spacing. Delete me */
 206   SCM extra_space_handle = scm_assq (ly_symbol2scm ("alignment-extra-space"), line_break_details);
 207   Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle)
 208                                         ? scm_cdr (extra_space_handle)
 209                                         : SCM_EOL,
 210                                         0.0);
 211
 212   Real padding = robust_scm2double (me->get_property ("padding"), 0.0);
 213   vector<Real> translates;
 214   Skyline down_skyline (stacking_dir);
 215   for (vsize j = 0; j < elems.size (); j++)
 216     {
 217       Real dy = 0;
 218       if (j == 0)
 219         dy = skylines[j][-stacking_dir].max_height ();
 220       else
 221         {
 222           down_skyline.merge (skylines[j-1][stacking_dir]);
 223           dy = down_skyline.distance (skylines[j][-stacking_dir]);
 224         }
 225
 226       dy = max (0.0, dy + padding + extra_space / elems.size ());
 227       down_skyline.raise (-stacking_dir * dy);
 228       where += stacking_dir * dy;
 229       translates.push_back (where);
 230     }
 231
 232   SCM offsets_handle = scm_assq (ly_symbol2scm ("alignment-offsets"),
 233                                  line_break_details);
 234   if (scm_is_pair (offsets_handle))
 235     {
 236       vsize i = 0;
 237
 238       for (SCM s = scm_cdr (offsets_handle);
 239            scm_is_pair (s) && i < translates.size (); s = scm_cdr (s), i++)
 240         {
 241           if (scm_is_number (scm_car (s)))
 242             translates[i] = scm_to_double (scm_car (s));
 243         }
 244     }
 245
 246   vector<Real> all_translates;
 247
 248   if (!translates.empty ())
 249     {
 250       Real w = translates[0];
 251       for  (vsize i = 0, j = 0; j < all_grobs.size (); j++)
 252         {
 253           if (i < elems.size () && all_grobs[j] == elems[i])
 254             w = translates[i++];
 255           all_translates.push_back (w);
 256         }
 257     }
 258   return all_translates;
 259 }
 260
 261 void
 262 Align_interface::align_elements_to_extents (Grob *me, Axis a)
 263 {
 264   extract_grob_set (me, "elements", all_grobs);
 265
 266   vector<Real> translates = get_extents_aligned_translates (me, all_grobs, a, false, 0, 0);
 267   if (translates.size ())
 268     for (vsize j = 0; j < all_grobs.size (); j++)
 269       all_grobs[j]->translate_axis (translates[j], a);
 270 }
 271
 272 /* After we have already determined the y-offsets of our children, we may still
 273    want to stretch them a little. */
 274 void
 275 Align_interface::stretch (Grob *me, Real amount, Axis a)
 276 {
 277   extract_grob_set (me, "elements", elts);
 278   Real non_empty_elts = stretchable_children_count (me);
 279   Real offset = 0.0;
 280   Direction dir = robust_scm2dir (me->get_property ("stacking-dir"), DOWN);
 281   for (vsize i = 1; i < elts.size (); i++)
 282     {
 283       if (!elts[i]->extent (me, a).is_empty ()
 284           && !to_boolean (elts[i]->get_property ("keep-fixed-while-stretching")))
 285         offset += amount / non_empty_elts;
 286       elts[i]->translate_axis (dir * offset, a);
 287     }
 288   me->flush_extent_cache (Y_AXIS);
 289 }
 290
 291 Real
 292 Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end)
 293 {
 294   extract_grob_set (me, "elements", all_grobs);
 295   SCM dy_scm = me->get_property ("forced-distance");
 296
 297   if (scm_is_number (dy_scm))
 298     {
 299       Real dy = scm_to_double (dy_scm) * robust_scm2dir (me->get_property ("stacking-dir"), DOWN);
 300       Real pos = 0;
 301       for (vsize i = 0; i < all_grobs.size (); i++)
 302         {
 303           if (all_grobs[i] == ch)
 304             return pos;
 305           if (!Hara_kiri_group_spanner::has_interface (all_grobs[i])
 306               || !Hara_kiri_group_spanner::request_suicide (all_grobs[i], start, end))
 307             pos += dy;
 308         }
 309     }
 310   else
 311     {
 312       vector<Real> translates = get_extents_aligned_translates (me, all_grobs, Y_AXIS, true, start, end);
 313
 314       if (translates.size ())
 315         {
 316           for (vsize i = 0; i < all_grobs.size (); i++)
 317             if (all_grobs[i] == ch)
 318               return translates[i];
 319         }
 320       else
 321         return 0;
 322     }
 323
 324   programming_error (_ ("tried to get a translation for something that is no child of mine"));
 325   return 0;
 326 }
 327
 328 Axis
 329 Align_interface::axis (Grob *me)
 330 {
 331   return Axis (scm_to_int (scm_car (me->get_property ("axes"))));
 332 }
 333
 334 void
 335 Align_interface::add_element (Grob *me, Grob *element)
 336 {
 337   Axis a = Align_interface::axis (me);
 338   SCM sym = axis_offset_symbol (a);
 339   SCM proc = axis_parent_positioning (a);
 340
 341   element->set_property (sym, proc);
 342   Axis_group_interface::add_element (me, element);
 343 }
 344
 345 void
 346 Align_interface::set_ordered (Grob *me)
 347 {
 348   SCM ga_scm = me->get_object ("elements");
 349   Grob_array *ga = unsmob_grob_array (ga_scm);
 350   if (!ga)
 351     {
 352       ga_scm = Grob_array::make_array ();
 353       ga = unsmob_grob_array (ga_scm);
 354       me->set_object ("elements", ga_scm);
 355     }
 356
 357   ga->set_ordered (true);
 358 }
 359
 360 int
 361 Align_interface::stretchable_children_count (Grob const *me)
 362 {
 363   extract_grob_set (me, "elements", elts);
 364   int ret = 0;
 365
 366   /* start at 1: we will never move the first child while stretching */
 367   for (vsize i = 1; i < elts.size (); i++)
 368     if (!to_boolean (elts[i]->get_property ("keep-fixed-while-stretching"))
 369         && !elts[i]->extent (elts[i], Y_AXIS).is_empty ())
 370       ret++;
 371
 372   return ret;
 373 }
 374
 375 MAKE_SCHEME_CALLBACK (Align_interface, calc_max_stretch, 1)
 376 SCM
 377 Align_interface::calc_max_stretch (SCM smob)
 378 {
 379   Grob *me = unsmob_grob (smob);
 380   Spanner *spanner_me = dynamic_cast<Spanner*> (me);
 381   Real ret = 0;
 382
 383   if (spanner_me && stretchable_children_count (me) > 0)
 384     {
 385       Paper_column *left = dynamic_cast<Paper_column*> (spanner_me->get_bound (LEFT));
 386       Real height = me->extent (me, Y_AXIS).length ();
 387       SCM line_break_details = left->get_property ("line-break-system-details");
 388       SCM fixed_offsets = scm_assq (ly_symbol2scm ("alignment-offsets"),
 389                                     line_break_details);
 390
 391       /* if there are fixed offsets, we refuse to stretch */
 392       if (fixed_offsets != SCM_BOOL_F)
 393         ret = 0;
 394       else
 395         ret = height * height / 80.0; /* why this, exactly? -- jneem */
 396     }
 397   return scm_from_double (ret);
 398 }
 399
 400 ADD_INTERFACE (Align_interface,
 401
 402                "Order grobs from top to bottom, left to right, right to left or bottom "
 403                "to top.  "
 404                "For vertical alignments of staves, the @code{break-system-details} of "
 405                "the left @internalsref{NonMusicalPaperColumn} may be set to tune vertical spacing "
 406                "Set @code{alignment-extra-space} to add extra space for staves. Set "
 407                "@code{fixed-alignment-extra-space} to force staves in PianoStaves further apart."
 408                ,
 409
 410                /*
 411                  properties
 412                 */
 413                "align-dir "
 414                "axes "
 415                "elements "
 416                "padding "
 417                "positioning-done "
 418                "stacking-dir "
 419                "threshold "
 420                );