]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie-engraver.cc
Doc-es: various updates.
[lilypond.git] / lily / tie-engraver.cc
index 40da0d3e8410663881acd57eb0d191a87626ee35..98eac4b19b81355b595133986f4bbf47565f40a5 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1998--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1998--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
@@ -23,6 +23,7 @@
 #include "international.hh"
 #include "item.hh"
 #include "note-head.hh"
+#include "pitch.hh"
 #include "protected-scm.hh"
 #include "spanner.hh"
 #include "staff-symbol-referencer.hh"
@@ -46,9 +47,9 @@ struct Head_event_tuple
 {
   Grob *head_;
   Moment end_moment_;
-  SCM tie_definition_;
   Stream_event *tie_stream_event_;
   Stream_event *tie_event_;
+  Spanner *tie_;
   // Indicate whether a tie from the same moment has been processed successfully
   // This is needed for tied chords, e.g. <c e g>~ g, because otherwise the c
   // and e will trigger a warning for an unterminated tie!
@@ -57,55 +58,57 @@ struct Head_event_tuple
   Head_event_tuple ()
   {
     head_ = 0;
-    tie_definition_ = SCM_EOL;
     tie_event_ = 0;
     tie_stream_event_ = 0;
     tie_from_chord_created = false;
+    tie_ = 0;
   }
 };
 
 class Tie_engraver : public Engraver
 {
+  /*
+    Whether tie event has been processed and can be deleted or should
+    be kept for later portions of a split note.
+  */
+  bool event_processed_;
   Stream_event *event_;
   vector<Grob *> now_heads_;
   vector<Head_event_tuple> heads_to_tie_;
-  vector<Grob *> ties_;
+  vector<Spanner *> ties_;
 
   Spanner *tie_column_;
+  bool tie_notehead (Grob *h, bool enharmonic);
 
 protected:
+  void process_acknowledged ();
   void stop_translation_timestep ();
-  virtual void derived_mark () const;
   void start_translation_timestep ();
-  DECLARE_ACKNOWLEDGER (note_head);
-  DECLARE_TRANSLATOR_LISTENER (tie);
+  void acknowledge_note_head (Grob_info);
+  void listen_tie (Stream_event *);
   void process_music ();
-  void typeset_tie (Grob *);
+  void typeset_tie (Spanner *);
   void report_unterminated_tie (Head_event_tuple const &);
   bool has_autosplit_end (Stream_event *event);
 public:
   TRANSLATOR_DECLARATIONS (Tie_engraver);
 };
 
-void
-Tie_engraver::derived_mark () const
-{
-  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 ()
+Tie_engraver::Tie_engraver (Context *c)
+  : Engraver (c)
 {
   event_ = 0;
   tie_column_ = 0;
+  event_processed_ = false;
 }
 
-IMPLEMENT_TRANSLATOR_LISTENER (Tie_engraver, tie);
 void
 Tie_engraver::listen_tie (Stream_event *ev)
 {
-  ASSIGN_EVENT_ONCE (event_, ev);
+  if (!to_boolean (get_property ("skipTypesetting")))
+    {
+      ASSIGN_EVENT_ONCE (event_, ev);
+    }
 }
 
 void Tie_engraver::report_unterminated_tie (Head_event_tuple const &tie_start)
@@ -114,7 +117,10 @@ void Tie_engraver::report_unterminated_tie (Head_event_tuple const &tie_start)
   // moment that created a tie, so this is not necessarily an unterminated
   // tie. Happens e.g. for <c e g>~ g
   if (!tie_start.tie_from_chord_created)
-    tie_start.head_->warning (_ ("unterminated tie"));
+    {
+      tie_start.tie_->warning (_ ("unterminated tie"));
+      tie_start.tie_->suicide ();
+    }
 }
 
 /*
@@ -141,17 +147,16 @@ Tie_engraver::process_music ()
     context ()->set_property ("tieMelismaBusy", SCM_BOOL_T);
 }
 
-void
-Tie_engraver::acknowledge_note_head (Grob_info i)
+bool
+Tie_engraver::tie_notehead (Grob *h, bool enharmonic)
 {
-  Grob *h = i.grob ();
+  bool found = false;
 
-  now_heads_.push_back (h);
-  for (vsize i = heads_to_tie_.size (); i--;)
+  for (vsize i = 0; i < heads_to_tie_.size (); i++)
     {
       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"));
+      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.
@@ -163,29 +168,36 @@ Tie_engraver::acknowledge_note_head (Grob_info i)
         Make a tie only if pitches are equal or if event end was not generated by
         Completion_heads_engraver.
       */
