]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
Run `make grand-replace'.
[lilypond.git] / lily / stem.cc
index 6757582869960d15ecd600493113f6af459a225c..1f8b21e85f51fec72fa86c818b24417dcde43298 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--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
 
   TODO: This is way too hairy
@@ -214,12 +214,9 @@ 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 !((head_count (me)
-           || stemlet_length > 0.0)
-          && scm_to_int (me->get_property ("duration-log")) >= 1);
+  return !is_normal_stem (me)
+    && (robust_scm2double (me->get_property ("stemlet-length"),
+                          0.0) == 0.0);
 }
 
 
@@ -236,22 +233,38 @@ 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);
+
   Real ss = Staff_symbol_referencer::staff_space (me);
-  Real len = scm_to_double (calc_length (smob)) * ss / 2;
-  Direction dir = get_grob_direction (me);
+  Real rad = Staff_symbol_referencer::staff_radius (me);
 
-  Interval iv;
-  Interval hp = head_positions (me);
-  if (dir == UP)
-    iv = Interval (0, len);
-  else
-    iv = Interval (-len, 0);
+  if (!to_boolean (me->get_property ("cross-staff")))
+    {
+      Real len = scm_to_double (calc_length (smob)) * ss / 2;
+      Direction dir = get_grob_direction (me);
 
-  if (!hp.is_empty ())
-    iv.translate (hp[dir] * ss / 2);
+      Interval hp = head_positions (me);
+      if (dir == UP)
+       iv = Interval (0, len);
+      else
+       iv = Interval (-len, 0);
+
+      if (!hp.is_empty ())
+       iv.translate (hp[dir] * ss / 2);
+
+      /* extend the stem (away from the head) to cover the staff */
+      if (dir == UP)
+       iv[UP] = max (iv[UP], rad * ss);
+      else
+       iv[DOWN] = min (iv[DOWN], -rad * ss);
+    }
+  else
+    iv = Interval (-rad * ss, rad * ss);
 
   return ly_interval2scm (iv);
 }
@@ -271,8 +284,6 @@ Stem::calc_stem_end_position (SCM smob)
       return me->get_property ("stem-end-position");
     }
   
-  Real ss = Staff_symbol_referencer::staff_space (me);
-  int durlog = duration_log (me);
   vector<Real> a;
 
   /* WARNING: IN HALF SPACES */
@@ -283,45 +294,10 @@ Stem::calc_stem_end_position (SCM smob)
   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 * stem_end < 0)
+  bool no_extend = to_boolean (me->get_property ("no-stem-extend"));
+  if (!no_extend && 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.  */
-  if (!get_beam (me) && dir == UP
-      && durlog > 2)
-    {
-      Grob *closest_to_flag = extremal_heads (me)[dir];
-      Grob *dots = closest_to_flag
-       ? Rhythmic_head::get_dots (closest_to_flag) : 0;
-
-      if (dots)
-       {
-         Real dp = Staff_symbol_referencer::get_position (dots);
-         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 (flag_yext.distance (dp) < 0.5)
-           {
-             Grob *par = dots->get_parent (X_AXIS);
-
-             if (Dot_column::has_interface (par))
-               {
-                 Side_position_interface::add_support (par, me);
-
-                 /* TODO: apply some better logic here. The flag is
-                    curved inwards, so this will typically be too
-                    much. */
-               }
-           }
-       }
-    }
-
   return scm_from_double (stem_end);
 }
 
@@ -337,7 +313,7 @@ Stem::calc_length (SCM smob)
 
   Real ss = Staff_symbol_referencer::staff_space (me);
   Real length = 7;
-  SCM s = scm_cdr (scm_assq (ly_symbol2scm ("lengths"), details));
+  SCM s = ly_assoc_get (ly_symbol2scm ("lengths"), details, SCM_EOL);
   if (scm_is_pair (s))
     length = 2 * scm_to_double (robust_list_ref (durlog - 2, s));
 
@@ -348,7 +324,7 @@ Stem::calc_length (SCM smob)
   Interval hp = head_positions (me);
   if (dir && dir * hp[dir] >= 0)
     {
-      SCM sshorten = scm_cdr (scm_assq (ly_symbol2scm ("stem-shorten"), details));
+      SCM sshorten = ly_assoc_get (ly_symbol2scm ("stem-shorten"), details, SCM_EOL);
       SCM scm_shorten = scm_is_pair (sshorten)
        ? robust_list_ref (max (duration_log (me) - 2, 0), sshorten) : SCM_EOL;
       Real shorten = 2* robust_scm2double (scm_shorten, 0);
@@ -402,7 +378,7 @@ Stem::duration_log (Grob *me)
   return (scm_is_number (s)) ? scm_to_int (s) : 2;
 }
 
-MAKE_SCHEME_CALLBACK(Stem, calc_positioning_done, 1);
+MAKE_SCHEME_CALLBACK (Stem, calc_positioning_done, 1);
 SCM
 Stem::calc_positioning_done (SCM smob)
 {
@@ -410,6 +386,8 @@ 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);
   vector<Grob*> heads (ro_heads);
   vector_sort (heads, position_less);
@@ -506,7 +484,7 @@ Stem::calc_positioning_done (SCM smob)
   return SCM_BOOL_T;
 }
 
-MAKE_SCHEME_CALLBACK(Stem, calc_direction, 1);
+MAKE_SCHEME_CALLBACK (Stem, calc_direction, 1);
 SCM
 Stem::calc_direction (SCM smob)
 {
@@ -529,7 +507,7 @@ Stem::calc_direction (SCM smob)
   return scm_from_int (dir);
 }
 
-MAKE_SCHEME_CALLBACK(Stem, calc_default_direction, 1);
+MAKE_SCHEME_CALLBACK (Stem, calc_default_direction, 1);
 SCM
 Stem::calc_default_direction (SCM smob)
 {
@@ -555,13 +533,11 @@ 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)
     {
@@ -570,11 +546,11 @@ Stem::height (SCM smob)
     }
 
   /*
-    Can't get_stencil(), since that would cache stencils too early.
+    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();
+  Interval iv = stencil ? stencil->extent (Y_AXIS) : Interval ();
   if (beam)
     {
       if (dir == CENTER)
@@ -594,26 +570,25 @@ Stem::stem_end_position (Grob *me)
   return robust_scm2double (me->get_property ("stem-end-position"), 0);
 }
 
-Stencil
-Stem::flag (Grob *me)
+MAKE_SCHEME_CALLBACK (Stem, calc_flag, 1);
+SCM
+Stem::calc_flag (SCM smob)
 {
-  int log = duration_log (me);
-  if (log < 3
-      || unsmob_grob (me->get_object ("beam")))
-    return Stencil ();
+  Grob *me = unsmob_grob (smob);
 
+  int log = duration_log (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;
 
-  SCM flag_style_scm = me->get_property ("flag-style");
+   SCM flag_style_scm = me->get_property ("flag-style");
   if (scm_is_symbol (flag_style_scm))
     flag_style = ly_symbol2string (flag_style_scm);
 
   if (flag_style == "no-flag")
-    return Stencil ();
+    return Stencil ().smobbed_copy ();
 
   bool adjust = true;
 
@@ -628,14 +603,14 @@ Stem::flag (Grob *me)
     */
     {
       if (adjust)
-       {
-         int p = (int) (rint (stem_end_position (me)));
-         staffline_offs
-           = Staff_symbol_referencer::on_line (me, p) ? "0" : "1";
-       }
+        {
+          int p = (int) (rint (stem_end_position (me)));
+          staffline_offs
+            = Staff_symbol_referencer::on_line (me, p) ? "0" : "1";
+        }
       else
-       staffline_offs = "2";
-    }
+        staffline_offs = "2";
+     }
   else
     staffline_offs = "";
 
@@ -652,17 +627,45 @@ Stem::flag (Grob *me)
     {
       string stroke_style = ly_scm2string (stroke_style_scm);
       if (!stroke_style.empty ())
-       {
-         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));
-         else
-           flag.add_stencil (stroke);
-       }
-    }
+        {
+          string font_char = flag_style + to_string (dir) + stroke_style;
+          Stencil stroke = fm->find_by_name ("flags." + font_char);
+          if (stroke.is_empty ())
+            {
+              font_char = to_string (dir) + stroke_style;
+              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_stencil (stroke);
+        }
+     }
+
+  return flag.smobbed_copy ();
+}
 
-  return flag;
+
+Stencil
+Stem::flag (Grob *me)
+{
+  int log = duration_log (me);
+  if (log < 3
+      || unsmob_grob (me->get_object ("beam")))
+    return Stencil ();
+
+  if (!is_normal_stem (me))
+    return Stencil ();
+
+  // This get_property call already evaluates the scheme function with
+  // the grob passed as argument! Thus, we only have to check if a valid
+  // stencil is returned.
+  SCM flag_style_scm = me->get_property ("flag");
+  if (Stencil *flag = unsmob_stencil (flag_style_scm)) {
+    return *flag;
+  } else {
+    return Stencil ();
+  }
 }
 
 MAKE_SCHEME_CALLBACK (Stem, width, 1);
@@ -723,6 +726,9 @@ Stem::print (SCM smob)
   if (!lh && stemlet && !beam)
     return SCM_EOL;
 
+  if (lh && robust_scm2int (lh->get_property ("duration-log"), 0) < 1) 
+    return SCM_EOL;
+
   if (is_invisible (me))
     return SCM_EOL;
 
@@ -801,8 +807,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);
@@ -815,7 +829,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)
@@ -823,17 +837,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.back ();
-         r = rest->extent (rest, X_AXIS).center ();
-       }
-    }
-  return scm_from_double (r);
+
+  programming_error ("Weird stem.");
+  return scm_from_double (0.0);
 }
 
 Spanner *
@@ -855,7 +863,7 @@ Stem::get_stem_info (Grob *me)
   return si;
 }
 
-MAKE_SCHEME_CALLBACK(Stem, calc_stem_info, 1);
+MAKE_SCHEME_CALLBACK (Stem, calc_stem_info, 1);
 SCM
 Stem::calc_stem_info (SCM smob)
 {
@@ -884,7 +892,7 @@ Stem::calc_stem_info (SCM smob)
 
   /* Simple standard stem length */
   SCM details = me->get_property ("details");
-  SCM lengths = scm_cdr (scm_assq (ly_symbol2scm ("beamed-lengths"), details));
+  SCM lengths = ly_assoc_get (ly_symbol2scm ("beamed-lengths"), details, SCM_EOL);
   
   Real ideal_length
     = scm_to_double (robust_list_ref (beam_count - 1, lengths))
@@ -896,7 +904,7 @@ Stem::calc_stem_info (SCM smob)
     - 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));
+  lengths = ly_assoc_get (ly_symbol2scm ("beamed-minimum-free-lengths"), details, SCM_EOL);
 
   Real ideal_minimum_free
     = scm_to_double (robust_list_ref (beam_count - 1, lengths))
@@ -906,10 +914,14 @@ Stem::calc_stem_info (SCM smob)
   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 ()
+    {
+      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):
@@ -950,9 +962,9 @@ Stem::calc_stem_info (SCM smob)
   Obviously not for grace beams.
 
   Also, not for knees.  Seems to be a good thing. */
-  bool no_extend_b = to_boolean (me->get_property ("no-stem-extend"));
+  bool no_extend = to_boolean (me->get_property ("no-stem-extend"));
   bool is_knee = to_boolean (beam->get_property ("knee"));
-  if (!no_extend_b && !is_knee)
+  if (!no_extend && !is_knee)
     {
       /* Highest beam of (UP) beam must never be lower than middle
         staffline */
@@ -964,8 +976,8 @@ 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 = ly_assoc_get (ly_symbol2scm ("beamed-extreme-minimum-free-lengths"),
+                           details, SCM_EOL);
   
   Real minimum_free
     = scm_to_double (robust_list_ref (beam_count - 1, bemfl))
@@ -995,29 +1007,46 @@ 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, calc_cross_staff, 1)
+SCM
+Stem::calc_cross_staff (SCM smob)
+{
+  return scm_from_bool (is_cross_staff (unsmob_grob (smob)));
+}
+
 /* FIXME:  Too many properties  */
 ADD_INTERFACE (Stem,
-              "The stem represent the graphical stem.  "
-              "In addition, it internally connects note heads, beams and"
-              "tremolos. "
-              "Rests and whole notes have invisible stems."
-
-              "\n\nThe following properties may be set in the details list." 
+              "The stem represents the graphical stem.  In addition, it"
+              " internally connects note heads, beams, and tremolos.  Rests"
+              " and whole notes have invisible stems.\n"
+              "\n"
+              "The following properties may be set in the @code{details}"
+              " list.\n"
+              "\n"
               "@table @code\n"
-              "@item  beamed-lengths \n"
-              "list of stem lengths given beam multiplicity. \n"
-              "@item beamed-minimum-free-lengths \n"
-              "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.\n"
+              "@item beamed-lengths\n"
+              "List of stem lengths given beam multiplicity.\n"
+              "@item beamed-minimum-free-lengths\n"
+              "List of normal minimum free stem lengths (chord to beams)"
+              " given beam multiplicity.\n"
               "@item beamed-extreme-minimum-free-lengths\n"
-              "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.\n"
+              "List of extreme minimum free stem lengths (chord to beams)"
+              " given beam multiplicity.\n"
               "@item lengths\n"
-              "Default stem lengths. The list gives a length for each flag-count.\n"
+              "Default stem lengths.  The list gives a length for each"
+              " flag count.\n"
               "@item stem-shorten\n"
-              "How much a stem in a forced direction "
-              "should be shortened. The list gives an amount depending on the number "
-              "of flags/beams."
-              "@end table\n"
-              ,
+              "How much a stem in a forced direction should be shortened."
+              "  The list gives an amount depending on the number of flags"
+              " and beams.\n"
+              "@end table\n",
 
               /* properties */
               "avoid-note-head "
@@ -1027,6 +1056,7 @@ ADD_INTERFACE (Stem,
               "details "
               "direction "
               "duration-log "
+              "flag "
               "flag-style "
               "french-beaming "
               "length "