]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/auto-beam-engraver.cc
new file.
[lilypond.git] / lily / auto-beam-engraver.cc
index 17af9045334412b8cdc9a23ee039931991330245..94e49d549d961fa43ea6a858bd2c68a33953f1a3 100644 (file)
@@ -1,59 +1,57 @@
 /*   
-  auto-beam-engraver.cc --  implement Auto_beam_engraver
+  auto-beam-engraver.cc -- implement Auto_beam_engraver
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1999--2002 Jan Nieuwenhuizen <janneke@gnu.org>
+  (c) 1999--2005 Jan Nieuwenhuizen <janneke@gnu.org>
   
  */
 
+#include "engraver.hh"
 #include "beaming.hh"
-#include "musical-request.hh"
 #include "beam.hh"
 #include "stem.hh"
-#include "debug.hh"
-#include "engraver-group-engraver.hh"
-#include "bar.hh"
+#include "warn.hh"
+#include "bar-line.hh"
 #include "rest.hh"
-#include "engraver.hh"
 #include "item.hh"
 #include "spanner.hh"
+#include "context.hh"
 
-/*
-  TODO: figure what to do in grace?
-
-  TODO: documentme.
- */
 class Auto_beam_engraver : public Engraver
 {
-  TRANSLATOR_DECLARATIONS(Auto_beam_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*);
   virtual void finalize ();
   virtual void acknowledge_grob (Grob_info);
-  virtual void create_grobs ();
+  virtual void process_acknowledged_grobs ();
 
 private:
   bool test_moment (Direction, Moment);
   void consider_begin (Moment);
   void consider_end (Moment);
-  Spanner* create_beam_p ();
+  Spanner* create_beam ();
   void begin_beam ();
   void end_beam ();
   void junk_beam ();
-  bool same_grace_state_b (Grob* e);
+  bool is_same_grace_state (Grob* e);
   void typeset_beam ();
 
+  Music *forbid_;
   /*
     shortest_mom is the shortest note in the beam.
    */
   Moment shortest_mom_;
-  Spanner *finished_beam_p_;
-  Link_array<Item>* stem_l_arr_p_;
+  Spanner *finished_beam_;
+  Link_array<Item>* stems_;
 
 
-  int count_i_;
+  int count_;
   Moment last_add_mom_;
   /*
     Projected ending of the  beam we're working on.
@@ -63,27 +61,60 @@ private:
   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_p_;  
-  Beaming_info_list*finished_grouping_p_;
+  Beaming_info_list*grouping_;
+  SCM beam_settings_ ;         // ugh. should protect ? 
+  
+  Beaming_info_list*finished_grouping_;
 };
 
+void
+Auto_beam_engraver::process_music ()
+{
+  if (scm_is_string (get_property ("whichBar")))
+    {
+      consider_end (shortest_mom_);
+      junk_beam ();
+    }
+
+  if (forbid_)
+    {
+      consider_end (shortest_mom_);
+      junk_beam ();
+    }
+}
 
 
 Auto_beam_engraver::Auto_beam_engraver ()
 {
-  count_i_ = 0;
-  stem_l_arr_p_ = 0;
+  forbid_ = 0;
+  count_ = 0;
+  stems_ = 0;
   shortest_mom_ = Moment (Rational (1, 8));
-  finished_beam_p_ = 0;
-  finished_grouping_p_ = 0;
-  grouping_p_ = 0;
+  finished_beam_ = 0;
+  finished_grouping_ = 0;
+  grouping_ = 0;
+  beam_settings_ = SCM_EOL;  
+}
+
+
+bool
+Auto_beam_engraver::try_music (Music*m)
+{
+  if (m->is_mus_type  ("beam-forbid-event"))
+    {
+      forbid_ = m;
+      return true;
+    }
+
+  return false;
 }
 
 /*
   Determine end moment for auto beaming (or begin moment, but mostly
-  0==anywhere) In order of increasing priority:
+  0== anywhere) In order of increasing priority:
   
   i.   begin anywhere, end at every beat
   ii.  end   *    <num> <den>
@@ -108,21 +139,42 @@ Auto_beam_engraver::Auto_beam_engraver ()
 bool
 Auto_beam_engraver::test_moment (Direction dir, Moment test_mom)
 {
+  Moment now = now_mom ();
+  if (dir == START
+      && now.grace_part_)
+    {
+      return false;
+    }
+  
   SCM wild = scm_list_n (ly_symbol2scm ("*"), ly_symbol2scm ("*"), SCM_UNDEFINED);
   SCM function;
   if (dir == START)
     function = scm_list_n (ly_symbol2scm ("begin"), SCM_UNDEFINED);
   else
     function = scm_list_n (ly_symbol2scm ("end"), SCM_UNDEFINED);
+  
+  Moment beat_length (1, 4);
+  if (Moment * m = unsmob_moment (get_property ("beatLength")))
+    {
+      beat_length = *m;
+    }
+  Moment measure_length (1, 1);
+  int num = 4;
+  if (Moment* m = unsmob_moment (get_property ("measureLength")))
+    {
+      num = int ((*m / beat_length).main_part_);
+    }
+  
+  int den = beat_length.den ();
+  SCM time = scm_list_n (scm_int2num (num), scm_int2num (den), SCM_UNDEFINED);
 
-  Moment one_beat = *unsmob_moment (get_property ("beatLength"));
-  int num = int ((*unsmob_moment (get_property ("measureLength")) / one_beat).main_part_);
-  int den = one_beat.den ();
-  SCM time = scm_list_n (gh_int2scm (num), gh_int2scm (den), SCM_UNDEFINED);
-
-  SCM type = scm_list_n (gh_int2scm (test_mom.num ()),
-                     gh_int2scm (test_mom.den ()), SCM_UNDEFINED);
+  SCM type = scm_list_n (scm_int2num (test_mom.num ()),
+                     scm_int2num (test_mom.den ()), SCM_UNDEFINED);
 
+  /*
+    UGH UGH.
+    settings aren't grob-properties.
+   */
   SCM settings = get_property ("autoBeamSettings");
   
   /* first guess */
@@ -134,32 +186,29 @@ Auto_beam_engraver::test_moment (Direction dir, Moment test_mom)
   /* end beam at end of beat */
   if (dir == STOP)
     {
-      SCM beat (get_property ("beatLength"));
-      
-      if (unsmob_moment (beat))
-       moment = *unsmob_moment (beat);
+      moment = robust_scm2moment (get_property ("beatLength"), moment);
     }
 
   /* second guess: property generic time exception */
-  SCM m = gh_assoc (gh_append3 (function, wild, time), settings);
+  SCM m = scm_assoc (ly_append3 (function, wild, time), settings);
   
-  if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m)))
-    moment = * unsmob_moment (ly_cdr (m));
+  if (m != SCM_BOOL_F && unsmob_moment (scm_cdr (m)))
+    moment = * unsmob_moment (scm_cdr (m));
 
   /* third guess: property time exception, specific for duration type */
