X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Frest-collision.cc;h=4c08264687e746063dcd57c3bd38a571fa84df4a;hb=c633bea462ad673cf59f5288b87027c7519c4d4f;hp=34d39fbe3b49cac69308ea5efd4b7d5bd2c5ad9b;hpb=76f13ab50fc726c89fa7c96f3deed519d2d773dc;p=lilypond.git diff --git a/lily/rest-collision.cc b/lily/rest-collision.cc index 34d39fbe3b..4c08264687 100644 --- a/lily/rest-collision.cc +++ b/lily/rest-collision.cc @@ -1,199 +1,291 @@ /* - 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--2000 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 // ceil. -#include "beam.hh" -#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 "note-head.hh" -#include "collision.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" -void -Rest_collision::add_column (Note_column *nc_l) +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, ""); +SCM +Rest_collision::force_shift_callback_rest (SCM rest, SCM offset) { - add_dependency (nc_l); - Pointer_group_interface gi (this); - if (nc_l->rest_b ()) - gi.name_ = "rests"; - else - gi.name_ = "notes"; - - gi.add_element (nc_l); -} + Grob *rest_grob = unsmob_grob (rest); + Grob *parent = rest_grob->get_parent (X_AXIS); -static Duration -to_duration (int type, int dots) -{ - Duration d; - d.durlog_i_ = type; - d.dots_i_ = dots; - return d; + /* + 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 (Note_column::has_interface (parent) && Note_column::has_rests (parent)) + { + Grob *collision = unsmob_grob (parent->get_object ("rest-collision")); + + if (collision) + (void) collision->get_property ("positioning-done"); + } + + return scm_from_double (0.0); } -static Moment -rhythmic_head2mom (Rhythmic_head* r) +void +Rest_collision::add_column (Grob *me, Grob *p) { - return to_duration (r->balltype_i (), r->dot_count ()).length_mom (); + Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p); + + p->set_object ("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); + } } -static Rhythmic_head* -col2rhythmic_head (Note_column* c) +static bool +rest_shift_less (Grob *const &r1, Grob *const &r2) { - SCM s = c->get_elt_pointer ("rests"); - assert (gh_pair_p (s)); - Score_element* e = unsmob_element (gh_car (s)); - return dynamic_cast (e); + Grob *col1 = r1->get_parent (X_AXIS); + Grob *col2 = r2->get_parent (X_AXIS); + return Note_column::shift_less (col1, col2); } -void -Rest_collision::before_line_breaking () +/* + 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::calc_positioning_done (SCM smob) { - Link_array rest_l_arr = - Pointer_group_interface__extract_elements (this, (Note_column*) 0, "rests"); - Link_array ncol_l_arr = - Pointer_group_interface__extract_elements (this, (Note_column*) 0, "notes"); - - - /* - handle rest-rest and rest-note collisions - - [todo] - * decide not to print rest if too crowded? - - * ignore rests under beams. - */ + Grob *me = unsmob_grob (smob); - // no rests to collide - if (!rest_l_arr.size()) - return; + me->set_property ("positioning-done", SCM_BOOL_T); - // no partners to collide with - if (rest_l_arr.size() + ncol_l_arr.size () < 2) - return; + extract_grob_set (me, "elements", elts); - // meisjes met meisjes - if (!ncol_l_arr.size()) - { - Moment m = rhythmic_head2mom (col2rhythmic_head (rest_l_arr[0])); - int i = 1; - for (; i < rest_l_arr.size (); i++) - { - Moment me = rhythmic_head2mom (col2rhythmic_head (rest_l_arr[i])); - if (me != m) - break; - } + vector rests; + vector notes; - /* - 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 = get_elt_property ("maximum-rest-count"); - if (i == rest_l_arr.size () - && gh_number_p (s) && gh_scm2int (s) < rest_l_arr.size ()) - { - display_count = gh_scm2int (s); - for (; i > display_count; i--) - col2rhythmic_head (rest_l_arr[i-1]) - ->set_elt_property ("transparent", SCM_BOOL_T); - } + for (vsize i = 0; i < elts.size (); i++) + { + Grob *e = elts[i]; + if (unsmob_grob (e->get_object ("rest"))) + rests.push_back (e); else - display_count = rest_l_arr.size (); - + notes.push_back (e); + } + + /* + handle rest-rest and rest-note collisions + + [todo] + * decide not to print rest if too crowded? + */ + + /* + no partners to collide with + */ + if (rests.size () + notes.size () < 2) + return SCM_BOOL_T; + + Real staff_space = Staff_symbol_referencer::staff_space (me); + /* + only rests + */ + if (!notes.size ()) + { + /* - UGH. Should get dims from table. Should have minimum dist. - */ - int dy = display_count > 2 ? 6 : 4; - if (display_count > 1) - { - rest_l_arr[0]->translate_rests (dy); - rest_l_arr[1]->translate_rests (-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")); + } + + Direction d = LEFT; + do + vector_sort (ordered_rests[d], rest_shift_less); + while (flip (&d) != LEFT) + ; + + do + { + 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; + } + } + while (flip (&d) != LEFT); + + 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))); + } + + do + { + 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); + } + } + while (flip (&d) != LEFT); } - // meisjes met jongetjes - else + else { - if (rest_l_arr.size () > 1) - { - warning (_("too many colliding rests")); - } - if (ncol_l_arr.size () > 1) - { - warning (_("too many notes for rest collision")); - } - Note_column * rcol = rest_l_arr[0]; - - // try to be opposite of noteheads. - Direction dir = - ncol_l_arr[0]->dir(); - - Interval restdim = rcol->rest_dim (); - if (restdim.empty_b ()) - return; - - // staff ref'd? - Real staff_space = paper_l()->get_var ("interline"); - - /* FIXME - staff_space = rcol->rest_l_arr[0]->staff_space (); - */ - Real half_staff_space_f = staff_space/2; - Real minimum_dist = paper_l ()->get_var ("restcollision_minimum_dist") - * half_staff_space_f; - /* - assumption: ref points are the same. - */ - Interval notedim; - for (int i = 0; i < ncol_l_arr.size(); i++) - { - notedim.unite (ncol_l_arr[i]->extent (Y_AXIS)); - } - - Interval inter (notedim); - inter.intersect (restdim); - - Real dist = - minimum_dist + dir * (notedim[dir] - restdim[-dir]) >? 0; - - - // FIXME - //int stafflines = 5; // rcol->rest_l_arr[0]->line_count; - int stafflines = Staff_symbol_referencer_interface (this).line_count (); - // 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); - - rcol->translate_rests (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_BOOL_T; } +ADD_INTERFACE (Rest_collision, + "Move ordinary rests (not multi-measure nor pitched rests)" + " to avoid conflicts.", -Rest_collision::Rest_collision(SCM s) - : Item (s) -{ - set_elt_pointer ("rests", SCM_EOL); - set_elt_pointer ("notes", SCM_EOL); - set_extent_callback (0, X_AXIS); - set_extent_callback (0, Y_AXIS); -} + /* properties */ + "minimum-distance " + "positioning-done " + "elements " + );