]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob-property.cc
Doc-es: various updates.
[lilypond.git] / lily / grob-property.cc
index b62a6bb9f9f94f815221f2c1f7819d0276e24ec0..1129e481571672c1170c3a9e7da4e7ff30b24762 100644 (file)
 #include "spanner.hh"
 #include "international.hh"
 #include "item.hh"
-#include "misc.hh"
-#include "item.hh"
 #include "program-option.hh"
 #include "profile.hh"
-#include "simple-closure.hh"
+#include "unpure-pure-container.hh"
 #include "warn.hh"
+#include "protected-scm.hh"
 
-#ifndef NDEBUG
-static SCM modification_callback = SCM_EOL;
+Protected_scm grob_property_callback_stack (SCM_EOL);
 
-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.")
+extern bool debug_property_callbacks;
+
+#ifdef DEBUG
+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 Protected_scm modification_callback (SCM_EOL);
+static Protected_scm cache_callback (SCM_EOL);
 
-  SCM_ASSERT_TYPE(ly_is_procedure (cb), cb, SCM_ARG1, __FUNCTION__,
-                 "procedure");
+/*
+FIXME: this should use ly:set-option interface instead.
+*/
 
-  modification_callback = cb;
+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.")
+{
+  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);
-
-
+#ifdef DEBUG
   if (ly_is_procedure (modification_callback))
     scm_apply_0 (modification_callback,
-                scm_list_n (self_scm (),
-                            scm_from_locale_string (file),
-                            scm_from_int (line),
-                            scm_from_locale_string (fun),
-                            sym, v, SCM_UNDEFINED));
-}
+                 scm_list_n (self_scm (),
+                             scm_from_locale_string (file),
+                             scm_from_int (line),
+                             scm_from_ascii_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_3 (mutable_property_alist_,
+                     immutable_property_alist_,
+                     def);
+}
+
+extern void check_interfaces_for_property (Grob const *me, SCM sym);
 
 void
 Grob::internal_set_property (SCM sym, SCM v)
 {
   internal_set_value_on_alist (&mutable_property_alist_,
-                              sym, v);
+                               sym, v);
 
 }
-#endif
 
 void
 Grob::internal_set_value_on_alist (SCM *alist, SCM sym, SCM v)
@@ -109,9 +119,9 @@ Grob::internal_set_value_on_alist (SCM *alist, SCM sym, SCM v)
   if (do_internal_type_checking_global)
     {
       if (!ly_is_procedure (v)
-         && !is_simple_closure (v)
-         && v != ly_symbol2scm ("calculation-in-progress"))
-       type_check_assignment (sym, v, ly_symbol2scm ("backend-type?"));
+          && !unsmob<Unpure_pure_container> (v)
+          && !scm_is_eq (v, ly_symbol2scm ("calculation-in-progress")))
+        type_check_assignment (sym, v, ly_symbol2scm ("backend-type?"));
 
       check_interfaces_for_property (this, sym);
     }
