]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stencil-scheme.cc
Merge branch 'master' of ssh+git://git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / lily / stencil-scheme.cc
index 1bf2eab21387312447a1411fa8a8ff86049b9102..a603f01b5f5c9b123cbd1638bfb462cd4a1b268e 100644 (file)
@@ -3,11 +3,9 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include <cmath>
-using namespace std;
 
 #include "font-metric.hh"
 #include "libc-extension.hh"
@@ -18,37 +16,31 @@ using namespace std;
   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.")
 {
   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).")
 {
   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 ();
@@ -62,7 +54,7 @@ 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 ();
 }
 
@@ -72,8 +64,8 @@ LY_DEFINE (ly_stencil_extent, "ly:stencil-extent",
           "@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");
+  LY_ASSERT_SMOB (Stencil, stil, 1);
+  LY_ASSERT_TYPE (is_axis, axis, 2);
 
   return ly_interval2scm (s->extent (Axis (scm_to_int (axis))));
 }
@@ -83,62 +75,10 @@ LY_DEFINE (ly_stencil_empty_p, "ly:stencil-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,
@@ -160,19 +100,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);
     }
 
@@ -181,7 +121,7 @@ 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 ();
 }
@@ -215,23 +155,45 @@ LY_DEFINE (ly_stencil_add, "ly:stencil-add",
 }
 
 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. "
+          1, 2, 0, (SCM expr, SCM xext, SCM yext),
+          "Stencils are device independent output expressions.  "
+          "They carry two pieces of information:\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"
-          "2: the vertical and horizontal extents of the object.\n\n")
+          "for example @file{scm/output-ps.scm}.\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)),
                   expr, SCM_ARG1, __FUNCTION__, "registered stencil expression");
 
-  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");
 
-  Box b (ly_scm2interval (xext), ly_scm2interval (yext));
+  Interval x; 
+  if (xext != SCM_UNDEFINED)
+    {
+      LY_ASSERT_TYPE (is_number_pair, xext, 2);
+      x = ly_scm2interval (xext);
+    }
+
+  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 ();
 }
@@ -242,9 +204,9 @@ LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to",
           "@var{dir} is a number -1, 1 are left and right respectively. "
           "Other values are interpolated (so 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);
 
@@ -257,8 +219,8 @@ 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}.")
 {
+  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 ());
 }
 
@@ -266,8 +228,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),
@@ -290,8 +252,7 @@ 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")
 {
-  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;
@@ -310,10 +271,10 @@ LY_DEFINE (ly_bracket, "ly:bracket",
           "given by @var{iv}. The wings protude by an amount of @var{p}, which "
           "may be negative. The thickness is given by @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),
@@ -321,16 +282,35 @@ 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 @var{stil} rotated @var{angle} degrees around point (@var{x}, @var{y}).")
+{
+  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 (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}.")
 {
-  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 ();
@@ -341,8 +321,7 @@ LY_DEFINE (ly_register_stencil_expression, "ly:register-stencil-expression",
           (SCM symbol),
           "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;
 }