]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/line-spanner.cc
new file, move from
[lilypond.git] / lily / line-spanner.cc
index bece984882c939e3373d3683f90a76c35c041a1b..9dc4562539484b949974bd9be0f065eedf08079d 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2000 Jan Nieuwenhuizen <janneke@gnu.org>
+  (c) 2000--2004 Jan Nieuwenhuizen <janneke@gnu.org>
 */
 
-#include "molecule.hh"
+#include <math.h>
+
+#include "stencil.hh"
 #include "item.hh"
 #include "spanner.hh"
 #include "line-spanner.hh"
-#include "paper-def.hh"
+#include "output-def.hh"
 #include "paper-column.hh"
 #include "staff-symbol-referencer.hh"
+#include "font-interface.hh"
+#include "warn.hh"
+#include "align-interface.hh"
+#include "lookup.hh"
+#include "line-interface.hh"
+
+Stencil
+zigzag_stencil (Grob *me, 
+                Offset from,
+                Offset to)
+{
+  Offset dz = to -from;
+  Real dx = dz[X_AXIS];
+  Real dy = dz[Y_AXIS];
+
+  Real thick = Staff_symbol_referencer::line_thickness (me);
+  thick *= robust_scm2double (me->get_property ("thickness"), 1.0); // todo: staff sym referencer? 
+  
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
 
+  double w = robust_scm2double (me->get_property ("zigzag-width"), 1)*staff_space;
+  double l = robust_scm2double ( me->get_property ("zigzag-length"), 1)* w;
+  double h = l>w/2 ? sqrt (l*l-w*w/4) : 0;
+  
+  SCM list = scm_list_n (ly_symbol2scm ("zigzag-line"),
+                     ly_bool2scm (true),
+                     scm_make_real (w),
+                     scm_make_real (h),
+                     scm_make_real (thick),
+                     scm_make_real (dx),
+                     scm_make_real (dy),
+                     SCM_UNDEFINED);
+  Box b;
+  b.add_point (Offset (0,0));
+  b.add_point (dz);
+  b[X_AXIS].widen (thick/2);
+  b[Y_AXIS].widen (thick/2);
+     
+  return Stencil (b, list);
+}
+
+MAKE_SCHEME_CALLBACK (Line_spanner, after_line_breaking, 1);
 SCM
-Line_spanner::line_atom (Grob* me, Real dx, Real dy)
+Line_spanner::after_line_breaking (SCM  g)
 {
-  SCM list = SCM_EOL;
-  SCM type = me->get_grob_property ("type");
-  if (gh_symbol_p (type)
+  Grob *me  = unsmob_grob (g);
+  Spanner*sp = dynamic_cast<Spanner*> (me);
+
+  /*
+    We remove the line at the start of the line.  For piano voice
+    indicators, it makes no sense to have them at the start of the
+    line.
+
+    I'm not sure what the official rules for glissandi are, but
+    usually the 2nd note of the glissando is "exact", so when playing
+    from the start of the line, there is no need to glide.
+
+    From a typographical p.o.v. this makes sense, since the amount of
+    space left of a note at the start of a line is very small.
+
+    --hwn.
+    
+   */
+  if (sp->get_bound (LEFT)->break_status_dir ()
+      && !sp->get_bound (RIGHT)->break_status_dir ())
+    {
+      /*
+       Can't do suicide, since this mucks up finding the trend.
+       */
+      me->set_property ("print-function", SCM_EOL);
+      
+    }
+  return SCM_EOL;
+}
+
+
+Stencil
+Line_spanner::line_stencil (Grob *me, 
+                            Offset from,
+                            Offset to)
+{
+  Offset dz = to -from ; 
+  SCM type = me->get_property ("style");
+  if (ly_c_symbol_p (type)
       && (type == ly_symbol2scm ("line")
          || type == ly_symbol2scm ("dashed-line")
-         || type == ly_symbol2scm ("dotted-line")))
+         || type == ly_symbol2scm ("dotted-line")
+         || type == ly_symbol2scm ("zigzag") 
+         || (type == ly_symbol2scm ("trill") && dz[Y_AXIS] != 0)))
     {
-      Real staff_space = Staff_symbol_referencer::staff_space (me);
-      Real thick = me->paper_l ()->get_var ("stafflinethickness");  
-
-      SCM s = me->get_grob_property ("line-thickness");
-      if (gh_number_p (s))
-       thick *= gh_scm2double (s);
-  
-      // maybe these should be in line-thickness?
-      Real length = staff_space;
-      s = me->get_grob_property ("dash-length");
-      if (gh_number_p (s))
-       length = gh_scm2double (s) * staff_space;
-
-      Real period = 2 * length + thick;
-      s = me->get_grob_property ("dash-period");
-      if (gh_number_p (s))
-       period = gh_scm2double (s) * staff_space;
+      return  (type == ly_symbol2scm ("zigzag"))
+       ? zigzag_stencil (me, from, to)
+       : Line_interface::line (me, from, to);
+    }
+  else if (ly_c_symbol_p (type)
+          && type == ly_symbol2scm ("trill"))
+    {
+      SCM alist_chain = Font_interface::text_font_alist_chain (me);
+      SCM style_alist = scm_list_n (scm_cons (ly_symbol2scm ("font-encoding"),
+                                            ly_symbol2scm ("fetaMusic")),
+                                   SCM_UNDEFINED);
       
-      if (type == ly_symbol2scm ("dotted-line"))
-       length = thick;
-       
-      if (type == ly_symbol2scm ("line"))
-       length = period + thick;
-
-      Real on = length - thick;
-      Real off = period - on;
-
-      list = gh_list (ly_symbol2scm ("dashed-line"),
-                     gh_double2scm (thick),
-                     gh_double2scm (on),
-                     gh_double2scm (off),
-                     gh_double2scm (dx),
-                     gh_double2scm (dy),
-                     SCM_UNDEFINED);
+      Font_metric *fm = select_font (me->get_paper (),
+                                    scm_cons (style_alist,
+                                             alist_chain));
+      Stencil m = fm->find_by_name ("scripts-trill-element");
+      Stencil mol;
+
+      do
+       mol.add_at_edge (X_AXIS, RIGHT, m, 0,0);
+      while (m.extent (X_AXIS).length ()
+            && mol.extent (X_AXIS).length ()
+            + m.extent (X_AXIS).length () < dz[X_AXIS]);
+
+      /*
+       FIXME: should center element on x/y
+       */
+      mol.translate_axis (m.extent (X_AXIS).length () / 2, X_AXIS);
+      mol.translate_axis (-(mol.extent (Y_AXIS)[DOWN]
+                           + mol.extent (Y_AXIS).length ())/2, Y_AXIS);
+
+      mol.translate (from);
+      return mol;
     }
