]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/auto-beam-engraver.cc
release: 1.5.4
[lilypond.git] / lily / auto-beam-engraver.cc
index ff73ee4c72fad2fa42e5f81d045a80b3463b790f..781f03393fdf7df09676a2d4d9edf658ce6fd66e 100644 (file)
@@ -3,7 +3,7 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1999--2000 Jan Nieuwenhuizen <janneke@gnu.org>
+  (c) 1999--2001 Jan Nieuwenhuizen <janneke@gnu.org>
   
  */
 
@@ -33,14 +33,16 @@ public:
 protected:
   virtual void stop_translation_timestep ();
   virtual void start_translation_timestep ();
-  virtual void do_removal_processing ();
+  virtual void finalize ();
   virtual void acknowledge_grob (Grob_info);
   virtual void create_grobs ();
 
 private:
-  void begin_beam ();
-  void consider_end_and_begin (Moment test_mom);
+  bool test_moment (Direction, Moment);
+  void consider_begin (Moment);
+  void consider_end (Moment);
   Spanner* create_beam_p ();
+  void begin_beam ();
   void end_beam ();
   void junk_beam ();
   bool same_grace_state_b (Grob* e);
@@ -54,9 +56,8 @@ private:
   Link_array<Item>* stem_l_arr_p_;
 
 
-  bool first_b_;
+  int count_i_;
   Moment last_add_mom_;
-
   /*
     Projected ending of the  beam we're working on.
    */
@@ -73,7 +74,7 @@ ADD_THIS_TRANSLATOR (Auto_beam_engraver);
 
 Auto_beam_engraver::Auto_beam_engraver ()
 {
-  first_b_ = true;
+  count_i_ = 0;
   stem_l_arr_p_ = 0;
   shortest_mom_ = Moment (1, 8);
   finished_beam_p_ = 0;
@@ -82,137 +83,146 @@ Auto_beam_engraver::Auto_beam_engraver ()
 }
 
 /*
-  rename me: consider_end_or_begin () ? 
- */
-void
-Auto_beam_engraver::consider_end_and_begin (Moment test_mom)
+  Determine end moment for auto beaming (or begin moment, but mostly
+  0==anywhere) In order of increasing priority:
+  
+  i.   begin anywhere, end at every beat
+  ii.  end   *    <num> <den>
+  iii. end <type> <num> <den>
+  
+  iv.  end   *      *     *
+  v.   end <type>   *     *
+  
+  
+  Rationale:
+  
+  [to be defined in config file]
+  i.   easy catch-all rule
+  ii.  exceptions for time signature
+  iii. exceptions for time signature, for specific duration type
+  
+  [user override]
+  iv.  generic override
+  v.   override for specific duration type
+  
+*/
+bool
+Auto_beam_engraver::test_moment (Direction dir, Moment test_mom)
 {
   SCM wild = gh_list (ly_symbol2scm ("*"), ly_symbol2scm ("*"), SCM_UNDEFINED);
-  SCM b = gh_list (ly_symbol2scm ("begin"), SCM_UNDEFINED);
-  SCM e = gh_list (ly_symbol2scm ("end"), SCM_UNDEFINED);
+  SCM function;
+  if (dir == START)
+    function = gh_list (ly_symbol2scm ("begin"), SCM_UNDEFINED);
+  else
+    function = gh_list (ly_symbol2scm ("end"), SCM_UNDEFINED);
 
-  Moment one_beat = *unsmob_momentget_property ("beatLength"));
-  int num = *unsmob_moment (get_property("measureLength")) / one_beat;
-  int den = one_beat.den_i ();
+  Moment one_beat = *unsmob_moment (get_property ("beatLength"));
+  int num = *unsmob_moment (get_property ("measureLength")) / one_beat;
+  int den = one_beat.den ();
   SCM time = gh_list (gh_int2scm (num), gh_int2scm (den), SCM_UNDEFINED);
 
-  SCM type = gh_list (gh_int2scm (test_mom.num_i ()),
-                     gh_int2scm (test_mom.den_i ()), SCM_UNDEFINED);
+  SCM type = gh_list (gh_int2scm (test_mom.num ()),
+                     gh_int2scm (test_mom.den ()), SCM_UNDEFINED);
 
   SCM settings = get_property ("autoBeamSettings");
   
