5 #include "paper-def.hh"
9 LY_DEFINE (ly_set_grob_property,"ly:set-grob-property!", 3, 0, 0,
10 (SCM grob, SCM sym, SCM val),
11 "Set @var{sym} in grob @var{grob} to value @var{val}")
13 Grob * sc = unsmob_grob (grob);
14 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
15 SCM_ASSERT_TYPE (gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
17 if (!type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
18 error ("typecheck failed");
20 sc->internal_set_grob_property (sym, val);
21 return SCM_UNSPECIFIED;
24 LY_DEFINE (ly_get_grob_property,
25 "ly:get-grob-property", 2, 0, 0, (SCM grob, SCM sym),
26 "Get the value of a value in grob @var{g} of property @var{sym}. It\n"
27 "will return @code{'()} (end-of-list) if @var{g} doesn't have @var{sym} set.\n"
29 "Grob properties are stored as GUILE association lists, with symbols as\n"
30 "keys. All lookup functions identify undefined properties with\n"
31 "end-of-list (i.e. @code{'()} in Scheme or @code{SCM_EOL} in C)\n"
34 Grob * sc = unsmob_grob (grob);
35 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
36 SCM_ASSERT_TYPE (gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
38 return sc->internal_get_grob_property (sym);
41 LY_DEFINE (spanner_get_bound, "ly:spanner-get-bound", 2 , 0, 0,
43 "Get one of the bounds of @var{spanner}. @var{dir} is @code{-1} "
44 "for left, and @code{1} for right.")
46 Spanner * sl = dynamic_cast<Spanner*> (unsmob_grob (slur));
47 SCM_ASSERT_TYPE (sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob");
48 SCM_ASSERT_TYPE (is_direction (dir), slur, SCM_ARG2, __FUNCTION__, "dir");
49 return sl->get_bound (to_dir (dir))->self_scm ();
52 /* TODO: make difference between scaled and unscalead variable in
53 calling (i.e different funcs.) */
54 LY_DEFINE (ly_grob_paper,"ly:grob-paper", 1, 0, 0,
56 "Get \\paper definition from a grob.")
58 Grob * sc = unsmob_grob (grob);
59 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
61 return sc->get_paper ()->self_scm ();
67 LY_DEFINE (ly_get_extent, "ly:grob-extent", 3, 0, 0,
68 (SCM grob, SCM refp, SCM axis),
69 "Get the extent in @var{axis} direction of @var{grob} relative to "
70 "the grob @var{refp}")
72 Grob * sc = unsmob_grob (grob);
73 Grob * ref = unsmob_grob (refp);
74 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
75 SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
77 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
79 return ly_interval2scm ( sc->extent (ref, Axis (gh_scm2int (axis))));
82 LY_DEFINE (ly_get_parent, "ly:grob-parent", 2, 0, 0, (SCM grob, SCM axis),
83 "Get the parent of @var{grob}. @var{axis} is 0 for the X-axis, "
86 Grob * sc = unsmob_grob (grob);
87 SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
88 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
90 Grob * par = sc->get_parent (Axis (gh_scm2int (axis)));
91 return par ? par->self_scm () : SCM_EOL;
94 LY_DEFINE (ly_get_system,
97 "Return the System Grob of @var{grob}.")
99 Grob *me = unsmob_grob (grob);
100 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
102 if (System *g = me->get_system ())
103 return g->self_scm ();
108 LY_DEFINE (ly_get_original,
111 "Return the unbroken original Grob of @var{grob}.")
113 Grob *me = unsmob_grob (grob);
114 SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
115 return me->original_ ? me->original_->self_scm () : me->self_scm ();
119 /* ly prefix? spanner in name? */
120 /* TODO: maybe we should return a vector -- random access is more
121 logical for this list? */
123 LY_DEFINE (get_broken_into,
124 "ly:spanner-broken-into", 1, 0, 0, (SCM spanner),
125 "Return broken-into list for @var{spanner}.")
127 /// Spanner *me = unsmob_spanner (spanner);
128 Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (spanner));
129 SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
132 for (int i = me->broken_intos_.size (); i; i--)
133 s = gh_cons (me->broken_intos_[i-1]->self_scm (), s);
138 LY_DEFINE (ly_grob_suicide,
139 "ly:grob-suicide", 1, 0, 0, (SCM g),
142 Grob *me = unsmob_grob (g);
143 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
146 return SCM_UNDEFINED;
151 LY_DEFINE (ly_grob_translate_axis_x,
152 "ly:grob-translate-axis!", 3, 0, 0,
153 (SCM g, SCM d, SCM a),
154 "Translate @var{g} on axis @var{a} over distance @var{d}.")
156 Grob *me = unsmob_grob (g);
157 SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
158 SCM_ASSERT_TYPE (gh_number_p (d), d, SCM_ARG2, __FUNCTION__, "dimension");
159 SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
161 me->translate_axis (gh_scm2double (d),
162 Axis (gh_scm2int (a)));
163 return SCM_UNDEFINED;
168 LY_DEFINE (ly_spanner_p,
169 "ly:spanner?", 1, 0, 0,
171 "Is @var{g} a spanner object?")
173 Grob *me = unsmob_grob (g);
174 bool b = dynamic_cast<Spanner*> (me);
176 return gh_bool2scm (b);
179 LY_DEFINE (ly_item_p,
182 "Is @var{g} a item object?")
184 Grob *me = unsmob_grob (g);
185 bool b = dynamic_cast<Item*> (me);
187 return gh_bool2scm (b);
191 LY_DEFINE (ly_item_break_dir,
192 "ly:item-break-dir", 1, 0, 0,
194 "The break status dir of @var{it}.")
196 Item * me = dynamic_cast<Item*> ( unsmob_grob (it));
197 SCM_ASSERT_TYPE (me, it, SCM_ARG1, __FUNCTION__, "Item");
199 return gh_int2scm (me->break_status_dir ());