lily/bar-line.cc

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