-  /*
-    Determine end moment for auto beaming (and begin, mostly 0==anywhere) 
-    In order of increasing priority:
-
-    i.   every beat
-    ii.  end   *    <num> <den>
-    iii. end <type> <num> <den>
-
-    iv.  end   *      *     *
-    v.   end <type>   *     *
-
-
-    Rationale:
-
-    [to be defined in config file]
-    i.   easy catch-all rule
-    ii.  exceptions for time signature
-    iii. exceptions for time signature, for specific duration type
-
-    [user override]
-    iv.  generic override
-    v.   override for specific duration type
-
-  */
+  /* first guess */
   
-
-  /*
-    first guess: begin beam at any position
-  */
-  Moment begin_mom (0);
-  /*
-    first guess: end beam at end of beat
-  */
-  SCM one (get_property ("beatLength"));
-
-  Moment end_mom;
-  if (unsmob_moment (one))
-    end_mom = *unsmob_moment (one);
-
-  /*
-    second guess: property generic time exception
-  */
-  SCM begin = gh_assoc (gh_append3 (b, wild, time), settings);
+  /* begin beam at any position
+ (and fallback for end) */
+  Moment moment (0);
   
-  if (begin != SCM_BOOL_F && unsmob_moment (gh_cdr (begin)))
-    begin_mom = * unsmob_moment (gh_cdr (begin));
-
-  SCM end = gh_assoc (gh_append3 (e, wild, time), settings);
-  if (end != SCM_BOOL_F && unsmob_moment (gh_cdr (end)))
-    end_mom = * unsmob_moment (gh_cdr (end));
+  /* end beam at end of beat */
+  if (dir == STOP)
+    {
+      SCM beat (get_property ("beatLength"));
+      
+      if (unsmob_moment (beat))
+       moment = *unsmob_moment (beat);
+    }
 
-  /*
-    third guess: property time exception, specific for duration type
-  */
-  SCM begin_mult = gh_assoc (gh_append3 (b, type, time), settings);
-  if (begin_mult != SCM_BOOL_F && unsmob_moment (gh_cdr (begin_mult)))
-    begin_mom = * unsmob_moment (gh_cdr (begin_mult));
+  /* second guess: property generic time exception */
+  SCM m = gh_assoc (gh_append3 (function, wild, time), settings);
   
-  SCM end_mult = gh_assoc (gh_append3 (e, type, time), settings);
-  if (end_mult != SCM_BOOL_F && unsmob_moment (gh_cdr (end_mult)))
-    end_mom = * unsmob_moment (gh_cdr (end_mult));
-
-  /*
-    fourth guess [user override]: property plain generic
-  */
-  begin = gh_assoc (gh_append3 (b, wild, wild), settings);
-  if (begin != SCM_BOOL_F && unsmob_moment (gh_cdr (begin)))
-    begin_mom = * unsmob_moment (gh_cdr (begin));
-
-  end = gh_assoc (gh_append3 (e, wild, wild), settings);
-  if (end != SCM_BOOL_F && unsmob_moment (gh_cdr (end)))
-    end_mom = * unsmob_moment (gh_cdr (end));
-
-  /*
-    fifth guess [user override]: property plain, specific for duration type
-  */
-  begin_mult = gh_assoc (gh_append3 (b, type, wild), settings);
-  if (begin_mult != SCM_BOOL_F && unsmob_moment (gh_cdr (begin_mult)))
-    begin_mom = * unsmob_moment (gh_cdr (begin_mult));
+  if (m != SCM_BOOL_F && unsmob_moment (gh_cdr (m)))
+    moment = * unsmob_moment (gh_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 (gh_cdr (m)))
+    moment = * unsmob_moment (gh_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 (gh_cdr (m)))
+    moment = * unsmob_moment (gh_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 (gh_cdr (m)))
+    moment = * unsmob_moment (gh_cdr (m));
   
