]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/part-combine-iterator.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / part-combine-iterator.cc
index 65c7f1aac987a682b4873b37cda8463b00867f48..922016b15cae8336190f052490e25d3b63b70abc 100644 (file)
@@ -1,20 +1,40 @@
 /*
-  new-part-combine-music-iterator.cc -- implement Part_combine_iterator
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2004--2014 Han-Wen Nienhuys
 
-  (c) 2004--2006 Han-Wen Nienhuys
+  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 "context.hh"
 #include "dispatcher.hh"
 #include "lily-guile.hh"
-#include "listener.hh"
 #include "music.hh"
 #include "music-iterator.hh"
 #include "music-sequence.hh"
 #include "warn.hh"
 
+enum Outlet_type
+{
+  CONTEXT_ONE, CONTEXT_TWO,
+  CONTEXT_SHARED, CONTEXT_SOLO,
+  CONTEXT_NULL, NUM_OUTLETS
+};
+
+static const char *outlet_names_[NUM_OUTLETS]
+  = {"one", "two", "shared", "solo", "null"};
+
 class Part_combine_iterator : public Music_iterator
 {
 public:
@@ -24,7 +44,6 @@ public:
 protected:
   virtual void derived_substitute (Context *f, Context *t);
   virtual void derived_mark () const;
-  Part_combine_iterator (Part_combine_iterator const &);
 
   virtual void construct_children ();
   virtual Moment pending_moment () const;
@@ -38,24 +57,34 @@ private:
   DECLARE_LISTENER (set_busy);
   bool busy_;
   bool notice_busy_;
-  
+
   bool try_process (Music_iterator *i, Moment m);
-  
+
   Music_iterator *first_iter_;
   Music_iterator *second_iter_;
   Moment start_moment_;
 
   SCM split_list_;
+  SCM direction_;
+  SCM directionOne_;
+  SCM directionTwo_;
+  SCM horizontalShiftOne_;
+  SCM horizontalShiftTwo_;
+
+  Stream_event *unisono_event_;
+  Stream_event *solo_one_event_;
+  Stream_event *solo_two_event_;
+  Stream_event *mmrest_event_;
 
   enum Status
-    {
-      APART,
-      TOGETHER,
-      SOLO1,
-      SOLO2,
-      UNISONO,
-      UNISILENCE,
-    };
+  {
+    APART,
+    TOGETHER,
+    SOLO1,
+    SOLO2,
+    UNISONO,
+    UNISILENCE,
+  };
   Status state_;
   Status playing_state_;
 
@@ -65,18 +94,15 @@ private:
   Status last_playing_;
 
   /*
-    TODO: this is getting of hand...
+    TODO: this is getting off hand...
   */
-  Context_handle one_;
-  Context_handle two_;
-  Context_handle null_;
-  Context_handle shared_;
-  Context_handle solo_;
+  Context_handle handles_[NUM_OUTLETS];
 
-  void substitute_both (Context *to1,
-                       Context *to2);
+  void substitute_both (Outlet_type to1,
+                        Outlet_type to2);
 
-  void kill_mmrest (Context *);
+  /* parameter is really Outlet_type */
+  void kill_mmrest (int in);
   void chords_together ();
   void solo1 ();
   void solo2 ();
@@ -92,20 +118,37 @@ Part_combine_iterator::do_quit ()
   if (second_iter_)
     second_iter_->quit ();
 
-  null_.set_context (0);
-  one_.set_context (0);
-  two_.set_context (0);
-  shared_.set_context (0);
-  solo_.set_context (0);
+  // Add listeners to all contexts except Devnull.
+  for (int i = 0; i < NUM_OUTLETS; i++)
+    {
+      Context *c = handles_[i].get_context ();
+      if (c->is_alias (ly_symbol2scm ("Voice")))
+        c->event_source ()->remove_listener (GET_LISTENER (set_busy), ly_symbol2scm ("music-event"));
+      handles_[i].set_context (0);
+    }
 }
 
 Part_combine_iterator::Part_combine_iterator ()
 {
+  mmrest_event_ = 0;
+  unisono_event_ = 0;
+  solo_two_event_ = 0;
+  solo_one_event_ = 0;
+
   first_iter_ = 0;
   second_iter_ = 0;
   split_list_ = SCM_EOL;
+  direction_ = SCM_BOOL_F;
+  directionOne_ = scm_from_int (1);
+  directionTwo_ = scm_from_int (-1);
+  horizontalShiftOne_ = scm_from_int (0);
+  horizontalShiftTwo_ = scm_from_int (1);
   state_ = APART;
   playing_state_ = APART;
+  last_playing_ = APART;
+
+  busy_ = false;
+  notice_busy_ = false;
 }
 
 void
