]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/context.cc
* lily/ various: Introduce stream events of types Prepare,
[lilypond.git] / lily / context.cc
index b1e4a6629de9589c28e907ae6cf4d4c3d482912b..f39fb5e1c29e4e9e7e3e298dfecce272015887ef 100644 (file)
@@ -9,8 +9,8 @@
 #include "context.hh"
 
 #include "context-def.hh"
+#include "dispatcher.hh"
 #include "international.hh"
-#include "lilypond-key.hh"
 #include "ly-smobs.icc"
 #include "main.hh"
 #include "output-def.hh"
@@ -25,7 +25,7 @@ bool
 Context::is_removable () const
 {
   return context_list_ == SCM_EOL && ! iterator_count_
-    && !dynamic_cast<Score_context const *> (this);
+    && !dynamic_cast<Global_context const *> (daddy_context_);
 }
 
 void
@@ -33,20 +33,21 @@ Context::check_removal ()
 {
   for (SCM p = context_list_; scm_is_pair (p); p = scm_cdr (p))
     {
-      Context *trg = unsmob_context (scm_car (p));
+      Context *ctx = unsmob_context (scm_car (p));
 
-      trg->check_removal ();
-      if (trg->is_removable ())
+      ctx->check_removal ();
+      if (ctx->is_removable ())
        {
-         recurse_over_translators (trg, &Translator::finalize,
+         recurse_over_translators (ctx, &Translator::finalize,
                                    &Translator_group::finalize,
                                    UP);
-         remove_context (trg);
+         send_stream_event (ctx, "RemoveContext", 0, 0);
        }
     }
 }
 
-Context::Context (Context const &)
+Context::Context (Context const &src)
+  : key_manager_ (src.key_manager_)
 {
   assert (false);
 }
@@ -58,37 +59,20 @@ Context::properties_dict () const
 }
 
 void
-Context::add_context (Context *t)
+Context::add_context (Context *child)
 {
-  SCM ts = t->self_scm ();
   context_list_ = ly_append2 (context_list_,
-                             scm_cons (ts, SCM_EOL));
-
-  t->daddy_context_ = this;
-  if (!t->init_)
-    {
-      t->init_ = true;
+                             scm_cons (child->self_scm (), SCM_EOL));
 
-      t->unprotect ();
-      Context_def *td = unsmob_context_def (t->definition_);
-
-      /* This cannot move before add_context (), because \override
-        operations require that we are in the hierarchy.  */
-      td->apply_default_property_operations (t);
-
-      recurse_over_translators (t,
-                               &Translator::initialize,
-                               &Translator_group::initialize,
-                               DOWN);
-    }
+  child->daddy_context_ = this;
+  this->events_below_->register_as_listener (child->events_below_);
 }
 
 
 Context::Context (Object_key const *key)
+  : key_manager_ (key)
 {
-  key_ = key;
   daddy_context_ = 0;
-  init_ = false;
   aliases_ = SCM_EOL;
   iterator_count_ = 0;
   implementation_ = 0;
@@ -96,36 +80,42 @@ Context::Context (Object_key const *key)
   accepts_list_ = SCM_EOL;
   context_list_ = SCM_EOL;
   definition_ = SCM_EOL;
+  definition_mods_ = SCM_EOL;
+  event_source_ = 0;
+  events_below_ = 0;
 
   smobify_self ();
 
   Scheme_hash_table *tab = new Scheme_hash_table;
   properties_scm_ = tab->unprotect ();
+  event_source_ = new Dispatcher ();
+  event_source_->unprotect ();
+  events_below_ = new Dispatcher ();
+  events_below_->unprotect ();
 
   /*
     UGH UGH
     const correctness.
   */
-  if (key_)
-    ((Object_key *)key)->unprotect ();
+  key_manager_.unprotect();
 }
 
 /* TODO:  this shares code with find_create_context ().  */
 Context *
