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