2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
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 "multi-measure-rest.hh"
22 #include "duration.hh"
23 #include "font-interface.hh"
24 #include "international.hh"
28 #include "output-def.hh"
29 #include "paper-column.hh" // urg
30 #include "percent-repeat-item.hh"
32 #include "separation-item.hh"
33 #include "spacing-options.hh"
35 #include "staff-symbol-referencer.hh"
37 #include "text-interface.hh"
41 Multi_measure_rest::bar_width (Spanner *me)
43 SCM spacing_pair = me->get_property ("spacing-pair");
45 for (LEFT_and_RIGHT (d))
47 Item *col = me->get_bound (d)->get_column ();
49 = (scm_is_pair (spacing_pair)
50 ? index_get_cell (spacing_pair, d)
51 : ly_symbol2scm ("staff-bar"));
52 Interval coldim = Paper_column::break_align_width (col, align_sym);
60 MAKE_SCHEME_CALLBACK (Multi_measure_rest, percent, 1);
62 Multi_measure_rest::percent (SCM smob)
64 Grob *me = unsmob_grob (smob);
65 Spanner *sp = dynamic_cast<Spanner *> (me);
67 Stencil r = Percent_repeat_item_interface::x_percent (me, 1);
68 r.translate_axis (-r.extent (X_AXIS).center (), X_AXIS);
72 Grob *common_x = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT),
74 Interval sp_iv = bar_width (sp);
77 Real rx = sp->get_bound (LEFT)->relative_coordinate (common_x, X_AXIS);
79 we gotta stay clear of sp_iv, so move a bit to the right if
82 x_off += max (sp_iv[LEFT] - rx, 0.0);
87 x_off += sp_iv.length () / 2;
89 r.translate_axis (x_off, X_AXIS);
91 return r.smobbed_copy ();
94 MAKE_SCHEME_CALLBACK (Multi_measure_rest, print, 1);
96 Multi_measure_rest::print (SCM smob)
98 Grob *me = unsmob_grob (smob);
99 Spanner *sp = dynamic_cast<Spanner *> (me);
101 Interval sp_iv = bar_width (sp);
102 Real space = sp_iv.length ();
104 Real rx = sp->get_bound (LEFT)->relative_coordinate (0, X_AXIS);
106 we gotta stay clear of sp_iv, so move a bit to the right if
109 Real x_off = max (sp_iv[LEFT] - rx, 0.0);
112 mol.add_stencil (symbol_stencil (me, space));
114 mol.translate_axis (x_off, X_AXIS);
115 return mol.smobbed_copy ();
118 MAKE_SCHEME_CALLBACK (Multi_measure_rest, height, 1);
120 Multi_measure_rest::height (SCM smob)
122 Grob *me = unsmob_grob (smob);
123 Spanner *sp = dynamic_cast<Spanner *> (me);
125 Real space = 1000000; // something very large...
128 mol.add_stencil (symbol_stencil (me, space));
130 return ly_interval2scm (mol.extent (Y_AXIS));
134 calc_closest_duration_log (Grob *me, double duration, bool force_round_up, bool paranoid)
136 bool round_up = force_round_up
137 || to_boolean (me->get_property ("round-up-to-longer-rest"));
138 int closest_usable_duration_log;
140 // Out of range initial values.
142 closest_usable_duration_log = -15; // high value
144 closest_usable_duration_log = 15; // low value
145 int minimum_usable_duration_log = -15;
146 int maximum_usable_duration_log = 15;
148 SCM duration_logs_list = me->get_property ("usable-duration-logs");
150 && (to_boolean (scm_null_p (duration_logs_list))
151 || !to_boolean (scm_list_p (duration_logs_list))))
153 warning (_ ("usable-duration-logs must be a non-empty list."
154 " Falling back to whole rests."));
155 closest_usable_duration_log = 0;
159 for (SCM s = duration_logs_list; scm_is_pair (s); s = scm_cdr (s))
161 int dur_log = scm_to_int (scm_car (s));
162 if (dur_log > minimum_usable_duration_log)
163 minimum_usable_duration_log = dur_log;
164 if (dur_log < maximum_usable_duration_log)
165 maximum_usable_duration_log = dur_log;
166 double dur = pow (2.0, -dur_log);
169 if (duration <= dur && dur_log > closest_usable_duration_log)
170 closest_usable_duration_log = dur_log;
174 if (duration >= dur && dur_log < closest_usable_duration_log)
175 closest_usable_duration_log = dur_log;
180 if (closest_usable_duration_log == 15)
181 closest_usable_duration_log = minimum_usable_duration_log;
182 if (closest_usable_duration_log == -15)
183 closest_usable_duration_log = maximum_usable_duration_log;
185 return closest_usable_duration_log;
189 calc_measure_duration_log (Grob *me, bool paranoid)
191 SCM sml = dynamic_cast<Spanner *> (me)->get_bound (LEFT)
192 ->get_property ("measure-length");
193 Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_
195 double measure_duration = ml.Rational::to_double ();
196 bool force_round_up = to_boolean (scm_list_p (scm_member (scm_cons (scm_from_int64 (ml.numerator ()),
197 scm_from_int64 (ml.denominator ())),
198 me->get_property ("round-up-exceptions"))));
200 return calc_closest_duration_log (me, measure_duration, force_round_up, paranoid);
204 Multi_measure_rest::symbol_stencil (Grob *me, Real space)
206 int measure_count = 0;
207 SCM m (me->get_property ("measure-count"));
208 if (scm_is_number (m))
209 measure_count = scm_to_int (m);
210 if (measure_count <= 0)
213 SCM limit = me->get_property ("expand-limit");
214 if (measure_count > scm_to_int (limit))
217 Stencil s = big_rest (me, (1.0 - 2 * padding) * space);
218 s.translate_axis (padding * space, X_AXIS);
222 Font_metric *musfont = Font_interface::get_default_font (me);
223 int mdl = calc_measure_duration_log (me, true);
225 if (measure_count == 1)
227 if (mdl == 0 && me->get_property ("staff-position") == SCM_EOL)
229 if (Staff_symbol_referencer::on_staff_line (me, 2))
230 me->set_property ("staff-position", scm_from_int (2));
231 else if (Staff_symbol_referencer::on_staff_line (me, 3))
232 me->set_property ("staff-position", scm_from_int (3));
235 Stencil s = musfont->find_by_name (Rest::glyph_name (me, mdl, "", true));
237 s.translate_axis ((space - s.extent (X_AXIS).length ()) / 2, X_AXIS);
241 return church_rest (me, musfont, measure_count, space);
245 WIDTH can also be 0 to determine the minimum size of the object.
248 Multi_measure_rest::big_rest (Grob *me, Real width)
250 Real thick_thick = robust_scm2double (me->get_property ("thick-thickness"), 1.0);
251 Real hair_thick = robust_scm2double (me->get_property ("hair-thickness"), .1);
253 Real ss = Staff_symbol_referencer::staff_space (me);
254 Real slt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
255 Real y = slt * thick_thick / 2 * ss;
256 Real ythick = hair_thick * slt * ss;
257 Box b (Interval (0.0, max (0.0, (width - 2 * ythick))), Interval (-y, y));
259 Real blot = width ? (.8 * min (y, ythick)) : 0.0;
261 Stencil m = Lookup::round_filled_box (b, blot);
262 Stencil yb = Lookup::round_filled_box (Box (Interval (-0.5, 0.5) * ythick, Interval (-ss, ss)), blot);
264 m.add_at_edge (X_AXIS, RIGHT, yb, 0);
265 m.add_at_edge (X_AXIS, LEFT, yb, 0);
267 m.align_to (X_AXIS, LEFT);
276 Multi_measure_rest::church_rest (Grob *me, Font_metric *musfont, int measure_count,
280 int symbol_count = 0;
281 Real symbols_width = 0.0;
282 double total_duration = measure_count * pow (2.0, -calc_measure_duration_log (me, true));
284 while (total_duration > 0)
286 int dl = calc_closest_duration_log (me, total_duration, false, true);
287 double duration = pow (2.0, -dl);
289 total_duration -= duration;
291 Stencil r = musfont->find_by_name (Rest::glyph_name (me, dl, "", true));
294 Real staff_space = Staff_symbol_referencer::staff_space (me);
295 r.translate_axis (staff_space, Y_AXIS);
297 symbols_width += r.extent (X_AXIS).length ();
298 mols = scm_cons (r.smobbed_copy (), mols);
302 /* Make outer padding this much bigger. */
303 Real outer_padding_factor = 1.5;
304 Real inner_padding = (space - symbols_width)
305 / (2 * outer_padding_factor + (symbol_count - 1));
306 if (inner_padding < 0)
310 for (SCM s = mols; scm_is_pair (s); s = scm_cdr (s))
311 mol.add_at_edge (X_AXIS, LEFT, *unsmob_stencil (scm_car (s)),
313 mol.align_to (X_AXIS, LEFT);
314 mol.translate_axis (outer_padding_factor * inner_padding, X_AXIS);
320 Multi_measure_rest::add_column (Grob *me, Item *c)
322 add_bound_item (dynamic_cast<Spanner *> (me), c);
326 Multi_measure_rest::calculate_spacing_rods (Grob *me, Real length)
328 Spanner *sp = dynamic_cast<Spanner *> (me);
329 if (! (sp->get_bound (LEFT) && sp->get_bound (RIGHT)))
331 programming_error ("Multi_measure_rest::get_rods (): I am not spanned!");
335 Item *li = sp->get_bound (LEFT)->get_column ();
336 Item *ri = sp->get_bound (RIGHT)->get_column ();
337 Item *lb = li->find_prebroken_piece (RIGHT);
338 Item *rb = ri->find_prebroken_piece (LEFT);
339 Grob *spacing = unsmob_grob (li->get_object ("spacing"));
341 spacing = unsmob_grob (ri->get_object ("spacing"));
343 me->warning (_ ("Using naive multi measure rest spacing."));
346 Spacing_options options;
347 options.init_from_grob (me);
348 int dl = calc_measure_duration_log (me, false);
349 Duration dur = Duration (dl, 0);
350 Rational rat = dur.get_length ();
351 length = max (length, options.get_duration_space (rat));
354 Item *combinations[4][2] = {{li, ri},
360 for (int i = 0; i < 4; i++)
362 Item *li = combinations[i][0];
363 Item *ri = combinations[i][1];
369 rod.item_drul_[LEFT] = li;
370 rod.item_drul_[RIGHT] = ri;
372 rod.distance_ = Paper_column::minimum_distance (li, ri)
374 + 2 * robust_scm2double (me->get_property ("bound-padding"), 1.0);
376 Real minlen = robust_scm2double (me->get_property ("minimum-length"), 0);
377 rod.distance_ = max (rod.distance_, minlen);
382 MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_spacing_rods, 1);
384 Multi_measure_rest::set_spacing_rods (SCM smob)
386 Grob *me = unsmob_grob (smob);
387 Real sym_width = symbol_stencil (me, 0.0).extent (X_AXIS).length ();
388 calculate_spacing_rods (me, sym_width);
390 return SCM_UNSPECIFIED;
393 MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_text_rods, 1);
395 Multi_measure_rest::set_text_rods (SCM smob)
397 Grob *me = unsmob_grob (smob);
398 Stencil *stil = me->get_stencil ();
401 Real len = (stil && !stil->extent (X_AXIS).is_empty ())
402 ? stil->extent (X_AXIS).length ()
404 calculate_spacing_rods (me, len);
406 return SCM_UNSPECIFIED;
409 ADD_INTERFACE (Multi_measure_rest,
410 "A rest that spans a whole number of measures.",
418 "round-up-exceptions "
419 "round-up-to-longer-rest "
422 "usable-duration-logs "