]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
* lily/lexer.ll: change is_string -> ly_c_string_p
[lilypond.git] / lily / stem.cc
index a6203acec92cfc98f507cdc39e1ad06dc23bb464..27711414ddd86f31bf8efe964a87a0a5210513eb 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"
 void
 Stem::set_beaming (Grob*me, int beam_count,  Direction d)
 {
-  SCM pair = me->get_grob_property ("beaming");
+  SCM pair = me->get_property ("beaming");
   
-  if (!gh_pair_p (pair))
+  if (!ly_c_pair_p (pair))
     {
-      pair = gh_cons (SCM_EOL, SCM_EOL);
-      me->set_grob_property ("beaming", pair);
+      pair = scm_cons (SCM_EOL, SCM_EOL);
+      me->set_property ("beaming", pair);
     }
 
   SCM l = index_get_cell (pair, d);
-  forint i = 0; i<  beam_count; i++)
+  for (int i = 0; i<  beam_count; i++)
     {
-      l = gh_cons (gh_int2scm (i), l);
+      l = scm_cons (scm_int2num (i), l);
     }
   index_set_cell (pair, d, l);         
 }
@@ -81,15 +81,15 @@ Stem::chord_start_y (Grob*me)
 Real
 Stem::stem_end_position (Grob*me) 
 {
-  SCM p =me->get_grob_property ("stem-end-position");
+  SCM p =me->get_property ("stem-end-position");
   Real pos;
-  if (!gh_number_p (p))
+  if (!is_number (p))
     {
       pos = get_default_stem_end_position (me);
-      me->set_grob_property ("stem-end-position", gh_double2scm (pos));
+      me->set_property ("stem-end-position", scm_make_real (pos));
     }
   else
-    pos = gh_scm2double (p);
+    pos = ly_scm2double (p);
 
   return pos;
 }
@@ -118,7 +118,7 @@ Stem::set_stemend (Grob*me, Real se)
   if (d && d * head_positions (me)[get_direction (me)] >= se*d)
     me->warning (_ ("Weird stem size; check for narrow beams"));
 
-  me->set_grob_property ("stem-end-position", gh_double2scm (se));
+  me->set_property ("stem-end-position", scm_make_real (se));
 }
 
 
@@ -136,7 +136,7 @@ Stem::support_head (Grob*me)
        UGH.
        */
       
-      return unsmob_grob (ly_car (me->get_grob_property ("note-heads")));
+      return unsmob_grob (ly_car (me->get_property ("note-heads")));
     }
   else
     return first_head (me);
@@ -189,12 +189,12 @@ Stem::extremal_heads (Grob*me)
   Drul_array<Grob *> exthead;
   exthead[LEFT] = exthead[RIGHT] =0;
   
