]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur-engraver.cc
Web-ja: update introduction
[lilypond.git] / lily / slur-engraver.cc
index 348e9e2014f282eaa35533185ed108f01eefd41c..2309f114de1948d134d2fb03a0a79989a0618807 100644 (file)
 /*
-  slur-engraver.cc -- implement Slur_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2008 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.
 
-#include "engraver.hh"
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
 #include "context.hh"
 #include "directional-element-interface.hh"
 #include "international.hh"
 #include "note-column.hh"
+#include "pointer-group-interface.hh"
+#include "slur-engraver.hh"
 #include "slur.hh"
 #include "spanner.hh"
-#include "stream-event.hh"
 #include "warn.hh"
 
 #include "translator.icc"
 
+SCM
+Slur_engraver::event_symbol () const
+{
+  return ly_symbol2scm ("slur-event");
+}
 
-/*
-  NOTE NOTE NOTE
+bool
+Slur_engraver::double_property () const
+{
+  return to_boolean (get_property ("doubleSlurs"));
+}
 
-  This is largely similar to Phrasing_slur_engraver. Check if fixes
-  apply there too.
+SCM
+Slur_engraver::grob_symbol () const
+{
+  return ly_symbol2scm ("Slur");
+}
 
-  (on principle, engravers don't use inheritance for code sharing)
-  
- */
+const char *
+Slur_engraver::object_name () const
+{
+  return "slur";
+}
 
-/*
-  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
+Slur_engraver::Slur_engraver (Context *c)
+  : Engraver (c)
 {
-  Drul_array<Stream_event *> events_;
-  Stream_event *running_slur_start_;
-  vector<Grob*> slurs_;
-  vector<Grob*> end_slurs_;
+}
 
-  void set_melisma (bool);
+void
+Slur_engraver::set_melisma (bool m)
+{
+  context ()->set_property ("slurMelismaBusy", ly_bool2scm (m));
+}
 
-protected:
-  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
+Slur_engraver::boot ()
+{
+  ADD_LISTENER (Slur_engraver, slur);
+  ADD_LISTENER (Slur_engraver, note);
+  ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, inline_accidental);
+  ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, fingering);
+  ADD_ACKNOWLEDGER (Slur_engraver, note_column);
+  ADD_ACKNOWLEDGER (Slur_engraver, script);
+  ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, text_script);
+  ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, dots);
+  ADD_END_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, tie);
+  ADD_ACKNOWLEDGER_FOR (Slur_engraver, extra_object, tuplet_number);
+}
 
-  void acknowledge_extra_object (Grob_info);
-  void stop_translation_timestep ();
-  void process_music ();
+ADD_TRANSLATOR (Slur_engraver,
+                /* doc */
+                "Build slur grobs from slur events.",
 
-  virtual void finalize ();
+                /* create */
+                "Slur ",
 
+                /* read */
+                "slurMelismaBusy "
+                "doubleSlurs ",
 
-public:
-  TRANSLATOR_DECLARATIONS (Slur_engraver);
-};
+                /* write */
+                ""
+               );
 
-Slur_engraver::Slur_engraver ()
+void
+Slur_engraver::derived_mark () const
 {
-  events_[START] = events_[STOP] = 0;
+  for (vsize i = start_events_.size (); i--;)
+    {
+      scm_gc_mark (start_events_[i].slur_->self_scm ());
+      if (start_events_[i].note_)
+        scm_gc_mark (start_events_[i].note_->self_scm ());
+    }
+  for (vsize i = stop_events_.size (); i--;)
+    {
+      scm_gc_mark (stop_events_[i].slur_->self_scm ());
+      if (stop_events_[i].note_)
+        scm_gc_mark (stop_events_[i].note_->self_scm ());
+    }
 }
 
-IMPLEMENT_TRANSLATOR_LISTENER (Slur_engraver, slur);
 void
-Slur_engraver::listen_slur (Stream_event *ev)
+Slur_engraver::listen_note_slur (Stream_event *ev, Stream_event *note)
 {
   Direction d = to_dir (ev->get_property ("span-direction"));
   if (d == START)
-    ASSIGN_EVENT_ONCE (events_[START], ev);
+    start_events_.push_back (Event_info (ev, note));
   else if (d == STOP)
-    ASSIGN_EVENT_ONCE (events_[STOP], ev);
+    stop_events_.push_back (Event_info (ev, note));
   else ev->origin ()->warning (_f ("direction of %s invalid: %d",
-                                  "slur-event", int (d)));
+                                   ev->name ().c_str (),
+                                   int (d)));
 }
 
 void
