]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / stem.cc
index 7b90d475e13251b3b01c4902f26b2cb0c09b6c90..a25c37f777211d6a77936decee08787fb8cf1016 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
 
   TODO: This is way too hairy
 #include <cmath>               // rint
 using namespace std;
 
-#include "lookup.hh"
+#include "beam.hh"
 #include "directional-element-interface.hh"
+#include "dot-column.hh"
+#include "font-interface.hh"
+#include "international.hh"
+#include "lookup.hh"
+#include "misc.hh"
 #include "note-head.hh"
-#include "warn.hh"
 #include "output-def.hh"
-#include "rhythmic-head.hh"
-#include "font-interface.hh"
 #include "paper-column.hh"
-#include "misc.hh"
-#include "beam.hh"
-#include "rest.hh"
 #include "pointer-group-interface.hh"
-#include "staff-symbol-referencer.hh"
+#include "rest.hh"
+#include "rhythmic-head.hh"
 #include "side-position-interface.hh"
-#include "dot-column.hh"
+#include "staff-symbol-referencer.hh"
 #include "stem-tremolo.hh"
+#include "warn.hh"
 
 void
 Stem::set_beaming (Grob *me, int beam_count, Direction d)
@@ -47,8 +48,12 @@ Stem::set_beaming (Grob *me, int beam_count, Direction d)
     }
 
   SCM lst = index_get_cell (pair, d);
-  for (int i = 0; i < beam_count; i++)
-    lst = scm_cons (scm_from_int (i), lst);
+  if (beam_count)
+    for (int i = 0; i < beam_count; i++)
+      lst = scm_cons (scm_from_int (i), lst);
+  else
+    lst = SCM_BOOL_F;
+  
   index_set_cell (pair, d, lst);
 }
 
@@ -154,7 +159,7 @@ Stem::extremal_heads (Grob *me)
   Drul_array<Grob *> exthead (0, 0);
   extract_grob_set (me, "note-heads", heads);
 
-  for (int i = heads.size (); i--;)
+  for (vsize i = heads.size (); i--;)
     {
       Grob *n = heads[i];
       int p = Staff_symbol_referencer::get_rounded_position (n);
@@ -180,21 +185,21 @@ integer_compare (int const &a, int const &b)
 }
 
 /* The positions, in ascending order.  */
-Array<int>
+vector<int>
 Stem::note_head_positions (Grob *me)
 {
-  Array<int> ps;
+  vector<int> ps;
   extract_grob_set (me, "note-heads", heads);
 
-  for (int i = heads.size (); i--;)
+  for (vsize i = heads.size (); i--;)
     {
       Grob *n = heads[i];
       int p = Staff_symbol_referencer::get_rounded_position (n);
 
-      ps.push (p);
+      ps.push_back (p);
     }
 
-  ps.sort (integer_compare);
+  vector_sort (ps, integer_compare);
   return ps;
 }
 
@@ -229,23 +234,24 @@ Stem::calc_stem_end_position (SCM smob)
   if (!head_count (me))
     return scm_from_double (0.0);
 
-
+  
   Real ss = Staff_symbol_referencer::staff_space (me);
   int durlog = duration_log (me);
-  Array<Real> a;
+  vector<Real> a;
 
   /* WARNING: IN HALF SPACES */
   Real length = robust_scm2double (me->get_property ("length"), 7);
 
   Direction dir = get_grob_direction (me);
   Interval hp = head_positions (me);
-  Real st = dir ? hp[dir] + dir * length : 0;
+  Real stem_end = dir ? hp[dir] + dir * length : 0;
 
   /* TODO: change name  to extend-stems to staff/center/'()  */
   bool no_extend_b = to_boolean (me->get_property ("no-stem-extend"));
-  if (!no_extend_b && dir * st < 0)
-    st = 0.0;
+  if (!no_extend_b && dir * stem_end < 0)
+    stem_end = 0.0;
 
+  
   /* Make a little room if we have a upflag and there is a dot.
      previous approach was to lengthen the stem. This is not
      good typesetting practice.  */
