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--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "dot-column.hh"
  10
  11 #include <cstdio>
  12 #include <cmath>
  13 #include <map>
  14 #include <set>
  15
  16 using namespace std;
  17
  18 #include "dots.hh"
  19 #include "dot-column.hh"
  20 #include "rhythmic-head.hh"
  21 #include "staff-symbol-referencer.hh"
  22 #include "directional-element-interface.hh"
  23 #include "side-position-interface.hh"
  24 #include "axis-group-interface.hh"
  25 #include "stem.hh"
  26 #include "grob.hh"
  27 #include "pointer-group-interface.hh"
  28 #include "dot-configuration.hh"
  29 #include "note-head.hh"
  30 #include "rest.hh"
  31 #include "dot-formatting-problem.hh"
  32
  33 MAKE_SCHEME_CALLBACK (Dot_column, calc_positioning_done, 1);
  34 SCM
  35 Dot_column::calc_positioning_done (SCM smob)
  36 {
  37   Grob *me = unsmob_grob (smob);
  38
  39   me->set_property ("positioning-done", SCM_BOOL_T);
  40
  41   vector<Grob*> dots
  42     = extract_grob_array (me, "dots");
  43
  44   vector<Grob*> main_heads;
  45   Real ss = 0;
  46
  47   Grob *commonx = me;
  48   { /*
  49       Trigger note collision resolution first, since that may kill off
  50       dots when merging.
  51     */
  52     for (vsize i = 0; i < dots.size (); i++)
  53       {
  54         Grob *n = dots[i]->get_parent (Y_AXIS);
  55         commonx = n->common_refpoint (commonx, X_AXIS);
  56
  57         if (Grob *stem = unsmob_grob (n->get_object("stem")))
  58           {
  59             commonx = stem->common_refpoint (commonx, X_AXIS);
  60
  61             if (Stem::first_head (stem) == n)
  62               main_heads.push_back (n);
  63           }
  64       }
  65   }
  66
  67   vector<Box> boxes;
  68   set<Grob*> stems;
  69
  70   extract_grob_set(me, "side-support-elements", support);
  71
  72   Interval base_x;
  73   for (vsize i = 0; i < main_heads.size (); i++)
  74     base_x.unite (main_heads[i]->extent (commonx, X_AXIS));
  75
  76   for (vsize i = 0; i < support.size (); i++)
  77     {
  78       Grob *s = support[i];
  79       if (!ss)
  80         ss = Staff_symbol_referencer::staff_space (s);
  81
  82       /* can't inspect Y extent of rest.
  83
  84          Rest collisions should wait after line breaking.
  85       */
  86       if (Rest::has_interface (s))
  87         {
  88           base_x.unite (s->extent (commonx, X_AXIS));
  89           continue;
  90         }
  91
  92       Interval y = s->extent (s, Y_AXIS);
  93       y *= 2 / ss;
  94       y += Staff_symbol_referencer::get_position (s);
  95
  96       Box b (s->extent (commonx, X_AXIS), y);
  97       boxes.push_back (b);
  98
  99       if (Grob *s = unsmob_grob (s->get_object ("stem")))
 100         stems.insert (s);
 101     }
 102
 103   for (set<Grob*>::const_iterator i(stems.begin());
 104        i != stems.end (); i++)
 105     {
 106       Grob *stem = (*i);
 107       Stencil flag = Stem::flag (stem);
 108       if (!flag.is_empty ())
 109         {
 110           Interval y = flag.extent (Y_AXIS)
 111             * (2 / ss)
 112             + Stem::stem_end_position (stem);
 113
 114           Interval x = stem->relative_coordinate (commonx, X_AXIS)
 115             + flag.extent (X_AXIS);
 116
 117           boxes.push_back (Box (x,y));
 118         }
 119     }
 120
 121   vector_sort (dots, position_less);
 122   for (vsize i = dots.size (); i--;)
 123     if (!dots[i]->is_live ())
 124       dots.erase (dots.begin () + i);
 125
 126   Dot_formatting_problem problem (boxes, base_x);
 127
 128   Dot_configuration cfg (problem);
 129   for (vsize i = 0; i < dots.size (); i++)
 130     {
 131       Dot_position dp;
 132       dp.dot_ = dots[i];
 133
 134       Grob *note = dots[i]->get_parent (Y_AXIS);
 135       if (note)
 136         {
 137           Grob *stem = unsmob_grob (note->get_object ("stem"));
 138           if (stem)
 139             dp.extremal_head_ = Stem::first_head (stem) == note;
 140
 141           dp.x_extent_ = note->extent (commonx, X_AXIS);
 142         }
 143
 144       int p = Staff_symbol_referencer::get_rounded_position (dp.dot_);
 145
 146       /* icky, since this should go via a Staff_symbol_referencer
 147          offset callback but adding a dot overwrites Y-offset. */
 148       p += (int) robust_scm2double (dp.dot_->get_property ("staff-position"), 0.0);
 149       dp.pos_ = p;
 150       if (dp.extremal_head_)
 151         dp.dir_ = to_dir (dp.dot_->get_property ("direction"));
 152
 153       cfg.remove_collision (p);
 154       cfg[p] = dp;
 155       if (Staff_symbol_referencer::on_line (dp.dot_, p))
 156         cfg.remove_collision (p);
 157     }
 158
 159   problem.register_configuration (cfg);
 160
 161   for (Dot_configuration::const_iterator i (cfg.begin ());
 162        i != cfg.end (); i++)
 163     {
 164       /*
 165         Junkme?
 166        */
 167       Staff_symbol_referencer::set_position (i->second.dot_, i->first);
 168     }
 169
 170
 171   me->translate_axis (cfg.x_offset () - me->relative_coordinate (commonx, X_AXIS),
 172                       X_AXIS);
 173   return SCM_BOOL_T;
 174 }
 175
 176 void
 177 Dot_column::add_head (Grob *me, Grob *rh)
 178 {
 179   Grob *d = unsmob_grob (rh->get_object ("dot"));
 180   if (d)
 181     {
 182       Side_position_interface::add_support (me, rh);
 183
 184       Pointer_group_interface::add_grob (me, ly_symbol2scm ("dots"), d);
 185       d->set_property ("Y-offset", Grob::x_parent_positioning_proc);
 186       d->set_property ("X-offset", Grob::x_parent_positioning_proc);
 187       Axis_group_interface::add_element (me, d);
 188     }
 189 }
 190
 191 ADD_INTERFACE (Dot_column,
 192
 193                "Groups dot objects so they form a column, and position dots so they do not "
 194                "clash with staff lines. ",
 195
 196                /* properties */
 197                "dots "
 198                "positioning-done "
 199                "direction "
 200                );
 201