]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/auto-beam-engraver.cc
release: 1.5.4
[lilypond.git] / lily / auto-beam-engraver.cc
index 2b753524355b15c24cd883d0b44ad93bc4beea3f..781f03393fdf7df09676a2d4d9edf658ce6fd66e 100644 (file)
@@ -1,12 +1,12 @@
-
 /*   
   auto-beam-engraver.cc --  implement Auto_beam_engraver
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1999--2000 Jan Nieuwenhuizen <janneke@gnu.org>
+  (c) 1999--2001 Jan Nieuwenhuizen <janneke@gnu.org>
   
  */
+
 #include "beaming.hh"
 #include "musical-request.hh"
 #include "beam.hh"
 #include "item.hh"
 #include "spanner.hh"
 
+/*
+  TODO: figure what to do in grace?
+
+  TODO: documentme.
+ */
 class Auto_beam_engraver : public Engraver
 {
 public:
@@ -26,27 +31,36 @@ public:
   VIRTUAL_COPY_CONS (Translator);
 
 protected:
-  virtual bool do_try_music (Music*);
-  virtual void do_pre_move_processing ();
-  virtual void do_post_move_processing ();
-  virtual void do_removal_processing ();
-  virtual void acknowledge_element (Score_element_info);
-  virtual void do_process_music ();
-  virtual void process_acknowledged ();
+  virtual void stop_translation_timestep ();
+  virtual void start_translation_timestep ();
+  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 (Score_element* e);
+  bool same_grace_state_b (Grob* e);
   void typeset_beam ();
 
+  /*
+    shortest_mom is the shortest note in the beam.
+   */
   Moment shortest_mom_;
   Spanner *finished_beam_p_;
   Link_array<Item>* stem_l_arr_p_;
-  
+
+
+  int count_i_;
   Moment last_add_mom_;
+  /*
+    Projected ending of the  beam we're working on.
+   */
   Moment extend_mom_;
   Moment beam_start_moment_;
   Moment beam_start_location_;
@@ -56,18 +70,11 @@ private:
   Beaming_info_list*finished_grouping_p_;
 };
 
-
-
-
 ADD_THIS_TRANSLATOR (Auto_beam_engraver);
 
-
-/*
-  TODO: remove all references to Timing_engraver; should read properties.
-  
- */
 Auto_beam_engraver::Auto_beam_engraver ()
 {
+  count_i_ = 0;
   stem_l_arr_p_ = 0;
   shortest_mom_ = Moment (1, 8);
   finished_beam_p_ = 0;
@@ -75,173 +82,147 @@ Auto_beam_engraver::Auto_beam_engraver ()
   grouping_p_ = 0;
 }
 
-
+/*
+  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::do_try_music (Music*) 
-{
-  return false;
-} 
-
-void
-Auto_beam_engraver::do_process_music ()
+Auto_beam_engraver::test_moment (Direction dir, Moment test_mom)
 {
-  consider_end_and_begin (shortest_mom_);
-}
+  SCM wild = gh_list (ly_symbol2scm ("*"), ly_symbol2scm ("*"), SCM_UNDEFINED);
+  SCM function;
+  if (dir == START)
+    function = gh_list (ly_symbol2scm ("begin"), SCM_UNDEFINED);
+  else
+    function = gh_list (ly_symbol2scm ("end"), SCM_UNDEFINED);
 
-void
-Auto_beam_engraver::consider_end_and_begin (Moment test_mom)
-{
-  Moment one_beat = *unsmob_moment( get_property ("beatLength"));
+  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);
 
-  int num = *unsmob_moment (get_property("measureLength")) / one_beat;
-  int den = one_beat.den_i ();
+  SCM type = gh_list (gh_int2scm (test_mom.num ()),
+                     gh_int2scm (test_mom.den ()), SCM_UNDEFINED);
 
+  SCM settings = get_property ("autoBeamSettings");
   
-  String time_str = String ("time") + to_str (num) + "_" + to_str (den);
-
-  String type_str;
-  if (test_mom.num () != 1)
-    type_str = to_str (test_mom.num ());
-  if (test_mom.den () != 1)
-    type_str = type_str + "_" + to_str (test_mom.den ());
-
-  /*
-    URG
-    
-    FIXME: SHOULD USE ALIST
-    
-   */
-
-  /*
-    Determine end moment for auto beaming (and begin, mostly 0==anywhere) 
-    In order of increasing priority:
-
-    i.   every beat <den>
-    ii.  time<num>_<den>beamAutoEnd
-    iii. time<num>_<den>beamAutoEnd<type>
-    iv.  beamAutoEnd
-    v.   beamAutoEnd<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
-
-    The user overrides should be required for common cases.
-   */
+  /* 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 = get_property ((time_str + "beamAutoBegin").ch_C());
-  if (unsmob_moment (begin))
-    begin_mom = * unsmob_moment (begin);
-
-  SCM end = get_property ((time_str + "beamAutoEnd").ch_C());
-  if (unsmob_moment (end))
-    end_mom = * unsmob_moment (end);
-
-  /*
-    third guess: property time exception, specific for duration type
-  */
-  if (type_str.length_i ())
+  /* begin beam at any position
+ (and fallback for end) */
+  Moment moment (0);
+  
+  /* end beam at end of beat */
+  if (dir == STOP)
     {
-      SCM end_mult = get_property ((time_str + "beamAutoEnd" + type_str).ch_C());
-      if (unsmob_moment (end_mult))
-       end_mom = * unsmob_moment (end_mult);
-
-      SCM begin_mult = get_property ((time_str + "beamAutoBegin" + type_str).ch_C());
-      if (unsmob_moment (begin_mult))
-       begin_mom = * unsmob_moment (begin_mult);
+      SCM beat (get_property ("beatLength"));
+      
+      if (unsmob_moment (beat))
+       moment = *unsmob_moment (beat);
     }
 
