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 Protected_scm modification_callback (SCM_EOL);
40 static Protected_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_ascii_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 && !unsmob<Simple_closure> (v)
127 && !unsmob<Unpure_pure_container> (v)
128 && !scm_is_eq (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 (scm_is_true (handle))
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) && !unsmob<Simple_closure> (val)
155 && !unsmob<Unpure_pure_container> (val))
156 type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"));
158 check_interfaces_for_property (this, sym);
161 return scm_is_false (handle) ? SCM_EOL : scm_cdr (handle);
165 Grob::internal_get_property (SCM sym) const
167 SCM val = get_property_data (sym);
170 if (scm_is_eq (val, ly_symbol2scm ("calculation-in-progress")))
172 programming_error (to_string ("cyclic dependency: calculation-in-progress encountered for #'%s (%s)",
173 ly_symbol2string (sym).c_str (),
174 name ().c_str ()));//assert (1==0);
175 if (debug_property_callbacks)
177 message ("backtrace: ");
178 print_property_callback_stack ();
183 if (Unpure_pure_container *upc = unsmob<Unpure_pure_container> (val))
184 val = upc->unpure_part ();
186 if (ly_is_procedure (val)
187 || unsmob<Simple_closure> (val))
189 Grob *me = ((Grob *)this);
190 val = me->try_callback_on_alist (&me->mutable_property_alist_, sym, val);
196 /* Unlike internal_get_property, this function does no caching. Use it, therefore, with caution. */
198 Grob::internal_get_pure_property (SCM sym, int start, int end) const
200 SCM val = internal_get_property_data (sym);
201 if (ly_is_procedure (val))
202 return call_pure_function (val, scm_list_1 (self_scm ()), start, end);
204 if (Unpure_pure_container *upc = unsmob<Unpure_pure_container> (val)) {
205 // Do cache, if the function ignores 'start' and 'end'
206 if (upc->is_unchanging ())
207 return internal_get_property (sym);
209 return call_pure_function (val, scm_list_1 (self_scm ()), start, end);
212 if (Simple_closure *sc = unsmob<Simple_closure> (val))
213 return evaluate_with_simple_closure (self_scm (),
220 Grob::internal_get_maybe_pure_property (SCM sym, bool pure, int start, int end) const
222 return pure ? internal_get_pure_property (sym, start, end) : internal_get_property (sym);
226 Grob::try_callback_on_alist (SCM *alist, SCM sym, SCM proc)
228 SCM marker = ly_symbol2scm ("calculation-in-progress");
230 need to put a value in SYM to ensure that we don't get a
233 *alist = scm_assq_set_x (*alist, sym, marker);
236 if (debug_property_callbacks)
237 grob_property_callback_stack = scm_cons (scm_list_3 (self_scm (), sym, proc), grob_property_callback_stack);
241 if (ly_is_procedure (proc))
242 value = scm_call_1 (proc, self_scm ());
243 else if (Simple_closure *sc = unsmob<Simple_closure> (proc))
245 value = evaluate_with_simple_closure (self_scm (),
251 if (debug_property_callbacks)
252 grob_property_callback_stack = scm_cdr (grob_property_callback_stack);
255 if (scm_is_eq (value, SCM_UNSPECIFIED))
257 value = get_property_data (sym);
258 assert (scm_is_null (value) || scm_is_eq (value, marker));
259 if (scm_is_eq (value, marker))
260 *alist = scm_assq_remove_x (*alist, sym);
265 if (ly_is_procedure (cache_callback))
266 scm_apply_0 (cache_callback,
267 scm_list_n (self_scm (),
273 internal_set_value_on_alist (alist, sym, value);
280 Grob::internal_set_object (SCM s, SCM v)
282 /* Perhaps we simply do the assq_set, but what the heck. */
286 object_alist_ = scm_assq_set_x (object_alist_, s, v);
290 Grob::internal_del_property (SCM sym)
292 mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, sym);
296 Grob::internal_get_object (SCM sym) const
298 if (profile_property_accesses)
299 note_property_access (&grob_property_lookup_table, sym);
301 SCM s = scm_sloppy_assq (sym, object_alist_);
305 SCM val = scm_cdr (s);
306 if (ly_is_procedure (val)
307 || unsmob<Simple_closure> (val)
308 || unsmob<Unpure_pure_container> (val))
310 Grob *me = ((Grob *)this);
311 val = me->try_callback_on_alist (&me->object_alist_, sym, val);
321 Grob::is_live () const
323 return scm_is_pair (immutable_property_alist_);
327 Grob::internal_has_interface (SCM k)
329 return scm_is_true (scm_c_memq (k, interfaces_));
333 call_pure_function (SCM unpure, SCM args, int start, int end)
335 if (Unpure_pure_container *upc = unsmob<Unpure_pure_container> (unpure))
337 SCM pure = upc->pure_part ();
339 if (Simple_closure *sc = unsmob<Simple_closure> (pure))
341 SCM expr = sc->expression ();
342 return evaluate_with_simple_closure (scm_car (args), expr, true, start, end);
345 if (ly_is_procedure (pure))
346 return scm_apply_0 (pure,
347 scm_append (scm_list_2 (scm_list_3 (scm_car (args),
348 scm_from_int (start),
355 if (Simple_closure *sc = unsmob<Simple_closure> (unpure))
357 SCM expr = sc->expression ();
358 return evaluate_with_simple_closure (scm_car (args), expr, true, start, end);
361 if (!ly_is_procedure (unpure))