]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob-property.cc
Merge with master
[lilypond.git] / lily / grob-property.cc
index 8cb3243f4bf454d32ee777712b57f8a781a72b26..5e49d8e8ec4747e765c567d9629073bc68bd8c17 100644 (file)
@@ -3,20 +3,43 @@
 */
 
 #include <cstring>
-#include <math.h>
 
 #include "main.hh"
-#include "input-smob.hh"
+#include "input.hh"
 #include "pointer-group-interface.hh"
 #include "misc.hh"
 #include "paper-score.hh"
 #include "output-def.hh"
 #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 "warn.hh"
+
+#ifndef NDEBUG
+static SCM modification_callback = 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.")
+{
+
+  SCM_ASSERT_TYPE(ly_is_procedure (cb), cb, SCM_ARG1, __FUNCTION__,
+                 "procedure");
+
+  modification_callback = cb;
+  return SCM_UNSPECIFIED;
+}
+#endif
 
 SCM
 Grob::get_property_alist_chain (SCM def) const
@@ -27,46 +50,13 @@ Grob::get_property_alist_chain (SCM def) const
                     SCM_UNDEFINED);
 }
 
-/*
-  This special add_thing routine is slightly more efficient than
-
-  set_prop (name, cons (thing, get_prop (name)))
-
-  since it can reuse the handle returned by scm_assq ().
-*/
-// JUNKME.
-void
-Grob::add_to_list_property (SCM sym, SCM thing)
-{
-  SCM handle
-    = scm_sloppy_assq (sym, mutable_property_alist_);
-
-  if (handle != SCM_BOOL_F)
-    {
-      scm_set_cdr_x (handle, scm_cons (thing, scm_cdr (handle)));
-    }
-  else
-    {
-      /*
-       There is no mutable prop yet, so create an entry, and put it in front of the
-       mutable prop list.
-      */
-      handle = scm_sloppy_assq (sym, immutable_property_alist_);
-      SCM tail = (handle != SCM_BOOL_F) ? scm_cdr (handle) : SCM_EOL;
-      SCM val = scm_cons (thing, tail);
-
-      mutable_property_alist_ = scm_cons (scm_cons (sym, val),
-                                         mutable_property_alist_);
-    }
-}
-
 
 extern void check_interfaces_for_property (Grob const *me, SCM sym);
 
+#ifndef NDEBUG
 void
-Grob::internal_set_property (SCM sym, SCM v)
+Grob::internal_set_property (SCM sym, SCM v, char const *file, int line, char const *fun)
 {
-#ifndef NDEBUG
   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?"));
@@ -78,55 +68,144 @@ Grob::internal_set_property (SCM sym, SCM v)
       scm_display (scm_list_2 (sym, type), scm_current_output_port ());
       assert (0);
     }
+  
+  internal_set_value_on_alist (&mutable_property_alist_,
+                              sym, v);
+
+
+  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));
+}
+#else
+void
+Grob::internal_set_property (SCM sym, SCM v)
+{
+  internal_set_value_on_alist (&mutable_property_alist_,
+                              sym, v);
+
+}
 #endif
 
+void
+Grob::internal_set_value_on_alist (SCM *alist, SCM sym, SCM v)
+{
   /* Perhaps we simply do the assq_set, but what the heck. */
   if (!is_live ())
     return;
 
   if (do_internal_type_checking_global)
     {
-      if (!type_check_assignment (sym, v, ly_symbol2scm ("backend-type?")))
-       abort ();
+      if (!ly_is_procedure (v)
+         && !is_simple_closure (v)
+         && v != ly_symbol2scm ("calculation-in-progress"))
+       type_check_assignment (sym, v, ly_symbol2scm ("backend-type?"));
+
       check_interfaces_for_property (this, sym);
     }
 
-  mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, sym, v);
+  *alist = scm_assq_set_x (*alist, sym, v);
 }
 
