X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fstencil-scheme.cc;h=5c859251ef19e9a432064527b66538c106ea13c7;hb=ace881437adc0146a62cffa3255ac1ca169bd054;hp=6ef0e191fd4394bad150cf94dfc7aa45151f3e23;hpb=98166b94174b63666a14a6a62bc16cf1b4163bce;p=lilypond.git diff --git a/lily/stencil-scheme.cc b/lily/stencil-scheme.cc index 6ef0e191fd..5c859251ef 100644 --- a/lily/stencil-scheme.cc +++ b/lily/stencil-scheme.cc @@ -1,9 +1,20 @@ /* - stencil-scheme.cc -- implement Stencil scheme accessors + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1997--2010 Han-Wen Nienhuys - (c) 1997--2007 Han-Wen Nienhuys + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . */ @@ -16,37 +27,32 @@ TODO: naming add/combine. */ -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 (); @@ -60,28 +66,29 @@ 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_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 ()); } @@ -90,13 +97,14 @@ LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge", 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); @@ -106,19 +114,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); } @@ -134,7 +142,7 @@ LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge", 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); @@ -162,15 +170,20 @@ LY_DEFINE (ly_stencil_add, "ly:stencil-add", LY_DEFINE (ly_make_stencil, "ly:make-stencil", 1, 2, 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-ps.scm}.\n\n" - "2: the vertical and horizontal extents of the object.\n\n" - "If the extents are unspecified, they are taken to be empty." - ) + "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 (!scm_is_pair (expr) || is_stencil_head (scm_car (expr)), @@ -180,14 +193,14 @@ LY_DEFINE (ly_make_stencil, "ly:make-stencil", Interval x; if (xext != SCM_UNDEFINED) { - SCM_ASSERT_TYPE (is_number_pair (xext), xext, SCM_ARG2, __FUNCTION__, "number pair"); + LY_ASSERT_TYPE (is_number_pair, xext, 2); x = ly_scm2interval (xext); } Interval y; if (yext != SCM_UNDEFINED) { - SCM_ASSERT_TYPE (is_number_pair (yext), yext, SCM_ARG3, __FUNCTION__, "number pair"); + LY_ASSERT_TYPE (is_number_pair, yext, 3); y = ly_scm2interval (yext); } @@ -198,13 +211,13 @@ LY_DEFINE (ly_make_stencil, "ly:make-stencil", 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); @@ -215,10 +228,11 @@ LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to", 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 ()); } @@ -226,8 +240,8 @@ 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); - SCM_ASSERT_TYPE (stil, stc, SCM_ARG1, __FUNCTION__, "Stencil"); return Stencil (stil->extent_box (), scm_list_3 (ly_symbol2scm ("color"), scm_list_3 (r, g, b), @@ -248,10 +262,10 @@ 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_is_procedure (func), func, SCM_ARG1, __FUNCTION__, - "procedure"); + LY_ASSERT_TYPE (ly_is_procedure, func, 2); Stencil_interpret_arguments a; a.func = func; @@ -266,14 +280,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), @@ -281,47 +296,89 @@ LY_DEFINE (ly_bracket, "ly:bracket", 0.95 * scm_to_double (t)).smobbed_copy (); } -LY_DEFINE (ly_rotate_stencil, "ly:stencil-rotate", +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 @var{stil} rotated @var{angle} degrees around point (@var{x}, @var{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); - SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil"); - SCM_ASSERT_TYPE (scm_is_number (angle), angle, SCM_ARG2, __FUNCTION__, "number"); - SCM_ASSERT_TYPE (scm_is_number (x), x, SCM_ARG3, __FUNCTION__, "number"); - SCM_ASSERT_TYPE (scm_is_number (y), y, SCM_ARG4, __FUNCTION__, "number"); + 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 (a, Offset (x_off, y_off)); + q->rotate_degrees_absolute (a, Offset (x_off, y_off)); return new_s; } -LY_DEFINE (ly_filled_box, "ly:round-filled-box", +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") + "Add @var{symbol} as head of a stencil expression.") { - SCM_ASSERT_TYPE (scm_is_symbol (symbol), symbol, - SCM_ARG1, __FUNCTION__, "Symbol"); + LY_ASSERT_TYPE (ly_is_symbol, symbol, 1); register_stencil_head (symbol); return SCM_UNSPECIFIED; } @@ -333,3 +390,20 @@ LY_DEFINE (ly_all_stencil_expressions, "ly:all-stencil-expressions", { return all_stencil_heads (); } + +LY_DEFINE (ly_stencil_scale, "ly:stencil-scale", + 3, 0, 0, (SCM stil, SCM x, SCM y), + "Scale @var{stil} using the horizontal and vertical scaling" + " factors @var{x} and @var{y}.") +{ + Stencil *s = unsmob_stencil (stil); + LY_ASSERT_SMOB (Stencil, stil, 1); + LY_ASSERT_TYPE (scm_is_number, x, 2); + LY_ASSERT_TYPE (scm_is_number, y, 3); + + SCM new_s = s->smobbed_copy (); + Stencil *q = unsmob_stencil (new_s); + + q->scale (scm_to_double (x), scm_to_double (y)); + return new_s; +}