]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
release: 1.5.25
[lilypond.git] / lily / stem.cc
index f144ba137e4d47fc2522cfba3511afe8136361dc..8502c7581c558ccf8c1ffa2e97900cacb980135c 100644 (file)
@@ -8,6 +8,7 @@
 
   TODO: This is way too hairy
 */
+
 #include <math.h>              // m_pi
 
 #include "lookup.hh"
 #include "group-interface.hh"
 #include "staff-symbol-referencer.hh"
 #include "spanner.hh"
-
+#include "side-position-interface.hh"
 
 void
-Stem::set_beaming (Grob*me ,int i,  Direction d )
+Stem::set_beaming (Grob*me ,int i,  Direction d)
 {
   SCM pair = me->get_grob_property ("beaming");
   
@@ -63,14 +64,14 @@ Stem::head_positions (Grob*me)
   Drul_array<Grob*> e (extremal_heads (me));
 
   return Interval (Staff_symbol_referencer::position_f (e[DOWN]),
-                  Staff_symbol_referencer::position_f ( e[UP]));
+                  Staff_symbol_referencer::position_f (e[UP]));
 }
 
 
 Real
 Stem::chord_start_f (Grob*me) 
 {
-  return head_positions(me)[get_direction (me)]
+  return head_positions (me)[get_direction (me)]
     * Staff_symbol_referencer::staff_space (me)/2.0;
 }
 
@@ -112,7 +113,7 @@ Stem::set_stemend (Grob*me, Real se)
   // todo: margins
   Direction d= get_direction (me);
   
-  if (d && d * head_positions(me)[get_direction (me)] >= se*d)
+  if (d && d * head_positions (me)[get_direction (me)] >= se*d)
     warning (_ ("Weird stem size; check for narrow beams"));
 
   me->set_grob_property ("stem-end-position", gh_double2scm (se));
@@ -140,7 +141,7 @@ Stem::support_head (Grob*me)
        UGH.
        */
       
-      return unsmob_grob (gh_car (me->get_grob_property ("heads")));
+      return unsmob_grob (ly_car (me->get_grob_property ("heads")));
     }
   else
     return first_head (me);
@@ -176,12 +177,12 @@ Stem::extremal_heads (Grob*me)
   Drul_array<Grob *> exthead;
   exthead[LEFT] = exthead[RIGHT] =0;
   