-//#define PROFILE_PROPERTY_ACCESSES
+SCM
+Grob::internal_get_property_data (SCM sym) const
+{
+#ifndef NDEBUG
+  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);
+
+  handle = scm_sloppy_assq (sym, immutable_property_alist_);
 
+  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?"));
 
+      check_interfaces_for_property (this, sym);
+    }
+  
+  return (handle == SCM_BOOL_F) ? SCM_EOL : scm_cdr (handle);
+}
 
 SCM
 Grob::internal_get_property (SCM sym) const
 {
-#ifndef NDEBUG
-  if (profile_property_accesses)
+  SCM val = get_property_data (sym);
+  if (ly_is_procedure (val)
+      || is_simple_closure (val))
     {
-      note_property_access (&grob_property_lookup_table, sym);
+      Grob *me = ((Grob*)this);
+      val = me->try_callback_on_alist (&me->mutable_property_alist_, sym, val);
     }
+  
+  return val;
+}
+
+#ifndef NDEBUG
+#include "protected-scm.hh"
+
+Protected_scm grob_property_callback_stack = SCM_EOL;
+bool debug_property_callbacks = 0;
 #endif
 
-  SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
-  if (s != SCM_BOOL_F)
-    return scm_cdr (s);
+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
+    cyclic call chain.
+  */
+  *alist = scm_assq_set_x (*alist, sym, marker);
 
-  s = scm_sloppy_assq (sym, immutable_property_alist_);
+#ifndef NDEBUG
+  if (debug_property_callbacks)
+    grob_property_callback_stack = scm_acons (sym, proc, grob_property_callback_stack);
+#endif
 
-  if (do_internal_type_checking_global && scm_is_pair (s))
+  SCM value = SCM_EOL;
+  if (ly_is_procedure (proc))
+    value = scm_call_1 (proc, self_scm ());
+  else if (is_simple_closure (proc))
     {
-      if (!type_check_assignment (sym, scm_cdr (s),
-                                 ly_symbol2scm ("backend-type?")))
-       abort ();
-
-      check_interfaces_for_property (this, sym);
+      value = evaluate_with_simple_closure (self_scm (),
+                                           simple_closure_expression (proc),
+                                           false, 0, 0);
     }
-
-  return (s == SCM_BOOL_F) ? SCM_EOL : scm_cdr (s);
+  
+#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 = internal_get_property (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);
+  
+  return value;
 }
 
-
 void
 Grob::internal_set_object (SCM s, SCM v)
 {
@@ -137,27 +216,53 @@ Grob::internal_set_object (SCM s, SCM v)
   object_alist_ = scm_assq_set_x (object_alist_, s, v);
 }
 
+void
+Grob::internal_del_property (SCM sym)
+{
+  mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, sym);
+}
+
 SCM
 Grob::internal_get_object (SCM sym) const
 {
-#ifdef PROFILE_PROPERTY_ACCESSES
-  note_property_access (&grob_property_lookup_table, sym);
-#endif
+  if (profile_property_accesses)
+    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);
+       }
+      
+      return val;
+    }
 
-  return (s == SCM_BOOL_F) ? SCM_EOL : scm_cdr (s);
+  return SCM_EOL;
 }
 
-void
-Grob::substitute_object_links (SCM crit, SCM orig)
+bool
+Grob::is_live () const
 {
-  set_break_subsititution (crit);
-  object_alist_ = substitute_object_alist (orig, object_alist_);
+  return scm_is_pair (immutable_property_alist_);
 }
 
 bool
-Grob::is_live () const
+Grob::internal_has_interface (SCM k)
 {
-  return immutable_property_alist_ != SCM_EOL;
+  return scm_c_memq (k, interfaces_) != SCM_BOOL_F;
+}
+
+SCM
+call_pure_function (SCM unpure, SCM args, int start, int end)
+{
+  SCM scm_call_pure_function = ly_lily_module_constant ("call-pure-function");
+
+  return scm_apply_0 (scm_call_pure_function,
+                     scm_list_4 (unpure, args, scm_from_int (start), scm_from_int (end)));
 }