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--2003 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.hh"
  13 #include "engraver-group-engraver.hh"
  14
  15 /**
  16    Put stuff in a Spanner with an Axis_group_interface.
  17    Use as last element of a context.
  18  */
  19 class Axis_group_engraver : public Engraver
  20 {
  21 protected:
  22   Spanner *staffline_;
  23   Link_array<Grob> elts_;
  24   virtual void initialize ();
  25   virtual void finalize ();
  26   virtual void acknowledge_grob (Grob_info);
  27   virtual void process_acknowledged_grobs ();
  28   virtual Spanner* get_spanner () const;
  29   virtual void add_element (Grob*) ;
  30 public:
  31 TRANSLATOR_DECLARATIONS(Axis_group_engraver );
  32 };
  33
  34
  35
  36 Axis_group_engraver::Axis_group_engraver ()
  37 {
  38   staffline_ = 0;
  39 }
  40
  41 void
  42 Axis_group_engraver::initialize ()
  43 {
  44   staffline_ = get_spanner ();
  45
  46   Grob *  it = unsmob_grob (get_property ("currentCommandColumn"));
  47
  48   staffline_->set_bound (LEFT,it);
  49
  50   announce_grob(staffline_, SCM_EOL);
  51 }
  52
  53 Spanner*
  54 Axis_group_engraver::get_spanner () const
  55 {
  56   return new Spanner (get_property ("VerticalAxisGroup"));
  57 }
  58
  59 void
  60 Axis_group_engraver::finalize ()
  61 {
  62   String type = get_daddy_grav ()->context_name ();
  63   SCM dims = get_property ("verticalExtent");
  64
  65   if (gh_pair_p (dims) && gh_number_p (ly_car (dims))
  66       && gh_number_p (ly_cdr (dims)))
  67     {
  68       staffline_->set_extent (Grob::preset_extent_proc, Y_AXIS);
  69       staffline_->set_grob_property ("Y-extent", dims);
  70     }
  71
  72   dims = get_property ("minimumVerticalExtent");
  73   if (gh_pair_p (dims) && gh_number_p (ly_car (dims))
  74       && gh_number_p (ly_cdr (dims)))
  75     staffline_->set_grob_property ("minimum-Y-extent", dims);
  76
  77   dims = get_property ("extraVerticalExtent");
  78   if (gh_pair_p (dims) && gh_number_p (ly_car (dims))
  79       && gh_number_p (ly_cdr (dims)))
  80     staffline_->set_grob_property ("extra-Y-extent", dims);
  81
  82   Grob *  it = unsmob_grob (get_property ("currentCommandColumn"));
  83
  84
  85   staffline_->set_bound (RIGHT,it);
  86
  87   typeset_grob (staffline_);
  88   staffline_ = 0;
  89 }
  90
  91 void
  92 Axis_group_engraver::acknowledge_grob (Grob_info i)
  93 {
  94   elts_.push (i.grob_);
  95 }
  96
  97 /*
  98   maybe should check if our parent is set, because we now get a
  99   cyclic parent relationship if we have two Axis_group_engravers in
 100   the context.  */
 101 void
 102 Axis_group_engraver::process_acknowledged_grobs ()
 103 {
 104   /* UGH UGH UGH */
 105   for (int i=0; i < elts_.size (); i++)
 106     {
 107       Grob *par = elts_[i]->get_parent (Y_AXIS);
 108
 109       if ((!par || !Axis_group_interface::has_interface (par))
 110           && ! elts_[i]->empty_b (Y_AXIS))
 111         add_element (elts_[i]);
 112     }
 113   elts_.clear ();
 114 }
 115
 116 void
 117 Axis_group_engraver::add_element (Grob*e)
 118 {
 119   Axis_group_interface::add_element (staffline_, e);
 120 }
 121
 122 ////////////////////////////////////////////////////////
 123 // maybenot such a good idea after all., to put classes in .cc
 124
 125 #include "hara-kiri-group-spanner.hh"
 126 #include "rhythmic-head.hh"
 127
 128 class Hara_kiri_engraver : public Axis_group_engraver
 129 {
 130 protected:
 131   virtual Spanner*get_spanner ()const;
 132   virtual void acknowledge_grob (Grob_info);
 133   virtual void add_element (Grob *e);
 134 public:
 135   TRANSLATOR_DECLARATIONS(Hara_kiri_engraver);
 136 };
 137
 138 void
 139 Hara_kiri_engraver::add_element (Grob*e)
 140 {
 141   Hara_kiri_group_spanner::add_element (staffline_, e);
 142 }
 143
 144
 145 Spanner*
 146 Hara_kiri_engraver::get_spanner () const
 147 {
 148   Spanner * sp = new Spanner (get_property ("RemoveEmptyVerticalGroup"));
 149
 150   return sp;
 151 }
 152
 153 void
 154 Hara_kiri_engraver::acknowledge_grob (Grob_info i)
 155 {
 156   Axis_group_engraver::acknowledge_grob (i);
 157   if (i.grob_->internal_has_interface (ly_symbol2scm ("rhythmic-grob-interface")))
 158     {
 159       Hara_kiri_group_spanner::add_interesting_item (staffline_, i.grob_);
 160     }
 161 }
 162
 163
 164 Hara_kiri_engraver::Hara_kiri_engraver()
 165 {
 166 }
 167
 168 ENTER_DESCRIPTION(Hara_kiri_engraver,
 169 /* descr */       "Like Axis_group_engraver, but make a hara kiri spanner, and add "
 170 "interesting items (ie. note heads, lyric syllables and normal rests) ",
 171 /* creats*/       "RemoveEmptyVerticalGroup",
 172 /* accepts */     "",
 173 /* acks  */      "grob-interface",
 174 /* reads */       "",
 175 /* write */       "");
 176
 177 ENTER_DESCRIPTION(Axis_group_engraver,
 178 /* descr */       "Group all objects created in this context in a VerticalAxisGroup spanner.",
 179 /* creats*/       "VerticalAxisGroup",
 180 /* accepts */     "",
 181 /* acks  */      "grob-interface",
 182 /* reads */       "verticalExtent minimumVerticalExtent extraVerticalExtent",
 183 /* write */       "");