X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob-property.cc;h=f174f7ee01f6128bd79c6c6d405c80998e862659;hb=f018757016404595c92e21346ae0661dafe7ea46;hp=b62a6bb9f9f94f815221f2c1f7819d0276e24ec0;hpb=3ee551fa4f2a2c3736a06f9f85f29b9f7bd89818;p=lilypond.git

diff --git a/lily/grob-property.cc b/lily/grob-property.cc
index b62a6bb9f9..f174f7ee01 100644
--- a/lily/grob-property.cc
+++ b/lily/grob-property.cc
@@ -19,66 +19,68 @@
 #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 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.")
 {
-
-  SCM_ASSERT_TYPE(ly_is_procedure (cb), cb, SCM_ARG1, __FUNCTION__,
-		  "procedure");
-
-  modification_callback = cb;
+  modification_callback =  (ly_is_procedure (cb)) ? cb : SCM_BOOL_F;
   return SCM_UNSPECIFIED;
 }
-#endif
 
-SCM
-Grob::get_property_alist_chain (SCM def) const
+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.")
 {
-  return scm_list_n (mutable_property_alist_,
-		     immutable_property_alist_,
-		     def,
-		     SCM_UNDEFINED);
+  cache_callback =  (ly_is_procedure (cb)) ? cb : SCM_BOOL_F;
+  return SCM_UNSPECIFIED;
 }
 
 
-extern void check_interfaces_for_property (Grob const *me, SCM sym);
-
-#if 0
-
-/*
-  We can't change signatures depending on NDEBUG, since NDEBUG comes
-  over the command line and may be different per .cc file.  This
-  should be done through the macro expansion of get_property().
- */
 void
-Grob::internal_set_property (SCM sym, SCM v, char const *file, int line, char const *fun)
+Grob::instrumented_set_property (SCM sym, SCM v,
+				 char const *file,
+				 int line,
+				 char const *fun)
 {
-  SCM grob_p = ly_lily_module_constant ("ly:grob?");
-  SCM grob_list_p = ly_lily_module_constant ("grob-list?");
-  SCM type = scm_object_property (sym, ly_symbol2scm ("backend-type?"));
-
-  if (type == grob_p
-      || type == grob_list_p
-      || (unsmob_grob (v) && ly_symbol2scm ("cause") != sym))
-    {
-      scm_display (scm_list_2 (sym, type), scm_current_output_port ());
-      assert (0);
-    }
-  
-  internal_set_value_on_alist (&mutable_property_alist_,
-			       sym, v);
-
-
+#ifndef NDEBUG
   if (ly_is_procedure (modification_callback))
     scm_apply_0 (modification_callback,
 		 scm_list_n (self_scm (),
@@ -86,9 +88,25 @@ Grob::internal_set_property (SCM sym, SCM v, char const *file, int line, char co
 			     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);
+}
 
+SCM
+Grob::get_property_alist_chain (SCM def) const
+{
+  return scm_list_n (mutable_property_alist_,
+		     immutable_property_alist_,
+		     def,
+		     SCM_UNDEFINED);
+}
+
+extern void check_interfaces_for_property (Grob const *me, SCM sym);
 
 void
 Grob::internal_set_property (SCM sym, SCM v)
@@ -97,7 +115,6 @@ Grob::internal_set_property (SCM sym, SCM v)
 			       sym, v);
 
 }
-#endif
 
 void
 Grob::internal_set_value_on_alist (SCM *alist, SCM sym, SCM v)
@@ -149,6 +166,21 @@ SCM
 Grob::internal_get_property (SCM sym) const
 {
   SCM val = get_property_data (sym);
+
+#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 ()));
+      if (debug_property_callbacks)
+	{
+	  message ("backtrace: ");
+	  print_property_callback_stack ();
+	}
+    }
+#endif
+  
   if (ly_is_procedure (val)
       || is_simple_closure (val))
     {
@@ -159,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)
@@ -178,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;
@@ -198,18 +243,29 @@ Grob::try_callback_on_alist (SCM *alist, SCM sym, SCM proc)
 	  
   /*
     If the function returns SCM_UNSPECIFIED, we assume the
-    property has been set with an explicit set_property()
+    property has been set with an explicit set_property ()
     call.
   */
   if (value == SCM_UNSPECIFIED)
     {
-      value = internal_get_property (sym);
+      value = get_property_data (sym);
       assert (value == SCM_EOL || value == marker);
       if (value == marker)
 	*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;
 }
@@ -274,3 +330,4 @@ call_pure_function (SCM unpure, SCM args, int start, int end)
   return scm_apply_0 (scm_call_pure_function,
 		      scm_list_4 (unpure, args, scm_from_int (start), scm_from_int (end)));
 }
+