-/*
- multi-measure-rest.cc -- implement Multi_measure_rest
-
- source file of the GNU LilyPond music typesetter
-
- (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
-
- */
+/*
+ This file is part of LilyPond, the GNU music typesetter.
+
+ Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
+
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
#include "multi-measure-rest.hh"
-#include "warn.hh"
+
+#include "directional-element-interface.hh"
+#include "duration.hh"
+#include "font-interface.hh"
+#include "international.hh"
+#include "lookup.hh"
+#include "misc.hh"
+#include "moment.hh"
#include "output-def.hh"
#include "paper-column.hh" // urg
-#include "font-interface.hh"
+#include "percent-repeat-item.hh"
#include "rest.hh"
-#include "stencil.hh"
-#include "misc.hh"
+#include "separation-item.hh"
+#include "spacing-options.hh"
#include "spanner.hh"
+#include "staff-symbol.hh"
#include "staff-symbol-referencer.hh"
-#include "text-item.hh"
-#include "percent-repeat-item.hh"
-#include "lookup.hh"
-#include "separation-item.hh"
+#include "system.hh"
+#include "text-interface.hh"
+#include "warn.hh"
+
+Interval
+Multi_measure_rest::bar_width (Spanner *me)
+{
+ SCM spacing_pair = me->get_property ("spacing-pair");
+ Interval iv;
+ for (LEFT_and_RIGHT (d))
+ {
+ Item *col = me->get_bound (d)->get_column ();
+ SCM align_sym
+ = (scm_is_pair (spacing_pair)
+ ? index_get_cell (spacing_pair, d)
+ : ly_symbol2scm ("staff-bar"));
+ Interval coldim = Paper_column::break_align_width (col, align_sym);
+
+ iv[d] = coldim[-d];
+ }
-MAKE_SCHEME_CALLBACK (Multi_measure_rest,percent,1);
+ return iv;
+}
+
+MAKE_SCHEME_CALLBACK (Multi_measure_rest, percent, 1);
SCM
Multi_measure_rest::percent (SCM smob)
{
Grob *me = unsmob_grob (smob);
- Spanner *sp = dynamic_cast<Spanner*> (me);
-
- Stencil r = Percent_repeat_item_interface::x_percent (me, 1, 0.75, 1.6);
+ Spanner *sp = dynamic_cast<Spanner *> (me);
- // ugh copy & paste.
-
- Interval sp_iv;
- Direction d = LEFT;
- do
- {
- Item * col = sp->get_bound (d)->get_column ();
+ Stencil r = Percent_repeat_item_interface::x_percent (me, 1);
+ r.translate_axis (-r.extent (X_AXIS).center (), X_AXIS);
- Interval coldim = col->extent (0, X_AXIS);
+ // ugh copy & paste.
- sp_iv[d] = coldim[-d] ;
- }
- while ((flip (&d)) != LEFT);
+ Grob *common_x = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT),
+ X_AXIS);
+ Interval sp_iv = bar_width (sp);
Real x_off = 0.0;
- Real rx = sp->get_bound (LEFT)->relative_coordinate (0, X_AXIS);
+ Real rx = sp->get_bound (LEFT)->relative_coordinate (common_x, X_AXIS);
/*
we gotta stay clear of sp_iv, so move a bit to the right if
needed.
- */
- x_off += (sp_iv[LEFT] - rx) >? 0;
+ */
+ x_off += max (sp_iv[LEFT] - rx, 0.0);
/*
center between stuff.
- */
- x_off += sp_iv.length ()/ 2;
+ */
+ x_off += sp_iv.length () / 2;
- r.translate_axis (x_off,X_AXIS);
+ r.translate_axis (x_off, X_AXIS);
-
return r.smobbed_copy ();
}
-MAKE_SCHEME_CALLBACK (Multi_measure_rest,print,1);
+MAKE_SCHEME_CALLBACK (Multi_measure_rest, print, 1);
SCM
-Multi_measure_rest::print (SCM smob)
+Multi_measure_rest::print (SCM smob)
{
Grob *me = unsmob_grob (smob);
- Spanner * sp = dynamic_cast<Spanner*> (me);
-
- Interval sp_iv;
- Direction d = LEFT;
-
- Grob *common = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
- do
- {
- Item * b = sp->get_bound (d);
-
- Interval coldim = (Separation_item::has_interface (b))
- ? Separation_item::relative_width (b, common)
- : b->extent (common, X_AXIS);
-
- sp_iv[d] = coldim.is_empty () ? b->relative_coordinate (common, X_AXIS) : coldim[-d];
- }
- while ((flip (&d)) != LEFT);
+ Spanner *sp = dynamic_cast<Spanner *> (me);
+ Interval sp_iv = bar_width (sp);
Real space = sp_iv.length ();
- Real rx = sp->get_bound (LEFT)->relative_coordinate (0, X_AXIS);
+ Real rx = sp->get_bound (LEFT)->relative_coordinate (0, X_AXIS);
/*
we gotta stay clear of sp_iv, so move a bit to the right if
needed.
- */
- Real x_off = (sp_iv[LEFT] - rx) >? 0;
+ */
+ Real x_off = max (sp_iv[LEFT] - rx, 0.0);
+
+ Stencil mol;
+ mol.add_stencil (symbol_stencil (me, space));
+
+ mol.translate_axis (x_off, X_AXIS);
+ return mol.smobbed_copy ();
+}
+
+MAKE_SCHEME_CALLBACK (Multi_measure_rest, height, 1);
+SCM
+Multi_measure_rest::height (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ Real space = 1000000; // something very large...
Stencil mol;
mol.add_stencil (symbol_stencil (me, space));
- int measures = 0;
- SCM m (me->get_property ("measure-count"));
- if (ly_c_number_p (m))
+ return ly_interval2scm (mol.extent (Y_AXIS));
+}
+
+int
+calc_closest_duration_log (Grob *me, double duration, bool force_round_up, bool paranoid)
+{
+ bool round_up = force_round_up
+ || to_boolean (me->get_property ("round-up-to-longer-rest"));
+ int closest_usable_duration_log;
+
+ // Out of range initial values.
+ if (round_up)
+ closest_usable_duration_log = -15; // high value
+ else
+ closest_usable_duration_log = 15; // low value
+ int minimum_usable_duration_log = -15;
+ int maximum_usable_duration_log = 15;
+
+ SCM duration_logs_list = me->get_property ("usable-duration-logs");
+ if (paranoid
+ && (to_boolean (scm_null_p (duration_logs_list))
+ || !to_boolean (scm_list_p (duration_logs_list))))
{
- measures = ly_scm2int (m);
+ warning (_ ("usable-duration-logs must be a non-empty list."
+ " Falling back to whole rests."));
+ closest_usable_duration_log = 0;
+ }
+ else
+ {
+ for (SCM s = duration_logs_list; scm_is_pair (s); s = scm_cdr (s))
+ {
+ int dur_log = scm_to_int (scm_car (s));
+ if (dur_log > minimum_usable_duration_log)
+ minimum_usable_duration_log = dur_log;
+ if (dur_log < maximum_usable_duration_log)
+ maximum_usable_duration_log = dur_log;
+ double dur = pow (2.0, -dur_log);
+ if (round_up)
+ {
+ if (duration <= dur && dur_log > closest_usable_duration_log)
+ closest_usable_duration_log = dur_log;
+ }
+ else
+ {
+ if (duration >= dur && dur_log < closest_usable_duration_log)
+ closest_usable_duration_log = dur_log;
+ }
+ }
}
- mol.translate_axis (x_off, X_AXIS);
- return mol.smobbed_copy ();
-}
+ if (closest_usable_duration_log == 15)
+ closest_usable_duration_log = minimum_usable_duration_log;
+ if (closest_usable_duration_log == -15)
+ closest_usable_duration_log = maximum_usable_duration_log;
+ return closest_usable_duration_log;
+}
+int
+calc_measure_duration_log (Grob *me, bool paranoid)
+{
+ SCM sml = dynamic_cast<Spanner *> (me)->get_bound (LEFT)
+ ->get_property ("measure-length");
+ Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_
+ : Rational (1);
+ double measure_duration = ml.Rational::to_double ();
+ bool force_round_up = to_boolean (scm_list_p (scm_member (scm_cons (scm_from_int64 (ml.numerator ()),
+ scm_from_int64 (ml.denominator ())),
+ me->get_property ("round-up-exceptions"))));
+
+ return calc_closest_duration_log (me, measure_duration, force_round_up, paranoid);
+}
Stencil
Multi_measure_rest::symbol_stencil (Grob *me, Real space)
{
- int measures = 0;
+ int measure_count = 0;
SCM m (me->get_property ("measure-count"));
- if (ly_c_number_p (m))
- {
- measures = ly_scm2int (m);
- }
- if (measures <= 0)
+ if (scm_is_number (m))
+ measure_count = scm_to_int (m);
+ if (measure_count <= 0)
return Stencil ();
-
SCM limit = me->get_property ("expand-limit");
- if (measures > ly_scm2int (limit))
+ if (measure_count > scm_to_int (limit))
{
- Real padding = 0.15;
- Stencil s = big_rest (me, (1.0 - 2*padding) * space);
- s.translate_axis (padding * space, X_AXIS);
+ Real padding = 0.15;
+ Stencil s = big_rest (me, (1.0 - 2 * padding) * space);
+ s.translate_axis (padding * space, X_AXIS);
return s;
}
- SCM alist_chain = Font_interface::music_font_alist_chain (me);
+ Font_metric *musfont = Font_interface::get_default_font (me);
+ int mdl = calc_measure_duration_log (me, true);
- Real staff_space = Staff_symbol_referencer::staff_space (me);
- Font_metric *musfont
- = select_font (me->get_paper (), alist_chain);
-
- SCM sml = me->get_property ("use-breve-rest");
- if (measures == 1)
+ if (measure_count == 1)
{
- if (to_boolean (sml))
- {
- Stencil s = musfont->find_by_name (Rest::glyph_name (me, -1, "", false));
-
- s.translate_axis ((space - s.extent (X_AXIS).length ())/2, X_AXIS);
-
- return s ;
- }
- else
- {
- Stencil s = musfont->find_by_name (Rest::glyph_name (me, 0, "", true));
-
- /*
- ugh.
- */
- if (Staff_symbol_referencer::get_position (me) == 0.0)
- s.translate_axis (staff_space, Y_AXIS);
-
- s.translate_axis ((space - s.extent (X_AXIS).length ())/2, X_AXIS);
-
- return s ;
+ if (me->get_property ("staff-position") == SCM_EOL)
+ {
+ int dir = get_grob_direction (me);
+ Real pos = Rest::staff_position_internal (me, mdl, dir);
+ me->set_property ("staff-position", scm_from_double (pos));
}
+
+ Stencil s = musfont->find_by_name (Rest::glyph_name (me, mdl, "", true, 0.0));
+
+ s.translate_axis ((space - s.extent (X_AXIS).length ()) / 2, X_AXIS);
+ return s;
}
else
- {
- return church_rest (me, musfont, measures, space);
- }
+ return church_rest (me, musfont, measure_count, space);
}
-
/*
WIDTH can also be 0 to determine the minimum size of the object.
- */
+*/
Stencil
Multi_measure_rest::big_rest (Grob *me, Real width)
{
- Real thick_thick =robust_scm2double (me->get_property ("thick-thickness"), 1.0);
+ Real thick_thick = robust_scm2double (me->get_property ("thick-thickness"), 1.0);
Real hair_thick = robust_scm2double (me->get_property ("hair-thickness"), .1);
-
Real ss = Staff_symbol_referencer::staff_space (me);
- Real slt = me->get_paper ()->get_dimension (ly_symbol2scm ("linethickness"));
- Real y = slt * thick_thick/2 * ss;
+ Real slt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+ Real y = slt * thick_thick / 2 * ss;
Real ythick = hair_thick * slt * ss;
- Box b (Interval (0, 0 >? (width - 2 * ythick)), Interval (-y, y));
-
- Real blot = width ? (.8 * (y <? ythick)) : 0.0;
-
- Stencil m = Lookup::round_filled_box (b, blot);
- Stencil yb = Lookup::round_filled_box (Box (Interval (-0.5, 0.5)* ythick, Interval (-ss, ss)), blot);
+ Box b (Interval (0.0, max (0.0, (width - 2 * ythick))), Interval (-y, y));
+
+ Real blot = width ? (.8 * min (y, ythick)) : 0.0;
- m.add_at_edge (X_AXIS, RIGHT, yb, 0, 0);
- m.add_at_edge (X_AXIS, LEFT, yb, 0, 0);
+ Stencil m = Lookup::round_filled_box (b, blot);
+ Stencil yb = Lookup::round_filled_box (Box (Interval (-0.5, 0.5) * ythick, Interval (-ss, ss)), blot);
+
+ m.add_at_edge (X_AXIS, RIGHT, yb, 0);
+ m.add_at_edge (X_AXIS, LEFT, yb, 0);
m.align_to (X_AXIS, LEFT);
-
+
return m;
}
/*
Kirchenpause (?)
- */
+*/
Stencil
-Multi_measure_rest::church_rest (Grob*me, Font_metric *musfont, int measures,
- Real space)
+Multi_measure_rest::church_rest (Grob *me, Font_metric *musfont, int measure_count,
+ Real space)
{
- SCM mols = SCM_EOL;
-
- /*
- see Wanske pp. 125
- */
- int l = measures;
- int count = 0;
+ SCM mols = SCM_EOL;
+ int symbol_count = 0;
Real symbols_width = 0.0;
+ double total_duration = measure_count * pow (2.0, -calc_measure_duration_log (me, true));
- SCM sml = me->get_property ("use-breve-rest");
+ SCM staff_position = me->get_property ("staff-position");
- while (l)
+ if (!scm_is_number (staff_position))
{
- if (sml == SCM_BOOL_T)
- {
- int k;
- if (l >= 2)
- {
- l-=2;
- k = -2;
- }
- else
- {
- l -= 1;
- k = -1;
- }
-
- Stencil r (musfont->find_by_name ("rests-" + to_string (k)));
- symbols_width += r.extent (X_AXIS).length ();
- mols = scm_cons (r.smobbed_copy (), mols);
- }
- else
- {
- int k;
- if (l >= 4)
- {
- l-=4;
- k = -2;
- }
- else if (l>= 2)
- {
- l -= 2;
- k = -1;
- }
- else
- {
- k = 0;
- l --;
- }
-
- Stencil r (musfont->find_by_name ("rests-" + to_string (k)));
- if (k == 0)
- {
- Real staff_space = Staff_symbol_referencer::staff_space (me);
- r.translate_axis (staff_space, Y_AXIS);
- }
- symbols_width += r.extent (X_AXIS).length ();
- mols = scm_cons (r.smobbed_copy (), mols);
- }
- count ++;
+ // Staff position is somewhat icky regarding its definition for
+ // compatibility reasons. It is intended to be the baseline of
+ // a breve rest. However, when the staff space is more than
+ // single space (like with tablature), it looks better if all
+ // rests are actually hanging. So staff position, in reality,
+ // is the semi-breve position - 2. Everything else is
+ // calculated from there.
+ int dir = get_grob_direction (me);
+ Real pos = Rest::staff_position_internal (me, 0, dir);
+ me->set_property ("staff-position", scm_from_double (pos - 2));
}
-
-
- Real outer_padding_factor = 1.5; // make outer padding this much bigger.
- Real inner_padding = (space - symbols_width) / (2 * outer_padding_factor + (count-1));
- if (inner_padding < 0)
+ while (total_duration > 0)
{
- inner_padding = 1.0;
- }
-
- Stencil mol;
- for (SCM s = mols; ly_c_pair_p (s); s = ly_cdr (s))
- {
- mol.add_at_edge (X_AXIS, LEFT, *unsmob_stencil (ly_car (s)), inner_padding, 0);
+ int dl = calc_closest_duration_log (me, total_duration, false, true);
+ double duration = pow (2.0, -dl);
+
+ total_duration -= duration;
+
+ Stencil r = musfont->find_by_name (Rest::glyph_name (me, dl, "", true, 2));
+
+ Real staff_space = Staff_symbol_referencer::staff_space (me);
+ if (dl == 0)
+ {
+ r.translate_axis (staff_space, Y_AXIS);
+ }
+ else
+ {
+ r.translate_axis (staff_space-r.extent (Y_AXIS).at (UP), Y_AXIS);
+ }
+ symbols_width += r.extent (X_AXIS).length ();
+ mols = scm_cons (r.smobbed_copy (), mols);
+ symbol_count++;
}
+
+ /* Make outer padding this much bigger. */
+ Real outer_padding_factor = 1.5;
+ Real inner_padding = (space - symbols_width)
+ / (2 * outer_padding_factor + (symbol_count - 1));
+ if (inner_padding < 0)
+ inner_padding = 1.0;
+
+ Stencil mol;
+ for (SCM s = mols; scm_is_pair (s); s = scm_cdr (s))
+ mol.add_at_edge (X_AXIS, LEFT, *unsmob_stencil (scm_car (s)),
+ inner_padding);
mol.align_to (X_AXIS, LEFT);
- mol.translate_axis (outer_padding_factor * inner_padding, X_AXIS);
+ mol.translate_axis (outer_padding_factor * inner_padding, X_AXIS);
return mol;
}
void
-Multi_measure_rest::add_column (Grob*me,Item* c)
+Multi_measure_rest::add_column (Grob *me, Item *c)
{
- add_bound_item (dynamic_cast<Spanner*> (me),c);
+ add_bound_item (dynamic_cast<Spanner *> (me), c);
}
-
-MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_spacing_rods,1);
-SCM
-Multi_measure_rest::set_spacing_rods (SCM smob)
+void
+Multi_measure_rest::calculate_spacing_rods (Grob *me, Real length)
{
- Grob*me = unsmob_grob (smob);
-
- Spanner*sp = dynamic_cast<Spanner*> (me);
+ Spanner *sp = dynamic_cast<Spanner *> (me);
if (! (sp->get_bound (LEFT) && sp->get_bound (RIGHT)))
{
programming_error ("Multi_measure_rest::get_rods (): I am not spanned!");
- return SCM_UNSPECIFIED;
+ return;
}
- Item * l = sp->get_bound (LEFT)->get_column ();
- Item * r = sp->get_bound (RIGHT)->get_column ();
- Item * lb = l->find_prebroken_piece (RIGHT);
- Item * rb = r->find_prebroken_piece (LEFT);
-
- Item* combinations[4][2] = {{l,r},
- {lb,r},
- {l,rb},
- {lb,rb}};
+ Item *li = sp->get_bound (LEFT)->get_column ();
+ Item *ri = sp->get_bound (RIGHT)->get_column ();
+ Item *lb = li->find_prebroken_piece (RIGHT);
+ Item *rb = ri->find_prebroken_piece (LEFT);
+ Grob *spacing = unsmob_grob (li->get_object ("spacing"));
+ if (!spacing)
+ spacing = unsmob_grob (ri->get_object ("spacing"));
+ if (!spacing)
+ me->warning (_ ("Using naive multi measure rest spacing."));
+ else
+ {
+ Spacing_options options;
+ options.init_from_grob (me);
+ int dl = calc_measure_duration_log (me, false);
+ Duration dur = Duration (dl, 0);
+ Rational rat = dur.get_length ();
+ length = max (length, options.get_duration_space (rat));
+ }
- Real sym_width = symbol_stencil (me, 0.0).extent (X_AXIS).length ();
-
- for (int i=0; i < 4; i++)
+ Item *combinations[4][2] = {{li, ri},
+ {lb, ri},
+ {li, rb},
+ {lb, rb}
+ };
+
+ for (int i = 0; i < 4; i++)
{
- Item *l = combinations[i][0];
- Item *r = combinations[i][1];
+ Item *li = combinations[i][0];
+ Item *ri = combinations[i][1];
- if (!l || !r)
- continue;
+ if (!li || !ri)
+ continue;
Rod rod;
- rod.item_l_drul_[LEFT] = l;
- rod.item_l_drul_[RIGHT] = r;
-
-
- rod.distance_ = l->extent (l, X_AXIS)[BIGGER] - r->extent (r, X_AXIS)[SMALLER]
- + sym_width + 2.0; // 2.0 = magic!
-
- Real minlen = robust_scm2double (me->get_property ("minimum-length"), 0.0);
- rod.distance_ = max (rod.distance_,
- minlen);
+ rod.item_drul_[LEFT] = li;
+ rod.item_drul_[RIGHT] = ri;
+
+ rod.distance_ = Paper_column::minimum_distance (li, ri)
+ + length
+ + 2 * robust_scm2double (me->get_property ("bound-padding"), 1.0);
+
+ Real minlen = robust_scm2double (me->get_property ("minimum-length"), 0);
+ rod.distance_ = max (rod.distance_, minlen);
rod.add_to_cols ();
}
- return SCM_UNSPECIFIED;
}
+MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_spacing_rods, 1);
+SCM
+Multi_measure_rest::set_spacing_rods (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ Real sym_width = symbol_stencil (me, 0.0).extent (X_AXIS).length ();
+ calculate_spacing_rods (me, sym_width);
+ return SCM_UNSPECIFIED;
+}
+MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_text_rods, 1);
+SCM
+Multi_measure_rest::set_text_rods (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ Stencil *stil = me->get_stencil ();
-ADD_INTERFACE (Multi_measure_rest,"multi-measure-rest-interface",
- "A rest that spans a whole number of measures.",
- "expand-limit measure-count hair-thickness thick-thickness use-breve-rest minimum-length");
+ /* FIXME uncached */
+ Real len = (stil && !stil->extent (X_AXIS).is_empty ())
+ ? stil->extent (X_AXIS).length ()
+ : 0.0;
+ calculate_spacing_rods (me, len);
+
+ return SCM_UNSPECIFIED;
+}
+ADD_INTERFACE (Multi_measure_rest,
+ "A rest that spans a whole number of measures.",
+
+ /* properties */
+ "bound-padding "
+ "expand-limit "
+ "hair-thickness "
+ "measure-count "
+ "minimum-length "
+ "round-up-exceptions "
+ "round-up-to-longer-rest "
+ "spacing-pair "
+ "thick-thickness "
+ "usable-duration-logs "
+ );
projects / lilypond.git / blobdiff