X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fsimple-spacer.cc;h=9b0a322b1cb37e2e9e24560549d3990c2617b148;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=3532c03606a1d7a33adccdf639ca598157274082;hpb=582186f60e5103f11a0cc54cc5dfb3319b9ea114;p=lilypond.git diff --git a/lily/simple-spacer.cc b/lily/simple-spacer.cc index 3532c03606..9b0a322b1c 100644 --- a/lily/simple-spacer.cc +++ b/lily/simple-spacer.cc @@ -3,7 +3,7 @@ source file of the GNU LilyPond music typesetter - (c) 1999--2006 Han-Wen Nienhuys + (c) 1999--2008 Han-Wen Nienhuys TODO: - add support for different stretch/shrink constants? @@ -80,9 +80,12 @@ Simple_spacer::fits () const Real Simple_spacer::rod_force (int l, int r, Real dist) { - Real c = range_stiffness (l, r); Real d = range_ideal_len (l, r); + Real c = range_stiffness (l, r, dist > d); Real block_stretch = dist - d; + + if (isinf (c) && block_stretch == 0) /* take care of the 0*infinity_f case */ + return 0; return c * block_stretch; } @@ -102,13 +105,18 @@ Simple_spacer::add_rod (int l, int r, Real dist) Real spring_dist = range_ideal_len (l, r); if (spring_dist < dist) for (int i = l; i < r; i++) - springs_[i].ideal_ *= dist / spring_dist; + { + if (spring_dist) + springs_[i].set_distance (springs_[i].distance () * dist / spring_dist); + else + springs_[i].set_distance (dist / (r - l)); + } return; } force_ = max (force_, block_force); for (int i = l; i < r; i++) - springs_[i].block_force_ = max (block_force, springs_[i].block_force_); + springs_[i].set_blocking_force (max (block_force, springs_[i].blocking_force ())); } Real @@ -116,16 +124,17 @@ Simple_spacer::range_ideal_len (int l, int r) const { Real d = 0.; for (int i = l; i < r; i++) - d += springs_[i].ideal_; + d += springs_[i].distance (); return d; } Real -Simple_spacer::range_stiffness (int l, int r) const +Simple_spacer::range_stiffness (int l, int r, bool stretch) const { Real den = 0.0; for (int i = l; i < r; i++) - den += springs_[i].inverse_hooke_; + den += stretch ? springs_[i].inverse_stretch_strength () + : springs_[i].inverse_compress_strength (); return 1 / den; } @@ -147,18 +156,13 @@ Simple_spacer::solve (Real line_len, bool ragged) ragged_ = ragged; line_len_ = line_len; - if (ragged) - { - force_ = 0; - fits_ = configuration_length (force_) <= line_len_; - /* we need to calculate a force here to prevent a bunch of short lines */ - if (fits_) - force_ = expand_line (); - } - else if (conf < line_len_) + if (conf < line_len_) force_ = expand_line (); else if (conf > line_len_) force_ = compress_line (); + + if (ragged && force_ < 0) + fits_ = false; } Real @@ -169,7 +173,10 @@ Simple_spacer::expand_line () fits_ = true; for (vsize i=0; i < springs_.size (); i++) - inv_hooke += springs_[i].inverse_hooke_; + inv_hooke += springs_[i].inverse_stretch_strength (); + + if (inv_hooke == 0.0) /* avoid division by zero. If springs are infinitely stiff */ + return 0.0; /* anyway, then it makes no difference what the force is */ assert (cur_len <= line_len_); return (line_len_ - cur_len) / inv_hooke + force_; @@ -181,39 +188,54 @@ Simple_spacer::compress_line () double inv_hooke = 0; double cur_len = configuration_length (force_); double cur_force = force_; + bool compressed = false; + + /* just because we are in compress_line () doesn't mean that the line + will actually be compressed (as in, a negative force) because + we start out with a stretched line. Here, we check whether we + will be compressed or stretched (so we know which spring constant to use) */ + if (configuration_length (0.0) > line_len_) + { + cur_force = 0.0; + cur_len = configuration_length (0.0); + compressed = true; + } fits_ = true; for (vsize i=0; i < springs_.size (); i++) - inv_hooke += springs_[i].inverse_hooke_; + inv_hooke += compressed + ? springs_[i].inverse_compress_strength () + : springs_[i].inverse_stretch_strength (); assert (line_len_ <= cur_len); - vector sorted_springs = springs_; - sort (sorted_springs.begin (), sorted_springs.end (), greater ()); + vector sorted_springs = springs_; + sort (sorted_springs.begin (), sorted_springs.end (), greater ()); + for (vsize i = 0; i < sorted_springs.size (); i++) { - Spring_description sp = sorted_springs[i]; + Spring sp = sorted_springs[i]; - assert (sp.block_force_ <= cur_force); - if (isinf (sp.block_force_)) + assert (sp.blocking_force () <= cur_force); + if (isinf (sp.blocking_force ())) break; - double block_dist = (cur_force - sp.block_force_) * inv_hooke; + double block_dist = (cur_force - sp.blocking_force ()) * inv_hooke; if (cur_len - block_dist < line_len_) { - cur_force += (line_len_ - cur_len) / inv_hooke; - cur_len = line_len_; + cur_force += (line_len_ - cur_len) / inv_hooke; + cur_len = line_len_; - /* - Paranoia check. + /* + Paranoia check. */ - assert (fabs (configuration_length (cur_force) - cur_len) < 1e-6); - return cur_force; + assert (fabs (configuration_length (cur_force) - cur_len) < 1e-6); + return cur_force; } cur_len -= block_dist; - inv_hooke -= sp.inverse_hooke_; - cur_force = sp.block_force_; + inv_hooke -= sp.inverse_compress_strength (); + cur_force = sp.blocking_force (); } fits_ = false; @@ -221,24 +243,10 @@ Simple_spacer::compress_line () } void -Simple_spacer::add_spring (Real ideal, Real inverse_hooke) +Simple_spacer::add_spring (Spring const &sp) { - Spring_description description; - - description.ideal_ = ideal; - description.inverse_hooke_ = inverse_hooke; - if (!description.is_sane ()) - { - programming_error ("insane spring found, setting to unit"); - - description.inverse_hooke_ = 1.0; - description.ideal_ = 1.0; - } - - description.block_force_ = -description.ideal_ / description.inverse_hooke_; - // block at distance 0 - - springs_.push_back (description); + force_ = max (force_, sp.blocking_force ()); + springs_.push_back (sp); } vector @@ -248,51 +256,26 @@ Simple_spacer::spring_positions () const ret.push_back (0.); for (vsize i = 0; i < springs_.size (); i++) - ret.push_back (ret.back () + springs_[i].length (ragged_ ? 0.0 : force_)); + ret.push_back (ret.back () + springs_[i].length (ragged_ && force_ > 0 ? 0.0 : force_)); return ret; } -/****************************************************************/ - -Spring_description::Spring_description () -{ - ideal_ = 0.0; - inverse_hooke_ = 0.0; - block_force_ = 0.0; -} - -bool -Spring_description::is_sane () const -{ - return (inverse_hooke_ >= 0) - && ideal_ > 0 - && !isinf (ideal_) && !isnan (ideal_) - && (inverse_hooke_ == 0.0 || fabs (inverse_hooke_) > 1e-8) - ; -} - Real -Spring_description::length (Real f) const +Simple_spacer::force_penalty (bool ragged) const { - return ideal_ + max (f, block_force_) * inverse_hooke_; + /* If we are ragged-right, we don't want to penalise according to the force, + but according to the amount of whitespace that is present after the end + of the line. */ + if (ragged) + return max (0.0, line_len_ - configuration_length (0.0)); + + /* Use a convex compression penalty. */ + Real f = force_; + return f - (f < 0 ? f*f*f*f*2 : 0); } /****************************************************************/ -/* - TODO: should a add penalty for widely varying spring forces (caused - by constraints, eg. - - - . ===== - . | | - .o|o|x ##x - . - - The ## forces the notes apart; we shouldn't allow the O's to touch - this closely. -*/ - struct Rod_description { vsize r_; @@ -320,25 +303,18 @@ struct Column_description { vector rods_; vector end_rods_; /* use these if they end at the last column of the line */ - Real ideal_; - Real inverse_hooke_; - Real end_ideal_; - Real end_inverse_hooke_; + Spring spring_; + Spring end_spring_; + SCM break_permission_; Interval keep_inside_line_; Column_description () { - ideal_ = 0; - inverse_hooke_ = 0; - end_ideal_ = 0; - end_inverse_hooke_ = 0; break_permission_ = SCM_EOL; } }; -static int compare_paper_column_rank (Grob *const &a, Grob *const &b); - static bool is_loose (Grob *g) { @@ -363,43 +339,6 @@ next_spaceable_column (vector const &list, vsize starting) return 0; } -/* this only returns non-NULL if the line-ending column is the next - spaceable-or-breakable column */ -static Grob* -next_line_ending_column (vector const &list, vsize starting) -{ - vsize i = starting + 1; - for (; i < list.size () - && is_loose (list[i]) - && !Paper_column::is_breakable (list[i]); - i++) - ; - return dynamic_cast (list[i])->find_prebroken_piece (LEFT); -} - -static void -get_column_spring (Grob *this_col, Grob *next_col, Real *ideal, Real *inv_hooke) -{ - Spring_smob *spring = 0; - - for (SCM s = this_col->get_object ("ideal-distances"); - !spring && scm_is_pair (s); - s = scm_cdr (s)) - { - Spring_smob *sp = unsmob_spring (scm_car (s)); - - if (sp->other_ == next_col) - spring = sp; - } - - if (!spring) - programming_error (_f ("No spring between column %d and next one", - Paper_column::get_rank (this_col))); - - *ideal = (spring) ? spring->distance_ : 5.0; - *inv_hooke = (spring) ? spring->inverse_strength_ : 1.0; -} - static Column_description get_column_description (vector const &cols, vsize col_index, bool line_starter) { @@ -410,16 +349,17 @@ get_column_description (vector const &cols, vsize col_index, bool line_st Column_description description; Grob *next_col = next_spaceable_column (cols, col_index); if (next_col) - get_column_spring (col, next_col, &description.ideal_, &description.inverse_hooke_); - Grob *end_col = next_line_ending_column (cols, col_index); + description.spring_ = Spaceable_grob::get_spring (col, next_col); + + Grob *end_col = dynamic_cast (cols[col_index+1])->find_prebroken_piece (LEFT); if (end_col) - get_column_spring (col, end_col, &description.end_ideal_, &description.end_inverse_hooke_); + description.end_spring_ = Spaceable_grob::get_spring (col, end_col); for (SCM s = Spaceable_grob::get_minimum_distances (col); scm_is_pair (s); s = scm_cdr (s)) { Grob *other = unsmob_grob (scm_caar (s)); - vsize j = binary_search (cols, other, &compare_paper_column_rank, col_index); + vsize j = binary_search (cols, other, Paper_column::less_than, col_index); if (j != VPOS) { if (cols[j] == other) @@ -428,39 +368,44 @@ get_column_description (vector const &cols, vsize col_index, bool line_st description.end_rods_.push_back (Rod_description (j, scm_to_double (scm_cdar (s)))); } } + if (!line_starter && to_boolean (col->get_property ("keep-inside-line"))) description.keep_inside_line_ = col->extent (col, X_AXIS); + description.break_permission_ = col->get_property ("line-break-permission"); return description; } vector -get_line_forces (vector const &icols, vector breaks, +get_line_forces (vector const &columns, Real line_len, Real indent, bool ragged) { + vector breaks; vector force; - force.resize (breaks.size () * breaks.size (), infinity_f); - + vector non_loose; vector cols; - vsize b = 1; SCM force_break = ly_symbol2scm ("force"); + for (vsize i = 0; i < columns.size (); i++) + if (!is_loose (columns[i]) || Paper_column::is_breakable (columns[i])) + non_loose.push_back (columns[i]); + + breaks.clear (); + breaks.push_back (0); cols.push_back (Column_description ()); - for (vsize i = 1; i < icols.size () - 1; i++) + for (vsize i = 1; i + 1 < non_loose.size (); i++) { - if (b < breaks.size () && breaks[b] == i) - { - breaks[b] = cols.size (); - b++; - } - if (!is_loose (icols[i])) - cols.push_back (get_column_description (icols, i, false)); + if (Paper_column::is_breakable (non_loose[i])) + breaks.push_back (cols.size ()); + + cols.push_back (get_column_description (non_loose, i, false)); } - breaks.back () = cols.size () - 1; + breaks.push_back (cols.size ()); + force.resize (breaks.size () * breaks.size (), infinity_f); - for (vsize b = 0; b < breaks.size () - 1; b++) + for (vsize b = 0; b + 1 < breaks.size (); b++) { - cols[breaks[b]] = get_column_description (icols, breaks[b], true); + cols[breaks[b]] = get_column_description (non_loose, breaks[b], true); vsize st = breaks[b]; for (vsize c = b+1; c < breaks.size (); c++) @@ -469,8 +414,8 @@ get_line_forces (vector const &icols, vector breaks, Simple_spacer spacer; for (vsize i = breaks[b]; i < end - 1; i++) - spacer.add_spring (cols[i].ideal_, cols[i].inverse_hooke_); - spacer.add_spring (cols[end-1].end_ideal_, cols[end-1].inverse_hooke_); + spacer.add_spring (cols[i].spring_); + spacer.add_spring (cols[end-1].end_spring_); for (vsize i = breaks[b]; i < end; i++) @@ -484,19 +429,22 @@ get_line_forces (vector const &icols, vector breaks, if (!cols[i].keep_inside_line_.is_empty ()) { spacer.add_rod (i - st, end - st, cols[i].keep_inside_line_[RIGHT]); - spacer.add_rod (0, i - st, cols[i].keep_inside_line_[LEFT]); + spacer.add_rod (0, i - st, -cols[i].keep_inside_line_[LEFT]); } } spacer.solve ((b == 0) ? line_len - indent : line_len, ragged); - force[b * breaks.size () + c] = spacer.force (); + force[b * breaks.size () + c] = spacer.force_penalty (ragged); - if (cols[end].break_permission_ == force_break) - break; if (!spacer.fits ()) { - force[b * breaks.size () + c] = infinity_f; + if (c == b + 1) + force[b * breaks.size () + c] = -200000; + else + force[b * breaks.size () + c] = infinity_f; break; } + if (end < cols.size () && cols[end].break_permission_ == force_break) + break; } } return force; @@ -513,7 +461,7 @@ get_line_configuration (vector const &columns, Column_x_positions ret; ret.cols_.push_back (dynamic_cast (columns[0])->find_prebroken_piece (RIGHT)); - for (vsize i = 1; i < columns.size () - 1; i++) + for (vsize i = 1; i + 1 < columns.size (); i++) { if (is_loose (columns[i])) ret.loose_cols_.push_back (columns[i]); @@ -524,29 +472,26 @@ get_line_configuration (vector const &columns, /* since we've already put our line-ending column in the column list, we can ignore the end_XXX_ fields of our column_description */ - for (vsize i = 0; i < ret.cols_.size () - 1; i++) + for (vsize i = 0; i + 1 < ret.cols_.size (); i++) { cols.push_back (get_column_description (ret.cols_, i, i == 0)); - spacer.add_spring (cols[i].ideal_, cols[i].inverse_hooke_); + spacer.add_spring (cols[i].spring_); } for (vsize i = 0; i < cols.size (); i++) { for (vsize r = 0; r < cols[i].rods_.size (); r++) spacer.add_rod (i, cols[i].rods_[r].r_, cols[i].rods_[r].dist_); + if (!cols[i].keep_inside_line_.is_empty ()) { spacer.add_rod (i, cols.size (), cols[i].keep_inside_line_[RIGHT]); - spacer.add_rod (0, i, cols[i].keep_inside_line_[LEFT]); + spacer.add_rod (0, i, -cols[i].keep_inside_line_[LEFT]); } } spacer.solve (line_len, ragged); - ret.force_ = spacer.force (); + ret.force_ = spacer.force_penalty (ragged); - /* - We used to have a penalty for compression, no matter what, but that - fucked up wtk1-fugue2 (taking 3 full pages.) - */ ret.config_ = spacer.spring_positions (); for (vsize i = 0; i < ret.config_.size (); i++) ret.config_[i] += indent; @@ -556,7 +501,7 @@ get_line_configuration (vector const &columns, /* Check if breaking constraints are met. */ - for (vsize i = 1; i < ret.cols_.size () - 1; i++) + for (vsize i = 1; i + 1 < ret.cols_.size (); i++) { SCM p = ret.cols_[i]->get_property ("line-break-permission"); if (p == ly_symbol2scm ("force")) @@ -566,9 +511,3 @@ get_line_configuration (vector const &columns, return ret; } -static int -compare_paper_column_rank (Grob *const &a, - Grob *const &b) -{ - return Paper_column::get_rank (a) - Paper_column::get_rank (b); -}