]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/beam-engraver.cc
use new-line-spanner for TextSpanner
[lilypond.git] / lily / beam-engraver.cc
index c8357fa38842d84bfae0fe9657e29b8d9413a325..51569b0e270b6582366f4e3cf0b7bb3412a97d9f 100644 (file)
 /*
-  beam-grav.cc -- implement Beam_engraver
+  beam-engraver.cc -- implement Beam_engraver
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1998--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
-#include "duration-convert.hh"
-#include "time-description.hh"
-#include "beam-engraver.hh"
-#include "stem.hh"
+
 #include "beam.hh"
-#include "musical-request.hh"
-#include "grouping.hh"
-#include "p-col.hh"
+#include "beaming-pattern.hh"
+#include "context.hh"
+#include "drul-array.hh"
+#include "duration.hh"
+#include "engraver.hh"
+#include "international.hh"
+#include "item.hh"
+#include "rest.hh"
+#include "spanner.hh"
+#include "stream-event.hh"
+#include "stem.hh"
 #include "warn.hh"
 
-Beam_engraver::Beam_engraver()
+#include "translator.icc"
+
+class Beam_engraver : public Engraver
 {
-  span_reqs_drul_[LEFT] = span_reqs_drul_[RIGHT] =0;
-  beam_p_ =0;
-  current_grouping_p_ =0;
-}
+public:
+  DECLARE_ACKNOWLEDGER (stem);
+  DECLARE_ACKNOWLEDGER (rest);
+
+protected:
+  Stream_event *start_ev_;
+
+  Spanner *finished_beam_;
+  Spanner *beam_;
+  Stream_event *prev_start_ev_;
+
+  Stream_event *stop_ev_;
+
+  Beaming_pattern *beam_info_;
+  Beaming_pattern *finished_beam_info_;
+
+  /// location  within measure where beam started.
+  Moment beam_start_location_;
+
+  /// moment (global time) where beam started.
+  Moment beam_start_mom_;
+
+  Beaming_options beaming_options_;
+  Beaming_options finished_beaming_options_;
+  
+  void typeset_beam ();
+  void set_melisma (bool);
 
+  Moment last_stem_added_at_;
+  void stop_translation_timestep ();
+  void start_translation_timestep ();
+  virtual void finalize ();
+
+  void process_music ();
+
+  virtual bool valid_start_point ();
+  virtual bool valid_end_point ();
+
+  DECLARE_TRANSLATOR_LISTENER (beam);
+public:
+  TRANSLATOR_DECLARATIONS (Beam_engraver);
+};
+
+/*
+  Hmm. this isn't necessary, since grace beams and normal beams are
+  always nested.
+*/
 bool
-Beam_engraver::do_try_music (Music*r)
+Beam_engraver::valid_start_point ()
 {
-  Beam_req* b = dynamic_cast <Beam_req *> (r);
-  if (!b)
-    return false;
+  Moment n = now_mom ();
 
-  if (bool (beam_p_) == bool (b->spantype_ == START))
-    return false;
+  return n.grace_part_ == Rational (0);
+}
 
-  Direction d = (!beam_p_) ? LEFT : RIGHT;
-  if (span_reqs_drul_[d] && !span_reqs_drul_[d]->equal_b (b))
-    return false;
+bool
+Beam_engraver::valid_end_point ()
+{
+  return valid_start_point ();
+}
 
-  span_reqs_drul_[d] = b;
-  return true;
+Beam_engraver::Beam_engraver ()
+{
+  beam_ = 0;
+  finished_beam_ = 0;
+  finished_beam_info_ = 0;
+  beam_info_ = 0;
+  stop_ev_ = 0;
+  start_ev_ = 0;
+  prev_start_ev_ = 0;
 }
 
+IMPLEMENT_TRANSLATOR_LISTENER (Beam_engraver, beam);
 void
-Beam_engraver::do_process_requests()
+Beam_engraver::listen_beam (Stream_event *ev)
 {
-  if (beam_p_ || !span_reqs_drul_[LEFT])
-    return;
+  Direction d = to_dir (ev->get_property ("span-direction"));
 
-  current_grouping_p_ = new Rhythmic_grouping;
-  beam_p_ = new Beam;
-
-  Scalar prop = get_property ("beamslopedamping");
-  if (prop.isnum_b ()) 
-    beam_p_->damping_i_ = prop;
+  if (d == START && valid_start_point ())
+    ASSIGN_EVENT_ONCE (start_ev_, ev);
+  else if (d == STOP && valid_end_point ())
+    ASSIGN_EVENT_ONCE (stop_ev_, ev);
+}
 
