/*
- dot-column.cc -- implement Dot_column
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.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 "dot-column.hh"
#include <cstdio>
#include <cmath>
#include <map>
+#include <set>
+
using namespace std;
-#include "dots.hh"
+#include "axis-group-interface.hh"
+#include "directional-element-interface.hh"
#include "dot-column.hh"
+#include "dot-configuration.hh"
+#include "dot-formatting-problem.hh"
+#include "dots.hh"
+#include "grob.hh"
+#include "note-head.hh"
+#include "pointer-group-interface.hh"
+#include "rest.hh"
#include "rhythmic-head.hh"
-#include "staff-symbol-referencer.hh"
-#include "directional-element-interface.hh"
#include "side-position-interface.hh"
-#include "axis-group-interface.hh"
+#include "staff-symbol-referencer.hh"
#include "stem.hh"
-#include "grob.hh"
-#include "pointer-group-interface.hh"
-
-/*
- TODO: let Dot_column communicate with stem via Note_column.
-*/
-MAKE_SCHEME_CALLBACK (Dot_column, side_position, 1);
+MAKE_SCHEME_CALLBACK (Dot_column, calc_positioning_done, 1);
SCM
-Dot_column::side_position (SCM smob)
+Dot_column::calc_positioning_done (SCM smob)
{
Grob *me = unsmob_grob (smob);
- extract_grob_set (me, "dots", dots);
-
- for (vsize i = 0; i < dots.size (); i++)
- {
- Grob *head = dots[i]->get_parent (Y_AXIS);
- Grob *stem = head ? unsmob_grob (head->get_object ("stem")) : 0;
- if (stem
- && !Stem::get_beam (stem)
- && Stem::duration_log (stem) > 2
- && !Stem::is_invisible (stem))
- {
- /*
- trigger stem end & direction calculation.
-
- This will add the stem to the support if a flag collision happens.
- */
- stem->get_property ("stem-end-position");
- }
- }
- return Side_position_interface::x_aligned_side (smob, SCM_EOL);
-}
+ /*
+ Trigger note collision resolution first, since that may kill off
+ dots when merging.
+ */
+ if (Grob *collision = unsmob_grob (me->get_object ("note-collision")))
+ (void) collision->get_property ("positioning-done");
-struct Dot_position
-{
- int pos_;
- Direction dir_;
- Grob *dot_;
- bool extremal_head_;
-
- Dot_position ()
- {
- dot_ = 0;
- pos_ = 0;
- dir_ = CENTER;
- extremal_head_ = false;
- }
-};
-
-typedef map<int, Dot_position> Dot_configuration;
+ me->set_property ("positioning-done", SCM_BOOL_T);
-/*
- Value CFG according.
-*/
-int
-dot_config_badness (Dot_configuration const &cfg)
-{
- int t = 0;
- for (Dot_configuration::const_iterator i (cfg.begin ());
- i != cfg.end (); i++)
+ vector<Grob *> dots
+ = extract_grob_array (me, "dots");
+
+ vector<Grob *> parent_stems;
+ Real ss = 0;
+
+ Grob *commonx = me;
+ for (vsize i = 0; i < dots.size (); i++)
{
- int p = i->first;
- int demerit = sqr (p - i->second.pos_) * 2;
-
- int dot_move_dir = sign (p - i->second.pos_);
- if (i->second.extremal_head_)
- {
- if (i->second.dir_
- && dot_move_dir != i->second.dir_)
- demerit += 3;
- else if (dot_move_dir != UP)
- demerit += 2;
- }
- else if (dot_move_dir != UP)
- demerit += 1;
-
- t += demerit;
- }
+ Grob *n = dots[i]->get_parent (Y_AXIS);
+ commonx = n->common_refpoint (commonx, X_AXIS);
- return t;
-}
+ if (Grob *stem = unsmob_grob (n->get_object ("stem")))
+ {
+ commonx = stem->common_refpoint (commonx, X_AXIS);
-void
-print_dot_configuration (Dot_configuration const &cfg)
-{
- printf ("dotconf { ");
- for (Dot_configuration::const_iterator i (cfg.begin ());
- i != cfg.end (); i++)
- printf ("%d, ", i->first);
- printf ("} \n");
-}
+ if (Stem::first_head (stem) == n)
+ parent_stems.push_back (stem);
+ }
+ }
-/*
- Shift K and following (preceding) entries up (down) as necessary to
- prevent staffline collisions if D is up (down).
+ vector<Box> boxes;
+ set<Grob *> stems;
- If K is in CFG, then do nothing.
-*/
+ extract_grob_set (me, "side-support-elements", support);
-Dot_configuration
-shift_one (Dot_configuration const &cfg,
- int k, Direction d)
-{
- Dot_configuration new_cfg;
- int offset = 0;
+ Interval base_x;
+ for (vsize i = 0; i < parent_stems.size (); i++)
+ base_x.unite (Stem::first_head (parent_stems[i])->extent (commonx, X_AXIS));
- if (d > 0)
+ for (vsize i = 0; i < support.size (); i++)
{
- for (Dot_configuration::const_iterator i (cfg.begin ());
- i != cfg.end (); i++)
- {
- int p = i->first;
- if (p == k)
- {
- if (Staff_symbol_referencer::on_line (i->second.dot_, p))
- p += d;
- else
- p += 2* d;
-
- offset = 2*d;
-
- new_cfg[p] = i->second;
- }
- else
- {
- if (new_cfg.find (p) == new_cfg.end ())
- offset = 0;
- new_cfg[p + offset] = i->second;
- }
- }
+ Grob *s = support[i];
+ if (!ss)
+ ss = Staff_symbol_referencer::staff_space (s);
+
+ /* can't inspect Y extent of rest.
+
+ Rest collisions should wait after line breaking.
+ */
+ Interval y;
+ if (Rest::has_interface (s))
+ {
+ base_x.unite (s->extent (commonx, X_AXIS));
+ continue;
+ }
+ else if (Stem::has_interface (s))
+ {
+ Real y1 = Stem::head_positions (s)[-get_grob_direction (s)];
+ Real y2 = y1 + get_grob_direction (s) * 7;
+
+ y.add_point (y1);
+ y.add_point (y2);
+
+ stems.insert (s);
+ }
+ else if (Note_head::has_interface (s))
+ y = Interval (-1.1, 1.1);
+ else
+ {
+ programming_error ("unknown grob in dot col support");
+ continue;
+ }
+
+ y += Staff_symbol_referencer::get_position (s);
+
+ Box b (s->extent (commonx, X_AXIS), y);
+ boxes.push_back (b);
+
+ if (Grob *stem = unsmob_grob (s->get_object ("stem")))
+ stems.insert (stem);
}
- else
+
+ for (set<Grob *>::const_iterator i (stems.begin ());
+ i != stems.end (); i++)
{
- Dot_configuration::const_iterator i (cfg.end ());
- do
- {
- i--;
-
- int p = i->first;
- if (p == k)
- {
- if (Staff_symbol_referencer::on_line (i->second.dot_, p))
- p += d;
- else
- p += 2* d;
-
- offset = 2*d;
-
- new_cfg[p] = i->second;
- }
- else
- {
- if (new_cfg.find (p) == new_cfg.end ())
- offset = 0;
-
- new_cfg[p + offset] = i->second;
- }
- }
- while (i != cfg.begin ());
+ Grob *stem = (*i);
+ Grob *flag = Stem::flag (stem);
+ if (flag)
+ {
+ Grob *commony = stem->common_refpoint (flag, Y_AXIS);
+ Interval y = flag->extent (commony, Y_AXIS) * (2 / ss);
+ Interval x = flag->extent (commonx, X_AXIS);
+
+ boxes.push_back (Box (x, y));
+ }
}
- return new_cfg;
-}
-
-/*
- Remove the collision in CFG either by shifting up or down, whichever
- is best.
-*/
-void
-remove_collision (Dot_configuration &cfg, int p)
-{
- bool collide = cfg.find (p) != cfg.end ();
-
- if (collide)
+ /*
+ The use of pure_position_less and pure_get_rounded_position below
+ are due to the fact that this callback is called before line breaking
+ occurs. Because dots' actual Y posiitons may be linked to that of
+ beams (dots are attached to rests, which are shifted to avoid beams),
+ we instead must use their pure Y positions.
+ */
+ vector_sort (dots, pure_position_less);
+
+ SCM chord_dots_limit = me->get_property ("chord-dots-limit");
+ if (scm_is_number (chord_dots_limit))
{
- Dot_configuration cfg_up = shift_one (cfg, p, UP);
- Dot_configuration cfg_down = shift_one (cfg, p, DOWN);
-
- int b_up = dot_config_badness (cfg_up);
- int b_down = dot_config_badness (cfg_down);
-
- cfg = (b_up < b_down) ? cfg_up : cfg_down;
+ // Sort dots by stem, then check for dots above the limit for each stem
+ vector <vector <Grob *> > dots_each_stem (parent_stems.size ());
+ for (vsize i = 0; i < dots.size (); i++)
+ if (Grob *stem = unsmob_grob (dots[i]->get_parent (Y_AXIS)
+ -> get_object ("stem")))
+ for (vsize j = 0; j < parent_stems.size (); j++)
+ if (stem == parent_stems[j])
+ {
+ dots_each_stem[j].push_back (dots[i]);
+ break;
+ }
+ for (vsize j = 0; j < parent_stems.size (); j++)
+ {
+ Interval chord = Stem::head_positions (parent_stems[j]);
+ int total_room = ((int) chord.length () + 2
+ + scm_to_int (chord_dots_limit)) / 2;
+ int total_dots = dots_each_stem[j].size ();
+ // remove excessive dots from the ends of the stem
+ for (int first_dot = 0; total_dots > total_room; total_dots--)
+ if (0 == (total_dots - total_room) % 2)
+ dots_each_stem[j][first_dot++]->suicide ();
+ else
+ dots_each_stem[j][first_dot + total_dots - 1]->suicide ();
+ }
}
-}
-MAKE_SCHEME_CALLBACK(Dot_column, calc_positioning_done, 1);
-SCM
-Dot_column::calc_positioning_done (SCM smob)
-{
- Grob *me = unsmob_grob (smob);
-
- me->set_property ("positioning-done", SCM_BOOL_T);
-
- vector<Grob*> dots
- = extract_grob_array (me, "dots");
-
- { /*
- Trigger note collision resolution first, since that may kill off
- dots when merging.
- */
- Grob *c = 0;
- for (vsize i = dots.size (); i--;)
- {
- Grob *n = dots[i]->get_parent (Y_AXIS);
- if (c)
- c = n->common_refpoint (c, X_AXIS);
- else
- c = n;
- }
- for (vsize i = dots.size (); i--;)
- {
- Grob *n = dots[i]->get_parent (Y_AXIS);
- n->relative_coordinate (c, X_AXIS);
- }
- }
-
- vector_sort (dots, position_less);
for (vsize i = dots.size (); i--;)
- if (!dots[i]->is_live ())
- dots.erase (dots.begin () + i);
+ {
+ if (!dots[i]->is_live ())
+ dots.erase (dots.begin () + i);
+ else
+ // Undo any fake translations that were done in add_head.
+ dots[i]->translate_axis (-dots[i]->relative_coordinate (me, X_AXIS), X_AXIS);
+ }
+
+ Dot_formatting_problem problem (boxes, base_x);
- Dot_configuration cfg;
- for (vsize i = 0;i < dots.size (); i++)
+ Dot_configuration cfg (problem);
+ for (vsize i = 0; i < dots.size (); i++)
{
Dot_position dp;
dp.dot_ = dots[i];
Grob *note = dots[i]->get_parent (Y_AXIS);
if (note)
- {
- Grob *stem = unsmob_grob (note->get_object ("stem"));
- if (stem)
- dp.extremal_head_ = Stem::first_head (stem) == note;
- }
+ {
+ if (Note_head::has_interface (note))
+ dp.dir_ = to_dir (dp.dot_->get_property ("direction"));
- int p = Staff_symbol_referencer::get_rounded_position (dp.dot_);
+ dp.x_extent_ = note->extent (commonx, X_AXIS);
+ }
+
+ int p = Staff_symbol_referencer::pure_get_rounded_position (dp.dot_);
/* icky, since this should go via a Staff_symbol_referencer
- offset callback but adding a dot overwrites Y-offset. */
+ offset callback but adding a dot overwrites Y-offset. */
p += (int) robust_scm2double (dp.dot_->get_property ("staff-position"), 0.0);
dp.pos_ = p;
- if (dp.extremal_head_)
- dp.dir_ = to_dir (dp.dot_->get_property ("direction"));
-
- remove_collision (cfg, p);
+ cfg.remove_collision (p);
cfg[p] = dp;
- if (Staff_symbol_referencer::on_line (dp.dot_, p))
- remove_collision (cfg, p);
+ if (Staff_symbol_referencer::on_line (dp.dot_, p) &&
+ dp.dot_->get_property ("style") != ly_symbol2scm ("kievan"))
+ cfg.remove_collision (p);
}
+ problem.register_configuration (cfg);
+
for (Dot_configuration::const_iterator i (cfg.begin ());
i != cfg.end (); i++)
{
/*
- Junkme?
+ Junkme?
*/
- Staff_symbol_referencer::set_position (i->second.dot_, i->first);
+ Staff_symbol_referencer::pure_set_position (i->second.dot_, i->first);
}
+
+ me->translate_axis (cfg.x_offset () - me->relative_coordinate (commonx, X_AXIS),
+ X_AXIS);
return SCM_BOOL_T;
}
void
-Dot_column::add_head (Grob *me, Grob *rh)
+Dot_column::add_head (Grob *me, Grob *head)
{
- Grob *d = unsmob_grob (rh->get_object ("dot"));
+ Grob *d = unsmob_grob (head->get_object ("dot"));
if (d)
{
- Side_position_interface::add_support (me, rh);
+ Side_position_interface::add_support (me, head);
Pointer_group_interface::add_grob (me, ly_symbol2scm ("dots"), d);
d->set_property ("Y-offset", Grob::x_parent_positioning_proc);
+ // Dot formatting requests the Y-offset, which for rests may
+ // trigger post-linebreak callbacks. On the other hand, we need the
+ // correct X-offset of the dots for horizontal collision avoidance.
+ // The translation here is undone in calc_positioning_done, where we
+ // do the X-offset properly.
+ if (Rest::has_interface (head))
+ d->translate_axis (head->extent (head, X_AXIS).length (), X_AXIS);
+ else
+ d->set_property ("X-offset", Grob::x_parent_positioning_proc);
Axis_group_interface::add_element (me, d);
}
}
ADD_INTERFACE (Dot_column,
-
- "Groups dot objects so they form a column, and position dots so they do not "
- "clash with staff lines ",
-
- /* properties */
- "dots "
- "positioning-done "
- "direction "
- );
+ "Group dot objects so they form a column, and position"
+ " dots so they do not clash with staff lines.",
+
+ /* properties */
+ "chord-dots-limit "
+ "dots "
+ "positioning-done "
+ "direction "
+ "note-collision "
+ );
projects / lilypond.git / blobdiff