2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2014 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/>.
23 #include "font-metric.hh"
25 #include "string-convert.hh"
35 Stencil::Stencil (Box b, SCM func)
42 Stencil::print_smob (SCM, SCM port, scm_print_state *)
44 scm_puts ("#<Stencil ", port);
45 scm_puts (" >", port);
55 const char Stencil::type_p_name_[] = "ly:stencil?";
58 Stencil::extent (Axis a) const
64 Stencil::is_empty () const
66 return (expr_ == SCM_EOL
71 Stencil::is_empty (Axis a) const
73 return dim_.is_empty (a);
77 Stencil::expr () const
83 Stencil::extent_box () const
89 Stencil::rotate (Real a, Offset off)
91 rotate_degrees (a * 180 / M_PI, off);
95 Rotate this stencil around the point ABSOLUTE_OFF.
99 Stencil::rotate_degrees_absolute (Real a, Offset absolute_off)
101 const Real x = absolute_off[X_AXIS];
102 const Real y = absolute_off[Y_AXIS];
105 * Build scheme expression (processed in stencil-interpret.cc)
107 /* TODO: by hanwenn 2008/09/10 14:38:56:
108 * in effect, this copies the underlying expression. It might be a
109 * little bit nicer to mirror this in the api, ie. make a
111 * and have Stencil::rotate be an abbrev of
115 expr_ = scm_list_n (ly_symbol2scm ("rotate-stencil"),
116 scm_list_2 (scm_from_double (a),
117 scm_cons (scm_from_double (x), scm_from_double (y))),
118 expr_, SCM_UNDEFINED);
121 * Calculate the new bounding box
123 Box shifted_box = extent_box ();
124 shifted_box.translate (-absolute_off);
127 pts.push_back (Offset (shifted_box.x ().at (LEFT), shifted_box.y ().at (DOWN)));
128 pts.push_back (Offset (shifted_box.x ().at (RIGHT), shifted_box.y ().at (DOWN)));
129 pts.push_back (Offset (shifted_box.x ().at (RIGHT), shifted_box.y ().at (UP)));
130 pts.push_back (Offset (shifted_box.x ().at (LEFT), shifted_box.y ().at (UP)));
132 const Offset rot = complex_exp (Offset (0, a * M_PI / 180.0));
134 for (vsize i = 0; i < pts.size (); i++)
135 dim_.add_point (pts[i] * rot + absolute_off);
139 Rotate this stencil around the point RELATIVE_OFF.
141 RELATIVE_OFF is measured in terms of the extent of the stencil, so
142 -1 = LEFT/DOWN edge, 1 = RIGHT/UP edge.
145 Stencil::rotate_degrees (Real a, Offset relative_off)
148 * Calculate the center of rotation
150 const Real x = extent (X_AXIS).linear_combination (relative_off[X_AXIS]);
151 const Real y = extent (Y_AXIS).linear_combination (relative_off[Y_AXIS]);
152 rotate_degrees_absolute (a, Offset (x, y));
156 Stencil::translate (Offset o)
165 || fabs (o[a]) > 1e6)
167 programming_error (String_convert::form_string ("Improbable offset for stencil: %f staff space", o[a])
169 + "Setting to zero.");
171 if (strict_infinity_checking)
172 scm_misc_error (__FUNCTION__, "Improbable offset.", SCM_EOL);
177 if (!scm_is_null (expr_))
178 expr_ = scm_list_n (ly_symbol2scm ("translate-stencil"),
180 expr_, SCM_UNDEFINED);
185 Stencil::translate_axis (Real x, Axis a)
193 Stencil::scale (Real x, Real y)
195 expr_ = scm_list_3 (ly_symbol2scm ("scale-stencil"),
196 scm_list_2 (scm_from_double (x),
197 scm_from_double (y)),
204 Stencil::add_stencil (Stencil const &s)
206 SCM cs = ly_symbol2scm ("combine-stencil");
207 if (scm_is_null (expr_))
209 else if (scm_is_null (s.expr_))
211 else if (scm_is_pair (expr_)
212 && scm_is_eq (cs, scm_car (expr_)))
214 if (scm_is_pair (s.expr_)
215 && scm_is_eq (cs, scm_car (s.expr_)))
216 expr_ = scm_append (scm_list_2 (s.expr_, scm_cdr (expr_)));
218 expr_ = scm_cons2 (cs, s.expr_, scm_cdr (expr_));
222 if (scm_is_pair (s.expr_)
223 && scm_is_eq (cs, scm_car (s.expr_)))
224 expr_ = scm_append (scm_list_2 (s.expr_, scm_list_1 (expr_)));
226 expr_ = scm_list_3 (cs, s.expr_, expr_);
232 Stencil::set_empty (bool e)
236 dim_[X_AXIS].set_empty ();
237 dim_[Y_AXIS].set_empty ();
241 dim_[X_AXIS] = Interval (0, 0);
242 dim_[Y_AXIS] = Interval (0, 0);
247 Stencil::align_to (Axis a, Real x)
252 Interval i (extent (a));
253 translate_axis (-i.linear_combination (x), a);
256 /* See scheme Function. */
258 // Any stencil that is empty in the orthogonal axis is spacing.
259 // Spacing is not subjected to the max (0) rule and can thus be
263 Stencil::add_at_edge (Axis a, Direction d, Stencil const &s, Real padding)
265 // Material that is empty in the axis of reference has only limited
266 // usefulness for combining. We still retain as much information as
267 // available since there may be uses like setting page links or
268 // background color or watermarks, and off-axis extents.
276 Interval first_extent = extent (a);
281 // translation does not affect axis-empty extent box.
282 toadd.translate_axis (first_extent[d], a);
287 Interval next_extent = s.extent (a);
289 bool first_is_spacing = is_empty (other_axis (a));
290 bool next_is_spacing = s.is_empty (other_axis (a));
292 Real offset = first_extent[d] - next_extent[-d];
294 if (!(first_is_spacing || next_is_spacing))
296 offset += d * padding;
300 toadd.translate_axis (offset, a);
304 // Stencil::stack is mainly used for assembling lines or columns
305 // of stencils. For the most common case of adding at the right, the
306 // reference point of the added stencil is usually placed at the right
307 // edge of the current one, unless the added stencil has a negative
308 // left extent in which case its left edge is placed at the right edge
309 // of the current one.
311 // Spacing is special in that it is applied without padding. Spacing
312 // at the right edge shifts the right edge accordingly.
314 // For spacing at the left edge, there are several approaches. In
315 // order to get to predictable behavior, we want to have at least a
316 // continuous approach. An obvious idea is to do a "translate" by the
317 // appropriate amount. Doing that while retaining the nominal left
318 // edge seems like the most straightforward way.
321 Stencil::stack (Axis a, Direction d, Stencil const &s, Real padding, Real mindist)
323 // Material that is empty in the axis of reference can't be sensibly
324 // stacked. We just revert to add_at_edge behavior then.
329 toadd.add_stencil (*this);
330 expr_ = toadd.expr ();
331 dim_ = toadd.extent_box ();
335 Interval first_extent = extent (a);
340 toadd.translate_axis (first_extent[d], a);
341 toadd.add_stencil (*this);
342 expr_ = toadd.expr ();
343 dim_ = toadd.extent_box ();
347 Interval next_extent = s.extent (a);
349 // It is somewhat tedious to special-case all spacing, but it turns
350 // out that not doing so makes it astonishingly hard to make the
351 // code do the correct thing.
353 // If first is spacing, we translate second accordingly without
354 // letting this affect its backward edge.
355 if (is_empty (other_axis (a)))
358 Real offset = d * first_extent.delta ();
359 toadd.translate_axis (offset, a);
360 toadd.add_stencil (*this);
361 expr_ = toadd.expr ();
362 dim_ = toadd.extent_box ();
363 dim_[a][-d] = next_extent[-d];
364 dim_[a][d] = next_extent[d] + offset;
368 // If next is spacing, similar action:
369 if (s.is_empty (other_axis (a)))
372 Real offset = first_extent [d];
373 toadd.translate_axis (offset, a);
374 toadd.add_stencil (*this);
375 expr_ = toadd.expr ();
376 dim_ = toadd.extent_box ();
377 dim_[a][-d] = first_extent[-d];
378 dim_[a][d] = first_extent[d] + d * next_extent.delta ();
383 Real offset = first_extent[d];
385 // If the added stencil has a backwardly protruding edge, we make
386 // room for it when combining.
388 if (d * next_extent [-d] < 0)
389 offset -= next_extent [-d];
391 offset += d * padding;
393 if (offset * d < mindist)
394 offset = d * mindist;
397 toadd.translate_axis (offset, a);
398 toadd.add_stencil (*this);
399 expr_ = toadd.expr ();
400 dim_ = toadd.extent_box ();
401 dim_[a][-d] = first_extent [-d];
402 dim_[a][d] = next_extent [d] + offset;
407 Stencil::in_color (Real r, Real g, Real b) const
409 Stencil new_stencil (extent_box (),
410 scm_list_3 (ly_symbol2scm ("color"),
411 scm_list_3 (scm_from_double (r),
413 scm_from_double (b)),
420 Stencil::translated (Offset z) const