@@ -259,11 +265,12 @@ Stem::calc_stem_end_position (SCM smob)
       if (dots)
        {
          Real dp = Staff_symbol_referencer::get_position (dots);
-         Real flagy = flag (me).extent (Y_AXIS)[-dir] * 2 / ss;
+         Interval flag_yext = flag (me).extent (Y_AXIS) * (2 / ss) + stem_end;
 
          /* Very gory: add myself to the X-support of the parent,
             which should be a dot-column. */
-         if (dir * (st + flagy - dp) < 0.5)
+         
+         if (flag_yext.distance (dp) < 0.5)
            {
              Grob *par = dots->get_parent (X_AXIS);
 
@@ -279,7 +286,7 @@ Stem::calc_stem_end_position (SCM smob)
        }
     }
 
-  return scm_from_double (st);
+  return scm_from_double (stem_end);
 }
 
 
@@ -317,6 +324,8 @@ Stem::calc_length (SCM smob)
       length -= shorten;
     }
 
+  length *= robust_scm2double (me->get_property ("length-fraction"), 1.0);
+
   /* Tremolo stuff.  */
   Grob *t_flag = unsmob_grob (me->get_object ("tremolo-flag"));
   if (t_flag && !unsmob_grob (me->get_object ("beam")))
@@ -327,20 +336,24 @@ Stem::calc_length (SCM smob)
       (Stem_tremolo::raw_stencil () looks at the beam.) --hwn  */
 
       Real minlen = 1.0
-       + 2 * Stem_tremolo::raw_stencil (t_flag).extent (Y_AXIS).length ()
+       + 2 * t_flag->extent (t_flag, Y_AXIS).length ()
        / ss;
 
+      /* We don't want to add the whole extent of the flag because the trem
+         and the flag can overlap partly. beam_translation gives a good
+         approximation */
       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;
-       }
+        {
+          Real beam_trans = Stem_tremolo::get_beam_translation (t_flag);
+          /* the obvious choice is (durlog - 2) here, but we need a bit more space. */
+          minlen += 2 * (durlog - 1.5) * beam_trans;
+
+          /* up-stems need even a little more space to avoid collisions. This
+             needs to be in sync with the tremolo positioning code in
+             Stem_tremolo::print */
+          if (dir == UP)
+            minlen += beam_trans;
+        }
       length = max (length, minlen + 1.0);
     }
   
@@ -363,24 +376,31 @@ Stem::calc_positioning_done (SCM smob)
     return SCM_BOOL_T;
 
   extract_grob_set (me, "note-heads", ro_heads);
-  Link_array<Grob> heads (ro_heads);
-  heads.sort (compare_position);
+  vector<Grob*> heads (ro_heads);
+  vector_sort (heads, compare_position);
   Direction dir = get_grob_direction (me);
 
   if (dir < 0)
-    heads.reverse ();
+    reverse (heads);
 
   Real thick = thickness (me);
 
   Grob *hed = support_head (me);
+  if (!dir)
+    {
+      programming_error ("Stem dir must be up or down.");
+      dir = UP;
+      set_grob_direction (me, dir);
+    }
+  
   Real w = hed->extent (hed, X_AXIS)[dir];
-  for (int i = 0; i < heads.size (); i++)
+  for (vsize i = 0; i < heads.size (); i++)
     heads[i]->translate_axis (w - heads[i]->extent (heads[i], X_AXIS)[dir],
                              X_AXIS);
 
   bool parity = true;
   Real lastpos = Real (Staff_symbol_referencer::get_position (heads[0]));
-  for (int i = 1; i < heads.size (); i++)
+  for (vsize i = 1; i < heads.size (); i++)
     {
       Real p = Staff_symbol_referencer::get_position (heads[i]);
       Real dy = fabs (lastpos- p);
@@ -438,8 +458,6 @@ Stem::calc_positioning_done (SCM smob)
   return SCM_BOOL_T;
 }
 
-
-
 MAKE_SCHEME_CALLBACK(Stem, calc_direction, 1);
 SCM
 Stem::calc_direction (SCM smob)
