]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
release: 1.3.0
[lilypond.git] / lily / stem.cc
index d41d96f9c3c28c772c3687731cef4b2258033813..7c7797a385c9c43c4ec3256776b86fe1c9fc8309 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996,1997 Han-Wen Nienhuys <hanwen@stack.nl>
+  (c) 1996, 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+
+  TODO: This is way too hairy
 */
 
 #include "stem.hh"
-#include "dimen.hh" 
 #include "debug.hh"
 #include "paper-def.hh"
 #include "note-head.hh"
 #include "lookup.hh"
 #include "molecule.hh"
-#include "p-col.hh"
+#include "paper-column.hh"
 #include "misc.hh"
+#include "beam.hh"
+#include "rest.hh"
 
-const int STEMLEN=7;
-
-int
-Stem::min_head_i()const
+void
+Stem::set_direction (Direction d)
 {
-    int m = 1000;
-    for (int i =0; i < head_l_arr_.size(); i++)
-       m = m <? head_l_arr_[i]->position_i_;
-    return m;
+  if  (!dir_)
+    warning (_ ("stem direction set already!"));
+
+  dir_ = d;
+
+  /*
+    todo
+  */
 }
 
-int
-Stem::max_head_i() const
+Stem::Stem ()
 {
-    int m = -1000;
-    for (int i =0; i < head_l_arr_.size(); i++)
-       m = m >? head_l_arr_[i]->position_i_;
-    return m;
-    
+  beams_i_drul_[LEFT] = beams_i_drul_[RIGHT] = -1;
+  yextent_drul_[DOWN] = yextent_drul_[UP] = 0;
+  flag_i_ = 2;
+  dir_ = CENTER;
+  beam_l_ = 0;
 }
 
-Stem::Stem(int c) 
+Interval_t<int>
+Stem::head_positions () const
 {
-    beams_left_i_ = 0;
-    beams_right_i_ = 0;
-
-    stem_bottom_f_ = stem_top_f_ = 0;
-    flag_i_ = 4;
-    dir_i_ =0;
-    staff_size_i_ = c;
+  /* 
+    Mysterious FreeBSD fix by John Galbraith.  Somehow, the empty intervals 
+    trigger FP exceptions on FreeBSD.  Fix: do not return infinity 
+
+   */
+  if (!head_l_arr_.size ())
+    {
+      return Interval_t<int> (100,-100);       
+    }
 
-    print_flag_b_=true;
-    stem_xoffset_f_ =0;
+  Interval_t<int> r;
+  for (int i =0; i < head_l_arr_.size (); i++)
+    {
+      int p = (int)head_l_arr_[i]->position_f ();
+      r[BIGGER] = r[BIGGER] >? p;
+      r[SMALLER] = r[SMALLER] <? p;
+    }
+  return r;
 }
 
-IMPLEMENT_STATIC_NAME(Stem);
-IMPLEMENT_IS_TYPE_B1(Stem,Item);
-
 void
-Stem::do_print() const
+Stem::do_print () const
 {
 #ifndef NPRINT
-    mtor << "flag "<< flag_i_ << " print_flag_b_ " << print_flag_b_;
-
+  DEBUG_OUT << "flag "<< flag_i_;
+  if (beam_l_)
+    DEBUG_OUT << "beamed";
 #endif
 }
 
-Real 
-Stem::stem_length_f()const
+Real
+Stem::stem_length_f () const
 {
-    return stem_top_f_-stem_bottom_f_ ;
+  return yextent_drul_[UP]-yextent_drul_[DOWN] ;
 }
 
 Real
-Stem::stem_start_f()const
+Stem::stem_begin_f () const
 {
-    return (dir_i_ < 0)? stem_top_f_ : stem_bottom_f_;
+  return yextent_drul_[Direction(-dir_)];
 }
 
 Real
-Stem::stem_end_f() const
+Stem::chord_start_f () const
 {
-    return (dir_i_ < 0)? stem_bottom_f_ : stem_top_f_;
+  return head_positions()[dir_] * staff_line_leading_f ()/2.0;
 }
 
+Real
+Stem::stem_end_f () const
+{
+  return yextent_drul_[dir_];
+}
 
 void
-Stem::set_stemend(Real se)
+Stem::set_stemend (Real se)
 {
-    // todo: margins
-    if (!  ((dir_i_ > 0 && se >= max_head_i()) || 
-           (se <= min_head_i() && dir_i_ <0))  )       
-       warning("Weird stem size; check for narrow beams");
+  // todo: margins
+  if (dir_ && dir_ * head_positions()[dir_] >= se*dir_)
+    warning (_ ("Weird stem size; check for narrow beams"));
 
-    stem_top_f_  = (dir_i_ < 0) ? max_head_i()           : se;
-    stem_bottom_f_  = (dir_i_ < 0) ? se  : min_head_i();
+  
+  yextent_drul_[dir_]  =  se;
+  yextent_drul_[Direction(-dir_)] = head_positions()[-dir_];
+}
+
+int
+Stem::type_i () const
+{
+  return head_l_arr_[0]->balltype_i_;
 }
 
 void
