2 stencil-scheme.cc -- implement Stencil scheme accessors
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2006 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_translate_stencil_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 SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
25 SCM_ASSERT_TYPE (scm_is_number (amount), amount, SCM_ARG2, __FUNCTION__, "number");
27 Real real_amount = scm_to_double (amount);
30 SCM_ASSERT_TYPE (!isinf (real_amount) && !isnan (real_amount),
31 amount, SCM_ARG2, __FUNCTION__, "finite number");
34 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
36 SCM new_s = s->smobbed_copy ();
37 Stencil *q = unsmob_stencil (new_s);
38 q->translate_axis (real_amount, Axis (scm_to_int (axis)));
42 LY_DEFINE (ly_translate_stencil, "ly:stencil-translate",
43 2, 0, 0, (SCM stil, SCM offset),
44 "Return a @var{stil}, "
45 "but translated by @var{offset} (a pair of numbers).")
47 Stencil *s = unsmob_stencil (stil);
48 SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
49 SCM_ASSERT_TYPE (is_number_pair (offset), offset, SCM_ARG2, __FUNCTION__, "number pair");
50 Offset o = ly_scm2offset (offset);
52 SCM new_s = s->smobbed_copy ();
53 Stencil *q = unsmob_stencil (new_s);
58 LY_DEFINE (ly_stencil_expr, "ly:stencil-expr",
60 "Return the expression of @var{stil}.")
62 Stencil *s = unsmob_stencil (stil);
63 SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
67 LY_DEFINE (ly_stencil_extent, "ly:stencil-extent",
68 2, 0, 0, (SCM stil, SCM axis),
69 "Return a pair of numbers signifying the extent of @var{stil} in "
70 "@var{axis} direction (0 or 1 for x and y axis respectively).")
72 Stencil *s = unsmob_stencil (stil);
73 SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
74 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
76 return ly_interval2scm (s->extent (Axis (scm_to_int (axis))));
79 LY_DEFINE (ly_stencil_empty_p, "ly:stencil-empty?",
81 "Return whether @var{stil} is empty ")
83 Stencil *s = unsmob_stencil (stil);
84 SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
85 return scm_from_bool (s->is_empty ());
88 LY_DEFINE (ly_stencil_origin, "ly:stencil-origin",
89 2, 0, 0, (SCM stil, SCM axis),
90 "Return a pair of numbers signifying the origin @var{stil} in "
91 "@var{axis} direction (0 or 1 for x and y axis respectively).")
93 Stencil *s = unsmob_stencil (stil);
94 SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
95 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
97 return scm_from_double (s->origin ()[Axis (scm_to_int (axis))]);
100 LY_DEFINE (ly_stencil_moved_to_edge, "ly:stencil-moved-to-edge",
101 4, 2, 0, (SCM first, SCM axis, SCM direction, SCM second,
102 SCM padding, SCM minimum),
103 "Similar to @code{ly:stencil-combine-edge}, but returns "
104 "@var{second} positioned to be next to @var{first}. ")
107 C&P from combine-at-edge.
109 fixme: just used once.
111 Stencil *s1 = unsmob_stencil (first);
112 Stencil *s2 = unsmob_stencil (second);
113 Stencil first_stencil;
115 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
116 SCM_ASSERT_TYPE (is_direction (direction), direction, SCM_ARG4, __FUNCTION__, "dir");
119 if (padding != SCM_UNDEFINED)
121 SCM_ASSERT_TYPE (scm_is_number (padding), padding, SCM_ARG5, __FUNCTION__, "number");
122 p = scm_to_double (padding);
125 if (minimum != SCM_UNDEFINED)
127 SCM_ASSERT_TYPE (scm_is_number (minimum), minimum, SCM_ARG6, __FUNCTION__, "number");
128 m = scm_to_double (minimum);
135 return first_stencil.moved_to_edge (Axis (scm_to_int (axis)),
136 Direction (scm_to_int (direction)),
137 *s2, p, m).smobbed_copy ();
139 return Stencil ().smobbed_copy ();
142 LY_DEFINE (ly_stencil_combine_at_edge, "ly:stencil-combine-at-edge",
143 4, 2, 0, (SCM first, SCM axis, SCM direction,
147 "Construct a stencil by putting @var{second} next to @var{first}. "
148 "@var{axis} can be 0 (x-axis) or 1 (y-axis), "
149 "@var{direction} can be -1 (left or down) or 1 (right or up). "
150 "The stencils are juxtaposed with @var{padding} as extra space. "
151 "If this puts the reference points closer than @var{minimum}, "
152 "they are moved by the latter amount."
153 "@var{first} and @var{second} may also be '() or #f.")
155 Stencil *s1 = unsmob_stencil (first);
156 Stencil *s2 = unsmob_stencil (second);
159 SCM_ASSERT_TYPE (s1 || first == SCM_BOOL_F || first == SCM_EOL,
160 first, SCM_ARG1, __FUNCTION__, "Stencil, #f or ()");
161 SCM_ASSERT_TYPE (s2 || second == SCM_BOOL_F || second == SCM_EOL,
162 second, SCM_ARG4, __FUNCTION__, "Stencil, #f or ()");
163 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
164 SCM_ASSERT_TYPE (is_direction (direction), direction, SCM_ARG3, __FUNCTION__, "dir");
167 if (padding != SCM_UNDEFINED)
169 SCM_ASSERT_TYPE (scm_is_number (padding), padding, SCM_ARG5, __FUNCTION__, "number");
170 p = scm_to_double (padding);
173 if (minimum != SCM_UNDEFINED)
175 SCM_ASSERT_TYPE (scm_is_number (minimum), minimum, SCM_ARG6, __FUNCTION__, "number");
176 m = scm_to_double (minimum);
183 result.add_at_edge (Axis (scm_to_int (axis)),
184 Direction (scm_to_int (direction)), *s2, p, m);
186 return result.smobbed_copy ();
189 LY_DEFINE (ly_stencil_add, "ly:stencil-add",
191 "Combine stencils. Takes any number of arguments.")
193 #define FUNC_NAME __FUNCTION__
194 SCM_VALIDATE_REST_ARGUMENT (args);
201 while (!SCM_NULLP (args))
203 Stencil *s = unsmob_stencil (scm_car (args));
205 SCM_ASSERT_TYPE (s, scm_car (args), SCM_ARGn, __FUNCTION__, "Stencil");
207 extent.unite (s->extent_box ());
208 *tail = scm_cons (s->expr (), SCM_EOL);
209 tail = SCM_CDRLOC (*tail);
210 args = scm_cdr (args);
213 expr = scm_cons (ly_symbol2scm ("combine-stencil"), expr);
214 return Stencil (extent, expr).smobbed_copy ();
217 LY_DEFINE (ly_make_stencil, "ly:make-stencil",
218 1, 2, 0, (SCM expr, SCM xext, SCM yext),
220 "Stencils are a device independent output expressions."
221 "They carry two pieces of information: \n\n"
222 "1: a specification of how to print this object. "
223 "This specification is processed by the output backends, "
224 " for example @file{scm/output-ps.scm}.\n\n"
225 "2: the vertical and horizontal extents of the object.\n\n"
226 "If the extents are unspecified, they are taken to be empty."
229 SCM_ASSERT_TYPE (!scm_is_pair (expr)
230 || is_stencil_head (scm_car (expr)),
231 expr, SCM_ARG1, __FUNCTION__, "registered stencil expression");
235 if (xext != SCM_UNDEFINED)
237 SCM_ASSERT_TYPE (is_number_pair (xext), xext, SCM_ARG2, __FUNCTION__, "number pair");
238 x = ly_scm2interval (xext);
242 if (yext != SCM_UNDEFINED)
244 SCM_ASSERT_TYPE (is_number_pair (yext), yext, SCM_ARG3, __FUNCTION__, "number pair");
245 y = ly_scm2interval (yext);
250 return s.smobbed_copy ();
253 LY_DEFINE (ly_stencil_aligned_to, "ly:stencil-aligned-to",
254 3, 0, 0, (SCM stil, SCM axis, SCM dir),
255 "Align @var{stil} using its own extents. "
256 "@var{dir} is a number -1, 1 are left and right respectively. "
257 "Other values are interpolated (so 0 means the center).")
259 SCM_ASSERT_TYPE (unsmob_stencil (stil), stil, SCM_ARG1, __FUNCTION__, "stencil");
260 SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
261 SCM_ASSERT_TYPE (scm_is_number (dir), dir, SCM_ARG3, __FUNCTION__, "number");
263 Stencil target = *unsmob_stencil (stil);
265 target.align_to ((Axis)scm_to_int (axis),
266 scm_to_double (dir));
267 return target.smobbed_copy ();
270 LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts",
272 " Analyse @var{s}, and return a list of fonts used in @var{s}.")
274 Stencil *stil = unsmob_stencil (s);
275 SCM_ASSERT_TYPE (stil, s, SCM_ARG1, __FUNCTION__, "Stencil");
276 return find_expression_fonts (stil->expr ());
279 LY_DEFINE (ly_stencil_in_color, "ly:stencil-in-color",
280 4, 0, 0, (SCM stc, SCM r, SCM g, SCM b),
281 "Put @var{stc} in a different color.")
283 Stencil *stil = unsmob_stencil (stc);
284 SCM_ASSERT_TYPE (stil, stc, SCM_ARG1, __FUNCTION__, "Stencil");
285 return Stencil (stil->extent_box (),
286 scm_list_3 (ly_symbol2scm ("color"),
287 scm_list_3 (r, g, b),
288 stil->expr ())).smobbed_copy ();
291 struct Stencil_interpret_arguments
297 void stencil_interpret_in_scm (void *p, SCM expr)
299 Stencil_interpret_arguments *ap = (Stencil_interpret_arguments *) p;
300 scm_call_2 (ap->func, ap->arg1, expr);
303 LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression",
304 4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset),
305 "Parse EXPR, feed bits to FUNC with first arg ARG1")
307 SCM_ASSERT_TYPE (ly_is_procedure (func), func, SCM_ARG1, __FUNCTION__,
310 Stencil_interpret_arguments a;
313 Offset o = ly_scm2offset (offset);
315 interpret_stencil_expression (expr, stencil_interpret_in_scm, (void *) & a, o);
317 return SCM_UNSPECIFIED;
320 LY_DEFINE (ly_bracket, "ly:bracket",
322 (SCM a, SCM iv, SCM t, SCM p),
323 "Make a bracket in direction @var{a}. The extent of the bracket is "
324 "given by @var{iv}. The wings protude by an amount of @var{p}, which "
325 "may be negative. The thickness is given by @var{t}.")
327 SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG1, __FUNCTION__, "axis");
328 SCM_ASSERT_TYPE (is_number_pair (iv), iv, SCM_ARG2, __FUNCTION__, "number pair");
329 SCM_ASSERT_TYPE (scm_is_number (t), a, SCM_ARG3, __FUNCTION__, "number");
330 SCM_ASSERT_TYPE (scm_is_number (p), a, SCM_ARG4, __FUNCTION__, "number");
332 return Lookup::bracket ((Axis)scm_to_int (a), ly_scm2interval (iv),
335 0.95 * scm_to_double (t)).smobbed_copy ();
338 LY_DEFINE (ly_rotate_stencil, "ly:stencil-rotate",
339 4, 0, 0, (SCM stil, SCM angle, SCM x, SCM y),
340 "Return a @var{stil} rotated @var{angle} degrees around point (@var{x}, @var{y}).")
342 Stencil *s = unsmob_stencil (stil);
343 SCM_ASSERT_TYPE (s, stil, SCM_ARG1, __FUNCTION__, "stencil");
344 SCM_ASSERT_TYPE (scm_is_number (angle), angle, SCM_ARG2, __FUNCTION__, "number");
345 SCM_ASSERT_TYPE (scm_is_number (x), x, SCM_ARG3, __FUNCTION__, "number");
346 SCM_ASSERT_TYPE (scm_is_number (y), y, SCM_ARG4, __FUNCTION__, "number");
347 Real a = scm_to_double (angle);
348 Real x_off = scm_to_double (x);
349 Real y_off = scm_to_double (y);
351 SCM new_s = s->smobbed_copy ();
352 Stencil *q = unsmob_stencil (new_s);
353 q->rotate (a, Offset (x_off, y_off));
357 LY_DEFINE (ly_filled_box, "ly:round-filled-box",
359 (SCM xext, SCM yext, SCM blot),
360 "Make a @code{Stencil} "
361 "that prints a black box of dimensions @var{xext}, "
362 "@var{yext} and roundness @var{blot}.")
364 SCM_ASSERT_TYPE (is_number_pair (xext), xext, SCM_ARG1, __FUNCTION__, "number pair");
365 SCM_ASSERT_TYPE (is_number_pair (yext), yext, SCM_ARG2, __FUNCTION__, "number pair");
366 SCM_ASSERT_TYPE (scm_is_number (blot), blot, SCM_ARG3, __FUNCTION__, "number");
368 return Lookup::round_filled_box (Box (ly_scm2interval (xext), ly_scm2interval (yext)),
369 scm_to_double (blot)).smobbed_copy ();
372 LY_DEFINE (ly_register_stencil_expression, "ly:register-stencil-expression",
375 "Add @var{symbol} as head of a stencil expression")
377 SCM_ASSERT_TYPE (scm_is_symbol (symbol), symbol,
378 SCM_ARG1, __FUNCTION__, "Symbol");
379 register_stencil_head (symbol);
380 return SCM_UNSPECIFIED;
383 LY_DEFINE (ly_all_stencil_expressions, "ly:all-stencil-expressions",
386 "Return all symbols recognized as stencil expressions.")
388 return all_stencil_heads ();