X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fside-position-interface.cc;h=2e83ee183c082527306229df7f1c409f2a85f741;hb=f9214bac21e9926dc3248416f58190c98c4167a9;hp=9ad3f6f3c4e0a2499245fd959f10196bbf0571a9;hpb=9b40d66187029df3dca86fc5ecc65f64db315a48;p=lilypond.git diff --git a/lily/side-position-interface.cc b/lily/side-position-interface.cc index 9ad3f6f3c4..0d56fe1868 100644 --- a/lily/side-position-interface.cc +++ b/lily/side-position-interface.cc @@ -1,291 +1,298 @@ -/* - 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--2000 Han-Wen Nienhuys - - */ -#include // ceil. + + (c) 1998--2007 Han-Wen Nienhuys +*/ #include "side-position-interface.hh" -#include "debug.hh" + +#include // ceil. +#include +using namespace std; + +#include "note-head.hh" #include "warn.hh" -#include "dimensions.hh" +#include "main.hh" +#include "staff-symbol-referencer.hh" +#include "pointer-group-interface.hh" +#include "directional-element-interface.hh" #include "staff-symbol-referencer.hh" -#include "group-interface.hh" +#include "staff-symbol.hh" +#include "string-convert.hh" +#include "misc.hh" +#include "grob.hh" void -Side_position::add_support (Score_element*me, Score_element*e) +Side_position_interface::add_support (Grob *me, Grob *e) { - Pointer_group_interface (me, "side-support-elements").add_element (e); + Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("side-support-elements"), e); } - - Direction -Side_position::get_direction (Score_element*me) +Side_position_interface::get_direction (Grob *me) { - SCM d = me->get_elt_property ("direction"); - if (isdir_b (d)) - return to_dir (d) ? to_dir (d) : DOWN; + Direction relative_dir = Direction (1); + SCM reldir = me->get_property ("side-relative-direction"); + if (is_direction (reldir)) + relative_dir = to_dir (reldir); - Direction relative_dir = UP; - SCM reldir = me->get_elt_property ("side-relative-direction"); // should use a lambda. - if (isdir_b (reldir)) - { - relative_dir = to_dir (reldir); - } - - SCM other_elt = me->get_elt_property ("direction-source"); - Score_element * e = unsmob_element(other_elt); + SCM other_elt = me->get_object ("direction-source"); + Grob *e = unsmob_grob (other_elt); if (e) - { - return (Direction)(relative_dir * Side_position::get_direction (e)); - } - - return DOWN; + return (Direction) (relative_dir * get_grob_direction (e)); + + return CENTER; } - -/* - Callback that does the aligning. Puts the element next to the support - */ -MAKE_SCHEME_CALLBACK(Side_position,side_position,2); +/* Put the element next to the support, optionally taking in + account the extent of the support. + + Does not take into account the extent of ME. +*/ SCM -Side_position::side_position (SCM element_smob, SCM axis) +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) { - Score_element *me = unsmob_element (element_smob); - Axis a = (Axis) gh_scm2int (axis); + 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 *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")); - Score_element *common = me->parent_l (a); - SCM support = me->get_elt_property ("side-support-elements"); - for (SCM s = support; s != SCM_EOL; s = gh_cdr (s)) - { - Score_element * e = unsmob_element (gh_car (s)); - if (e) - common = common->common_refpoint (e, a); - } - Interval dim; - for (SCM s = support; s != SCM_EOL; s = gh_cdr (s)) + Interval staff_extents; + if (include_staff) { + common = staff_symbol->common_refpoint (common, Y_AXIS); + staff_extents = staff_symbol->maybe_pure_extent (common, Y_AXIS, pure, start, end); - Score_element * e = unsmob_element ( gh_car (s)); - if (e) - { - Real coord = e->relative_coordinate (common, a); - - dim.unite (coord + e->extent (a)); - } + if (include_staff) + dim.unite (staff_extents); } - if (dim.empty_b ()) + for (vsize i = 0; i < support.size (); i++) { - dim = Interval(0,0); + Grob *e = support[i]; + if (e) + 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)); + } } - Direction dir = Side_position::get_direction (me); - - Real off = me->parent_l (a)->relative_coordinate (common, a); - SCM minimum = me->remove_elt_property ("minimum-space"); + if (dim.is_empty ()) + dim = Interval (0, 0); - Real total_off = dim[dir] + off; - SCM padding = me->remove_elt_property ("padding"); - if (gh_number_p (padding)) - { - total_off += gh_scm2double (padding) * dir; - } - if (gh_number_p (minimum) && total_off * dir < gh_scm2double (minimum)) - { - total_off = gh_scm2double (minimum) * dir; - } - if (fabs (total_off) > 100 CM) - programming_error ("Huh ? Improbable staff side dim."); + Direction dir = get_grob_direction (me); - return gh_double2scm (total_off); -} + 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); -/** - callback that centers the element on itself - */ -MAKE_SCHEME_CALLBACK(Side_position,aligned_on_self,2); -SCM -Side_position::aligned_on_self (SCM element_smob, SCM axis) -{ - Score_element *me = unsmob_element (element_smob); - Axis a = (Axis) gh_scm2int (axis); - String s ("self-alignment-"); + Real total_off = dim.linear_combination (dir) - off; + total_off += dir * ss * robust_scm2double (me->get_property ("padding"), 0); - s += (a == X_AXIS) ? "X" : "Y"; + if (minimum_space >= 0 + && dir + && total_off * dir < minimum_space) + total_off = minimum_space * dir; - SCM align (me->get_elt_property (s.ch_C())); - if (gh_number_p (align)) + if (include_my_extent) { - Interval ext(me->extent (a)); - - if (ext.empty_b ()) - { - programming_error ("I'm empty. Can't align on self"); - return gh_double2scm (0.0); - } - else + Interval iv = me->maybe_pure_extent (me, a, pure, start, end); + if (!iv.is_empty ()) { - Real lambda = (0.5 - gh_scm2double (align) / 2.0); - return gh_double2scm (- (lambda * ext[LEFT] + (1 - lambda) * ext[RIGHT])); + if (!dir) + { + programming_error ("direction unknown, but aligned-side wanted"); + dir = DOWN; + } + total_off += -iv[-dir]; } } - else if (unsmob_element (align)) + + 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) { - return gh_double2scm (- unsmob_element (align)->relative_coordinate (me, a)); + 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 gh_double2scm (0.0); + return scm_from_double (total_off); } - -Real -directed_round (Real f, Direction d) +MAKE_SCHEME_CALLBACK (Side_position_interface, y_aligned_on_support_refpoints, 1); +SCM +Side_position_interface::y_aligned_on_support_refpoints (SCM smob) { - if (d < 0) - return floor (f); - else - return ceil (f); + return general_side_position (unsmob_grob (smob), Y_AXIS, false, false, false, 0, 0, 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,quantised_position,2); +MAKE_SCHEME_CALLBACK (Side_position_interface, pure_y_aligned_on_support_refpoints, 3); SCM -Side_position::quantised_position (SCM element_smob, SCM ) +Side_position_interface::pure_y_aligned_on_support_refpoints (SCM smob, SCM start, SCM end) { - Score_element *me = unsmob_element (element_smob); - - - Direction d = Side_position::get_direction (me); - - if (Staff_symbol_referencer::has_interface (me)) - { - Real p = Staff_symbol_referencer::position_f (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 general_side_position (unsmob_grob (smob), Y_AXIS, false, false, + true, scm_to_int (start), scm_to_int (end), 0); } + /* Position next to support, taking into account my own dimensions and padding. - */ -MAKE_SCHEME_CALLBACK(Side_position,aligned_side,2); +*/ SCM -Side_position::aligned_side (SCM element_smob, SCM axis) +axis_aligned_side_helper (SCM smob, Axis a, bool pure, int start, int end, SCM current_off_scm) { - Score_element *me = unsmob_element (element_smob); - Axis a = (Axis) gh_scm2int (axis); - - Direction d = Side_position::get_direction (me); - Real o = gh_scm2double (side_position (element_smob,axis)); - - Interval iv = me->extent (a); - - if (!iv.empty_b ()) + Real r; + Real *current_off_ptr = 0; + if (scm_is_number (current_off_scm)) { - o += - iv[-d]; - - SCM pad = me->get_elt_property ("padding"); - if (gh_number_p (pad)) - o += d *gh_scm2double (pad) ; + r = scm_to_double (current_off_scm); + current_off_ptr = &r; } - return gh_double2scm (o); + + return Side_position_interface::aligned_side (unsmob_grob (smob), a, pure, start, end, current_off_ptr); } -/* - Position centered on parent. - */ -MAKE_SCHEME_CALLBACK(Side_position,centered_on_parent,2); + +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, x_aligned_side, 2, 1); SCM -Side_position::centered_on_parent (SCM element_smob, SCM axis) +Side_position_interface::x_aligned_side (SCM smob, SCM current_off) { - Score_element *me = unsmob_element (element_smob); - Axis a = (Axis) gh_scm2int (axis); - Score_element *him = me->parent_l (a); - - return gh_double2scm (him->extent (a).center ()); + return axis_aligned_side_helper (smob, X_AXIS, false, 0, 0, current_off); } - -void -Side_position::add_staff_support (Score_element*me) +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) { - Score_element* st = Staff_symbol_referencer::staff_symbol_l (me); - if (st) - { - add_support (me,st); - } + return axis_aligned_side_helper (smob, Y_AXIS, false, 0, 0, current_off); } -void -Side_position::set_axis (Score_element*me, Axis a) +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) { - me->add_offset_callback (Side_position::aligned_side_proc, a); + return axis_aligned_side_helper (smob, Y_AXIS, true, + scm_to_int (start), + scm_to_int (end), + cur_off); } - - -// ugh. doesn't cactch all variants. -Axis -Side_position::get_axis (Score_element*me) +SCM +Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, int end, + Real *current_off) { - if (me->has_offset_callback_b (Side_position::aligned_side_proc, X_AXIS) - || me->has_offset_callback_b (Side_position::aligned_side_proc , X_AXIS)) - return X_AXIS; + Direction dir = get_grob_direction (me); - - return Y_AXIS; -} + Real o = scm_to_double (general_side_position (me, a, true, true, pure, start, end, current_off)); -void -Side_position::set_direction (Score_element*me, Direction d) -{ - me->set_elt_property ("direction", gh_int2scm (d)); -} + /* + 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->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 + || (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"))) + { + 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")); -void -Side_position::set_minimum_space (Score_element*me, Real m) -{ - me->set_elt_property ("minimum-space", gh_double2scm (m)); -} + Grob *common = me->common_refpoint (staff, Y_AXIS); -void -Side_position::set_padding (Score_element*me, Real p) -{ - me->set_elt_property ("padding", gh_double2scm (p)); + 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); } -bool -Side_position::has_interface (Score_element*me) +void +Side_position_interface::set_axis (Grob *me, Axis a) { - return me->has_interface (ly_symbol2scm ("side-position-interface")); + 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); + } } - -bool -Side_position::supported_b (Score_element*me) +Axis +Side_position_interface::get_axis (Grob *me) { - SCM s = me->get_elt_property ("side-support-elements"); - return gh_pair_p(s); + if (scm_is_number (me->get_property ("side-axis"))) + return Axis (scm_to_int (me->get_property ("side-axis"))); + + me->programming_error ("side-axis not set."); + return NO_AXES; } - +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 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 " + );