-  prop = get_property ("beamquantisation");
-  if (prop.isnum_b ()) 
-    beam_p_->quantisation_ = (Beam::Quantisation)(int)prop;
-  announce_element (Score_element_info (beam_p_, span_reqs_drul_[LEFT]));
+void
+Beam_engraver::set_melisma (bool ml)
+{
+  SCM b = get_property ("autoBeaming");
+  if (!to_boolean (b))
+    context ()->set_property ("beamMelismaBusy", ml ? SCM_BOOL_T : SCM_BOOL_F);
 }
 
 void
-Beam_engraver::do_pre_move_processing()
+Beam_engraver::process_music ()
 {
-  if (!beam_p_ || !span_reqs_drul_[RIGHT]) 
-    return;
+  if (start_ev_)
+    {
+      if (beam_)
+       {
+         start_ev_->origin ()->warning (_ ("already have a beam"));
+         return;
+       }
 
-  Rhythmic_grouping const * rg_C = get_staff_info().rhythmic_C_;
-  rg_C->extend (current_grouping_p_->interval());
-  beam_p_->set_grouping (*rg_C, *current_grouping_p_);
-  typeset_element (beam_p_);
-  beam_p_ = 0;
+      set_melisma (true);
+      prev_start_ev_ = start_ev_;
+      beam_ = make_spanner ("Beam", start_ev_->self_scm ());
+      Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 
-  delete current_grouping_p_;
-  current_grouping_p_ = 0;
+      beam_start_location_ = mp;
+      beam_start_mom_ = now_mom ();
 
-  span_reqs_drul_[RIGHT] = span_reqs_drul_[LEFT] = 0;
+      beaming_options_.from_context (context ());
+      beam_info_ = new Beaming_pattern;
+      /* urg, must copy to Auto_beam_engraver too */
+    }
+
+  typeset_beam ();
+  if (stop_ev_ && beam_)
+    {
+      announce_end_grob (beam_, stop_ev_->self_scm ());
+      
+    }
 }
 
 void
-Beam_engraver::do_removal_processing()
+Beam_engraver::typeset_beam ()
 {
-  if (beam_p_)
+  if (finished_beam_)
     {
-      span_reqs_drul_[LEFT]->warning (_("unterminated beam"));
-      typeset_element (beam_p_);
-      beam_p_ =0;
+      if (!finished_beam_->get_bound (RIGHT))
+       finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
+      
+      finished_beam_info_->beamify (finished_beaming_options_);
+      Beam::set_beaming (finished_beam_, finished_beam_info_);
+
+      delete finished_beam_info_;
+      finished_beam_info_ = 0;
+      finished_beam_ = 0;
     }
 }
 
+void
+Beam_engraver::start_translation_timestep ()
+{
+  start_ev_ = 0;
+
+  if (beam_)
+    {
+      set_melisma (true);
+    }
+}
 
 void
-Beam_engraver::acknowledge_element (Score_element_info i)
+Beam_engraver::stop_translation_timestep ()
 {
-  Stem* s = dynamic_cast<Stem *> (i.elem_l_);
-  if (!beam_p_ || !s)
-    return;
+  if (stop_ev_)
+    {
+      finished_beam_ = beam_;
+      finished_beam_info_ = beam_info_;
+      finished_beaming_options_ = beaming_options_;
+      
+      stop_ev_ = 0;
+      beam_ = 0;
+      beam_info_ = 0;
+      typeset_beam ();
+      set_melisma (false);
+    }
+}
 
-  if (!dynamic_cast <Rhythmic_req *> (i.req_l_))
+void
+Beam_engraver::finalize ()
+{
+  typeset_beam ();
+  if (beam_)
     {
-      ::warning ( _("Stem must have Rhythmic structure."));
-      return;
+      prev_start_ev_->origin ()->warning (_ ("unterminated beam"));
+
+      /*
+       we don't typeset it, (we used to, but it was commented
+       out. Reason unknown) */
+      beam_->suicide ();
+      delete beam_info_;
     }
+}
 
