]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/bar-line.cc
Merge master into nested-bookparts
[lilypond.git] / lily / bar-line.cc
index 28d4e88ca70c03dc6183d2673a6db32e6b3a3e6a..d0b18fd1c55345adf59f2d46f99321a5d9390af3 100644 (file)
 /*
-  bar.cc -- implement Bar
+  bar-line.cc -- implement Bar_line
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include <math.h>
-
-#include "lookup.hh"
-#include "paper-column.hh"
-#include "grob.hh"
 #include "bar-line.hh"
-#include "string.hh"
-#include "stencil.hh"
-#include "output-def.hh"
-#include "font-interface.hh"
 
 #include "all-font-metrics.hh"
-#include "item.hh"
+#include "font-interface.hh"
+#include "lookup.hh"
+#include "output-def.hh"
+#include "paper-column.hh"
 #include "staff-symbol-referencer.hh"
+#include "line-interface.hh"
+
+MAKE_SCHEME_CALLBACK (Bar_line, calc_bar_extent, 1)
+SCM
+Bar_line::calc_bar_extent (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+
+  SCM size = me->get_property ("bar-size");
 
-MAKE_SCHEME_CALLBACK (Bar_line,print,1);
+  if (!scm_is_number (size)
+      || !Staff_symbol_referencer::get_staff_symbol (me))
+    return ly_interval2scm (Interval ());
 
-SCM 
-Bar_line::print (SCM smob) 
+  Real h = scm_to_double (size);
+  return ly_interval2scm (Interval (-h/2, h/2));
+}
+
+Interval
+Bar_line::bar_y_extent (Grob *me, Grob *refpoint)
 {
-  Grob * me = unsmob_grob (smob);
+  Interval iv = robust_scm2interval (me->get_property ("bar-extent"), Interval ());
 
-  SCM s = me->get_property ("glyph");
-  SCM barsiz_proc = me->get_property ("bar-size-procedure");
-  if (ly_c_string_p (s) && ly_c_procedure_p (barsiz_proc))
+  iv.translate (me->relative_coordinate (refpoint, Y_AXIS));
+  return iv;
+}
+
+MAKE_SCHEME_CALLBACK (Bar_line, print, 1);
+SCM
+Bar_line::print (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+
+  SCM s = me->get_property ("glyph-name");
+  SCM barsize = me->get_property ("bar-size");
+  
+  if (scm_is_string (s) && scm_is_number (barsize))
     {
-      String str  =ly_scm2string (s);
-      SCM siz = scm_call_1 (barsiz_proc, me->self_scm ());
-      Real sz = robust_scm2double (siz, 0);
-      if (sz < 0)
+      string str = ly_scm2string (s);
+      Real sz = robust_scm2double (barsize, 0);
+      if (sz <= 0)
        return SCM_EOL;
-      
-      return compound_barline (me, str, sz).smobbed_copy ();
+
+      return compound_barline (me, str, sz, false).smobbed_copy ();
     }
   return SCM_EOL;
 }
 
-
 Stencil
-Bar_line::compound_barline (Grob*me, String str, Real h)
+Bar_line::compound_barline (Grob *me, string str, Real h,
+                           bool rounded)
 {
   Real kern = robust_scm2double (me->get_property ("kern"), 1);
   Real thinkern = robust_scm2double (me->get_property ("thin-kern"), 1);
   Real hair = robust_scm2double (me->get_property ("hair-thickness"), 1);
   Real fatline = robust_scm2double (me->get_property ("thick-thickness"), 1);
 
-  Real staffline = me->get_paper ()->get_dimension (ly_symbol2scm ("linethickness"));
+  Real staffline = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
   Real staff_space = Staff_symbol_referencer::staff_space (me);
 
   kern *= staffline;
   thinkern *= staffline;
   hair *= staffline;
   fatline *= staffline;
-  
-  Stencil thin = simple_barline (me, hair, h);
-  Stencil thick = simple_barline (me, fatline, h);
-  Stencil dot = Font_interface::get_default_font (me)->find_by_name ("dots-dot");
-  Real dist = ( Staff_symbol_referencer::line_count (me) & 1 ? 1 :
-               (staff_space<2 ? 2 : .5) ) * staff_space;
+
+  Stencil thin = simple_barline (me, hair, h, rounded);
+  Stencil thick = simple_barline (me, fatline, h, rounded);
+  Stencil dot = Font_interface::get_default_font (me)->find_by_name ("dots.dot");
+
+  int lines = Staff_symbol_referencer::line_count (me);
+  Real dist
+    = ((lines & 1 || lines == 0)
+       ? 1
+       : (staff_space < 2 ? 2 : .5)) * staff_space;
   Stencil colon (dot);
-  colon.translate_axis (dist,Y_AXIS);
+  colon.translate_axis (dist, Y_AXIS);
   colon.add_stencil (dot);
-  colon.translate_axis (-dist/2,Y_AXIS);
+  colon.translate_axis (-dist / 2, Y_AXIS);
 
   Stencil m;
-  
+  Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
+  Real center = 0;
+  if (staff)
+    {
+      Interval staff_extent = staff->extent (staff, Y_AXIS);
+      center = staff_extent.center ();
+    }
+
+  if (str == "||:")
+    str = "|:";
+
   if (str == "")
     {
-      return Lookup::blank (Box (Interval (0, 0), Interval (-h/2, h/2)));
+      Stencil empty =  Lookup::blank (Box (Interval (0, 0), Interval (-h / 2, h / 2)));
+      empty.translate_axis (center, Y_AXIS);
+      return empty;
     }
   else if (str == "|")
     {
+      thin.translate_axis (center, Y_AXIS);
       return thin;
     }
   else if (str == "|." || (h == 0 && str == ":|"))
     {
-      m.add_at_edge (X_AXIS, LEFT, thick, 0, 0);      
-      m.add_at_edge (X_AXIS, LEFT, thin, kern,0 );
+      m.add_at_edge (X_AXIS, LEFT, thick, 0);
+      m.add_at_edge (X_AXIS, LEFT, thin, kern);
     }
   else if (str == ".|" || (h == 0 && str == "|:"))
     {
-      m.add_at_edge (X_AXIS, RIGHT, thick, 0, 0);
-      m.add_at_edge (X_AXIS, RIGHT, thin, kern, 0);
+      m.add_at_edge (X_AXIS, RIGHT, thick, 0);
+      m.add_at_edge (X_AXIS, RIGHT, thin, kern);
     }
   else if (str == ":|")
     {
-      m.add_at_edge (X_AXIS, LEFT, thick, 0, 0);
-      m.add_at_edge (X_AXIS, LEFT, thin, kern, 0);
-      m.add_at_edge (X_AXIS, LEFT, colon, kern, 0);      
+      m.add_at_edge (X_AXIS, LEFT, thick, 0);
+      m.add_at_edge (X_AXIS, LEFT, thin, kern);
+      m.add_at_edge (X_AXIS, LEFT, colon, kern);
     }
   else if (str == "|:")
     {
-      m.add_at_edge (X_AXIS, RIGHT, thick, 0, 0);
-      m.add_at_edge (X_AXIS, RIGHT, thin, kern, 0);
-      m.add_at_edge (X_AXIS, RIGHT, colon, kern, 0);      
+      m.add_at_edge (X_AXIS, RIGHT, thick, 0);
+      m.add_at_edge (X_AXIS, RIGHT, thin, kern);
+      m.add_at_edge (X_AXIS, RIGHT, colon, kern);
     }
   else if (str == ":|:")
     {
-      m.add_at_edge (X_AXIS, LEFT, thick, thinkern, 0);
-      m.add_at_edge (X_AXIS, LEFT, colon, kern, 0);
-      m.add_at_edge (X_AXIS, RIGHT, thick, kern, 0);
-      m.add_at_edge (X_AXIS, RIGHT, colon, kern, 0);      
+      m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
+      m.add_at_edge (X_AXIS, LEFT, colon, kern);
+      m.add_at_edge (X_AXIS, RIGHT, thick, kern);
+      m.add_at_edge (X_AXIS, RIGHT, colon, kern);
+    }
+  else if (str == ":|.|:")
+    {
+      m.add_at_edge (X_AXIS, LEFT, thick, 0);
+      m.add_at_edge (X_AXIS, LEFT, thin, kern);
+      m.add_at_edge (X_AXIS, LEFT, colon, kern);
+      m.add_at_edge (X_AXIS, RIGHT, thin, kern);
+      m.add_at_edge (X_AXIS, RIGHT, colon, kern);
+
+    }
+  else if (str == ":|.:")
+    {
+      m.add_at_edge (X_AXIS, LEFT, thick, 0);
+      m.add_at_edge (X_AXIS, LEFT, thin, kern);
+      m.add_at_edge (X_AXIS, LEFT, colon, kern);
+      m.add_at_edge (X_AXIS, RIGHT, colon, kern);
     }
   else if (str == ".|.")
     {
-      m.add_at_edge (X_AXIS, LEFT, thick, thinkern, 0);
-      m.add_at_edge (X_AXIS, RIGHT, thick, kern, 0);
+      m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
+      m.add_at_edge (X_AXIS, RIGHT, thick, kern);
+    }
+  else if (str == "|.|")
+    {
+      m.add_at_edge (X_AXIS, LEFT, thick, 0);
+      m.add_at_edge (X_AXIS, LEFT, thin, kern);
+      m.add_at_edge (X_AXIS, RIGHT, thin, kern);
     }
   else if (str == "||")
     {
@@ -120,102 +178,190 @@ Bar_line::compound_barline (Grob*me, String str, Real h)
        should align to other side? this never appears
        on the system-start?
       */
