#include "program-option.hh"
#include "profile.hh"
#include "simple-closure.hh"
+#include "unpure-pure-container.hh"
#include "warn.hh"
+#include "protected-scm.hh"
+
+Protected_scm grob_property_callback_stack = SCM_EOL;
+
+extern bool debug_property_callbacks;
#ifndef NDEBUG
-static SCM modification_callback = SCM_EOL;
+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;
+
+/*
+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.")
+ 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;
+}
- SCM_ASSERT_TYPE(ly_is_procedure (cb), cb, SCM_ARG1, __FUNCTION__,
- "procedure");
-
- 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 (),
+ 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);
+}
+
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);
-#ifndef NDEBUG
-void
-Grob::internal_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);
-
-
- 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);
+ sym, v);
}
-#endif
void
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?"));
+ && !is_simple_closure (v)
+ && !is_unpure_pure_container (v)
+ && v != ly_symbol2scm ("calculation-in-progress"))
+ type_check_assignment (sym, v, ly_symbol2scm ("backend-type?"));
check_interfaces_for_property (this, sym);
}
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);
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) && !is_simple_closure (val) && !is_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);
}
Grob::internal_get_property (SCM sym) const
{
SCM val = get_property_data (sym);
+
+#ifndef NDEBUG
+ if (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 (is_unpure_pure_container (val))
+ val = unpure_pure_container_unpure_part (val);
+
if (ly_is_procedure (val)
|| is_simple_closure (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) || is_unpure_pure_container (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)
-{
+{
SCM marker = ly_symbol2scm ("calculation-in-progress");
/*
need to put a value in SYM to ensure that we don't get a
#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;
else if (is_simple_closure (proc))
{
value = evaluate_with_simple_closure (self_scm (),
- simple_closure_expression (proc),
- false, 0, 0);
+ simple_closure_expression (proc),
+ 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 = 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);
+ *alist = scm_assq_remove_x (*alist, sym);
}
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;
}
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);
- }
-
+ || is_simple_closure (val)
+ || is_unpure_pure_container (val))
+ {
+ Grob *me = ((Grob *)this);
+ val = me->try_callback_on_alist (&me->object_alist_, sym, val);
+ }
+
return val;
}
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 (is_unpure_pure_container (unpure))
+ {
+ SCM pure = unpure_pure_container_pure_part (unpure);
+
+ if (is_simple_closure (pure))
+ {
+ SCM expr = simple_closure_expression (pure);
+ 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;
+ }
- return scm_apply_0 (scm_call_pure_function,
- scm_list_4 (unpure, args, scm_from_int (start), scm_from_int (end)));
+ if (is_simple_closure (unpure))
+ {
+ SCM expr = simple_closure_expression (unpure);
+ return evaluate_with_simple_closure (scm_car (args), expr, true, start, end);
+ }
+
+ if (!ly_is_procedure (unpure))
+ return unpure;
+
+ return SCM_BOOL_F;
}
+