-  /*
-    fourth guess [user override]: property plain generic
-  */
-  begin = get_property ("beamAutoBegin");
-  if (unsmob_moment (begin))
-    begin_mom = * unsmob_moment (begin);
-
-
+  /* second guess: property generic time exception */
+  SCM m = gh_assoc (gh_append3 (function, wild, time), settings);
   
-  end = get_property ("beamAutoEnd");
-  if (unsmob_moment (end))
-    end_mom = * unsmob_moment (end);
-
-  /*
-    fifth guess [user override]: property plain, specific for duration type
-  */
-  if (type_str.length_i ())
+  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));
+  
+  Rational r;
+  if (moment)
     {
-      SCM end_mult = get_property ((String ("beamAutoEnd") + type_str).ch_C());
-      if (unsmob_moment (end_mult))
-       end_mom = * unsmob_moment (end_mult);
-
-      SCM begin_mult = get_property ((String ("beamAutoBegin") + type_str).ch_C());
-      if (unsmob_moment (begin_mult))
-       begin_mom = * unsmob_moment (begin_mult);
+      /* 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_);
     }
-
-  Rational r;
-  if (end_mom)
-    r = unsmob_moment (get_property ("measurePosition"))->mod_rat (end_mom);
   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_ && !r)
-    end_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_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 ();
+    }
 }
 
-      
 void
-Auto_beam_engraver::begin_beam ()
+Auto_beam_engraver::consider_end (Moment test_mom)
 {
-  assert (!stem_l_arr_p_);
-  stem_l_arr_p_ = new Link_array<Item>;
-  assert (!grouping_p_);
-  grouping_p_ = new Beaming_info_list;
-  beam_start_moment_ = now_mom ();
-  beam_start_location_ = *unsmob_moment (get_property ("measurePosition"));
+  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 ()
 {
-  Spanner* beam_p = new Spanner (get_property ("basicBeamProperties"));
-  Beam::set_interface (beam_p);
-
+  if (to_boolean (get_property ("skipTypesetting")))
+    {
+     return 0;
+    }
+  
+  Spanner* beam_p = new Spanner (get_property ("Beam"));
   for (int i = 0; i < stem_l_arr_p_->size (); i++)
     {
       /*
@@ -249,16 +230,44 @@ Auto_beam_engraver::create_beam_p ()
        */
       if (Stem::beam_l ((*stem_l_arr_p_)[i]))
        {
+         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_element (beam_p, 0);
+  announce_grob (beam_p, 0);
 
   return beam_p;
 }
 
+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;
+  beam_start_moment_ = now_mom ();
+  beam_start_location_ = *unsmob_moment (get_property ("measurePosition"));
+
+
+}
+
+
+void
+Auto_beam_engraver::junk_beam () 
+{
+  assert (stem_l_arr_p_);
+  
+  delete stem_l_arr_p_;
+  stem_l_arr_p_ = 0;
+  delete grouping_p_;
+  grouping_p_ = 0;
+
+  shortest_mom_ = Moment (1, 8);
+}
+
 void
 Auto_beam_engraver::end_beam ()
 {
@@ -267,6 +276,7 @@ Auto_beam_engraver::end_beam ()
       junk_beam ();
     }
   else
