/*
- note-column.cc -- implement Note_column
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.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 "note-column.hh"
-#include "beam.hh"
+
+#include <cmath> // ceil
+using namespace std;
+
+#include "accidental-placement.hh"
+#include "axis-group-interface.hh"
+#include "directional-element-interface.hh"
+#include "international.hh"
+#include "item.hh"
#include "note-head.hh"
-#include "stem.hh"
+#include "output-def.hh"
+#include "pointer-group-interface.hh"
#include "rest.hh"
-#include "debug.hh"
-#include "paper-def.hh"
+#include "staff-symbol-referencer.hh"
+#include "stem.hh"
+#include "warn.hh"
+
+/*
+ TODO: figure out if we can prune this class. This is just an
+ annoying layer between (rest)collision & (note-head + stem)
+*/
bool
-Note_column::rest_b () const
+Note_column::has_rests (Grob *me)
{
- return rest_l_arr_.size ();
+ return Grob::is_smob (me->get_object ("rest"));
}
-Note_column::Note_column()
+bool
+Note_column::shift_less (Grob *const &p1, Grob *const &p2)
{
- set_axes (X_AXIS,X_AXIS);
- stem_l_ = 0;
+ SCM s1 = p1->get_property ("horizontal-shift");
+ SCM s2 = p2->get_property ("horizontal-shift");
+
+ int h1 = (scm_is_number (s1)) ? scm_to_int (s1) : 0;
+ int h2 = (scm_is_number (s2)) ? scm_to_int (s2) : 0;
+ return h1 < h2;
}
-void
-Note_column::sort()
+Item *
+Note_column::get_stem (Grob *me)
+{
+ SCM s = me->get_object ("stem");
+ return Item::unsmob (s);
+}
+
+Item *
+Note_column::get_flag (Grob *me)
{
- head_l_arr_.sort (Note_head::compare);
+ Item *stem = get_stem (me);
+ if (stem)
+ {
+ SCM s = stem->get_object ("flag");
+ return Item::unsmob (s);
+ }
+ return 0;
}
-
-Interval_t<int>
-Note_column::head_positions_interval() const
+
+Slice
+Note_column::head_positions_interval (Grob *me)
{
- ((Note_column*)this)->sort();
- Interval_t<int> iv;
+ Slice iv;
iv.set_empty ();
- if (head_l_arr_.size ())
- iv = Interval_t<int>(head_l_arr_[0]->position_i_,
- head_l_arr_.top()->position_i_);
-
+ extract_grob_set (me, "note-heads", heads);
+ for (vsize i = 0; i < heads.size (); i++)
+ {
+ Grob *se = heads[i];
+
+ int j = Staff_symbol_referencer::get_rounded_position (se);
+ iv.unite (Slice (j, j));
+ }
return iv;
}
Direction
-Note_column::dir () const
+Note_column::dir (Grob *me)
{
- if (stem_l_)
- return stem_l_->dir_;
- else if (head_l_arr_.size ())
- return sign (head_positions_interval().center ());
+ Grob *stem = Grob::unsmob (me->get_object ("stem"));
+ if (stem && Stem::has_interface (stem))
+ return get_grob_direction (stem);
+ else
+ {
+ extract_grob_set (me, "note-heads", heads);
+ if (heads.size ())
+ return (Direction)sign (head_positions_interval (me).center ());
+ }
- assert (false);
+ if (has_interface (me))
+ programming_error ("Note_column without heads and stem");
+ else
+ programming_error ("dir() given grob without Note_column interface");
return CENTER;
}
-
void
-Note_column::set_stem (Stem * stem_l)
+Note_column::set_stem (Grob *me, Grob *stem)
{
- stem_l_ = stem_l;
- add_dependency (stem_l);
- add_element (stem_l);
+ me->set_object ("stem", stem->self_scm ());
+ Axis_group_interface::add_element (me, stem);
}
-
-void
-Note_column::do_substitute_element_pointer (Score_element*o, Score_element*n)
+Grob *
+Note_column::get_rest (Grob *me)
{
- if (stem_l_ == o)
- {
- stem_l_ = n ? dynamic_cast<Stem *> (n):0;
- }
- if (dynamic_cast<Note_head *> (o))
- {
- head_l_arr_.substitute (dynamic_cast<Note_head *> (o),
- (n)? dynamic_cast<Note_head *> (n) : 0);
- }
-
- if (dynamic_cast<Rest *> (o))
- {
- rest_l_arr_.substitute (dynamic_cast<Rest *> (o),
- (n)? dynamic_cast<Rest *> (n) : 0);
- }
+ return Grob::unsmob (me->get_object ("rest"));
}
void
-Note_column::add_head (Rhythmic_head *h)
+Note_column::add_head (Grob *me, Grob *h)
{
- if (Rest*r=dynamic_cast<Rest *> (h))
+ bool both = false;
+ if (Rest::has_interface (h))
{
- rest_l_arr_.push (r);
+ extract_grob_set (me, "note-heads", heads);
+ if (heads.size ())
+ both = true;
+ else
+ me->set_object ("rest", h->self_scm ());
}
- if (Note_head *nh=dynamic_cast<Note_head *> (h))
+ else if (Note_head::has_interface (h))
{
- head_l_arr_.push (nh);
+ if (Grob::is_smob (me->get_object ("rest")))
+ both = true;
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-heads"), h);
}
- add_element (h);
+
+ if (both)
+ me->warning (_ ("cannot have note heads and rests together on a stem"));
+ else
+ Axis_group_interface::add_element (me, h);
}
-/**
- translate the rest symbols
- */
-void
-Note_column::translate_rests (int dy_i)
+Grob *
+Note_column::first_head (Grob *me)
{
- invalidate_cache (Y_AXIS);
- for (int i=0; i < rest_l_arr_.size(); i++)
- rest_l_arr_[i]->position_i_ += dy_i;
+ Grob *st = get_stem (me);
+ return st ? Stem::first_head (st) : 0;
}
-void
-Note_column::do_print() const
+/*
+ Return extent of the noteheads in the "main column",
+ (i.e. excluding any suspended noteheads), or extent
+ of the rest (if there are no heads).
+*/
+Interval
+Note_column::calc_main_extent (Grob *me)
{
-#ifndef NPRINT
- DOUT << "rests: " << rest_l_arr_.size() << ", ";
- DOUT << "heads: " << head_l_arr_.size();
-#endif
+ Grob *main_head = 0;
+ if (get_stem (me))
+ main_head = first_head (me);
+ else
+ {
+ // no stems => no suspended noteheads.
+ extract_grob_set (me, "note-heads", heads);
+ if (heads.size())
+ main_head = heads[0];
+ }
+ Grob *main_item = main_head
+ ? main_head
+ : Grob::unsmob (me->get_object ("rest"));
+
+ return main_item
+ ? main_item->extent (me, X_AXIS)
+ : Interval (0, 0);
}
-void
-Note_column::set_dotcol (Dot_column *d)
+/*
+ Return the first AccidentalPlacement grob that we find in a note-head.
+*/
+Grob *
+Note_column::accidentals (Grob *me)
{
- add_element (d);
+ extract_grob_set (me, "note-heads", heads);
+ Grob *acc = 0;
+ for (vsize i = 0; i < heads.size (); i++)
+ {
+ Grob *h = heads[i];
+ acc = h ? Grob::unsmob (h->get_object ("accidental-grob")) : 0;
+ if (acc)
+ break;
+ }
+
+ if (!acc)
+ return 0;
+
+ if (Accidental_placement::has_interface (acc->get_parent (X_AXIS)))
+ return acc->get_parent (X_AXIS);
+
+ /* compatibility. */
+ return acc;
}
- /*
- [TODO]
- handle rest under beam (do_post: beams are calculated now)
- what about combination of collisions and rest under beam.
+Grob *
+Note_column::dot_column (Grob *me)
+{
+ extract_grob_set (me, "note-heads", heads);
+ for (vsize i = 0; i < heads.size (); i++)
+ {
+ Grob *dots = Grob::unsmob (heads[i]->get_object ("dot"));
+ if (dots)
+ return dots->get_parent (X_AXIS);
+ }
- Should lookup
-
- rest -> stem -> beam -> interpolate_y_position ()
-
- */
+ return 0;
+}
-void
-Note_column::do_post_processing ()
+/* If a note-column contains a cross-staff stem then
+ nc->extent (Y_AXIS, refp) will not consider the extent of the stem.
+ If you want the extent of the stem to be included (and you are safe
+ from any cross-staff issues) then call this function instead. */
+Interval
+Note_column::cross_staff_extent (Grob *me, Grob *refp)
{
- if (!stem_l_ || !rest_b ())
- return;
-
- Beam * b = stem_l_->beam_l_;
- if (!b)
- return;
-
- /* ugh. Should be done by beam. */
- Real x = stem_l_->hpos_f ();
- Direction d = stem_l_->get_dir ();
- Real beamy = x * b->slope_f_ + b->left_y_;
- Interval restdim = extent (Y_AXIS);
-
- Real staff_space = rest_l_arr_[0]->staff_line_leading_f ();
- Real internote_f = staff_space/2;
- Real minimum_dist
- = paper_l ()->get_var ("restcollision_minimum_beamdist") * internote_f;
- Real dist =
- minimum_dist + -d * (beamy - restdim[d]) >? 0;
-
- int stafflines = rest_l_arr_[0]->lines_i ();
-
- // 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);
-
- translate_rests (-d * discrete_dist);
+ Interval iv = me->extent (refp, Y_AXIS);
+ if (Grob *s = get_stem (me))
+ iv.unite (s->extent (refp, Y_AXIS));
+
+ return iv;
}
+
+ADD_INTERFACE (Note_column,
+ "Stem and noteheads combined.",
+
+ /* properties */
+ "force-hshift "
+ "horizontal-shift "
+ "ignore-collision "
+ "note-heads "
+ "rest "
+ "rest-collision "
+ "stem "
+ );