]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/context.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / context.cc
index d8e5b7bfba32b341f2523cff06350e356d22cc5c..a27db01865b92414d07d37752b407df85d26755a 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  context.cc -- implement Context
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2004--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2004--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "context.hh"
@@ -24,8 +35,8 @@
 bool
 Context::is_removable () const
 {
-  return context_list_ == SCM_EOL && ! iterator_count_
-    && !dynamic_cast<Global_context const *> (daddy_context_);
+  return context_list_ == SCM_EOL && ! client_count_
+         && !dynamic_cast<Global_context const *> (daddy_context_);
 }
 
 void
@@ -37,17 +48,16 @@ Context::check_removal ()
 
       ctx->check_removal ();
       if (ctx->is_removable ())
-       {
-         recurse_over_translators (ctx, &Translator::finalize,
-                                   &Translator_group::finalize,
-                                   UP);
-         send_stream_event (ctx, "RemoveContext", 0, 0);
-       }
+        {
+          recurse_over_translators (ctx, &Translator::finalize,
+                                    &Translator_group::finalize,
+                                    UP);
+          send_stream_event (ctx, "RemoveContext", 0, 0);
+        }
     }
 }
 
-Context::Context (Context const &src)
-  : key_manager_ (src.key_manager_)
+Context::Context (Context const & /* src */)
 {
   assert (false);
 }
@@ -62,22 +72,21 @@ void
 Context::add_context (Context *child)
 {
   context_list_ = ly_append2 (context_list_,
-                             scm_cons (child->self_scm (), SCM_EOL));
+                              scm_cons (child->self_scm (), SCM_EOL));
 
   child->daddy_context_ = this;
   this->events_below_->register_as_listener (child->events_below_);
 }
 
-
-Context::Context (Object_key const *key)
-  : key_manager_ (key)
+Context::Context ()
 {
   daddy_context_ = 0;
   aliases_ = SCM_EOL;
-  iterator_count_ = 0;
+  client_count_ = 0;
   implementation_ = 0;
   properties_scm_ = SCM_EOL;
   accepts_list_ = SCM_EOL;
+  default_child_ = SCM_EOL;
   context_list_ = SCM_EOL;
   definition_ = SCM_EOL;
   definition_mods_ = SCM_EOL;
@@ -92,17 +101,11 @@ Context::Context (Object_key const *key)
   event_source_->unprotect ();
   events_below_ = new Dispatcher ();
   events_below_->unprotect ();
-
-  /*
-    UGH UGH
-    const correctness.
-  */
-  key_manager_.unprotect();
 }
 
 /* TODO:  this shares code with find_create_context ().  */
 Context *
