]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
Merge branch 'master' of git+ssh://jneem@git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / lily / stem.cc
index d5555a1e72633629f7e09a6a81f67da9e4602433..09786b750b5d205d4b7f834b6c6fa69fe507453b 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 1996--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
 
   TODO: This is way too hairy
 */
 
 #include "stem.hh"
+#include "spanner.hh"
 
 #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 +49,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);
 }
 
@@ -60,7 +66,9 @@ Stem::get_beaming (Grob *me, Direction d)
     return 0;
 
   SCM lst = index_get_cell (pair, d);
-  return scm_ilength (lst);
+
+  int len = scm_ilength (lst);
+  return max (len, 0);
 }
 
 Interval
@@ -146,7 +154,7 @@ Stem::last_head (Grob *me)
 Drul_array<Grob *>
 Stem::extremal_heads (Grob *me)
 {
-  const int inf = 1000000;
+  const int inf = INT_MAX;
   Drul_array<int> extpos;
   extpos[DOWN] = inf;
   extpos[UP] = -inf;
@@ -154,7 +162,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);
@@ -173,28 +181,22 @@ Stem::extremal_heads (Grob *me)
   return exthead;
 }
 
-static int
-integer_compare (int const &a, int const &b)
-{
-  return a - 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, less<int> ());
   return ps;
 }
 
@@ -212,12 +214,50 @@ Stem::add_head (Grob *me, Grob *n)
 bool
 Stem::is_invisible (Grob *me)
 {
-  Real stemlet_length = robust_scm2double (me->get_property ("stemlet-length"),
-                                          0.0);
+  return !is_normal_stem (me)
+    && (robust_scm2double (me->get_property ("stemlet-length"),
+                          0.0) == 0.0);
+}
+
+
+bool
+Stem::is_normal_stem (Grob *me)
+{
+  return head_count (me) && scm_to_int (me->get_property ("duration-log")) >= 1;
+}
+
+
+MAKE_SCHEME_CALLBACK (Stem, pure_height, 3)
+SCM
+Stem::pure_height (SCM smob, SCM start, SCM end)
+{
+  (void) start;
+  (void) end;
+
+  Grob *me = unsmob_grob (smob);
+  Interval iv;
+
+  if (!is_normal_stem (me))
+    return ly_interval2scm (iv);
+
+  /* if we are part of a cross-staff beam, return empty */
+  if (get_beam (me) && Beam::is_cross_staff (get_beam (me)))
+    return ly_interval2scm (iv);
+  
+  Real ss = Staff_symbol_referencer::staff_space (me);
+  Real len = scm_to_double (calc_length (smob)) * ss / 2;
+  Direction dir = get_grob_direction (me);
+
+  Interval hp = head_positions (me);
+  if (dir == UP)
+    iv = Interval (0, len);
+  else
+    iv = Interval (-len, 0);
 
-  return !((head_count (me)
-           || stemlet_length > 0.0)
-          && scm_to_int (me->get_property ("duration-log")) >= 1);
+  if (!hp.is_empty ())
+    iv.translate (hp[dir] * ss / 2);
+
+  return ly_interval2scm (iv);
 }
 
 MAKE_SCHEME_CALLBACK (Stem, calc_stem_end_position, 1)
@@ -229,10 +269,15 @@ Stem::calc_stem_end_position (SCM smob)
   if (!head_count (me))
     return scm_from_double (0.0);
 
+  if (Grob *beam = get_beam (me))
+    {
+      (void) beam->get_property ("quantized-positions");
+      return me->get_property ("stem-end-position");
+    }
   
   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);
@@ -260,11 +305,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 * (stem_end + flagy - dp) < 0.5)
+         
+         if (flag_yext.distance (dp) < 0.5)
            {
              Grob *par = dots->get_parent (X_AXIS);
 
@@ -283,7 +329,7 @@ Stem::calc_stem_end_position (SCM smob)
   return scm_from_double (stem_end);
 }
 
-
+/* Length is in half-spaces (or: positions) here. */
 MAKE_SCHEME_CALLBACK (Stem, calc_length, 1)
 SCM
 Stem::calc_length (SCM smob)
@@ -330,20 +376,23 @@ 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 ()
-       / ss;
+       + 2 * Stem_tremolo::vertical_length (t_flag) / 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);
     }
   
@@ -365,13 +414,15 @@ Stem::calc_positioning_done (SCM smob)
   if (!head_count (me))
     return SCM_BOOL_T;
 
+  me->set_property ("positioning-done", 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, position_less);
   Direction dir = get_grob_direction (me);
 
   if (dir < 0)
-    heads.reverse ();
+    reverse (heads);
 
   Real thick = thickness (me);
 
@@ -382,15 +433,28 @@ Stem::calc_positioning_done (SCM smob)
       dir = UP;
       set_grob_direction (me, dir);
     }
-  
+
+  bool is_harmonic_centered = false;
+  for (vsize i = 0; i < heads.size (); i++)
+    is_harmonic_centered = is_harmonic_centered 
+      || heads[i]->get_property ("style") == ly_symbol2scm ("harmonic");
+  is_harmonic_centered = is_harmonic_centered && is_invisible (me);
+
   Real w = hed->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);
