lily/stem.cc

   1 /*
   2   stem.cc -- implement Stem
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996,1997 Han-Wen Nienhuys <hanwen@stack.nl>
   7 */
   8
   9 #include "stem.hh"
  10 #include "dimen.hh"
  11 #include "debug.hh"
  12 #include "paper-def.hh"
  13 #include "note-head.hh"
  14 #include "lookup.hh"
  15 #include "molecule.hh"
  16 #include "p-col.hh"
  17 #include "misc.hh"
  18 #include "beam.hh"
  19 #include "rest.hh"
  20
  21 const int STEMLEN=7;
  22
  23 IMPLEMENT_IS_TYPE_B1 (Stem,Item);
  24
  25 Stem::Stem ()
  26 {
  27   /*
  28     TODO: staff-size
  29    */
  30   abbrev_flag_i_ = 0;
  31   beam_l_ = 0;
  32   beams_left_i_ = 0;
  33   beams_right_i_ = 0;
  34
  35   stem_bottom_f_ = stem_top_f_ = 0;
  36   flag_i_ = 4;
  37   dir_ =CENTER;
  38   staff_size_i_ = 8;
  39
  40   stem_xoffset_f_ =0;
  41   beam_gap_i_ = 0;
  42 }
  43
  44 int
  45 Stem::min_head_i () const
  46 {
  47   int m = 1000;
  48   for (int i =0; i < head_l_arr_.size (); i++)
  49     m = m <? head_l_arr_[i]->position_i_;
  50   return m;
  51 }
  52
  53 int
  54 Stem::max_head_i () const
  55 {
  56   int m = -1000;
  57   for (int i =0; i < head_l_arr_.size (); i++)
  58     m = m >? head_l_arr_[i]->position_i_;
  59   return m;
  60
  61 }
  62
  63 void
  64 Stem::do_print () const
  65 {
  66 #ifndef NPRINT
  67   DOUT << "flag "<< flag_i_ << " print_flag? " << !(bool)beam_l_ << "abbrev_flag_i_" << abbrev_flag_i_;
  68 #endif
  69 }
  70
  71 Real
  72 Stem::stem_length_f () const
  73 {
  74   return stem_top_f_-stem_bottom_f_ ;
  75 }
  76
  77 Real
  78 Stem::stem_start_f () const
  79 {
  80   return (dir_ < 0)? stem_top_f_ : stem_bottom_f_;
  81 }
  82
  83 Real
  84 Stem::stem_end_f () const
  85 {
  86   return (dir_ < 0)? stem_bottom_f_ : stem_top_f_;
  87 }
  88
  89
  90 void
  91 Stem::set_stemend (Real se)
  92 {
  93   // todo: margins
  94   if (!  ((dir_ > 0 && se >= max_head_i ()) ||
  95           (se <= min_head_i () && dir_ <0)))
  96     warning ("Weird stem size; check for narrow beams");
  97
  98   stem_top_f_  = (dir_ < 0) ? max_head_i () : se;
  99   stem_bottom_f_  = (dir_ < 0) ? se  : min_head_i ();
 100 }
 101
 102 int
 103 Stem::type_i () const
 104 {
 105   return head_l_arr_[0]->balltype_i_;
 106 }
 107
 108 void
 109 Stem::add (Note_head *n)
 110 {
 111   n->add_dependency (this);
 112       head_l_arr_.push (n);
 113 }
 114
 115 void
 116 Stem::add (Rest *r)
 117 {
 118   rest_l_arr_.push (r);
 119   r->add_dependency (this);     // ?
 120 }
 121
 122 bool
 123 Stem::invisible_b () const
 124 {
 125
 126   return !head_l_arr_.size () ||
 127     head_l_arr_[0]->balltype_i_ <= 0;
 128
 129 }
 130
 131 // if dir_ is set we return fake values.
 132
 133 int
 134 Stem::get_center_distance_from_top ()
 135 {
 136   if (dir_)
 137     return (dir_ > 0) ? 0 : 1;
 138
 139   int staff_center = staff_size_i_ / 2;
 140   int max = max_head_i () - staff_center;
 141   return max >? 0;
 142 }
 143
 144 // if dir_ is set we return fake values.
 145 int
 146 Stem::get_center_distance_from_bottom ()
 147 {
 148   if (dir_)
 149     return (dir_ > 0) ? 1 : 0;
 150
 151   int staff_center = staff_size_i_ / 2;
 152   int min = staff_center - min_head_i ();
 153   return min >? 0;
 154 }
 155
 156 Direction
 157 Stem::get_default_dir ()
 158 {
 159   if (dir_)
 160     return dir_;
 161   return (get_center_distance_from_top () >=
 162     get_center_distance_from_bottom ()) ?
 163     (Direction)-1 : (Direction)1;
 164 }
 165
 166
 167 void
 168 Stem::set_default_dir ()
 169 {
 170   dir_ = get_default_dir ();
 171 }
 172
 173 void
 174 Stem::set_default_stemlen ()
 175 {
 176   if (!dir_)
 177     set_default_dir ();
 178
 179   // ugh... how about non 5-line staffs?
 180   bool on_ledger_line_b = ((max_head_i () < -2 && dir_ == 1)
 181 //    || (min_head_i () > staff_size_i_ && dir_ == -1));
 182     || (min_head_i () > staff_size_i_ + 3 && dir_ == -1));
 183   if (on_ledger_line_b)
 184     {
 185       set_stemend (staff_size_i_ / 2 - 1);
 186     }
 187   else
 188     {
 189       Real dy = paper ()->interbeam_f ();
 190       Real len = STEMLEN;
 191       // ugh, should get nice *rule* for this
 192       if (abbrev_flag_i_ > 1)
 193         len += (abbrev_flag_i_ - 1)* dy / 2;
 194       set_stemend ((dir_ > 0) ? max_head_i () + len :
 195                    min_head_i () - len);
 196     }
 197 }
 198
 199 void
 200 Stem::set_default_extents ()
 201 {
 202   if (!stem_length_f ())
 203     set_default_stemlen ();
 204
 205   set_stemend ((dir_< 0) ?
 206                max_head_i ()-stem_length_f (): min_head_i () + stem_length_f ());
 207   // ugh, a whole ball is wider
 208   if (head_l_arr_[0]->balltype_i_ <= 0)
 209     stem_xoffset_f_ = paper ()->note_width () / 2;
 210   else if (dir_ > 0)
 211     stem_xoffset_f_ = paper ()->note_width () - paper ()->rule_thickness ();
 212   else
 213     stem_xoffset_f_ = 0;
 214 }
 215
 216 /*
 217   TODO
 218
 219   move into note_column.cc
 220
 221   */
 222 void
 223 Stem::set_noteheads ()
 224 {
 225   if (!head_l_arr_.size ())
 226     return;
 227   head_l_arr_.sort (Note_head::compare);
 228   if (dir_ < 0)
 229     head_l_arr_.reverse ();
 230
 231   head_l_arr_[0]->extremal_i_ = -1;
 232   head_l_arr_.top ()->extremal_i_ = 1;
 233   int parity=1;
 234   int lastpos = head_l_arr_[0]->position_i_;
 235   for (int i=1; i < head_l_arr_.size (); i ++)
 236     {
 237       int dy =abs (lastpos- head_l_arr_[i]->position_i_);
 238
 239       if (dy <= 1)
 240         {
 241           if (parity)
 242             head_l_arr_[i]->x_dir_ = (stem_xoffset_f_>0) ? UP:DOWN;
 243           parity = !parity;
 244         }
 245       else
 246         parity = 0;
 247       lastpos = head_l_arr_[i]->position_i_;
 248     }
 249 }
 250
 251 void
 252 Stem::do_pre_processing ()
 253 {
 254   if (stem_bottom_f_== stem_top_f_)
 255     set_default_extents ();
 256   set_noteheads ();
 257   flag_i_ = dir_ * abs (flag_i_);
 258   transparent_b_ = invisible_b ();
 259   empty_b_ = invisible_b ();
 260
 261 }
 262
 263
 264 Interval
 265 Stem::do_width () const
 266 {
 267   Interval r (0, 0);
 268   if (abbrev_flag_i_)
 269     {
 270       r = abbrev_mol ().extent ().x ();
 271     }
 272   else if (beam_l_ || abs (flag_i_) <= 4)
 273     ;   // TODO!
 274   else
 275     {
 276       Paper_def*p= paper ();
 277       r = p->lookup_l ()->flag (flag_i_).dim.x ();
 278       r+= stem_xoffset_f_;
 279     }
 280   return r;
 281 }
 282
 283
 284
 285 Molecule
 286 Stem::abbrev_mol () const
 287 {
 288   Real dy = paper ()->interbeam_f ();
 289   Real w = 1.5 * paper ()->lookup_l ()->ball (2).dim.x ().length ();
 290   Real beamdy = paper ()->interline_f () / 2;
 291
 292   int beams_i = 0;
 293   Real slope = paper ()->internote_f () / 4;
 294
 295   if (beam_l_) {
 296     // huh?
 297     slope = 2 * beam_l_->slope;
 298     // ugh, rather calc from Abbreviation_req
 299     beams_i = beams_right_i_ >? beams_left_i_;
 300   }
 301   paper ()->lookup_l ()->beam (slope, 20 PT);
 302
 303   Molecule beams;
 304   Atom a (paper ()->lookup_l ()->beam (slope, w));
 305   a.translate (Offset(- w / 2, stem_end_f () - (w / 2 * slope)));
 306   // ugh
 307   if (!beams_i)
 308     a.translate (dy + beamdy - dir_ * dy, Y_AXIS);
 309   else
 310     a.translate (2 * beamdy - dir_ * (beamdy - dy), Y_AXIS);
 311
 312   for (int i = 0; i < abbrev_flag_i_; i++)
 313     {
 314       Atom b (a);
 315       b.translate (-dir_ * dy * (beams_i + i), Y_AXIS);
 316       beams.add (b);
 317     }
 318
 319   return beams;
 320 }
 321
 322 Molecule*
 323 Stem::brew_molecule_p () const
 324 {
 325   Molecule *mol_p =new Molecule;
 326
 327   Real bot  = stem_bottom_f_;
 328   Real top = stem_top_f_;
 329
 330   assert (bot!=top);
 331
 332   Paper_def *p =paper ();
 333
 334   Real dy = p->internote_f ();
 335   if (!invisible_b ())
 336     {
 337       Symbol ss =p->lookup_l ()->stem (bot*dy,top*dy);
 338       mol_p->add (Atom (ss));
 339     }
 340
 341   if (!beam_l_ &&abs (flag_i_) > 4)
 342     {
 343       Symbol fl = p->lookup_l ()->flag (flag_i_);
 344       Molecule m (fl);
 345       if (flag_i_ < -4)
 346         {
 347           mol_p->add_at_edge (Y_AXIS, DOWN, m);
 348         }
 349       else if (flag_i_ > 4)
 350         {
 351           mol_p->add_at_edge (Y_AXIS, UP, m);
 352         }
 353       else
 354         assert (false);
 355          assert (!abbrev_flag_i_);
 356  }
 357
 358   if (abbrev_flag_i_)
 359     mol_p->add (abbrev_mol ());
 360
 361   mol_p->translate (stem_xoffset_f_, X_AXIS);
 362   return mol_p;
 363 }
 364
 365 Real
 366 Stem::hpos_f () const
 367 {
 368   return Item::hpos_f () + stem_xoffset_f_;
 369 }
 370
 371
 372 void
 373 Stem::do_substitute_dependency (Score_elem*o,Score_elem*n)
 374 {
 375   Item * o_l = o->item ();
 376   Item * n_l = n? n->item () : 0;
 377   head_l_arr_.substitute ((Note_head*)o_l, (Note_head*)n_l);
 378   rest_l_arr_.substitute ((Rest*)o_l, (Rest*)n_l);
 379 }