]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
($(outdir)/%.pdf): add DVIPS_FLAGS. This will
[lilypond.git] / lily / stem.cc
index 51c2c5853034934a9500871eacca3304a34756d1..c0af303c0c9a31fcd0fd37dc1359fbe0199c6684 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
     Jan Nieuwenhuizen <janneke@gnu.org>
 
   TODO: This is way too hairy
@@ -23,7 +23,7 @@
 #include "paper-def.hh"
 #include "rhythmic-head.hh"
 #include "font-interface.hh"
-#include "molecule.hh"
+#include "stencil.hh"
 #include "paper-column.hh"
 #include "misc.hh"
 #include "beam.hh"
@@ -33,6 +33,7 @@
 #include "spanner.hh"
 #include "side-position-interface.hh"
 #include "dot-column.hh"
+#include "stem-tremolo.hh"
 
 void
 Stem::set_beaming (Grob*me, int beam_count,  Direction d)
@@ -96,13 +97,13 @@ Stem::stem_end_position (Grob*me)
 Direction
 Stem::get_direction (Grob*me)
 {
-  Direction d = Directional_element_interface::get (me);
+  Direction d = get_grob_direction (me);
 
   if (!d)
     {
        d = get_default_dir (me);
        // urg, AAARGH!
-       Directional_element_interface::set (me, d);
+       set_grob_direction (me, d);
     }
   return d ;
 }
