]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/context-property.cc
Run `make grand-replace'.
[lilypond.git] / lily / context-property.cc
index 0e9a0e129a4462a41fcd2459508dd5beb7096ae7..08ade8f954391ab4eec71e482063fa370e523663 100644 (file)
 /*
-   context-property.cc -- implement manipulation of immutable Grob
-   property lists.
+  context-property.cc -- implement manipulation of immutable Grob
+  property lists.
 
-   source file of the GNU LilyPond music typesetter
+  source file of the GNU LilyPond music typesetter
 
-   (c) 2004 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 2004--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "context.hh"
-#include "grob-selector.hh"
 #include "engraver.hh"
+#include "international.hh"
 #include "item.hh"
 #include "main.hh"
+#include "simple-closure.hh"
 #include "spanner.hh"
 #include "warn.hh"
 
+/*
+  like execute_general_pushpop_property(), but typecheck
+  grob_property_path and context_property.
+*/
+void
+general_pushpop_property (Context *context,
+                         SCM context_property,
+                         SCM grob_property_path,
+                         SCM new_value)
+{
+  if (!scm_is_symbol (context_property)
+      || !scm_is_symbol (scm_car (grob_property_path)))
+    {
+      warning (_ ("need symbol arguments for \\override and \\revert"));
+      if (do_internal_type_checking_global)
+       assert (false);
+    }
+
+  sloppy_general_pushpop_property (context, context_property,
+                                   grob_property_path, new_value);
+}
+
+
 /*
   Grob descriptions (ie. alists with layout properties) are
   represented as a (ALIST . BASED-ON) pair, where BASED-ON is the
   alist defined in a parent context. BASED-ON should always be a tail
   of ALIST.
+
+  Push or pop (depending on value of VAL) a single entry entry from a
+  translator property list by name of PROP.  GROB_PROPERTY_PATH
+  indicates nested alists, eg. '(beamed-stem-lengths details)
   
+*/
+void
+execute_override_property (Context *context,
+                          SCM context_property,
+                          SCM grob_property_path,
+                          SCM new_value)
+{
+  SCM current_context_val = SCM_EOL;
+  
+  Context *where = context->where_defined (context_property,
+                                          &current_context_val);
+
+  /*
+    Don't mess with MIDI.
   */
+  if (!where)
+    return;
 
-/*
-  Push or pop (depending on value of VAL) a single entry (ELTPROP . VAL)
-  entry from a translator property list by name of PROP
-*/
+  if (where != context)
+    {
+      SCM base = updated_grob_properties (context, context_property);
+      current_context_val = scm_cons (base, base);
+      context->set_property (context_property, current_context_val);
+    }
+
+  if (!scm_is_pair (current_context_val))
+    {
+      programming_error ("Grob definition should be cons");
+      return;
+    }
 
+  SCM target_alist = scm_car (current_context_val);
 
+  SCM symbol = scm_car (grob_property_path);
+  if (scm_is_pair (scm_cdr (grob_property_path)))
+    {
+      new_value = nested_property_alist (ly_assoc_get (symbol, target_alist, 
+                                                      SCM_EOL),
+                                        scm_cdr (grob_property_path),
+                                        new_value);
+    }
+
+  /* it's tempting to replace the head of the list if it's the same
+   property. However, we have to keep this info around, in case we have to
+   \revert back to it.
+  */
+  target_alist = scm_acons (symbol, new_value, target_alist);
+
+  bool ok = true;
+  if (!ly_is_procedure (new_value)
+      && !is_simple_closure (new_value))
+    ok = type_check_assignment (symbol, new_value,
+                               ly_symbol2scm ("backend-type?"));
+
+  /*
+    tack onto alist.  We can use set_car, since
+    updated_grob_properties () in child contexts will check
+    for changes in the car.
+  */
+  if (ok)
+    {
+      scm_set_car_x (current_context_val, target_alist);
+    }
+}
+
+/*
+  do a pop (indicated by new_value==SCM_UNDEFINED) or push
+ */
 void
-execute_pushpop_property (Context * trg,
-                         SCM prop, SCM eltprop, SCM val)
+sloppy_general_pushpop_property (Context *context,
+                                SCM context_property,
+                                SCM grob_property_path,
+                                SCM new_value)
 {
-  if (scm_is_symbol (prop) && scm_is_symbol (eltprop))
+  if (new_value == SCM_UNDEFINED)
+    execute_revert_property (context, context_property,
+                            grob_property_path);
+  else
+    execute_override_property (context, context_property,
+                              grob_property_path,
+                              new_value);
+}
+
+/*
+  Revert the property given by property_path.
+*/
+void
+execute_revert_property (Context *context,
+                        SCM context_property,
+                        SCM grob_property_path)
+{
+  SCM current_context_val = SCM_EOL;
+  if (context->where_defined (context_property, &current_context_val)
+      == context)
     {
-      if (val != SCM_UNDEFINED)
+      SCM current_alist = scm_car (current_context_val);
+      SCM daddy = scm_cdr (current_context_val);
+
+      if (!scm_is_pair (grob_property_path)
+         || !scm_is_symbol (scm_car (grob_property_path)))
        {
-         SCM prev = SCM_EOL;
-         Context * where = trg->where_defined (prop);
-
-         /*
-           Don't mess with MIDI.
-          */
-         if (!where)
-           return ;
-         
-         if (where != trg)
-           {
-             SCM base = updated_grob_properties (trg, prop);
-             prev = scm_cons (base, base); 
-             trg->internal_set_property (prop, prev);
-           }
-         else
-           prev = trg->internal_get_property (prop);
-         
-         if (!scm_is_pair (prev))
-           {
-             programming_error ("Grob definition should be cons.");
-             return ;
-           }
+         programming_error ("Grob property path should be list of symbols.");
+         return;
+       }
+      
+      SCM symbol = scm_car (grob_property_path);
+      if (scm_is_pair (scm_cdr (grob_property_path)))
+       {
+         SCM current_sub_alist = ly_assoc_get (symbol, current_alist, SCM_EOL);
+         SCM new_val
+           = nested_property_revert_alist (current_sub_alist,
+                                           scm_cdr (grob_property_path));
+           
+         if (scm_is_pair (current_alist)
+             && scm_caar (current_alist) == symbol
+             && current_alist != daddy)
+           current_alist = scm_cdr (current_alist);
 
-         SCM prev_alist = scm_car (prev);
-         
-         if (scm_is_pair (prev_alist) || prev_alist == SCM_EOL)
-           {
-             bool ok = type_check_assignment (eltprop, val, ly_symbol2scm ("backend-type?"));
-
-             /*
-              tack onto alist:
-             */
-             if (ok)
-               scm_set_car_x (prev, scm_acons (eltprop, val, prev_alist));
-           }
-         else
-           {
-             // warning here.
-           }
+         current_alist = scm_acons (symbol, new_val, current_alist);
+         scm_set_car_x (current_context_val, current_alist);
        }
-      else if (trg->where_defined (prop) == trg)
+      else
        {
-         SCM prev = trg->internal_get_property (prop);
-         SCM prev_alist = scm_car (prev);
-         SCM daddy = scm_cdr (prev);
+         SCM new_alist = evict_from_alist (symbol, current_alist, daddy);
          
-         SCM new_alist = SCM_EOL;
-         SCM *tail = &new_alist;
-
-         while (prev_alist != daddy)
-           {
-             if (ly_c_equal_p (scm_caar (prev_alist), eltprop))
-               {
-                 prev_alist = scm_cdr (prev_alist);
-                 break ;
-               }
-
-             
-             *tail = scm_cons (scm_car (prev_alist), SCM_EOL);
-             tail = SCM_CDRLOC (*tail);
-             prev_alist = scm_cdr (prev_alist);
-           }
-
-         if (new_alist == SCM_EOL && prev_alist == daddy)
-           trg->unset_property (prop);
+         if (new_alist == daddy)
+           context->unset_property (context_property);
          else
-           {
-             *tail = prev_alist;
-             trg->internal_set_property (prop, scm_cons (new_alist, daddy));
-           }
+           context->set_property (context_property,
+                                  scm_cons (new_alist, daddy));
        }
     }
-  else
-    {
-      warning ("Need symbol arguments for \\override and \\revert");
-      if (internal_type_checking_global_b)
-       assert (false);
-    }
 }
-
+/*
+  Convenience: a push/pop grob property using a single grob_property
+  as argument.
+*/
+void
+execute_pushpop_property (Context *context,
+                         SCM context_property,
+                         SCM grob_property,
+                         SCM new_value)
+{
+  general_pushpop_property (context, context_property,
+                           scm_list_1 (grob_property),
+                           new_value);
+}
+  
 /*
   PRE_INIT_OPS is in the order specified, and hence must be reversed.
- */
+*/
 void
 apply_property_operations (Context *tg, SCM pre_init_ops)
 {
@@ -129,41 +208,45 @@ apply_property_operations (Context *tg, SCM pre_init_ops)
     {
       SCM entry = scm_car (s);
       SCM type = scm_car (entry);
-      entry = scm_cdr (entry); 
-      
-      if (type == ly_symbol2scm ("push") || type == ly_symbol2scm ("poppush"))
-       {
-         SCM val = scm_cddr (entry);
-         val = scm_is_pair (val) ? scm_car (val) : SCM_UNDEFINED;
+      entry = scm_cdr (entry);
 
-         execute_pushpop_property (tg, scm_car (entry), scm_cadr (entry), val);
+      if (type == ly_symbol2scm ("push"))
+       {
+         SCM context_prop = scm_car (entry);
+         SCM val = scm_cadr (entry);
+         SCM grob_prop_path = scm_cddr (entry);
+         sloppy_general_pushpop_property (tg, context_prop, grob_prop_path, val);
        }
-      else if (type == ly_symbol2scm ("assign"))
+      else if (type == ly_symbol2scm ("pop"))
        {
-         tg->internal_set_property (scm_car (entry), scm_cadr (entry));
+         SCM context_prop = scm_car (entry);
+         SCM val = SCM_UNDEFINED;
+         SCM grob_prop_path = scm_cdr (entry);
+         sloppy_general_pushpop_property (tg, context_prop, grob_prop_path, val);
        }
+      else if (type == ly_symbol2scm ("assign"))
+       tg->set_property (scm_car (entry), scm_cadr (entry));
     }
 }
 
 /*
   Return the object alist for SYM, checking if its base in enclosing
-  contexts has changed. The alist is updated if necessary. 
-   */
+  contexts has changed. The alist is updated if necessary.
+*/
 SCM
-updated_grob_properties (Context * tg, SCM sym)
+updated_grob_properties (Context *tg, SCM sym)
 {
   assert (scm_is_symbol (sym));
-  
-  tg = tg->where_defined (sym);
+
+  SCM props;
+  tg = tg->where_defined (sym, &props);
   if (!tg)
     return SCM_EOL;
-  
+
   SCM daddy_props
     = (tg->get_parent_context ())
     ? updated_grob_properties (tg->get_parent_context (), sym)
     : SCM_EOL;
-  
-  SCM props  = tg->internal_get_property (sym);
 
   if (!scm_is_pair (props))
     {
@@ -173,56 +256,22 @@ updated_grob_properties (Context * tg, SCM sym)
 
   SCM based_on = scm_cdr (props);
   if (based_on == daddy_props)
-    {
-      return scm_car (props);
-    }
+    return scm_car (props);
   else
     {
       SCM copy = daddy_props;
       SCM *tail = &copy;
       SCM p = scm_car (props);
-      while  (p != based_on)
+      while (p != based_on)
        {
          *tail = scm_cons (scm_car (p), daddy_props);
          tail = SCM_CDRLOC (*tail);
          p = scm_cdr (p);
        }
-      
+
       scm_set_car_x (props, copy);
       scm_set_cdr_x (props, daddy_props);
 
       return copy;
     }
 }
-
-Item *
-make_item_from_properties (Engraver *tr, SCM x, SCM cause, const char * name)
-{
-  Context *context = tr->context ();
-  
-  SCM props = updated_grob_properties (context, x);
-
-  Object_key const*key = context->get_grob_key (name);
-  Item *it = new Item (props, key);
-  scm_gc_unprotect_object (key->self_scm ());
-
-#ifdef TWEAK 
-  Grob_selector::register_grob (context, it);
-#endif
-  dynamic_cast<Engraver*>(tr)->announce_grob (it, cause);
-
-  return it;
-}
-
-Spanner*
-make_spanner_from_properties (Engraver *tr, SCM x, SCM cause, const char *name)
-{
-  Context *context = tr->context ();
-
-  SCM props = updated_grob_properties (context, x);
-  Spanner *it = new Spanner (props, context->get_grob_key (name));
-
-  dynamic_cast<Engraver*>(tr)->announce_grob (it, cause);
-
-  return it;
-}