]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
(brew_molecule): cleaned up Cluster code and
[lilypond.git] / lily / stem.cc
index 32ccc700b85a6b12e4f88e42503effd2e74fe0e5..7a63f20b7c5eeb0e5d6a8f023f11ca07faadc34e 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
     Jan Nieuwenhuizen <janneke@gnu.org>
 
   TODO: This is way too hairy
@@ -65,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]));
 }
 
 
@@ -123,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)
 {
@@ -152,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)
 {
@@ -193,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 {
@@ -221,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);
     }
@@ -246,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
@@ -271,21 +276,20 @@ Stem::get_default_dir (Grob*me)
 Real
 Stem::get_default_stem_end_position (Grob*me) 
 {
+  /* Tab notation feature: make stem end extend out of staff. */
   SCM up_to_staff = me->get_grob_property ("up-to-staff");
-  if (to_boolean(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);
+      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))
     {
@@ -294,15 +298,12 @@ Stem::get_default_stem_end_position (Grob*me)
   else
     {
       s = me->get_grob_property ("lengths");
-      length_f = 3.5;
-      
       if (gh_pair_p (s))
        {
          length_f = 2* gh_scm2double (robust_list_ref (duration_log(me) -2, s));
        }
     }
 
-
   Real shorten_f = 0.0;
   
   SCM sshorten = me->get_grob_property ("stem-shorten");
@@ -334,6 +335,10 @@ Stem::get_default_stem_end_position (Grob*me)
   Interval hp = head_positions (me);  
   Real st = hp[dir] + dir * length_f;
 
+
+  /*
+    TODO: change name  to extend-stems to staff/center/'()
+  */
   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;
@@ -344,16 +349,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); 
 
@@ -413,10 +418,8 @@ Stem::position_noteheads (Grob*me)
 
 
   bool invisible = invisible_b (me);
-  Real thick = 0.0;
-  if (invisible)
-        thick = gh_scm2double (me->get_grob_property ("thickness"))
-         * me->paper_l ()->get_var ("linethickness");
+  Real thick = gh_scm2double (me->get_grob_property ("thickness"))
+     * me->get_paper ()->get_var ("linethickness");
       
 
   Grob *hed = support_head (me);
@@ -428,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)
@@ -441,10 +444,16 @@ Stem::position_noteheads (Grob*me)
              Real l = Note_head::head_extent (heads[i], X_AXIS).length ();
 
              Direction d = get_direction (me);
-             heads[i]->translate_axis (l * d, X_AXIS);
+             /* reversed head should be shifted l-thickness, but this looks
+                too crowded, so we only shift l-0.5*thickness.
+                Notice that this leads to assymetry: Normal heads overlap
+                the stem 100% whereas reversed heads only overlaps the stem
+                50% */
+             #define magic 0.5
+             heads[i]->translate_axis ((l-thick*magic) * d, X_AXIS);
 
              if (invisible_b(me))
-               heads[i]->translate_axis (-thick *2* d , X_AXIS);
+               heads[i]->translate_axis (-thick*(2-magic) * d , X_AXIS);
 
              
             /* TODO:
@@ -488,7 +497,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;
@@ -511,6 +520,12 @@ Stem::height (SCM smob, SCM ax)
   Interval iv;
   if (mol != SCM_EOL)
     iv = unsmob_molecule (mol)->extent (a);
+  if (Grob *b =get_beam (me))
+    {
+      Direction d = get_direction (me);
+      iv[d] += d * Beam::get_thickness (b) /2.0 ;
+    }
+
   return ly_interval2scm (iv);
 }
 
@@ -518,29 +533,26 @@ Stem::height (SCM smob, SCM ax)
 Molecule
 Stem::flag (Grob*me)
 {
-  /* 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))
+  /* TODO: maybe property stroke-style should take different values,
+     e.g. "" (i.e. no stroke), "single" and "double" (currently, it's
+     '() or "grace").  */
+  String flag_style;
+  
+  SCM flag_style_scm = me->get_grob_property ("flag-style");
+  if (gh_symbol_p (flag_style_scm))
     {
-      fstyle = ly_scm2string (fst);
+      flag_style = ly_symbol2string (flag_style_scm);
     }
 
-  SCM st = me->get_grob_property ("style");
-  if (gh_symbol_p (st))
+  if (flag_style == "no-flag")
     {
-      style = (ly_scm2string (scm_symbol_to_string (st)));
-    }
-  else
-    {
-      style = "";
+      return Molecule ();
     }
+
   bool adjust = to_boolean (me->get_grob_property ("adjust-if-on-staffline"));
 