-  Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (i.req_l_);
-  if (rhythmic_req->duration_.durlog_i_<= 2)
+void
+Beam_engraver::acknowledge_rest (Grob_info info)
+{
+  if (beam_
+      && !scm_is_number (info.grob ()->get_property_data ("staff-position")))
     {
-      rhythmic_req->warning (_ ("stem doesn't fit in beam"));
-      return;
+      chain_offset_callback (info.grob(),
+                            Beam::rest_collision_callback_proc, Y_AXIS);
     }
+}
+
+
+
+void
+Beam_engraver::acknowledge_stem (Grob_info info)
+{
+  if (!beam_)
+    return;
+  
+  Moment now = now_mom ();
+  if (!valid_start_point ())
+    return;
 
-  /*
-    TODO: do something sensible if it doesn't fit in the beam.
-   */
-  Moment start = get_staff_info().time_C_->whole_in_measure_;
+  Item *stem = dynamic_cast<Item *> (info.grob ());
+  if (Stem::get_beam (stem))
+    return;
 
-  if (!current_grouping_p_->child_fit_b (start))
+  
+  
+  Stream_event *ev = info.ultimate_event_cause ();
+  if (!ev->in_event_class ("rhythmic-event"))
     {
-      String s (_("please fix me") + ": " 
-       + _f ("stem at %s doesn't fit in beam", now_moment ().str ()));
-      if (i.req_l_)
-       i.req_l_->warning(s);
-      else 
-       warning (s);
+      info.grob ()->warning (_ ("stem must have Rhythmic structure"));
+      return;
     }
-  else
+
+  last_stem_added_at_ = now;
+  int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
+  if (durlog <= 2)
     {
-      current_grouping_p_->add_child (start, rhythmic_req->duration ());
-      s->flag_i_ = rhythmic_req->duration_.durlog_i_;
-      beam_p_->add_stem (s);
+      ev->origin ()->warning (_ ("stem does not fit in beam"));
+      prev_start_ev_->origin ()->warning (_ ("beam was started here"));
+      /*
+       don't return, since
+
+       [r4 c8] can just as well be modern notation.
+      */
     }
+
+  stem->set_property ("duration-log",
+                     scm_from_int (durlog));
+  Moment stem_location = now - beam_start_mom_ + beam_start_location_;
+  beam_info_->add_stem (stem_location,
+                       max (durlog- 2, 0));
+  Beam::add_stem (beam_, stem);
+}
+
+ADD_ACKNOWLEDGER (Beam_engraver, stem);
+ADD_ACKNOWLEDGER (Beam_engraver, rest);
+
+ADD_TRANSLATOR (Beam_engraver,
+               /* doc */
+
+               "Handles Beam events by engraving Beams.  If omitted, then notes will be "
+               "printed with flags instead of beams.",
+               
+               /* create */ "Beam",
+
+               /* read */
+               "beamMelismaBusy "
+               "beatLength "
+               "subdivideBeams "
+               ,
+               /* write */
+               "forbidBreak");
+
+class Grace_beam_engraver : public Beam_engraver
+{
+public:
+  TRANSLATOR_DECLARATIONS (Grace_beam_engraver);
+
+  DECLARE_TRANSLATOR_LISTENER (beam);
+  
+protected:
+  virtual bool valid_start_point ();
+  virtual bool valid_end_point ();
+};
+
+Grace_beam_engraver::Grace_beam_engraver ()
+{
+}
+
+bool
+Grace_beam_engraver::valid_start_point ()
+{
+  Moment n = now_mom ();
+
+  return n.grace_part_ != Rational (0);
+}
+
+bool
+Grace_beam_engraver::valid_end_point ()
+{
+  return beam_ && valid_start_point ();
+}
+
+/*
+  Ugh, C&P code.
+ */
+IMPLEMENT_TRANSLATOR_LISTENER (Grace_beam_engraver, beam);
+void
+Grace_beam_engraver::listen_beam (Stream_event *ev)
+{
+  Direction d = to_dir (ev->get_property ("span-direction"));
+
+  if (d == START && valid_start_point ())
+    start_ev_ = ev;
+  else if (d == STOP && valid_end_point ())
+    stop_ev_ = ev;
 }
 
-ADD_THIS_TRANSLATOR(Beam_engraver);
+
+ADD_ACKNOWLEDGER (Grace_beam_engraver, stem);
+ADD_ACKNOWLEDGER (Grace_beam_engraver, rest);
+
+ADD_TRANSLATOR (Grace_beam_engraver,
+
+               /* doc */
+
+               "Handles Beam events by engraving Beams.  If omitted, then notes will "
+               "be printed with flags instead of beams. Only engraves beams when we "
+               " are at grace points in time. ",
+               
+               /* create */ "Beam",
+               /* read */
+               "beamMelismaBusy "
+               "beatLength "
+               "subdivideBeams "
+               ,
+               /* write */ "");
+