-  end_mult = gh_assoc (gh_append3 (e, type, wild), settings);
-  if (end_mult != SCM_BOOL_F && unsmob_moment (gh_cdr (end_mult)))
-    end_mom = * unsmob_moment (gh_cdr (end_mult));
-
   Rational r;
-  if (end_mom)
-    r = unsmob_moment (get_property ("measurePosition"))->mod_rat (end_mom);
+  if (moment)
+    {
+      /* Ugh? measurePosition can be negative, when \partial
+        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"));
+      if (pos < Moment (0))
+       {
+         Moment length = * unsmob_moment (get_property ("measureLength"));
+         pos = length - pos;
+       }
+      r = pos.main_part_.mod_rat (moment.main_part_);
+    }
   else
-    r = Moment (1);
+    {
+      if (dir == START)
+       /* if undefined, starting is ok */
+       r = 0;
+      else
+       /* but ending is not */
+       r = 1;
+    }
+  return !r;
+}
 
-  if (stem_l_arr_p_ && stem_l_arr_p_->size () > 1 && !r)
-    end_beam ();
+void
+Auto_beam_engraver::consider_begin (Moment test_mom)
+{
+  bool off = to_boolean (get_property ("noAutoBeaming"));
+  if (!stem_l_arr_p_ && ! off)
+    {
+      bool b = test_moment (START, test_mom);
+      if (b)
+       begin_beam ();
+    }
+}
 
-  /*
-    Allow already started autobeam to end
-   */
-  SCM on = get_property ("noAutoBeaming");
-  if (to_boolean (on))
-    return;
-
-  if (begin_mom)
-    r = unsmob_moment (get_property ("measurePosition"))->mod_rat (begin_mom);
-  if (!stem_l_arr_p_ && (!begin_mom || !r))
-    begin_beam ();
+void
+Auto_beam_engraver::consider_end (Moment test_mom)
+{
+  if (stem_l_arr_p_)
+    {
+      /* Allow already started autobeam to end:
+        don't check for noAutoBeaming */
+      bool b = test_moment (STOP, test_mom);
+      if (b)
+       end_beam ();
+    }
 }
-      
+
 Spanner*
 Auto_beam_engraver::create_beam_p ()
 {
+  if (to_boolean (get_property ("skipTypesetting")))
+    {
+     return 0;
+    }
+  
   Spanner* beam_p = new Spanner (get_property ("Beam"));
-  Beam::set_interface (beam_p);
-
   for (int i = 0; i < stem_l_arr_p_->size (); i++)
     {
       /*
@@ -220,10 +230,10 @@ Auto_beam_engraver::create_beam_p ()
        */
       if (Stem::beam_l ((*stem_l_arr_p_)[i]))
        {
-         scm_unprotect_object (beam_p->self_scm ());
+         scm_gc_unprotect_object (beam_p->self_scm ());
          return 0;
        }
-      Beam::add_stem (beam_p,(*stem_l_arr_p_)[i]);
+      Beam::add_stem (beam_p, (*stem_l_arr_p_)[i]);
     }
   
   announce_grob (beam_p, 0);
@@ -240,6 +250,8 @@ Auto_beam_engraver::begin_beam ()
   grouping_p_ = new Beaming_info_list;
   beam_start_moment_ = now_mom ();
   beam_start_location_ = *unsmob_moment (get_property ("measurePosition"));
+
+
 }
 
 
@@ -252,6 +264,7 @@ Auto_beam_engraver::junk_beam ()
   stem_l_arr_p_ = 0;
   delete grouping_p_;
   grouping_p_ = 0;
+
   shortest_mom_ = Moment (1, 8);
 }
 
@@ -263,6 +276,7 @@ Auto_beam_engraver::end_beam ()
       junk_beam ();
     }
   else
+    
     {
       finished_beam_p_ = create_beam_p ();
       if (finished_beam_p_)
@@ -270,8 +284,9 @@ Auto_beam_engraver::end_beam ()
       delete stem_l_arr_p_;
       stem_l_arr_p_ = 0;
       grouping_p_ = 0;
-      shortest_mom_ = Moment (1, 8);
     }
+
+  shortest_mom_ = Moment (1, 8);
 }
 
 void