-  if (String::compare_i (style, "mensural") == 0)
+  String staffline_offs;
+  if (String::compare (flag_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,
@@ -574,10 +586,9 @@ Stem::flag (Grob*me)
            
            --hwn.
          */
-         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";
+         int p = (int)rint (Staff_symbol_referencer::get_position (first_head (me)));
+         staffline_offs = Staff_symbol_referencer::on_staffline (me, p) ?
+           "1" : "0";
        }
       else
         {
@@ -588,14 +599,37 @@ 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));
-  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;
+
+  char dir = (get_direction (me) == UP) ? 'u' : 'd';
+  String font_char =
+    flag_style + to_string (dir) + staffline_offs + to_string (duration_log (me));
+  Font_metric *fm = Font_interface::get_default_font (me);
+  Molecule flag = fm->find_by_name ("flags-" + font_char);
+  if (flag.empty_b ())
+    {
+      me->warning (_f ("flag `%s' not found", font_char));
+    }
+
+  SCM stroke_style_scm = me->get_grob_property ("stroke-style");
+  if (gh_string_p (stroke_style_scm))
+    {
+      String stroke_style = ly_scm2string (stroke_style_scm);
+      if (!stroke_style.empty_b ())
+       {
+         String font_char = to_string (dir) + stroke_style;
+         Molecule stroke = fm->find_by_name ("flags-" + font_char);
+         if (stroke.empty_b ())
+           {
+             me->warning (_f ("flag stroke `%s' not found", font_char));
+           }
+         else
+           {
+             flag.add_molecule (stroke);
+           }
+       }
+    }
+
+  return flag;
 }
 
 MAKE_SCHEME_CALLBACK (Stem,dim_callback,2);
@@ -638,22 +672,19 @@ Stem::brew_molecule (SCM smob)
   /*
     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::position_f (lh);
+      y1 = Staff_symbol_referencer::get_position (lh);
     }
   else
     {
       Grob * lh = first_head (me);
       if (!lh)
        return SCM_EOL;
-      y1 = Staff_symbol_referencer::position_f (lh);
+      y1 = Staff_symbol_referencer::get_position (lh);
     }
   
   Real y2 = stem_end_position (me);
@@ -680,14 +711,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);
@@ -740,7 +771,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;
@@ -749,134 +780,161 @@ Stem::off_callback (SCM element_smob, SCM)
   return gh_double2scm (r);
 }
 
-
-
 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) 
+Stem::get_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;
-  }
-  
+  /* Return cached info if available */
   SCM scm_info = me->get_grob_property ("stem-info");
-
-  if (gh_pair_p (scm_info ))
+  if (!gh_pair_p (scm_info))
     {
-      Stem_info si ;
-
-      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));
+      calc_stem_info (me);
+      scm_info = me->get_grob_property ("stem-info");
+    }
+  
+  Stem_info si;
+  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;
+}
 
-      return si;
+void
+Stem::calc_stem_info (Grob *me)
+{
+  /* Tab notation feature: make stem end extend out of staff. */
+  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);
+      Real ideal_y = dir * (line_count + 1.5);
+      Real shortest_y = ideal_y;
+      
+      me->set_grob_property ("stem-info",
+                            scm_list_n (gh_double2scm (ideal_y),
+                                        gh_double2scm (shortest_y),
+                                        SCM_UNDEFINED));
+      return;
     }
 
-  Direction mydir = Directional_element_interface::get (me);
+  Direction my_dir = Directional_element_interface::get (me);
   Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real half_space = staff_space / 2;
+  Grob *beam = get_beam (me);
+  Real beam_translation = Beam::get_beam_translation (beam);
+  Real beam_thickness = gh_scm2double (beam->get_grob_property ("thickness"));
+  int beam_count = Beam::get_direction_beam_count (beam, my_dir);
+
+
+  /* Simple standard stem length */
+  Real ideal_length =
+    gh_scm2double (robust_list_ref
+                  (beam_count - 1,
+                   me->get_grob_property ("beamed-lengths")))
+    * staff_space
+    /* stem only extends to center of beam */
+    - 0.5 * beam_thickness;
 
-  Grob * beam = beam_l (me);
-  int beam_count = beam_multiplicity(me).length()+1;
-  Real beam_translation= Beam::get_beam_translation (beam);
-  Real thick = gh_scm2double (beam->get_grob_property ("thickness"));
-  Real note_start = chord_start_y (me);
-  
-  /* from here on, calculate as if dir == UP */
-  note_start *= mydir;
   
