]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
* VERSION: 1.5.72 released
[lilypond.git] / lily / stem.cc
index d0efe954f8e1f8e399c286efe95444048384eef3..b17f0a383afaec3ec435f8ef552fdcec6193c774 100644 (file)
@@ -19,7 +19,7 @@
 #include "directional-element-interface.hh"
 #include "note-head.hh"
 #include "stem.hh"
-#include "debug.hh"
+#include "warn.hh"
 #include "paper-def.hh"
 #include "rhythmic-head.hh"
 #include "font-interface.hh"
 #include "dot-column.hh"
 
 void
-Stem::set_beaming (Grob*me ,int i,  Direction d)
+Stem::set_beaming (Grob*me, int beam_count,  Direction d)
 {
   SCM pair = me->get_grob_property ("beaming");
   
   if (!gh_pair_p (pair))
     {
-      pair = gh_cons (gh_int2scm (-1),gh_int2scm (-1));
-      me->      set_grob_property ("beaming", pair);
+      pair = gh_cons (SCM_EOL, SCM_EOL);
+      me->set_grob_property ("beaming", pair);
     }
-  index_set_cell (pair, d, gh_int2scm (i));
-}
 
-int
-Stem::beam_count (Grob*me,Direction d)
-{
-  SCM p=me->get_grob_property ("beaming");
-  if (gh_pair_p (p))
-    return gh_scm2int (index_cell (p,d));
-  else
-    return -1;
+  SCM l = index_get_cell (pair, d);
+  for( int i = 0; i<  beam_count; i++)
+    {
+      l = gh_cons (gh_int2scm (i), l);
+    }
+  index_set_cell (pair, d, l);         
 }
 
+
 Interval
 Stem::head_positions (Grob*me) 
 {
@@ -68,8 +65,8 @@ 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]));
+  return Interval (Staff_symbol_referencer::get_position (e[DOWN]),
+                  Staff_symbol_referencer::get_position (e[UP]));
 }
 
 
