lily/fingering-column-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2012 Mike Solomon <mike@mikesolomon.org>
   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 "engraver.hh"
  21 #include "side-position-interface.hh"
  22 #include "pointer-group-interface.hh"
  23 #include "fingering-column.hh"
  24 #include "item.hh"
  25
  26 #include "translator.icc"
  27
  28 /**
  29    Find potentially colliding scripts, and put them in a
  30    Fingering_column, that will fix the columns.  */
  31 class Fingering_column_engraver : public Engraver
  32 {
  33   Drul_array<Grob *> fingering_columns_;
  34   Drul_array<vector<Grob *> > scripts_;
  35   vector<Grob *> possibles_;
  36
  37 public:
  38   TRANSLATOR_DECLARATIONS (Fingering_column_engraver);
  39 protected:
  40   void acknowledge_finger (Grob_info);
  41   void process_acknowledged ();
  42   void stop_translation_timestep ();
  43 };
  44
  45 Fingering_column_engraver::Fingering_column_engraver (Context *c)
  46   : Engraver (c)
  47 {
  48   for (LEFT_and_RIGHT (d))
  49     fingering_columns_[d] = 0;
  50 }
  51
  52 void
  53 Fingering_column_engraver::stop_translation_timestep ()
  54 {
  55   for (vsize i = 0; i < possibles_.size (); i++)
  56     if (!Item::is_non_musical (possibles_[i]))
  57       {
  58         if (Side_position_interface::get_axis (possibles_[i]) == X_AXIS)
  59           {
  60             Direction d = robust_scm2dir (possibles_[i]->get_property ("direction"), CENTER);
  61             if (d)
  62               scripts_[d].push_back (possibles_[i]);
  63             else
  64               possibles_[i]->warning ("Cannot add a fingering without a direction.");
  65           }
  66       }
  67
  68   for (LEFT_and_RIGHT (d))
  69     {
  70       if (scripts_[d].size () < 2 && fingering_columns_[d])
  71         {
  72           fingering_columns_[d]->suicide ();
  73           fingering_columns_[d] = 0;
  74         }
  75       if (fingering_columns_[d])
  76         {
  77           for (vsize i = 0; i < scripts_[d].size (); i++)
  78             Fingering_column::add_fingering (fingering_columns_[d], scripts_[d][i]);
  79
  80         }
  81       scripts_[d].clear ();
  82       fingering_columns_[d] = 0;
  83     }
  84   possibles_.clear ();
  85 }
  86
  87 void
  88 Fingering_column_engraver::acknowledge_finger (Grob_info inf)
  89 {
  90   Item *thing = dynamic_cast<Item *> (inf.grob ());
  91   if (thing)
  92     possibles_.push_back (thing);
  93 }
  94
  95 void
  96 Fingering_column_engraver::process_acknowledged ()
  97 {
  98   for (LEFT_and_RIGHT (d))
  99     {
 100       if (possibles_.size () > 1 && !fingering_columns_[d])
 101         fingering_columns_[d] = make_item ("FingeringColumn", SCM_EOL);
 102     }
 103 }
 104
 105 void
 106 Fingering_column_engraver::boot ()
 107 {
 108   ADD_ACKNOWLEDGER (Fingering_column_engraver, finger);
 109 }
 110
 111 ADD_TRANSLATOR (Fingering_column_engraver,
 112                 /* doc */
 113                 "Find potentially colliding scripts and put them into a"
 114                 " @code{FingeringColumn} object; that will fix the collisions.",
 115
 116                 /* create */
 117                 "FingeringColumn ",
 118
 119                 /* read */
 120                 "",
 121
 122                 /* write */
 123                 ""
 124                );