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       if (isinf (o[a]) || isnan (o[a]))
  92         {
  93           programming_error (String_convert::form_string ("Improbable offset for stencil: %f staff space", o[a])
  94                              + "\n"
  95                              + "Setting to zero.");
  96           o[a] =  0.0;
  97         }
  98       incr (a);
  99     }
 100
 101   expr_ = scm_list_n (ly_symbol2scm ("translate-stencil"),
 102                       ly_offset2scm (o),
 103                       expr_, SCM_UNDEFINED);
 104   if (!is_empty ())
 105     dim_.translate (o);
 106   origin_ += o;
 107 }
 108
 109 void
 110 Stencil::translate_axis (Real x, Axis a)
 111 {
 112   Offset o (0,0);
 113   o[a] = x;
 114   translate (o);
 115 }
 116
 117 void
 118 Stencil::add_stencil (Stencil const &s)
 119 {
 120   expr_ = scm_list_3 (ly_symbol2scm ("combine-stencil"), s.expr_, expr_);
 121   dim_.unite (s.dim_);
 122 }
 123
 124
 125
 126 void
 127 Stencil::set_empty (bool e)
 128 {
 129   if (e)
 130     {
 131       dim_[X_AXIS].set_empty ();
 132       dim_[Y_AXIS].set_empty ();
 133     }
 134   else
 135     {
 136       dim_[X_AXIS] = Interval (0,0);
 137       dim_[Y_AXIS] = Interval (0,0);
 138     }
 139 }
 140
 141 void
 142 Stencil::align_to (Axis a, Real x)
 143 {
 144   if (is_empty ())
 145     return;
 146
 147   Interval i (extent (a));
 148   translate_axis (-i.linear_combination (x), a);
 149 }
 150
 151 /* FIXME: unintuitive naming, you would expect *this to be moved.
 152    Kept (keeping?) API for compat with add_at_edge ().
 153
 154    What is PADDING, what is MINIMUM, exactly?  */
 155 Stencil
 156 Stencil::moved_to_edge (Axis a, Direction d, Stencil const &s,
 157                         Real padding, Real minimum) const
 158 {
 159   Interval my_extent = dim_[a];
 160   Interval i (s.extent (a));
 161   Real his_extent;
 162   if (i.is_empty ())
 163     {
 164       programming_error ("Stencil::moved_to_edge: adding empty stencil.");
 165       his_extent = 0.0;
 166     }
 167   else
 168     his_extent = i[-d];
 169
 170   Real offset = (my_extent.is_empty () ? 0.0 : my_extent[d] - his_extent)
 171     + d * padding;
 172
 173   Stencil toadd (s);
 174   toadd.translate_axis (offset,a);
 175
 176   if (minimum > 0 && d * (-origin ()[a] + toadd.origin ()[a]) < minimum)
 177     toadd.translate_axis ( -toadd.origin ()[a]
 178                            + origin ()[a] + d * minimum, a);
 179
 180   return toadd;
 181 }
 182
 183 /*  See scheme Function.  */
 184 void
 185 Stencil::add_at_edge (Axis a, Direction d, Stencil const &s, Real padding,
 186                       Real minimum)
 187 {
 188   add_stencil (moved_to_edge (a, d, s, padding, minimum));
 189 }
 190
 191
 192 /****************************************************************/
 193
 194
 195 void
 196 interpret_stencil_expression (SCM expr,
 197                               void (*func) (void*, SCM),
 198                               void *func_arg,
 199                               Offset o)
 200 {
 201   while (1)
 202     {
 203       if (!scm_is_pair (expr))
 204         return;
 205
 206       SCM head = scm_car (expr);
 207
 208       if (head == ly_symbol2scm ("translate-stencil"))
 209         {
 210           o += ly_scm2offset (scm_cadr (expr));
 211           expr = scm_caddr (expr);
 212         }
 213       else if (head == ly_symbol2scm ("combine-stencil"))
 214         {
 215           for (SCM x = scm_cdr (expr); scm_is_pair (x); x = scm_cdr (x))
 216             interpret_stencil_expression (scm_car (x), func, func_arg, o);
 217           return;
 218         }
 219       else if (head == ly_symbol2scm ("grob-cause"))
 220         {
 221           SCM grob = scm_cadr (expr);
 222
 223           (*func) (func_arg, scm_list_2 (head, grob));
 224           interpret_stencil_expression (scm_caddr (expr), func, func_arg, o);
 225           (*func) (func_arg, scm_list_1 (ly_symbol2scm ("no-origin")));
 226           return;
 227         }
 228       else
 229         {
 230           (*func) (func_arg,
 231                    scm_list_4 (ly_symbol2scm ("placebox"),
 232                                scm_make_real (o[X_AXIS]),
 233                                scm_make_real (o[Y_AXIS]),
 234                                expr));
 235            return;
 236         }
 237     }
 238 }
 239
 240
 241 struct Font_list
 242 {
 243   SCM fonts_;
 244 };
 245
 246 static void
 247 find_font_function (void *fs, SCM x)
 248 {
 249   Font_list *me = (Font_list*) fs;
 250
 251   if (scm_car (x) == ly_symbol2scm ("placebox"))
 252     {
 253       SCM args = scm_cdr (x);
 254       SCM what = scm_caddr (args);
 255
 256       if (scm_is_pair (what))
 257         {
 258           SCM head = scm_car (what);
 259           if (ly_symbol2scm ("text") == head)
 260             me->fonts_ = scm_cons (scm_cadr (what), me->fonts_);
 261           else if (head == ly_symbol2scm ("char"))
 262             me->fonts_ = scm_cons (scm_cadr (what), me->fonts_);
 263         }
 264     }
 265 }
 266
 267 SCM
 268 find_expression_fonts (SCM expr)
 269 {
 270   Font_list fl;
 271
 272   fl.fonts_ = SCM_EOL;
 273
 274   interpret_stencil_expression (expr, &find_font_function,
 275                                 (void*) &fl, Offset (0,0));
 276
 277   return fl.fonts_;
 278 }
 279
 280
 281 LY_DEFINE (ly_stencil_fonts, "ly:stencil-fonts",
 282            1, 0, 0, (SCM s),
 283           " Analyse @var{s}, and return a list of fonts used in @var{s}.")
 284 {
 285   Stencil *stil = unsmob_stencil (s);
 286   SCM_ASSERT_TYPE (stil, s, SCM_ARG1, __FUNCTION__, "Stencil");
 287   return find_expression_fonts (stil->expr ());
 288 }
 289
 290 struct Stencil_interpret_arguments
 291 {
 292   SCM func;
 293   SCM arg1;
 294 };
 295
 296 void stencil_interpret_in_scm (void *p, SCM expr)
 297 {
 298   Stencil_interpret_arguments *ap = (Stencil_interpret_arguments*) p;
 299   scm_call_2 (ap->func, ap->arg1, expr);
 300 }
 301
 302
 303
 304 LY_DEFINE (ly_interpret_stencil_expression, "ly:interpret-stencil-expression",
 305            4, 0, 0, (SCM expr, SCM func, SCM arg1, SCM offset),
 306            "Parse EXPR, feed bits to FUNC with first arg ARG1")
 307 {
 308   SCM_ASSERT_TYPE (ly_c_procedure_p(func), func, SCM_ARG1, __FUNCTION__,
 309                    "procedure");
 310
 311   Stencil_interpret_arguments a;
 312   a.func = func;
 313   a.arg1 = arg1;
 314   Offset o = ly_scm2offset (offset);
 315
 316   interpret_stencil_expression (expr, stencil_interpret_in_scm, (void*) &a, o);
 317
 318   return SCM_UNSPECIFIED;
 319 }
 320