X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Frest-collision.cc;h=8ba647e2019d8201d3698dbaa39cdd74f6671e90;hb=0f108b36cbf1e3e2168120b3d68997e75158e348;hp=e81cef84953cfd6474c1c564b72aa7e314b590ef;hpb=f68bbd7a1ed1b0e7146bbbffcbcbb7f9c9bda3cc;p=lilypond.git diff --git a/lily/rest-collision.cc b/lily/rest-collision.cc index e81cef8495..8ba647e201 100644 --- a/lily/rest-collision.cc +++ b/lily/rest-collision.cc @@ -1,258 +1,287 @@ /* - rest-collision.cc -- implement Rest_collision + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1997--2012 Han-Wen Nienhuys - (c) 1997--2001 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. -#include // ceil. + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ -#include "debug.hh" #include "rest-collision.hh" + +#include // ceil. +using namespace std; + +#include "directional-element-interface.hh" +#include "duration.hh" +#include "international.hh" +#include "item.hh" #include "note-column.hh" -#include "stem.hh" -#include "rhythmic-head.hh" -#include "paper-def.hh" +#include "output-def.hh" +#include "pointer-group-interface.hh" #include "rest.hh" -#include "group-interface.hh" +#include "rhythmic-head.hh" #include "staff-symbol-referencer.hh" -#include "duration.hh" +#include "stem.hh" +#include "grob.hh" +#include "warn.hh" -MAKE_SCHEME_CALLBACK (Rest_collision,force_shift_callback,2); +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, ""); SCM -Rest_collision::force_shift_callback (SCM element_smob, SCM axis) +Rest_collision::force_shift_callback_rest (SCM rest, SCM offset) { - Grob *them = unsmob_grob (element_smob); - Axis a = (Axis) gh_scm2int (axis); - assert (a == Y_AXIS); + Grob *rest_grob = unsmob_grob (rest); + Grob *parent = rest_grob->get_parent (X_AXIS); - Grob * rc = unsmob_grob (them->get_grob_property ("rest-collision")); + /* + translate REST; we need the result of this translation later on, + while the offset probably still is 0/calculation-in-progress. + */ + if (scm_is_number (offset)) + rest_grob->translate_axis (scm_to_double (offset), Y_AXIS); - if (rc) + if (Note_column::has_interface (parent) && Note_column::has_rests (parent)) { - /* - Done: destruct pointers, so we do the shift only once. - */ - SCM elts = rc->get_grob_property ("elements"); - rc->set_grob_property ("elements", SCM_EOL); + Grob *collision = unsmob_grob (parent->get_object ("rest-collision")); - do_shift (rc, elts); + if (collision) + (void) collision->get_property ("positioning-done"); } - - return gh_double2scm (0.0); + + return scm_from_double (0.0); } void -Rest_collision::add_column (Grob*me,Grob *p) +Rest_collision::add_column (Grob *me, Grob *p) { - me->add_dependency (p); - Pointer_group_interface::add_element (me, "elements", p); + Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p); - /* - only add callback for the rests, since we don't move anything else. + p->set_object ("rest-collision", me->self_scm ()); - (not?) - */ - p->add_offset_callback (Rest_collision::force_shift_callback_proc, Y_AXIS); - p->set_grob_property ("rest-collision", me->self_scm ()); + Grob *rest = unsmob_grob (p->get_object ("rest")); + if (rest) + { + chain_offset_callback (rest, + Rest_collision::force_shift_callback_rest_proc, Y_AXIS); + } } - -/* - Combination of dot-count and duration-log. - */ -static SCM -head_characteristic (Grob * col) +static bool +rest_shift_less (Grob *const &r1, Grob *const &r2) { - Grob * s = unsmob_grob (col->get_grob_property ("rest")); - - if (!s) - return SCM_BOOL_F; - else - return gh_cons (s->get_grob_property ("duration-log"), - gh_int2scm (Rhythmic_head::dot_count (s))); + Grob *col1 = r1->get_parent (X_AXIS); + Grob *col2 = r2->get_parent (X_AXIS); + return Note_column::shift_less (col1, col2); } /* - TODO: fixme, fucks up if called twice on the same set of rests. - TODO: look at horizontal-shift to determine ordering between rests for more than two voices. - - */ +*/ +MAKE_SCHEME_CALLBACK (Rest_collision, calc_positioning_done, 1); SCM -Rest_collision::do_shift (Grob *me, SCM elts) +Rest_collision::calc_positioning_done (SCM smob) { - /* - ugh. -> score elt type - */ - Link_array rests; - Link_array notes; - Grob * commony = 0; - for (SCM s = elts; gh_pair_p (s); s = ly_cdr (s)) + Grob *me = unsmob_grob (smob); + + me->set_property ("positioning-done", SCM_BOOL_T); + + extract_grob_set (me, "elements", elts); + + vector rests; + vector notes; + + for (vsize i = 0; i < elts.size (); i++) { - - Grob * e = unsmob_grob (ly_car (s)); - if (!e) - continue; - - if (!commony) - commony = e; + Grob *e = elts[i]; + if (unsmob_grob (e->get_object ("rest"))) + rests.push_back (e); else - commony= commony->common_refpoint (e, Y_AXIS); - - if (unsmob_grob (e->get_grob_property ("rest"))) - rests.push (e); - else - notes.push (e); + notes.push_back (e); } - - /* - handle rest-rest and rest-note collisions - - [todo] - * decide not to print rest if too crowded? - - * ignore rests under beams. - */ + /* + handle rest-rest and rest-note collisions - // no rests to collide - if (!rests.size ()) - return SCM_UNSPECIFIED; + [todo] + * decide not to print rest if too crowded? + */ - // no partners to collide with + /* + no partners to collide with + */ if (rests.size () + notes.size () < 2) - return SCM_UNSPECIFIED; + return SCM_BOOL_T; - // meisjes met meisjes - if (!notes.size ()) + Real staff_space = Staff_symbol_referencer::staff_space (me); + /* + only rests + */ + if (!notes.size ()) { - SCM characteristic = head_characteristic (rests[0]); - int i = 1; - for (; i < rests.size (); i++) - { - if (!gh_equal_p (head_characteristic (rests[i]), characteristic)) - break; - } /* - If all durations are the same, we'll check if there are more - rests than maximum-rest-count. - Otherwise (different durations), we'll try to display them all - (urg: all 3 of them, currently). - */ - int display_count; - SCM s = me->get_grob_property ("maximum-rest-count"); - if (i == rests.size () - && gh_number_p (s) && gh_scm2int (s) < rests.size ()) - { - display_count = gh_scm2int (s); - for (; i > display_count; i--) - { - Grob* r = unsmob_grob (rests[i-1]->get_grob_property ("rest")); - if (r) - r->suicide (); - rests[i-1]->suicide (); - } - } - else - display_count = rests.size (); - - /* - Ugh. Should have minimum dist. - - Ugh. What do we do if we have three different rests? - - */ - int dy = display_count > 2 ? 6 : 4; // FIXME Should get dims from table. - if (display_count > 1) - { - Direction d0 = Note_column::dir (rests[0]); - Direction d1 = Note_column::dir (rests[1]); - - if (!d0 && !d1) - { - d0= UP; - d1 = DOWN; - } - else if (!d0) - d0 = - d1; - else if (!d1) - d1 = -d0; - - Note_column::translate_rests (rests[0],d0 *dy); - Note_column::translate_rests (rests[1], d1 *dy); - } + This is incomplete: in case of an uneven number of rests, the + center one should be centered on the staff. + */ + Drul_array > ordered_rests; + for (vsize i = 0; i < rests.size (); i++) + { + Grob *r = Note_column::get_rest (rests[i]); + + Direction d = get_grob_direction (r); + if (d) + ordered_rests[d].push_back (r); + else + rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set")); + } + + for (LEFT_and_RIGHT (d)) + vector_sort (ordered_rests[d], rest_shift_less); + + + for (LEFT_and_RIGHT (d)) + { + if (ordered_rests[d].size () < 1) + { + if (ordered_rests[-d].size () > 1) + ordered_rests[-d][0]->warning (_ ("too many colliding rests")); + + return SCM_BOOL_T; + } + } + + Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS); + common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS); + + Real diff + = (ordered_rests[DOWN].back ()->extent (common, Y_AXIS)[UP] + - ordered_rests[UP].back ()->extent (common, Y_AXIS)[DOWN]) / staff_space; + + if (diff > 0) + { + int amount_down = (int) ceil (diff / 2); + diff -= amount_down; + Rest::translate (ordered_rests[DOWN].back (), + -2 * amount_down); + if (diff > 0) + Rest::translate (ordered_rests[UP].back (), + 2 * int (ceil (diff))); + } + + for (LEFT_and_RIGHT (d)) + { + for (vsize i = ordered_rests[d].size () - 1; i-- > 0;) + { + Real last_y = ordered_rests[d][i + 1]->extent (common, Y_AXIS)[d]; + Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d]; + + Real diff = d * ((last_y - y) / staff_space); + if (diff > 0) + Rest::translate (ordered_rests[d][i], d * (int) ceil (diff) * 2); + } + } } - // meisjes met jongetjes - else + else { - if (rests.size () > 1) - { - warning (_ ("too many colliding rests")); - } - if (notes.size () > 1) - { - warning (_ ("too many notes for rest collision")); - } - Grob * rcol = rests[0]; - - // try to be opposite of noteheads. - Direction dir = - Note_column::dir (notes[0]); - - Grob * r = unsmob_grob (rcol->get_grob_property ("rest")); - Interval restdim = r->extent (r, Y_AXIS); // ?? - - if (restdim.empty_b ()) - return SCM_UNSPECIFIED; - - // FIXME: staff ref'd? - Real staff_space = 1.0; - - Real minimum_dist = gh_scm2double (me->get_grob_property ("minimum-distance")) * staff_space; - /* - assumption: ref points are the same. - */ - Interval notedim; - for (int i = 0; i < notes.size (); i++) - { - Grob * stem = Note_column::stem_l (notes[i]); - Grob * head = Stem::first_head (stem); - notedim.unite (head->extent (commony, Y_AXIS)); - } - - Interval inter (notedim); - inter.intersect (restdim); - - Real dist = - minimum_dist + dir * (notedim[dir] - restdim[-dir]) >? 0; - - - // FIXME - //int stafflines = 5; // rcol->rests[0]->line_count; - int stafflines = Staff_symbol_referencer::line_count (me); - // hurg? - stafflines = stafflines != 0 ? stafflines : 5; - - // move discretely by half spaces. - int discrete_dist = int (ceil (dist / (0.5 *staff_space))); - - // move by whole spaces inside the staff. - if (discrete_dist < stafflines+1) - discrete_dist = int (ceil (discrete_dist / 2.0)* 2.0); - - Note_column::translate_rests (rcol,dir * discrete_dist); + Rests and notes. + */ + // Count how many rests we move + Drul_array rcount (0, 0); + + for (vsize i = 0; i < rests.size (); i++) + { + Grob *rcol = rests[i]; + Grob *rest = Note_column::get_rest (rcol); + + Direction dir = get_grob_direction (rest); + if (!dir) + dir = Note_column::dir (rcol); + + // Do not compute a translation for pre-positioned rests, + // nor count them for the "too many colliding rests" warning + if (scm_is_number (rest->get_property ("staff-position"))) + continue; + + Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS); + Interval restdim = rest->extent (common, Y_AXIS); + if (restdim.is_empty ()) + continue; + + Real staff_space = Staff_symbol_referencer::staff_space (rcol); + Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space; + + Interval notedim; + for (vsize i = 0; i < notes.size (); i++) + { + if (Note_column::dir (notes[i]) == -dir + // If the note has already happened (but it has a long + // duration, so there is a collision), don't look at the stem. + // If we do, the rest gets shifted down a lot and it looks bad. + || dynamic_cast (notes[i])->get_column () != dynamic_cast (rest)->get_column ()) + { + /* try not to look at the stem, as looking at a beamed + note may trigger beam positioning prematurely. + + This happens with dotted rests, which need Y + positioning to compute X-positioning. + */ + Grob *head = Note_column::first_head (notes[i]); + if (head) + notedim.unite (head->extent (common, Y_AXIS)); + else + programming_error ("Note_column without first_head()"); + } + else + notedim.unite (notes[i]->extent (common, Y_AXIS)); + } + + Real y = dir * max (0.0, + -dir * restdim[-dir] + dir * notedim[dir] + minimum_dist); + + int stafflines = Staff_symbol_referencer::line_count (me); + if (!stafflines) + { + programming_error ("no staff line count"); + stafflines = 5; + } + + // move discretely by half spaces. + int discrete_y = dir * int (ceil (y / (0.5 * dir * staff_space))); + + // move by whole spaces inside the staff. + if (fabs (Staff_symbol_referencer::get_position (rest) + + discrete_y) < stafflines + 1) + { + discrete_y = dir * int (ceil (dir * discrete_y / 2.0) * 2.0); + } + + Rest::translate (rest, discrete_y); + if (rcount[dir]++) + rest->warning (_ ("too many colliding rests")); + } } - return SCM_UNSPECIFIED; + return SCM_BOOL_T; } -void -Rest_collision::set_interface (Grob*me) -{ - me->set_extent_callback (SCM_EOL, X_AXIS); - me->set_extent_callback (SCM_EOL, Y_AXIS); -} +ADD_INTERFACE (Rest_collision, + "Move ordinary rests (not multi-measure nor pitched rests)" + " to avoid conflicts.", + + /* properties */ + "minimum-distance " + "positioning-done " + "elements " + );