]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem.cc
release: 1.5.38
[lilypond.git] / lily / stem.cc
index 3dbc09ac45b1668901b8b7e7b4f6f61c0cdfcd8a..d53539ec68363f21e5712f4e6031058f95efc49c 100644 (file)
@@ -3,11 +3,12 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
     Jan Nieuwenhuizen <janneke@gnu.org>
 
   TODO: This is way too hairy
 */
+
 #include <math.h>              // m_pi
 
 #include "lookup.hh"
@@ -26,7 +27,7 @@
 #include "group-interface.hh"
 #include "staff-symbol-referencer.hh"
 #include "spanner.hh"
-
+#include "side-position-interface.hh"
 
 void
 Stem::set_beaming (Grob*me ,int i,  Direction d)
@@ -81,7 +82,6 @@ Stem::stem_end_position (Grob*me)
   Real pos;
   if (!gh_number_p (p))
     {
-
       pos = get_default_stem_end_position (me);
       me->set_grob_property ("stem-end-position", gh_double2scm (pos));
     }
@@ -113,7 +113,7 @@ Stem::set_stemend (Grob*me, Real se)
   Direction d= get_direction (me);
   
   if (d && d * head_positions (me)[get_direction (me)] >= se*d)
-    warning (_ ("Weird stem size; check for narrow beams"));
+    me->warning (_ ("Weird stem size; check for narrow beams"));
 
   me->set_grob_property ("stem-end-position", gh_double2scm (se));
 }
@@ -140,7 +140,7 @@ Stem::support_head (Grob*me)
        UGH.
        */
       
-      return unsmob_grob (gh_car (me->get_grob_property ("heads")));
+      return unsmob_grob (ly_car (me->get_grob_property ("heads")));
     }
   else
     return first_head (me);
@@ -176,9 +176,9 @@ Stem::extremal_heads (Grob*me)
   Drul_array<Grob *> exthead;
   exthead[LEFT] = exthead[RIGHT] =0;
   
-  for (SCM s = me->get_grob_property ("heads"); gh_pair_p (s); s = gh_cdr (s))
+  for (SCM s = me->get_grob_property ("heads"); gh_pair_p (s); s = ly_cdr (s))
     {
-      Grob * n = unsmob_grob (gh_car (s));
+      Grob * n = unsmob_grob (ly_car (s));
 
       
       int p = int (Staff_symbol_referencer::position_f (n));
@@ -196,6 +196,29 @@ Stem::extremal_heads (Grob*me)
   return exthead;
 }
 
