X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fside-position-interface.cc;h=16e2929a6699001fd029f7e43548097ec62031c6;hb=074edde46fd433dbf52c482f3b087e80587db001;hp=e68aaf660a4456b815870e6a2dfc76acdbd01cfc;hpb=667d9bdb6227dd10819599c6d069a5eeb67eedd7;p=lilypond.git diff --git a/lily/side-position-interface.cc b/lily/side-position-interface.cc index e68aaf660a..16e2929a66 100644 --- a/lily/side-position-interface.cc +++ b/lily/side-position-interface.cc @@ -1,281 +1,504 @@ -/* - staff-side.cc -- implement Staff_side_element - - source file of the GNU LilyPond music typesetter - - (c) 1998--2002 Han-Wen Nienhuys - - */ -#include // ceil. +/* + This file is part of LilyPond, the GNU music typesetter. + + Copyright (C) 1998--2015 Han-Wen Nienhuys + + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ #include "side-position-interface.hh" -#include "debug.hh" -#include "warn.hh" -#include "dimensions.hh" -#include "staff-symbol-referencer.hh" -#include "group-interface.hh" + +#include // ceil. +#include +#include +#include + +using namespace std; + +#include "accidental-interface.hh" +#include "accidental-placement.hh" +#include "axis-group-interface.hh" #include "directional-element-interface.hh" +#include "grob.hh" +#include "grob-array.hh" +#include "international.hh" +#include "item.hh" +#include "main.hh" +#include "misc.hh" +#include "note-head.hh" +#include "note-column.hh" +#include "pointer-group-interface.hh" +#include "skyline-pair.hh" +#include "staff-symbol-referencer.hh" +#include "staff-symbol.hh" +#include "stem.hh" +#include "string-convert.hh" +#include "system.hh" +#include "warn.hh" +#include "unpure-pure-container.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); + Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("side-support-elements"), e); } - - -Direction -Side_position_interface::get_direction (Grob*me) +set +get_support_set (Grob *me) { - SCM d = me->get_grob_property ("direction"); - if (ly_dir_p (d) && to_dir (d)) - return to_dir (d); + // Only slightly kludgy heuristic... + // We want to make sure that all AccidentalPlacements' + // accidentals make it into the side support + extract_grob_set (me, "side-support-elements", proto_support); + set support; - Direction relative_dir = Direction (1); - SCM reldir = me->get_grob_property ("side-relative-direction"); // should use a lambda. - if (ly_dir_p (reldir)) + for (vsize i = 0; i < proto_support.size (); i++) { - relative_dir = to_dir (reldir); + if (has_interface (proto_support[i])) + { + Grob *accs = proto_support[i]; + for (SCM acs = accs->get_object ("accidental-grobs"); scm_is_pair (acs); + acs = scm_cdr (acs)) + for (SCM s = scm_cdar (acs); scm_is_pair (s); s = scm_cdr (s)) + { + Grob *a = unsmob (scm_car (s)); + support.insert (a); + } + } + else + support.insert (proto_support[i]); } - - SCM other_elt = me->get_grob_property ("direction-source"); - Grob * e = unsmob_grob (other_elt); - if (e) + return support; +} + +/* + Position next to support, taking into account my own dimensions and padding. +*/ +SCM +axis_aligned_side_helper (SCM smob, Axis a, bool pure, int start, int end, SCM current_off_scm) +{ + Real r; + Real *current_off_ptr = 0; + if (scm_is_number (current_off_scm)) { - return (Direction) (relative_dir * Directional_element_interface::get (e)); + r = scm_to_double (current_off_scm); + current_off_ptr = &r; } - - return CENTER; + + Grob *me = unsmob (smob); + // We will only ever want widths of spanners after line breaking + // so we can set pure to false + if (dynamic_cast (me) && a == X_AXIS) + pure = false; + + return Side_position_interface::aligned_side (me, a, pure, start, end, current_off_ptr); } - -MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_extents, 2); +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, x_aligned_side, 2, 1, ""); SCM -Side_position_interface::aligned_on_support_extents (SCM element_smob, SCM axis) +Side_position_interface::x_aligned_side (SCM smob, SCM current_off) { - Grob *me = unsmob_grob (element_smob); - Axis a = (Axis) gh_scm2int (axis); - - return general_side_position (me, a, true); + // Because horizontal skylines need vertical heights, we'd trigger + // unpure calculations too soon if this were called before line breaking. + // So, we always use pure heights. Given that horizontal skylines are + // almost always used before line breaking anyway, this doesn't cause + // problems. + return axis_aligned_side_helper (smob, X_AXIS, true, 0, 0, current_off); } +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) +{ + return axis_aligned_side_helper (smob, Y_AXIS, false, 0, 0, current_off); +} -/* - Puts the element next to the support, optionally taking in - account the extent of the support. -*/ +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, pure_y_aligned_side, 4, 1, ""); SCM -Side_position_interface::general_side_position (Grob * me, Axis a, bool use_extents) +Side_position_interface::pure_y_aligned_side (SCM smob, SCM start, SCM end, SCM cur_off) { + return axis_aligned_side_helper (smob, Y_AXIS, true, + scm_to_int (start), + scm_to_int (end), + cur_off); +} +MAKE_SCHEME_CALLBACK (Side_position_interface, calc_cross_staff, 1) +SCM +Side_position_interface::calc_cross_staff (SCM smob) +{ + Grob *me = unsmob (smob); + extract_grob_set (me, "side-support-elements", elts); - /* - 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? + Direction my_dir = get_grob_direction (me) ; - 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 < elts.size (); i++) { - Grob * e = unsmob_grob (ly_car (s)); - if (e) - if (use_extents) - dim.unite (e->extent (common, a)); - else - { - Real x = e->relative_coordinate (common, a); - dim.unite (Interval (x,x)); - } + /* + If 'me' is placed relative to any cross-staff element with a + 'direction callback defined, the placement of 'me' is likely + to depend on staff-spacing, thus 'me' should be considered + cross-staff. + */ + if (to_boolean (elts[i]->get_property ("cross-staff")) + && !is_direction (elts[i]->get_property_data ("direction"))) + return SCM_BOOL_T; + + /* + If elts[i] is cross-staff and is pointing in the same + direction as 'me', we assume that the alignment + of 'me' is influenced the cross-staffitude of elts[i] + and thus we mark 'me' as cross-staff. + */ + if (to_boolean (elts[i]->get_property ("cross-staff")) + && my_dir == get_grob_direction (elts[i])) + return SCM_BOOL_T; } - if (dim.empty_b ()) + Grob *myvag = Grob::get_vertical_axis_group (me); + for (vsize i = 0; i < elts.size (); i++) + if (myvag != Grob::get_vertical_axis_group (elts[i])) + return SCM_BOOL_T; + + return SCM_BOOL_F; +} + +// long function - each stage is clearly marked + +SCM +Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, int end, + Real *current_off) +{ + Direction dir = get_grob_direction (me); + + set support = get_support_set (me); + + Grob *common[2]; + for (Axis ax = X_AXIS; ax < NO_AXES; incr (ax)) + common[ax] = common_refpoint_of_array (support, + (ax == a + ? me->get_parent (ax) + : me), + ax); + + Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (me); + bool quantize_position = to_boolean (me->get_maybe_pure_property ("quantize-position", pure, start, end)); + bool me_cross_staff = to_boolean (me->get_property ("cross-staff")); + + bool include_staff + = staff_symbol + && a == Y_AXIS + && scm_is_number (me->get_maybe_pure_property ("staff-padding", pure, start, end)) + && !quantize_position; + + if (include_staff) + common[Y_AXIS] = staff_symbol->common_refpoint (common[Y_AXIS], Y_AXIS); + + Skyline my_dim; + SCM skyp = me->get_maybe_pure_property (a == X_AXIS + ? "horizontal-skylines" + : "vertical-skylines", + pure, + start, + end); + if (unsmob (skyp)) { - dim = Interval (0,0); + // for spanner pure heights, we don't know horizontal spacing, + // so a spanner can never have a meaningful x coordiante + // we just give it the parents' coordinate because its + // skyline will likely be of infinite width anyway + // and we don't want to prematurely trigger H spacing + Real xc = a == X_AXIS || (pure && dynamic_cast (me)) + ? me->get_parent (X_AXIS)->relative_coordinate (common[X_AXIS], X_AXIS) + : me->relative_coordinate (common[X_AXIS], X_AXIS); + // same here, for X_AXIS spacing, if it's happening, it should only be + // before line breaking. because there is no thing as "pure" x spacing, + // we assume that it is all pure + Real yc = a == X_AXIS + ? me->pure_relative_y_coordinate (common[Y_AXIS], start, end) + : me->get_parent (Y_AXIS)->maybe_pure_coordinate (common[Y_AXIS], Y_AXIS, pure, start, end); + Skyline_pair copy = *unsmob (skyp); + copy.shift (a == X_AXIS ? yc : xc); + copy.raise (a == X_AXIS ? xc : yc); + my_dim = copy[-dir]; } + else + me->warning ("cannot find skylines - strange alignment will follow"); + - Direction dir = Side_position_interface::get_direction (me); - - Real off = me->get_parent (a)->relative_coordinate (common, a); - SCM minimum = me->remove_grob_property ("minimum-space"); + vector boxes; + vector skyps; + set::iterator it; - Real total_off = dim.linear_combination (dir) + off; - SCM padding = me->remove_grob_property ("padding"); - if (gh_number_p (padding)) + for (it = support.begin (); it != support.end (); it++) { - total_off += gh_scm2double (padding) * dir; + Grob *e = *it; + + bool cross_staff = to_boolean (e->get_property ("cross-staff")); + if (a == Y_AXIS + && !me_cross_staff // 'me' promised not to adapt to staff-spacing + && cross_staff) // but 'e' might move based on staff-pacing + continue; // so 'me' may not move in response to 'e' + + if (a == Y_AXIS + && has_interface (e)) + { + // If called as 'pure' we may not force a stem to set its direction, + if (pure && !is_direction (e->get_property_data ("direction"))) + continue; + // There is no need to consider stems pointing away. + if (dir == -get_grob_direction (e)) + continue; + } + + if (e) + { + SCM sp = e->get_maybe_pure_property (a == X_AXIS + ? "horizontal-skylines" + : "vertical-skylines", + pure, + start, + end); + + if (unsmob (sp)) + { + Real xc = pure && dynamic_cast (e) + ? e->get_parent (X_AXIS)->relative_coordinate (common[X_AXIS], X_AXIS) + : e->relative_coordinate (common[X_AXIS], X_AXIS); + // same logic as above + // we assume horizontal spacing is always pure + Real yc = a == X_AXIS + ? e->pure_relative_y_coordinate (common[Y_AXIS], start, end) + : e->maybe_pure_coordinate (common[Y_AXIS], Y_AXIS, pure, start, end); + Skyline_pair copy = *unsmob (sp); + if (a == Y_AXIS + && has_interface (e) + && to_boolean (me->get_maybe_pure_property ("add-stem-support", pure, start, end))) + copy[dir].set_minimum_height (copy[dir].max_height ()); + copy.shift (a == X_AXIS ? yc : xc); + copy.raise (a == X_AXIS ? xc : yc); + skyps.push_back (copy); + } + else { /* no warning*/ } + } } - if (gh_number_p (minimum) - && dir - && total_off * dir < gh_scm2double (minimum)) + Skyline dim (boxes, other_axis (a), dir); + if (skyps.size ()) { - total_off = gh_scm2double (minimum) * dir; + Skyline_pair merged (skyps); + dim.merge (merged[dir]); } - if (fabs (total_off) > 100 CM) - programming_error ("Huh ? Improbable staff side dim."); - - return gh_double2scm (total_off); -} - -/* - Cut & paste (ugh.) - */ -MAKE_SCHEME_CALLBACK (Side_position_interface,aligned_on_support_refpoints,2); -SCM -Side_position_interface::aligned_on_support_refpoints (SCM smob, SCM axis) -{ - Grob *me = unsmob_grob (smob); - Axis a = (Axis) gh_scm2int (axis); + if (include_staff) + { + Interval staff_extents; + common[Y_AXIS] = staff_symbol->common_refpoint (common[Y_AXIS], Y_AXIS); + staff_extents = staff_symbol->maybe_pure_extent (common[Y_AXIS], Y_AXIS, pure, start, end); + dim.set_minimum_height (staff_extents[dir]); + } - return general_side_position (me, a, false); -} + // Sometimes, we want to side position for grobs but they + // don't position against anything. Some cases where this is true: + // - StanzaNumber if the supporting lyrics are hara-kiri'd + // SystemStartBracket + // InstrumentName + // In all these cases, we set the height of the support to 0. + // This becomes then like the self-alignment-interface with the + // caveat that there is padding added. + // TODO: if there is a grob that never has side-support-elements + // (like InstrumentName), why are we using this function? Isn't it + // overkill? A function like self-alignment-interface with padding + // works just fine. + // One could even imagine the two interfaces merged, as the only + // difference is that in self-alignment-interface we align on the parent + // where as here we align on a group of grobs. + if (dim.is_empty ()) + { + dim = Skyline (dim.direction ()); + dim.set_minimum_height (0.0); + } + Real ss = Staff_symbol_referencer::staff_space (me); + Real dist = dim.distance (my_dim, robust_scm2double (me->get_maybe_pure_property ("horizon-padding", pure, start, end), 0.0)); + Real total_off = !isinf (dist) ? dir * dist : 0.0; + total_off += dir * ss * robust_scm2double (me->get_maybe_pure_property ("padding", pure, start, end), 0.0); + Real minimum_space = ss * robust_scm2double (me->get_maybe_pure_property ("minimum-space", pure, start, end), -1); -Real -directed_round (Real f, Direction d) -{ - if (d < 0) - return floor (f); - else - return ceil (f); -} + if (minimum_space >= 0 + && dir + && total_off * dir < minimum_space) + total_off = minimum_space * dir; -/* - Callback that quantises in staff-spaces, rounding in the direction - of the elements "direction" elt property. + if (current_off) + total_off = dir * max (dir * total_off, + dir * (*current_off)); - 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); -SCM -Side_position_interface::quantised_position (SCM element_smob, SCM) -{ - Grob *me = unsmob_grob (element_smob); - - - Direction d = Side_position_interface::get_direction (me); - - if (Staff_symbol_referencer::has_interface (me)) + /* FIXME: 1000 should relate to paper size. */ + if (fabs (total_off) > 1000) { - 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); -} - -/* - 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) -{ - 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)); + string msg + = String_convert::form_string ("Improbable offset for grob %s: %f", + me->name ().c_str (), total_off); - Interval iv = me->extent (me, a); + programming_error (msg); + if (strict_infinity_checking) + scm_misc_error (__FUNCTION__, "Improbable offset.", SCM_EOL); + } - if (!iv.empty_b ()) + /* + Ensure 'staff-padding' from my refpoint 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 (!d) - { - programming_error ("Direction unknown, but aligned-side wanted."); - d = DOWN; - } - o += - iv[-d]; - - SCM pad = me->get_grob_property ("padding"); - if (gh_number_p (pad)) - o += d *gh_scm2double (pad) ; + if (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 + total_off - staff_off) / ss; + Real rounded = directed_round (position, dir); + Grob *head = me->get_parent (X_AXIS); + + Interval staff_span = Staff_symbol::line_span (staff); + staff_span.widen (1); + if (staff_span.contains (position) + /* If we are between notehead and staff, quantize for ledger lines. */ + || (has_interface (head) + && dir * position < 0)) + { + total_off += (rounded - position) * 0.5 * ss; + if (Staff_symbol_referencer::on_line (me, int (rounded))) + total_off += dir * 0.5 * ss; + } + } + else if (scm_is_number (me->get_maybe_pure_property ("staff-padding", pure, start, end)) && dir) + { + Real staff_padding + = Staff_symbol_referencer::staff_space (me) + * scm_to_double (me->get_maybe_pure_property ("staff-padding", pure, start, end)); + + Grob *parent = me->get_parent (Y_AXIS); + Grob *common = me->common_refpoint (staff, Y_AXIS); + Real parent_position = parent->maybe_pure_coordinate (common, Y_AXIS, pure, start, end); + Real staff_position = staff->maybe_pure_coordinate (common, Y_AXIS, pure, start, end); + Interval staff_extent = staff->maybe_pure_extent (staff, a, pure, start, end); + Real diff = (dir * staff_extent[dir] + staff_padding + - dir * total_off + + dir * (staff_position - parent_position)); + total_off += dir * max (diff, 0.0); + } } - return gh_double2scm (o); + return scm_from_double (total_off); } void -Side_position_interface::add_staff_support (Grob*me) +Side_position_interface::set_axis (Grob *me, Axis a) { - Grob* st = Staff_symbol_referencer::staff_symbol_l (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)); + chain_offset_callback (me, + (a == X_AXIS) + ? x_aligned_side_proc + : Unpure_pure_container::make_smob (y_aligned_side_proc, pure_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; + string msg = String_convert::form_string ("side-axis not set for grob %s.", + me->name ().c_str ()); + me->programming_error (msg); + return NO_AXES; } -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) +MAKE_SCHEME_CALLBACK (Side_position_interface, move_to_extremal_staff, 1); +SCM +Side_position_interface::move_to_extremal_staff (SCM smob) { - SCM s = me->get_grob_property ("side-support-elements"); - return gh_pair_p (s); + Grob *me = unsmob (smob); + System *sys = dynamic_cast (me->get_system ()); + Direction dir = get_grob_direction (me); + if (dir != DOWN) + dir = UP; + + Interval iv = me->extent (sys, X_AXIS); + iv.widen (1.0); + Grob *top_staff = sys->get_extremal_staff (dir, iv); + + if (!top_staff) + return SCM_BOOL_F; + + // Only move this grob if it is a direct child of the system. We + // are not interested in moving marks from other staves to the top + // staff; we only want to move marks from the system to the top + // staff. + if (sys != me->get_parent (Y_AXIS)) + return SCM_BOOL_F; + + me->set_parent (top_staff, Y_AXIS); + me->flush_extent_cache (Y_AXIS); + Axis_group_interface::add_element (top_staff, me); + + // Remove any cross-staff side-support dependencies + Grob_array *ga = unsmob (me->get_object ("side-support-elements")); + if (ga) + { + vector const &elts = ga->array (); + vector new_elts; + for (vsize i = 0; i < elts.size (); ++i) + { + if (me->common_refpoint (elts[i], Y_AXIS) == top_staff) + new_elts.push_back (elts[i]); + } + ga->set_array (new_elts); + } + return SCM_BOOL_T; } - - - -ADD_INTERFACE (Side_position_interface,"side-position-interface", - "Position a victim object (this one) next to other objects (the support). -#'direction = where to put the victim object (left or right?) -", - "side-support-elements direction-source direction side-relative-direction minimum-space padding"); +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 of the staff into account if" + " @code{staff-padding} is set. If undefined, the staff symbol" + " is ignored.", + + /* properties */ + "add-stem-support " + "direction " + "minimum-space " + "horizon-padding " + "padding " + "quantize-position " + "side-axis " + "side-support-elements " + "slur-padding " + "staff-padding " + "use-skylines " + );