-/*
+/*
staff-symbol-referencer.cc -- implement Staff_symbol_referencer
-
+
source file of the GNU LilyPond music typesetter
-
- (c) 1999--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- */
-#include <math.h>
+ (c) 1999--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
#include "staff-symbol-referencer.hh"
+
#include "staff-symbol.hh"
-#include "paper-def.hh"
-
+#include "grob.hh"
+#include "output-def.hh"
+#include "libc-extension.hh"
+
+int
+Staff_symbol_referencer::line_count (Grob *me)
+{
+ Grob *st = get_staff_symbol (me);
+ return st ? Staff_symbol::line_count (st) : 0;
+}
+
bool
-Staff_symbol_referencer::has_interface (Grob*e)
+Staff_symbol_referencer::on_line (Grob *me)
{
- return unsmob_grob (e->get_grob_property ("staff-symbol"))
- || gh_number_p (e->get_grob_property ("staff-position"));
+ return on_line (me, (int) rint (get_position (me)));
}
-int
-Staff_symbol_referencer::line_count (Grob*me)
+bool
+Staff_symbol_referencer::on_staff_line (Grob *me)
{
- Grob *st = staff_symbol_l (me);
- return st ? Staff_symbol::line_count (st) : 0;
+ return on_staff_line (me, (int) rint (get_position (me)));
}
bool
-Staff_symbol_referencer::on_staffline (Grob*me)
+Staff_symbol_referencer::on_line (Grob *me, int pos)
{
- return on_staffline (me, (int) rint (position_f (me)));
+ return Staff_symbol::on_line (me, pos);
}
bool
-Staff_symbol_referencer::on_staffline (Grob*me, int pos)
+Staff_symbol_referencer::on_staff_line (Grob *me, int pos)
{
- int sz = line_count (me)-1;
- return ((pos + sz) % 2) == 0;
+ return on_line (me, pos) && abs (pos) <= 2 * staff_radius (me);
}
-Grob*
-Staff_symbol_referencer::staff_symbol_l (Grob*me)
+Grob *
+Staff_symbol_referencer::get_staff_symbol (Grob *me)
{
- SCM st = me->get_grob_property ("staff-symbol");
+ if (Staff_symbol::has_interface (me))
+ return me;
+
+ SCM st = me->get_object ("staff-symbol");
return unsmob_grob (st);
}
Real
-Staff_symbol_referencer::staff_space (Grob*me)
+Staff_symbol_referencer::staff_space (Grob *me)
{
- Grob * st = staff_symbol_l (me);
+ Grob *st = get_staff_symbol (me);
if (st)
return Staff_symbol::staff_space (st);
-
return 1.0;
}
Real
-Staff_symbol_referencer::position_f (Grob*me)
+Staff_symbol_referencer::line_thickness (Grob *me)
{
- Real p =0.0;
- Grob * st = staff_symbol_l (me);
- Grob * c = st ? me->common_refpoint (st, Y_AXIS) : 0;
+ Grob *st = get_staff_symbol (me);
+ if (st)
+ return Staff_symbol::get_line_thickness (st);
+ return me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+}
+
+Real
+Staff_symbol_referencer::get_position (Grob *me)
+{
+ Real p = 0.0;
+ Grob *st = get_staff_symbol (me);
+ Grob *c = st ? me->common_refpoint (st, Y_AXIS) : 0;
if (st && c)
{
Real y = me->relative_coordinate (c, Y_AXIS)
- st->relative_coordinate (c, Y_AXIS);
p += 2.0 * y / Staff_symbol::staff_space (st);
+ return p;
}
- else
+ else if (!st)
+ return me->relative_coordinate (me->get_parent (Y_AXIS), Y_AXIS) * 2;
+ return robust_scm2double (me->get_property ("staff-position"), p);
+}
+
+
+Interval
+Staff_symbol_referencer::extent_in_staff (Grob *me)
+{
+ Grob *st = get_staff_symbol (me);
+ Grob *c = st ? me->common_refpoint (st, Y_AXIS) : 0;
+
+ Interval retval;
+ if (st && c)
{
- SCM pos = me->get_grob_property ("staff-position");
- if (gh_number_p (pos))
- return gh_scm2double (pos);
+ retval = me->extent (c, Y_AXIS)
+ - st->relative_coordinate (c, Y_AXIS);
}
-
- return p;
+
+ return retval;
}
-/*
- should use offset callback!
- */
-MAKE_SCHEME_CALLBACK (Staff_symbol_referencer,callback,2);
+int
+Staff_symbol_referencer::get_rounded_position (Grob *me)
+{
+ return int (rint (get_position (me)));
+}
+
+MAKE_SCHEME_CALLBACK (Staff_symbol_referencer, callback, 1);
SCM
-Staff_symbol_referencer::callback (SCM element_smob, SCM)
+Staff_symbol_referencer::callback (SCM smob)
{
- Grob *me = unsmob_grob (element_smob);
+ Grob *me = unsmob_grob (smob);
-
- SCM pos = me->get_grob_property ("staff-position");
- Real off =0.0;
- if (gh_number_p (pos))
+ SCM pos = me->get_property ("staff-position");
+ Real off = 0.0;
+ if (scm_is_number (pos))
{
Real space = Staff_symbol_referencer::staff_space (me);
- off = gh_scm2double (pos) * space/2.0;
- me->set_grob_property ("staff-position", gh_double2scm (0.0));
+ off = scm_to_double (pos) * space / 2.0;
}
- return gh_double2scm (off);
+ return scm_from_double (off);
}
- /*
-
- This sets the position relative to the center of the staff symbol.
-
- The function is hairy, because it can be callled in two situations:
+/* This sets the position relative to the center of the staff symbol.
- 1. There is no staff yet; we must set staff-position
+The function is hairy, because it can be called in two situations:
+
+1. There is no staff yet; we must set staff-position
+
+2. There is a staff, and perhaps someone even applied a
+translate_axis (). Then we must compensate for the translation
+
+In either case, we set a callback to be sure that our new position
+will be extracted from staff-position */
- 2. There is a staff, and perhaps someone even applied a
- translate_axis (). Then we must compensate for the translation
-
- In either case, we set a callback to be sure that our new position
- will be extracted from staff-position
-
- */
void
-Staff_symbol_referencer::set_position (Grob*me,Real p)
+Staff_symbol_referencer::set_position (Grob *me, Real p)
{
- Grob * st = staff_symbol_l (me);
+ Grob *st = get_staff_symbol (me);
+ Real oldpos = 0.0;
if (st && me->common_refpoint (st, Y_AXIS))
{
- Real oldpos = position_f (me);
- me->set_grob_property ("staff-position", gh_double2scm (p - oldpos));
- }
- else
- {
- me->set_grob_property ("staff-position",
- gh_double2scm (p));
-
+ oldpos = get_position (me);
}
- if (me->has_offset_callback_b (Staff_symbol_referencer::callback_proc, Y_AXIS))
- return ;
-
- me->add_offset_callback (Staff_symbol_referencer::callback_proc, Y_AXIS);
+
+ Real ss = Staff_symbol_referencer::staff_space (me);
+ me->translate_axis ((p - oldpos) * ss * 0.5, Y_AXIS);
}
-/*
- half of the height, in staff space.
- */
+/* Half of the height, in staff space, i.e. 2.0 for a normal staff. */
Real
-Staff_symbol_referencer::staff_radius (Grob*me)
+Staff_symbol_referencer::staff_radius (Grob *me)
{
- return (line_count (me) -1) / 2;
+ return (line_count (me) - 1) / 2.0;
}
-
int
-compare_position (Grob *const &a, Grob * const &b)
+compare_position (Grob *const &a, Grob *const &b)
{
- return sign (Staff_symbol_referencer::position_f ((Grob*)a) -
- Staff_symbol_referencer::position_f ((Grob*)b));
+ return sign (Staff_symbol_referencer::get_position ((Grob *)a)
+ - Staff_symbol_referencer::get_position ((Grob *) b));
}
+bool
+position_less (Grob *const &a, Grob *const &b)
+{
+ return Staff_symbol_referencer::get_position (a)
+ < Staff_symbol_referencer::get_position (b);
+}
+ADD_INTERFACE (Staff_symbol_referencer,
+ "An object whose Y@tie{}position is meant relative to a staff"
+ " symbol. These usually"
+ " have @code{Staff_symbol_referencer::callback} in their"
+ " @code{Y-offset-callbacks}.",
-
-
-ADD_INTERFACE (Staff_symbol_referencer,"staff-symbol-referencer-interface",
- "Object whose Y position is meaning with reference to a staff
-symbol. Objects that have this interface should include
-Staff_symbol_referencer::callback in their Y-offset-callback.
-",
- "staff-position");
+ /* properties */
+ "staff-position "
+ );