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"
22 #include "protected-scm.hh"
24 Protected_scm grob_property_callback_stack = SCM_EOL;
26 extern bool debug_property_callbacks;
30 print_property_callback_stack ()
33 for (SCM s = grob_property_callback_stack; scm_is_pair (s); s = scm_cdr (s))
34 message (_f ("%d: %s", frame++, ly_scm_write_string (scm_car (s)).c_str ()));
38 static SCM modification_callback = SCM_EOL;
39 static SCM cache_callback = SCM_EOL;
42 FIXME: this should use ly:set-option interface instead.
45 LY_DEFINE (ly_set_grob_modification_callback, "ly:set-grob-modification-callback",
47 "Specify a procedure that will be called every time LilyPond"
48 " modifies a grob property. The callback will receive as"
49 " arguments the grob that is being modified, the name of the"
50 " C++ file in which the modification was requested, the line"
51 " number in the C++ file in which the modification was requested,"
52 " the name of the function in which the modification was"
53 " requested, the property to be changed, and the new value for"
56 modification_callback = (ly_is_procedure (cb)) ? cb : SCM_BOOL_F;
57 return SCM_UNSPECIFIED;
60 LY_DEFINE (ly_set_property_cache_callback, "ly:set-property-cache-callback",
62 "Specify a procedure that will be called whenever lilypond"
63 " calculates a callback function and caches the result. The"
64 " callback will receive as arguments the grob whose property it"
65 " is, the name of the property, the name of the callback that"
66 " calculated the property, and the new (cached) value of the"
69 cache_callback = (ly_is_procedure (cb)) ? cb : SCM_BOOL_F;
70 return SCM_UNSPECIFIED;
74 Grob::instrumented_set_property (SCM sym, SCM v,
80 if (ly_is_procedure (modification_callback))
81 scm_apply_0 (modification_callback,
82 scm_list_n (self_scm (),
83 scm_from_locale_string (file),
85 scm_from_locale_string (fun),
86 sym, v, SCM_UNDEFINED));
93 internal_set_property (sym, v);
97 Grob::get_property_alist_chain (SCM def) const
99 return scm_list_n (mutable_property_alist_,
100 immutable_property_alist_,
105 extern void check_interfaces_for_property (Grob const *me, SCM sym);
108 Grob::internal_set_property (SCM sym, SCM v)
110 internal_set_value_on_alist (&mutable_property_alist_,
116 Grob::internal_set_value_on_alist (SCM *alist, SCM sym, SCM v)
118 /* Perhaps we simply do the assq_set, but what the heck. */
122 if (do_internal_type_checking_global)
124 if (!ly_is_procedure (v)
125 && !is_simple_closure (v)
126 && v != ly_symbol2scm ("calculation-in-progress"))
127 type_check_assignment (sym, v, ly_symbol2scm ("backend-type?"));
129 check_interfaces_for_property (this, sym);
132 *alist = scm_assq_set_x (*alist, sym, v);
136 Grob::internal_get_property_data (SCM sym) const
139 if (profile_property_accesses)
140 note_property_access (&grob_property_lookup_table, sym);
143 SCM handle = scm_sloppy_assq (sym, mutable_property_alist_);
144 if (handle != SCM_BOOL_F)
145 return scm_cdr (handle);
147 handle = scm_sloppy_assq (sym, immutable_property_alist_);
149 if (do_internal_type_checking_global && scm_is_pair (handle))
151 SCM val = scm_cdr (handle);
152 if (!ly_is_procedure (val) && !is_simple_closure (val))
153 type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"));
155 check_interfaces_for_property (this, sym);
158 return (handle == SCM_BOOL_F) ? SCM_EOL : scm_cdr (handle);
162 Grob::internal_get_property (SCM sym) const
164 SCM val = get_property_data (sym);
167 if (val == ly_symbol2scm ("calculation-in-progress"))
169 programming_error (_f ("cyclic dependency: calculation-in-progress encountered for #'%s (%s)",
170 ly_symbol2string (sym).c_str (),
172 if (debug_property_callbacks)
174 message ("backtrace: ");
175 print_property_callback_stack ();
180 if (ly_is_procedure (val)
181 || is_simple_closure (val))
183 Grob *me = ((Grob *)this);
184 val = me->try_callback_on_alist (&me->mutable_property_alist_, sym, val);
190 /* Unlike internal_get_property, this function does no caching. Use it, therefore, with caution. */
192 Grob::internal_get_pure_property (SCM sym, int start, int end) const
194 SCM val = internal_get_property_data (sym);
195 if (ly_is_procedure (val))
196 return call_pure_function (val, scm_list_1 (self_scm ()), start, end);
197 if (is_simple_closure (val))
198 return evaluate_with_simple_closure (self_scm (),
199 simple_closure_expression (val),
205 Grob::internal_get_maybe_pure_property (SCM sym, bool pure, int start, int end) const
207 return pure ? internal_get_pure_property (sym, start, end) : internal_get_property (sym);
211 Grob::try_callback_on_alist (SCM *alist, SCM sym, SCM proc)
213 SCM marker = ly_symbol2scm ("calculation-in-progress");
215 need to put a value in SYM to ensure that we don't get a
218 *alist = scm_assq_set_x (*alist, sym, marker);
221 if (debug_property_callbacks)
222 grob_property_callback_stack = scm_cons (scm_list_3 (self_scm (), sym, proc), grob_property_callback_stack);
226 if (ly_is_procedure (proc))
227 value = scm_call_1 (proc, self_scm ());
228 else if (is_simple_closure (proc))
230 value = evaluate_with_simple_closure (self_scm (),
231 simple_closure_expression (proc),
236 if (debug_property_callbacks)
237 grob_property_callback_stack = scm_cdr (grob_property_callback_stack);
241 If the function returns SCM_UNSPECIFIED, we assume the
242 property has been set with an explicit set_property ()
245 if (value == SCM_UNSPECIFIED)
247 value = get_property_data (sym);
248 assert (value == SCM_EOL || value == marker);
250 *alist = scm_assq_remove_x (*alist, marker);
255 if (ly_is_procedure (cache_callback))
256 scm_apply_0 (cache_callback,
257 scm_list_n (self_scm (),
263 internal_set_value_on_alist (alist, sym, value);
270 Grob::internal_set_object (SCM s, SCM v)
272 /* Perhaps we simply do the assq_set, but what the heck. */
276 object_alist_ = scm_assq_set_x (object_alist_, s, v);
280 Grob::internal_del_property (SCM sym)
282 mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, sym);
286 Grob::internal_get_object (SCM sym) const
288 if (profile_property_accesses)
289 note_property_access (&grob_property_lookup_table, sym);
291 SCM s = scm_sloppy_assq (sym, object_alist_);
295 SCM val = scm_cdr (s);
296 if (ly_is_procedure (val)
297 || is_simple_closure (val))
299 Grob *me = ((Grob *)this);
300 val = me->try_callback_on_alist (&me->object_alist_, sym, val);
310 Grob::is_live () const
312 return scm_is_pair (immutable_property_alist_);
316 Grob::internal_has_interface (SCM k)
318 return scm_c_memq (k, interfaces_) != SCM_BOOL_F;
322 call_pure_function (SCM unpure, SCM args, int start, int end)
324 SCM scm_call_pure_function = ly_lily_module_constant ("call-pure-function");
326 return scm_apply_0 (scm_call_pure_function,
327 scm_list_4 (unpure, args, scm_from_int (start), scm_from_int (end)));