-  return list;
+  return Stencil ();
 }
 
+/*
+  Find a common Y parent, which --if found-- should be the
+  fixed-distance alignment.
+ */
+Grob *
+line_spanner_common_parent (Grob *me)
+{
+  Grob * common = find_fixed_alignment_parent (me);
+  if (!common)
+    {
+      common = Staff_symbol_referencer::get_staff_symbol (me);
+      if (common)
+       common = common->get_parent (Y_AXIS);
+      else
+       common = me->get_parent (Y_AXIS);
+    }
 
+  return common;
+}
 
 /*
   Warning: this thing is a cross-staff object, so it should have empty Y-dimensions.
 
 (If not, you risk that this is called from the staff-alignment
-  routine, via molecule_extent. At this point, the staffs aren't
+ (If not, you risk that this is called from the staff-alignment
+  routine, via stencil_extent. At this point, the staves aren't
   separated yet, so it doesn't work cross-staff.
 
 */
 
-MAKE_SCHEME_CALLBACK (Line_spanner, brew_molecule, 1);
+
+MAKE_SCHEME_CALLBACK (Line_spanner, print, 1);
 SCM
-Line_spanner::brew_molecule (SCM smob) 
+Line_spanner::print (SCM smob) 
 {
-  Grob *me= unsmob_grob (smob);
-  Spanner *spanner = dynamic_cast<Spanner*> (me);
+  Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (smob));
 
-  Grob *common[] = { 0, 0 };
-
-  Item *l = spanner->get_bound (LEFT);
-  Item *r = spanner->get_bound (RIGHT);  
+  Drul_array<Item*>  bound (me->get_bound (LEFT),
+                           me->get_bound (RIGHT));
+  
+  
+  Real gap = robust_scm2double (me->get_property ("gap"), 0.0);
 
-  /*
-    FIXME: should also do something sensible across line breaks.
-   */
-  if (l->break_status_dir () || r->break_status_dir ())
-    return SCM_EOL;
+  Offset ofxy (gap, 0); /*offset from start point to start of line*/
+  Offset dxy ;
+  Offset my_off;
+  Offset his_off;
   
