lily/axis-group-interface.cc

   1 /*
   2   axis-group-interface.cc -- implement Axis_group_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 "axis-group-interface.hh"
  10
  11 #include "align-interface.hh"
  12 #include "directional-element-interface.hh"
  13 #include "pointer-group-interface.hh"
  14 #include "grob-array.hh"
  15 #include "hara-kiri-group-spanner.hh"
  16 #include "international.hh"
  17 #include "paper-column.hh"
  18 #include "paper-score.hh"
  19 #include "system.hh"
  20 #include "warn.hh"
  21
  22 void
  23 Axis_group_interface::add_element (Grob *me, Grob *e)
  24 {
  25   SCM axes = me->get_property ("axes");
  26   if (!scm_is_pair (axes))
  27     programming_error ("axes should be nonempty");
  28
  29   for (SCM ax = axes; scm_is_pair (ax); ax = scm_cdr (ax))
  30     {
  31       Axis a = (Axis) scm_to_int (scm_car (ax));
  32
  33       if (!e->get_parent (a))
  34         e->set_parent (me, a);
  35
  36       e->set_object ((a == X_AXIS)
  37                      ? ly_symbol2scm ("axis-group-parent-X")
  38                      : ly_symbol2scm ("axis-group-parent-Y"),
  39                      me->self_scm ());
  40     }
  41
  42   /* must be ordered, because Align_interface also uses
  43      Axis_group_interface  */
  44   Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), e);
  45 }
  46
  47 bool
  48 Axis_group_interface::has_axis (Grob *me, Axis a)
  49 {
  50   SCM axes = me->get_property ("axes");
  51
  52   return (SCM_BOOL_F != scm_memq (scm_from_int (a), axes));
  53 }
  54
  55 Interval
  56 Axis_group_interface::relative_group_extent (vector<Grob*> const &elts,
  57                                              Grob *common, Axis a)
  58 {
  59   Interval r;
  60   for (vsize i = 0; i < elts.size (); i++)
  61     {
  62       Grob *se = elts[i];
  63       Interval dims = se->extent (common, a);
  64       if (!dims.is_empty ())
  65         r.unite (dims);
  66     }
  67   return r;
  68 }
  69
  70 Interval
  71 Axis_group_interface::cached_pure_height (Grob *me,
  72                                           vector<Grob*> const &elts,
  73                                           Grob *common,
  74                                           int start, int end)
  75 {
  76   Paper_score *ps = get_root_system (me)->paper_score ();
  77   vector<vsize> breaks = ps->get_break_indices ();
  78   vector<Grob*> cols = ps->get_columns ();
  79   vsize start_index = VPOS;
  80   vsize end_index = VPOS;
  81
  82   for (vsize i = 0; i < breaks.size (); i++)
  83     {
  84       int r = Paper_column::get_rank (cols[breaks[i]]);
  85       if (start == r)
  86         start_index = i;
  87       if (end == r)
  88         end_index = i;
  89     }
  90
  91   if (start_index == VPOS || end_index == VPOS)
  92     {
  93       programming_error (_ ("tried to calculate pure-height at a non-breakpoint"));
  94       return Interval (0, 0);
  95     }
  96
  97   SCM extents = me->get_property ("cached-pure-extents");
  98   if (!scm_is_vector (extents))
  99     {
 100       extents = scm_c_make_vector (breaks.size () - 1, SCM_EOL);
 101       for (vsize i = 0; i < breaks.size () - 1; i++)
 102         {
 103           int st = Paper_column::get_rank (cols[breaks[i]]);
 104           int ed = Paper_column::get_rank (cols[breaks[i+1]]);
 105           Interval iv = relative_pure_height (me, elts, common, st, ed, false);
 106           scm_vector_set_x (extents, scm_from_int (i), ly_interval2scm (iv));
 107         }
 108       me->set_property ("cached-pure-extents", extents);
 109     }
 110
 111   Interval ext (0, 0);
 112   for (vsize i = start_index; i < end_index; i++)
 113     ext.unite (ly_scm2interval (scm_c_vector_ref (extents, i)));
 114   return ext;
 115 }
 116
 117 Interval
 118 Axis_group_interface::relative_pure_height (Grob *me,
 119                                             vector<Grob*> const &elts,
 120                                             Grob *common,
 121                                             int start, int end,
 122                                             bool use_cache)
 123 {
 124   /* It saves a _lot_ of time if we assume a VerticalAxisGroup is additive
 125      (ie. height (i, k) = height (i, j) + height (j, k) for all i <= j <= k).
 126      Unfortunately, it isn't always true, particularly if there is a
 127      VerticalAlignment somewhere in the descendants.
 128
 129      Apart from PianoStaff, which has a fixed VerticalAlignment so it doesn't
 130      count, the only VerticalAlignment comes from Score. This makes it
 131      reasonably safe to assume that if our parent is a VerticalAlignment,
 132      we can assume additivity and cache things nicely. */
 133   Grob *p = me->get_parent (Y_AXIS);
 134   if (use_cache && p && Align_interface::has_interface (p))
 135     return Axis_group_interface::cached_pure_height (me, elts, common, start, end);
 136
 137   Interval r;
 138
 139   for (vsize i = 0; i < elts.size (); i++)
 140     {
 141       Interval_t<int> rank_span = elts[i]->spanned_rank_iv ();
 142       Item *it = dynamic_cast<Item*> (elts[i]);
 143       if (rank_span[LEFT] <= end && rank_span[RIGHT] >= start && (!it || it->pure_is_visible (start, end)))
 144         {
 145           Interval dims = elts[i]->pure_height (common, start, end);
 146           if (!dims.is_empty ())
 147             r.unite (dims);
 148         }
 149     }
 150   return r;
 151 }
 152
 153 MAKE_SCHEME_CALLBACK (Axis_group_interface, width, 1);
 154 SCM
 155 Axis_group_interface::width (SCM smob)
 156 {
 157   Grob *me = unsmob_grob (smob);
 158   return generic_group_extent (me, X_AXIS);
 159 }
 160
 161 MAKE_SCHEME_CALLBACK (Axis_group_interface, height, 1);
 162 SCM
 163 Axis_group_interface::height (SCM smob)
 164 {
 165   Grob *me = unsmob_grob (smob);
 166   return generic_group_extent (me, Y_AXIS);
 167 }
 168
 169 MAKE_SCHEME_CALLBACK (Axis_group_interface, pure_height, 3);
 170 SCM
 171 Axis_group_interface::pure_height (SCM smob, SCM start_scm, SCM end_scm)
 172 {
 173   int start = robust_scm2int (start_scm, 0);
 174   int end = robust_scm2int (end_scm, INT_MAX);
 175   Grob *me = unsmob_grob (smob);
 176
 177   return pure_group_height (me, start, end);
 178 }
 179
 180 SCM
 181 Axis_group_interface::generic_group_extent (Grob *me, Axis a)
 182 {
 183   extract_grob_set (me, "elements", elts);
 184   if (a == Y_AXIS && to_boolean (me->get_property ("skyline-spacing")))
 185     skyline_spacing (me, elts);
 186   Grob *common = common_refpoint_of_array (elts, me, a);
 187
 188   Real my_coord = me->relative_coordinate (common, a);
 189   Interval r (relative_group_extent (elts, common, a));
 190
 191   return ly_interval2scm (r - my_coord);
 192 }
 193
 194 SCM
 195 Axis_group_interface::pure_group_height (Grob *me, int start, int end)
 196 {
 197   Grob *common = unsmob_grob (me->get_object ("common-refpoint-of-elements"));
 198
 199   if (!common)
 200     {
 201       extract_grob_set (me, "elements", elts);
 202
 203       vector<Grob*> relevant_elts;
 204       SCM is_relevant = ly_lily_module_constant ("pure-relevant");
 205
 206       for (vsize i = 0; i < elts.size (); i++)
 207         {
 208           if (to_boolean (scm_apply_1 (is_relevant, elts[i]->self_scm (), SCM_EOL)))
 209             relevant_elts.push_back (elts[i]);
 210
 211           Item *it = dynamic_cast<Item*> (elts[i]);
 212           Direction d = LEFT;
 213           if (it)
 214             do
 215               {
 216                 Item *piece = it->find_prebroken_piece (d);
 217                 if (piece && to_boolean (scm_apply_1 (is_relevant, piece->self_scm (), SCM_EOL)))
 218                   relevant_elts.push_back (piece);
 219               }
 220             while (flip (&d) != LEFT);
 221         }
 222
 223       common = common_refpoint_of_array (relevant_elts, me, Y_AXIS);
 224       me->set_object ("common-refpoint-of-elements", common->self_scm ());
 225
 226       SCM ga_scm = Grob_array::make_array ();
 227       Grob_array *ga = unsmob_grob_array (ga_scm);
 228       ga->set_array (relevant_elts);
 229       me->set_object ("pure-relevant-elements", ga_scm);
 230     }
 231
 232   extract_grob_set (me, "pure-relevant-elements", elts);
 233   Real my_coord = me->relative_coordinate (common, Y_AXIS);
 234   Interval r (relative_pure_height (me, elts, common, start, end, true));
 235
 236   return ly_interval2scm (r - my_coord);
 237 }
 238
 239 void
 240 Axis_group_interface::get_children (Grob *me, vector<Grob*> *found)
 241 {
 242   found->push_back (me);
 243
 244   if (!has_interface (me))
 245     return;
 246
 247   extract_grob_set (me, "elements", elements);
 248   for (vsize i = 0; i < elements.size (); i++)
 249     {
 250       Grob *e = elements[i];
 251       Axis_group_interface::get_children (e, found);
 252     }
 253 }
 254
 255 bool
 256 staff_priority_less (Grob * const &g1, Grob * const &g2)
 257 {
 258   int priority_1 = robust_scm2int (g1->get_property ("outside-staff-priority"), INT_MIN);
 259   int priority_2 = robust_scm2int (g2->get_property ("outside-staff-priority"), INT_MIN);
 260
 261   if (priority_1 < priority_2)
 262     return true;
 263   else if (priority_1 > priority_2)
 264     return false;
 265
 266   /* if there is no preference in staff priority, choose the one with the lower rank */
 267   int rank_1 = g1->spanned_rank_iv ()[LEFT];
 268   int rank_2 = g2->spanned_rank_iv ()[LEFT];
 269   return rank_1 < rank_2;
 270 }
 271
 272 static void
 273 add_boxes (Grob *me, Grob *x_common, Grob *y_common, vector<Box> *const boxes)
 274 {
 275   if (Axis_group_interface::has_interface (me)
 276       && Axis_group_interface::has_axis (me, Y_AXIS))
 277     {
 278       Grob_array *elements = unsmob_grob_array (me->get_object ("elements"));
 279       if (elements)
 280         for (vsize i = 0; i < elements->size (); i++)
 281           add_boxes (elements->grob (i), x_common, y_common, boxes);
 282     }
 283   else
 284     boxes->push_back (Box (me->extent (x_common, X_AXIS),
 285                            me->extent (y_common, Y_AXIS)));
 286 }
 287
 288 void
 289 Axis_group_interface::skyline_spacing (Grob *me, vector<Grob*> elements)
 290 {
 291   vector_sort (elements, staff_priority_less);
 292   Grob *x_common = common_refpoint_of_array (elements, me, X_AXIS);
 293   Grob *y_common = common_refpoint_of_array (elements, me, Y_AXIS);
 294
 295   vsize i = 0;
 296   vector<Box> boxes;
 297
 298   for (i = 0; i < elements.size ()
 299          && !scm_is_number (elements[i]->get_property ("outside-staff-priority")); i++)
 300     add_boxes (elements[i], x_common, y_common, &boxes);
 301
 302   Drul_array<Skyline> skylines (Skyline (boxes, X_AXIS, DOWN),
 303                                 Skyline (boxes, X_AXIS, UP));
 304   for (; i < elements.size (); i++)
 305     {
 306       Direction dir = get_grob_direction (elements[i]);
 307       if (dir == CENTER)
 308         {
 309           warning (_ ("an outside-staff object should have a direction"));
 310           continue;
 311         }
 312
 313       Box b (elements[i]->extent (x_common, X_AXIS),
 314              elements[i]->extent (y_common, Y_AXIS));
 315       if (b[X_AXIS].is_empty () || b[Y_AXIS].is_empty ())
 316         {
 317           warning (_f ("outside-staff object %s has an empty extent", elements[i]->name ().c_str ()));
 318           continue;
 319         }
 320
 321       boxes.clear ();
 322       boxes.push_back (b);
 323       Skyline other = Skyline (boxes, X_AXIS, -dir);
 324       Real padding = robust_scm2double (elements[i]->get_property ("outside-staff-padding"), 0.5);
 325       Real dist = skylines[dir].distance (other) + padding;
 326
 327       if (dist > 0)
 328         {
 329           b.translate (Offset (0, dir*dist));
 330           elements[i]->translate_axis (dir*dist, Y_AXIS);
 331         }
 332       skylines[dir].insert (b, X_AXIS);
 333     }
 334 }
 335
 336 ADD_INTERFACE (Axis_group_interface,
 337
 338                "An object that groups other layout objects.",
 339
 340                /* properties */
 341                "axes "
 342                "elements "
 343                "common-refpoint-of-elements "
 344                "pure-relevant-elements "
 345                "skyline-spacing "
 346                "cached-pure-extents "
 347                );