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 "input.hh"
  13 #include "font-metric.hh"
  14 #include "dimensions.hh"
  15 #include "interval.hh"
  16 #include "string.hh"
  17 #include "stencil.hh"
  18 #include "warn.hh"
  19
  20 #include "ly-smobs.icc"
  21
  22 Stencil::Stencil ()
  23 {
  24   expr_ = SCM_EOL;
  25   set_empty (true);
  26 }
  27
  28 Stencil::Stencil (Box b, SCM func)
  29 {
  30   expr_ = func;
  31   dim_ = b;
  32 }
  33
  34 int
  35 Stencil::print_smob (SCM, SCM port, scm_print_state *)
  36 {
  37   scm_puts ("#<Stencil ", port);
  38   scm_puts (" >", port);
  39   return 1;
  40 }
  41
  42 SCM
  43 Stencil::mark_smob (SCM smob)
  44 {
  45   Stencil *s = (Stencil*) ly_cdr (smob);
  46   return s->expr_;
  47 }
  48
  49 IMPLEMENT_SIMPLE_SMOBS (Stencil);
  50 IMPLEMENT_TYPE_P (Stencil, "ly:stencil?");
  51 IMPLEMENT_DEFAULT_EQUAL_P (Stencil);
  52
  53 Interval
  54 Stencil::extent (Axis a) const
  55 {
  56   return dim_[a];
  57 }
  58
  59 /* Hmm... maybe this is not such a good idea ; stuff can be empty,
  60    while expr_ == '()  */
  61 bool
  62 Stencil::is_empty () const
  63 {
  64   return expr_ == SCM_EOL;
  65 }
  66
  67 SCM
  68 Stencil::expr () const
  69 {
  70   return expr_;
  71 }
  72
  73 Box
  74 Stencil::extent_box () const
  75 {
  76   return dim_;
  77 }
  78 Offset
  79 Stencil::origin () const
  80 {
  81   return origin_;
  82 }
  83
  84 void
  85 Stencil::translate (Offset o)
  86 {
  87   Axis a = X_AXIS;
  88   while (a < NO_AXES)
  89     {
  90       if (abs (o[a]) > 100 CM
  91           || isinf (o[a]) || isnan (o[a]))
  92         {
  93           programming_error ("Improbable offset for translation: setting to zero");
  94           o[a] =  0.0;
  95         }
  96       incr (a);
  97     }
  98
  99   expr_ = scm_list_n (ly_symbol2scm ("translate-stencil"),
 100                       ly_offset2scm (o),
 101                       expr_, SCM_UNDEFINED);
 102   if (!is_empty ())
 103     dim_.translate (o);
 104   origin_ += o;
 105 }
 106
 107 void
 108 Stencil::translate_axis (Real x, Axis a)
 109 {
 110   Offset o (0,0);
 111   o[a] = x;
 112   translate (o);
 113 }
 114
 115 void
 116 Stencil::add_stencil (Stencil const &s)
 117 {
 118   expr_ = scm_list_3 (ly_symbol2scm ("combine-stencil"), s.expr_, expr_);
 119   dim_.unite (s.dim_);
 120 }
 121
 122 void
 123 Stencil::set_empty (bool e)
 124 {
 125   if (e)
 126     {
 127       dim_[X_AXIS].set_empty ();
 128       dim_[Y_AXIS].set_empty ();
 129     }
 130   else
 131     {
 132       dim_[X_AXIS] = Interval (0,0);
 133       dim_[Y_AXIS] = Interval (0,0);
 134     }
 135 }
 136
 137 void
 138 Stencil::align_to (Axis a, Real x)
 139 {
 140   if (is_empty ())
 141     return ;
 142
 143   Interval i (extent (a));
 144   translate_axis (-i.linear_combination (x), a);
 145 }
 146
 147 /* FIXME: unintuitive naming, you would expect *this to be moved.
 148    Kept (keeping?) API for compat with add_at_edge ().
 149
 150    What is PADDING, what is MINIMUM, exactly?  */
 151 Stencil
 152 Stencil::moved_to_edge (Axis a, Direction d, Stencil const &s,
 153                         Real padding, Real minimum) const
 154 {
 155   Interval my_extent = dim_[a];
 156   Interval i (s.extent (a));
 157   Real his_extent;
 158   if (i.is_empty ())
 159     {
 160       programming_error ("Stencil::moved_to_edge: adding empty stencil.");
 161       his_extent = 0.0;
 162     }
 163   else
 164     his_extent = i[-d];
 165
 166   Real offset = (my_extent.is_empty () ? 0.0 : my_extent[d] - his_extent)
 167     + d * padding;
 168
 169   Stencil toadd (s);
 170   toadd.translate_axis (offset,a);
 171
 172   if (minimum > 0 && d * (-origin ()[a] + toadd.origin ()[a]) < minimum)
 173     toadd.translate_axis ( -toadd.origin ()[a]
 174                            + origin ()[a] + d * minimum, a);
 175
 176   return toadd;
 177 }
 178
 179 /*  See scheme Function.  */
 180 void
 181 Stencil::add_at_edge (Axis a, Direction d, Stencil const &s, Real padding,
 182                       Real minimum)
 183 {
 184   add_stencil (moved_to_edge (a, d, s, padding, minimum));
 185 }
 186
 187
 188 /****************************************************************/
 189
 190 void
 191 interpret_stencil_expr (SCM expr,
 192                         void (*func) (void*, SCM),
 193                         void *func_arg,
 194                         Offset o)
 195 {
 196   while (1)
 197     {
 198       if (!ly_c_pair_p (expr))
 199         return;
 200
 201       SCM head =ly_car (expr);
 202       if (unsmob_input (head))
 203         {
 204           Input *ip = unsmob_input (head);
 205           (*func)(func_arg,
 206                   scm_list_4 (ly_symbol2scm ("define-origin"),
 207                               scm_makfrom0str (ip->file_string ()
 208                                                .to_str0 ()),
 209                               scm_int2num (ip->line_number ()),
 210                               scm_int2num (ip->column_number ())));
 211
 212           expr = ly_cadr (expr);
 213         }
 214       else  if (head ==  ly_symbol2scm ("no-origin"))
 215         {
 216           (*func) (func_arg, scm_list_1 (head));
 217           expr = ly_cadr (expr);
 218         }
 219       else if (head == ly_symbol2scm ("translate-stencil"))
 220         {
 221           o += ly_scm2offset (ly_cadr (expr));
 222           expr = ly_caddr (expr);
 223         }
 224       else if (head == ly_symbol2scm ("combine-stencil"))
 225         {
 226           interpret_stencil_expr (ly_cadr (expr), func, func_arg, o);
 227           expr = ly_caddr (expr);
 228         }
 229       else
 230         {
 231           (*func) (func_arg,
 232                    scm_list_4 (ly_symbol2scm ("placebox"),
 233                                scm_make_real (o[X_AXIS]),
 234                                scm_make_real (o[Y_AXIS]),
 235                                expr));
 236           return;
 237         }
 238     }
 239 }
 240
 241
 242 struct Font_list
 243 {
 244   SCM list_;
 245 };
 246
 247 static void
 248 find_font_function (void * fs, SCM x)
 249 {
 250   Font_struct * me = (Font_struct*)fs;
 251
 252   if (ly_car (x) == ly_symbol2scm ("placebox"))
 253     {
 254       SCM args = ly_cdr (x);
 255       SCM what = ly_caddr (x);
 256
 257       if (ly_c_pair_p (what))
 258         {
 259           SCM head = ly_car (what);
 260           if (ly_symbol2scm ("text")  == head)
 261             me->fonts_ = scm_cons (ly_cadr (what), me->fonts_);
 262           else  if (head == ly_symbol2scm ("char"))
 263             me->fonts_ = scm_cons (ly_cadr (what), me->fonts_);
 264         }
 265     }
 266 }
 267
 268 LY_DEFINE(ly_stencil_fonts, "ly:stencil-fonts",
 269           1,0,0, (s),
 270           "Analyse @var{s}, and return a list of fonts used in @var{s}."
 271 {
 272   Stencil *stil =unsmob_stencil (s);
 273   SCM_ASSERT_TYPE (stil, s, SCM_ARG1, __FUNCTION__, "Stencil");
 274   Font_list fl;
 275
 276   fl.list_ = SCM_EOL;
 277
 278   interpret_stencil_expr (stil.expr (), &find_font_function,
 279                           (void*) &fl, Offset (0,0));
 280
 281   return fl.list_;
 282 }