lily/axis-group-engraver.cc

   1 /*
   2   axis-group-engraver.cc --  implement Axis_group_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7  */
   8
   9 #include "spanner.hh"
  10 #include "paper-column.hh"
  11 #include "axis-group-interface.hh"
  12 #include "engraver-group-engraver.hh"
  13 #include "warn.hh"
  14 #include "context.hh"
  15
  16 /**
  17    Put stuff in a Spanner with an Axis_group_interface.
  18    Use as last element of a context.
  19  */
  20 class Axis_group_engraver : public Engraver
  21 {
  22 protected:
  23   Spanner *staffline_;
  24   Link_array<Grob> elts_;
  25   virtual void process_music ();
  26   virtual void finalize ();
  27   virtual void acknowledge_grob (Grob_info);
  28   virtual void process_acknowledged_grobs ();
  29   virtual Spanner* get_spanner () ;
  30   virtual void add_element (Grob*) ;
  31 public:
  32   TRANSLATOR_DECLARATIONS (Axis_group_engraver);
  33 };
  34
  35 Axis_group_engraver::Axis_group_engraver ()
  36 {
  37   must_be_last_ = true;
  38   staffline_ = 0;
  39 }
  40
  41 void
  42 Axis_group_engraver::process_music ()
  43 {
  44   if (!staffline_)
  45     {
  46       staffline_ = get_spanner ();
  47       Grob *  it = unsmob_grob (get_property ("currentCommandColumn"));
  48       staffline_->set_bound (LEFT,it);
  49     }
  50 }
  51
  52 Spanner*
  53 Axis_group_engraver::get_spanner ()
  54 {
  55   return make_spanner ("VerticalAxisGroup", SCM_EOL);
  56 }
  57
  58 /*
  59   TODO: should we junk minimumVerticalExtent/extraVerticalExtent ?
  60  */
  61
  62 void
  63 Axis_group_engraver::finalize ()
  64 {
  65   if (!staffline_)
  66     return ;
  67
  68   String type = context ()->context_name ();
  69   SCM dims = get_property ("verticalExtent");
  70
  71   if (is_number_pair (dims))
  72     staffline_->set_extent (dims, Y_AXIS);
  73
  74   dims = get_property ("minimumVerticalExtent");
  75   if (is_number_pair (dims) )
  76     staffline_->set_property ("minimum-Y-extent", dims);
  77
  78   dims = get_property ("extraVerticalExtent");
  79   if (is_number_pair (dims))
  80     staffline_->set_property ("extra-Y-extent", dims);
  81
  82   Grob *  it = unsmob_grob (get_property ("currentCommandColumn"));
  83
  84   staffline_->set_bound (RIGHT,it);
  85
  86   staffline_ = 0;
  87 }
  88
  89 void
  90 Axis_group_engraver::acknowledge_grob (Grob_info i)
  91 {
  92   elts_.push (i.grob_);
  93 }
  94
  95 /*
  96   maybe should check if our parent is set, because we now get a
  97   cyclic parent relationship if we have two Axis_group_engravers in
  98   the context.  */
  99 void
 100 Axis_group_engraver::process_acknowledged_grobs ()
 101 {
 102   if (!staffline_)
 103     return ;
 104
 105   for (int i=0; i < elts_.size (); i++)
 106     {
 107       if  (!unsmob_grob (elts_[i]->get_property ("axis-group-parent-Y")))
 108         {
 109           if (staffline_->get_parent (Y_AXIS)
 110               && staffline_->get_parent (Y_AXIS) == elts_[i])
 111             {
 112               String msg = _("Axis_group_engraver: vertical group already has a parent.\n"
 113                              "Do you have two Axis_group_engravers?\n"
 114                              "Killing this vertical group.");
 115               staffline_->warning (msg);
 116               staffline_->suicide ();
 117               staffline_ = 0;
 118               break ;
 119             }
 120           else if (elts_[i]->is_empty (Y_AXIS))
 121             {
 122               /*
 123                 We have to do _something_, otherwise staff objects will
 124                 end up with System as parent.
 125
 126               */
 127               elts_[i]->set_parent (staffline_, Y_AXIS);
 128             }
 129           else
 130             add_element (elts_[i]);
 131         }
 132     }
 133   elts_.clear ();
 134 }
 135
 136 void
 137 Axis_group_engraver::add_element (Grob*e)
 138 {
 139   Axis_group_interface::add_element (staffline_, e);
 140 }
 141
 142 /****************************************************************/
 143
 144 /*
 145
 146  maybenot such a good idea after all., to put class declarations in
 147  .cc
 148
 149 */
 150
 151 #include "hara-kiri-group-spanner.hh"
 152 #include "rhythmic-head.hh"
 153
 154 class Hara_kiri_engraver : public Axis_group_engraver
 155 {
 156 protected:
 157   virtual Spanner*get_spanner ();
 158   virtual void acknowledge_grob (Grob_info);
 159   virtual void add_element (Grob *e);
 160 public:
 161   TRANSLATOR_DECLARATIONS (Hara_kiri_engraver);
 162 };
 163
 164 void
 165 Hara_kiri_engraver::add_element (Grob*e)
 166 {
 167   Hara_kiri_group_spanner::add_element (staffline_, e);
 168 }
 169
 170
 171 Spanner*
 172 Hara_kiri_engraver::get_spanner ()
 173 {
 174   Spanner * sp = make_spanner ("RemoveEmptyVerticalGroup", SCM_EOL);
 175
 176   return sp;
 177 }
 178
 179 void
 180 Hara_kiri_engraver::acknowledge_grob (Grob_info i)
 181 {
 182   Axis_group_engraver::acknowledge_grob (i);
 183   if (staffline_
 184       && (i.grob_->internal_has_interface (ly_symbol2scm ("rhythmic-grob-interface"))
 185           || i.grob_->internal_has_interface (ly_symbol2scm ("lyric-interface")))
 186       )
 187     {
 188       Hara_kiri_group_spanner::add_interesting_item (staffline_, i.grob_);
 189     }
 190 }
 191
 192
 193 Hara_kiri_engraver::Hara_kiri_engraver ()
 194 {
 195 }
 196
 197 ENTER_DESCRIPTION (Hara_kiri_engraver,
 198 /* descr */       "Like Axis_group_engraver, but make a hara-kiri spanner, and add "
 199 "interesting items (ie. note heads, lyric syllables and normal rests) ",
 200 /* creats*/       "RemoveEmptyVerticalGroup",
 201 /* accepts */     "",
 202 /* acks  */      "grob-interface",
 203 /* reads */       "",
 204 /* write */       "");
 205
 206 ENTER_DESCRIPTION (Axis_group_engraver,
 207 /* descr */       "Group all objects created in this context in a VerticalAxisGroup spanner.",
 208 /* creats*/       "VerticalAxisGroup",
 209 /* accepts */     "",
 210 /* acks  */      "grob-interface",
 211 /* reads */       "verticalExtent minimumVerticalExtent extraVerticalExtent",
 212 /* write */       "");