X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fstencil-scheme.cc;h=102fe5e6c90389e028033d26e84e2c2784ff100a;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=826ffe17aa1fc48a05a9074a35fa9c787e27df10;hpb=f2541abbfdbed6bf32db3b7eaa62baae33710b04;p=lilypond.git diff --git a/lily/stencil-scheme.cc b/lily/stencil-scheme.cc index 826ffe17aa..102fe5e6c9 100644 --- a/lily/stencil-scheme.cc +++ b/lily/stencil-scheme.cc @@ -3,72 +3,45 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2005 Han-Wen Nienhuys + (c) 1997--2008 Han-Wen Nienhuys */ -#include - -#include // isinf #include "font-metric.hh" -#include "stencil.hh" +#include "libc-extension.hh" #include "lookup.hh" +#include "stencil.hh" /* TODO: naming add/combine. */ -/* - UGH. Junk all mutators. -*/ -LY_DEFINE (ly_stencil_set_extent_x, "ly:stencil-set-extent!", - 3, 0, 0, (SCM stil, SCM axis, SCM np), - "Set the extent of @var{stil} " - "(@var{extent} must be a pair of numbers) " - "in @var{axis} direction (0 or 1 for x- and y-axis respectively).") -{ - Stencil *s = unsmob_stencil (stil); - SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil"); - SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis"); - SCM_ASSERT_TYPE (is_number_pair (np), np, SCM_ARG3, __FUNCTION__, - "number pair"); - - Interval iv = ly_scm2interval (np); - s->dim_[Axis (scm_to_int (axis))] = iv; - - return SCM_UNSPECIFIED; -} -LY_DEFINE (ly_translate_stencil_axis, "ly:stencil-translate-axis", +LY_DEFINE (ly_stencil_translate_axis, "ly:stencil-translate-axis", 3, 0, 0, (SCM stil, SCM amount, SCM axis), - "Return a copy of @var{stil} but translated by @var{amount} in @var{axis} direction.") + "Return a copy of @var{stil} but translated by @var{amount}" + " in @var{axis} direction.") { Stencil *s = unsmob_stencil (stil); - SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil"); - SCM_ASSERT_TYPE (scm_is_number (amount), amount, SCM_ARG2, __FUNCTION__, "number"); + LY_ASSERT_SMOB (Stencil, stil, 1); + LY_ASSERT_TYPE (scm_is_number, amount, 2); + LY_ASSERT_TYPE (is_axis, axis, 3); Real real_amount = scm_to_double (amount); -#if 0 - SCM_ASSERT_TYPE (!isinf (real_amount) && !isnan (real_amount), - amount, SCM_ARG2, __FUNCTION__, "finite number"); -#endif - - SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis"); SCM new_s = s->smobbed_copy (); Stencil *q = unsmob_stencil (new_s); q->translate_axis (real_amount, Axis (scm_to_int (axis))); return new_s; - } -LY_DEFINE (ly_translate_stencil, "ly:stencil-translate", +LY_DEFINE (ly_stencil_translate, "ly:stencil-translate", 2, 0, 0, (SCM stil, SCM offset), - "Return a @var{stil}, " - "but translated by @var{offset} (a pair of numbers).") + "Return a @var{stil}, but translated by @var{offset}" + " (a pair of numbers).") { Stencil *s = unsmob_stencil (stil); - SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil"); - SCM_ASSERT_TYPE (is_number_pair (offset), offset, SCM_ARG2, __FUNCTION__, "number pair"); + LY_ASSERT_SMOB (Stencil, stil, 1); + LY_ASSERT_TYPE (is_number_pair, offset, 2); Offset o = ly_scm2offset (offset); SCM new_s = s->smobbed_copy (); @@ -82,95 +55,45 @@ LY_DEFINE (ly_stencil_expr, "ly:stencil-expr", "Return the expression of @var{stil}.") { Stencil *s = unsmob_stencil (stil); - SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil"); + LY_ASSERT_SMOB (Stencil, stil, 1); return s->expr (); } -LY_DEFINE (ly_stencil_get_extent, "ly:stencil-extent", +LY_DEFINE (ly_stencil_extent, "ly:stencil-extent", 2, 0, 0, (SCM stil, SCM axis), - "Return a pair of numbers signifying the extent of @var{stil} in " - "@var{axis} direction (0 or 1 for x and y axis respectively).") + "Return a pair of numbers signifying the extent of @var{stil} in" + " @var{axis} direction (@code{0} or @code{1} for x and" + " y@tie{}axis, respectively).") { Stencil *s = unsmob_stencil (stil); - SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil"); - SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis"); + LY_ASSERT_SMOB (Stencil, stil, 1); + LY_ASSERT_TYPE (is_axis, axis, 2); return ly_interval2scm (s->extent (Axis (scm_to_int (axis)))); } LY_DEFINE (ly_stencil_empty_p, "ly:stencil-empty?", 1, 0, 0, (SCM stil), - "Return whether @var{stil} is empty ") + "Return whether @var{stil} is empty.") { Stencil *s = unsmob_stencil (stil); - SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil"); + LY_ASSERT_SMOB (Stencil, stil, 1); return scm_from_bool (s->is_empty ()); } -LY_DEFINE (ly_stencil_origin, "ly:stencil-origin", - 2, 0, 0, (SCM stil, SCM axis), - "Return a pair of numbers signifying the origin @var{stil} in " - "@var{axis} direction (0 or 1 for x and y axis respectively).") -{ - Stencil *s = unsmob_stencil (stil); - SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil"); - SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis"); - - return scm_from_double (s->origin ()[Axis (scm_to_int (axis))]); -} - -LY_DEFINE (ly_stencil_moved_to_edge, "ly:stencil-moved-to-edge", - 4, 2, 0, (SCM first, SCM axis, SCM direction, SCM second, - SCM padding, SCM minimum), - "Similar to @code{ly:stencil-combine-edge}, but returns " - "@var{second} positioned to be next to @var{first}. ") -{ - /* - C&P from combine-at-edge. - */ - Stencil *s1 = unsmob_stencil (first); - Stencil *s2 = unsmob_stencil (second); - Stencil first_stencil; - - SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis"); - SCM_ASSERT_TYPE (is_direction (direction), direction, SCM_ARG4, __FUNCTION__, "dir"); - - Real p = 0.0; - if (padding != SCM_UNDEFINED) - { - SCM_ASSERT_TYPE (scm_is_number (padding), padding, SCM_ARG5, __FUNCTION__, "number"); - p = scm_to_double (padding); - } - Real m = 0.0; - if (minimum != SCM_UNDEFINED) - { - SCM_ASSERT_TYPE (scm_is_number (minimum), minimum, SCM_ARG6, __FUNCTION__, "number"); - m = scm_to_double (minimum); - } - - if (s1) - first_stencil = *s1; - - if (s2) - return first_stencil.moved_to_edge (Axis (scm_to_int (axis)), - Direction (scm_to_int (direction)), - *s2, p, m).smobbed_copy (); - else - return Stencil ().smobbed_copy (); -} - LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge", 4, 2, 0, (SCM first, SCM axis, SCM direction, SCM second, SCM padding, SCM minimum), - "Construct a stencil by putting @var{second} next to @var{first}. " - "@var{axis} can be 0 (x-axis) or 1 (y-axis), " - "@var{direction} can be -1 (left or down) or 1 (right or up). " - "The stencils are juxtaposed with @var{padding} as extra space. " - "If this puts the reference points closer than @var{minimum}, " - "they are moved by the latter amount." - "@var{first} and @var{second} may also be '() or #f.") + "Construct a stencil by putting @var{second} next to @var{first}." + " @var{axis} can be 0 (x-axis) or@tie{}1 (y-axis)." + " @var{direction} can be -1 (left or down) or@tie{}1 (right or" + " up). The stencils are juxtaposed with @var{padding} as extra" + " space. If this puts the reference points closer than" + " @var{minimum}, they are moved by the latter amount." + " @var{first} and @var{second} may also be @code{'()} or" + " @code{#f}.") { Stencil *s1 = unsmob_stencil (first); Stencil *s2 = unsmob_stencil (second); @@ -180,19 +103,19 @@ LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge", first, SCM_ARG1, __FUNCTION__, "Stencil, #f or ()"); SCM_ASSERT_TYPE (s2 || second == SCM_BOOL_F || second == SCM_EOL, second, SCM_ARG4, __FUNCTION__, "Stencil, #f or ()"); - SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis"); - SCM_ASSERT_TYPE (is_direction (direction), direction, SCM_ARG3, __FUNCTION__, "dir"); + LY_ASSERT_TYPE (is_axis, axis, 2); + LY_ASSERT_TYPE (is_direction, direction, 3); Real p = 0.0; if (padding != SCM_UNDEFINED) { - SCM_ASSERT_TYPE (scm_is_number (padding), padding, SCM_ARG5, __FUNCTION__, "number"); + LY_ASSERT_TYPE (scm_is_number, padding, 5); p = scm_to_double (padding); } Real m = 0.0; if (minimum != SCM_UNDEFINED) { - SCM_ASSERT_TYPE (scm_is_number (minimum), minimum, SCM_ARG6, __FUNCTION__, "number"); + LY_ASSERT_TYPE (scm_is_number, minimum, 6); m = scm_to_double (minimum); } @@ -201,19 +124,22 @@ LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge", if (s2) result.add_at_edge (Axis (scm_to_int (axis)), - Direction (scm_to_int (direction)), *s2, p, m); + Direction (scm_to_int (direction)), *s2, p); return result.smobbed_copy (); } LY_DEFINE (ly_stencil_add, "ly:stencil-add", 0, 0, 1, (SCM args), - "Combine stencils. Takes any number of arguments.") + "Combine stencils. Takes any number of arguments.") { #define FUNC_NAME __FUNCTION__ SCM_VALIDATE_REST_ARGUMENT (args); - Stencil result; + SCM expr = SCM_EOL; + SCM *tail = &expr; + Box extent; + extent.set_empty (); while (!SCM_NULLP (args)) { @@ -221,55 +147,96 @@ LY_DEFINE (ly_stencil_add, "ly:stencil-add", if (!s) SCM_ASSERT_TYPE (s, scm_car (args), SCM_ARGn, __FUNCTION__, "Stencil"); - result.add_stencil (*s); + extent.unite (s->extent_box ()); + *tail = scm_cons (s->expr (), SCM_EOL); + tail = SCM_CDRLOC (*tail); args = scm_cdr (args); } - return result.smobbed_copy (); + expr = scm_cons (ly_symbol2scm ("combine-stencil"), expr); + return Stencil (extent, expr).smobbed_copy (); } LY_DEFINE (ly_make_stencil, "ly:make-stencil", - 3, 0, 0, (SCM expr, SCM xext, SCM yext), - " \n" - "Stencils are a device independent output expressions." - "They carry two pieces of information: \n\n" - "1: a specification of how to print this object. " - "This specification is processed by the output backends, " - " for example @file{scm/output-tex.scm}.\n\n" - "2: the vertical and horizontal extents of the object.\n\n") + 1, 2, 0, (SCM expr, SCM xext, SCM yext), + "Stencils are device independent output expressions." + " They carry two pieces of information:\n" + "\n" + "@enumerate\n" + "@item\n" + "A specification of how to print this object." + " This specification is processed by the output backends," + " for example @file{scm/output-ps.scm}.\n" + "\n" + "@item\n" + "The vertical and horizontal extents of the object, given as" + " pairs. If an extent is unspecified (or if you use" + " @code{(1000 . -1000)} as its value), it is taken to be empty.\n" + "@end enumerate\n") { - SCM_ASSERT_TYPE (is_number_pair (xext), xext, SCM_ARG2, __FUNCTION__, "number pair"); - SCM_ASSERT_TYPE (is_number_pair (yext), yext, SCM_ARG3, __FUNCTION__, "number pair"); + SCM_ASSERT_TYPE (!scm_is_pair (expr) + || is_stencil_head (scm_car (expr)), + expr, SCM_ARG1, __FUNCTION__, "registered stencil expression"); + + + Interval x; + if (xext != SCM_UNDEFINED) + { + LY_ASSERT_TYPE (is_number_pair, xext, 2); + x = ly_scm2interval (xext); + } - Box b (ly_scm2interval (xext), ly_scm2interval (yext)); + Interval y; + if (yext != SCM_UNDEFINED) + { + LY_ASSERT_TYPE (is_number_pair, yext, 3); + y = ly_scm2interval (yext); + } + + Box b (x, y); Stencil s (b, expr); return s.smobbed_copy (); } -LY_DEFINE (ly_stencil_align_to_x, "ly:stencil-align-to!", +LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to", 3, 0, 0, (SCM stil, SCM axis, SCM dir), - "Align @var{stil} using its own extents. " - "@var{dir} is a number -1, 1 are left and right respectively. " - "Other values are interpolated (so 0 means the center. ") + "Align @var{stil} using its own extents. @var{dir} is a number." + " @code{-1} and @code{1} are left and right, respectively." + " Other values are interpolated (so @code{0} means the center).") { - SCM_ASSERT_TYPE (unsmob_stencil (stil), stil, SCM_ARG1, __FUNCTION__, "stencil"); - SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis"); - SCM_ASSERT_TYPE (scm_is_number (dir), dir, SCM_ARG3, __FUNCTION__, "number"); + LY_ASSERT_SMOB (Stencil, stil, 1); + LY_ASSERT_TYPE (is_axis, axis, 2); + LY_ASSERT_TYPE (scm_is_number, dir, 3); + + Stencil target = *unsmob_stencil (stil); - unsmob_stencil (stil)->align_to ((Axis)scm_to_int (axis), - scm_to_double (dir)); - return stil; + target.align_to ((Axis)scm_to_int (axis), + scm_to_double (dir)); + return target.smobbed_copy (); } LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts", 1, 0, 0, (SCM s), - " Analyse @var{s}, and return a list of fonts used in @var{s}.") + "Analyze @var{s}, and return a list of fonts used" + " in@tie{}@var{s}.") { + LY_ASSERT_SMOB (Stencil, s, 1); Stencil *stil = unsmob_stencil (s); - SCM_ASSERT_TYPE (stil, s, SCM_ARG1, __FUNCTION__, "Stencil"); return find_expression_fonts (stil->expr ()); } +LY_DEFINE (ly_stencil_in_color, "ly:stencil-in-color", + 4, 0, 0, (SCM stc, SCM r, SCM g, SCM b), + "Put @var{stc} in a different color.") +{ + LY_ASSERT_SMOB (Stencil, stc, 1); + Stencil *stil = unsmob_stencil (stc); + return Stencil (stil->extent_box (), + scm_list_3 (ly_symbol2scm ("color"), + scm_list_3 (r, g, b), + stil->expr ())).smobbed_copy (); +} + struct Stencil_interpret_arguments { SCM func; @@ -284,17 +251,17 @@ void stencil_interpret_in_scm (void *p, SCM expr) LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression", 4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset), - "Parse EXPR, feed bits to FUNC with first arg ARG1") + "Parse @var{expr}, feed bits to @var{func} with first arg" + " @var{arg1} having offset @var{offset}.") { - SCM_ASSERT_TYPE (ly_c_procedure_p (func), func, SCM_ARG1, __FUNCTION__, - "procedure"); + LY_ASSERT_TYPE (ly_is_procedure, func, 2); Stencil_interpret_arguments a; a.func = func; a.arg1 = arg1; Offset o = ly_scm2offset (offset); - interpret_stencil_expression (expr, stencil_interpret_in_scm, (void *) &a, o); + interpret_stencil_expression (expr, stencil_interpret_in_scm, (void *) & a, o); return SCM_UNSPECIFIED; } @@ -302,14 +269,15 @@ LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression", LY_DEFINE (ly_bracket, "ly:bracket", 4, 0, 0, (SCM a, SCM iv, SCM t, SCM p), - "Make a bracket in direction @var{a}. The extent of the bracket is " - "given by @var{iv}. The wings protude by an amount of @var{p}, which " - "may be negative. The thickness is given by @var{t}.") + "Make a bracket in direction@tie{}@var{a}. The extent of the" + " bracket is given by @var{iv}. The wings protrude by an amount" + " of@tie{}@var{p}, which may be negative. The thickness is given" + " by@tie{}@var{t}.") { - SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG1, __FUNCTION__, "axis"); - SCM_ASSERT_TYPE (is_number_pair (iv), iv, SCM_ARG2, __FUNCTION__, "number pair"); - SCM_ASSERT_TYPE (scm_is_number (t), a, SCM_ARG3, __FUNCTION__, "number"); - SCM_ASSERT_TYPE (scm_is_number (p), a, SCM_ARG4, __FUNCTION__, "number"); + LY_ASSERT_TYPE (is_axis, a, 1); + LY_ASSERT_TYPE (is_number_pair, iv, 2); + LY_ASSERT_TYPE (scm_is_number, t, 3); + LY_ASSERT_TYPE (scm_is_number, p, 4); return Lookup::bracket ((Axis)scm_to_int (a), ly_scm2interval (iv), scm_to_double (t), @@ -317,18 +285,97 @@ LY_DEFINE (ly_bracket, "ly:bracket", 0.95 * scm_to_double (t)).smobbed_copy (); } -LY_DEFINE (ly_filled_box, "ly:round-filled-box", +LY_DEFINE (ly_stencil_rotate, "ly:stencil-rotate", + 4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y), + "Return a stencil @var{stil} rotated @var{angle} degrees around" + " the relative offset (@var{x}, @var{y}). E.g. an offset of" + " (-1, 1) will rotate the stencil around the left upper corner.") +{ + Stencil *s = unsmob_stencil (stil); + LY_ASSERT_SMOB (Stencil, stil, 1); + LY_ASSERT_TYPE (scm_is_number, angle, 2); + LY_ASSERT_TYPE (scm_is_number, x, 3); + LY_ASSERT_TYPE (scm_is_number, y, 4); + Real a = scm_to_double (angle); + Real x_off = scm_to_double (x); + Real y_off = scm_to_double (y); + + SCM new_s = s->smobbed_copy (); + Stencil *q = unsmob_stencil (new_s); + q->rotate_degrees (a, Offset (x_off, y_off)); + return new_s; +} + +LY_DEFINE (ly_stencil_rotate_absolute, "ly:stencil-rotate-absolute", + 4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y), + "Return a stencil @var{stil} rotated @var{angle} degrees around" + " point (@var{x}, @var{y}), given in absolute coordinates.") +{ + Stencil *s = unsmob_stencil (stil); + LY_ASSERT_SMOB (Stencil, stil, 1); + LY_ASSERT_TYPE (scm_is_number, angle, 2); + LY_ASSERT_TYPE (scm_is_number, x, 3); + LY_ASSERT_TYPE (scm_is_number, y, 4); + Real a = scm_to_double (angle); + Real x_off = scm_to_double (x); + Real y_off = scm_to_double (y); + + SCM new_s = s->smobbed_copy (); + Stencil *q = unsmob_stencil (new_s); + q->rotate_degrees_absolute (a, Offset (x_off, y_off)); + return new_s; +} + +LY_DEFINE (ly_round_filled_box, "ly:round-filled-box", 3, 0, 0, (SCM xext, SCM yext, SCM blot), - "Make a @code{Stencil} " - "that prints a black box of dimensions @var{xext}, " - "@var{yext} and roundness @var{blot}.") + "Make a @code{Stencil} object that prints a black box of" + " dimensions @var{xext}, @var{yext} and roundness @var{blot}.") { - SCM_ASSERT_TYPE (is_number_pair (xext), xext, SCM_ARG1, __FUNCTION__, "number pair"); - SCM_ASSERT_TYPE (is_number_pair (yext), yext, SCM_ARG2, __FUNCTION__, "number pair"); - SCM_ASSERT_TYPE (scm_is_number (blot), blot, SCM_ARG3, __FUNCTION__, "number"); + LY_ASSERT_TYPE (is_number_pair, xext, 1); + LY_ASSERT_TYPE (is_number_pair, yext, 2); + LY_ASSERT_TYPE (scm_is_number, blot, 3); return Lookup::round_filled_box (Box (ly_scm2interval (xext), ly_scm2interval (yext)), scm_to_double (blot)).smobbed_copy (); } +LY_DEFINE (ly_round_filled_polygon, "ly:round-filled-polygon", + 2, 0, 0, + (SCM points, SCM blot), + "Make a @code{Stencil} object that prints a black polygon with" + " corners at the points defined by @var{points} (list of coordinate" + " pairs) and roundness @var{blot}.") +{ + SCM_ASSERT_TYPE (scm_ilength (points) > 0, points, SCM_ARG1, __FUNCTION__, "list of coordinate pairs"); + LY_ASSERT_TYPE (scm_is_number, blot, 2); + vector pts; + for (SCM p = points; scm_is_pair (p); p = scm_cdr (p)) + { + SCM scm_pt = scm_car (p); + if (scm_is_pair (scm_pt)) { + pts.push_back (ly_scm2offset (scm_pt)); + } else { + // TODO: Print out warning + } + } + return Lookup::round_filled_polygon (pts, scm_to_double (blot)).smobbed_copy (); +} + +LY_DEFINE (ly_register_stencil_expression, "ly:register-stencil-expression", + 1, 0, 0, + (SCM symbol), + "Add @var{symbol} as head of a stencil expression.") +{ + LY_ASSERT_TYPE (ly_is_symbol, symbol, 1); + register_stencil_head (symbol); + return SCM_UNSPECIFIED; +} + +LY_DEFINE (ly_all_stencil_expressions, "ly:all-stencil-expressions", + 0, 0, 0, + (), + "Return all symbols recognized as stencil expressions.") +{ + return all_stencil_heads (); +}