-  for (SCM s = me->get_grob_property ("heads"); gh_pair_p (s); s = gh_cdr (s))
+  for (SCM s = me->get_grob_property ("heads"); gh_pair_p (s); s = ly_cdr (s))
     {
-      Grob * n = unsmob_grob (gh_car (s));
+      Grob * n = unsmob_grob (ly_car (s));
 
       
-      int p = int(Staff_symbol_referencer::position_f (n));
+      int p = int (Staff_symbol_referencer::position_f (n));
 
       Direction d = LEFT;
       do {
@@ -196,6 +197,29 @@ Stem::extremal_heads (Grob*me)
   return exthead;
 }
 
+static int
+icmp (int const &a, int const &b)
+{
+  return a-b;
+}
+
+Array<int>
+Stem::note_head_positions (Grob *me)
+{
+  Array<int> ps ;
+  for (SCM s = me->get_grob_property ("heads"); gh_pair_p (s); s = ly_cdr (s))
+    {
+      Grob * n = unsmob_grob (ly_car (s));
+      int p = int (Staff_symbol_referencer::position_f (n));
+
+      ps.push (p);
+    }
+
+  ps.sort (icmp);
+  return ps; 
+}
+
+
 void
 Stem::add_head (Grob*me, Grob *n)
 {
@@ -204,7 +228,7 @@ Stem::add_head (Grob*me, Grob *n)
 
   if (Note_head::has_interface (n))
     {
-      Pointer_group_interface::add_element (me, "heads",n);
+      Pointer_group_interface::add_element (me, ly_symbol2scm ("heads"), n);
     }
   else
     {
@@ -215,14 +239,14 @@ Stem::add_head (Grob*me, Grob *n)
 bool
 Stem::invisible_b (Grob*me)
 {
-  return !(heads_i (me) && Rhythmic_head::balltype_i (support_head (me)) >= 1);
+  return ! (heads_i (me) && Rhythmic_head::balltype_i (support_head (me)) >= 1);
 }
 
 int
 Stem::get_center_distance (Grob*me, Direction d)
 {
   int staff_center = 0;
-  int distance = (int) (d*(head_positions(me)[d] - staff_center));
+  int distance = (int) (d* (head_positions (me)[d] - staff_center));
   return distance >? 0;
 }
 
@@ -235,7 +259,7 @@ Stem::get_default_dir (Grob*me)
   if (sign (dd - du))
     return Direction (sign (dd -du));
 
-  return to_dir (me->get_grob_property ("default-neutral-direction"));
+  return to_dir (me->get_grob_property ("neutral-direction"));
 }
 
 Real
@@ -246,32 +270,32 @@ Stem::get_default_stem_end_position (Grob*me)
   Array<Real> a;
 
   Real length_f = 0.;
-  SCM scm_len = me->get_grob_property("length");
+  SCM scm_len = me->get_grob_property ("length");
   if (gh_number_p (scm_len))
     {
       length_f = gh_scm2double (scm_len);
     }
   else
     {
-      s = me->get_grob_property("lengths");
-      for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
-       a.push (gh_scm2double (gh_car (q)));
+      s = me->get_grob_property ("lengths");
+      for (SCM q = s; q != SCM_EOL; q = ly_cdr (q))
+       a.push (gh_scm2double (ly_car (q)));
                
       // stem uses half-spaces
-      length_f = a[((flag_i (me) - 2) >? 0) <? (a.size () - 1)] * 2;
+      length_f = a[ ((flag_i (me) - 2) >? 0) <? (a.size () - 1)] * 2;
     }
 
 
   a.clear ();
   s = me->get_grob_property ("stem-shorten");
-  for (SCM q = s; gh_pair_p (q); q = gh_cdr (q))
-    a.push (gh_scm2double (gh_car (q)));
+  for (SCM q = s; gh_pair_p (q); q = ly_cdr (q))
+    a.push (gh_scm2double (ly_car (q)));
 
 
   // stem uses half-spaces
 
-  // fixme: use gh_list_ref () iso. array[]
-  Real shorten_f = a[((flag_i (me) - 2) >? 0) <? (a.size () - 1)] * 2;
+  // fixme: use scm_list_n_ref () iso. array[]
+  Real shorten_f = a[ ((flag_i (me) - 2) >? 0) <? (a.size () - 1)] * 2;
 
   /* URGURGURG
      'set-default-stemlen' sets direction too
@@ -287,20 +311,58 @@ Stem::get_default_stem_end_position (Grob*me)
     stems in unnatural (forced) direction should be shortened, 
     according to [Roush & Gourlay]
    */
-  if (((int)chord_start_f (me))
+  if (( (int)chord_start_f (me))
       && (get_direction (me) != get_default_dir (me)))
     length_f -= shorten_f;
 
+  Interval hp = head_positions (me);  
+  Real st = hp[dir] + dir * length_f;
+
 
-   Real st = head_positions(me)[dir] + dir * length_f;
   
-   bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend"));
+
+  /*
+    Make a little room if we have a flag and there is a dot.
+
+    TODO:
+
+    maybe  we should consider moving the dot to the right?
+  */
+  if (!beam_l (me)
+      && flag_i (me))
+    {
+      Grob * closest_to_flag = extremal_heads (me)[dir];
+      Grob * dots = closest_to_flag
+       ? Rhythmic_head::dots_l (closest_to_flag ) : 0;
+
+      if (dots)
+       {
+         Real dp = Staff_symbol_referencer::position_f  (dots);
+         Real flagy =  flag (me).extent (Y_AXIS)[-dir] * 2; // should divide by staffspace
+
+         /*
+           Very gory: add myself to the X-support of the parent,
+           which should be a dot-column.
+          */
+         if (dir * (st + flagy -  dp) < 0.5)
+           Side_position_interface::add_support (dots->get_parent (X_AXIS), me);
+
+         /*
+           previous approach was to lengthen the stem. This is not
+           good typesetting practice.  */
+       }
+    }
+
+
+  bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend"));
    if (!grace_b && !no_extend_b && dir * st < 0) // junkme?
       st = 0.0;
 
   return st;
 }
 
+
+
 /*
   Number of hooks on the flag, ie. the log of the duration.
  */
@@ -308,7 +370,7 @@ int
 Stem::flag_i (Grob*me) 
 {
   SCM s = me->get_grob_property ("duration-log");
-  return  (gh_number_p (s)) ? gh_scm2int (s) : 2;
+  return (gh_number_p (s)) ? gh_scm2int (s) : 2;
 }
 
 void
@@ -328,10 +390,11 @@ Stem::position_noteheads (Grob*me)
 
 
   Grob *hed = support_head (me);
-  Real w = hed->extent (hed, X_AXIS)[dir];
+  Real w = Note_head::head_extent (hed,X_AXIS)[dir];
   for (int i=0; i < heads.size (); i++)
     {
-      heads[i]->translate_axis (w - heads[i]->extent (heads[i], X_AXIS)[dir], X_AXIS);
+      heads[i]->translate_axis (w - Note_head::head_extent (heads[i],X_AXIS)[dir],
+                               X_AXIS);
     }
   
   bool parity= true;           // todo: make me settable.
@@ -357,7 +420,7 @@ Stem::position_noteheads (Grob*me)
     }
 }
 
