]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/auto-beam-engraver.cc
Run `make grand-replace'.
[lilypond.git] / lily / auto-beam-engraver.cc
index 38585b06d5960f73d321f40f183e94e1e0a17dc9..f86edaecc88eceddb74e17dea010458a24fa826f 100644 (file)
@@ -3,32 +3,41 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1999--2005 Jan Nieuwenhuizen <janneke@gnu.org>
+  (c) 1999--2008 Jan Nieuwenhuizen <janneke@gnu.org>
 */
 
-#include "engraver.hh"
-#include "beaming.hh"
-#include "beam.hh"
-#include "stem.hh"
-#include "warn.hh"
 #include "bar-line.hh"
-#include "rest.hh"
+#include "beaming-pattern.hh"
+#include "beam.hh"
+#include "context.hh"
+#include "duration.hh"
+#include "engraver.hh"
 #include "item.hh"
+#include "rest.hh"
 #include "spanner.hh"
-#include "context.hh"
+#include "stream-event.hh"
+#include "stem.hh"
+#include "warn.hh"
+
+#include "translator.icc"
 
 class Auto_beam_engraver : public Engraver
 {
   TRANSLATOR_DECLARATIONS (Auto_beam_engraver);
 
 protected:
-  virtual void stop_translation_timestep ();
-  virtual void start_translation_timestep ();
-  virtual void process_music ();
-  virtual bool try_music (Music *);
+  void stop_translation_timestep ();
+  void process_music ();
   virtual void finalize ();
-  virtual void acknowledge_grob (Grob_info);
-  virtual void process_acknowledged_grobs ();
+  virtual void derived_mark () const;
+
+  DECLARE_ACKNOWLEDGER (rest);
+  DECLARE_ACKNOWLEDGER (beam);
+  DECLARE_ACKNOWLEDGER (bar_line);
+  DECLARE_ACKNOWLEDGER (stem);
+  DECLARE_TRANSLATOR_LISTENER (beam_forbid);
+
+  void process_acknowledged ();
 
 private:
   bool test_moment (Direction, Moment);
@@ -41,15 +50,15 @@ private:
   bool is_same_grace_state (Grob *e);
   void typeset_beam ();
 
-  Music *forbid_;
+  Stream_event *forbid_;
   /*
     shortest_mom is the shortest note in the beam.
   */
   Moment shortest_mom_;
   Spanner *finished_beam_;
-  Link_array<Item> *stems_;
+  vector<Item*> *stems_;
 
-  int count_;
+  int process_acknowledged_count_;
   Moment last_add_mom_;
   /*
     Projected ending of the  beam we're working on.
@@ -58,19 +67,54 @@ private:
   Moment beam_start_moment_;
   Moment beam_start_location_;
 
-  bool subdivide_beams_;
-  Moment beat_length_;
-
   // We act as if beam were created, and start a grouping anyway.
-  Beaming_info_list *grouping_;
-  SCM beam_settings_;          // ugh. should protect ? 
+  Beaming_pattern *grouping_;
+  SCM beam_settings_;
+
+  Beaming_pattern *finished_grouping_;
+
 
-  Beaming_info_list *finished_grouping_;
+  Beaming_options beaming_options_;
+  Beaming_options finished_beaming_options_;
+  
+  
+  void check_bar_property ();
 };
 
+void
+Auto_beam_engraver::derived_mark () const
+{
+  scm_gc_mark (beam_settings_);
+}
+
+void
+Auto_beam_engraver::check_bar_property ()
+{
+  /* Duplicated from process_music (), since
+     Repeat_acknowledge_engraver::process_music () may also set whichBar.  */
+
+  Moment now = now_mom ();
+  if (scm_is_string (get_property ("whichBar"))
+      && beam_start_moment_ < now)
+    {
+      consider_end (shortest_mom_);
+      junk_beam ();
+    }
+}
+
 void
 Auto_beam_engraver::process_music ()
 {
+  /*
+    don't beam over skips
+  */
+  if (stems_)
+    {
+      Moment now = now_mom ();
+      if (extend_mom_ < now)
+       end_beam ();
+    }
+
   if (scm_is_string (get_property ("whichBar")))
     {
       consider_end (shortest_mom_);
@@ -87,7 +131,7 @@ Auto_beam_engraver::process_music ()
 Auto_beam_engraver::Auto_beam_engraver ()
 {
   forbid_ = 0;
-  count_ = 0;
+  process_acknowledged_count_ = 0;
   stems_ = 0;
   shortest_mom_ = Moment (Rational (1, 8));
   finished_beam_ = 0;
@@ -96,16 +140,11 @@ Auto_beam_engraver::Auto_beam_engraver ()
   beam_settings_ = SCM_EOL;
 }
 
-bool
-Auto_beam_engraver::try_music (Music *m)
+IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid);
+void
+Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
 {
-  if (m->is_mus_type ("beam-forbid-event"))
-    {
-      forbid_ = m;
-      return true;
-    }
-
-  return false;
+  ASSIGN_EVENT_ONCE (forbid_, ev);
 }
 
 bool
@@ -117,7 +156,7 @@ Auto_beam_engraver::test_moment (Direction dir, Moment test)
                     test.smobbed_copy ())
     != SCM_BOOL_F;
 }
-    
+
 void
 Auto_beam_engraver::consider_begin (Moment test_mom)
 {
@@ -150,19 +189,18 @@ Auto_beam_engraver::create_beam ()
   if (to_boolean (get_property ("skipTypesetting")))
     return 0;
 
-  Spanner *beam = new Spanner (beam_settings_, context ()->get_grob_key ("Beam"));
-  for (int i = 0; i < stems_->size (); i++)
-    {
-      /*
-       watch out for stem tremolos and abbreviation beams
-      */
-      if (Stem::get_beam ((*stems_)[i]))
-       {
-         scm_gc_unprotect_object (beam->self_scm ());
-         return 0;
-       }
-      Beam::add_stem (beam, (*stems_)[i]);
-    }
+  for (vsize i = 0; i < stems_->size (); i++)
+    if (Stem::get_beam ((*stems_)[i]))
+      return 0;
+
+  /*
+    Can't use make_spanner_from_properties () because we have to use
+    beam_settings_.
+  */
+  Spanner *beam = new Spanner (beam_settings_);
+
+  for (vsize i = 0; i < stems_->size (); i++)
+    Beam::add_stem (beam, (*stems_)[i]);
 
   announce_grob (beam, (*stems_)[0]->self_scm ());
 
@@ -178,15 +216,14 @@ Auto_beam_engraver::begin_beam ()
       return;
     }
 
-  stems_ = new Link_array<Item>;
-  grouping_ = new Beaming_info_list;
+  stems_ = new vector<Item*>;
+  grouping_ = new Beaming_pattern ();
+  beaming_options_.from_context (context ());
   beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
 
   beam_start_moment_ = now_mom ();
   beam_start_location_
     = robust_scm2moment (get_property ("measurePosition"), Moment (0));
-  subdivide_beams_ = ly_scm2bool (get_property ("subdivideBeams"));
-  beat_length_ = robust_scm2moment (get_property ("beatLength"), Moment (1, 4));
 }
 
 void
@@ -208,14 +245,17 @@ void
 Auto_beam_engraver::end_beam ()
 {
   if (stems_->size () < 2)
-    {
-      junk_beam ();
-    }
+    junk_beam ();
   else
     {
       finished_beam_ = create_beam ();
+      
       if (finished_beam_)
-       finished_grouping_ = grouping_;
+       {
+         announce_end_grob (finished_beam_, SCM_EOL);
+         finished_grouping_ = grouping_;
+         finished_beaming_options_ = beaming_options_;
+       }
       delete stems_;
       stems_ = 0;
       grouping_ = 0;
@@ -230,7 +270,10 @@ Auto_beam_engraver::typeset_beam ()
 {
   if (finished_beam_)
     {
-      finished_grouping_->beamify (beat_length_, subdivide_beams_);
+      if (!finished_beam_->get_bound (RIGHT))
+       finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
+      
+      finished_grouping_->beamify (finished_beaming_options_);
       Beam::set_beaming (finished_beam_, finished_grouping_);
       finished_beam_ = 0;
 
@@ -239,28 +282,12 @@ Auto_beam_engraver::typeset_beam ()
     }
 }
 
-void
-Auto_beam_engraver::start_translation_timestep ()
-{
-  count_ = 0;
-  /*
-    don't beam over skips
-  */
-  if (stems_)
-    {
-      Moment now = now_mom ();
-      if (extend_mom_ < now)
-       {
-         end_beam ();
-       }
-    }
-  forbid_ = 0;
-}
-
 void
 Auto_beam_engraver::stop_translation_timestep ()
 {
   typeset_beam ();
+  process_acknowledged_count_ = 0;
+  forbid_ = 0;
 }
 
 void
@@ -273,152 +300,147 @@ Auto_beam_engraver::finalize ()
     junk_beam ();
 }
 
+
 void
-Auto_beam_engraver::acknowledge_grob (Grob_info info)
+Auto_beam_engraver::acknowledge_beam (Grob_info info)
 {
-  /* Duplicated from process_music (), since
-     Repeat_acknowledge_engraver::process_music () may also set whichBar.  */
-  if (scm_is_string (get_property ("whichBar"))
-      && beam_start_moment_ < now_mom ())
-    {
-      consider_end (shortest_mom_);
-      junk_beam ();
-    }
+  (void)info;
+  check_bar_property ();
+  if (stems_)
+    end_beam ();
+}
+
+void
+Auto_beam_engraver::acknowledge_bar_line (Grob_info info)
+{
+  (void)info;
+  check_bar_property ();
+  if (stems_)
+    end_beam ();
+}
 
+void
+Auto_beam_engraver::acknowledge_rest (Grob_info info)
+{
+  (void)info;
+  check_bar_property ();
   if (stems_)
+    end_beam ();
+}
+
+void
+Auto_beam_engraver::acknowledge_stem (Grob_info info)
+{
+  check_bar_property ();
+  Item *stem = dynamic_cast<Item *> (info.grob ());
+  Stream_event *ev = info.ultimate_event_cause ();
+  if (!ev->in_event_class ("rhythmic-event"))
     {
-      if (Beam::has_interface (info.grob_))
-       {
-         end_beam ();
-       }
-      else if (Bar_line::has_interface (info.grob_))
-       {
-         end_beam ();
-       }
-      else if (Rest::has_interface (info.grob_))
-       {
-         end_beam ();
-       }
+      programming_error ("stem must have rhythmic structure");
+      return;
     }
 
-  if (Stem::has_interface (info.grob_))
+  /*
+    Don't (start) auto-beam over empty stems; skips or rests
+  */
+  if (!Stem::head_count (stem))
     {
-      Item *stem = dynamic_cast<Item *> (info.grob_);
-      Music *m = info.music_cause ();
-      if (!m->is_mus_type ("rhythmic-event"))
-       {
-         programming_error ("stem must have rhythmic structure");
-         return;
-       }
-
-      /*
-       Don't (start) auto-beam over empty stems; skips or rests
-      */
-      if (!Stem::head_count (stem))
-       {
-         if (stems_)
-           end_beam ();
-         return;
-       }
-
-      if (Stem::get_beam (stem))
-       {
-         if (stems_)
-           junk_beam ();
-         return;
-       }
-
-      int durlog = unsmob_duration (m->get_property ("duration"))->duration_log ();
-
-      if (durlog <= 2)
-       {
-         if (stems_)
-           end_beam ();
-         return;
-       }
-
-      /*
-       ignore grace notes.
-      */
-      if (bool (beam_start_location_.grace_part_) != bool (now_mom ().grace_part_))
-       return;
+      if (stems_)
+       end_beam ();
+      return;
+    }
 
-      Moment dur = unsmob_duration (m->get_property ("duration"))->get_length ();
-      /* FIXME:
+  if (Stem::get_beam (stem))
+    {
+      if (stems_)
+       junk_beam ();
+      return;
+    }
 
-      This comment has been here since long:
+  int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
 
-      if shortest duration would change
-      consider ending and beginning beam first.
+  if (durlog <= 2)
+    {
+      if (stems_)
+       end_beam ();
+      return;
+    }
 
-      but the code didn't match: */
-#if 1
-      consider_end (dur);
-      consider_begin (dur);
+  /*
+    ignore grace notes.
+  */
+  Moment now = now_mom ();
+  if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_))
+    return;
 
-      if (dur < shortest_mom_)
-       shortest_mom_ = dur;
-#else
-      /* I very much suspect that we wanted: */
+  Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length ();
 
-      consider_end (shortest_mom_);
-      if (dur < shortest_mom_)
-       {
-         shortest_mom_ = dur;
-         consider_end (shortest_mom_);
-       }
-      consider_begin (shortest_mom_);
-#endif
+  consider_end (dur);
+  consider_begin (dur);
 
-      if (!stems_)
-       return;
+  if (dur < shortest_mom_)
+    shortest_mom_ = dur;
 
-      Moment now = now_mom ();
+  if (!stems_)
+    return;
 
-      grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
-                          durlog - 2);
-      stems_->push (stem);
-      last_add_mom_ = now;
-      extend_mom_ = (extend_mom_ >? now) + m->get_length ();
-    }
+  grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
+                      durlog - 2,
+                      Stem::is_invisible (stem));
+  stems_->push_back (stem);
+  last_add_mom_ = now;
+  extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now);
 }
 
 void
-Auto_beam_engraver::process_acknowledged_grobs ()
+Auto_beam_engraver::process_acknowledged ()
 {
-  if (!count_)
+  if (extend_mom_ > now_mom ())
+    return;
+
+  if (!process_acknowledged_count_)
     {
       consider_end (shortest_mom_);
       consider_begin (shortest_mom_);
     }
-  else if (count_ > 1)
+  else if (process_acknowledged_count_ > 1)
     {
       if (stems_)
        {
          Moment now = now_mom ();
          if ((extend_mom_ < now)
              || ((extend_mom_ == now) && (last_add_mom_ != now)))
-           {
-             end_beam ();
-           }
+           end_beam ();
          else if (!stems_->size ())
-           {
-             junk_beam ();
-           }
+           junk_beam ();
        }
     }
 
-  count_++;
+  process_acknowledged_count_++;
 }
 
+ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
 ADD_TRANSLATOR (Auto_beam_engraver,
-               /* descr */ "Generate beams based on measure characteristics and observed "
-               "Stems.  Uses beatLength, measureLength and measurePosition to decide "
-               "when to start and stop a beam.  Overriding beaming is done through "
-               "@ref{Stem_engraver} properties @code{stemLeftBeamCount} and "
-               "@code{stemRightBeamCount}. ",
-               /* creats*/ "Beam",
-               /* accepts */ "beam-forbid-event",
-               /* acks  */ "stem-interface rest-interface beam-interface bar-line-interface",
-               /* reads */ "autoBeaming autoBeamSettings beatLength subdivideBeams",
-               /* write */ "");
+               /* doc */
+               "Generate beams based on measure characteristics and observed"
+               " Stems.  Uses @code{beatLength}, @code{measureLength}, and"
+               " @code{measurePosition} to decide when to start and stop a"
+               " beam.  Overriding beaming is done through"
+               " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
+               " @code{stemRightBeamCount}.",
+
+               /* create */
+               "Beam ",
+
+               /* read */
+               "autoBeaming "
+               "autoBeamSettings "
+               "beatLength "
+               "subdivideBeams ",
+               
+               /* write */
+               ""
+               );