@@ -115,11 +158,19 @@ Part_combine_iterator::derived_mark () const
     scm_gc_mark (first_iter_->self_scm ());
   if (second_iter_)
     scm_gc_mark (second_iter_->self_scm ());
+  if (unisono_event_)
+    scm_gc_mark (unisono_event_->self_scm ());
+  if (mmrest_event_)
+    scm_gc_mark (mmrest_event_->self_scm ());
+  if (solo_one_event_)
+    scm_gc_mark (solo_one_event_->self_scm ());
+  if (solo_two_event_)
+    scm_gc_mark (solo_two_event_->self_scm ());
 }
 
 void
 Part_combine_iterator::derived_substitute (Context *f,
-                                          Context *t)
+                                           Context *t)
 {
   if (first_iter_)
     first_iter_->substitute_outlet (f, t);
@@ -145,85 +196,41 @@ Part_combine_iterator::ok () const
 }
 
 void
-Part_combine_iterator::chords_together ()
+Part_combine_iterator::substitute_both (Outlet_type to1,
+                                        Outlet_type to2)
 {
-  if (state_ == TOGETHER)
-    return;
-  else
-    {
-      playing_state_ = TOGETHER;
-      state_ = TOGETHER;
+  Outlet_type tos[] = {to1, to2};
 
-      substitute_both (shared_.get_outlet (), shared_.get_outlet ());
-    }
-}
+  Music_iterator *mis[] = {first_iter_, second_iter_};
 
-void
-Part_combine_iterator::kill_mmrest (Context *tg)
-{
-  static Music *mmrest;
-  if (!mmrest)
+  for (int i = 0; i < 2; i++)
     {
-      mmrest = make_music_by_name (ly_symbol2scm ("MultiMeasureRestEvent"));
-      mmrest->set_property ("duration", SCM_EOL);
+      for (int j = 0; j < NUM_OUTLETS; j++)
+        if (j != tos[i])
+          mis[i]->substitute_outlet (handles_[j].get_context (), handles_[tos[i]].get_context ());
     }
 
-  mmrest->send_to_context (tg);
-}
-
-void
-Part_combine_iterator::solo1 ()
-{
-  if (state_ == SOLO1)
-    return;
-  else
+  for (int j = 0; j < NUM_OUTLETS; j++)
     {
-      state_ = SOLO1;
-      substitute_both (solo_.get_outlet (),
-                      null_.get_outlet ());
-
-      kill_mmrest (two_.get_outlet ());
-      kill_mmrest (shared_.get_outlet ());
-
-      if (playing_state_ != SOLO1)
-       {
-         static Music *event;
-         if (!event)
-           event = make_music_by_name (ly_symbol2scm ("SoloOneEvent"));
-
-         event->send_to_context (first_iter_->get_outlet ());
-       }
-      playing_state_ = SOLO1;
+      if (j != to1 && j != to2)
+        kill_mmrest (j);
     }
 }
 
 void
-Part_combine_iterator::substitute_both (Context *to1,
-                                       Context *to2)
+Part_combine_iterator::kill_mmrest (int in)
 {
-  Context *tos[] = {to1, to2};
-  Music_iterator *mis[] = {first_iter_, second_iter_};
-  Context_handle *hs[]
-    = {
-    &null_,
-    &one_, &two_,
-    &shared_, &solo_,
-    0
-  };
 
-  for (int i = 0; i < 2; i++)
+  if (!mmrest_event_)
     {
-      for (int j = 0; hs[j]; j++)
-       if (hs[j]->get_outlet () != tos[i])
-         mis[i]->substitute_outlet (hs[j]->get_outlet (), tos[i]);
+      mmrest_event_ = new Stream_event
+        (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"),
+                     ly_symbol2scm ("multi-measure-rest-event")));
+      mmrest_event_->set_property ("duration", SCM_EOL);
+      mmrest_event_->unprotect ();
     }
 
-  for (int j = 0; hs[j]; j++)
-    {
-      Context *t = hs[j]->get_outlet ();
-      if (t != to1 && t != to2)
-       kill_mmrest (t);
-    }
+  handles_[in].get_context ()->event_source ()->broadcast (mmrest_event_);
 }
 
 void