@@ -129,11 +130,7 @@ Stem::set_stemend (Grob*me, Real se)
 Grob*
 Stem::support_head (Grob*me)
 {
-  SCM h = me->get_grob_property ("support-head");
-  Grob * nh = unsmob_grob (h);
-  if (nh)
-    return nh;
-  else if (head_count (me) == 1)
+  if (head_count (me) == 1)
     {
       /*
        UGH.
@@ -218,6 +215,9 @@ icmp (int const &a, int const &b)
   return a-b;
 }
 
+/*
+  The positions, in ascending order.
+ */
 Array<int>
 Stem::note_head_positions (Grob *me)
 {
@@ -229,7 +229,7 @@ Stem::note_head_positions (Grob *me)
 
       ps.push (p);
     }
-
+  
   ps.sort (icmp);
   return ps; 
 }
@@ -241,6 +241,9 @@ Stem::add_head (Grob*me, Grob *n)
   n->set_grob_property ("stem", me->self_scm ());
   n->add_dependency (me);
 
+  /*
+    TODO: why not store Rest pointers? 
+  */
   if (Note_head::has_interface (n))
     {
       Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-heads"), n);
@@ -259,7 +262,7 @@ Stem::get_default_dir (Grob*me)
 {
   int staff_center = 0;
   Interval hp = head_positions (me);
-  if (hp.empty_b())
+  if (hp.is_empty ())
     {
       return CENTER;
     }
@@ -276,20 +279,15 @@ 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))
-    {
-      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"));
+  Real ss = Staff_symbol_referencer::staff_space (me); 
+
+  int durlog = duration_log (me);
+    
   SCM s;
   Array<Real> a;
 
-  Real length = 3.5;
+  
+  Real length = 7;             // WARNING: IN HALF SPACES
   SCM scm_len = me->get_grob_property ("length");
   if (gh_number_p (scm_len))
     {
@@ -300,20 +298,10 @@ Stem::get_default_stem_end_position (Grob*me)
       s = me->get_grob_property ("lengths");
       if (gh_pair_p (s))
        {
-         length = 2* gh_scm2double (robust_list_ref (duration_log(me) -2, s));
+         length = 2* gh_scm2double (robust_list_ref (durlog -2, s));
        }
     }
 
-  Real shorten = 0.0;
-  
-  SCM sshorten = me->get_grob_property ("stem-shorten");
-  SCM scm_shorten = gh_pair_p (sshorten) ?
-    robust_list_ref ((duration_log (me) - 2) >? 0, sshorten): SCM_EOL;
-  if (gh_number_p (scm_shorten))
-    {
-      shorten = 2* gh_scm2double (scm_shorten);
-    }
-
 
 
   /* URGURGURG
@@ -323,19 +311,65 @@ Stem::get_default_stem_end_position (Grob*me)
   if (!dir)
     {
       dir = get_default_dir (me);
-      Directional_element_interface::set (me, dir);
+      set_grob_direction (me, dir);
     }
 
-  /* On boundary: shorten only half */
-  if (abs (head_positions (me)[get_direction (me)]) <= 1)
-    shorten *= 0.5;
-  
+
   /* stems in unnatural (forced) direction should be shortened, 
     according to [Roush & Gourlay] */
   if (!chord_start_y (me)
       || (get_direction (me) != get_default_dir (me)))
-    length -= shorten;
+    {
+      
+  
+      SCM sshorten = me->get_grob_property ("stem-shorten");
+      SCM scm_shorten = gh_pair_p (sshorten) ?
+       robust_list_ref ((duration_log (me) - 2) >? 0, sshorten): SCM_EOL;
+      Real shorten = 2* robust_scm2double (scm_shorten,0);
+      
+  
+      /* On boundary: shorten only half */
+      if (abs (head_positions (me)[get_direction (me)]) <= 1)
+       shorten *= 0.5;
+  
+      length -= shorten;
+    }
+
+  /*
+    Tremolo stuff: 
+  */
+  Grob * trem = unsmob_grob (me->get_grob_property ("tremolo-flag"));
+  if (trem &&  !unsmob_grob (me->get_grob_property ("beam")))
+    {
+      /*
+       Crude hack: add extra space if tremolo flag is there.
 
+       We can't do this for the beam, since we get into a loop
+       (Stem_tremolo::raw_stencil() looks at the beam.)
+       
+        --hwn 
+      */
+      
+      Real minlen =
+       1.0 + 2 * Stem_tremolo::raw_stencil (trem).extent (Y_AXIS).length  () / ss;
+      
+      if (durlog >= 3)
+       {
+         Interval flag_ext = flag (me).extent (Y_AXIS) ;
+         if (!flag_ext.is_empty ())
+           minlen += 2 * flag_ext.length () / ss ;
+
+         /*
+           The clash is smaller for down stems (since the tremolo is
+           angled up.)
+          */
+         if (dir == DOWN)
+           minlen -= 1.0;
+       }
+      
+      length = length >? (minlen + 1.0);
+    }
+   
   Interval hp = head_positions (me);  
   Real st = hp[dir] + dir * length;
 
@@ -343,7 +377,7 @@ Stem::get_default_stem_end_position (Grob*me)
     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?
+  if (!no_extend_b && dir * st < 0) // junkme?
     st = 0.0;
 
   /*
@@ -353,7 +387,7 @@ Stem::get_default_stem_end_position (Grob*me)
     
   */
   if (!get_beam (me) && dir == UP
-      && duration_log (me) > 2)
+      && durlog > 2)
     {
       Grob * closest_to_flag = extremal_heads (me)[dir];
       Grob * dots = closest_to_flag
@@ -363,7 +397,7 @@ Stem::get_default_stem_end_position (Grob*me)
        {
          Real dp = Staff_symbol_referencer::get_position (dots);
          Real flagy =  flag (me).extent (Y_AXIS)[-dir] * 2
-           / Staff_symbol_referencer::staff_space (me); 
+           / ss;
 
          /*
            Very gory: add myself to the X-support of the parent,
@@ -420,8 +454,7 @@ Stem::position_noteheads (Grob*me)
     heads.reverse ();
 
 
-  Real thick = gh_scm2double (me->get_grob_property ("thickness"))
-     * me->get_paper ()->get_var ("linethickness");
+  Real thick = thickness (me);
       
   Grob *hed = support_head (me);
   Real w = Note_head::head_extent (hed,X_AXIS)[dir];
@@ -432,29 +465,38 @@ Stem::position_noteheads (Grob*me)
     }
   
   bool parity= true;
-  int lastpos = int (Staff_symbol_referencer::get_position (heads[0]));
+  Real lastpos = Real (Staff_symbol_referencer::get_position (heads[0]));
   for (int i=1; i < heads.size (); i ++)
     {
       Real p = Staff_symbol_referencer::get_position (heads[i]);
-      int dy =abs (lastpos- (int)p);
+      Real dy =fabs (lastpos- p);
 
-      if (dy <= 1)
+      /*
+       dy should always be 0.5, 0.0, 1.0, but provide safety margin
+       for rounding errors.
+      */
+      if (dy < 1.1)            
        {
          if (parity)
            {
              Real l = Note_head::head_extent (heads[i], X_AXIS).length ();
 
              Direction d = get_direction (me);
-             /* 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);
+             /*
+               Reversed head should be shifted l-thickness, but this
+               looks too crowded, so we only shift l-0.5*thickness.
+
+               This leads to assymetry: Normal heads overlap the
+               stem 100% whereas reversed heads only overlaps the
+               stem 50%
+
+             */
+
+             Real reverse_overlap =0.5;
+             heads[i]->translate_axis ((l-thick*reverse_overlap) * d, X_AXIS);
 
              if (invisible_b(me))
-               heads[i]->translate_axis (-thick*(2-magic) * d , X_AXIS);
+               heads[i]->translate_axis (-thick*(2 - reverse_overlap) * d , X_AXIS);
 
              
             /* TODO:
@@ -498,7 +540,7 @@ Stem::before_line_breaking (SCM smob)
     }
   else
     {
-      me->set_grob_property ("molecule-callback", SCM_EOL);
+      me->set_grob_property ("print-function", SCM_EOL);
     }
   
   return SCM_UNSPECIFIED;
@@ -517,10 +559,10 @@ Stem::height (SCM smob, SCM ax)
   Grob * me = unsmob_grob (smob);
   assert (a == Y_AXIS);
 
-  SCM mol = me->get_uncached_molecule ();
+  SCM mol = me->get_uncached_stencil ();
   Interval iv;
   if (mol != SCM_EOL)
-    iv = unsmob_molecule (mol)->extent (a);
+    iv = unsmob_stencil (mol)->extent (a);
   if (Grob *b =get_beam (me))
     {
       Direction d = get_direction (me);
@@ -531,7 +573,7 @@ Stem::height (SCM smob, SCM ax)
 }
 
 
-Molecule
+Stencil
 Stem::flag (Grob*me)
 {
   /* TODO: maybe property stroke-style should take different values,
@@ -547,7 +589,7 @@ Stem::flag (Grob*me)
 
   if (flag_style == "no-flag")
     {
-      return Molecule ();
+      return Stencil ();
     }
 
   bool adjust = to_boolean (me->get_grob_property ("adjust-if-on-staffline"));
@@ -579,7 +621,8 @@ Stem::flag (Grob*me)
             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).  */
+            note heads to a single stem in mensural notation).
+         */
 
          /*
            perhaps the detection whether this correction is needed should
@@ -605,8 +648,8 @@ Stem::flag (Grob*me)
   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 ())
+  Stencil flag = fm->find_by_name ("flags-" + font_char);
+  if (flag.is_empty ())
     {
       me->warning (_f ("flag `%s' not found", font_char));
     }
@@ -615,17 +658,17 @@ Stem::flag (Grob*me)
   if (gh_string_p (stroke_style_scm))
     {
       String stroke_style = ly_scm2string (stroke_style_scm);
-      if (!stroke_style.empty_b ())
+      if (!stroke_style.is_empty ())
        {
          String font_char = to_string (dir) + stroke_style;
-         Molecule stroke = fm->find_by_name ("flags-" + font_char);
-         if (stroke.empty_b ())
+         Stencil stroke = fm->find_by_name ("flags-" + font_char);
+         if (stroke.is_empty ())
            {
              me->warning (_f ("flag stroke `%s' not found", font_char));
            }
          else
            {
-             flag.add_molecule (stroke);
+             flag.add_stencil (stroke);
            }
        }
     }
@@ -639,59 +682,53 @@ Stem::dim_callback (SCM e, SCM ax)
 {
   Axis a = (Axis) gh_scm2int (ax);
   assert (a == X_AXIS);
-  Grob *se = unsmob_grob (e);
+  Grob *me = unsmob_grob (e);
   Interval r (0, 0);
-  if (unsmob_grob (se->get_grob_property ("beam")) || abs (duration_log (se)) <= 2)
+  if (unsmob_grob (me->get_grob_property ("beam")) || abs (duration_log (me)) <= 2)
     ;  // TODO!
   else
     {
-      r = flag (se).extent (X_AXIS);
+      r = flag (me).extent (X_AXIS)
+       + thickness (me)/2;
     }
   return ly_interval2scm (r);
 }
  
+Real
+Stem::thickness (Grob* me)
+{
+  return gh_scm2double (me->get_grob_property ("thickness"))
+    * Staff_symbol_referencer::line_thickness (me);
+}
 
-
-MAKE_SCHEME_CALLBACK (Stem,brew_molecule,1);
+MAKE_SCHEME_CALLBACK (Stem,print,1);
 
 SCM
-Stem::brew_molecule (SCM smob) 
+Stem::print (SCM smob) 
 {
   Grob*me = unsmob_grob (smob);
-  Molecule mol;
+  Stencil mol;
   Direction d = get_direction (me);
-  
-  
      
-  Real y1;
-
   /*
+    TODO: make the stem start a direction ?
+
     This is required to avoid stems passing in tablature chords...
-   */
+  */
+  Grob *lh = to_boolean (me->get_grob_property ("avoid-note-head")) 
+    ? last_head (me) :  lh = first_head (me);
 
+  if (!lh)
+    return SCM_EOL;
 
-  /*
-    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);
-    }
+  if (invisible_b (me))
+    return SCM_EOL;
   
+  Real y1 = Staff_symbol_referencer::get_position (lh);
   Real y2 = stem_end_position (me);
   
   Interval stem_y (y1 <? y2,y2 >? y1);
-
 
   // dy?
   Real dy = Staff_symbol_referencer::staff_space (me) * 0.5;
@@ -702,28 +739,30 @@ Stem::brew_molecule (SCM smob)
        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);
+      Real y_attach = Note_head::stem_attachment_coordinate (hed, Y_AXIS);
 
       y_attach = head_height.linear_combination (y_attach);
       stem_y[Direction (-d)] += d * y_attach/dy;
     }
+
   
-  if (!invisible_b (me))
-    {
-      Real stem_width = gh_scm2double (me->get_grob_property ("thickness"))
-       // URG
-       * 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);
-    }
+  // URG
+  Real stem_width = thickness (me);
+  Real blot = 
+       me->get_paper ()->get_realvar (ly_symbol2scm ("blotdiameter"));
+  
+  Box b = Box (Interval (-stem_width/2, stem_width/2),
+              Interval (stem_y[DOWN]*dy, stem_y[UP]*dy));
+
+  Stencil ss = Lookup::round_filled_box (b, blot);
+  mol.add_stencil (ss);
 
   if (!get_beam (me) && abs (duration_log (me)) > 2)
     {
-      Molecule fl = flag (me);
-      fl.translate_axis (stem_y[d]*dy, Y_AXIS);
-      mol.add_molecule (fl);
+      Stencil fl = flag (me);
+      fl.translate_axis (stem_y[d]*dy - d * blot/2, Y_AXIS);
+      fl.translate_axis (stem_width/2, X_AXIS);
+      mol.add_stencil (fl);
     }
 
   return mol.smobbed_copy ();
@@ -748,7 +787,6 @@ Stem::off_callback (SCM element_smob, SCM)
   if (Grob * f = first_head (me))
     {
       Interval head_wid = Note_head::head_extent(f, X_AXIS);
-
       
       Real attach =0.0;
 
@@ -771,9 +809,7 @@ Stem::off_callback (SCM element_smob, SCM)
       if (attach)
        {
          Real rule_thick
-           = gh_scm2double (me->get_grob_property ("thickness"))
-           * me->get_paper ()->get_var ("linethickness");
-
+           = thickness (me);
          
          r += - d * rule_thick * 0.5;
        }
@@ -781,6 +817,7 @@ Stem::off_callback (SCM element_smob, SCM)
   return gh_double2scm (r);
 }
 
+
 Grob*
 Stem::get_beam (Grob*me)
 {
@@ -800,54 +837,40 @@ Stem::get_stem_info (Grob *me)
     }
   
   Stem_info si;
-  si.dir_ = Directional_element_interface::get (me); 
+  si.dir_ = get_grob_direction (me); 
   si.ideal_y_ = gh_scm2double (gh_car (scm_info)); 
   si.shortest_y_ = gh_scm2double (gh_cadr (scm_info));
   return si;
 }
 
+
+/*
+  TODO: add extra space for tremolos!
+ */
 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 my_dir = Directional_element_interface::get (me);
+  Direction my_dir = get_grob_direction (me);
   Real staff_space = Staff_symbol_referencer::staff_space (me);
   Grob *beam = get_beam (me);
   Real beam_translation = Beam::get_beam_translation (beam);
-  Real beam_thickness = gh_scm2double (beam->get_grob_property ("thickness"));
+  Real beam_thickness = Beam::get_thickness (beam);
   int beam_count = Beam::get_direction_beam_count (beam, my_dir);
 
 
   /* Simple standard stem length */
+  SCM lengths = me->get_grob_property ("beamed-lengths");
   Real ideal_length =
-    gh_scm2double (robust_list_ref
-                  (beam_count - 1,
-                   me->get_grob_property ("beamed-lengths")))
+    gh_scm2double (robust_list_ref (beam_count - 1,lengths))
+               
     * staff_space
     /* stem only extends to center of beam */
     - 0.5 * beam_thickness;
-
   
   /* Condition: sane minimum free stem length (chord to beams) */
+  lengths = me->get_grob_property ("beamed-minimum-free-lengths");
   Real ideal_minimum_free =
-    gh_scm2double (robust_list_ref
-                  (beam_count - 1,
-                   me->get_grob_property ("beamed-minimum-free-lengths")))
+    gh_scm2double (robust_list_ref (beam_count - 1, lengths))
     * staff_space;
   
 
@@ -873,7 +896,7 @@ Stem::calc_stem_info (Grob *me)
   Real note_start =
     /* staff positions */
     head_positions (me)[my_dir] * 0.5
-    * my_dir;
+    * my_dir * staff_space;
   Real ideal_y = note_start + ideal_length;
 
 
@@ -892,11 +915,9 @@ Stem::calc_stem_info (Grob *me)
      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"));
   bool knee_b = to_boolean (beam->get_grob_property ("knee"));
-  if (!grace_b && !no_extend_b && !knee_b)
+  if (!no_extend_b && !knee_b)
     {
       /* Highest beam of (UP) beam must never be lower than middle
         staffline */
@@ -907,9 +928,7 @@ Stem::calc_stem_info (Grob *me)
     }
 
 
-  SCM shorten = beam->get_grob_property ("shorten");
-  if (gh_number_p (shorten))
-    ideal_y -= gh_scm2double (shorten);
+  ideal_y -= robust_scm2double (beam->get_grob_property ("shorten"), 0);
 
   Real minimum_free =
     gh_scm2double (robust_list_ref
@@ -947,8 +966,32 @@ Stem::beam_multiplicity (Grob *stem)
 }
 
 
+/*
+  these are too many props.
+ */
 ADD_INTERFACE (Stem,"stem-interface",
-  "A stem",
-  "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");
+              "A stem",
+              "tremolo-flag french-beaming "
+              "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 "
+              "note-heads direction length flag-style "
+              "no-stem-extend stroke-style");
 
 
+
+/****************************************************************/
+
+Stem_info::Stem_info()
+{
+  ideal_y_ = shortest_y_ =0;
+  dir_ = CENTER;
+}
+
+void
+Stem_info::scale (Real x)
+{
+  ideal_y_ *= x;
+  shortest_y_ *= x;
+}