]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/auto-beam-engraver.cc
Doc-es: various updates.
[lilypond.git] / lily / auto-beam-engraver.cc
index 0d5fa60ed2444cb8d5e9061fc3613c32613f4794..2c61f00959b3283568bf6550508949f688555f60 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1999--2011 Jan Nieuwenhuizen <janneke@gnu.org>
+  Copyright (C) 1999--2015 Jan Nieuwenhuizen <janneke@gnu.org>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#include "bar-line.hh"
 #include "beaming-pattern.hh"
 #include "beam.hh"
 #include "context.hh"
+#include "context-handle.hh"
 #include "duration.hh"
 #include "engraver.hh"
+#include "grob-properties.hh"
 #include "item.hh"
 #include "rest.hh"
 #include "spanner.hh"
@@ -38,28 +39,28 @@ class Auto_beam_engraver : public Engraver
 
 protected:
   void stop_translation_timestep ();
-  void process_music ();
+  void process_acknowledged ();
+
+  virtual void process_music ();
   virtual void finalize ();
   virtual void derived_mark () const;
 
-  DECLARE_ACKNOWLEDGER (rest);
-  DECLARE_ACKNOWLEDGER (beam);
-  DECLARE_ACKNOWLEDGER (bar_line);
-  DECLARE_ACKNOWLEDGER (breathing_sign);
-  DECLARE_ACKNOWLEDGER (stem);
-  DECLARE_TRANSLATOR_LISTENER (beam_forbid);
-
-  void process_acknowledged ();
+  void acknowledge_rest (Grob_info);
+  void acknowledge_beam (Grob_info);
+  void acknowledge_bar_line (Grob_info);
+  void acknowledge_breathing_sign (Grob_info);
+  void acknowledge_stem (Grob_info);
+  void listen_beam_forbid (Stream_event *);
 
 private:
-  bool test_moment (Direction, Moment, Moment);
+  virtual bool test_moment (Direction, Moment, Moment);
   void consider_begin (Moment, Moment);
   void consider_end (Moment, Moment);
   Spanner *create_beam ();
   void begin_beam ();
   void end_beam ();
   void junk_beam ();
-  bool is_same_grace_state (Grob *e);
+  virtual bool is_same_grace_state (Moment, Moment);
   void recheck_beam ();
   void typeset_beam ();
   vector<Item *> *remove_end_stems (vsize);
@@ -80,7 +81,10 @@ private:
   Moment extend_mom_;
   Moment beam_start_moment_;
   Moment beam_start_location_;
-  Context *beam_start_context_;
+  /*
+    Handle on the starting staff keeps it alive until beam is comlete
+  */
+  Context_handle beam_start_context_;
 
   // We act as if beam were created, and start a grouping anyway.
   Beaming_pattern *grouping_;
@@ -88,11 +92,9 @@ private:
 
   Beaming_pattern *finished_grouping_;
 
-
   Beaming_options beaming_options_;
   Beaming_options finished_beaming_options_;
 
-
   void check_bar_property ();
 };
 
@@ -127,7 +129,7 @@ Auto_beam_engraver::process_music ()
   if (stems_)
     {
       if (extend_mom_ < now)
-       end_beam ();
+        end_beam ();
     }
 
   if (scm_is_string (get_property ("whichBar")))
@@ -139,25 +141,26 @@ Auto_beam_engraver::process_music ()
   if (forbid_)
     {
       if (stems_)
-       end_beam ();
+        end_beam ();
       else
-       junk_beam ();
+        junk_beam ();
     }
 }
 
-Auto_beam_engraver::Auto_beam_engraver ()
+Auto_beam_engraver::Auto_beam_engraver (Context *c)
+  : Engraver (c)
 {
   forbid_ = 0;
   process_acknowledged_count_ = 0;
   stems_ = 0;
   shortest_mom_ = Moment (Rational (1, 4));
+  extend_mom_ = Moment (-1);
   finished_beam_ = 0;
   finished_grouping_ = 0;
   grouping_ = 0;
   beam_settings_ = SCM_EOL;
 }
 
-IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid);
 void
 Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
 {
@@ -167,12 +170,11 @@ Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
 bool
 Auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment dur)
 {
-  return scm_call_4 (get_property ("autoBeamCheck"),
-                    context ()->self_scm (),
-                    scm_from_int (dir),
-                     test_mom.smobbed_copy (),
-                    dur.smobbed_copy ())
-    != SCM_BOOL_F;
+  return scm_is_true (scm_call_4 (get_property ("autoBeamCheck"),
+                                    context ()->self_scm (),
+                                    scm_from_int (dir),
+                                    test_mom.smobbed_copy (),
+                                    dur.smobbed_copy ()));
 }
 
 void
@@ -184,7 +186,7 @@ Auto_beam_engraver::consider_begin (Moment test_mom, Moment dur)
     {
       bool b = test_moment (START, test_mom, dur);
       if (b)
-       begin_beam ();
+        begin_beam ();
     }
 }
 
