]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur-engraver.cc
Imported Upstream version 2.19.47
[lilypond.git] / lily / slur-engraver.cc
index 4553e4dcba6c96afa67f527a683903fac61cae5c..80ceb5f431fdf700dddc2000b95044ac9ff3f023 100644 (file)
 /*
-  slur-grav.cc -- implement Slur_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Copyright (C) 1997--2015 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 "proto.hh"
-#include "musical-request.hh"
+#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 "debug.hh"
-#include "note-column.hh"
-#include "translator-group.hh"
+#include "spanner.hh"
+#include "warn.hh"
+
+#include "translator.icc"
+
+SCM
+Slur_engraver::event_symbol () const
+{
+  return ly_symbol2scm ("slur-event");
+}
 
 bool
-Slur_engraver::do_try_music (Music *req_l)
+Slur_engraver::double_property () const
 {
-  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 to_boolean (get_property ("doubleSlurs"));
+}
 
-      return true;
-    }
-  return false;
+SCM
+Slur_engraver::grob_symbol () const
+{
+  return ly_symbol2scm ("Slur");
+}
+
+const char *
+Slur_engraver::object_name () const
+{
+  return "slur";
+}
+
+Slur_engraver::Slur_engraver ()
+{
 }
 
 void
 Slur_engraver::set_melisma (bool m)
 {
-  Translator_group *where = daddy_trans_l_;
-  get_property ("slurMelismaBusy", &where);
-  if (!where)
-    where = daddy_trans_l_;
-    
-  daddy_trans_l_->set_property ("slurMelismaBusy", m ? "1" :"0");
+  context ()->set_property ("slurMelismaBusy", ly_bool2scm (m));
 }
 
 void
-Slur_engraver::acknowledge_element (Score_element_info info)
+Slur_engraver::boot ()
 {
-  if (dynamic_cast<Note_column *> (info.elem_l_))
+  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);
+}
+
+ADD_TRANSLATOR (Slur_engraver,
+                /* doc */
+                "Build slur grobs from slur events.",
+
+                /* create */
+                "Slur ",
+
+                /* read */
+                "slurMelismaBusy "
+                "doubleSlurs ",
+
+                /* write */
+                ""
+               );
+
+void
+Slur_engraver::derived_mark () const
+{
+  for (vsize i = start_events_.size (); i--;)
     {
-      Note_column *col_l =dynamic_cast<Note_column *> (info.elem_l_) ;// ugh
-      for (int i = 0; i < slur_l_stack_.size(); i++)
-       slur_l_stack_[i]->add_column (col_l);
-      for (int i = 0; i < end_slur_l_arr_.size(); i++)
-       end_slur_l_arr_[i]->add_column (col_l);
+      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 ());
+    }
+}
+
+void
+Slur_engraver::listen_note_slur (Stream_event *ev, Stream_event *note)
+{
+  Direction d = to_dir (ev->get_property ("span-direction"));
+  if (d == START)
+    start_events_.push_back (Event_info (ev, note));
+  else if (d == STOP)
+    stop_events_.push_back (Event_info (ev, note));
+  else ev->origin ()->warning (_f ("direction of %s invalid: %d",
+                                   ev->name ().c_str (),
+                                   int (d)));
 }
 
 void
-Slur_engraver::do_removal_processing ()
+Slur_engraver::listen_note (Stream_event *ev)
 {
-  for (int i = 0; i < slur_l_stack_.size(); i++)
+  for (SCM arts = ev->get_property ("articulations");
+       scm_is_pair (arts); arts = scm_cdr (arts))
     {
-      typeset_element (slur_l_stack_[i]);
+      Stream_event *art = unsmob<Stream_event> (scm_car (arts));
+      if (art->in_event_class (event_symbol ()))
+        listen_note_slur (art, ev);
     }
-  slur_l_stack_.clear ();
-  if (!get_property ("weAreGraceContext",0).to_bool ())
-    for (int i=0; i < requests_arr_.size(); i++)
-      {
-       requests_arr_[i]->warning (_ ("unterminated slur"));
-      }
 }
 
 void
-Slur_engraver::do_process_requests()
+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);
+  // 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)
+{
+  objects_to_acknowledge_.push_back (info);
+}
+
+void
+Slur_engraver::acknowledge_script (Grob_info info)
 {
-  Array<Slur*> start_slur_l_arr_;
-  for (int i=0; i< new_slur_req_l_arr_.size(); i++)
+  if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
+    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->warning (_f ("can't find both ends of %s", _("slur")));
-         else
-           {
-             end_slur_l_arr_.push (slur_l_stack_.pop());
-             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)
-         Slur * s_p =new Slur;
-         Scalar prop = get_property ("slurDash", 0);
-         if (prop.isnum_b ()) 
-           s_p->set_elt_property (dashed_scm_sym, gh_int2scm(prop));
-
-         
-         requests_arr_.push (slur_req_l);
-         start_slur_l_arr_.push (s_p);
-         announce_element (Score_element_info (s_p, slur_req_l));
-       }
+      slurs_[i]->warning (_f ("unterminated %s", object_name ()));
+      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()
-{
-  Scalar dir (get_property ("slurVerticalDirection", 0));
-  Scalar dir2 (get_property ("verticalDirection", 0));
-
-  Direction slurdir = CENTER;
-  if (dir.length_i () && dir.isnum_b ())
-    slurdir = (Direction) sign (int(dir));
-  else if (dir2.length_i () && dir2.isnum_b ())
-    slurdir = (Direction) sign (int (dir2));
-  
-  for (int i = 0; i < end_slur_l_arr_.size(); i++)
+Slur_engraver::create_slur (SCM spanner_id, Event_info evi, Grob *g_cause, Direction dir, bool left_broken)
+{
+  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));
+  }
+
+}
+
+bool
+Slur_engraver::can_create_slur (SCM id, vsize old_slurs, vsize *event_idx, Stream_event *ev)
+{
+  for (vsize j = slurs_.size (); j--;)
     {
-      end_slur_l_arr_[i]->dir_ = slurdir;
-      typeset_element (end_slur_l_arr_[i]);
+      Grob *slur = slurs_[j];
+      Direction updown = to_dir (ev->get_property ("direction"));
+
+      // 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;
+        }
     }
-  end_slur_l_arr_.clear();
+  return true;
+}
+
+bool
+Slur_engraver::try_to_end (Event_info evi)
+{
+  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--;)
+    {
+      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::do_post_move_processing()
+Slur_engraver::process_music ()
 {
-  new_slur_req_l_arr_.clear();
-  if (get_property ("automaticMelismata",0).to_bool ())
+  for (vsize i = 0; i < stop_events_.size (); i++)
     {
-      set_melisma (slur_l_stack_.size ());
+      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 ()));
     }
+
+  vsize old_slurs = slurs_.size ();
+  for (vsize i = start_events_.size (); i--;)
+    {
+      Stream_event *ev = start_events_[i].slur_;
+      SCM id = ev->get_property ("spanner-id");
+      Direction updown = to_dir (ev->get_property ("direction"));
+
+      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")))
+    {
+      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);
+    }
 
-ADD_THIS_TRANSLATOR(Slur_engraver);
+  for (vsize i = 0; i < end_slurs_.size (); i++)
+    {
+      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_);
+
+  note_slurs_[LEFT].clear ();
+  note_slurs_[RIGHT].clear ();
+  objects_to_acknowledge_.clear ();
+  end_slurs_.clear ();
+  start_events_.clear ();
+  stop_events_.clear ();
+}