@@ -453,39 +471,42 @@ Stem::calc_direction (SCM smob)
       dir = get_grob_direction (me);
     }
   else
-    dir = get_default_dir (me);
+    {
+      SCM dd = me->get_property ("default-direction");
+      dir = to_dir (dd);
+      if (!dir)
+       return me->get_property ("neutral-direction");
+    }
   
   return scm_from_int (dir);
 }
 
-Direction
-Stem::get_default_dir (Grob *me)
+MAKE_SCHEME_CALLBACK(Stem, calc_default_direction, 1);
+SCM
+Stem::calc_default_direction (SCM smob)
 {
+  Grob *me = unsmob_grob (smob);
+
   Direction dir = CENTER;
   int staff_center = 0;
   Interval hp = head_positions (me);
   if (!hp.is_empty ())
     {
-      int udistance = (int) (UP *hp[UP] - staff_center);
-      int ddistance = (int) (DOWN *hp[DOWN] - staff_center);
+      int udistance = (int) (UP * hp[UP] - staff_center);
+      int ddistance = (int) (DOWN * hp[DOWN] - staff_center);
       
-      if (sign (ddistance - udistance))
-       dir = Direction (sign (ddistance - udistance));
-      else
-       dir = to_dir (me->get_property ("neutral-direction"));
+      dir = Direction (sign (ddistance - udistance));
     }
-  return dir;
+  
+  return scm_from_int (dir);
 }
 
 
-
-MAKE_SCHEME_CALLBACK (Stem, height, 2);
+MAKE_SCHEME_CALLBACK (Stem, height, 1);
 SCM
