lily/side-position-interface.cc

   1 /*
   2   side-position-interface.cc -- implement Side_position_interface
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "side-position-interface.hh"
  10
  11 #include <cmath>                // ceil.
  12 #include <algorithm>
  13
  14 using namespace std;
  15
  16 #include "directional-element-interface.hh"
  17 #include "grob.hh"
  18 #include "main.hh"
  19 #include "misc.hh"
  20 #include "note-head.hh"
  21 #include "pointer-group-interface.hh"
  22 #include "staff-symbol-referencer.hh"
  23 #include "staff-symbol.hh"
  24 #include "stem.hh"
  25 #include "string-convert.hh"
  26 #include "warn.hh"
  27
  28 void
  29 Side_position_interface::add_support (Grob *me, Grob *e)
  30 {
  31   Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("side-support-elements"), e);
  32 }
  33
  34 Direction
  35 Side_position_interface::get_direction (Grob *me)
  36 {
  37   Direction relative_dir = Direction (1);
  38   SCM reldir = me->get_property ("side-relative-direction");
  39   if (is_direction (reldir))
  40     relative_dir = to_dir (reldir);
  41
  42   SCM other_elt = me->get_object ("direction-source");
  43   Grob *e = unsmob_grob (other_elt);
  44   if (e)
  45     return (Direction) (relative_dir * get_grob_direction (e));
  46
  47   return CENTER;
  48 }
  49
  50 /* Put the element next to the support, optionally taking in
  51    account the extent of the support.
  52
  53    Does not take into account the extent of ME.
  54 */
  55 SCM
  56 Side_position_interface::general_side_position (Grob *me, Axis a, bool use_extents,
  57                                                 bool include_my_extent,
  58                                                 bool pure, int start, int end,
  59                                                 Real *current_offset)
  60 {
  61   Real ss = Staff_symbol_referencer::staff_space (me);
  62
  63   extract_grob_set (me, "side-support-elements", support);
  64
  65   Grob *common = common_refpoint_of_array (support, me->get_parent (a), a);
  66   Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (me);
  67   bool include_staff =
  68     staff_symbol
  69     && a == Y_AXIS
  70     && scm_is_number (me->get_property ("staff-padding"))
  71     && !to_boolean (me->get_property ("quantize-position"));
  72
  73   Interval dim;
  74   Interval staff_extents;
  75   if (include_staff)
  76     {
  77       common = staff_symbol->common_refpoint (common, Y_AXIS);
  78       staff_extents = staff_symbol->maybe_pure_extent (common, Y_AXIS, pure, start, end);
  79
  80       if (include_staff)
  81         dim.unite (staff_extents);
  82     }
  83
  84   Direction dir = get_grob_direction (me);
  85
  86   for (vsize i = 0; i < support.size (); i++)
  87     {
  88       Grob *e = support[i];
  89
  90       // In the case of a stem, we will find a note head as well
  91       // ignoring the stem solves cyclic dependencies if the stem is
  92       // attached to a cross-staff beam.
  93       if (a == Y_AXIS
  94           && Stem::has_interface (e)
  95           && dir == - get_grob_direction (e))
  96         continue;
  97
  98       if (e)
  99         if (use_extents)
 100           dim.unite (e->maybe_pure_extent (common, a, pure, start, end));
 101         else
 102           {
 103             Real x = e->maybe_pure_coordinate (common, a, pure, start, end);
 104             dim.unite (Interval (x, x));
 105           }
 106     }
 107
 108   if (dim.is_empty ())
 109     dim = Interval (0, 0);
 110
 111   Real off = me->get_parent (a)->maybe_pure_coordinate (common, a, pure, start, end);
 112   Real minimum_space = ss * robust_scm2double (me->get_property ("minimum-space"), -1);
 113
 114   Real total_off = dim.linear_combination (dir) - off;
 115   total_off += dir * ss * robust_scm2double (me->get_property ("padding"), 0);
 116
 117   if (minimum_space >= 0
 118       && dir
 119       && total_off * dir < minimum_space)
 120     total_off = minimum_space * dir;
 121
 122   if (include_my_extent)
 123     {
 124       Interval iv = me->maybe_pure_extent (me, a, pure, start, end);
 125       if (!iv.is_empty ())
 126         {
 127           if (!dir)
 128             {
 129               programming_error ("direction unknown, but aligned-side wanted");
 130               dir = DOWN;
 131             }
 132           total_off += -iv[-dir];
 133         }
 134     }
 135
 136   if (current_offset)
 137     total_off = dir * max (dir * total_off,
 138                            dir * (*current_offset));
 139
 140
 141   /* FIXME: 1000 should relate to paper size.  */
 142   if (fabs (total_off) > 1000)
 143     {
 144       string msg
 145         = String_convert::form_string ("Improbable offset for grob %s: %f",
 146                                        me->name ().c_str (), total_off);
 147
 148       programming_error (msg);
 149       if (strict_infinity_checking)
 150         scm_misc_error (__FUNCTION__, "Improbable offset.", SCM_EOL);
 151     }
 152   return scm_from_double (total_off);
 153 }
 154
 155
 156 MAKE_SCHEME_CALLBACK (Side_position_interface, y_aligned_on_support_refpoints, 1);
 157 SCM
 158 Side_position_interface::y_aligned_on_support_refpoints (SCM smob)
 159 {
 160   return general_side_position (unsmob_grob (smob), Y_AXIS, false, false, false, 0, 0, 0);
 161 }
 162
 163 MAKE_SCHEME_CALLBACK (Side_position_interface, pure_y_aligned_on_support_refpoints, 3);
 164 SCM
 165 Side_position_interface::pure_y_aligned_on_support_refpoints (SCM smob, SCM start, SCM end)
 166 {
 167   return general_side_position (unsmob_grob (smob), Y_AXIS, false, false,
 168                                 true, scm_to_int (start), scm_to_int (end), 0);
 169 }
 170
 171
 172 /*
 173   Position next to support, taking into account my own dimensions and padding.
 174 */
 175 SCM
 176 axis_aligned_side_helper (SCM smob, Axis a, bool pure, int start, int end, SCM current_off_scm)
 177 {
 178   Real r;
 179   Real *current_off_ptr = 0;
 180   if (scm_is_number (current_off_scm))
 181     {
 182       r = scm_to_double (current_off_scm);
 183       current_off_ptr = &r;
 184     }
 185
 186   return Side_position_interface::aligned_side (unsmob_grob (smob), a, pure, start, end, current_off_ptr);
 187 }
 188
 189
 190 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, x_aligned_side, 2, 1, "");
 191 SCM
 192 Side_position_interface::x_aligned_side (SCM smob, SCM current_off)
 193 {
 194   return axis_aligned_side_helper (smob, X_AXIS, false, 0, 0, current_off);
 195 }
 196
 197 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, y_aligned_side, 2, 1, "");
 198 SCM
 199 Side_position_interface::y_aligned_side (SCM smob, SCM current_off)
 200 {
 201   return axis_aligned_side_helper (smob, Y_AXIS, false, 0, 0, current_off);
 202 }
 203
 204 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, pure_y_aligned_side, 4, 1, "");
 205 SCM
 206 Side_position_interface::pure_y_aligned_side (SCM smob, SCM start, SCM end, SCM cur_off)
 207 {
 208   return axis_aligned_side_helper (smob, Y_AXIS, true,
 209                                    scm_to_int (start),
 210                                    scm_to_int (end),
 211                                    cur_off);
 212 }
 213
 214 MAKE_SCHEME_CALLBACK (Side_position_interface, calc_cross_staff, 1)
 215 SCM
 216 Side_position_interface::calc_cross_staff (SCM smob)
 217 {
 218   Grob *me = unsmob_grob (smob);
 219   extract_grob_set (me, "side-support-elements", elts);
 220
 221   for (vsize i = 0; i < elts.size (); i++)
 222     if (to_boolean (elts[i]->get_property ("cross-staff")))
 223       return SCM_BOOL_T;
 224
 225   Grob *common = common_refpoint_of_array (elts, me->get_parent (Y_AXIS), Y_AXIS);
 226   return scm_from_bool (common != me->get_parent (Y_AXIS));
 227 }
 228
 229 SCM
 230 Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, int end,
 231                                        Real *current_off)
 232 {
 233   Direction dir = get_grob_direction (me);
 234
 235   Real o = scm_to_double (general_side_position (me, a, true, true, pure, start, end, current_off));
 236
 237   /*
 238     Maintain a minimum distance to the staff. This is similar to side
 239     position with padding, but it will put adjoining objects on a row if
 240     stuff sticks out of the staff a little.
 241   */
 242   Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
 243   if (staff && a == Y_AXIS)
 244     {
 245       if (to_boolean (me->get_property ("quantize-position")))
 246         {
 247           Grob *common = me->common_refpoint (staff, Y_AXIS);
 248           Real my_off = me->get_parent (Y_AXIS)->maybe_pure_coordinate (common, Y_AXIS, pure, start, end);
 249           Real staff_off = staff->maybe_pure_coordinate (common, Y_AXIS, pure, start, end);
 250           Real ss = Staff_symbol::staff_space (staff);
 251           Real position = 2 * (my_off + o - staff_off) / ss;
 252           Real rounded = directed_round (position, dir);
 253           Grob *head = me->get_parent (X_AXIS);
 254
 255           if (fabs (position) <= 2 * Staff_symbol_referencer::staff_radius (me) + 1
 256               /* In case of a ledger lines, quantize even if we're outside the staff. */
 257               || (Note_head::has_interface (head)
 258
 259                   && abs (Staff_symbol_referencer::get_position (head)) > abs (position)))
 260             {
 261               o += (rounded - position) * 0.5 * ss;
 262               if (Staff_symbol_referencer::on_line (me, int (rounded)))
 263                 o += dir * 0.5 * ss;
 264             }
 265         }
 266       else if (scm_is_number (me->get_property ("staff-padding")) && dir)
 267         {
 268           Interval iv = me->maybe_pure_extent (me, a, pure, start, end);
 269
 270           Real padding
 271             = Staff_symbol_referencer::staff_space (me)
 272             * scm_to_double (me->get_property ("staff-padding"));
 273
 274           Grob *common = me->common_refpoint (staff, Y_AXIS);
 275
 276           Interval staff_size = staff->maybe_pure_extent (common, Y_AXIS, pure, start, end);
 277           Real diff = dir*staff_size[dir] + padding - dir * (o + iv[-dir]);
 278           o += dir * max (diff, 0.0);
 279         }
 280     }
 281   return scm_from_double (o);
 282 }
 283
 284 void
 285 Side_position_interface::set_axis (Grob *me, Axis a)
 286 {
 287   if (!scm_is_number (me->get_property ("side-axis")))
 288     {
 289       me->set_property ("side-axis", scm_from_int (a));
 290       chain_offset_callback (me,
 291                              (a==X_AXIS)
 292                              ? x_aligned_side_proc
 293                              : y_aligned_side_proc,
 294                              a);
 295     }
 296 }
 297
 298 Axis
 299 Side_position_interface::get_axis (Grob *me)
 300 {
 301   if (scm_is_number (me->get_property ("side-axis")))
 302     return Axis (scm_to_int (me->get_property ("side-axis")));
 303
 304   string msg = String_convert::form_string ("side-axis not set for grob %s.",
 305                                             me->name ().c_str ());
 306   me->programming_error (msg);
 307   return NO_AXES;
 308 }
 309
 310 ADD_INTERFACE (Side_position_interface,
 311                "Position a victim object (this one) next to other objects"
 312                " (the support).  The property @code{direction} signifies where"
 313                " to put the victim object relative to the support (left or"
 314                " right, up or down?)\n"
 315                "\n"
 316                "The routine also takes the size of the staff into account if"
 317                " @code{staff-padding} is set.  If undefined, the staff symbol"
 318                " is ignored.",
 319
 320                /* properties */
 321                "direction "
 322                "direction-source "
 323                "minimum-space "
 324                "padding "
 325                "quantize-position "
 326                "side-axis "
 327                "side-relative-direction "
 328                "side-support-elements "
 329                "slur-padding "
 330                "staff-padding "
 331                );