]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie-engraver.cc
*** empty log message ***
[lilypond.git] / lily / tie-engraver.cc
index 351dc4442a979ff24ecc070817f18f3a92afae79..e5f9efddf9cb953c35d2d0af184c61a77600db66 100644 (file)
@@ -3,32 +3,75 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1998--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1998--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
 
-#include "tie-engraver.hh"
 #include "command-request.hh"
-#include "note-head.hh"
 #include "musical-request.hh"
 #include "tie.hh"
 #include "translator-group.hh"
+#include "spanner.hh"
+#include "tie-column.hh"
+#include "engraver.hh"
+#include "item.hh"
+#include "grob-pitch-tuple.hh"
+#include "warn.hh"
+#include "note-head.hh"
+
+/**
+   Manufacture ties.  Acknowledge noteheads, and put them into a
+   priority queue. If we have a Tie_req, 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 reqs).
+
+*/
+class Tie_engraver : public Engraver
+{
+  Moment end_mom_;
+  Moment next_end_mom_;
+
+  Tie_req *req_;
+  Link_array<Grob> now_heads_;
+  Link_array<Grob> stopped_heads_;
+  Link_array<Grob> ties_;
+
+  Spanner * tie_column_;
+  
+  void set_melisma (bool);
+  
+protected:
+  virtual void start_translation_timestep ();
+  virtual void stop_translation_timestep ();
+  virtual void acknowledge_grob (Grob_info);
+  virtual bool try_music (Music*);
+  virtual void process_acknowledged_grobs ();
+  void typeset_tie (Grob*);
+public:
+  TRANSLATOR_DECLARATIONS(Tie_engraver);
+};
 
-ADD_THIS_TRANSLATOR (Tie_engraver);
 
-Tie_engraver::Tie_engraver()
+
+Tie_engraver::Tie_engraver ()
 {
-  req_l_ = 0;
+  req_ = 0;
+  tie_column_ = 0;
 }
 
 
 bool