-Context::create_unique_context (SCM n, SCM operations)
+Context::create_unique_context (SCM name, string id, SCM operations)
 {
   /*
     Don't create multiple score contexts.
   */
-  if (dynamic_cast<Global_context *> (this)
-      && dynamic_cast<Global_context *> (this)->get_score_context ())
-    return get_score_context ()->create_unique_context (n, operations);
+  Global_context *gthis = dynamic_cast<Global_context *> (this);
+  if (gthis && gthis->get_score_context ())
+    return gthis->get_score_context ()->create_unique_context (name, id, operations);
 
   /*
     TODO: use accepts_list_.
   */
   vector<Context_def*> path
-    = unsmob_context_def (definition_)->path_to_acceptable_context (n, get_output_def ());
+    = unsmob_context_def (definition_)->path_to_acceptable_context (name, get_output_def ());
 
   if (path.size ())
     {
@@ -134,10 +124,15 @@ Context::create_unique_context (SCM n, SCM operations)
       // start at 1.  The first one (index 0) will be us.
       for (vsize i = 0; i < path.size (); i++)
        {
-         SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
-
+         SCM ops = SCM_EOL;
+         string id_str = "\\new";
+         if (i == path.size () - 1)
+           {
+             ops = operations;
+             id_str = id;
+           }
          current = current->create_context (path[i],
-                                            "\\new",
+                                            id_str,
                                             ops);
        }
 
@@ -150,11 +145,11 @@ Context::create_unique_context (SCM n, SCM operations)
   */
   Context *ret = 0;
   if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
-    ret = daddy_context_->create_unique_context (n, operations);
+    ret = daddy_context_->create_unique_context (name, id, operations);
   else
     {
       warning (_f ("can't find or create new `%s'",
-                  ly_symbol2string (n).c_str ()));
+                  ly_symbol2string (name).c_str ()));
       ret = 0;
     }
   return ret;
@@ -166,9 +161,9 @@ Context::find_create_context (SCM n, string id, SCM operations)
   /*
     Don't create multiple score contexts.
   */
-  if (dynamic_cast<Global_context *> (this)
-      && dynamic_cast<Global_context *> (this)->get_score_context ())
-    return get_score_context ()->find_create_context (n, id, operations);
+  Global_context *gthis = dynamic_cast<Global_context *> (this);
+  if (gthis && gthis->get_score_context ())
+    return gthis->get_score_context ()->find_create_context (n, id, operations);
 
   if (Context *existing = find_context_below (this, n, id))
     return existing;
@@ -222,70 +217,142 @@ Context::find_create_context (SCM n, string id, SCM operations)
   return ret;
 }
 
-Context *
-Context::create_context (Context_def *cdef,
-                        string id,
-                        SCM ops)
+IMPLEMENT_LISTENER (Context, acknowledge_infant);
+void
+Context::acknowledge_infant (SCM sev)
 {
-  string type = ly_symbol2string (cdef->get_context_name ());
-  Object_key const *key = get_context_key (type, id);
-  Context *new_context
-    = cdef->instantiate (ops, key);
-
-  new_context->id_string_ = id;
-  add_context (new_context);
-  apply_property_operations (new_context, ops);
-
-  return new_context;
+  infant_event_ = unsmob_stream_event (sev);
 }
 
-Object_key const *
-Context::get_context_key (string type, string id)
+IMPLEMENT_LISTENER (Context, set_property_from_event);
+void
+Context::set_property_from_event (SCM sev)
 {
-  if (!use_object_keys)
-    return 0;
-
-  string now_key = type + "@" + id;
-
-  int disambiguation_count = 0;
-  if (context_counts_.find (now_key) != context_counts_.end ())
-    disambiguation_count = context_counts_[now_key];
-
-  context_counts_[now_key] = disambiguation_count + 1;
-
-  return new Lilypond_context_key (key (),
-                                  now_mom (),
-                                  type, id,
-                                  disambiguation_count);
+  Stream_event *ev = unsmob_stream_event (sev);
+  
+  SCM sym = ev->get_property ("symbol");
+  if (scm_is_symbol (sym))
+    {
+      SCM val = ev->get_property ("value");
+      bool ok = true;
+      if (val != SCM_EOL)
+       ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
+      if (ok)
+       internal_set_property (sym, val);
+    }
 }
 
-Object_key const *
-Context::get_grob_key (string name)
+IMPLEMENT_LISTENER (Context, unset_property_from_event);
+void
+Context::unset_property_from_event (SCM sev)
 {
-  if (!use_object_keys)
-    return 0;
-
-  return create_grob_key (name);
+  Stream_event *ev = unsmob_stream_event (sev);
+  
+  SCM sym = ev->get_property ("symbol");
+  type_check_assignment (sym, SCM_EOL, ly_symbol2scm ("translation-type?"));
+  unset_property (sym);
 }
 
 /*
-  We want to have a key for some objects anyway, so we can invent a
-  unique identifier for each (book,score) tuple.
+  Creates a new context from a CreateContext event, and sends an
+  AnnounceNewContext event to this context.
 */
