2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2012 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::accidental_width (Grob *me)
46 extract_grob_set (me, "note-heads", nhs);
48 for (vsize i = 0; i < nhs.size (); i++)
49 if (Grob *acc = unsmob_grob (nhs[i]->get_object ("accidental-grob")))
52 Grob *common = common_refpoint_of_array (accs, me, X_AXIS);
53 common = common_refpoint_of_array (nhs, common, X_AXIS);
55 Interval nhs_ex = Axis_group_interface::relative_group_extent (nhs, common, X_AXIS);
56 Interval accs_ex = Axis_group_interface::relative_group_extent (accs, common, X_AXIS);
58 if (nhs_ex.is_empty ())
61 // want an empty interval here
62 if (accs_ex.is_empty ())
65 return Interval (accs_ex[LEFT], nhs_ex[LEFT]);
69 Note_column::has_rests (Grob *me)
71 return unsmob_grob (me->get_object ("rest"));
75 Note_column::shift_less (Grob *const &p1, Grob *const &p2)
77 SCM s1 = p1->get_property ("horizontal-shift");
78 SCM s2 = p2->get_property ("horizontal-shift");
80 int h1 = (scm_is_number (s1)) ? scm_to_int (s1) : 0;
81 int h2 = (scm_is_number (s2)) ? scm_to_int (s2) : 0;
86 Note_column::get_stem (Grob *me)
88 SCM s = me->get_object ("stem");
89 return unsmob_item (s);
93 Note_column::get_flag (Grob *me)
95 Item *stem = get_stem (me);
98 SCM s = stem->get_object ("flag");
99 return unsmob_item (s);
105 Note_column::head_positions_interval (Grob *me)
111 extract_grob_set (me, "note-heads", heads);
112 for (vsize i = 0; i < heads.size (); i++)
116 int j = Staff_symbol_referencer::get_rounded_position (se);
117 iv.unite (Slice (j, j));
123 Note_column::dir (Grob *me)
125 Grob *stem = unsmob_grob (me->get_object ("stem"));
126 if (stem && Stem::has_interface (stem))
127 return get_grob_direction (stem);
130 extract_grob_set (me, "note-heads", heads);
132 return (Direction)sign (head_positions_interval (me).center ());
135 programming_error ("note column without heads and stem");
140 Note_column::set_stem (Grob *me, Grob *stem)
142 me->set_object ("stem", stem->self_scm ());
143 Axis_group_interface::add_element (me, stem);
147 Note_column::get_rest (Grob *me)
149 return unsmob_grob (me->get_object ("rest"));
153 Note_column::add_head (Grob *me, Grob *h)
156 if (Rest::has_interface (h))
158 extract_grob_set (me, "note-heads", heads);
162 me->set_object ("rest", h->self_scm ());
164 else if (Note_head::has_interface (h))
166 if (unsmob_grob (me->get_object ("rest")))
168 Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-heads"), h);
172 me->warning (_ ("cannot have note heads and rests together on a stem"));
174 Axis_group_interface::add_element (me, h);
178 Note_column::first_head (Grob *me)
180 Grob *st = get_stem (me);
181 return st ? Stem::first_head (st) : 0;
185 Return the first AccidentalPlacement grob that we find in a note-head.
188 Note_column::accidentals (Grob *me)
190 extract_grob_set (me, "note-heads", heads);
192 for (vsize i = 0; i < heads.size (); i++)
195 acc = h ? unsmob_grob (h->get_object ("accidental-grob")) : 0;
203 if (Accidental_placement::has_interface (acc->get_parent (X_AXIS)))
204 return acc->get_parent (X_AXIS);
211 Note_column::dot_column (Grob *me)
213 extract_grob_set (me, "note-heads", heads);
214 for (vsize i = 0; i < heads.size (); i++)
216 Grob *dots = unsmob_grob (heads[i]->get_object ("dot"));
218 return dots->get_parent (X_AXIS);
224 /* If a note-column contains a cross-staff stem then
225 nc->extent (Y_AXIS, refp) will not consider the extent of the stem.
226 If you want the extent of the stem to be included (and you are safe
227 from any cross-staff issues) then call this function instead. */
229 Note_column::cross_staff_extent (Grob *me, Grob *refp)
231 Interval iv = me->extent (refp, Y_AXIS);
232 if (Grob *s = get_stem (me))
233 iv.unite (s->extent (refp, Y_AXIS));
238 ADD_INTERFACE (Note_column,
239 "Stem and noteheads combined.",