-Slur_engraver::set_melisma (bool m)
+Slur_engraver::listen_note (Stream_event *ev)
 {
-  context ()->set_property ("slurMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
+  for (SCM arts = ev->get_property ("articulations");
+       scm_is_pair (arts); arts = scm_cdr (arts))
+    {
+      Stream_event *art = unsmob<Stream_event> (scm_car (arts));
+      if (art->in_event_class (event_symbol ()))
+        listen_note_slur (art, ev);
+    }
 }
 
 void
@@ -97,143 +144,225 @@ Slur_engraver::acknowledge_note_column (Grob_info info)
     Slur::add_column (slurs_[i], e);
   for (vsize i = end_slurs_.size (); i--;)
     Slur::add_column (end_slurs_[i], e);
+  // Now cater for slurs starting/ending at a notehead: those override
+  // the column bounds
+  if (note_slurs_[START].empty () && note_slurs_[STOP].empty ())
+    return;
+  extract_grob_set (e, "note-heads", heads);
+  for (vsize i = heads.size (); i--;)
+    {
+      if (Stream_event *ev =
+          unsmob<Stream_event> (heads[i]->get_property ("cause")))
+        for (LEFT_and_RIGHT (d))
+          {
+            std::pair<Note_slurs::const_iterator, Note_slurs::const_iterator> its
+              = note_slurs_[d].equal_range (ev);
+            for (Note_slurs::const_iterator it = its.first;
+                 it != its.second;
+                 ++it)
+              it->second->set_bound (d, heads[i]);
+          }
+    }
 }
 
 void
 Slur_engraver::acknowledge_extra_object (Grob_info info)
 {
-  Slur::auxiliary_acknowledge_extra_object (info, slurs_, end_slurs_);
+  objects_to_acknowledge_.push_back (info);
 }
 
 void
-Slur_engraver::acknowledge_accidental (Grob_info info)
+Slur_engraver::acknowledge_script (Grob_info info)
 {
-  acknowledge_extra_object (info);
+  if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
+    acknowledge_extra_object (info);
 }
 
 void
-Slur_engraver::acknowledge_fingering (Grob_info info)
+Slur_engraver::finalize ()
 {
-  acknowledge_extra_object (info);
+  for (vsize i = 0; i < slurs_.size (); i++)
+    {
+      slurs_[i]->warning (_f ("unterminated %s", object_name ()));
+      slurs_[i]->suicide ();
+    }
+  slurs_.clear ();
 }
 
 void
-Slur_engraver::acknowledge_tuplet_number (Grob_info info)
+Slur_engraver::create_slur (SCM spanner_id, Event_info evi, Grob *g_cause, Direction dir, bool left_broken)
 {
-  acknowledge_extra_object (info);
-}
+  Grob *ccc = left_broken
+    ? unsmob<Grob> (get_property ("currentCommandColumn"))
+    : 0; // efficiency
+  SCM cause = evi.slur_ ? evi.slur_->self_scm () : g_cause->self_scm ();
+  Spanner *slur = make_spanner (grob_symbol (), cause);
+  slur->set_property ("spanner-id", spanner_id);
+  if (dir)
+    set_grob_direction (slur, dir);
+  if (left_broken)
+    slur->set_bound (LEFT, ccc);
+  slurs_.push_back (slur);
+  if (evi.note_)
+    note_slurs_[START].insert (Note_slurs::value_type (evi.note_, slur));
+
+  if (double_property ())
+  {
+    set_grob_direction (slur, DOWN);
+    slur = make_spanner (grob_symbol (), cause);
+    slur->set_property ("spanner-id", spanner_id);
+    set_grob_direction (slur, UP);
+    if (left_broken)
+      slur->set_bound (LEFT, ccc);
+    slurs_.push_back (slur);
+    if (evi.note_)
+      note_slurs_[START].insert(Note_slurs::value_type (evi.note_, slur));
+  }
 
-
-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)
+bool
+Slur_engraver::can_create_slur (SCM id, vsize old_slurs, vsize *event_idx, Stream_event *ev)
 {
-  acknowledge_extra_object (info);
-}
+  for (vsize j = slurs_.size (); j--;)
+    {
+      Grob *slur = slurs_[j];
+      Direction updown = to_dir (ev->get_property ("direction"));
 
-void
-Slur_engraver::acknowledge_tie (Grob_info info)
-{
-  acknowledge_extra_object (info);
+      // Check if we already have a slur with the same spanner-id.
+      if (ly_is_equal (id, 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 (_f ("already have %s", object_name ()));
+              if (event_idx)
+                start_events_.erase (start_events_.begin () + (*event_idx));
+              return false;
+            }
+
+          // 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)
+            return false;
+
+          Stream_event *c = unsmob<Stream_event> (slur->get_property ("cause"));
+
+          if (!c)
+            {
+              slur->programming_error (_f ("%s without a cause", object_name ()));
+              return true;
+            }
+
+          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)
+            {
+              slur->suicide ();
+              slurs_.erase (slurs_.begin () + j);
+              return true;
+            }
+
+          // If the existing slur has the same direction as ours, drop ours
+
+          if (slur_dir == updown)
+            return false;
+        }
+    }
+  return true;
 }
 