-Stem::height (SCM smob, SCM ax)
+Stem::height (SCM smob)
 {
-  Axis a = (Axis)scm_to_int (ax);
   Grob *me = unsmob_grob (smob);
-  assert (a == Y_AXIS);
 
   Direction dir = get_grob_direction (me);
   
@@ -496,11 +517,16 @@ Stem::height (SCM smob, SCM ax)
   Grob *beam = get_beam (me);
   if (beam)
     {
-      beam->get_property ("positions");
+      /* trigger set-stem-lengths. */
+      beam->get_property ("quantized-positions");
     }
 
-  /* FIXME uncached? */
-  Interval iv = me->get_stencil () ? me->get_stencil ()->extent (a) : Interval();
+  /*
+    Can't get_stencil(), since that would cache stencils too early.
+    This causes problems with beams.
+   */
+  Stencil *stencil = unsmob_stencil (print (smob));
+  Interval iv = stencil ? stencil->extent (Y_AXIS) : Interval();
   if (beam)
     {
       if (dir == CENTER)
@@ -532,7 +558,7 @@ Stem::flag (Grob *me)
     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;
+  string flag_style;
 
   SCM flag_style_scm = me->get_property ("flag-style");
   if (scm_is_symbol (flag_style_scm))
@@ -543,8 +569,8 @@ Stem::flag (Grob *me)
 
   bool adjust = true;
 
-  String staffline_offs;
-  if (String::compare (flag_style, "mensural") == 0)
+  string staffline_offs;
+  if (flag_style == "mensural")
     /* 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,
@@ -557,7 +583,7 @@ Stem::flag (Grob *me)
        {
          int p = (int) (rint (stem_end_position (me)));
          staffline_offs
-           = Staff_symbol_referencer::on_staffline (me, p) ? "0" : "1";
+           = Staff_symbol_referencer::on_line (me, p) ? "0" : "1";
        }
       else
        staffline_offs = "2";
@@ -566,7 +592,7 @@ Stem::flag (Grob *me)
     staffline_offs = "";
 
   char dir = (get_grob_direction (me) == UP) ? 'u' : 'd';
-  String font_char = flag_style
+  string font_char = flag_style
     + to_string (dir) + staffline_offs + to_string (log);
   Font_metric *fm = Font_interface::get_default_font (me);
   Stencil flag = fm->find_by_name ("flags." + font_char);
@@ -576,10 +602,10 @@ Stem::flag (Grob *me)
   SCM stroke_style_scm = me->get_property ("stroke-style");
   if (scm_is_string (stroke_style_scm))
     {
-      String stroke_style = ly_scm2string (stroke_style_scm);
-      if (!stroke_style.is_empty ())
+      string stroke_style = ly_scm2string (stroke_style_scm);
+      if (!stroke_style.empty ())
        {
-         String font_char = to_string (dir) + stroke_style;
+         string font_char = to_string (dir) + stroke_style;
          Stencil stroke = fm->find_by_name ("flags." + font_char);
          if (stroke.is_empty ())
            me->warning (_f ("flag stroke `%s' not found", font_char));
@@ -591,12 +617,10 @@ Stem::flag (Grob *me)
   return flag;
 }
 
-MAKE_SCHEME_CALLBACK (Stem, width_callback, 2);
+MAKE_SCHEME_CALLBACK (Stem, width, 1);
 SCM
-Stem::width_callback (SCM e, SCM ax)
+Stem::width (SCM e)
 {
-  (void) ax;
-  assert (scm_to_int (ax) == X_AXIS);
   Grob *me = unsmob_grob (e);
 
   Interval r;
@@ -673,13 +697,13 @@ Stem::print (SCM smob)
 
   Interval stem_y (min (y1, y2), max (y2, y1));
 
-  if (Grob *hed = support_head (me))
+  if (Grob *head = support_head (me))
     {
       /*
        must not take ledgers into account.
       */
-      Interval head_height = hed->extent (hed, Y_AXIS);
-      Real y_attach = Note_head::stem_attachment_coordinate (hed, Y_AXIS);
+      Interval head_height = head->extent (head, Y_AXIS);
+      Real y_attach = Note_head::stem_attachment_coordinate (head, Y_AXIS);
 
       y_attach = head_height.linear_combination (y_attach);
       stem_y[Direction (-d)] += d * y_attach / half_space;
@@ -688,7 +712,7 @@ Stem::print (SCM smob)
   // URG
   Real stem_width = thickness (me);
   Real blot
-    = me->get_layout ()->get_dimension (ly_symbol2scm ("blotdiameter"));
+    = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
 
   Box b = Box (Interval (-stem_width / 2, stem_width / 2),
               Interval (stem_y[DOWN] * half_space, stem_y[UP] * half_space));
@@ -709,7 +733,7 @@ Stem::get_translated_flag (Grob *me)
     {
       Direction d = get_grob_direction (me);
       Real blot
-       = me->get_layout ()->get_dimension (ly_symbol2scm ("blotdiameter"));
+       = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
       Real stem_width = thickness (me);
       Real half_space = Staff_symbol_referencer::staff_space (me) * 0.5;
       Real y2 = robust_scm2double (me->get_property ("stem-end-position"), 0.0);
@@ -723,11 +747,11 @@ Stem::get_translated_flag (Grob *me)
 /*
   move the stem to right of the notehead if it is up.
 */
-MAKE_SCHEME_CALLBACK (Stem, offset_callback, 2);
+MAKE_SCHEME_CALLBACK (Stem, offset_callback, 1);
 SCM
-Stem::offset_callback (SCM element_smob, SCM)
+Stem::offset_callback (SCM smob)
 {
-  Grob *me = unsmob_grob (element_smob);
+  Grob *me = unsmob_grob (smob);
   Real r = 0.0;
 
   if (Grob *f = first_head (me))
@@ -756,7 +780,7 @@ Stem::offset_callback (SCM element_smob, SCM)
       extract_grob_set (me, "rests", rests);
       if (rests.size ())
        {
-         Grob *rest = rests.top ();
+         Grob *rest = rests.back ();
          r = rest->extent (rest, X_AXIS).center ();
        }
     }
@@ -782,7 +806,6 @@ Stem::get_stem_info (Grob *me)
   return si;
 }
 
-/* TODO: add extra space for tremolos!  */
 MAKE_SCHEME_CALLBACK(Stem, calc_stem_info, 1);
 SCM
 Stem::calc_stem_info (SCM smob)
@@ -798,26 +821,45 @@ Stem::calc_stem_info (SCM smob)
 
   Real staff_space = Staff_symbol_referencer::staff_space (me);
   Grob *beam = get_beam (me);
+
+  if (beam)
+    {
+      (void) beam->get_property ("beaming");
+    }
+  
   Real beam_translation = Beam::get_beam_translation (beam);
   Real beam_thickness = Beam::get_thickness (beam);
   int beam_count = Beam::get_direction_beam_count (beam, my_dir);
+  Real length_fraction
+    = robust_scm2double (me->get_property ("length-fraction"), 1.0);
 
   /* Simple standard stem length */
   SCM details = me->get_property ("details");
   SCM lengths = scm_cdr (scm_assq (ly_symbol2scm ("beamed-lengths"), details));
+  
   Real ideal_length
     = scm_to_double (robust_list_ref (beam_count - 1, lengths))
-
     * staff_space
+    * length_fraction
+    
     /* stem only extends to center of beam
      */
     - 0.5 * beam_thickness;
 
   /* Condition: sane minimum free stem length (chord to beams) */
   lengths = scm_cdr (scm_assq (ly_symbol2scm ("beamed-minimum-free-lengths"), details));
+
   Real ideal_minimum_free
     = scm_to_double (robust_list_ref (beam_count - 1, lengths))
-    * staff_space;
+    * staff_space
+    * length_fraction;
+
+  Real height_of_my_trem = 0.0;
+  Grob *trem = unsmob_grob (me->get_object ("tremolo-flag"));
+  if (trem)
+      height_of_my_trem = trem->extent (trem, Y_AXIS).length ()
+        /* hack a bit of space around the trem. */
+        + beam_translation;
 
   /* UGH
      It seems that also for ideal minimum length, we must use
@@ -831,6 +873,7 @@ Stem::calc_stem_info (SCM smob)
 
   Real ideal_minimum_length = ideal_minimum_free
     + height_of_my_beams
+    + height_of_my_trem
     /* stem only extends to center of beam */
     - 0.5 * beam_thickness;
 
@@ -872,24 +915,19 @@ Stem::calc_stem_info (SCM smob)
 
   ideal_y -= robust_scm2double (beam->get_property ("shorten"), 0);
 
-  SCM bemfl = scm_cdr (scm_assq (ly_symbol2scm ("beamed-extreme-minimum-free-lengths"), details));
+  SCM bemfl = scm_cdr (scm_assq (ly_symbol2scm ("beamed-extreme-minimum-free-lengths"),
+                                details));
   
   Real minimum_free
     = scm_to_double (robust_list_ref (beam_count - 1, bemfl))
-    * staff_space;
+    * staff_space
+    * length_fraction;
 
-  Real minimum_length = minimum_free
+  Real minimum_length = max (minimum_free, height_of_my_trem)
     + height_of_my_beams
     /* stem only extends to center of beam */
     - 0.5 * beam_thickness;
 
-  if (Grob *tremolo = unsmob_grob (me->get_object ("tremolo-flag")))
-    {
-      Interval y_ext = tremolo->extent (tremolo, Y_AXIS);
-      y_ext.widen (0.5);       // FIXME. Should be tunable? 
-      minimum_length = max (minimum_length, y_ext.length ());
-    }
-
   ideal_y *= my_dir;
   Real minimum_y = note_start + minimum_length;
   Real shortest_y = minimum_y * my_dir;
@@ -930,19 +968,21 @@ ADD_INTERFACE (Stem, "stem-interface",
               "should be shortened. The list gives an amount depending on the number "
               "of flags/beams."
               "@end table\n"
-
               ,
 
               /* properties */
-              
               "avoid-note-head "
               "beam "
               "beaming "
+              "default-direction "
+              "details "
               "direction "
               "duration-log "
               "flag-style "
               "french-beaming "
               "length "
+              "length-fraction "
+              "max-beam-connect "
               "neutral-direction "
               "no-stem-extend "
               "note-heads "