-      if (ly_is_equal (right_ev->get_property ("pitch"), left_ev->get_property ("pitch"))
+      SCM p1 = left_ev->get_property ("pitch");
+      SCM p2 = right_ev->get_property ("pitch");
+      if ((enharmonic
+           ? (unsmob<Pitch> (p1) && unsmob<Pitch> (p2) &&
+              unsmob<Pitch> (p1)->tone_pitch () == unsmob<Pitch> (p2)->tone_pitch ())
+           : ly_is_equal (p1, p2))
           && (!Tie_engraver::has_autosplit_end (left_ev)))
         {
-          Grob *p = new Spanner (heads_to_tie_[i].tie_definition_);
+          Spanner *p = heads_to_tie_[i].tie_;
           Moment end = heads_to_tie_[i].end_moment_;
 
-          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 ();
+          Stream_event *cause = heads_to_tie_[i].tie_event_
+                                    ? heads_to_tie_[i].tie_event_
+                                    : heads_to_tie_[i].tie_stream_event_;
+
+          announce_end_grob (p, cause->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")))
+          if (is_direction (cause->get_property ("direction")))
             {
-              Direction d = to_dir (unsmob_stream_event (cause)->get_property ("direction"));
+              Direction d = to_dir (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);
 
+          found = true;
           /*
             Prevent all other tied notes ending at the same moment (assume
             implicitly the notes have also started at the same moment!)
@@ -197,14 +209,27 @@ Tie_engraver::acknowledge_note_head (Grob_info i)
               if (heads_to_tie_[j].end_moment_ == end)
                 heads_to_tie_[j].tie_from_chord_created = true;
             }
+          break;
         }
     }
+  return found;
+}
+
+void
+Tie_engraver::acknowledge_note_head (Grob_info i)
+{
+  Grob *h = i.grob ();
+
+  now_heads_.push_back (h);
+
+  if (!tie_notehead (h, false))
+    tie_notehead (h, true);
 
   if (ties_.size () && ! tie_column_)
     tie_column_ = make_spanner ("TieColumn", ties_[0]->self_scm ());
 
   if (tie_column_)
-    for (vsize i = ties_.size (); i--;)
+    for (vsize i = 0; i < ties_.size (); i++)
       Tie_column::add_tie (tie_column_, ties_[i]);
 }
 
@@ -229,7 +254,7 @@ Tie_engraver::start_translation_timestep ()
 }
 
 void
-Tie_engraver::stop_translation_timestep ()
+Tie_engraver::process_acknowledged ()
 {
   bool wait = to_boolean (get_property ("tieWaitForNote"));
   if (ties_.size ())
@@ -251,17 +276,12 @@ Tie_engraver::stop_translation_timestep ()
 
   vector<Head_event_tuple> new_heads_to_tie;
 
-  /*
-    Whether tie event has been processed and can be deleted or should
-    be kept for later portions of a split note.
-  */
-  bool event_processed = false;
 
   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"));
+        = unsmob<Stream_event> (head->get_property ("cause"));
 
       if (!left_ev)
         {
@@ -281,7 +301,7 @@ Tie_engraver::stop_translation_timestep ()
            !tie_event && !tie_stream_event && scm_is_pair (s);
            s = scm_cdr (s))
         {
-          Stream_event *ev = unsmob_stream_event (scm_car (s));
+          Stream_event *ev = unsmob<Stream_event> (scm_car (s));
           if (!ev)
             continue;
 
@@ -292,17 +312,16 @@ Tie_engraver::stop_translation_timestep ()
       if (left_ev && (tie_event || tie_stream_event)
           && (!Tie_engraver::has_autosplit_end (left_ev)))
         {
-          event_processed = true;
+          event_processed_ = true;
 
           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;
+          event_tup.tie_ = make_spanner ("Tie", tie_event
+                                    ? tie_event->self_scm ()
+                                    : tie_stream_event->self_scm ());
 
           Moment end = now_mom ();
           if (end.grace_part_)
@@ -331,37 +350,48 @@ Tie_engraver::stop_translation_timestep ()
   for (vsize i = 0; i < new_heads_to_tie.size (); i++)
     heads_to_tie_.push_back (new_heads_to_tie[i]);
 
+  now_heads_.clear ();
+}
+
+void
+Tie_engraver::stop_translation_timestep ()
+{
   /*
     Discard event only if it has been processed with at least one
     appropriate note.
   */
-  if (event_processed)
+  if (event_processed_)
     event_ = 0;
 
-  now_heads_.clear ();
+  event_processed_ = false;
 }
 
 void
-Tie_engraver::typeset_tie (Grob *her)
+Tie_engraver::typeset_tie (Spanner *her)
 {
-  if (! (Tie::head (her, LEFT) && Tie::head (her, RIGHT)))
-    warning (_ ("lonely tie"));
+  Grob *left_head = Tie::head (her, LEFT);
+  Grob *right_head = Tie::head (her, RIGHT);
 
-  Drul_array<Grob *> new_head_drul;
-  new_head_drul[LEFT] = Tie::head (her, LEFT);
-  new_head_drul[RIGHT] = Tie::head (her, RIGHT);
-  for (LEFT_and_RIGHT (d))
+  if (!left_head || !right_head)
     {
-      if (!Tie::head (her, d))
-        new_head_drul[d] = Tie::head (her, (Direction) - d);
+      warning (_ ("lonely tie"));
+      if (!left_head)
+        left_head = right_head;
+      else
+        right_head = left_head;
     }
 
-  Spanner *sp = dynamic_cast<Spanner *> (her);
-  sp->set_bound (LEFT, new_head_drul[LEFT]);
-  sp->set_bound (RIGHT, new_head_drul[RIGHT]);
+  her->set_bound (LEFT, left_head);
+  her->set_bound (RIGHT, right_head);
+}
+
+void
+Tie_engraver::boot ()
+{
+  ADD_LISTENER (Tie_engraver, tie);
+  ADD_ACKNOWLEDGER (Tie_engraver, note_head);
 }
 
-ADD_ACKNOWLEDGER (Tie_engraver, note_head);
 ADD_TRANSLATOR (Tie_engraver,
                 /* doc */
                 "Generate ties between note heads of equal pitch.",
@@ -371,6 +401,7 @@ ADD_TRANSLATOR (Tie_engraver,
                 "TieColumn ",
 
                 /* read */
+                "skipTypesetting "
                 "tieWaitForNote ",
 
                 /* write */