-      m.add_at_edge (X_AXIS, RIGHT, thin, 0, 0);
-      m.add_at_edge (X_AXIS, RIGHT, thin, thinkern, 0);
+      m.add_at_edge (X_AXIS, RIGHT, thin, 0);
+      m.add_at_edge (X_AXIS, RIGHT, thin, thinkern);
     }
   else if (str == ":")
     {
       int c = (Staff_symbol_referencer::line_count (me));
-      
-      for (int i = 0 ; i < c - 1; i++)
+
+      for (int i = 0; i < c - 1; i++)
        {
-         Real y = (- (c-1.0) / 2 + 0.5  +   i * staff_space);
+         Real y = (- (c - 1.0) / 2 + 0.5 + i) * staff_space;
          Stencil d (dot);
 
-         d. translate_axis (y,Y_AXIS);
+         d.translate_axis (y, Y_AXIS);
          m.add_stencil (d);
        }
     }
+  else if (str == "dashed")
+    {
+      m = dashed_bar_line (me, h, hair);
+    }
+  else if (str == ".")
+    {
+      m = dot;
+    }
+
+  m.translate_axis (center, Y_AXIS);
   return m;
 }
 
 Stencil
-Bar_line::simple_barline (Grob *me,Real w, Real h) 
+Bar_line::simple_barline (Grob *me,
+                         Real w,
+                         Real h,
+                         bool rounded)
 {
-  Real blot = me->get_paper ()->get_dimension (ly_symbol2scm ("blotdiameter"));
-  return Lookup::round_filled_box (Box (Interval (0,w), Interval (-h/2, h/2)), blot);
-}
+  Real blot
+    = rounded
+    ? me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"))
+    : 0.0;
 
