lily/stencil-scheme.cc

   1 /*
   2   stencil-scheme.cc -- implement Stencil scheme accessors
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9
  10 #include "font-metric.hh"
  11 #include "libc-extension.hh"
  12 #include "lookup.hh"
  13 #include "stencil.hh"
  14
  15 /*
  16   TODO: naming add/combine.
  17 */
  18
  19 LY_DEFINE (ly_stencil_translate_axis, "ly:stencil-translate-axis",
  20            3, 0, 0, (SCM stil, SCM amount, SCM axis),
  21            "Return a copy of @var{stil} but translated by @var{amount} in @var{axis} direction.")
  22 {
  23   Stencil *s = unsmob_stencil (stil);
  24   LY_ASSERT_SMOB (Stencil, stil, 1);
  25   LY_ASSERT_TYPE (scm_is_number, amount, 2);
  26   LY_ASSERT_TYPE (is_axis, axis, 3);
  27
  28   Real real_amount = scm_to_double (amount);
  29
  30   SCM new_s = s->smobbed_copy ();
  31   Stencil *q = unsmob_stencil (new_s);
  32   q->translate_axis (real_amount, Axis (scm_to_int (axis)));
  33   return new_s;
  34 }
  35
  36 LY_DEFINE (ly_stencil_translate, "ly:stencil-translate",
  37            2, 0, 0, (SCM stil, SCM offset),
  38            "Return a @var{stil}, "
  39            "but translated by @var{offset} (a pair of numbers).")
  40 {
  41   Stencil *s = unsmob_stencil (stil);
  42   LY_ASSERT_SMOB (Stencil, stil, 1);
  43   LY_ASSERT_TYPE (is_number_pair, offset, 2);
  44   Offset o = ly_scm2offset (offset);
  45
  46   SCM new_s = s->smobbed_copy ();
  47   Stencil *q = unsmob_stencil (new_s);
  48   q->translate (o);
  49   return new_s;
  50 }
  51
  52 LY_DEFINE (ly_stencil_expr, "ly:stencil-expr",
  53            1, 0, 0, (SCM stil),
  54            "Return the expression of @var{stil}.")
  55 {
  56   Stencil *s = unsmob_stencil (stil);
  57   LY_ASSERT_SMOB (Stencil, stil, 1);
  58   return s->expr ();
  59 }
  60
  61 LY_DEFINE (ly_stencil_extent, "ly:stencil-extent",
  62            2, 0, 0, (SCM stil, SCM axis),
  63            "Return a pair of numbers signifying the extent of @var{stil} in "
  64            "@var{axis} direction (0 or 1 for x and y axis respectively).")
  65 {
  66   Stencil *s = unsmob_stencil (stil);
  67   LY_ASSERT_SMOB (Stencil, stil, 1);
  68   LY_ASSERT_TYPE (is_axis, axis, 2);
  69
  70   return ly_interval2scm (s->extent (Axis (scm_to_int (axis))));
  71 }
  72
  73 LY_DEFINE (ly_stencil_empty_p, "ly:stencil-empty?",
  74            1, 0, 0, (SCM stil),
  75            "Return whether @var{stil} is empty ")
  76 {
  77   Stencil *s = unsmob_stencil (stil);
  78   LY_ASSERT_SMOB (Stencil, stil, 1);
  79   return scm_from_bool (s->is_empty ());
  80 }
  81
  82 LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge",
  83            4, 2, 0, (SCM first, SCM axis, SCM direction,
  84                      SCM second,
  85                      SCM padding,
  86                      SCM minimum),
  87            "Construct a stencil by putting @var{second} next to @var{first}. "
  88            "@var{axis} can be 0 (x-axis) or 1 (y-axis), "
  89            "@var{direction} can be -1 (left or down) or 1 (right or up). "
  90            "The stencils are juxtaposed with  @var{padding} as extra space. "
  91            "If this puts the reference points closer than @var{minimum}, "
  92            "they are moved by the latter amount."
  93            "@var{first} and @var{second} may also be '() or #f.")
  94 {
  95   Stencil *s1 = unsmob_stencil (first);
  96   Stencil *s2 = unsmob_stencil (second);
  97   Stencil result;
  98
  99   SCM_ASSERT_TYPE (s1 || first == SCM_BOOL_F || first == SCM_EOL,
 100                    first, SCM_ARG1, __FUNCTION__, "Stencil, #f or ()");
 101   SCM_ASSERT_TYPE (s2 || second == SCM_BOOL_F || second == SCM_EOL,
 102                    second, SCM_ARG4, __FUNCTION__, "Stencil, #f or ()");
 103   LY_ASSERT_TYPE (is_axis, axis,  2);
 104   LY_ASSERT_TYPE (is_direction, direction, 3);
 105
 106   Real p = 0.0;
 107   if (padding != SCM_UNDEFINED)
 108     {
 109       LY_ASSERT_TYPE (scm_is_number, padding, 5);
 110       p = scm_to_double (padding);
 111     }
 112   Real m = 0.0;
 113   if (minimum != SCM_UNDEFINED)
 114     {
 115       LY_ASSERT_TYPE (scm_is_number, minimum, 6);
 116       m = scm_to_double (minimum);
 117     }
 118
 119   if (s1)
 120     result = *s1;
 121
 122   if (s2)
 123     result.add_at_edge (Axis (scm_to_int (axis)),
 124                         Direction (scm_to_int (direction)), *s2, p);
 125
 126   return result.smobbed_copy ();
 127 }
 128
 129 LY_DEFINE (ly_stencil_add, "ly:stencil-add",
 130            0, 0, 1, (SCM args),
 131            "Combine stencils. Takes any number of arguments.")
 132 {
 133 #define FUNC_NAME __FUNCTION__
 134   SCM_VALIDATE_REST_ARGUMENT (args);
 135
 136   SCM expr = SCM_EOL;
 137   SCM *tail = &expr;
 138   Box extent;
 139   extent.set_empty ();
 140
 141   while (!SCM_NULLP (args))
 142     {
 143       Stencil *s = unsmob_stencil (scm_car (args));
 144       if (!s)
 145         SCM_ASSERT_TYPE (s, scm_car (args), SCM_ARGn, __FUNCTION__, "Stencil");
 146
 147       extent.unite (s->extent_box ());
 148       *tail = scm_cons (s->expr (), SCM_EOL);
 149       tail = SCM_CDRLOC (*tail);
 150       args = scm_cdr (args);
 151     }
 152
 153   expr = scm_cons (ly_symbol2scm ("combine-stencil"), expr);
 154   return Stencil (extent, expr).smobbed_copy ();
 155 }
 156
 157 LY_DEFINE (ly_make_stencil, "ly:make-stencil",
 158            1, 2, 0, (SCM expr, SCM xext, SCM yext),
 159            "Stencils are device independent output expressions.  "
 160            "They carry two pieces of information:\n"
 161
 162            "@enumerate\n"
 163
 164            "@item\n"
 165            "A specification of how to print this object.  "
 166            "This specification is processed by the output backends, "
 167            "for example @file{scm/output-ps.scm}.\n"
 168
 169            "@item\n"
 170            "The vertical and horizontal extents of the object, "
 171            "given as pairs.  "
 172            "If an extent is unspecified (or if you use "
 173            "@code{(1000 . -1000)} as its value), it is taken to be empty.\n"
 174
 175            "@end enumerate\n")
 176 {
 177   SCM_ASSERT_TYPE (!scm_is_pair (expr)
 178                    || is_stencil_head (scm_car (expr)),
 179                    expr, SCM_ARG1, __FUNCTION__, "registered stencil expression");
 180
 181
 182   Interval x;
 183   if (xext != SCM_UNDEFINED)
 184     {
 185       LY_ASSERT_TYPE (is_number_pair, xext, 2);
 186       x = ly_scm2interval (xext);
 187     }
 188
 189   Interval y;
 190   if (yext != SCM_UNDEFINED)
 191     {
 192       LY_ASSERT_TYPE (is_number_pair, yext, 3);
 193       y = ly_scm2interval (yext);
 194     }
 195
 196   Box b (x, y);
 197   Stencil s (b, expr);
 198   return s.smobbed_copy ();
 199 }
 200
 201 LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to",
 202            3, 0, 0, (SCM stil, SCM axis, SCM dir),
 203            "Align @var{stil} using its own extents. "
 204            "@var{dir} is a number -1, 1 are left and right respectively. "
 205            "Other values are interpolated (so 0 means the center).")
 206 {
 207   LY_ASSERT_SMOB (Stencil, stil, 1);
 208   LY_ASSERT_TYPE (is_axis, axis, 2);
 209   LY_ASSERT_TYPE (scm_is_number, dir, 3);
 210
 211   Stencil target = *unsmob_stencil (stil);
 212
 213   target.align_to ((Axis)scm_to_int (axis),
 214                    scm_to_double (dir));
 215   return target.smobbed_copy ();
 216 }
 217
 218 LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts",
 219            1, 0, 0, (SCM s),
 220            " Analyse @var{s}, and return a list of fonts used in @var{s}.")
 221 {
 222   LY_ASSERT_SMOB (Stencil, s, 1);
 223   Stencil *stil = unsmob_stencil (s);
 224   return find_expression_fonts (stil->expr ());
 225 }
 226
 227 LY_DEFINE (ly_stencil_in_color, "ly:stencil-in-color",
 228            4, 0, 0, (SCM stc, SCM r, SCM g, SCM b),
 229            "Put @var{stc} in a different color.")
 230 {
 231   LY_ASSERT_SMOB (Stencil, stc, 1);
 232   Stencil *stil = unsmob_stencil (stc);
 233   return Stencil (stil->extent_box (),
 234                   scm_list_3 (ly_symbol2scm ("color"),
 235                               scm_list_3 (r, g, b),
 236                               stil->expr ())).smobbed_copy ();
 237 }
 238
 239 struct Stencil_interpret_arguments
 240 {
 241   SCM func;
 242   SCM arg1;
 243 };
 244
 245 void stencil_interpret_in_scm (void *p, SCM expr)
 246 {
 247   Stencil_interpret_arguments *ap = (Stencil_interpret_arguments *) p;
 248   scm_call_2 (ap->func, ap->arg1, expr);
 249 }
 250
 251 LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression",
 252            4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset),
 253            "Parse EXPR, feed bits to FUNC with first arg ARG1")
 254 {
 255   LY_ASSERT_TYPE (ly_is_procedure, func, 2);
 256
 257   Stencil_interpret_arguments a;
 258   a.func = func;
 259   a.arg1 = arg1;
 260   Offset o = ly_scm2offset (offset);
 261
 262   interpret_stencil_expression (expr, stencil_interpret_in_scm, (void *) & a, o);
 263
 264   return SCM_UNSPECIFIED;
 265 }
 266
 267 LY_DEFINE (ly_bracket, "ly:bracket",
 268            4, 0, 0,
 269            (SCM a, SCM iv, SCM t, SCM p),
 270            "Make a bracket in direction @var{a}. The extent of the bracket is "
 271            "given by @var{iv}. The wings protude by an amount of @var{p}, which "
 272            "may be negative. The thickness is given by @var{t}.")
 273 {
 274   LY_ASSERT_TYPE (is_axis, a, 1);
 275   LY_ASSERT_TYPE (is_number_pair, iv, 2);
 276   LY_ASSERT_TYPE (scm_is_number, t,3);
 277   LY_ASSERT_TYPE (scm_is_number, p,4);
 278
 279   return Lookup::bracket ((Axis)scm_to_int (a), ly_scm2interval (iv),
 280                           scm_to_double (t),
 281                           scm_to_double (p),
 282                           0.95 * scm_to_double (t)).smobbed_copy ();
 283 }
 284
 285 LY_DEFINE (ly_stencil_rotate, "ly:stencil-rotate",
 286            4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y),
 287            "Return a @var{stil} rotated @var{angle} degrees around point (@var{x}, @var{y}).")
 288 {
 289   Stencil *s = unsmob_stencil (stil);
 290   LY_ASSERT_SMOB (Stencil, stil, 1);
 291   LY_ASSERT_TYPE (scm_is_number, angle, 2);
 292   LY_ASSERT_TYPE (scm_is_number, x,3);
 293   LY_ASSERT_TYPE (scm_is_number, y, 4);
 294   Real a = scm_to_double (angle);
 295   Real x_off = scm_to_double (x);
 296   Real y_off = scm_to_double (y);
 297
 298   SCM new_s = s->smobbed_copy ();
 299   Stencil *q = unsmob_stencil (new_s);
 300   q->rotate (a, Offset (x_off, y_off));
 301   return new_s;
 302 }
 303
 304 LY_DEFINE (ly_round_filled_box, "ly:round-filled-box",
 305            3, 0, 0,
 306            (SCM xext, SCM yext, SCM blot),
 307            "Make a @code{Stencil} "
 308            "that prints a black box of dimensions @var{xext}, "
 309            "@var{yext} and roundness @var{blot}.")
 310 {
 311   LY_ASSERT_TYPE (is_number_pair, xext, 1);
 312   LY_ASSERT_TYPE (is_number_pair, yext, 2);
 313   LY_ASSERT_TYPE (scm_is_number, blot, 3);
 314
 315   return Lookup::round_filled_box (Box (ly_scm2interval (xext), ly_scm2interval (yext)),
 316                                    scm_to_double (blot)).smobbed_copy ();
 317 }
 318
 319 LY_DEFINE (ly_register_stencil_expression, "ly:register-stencil-expression",
 320            1, 0, 0,
 321            (SCM symbol),
 322            "Add @var{symbol} as head of a stencil expression")
 323 {
 324   LY_ASSERT_TYPE (ly_is_symbol, symbol, 1);
 325   register_stencil_head (symbol);
 326   return SCM_UNSPECIFIED;
 327 }
 328
 329 LY_DEFINE (ly_all_stencil_expressions, "ly:all-stencil-expressions",
 330            0, 0, 0,
 331            (),
 332            "Return all symbols recognized as stencil expressions.")
 333 {
 334   return all_stencil_heads ();
 335 }