2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2006--2011 Joe Neeman <joeneeman@gmail.com>
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 #ifndef CONSTRAINED_BREAKING_HH
21 #define CONSTRAINED_BREAKING_HH
23 #include "lily-guile.hh"
28 * Begin/rest-of-line hack. This geometrical shape is a crude approximation
29 * of Skyline, but it is better than a rectangle.
39 Line_shape (Interval begin, Interval rest);
40 Line_shape piggyback (Line_shape mount, Real padding) const;
47 vector<Stencil *> footnotes_; /* The footnotes at the bottom of the
48 page, where each stencil represents
49 a different footnote. */
50 Interval refpoint_extent_; /* The refpoints of the first and last
51 spaceable staff in this line. min-distance
52 should be measured from the bottom
53 refpoint_extent of one line to the
54 top refpoint_extent of the next. */
55 Real tallness_; /* Y-extent, adjusted according to begin/rest-of-line*/
57 Real padding_; /* compulsory space after this system (if we're not
61 Real title_min_distance_;
63 Real space_; /* spring length */
67 SCM break_permission_;
76 /* The page-breaker deals with forbidden page breaks by "compressing"
77 two Line_detailses into one. The following fields are used by the
78 page-breaker to keep track of this. If the number of fields needed
79 by the page-breaker grows, it might be a good idea to create a separate
81 int compressed_lines_count_;
82 int compressed_nontitle_lines_count_;
83 bool last_markup_line_;
84 bool first_markup_line_;
95 title_min_distance_ = 0;
99 tight_spacing_ = false;
100 break_permission_ = ly_symbol2scm ("allow");
101 page_permission_ = ly_symbol2scm ("allow");
102 turn_permission_ = ly_symbol2scm ("allow");
107 compressed_lines_count_ = 1;
108 compressed_nontitle_lines_count_ = 1;
109 last_markup_line_ = false;
110 first_markup_line_ = false;
112 refpoint_extent_ = Interval (0, 0);
115 Line_details (Prob *pb, Output_def *paper);
116 Real full_height () const;
117 Real tallness () const;
118 Real spring_length (Line_details const &next_line) const;
122 Helper to trace back an optimal path
124 struct Constrained_break_node
126 /* the number of bars in all the systems before this one
130 /* unlike the Gourlay breaker, this is the sum of all demerits up to,
131 * and including, this line */
133 struct Line_details details_;
135 Constrained_break_node ()
138 demerits_ = infinity_f;
143 printf ("prev break %d, demerits %f\n", prev_, demerits_);
148 A dynamic programming solution to breaking scores into lines
150 class Constrained_breaking
153 vector<Column_x_positions> solve (vsize start, vsize end, vsize sys_count);
154 vector<Column_x_positions> best_solution (vsize start, vsize end);
155 vector<Line_details> line_details (vsize start, vsize end, vsize sys_count);
157 Constrained_breaking (Paper_score *ps);
158 Constrained_breaking (Paper_score *ps, vector<vsize> const &start_col_posns);
160 int max_system_count (vsize start, vsize end);
161 int min_system_count (vsize start, vsize end);
164 Paper_score *pscore_;
165 vsize valid_systems_;
170 Real system_system_min_distance_;
171 Real system_system_padding_;
172 Real system_system_space_;
173 Real system_markup_space_;
174 Real score_system_min_distance_;
175 Real score_system_padding_;
176 Real score_markup_min_distance_;
177 Real score_markup_padding_;
179 /* the (i,j)th entry is the configuration for breaking between
181 Matrix<Line_details> lines_;
183 /* the [i](j,k)th entry is the score for fitting the first k bars onto the
184 first j systems, starting at the i'th allowed starting column */
185 vector<Matrix<Constrained_break_node> > state_;
187 vector<vsize> start_; /* the columns at which we might be asked to start breaking */
188 vector<vsize> starting_breakpoints_; /* the corresponding index in breaks_ */
191 vector<vsize> breaks_;
194 void resize (vsize systems);
196 Column_x_positions space_line (vsize start_col, vsize end_col);
197 vsize prepare_solution (vsize start, vsize end, vsize sys_count);
199 Real combine_demerits (Real force, Real prev_force);
201 bool calc_subproblem (vsize start, vsize systems, vsize max_break_index);
202 void fill_line_details (Line_details *const, vsize, vsize);
204 #endif /* CONSTRAINED_BREAKING_HH */