]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/span-bar.cc
Imported Upstream version 2.14.2
[lilypond.git] / lily / span-bar.cc
index 858b67cb71346c50269076e56a8ecc611dadda57..00e22fb0855e016d3f1750369a26e64634fc5df9 100644 (file)
 /*
-  span-bar.cc -- implement Span_bar
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.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 "span-bar.hh"
-#include "lookup.hh"
+
+#include "font-interface.hh"
 #include "dimensions.hh"
+#include "output-def.hh"
+#include "stencil.hh"
+#include "warn.hh"
+#include "axis-group-interface.hh"
+#include "bar-line.hh"
+#include "grob.hh"
+#include "pointer-group-interface.hh"
+#include "staff-symbol-referencer.hh"
 
-#include "paper-def.hh"
-#include "molecule.hh"
-#include "align-element.hh"
 
 void
-Span_bar::add_bar (Bar*b)
+Span_bar::add_bar (Grob *me, Grob *b)
 {
-  spanning_l_arr_.push (b);
-  add_dependency (b);
+  Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), b);
 }
 
-void
-Span_bar::do_substitute_dependency (Score_element*o, Score_element*n)
-{
-  spanning_l_arr_.unordered_substitute (o, n);
-}
+MAKE_SCHEME_CALLBACK (Span_bar, print, 1);
 
-void
-Span_bar::set_align (Align_element *a)
-{
-  add_dependency (a);
-}
+/* Limitations/Bugs:
 
-Interval
-Span_bar::do_width () const
+(1) Elements from 'me->get_object ("elements")' must be
+ordered according to their y coordinates relative to their common
+axis group parent.  Otherwise, the computation goes mad.
+
+(2) This method depends on bar_engraver not being removed from
+staff context.  If bar_engraver is removed, the size of the staff
+lines is evaluated as 0, which results in a solid span bar line
+with faulty y coordinate. */
+
+/* This routine was originally by Juergen Reuter, but it was a on the
+   bulky side. Rewritten by Han-Wen. */
+SCM
+Span_bar::print (SCM smobbed_me)
 {
-  if (no_width_b_)
+  Grob *me = unsmob_grob (smobbed_me);
+  extract_grob_set (me, "elements", elements);
+  Grob *refp = common_refpoint_of_array (elements, me, Y_AXIS);
+
+  SCM glyph = me->get_property ("glyph-name");
+
+  /* glyph may not be a string, when ME is killed by Hara Kiri in
+     between. */
+  if (!scm_is_string (glyph))
+    return SCM_EOL;
+
+  string glyph_string = ly_scm2string (glyph);
+
+  /* compose span_bar_mol */
+  vector<Interval> extents;
+  vector<bool> make_span_bar;
+  Grob *model_bar = 0;
+  for (vsize i = elements.size (); i--;)
+    {
+      Grob *bar = elements[i];
+      Interval ext = Bar_line::bar_y_extent (bar, refp);
+      if (Grob *staff = Staff_symbol_referencer::get_staff_symbol (bar))
+       ext.unite (staff->extent (refp, Y_AXIS));
+      if (ext.is_empty ())
+       continue;
+
+      extents.push_back (ext);
+      make_span_bar.push_back (to_boolean (bar->get_property ("allow-span-bar")));
+      model_bar = bar;
+    }
+
+  if (!model_bar)
+    model_bar = me;
+
+  vector_sort (extents, Interval::left_less);
+
+  Stencil span_bar;
+  for (vsize i = 1; i < extents.size (); i++)
     {
-      return Interval (0,0);
+      Interval prev_extent = extents[i - 1];
+      Interval ext = extents[i];
+      if (!prev_extent.is_empty ())
+       {
+         Interval l (prev_extent [UP],
+                     ext[DOWN]);
+
+         if (l.is_empty () || !make_span_bar[i])
+           {
+             /* There is overlap between the bar lines.  Do nothing. */
+           }
+         else
+           {
+             Stencil interbar = Bar_line::compound_barline (model_bar,
+                                                            glyph_string,
+                                                            l,
+                                                            false);
+             span_bar.add_stencil (interbar);
+           }
+       }
+      prev_extent = ext;
     }
-  
-  Molecule m = lookup_l ()->bar (type_str_, 40 PT);
-  
-  return m.extent (X_AXIS);
+
+  span_bar.translate_axis (- me->relative_coordinate (refp, Y_AXIS),
+                          Y_AXIS);
+
+  return span_bar.smobbed_copy ();
 }
 
-void
-Span_bar::do_pre_processing ()
+MAKE_SCHEME_CALLBACK (Span_bar, width, 1);
+SCM
+Span_bar::width (SCM smob)
 {
-  Bar::do_pre_processing ();
-  
-  evaluate_empty ();
-  translate_axis (extra_x_off_, X_AXIS);
-  
-  dim_cache_[Y_AXIS].set_empty (false); // a hack to make mark scripts work.
+  Grob *me = unsmob_grob (smob);
+  SCM gn = me->get_property ("glyph-name");
+  if (!me->is_live ())
+    return ly_interval2scm (Interval ());
+
+  string gl = ly_scm2string (gn);
+
+  /*
+    urg.
+  */
+  Stencil m =
+    Bar_line::compound_barline (me, gl, Interval (-20 PT, 20 PT), false);
+
+  return ly_interval2scm (m.extent (X_AXIS));
 }
 
