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");
48 Item *col = me->get_bound (d)->get_column ();
50 = (scm_is_pair (spacing_pair)
51 ? index_get_cell (spacing_pair, d)
52 : ly_symbol2scm ("staff-bar"));
53 Interval coldim = Paper_column::break_align_width (col, align_sym);
57 while (flip (&d) != LEFT);
62 MAKE_SCHEME_CALLBACK (Multi_measure_rest, percent, 1);
64 Multi_measure_rest::percent (SCM smob)
66 Grob *me = unsmob_grob (smob);
67 Spanner *sp = dynamic_cast<Spanner *> (me);
69 Stencil r = Percent_repeat_item_interface::x_percent (me, 1);
70 r.translate_axis (-r.extent (X_AXIS).center (), X_AXIS);
74 Grob *common_x = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT),
76 Interval sp_iv = bar_width (sp);
79 Real rx = sp->get_bound (LEFT)->relative_coordinate (common_x, X_AXIS);
81 we gotta stay clear of sp_iv, so move a bit to the right if
84 x_off += max (sp_iv[LEFT] - rx, 0.0);
89 x_off += sp_iv.length () / 2;
91 r.translate_axis (x_off, X_AXIS);
93 return r.smobbed_copy ();
96 MAKE_SCHEME_CALLBACK (Multi_measure_rest, print, 1);
98 Multi_measure_rest::print (SCM smob)
100 Grob *me = unsmob_grob (smob);
101 Spanner *sp = dynamic_cast<Spanner *> (me);
103 Interval sp_iv = bar_width (sp);
104 Real space = sp_iv.length ();
106 Real rx = sp->get_bound (LEFT)->relative_coordinate (0, X_AXIS);
108 we gotta stay clear of sp_iv, so move a bit to the right if
111 Real x_off = max (sp_iv[LEFT] - rx, 0.0);
114 mol.add_stencil (symbol_stencil (me, space));
116 mol.translate_axis (x_off, X_AXIS);
117 return mol.smobbed_copy ();
121 calc_closest_duration_log (Grob *me, double duration, bool force_round_up, bool paranoid)
123 bool round_up = force_round_up
124 || to_boolean (me->get_property ("round-up-to-longer-rest"));
125 int closest_usable_duration_log;
127 // Out of range initial values.
129 closest_usable_duration_log = -15; // high value
131 closest_usable_duration_log = 15; // low value
132 int minimum_usable_duration_log = -15;
133 int maximum_usable_duration_log = 15;
135 SCM duration_logs_list = me->get_property ("usable-duration-logs");
137 && (to_boolean (scm_null_p (duration_logs_list))
138 || !to_boolean (scm_list_p (duration_logs_list))))
140 warning (_ ("usable-duration-logs must be a non-empty list. Falling back to whole rests."));
141 closest_usable_duration_log = 0;
145 for (SCM s = duration_logs_list; scm_is_pair (s); s = scm_cdr (s))
147 int dur_log = scm_to_int (scm_car (s));
148 if (dur_log > minimum_usable_duration_log)
149 minimum_usable_duration_log = dur_log;
150 if (dur_log < maximum_usable_duration_log)
151 maximum_usable_duration_log = dur_log;
152 double dur = pow (2.0, -dur_log);
155 if (duration <= dur && dur_log > closest_usable_duration_log)
156 closest_usable_duration_log = dur_log;
160 if (duration >= dur && dur_log < closest_usable_duration_log)
161 closest_usable_duration_log = dur_log;
166 if (closest_usable_duration_log == 15)
167 closest_usable_duration_log = minimum_usable_duration_log;
168 if (closest_usable_duration_log == -15)
169 closest_usable_duration_log = maximum_usable_duration_log;
171 return closest_usable_duration_log;
175 calc_measure_duration_log (Grob *me, bool paranoid)
177 SCM sml = dynamic_cast<Spanner *> (me)->get_bound (LEFT)
178 ->get_property ("measure-length");
179 Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_
181 double measure_duration = ml.Rational::to_double ();
182 bool force_round_up = to_boolean (scm_list_p (scm_member (scm_cons (scm_from_int64 (ml.numerator ()),
183 scm_from_int64 (ml.denominator ())),
184 me->get_property ("round-up-exceptions"))));
186 return calc_closest_duration_log (me, measure_duration, force_round_up, paranoid);
190 Multi_measure_rest::symbol_stencil (Grob *me, Real space)
192 int measure_count = 0;
193 SCM m (me->get_property ("measure-count"));
194 if (scm_is_number (m))
195 measure_count = scm_to_int (m);
196 if (measure_count <= 0)
199 SCM limit = me->get_property ("expand-limit");
200 if (measure_count > scm_to_int (limit))
203 Stencil s = big_rest (me, (1.0 - 2 * padding) * space);
204 s.translate_axis (padding * space, X_AXIS);
208 Font_metric *musfont = Font_interface::get_default_font (me);
209 int mdl = calc_measure_duration_log (me, true);
211 if (measure_count == 1)
213 if (mdl == 0 && me->get_property ("staff-position") == SCM_EOL)
215 if (Staff_symbol_referencer::on_staff_line (me, 2))
216 me->set_property ("staff-position", scm_from_int (2));
217 else if (Staff_symbol_referencer::on_staff_line (me, 3))
218 me->set_property ("staff-position", scm_from_int (3));
221 Stencil s = musfont->find_by_name (Rest::glyph_name (me, mdl, "", true));
223 s.translate_axis ((space - s.extent (X_AXIS).length ()) / 2, X_AXIS);
227 return church_rest (me, musfont, measure_count, space);
231 WIDTH can also be 0 to determine the minimum size of the object.
234 Multi_measure_rest::big_rest (Grob *me, Real width)
236 Real thick_thick = robust_scm2double (me->get_property ("thick-thickness"), 1.0);
237 Real hair_thick = robust_scm2double (me->get_property ("hair-thickness"), .1);
239 Real ss = Staff_symbol_referencer::staff_space (me);
240 Real slt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
241 Real y = slt * thick_thick / 2 * ss;
242 Real ythick = hair_thick * slt * ss;
243 Box b (Interval (0.0, max (0.0, (width - 2 * ythick))), Interval (-y, y));
245 Real blot = width ? (.8 * min (y, ythick)) : 0.0;
247 Stencil m = Lookup::round_filled_box (b, blot);
248 Stencil yb = Lookup::round_filled_box (Box (Interval (-0.5, 0.5) * ythick, Interval (-ss, ss)), blot);
250 m.add_at_edge (X_AXIS, RIGHT, yb, 0);
251 m.add_at_edge (X_AXIS, LEFT, yb, 0);
253 m.align_to (X_AXIS, LEFT);
262 Multi_measure_rest::church_rest (Grob *me, Font_metric *musfont, int measure_count,
266 int symbol_count = 0;
267 Real symbols_width = 0.0;
268 double total_duration = measure_count * pow (2.0, -calc_measure_duration_log (me, true));
270 while (total_duration > 0)
272 int dl = calc_closest_duration_log (me, total_duration, false, true);
273 double duration = pow (2.0, -dl);
275 total_duration -= duration;
277 Stencil r = musfont->find_by_name (Rest::glyph_name (me, dl, "", true));
280 Real staff_space = Staff_symbol_referencer::staff_space (me);
281 r.translate_axis (staff_space, Y_AXIS);
283 symbols_width += r.extent (X_AXIS).length ();
284 mols = scm_cons (r.smobbed_copy (), mols);
288 /* Make outer padding this much bigger. */
289 Real outer_padding_factor = 1.5;
290 Real inner_padding = (space - symbols_width)
291 / (2 * outer_padding_factor + (symbol_count - 1));
292 if (inner_padding < 0)
296 for (SCM s = mols; scm_is_pair (s); s = scm_cdr (s))
297 mol.add_at_edge (X_AXIS, LEFT, *unsmob_stencil (scm_car (s)),
299 mol.align_to (X_AXIS, LEFT);
300 mol.translate_axis (outer_padding_factor * inner_padding, X_AXIS);
306 Multi_measure_rest::add_column (Grob *me, Item *c)
308 add_bound_item (dynamic_cast<Spanner *> (me), c);
312 Multi_measure_rest::calculate_spacing_rods (Grob *me, Real length)
314 Spanner *sp = dynamic_cast<Spanner *> (me);
315 if (! (sp->get_bound (LEFT) && sp->get_bound (RIGHT)))
317 programming_error ("Multi_measure_rest::get_rods (): I am not spanned!");
321 Item *li = sp->get_bound (LEFT)->get_column ();
322 Item *ri = sp->get_bound (RIGHT)->get_column ();
323 Item *lb = li->find_prebroken_piece (RIGHT);
324 Item *rb = ri->find_prebroken_piece (LEFT);
325 Grob *spacing = unsmob_grob (li->get_object ("spacing"));
327 spacing = unsmob_grob (ri->get_object ("spacing"));
329 me->warning ("Using naive multi measure rest spacing.");
332 Spacing_options options;
333 options.init_from_grob (me);
334 int dl = calc_measure_duration_log (me, false);
335 Duration dur = Duration (dl, 0);
336 Rational rat = dur.get_length ();
337 length = max (length, options.get_duration_space (rat));
340 Item *combinations[4][2] = {{li, ri},
346 for (int i = 0; i < 4; i++)
348 Item *li = combinations[i][0];
349 Item *ri = combinations[i][1];
355 rod.item_drul_[LEFT] = li;
356 rod.item_drul_[RIGHT] = ri;
358 rod.distance_ = Paper_column::minimum_distance (li, ri)
360 + 2 * robust_scm2double (me->get_property ("bound-padding"), 1.0);
362 Real minlen = robust_scm2double (me->get_property ("minimum-length"), 0);
363 rod.distance_ = max (rod.distance_, minlen);
368 MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_spacing_rods, 1);
370 Multi_measure_rest::set_spacing_rods (SCM smob)
372 Grob *me = unsmob_grob (smob);
373 Real sym_width = symbol_stencil (me, 0.0).extent (X_AXIS).length ();
374 calculate_spacing_rods (me, sym_width);
376 return SCM_UNSPECIFIED;
379 MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_text_rods, 1);
381 Multi_measure_rest::set_text_rods (SCM smob)
383 Grob *me = unsmob_grob (smob);
384 Stencil *stil = me->get_stencil ();
387 Real len = (stil && !stil->extent (X_AXIS).is_empty ())
388 ? stil->extent (X_AXIS).length ()
390 calculate_spacing_rods (me, len);
392 return SCM_UNSPECIFIED;
395 ADD_INTERFACE (Multi_measure_rest,
396 "A rest that spans a whole number of measures.",
404 "round-up-exceptions "
405 "round-up-to-longer-rest "
408 "usable-duration-logs "