2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2010 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 "bar-line.hh"
22 #include "all-font-metrics.hh"
23 #include "font-interface.hh"
25 #include "output-def.hh"
26 #include "paper-column.hh"
27 #include "staff-symbol-referencer.hh"
28 #include "line-interface.hh"
30 MAKE_SCHEME_CALLBACK (Bar_line, calc_bar_extent, 1)
32 Bar_line::calc_bar_extent (SCM smob)
34 Grob *me = unsmob_grob (smob);
36 SCM size = me->get_property ("bar-size");
38 if (!scm_is_number (size)
39 || !Staff_symbol_referencer::get_staff_symbol (me))
40 return ly_interval2scm (Interval ());
42 Real h = scm_to_double (size);
43 return ly_interval2scm (Interval (-h/2, h/2));
47 Bar_line::bar_y_extent (Grob *me, Grob *refpoint)
49 Interval iv = robust_scm2interval (me->get_property ("bar-extent"), Interval ());
51 iv.translate (me->relative_coordinate (refpoint, Y_AXIS));
55 MAKE_SCHEME_CALLBACK (Bar_line, print, 1);
57 Bar_line::print (SCM smob)
59 Grob *me = unsmob_grob (smob);
61 SCM s = me->get_property ("glyph-name");
62 SCM barsize = me->get_property ("bar-size");
64 if (scm_is_string (s) && scm_is_number (barsize))
66 string str = ly_scm2string (s);
67 Real sz = robust_scm2double (barsize, 0);
71 return compound_barline (me, str, sz, false).smobbed_copy ();
77 Bar_line::compound_barline (Grob *me, string str, Real h,
80 Real kern = robust_scm2double (me->get_property ("kern"), 1);
81 Real thinkern = robust_scm2double (me->get_property ("thin-kern"), 1);
82 Real hair = robust_scm2double (me->get_property ("hair-thickness"), 1);
83 Real fatline = robust_scm2double (me->get_property ("thick-thickness"), 1);
85 Real staffline = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
86 Real staff_space = Staff_symbol_referencer::staff_space (me);
89 thinkern *= staffline;
93 Stencil thin = simple_barline (me, hair, h, rounded);
94 Stencil thick = simple_barline (me, fatline, h, rounded);
95 Stencil dot = Font_interface::get_default_font (me)->find_by_name ("dots.dot");
97 int lines = Staff_symbol_referencer::line_count (me);
99 = ((lines & 1 || lines == 0)
101 : (staff_space < 2 ? 2 : .5)) * staff_space;
103 colon.translate_axis (dist, Y_AXIS);
104 colon.add_stencil (dot);
105 colon.translate_axis (-dist / 2, Y_AXIS);
108 Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
112 Interval staff_extent = staff->extent (staff, Y_AXIS);
113 center = staff_extent.center ();
121 Stencil empty = Lookup::blank (Box (Interval (0, 0), Interval (-h / 2, h / 2)));
122 empty.translate_axis (center, Y_AXIS);
127 thin.translate_axis (center, Y_AXIS);
132 thick.translate_axis (center, Y_AXIS);
135 else if (str == "|." || (h == 0 && str == ":|"))
137 m.add_at_edge (X_AXIS, LEFT, thick, 0);
138 m.add_at_edge (X_AXIS, LEFT, thin, kern);
140 else if (str == ".|" || (h == 0 && str == "|:"))
142 m.add_at_edge (X_AXIS, RIGHT, thick, 0);
143 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
145 else if (str == ":|")
147 m.add_at_edge (X_AXIS, LEFT, thick, 0);
148 m.add_at_edge (X_AXIS, LEFT, thin, kern);
149 m.add_at_edge (X_AXIS, LEFT, colon, kern);
151 else if (str == "|:")
153 m.add_at_edge (X_AXIS, RIGHT, thick, 0);
154 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
155 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
157 else if (str == ":|:")
159 m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
160 m.add_at_edge (X_AXIS, LEFT, colon, kern);
161 m.add_at_edge (X_AXIS, RIGHT, thick, kern);
162 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
164 else if (str == ":|.|:")
166 m.add_at_edge (X_AXIS, LEFT, thick, 0);
167 m.add_at_edge (X_AXIS, LEFT, thin, kern);
168 m.add_at_edge (X_AXIS, LEFT, colon, kern);
169 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
170 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
173 else if (str == ":|.:")
175 m.add_at_edge (X_AXIS, LEFT, thick, 0);
176 m.add_at_edge (X_AXIS, LEFT, thin, kern);
177 m.add_at_edge (X_AXIS, LEFT, colon, kern);
178 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
180 else if (str == ".|.")
182 m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
183 m.add_at_edge (X_AXIS, RIGHT, thick, kern);
185 else if (str == "|.|")
187 m.add_at_edge (X_AXIS, LEFT, thick, 0);
188 m.add_at_edge (X_AXIS, LEFT, thin, kern);
189 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
191 else if (str == "||")
194 should align to other side? this never appears
197 m.add_at_edge (X_AXIS, RIGHT, thin, 0);
198 m.add_at_edge (X_AXIS, RIGHT, thin, thinkern);
202 int c = (Staff_symbol_referencer::line_count (me));
204 for (int i = 0; i < c - 1; i++)
206 Real y = (- (c - 1.0) / 2 + 0.5 + i) * staff_space;
209 d.translate_axis (y, Y_AXIS);
213 else if (str == "dashed")
215 m = dashed_bar_line (me, h, hair);
219 m = tick_bar_line (me, h, rounded);
222 m.translate_axis (center, Y_AXIS);
227 Bar_line::simple_barline (Grob *me,
234 ? me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"))
237 return Lookup::round_filled_box (Box (Interval (0, w),
238 Interval (-h / 2, h / 2)), blot);
242 Bar_line::tick_bar_line (Grob *me, Real h, bool rounded)
244 Real th = Staff_symbol_referencer::staff_space (me) / 2;
245 Real line_thick = Staff_symbol_referencer::line_thickness (me);
249 ? me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"))
252 return Lookup::round_filled_box (Box (Interval (0, line_thick),
253 Interval (h / 2 - th, h / 2 + th)), blot);
257 MAKE_SCHEME_CALLBACK (Bar_line, calc_bar_size, 1);
259 Bar_line::calc_bar_size (SCM smob)
261 Grob *me = unsmob_grob (smob);
262 if (Grob *staff = Staff_symbol_referencer::get_staff_symbol (me))
264 Interval staff_y = staff->extent (staff, Y_AXIS);
265 return scm_from_double (staff_y.is_empty () ? 0.0 : staff_y.length ());
267 return scm_from_int (0);
272 Bar_line::dashed_bar_line (Grob *me, Real h, Real thick)
275 = 1.0 - robust_scm2double (me->get_property ("gap"), 0.3);
277 this is a tad complex for what we want to achieve, but with a
278 simple line, the round blotting interferes with staff line
281 Real ss = Staff_symbol_referencer::staff_space (me);
282 int count = Staff_symbol_referencer::line_count (me);
283 Real line_thick = Staff_symbol_referencer::line_thickness (me);
285 if (fabs (line_thick + (count -1) * ss - h) < 0.1) // ugh.
288 me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
290 Real half_space = ss/2;
293 for (int i = (count-1); i >= -(count-1); i -= 2)
295 Real top_y = min ((i + dash_size) * half_space,
296 (count-1) * half_space + line_thick / 2);
297 Real bot_y = max ((i - dash_size) * half_space,
298 -(count-1) * half_space - line_thick/2);
300 bar.add_stencil (Lookup::round_filled_box (Box (Interval (0, thick),
301 Interval (bot_y, top_y)),
309 We have to scale the dashing so it starts and ends with half a
312 int dashes = int (rint (h / ss));
313 Real total_dash_size = h / dashes;
314 Real factor = (dash_size - thick) / ss;
316 SCM at = scm_list_n (ly_symbol2scm ("dashed-line"),
317 scm_from_double (thick),
318 scm_from_double (factor * total_dash_size),
319 scm_from_double ((1-factor) * total_dash_size),
322 scm_from_double (factor * total_dash_size * 0.5),
326 box.add_point (Offset (0, 0));
327 box.add_point (Offset (0, h));
330 s.translate (Offset (thick/2, -h/2));
336 MAKE_SCHEME_CALLBACK (Bar_line, calc_anchor, 1)
338 Bar_line::calc_anchor (SCM smob)
340 Grob *me = unsmob_grob (smob);
341 Real kern = robust_scm2double (me->get_property ("kern"), 1);
342 Real staffline = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
343 string str = robust_scm2string (me->get_property ("glyph-name"), "");
345 /* we put the anchor in the center of the barline, unless we are
346 a repeat bar, in which case we put the anchor in the center of
347 the barline without the dots. */
348 Interval ext = me->extent (me, X_AXIS);
350 return scm_from_double (0);
352 Real anchor = ext.center ();
354 Stencil dot = Font_interface::get_default_font (me)->find_by_name ("dots.dot");
355 Real dot_width = dot.extent (X_AXIS).length () + kern * staffline;
357 anchor -= dot_width / 2;
358 else if (str == ":|")
359 anchor += dot_width / 2;
361 return scm_from_double (anchor);
364 ADD_INTERFACE (Bar_line,
367 "Print a special bar symbol. It replaces the regular bar"
368 " symbol with a special symbol. The argument @var{bartype}"
369 " is a string which specifies the kind of bar line to print."
370 " Options are @code{|}, @code{:|}, @code{|:}, @code{:|:}, @code{:|.|:},"
371 " @code{:|.:}, @code{.}, @code{||}, @code{|.}, @code{.|}, @code{.|.},"
372 " @code{|.|}, @code{:}, @code{dashed} and @code{'}.\n"
374 "These produce, respectively, a normal bar line, a right repeat, a left repeat,"
375 " a thick double repeat, a thin-thick-thin double repeat,"
376 " a thin-thick double repeat, a thick bar, a double bar, a start bar,"
377 " an end bar, a thick double bar, a thin-thick-thin bar,"
378 " a dotted bar, a dashed bar, and a tick."
379 " In addition, there is an option"
380 " @code{||:} which is equivalent to @code{|:} except at line"
381 " breaks, where it produces a double bar (@code{||}) at the"
382 " end of the line and a repeat sign (@code{|:}) at the"
383 " beginning of the new line.\n"
385 "If @var{bartype} is set to @code{empty} then nothing is"
386 " printed, but a line break is allowed at that spot.\n"
388 "@code{gap} is used for the gaps in dashed bar lines.",