lily/stencil-scheme.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "font-metric.hh"
  21 #include "libc-extension.hh"
  22 #include "lookup.hh"
  23 #include "stencil.hh"
  24
  25 /*
  26   TODO: naming add/combine.
  27 */
  28
  29 LY_DEFINE (ly_stencil_translate_axis, "ly:stencil-translate-axis",
  30            3, 0, 0, (SCM stil, SCM amount, SCM axis),
  31            "Return a copy of @var{stil} but translated by @var{amount}"
  32            " in @var{axis} direction.")
  33 {
  34   Stencil *s = unsmob_stencil (stil);
  35   LY_ASSERT_SMOB (Stencil, stil, 1);
  36   LY_ASSERT_TYPE (scm_is_number, amount, 2);
  37
  38   LY_ASSERT_TYPE (is_axis, axis, 3);
  39
  40   Real real_amount = scm_to_double (amount);
  41
  42   SCM new_s = s->smobbed_copy ();
  43   Stencil *q = unsmob_stencil (new_s);
  44   q->translate_axis (real_amount, Axis (scm_to_int (axis)));
  45   return new_s;
  46 }
  47
  48 LY_DEFINE (ly_stencil_translate, "ly:stencil-translate",
  49            2, 0, 0, (SCM stil, SCM offset),
  50            "Return a @var{stil}, but translated by @var{offset}"
  51            " (a pair of numbers).")
  52 {
  53   Stencil *s = unsmob_stencil (stil);
  54   LY_ASSERT_SMOB (Stencil, stil, 1);
  55   LY_ASSERT_TYPE (is_number_pair, offset, 2);
  56   Offset o = ly_scm2offset (offset);
  57
  58   SCM new_s = s->smobbed_copy ();
  59   Stencil *q = unsmob_stencil (new_s);
  60   q->translate (o);
  61   return new_s;
  62 }
  63
  64 LY_DEFINE (ly_stencil_expr, "ly:stencil-expr",
  65            1, 0, 0, (SCM stil),
  66            "Return the expression of @var{stil}.")
  67 {
  68   Stencil *s = unsmob_stencil (stil);
  69   LY_ASSERT_SMOB (Stencil, stil, 1);
  70   return s->expr ();
  71 }
  72
  73 LY_DEFINE (ly_stencil_extent, "ly:stencil-extent",
  74            2, 0, 0, (SCM stil, SCM axis),
  75            "Return a pair of numbers signifying the extent of @var{stil} in"
  76            " @var{axis} direction (@code{0} or @code{1} for x and"
  77            " y@tie{}axis, respectively).")
  78 {
  79   Stencil *s = unsmob_stencil (stil);
  80   LY_ASSERT_SMOB (Stencil, stil, 1);
  81   LY_ASSERT_TYPE (is_axis, axis, 2);
  82
  83   return ly_interval2scm (s->extent (Axis (scm_to_int (axis))));
  84 }
  85
  86 LY_DEFINE (ly_stencil_empty_p, "ly:stencil-empty?",
  87            1, 0, 0, (SCM stil),
  88            "Return whether @var{stil} is empty.")
  89 {
  90   Stencil *s = unsmob_stencil (stil);
  91   LY_ASSERT_SMOB (Stencil, stil, 1);
  92   return scm_from_bool (s->is_empty ());
  93 }
  94
  95 LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge",
  96            4, 1, 0, (SCM first, SCM axis, SCM direction,
  97                      SCM second,
  98                      SCM padding),
  99            "Construct a stencil by putting @var{second} next to @var{first}."
 100            "  @var{axis} can be 0 (x-axis) or@tie{}1 (y-axis)."
 101            "  @var{direction} can be -1 (left or down) or@tie{}1 (right or"
 102            " up).  The stencils are juxtaposed with @var{padding} as extra"
 103            " space.  @var{first} and @var{second} may also be @code{'()} or"
 104            " @code{#f}.")
 105 {
 106   Stencil *s1 = unsmob_stencil (first);
 107   Stencil *s2 = unsmob_stencil (second);
 108   Stencil result;
 109
 110   SCM_ASSERT_TYPE (s1 || first == SCM_BOOL_F || first == SCM_EOL,
 111                    first, SCM_ARG1, __FUNCTION__, "Stencil, #f or ()");
 112   SCM_ASSERT_TYPE (s2 || second == SCM_BOOL_F || second == SCM_EOL,
 113                    second, SCM_ARG4, __FUNCTION__, "Stencil, #f or ()");
 114   LY_ASSERT_TYPE (is_axis, axis, 2);
 115   LY_ASSERT_TYPE (is_direction, direction, 3);
 116
 117   Real p = 0.0;
 118   if (padding != SCM_UNDEFINED)
 119     {
 120       LY_ASSERT_TYPE (scm_is_number, padding, 5);
 121       p = scm_to_double (padding);
 122     }
 123
 124   if (s1)
 125     result = *s1;
 126
 127   if (s2)
 128     result.add_at_edge (Axis (scm_to_int (axis)),
 129                         Direction (scm_to_int (direction)), *s2, p);
 130
 131   return result.smobbed_copy ();
 132 }
 133
 134 LY_DEFINE (ly_stencil_add, "ly:stencil-add",
 135            0, 0, 1, (SCM args),
 136            "Combine stencils.  Takes any number of arguments.")
 137 {
 138 #define FUNC_NAME __FUNCTION__
 139   SCM_VALIDATE_REST_ARGUMENT (args);
 140
 141   SCM expr = SCM_EOL;
 142   SCM cs = ly_symbol2scm ("combine-stencil");
 143
 144   Box extent;
 145   extent.set_empty ();
 146
 147   while (!SCM_NULLP (args))
 148     {
 149       Stencil *s = unsmob_stencil (scm_car (args));
 150       if (!s)
 151         SCM_ASSERT_TYPE (s, scm_car (args), SCM_ARGn, __FUNCTION__, "Stencil");
 152
 153       extent.unite (s->extent_box ());
 154       if (scm_is_pair (s->expr ()) && scm_is_eq (cs, s->expr ()))
 155         {
 156           expr = scm_reverse_x (scm_list_copy (scm_cdr (s->expr ())),
 157                                 expr);
 158         }
 159       else
 160         expr = scm_cons (s->expr (), expr);
 161
 162       args = scm_cdr (args);
 163     }
 164
 165   expr = scm_cons (cs, scm_reverse_x (expr, SCM_EOL));
 166   return Stencil (extent, expr).smobbed_copy ();
 167 }
 168
 169 LY_DEFINE (ly_make_stencil, "ly:make-stencil",
 170            1, 2, 0, (SCM expr, SCM xext, SCM yext),
 171            "Stencils are device independent output expressions."
 172            "  They carry two pieces of information:\n"
 173            "\n"
 174            "@enumerate\n"
 175            "@item\n"
 176            "A specification of how to print this object."
 177            "  This specification is processed by the output backends,"
 178            " for example @file{scm/output-ps.scm}.\n"
 179            "\n"
 180            "@item\n"
 181            "The vertical and horizontal extents of the object, given as"
 182            " pairs.  If an extent is unspecified (or if you use"
 183            " @code{empty-interval} as its value), it is taken to be empty.\n"
 184            "@end enumerate\n")
 185 {
 186   SCM_ASSERT_TYPE (!scm_is_pair (expr)
 187                    || is_stencil_head (scm_car (expr)),
 188                    expr, SCM_ARG1, __FUNCTION__, "registered stencil expression");
 189
 190   Interval x;
 191   if (xext != SCM_UNDEFINED)
 192     {
 193       LY_ASSERT_TYPE (is_number_pair, xext, 2);
 194       x = ly_scm2interval (xext);
 195     }
 196
 197   Interval y;
 198   if (yext != SCM_UNDEFINED)
 199     {
 200       LY_ASSERT_TYPE (is_number_pair, yext, 3);
 201       y = ly_scm2interval (yext);
 202     }
 203
 204   Box b (x, y);
 205   Stencil s (b, expr);
 206   return s.smobbed_copy ();
 207 }
 208
 209 LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to",
 210            3, 0, 0, (SCM stil, SCM axis, SCM dir),
 211            "Align @var{stil} using its own extents.  @var{dir} is a number."
 212            "  @w{@code{-1}} and @code{1} are left and right, respectively."
 213            "  Other values are interpolated (so @code{0} means the center).")
 214 {
 215   LY_ASSERT_SMOB (Stencil, stil, 1);
 216   LY_ASSERT_TYPE (is_axis, axis, 2);
 217   LY_ASSERT_TYPE (scm_is_number, dir, 3);
 218
 219   Stencil target = *unsmob_stencil (stil);
 220
 221   target.align_to ((Axis)scm_to_int (axis),
 222                    scm_to_double (dir));
 223   return target.smobbed_copy ();
 224 }
 225
 226 LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts",
 227            1, 0, 0, (SCM s),
 228            "Analyze @var{s}, and return a list of fonts used"
 229            " in@tie{}@var{s}.")
 230 {
 231   LY_ASSERT_SMOB (Stencil, s, 1);
 232   Stencil *stil = unsmob_stencil (s);
 233   return find_expression_fonts (stil->expr ());
 234 }
 235
 236 LY_DEFINE (ly_stencil_in_color, "ly:stencil-in-color",
 237            4, 0, 0, (SCM stc, SCM r, SCM g, SCM b),
 238            "Put @var{stc} in a different color.")
 239 {
 240   LY_ASSERT_SMOB (Stencil, stc, 1);
 241   Stencil *stil = unsmob_stencil (stc);
 242   return Stencil (stil->extent_box (),
 243                   scm_list_3 (ly_symbol2scm ("color"),
 244                               scm_list_3 (r, g, b),
 245                               stil->expr ())).smobbed_copy ();
 246 }
 247
 248 struct Stencil_interpret_arguments
 249 {
 250   SCM func;
 251   SCM arg1;
 252 };
 253
 254 void stencil_interpret_in_scm (void *p, SCM expr)
 255 {
 256   Stencil_interpret_arguments *ap = (Stencil_interpret_arguments *) p;
 257   scm_call_2 (ap->func, ap->arg1, expr);
 258 }
 259
 260 LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression",
 261            4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset),
 262            "Parse @var{expr}, feed bits to @var{func} with first arg"
 263            " @var{arg1} having offset @var{offset}.")
 264 {
 265   LY_ASSERT_TYPE (ly_is_procedure, func, 2);
 266
 267   Stencil_interpret_arguments a;
 268   a.func = func;
 269   a.arg1 = arg1;
 270   Offset o = ly_scm2offset (offset);
 271
 272   interpret_stencil_expression (expr, stencil_interpret_in_scm, (void *) & a, o);
 273
 274   return SCM_UNSPECIFIED;
 275 }
 276
 277 LY_DEFINE (ly_bracket, "ly:bracket",
 278            4, 0, 0,
 279            (SCM a, SCM iv, SCM t, SCM p),
 280            "Make a bracket in direction@tie{}@var{a}.  The extent of the"
 281            " bracket is given by @var{iv}.  The wings protrude by an amount"
 282            " of@tie{}@var{p}, which may be negative.  The thickness is given"
 283            " by@tie{}@var{t}.")
 284 {
 285   LY_ASSERT_TYPE (is_axis, a, 1);
 286   LY_ASSERT_TYPE (is_number_pair, iv, 2);
 287   LY_ASSERT_TYPE (scm_is_number, t, 3);
 288   LY_ASSERT_TYPE (scm_is_number, p, 4);
 289
 290   return Lookup::bracket ((Axis)scm_to_int (a), ly_scm2interval (iv),
 291                           scm_to_double (t),
 292                           scm_to_double (p),
 293                           0.95 * scm_to_double (t)).smobbed_copy ();
 294 }
 295
 296 LY_DEFINE (ly_stencil_rotate, "ly:stencil-rotate",
 297            4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y),
 298            "Return a stencil @var{stil} rotated @var{angle} degrees around"
 299            " the relative offset (@var{x}, @var{y}).  E.g., an offset of"
 300            " (-1, 1) will rotate the stencil around the left upper corner.")
 301 {
 302   Stencil *s = unsmob_stencil (stil);
 303   LY_ASSERT_SMOB (Stencil, stil, 1);
 304   LY_ASSERT_TYPE (scm_is_number, angle, 2);
 305   LY_ASSERT_TYPE (scm_is_number, x, 3);
 306   LY_ASSERT_TYPE (scm_is_number, y, 4);
 307   Real a = scm_to_double (angle);
 308   Real x_off = scm_to_double (x);
 309   Real y_off = scm_to_double (y);
 310
 311   SCM new_s = s->smobbed_copy ();
 312   Stencil *q = unsmob_stencil (new_s);
 313   q->rotate_degrees (a, Offset (x_off, y_off));
 314   return new_s;
 315 }
 316
 317 LY_DEFINE (ly_stencil_rotate_absolute, "ly:stencil-rotate-absolute",
 318            4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y),
 319            "Return a stencil @var{stil} rotated @var{angle} degrees around"
 320            " point (@var{x}, @var{y}), given in absolute coordinates.")
 321 {
 322   Stencil *s = unsmob_stencil (stil);
 323   LY_ASSERT_SMOB (Stencil, stil, 1);
 324   LY_ASSERT_TYPE (scm_is_number, angle, 2);
 325   LY_ASSERT_TYPE (scm_is_number, x, 3);
 326   LY_ASSERT_TYPE (scm_is_number, y, 4);
 327   Real a = scm_to_double (angle);
 328   Real x_off = scm_to_double (x);
 329   Real y_off = scm_to_double (y);
 330
 331   SCM new_s = s->smobbed_copy ();
 332   Stencil *q = unsmob_stencil (new_s);
 333   q->rotate_degrees_absolute (a, Offset (x_off, y_off));
 334   return new_s;
 335 }
 336
 337 LY_DEFINE (ly_round_filled_box, "ly:round-filled-box",
 338            3, 0, 0,
 339            (SCM xext, SCM yext, SCM blot),
 340            "Make a @code{Stencil} object that prints a black box of"
 341            " dimensions @var{xext}, @var{yext} and roundness @var{blot}.")
 342 {
 343   LY_ASSERT_TYPE (is_number_pair, xext, 1);
 344   LY_ASSERT_TYPE (is_number_pair, yext, 2);
 345   LY_ASSERT_TYPE (scm_is_number, blot, 3);
 346
 347   return Lookup::round_filled_box (Box (ly_scm2interval (xext), ly_scm2interval (yext)),
 348                                    scm_to_double (blot)).smobbed_copy ();
 349 }
 350
 351 LY_DEFINE (ly_round_filled_polygon, "ly:round-filled-polygon",
 352            2, 0, 0,
 353            (SCM points, SCM blot),
 354            "Make a @code{Stencil} object that prints a black polygon with"
 355            " corners at the points defined by @var{points} (list of coordinate"
 356            " pairs) and roundness @var{blot}.")
 357 {
 358   SCM_ASSERT_TYPE (scm_ilength (points) > 0, points, SCM_ARG1, __FUNCTION__, "list of coordinate pairs");
 359   LY_ASSERT_TYPE (scm_is_number, blot, 2);
 360   vector<Offset> pts;
 361   for (SCM p = points; scm_is_pair (p); p = scm_cdr (p))
 362     {
 363       SCM scm_pt = scm_car (p);
 364       if (scm_is_pair (scm_pt))
 365         {
 366           pts.push_back (ly_scm2offset (scm_pt));
 367         }
 368       else
 369         {
 370           // TODO: Print out warning
 371         }
 372     }
 373   return Lookup::round_filled_polygon (pts, scm_to_double (blot)).smobbed_copy ();
 374 }
 375
 376 LY_DEFINE (ly_register_stencil_expression, "ly:register-stencil-expression",
 377            1, 0, 0,
 378            (SCM symbol),
 379            "Add @var{symbol} as head of a stencil expression.")
 380 {
 381   LY_ASSERT_TYPE (ly_is_symbol, symbol, 1);
 382   register_stencil_head (symbol);
 383   return SCM_UNSPECIFIED;
 384 }
 385
 386 LY_DEFINE (ly_all_stencil_expressions, "ly:all-stencil-expressions",
 387            0, 0, 0,
 388            (),
 389            "Return all symbols recognized as stencil expressions.")
 390 {
 391   return all_stencil_heads ();
 392 }
 393
 394 LY_DEFINE (ly_stencil_scale, "ly:stencil-scale",
 395            3, 0, 0, (SCM stil, SCM x, SCM y),
 396            "Scale @var{stil} using the horizontal and vertical scaling"
 397            " factors @var{x} and @var{y}.")
 398 {
 399   Stencil *s = unsmob_stencil (stil);
 400   LY_ASSERT_SMOB (Stencil, stil, 1);
 401   LY_ASSERT_TYPE (scm_is_number, x, 2);
 402   LY_ASSERT_TYPE (scm_is_number, y, 3);
 403
 404   SCM new_s = s->smobbed_copy ();
 405   Stencil *q = unsmob_stencil (new_s);
 406
 407   q->scale (scm_to_double (x), scm_to_double (y));
 408   return new_s;
 409 }