lily/beam-engraver.cc

   1 /*
   2   beam-engraver.cc --  implement Beam_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9 #include "engraver-group-engraver.hh"
  10 #include "engraver.hh"
  11 #include "musical-request.hh"
  12 #include "beam.hh"
  13 #include "stem.hh"
  14 #include "warn.hh"
  15 #include "beaming.hh"
  16 #include "score-engraver.hh"
  17 #include "rest.hh"
  18 #include "drul-array.hh"
  19 #include "item.hh"
  20 #include "spanner.hh"
  21
  22 class Beam_engraver : public Engraver
  23 {
  24   Drul_array<Span_req*> reqs_drul_;
  25
  26   Link_array<Stem> stems_;
  27
  28
  29   Spanner *finished_beam_p_;
  30   Spanner *beam_p_;
  31   Span_req * prev_start_req_;
  32
  33   Beaming_info_list * beam_info_p_;
  34   Beaming_info_list * finished_beam_info_p_;
  35
  36   /// location  within measure where beam started.
  37   Moment beam_start_location_;
  38
  39   /// moment (global time) where beam started.
  40   Moment beam_start_mom_;
  41
  42   void typeset_beam ();
  43   void set_melisma (bool);
  44 protected:
  45   virtual void stop_translation_timestep ();
  46   virtual void start_translation_timestep ();
  47   virtual void finalize ();
  48   virtual void create_grobs ();
  49   virtual void acknowledge_grob (Grob_info);
  50   virtual bool try_music (Music*);
  51   virtual void process_music ();
  52
  53 public:
  54   TRANSLATOR_DECLARATIONS(  Beam_engraver );
  55 };
  56
  57
  58 Beam_engraver::Beam_engraver ()
  59 {
  60   beam_p_ = 0;
  61   finished_beam_p_ =0;
  62   finished_beam_info_p_=0;
  63   beam_info_p_ =0;
  64   reqs_drul_[LEFT] = reqs_drul_[RIGHT] =0;
  65   prev_start_req_ =0;
  66 }
  67
  68 bool
  69 Beam_engraver::try_music (Music *m)
  70 {
  71   if (Span_req * c = dynamic_cast<Span_req*> (m))
  72     {
  73       if (scm_equal_p (c->get_mus_property ("span-type"),
  74                        ly_str02scm ("abort")) == SCM_BOOL_T)
  75         {
  76           reqs_drul_[START] = 0;
  77           reqs_drul_[STOP] = 0;
  78           if (beam_p_)
  79             beam_p_->suicide ();
  80           beam_p_ = 0;
  81         }
  82       else if (scm_equal_p (c->get_mus_property ("span-type"),
  83                        ly_str02scm ("beam")) == SCM_BOOL_T)
  84         {
  85
  86           Direction d =c->get_span_dir ();
  87
  88           if (d == STOP && !beam_p_)
  89             {
  90               m->origin ()->warning (_ ("can't find start of beam"));
  91               return false;
  92             }
  93
  94           if (d == STOP)
  95             {
  96               SCM m = get_property ("automaticMelismata");
  97               SCM b = get_property ("noAutoBeaming");
  98               if (to_boolean (m) && to_boolean (b))
  99                 {
 100                   set_melisma (false);
 101                 }
 102             }
 103
 104           reqs_drul_[d ] = c;
 105           return true;
 106         }
 107     }
 108   return false;
 109 }
 110
 111 void
 112 Beam_engraver::set_melisma (bool m)
 113 {
 114   daddy_trans_l_->set_property ("beamMelismaBusy", m ? SCM_BOOL_T :SCM_BOOL_F);
 115 }
 116
 117 void
 118 Beam_engraver::process_music ()
 119 {
 120   if (reqs_drul_[STOP])
 121     {
 122       if (!beam_p_)
 123         reqs_drul_[STOP]->origin ()->warning (_ ("can't find start of beam"));
 124       prev_start_req_ =0;
 125       finished_beam_p_ = beam_p_;
 126       finished_beam_info_p_ = beam_info_p_;
 127
 128       beam_info_p_ =0;
 129       beam_p_ = 0;
 130     }
 131
 132
 133   if (beam_p_)
 134     {
 135       Score_engraver * e = 0;
 136       Translator * t  =  daddy_grav_l ();
 137       for (; !e && t;  t = t->daddy_trans_l_)
 138         {
 139           e = dynamic_cast<Score_engraver*> (t);
 140         }
 141
 142       if (!e)
 143         programming_error ("No score engraver!");
 144       else
 145         e->forbid_breaks ();
 146     }
 147 }
 148
 149
 150 void
 151 Beam_engraver::create_grobs ()
 152 {
 153   if (reqs_drul_[START])
 154     {
 155       if (beam_p_)
 156         {
 157           reqs_drul_[START]->origin ()->warning (_ ("already have a beam"));
 158           return;
 159         }
 160
 161       prev_start_req_ = reqs_drul_[START];
 162       beam_p_ = new Spanner (get_property ("Beam"));
 163       SCM smp = get_property ("measurePosition");
 164       Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
 165
 166       beam_start_location_ = mp;
 167       beam_start_mom_ = now_mom ();
 168
 169       beam_info_p_ = new Beaming_info_list;
 170
 171       /* urg, must copy to Auto_beam_engraver too */
 172
 173       announce_grob (beam_p_, reqs_drul_[START]);
 174     }
 175   reqs_drul_[STOP] = 0;
 176   reqs_drul_[START] = 0;
 177 }
 178
 179 void
 180 Beam_engraver::typeset_beam ()
 181 {
 182   if (finished_beam_p_)
 183     {
 184       finished_beam_info_p_->beamify ();
 185
 186       Beam::set_beaming (finished_beam_p_, finished_beam_info_p_);
 187       typeset_grob (finished_beam_p_);
 188       delete finished_beam_info_p_;
 189       finished_beam_info_p_ =0;
 190       finished_beam_p_ = 0;
 191
 192       reqs_drul_[STOP] = 0;
 193     }
 194 }
 195
 196 void
 197 Beam_engraver::start_translation_timestep ()
 198 {
 199   reqs_drul_ [START] =0;
 200   if (beam_p_) {
 201     SCM m = get_property ("automaticMelismata");
 202     SCM b = get_property ("noAutoBeaming");
 203     if (to_boolean (m) && to_boolean (b)) {
 204       set_melisma (true);
 205     }
 206   }
 207 }
 208
 209 void
 210 Beam_engraver::stop_translation_timestep ()
 211 {
 212   typeset_beam ();
 213 }
 214
 215 void
 216 Beam_engraver::finalize ()
 217 {
 218   typeset_beam ();
 219   if (beam_p_)
 220     {
 221       prev_start_req_->origin ()->warning (_ ("unterminated beam"));
 222
 223       /*
 224         we don't typeset it, (we used to, but it was commented
 225         out. Reason unknown) */
 226       beam_p_->suicide ();
 227       delete beam_info_p_;
 228     }
 229 }
 230
 231 void
 232 Beam_engraver::acknowledge_grob (Grob_info info)
 233 {
 234   if (beam_p_)
 235     {
 236       if (Rest::has_interface (info.grob_l_))
 237         {
 238           info.grob_l_->add_offset_callback (Beam::rest_collision_callback_proc, Y_AXIS);
 239         }
 240       else if (Stem::has_interface (info.grob_l_))
 241         {
 242           Moment now = now_mom();
 243
 244           if(bool (now.grace_part_ ) != bool (beam_start_mom_.grace_part_))
 245             return ;
 246
 247           Item *stem_l = dynamic_cast<Item*> (info.grob_l_);
 248           if (Stem::beam_l (stem_l))
 249             return;
 250
 251           Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
 252           if (!rhythmic_req)
 253             {
 254               String s = _ ("stem must have Rhythmic structure");
 255               if (info.req_l_)
 256                 info.req_l_->origin ()->warning (s);
 257               else
 258                 ::warning (s);
 259
 260               return;
 261             }
 262
 263       int durlog  = unsmob_duration (rhythmic_req->get_mus_property ("duration"))-> duration_log ();
 264           if (durlog <= 2)
 265             {
 266               rhythmic_req->origin ()->warning (_ ("stem doesn't fit in beam"));
 267               prev_start_req_->origin ()->warning (_ ("beam was started here"));
 268               /*
 269                 don't return, since
 270
 271                 [r4 c8] can just as well be modern notation.
 272               */
 273             }
 274
 275           stem_l->set_grob_property ("duration-log",
 276                                     gh_int2scm (durlog));
 277           Moment stem_location = now - beam_start_mom_ + beam_start_location_;
 278           beam_info_p_->add_stem (stem_location,
 279  (durlog- 2) >? 1);
 280           Beam::add_stem (beam_p_, stem_l);
 281         }
 282     }
 283 }
 284
 285
 286
 287
 288
 289 ENTER_DESCRIPTION(Beam_engraver,
 290 /* descr */       "Handles Beam_requests by engraving Beams.    If omitted, then notes will be
 291 printed with flags instead of beams.",
 292 /* creats*/       "Beam",
 293 /* acks  */       "stem-interface rest-interface",
 294 /* reads */       "beamMelismaBusy",
 295 /* write */       "");