]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/context.cc
Merge branch 'master' of git://git.sv.gnu.org/lilypond
[lilypond.git] / lily / context.cc
index 5e97a6171de24c24830548e4c141ed763d587dac..45a1562b1f98a6d255c7da7d2af73f065744d66b 100644 (file)
@@ -10,6 +10,7 @@
 
 #include "context-def.hh"
 #include "dispatcher.hh"
+#include "global-context.hh"
 #include "international.hh"
 #include "ly-smobs.icc"
 #include "main.hh"
@@ -17,7 +18,6 @@
 #include "profile.hh"
 #include "program-option.hh"
 #include "scm-hash.hh"
-#include "score-context.hh"
 #include "translator-group.hh"
 #include "warn.hh"
 
@@ -33,15 +33,15 @@ 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);
        }
     }
 }
@@ -59,29 +59,13 @@ 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_);
 }
 
 
@@ -89,7 +73,6 @@ Context::Context (Object_key const *key)
   : key_manager_ (key)
 {
   daddy_context_ = 0;
-  init_ = false;
   aliases_ = SCM_EOL;
   iterator_count_ = 0;
   implementation_ = 0;
@@ -98,7 +81,6 @@ Context::Context (Object_key const *key)
   context_list_ = SCM_EOL;
   definition_ = SCM_EOL;
   definition_mods_ = SCM_EOL;
-  unique_ = -1;
   event_source_ = 0;
   events_below_ = 0;
 
@@ -158,15 +140,15 @@ Context::create_unique_context (SCM name, string id, SCM operations)
     }
 
   /*
-    Don't go up to Global_context, because global goes down to
-    Score_context
+    Don't go up to Global_context, because global goes down to the
+    Score context
   */
   Context *ret = 0;
   if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
     ret = daddy_context_->create_unique_context (name, id, operations);
   else
     {
-      warning (_f ("can't find or create new `%s'",
+      warning (_f ("cannot find or create new `%s'",
                   ly_symbol2string (name).c_str ()));
       ret = 0;
     }
@@ -220,51 +202,157 @@ Context::find_create_context (SCM n, string id, SCM operations)
     }
 
   /*
-    Don't go up to Global_context, because global goes down to
-    Score_context
+    Don't go up to Global_context, because global goes down to the
+    Score context
   */
   Context *ret = 0;
   if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
     ret = daddy_context_->find_create_context (n, id, operations);
   else
     {
-      warning (_f ("can't find or create `%s' called `%s'",
+      warning (_f ("cannot find or create `%s' called `%s'",
                   ly_symbol2string (n).c_str (), id));
       ret = 0;
     }
   return ret;
 }
 
-Context *
-Context::create_context (Context_def *cdef,
-                        string id,
-                        SCM ops)
+IMPLEMENT_LISTENER (Context, acknowledge_infant);
+void
+Context::acknowledge_infant (SCM sev)
+{
+  infant_event_ = unsmob_stream_event (sev);
+}
+
+IMPLEMENT_LISTENER (Context, set_property_from_event);
+void
+Context::set_property_from_event (SCM sev)
+{
+  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)
+       set_property (sym, val);
+    }
+}
+
+IMPLEMENT_LISTENER (Context, unset_property_from_event);
+void
+Context::unset_property_from_event (SCM sev)
 {
-  int unique = get_global_context()->new_unique();
+  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);
+}
 
-  // TODO: The following should be carried out by a listener.
-  string type = ly_symbol2string (cdef->get_context_name ());
+/*
+  Creates a new context from a CreateContext event, and sends an
+  AnnounceNewContext event to this context.
+*/
+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);
-  Context *new_context
-    = cdef->instantiate (ops, key);
+  
+  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;
-  new_context->unique_ = unique;
   
