Approximates cross-staff slurs in VerticalAxisGroup vertical-skylines.

lily/phrasing-slur-engraver.cc

 /*
   This file is part of LilyPond, the GNU music typesetter.
 
   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.
 
@@ skipping 12 matching lines @@
 #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"
 
-#include <map>
+#include <algorithm>
 
 /*
   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)
+
+  For info on SlurStubs, check out slur-engraver.cc.
 
  */
 
 /*
   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
 {
   vector<Stream_event *> start_events_;
   vector<Stream_event *> stop_events_;
-  vector<Grob *> slurs_;
-  vector<Grob *> end_slurs_;
-  map<Grob *, vector<Grob *> > slur_stubs_;
+  vector<Slur_info> slur_infos_;
+  vector<Slur_info> end_slur_infos_;
   vector<Grob_info> objects_to_acknowledge_;
 
 protected:
   DECLARE_TRANSLATOR_LISTENER (phrasing_slur);
   DECLARE_ACKNOWLEDGER (inline_accidental);
   DECLARE_ACKNOWLEDGER (fingering);
   DECLARE_ACKNOWLEDGER (note_column);
   DECLARE_ACKNOWLEDGER (slur);
   DECLARE_ACKNOWLEDGER (script);
   DECLARE_ACKNOWLEDGER (dots);
   DECLARE_ACKNOWLEDGER (text_script);
-  DECLARE_ACKNOWLEDGER (tie);
+  DECLARE_END_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:
@@ skipping 23 matching lines @@
   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 (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);
-
-  for (vsize j = 0; j < slurs_.size (); j++)
-    {
-      if (slur_stubs_.find (slurs_[j]) == slur_stubs_.end ())
-        slur_stubs_[slurs_[j]] = vector<Grob *> ();
-
-      Grob *stub = make_spanner ("SlurStub", info.grob ()->self_scm ());
-      slur_stubs_[slurs_[j]].push_back (stub);
-    }
-
-  for (vsize j = 0; j < end_slurs_.size (); j++)
-    {
-      if (slur_stubs_.find (end_slurs_[j]) == slur_stubs_.end ())
-        slur_stubs_[end_slurs_[j]] = vector<Grob *> ();
-
-      Grob *stub = make_spanner ("SlurStub", info.grob ()->self_scm ());
-      slur_stubs_[end_slurs_[j]].push_back (stub);
+  for (vsize i = slur_infos_.size (); i--;)
+    {
+      Slur::add_column (slur_infos_[i].slur_, e);
+      Grob *stub = make_spanner ("SlurStub", slur_infos_[i].slur_->self_scm ());
+      slur_infos_[i].stubs_.push_back (stub);
+    }
+  for (vsize i = end_slur_infos_.size (); i--;)
+    {
+      Slur::add_column (end_slur_infos_[i].slur_, e);
+      Grob *stub = make_spanner ("SlurStub", slur_infos_[i].slur_->self_scm ());
+      end_slur_infos_[i].stubs_.push_back (stub);
     }
 }
 
 void
 Phrasing_slur_engraver::acknowledge_extra_object (Grob_info info)
 {
   objects_to_acknowledge_.push_back (info);
 }
 
 void
@@ skipping 28 matching lines @@
     acknowledge_extra_object (info);
 }
 
 void
 Phrasing_slur_engraver::acknowledge_text_script (Grob_info info)
 {
   acknowledge_extra_object (info);
 }
 
 void
-Phrasing_slur_engraver::acknowledge_tie (Grob_info info)
+Phrasing_slur_engraver::acknowledge_end_tie (Grob_info info)
 {
   acknowledge_extra_object (info);
 }
 
 void
 Phrasing_slur_engraver::acknowledge_slur (Grob_info info)
 {
-  if (!info.grob ()->internal_has_interface (ly_symbol2scm ("slur-stub-interface")))
+  if (!info.grob ()->internal_has_interface (ly_symbol2scm ("cross-staff-stub-interface")))
     acknowledge_extra_object (info);
 }
 
 void
 Phrasing_slur_engraver::finalize ()
 {
-  for (vsize i = 0; i < slurs_.size (); i++)
-    {
-      slurs_[i]->warning (_ ("unterminated phrasing slur"));
-      slurs_[i]->suicide ();
-    }
-  slurs_.clear ();
-  slur_stubs_.clear ();
+  for (vsize i = 0; i < slur_infos_.size (); i++)
+    {
+      slur_infos_[i].slur_->warning (_ ("unterminated phrasing slur"));
+      slur_infos_[i].slur_->suicide ();
+      for (vsize j = 0; j < slur_infos_[i].stubs_.size (); j++)
+        slur_infos_[i].stubs_[j]->suicide ();
+    }
+  slur_infos_.clear ();
 }
 
 void
 Phrasing_slur_engraver::process_music ()
 {
   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"), ""))
+      for (vsize j = slur_infos_.size (); j--;)
+        {
+          if (id == robust_scm2string (slur_infos_[j].slur_->get_property ("spanner-id"), ""))
             {
               ended = true;
-              end_slurs_.push_back (slurs_[j]);
-              slurs_.erase (slurs_.begin () + j);
+              end_slur_infos_.push_back (slur_infos_[j].slur_);
+              slur_infos_.erase (slur_infos_.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"));
     }
 
-  vsize old_slurs = slurs_.size ();
+  vsize old_slurs = slur_infos_.size ();
   for (vsize i = start_events_.size (); 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));)
+      for (vsize j = slur_infos_.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 (id == robust_scm2string (slur_infos_[j].slur_->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.
 
               if (!updown)
                 break;
 
-              Stream_event *c = unsmob_stream_event (slurs_[j]->get_property ("cause"));
+              Stream_event *c = unsmob_stream_event (slur_infos_[j].slur_->get_property ("cause"));
 
               if (!c)
                 {
-                  slurs_[j]->programming_error ("phrasing slur without a cause");
+                  slur_infos_[j].slur_->programming_error ("phrasing 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);
+                  slur_infos_[j].slur_->suicide ();
+                  for (vsize k = 0; k < slur_infos_[i].stubs_.size (); k++)
+                    slur_infos_[j].stubs_[k]->suicide ();
+                  slur_infos_.erase (slur_infos_.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 ("PhrasingSlur", ev->self_scm ());
           slur->set_property ("spanner-id", ly_string2scm (id));
           if (updown)
             set_grob_direction (slur, updown);
-          slurs_.push_back (slur);
+          slur_infos_.push_back (slur);
         }
     }
 }
 
 void
 Phrasing_slur_engraver::stop_translation_timestep ()
 {
   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);
+      for (vsize i = 0; i < end_slur_infos_.size (); i++)
+        Slur::add_extra_encompass (end_slur_infos_[i].slur_, 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++)
-    {
-      Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
+        for (vsize i = 0; i < slur_infos_.size (); i++)
+          Slur::add_extra_encompass (slur_infos_[i].slur_, g);
+    }
+
+  for (vsize i = 0; i < end_slur_infos_.size (); i++)
+    {
+      Spanner *s = dynamic_cast<Spanner *> (end_slur_infos_[i].slur_);
       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_);
-
-  for (vsize i = 0; i < end_slurs_.size (); i++)
-    if (slur_stubs_.find (end_slurs_[i]) != slur_stubs_.end ())
-      {
-        // We likely SlurStubs we don't need.  Get rid of them.
-        map<Grob *, Grob *> vag_to_slur;
-        for (vsize j = 0; j < slur_stubs_[end_slurs_[i]].size (); j++)
-          {
-            Grob *vag = Grob::get_vertical_axis_group (slur_stubs_[end_slurs_[i]][j]);
-            if (vag)
-              {
-                if (vag_to_slur.find (vag) != vag_to_slur.end ())
-                  slur_stubs_[end_slurs_[i]][j]->suicide ();
-                else
-                  vag_to_slur[vag] = slur_stubs_[end_slurs_[i]][j];
-              }
-            else
-              {
-                end_slurs_[i]->programming_error ("Cannot find vertical axis group for NoteColumn.");
-                slur_stubs_[end_slurs_[i]][j]->suicide ();
-              }
-          }
-        map<Grob *, Grob *>::const_iterator it;
-        for (it = vag_to_slur.begin ();
-             it != vag_to_slur.end ();
-             it++)
-          Slur::main_to_stub (end_slurs_[i], it->second);
-
-        slur_stubs_.erase (end_slurs_[i]);
-      }
+    Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slur_infos_, end_slur_infos_);
+
+  for (vsize i = 0; i < end_slur_infos_.size (); i++)
+    {
+      // There are likely SlurStubs we don't need. Get rid of them.
+      vector<Grob *> vags;
+      vector<Grob *> stubs;
+      for (vsize j = 0; j < end_slur_infos_[i].stubs_.size (); j++)
+        {
+          Grob *stub = end_slur_infos_[i].stubs_[j];
+          Grob *vag = Grob::get_vertical_axis_group (stub);
+          if (vag)
+            {
+              vector<Grob *>::const_iterator it =
+                find (vags.begin (), vags.end (), vag);
+              if (it != vags.end ())
+                stub->suicide ();
+              else
+                {
+                  vags.push_back (vag);
+                  stubs.push_back (stub);
+                }
+            }
+          else
+            {
+              end_slur_infos_[i].slur_->programming_error ("Cannot find vertical axis group for NoteColumn.");
+              stub->suicide ();
+            }
+        }
+      for (vsize j = 0; j < stubs.size (); j++)
+        Slur::main_to_stub (end_slur_infos_[i].slur_, stubs[j]);
+    }
 
   objects_to_acknowledge_.clear ();
-  end_slurs_.clear ();
+  end_slur_infos_.clear ();
   start_events_.clear ();
   stop_events_.clear ();
 }
 
 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, 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_END_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 ",
 
                 /* read */
                 "",
 
                 /* write */
                 ""
                );