]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
* scm/lily.scm (completize-formats): new function
[lilypond.git] / lily / stem.cc
index 7b547f0cda3c12036f1f3c70c0a5f0a1d36e69b3..b098b38af794f77a38fb428eb185d0c09cd7e4d4 100644 (file)
   Stem-end, chord-start, etc. is all confusing naming.
 */
 
+#include "stem.hh"
+
 #include <math.h>              // rint
 
 #include "lookup.hh"
 #include "directional-element-interface.hh"
 #include "note-head.hh"
-#include "stem.hh"
 #include "warn.hh"
 #include "output-def.hh"
 #include "rhythmic-head.hh"
 #include "font-interface.hh"
-#include "stencil.hh"
 #include "paper-column.hh"
 #include "misc.hh"
 #include "beam.hh"
 #include "rest.hh"
 #include "group-interface.hh"
 #include "staff-symbol-referencer.hh"
-#include "spanner.hh"
 #include "side-position-interface.hh"
 #include "dot-column.hh"
 #include "stem-tremolo.hh"
@@ -40,7 +39,7 @@ Stem::set_beaming (Grob *me, int beam_count, Direction d)
 {
   SCM pair = me->get_property ("beaming");
 
-  if (!ly_c_pair_p (pair))
+  if (!scm_is_pair (pair))
     {
       pair = scm_cons (SCM_EOL, SCM_EOL);
       me->set_property ("beaming", pair);
@@ -56,7 +55,7 @@ int
 Stem::get_beaming (Grob *me, Direction d)
 {
   SCM pair = me->get_property ("beaming");
-  if (!ly_c_pair_p (pair))
+  if (!scm_is_pair (pair))
     return 0;
 
   SCM lst = index_get_cell (pair, d);
@@ -91,13 +90,13 @@ Stem::stem_end_position (Grob *me)
 {
   SCM p = me->get_property ("stem-end-position");
   Real pos;
-  if (!ly_c_number_p (p))
+  if (!scm_is_number (p))
     {
       pos = get_default_stem_end_position (me);
       me->set_property ("stem-end-position", scm_make_real (pos));
     }
   else
-    pos = ly_scm2double (p);
+    pos = scm_to_double (p);
 
   return pos;
 }
@@ -135,7 +134,7 @@ Stem::support_head (Grob *me)
 {
   if (head_count (me) == 1)
     /* UGH. */
-    return unsmob_grob (ly_car (me->get_property ("note-heads")));
+    return unsmob_grob (scm_car (me->get_property ("note-heads")));
   return first_head (me);
 }
 
@@ -166,9 +165,10 @@ Stem::last_head (Grob *me)
   return 0;  
 }
 
-/* START is part where stem reaches `last' head.
+/*
+  START is part where stem reaches `last' head.
 
-This function returns a drul with (bottom-head, top-head). 
+  This function returns a drul with (bottom-head, top-head). 
 
 */
 Drul_array<Grob*>
@@ -179,13 +179,11 @@ Stem::extremal_heads (Grob *me)
   extpos[DOWN] = inf;
   extpos[UP] = -inf;
 
-  Drul_array<Grob *> exthead;
-  exthead[LEFT] = exthead[RIGHT] =0;
-
-  for (SCM s = me->get_property ("note-heads"); ly_c_pair_p (s);
-       s = ly_cdr (s))
+  Drul_array<Grob *> exthead (0, 0);
+  for (SCM s = me->get_property ("note-heads"); scm_is_pair (s);
+       s = scm_cdr (s))
     {
-      Grob *n = unsmob_grob (ly_car (s));
+      Grob *n = unsmob_grob (scm_car (s));
       int p = Staff_symbol_referencer::get_rounded_position (n);
 
       Direction d = LEFT;
@@ -202,7 +200,7 @@ Stem::extremal_heads (Grob *me)
 }
 
 static int
-icmp (int const &a, int const &b)
+integer_compare (int const &a, int const &b)
 {
   return a - b;
 }
@@ -212,16 +210,16 @@ Array<int>
 Stem::note_head_positions (Grob *me)
 {
   Array<int> ps ;
-  for (SCM s = me->get_property ("note-heads"); ly_c_pair_p (s);
-       s = ly_cdr (s))
+  for (SCM s = me->get_property ("note-heads"); scm_is_pair (s);
+       s = scm_cdr (s))
     {
-      Grob *n = unsmob_grob (ly_car (s));
+      Grob *n = unsmob_grob (scm_car (s));
       int p = Staff_symbol_referencer::get_rounded_position (n);
 
       ps.push (p);
     }
 
-  ps.sort (icmp);
+  ps.sort (integer_compare);
   return ps;
 }
 
@@ -231,16 +229,21 @@ Stem::add_head (Grob *me, Grob *n)
   n->set_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);
+  else if (Rest::has_interface (n))
+    Pointer_group_interface::add_grob (me, ly_symbol2scm ("rests"), n);
 }
 
 bool
 Stem::is_invisible (Grob *me)
 {
-  return !(head_count (me)
-          && ly_scm2int (me->get_property ("duration-log")) >= 1);
+  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);
 }
 
 Direction
