2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2014 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 "staff-symbol.hh"
23 #include "dimensions.hh"
24 #include "output-def.hh"
25 #include "paper-column.hh"
28 #include "staff-symbol-referencer.hh"
31 MAKE_SCHEME_CALLBACK (Staff_symbol, print, 1);
34 Staff_symbol::print (SCM smob)
36 Grob *me = unsmob_grob (smob);
37 Spanner *sp = dynamic_cast<Spanner *> (me);
39 = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
41 Interval span_points (0, 0);
44 For raggedright without ragged staves, simply set width to the linewidth.
46 (ok -- lousy UI, since width is in staff spaces)
50 Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
51 t *= robust_scm2double (me->get_property ("thickness"), 1.0);
53 for (LEFT_and_RIGHT (d))
55 SCM width_scm = me->get_property ("width");
56 if (d == RIGHT && scm_is_number (width_scm))
59 don't multiply by Staff_symbol_referencer::staff_space (me),
60 since that would make aligning staff symbols of different sizes to
61 one right margin hell.
63 span_points[RIGHT] = scm_to_double (width_scm);
67 Item *x = sp->get_bound (d);
69 span_points[d] = ((!x->break_status_dir ()
70 && !x->extent (x, X_AXIS).is_empty ())
71 ? Paper_column::break_align_width (x, ly_symbol2scm ("break-alignment"))[d]
72 : x->relative_coordinate (common, X_AXIS));
75 span_points[d] -= d * t / 2;
80 vector<Real> line_positions = Staff_symbol::line_positions (me);
83 = Lookup::horizontal_line (span_points
84 - me->relative_coordinate (common, X_AXIS),
87 Real space = staff_space (me);
88 for (vector<Real>::const_iterator i = line_positions.begin (),
89 e = line_positions.end ();
94 b.translate_axis (*i * 0.5 * space, Y_AXIS);
97 return m.smobbed_copy ();
101 Staff_symbol::line_positions (Grob *me)
103 SCM line_positions = me->get_property ("line-positions");
104 if (scm_is_pair (line_positions))
106 int line_count = scm_ilength (line_positions);
107 vector<Real> values (line_count);
109 for (SCM s = line_positions; scm_is_pair (s);
112 values[i++] = scm_to_double (scm_car (s));
118 int line_count = Staff_symbol::line_count (me);
119 Real height = line_count - 1;
120 vector<Real> values (line_count);
121 for (int i = 0; i < line_count; i++)
123 values[i] = height - i * 2;
130 Staff_symbol::ledger_positions (Grob *me, int pos)
132 SCM ledger_positions = me->get_property ("ledger-positions");
133 Real ledger_extra = robust_scm2double (me->get_property ("ledger-extra"), 0);
134 vector<Real> line_positions = Staff_symbol::line_positions (me);
137 if (line_positions.empty ())
140 // find the staff line nearest to note position
141 Real nearest_line = line_positions[0];
142 Real line_dist = abs (line_positions[0] - pos);
143 for (vector<Real>::const_iterator i = line_positions.begin (),
144 e = line_positions.end ();
148 if (abs (*i - pos) < line_dist)
151 line_dist = abs (*i - pos);
158 Direction dir = (Direction)sign (pos - nearest_line);
160 if (scm_is_pair (ledger_positions))
161 // custom ledger line positions
163 Real min_pos = HUGE_VAL;
164 Real max_pos = -HUGE_VAL;
167 // find the extent of the ledger pattern
168 for (SCM s = ledger_positions; scm_is_pair (s); s = scm_cdr (s))
171 if (!scm_is_number (s2))
173 Real current_ledger = scm_to_double (s2);
174 if (current_ledger > max_pos)
175 max_pos = current_ledger;
176 if (current_ledger < min_pos)
177 min_pos = current_ledger;
180 Real cycle = max_pos - min_pos;
182 Interval ledger_fill;
183 ledger_fill.add_point (nearest_line + 0.5 * dir);
184 ledger_fill.add_point (pos + 0.5 * dir + ledger_extra * dir);
186 // fill the Interval ledger_fill with ledger lines
187 int n = (int) floor ((ledger_fill[DOWN] - min_pos) / cycle);
189 SCM s = scm_cdr (ledger_positions);
190 if (!scm_is_pair (s) || cycle < 0.1)
195 if (scm_is_number (s2))
197 current = scm_to_double (s2) + n * cycle;
198 if (ledger_fill.contains (current))
199 values.push_back (current);
202 // grouped ledger lines, either add all or none
206 current = scm_to_double (scm_car (s2)) + n * cycle;
207 if (ledger_fill.contains (current))
212 current = scm_to_double (scm_car (s2)) + n * cycle;
213 values.push_back (current);
216 while (scm_is_pair (s2));
221 while (scm_is_pair (s2));
224 if (!scm_is_pair (s))
226 s = scm_cdr (ledger_positions);
230 while (current <= ledger_fill[UP]);
233 // normal ledger lines
235 int ledger_count = (int) floor ((abs (nearest_line - pos) + ledger_extra) / 2);
236 values.resize (ledger_count);
237 for (int i = 0; i < ledger_count; i++)
239 values[i] = nearest_line + dir * (ledger_count - i) * 2;
246 Staff_symbol::line_count (Grob *me)
248 SCM line_positions = me->get_property ("line-positions");
249 if (scm_is_pair (line_positions))
250 return scm_ilength (line_positions);
252 return robust_scm2int (me->get_property ("line-count"), 0);
256 Staff_symbol::staff_space (Grob *me)
258 return robust_scm2double (me->get_property ("staff-space"), 1.0);
262 Staff_symbol::get_line_thickness (Grob *me)
264 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
266 return robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
270 Staff_symbol::get_ledger_line_thickness (Grob *me)
272 SCM lt_pair = me->get_property ("ledger-line-thickness");
273 Offset z = robust_scm2offset (lt_pair, Offset (1.0, 0.1));
275 return z[X_AXIS] * get_line_thickness (me) + z[Y_AXIS] * staff_space (me);
278 MAKE_SCHEME_CALLBACK (Staff_symbol, height, 1);
280 Staff_symbol::height (SCM smob)
282 Grob *me = unsmob_grob (smob);
283 Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
284 t *= robust_scm2double (me->get_property ("thickness"), 1.0);
286 SCM line_positions = me->get_property ("line-positions");
289 Real space = staff_space (me);
290 if (scm_is_pair (line_positions))
292 for (SCM s = line_positions; scm_is_pair (s);
294 y_ext.add_point (scm_to_double (scm_car (s)) * 0.5 * space);
298 int l = Staff_symbol::line_count (me);
299 Real height = (l - 1) * staff_space (me) / 2;
300 y_ext = Interval (-height, height);
303 return ly_interval2scm (y_ext);
307 Staff_symbol::on_line (Grob *me, int pos, bool allow_ledger)
309 SCM line_positions = me->get_property ("line-positions");
310 if (scm_is_pair (line_positions))
312 Real min_line = HUGE_VAL;
313 Real max_line = -HUGE_VAL;
314 for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
316 Real current_line = scm_to_double (scm_car (s));
317 if (pos == current_line)
319 if (current_line > max_line)
320 max_line = current_line;
321 if (current_line < min_line)
322 min_line = current_line;
329 return (( (int) (rint (pos - min_line)) % 2) == 0);
331 return (( (int) (rint (pos - max_line)) % 2) == 0);
338 int const line_cnt = line_count (me);
339 bool result = abs (pos + line_cnt) % 2 == 1;
340 if (result && !allow_ledger)
342 result = -line_cnt < pos && pos < line_cnt;
349 Staff_symbol::line_span (Grob *me)
351 SCM line_positions = me->get_property ("line-positions");
354 if (scm_is_pair (line_positions))
355 for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
356 iv.add_point (scm_to_double (scm_car (s)));
359 int count = line_count (me);
360 return Interval (-count + 1, count - 1);
366 ADD_INTERFACE (Staff_symbol,
367 "This spanner draws the lines of a staff. A staff symbol"
368 " defines a vertical unit, the @emph{staff space}. Quantities"
369 " that go by a half staff space are called @emph{positions}."
370 " The center (i.e., middle line or space) is position@tie{}0."
371 " The length of the symbol may be set by hand through the"
372 " @code{width} property.",
376 "ledger-line-thickness "