/*
- stencil.cc -- implement Stencil
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-*/
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
-#include "stencil.hh"
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
-#include <math.h>
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
-#include <libc-extension.hh> // isinf
+#include "stencil.hh"
-#include "input-smob.hh"
+#include "main.hh"
#include "font-metric.hh"
-#include "dimensions.hh"
+#include "input.hh"
#include "string-convert.hh"
#include "warn.hh"
SCM
Stencil::mark_smob (SCM smob)
{
- Stencil *s = (Stencil*) SCM_CELL_WORD_1 (smob);
+ Stencil *s = (Stencil *) SCM_CELL_WORD_1 (smob);
return s->expr_;
}
return dim_[a];
}
-/* Hmm... maybe this is not such a good idea ; stuff can be empty,
- while expr_ == '() */
bool
Stencil::is_empty () const
{
- return expr_ == SCM_EOL;
+ return (expr_ == SCM_EOL
+ || dim_.is_empty ());
+}
+
+bool
+Stencil::is_empty (Axis a) const
+{
+ return dim_.is_empty (a);
}
SCM
{
return dim_;
}
-Offset
-Stencil::origin () const
+
+void
+Stencil::rotate (Real a, Offset off)
{
- return origin_;
+ rotate_degrees (a * 180 / M_PI, off);
+}
+
+/*
+ Rotate this stencil around the point ABSOLUTE_OFF.
+
+ */
+void
+Stencil::rotate_degrees_absolute (Real a, Offset absolute_off)
+{
+ const Real x = absolute_off[X_AXIS];
+ const Real y = absolute_off[Y_AXIS];
+
+ /*
+ * Build scheme expression (processed in stencil-interpret.cc)
+ */
+ /* TODO: by hanwenn 2008/09/10 14:38:56:
+ * in effect, this copies the underlying expression. It might be a
+ * little bit nicer to mirror this in the api, ie. make a
+ * Stencil::rotated()
+ * and have Stencil::rotate be an abbrev of
+ * *this = rotated()
+ */
+
+ expr_ = scm_list_n (ly_symbol2scm ("rotate-stencil"),
+ scm_list_2 (scm_from_double (a),
+ scm_cons (scm_from_double (x), scm_from_double (y))),
+ expr_, SCM_UNDEFINED);
+
+ /*
+ * Calculate the new bounding box
+ */
+ Box shifted_box = extent_box ();
+ shifted_box.translate (-absolute_off);
+
+ vector<Offset> pts;
+ pts.push_back (Offset (shifted_box.x ().at (LEFT), shifted_box.y ().at (DOWN)));
+ pts.push_back (Offset (shifted_box.x ().at (RIGHT), shifted_box.y ().at (DOWN)));
+ pts.push_back (Offset (shifted_box.x ().at (RIGHT), shifted_box.y ().at (UP)));
+ pts.push_back (Offset (shifted_box.x ().at (LEFT), shifted_box.y ().at (UP)));
+
+ const Offset rot = complex_exp (Offset (0, a * M_PI / 180.0));
+ dim_.set_empty ();
+ for (vsize i = 0; i < pts.size (); i++)
+ dim_.add_point (pts[i] * rot + absolute_off);
+}
+
+/*
+ Rotate this stencil around the point RELATIVE_OFF.
+
+ RELATIVE_OFF is measured in terms of the extent of the stencil, so
+ -1 = LEFT/DOWN edge, 1 = RIGHT/UP edge.
+ */
+void
+Stencil::rotate_degrees (Real a, Offset relative_off)
+{
+ /*
+ * Calculate the center of rotation
+ */
+ const Real x = extent (X_AXIS).linear_combination (relative_off[X_AXIS]);
+ const Real y = extent (Y_AXIS).linear_combination (relative_off[Y_AXIS]);
+ rotate_degrees_absolute (a, Offset (x, y));
}
void
Axis a = X_AXIS;
while (a < NO_AXES)
{
- if (isinf (o[a]) || isnan (o[a]))
- {
- programming_error (String_convert::form_string ("Improbable offset for stencil: %f staff space", o[a])
- + "\n"
- + "Setting to zero.");
- o[a] = 0.0;
- }
+ if (isinf (o[a])
+ || isnan (o[a])
+
+ // ugh, hardcoded.
+ || fabs (o[a]) > 1e6)
+ {
+ programming_error (String_convert::form_string ("Improbable offset for stencil: %f staff space", o[a])
+ + "\n"
+ + "Setting to zero.");
+ o[a] = 0.0;
+ if (strict_infinity_checking)
+ scm_misc_error (__FUNCTION__, "Improbable offset.", SCM_EOL);
+ }
incr (a);
}
- expr_ = scm_list_n (ly_symbol2scm ("translate-stencil"),
- ly_offset2scm (o),
- expr_, SCM_UNDEFINED);
+ if (!scm_is_null (expr_))
+ expr_ = scm_list_n (ly_symbol2scm ("translate-stencil"),
+ ly_offset2scm (o),
+ expr_, SCM_UNDEFINED);
if (!is_empty ())
dim_.translate (o);
- origin_ += o;
}
void
translate (o);
}
+void
+Stencil::scale (Real x, Real y)
+{
+ expr_ = scm_list_3 (ly_symbol2scm ("scale-stencil"),
+ scm_list_2 (scm_from_double (x),
+ scm_from_double (y)),
+ expr_);
+ dim_[X_AXIS] *= x;
+ dim_[Y_AXIS] *= y;
+}
+
void
Stencil::add_stencil (Stencil const &s)
{
- expr_ = scm_list_3 (ly_symbol2scm ("combine-stencil"), s.expr_, expr_);
+ SCM cs = ly_symbol2scm ("combine-stencil");
+ if (scm_is_null (expr_))
+ expr_ = s.expr_;
+ else if (scm_is_null (s.expr_))
+ ;
+ else if (scm_is_pair (expr_)
+ && scm_is_eq (cs, scm_car (expr_)))
+ {
+ if (scm_is_pair (s.expr_)
+ && scm_is_eq (cs, scm_car (s.expr_)))
+ expr_ = scm_append (scm_list_2 (s.expr_, scm_cdr (expr_)));
+ else
+ expr_ = scm_cons2 (cs, s.expr_, scm_cdr (expr_));
+ }
+ else
+ {
+ if (scm_is_pair (s.expr_)
+ && scm_is_eq (cs, scm_car (s.expr_)))
+ expr_ = scm_append (scm_list_2 (s.expr_, scm_list_1 (expr_)));
+ else
+ expr_ = scm_list_3 (cs, s.expr_, expr_);
+ }
dim_.unite (s.dim_);
}
-
-
void
Stencil::set_empty (bool e)
{
void
Stencil::align_to (Axis a, Real x)
{
- if (is_empty ())
+ if (is_empty (a))
return;
Interval i (extent (a));
translate_axis (-i.linear_combination (x), a);
}
-/* FIXME: unintuitive naming, you would expect *this to be moved.
- Kept (keeping?) API for compat with add_at_edge ().
+/* See scheme Function. */
- What is PADDING, what is MINIMUM, exactly? */
-Stencil
-Stencil::moved_to_edge (Axis a, Direction d, Stencil const &s,
- Real padding, Real minimum) const
+// Any stencil that is empty in the orthogonal axis is spacing.
+// Spacing is not subjected to the max (0) rule and can thus be
+// negative.
+
+void
+Stencil::add_at_edge (Axis a, Direction d, Stencil const &s, Real padding)
{
- Interval my_extent = dim_[a];
- Interval i (s.extent (a));
- Real his_extent;
- if (i.is_empty ())
+ // Material that is empty in the axis of reference has only limited
+ // usefulness for combining. We still retain as much information as
+ // available since there may be uses like setting page links or
+ // background color or watermarks, and off-axis extents.
+
+ if (is_empty (a))
{
- programming_error ("Stencil::moved_to_edge: adding empty stencil.");
- his_extent = 0.0;
- // SCM_ASSERT_TYPE (0, s.expr (), SCM_ARG1, __FUNCTION__, "non-empty stencil");
+ add_stencil (s);
+ return;
}
- else
- his_extent = i[-d];
- Real offset = (my_extent.is_empty () ? 0.0 : my_extent[d] - his_extent)
- + d * padding;
+ Interval first_extent = extent (a);
- Stencil toadd (s);
- toadd.translate_axis (offset, a);
+ if (s.is_empty (a))
+ {
+ Stencil toadd (s);
+ // translation does not affect axis-empty extent box.
+ toadd.translate_axis (first_extent[d], a);
+ add_stencil (toadd);
+ return;
+ }
- if (minimum > 0 && d * (-origin ()[a] + toadd.origin ()[a]) < minimum)
- toadd.translate_axis ( -toadd.origin ()[a]
- + origin ()[a] + d * minimum, a);
+ Interval next_extent = s.extent (a);
- return toadd;
-}
+ bool first_is_spacing = is_empty (other_axis (a));
+ bool next_is_spacing = s.is_empty (other_axis (a));
-/* See scheme Function. */
-void
-Stencil::add_at_edge (Axis a, Direction d, Stencil const &s, Real padding,
- Real minimum)
-{
- add_stencil (moved_to_edge (a, d, s, padding, minimum));
-}
+ Real offset = first_extent[d] - next_extent[-d];
+ if (!(first_is_spacing || next_is_spacing))
+ {
+ offset += d * padding;
+ }
-/****************************************************************/
+ Stencil toadd (s);
+ toadd.translate_axis (offset, a);
+ add_stencil (toadd);
+}
+// Stencil::stack is mainly used for assembling lines or columns
+// of stencils. For the most common case of adding at the right, the
+// reference point of the added stencil is usually placed at the right
+// edge of the current one, unless the added stencil has a negative
+// left extent in which case its left edge is placed at the right edge
+// of the current one.
+//
+// Spacing is special in that it is applied without padding. Spacing
+// at the right edge shifts the right edge accordingly.
+//
+// For spacing at the left edge, there are several approaches. In
+// order to get to predictable behavior, we want to have at least a
+// continuous approach. An obvious idea is to do a "translate" by the
+// appropriate amount. Doing that while retaining the nominal left
+// edge seems like the most straightforward way.
void
-interpret_stencil_expression (SCM expr,
- void (*func) (void*, SCM),
- void *func_arg,
- Offset o)
+Stencil::stack (Axis a, Direction d, Stencil const &s, Real padding, Real mindist)
{
- while (1)
+ // Material that is empty in the axis of reference can't be sensibly
+ // stacked. We just revert to add_at_edge behavior then.
+
+ if (is_empty (a))
{
- if (!scm_is_pair (expr))
- return;
+ Stencil toadd (s);
+ toadd.add_stencil (*this);
+ expr_ = toadd.expr ();
+ dim_ = toadd.extent_box ();
+ return;
+ }
- SCM head = scm_car (expr);
+ Interval first_extent = extent (a);
- if (head == ly_symbol2scm ("translate-stencil"))
- {
- o += ly_scm2offset (scm_cadr (expr));
- expr = scm_caddr (expr);
- }
- else if (head == ly_symbol2scm ("combine-stencil"))
- {
- for (SCM x = scm_cdr (expr); scm_is_pair (x); x = scm_cdr (x))
- interpret_stencil_expression (scm_car (x), func, func_arg, o);
- return;
- }
- else if (head == ly_symbol2scm ("grob-cause"))
- {
- SCM grob = scm_cadr (expr);
-
- (*func) (func_arg, scm_list_2 (head, grob));
- interpret_stencil_expression (scm_caddr (expr), func, func_arg, o);
- (*func) (func_arg, scm_list_1 (ly_symbol2scm ("no-origin")));
- return;
- }
- else if (head == ly_symbol2scm ("color"))
- {
- SCM color = scm_cadr (expr);
- SCM r = scm_car (color);
- SCM g = scm_cadr (color);
- SCM b = scm_caddr (color);
-
- (*func) (func_arg, scm_list_4 (ly_symbol2scm ("setcolor"), r, g, b));
- interpret_stencil_expression (scm_caddr (expr), func, func_arg, o);
- (*func) (func_arg, scm_list_1 (ly_symbol2scm ("resetcolor")));
-
- return;
- }
- else
- {
- (*func) (func_arg,
- scm_list_4 (ly_symbol2scm ("placebox"),
- scm_make_real (o[X_AXIS]),
- scm_make_real (o[Y_AXIS]),
- expr));
- return;
- }
+ if (s.is_empty (a))
+ {
+ Stencil toadd (s);
+ toadd.translate_axis (first_extent[d], a);
+ toadd.add_stencil (*this);
+ expr_ = toadd.expr ();
+ dim_ = toadd.extent_box ();
+ return;
}
-}
+ Interval next_extent = s.extent (a);
-struct Font_list
-{
- SCM fonts_;
-};
-
-static void
-find_font_function (void *fs, SCM x)
-{
- Font_list *me = (Font_list*) fs;
+ // It is somewhat tedious to special-case all spacing, but it turns
+ // out that not doing so makes it astonishingly hard to make the
+ // code do the correct thing.
- if (scm_car (x) == ly_symbol2scm ("placebox"))
+ // If first is spacing, we translate second accordingly without
+ // letting this affect its backward edge.
+ if (is_empty (other_axis (a)))
{
- SCM args = scm_cdr (x);
- SCM what = scm_caddr (args);
+ Stencil toadd (s);
+ Real offset = d * first_extent.delta ();
+ toadd.translate_axis (offset, a);
+ toadd.add_stencil (*this);
+ expr_ = toadd.expr ();
+ dim_ = toadd.extent_box ();
+ dim_[a][-d] = next_extent[-d];
+ dim_[a][d] = next_extent[d] + offset;
+ return;
+ }
- if (scm_is_pair (what))
- {
- SCM head = scm_car (what);
- if (ly_symbol2scm ("text") == head)
- me->fonts_ = scm_cons (scm_cadr (what), me->fonts_);
- else if (head == ly_symbol2scm ("char"))
- me->fonts_ = scm_cons (scm_cadr (what), me->fonts_);
- }
+ // If next is spacing, similar action:
+ if (s.is_empty (other_axis (a)))
+ {
+ Stencil toadd (s);
+ Real offset = first_extent [d];
+ toadd.translate_axis (offset, a);
+ toadd.add_stencil (*this);
+ expr_ = toadd.expr ();
+ dim_ = toadd.extent_box ();
+ dim_[a][-d] = first_extent[-d];
+ dim_[a][d] = first_extent[d] + d * next_extent.delta ();
+ return;
}
-}
-SCM
-find_expression_fonts (SCM expr)
-{
- Font_list fl;
- fl.fonts_ = SCM_EOL;
+ Real offset = first_extent[d];
+
+ // If the added stencil has a backwardly protruding edge, we make
+ // room for it when combining.
- interpret_stencil_expression (expr, &find_font_function,
- (void*) &fl, Offset (0, 0));
+ if (d * next_extent [-d] < 0)
+ offset -= next_extent [-d];
- return fl.fonts_;
+ offset += d * padding;
+
+ if (offset * d < mindist)
+ offset = d * mindist;
+
+ Stencil toadd (s);
+ toadd.translate_axis (offset, a);
+ toadd.add_stencil (*this);
+ expr_ = toadd.expr ();
+ dim_ = toadd.extent_box ();
+ dim_[a][-d] = first_extent [-d];
+ dim_[a][d] = next_extent [d] + offset;
}
+Stencil
+Stencil::in_color (Real r, Real g, Real b) const
+{
+ Stencil new_stencil (extent_box (),
+ scm_list_3 (ly_symbol2scm ("color"),
+ scm_list_3 (scm_from_double (r),
+ scm_from_double (g),
+ scm_from_double (b)),
+ expr ()));
+ return new_stencil;
+}
+
+/* convenience */
+Stencil
+Stencil::translated (Offset z) const
+{
+ Stencil s (*this);
+ s.translate (z);
+ return s;
+}
projects / lilypond.git / blobdiff