2 span-bar.cc -- implement Span_bar
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
11 #include "font-interface.hh"
12 #include "dimensions.hh"
13 #include "output-def.hh"
16 #include "axis-group-interface.hh"
17 #include "bar-line.hh"
19 #include "pointer-group-interface.hh"
23 Span_bar::add_bar (Grob *me, Grob *b)
25 Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), b);
27 me->add_dependency (b);
30 MAKE_SCHEME_CALLBACK (Span_bar, print, 1);
34 (1) Elements from 'me->get_object ("elements")' must be
35 ordered according to their y coordinates relative to their common
36 axis group parent. Otherwise, the computation goes mad.
38 (2) This method depends on bar_engraver not being removed from
39 staff context. If bar_engraver is removed, the size of the staff
40 lines is evaluated as 0, which results in a solid span bar line
41 with faulty y coordinate. */
43 /* This routine was originally by Juergen Reuter, but it was a on the
44 bulky side. Rewritten by Han-Wen. */
46 Span_bar::print (SCM smobbed_me)
48 Grob *me = unsmob_grob (smobbed_me);
49 extract_grob_set (me, "elements", elements);
50 Grob *refp = common_refpoint_of_array (elements, me, Y_AXIS);
52 Span_bar::evaluate_glyph (me);
53 SCM glyph = me->get_property ("glyph");
55 /* glyph may not be a string, when ME is killed by Hara Kiri in
57 if (!scm_is_string (glyph))
60 String glyph_string = ly_scm2string (glyph);
62 /* compose span_bar_mol */
63 Array<Interval> extents;
65 for (int i = elements.size (); i--;)
67 Grob *bar = elements[i];
68 Interval ext = bar->extent (refp, Y_AXIS);
79 extents.sort (&Interval::left_comparison);
82 for (int i = 1; i < extents.size (); i ++)
84 Interval prev_extent = extents[i-1];
85 Interval ext = extents[i];
86 if (!prev_extent.is_empty ())
88 Interval l (prev_extent [UP],
93 /* There is overlap between the bar lines. Do nothing. */
97 Stencil interbar = Bar_line::compound_barline (model_bar,
101 interbar.translate_axis (l.center (), Y_AXIS);
102 span_bar.add_stencil (interbar);
108 span_bar.translate_axis (- me->relative_coordinate (refp, Y_AXIS),
111 return span_bar.smobbed_copy ();
114 MAKE_SCHEME_CALLBACK (Span_bar, width_callback, 2);
116 Span_bar::width_callback (SCM element_smob, SCM scm_axis)
118 Grob *se = unsmob_grob (element_smob);
121 assert ( (Axis) scm_to_int (scm_axis) == X_AXIS);
122 String gl = ly_scm2string (se->get_property ("glyph"));
127 Stencil m = Bar_line::compound_barline (se, gl, 40 PT, false);
129 return ly_interval2scm (m.extent (X_AXIS));
132 MAKE_SCHEME_CALLBACK (Span_bar, before_line_breaking, 1);
134 Span_bar::before_line_breaking (SCM smob)
136 Grob *g = unsmob_grob (smob);
140 /* No need to call Bar_line::before_line_breaking (), because the info
141 in ELEMENTS already has been procced by
142 Bar_line::before_line_breaking (). */
143 return SCM_UNSPECIFIED;
146 MAKE_SCHEME_CALLBACK (Span_bar, center_on_spanned_callback, 2);
149 Span_bar::center_on_spanned_callback (SCM element_smob, SCM axis)
151 Grob *me = unsmob_grob (element_smob);
153 assert (scm_to_int (axis) == Y_AXIS);
154 Interval i (get_spanned_interval (me));
156 /* Bar_line::print delivers a barline of y-extent (-h/2, h/2), so
157 we have to translate ourselves to be in the center of the
158 interval that we span. */
162 return scm_make_real (0.0);
165 return scm_make_real (i.center ());
169 Span_bar::evaluate_empty (Grob *me)
171 /* TODO: filter all hara-kiried out of ELEMENS list, and then
172 optionally do suicide. Call this cleanage function from
173 center_on_spanned_callback () as well. */
175 extract_grob_set (me, "elements", elements);
176 if (elements.is_empty ())
183 Span_bar::evaluate_glyph (Grob *me)
185 SCM gl = me->get_property ("glyph");
187 if (scm_is_string (gl))
190 extract_grob_set (me, "elements", elements);
191 for (int i = elements.size();
192 i-- && !scm_is_string (gl); )
194 gl = elements[i]->get_property ("glyph");
197 if (!scm_is_string (gl))
203 String type = ly_scm2string (gl);
208 else if (type == ":|")
212 else if (type == ":|:")
217 gl = scm_makfrom0str (type.to_str0 ());
218 if (scm_equal_p (me->get_property ("glyph"), gl)
220 me->set_property ("glyph", gl);
224 Span_bar::get_spanned_interval (Grob *me)
226 return ly_scm2interval (Axis_group_interface::group_extent_callback
227 (me->self_scm (), scm_int2num (Y_AXIS)));
230 MAKE_SCHEME_CALLBACK (Span_bar, get_bar_size, 1);
232 Span_bar::get_bar_size (SCM smob)
234 Grob *me = unsmob_grob (smob);
235 Interval iv (get_spanned_interval (me));
238 /* This happens if the bars are hara-kiried from under us. */
240 return scm_make_real (-1);
242 return scm_make_real (iv.length ());
245 ADD_INTERFACE (Span_bar, "span-bar-interface",
246 "A bar line that spanned between other barlines. This interface is "
247 " used for bar lines that connect different staves.",