]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur-engraver.cc
Add new features/bugfixes to changes.tely
[lilypond.git] / lily / slur-engraver.cc
index 77e6ccd1933f407c4ad5f95fcb5034c21938bf95..98f0bbf336fcf779559b49a1c9c9e018b32d2d9c 100644 (file)
@@ -1,37 +1,74 @@
 /*
-  slur-engraver.cc -- implement Slur_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#include "event.hh"
-#include "slur.hh"
-#include "warn.hh"
-#include "note-column.hh"
-#include "translator-group.hh"
 #include "engraver.hh"
+
+#include "context.hh"
+#include "directional-element-interface.hh"
+#include "international.hh"
+#include "note-column.hh"
+#include "slur.hh"
 #include "spanner.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+
+#include "translator.icc"
 
 /*
-  TODO: junk nested slur functionality.
+  NOTE NOTE NOTE
+
+  This is largely similar to Phrasing_slur_engraver. Check if fixes
+  apply there too.
+
+  (on principle, engravers don't use inheritance for code sharing)
+
  */
+
+/*
+  It is possible that a slur starts and ends on the same note.  At
+  least, it is for phrasing slurs: a note can be both beginning and
+  ending of a phrase.
+*/
 class Slur_engraver : public Engraver
 {
-  Link_array<Music> events_;
-  Link_array<Music> new_slur_evs_;
-  Link_array<Grob> slur_stack_;
-  Link_array<Grob> end_slurs_;
-  Moment last_start_;
+  vector<Stream_event *> start_events_;
+  vector<Stream_event *> stop_events_;
+  vector<Grob *> slurs_;
+  vector<Grob *> end_slurs_;
 
   void set_melisma (bool);
 
 protected:
-  virtual bool try_music (Music*);
-  virtual void acknowledge_grob (Grob_info);
-  virtual void stop_translation_timestep ();
-  virtual void start_translation_timestep ();
+  DECLARE_TRANSLATOR_LISTENER (slur);
+  DECLARE_ACKNOWLEDGER (accidental);
+  DECLARE_ACKNOWLEDGER (fingering);
+  DECLARE_ACKNOWLEDGER (note_column);
+  DECLARE_ACKNOWLEDGER (script);
+  DECLARE_ACKNOWLEDGER (text_script);
+  DECLARE_ACKNOWLEDGER (tie);
+  DECLARE_ACKNOWLEDGER (tuplet_number);
+
+  void acknowledge_extra_object (Grob_info);
+  void stop_translation_timestep ();
+  void process_music ();
+
   virtual void finalize ();
-  virtual void process_acknowledged_grobs ();
 
 public:
   TRANSLATOR_DECLARATIONS (Slur_engraver);
@@ -39,182 +76,195 @@ public:
 
 Slur_engraver::Slur_engraver ()
 {
-  last_start_ = Moment (-1);
 }
 
-bool
-Slur_engraver::try_music (Music *ev)
+IMPLEMENT_TRANSLATOR_LISTENER (Slur_engraver, slur);
+void
+Slur_engraver::listen_slur (Stream_event *ev)
 {
-  if (ev->is_mus_type ("abort-event"))
-    {
-      for (int i = 0; i < slur_stack_.size (); i++)
-       {
-         slur_stack_[i]->suicide ();
-       }
-      slur_stack_.clear ();
-      for (int i = 0; i < end_slurs_.size (); i++)
-       {
-         end_slurs_[i]->suicide ();
-       }
-      end_slurs_.clear ();
-      events_.clear ();
-      new_slur_evs_.clear ();
-    }
-  else if (ev->is_mus_type ("slur-event"))
-    {
-      /*
-       Let's not start more than one slur per moment.
-      */
-      Direction d = to_dir (ev->get_mus_property ("span-direction"));
-      if (d == START)
-       {
-         if (now_mom () > last_start_)
-           {
-             new_slur_evs_.push (ev);
-             last_start_ = now_mom ();
-           }
-
-         /*
-           But we swallow other slur events.
-         */
-             
-         return true;
-
-       }
-      else if (d == STOP)
-       {
-         /*
-           Swallow other events.
-         */
-         for (int j = new_slur_evs_.size(); j--;)
-           {
-             Direction nd = to_dir (new_slur_evs_[j]->get_mus_property ("span-direction"));
-             
-             if (nd == STOP)
-               return true;
-           }
-             
-         new_slur_evs_.push (ev);
-         return true;
-       }
-    }
-  return false;
+  Direction d = to_dir (ev->get_property ("span-direction"));
+  if (d == START)
+    start_events_.push_back (ev);
+  else if (d == STOP)
+    stop_events_.push_back (ev);
+  else ev->origin ()->warning (_f ("direction of %s invalid: %d",
+                                     "slur-event", int (d)));
 }
 
 void
 Slur_engraver::set_melisma (bool m)
 {
-  daddy_trans_->set_property ("slurMelismaBusy", m ? SCM_BOOL_T :SCM_BOOL_F);
+  context ()->set_property ("slurMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
 }
 
 void
-Slur_engraver::acknowledge_grob (Grob_info info)
+Slur_engraver::acknowledge_note_column (Grob_info info)
 {
-  if (Note_column::has_interface (info.grob_))
-    {
-      Grob *e =info.grob_;
-      for (int i = 0; i < slur_stack_.size (); i++)
-       Slur::add_column (slur_stack_[i], e);
-      for (int i = 0; i < end_slurs_.size (); i++)
-       Slur::add_column (end_slurs_[i], e);
-    }
+  Grob *e = info.grob ();
+  for (vsize i = slurs_.size (); i--;)
+    Slur::add_column (slurs_[i], e);
+  for (vsize i = end_slurs_.size (); i--;)
+    Slur::add_column (end_slurs_[i], e);
 }
 
 void
-Slur_engraver::finalize ()
+Slur_engraver::acknowledge_extra_object (Grob_info info)
 {
-  for (int i = 0; i < slur_stack_.size (); i++)
-    {
-#if 0
-      typeset_grob (slur_stack_[i]);
-#else
-      /*
-       Let's not typeset unterminated stuff
-       */
-      slur_stack_[i]->suicide ();
-#endif     
-    }
-  slur_stack_.clear ();
+  Slur::auxiliary_acknowledge_extra_object (info, slurs_, end_slurs_);
+}
+
+void
+Slur_engraver::acknowledge_accidental (Grob_info info)
+{
+  acknowledge_extra_object (info);
+}
 
-  for (int i=0; i < events_.size (); i++)
-      {
-       events_[i]->origin ()->warning (_ ("unterminated slur"));
-      }
+void
+Slur_engraver::acknowledge_fingering (Grob_info info)
+{
+  acknowledge_extra_object (info);
+}
+
+void
+Slur_engraver::acknowledge_tuplet_number (Grob_info info)
+{
+  acknowledge_extra_object (info);
+}
+
+void
+Slur_engraver::acknowledge_script (Grob_info info)
+{
+  if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
+    acknowledge_extra_object (info);
+}
+
+void
+Slur_engraver::acknowledge_text_script (Grob_info info)
+{
+  acknowledge_extra_object (info);
+}
+
+void
+Slur_engraver::acknowledge_tie (Grob_info info)
+{
+  acknowledge_extra_object (info);
 }
 
 void
-Slur_engraver::process_acknowledged_grobs ()
+Slur_engraver::finalize ()
 {
-  Link_array<Grob> start_slurs;
-  for (int i=0; i< new_slur_evs_.size (); i++)
+  for (vsize i = 0; i < slurs_.size (); i++)
     {
-      Music* slur_ev = new_slur_evs_[i];
-      // end slur: move the slur to other array
-      Direction d = to_dir (slur_ev->get_mus_property ("span-direction"));
-      if (d== STOP)
-       {
-         if (slur_stack_.empty ())
-           /* How to shut up this warning, when Voice_devnull_engraver has
-              eaten start event? */
-           slur_ev->origin ()->warning (_f ("can't find start of slur"));
-         else
-           {
-             Grob* slur = slur_stack_.pop ();
-           
-             end_slurs_.push (slur);
-             events_.pop ();
-           }
-       }
-      else  if (d == START)
-       {
-         // push a new slur onto stack.
-         // (use temp. array to wait for all slur STOPs)
-         Grob* slur = new Spanner (get_property ("Slur"));
-         Slur::set_interface (slur); // cannot remove yet!
-
-
-         if (Direction updown = to_dir (slur_ev->get_mus_property ("direction")))
-           {
-             slur->set_grob_property ("direction", gh_int2scm (updown));
-           }
-         
-         start_slurs.push (slur);
-         events_.push (slur_ev);
-         announce_grob (slur, slur_ev->self_scm ());
-       }
+      slurs_[i]->warning (_ ("unterminated slur"));
+      slurs_[i]->suicide ();
     }
-  for (int i=0; i < start_slurs.size (); i++)
-    slur_stack_.push (start_slurs[i]);
-  new_slur_evs_.clear ();
 }
 
 void
-Slur_engraver::stop_translation_timestep ()
+Slur_engraver::process_music ()
 {
-  for (int i = 0; i < end_slurs_.size (); i++)
+  for (vsize i = 0; i < stop_events_.size (); i++)
     {
-      typeset_grob (end_slurs_[i]);
+      Stream_event *ev = stop_events_[i];
+      string id = robust_scm2string (ev->get_property ("spanner-id"), "");
+
+      // Find the slur that is ended with this event (by checking the spanner-id)
+      bool ended = false;
+      for (vsize j = slurs_.size (); j--;)
+        {
+          if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
+            {
+              ended = true;
+              end_slurs_.push_back (slurs_[j]);
+              slurs_.erase (slurs_.begin () + j);
+            }
+        }
+      if (!ended)
+        ev->origin ()->warning (_ ("cannot end slur"));
     }
-  end_slurs_.clear ();
+
+  for (vsize i = start_events_.size (); i--;)
+    {
+      Stream_event *ev = start_events_[i];
+      string id = robust_scm2string (ev->get_property ("spanner-id"), "");
+      bool have_slur = false;
+      // Check if we already have a slur with the same spanner-id.
+      // In that case, don't create a new slur, but print a warning
+      for (vsize j = 0; j < slurs_.size (); j++)
+        have_slur = have_slur || (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""));
+
+      if (have_slur)
+        {
+          // We already have a slur, so give a warning and completely ignore
+          // the new slur.
+          ev->origin ()->warning (_ ("already have slur"));
+          start_events_.erase (start_events_.begin () + i);
+        }
+      else
+        {
+          Grob *slur = make_spanner ("Slur", ev->self_scm ());
+          Direction updown = to_dir (ev->get_property ("direction"));
+          slur->set_property ("spanner-id", ly_string2scm (id));
+          if (updown)
+            set_grob_direction (slur, updown);
+          slurs_.push_back (slur);
+
+          if (to_boolean (get_property ("doubleSlurs")))
+            {
+              set_grob_direction (slur, DOWN);
+              slur = make_spanner ("Slur", ev->self_scm ());
+              slur->set_property ("spanner-id", ly_string2scm (id));
+              set_grob_direction (slur, UP);
+              slurs_.push_back (slur);
+            }
+        }
+    }
+  set_melisma (slurs_.size ());
 }
 
 void
-Slur_engraver::start_translation_timestep ()
+Slur_engraver::stop_translation_timestep ()
 {
-  new_slur_evs_.clear ();
-  SCM m = get_property ("automaticMelismata");
-  if (to_boolean (m))
+  if (Grob *g = unsmob_grob (get_property ("currentCommandColumn")))
+    {
+      for (vsize i = 0; i < end_slurs_.size (); i++)
+        Slur::add_extra_encompass (end_slurs_[i], g);
+
+      if (!start_events_.size ())
+        for (vsize i = 0; i < slurs_.size (); i++)
+          Slur::add_extra_encompass (slurs_[i], g);
+    }
+
+  for (vsize i = 0; i < end_slurs_.size (); i++)
     {
-      set_melisma (slur_stack_.size ());
+      Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
+      if (!s->get_bound (RIGHT))
+        s->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
+      announce_end_grob (s, SCM_EOL);
     }
+  end_slurs_.clear ();
+  start_events_.clear ();
+  stop_events_.clear ();
 }
 
+ADD_ACKNOWLEDGER (Slur_engraver, accidental);
+ADD_ACKNOWLEDGER (Slur_engraver, fingering);
+ADD_ACKNOWLEDGER (Slur_engraver, note_column);
+ADD_ACKNOWLEDGER (Slur_engraver, script);
+ADD_ACKNOWLEDGER (Slur_engraver, text_script);
+ADD_ACKNOWLEDGER (Slur_engraver, tie);
+ADD_ACKNOWLEDGER (Slur_engraver, tuplet_number);
+ADD_TRANSLATOR (Slur_engraver,
+                /* doc */
+                "Build slur grobs from slur events.",
+
+                /* create */
+                "Slur ",
 
+                /* read */
+                "slurMelismaBusy "
+                "doubleSlurs ",
 
-ENTER_DESCRIPTION (Slur_engraver,
-/* descr */       "Build slurs from Slur_evs",
-/* creats*/       "Slur",
-/* accepts */     "slur-event",
-/* acks  */      "note-column-interface",
-/* reads */       "slurMelismaBusy",
-/* write */       "");
+                /* write */
+                ""
+               );