X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob-property.cc;h=f1242994d53fb696133cbedfc6e6b2bc1b9336ce;hb=41e2b812edf60eb502de72a6aefefa84c5c26dd9;hp=ec83ef75b5d6055631c7c6ca9b81c50b1ee25b31;hpb=b1323f33e9aa4b9eea05eefb8755c907d4d762d4;p=lilypond.git diff --git a/lily/grob-property.cc b/lily/grob-property.cc index ec83ef75b5..f1242994d5 100644 --- a/lily/grob-property.cc +++ b/lily/grob-property.cc @@ -1,119 +1,247 @@ /* Implement storage and manipulation of grob properties. - */ +*/ -#include -#include +#include #include "main.hh" -#include "input-smob.hh" -#include "group-interface.hh" +#include "input.hh" +#include "pointer-group-interface.hh" #include "misc.hh" #include "paper-score.hh" -#include "paper-def.hh" -#include "grob.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 { - return scm_list_n (mutable_property_alist_, - immutable_property_alist_, - def, - SCM_UNDEFINED); + return scm_list_n (mutable_property_alist_, + immutable_property_alist_, + def, + SCM_UNDEFINED); } +extern void check_interfaces_for_property (Grob const *me, SCM sym); -/* - 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(). -*/ void -Grob::add_to_list_property (SCM sym, SCM thing) +#ifndef NDEBUG +Grob::internal_set_property (SCM sym, SCM v, char const *file, int line, char const *fun) { - SCM handle - = scm_sloppy_assq (sym, mutable_property_alist_) - ; + 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 (handle != SCM_BOOL_F) - { - gh_set_cdr_x (handle, gh_cons (thing, gh_cdr (handle))); - } - else + if (type == grob_p + || type == grob_list_p + || (unsmob_grob (v) && ly_symbol2scm ("cause") != sym)) { - /* - 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) ? gh_cdr(handle) : SCM_EOL; - SCM val = gh_cons (thing, tail); - - mutable_property_alist_ = gh_cons (gh_cons (sym, val), - mutable_property_alist_); + scm_display (scm_list_2 (sym, type), scm_current_output_port ()); + assert (0); } -} - - -extern void check_interfaces_for_property (Grob const *me, SCM sym); - -void -Grob::internal_set_property (SCM s, SCM v) +#else +Grob::internal_set_property (SCM sym, SCM v) { +#endif + /* Perhaps we simply do the assq_set, but what the heck. */ - if (!live ()) + if (!is_live ()) return; - if (internal_type_checking_global_b) + if (do_internal_type_checking_global) { - if (!type_check_assignment (s, v, ly_symbol2scm ("backend-type?"))) + if (!ly_is_procedure (v) + && !is_simple_closure (v) + && v != ly_symbol2scm ("calculation-in-progress") + && !type_check_assignment (sym, v, ly_symbol2scm ("backend-type?"))) abort (); - check_interfaces_for_property (this, s); + check_interfaces_for_property (this, sym); } - mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v); +#ifndef NDEBUG + if (ly_is_procedure (modification_callback)) + scm_apply_0 (modification_callback, + scm_list_n (self_scm (), + scm_makfrom0str (file), + scm_from_int (line), + scm_makfrom0str (fun), + sym, v, SCM_UNDEFINED)); +#endif + + mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, sym, v); } - +//#define PROFILE_PROPERTY_ACCESSES SCM -Grob::internal_get_property (SCM sym) const +Grob::internal_get_property_data (SCM sym) const { - SCM s = scm_sloppy_assq (sym, mutable_property_alist_); - if (s != SCM_BOOL_F) - return ly_cdr (s); - - s = scm_sloppy_assq (sym, immutable_property_alist_); +#ifndef NDEBUG + if (profile_property_accesses) + note_property_access (&grob_property_lookup_table, sym); +#endif - if (internal_type_checking_global_b && gh_pair_p (s)) + 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)) { - if (!type_check_assignment (sym, gh_cdr (s), + SCM val = scm_cdr (handle); + if (!ly_is_procedure (val) + && !is_simple_closure (val) + && !type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"))) abort (); check_interfaces_for_property (this, sym); } + + return (handle == SCM_BOOL_F) ? 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)) + { + val = ((Grob*)this)->try_callback (sym, val); + } + + return val; +} + +#ifndef NDEBUG +#include "protected-scm.hh" - return (s == SCM_BOOL_F) ? SCM_EOL : ly_cdr (s); +Protected_scm grob_property_callback_stack = SCM_EOL; +bool debug_property_callbacks = 0; +#endif + +SCM +Grob::try_callback (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. + */ + mutable_property_alist_ + = scm_assq_set_x (mutable_property_alist_, sym, marker); + +#ifndef NDEBUG + if (debug_property_callbacks) + grob_property_callback_stack = scm_acons (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 + 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); + if (value == marker) + mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, marker); + } + else + set_property (sym, value); + + return value; } void -Grob::substitute_mutable_properties (SCM crit, SCM orig) +Grob::internal_set_object (SCM s, SCM v) { - set_break_subsititution (crit); - mutable_property_alist_ = substitute_mutable_property_alist (orig); + /* Perhaps we simply do the assq_set, but what the heck. */ + if (!is_live ()) + return; + + 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 + + SCM s = scm_sloppy_assq (sym, object_alist_); + + return (s == SCM_BOOL_F) ? SCM_EOL : scm_cdr (s); +} + +bool +Grob::is_live () const +{ + return scm_is_pair (immutable_property_alist_); +} bool -Grob::live () const +Grob::internal_has_interface (SCM k) +{ + return scm_c_memq (k, interfaces_) != SCM_BOOL_F; +} + +SCM +call_pure_function (SCM unpure, SCM args, int start, int end) { - return immutable_property_alist_ != SCM_EOL; + 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))); }