X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fside-position-interface.cc;h=52551e8b5286452342d4eae53dbc1f9396efef36;hb=b872748c6aa8bb721ced458691b38ac2fac5dfc8;hp=49c6ece55a1c8853214e28965a7c253df284f5da;hpb=7d3d28de0ce6e2f018aff599cecd944d1754fe3c;p=lilypond.git diff --git a/lily/side-position-interface.cc b/lily/side-position-interface.cc index 49c6ece55a..52551e8b52 100644 --- a/lily/side-position-interface.cc +++ b/lily/side-position-interface.cc @@ -1,7 +1,7 @@ /* This file is part of LilyPond, the GNU music typesetter. - Copyright (C) 1998--2012 Han-Wen Nienhuys + 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 @@ -46,6 +46,7 @@ using namespace std; #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) @@ -53,15 +54,6 @@ Side_position_interface::add_support (Grob *me, Grob *e) Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("side-support-elements"), e); } -void -Side_position_interface::recursive_add_support (Grob *me, Grob *e) -{ - Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("side-support-elements"), e); - extract_grob_set (e, "side-support-elements", sse); - for (vsize i = 0; i < sse.size (); i++) - recursive_add_support (me, sse[i]); -} - set get_support_set (Grob *me) { @@ -73,14 +65,14 @@ get_support_set (Grob *me) for (vsize i = 0; i < proto_support.size (); i++) { - if (Accidental_placement::has_interface (proto_support[i])) + 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_grob (scm_car (s)); + Grob *a = unsmob (scm_car (s)); support.insert (a); } } @@ -104,7 +96,7 @@ axis_aligned_side_helper (SCM smob, Axis a, bool pure, int start, int end, SCM c current_off_ptr = &r; } - Grob *me = unsmob_grob (smob); + 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) @@ -146,31 +138,34 @@ MAKE_SCHEME_CALLBACK (Side_position_interface, calc_cross_staff, 1) SCM Side_position_interface::calc_cross_staff (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = unsmob (smob); extract_grob_set (me, "side-support-elements", elts); -// Commented out because of cross staff issues -// Direction for cross staff stems depends on the spacing of staves, -// which depends on the inclusion of cross-staff side position grobs, -// which need the direction for positioning. So the get_grob_direction call -// may lead to circular dependencies. -// #if 0 + Direction my_dir = get_grob_direction (me) ; - // if a cross-staff grob is pointing in a different direction than - // that of an aligning element, we assume that the alignment - // of said element will not be influenced the cross-staffitude - // of the grob and thus we do not mark the aligning element - // as cross-staff - for (vsize i = 0; i < elts.size (); i++) - if (to_boolean (elts[i]->get_property ("cross-staff")) - && my_dir == get_grob_direction (elts[i])) - return SCM_BOOL_T; -//#endif -#if 0 for (vsize i = 0; i < elts.size (); i++) - if (to_boolean (elts[i]->get_property ("cross-staff"))) - return SCM_BOOL_T; -#endif + { + /* + 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; + } + 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])) @@ -184,7 +179,7 @@ Side_position_interface::calc_cross_staff (SCM smob) SCM Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, int end, Real *current_off) -{//printf (" %s\n", me->name ().c_str ()); +{ Direction dir = get_grob_direction (me); set support = get_support_set (me); @@ -198,25 +193,26 @@ Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, i 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_property ("staff-padding")) - && !to_boolean (me->get_property ("quantize-position")); + && 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; - Skyline_pair *skyp = Skyline_pair::unsmob ( - me->get_maybe_pure_property (a == X_AXIS - ? "horizontal-skylines" - : "vertical-skylines", - pure, - start, - end)); - if (skyp) + SCM skyp = me->get_maybe_pure_property (a == X_AXIS + ? "horizontal-skylines" + : "vertical-skylines", + pure, + start, + end); + if (unsmob (skyp)) { // for spanner pure heights, we don't know horizontal spacing, // so a spanner can never have a meaningful x coordiante @@ -224,7 +220,7 @@ Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, i // 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->parent_relative (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, @@ -232,7 +228,7 @@ Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, i 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 = Skyline_pair (*skyp); + Skyline_pair copy = *unsmob (skyp); copy.shift (a == X_AXIS ? yc : xc); copy.raise (a == X_AXIS ? xc : yc); my_dim = copy[-dir]; @@ -244,53 +240,54 @@ Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, i vector boxes; vector skyps; set::iterator it; - Real max_raise = -dir * infinity_f; - bool aligns_to_cross_staff = false; for (it = support.begin (); it != support.end (); it++) { Grob *e = *it; -//printf (" %s\n", e->name ().c_str ()); - // 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. + + bool cross_staff = to_boolean (e->get_property ("cross-staff")); if (a == Y_AXIS - && Stem::has_interface (e) - && dir == - get_grob_direction (e)) - continue; + && !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 (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; + } - bool cross_staff = to_boolean (e->get_property ("cross-staff")); - - Skyline_pair *sp = Skyline_pair::unsmob - (e->get_maybe_pure_property (a == X_AXIS - ? "horizontal-skylines" - : "vertical-skylines", - pure || cross_staff, - start, - end)); - - aligns_to_cross_staff |= cross_staff; - if (sp) + 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->parent_relative (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 = Skyline_pair (*sp); + Skyline_pair copy = *unsmob (sp); if (a == Y_AXIS - && Stem::has_interface (e) - && to_boolean (me->get_property ("add-stem-support"))) + && 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); - max_raise = minmax (dir, max_raise, a == X_AXIS ? xc : yc); skyps.push_back (copy); } else { /* no warning*/ } @@ -312,39 +309,34 @@ Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, i dim.set_minimum_height (staff_extents[dir]); } - // this seems kinda kludgy, as there is no apparent logic to it - // however, it is a holdover from the previous code and - // necessary for the InstrumentName grob - // TODO: find a better way to deal with this... + // 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); } - // Ditto - seems kludgy, but this time logic of SystemStartBrackets - if (my_dim.is_empty ()) - { - my_dim = Skyline (my_dim.direction ()); - my_dim.set_minimum_height (isinf (max_raise) ? 0.0 : max_raise); - } - - // Many cross-staff grobs do not have good height estimations. - // We give the grob the best chance of not colliding by shifting - // it to the maximum height in the case of cross-staff alignment. - // This means, in other words, that the old way things were done - // (using boxes instead of skylines) is just reactivated for - // alignment to cross-staff grobs. - if (aligns_to_cross_staff) - dim.set_minimum_height (dim.max_height ()); - Real ss = Staff_symbol_referencer::staff_space (me); - Real dist = dim.distance (my_dim, robust_scm2double (me->get_property ("horizon-padding"), 0.0)); + 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_property ("padding"), 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_property ("minimum-space"), -1); + Real minimum_space = ss * robust_scm2double (me->get_maybe_pure_property ("minimum-space", pure, start, end), -1); if (minimum_space >= 0 && dir @@ -368,14 +360,14 @@ Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, i } /* - 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 + 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 (to_boolean (me->get_property ("quantize-position"))) + 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); @@ -388,23 +380,20 @@ Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, i 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))) + /* 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_property ("staff-padding")) && dir) + else if (scm_is_number (me->get_maybe_pure_property ("staff-padding", pure, start, end)) && 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")); + * 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); @@ -412,7 +401,7 @@ Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, i 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 + iv[-dir]) + - dir * total_off + dir * (staff_position - parent_position)); total_off += dir * max (diff, 0.0); } @@ -429,7 +418,7 @@ Side_position_interface::set_axis (Grob *me, Axis a) chain_offset_callback (me, (a == X_AXIS) ? x_aligned_side_proc - : y_aligned_side_proc, + : Unpure_pure_container::make_smob (y_aligned_side_proc, pure_y_aligned_side_proc), a); } } @@ -450,7 +439,7 @@ 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); + Grob *me = unsmob (smob); System *sys = dynamic_cast (me->get_system ()); Direction dir = get_grob_direction (me); if (dir != DOWN) @@ -475,7 +464,7 @@ Side_position_interface::move_to_extremal_staff (SCM smob) 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")); + Grob_array *ga = unsmob (me->get_object ("side-support-elements")); if (ga) { vector const &elts = ga->array ();