/*
- 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 <hanwen@xs4all.nl>
- (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+ 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 <http://www.gnu.org/licenses/>.
*/
-#include "debug.hh"
#include "rest-collision.hh"
-#include "rest-column.hh"
+
+#include <cmath> // ceil.
+using namespace std;
+
+#include "directional-element-interface.hh"
+#include "duration.hh"
+#include "international.hh"
+#include "item.hh"
#include "note-column.hh"
+#include "output-def.hh"
+#include "pointer-group-interface.hh"
+#include "rest.hh"
+#include "rhythmic-head.hh"
+#include "staff-symbol-referencer.hh"
#include "stem.hh"
-#include "note-head.hh"
-#include "collision.hh"
-#include "paper-def.hh"
+#include "grob.hh"
+#include "warn.hh"
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1, "");
+SCM
+Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
+{
+ Grob *rest_grob = unsmob_grob (rest);
+ Grob *parent = rest_grob->get_parent (X_AXIS);
-IMPLEMENT_IS_TYPE_B1(Rest_collision,Item);
+ /*
+ 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);
-void
-Rest_collision::add (Note_column *nc_l)
-{
- add_dependency (nc_l);
- ncol_l_arr_.push (nc_l);
+ 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);
}
void
-Rest_collision::add (Rest_column *rc_l)
+Rest_collision::add_column (Grob *me, Grob *p)
{
- add_dependency (rc_l);
- rest_l_arr_.push (rc_l);
+ 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);
+ }
}
-void
-Rest_collision::do_post_processing()
+static bool
+rest_shift_less (Grob *const &r1, Grob *const &r2)
{
- /*
- handle rest under beam (do_post: beams are calculated now)
-
- [todo]
- i-d like to have access to the beam itself,
- iso only the (half-initialised?) stem
-
- what about combination of collisions and rest under beam
- */
-
- // no rests to collide
- if (!rest_l_arr_.size())
- return;
- // can this happen?
- Stem* stem_l = rest_l_arr_[0]->stem_l_;
- if (!stem_l)
- return;
- // no beam
- if (!(stem_l->beams_left_i_ || stem_l->beams_right_i_))
- return;
-
- int dir_i = rest_l_arr_[0]->dir_i_;
- int midpos = 4;
-#if 1
- // ugh
- int stem_length_i = 7 - 2;
- // ugh, Stem::stem_start vs Stem::stem_end
- int pos = (stem_l->stem_end_f() - midpos) - dir_i * stem_length_i;
-#else // nogo: stem_start not set for rests?
- int pos = (stem_l->stem_start_f() - midpos) + dir_i * 2;
-#endif
- rest_l_arr_[0]->translate_heads (pos);
+ Grob *col1 = r1->get_parent (X_AXIS);
+ Grob *col2 = r2->get_parent (X_AXIS);
+ return Note_column::shift_less (col1, col2);
}
-void
-Rest_collision::do_pre_processing()
+/*
+ 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)
{
- /*
- handle rest-rest and rest-note collisions
-
- [todo]
- decide not to print rest if too crowded?
- */
-
- // no rests to collide
- if (!rest_l_arr_.size())
- return;
-
- // no partners to collide with
- if (rest_l_arr_.size() + ncol_l_arr_.size () < 2)
- return;
-
- // meisjes met meisjes
- if (!ncol_l_arr_.size()) {
- int dy = rest_l_arr_.size() > 2 ? 6 : 4;
-
- rest_l_arr_[0]->translate_heads (rest_l_arr_[0]->dir_i_ *dy);
- // top is last element...
- rest_l_arr_.top()->translate_heads (rest_l_arr_.top ()->dir_i_* dy);
+ Grob *me = unsmob_grob (smob);
+
+ me->set_property ("positioning-done", SCM_BOOL_T);
+
+ extract_grob_set (me, "elements", elts);
+
+ vector<Grob *> rests;
+ vector<Grob *> notes;
+
+ for (vsize i = 0; i < elts.size (); i++)
+ {
+ Grob *e = elts[i];
+ if (unsmob_grob (e->get_object ("rest")))
+ rests.push_back (e);
+ else
+ notes.push_back (e);
}
- // meisjes met jongetjes
- else {
-#if 0 // breendet: rests go always under
- // geen gemug, trug op je rug
- int dir_i = -1;
- rest_l_arr_[0]->translate_heads (dir_i * 3);
-#else
- // int dir_i = - ncol_l_arr_[0]->dir_i_;
- int dir_i = rest_l_arr_[0]->dir_i_;
- // hope it's 4: if it works->doco
- int midpos = 4;
-
- // minimum move
- int minpos = 4;
-
- // quart rest height
- // UGH Should get dims from table!
- int size_i = 6;
-
- int sep_i = 3 + size_i / 2;
- for (int i = 0; i < ncol_l_arr_.size(); i++) {
- // how to know whether to sort?
- ncol_l_arr_[i]->sort();
- for ( int j = 0; j < ncol_l_arr_[i]->head_l_arr_.size(); j++)
- minpos = minpos >? dir_i *
- (ncol_l_arr_[i]->head_l_arr_[j]->position_i_ -midpos) + sep_i;
- }
- rest_l_arr_[0]->translate_heads (dir_i * minpos);
-#endif
+
+ /*
+ 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 ())
+ {
+
+ /*
+ This is incomplete: in case of an uneven number of rests, the
+ center one should be centered on the staff.
+ */
+ Drul_array<vector<Grob *> > 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);
+ }
+ }
}
-}
+ else
+ {
+ /*
+ Rests and notes.
+ */
+ // Count how many rests we move
+ Drul_array<int> rcount (0, 0);
-void
-Rest_collision::do_print() const
-{
-#ifndef NPRINT
- DOUT << "rests: " << rest_l_arr_.size() << ", ";
- DOUT << "cols: " << ncol_l_arr_.size();
-#endif
-}
+ for (vsize i = 0; i < rests.size (); i++)
+ {
+ Grob *rcol = rests[i];
+ Grob *rest = Note_column::get_rest (rcol);
-void
-Rest_collision::do_substitute_dependency (Score_elem*o,Score_elem*n)
-{
- Item*o_l = o->item();
- Item*n_l = n?n->item():0;
-
- rest_l_arr_.substitute ((Rest_column*)o_l,(Rest_column*)n_l);
- ncol_l_arr_.substitute ((Note_column*)o_l,(Note_column*)n_l);
-}
+ Direction dir = get_grob_direction (rest);
+ if (!dir)
+ dir = Note_column::dir (rcol);
-Rest_collision::Rest_collision()
-{
- transparent_b_ = true;
- empty_b_ = true;
+ // 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<Item *> (notes[i])->get_column () != dynamic_cast<Item *> (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);
+
+ // move discretely by half spaces.
+ int discrete_y = dir * int (ceil (y / (0.5 * dir * staff_space)));
+
+ Interval staff_span = Staff_symbol_referencer::staff_span (rest);
+ staff_span.widen (1);
+ // move by whole spaces inside the staff.
+ if (staff_span.contains
+ (Staff_symbol_referencer::get_position (rest) + discrete_y))
+ {
+ 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.",
+
+ /* properties */
+ "minimum-distance "
+ "positioning-done "
+ "elements "
+ );
+
projects / lilypond.git / blobdiff