-  for (SCM s = me->get_grob_property ("note-heads"); gh_pair_p (s); s = ly_cdr (s))
+  for (SCM s = me->get_property ("note-heads"); ly_c_pair_p (s); s = ly_cdr (s))
     {
       Grob * n = unsmob_grob (ly_car (s));
 
       
-      int p = int (Staff_symbol_referencer::get_position (n));
+      int p = Staff_symbol_referencer::get_rounded_position (n);
 
       Direction d = LEFT;
       do {
@@ -215,14 +215,17 @@ icmp (int const &a, int const &b)
   return a-b;
 }
 
+/*
+  The positions, in ascending order.
+ */
 Array<int>
 Stem::note_head_positions (Grob *me)
 {
   Array<int> ps ;
-  for (SCM s = me->get_grob_property ("note-heads"); gh_pair_p (s); s = ly_cdr (s))
+  for (SCM s = me->get_property ("note-heads"); ly_c_pair_p (s); s = ly_cdr (s))
     {
       Grob * n = unsmob_grob (ly_car (s));
-      int p = int (Staff_symbol_referencer::get_position (n));
+      int p = Staff_symbol_referencer::get_rounded_position (n);
 
       ps.push (p);
     }
@@ -235,7 +238,7 @@ Stem::note_head_positions (Grob *me)
 void
 Stem::add_head (Grob*me, Grob *n)
 {
-  n->set_grob_property ("stem", me->self_scm ());
+  n->set_property ("stem", me->self_scm ());
   n->add_dependency (me);
 
   /*
@@ -248,10 +251,10 @@ Stem::add_head (Grob*me, Grob *n)
 }
 
 bool
-Stem::invisible_b (Grob*me)
+Stem::is_invisible (Grob*me)
 {
   return ! (head_count (me)
-           && gh_scm2int (me->get_grob_property ("duration-log")) >= 1);
+           && ly_scm2int (me->get_property ("duration-log")) >= 1);
 }
 
 Direction
@@ -270,7 +273,7 @@ Stem::get_default_dir (Grob*me)
   if (sign (ddistance - udistance))
     return Direction (sign (ddistance -udistance));
 
-  return to_dir (me->get_grob_property ("neutral-direction"));
+  return to_dir (me->get_property ("neutral-direction"));
 }
 
 Real
@@ -285,22 +288,20 @@ Stem::get_default_stem_end_position (Grob*me)
 
   
   Real length = 7;             // WARNING: IN HALF SPACES
-  SCM scm_len = me->get_grob_property ("length");
-  if (gh_number_p (scm_len))
+  SCM scm_len = me->get_property ("length");
+  if (is_number (scm_len))
     {
-      length = gh_scm2double (scm_len);
+      length = ly_scm2double (scm_len);
     }
   else
     {
-      s = me->get_grob_property ("lengths");
-      if (gh_pair_p (s))
+      s = me->get_property ("lengths");
+      if (ly_c_pair_p (s))
        {
-         length = 2* gh_scm2double (robust_list_ref (durlog -2, s));
+         length = 2* ly_scm2double (robust_list_ref (durlog -2, s));
        }
     }
 
-
-
   /* URGURGURG
      'set-default-stemlen' sets direction too
    */
@@ -311,22 +312,18 @@ Stem::get_default_stem_end_position (Grob*me)
       set_grob_direction (me, dir);
     }
 
-
   /* stems in unnatural (forced) direction should be shortened, 
     according to [Roush & Gourlay] */
-  if (!chord_start_y (me)
-      || (get_direction (me) != get_default_dir (me)))
+  if (dir * head_positions (me)[dir] >= 0)
     {
-      
-  
-      SCM sshorten = me->get_grob_property ("stem-shorten");
-      SCM scm_shorten = gh_pair_p (sshorten) ?
+      SCM sshorten = me->get_property ("stem-shorten");
+      SCM scm_shorten = ly_c_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)
+      if (abs (head_positions (me)[dir]) <= 1)
        shorten *= 0.5;
   
       length -= shorten;
@@ -335,20 +332,20 @@ Stem::get_default_stem_end_position (Grob*me)
   /*
     Tremolo stuff: 
   */
-  Grob * trem = unsmob_grob (me->get_grob_property ("tremolo-flag"));
-  if (trem &&  !unsmob_grob (me->get_grob_property ("beam")))
+  Grob * trem = unsmob_grob (me->get_property ("tremolo-flag"));
+  if (trem &&  !unsmob_grob (me->get_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_molecule() looks at the beam.)
+       (Stem_tremolo::raw_stencil () looks at the beam.)
        
         --hwn 
       */
       
       Real minlen =
-       1.0 + 2 * Stem_tremolo::raw_molecule (trem).extent (Y_AXIS).length  () / ss;
+       1.0 + 2 * Stem_tremolo::raw_stencil (trem).extent (Y_AXIS).length  () / ss;
       
       if (durlog >= 3)
        {
@@ -373,7 +370,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"));
+  bool no_extend_b = to_boolean (me->get_property ("no-stem-extend"));
   if (!no_extend_b && dir * st < 0) // junkme?
     st = 0.0;
 
@@ -431,8 +428,8 @@ Stem::get_default_stem_end_position (Grob*me)
 int
 Stem::duration_log (Grob*me) 
 {
-  SCM s = me->get_grob_property ("duration-log");
-  return (gh_number_p (s)) ? gh_scm2int (s) : 2;
+  SCM s = me->get_property ("duration-log");
+  return (is_number (s)) ? ly_scm2int (s) : 2;
 }
 
 void
@@ -462,13 +459,17 @@ 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)
            {
@@ -488,7 +489,7 @@ Stem::position_noteheads (Grob*me)
              Real reverse_overlap =0.5;
              heads[i]->translate_axis ((l-thick*reverse_overlap) * d, X_AXIS);
 
-             if (invisible_b(me))
+             if (is_invisible (me))
                heads[i]->translate_axis (-thick*(2 - reverse_overlap) * d , X_AXIS);
 
              
@@ -533,7 +534,7 @@ Stem::before_line_breaking (SCM smob)
     }
   else
     {
-      me->set_grob_property ("molecule-callback", SCM_EOL);
+      me->set_property ("print-function", SCM_EOL);
     }
   
   return SCM_UNSPECIFIED;
@@ -548,14 +549,14 @@ MAKE_SCHEME_CALLBACK (Stem, height, 2);
 SCM
 Stem::height (SCM smob, SCM ax)
 {
-  Axis a = (Axis)gh_scm2int (ax);
+  Axis a = (Axis)ly_scm2int (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);
@@ -566,7 +567,7 @@ Stem::height (SCM smob, SCM ax)
 }
 
 
-Molecule
+Stencil
 Stem::flag (Grob*me)
 {
   /* TODO: maybe property stroke-style should take different values,
@@ -574,18 +575,18 @@ Stem::flag (Grob*me)
      '() or "grace").  */
   String flag_style;
   
-  SCM flag_style_scm = me->get_grob_property ("flag-style");
-  if (gh_symbol_p (flag_style_scm))
+  SCM flag_style_scm = me->get_property ("flag-style");
+  if (is_symbol (flag_style_scm))
     {
       flag_style = ly_symbol2string (flag_style_scm);
     }
 
   if (flag_style == "no-flag")
     {
-      return Molecule ();
+      return Stencil ();
     }
 
-  bool adjust = to_boolean (me->get_grob_property ("adjust-if-on-staffline"));
+  bool adjust = true;
 
   String staffline_offs;
   if (String::compare (flag_style, "mensural") == 0)
@@ -601,7 +602,7 @@ Stem::flag (Grob*me)
         {
          /* Urrgh!  We have to detect wether this stem ends on a staff
             line or between two staff lines.  But we can not call
-            stem_end_position(me) or get_default_stem_end_position(me),
+            stem_end_position (me) or get_default_stem_end_position (me),
             since this encounters the flag and hence results in an
             infinite recursion.  However, in pure mensural notation,
             there are no multiple note heads attached to a single stem,
@@ -623,7 +624,7 @@ Stem::flag (Grob*me)
            
            --hwn.
          */
-         int p = (int)rint (Staff_symbol_referencer::get_position (first_head (me)));
+         int p = Staff_symbol_referencer::get_rounded_position (me);
          staffline_offs = Staff_symbol_referencer::on_staffline (me, p) ?
            "1" : "0";
        }
@@ -641,27 +642,27 @@ 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);
+  Stencil flag = fm->find_by_name ("flags-" + font_char);
   if (flag.is_empty ())
     {
       me->warning (_f ("flag `%s' not found", font_char));
     }
 
-  SCM stroke_style_scm = me->get_grob_property ("stroke-style");
-  if (gh_string_p (stroke_style_scm))
+  SCM stroke_style_scm = me->get_property ("stroke-style");
+  if (ly_c_string_p (stroke_style_scm))
     {
       String stroke_style = ly_scm2string (stroke_style_scm);
       if (!stroke_style.is_empty ())
        {
          String font_char = to_string (dir) + stroke_style;
-         Molecule 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
            {
-             flag.add_molecule (stroke);
+             flag.add_stencil (stroke);
            }
        }
     }
@@ -673,11 +674,11 @@ MAKE_SCHEME_CALLBACK (Stem,dim_callback,2);
 SCM
 Stem::dim_callback (SCM e, SCM ax)
 {
-  Axis a = (Axis) gh_scm2int (ax);
+  Axis a = (Axis) ly_scm2int (ax);
   assert (a == X_AXIS);
   Grob *me = unsmob_grob (e);
   Interval r (0, 0);
-  if (unsmob_grob (me->get_grob_property ("beam")) || abs (duration_log (me)) <= 2)
+  if (unsmob_grob (me->get_property ("beam")) || abs (duration_log (me)) <= 2)
     ;  // TODO!
   else
     {
@@ -690,17 +691,17 @@ Stem::dim_callback (SCM e, SCM ax)
 Real
 Stem::thickness (Grob* me)
 {
-  return gh_scm2double (me->get_grob_property ("thickness"))
+  return ly_scm2double (me->get_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);
      
   /*
@@ -708,13 +709,13 @@ Stem::brew_molecule (SCM smob)
 
     This is required to avoid stems passing in tablature chords...
   */
-  Grob *lh = to_boolean (me->get_grob_property ("avoid-note-head")) 
+  Grob *lh = to_boolean (me->get_property ("avoid-note-head")) 
     ? last_head (me) :  lh = first_head (me);
 
   if (!lh)
     return SCM_EOL;
 
-  if (invisible_b (me))
+  if (is_invisible (me))
     return SCM_EOL;
   
   Real y1 = Staff_symbol_referencer::get_position (lh);
@@ -742,20 +743,20 @@ Stem::brew_molecule (SCM smob)
   // URG
   Real stem_width = thickness (me);
   Real blot = 
-       me->get_paper ()->get_realvar (ly_symbol2scm ("blotdiameter"));
+       me->get_paper ()->get_dimension (ly_symbol2scm ("blotdiameter"));
   
   Box b = Box (Interval (-stem_width/2, stem_width/2),
               Interval (stem_y[DOWN]*dy, stem_y[UP]*dy));
 
-  Molecule ss = Lookup::round_filled_box (b, blot);
-  mol.add_molecule (ss);
+  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);
+      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_molecule (fl);
+      mol.add_stencil (fl);
     }
 
   return mol.smobbed_copy ();
@@ -774,21 +775,21 @@ Stem::off_callback (SCM element_smob, SCM)
 
   if (head_count (me) == 0)
     {
-      return gh_double2scm (0.0);
+      return scm_make_real (0.0);
     }
   
   if (Grob * f = first_head (me))
     {
-      Interval head_wid = Note_head::head_extent(f, X_AXIS);
+      Interval head_wid = Note_head::head_extent (f, X_AXIS);
       
       Real attach =0.0;
 
-      if (invisible_b (me))
+      if (is_invisible (me))
        {
          attach = 0.0;
        }
       else
-       attach = Note_head::stem_attachment_coordinate(f, X_AXIS);
+       attach = Note_head::stem_attachment_coordinate (f, X_AXIS);
 
       Direction d = get_direction (me);
 
@@ -807,14 +808,14 @@ Stem::off_callback (SCM element_smob, SCM)
          r += - d * rule_thick * 0.5;
        }
     }
-  return gh_double2scm (r);
+  return scm_make_real (r);
 }
 
 
 Grob*
 Stem::get_beam (Grob*me)
 {
-  SCM b=  me->get_grob_property ("beam");
+  SCM b=  me->get_property ("beam");
   return unsmob_grob (b);
 }
 
@@ -822,17 +823,17 @@ Stem_info
 Stem::get_stem_info (Grob *me)
 {
   /* Return cached info if available */
-  SCM scm_info = me->get_grob_property ("stem-info");
-  if (!gh_pair_p (scm_info))
+  SCM scm_info = me->get_property ("stem-info");
+  if (!ly_c_pair_p (scm_info))
     {
       calc_stem_info (me);
-      scm_info = me->get_grob_property ("stem-info");
+      scm_info = me->get_property ("stem-info");
     }
   
   Stem_info si;
   si.dir_ = get_grob_direction (me); 
-  si.ideal_y_ = gh_scm2double (gh_car (scm_info)); 
-  si.shortest_y_ = gh_scm2double (gh_cadr (scm_info));
+  si.ideal_y_ = ly_scm2double (ly_car (scm_info)); 
+  si.shortest_y_ = ly_scm2double (ly_cadr (scm_info));
   return si;
 }
 
@@ -844,6 +845,13 @@ void
 Stem::calc_stem_info (Grob *me)
 {
   Direction my_dir = get_grob_direction (me);
+
+  if (!my_dir)
+    {
+      programming_error ("No stem dir set?");
+      my_dir  = UP;
+    }
+  
   Real staff_space = Staff_symbol_referencer::staff_space (me);
   Grob *beam = get_beam (me);
   Real beam_translation = Beam::get_beam_translation (beam);
@@ -852,18 +860,18 @@ Stem::calc_stem_info (Grob *me)
 
 
   /* Simple standard stem length */
-  SCM lengths = me->get_grob_property ("beamed-lengths");
+  SCM lengths = me->get_property ("beamed-lengths");
   Real ideal_length =
-    gh_scm2double (robust_list_ref (beam_count - 1,lengths))
+    ly_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");
+  lengths = me->get_property ("beamed-minimum-free-lengths");
   Real ideal_minimum_free =
-    gh_scm2double (robust_list_ref (beam_count - 1, lengths))
+    ly_scm2double (robust_list_ref (beam_count - 1, lengths))
     * staff_space;
   
 
@@ -908,9 +916,9 @@ Stem::calc_stem_info (Grob *me)
      Obviously not for grace beams.
      
      Also, not for knees.  Seems to be a good thing. */
-  bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend"));
-  bool knee_b = to_boolean (beam->get_grob_property ("knee"));
-  if (!no_extend_b && !knee_b)
+  bool no_extend_b = to_boolean (me->get_property ("no-stem-extend"));
+  bool is_knee = to_boolean (beam->get_property ("knee"));
+  if (!no_extend_b && !is_knee)
     {
       /* Highest beam of (UP) beam must never be lower than middle
         staffline */
@@ -921,12 +929,12 @@ Stem::calc_stem_info (Grob *me)
     }
 
 
-  ideal_y -= robust_scm2double (beam->get_grob_property ("shorten"), 0);
+  ideal_y -= robust_scm2double (beam->get_property ("shorten"), 0);
 
   Real minimum_free =
-    gh_scm2double (robust_list_ref
+    ly_scm2double (robust_list_ref
                   (beam_count - 1,
-                   me->get_grob_property
+                   me->get_property
                    ("beamed-extreme-minimum-free-lengths")))
     * staff_space;
 
@@ -941,18 +949,18 @@ Stem::calc_stem_info (Grob *me)
   ideal_y *= my_dir;
   Real shortest_y = minimum_y * my_dir; 
   
-  me->set_grob_property ("stem-info",
-                        scm_list_n (gh_double2scm (ideal_y),
-                                    gh_double2scm (shortest_y),
+  me->set_property ("stem-info",
+                        scm_list_n (scm_make_real (ideal_y),
+                                    scm_make_real (shortest_y),
                                     SCM_UNDEFINED));
 }
 
 Slice
 Stem::beam_multiplicity (Grob *stem)
 {
-  SCM beaming= stem->get_grob_property ("beaming");
-  Slice l = int_list_to_slice (gh_car (beaming));
-  Slice r = int_list_to_slice (gh_cdr (beaming));
+  SCM beaming= stem->get_property ("beaming");
+  Slice l = int_list_to_slice (ly_car (beaming));
+  Slice r = int_list_to_slice (ly_cdr (beaming));
   l.unite (r);
 
   return l;
@@ -963,9 +971,14 @@ Stem::beam_multiplicity (Grob *stem)
   these are too many props.
  */
 ADD_INTERFACE (Stem,"stem-interface",
-              "A stem",
+              "The stem represent the graphical  stem. "
+              "  In addition, it internally connects note heads, beams, tremolos. Rests "
+              " and whole notes have invisible stems."
+
+,
+              
               "tremolo-flag french-beaming "
-              "avoid-note-head adjust-if-on-staffline thickness "
+              "avoid-note-head 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 "
@@ -976,7 +989,7 @@ ADD_INTERFACE (Stem,"stem-interface",
 
 /****************************************************************/
 
-Stem_info::Stem_info()
+Stem_info::Stem_info ()
 {
   ideal_y_ = shortest_y_ =0;
   dir_ = CENTER;