lily/script-column-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1999--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   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 "script-column.hh"
  22 #include "side-position-interface.hh"
  23 #include "item.hh"
  24
  25 #include "translator.icc"
  26
  27 /**
  28    Find potentially colliding scripts, and put them in a
  29    Script_column, that will fix the collisions.  */
  30 class Script_column_engraver : public Engraver
  31 {
  32   Grob *script_column_;
  33   vector<Grob *> scripts_;
  34
  35 public:
  36   TRANSLATOR_DECLARATIONS (Script_column_engraver);
  37 protected:
  38   void acknowledge_side_position (Grob_info);
  39   void process_acknowledged ();
  40   void stop_translation_timestep ();
  41 };
  42
  43 Script_column_engraver::Script_column_engraver (Context *c)
  44   : Engraver (c)
  45 {
  46   script_column_ = 0;
  47 }
  48
  49 void
  50 Script_column_engraver::stop_translation_timestep ()
  51 {
  52   if (script_column_)
  53     {
  54       for (vsize i = 0; i < scripts_.size (); i++)
  55         if (Side_position_interface::get_axis (scripts_[i]) == Y_AXIS)
  56           Script_column::add_side_positioned (script_column_, scripts_[i]);
  57     }
  58
  59   script_column_ = 0;
  60   scripts_.clear ();
  61 }
  62
  63 void
  64 Script_column_engraver::acknowledge_side_position (Grob_info inf)
  65 {
  66   Item *thing = dynamic_cast<Item *> (inf.grob ());
  67   if (thing)
  68     {
  69       if (!Item::is_non_musical (thing))
  70         scripts_.push_back (thing);
  71     }
  72 }
  73
  74 void
  75 Script_column_engraver::process_acknowledged ()
  76 {
  77   if (!script_column_ && scripts_.size () > 1)
  78     script_column_ = make_item ("ScriptColumn", SCM_EOL);
  79 }
  80
  81 void
  82 Script_column_engraver::boot ()
  83 {
  84   ADD_ACKNOWLEDGER (Script_column_engraver, side_position);
  85 }
  86
  87 ADD_TRANSLATOR (Script_column_engraver,
  88                 /* doc */
  89                 "Find potentially colliding scripts and put them into a"
  90                 " @code{ScriptColumn} object; that will fix the collisions.",
  91
  92                 /* create */
  93                 "ScriptColumn ",
  94
  95                 /* read */
  96                 "",
  97
  98                 /* write */
  99                 ""
 100                );