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/>.
22 #include "directional-element-interface.hh"
24 #include "font-interface.hh"
25 #include "international.hh"
26 #include "output-def.hh"
27 #include "paper-score.hh"
28 #include "staff-symbol-referencer.hh"
29 #include "staff-symbol.hh"
34 MAKE_SCHEME_CALLBACK (Rest, y_offset_callback, 1);
36 Rest::y_offset_callback (SCM smob)
38 Grob *me = unsmob_grob (smob);
39 int duration_log = scm_to_int (me->get_property ("duration-log"));
40 Real ss = Staff_symbol_referencer::staff_space (me);
42 return scm_from_double (ss * 0.5 * Rest::staff_position_internal (me, duration_log, get_grob_direction (me)));
46 Rest::staff_position_internal (Grob *me, int duration_log, int dir)
51 bool position_override = scm_is_number (me->get_property ("staff-position"));
54 if (position_override)
57 = robust_scm2double (me->get_property ("staff-position"), 0);
60 semibreve rests are positioned one staff line off
62 if (duration_log == 0)
66 trust the client on good positioning;
67 would be tempting to adjust position of rests longer than a quarter
68 to be properly aligned to staff lines,
69 but custom rest shapes may not need that sort of care.
78 /* Only half notes or longer want alignment with staff lines */
82 We need a staff symbol for actually aligning anything
84 Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
88 std::vector<Real> linepos = Staff_symbol::line_positions (staff);
93 std::sort (linepos.begin (), linepos.end ());
95 if (duration_log == 0)
98 lower voice semibreve rests generally hang a line lower
105 make a semibreve rest hang from the next available line,
106 except when there is none.
109 std::vector<Real>::const_iterator it
110 = std::upper_bound (linepos.begin (), linepos.end (), pos);
111 if (it != linepos.end ())
114 pos = linepos.back ();
118 std::vector<Real>::const_iterator it
119 = std::upper_bound (linepos.begin (), linepos.end (), pos);
120 if (it != linepos.begin ())
125 /* Finished for neutral position */
129 /* If we have a voiced position, make sure that it's on the
130 proper side of neutral before using it. If it isn't, we fall
131 back to a constant offset from neutral position.
134 Real neutral = staff_position_internal (me, duration_log, 0);
136 if (dir * (pos - neutral) > 0)
139 return neutral + 4 * dir;
142 /* A rest might lie under a beam, in which case it should be cross-staff if
143 the beam is cross-staff because the rest's position depends on the
144 formatting of the beam. */
145 MAKE_SCHEME_CALLBACK (Rest, calc_cross_staff, 1);
147 Rest::calc_cross_staff (SCM smob)
149 Grob *me = unsmob_grob (smob);
150 Grob *stem = unsmob_grob (me->get_object ("stem"));
155 return stem->get_property ("cross-staff");
159 make this function easily usable in C++
162 Rest::glyph_name (Grob *me, int durlog, const string &style, bool try_ledgers,
165 bool is_ledgered = false;
166 if (try_ledgers && (durlog == -1 || durlog == 0 || durlog == 1))
168 int const pos = int (Staff_symbol_referencer::get_position (me)
171 half rests need ledger if not lying on a staff line,
172 whole rests need ledger if not hanging from a staff line,
173 breve rests need ledger if neither lying on nor hanging from a staff line
175 if (-1 <= durlog && durlog <= 1)
176 is_ledgered = !Staff_symbol_referencer::on_staff_line (me, pos)
178 && Staff_symbol_referencer::on_staff_line (me, pos + 2));
181 string actual_style (style.c_str ());
183 if ((style == "mensural") || (style == "neomensural"))
187 FIXME: Currently, ancient font does not provide ledgered rests;
188 hence the "o" suffix in the glyph name is bogus. But do we need
189 ledgered rests at all now that we can draw ledger lines with
190 variable width, length and blotdiameter? -- jr
195 There are no 32th/64th/128th mensural/neomensural rests. In
196 these cases, revert back to default style.
202 if ((style == "classical") && (durlog != 2))
205 classical style: revert back to default style for any rest other
211 if (style == "default")
214 Some parts of lily still prefer style "default" over "".
215 Correct this here. -- jr
220 return ("rests." + ::to_string (durlog) + (is_ledgered ? "o" : "")
224 MAKE_SCHEME_CALLBACK (Rest, print, 1);
226 Rest::brew_internal_stencil (Grob *me, bool ledgered)
228 SCM durlog_scm = me->get_property ("duration-log");
229 if (!scm_is_number (durlog_scm))
230 return Stencil ().smobbed_copy ();
232 int durlog = scm_to_int (durlog_scm);
234 string style = robust_symbol2string (me->get_property ("style"), "default");
236 Font_metric *fm = Font_interface::get_default_font (me);
237 string font_char = glyph_name (me, durlog, style, ledgered, 0.0);
238 Stencil out = fm->find_by_name (font_char);
240 me->warning (_f ("rest `%s' not found", font_char.c_str ()));
242 return out.smobbed_copy ();
246 translate the rest vertically by amount DY, but only if
247 it doesn't have staff-position set.
250 Rest::translate (Grob *me, int dy)
252 if (!scm_is_number (me->get_property ("staff-position")))
254 me->translate_axis (dy * Staff_symbol_referencer::staff_space (me) / 2.0, Y_AXIS);
255 Grob *p = me->get_parent (Y_AXIS);
256 p->flush_extent_cache (Y_AXIS);
261 Rest::print (SCM smob)
263 return brew_internal_stencil (unsmob_grob (smob), true);
266 MAKE_SCHEME_CALLBACK (Rest, width, 1);
268 We need the callback. The real stencil has ledgers depending on
269 Y-position. The Y-position is known only after line breaking. */
271 Rest::width (SCM smob)
273 return generic_extent_callback (unsmob_grob (smob), X_AXIS);
276 MAKE_SCHEME_CALLBACK (Rest, height, 1);
278 Rest::height (SCM smob)
280 return generic_extent_callback (unsmob_grob (smob), Y_AXIS);
284 We need the callback. The real stencil has ledgers depending on
285 Y-position. The Y-position is known only after line breaking. */
287 Rest::generic_extent_callback (Grob *me, Axis a)
290 Don't want ledgers: ledgers depend on Y position, which depends on
291 rest collision, which depends on stem size which depends on beam
292 slop of opposite note column.
294 consequence: we get too small extents and potential collisions
297 SCM m = brew_internal_stencil (me, a != X_AXIS);
298 return ly_interval2scm (unsmob_stencil (m)->extent (a));
301 MAKE_SCHEME_CALLBACK (Rest, pure_height, 3);
303 Rest::pure_height (SCM smob,
307 Grob *me = unsmob_grob (smob);
308 SCM m = brew_internal_stencil (me, false);
309 return ly_interval2scm (unsmob_stencil (m)->extent (Y_AXIS));
313 "A rest symbol. The property @code{style} can be"
314 " @code{default}, @code{mensural}, @code{neomensural} or"
315 " @code{classical}.",