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>
10 #include <libc-extension.hh> // isinf
12 #include "input-smob.hh"
13 #include "font-metric.hh"
14 #include "dimensions.hh"
15 #include "interval.hh"
20 #include "ly-smobs.icc"
28 Stencil::Stencil (Box b, SCM func)
35 Stencil::print_smob (SCM, SCM port, scm_print_state *)
37 scm_puts ("#<Stencil ", port);
38 scm_puts (" >", port);
43 Stencil::mark_smob (SCM smob)
45 Stencil *s = (Stencil*) ly_cdr (smob);
49 IMPLEMENT_SIMPLE_SMOBS (Stencil);
50 IMPLEMENT_TYPE_P (Stencil, "ly:stencil?");
51 IMPLEMENT_DEFAULT_EQUAL_P (Stencil);
54 Stencil::extent (Axis a) const
59 /* Hmm... maybe this is not such a good idea ; stuff can be empty,
62 Stencil::is_empty () const
64 return expr_ == SCM_EOL;
68 Stencil::expr () const
74 Stencil::extent_box () const
79 Stencil::origin () const
85 Stencil::translate (Offset o)
90 if (abs (o[a]) > 100 CM
91 || isinf (o[a]) || isnan (o[a]))
93 programming_error ("Improbable offset for translation: setting to zero");
99 expr_ = scm_list_n (ly_symbol2scm ("translate-stencil"),
101 expr_, SCM_UNDEFINED);
108 Stencil::translate_axis (Real x, Axis a)
116 Stencil::add_stencil (Stencil const &s)
118 expr_ = scm_list_3 (ly_symbol2scm ("combine-stencil"), s.expr_, expr_);
125 Stencil::set_empty (bool e)
129 dim_[X_AXIS].set_empty ();
130 dim_[Y_AXIS].set_empty ();
134 dim_[X_AXIS] = Interval (0,0);
135 dim_[Y_AXIS] = Interval (0,0);
140 Stencil::align_to (Axis a, Real x)
145 Interval i (extent (a));
146 translate_axis (-i.linear_combination (x), a);
149 /* FIXME: unintuitive naming, you would expect *this to be moved.
150 Kept (keeping?) API for compat with add_at_edge ().
152 What is PADDING, what is MINIMUM, exactly? */
154 Stencil::moved_to_edge (Axis a, Direction d, Stencil const &s,
155 Real padding, Real minimum) const
157 Interval my_extent = dim_[a];
158 Interval i (s.extent (a));
162 programming_error ("Stencil::moved_to_edge: adding empty stencil.");
168 Real offset = (my_extent.is_empty () ? 0.0 : my_extent[d] - his_extent)
172 toadd.translate_axis (offset,a);
174 if (minimum > 0 && d * (-origin ()[a] + toadd.origin ()[a]) < minimum)
175 toadd.translate_axis ( -toadd.origin ()[a]
176 + origin ()[a] + d * minimum, a);
181 /* See scheme Function. */
183 Stencil::add_at_edge (Axis a, Direction d, Stencil const &s, Real padding,
186 add_stencil (moved_to_edge (a, d, s, padding, minimum));
190 /****************************************************************/
192 LY_DEFINE (ly_interpret_stencil, "ly:interpret-stencil",
193 4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset),
194 "Parse EXPR, feed bits to FUNC with first arg ARG1")
196 Offset o = ly_scm2offset (offset);
199 if (!ly_c_pair_p (expr))
200 return SCM_UNDEFINED;
202 SCM head = ly_car (expr);
203 if (unsmob_input (head))
205 Input *ip = unsmob_input (head);
206 scm_call_2 (func, arg1,
207 scm_list_4 (ly_symbol2scm ("define-origin"),
208 scm_makfrom0str (ip->file_string ()
210 scm_int2num (ip->line_number ()),
211 scm_int2num (ip->column_number ())));
212 expr = ly_cadr (expr);
214 else if (head == ly_symbol2scm ("no-origin"))
216 scm_call_2 (func, arg1, scm_list_1 (head));
217 expr = ly_cadr (expr);
219 else if (head == ly_symbol2scm ("translate-stencil"))
221 o += ly_scm2offset (ly_cadr (expr));
222 expr = ly_caddr (expr);
224 else if (head == ly_symbol2scm ("combine-stencil"))
226 for (SCM x = ly_cdr (expr); ly_c_pair_p (x); x = ly_cdr (x))
227 ly_interpret_stencil (ly_car (x), func, arg1, ly_offset2scm (o));
228 return SCM_UNDEFINED;
232 scm_call_2 (func, arg1,
233 scm_list_4 (ly_symbol2scm ("placebox"),
234 scm_make_real (o[X_AXIS]),
235 scm_make_real (o[Y_AXIS]),
237 return SCM_UNDEFINED;
242 LY_DEFINE (ly_find_font_function, "ly:find-font-function",
243 2, 0, 0, (SCM fs, SCM x),
246 if (ly_car (x) == ly_symbol2scm ("placebox"))
248 SCM args = ly_cdr (x);
249 SCM what = ly_caddr (args);
251 if (ly_c_pair_p (what))
253 SCM head = ly_car (what);
254 if (ly_symbol2scm ("text") == head)
255 fs = scm_cons (ly_cadr (what), fs);
256 else if (head == ly_symbol2scm ("char"))
257 fs = scm_cons (ly_cadr (what), fs);
260 return SCM_UNDEFINED;
264 find_expression_fonts (SCM expr)
267 ly_interpret_stencil (expr, ly_scheme_function ("ly:find-font-function"),
268 fonts, ly_offset2scm (Offset (0, 0)));
272 LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts",
274 " Analyse @var{s}, and return a list of fonts used in @var{s}.")
276 Stencil *stil = unsmob_stencil (s);
277 SCM_ASSERT_TYPE (stil, s, SCM_ARG1, __FUNCTION__, "Stencil");
278 return find_expression_fonts (stil->expr ());