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>
14 #include "output-def.hh"
18 LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!",
19 3, 0, 0, (SCM grob, SCM sym, SCM val),
20 "Set @var{sym} in grob @var{grob} to value @var{val}")
22 Grob *sc = unsmob_grob (grob);
23 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
24 SCM_ASSERT_TYPE (ly_c_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
26 if (!type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
27 error ("typecheck failed");
29 sc->internal_set_property (sym, val);
30 return SCM_UNSPECIFIED;
33 LY_DEFINE (ly_grob_property, "ly:grob-property",
34 2, 0, 0, (SCM grob, SCM sym),
35 "Return the value of a value in grob @var{g} of property @var{sym}. "
36 "It will return @code{' ()} (end-of-list) "
37 "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 (ly_c_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
45 return sc->internal_get_property (sym);
48 LY_DEFINE (ly_spanner_get_bound, "ly:spanner-get-bound",
49 2, 0, 0, (SCM slur, SCM dir),
50 "Get one of the bounds of @var{spanner}. @var{dir} is @code{-1} "
51 "for left, and @code{1} for right.")
53 Spanner * sl = dynamic_cast<Spanner*> (unsmob_grob (slur));
54 SCM_ASSERT_TYPE (sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob");
55 SCM_ASSERT_TYPE (is_direction (dir), slur, SCM_ARG2, __FUNCTION__, "dir");
56 return sl->get_bound (to_dir (dir))->self_scm ();
59 /* TODO: make difference between scaled and unscalead variable in
60 calling (i.e different funcs.) */
61 LY_DEFINE (ly_grob_paper, "ly:grob-paper",
63 "Get @code{\\paper} definition from grob @var{g}.")
65 Grob * sc = unsmob_grob (g);
66 SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
68 return sc->get_paper ()->self_scm ();
71 LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
72 1, 1, 0, (SCM g, SCM global),
73 "Get an alist chain for grob @var{g}, with @var{global} as the "
74 "global default. If unspecified, @code{font-defaults} "
75 "from the paper block is taken. ")
77 Grob *sc = unsmob_grob (g);
78 SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
80 if (global == SCM_UNDEFINED)
82 = sc->get_paper ()->lookup_variable (ly_symbol2scm ("font-defaults"));
84 return sc->get_property_alist_chain (global);
87 LY_DEFINE (ly_get_extent, "ly:grob-extent",
88 3, 0, 0, (SCM grob, SCM refp, SCM axis),
89 "Get the extent in @var{axis} direction of @var{grob} relative to "
90 "the grob @var{refp}")
92 Grob *sc = unsmob_grob (grob);
93 Grob *ref = unsmob_grob (refp);
94 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
95 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
96 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
98 return ly_interval2scm ( sc->extent (ref, Axis (ly_scm2int (axis))));
101 LY_DEFINE (ly_grob_parent, "ly:grob-parent",
102 2, 0, 0, (SCM grob, SCM axis),
103 "Get the parent of @var{grob}. @var{axis} is 0 for the X-axis, "
106 Grob *sc = unsmob_grob (grob);
107 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
108 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
110 Grob *par = sc->get_parent (Axis (ly_scm2int (axis)));
111 return par ? par->self_scm () : SCM_EOL;
114 LY_DEFINE (ly_grob_properties, "ly:grob-properties",
116 "Get the mutable proprerties of @var{grob}.")
118 Grob *g = unsmob_grob (grob);
119 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
121 /* FIXME: uhg? copy/read only? */
122 return g->mutable_property_alist_;
125 LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
127 "Get the immutable properties of @var{grob}.")
129 Grob *g = unsmob_grob (grob);
130 SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
132 /* FIXME: uhg? copy/read only? */
133 return g->immutable_property_alist_;
136 LY_DEFINE (ly_grob_system, "ly:grob-system",
138 "Return the System Grob of @var{g}.")
140 Grob *me = unsmob_grob (g);
141 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
143 if (System *g = me->get_system ())
144 return g->self_scm ();
149 LY_DEFINE (ly_grob_original, "ly:grob-original",
151 "Return the unbroken original Grob of @var{grob}.")
153 Grob *me = unsmob_grob (grob);
154 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
155 return me->original_ ? me->original_->self_scm () : me->self_scm ();
158 /* TODO: maybe we should return a vector -- random access is more
159 logical for this list? */
160 LY_DEFINE (ly_spanner_broken_into, "ly:spanner-broken-into",
161 1, 0, 0, (SCM spanner),
162 "Return broken-into list for @var{spanner}.")
164 Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (spanner));
165 SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
168 for (int i = me->broken_intos_.size (); i--;)
169 s = scm_cons (me->broken_intos_[i]->self_scm (), s);
173 LY_DEFINE (ly_grob_suicide, "ly:grob-suicide",
177 Grob *me = unsmob_grob (g);
178 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
181 return SCM_UNSPECIFIED;
184 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
185 3, 0, 0, (SCM g, SCM d, SCM a),
186 "Translate @var{g} on axis @var{a} over distance @var{d}.")
188 Grob *me = unsmob_grob (g);
189 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
190 SCM_ASSERT_TYPE (ly_c_number_p (d), d, SCM_ARG2, __FUNCTION__, "dimension");
191 SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
193 me->translate_axis (ly_scm2double (d), Axis (ly_scm2int (a)));
194 return SCM_UNSPECIFIED;
197 LY_DEFINE (ly_spanner_p, "ly:spanner?",
199 "Is @var{g} a spanner object?")
201 Grob *me = unsmob_grob (g);
202 bool b = dynamic_cast<Spanner*> (me);
204 return ly_bool2scm (b);
207 LY_DEFINE (ly_item_p, "ly:item?",
209 "Is @var{g} an @code{Item} object?")
211 Grob *me = unsmob_grob (g);
212 bool b = dynamic_cast<Item*> (me);
213 return ly_bool2scm (b);
216 LY_DEFINE (ly_item_break_dir, "ly:item-break-dir",
218 "The break status dir of item @var{it}. @code{-1} is end of "
219 "line, @code{0} unbroken, and @code{1} begin of line.")
221 Item *me = dynamic_cast<Item*> (unsmob_grob (it));
222 SCM_ASSERT_TYPE (me, it, SCM_ARG1, __FUNCTION__, "Item");
223 return scm_int2num (me->break_status_dir ());