X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fside-position-interface.cc;h=6fad89ea54cccf0e5846d69d35e90d6e0ff391c3;hb=9578677bb2b3929964e8cc2c906df5c98b8a50c4;hp=b1d3923d3f8435991718300f078afff5a1d0fa4a;hpb=89bf299597169eeaa5ed7a215b6e808fa849c8cd;p=lilypond.git diff --git a/lily/side-position-interface.cc b/lily/side-position-interface.cc index b1d3923d3f..6fad89ea54 100644 --- a/lily/side-position-interface.cc +++ b/lily/side-position-interface.cc @@ -1,288 +1,477 @@ -/* - staff-side.cc -- implement Staff_side_element - - source file of the GNU LilyPond music typesetter - - (c) 1998--2000 Han-Wen Nienhuys - - */ -#include // ceil. +/* + This file is part of LilyPond, the GNU music typesetter. + + Copyright (C) 1998--2012 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 // ceil. +#include + +using namespace std; + +#include "accidental-interface.hh" +#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 "pointer-group-interface.hh" #include "staff-symbol-referencer.hh" -#include "group-interface.hh" +#include "staff-symbol.hh" +#include "stem.hh" +#include "string-convert.hh" +#include "system.hh" +#include "warn.hh" void -Side_position::add_support (Grob*me, Grob*e) +Side_position_interface::add_support (Grob *me, Grob *e) { - Pointer_group_interface::add_element (me, "side-support-elements",e); + Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("side-support-elements"), e); } +SCM +finish_offset (Grob *me, Direction dir, Real total_off, Real *current_offset) +{ + Real ss = Staff_symbol_referencer::staff_space (me); + Real minimum_space = ss * robust_scm2double (me->get_property ("minimum-space"), -1); + total_off += dir * ss * robust_scm2double (me->get_property ("padding"), 0); + if (minimum_space >= 0 + && dir + && total_off * dir < minimum_space) + total_off = minimum_space * dir; -Direction -Side_position::get_direction (Grob*me) -{ - SCM d = me->get_grob_property ("direction"); - if (isdir_b (d) && to_dir (d)) - return to_dir (d); + if (current_offset) + total_off = dir * max (dir * total_off, + dir * (*current_offset)); - Direction relative_dir = Direction (1); - SCM reldir = me->get_grob_property ("side-relative-direction"); // should use a lambda. - if (isdir_b (reldir)) - { - relative_dir = to_dir (reldir); - } - - SCM other_elt = me->get_grob_property ("direction-source"); - Grob * e = unsmob_grob(other_elt); - if (e) + /* FIXME: 1000 should relate to paper size. */ + if (fabs (total_off) > 1000) { - return (Direction)(relative_dir * Side_position::get_direction (e)); + 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 DOWN; + + return scm_from_double (total_off); } - -/* - 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) { - Grob *me = unsmob_grob (element_smob); - Axis a = (Axis) gh_scm2int (axis); + 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")); - Grob *common = me->parent_l (a); - SCM support = me->get_grob_property ("side-support-elements"); - for (SCM s = support; s != SCM_EOL; s = gh_cdr (s)) - { - Grob * e = unsmob_grob (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); - Grob * e = unsmob_grob ( gh_car (s)); - if (e) - { - dim.unite (e->extent (common, a)); - } + if (include_staff) + dim.unite (staff_extents); } - if (dim.empty_b ()) + Direction dir = get_grob_direction (me); + + for (vsize i = 0; i < support.size (); i++) { - dim = Interval(0,0); - } + Grob *e = support[i]; - Direction dir = Side_position::get_direction (me); - - Real off = me->parent_l (a)->relative_coordinate (common, a); - SCM minimum = me->remove_grob_property ("minimum-space"); + // 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; - Real total_off = dim[dir] + off; - SCM padding = me->remove_grob_property ("padding"); - if (gh_number_p (padding)) - { - total_off += gh_scm2double (padding) * dir; + 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)); + } + } } - if (gh_number_p (minimum) && total_off * dir < gh_scm2double (minimum)) + + if (dim.is_empty ()) + dim = Interval (0, 0); + + Real off = me->get_parent (a)->maybe_pure_coordinate (common, a, pure, start, end); + + Real total_off = dim.linear_combination (dir) - off; + if (include_my_extent) { - total_off = gh_scm2double (minimum) * dir; + 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 (fabs (total_off) > 100 CM) - programming_error ("Huh ? Improbable staff side dim."); - return gh_double2scm (total_off); + return finish_offset (me, dir, total_off, current_offset); } -/** - 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) +Side_position_interface::skyline_side_position (Grob *me, Axis a, + bool pure, int start, int end, + Real *current_offset) { - Grob *me = unsmob_grob (element_smob); - Axis a = (Axis) gh_scm2int (axis); - String s ("self-alignment-"); + extract_grob_set (me, "side-support-elements", support); - s += (a == X_AXIS) ? "X" : "Y"; + 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); - SCM align (me->get_grob_property (s.ch_C())); - if (gh_number_p (align)) - { - Interval ext(me->extent (me,a)); + Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (me); + Direction dir = get_grob_direction (me); - if (ext.empty_b ()) - { - programming_error ("I'm empty. Can't align on self"); - return gh_double2scm (0.0); - } + Box off; + for (Axis ax = X_AXIS; ax < NO_AXES; incr (ax)) + { + if (ax == a) + off[ax] = me->get_parent (ax)->maybe_pure_coordinate (common[ax], ax, pure, start, end) + + me->maybe_pure_extent (me, ax, pure, start, end); else - { - return gh_double2scm (- ext.linear_combination (gh_scm2double (align))); - } + off[ax] = me->maybe_pure_extent (common[ax], ax, pure, start, end); } - else if (unsmob_grob (align)) + + if (off[X_AXIS].is_empty () || off[Y_AXIS].is_empty ()) + return scm_from_double (0.0); + + Real skyline_padding = 0.1; + + Skyline my_dim (off, skyline_padding, other_axis (a), -dir); + + bool include_staff + = staff_symbol + && a == Y_AXIS + && scm_is_number (me->get_property ("staff-padding")) + && !to_boolean (me->get_property ("quantize-position")); + + vector boxes; + Real min_h = dir == LEFT ? infinity_f : -infinity_f; + for (vsize i = 0; i < support.size (); i++) { - return gh_double2scm (- unsmob_grob (align)->relative_coordinate (me, a)); - } - return gh_double2scm (0.0); -} + 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 (Accidental_interface::has_interface (e)) + { + vector bs = Accidental_interface::accurate_boxes (e, common); + boxes.insert (boxes.end (), bs.begin (), bs.end ()); + } + else + { + Box b; + for (Axis ax = X_AXIS; ax < NO_AXES; incr (ax)) + b[ax] = e->maybe_pure_extent (common[ax], ax, pure, start, end); + + if (b[X_AXIS].is_empty () || b[Y_AXIS].is_empty ()) + continue; + + boxes.push_back (b); + min_h = minmax (dir, b[a][-dir], min_h); + } + } + } -Real -directed_round (Real f, Direction d) -{ - if (d < 0) - return floor (f); + Skyline dim (boxes, skyline_padding, other_axis (a), dir); + if (!boxes.size ()) + dim.set_minimum_height (0.0); else - return ceil (f); -} + dim.set_minimum_height (min_h); -/* - Callback that quantises in staff-spaces, rounding in the direction - of the elements "direction" elt property. + 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 (minmax (dir, min_h, staff_extents[dir])); + } + + Real total_off = dir * dim.distance (my_dim); + return finish_offset (me, dir, total_off, current_offset); +} - 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, y_aligned_on_support_refpoints, 1); SCM -Side_position::quantised_position (SCM element_smob, SCM ) +Side_position_interface::y_aligned_on_support_refpoints (SCM smob) { - Grob *me = unsmob_grob (element_smob); - - - Direction d = Side_position::get_direction (me); + return general_side_position (unsmob_grob (smob), Y_AXIS, false, false, false, 0, 0, 0); +} - 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); +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. - */ -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) { - Grob *me = unsmob_grob (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 (me, 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_grob_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) { - Grob *me = unsmob_grob (element_smob); - Axis a = (Axis) gh_scm2int (axis); - Grob *him = me->parent_l (a); - - return gh_double2scm (him->extent (him,a).center ()); + return axis_aligned_side_helper (smob, X_AXIS, false, 0, 0, current_off); } - -void -Side_position::add_staff_support (Grob*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) { - Grob* 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 (Grob*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 (Grob*me) +MAKE_SCHEME_CALLBACK (Side_position_interface, calc_cross_staff, 1) +SCM +Side_position_interface::calc_cross_staff (SCM smob) { - 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; + Grob *me = unsmob_grob (smob); + extract_grob_set (me, "side-support-elements", elts); - - return Y_AXIS; -} + for (vsize i = 0; i < elts.size (); i++) + if (to_boolean (elts[i]->get_property ("cross-staff"))) + return SCM_BOOL_T; -void -Side_position::set_direction (Grob*me, Direction d) -{ - me->set_grob_property ("direction", gh_int2scm (d)); + Grob *common = common_refpoint_of_array (elts, me->get_parent (Y_AXIS), Y_AXIS); + return scm_from_bool (common != me->get_parent (Y_AXIS)); } -void -Side_position::set_minimum_space (Grob*me, Real m) +SCM +Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, int end, + Real *current_off) { - me->set_grob_property ("minimum-space", gh_double2scm (m)); + Direction dir = get_grob_direction (me); + bool skyline = to_boolean (me->get_property ("use-skylines")); + + Real o = scm_to_double (skyline + ? skyline_side_position (me, a, pure, start, end, current_off) + : general_side_position (me, a, true, true, pure, start, end, current_off)); + + /* + 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); + + Interval staff_span = Staff_symbol::line_span (staff); + staff_span.widen (1); + if (staff_span.contains (position) + /* In case of a ledger lines, quantize even if we're outside the staff. */ + || (Note_head::has_interface (head) + + && abs (Staff_symbol_referencer::get_position (head)) > abs (position))) + { + 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 staff_padding + = Staff_symbol_referencer::staff_space (me) + * scm_to_double (me->get_property ("staff-padding")); + + 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 * (o + iv[-dir]) + + dir * (staff_position - parent_position)); + o += dir * max (diff, 0.0); + } + } + return scm_from_double (o); } void -Side_position::set_padding (Grob*me, Real p) +Side_position_interface::set_axis (Grob *me, Axis a) { - me->set_grob_property ("padding", gh_double2scm (p)); + 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::has_interface (Grob*me) +Axis +Side_position_interface::get_axis (Grob *me) { - return me->has_interface (ly_symbol2scm ("side-position-interface")); + 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; } -bool -Side_position::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_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 " + "minimum-space " + "padding " + "quantize-position " + "side-axis " + "side-support-elements " + "slur-padding " + "staff-padding " + "use-skylines " + );