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   Skyline down_skyline (stacking_dir);
 212   for (vsize j = 0; j < elems.size (); j++)
 213     {
 214       Real dy = 0;
 215       if (j == 0)
 216         dy = skylines[j][-stacking_dir].max_height ();
 217       else
 218         {
 219           down_skyline.merge (skylines[j-1][stacking_dir]);
 220           dy = down_skyline.distance (skylines[j][-stacking_dir]);
 221         }
 222
 223       dy = max (0.0, dy + padding + extra_space / elems.size ());
 224       down_skyline.raise (-stacking_dir * dy);
 225       where += stacking_dir * dy;
 226       translates.push_back (where);
 227     }
 228
 229   SCM offsets_handle = scm_assq (ly_symbol2scm ("alignment-offsets"),
 230                                  line_break_details);
 231   if (scm_is_pair (offsets_handle))
 232     {
 233       vsize i = 0;
 234
 235       for (SCM s = scm_cdr (offsets_handle);
 236            scm_is_pair (s) && i < translates.size (); s = scm_cdr (s), i++)
 237         {
 238           if (scm_is_number (scm_car (s)))
 239             translates[i] = scm_to_double (scm_car (s));
 240         }
 241     }
 242
 243   vector<Real> all_translates;
 244
 245   if (!translates.empty ())
 246     {
 247       Real w = translates[0];
 248       for  (vsize i = 0, j = 0; j < all_grobs.size (); j++)
 249         {
 250           if (i < elems.size () && all_grobs[j] == elems[i])
 251             w = translates[i++];
 252           all_translates.push_back (w);
 253         }
 254     }
 255   return all_translates;
 256 }
 257
 258 void
 259 Align_interface::align_elements_to_extents (Grob *me, Axis a)
 260 {
 261   extract_grob_set (me, "elements", all_grobs);
 262
 263   vector<Real> translates = get_extents_aligned_translates (me, all_grobs, a, false, 0, 0);
 264   if (translates.size ())
 265     for (vsize j = 0; j < all_grobs.size (); j++)
 266       all_grobs[j]->translate_axis (translates[j], a);
 267 }
 268
 269 /* After we have already determined the y-offsets of our children, we may still
 270    want to stretch them a little. */
 271 void
 272 Align_interface::stretch (Grob *me, Real amount, Axis a)
 273 {
 274   extract_grob_set (me, "elements", elts);
 275   Real non_empty_elts = stretchable_children_count (me);
 276   Real offset = 0.0;
 277   Direction dir = robust_scm2dir (me->get_property ("stacking-dir"), DOWN);
 278   for (vsize i = 0; i < elts.size (); i++)
 279     {
 280       elts[i]->translate_axis (dir * offset, a);
 281       if (!elts[i]->extent (me, a).is_empty ()
 282           && !to_boolean (elts[i]->get_property ("keep-fixed-while-stretching")))
 283         offset += amount / non_empty_elts;
 284     }
 285   me->flush_extent_cache (Y_AXIS);
 286 }
 287
 288 Real
 289 Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end)
 290 {
 291   extract_grob_set (me, "elements", all_grobs);
 292   SCM dy_scm = me->get_property ("forced-distance");
 293
 294   if (scm_is_number (dy_scm))
 295     {
 296       Real dy = scm_to_double (dy_scm) * robust_scm2dir (me->get_property ("stacking-dir"), DOWN);
 297       Real pos = 0;
 298       for (vsize i = 0; i < all_grobs.size (); i++)
 299         {
 300           if (all_grobs[i] == ch)
 301             return pos;
 302           if (!Hara_kiri_group_spanner::has_interface (all_grobs[i])
 303               || !Hara_kiri_group_spanner::request_suicide (all_grobs[i], start, end))
 304             pos += dy;
 305         }
 306     }
 307   else
 308     {
 309       vector<Real> translates = get_extents_aligned_translates (me, all_grobs, Y_AXIS, true, start, end);
 310
 311       if (translates.size ())
 312         {
 313           for (vsize i = 0; i < all_grobs.size (); i++)
 314             if (all_grobs[i] == ch)
 315               return translates[i];
 316         }
 317       else
 318         return 0;
 319     }
 320
 321   programming_error (_ ("tried to get a translation for something that is no child of mine"));
 322   return 0;
 323 }
 324
 325 Axis
 326 Align_interface::axis (Grob *me)
 327 {
 328   return Axis (scm_to_int (scm_car (me->get_property ("axes"))));
 329 }
 330
 331 void
 332 Align_interface::add_element (Grob *me, Grob *element)
 333 {
 334   Axis a = Align_interface::axis (me);
 335   SCM sym = axis_offset_symbol (a);
 336   SCM proc = axis_parent_positioning (a);
 337
 338   element->set_property (sym, proc);
 339   Axis_group_interface::add_element (me, element);
 340 }
 341
 342 void
 343 Align_interface::set_ordered (Grob *me)
 344 {
 345   SCM ga_scm = me->get_object ("elements");
 346   Grob_array *ga = unsmob_grob_array (ga_scm);
 347   if (!ga)
 348     {
 349       ga_scm = Grob_array::make_array ();
 350       ga = unsmob_grob_array (ga_scm);
 351       me->set_object ("elements", ga_scm);
 352     }
 353
 354   ga->set_ordered (true);
 355 }
 356
 357 int
 358 Align_interface::stretchable_children_count (Grob const *me)
 359 {
 360   extract_grob_set (me, "elements", elts);
 361   int ret = 0;
 362
 363   /* start at 1: we will never move the first child while stretching */
 364   for (vsize i = 1; i < elts.size (); i++)
 365     if (!to_boolean (elts[i]->get_property ("keep-fixed-while-stretching"))
 366         && !elts[i]->extent (elts[i], Y_AXIS).is_empty ())
 367       ret++;
 368
 369   return ret;
 370 }
 371
 372 MAKE_SCHEME_CALLBACK (Align_interface, calc_max_stretch, 1)
 373 SCM
 374 Align_interface::calc_max_stretch (SCM smob)
 375 {
 376   Grob *me = unsmob_grob (smob);
 377   Spanner *spanner_me = dynamic_cast<Spanner*> (me);
 378   Real ret = 0;
 379
 380   if (spanner_me && stretchable_children_count (me) > 0)
 381     {
 382       Paper_column *left = dynamic_cast<Paper_column*> (spanner_me->get_bound (LEFT));
 383       Real height = me->extent (me, Y_AXIS).length ();
 384       SCM line_break_details = left->get_property ("line-break-system-details");
 385       SCM fixed_offsets = scm_assq (ly_symbol2scm ("alignment-offsets"),
 386                                     line_break_details);
 387
 388       /* if there are fixed offsets, we refuse to stretch */
 389       if (fixed_offsets != SCM_BOOL_F)
 390         ret = 0;
 391       else
 392         ret = height * height / 80.0; /* why this, exactly? -- jneem */
 393     }
 394   return scm_from_double (ret);
 395 }
 396
 397 /*
 398   Find Y-axis parent of G that has a #'forced-distance property. This
 399   has the effect of finding the piano-staff given an object in that
 400   piano staff.
 401
 402   FIXME: piano staves no longer have forced-distance. The code that
 403   relies on this function (in line-spanner) is broken.
 404 */
 405 Grob *
 406 find_fixed_alignment_parent (Grob *g)
 407 {
 408   (void) g;
 409   programming_error ("deprecated. We don't use forced-distance anymore");
 410   return 0;
 411 }
 412
 413 ADD_INTERFACE (Align_interface,
 414
 415                "Order grobs from top to bottom, left to right, right to left or bottom "
 416                "to top.  "
 417                "For vertical alignments of staves, the @code{break-system-details} of "
 418                "the left @internalsref{NonMusicalPaperColumn} may be set to tune vertical spacing "
 419                "Set @code{alignment-extra-space} to add extra space for staves. Set "
 420                "@code{fixed-alignment-extra-space} to force staves in PianoStaves further apart."
 421                ,
 422
 423                /*
 424                  properties
 425                 */
 426                "align-dir "
 427                "axes "
 428                "elements "
 429                "padding "
 430                "positioning-done "
 431                "stacking-dir "
 432                "threshold "
 433                );