-MAKE_SCHEME_CALLBACK (Bar_line,before_line_breaking ,1);
+  return Lookup::round_filled_box (Box (Interval (0, w),
+                                       Interval (-h / 2, h / 2)), blot);
+}
 
+MAKE_SCHEME_CALLBACK (Bar_line, calc_bar_size, 1);
 SCM
-Bar_line::before_line_breaking (SCM smob)
+Bar_line::calc_bar_size (SCM smob)
 {
-  Grob*me=unsmob_grob (smob);
-  Item * item = dynamic_cast<Item*> (me);
-  
-  SCM g = me->get_property ("glyph");
-  SCM orig = g;
-  Direction bsd = item->break_status_dir ();
-  if (ly_c_string_p (g) && bsd)
+  Grob *me = unsmob_grob (smob);
+  if (Grob *staff = Staff_symbol_referencer::get_staff_symbol (me))
     {
-      SCM proc = me->get_property ("break-glyph-function");
-      g = scm_call_2 (proc, g, scm_int2num (bsd));
+      Interval staff_y = staff->extent (staff, Y_AXIS);
+      return scm_from_double (staff_y.is_empty () ? 0.0 : staff_y.length ());
     }
-  
-  if (!ly_c_string_p (g))
-    {
-      me->set_property ("print-function", SCM_EOL);
-      me->set_extent (SCM_EOL, X_AXIS);
-      // leave y_extent for spanbar? 
-    }
-
-  if (! ly_c_equal_p (g, orig))
-    me->set_property ("glyph", g);
-
-  return SCM_UNSPECIFIED;
+  return scm_from_int (0);
 }