-MAKE_SCHEME_CALLBACK(Stem,before_line_breaking,1);
+MAKE_SCHEME_CALLBACK (Stem,before_line_breaking,1);
 SCM
 Stem::before_line_breaking (SCM smob)
 {
@@ -368,7 +431,7 @@ Stem::before_line_breaking (SCM smob)
   if (invisible_b (me))
     {
       me->remove_grob_property ("molecule-callback");
-      // suicide();
+      // suicide ();
     }
   
   set_spacing_hints (me);
@@ -387,7 +450,7 @@ Stem::height (SCM smob, SCM ax)
 {
   Axis a = (Axis)gh_scm2int (ax);
   Grob * me = unsmob_grob (smob);
-  assert ( a == Y_AXIS);
+  assert (a == Y_AXIS);
 
   SCM mol = me->get_uncached_molecule ();
   Interval iv;
@@ -414,7 +477,7 @@ Stem::set_spacing_hints (Grob*me)
       Item* item = dynamic_cast<Item*> (me);
       Item * col =  item->column_l ();
       SCM dirlist =col->get_grob_property ("dir-list");
-      if (scm_sloppy_memq (scmdir, dirlist) == SCM_BOOL_F)
+      if (scm_c_memq (scmdir, dirlist) == SCM_BOOL_F)
        {
          dirlist = gh_cons (scmdir, dirlist);
          col->set_grob_property ("dir-list", dirlist);
@@ -425,22 +488,73 @@ Stem::set_spacing_hints (Grob*me)
 Molecule
 Stem::flag (Grob*me)
 {
-  String style;
-  SCM st = me->get_grob_property ("flag-style");
-  if ( gh_string_p (st))
+  /* TODO: rename flag-style into something more appropriate,
+   e.g. "stroke-style", maybe with values "" (i.e. no stroke),
+   "single" and "double".  Needs more discussion.
+  */
+  String style, fstyle, staffline_offs;
+  SCM fst = me->get_grob_property ("flag-style");
+  if (gh_string_p (fst))
     {
-      style = ly_scm2string (st);
+      fstyle = ly_scm2string (fst);
     }
 
+  SCM st = me->get_grob_property ("style");
+  if (gh_symbol_p (st))
+    {
+      style = (ly_scm2string (scm_symbol_to_string (st)));
+    }
+  else
+    {
+      style = "";
+    }
+  if (String::compare_i (style, "mensural") == 0)
+    /* Mensural notation: For notes on staff lines, use different
+       flags than for notes between staff lines.  The idea is that
+       flags are always vertically aligned with the staff lines,
+       regardless if the note head is on a staff line or between two
+       staff lines.  In other words, the inner end of a flag always
+       touches a staff line.
+    */
+    {
+      /* Urrgh!  We have to detect wether this stem ends on a staff
+        line or between two staff lines.  But we can not call
+        stem_end_position(me) or get_default_stem_end_position(me),
+        since this encounters the flag and hence results in an
+        infinite recursion.  However, in pure mensural notation,
+        there are no multiple note heads attached to a single stem,
+        neither is there usually need for using the stem_shorten
+        property (except for 32th and 64th notes, but that is not a
+        problem since the stem length in this case is augmented by
+        an integral multiple of staff_space).  Hence, it should be
+        sufficient to just take the first note head, assume it's
+        the only one, look if it's on a staff line, and select the
+        flag's shape accordingly.  In the worst case, the shape
+        looks slightly misplaced, but that will usually be the
+        programmer's fault (e.g. when trying to attach multiple
+        note heads to a single stem in mensural notation).
+
+      */
+       Grob *first = first_head(me);
+       int sz = Staff_symbol_referencer::line_count (me)-1;
+       int p = (int)rint (Staff_symbol_referencer::position_f (first));
+       staffline_offs = (((p ^ sz) & 0x1) == 0) ? "1" : "0";
+    }
+  else
+    {
+       staffline_offs = "";
+    }
   char c = (get_direction (me) == UP) ? 'u' : 'd';
-  Molecule m = Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + 
-                                     to_str (flag_i (me)));
-  if (!style.empty_b ())
-    m.add_molecule(Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + style));
+  String index_str
+    = String ("flags-") + style + to_str (c) + staffline_offs + to_str (flag_i (me));
+  Molecule m
+    = Font_interface::get_default_font (me)->find_by_name (index_str);
+  if (!fstyle.empty_b ())
+    m.add_molecule (Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + fstyle));
   return m;
 }
 
