lily/stencil.cc

   1 /*
   2   stencil.cc -- implement Stencil
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include <math.h>
  10 #include <libc-extension.hh>    // isinf
  11
  12 #include "font-metric.hh"
  13 #include "dimensions.hh"
  14 #include "interval.hh"
  15 #include "string.hh"
  16 #include "stencil.hh"
  17 #include "warn.hh"
  18
  19 #include "ly-smobs.icc"
  20
  21 Stencil::Stencil ()
  22 {
  23   expr_ = SCM_EOL;
  24   set_empty (true);
  25 }
  26
  27 Stencil::Stencil (Box b, SCM func)
  28 {
  29   expr_ = func;
  30   dim_ = b;
  31 }
  32
  33 int
  34 Stencil::print_smob (SCM, SCM port, scm_print_state *)
  35 {
  36   scm_puts ("#<Stencil ", port);
  37   scm_puts (" >", port);
  38   return 1;
  39 }
  40
  41 SCM
  42 Stencil::mark_smob (SCM smob)
  43 {
  44   Stencil *s = (Stencil*) ly_cdr (smob);
  45   return s->expr_;
  46 }
  47
  48 IMPLEMENT_SIMPLE_SMOBS (Stencil);
  49 IMPLEMENT_TYPE_P (Stencil, "ly:stencil?");
  50 IMPLEMENT_DEFAULT_EQUAL_P (Stencil);
  51
  52 Interval
  53 Stencil::extent (Axis a) const
  54 {
  55   return dim_[a];
  56 }
  57
  58 Offset
  59 Stencil::origin () const
  60 {
  61   return origin_;
  62 }
  63
  64 void
  65 Stencil::translate (Offset o)
  66 {
  67   Axis a = X_AXIS;
  68   while (a < NO_AXES)
  69     {
  70       if (abs (o[a]) > 100 CM
  71           || isinf (o[a]) || isnan (o[a]))
  72         {
  73           programming_error ("Improbable offset for translation: setting to zero");
  74           o[a] =  0.0;
  75         }
  76       incr (a);
  77     }
  78
  79   expr_ = scm_list_n (ly_symbol2scm ("translate-stencil"),
  80                       ly_offset2scm (o),
  81                       expr_, SCM_UNDEFINED);
  82   if (!is_empty ())
  83     dim_.translate (o);
  84   origin_ += o;
  85 }
  86
  87 void
  88 Stencil::translate_axis (Real x, Axis a)
  89 {
  90   Offset o (0,0);
  91   o[a] = x;
  92   translate (o);
  93 }
  94
  95 void
  96 Stencil::add_stencil (Stencil const &s)
  97 {
  98   expr_ = scm_list_3 (ly_symbol2scm ("combine-stencil"), s.expr_, expr_);
  99   dim_.unite (s.dim_);
 100 }
 101
 102 void
 103 Stencil::set_empty (bool e)
 104 {
 105   if (e)
 106     {
 107       dim_[X_AXIS].set_empty ();
 108       dim_[Y_AXIS].set_empty ();
 109     }
 110   else
 111     {
 112       dim_[X_AXIS] = Interval (0,0);
 113       dim_[Y_AXIS] = Interval (0,0);
 114     }
 115 }
 116
 117 void
 118 Stencil::align_to (Axis a, Real x)
 119 {
 120   if (is_empty ())
 121     return ;
 122
 123   Interval i (extent (a));
 124   translate_axis (-i.linear_combination (x), a);
 125 }
 126
 127 /* FIXME: unintuitive naming, you would expect *this to be moved.
 128    Kept (keeping?) API for compat with add_at_edge ().  */
 129 Stencil
 130 Stencil::moved_to_edge (Axis a, Direction d, Stencil const &s, Real padding,
 131                         Real minimum) const
 132 {
 133   Interval my_extent=  dim_[a];
 134
 135
 136   Interval i (s.extent (a));
 137   Real his_extent;
 138   if (i.is_empty ())
 139     {
 140       programming_error ("Stencil::moved_to_edge: adding empty stencil.");
 141       his_extent = 0.0;
 142     }
 143   else
 144     his_extent = i[-d];
 145
 146   Real offset = (my_extent.  is_empty () ? 0.0 : my_extent[d] - his_extent)
 147     + d * padding;
 148
 149   Stencil toadd (s);
 150   toadd.translate_axis (offset,a);
 151
 152   if (minimum > 0
 153       && d *(- origin ()[a] + toadd.origin ()[a]) < minimum)
 154     toadd.translate_axis ( -toadd.origin ()[a]
 155                            + origin ()[a] + d* minimum, a);
 156
 157   return toadd;
 158 }
 159
 160 /*  See scheme Function.  */
 161 void
 162 Stencil::add_at_edge (Axis a, Direction d, Stencil const &s, Real padding,
 163                       Real minimum)
 164 {
 165   add_stencil (moved_to_edge (a, d, s, padding, minimum));
 166 }
 167
 168 /* Hmm... maybe this is not such a good idea ; stuff can be empty,
 169    while expr_ == '()  */
 170 bool
 171 Stencil::is_empty () const
 172 {
 173   return expr_ == SCM_EOL;
 174 }
 175
 176 SCM
 177 Stencil::get_expr () const
 178 {
 179   return expr_;
 180 }
 181
 182 Box
 183 Stencil::extent_box () const
 184 {
 185   return dim_;
 186 }