-  m = gh_assoc (gh_append3 (function, type, time), settings);
-  if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m)))
-    moment = * unsmob_moment (ly_cdr (m));
+  m = scm_assoc (ly_append3 (function, type, time), settings);
+  if (m != SCM_BOOL_F && unsmob_moment (scm_cdr (m)))
+    moment = * unsmob_moment (scm_cdr (m));
 
   /* fourth guess [user override]: property plain generic */
-  m = gh_assoc (gh_append3 (function, wild, wild), settings);
-  if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m)))
-    moment = * unsmob_moment (ly_cdr (m));
+  m = scm_assoc (ly_append3 (function, wild, wild), settings);
+  if (m != SCM_BOOL_F && unsmob_moment (scm_cdr (m)))
+    moment = * unsmob_moment (scm_cdr (m));
 
   /* fifth guess [user override]: property plain, specific for duration type */
-  m = gh_assoc (gh_append3 (function, type, wild), settings);
-  if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m)))
-    moment = * unsmob_moment (ly_cdr (m));
+  m = scm_assoc (ly_append3 (function, type, wild), settings);
+  if (m != SCM_BOOL_F && unsmob_moment (scm_cdr (m)))
+    moment = * unsmob_moment (scm_cdr (m));
   
   Rational r;
   if (moment.to_bool ())
