2 grob-scheme.cc -- Scheme entry points for the grob datatype
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
7 Han-Wen Nienhuys <hanwen@xs4all.nl>
12 #include "warn.hh" // error()
14 #include "output-def.hh"
16 #include "font-interface.hh"
17 #include "paper-score.hh"
20 LY_DEFINE (ly_grob_property_data, "ly:grob-property-data",
21 2, 0, 0, (SCM grob, SCM sym),
23 "Retrieve @var{sym} for @var{grob} but don't process callbacks.")
25 Grob *sc = unsmob_grob (grob);
26 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
27 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
28 // SCM_ASSERT_TYPE (ly_is_procedure (proc), proc, SCM_ARG3, __FUNCTION__, "procedure");
30 return sc->get_property_data (sym);
33 LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!",
34 3, 0, 0, (SCM grob, SCM sym, SCM val),
35 "Set @var{sym} in grob @var{grob} to value @var{val}")
37 Grob *sc = unsmob_grob (grob);
38 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
39 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
41 if (!ly_is_procedure (val)
42 && !type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
43 error ("typecheck failed");
45 sc->set_property (sym, val);
46 return SCM_UNSPECIFIED;
49 LY_DEFINE (ly_grob_property, "ly:grob-property",
50 2, 1, 0, (SCM grob, SCM sym, SCM deflt),
51 "Return the value of a value in grob @var{g} of property @var{sym}. "
52 "It will return @code{'()} or @var{deflt} (if specified) "
53 "if @var{sym} is undefined in @var{g}."
56 Grob *sc = unsmob_grob (grob);
57 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
58 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
59 if (deflt == SCM_UNDEFINED)
62 SCM retval = sc->internal_get_property (sym);
63 if (retval == SCM_EOL)
70 LY_DEFINE (ly_grob_interfaces, "ly:grob-interfaces",
72 "Return the interfaces list of grob @var{grob}.")
74 Grob *sc = unsmob_grob (grob);
75 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
77 return sc->interfaces ();
80 LY_DEFINE (ly_grob_object, "ly:grob-object",
81 2, 0, 0, (SCM grob, SCM sym),
82 "Return the value of a pointer in grob @var{g} of property @var{sym}. "
83 "It will return @code{' ()} (end-of-list) "
84 "if @var{sym} is undefined in @var{g}."
87 Grob *sc = unsmob_grob (grob);
88 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
89 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
91 return sc->internal_get_object (sym);
94 LY_DEFINE (ly_spanner_get_bound, "ly:spanner-bound",
95 2, 0, 0, (SCM slur, SCM dir),
96 "Get one of the bounds of @var{spanner}. @var{dir} is @code{-1} "
97 "for left, and @code{1} for right.")
99 Spanner *sl = dynamic_cast<Spanner *> (unsmob_grob (slur));
100 SCM_ASSERT_TYPE (sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob");
101 SCM_ASSERT_TYPE (is_direction (dir), slur, SCM_ARG2, __FUNCTION__, "dir");
102 return sl->get_bound (to_dir (dir))->self_scm ();
105 /* TODO: make difference between scaled and unscalead variable in
106 calling (i.e different funcs.) */
107 LY_DEFINE (ly_grob_layout, "ly:grob-layout",
109 "Get @code{\\layout} definition from grob @var{g}.")
111 Grob *sc = unsmob_grob (g);
112 SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
114 return sc->layout ()->self_scm ();
117 LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
118 1, 1, 0, (SCM grob, SCM global),
119 "Get an alist chain for grob @var{grob}, with @var{global} as the "
120 "global default. If unspecified, @code{font-defaults} "
121 "from the layout block is taken. ")
123 Grob *sc = unsmob_grob (grob);
124 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
126 if (global == SCM_UNDEFINED)
128 global = sc->layout ()->lookup_variable (ly_symbol2scm ("font-defaults"));
129 if (global == SCM_UNDEFINED)
133 return sc->get_property_alist_chain (global);
136 LY_DEFINE (ly_get_extent, "ly:grob-extent",
137 3, 0, 0, (SCM grob, SCM refp, SCM axis),
138 "Get the extent in @var{axis} direction of @var{grob} relative to "
139 "the grob @var{refp}")
141 Grob *sc = unsmob_grob (grob);
142 Grob *ref = unsmob_grob (refp);
144 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
145 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
146 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
148 Axis a = Axis (scm_to_int (axis));
151 if (ref->common_refpoint (sc, a) != ref)
153 // ugh. should use other error message
154 SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
156 return ly_interval2scm (sc->extent (ref, a));
159 LY_DEFINE (ly_grob_robust_relative_extent, "ly:grob-robust-relative-extent",
160 3, 0, 0, (SCM grob, SCM refp, SCM axis),
161 "Get the extent in @var{axis} direction of @var{grob} relative to "
162 "the grob @var{refp}, or (0,0) if empty")
164 Grob *sc = unsmob_grob (grob);
165 Grob *ref = unsmob_grob (refp);
167 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
168 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
169 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
171 Axis a = Axis (scm_to_int (axis));
173 if (ref->common_refpoint (sc, a) != ref)
175 // ugh. should use other error message
176 SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
179 return ly_interval2scm (robust_relative_extent (sc, ref, a));
182 LY_DEFINE (ly_grob_relative_coordinate, "ly:grob-relative-coordinate",
183 3, 0, 0, (SCM grob, SCM refp, SCM axis),
184 "Get the coordinate in @var{axis} direction of @var{grob} relative to "
185 "the grob @var{refp}")
187 Grob *sc = unsmob_grob (grob);
188 Grob *ref = unsmob_grob (refp);
190 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
191 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
192 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
194 Axis a = Axis (scm_to_int (axis));
197 if (ref->common_refpoint (sc, a) != ref)
199 // ugh. should use other error message
200 SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
203 return scm_from_double (sc->relative_coordinate (ref,a));
207 LY_DEFINE (ly_grob_parent, "ly:grob-parent",
208 2, 0, 0, (SCM grob, SCM axis),
209 "Get the parent of @var{grob}. @var{axis} is 0 for the X-axis, "
212 Grob *sc = unsmob_grob (grob);
213 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
214 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
216 Grob *par = sc->get_parent (Axis (scm_to_int (axis)));
217 return par ? par->self_scm () : SCM_EOL;
220 LY_DEFINE (ly_grob_properties, "ly:grob-properties",
222 "Get the mutable proprerties of @var{grob}.")
224 Grob *g = unsmob_grob (grob);
225 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
227 /* FIXME: uhg? copy/read only? */
228 return g->mutable_property_alist_;
231 LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
233 "Get the immutable properties of @var{grob}.")
235 Grob *g = unsmob_grob (grob);
236 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
238 /* FIXME: uhg? copy/read only? */
239 return g->immutable_property_alist_;
242 LY_DEFINE (ly_grob_system, "ly:grob-system",
244 "Return the System Grob of @var{g}.")
246 Grob *me = unsmob_grob (g);
247 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
249 if (System *g = me->get_system ())
250 return g->self_scm ();
255 LY_DEFINE (ly_grob_original, "ly:grob-original",
257 "Return the unbroken original Grob of @var{grob}.")
259 Grob *me = unsmob_grob (grob);
260 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
261 return me->original () ? me->original ()->self_scm () : me->self_scm ();
264 /* TODO: maybe we should return a vector -- random access is more
265 logical for this list? */
266 LY_DEFINE (ly_spanner_broken_into, "ly:spanner-broken-into",
267 1, 0, 0, (SCM spanner),
268 "Return broken-into list for @var{spanner}.")
270 Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (spanner));
271 SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
274 for (vsize i = me->broken_intos_.size (); i--;)
275 s = scm_cons (me->broken_intos_[i]->self_scm (), s);
279 LY_DEFINE (ly_grob_suicide_x, "ly:grob-suicide!",
283 Grob *me = unsmob_grob (g);
284 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
287 return SCM_UNSPECIFIED;
290 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
291 3, 0, 0, (SCM g, SCM d, SCM a),
292 "Translate @var{g} on axis @var{a} over distance @var{d}.")
294 Grob *me = unsmob_grob (g);
295 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
296 SCM_ASSERT_TYPE (scm_is_number (d), d, SCM_ARG2, __FUNCTION__, "dimension");
297 SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
299 me->translate_axis (scm_to_double (d), Axis (scm_to_int (a)));
300 return SCM_UNSPECIFIED;
303 LY_DEFINE (ly_spanner_p, "ly:spanner?",
305 "Is @var{g} a spanner object?")
307 Grob *me = unsmob_grob (g);
308 bool b = dynamic_cast<Spanner *> (me);
310 return ly_bool2scm (b);
313 LY_DEFINE (ly_grob_key, "ly:grob-key",
316 "Return the object-key for @var{grob}.")
318 Grob *me = unsmob_grob (grob);
319 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "Grob");
321 return me->key () ? me->key ()->self_scm () : SCM_EOL;
324 LY_DEFINE (ly_grob_default_font, "ly:grob-default-font",
326 "Return the default font for grob @var{gr}.")
328 Grob *gr = unsmob_grob (grob);
329 SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
331 return Font_interface::get_default_font (gr)->self_scm ();
336 TODO: consider swapping order, so we can do
338 (grob-common-refpoint a b c d e)
340 LY_DEFINE (ly_grob_common_refpoint, "ly:grob-common-refpoint",
341 3, 0, 0, (SCM grob, SCM other, SCM axis),
342 "Find the common refpoint of @var{grob} and @var{other} for @var{axis}."
346 Grob *gr = unsmob_grob (grob);
347 SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
349 Grob *o = unsmob_grob (other);
350 SCM_ASSERT_TYPE (o, other, SCM_ARG2, __FUNCTION__, "grob");
352 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
354 Grob *refp = gr->common_refpoint (o, Axis (scm_to_int (axis)));
355 return refp ? refp->self_scm () : SCM_BOOL_F;
358 LY_DEFINE (ly_grob_common_refpoint_of_array, "ly:grob-common-refpoint-of-array",
359 3, 0, 0, (SCM grob, SCM others, SCM axis),
360 "Find the common refpoint of @var{grob} and @var{others} "
361 "(a grob-array) for @var{axis}."
364 Grob *gr = unsmob_grob (grob);
365 SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
367 Grob_array *ga = unsmob_grob_array (others);
368 SCM_ASSERT_TYPE (ga, others, SCM_ARG2, __FUNCTION__, "grob array");
369 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
371 Grob *refp = common_refpoint_of_array (ga->array (), gr, Axis (scm_to_int (axis)));
372 return refp ? refp->self_scm () : SCM_BOOL_F;