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 SCM line_positions = me->get_property ("line-positions");
83 = Lookup::horizontal_line (span_points
84 - me->relative_coordinate (common, X_AXIS),
87 Real space = staff_space (me);
88 if (scm_is_pair (line_positions))
90 for (SCM s = line_positions; scm_is_pair (s);
94 b.translate_axis (scm_to_double (scm_car (s))
95 * 0.5 * space, Y_AXIS);
101 int l = Staff_symbol::line_count (me);
102 Real height = (l - 1) * staff_space (me) / 2;
103 for (int i = 0; i < l; i++)
106 b.translate_axis (height - i * space, Y_AXIS);
110 return m.smobbed_copy ();
114 Staff_symbol::get_steps (Grob *me)
116 return line_count (me) * 2;
120 Staff_symbol::line_count (Grob *me)
122 SCM c = me->get_property ("line-count");
123 if (scm_is_number (c))
124 return scm_to_int (c);
130 Staff_symbol::staff_space (Grob *me)
132 return robust_scm2double (me->get_property ("staff-space"), 1.0);
136 Staff_symbol::get_line_thickness (Grob *me)
138 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
140 return robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
144 Staff_symbol::get_ledger_line_thickness (Grob *me)
146 SCM lt_pair = me->get_property ("ledger-line-thickness");
147 Offset z = robust_scm2offset (lt_pair, Offset (1.0, 0.1));
149 return z[X_AXIS] * get_line_thickness (me) + z[Y_AXIS] * staff_space (me);
152 MAKE_SCHEME_CALLBACK (Staff_symbol, height, 1);
154 Staff_symbol::height (SCM smob)
156 Grob *me = unsmob_grob (smob);
157 Real t = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
158 t *= robust_scm2double (me->get_property ("thickness"), 1.0);
160 SCM line_positions = me->get_property ("line-positions");
163 Real space = staff_space (me);
164 if (scm_is_pair (line_positions))
166 for (SCM s = line_positions; scm_is_pair (s);
168 y_ext.add_point (scm_to_double (scm_car (s)) * 0.5 * space);
172 int l = Staff_symbol::line_count (me);
173 Real height = (l - 1) * staff_space (me) / 2;
174 y_ext = Interval (-height, height);
177 return ly_interval2scm (y_ext);
181 Staff_symbol::on_line (Grob *me, int pos)
183 SCM line_positions = me->get_property ("line-positions");
184 if (scm_is_pair (line_positions))
186 Real min_line = HUGE_VAL;
187 Real max_line = -HUGE_VAL;
188 for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
190 Real current_line = scm_to_double (scm_car (s));
191 if (pos == current_line)
193 if (current_line > max_line)
194 max_line = current_line;
195 if (current_line < min_line)
196 min_line = current_line;
200 return (( (int) (rint (pos - min_line)) % 2) == 0);
202 return (( (int) (rint (pos - max_line)) % 2) == 0);
207 return ((abs (pos + line_count (me)) % 2) == 1);
211 Staff_symbol::line_span (Grob *me)
213 SCM line_positions = me->get_property ("line-positions");
216 if (scm_is_pair (line_positions))
217 for (SCM s = line_positions; scm_is_pair (s); s = scm_cdr (s))
218 iv.add_point (scm_to_double (scm_car (s)));
221 int count = line_count (me);
222 return Interval (-count + 1, count - 1);
228 ADD_INTERFACE (Staff_symbol,
229 "This spanner draws the lines of a staff. A staff symbol"
230 " defines a vertical unit, the @emph{staff space}. Quantities"
231 " that go by a half staff space are called @emph{positions}."
232 " The center (i.e., middle line or space) is position@tie{}0."
233 " The length of the symbol may be set by hand through the"
234 " @code{width} property.",
237 "ledger-line-thickness "