source file of the GNU LilyPond music typesetter
- (c) 1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
#include "span-bar.hh"
+
#include "font-interface.hh"
#include "dimensions.hh"
-#include "paper-def.hh"
-#include "molecule.hh"
+#include "output-def.hh"
+#include "stencil.hh"
#include "warn.hh"
#include "axis-group-interface.hh"
-#include "group-interface.hh"
+#include "bar-line.hh"
#include "grob.hh"
-#include "bar.hh"
+#include "pointer-group-interface.hh"
void
-Span_bar::add_bar (Grob*me, Grob*b)
+Span_bar::add_bar (Grob *me, Grob *b)
{
- Pointer_group_interface::add_element (me,"elements", b);
-
- me->add_dependency (b);
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), b);
}
-MAKE_SCHEME_CALLBACK (Span_bar,brew_molecule,1);
-
-/**
- * Limitations/Bugs:
- *
- * (1) Elements from 'me->get_grob_property ("elements")' must be
- * ordered according to their y coordinates relative to their common
- * axis group parent. Otherwise, the computation goes mad. (TODO:
- * apply a sort algorithm that ensures this precondition.) However,
- * until now, I have seen no case where lily has not fulfilled this
- * precondition.
- *
- * (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.
- *
- */
+MAKE_SCHEME_CALLBACK (Span_bar, print, 1);
+
+/* Limitations/Bugs:
+
+(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::brew_molecule (SCM smobbed_me)
+Span_bar::print (SCM smobbed_me)
{
Grob *me = unsmob_grob (smobbed_me);
- Span_bar::evaluate_glyph(me);
- SCM glyph = me->get_grob_property (ly_symbol2scm ("glyph"));
- String glyph_str = ly_scm2string (glyph);
- SCM first_elt = me->get_grob_property ("elements");
-
- // first walk: compute axis_group parent via common_refpoint () on all bars
- Grob *refpoint = 0;
- int staff_bar_count = 0;
- for (SCM elts = first_elt;
- elts != SCM_EOL;
- elts = gh_cdr (elts))
- {
- SCM smobbed_staff_bar = gh_car (elts);
- Grob *staff_bar = unsmob_grob (smobbed_staff_bar);
- refpoint = (staff_bar_count > 0) ?
- staff_bar->common_refpoint (refpoint, Y_AXIS) :
- staff_bar;
- staff_bar_count++;
- }
- /* assert: refpoint is an axis-group object */
- Grob *axis_group = refpoint;
-
- // second walk: collect span bar components;
- // compute extent of axis_group
- Real last_staff_bar_length;
- Real *interstaff_bar_length = new Real[staff_bar_count];
- Real *interstaff_bar_yoffs = new Real[staff_bar_count];
- Molecule *interstaff_bar_molecule = new Molecule[staff_bar_count];
- Real axis_group_extent = 0.0;
- staff_bar_count = 0;
- for (SCM elts = first_elt;
- elts != SCM_EOL;
- elts = gh_cdr (elts))
- {
- SCM smobbed_staff_bar = gh_car (elts);
- SCM smobbed_staff_bar_molecule =
- Bar::brew_molecule (smobbed_staff_bar);
- Grob *staff_bar = unsmob_grob (smobbed_staff_bar);
- interstaff_bar_yoffs[staff_bar_count] =
- staff_bar->relative_coordinate (axis_group, (Axis)Y_AXIS);
- if (smobbed_staff_bar_molecule != SCM_EOL)
+ 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--;)
{
- Real staff_bar_length =
- unsmob_molecule (smobbed_staff_bar_molecule)->
- extent (Y_AXIS).length ();
- if (staff_bar_count > 0)
- {
- // clone bar_molecule and fix y extent
- interstaff_bar_length[staff_bar_count] =
- interstaff_bar_yoffs[staff_bar_count] -
- interstaff_bar_yoffs[staff_bar_count - 1] -
- last_staff_bar_length;
- SCM smobbed_interstaff_bar_molecule =
- Bar::compound_barline (staff_bar, glyph_str,
- interstaff_bar_length[staff_bar_count]).
- smobbed_copy ();
- interstaff_bar_molecule[staff_bar_count] =
- *unsmob_molecule (smobbed_interstaff_bar_molecule);
- }
- else
- {
- interstaff_bar_molecule[staff_bar_count] = Molecule::Molecule ();
- }
- last_staff_bar_length = staff_bar_length;
+ Grob *bar = elements[i];
+ Interval ext = Bar_line::bar_y_extent (bar, refp);
+ 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 (!model_bar)
+ model_bar = me;
+
+ vector_sort (extents, Interval::left_less);
+
+ Stencil span_bar;
+ for (vsize i = 1; i < extents.size (); i++)
{
- last_staff_bar_length = 0;
- interstaff_bar_length[staff_bar_count] = 0;
- interstaff_bar_molecule[staff_bar_count] = Molecule::Molecule ();
+ 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.length (),
+ false);
+ interbar.translate_axis (l.center (), Y_AXIS);
+ span_bar.add_stencil (interbar);
+ }
+ }
+ prev_extent = ext;
}
- axis_group_extent += last_staff_bar_length;
- axis_group_extent += interstaff_bar_length[staff_bar_count];
- staff_bar_count++;
- }
- // assert(abs(axis_group_extent -
- // axis_group->extent (axis_group, Y_AXIS).length ()) < EPSILON);
-
- // third walk: correct y axis on all span bar components;
- // put all components into a single span bar molecule
- Molecule span_bar_molecule = Molecule::Molecule ();
- staff_bar_count = 0;
- for (SCM elts = first_elt;
- elts != SCM_EOL;
- elts = gh_cdr (elts))
- {
- interstaff_bar_yoffs[staff_bar_count] +=
- (axis_group_extent - interstaff_bar_length[staff_bar_count]) / 2;
- interstaff_bar_molecule[staff_bar_count].//DEBUG
- translate_axis (-1.0 PT, X_AXIS);//DEBUG
- interstaff_bar_molecule[staff_bar_count].
- translate_axis (interstaff_bar_yoffs[staff_bar_count], Y_AXIS);
- span_bar_molecule.add_molecule (interstaff_bar_molecule[staff_bar_count]);
- staff_bar_count++;
- }
-
- // clean-up & exit
- delete interstaff_bar_length;
- delete interstaff_bar_yoffs;
- delete interstaff_bar_molecule;
- return span_bar_molecule.smobbed_copy ();
+
+ span_bar.translate_axis (- me->relative_coordinate (refp, Y_AXIS),
+ Y_AXIS);
+
+ return span_bar.smobbed_copy ();
}
-MAKE_SCHEME_CALLBACK (Span_bar,width_callback,2);
+MAKE_SCHEME_CALLBACK (Span_bar, width, 1);
SCM
-Span_bar::width_callback (SCM element_smob, SCM scm_axis)
+Span_bar::width (SCM smob)
{
- Grob *se = unsmob_grob (element_smob);
- Axis a = (Axis) gh_scm2int (scm_axis);
- assert (a == X_AXIS);
- String gl = ly_scm2string (se->get_grob_property ("glyph"));
+ 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.
- */
- Molecule m = Bar::compound_barline (se, gl, 40 PT);
-
+ */
+ Stencil m = Bar_line::compound_barline (me, gl, 40 PT, false);
+
return ly_interval2scm (m.extent (X_AXIS));
}
-MAKE_SCHEME_CALLBACK (Span_bar,before_line_breaking,1);
+MAKE_SCHEME_CALLBACK (Span_bar, before_line_breaking, 1);
SCM
Span_bar::before_line_breaking (SCM smob)
{
- evaluate_empty (unsmob_grob (smob));
- evaluate_glyph (unsmob_grob (smob));
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "elements", elements);
+ if (elements.empty ())
+ me->suicide ();
- /*
- no need to call Bar::before_line_breaking (), because the info
- in ELEMENTS already has been procced by Bar::before_line_breaking ().
- */
return SCM_UNSPECIFIED;
}
-MAKE_SCHEME_CALLBACK (Span_bar,center_on_spanned_callback,2);
+MAKE_SCHEME_CALLBACK (Span_bar, center_on_spanned_callback, 1);
SCM
-Span_bar::center_on_spanned_callback (SCM element_smob, SCM axis)
+Span_bar::center_on_spanned_callback (SCM smob)
{
- Grob *me = unsmob_grob (element_smob);
- Axis a = (Axis) gh_scm2int (axis);
- assert (a == Y_AXIS);
+ Grob *me = unsmob_grob (smob);
Interval i (get_spanned_interval (me));
- /*
- Bar::brew_molecule 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.empty_b ())
+ /* 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 ())
{
me->suicide ();
- return gh_double2scm (0.0);
+ return scm_from_double (0.0);
}
-
- return gh_double2scm (i.center ());
-}
-void
-Span_bar::evaluate_empty (Grob*me)
-{
- /*
- TODO: filter all hara-kiried out of ELEMENS list, and then
- optionally do suicide. Call this cleanage function from
- center_on_spanned_callback () as well.
-
- */
- if (!gh_pair_p (me->get_grob_property ("elements")))
- {
- me->suicide ();
- }
+ return scm_from_double (i.center ());
}
-void
-Span_bar::evaluate_glyph (Grob*me)
+
+
+MAKE_SCHEME_CALLBACK(Span_bar, calc_glyph_name, 1);
+SCM
+Span_bar::calc_glyph_name (SCM smob)
{
- SCM elts = me->get_grob_property ("elements");
- Grob * b = unsmob_grob (gh_car (elts));
- SCM glsym =ly_symbol2scm ("glyph");
- SCM gl =b ->get_grob_property (glsym);
- if (!gh_string_p (gl))
+ 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 ;
- }
-
- String type = ly_scm2string (gl);
-
- if (type == "|:")
- {
- type = ".|";
- }
- else if (type== ":|")
- {
- type = "|.";
- }
- else if (type== ":|:")
- {
- type = ".|.";
+ return SCM_UNSPECIFIED;
}
- gl = ly_str02scm (type.ch_C ());
- if (scm_equal_p (me->get_grob_property (glsym), gl) != SCM_BOOL_T)
- me->set_grob_property (glsym, gl);
+ string type = ly_scm2string (gl);
+ if (type == "|:")
+ type = ".|";
+ else if (type == ":|")
+ type = "|.";
+ else if (type == ":|:")
+ type = ".|.";
+ else if (type == ":|.|:")
+ type = "|.|";
+ else if (type == ":|.:")
+ type = "|.";
+
+ return ly_string2scm (type);
}
Interval
-Span_bar::get_spanned_interval (Grob*me)
+Span_bar::get_spanned_interval (Grob *me)
{
- return ly_scm2interval (Axis_group_interface::group_extent_callback (me->self_scm (), gh_int2scm (Y_AXIS)));
+ return ly_scm2interval (Axis_group_interface::generic_group_extent (me, Y_AXIS));
}
-
-MAKE_SCHEME_CALLBACK (Span_bar,get_bar_size,1);
+MAKE_SCHEME_CALLBACK (Span_bar, calc_bar_size, 1);
SCM
-Span_bar::get_bar_size (SCM smob)
+Span_bar::calc_bar_size (SCM smob)
{
- Grob* me = unsmob_grob (smob);
+ Grob *me = unsmob_grob (smob);
Interval iv (get_spanned_interval (me));
- if (iv.empty_b ())
+ if (iv.is_empty ())
{
- /*
- This happens if the bars are hara-kiried from under us.
- */
+ /* This happens if the bars are hara-kiried from under us. */
me->suicide ();
- return gh_double2scm (-1);
+ return scm_from_double (-1);
}
- return gh_double2scm (iv.length ());
+ return scm_from_double (iv.length ());
}
-void
-Span_bar::set_interface (Grob *me)
-{
- Bar::set_interface (me);
-
- me->set_interface (ly_symbol2scm ("span-bar-interface"));
- me->set_extent_callback (SCM_EOL, 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 "
+ );
-bool
-Span_bar::has_interface (Grob*m)
-{
- return m && m->has_interface (ly_symbol2scm ("span-bar-interface"));
-}