@@ -271,13 +274,13 @@ Stem::get_default_stem_end_position (Grob *me)
   /* WARNING: IN HALF SPACES */
   Real length = 7;
   SCM scm_len = me->get_property ("length");
-  if (ly_c_number_p (scm_len))
-    length = ly_scm2double (scm_len);
+  if (scm_is_number (scm_len))
+    length = scm_to_double (scm_len);
   else
     {
       s = me->get_property ("lengths");
-      if (ly_c_pair_p (s))
-       length = 2 * ly_scm2double (robust_list_ref (durlog - 2, s));
+      if (scm_is_pair (s))
+       length = 2 * scm_to_double (robust_list_ref (durlog - 2, s));
     }
 
   /* URGURGURG
@@ -295,7 +298,7 @@ Stem::get_default_stem_end_position (Grob *me)
   if (dir && dir * hp[dir] >= 0)
     {
       SCM sshorten = me->get_property ("stem-shorten");
-      SCM scm_shorten = ly_c_pair_p (sshorten) ?
+      SCM scm_shorten = scm_is_pair (sshorten) ?
        robust_list_ref ((duration_log (me) - 2) >? 0, sshorten): SCM_EOL;
       Real shorten = 2* robust_scm2double (scm_shorten,0);
 
@@ -357,7 +360,7 @@ Stem::get_default_stem_end_position (Grob *me)
 
          /* 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 (dir * (st + flagy - dp) < 0.5)
            {
              Grob *par = dots->get_parent (X_AXIS);
 
@@ -380,7 +383,7 @@ int
 Stem::duration_log (Grob *me)
 {
   SCM s = me->get_property ("duration-log");
-  return (ly_c_number_p (s)) ? ly_scm2int (s) : 2;
+  return (scm_is_number (s)) ? scm_to_int (s) : 2;
 }
 
 void
@@ -401,10 +404,9 @@ Stem::position_noteheads (Grob *me)
   Real thick = thickness (me);
 
   Grob *hed = support_head (me);
-  Real w = Note_head::head_extent (hed, X_AXIS)[dir];
+  Real w = hed->extent (hed, X_AXIS)[dir];
   for (int i = 0; i < heads.size (); i++)
-    heads[i]->translate_axis (w - Note_head::head_extent (heads[i],
-                                                         X_AXIS)[dir],
+    heads[i]->translate_axis (w - heads[i]->extent (heads[i], X_AXIS)[dir],
                              X_AXIS);
 
   bool parity = true;
@@ -412,7 +414,7 @@ Stem::position_noteheads (Grob *me)
   for (int i = 1; i < heads.size (); i ++)
     {
       Real p = Staff_symbol_referencer::get_position (heads[i]);
-      Real dy =fabs (lastpos- p);
+      Real dy = fabs (lastpos- p);
 
       /*
        dy should always be 0.5, 0.0, 1.0, but provide safety margin
@@ -422,7 +424,7 @@ Stem::position_noteheads (Grob *me)
        {
          if (parity)
            {
-             Real ell = Note_head::head_extent (heads[i], X_AXIS).length ();
+             Real ell = heads[i]->extent (heads[i], X_AXIS).length ();
 
              Direction d = get_direction (me);
              /*
@@ -480,8 +482,6 @@ Stem::before_line_breaking (SCM smob)
       stem_end_position (me);  // ugh. Trigger direction calc.
       position_noteheads (me);
     }
-  else
-    me->set_property ("print-function", SCM_EOL);
   
   return SCM_UNSPECIFIED;
 }
@@ -495,14 +495,14 @@ MAKE_SCHEME_CALLBACK (Stem, height, 2);
 SCM
 Stem::height (SCM smob, SCM ax)
 {
-  Axis a = (Axis)ly_scm2int (ax);
+  Axis a = (Axis)scm_to_int (ax);
   Grob *me = unsmob_grob (smob);
   assert (a == Y_AXIS);
 
   /*
     ugh. - this dependency should be automatic.
   */
