lily/new-lyric-combine-music-iterator.cc

   1 /*
   2 new-lyric-combine-iterator.cc --  implement New_lyric_combine_music_iterator
   3
   4 source file of the GNU LilyPond music typesetter
   5
   6 (c) 2004 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8  */
   9
  10 #include "translator-group.hh"
  11 #include "lyric-combine-music.hh"
  12 #include "event.hh"
  13 #include "grob.hh"
  14 #include "music-iterator.hh"
  15
  16
  17 class New_lyric_combine_music_iterator : public Music_iterator
  18 {
  19 public:
  20   VIRTUAL_COPY_CONS (Music_iterator);
  21   New_lyric_combine_music_iterator ();
  22   New_lyric_combine_music_iterator (New_lyric_combine_music_iterator const&src);
  23   DECLARE_SCHEME_CALLBACK(constructor, ());
  24 protected:
  25   virtual void construct_children ();
  26   virtual Moment pending_moment () const;
  27   virtual void do_quit();
  28   virtual void process (Moment);
  29   virtual Music_iterator *try_music_in_children (Music *) const;
  30   virtual bool run_always ()const;
  31   virtual bool ok () const;
  32   virtual void derived_mark () const;
  33 private:
  34   bool start_new_syllable () ;
  35   void find_thread ();
  36
  37   Translator_group * lyrics_context_;
  38   Translator_group* music_context_;
  39   Music_iterator * lyric_iter_;
  40 };
  41
  42 /*
  43   Ugh, why static?
  44  */
  45 static Music *busy_ev;
  46 static Music *start_ev;
  47 static Music *melisma_playing_ev;
  48
  49 New_lyric_combine_music_iterator::New_lyric_combine_music_iterator ()
  50 {
  51   lyric_iter_ =0;
  52   music_context_ =0;
  53   lyrics_context_ = 0;
  54   if (!busy_ev)
  55     {
  56       busy_ev
  57         = make_music_by_name (ly_symbol2scm ("BusyPlayingEvent"));
  58       start_ev
  59         = make_music_by_name (ly_symbol2scm ("StartPlayingEvent"));
  60       melisma_playing_ev
  61         = make_music_by_name (ly_symbol2scm ("MelismaPlayingEvent"));
  62     }
  63 }
  64
  65 bool
  66 New_lyric_combine_music_iterator::start_new_syllable ()
  67 {
  68   bool b = music_context_->try_music (busy_ev);
  69
  70   if (!b)
  71     return false;
  72
  73   if (!to_boolean (lyrics_context_->get_property ("ignoreMelismata")))
  74     {
  75       bool m = music_context_->try_music (melisma_playing_ev);
  76       if (m)
  77         return false;
  78     }
  79
  80   return true;
  81 }
  82
  83 Moment
  84 New_lyric_combine_music_iterator::pending_moment () const
  85 {
  86   Moment m;
  87
  88   m.set_infinite (1);
  89
  90   return m;
  91 }
  92
  93 bool
  94 New_lyric_combine_music_iterator::run_always () const
  95 {
  96   return true;
  97 }
  98
  99 bool
 100 New_lyric_combine_music_iterator::ok () const
 101 {
 102   return lyric_iter_ && lyric_iter_->ok ();
 103 }
 104
 105 void
 106 New_lyric_combine_music_iterator::derived_mark()const
 107 {
 108   if (lyric_iter_)
 109     scm_gc_mark (lyric_iter_->self_scm ());
 110   if (lyrics_context_)
 111     scm_gc_mark (lyrics_context_->self_scm ());
 112   if (music_context_)
 113     scm_gc_mark (music_context_->self_scm ());
 114 }
 115
 116 /*
 117   ID == "" means accept any ID.
 118  */
 119 Translator_group *
 120 find_context_below (Translator_group * where,
 121                     String type, String id)
 122 {
 123   if (where->context_name () == type)
 124     {
 125       if (id == "" || where->id_string_ == id)
 126         return where;
 127     }
 128
 129   Translator_group * found = 0;
 130   for (SCM s = where->trans_group_list_;
 131        !found && gh_pair_p (s); s = gh_cdr (s))
 132     {
 133       Translator_group * tr = dynamic_cast<Translator_group*> (unsmob_translator (gh_car (s)));
 134
 135
 136       found = find_context_below (tr, type, id);
 137     }
 138
 139   return found;
 140 }
 141
 142
 143
 144 void
 145 New_lyric_combine_music_iterator::construct_children ()
 146 {
 147   Music *m = unsmob_music (get_music ()->get_mus_property ("element"));
 148   lyric_iter_ = unsmob_iterator (get_iterator (m));
 149
 150   if (lyric_iter_)
 151     {
 152       lyrics_context_ = find_context_below (lyric_iter_->report_to (), "LyricsVoice", "");
 153     }
 154
 155   find_thread ();
 156 }
 157
 158 void
 159 New_lyric_combine_music_iterator::find_thread ()
 160 {
 161   if (!music_context_)
 162     {
 163       SCM voice_name = get_music ()->get_mus_property ("associated-context");
 164
 165       if (gh_string_p (voice_name))
 166         {
 167           Translator_group *t = report_to ();
 168           while (t && t->daddy_trans_)
 169             t = t->daddy_trans_;
 170
 171           String name =  ly_scm2string (voice_name);
 172           Translator_group* voice = find_context_below (t, "Voice", name);
 173           Translator_group *thread = 0;
 174           if (voice)
 175             thread = find_context_below (voice, "Thread", "");
 176           else
 177             get_music ()->origin ()->warning (_f("Cannot find Voice: %s\n", name.to_str0()));
 178
 179           if (thread)
 180             music_context_ = thread;
 181
 182           if (lyrics_context_ && voice)
 183             lyrics_context_->set_property ("associatedVoiceContext",  voice->self_scm ());
 184         }
 185     }
 186 }
 187
 188 void
 189 New_lyric_combine_music_iterator::process (Moment )
 190 {
 191   find_thread ();
 192   if (!music_context_)
 193     return ;
 194
 195   if (!music_context_->daddy_trans_)
 196     {
 197       music_context_ = 0;
 198       if (lyrics_context_)
 199         lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext"));
 200     }
 201
 202   if (music_context_
 203       && start_new_syllable () && lyric_iter_->ok ())
 204     {
 205       Moment m= lyric_iter_->pending_moment ();
 206       lyric_iter_->process (m);
 207     }
 208 }
 209
 210 void
 211 New_lyric_combine_music_iterator::do_quit ()
 212 {
 213   if (lyric_iter_)
 214     lyric_iter_->quit();
 215 }
 216
 217 New_lyric_combine_music_iterator::New_lyric_combine_music_iterator (New_lyric_combine_music_iterator const & src)
 218     : Music_iterator (src)
 219 {
 220   lyric_iter_ = 0;
 221
 222   if (src.lyric_iter_)
 223     lyric_iter_ =  src.lyric_iter_->clone ();
 224
 225   if (lyric_iter_)
 226     scm_gc_unprotect_object (lyric_iter_->self_scm());
 227
 228   music_context_ = src.music_context_;
 229   lyric_iter_ = src.lyric_iter_;
 230
 231
 232   assert (false);               // shouldn't copy, really.
 233 }
 234
 235
 236 Music_iterator*
 237 New_lyric_combine_music_iterator::try_music_in_children (Music *m) const
 238 {
 239   return lyric_iter_->try_music (m);
 240 }
 241
 242
 243 IMPLEMENT_CTOR_CALLBACK (New_lyric_combine_music_iterator);