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