2 grob-scheme.cc -- Scheme entry points for the grob datatype
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2005 Jan Nieuwenhuizen <janneke@gnu.org>
7 Han-Wen Nienhuys <hanwen@cs.uu.nl>
14 #include "output-def.hh"
16 #include "font-interface.hh"
19 LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!",
20 3, 0, 0, (SCM grob, SCM sym, SCM val),
21 "Set @var{sym} in grob @var{grob} to value @var{val}")
23 Grob *sc = unsmob_grob (grob);
24 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
25 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
27 if (!type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
28 error ("typecheck failed");
30 sc->internal_set_property (sym, val);
31 return SCM_UNSPECIFIED;
34 LY_DEFINE (ly_grob_property, "ly:grob-property",
35 2, 0, 0, (SCM grob, SCM sym),
36 "Return the value of a value in grob @var{g} of property @var{sym}. "
37 "It will return @code{' ()} (end-of-list) "
38 "if @var{sym} is undefined in @var{g}."
41 Grob *sc = unsmob_grob (grob);
42 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
43 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
45 return sc->internal_get_property (sym);
48 LY_DEFINE (ly_grob_object, "ly:grob-object",
49 2, 0, 0, (SCM grob, SCM sym),
50 "Return the value of a pointer in grob @var{g} of property @var{sym}. "
51 "It will return @code{' ()} (end-of-list) "
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");
59 return sc->internal_get_object (sym);
63 LY_DEFINE (ly_spanner_get_bound, "ly:spanner-get-bound",
64 2, 0, 0, (SCM slur, SCM dir),
65 "Get one of the bounds of @var{spanner}. @var{dir} is @code{-1} "
66 "for left, and @code{1} for right.")
68 Spanner *sl = dynamic_cast<Spanner *> (unsmob_grob (slur));
69 SCM_ASSERT_TYPE (sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob");
70 SCM_ASSERT_TYPE (is_direction (dir), slur, SCM_ARG2, __FUNCTION__, "dir");
71 return sl->get_bound (to_dir (dir))->self_scm ();
74 /* TODO: make difference between scaled and unscalead variable in
75 calling (i.e different funcs.) */
76 LY_DEFINE (ly_grob_layout, "ly:grob-layout",
78 "Get @code{\\layout} definition from grob @var{g}.")
80 Grob *sc = unsmob_grob (g);
81 SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
83 return sc->get_layout ()->self_scm ();
86 LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
87 1, 1, 0, (SCM grob, SCM global),
88 "Get an alist chain for grob @var{grob}, with @var{global} as the "
89 "global default. If unspecified, @code{font-defaults} "
90 "from the layout block is taken. ")
92 Grob *sc = unsmob_grob (grob);
93 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
95 if (global == SCM_UNDEFINED)
97 global = sc->get_layout ()->lookup_variable (ly_symbol2scm ("font-defaults"));
98 if (global == SCM_UNDEFINED)
102 return sc->get_property_alist_chain (global);
105 LY_DEFINE (ly_get_extent, "ly:grob-extent",
106 3, 0, 0, (SCM grob, SCM refp, SCM axis),
107 "Get the extent in @var{axis} direction of @var{grob} relative to "
108 "the grob @var{refp}")
110 Grob *sc = unsmob_grob (grob);
111 Grob *ref = unsmob_grob (refp);
112 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
113 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
114 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
116 return ly_interval2scm (sc->extent (ref, Axis (scm_to_int (axis))));
119 LY_DEFINE (ly_grob_parent, "ly:grob-parent",
120 2, 0, 0, (SCM grob, SCM axis),
121 "Get the parent of @var{grob}. @var{axis} is 0 for the X-axis, "
124 Grob *sc = unsmob_grob (grob);
125 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
126 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
128 Grob *par = sc->get_parent (Axis (scm_to_int (axis)));
129 return par ? par->self_scm () : SCM_EOL;
132 LY_DEFINE (ly_grob_properties, "ly:grob-properties",
134 "Get the mutable proprerties of @var{grob}.")
136 Grob *g = unsmob_grob (grob);
137 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
139 /* FIXME: uhg? copy/read only? */
140 return g->mutable_property_alist_;
143 LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
145 "Get the immutable properties of @var{grob}.")
147 Grob *g = unsmob_grob (grob);
148 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
150 /* FIXME: uhg? copy/read only? */
151 return g->immutable_property_alist_;
154 LY_DEFINE (ly_grob_system, "ly:grob-system",
156 "Return the System Grob of @var{g}.")
158 Grob *me = unsmob_grob (g);
159 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
161 if (System *g = me->get_system ())
162 return g->self_scm ();
167 LY_DEFINE (ly_grob_original, "ly:grob-original",
169 "Return the unbroken original Grob of @var{grob}.")
171 Grob *me = unsmob_grob (grob);
172 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
173 return me->original_ ? me->original_->self_scm () : me->self_scm ();
176 /* TODO: maybe we should return a vector -- random access is more
177 logical for this list? */
178 LY_DEFINE (ly_spanner_broken_into, "ly:spanner-broken-into",
179 1, 0, 0, (SCM spanner),
180 "Return broken-into list for @var{spanner}.")
182 Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (spanner));
183 SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
186 for (int i = me->broken_intos_.size (); i--;)
187 s = scm_cons (me->broken_intos_[i]->self_scm (), s);
191 LY_DEFINE (ly_grob_suicide, "ly:grob-suicide",
195 Grob *me = unsmob_grob (g);
196 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
199 return SCM_UNSPECIFIED;
202 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
203 3, 0, 0, (SCM g, SCM d, SCM a),
204 "Translate @var{g} on axis @var{a} over distance @var{d}.")
206 Grob *me = unsmob_grob (g);
207 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
208 SCM_ASSERT_TYPE (scm_is_number (d), d, SCM_ARG2, __FUNCTION__, "dimension");
209 SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
211 me->translate_axis (scm_to_double (d), Axis (scm_to_int (a)));
212 return SCM_UNSPECIFIED;
215 LY_DEFINE (ly_spanner_p, "ly:spanner?",
217 "Is @var{g} a spanner object?")
219 Grob *me = unsmob_grob (g);
220 bool b = dynamic_cast<Spanner *> (me);
222 return ly_bool2scm (b);
225 LY_DEFINE (ly_item_p, "ly:item?",
227 "Is @var{g} an @code{Item} object?")
229 Grob *me = unsmob_grob (g);
230 bool b = dynamic_cast<Item *> (me);
231 return ly_bool2scm (b);
234 LY_DEFINE (ly_item_break_dir, "ly:item-break-dir",
236 "The break status dir of item @var{it}. @code{-1} is end of "
237 "line, @code{0} unbroken, and @code{1} begin of line.")
239 Item *me = dynamic_cast<Item *> (unsmob_grob (it));
240 SCM_ASSERT_TYPE (me, it, SCM_ARG1, __FUNCTION__, "Item");
241 return scm_from_int (me->break_status_dir ());
244 LY_DEFINE (ly_grob_key, "ly:grob-key",
247 "Return the object-key for @var{grob}.")
249 Grob *me = unsmob_grob (grob);
250 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "Grob");
251 return me->get_key ()->self_scm ();
256 LY_DEFINE (ly_grob_default_font, "ly:grob-default-font",
258 "Return the default font for grob @var{gr}.")
260 Grob *gr = unsmob_grob (grob);
261 SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
263 return Font_interface::get_default_font (gr)->self_scm ();