2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "note-column.hh"
22 #include <cmath> // ceil
25 #include "accidental-placement.hh"
26 #include "axis-group-interface.hh"
27 #include "directional-element-interface.hh"
28 #include "international.hh"
30 #include "note-head.hh"
31 #include "output-def.hh"
32 #include "pointer-group-interface.hh"
34 #include "staff-symbol-referencer.hh"
39 TODO: figure out if we can prune this class. This is just an
40 annoying layer between (rest)collision & (note-head + stem)
44 Note_column::has_rests (Grob *me)
46 return Grob::unsmob (me->get_object ("rest"));
50 Note_column::shift_less (Grob *const &p1, Grob *const &p2)
52 SCM s1 = p1->get_property ("horizontal-shift");
53 SCM s2 = p2->get_property ("horizontal-shift");
55 int h1 = (scm_is_number (s1)) ? scm_to_int (s1) : 0;
56 int h2 = (scm_is_number (s2)) ? scm_to_int (s2) : 0;
61 Note_column::get_stem (Grob *me)
63 SCM s = me->get_object ("stem");
64 return Item::unsmob (s);
68 Note_column::get_flag (Grob *me)
70 Item *stem = get_stem (me);
73 SCM s = stem->get_object ("flag");
74 return Item::unsmob (s);
80 Note_column::head_positions_interval (Grob *me)
86 extract_grob_set (me, "note-heads", heads);
87 for (vsize i = 0; i < heads.size (); i++)
91 int j = Staff_symbol_referencer::get_rounded_position (se);
92 iv.unite (Slice (j, j));
98 Note_column::dir (Grob *me)
100 Grob *stem = Grob::unsmob (me->get_object ("stem"));
101 if (stem && Stem::has_interface (stem))
102 return get_grob_direction (stem);
105 extract_grob_set (me, "note-heads", heads);
107 return (Direction)sign (head_positions_interval (me).center ());
110 if (has_interface (me))
111 programming_error ("Note_column without heads and stem");
113 programming_error ("dir() given grob without Note_column interface");
118 Note_column::set_stem (Grob *me, Grob *stem)
120 me->set_object ("stem", stem->self_scm ());
121 Axis_group_interface::add_element (me, stem);
125 Note_column::get_rest (Grob *me)
127 return Grob::unsmob (me->get_object ("rest"));
131 Note_column::add_head (Grob *me, Grob *h)
134 if (Rest::has_interface (h))
136 extract_grob_set (me, "note-heads", heads);
140 me->set_object ("rest", h->self_scm ());
142 else if (Note_head::has_interface (h))
144 if (Grob::unsmob (me->get_object ("rest")))
146 Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-heads"), h);
150 me->warning (_ ("cannot have note heads and rests together on a stem"));
152 Axis_group_interface::add_element (me, h);
156 Note_column::first_head (Grob *me)
158 Grob *st = get_stem (me);
159 return st ? Stem::first_head (st) : 0;
163 Return extent of the noteheads in the "main column",
164 (i.e. excluding any suspended noteheads), or extent
165 of the rest (if there are no heads).
168 Note_column::calc_main_extent (Grob *me)
172 main_head = first_head (me);
175 // no stems => no suspended noteheads.
176 extract_grob_set (me, "note-heads", heads);
178 main_head = heads[0];
180 Grob *main_item = main_head
182 : Grob::unsmob (me->get_object ("rest"));
185 ? main_item->extent (me, X_AXIS)
190 Return the first AccidentalPlacement grob that we find in a note-head.
193 Note_column::accidentals (Grob *me)
195 extract_grob_set (me, "note-heads", heads);
197 for (vsize i = 0; i < heads.size (); i++)
200 acc = h ? Grob::unsmob (h->get_object ("accidental-grob")) : 0;
208 if (Accidental_placement::has_interface (acc->get_parent (X_AXIS)))
209 return acc->get_parent (X_AXIS);
216 Note_column::dot_column (Grob *me)
218 extract_grob_set (me, "note-heads", heads);
219 for (vsize i = 0; i < heads.size (); i++)
221 Grob *dots = Grob::unsmob (heads[i]->get_object ("dot"));
223 return dots->get_parent (X_AXIS);
229 /* If a note-column contains a cross-staff stem then
230 nc->extent (Y_AXIS, refp) will not consider the extent of the stem.
231 If you want the extent of the stem to be included (and you are safe
232 from any cross-staff issues) then call this function instead. */
234 Note_column::cross_staff_extent (Grob *me, Grob *refp)
236 Interval iv = me->extent (refp, Y_AXIS);
237 if (Grob *s = get_stem (me))
238 iv.unite (s->extent (refp, Y_AXIS));
243 ADD_INTERFACE (Note_column,
244 "Stem and noteheads combined.",