-  for (Axis a = X_AXIS;  a < NO_AXES; a = Axis (a + 1))
+
+  if (bound[RIGHT]->break_status_dir ())
     {
-      common[a] = l->common_refpoint (r, a);
+      if (bound[LEFT]->break_status_dir ())
+       {
+         programming_error ("line-spanner with two broken ends. Farewell sweet world.");
+
+         me->suicide ();
+         return SCM_EOL;
+       }
+
+      /*
+       This is hairy. For the normal case, we simply find common
+       parents, and draw a line between the bounds. When two note
+       heads are on different lines, there is no common parent
+       anymore. We have to find the piano-staff object.
+      */
+      
+      int k = broken_spanner_index (me);
+      Spanner *parent_sp = dynamic_cast<Spanner*> (me->original_);
+      Spanner *next_sp  = parent_sp->broken_intos_ [k+1];
+      Item *next_bound = next_sp->get_bound (RIGHT);
+
+      if (next_bound->break_status_dir ())
+       {
+         programming_error ("no note heads for the line spanner on next line?"
+                            " Confused.");
+         me->suicide ();
+         return SCM_EOL;
+       }
+            
+      Grob *commonx = bound[LEFT]->common_refpoint (bound[RIGHT], X_AXIS);
+      commonx = me->common_refpoint (commonx, X_AXIS);
+      
+      Grob *next_common_y = line_spanner_common_parent (next_bound);
+      Grob *this_common_y = line_spanner_common_parent (bound[LEFT]);
+
+      Grob *all_common_y = me->common_refpoint (this_common_y, Y_AXIS);
+      
+      Interval next_ext  = next_bound->extent (next_common_y, Y_AXIS);
+      Interval this_ext  = bound[LEFT]->extent (this_common_y, Y_AXIS);
+
+      Real yoff = this_common_y->relative_coordinate (all_common_y, Y_AXIS);
+      
+      Offset p1 (bound[LEFT]->extent (commonx, X_AXIS)[RIGHT],
+                this_ext.center ()  + yoff); 
+      Offset p2 (bound[RIGHT]->extent (commonx, X_AXIS)[LEFT],
+                next_ext.center () + yoff);
+      
+      Offset dz (p2 -p1);
+      Real len = dz.length ();
+
+      Offset dir  = dz *(1/ len);
+      dz = (dz.length () - 2*gap) *dir;
+      
   
-    if (!common[a])
-      return SCM_EOL;
+      Stencil l (line_stencil (me, Offset (0, 0), dz));
+
+      l.translate (dir * gap +  p1
+                  - Offset (me->relative_coordinate (commonx, X_AXIS),
+                            me->relative_coordinate (all_common_y, Y_AXIS)));
+
+      return l.smobbed_copy (); 
     }
-  
-  Offset dxy ; 
-  for (Axis a = X_AXIS;  a < NO_AXES; a = Axis (a + 1))
+  else
     {
-      dxy[a] = r->extent (common[a], a)[LEFT] -
-       l->extent (common[a], a)[RIGHT];
-    }
-  
-  Molecule line;
-  Real gap = gh_scm2double (me->get_grob_property ("gap"));
-
-  Offset my_off(me->relative_coordinate (common[X_AXIS], X_AXIS),
-               me->relative_coordinate (common[Y_AXIS], Y_AXIS) ); 
-  Offset his_off(l->relative_coordinate (common[X_AXIS], X_AXIS),
-                l->relative_coordinate (common[Y_AXIS], Y_AXIS) ); 
-  dxy *= (dxy.length () - 2 * gap) / dxy.length ();
-  
-  SCM list = Line_spanner::line_atom (me, dxy[X_AXIS], dxy[Y_AXIS]);
-    
-  if (list == SCM_EOL)
-    return SCM_EOL;
-  
-  Box b (Interval (0, dxy[X_AXIS]), Interval (0, dxy[Y_AXIS]));
-  
-  line = Molecule (b, list);
-  line.translate_axis (l->extent (l, X_AXIS).length (), X_AXIS); 
-  
+      Grob *common[] = { me, me };
+      for (int a = X_AXIS;  a < NO_AXES; a++)
+       {
+         common[a] = me->common_refpoint (bound[RIGHT], Axis (a));
+         common[a] = common[a]->common_refpoint (bound[LEFT], Axis (a));
+       }
+
+      // distance from center to start of line      
+      Real off = gap + ((bound[LEFT]->extent (bound[LEFT], X_AXIS).length ()*3)/4);
+
+      for (int a = X_AXIS; a < NO_AXES; a++)
+       {
+         Axis ax = (Axis)a;
+         dxy[ax] =
+           + bound[RIGHT]->extent (common[X_AXIS], ax).center ()
+           - bound[LEFT]->extent (common[X_AXIS], ax).center ();
+
+         my_off[ax] =me->relative_coordinate (common[a], ax);
+         his_off[ax] = bound[LEFT]->relative_coordinate (common[a], ax);
+         
+       }
+
+      ofxy = dxy * (off/dxy.length ());
+      dxy -= 2*ofxy;
   
-  Offset g = dxy * (gap / dxy.length ());
-  line.translate (g - my_off + his_off);
-      
-  return line.smobbed_copy ();
+      Stencil line = line_stencil (me, Offset (0,0),dxy);
+
+      line.translate_axis (bound[LEFT]->extent (bound[LEFT], X_AXIS).length ()/2, X_AXIS); 
+      line.translate (ofxy - my_off + his_off);
+      return line.smobbed_copy ();
+    }
 }
 
 
+ADD_INTERFACE (Line_spanner, "line-spanner-interface",
+              "Generic line drawn between two objects, e.g. for use with glissandi.\n"
+              "The property @code{style} can be @code{line}, "
+              "@code{dashed-line}, @code{trill}, \n"
+              "@code{dotted-line} or @code{zigzag}.\n"
+              "\n"
+              ,
+              "gap zigzag-width zigzag-length thickness");
+
+