-MAKE_SCHEME_CALLBACK(Stem,dim_callback,2);
+MAKE_SCHEME_CALLBACK (Stem,dim_callback,2);
 SCM
 Stem::dim_callback (SCM e, SCM ax)
 {
@@ -454,12 +568,12 @@ Stem::dim_callback (SCM e, SCM ax)
     {
       r = flag (se).extent (X_AXIS);
     }
-  return ly_interval2scm ( r);
+  return ly_interval2scm (r);
 }
 
 
-
-MAKE_SCHEME_CALLBACK(Stem,brew_molecule,1);
+MAKE_SCHEME_CALLBACK (Stem,brew_molecule,1);
 
 SCM
 Stem::brew_molecule (SCM smob) 
@@ -472,24 +586,30 @@ Stem::brew_molecule (SCM smob)
   Real y1 = Staff_symbol_referencer::position_f (first_head (me));
   Real y2 = stem_end_position (me);
   
-  Interval stem_y(y1,y2);
-  stem_y.unite (Interval (y2,y1));
+  Interval stem_y (y1 <? y2,y2 >? y1);
 
-  Real dy = Staff_symbol_referencer::staff_space (me)/2.0;
-  Real head_wid = 0;
 
-  Real angle =0.0;
+  // dy?
+  Real dy = Staff_symbol_referencer::staff_space (me) * 0.5;
+    
   if (Grob *hed = support_head (me))
     {
-      head_wid = hed->extent (hed,X_AXIS).length ();
+      /*
+       must not take ledgers into account.
+       */
+      Interval head_height = Note_head::head_extent (hed,Y_AXIS);
+      Real y_attach = Note_head::stem_attachment_coordinate ( hed, Y_AXIS);
 
-      angle = gh_scm2double (hed->get_grob_property ("attachment-angle"));
+      y_attach = head_height.linear_combination (y_attach);
+      stem_y[Direction (-d)] += d * 2*y_attach;
     }
