2 grob-scheme.cc -- Scheme entry points for the grob datatype
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2004 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}."
38 Grob *sc = unsmob_grob (grob);
39 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
40 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
42 return sc->internal_get_property (sym);
45 LY_DEFINE (ly_spanner_get_bound, "ly:spanner-get-bound",
46 2, 0, 0, (SCM slur, SCM dir),
47 "Get one of the bounds of @var{spanner}. @var{dir} is @code{-1} "
48 "for left, and @code{1} for right.")
50 Spanner * sl = dynamic_cast<Spanner*> (unsmob_grob (slur));
51 SCM_ASSERT_TYPE (sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob");
52 SCM_ASSERT_TYPE (is_direction (dir), slur, SCM_ARG2, __FUNCTION__, "dir");
53 return sl->get_bound (to_dir (dir))->self_scm ();
56 /* TODO: make difference between scaled and unscalead variable in
57 calling (i.e different funcs.) */
58 LY_DEFINE (ly_grob_layout, "ly:grob-layout",
60 "Get @code{\\layout} definition from grob @var{g}.")
62 Grob * sc = unsmob_grob (g);
63 SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
65 return sc->get_layout ()->self_scm ();
68 LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
69 1, 1, 0, (SCM g, SCM global),
70 "Get an alist chain for grob @var{g}, with @var{global} as the "
71 "global default. If unspecified, @code{font-defaults} "
72 "from the layout block is taken. ")
74 Grob *sc = unsmob_grob (g);
75 SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
77 if (global == SCM_UNDEFINED)
79 = sc->get_layout ()->lookup_variable (ly_symbol2scm ("font-defaults"));
81 return sc->get_property_alist_chain (global);
84 LY_DEFINE (ly_get_extent, "ly:grob-extent",
85 3, 0, 0, (SCM grob, SCM refp, SCM axis),
86 "Get the extent in @var{axis} direction of @var{grob} relative to "
87 "the grob @var{refp}")
89 Grob *sc = unsmob_grob (grob);
90 Grob *ref = unsmob_grob (refp);
91 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
92 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
93 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
95 return ly_interval2scm ( sc->extent (ref, Axis (scm_to_int (axis))));
98 LY_DEFINE (ly_grob_parent, "ly:grob-parent",
99 2, 0, 0, (SCM grob, SCM axis),
100 "Get the parent of @var{grob}. @var{axis} is 0 for the X-axis, "
103 Grob *sc = unsmob_grob (grob);
104 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
105 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
107 Grob *par = sc->get_parent (Axis (scm_to_int (axis)));
108 return par ? par->self_scm () : SCM_EOL;
111 LY_DEFINE (ly_grob_properties, "ly:grob-properties",
113 "Get the mutable proprerties of @var{grob}.")
115 Grob *g = unsmob_grob (grob);
116 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
118 /* FIXME: uhg? copy/read only? */
119 return g->mutable_property_alist_;
122 LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
124 "Get the immutable properties of @var{grob}.")
126 Grob *g = unsmob_grob (grob);
127 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
129 /* FIXME: uhg? copy/read only? */
130 return g->immutable_property_alist_;
133 LY_DEFINE (ly_grob_system, "ly:grob-system",
135 "Return the System Grob of @var{g}.")
137 Grob *me = unsmob_grob (g);
138 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
140 if (System *g = me->get_system ())
141 return g->self_scm ();
146 LY_DEFINE (ly_grob_original, "ly:grob-original",
148 "Return the unbroken original Grob of @var{grob}.")
150 Grob *me = unsmob_grob (grob);
151 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
152 return me->original_ ? me->original_->self_scm () : me->self_scm ();
155 /* TODO: maybe we should return a vector -- random access is more
156 logical for this list? */
157 LY_DEFINE (ly_spanner_broken_into, "ly:spanner-broken-into",
158 1, 0, 0, (SCM spanner),
159 "Return broken-into list for @var{spanner}.")
161 Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (spanner));
162 SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
165 for (int i = me->broken_intos_.size (); i--;)
166 s = scm_cons (me->broken_intos_[i]->self_scm (), s);
170 LY_DEFINE (ly_grob_suicide, "ly:grob-suicide",
174 Grob *me = unsmob_grob (g);
175 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
178 return SCM_UNSPECIFIED;
181 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
182 3, 0, 0, (SCM g, SCM d, SCM a),
183 "Translate @var{g} on axis @var{a} over distance @var{d}.")
185 Grob *me = unsmob_grob (g);
186 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
187 SCM_ASSERT_TYPE (scm_is_number (d), d, SCM_ARG2, __FUNCTION__, "dimension");
188 SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
190 me->translate_axis (scm_to_double (d), Axis (scm_to_int (a)));
191 return SCM_UNSPECIFIED;
194 LY_DEFINE (ly_spanner_p, "ly:spanner?",
196 "Is @var{g} a spanner object?")
198 Grob *me = unsmob_grob (g);
199 bool b = dynamic_cast<Spanner*> (me);
201 return ly_bool2scm (b);
204 LY_DEFINE (ly_item_p, "ly:item?",
206 "Is @var{g} an @code{Item} object?")
208 Grob *me = unsmob_grob (g);
209 bool b = dynamic_cast<Item*> (me);
210 return ly_bool2scm (b);
213 LY_DEFINE (ly_item_break_dir, "ly:item-break-dir",
215 "The break status dir of item @var{it}. @code{-1} is end of "
216 "line, @code{0} unbroken, and @code{1} begin of line.")
218 Item *me = dynamic_cast<Item*> (unsmob_grob (it));
219 SCM_ASSERT_TYPE (me, it, SCM_ARG1, __FUNCTION__, "Item");
220 return scm_int2num (me->break_status_dir ());
224 LY_DEFINE(ly_grob_key, "ly:grob-key",
227 "Return the object-key for @var{grob}."
230 Grob *me = unsmob_grob (grob);
231 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "Grob");
232 return me->get_key ()->self_scm ();