lily/beam-collision-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2011 Mike Solomon <mike@apollinemike.com>
   5
   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.
  10
  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.
  15
  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/>.
  18 */
  19
  20 #include "beam.hh"
  21 #include "engraver.hh"
  22 #include "item.hh"
  23 #include "note-head.hh"
  24 #include "pointer-group-interface.hh"
  25 #include "stem.hh"
  26
  27 class Beam_collision_engraver : public Engraver
  28 {
  29 protected:
  30   vector<Grob_info> beams_;
  31   vector<Grob_info> covered_grobs_;
  32
  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
  41   virtual void finalize ();
  42
  43 private:
  44   bool covered_grob_has_interface (Grob *covered_grob, Grob *beam);
  45
  46 public:
  47   TRANSLATOR_DECLARATIONS (Beam_collision_engraver);
  48 };
  49
  50 Beam_collision_engraver::Beam_collision_engraver () {}
  51
  52 bool
  53 Beam_collision_engraver::covered_grob_has_interface (Grob *covered_grob, Grob *beam)
  54 {
  55   SCM interfaces = beam->get_property ("collision-interfaces");
  56
  57   for (SCM l = interfaces; scm_is_pair (l); l = scm_cdr (l))
  58     {
  59       if (covered_grob->internal_has_interface (scm_car (l)))
  60         return true;
  61     }
  62
  63   return false;
  64 }
  65
  66 void
  67 Beam_collision_engraver::finalize ()
  68 {
  69   if (!covered_grobs_.size ())
  70     return;
  71
  72   vector_sort (covered_grobs_, Grob_info::less);
  73   vector_sort (beams_, Grob_info::less);
  74   vsize start = 0;
  75
  76   for (vsize i = 0; i < beams_.size (); i++)
  77     {
  78       Grob *beam_grob = beams_[i].grob ();
  79       if (Beam::is_cross_staff (beam_grob))
  80         continue;
  81
  82       Context *beam_context = beams_[i].context ();
  83
  84       Interval_t<int> beam_spanned_rank_ = beam_grob->spanned_rank_interval ();
  85       // Start considering grobs at the first grob whose end falls at or after the beam's beginning.
  86       while (covered_grobs_[start].grob ()->spanned_rank_interval ()[RIGHT] < beam_spanned_rank_[LEFT])
  87         start++;
  88
  89       // Stop when the grob's beginning comes after the beam's end.
  90       for (vsize j = start; j < covered_grobs_.size (); j++)
  91         {
  92           Grob *covered_grob = covered_grobs_[j].grob ();
  93           Context *covered_grob_context = covered_grobs_[j].context ();
  94
  95           Interval_t<int> covered_grob_spanned_rank = covered_grob->spanned_rank_interval ();
  96           if (covered_grob_spanned_rank[LEFT] > beam_spanned_rank_[RIGHT])
  97             break;
  98           /*
  99              Only consider grobs whose end falls at or after the beam's beginning.
 100              If the grob is a beam, it cannot start before beams_[i].
 101              Also, if the user wants to check for collisions only in the beam's voice,
 102              then make sure the beam and the covered_grob are in the same voice.
 103           */
 104           if ((covered_grob_spanned_rank[RIGHT] >= beam_spanned_rank_[LEFT])
 105               && !(to_boolean (beam_grob->get_property ("collision-voice-only"))
 106                    && (covered_grob_context != beam_context))
 107               && !(Beam::has_interface (covered_grob)
 108                    && (covered_grob_spanned_rank[LEFT] <= beam_spanned_rank_[LEFT]))
 109               && covered_grob_has_interface (covered_grob, beam_grob))
 110             {
 111               // Do not consider note heads attached to the beam.
 112               if (Stem::has_interface (covered_grob))
 113                 if (unsmob_grob (covered_grob->get_object ("beam")))
 114                   continue;
 115
 116               if (Grob *stem = unsmob_grob (covered_grob->get_object ("stem")))
 117                 if (Grob *beam = unsmob_grob (stem->get_object ("beam")))
 118                   if (beam == beam_grob)
 119                     continue;
 120
 121               Pointer_group_interface::add_grob (beam_grob, ly_symbol2scm ("covered-grobs"), covered_grob);
 122             }
 123         }
 124     }
 125 }
 126
 127 void
 128 Beam_collision_engraver::acknowledge_note_head (Grob_info i)
 129 {
 130   covered_grobs_.push_back (i);
 131 }
 132
 133 void
 134 Beam_collision_engraver::acknowledge_stem (Grob_info i)
 135 {
 136   covered_grobs_.push_back (i);
 137 }
 138
 139 void
 140 Beam_collision_engraver::acknowledge_accidental (Grob_info i)
 141 {
 142   if (i.grob ()->internal_has_interface (ly_symbol2scm ("inline-accidental-interface")))
 143     covered_grobs_.push_back (i);
 144 }
 145
 146 void
 147 Beam_collision_engraver::acknowledge_clef (Grob_info i)
 148 {
 149   covered_grobs_.push_back (i);
 150 }
 151
 152 void
 153 Beam_collision_engraver::acknowledge_key_signature (Grob_info i)
 154 {
 155   covered_grobs_.push_back (i);
 156 }
 157
 158 void
 159 Beam_collision_engraver::acknowledge_time_signature (Grob_info i)
 160 {
 161   covered_grobs_.push_back (i);
 162 }
 163
 164 void
 165 Beam_collision_engraver::acknowledge_beam (Grob_info i)
 166 {
 167   beams_.push_back (i);
 168   covered_grobs_.push_back (i);
 169 }
 170
 171 #include "translator.icc"
 172
 173 ADD_ACKNOWLEDGER (Beam_collision_engraver, note_head);
 174 ADD_ACKNOWLEDGER (Beam_collision_engraver, stem);
 175 ADD_ACKNOWLEDGER (Beam_collision_engraver, accidental);
 176 ADD_ACKNOWLEDGER (Beam_collision_engraver, clef);
 177 ADD_ACKNOWLEDGER (Beam_collision_engraver, key_signature);
 178 ADD_ACKNOWLEDGER (Beam_collision_engraver, time_signature);
 179 ADD_ACKNOWLEDGER (Beam_collision_engraver, beam);
 180
 181 ADD_TRANSLATOR (Beam_collision_engraver,
 182                 /* doc */
 183                 "Help beams avoid colliding with notes and clefs in other voices.",
 184
 185                 /* create */
 186                 "",
 187
 188                 /* read */
 189                 "",
 190
 191                 /* write */
 192                 ""
 193                 );