source file of the GNU LilyPond music typesetter
- (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include <math.h> // ceil.
#include "side-position-interface.hh"
+
+#include <cmath> // ceil.
+
+#include "note-head.hh"
#include "warn.hh"
#include "warn.hh"
#include "dimensions.hh"
#include "staff-symbol-referencer.hh"
#include "group-interface.hh"
#include "directional-element-interface.hh"
+#include "staff-symbol-referencer.hh"
+#include "string-convert.hh"
void
Side_position_interface::add_support (Grob*me, Grob*e)
Pointer_group_interface::add_grob (me, ly_symbol2scm ("side-support-elements"), e);
}
-
-
Direction
Side_position_interface::get_direction (Grob*me)
{
- SCM d = me->get_grob_property ("direction");
+ SCM d = me->get_property ("direction");
if (is_direction (d) && to_dir (d))
return to_dir (d);
Direction relative_dir = Direction (1);
- SCM reldir = me->get_grob_property ("side-relative-direction"); // should use a lambda.
+ SCM reldir = me->get_property ("side-relative-direction"); // should use a lambda.
if (is_direction (reldir))
{
relative_dir = to_dir (reldir);
}
- SCM other_elt = me->get_grob_property ("direction-source");
+ SCM other_elt = me->get_property ("direction-source");
Grob * e = unsmob_grob (other_elt);
if (e)
{
- return (Direction) (relative_dir * Directional_element_interface::get (e));
+ return (Direction) (relative_dir * get_grob_direction (e));
}
return CENTER;
Side_position_interface::aligned_on_support_extents (SCM element_smob, SCM axis)
{
Grob *me = unsmob_grob (element_smob);
- Axis a = (Axis) gh_scm2int (axis);
+ Axis a = (Axis) scm_to_int (axis);
return general_side_position (me, a, true);
}
-/*
- Puts the element next to the support, optionally taking in
- account the extent of the support.
-*/
+/* Put the element next to the support, optionally taking in
+ account the extent of the support. */
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)
{
-
-
- /*
- As this is only used as a callback, this is called only once. We
- could wipe SIDE-SUPPORT-ELEMENTS after we retrieve it to conserve
- memory; however -- we should look more into benefits of such actions?
-
- The benefit is small, it seems: total GC times taken don't
- differ. Would this also hamper Generational GC ?
-
- */
- SCM support = me->get_grob_property ("side-support-elements");
+ Real ss = Staff_symbol_referencer::staff_space (me);
+ SCM support = me->get_property ("side-support-elements");
Grob *common = common_refpoint_of_list (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")));
+
Interval dim;
- for (SCM s = support; s != SCM_EOL; s = ly_cdr (s))
+ if (include_staff)
+ {
+ common = st->common_refpoint (common, Y_AXIS);
+ dim = st->extent (common, Y_AXIS);
+ }
+
+ for (SCM s = support; s != SCM_EOL; s = scm_cdr (s))
{
- Grob * e = unsmob_grob (ly_car (s));
+ Grob *e = unsmob_grob (scm_car (s));
if (e)
if (use_extents)
dim.unite (e->extent (common, a));
}
}
- if (dim.empty_b ())
- {
- dim = Interval (0,0);
- }
+ if (dim.is_empty ())
+ dim = Interval (0, 0);
Direction dir = Side_position_interface::get_direction (me);
- Real off = me->get_parent (a)->relative_coordinate (common, a);
- SCM minimum = me->get_grob_property ("minimum-space");
+ Real off = me->get_parent (a)->relative_coordinate (common, a);
+ Real minimum_space = ss * robust_scm2double (me->get_property ("minimum-space"), -1);
Real total_off = dim.linear_combination (dir) - off;
- SCM padding = me->get_grob_property ("padding");
- if (gh_number_p (padding))
- {
- total_off += gh_scm2double (padding) * dir;
- }
+ total_off += dir * ss * robust_scm2double (me->get_property ("padding"), 0);
- if (gh_number_p (minimum)
+ if (minimum_space >= 0
&& dir
- && total_off * dir < gh_scm2double (minimum))
- {
- total_off = gh_scm2double (minimum) * dir;
- }
+ && total_off * dir < minimum_space)
+ total_off = minimum_space * dir;
+ /* FIXME: 100CM should relate to paper size. */
if (fabs (total_off) > 100 CM)
- programming_error ("Huh ? Improbable staff side dim.");
-
- return gh_double2scm (total_off);
+ {
+ String msg
+ = String_convert::form_string ("Improbable offset for grob %s: %f%s",
+ me->name ().to_str0 (), total_off,
+ INTERNAL_UNIT);
+
+ programming_error (msg);
+ }
+ return scm_make_real (total_off);
}
/*
Side_position_interface::aligned_on_support_refpoints (SCM smob, SCM axis)
{
Grob *me = unsmob_grob (smob);
- Axis a = (Axis) gh_scm2int (axis);
+ Axis a = (Axis) scm_to_int (axis);
- return general_side_position (me, a, false);
+ return general_side_position (me, a, false);
}
Real rad = Staff_symbol_referencer::staff_radius (me) *2 ;
int ip = int (rp);
- if (abs (ip) <= rad && Staff_symbol_referencer::on_staffline (me,ip))
+ 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;
}
-
- return gh_double2scm ((rp - p) * Staff_symbol_referencer::staff_space (me) / 2.0);
+
+ return scm_make_real ((rp - p) * Staff_symbol_referencer::staff_space (me) / 2.0);
}
- return gh_double2scm (0.0);
+ return scm_make_real (0.0);
}
/*
Side_position_interface::aligned_side (SCM element_smob, SCM axis)
{
Grob *me = unsmob_grob (element_smob);
- Axis a = (Axis) gh_scm2int (axis);
+ Axis a = (Axis) scm_to_int (axis);
Direction d = Side_position_interface::get_direction (me);
- Real o = gh_scm2double (aligned_on_support_extents (element_smob,axis));
+ Real o = scm_to_double (aligned_on_support_extents (element_smob,axis));
Interval iv = me->extent (me, a);
- if (!iv.empty_b ())
+ if (!iv.is_empty ())
{
if (!d)
{
}
o += - iv[-d];
}
- return gh_double2scm (o);
-}
-/*
+ /*
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.
*/
-MAKE_SCHEME_CALLBACK (Side_position_interface,out_of_staff,2);
-SCM
-Side_position_interface::out_of_staff (SCM element_smob, SCM axis)
-{
- Grob *me = unsmob_grob (element_smob);
- Axis a = (Axis) gh_scm2int (axis);
-
Grob * st = Staff_symbol_referencer::get_staff_symbol (me);
-
- if (!st)
- return gh_int2scm (0);
-
- Real padding=0.0;
- SCM spad = me->get_grob_property ("staff-padding");
-
- if (gh_number_p (spad))
- padding = gh_scm2double (spad);
-
- Grob *common = me->common_refpoint (st, Y_AXIS);
- Direction d = Side_position_interface::get_direction (me);
- Interval staff_size = st->extent (common, Y_AXIS);
- Interval me_ext = me->extent (common, a);
- Real diff = d*staff_size[d] + padding - d*me_ext[-d];
- return gh_double2scm (diff >? 0);
-}
-
-void
-Side_position_interface::add_staff_support (Grob*me)
-{
- Grob* st = Staff_symbol_referencer::get_staff_symbol (me);
- if (st && get_axis (me) == Y_AXIS)
+ if (st && a == Y_AXIS
+ && scm_is_number (me->get_property ("staff-padding")))
{
- add_support (me,st);
+ Real padding=
+ Staff_symbol_referencer::staff_space (me)
+ * scm_to_double (me->get_property ("staff-padding"));
+
+ Grob *common = me->common_refpoint (st, Y_AXIS);
+
+ Interval staff_size = st->extent (common, Y_AXIS);
+ Real diff = d*staff_size[d] + padding - d*(o + iv[-d]);
+ o += (d* (diff >? 0));
}
+
+ return scm_make_real (o);
}
+
void
Side_position_interface::set_axis (Grob*me, Axis a)
{
me->add_offset_callback (Side_position_interface::aligned_side_proc, a);
}
-
-
-// ugh. doesn't cactch all variants.
+// ugh. doesn't catch all variants.
Axis
Side_position_interface::get_axis (Grob*me)
{
- if (me->has_offset_callback_b (Side_position_interface::aligned_side_proc, X_AXIS)
- || me->has_offset_callback_b (Side_position_interface::aligned_side_proc , X_AXIS))
+ 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;
}
-void
-Side_position_interface::set_direction (Grob*me, Direction d)
-{
- me->set_grob_property ("direction", gh_int2scm (d));
-}
-
-void
-Side_position_interface::set_minimum_space (Grob*me, Real m)
-{
- me->set_grob_property ("minimum-space", gh_double2scm (m));
-}
-
-void
-Side_position_interface::set_padding (Grob*me, Real p)
-{
- me->set_grob_property ("padding", gh_double2scm (p));
-}
-
-
-bool
-Side_position_interface::supported_b (Grob*me)
-{
- SCM s = me->get_grob_property ("side-support-elements");
- return gh_pair_p (s);
-}
-
-
-
ADD_INTERFACE (Side_position_interface,"side-position-interface",
- "Position a victim object (this one) next to other objects (the "
-"support). In this case, the property @code{direction} signifies where to put the "
-"victim object relative to the support (left or right, up or down?) "
-,
- "staff-padding side-support-elements direction-source direction side-relative-direction minimum-space padding");
+ "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."
+ ,
+ "staff-padding side-support-elements direction-source "
+ "direction side-relative-direction minimum-space padding");
projects / lilypond.git / blobdiff