lily/dot-column.cc

   1 /*
   2   dot-column.cc -- implement Dot_column
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "dot-column.hh"
  10
  11 #include <cstdio>
  12 #include <cmath>
  13 #include <map>
  14 using namespace std;
  15
  16 #include "dots.hh"
  17 #include "rhythmic-head.hh"
  18 #include "staff-symbol-referencer.hh"
  19 #include "directional-element-interface.hh"
  20 #include "side-position-interface.hh"
  21 #include "axis-group-interface.hh"
  22 #include "stem.hh"
  23 #include "pointer-group-interface.hh"
  24
  25 /*
  26   TODO: let Dot_column communicate with stem via Note_column.
  27 */
  28
  29 MAKE_SCHEME_CALLBACK (Dot_column, side_position, 1);
  30 SCM
  31 Dot_column::side_position (SCM smob)
  32 {
  33   Grob *me = unsmob_grob (smob);
  34   extract_grob_set (me, "dots", dots);
  35
  36   for (vsize i = 0; i  < dots.size (); i++)
  37     {
  38       Grob *head = dots[i]->get_parent (Y_AXIS);
  39       Grob *stem = head ? unsmob_grob (head->get_object ("stem")) : 0;
  40       if (stem
  41           && !Stem::get_beam (stem)
  42           && Stem::duration_log (stem) > 2
  43           && !Stem::is_invisible (stem))
  44         {
  45           /*
  46             trigger stem end & direction calculation.
  47
  48             This will add the stem to the support if a flag collision happens.
  49           */
  50           stem->get_property ("stem-end-position");
  51         }
  52     }
  53
  54   return Side_position_interface::x_aligned_side (smob, SCM_EOL);
  55 }
  56
  57 struct Dot_position
  58 {
  59   int pos_;
  60   Direction dir_;
  61   Grob *dot_;
  62   bool extremal_head_;
  63
  64   Dot_position ()
  65   {
  66     dot_ = 0;
  67     pos_ = 0;
  68     dir_ = CENTER;
  69     extremal_head_ = false;
  70   }
  71 };
  72
  73 typedef map<int, Dot_position> Dot_configuration;
  74
  75 /*
  76   Value CFG according.
  77 */
  78 int
  79 dot_config_badness (Dot_configuration const &cfg)
  80 {
  81   int t = 0;
  82   for (Dot_configuration::const_iterator i (cfg.begin ());
  83        i != cfg.end (); i++)
  84     {
  85       int p = i->first;
  86       int demerit = sqr (p - i->second.pos_) * 2;
  87
  88       int dot_move_dir = sign (p - i->second.pos_);
  89       if (i->second.extremal_head_)
  90         {
  91           if (i->second.dir_
  92               && dot_move_dir != i->second.dir_)
  93             demerit += 3;
  94           else if (dot_move_dir != UP)
  95             demerit += 2;
  96         }
  97       else if (dot_move_dir != UP)
  98         demerit += 1;
  99
 100       t += demerit;
 101     }
 102
 103   return t;
 104 }
 105
 106 void
 107 print_dot_configuration (Dot_configuration const &cfg)
 108 {
 109   printf ("dotconf { ");
 110   for (Dot_configuration::const_iterator i (cfg.begin ());
 111        i != cfg.end (); i++)
 112     printf ("%d, ", i->first);
 113   printf ("} \n");
 114 }
 115
 116 /*
 117   Shift K and following (preceding) entries up (down) as necessary to
 118   prevent staffline collisions if D is up (down).
 119
 120   If K is in CFG, then do nothing.
 121 */
 122
 123 Dot_configuration
 124 shift_one (Dot_configuration const &cfg,
 125            int k, Direction d)
 126 {
 127   Dot_configuration new_cfg;
 128   int offset = 0;
 129
 130   if (d > 0)
 131     {
 132       for (Dot_configuration::const_iterator i (cfg.begin ());
 133            i != cfg.end (); i++)
 134         {
 135           int p = i->first;
 136           if (p == k)
 137             {
 138               if (Staff_symbol_referencer::on_line (i->second.dot_, p))
 139                 p += d;
 140               else
 141                 p += 2* d;
 142
 143               offset = 2*d;
 144
 145               new_cfg[p] = i->second;
 146             }
 147           else
 148             {
 149               if (new_cfg.find (p) == new_cfg.end ())
 150                 offset = 0;
 151               new_cfg[p + offset] = i->second;
 152             }
 153         }
 154     }
 155   else
 156     {
 157       Dot_configuration::const_iterator i (cfg.end ());
 158       do
 159         {
 160           i--;
 161
 162           int p = i->first;
 163           if (p == k)
 164             {
 165               if (Staff_symbol_referencer::on_line (i->second.dot_, p))
 166                 p += d;
 167               else
 168                 p += 2* d;
 169
 170               offset = 2*d;
 171
 172               new_cfg[p] = i->second;
 173             }
 174           else
 175             {
 176               if (new_cfg.find (p) == new_cfg.end ())
 177                 offset = 0;
 178
 179               new_cfg[p + offset] = i->second;
 180             }
 181         }
 182       while (i != cfg.begin ());
 183     }
 184
 185   return new_cfg;
 186 }
 187
 188 /*
 189   Remove the collision in CFG either by shifting up or down, whichever
 190   is best.
 191 */
 192 void
 193 remove_collision (Dot_configuration &cfg, int p)
 194 {
 195   bool collide = cfg.find (p) != cfg.end ();
 196
 197   if (collide)
 198     {
 199       Dot_configuration cfg_up = shift_one (cfg, p, UP);
 200       Dot_configuration cfg_down = shift_one (cfg, p, DOWN);
 201
 202       int b_up = dot_config_badness (cfg_up);
 203       int b_down = dot_config_badness (cfg_down);
 204
 205       cfg = (b_up < b_down) ? cfg_up : cfg_down;
 206     }
 207 }
 208
 209 MAKE_SCHEME_CALLBACK(Dot_column, calc_positioning_done, 1);
 210 SCM
 211 Dot_column::calc_positioning_done (SCM smob)
 212 {
 213   Grob *me = unsmob_grob (smob);
 214   vector<Grob*> dots
 215     = extract_grob_array (me, "dots");
 216
 217   { /*
 218       Trigger note collision resolution first, since that may kill off
 219       dots when merging.
 220     */
 221     Grob *c = 0;
 222     for (vsize i = dots.size (); i--;)
 223       {
 224         Grob *n = dots[i]->get_parent (Y_AXIS);
 225         if (c)
 226           c = n->common_refpoint (c, X_AXIS);
 227         else
 228           c = n;
 229       }
 230     for (vsize i = dots.size (); i--;)
 231       {
 232         Grob *n = dots[i]->get_parent (Y_AXIS);
 233         n->relative_coordinate (c, X_AXIS);
 234       }
 235   }
 236
 237   vector_sort (dots, position_less);
 238   for (vsize i = dots.size (); i--;)
 239     if (!dots[i]->is_live ())
 240       dots.erase (dots.begin () + i);
 241
 242   Dot_configuration cfg;
 243   for (vsize i = 0;i < dots.size (); i++)
 244     {
 245       Dot_position dp;
 246       dp.dot_ = dots[i];
 247
 248       Grob *note = dots[i]->get_parent (Y_AXIS);
 249       if (note)
 250         {
 251           Grob *stem = unsmob_grob (note->get_object ("stem"));
 252           if (stem)
 253             dp.extremal_head_ = Stem::first_head (stem) == note;
 254         }
 255
 256       int p = Staff_symbol_referencer::get_rounded_position (dp.dot_);
 257       dp.pos_ = p;
 258
 259       if (dp.extremal_head_)
 260         dp.dir_ = to_dir (dp.dot_->get_property ("direction"));
 261
 262       remove_collision (cfg, p);
 263       cfg[p] = dp;
 264       if (Staff_symbol_referencer::on_line (dp.dot_, p))
 265         remove_collision (cfg, p);
 266     }
 267
 268   for (Dot_configuration::const_iterator i (cfg.begin ());
 269        i != cfg.end (); i++)
 270     {
 271       /*
 272         Junkme?
 273        */
 274       Staff_symbol_referencer::set_position (i->second.dot_, i->first);
 275     }
 276   return SCM_BOOL_T;
 277 }
 278
 279 void
 280 Dot_column::add_head (Grob *me, Grob *rh)
 281 {
 282   Grob *d = unsmob_grob (rh->get_object ("dot"));
 283   if (d)
 284     {
 285       Side_position_interface::add_support (me, rh);
 286
 287       Pointer_group_interface::add_grob (me, ly_symbol2scm ("dots"), d);
 288       d->set_property ("Y-offset", Grob::x_parent_positioning_proc);
 289       Axis_group_interface::add_element (me, d);
 290     }
 291 }
 292
 293 ADD_INTERFACE (Dot_column,
 294                "dot-column-interface",
 295
 296                "Groups dot objects so they form a column, and position dots so they do not "
 297                "clash with staff lines ",
 298
 299                /* properties */
 300                "dots "
 301                "positioning-done "
 302                "direction "
 303                );
 304