@@ -292,7 +307,7 @@ Auto_beam_engraver::typeset_beam ()
 void
 Auto_beam_engraver::start_translation_timestep ()
 {
-  first_b_ =true;
+  count_i_ = 0;
   /*
     don't beam over skips
    */
@@ -314,7 +329,7 @@ Auto_beam_engraver::stop_translation_timestep ()
 }
 
 void
-Auto_beam_engraver::do_removal_processing ()
+Auto_beam_engraver::finalize ()
 {
   /* finished beams may be typeset */
   typeset_beam ();
@@ -323,20 +338,10 @@ Auto_beam_engraver::do_removal_processing ()
     junk_beam ();
 }
 
-bool
-Auto_beam_engraver::same_grace_state_b (Grob* e)
-{
-  bool gr = e->get_grob_property ("grace") == SCM_BOOL_T;
-  SCM wg =get_property ("weAreGraceContext");
-  return (to_boolean (wg)) == gr;
-}
 
 void
 Auto_beam_engraver::acknowledge_grob (Grob_info info)
 {
-  if (!same_grace_state_b (info.elem_l_))
-    return;
-  
   if (stem_l_arr_p_)
     {
       if (Beam::has_interface (info.elem_l_))
@@ -390,26 +395,43 @@ Auto_beam_engraver::acknowledge_grob (Grob_info info)
          return;
        }
 
+
       /*
-       if shortest duration would change
-       reconsider ending/starting beam first.
-      */
-      Moment dur = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->length_mom ();
-      consider_end_and_begin (dur);
-      if (!stem_l_arr_p_)
-       return;
+       ignore grace notes.
+       */
+      if (bool (beam_start_location_.grace_part_) != bool (now_mom ().grace_part_))
+       return ;
+       
       
+      Moment dur = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->length_mom ();
+      /* FIXME:
+
+       This comment has been here since long:
+
+          if shortest duration would change
+           consider ending and beginning beam first. 
+
+       but the code didn't match: */
+#if 1
+      consider_end (dur);
+      consider_begin (dur);
+
+      if (dur < shortest_mom_)
+       shortest_mom_ = dur;
+#else
+      /* I very much suspect that we wanted: */
+
+      consider_end (shortest_mom_);
       if (dur < shortest_mom_)
        {
          shortest_mom_ = dur;
-         if (stem_l_arr_p_->size ())
-           {
-             shortest_mom_ = dur;
-             consider_end_and_begin (shortest_mom_);
-             if (!stem_l_arr_p_)
-               return;
-           }
+         consider_end (shortest_mom_);
        }
+      consider_begin (shortest_mom_);
+#endif
+
+      if (!stem_l_arr_p_)
+       return;
       
       Moment now = now_mom ();
       
@@ -417,25 +439,25 @@ Auto_beam_engraver::acknowledge_grob (Grob_info info)
                             durlog - 2);
       stem_l_arr_p_->push (stem_l);
       last_add_mom_ = now;
-      extend_mom_ = extend_mom_ >? now + rhythmic_req->length_mom ();
+      extend_mom_ = (extend_mom_ >? now) + rhythmic_req->length_mom ();
     }
 }
 
 void
 Auto_beam_engraver::create_grobs ()
 {
-  if (first_b_)
+  if (!count_i_)
     {
-      first_b_ = false;
-      consider_end_and_begin (shortest_mom_);
+      consider_end (shortest_mom_);
+      consider_begin (shortest_mom_);
     }
-  else
+  else if (count_i_ > 1)
     {
       if (stem_l_arr_p_)
        {
          Moment now = now_mom ();
          if ((extend_mom_ < now)
-             || ((extend_mom_ == now) && (last_add_mom_ != now )))
+             || ((extend_mom_ == now) && (last_add_mom_ != now)))
            {
              end_beam ();
            }
@@ -444,5 +466,11 @@ Auto_beam_engraver::create_grobs ()
              junk_beam ();
            }
        }    
-    }  
+    }
+
+  /*
+    count_i_++ -> 
+
+        auto-beam-engraver.cc:459: warning: value computed is not used (gcc: 2.96) */
+  count_i_ = count_i_ + 1;
 }