2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "span-bar.hh"
22 #include "font-interface.hh"
23 #include "dimensions.hh"
24 #include "output-def.hh"
27 #include "axis-group-interface.hh"
28 #include "bar-line.hh"
30 #include "pointer-group-interface.hh"
31 #include "staff-symbol-referencer.hh"
34 Span_bar::add_bar (Grob *me, Grob *b)
36 Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), b);
39 MAKE_SCHEME_CALLBACK (Span_bar, print, 1);
43 (1) Elements from 'me->get_object ("elements")' must be
44 ordered according to their y coordinates relative to their common
45 axis group parent. Otherwise, the computation goes mad.
47 (2) This method depends on bar_engraver not being removed from
48 staff context. If bar_engraver is removed, the size of the staff
49 lines is evaluated as 0, which results in a solid span bar line
50 with faulty y coordinate. */
52 /* This routine was originally by Juergen Reuter, but it was a on the
53 bulky side. Rewritten by Han-Wen. */
55 Span_bar::print (SCM smobbed_me)
57 Grob *me = unsmob_grob (smobbed_me);
58 extract_grob_set (me, "elements", elements);
59 Grob *refp = common_refpoint_of_array (elements, me, Y_AXIS);
61 SCM glyph = me->get_property ("glyph-name");
63 /* glyph may not be a string, when ME is killed by Hara Kiri in
65 if (!scm_is_string (glyph))
68 string glyph_string = ly_scm2string (glyph);
70 /* compose span_bar_mol */
71 vector<Interval> extents;
72 vector<bool> make_span_bar;
74 for (vsize i = elements.size (); i--;)
76 Grob *bar = elements[i];
77 Interval ext = Bar_line::bar_y_extent (bar, refp);
78 if (Grob *staff = Staff_symbol_referencer::get_staff_symbol (bar))
79 ext.unite (staff->extent (refp, Y_AXIS));
83 extents.push_back (ext);
84 make_span_bar.push_back (to_boolean (bar->get_property ("allow-span-bar")));
92 for (vsize i = 1; i < extents.size (); i++)
94 Interval prev_extent = extents[i - 1];
95 Interval ext = extents[i];
96 if (!prev_extent.is_empty ())
98 Interval l (prev_extent [UP],
101 if (l.is_empty () || !make_span_bar[i])
103 /* There is overlap between the bar lines. Do nothing. */
107 Stencil interbar = Bar_line::compound_barline (model_bar,
111 span_bar.add_stencil (interbar);
117 span_bar.translate_axis (- me->relative_coordinate (refp, Y_AXIS),
120 return span_bar.smobbed_copy ();
123 MAKE_SCHEME_CALLBACK (Span_bar, width, 1);
125 Span_bar::width (SCM smob)
127 Grob *me = unsmob_grob (smob);
128 SCM gn = me->get_property ("glyph-name");
130 return ly_interval2scm (Interval ());
132 string gl = ly_scm2string (gn);
138 = Bar_line::compound_barline (me, gl, Interval (-20 PT, 20 PT), false);
140 return ly_interval2scm (m.extent (X_AXIS));
143 MAKE_SCHEME_CALLBACK (Span_bar, before_line_breaking, 1);
145 Span_bar::before_line_breaking (SCM smob)
147 Grob *me = unsmob_grob (smob);
148 extract_grob_set (me, "elements", elements);
149 if (elements.empty ())
152 return SCM_UNSPECIFIED;
155 MAKE_SCHEME_CALLBACK (Span_bar, center_on_spanned_callback, 1);
158 Span_bar::center_on_spanned_callback (SCM smob)
160 Grob *me = unsmob_grob (smob);
161 Interval i (get_spanned_interval (me));
163 /* Bar_line::print delivers a barline of y-extent (-h/2, h/2), so
164 we have to translate ourselves to be in the center of the
165 interval that we span. */
169 return scm_from_double (0.0);
172 return scm_from_double (i.center ());
175 MAKE_SCHEME_CALLBACK (Span_bar, calc_glyph_name, 1);
177 Span_bar::calc_glyph_name (SCM smob)
179 Grob *me = unsmob_grob (smob);
180 extract_grob_set (me, "elements", elements);
182 for (vsize i = elements.size ();
183 i-- && !scm_is_string (gl);)
184 gl = elements[i]->get_property ("glyph-name");
186 if (!scm_is_string (gl))
189 return SCM_UNSPECIFIED;
192 string type = ly_scm2string (gl);
193 if (type == "|:" || type == "||:")
195 else if (type == ":|")
197 else if (type == ":|:")
199 else if (type == ":|.|:")
201 else if (type == ":|.:")
203 else if (type == "S" || type == "S|" || type == "|S")
205 else if (type == "S|:" || type == ".S|:")
207 else if (type == ":|S" || type == ":|S.")
209 else if (type == ":|S|:" || type == ":|S.|:")
211 else if (type == "'")
214 return ly_string2scm (type);
218 Span_bar::get_spanned_interval (Grob *me)
220 return ly_scm2interval (Axis_group_interface::generic_group_extent (me, Y_AXIS));
223 ADD_INTERFACE (Span_bar,
224 "A bar line that is spanned between other barlines. This"
225 " interface is used for bar lines that connect different"
232 "pure-relevant-grobs "
233 "pure-relevant-items "
234 "pure-relevant-spanners "