]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur-engraver.cc
Imported Upstream version 2.16.0
[lilypond.git] / lily / slur-engraver.cc
index 763d77a3e585cb075cb7287d996f129b86961d22..03f5a5c430667ca9783b9578c454202aa55d6859 100644 (file)
 /*
-  slur-grav.cc -- implement Slur_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Copyright (C) 1997--2012 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-engraver.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
 
-class Slur_engraver :public Engraver {
-  Link_array<Span_req> requests_arr_;
-  Link_array<Span_req> new_slur_req_l_arr_;
-  Link_array<Score_element> slur_l_stack_;
-  Link_array<Score_element> end_slur_l_arr_;
+  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
+{
+  vector<Stream_event *> start_events_;
+  vector<Stream_event *> stop_events_;
+  vector<Grob *> slurs_;
+  vector<Grob *> end_slurs_;
+  vector<Grob_info> objects_to_acknowledge_;
 
   void set_melisma (bool);
+
 protected:
-  virtual bool do_try_music (Music*);
-  virtual void do_process_music ();
-  virtual void acknowledge_element (Score_element_info);
-  virtual void do_pre_move_processing ();
-  virtual void do_post_move_processing ();
-  virtual void do_removal_processing ();
+  DECLARE_TRANSLATOR_LISTENER (slur);
+  DECLARE_ACKNOWLEDGER (inline_accidental);
+  DECLARE_ACKNOWLEDGER (fingering);
+  DECLARE_ACKNOWLEDGER (note_column);
+  DECLARE_ACKNOWLEDGER (script);
+  DECLARE_ACKNOWLEDGER (dots);
+  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 derived_mark () const;
 
 public:
-  VIRTUAL_COPY_CONS (Translator);
-  
+  TRANSLATOR_DECLARATIONS (Slur_engraver);
 };
 
-bool
-Slur_engraver::do_try_music (Music *req_l)
+Slur_engraver::Slur_engraver ()
 {
-  if (Span_req *sl = dynamic_cast <Span_req *> (req_l))
-    {
-      if (sl->span_type_str_ != "slur")
-       return false;
-      new_slur_req_l_arr_.push (sl);
+}
 
-      return true;
-    }
-  return false;
+void
+Slur_engraver::derived_mark () const
+{
+  for (vsize i = start_events_.size (); i--;)
+    scm_gc_mark (start_events_[i]->self_scm ());
+  for (vsize i = stop_events_.size (); i--;)
+    scm_gc_mark (stop_events_[i]->self_scm ());
+}
+
+IMPLEMENT_TRANSLATOR_LISTENER (Slur_engraver, slur);
+void
+Slur_engraver::listen_slur (Stream_event *ev)
+{
+  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_element (Score_element_info info)
+Slur_engraver::acknowledge_note_column (Grob_info info)
 {
-  if (Note_column::has_interface (info.elem_l_))
-    {
-      Score_element *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::do_removal_processing ()
+Slur_engraver::acknowledge_extra_object (Grob_info info)
 {
-  for (int i = 0; i < slur_l_stack_.size (); i++)
-    {
-#if 0
-      typeset_element (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"));
-      }
+  objects_to_acknowledge_.push_back (info);
+}
+
+void
+Slur_engraver::acknowledge_inline_accidental (Grob_info info)
+{
+  acknowledge_extra_object (info);
+}
+
+void
+Slur_engraver::acknowledge_dots (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::do_process_music ()
+Slur_engraver::acknowledge_text_script (Grob_info info)
 {
-  Link_array<Score_element> start_slur_l_arr_;
-  for (int i=0; i< new_slur_req_l_arr_.size (); i++)
+  acknowledge_extra_object (info);
+}
+
+void
+Slur_engraver::acknowledge_tie (Grob_info info)
+{
+  acknowledge_extra_object (info);
+}
+
+void
+Slur_engraver::finalize ()
+{
+  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->span_dir_ == STOP)
-       {
-         if (slur_l_stack_.empty ())
-           slur_req_l->origin ()->warning (_f ("can't find start of slur"));
-         else
-           {
-             Score_element* slur = slur_l_stack_.pop ();
-             SCM s = get_property ("slurEndAttachment");
-             if (gh_symbol_p (s))
-               {
-                 index_set_cell (slur->get_elt_property ("attachment"), STOP, s);
-               }
-             end_slur_l_arr_.push (slur);
-             requests_arr_.pop ();
-           }
-       }
-      else  if (slur_req_l->span_dir_ == START)
-       {
-         // push a new slur onto stack.
-         // (use temp. array to wait for all slur STOPs)
-         Score_element* slur = new Spanner (get_property ("basicSlurProperties"));
-         Slur::set_interface (slur);
-         SCM s = get_property ("slurBeginAttachment");
-         if (gh_symbol_p (s))
-           {
-             index_set_cell (slur->get_elt_property ("attachment"), START, s);
-           }
-         start_slur_l_arr_.push (slur);
-         requests_arr_.push (slur_req_l);
-         announce_element (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]);
+  slurs_.clear ();
 }
 
 void
-Slur_engraver::do_pre_move_processing ()
+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 slurs that are 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)
+        {
+          // Ignore redundant stop events for this id
+          for (vsize j = stop_events_.size (); --j > i;)
+            {
+              if (id == robust_scm2string (stop_events_[j]->get_property ("spanner-id"), ""))
+                stop_events_.erase (stop_events_.begin () + j);
+            }
+        }
+      else
+        ev->origin ()->warning (_ ("cannot end slur"));
+    }
+
+  vsize old_slurs = slurs_.size ();
+  for (vsize i = start_events_.size (); i--;)
     {
-      typeset_element (end_slur_l_arr_[i]);
+      Stream_event *ev = start_events_[i];
+      string id = robust_scm2string (ev->get_property ("spanner-id"), "");
+      Direction updown = to_dir (ev->get_property ("direction"));
+
+      bool completed;
+      for (vsize j = slurs_.size (); !(completed = (j-- == 0));)
+        {
+          // Check if we already have a slur with the same spanner-id.
+          if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
+            {
+              if (j < old_slurs)
+                {
+                  // We already have an old slur, so give a warning
+                  // and completely ignore the new slur.
+                  ev->origin ()->warning (_ ("already have slur"));
+                  start_events_.erase (start_events_.begin () + i);
+                  break;
+                }
+
+              // If this slur event has no direction, it will not
+              // contribute anything new to the existing slur(s), so
+              // we can ignore it.
+
+              if (!updown)
+                break;
+
+              Stream_event *c = unsmob_stream_event (slurs_[j]->get_property ("cause"));
+
+              if (!c)
+                {
+                  slurs_[j]->programming_error ("slur without a cause");
+                  continue;
+                }
+
+              Direction slur_dir = to_dir (c->get_property ("direction"));
+
+              // If the existing slur does not have a direction yet,
+              // we'd rather take the new one.
+
+              if (!slur_dir)
+                {
+                  slurs_[j]->suicide ();
+                  slurs_.erase (slurs_.begin () + j);
+                  continue;
+                }
+
+              // If the existing slur has the same direction as ours, drop ours
+
+              if (slur_dir == updown)
+                break;
+            }
+        }
+      // If the loop completed, our slur is new
+      if (completed)
+        {
+          Grob *slur = make_spanner ("Slur", ev->self_scm ());
+          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::do_post_move_processing ()
+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);
     }
+
+  for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
+    Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
+
+  objects_to_acknowledge_.clear ();
+  end_slurs_.clear ();
+  start_events_.clear ();
+  stop_events_.clear ();
 }
 
+ADD_ACKNOWLEDGER (Slur_engraver, inline_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, dots);
+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 */
+                ""
+               );