2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--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 "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);
56 SCM width_scm = me->get_property ("width");
57 if (d == RIGHT && scm_is_number (width_scm))
60 don't multiply by Staff_symbol_referencer::staff_space (me),
61 since that would make aligning staff symbols of different sizes to
62 one right margin hell.
64 span_points[RIGHT] = scm_to_double (width_scm);
68 Item *x = sp->get_bound (d);
70 span_points[d] = ((!x->break_status_dir ()
71 && !x->extent (x, X_AXIS).is_empty ())
72 ? Paper_column::break_align_width (x, ly_symbol2scm ("break-alignment"))[d]
73 : x->relative_coordinate (common, X_AXIS));
76 span_points[d] -= d * t / 2;
78 while (flip (&d) != LEFT);
82 vector<Real> line_positions = Staff_symbol::line_positions (me);
85 = Lookup::horizontal_line (span_points
86 - me->relative_coordinate (common, X_AXIS),
89 Real space = staff_space (me);
90 for (vector<Real>::const_iterator i = line_positions.begin (),
91 e = line_positions.end ();
96 b.translate_axis (*i * 0.5 * space, Y_AXIS);
99 return m.smobbed_copy ();
103 Staff_symbol::line_positions (Grob *me)
105 SCM line_positions = me->get_property ("line-positions");
106 if (scm_is_pair (line_positions))
108 int line_count = scm_ilength (line_positions);
109 vector<Real> values (line_count);
111 for (SCM s = line_positions; scm_is_pair (s);
114 values[i++] = scm_to_double (scm_car (s));
120 int line_count = Staff_symbol::line_count (me);
121 Real height = line_count - 1;
122 vector<Real> values (line_count);
123 for (int i = 0; i < line_count; i++)
125 values[i] = height - i * 2;
132 Staff_symbol::ledger_positions (Grob *me, int pos)
134 SCM ledger_positions = me->get_property ("ledger-positions");
135 Real ledger_extra = robust_scm2double (me->get_property ("ledger-extra"), 0);
136 vector<Real> line_positions = Staff_symbol::line_positions (me);
139 if (line_positions.empty ())
142 // find the staff line nearest to note position
143 Real nearest_line = line_positions[0];
144 Real line_dist = abs (line_positions[0] - pos);
145 for (vector<Real>::const_iterator i = line_positions.begin (),
146 e = line_positions.end ();
150 if (abs (*i - pos) < line_dist)
153 line_dist = abs (*i - pos);
160 Direction dir = (Direction)sign (pos - nearest_line);
162 if (scm_is_pair (ledger_positions))
163 // custom ledger line positions
165 Real min_pos = HUGE_VAL;
166 Real max_pos = -HUGE_VAL;
169 // find the extent of the ledger pattern
170 for (SCM s = ledger_positions; scm_is_pair (s); s = scm_cdr (s))
173 if (!scm_is_number (s2))
175 Real current_ledger = scm_to_double (s2);
176 if (current_ledger > max_pos)
177 max_pos = current_ledger;
178 if (current_ledger < min_pos)
179 min_pos = current_ledger;
182 Real cycle = max_pos - min_pos;
184 Interval ledger_fill;
185 ledger_fill.add_point (nearest_line + 0.5 * dir);
186 ledger_fill.add_point (pos + 0.5 * dir + ledger_extra * dir);
188 // fill the Interval ledger_fill with ledger lines
189 int n = (int) floor ((ledger_fill[DOWN] - min_pos) / cycle);
191 SCM s = scm_cdr (ledger_positions);
192 if (!scm_is_pair (s) || cycle < 0.1)
197 if (scm_is_number (s2))
199 current = scm_to_double (s2) + n * cycle;
200 if (ledger_fill.contains (current))
201 values.push_back (current);
204 // grouped ledger lines, either add all or none
208 current = scm_to_double (scm_car (s2)) + n * cycle;
209 if (ledger_fill.contains (current))
214 current = scm_to_double (scm_car (s2)) + n * cycle;
215 values.push_back (current);
218 while (scm_is_pair (s2));
223 while (scm_is_pair (s2));
226 if (!scm_is_pair (s))
228 s = scm_cdr (ledger_positions);
232 while (current <= ledger_fill[UP]);
235 // normal ledger lines
237 int ledger_count = (int) floor ((abs (nearest_line - pos) + ledger_extra) / 2);
238 values.resize (ledger_count);
239 for (int i = 0; i < ledger_count; i++)
241 values[i] = nearest_line + dir * (ledger_count - i) * 2;
248 Staff_symbol::line_count (Grob *me)
250 SCM line_positions = me->get_property ("line-positions");
251 if (scm_is_pair (line_positions))
252 return scm_ilength (line_positions);
254 return robust_scm2int (me->get_property ("line-count"), 0);
258 Staff_symbol::staff_space (Grob *me)
260 return robust_scm2double (me->get_property ("staff-space"), 1.0);
264 Staff_symbol::get_line_thickness (Grob *me)
266 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
268 return robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
272 Staff_symbol::get_ledger_line_thickness (Grob *me)
274 SCM lt_pair = me->get_property ("ledger-line-thickness");
275 Offset z = robust_scm2offset (lt_pair, Offset (1.0, 0.1));
277 return z[X_AXIS] * get_line_thickness (me) + z[Y_AXIS] * staff_space (me);
280 MAKE_SCHEME_CALLBACK (Staff_symbol, height, 1);
282 Staff_symbol::height (SCM smob)
284 Grob *me = unsmob_grob (smob);
285 Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
286 t *= robust_scm2double (me->get_property ("thickness"), 1.0);
288 SCM line_positions = me->get_property ("line-positions");
291 Real space = staff_space (me);
292 if (scm_is_pair (line_positions))
294 for (SCM s = line_positions; scm_is_pair (s);
296 y_ext.add_point (scm_to_double (scm_car (s)) * 0.5 * space);
300 int l = Staff_symbol::line_count (me);
301 Real height = (l - 1) * staff_space (me) / 2;
302 y_ext = Interval (-height, height);
305 return ly_interval2scm (y_ext);
309 Staff_symbol::on_line (Grob *me, int pos, bool allow_ledger)
311 SCM line_positions = me->get_property ("line-positions");
312 if (scm_is_pair (line_positions))
314 Real min_line = HUGE_VAL;
315 Real max_line = -HUGE_VAL;
316 for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
318 Real current_line = scm_to_double (scm_car (s));
319 if (pos == current_line)
321 if (current_line > max_line)
322 max_line = current_line;
323 if (current_line < min_line)
324 min_line = current_line;
331 return (( (int) (rint (pos - min_line)) % 2) == 0);
333 return (( (int) (rint (pos - max_line)) % 2) == 0);
340 int const line_cnt = line_count (me);
341 bool result = abs (pos + line_cnt) % 2 == 1;
342 if (result && !allow_ledger)
344 result = -line_cnt < pos && pos < line_cnt;
351 Staff_symbol::line_span (Grob *me)
353 SCM line_positions = me->get_property ("line-positions");
356 if (scm_is_pair (line_positions))
357 for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
358 iv.add_point (scm_to_double (scm_car (s)));
361 int count = line_count (me);
362 return Interval (-count + 1, count - 1);
368 ADD_INTERFACE (Staff_symbol,
369 "This spanner draws the lines of a staff. A staff symbol"
370 " defines a vertical unit, the @emph{staff space}. Quantities"
371 " that go by a half staff space are called @emph{positions}."
372 " The center (i.e., middle line or space) is position@tie{}0."
373 " The length of the symbol may be set by hand through the"
374 " @code{width} property.",
378 "ledger-line-thickness "