2 Implement storage and manipulation of grob properties.
9 #include "pointer-group-interface.hh"
11 #include "paper-score.hh"
12 #include "output-def.hh"
14 #include "international.hh"
18 #include "program-option.hh"
20 #include "simple-closure.hh"
24 static SCM modification_callback = SCM_EOL;
26 LY_DEFINE (ly_set_grob_modification_callback, "ly:set-grob-modification-callback",
28 "Specify a procedure that will be called every time lilypond modifies "
29 "a grob property. The callback will receive as arguments "
30 "the grob that is being modified, the name of the C++ file in which "
31 "the modification was requested, the line number in the C++ file in "
32 "which the modification was requested, the property to be changed and "
33 "the new value for the property.")
36 SCM_ASSERT_TYPE(ly_is_procedure (cb), cb, SCM_ARG1, __FUNCTION__,
39 modification_callback = cb;
40 return SCM_UNSPECIFIED;
45 Grob::get_property_alist_chain (SCM def) const
47 return scm_list_n (mutable_property_alist_,
48 immutable_property_alist_,
54 extern void check_interfaces_for_property (Grob const *me, SCM sym);
58 Grob::internal_set_property (SCM sym, SCM v, char const *file, int line, char const *fun)
60 SCM grob_p = ly_lily_module_constant ("ly:grob?");
61 SCM grob_list_p = ly_lily_module_constant ("grob-list?");
62 SCM type = scm_object_property (sym, ly_symbol2scm ("backend-type?"));
65 || type == grob_list_p
66 || (unsmob_grob (v) && ly_symbol2scm ("cause") != sym))
68 scm_display (scm_list_2 (sym, type), scm_current_output_port ());
72 internal_set_value_on_alist (&mutable_property_alist_,
76 if (ly_is_procedure (modification_callback))
77 scm_apply_0 (modification_callback,
78 scm_list_n (self_scm (),
79 scm_from_locale_string (file),
81 scm_from_locale_string (fun),
82 sym, v, SCM_UNDEFINED));
86 Grob::internal_set_property (SCM sym, SCM v)
88 internal_set_value_on_alist (&mutable_property_alist_,
95 Grob::internal_set_value_on_alist (SCM *alist, SCM sym, SCM v)
97 /* Perhaps we simply do the assq_set, but what the heck. */
101 if (do_internal_type_checking_global)
103 if (!ly_is_procedure (v)
104 && !is_simple_closure (v)
105 && v != ly_symbol2scm ("calculation-in-progress"))
106 type_check_assignment (sym, v, ly_symbol2scm ("backend-type?"));
108 check_interfaces_for_property (this, sym);
111 *alist = scm_assq_set_x (*alist, sym, v);
115 Grob::internal_get_property_data (SCM sym) const
118 if (profile_property_accesses)
119 note_property_access (&grob_property_lookup_table, sym);
122 SCM handle = scm_sloppy_assq (sym, mutable_property_alist_);
123 if (handle != SCM_BOOL_F)
124 return scm_cdr (handle);
126 handle = scm_sloppy_assq (sym, immutable_property_alist_);
128 if (do_internal_type_checking_global && scm_is_pair (handle))
130 SCM val = scm_cdr (handle);
131 if (!ly_is_procedure (val) && !is_simple_closure (val))
132 type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"));
134 check_interfaces_for_property (this, sym);
137 return (handle == SCM_BOOL_F) ? SCM_EOL : scm_cdr (handle);
141 Grob::internal_get_property (SCM sym) const
143 SCM val = get_property_data (sym);
144 if (ly_is_procedure (val)
145 || is_simple_closure (val))
147 Grob *me = ((Grob*)this);
148 val = me->try_callback_on_alist (&me->mutable_property_alist_, sym, val);
155 #include "protected-scm.hh"
157 Protected_scm grob_property_callback_stack = SCM_EOL;
158 bool debug_property_callbacks = 0;
162 Grob::try_callback_on_alist (SCM *alist, SCM sym, SCM proc)
164 SCM marker = ly_symbol2scm ("calculation-in-progress");
166 need to put a value in SYM to ensure that we don't get a
169 *alist = scm_assq_set_x (*alist, sym, marker);
172 if (debug_property_callbacks)
173 grob_property_callback_stack = scm_acons (sym, proc, grob_property_callback_stack);
177 if (ly_is_procedure (proc))
178 value = scm_call_1 (proc, self_scm ());
179 else if (is_simple_closure (proc))
181 value = evaluate_with_simple_closure (self_scm (),
182 simple_closure_expression (proc),
187 if (debug_property_callbacks)
188 grob_property_callback_stack = scm_cdr (grob_property_callback_stack);
192 If the function returns SCM_UNSPECIFIED, we assume the
193 property has been set with an explicit set_property()
196 if (value == SCM_UNSPECIFIED)
198 value = internal_get_property (sym);
199 assert (value == SCM_EOL || value == marker);
201 *alist = scm_assq_remove_x (*alist, marker);
204 internal_set_value_on_alist (alist, sym, value);
210 Grob::internal_set_object (SCM s, SCM v)
212 /* Perhaps we simply do the assq_set, but what the heck. */
216 object_alist_ = scm_assq_set_x (object_alist_, s, v);
220 Grob::internal_del_property (SCM sym)
222 mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, sym);
226 Grob::internal_get_object (SCM sym) const
228 if (profile_property_accesses)
229 note_property_access (&grob_property_lookup_table, sym);
231 SCM s = scm_sloppy_assq (sym, object_alist_);
235 SCM val = scm_cdr (s);
236 if (ly_is_procedure (val)
237 || is_simple_closure (val))
239 Grob *me = ((Grob*)this);
240 val = me->try_callback_on_alist (&me->object_alist_, sym, val);
250 Grob::is_live () const
252 return scm_is_pair (immutable_property_alist_);
256 Grob::internal_has_interface (SCM k)
258 return scm_c_memq (k, interfaces_) != SCM_BOOL_F;
262 call_pure_function (SCM unpure, SCM args, int start, int end)
264 SCM scm_call_pure_function = ly_lily_module_constant ("call-pure-function");
266 return scm_apply_0 (scm_call_pure_function,
267 scm_list_4 (unpure, args, scm_from_int (start), scm_from_int (end)));