@@ -194,10 +196,10 @@ Auto_beam_engraver::consider_end (Moment test_mom, Moment dur)
   if (stems_)
     {
       /* Allow already started autobeam to end:
-        don't check for autoBeaming */
+         don't check for autoBeaming */
       bool b = test_moment (STOP, test_mom, dur);
       if (b)
-       end_beam ();
+        end_beam ();
     }
 }
 
@@ -221,8 +223,7 @@ Auto_beam_engraver::create_beam ()
     Beam::add_stem (beam, (*stems_)[i]);
 
   Grob_info i = make_grob_info (beam, (*stems_)[0]->self_scm ());
-  i.rerouting_daddy_context_ = beam_start_context_;
-  announce_grob (i);
+  announce_grob (i, beam_start_context_.get_context ());
 
   return beam;
 }
@@ -239,9 +240,9 @@ Auto_beam_engraver::begin_beam ()
   stems_ = new vector<Item *>;
   grouping_ = new Beaming_pattern ();
   beaming_options_.from_context (context ());
-  beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
+  beam_settings_ = Grob_property_info (context (), ly_symbol2scm ("Beam")).updated ();
 
-  beam_start_context_ = context ()->get_parent_context ();
+  beam_start_context_.set_context (context ()->get_parent_context ());
   beam_start_moment_ = now_mom ();
   beam_start_location_
     = robust_scm2moment (get_property ("measurePosition"), Moment (0));
@@ -262,6 +263,13 @@ Auto_beam_engraver::junk_beam ()
   shortest_mom_ = Moment (Rational (1, 4));
 }
 
+bool
+Auto_beam_engraver::is_same_grace_state (Moment start, Moment now)
+{
+  return bool (start.grace_part_) == bool (now.grace_part_);
+}
+
+
 void
 Auto_beam_engraver::end_beam ()
 {
@@ -272,20 +280,20 @@ Auto_beam_engraver::end_beam ()
       finished_beam_ = create_beam ();
 
       if (finished_beam_)
-       {
-         Grob_info i = make_grob_info (finished_beam_, SCM_EOL);
-         i.rerouting_daddy_context_ = beam_start_context_;
-
-         announce_end_grob (i);
-         finished_grouping_ = grouping_;
-         finished_beaming_options_ = beaming_options_;
-       }
+        {
+          Grob_info i = make_grob_info (finished_beam_, SCM_EOL);
+
+          announce_end_grob (i, beam_start_context_.get_context ());
+          finished_grouping_ = grouping_;
+          finished_beaming_options_ = beaming_options_;
+        }
       delete stems_;
       stems_ = 0;
       grouping_ = 0;
       beam_settings_ = SCM_EOL;
     }
 
+  beam_start_context_.set_context (NULL);
   shortest_mom_ = Moment (Rational (1, 4));
 }
 
@@ -295,7 +303,7 @@ Auto_beam_engraver::typeset_beam ()
   if (finished_beam_)
     {
       if (!finished_beam_->get_bound (RIGHT))
-       finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
+        finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
 
       finished_grouping_->beamify (finished_beaming_options_);
       Beam::set_beaming (finished_beam_, finished_grouping_);
@@ -324,7 +332,6 @@ Auto_beam_engraver::finalize ()
     junk_beam ();
 }
 
-
 void
 Auto_beam_engraver::acknowledge_beam (Grob_info /* info */)
 {
@@ -375,42 +382,45 @@ Auto_beam_engraver::acknowledge_stem (Grob_info info)
   if (!Stem::head_count (stem))
     {
       if (stems_)
-       end_beam ();
+        end_beam ();
       return;
     }
 
   if (Stem::get_beam (stem))
     {
       if (stems_)
-       junk_beam ();
+        junk_beam ();
       return;
     }
 
-  int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
+  int durlog = unsmob<Duration> (ev->get_property ("duration"))->duration_log ();
 
   if (durlog <= 2)
     {
       if (stems_)
-       end_beam ();
+        end_beam ();
       return;
     }
 
   /*
-    ignore grace notes.
+    ignore interspersed grace notes.
   */
   Moment now = now_mom ();
-  if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_))
+  if (!is_same_grace_state (beam_start_location_, now))
     return;
 
