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