X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fside-position-interface.cc;h=4498d76979249389dbfce37e2a1bc4ec18039076;hb=6ca3f1b0e92f37f9f4bc44bb3627b928a5aeccd4;hp=454333156877c61ee763243259defa03472a7869;hpb=0ada3837f91b0e14cf7c588351d020b88e50d604;p=lilypond.git diff --git a/lily/side-position-interface.cc b/lily/side-position-interface.cc index 4543331568..4498d76979 100644 --- a/lily/side-position-interface.cc +++ b/lily/side-position-interface.cc @@ -1,55 +1,60 @@ /* - side-position-interface.cc -- implement Side_position_interface + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1998--2009 Han-Wen Nienhuys - (c) 1998--2005 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 // ceil. #include + using namespace std; +#include "axis-group-interface.hh" +#include "directional-element-interface.hh" +#include "grob.hh" +#include "grob-array.hh" +#include "main.hh" +#include "misc.hh" #include "note-head.hh" -#include "warn.hh" -#include "warn.hh" -#include "dimensions.hh" -#include "staff-symbol-referencer.hh" #include "pointer-group-interface.hh" -#include "directional-element-interface.hh" #include "staff-symbol-referencer.hh" #include "staff-symbol.hh" +#include "stem.hh" #include "string-convert.hh" -#include "misc.hh" +#include "system.hh" +#include "warn.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) -{ - Direction relative_dir = Direction (1); - 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 * get_grob_direction (e)); - - return CENTER; + Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("side-support-elements"), e); } /* Put the element next to the support, optionally taking in - account the extent of the support. */ + account the extent of the support. + + Does not take into account the extent of ME. +*/ 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, + bool include_my_extent, + bool pure, int start, int end, + Real *current_offset) { Real ss = Staff_symbol_referencer::staff_space (me); @@ -57,45 +62,53 @@ Side_position_interface::general_side_position (Grob *me, Axis a, bool use_exten 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 = false; - - if (staff_symbol - && a == Y_AXIS) - { - if (scm_is_number (me->get_property ("staff-padding"))) - include_staff = true; - } + bool include_staff = + staff_symbol + && a == Y_AXIS + && scm_is_number (me->get_property ("staff-padding")) + && !to_boolean (me->get_property ("quantize-position")); Interval dim; Interval staff_extents; if (include_staff) { common = staff_symbol->common_refpoint (common, Y_AXIS); - staff_extents = staff_symbol->extent (common, Y_AXIS); + staff_extents = staff_symbol->maybe_pure_extent (common, Y_AXIS, pure, start, end); if (include_staff) dim.unite (staff_extents); } - for (int i = 0; i < support.size (); i++) + Direction dir = get_grob_direction (me); + + for (vsize i = 0; i < support.size (); i++) { Grob *e = support[i]; + + // In the case of a stem, we will find a note head as well + // ignoring the stem solves cyclic dependencies if the stem is + // attached to a cross-staff beam. + if (a == Y_AXIS + && Stem::has_interface (e) + && dir == - get_grob_direction (e)) + continue; + 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 (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)); + } + } } if (dim.is_empty ()) dim = Interval (0, 0); - Direction dir = get_grob_direction (me); - - Real off = me->get_parent (a)->relative_coordinate (common, a); + 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); Real total_off = dim.linear_combination (dir) - off; @@ -105,16 +118,36 @@ Side_position_interface::general_side_position (Grob *me, Axis a, bool use_exten && dir && total_off * dir < minimum_space) total_off = minimum_space * dir; + + if (include_my_extent) + { + Interval iv = me->maybe_pure_extent (me, a, pure, start, end); + if (!iv.is_empty ()) + { + if (!dir) + { + programming_error ("direction unknown, but aligned-side wanted"); + dir = DOWN; + } + total_off += -iv[-dir]; + } + } + + if (current_offset) + total_off = dir * max (dir * total_off, + dir * (*current_offset)); - /* FIXME: 100CM should relate to paper size. */ - if (fabs (total_off) > 100 CM) + + /* FIXME: 1000 should relate to paper size. */ + if (fabs (total_off) > 1000) { - String msg - = String_convert::form_string ("Improbable offset for grob %s: %f%s", - me->name ().to_str0 (), total_off, - INTERNAL_UNIT); + 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 scm_from_double (total_off); } @@ -124,46 +157,82 @@ MAKE_SCHEME_CALLBACK (Side_position_interface, y_aligned_on_support_refpoints, 1 SCM Side_position_interface::y_aligned_on_support_refpoints (SCM smob) { - return general_side_position (unsmob_grob (smob), Y_AXIS, false); + return general_side_position (unsmob_grob (smob), Y_AXIS, false, false, false, 0, 0, 0); } +MAKE_SCHEME_CALLBACK (Side_position_interface, pure_y_aligned_on_support_refpoints, 3); +SCM +Side_position_interface::pure_y_aligned_on_support_refpoints (SCM smob, SCM start, SCM end) +{ + 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. */ +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)) + { + r = scm_to_double (current_off_scm); + current_off_ptr = &r; + } + + return Side_position_interface::aligned_side (unsmob_grob (smob), a, pure, start, end, current_off_ptr); +} + -MAKE_SCHEME_CALLBACK (Side_position_interface, x_aligned_side, 1); +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, x_aligned_side, 2, 1, ""); SCM -Side_position_interface::x_aligned_side (SCM smob) +Side_position_interface::x_aligned_side (SCM smob, SCM current_off) { - return aligned_side (unsmob_grob (smob), X_AXIS); + return axis_aligned_side_helper (smob, X_AXIS, false, 0, 0, current_off); } -MAKE_SCHEME_CALLBACK (Side_position_interface, y_aligned_side, 1); +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, y_aligned_side, 2, 1, ""); SCM -Side_position_interface::y_aligned_side (SCM smob) +Side_position_interface::y_aligned_side (SCM smob, SCM current_off) { - return aligned_side (unsmob_grob (smob), Y_AXIS); + return axis_aligned_side_helper (smob, Y_AXIS, false, 0, 0, current_off); } +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, pure_y_aligned_side, 4, 1, ""); SCM -Side_position_interface::aligned_side (Grob*me, Axis a) +Side_position_interface::pure_y_aligned_side (SCM smob, SCM start, SCM end, SCM cur_off) { - Direction dir = get_grob_direction (me); + return axis_aligned_side_helper (smob, Y_AXIS, true, + scm_to_int (start), + scm_to_int (end), + cur_off); +} - Real o = scm_to_double (general_side_position (me, a, true)); - Interval iv = me->extent (me, a); +MAKE_SCHEME_CALLBACK (Side_position_interface, calc_cross_staff, 1) +SCM +Side_position_interface::calc_cross_staff (SCM smob) +{ + Grob *me = unsmob_grob (smob); + extract_grob_set (me, "side-support-elements", elts); - if (!iv.is_empty ()) - { - if (!dir) - { - programming_error ("direction unknown, but aligned-side wanted"); - dir = DOWN; - } - o += -iv[-dir]; - } + for (vsize i = 0; i < elts.size (); i++) + if (to_boolean (elts[i]->get_property ("cross-staff"))) + return SCM_BOOL_T; + + Grob *common = common_refpoint_of_array (elts, me->get_parent (Y_AXIS), Y_AXIS); + return scm_from_bool (common != me->get_parent (Y_AXIS)); +} + +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); + + Real o = scm_to_double (general_side_position (me, a, true, true, pure, start, end, current_off)); /* Maintain a minimum distance to the staff. This is similar to side @@ -173,38 +242,41 @@ Side_position_interface::aligned_side (Grob*me, Axis a) Grob *staff = Staff_symbol_referencer::get_staff_symbol (me); if (staff && a == Y_AXIS) { - 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")); - - Grob *common = me->common_refpoint (staff, Y_AXIS); - - 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); - } - 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 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 (rounded <= Staff_symbol_referencer::staff_radius (me) + + if (fabs (position) <= 2 * Staff_symbol_referencer::staff_radius (me) + 1 + /* In case of a ledger lines, quantize even if we're outside the staff. */ || (Note_head::has_interface (head) - && sign (Staff_symbol_referencer::get_position (head)) == - dir)) + + && abs (Staff_symbol_referencer::get_position (head)) > abs (position))) { - o += dir *(rounded - position) * 0.5 * ss; - if (Staff_symbol_referencer::on_staffline (me, int (rounded))) + 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")) && dir) + { + 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")); + + Grob *common = me->common_refpoint (staff, Y_AXIS); + + 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); } @@ -212,42 +284,91 @@ Side_position_interface::aligned_side (Grob*me, Axis a) void Side_position_interface::set_axis (Grob *me, Axis a) { - add_offset_callback (me, - (a==X_AXIS) - ? x_aligned_side_proc - : y_aligned_side_proc, - a); + 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); + } } -// ugh. doesn't catch all variants. Axis Side_position_interface::get_axis (Grob *me) { - if (me->get_property_data (ly_symbol2scm ("X-offset")) - == Side_position_interface::x_aligned_side_proc) - return X_AXIS; - else if (me->get_property_data (ly_symbol2scm ("Y-offset")) - == Side_position_interface::y_aligned_side_proc) - return Y_AXIS; - + if (scm_is_number (me->get_property ("side-axis"))) + return Axis (scm_to_int (me->get_property ("side-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; } -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.", +MAKE_SCHEME_CALLBACK (Side_position_interface, move_to_extremal_staff, 1); +SCM +Side_position_interface::move_to_extremal_staff (SCM smob) +{ + Grob *me = unsmob_grob (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_grob_array (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, + "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 */ "direction " - "direction-source " "minimum-space " "padding " - "side-relative-direction " + "quantize-position " + "side-axis " "side-support-elements " "slur-padding " "staff-padding " - "quantize-position " );