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 if (isinf (o[a]) || isnan (o[a]))
93 programming_error (String_convert::form_string ("Improbable offset for stencil: %f staff space", o[a])
95 + "Setting to zero.");
101 expr_ = scm_list_n (ly_symbol2scm ("translate-stencil"),
103 expr_, SCM_UNDEFINED);
110 Stencil::translate_axis (Real x, Axis a)
118 Stencil::add_stencil (Stencil const &s)
120 expr_ = scm_list_3 (ly_symbol2scm ("combine-stencil"), s.expr_, expr_);
127 Stencil::set_empty (bool e)
131 dim_[X_AXIS].set_empty ();
132 dim_[Y_AXIS].set_empty ();
136 dim_[X_AXIS] = Interval (0,0);
137 dim_[Y_AXIS] = Interval (0,0);
142 Stencil::align_to (Axis a, Real x)
147 Interval i (extent (a));
148 translate_axis (-i.linear_combination (x), a);
151 /* FIXME: unintuitive naming, you would expect *this to be moved.
152 Kept (keeping?) API for compat with add_at_edge ().
154 What is PADDING, what is MINIMUM, exactly? */
156 Stencil::moved_to_edge (Axis a, Direction d, Stencil const &s,
157 Real padding, Real minimum) const
159 Interval my_extent = dim_[a];
160 Interval i (s.extent (a));
164 programming_error ("Stencil::moved_to_edge: adding empty stencil.");
170 Real offset = (my_extent.is_empty () ? 0.0 : my_extent[d] - his_extent)
174 toadd.translate_axis (offset,a);
176 if (minimum > 0 && d * (-origin ()[a] + toadd.origin ()[a]) < minimum)
177 toadd.translate_axis ( -toadd.origin ()[a]
178 + origin ()[a] + d * minimum, a);
183 /* See scheme Function. */
185 Stencil::add_at_edge (Axis a, Direction d, Stencil const &s, Real padding,
188 add_stencil (moved_to_edge (a, d, s, padding, minimum));
192 /****************************************************************/
196 interpret_stencil_expression (SCM expr,
197 void (*func) (void*, SCM),
203 if (!scm_is_pair (expr))
206 SCM head = scm_car (expr);
208 if (head == ly_symbol2scm ("translate-stencil"))
210 o += ly_scm2offset (scm_cadr (expr));
211 expr = scm_caddr (expr);
213 else if (head == ly_symbol2scm ("combine-stencil"))
215 for (SCM x = scm_cdr (expr); scm_is_pair (x); x = scm_cdr (x))
216 interpret_stencil_expression (scm_car (x), func, func_arg, o);
219 else if (head == ly_symbol2scm ("grob-cause"))
221 SCM grob = scm_cadr (expr);
223 (*func) (func_arg, scm_list_2 (head, grob));
224 interpret_stencil_expression (scm_caddr (expr), func, func_arg, o);
225 (*func) (func_arg, scm_list_1 (ly_symbol2scm ("no-origin")));
231 scm_list_4 (ly_symbol2scm ("placebox"),
232 scm_make_real (o[X_AXIS]),
233 scm_make_real (o[Y_AXIS]),
247 find_font_function (void *fs, SCM x)
249 Font_list *me = (Font_list*) fs;
251 if (scm_car (x) == ly_symbol2scm ("placebox"))
253 SCM args = scm_cdr (x);
254 SCM what = scm_caddr (args);
256 if (scm_is_pair (what))
258 SCM head = scm_car (what);
259 if (ly_symbol2scm ("text") == head)
260 me->fonts_ = scm_cons (scm_cadr (what), me->fonts_);
261 else if (head == ly_symbol2scm ("char"))
262 me->fonts_ = scm_cons (scm_cadr (what), me->fonts_);
268 find_expression_fonts (SCM expr)
274 interpret_stencil_expression (expr, &find_font_function,
275 (void*) &fl, Offset (0,0));
281 LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts",
283 " Analyse @var{s}, and return a list of fonts used in @var{s}.")
285 Stencil *stil = unsmob_stencil (s);
286 SCM_ASSERT_TYPE (stil, s, SCM_ARG1, __FUNCTION__, "Stencil");
287 return find_expression_fonts (stil->expr ());
290 struct Stencil_interpret_arguments
296 void stencil_interpret_in_scm (void *p, SCM expr)
298 Stencil_interpret_arguments *ap = (Stencil_interpret_arguments*) p;
299 scm_call_2 (ap->func, ap->arg1, expr);
304 LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression",
305 4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset),
306 "Parse EXPR, feed bits to FUNC with first arg ARG1")
308 SCM_ASSERT_TYPE (ly_c_procedure_p(func), func, SCM_ARG1, __FUNCTION__,
311 Stencil_interpret_arguments a;
314 Offset o = ly_scm2offset (offset);
316 interpret_stencil_expression (expr, stencil_interpret_in_scm, (void*) &a, o);
318 return SCM_UNSPECIFIED;