(Text markup): add note about

[lilypond.git] / lily / bar-line.cc

diff --git a/lily/bar-line.cc b/lily/bar-line.cc
index 5aac74183e60931d5d966f9ac066d1bb6c5d7d07..38af64a6bb19dad465c366ae36baaa0f7ee13902 100644 (file)
--- a/lily/bar-line.cc
+++ b/lily/bar-line.cc
@@ -3,8 +3,9 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
+
 #include <math.h>
 
 #include "lookup.hh"
@@ -16,7 +17,7 @@
 #include "molecule.hh"
 #include "paper-def.hh"
 #include "font-interface.hh"
-#include "debug.hh"
+
 #include "all-font-metrics.hh"
 #include "item.hh"
 #include "staff-symbol-referencer.hh"
@@ -52,10 +53,8 @@ Bar_line::compound_barline (Grob*me, String str, Real h)
   Real hair = gh_scm2double (me->get_grob_property ("hair-thickness"));
   Real fatline = gh_scm2double (me->get_grob_property ("thick-thickness"));
 
-  Real staffline = me->paper_l ()->get_var ("stafflinethickness");
+  Real staffline = me->get_paper ()->get_realvar (ly_symbol2scm ("linethickness"));
   Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real staffspace = me->paper_l ()->get_var ("staffspace")
-    * staff_space;
 
   kern *= staffline;
   thinkern *= staffline;
@@ -67,7 +66,7 @@ Bar_line::compound_barline (Grob*me, String str, Real h)
   Molecule colon;
   Molecule 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 ) * staffspace;
+               (staff_space<2 ? 2 : .5) ) * staff_space;
   dot.translate_axis(dist/2,Y_AXIS);
   colon.add_molecule(dot);
   dot.translate_axis(-dist,Y_AXIS);
@@ -85,48 +84,47 @@ Bar_line::compound_barline (Grob*me, String str, Real h)
     }
   else if (str == "|." || (h == 0 && 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, thick, 0, 0);      
+      m.add_at_edge (X_AXIS, LEFT, thin, kern,0 );
     }
   else if (str == ".|" || (h == 0 && str == "|:"))
     {
-      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, thick, 0, 0);
+      m.add_at_edge (X_AXIS, RIGHT, thin, kern, 0);
     }
   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, LEFT, thick, 0, 0);
+      m.add_at_edge (X_AXIS, LEFT, thin, kern, 0);
+      m.add_at_edge (X_AXIS, LEFT, colon, kern, 0);      
     }
   else if (str == "|:")
     {
-      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);      
+      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);      
     }
   else if (str == ":|:")
     {
-      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);      
+      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);      
     }
   else if (str == ".|.")
     {
-      m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
-      m.add_at_edge (X_AXIS, RIGHT, thick, kern);      
+      m.add_at_edge (X_AXIS, LEFT, thick, thinkern, 0);
+      m.add_at_edge (X_AXIS, RIGHT, thick, kern, 0);
     }
   else if (str == "||")
     {
-      m.add_at_edge (X_AXIS, RIGHT, thin, 0);
-      m.add_at_edge (X_AXIS, RIGHT, thin, thinkern);      
+      m.add_at_edge (X_AXIS, RIGHT, thin, 0, 0);
+      m.add_at_edge (X_AXIS, RIGHT, thin, thinkern, 0);
     }
 
   return m;
 }
 
-
 Molecule
 Bar_line::simple_barline (Grob*,Real w, Real h) 
 {
@@ -147,14 +145,13 @@ Bar_line::before_line_breaking (SCM smob)
   if (gh_string_p (g) && bsd)
     {
       SCM proc = me->get_grob_property ("break-glyph-function");
-      g = gh_call2 (proc, g, gh_int2scm (bsd));
+      g = gh_call2 (proc, g, scm_int2num (bsd));
     }
-
   
   if (!gh_string_p (g))
     {
       me->set_grob_property ("molecule-callback", SCM_EOL);
-      me->set_extent_callback (SCM_EOL, X_AXIS);
+      me->set_extent (SCM_EOL, X_AXIS);
       // leave y_extent for spanbar? 
     }
 
@@ -164,17 +161,7 @@ Bar_line::before_line_breaking (SCM smob)
   return SCM_UNSPECIFIED;
 }
   
-void
-Bar_line::set_interface (Grob*me)
-{
-  me->set_interface (ly_symbol2scm ("bar-line-interface"));
-}
 
-bool
-Bar_line::has_interface (Grob*m)
-{
-  return m && m->has_interface (ly_symbol2scm ("bar-line-interface"));
-}
 
 
 MAKE_SCHEME_CALLBACK (Bar_line,get_staff_bar_size,1);
@@ -186,7 +173,7 @@ Bar_line::get_staff_bar_size (SCM smob)
   SCM size = me->get_grob_property ("bar-size");
   if (gh_number_p (size))
     return gh_double2scm (gh_scm2double (size)*ss);
-  else if (Staff_symbol_referencer::staff_symbol_l (me))
+  else if (Staff_symbol_referencer::get_staff_symbol (me))
     {
       /*
        If there is no staff-symbol, we get -1 from the next
@@ -196,5 +183,24 @@ Bar_line::get_staff_bar_size (SCM smob)
       return gh_double2scm ((Staff_symbol_referencer::line_count (me) -1) * ss);
     }
   else
-    return gh_int2scm (0);
+    return scm_int2num (0);
 }
+
+
+
+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");