@@ -122,13 +132,13 @@ Grob::internal_set_value_on_alist (SCM *alist, SCM sym, SCM v)
 SCM
 Grob::internal_get_property_data (SCM sym) const
 {
-#ifndef NDEBUG
+#ifdef DEBUG
   if (profile_property_accesses)
     note_property_access (&grob_property_lookup_table, sym);
 #endif
-  
+
   SCM handle = scm_sloppy_assq (sym, mutable_property_alist_);
-  if (handle != SCM_BOOL_F)
+  if (scm_is_true (handle))
     return scm_cdr (handle);
 
   handle = scm_sloppy_assq (sym, immutable_property_alist_);
@@ -136,39 +146,75 @@ Grob::internal_get_property_data (SCM sym) const
   if (do_internal_type_checking_global && scm_is_pair (handle))
     {
       SCM val = scm_cdr (handle);
-      if (!ly_is_procedure (val) && !is_simple_closure (val))
-       type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"));
+      if (!ly_is_procedure (val)
+          && !unsmob<Unpure_pure_container> (val))
+        type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"));
 
       check_interfaces_for_property (this, sym);
     }
-  
-  return (handle == SCM_BOOL_F) ? SCM_EOL : scm_cdr (handle);
+
+  return scm_is_false (handle) ? SCM_EOL : scm_cdr (handle);
 }
 
 SCM
 Grob::internal_get_property (SCM sym) const
 {
   SCM val = get_property_data (sym);
-  if (ly_is_procedure (val)
-      || is_simple_closure (val))
+
+#ifdef DEBUG
+  if (scm_is_eq (val, ly_symbol2scm ("calculation-in-progress")))
+    {
+      programming_error (to_string ("cyclic dependency: calculation-in-progress encountered for #'%s (%s)",
+                                    ly_symbol2string (sym).c_str (),
+                                    name ().c_str ()));//assert (1==0);
+      if (debug_property_callbacks)
+        {
+          message ("backtrace: ");
+          print_property_callback_stack ();
+        }
+    }
+#endif
+
+  if (Unpure_pure_container *upc = unsmob<Unpure_pure_container> (val))
+    val = upc->unpure_part ();
+
+  if (ly_is_procedure (val))
     {
-      Grob *me = ((Grob*)this);
+      Grob *me = ((Grob *)this);
       val = me->try_callback_on_alist (&me->mutable_property_alist_, sym, val);
     }
-  
+
   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 (Unpure_pure_container *upc = unsmob<Unpure_pure_container> (val)) {
+    // Do cache, if the function ignores 'start' and 'end'
+    if (upc->is_unchanging ())
+      return internal_get_property (sym);
+    else
+      return call_pure_function (val, scm_list_1 (self_scm ()), start, end);
+  }
 
-Protected_scm grob_property_callback_stack = SCM_EOL;
-bool debug_property_callbacks = 0;
-#endif
+  return val;
+}
+
+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)
-{      
+{
   SCM marker = ly_symbol2scm ("calculation-in-progress");
   /*
     need to put a value in SYM to ensure that we don't get a
@@ -176,41 +222,40 @@ Grob::try_callback_on_alist (SCM *alist, SCM sym, SCM proc)
   */
   *alist = scm_assq_set_x (*alist, sym, marker);
 
-#ifndef NDEBUG
+#ifdef DEBUG
   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;
   if (ly_is_procedure (proc))
     value = scm_call_1 (proc, self_scm ());
-  else if (is_simple_closure (proc))
-    {
-      value = evaluate_with_simple_closure (self_scm (),
-                                           simple_closure_expression (proc),
-                                           false, 0, 0);
-    }
-  
-#ifndef NDEBUG
+
+#ifdef DEBUG
   if (debug_property_callbacks)
     grob_property_callback_stack = scm_cdr (grob_property_callback_stack);
 #endif
-         
-  /*
-    If the function returns SCM_UNSPECIFIED, we assume the
-    property has been set with an explicit set_property()
-    call.
-  */
-  if (value == SCM_UNSPECIFIED)
+
+  if (scm_is_eq (value, SCM_UNSPECIFIED))
     {
-      value = internal_get_property (sym);
-      assert (value == SCM_EOL || value == marker);
-      if (value == marker)
-       *alist = scm_assq_remove_x (*alist, marker);
+      value = get_property_data (sym);
+      assert (scm_is_null (value) || scm_is_eq (value, marker));
+      if (scm_is_eq (value, marker))
+        *alist = scm_assq_remove_x (*alist, sym);
     }
   else
-    internal_set_value_on_alist (alist, sym, value);
-  
+    {
+#ifdef DEBUG
+      if (ly_is_procedure (cache_callback))
+        scm_call_4 (cache_callback,
+                    self_scm (),
+                    sym,
+                    proc,
+                    value);
+#endif
+      internal_set_value_on_alist (alist, sym, value);
+    }
+
   return value;
 }
 
@@ -237,17 +282,17 @@ Grob::internal_get_object (SCM sym) const
     note_property_access (&grob_property_lookup_table, sym);
 
   SCM s = scm_sloppy_assq (sym, object_alist_);
-  
-  if (s != SCM_BOOL_F)
+
+  if (scm_is_true (s))
     {
       SCM val = scm_cdr (s);
       if (ly_is_procedure (val)
-         || is_simple_closure (val))
-       {
-         Grob *me = ((Grob*)this);
-         val = me->try_callback_on_alist (&me->object_alist_, sym, val);
-       }
-      
+          || unsmob<Unpure_pure_container> (val))
+        {
+          Grob *me = ((Grob *)this);
+          val = me->try_callback_on_alist (&me->object_alist_, sym, val);
+        }
+
       return val;
     }
 
@@ -263,14 +308,38 @@ Grob::is_live () const
 bool
 Grob::internal_has_interface (SCM k)
 {
-  return scm_c_memq (k, interfaces_) != SCM_BOOL_F;
+  return scm_is_true (scm_c_memq (k, interfaces_));
 }
 
 SCM
-call_pure_function (SCM unpure, SCM args, int start, int end)
+call_pure_function (SCM value, SCM args, int start, int end)
 {
-  SCM scm_call_pure_function = ly_lily_module_constant ("call-pure-function");
+  if (Unpure_pure_container *upc = unsmob<Unpure_pure_container> (value))
+    {
+      if (upc->is_unchanging ())
+        {
+          // Don't bother forming an Unpure_pure_call here.
+          value = upc->unpure_part ();
+
+          if (ly_is_procedure (value))
+            return scm_apply_0 (value, args);
+          return value;
+        }
+
+      value = upc->pure_part ();
+
+      if (ly_is_procedure (value))
+        return scm_apply_3 (value,
+                            scm_car (args),
+                            scm_from_int (start),
+                            scm_from_int (end),
+                            scm_cdr (args));
+
+      return value;
+    }
+
+  if (!ly_is_procedure (value))
+    return value;
 
-  return scm_apply_0 (scm_call_pure_function,
-                     scm_list_4 (unpure, args, scm_from_int (start), scm_from_int (end)));
+  return SCM_BOOL_F;
 }