lily/axis-group-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1999--2011 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 "axis-group-engraver.hh"
  21
  22 #include "axis-group-interface.hh"
  23 #include "pointer-group-interface.hh"
  24 #include "context.hh"
  25 #include "international.hh"
  26 #include "spanner.hh"
  27 #include "warn.hh"
  28
  29 #include "translator.icc"
  30
  31 Axis_group_engraver::Axis_group_engraver ()
  32 {
  33   staffline_ = 0;
  34 }
  35
  36 bool
  37 Axis_group_engraver::must_be_last () const
  38 {
  39   return true;
  40 }
  41
  42 void
  43 Axis_group_engraver::process_music ()
  44 {
  45   if (!staffline_)
  46     {
  47       staffline_ = get_spanner ();
  48       Grob *it = unsmob_grob (get_property ("currentCommandColumn"));
  49       staffline_->set_bound (LEFT, it);
  50     }
  51 }
  52
  53 Spanner *
  54 Axis_group_engraver::get_spanner ()
  55 {
  56   return make_spanner ("VerticalAxisGroup", SCM_EOL);
  57 }
  58
  59 void
  60 Axis_group_engraver::finalize ()
  61 {
  62   if (staffline_)
  63     {
  64       Grob *it = unsmob_grob (get_property ("currentCommandColumn"));
  65       staffline_->set_bound (RIGHT, it);
  66
  67       Pointer_group_interface::set_ordered (staffline_, ly_symbol2scm ("elements"), false);
  68     }
  69 }
  70
  71 void
  72 Axis_group_engraver::acknowledge_grob (Grob_info i)
  73 {
  74   elts_.push_back (i.grob ());
  75 }
  76
  77 /*
  78   maybe should check if our parent is set, because we now get a
  79   cyclic parent relationship if we have two Axis_group_engravers in
  80   the context.  */
  81 void
  82 Axis_group_engraver::process_acknowledged ()
  83 {
  84   if (!staffline_)
  85     return;
  86
  87   for (vsize i = 0; i < elts_.size (); i++)
  88     {
  89       if (!unsmob_grob (elts_[i]->get_object ("axis-group-parent-Y")))
  90         {
  91           if (staffline_->get_parent (Y_AXIS)
  92               && staffline_->get_parent (Y_AXIS) == elts_[i])
  93             {
  94               staffline_->warning (_ ("Axis_group_engraver: vertical group already has a parent"));
  95               staffline_->warning (_ ("are there two Axis_group_engravers?"));
  96               staffline_->warning (_ ("removing this vertical group"));
  97               staffline_->suicide ();
  98               staffline_ = 0;
  99               break;
 100             }
 101           add_element (elts_[i]);
 102         }
 103     }
 104   elts_.clear ();
 105 }
 106
 107 void
 108 Axis_group_engraver::add_element (Grob *e)
 109 {
 110   Axis_group_interface::add_element (staffline_, e);
 111 }
 112
 113 ADD_ACKNOWLEDGER (Axis_group_engraver, grob);
 114
 115 ADD_TRANSLATOR (Axis_group_engraver,
 116                 /* doc */
 117                 "Group all objects created in this context in a"
 118                 " @code{VerticalAxisGroup} spanner.",
 119
 120                 /* create */
 121                 "VerticalAxisGroup ",
 122
 123                 /* read */
 124                 "currentCommandColumn ",
 125
 126                 /* write */
 127                 ""
 128                 );