/*
This file is part of LilyPond, the GNU music typesetter.
- Copyright (C) 1997--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
LilyPond is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#include "font-metric.hh"
#include "libc-extension.hh"
#include "lookup.hh"
+#include "offset.hh"
#include "stencil.hh"
+/*
+ * A few general helpers in degrees
+ */
+
+LY_DEFINE (ly_angle, "ly:angle",
+ 1, 1, 0, (SCM x, SCM y),
+ "Calculates angle in degrees of given vector. With one argument,"
+ " @var{x} is a number pair indicating the vector. With two"
+ " arguments, @var{x} and @var{y} specify the respective coordinates.")
+{
+ Offset off;
+ if (SCM_UNBNDP (y)) {
+ LY_ASSERT_TYPE (is_number_pair, x, 1);
+ off = ly_scm2offset (x);
+ } else {
+ LY_ASSERT_TYPE (scm_is_number, x, 1);
+ LY_ASSERT_TYPE (scm_is_number, y, 2);
+ off = Offset (scm_to_double (x), scm_to_double (y));
+ }
+ return scm_from_double (off.angle_degrees ());
+}
+
+LY_DEFINE (ly_length, "ly:length",
+ 1, 1, 0, (SCM x, SCM y),
+ "Calculates magnitude of given vector. With one argument,"
+ " @var{x} is a number pair indicating the vector. With two"
+ " arguments, @var{x} and @var{y} specify the respective coordinates.")
+{
+ Offset off;
+ if (SCM_UNBNDP (y)) {
+ LY_ASSERT_TYPE (is_number_pair, x, 1);
+ off = ly_scm2offset (x);
+ } else {
+ LY_ASSERT_TYPE (scm_is_number, x, 1);
+ LY_ASSERT_TYPE (scm_is_number, y, 2);
+ off = Offset (scm_to_double (x), scm_to_double (y));
+ }
+ return scm_from_double (off.length ());
+}
+
+LY_DEFINE (ly_directed, "ly:directed",
+ 1, 1, 0, (SCM direction, SCM magnitude),
+ "Calculates an @code{(x . y)} pair with optional @var{magnitude}"
+ " (defaulting to @code{1.0}) and @var{direction} specified either"
+ " as an angle in degrees or a coordinate pair giving the direction. "
+ " If @var{magnitude} is a pair, the respective coordinates are"
+ " scaled independently, useful for ellipse drawings.")
+{
+ Offset res;
+ if (scm_is_pair (direction))
+ {
+ LY_ASSERT_TYPE (is_number_pair, direction, 1);
+ res = ly_scm2offset (direction).direction ();
+ }
+ else
+ {
+ LY_ASSERT_TYPE (scm_is_number, direction, 1);
+ res = offset_directed (scm_to_double (direction));
+ }
+ if (SCM_UNBNDP (magnitude))
+ return ly_offset2scm (res);
+ if (scm_is_pair (magnitude))
+ {
+ LY_ASSERT_TYPE (is_number_pair, magnitude, 2);
+ return ly_offset2scm (res.scale (ly_scm2offset (magnitude)));
+ }
+ LY_ASSERT_TYPE (scm_is_number, magnitude, 2);
+ return ly_offset2scm (scm_to_double (magnitude) * res);
+}
+
+
/*
TODO: naming add/combine.
*/
"Return a copy of @var{stil} but translated by @var{amount}"
" in @var{axis} direction.")
{
- Stencil *s = unsmob_stencil (stil);
+ Stencil *s = unsmob<Stencil> (stil);
LY_ASSERT_SMOB (Stencil, stil, 1);
LY_ASSERT_TYPE (scm_is_number, amount, 2);
Real real_amount = scm_to_double (amount);
SCM new_s = s->smobbed_copy ();
- Stencil *q = unsmob_stencil (new_s);
+ scm_remember_upto_here_1 (stil);
+
+ Stencil *q = unsmob<Stencil> (new_s);
q->translate_axis (real_amount, Axis (scm_to_int (axis)));
return new_s;
}
"Return a @var{stil}, but translated by @var{offset}"
" (a pair of numbers).")
{
- Stencil *s = unsmob_stencil (stil);
+ Stencil *s = unsmob<Stencil> (stil);
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 ();
- Stencil *q = unsmob_stencil (new_s);
+ scm_remember_upto_here_1 (stil);
+
+ Stencil *q = unsmob<Stencil> (new_s);
q->translate (o);
return new_s;
}
1, 0, 0, (SCM stil),
"Return the expression of @var{stil}.")
{
- Stencil *s = unsmob_stencil (stil);
+ Stencil *s = unsmob<Stencil> (stil);
LY_ASSERT_SMOB (Stencil, stil, 1);
return s->expr ();
}
" @var{axis} direction (@code{0} or @code{1} for x and"
" y@tie{}axis, respectively).")
{
- Stencil *s = unsmob_stencil (stil);
+ Stencil *s = unsmob<Stencil> (stil);
LY_ASSERT_SMOB (Stencil, stil, 1);
LY_ASSERT_TYPE (is_axis, axis, 2);
}
LY_DEFINE (ly_stencil_empty_p, "ly:stencil-empty?",
- 1, 0, 0, (SCM stil),
- "Return whether @var{stil} is empty.")
+ 1, 1, 0, (SCM stil, SCM axis),
+ "Return whether @var{stil} is empty. If an optional"
+ " @var{axis} is supplied, the emptiness check is"
+ " restricted to that axis.")
{
- Stencil *s = unsmob_stencil (stil);
+ Stencil *s = unsmob<Stencil> (stil);
LY_ASSERT_SMOB (Stencil, stil, 1);
- return scm_from_bool (s->is_empty ());
+ if (SCM_UNBNDP (axis))
+ return scm_from_bool (s->is_empty ());
+ LY_ASSERT_TYPE (is_axis, axis, 2);
+ return scm_from_bool (s->is_empty (Axis (scm_to_int (axis))));
}
LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge",
" space. @var{first} and @var{second} may also be @code{'()} or"
" @code{#f}.")
{
- Stencil *s1 = unsmob_stencil (first);
- Stencil *s2 = unsmob_stencil (second);
+ Stencil *s1 = unsmob<Stencil> (first);
+ Stencil *s2 = unsmob<Stencil> (second);
Stencil result;
- SCM_ASSERT_TYPE (s1 || first == SCM_BOOL_F || first == SCM_EOL,
+ SCM_ASSERT_TYPE (s1 || scm_is_false (first) || scm_is_null (first),
first, SCM_ARG1, __FUNCTION__, "Stencil, #f or ()");
- SCM_ASSERT_TYPE (s2 || second == SCM_BOOL_F || second == SCM_EOL,
+ SCM_ASSERT_TYPE (s2 || scm_is_false (second) || scm_is_null (second),
second, SCM_ARG4, __FUNCTION__, "Stencil, #f or ()");
LY_ASSERT_TYPE (is_axis, axis, 2);
LY_ASSERT_TYPE (is_direction, direction, 3);
Real p = 0.0;
- if (padding != SCM_UNDEFINED)
+ if (!SCM_UNBNDP (padding))
{
LY_ASSERT_TYPE (scm_is_number, padding, 5);
p = scm_to_double (padding);
result.add_at_edge (Axis (scm_to_int (axis)),
Direction (scm_to_int (direction)), *s2, p);
+ scm_remember_upto_here_2 (first, second);
+
+ return result.smobbed_copy ();
+}
+
+LY_DEFINE (ly_stencil_stack, "ly:stencil-stack",
+ 4, 2, 0, (SCM first, SCM axis, SCM direction,
+ SCM second,
+ SCM padding,
+ SCM mindist),
+ "Construct a stencil by stacking @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. @var{first} and @var{second} may also be @code{'()} or"
+ " @code{#f}. As opposed to @code{ly:stencil-combine-at-edge},"
+ " metrics are suited for successively accumulating lines of"
+ " stencils. Also, @var{second} stencil is drawn last.\n\n"
+ "If @var{mindist} is specified, reference points are placed"
+ " apart at least by this distance. If either of the stencils"
+ " is spacing, @var{padding} and @var{mindist} do not apply.")
+{
+ Stencil *s1 = unsmob<Stencil> (first);
+ Stencil *s2 = unsmob<Stencil> (second);
+ Stencil result;
+
+ SCM_ASSERT_TYPE (s1 || scm_is_false (first) || scm_is_null (first),
+ first, SCM_ARG1, __FUNCTION__, "Stencil, #f or ()");
+ SCM_ASSERT_TYPE (s2 || scm_is_false (second) || scm_is_null (second),
+ second, SCM_ARG4, __FUNCTION__, "Stencil, #f or ()");
+ LY_ASSERT_TYPE (is_axis, axis, 2);
+ LY_ASSERT_TYPE (is_direction, direction, 3);
+
+ Real p = 0.0;
+ if (!SCM_UNBNDP (padding))
+ {
+ LY_ASSERT_TYPE (scm_is_number, padding, 5);
+ p = scm_to_double (padding);
+ }
+ Real d = -infinity_f;
+ if (!SCM_UNBNDP (mindist))
+ {
+ LY_ASSERT_TYPE (scm_is_number, mindist, 6);
+ d = scm_to_double (mindist);
+ }
+
+ if (s1)
+ result = *s1;
+
+ if (s2)
+ result.stack (Axis (scm_to_int (axis)),
+ Direction (scm_to_int (direction)), *s2, p, d);
+
+ scm_remember_upto_here_2 (first, second);
+
return result.smobbed_copy ();
}
while (!SCM_NULLP (args))
{
- Stencil *s = unsmob_stencil (scm_car (args));
+ Stencil *s = unsmob<Stencil> (scm_car (args));
if (!s)
SCM_ASSERT_TYPE (s, scm_car (args), SCM_ARGn, __FUNCTION__, "Stencil");
"@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"
+ " @code{empty-interval} as its value), it is taken to be empty.\n"
"@end enumerate\n")
{
SCM_ASSERT_TYPE (!scm_is_pair (expr)
expr, SCM_ARG1, __FUNCTION__, "registered stencil expression");
Interval x;
- if (xext != SCM_UNDEFINED)
+ if (!SCM_UNBNDP (xext))
{
LY_ASSERT_TYPE (is_number_pair, xext, 2);
x = ly_scm2interval (xext);
}
Interval y;
- if (yext != SCM_UNDEFINED)
+ if (!SCM_UNBNDP (yext))
{
LY_ASSERT_TYPE (is_number_pair, yext, 3);
y = ly_scm2interval (yext);
LY_ASSERT_TYPE (is_axis, axis, 2);
LY_ASSERT_TYPE (scm_is_number, dir, 3);
- Stencil target = *unsmob_stencil (stil);
+ Stencil target = *unsmob<Stencil> (stil);
target.align_to ((Axis)scm_to_int (axis),
scm_to_double (dir));
" in@tie{}@var{s}.")
{
LY_ASSERT_SMOB (Stencil, s, 1);
- Stencil *stil = unsmob_stencil (s);
+ Stencil *stil = unsmob<Stencil> (s);
return find_expression_fonts (stil->expr ());
}
"Put @var{stc} in a different color.")
{
LY_ASSERT_SMOB (Stencil, stc, 1);
- Stencil *stil = unsmob_stencil (stc);
+ Stencil *stil = unsmob<Stencil> (stc);
return Stencil (stil->extent_box (),
scm_list_3 (ly_symbol2scm ("color"),
scm_list_3 (r, g, b),
SCM arg1;
};
-void stencil_interpret_in_scm (void *p, SCM expr)
+SCM stencil_interpret_in_scm (void *p, SCM expr)
{
Stencil_interpret_arguments *ap = (Stencil_interpret_arguments *) p;
- scm_call_2 (ap->func, ap->arg1, expr);
+ return scm_call_2 (ap->func, ap->arg1, expr);
}
LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression",
" 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);
+ 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);
Real y_off = scm_to_double (y);
SCM new_s = s->smobbed_copy ();
- Stencil *q = unsmob_stencil (new_s);
+ Stencil *q = unsmob<Stencil> (new_s);
q->rotate_degrees (a, Offset (x_off, y_off));
return new_s;
}
"Return a stencil @var{stil} rotated @var{angle} degrees around"
" point (@var{x}, @var{y}), given in absolute coordinates.")
{
- Stencil *s = unsmob_stencil (stil);
+ 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);
Real y_off = scm_to_double (y);
SCM new_s = s->smobbed_copy ();
- Stencil *q = unsmob_stencil (new_s);
+ Stencil *q = unsmob<Stencil> (new_s);
q->rotate_degrees_absolute (a, Offset (x_off, y_off));
return new_s;
}
}
LY_DEFINE (ly_round_filled_polygon, "ly:round-filled-polygon",
- 2, 0, 0,
- (SCM points, SCM blot),
+ 2, 1, 0,
+ (SCM points, SCM blot, SCM extroversion),
"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}.")
+ " pairs) and roundness @var{blot}. Optional"
+ "@var{extroversion} shifts the outline outward, with the"
+ "default of@tie{}@code{-1.0} keeping the outer boundary of"
+ "the outline just inside of the polygon.")
{
SCM_ASSERT_TYPE (scm_ilength (points) > 0, points, SCM_ARG1, __FUNCTION__, "list of coordinate pairs");
LY_ASSERT_TYPE (scm_is_number, blot, 2);
+ Real ext = -1;
+ if (!SCM_UNBNDP (extroversion))
+ {
+ LY_ASSERT_TYPE (scm_is_number, extroversion, 3);
+ ext = scm_to_double (extroversion);
+ }
vector<Offset> pts;
for (SCM p = points; scm_is_pair (p); p = scm_cdr (p))
{
// TODO: Print out warning
}
}
- return Lookup::round_filled_polygon (pts, scm_to_double (blot)).smobbed_copy ();
+ return Lookup::round_filled_polygon (pts, scm_to_double (blot), ext)
+ .smobbed_copy ();
}
LY_DEFINE (ly_register_stencil_expression, "ly:register-stencil-expression",
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}.")
+ "Scale stencil @var{stil} using the horizontal and vertical"
+ " scaling factors @var{x} and @var{y}. Negative values will"
+ " flip or mirror @var{stil} without changing its origin;"
+ " this may result in collisions unless it is repositioned.")
{
- Stencil *s = unsmob_stencil (stil);
+ 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);
+ Stencil *q = unsmob<Stencil> (new_s);
q->scale (scm_to_double (x), scm_to_double (y));
return new_s;
}
+
+LY_DEFINE (ly_stencil_outline, "ly:stencil-outline",
+ 2, 0, 0, (SCM stil, SCM outline),
+ "Return a stencil with the stencil expression (inking)"
+ " of stencil @var{stil} but with outline and dimensions"
+ " from stencil @var{outline}.")
+{
+ Stencil s = *LY_ASSERT_SMOB (Stencil, stil, 1);
+ Stencil o = *LY_ASSERT_SMOB (Stencil, outline, 2);
+ return s.with_outline (o).smobbed_copy ();
+}
projects / lilypond.git / blobdiff