+  for (vsize i = 0; i < heads.size (); i++)
+    {
+      Real amount = w - heads[i]->extent (heads[i], X_AXIS)[dir];
 
+      if (is_harmonic_centered)
+       amount =
+         hed->extent (hed, X_AXIS).linear_combination (CENTER)
+         - heads[i]->extent (heads[i], X_AXIS).linear_combination (CENTER);
+      
+      heads[i]->translate_axis (amount, 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);
@@ -497,17 +561,16 @@ SCM
 Stem::height (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-
+  if (!is_normal_stem (me))
+    return ly_interval2scm (Interval ());
+  
   Direction dir = get_grob_direction (me);
   
-  /* Trigger callback.
-
-  UGH. Should be automatic
-  */
   Grob *beam = get_beam (me);
   if (beam)
     {
-      beam->get_property ("positions");
+      /* trigger set-stem-lengths. */
+      beam->get_property ("quantized-positions");
     }
 
   /*
@@ -547,7 +610,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))
@@ -558,8 +621,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,
@@ -572,7 +635,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";
@@ -581,7 +644,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);
@@ -591,10 +654,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));
@@ -642,6 +705,8 @@ SCM
 Stem::print (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
+  Grob *beam = get_beam (me);
+    
   Stencil mol;
   Direction d = get_grob_direction (me);
 
@@ -655,7 +720,6 @@ Stem::print (SCM smob)
     = to_boolean (me->get_property ("avoid-note-head"))
     ? last_head (me)
     : first_head (me);
-  Grob *beam = get_beam (me);
 
   if (!lh && !stemlet)
     return SCM_EOL;
@@ -701,7 +765,7 @@ Stem::print (SCM smob)
   // URG
   Real stem_width = thickness (me);
   Real blot
-    = me->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));
@@ -722,7 +786,7 @@ Stem::get_translated_flag (Grob *me)
     {
       Direction d = get_grob_direction (me);
       Real blot
-       = me->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);
@@ -741,8 +805,16 @@ SCM
 Stem::offset_callback (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-  Real r = 0.0;
 
+  extract_grob_set (me, "rests", rests);
+  if (rests.size ())
+    {
+      Grob *rest = rests.back ();
+      Real r = rest->extent (rest, X_AXIS).center ();
+      return scm_from_double (r);
+    }
+
+  
   if (Grob *f = first_head (me))
     {
       Interval head_wid = f->extent (f, X_AXIS);
@@ -755,7 +827,7 @@ Stem::offset_callback (SCM smob)
 
       Direction d = get_grob_direction (me);
       Real real_attach = head_wid.linear_combination (d * attach);
-      r = real_attach;
+      Real r = real_attach;
 
       /* If not centered: correct for stem thickness.  */
       if (attach)
@@ -763,17 +835,11 @@ Stem::offset_callback (SCM smob)
          Real rule_thick = thickness (me);
          r += -d * rule_thick * 0.5;
        }
+      return scm_from_double (r);
     }
-  else
-    {
-      extract_grob_set (me, "rests", rests);
-      if (rests.size ())
-       {
-         Grob *rest = rests.top ();
-         r = rest->extent (rest, X_AXIS).center ();
-       }
-    }
-  return scm_from_double (r);
+
+  programming_error ("Weird stem.");
+  return scm_from_double (0.0);
 }
 
 Spanner *
@@ -795,7 +861,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)
@@ -844,6 +909,17 @@ Stem::calc_stem_info (SCM smob)
     * 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
+       = Stem_tremolo::vertical_length (trem)
+        /* hack a bit of space around the trem. */
+        + beam_translation;
+    }
+
+  
   /* UGH
      It seems that also for ideal minimum length, we must use
      the maximum beam count (for this direction):
@@ -856,6 +932,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;
 
@@ -905,18 +982,11 @@ Stem::calc_stem_info (SCM smob)
     * 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;
@@ -935,8 +1005,22 @@ Stem::beam_multiplicity (Grob *stem)
   return le;
 }
 
+bool
+Stem::is_cross_staff (Grob *stem)
+{
+  Grob *beam = unsmob_grob (stem->get_object ("beam"));
+  return beam && Beam::is_cross_staff (beam);
+}
+
+MAKE_SCHEME_CALLBACK (Stem, cross_staff, 1)
+SCM
+Stem::cross_staff (SCM smob)
+{
+  return scm_from_bool (is_cross_staff (unsmob_grob (smob)));
+}
+
 /* FIXME:  Too many properties  */
-ADD_INTERFACE (Stem, "stem-interface",
+ADD_INTERFACE (Stem,
               "The stem represent the graphical stem.  "
               "In addition, it internally connects note heads, beams and"
               "tremolos. "
@@ -971,6 +1055,7 @@ ADD_INTERFACE (Stem, "stem-interface",
               "french-beaming "
               "length "
               "length-fraction "
+              "max-beam-connect "
               "neutral-direction "
               "no-stem-extend "
               "note-heads "