]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/phrasing-slur-engraver.cc
Issue 2584 (redo 1967): please make partcombine merge slurs
[lilypond.git] / lily / phrasing-slur-engraver.cc
index d0891c08d78d1d4c454890127fbbe8b60df567b6..ea2439534c2b210e42250269471c7c26c684d3c6 100644 (file)
 /*
-  phrasing-slur-engraver.cc -- implement Phrasing_slur_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.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 "engraver.hh"
+
 #include "context.hh"
 #include "directional-element-interface.hh"
-#include "engraver.hh"
-#include "slur.hh"
+#include "international.hh"
 #include "note-column.hh"
+#include "slur.hh"
 #include "spanner.hh"
-#include "tie.hh"
+#include "stream-event.hh"
 #include "warn.hh"
 
+#include "translator.icc"
+
+/*
+  NOTE NOTE NOTE
+
+  This is largely similar to 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 Phrasing_slur_engraver : public Engraver
 {
-  Drul_array<Music *> events_;
-  Music *running_slur_start_;
-  Link_array<Grob> slurs_;
-  Link_array<Grob> end_slurs_;
+  vector<Stream_event *> start_events_;
+  vector<Stream_event *> stop_events_;
+  vector<Grob *> slurs_;
+  vector<Grob *> end_slurs_;
+  vector<Grob_info> objects_to_acknowledge_;
 
 protected:
-  virtual bool try_music (Music *);
-
-  void acknowledge_extra_object (Grob_info);
-  DECLARE_ACKNOWLEDGER (accidental);
-  DECLARE_ACKNOWLEDGER (dynamic_line_spanner);
+  DECLARE_TRANSLATOR_LISTENER (phrasing_slur);
+  DECLARE_ACKNOWLEDGER (inline_accidental);
   DECLARE_ACKNOWLEDGER (fingering);
   DECLARE_ACKNOWLEDGER (note_column);
-  DECLARE_ACKNOWLEDGER (script);
   DECLARE_ACKNOWLEDGER (slur);
+  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 ();
-  virtual void finalize ();
   void process_music ();
 
+  virtual void finalize ();
+
 public:
   TRANSLATOR_DECLARATIONS (Phrasing_slur_engraver);
 };
 
 Phrasing_slur_engraver::Phrasing_slur_engraver ()
 {
-  events_[START] = events_[STOP] = 0;
 }
 
-bool
-Phrasing_slur_engraver::try_music (Music *m)
+IMPLEMENT_TRANSLATOR_LISTENER (Phrasing_slur_engraver, phrasing_slur);
+void
+Phrasing_slur_engraver::listen_phrasing_slur (Stream_event *ev)
 {
-  if (m->is_mus_type ("phrasing-slur-event"))
-    {
-      /*
-       Let's not start more than one slur per moment.
-      */
-      Direction d = to_dir (m->get_property ("span-direction"));
-      if (d == START)
-       {
-         events_[START] = m;
-         return true;
-       }
-      else if (d == STOP)
-       {
-         if (slurs_.is_empty ())
-           return false;
-
-         events_[STOP] = m;
-         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",
+                                     "phrasing-slur-event", int (d)));
 }
 
 void
 Phrasing_slur_engraver::acknowledge_note_column (Grob_info info)
 {
   Grob *e = info.grob ();
-  for (int i = slurs_.size (); i--;)
+  for (vsize i = slurs_.size (); i--;)
     Slur::add_column (slurs_[i], e);
-  for (int i = end_slurs_.size (); i--;)
+  for (vsize i = end_slurs_.size (); i--;)
     Slur::add_column (end_slurs_[i], e);
 }
 
-/* FIXME: cut + paste job from Slur:: */
 void
 Phrasing_slur_engraver::acknowledge_extra_object (Grob_info info)
 {
-  Grob *e = info.grob ();
-  SCM avoid = e->get_property ("avoid-slur");
-  if (Tie::has_interface (e)
-      || avoid == ly_symbol2scm ("inside"))
-    {
-      for (int i = slurs_.size (); i--;)
-       Slur::add_extra_encompass (slurs_[i], e);
-      for (int i = end_slurs_.size (); i--;)
-       Slur::add_extra_encompass (end_slurs_[i], e);
-    }
-  else if (avoid == ly_symbol2scm ("outside")
-          || avoid == ly_symbol2scm ("around"))
-    {
-      Grob *slur = slurs_.size () ? slurs_[0] : 0;
-      slur = (end_slurs_.size () && !slur)
-       ? end_slurs_[0] : slur;
-
-      if (slur)
-       {
-         chain_offset_callback (e, Slur::outside_slur_callback_proc, Y_AXIS);
-         e->set_object ("slur", slur->self_scm ());
-       }
-    }
+  objects_to_acknowledge_.push_back (info);
 }
 
 void
-Phrasing_slur_engraver::acknowledge_accidental (Grob_info info)
+Phrasing_slur_engraver::acknowledge_inline_accidental (Grob_info info)
 {
   acknowledge_extra_object (info);
 }
 
 void
