]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur-engraver.cc
Merge branch 'master' of git://git.savannah.gnu.org/lilypond.git
[lilypond.git] / lily / slur-engraver.cc
index 6f57a925c39113bc58a85c027831ff554a46d540..45aa121a71eebd00cf0580fbf6d33ed42febd13d 100644 (file)
 /*
-  slur-engraver.cc -- implement Slur_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c)  1997--2001 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 "musical-request.hh"
-#include "slur.hh"
-#include "debug.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"
+
+
+/*
+  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<Span_req> requests_arr_;
-  Link_array<Span_req> new_slur_req_l_arr_;
-  Link_array<Grob> slur_l_stack_;
-  Link_array<Grob> end_slur_l_arr_;
-  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 create_grobs ();
+
 
 public:
-  VIRTUAL_COPY_CONS (Translator);
-  Slur_engraver ();
+  TRANSLATOR_DECLARATIONS (Slur_engraver);
 };
 
 Slur_engraver::Slur_engraver ()
 {
-  last_start_ = Moment (-1);
 }
 
-bool
-Slur_engraver::try_music (Music *req_l)
+IMPLEMENT_TRANSLATOR_LISTENER (Slur_engraver, slur);
+void
+Slur_engraver::listen_slur (Stream_event *ev)
 {
-  if (Span_req *sl = dynamic_cast <Span_req *> (req_l))
-    {
-      String t =  ly_scm2string (sl->get_mus_property ("span-type"));
-      if (t == "abort")
-       {
-         for (int i = 0; i < slur_l_stack_.size (); i++)
-           {
-             slur_l_stack_[i]->suicide ();
-           }
-         slur_l_stack_.clear ();
-         for (int i = 0; i < end_slur_l_arr_.size (); i++)
-           {
-             end_slur_l_arr_[i]->suicide ();
-           }
-         end_slur_l_arr_.clear ();
-         requests_arr_.clear ();
-         new_slur_req_l_arr_.clear ();
-       }
-      else if (t == "slur")
-       {
-         /*
-           Let's not start more than one slur per moment.
-          */
-         if (sl->get_span_dir () == START)
-           {
-             if (now_mom () > last_start_)
-               {
-                 new_slur_req_l_arr_.push (sl);
-                 last_start_ = now_mom ();
-                 return true;
-               }
-           }
-         else
-           {
-             new_slur_req_l_arr_.push (sl);
-             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_l_->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.elem_l_))
-    {
-      Grob *e =info.elem_l_;
-      for (int i = 0; i < slur_l_stack_.size (); i++)
-       Slur::add_column (slur_l_stack_[i], e);
-      for (int i = 0; i < end_slur_l_arr_.size (); i++)
-       Slur::add_column (end_slur_l_arr_[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_l_stack_.size (); i++)
-    {
-#if 0
-      typeset_grob (slur_l_stack_[i]);
-#else
-      /*
-       Let's not typeset unterminated stuff
-       */
-      slur_l_stack_[i]->suicide ();
-#endif     
-    }
-  slur_l_stack_.clear ();
-  SCM wg = get_property ("weAreGraceContext");
-  bool wgb = to_boolean (wg);
-  if (!wgb)
-    for (int i=0; i < requests_arr_.size (); i++)
-      {
-       requests_arr_[i]->origin ()->warning (_ ("unterminated slur"));
-      }
+  Slur::auxiliary_acknowledge_extra_object (info, slurs_, end_slurs_);
+}
+
+void
+Slur_engraver::acknowledge_accidental (Grob_info info)
+{
+  acknowledge_extra_object (info);
+}
+
+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::create_grobs ()
+Slur_engraver::finalize ()
 {
-  Link_array<Grob> start_slur_l_arr;
-  for (int i=0; i< new_slur_req_l_arr_.size (); i++)
+  for (vsize i = 0; i < slurs_.size (); i++)
     {
-      Span_req* slur_req_l = new_slur_req_l_arr_[i];
-      // end slur: move the slur to other array
-      if (slur_req_l->get_span_dir () == STOP)
-       {
-         if (slur_l_stack_.empty ())
-           /* How to shut up this warning, when Voice_devnull_engraver has
-              eaten start request? */
-           slur_req_l->origin ()->warning (_f ("can't find start of slur"));
-         else
-           {
-             Grob* slur = slur_l_stack_.pop ();
-             SCM s = get_property ("slurEndAttachment");
-             if (gh_symbol_p (s))
-               {
-                 index_set_cell (slur->get_grob_property ("attachment"), STOP, s);
-               }
-             end_slur_l_arr_.push (slur);
-             requests_arr_.pop ();
-           }
-       }
-      else  if (slur_req_l->get_span_dir () == 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);
-         SCM s = get_property ("slurBeginAttachment");
-         if (gh_symbol_p (s))
-           {
-             index_set_cell (slur->get_grob_property ("attachment"), START, s);
-           }
-         start_slur_l_arr.push (slur);
-         requests_arr_.push (slur_req_l);
-         announce_grob (slur, slur_req_l);
-       }
+      slurs_[i]->warning (_ ("unterminated slur"));
+      slurs_[i]->suicide ();
     }
-  for (int i=0; i < start_slur_l_arr.size (); i++)
-    slur_l_stack_.push (start_slur_l_arr[i]);
-  new_slur_req_l_arr_.clear ();
 }
 
 void
-Slur_engraver::stop_translation_timestep ()
+Slur_engraver::process_music ()
 {
-  for (int i = 0; i < end_slur_l_arr_.size (); i++)
+  for (vsize i = 0; i < stop_events_.size (); 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"));
+    }
+
+  for (vsize i = start_events_.size (); i--;)
     {
-      typeset_grob (end_slur_l_arr_[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);
+            }
+        }
     }
-  end_slur_l_arr_.clear ();
+  set_melisma (slurs_.size ());
 }
 
 void
-Slur_engraver::start_translation_timestep ()
+Slur_engraver::stop_translation_timestep ()
 {
-  new_slur_req_l_arr_.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_l_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 ",
 
-ADD_THIS_TRANSLATOR (Slur_engraver);
+               /* write */
+               ""
+               );