@@ -236,33 +243,65 @@ Part_combine_iterator::unisono (bool silent)
   else
     {
       /*
-       If we're coming from SOLO2 state, we might have kill mmrests
-       in the 1st voice, so in that case, we use the second voice
-       as a basis for events.
+        If we're coming from SOLO2 state, we might have kill mmrests
+        in the 1st voice, so in that case, we use the second voice
+        as a basis for events.
       */
-      Context *c1 = (last_playing_ == SOLO2) ? null_.get_outlet () : shared_.get_outlet ();
-      Context *c2 = (last_playing_ == SOLO2) ? shared_.get_outlet () : null_.get_outlet ();
+      Outlet_type c1 = (last_playing_ == SOLO2) ? CONTEXT_NULL : CONTEXT_SHARED;
+      Outlet_type c2 = (last_playing_ == SOLO2) ? CONTEXT_SHARED : CONTEXT_NULL;
       substitute_both (c1, c2);
-      kill_mmrest ((last_playing_ == SOLO2)
-                  ? one_.get_outlet () : two_.get_outlet ());
-      kill_mmrest (shared_.get_outlet ());
+      kill_mmrest ((last_playing_ == SOLO2) ? CONTEXT_ONE : CONTEXT_TWO);
+      kill_mmrest (CONTEXT_SHARED);
 
       if (playing_state_ != UNISONO
-         && newstate == UNISONO)
-       {
-         static Music *event;
-         if (!event)
-           event = make_music_by_name (ly_symbol2scm ("UnisonoEvent"));
-
-         Context *out = (last_playing_ == SOLO2 ? second_iter_ : first_iter_)
-           ->get_outlet ();
-         event->send_to_context (out);
-         playing_state_ = UNISONO;
-       }
+          && newstate == UNISONO)
+        {
+          if (!unisono_event_)
+            {
+              unisono_event_ = new Stream_event
+                (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"),
+                             ly_symbol2scm ("unisono-event")));
+              unisono_event_->unprotect ();
+            }
+
+          Context *out = (last_playing_ == SOLO2 ? second_iter_ : first_iter_)
+                         ->get_outlet ();
+          out->event_source ()->broadcast (unisono_event_);
+          playing_state_ = UNISONO;
+        }
       state_ = newstate;
     }
 }
 
+void
+Part_combine_iterator::solo1 ()
+{
+  if (state_ == SOLO1)
+    return;
+  else
+    {
+      state_ = SOLO1;
+      substitute_both (CONTEXT_SOLO, CONTEXT_NULL);
+
+      kill_mmrest (CONTEXT_TWO);
+      kill_mmrest (CONTEXT_SHARED);
+
+      if (playing_state_ != SOLO1)
+        {
+          if (!solo_one_event_)
+            {
+              solo_one_event_ = new Stream_event
+                (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"),
+                             ly_symbol2scm ("solo-one-event")));
+              solo_one_event_->unprotect ();
+            }
+
+          first_iter_->get_outlet ()->event_source ()->broadcast (solo_one_event_);
+        }
+      playing_state_ = SOLO1;
+    }
+}
+
 void
 Part_combine_iterator::solo2 ()
 {
@@ -272,17 +311,35 @@ Part_combine_iterator::solo2 ()
     {
       state_ = SOLO2;
 
-      substitute_both (null_.get_outlet (), solo_.get_outlet ());
+      substitute_both (CONTEXT_NULL, CONTEXT_SOLO);
 
       if (playing_state_ != SOLO2)
-       {
-         static Music *event;
-         if (!event)
-           event = make_music_by_name (ly_symbol2scm ("SoloTwoEvent"));
-
-         event->send_to_context (second_iter_->get_outlet ());
-         playing_state_ = SOLO2;
-       }
+        {
+          if (!solo_two_event_)
+            {
+              solo_two_event_ = new Stream_event
+                (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"),
+                             ly_symbol2scm ("solo-two-event")));
+              solo_two_event_->unprotect ();
+            }
+
+          second_iter_->get_outlet ()->event_source ()->broadcast (solo_two_event_);
+          playing_state_ = SOLO2;
+        }
+    }
+}
+
+void
+Part_combine_iterator::chords_together ()
+{
+  if (state_ == TOGETHER)
+    return;
+  else
+    {
+      playing_state_ = TOGETHER;
+      state_ = TOGETHER;
+
+      substitute_both (CONTEXT_SHARED, CONTEXT_SHARED);
     }
 }
 
