]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob-property.cc
Doc: Usage 1.2 - Added note about using wildcards
[lilypond.git] / lily / grob-property.cc
index 1fcded7df749e3197ce2e2031a1dced00bc39317..779f0e91cbcb4712deb96e765e5f4db4f8c4c506 100644 (file)
@@ -18,6 +18,7 @@
 #include "program-option.hh"
 #include "profile.hh"
 #include "simple-closure.hh"
+#include "unpure-pure-container.hh"
 #include "warn.hh"
 #include "protected-scm.hh"
 
@@ -35,66 +36,61 @@ print_property_callback_stack ()
 }
 #endif
 
-static SCM modification_callback = SCM_EOL;
-static SCM cache_callback = SCM_EOL;
-
+static Protected_scm modification_callback = SCM_EOL;
+static Protected_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.")
+           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;
+  modification_callback = (ly_is_procedure (cb)) ? cb : SCM_BOOL_F;
   return SCM_UNSPECIFIED;
 }
 
 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.")
+           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;
+  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)
+                                 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 (),
-                            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_locale_string (fun),
+                             sym, v, SCM_UNDEFINED));
 #else
   (void) file;
   (void) line;
   (void) fun;
 #endif
-  
+
   internal_set_property (sym, v);
 }
 
@@ -102,9 +98,9 @@ SCM
 Grob::get_property_alist_chain (SCM def) const
 {
   return scm_list_n (mutable_property_alist_,
-                    immutable_property_alist_,
-                    def,
-                    SCM_UNDEFINED);
+                     immutable_property_alist_,
+                     def,
+                     SCM_UNDEFINED);
 }
 
 extern void check_interfaces_for_property (Grob const *me, SCM sym);
@@ -113,7 +109,7 @@ void
 Grob::internal_set_property (SCM sym, SCM v)
 {
   internal_set_value_on_alist (&mutable_property_alist_,
-                              sym, v);
+                               sym, v);
 
 }
 
@@ -127,9 +123,10 @@ 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?"));
+          && !Simple_closure::is_smob (v)
+          && !Unpure_pure_container::is_smob (v)
+          && v != ly_symbol2scm ("calculation-in-progress"))
+        type_check_assignment (sym, v, ly_symbol2scm ("backend-type?"));
 
       check_interfaces_for_property (this, sym);
     }
@@ -144,7 +141,7 @@ Grob::internal_get_property_data (SCM sym) const
   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)
     return scm_cdr (handle);
@@ -154,12 +151,13 @@ 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) && !Simple_closure::is_smob (val)
+          && !Unpure_pure_container::is_smob (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);
 }
 
@@ -171,30 +169,62 @@ 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 (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 ();
-       }
+        {
+          message ("backtrace: ");
+          print_property_callback_stack ();
+        }
     }
 #endif
-  
+
+  if (Unpure_pure_container *upc = Unpure_pure_container::unsmob (val))
+    val = upc->unpure_part ();
+
   if (ly_is_procedure (val)
-      || is_simple_closure (val))
+      || Simple_closure::is_smob (val))
     {
-      Grob *me = ((Grob*)this);
+      Grob *me = ((Grob *)this);
       val = me->try_callback_on_alist (&me->mutable_property_alist_, sym, val);
     }
-  
+
+  return val;
+}
+
+/* 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 = Unpure_pure_container::unsmob (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);
+  }
+
+  if (Simple_closure *sc = Simple_closure::unsmob (val))
+    return evaluate_with_simple_closure (self_scm (),
+                                         sc->expression (),
+                                         true, start, end);
   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
@@ -210,44 +240,39 @@ Grob::try_callback_on_alist (SCM *alist, SCM sym, SCM proc)
   SCM value = SCM_EOL;
   if (ly_is_procedure (proc))
     value = scm_call_1 (proc, self_scm ());
-  else if (is_simple_closure (proc))
+  else if (Simple_closure *sc = Simple_closure::unsmob (proc))
     {
       value = evaluate_with_simple_closure (self_scm (),
-                                           simple_closure_expression (proc),
-                                           false, 0, 0);
+                                            sc->expression (),
+                                            false, 0, 0);
     }
-  
+
 #ifndef NDEBUG
   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)
     {
       value = get_property_data (sym);
       assert (value == SCM_EOL || value == marker);
       if (value == marker)
-       *alist = scm_assq_remove_x (*alist, marker);
+        *alist = scm_assq_remove_x (*alist, sym);
     }
   else
     {
 #ifndef NDEBUG
       if (ly_is_procedure (cache_callback))
-       scm_apply_0 (cache_callback,
-                    scm_list_n (self_scm (),
-                                sym,
-                                proc,
-                                value,
-                                SCM_UNDEFINED));
+        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,17 +299,18 @@ 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)
     {
       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);
-       }
-      
+          || Simple_closure::is_smob (val)
+          || Unpure_pure_container::is_smob (val))
+        {
+          Grob *me = ((Grob *)this);
+          val = me->try_callback_on_alist (&me->object_alist_, sym, val);
+        }
+
       return val;
     }
 
@@ -306,9 +332,35 @@ Grob::internal_has_interface (SCM k)
 SCM
 call_pure_function (SCM unpure, SCM args, int start, int end)
 {
-  SCM scm_call_pure_function = ly_lily_module_constant ("call-pure-function");
+  if (Unpure_pure_container *upc = Unpure_pure_container::unsmob (unpure))
+    {
+      SCM pure = upc->pure_part ();
+
+      if (Simple_closure *sc = Simple_closure::unsmob (pure))
+        {
+          SCM expr = sc->expression ();
+          return evaluate_with_simple_closure (scm_car (args), expr, true, start, end);
+        }
+
+      if (ly_is_procedure (pure))
+        return scm_apply_0 (pure,
+                            scm_append (scm_list_2 (scm_list_3 (scm_car (args),
+                                                                scm_from_int (start),
+                                                                scm_from_int (end)),
+                                                    scm_cdr (args))));
+
+      return pure;
+    }
+
+  if (Simple_closure *sc = Simple_closure::unsmob (unpure))
+    {
+      SCM expr = sc->expression ();
+      return evaluate_with_simple_closure (scm_car (args), expr, true, start, end);
+    }
+
+  if (!ly_is_procedure (unpure))
+    return unpure;
 
-  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;
 }