-  
-
 
 
-MAKE_SCHEME_CALLBACK (Bar_line,get_staff_bar_size,1);
-SCM
-Bar_line::get_staff_bar_size (SCM smob) 
+Stencil
+Bar_line::dashed_bar_line (Grob *me, Real h, Real thick)
 {
-  Grob*me = unsmob_grob (smob);
+  Real dash_size
+    = 1.0 - robust_scm2double (me->get_property ("gap"), 0.3);
+  /*
+    this is a tad complex for what we want to achieve, but with a
+    simple line, the round blotting interferes with staff line
+    connections.
+      */
   Real ss = Staff_symbol_referencer::staff_space (me);
-  SCM size = me->get_property ("bar-size");
-  if (ly_c_number_p (size))
-    return scm_make_real (ly_scm2double (size)*ss);
-  else if (Staff_symbol_referencer::get_staff_symbol (me))
+  int count = Staff_symbol_referencer::line_count (me);
+      Real line_thick = Staff_symbol_referencer::line_thickness (me);
+
+  if (fabs (line_thick + (count -1) * ss - h) <   0.1) // ugh.
     {
-      /*
-       If there is no staff-symbol, we get -1 from the next
-       calculation. That's a nonsense value, which would collapse the
-       barline so we return 0.0 in the next alternative.
-      */
-      return scm_make_real ((Staff_symbol_referencer::line_count (me) -1) * ss);
+      Real blot = 
+       me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
+
+      Real half_space = ss/2;
+      Stencil bar;
+  
+      for (int i = (count-1); i >= -(count-1); i -= 2)
+       {
+         Real top_y = min ((i + dash_size) * half_space,
+                           (count-1) * half_space +  line_thick / 2);
+         Real bot_y = max ((i - dash_size) * half_space,
+                           -(count-1) * half_space - line_thick/2);
+
+         bar.add_stencil (Lookup::round_filled_box (Box (Interval (0, thick),
+                                                         Interval (bot_y, top_y)),
+                                                    blot));
+       }
+      return bar;
     }
   else
-    return scm_int2num (0);
+    {
+      /*
+       We have to scale the dashing so it starts and ends with half a
+       dash exactly.
+       */
+      int dashes = int (rint (h / ss));
+      Real total_dash_size = h / dashes;
+      Real factor = (dash_size - thick) / ss;
+      
+      SCM at = scm_list_n (ly_symbol2scm ("dashed-line"),
+                          scm_from_double (thick),
+                          scm_from_double (factor * total_dash_size),
+                          scm_from_double ((1-factor) * total_dash_size),
+                          scm_from_double (0),
+                          scm_from_double (h),
+                          scm_from_double (factor * total_dash_size * 0.5),
+                          SCM_UNDEFINED);
+
+      Box box;
+      box.add_point (Offset (0, 0));
+      box.add_point (Offset (0, h));
+
+      Stencil s (box, at);
+      s.translate (Offset (thick/2, -h/2));
+      return s;
+    }
+  return Stencil ();
 }
 