-void
-Slur_engraver::finalize ()
+bool
+Slur_engraver::try_to_end (Event_info evi)
 {
-  if (slurs_.size ())
+  SCM id = evi.slur_->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--;)
     {
-      slurs_[0]->warning (_ ("unterminated slur"));
-      for (vsize i = 0; i < slurs_.size (); i++)
-       slurs_[i]->suicide ();
+      if (ly_is_equal (id, slurs_[j]->get_property ("spanner-id")))
+        {
+          ended = true;
+          end_slurs_.push_back (slurs_[j]);
+          if (evi.note_)
+            note_slurs_[STOP].insert
+              (Note_slurs::value_type
+               (evi.note_, dynamic_cast <Spanner *> (slurs_[j])));
+          slurs_.erase (slurs_.begin () + j);
+        }
     }
+  return ended;
 }
 
 void
 Slur_engraver::process_music ()
 {
-  if (events_[STOP])
+  for (vsize i = 0; i < stop_events_.size (); i++)
     {
-      if (slurs_.size () == 0)
-       events_[STOP]->origin ()->warning (_ ("cannot end slur"));
-
-      
-      end_slurs_ = slurs_;
-      slurs_.clear ();
+      SCM id = stop_events_[i].slur_->get_property ("spanner-id");
+      bool ended = try_to_end (stop_events_[i]);
+      if (ended)
+        {
+          // Ignore redundant stop events for this id
+          for (vsize j = stop_events_.size (); --j > i;)
+            {
+              if (ly_is_equal (id, stop_events_[j].slur_->get_property ("spanner-id")))
+                stop_events_.erase (stop_events_.begin () + j);
+            }
+        }
+      else
+        stop_events_[i].slur_->origin ()->warning (_f ("cannot end %s", object_name ()));
     }
 
-  if (events_[START] && slurs_.empty ())
+  vsize old_slurs = slurs_.size ();
+  for (vsize i = start_events_.size (); i--;)
     {
-      Stream_event *ev = events_[START];
-
-      bool double_slurs = to_boolean (get_property ("doubleSlurs"));
-
-      Grob *slur = make_spanner ("Slur", events_[START]->self_scm ());
+      Stream_event *ev = start_events_[i].slur_;
+      SCM id = ev->get_property ("spanner-id");
       Direction updown = to_dir (ev->get_property ("direction"));
-      if (updown && !double_slurs)
-       set_grob_direction (slur, updown);
-
-      slurs_.push_back (slur);
-
-      if (double_slurs)
-       {
-         set_grob_direction (slur, DOWN);
-         slur = make_spanner ("Slur", events_[START]->self_scm ());
-         set_grob_direction (slur, UP);
-         slurs_.push_back (slur);
-       }
+
+      if (can_create_slur (id, old_slurs, &i, ev))
+        create_slur (id, start_events_[i], 0, updown, false);
     }
+
   set_melisma (slurs_.size ());
 }
 
 void
 Slur_engraver::stop_translation_timestep ()
 {
-  if (Grob *g = unsmob_grob (get_property ("currentCommandColumn")))
+  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);
+        Slur::add_extra_encompass (end_slurs_[i], g);
 
-      if (!events_[START])
-       for (vsize i = 0; i < slurs_.size (); i++)
-         Slur::add_extra_encompass (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++)
     {
-      Spanner * s = dynamic_cast<Spanner*> (end_slurs_[i]);
+      Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
       if (!s->get_bound (RIGHT))
-       s->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
+        s->set_bound (RIGHT, unsmob<Grob> (get_property ("currentMusicalColumn")));
       announce_end_grob (s, SCM_EOL);
     }
-  end_slurs_.clear ();
-  events_[START] = events_[STOP] = 0;
-}
-
-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 ",
+  for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
+    Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
 
-               /* write */
-               ""
-               );
+  note_slurs_[LEFT].clear ();
+  note_slurs_[RIGHT].clear ();
+  objects_to_acknowledge_.clear ();
+  end_slurs_.clear ();
+  start_events_.clear ();
+  stop_events_.clear ();
+}