-Object_key const *
-Context::create_grob_key (string name)
-{
-  int disambiguation_count = 0;
-  if (grob_counts_.find (name) != grob_counts_.end ())
-    disambiguation_count = grob_counts_[name];
-  grob_counts_[name] = disambiguation_count + 1;
+IMPLEMENT_LISTENER (Context, create_context_from_event);
+void
+Context::create_context_from_event (SCM sev)
+{
+  Stream_event *ev = unsmob_stream_event (sev);
+  
+  string id = ly_scm2string (ev->get_property ("id"));
+  SCM ops = ev->get_property ("ops");
+  SCM type_scm = ev->get_property ("type");
+  string type = ly_symbol2string (type_scm);
+  Object_key const *key = key_manager_.get_context_key (now_mom(), type, id);
+  
+  vector<Context_def*> path
+    = unsmob_context_def (definition_)->path_to_acceptable_context (type_scm, get_output_def ());
+  if (path.size () != 1)
+    {
+      programming_error (_f ("Invalid CreateContext event: Cannot create %s context", type.c_str ()));
+      return;
+    }
+  Context_def *cdef = path[0];
+  
+  Context *new_context = cdef->instantiate (ops, key);
+
+  new_context->id_string_ = id;
+  
+  /* Register various listeners:
+      - Make the new context hear events that universally affect contexts
+      - connect events_below etc. properly */
+  /* We want to be the first ones to hear our own events. Therefore, wait
+     before registering events_below_ */
+  new_context->event_source ()->
+    add_listener (GET_LISTENER (new_context->create_context_from_event),
+                  ly_symbol2scm ("CreateContext"));
+  new_context->event_source ()->
+    add_listener (GET_LISTENER (new_context->remove_context),
+                  ly_symbol2scm ("RemoveContext"));
+  new_context->event_source ()->
+    add_listener (GET_LISTENER (new_context->change_parent),
+                  ly_symbol2scm ("ChangeParent"));
+  new_context->event_source ()->
+    add_listener (GET_LISTENER (new_context->set_property_from_event),
+                  ly_symbol2scm ("SetProperty"));
+  new_context->event_source ()->
+    add_listener (GET_LISTENER (new_context->unset_property_from_event),
+                  ly_symbol2scm ("UnsetProperty"));
+
+  new_context->events_below_->register_as_listener (new_context->event_source_);
+  this->add_context (new_context);
+
+  new_context->unprotect ();
+
+  Context_def *td = unsmob_context_def (new_context->definition_);
+
+  /* This cannot move before add_context (), because \override
+     operations require that we are in the hierarchy.  */
+  td->apply_default_property_operations (new_context);
+  apply_property_operations (new_context, ops);
+
+  send_stream_event (this, "AnnounceNewContext", 0,
+                    ly_symbol2scm ("context"), new_context->self_scm (),
+                    ly_symbol2scm ("creator"), sev);
+}
 
-  Object_key *k = new Lilypond_grob_key (key (),
-                                        now_mom (),
-                                        name,
-                                        disambiguation_count);
+Context *
+Context::create_context (Context_def *cdef,
+                        string id,
+                        SCM ops)
+{
+  infant_event_ = 0;
+  /* TODO: This is fairly misplaced. We can fix this when we have taken out all
+     iterator specific stuff from the Context class */
+  event_source_->
+    add_listener (GET_LISTENER (acknowledge_infant),
+                  ly_symbol2scm ("AnnounceNewContext"));
+  /* The CreateContext creates a new context, and sends an announcement of the
+     new context through another event. That event will be stored in
+     infant_event_ to create a return value. */
+  send_stream_event (this, "CreateContext", 0,
+                     ly_symbol2scm ("ops"), ops,
+                     ly_symbol2scm ("type"), cdef->get_context_name (),
+                     ly_symbol2scm ("id"), scm_makfrom0str (id.c_str ()));
+  event_source_->
+    remove_listener (GET_LISTENER (acknowledge_infant),
+                     ly_symbol2scm ("AnnounceNewContext"));
+
+  assert (infant_event_);
+  SCM infant_scm = infant_event_->get_property ("context");
+  Context *infant = unsmob_context (infant_scm);
+
+  if (!infant || infant->get_parent_context () != this)
+    {
+      programming_error ("create_context: can't locate newly created context");
+      return 0;
+    }
 
-  return k;
+  return infant;
 }
 
 /*
@@ -323,10 +390,7 @@ Context::get_default_interpreter ()
        }
 
       Context *tg = create_context (t, "", SCM_EOL);
-      if (!tg->is_bottom_context ())
-       return tg->get_default_interpreter ();
-      else
-       return tg;
+      return tg->get_default_interpreter ();
     }
   return this;
 }
@@ -369,6 +433,23 @@ Context::internal_get_property (SCM sym) const
   return val;
 }
 
+/*
+Called by the send_stream_event macro. props is a 0-terminated array of
+properties and corresponding values, interleaved. This method should not
+be called from any other place than the send_stream_event macro.
+*/
+void
+Context::internal_send_stream_event (SCM type, Input *origin, SCM props[])
+{
+  Stream_event *e = new Stream_event (type, origin);
+  for (int i = 0; props[i]; i += 2)
+    {
+      e->internal_set_property (props[i], props[i+1]);
+    }
+  event_source_->broadcast (e);
+  e->unprotect ();
+}
+
 bool
 Context::is_alias (SCM sym) const
 {
@@ -407,17 +488,35 @@ Context::unset_property (SCM sym)
   properties_dict ()->remove (sym);
 }
 
-/**
-   Remove a context from the hierarchy.
-*/
-Context *
-Context::remove_context (Context *trans)
+IMPLEMENT_LISTENER (Context, change_parent);
+void
+Context::change_parent (SCM sev)
+{
+  Stream_event *ev = unsmob_stream_event (sev);
+  Context *to = unsmob_context (ev->get_property ("context"));
+
+  disconnect_from_parent ();
+  to->add_context (this);
+}
+
+/*
+  Die. The next GC sweep should take care of the actual death.
+ */
+IMPLEMENT_LISTENER (Context, remove_context);
+void
+Context::remove_context (SCM)
 {
-  assert (trans);
+  /* ugh, the translator group should listen to RemoveContext events by itself */
+  implementation ()->disconnect_from_context ();
+  disconnect_from_parent ();
+}
 
-  context_list_ = scm_delq_x (trans->self_scm (), context_list_);
-  trans->daddy_context_ = 0;
-  return trans;
+void
+Context::disconnect_from_parent ()
+{
+  daddy_context_->events_below_->unregister_as_listener (this->events_below_);
+  daddy_context_->context_list_ = scm_delq_x (this->self_scm (), daddy_context_->context_list_);
+  daddy_context_ = 0;
 }
 
 /*
@@ -522,20 +621,34 @@ Context::print_smob (SCM s, SCM port, scm_print_state *)
   return 1;
 }
 
+Object_key const *
+Context::get_grob_key (string name)
+{
+  return key_manager_.get_grob_key (now_mom (), name);
+}
+
+Object_key const *
+Context::get_context_key (string name, string id)
+{
+  return key_manager_.get_context_key (now_mom (), name, id);
+}
+
 SCM
 Context::mark_smob (SCM sm)
 {
   Context *me = (Context *) SCM_CELL_WORD_1 (sm);
-  if (me->key_)
-    scm_gc_mark (me->key_->self_scm ());
+  me->key_manager_.gc_mark();
 
   scm_gc_mark (me->context_list_);
   scm_gc_mark (me->aliases_);
   scm_gc_mark (me->definition_);
+  scm_gc_mark (me->definition_mods_);
   scm_gc_mark (me->properties_scm_);
   scm_gc_mark (me->accepts_list_);
   if (me->implementation_)
     scm_gc_mark (me->implementation_->self_scm ());
+  if (me->event_source_) scm_gc_mark (me->event_source_->self_scm ());
+  if (me->events_below_) scm_gc_mark (me->events_below_->self_scm ());
 
   return me->properties_scm_;
 }
@@ -583,8 +696,7 @@ Context::clear_key_disambiguations ()
   if (!use_object_keys)
     return;
 
-  grob_counts_.clear ();
-  context_counts_.clear ();
+  key_manager_.clear ();
   for (SCM s = context_list_; scm_is_pair (s); s = scm_cdr (s))
     unsmob_context (scm_car (s))->clear_key_disambiguations ();
 }
@@ -634,3 +746,16 @@ set_context_property_on_children (Context *trans, SCM sym, SCM val)
       set_context_property_on_children (trg, sym, ly_deep_copy (val));
     }
 }
+
+bool
+melisma_busy (Context *tr)
+{
+  SCM melisma_properties = tr->get_property ("melismaBusyProperties");
+  bool busy = false;
+
+  for (; scm_is_pair (melisma_properties);
+       melisma_properties = scm_cdr (melisma_properties))
+    busy = busy || to_boolean (tr->internal_get_property (scm_car (melisma_properties)));
+
+  return busy;
+}