2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
5 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 LilyPond is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 LilyPond is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
21 #include "font-interface.hh"
22 #include "grob-array.hh"
24 #include "output-def.hh"
25 #include "paper-score.hh"
26 #include "simple-closure.hh"
28 #include "warn.hh" // error ()
30 LY_DEFINE (ly_grob_property_data, "ly:grob-property-data",
31 2, 0, 0, (SCM grob, SCM sym),
32 "Return the value for property @var{sym} of @var{grob},"
33 " but do not process callbacks.")
35 Grob *sc = unsmob_grob (grob);
37 LY_ASSERT_SMOB (Grob, grob, 1);
38 LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
40 return sc->get_property_data (sym);
43 LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!",
44 3, 0, 0, (SCM grob, SCM sym, SCM val),
45 "Set @var{sym} in grob @var{grob} to value @var{val}.")
47 Grob *sc = unsmob_grob (grob);
49 LY_ASSERT_SMOB (Grob, grob, 1);
50 LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
52 if (!ly_is_procedure (val)
53 && !is_simple_closure (val)
54 && !type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
55 error ("typecheck failed");
57 sc->set_property (sym, val);
58 return SCM_UNSPECIFIED;
61 LY_DEFINE (ly_grob_set_nested_property_x, "ly:grob-set-nested-property!",
62 3, 0, 0, (SCM grob, SCM symlist, SCM val),
63 "Set nested property @var{symlist} in grob @var{grob} to value @var{val}.")
65 Grob *sc = unsmob_grob (grob);
67 LY_ASSERT_SMOB (Grob, grob, 1);
69 bool type_ok = ly_cheap_is_list (symlist);
72 for (SCM s = symlist; scm_is_pair (s) && type_ok; s = scm_cdr (s))
73 type_ok &= ly_is_symbol (scm_car (s));
75 SCM_ASSERT_TYPE (type_ok, symlist, SCM_ARG2, __FUNCTION__, "list of symbols");
77 set_nested_property (sc, symlist, val);
78 return SCM_UNSPECIFIED;
81 LY_DEFINE (ly_grob_pure_property, "ly:grob-pure-property",
82 4, 1, 0, (SCM grob, SCM sym, SCM beg, SCM end, SCM val),
83 "Return the pure value for property @var{sym} of @var{grob}."
84 " If no value is found, return @var{val} or @code{'()}"
85 " if @var{val} is not specified.")
87 Grob *sc = unsmob_grob (grob);
89 LY_ASSERT_SMOB (Grob, grob, 1);
90 LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
91 LY_ASSERT_TYPE (scm_is_integer, beg, 3);
92 LY_ASSERT_TYPE (scm_is_integer, end, 4);
93 if (val == SCM_UNDEFINED)
96 SCM retval = sc->internal_get_pure_property (sym, scm_to_int (beg), scm_to_int (end));
97 if (retval == SCM_EOL)
103 LY_DEFINE (ly_grob_pure_height, "ly:grob-pure-height",
104 4, 1, 0, (SCM grob, SCM refp, SCM beg, SCM end, SCM val),
105 "Return the pure height of @var{grob} given refpoint @var{refp}."
106 " If no value is found, return @var{val} or @code{'()}"
107 " if @var{val} is not specified.")
109 Grob *sc = unsmob_grob (grob);
110 Grob *ref = unsmob_grob (refp);
112 LY_ASSERT_SMOB (Grob, grob, 1);
113 LY_ASSERT_SMOB (Grob, refp, 2);
114 LY_ASSERT_TYPE (scm_is_integer, beg, 3);
115 LY_ASSERT_TYPE (scm_is_integer, end, 4);
116 if (val == SCM_UNDEFINED)
119 Interval retval = sc->pure_height (ref, scm_to_int (beg), scm_to_int (end));
121 return ly_interval2scm (retval);
124 LY_DEFINE (ly_grob_property, "ly:grob-property",
125 2, 1, 0, (SCM grob, SCM sym, SCM val),
126 "Return the value for property @var{sym} of @var{grob}."
127 " If no value is found, return @var{val} or @code{'()}"
128 " if @var{val} is not specified.")
130 Grob *sc = unsmob_grob (grob);
132 LY_ASSERT_SMOB (Grob, grob, 1);
133 LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
134 if (val == SCM_UNDEFINED)
137 SCM retval = sc->internal_get_property (sym);
138 if (retval == SCM_EOL)
144 LY_DEFINE (ly_grob_interfaces, "ly:grob-interfaces",
146 "Return the interfaces list of grob @var{grob}.")
148 Grob *sc = unsmob_grob (grob);
150 LY_ASSERT_SMOB (Grob, grob, 1);
152 return sc->interfaces ();
155 LY_DEFINE (ly_grob_object, "ly:grob-object",
156 2, 0, 0, (SCM grob, SCM sym),
157 "Return the value of a pointer in grob @var{grob} of property"
158 " @var{sym}. It returns @code{'()} (end-of-list) if @var{sym}"
159 " is undefined in @var{grob}.")
161 Grob *sc = unsmob_grob (grob);
163 LY_ASSERT_SMOB (Grob, grob, 1);
164 LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
166 return sc->internal_get_object (sym);
169 LY_DEFINE (ly_grob_set_object_x, "ly:grob-set-object!",
170 3, 0, 0, (SCM grob, SCM sym, SCM val),
171 "Set @var{sym} in grob @var{grob} to value @var{val}.")
173 Grob *sc = unsmob_grob (grob);
175 LY_ASSERT_SMOB (Grob, grob, 1);
176 LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
178 sc->set_object (sym, val);
179 return SCM_UNSPECIFIED;
182 /* TODO: make difference between scaled and unscalead variable in
183 calling (i.e different funcs.) */
184 LY_DEFINE (ly_grob_layout, "ly:grob-layout",
186 "Get @code{\\layout} definition from grob @var{grob}.")
188 Grob *sc = unsmob_grob (grob);
190 LY_ASSERT_SMOB (Grob, grob, 1);
192 return sc->layout ()->self_scm ();
195 LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
196 1, 1, 0, (SCM grob, SCM global),
197 "Get an alist chain for grob @var{grob}, with @var{global} as"
198 " the global default. If unspecified, @code{font-defaults}"
199 " from the layout block is taken.")
201 Grob *sc = unsmob_grob (grob);
203 LY_ASSERT_SMOB (Grob, grob, 1);
205 if (global == SCM_UNDEFINED)
207 global = sc->layout ()->lookup_variable (ly_symbol2scm ("font-defaults"));
208 if (global == SCM_UNDEFINED)
212 return sc->get_property_alist_chain (global);
215 LY_DEFINE (ly_grob_extent, "ly:grob-extent",
216 3, 0, 0, (SCM grob, SCM refp, SCM axis),
217 "Get the extent in @var{axis} direction of @var{grob} relative to"
218 " the grob @var{refp}.")
220 Grob *sc = unsmob_grob (grob);
221 Grob *ref = unsmob_grob (refp);
223 LY_ASSERT_SMOB (Grob, grob, 1);
224 LY_ASSERT_SMOB (Grob, refp, 2);
225 LY_ASSERT_TYPE (is_axis, axis, 3);
227 Axis a = Axis (scm_to_int (axis));
229 if (ref->common_refpoint (sc, a) != ref)
231 // ugh. should use other error message
232 SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
234 return ly_interval2scm (sc->extent (ref, a));
237 LY_DEFINE (ly_grob_robust_relative_extent, "ly:grob-robust-relative-extent",
238 3, 0, 0, (SCM grob, SCM refp, SCM axis),
239 "Get the extent in @var{axis} direction of @var{grob} relative to"
240 " the grob @var{refp}, or @code{(0,0)} if empty.")
242 Grob *sc = unsmob_grob (grob);
243 Grob *ref = unsmob_grob (refp);
245 LY_ASSERT_SMOB (Grob, grob, 1);
246 LY_ASSERT_SMOB (Grob, refp, 2);
247 LY_ASSERT_TYPE (is_axis, axis, 3);
249 Axis a = Axis (scm_to_int (axis));
251 if (ref->common_refpoint (sc, a) != ref)
253 // ugh. should use other error message
254 SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
257 return ly_interval2scm (robust_relative_extent (sc, ref, a));
260 LY_DEFINE (ly_grob_relative_coordinate, "ly:grob-relative-coordinate",
261 3, 0, 0, (SCM grob, SCM refp, SCM axis),
262 "Get the coordinate in @var{axis} direction of @var{grob} relative"
263 " to the grob @var{refp}.")
265 Grob *sc = unsmob_grob (grob);
266 Grob *ref = unsmob_grob (refp);
268 LY_ASSERT_SMOB (Grob, grob, 1);
269 LY_ASSERT_SMOB (Grob, refp, 2);
270 LY_ASSERT_TYPE (is_axis, axis, 3);
272 Axis a = Axis (scm_to_int (axis));
274 if (ref->common_refpoint (sc, a) != ref)
276 // ugh. should use other error message
277 SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
280 return scm_from_double (sc->relative_coordinate (ref, a));
283 LY_DEFINE (ly_grob_parent, "ly:grob-parent",
284 2, 0, 0, (SCM grob, SCM axis),
285 "Get the parent of @var{grob}. @var{axis} is 0 for the X-axis,"
286 " 1@tie{}for the Y-axis.")
288 Grob *sc = unsmob_grob (grob);
290 LY_ASSERT_SMOB (Grob, grob, 1);
291 LY_ASSERT_TYPE (is_axis, axis, 2);
293 Grob *par = sc->get_parent (Axis (scm_to_int (axis)));
294 return par ? par->self_scm () : SCM_EOL;
297 LY_DEFINE (ly_grob_set_parent_x, "ly:grob-set-parent!",
298 3, 0, 0, (SCM grob, SCM axis, SCM parent_grob),
299 "Set @var{parent-grob} the parent of grob @var{grob} in axis @var{axis}.")
301 Grob *gr = unsmob_grob (grob);
302 Grob *parent = unsmob_grob (parent_grob);
304 LY_ASSERT_SMOB (Grob, grob, 1);
305 LY_ASSERT_TYPE (is_axis, axis, 2);
306 LY_ASSERT_SMOB (Grob, parent_grob, 3);
308 Axis a = Axis (scm_to_int (axis));
309 gr->set_parent (parent, a);
310 return SCM_UNSPECIFIED;
313 LY_DEFINE (ly_grob_properties, "ly:grob-properties",
315 "Get the mutable properties of @var{grob}.")
317 Grob *g = unsmob_grob (grob);
319 LY_ASSERT_SMOB (Grob, grob, 1);
321 /* FIXME: uhg? copy/read only? */
322 return g->mutable_property_alist_;
325 LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
327 "Get the immutable properties of @var{grob}.")
329 Grob *g = unsmob_grob (grob);
331 LY_ASSERT_SMOB (Grob, grob, 1);
333 /* FIXME: uhg? copy/read only? */
334 return g->immutable_property_alist_;
337 LY_DEFINE (ly_grob_system, "ly:grob-system",
339 "Return the system grob of @var{grob}.")
341 Grob *me = unsmob_grob (grob);
343 LY_ASSERT_SMOB (Grob, grob, 1);
345 if (System *g = me->get_system ())
346 return g->self_scm ();
351 LY_DEFINE (ly_grob_original, "ly:grob-original",
353 "Return the unbroken original grob of @var{grob}.")
355 Grob *me = unsmob_grob (grob);
357 LY_ASSERT_SMOB (Grob, grob, 1);
358 return me->original () ? me->original ()->self_scm () : me->self_scm ();
361 LY_DEFINE (ly_grob_suicide_x, "ly:grob-suicide!",
365 Grob *me = unsmob_grob (grob);
367 LY_ASSERT_SMOB (Grob, grob, 1);
370 return SCM_UNSPECIFIED;
373 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
374 3, 0, 0, (SCM grob, SCM d, SCM a),
375 "Translate @var{grob} on axis@tie{}@var{a} over"
376 " distance@tie{}@var{d}.")
378 Grob *me = unsmob_grob (grob);
380 LY_ASSERT_SMOB (Grob, grob, 1);
381 LY_ASSERT_TYPE (scm_is_number, d, 2);
382 LY_ASSERT_TYPE (is_axis, a, 3);
384 me->translate_axis (scm_to_double (d), Axis (scm_to_int (a)));
385 return SCM_UNSPECIFIED;
388 LY_DEFINE (ly_grob_default_font, "ly:grob-default-font",
390 "Return the default font for grob @var{grob}.")
392 Grob *gr = unsmob_grob (grob);
394 LY_ASSERT_SMOB (Grob, grob, 1);
396 return Font_interface::get_default_font (gr)->self_scm ();
400 TODO: consider swapping order, so we can do
402 (grob-common-refpoint a b c d e)
404 LY_DEFINE (ly_grob_common_refpoint, "ly:grob-common-refpoint",
405 3, 0, 0, (SCM grob, SCM other, SCM axis),
406 "Find the common refpoint of @var{grob} and @var{other}"
410 Grob *gr = unsmob_grob (grob);
412 LY_ASSERT_SMOB (Grob, grob, 1);
413 LY_ASSERT_SMOB (Grob, other, 2);
415 Grob *o = unsmob_grob (other);
417 LY_ASSERT_TYPE (is_axis, axis, 3);
419 Grob *refp = gr->common_refpoint (o, Axis (scm_to_int (axis)));
420 return refp ? refp->self_scm () : SCM_BOOL_F;
423 LY_DEFINE (ly_grob_common_refpoint_of_array, "ly:grob-common-refpoint-of-array",
424 3, 0, 0, (SCM grob, SCM others, SCM axis),
425 "Find the common refpoint of @var{grob} and @var{others}"
426 " (a grob-array) for @var{axis}.")
428 Grob *gr = unsmob_grob (grob);
430 LY_ASSERT_SMOB (Grob, grob, 1);
431 LY_ASSERT_SMOB (Grob_array, others, 2);
433 Grob_array *ga = unsmob_grob_array (others);
434 LY_ASSERT_TYPE (is_axis, axis, 3);
436 Grob *refp = common_refpoint_of_array (ga->array (), gr, Axis (scm_to_int (axis)));
437 return refp ? refp->self_scm () : SCM_BOOL_F;
440 LY_DEFINE (ly_grob_chain_callback, "ly:grob-chain-callback",
441 3, 0, 0, (SCM grob, SCM proc, SCM sym),
442 "Find the callback that is stored as property"
443 " @var{sym} of grob @var{grob} and chain @var{proc}"
444 " to the head of this, meaning that it is called"
445 " using @var{grob} and the previous callback's result.")
447 Grob *gr = unsmob_grob (grob);
449 LY_ASSERT_SMOB (Grob, grob, 1);
450 LY_ASSERT_TYPE (ly_is_procedure, proc, 2);
451 LY_ASSERT_TYPE (ly_is_symbol, sym, 3);
453 chain_callback (gr, proc, sym);
454 return SCM_UNSPECIFIED;
457 LY_DEFINE (ly_grob_vertical_less_p, "ly:grob-vertical<?",
458 2, 0, 0, (SCM a, SCM b),
459 "Does @var{a} lie above @var{b} on the page?")
461 LY_ASSERT_SMOB (Grob, a, 1);
462 LY_ASSERT_SMOB (Grob, b, 2);
464 Grob *ga = unsmob_grob (a);
465 Grob *gb = unsmob_grob (b);
467 return ly_bool2scm (Grob::vertical_less (ga, gb));