]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob-property.cc
Imported Upstream version 2.14.2
[lilypond.git] / lily / grob-property.cc
index 1473157209dc7be9c9139e6f1a923ffd5f42e508..f174f7ee01f6128bd79c6c6d405c80998e862659 100644 (file)
 #include "profile.hh"
 #include "simple-closure.hh"
 #include "warn.hh"
+#include "protected-scm.hh"
+
+Protected_scm grob_property_callback_stack = SCM_EOL;
+
+extern bool debug_property_callbacks;
 
 #ifndef NDEBUG
+static void
+print_property_callback_stack ()
+{
+  int frame = 0;
+  for (SCM s = grob_property_callback_stack; scm_is_pair (s); s = scm_cdr (s))
+    message (_f ("%d: %s", frame++, ly_scm_write_string (scm_car (s)).c_str ()));
+}
+#endif
+
 static SCM modification_callback = SCM_EOL;
+static SCM cache_callback = SCM_EOL;
+
+
+/*
+
+FIXME: this should use ly:set-option interface instead.
+
+*/
 
 LY_DEFINE (ly_set_grob_modification_callback, "ly:set-grob-modification-callback",
           1, 0, 0, (SCM cb),
-          "Specify a procedure that will be called every time lilypond modifies "
-          "a grob property. The callback will receive as arguments "
-          "the grob that is being modified, "
-          "the name of the C++ file in which the modification was requested, "
-          "the line number in the C++ file in which the modification was requested, "
-          "the name of the function in which the modification was requested, "
-          "the property to be changed and "
-          "the new value for the property.")
+          "Specify a procedure that will be called every time LilyPond"
+          " modifies a grob property.  The callback will receive as"
+          " arguments the grob that is being modified, the name of the"
+          " C++ file in which the modification was requested, the line"
+          " number in the C++ file in which the modification was requested,"
+          " the name of the function in which the modification was"
+          " requested, the property to be changed, and the new value for"
+          " the property.")
 {
-  LY_ASSERT_TYPE (ly_is_procedure, cb, 1);
+  modification_callback =  (ly_is_procedure (cb)) ? cb : SCM_BOOL_F;
+  return SCM_UNSPECIFIED;
+}
 
-  modification_callback = cb;
+LY_DEFINE (ly_set_property_cache_callback, "ly:set-property-cache-callback",
+          1, 0, 0, (SCM cb),
+          "Specify a procedure that will be called whenever lilypond"
+          " calculates a callback function and caches the result.  The"
+          " callback will receive as arguments the grob whose property it"
+          " is, the name of the property, the name of the callback that"
+          " calculated the property, and the new (cached) value of the"
+          " property.")
+{
+  cache_callback =  (ly_is_procedure (cb)) ? cb : SCM_BOOL_F;
   return SCM_UNSPECIFIED;
 }
 
+
 void
 Grob::instrumented_set_property (SCM sym, SCM v,
                                 char const *file,
                                 int line,
                                 char const *fun)
 {
+#ifndef NDEBUG
   if (ly_is_procedure (modification_callback))
     scm_apply_0 (modification_callback,
                 scm_list_n (self_scm (),
@@ -53,9 +88,14 @@ Grob::instrumented_set_property (SCM sym, SCM v,
                             scm_from_int (line),
                             scm_from_locale_string (fun),
                             sym, v, SCM_UNDEFINED));
+#else
+  (void) file;
+  (void) line;
+  (void) fun;
+#endif
+  
   internal_set_property (sym, v);
 }
-#endif
 
 SCM
 Grob::get_property_alist_chain (SCM def) const
@@ -66,7 +106,6 @@ Grob::get_property_alist_chain (SCM def) const
                     SCM_UNDEFINED);
 }
 
-
 extern void check_interfaces_for_property (Grob const *me, SCM sym);
 
 void
@@ -130,9 +169,16 @@ Grob::internal_get_property (SCM sym) const
 
 #ifndef NDEBUG
   if (val == ly_symbol2scm ("calculation-in-progress"))
