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 *> active_beams_;
  30   vector<Grob *> signaled_beams_;
  31   vector<Grob *> end_beams_;
  32   vector<Grob *> covered_grobs_;
  33   vector<Grob *> covered_interior_grobs_;
  34
  35   DECLARE_ACKNOWLEDGER (note_head);
  36   DECLARE_ACKNOWLEDGER (accidental);
  37   DECLARE_ACKNOWLEDGER (clef);
  38   DECLARE_ACKNOWLEDGER (key_signature);
  39   DECLARE_ACKNOWLEDGER (time_signature);
  40   DECLARE_ACKNOWLEDGER (bar_line);
  41   DECLARE_ACKNOWLEDGER (beam);
  42   DECLARE_END_ACKNOWLEDGER (beam);
  43   void stop_translation_timestep ();
  44 public:
  45   TRANSLATOR_DECLARATIONS (Beam_collision_engraver);
  46 };
  47
  48 void
  49 Beam_collision_engraver::stop_translation_timestep ()
  50 {
  51   for (vsize i = 0; i < covered_interior_grobs_.size (); i++)
  52     for (vsize j = 0; j < active_beams_.size (); j++)
  53       Pointer_group_interface::add_grob (active_beams_[j], ly_symbol2scm ("covered-grobs"), covered_interior_grobs_[i]);
  54
  55   covered_interior_grobs_.clear ();
  56
  57   for (vsize i = 0; i < active_beams_.size (); i++)
  58     for (vsize j = 0; j < signaled_beams_.size (); j++)
  59       if (active_beams_[i] == signaled_beams_[j])
  60         {
  61           signaled_beams_.erase (signaled_beams_.begin () + j);
  62           break;
  63         }
  64
  65   /*
  66     hack.
  67     in auto beaming, end beams are signaled with their beams at a later timestep.
  68     we need to scrub these.
  69   */
  70   for (vsize i = 0; i < end_beams_.size (); i++)
  71     for (vsize j = 0; j < signaled_beams_.size (); j++)
  72       if (end_beams_[i] == signaled_beams_[j])
  73         {
  74           signaled_beams_.erase (signaled_beams_.begin () + j);
  75           break;
  76         }
  77
  78   for (vsize i = 0; i < signaled_beams_.size (); i++)
  79     active_beams_.push_back (signaled_beams_[i]);
  80
  81   signaled_beams_.clear ();
  82
  83   for (vsize i = 0; i < covered_grobs_.size (); i++)
  84     for (vsize j = 0; j < active_beams_.size (); j++)
  85       {
  86         Grob *g = covered_grobs_[i];
  87         if (Grob *stem = unsmob_grob (g->get_object ("stem")))
  88           if (Grob *beam = unsmob_grob (stem->get_object ("beam")))
  89             if (beam == active_beams_[j])
  90               continue;
  91
  92         Pointer_group_interface::add_grob (active_beams_[j], ly_symbol2scm ("covered-grobs"), g);
  93       }
  94
  95   covered_grobs_.clear ();
  96
  97   for (vsize i = 0; i < end_beams_.size (); i++)
  98     for (vsize j = 0; j < active_beams_.size (); j++)
  99       if (end_beams_[i] == active_beams_[j])
 100         {
 101           active_beams_.erase (active_beams_.begin () + j);
 102           break;
 103         }
 104
 105   end_beams_.clear ();
 106 }
 107
 108 Beam_collision_engraver::Beam_collision_engraver () {}
 109
 110 void
 111 Beam_collision_engraver::acknowledge_note_head (Grob_info i)
 112 {
 113   covered_grobs_.push_back (i.grob ());
 114 }
 115
 116 void
 117 Beam_collision_engraver::acknowledge_accidental (Grob_info i)
 118 {
 119   covered_grobs_.push_back (i.grob ());
 120 }
 121
 122 void
 123 Beam_collision_engraver::acknowledge_bar_line (Grob_info i)
 124 {
 125   covered_interior_grobs_.push_back (i.grob ());
 126 }
 127
 128 void
 129 Beam_collision_engraver::acknowledge_clef (Grob_info i)
 130 {
 131   covered_interior_grobs_.push_back (i.grob ());
 132 }
 133
 134 void
 135 Beam_collision_engraver::acknowledge_key_signature (Grob_info i)
 136 {
 137   covered_interior_grobs_.push_back (i.grob ());
 138 }
 139
 140 void
 141 Beam_collision_engraver::acknowledge_time_signature (Grob_info i)
 142 {
 143   covered_interior_grobs_.push_back (i.grob ());
 144 }
 145
 146 void
 147 Beam_collision_engraver::acknowledge_beam (Grob_info i)
 148 {
 149   signaled_beams_.push_back (i.grob ());
 150 }
 151
 152 void
 153 Beam_collision_engraver::acknowledge_end_beam (Grob_info i)
 154 {
 155   end_beams_.push_back (i.grob ());
 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 ADD_ACKNOWLEDGER (Beam_collision_engraver, bar_line);
 167 ADD_END_ACKNOWLEDGER (Beam_collision_engraver, beam);
 168
 169 ADD_TRANSLATOR (Beam_collision_engraver,
 170                 /* doc */
 171                 "Help beams avoid colliding with notes and clefs in other voices.",
 172
 173                 /* create */
 174                 "",
 175
 176                 /* read */
 177                 "",
 178
 179                 /* write */
 180                 ""
 181                 );