]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stencil-scheme.cc
replace SCM_ASSERT_TYPE with LY_ASSERT_TYPE and friends
[lilypond.git] / lily / stencil-scheme.cc
index 4ef10f4e08914228e30eb05e2632105ce54ed1a3..619d43d3162ecf67df405a3a8b295c669f5dce4f 100644 (file)
@@ -3,72 +3,50 @@
 
   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 <math.h>
-
-#include <libc - extension.hh> // 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.")
 {
   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_FIRST_SMOB(Stencil, stil);
+  LY_ASSERT_TYPE(scm_is_number, 2);
 
   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");
+  LY_ASSERT_TYPE(is_axis, 3);
 
   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_FIRST_SMOB(Stencil, stil);
+  LY_ASSERT_TYPE(is_number_pair, 2);
   Offset o = ly_scm2offset (offset);
 
   SCM new_s = s->smobbed_copy ();
@@ -82,18 +60,18 @@ 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_FIRST_SMOB(Stencil, stil);
   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).")
 {
   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_FIRST_SMOB(Stencil, stil);
+  LY_ASSERT_TYPE(is_axis, 2);
 
   return ly_interval2scm (s->extent (Axis (scm_to_int (axis))));
 }
@@ -103,62 +81,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_FIRST_SMOB(Stencil, stil);
   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,
@@ -176,23 +102,24 @@ LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge",
   Stencil *s2 = unsmob_stencil (second);
   Stencil result;
 
+  LY_FUNC_NOTE_FIRST_ARG(first);
   SCM_ASSERT_TYPE (s1 || first == SCM_BOOL_F || first == SCM_EOL,
                   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, 2);
+  LY_ASSERT_TYPE(is_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, 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, 6);
       m = scm_to_double (minimum);
     }
 
@@ -201,7 +128,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 ();
 }
@@ -213,7 +140,10 @@ LY_DEFINE (ly_stencil_add, "ly:stencil-add",
 #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 +151,91 @@ 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),
+          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-tex.scm}.\n\n"
-          "2: the vertical and horizontal extents of the object.\n\n")
+          " 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."
+          )
 {
-  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");
+  LY_FUNC_NOTE_FIRST_ARG (expr);
+  SCM_ASSERT_TYPE (!scm_is_pair (expr)
+                  || is_stencil_head (scm_car (expr)),
+                  expr, SCM_ARG1, __FUNCTION__, "registered stencil expression");
 
-  Box b (ly_scm2interval (xext), ly_scm2interval (yext));
+
+  Interval x; 
+  if (xext != SCM_UNDEFINED)
+    {
+      LY_ASSERT_TYPE(is_number_pair, 2);
+      x = ly_scm2interval (xext);
+    }
+
+  Interval y; 
+  if (yext != SCM_UNDEFINED)
+    {
+      LY_ASSERT_TYPE(is_number_pair, 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")
+          "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_FIRST_SMOB(Stencil, stil);
+  LY_ASSERT_TYPE(is_axis, 2);
+  LY_ASSERT_TYPE(scm_is_number, 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}.")
 {
+  LY_ASSERT_FIRST_SMOB (Stencil, s);
   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_FIRST_SMOB (Stencil, stc);
+  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;
@@ -286,15 +252,15 @@ 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_c_procedure_p (func), func, SCM_ARG1, __FUNCTION__,
-                  "procedure");
+  LY_FUNC_NOTE_FIRST_ARG(expr);
+  LY_ASSERT_TYPE (ly_is_procedure, 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;
 }
@@ -306,10 +272,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_FIRST_TYPE(is_axis, a);
+  LY_ASSERT_TYPE(is_number_pair, 2);
+  LY_ASSERT_TYPE(scm_is_number, 3);
+  LY_ASSERT_TYPE(scm_is_number, 4);
 
   return Lookup::bracket ((Axis)scm_to_int (a), ly_scm2interval (iv),
                          scm_to_double (t),
@@ -317,18 +283,54 @@ 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_FIRST_SMOB(Stencil, stil);
+  LY_ASSERT_TYPE(scm_is_number, 2);
+  LY_ASSERT_TYPE(scm_is_number, 3);
+  LY_ASSERT_TYPE(scm_is_number, 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_FIRST_TYPE(is_number_pair, xext);
+  LY_ASSERT_TYPE(is_number_pair, 2);
+  LY_ASSERT_TYPE(scm_is_number, 3);
 
   return Lookup::round_filled_box (Box (ly_scm2interval (xext), ly_scm2interval (yext)),
                                   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_FIRST_TYPE(ly_is_symbol, symbol);
+  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 ();
+}