-/*
+/*
staff-symbol-referencer.cc -- implement Staff_symbol_referencer
-
+
source file of the GNU LilyPond music typesetter
-
- (c) 1999 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 "dimension-cache.hh"
+#include "grob.hh"
+#include "output-def.hh"
+#include "libc-extension.hh"
-Staff_symbol_referencer_interface::Staff_symbol_referencer_interface (Score_element const *sc)
+int
+Staff_symbol_referencer::line_count (Grob *me)
{
- elt_l_ = (Score_element*)sc;
+ Grob *st = get_staff_symbol (me);
+ return st ? Staff_symbol::line_count (st) : 0;
}
-void
-Staff_symbol_referencer_interface::set_interface ()
+bool
+Staff_symbol_referencer::on_line (Grob *me)
{
- elt_l_->set_elt_property ("staff-position", gh_double2scm (0.0));
- elt_l_->dim_cache_[Y_AXIS]->off_callbacks_.push (callback);
+ return on_line (me, (int) rint (get_position (me)));
}
-
bool
-Staff_symbol_referencer_interface::has_interface_b ()
+Staff_symbol_referencer::on_staff_line (Grob *me)
{
- return unsmob_element (elt_l_->get_elt_property ("staff-symbol"))
- || gh_number_p (elt_l_->get_elt_property ("staff-position"));
+ return on_staff_line (me, (int) rint (get_position (me)));
}
+bool
+Staff_symbol_referencer::on_line (Grob *me, int pos)
+{
+ int sz = line_count (me) - 1;
+ return ((pos + sz) % 2) == 0;
+}
-int
-Staff_symbol_referencer_interface::lines_i () const
+bool
+Staff_symbol_referencer::on_staff_line (Grob *me, int pos)
{
- Staff_symbol *st = staff_symbol_l ();
- return st ? st->no_lines_i_ : 5;
+ return on_line (me, pos) && abs (pos) <= 2 * staff_radius (me);
}
-Staff_symbol*
-Staff_symbol_referencer_interface::staff_symbol_l () const
+Grob *
+Staff_symbol_referencer::get_staff_symbol (Grob *me)
{
- SCM st = elt_l_->get_elt_property ("staff-symbol");
- return dynamic_cast<Staff_symbol* > (unsmob_element(st));
+ if (Staff_symbol::has_interface (me))
+ return me;
+
+ SCM st = me->get_object ("staff-symbol");
+ return unsmob_grob (st);
}
Real
-Staff_symbol_referencer_interface::staff_line_leading_f () const
+Staff_symbol_referencer::staff_space (Grob *me)
{
- Staff_symbol * st = staff_symbol_l ();
+ Grob *st = get_staff_symbol (me);
if (st)
- return st->staff_line_leading_f_;
- else if (elt_l_->pscore_l_ && elt_l_->paper_l ())
- elt_l_->paper_l ()->get_var ("interline");
-
- return 0.0;
+ return Staff_symbol::staff_space (st);
+ return 1.0;
}
+Real
+Staff_symbol_referencer::line_thickness (Grob *me)
+{
+ 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_interface::position_f () const
+Staff_symbol_referencer::get_position (Grob *me)
{
- Real p =0.0;
- Staff_symbol * st = staff_symbol_l ();
- Score_element * c = st ? elt_l_->common_refpoint (st, Y_AXIS) : 0;
+ 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 = elt_l_->relative_coordinate (c, Y_AXIS)
+ Real y = me->relative_coordinate (c, Y_AXIS)
- st->relative_coordinate (c, Y_AXIS);
- p += 2.0 * y / st->staff_line_leading_f ();
+ 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 = elt_l_->get_elt_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!
- */
-Real
-Staff_symbol_referencer_interface::callback (Dimension_cache const * c)
+int
+Staff_symbol_referencer::get_rounded_position (Grob *me)
{
- Score_element * sc = dynamic_cast<Score_element*> (c->element_l ());
+ return int (rint (get_position (me)));
+}
-
- SCM pos = sc->get_elt_property ("staff-position");
- Real off =0.0;
- if (gh_number_p (pos))
+MAKE_SCHEME_CALLBACK (Staff_symbol_referencer, callback, 1);
+SCM
+Staff_symbol_referencer::callback (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+
+ SCM pos = me->get_property ("staff-position");
+ Real off = 0.0;
+ if (scm_is_number (pos))
{
- Real space = staff_symbol_referencer_interface (sc).staff_line_leading_f ();
- off = gh_scm2double (pos) * space/2.0;
+ Real space = Staff_symbol_referencer::staff_space (me);
+ off = scm_to_double (pos) * space / 2.0;
}
- sc->set_elt_property ("staff-position", gh_double2scm (0.0));
- return 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 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 */
void
-Staff_symbol_referencer_interface::set_position (Real p)
+Staff_symbol_referencer::set_position (Grob *me, Real p)
{
- Staff_symbol * st = staff_symbol_l ();
- if (st && elt_l_->common_refpoint(st, Y_AXIS))
+ Grob *st = get_staff_symbol (me);
+ Real oldpos = 0.0;
+ if (st && me->common_refpoint (st, Y_AXIS))
{
- Real oldpos = position_f ();
- elt_l_->set_elt_property ("staff-position", gh_double2scm (p - oldpos));
+ oldpos = get_position (me);
}
- else
- {
- elt_l_->set_elt_property ("staff-position",
- gh_double2scm (p));
-
- }
-
- Array<Offset_cache_callback> &callbacks (elt_l_->dim_cache_[Y_AXIS]->off_callbacks_);
- for (int i=0; i < callbacks.size ();i++)
- if (callbacks[i] == callback)
- return ;
- callbacks.push (callback);
+
+ Real ss = Staff_symbol_referencer::staff_space (me);
+ me->translate_axis ((p - oldpos) * ss * 0.5, Y_AXIS);
}
-Staff_symbol_referencer_interface
-staff_symbol_referencer_interface (Score_element const*e)
+/* Half of the height, in staff space, i.e. 2.0 for a normal staff. */
+Real
+Staff_symbol_referencer::staff_radius (Grob *me)
{
- return e; // gee, I'm so smart!
+ return (line_count (me) - 1) / 2.0;
}
int
-compare_position (Score_element *const &a, Score_element * const &b)
+compare_position (Grob *const &a, Grob *const &b)
{
- Staff_symbol_referencer_interface s1(a);
- Staff_symbol_referencer_interface s2(b);
+ return sign (Staff_symbol_referencer::get_position ((Grob *)a)
+ - Staff_symbol_referencer::get_position ((Grob *) b));
+}
- return sign(s1.position_f () - s2.position_f ());
+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 position is meant relative to a staff "
+ "symbol. "
+ "These usually have @code{Staff_symbol_referencer::callback} "
+ "in their @code{Y-offset-callbacks}. ",
+
+ /* properties */
+ "staff-position");
+
+