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--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #include "align-interface.hh"
  11 #include "grob.hh"
  12 #include "group-interface.hh"
  13 #include "axis-group-interface.hh"
  14 #include "hara-kiri-group-spanner.hh"
  15 #include "paper-def.hh"
  16
  17 MAKE_SCHEME_CALLBACK (Align_interface,alignment_callback,2);
  18 SCM
  19 Align_interface::alignment_callback (SCM element_smob, SCM axis)
  20 {
  21   Grob * me = unsmob_grob (element_smob);
  22   Axis ax = (Axis)gh_scm2int (axis);
  23   Grob * par = me->get_parent (ax);
  24   if (par && !to_boolean (par->get_grob_property ("alignment-done")))
  25     {
  26       Align_interface::align_elements_to_extents (par, ax);
  27     }
  28   return gh_double2scm (0.0);
  29 }
  30
  31 MAKE_SCHEME_CALLBACK (Align_interface,fixed_distance_alignment_callback,2);
  32 SCM
  33 Align_interface::fixed_distance_alignment_callback (SCM element_smob, SCM axis)
  34 {
  35   Grob * me = unsmob_grob (element_smob);
  36   Axis ax = (Axis)gh_scm2int (axis);
  37   Grob * par = me->get_parent (ax);
  38   if (par && !to_boolean (par->get_grob_property ("alignment-done")))
  39     {
  40       Align_interface::align_to_fixed_distance (par, ax);
  41     }
  42   return gh_double2scm (0.0);
  43 }
  44
  45 /*
  46   merge with align-to-extents?
  47  */
  48 void
  49 Align_interface::align_to_fixed_distance (Grob *me , Axis a)
  50 {
  51   me->set_grob_property ("alignment-done", SCM_BOOL_T);
  52
  53   SCM d =   me->get_grob_property ("stacking-dir");
  54
  55   Direction stacking_dir = gh_number_p (d) ? to_dir (d) : CENTER;
  56   if (!stacking_dir)
  57     stacking_dir = DOWN;
  58
  59   SCM force = me->get_grob_property ("forced-distance");
  60
  61   Real dy = 0.0;
  62   if (gh_number_p (force))
  63     {
  64       dy = gh_scm2double (force);
  65     }
  66
  67   Link_array<Grob> elems
  68     = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
  69
  70   Real where_f=0;
  71
  72   Interval v;
  73   v.set_empty ();
  74   Array<Real> translates;
  75
  76   for (int j= elems.size (); j--; )
  77     {
  78       /*
  79         This is not very elegant, in that we need special support for
  80         hara kiri. Unfortunately, the generic wiring of
  81         force_hara_kiri_callback () (extent and offset callback) is
  82         such that we might get into a loop if we call extent() or
  83         offset() the elements.
  84
  85
  86        */
  87       if (a == Y_AXIS
  88           && Hara_kiri_group_spanner::has_interface (elems[j]))
  89         Hara_kiri_group_spanner::consider_suicide (elems[j]);
  90
  91       if (!ly_pair_p (elems[j]-> immutable_property_alist_))
  92         elems.del(j);
  93     }
  94
  95   for (int j =0; j < elems.size (); j++)
  96     {
  97       where_f += stacking_dir * dy;
  98       translates.push (where_f);
  99       v.unite (Interval (where_f, where_f));
 100     }
 101
 102   /*
 103     TODO: support self-alignment-{Y,X}
 104    */
 105   for (int i = 0; i < translates.size (); i++)
 106     {
 107       elems[i]->translate_axis (translates[i] - v.center (), a);
 108     }
 109 }
 110
 111 /*
 112   Hairy function to put elements where they should be. Can be tweaked
 113   from the outside by setting minimum-space-pair and extra-space in its
 114   children
 115
 116   We assume that the children the refpoints of the children are still
 117   found at 0.0 -- we will fuck up with thresholds if children's
 118   extents are already moved to locations such as (-16, -8), since the
 119   dy needed to put things in a row doesn't relate to the distances
 120   between original refpoints.
 121
 122   TODO: maybe we should rethink and throw out thresholding altogether.
 123   The original function has been taken over by
 124   align_to_fixed_distance().
 125 */
 126 void
 127 Align_interface::align_elements_to_extents (Grob * me, Axis a)
 128 {
 129   me->set_grob_property ("alignment-done", SCM_BOOL_T);
 130
 131   SCM d =   me->get_grob_property ("stacking-dir");
 132
 133   Direction stacking_dir = gh_number_p (d) ? to_dir (d) : CENTER;
 134   if (!stacking_dir)
 135     stacking_dir = DOWN;
 136
 137   Interval threshold = Interval (0, Interval::infinity ());
 138   SCM thr = me->get_grob_property ("threshold");
 139   if (gh_pair_p (thr))
 140     {
 141       threshold[SMALLER] = gh_scm2double (ly_car (thr));
 142       threshold[BIGGER] = gh_scm2double (ly_cdr (thr));
 143     }
 144
 145
 146   Array<Interval> dims;
 147
 148   Link_array<Grob> elems;
 149   Link_array<Grob> all_grobs
 150     = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
 151   for (int i=0; i < all_grobs.size (); i++)
 152     {
 153       Interval y = all_grobs[i]->extent (me, a);
 154       if (!y.empty_b ())
 155         {
 156           Grob *e =dynamic_cast<Grob*> (all_grobs[i]);
 157
 158           // todo: fucks up if item both in Halign & Valign.
 159           SCM min_dims = e->remove_grob_property ("minimum-space-pair");
 160           if (gh_pair_p (min_dims) &&
 161               gh_number_p (ly_car (min_dims))
 162               && gh_number_p (ly_cdr (min_dims)))
 163             {
 164               y.unite (ly_scm2interval (min_dims));
 165             }
 166
 167           SCM extra_dims = e->remove_grob_property ("extra-space");
 168           if (gh_pair_p (extra_dims) &&
 169               gh_number_p (ly_car (extra_dims))
 170               && gh_number_p (ly_cdr (extra_dims)))
 171             {
 172               y[LEFT] += gh_scm2double (ly_car (extra_dims));
 173               y[RIGHT] += gh_scm2double (ly_cdr (extra_dims));
 174             }
 175
 176           elems.push (e);
 177           dims.push (y);
 178         }
 179     }
 180
 181
 182   /*
 183     Read self-alignment-X and self-alignment-Y. This may seem like
 184     code duplication. (and really: it is), but this is necessary to
 185     prevent ugly cyclic dependencies that arise when you combine
 186     self-alignment on a child with alignment of children.
 187   */
 188
 189   String s ("self-alignment-");
 190
 191   s += (a == X_AXIS) ? "X" : "Y";
 192
 193   SCM align (me->get_grob_property (s.ch_C ()));
 194
 195   Array<Real> translates ;
 196   Interval total;
 197   Real where_f=0;
 198
 199   for (int j=0 ;  j < elems.size (); j++)
 200     {
 201       Real dy = -  dims[j][-stacking_dir];
 202       if (j)
 203         dy += dims[j-1][stacking_dir];
 204
 205
 206       /*
 207         we want dy to be > 0
 208        */
 209       dy *= stacking_dir;
 210       if (j)
 211         {
 212           dy = (dy >? threshold[SMALLER])
 213             <? threshold[BIGGER];
 214         }
 215
 216       where_f += stacking_dir * dy;
 217       total.unite (dims[j] +   where_f);
 218       translates.push (where_f);
 219     }
 220
 221
 222   Grob * align_center = unsmob_grob (align);
 223   Real center_offset = 0.0;
 224
 225   /*
 226     also move the grobs that were empty, to maintain spatial order.
 227    */
 228   Array<Real> all_translates;
 229   if (translates.size ())
 230     {
 231       int i =0;
 232       int j =0;
 233       Real w = translates[0];
 234       while (j  < all_grobs.size ())
 235         {
 236           if (i < elems.size () && all_grobs[j] == elems[i])
 237             {
 238               w = translates[i++];
 239             }
 240           if (all_grobs[j] == align_center)
 241             center_offset = w;
 242           all_translates .push (w);
 243           j++;
 244         }
 245
 246
 247       /*
 248         FIXME: uncommenting freaks out the Y-alignment of
 249         line-of-score.
 250        */
 251       // Real align_param = ly_dir_p (align)  ? gh_scm2double (align) : 0.0;
 252
 253       if (gh_number_p (align))
 254         center_offset = total.linear_combination (gh_scm2double (align));
 255
 256       for (int j = 0 ;  j < all_grobs.size (); j++)
 257         all_grobs[j]->translate_axis (all_translates[j] - center_offset, a);
 258     }
 259 }
 260 Axis
 261 Align_interface::axis (Grob*me)
 262 {
 263   return  Axis (gh_scm2int (ly_car (me->get_grob_property ("axes"))));
 264 }
 265
 266 void
 267 Align_interface::add_element (Grob*me,Grob* s, SCM cb)
 268 {
 269   s->add_offset_callback (cb, Align_interface::axis (me));
 270   Axis_group_interface::add_element (me, s);
 271 }
 272
 273 void
 274 Align_interface::set_axis (Grob*me,Axis a)
 275 {
 276   Axis_group_interface::set_axes (me, a,a);
 277 }
 278
 279
 280
 281 ADD_INTERFACE (Align_interface, "align-interface",
 282   " Order grobs top to bottom/left to right/right to left etc.",
 283   "forced-distance stacking-dir align-dir threshold alignment-done center-element elements axes");
 284
 285
 286 struct Foobar
 287 {
 288   bool has_interface (Grob*);
 289 };
 290 ADD_INTERFACE (Foobar, "aligned-interface",
 291   "read by align-interface",
 292   "minimum-space-pair extra-space");