2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2011--2012 Mike Solomon <mike@apollinemike.com>
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/>.
21 #include "engraver.hh"
23 #include "note-head.hh"
24 #include "pointer-group-interface.hh"
27 class Beam_collision_engraver : public Engraver
30 vector<Grob_info> beams_;
31 vector<Grob_info> covered_grobs_;
33 DECLARE_ACKNOWLEDGER (note_head);
34 DECLARE_ACKNOWLEDGER (stem);
35 DECLARE_ACKNOWLEDGER (accidental);
36 DECLARE_ACKNOWLEDGER (clef);
37 DECLARE_ACKNOWLEDGER (key_signature);
38 DECLARE_ACKNOWLEDGER (time_signature);
39 DECLARE_ACKNOWLEDGER (beam);
40 DECLARE_ACKNOWLEDGER (flag);
42 virtual void finalize ();
45 bool covered_grob_has_interface (Grob *covered_grob, Grob *beam);
48 TRANSLATOR_DECLARATIONS (Beam_collision_engraver);
51 Beam_collision_engraver::Beam_collision_engraver () {}
54 Beam_collision_engraver::covered_grob_has_interface (Grob *covered_grob, Grob *beam)
56 SCM interfaces = beam->get_property ("collision-interfaces");
58 for (SCM l = interfaces; scm_is_pair (l); l = scm_cdr (l))
60 if (covered_grob->internal_has_interface (scm_car (l)))
68 Beam_collision_engraver::finalize ()
70 if (!covered_grobs_.size ())
73 vector_sort (covered_grobs_, Grob_info::less);
74 vector_sort (beams_, Grob_info::less);
77 for (vsize i = 0; i < beams_.size (); i++)
79 Grob *beam_grob = beams_[i].grob ();
81 extract_grob_set (beam_grob, "normal-stems", stems);
82 Interval_t<int> vertical_span;
83 for (vsize j = 0; j < stems.size (); j++)
85 int vag = Grob::get_vertical_axis_group_index (stems[j]);
87 vertical_span.add_point (vag);
89 Context *beam_context = beams_[i].context ();
91 Interval_t<int> beam_spanned_rank_ = beam_grob->spanned_rank_interval ();
92 // Start considering grobs at the first grob whose end falls at or after the beam's beginning.
93 while (covered_grobs_[start].grob ()->spanned_rank_interval ()[RIGHT] < beam_spanned_rank_[LEFT])
96 // Stop when the grob's beginning comes after the beam's end.
97 for (vsize j = start; j < covered_grobs_.size (); j++)
99 Grob *covered_grob = covered_grobs_[j].grob ();
100 int vag = Grob::get_vertical_axis_group_index (covered_grob);
101 if (!vertical_span.contains (vag))
103 Context *covered_grob_context = covered_grobs_[j].context ();
105 Interval_t<int> covered_grob_spanned_rank = covered_grob->spanned_rank_interval ();
106 if (covered_grob_spanned_rank[LEFT] > beam_spanned_rank_[RIGHT])
109 Only consider grobs whose end falls at or after the beam's beginning.
110 If the grob is a beam, it cannot start before beams_[i].
111 Also, if the user wants to check for collisions only in the beam's voice,
112 then make sure the beam and the covered_grob are in the same voice.
114 if ((covered_grob_spanned_rank[RIGHT] >= beam_spanned_rank_[LEFT])
115 && !(to_boolean (beam_grob->get_property ("collision-voice-only"))
116 && (covered_grob_context != beam_context))
117 && !(Beam::has_interface (covered_grob)
118 && (covered_grob_spanned_rank[LEFT] <= beam_spanned_rank_[LEFT]))
119 && covered_grob_has_interface (covered_grob, beam_grob))
121 // Do not consider note heads attached to the beam.
122 if (Stem::has_interface (covered_grob))
123 if (unsmob_grob (covered_grob->get_object ("beam")))
126 if (Grob *stem = unsmob_grob (covered_grob->get_object ("stem")))
127 if (Grob *beam = unsmob_grob (stem->get_object ("beam")))
128 if (beam == beam_grob)
131 Pointer_group_interface::add_grob (beam_grob, ly_symbol2scm ("covered-grobs"), covered_grob);
138 Beam_collision_engraver::acknowledge_note_head (Grob_info i)
140 covered_grobs_.push_back (i);
144 Beam_collision_engraver::acknowledge_stem (Grob_info i)
146 covered_grobs_.push_back (i);
150 Beam_collision_engraver::acknowledge_accidental (Grob_info i)
152 if (i.grob ()->internal_has_interface (ly_symbol2scm ("inline-accidental-interface")))
153 covered_grobs_.push_back (i);
157 Beam_collision_engraver::acknowledge_clef (Grob_info i)
159 covered_grobs_.push_back (i);
163 Beam_collision_engraver::acknowledge_key_signature (Grob_info i)
165 covered_grobs_.push_back (i);
169 Beam_collision_engraver::acknowledge_time_signature (Grob_info i)
171 covered_grobs_.push_back (i);
175 Beam_collision_engraver::acknowledge_flag (Grob_info i)
177 covered_grobs_.push_back (i);
181 Beam_collision_engraver::acknowledge_beam (Grob_info i)
183 beams_.push_back (i);
184 covered_grobs_.push_back (i);
187 #include "translator.icc"
189 ADD_ACKNOWLEDGER (Beam_collision_engraver, note_head);
190 ADD_ACKNOWLEDGER (Beam_collision_engraver, stem);
191 ADD_ACKNOWLEDGER (Beam_collision_engraver, accidental);
192 ADD_ACKNOWLEDGER (Beam_collision_engraver, clef);
193 ADD_ACKNOWLEDGER (Beam_collision_engraver, key_signature);
194 ADD_ACKNOWLEDGER (Beam_collision_engraver, time_signature);
195 ADD_ACKNOWLEDGER (Beam_collision_engraver, flag);
196 ADD_ACKNOWLEDGER (Beam_collision_engraver, beam);
198 ADD_TRANSLATOR (Beam_collision_engraver,
200 "Help beams avoid colliding with notes and clefs in other voices.",