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, 1, 0, (SCM stil, SCM axis),
  88            "Return whether @var{stil} is empty.  If an optional"
  89            " @var{axis} is supplied, the emptiness check is"
  90            " restricted to that axis.")
  91 {
  92   Stencil *s = unsmob_stencil (stil);
  93   LY_ASSERT_SMOB (Stencil, stil, 1);
  94   if (SCM_UNBNDP (axis))
  95     return scm_from_bool (s->is_empty ());
  96   LY_ASSERT_TYPE (is_axis, axis, 2);
  97   return scm_from_bool (s->is_empty (Axis (scm_to_int (axis))));
  98 }
  99
 100 LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge",
 101            4, 1, 0, (SCM first, SCM axis, SCM direction,
 102                      SCM second,
 103                      SCM padding),
 104            "Construct a stencil by putting @var{second} next to @var{first}."
 105            "  @var{axis} can be 0 (x-axis) or@tie{}1 (y-axis)."
 106            "  @var{direction} can be -1 (left or down) or@tie{}1 (right or"
 107            " up).  The stencils are juxtaposed with @var{padding} as extra"
 108            " space.  @var{first} and @var{second} may also be @code{'()} or"
 109            " @code{#f}.")
 110 {
 111   Stencil *s1 = unsmob_stencil (first);
 112   Stencil *s2 = unsmob_stencil (second);
 113   Stencil result;
 114
 115   SCM_ASSERT_TYPE (s1 || first == SCM_BOOL_F || first == SCM_EOL,
 116                    first, SCM_ARG1, __FUNCTION__, "Stencil, #f or ()");
 117   SCM_ASSERT_TYPE (s2 || second == SCM_BOOL_F || second == SCM_EOL,
 118                    second, SCM_ARG4, __FUNCTION__, "Stencil, #f or ()");
 119   LY_ASSERT_TYPE (is_axis, axis, 2);
 120   LY_ASSERT_TYPE (is_direction, direction, 3);
 121
 122   Real p = 0.0;
 123   if (padding != SCM_UNDEFINED)
 124     {
 125       LY_ASSERT_TYPE (scm_is_number, padding, 5);
 126       p = scm_to_double (padding);
 127     }
 128
 129   if (s1)
 130     result = *s1;
 131
 132   if (s2)
 133     result.add_at_edge (Axis (scm_to_int (axis)),
 134                         Direction (scm_to_int (direction)), *s2, p);
 135
 136   return result.smobbed_copy ();
 137 }
 138
 139 LY_DEFINE (ly_stencil_add, "ly:stencil-add",
 140            0, 0, 1, (SCM args),
 141            "Combine stencils.  Takes any number of arguments.")
 142 {
 143 #define FUNC_NAME __FUNCTION__
 144   SCM_VALIDATE_REST_ARGUMENT (args);
 145
 146   SCM expr = SCM_EOL;
 147   SCM cs = ly_symbol2scm ("combine-stencil");
 148
 149   Box extent;
 150   extent.set_empty ();
 151
 152   while (!SCM_NULLP (args))
 153     {
 154       Stencil *s = unsmob_stencil (scm_car (args));
 155       if (!s)
 156         SCM_ASSERT_TYPE (s, scm_car (args), SCM_ARGn, __FUNCTION__, "Stencil");
 157
 158       extent.unite (s->extent_box ());
 159       if (scm_is_pair (s->expr ()) && scm_is_eq (cs, s->expr ()))
 160         {
 161           expr = scm_reverse_x (scm_list_copy (scm_cdr (s->expr ())),
 162                                 expr);
 163         }
 164       else
 165         expr = scm_cons (s->expr (), expr);
 166
 167       args = scm_cdr (args);
 168     }
 169
 170   expr = scm_cons (cs, scm_reverse_x (expr, SCM_EOL));
 171   return Stencil (extent, expr).smobbed_copy ();
 172 }
 173
 174 LY_DEFINE (ly_make_stencil, "ly:make-stencil",
 175            1, 2, 0, (SCM expr, SCM xext, SCM yext),
 176            "Stencils are device independent output expressions."
 177            "  They carry two pieces of information:\n"
 178            "\n"
 179            "@enumerate\n"
 180            "@item\n"
 181            "A specification of how to print this object."
 182            "  This specification is processed by the output backends,"
 183            " for example @file{scm/output-ps.scm}.\n"
 184            "\n"
 185            "@item\n"
 186            "The vertical and horizontal extents of the object, given as"
 187            " pairs.  If an extent is unspecified (or if you use"
 188            " @code{empty-interval} as its value), it is taken to be empty.\n"
 189            "@end enumerate\n")
 190 {
 191   SCM_ASSERT_TYPE (!scm_is_pair (expr)
 192                    || is_stencil_head (scm_car (expr)),
 193                    expr, SCM_ARG1, __FUNCTION__, "registered stencil expression");
 194
 195   Interval x;
 196   if (xext != SCM_UNDEFINED)
 197     {
 198       LY_ASSERT_TYPE (is_number_pair, xext, 2);
 199       x = ly_scm2interval (xext);
 200     }
 201
 202   Interval y;
 203   if (yext != SCM_UNDEFINED)
 204     {
 205       LY_ASSERT_TYPE (is_number_pair, yext, 3);
 206       y = ly_scm2interval (yext);
 207     }
 208
 209   Box b (x, y);
 210   Stencil s (b, expr);
 211   return s.smobbed_copy ();
 212 }
 213
 214 LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to",
 215            3, 0, 0, (SCM stil, SCM axis, SCM dir),
 216            "Align @var{stil} using its own extents.  @var{dir} is a number."
 217            "  @w{@code{-1}} and @code{1} are left and right, respectively."
 218            "  Other values are interpolated (so @code{0} means the center).")
 219 {
 220   LY_ASSERT_SMOB (Stencil, stil, 1);
 221   LY_ASSERT_TYPE (is_axis, axis, 2);
 222   LY_ASSERT_TYPE (scm_is_number, dir, 3);
 223
 224   Stencil target = *unsmob_stencil (stil);
 225
 226   target.align_to ((Axis)scm_to_int (axis),
 227                    scm_to_double (dir));
 228   return target.smobbed_copy ();
 229 }
 230
 231 LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts",
 232            1, 0, 0, (SCM s),
 233            "Analyze @var{s}, and return a list of fonts used"
 234            " in@tie{}@var{s}.")
 235 {
 236   LY_ASSERT_SMOB (Stencil, s, 1);
 237   Stencil *stil = unsmob_stencil (s);
 238   return find_expression_fonts (stil->expr ());
 239 }
 240
 241 LY_DEFINE (ly_stencil_in_color, "ly:stencil-in-color",
 242            4, 0, 0, (SCM stc, SCM r, SCM g, SCM b),
 243            "Put @var{stc} in a different color.")
 244 {
 245   LY_ASSERT_SMOB (Stencil, stc, 1);
 246   Stencil *stil = unsmob_stencil (stc);
 247   return Stencil (stil->extent_box (),
 248                   scm_list_3 (ly_symbol2scm ("color"),
 249                               scm_list_3 (r, g, b),
 250                               stil->expr ())).smobbed_copy ();
 251 }
 252
 253 struct Stencil_interpret_arguments
 254 {
 255   SCM func;
 256   SCM arg1;
 257 };
 258
 259 void stencil_interpret_in_scm (void *p, SCM expr)
 260 {
 261   Stencil_interpret_arguments *ap = (Stencil_interpret_arguments *) p;
 262   scm_call_2 (ap->func, ap->arg1, expr);
 263 }
 264
 265 LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression",
 266            4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset),
 267            "Parse @var{expr}, feed bits to @var{func} with first arg"
 268            " @var{arg1} having offset @var{offset}.")
 269 {
 270   LY_ASSERT_TYPE (ly_is_procedure, func, 2);
 271
 272   Stencil_interpret_arguments a;
 273   a.func = func;
 274   a.arg1 = arg1;
 275   Offset o = ly_scm2offset (offset);
 276
 277   interpret_stencil_expression (expr, stencil_interpret_in_scm, (void *) & a, o);
 278
 279   return SCM_UNSPECIFIED;
 280 }
 281
 282 LY_DEFINE (ly_bracket, "ly:bracket",
 283            4, 0, 0,
 284            (SCM a, SCM iv, SCM t, SCM p),
 285            "Make a bracket in direction@tie{}@var{a}.  The extent of the"
 286            " bracket is given by @var{iv}.  The wings protrude by an amount"
 287            " of@tie{}@var{p}, which may be negative.  The thickness is given"
 288            " by@tie{}@var{t}.")
 289 {
 290   LY_ASSERT_TYPE (is_axis, a, 1);
 291   LY_ASSERT_TYPE (is_number_pair, iv, 2);
 292   LY_ASSERT_TYPE (scm_is_number, t, 3);
 293   LY_ASSERT_TYPE (scm_is_number, p, 4);
 294
 295   return Lookup::bracket ((Axis)scm_to_int (a), ly_scm2interval (iv),
 296                           scm_to_double (t),
 297                           scm_to_double (p),
 298                           0.95 * scm_to_double (t)).smobbed_copy ();
 299 }
 300
 301 LY_DEFINE (ly_stencil_rotate, "ly:stencil-rotate",
 302            4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y),
 303            "Return a stencil @var{stil} rotated @var{angle} degrees around"
 304            " the relative offset (@var{x}, @var{y}).  E.g., an offset of"
 305            " (-1, 1) will rotate the stencil around the left upper corner.")
 306 {
 307   Stencil *s = unsmob_stencil (stil);
 308   LY_ASSERT_SMOB (Stencil, stil, 1);
 309   LY_ASSERT_TYPE (scm_is_number, angle, 2);
 310   LY_ASSERT_TYPE (scm_is_number, x, 3);
 311   LY_ASSERT_TYPE (scm_is_number, y, 4);
 312   Real a = scm_to_double (angle);
 313   Real x_off = scm_to_double (x);
 314   Real y_off = scm_to_double (y);
 315
 316   SCM new_s = s->smobbed_copy ();
 317   Stencil *q = unsmob_stencil (new_s);
 318   q->rotate_degrees (a, Offset (x_off, y_off));
 319   return new_s;
 320 }
 321
 322 LY_DEFINE (ly_stencil_rotate_absolute, "ly:stencil-rotate-absolute",
 323            4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y),
 324            "Return a stencil @var{stil} rotated @var{angle} degrees around"
 325            " point (@var{x}, @var{y}), given in absolute coordinates.")
 326 {
 327   Stencil *s = unsmob_stencil (stil);
 328   LY_ASSERT_SMOB (Stencil, stil, 1);
 329   LY_ASSERT_TYPE (scm_is_number, angle, 2);
 330   LY_ASSERT_TYPE (scm_is_number, x, 3);
 331   LY_ASSERT_TYPE (scm_is_number, y, 4);
 332   Real a = scm_to_double (angle);
 333   Real x_off = scm_to_double (x);
 334   Real y_off = scm_to_double (y);
 335
 336   SCM new_s = s->smobbed_copy ();
 337   Stencil *q = unsmob_stencil (new_s);
 338   q->rotate_degrees_absolute (a, Offset (x_off, y_off));
 339   return new_s;
 340 }
 341
 342 LY_DEFINE (ly_round_filled_box, "ly:round-filled-box",
 343            3, 0, 0,
 344            (SCM xext, SCM yext, SCM blot),
 345            "Make a @code{Stencil} object that prints a black box of"
 346            " dimensions @var{xext}, @var{yext} and roundness @var{blot}.")
 347 {
 348   LY_ASSERT_TYPE (is_number_pair, xext, 1);
 349   LY_ASSERT_TYPE (is_number_pair, yext, 2);
 350   LY_ASSERT_TYPE (scm_is_number, blot, 3);
 351
 352   return Lookup::round_filled_box (Box (ly_scm2interval (xext), ly_scm2interval (yext)),
 353                                    scm_to_double (blot)).smobbed_copy ();
 354 }
 355
 356 LY_DEFINE (ly_round_filled_polygon, "ly:round-filled-polygon",
 357            2, 0, 0,
 358            (SCM points, SCM blot),
 359            "Make a @code{Stencil} object that prints a black polygon with"
 360            " corners at the points defined by @var{points} (list of coordinate"
 361            " pairs) and roundness @var{blot}.")
 362 {
 363   SCM_ASSERT_TYPE (scm_ilength (points) > 0, points, SCM_ARG1, __FUNCTION__, "list of coordinate pairs");
 364   LY_ASSERT_TYPE (scm_is_number, blot, 2);
 365   vector<Offset> pts;
 366   for (SCM p = points; scm_is_pair (p); p = scm_cdr (p))
 367     {
 368       SCM scm_pt = scm_car (p);
 369       if (scm_is_pair (scm_pt))
 370         {
 371           pts.push_back (ly_scm2offset (scm_pt));
 372         }
 373       else
 374         {
 375           // TODO: Print out warning
 376         }
 377     }
 378   return Lookup::round_filled_polygon (pts, scm_to_double (blot)).smobbed_copy ();
 379 }
 380
 381 LY_DEFINE (ly_register_stencil_expression, "ly:register-stencil-expression",
 382            1, 0, 0,
 383            (SCM symbol),
 384            "Add @var{symbol} as head of a stencil expression.")
 385 {
 386   LY_ASSERT_TYPE (ly_is_symbol, symbol, 1);
 387   register_stencil_head (symbol);
 388   return SCM_UNSPECIFIED;
 389 }
 390
 391 LY_DEFINE (ly_all_stencil_expressions, "ly:all-stencil-expressions",
 392            0, 0, 0,
 393            (),
 394            "Return all symbols recognized as stencil expressions.")
 395 {
 396   return all_stencil_heads ();
 397 }
 398
 399 LY_DEFINE (ly_stencil_scale, "ly:stencil-scale",
 400            3, 0, 0, (SCM stil, SCM x, SCM y),
 401            "Scale @var{stil} using the horizontal and vertical scaling"
 402            " factors @var{x} and @var{y}.")
 403 {
 404   Stencil *s = unsmob_stencil (stil);
 405   LY_ASSERT_SMOB (Stencil, stil, 1);
 406   LY_ASSERT_TYPE (scm_is_number, x, 2);
 407   LY_ASSERT_TYPE (scm_is_number, y, 3);
 408
 409   SCM new_s = s->smobbed_copy ();
 410   Stencil *q = unsmob_stencil (new_s);
 411
 412   q->scale (scm_to_double (x), scm_to_double (y));
 413   return new_s;
 414 }