/*
- 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 "group-interface.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)
{
- SCM r = get_elt_property ("rests");
-
- return gh_pair_p (r);
+ return unsmob<Grob> (me->get_object ("rest"));
}
-int
-Note_column::shift_compare (Note_column *const &p1, Note_column*const&p2)
+bool
+Note_column::shift_less (Grob *const &p1, Grob *const &p2)
{
- SCM s1 = p1->get_elt_property ("horizontal-shift");
- SCM s2 = p2->get_elt_property ("horizontal-shift");
+ SCM s1 = p1->get_property ("horizontal-shift");
+ SCM s2 = p2->get_property ("horizontal-shift");
- int h1 = (s1 == SCM_UNDEFINED) ? 0 : gh_scm2int (s1);
- int h2 = (s2 == SCM_UNDEFINED) ? 0 : gh_scm2int (s2);
- return h1 - h2;
+ 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;
}
-Note_column::Note_column()
+Item *
+Note_column::get_stem (Grob *me)
{
- set_elt_property ("rests", SCM_EOL);
- set_elt_property ("note-heads", SCM_EOL);
- set_axes (X_AXIS, Y_AXIS);
+ SCM s = me->get_object ("stem");
+ return unsmob<Item> (s);
}
-Stem *
-Note_column::stem_l () const
+Item *
+Note_column::get_flag (Grob *me)
{
- SCM s = get_elt_property ("stem");
- return dynamic_cast<Stem*> (unsmob_element (s));
-
+ Item *stem = get_stem (me);
+ if (stem)
+ {
+ SCM s = stem->get_object ("flag");
+ return unsmob<Item> (s);
+ }
+ return 0;
}
-
Slice
-Note_column::head_positions_interval() const
+Note_column::head_positions_interval (Grob *me)
{
- Slice iv;
+ Slice iv;
iv.set_empty ();
- SCM h = get_elt_property ("note-heads");
- for (; gh_pair_p (h); h = gh_cdr (h))
+ extract_grob_set (me, "note-heads", heads);
+ for (vsize i = 0; i < heads.size (); i++)
{
- Score_element *se = unsmob_element (gh_car (h));
- Staff_symbol_referencer_interface si (se);
-
- int j = int (si.position_f ());
- iv.unite (Slice (j,j));
+ 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 ()->get_direction ();
- else if (gh_pair_p (get_elt_property ("note-heads")))
- return (Direction)sign (head_positions_interval().center ());
+ Grob *stem = unsmob<Grob> (me->get_object ("stem"));
+ if (has_interface<Stem> (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 ());
+ }
- programming_error ("Note column without heads and stem!");
+ if (has_interface<Note_column> (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)
{
- set_elt_property ("stem", stem_l->self_scm_);
-
- add_dependency (stem_l);
- add_element (stem_l);
+ me->set_object ("stem", stem->self_scm ());
+ Axis_group_interface::add_element (me, stem);
}
-
+Grob *
+Note_column::get_rest (Grob *me)
+{
+ return unsmob<Grob> (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 (has_interface<Rest> (h))
{
- Group_interface gi (this, "rests");
- gi.add_element (h);
+ 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 (has_interface<Note_head> (h))
{
- Group_interface gi (this, "note-heads");
- gi.add_element (nh);
+ if (unsmob<Grob> (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 vertically by amount DY_I.
- */
-void
-Note_column::translate_rests (int dy_i)
+Grob *
+Note_column::first_head (Grob *me)
{
- SCM s = get_elt_property ("rests");
- for (; gh_pair_p (s); s = gh_cdr (s))
- {
- Score_element * se = unsmob_element (gh_car (s));
- Staff_symbol_referencer_interface si (se);
-
- se->translate_axis (dy_i * si.staff_line_leading_f ()/2.0, Y_AXIS);
- }
+ Grob *st = get_stem (me);
+ return st ? Stem::first_head (st) : 0;
}
-
-void
-Note_column::set_dotcol (Dot_column *d)
+/*
+ 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)
{
- add_element (d);
+ 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
+ : unsmob<Grob> (me->get_object ("rest"));
+
+ return main_item
+ ? main_item->extent (me, X_AXIS)
+ : Interval (0, 0);
}
/*
- [TODO]
- handle rest under beam (do_post: beams are calculated now)
- what about combination of collisions and rest under beam.
-
- Should lookup
-
- rest -> stem -> beam -> interpolate_y_position ()
-
+ Return the first AccidentalPlacement grob that we find in a note-head.
*/
-
-void
-Note_column::do_post_processing ()
+Grob *
+Note_column::accidentals (Grob *me)
{
- if (!stem_l () || !rest_b ())
- return;
-
- Beam * b = stem_l ()->beam_l ();
- if (!b || !b->stem_count ())
- return;
-
- /* ugh. Should be done by beam.
- (what? should be done --jcn)
- scary too?: height is calculated during post_processing
- */
- Real dy = 0;
- Real y = 0;
- SCM s = b->get_elt_property ("height");
- if (s != SCM_UNDEFINED)
- dy = gh_scm2double (s);
- s = b->get_elt_property ("y-position");
- if (s != SCM_UNDEFINED)
- y = gh_scm2double (s);
-
- Real x0 = b->first_visible_stem ()->hpos_f ();
- Real dydx = b->last_visible_stem ()->hpos_f () - x0;
-
- Direction d = stem_l ()->get_direction ();
- Real beamy = (stem_l ()->hpos_f () - x0) * dydx + y;
-
- s = get_elt_property ("rests");
- Score_element * se = unsmob_element (gh_car (s));
- Staff_symbol_referencer_interface si (se);
-
- Real staff_space = si.staff_line_leading_f ();
- Real rest_dim = extent (Y_AXIS)[d]*2.0 /staff_space ;
-
- Real minimum_dist
- = paper_l ()->get_var ("restcollision_minimum_beamdist") ;
- Real dist =
- minimum_dist + -d * (beamy - rest_dim) >? 0;
-
- int stafflines = si.lines_i ();
-
- // move discretely by half spaces.
- int discrete_dist = int (ceil (dist ));
-
- // 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);
-}
+ extract_grob_set (me, "note-heads", heads);
+ Grob *acc = 0;
+ for (vsize i = 0; i < heads.size (); i++)
+ {
+ Grob *h = heads[i];
+ acc = h ? unsmob<Grob> (h->get_object ("accidental-grob")) : 0;
+ if (acc)
+ break;
+ }
+ if (!acc)
+ return 0;
-Interval
-Note_column::rest_dim () const
+ if (has_interface<Accidental_placement> (acc->get_parent (X_AXIS)))
+ return acc->get_parent (X_AXIS);
+
+ /* compatibility. */
+ return acc;
+}
+
+Grob *
+Note_column::dot_column (Grob *me)
{
- Interval restdim;
- SCM s = get_elt_property ("rests");
- for (; gh_pair_p (s); s = gh_cdr (s))
+ extract_grob_set (me, "note-heads", heads);
+ for (vsize i = 0; i < heads.size (); i++)
{
- Score_element * sc = unsmob_element ( gh_car (s));
- restdim.unite (sc->extent (Y_AXIS));
+ Grob *dots = unsmob<Grob> (heads[i]->get_object ("dot"));
+ if (dots)
+ return dots->get_parent (X_AXIS);
}
-
- return restdim;
+
+ return 0;
}
-Note_head*
-Note_column::first_head () const
+/* 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)
{
- Stem * st = stem_l ();
- return st? st->first_head (): 0;
+ 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 "
+ "glissando-skip "
+ );
projects / lilypond.git / blobdiff