-Context::create_unique_context (SCM name, string id, SCM operations)
+Context::create_unique_context (SCM name, const string &id, SCM operations)
 {
   /*
     Don't create multiple score contexts.
@@ -111,30 +114,25 @@ Context::create_unique_context (SCM name, string id, SCM operations)
   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 (name, get_output_def ());
-
+  vector<Context_def *> path = path_to_acceptable_context (name);
   if (path.size ())
     {
       Context *current = this;
 
-      // start at 1.  The first one (index 0) will be us.
+      // Iterate through the path and create all of the implicit contexts.
       for (vsize i = 0; i < path.size (); i++)
-       {
-         SCM ops = SCM_EOL;
-         string id_str = "\\new";
-         if (i == path.size () - 1)
-           {
-             ops = operations;
-             id_str = id;
-           }
-         current = current->create_context (path[i],
-                                            id_str,
-                                            ops);
-       }
+        {
+          SCM ops = SCM_EOL;
+          string id_str = "\\new";
+          if (i == path.size () - 1)
+            {
+              ops = operations;
+              id_str = id;
+            }
+          current = current->create_context (path[i],
+                                             id_str,
+                                             ops);
+        }
 
       return current;
     }
@@ -148,37 +146,54 @@ Context::create_unique_context (SCM name, string id, SCM operations)
     ret = daddy_context_->create_unique_context (name, id, operations);
   else
     {
-      warning (_f ("can't find or create new `%s'",
-                  ly_symbol2string (name).c_str ()));
+      warning (_f ("cannot find or create new `%s'",
+                   ly_symbol2string (name).c_str ()));
       ret = 0;
     }
   return ret;
 }
 
 Context *
-Context::find_create_context (SCM n, string id, SCM operations)
+Context::find_create_context (SCM n, const string &id, SCM operations)
 {
   /*
     Don't create multiple score contexts.
   */
   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 (gthis)
+    {
+      if (gthis->get_score_context ())
+        return gthis->get_score_context ()->find_create_context (n, id, operations);
+
+      // Special case: If we use \set Timing.xxx = whatever before
+      // Score is established, the alias of Score to Timing will not
+      // be taken into account.  We check for this particular case
+      // here.  Aliases apart from Score-level ones don't warrant
+      // context creation as they could create unwanted contexts, like
+      // RhythmicVoice instead of Voice.  Creating a Score context,
+      // however, can't really do anything wrong.
+
+      SCM score_name = default_child_context_name ();
+      SCM score_def = find_context_def (get_output_def (), score_name);
+
+      if (Context_def *cd = unsmob_context_def (score_def))
+        {
+          if (cd->is_alias (n))
+            return create_context (cd, id, operations);
+        }
+    }
+
 
   if (Context *existing = find_context_below (this, n, id))
     return existing;
 
   if (n == ly_symbol2scm ("Bottom"))
     {
-      Context *tg = get_default_interpreter ();
+      Context *tg = get_default_interpreter (id);
       return tg;
     }
 
-  /*
-    TODO: use accepts_list_.
-  */
-  vector<Context_def*> path
-    = unsmob_context_def (definition_)->path_to_acceptable_context (n, get_output_def ());
+  vector<Context_def *> path = path_to_acceptable_context (n);
 
   if (path.size ())
     {
@@ -186,17 +201,17 @@ Context::find_create_context (SCM n, string id, 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 = (i == path.size () - 1) ? operations : SCM_EOL;
 
-         string this_id = "";
-         if (i == path.size () -1)
-           this_id = id;
+          string this_id = "";
+          if (i == path.size () - 1)
+            this_id = id;
 
-         current = current->create_context (path[i],
-                                            this_id,
-                                            ops);
-       }
+          current = current->create_context (path[i],
+                                             this_id,
+                                             ops);
+        }
 
       return current;
     }
@@ -210,8 +225,8 @@ Context::find_create_context (SCM n, string id, SCM operations)
     ret = daddy_context_->find_create_context (n, id, operations);
   else
     {
-      warning (_f ("can't find or create `%s' called `%s'",
-                  ly_symbol2string (n).c_str (), id));
+      warning (_f ("cannot find or create `%s' called `%s'",
+                   ly_symbol2string (n).c_str (), id));
       ret = 0;
     }
   return ret;
@@ -229,16 +244,22 @@ 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");
+
+      if (SCM_UNBNDP (val)) {
+        unset_property (sym);
+        return;
+      }
+          
       bool ok = true;
-      if (val != SCM_EOL)
-       ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
+      ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
+
       if (ok)
-       set_property (sym, val);
+        set_property (sym, val);
     }
 }
 
@@ -247,7 +268,7 @@ void
 Context::unset_property_from_event (SCM sev)
 {
   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);
@@ -262,46 +283,45 @@ 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 ());
+
+  vector<Context_def *> path = path_to_acceptable_context (type_scm);
+
   if (path.size () != 1)
     {
-      programming_error (_f ("Invalid CreateContext event: Cannot create %s context", type.c_str ()));
+      programming_error (to_string ("Invalid CreateContext event: Cannot create %s context", type.c_str ()));
       return;
     }
   Context_def *cdef = path[0];
-  
-  Context *new_context = cdef->instantiate (ops, key);
+
+  Context *new_context = cdef->instantiate (ops);
 
   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"));