@@ -297,7 +354,7 @@ Part_combine_iterator::apart (bool silent)
   else
     {
       state_ = APART;
-      substitute_both (one_.get_outlet (), two_.get_outlet ());
+      substitute_both (CONTEXT_ONE, CONTEXT_TWO);
     }
 }
 
@@ -306,62 +363,51 @@ Part_combine_iterator::construct_children ()
 {
   start_moment_ = get_outlet ()->now_mom ();
   split_list_ = get_music ()->get_property ("split-list");
-  SCM lst = get_music ()->get_property ("elements");
-
-  SCM props = scm_list_n (/*
-                           used to have tweaks here.
-                         */
-
-                         SCM_UNDEFINED);
-
-  Context *tr
-    = get_outlet ()->find_create_context (ly_symbol2scm ("Voice"),
-                                         "shared", props);
-
-  shared_.set_context (tr);
-
-  /*
-    If we don't, we get a new staff for every Voice.
-  */
-  set_context (tr);
-
-  Context *solo_tr
-    = get_outlet ()->find_create_context (ly_symbol2scm ("Voice"),
-                                         "solo", props);
-
-  solo_.set_context (solo_tr);
-
-  Context *null
-    = get_outlet ()->find_create_context (ly_symbol2scm ("Devnull"),
-                                         "", SCM_EOL);
-
-  if (!null)
-    programming_error ("no Devnull found");
-
-  null_.set_context (null);
+  direction_ = get_music ()->get_property ("direction");
+  if (is_direction (direction_))
+    {
+      directionOne_ = direction_;
+      directionTwo_ = direction_;
+      if (scm_is_true (scm_negative_p (direction_)))
+        {
+          horizontalShiftOne_ = scm_from_int (1);
+          horizontalShiftTwo_ = scm_from_int (0);
+        }
+    }
 
-  Context *one = tr->find_create_context (ly_symbol2scm ("Voice"),
-                                         "one", props);
+  Context *c = get_outlet ();
 
-  one_.set_context (one);
+  for (int i = 0; i < NUM_OUTLETS; i++)
+    {
+      SCM type = (i == CONTEXT_NULL) ? ly_symbol2scm ("Devnull") : ly_symbol2scm ("Voice");
+      /* find context below c: otherwise we may create new staff for each voice */
+      c = c->find_create_context (type, outlet_names_[i], SCM_EOL);
+      handles_[i].set_context (c);
+      if (c->is_alias (ly_symbol2scm ("Voice")))
+        c->event_source ()->add_listener (GET_LISTENER (set_busy), ly_symbol2scm ("music-event"));
+    }
 
+  SCM lst = get_music ()->get_property ("elements");
+  Context *one = handles_[CONTEXT_ONE].get_context ();
   set_context (one);
   first_iter_ = unsmob_iterator (get_iterator (unsmob_music (scm_car (lst))));
-
-  Context *two = tr->find_create_context (ly_symbol2scm ("Voice"),
-                                         "two", props);
-  two_.set_context (two);
+  Context *two = handles_[CONTEXT_TWO].get_context ();
   set_context (two);
   second_iter_ = unsmob_iterator (get_iterator (unsmob_music (scm_cadr (lst))));
+  Context *shared = handles_[CONTEXT_SHARED].get_context ();
+  set_context (shared);
 
-  set_context (tr);
-
+  /* Mimic all settings of voiceOne/voiceTwo for the two separate voices...*/
+  /* FIXME: Is there any way to use the definition of \voiceOne/\voiceTwo
+            directly??? */
   char const *syms[]
-    = {
+  =
+  {
     "Stem",
     "DynamicLineSpanner",
     "Tie",
     "Dots",
+    "MultiMeasureRest",
     "Rest",
     "Slur",
     "TextScript",
@@ -369,22 +415,25 @@ Part_combine_iterator::construct_children ()
     0
   };
 
-  // Add listeners to all contexts except Devnull.
-  Context *contexts[] = {one, two, solo_tr, tr, 0};
-  for (int i = 0; contexts[i]; i++)
-    {
-      contexts[i]->event_source ()->add_listener (GET_LISTENER (set_busy), ly_symbol2scm ("MusicEvent"));
-    }
-
   for (char const **p = syms; *p; p++)
     {
       SCM sym = ly_symbol2scm (*p);
       execute_pushpop_property (one, sym,
-                               ly_symbol2scm ("direction"), scm_from_int (1));
+                                ly_symbol2scm ("direction"), directionOne_);
 
       execute_pushpop_property (two, sym,
-                               ly_symbol2scm ("direction"), scm_from_int (-1));
+                                ly_symbol2scm ("direction"), directionTwo_);
+
+      if (scm_is_number (direction_))
+        execute_pushpop_property (shared, sym,
+                                  ly_symbol2scm ("direction"), direction_);
     }
