X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob-scheme.cc;h=b31447ffac38b547a9f232baeee325875bac496b;hb=a9c0c06eca7cf482bd550be17e4a4dbdfc7cc22a;hp=75c9c7bc1e7b6182cbfa1ad3a6b1c33379c1222d;hpb=c76d27c59244a331a2873a40e0d7e40ad378d4b8;p=lilypond.git diff --git a/lily/grob-scheme.cc b/lily/grob-scheme.cc index 75c9c7bc1e..b31447ffac 100644 --- a/lily/grob-scheme.cc +++ b/lily/grob-scheme.cc @@ -3,17 +3,30 @@ source file of the GNU LilyPond music typesetter - (c) 1998--2004 Jan Nieuwenhuizen - Han-Wen Nienhuys + (c) 1998--2006 Jan Nieuwenhuizen + Han-Wen Nienhuys */ #include "grob.hh" -#include "warn.hh" -#include "spanner.hh" + +#include "warn.hh" // error() #include "item.hh" #include "output-def.hh" #include "system.hh" +#include "font-interface.hh" +#include "paper-score.hh" + + +LY_DEFINE (ly_grob_property_data, "ly:grob-property-data", + 2, 0, 0, (SCM grob, SCM sym), + "Retrieve @var{sym} for @var{grob} but don't process callbacks.") +{ + Grob *sc = unsmob_grob (grob); + SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); + SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol"); + return sc->get_property_data (sym); +} LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!", 3, 0, 0, (SCM grob, SCM sym, SCM val), @@ -23,34 +36,65 @@ LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!", SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol"); - if (!type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"))) + if (!ly_is_procedure (val) + && !type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"))) error ("typecheck failed"); - sc->internal_set_property (sym, val); + sc->set_property (sym, val); return SCM_UNSPECIFIED; } LY_DEFINE (ly_grob_property, "ly:grob-property", + 2, 1, 0, (SCM grob, SCM sym, SCM deflt), + "Return the value of a value in grob @var{g} of property @var{sym}. " + "It will return @code{'()} or @var{deflt} (if specified) " + "if @var{sym} is undefined in @var{g}." + "\n\n") +{ + Grob *sc = unsmob_grob (grob); + SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); + SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol"); + if (deflt == SCM_UNDEFINED) + deflt = SCM_EOL; + + SCM retval = sc->internal_get_property (sym); + if (retval == SCM_EOL) + retval = deflt; + + return retval; +} + + +LY_DEFINE (ly_grob_interfaces, "ly:grob-interfaces", + 1, 0, 0, (SCM grob), + "Return the interfaces list of grob @var{grob}.") +{ + Grob *sc = unsmob_grob (grob); + SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); + + return sc->interfaces (); +} + +LY_DEFINE (ly_grob_object, "ly:grob-object", 2, 0, 0, (SCM grob, SCM sym), - "Return the value of a value in grob @var{g} of property @var{sym}. " + "Return the value of a pointer in grob @var{g} of property @var{sym}. " "It will return @code{' ()} (end-of-list) " "if @var{sym} is undefined in @var{g}." - "\n\n" - ) + "\n\n") { Grob *sc = unsmob_grob (grob); SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol"); - return sc->internal_get_property (sym); + return sc->internal_get_object (sym); } -LY_DEFINE (ly_spanner_get_bound, "ly:spanner-get-bound", +LY_DEFINE (ly_spanner_get_bound, "ly:spanner-bound", 2, 0, 0, (SCM slur, SCM dir), "Get one of the bounds of @var{spanner}. @var{dir} is @code{-1} " "for left, and @code{1} for right.") { - Spanner * sl = dynamic_cast (unsmob_grob (slur)); + Spanner *sl = dynamic_cast (unsmob_grob (slur)); SCM_ASSERT_TYPE (sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob"); SCM_ASSERT_TYPE (is_direction (dir), slur, SCM_ARG2, __FUNCTION__, "dir"); return sl->get_bound (to_dir (dir))->self_scm (); @@ -58,28 +102,31 @@ LY_DEFINE (ly_spanner_get_bound, "ly:spanner-get-bound", /* TODO: make difference between scaled and unscalead variable in calling (i.e different funcs.) */ -LY_DEFINE (ly_grob_paper, "ly:grob-paper", +LY_DEFINE (ly_grob_layout, "ly:grob-layout", 1, 0, 0, (SCM g), - "Get @code{\\paper} definition from grob @var{g}.") + "Get @code{\\layout} definition from grob @var{g}.") { - Grob * sc = unsmob_grob (g); + Grob *sc = unsmob_grob (g); SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob"); - return sc->get_paper ()->self_scm (); + return sc->layout ()->self_scm (); } LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain", - 1, 1, 0, (SCM g, SCM global), - "Get an alist chain for grob @var{g}, with @var{global} as the " + 1, 1, 0, (SCM grob, SCM global), + "Get an alist chain for grob @var{grob}, with @var{global} as the " "global default. If unspecified, @code{font-defaults} " - "from the paper block is taken. ") + "from the layout block is taken. ") { - Grob *sc = unsmob_grob (g); - SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob"); + Grob *sc = unsmob_grob (grob); + SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); if (global == SCM_UNDEFINED) - global - = sc->get_paper ()->lookup_variable (ly_symbol2scm ("font-defaults")); + { + global = sc->layout ()->lookup_variable (ly_symbol2scm ("font-defaults")); + if (global == SCM_UNDEFINED) + global = SCM_EOL; + } return sc->get_property_alist_chain (global); } @@ -91,13 +138,70 @@ LY_DEFINE (ly_get_extent, "ly:grob-extent", { Grob *sc = unsmob_grob (grob); Grob *ref = unsmob_grob (refp); + + SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); + SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob"); + SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis"); + + Axis a = Axis (scm_to_int (axis)); + + + if (ref->common_refpoint (sc, a) != ref) + { + // ugh. should use other error message + SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint"); + } + return ly_interval2scm (sc->extent (ref, a)); +} + +LY_DEFINE (ly_grob_robust_relative_extent, "ly:grob-robust-relative-extent", + 3, 0, 0, (SCM grob, SCM refp, SCM axis), + "Get the extent in @var{axis} direction of @var{grob} relative to " + "the grob @var{refp}, or (0,0) if empty") +{ + Grob *sc = unsmob_grob (grob); + Grob *ref = unsmob_grob (refp); + + SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); + SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob"); + SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis"); + + Axis a = Axis (scm_to_int (axis)); + + if (ref->common_refpoint (sc, a) != ref) + { + // ugh. should use other error message + SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint"); + } + + return ly_interval2scm (robust_relative_extent (sc, ref, a)); +} + +LY_DEFINE (ly_grob_relative_coordinate, "ly:grob-relative-coordinate", + 3, 0, 0, (SCM grob, SCM refp, SCM axis), + "Get the coordinate in @var{axis} direction of @var{grob} relative to " + "the grob @var{refp}") +{ + Grob *sc = unsmob_grob (grob); + Grob *ref = unsmob_grob (refp); + SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob"); SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis"); - return ly_interval2scm ( sc->extent (ref, Axis (scm_to_int (axis)))); + Axis a = Axis (scm_to_int (axis)); + + + if (ref->common_refpoint (sc, a) != ref) + { + // ugh. should use other error message + SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint"); + } + + return scm_from_double (sc->relative_coordinate (ref,a)); } + LY_DEFINE (ly_grob_parent, "ly:grob-parent", 2, 0, 0, (SCM grob, SCM axis), "Get the parent of @var{grob}. @var{axis} is 0 for the X-axis, " @@ -152,7 +256,7 @@ LY_DEFINE (ly_grob_original, "ly:grob-original", { Grob *me = unsmob_grob (grob); SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob"); - return me->original_ ? me->original_->self_scm () : me->self_scm (); + return me->original () ? me->original ()->self_scm () : me->self_scm (); } /* TODO: maybe we should return a vector -- random access is more @@ -161,16 +265,16 @@ LY_DEFINE (ly_spanner_broken_into, "ly:spanner-broken-into", 1, 0, 0, (SCM spanner), "Return broken-into list for @var{spanner}.") { - Spanner *me = dynamic_cast (unsmob_grob (spanner)); + Spanner *me = dynamic_cast (unsmob_grob (spanner)); SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner"); SCM s = SCM_EOL; - for (int i = me->broken_intos_.size (); i--;) + for (vsize i = me->broken_intos_.size (); i--;) s = scm_cons (me->broken_intos_[i]->self_scm (), s); return s; } -LY_DEFINE (ly_grob_suicide, "ly:grob-suicide", +LY_DEFINE (ly_grob_suicide_x, "ly:grob-suicide!", 1, 0, 0, (SCM g), "Kill @var{g}.") { @@ -199,27 +303,69 @@ LY_DEFINE (ly_spanner_p, "ly:spanner?", "Is @var{g} a spanner object?") { Grob *me = unsmob_grob (g); - bool b = dynamic_cast (me); + bool b = dynamic_cast (me); return ly_bool2scm (b); } -LY_DEFINE (ly_item_p, "ly:item?", - 1, 0, 0, (SCM g), - "Is @var{g} an @code{Item} object?") +LY_DEFINE (ly_grob_key, "ly:grob-key", + 1, 0, 0, + (SCM grob), + "Return the object-key for @var{grob}.") { - Grob *me = unsmob_grob (g); - bool b = dynamic_cast (me); - return ly_bool2scm (b); + Grob *me = unsmob_grob (grob); + SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "Grob"); + + return me->key () ? me->key ()->self_scm () : SCM_EOL; +} + +LY_DEFINE (ly_grob_default_font, "ly:grob-default-font", + 1, 0, 0, (SCM grob), + "Return the default font for grob @var{gr}.") +{ + Grob *gr = unsmob_grob (grob); + SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob"); + + return Font_interface::get_default_font (gr)->self_scm (); } -LY_DEFINE (ly_item_break_dir, "ly:item-break-dir", - 1, 0, 0, (SCM it), - "The break status dir of item @var{it}. @code{-1} is end of " - "line, @code{0} unbroken, and @code{1} begin of line.") + +/* + TODO: consider swapping order, so we can do + + (grob-common-refpoint a b c d e) + */ +LY_DEFINE (ly_grob_common_refpoint, "ly:grob-common-refpoint", + 3, 0, 0, (SCM grob, SCM other, SCM axis), + "Find the common refpoint of @var{grob} and @var{other} for @var{axis}." + ) { - Item *me = dynamic_cast (unsmob_grob (it)); - SCM_ASSERT_TYPE (me, it, SCM_ARG1, __FUNCTION__, "Item"); - return scm_int2num (me->break_status_dir ()); + + Grob *gr = unsmob_grob (grob); + SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob"); + + Grob *o = unsmob_grob (other); + SCM_ASSERT_TYPE (o, other, SCM_ARG2, __FUNCTION__, "grob"); + + SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis"); + + Grob *refp = gr->common_refpoint (o, Axis (scm_to_int (axis))); + return refp ? refp->self_scm () : SCM_BOOL_F; } +LY_DEFINE (ly_grob_common_refpoint_of_array, "ly:grob-common-refpoint-of-array", + 3, 0, 0, (SCM grob, SCM others, SCM axis), + "Find the common refpoint of @var{grob} and @var{others} " + "(a grob-array) for @var{axis}." + ) +{ + Grob *gr = unsmob_grob (grob); + SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob"); + + Grob_array *ga = unsmob_grob_array (others); + SCM_ASSERT_TYPE (ga, others, SCM_ARG2, __FUNCTION__, "grob array"); + SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis"); + + Grob *refp = common_refpoint_of_array (ga->array (), gr, Axis (scm_to_int (axis))); + return refp ? refp->self_scm () : SCM_BOOL_F; +}