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