X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fsimple-spacer.cc;h=ffc4bfcbfce26bad151ab0240007c89602ed26bd;hb=ad6b7158001d4efac5500f29e55e61dff36088ef;hp=f641f854b0607392bd5a0a2177428068958b6c02;hpb=9403281c7c8998d70c65dc45689217c36b87c98b;p=lilypond.git diff --git a/lily/simple-spacer.cc b/lily/simple-spacer.cc index f641f854b0..ffc4bfcbfc 100644 --- a/lily/simple-spacer.cc +++ b/lily/simple-spacer.cc @@ -3,23 +3,23 @@ source file of the GNU LilyPond music typesetter - (c) 1999--2005 Han-Wen Nienhuys + (c) 1999--2006 Han-Wen Nienhuys TODO: - add support for different stretch/shrink constants? */ #include -#include +#include "column-x-positions.hh" +#include "dimensions.hh" +#include "international.hh" #include "libc-extension.hh" // isinf -#include "simple-spacer.hh" #include "paper-column.hh" +#include "simple-spacer.hh" +#include "spaceable-grob.hh" #include "spring.hh" #include "warn.hh" -#include "column-x-positions.hh" -#include "spaceable-grob.hh" -#include "dimensions.hh" /* A simple spacing constraint solver. The approach: @@ -59,14 +59,31 @@ Simple_spacer::Simple_spacer () { - /* - Give an extra penalty for compression. Needed to avoid compressing - tightly spaced lines. - */ - active_count_ = 0; - force_ = 0.; - indent_ = 0.0; - default_space_ = 20 PT; + line_len_ = 0.0; + force_ = 0.0; + fits_ = true; + ragged_ = true; +} + +Real +Simple_spacer::force () const +{ + return force_; +} + +bool +Simple_spacer::fits () const +{ + return fits_; +} + +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 block_stretch = dist - d; + return c * block_stretch; } void @@ -74,37 +91,24 @@ Simple_spacer::add_rod (int l, int r, Real dist) { if (isinf (dist) || isnan (dist)) { - programming_error ("Weird minimum distance. Ignoring"); + programming_error ("ignoring weird minimum distance"); return; } - Real c = range_stiffness (l, r); - if (isinf (c)) + Real block_force = rod_force (l, r, dist); + + if (isinf (block_force)) { - /* - If a spring is fixed, we have to do something here: - we let the rod override the spring. - */ - Real total_dist = 0.; - for (int i = l; i < r; i++) - total_dist += springs_[i].ideal_; - - if (total_dist < dist) + Real spring_dist = range_ideal_len (l, r); + if (spring_dist < dist) for (int i = l; i < r; i++) - springs_[i].ideal_ *= dist / total_dist; + springs_[i].ideal_ *= dist / spring_dist; return; } - - Real d = range_ideal_len (l, r); - Real block_stretch = dist - d; - - Real block_force = c * block_stretch; - force_ = force_ >? block_force; - + force_ = max (force_, block_force); for (int i = l; i < r; i++) - springs_[i].block_force_ = block_force >? - springs_[i].block_force_; + springs_[i].block_force_ = max (block_force, springs_[i].block_force_); } Real @@ -121,124 +125,126 @@ Simple_spacer::range_stiffness (int l, int r) const { Real den = 0.0; for (int i = l; i < r; i++) - { - if (springs_[i].is_active_) - den += 1 / springs_[i].hooke_; - } + den += springs_[i].inverse_hooke_; return 1 / den; } Real -Simple_spacer::active_blocking_force () const -{ - Real bf = -infinity_f; - for (int i = 0; i < springs_.size (); i++) - if (springs_[i].is_active_) - { - bf = bf >? springs_[i].block_force_; - } - return bf; -} - -Real -Simple_spacer::active_springs_stiffness () const +Simple_spacer::configuration_length (Real force) const { - Real stiff = range_stiffness (0, springs_.size ()); - if (isinf (stiff)) - { - /* - all springs are inactive. Take the stiffness of the - latest spring to block. - */ - - Real max_block_force = -infinity_f; - int max_i = -1; - for (int i = 0; i < springs_.size (); i++) - { - if (springs_[i].block_force_ > max_block_force) - { - max_i = i; - max_block_force = springs_[i].block_force_; - } - } + Real l = 0.; + for (vsize i = 0; i < springs_.size (); i++) + l += springs_[i].length (force); - stiff = springs_[max_i].hooke_; - } - return stiff; + return l; } void -Simple_spacer::set_active_states () +Simple_spacer::solve (Real line_len, bool ragged) { - /* float comparison is safe, since force is only copied. */ - for (int i = 0; i < springs_.size (); i++) - if (springs_[i].is_active_ - && springs_[i].block_force_ >= force_) - { - springs_[i].is_active_ = false; - active_count_--; - } + Real conf = configuration_length (force_); + + ragged_ = ragged; + line_len_ = line_len; + if (conf < line_len_) + force_ = expand_line (); + else if (conf > line_len_) + force_ = compress_line (); + + if (ragged && force_ < 0) + fits_ = false; } Real -Simple_spacer::configuration_length () const +Simple_spacer::expand_line () { - Real l = 0.; - for (int i = 0; i < springs_.size (); i++) - l += springs_[i].length (force_); + double inv_hooke = 0; + double cur_len = configuration_length (force_); - return l; -} + fits_ = true; + for (vsize i=0; i < springs_.size (); i++) + inv_hooke += springs_[i].inverse_hooke_; -bool -Simple_spacer::is_active () const -{ - return active_count_; + assert (cur_len <= line_len_); + return (line_len_ - cur_len) / inv_hooke + force_; } -void -Simple_spacer::my_solve_linelen () +Real +Simple_spacer::compress_line () { - while (is_active ()) + double inv_hooke = 0; + double cur_len = configuration_length (force_); + double cur_force = force_; + + fits_ = true; + for (vsize i=0; i < springs_.size (); i++) + inv_hooke += springs_[i].inverse_hooke_; + + assert (line_len_ <= cur_len); + + vector sorted_springs = springs_; + sort (sorted_springs.begin (), sorted_springs.end (), greater ()); + for (vsize i = 0; i < sorted_springs.size (); i++) { - force_ = active_blocking_force (); - Real conf = configuration_length (); + Spring_description sp = sorted_springs[i]; - if (conf < line_len_) + assert (sp.block_force_ <= cur_force); + if (isinf (sp.block_force_)) + break; + + double block_dist = (cur_force - sp.block_force_) * inv_hooke; + if (cur_len - block_dist < line_len_) { - force_ += (line_len_ - conf) * active_springs_stiffness (); - break; + cur_force += (line_len_ - cur_len) / inv_hooke; + cur_len = line_len_; + + /* + Paranoia check. + */ + assert (fabs (configuration_length (cur_force) - cur_len) < 1e-6); + return cur_force; } - else - set_active_states (); + + cur_len -= block_dist; + inv_hooke -= sp.inverse_hooke_; + cur_force = sp.block_force_; } + + fits_ = false; + return cur_force; } void -Simple_spacer::my_solve_natural_len () +Simple_spacer::add_spring (Real ideal, Real inverse_hooke) { - Real line_len_force = 0.0; + Spring_description description; - while (is_active ()) + description.ideal_ = ideal; + description.inverse_hooke_ = inverse_hooke; + if (!description.is_sane ()) { - force_ = active_blocking_force () >? 0.0; - Real conf = configuration_length (); + programming_error ("insane spring found, setting to unit"); - if (conf < line_len_) - { - line_len_force = force_ - + (line_len_ - conf) - * active_springs_stiffness (); - } + description.inverse_hooke_ = 1.0; + description.ideal_ = 1.0; + } - if (force_ < 1e-8) // ugh., - break; + description.block_force_ = -description.ideal_ / description.inverse_hooke_; + // block at distance 0 - set_active_states (); - } + springs_.push_back (description); +} + +vector +Simple_spacer::spring_positions () const +{ + vector ret; + ret.push_back (0.); - force_ = line_len_force; + for (vsize i = 0; i < springs_.size (); i++) + ret.push_back (ret.back () + springs_[i].length (ragged_ && force_ > 0 ? 0.0 : force_)); + return ret; } /****************************************************************/ @@ -246,26 +252,26 @@ Simple_spacer::my_solve_natural_len () Spring_description::Spring_description () { ideal_ = 0.0; - hooke_ = 0.0; - is_active_ = true; + inverse_hooke_ = 0.0; block_force_ = 0.0; } bool Spring_description::is_sane () const { - return (hooke_ > 0) + return (inverse_hooke_ >= 0) && ideal_ > 0 - && !isinf (ideal_) && !isnan (ideal_); + && !isinf (ideal_) && !isnan (ideal_) + && (inverse_hooke_ == 0.0 || fabs (inverse_hooke_) > 1e-8) + ; } Real Spring_description::length (Real f) const { - if (!is_active_) - f = block_force_; - return ideal_ + f / hooke_; + return ideal_ + max (f, block_force_) * inverse_hooke_; } + /****************************************************************/ /* @@ -273,186 +279,285 @@ Spring_description::length (Real f) const by constraints, eg. - ===== - | | - o|o| x ##x - + . ===== + . | | + .o|o|x ##x + . The ## forces the notes apart; we shouldn't allow the O's to touch this closely. */ -void -Simple_spacer_wrapper::solve (Column_x_positions *positions, bool ragged) + +struct Rod_description { - if (ragged) - spacer_->my_solve_natural_len (); - else - spacer_->my_solve_linelen (); + vsize r_; + Real dist_; + + bool operator< (const Rod_description r) + { + return r_ < r.r_; + } + + Rod_description () + { + r_ = 0; + dist_ = 0; + } + + Rod_description (vsize r, Real d) + { + r_ = r; + dist_ = d; + } +}; + +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_; + 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 bool +is_loose (Grob *g) +{ + return (scm_is_pair (g->get_object ("between-cols"))); +} - positions->force_ = spacer_->force_; +static Grob* +maybe_find_prebroken_piece (Grob *g, Direction d) +{ + Grob *ret = dynamic_cast (g)->find_prebroken_piece (d); + if (ret) + return ret; + return g; +} - /* - We used to have a penalty for compression, no matter what, but that - fucked up wtk1-fugue2 (taking 3 full pages.) - */ - positions->config_.push (spacer_->indent_); - for (int i = 0; i < spacer_->springs_.size (); i++) - { - Real l = spacer_->springs_[i].length ((ragged) ? 0.0 : spacer_->force_); - positions->config_.push (positions->config_.top () + l); - /* - we have l>= 0 here, up to rounding errors - */ - } +static Grob* +next_spaceable_column (vector const &list, vsize starting) +{ + for (vsize i = starting+1; i < list.size (); i++) + if (!is_loose (list[i])) + return list[i]; + return 0; +} - /* - For raggedright, we must have a measure of music density: this is - to prevent lots of short lines (which all have force = 0). - */ - if (ragged) +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)) { - positions->satisfies_constraints_ - = positions->config_.top () < spacer_->line_len_; + Spring_smob *sp = unsmob_spring (scm_car (s)); + + if (sp->other_ == next_col) + spring = sp; } - else - positions->satisfies_constraints_ = spacer_->is_active (); - positions->cols_ = spaced_cols_; - positions->loose_cols_ = loose_cols_; + if (!spring) + programming_error (_f ("No spring between column %d and next one", + Paper_column::get_rank (this_col))); - /* - Check if breaking constraints are met. - */ - bool break_satisfy = true; - int sz = positions->cols_.size (); - for (int i = sz; i--;) + *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) +{ + Grob *col = cols[col_index]; + if (line_starter) + col = maybe_find_prebroken_piece (col, RIGHT); + + 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 = 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_); + + for (SCM s = Spaceable_grob::get_minimum_distances (col); + scm_is_pair (s); s = scm_cdr (s)) { - SCM p = positions->cols_[i]->get_property ("penalty"); - if (scm_is_number (p)) + Grob *other = unsmob_grob (scm_caar (s)); + vsize j = binary_search (cols, other, Paper_column::less_than, col_index); + if (j != VPOS) { - if (scm_to_double (p) < -9999) - break_satisfy = break_satisfy && (i == 0 || i == sz -1); - if (scm_to_double (p) > 9999) - break_satisfy = break_satisfy && ! (i == 0 || i == sz -1); + if (cols[j] == other) + description.rods_.push_back (Rod_description (j, scm_to_double (scm_cdar (s)))); + else /* it must end at the LEFT prebroken_piece */ + 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); - positions->satisfies_constraints_ - = positions->satisfies_constraints_ && break_satisfy; + description.break_permission_ = col->get_property ("line-break-permission"); + return description; } -void -Simple_spacer::add_spring (Real ideal, Real hooke) +vector +get_line_forces (vector const &columns, + Real line_len, Real indent, bool ragged) { - Spring_description desc; - - desc.ideal_ = ideal; - desc.hooke_ = hooke; - if (!desc.is_sane ()) + vector breaks; + vector force; + vector non_loose; + vector cols; + 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 < non_loose.size () - 1; i++) { - programming_error ("Insane spring found. Setting to unit spring."); + if (Paper_column::is_breakable (non_loose[i])) + breaks.push_back (cols.size ()); - desc.hooke_ = 1.0; - desc.ideal_ = 1.0; + cols.push_back (get_column_description (non_loose, i, false)); } + breaks.push_back (cols.size ()); + force.resize (breaks.size () * breaks.size (), infinity_f); - if (isinf (hooke)) - { - desc.is_active_ = false; - } - else + for (vsize b = 0; b < breaks.size () - 1; b++) { - /* - desc.is_active_ ? - */ - desc.block_force_ = -desc.hooke_ * desc.ideal_; // block at distance 0 + cols[breaks[b]] = get_column_description (non_loose, breaks[b], true); + vsize st = breaks[b]; - active_count_++; - } - springs_.push (desc); -} - -static int -compare_paper_column_rank (Grob *const &a, - Grob *const &b) -{ - return Paper_column::get_rank (a) - Paper_column::get_rank (b); -} + for (vsize c = b+1; c < breaks.size (); c++) + { + vsize end = breaks[c]; + Simple_spacer spacer; -void -Simple_spacer_wrapper::add_columns (Link_array const &icols) -{ - Link_array cols (icols); + 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].end_inverse_hooke_); - for (int i = cols.size (); i--;) - if (scm_is_pair (cols[i]->get_property ("between-cols"))) - { - loose_cols_.push (cols[i]); - cols.del (i); - } - spaced_cols_ = cols; - for (int i = 0; i < cols.size () - 1; i++) - { - Spring_smob *spring = 0; + for (vsize i = breaks[b]; i < end; i++) + { + for (vsize r = 0; r < cols[i].rods_.size (); r++) + if (cols[i].rods_[r].r_ < end) + spacer.add_rod (i - st, cols[i].rods_[r].r_ - st, cols[i].rods_[r].dist_); + for (vsize r = 0; r < cols[i].end_rods_.size (); r++) + if (cols[i].end_rods_[r].r_ == end) + spacer.add_rod (i - st, end - st, cols[i].end_rods_[r].dist_); + 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.solve ((b == 0) ? line_len - indent : line_len, ragged); - for (SCM s = cols[i]->get_property ("ideal-distances"); - !spring && scm_is_pair (s); - s = scm_cdr (s)) - { - Spring_smob *sp = unsmob_spring (scm_car (s)); + /* add a (convex) penalty for compression. We do this _only_ in get_line_forces, + not get_line_configuration. This is temporary, for backwards compatibility; + the old line/page-breaking stuff ignores page breaks when it calculates line + breaks, so compression penalties can result in scores (eg. wtk-fugue) blowing + up to too many pages. */ + Real f = spacer.force (); + force[b * breaks.size () + c] = f - (f < 0 ? f*f*f*f*4 : 0); - if (sp->other_ == cols[i + 1]) - spring = sp; + if (!spacer.fits ()) + { + 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; +} - if (!spring) - programming_error (_f ("No spring between column %d and next one", - Paper_column::get_rank (cols[i]))); - - Real ideal = (spring) ? spring->distance_ : spacer_->default_space_; - Real hooke = (spring) ? spring->strength_ : 1.0; +Column_x_positions +get_line_configuration (vector const &columns, + Real line_len, + Real indent, + bool ragged) +{ + vector cols; + Simple_spacer spacer; + Column_x_positions ret; - spacer_->add_spring (ideal, hooke); + ret.cols_.push_back (dynamic_cast (columns[0])->find_prebroken_piece (RIGHT)); + for (vsize i = 1; i < columns.size () - 1; i++) + { + if (is_loose (columns[i])) + ret.loose_cols_.push_back (columns[i]); + else + ret.cols_.push_back (columns[i]); } + ret.cols_.push_back (dynamic_cast (columns.back ())->find_prebroken_piece (LEFT)); - for (int i = 0; i < cols.size () - 1; i++) + /* 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 (SCM s = Spaceable_grob::get_minimum_distances (cols[i]); - scm_is_pair (s); s = scm_cdr (s)) - { - Grob *other = unsmob_grob (scm_caar (s)); - int oi = binsearch_links (cols, other, &compare_paper_column_rank); - if (oi >= 0 - && cols[oi] == other) - { - spacer_->add_rod (i, oi, scm_to_double (scm_cdar (s))); - } - } + cols.push_back (get_column_description (ret.cols_, i, i == 0)); + spacer.add_spring (cols[i].ideal_, cols[i].inverse_hooke_); + } + 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 (i - && !to_boolean (cols[i]->get_property ("allow-outside-line"))) + if (!cols[i].keep_inside_line_.is_empty ()) { - Interval e = cols[i]->extent (cols[i], X_AXIS); - if (!e.is_empty ()) - { - spacer_->add_rod (i, cols.size () - 1, e[RIGHT]); - spacer_->add_rod (0, i, e[LEFT]); - } + spacer.add_rod (i, cols.size (), cols[i].keep_inside_line_[RIGHT]); + spacer.add_rod (0, i, -cols[i].keep_inside_line_[LEFT]); } } -} -Simple_spacer_wrapper::Simple_spacer_wrapper () -{ - spacer_ = new Simple_spacer (); -} + spacer.solve (line_len, ragged); + ret.force_ = spacer.force (); -Simple_spacer_wrapper::~Simple_spacer_wrapper () -{ - delete spacer_; -} + /* + 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; -Simple_spacer_wrapper::Simple_spacer_wrapper (Simple_spacer_wrapper const &) -{ + ret.satisfies_constraints_ = spacer.fits (); + + /* + Check if breaking constraints are met. + */ + for (vsize i = 1; i < ret.cols_.size () - 1; i++) + { + SCM p = ret.cols_[i]->get_property ("line-break-permission"); + if (p == ly_symbol2scm ("force")) + ret.satisfies_constraints_ = false; + } + + return ret; } +