/*
- 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--2000 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 "dimension-cache.hh"
+
#include "span-bar.hh"
-#include "lookup.hh"
+
+#include "font-interface.hh"
#include "dimensions.hh"
-#include "paper-def.hh"
-#include "molecule.hh"
-#include "align-element.hh"
+#include "output-def.hh"
+#include "stencil.hh"
#include "warn.hh"
-#include "group-interface.hh"
+#include "axis-group-interface.hh"
+#include "bar-line.hh"
+#include "grob.hh"
+#include "pointer-group-interface.hh"
+#include "staff-symbol-referencer.hh"
void
-Span_bar::add_bar (Score_element*b)
+Span_bar::add_bar (Grob *me, Grob *b)
{
- Group_interface gi (this);
- gi.add_element (b);
-
- add_dependency (b);
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), b);
}
+MAKE_SCHEME_CALLBACK (Span_bar, print, 1);
-Interval
-Span_bar::width_callback (Dimension_cache const * c)
-{
- Span_bar* s= dynamic_cast<Span_bar*> (c->element_l ());
- String gl = ly_scm2string (s->get_elt_property ("glyph"));
-
- Molecule m = s->lookup_l ()->bar (gl, 40 PT, s->paper_l ());
-
- return m.extent (X_AXIS);
-}
+/* Limitations/Bugs:
-void
-Span_bar::do_pre_processing ()
-{
- Bar::do_pre_processing ();
-
- evaluate_empty ();
-
- // set_empty (false, Y_AXIS); // a hack to make mark scripts work.
-}
+(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.
-void
-Span_bar::do_post_processing ()
+(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)
{
- Bar::do_post_processing ();
- Interval i(get_spanned_interval ());
+ Grob *me = unsmob_grob (smobbed_me);
+ extract_grob_set (me, "elements", elements);
+ Grob *refp = common_refpoint_of_array (elements, me, Y_AXIS);
- translate_axis (i.center (), Y_AXIS);
-}
+ SCM glyph = me->get_property ("glyph-name");
-void
-Span_bar::evaluate_empty ()
-{
- if (!gh_pair_p (get_elt_property ("elements")))
- {
- set_elt_property ("transparent", SCM_BOOL_T);
- set_empty (X_AXIS);
- set_empty (Y_AXIS);
- }
+ /* glyph may not be a string, when ME is killed by Hara Kiri in
+ between. */
+ if (!scm_is_string (glyph))
+ return SCM_EOL;
- SCM gl = get_elt_property ("glyph");
- if (!gh_string_p (gl))
- {
- set_elt_property ("transparent", SCM_BOOL_T);
- set_empty (X_AXIS);
- set_empty (Y_AXIS);
- }
- else {
- String type_str = ly_scm2string (gl);
- if (type_str == "|:")
- {
- type_str= ".|";
- }
- else if (type_str== ":|")
+ 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--;)
{
- type_str= "|.";
+ 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;
}
- else if (type_str== ":|:")
+
+ if (!model_bar)
+ model_bar = me;
+
+ vector_sort (extents, Interval::left_less);
+
+ Stencil span_bar;
+ for (vsize i = 1; i < extents.size (); i++)
{
- type_str= ".|.";
+ 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;
}
- }
+
+ span_bar.translate_axis (- me->relative_coordinate (refp, Y_AXIS),
+ Y_AXIS);
+
+ return span_bar.smobbed_copy ();
}
-Interval
-Span_bar::get_spanned_interval () const
+MAKE_SCHEME_CALLBACK (Span_bar, width, 1);
+SCM
+Span_bar::width (SCM smob)
{
- Interval y_int;
+ Grob *me = unsmob_grob (smob);
+ SCM gn = me->get_property ("glyph-name");
+ if (!me->is_live ())
+ return ly_interval2scm (Interval ());
- for (SCM s = get_elt_property ("elements"); gh_pair_p (s); s = gh_cdr (s))
- {
- Score_element *bar = unsmob_element ( gh_car (s));
+ string gl = ly_scm2string (gn);
- if (!bar)
- continue;
-
- Score_element*common = common_refpoint (bar, Y_AXIS);
+ /*
+ urg.
+ */
+ Stencil m =
+ Bar_line::compound_barline (me, gl, Interval (-20 PT, 20 PT), false);
- Interval iv (bar->extent(Y_AXIS));
- if (!iv.empty_b ())
- {
- Real y = bar->relative_coordinate (common, Y_AXIS)
- - relative_coordinate (common, Y_AXIS);
-
- y_int.unite (y + iv);
- }
- }
- return y_int;
+ return ly_interval2scm (m.extent (X_AXIS));
}
-Interval
-Span_bar::height_callback (Dimension_cache const *c)
+MAKE_SCHEME_CALLBACK (Span_bar, before_line_breaking, 1);
+SCM
+Span_bar::before_line_breaking (SCM smob)
{
- Span_bar * s= dynamic_cast<Span_bar*> (c->element_l ());
- return s->get_spanned_interval ();
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "elements", elements);
+ if (elements.empty ())
+ me->suicide ();
+
+ return SCM_UNSPECIFIED;
}
-Molecule
-Span_bar::do_brew_molecule () const
+MAKE_SCHEME_CALLBACK (Span_bar, center_on_spanned_callback, 1);
+
+SCM
+Span_bar::center_on_spanned_callback (SCM smob)
{
- Interval iv (get_spanned_interval ());
- Molecule output;
- SCM s = get_elt_property ("glyph");
- if (gh_string_p (s) && !iv.empty_b())
- {
- output.add_molecule (lookup_l ()->bar (ly_scm2string (s),
- iv.length (),
- paper_l ()));
- }
- else
+ 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 ())
{
- programming_error("Huh? My children deflated (FIXME)");
+ me->suicide ();
+ return scm_from_double (0.0);
}
- return output;
+
+ return scm_from_double (i.center ());
}
-Span_bar::Span_bar ()
+MAKE_SCHEME_CALLBACK(Span_bar, calc_glyph_name, 1);
+SCM
+Span_bar::calc_glyph_name (SCM smob)
{
- dim_cache_[X_AXIS]->set_callback (width_callback);
- dim_cache_[Y_AXIS]->set_callback (height_callback);
+ 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))
+ {
+ me->suicide ();
+ return SCM_UNSPECIFIED;
+ }
+
+ 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);
+}
+
+Interval
+Span_bar::get_spanned_interval (Grob *me)
+{
+ 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 "
+ );
+