-  Grob *beam= get_beam (me);
+  Grob *beam = get_beam (me);
   if (beam)
     {
       Beam::after_line_breaking (beam->self_scm ());
@@ -513,7 +513,7 @@ Stem::height (SCM smob, SCM ax)
   Interval iv;
   if (mol != SCM_EOL)
     iv = unsmob_stencil (mol)->extent (a);
-  if (Grob *b =get_beam (me))
+  if (Grob *b = get_beam (me))
     {
       Direction d = get_direction (me);
       iv[d] += d * Beam::get_thickness (b) * 0.5 ;
@@ -532,7 +532,7 @@ Stem::flag (Grob *me)
   String flag_style;
 
   SCM flag_style_scm = me->get_property ("flag-style");
-  if (ly_c_symbol_p (flag_style_scm))
+  if (scm_is_symbol (flag_style_scm))
     flag_style = ly_symbol2string (flag_style_scm);
   
   if (flag_style == "no-flag")
@@ -570,7 +570,7 @@ 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);
-  Stencil flag = fm->find_by_name ("flags-" + font_char);
+  Stencil flag = fm->find_by_name ("flags." + font_char);
   if (flag.is_empty ())
     me->warning (_f ("flag `%s' not found", font_char));
 
@@ -581,7 +581,7 @@ Stem::flag (Grob *me)
       if (!stroke_style.is_empty ())
        {
          String font_char = to_string (dir) + stroke_style;
-         Stencil stroke = fm->find_by_name ("flags-" + font_char);
+         Stencil stroke = fm->find_by_name ("flags." + font_char);
          if (stroke.is_empty ())
            me->warning (_f ("flag stroke `%s' not found", font_char));
          else
@@ -592,11 +592,11 @@ Stem::flag (Grob *me)
   return flag;
 }
 
-MAKE_SCHEME_CALLBACK (Stem,dim_callback,2);
+MAKE_SCHEME_CALLBACK (Stem,width_callback,2);
 SCM
-Stem::dim_callback (SCM e, SCM ax)
+Stem::width_callback (SCM e, SCM ax)
 {
-  Axis a = (Axis) ly_scm2int (ax);
+  Axis a = (Axis) scm_to_int (ax);
   assert (a == X_AXIS);
   Grob *me = unsmob_grob (e);
 
@@ -622,7 +622,7 @@ Stem::dim_callback (SCM e, SCM ax)
 Real
 Stem::thickness (Grob *me)
 {
-  return ly_scm2double (me->get_property ("thickness"))
+  return scm_to_double (me->get_property ("thickness"))
     * Staff_symbol_referencer::line_thickness (me);
 }
 
@@ -634,45 +634,68 @@ Stem::print (SCM smob)
   Stencil mol;
   Direction d = get_direction (me);
 
+  Real stemlet_length = robust_scm2double (me->get_property ("stemlet-length"),
+                                          0.0);
+  bool stemlet = stemlet_length > 0.0;
+  
   /* TODO: make the stem start a direction ?
      This is required to avoid stems passing in tablature chords.  */
-  Grob *lh = to_boolean (me->get_property ("avoid-note-head"))
-    ? last_head (me) :  lh = first_head (me);
+  Grob *lh =
+    to_boolean (me->get_property ("avoid-note-head"))
+    ? last_head (me)
+    : lh = first_head (me);
+  Grob *beam = get_beam (me);
 
-  if (!lh)
+  if (!lh && !stemlet)
     return SCM_EOL;
 
+  if (stemlet && !beam)
+    return SCM_EOL;
+    
   if (is_invisible (me))
     return SCM_EOL;
 
-  Real y1 = Staff_symbol_referencer::get_position (lh);
   Real y2 = stem_end_position (me);
+  Real y1 = y2;
+  Real half_space = Staff_symbol_referencer::staff_space (me) * 0.5;
 
-  Interval stem_y (y1 <? y2,y2 >? y1);
 
-  // dy?
-  Real dy = Staff_symbol_referencer::staff_space (me) * 0.5;
+  if (lh)
+    y2 = Staff_symbol_referencer::get_position (lh);
+  else if (stemlet)
+    {
+      Real beam_translation = Beam::get_beam_translation (beam);
+      Real beam_thickness = Beam::get_thickness (beam);
+      int beam_count = beam_multiplicity (me).length () + 1;
+
+      y2 -= d
+       * (0.5 * beam_thickness
+          + beam_translation * (0 >? (beam_count - 1))
+          + stemlet_length) / half_space;
+    }
+
+  Interval stem_y (y1 <? y2,y2 >? y1);
 
   if (Grob *hed = support_head (me))
     {
       /*
        must not take ledgers into account.
        */
-      Interval head_height = Note_head::head_extent (hed,Y_AXIS);
+      Interval head_height = hed->extent (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;
+      stem_y[Direction (-d)] += d * y_attach/half_space;
     }
 
 
   // URG
   Real stem_width = thickness (me);
   Real blot =
-       me->get_paper ()->get_dimension (ly_symbol2scm ("blotdiameter"));
+       me->get_layout ()->get_dimension (ly_symbol2scm ("blotdiameter"));
 
   Box b = Box (Interval (-stem_width/2, stem_width/2),
-              Interval (stem_y[DOWN]*dy, stem_y[UP]*dy));
+              Interval (stem_y[DOWN]*half_space, stem_y[UP]*half_space));
 
   Stencil ss = Lookup::round_filled_box (b, blot);
   mol.add_stencil (ss);
@@ -680,7 +703,7 @@ Stem::print (SCM smob)
   if (!get_beam (me) && abs (duration_log (me)) > 2)
     {
       Stencil fl = flag (me);
-      fl.translate_axis (stem_y[d]*dy - d * blot/2, Y_AXIS);
+      fl.translate_axis (stem_y[d]*half_space - d * blot/2, Y_AXIS);
       fl.translate_axis (stem_width/2, X_AXIS);
       mol.add_stencil (fl);
     }
@@ -691,35 +714,43 @@ Stem::print (SCM smob)
 /*
   move the stem to right of the notehead if it is up.
  */
-MAKE_SCHEME_CALLBACK (Stem, off_callback, 2);
+MAKE_SCHEME_CALLBACK (Stem, offset_callback, 2);
 SCM
-Stem::off_callback (SCM element_smob, SCM)
+Stem::offset_callback (SCM element_smob, SCM)
 {
   Grob *me = unsmob_grob (element_smob);
   Real r = 0.0;
   
-  if (head_count (me))
-    if (Grob *f = first_head (me))
-      {
-       Interval head_wid = Note_head::head_extent (f, X_AXIS);
-       Real attach = 0.0;
+  if (Grob *f = first_head (me))
+    {
+      Interval head_wid = f->extent (f, X_AXIS);
+      Real attach = 0.0;
        
-       if (is_invisible (me))
-         attach = 0.0;
-       else
+      if (is_invisible (me))
+       attach = 0.0;
+      else
        attach = Note_head::stem_attachment_coordinate (f, X_AXIS);
        
-       Direction d = get_direction (me);
-       Real real_attach = head_wid.linear_combination (d * attach);
-       r = real_attach;
+      Direction d = get_direction (me);
+      Real real_attach = head_wid.linear_combination (d * attach);
+      r = real_attach;
        
-       /* If not centered: correct for stem thickness.  */
-       if (attach)
-         {
-           Real rule_thick = thickness (me);
-           r += - d * rule_thick * 0.5;
-         }
-      }
+      /* If not centered: correct for stem thickness.  */
+      if (attach)
+       {
+         Real rule_thick = thickness (me);
+         r += - d * rule_thick * 0.5;
+       }
+    }
+  else
+    {
+      SCM rests = me->get_property ("rests");
+      if (scm_is_pair (rests))
+       {
+         Grob * rest = unsmob_grob (scm_car (rests));
+         r = rest->extent (rest, X_AXIS).center ();
+       }
+    }
   return scm_make_real (r);
 }
 
@@ -735,7 +766,7 @@ Stem::get_stem_info (Grob *me)
 {
   /* Return cached info if available */
   SCM scm_info = me->get_property ("stem-info");
-  if (!ly_c_pair_p (scm_info))
+  if (!scm_is_pair (scm_info))
     {
       calc_stem_info (me);
       scm_info = me->get_property ("stem-info");
@@ -743,8 +774,8 @@ Stem::get_stem_info (Grob *me)
 
   Stem_info si;
   si.dir_ = get_grob_direction (me);
-  si.ideal_y_ = ly_scm2double (ly_car (scm_info));
-  si.shortest_y_ = ly_scm2double (ly_cadr (scm_info));
+  si.ideal_y_ = scm_to_double (scm_car (scm_info));
+  si.shortest_y_ = scm_to_double (scm_cadr (scm_info));
   return si;
 }
 
@@ -771,7 +802,7 @@ Stem::calc_stem_info (Grob *me)
   /* Simple standard stem length */
   SCM lengths = me->get_property ("beamed-lengths");
   Real ideal_length =
-    ly_scm2double (robust_list_ref (beam_count - 1,lengths))
+    scm_to_double (robust_list_ref (beam_count - 1,lengths))
                
     * staff_space
     /* stem only extends to center of beam
@@ -782,7 +813,7 @@ Stem::calc_stem_info (Grob *me)
   /* Condition: sane minimum free stem length (chord to beams) */
   lengths = me->get_property ("beamed-minimum-free-lengths");
   Real ideal_minimum_free =
-    ly_scm2double (robust_list_ref (beam_count - 1, lengths))
+    scm_to_double (robust_list_ref (beam_count - 1, lengths))
     * staff_space;
 
 
@@ -842,7 +873,7 @@ Stem::calc_stem_info (Grob *me)
   ideal_y -= robust_scm2double (beam->get_property ("shorten"), 0);
 
   Real minimum_free =
-    ly_scm2double (robust_list_ref
+    scm_to_double (robust_list_ref
                   (beam_count - 1,
                    me->get_property
                    ("beamed-extreme-minimum-free-lengths")))
@@ -865,9 +896,9 @@ Stem::calc_stem_info (Grob *me)
 Slice
 Stem::beam_multiplicity (Grob *stem)
 {
-  SCM beaming= stem->get_property ("beaming");
-  Slice le = int_list_to_slice (ly_car (beaming));
-  Slice ri = int_list_to_slice (ly_cdr (beaming));
+  SCM beaming = stem->get_property ("beaming");
+  Slice le = int_list_to_slice (scm_car (beaming));
+  Slice ri = int_list_to_slice (scm_cdr (beaming));
   le.unite (ri);
   return le;
 }
@@ -881,6 +912,7 @@ ADD_INTERFACE (Stem, "stem-interface",
               "Rests and whole notes have invisible stems.",
               "tremolo-flag french-beaming "
               "avoid-note-head thickness "
+              "stemlet-length rests "
               "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 "