]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/part-combine-iterator.cc
Issue 4423: eliminate part combiner's array of context handles (3/4)
[lilypond.git] / lily / part-combine-iterator.cc
index 06449fb5dca228c13dd6a9daa0269cbce80c400e..a3b54fc386f4fde3d934b8df6f14d33b1efd400c 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2004--2012 Han-Wen Nienhuys
+  Copyright (C) 2004--2015 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
@@ -53,45 +53,28 @@ protected:
   virtual bool ok () const;
 
 private:
-  /* used by try_process */
-  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_;
+  static const size_t NUM_PARTS = 2;
+  Music_iterator *iterators_[NUM_PARTS];
   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
   {
+    INITIAL,
     APART,
     TOGETHER,
-    SOLO1,
-    SOLO2,
+    SOLO,
     UNISONO,
     UNISILENCE,
   };
   Status state_;
-  Status playing_state_;
 
-  /*
-    Should be SOLO1 or SOLO2
-  */
-  Status last_playing_;
+  // For states in which it matters, this is the relevant part,
+  // e.g. 1 for Solo I, 2 for Solo II.
+  int chosen_part_;
 
   /*
     TODO: this is getting off hand...
@@ -100,80 +83,54 @@ private:
 
   void substitute_both (Outlet_type to1,
                         Outlet_type to2);
-
-  /* parameter is really Outlet_type */
-  void kill_mmrest (int in);
+  bool is_active_outlet (const Context *c) const;
+  void kill_mmrest (Context *c);
   void chords_together ();
   void solo1 ();
   void solo2 ();
-  void apart (bool silent);
-  void unisono (bool silent);
+  void apart ();
+  void unisono (bool silent, int newpart);
 };
 
+const size_t Part_combine_iterator::NUM_PARTS;
+
 void
 Part_combine_iterator::do_quit ()
 {
-  if (first_iter_)
-    first_iter_->quit ();
-  if (second_iter_)
-    second_iter_->quit ();
-
-  // 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);
-    }
+  for (size_t i = 0; i < NUM_PARTS; i++)
+    if (iterators_[i])
+      iterators_[i]->quit ();
 }
 
 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;
+  for (size_t i = 0; i < NUM_PARTS; i++)
+    iterators_[i] = 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;
+  state_ = INITIAL;
+  chosen_part_ = 1;
 }
 
 void
 Part_combine_iterator::derived_mark () const
 {
-  if (first_iter_)
-    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 ());
+  for (size_t i = 0; i < NUM_PARTS; i++)
+    if (iterators_[i])
+      scm_gc_mark (iterators_[i]->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)
 {
-  if (first_iter_)
-    first_iter_->substitute_outlet (f, t);
+  // (Explain why just iterators_[0].)
+  if (iterators_[0])
+    iterators_[0]->substitute_outlet (f, t);
 }
 
 Moment
@@ -181,150 +138,104 @@ Part_combine_iterator::pending_moment () const
 {
   Moment p;
   p.set_infinite (1);
-  if (first_iter_->ok ())
-    p = min (p, first_iter_->pending_moment ());
 
-  if (second_iter_->ok ())
-    p = min (p, second_iter_->pending_moment ());
+  for (size_t i = 0; i < NUM_PARTS; i++)
+    if (iterators_[i]->ok ())
+      p = min (p, iterators_[i]->pending_moment ());
+
   return p;
 }
 
 bool
 Part_combine_iterator::ok () const
 {
-  return first_iter_->ok () || second_iter_->ok ();
+  for (size_t i = 0; i < NUM_PARTS; i++)
+    if (iterators_[i]->ok ())
+      return true;
+
+  return false;
 }
 
 void
 Part_combine_iterator::substitute_both (Outlet_type to1,
                                         Outlet_type to2)
 {
-  Outlet_type tos[] = {to1, to2};
-
-  Music_iterator *mis[] = {first_iter_, second_iter_};
+  // TODO: There is no good reason to tie the parts together here.
+  // Factor out per-part stuff into a new class of iterator which
+  // reads a part-specific list similar to the existing combined
+  // "split-list".
+  iterators_[0]->substitute_outlet (iterators_[0]->get_outlet (),
+                                    handles_[to1].get_context ());
+  iterators_[1]->substitute_outlet (iterators_[1]->get_outlet (),
+                                    handles_[to2].get_context ());
+}
 
-  for (int i = 0; i < 2; i++)
-    {
-      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 ());
-    }
+bool Part_combine_iterator::is_active_outlet (const Context *c) const
+{
+  for (size_t i = 0; i < NUM_PARTS; i++)
+    if (iterators_[i] && (iterators_[i]->get_outlet () == c))
+      return true;
 
-  for (int j = 0; j < NUM_OUTLETS; j++)
-    {
-      if (j != to1 && j != to2)
-        kill_mmrest (j);
-    }
+  return false;
 }
 
 void
