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 "bar-line.hh"
22 #include "all-font-metrics.hh"
23 #include "font-interface.hh"
24 #include "line-interface.hh"
26 #include "output-def.hh"
27 #include "paper-column.hh"
28 #include "staff-symbol-referencer.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));
56 Bar_line::non_empty_barline (Grob *me)
58 return has_interface (me) && !me->extent (me, X_AXIS).is_empty ();
61 MAKE_SCHEME_CALLBACK (Bar_line, print, 1);
63 Bar_line::print (SCM smob)
65 Grob *me = unsmob_grob (smob);
67 SCM s = me->get_property ("glyph-name");
68 SCM barsize = me->get_property ("bar-size");
70 if (scm_is_string (s) && scm_is_number (barsize))
72 string str = ly_scm2string (s);
73 Real sz = robust_scm2double (barsize, 0);
77 return compound_barline (me, str, sz, false).smobbed_copy ();
83 Bar_line::compound_barline (Grob *me, string str, Real h,
86 Real kern = robust_scm2double (me->get_property ("kern"), 1);
87 Real thinkern = robust_scm2double (me->get_property ("thin-kern"), 1);
88 Real hair = robust_scm2double (me->get_property ("hair-thickness"), 1);
89 Real fatline = robust_scm2double (me->get_property ("thick-thickness"), 1);
91 Real staffline = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
92 Real staff_space = Staff_symbol_referencer::staff_space (me);
95 thinkern *= staffline;
99 Stencil thin = simple_barline (me, hair, h, rounded);
100 Stencil thick = simple_barline (me, fatline, h, rounded);
101 Stencil dot = Font_interface::get_default_font (me)->find_by_name ("dots.dot");
103 int lines = Staff_symbol_referencer::line_count (me);
105 = ((lines & 1 || lines == 0)
107 : (staff_space < 2 ? 2 : .5)) * staff_space;
109 colon.translate_axis (dist, Y_AXIS);
110 colon.add_stencil (dot);
111 colon.translate_axis (-dist / 2, Y_AXIS);
114 Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
118 Interval staff_extent = staff->extent (staff, Y_AXIS);
119 center = staff_extent.center ();
125 if (str == "|S" || str == "S|")
130 Stencil empty = Lookup::blank (Box (Interval (0, 0), Interval (-h / 2, h / 2)));
131 empty.translate_axis (center, Y_AXIS);
136 thin.translate_axis (center, Y_AXIS);
141 thick.translate_axis (center, Y_AXIS);
144 else if (str == "|." || (h == 0 && str == ":|"))
146 m.add_at_edge (X_AXIS, LEFT, thick, 0);
147 m.add_at_edge (X_AXIS, LEFT, thin, kern);
149 else if (str == ".|" || (h == 0 && str == "|:"))
151 m.add_at_edge (X_AXIS, RIGHT, thick, 0);
152 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
154 else if (str == ":|")
156 m.add_at_edge (X_AXIS, LEFT, thick, 0);
157 m.add_at_edge (X_AXIS, LEFT, thin, kern);
158 m.add_at_edge (X_AXIS, LEFT, colon, kern);
160 else if (str == "|:")
162 m.add_at_edge (X_AXIS, RIGHT, thick, 0);
163 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
164 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
166 else if (str == ":|:")
168 m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
169 m.add_at_edge (X_AXIS, LEFT, colon, kern);
170 m.add_at_edge (X_AXIS, RIGHT, thick, kern);
171 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, thin, kern);
179 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
181 else if (str == ":|.:")
183 m.add_at_edge (X_AXIS, LEFT, thick, 0);
184 m.add_at_edge (X_AXIS, LEFT, thin, kern);
185 m.add_at_edge (X_AXIS, LEFT, colon, kern);
186 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
188 else if (str == ".|.")
190 m.add_at_edge (X_AXIS, LEFT, thick, thinkern);
191 m.add_at_edge (X_AXIS, RIGHT, thick, kern);
193 else if (str == "|.|")
195 m.add_at_edge (X_AXIS, LEFT, thick, 0);
196 m.add_at_edge (X_AXIS, LEFT, thin, kern);
197 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
199 else if (str == "||")
202 should align to other side? this never appears
204 m.add_at_edge (X_AXIS, RIGHT, thin, 0);
205 m.add_at_edge (X_AXIS, RIGHT, thin, thinkern);
207 m.add_at_edge (X_AXIS, LEFT, thin, thinkern);
208 m.add_at_edge (X_AXIS, RIGHT, thin, thinkern);
210 else if (str.find ("S") != NPOS || str == "|._.|")
212 // Handle all varsegno stuff
214 segno.add_at_edge (X_AXIS, LEFT, thin, thinkern);
215 segno.add_at_edge (X_AXIS, RIGHT, thin, thinkern);
216 segno.add_stencil (Font_interface::get_default_font (me)->find_by_name ("scripts.varsegno"));
219 m.add_stencil (segno);
220 else if (str == "S|:" || str == ".S|:")
222 m.add_at_edge (X_AXIS, RIGHT, thick, 0);
223 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
224 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
225 m.add_at_edge (X_AXIS, LEFT, segno, thinkern);
227 else if (str == ":|S" || str == ":|S.")
229 m.add_at_edge (X_AXIS, LEFT, thick, 0);
230 m.add_at_edge (X_AXIS, LEFT, thin, kern);
231 m.add_at_edge (X_AXIS, LEFT, colon, kern);
232 m.add_at_edge (X_AXIS, RIGHT, segno, thinkern);
234 else if (str == ":|S|:" || str == ":|S.|:")
236 m.add_at_edge (X_AXIS, LEFT, thick, 0);
237 m.add_at_edge (X_AXIS, LEFT, thin, kern);
238 m.add_at_edge (X_AXIS, LEFT, colon, kern);
239 m.add_at_edge (X_AXIS, RIGHT, segno, thinkern);
240 m.add_at_edge (X_AXIS, RIGHT, thick, thinkern);
241 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
242 m.add_at_edge (X_AXIS, RIGHT, colon, kern);
244 else if (str == "|._.|") // :|S|: or :|S.|: without segno and colon
246 // get the width of the segno sign
247 Real segno_width = segno.extent (X_AXIS).length ();
248 m.add_at_edge (X_AXIS, LEFT, thick, 0);
249 m.add_at_edge (X_AXIS, LEFT, thin, kern);
250 m.add_at_edge (X_AXIS, RIGHT, thick, segno_width + 2 * thinkern);
251 m.add_at_edge (X_AXIS, RIGHT, thin, kern);
253 // end varsegno block
257 int c = (Staff_symbol_referencer::line_count (me));
259 for (int i = 0; i < c - 1; i++)
261 Real y = (- (c - 1.0) / 2 + 0.5 + i) * staff_space;
264 d.translate_axis (y, Y_AXIS);
268 else if (str == "dashed")
269 m = dashed_bar_line (me, h, hair);
271 m = tick_bar_line (me, h, rounded);
273 m.translate_axis (center, Y_AXIS);
278 Bar_line::simple_barline (Grob *me,
285 ? me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"))
288 return Lookup::round_filled_box (Box (Interval (0, w),
289 Interval (-h / 2, h / 2)), blot);
293 Bar_line::tick_bar_line (Grob *me, Real h, bool rounded)
295 Real th = Staff_symbol_referencer::staff_space (me) / 2;
296 Real line_thick = Staff_symbol_referencer::line_thickness (me);
300 ? me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"))
303 return Lookup::round_filled_box (Box (Interval (0, line_thick),
304 Interval (h / 2 - th, h / 2 + th)), blot);
307 MAKE_SCHEME_CALLBACK (Bar_line, calc_bar_size, 1);
309 Bar_line::calc_bar_size (SCM smob)
311 Grob *me = unsmob_grob (smob);
312 if (Grob *staff = Staff_symbol_referencer::get_staff_symbol (me))
314 Interval staff_y = staff->extent (staff, Y_AXIS);
315 return scm_from_double (staff_y.is_empty () ? 0.0 : staff_y.length ());
317 return scm_from_int (0);
321 Bar_line::dashed_bar_line (Grob *me, Real h, Real thick)
324 = 1.0 - robust_scm2double (me->get_property ("gap"), 0.3);
326 this is a tad complex for what we want to achieve, but with a
327 simple line, the round blotting interferes with staff line
330 Real ss = Staff_symbol_referencer::staff_space (me);
331 int count = Staff_symbol_referencer::line_count (me);
332 Real line_thick = Staff_symbol_referencer::line_thickness (me);
334 if (fabs (line_thick + (count -1) * ss - h) < 0.1) // ugh.
337 = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
339 Real half_space = ss / 2;
342 for (int i = (count - 1); i >= -(count - 1); i -= 2)
344 Real top_y = min ((i + dash_size) * half_space,
345 (count - 1) * half_space + line_thick / 2);
346 Real bot_y = max ((i - dash_size) * half_space,
347 -(count - 1) * half_space - line_thick / 2);
349 bar.add_stencil (Lookup::round_filled_box (Box (Interval (0, thick),
350 Interval (bot_y, top_y)),
358 We have to scale the dashing so it starts and ends with half a
361 int dashes = int (rint (h / ss));
362 Real total_dash_size = h / dashes;
363 Real factor = (dash_size - thick) / ss;
365 SCM at = scm_list_n (ly_symbol2scm ("dashed-line"),
366 scm_from_double (thick),
367 scm_from_double (factor * total_dash_size),
368 scm_from_double ((1 - factor) * total_dash_size),
371 scm_from_double (factor * total_dash_size * 0.5),
375 box.add_point (Offset (0, 0));
376 box.add_point (Offset (0, h));
379 s.translate (Offset (thick / 2, -h / 2));
385 MAKE_SCHEME_CALLBACK (Bar_line, calc_anchor, 1)
387 Bar_line::calc_anchor (SCM smob)
389 Grob *me = unsmob_grob (smob);
390 Real kern = robust_scm2double (me->get_property ("kern"), 1);
391 Real staffline = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
392 string str = robust_scm2string (me->get_property ("glyph-name"), "");
394 /* we put the anchor in the center of the barline, unless we are
395 a repeat bar, in which case we put the anchor in the center of
396 the barline without the dots. */
397 Interval ext = me->extent (me, X_AXIS);
399 return scm_from_double (0);
401 Real anchor = ext.center ();
403 Stencil dot = Font_interface::get_default_font (me)->find_by_name ("dots.dot");
404 Real dot_width = dot.extent (X_AXIS).length () + kern * staffline;
406 anchor -= dot_width / 2;
407 else if (str == ":|")
408 anchor += dot_width / 2;
410 return scm_from_double (anchor);
413 ADD_INTERFACE (Bar_line,
416 "Print a special bar symbol. It replaces the regular bar"
417 " symbol with a special symbol. The argument @var{bartype}"
418 " is a string which specifies the kind of bar line to print."
419 " Options are @code{|}, @code{:|}, @code{|:}, @code{:|:}, @code{:|.|:},"
420 " @code{:|.:}, @code{.}, @code{||}, @code{|.}, @code{.|}, @code{.|.},"
421 " @code{|.|}, @code{:}, @code{dashed}, @code{'} and @code{S}.\n"
423 "These produce, respectively, a normal bar line, a right repeat, a left repeat,"
424 " a thick double repeat, a thin-thick-thin double repeat,"
425 " a thin-thick double repeat, a thick bar, a double bar, a start bar,"
426 " an end bar, a thick double bar, a thin-thick-thin bar,"
427 " a dotted bar, a dashed bar, a tick as bar line and a segno bar.\n"
429 "In addition, there is an option"
430 " @code{||:} which is equivalent to @code{|:} except at line"
431 " breaks, where it produces a double bar (@code{||}) at the"
432 " end of the line and a repeat sign (@code{|:}) at the"
433 " beginning of the new line.\n"
435 "For segno, @code{S} produces a segno sign except at line breaks,"
436 " where it produces a double bar (@code{||}) at the"
437 " end of the line and a segno sign at the beginning of the new line."
438 " @code{|S} is equivalent to @code{S} but produces a simple bar line"
439 " (@code{|}) instead of a double bar line (@code{||}) at line breaks."
440 " @code{S|} produces the segno sign at line breaks and starts the following"
441 " line without special bar lines.\n"
443 "@code{S|:} and @code{:|S} are used for repeat/segno combinations that are"
444 " separated at line breaks. Alternatively, @code{.S|:} and @code{:|S.}"
445 " may be used which combine repeat signs and segno at the same line in"
446 " case of a line break. @code{:|S|:} is a combination of a left repeat"
447 " (@code{:|}), a segno (@code{S}) and a right repeat @code{|:} which"
448 " splits before the segno at line breaks; @code{:|S.|:} splits after"
451 "If @var{bartype} is set to @code{empty} then nothing is"
452 " printed, but a line break is allowed at that spot.\n"
454 "@code{gap} is used for the gaps in dashed bar lines.",