-Phrasing_slur_engraver::acknowledge_dynamic_line_spanner (Grob_info info)
+Phrasing_slur_engraver::acknowledge_dots (Grob_info info)
 {
   acknowledge_extra_object (info);
 }
@@ -138,11 +127,18 @@ Phrasing_slur_engraver::acknowledge_fingering (Grob_info info)
 }
 
 void
-Phrasing_slur_engraver::acknowledge_script (Grob_info info)
+Phrasing_slur_engraver::acknowledge_tuplet_number (Grob_info info)
 {
   acknowledge_extra_object (info);
 }
 
+void
+Phrasing_slur_engraver::acknowledge_script (Grob_info info)
+{
+  if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
+    acknowledge_extra_object (info);
+}
+
 void
 Phrasing_slur_engraver::acknowledge_text_script (Grob_info info)
 {
@@ -164,53 +160,146 @@ Phrasing_slur_engraver::acknowledge_slur (Grob_info info)
 void
 Phrasing_slur_engraver::finalize ()
 {
-  if (slurs_.size ())
-    slurs_[0]->warning (_ ("unterminated phrasing slur"));
+  for (vsize i = 0; i < slurs_.size (); i++)
+    {
+      slurs_[i]->warning (_ ("unterminated phrasing slur"));
+      slurs_[i]->suicide ();
+    }
 }
 
 void
 Phrasing_slur_engraver::process_music ()
 {
-  if (events_[STOP])
+  for (vsize i = 0; i < stop_events_.size (); i++)
     {
-      end_slurs_ = slurs_;
-      slurs_.clear ();
+      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 phrasing slur"));
     }
 
-  if (events_[START] && slurs_.is_empty ())
+  vsize old_slurs = slurs_.size ();
+  for (vsize i = start_events_.size (); i--;)
     {
-      Music *ev = events_[START];
-
-      Grob *slur = make_spanner ("PhrasingSlur", events_[START]->self_scm ());
+      Stream_event *ev = start_events_[i];
+      string id = robust_scm2string (ev->get_property ("spanner-id"), "");
       Direction updown = to_dir (ev->get_property ("direction"));
-      if (updown)
-       set_grob_direction (slur, updown);
 
-      slurs_.push (slur);
+      bool completed;
+      for (vsize j = 0; !(completed = (j == slurs_.size ())); j++)
+        {
+          // 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 phrasing 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.  This is not entirely accurate:
+              // tweaks or context properties like those set with
+              // \slurUp can still override a neutral direction, so
+              // when encountering a slur event with "opposite"
+              // direction first, then one with neutral direction, we
+              // only let the "opposite" direction remain, while if
+              // the order is the other way round, a double slur
+              // results since the direction of the first slur is no
+              // longer attributable to a "neutral" slur event.  A
+              // mixture of neutral and directed events is nothing
+              // that the partcombiner should crank out, and it would
+              // be decidedly strange for manual input.
+
+              if (!updown)
+                break;
+
+              // If the existing slur does not have a direction yet,
+              // give it ours
+
+              Direction slur_dir = to_dir (slurs_[j]->get_property ("direction"));
+
+              if (!slur_dir)
+                {
+                  set_grob_direction (slurs_[j], updown);
+                  break;
+                }
+
+              // 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 ("PhrasingSlur", ev->self_scm ());
+          slur->set_property ("spanner-id", ly_string2scm (id));
+          if (updown)
+            set_grob_direction (slur, updown);
+          slurs_.push_back (slur);
+        }
     }
 }
 
 void
 Phrasing_slur_engraver::stop_translation_timestep ()
 {
+  for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
+    Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
+
   end_slurs_.clear ();
-  events_[START] = events_[STOP] = 0;
+  start_events_.clear ();
+  stop_events_.clear ();
+  objects_to_acknowledge_.clear ();
 }
 
-#include "translator.icc"
-
-ADD_ACKNOWLEDGER (Phrasing_slur_engraver, accidental);
-ADD_ACKNOWLEDGER (Phrasing_slur_engraver, dynamic_line_spanner);
+ADD_ACKNOWLEDGER (Phrasing_slur_engraver, inline_accidental);
 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, fingering)
-  ADD_ACKNOWLEDGER (Phrasing_slur_engraver, note_column);
-ADD_ACKNOWLEDGER (Phrasing_slur_engraver, script);
+ADD_ACKNOWLEDGER (Phrasing_slur_engraver, note_column);
 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, slur);
+ADD_ACKNOWLEDGER (Phrasing_slur_engraver, script);
+ADD_ACKNOWLEDGER (Phrasing_slur_engraver, dots);
 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, text_script);
 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tie);
+ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tuplet_number);
 
 ADD_TRANSLATOR (Phrasing_slur_engraver,
-               /* doc */ "Print phrasing slurs. Similar to @ref{Slur_engraver}",
-               /* create */ "PhrasingSlur",
-               /* accept */ "phrasing-slur-event",
-               /* read */ "",
-               /* write */ "");
+                /* doc */
+                "Print phrasing slurs.  Similar to @ref{Slur_engraver}.",
+
+                /* create */
+                "PhrasingSlur ",
+
+                /* read */
+                "",
+
+                /* write */
+                ""
+               );