-void
-Span_bar::do_post_processing ()
+MAKE_SCHEME_CALLBACK (Span_bar, before_line_breaking, 1);
+SCM
+Span_bar::before_line_breaking (SCM smob)
 {
-  Bar::do_post_processing ();
+  Grob *me = unsmob_grob (smob);
+  extract_grob_set (me, "elements", elements);
+  if (elements.empty ())
+    me->suicide ();
+
+  return SCM_UNSPECIFIED;
 }
 
-void
-Span_bar::evaluate_empty ()
-{ 
-  if (spanning_l_arr_.size () < 1) 
-    {
-      transparent_b_ = true;
-      set_empty (true);   
-    }
-  if (type_str_.empty_b ()) 
-    {
-      transparent_b_=true;
-      set_empty (true);
-    }
-  else if (type_str_ == "|:") 
-    {
-      type_str_ = ".|";
-    }
-  else if (type_str_ == ":|")
-    {
-      type_str_ = "|.";
-    }
-  else if (type_str_ == ":|:")
+MAKE_SCHEME_CALLBACK (Span_bar, center_on_spanned_callback, 1);
+
+SCM
+Span_bar::center_on_spanned_callback (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  Interval i (get_spanned_interval (me));
+
+  /* Bar_line::print delivers a barline of y-extent (-h/2, h/2), so
+     we have to translate ourselves to be in the center of the
+     interval that we span. */
+  if (i.is_empty ())
     {
-      type_str_ = ".|.";
+      me->suicide ();
+      return scm_from_double (0.0);
     }
+
+  return scm_from_double (i.center ());
 }
 
-Interval
-Span_bar::get_spanned_interval () const
+
+
+MAKE_SCHEME_CALLBACK(Span_bar, calc_glyph_name, 1);
+SCM
+Span_bar::calc_glyph_name (SCM smob)
 {
-  Interval y_int;
-  for (int i=0; i < spanning_l_arr_.size (); i++) 
+  Grob *me = unsmob_grob (smob);
+  extract_grob_set (me, "elements", elements);
+  SCM gl = SCM_EOL;
+  for (vsize i = elements.size ();
+       i-- && !scm_is_string (gl);)
+    gl = elements[i]->get_property ("glyph-name");
+
+  if (!scm_is_string (gl))
     {
-      Dimension_cache*common = 
-       common_group (spanning_l_arr_[i], Y_AXIS);
-       
-      Real y = spanning_l_arr_[i]->dim_cache_[Y_AXIS].relative_coordinate (common)  
-       -dim_cache_[Y_AXIS].relative_coordinate (common);
-
-      y_int.unite (y + spanning_l_arr_[i]->extent(Y_AXIS));
+      me->suicide ();
+      return SCM_UNSPECIFIED;
     }
-  return y_int;
-}
 
-Interval
-Span_bar::do_height () const
-{
-  return get_spanned_interval ();
+  string type = ly_scm2string (gl);
+  if (type == "|:" || type == "||:")
+    type = ".|";
+  else if (type == ":|")
+    type = "|.";
+  else if (type == ":|:")
+    type = ".|.";
+  else if (type == ":|.|:")
+    type = "|.|";
+  else if (type == ":|.:")
+    type = "|.";
+  else if (type == "S" || type == "S|" || type == "|S")
+    type = "||";
+  else if (type == "S|:" || type == ".S|:")
+    type = ".|";
+  else if (type == ":|S" || type == ":|S.")
+    type = "|.";
+    else if (type == ":|S|:" || type == ":|S.|:")
+    type = "|._.|";
+  else if (type == "'")
+    type = "";
+
+  return ly_string2scm (type);
 }
 
-Molecule*
-Span_bar::do_brew_molecule_p () const
+Interval
+Span_bar::get_spanned_interval (Grob *me)
 {
-  Interval iv (get_spanned_interval ());
-  Molecule*output = new Molecule (lookup_l ()->bar (type_str_, iv.length ()));
-
-  output->translate_axis (iv.center (), Y_AXIS);
-  return output;
+  return ly_scm2interval (Axis_group_interface::generic_group_extent (me, Y_AXIS));
 }
 
+ADD_INTERFACE (Span_bar,
+              "A bar line that is spanned between other barlines.  This"
+              " interface is used for bar lines that connect different"
+              " staves.",
 
+              /* properties */
+              "glyph-name "
+              "elements "
+              "pure-Y-common "
+              "pure-relevant-grobs "
+              "pure-relevant-items "
+              "pure-relevant-spanners "
+              );
 
-Span_bar::Span_bar ()
-{
-  type_str_ = "";
-  extra_x_off_ = 0.0;
-  no_width_b_ = false;
-}