-  stem_y[Direction(-d)] += d * head_wid * tan(angle)/(2*dy);
   
   if (!invisible_b (me))
     {
-      Real stem_width = gh_scm2double (me->get_grob_property ("thickness")) * me->paper_l ()->get_var ("stafflinethickness");
+      Real stem_width = gh_scm2double (me->get_grob_property ("thickness"))
+       // URG
+       * me->paper_l ()->get_var ("stafflinethickness");
+      
       Molecule ss =Lookup::filledbox (Box (Interval (-stem_width/2, stem_width/2),
                                           Interval (stem_y[DOWN]*dy, stem_y[UP]*dy)));
       mol.add_molecule (ss);
@@ -498,7 +618,7 @@ Stem::brew_molecule (SCM smob)
   if (!beam_l (me) && abs (flag_i (me)) > 2)
     {
       Molecule fl = flag (me);
-      fl.translate_axis(stem_y[d]*dy, Y_AXIS);
+      fl.translate_axis (stem_y[d]*dy, Y_AXIS);
       mol.add_molecule (fl);
     }
 
@@ -508,23 +628,38 @@ Stem::brew_molecule (SCM smob)
 /*
   move the stem to right of the notehead if it is up.
  */
-MAKE_SCHEME_CALLBACK(Stem,off_callback,2);
+MAKE_SCHEME_CALLBACK (Stem,off_callback,2);
 SCM
-Stem::off_callback (SCM element_smob, SCM )
+Stem::off_callback (SCM element_smob, SCM)
 {
   Grob *me = unsmob_grob (element_smob);
   
   Real r=0;
   if (Grob * f = first_head (me))
     {
-      Interval head_wid(0, f->extent (f,X_AXIS).length ());
+      Interval head_wid = Note_head::head_extent(f, X_AXIS);
+
+      Real attach =
+       Note_head::stem_attachment_coordinate(f, X_AXIS);
 
-      if (to_boolean (me->get_grob_property ("stem-centered")))
-       return gh_double2scm ( head_wid.center ());
-      
-      Real rule_thick = gh_scm2double (me->get_grob_property ("thickness")) * me->paper_l ()->get_var ("stafflinethickness");
       Direction d = get_direction (me);
-      r = head_wid[d] - d * rule_thick * 0.5;
+
+      Real real_attach = head_wid.linear_combination (d * attach);
+
+      r = real_attach;
+
+      /*
+       If not centered: correct for stem thickness.
+       */
+      if (attach)
+       {
+         Real rule_thick
+           = gh_scm2double (me->get_grob_property ("thickness"))
+           * me->paper_l ()->get_var ("stafflinethickness");
+
+         
+         r += - d * rule_thick * 0.5;
+       }
     }
   return gh_double2scm (r);
 }
@@ -575,18 +710,18 @@ Stem::calc_stem_info (Grob*me)
   Array<Real> a;
   SCM s;
   
-  s = me->get_grob_property("beamed-minimum-lengths");
+  s = me->get_grob_property ("beamed-minimum-lengths");
   a.clear ();
-  for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
-    a.push (gh_scm2double (gh_car (q)));
+  for (SCM q = s; q != SCM_EOL; q = ly_cdr (q))
+    a.push (gh_scm2double (ly_car (q)));
 
 
   Real minimum_length = a[multiplicity <? (a.size () - 1)] * staff_space;
   s = me->get_grob_property ("beamed-lengths");
 
-  a.clear();
-  for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
-    a.push (gh_scm2double (gh_car (q)));
+  a.clear ();
+  for (SCM q = s; q != SCM_EOL; q = ly_cdr (q))
+    a.push (gh_scm2double (ly_car (q)));
 
   Real stem_length =  a[multiplicity <? (a.size () - 1)] * staff_space;
 
@@ -646,7 +781,7 @@ Stem::calc_stem_info (Grob*me)
 
  Grob *common = me->common_refpoint (beam, Y_AXIS);
   Real interstaff_f = beam_dir *
   (me->relative_coordinate (common, Y_AXIS)
+ (me->relative_coordinate (common, Y_AXIS)
      - beam->relative_coordinate (common, Y_AXIS));
 
   info.idealy_f_ += interstaff_f;