-Stem::add(Note_head *n)
+Stem::add_head (Rhythmic_head *n)
 {
-    n->add_dependency(this);
-    if (n->rest_b_) {
-       rest_l_arr_.push(n);
-    } else if (n->balltype_i_ == 1) {
-       whole_l_arr_.push(n);
-       return;
-    } else{
-       head_l_arr_.push(n);
+  n->stem_l_ = this;
+  n->add_dependency (this);    // ?
+  if (Note_head *nh = dynamic_cast<Note_head *> (n))
+    {
+      head_l_arr_.push (nh);
+    }
+  else if (Rest *r = dynamic_cast<Rest *> (n))
+    {
+      rest_l_arr_.push (r);
     }
 }
 
 bool
-Stem::invisible_b()const
+Stem::invisible_b () const
 {
-    return !head_l_arr_.size();
+  return (!head_l_arr_.size () ||
+    head_l_arr_[0]->balltype_i_ <= 0);
 }
 
-// if dir_i_ is set we return fake values.
-
 int
-Stem::get_center_distance_from_top()
+Stem::get_center_distance (Direction d) const
 {
-    if (dir_i_)
-       return (dir_i_ > 0) ? 0 : 1;
-
-    int staff_center = staff_size_i_ / 2;
-    int max = max_head_i() - staff_center;
-    return max >? 0;
+  int staff_center = 0;
+  int distance = d*(head_positions()[d] - staff_center);
+  return distance >? 0;
 }
 
-// if dir_i_ is set we return fake values.
-int
-Stem::get_center_distance_from_bottom()
+Direction
+Stem::get_default_dir () const
 {
-    if (dir_i_)
-       return (dir_i_ > 0) ? 1 : 0;
+  int du = get_center_distance (UP);
+  int dd = get_center_distance (DOWN);
+
+  if (sign (dd - du))
+    return Direction (sign (dd -du));
 
-    int staff_center = staff_size_i_ / 2;
-    int min = staff_center - min_head_i();
-    return min >? 0;
+  return Direction (int(paper_l ()->get_var ("stem_default_neutral_direction")));
 }
 
-int
-Stem::get_default_dir()
+Direction
+Stem::get_dir () const
 {
-    if (dir_i_)
-       return dir_i_;
-    return (get_center_distance_from_top() >=
-       get_center_distance_from_bottom()) ? -1 : 1;
+  return dir_;
 }
 
 
 void
-Stem::set_default_dir()
+Stem::set_default_stemlen ()
 {
-    dir_i_ = get_default_dir();
+  Real length_f = 0.;
+  SCM scm_len = get_elt_property(length_scm_sym);
+  if (scm_len != SCM_BOOL_F)
+    {
+      length_f = gh_scm2double (SCM_CDR(scm_len));
+    }
+  else
+    length_f = paper_l ()->get_var ("stem_length0");
+
+  bool grace_b = get_elt_property (grace_scm_sym) != SCM_BOOL_F;
+  String type_str = grace_b ? "grace_" : "";
+
+  Real shorten_f = paper_l ()->get_var (type_str + "forced_stem_shorten0");
+
+  if (!dir_)
+    dir_ = get_default_dir ();
+
+  /* 
+    stems in unnatural (forced) direction should be shortened, 
+    according to [Roush & Gourlay]
+   */
+  if (((int)chord_start_f ())
+      && (dir_ != get_default_dir ()))
+    length_f -= shorten_f;
+
+  if (flag_i_ >= 5)
+    length_f += 2.0;
+  if (flag_i_ >= 6)
+    length_f += 1.0;
+  
+  set_stemend ((dir_ > 0) ? head_positions()[BIGGER] + length_f:
+              head_positions()[SMALLER] - length_f);
+
+  bool no_extend_b = get_elt_property (no_stem_extend_scm_sym) != SCM_BOOL_F;
+  if (!grace_b && !no_extend_b && (dir_ * stem_end_f () < 0))
+    set_stemend (0);
 }
 
+//xxx
 void
-Stem::set_default_stemlen()
+Stem::set_default_extents ()
 {
-    if (!dir_i_)
-       set_default_dir();
-
-    
-    // ugh... how about non 5-line staffs?
-    if ((max_head_i() < -2 && dir_i_ == 1 )
-       ||(min_head_i() > staff_size_i_ && dir_i_ == -1) ){
-       set_stemend(    staff_size_i_ /2 -1 );
-    } else {
-       set_stemend( (dir_i_ > 0) ? max_head_i() + STEMLEN : 
-                                    min_head_i() - STEMLEN);
+  if (!stem_length_f ())
+    set_default_stemlen ();
 
-    }
 }
 
-
 void
-Stem::set_default_extents()
+Stem::set_noteheads ()
 {
-    if (!stem_length_f())
-       set_default_stemlen();
-
-    set_stemend((dir_i_< 0) ? 
-               max_head_i()-stem_length_f(): min_head_i() +stem_length_f());
-    if (dir_i_ > 0){   
-       stem_xoffset_f_ = paper()->note_width()-paper()->rule_thickness();
-    } else
-       stem_xoffset_f_ = 0;
-}
-
-/*
-  TODO
+  if (!head_l_arr_.size ())
+    return;
+  head_l_arr_.sort (Note_head::compare);
+  if (dir_ < 0)
+    head_l_arr_.reverse ();
+
+  Note_head * beginhead =   head_l_arr_[0];
+  beginhead->set_elt_property (extremal_scm_sym, SCM_BOOL_T);
+  if  (beginhead !=   head_l_arr_.top ())
+    head_l_arr_.top ()->set_elt_property (extremal_scm_sym, SCM_BOOL_T);
   
-  move into note_column.cc
+  int parity=1;
+  int lastpos = int (beginhead->position_f ());
+  for (int i=1; i < head_l_arr_.size (); i ++)
+    {
+      int dy =abs (lastpos- (int)head_l_arr_[i]->position_f ());
+
+      if (dy <= 1)
+       {
+         if (parity)
+           head_l_arr_[i]->flip_around_stem (dir_);
+         parity = !parity;
+       }
+      else
+       parity = 1;
+      lastpos = int (head_l_arr_[i]->position_f ());
+    }
+}
 
-  */
 void
-Stem::set_noteheads()
+Stem::do_pre_processing ()
 {
-    if(!head_l_arr_.size())
-       return;
-    head_l_arr_.sort(Note_head::compare);
-    if (dir_i_ < 0) 
-       head_l_arr_.reverse();
-    
-    head_l_arr_[0]->extremal_i_ = -1;
-    head_l_arr_.top()->extremal_i_ = 1;
-    int parity=1;
-    int lastpos = head_l_arr_[0]->position_i_;
-    for (int i=1; i < head_l_arr_.size(); i ++) {
-       int dy =abs(lastpos- head_l_arr_[i]->position_i_);
-       
-       if (dy <= 1) {
-           if (parity)
-               head_l_arr_[i]->x_dir_i_ = (stem_xoffset_f_>0) ? 1:-1;
-           parity = !parity;
-       } else
-           parity = 0;
-       lastpos = head_l_arr_[i]->position_i_;
+  if (yextent_drul_[DOWN]== yextent_drul_[UP])
+    set_default_extents ();
+  set_noteheads ();
+
+  if (invisible_b ())
+    {
+      set_elt_property (transparent_scm_sym, SCM_BOOL_T);
     }
+  set_empty (invisible_b (), X_AXIS, Y_AXIS);
+  set_spacing_hints ();
 }
 
+
+
+/**
+   set stem directions for hinting the optical spacing correction.
+
+   Modifies DIR_LIST property of the Stem's Score_column
+
+   TODO: more advanced: supply height of noteheads as well, for more advanced spacing possibilities
+ */
+
 void
-Stem::do_pre_processing()
+Stem::set_spacing_hints () 
 {
-    if (stem_bottom_f_== stem_top_f_)
-       set_default_extents();
-    set_noteheads();
-    flag_i_ = dir_i_*abs(flag_i_);
-    transparent_b_ = invisible_b();
-    empty_b_ = invisible_b();
+  if (!invisible_b ())
+    {
+      SCM scmdir  = gh_int2scm (dir_);
+      SCM dirlist = column_l ()->get_elt_property (dir_list_scm_sym);
+      if (dirlist == SCM_BOOL_F)
+       dirlist = SCM_EOL;
+      else
+       dirlist = SCM_CDR (dirlist);
+
+      if (scm_sloppy_memq (scmdir, dirlist) == SCM_EOL)
+       {
+         dirlist = gh_cons (scmdir, dirlist);
+         column_l ()->set_elt_property (dir_list_scm_sym, dirlist);
+       }
+    }
 }
 
+Molecule
+Stem::flag () const
+{
+  String style;
+  SCM st = get_elt_property (style_scm_sym);
+  if ( st != SCM_BOOL_F)
+    {
+      st = SCM_CDR(st);
+      style = ly_scm2string (st);
+    }
+
+  char c = (dir_ == UP) ? 'u' : 'd';
+  Molecule m = lookup_l ()->afm_find (String ("flags-") + to_str (c) + 
+                                     to_str (flag_i_));
+  if (!style.empty_b ())
+    m.add_molecule(lookup_l ()->afm_find (String ("flags-") + to_str (c) + style));
+  return m;
+}
 
 Interval
-Stem::do_width()const
+Stem::do_width () const
 {
-    if (!print_flag_b_ || abs(flag_i_) <= 4)
-       return Interval(0,0);   // TODO!
-    Paper_def*p= paper();
-    Interval r(p->lookup_l()->flag(flag_i_).dim.x);
-    r+= stem_xoffset_f_;
-    return r;
+  Interval r (0, 0);
+  if (beam_l_ || abs (flag_i_) <= 2)
+    ;  // TODO!
+  else
+    {
+      r = flag ().dim_.x ();
+      r += note_delta_f ();
+    }
+  return r;
 }
 
+
+
+
+const Real ANGLE = 20* (2.0*M_PI/360.0); // ugh!
+
 Molecule*
-Stem::brew_molecule_p()const 
+Stem::do_brew_molecule_p () const
 {
-    Molecule *out =0;
-        
-    Real bot  = stem_bottom_f_;
-    Real top = stem_top_f_;
-    
-    assert(bot!=top);
-    Paper_def *p =paper();
-
-    Real dy = p->internote_f();
-    Symbol ss =p->lookup_l()->stem(bot*dy,top*dy);
-
-    out = new Molecule(Atom(ss));
-
-    if (print_flag_b_&&abs(flag_i_) > 4){
-       Symbol fl = p->lookup_l()->flag(flag_i_);
-       Molecule m(fl);
-       if (flag_i_ < -4){              
-           out->add_bottom(m);
-       } else if (flag_i_ > 4) {
-           out->add_top(m);
-       } else
-           assert(false); 
+  Molecule *mol_p =new Molecule;
+  Drul_array<Real> stem_y = yextent_drul_;
+  Real dy = staff_line_leading_f ()/2.0;
+
+  Real head_wid = 0;
+  if (head_l_arr_.size ())
+    head_wid = head_l_arr_[0]->extent (X_AXIS).length ();
+  stem_y[Direction(-dir_)] += dir_ * head_wid * tan(ANGLE)/(2*dy);
+  
+  if (!invisible_b ())
+    {
+      Real stem_width = paper_l ()->get_var ("stemthickness");
+      Molecule ss =lookup_l ()->filledbox (Box (Interval (-stem_width/2, stem_width/2),
+                                                Interval (stem_y[DOWN]*dy, stem_y[UP]*dy)));
+      mol_p->add_molecule (ss);
     }
 
-    out->translate_x(stem_xoffset_f_);
-    return out;
+  if (!beam_l_ && abs (flag_i_) > 2)
+    {
+      Molecule fl = flag ();
+      fl.translate_axis(stem_y[dir_]*dy, Y_AXIS);
+      mol_p->add_molecule (fl);
+    }
+
+  if (head_l_arr_.size())
+    {
+      mol_p->translate_axis (note_delta_f (), X_AXIS);
+    }
+  return mol_p;
 }
 
 Real
-Stem::hpos_f()const
+Stem::note_delta_f () const
 {
-    return Item::hpos_f() + stem_xoffset_f_;
+  Real r=0;
+  if (head_l_arr_.size())
+    {
+      Interval head_wid(0,  head_l_arr_[0]->extent (X_AXIS).length ());
+         Real rule_thick = paper_l ()->get_var ("stemthickness");
+
+      Interval stem_wid(-rule_thick/2, rule_thick/2);
+      if (dir_ == CENTER)
+       r = head_wid.center ();
+      else
+       r = head_wid[dir_] - stem_wid[dir_];
+    }
+  return r;
 }
 
+Real
+Stem::hpos_f () const
+{
+  return note_delta_f () + Item::hpos_f ();
+}
 
 void
-Stem::do_substitute_dependency(Score_elem*o,Score_elem*n)
+Stem::do_substitute_element_pointer (Score_element*o,Score_element*n)
 {
-    Item * o_l = o->item();
-    Item * n_l = n? n->item():0;
-    whole_l_arr_.substitute((Note_head*)o_l, (Note_head*)n_l);
-    head_l_arr_.substitute((Note_head*)o_l, (Note_head*)n_l);
-    rest_l_arr_.substitute((Note_head*)o_l, (Note_head*)n_l);
+  if (Note_head*h=dynamic_cast<Note_head*> (o))
+    head_l_arr_.substitute (h, dynamic_cast<Note_head*>(n));
+  if (Rest *r=dynamic_cast<Rest*> (o))
+    rest_l_arr_.substitute (r, dynamic_cast<Rest*>(n));
+  if (Beam* b = dynamic_cast<Beam*> (o))
+    {
+      if (b == beam_l_) 
+       beam_l_ = dynamic_cast<Beam*> (n);
+    }
+  Staff_symbol_referencer::do_substitute_element_pointer (o,n);
 }