+MAKE_SCHEME_CALLBACK (Bar_line, calc_anchor, 1)
+SCM
+Bar_line::calc_anchor (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  Real kern = robust_scm2double (me->get_property ("kern"), 1);
+  Real staffline = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+  string str = robust_scm2string (me->get_property ("glyph-name"), "");
+
+  /* we put the anchor in the center of the barline, unless we are
+     a repeat bar, in which case we put the anchor in the center of
+     the barline without the dots. */
+  Interval ext = me->extent (me, X_AXIS);
+  if (ext.is_empty ())
+    return scm_from_double (0);
+
+  Real anchor = ext.center ();
+
+  Stencil dot = Font_interface::get_default_font (me)->find_by_name ("dots.dot");
+  Real dot_width = dot.extent (X_AXIS).length () + kern * staffline;
+  if (str == "|:")
+    anchor -= dot_width / 2;
+  else if (str == ":|")
+    anchor += dot_width / 2;
+
+  return scm_from_double (anchor);
+}
+
+ADD_INTERFACE (Bar_line,
+              "Bar line.\n"
+              "\n"
+              "Print a special bar symbol.  It replaces the regular bar"
+              " symbol with a special symbol.  The argument @var{bartype}"
+              " is a string which specifies the kind of bar to print."
+              "  Options are @code{:|}, @code{|:}, @code{:|:}, @code{||},"
+              " @code{|.}, @code{.|}, and @code{.|.}.\n"
+              "\n"
+              "These produce, respectively, a right repeat, a left repeat,"
+              " a double repeat, a double bar, a start bar, an end bar, and"
+              " a thick double bar.  In addition, there is an option"
+              " @code{||:} which is equivalent to @code{|:} except at line"
+              " breaks, where it produces a double bar (@code{||}) at the"
+              " end of the line and a repeat sign (@code{|:}) at the"
+              " beginning of the new line.\n"
+              "\n"
+              "If @var{bartype} is set to @code{empty} then nothing is"
+              " printed, but a line break is allowed at that spot.\n"
+              "\n"
+              "@code{gap} is used for the gaps in dashed barlines.",
+
+              /* properties */
+              "allow-span-bar "
+              "gap "
+              "kern "
+              "thin-kern "
+              "hair-thickness "
+              "thick-thickness "
+              "glyph "
+              "glyph-name "
+              "bar-size "
+              "bar-extent "
+              );
 
 
-ADD_INTERFACE (Bar_line, "bar-line-interface",
-  "Bar line.\n"
-"\n"
-"Print a special bar symbol. It replaces the \n"
-"regular bar symbol with a special\n"
-"symbol.  The argument @var{bartype} is a string which specifies the\n"
-"kind of bar to print.  Options are @code{:|},\n"
-"@code{|:}, @code{:|:},\n"
-"@code{||}, @code{|.},\n"
-"@code{.|}, and @code{.|.}. \n"
-"\n"
-"These produce, respectively, a right repeat, a left repeat, a double\n"
-"repeat, a double bar, a start bar, an end bar, and a thick double bar.\n"
-"If @var{bartype} is set to @code{empty} then nothing is printed,\n"
-"but a line break is allowed at that spot.\n",
-  "bar-size-procedure kern thin-kern hair-thickness thick-thickness glyph bar-size break-glyph-function");