-Part_combine_iterator::kill_mmrest (int in)
+Part_combine_iterator::kill_mmrest (Context *c)
 {
 
   if (!mmrest_event_)
     {
       mmrest_event_ = new Stream_event
-       (handles_[in].get_context ()->make_event_class
-        (ly_symbol2scm ("multi-measure-rest-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 ();
     }
 
-  handles_[in].get_context ()->event_source ()->broadcast (mmrest_event_);
+  c->event_source ()->broadcast (mmrest_event_);
 }
 
 void
-Part_combine_iterator::unisono (bool silent)
+Part_combine_iterator::unisono (bool silent, int newpart)
 {
   Status newstate = (silent) ? UNISILENCE : UNISONO;
 
-  if (newstate == state_)
+  if ((newstate == state_) and (newpart == chosen_part_))
     return;
   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.
-      */
-      Outlet_type c1 = (last_playing_ == SOLO2) ? CONTEXT_NULL : CONTEXT_SHARED;
-      Outlet_type c2 = (last_playing_ == SOLO2) ? CONTEXT_SHARED : CONTEXT_NULL;
+      Outlet_type c1 = (newpart == 2) ? CONTEXT_NULL : CONTEXT_SHARED;
+      Outlet_type c2 = (newpart == 2) ? CONTEXT_SHARED : CONTEXT_NULL;
       substitute_both (c1, c2);
-      kill_mmrest ((last_playing_ == SOLO2) ? CONTEXT_ONE : CONTEXT_TWO);
-      kill_mmrest (CONTEXT_SHARED);
 
-      if (playing_state_ != UNISONO
-          && newstate == UNISONO)
-        {
-          Context *out = (last_playing_ == SOLO2 ? second_iter_ : first_iter_)
-                         ->get_outlet ();
-          if (!unisono_event_)
-            {
-              unisono_event_ = new Stream_event
-               (out->make_event_class (ly_symbol2scm ("unisono-event")));
-              unisono_event_->unprotect ();
-            }
-
-          out->event_source ()->broadcast (unisono_event_);
-          playing_state_ = UNISONO;
-        }
       state_ = newstate;
+      chosen_part_ = newpart;
     }
 }
 
 void
 Part_combine_iterator::solo1 ()
 {
-  if (state_ == SOLO1)
+  if ((state_ == SOLO) && (chosen_part_ == 1))
     return;
   else
     {
-      state_ = SOLO1;
+      state_ = SOLO;
+      chosen_part_ = 1;
       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
-               (first_iter_->get_outlet ()->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 ()
 {
-  if (state_ == SOLO2)
+  if ((state_ == SOLO) and (chosen_part_ == 2))
     return;
   else
     {
-      state_ = SOLO2;
-
+      state_ = SOLO;
+      chosen_part_ = 2;
       substitute_both (CONTEXT_NULL, CONTEXT_SOLO);
-
-      if (playing_state_ != SOLO2)
-        {
-          if (!solo_two_event_)
-            {
-              solo_two_event_ = new Stream_event
-               (second_iter_->get_outlet ()->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;
-        }
     }
 }
 
@@ -335,7 +246,6 @@ Part_combine_iterator::chords_together ()
     return;
   else
     {
-      playing_state_ = TOGETHER;
       state_ = TOGETHER;
 
       substitute_both (CONTEXT_SHARED, CONTEXT_SHARED);
@@ -343,11 +253,8 @@ Part_combine_iterator::chords_together ()
 }
 
 void
-Part_combine_iterator::apart (bool silent)
+Part_combine_iterator::apart ()
 {
-  if (!silent)
-    playing_state_ = APART;
-
   if (state_ == APART)
     return;
   else
@@ -362,110 +269,20 @@ Part_combine_iterator::construct_children ()
 {
   start_moment_ = get_outlet ()->now_mom ();
   split_list_ = get_music ()->get_property ("split-list");
-  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 *c = get_outlet ();
 
   for (int i = 0; i < NUM_OUTLETS; i++)
     {
-      SCM type = (i == CONTEXT_NULL) ? ly_symbol2scm ("Devnull") : ly_symbol2scm ("Voice");
+      SCM type = (i == CONTEXT_NULL) ? ly_symbol2scm ("NullVoice") : 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 = 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);
-
-  /* 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",
-    "Rest",
-    "Slur",
-    "TextScript",
-    "Script",
-    0
-  };
-
-  for (char const **p = syms; *p; p++)
-    {
-      SCM sym = ly_symbol2scm (*p);
-      execute_pushpop_property (one, sym,
-                                ly_symbol2scm ("direction"), directionOne_);
-
-      execute_pushpop_property (two, sym,
-                                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_);
-  /* Also handle MultiMeasureRest positions for voice 1/2 */
-  execute_pushpop_property (one, ly_symbol2scm ("MultiMeasureRest"),
-                            ly_symbol2scm ("staff-position"), scm_from_int (4));
-  execute_pushpop_property (two, ly_symbol2scm ("MultiMeasureRest"),
-                            ly_symbol2scm ("staff-position"), scm_from_int (-4));
-
-}
-
-IMPLEMENT_LISTENER (Part_combine_iterator, set_busy);
-void
-Part_combine_iterator::set_busy (SCM se)
-{
-  if (!notice_busy_)
-    return;
-
-  Stream_event *e = unsmob_stream_event (se);
-
-  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.
-*/
-bool
-Part_combine_iterator::try_process (Music_iterator *i, Moment m)
-{
-  busy_ = false;
-  notice_busy_ = true;
-
-  i->process (m);
-
-  notice_busy_ = false;
-  return busy_;
+  iterators_[0] = unsmob<Music_iterator> (get_iterator (unsmob<Music> (scm_car (lst))));
+  iterators_[1] = unsmob<Music_iterator> (get_iterator (unsmob<Music> (scm_cadr (lst))));
 }
 
 void
@@ -479,27 +296,42 @@ Part_combine_iterator::process (Moment m)
   if (start_moment_.main_part_.is_infinity () && start_moment_ < 0)
     start_moment_ = now;
 
+  Context *prev_active_outlets[NUM_PARTS];
+  for (size_t i = 0; i < NUM_PARTS; i++)
+    prev_active_outlets[i] = iterators_[i]->get_outlet ();
+
   for (; scm_is_pair (split_list_); split_list_ = scm_cdr (split_list_))
     {
-      splitm = unsmob_moment (scm_caar (split_list_));
+      splitm = unsmob<Moment> (scm_caar (split_list_));
       if (splitm && *splitm + start_moment_ > now)
         break;
 
       SCM tag = scm_cdar (split_list_);
 
-      if (tag == ly_symbol2scm ("chords"))
+      if (scm_is_eq (tag, ly_symbol2scm ("chords")))
         chords_together ();
-      else if (tag == ly_symbol2scm ("apart")
-               || tag == ly_symbol2scm ("apart-silence")
-               || tag == ly_symbol2scm ("apart-spanner"))
-        apart (tag == ly_symbol2scm ("apart-silence"));
-      else if (tag == ly_symbol2scm ("unisono"))
-        unisono (false);
-      else if (tag == ly_symbol2scm ("unisilence"))
-        unisono (true);
-      else if (tag == ly_symbol2scm ("solo1"))
+      else if (scm_is_eq (tag, ly_symbol2scm ("apart"))
+               || scm_is_eq (tag, ly_symbol2scm ("apart-silence"))
+               || scm_is_eq (tag, ly_symbol2scm ("apart-spanner")))
+        apart ();
+      else if (scm_is_eq (tag, ly_symbol2scm ("unisono")))
+        {
+          // Continue to use the most recently used part because we might have
+          // killed mmrests in the other part.
+          unisono (false, (chosen_part_ == 2) ? 2 : 1);
+        }
+      else if (scm_is_eq (tag, ly_symbol2scm ("unisilence")))
+        {
+          // as for unisono
+          unisono (true, (chosen_part_ == 2) ? 2 : 1);
+        }
+      else if (scm_is_eq (tag, ly_symbol2scm ("silence1")))
+        unisono (true, 1);
+      else if (scm_is_eq (tag, ly_symbol2scm ("silence2")))
+        unisono (true, 2);
+      else if (scm_is_eq (tag, ly_symbol2scm ("solo1")))
         solo1 ();
-      else if (tag == ly_symbol2scm ("solo2"))
+      else if (scm_is_eq (tag, ly_symbol2scm ("solo2")))
         solo2 ();
       else if (scm_is_symbol (tag))
         {
@@ -509,16 +341,26 @@ Part_combine_iterator::process (Moment m)
         }
     }
 
-  if (first_iter_->ok ())
+  bool any_outlet_changed = false;
+  for (size_t i = 0; i < NUM_PARTS; i++)
     {
-      if (try_process (first_iter_, m))
-        last_playing_ = SOLO1;
+      if (iterators_[i]->ok ())
+        iterators_[i]->process (m);
+
+      if (prev_active_outlets[i] != iterators_[i]->get_outlet ())
+          any_outlet_changed = true;
     }
 
-  if (second_iter_->ok ())
+  if (any_outlet_changed)
     {
-      if (try_process (second_iter_, m))
-        last_playing_ = SOLO2;
+      // Kill multi-measure rests in outlets that were previously active and
+      // are no longer active.
+      for (size_t i = 0; i < NUM_PARTS; i++)
+        {
+          Context *c = prev_active_outlets[i];
+          if (c && !is_active_outlet (c))
+              kill_mmrest (c);
+        }
     }
 }