lily/side-position-interface.cc

   1 /*
   2   staff-side.cc --  implement Staff_side_element
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #include "side-position-interface.hh"
  11
  12 #include <cmath>                // ceil.
  13
  14 #include "note-head.hh"
  15 #include "warn.hh"
  16 #include "warn.hh"
  17 #include "dimensions.hh"
  18 #include "staff-symbol-referencer.hh"
  19 #include "group-interface.hh"
  20 #include "directional-element-interface.hh"
  21 #include "staff-symbol-referencer.hh"
  22 #include "string-convert.hh"
  23
  24 void
  25 Side_position_interface::add_support (Grob*me, Grob*e)
  26 {
  27   Pointer_group_interface::add_grob (me, ly_symbol2scm ("side-support-elements"), e);
  28 }
  29
  30 Direction
  31 Side_position_interface::get_direction (Grob*me)
  32 {
  33   SCM d = me->get_property ("direction");
  34   if (is_direction (d) && to_dir (d))
  35     return to_dir (d);
  36
  37   Direction relative_dir = Direction (1);
  38   SCM reldir = me->get_property ("side-relative-direction");    // should use a lambda.
  39   if (is_direction (reldir))
  40     {
  41       relative_dir = to_dir (reldir);
  42     }
  43
  44   SCM other_elt = me->get_property ("direction-source");
  45   Grob * e = unsmob_grob (other_elt);
  46   if (e)
  47     {
  48       return (Direction) (relative_dir * get_grob_direction (e));
  49     }
  50
  51   return CENTER;
  52 }
  53
  54
  55 MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_extents, 2);
  56 SCM
  57 Side_position_interface::aligned_on_support_extents (SCM element_smob, SCM axis)
  58 {
  59   Grob *me = unsmob_grob (element_smob);
  60   Axis a = (Axis) scm_to_int (axis);
  61
  62   return general_side_position (me, a, true);
  63 }
  64
  65
  66 /* Put the element next to the support, optionally taking in
  67    account the extent of the support.  */
  68 SCM
  69 Side_position_interface::general_side_position (Grob *me, Axis a, bool use_extents)
  70 {
  71   Real ss = Staff_symbol_referencer::staff_space (me);
  72   SCM support = me->get_property ("side-support-elements");
  73   Grob *common = common_refpoint_of_list (support, me->get_parent (a), a);
  74   Grob * st = Staff_symbol_referencer::get_staff_symbol (me);
  75   bool include_staff = (st
  76                         && a == Y_AXIS
  77                         && scm_is_number (me->get_property ("staff-padding")));
  78
  79   Interval dim;
  80   if (include_staff)
  81     {
  82       common = st->common_refpoint (common, Y_AXIS);
  83       dim = st->extent (common, Y_AXIS);
  84     }
  85
  86   for (SCM s = support; s != SCM_EOL; s = scm_cdr (s))
  87     {
  88       Grob *e = unsmob_grob (scm_car (s));
  89       if (e)
  90         if (use_extents)
  91           dim.unite (e->extent (common, a));
  92         else
  93           {
  94             Real x = e->relative_coordinate (common, a);
  95             dim.unite (Interval (x,x));
  96           }
  97     }
  98
  99   if (dim.is_empty ())
 100     dim = Interval (0, 0);
 101
 102   Direction dir = Side_position_interface::get_direction (me);
 103
 104   Real off = me->get_parent (a)->relative_coordinate (common, a);
 105   Real minimum_space = ss * robust_scm2double (me->get_property ("minimum-space"),  -1);
 106
 107   Real total_off = dim.linear_combination (dir) - off;
 108   total_off += dir * ss * robust_scm2double (me->get_property ("padding"), 0);
 109
 110   if (minimum_space >= 0
 111       && dir
 112       && total_off * dir < minimum_space)
 113     total_off = minimum_space * dir;
 114
 115   /* FIXME: 100CM should relate to paper size.  */
 116   if (fabs (total_off) > 100 CM)
 117     programming_error (String_convert::form_string ("Improbable offset for grob %s: %f%s", me->name (), total_off, INTERNAL_UNIT));
 118
 119   return scm_make_real (total_off);
 120 }
 121
 122 /*
 123   Cut & paste (ugh.)
 124  */
 125 MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_refpoints,2);
 126 SCM
 127 Side_position_interface::aligned_on_support_refpoints (SCM smob, SCM axis)
 128 {
 129   Grob *me = unsmob_grob (smob);
 130   Axis a = (Axis) scm_to_int (axis);
 131
 132   return general_side_position (me, a, false);
 133 }
 134
 135
 136
 137
 138 Real
 139 directed_round (Real f, Direction d)
 140 {
 141   if (d < 0)
 142     return floor (f);
 143   else
 144     return ceil (f);
 145 }
 146
 147 /*
 148   Callback that quantises in staff-spaces, rounding in the direction
 149   of the elements "direction" elt property.
 150
 151   Only rounds when we're inside the staff, as determined by
 152   Staff_symbol_referencer::staff_radius () */
 153 MAKE_SCHEME_CALLBACK (Side_position_interface,quantised_position,2);
 154 SCM
 155 Side_position_interface::quantised_position (SCM element_smob, SCM)
 156 {
 157   Grob *me = unsmob_grob (element_smob);
 158
 159   Direction d = Side_position_interface::get_direction (me);
 160
 161   Grob * stsym = Staff_symbol_referencer::get_staff_symbol (me);
 162   if (stsym)
 163     {
 164       Real p = Staff_symbol_referencer::get_position (me);
 165       Real rp = directed_round (p, d);
 166       Real rad = Staff_symbol_referencer::staff_radius (me) *2 ;
 167       int ip = int (rp);
 168
 169       Grob *head = me->get_parent (X_AXIS);
 170
 171       if (Staff_symbol_referencer::on_staffline (me,ip)
 172           && ((abs (ip) <= rad)
 173               || (Note_head::has_interface (head)
 174                   && sign (Staff_symbol_referencer::get_position (head))
 175                   == -d)
 176               ))
 177         {
 178           ip += d;
 179           rp += d;
 180         }
 181
 182       return scm_make_real ((rp - p) * Staff_symbol_referencer::staff_space (me) / 2.0);
 183     }
 184   return scm_make_real (0.0);
 185 }
 186
 187 /*
 188   Position next to support, taking into account my own dimensions and padding.
 189  */
 190 MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_side,2);
 191 SCM
 192 Side_position_interface::aligned_side (SCM element_smob, SCM axis)
 193 {
 194   Grob *me = unsmob_grob (element_smob);
 195   Axis a = (Axis) scm_to_int (axis);
 196
 197   Direction d = Side_position_interface::get_direction (me);
 198
 199   Real o = scm_to_double (aligned_on_support_extents (element_smob,axis));
 200
 201   Interval iv =  me->extent (me, a);
 202
 203   if (!iv.is_empty ())
 204     {
 205       if (!d)
 206         {
 207           programming_error ("Direction unknown, but aligned-side wanted.");
 208           d = DOWN;
 209         }
 210       o += - iv[-d];
 211     }
 212
 213   /*
 214   Maintain a minimum distance to the staff. This is similar to side
 215   position with padding, but it will put adjoining objects on a row if
 216   stuff sticks out of the staff a little.
 217  */
 218   Grob * st = Staff_symbol_referencer::get_staff_symbol (me);
 219   if (st && a == Y_AXIS
 220       && scm_is_number (me->get_property ("staff-padding")))
 221     {
 222       Real padding=
 223       Staff_symbol_referencer::staff_space (me)
 224       * scm_to_double (me->get_property ("staff-padding"));
 225
 226       Grob *common = me->common_refpoint (st, Y_AXIS);
 227
 228       Interval staff_size = st->extent (common, Y_AXIS);
 229       Real diff =  d*staff_size[d] + padding - d*(o + iv[-d]);
 230       o += (d*  (diff >? 0));
 231     }
 232
 233   return scm_make_real (o);
 234 }
 235
 236
 237 void
 238 Side_position_interface::set_axis (Grob*me, Axis a)
 239 {
 240   me->add_offset_callback (Side_position_interface::aligned_side_proc, a);
 241 }
 242
 243 // ugh. doesn't catch all variants.
 244 Axis
 245 Side_position_interface::get_axis (Grob*me)
 246 {
 247   if (me->has_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS)
 248       || me->has_offset_callback (Side_position_interface::aligned_side_proc , X_AXIS))
 249     return X_AXIS;
 250
 251   return Y_AXIS;
 252 }
 253
 254
 255 ADD_INTERFACE (Side_position_interface,"side-position-interface",
 256                "Position a victim object (this one) next to other objects (the "
 257                "support).   The property @code{direction} signifies where to put the  "
 258                "victim object relative to the support (left or right, up or down?)\n\n "
 259                "The routine also takes the size the staff into account if "
 260                "@code{staff-padding} is set. If undefined, the staff symbol is ignored."
 261                ,
 262                "staff-padding side-support-elements direction-source "
 263                "direction side-relative-direction minimum-space padding");