@@ -126,7 +123,9 @@ Stem::set_stemend (Grob*me, Real se)
 
 /*
   Note head that determines hshift for upstems
- */ 
+
+  WARNING: triggers direction
+*/ 
 Grob*
 Stem::support_head (Grob*me)
 {
@@ -155,7 +154,9 @@ Stem::head_count (Grob*me)
 
 /*
   The note head which forms one end of the stem.  
- */
+
+  WARNING: triggers direction
+*/
 Grob*
 Stem::first_head (Grob*me)
 {
@@ -165,6 +166,18 @@ Stem::first_head (Grob*me)
   return extremal_heads (me)[-d];
 }
 
+/*
+  The note head opposite to the first head.
+ */
+Grob*
+Stem::last_head (Grob*me)
+{
+  Direction d = get_direction (me);
+  if (!d)
+    return 0;
+  return extremal_heads (me)[d];
+}
+
 /*
   START is part where stem reaches `last' head. 
  */
@@ -184,7 +197,7 @@ Stem::extremal_heads (Grob*me)
       Grob * n = unsmob_grob (ly_car (s));
 
       
-      int p = int (Staff_symbol_referencer::position_f (n));
+      int p = int (Staff_symbol_referencer::get_position (n));
 
       Direction d = LEFT;
       do {
@@ -212,7 +225,7 @@ Stem::note_head_positions (Grob *me)
   for (SCM s = me->get_grob_property ("note-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));
+      int p = int (Staff_symbol_referencer::get_position (n));
 
       ps.push (p);
     }
@@ -237,7 +250,8 @@ Stem::add_head (Grob*me, Grob *n)
 bool
 Stem::invisible_b (Grob*me)
 {
-  return ! (head_count (me) && Note_head::balltype_i (support_head (me)) >= 1);
+  return ! (head_count (me)
+           && gh_scm2int (me->get_grob_property ("duration-log")) >= 1);
 }
 
 Direction
@@ -262,11 +276,21 @@ Stem::get_default_dir (Grob*me)
 Real
 Stem::get_default_stem_end_position (Grob*me) 
 {
+  SCM up_to_staff = me->get_grob_property ("up-to-staff");
+  if (to_boolean(up_to_staff))
+    {
+      int line_count = Staff_symbol_referencer::line_count (me);
+    
+      Direction dir = get_direction (me);
+    
+      return dir*  (line_count + 3.5);
+    }
+  
   bool grace_b = to_boolean (me->get_grob_property ("grace"));
   SCM s;
   Array<Real> a;
 
-  Real length_f = 0.;
+  Real length_f = 3.5;
   SCM scm_len = me->get_grob_property ("length");
   if (gh_number_p (scm_len))
     {
@@ -275,24 +299,20 @@ Stem::get_default_stem_end_position (Grob*me)
   else
     {
       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[ ((duration_log (me) - 2) >? 0) <? (a.size () - 1)] * 2;
+      if (gh_pair_p (s))
+       {
+         length_f = 2* gh_scm2double (robust_list_ref (duration_log(me) -2, s));
+       }
     }
 
 
-  a.clear ();
-  s = me->get_grob_property ("stem-shorten");
-  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 scm_list_n_ref () iso. array[]
-  Real shorten_f = a[ ((duration_log (me) - 2) >? 0) <? (a.size () - 1)] * 2;
+  Real shorten_f = 0.0;
+  
+  SCM sshorten = me->get_grob_property ("stem-shorten");
+  if (gh_pair_p (sshorten))
+    {
+      shorten_f = 2* gh_scm2double (robust_list_ref ((duration_log (me) - 2) >? 0, sshorten));
+    }
 
   /* On boundary: shorten only half */
   if (abs (chord_start_y (me)) == 0.5)
@@ -327,16 +347,16 @@ Stem::get_default_stem_end_position (Grob*me)
     good typesetting practice. 
     
   */
-  if (!beam_l (me) && dir == UP
+  if (!get_beam (me) && dir == UP
       && duration_log (me) > 2)
     {
       Grob * closest_to_flag = extremal_heads (me)[dir];
       Grob * dots = closest_to_flag
-       ? Rhythmic_head::dots_l (closest_to_flag ) : 0;
+       ? Rhythmic_head::get_dots (closest_to_flag ) : 0;
 
       if (dots)
        {
-         Real dp = Staff_symbol_referencer::position_f  (dots);
+         Real dp = Staff_symbol_referencer::get_position (dots);
          Real flagy =  flag (me).extent (Y_AXIS)[-dir] * 2
            / Staff_symbol_referencer::staff_space (me); 
 
@@ -399,7 +419,7 @@ Stem::position_noteheads (Grob*me)
   Real thick = 0.0;
   if (invisible)
         thick = gh_scm2double (me->get_grob_property ("thickness"))
-         * me->paper_l ()->get_var ("linethickness");
+         * me->get_paper ()->get_var ("linethickness");
       
 
   Grob *hed = support_head (me);
@@ -411,10 +431,10 @@ Stem::position_noteheads (Grob*me)
     }
   
   bool parity= true;           // todo: make me settable.
-  int lastpos = int (Staff_symbol_referencer::position_f (heads[0]));
+  int lastpos = int (Staff_symbol_referencer::get_position (heads[0]));
   for (int i=1; i < heads.size (); i ++)
     {
-      Real p = Staff_symbol_referencer::position_f (heads[i]);
+      Real p = Staff_symbol_referencer::get_position (heads[i]);
       int dy =abs (lastpos- (int)p);
 
       if (dy <= 1)
@@ -471,7 +491,7 @@ Stem::before_line_breaking (SCM smob)
     }
   else
     {
-      me->remove_grob_property ("molecule-callback");
+      me->set_grob_property ("molecule-callback", SCM_EOL);
     }
   
   return SCM_UNSPECIFIED;
@@ -523,7 +543,7 @@ Stem::flag (Grob*me)
     }
   bool adjust = to_boolean (me->get_grob_property ("adjust-if-on-staffline"));
 
-  if (String::compare_i (style, "mensural") == 0)
+  if (String::compare (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,
@@ -559,7 +579,7 @@ Stem::flag (Grob*me)
          */
          Grob *first = first_head(me);
          int sz = Staff_symbol_referencer::line_count (me)-1;
-         int p = (int)rint (Staff_symbol_referencer::position_f (first));
+         int p = (int)rint (Staff_symbol_referencer::get_position (first));
          staffline_offs = (((p ^ sz) & 0x1) == 0) ? "1" : "0";
        }
       else
@@ -572,12 +592,12 @@ Stem::flag (Grob*me)
       staffline_offs = "";
     }
   char c = (get_direction (me) == UP) ? 'u' : 'd';
-  String index_str
-    = String ("flags-") + style + to_str (c) + staffline_offs + to_str (duration_log (me));
+  String index_string
+    = String ("flags-") + style + to_string (c) + staffline_offs + to_string (duration_log (me));
   Molecule m
-    = Font_interface::get_default_font (me)->find_by_name (index_str);
+    = Font_interface::get_default_font (me)->find_by_name (index_string);
   if (!fstyle.empty_b ())
-    m.add_molecule (Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + fstyle));
+    m.add_molecule (Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_string (c) + fstyle));
   return m;
 }
 
@@ -610,7 +630,35 @@ Stem::brew_molecule (SCM smob)
   Direction d = get_direction (me);
   
   
-  Real y1 = Staff_symbol_referencer::position_f (first_head (me));
+     
+  Real y1;
+
+  /*
+    This is required to avoid stems passing in tablature chords...
+   */
+
+
+  /*
+    TODO: make  the stem start a direction ?
+  */
+  
+
+  
+  if (to_boolean (me->get_grob_property ("avoid-note-head")))
+    {
+      Grob * lh = last_head (me);
+      if (!lh)
+       return SCM_EOL;
+      y1 = Staff_symbol_referencer::get_position (lh);
+    }
+  else
+    {
+      Grob * lh = first_head (me);
+      if (!lh)
+       return SCM_EOL;
+      y1 = Staff_symbol_referencer::get_position (lh);
+    }
+  
   Real y2 = stem_end_position (me);
   
   Interval stem_y (y1 <? y2,y2 >? y1);
@@ -635,14 +683,14 @@ Stem::brew_molecule (SCM smob)
     {
       Real stem_width = gh_scm2double (me->get_grob_property ("thickness"))
        // URG
-       * me->paper_l ()->get_var ("linethickness");
+       * me->get_paper ()->get_var ("linethickness");
       
       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);
     }
 
-  if (!beam_l (me) && abs (duration_log (me)) > 2)
+  if (!get_beam (me) && abs (duration_log (me)) > 2)
     {
       Molecule fl = flag (me);
       fl.translate_axis (stem_y[d]*dy, Y_AXIS);
@@ -695,7 +743,7 @@ Stem::off_callback (SCM element_smob, SCM)
        {
          Real rule_thick
            = gh_scm2double (me->get_grob_property ("thickness"))
-           * me->paper_l ()->get_var ("linethickness");
+           * me->get_paper ()->get_var ("linethickness");
 
          
          r += - d * rule_thick * 0.5;
@@ -707,156 +755,147 @@ Stem::off_callback (SCM element_smob, SCM)
 
 
 Grob*
-Stem::beam_l (Grob*me)
+Stem::get_beam (Grob*me)
 {
   SCM b=  me->get_grob_property ("beam");
   return unsmob_grob (b);
 }
 
-
 // ugh still very long.
 Stem_info
 Stem::calc_stem_info (Grob*me) 
 {
+  SCM up_to_staff = me->get_grob_property ("up-to-staff");
+  if (gh_scm2bool(up_to_staff)) {
+    
+    // Up-to-staff : the stem end out of the staff.
+
+    /*
+      FIXME: duplicate code.
+     */
+    int line_count = Staff_symbol_referencer::line_count (me);
+    
+    Stem_info si ;
+    
+    Direction dir = get_direction (me);
+    
+    si.ideal_y_ = dir*  (line_count + 1.5);
+    si.dir_ = dir;
+    si.shortest_y_ = si.ideal_y_; 
+    
+    return si;
+  }
+  
   SCM scm_info = me->get_grob_property ("stem-info");
 
   if (gh_pair_p (scm_info ))
     {
       Stem_info si ;
 
-      si.ideal_y = gh_scm2double (gh_car (scm_info)); 
-      si.max_y = gh_scm2double (gh_cadr (scm_info)); 
-      si.min_y = gh_scm2double (gh_caddr (scm_info));
+      si.dir_ = Directional_element_interface::get(me); 
+      si.ideal_y_ = gh_scm2double (gh_car (scm_info)); 
+      si.shortest_y_ = gh_scm2double (gh_cadr (scm_info));
 
       return si;
     }
-    
-  Grob * beam = beam_l (me);
-
-  Direction beam_dir = Directional_element_interface::get (beam);
-  if (!beam_dir)
-    {
-      programming_error ("Beam dir not set.");
-      beam_dir = UP;
-    }
-    
 
+  Direction mydir = Directional_element_interface::get (me);
   Real staff_space = Staff_symbol_referencer::staff_space (me);
   Real half_space = staff_space / 2;
-  
-  int multiplicity = Beam::get_multiplicity (beam);
-  Real interbeam_f = Beam::get_interbeam (beam);
 
+  Grob * beam = get_beam (me);
+  int beam_count = Beam::get_direction_beam_count (beam, mydir);
+  Real beam_translation= Beam::get_beam_translation (beam);
   Real thick = gh_scm2double (beam->get_grob_property ("thickness"));
-  Stem_info info; 
-  info.ideal_y = chord_start_y (me);
-
-  // for simplicity, we calculate as if dir == UP
-
-  /*
-    UGH. This confuses issues more. fixme. --hwn
-   */
-  info.ideal_y *= beam_dir;
-  SCM grace_prop = me->get_grob_property ("grace");
-
-  bool grace_b = to_boolean (grace_prop);
+  Real note_start = chord_start_y (me);
   
-  Array<Real> a;
-  SCM s;
+  /* from here on, calculate as if dir == UP */
+  note_start *= mydir;
   
-  s = me->get_grob_property ("beamed-minimum-lengths");
-  a.clear ();
-  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 = ly_cdr (q))
-    a.push (gh_scm2double (ly_car (q)));
+  SCM grace_prop = me->get_grob_property ("grace");
+  
+  bool grace_b = to_boolean (grace_prop);
+  SCM bml = robust_list_ref ( beam_count - 1,
+                             me->get_grob_property ("beamed-minimum-lengths"));
 
-  Real stem_length =  a[multiplicity <? (a.size () - 1)] * staff_space;
+  Real minimum_length = gh_scm2double(bml)*staff_space;
+  SCM bl =  robust_list_ref ( beam_count - 1,
+                             me->get_grob_property ("beamed-lengths"));
+  Real stem_length =  gh_scm2double(bl) * staff_space;
 
 
   /*
-    This sucks -- On a kneed beam, *all* stems are kneed, not half of them.
+    stem goes to center of beam, hence 0.5
    */
-  if (!beam_dir || (beam_dir == Directional_element_interface::get (me)))
-    /* normal beamed stem */
-    {
-      if (multiplicity)
-       {
-         info.ideal_y += thick + (multiplicity - 1) * interbeam_f;
-       }
-      info.min_y = info.ideal_y;
-      info.max_y = 1000;  // INT_MAX;
+  Real beam_lengthen = beam_translation* (beam_count - 1)
+    + 0.5 * thick;
 
-      info.ideal_y += stem_length;
-      info.min_y += minimum_length;
+  Real shortest_y = note_start + minimum_length + beam_lengthen;
+  Real ideal_y = stem_length + note_start + beam_lengthen;
 
-      /*
-       lowest beam of (UP) beam must never be lower than second staffline
+  /*
+    lowest beam of (UP) beam must never be lower than second staffline
 
-       Hmm, reference (Wanske?)
+    Hmm, reference (Wanske?)
 
-       Although this (additional) rule is probably correct,
-       I expect that highest beam (UP) should also never be lower
-       than middle staffline, just as normal stems.
-       
-      */
-      bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend"));
-      if (!grace_b && !no_extend_b)
-       {
-         /* highest beam of (UP) beam must never be lower than middle
-            staffline
-            lowest beam of (UP) beam must never be lower than second staffline
-          */
-         info.min_y =
-           info.min_y >? 0
-           >? (- 2 * half_space - thick
-               + (multiplicity > 0) * thick
-               + interbeam_f * (multiplicity - 1));
-       }
-    }
-  else
-    /* knee */
-    {
-      info.ideal_y -= thick + stem_length;
-      info.max_y = info.ideal_y - minimum_length;
+    Although this (additional) rule is probably correct,
+    I expect that highest beam (UP) should also never be lower
+    than middle staffline, just as normal stems.
 
-      /*
-       We shouldn't invert the stems, so we set minimum at 0. 
-       */
-      info.min_y = 0.5;
+    Add: not for knees.  Not sure if that's is a good thing.
+  */
+  bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend"));
+  bool knee_b = to_boolean (beam->get_grob_property ("knee"));
+  if (!grace_b && !no_extend_b && !knee_b)
+    {
+      /* highest beam of (UP) beam must never be lower than middle
+        staffline
+        lowest beam of (UP) beam must never be lower than second staffline
+      */
+      ideal_y =
+       ideal_y >? 0
+       >? (- 2 * half_space - thick + beam_lengthen);
     }
+    
   
-  info.ideal_y = (info.max_y <? info.ideal_y) >? info.min_y;
-
-  s = beam->get_grob_property ("shorten");
+  //  ideal_y = ideal_y >? shortest_y;
+  SCM s = beam->get_grob_property ("shorten");
   if (gh_number_p (s))
-    info.ideal_y -= gh_scm2double (s);
+    ideal_y -= gh_scm2double (s);
 
-  Grob *common = me->common_refpoint (beam, Y_AXIS);
-  Real interstaff_f = beam_dir *
-    (me->relative_coordinate (common, Y_AXIS)
-     - beam->relative_coordinate (common, Y_AXIS));
   
-  info.ideal_y += interstaff_f;
-  info.min_y += interstaff_f;
-  info.max_y += interstaff_f ;
-
+  ideal_y *= mydir;
+  shortest_y *= mydir; 
+  
   me->set_grob_property ("stem-info",
-                        scm_list_n (gh_double2scm (info.ideal_y),
-                                    gh_double2scm (info.max_y),
-                                    gh_double2scm (info.min_y),
+                        scm_list_n (gh_double2scm (ideal_y),
+                                    gh_double2scm (shortest_y),
                                     SCM_UNDEFINED));
+
+  Stem_info si;
+  si.dir_ = mydir;
+  si.shortest_y_ = shortest_y;
+  si.ideal_y_ = ideal_y;
   
-  return info;
+  return si;
 }
 
+
+// move to stem?
+Slice
+Stem::beam_multiplicity (Grob *stem)
+{
+  SCM beaming= stem->get_grob_property ("beaming");
+  Slice l = int_list_to_slice (gh_car (beaming));
+  Slice r = int_list_to_slice (gh_cdr (beaming));
+  l.unite (r);
+
+  return l;
+}
+
+
 ADD_INTERFACE (Stem,"stem-interface",
   "A stem",
-  "adjust-if-on-staffline thickness stem-info beamed-lengths beamed-minimum-lengths lengths beam stem-shorten duration-log beaming neutral-direction stem-end-position support-head note-heads direction length style no-stem-extend flag-style dir-forced");
+  "up-to-staff avoid-note-head adjust-if-on-staffline thickness stem-info beamed-lengths beamed-minimum-lengths lengths beam stem-shorten duration-log beaming neutral-direction stem-end-position support-head note-heads direction length style no-stem-extend flag-style");
+