X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fgrob-scheme.cc;h=4d6ed8f69b1524236b81b8f32291382cf75846db;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=b31447ffac38b547a9f232baeee325875bac496b;hpb=2a8c79664174b846da1fe107f429f23536f8724d;p=lilypond.git diff --git a/lily/grob-scheme.cc b/lily/grob-scheme.cc index b31447ffac..4d6ed8f69b 100644 --- a/lily/grob-scheme.cc +++ b/lily/grob-scheme.cc @@ -3,38 +3,38 @@ source file of the GNU LilyPond music typesetter - (c) 1998--2006 Jan Nieuwenhuizen + (c) 1998--2008 Jan Nieuwenhuizen Han-Wen Nienhuys */ -#include "grob.hh" - -#include "warn.hh" // error() +#include "warn.hh" // error () #include "item.hh" #include "output-def.hh" #include "system.hh" #include "font-interface.hh" #include "paper-score.hh" - +#include "grob-array.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"); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_TYPE (ly_is_symbol, sym, 2); 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), - "Set @var{sym} in grob @var{grob} to value @var{val}") + "Set @var{sym} in grob @var{grob} to value @var{val}.") { 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"); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_TYPE (ly_is_symbol, sym, 2); if (!ly_is_procedure (val) && !type_check_assignment (sym, val, ly_symbol2scm ("backend-type?"))) @@ -46,14 +46,15 @@ LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!", 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") + "Return the value of a value in grob@tie{}@var{g} of property" + " @var{sym}. It returns @code{'()} (end-of-list) or" + " @var{deflt} (if specified) if @var{sym} is undefined" + " in@tie{}@var{g}.") { 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"); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_TYPE (ly_is_symbol, sym, 2); if (deflt == SCM_UNDEFINED) deflt = SCM_EOL; @@ -70,56 +71,50 @@ LY_DEFINE (ly_grob_interfaces, "ly:grob-interfaces", "Return the interfaces list of grob @var{grob}.") { Grob *sc = unsmob_grob (grob); - SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); + + LY_ASSERT_SMOB (Grob, grob, 1); return sc->interfaces (); } LY_DEFINE (ly_grob_object, "ly:grob-object", 2, 0, 0, (SCM grob, SCM 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") + "Return the value of a pointer in grob@tie{}@var{g} of property" + " @var{sym}. It returns @code{'()} (end-of-list) if @var{sym}" + " is undefined in@tie{}@var{g}.") { 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"); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_TYPE (ly_is_symbol, sym, 2); return sc->internal_get_object (sym); } -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)); - 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 (); -} + /* TODO: make difference between scaled and unscalead variable in calling (i.e different funcs.) */ LY_DEFINE (ly_grob_layout, "ly:grob-layout", - 1, 0, 0, (SCM g), - "Get @code{\\layout} definition from grob @var{g}.") + 1, 0, 0, (SCM grob), + "Get @code{\\layout} definition from grob @var{grob}.") { - Grob *sc = unsmob_grob (g); - SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob"); + Grob *sc = unsmob_grob (grob); + + LY_ASSERT_SMOB (Grob, grob, 1); return sc->layout ()->self_scm (); } LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain", 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 layout block is taken. ") + "Get an alist chain for grob @var{grob}, with @var{global} as" + " the global default. If unspecified, @code{font-defaults}" + " from the layout block is taken.") { Grob *sc = unsmob_grob (grob); - SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); + + LY_ASSERT_SMOB (Grob, grob, 1); if (global == SCM_UNDEFINED) { @@ -131,17 +126,18 @@ LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain", return sc->get_property_alist_chain (global); } -LY_DEFINE (ly_get_extent, "ly:grob-extent", +LY_DEFINE (ly_grob_extent, "ly:grob-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}") + "Get the extent 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"); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_SMOB (Grob, refp, 2); + LY_ASSERT_TYPE (is_axis, axis, 3); Axis a = Axis (scm_to_int (axis)); @@ -156,15 +152,16 @@ LY_DEFINE (ly_get_extent, "ly:grob-extent", 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") + "Get the extent in @var{axis} direction of @var{grob} relative to" + " the grob @var{refp}, or @code{(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"); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_SMOB (Grob, refp, 2); + LY_ASSERT_TYPE (is_axis, axis, 3); Axis a = Axis (scm_to_int (axis)); @@ -179,15 +176,16 @@ LY_DEFINE (ly_grob_robust_relative_extent, "ly:grob-robust-relative-extent", 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}") + "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"); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_SMOB (Grob, refp, 2); + LY_ASSERT_TYPE (is_axis, axis, 3); Axis a = Axis (scm_to_int (axis)); @@ -198,18 +196,19 @@ LY_DEFINE (ly_grob_relative_coordinate, "ly:grob-relative-coordinate", SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint"); } - return scm_from_double (sc->relative_coordinate (ref,a)); + 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, " - "1 for the Y-axis.") + "Get the parent of @var{grob}. @var{axis} is 0 for the X-axis," + " 1@tie{}for the Y-axis.") { Grob *sc = unsmob_grob (grob); - SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob"); - SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis"); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_TYPE (is_axis, axis, 2); Grob *par = sc->get_parent (Axis (scm_to_int (axis))); return par ? par->self_scm () : SCM_EOL; @@ -217,10 +216,11 @@ LY_DEFINE (ly_grob_parent, "ly:grob-parent", LY_DEFINE (ly_grob_properties, "ly:grob-properties", 1, 0, 0, (SCM grob), - "Get the mutable proprerties of @var{grob}.") + "Get the mutable properties of @var{grob}.") { Grob *g = unsmob_grob (grob); - SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob"); + + LY_ASSERT_SMOB (Grob, grob, 1); /* FIXME: uhg? copy/read only? */ return g->mutable_property_alist_; @@ -231,18 +231,20 @@ LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties", "Get the immutable properties of @var{grob}.") { Grob *g = unsmob_grob (grob); - SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob"); + + LY_ASSERT_SMOB (Grob, grob, 1); /* FIXME: uhg? copy/read only? */ return g->immutable_property_alist_; } LY_DEFINE (ly_grob_system, "ly:grob-system", - 1, 0, 0, (SCM g), - "Return the System Grob of @var{g}.") + 1, 0, 0, (SCM grob), + "Return the system grob of @var{grob}.") { - Grob *me = unsmob_grob (g); - SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob"); + Grob *me = unsmob_grob (grob); + + LY_ASSERT_SMOB (Grob, grob, 1); if (System *g = me->get_system ()) return g->self_scm (); @@ -252,79 +254,49 @@ LY_DEFINE (ly_grob_system, "ly:grob-system", LY_DEFINE (ly_grob_original, "ly:grob-original", 1, 0, 0, (SCM grob), - "Return the unbroken original Grob of @var{grob}.") + "Return the unbroken original grob of @var{grob}.") { Grob *me = unsmob_grob (grob); - SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob"); + + LY_ASSERT_SMOB (Grob, grob, 1); return me->original () ? me->original ()->self_scm () : me->self_scm (); } -/* TODO: maybe we should return a vector -- random access is more - logical for this list? */ -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)); - SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner"); - - SCM s = SCM_EOL; - 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_x, "ly:grob-suicide!", - 1, 0, 0, (SCM g), - "Kill @var{g}.") + 1, 0, 0, (SCM grob), + "Kill @var{grob}.") { - Grob *me = unsmob_grob (g); - SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob"); + Grob *me = unsmob_grob (grob); + + LY_ASSERT_SMOB (Grob, grob, 1); me->suicide (); return SCM_UNSPECIFIED; } LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!", - 3, 0, 0, (SCM g, SCM d, SCM a), - "Translate @var{g} on axis @var{a} over distance @var{d}.") + 3, 0, 0, (SCM grob, SCM d, SCM a), + "Translate @var{g} on axis@tie{}@var{a} over" + " distance@tie{}@var{d}.") { - Grob *me = unsmob_grob (g); - SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob"); - SCM_ASSERT_TYPE (scm_is_number (d), d, SCM_ARG2, __FUNCTION__, "dimension"); - SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis"); + Grob *me = unsmob_grob (grob); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_TYPE (scm_is_number, d, 2); + LY_ASSERT_TYPE (is_axis, a, 3); me->translate_axis (scm_to_double (d), Axis (scm_to_int (a))); return SCM_UNSPECIFIED; } -LY_DEFINE (ly_spanner_p, "ly:spanner?", - 1, 0, 0, (SCM g), - "Is @var{g} a spanner object?") -{ - Grob *me = unsmob_grob (g); - bool b = dynamic_cast (me); - - return ly_bool2scm (b); -} - -LY_DEFINE (ly_grob_key, "ly:grob-key", - 1, 0, 0, - (SCM grob), - "Return the object-key for @var{grob}.") -{ - 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"); + + LY_ASSERT_SMOB (Grob, grob, 1); return Font_interface::get_default_font (gr)->self_scm (); } @@ -337,17 +309,18 @@ LY_DEFINE (ly_grob_default_font, "ly:grob-default-font", */ 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}." - ) + "Find the common refpoint of @var{grob} and @var{other}" + " for @var{axis}.") { Grob *gr = unsmob_grob (grob); - SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob"); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_SMOB (Grob, other, 2); 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"); + LY_ASSERT_TYPE (is_axis, axis, 3); Grob *refp = gr->common_refpoint (o, Axis (scm_to_int (axis))); return refp ? refp->self_scm () : SCM_BOOL_F; @@ -355,16 +328,16 @@ LY_DEFINE (ly_grob_common_refpoint, "ly:grob-common-refpoint", 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}." - ) + "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"); + + LY_ASSERT_SMOB (Grob, grob, 1); + LY_ASSERT_SMOB (Grob_array, others, 2); 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"); + LY_ASSERT_TYPE (is_axis, axis, 3); Grob *refp = common_refpoint_of_array (ga->array (), gr, Axis (scm_to_int (axis))); return refp ? refp->self_scm () : SCM_BOOL_F;