2 stencil.cc -- implement Stencil
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
13 #include <libc-extension.hh> // isinf
15 #include "input-smob.hh"
16 #include "font-metric.hh"
17 #include "dimensions.hh"
18 #include "string-convert.hh"
21 #include "ly-smobs.icc"
29 Stencil::Stencil (Box b, SCM func)
36 Stencil::print_smob (SCM, SCM port, scm_print_state *)
38 scm_puts ("#<Stencil ", port);
39 scm_puts (" >", port);
44 Stencil::mark_smob (SCM smob)
46 Stencil *s = (Stencil*) SCM_CELL_WORD_1 (smob);
50 IMPLEMENT_SIMPLE_SMOBS (Stencil);
51 IMPLEMENT_TYPE_P (Stencil, "ly:stencil?");
52 IMPLEMENT_DEFAULT_EQUAL_P (Stencil);
55 Stencil::extent (Axis a) const
60 /* Hmm... maybe this is not such a good idea ; stuff can be empty,
63 Stencil::is_empty () const
65 return expr_ == SCM_EOL;
69 Stencil::expr () const
75 Stencil::extent_box () const
80 Stencil::origin () const
86 Stencil::translate (Offset o)
91 /* FIXME: 100CM should relate to paper size. */
92 if (abs (o[a]) > 100 CM
93 || isinf (o[a]) || isnan (o[a]))
95 programming_error (String_convert::form_string ("Improbable offset for stencil: %f%s", o[a], INTERNAL_UNIT)
97 + "Setting to zero.");
103 expr_ = scm_list_n (ly_symbol2scm ("translate-stencil"),
105 expr_, SCM_UNDEFINED);
112 Stencil::translate_axis (Real x, Axis a)
120 Stencil::add_stencil (Stencil const &s)
122 expr_ = scm_list_3 (ly_symbol2scm ("combine-stencil"), s.expr_, expr_);
129 Stencil::set_empty (bool e)
133 dim_[X_AXIS].set_empty ();
134 dim_[Y_AXIS].set_empty ();
138 dim_[X_AXIS] = Interval (0,0);
139 dim_[Y_AXIS] = Interval (0,0);
144 Stencil::align_to (Axis a, Real x)
149 Interval i (extent (a));
150 translate_axis (-i.linear_combination (x), a);
153 /* FIXME: unintuitive naming, you would expect *this to be moved.
154 Kept (keeping?) API for compat with add_at_edge ().
156 What is PADDING, what is MINIMUM, exactly? */
158 Stencil::moved_to_edge (Axis a, Direction d, Stencil const &s,
159 Real padding, Real minimum) const
161 Interval my_extent = dim_[a];
162 Interval i (s.extent (a));
166 programming_error ("Stencil::moved_to_edge: adding empty stencil.");
172 Real offset = (my_extent.is_empty () ? 0.0 : my_extent[d] - his_extent)
176 toadd.translate_axis (offset,a);
178 if (minimum > 0 && d * (-origin ()[a] + toadd.origin ()[a]) < minimum)
179 toadd.translate_axis ( -toadd.origin ()[a]
180 + origin ()[a] + d * minimum, a);
185 /* See scheme Function. */
187 Stencil::add_at_edge (Axis a, Direction d, Stencil const &s, Real padding,
190 add_stencil (moved_to_edge (a, d, s, padding, minimum));
194 /****************************************************************/
198 interpret_stencil_expression (SCM expr,
199 void (*func) (void*, SCM),
205 if (!scm_is_pair (expr))
208 SCM head = scm_car (expr);
210 if (head == ly_symbol2scm ("translate-stencil"))
212 o += ly_scm2offset (scm_cadr (expr));
213 expr = scm_caddr (expr);
215 else if (head == ly_symbol2scm ("combine-stencil"))
217 for (SCM x = scm_cdr (expr); scm_is_pair (x); x = scm_cdr (x))
218 interpret_stencil_expression (scm_car (x), func, func_arg, o);
221 else if (head == ly_symbol2scm ("grob-cause"))
223 SCM grob = scm_cadr (expr);
225 (*func) (func_arg, scm_list_2 (head, grob));
226 interpret_stencil_expression (scm_caddr (expr), func, func_arg, o);
227 (*func) (func_arg, scm_list_1 (ly_symbol2scm ("no-origin")));
233 scm_list_4 (ly_symbol2scm ("placebox"),
234 scm_make_real (o[X_AXIS]),
235 scm_make_real (o[Y_AXIS]),
249 find_font_function (void *fs, SCM x)
251 Font_list *me = (Font_list*) fs;
253 if (scm_car (x) == ly_symbol2scm ("placebox"))
255 SCM args = scm_cdr (x);
256 SCM what = scm_caddr (args);
258 if (scm_is_pair (what))
260 SCM head = scm_car (what);
261 if (ly_symbol2scm ("text") == head)
262 me->fonts_ = scm_cons (scm_cadr (what), me->fonts_);
263 else if (head == ly_symbol2scm ("char"))
264 me->fonts_ = scm_cons (scm_cadr (what), me->fonts_);
270 find_expression_fonts (SCM expr)
276 interpret_stencil_expression (expr, &find_font_function,
277 (void*) &fl, Offset (0,0));
283 LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts",
285 " Analyse @var{s}, and return a list of fonts used in @var{s}.")
287 Stencil *stil = unsmob_stencil (s);
288 SCM_ASSERT_TYPE (stil, s, SCM_ARG1, __FUNCTION__, "Stencil");
289 return find_expression_fonts (stil->expr ());
292 struct Stencil_interpret_arguments
298 void stencil_interpret_in_scm (void *p, SCM expr)
300 Stencil_interpret_arguments *ap = (Stencil_interpret_arguments*) p;
301 scm_call_2 (ap->func, ap->arg1, expr);
306 LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression",
307 4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset),
308 "Parse EXPR, feed bits to FUNC with first arg ARG1")
310 SCM_ASSERT_TYPE (ly_c_procedure_p(func), func, SCM_ARG1, __FUNCTION__,
313 Stencil_interpret_arguments a;
316 Offset o = ly_scm2offset (offset);
318 interpret_stencil_expression (expr, stencil_interpret_in_scm, (void*) &a, o);
320 return SCM_UNSPECIFIED;