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 acknowledge_grob (Grob_info);
  49   virtual bool try_music (Music*);
  50   virtual void process_music ();
  51
  52 public:
  53   Beam_engraver ();
  54   VIRTUAL_COPY_CONS (Translator);
  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)
  89             {
  90               SCM m = get_property ("automaticMelismata");
  91               SCM b = get_property ("noAutoBeaming");
  92               if (to_boolean (m) && to_boolean (b))
  93                 {
  94                   set_melisma (false);
  95                 }
  96             }
  97
  98           reqs_drul_[d ] = c;
  99           return true;
 100         }
 101     }
 102   return false;
 103 }
 104
 105 void
 106 Beam_engraver::set_melisma (bool m)
 107 {
 108   daddy_trans_l_->set_property ("beamMelismaBusy", m ? SCM_BOOL_T :SCM_BOOL_F);
 109 }
 110
 111 void
 112 Beam_engraver::process_music ()
 113 {
 114   if (reqs_drul_[STOP])
 115     {
 116       if (!beam_p_)
 117         reqs_drul_[STOP]->origin ()->warning (_ ("can't find start of beam"));
 118       prev_start_req_ =0;
 119       finished_beam_p_ = beam_p_;
 120       finished_beam_info_p_ = beam_info_p_;
 121
 122       beam_info_p_ =0;
 123       beam_p_ = 0;
 124     }
 125
 126
 127   if (beam_p_ && !to_boolean (get_property ("weAreGraceContext")))
 128     {
 129       Score_engraver * e = 0;
 130       Translator * t  =  daddy_grav_l ();
 131       for (; !e && t;  t = t->daddy_trans_l_)
 132         {
 133           e = dynamic_cast<Score_engraver*> (t);
 134         }
 135
 136       if (!e)
 137         programming_error ("No score engraver!");
 138       else
 139         e->forbid_breaks ();
 140     }
 141
 142   if (reqs_drul_[START])
 143     {
 144       if (beam_p_)
 145         {
 146           reqs_drul_[START]->origin ()->warning (_ ("already have a beam"));
 147           return;
 148         }
 149
 150       prev_start_req_ = reqs_drul_[START];
 151       beam_p_ = new Spanner (get_property ("Beam"));
 152       SCM smp = get_property ("measurePosition");
 153       Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
 154
 155       beam_start_location_ = mp;
 156       beam_start_mom_ = now_mom ();
 157       beam_info_p_ = new Beaming_info_list;
 158
 159
 160       /* urg, must copy to Auto_beam_engraver too */
 161
 162       announce_grob (beam_p_, reqs_drul_[START]);
 163     }
 164 }
 165
 166 void
 167 Beam_engraver::typeset_beam ()
 168 {
 169   if (finished_beam_p_)
 170     {
 171       finished_beam_info_p_->beamify ();
 172
 173       Beam::set_beaming (finished_beam_p_, finished_beam_info_p_);
 174       typeset_grob (finished_beam_p_);
 175       delete finished_beam_info_p_;
 176       finished_beam_info_p_ =0;
 177       finished_beam_p_ = 0;
 178     }
 179 }
 180
 181 void
 182 Beam_engraver::start_translation_timestep ()
 183 {
 184   reqs_drul_ [START] =0;
 185   reqs_drul_ [STOP] =0;
 186   if (beam_p_)
 187     {
 188       SCM m = get_property ("automaticMelismata");
 189       SCM b = get_property ("noAutoBeaming");
 190       if (to_boolean (m) && to_boolean (b)) {
 191         set_melisma (true);
 192       }
 193     }
 194 }
 195
 196 void
 197 Beam_engraver::stop_translation_timestep ()
 198 {
 199   typeset_beam ();
 200 }
 201
 202 void
 203 Beam_engraver::finalize ()
 204 {
 205   typeset_beam ();
 206   if (beam_p_)
 207     {
 208       prev_start_req_->origin ()->warning (_ ("unterminated beam"));
 209
 210    /*
 211         we don't typeset it, (we used to, but it was commented
 212         out. Reason unknown) */
 213       beam_p_->suicide ();
 214       delete beam_info_p_;
 215     }
 216 }
 217
 218 void
 219 Beam_engraver::acknowledge_grob (Grob_info info)
 220 {
 221   if (beam_p_)
 222     {
 223       if (Rest::has_interface (info.elem_l_))
 224         {
 225           info.elem_l_->add_offset_callback (Beam::rest_collision_callback_proc, Y_AXIS);
 226         }
 227       else if (Stem::has_interface (info.elem_l_))
 228         {
 229           Item *stem_l = dynamic_cast<Item*> (info.elem_l_);
 230           if (Stem::beam_l (stem_l))
 231             return;
 232
 233           bool stem_grace = stem_l->get_grob_property ("grace") == SCM_BOOL_T;
 234
 235           SCM wg =get_property ("weAreGraceContext");
 236           bool wgb= to_boolean (wg);
 237
 238           if (wgb!= stem_grace)
 239             return;
 240
 241           Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
 242           if (!rhythmic_req)
 243             {
 244               String s = _ ("stem must have Rhythmic structure");
 245               if (info.req_l_)
 246                 info.req_l_->origin ()->warning (s);
 247               else
 248                 ::warning (s);
 249
 250               return;
 251             }
 252
 253       int durlog  = unsmob_duration (rhythmic_req->get_mus_property ("duration"))-> duration_log ();
 254           if (durlog <= 2)
 255             {
 256               rhythmic_req->origin ()->warning (_ ("stem doesn't fit in beam"));
 257               prev_start_req_->origin ()->warning (_ ("beam was started here"));
 258               /*
 259                 don't return, since
 260
 261                 [r4 c8] can just as well be modern notation.
 262               */
 263             }
 264
 265           stem_l->set_grob_property ("duration-log",
 266                                     gh_int2scm (durlog));
 267           Moment stem_location = now_mom () - beam_start_mom_ + beam_start_location_;
 268           beam_info_p_->add_stem (stem_location,
 269  (durlog- 2) >? 1);
 270           Beam::add_stem (beam_p_, stem_l);
 271         }
 272     }
 273 }
 274
 275
 276
 277 ADD_THIS_TRANSLATOR (Beam_engraver);
 278