lily/translator-group.cc

   1 /*
   2   translator-group.cc -- implement Translator_group
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>,
   7                  Erik Sandberg <mandolaerik@gmail.com>
   8 */
   9
  10 #include "translator-group.hh"
  11
  12 #include "context-def.hh"
  13 #include "context.hh"
  14 #include "dispatcher.hh"
  15 #include "international.hh"
  16 #include "main.hh"
  17 #include "music.hh"
  18 #include "output-def.hh"
  19 #include "scm-hash.hh"
  20 #include "stream-event.hh"
  21 #include "warn.hh"
  22
  23 Translator_group *
  24 Translator_group::get_daddy_translator () const
  25 {
  26   return context ()->get_parent_context ()->implementation ();
  27 }
  28
  29 void
  30 translator_each (SCM list, Translator_method method)
  31 {
  32   for (SCM p = list; scm_is_pair (p); p = scm_cdr (p))
  33     (unsmob_translator (scm_car (p))->*method) ();
  34 }
  35
  36 void
  37 Translator_group::initialize ()
  38 {
  39   precompute_method_bindings ();
  40 }
  41
  42 void
  43 Translator_group::connect_to_context (Context *c)
  44 {
  45   if (context_)
  46     programming_error ("already connected to a context");
  47   context_ = c;
  48   c->event_source ()->add_listener (GET_LISTENER (eat_event), ly_symbol2scm ("MusicEvent"));
  49 }
  50
  51 void
  52 Translator_group::finalize ()
  53 {
  54 }
  55
  56 bool
  57 translator_accepts_any_of (Translator *tr, SCM ifaces)
  58 {
  59   SCM ack_ifs = scm_assoc (ly_symbol2scm ("events-accepted"),
  60                            tr->translator_description ());
  61   ack_ifs = scm_cdr (ack_ifs);
  62   for (SCM s = ifaces; scm_is_pair (s); s = scm_cdr (s))
  63     if (scm_c_memq (scm_car (s), ack_ifs) != SCM_BOOL_F)
  64       return true;
  65   return false;
  66 }
  67
  68 SCM
  69 find_accept_translators (SCM gravlist, SCM ifaces)
  70 {
  71   SCM l = SCM_EOL;
  72   for (SCM s = gravlist; scm_is_pair (s); s = scm_cdr (s))
  73     {
  74       Translator *tr = unsmob_translator (scm_car (s));
  75       if (translator_accepts_any_of (tr, ifaces))
  76         l = scm_cons (tr->self_scm (), l);
  77     }
  78   l = scm_reverse_x (l, SCM_EOL);
  79
  80   return l;
  81 }
  82
  83 IMPLEMENT_LISTENER (Translator_group, eat_event);
  84 void
  85 Translator_group::eat_event (SCM sev)
  86 {
  87   Stream_event *ev = unsmob_stream_event (sev);
  88   SCM sm = ev->get_property ("music");
  89   Music *m = unsmob_music (sm);
  90   try_music (m);
  91 }
  92
  93 bool
  94 Translator_group::try_music (Music *m)
  95 {
  96   SCM name = scm_sloppy_assq (ly_symbol2scm ("name"),
  97                               m->get_property_alist (false));
  98
  99   if (!scm_is_pair (name))
 100     return false;
 101
 102   name = scm_cdr (name);
 103   SCM accept_list = scm_hashq_ref (accept_hash_table_, name, SCM_UNDEFINED);
 104   if (accept_list == SCM_BOOL_F)
 105     {
 106       accept_list = find_accept_translators (get_simple_trans_list (),
 107                                              m->get_property ("types"));
 108       scm_hashq_set_x (accept_hash_table_, name, accept_list);
 109     }
 110
 111   for (SCM p = accept_list; scm_is_pair (p); p = scm_cdr (p))
 112     {
 113       Translator *t = unsmob_translator (scm_car (p));
 114       if (t && t->try_music (m))
 115         return true;
 116     }
 117
 118   // We couldn't swallow the event in this context. Try parent.
 119   Context *p = context ()->get_parent_context ();
 120   // Global context's translator group is a dummy, so don't try it.
 121   if (p->get_parent_context())
 122     // ES todo: Make Translators listeners directly instead.
 123     return p->implementation ()->try_music (m);
 124   else
 125     // We have tried all possible contexts. Give up.
 126     m->origin ()->warning (_f ("junking event: `%s'", m->name ()));
 127   return false;
 128 }
 129
 130 SCM
 131 Translator_group::get_simple_trans_list ()
 132 {
 133   return simple_trans_list_;
 134 }
 135
 136 void
 137 precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
 138 {
 139   Translator_group *tg
 140     = dynamic_cast<Translator_group *> (c->implementation ());
 141
 142   if (dir == DOWN)
 143     {
 144       tg->precomputed_translator_foreach (idx);
 145       tg->call_precomputed_self_method (idx);
 146     }
 147
 148   for (SCM s = c->children_contexts (); scm_is_pair (s);
 149        s = scm_cdr (s))
 150     precomputed_recurse_over_translators (unsmob_context (scm_car (s)), idx, dir);
 151
 152   if (dir == UP)
 153     {
 154       tg->precomputed_translator_foreach (idx);
 155       tg->call_precomputed_self_method (idx);
 156     }
 157 }
 158
 159 void
 160 recurse_over_translators (Context *c, Translator_method ptr, Translator_group_method tg_ptr, Direction dir)
 161 {
 162   Translator_group *tg
 163     = dynamic_cast<Translator_group *> (c->implementation ());
 164
 165   if (dir == DOWN)
 166     {
 167       (tg->*tg_ptr) ();
 168       translator_each (tg->get_simple_trans_list (), ptr);
 169     }
 170
 171   for (SCM s = c->children_contexts (); scm_is_pair (s);
 172        s = scm_cdr (s))
 173     recurse_over_translators (unsmob_context (scm_car (s)), ptr, tg_ptr, dir);
 174
 175   if (dir == UP)
 176     {
 177       translator_each (tg->get_simple_trans_list (),
 178                        ptr);
 179
 180       (tg->*tg_ptr) ();
 181     }
 182 }
 183
 184 Translator_group::Translator_group ()
 185 {
 186   simple_trans_list_ = SCM_EOL;
 187   accept_hash_table_ = SCM_EOL;
 188   context_ = 0;
 189   smobify_self ();
 190
 191   accept_hash_table_ = scm_c_make_hash_table (19);
 192 }
 193
 194 void
 195 Translator_group::derived_mark () const
 196 {
 197 }
 198
 199 void
 200 Translator_group::precompute_method_bindings ()
 201 {
 202   for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
 203     {
 204       Translator *tr = unsmob_translator (scm_car (s));
 205       Translator_void_method_ptr ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT];
 206       tr->fetch_precomputable_methods (ptrs);
 207
 208       assert (tr);
 209       for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
 210         {
 211           if (ptrs[i])
 212             precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i]));
 213         }
 214     }
 215
 216   fetch_precomputable_methods (precomputed_self_method_bindings_);
 217 }
 218
 219 void
 220 Translator_group::precomputed_translator_foreach (Translator_precompute_index idx)
 221 {
 222   vector<Translator_method_binding> &bindings (precomputed_method_bindings_[idx]);
 223   for (vsize i = 0; i < bindings.size (); i++)
 224     bindings[i].invoke ();
 225 }
 226
 227 void
 228 Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[])
 229 {
 230   for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
 231     ptrs[i] = 0;
 232 }
 233
 234 void
 235 Translator_group::call_precomputed_self_method (Translator_precompute_index idx)
 236 {
 237   if (precomputed_self_method_bindings_[idx])
 238     (*precomputed_self_method_bindings_[idx]) (this);
 239 }
 240
 241 Translator_group::~Translator_group ()
 242 {
 243 }
 244
 245 #include "ly-smobs.icc"
 246
 247 IMPLEMENT_SMOBS (Translator_group);
 248 IMPLEMENT_DEFAULT_EQUAL_P (Translator_group);
 249 IMPLEMENT_TYPE_P (Translator_group, "ly:translator-group?");
 250
 251 int
 252 Translator_group::print_smob (SCM s, SCM port, scm_print_state *)
 253 {
 254   Translator_group *me = (Translator_group *) SCM_CELL_WORD_1 (s);
 255   scm_puts ("#<Translator_group ", port);
 256   scm_puts (me->class_name (), port);
 257   scm_display (me->simple_trans_list_, port);
 258   scm_puts (" >", port);
 259   return 1;
 260 }
 261
 262 SCM
 263 Translator_group::mark_smob (SCM smob)
 264 {
 265   Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob);
 266
 267   me->derived_mark ();
 268   scm_gc_mark (me->accept_hash_table_);
 269   return me->simple_trans_list_;
 270 }