+  /* Handle horizontal shifts for crossing notes */
+  execute_pushpop_property (one, ly_symbol2scm ("NoteColumn"),
+                            ly_symbol2scm ("horizontal-shift"), horizontalShiftOne_);
+  execute_pushpop_property (two, ly_symbol2scm ("NoteColumn"),
+                            ly_symbol2scm ("horizontal-shift"), horizontalShiftTwo_);
+
 }
 
 IMPLEMENT_LISTENER (Part_combine_iterator, set_busy);
@@ -395,16 +444,14 @@ Part_combine_iterator::set_busy (SCM se)
     return;
 
   Stream_event *e = unsmob_stream_event (se);
-  SCM mus = e->get_property ("music");
-  Music *m = unsmob_music (mus);
-  assert (m);
 
-  if (m->is_mus_type ("note-event") || m->is_mus_type ("cluster-note-event"))
+  if (e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event"))
     busy_ = true;
 }
 
 /*
-* Processes a moment in an iterator, and returns whether any new music was reported.
+  Processes a moment in an iterator, and returns whether any new music
+  was reported.
 */
 bool
 Part_combine_iterator::try_process (Music_iterator *i, Moment m)
@@ -413,7 +460,7 @@ Part_combine_iterator::try_process (Music_iterator *i, Moment m)
   notice_busy_ = true;
 
   i->process (m);
-  
+
   notice_busy_ = false;
   return busy_;
 }
@@ -424,34 +471,39 @@ Part_combine_iterator::process (Moment m)
   Moment now = get_outlet ()->now_mom ();
   Moment *splitm = 0;
 
+  /* This is needed if construct_children was called before iteration
+     started */
+  if (start_moment_.main_part_.is_infinity () && start_moment_ < 0)
+    start_moment_ = now;
+
   for (; scm_is_pair (split_list_); split_list_ = scm_cdr (split_list_))
     {
       splitm = unsmob_moment (scm_caar (split_list_));
       if (splitm && *splitm + start_moment_ > now)
-       break;
+        break;
 
       SCM tag = scm_cdar (split_list_);
 
       if (tag == ly_symbol2scm ("chords"))
-       chords_together ();
+        chords_together ();
       else if (tag == ly_symbol2scm ("apart")
-              || tag == ly_symbol2scm ("apart-silence")
-              || tag == ly_symbol2scm ("apart-spanner"))
-       apart (tag == ly_symbol2scm ("apart-silence"));
+               || tag == ly_symbol2scm ("apart-silence")
+               || tag == ly_symbol2scm ("apart-spanner"))
+        apart (tag == ly_symbol2scm ("apart-silence"));
       else if (tag == ly_symbol2scm ("unisono"))
-       unisono (false);
+        unisono (false);
       else if (tag == ly_symbol2scm ("unisilence"))
-       unisono (true);
+        unisono (true);
       else if (tag == ly_symbol2scm ("solo1"))
-       solo1 ();
+        solo1 ();
       else if (tag == ly_symbol2scm ("solo2"))
-       solo2 ();
+        solo2 ();
       else if (scm_is_symbol (tag))
-       {
-         string s = "Unknown split directive: "
-           + (scm_is_symbol (tag) ? ly_symbol2string (tag) : string ("not a symbol"));
-         programming_error (s);
-       }
+        {
+          string s = "Unknown split directive: "
+                     + (scm_is_symbol (tag) ? ly_symbol2string (tag) : string ("not a symbol"));
+          programming_error (s);
+        }
     }
 
   if (first_iter_->ok ())
@@ -463,7 +515,7 @@ Part_combine_iterator::process (Moment m)
   if (second_iter_->ok ())
     {
       if (try_process (second_iter_, m))
-       last_playing_ = SOLO2;
+        last_playing_ = SOLO2;
     }
 }