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--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "font-metric.hh"
  10 #include "stencil.hh"
  11
  12 /*
  13   TODO: naming add/combine.
  14  */
  15 /*
  16   UMGH. junkme!
  17
  18  */
  19 LY_DEFINE (ly_stencil_set_extent_x, "ly:stencil-set-extent!",
  20            3, 0, 0, (SCM stil, SCM axis, SCM np),
  21            "Set the extent of @var{stil} "
  22            "(@var{extent} must be a pair of numbers) "
  23            "in @var{axis} direction (0 or 1 for x- and y-axis respectively).")
  24 {
  25   Stencil *s = unsmob_stencil (stil);
  26   SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
  27   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
  28   SCM_ASSERT_TYPE (is_number_pair (np), np, SCM_ARG3, __FUNCTION__, "number pair");
  29
  30   Interval iv = ly_scm2interval (np);
  31   s->dim_[Axis (gh_scm2int (axis))] = iv;
  32
  33   return SCM_UNDEFINED;
  34 }
  35
  36 LY_DEFINE (ly_translate_stencil_axis, "ly:stencil-translate-axis",
  37            3, 0, 0, (SCM stil, SCM amount, SCM axis),
  38            "Return a copy of @var{stil} but translated by @var{amount} in @var{axis} direction.")
  39 {
  40   Stencil *s = unsmob_stencil (stil);
  41   SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
  42   SCM_ASSERT_TYPE (gh_number_p (amount), amount, SCM_ARG2, __FUNCTION__, "number pair");
  43   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
  44
  45   SCM new_s = s->smobbed_copy ();
  46   Stencil *q = unsmob_stencil (new_s);
  47   q->translate_axis (gh_scm2double (amount), Axis (gh_scm2int (axis)));
  48   return new_s;
  49
  50 }
  51
  52 LY_DEFINE (ly_translate_stencil, "ly:stencil-translate",
  53            2, 0, 0, (SCM stil, SCM offset),
  54            "Return a @var{stil}, "
  55            "but translated by @var{offset} (a pair of numbers).")
  56 {
  57   Stencil *s = unsmob_stencil (stil);
  58   SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
  59   SCM_ASSERT_TYPE (is_number_pair (offset), offset, SCM_ARG2, __FUNCTION__, "number pair");
  60   Offset o = ly_scm2offset (offset);
  61
  62   SCM new_s = s->smobbed_copy ();
  63   Stencil *q =unsmob_stencil (new_s);
  64   q->translate (o);
  65   return new_s;
  66 }
  67
  68 LY_DEFINE (ly_stencil_get_expr, "ly:stencil-get-expr",
  69            1, 0, 0, (SCM stil),
  70            "Return the expression of @var{stil}.")
  71 {
  72   Stencil *s = unsmob_stencil (stil);
  73   SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
  74   return s->get_expr ();
  75 }
  76
  77 LY_DEFINE (ly_stencil_get_extent, "ly:stencil-extent",
  78            2, 0, 0, (SCM stil, SCM axis),
  79            "Return a pair of numbers signifying the extent of @var{stil} in "
  80            "@var{axis} direction (0 or 1 for x and y axis respectively).")
  81 {
  82   Stencil *s = unsmob_stencil (stil);
  83   SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
  84   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
  85
  86   return ly_interval2scm (s->extent (Axis (gh_scm2int (axis))));
  87 }
  88
  89 LY_DEFINE (ly_stencil_moved_to_edge, "ly:stencil-moved-to-edge",
  90            4, 2, 0, (SCM first, SCM axis, SCM direction, SCM second,
  91                      SCM padding, SCM minimum),
  92            "Similar to @code{ly:stencil-combine-edge}, but returns "
  93            "@var{second} positioned to be next to @var{first}. ")
  94 {
  95   /*
  96     C&P from combine-at-edge.
  97    */
  98   Stencil *s1 = unsmob_stencil (first);
  99   Stencil *s2 = unsmob_stencil (second);
 100   Stencil first_stencil;
 101
 102   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
 103   SCM_ASSERT_TYPE (is_direction (direction), direction, SCM_ARG4, __FUNCTION__, "dir");
 104
 105   Real p = 0.0;
 106   if (padding != SCM_UNDEFINED)
 107     {
 108       SCM_ASSERT_TYPE (gh_number_p (padding), padding, SCM_ARG5, __FUNCTION__, "number");
 109       p = gh_scm2double (padding);
 110     }
 111   Real m = 0.0;
 112   if (minimum != SCM_UNDEFINED)
 113     {
 114       SCM_ASSERT_TYPE (gh_number_p (minimum), minimum, SCM_ARG6, __FUNCTION__, "number");
 115       m = gh_scm2double (minimum);
 116     }
 117
 118   if (s1)
 119     first_stencil = *s1;
 120
 121   if (s2)
 122     return first_stencil.moved_to_edge (Axis (gh_scm2int (axis)),
 123                                         Direction (gh_scm2int (direction)),
 124                                         *s2, p, m).smobbed_copy ();
 125   else
 126     return Stencil().smobbed_copy ();
 127 }
 128
 129
 130
 131 LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge",
 132            4, 2, 0,  (SCM first, SCM axis, SCM direction,
 133                       SCM second,
 134                       SCM padding,
 135                       SCM minimum),
 136            "Construct a stencil by putting @var{second} next to @var{first}. "
 137            "@var{axis} can be 0 (x-axis) or 1 (y-axis), "
 138            "@var{direction} can be -1 (left or down) or 1 (right or up). "
 139            "The stencils are juxtaposed with  @var{padding} as extra space. "
 140            "If this puts the reference points closer than @var{minimum}, "
 141            "they are moved by the latter amount.")
 142 {
 143   Stencil *s1 = unsmob_stencil (first);
 144   Stencil *s2 = unsmob_stencil (second);
 145   Stencil result;
 146
 147   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
 148   SCM_ASSERT_TYPE (is_direction (direction), direction, SCM_ARG4, __FUNCTION__, "dir");
 149
 150   Real p = 0.0;
 151   if (padding != SCM_UNDEFINED)
 152     {
 153       SCM_ASSERT_TYPE (gh_number_p (padding), padding, SCM_ARG5, __FUNCTION__, "number");
 154       p = gh_scm2double (padding);
 155     }
 156   Real m = 0.0;
 157   if (minimum != SCM_UNDEFINED)
 158     {
 159       SCM_ASSERT_TYPE (gh_number_p (minimum), minimum, SCM_ARG6, __FUNCTION__, "number");
 160       m = gh_scm2double (minimum);
 161     }
 162
 163   if (s1)
 164     result = *s1;
 165   if (s2)
 166     result.add_at_edge (Axis (gh_scm2int (axis)),
 167                         Direction (gh_scm2int (direction)), *s2, p, m);
 168
 169   return result.smobbed_copy ();
 170 }
 171
 172 LY_DEFINE (ly_stencil_add , "ly:stencil-add",
 173            0, 0, 1, (SCM args),
 174            "Combine stencils. Takes any number of arguments.")
 175 {
 176 #define FUNC_NAME __FUNCTION__
 177   SCM_VALIDATE_REST_ARGUMENT (args);
 178
 179   Stencil result;
 180
 181   while (!SCM_NULLP (args))
 182     {
 183       Stencil *s = unsmob_stencil (gh_car (args));
 184       if (!s)
 185         SCM_ASSERT_TYPE (s, gh_car (args), SCM_ARGn, __FUNCTION__, "Stencil");
 186
 187       result.add_stencil (*s);
 188       args = gh_cdr (args);
 189     }
 190
 191   return result.smobbed_copy ();
 192 }
 193
 194 LY_DEFINE (ly_make_stencil, "ly:make-stencil",
 195            3, 0, 0,  (SCM expr, SCM xext, SCM yext),
 196            " \n"
 197            "Stencils are a device independent output expressions."
 198            "They carry two pieces of information: \n\n"
 199            "1: a specification of how to print this object. "
 200            "This specification is processed by the output backends, "
 201            " for example @file{scm/output-tex.scm}.\n\n"
 202            "2: the vertical and horizontal extents of the object.\n\n")
 203 {
 204   SCM_ASSERT_TYPE (is_number_pair (xext), xext, SCM_ARG2, __FUNCTION__, "number pair");
 205   SCM_ASSERT_TYPE (is_number_pair (yext), yext, SCM_ARG3, __FUNCTION__, "number pair");
 206
 207   Box b (ly_scm2interval (xext), ly_scm2interval (yext));
 208   Stencil s (b, expr);
 209   return s.smobbed_copy ();
 210 }
 211
 212 SCM
 213 fontify_atom (Font_metric const *met, SCM f)
 214 {
 215   if (f == SCM_EOL)
 216     return f;
 217   else
 218     return  scm_list_n (ly_symbol2scm ("fontify"),
 219                         ly_quote_scm (met->description_), f, SCM_UNDEFINED);
 220 }
 221
 222 LY_DEFINE (ly_fontify_atom,"ly:fontify-atom",
 223            2, 0, 0, (SCM met, SCM f),
 224            "Add a font selection command for the font metric @var{met} "
 225            "to @var{f}.")
 226 {
 227   SCM_ASSERT_TYPE (unsmob_metrics (met), met, SCM_ARG1, __FUNCTION__, "font metric");
 228
 229   return fontify_atom (unsmob_metrics (met), f);
 230 }
 231
 232 LY_DEFINE (ly_align_to_x, "ly:stencil-align-to!",
 233            3, 0, 0, (SCM stil, SCM axis, SCM dir),
 234            "Align @var{stil} using its own extents. "
 235            "@var{dir} is a number -1, 1 are left and right respectively. "
 236            "Other values are interpolated (so 0 means the center. ")
 237 {
 238   SCM_ASSERT_TYPE (unsmob_stencil (stil), stil, SCM_ARG1, __FUNCTION__, "stencil");
 239   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
 240   SCM_ASSERT_TYPE (gh_number_p (dir), dir, SCM_ARG3, __FUNCTION__, "number");
 241
 242   unsmob_stencil (stil)->align_to ((Axis)gh_scm2int (axis),
 243                                    gh_scm2double (dir));
 244   return SCM_UNDEFINED;
 245 }