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.")
35 if (!ly_is_procedure (cb))
36 warning (_ ("not setting modification callback: not a procedure"));
38 modification_callback = cb;
44 Grob::get_property_alist_chain (SCM def) const
46 return scm_list_n (mutable_property_alist_,
47 immutable_property_alist_,
53 extern void check_interfaces_for_property (Grob const *me, SCM sym);
57 Grob::internal_set_property (SCM sym, SCM v, char const *file, int line, char const *fun)
59 SCM grob_p = ly_lily_module_constant ("ly:grob?");
60 SCM grob_list_p = ly_lily_module_constant ("grob-list?");
61 SCM type = scm_object_property (sym, ly_symbol2scm ("backend-type?"));
64 || type == grob_list_p
65 || (unsmob_grob (v) && ly_symbol2scm ("cause") != sym))
67 scm_display (scm_list_2 (sym, type), scm_current_output_port ());
71 Grob::internal_set_property (SCM sym, SCM v)
75 /* Perhaps we simply do the assq_set, but what the heck. */
79 if (do_internal_type_checking_global)
81 if (!ly_is_procedure (v)
82 && !is_simple_closure (v)
83 && v != ly_symbol2scm ("calculation-in-progress")
84 && !type_check_assignment (sym, v, ly_symbol2scm ("backend-type?")))
86 check_interfaces_for_property (this, sym);
90 if (ly_is_procedure (modification_callback))
91 scm_apply_0 (modification_callback,
92 scm_list_n (self_scm (),
93 scm_makfrom0str (file),
95 scm_makfrom0str (fun),
96 sym, v, SCM_UNDEFINED));
99 mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, sym, v);
102 //#define PROFILE_PROPERTY_ACCESSES
104 Grob::internal_get_property_data (SCM sym) const
107 if (profile_property_accesses)
108 note_property_access (&grob_property_lookup_table, sym);
111 SCM handle = scm_sloppy_assq (sym, mutable_property_alist_);
112 if (handle != SCM_BOOL_F)
113 return scm_cdr (handle);
115 handle = scm_sloppy_assq (sym, immutable_property_alist_);
117 if (do_internal_type_checking_global && scm_is_pair (handle))
119 SCM val = scm_cdr (handle);
120 if (!ly_is_procedure (val)
121 && !is_simple_closure (val)
122 && !type_check_assignment (sym, val,
123 ly_symbol2scm ("backend-type?")))
126 check_interfaces_for_property (this, sym);
129 return (handle == SCM_BOOL_F) ? SCM_EOL : scm_cdr (handle);
133 Grob::internal_get_property (SCM sym) const
135 SCM val = get_property_data (sym);
136 if (ly_is_procedure (val)
137 || is_simple_closure (val))
139 val = ((Grob*)this)->try_callback (sym, val);
146 #include "protected-scm.hh"
148 Protected_scm grob_property_callback_stack = SCM_EOL;
149 bool debug_property_callbacks = 0;
153 Grob::try_callback (SCM sym, SCM proc)
155 SCM marker = ly_symbol2scm ("calculation-in-progress");
157 need to put a value in SYM to ensure that we don't get a
160 mutable_property_alist_
161 = scm_assq_set_x (mutable_property_alist_, sym, marker);
164 if (debug_property_callbacks)
165 grob_property_callback_stack = scm_acons (sym, proc, grob_property_callback_stack);
169 if (ly_is_procedure (proc))
170 value = scm_call_1 (proc, self_scm ());
171 else if (is_simple_closure (proc))
173 value = evaluate_with_simple_closure (self_scm (),
174 simple_closure_expression (proc),
178 if (debug_property_callbacks)
179 grob_property_callback_stack = scm_cdr (grob_property_callback_stack);
183 If the function returns SCM_UNSPECIFIED, we assume the
184 property has been set with an explicit set_property()
187 if (value == SCM_UNSPECIFIED)
189 value = internal_get_property (sym);
191 mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, marker);
194 set_property (sym, value);
200 Grob::internal_set_object (SCM s, SCM v)
202 /* Perhaps we simply do the assq_set, but what the heck. */
206 object_alist_ = scm_assq_set_x (object_alist_, s, v);
210 Grob::internal_del_property (SCM sym)
212 mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, sym);
216 Grob::internal_get_object (SCM sym) const
218 #ifdef PROFILE_PROPERTY_ACCESSES
219 note_property_access (&grob_property_lookup_table, sym);
222 SCM s = scm_sloppy_assq (sym, object_alist_);
224 return (s == SCM_BOOL_F) ? SCM_EOL : scm_cdr (s);
228 Grob::is_live () const
230 return scm_is_pair (immutable_property_alist_);
234 Grob::internal_has_interface (SCM k)
236 return scm_c_memq (k, interfaces_) != SCM_BOOL_F;
240 call_pure_function (SCM unpure, SCM args, int start, int end)
242 SCM scm_call_pure_function = ly_lily_module_constant ("call-pure-function");
244 return scm_apply_0 (scm_call_pure_function,
245 scm_list_4 (unpure, args, scm_from_int (start), scm_from_int (end)));