+static int
+icmp (int const &a, int const &b)
+{
+  return a-b;
+}
+
+Array<int>
+Stem::note_head_positions (Grob *me)
+{
+  Array<int> ps ;
+  for (SCM s = me->get_grob_property ("heads"); gh_pair_p (s); s = ly_cdr (s))
+    {
+      Grob * n = unsmob_grob (ly_car (s));
+      int p = int (Staff_symbol_referencer::position_f (n));
+
+      ps.push (p);
+    }
+
+  ps.sort (icmp);
+  return ps; 
+}
+
+
 void
 Stem::add_head (Grob*me, Grob *n)
 {
@@ -204,7 +227,7 @@ Stem::add_head (Grob*me, Grob *n)
 
   if (Note_head::has_interface (n))
     {
-      Pointer_group_interface::add_element (me, "heads",n);
+      Pointer_group_interface::add_grob (me, ly_symbol2scm ("heads"), n);
     }
   else
     {
@@ -254,8 +277,8 @@ Stem::get_default_stem_end_position (Grob*me)
   else
     {
       s = me->get_grob_property ("lengths");
-      for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
-       a.push (gh_scm2double (gh_car (q)));
+      for (SCM q = s; q != SCM_EOL; q = ly_cdr (q))
+       a.push (gh_scm2double (ly_car (q)));
                
       // stem uses half-spaces
       length_f = a[ ((flag_i (me) - 2) >? 0) <? (a.size () - 1)] * 2;
@@ -264,13 +287,13 @@ Stem::get_default_stem_end_position (Grob*me)
 
   a.clear ();
   s = me->get_grob_property ("stem-shorten");
-  for (SCM q = s; gh_pair_p (q); q = gh_cdr (q))
-    a.push (gh_scm2double (gh_car (q)));
+  for (SCM q = s; gh_pair_p (q); q = ly_cdr (q))
+    a.push (gh_scm2double (ly_car (q)));
 
 
   // stem uses half-spaces
 
-  // fixme: use gh_list_ref () iso. array[]
+  // fixme: use scm_list_n_ref () iso. array[]
   Real shorten_f = a[ ((flag_i (me) - 2) >? 0) <? (a.size () - 1)] * 2;
 
   /* URGURGURG
@@ -293,7 +316,10 @@ Stem::get_default_stem_end_position (Grob*me)
 
   Interval hp = head_positions (me);  
   Real st = hp[dir] + dir * length_f;
+
+
   
+
   /*
     Make a little room if we have a flag and there is a dot.
 
@@ -301,7 +327,6 @@ Stem::get_default_stem_end_position (Grob*me)
 
     maybe  we should consider moving the dot to the right?
   */
-
   if (!beam_l (me)
       && flag_i (me))
     {
@@ -313,19 +338,30 @@ Stem::get_default_stem_end_position (Grob*me)
        {
          Real dp = Staff_symbol_referencer::position_f  (dots);
          Real flagy =  flag (me).extent (Y_AXIS)[-dir] * 2; // should divide by staffspace
-         
-         if (dir * (st + flagy -  dp) < 0) 
-           st += (fabs (st + flagy -  dp) + 1.0) *dir;
+
+         /*
+           Very gory: add myself to the X-support of the parent,
+           which should be a dot-column.
+          */
+         if (dir * (st + flagy -  dp) < 0.5)
+           Side_position_interface::add_support (dots->get_parent (X_AXIS), me);
+
+         /*
+           previous approach was to lengthen the stem. This is not
+           good typesetting practice.  */
        }
     }
-  
-   bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend"));
+
+
+  bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend"));
    if (!grace_b && !no_extend_b && dir * st < 0) // junkme?
       st = 0.0;
 
   return st;
 }
 
+
+
 /*
   Number of hooks on the flag, ie. the log of the duration.
  */
@@ -343,7 +379,7 @@ Stem::position_noteheads (Grob*me)
     return;
   
   Link_array<Grob> heads =
-    Pointer_group_interface__extract_elements (me, (Grob*)0, "heads");
+    Pointer_group_interface__extract_grobs (me, (Grob*)0, "heads");
 
   heads.sort (compare_position);
   Direction dir =get_direction (me);
@@ -353,10 +389,11 @@ Stem::position_noteheads (Grob*me)
 
 
   Grob *hed = support_head (me);
-  Real w = hed->extent (hed, X_AXIS)[dir];
+  Real w = Note_head::head_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);
+      heads[i]->translate_axis (w - Note_head::head_extent (heads[i],X_AXIS)[dir],
+                               X_AXIS);
     }
   
   bool parity= true;           // todo: make me settable.
@@ -370,7 +407,8 @@ Stem::position_noteheads (Grob*me)
        {
          if (parity)
            {
-             Real l = heads[i]->extent (heads[i], X_AXIS).length ();
+             Real l = Note_head::head_extent (heads[i], X_AXIS).length ();
+
              heads[i]->translate_axis (l * get_direction (me), X_AXIS);
            }
          parity = !parity;
@@ -396,11 +434,9 @@ Stem::before_line_breaking (SCM smob)
       // suicide ();
     }
   
-  set_spacing_hints (me);
   return SCM_UNSPECIFIED;
 }
 
