]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/bar-line.cc
Web-ja: update introduction
[lilypond.git] / lily / bar-line.cc
index c9d9159a4cfff26591f12404053947c623ef6cba..e378f3b22c1b878841931b508619188279fcd200 100644 (file)
 /*
-  bar-line.cc -- implement Bar_line
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "bar-line.hh"
-
-#include "all-font-metrics.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");
-
-  if (!scm_is_number (size)
-      || !Staff_symbol_referencer::get_staff_symbol (me))
-    return ly_interval2scm (Interval ());
-
-  Real h = scm_to_double (size);
-  return ly_interval2scm (Interval (-h/2, h/2));
-}
-
-Interval
-Bar_line::bar_y_extent (Grob *me, Grob *refpoint)
-{
-  Interval iv = robust_scm2interval (me->get_property ("bar-extent"), Interval ());
-
-  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);
-      Real sz = robust_scm2double (barsize, 0);
-      if (sz <= 0)
-       return SCM_EOL;
-
-      return compound_barline (me, str, sz, false).smobbed_copy ();
-    }
-  return SCM_EOL;
-}
-
-Stencil
-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->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, 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.add_stencil (dot);
-  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 == "")
-    {
-      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);
-      m.add_at_edge (X_AXIS, LEFT, thin, kern);
-    }
-  else if (str == ".|" || (h == 0 && str == "|:"))
-    {
-      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);
-      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);
-      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);
-      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);
-      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 == "||")
-    {
-      /*
-       should align to other side? this never appears
-       on the system-start?
-      */
-      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++)
-       {
-         Real y = (- (c - 1.0) / 2 + 0.5 + i) * staff_space;
-         Stencil d (dot);
-
-         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 = tick_bar_line (me, h, rounded);
-    }
-  else if (str == ".")
-    {
-      m = dot;
-    }
 
-  m.translate_axis (center, Y_AXIS);
-  return m;
-}
-
-Stencil
-Bar_line::simple_barline (Grob *me,
-                         Real w,
-                         Real h,
-                         bool rounded)
-{
-  Real blot
-    = rounded
-    ? me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"))
-    : 0.0;
-
-  return Lookup::round_filled_box (Box (Interval (0, w),
-                                       Interval (-h / 2, h / 2)), blot);
-}
-
-Stencil
-Bar_line::tick_bar_line (Grob *me, Real h, bool rounded)
-{
-  Real th = Staff_symbol_referencer::staff_space (me) / 2;
-  Real line_thick = Staff_symbol_referencer::line_thickness (me);
-
-  Real blot
-    = rounded
-    ? me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"))
-    : 0.0;
-
-  return Lookup::round_filled_box (Box (Interval (0, line_thick),
-                                        Interval (h / 2 - th, h / 2 + th)), blot);
-}
-
-
-MAKE_SCHEME_CALLBACK (Bar_line, calc_bar_size, 1);
-SCM
-Bar_line::calc_bar_size (SCM smob)
-{
-  Grob *me = unsmob_grob (smob);
-  if (Grob *staff = Staff_symbol_referencer::get_staff_symbol (me))
-    {
-      Interval staff_y = staff->extent (staff, Y_AXIS);
-      return scm_from_double (staff_y.is_empty () ? 0.0 : staff_y.length ());
-    }
-  return scm_from_int (0);
-}
-
-
-Stencil
-Bar_line::dashed_bar_line (Grob *me, Real h, Real thick)
+bool
+Bar_line::non_empty_barline (Grob *me)
 {
-  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);
-  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.
-    {
-      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
-    {
-      /*
-       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 ();
+  return me->internal_has_interface (ly_symbol2scm ("bar-line-interface"))
+         && !me->extent (me, X_AXIS).is_empty ();
 }
-
-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 line to print."
-              "  Options are @code{:|}, @code{|:}, @code{:|:}, @code{:|.|:},"
-              " @code{:|.:}, @code{||}, @code{|.}, @code{.|}, @code{.|.},"
-              " @code{|.|}, @code{:} and @code{dashed}.\n"
-              "\n"
-              "These produce, respectively, a right repeat, a left repeat,"
-              " a thick double repeat, a thin-thick-thin double repeat,"
-              " a thin-thick double repeat, a double bar, a start bar,"
-              " an end bar, a thick double bar, a thin-thick-thin bar,"
-              " a dotted bar and a dashed 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 bar lines.",
-
-              /* properties */
-              "allow-span-bar "
-              "gap "
-              "kern "
-              "thin-kern "
-              "hair-thickness "
-              "thick-thickness "
-              "glyph "
-              "glyph-name "
-              "bar-size "
-              "bar-extent "
-              );