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