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 *> beams_;
  30   vector<Grob *> 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 public:
  42   TRANSLATOR_DECLARATIONS (Beam_collision_engraver);
  43 };
  44
  45 Beam_collision_engraver::Beam_collision_engraver () {}
  46
  47 void
  48 Beam_collision_engraver::finalize ()
  49 {
  50   if (!covered_grobs_.size ())
  51     return;
  52
  53   vector_sort (covered_grobs_, Grob::less);
  54   vector_sort (beams_, Grob::less);
  55   vsize start = 0;
  56
  57   for (vsize i = 0; i < beams_.size (); i++)
  58     {
  59       Interval_t<int> beam_spanned_rank_ = beams_[i]->spanned_rank_interval ();
  60       // Start considering grobs at the first grob whose end falls at or after the beam's beginning.
  61       while (covered_grobs_[start]->spanned_rank_interval ()[RIGHT] < beam_spanned_rank_[LEFT])
  62         start++;
  63
  64       // Stop when the grob's beginning comes after the beam's end.
  65       for (vsize j = start; j < covered_grobs_.size (); j++)
  66         {
  67           Interval_t<int> covered_grob_spanned_rank = covered_grobs_[j]->spanned_rank_interval ();
  68           if (covered_grob_spanned_rank[LEFT] > beam_spanned_rank_[RIGHT])
  69             break;
  70           /*
  71              Only consider grobs whose end falls at or after the beam's beginning.
  72              If the grob is a beam, it cannot start before beams_[i]
  73           */
  74           if ((covered_grob_spanned_rank[RIGHT] >= beam_spanned_rank_[LEFT])
  75               && !(Beam::has_interface (covered_grobs_[j])
  76                    && (covered_grob_spanned_rank[LEFT] <= beam_spanned_rank_[LEFT])))
  77             {
  78               // Do not consider note heads attached to the beam.
  79               bool my_beam = false;
  80               if (Grob *stem = unsmob_grob (covered_grobs_[j]->get_object ("stem")))
  81                 if (Grob *beam = unsmob_grob (stem->get_object ("beam")))
  82                   if (beam == beams_[i])
  83                     my_beam = true;
  84
  85               if (!my_beam)
  86                 Pointer_group_interface::add_grob (beams_[i], ly_symbol2scm ("covered-grobs"), covered_grobs_[j]);
  87             }
  88         }
  89     }
  90 }
  91
  92 void
  93 Beam_collision_engraver::acknowledge_note_head (Grob_info i)
  94 {
  95   covered_grobs_.push_back (i.grob ());
  96 }
  97
  98 void
  99 Beam_collision_engraver::acknowledge_accidental (Grob_info i)
 100 {
 101   if (i.grob ()->internal_has_interface (ly_symbol2scm ("inline-accidental-interface")))
 102     covered_grobs_.push_back (i.grob ());
 103 }
 104
 105 void
 106 Beam_collision_engraver::acknowledge_clef (Grob_info i)
 107 {
 108   covered_grobs_.push_back (i.grob ());
 109 }
 110
 111 void
 112 Beam_collision_engraver::acknowledge_key_signature (Grob_info i)
 113 {
 114   covered_grobs_.push_back (i.grob ());
 115 }
 116
 117 void
 118 Beam_collision_engraver::acknowledge_time_signature (Grob_info i)
 119 {
 120   covered_grobs_.push_back (i.grob ());
 121 }
 122
 123 void
 124 Beam_collision_engraver::acknowledge_beam (Grob_info i)
 125 {
 126   beams_.push_back (i.grob ());
 127   covered_grobs_.push_back (i.grob ());
 128 }
 129
 130 #include "translator.icc"
 131
 132 ADD_ACKNOWLEDGER (Beam_collision_engraver, note_head);
 133 ADD_ACKNOWLEDGER (Beam_collision_engraver, accidental);
 134 ADD_ACKNOWLEDGER (Beam_collision_engraver, clef);
 135 ADD_ACKNOWLEDGER (Beam_collision_engraver, key_signature);
 136 ADD_ACKNOWLEDGER (Beam_collision_engraver, time_signature);
 137 ADD_ACKNOWLEDGER (Beam_collision_engraver, beam);
 138
 139 ADD_TRANSLATOR (Beam_collision_engraver,
 140                 /* doc */
 141                 "Help beams avoid colliding with notes and clefs in other voices.",
 142
 143                 /* create */
 144                 "",
 145
 146                 /* read */
 147                 "",
 148
 149                 /* write */
 150                 ""
 151                 );