-    programming_error (_f ("cyclic dependency: calculation-in-progress encountered for #'%s (%s)",
-                          ly_symbol2string (sym).c_str (),
-                          name ().c_str ()));
+    {
+      programming_error (_f ("cyclic dependency: calculation-in-progress encountered for #'%s (%s)",
+                            ly_symbol2string (sym).c_str (),
+                            name ().c_str ()));
+      if (debug_property_callbacks)
+       {
+         message ("backtrace: ");
+         print_property_callback_stack ();
+       }
+    }
 #endif
   
   if (ly_is_procedure (val)
@@ -145,12 +191,25 @@ Grob::internal_get_property (SCM sym) const
   return val;
 }
 
-#ifndef NDEBUG
-#include "protected-scm.hh"
+/* Unlike internal_get_property, this function does no caching. Use it, therefore, with caution. */
+SCM
+Grob::internal_get_pure_property (SCM sym, int start, int end) const
+{
+  SCM val = internal_get_property_data (sym);
+  if (ly_is_procedure (val))
+    return call_pure_function (val, scm_list_1 (self_scm ()), start, end);
+  if (is_simple_closure (val))
+    return evaluate_with_simple_closure (self_scm (),
+                                        simple_closure_expression (val),
+                                        true, start, end);
+  return val;
+}
 
-Protected_scm grob_property_callback_stack = SCM_EOL;
-bool debug_property_callbacks = 0;
-#endif
+SCM
+Grob::internal_get_maybe_pure_property (SCM sym, bool pure, int start, int end) const
+{
+  return pure ? internal_get_pure_property (sym, start, end) : internal_get_property (sym);
+}
 
 SCM
 Grob::try_callback_on_alist (SCM *alist, SCM sym, SCM proc)
@@ -164,7 +223,7 @@ Grob::try_callback_on_alist (SCM *alist, SCM sym, SCM proc)
 
 #ifndef NDEBUG
   if (debug_property_callbacks)
-    grob_property_callback_stack = scm_acons (sym, proc, grob_property_callback_stack);
+    grob_property_callback_stack = scm_cons (scm_list_3 (self_scm (), sym, proc), grob_property_callback_stack);
 #endif
 
   SCM value = SCM_EOL;
@@ -195,7 +254,18 @@ Grob::try_callback_on_alist (SCM *alist, SCM sym, SCM proc)
        *alist = scm_assq_remove_x (*alist, marker);
     }
   else
-    internal_set_value_on_alist (alist, sym, value);
+    {
+#ifndef NDEBUG
+      if (ly_is_procedure (cache_callback))
+       scm_apply_0 (cache_callback,
+                    scm_list_n (self_scm (),
+                                sym,
+                                proc,
+                                value,
+                                SCM_UNDEFINED));
+#endif
+      internal_set_value_on_alist (alist, sym, value);
+    }
   
   return value;
 }
@@ -261,37 +331,3 @@ call_pure_function (SCM unpure, SCM args, int start, int end)
                      scm_list_4 (unpure, args, scm_from_int (start), scm_from_int (end)));
 }
 
-
-/*
-  PROP_PATH should be big-to-small ordering
- */
-SCM 
-nested_property_alist (SCM alist, SCM prop_path, SCM value)
-{
-  SCM new_value = SCM_BOOL_F;
-  if (scm_is_pair (scm_cdr (prop_path)))
-    {
-      SCM sub_alist = ly_assoc_get (scm_car (prop_path), alist, SCM_EOL);
-      new_value = nested_property_alist (sub_alist, scm_cdr (prop_path), value);
-    }
-  else
-    {
-      new_value = value;
-    }
-  
-  return scm_acons (scm_car (prop_path), new_value, alist);
-}
-
-
-void
-set_nested_property (Grob *me, SCM property_path, SCM value)
-{
-  SCM big_to_small = scm_reverse (property_path);
-  SCM alist = me->get_property (scm_car (big_to_small));
-
-  alist = nested_property_alist (alist, scm_cdr (big_to_small), value);
-  
-  me->set_property (scm_car (big_to_small),
-                   alist);
-}
-