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"
21 #include "unpure-pure-container.hh"
23 #include "protected-scm.hh"
25 Protected_scm grob_property_callback_stack = SCM_EOL;
27 extern bool debug_property_callbacks;
31 print_property_callback_stack ()
34 for (SCM s = grob_property_callback_stack; scm_is_pair (s); s = scm_cdr (s))
35 message (_f ("%d: %s", frame++, ly_scm_write_string (scm_car (s)).c_str ()));
39 static SCM modification_callback = SCM_EOL;
40 static SCM cache_callback = SCM_EOL;
43 FIXME: this should use ly:set-option interface instead.
46 LY_DEFINE (ly_set_grob_modification_callback, "ly:set-grob-modification-callback",
48 "Specify a procedure that will be called every time LilyPond"
49 " modifies a grob property. The callback will receive as"
50 " arguments the grob that is being modified, the name of the"
51 " C++ file in which the modification was requested, the line"
52 " number in the C++ file in which the modification was requested,"
53 " the name of the function in which the modification was"
54 " requested, the property to be changed, and the new value for"
57 modification_callback = (ly_is_procedure (cb)) ? cb : SCM_BOOL_F;
58 return SCM_UNSPECIFIED;
61 LY_DEFINE (ly_set_property_cache_callback, "ly:set-property-cache-callback",
63 "Specify a procedure that will be called whenever lilypond"
64 " calculates a callback function and caches the result. The"
65 " callback will receive as arguments the grob whose property it"
66 " is, the name of the property, the name of the callback that"
67 " calculated the property, and the new (cached) value of the"
70 cache_callback = (ly_is_procedure (cb)) ? cb : SCM_BOOL_F;
71 return SCM_UNSPECIFIED;
75 Grob::instrumented_set_property (SCM sym, SCM v,
81 if (ly_is_procedure (modification_callback))
82 scm_apply_0 (modification_callback,
83 scm_list_n (self_scm (),
84 scm_from_locale_string (file),
86 scm_from_locale_string (fun),
87 sym, v, SCM_UNDEFINED));
94 internal_set_property (sym, v);
98 Grob::get_property_alist_chain (SCM def) const
100 return scm_list_n (mutable_property_alist_,
101 immutable_property_alist_,
106 extern void check_interfaces_for_property (Grob const *me, SCM sym);
109 Grob::internal_set_property (SCM sym, SCM v)
111 internal_set_value_on_alist (&mutable_property_alist_,
117 Grob::internal_set_value_on_alist (SCM *alist, SCM sym, SCM v)
119 /* Perhaps we simply do the assq_set, but what the heck. */
123 if (do_internal_type_checking_global)
125 if (!ly_is_procedure (v)
126 && !is_simple_closure (v)
127 && !is_unpure_pure_container (v)
128 && v != ly_symbol2scm ("calculation-in-progress"))
129 type_check_assignment (sym, v, ly_symbol2scm ("backend-type?"));
131 check_interfaces_for_property (this, sym);
134 *alist = scm_assq_set_x (*alist, sym, v);
138 Grob::internal_get_property_data (SCM sym) const
141 if (profile_property_accesses)
142 note_property_access (&grob_property_lookup_table, sym);
145 SCM handle = scm_sloppy_assq (sym, mutable_property_alist_);
146 if (handle != SCM_BOOL_F)
147 return scm_cdr (handle);
149 handle = scm_sloppy_assq (sym, immutable_property_alist_);
151 if (do_internal_type_checking_global && scm_is_pair (handle))
153 SCM val = scm_cdr (handle);
154 if (!ly_is_procedure (val) && !is_simple_closure (val) && !is_unpure_pure_container (val))
155 type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"));
157 check_interfaces_for_property (this, sym);
160 return (handle == SCM_BOOL_F) ? SCM_EOL : scm_cdr (handle);
164 Grob::internal_get_property (SCM sym) const
166 SCM val = get_property_data (sym);
169 if (val == ly_symbol2scm ("calculation-in-progress"))
171 programming_error (to_string ("cyclic dependency: calculation-in-progress encountered for #'%s (%s)",
172 ly_symbol2string (sym).c_str (),
174 if (debug_property_callbacks)
176 message ("backtrace: ");
177 print_property_callback_stack ();
182 if (is_unpure_pure_container (val))
183 val = unpure_pure_container_unpure_part (val);
184 if (ly_is_procedure (val)
185 || is_simple_closure (val))
187 Grob *me = ((Grob *)this);
188 val = me->try_callback_on_alist (&me->mutable_property_alist_, sym, val);
194 /* Unlike internal_get_property, this function does no caching. Use it, therefore, with caution. */
196 Grob::internal_get_pure_property (SCM sym, int start, int end) const
198 SCM val = internal_get_property_data (sym);
199 if (ly_is_procedure (val) || is_unpure_pure_container (val))
200 return call_pure_function (val, scm_list_1 (self_scm ()), start, end);
201 if (is_simple_closure (val))
202 return evaluate_with_simple_closure (self_scm (),
203 simple_closure_expression (val),
209 Grob::internal_get_maybe_pure_property (SCM sym, bool pure, int start, int end) const
211 return pure ? internal_get_pure_property (sym, start, end) : internal_get_property (sym);
215 Grob::try_callback_on_alist (SCM *alist, SCM sym, SCM proc)
217 SCM marker = ly_symbol2scm ("calculation-in-progress");
219 need to put a value in SYM to ensure that we don't get a
222 *alist = scm_assq_set_x (*alist, sym, marker);
225 if (debug_property_callbacks)
226 grob_property_callback_stack = scm_cons (scm_list_3 (self_scm (), sym, proc), grob_property_callback_stack);
230 if (ly_is_procedure (proc))
231 value = scm_call_1 (proc, self_scm ());
232 else if (is_simple_closure (proc))
234 value = evaluate_with_simple_closure (self_scm (),
235 simple_closure_expression (proc),
240 if (debug_property_callbacks)
241 grob_property_callback_stack = scm_cdr (grob_property_callback_stack);
245 If the function returns SCM_UNSPECIFIED, we assume the
246 property has been set with an explicit set_property ()
249 if (value == SCM_UNSPECIFIED)
251 value = get_property_data (sym);
252 assert (value == SCM_EOL || value == marker);
254 *alist = scm_assq_remove_x (*alist, marker);
259 if (ly_is_procedure (cache_callback))
260 scm_apply_0 (cache_callback,
261 scm_list_n (self_scm (),
267 internal_set_value_on_alist (alist, sym, value);
274 Grob::internal_set_object (SCM s, SCM v)
276 /* Perhaps we simply do the assq_set, but what the heck. */
280 object_alist_ = scm_assq_set_x (object_alist_, s, v);
284 Grob::internal_del_property (SCM sym)
286 mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, sym);
290 Grob::internal_get_object (SCM sym) const
292 if (profile_property_accesses)
293 note_property_access (&grob_property_lookup_table, sym);
295 SCM s = scm_sloppy_assq (sym, object_alist_);
299 SCM val = scm_cdr (s);
300 if (ly_is_procedure (val)
301 || is_simple_closure (val)
302 || is_unpure_pure_container (val))
304 Grob *me = ((Grob *)this);
305 val = me->try_callback_on_alist (&me->object_alist_, sym, val);
315 Grob::is_live () const
317 return scm_is_pair (immutable_property_alist_);
321 Grob::internal_has_interface (SCM k)
323 return scm_c_memq (k, interfaces_) != SCM_BOOL_F;
327 call_pure_function (SCM unpure, SCM args, int start, int end)
329 SCM scm_call_pure_function = ly_lily_module_constant ("call-pure-function");
331 return scm_apply_0 (scm_call_pure_function,
332 scm_list_4 (unpure, args, scm_from_int (start), scm_from_int (end)));