-Tie_engraver::do_try_music (Music *m)
+Tie_engraver::try_music (Music *m)
 {
   if (Tie_req * c = dynamic_cast<Tie_req*> (m))
     {
-      req_l_ = c;
-      SCM m = get_property ("automaticMelismata",0);
+      /*      if (end_mom_ > now_mom ())
+       return false;
+      */
+      req_ = c;
+      SCM m = get_property ("automaticMelismata");
       bool am = gh_boolean_p (m) &&gh_scm2bool (m);
       if (am)
        {
@@ -42,81 +85,65 @@ Tie_engraver::do_try_music (Music *m)
 void
 Tie_engraver::set_melisma (bool m)
 {
-  Translator_group *where = daddy_trans_l_;
-  get_property ("tieMelismaBusy", &where);
-  if (!where)
-    where = daddy_trans_l_;
-    
-  daddy_trans_l_->set_property ("tieMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
+  daddy_trans_->set_property ("tieMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
 }
 
 void
-Tie_engraver::acknowledge_element (Score_element_info i)
+Tie_engraver::acknowledge_grob (Grob_info i)
 {
-  if (Note_head *nh = dynamic_cast<Note_head *> (i.elem_l_))
+  if (Note_head::has_interface (i.grob_))
     {
-      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 ()));
+      now_heads_.push (i.grob_);
     }
 }
 
-void
-Tie_engraver::do_process_requests ()
+int
+head_pitch_compare (Grob  *const&a,Grob  *const&b)
 {
-  if (req_l_)
-    {
-      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 ());
-    }
+  Music *m1 =unsmob_music (a->get_grob_property ("cause"));
+  Music *m2 =unsmob_music (b->get_grob_property ("cause"));  
+
+  return Pitch::compare (* unsmob_pitch (m1->get_mus_property ("pitch")),
+                        * unsmob_pitch (m2->get_mus_property ("pitch")));
 }
 
 void
-Tie_engraver::process_acknowledged ()
+Tie_engraver::process_acknowledged_grobs ()
 {
-  if (req_l_)
+  if (req_)
     {
-      now_heads_.sort (CHead_melodic_tuple::pitch_compare);
-      stopped_heads_.sort(CHead_melodic_tuple::pitch_compare);
+      now_heads_.sort (&head_pitch_compare);
+      /*
+       We could sort stopped_heads_ as well (and use a linear alg. in
+       stead of nested loop), but we'd have to use a stable sorting
+       algorithm, since the ordering of the stopped heads (of the
+       same pitch) is relevant.
+       */
 
       SCM head_list = SCM_EOL;
       
-      int j = stopped_heads_.size ()-1;
-      int i = now_heads_.size ()-1;
-
-      while  (i >= 0 && j >=0)
+      for (int i = now_heads_.size(); i--;)
        {
-         int comp
-           = Musical_pitch::compare (now_heads_[i].req_l_->pitch_ ,
-                                     stopped_heads_[j].req_l_->pitch_);
-
-         if (comp)
+         for (int j = stopped_heads_.size(); j--;)
            {
-             (comp < 0) ? j -- : i--;
-             continue;
-           }
-         else
-           {
-             head_list  = gh_cons (gh_cons (stopped_heads_[j].head_l_->self_scm_,
-                                            now_heads_[i].head_l_->self_scm_),
-                                   head_list);
-
-             past_notes_pq_. insert (now_heads_[i]);
-             now_heads_.del (i);
-             stopped_heads_.del (j);
-             i--;
-             j--;
-           }
-       }
+             int comp
+               = head_pitch_compare (now_heads_[i], stopped_heads_[j]);
 
+             if (!comp)
+               {
+                 head_list  = gh_cons (gh_cons (stopped_heads_[j]->self_scm (),
+                                                now_heads_[i]->self_scm ()),
+                                       head_list);
 
-      SCM sparse = get_property ("sparseTies", 0);
+                 now_heads_.del (i);
+                 stopped_heads_.del (j);
+                 break ;
+               }
+           }
+       }
+     
+      SCM basic = get_property ("Tie");
+      SCM sparse = get_property ("sparseTies");
       if (to_boolean (sparse))
        {
          int i = scm_ilength (head_list);
@@ -124,88 +151,136 @@ Tie_engraver::process_acknowledged ()
          if (!i)
            return;
          
-         SCM pair = gh_list_ref (head_list, gh_int2scm (i/2));
+         SCM pair = scm_list_ref (head_list, gh_int2scm (i/2));
          
-         Tie * p = new Tie;
-         p->set_head (LEFT, dynamic_cast<Item*> (unsmob_element (gh_car (pair))));
-         p->set_head (RIGHT, dynamic_cast<Item*> (unsmob_element (gh_cdr (pair))));
+         Spanner * p = new Spanner (basic);
+
+         Tie::set_interface (p); // cannot remove.
+         Tie::set_head (p,LEFT, dynamic_cast<Item*> (unsmob_grob (ly_car (pair))));
+         Tie::set_head (p,RIGHT, dynamic_cast<Item*> (unsmob_grob (ly_cdr (pair))));
          
-         tie_p_arr_.push (p);
-         announce_element (Score_element_info (p, req_l_));
+         ties_.push (p);
+         announce_grob(p, req_->self_scm());
        }
-      else for (SCM s = head_list; gh_pair_p (s); s = gh_cdr (s))
+      else for (SCM s = head_list; gh_pair_p (s); s = ly_cdr (s))
        {
-         Tie * p = new Tie;
-         p->set_head (LEFT, dynamic_cast<Item*> (unsmob_element (gh_caar (s))));
-         p->set_head (RIGHT, dynamic_cast<Item*> (unsmob_element (gh_cdar (s))));
+         Grob * p = new Spanner (basic);
+         Tie::set_interface (p); // cannot remove yet!
+         
+         Tie::set_head (p, LEFT, dynamic_cast<Item*> (unsmob_grob (ly_caar (s))));
+         Tie::set_head (p, RIGHT, dynamic_cast<Item*> (unsmob_grob (ly_cdar (s))));
          
-         tie_p_arr_.push (p);
-         announce_element (Score_element_info (p, req_l_));
+         ties_.push (p);
+         announce_grob(p, req_->self_scm());
        }
 
-      if (!tie_p_arr_.size ())
+      if (ties_.size () > 1 && !tie_column_)
        {
-         req_l_->warning (_ ("No ties were created!"));
+         tie_column_ = new Spanner (get_property ("TieColumn"));
+
+         for (int i = ties_.size (); i--;)
+           Tie_column::add_tie (tie_column_,ties_ [i]);
+         announce_grob(tie_column_, SCM_EOL);
        }
-         
     }
 }
 
 
 void
