2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2000--2012 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 "system-start-delimiter.hh"
21 #include "text-interface.hh"
22 #include "all-font-metrics.hh"
23 #include "axis-group-interface.hh"
24 #include "font-interface.hh"
26 #include "line-interface.hh"
28 #include "output-def.hh"
29 #include "pointer-group-interface.hh"
31 #include "staff-symbol-referencer.hh"
34 System_start_delimiter::staff_bracket (Grob *me, Real height)
36 Font_metric *fm = Font_interface::get_default_font (me);
38 Drul_array<Stencil> tips (fm->find_by_name ("brackettips.down"),
39 fm->find_by_name ("brackettips.up"));
41 Real thickness = robust_scm2double (me->get_property ("thickness"), 0.25);
43 Real overlap = 0.1 * thickness;
45 Box box (Interval (0, thickness),
47 * (height / 2 + overlap));
49 Stencil bracket = Lookup::filled_box (box);
51 bracket.add_at_edge (Y_AXIS, d, tips[d], -overlap);
52 bracket = Stencil (box, bracket.expr ());
54 bracket.translate_axis (-0.8, X_AXIS);
60 System_start_delimiter::line_bracket (Grob *me, Real height)
63 = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"))
64 * robust_scm2double (me->get_property ("thickness"), 1);
67 Stencil tip1 = Line_interface::make_line (thick,
68 Offset (0, -height / 2),
69 Offset (w, -height / 2));
70 Stencil tip2 = Line_interface::make_line (thick,
71 Offset (0, height / 2),
72 Offset (w, height / 2));
73 Stencil vline = Line_interface::make_line (thick,
74 Offset (0, -height / 2),
75 Offset (0, height / 2));
77 vline.add_stencil (tip1);
78 vline.add_stencil (tip2);
79 vline.translate_axis (-w, X_AXIS);
84 System_start_delimiter::simple_bar (Grob *me, Real h)
86 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
87 Real w = lt * robust_scm2double (me->get_property ("thickness"), 1);
88 return Lookup::round_filled_box (Box (Interval (0, w), Interval (-h / 2, h / 2)),
92 MAKE_SCHEME_CALLBACK (System_start_delimiter, print, 1);
94 System_start_delimiter::print (SCM smob)
96 Spanner *me = unsmob_spanner (smob);
97 extract_grob_set (me, "elements", elts);
98 Grob *common = common_refpoint_of_array (elts, me, Y_AXIS);
101 Real staffspace = 1.0;
102 int non_empty_count = 0;
103 for (vsize i = elts.size (); i--;)
105 Spanner *sp = dynamic_cast<Spanner *> (elts[i]);
108 && sp->get_bound (LEFT) == me->get_bound (LEFT))
110 Interval dims = sp->extent (common, Y_AXIS);
111 if (!dims.is_empty ())
115 staffspace = Staff_symbol_referencer::staff_space (sp);
120 SCM glyph_sym = me->get_property ("style");
121 Real len = ext.length ();
123 // Use collapse-height in multiples of the staff-space
125 || (robust_scm2double (me->get_property ("collapse-height"), 0.0) >= (len / staffspace)))
128 return SCM_UNSPECIFIED;
132 if (glyph_sym == ly_symbol2scm ("bracket"))
133 m = staff_bracket (me, len);
134 else if (glyph_sym == ly_symbol2scm ("brace"))
135 m = staff_brace (me, len);
136 else if (glyph_sym == ly_symbol2scm ("bar-line"))
137 m = simple_bar (me, len);
138 else if (glyph_sym == ly_symbol2scm ("line-bracket"))
139 m = line_bracket (me, len);
141 m.translate_axis (ext.center (), Y_AXIS);
142 return m.smobbed_copy ();
146 System_start_delimiter::staff_brace (Grob *me, Real y)
151 Find the default brace font if the user overrides it.
153 fm = Font_interface::get_default_font (me);
157 int hi = max ((int) fm->count () - 1, 2);
159 /* do a binary search for each Y, not very efficient, but passable? */
163 int cmp = (lo + hi) / 2;
164 b = fm->get_indexed_char_dimensions (cmp);
165 if (b[Y_AXIS].is_empty () || b[Y_AXIS].length () > y)
172 Stencil stil (fm->find_by_name ("brace" + ::to_string (lo)));
173 stil.translate_axis (-b[X_AXIS].length () / 2, X_AXIS);
175 stil.translate_axis (-0.2, X_AXIS);
180 ADD_INTERFACE (System_start_delimiter,
181 "The brace, bracket or bar in front of the system. The"
182 " following values for @code{style} are recognized:\n"
186 "A thick bracket, normally used to group similar"
187 " instruments in a score. Default for @code{StaffGroup}."
188 " @code{SystemStartBracket} uses this style.\n"
190 "A @q{piano style} brace normally used for an instrument"
191 " that uses two staves. The default style for"
192 " @code{GrandStaff}. @code{SystemStartBrace} uses this"
195 "A simple line between the staves in a score. Default"
196 " for staves enclosed in @code{<<} and @code{>>}."
197 " @code{SystemStartBar} uses this style.\n"
198 "@item line-bracket\n"
199 "A simple square, normally used for subgrouping"
200 " instruments in a score. @code{SystemStartSquare} uses"
204 "See also @file{input/regression/system-start-nesting.ly}.",