X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fside-position-interface.cc;h=f5f51bced2259832f7de93266bfa28a421780ae2;hb=ebe3e7dfa38d450fcf05298224949ad57da45668;hp=d5e9a4f0f3d96be24f5c56b586aaa135e427f149;hpb=7aabfb20c46e0a1de41698ddc6859ccd3a6dea85;p=lilypond.git diff --git a/lily/side-position-interface.cc b/lily/side-position-interface.cc index d5e9a4f0f3..f5f51bced2 100644 --- a/lily/side-position-interface.cc +++ b/lily/side-position-interface.cc @@ -1,309 +1,249 @@ -/* - staff-side.cc -- implement Staff_side_element - +/* + side-position-interface.cc -- implement Side_position_interface + source file of the GNU LilyPond music typesetter - - (c) 1998--2003 Han-Wen Nienhuys - - */ -#include // ceil. + + (c) 1998--2006 Han-Wen Nienhuys +*/ #include "side-position-interface.hh" + +#include // ceil. +#include +using namespace std; + +#include "note-head.hh" #include "warn.hh" -#include "warn.hh" -#include "dimensions.hh" +#include "main.hh" #include "staff-symbol-referencer.hh" -#include "group-interface.hh" +#include "pointer-group-interface.hh" #include "directional-element-interface.hh" +#include "staff-symbol-referencer.hh" +#include "staff-symbol.hh" +#include "string-convert.hh" +#include "misc.hh" void -Side_position_interface::add_support (Grob*me, Grob*e) +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) +Side_position_interface::get_direction (Grob *me) { - SCM d = me->get_grob_property ("direction"); - if (ly_dir_p (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. - if (ly_dir_p (reldir)) - { - relative_dir = to_dir (reldir); - } - - SCM other_elt = me->get_grob_property ("direction-source"); - Grob * e = unsmob_grob (other_elt); + SCM reldir = me->get_property ("side-relative-direction"); + if (is_direction (reldir)) + relative_dir = to_dir (reldir); + + SCM other_elt = me->get_object ("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; } - -MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_extents, 2); +/* Put the element next to the support, optionally taking in + account the extent of the support. */ SCM -Side_position_interface::aligned_on_support_extents (SCM element_smob, SCM axis) +Side_position_interface::general_side_position (Grob *me, Axis a, bool use_extents) { - Grob *me = unsmob_grob (element_smob); - Axis a = (Axis) gh_scm2int (axis); + Real ss = Staff_symbol_referencer::staff_space (me); - return general_side_position (me, a, true); -} + extract_grob_set (me, "side-support-elements", support); + Grob *common = common_refpoint_of_array (support, me->get_parent (a), a); + 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")); -/* - Puts 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) -{ - + Interval dim; + Interval staff_extents; + if (include_staff) + { + common = staff_symbol->common_refpoint (common, Y_AXIS); + staff_extents = staff_symbol->extent (common, Y_AXIS); - /* - 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? + if (include_staff) + dim.unite (staff_extents); + } - 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"); - Grob *common = common_refpoint_of_list (support, me->get_parent (a), a); - - Interval dim; - for (SCM s = support; s != SCM_EOL; s = ly_cdr (s)) + for (vsize i = 0; i < support.size (); i++) { - Grob * e = unsmob_grob (ly_car (s)); + Grob *e = support[i]; if (e) if (use_extents) dim.unite (e->extent (common, a)); else { Real x = e->relative_coordinate (common, a); - dim.unite (Interval (x,x)); + dim.unite (Interval (x, x)); } } - if (dim.empty_b ()) - { - dim = Interval (0,0); - } + if (dim.is_empty ()) + dim = Interval (0, 0); + + Direction dir = get_grob_direction (me); - 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 * dir < minimum_space) + total_off = minimum_space * dir; + + /* FIXME: 1000 should relate to paper size. */ + if (fabs (total_off) > 1000) { - total_off = gh_scm2double (minimum) * dir; - } - - if (fabs (total_off) > 100 CM) - programming_error ("Huh ? Improbable staff side dim."); + string msg + = String_convert::form_string ("Improbable offset for grob %s: %f", + me->name ().c_str (), total_off); - return gh_double2scm (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) gh_scm2int (axis); - - return general_side_position (me, a, false); + return general_side_position (unsmob_grob (smob), Y_AXIS, false); } +/* + Position next to support, taking into account my own dimensions and padding. +*/ -Real -directed_round (Real f, Direction d) +MAKE_SCHEME_CALLBACK (Side_position_interface, x_aligned_side, 1); +SCM +Side_position_interface::x_aligned_side (SCM smob) { - if (d < 0) - return floor (f); - else - return ceil (f); + return aligned_side (unsmob_grob (smob), X_AXIS); } -/* - 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); +MAKE_SCHEME_CALLBACK (Side_position_interface, y_aligned_side, 1); SCM -Side_position_interface::quantised_position (SCM element_smob, SCM) +Side_position_interface::y_aligned_side (SCM smob) { - Grob *me = unsmob_grob (element_smob); - - Direction d = Side_position_interface::get_direction (me); - - Grob * stsym = Staff_symbol_referencer::get_staff_symbol (me); - if (stsym) - { - 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); - - if (abs (ip) <= rad && Staff_symbol_referencer::on_staffline (me,ip)) - { - ip += d; - rp += d; - } - - return gh_double2scm ((rp - p) * Staff_symbol_referencer::staff_space (me) / 2.0); - } - return gh_double2scm (0.0); + return aligned_side (unsmob_grob (smob), Y_AXIS); } -/* - Position next to support, taking into account my own dimensions and padding. - */ -MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_side,2); SCM -Side_position_interface::aligned_side (SCM element_smob, SCM axis) +Side_position_interface::aligned_side (Grob *me, Axis a) { - Grob *me = unsmob_grob (element_smob); - Axis a = (Axis) gh_scm2int (axis); - - Direction d = Side_position_interface::get_direction (me); - - Real o = gh_scm2double (aligned_on_support_extents (element_smob,axis)); + Direction dir = get_grob_direction (me); - Interval iv = me->extent (me, a); + Real o = scm_to_double (general_side_position (me, a, true)); + Interval iv = me->extent (me, a); - if (!iv.empty_b ()) + if (!iv.is_empty ()) { - if (!d) + if (!dir) { - programming_error ("Direction unknown, but aligned-side wanted."); - d = DOWN; + programming_error ("direction unknown, but aligned-side wanted"); + dir = DOWN; } - o += - iv[-d]; + o += -iv[-dir]; } - 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); + /* + 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 *staff = Staff_symbol_referencer::get_staff_symbol (me); + if (staff && a == Y_AXIS) + { + if (to_boolean (me->get_property ("quantize-position"))) + { + Grob *common = me->common_refpoint (staff, Y_AXIS); + Real my_off = me->relative_coordinate (common, Y_AXIS); + Real staff_off = staff->relative_coordinate (common, Y_AXIS); + 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 (rounded <= 2 * Staff_symbol_referencer::staff_radius (me) + || (Note_head::has_interface (head) + && sign (Staff_symbol_referencer::get_position (head)) == - dir)) + { + 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"))) + { + Real padding + = Staff_symbol_referencer::staff_space (me) + * scm_to_double (me->get_property ("staff-padding")); - Real padding=0.0; - SCM spad = me->get_grob_property ("staff-padding"); + Grob *common = me->common_refpoint (staff, Y_AXIS); - 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); + Interval staff_size = staff->extent (common, Y_AXIS); + 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::add_staff_support (Grob*me) +Side_position_interface::set_axis (Grob *me, Axis a) { - Grob* st = Staff_symbol_referencer::get_staff_symbol (me); - if (st && get_axis (me) == Y_AXIS) + if (!scm_is_number (me->get_property ("side-axis"))) { - add_support (me,st); + me->set_property ("side-axis", scm_from_int (a)); + add_offset_callback (me, + (a==X_AXIS) + ? x_aligned_side_proc + : y_aligned_side_proc, + a); } } - -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. Axis -Side_position_interface::get_axis (Grob*me) +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)) - return X_AXIS; - + if (scm_is_number (me->get_property ("side-axis"))) + return Axis (scm_to_int (me->get_property ("side-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 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"); + me->programming_error ("side-axis not set."); + 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.", + + /* properties */ + "direction " + "direction-source " + "minimum-space " + "padding " + "quantize-position " + "side-axis " + "side-relative-direction " + "side-support-elements " + "slur-padding " + "staff-padding " + );