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 "staff-symbol.hh"
23 #include "dimensions.hh"
24 #include "output-def.hh"
27 #include "staff-symbol-referencer.hh"
30 MAKE_SCHEME_CALLBACK (Staff_symbol, print, 1);
33 Staff_symbol::print (SCM smob)
35 Grob *me = unsmob_grob (smob);
36 Spanner *sp = dynamic_cast<Spanner *> (me);
38 = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
40 Interval span_points (0, 0);
43 For raggedright without ragged staves, simply set width to the linewidth.
45 (ok -- lousy UI, since width is in staff spaces)
49 Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
50 t *= robust_scm2double (me->get_property ("thickness"), 1.0);
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->relative_coordinate (common, X_AXIS);
70 if (!x->break_status_dir ()
71 && !x->extent (x, X_AXIS).is_empty ())
72 span_points[d] += x->extent (x, X_AXIS)[d];
75 span_points[d] -= d * t / 2;
77 while (flip (&d) != LEFT);
81 vector<Real> line_positions = Staff_symbol::line_positions (me);
82 int line_count = line_positions.size ();
85 = Lookup::horizontal_line (span_points
86 - me->relative_coordinate (common, X_AXIS),
89 Real space = staff_space (me);
90 for (int i = 0; i < line_count; i++)
93 b.translate_axis (line_positions[i] * 0.5 * space, Y_AXIS);
96 return m.smobbed_copy ();
100 Staff_symbol::line_positions (Grob *me)
102 SCM line_positions = me->get_property ("line-positions");
103 if (scm_is_pair (line_positions))
105 int line_count = scm_ilength (line_positions);
106 vector<Real> values (line_count);
108 for (SCM s = line_positions; scm_is_pair (s);
111 values[i++] = scm_to_double (scm_car (s));
117 int line_count = Staff_symbol::line_count (me);
118 Real height = line_count - 1;
119 vector<Real> values (line_count);
120 for (int i = 0; i < line_count; i++)
122 values[i] = height - i * 2;
129 Staff_symbol::ledger_positions (Grob *me, int pos)
131 SCM ledger_positions = me->get_property ("ledger-positions");
132 Real ledger_extra = robust_scm2double (me->get_property ("ledger-extra"), 0);
133 vector<Real> line_positions = Staff_symbol::line_positions (me);
136 if (line_positions.empty ())
139 int line_count = line_positions.size ();
141 // find the staff line nearest to note position
142 Real nearest_line = line_positions[0];
143 Real line_dist = abs (line_positions[0] - pos);
144 for (int i = 1; i < line_count; i++)
146 if (abs (line_positions[i] - pos) < line_dist)
148 nearest_line = line_positions[i];
149 line_dist = abs (line_positions[i] - pos);
156 Direction dir = (Direction)sign (pos - nearest_line);
158 if (scm_is_pair (ledger_positions))
159 // custom ledger line positions
161 Real min_pos = HUGE_VAL;
162 Real max_pos = -HUGE_VAL;
165 // find the extent of the ledger pattern
166 for (SCM s = ledger_positions; scm_is_pair (s); s = scm_cdr (s))
169 if (!scm_is_number (s2))
171 Real current_ledger = scm_to_double (s2);
172 if (current_ledger > max_pos)
173 max_pos = current_ledger;
174 if (current_ledger < min_pos)
175 min_pos = current_ledger;
178 Real cycle = max_pos - min_pos;
180 Interval ledger_fill;
181 ledger_fill.add_point (nearest_line + 0.5 * dir);
182 ledger_fill.add_point (pos + 0.5 * dir + ledger_extra * dir);
184 // fill the Interval ledger_fill with ledger lines
185 int n = (int) floor ((ledger_fill[DOWN] - min_pos) / cycle);
187 SCM s = scm_cdr (ledger_positions);
188 if (!scm_is_pair (s) || cycle < 0.1)
193 if (scm_is_number (s2))
195 current = scm_to_double (s2) + n * cycle;
196 if (ledger_fill.contains (current))
197 values.push_back (current);
200 // grouped ledger lines, either add all or none
204 current = scm_to_double (scm_car (s2)) + n * cycle;
205 if (ledger_fill.contains (current))
210 current = scm_to_double (scm_car (s2)) + n * cycle;
211 values.push_back (current);
214 while (scm_is_pair (s2));
219 while (scm_is_pair (s2));
222 if (!scm_is_pair (s))
224 s = scm_cdr (ledger_positions);
228 while (current <= ledger_fill[UP]);
231 // normal ledger lines
233 int ledger_count = (int) floor ((abs (nearest_line - pos) + ledger_extra) / 2);
234 values.resize (ledger_count);
235 for (int i = 0; i < ledger_count; i++)
237 values[i] = nearest_line + dir * (ledger_count - i) * 2;
244 Staff_symbol::line_count (Grob *me)
246 SCM line_positions = me->get_property ("line-positions");
247 if (scm_is_pair (line_positions))
248 return scm_ilength (line_positions);
250 return robust_scm2int (me->get_property ("line-count"), 0);
254 Staff_symbol::staff_space (Grob *me)
256 return robust_scm2double (me->get_property ("staff-space"), 1.0);
260 Staff_symbol::get_line_thickness (Grob *me)
262 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
264 return robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
268 Staff_symbol::get_ledger_line_thickness (Grob *me)
270 SCM lt_pair = me->get_property ("ledger-line-thickness");
271 Offset z = robust_scm2offset (lt_pair, Offset (1.0, 0.1));
273 return z[X_AXIS] * get_line_thickness (me) + z[Y_AXIS] * staff_space (me);
276 MAKE_SCHEME_CALLBACK (Staff_symbol, height, 1);
278 Staff_symbol::height (SCM smob)
280 Grob *me = unsmob_grob (smob);
281 Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
282 t *= robust_scm2double (me->get_property ("thickness"), 1.0);
284 SCM line_positions = me->get_property ("line-positions");
287 Real space = staff_space (me);
288 if (scm_is_pair (line_positions))
290 for (SCM s = line_positions; scm_is_pair (s);
292 y_ext.add_point (scm_to_double (scm_car (s)) * 0.5 * space);
296 int l = Staff_symbol::line_count (me);
297 Real height = (l - 1) * staff_space (me) / 2;
298 y_ext = Interval (-height, height);
301 return ly_interval2scm (y_ext);
305 Staff_symbol::on_line (Grob *me, int pos)
307 SCM line_positions = me->get_property ("line-positions");
308 if (scm_is_pair (line_positions))
310 Real min_line = HUGE_VAL;
311 Real max_line = -HUGE_VAL;
312 for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
314 Real current_line = scm_to_double (scm_car (s));
315 if (pos == current_line)
317 if (current_line > max_line)
318 max_line = current_line;
319 if (current_line < min_line)
320 min_line = current_line;
324 return (( (int) (rint (pos - min_line)) % 2) == 0);
326 return (( (int) (rint (pos - max_line)) % 2) == 0);
331 return ((abs (pos + line_count (me)) % 2) == 1);
335 Staff_symbol::line_span (Grob *me)
337 SCM line_positions = me->get_property ("line-positions");
340 if (scm_is_pair (line_positions))
341 for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
342 iv.add_point (scm_to_double (scm_car (s)));
345 int count = line_count (me);
346 return Interval (-count + 1, count - 1);
352 ADD_INTERFACE (Staff_symbol,
353 "This spanner draws the lines of a staff. A staff symbol"
354 " defines a vertical unit, the @emph{staff space}. Quantities"
355 " that go by a half staff space are called @emph{positions}."
356 " The center (i.e., middle line or space) is position@tie{}0."
357 " The length of the symbol may be set by hand through the"
358 " @code{width} property.",
362 "ledger-line-thickness "