+  /* 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_);
-  
-  add_context (new_context);
+  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);
-  events_below_->register_as_listener (new_context->events_below_);
 
-  // TODO: The above operations should be performed by a listener to the following event.
-  send_stream_event (this, "CreateContext",
-                     ly_symbol2scm ("unique"), scm_int2num (unique),
+  send_stream_event (this, "AnnounceNewContext", 0,
+                    ly_symbol2scm ("context"), new_context->self_scm (),
+                    ly_symbol2scm ("creator"), sev);
+}
+
+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);
 
-  return new_context;
+  if (!infant || infant->get_parent_context () != this)
+    {
+      programming_error ("create_context: can't locate newly created context");
+      return 0;
+    }
+
+  return infant;
 }
 
 /*
@@ -297,7 +385,7 @@ Context::get_default_interpreter ()
       Context_def *t = unsmob_context_def (st);
       if (!t)
        {
-         warning (_f ("can't find or create: `%s'", name.c_str ()));
+         warning (_f ("cannot find or create: `%s'", name.c_str ()));
          t = unsmob_context_def (this->definition_);
        }
 
@@ -351,12 +439,12 @@ 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, SCM props[])
+Context::internal_send_stream_event (SCM type, Input *origin, SCM props[])
 {
-  Stream_event *e = new Stream_event (this, type);
+  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]);
+      e->set_property (props[i], props[i+1]);
     }
   event_source_->broadcast (e);
   e->unprotect ();
@@ -381,12 +469,20 @@ Context::add_alias (SCM sym)
 }
 
 void
-Context::internal_set_property (SCM sym, SCM val)
+Context::internal_set_property (SCM sym, SCM val
+#ifndef NDEBUG
+                               , char const *file, int line, char const *fun
+#endif
+                               )
 {
 #ifndef NDEBUG
+  (void) file;
+  (void) line;
+  (void) fun;
+#endif
+
   if (do_internal_type_checking_global)
     assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
-#endif
 
   properties_dict ()->set (sym, val);
 }
@@ -400,19 +496,38 @@ 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)
 {
-  assert (trans);
+  Stream_event *ev = unsmob_stream_event (sev);
+  Context *to = unsmob_context (ev->get_property ("context"));
 
-  context_list_ = scm_delq_x (trans->self_scm (), context_list_);
-  trans->daddy_context_ = 0;
-  return trans;
+  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)
+{
+  /* ugh, the translator group should listen to RemoveContext events by itself */
+  Translator_group *impl = implementation ();
+  if (impl)
+    impl->disconnect_from_context ();
+  disconnect_from_parent ();
+}
+
+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;
+}
 
 /*
   ID == "" means accept any ID.
@@ -439,25 +554,6 @@ find_context_below (Context *where,
   return found;
 }
 
-Context *
-find_context_below (Context *where,
-                    int unique)
-{
-  if (where->get_unique () == unique)
-    return where;
-
-  Context *found = 0;
-  for (SCM s = where->children_contexts ();
-       !found && scm_is_pair (s); s = scm_cdr (s))
-    {
-      Context *tr = unsmob_context (scm_car (s));
-
-      found = find_context_below (tr, unique);
-    }
-
-  return found;
-}
-
 SCM
 Context::properties_as_alist () const
 {
@@ -477,12 +573,10 @@ Context::context_name () const
   return ly_symbol2string (context_name_symbol ());
 }
 
-Score_context *
+Context *
 Context::get_score_context () const
 {
-  if (Score_context *sc = dynamic_cast<Score_context *> ((Context *) this))
-    return sc;
-  else if (daddy_context_)
+  if (daddy_context_)
     return daddy_context_->get_score_context ();
   else
     return 0;
@@ -559,10 +653,15 @@ Context::mark_smob (SCM sm)
   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 ());
+
+  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_;
 }
@@ -571,20 +670,6 @@ IMPLEMENT_SMOBS (Context);
 IMPLEMENT_DEFAULT_EQUAL_P (Context);
 IMPLEMENT_TYPE_P (Context, "ly:context?");
 
-bool
-Context::try_music (Music *m)
-{
-  Translator_group *t = implementation ();
-  if (!t)
-    return false;
-
-  bool b = t->try_music (m);
-  if (!b && daddy_context_)
-    b = daddy_context_->try_music (m);
-
-  return b;
-}
-
 Global_context *
 Context::get_global_context () const
 {
@@ -653,7 +738,7 @@ measure_position (Context const *context)
 void
 set_context_property_on_children (Context *trans, SCM sym, SCM val)
 {
-  trans->internal_set_property (sym, ly_deep_copy (val));
+  trans->set_property (sym, ly_deep_copy (val));
   for (SCM p = trans->children_contexts (); scm_is_pair (p); p = scm_cdr (p))
     {
       Context *trg = unsmob_context (scm_car (p));