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