+  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"));
+  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"));
+  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"));
+  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"));
+  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);
@@ -316,31 +336,50 @@ Context::create_context_from_event (SCM sev)
   apply_property_operations (new_context, ops);
 
   send_stream_event (this, "AnnounceNewContext", 0,
-                    ly_symbol2scm ("context"), new_context->self_scm (),
-                    ly_symbol2scm ("creator"), sev);
+                     ly_symbol2scm ("context"), new_context->self_scm (),
+                     ly_symbol2scm ("creator"), sev);
+}
+
+vector<Context_def *>
+Context::path_to_acceptable_context (SCM name) const
+{
+  // The 'accepts elements in definition_mods_ is a list of ('accepts string),
+  // but the Context_def expects to see elements of the form ('accepts symbol).
+  SCM accepts = SCM_EOL;
+  for (SCM s = definition_mods_; scm_is_pair (s); s = scm_cdr (s))
+    if (scm_caar (s) == ly_symbol2scm ("accepts"))
+      {
+        SCM elt = scm_list_2 (scm_caar (s), scm_string_to_symbol (scm_cadar (s)));
+        accepts = scm_cons (elt, accepts);
+      }
+
+  return unsmob_context_def (definition_)->path_to_acceptable_context (name,
+         get_output_def (),
+         scm_reverse_x (accepts, SCM_EOL));
+
 }
 
 Context *
 Context::create_context (Context_def *cdef,
-                        string id,
-                        SCM ops)
+                         const 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"));
+  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 ()));
+                     ly_symbol2scm ("id"), ly_string2scm (id));
   event_source_->
-    remove_listener (GET_LISTENER (acknowledge_infant),
-                     ly_symbol2scm ("AnnounceNewContext"));
+  remove_listener (GET_LISTENER (acknowledge_infant),
+                   ly_symbol2scm ("AnnounceNewContext"));
 
   assert (infant_event_);
   SCM infant_scm = infant_event_->get_property ("context");
@@ -362,9 +401,7 @@ Context::create_context (Context_def *cdef,
 SCM
 Context::default_child_context_name () const
 {
-  return scm_is_pair (accepts_list_)
-    ? scm_car (accepts_list_)
-    : SCM_EOL;
+  return default_child_;
 }
 
 bool
@@ -374,7 +411,7 @@ Context::is_bottom_context () const
 }
 
 Context *
-Context::get_default_interpreter ()
+Context::get_default_interpreter (const string &context_id)
 {
   if (!is_bottom_context ())
     {
@@ -384,13 +421,23 @@ Context::get_default_interpreter ()
       string name = ly_symbol2string (nm);
       Context_def *t = unsmob_context_def (st);
       if (!t)
-       {
-         warning (_f ("can't find or create: `%s'", name.c_str ()));
-         t = unsmob_context_def (this->definition_);
-       }
-
-      Context *tg = create_context (t, "", SCM_EOL);
-      return tg->get_default_interpreter ();
+        {
+          warning (_f ("cannot find or create: `%s'", name.c_str ()));
+          t = unsmob_context_def (this->definition_);
+        }
+      if (scm_is_symbol (t->get_default_child (SCM_EOL)))
+        {
+          Context *tg = create_context (t, "\\new", SCM_EOL);
+          return tg->get_default_interpreter (context_id);
+        }
+      return create_context (t, context_id, SCM_EOL);
+    }
+  else if (!context_id.empty () && context_id != id_string ())
+    {
+      if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
+        return daddy_context_->get_default_interpreter (context_id);
+      warning (_f ("cannot find or create new Bottom = \"%s\"",
+                   context_id.c_str ()));
     }
   return this;
 }
@@ -441,10 +488,12 @@ 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);
+  Stream_event *e = new Stream_event
+    (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"), type),
+     origin);
   for (int i = 0; props[i]; i += 2)
     {
-      e->set_property (props[i], props[i+1]);
+      e->set_property (props[i], props[i + 1]);
     }
   event_source_->broadcast (e);
   e->unprotect ();
@@ -453,10 +502,9 @@ Context::internal_send_stream_event (SCM type, Input *origin, SCM props[])
 bool
 Context::is_alias (SCM sym) const
 {
-  if (sym == ly_symbol2scm ("Bottom")
-      && !scm_is_pair (accepts_list_))
-    return true;
-  if (sym == unsmob_context_def (definition_)->get_context_name ())
+  if (scm_is_eq (sym, ly_symbol2scm ("Bottom")))
+    return is_bottom_context ();
+  if (scm_is_eq (sym, context_name_symbol ()))
     return true;
 
   return scm_c_memq (sym, aliases_) != SCM_BOOL_F;
@@ -468,18 +516,23 @@ Context::add_alias (SCM sym)
   aliases_ = scm_cons (sym, aliases_);
 }
 
+/* we don't (yet) instrument context properties */
 void