-
 /*
   ugh.
   When in a beam with tuplet brackets, brew_mol is called early,
@@ -422,46 +458,79 @@ Stem::height (SCM smob, SCM ax)
 }
 
 
-/**
-   set stem directions for hinting the optical spacing correction.
-
-   Modifies DIR_LIST property of the Stem's Paper_column
-
-   TODO: more advanced: supply height of noteheads as well, for more advanced spacing possibilities
- */
-void
-Stem::set_spacing_hints (Grob*me) 
+Molecule
+Stem::flag (Grob*me)
 {
-  if (!invisible_b (me))
+  /* TODO: rename flag-style into something more appropriate,
+   e.g. "stroke-style", maybe with values "" (i.e. no stroke),
+   "single" and "double".  Needs more discussion.
+  */
+  String style, fstyle, staffline_offs;
+  SCM fst = me->get_grob_property ("flag-style");
+  if (gh_string_p (fst))
     {
-      SCM scmdir  = gh_int2scm (get_direction (me));
+      fstyle = ly_scm2string (fst);
+    }
 
-      Item* item = dynamic_cast<Item*> (me);
-      Item * col =  item->column_l ();
-      SCM dirlist =col->get_grob_property ("dir-list");
-      if (scm_sloppy_memq (scmdir, dirlist) == SCM_BOOL_F)
-       {
-         dirlist = gh_cons (scmdir, dirlist);
-         col->set_grob_property ("dir-list", dirlist);
+  SCM st = me->get_grob_property ("style");
+  if (gh_symbol_p (st))
+    {
+      style = (ly_scm2string (scm_symbol_to_string (st)));
+    }
+  else
+    {
+      style = "";
+    }
+  bool adjust = to_boolean (me->get_grob_property ("adjust-if-on-staffline"));
+
+  if (String::compare_i (style, "mensural") == 0)
+    /* 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,
+       regardless if the note head is on a staff line or between two
+       staff lines.  In other words, the inner end of a flag always
+       touches a staff line.
+    */
+    {
+      if (adjust)
+        {
+         /* 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),
+            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,
+            neither is there usually need for using the stem_shorten
+            property (except for 32th and 64th notes, but that is not a
+            problem since the stem length in this case is augmented by
+            an integral multiple of staff_space).  Hence, it should be
+            sufficient to just take the first note head, assume it's
+            the only one, look if it's on a staff line, and select the
+            flag's shape accordingly.  In the worst case, the shape
+            looks slightly misplaced, but that will usually be the
+            programmer's fault (e.g. when trying to attach multiple
+            note heads to a single stem in mensural notation).  */
+         Grob *first = first_head(me);
+         int sz = Staff_symbol_referencer::line_count (me)-1;
+         int p = (int)rint (Staff_symbol_referencer::position_f (first));
+         staffline_offs = (((p ^ sz) & 0x1) == 0) ? "1" : "0";
+       }
+      else
+        {
+         staffline_offs = "2";
        }
     }
-}
-
-Molecule
-Stem::flag (Grob*me)
-{
-  String style;
-  SCM st = me->get_grob_property ("flag-style");
-  if (gh_string_p (st))
+  else
     {
-      style = ly_scm2string (st);
+      staffline_offs = "";
     }
-
   char c = (get_direction (me) == UP) ? 'u' : 'd';
-  Molecule m = Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + 
-                                     to_str (flag_i (me)));
-  if (!style.empty_b ())
-    m.add_molecule (Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + style));
+  String index_str
+    = String ("flags-") + style + to_str (c) + staffline_offs + to_str (flag_i (me));
+  Molecule m
+    = Font_interface::get_default_font (me)->find_by_name (index_str);
+  if (!fstyle.empty_b ())
+    m.add_molecule (Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + fstyle));
   return m;
 }
 
@@ -497,23 +566,30 @@ Stem::brew_molecule (SCM smob)
   Real y1 = Staff_symbol_referencer::position_f (first_head (me));
   Real y2 = stem_end_position (me);
   
-  Interval stem_y (y1,y2);
-  stem_y.unite (Interval (y2,y1));
+  Interval stem_y (y1 <? y2,y2 >? y1);
+
+
+  // dy?
+  Real dy = Staff_symbol_referencer::staff_space (me) * 0.5;
 
-  Real dy = Staff_symbol_referencer::staff_space (me)/2.0;
-    
   if (Grob *hed = support_head (me))
     {
-      Interval head_height = hed->extent (hed,Y_AXIS);
+      /*
+       must not take ledgers into account.
+       */
+      Interval head_height = Note_head::head_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 * 2*y_attach;
+      stem_y[Direction (-d)] += d * y_attach/dy;
     }
   
   if (!invisible_b (me))
     {
-      Real stem_width = gh_scm2double (me->get_grob_property ("thickness")) * me->paper_l ()->get_var ("stafflinethickness");
+      Real stem_width = gh_scm2double (me->get_grob_property ("thickness"))
+       // URG
+       * me->paper_l ()->get_var ("stafflinethickness");
+      
       Molecule ss =Lookup::filledbox (Box (Interval (-stem_width/2, stem_width/2),
                                           Interval (stem_y[DOWN]*dy, stem_y[UP]*dy)));
       mol.add_molecule (ss);
@@ -541,7 +617,7 @@ Stem::off_callback (SCM element_smob, SCM)
   Real r=0;
   if (Grob * f = first_head (me))
     {
-      Interval head_wid = f->extent (f,X_AXIS);
+      Interval head_wid = Note_head::head_extent(f, X_AXIS);
 
       Real attach =
        Note_head::stem_attachment_coordinate(f, X_AXIS);
@@ -616,16 +692,16 @@ Stem::calc_stem_info (Grob*me)
   
   s = me->get_grob_property ("beamed-minimum-lengths");
   a.clear ();
-  for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
-    a.push (gh_scm2double (gh_car (q)));
+  for (SCM q = s; q != SCM_EOL; q = ly_cdr (q))
+    a.push (gh_scm2double (ly_car (q)));
 
 
   Real minimum_length = a[multiplicity <? (a.size () - 1)] * staff_space;
   s = me->get_grob_property ("beamed-lengths");
 
   a.clear ();
-  for (SCM q = s; q != SCM_EOL; q = gh_cdr (q))
-    a.push (gh_scm2double (gh_car (q)));
+  for (SCM q = s; q != SCM_EOL; q = ly_cdr (q))
+    a.push (gh_scm2double (ly_car (q)));
 
   Real stem_length =  a[multiplicity <? (a.size () - 1)] * staff_space;