+    
     {
       finished_beam_p_ = create_beam_p ();
       if (finished_beam_p_)
@@ -274,10 +284,11 @@ 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
 Auto_beam_engraver::typeset_beam ()
 {
@@ -285,7 +296,7 @@ Auto_beam_engraver::typeset_beam ()
     {
       finished_grouping_p_->beamify ();
       Beam::set_beaming (finished_beam_p_, finished_grouping_p_);
-      typeset_element (finished_beam_p_);
+      typeset_grob (finished_beam_p_);
       finished_beam_p_ = 0;
     
       delete finished_grouping_p_;
@@ -294,8 +305,9 @@ Auto_beam_engraver::typeset_beam ()
 }
 
 void
-Auto_beam_engraver::do_post_move_processing ()
+Auto_beam_engraver::start_translation_timestep ()
 {
+  count_i_ = 0;
   /*
     don't beam over skips
    */
@@ -310,13 +322,14 @@ Auto_beam_engraver::do_post_move_processing ()
 }
 
 void
-Auto_beam_engraver::do_pre_move_processing ()
+Auto_beam_engraver::stop_translation_timestep ()
 {
+  
   typeset_beam ();
 }
 
 void
-Auto_beam_engraver::do_removal_processing ()
+Auto_beam_engraver::finalize ()
 {
   /* finished beams may be typeset */
   typeset_beam ();
@@ -325,20 +338,10 @@ Auto_beam_engraver::do_removal_processing ()
     junk_beam ();
 }
 
-bool
-Auto_beam_engraver::same_grace_state_b (Score_element* e)
-{
-  bool gr = e->get_elt_property ("grace") == SCM_BOOL_T;
-  SCM wg =get_property ("weAreGraceContext");
-  return (to_boolean (wg)) == gr;
-}
 
 void
-Auto_beam_engraver::acknowledge_element (Score_element_info info)
+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_))
@@ -383,7 +386,8 @@ Auto_beam_engraver::acknowledge_element (Score_element_info info)
          return ;
        }
              
-      int durlog  =rhythmic_req->duration_.durlog_i_;
+      int durlog  = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->duration_log ();
+      
       if (durlog <= 2)
        {
          if (stem_l_arr_p_)
@@ -391,62 +395,82 @@ Auto_beam_engraver::acknowledge_element (Score_element_info info)
          return;
        }
 
+
       /*
-       if shortest duration would change
-       reconsider ending/starting beam first.
-      */
-      Moment mom = rhythmic_req->duration_.length_mom ();
-      consider_end_and_begin (mom);
-      if (!stem_l_arr_p_)
-       return;
-      if (mom < shortest_mom_)
+       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_)
        {
-         if (stem_l_arr_p_->size ())
-           {
-             shortest_mom_ = mom;
-             consider_end_and_begin (shortest_mom_);
-             if (!stem_l_arr_p_)
-               return;
-           }
-         shortest_mom_ = mom;
+         shortest_mom_ = dur;
+         consider_end (shortest_mom_);
        }
+      consider_begin (shortest_mom_);
+#endif
+
+      if (!stem_l_arr_p_)
+       return;
+      
       Moment now = now_mom ();
       
       grouping_p_->add_stem (now - beam_start_moment_ + beam_start_location_,
                             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::junk_beam () 
+Auto_beam_engraver::create_grobs ()
 {
-  assert (stem_l_arr_p_);
-  
-  delete stem_l_arr_p_;
-  stem_l_arr_p_ = 0;
-  delete grouping_p_;
-  grouping_p_ = 0;
-  shortest_mom_ = Moment (1, 8);
-}
-
-void
-Auto_beam_engraver::process_acknowledged ()
-{
-  if (stem_l_arr_p_)
+  if (!count_i_)
     {
-      Moment now = now_mom ();
-      if ((extend_mom_ < now)
-         || ((extend_mom_ == now) && (last_add_mom_ != now )))
-       {
-         end_beam ();
-       }
-      else if (!stem_l_arr_p_->size ())
+      consider_end (shortest_mom_);
+      consider_begin (shortest_mom_);
+    }
+  else if (count_i_ > 1)
+    {
+      if (stem_l_arr_p_)
        {
-         junk_beam ();
-       }
+         Moment now = now_mom ();
+         if ((extend_mom_ < now)
+             || ((extend_mom_ == now) && (last_add_mom_ != now)))
+           {
+             end_beam ();
+           }
+         else if (!stem_l_arr_p_->size ())
+           {
+             junk_beam ();
+           }
+       }    
     }
-}
 
+  /*
+    count_i_++ -> 
+
+        auto-beam-engraver.cc:459: warning: value computed is not used (gcc: 2.96) */
+  count_i_ = count_i_ + 1;
+}