2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2006--2012 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 PAGE_BREAKING_HH
21 #define PAGE_BREAKING_HH
23 #include "constrained-breaking.hh"
24 #include "page-spacing.hh"
26 /* Either a paper-score, markup or header.
30 System_spec (Paper_score *ps)
36 System_spec (Prob *pb)
55 index into system_specs_, if this is VPOS, the Break_position represents the
58 vsize system_spec_index_;
60 /* if system_spec_index_ indexes a score, then we start at the score_brk_'th
61 possible page-break in the score */
64 /* if system_spec_index_ indexes a score, this points to the broken column */
68 /* if non-zero, this is the (fixed, uncompressed) number of lines between
69 this Break_position and the previous. */
70 int forced_line_count_;
72 Break_position (vsize s = VPOS, vsize brk = VPOS, Grob *g = NULL, bool end = false)
74 system_spec_index_ = s;
78 forced_line_count_ = 0;
82 lexicographic in (system_spec_index_, score_break_)
84 bool operator < (const Break_position &other)
86 return (system_spec_index_ == VPOS && other.system_spec_index_ != VPOS)
87 || (system_spec_index_ < other.system_spec_index_)
88 || (system_spec_index_ == other.system_spec_index_ && score_break_ < other.score_break_);
91 bool operator <= (const Break_position &other)
93 return (system_spec_index_ == VPOS)
94 || (system_spec_index_ < other.system_spec_index_ && other.system_spec_index_ != VPOS)
95 || (system_spec_index_ == other.system_spec_index_ && score_break_ <= other.score_break_);
102 typedef bool (*Break_predicate) (Grob *);
103 typedef bool (*Prob_break_predicate) (Prob *);
104 typedef vector<vsize> Line_division;
109 determine the page breaking, and break scores into lines
112 virtual SCM solve () = 0;
114 Page_breaking (Paper_book *pb, Break_predicate, Prob_break_predicate);
115 virtual ~Page_breaking ();
117 bool ragged () const;
118 bool ragged_last () const;
119 bool is_last () const;
120 bool ends_score () const;
121 int systems_per_page () const;
122 int max_systems_per_page () const;
123 int min_systems_per_page () const;
124 Real page_height (int page_number, bool last) const;
125 Real paper_height () const;
126 vsize system_count () const;
127 Real footnote_separator_stencil_height () const;
128 Real footnote_padding () const;
129 Real in_note_padding () const;
130 Real footnote_number_raise () const;
131 Real footnote_footer_padding () const;
132 Real line_count_penalty (int line_count) const;
133 int line_count_status (int line_count) const;
134 bool too_many_lines (int line_count) const;
135 bool too_few_lines (int line_count) const;
136 Real min_whitespace_at_top_of_page (Line_details const &) const;
137 Real min_whitespace_at_bottom_of_page (Line_details const &) const;
138 int orphan_penalty () const;
143 vsize next_system (Break_position const &break_pos) const;
145 SCM make_pages (vector<vsize> lines_per_page, SCM lines);
147 vsize min_system_count (vsize start, vsize end);
148 vsize max_system_count (vsize start, vsize end);
150 void break_into_pieces (vsize start, vsize end, Line_division const &div);
154 void set_current_breakpoints (vsize start,
157 Line_division lower_bound = Line_division (),
158 Line_division upper_bound = Line_division ());
159 void set_to_ideal_line_configuration (vsize start, vsize end);
161 vsize current_configuration_count () const;
162 Line_division current_configuration (vsize configuration_index) const;
163 Page_spacing_result space_systems_on_n_pages (vsize configuration_index,
164 vsize n, vsize first_page_num);
165 Page_spacing_result space_systems_on_n_or_one_more_pages (vsize configuration_index, vsize n,
166 vsize first_page_num,
167 Real penalty_for_fewer_pages);
168 Page_spacing_result space_systems_on_best_pages (vsize configuration_index,
169 vsize first_page_num);
170 Page_spacing_result space_systems_with_fixed_number_per_page (vsize configuration_index,
171 vsize first_page_num);
172 Page_spacing_result pack_systems_on_least_pages (vsize configuration_index,
173 vsize first_page_num);
174 vsize min_page_count (vsize configuration_index, vsize first_page_num);
175 bool all_lines_stretched (vsize configuration_index);
176 Real blank_page_penalty () const;
178 SCM breakpoint_property (vsize breakpoint, char const *str);
180 vsize last_break_position () const;
182 vector<Break_position> breaks_;
183 vector<Break_position> chunks_;
184 vector<System_spec> system_specs_;
185 vector<Constrained_breaking> line_breaking_;
188 int systems_per_page_;
189 int max_systems_per_page_;
190 int min_systems_per_page_;
192 Real footnote_separator_stencil_height_;
193 Real footnote_padding_;
194 Real in_note_padding_;
195 Real footnote_number_raise_;
196 Real footnote_footer_padding_;
199 vector<Line_division> current_configurations_;
200 vector<Break_position> current_chunks_;
201 vsize current_start_breakpoint_;
202 vsize current_end_breakpoint_;
204 void cache_line_details (vsize configuration_index);
205 void compute_line_heights ();
206 void clear_line_details_cache ();
207 vsize cached_configuration_index_;
208 vector<Line_details> cached_line_details_;
209 vector<Line_details> uncompressed_line_details_;
212 mutable vector<Real> page_height_cache_;
213 mutable vector<Real> last_page_height_cache_;
215 vector<Break_position> chunk_list (vsize start, vsize end);
216 Line_division system_count_bounds (vector<Break_position> const &chunks, bool min);
217 void line_breaker_args (vsize i,
218 Break_position const &start,
219 Break_position const &end,
220 vsize *line_breaker_start,
221 vsize *line_breaker_end);
223 void line_divisions_rec (vsize system_count,
224 Line_division const &min,
225 Line_division const &max,
228 vector<Line_details> line_details (vsize start, vsize end, Line_division const &div);
229 Page_spacing_result space_systems_on_1_page (vector<Line_details> const &lines, Real page_height, bool ragged);
230 Page_spacing_result space_systems_on_2_pages (vsize configuration_index, vsize first_page_num);
231 Page_spacing_result finalize_spacing_result (vsize configuration_index, Page_spacing_result);
232 void create_system_list ();
233 void find_chunks_and_breaks (Break_predicate, Prob_break_predicate);
234 SCM make_page (int page_num, bool last) const;
235 SCM get_page_configuration (SCM systems, int page_num, bool ragged, bool last);
236 SCM draw_page (SCM systems, SCM config, int page_num, bool last);
238 #endif /* PAGE_BREAKING_HH */