@@ -168,10 +217,20 @@ Auto_beam_engraver::test_moment (Direction dir, Moment test_mom)
         We may have to fix this elsewhere (timing translator)
        r = unsmob_moment (get_property ("measurePosition"))->mod_rat (moment);
       */
-      Moment pos = * unsmob_moment (get_property ("measurePosition"));
+      Moment pos (0);
+      if (Moment  *m = unsmob_moment (get_property ("measurePosition")))
+       {
+         pos = *m;
+       }
+         
       if (pos < Moment (0))
        {
-         Moment length = * unsmob_moment (get_property ("measureLength"));
+         Moment length(1);
+
+         if ( Moment *m =  unsmob_moment (get_property ("measureLength")))
+           {
+             length = *m;
+           }
          pos = length - pos;
        }
       r = pos.main_part_.mod_rat (moment.main_part_);
@@ -185,14 +244,16 @@ Auto_beam_engraver::test_moment (Direction dir, Moment test_mom)
        /* but ending is not */
        r = 1;
     }
+
   return !r;
 }
 
 void
 Auto_beam_engraver::consider_begin (Moment test_mom)
 {
-  bool off = to_boolean (get_property ("noAutoBeaming"));
-  if (!stem_l_arr_p_ && ! off)
+  bool on = to_boolean (get_property ("autoBeaming"));
+  if (!stems_ && on
+      && !forbid_)
     {
       bool b = test_moment (START, test_mom);
       if (b)
@@ -203,85 +264,92 @@ Auto_beam_engraver::consider_begin (Moment test_mom)
 void
 Auto_beam_engraver::consider_end (Moment test_mom)
 {
-  if (stem_l_arr_p_)
+  if (stems_)
     {
       /* Allow already started autobeam to end:
-        don't check for noAutoBeaming */
+        don't check for autoBeaming */
       bool b = test_moment (STOP, test_mom);
       if (b)
        end_beam ();
     }
 }
 
-Spanner*
-Auto_beam_engraver::create_beam_p ()
+Spanner *
+Auto_beam_engraver::create_beam ()
 {
   if (to_boolean (get_property ("skipTypesetting")))
-    {
-     return 0;
-    }
+    return 0;
   
-  Spanner* beam_p = new Spanner (get_property ("Beam"));
-  for (int i = 0; i < stem_l_arr_p_->size (); i++)
+  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::beam_l ((*stem_l_arr_p_)[i]))
+      if (Stem::get_beam ((*stems_)[i]))
        {
-         scm_gc_unprotect_object (beam_p->self_scm ());
+         scm_gc_unprotect_object (beam->self_scm ());
          return 0;
        }
-      Beam::add_stem (beam_p, (*stem_l_arr_p_)[i]);
+      Beam::add_stem (beam, (*stems_)[i]);
     }
   
-  announce_grob(beam_p, SCM_EOL);
+  announce_grob (beam, (*stems_)[0]->self_scm ());
 
-  return beam_p;
+  return beam;
 }
 
 void
 Auto_beam_engraver::begin_beam ()
 {
-  assert (!stem_l_arr_p_);
-  stem_l_arr_p_ = new Link_array<Item>;
-  assert (!grouping_p_);
-  grouping_p_ = new Beaming_info_list;
+  if (stems_ || grouping_ )
+    {
+      programming_error ("already have autobeam");
+      return; 
+    }
+  
+  stems_ = new Link_array<Item>;
+  grouping_ = new Beaming_info_list;
+  beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
+  
   beam_start_moment_ = now_mom ();
-  beam_start_location_ = *unsmob_moment (get_property ("measurePosition"));
-  subdivide_beams_ = gh_scm2bool(get_property("subdivideBeams")); 
+  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
 Auto_beam_engraver::junk_beam () 
 {
-  assert (stem_l_arr_p_);
+  if (!stems_)
+    return ;
+  
+  delete stems_;
+  stems_ = 0;
+  delete grouping_;
+  grouping_ = 0;
+  beam_settings_ = SCM_EOL;
   
-  delete stem_l_arr_p_;
-  stem_l_arr_p_ = 0;
-  delete grouping_p_;
-  grouping_p_ = 0;
-
   shortest_mom_ = Moment (Rational (1, 8));
 }
 
 void
 Auto_beam_engraver::end_beam ()
 {
-  if (stem_l_arr_p_->size () < 2)
+  if (stems_->size () < 2)
     {
       junk_beam ();
     }
   else
-    
     {
-      finished_beam_p_ = create_beam_p ();
-      if (finished_beam_p_)
-       finished_grouping_p_ = grouping_p_;
-      delete stem_l_arr_p_;
-      stem_l_arr_p_ = 0;
-      grouping_p_ = 0;
+      finished_beam_ = create_beam ();
+      if (finished_beam_)
+       finished_grouping_ = grouping_;
+      delete stems_;
+      stems_ = 0;
+      grouping_ = 0;
+      beam_settings_ = SCM_EOL;
     }
 
   shortest_mom_ = Moment (Rational (1, 8));
@@ -290,27 +358,25 @@ Auto_beam_engraver::end_beam ()
 void
 Auto_beam_engraver::typeset_beam ()
 {
-  if (finished_beam_p_)
+  if (finished_beam_)
     {
-      finished_grouping_p_->beamify(*unsmob_moment (get_property ("beatLength")),
-                                   subdivide_beams_);
-      Beam::set_beaming (finished_beam_p_, finished_grouping_p_);
-      typeset_grob (finished_beam_p_);
-      finished_beam_p_ = 0;
+      finished_grouping_->beamify (beat_length_, subdivide_beams_);
+      Beam::set_beaming (finished_beam_, finished_grouping_);
+      finished_beam_ = 0;
     
-      delete finished_grouping_p_;
-      finished_grouping_p_= 0;
+      delete finished_grouping_;
+      finished_grouping_ = 0;
     }
 }
 
 void
 Auto_beam_engraver::start_translation_timestep ()
 {
-  count_i_ = 0;
+  count_ = 0;
   /*
     don't beam over skips
    */
-  if (stem_l_arr_p_)
+  if (stems_)
     {
       Moment now = now_mom ();
       if (extend_mom_ < now)
@@ -318,6 +384,7 @@ Auto_beam_engraver::start_translation_timestep ()
          end_beam ();
        }
     }
+  forbid_ = 0;
 }
 
 void
@@ -332,7 +399,7 @@ Auto_beam_engraver::finalize ()
   /* finished beams may be typeset */
   typeset_beam ();
   /* but unfinished may need another announce/acknowledge pass */
-  if (stem_l_arr_p_)
+  if (stems_)
     junk_beam ();
 }
 
