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>
12 #include "output-def.hh"
15 LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!",
16 3, 0, 0, (SCM grob, SCM sym, SCM val),
17 "Set @var{sym} in grob @var{grob} to value @var{val}")
19 Grob *sc = unsmob_grob (grob);
20 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
21 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
23 if (!type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
24 error ("typecheck failed");
26 sc->internal_set_property (sym, val);
27 return SCM_UNSPECIFIED;
30 LY_DEFINE (ly_grob_property, "ly:grob-property",
31 2, 0, 0, (SCM grob, SCM sym),
32 "Return the value of a value in grob @var{g} of property @var{sym}. "
33 "It will return @code{' ()} (end-of-list) "
34 "if @var{sym} is undefined in @var{g}."
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 return sc->internal_get_property (sym);
44 LY_DEFINE (ly_spanner_get_bound, "ly:spanner-get-bound",
45 2, 0, 0, (SCM slur, SCM dir),
46 "Get one of the bounds of @var{spanner}. @var{dir} is @code{-1} "
47 "for left, and @code{1} for right.")
49 Spanner *sl = dynamic_cast<Spanner *> (unsmob_grob (slur));
50 SCM_ASSERT_TYPE (sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob");
51 SCM_ASSERT_TYPE (is_direction (dir), slur, SCM_ARG2, __FUNCTION__, "dir");
52 return sl->get_bound (to_dir (dir))->self_scm ();
55 /* TODO: make difference between scaled and unscalead variable in
56 calling (i.e different funcs.) */
57 LY_DEFINE (ly_grob_layout, "ly:grob-layout",
59 "Get @code{\\layout} definition from grob @var{g}.")
61 Grob *sc = unsmob_grob (g);
62 SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
64 return sc->get_layout ()->self_scm ();
67 LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
68 1, 1, 0, (SCM grob, SCM global),
69 "Get an alist chain for grob @var{grob}, with @var{global} as the "
70 "global default. If unspecified, @code{font-defaults} "
71 "from the layout block is taken. ")
73 Grob *sc = unsmob_grob (grob);
74 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
76 if (global == SCM_UNDEFINED)
78 = sc->get_layout ()->lookup_variable (ly_symbol2scm ("font-defaults"));
80 return sc->get_property_alist_chain (global);
83 LY_DEFINE (ly_get_extent, "ly:grob-extent",
84 3, 0, 0, (SCM grob, SCM refp, SCM axis),
85 "Get the extent in @var{axis} direction of @var{grob} relative to "
86 "the grob @var{refp}")
88 Grob *sc = unsmob_grob (grob);
89 Grob *ref = unsmob_grob (refp);
90 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
91 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
92 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
94 return ly_interval2scm (sc->extent (ref, Axis (scm_to_int (axis))));
97 LY_DEFINE (ly_grob_parent, "ly:grob-parent",
98 2, 0, 0, (SCM grob, SCM axis),
99 "Get the parent of @var{grob}. @var{axis} is 0 for the X-axis, "
102 Grob *sc = unsmob_grob (grob);
103 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
104 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
106 Grob *par = sc->get_parent (Axis (scm_to_int (axis)));
107 return par ? par->self_scm () : SCM_EOL;
110 LY_DEFINE (ly_grob_properties, "ly:grob-properties",
112 "Get the mutable proprerties of @var{grob}.")
114 Grob *g = unsmob_grob (grob);
115 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
117 /* FIXME: uhg? copy/read only? */
118 return g->mutable_property_alist_;
121 LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
123 "Get the immutable properties of @var{grob}.")
125 Grob *g = unsmob_grob (grob);
126 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
128 /* FIXME: uhg? copy/read only? */
129 return g->immutable_property_alist_;
132 LY_DEFINE (ly_grob_system, "ly:grob-system",
134 "Return the System Grob of @var{g}.")
136 Grob *me = unsmob_grob (g);
137 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
139 if (System *g = me->get_system ())
140 return g->self_scm ();
145 LY_DEFINE (ly_grob_original, "ly:grob-original",
147 "Return the unbroken original Grob of @var{grob}.")
149 Grob *me = unsmob_grob (grob);
150 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
151 return me->original_ ? me->original_->self_scm () : me->self_scm ();
154 /* TODO: maybe we should return a vector -- random access is more
155 logical for this list? */
156 LY_DEFINE (ly_spanner_broken_into, "ly:spanner-broken-into",
157 1, 0, 0, (SCM spanner),
158 "Return broken-into list for @var{spanner}.")
160 Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (spanner));
161 SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
164 for (int i = me->broken_intos_.size (); i--;)
165 s = scm_cons (me->broken_intos_[i]->self_scm (), s);
169 LY_DEFINE (ly_grob_suicide, "ly:grob-suicide",
173 Grob *me = unsmob_grob (g);
174 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
177 return SCM_UNSPECIFIED;
180 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
181 3, 0, 0, (SCM g, SCM d, SCM a),
182 "Translate @var{g} on axis @var{a} over distance @var{d}.")
184 Grob *me = unsmob_grob (g);
185 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
186 SCM_ASSERT_TYPE (scm_is_number (d), d, SCM_ARG2, __FUNCTION__, "dimension");
187 SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
189 me->translate_axis (scm_to_double (d), Axis (scm_to_int (a)));
190 return SCM_UNSPECIFIED;
193 LY_DEFINE (ly_spanner_p, "ly:spanner?",
195 "Is @var{g} a spanner object?")
197 Grob *me = unsmob_grob (g);
198 bool b = dynamic_cast<Spanner *> (me);
200 return ly_bool2scm (b);
203 LY_DEFINE (ly_item_p, "ly:item?",
205 "Is @var{g} an @code{Item} object?")
207 Grob *me = unsmob_grob (g);
208 bool b = dynamic_cast<Item *> (me);
209 return ly_bool2scm (b);
212 LY_DEFINE (ly_item_break_dir, "ly:item-break-dir",
214 "The break status dir of item @var{it}. @code{-1} is end of "
215 "line, @code{0} unbroken, and @code{1} begin of line.")
217 Item *me = dynamic_cast<Item *> (unsmob_grob (it));
218 SCM_ASSERT_TYPE (me, it, SCM_ARG1, __FUNCTION__, "Item");
219 return scm_int2num (me->break_status_dir ());
222 LY_DEFINE (ly_grob_key, "ly:grob-key",
225 "Return the object-key for @var{grob}.")
227 Grob *me = unsmob_grob (grob);
228 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "Grob");
229 return me->get_key ()->self_scm ();