2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
20 #include "font-metric.hh"
21 #include "libc-extension.hh"
26 TODO: naming add/combine.
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.")
34 Stencil *s = unsmob_stencil (stil);
35 LY_ASSERT_SMOB (Stencil, stil, 1);
36 LY_ASSERT_TYPE (scm_is_number, amount, 2);
37 LY_ASSERT_TYPE (is_axis, axis, 3);
39 Real real_amount = scm_to_double (amount);
41 SCM new_s = s->smobbed_copy ();
42 Stencil *q = unsmob_stencil (new_s);
43 q->translate_axis (real_amount, Axis (scm_to_int (axis)));
47 LY_DEFINE (ly_stencil_translate, "ly:stencil-translate",
48 2, 0, 0, (SCM stil, SCM offset),
49 "Return a @var{stil}, but translated by @var{offset}"
50 " (a pair of numbers).")
52 Stencil *s = unsmob_stencil (stil);
53 LY_ASSERT_SMOB (Stencil, stil, 1);
54 LY_ASSERT_TYPE (is_number_pair, offset, 2);
55 Offset o = ly_scm2offset (offset);
57 SCM new_s = s->smobbed_copy ();
58 Stencil *q = unsmob_stencil (new_s);
63 LY_DEFINE (ly_stencil_expr, "ly:stencil-expr",
65 "Return the expression of @var{stil}.")
67 Stencil *s = unsmob_stencil (stil);
68 LY_ASSERT_SMOB (Stencil, stil, 1);
72 LY_DEFINE (ly_stencil_extent, "ly:stencil-extent",
73 2, 0, 0, (SCM stil, SCM axis),
74 "Return a pair of numbers signifying the extent of @var{stil} in"
75 " @var{axis} direction (@code{0} or @code{1} for x and"
76 " y@tie{}axis, respectively).")
78 Stencil *s = unsmob_stencil (stil);
79 LY_ASSERT_SMOB (Stencil, stil, 1);
80 LY_ASSERT_TYPE (is_axis, axis, 2);
82 return ly_interval2scm (s->extent (Axis (scm_to_int (axis))));
85 LY_DEFINE (ly_stencil_empty_p, "ly:stencil-empty?",
87 "Return whether @var{stil} is empty.")
89 Stencil *s = unsmob_stencil (stil);
90 LY_ASSERT_SMOB (Stencil, stil, 1);
91 return scm_from_bool (s->is_empty ());
94 LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge",
95 4, 2, 0, (SCM first, SCM axis, SCM direction,
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. If this puts the reference points closer than"
104 " @var{minimum}, they are moved by the latter amount."
105 " @var{first} and @var{second} may also be @code{'()} or"
108 Stencil *s1 = unsmob_stencil (first);
109 Stencil *s2 = unsmob_stencil (second);
112 SCM_ASSERT_TYPE (s1 || first == SCM_BOOL_F || first == SCM_EOL,
113 first, SCM_ARG1, __FUNCTION__, "Stencil, #f or ()");
114 SCM_ASSERT_TYPE (s2 || second == SCM_BOOL_F || second == SCM_EOL,
115 second, SCM_ARG4, __FUNCTION__, "Stencil, #f or ()");
116 LY_ASSERT_TYPE (is_axis, axis, 2);
117 LY_ASSERT_TYPE (is_direction, direction, 3);
120 if (padding != SCM_UNDEFINED)
122 LY_ASSERT_TYPE (scm_is_number, padding, 5);
123 p = scm_to_double (padding);
126 if (minimum != SCM_UNDEFINED)
128 LY_ASSERT_TYPE (scm_is_number, minimum, 6);
129 m = scm_to_double (minimum);
136 result.add_at_edge (Axis (scm_to_int (axis)),
137 Direction (scm_to_int (direction)), *s2, p);
139 return result.smobbed_copy ();
142 LY_DEFINE (ly_stencil_add, "ly:stencil-add",
144 "Combine stencils. Takes any number of arguments.")
146 #define FUNC_NAME __FUNCTION__
147 SCM_VALIDATE_REST_ARGUMENT (args);
154 while (!SCM_NULLP (args))
156 Stencil *s = unsmob_stencil (scm_car (args));
158 SCM_ASSERT_TYPE (s, scm_car (args), SCM_ARGn, __FUNCTION__, "Stencil");
160 extent.unite (s->extent_box ());
161 *tail = scm_cons (s->expr (), SCM_EOL);
162 tail = SCM_CDRLOC (*tail);
163 args = scm_cdr (args);
166 expr = scm_cons (ly_symbol2scm ("combine-stencil"), expr);
167 return Stencil (extent, expr).smobbed_copy ();
170 LY_DEFINE (ly_make_stencil, "ly:make-stencil",
171 1, 2, 0, (SCM expr, SCM xext, SCM yext),
172 "Stencils are device independent output expressions."
173 " They carry two pieces of information:\n"
177 "A specification of how to print this object."
178 " This specification is processed by the output backends,"
179 " for example @file{scm/output-ps.scm}.\n"
182 "The vertical and horizontal extents of the object, given as"
183 " pairs. If an extent is unspecified (or if you use"
184 " @code{(1000 . -1000)} as its value), it is taken to be empty.\n"
187 SCM_ASSERT_TYPE (!scm_is_pair (expr)
188 || is_stencil_head (scm_car (expr)),
189 expr, SCM_ARG1, __FUNCTION__, "registered stencil expression");
192 if (xext != SCM_UNDEFINED)
194 LY_ASSERT_TYPE (is_number_pair, xext, 2);
195 x = ly_scm2interval (xext);
199 if (yext != SCM_UNDEFINED)
201 LY_ASSERT_TYPE (is_number_pair, yext, 3);
202 y = ly_scm2interval (yext);
207 return s.smobbed_copy ();
210 LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to",
211 3, 0, 0, (SCM stil, SCM axis, SCM dir),
212 "Align @var{stil} using its own extents. @var{dir} is a number."
213 " @code{-1} and @code{1} are left and right, respectively."
214 " Other values are interpolated (so @code{0} means the center).")
216 LY_ASSERT_SMOB (Stencil, stil, 1);
217 LY_ASSERT_TYPE (is_axis, axis, 2);
218 LY_ASSERT_TYPE (scm_is_number, dir, 3);
220 Stencil target = *unsmob_stencil (stil);
222 target.align_to ((Axis)scm_to_int (axis),
223 scm_to_double (dir));
224 return target.smobbed_copy ();
227 LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts",
229 "Analyze @var{s}, and return a list of fonts used"
232 LY_ASSERT_SMOB (Stencil, s, 1);
233 Stencil *stil = unsmob_stencil (s);
234 return find_expression_fonts (stil->expr ());
237 LY_DEFINE (ly_stencil_in_color, "ly:stencil-in-color",
238 4, 0, 0, (SCM stc, SCM r, SCM g, SCM b),
239 "Put @var{stc} in a different color.")
241 LY_ASSERT_SMOB (Stencil, stc, 1);
242 Stencil *stil = unsmob_stencil (stc);
243 return Stencil (stil->extent_box (),
244 scm_list_3 (ly_symbol2scm ("color"),
245 scm_list_3 (r, g, b),
246 stil->expr ())).smobbed_copy ();
249 struct Stencil_interpret_arguments
255 void stencil_interpret_in_scm (void *p, SCM expr)
257 Stencil_interpret_arguments *ap = (Stencil_interpret_arguments *) p;
258 scm_call_2 (ap->func, ap->arg1, expr);
261 LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression",
262 4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset),
263 "Parse @var{expr}, feed bits to @var{func} with first arg"
264 " @var{arg1} having offset @var{offset}.")
266 LY_ASSERT_TYPE (ly_is_procedure, func, 2);
268 Stencil_interpret_arguments a;
271 Offset o = ly_scm2offset (offset);
273 interpret_stencil_expression (expr, stencil_interpret_in_scm, (void *) & a, o);
275 return SCM_UNSPECIFIED;
278 LY_DEFINE (ly_bracket, "ly:bracket",
280 (SCM a, SCM iv, SCM t, SCM p),
281 "Make a bracket in direction@tie{}@var{a}. The extent of the"
282 " bracket is given by @var{iv}. The wings protrude by an amount"
283 " of@tie{}@var{p}, which may be negative. The thickness is given"
286 LY_ASSERT_TYPE (is_axis, a, 1);
287 LY_ASSERT_TYPE (is_number_pair, iv, 2);
288 LY_ASSERT_TYPE (scm_is_number, t, 3);
289 LY_ASSERT_TYPE (scm_is_number, p, 4);
291 return Lookup::bracket ((Axis)scm_to_int (a), ly_scm2interval (iv),
294 0.95 * scm_to_double (t)).smobbed_copy ();
297 LY_DEFINE (ly_stencil_rotate, "ly:stencil-rotate",
298 4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y),
299 "Return a stencil @var{stil} rotated @var{angle} degrees around"
300 " the relative offset (@var{x}, @var{y}). E.g. an offset of"
301 " (-1, 1) will rotate the stencil around the left upper corner.")
303 Stencil *s = unsmob_stencil (stil);
304 LY_ASSERT_SMOB (Stencil, stil, 1);
305 LY_ASSERT_TYPE (scm_is_number, angle, 2);
306 LY_ASSERT_TYPE (scm_is_number, x, 3);
307 LY_ASSERT_TYPE (scm_is_number, y, 4);
308 Real a = scm_to_double (angle);
309 Real x_off = scm_to_double (x);
310 Real y_off = scm_to_double (y);
312 SCM new_s = s->smobbed_copy ();
313 Stencil *q = unsmob_stencil (new_s);
314 q->rotate_degrees (a, Offset (x_off, y_off));
318 LY_DEFINE (ly_stencil_rotate_absolute, "ly:stencil-rotate-absolute",
319 4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y),
320 "Return a stencil @var{stil} rotated @var{angle} degrees around"
321 " point (@var{x}, @var{y}), given in absolute coordinates.")
323 Stencil *s = unsmob_stencil (stil);
324 LY_ASSERT_SMOB (Stencil, stil, 1);
325 LY_ASSERT_TYPE (scm_is_number, angle, 2);
326 LY_ASSERT_TYPE (scm_is_number, x, 3);
327 LY_ASSERT_TYPE (scm_is_number, y, 4);
328 Real a = scm_to_double (angle);
329 Real x_off = scm_to_double (x);
330 Real y_off = scm_to_double (y);
332 SCM new_s = s->smobbed_copy ();
333 Stencil *q = unsmob_stencil (new_s);
334 q->rotate_degrees_absolute (a, Offset (x_off, y_off));
338 LY_DEFINE (ly_round_filled_box, "ly:round-filled-box",
340 (SCM xext, SCM yext, SCM blot),
341 "Make a @code{Stencil} object that prints a black box of"
342 " dimensions @var{xext}, @var{yext} and roundness @var{blot}.")
344 LY_ASSERT_TYPE (is_number_pair, xext, 1);
345 LY_ASSERT_TYPE (is_number_pair, yext, 2);
346 LY_ASSERT_TYPE (scm_is_number, blot, 3);
348 return Lookup::round_filled_box (Box (ly_scm2interval (xext), ly_scm2interval (yext)),
349 scm_to_double (blot)).smobbed_copy ();
352 LY_DEFINE (ly_round_filled_polygon, "ly:round-filled-polygon",
354 (SCM points, SCM blot),
355 "Make a @code{Stencil} object that prints a black polygon with"
356 " corners at the points defined by @var{points} (list of coordinate"
357 " pairs) and roundness @var{blot}.")
359 SCM_ASSERT_TYPE (scm_ilength (points) > 0, points, SCM_ARG1, __FUNCTION__, "list of coordinate pairs");
360 LY_ASSERT_TYPE (scm_is_number, blot, 2);
362 for (SCM p = points; scm_is_pair (p); p = scm_cdr (p))
364 SCM scm_pt = scm_car (p);
365 if (scm_is_pair (scm_pt))
367 pts.push_back (ly_scm2offset (scm_pt));
371 // TODO: Print out warning
374 return Lookup::round_filled_polygon (pts, scm_to_double (blot)).smobbed_copy ();
377 LY_DEFINE (ly_register_stencil_expression, "ly:register-stencil-expression",
380 "Add @var{symbol} as head of a stencil expression.")
382 LY_ASSERT_TYPE (ly_is_symbol, symbol, 1);
383 register_stencil_head (symbol);
384 return SCM_UNSPECIFIED;
387 LY_DEFINE (ly_all_stencil_expressions, "ly:all-stencil-expressions",
390 "Return all symbols recognized as stencil expressions.")
392 return all_stencil_heads ();
395 LY_DEFINE (ly_stencil_scale, "ly:stencil-scale",
396 3, 0, 0, (SCM stil, SCM x, SCM y),
397 "Scale @var{stil} using the horizontal and vertical scaling"
398 " factors @var{x} and @var{y}.")
400 Stencil *s = unsmob_stencil (stil);
401 LY_ASSERT_SMOB (Stencil, stil, 1);
402 LY_ASSERT_TYPE (scm_is_number, x, 2);
403 LY_ASSERT_TYPE (scm_is_number, y, 3);
405 SCM new_s = s->smobbed_copy ();
406 Stencil *q = unsmob_stencil (new_s);
408 q->scale (scm_to_double (x), scm_to_double (y));