-  SCM grace_prop = me->get_grob_property ("grace");
+  /* Condition: sane minimum free stem length (chord to beams) */
+  Real ideal_minimum_free =
+    gh_scm2double (robust_list_ref
+                  (beam_count - 1,
+                   me->get_grob_property ("beamed-minimum-free-lengths")))
+    * staff_space;
   
-  bool grace_b = to_boolean (grace_prop);
-  SCM bml = robust_list_ref ( beam_count ,
-                             me->get_grob_property ("beamed-minimum-lengths"));
 
-  Real minimum_length = gh_scm2double(bml)*staff_space;
-  SCM bl =  robust_list_ref ( beam_count ,
-                             me->get_grob_property ("beamed-lengths"));
-  Real stem_length =  gh_scm2double(bl) * staff_space;
+  /* UGH
+     It seems that also for ideal minimum length, we must use
+     the maximum beam count (for this direction):
+     
+     \score{ \notes\relative c''{ [a8 a32] }}
+     
+     must be horizontal. */
+  Real height_of_my_beams = beam_thickness
+    + (beam_count - 1) * beam_translation;
 
+  Real ideal_minimum_length = ideal_minimum_free
+    + height_of_my_beams
+    /* stem only extends to center of beam */
+    - 0.5 * beam_thickness;
 
-  /*
-    stem goes to center of beam, hence 0.5
-   */
-  Real beam_lengthen = beam_translation* (beam_count - 1)
-    + ((beam_count > 0) ? thick : 0) - 0.5 * thick;
+  ideal_length = ideal_length >? ideal_minimum_length;
 
-  Real shortest_y = note_start + minimum_length + beam_lengthen;
-  Real ideal_y = stem_length + note_start + beam_lengthen;
+  
+  /* Convert to Y position, calculate for dir == UP */
+  Real note_start =
+    /* staff positions */
+    head_positions (me)[my_dir] * 0.5
+    * my_dir;
+  Real ideal_y = note_start + ideal_length;
 
-  /*
-    lowest beam of (UP) beam must never be lower than second staffline
 
-    Hmm, reference (Wanske?)
+  /* Conditions for Y position */
 
-    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.
-       
-  */
+  /* Lowest beam of (UP) beam must never be lower than second staffline
+     Reference?
+     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.
+
+     Reference?
+
+     Obviously not for grace beams.
+     
+     Also, not for knees.  Seems to be a good thing. */
+  SCM grace = me->get_grob_property ("grace");
+  bool grace_b = to_boolean (grace);
   bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend"));
-  if (!grace_b && !no_extend_b)
+  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);
+      /* Highest beam of (UP) beam must never be lower than middle
+        staffline */
+      ideal_y =        ideal_y >? 0;
+      /* Lowest beam of (UP) beam must never be lower than second staffline */
+      ideal_y =        ideal_y >? (-staff_space
+                           - beam_thickness + height_of_my_beams);
     }
-    
-  
-  //  ideal_y = ideal_y >? shortest_y;
-  SCM s = beam->get_grob_property ("shorten");
-  if (gh_number_p (s))
-    ideal_y -= gh_scm2double (s);
 
+
+  SCM shorten = beam->get_grob_property ("shorten");
+  if (gh_number_p (shorten))
+    ideal_y -= gh_scm2double (shorten);
+
+
+  Real minimum_free =
+    gh_scm2double (robust_list_ref
+                  (beam_count - 1,
+                   me->get_grob_property
+                   ("beamed-extreme-minimum-free-lengths")))
+    * staff_space;
+
+  Real minimum_length = minimum_free
+    + height_of_my_beams
+    /* stem only extends to center of beam */
+    - 0.5 * beam_thickness;
+
+  Real minimum_y = note_start + minimum_length;
+  
   
-  ideal_y *= mydir;
-  shortest_y *= mydir; 
+  ideal_y *= my_dir;
+  Real shortest_y = minimum_y * my_dir; 
   
   me->set_grob_property ("stem-info",
                         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 si;
 }
 
-
-// move to stem?
 Slice
 Stem::beam_multiplicity (Grob *stem)
 {
@@ -891,6 +949,6 @@ Stem::beam_multiplicity (Grob *stem)
 
 ADD_INTERFACE (Stem,"stem-interface",
   "A stem",
-  "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 dir-forced");
+  "french-beaming up-to-staff avoid-note-head adjust-if-on-staffline thickness stem-info beamed-lengths beamed-minimum-free-lengths beamed-extreme-minimum-free-lengths lengths beam stem-shorten duration-log beaming neutral-direction stem-end-position support-head note-heads direction length flag-style no-stem-extend stroke-style");