-Tie_engraver::do_pre_move_processing ()
+Tie_engraver::stop_translation_timestep ()
 {
-  for (int i=0; i < now_heads_.size (); i++)
-    {
-      past_notes_pq_.insert (now_heads_[i]);
-    }
+  req_ = 0;
+
   now_heads_.clear ();
 
-  for (int i=0; i<  tie_p_arr_.size (); i++)
+  /*
+    we don't warn for no ties, since this happens naturally when you
+    use skipTypesetting.  */
+  
+  for (int i=0; i<  ties_.size (); i++)
    {
-      typeset_element (tie_p_arr_[i]);
+      typeset_tie (ties_[i]);
+    }
+  ties_.clear ();
+  if (tie_column_)
+    {
+      typeset_grob (tie_column_);
+      tie_column_ =0;
     }
-  tie_p_arr_.clear ();
 }
 
 void
-Tie_engraver::do_post_move_processing ()
+Tie_engraver::typeset_tie (Grob *her)
+{
+  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 {
+    if (!Tie::head (her,d))
+      new_head_drul[d] = Tie::head (her, (Direction)-d);
+  } while (flip (&d) != LEFT);
+
+  index_set_cell (her->get_grob_property ("heads"), LEFT, new_head_drul[LEFT]->self_scm ());
+  index_set_cell (her->get_grob_property ("heads"), RIGHT, new_head_drul[RIGHT]->self_scm ());
+
+  typeset_grob (her);
+}
+
+void
+Tie_engraver::start_translation_timestep ()
 {
-  SCM m = get_property ("automaticMelismata",0);
+  SCM m = get_property ("automaticMelismata");
   if (to_boolean (m))
     {
       set_melisma (false);
     }
-  req_l_ = 0;
-  Moment now = now_mom ();
-  while (past_notes_pq_.size () && past_notes_pq_.front ().end_ < now)
-    past_notes_pq_.delmin ();
-}
 
-CHead_melodic_tuple::CHead_melodic_tuple ()
-{
-  head_l_ =0;
-  req_l_ =0;
-  end_ = 0;
-}
+  SCM grobs = get_property ("busyGrobs");
+  Moment now = now_mom();
+  stopped_heads_.clear ();
+  
+  for (; gh_pair_p (grobs); grobs = gh_cdr (grobs))
+    {
+      Grob * grob  = unsmob_grob (gh_cdar (grobs));
+      Moment end  =*unsmob_moment (gh_caar (grobs));
+      
+      /*
+       This is slightly ugh: we are now confunding the frontend
+       (iterators) and the backend (note heads) */
+      if (end > now)
+       break;
+      else if (end == now
+              && Note_head::has_interface (grob))
+       stopped_heads_.push (grob);
+    }
 
-CHead_melodic_tuple::CHead_melodic_tuple (Note_head *h, Melodic_req*m, Moment mom)
-{
-  head_l_ = h;
-  req_l_ = m;
-  end_ = mom;
-}
 
-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_);
-}
+  /*
+    
+    The list starts with entries that start earlier. By going through
+    it, we reverse the order, where as we'd like to use the `last'
+    heads first.
 
-int
-CHead_melodic_tuple::time_compare (CHead_melodic_tuple const&h1,
-                            CHead_melodic_tuple const &h2)
-{
-  return (h1.end_ - h2.end_ ).sign ();
+    This makes  a difference for grace notes. If we have
+
+    c4 \grace c8 ~ c4
+
+    Then busyGrobs will have ((1/4 . gc8) (1/4 . c4)). 
+
+    We want stopped_heads_ to contain (c4 gc8), because we start with
+    it at the top.
+   */
+  stopped_heads_.reverse();
 }
+
+
+ENTER_DESCRIPTION(Tie_engraver,
+/* descr */       "Generate ties between noteheads of equal pitch.",
+/* creats*/       "Tie TieColumn",
+/* acks  */       "rhythmic-head-interface",
+/* reads */       "sparseTies tieMelismaBusy",
+/* write */       "");