]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie-engraver.cc
Run `make grand-replace'.
[lilypond.git] / lily / tie-engraver.cc
index 848c5b16a9ce7f09d0f854ee200071d793873d36..3d30e77738d9a4fe8403cda31830839f5052e866 100644 (file)
-/*   
-  ctie-engraver.cc --  implement Tie_engraver
-  
+/*
+  tie-engraver.cc -- implement Tie_engraver
+
   source file of the GNU LilyPond music typesetter
-  
-  (c) 1998--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
 
-#include "tie-engraver.hh"
-#include "command-request.hh"
+  (c) 1998--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
+
+#include "engraver.hh"
+
+#include "context.hh"
+#include "international.hh"
+#include "item.hh"
 #include "note-head.hh"
-#include "musical-request.hh"
+#include "protected-scm.hh"
+#include "spanner.hh"
+#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
+#include "tie-column.hh"
 #include "tie.hh"
-#include "translator-group.hh"
+#include "warn.hh"
+
+#include "translator.icc"
+
+/**
+   Manufacture ties.  Acknowledge noteheads, and put them into a
+   priority queue. If we have a TieEvent, connect the notes that finish
+   just at this time, and note that start at this time.
+
+   TODO: Remove the dependency on musical info. We should tie on the
+   basis of position and duration-log of the heads (not of the events).
+*/
+
+struct Head_event_tuple
+{
+  Grob *head_;
+  Moment end_moment_;
+  SCM tie_definition_;
+  Stream_event *tie_stream_event_;
+  Stream_event *tie_event_;
+  
+  Head_event_tuple ()
+  {
+    head_ = 0;
+    tie_definition_ = SCM_EOL;
+    tie_event_ = 0;
+    tie_stream_event_ = 0;
+  }
+};
+
+class Tie_engraver : public Engraver
+{
+  Stream_event *event_;
+  vector<Grob*> now_heads_;
+  vector<Head_event_tuple> heads_to_tie_;
+  vector<Grob*> ties_;
 
-Tie_engraver::Tie_engraver()
+  Spanner *tie_column_;
+
+protected:
+  void stop_translation_timestep ();
+  virtual void derived_mark () const;
+  void start_translation_timestep ();
+  DECLARE_ACKNOWLEDGER (note_head);
+  DECLARE_TRANSLATOR_LISTENER (tie);
+  void process_music ();
+  void typeset_tie (Grob *);
+public:
+  TRANSLATOR_DECLARATIONS (Tie_engraver);
+};
+
+void
+Tie_engraver::derived_mark () const
 {
-  req_l_ = 0;
+  Engraver::derived_mark ();
+  for (vsize i = 0; i < heads_to_tie_.size (); i++)
+    scm_gc_mark (heads_to_tie_[i].tie_definition_);
 }
 
+Tie_engraver::Tie_engraver ()
+{
+  event_ = 0;
+  tie_column_ = 0;
+}
 
-bool
-Tie_engraver::do_try_music (Music *m)
+IMPLEMENT_TRANSLATOR_LISTENER (Tie_engraver, tie);
+void
+Tie_engraver::listen_tie (Stream_event *ev)
 {
-  if (Tie_req * c = dynamic_cast<Tie_req*> (m))
-    {
-      req_l_ = c;
-      if (get_property ("automaticMelismas",0).to_bool ())
-       {
-         set_melisma (true);
-       }
-      return true;
-    }
-  return false;
+  ASSIGN_EVENT_ONCE (event_, ev);
 }
 
 void
-Tie_engraver::set_melisma (bool m)
+Tie_engraver::process_music ()
 {
-  Translator_group *where = daddy_trans_l_;
-  get_property ("tieMelismaBusy", &where);
-  if (!where)
-    where = daddy_trans_l_;
-    
-  daddy_trans_l_->set_property ("tieMelismaBusy", m ? "1" :"0");
+  bool busy = event_;
+  for (vsize i = 0; !busy && i < heads_to_tie_.size (); i++)
+    busy |=  (heads_to_tie_[i].tie_event_
+             || heads_to_tie_[i].tie_stream_event_);
+
+  if (busy)
+    context ()->set_property ("tieMelismaBusy", SCM_BOOL_T);
 }
 
 void
-Tie_engraver::acknowledge_element (Score_element_info i)
+Tie_engraver::acknowledge_note_head (Grob_info i)
 {
-  if (Note_head *nh = dynamic_cast<Note_head *> (i.elem_l_))
+  Grob *h = i.grob ();
+
+  now_heads_.push_back (h);
+  for (vsize i = heads_to_tie_.size (); i--;)
     {
-      Note_req * m = dynamic_cast<Note_req* > (i.req_l_);
-      if (!m)
-       return;
-      now_heads_.push (CHead_melodic_tuple (nh, m, now_mom()+ m->length_mom ()));
+      Grob *th = heads_to_tie_[i].head_;
+      Stream_event *right_ev = unsmob_stream_event (h->get_property ("cause"));
+      Stream_event *left_ev = unsmob_stream_event (th->get_property ("cause"));
+
+      /*
+       maybe should check positions too.
+      */
+      if (!right_ev || !left_ev)
+       continue;
+      
+      if (ly_is_equal (right_ev->get_property ("pitch"),
+                      left_ev->get_property ("pitch")))
+       {
+         Grob *p = new Spanner (heads_to_tie_[i].tie_definition_);
+
+         SCM cause = heads_to_tie_[i].tie_event_
+           ? heads_to_tie_[i].tie_event_->self_scm ()
+           : heads_to_tie_[i].tie_stream_event_->self_scm ();
+         
+         announce_grob (p, cause);
+         Tie::set_head (p, LEFT, th);
+         Tie::set_head (p, RIGHT, h);
+
+
+         if (is_direction (unsmob_stream_event (cause)->get_property ("direction")))
+           {
+             Direction d = to_dir (unsmob_stream_event (cause)->get_property ("direction"));
+             p->set_property ("direction", scm_from_int (d)); 
+           }
+         
+         ties_.push_back (p);
+         heads_to_tie_.erase (heads_to_tie_.begin () + i);
+       }
     }
+
+  if (ties_.size () && ! tie_column_)
+    tie_column_ = make_spanner ("TieColumn", ties_[0]->self_scm ());
+
+  if (tie_column_)
+    for (vsize i = ties_.size (); i--;)
+      Tie_column::add_tie (tie_column_, ties_[i]);
 }
 
 void
-Tie_engraver::do_process_requests ()
+Tie_engraver::start_translation_timestep ()
 {
-  if (req_l_)
+  context ()->set_property ("tieMelismaBusy",
+                           ly_bool2scm (heads_to_tie_.size ()));
+
+  if (heads_to_tie_.size () && !to_boolean (get_property ("tieWaitForNote")))
     {
       Moment now = now_mom ();
-      Link_array<Note_head> nharr;
-      
-      stopped_heads_.clear ();
-      while (past_notes_pq_.size ()
-            && past_notes_pq_.front ().end_ == now)
-       stopped_heads_.push (past_notes_pq_.get ());
+      for (vsize i = heads_to_tie_.size ();  i--; )
+       {
+         if (now > heads_to_tie_[i].end_moment_)
+           heads_to_tie_.erase (heads_to_tie_.begin () + i);
+       }
     }
 }
 
 void
-Tie_engraver::process_acknowledged ()
+Tie_engraver::stop_translation_timestep ()
 {
-  bool old_behavior = get_property ("oldTieBehavior", 0).to_bool ();
-  
-  if (req_l_)
+  bool wait = to_boolean (get_property ("tieWaitForNote"));
+  if (ties_.size ())
     {
+      if (!wait)
+       heads_to_tie_.clear ();
 
-      /*
-       JUNKME!
-       */
-      if (old_behavior)
-       {
-         if (now_heads_.size () != stopped_heads_.size ())
-           {
-             req_l_->warning ("Unequal number of note heads for tie");
-           }
-         int sz = now_heads_.size () <? stopped_heads_.size ();
+      for (vsize i = 0; i < ties_.size (); i++)
+         typeset_tie (ties_[i]);
 
-         /* hmm. Should do something more sensible.
-       because, we assume no more noteheads come along after the 1st pass.
-         */
-         if (sz <= tie_p_arr_.size ())
-           return;
+      ties_.clear ();
+      tie_column_ = 0;
+    }
 
-         now_heads_.sort (CHead_melodic_tuple::pitch_compare);
-         stopped_heads_.sort(CHead_melodic_tuple::pitch_compare);
+  vector<Head_event_tuple> new_heads_to_tie;
+  
+  for (vsize i = 0; i < now_heads_.size (); i++)
+    {
+      Grob *head = now_heads_[i];
+      Stream_event *left_ev
+       = unsmob_stream_event (head->get_property ("cause"));
 
-         for (int i=0; i < sz; i++)
-           {
-             Tie * p = new Tie;
-             p->set_head (LEFT, stopped_heads_[i].head_l_);
-             p->set_head (RIGHT, now_heads_[i].head_l_);
-             tie_p_arr_.push (p);
-             announce_element (Score_element_info (p, req_l_));
-           }
+      if (!left_ev)
+       {
+         // may happen for ambituses
+         continue;
        }
-      else
+           
+      
+      SCM left_articulations = left_ev->get_property ("articulations");
+
+      Stream_event *tie_event = 0;
+      Stream_event *tie_stream_event = event_;
+      for (SCM s = left_articulations;
+          !tie_event && !tie_stream_event && scm_is_pair (s);
+          s = scm_cdr (s))
+       {
+         Stream_event *ev = unsmob_stream_event (scm_car (s));
+         if (!ev)
+           continue;
+         
+         if (ev->in_event_class ("tie-event"))
+           tie_event = ev;
+       }
+         
+      if (left_ev && (tie_event || tie_stream_event))
        {
-         now_heads_.sort (CHead_melodic_tuple::pitch_compare);
-         stopped_heads_.sort(CHead_melodic_tuple::pitch_compare);
-         int i=0;
-         int j=0;
-         int tie_count=0;
-         while  ( i < now_heads_.size () && j < stopped_heads_.size ())
+         Head_event_tuple event_tup;
+
+         SCM start_definition
+           = updated_grob_properties (context (), ly_symbol2scm ("Tie"));
+
+         event_tup.head_ = head;
+         event_tup.tie_definition_ = start_definition;
+         event_tup.tie_event_ = tie_event;
+         event_tup.tie_stream_event_ = tie_stream_event;
+
+         Moment end = now_mom ();
+         if (end.grace_part_)
            {
-             int comp
-               = Musical_pitch::compare (now_heads_[i].req_l_->pitch_ ,
-                                         stopped_heads_[j].req_l_->pitch_);
-
-             if (comp)
-               {
-                 (comp < 0) ? i ++ : j++;
-                 continue;
-               }
-             else
-               {
-                 tie_count ++;
-
-                 /* don't go around recreating ties that were already
-                 made. Not infallible. Due to reordering in sort (),
-                 we will make the wrong ties when noteheads are
-                 added.  */
-                 if (tie_count > tie_p_arr_.size ())
-                   {
-                     Tie * p = new Tie;
-                     p->set_head (LEFT, stopped_heads_[j].head_l_);
-                     p->set_head (RIGHT, now_heads_[i].head_l_);
-                     tie_p_arr_.push (p);
-                     announce_element (Score_element_info (p, req_l_));
-                   }
-                 i++;
-                 j++;
-
-               }
+             end.grace_part_ += get_event_length (left_ev).main_part_;
            }
-
-         if (!tie_p_arr_.size ())
+         else
            {
-             req_l_->warning (_("No ties were created!"));
+             end += get_event_length (left_ev);
            }
-         
+         event_tup.end_moment_ = end;
+           
+         new_heads_to_tie.push_back (event_tup);
        }
     }
-}
 
-void
-Tie_engraver::do_pre_move_processing ()
-{
-  for (int i=0; i < now_heads_.size (); i++)
-    {
-      past_notes_pq_.insert (now_heads_[i]);
-    }
-  now_heads_.clear ();
+  if (!wait && new_heads_to_tie.size ())
+    heads_to_tie_.clear ();
 
-  Scalar dir (get_property ("tieVerticalDirection", 0));
-  Scalar dir2 (get_property ("verticalDirection", 0));
-
-  Direction tie_dir = CENTER;
-  if (dir.length_i () && dir.isnum_b ())
-    tie_dir = (Direction) sign (int(dir));
-  else if (dir2.length_i () && dir2.isnum_b ())
-    tie_dir = (Direction) sign (int (dir2));
+  // hmmm, how to do with copy () ?
+  for (vsize i = 0; i < new_heads_to_tie.size (); i++)
+    heads_to_tie_.push_back (new_heads_to_tie[i]);
   
-  for (int i=0; i<  tie_p_arr_.size (); i++)
-   {
-      tie_p_arr_[i]->dir_ = tie_dir;
-      typeset_element (tie_p_arr_[i]);
-    }
-  tie_p_arr_.clear ();
+  event_ = 0;
+  now_heads_.clear ();
 }
 
 void
-Tie_engraver::do_post_move_processing ()
+Tie_engraver::typeset_tie (Grob *her)
 {
-  if (get_property ("automaticMelismas",0).to_bool ())
+  if (! (Tie::head (her, LEFT) && Tie::head (her, RIGHT)))
+    warning (_ ("lonely tie"));
+
+  Direction d = LEFT;
+  Drul_array<Grob *> new_head_drul;
+  new_head_drul[LEFT] = Tie::head (her, LEFT);
+  new_head_drul[RIGHT] = Tie::head (her, RIGHT);
+  do
     {
-      set_melisma (false);
+      if (!Tie::head (her, d))
+       new_head_drul[d] = Tie::head (her, (Direction) - d);
     }
-  req_l_ = 0;
-  Moment now = now_mom ();
-  while (past_notes_pq_.size () && past_notes_pq_.front ().end_ < now)
-    past_notes_pq_.delmin ();
-}
+  while (flip (&d) != LEFT);
 
-ADD_THIS_TRANSLATOR(Tie_engraver);
-
-
-CHead_melodic_tuple::CHead_melodic_tuple ()
-{
-  head_l_ =0;
-  req_l_ =0;
-  end_ = 0;
+  Spanner *sp = dynamic_cast<Spanner*> (her);
+  sp->set_bound (LEFT, new_head_drul[LEFT]);
+  sp->set_bound (RIGHT, new_head_drul[RIGHT]);
 }
 
-CHead_melodic_tuple::CHead_melodic_tuple (Note_head *h, Melodic_req*m, Moment mom)
-{
-  head_l_ = h;
-  req_l_ = m;
-  end_ = mom;
-}
+ADD_ACKNOWLEDGER (Tie_engraver, note_head);
+ADD_TRANSLATOR (Tie_engraver,
+               /* doc */
+               "Generate ties between note heads of equal pitch.",
 
-int
-CHead_melodic_tuple::pitch_compare (CHead_melodic_tuple const&h1,
-                            CHead_melodic_tuple const &h2)
-{
-  return Melodic_req::compare (*h1.req_l_, *h2.req_l_);
-}
+               /* create */
+               "Tie "
+               "TieColumn ",
 
-int
-CHead_melodic_tuple::time_compare (CHead_melodic_tuple const&h1,
-                            CHead_melodic_tuple const &h2)
-{
-  return (h1.end_ - h2.end_ ).sign ();
-}
+               /* read */
+               "tieWaitForNote ",
+
+               /* write */
+               "tieMelismaBusy "
+               );