source file of the GNU LilyPond music typesetter
- (c) 1998--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1998--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
#include "side-position-interface.hh"
#include <cmath> // ceil.
#include <algorithm>
+
using namespace std;
+#include "directional-element-interface.hh"
+#include "grob.hh"
+#include "main.hh"
+#include "misc.hh"
#include "note-head.hh"
-#include "warn.hh"
-#include "warn.hh"
-#include "dimensions.hh"
-#include "staff-symbol-referencer.hh"
#include "pointer-group-interface.hh"
-#include "directional-element-interface.hh"
#include "staff-symbol-referencer.hh"
+#include "staff-symbol.hh"
+#include "stem.hh"
#include "string-convert.hh"
+#include "warn.hh"
void
Side_position_interface::add_support (Grob *me, Grob *e)
{
- Pointer_group_interface::add_grob (me, ly_symbol2scm ("side-support-elements"), e);
+ Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("side-support-elements"), e);
}
Direction
Side_position_interface::get_direction (Grob *me)
{
Direction relative_dir = Direction (1);
- SCM reldir = me->get_property ("side-relative-direction"); // should use a lambda.
+ SCM reldir = me->get_property ("side-relative-direction");
if (is_direction (reldir))
relative_dir = to_dir (reldir);
return CENTER;
}
-MAKE_SCHEME_CALLBACK (Side_position_interface, aligned_on_support_extents, 2);
-SCM
-Side_position_interface::aligned_on_support_extents (SCM element_smob, SCM axis)
-{
- Grob *me = unsmob_grob (element_smob);
- Axis a = (Axis) scm_to_int (axis);
-
- return general_side_position (me, a, true);
-}
-
/* Put the element next to the support, optionally taking in
- account the extent of the support. */
+ account the extent of the support.
+
+ Does not take into account the extent of ME.
+*/
SCM
-Side_position_interface::general_side_position (Grob *me, Axis a, bool use_extents)
+Side_position_interface::general_side_position (Grob *me, Axis a, bool use_extents,
+ bool include_my_extent,
+ bool pure, int start, int end,
+ Real *current_offset)
{
Real ss = Staff_symbol_referencer::staff_space (me);
extract_grob_set (me, "side-support-elements", support);
Grob *common = common_refpoint_of_array (support, me->get_parent (a), a);
- Grob *st = Staff_symbol_referencer::get_staff_symbol (me);
- bool include_staff = (st
- && a == Y_AXIS
- && scm_is_number (me->get_property ("staff-padding")));
+ Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (me);
+ bool include_staff =
+ staff_symbol
+ && a == Y_AXIS
+ && scm_is_number (me->get_property ("staff-padding"))
+ && !to_boolean (me->get_property ("quantize-position"));
Interval dim;
+ Interval staff_extents;
if (include_staff)
{
- common = st->common_refpoint (common, Y_AXIS);
- dim = st->extent (common, Y_AXIS);
+ common = staff_symbol->common_refpoint (common, Y_AXIS);
+ staff_extents = staff_symbol->maybe_pure_extent (common, Y_AXIS, pure, start, end);
+
+ if (include_staff)
+ dim.unite (staff_extents);
}
- for (int i = 0; i < support.size (); i++)
+ Direction dir = get_grob_direction (me);
+
+ for (vsize i = 0; i < support.size (); i++)
{
Grob *e = support[i];
+
+ // In the case of a stem, we will find a note head as well
+ // ignoring the stem solves cyclic dependencies if the stem is
+ // attached to a cross-staff beam.
+ if (a == Y_AXIS
+ && Stem::has_interface (e)
+ && dir == - get_grob_direction (e))
+ continue;
+
if (e)
- if (use_extents)
- dim.unite (e->extent (common, a));
- else
- {
- Real x = e->relative_coordinate (common, a);
- dim.unite (Interval (x, x));
- }
+ {
+ if (use_extents)
+ dim.unite (e->maybe_pure_extent (common, a, pure, start, end));
+ else
+ {
+ Real x = e->maybe_pure_coordinate (common, a, pure, start, end);
+ dim.unite (Interval (x, x));
+ }
+ }
}
if (dim.is_empty ())
dim = Interval (0, 0);
- Direction dir = get_grob_direction (me);
-
- Real off = me->get_parent (a)->relative_coordinate (common, a);
+ Real off = me->get_parent (a)->maybe_pure_coordinate (common, a, pure, start, end);
Real minimum_space = ss * robust_scm2double (me->get_property ("minimum-space"), -1);
Real total_off = dim.linear_combination (dir) - off;
&& total_off * dir < minimum_space)
total_off = minimum_space * dir;
- /* FIXME: 100CM should relate to paper size. */
- if (fabs (total_off) > 100 CM)
+ if (include_my_extent)
+ {
+ Interval iv = me->maybe_pure_extent (me, a, pure, start, end);
+ if (!iv.is_empty ())
+ {
+ if (!dir)
+ {
+ programming_error ("direction unknown, but aligned-side wanted");
+ dir = DOWN;
+ }
+ total_off += -iv[-dir];
+ }
+ }
+
+ if (current_offset)
+ total_off = dir * max (dir * total_off,
+ dir * (*current_offset));
+
+
+ /* FIXME: 1000 should relate to paper size. */
+ if (fabs (total_off) > 1000)
{
- String msg
- = String_convert::form_string ("Improbable offset for grob %s: %f%s",
- me->name ().to_str0 (), total_off,
- INTERNAL_UNIT);
+ string msg
+ = String_convert::form_string ("Improbable offset for grob %s: %f",
+ me->name ().c_str (), total_off);
programming_error (msg);
+ if (strict_infinity_checking)
+ scm_misc_error (__FUNCTION__, "Improbable offset.", SCM_EOL);
}
return scm_from_double (total_off);
}
-/*
- Cut & paste (ugh.)
-*/
-MAKE_SCHEME_CALLBACK (Side_position_interface, aligned_on_support_refpoints, 2);
+
+MAKE_SCHEME_CALLBACK (Side_position_interface, y_aligned_on_support_refpoints, 1);
SCM
-Side_position_interface::aligned_on_support_refpoints (SCM smob, SCM axis)
+Side_position_interface::y_aligned_on_support_refpoints (SCM smob)
{
- Grob *me = unsmob_grob (smob);
- Axis a = (Axis) scm_to_int (axis);
-
- return general_side_position (me, a, false);
+ return general_side_position (unsmob_grob (smob), Y_AXIS, false, false, false, 0, 0, 0);
}
-Real
-directed_round (Real f, Direction d)
+MAKE_SCHEME_CALLBACK (Side_position_interface, pure_y_aligned_on_support_refpoints, 3);
+SCM
+Side_position_interface::pure_y_aligned_on_support_refpoints (SCM smob, SCM start, SCM end)
{
- if (d < 0)
- return floor (f);
- else
- return ceil (f);
+ return general_side_position (unsmob_grob (smob), Y_AXIS, false, false,
+ true, scm_to_int (start), scm_to_int (end), 0);
}
-/*
- Callback that quantises in staff-spaces, rounding in the direction
- of the elements "direction" elt property.
- Only rounds when we're inside the staff, as determined by
- Staff_symbol_referencer::staff_radius () */
-MAKE_SCHEME_CALLBACK (Side_position_interface, quantised_position, 2);
+/*
+ Position next to support, taking into account my own dimensions and padding.
+*/
SCM
-Side_position_interface::quantised_position (SCM element_smob, SCM)
+axis_aligned_side_helper (SCM smob, Axis a, bool pure, int start, int end, SCM current_off_scm)
{
- Grob *me = unsmob_grob (element_smob);
-
- Direction d = get_grob_direction (me);
-
- Grob *stsym = Staff_symbol_referencer::get_staff_symbol (me);
- if (stsym)
+ Real r;
+ Real *current_off_ptr = 0;
+ if (scm_is_number (current_off_scm))
{
- Real p = Staff_symbol_referencer::get_position (me);
- Real rp = directed_round (p, d);
- Real rad = Staff_symbol_referencer::staff_radius (me) * 2;
- int ip = int (rp);
+ r = scm_to_double (current_off_scm);
+ current_off_ptr = &r;
+ }
+
+ return Side_position_interface::aligned_side (unsmob_grob (smob), a, pure, start, end, current_off_ptr);
+}
- Grob *head = me->get_parent (X_AXIS);
- if (Staff_symbol_referencer::on_staffline (me, ip)
- && ((abs (ip) <= rad)
- || (Note_head::has_interface (head)
- && sign (Staff_symbol_referencer::get_position (head))
- == -d)))
- {
- ip += d;
- rp += d;
- }
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, x_aligned_side, 2, 1, "");
+SCM
+Side_position_interface::x_aligned_side (SCM smob, SCM current_off)
+{
+ return axis_aligned_side_helper (smob, X_AXIS, false, 0, 0, current_off);
+}
- return scm_from_double ((rp - p) * Staff_symbol_referencer::staff_space (me) / 2.0);
- }
- return scm_from_double (0.0);
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, y_aligned_side, 2, 1, "");
+SCM
+Side_position_interface::y_aligned_side (SCM smob, SCM current_off)
+{
+ return axis_aligned_side_helper (smob, Y_AXIS, false, 0, 0, current_off);
}
-/*
- Position next to support, taking into account my own dimensions and padding.
-*/
-MAKE_SCHEME_CALLBACK (Side_position_interface, aligned_side, 2);
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, pure_y_aligned_side, 4, 1, "");
+SCM
+Side_position_interface::pure_y_aligned_side (SCM smob, SCM start, SCM end, SCM cur_off)
+{
+ return axis_aligned_side_helper (smob, Y_AXIS, true,
+ scm_to_int (start),
+ scm_to_int (end),
+ cur_off);
+}
+
+MAKE_SCHEME_CALLBACK (Side_position_interface, calc_cross_staff, 1)
SCM
-Side_position_interface::aligned_side (SCM element_smob, SCM axis)
+Side_position_interface::calc_cross_staff (SCM smob)
{
- Grob *me = unsmob_grob (element_smob);
- Axis a = (Axis) scm_to_int (axis);
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "side-support-elements", elts);
- Direction d = get_grob_direction (me);
- Real o = scm_to_double (aligned_on_support_extents (element_smob, axis));
+ for (vsize i = 0; i < elts.size (); i++)
+ if (to_boolean (elts[i]->get_property ("cross-staff")))
+ return SCM_BOOL_T;
- Interval iv = me->extent (me, a);
+ Grob *common = common_refpoint_of_array (elts, me->get_parent (Y_AXIS), Y_AXIS);
+ return scm_from_bool (common != me->get_parent (Y_AXIS));
+}
- if (!iv.is_empty ())
- {
- if (!d)
- {
- programming_error ("direction unknown, but aligned-side wanted");
- d = DOWN;
- }
- o += -iv[-d];
- }
+SCM
+Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, int end,
+ Real *current_off)
+{
+ Direction dir = get_grob_direction (me);
+
+ Real o = scm_to_double (general_side_position (me, a, true, true, pure, start, end, current_off));
/*
Maintain a minimum distance to the staff. This is similar to side
position with padding, but it will put adjoining objects on a row if
stuff sticks out of the staff a little.
*/
- Grob *st = Staff_symbol_referencer::get_staff_symbol (me);
- if (st && a == Y_AXIS
- && scm_is_number (me->get_property ("staff-padding")))
+ Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
+ if (staff && a == Y_AXIS)
{
- Real padding
- = Staff_symbol_referencer::staff_space (me)
- * scm_to_double (me->get_property ("staff-padding"));
+ if (to_boolean (me->get_property ("quantize-position")))
+ {
+ Grob *common = me->common_refpoint (staff, Y_AXIS);
+ Real my_off = me->get_parent (Y_AXIS)->maybe_pure_coordinate (common, Y_AXIS, pure, start, end);
+ Real staff_off = staff->maybe_pure_coordinate (common, Y_AXIS, pure, start, end);
+ Real ss = Staff_symbol::staff_space (staff);
+ Real position = 2 * (my_off + o - staff_off) / ss;
+ Real rounded = directed_round (position, dir);
+ Grob *head = me->get_parent (X_AXIS);
+
+ if (fabs (position) <= 2 * Staff_symbol_referencer::staff_radius (me) + 1
+ /* In case of a ledger lines, quantize even if we're outside the staff. */
+ || (Note_head::has_interface (head)
+
+ && abs (Staff_symbol_referencer::get_position (head)) > abs (position)))
+ {
+ o += (rounded - position) * 0.5 * ss;
+ if (Staff_symbol_referencer::on_line (me, int (rounded)))
+ o += dir * 0.5 * ss;
+ }
+ }
+ else if (scm_is_number (me->get_property ("staff-padding")) && dir)
+ {
+ Interval iv = me->maybe_pure_extent (me, a, pure, start, end);
+
+ Real padding
+ = Staff_symbol_referencer::staff_space (me)
+ * scm_to_double (me->get_property ("staff-padding"));
- Grob *common = me->common_refpoint (st, Y_AXIS);
+ Grob *common = me->common_refpoint (staff, Y_AXIS);
- Interval staff_size = st->extent (common, Y_AXIS);
- Real diff = d*staff_size[d] + padding - d * (o + iv[-d]);
- o += d * max (diff, 0.0);
+ Interval staff_size = staff->maybe_pure_extent (common, Y_AXIS, pure, start, end);
+ Real diff = dir*staff_size[dir] + padding - dir * (o + iv[-dir]);
+ o += dir * max (diff, 0.0);
+ }
}
-
return scm_from_double (o);
}
void
Side_position_interface::set_axis (Grob *me, Axis a)
{
- me->add_offset_callback (Side_position_interface::aligned_side_proc, a);
+ if (!scm_is_number (me->get_property ("side-axis")))
+ {
+ me->set_property ("side-axis", scm_from_int (a));
+ chain_offset_callback (me,
+ (a==X_AXIS)
+ ? x_aligned_side_proc
+ : y_aligned_side_proc,
+ a);
+ }
}
-// ugh. doesn't catch all variants.
Axis
Side_position_interface::get_axis (Grob *me)
{
- if (me->has_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS)
- || me->has_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS))
- return X_AXIS;
-
- return Y_AXIS;
+ if (scm_is_number (me->get_property ("side-axis")))
+ return Axis (scm_to_int (me->get_property ("side-axis")));
+
+ string msg = String_convert::form_string ("side-axis not set for grob %s.",
+ me->name ().c_str ());
+ me->programming_error (msg);
+ return NO_AXES;
}
-ADD_INTERFACE (Side_position_interface, "side-position-interface",
- "Position a victim object (this one) next to other objects (the "
- "support). The property @code{direction} signifies where to put the "
- "victim object relative to the support (left or right, up or down?)\n\n "
- "The routine also takes the size the staff into account if "
- "@code{staff-padding} is set. If undefined, the staff symbol is ignored.",
+ADD_INTERFACE (Side_position_interface,
+ "Position a victim object (this one) next to other objects"
+ " (the support). The property @code{direction} signifies where"
+ " to put the victim object relative to the support (left or"
+ " right, up or down?)\n"
+ "\n"
+ "The routine also takes the size of the staff into account if"
+ " @code{staff-padding} is set. If undefined, the staff symbol"
+ " is ignored.",
/* properties */
"direction "
"direction-source "
"minimum-space "
"padding "
+ "quantize-position "
+ "side-axis "
"side-relative-direction "
"side-support-elements "
"slur-padding "
projects / lilypond.git / blobdiff