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"
20 Span_bar::add_bar (Grob *me, Grob *b)
22 Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), b);
24 me->add_dependency (b);
27 MAKE_SCHEME_CALLBACK (Span_bar, print, 1);
31 (1) Elements from 'me->get_property ("elements")' must be
32 ordered according to their y coordinates relative to their common
33 axis group parent. Otherwise, the computation goes mad.
36 apply a sort algorithm that ensures this precondition.) However,
37 until now, I have seen no case where lily has not fulfilled this
40 (2) This method depends on bar_engraver not being removed from
41 staff context. If bar_engraver is removed, the size of the staff
42 lines is evaluated as 0, which results in a solid span bar line
43 with faulty y coordinate. */
45 /* This routine was originally by Juergen Reuter, but it was a on the
46 bulky side. Rewritten by Han-Wen. */
48 Span_bar::print (SCM smobbed_me)
50 Grob *me = unsmob_grob (smobbed_me);
51 SCM first_elt = me->get_property ("elements");
53 /* compute common refpoint of elements */
55 for (SCM elts = first_elt; scm_is_pair (elts); elts = scm_cdr (elts))
57 SCM smobbed_staff_bar = scm_car (elts);
58 Grob *staff_bar = unsmob_grob (smobbed_staff_bar);
59 refp = staff_bar->common_refpoint (refp, Y_AXIS);
62 Span_bar::evaluate_glyph (me);
63 SCM glyph = me->get_property ("glyph");
65 /* glyph may not be a string, when ME is killed by Hara Kiri in
67 if (!scm_is_string (glyph))
70 String glyph_string = ly_scm2string (glyph);
72 /* compose span_bar_mol */
76 for (SCM elts = first_elt; scm_is_pair (elts); elts = scm_cdr (elts))
78 SCM smobbed_staff_bar = scm_car (elts);
79 Grob *staff_bar = unsmob_grob (smobbed_staff_bar);
80 Interval ext = staff_bar->extent (refp, Y_AXIS);
84 if (!prev_extent.is_empty ())
86 Interval l (prev_extent [UP],
91 /* There is overlap between the bar lines. Do nothing. */
95 Stencil interbar = Bar_line::compound_barline (staff_bar,
99 interbar.translate_axis (l.center (), Y_AXIS);
100 span_bar_mol.add_stencil (interbar);
106 span_bar_mol.translate_axis (- me->relative_coordinate (refp, Y_AXIS),
109 return span_bar_mol.smobbed_copy ();
112 MAKE_SCHEME_CALLBACK (Span_bar, width_callback, 2);
114 Span_bar::width_callback (SCM element_smob, SCM scm_axis)
116 Grob *se = unsmob_grob (element_smob);
119 assert ( (Axis) scm_to_int (scm_axis) == X_AXIS);
120 String gl = ly_scm2string (se->get_property ("glyph"));
125 Stencil m = Bar_line::compound_barline (se, gl, 40 PT, false);
127 return ly_interval2scm (m.extent (X_AXIS));
130 MAKE_SCHEME_CALLBACK (Span_bar, before_line_breaking, 1);
132 Span_bar::before_line_breaking (SCM smob)
134 Grob *g = unsmob_grob (smob);
138 /* No need to call Bar_line::before_line_breaking (), because the info
139 in ELEMENTS already has been procced by
140 Bar_line::before_line_breaking (). */
141 return SCM_UNSPECIFIED;
144 MAKE_SCHEME_CALLBACK (Span_bar, center_on_spanned_callback, 2);
147 Span_bar::center_on_spanned_callback (SCM element_smob, SCM axis)
149 Grob *me = unsmob_grob (element_smob);
151 assert (scm_to_int (axis) == Y_AXIS);
152 Interval i (get_spanned_interval (me));
154 /* Bar_line::print delivers a barline of y-extent (-h/2, h/2), so
155 we have to translate ourselves to be in the center of the
156 interval that we span. */
160 return scm_make_real (0.0);
163 return scm_make_real (i.center ());
167 Span_bar::evaluate_empty (Grob *me)
169 /* TODO: filter all hara-kiried out of ELEMENS list, and then
170 optionally do suicide. Call this cleanage function from
171 center_on_spanned_callback () as well. */
172 if (!scm_is_pair (me->get_property ("elements")))
179 Span_bar::evaluate_glyph (Grob *me)
181 SCM gl = me->get_property ("glyph");
183 if (scm_is_string (gl))
186 for (SCM s = me->get_property ("elements");
187 !scm_is_string (gl) && scm_is_pair (s); s = scm_cdr (s))
189 gl = unsmob_grob (scm_car (s))
190 ->get_property ("glyph");
193 if (!scm_is_string (gl))
199 String type = ly_scm2string (gl);
204 else if (type == ":|")
208 else if (type == ":|:")
213 gl = scm_makfrom0str (type.to_str0 ());
214 if (scm_equal_p (me->get_property ("glyph"), gl)
216 me->set_property ("glyph", gl);
220 Span_bar::get_spanned_interval (Grob *me)
222 return ly_scm2interval (Axis_group_interface::group_extent_callback
223 (me->self_scm (), scm_int2num (Y_AXIS)));
226 MAKE_SCHEME_CALLBACK (Span_bar, get_bar_size, 1);
228 Span_bar::get_bar_size (SCM smob)
230 Grob *me = unsmob_grob (smob);
231 Interval iv (get_spanned_interval (me));
234 /* This happens if the bars are hara-kiried from under us. */
236 return scm_make_real (-1);
238 return scm_make_real (iv.length ());
241 ADD_INTERFACE (Span_bar, "span-bar-interface",
242 "A bar line that spanned between other barlines. This interface is "
243 " used for bar lines that connect different staves.",