-#ifndef NDEBUG
-Context::internal_set_property (SCM sym, SCM val, char const *file, int line, char const *fun)
+Context::instrumented_set_property (SCM sym, SCM val, const char *, int, const char *)
 {
-  if (do_internal_type_checking_global)
-    assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
-#else
+  internal_set_property (sym, val);
+}
+
+void
 Context::internal_set_property (SCM sym, SCM val)
 {
-#endif
+  bool type_check_ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
 
-  properties_dict ()->set (sym, val);
+  if (do_internal_type_checking_global)
+    assert (type_check_ok);
+
+  if (type_check_ok)
+    properties_dict ()->set (sym, val);
 }
 
 /*
@@ -510,7 +563,9 @@ void
 Context::remove_context (SCM)
 {
   /* ugh, the translator group should listen to RemoveContext events by itself */
-  implementation ()->disconnect_from_context ();
+  Translator_group *impl = implementation ();
+  if (impl)
+    impl->disconnect_from_context ();
   disconnect_from_parent ();
 }
 
@@ -527,12 +582,12 @@ Context::disconnect_from_parent ()
 */
 Context *
 find_context_below (Context *where,
-                   SCM type, string id)
+                    SCM type, const string &id)
 {
   if (where->is_alias (type))
     {
       if (id == "" || where->id_string () == id)
-       return where;
+        return where;
     }
 
   Context *found = 0;
@@ -622,23 +677,10 @@ 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);
-  me->key_manager_.gc_mark();
 
   scm_gc_mark (me->context_list_);
   scm_gc_mark (me->aliases_);
@@ -646,10 +688,16 @@ Context::mark_smob (SCM sm)
   scm_gc_mark (me->definition_mods_);
   scm_gc_mark (me->properties_scm_);
   scm_gc_mark (me->accepts_list_);
+  scm_gc_mark (me->default_child_);
+
   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_;
 }
@@ -677,17 +725,6 @@ Context::get_parent_context () const
   return daddy_context_;
 }
 
-void
-Context::clear_key_disambiguations ()
-{
-  if (!use_object_keys)
-    return;
-
-  key_manager_.clear ();
-  for (SCM s = context_list_; scm_is_pair (s); s = scm_cdr (s))
-    unsmob_context (scm_car (s))->clear_key_disambiguations ();
-}
-
 /*
   Ugh. Where to put this?
 */
@@ -712,16 +749,44 @@ measure_position (Context const *context)
       m = *unsmob_moment (sm);
 
       if (m.main_part_ < Rational (0))
-       {
-         Rational length (measure_length (context));
-         while (m.main_part_ < Rational (0))
-           m.main_part_ += length;
-       }
+        {
+          Rational length (measure_length (context));
+          while (m.main_part_ < Rational (0))
+            m.main_part_ += length;
+        }
     }
 
   return m;
 }
 
+/* Finds the measure position after a note of length DUR that
+   begins at the current measure position. */
+Moment
+measure_position (Context const *context, Duration const *dur)
+{
+  Moment pos = measure_position (context);
+  Rational dur_length = dur ? dur->get_length () : Rational (0);
+
+  Moment end_pos = pos.grace_part_ < Rational (0)
+                   ? Moment (pos.main_part_, pos.grace_part_ + dur_length)
+                   : Moment (pos.main_part_ + dur_length, 0);
+
+  return end_pos;
+}
+
+int
+measure_number (Context const *context)
+{
+  SCM barnum = context->get_property ("internalBarNumber");
+  SCM smp = context->get_property ("measurePosition");
+
+  int bn = robust_scm2int (barnum, 0);
+  Moment mp = robust_scm2moment (smp, Moment (0));
+  if (mp.main_part_ < Rational (0))
+    bn--;
+
+  return bn;
+}
 
 void
 set_context_property_on_children (Context *trans, SCM sym, SCM val)
@@ -740,9 +805,19 @@ melisma_busy (Context *tr)
   SCM melisma_properties = tr->get_property ("melismaBusyProperties");
   bool busy = false;
 
-  for (; scm_is_pair (melisma_properties);
+  for (; !busy && 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;
 }
+
+bool
+check_repeat_count_visibility (Context const *context, SCM count)
+{
+  SCM proc = context->get_property ("repeatCountVisibility");
+  return (ly_is_procedure (proc)
+          && to_boolean (scm_call_2 (proc,
+                                     count,
+                                     context->self_scm ())));
+}