lily/spacing-engraver.cc

   1 /*
   2   spacing-engraver.cc --  implement Spacing_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #include "musical-request.hh"
  11 #include "paper-column.hh"
  12
  13 #include "spacing-spanner.hh"
  14 #include "engraver.hh"
  15 #include "pqueue.hh"
  16 #include "note-spacing.hh"
  17 #include "staff-spacing.hh"
  18 #include "group-interface.hh"
  19
  20 struct Rhythmic_tuple
  21 {
  22   Grob_info info_;
  23   Moment end_;
  24
  25   Rhythmic_tuple ()
  26     {
  27     }
  28   Rhythmic_tuple (Grob_info i, Moment m)
  29     {
  30       info_ = i;
  31       end_ = m;
  32     }
  33   static int time_compare (Rhythmic_tuple const &, Rhythmic_tuple const &);
  34 };
  35
  36 /**
  37    Acknowledge rhythmic elements, for initializing spacing fields in
  38    the columns.
  39
  40    should be the  last one of the toplevel context
  41 */
  42 class Spacing_engraver : public Engraver
  43 {
  44   PQueue<Rhythmic_tuple> playing_durations_;
  45   Array<Rhythmic_tuple> now_durations_;
  46   Array<Rhythmic_tuple> stopped_durations_;
  47
  48   Spanner * spacing_p_;
  49
  50   TRANSLATOR_DECLARATIONS(Spacing_engraver);
  51 protected:
  52   virtual void acknowledge_grob (Grob_info);
  53   virtual void start_translation_timestep ();
  54   virtual void stop_translation_timestep ();
  55   virtual void initialize ();
  56   virtual void finalize ();
  57 };
  58
  59 inline int
  60 compare (Rhythmic_tuple const &a, Rhythmic_tuple const &b)
  61 {
  62   return Rhythmic_tuple::time_compare (a,b);
  63 }
  64
  65 int
  66 Rhythmic_tuple::time_compare (Rhythmic_tuple const &h1,
  67                               Rhythmic_tuple const &h2)
  68 {
  69   return (h1.end_ - h2.end_).main_part_.sign ();
  70 }
  71
  72 Spacing_engraver::Spacing_engraver ()
  73 {
  74   spacing_p_ = 0;
  75 }
  76
  77 void
  78 Spacing_engraver::initialize ()
  79 {
  80   spacing_p_  =new Spanner (get_property ("SpacingSpanner"));
  81   spacing_p_->set_bound (LEFT, unsmob_grob (get_property ("currentCommandColumn")));
  82   announce_grob(spacing_p_, SCM_EOL);
  83 }
  84
  85 void
  86 Spacing_engraver::finalize ()
  87 {
  88   Grob * p = unsmob_grob (get_property ("currentCommandColumn"));
  89   spacing_p_->set_bound (RIGHT, p);
  90   typeset_grob (spacing_p_);
  91   spacing_p_ =0;
  92 }
  93
  94 void
  95 Spacing_engraver::acknowledge_grob (Grob_info i)
  96 {
  97   if (Note_spacing::has_interface (i.grob_l_) || Staff_spacing::has_interface (i.grob_l_))
  98     {
  99       Pointer_group_interface::add_grob (spacing_p_, ly_symbol2scm  ("wishes"), i.grob_l_);
 100     }
 101
 102   if (to_boolean (i.grob_l_->get_grob_property ("non-rhythmic")))
 103     return;
 104
 105   if (Rhythmic_req * r = dynamic_cast<Rhythmic_req*> (i.music_cause ()))
 106     {
 107       Rhythmic_tuple t (i, now_mom () + r->length_mom ());
 108       now_durations_.push (t);
 109     }
 110 }
 111
 112 void
 113 Spacing_engraver::stop_translation_timestep ()
 114 {
 115   Moment shortest_playing;
 116   shortest_playing.set_infinite (1);
 117   for (int i=0; i < playing_durations_.size (); i++)
 118     {
 119       Moment m = (playing_durations_[i].info_.music_cause ())->length_mom ();
 120       if (m.to_bool ())
 121         {
 122           shortest_playing = shortest_playing <? m;
 123         }
 124     }
 125
 126   Moment starter, inf;
 127   inf.set_infinite (1);
 128   starter=inf;
 129   for (int i=0; i < now_durations_.size (); i++)
 130     {
 131       Moment m = now_durations_[i].info_.music_cause ()->length_mom ();
 132       if (m.to_bool ())
 133         starter = starter <? m;
 134
 135       playing_durations_.insert (now_durations_[i]);
 136     }
 137   now_durations_.clear ();
 138
 139   shortest_playing = shortest_playing <? starter;
 140
 141   Paper_column * sc
 142     = dynamic_cast<Paper_column*> (unsmob_grob (get_property ("currentMusicalColumn")));
 143
 144   SCM sh = shortest_playing.smobbed_copy ();
 145   SCM st = starter.smobbed_copy ();
 146
 147   sc->set_grob_property ("shortest-playing-duration", sh);
 148   sc->set_grob_property ("shortest-starter-duration", st);
 149 }
 150
 151 void
 152 Spacing_engraver::start_translation_timestep ()
 153 {
 154   Moment now = now_mom ();
 155   stopped_durations_.clear ();
 156   while (playing_durations_.size () && playing_durations_.front ().end_ < now)
 157     playing_durations_.delmin ();
 158   while (playing_durations_.size () && playing_durations_.front ().end_ == now)
 159     stopped_durations_.push (playing_durations_.get ());
 160 }
 161
 162
 163
 164
 165 ENTER_DESCRIPTION(Spacing_engraver,
 166 /* descr */       "make a SpacingSpanner and do bookkeeping of shortest starting and playing notes  ",
 167 /* creats*/       "SpacingSpanner",
 168 /* acks  */       "grob-interface",
 169 /* reads */       "",
 170 /* write */       "");