2 stencil-scheme.cc -- implement Stencil scheme accessors
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "font-metric.hh"
11 #include "libc-extension.hh"
16 TODO: naming add/combine.
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.")
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);
28 Real real_amount = scm_to_double (amount);
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)));
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).")
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);
46 SCM new_s = s->smobbed_copy ();
47 Stencil *q = unsmob_stencil (new_s);
52 LY_DEFINE (ly_stencil_expr, "ly:stencil-expr",
54 "Return the expression of @var{stil}.")
56 Stencil *s = unsmob_stencil (stil);
57 LY_ASSERT_SMOB (Stencil, stil, 1);
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).")
66 Stencil *s = unsmob_stencil (stil);
67 LY_ASSERT_SMOB (Stencil, stil, 1);
68 LY_ASSERT_TYPE (is_axis, axis, 2);
70 return ly_interval2scm (s->extent (Axis (scm_to_int (axis))));
73 LY_DEFINE (ly_stencil_empty_p, "ly:stencil-empty?",
75 "Return whether @var{stil} is empty ")
77 Stencil *s = unsmob_stencil (stil);
78 LY_ASSERT_SMOB (Stencil, stil, 1);
79 return scm_from_bool (s->is_empty ());
82 LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge",
83 4, 2, 0, (SCM first, SCM axis, SCM direction,
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.")
95 Stencil *s1 = unsmob_stencil (first);
96 Stencil *s2 = unsmob_stencil (second);
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);
107 if (padding != SCM_UNDEFINED)
109 LY_ASSERT_TYPE (scm_is_number, padding, 5);
110 p = scm_to_double (padding);
113 if (minimum != SCM_UNDEFINED)
115 LY_ASSERT_TYPE (scm_is_number, minimum, 6);
116 m = scm_to_double (minimum);
123 result.add_at_edge (Axis (scm_to_int (axis)),
124 Direction (scm_to_int (direction)), *s2, p);
126 return result.smobbed_copy ();
129 LY_DEFINE (ly_stencil_add, "ly:stencil-add",
131 "Combine stencils. Takes any number of arguments.")
133 #define FUNC_NAME __FUNCTION__
134 SCM_VALIDATE_REST_ARGUMENT (args);
141 while (!SCM_NULLP (args))
143 Stencil *s = unsmob_stencil (scm_car (args));
145 SCM_ASSERT_TYPE (s, scm_car (args), SCM_ARGn, __FUNCTION__, "Stencil");
147 extent.unite (s->extent_box ());
148 *tail = scm_cons (s->expr (), SCM_EOL);
149 tail = SCM_CDRLOC (*tail);
150 args = scm_cdr (args);
153 expr = scm_cons (ly_symbol2scm ("combine-stencil"), expr);
154 return Stencil (extent, expr).smobbed_copy ();
157 LY_DEFINE (ly_make_stencil, "ly:make-stencil",
158 1, 2, 0, (SCM expr, SCM xext, SCM yext),
160 "Stencils are a device independent output expressions."
161 "They carry two pieces of information: \n\n"
162 "1: a specification of how to print this object. "
163 "This specification is processed by the output backends, "
164 " for example @file{scm/output-ps.scm}.\n\n"
165 "2: the vertical and horizontal extents of the object.\n\n"
166 "If the extents are unspecified, they are taken to be empty."
169 SCM_ASSERT_TYPE (!scm_is_pair (expr)
170 || is_stencil_head (scm_car (expr)),
171 expr, SCM_ARG1, __FUNCTION__, "registered stencil expression");
175 if (xext != SCM_UNDEFINED)
177 LY_ASSERT_TYPE (is_number_pair, xext, 2);
178 x = ly_scm2interval (xext);
182 if (yext != SCM_UNDEFINED)
184 LY_ASSERT_TYPE (is_number_pair, yext, 3);
185 y = ly_scm2interval (yext);
190 return s.smobbed_copy ();
193 LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to",
194 3, 0, 0, (SCM stil, SCM axis, SCM dir),
195 "Align @var{stil} using its own extents. "
196 "@var{dir} is a number -1, 1 are left and right respectively. "
197 "Other values are interpolated (so 0 means the center).")
199 LY_ASSERT_SMOB (Stencil, stil, 1);
200 LY_ASSERT_TYPE (is_axis, axis, 2);
201 LY_ASSERT_TYPE (scm_is_number, dir, 3);
203 Stencil target = *unsmob_stencil (stil);
205 target.align_to ((Axis)scm_to_int (axis),
206 scm_to_double (dir));
207 return target.smobbed_copy ();
210 LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts",
212 " Analyse @var{s}, and return a list of fonts used in @var{s}.")
214 LY_ASSERT_SMOB (Stencil, s, 1);
215 Stencil *stil = unsmob_stencil (s);
216 return find_expression_fonts (stil->expr ());
219 LY_DEFINE (ly_stencil_in_color, "ly:stencil-in-color",
220 4, 0, 0, (SCM stc, SCM r, SCM g, SCM b),
221 "Put @var{stc} in a different color.")
223 LY_ASSERT_SMOB (Stencil, stc, 1);
224 Stencil *stil = unsmob_stencil (stc);
225 return Stencil (stil->extent_box (),
226 scm_list_3 (ly_symbol2scm ("color"),
227 scm_list_3 (r, g, b),
228 stil->expr ())).smobbed_copy ();
231 struct Stencil_interpret_arguments
237 void stencil_interpret_in_scm (void *p, SCM expr)
239 Stencil_interpret_arguments *ap = (Stencil_interpret_arguments *) p;
240 scm_call_2 (ap->func, ap->arg1, expr);
243 LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression",
244 4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset),
245 "Parse EXPR, feed bits to FUNC with first arg ARG1")
247 LY_ASSERT_TYPE (ly_is_procedure, func, 2);
249 Stencil_interpret_arguments a;
252 Offset o = ly_scm2offset (offset);
254 interpret_stencil_expression (expr, stencil_interpret_in_scm, (void *) & a, o);
256 return SCM_UNSPECIFIED;
259 LY_DEFINE (ly_bracket, "ly:bracket",
261 (SCM a, SCM iv, SCM t, SCM p),
262 "Make a bracket in direction @var{a}. The extent of the bracket is "
263 "given by @var{iv}. The wings protude by an amount of @var{p}, which "
264 "may be negative. The thickness is given by @var{t}.")
266 LY_ASSERT_TYPE (is_axis, a, 1);
267 LY_ASSERT_TYPE (is_number_pair, iv, 2);
268 LY_ASSERT_TYPE (scm_is_number, t,3);
269 LY_ASSERT_TYPE (scm_is_number, p,4);
271 return Lookup::bracket ((Axis)scm_to_int (a), ly_scm2interval (iv),
274 0.95 * scm_to_double (t)).smobbed_copy ();
277 LY_DEFINE (ly_stencil_rotate, "ly:stencil-rotate",
278 4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y),
279 "Return a @var{stil} rotated @var{angle} degrees around point (@var{x}, @var{y}).")
281 Stencil *s = unsmob_stencil (stil);
282 LY_ASSERT_SMOB (Stencil, stil, 1);
283 LY_ASSERT_TYPE (scm_is_number, angle, 2);
284 LY_ASSERT_TYPE (scm_is_number, x,3);
285 LY_ASSERT_TYPE (scm_is_number, y, 4);
286 Real a = scm_to_double (angle);
287 Real x_off = scm_to_double (x);
288 Real y_off = scm_to_double (y);
290 SCM new_s = s->smobbed_copy ();
291 Stencil *q = unsmob_stencil (new_s);
292 q->rotate (a, Offset (x_off, y_off));
296 LY_DEFINE (ly_round_filled_box, "ly:round-filled-box",
298 (SCM xext, SCM yext, SCM blot),
299 "Make a @code{Stencil} "
300 "that prints a black box of dimensions @var{xext}, "
301 "@var{yext} and roundness @var{blot}.")
303 LY_ASSERT_TYPE (is_number_pair, xext, 1);
304 LY_ASSERT_TYPE (is_number_pair, yext, 2);
305 LY_ASSERT_TYPE (scm_is_number, blot, 3);
307 return Lookup::round_filled_box (Box (ly_scm2interval (xext), ly_scm2interval (yext)),
308 scm_to_double (blot)).smobbed_copy ();
311 LY_DEFINE (ly_register_stencil_expression, "ly:register-stencil-expression",
314 "Add @var{symbol} as head of a stencil expression")
316 LY_ASSERT_TYPE (ly_is_symbol, symbol, 1);
317 register_stencil_head (symbol);
318 return SCM_UNSPECIFIED;
321 LY_DEFINE (ly_all_stencil_expressions, "ly:all-stencil-expressions",
324 "Return all symbols recognized as stencil expressions.")
326 return all_stencil_heads ();