@@ -340,28 +407,38 @@ Auto_beam_engraver::finalize ()
 void
 Auto_beam_engraver::acknowledge_grob (Grob_info info)
 {
-  if (stem_l_arr_p_)
+  /*
+    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())
     {
-      if (Beam::has_interface (info.grob_l_))
+      consider_end (shortest_mom_);
+      junk_beam ();
+    }
+  
+  if (stems_)
+    {
+      if (Beam::has_interface (info.grob_))
        {
          end_beam ();
        }
-      else if (Bar::has_interface (info.grob_l_))
+      else if (Bar_line::has_interface (info.grob_))
        {
          end_beam ();
        }
-      else if (Rest::has_interface (info.grob_l_))
+      else if (Rest::has_interface (info.grob_))
        {
          end_beam ();
        }
     }
   
-  if (Stem::has_interface (info.grob_l_))
+  if (Stem::has_interface (info.grob_))
     {
-      Item* stem_l = dynamic_cast<Item *> (info.grob_l_);
-                                      
-      Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.music_cause ());
-      if (!rhythmic_req)
+      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;
@@ -370,25 +447,25 @@ Auto_beam_engraver::acknowledge_grob (Grob_info info)
       /*
        Don't (start) auto-beam over empty stems; skips or rests
        */
-      if (!Stem::heads_i (stem_l))
+      if (!Stem::head_count (stem))
        {
-         if (stem_l_arr_p_)
+         if (stems_)
            end_beam ();
          return;
        }
 
-      if (Stem::beam_l (stem_l))
+      if (Stem::get_beam (stem))
        {
-         if (stem_l_arr_p_)
+         if (stems_)
            junk_beam ();
          return ;
        }
              
-      int durlog  = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->duration_log ();
+      int durlog  = unsmob_duration (m->get_property ("duration"))->duration_log ();
       
       if (durlog <= 2)
        {
-         if (stem_l_arr_p_)
+         if (stems_)
            end_beam ();
          return;
        }
@@ -401,7 +478,7 @@ Auto_beam_engraver::acknowledge_grob (Grob_info info)
        return ;
        
       
-      Moment dur = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->length_mom ();
+      Moment dur = unsmob_duration (m->get_property ("duration"))->get_length ();
       /* FIXME:
 
        This comment has been here since long:
@@ -428,30 +505,30 @@ Auto_beam_engraver::acknowledge_grob (Grob_info info)
       consider_begin (shortest_mom_);
 #endif
 
-      if (!stem_l_arr_p_)
+      if (!stems_)
        return;
       
       Moment now = now_mom ();
       
-      grouping_p_->add_stem (now - beam_start_moment_ + beam_start_location_,
+      grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
                             durlog - 2);
-      stem_l_arr_p_->push (stem_l);
+      stems_->push (stem);
       last_add_mom_ = now;
-      extend_mom_ = (extend_mom_ >? now) + rhythmic_req->length_mom ();
+      extend_mom_ = (extend_mom_ >? now) + m->get_length ();
     }
 }
 
 void
-Auto_beam_engraver::create_grobs ()
+Auto_beam_engraver::process_acknowledged_grobs ()
 {
-  if (!count_i_)
+  if (!count_)
     {
       consider_end (shortest_mom_);
       consider_begin (shortest_mom_);
     }
-  else if (count_i_ > 1)
+  else if (count_ > 1)
     {
-      if (stem_l_arr_p_)
+      if (stems_)
        {
          Moment now = now_mom ();
          if ((extend_mom_ < now)
@@ -459,27 +536,25 @@ Auto_beam_engraver::create_grobs ()
            {
              end_beam ();
            }
-         else if (!stem_l_arr_p_->size ())
+         else if (!stems_->size ())
            {
              junk_beam ();
            }
        }    
     }
-
-  /*
-    count_i_++ -> 
-
-        auto-beam-engraver.cc:459: warning: value computed is not used (gcc: 2.96) */
-  count_i_ = count_i_ + 1;
+  
+  count_ ++;
 }
-ENTER_DESCRIPTION(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 stemLeftBeamCount and
-stemRightBeamCount.
-",
+
+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",
-/* acks  */       "stem-interface rest-interface beam-interface bar-line-interface",
-/* reads */       "noAutoBeaming autoBeamSettings subdivideBeams",
+/* accepts */     "beam-forbid-event",
+/* acks  */      "stem-interface rest-interface beam-interface bar-line-interface",
+/* reads */       "autoBeaming autoBeamSettings beatLength subdivideBeams",
 /* write */       "");