2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2011--2015 Mike Solomon <mike@mikesolomon.org>
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 void acknowledge_note_head (Grob_info);
34 void acknowledge_stem (Grob_info);
35 void acknowledge_accidental (Grob_info);
36 void acknowledge_clef (Grob_info);
37 void acknowledge_clef_modifier (Grob_info);
38 void acknowledge_key_signature (Grob_info);
39 void acknowledge_time_signature (Grob_info);
40 void acknowledge_beam (Grob_info);
41 void acknowledge_flag (Grob_info);
43 virtual void finalize ();
46 bool covered_grob_has_interface (Grob *covered_grob, Grob *beam);
49 TRANSLATOR_DECLARATIONS (Beam_collision_engraver);
52 Beam_collision_engraver::Beam_collision_engraver (Context *c)
57 Beam_collision_engraver::covered_grob_has_interface (Grob *covered_grob, Grob *beam)
59 SCM interfaces = beam->get_property ("collision-interfaces");
61 for (SCM l = interfaces; scm_is_pair (l); l = scm_cdr (l))
63 if (covered_grob->internal_has_interface (scm_car (l)))
71 Beam_collision_engraver::finalize ()
73 if (!covered_grobs_.size ())
76 vector_sort (covered_grobs_, Grob_info::less);
77 vector_sort (beams_, Grob_info::less);
80 for (vsize i = 0; i < beams_.size (); i++)
82 Grob *beam_grob = beams_[i].grob ();
84 extract_grob_set (beam_grob, "normal-stems", stems);
85 Interval_t<int> vertical_span;
86 for (vsize j = 0; j < stems.size (); j++)
88 int vag = Grob::get_vertical_axis_group_index (stems[j]);
90 vertical_span.add_point (vag);
92 Context *beam_context = beams_[i].context ();
94 Interval_t<int> beam_spanned_rank_ = beam_grob->spanned_rank_interval ();
95 // Start considering grobs at the first grob whose end falls at or after the beam's beginning.
96 while (covered_grobs_[start].grob ()->spanned_rank_interval ()[RIGHT] < beam_spanned_rank_[LEFT])
99 // Stop when the grob's beginning comes after the beam's end.
100 for (vsize j = start; j < covered_grobs_.size (); j++)
102 Grob *covered_grob = covered_grobs_[j].grob ();
103 int vag = Grob::get_vertical_axis_group_index (covered_grob);
104 if (!vertical_span.contains (vag))
106 Context *covered_grob_context = covered_grobs_[j].context ();
108 Interval_t<int> covered_grob_spanned_rank = covered_grob->spanned_rank_interval ();
109 if (covered_grob_spanned_rank[LEFT] > beam_spanned_rank_[RIGHT])
112 Only consider grobs whose end falls at or after the beam's beginning.
113 If the grob is a beam, it cannot start before beams_[i].
114 Also, if the user wants to check for collisions only in the beam's voice,
115 then make sure the beam and the covered_grob are in the same voice.
117 if ((covered_grob_spanned_rank[RIGHT] >= beam_spanned_rank_[LEFT])
118 && !(to_boolean (beam_grob->get_property ("collision-voice-only"))
119 && (covered_grob_context != beam_context))
120 && !(has_interface<Beam> (covered_grob)
121 && (covered_grob_spanned_rank[LEFT] <= beam_spanned_rank_[LEFT]))
122 && covered_grob_has_interface (covered_grob, beam_grob))
124 // Do not consider note heads attached to the beam.
125 if (has_interface<Stem> (covered_grob))
126 if (unsmob<Grob> (covered_grob->get_object ("beam")))
129 if (Grob *stem = unsmob<Grob> (covered_grob->get_object ("stem")))
130 if (Grob *beam = unsmob<Grob> (stem->get_object ("beam")))
131 if (beam == beam_grob)
134 Pointer_group_interface::add_grob (beam_grob, ly_symbol2scm ("covered-grobs"), covered_grob);
141 Beam_collision_engraver::acknowledge_note_head (Grob_info i)
143 covered_grobs_.push_back (i);
147 Beam_collision_engraver::acknowledge_stem (Grob_info i)
149 covered_grobs_.push_back (i);
153 Beam_collision_engraver::acknowledge_accidental (Grob_info i)
155 if (i.grob ()->internal_has_interface (ly_symbol2scm ("inline-accidental-interface")))
156 covered_grobs_.push_back (i);
160 Beam_collision_engraver::acknowledge_clef (Grob_info i)
162 covered_grobs_.push_back (i);
166 Beam_collision_engraver::acknowledge_key_signature (Grob_info i)
168 covered_grobs_.push_back (i);
172 Beam_collision_engraver::acknowledge_clef_modifier (Grob_info i)
174 covered_grobs_.push_back (i);
178 Beam_collision_engraver::acknowledge_time_signature (Grob_info i)
180 covered_grobs_.push_back (i);
184 Beam_collision_engraver::acknowledge_flag (Grob_info i)
186 covered_grobs_.push_back (i);
190 Beam_collision_engraver::acknowledge_beam (Grob_info i)
192 beams_.push_back (i);
193 covered_grobs_.push_back (i);
196 #include "translator.icc"
200 Beam_collision_engraver::boot ()
202 ADD_ACKNOWLEDGER (Beam_collision_engraver, note_head);
203 ADD_ACKNOWLEDGER (Beam_collision_engraver, stem);
204 ADD_ACKNOWLEDGER (Beam_collision_engraver, accidental);
205 ADD_ACKNOWLEDGER (Beam_collision_engraver, clef);
206 ADD_ACKNOWLEDGER (Beam_collision_engraver, key_signature);
207 ADD_ACKNOWLEDGER (Beam_collision_engraver, time_signature);
208 ADD_ACKNOWLEDGER (Beam_collision_engraver, clef_modifier);
209 ADD_ACKNOWLEDGER (Beam_collision_engraver, flag);
210 ADD_ACKNOWLEDGER (Beam_collision_engraver, beam);
213 ADD_TRANSLATOR (Beam_collision_engraver,
215 "Help beams avoid colliding with notes and clefs in other voices.",