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--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "bar-line.hh"
  10
  11 #include "all-font-metrics.hh"
  12 #include "font-interface.hh"
  13 #include "lookup.hh"
  14 #include "output-def.hh"
  15 #include "paper-column.hh"
  16 #include "staff-symbol-referencer.hh"
  17 #include "line-interface.hh"
  18
  19 MAKE_SCHEME_CALLBACK (Bar_line, calc_bar_extent, 1)
  20 SCM
  21 Bar_line::calc_bar_extent (SCM smob)
  22 {
  23   Grob *me = unsmob_grob (smob);
  24
  25   SCM size = me->get_property ("bar-size");
  26
  27   if (!scm_is_number (size)
  28       || !Staff_symbol_referencer::get_staff_symbol (me))
  29     return ly_interval2scm (Interval ());
  30
  31   Real h = scm_to_double (size);
  32   return ly_interval2scm (Interval (-h/2, h/2));
  33 }
  34
  35 Interval
  36 Bar_line::bar_y_extent (Grob *me, Grob *refpoint)
  37 {
  38   Interval iv = robust_scm2interval (me->get_property ("bar-extent"), Interval ());
  39
  40   iv.translate (me->relative_coordinate (refpoint, Y_AXIS));
  41   return iv;
  42 }
  43
  44 MAKE_SCHEME_CALLBACK (Bar_line, print, 1);
  45 SCM
  46 Bar_line::print (SCM smob)
  47 {
  48   Grob *me = unsmob_grob (smob);
  49
  50   SCM s = me->get_property ("glyph-name");
  51   SCM barsize = me->get_property ("bar-size");
  52
  53   if (scm_is_string (s) && scm_is_number (barsize))
  54     {
  55       string str = ly_scm2string (s);
  56       Real sz = robust_scm2double (barsize, 0);
  57       if (sz <= 0)
  58         return SCM_EOL;
  59
  60       return compound_barline (me, str, sz, false).smobbed_copy ();
  61     }
  62   return SCM_EOL;
  63 }
  64
  65 Stencil
  66 Bar_line::compound_barline (Grob *me, string str, Real h,
  67                             bool rounded)
  68 {
  69   Real kern = robust_scm2double (me->get_property ("kern"), 1);
  70   Real thinkern = robust_scm2double (me->get_property ("thin-kern"), 1);
  71   Real hair = robust_scm2double (me->get_property ("hair-thickness"), 1);
  72   Real fatline = robust_scm2double (me->get_property ("thick-thickness"), 1);
  73
  74   Real staffline = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
  75   Real staff_space = Staff_symbol_referencer::staff_space (me);
  76
  77   kern *= staffline;
  78   thinkern *= staffline;
  79   hair *= staffline;
  80   fatline *= staffline;
  81
  82   Stencil thin = simple_barline (me, hair, h, rounded);
  83   Stencil thick = simple_barline (me, fatline, h, rounded);
  84   Stencil dot = Font_interface::get_default_font (me)->find_by_name ("dots.dot");
  85
  86   int lines = Staff_symbol_referencer::line_count (me);
  87   Real dist
  88     = ((lines & 1 || lines == 0)
  89        ? 1
  90        : (staff_space < 2 ? 2 : .5)) * staff_space;
  91   Stencil colon (dot);
  92   colon.translate_axis (dist, Y_AXIS);
  93   colon.add_stencil (dot);
  94   colon.translate_axis (-dist / 2, Y_AXIS);
  95
  96   Stencil m;
  97   Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
  98   Real center = 0;
  99   if (staff)
 100     {
 101       Interval staff_extent = staff->extent (staff, Y_AXIS);
 102       center = staff_extent.center ();
 103     }
 104
 105   if (str == "||:")
 106     str = "|:";
 107
 108   if (str == "")
 109     {
 110       Stencil empty =  Lookup::blank (Box (Interval (0, 0), Interval (-h / 2, h / 2)));
 111       empty.translate_axis (center, Y_AXIS);
 112       return empty;
 113     }
 114   else if (str == "|")
 115     {
 116       thin.translate_axis (center, Y_AXIS);
 117       return thin;
 118     }
 119   else if (str == "|." || (h == 0 && str == ":|"))
 120     {
 121       m.add_at_edge (X_AXIS, LEFT, thick, 0);
 122       m.add_at_edge (X_AXIS, LEFT, thin, kern);
 123     }
 124   else if (str == ".|" || (h == 0 && str == "|:"))
 125     {
 126       m.add_at_edge (X_AXIS, RIGHT, thick, 0);
 127       m.add_at_edge (X_AXIS, RIGHT, thin, kern);
 128     }
 129   else if (str == ":|")
 130     {
 131       m.add_at_edge (X_AXIS, LEFT, thick, 0);
 132       m.add_at_edge (X_AXIS, LEFT, thin, kern);
 133       m.add_at_edge (X_AXIS, LEFT, colon, kern);
 134     }
 135   else if (str == "|:")
 136     {
 137       m.add_at_edge (X_AXIS, RIGHT, thick, 0);
 138       m.add_at_edge (X_AXIS, RIGHT, thin, kern);
 139       m.add_at_edge (X_AXIS, RIGHT, colon, kern);
 140     }
 141   else if (str == ":|:")
 142     {
 143       m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
 144       m.add_at_edge (X_AXIS, LEFT, colon, kern);
 145       m.add_at_edge (X_AXIS, RIGHT, thick, kern);
 146       m.add_at_edge (X_AXIS, RIGHT, colon, kern);
 147     }
 148   else if (str == ":|.|:")
 149     {
 150       m.add_at_edge (X_AXIS, LEFT, thick, 0);
 151       m.add_at_edge (X_AXIS, LEFT, thin, kern);
 152       m.add_at_edge (X_AXIS, LEFT, colon, kern);
 153       m.add_at_edge (X_AXIS, RIGHT, thin, kern);
 154       m.add_at_edge (X_AXIS, RIGHT, colon, kern);
 155
 156     }
 157   else if (str == ":|.:")
 158     {
 159       m.add_at_edge (X_AXIS, LEFT, thick, 0);
 160       m.add_at_edge (X_AXIS, LEFT, thin, kern);
 161       m.add_at_edge (X_AXIS, LEFT, colon, kern);
 162       m.add_at_edge (X_AXIS, RIGHT, colon, kern);
 163     }
 164   else if (str == ".|.")
 165     {
 166       m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
 167       m.add_at_edge (X_AXIS, RIGHT, thick, kern);
 168     }
 169   else if (str == "|.|")
 170     {
 171       m.add_at_edge (X_AXIS, LEFT, thick, 0);
 172       m.add_at_edge (X_AXIS, LEFT, thin, kern);
 173       m.add_at_edge (X_AXIS, RIGHT, thin, kern);
 174     }
 175   else if (str == "||")
 176     {
 177       /*
 178         should align to other side? this never appears
 179         on the system-start?
 180       */
 181       m.add_at_edge (X_AXIS, RIGHT, thin, 0);
 182       m.add_at_edge (X_AXIS, RIGHT, thin, thinkern);
 183     }
 184   else if (str == ":")
 185     {
 186       int c = (Staff_symbol_referencer::line_count (me));
 187
 188       for (int i = 0; i < c - 1; i++)
 189         {
 190           Real y = (- (c - 1.0) / 2 + 0.5 + i) * staff_space;
 191           Stencil d (dot);
 192
 193           d.translate_axis (y, Y_AXIS);
 194           m.add_stencil (d);
 195         }
 196     }
 197   else if (str == "dashed")
 198     {
 199       m = dashed_bar_line (me, h, hair);
 200     }
 201   else if (str == ".")
 202     {
 203       m = dot;
 204     }
 205
 206   m.translate_axis (center, Y_AXIS);
 207   return m;
 208 }
 209
 210 Stencil
 211 Bar_line::simple_barline (Grob *me,
 212                           Real w,
 213                           Real h,
 214                           bool rounded)
 215 {
 216   Real blot
 217     = rounded
 218     ? me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"))
 219     : 0.0;
 220
 221   return Lookup::round_filled_box (Box (Interval (0, w),
 222                                         Interval (-h / 2, h / 2)), blot);
 223 }
 224
 225 MAKE_SCHEME_CALLBACK (Bar_line, calc_bar_size, 1);
 226 SCM
 227 Bar_line::calc_bar_size (SCM smob)
 228 {
 229   Grob *me = unsmob_grob (smob);
 230   if (Grob *staff = Staff_symbol_referencer::get_staff_symbol (me))
 231     {
 232       Interval staff_y = staff->extent (staff, Y_AXIS);
 233       return scm_from_double (staff_y.is_empty () ? 0.0 : staff_y.length ());
 234     }
 235   return scm_from_int (0);
 236 }
 237
 238
 239 Stencil
 240 Bar_line::dashed_bar_line (Grob *me, Real h, Real thick)
 241 {
 242   Real dash_size
 243     = 1.0 - robust_scm2double (me->get_property ("gap"), 0.3);
 244   /*
 245     this is a tad complex for what we want to achieve, but with a
 246     simple line, the round blotting interferes with staff line
 247     connections.
 248       */
 249   Real ss = Staff_symbol_referencer::staff_space (me);
 250   int count = Staff_symbol_referencer::line_count (me);
 251       Real line_thick = Staff_symbol_referencer::line_thickness (me);
 252
 253   if (fabs (line_thick + (count -1) * ss - h) <   0.1) // ugh.
 254     {
 255       Real blot =
 256         me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
 257
 258       Real half_space = ss/2;
 259       Stencil bar;
 260
 261       for (int i = (count-1); i >= -(count-1); i -= 2)
 262         {
 263           Real top_y = min ((i + dash_size) * half_space,
 264                             (count-1) * half_space +  line_thick / 2);
 265           Real bot_y = max ((i - dash_size) * half_space,
 266                             -(count-1) * half_space - line_thick/2);
 267
 268           bar.add_stencil (Lookup::round_filled_box (Box (Interval (0, thick),
 269                                                           Interval (bot_y, top_y)),
 270                                                      blot));
 271         }
 272       return bar;
 273     }
 274   else
 275     {
 276       /*
 277         We have to scale the dashing so it starts and ends with half a
 278         dash exactly.
 279        */
 280       int dashes = int (rint (h / ss));
 281       Real total_dash_size = h / dashes;
 282       Real factor = (dash_size - thick) / ss;
 283
 284       SCM at = scm_list_n (ly_symbol2scm ("dashed-line"),
 285                            scm_from_double (thick),
 286                            scm_from_double (factor * total_dash_size),
 287                            scm_from_double ((1-factor) * total_dash_size),
 288                            scm_from_double (0),
 289                            scm_from_double (h),
 290                            scm_from_double (factor * total_dash_size * 0.5),
 291                            SCM_UNDEFINED);
 292
 293       Box box;
 294       box.add_point (Offset (0, 0));
 295       box.add_point (Offset (0, h));
 296
 297       Stencil s (box, at);
 298       s.translate (Offset (thick/2, -h/2));
 299       return s;
 300     }
 301   return Stencil ();
 302 }
 303
 304 MAKE_SCHEME_CALLBACK (Bar_line, calc_anchor, 1)
 305 SCM
 306 Bar_line::calc_anchor (SCM smob)
 307 {
 308   Grob *me = unsmob_grob (smob);
 309   Real kern = robust_scm2double (me->get_property ("kern"), 1);
 310   Real staffline = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
 311   string str = robust_scm2string (me->get_property ("glyph-name"), "");
 312
 313   /* we put the anchor in the center of the barline, unless we are
 314      a repeat bar, in which case we put the anchor in the center of
 315      the barline without the dots. */
 316   Interval ext = me->extent (me, X_AXIS);
 317   if (ext.is_empty ())
 318     return scm_from_double (0);
 319
 320   Real anchor = ext.center ();
 321
 322   Stencil dot = Font_interface::get_default_font (me)->find_by_name ("dots.dot");
 323   Real dot_width = dot.extent (X_AXIS).length () + kern * staffline;
 324   if (str == "|:")
 325     anchor -= dot_width / 2;
 326   else if (str == ":|")
 327     anchor += dot_width / 2;
 328
 329   return scm_from_double (anchor);
 330 }
 331
 332 ADD_INTERFACE (Bar_line,
 333                "Bar line.\n"
 334                "\n"
 335                "Print a special bar symbol.  It replaces the regular bar"
 336                " symbol with a special symbol.  The argument @var{bartype}"
 337                " is a string which specifies the kind of bar line to print."
 338                "  Options are @code{:|}, @code{|:}, @code{:|:}, @code{:|.|:},"
 339                " @code{:|.:}, @code{||}, @code{|.}, @code{.|}, @code{.|.},"
 340                " @code{|.|}, @code{:} and @code{dashed}.\n"
 341                "\n"
 342                "These produce, respectively, a right repeat, a left repeat,"
 343                " a thick double repeat, a thin-thick-thin double repeat,"
 344                " a thin-thick double repeat, a double bar, a start bar,"
 345                " an end bar, a thick double bar, a thin-thick-thin bar,"
 346                " a dotted bar and a dashed bar."
 347                "  In addition, there is an option"
 348                " @code{||:} which is equivalent to @code{|:} except at line"
 349                " breaks, where it produces a double bar (@code{||}) at the"
 350                " end of the line and a repeat sign (@code{|:}) at the"
 351                " beginning of the new line.\n"
 352                "\n"
 353                "If @var{bartype} is set to @code{empty} then nothing is"
 354                " printed, but a line break is allowed at that spot.\n"
 355                "\n"
 356                "@code{gap} is used for the gaps in dashed bar lines.",
 357
 358                /* properties */
 359                "allow-span-bar "
 360                "gap "
 361                "kern "
 362                "thin-kern "
 363                "hair-thickness "
 364                "thick-thickness "
 365                "glyph "
 366                "glyph-name "
 367                "bar-size "
 368                "bar-extent "
 369                );