2 grob-scheme.cc -- Scheme entry points for the grob datatype
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2007 Jan Nieuwenhuizen <janneke@gnu.org>
7 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "warn.hh" // error()
12 #include "output-def.hh"
14 #include "font-interface.hh"
15 #include "paper-score.hh"
16 #include "grob-array.hh"
18 LY_DEFINE (ly_grob_property_data, "ly:grob-property-data",
19 2, 0, 0, (SCM grob, SCM sym),
20 "Retrieve @var{sym} for @var{grob} but don't process callbacks.")
22 Grob *sc = unsmob_grob (grob);
24 LY_FUNC_NOTE_FIRST_ARG(grob);
25 LY_ASSERT_SMOB(Grob, 1);
27 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
29 return sc->get_property_data (sym);
32 LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!",
33 3, 0, 0, (SCM grob, SCM sym, SCM val),
34 "Set @var{sym} in grob @var{grob} to value @var{val}")
36 Grob *sc = unsmob_grob (grob);
37 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
38 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
40 if (!ly_is_procedure (val)
41 && !type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
42 error ("typecheck failed");
44 sc->set_property (sym, val);
45 return SCM_UNSPECIFIED;
48 LY_DEFINE (ly_grob_property, "ly:grob-property",
49 2, 1, 0, (SCM grob, SCM sym, SCM deflt),
50 "Return the value of a value in grob @var{g} of property @var{sym}. "
51 "It will return @code{'()} or @var{deflt} (if specified) "
52 "if @var{sym} is undefined in @var{g}."
55 Grob *sc = unsmob_grob (grob);
56 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
57 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
58 if (deflt == SCM_UNDEFINED)
61 SCM retval = sc->internal_get_property (sym);
62 if (retval == SCM_EOL)
69 LY_DEFINE (ly_grob_interfaces, "ly:grob-interfaces",
71 "Return the interfaces list of grob @var{grob}.")
73 Grob *sc = unsmob_grob (grob);
74 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
76 return sc->interfaces ();
79 LY_DEFINE (ly_grob_object, "ly:grob-object",
80 2, 0, 0, (SCM grob, SCM sym),
81 "Return the value of a pointer in grob @var{g} of property @var{sym}. "
82 "It will return @code{' ()} (end-of-list) "
83 "if @var{sym} is undefined in @var{g}."
86 Grob *sc = unsmob_grob (grob);
87 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
88 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
90 return sc->internal_get_object (sym);
95 /* TODO: make difference between scaled and unscalead variable in
96 calling (i.e different funcs.) */
97 LY_DEFINE (ly_grob_layout, "ly:grob-layout",
99 "Get @code{\\layout} definition from grob @var{g}.")
101 Grob *sc = unsmob_grob (g);
102 SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
104 return sc->layout ()->self_scm ();
107 LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
108 1, 1, 0, (SCM grob, SCM global),
109 "Get an alist chain for grob @var{grob}, with @var{global} as the "
110 "global default. If unspecified, @code{font-defaults} "
111 "from the layout block is taken. ")
113 Grob *sc = unsmob_grob (grob);
114 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
116 if (global == SCM_UNDEFINED)
118 global = sc->layout ()->lookup_variable (ly_symbol2scm ("font-defaults"));
119 if (global == SCM_UNDEFINED)
123 return sc->get_property_alist_chain (global);
126 LY_DEFINE (ly_grob_extent, "ly:grob-extent",
127 3, 0, 0, (SCM grob, SCM refp, SCM axis),
128 "Get the extent in @var{axis} direction of @var{grob} relative to "
129 "the grob @var{refp}")
131 Grob *sc = unsmob_grob (grob);
132 Grob *ref = unsmob_grob (refp);
134 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
135 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
136 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
138 Axis a = Axis (scm_to_int (axis));
141 if (ref->common_refpoint (sc, a) != ref)
143 // ugh. should use other error message
144 SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
146 return ly_interval2scm (sc->extent (ref, a));
149 LY_DEFINE (ly_grob_robust_relative_extent, "ly:grob-robust-relative-extent",
150 3, 0, 0, (SCM grob, SCM refp, SCM axis),
151 "Get the extent in @var{axis} direction of @var{grob} relative to "
152 "the grob @var{refp}, or (0,0) if empty")
154 Grob *sc = unsmob_grob (grob);
155 Grob *ref = unsmob_grob (refp);
157 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
158 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
159 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
161 Axis a = Axis (scm_to_int (axis));
163 if (ref->common_refpoint (sc, a) != ref)
165 // ugh. should use other error message
166 SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
169 return ly_interval2scm (robust_relative_extent (sc, ref, a));
172 LY_DEFINE (ly_grob_relative_coordinate, "ly:grob-relative-coordinate",
173 3, 0, 0, (SCM grob, SCM refp, SCM axis),
174 "Get the coordinate in @var{axis} direction of @var{grob} relative to "
175 "the grob @var{refp}")
177 Grob *sc = unsmob_grob (grob);
178 Grob *ref = unsmob_grob (refp);
180 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
181 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
182 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
184 Axis a = Axis (scm_to_int (axis));
187 if (ref->common_refpoint (sc, a) != ref)
189 // ugh. should use other error message
190 SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
193 return scm_from_double (sc->relative_coordinate (ref,a));
197 LY_DEFINE (ly_grob_parent, "ly:grob-parent",
198 2, 0, 0, (SCM grob, SCM axis),
199 "Get the parent of @var{grob}. @var{axis} is 0 for the X-axis, "
202 Grob *sc = unsmob_grob (grob);
203 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
204 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
206 Grob *par = sc->get_parent (Axis (scm_to_int (axis)));
207 return par ? par->self_scm () : SCM_EOL;
210 LY_DEFINE (ly_grob_properties, "ly:grob-properties",
212 "Get the mutable proprerties of @var{grob}.")
214 Grob *g = unsmob_grob (grob);
215 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
217 /* FIXME: uhg? copy/read only? */
218 return g->mutable_property_alist_;
221 LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
223 "Get the immutable properties of @var{grob}.")
225 Grob *g = unsmob_grob (grob);
226 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
228 /* FIXME: uhg? copy/read only? */
229 return g->immutable_property_alist_;
232 LY_DEFINE (ly_grob_system, "ly:grob-system",
234 "Return the System Grob of @var{g}.")
236 Grob *me = unsmob_grob (g);
237 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
239 if (System *g = me->get_system ())
240 return g->self_scm ();
245 LY_DEFINE (ly_grob_original, "ly:grob-original",
247 "Return the unbroken original Grob of @var{grob}.")
249 Grob *me = unsmob_grob (grob);
250 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
251 return me->original () ? me->original ()->self_scm () : me->self_scm ();
255 LY_DEFINE (ly_grob_suicide_x, "ly:grob-suicide!",
259 Grob *me = unsmob_grob (g);
260 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
263 return SCM_UNSPECIFIED;
266 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
267 3, 0, 0, (SCM g, SCM d, SCM a),
268 "Translate @var{g} on axis @var{a} over distance @var{d}.")
270 Grob *me = unsmob_grob (g);
271 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
272 SCM_ASSERT_TYPE (scm_is_number (d), d, SCM_ARG2, __FUNCTION__, "dimension");
273 SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
275 me->translate_axis (scm_to_double (d), Axis (scm_to_int (a)));
276 return SCM_UNSPECIFIED;
279 LY_DEFINE (ly_grob_default_font, "ly:grob-default-font",
281 "Return the default font for grob @var{gr}.")
283 Grob *gr = unsmob_grob (grob);
284 SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
286 return Font_interface::get_default_font (gr)->self_scm ();
291 TODO: consider swapping order, so we can do
293 (grob-common-refpoint a b c d e)
295 LY_DEFINE (ly_grob_common_refpoint, "ly:grob-common-refpoint",
296 3, 0, 0, (SCM grob, SCM other, SCM axis),
297 "Find the common refpoint of @var{grob} and @var{other} for @var{axis}."
301 Grob *gr = unsmob_grob (grob);
302 SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
304 Grob *o = unsmob_grob (other);
305 SCM_ASSERT_TYPE (o, other, SCM_ARG2, __FUNCTION__, "grob");
307 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
309 Grob *refp = gr->common_refpoint (o, Axis (scm_to_int (axis)));
310 return refp ? refp->self_scm () : SCM_BOOL_F;
313 LY_DEFINE (ly_grob_common_refpoint_of_array, "ly:grob-common-refpoint-of-array",
314 3, 0, 0, (SCM grob, SCM others, SCM axis),
315 "Find the common refpoint of @var{grob} and @var{others} "
316 "(a grob-array) for @var{axis}."
319 Grob *gr = unsmob_grob (grob);
320 SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
322 Grob_array *ga = unsmob_grob_array (others);
323 SCM_ASSERT_TYPE (ga, others, SCM_ARG2, __FUNCTION__, "grob array");
324 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
326 Grob *refp = common_refpoint_of_array (ga->array (), gr, Axis (scm_to_int (axis)));
327 return refp ? refp->self_scm () : SCM_BOOL_F;