lily/bar-line.cc

   1 /*
   2   bar.cc -- implement Bar
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include <math.h>
  10
  11 #include "bar-line.hh"
  12 #include "lookup.hh"
  13 #include "paper-column.hh"
  14 #include "output-def.hh"
  15 #include "font-interface.hh"
  16 #include "all-font-metrics.hh"
  17 #include "staff-symbol-referencer.hh"
  18
  19 MAKE_SCHEME_CALLBACK (Bar_line, print, 1);
  20
  21 SCM
  22 Bar_line::print (SCM smob)
  23 {
  24   Grob *me = unsmob_grob (smob);
  25
  26   SCM s = me->get_property ("glyph");
  27   SCM barsiz_proc = me->get_property ("bar-size-procedure");
  28   if (scm_is_string (s) && ly_c_procedure_p (barsiz_proc))
  29     {
  30       String str = ly_scm2string (s);
  31       SCM siz = scm_call_1 (barsiz_proc, me->self_scm ());
  32       Real sz = robust_scm2double (siz, 0);
  33       if (sz <= 0)
  34         return SCM_EOL;
  35
  36       return compound_barline (me, str, sz).smobbed_copy ();
  37     }
  38   return SCM_EOL;
  39 }
  40
  41 Stencil
  42 Bar_line::compound_barline (Grob *me, String str, Real h)
  43 {
  44   Real kern = robust_scm2double (me->get_property ("kern"), 1);
  45   Real thinkern = robust_scm2double (me->get_property ("thin-kern"), 1);
  46   Real hair = robust_scm2double (me->get_property ("hair-thickness"), 1);
  47   Real fatline = robust_scm2double (me->get_property ("thick-thickness"), 1);
  48
  49   Real staffline = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
  50   Real staff_space = Staff_symbol_referencer::staff_space (me);
  51
  52   kern *= staffline;
  53   thinkern *= staffline;
  54   hair *= staffline;
  55   fatline *= staffline;
  56
  57   Stencil thin = simple_barline (me, hair, h);
  58   Stencil thick = simple_barline (me, fatline, h);
  59   Stencil dot = Font_interface::get_default_font (me)->find_by_name ("dots.dot");
  60
  61   int lines = Staff_symbol_referencer::line_count (me);
  62   Real dist
  63     = ((lines & 1 || lines == 0)
  64        ? 1
  65        : (staff_space < 2 ? 2 : .5)) * staff_space;
  66   Stencil colon (dot);
  67   colon.translate_axis (dist, Y_AXIS);
  68   colon.add_stencil (dot);
  69   colon.translate_axis (-dist / 2, Y_AXIS);
  70
  71   Stencil m;
  72   if (str == "||:")
  73     str = "|:";
  74
  75   if (str == "")
  76     {
  77       return Lookup::blank (Box (Interval (0, 0), Interval (-h / 2, h / 2)));
  78     }
  79   else if (str == "|")
  80     {
  81       return thin;
  82     }
  83   else if (str == "|." || (h == 0 && str == ":|"))
  84     {
  85       m.add_at_edge (X_AXIS, LEFT, thick, 0, 0);
  86       m.add_at_edge (X_AXIS, LEFT, thin, kern, 0);
  87     }
  88   else if (str == ".|" || (h == 0 && str == "|:"))
  89     {
  90       m.add_at_edge (X_AXIS, RIGHT, thick, 0, 0);
  91       m.add_at_edge (X_AXIS, RIGHT, thin, kern, 0);
  92     }
  93   else if (str == ":|")
  94     {
  95       m.add_at_edge (X_AXIS, LEFT, thick, 0, 0);
  96       m.add_at_edge (X_AXIS, LEFT, thin, kern, 0);
  97       m.add_at_edge (X_AXIS, LEFT, colon, kern, 0);
  98     }
  99   else if (str == "|:")
 100     {
 101       m.add_at_edge (X_AXIS, RIGHT, thick, 0, 0);
 102       m.add_at_edge (X_AXIS, RIGHT, thin, kern, 0);
 103       m.add_at_edge (X_AXIS, RIGHT, colon, kern, 0);
 104     }
 105   else if (str == ":|:")
 106     {
 107       m.add_at_edge (X_AXIS, LEFT, thick, thinkern, 0);
 108       m.add_at_edge (X_AXIS, LEFT, colon, kern, 0);
 109       m.add_at_edge (X_AXIS, RIGHT, thick, kern, 0);
 110       m.add_at_edge (X_AXIS, RIGHT, colon, kern, 0);
 111     }
 112   else if (str == ".|.")
 113     {
 114       m.add_at_edge (X_AXIS, LEFT, thick, thinkern, 0);
 115       m.add_at_edge (X_AXIS, RIGHT, thick, kern, 0);
 116     }
 117   else if (str == "||")
 118     {
 119       /*
 120         should align to other side? this never appears
 121         on the system-start?
 122       */
 123       m.add_at_edge (X_AXIS, RIGHT, thin, 0, 0);
 124       m.add_at_edge (X_AXIS, RIGHT, thin, thinkern, 0);
 125     }
 126   else if (str == ":")
 127     {
 128       int c = (Staff_symbol_referencer::line_count (me));
 129
 130       for (int i = 0; i < c - 1; i++)
 131         {
 132           Real y = (- (c - 1.0) / 2 + 0.5 + i * staff_space);
 133           Stencil d (dot);
 134
 135           d.translate_axis (y, Y_AXIS);
 136           m.add_stencil (d);
 137         }
 138     }
 139   return m;
 140 }
 141
 142 Stencil
 143 Bar_line::simple_barline (Grob *me,
 144                           Real w,
 145                           Real h)
 146 {
 147   Real blot = me->get_layout ()->get_dimension (ly_symbol2scm ("blotdiameter"));
 148
 149   return Lookup::round_filled_box (Box (Interval (0, w), Interval (-h / 2, h / 2)), blot);
 150 }
 151
 152 MAKE_SCHEME_CALLBACK (Bar_line, before_line_breaking, 1);
 153
 154 SCM
 155 Bar_line::before_line_breaking (SCM smob)
 156 {
 157   Grob *me = unsmob_grob (smob);
 158   Item *item = dynamic_cast<Item *> (me);
 159
 160   SCM g = me->get_property ("glyph");
 161   SCM orig = g;
 162   Direction bsd = item->break_status_dir ();
 163   if (scm_is_string (g) && bsd)
 164     {
 165       SCM proc = me->get_property ("break-glyph-function");
 166       g = scm_call_2 (proc, g, scm_int2num (bsd));
 167     }
 168
 169   if (!scm_is_string (g))
 170     {
 171       me->set_property ("print-function", SCM_EOL);
 172       me->set_extent (SCM_EOL, X_AXIS);
 173       // leave y_extent for spanbar?
 174     }
 175
 176   if (! ly_c_equal_p (g, orig))
 177     me->set_property ("glyph", g);
 178
 179   return SCM_UNSPECIFIED;
 180 }
 181
 182 MAKE_SCHEME_CALLBACK (Bar_line, get_staff_bar_size, 1);
 183 SCM
 184 Bar_line::get_staff_bar_size (SCM smob)
 185 {
 186   Grob *me = unsmob_grob (smob);
 187   Real ss = Staff_symbol_referencer::staff_space (me);
 188   SCM size = me->get_property ("bar-size");
 189   if (scm_is_number (size))
 190     return scm_make_real (scm_to_double (size) * ss);
 191   else if (Staff_symbol_referencer::get_staff_symbol (me))
 192     {
 193       /*
 194         If there is no staff-symbol, we get -1 from the next
 195         calculation. That's a nonsense value, which would collapse the
 196         barline so we return 0.0 in the next alternative.
 197       */
 198       Real ysize = (Staff_symbol_referencer::line_count (me) -1);
 199       ysize = ysize * ss + Staff_symbol_referencer::line_thickness (me);
 200       return scm_make_real (ysize);
 201     }
 202   else
 203     return scm_int2num (0);
 204 }
 205
 206 ADD_INTERFACE (Bar_line, "bar-line-interface",
 207                "Bar line.\n"
 208                "\n"
 209                "Print a special bar symbol. It replaces the \n"
 210                "regular bar symbol with a special\n"
 211                "symbol.  The argument @var{bartype} is a string which specifies the\n"
 212                "kind of bar to print.  Options are @code{:|}, \n"
 213                "@code{|:}, @code{:|:},\n"
 214                "@code{||}, @code{|.},\n"
 215                "@code{.|}, and @code{.|.}. \n"
 216                "\n"
 217                "These produce, respectively, a right repeat, a left repeat, a double\n"
 218                "repeat, a double bar, a start bar, an end bar, and a thick double bar.\n"
 219                "If @var{bartype} is set to @code{empty} then nothing is printed,\n"
 220                "but a line break is allowed at that spot.\n",
 221                "bar-size-procedure kern thin-kern hair-thickness thick-thickness glyph bar-size break-glyph-function");