-  Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length ();
+  Duration *stem_duration = unsmob<Duration> (ev->get_property ("duration"));
+  Moment dur = stem_duration->get_length ();
+
+  //Moment dur = unsmob<Duration> (ev->get_property ("duration"))->get_length ();
   Moment measure_now = measure_position (context ());
   bool recheck_needed = false;
 
   if (dur < shortest_mom_)
     {
-    /* new shortest moment, so store it and set recheck_needed */
-    shortest_mom_ = dur;
-    recheck_needed = true;
+      /* new shortest moment, so store it and set recheck_needed */
+      shortest_mom_ = dur;
+      recheck_needed = true;
     }
 
   /* end should be based on shortest_mom_, begin should be
@@ -422,8 +432,10 @@ Auto_beam_engraver::acknowledge_stem (Grob_info info)
     return;
 
   grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
-                      durlog - 2,
-                      Stem::is_invisible (stem));
+                       durlog - 2,
+                       Stem::is_invisible (stem),
+                       stem_duration->factor (),
+                       (to_boolean (stem->get_property ("tuplet-start"))));
   stems_->push_back (stem);
   last_add_mom_ = now;
   extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now);
@@ -447,7 +459,6 @@ Auto_beam_engraver::recheck_beam ()
 
   bool found_end;
 
-
   for (vsize i = 0; i < stems_->size () - 1;)
     {
       found_end = test_moment (STOP,
@@ -506,7 +517,7 @@ Auto_beam_engraver::remove_end_stems (vsize split_index)
 void
 Auto_beam_engraver::process_acknowledged ()
 {
-  Moment now = now_mom();
+  Moment now = now_mom ();
   if (extend_mom_ > now)
     return;
 
@@ -518,23 +529,29 @@ Auto_beam_engraver::process_acknowledged ()
   else if (process_acknowledged_count_ > 1)
     {
       if (stems_)
-       {
-         if ((extend_mom_ < now)
-             || ((extend_mom_ == now) && (last_add_mom_ != now)))
-           end_beam ();
-         else if (!stems_->size ())
-           junk_beam ();
-       }
+        {
+          if ((extend_mom_ < now)
+              || ((extend_mom_ == now) && (last_add_mom_ != now)))
+            end_beam ();
+          else if (!stems_->size ())
+            junk_beam ();
+        }
     }
 
   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, breathing_sign);
-ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
+void
+Auto_beam_engraver::boot ()
+{
+  ADD_LISTENER (Auto_beam_engraver, beam_forbid);
+  ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
+  ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
+  ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
+  ADD_ACKNOWLEDGER (Auto_beam_engraver, breathing_sign);
+  ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
+}
+
 ADD_TRANSLATOR (Auto_beam_engraver,
                 /* doc */
                 "Generate beams based on measure characteristics and observed"
@@ -552,9 +569,98 @@ ADD_TRANSLATOR (Auto_beam_engraver,
                 "autoBeaming "
                 "baseMoment "
                 "beamExceptions "
+                "beamHalfMeasure "
                 "beatStructure "
                 "subdivideBeams ",
 
                 /* write */
                 ""
-                );
+               );
+
+class Grace_auto_beam_engraver : public Auto_beam_engraver
+{
+  TRANSLATOR_DECLARATIONS (Grace_auto_beam_engraver);
+  TRANSLATOR_INHERIT (Auto_beam_engraver);
+
+private:
+  Moment last_grace_start_; // Full starting time of last grace group
+  Moment last_grace_position_; // Measure position of same
+  virtual void process_music ();
+  virtual bool is_same_grace_state (Moment, Moment);
+  virtual bool test_moment (Direction, Moment, Moment);
+};
+
+Grace_auto_beam_engraver::Grace_auto_beam_engraver (Context *c)
+  : Auto_beam_engraver (c)
+{
+  last_grace_start_.main_part_.set_infinite (-1);
+  // grace_part_ is zero -> test_moment is false, last_grace_position_
+  // not considered.
+}
+
+bool
+Grace_auto_beam_engraver::is_same_grace_state (Moment, Moment)
+{
+  // This is for ignoring interspersed grace notes in main note
+  // beaming.  We never want to ignore something inside of grace note
+  // beaming, so return true.
+  return true;
+}
+
+void
+Grace_auto_beam_engraver::process_music ()
+{
+  Moment now = now_mom ();
+  // Update last_grace_start_ and last_grace_position_ only when the
+  // main time advances.
+  if (now.main_part_ > last_grace_start_.main_part_)
+    {
+      last_grace_start_ = now;
+      last_grace_position_ = measure_position (context ());
+    }
+
+  Auto_beam_engraver::process_music ();
+}
+
+bool
+Grace_auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment)
+{
+  // If no grace group started this main moment, we have no business
+  // beaming.  Same if we have left the original main time step.
+  if (!last_grace_start_.grace_part_
+      || last_grace_position_.main_part_ != test_mom.main_part_)
+    return false;
+  // Autobeam start only when at the start of the grace group.
+  if (dir == START)
+      return last_grace_position_ == test_mom;
+  // Autobeam end only when the grace part is finished.
+  return !test_mom.grace_part_;
+}
+
+void
+Grace_auto_beam_engraver::boot ()
+{
+  ADD_LISTENER (Grace_auto_beam_engraver, beam_forbid);
+  ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, stem);
+  ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, bar_line);
+  ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, beam);
+  ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, breathing_sign);
+  ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, rest);
+}
+
+ADD_TRANSLATOR (Grace_auto_beam_engraver,
+                /* doc */
+                "Generates one autobeam group across an entire grace phrase. "
+                " As usual, any manual beaming or @code{\\noBeam} will block"
+                " autobeaming, just like setting the context property"
+                " @samp{autoBeaming} to @code{##f}.",
+
+                /* create */
+                "Beam ",
+
+                /* read */
+                "autoBeaming ",
+
+                /* write */
+                ""
+               );