/*
- page-breaking.hh -- declare a superclass and utility
- functions for several different page-breaking algorithms
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2006--2010 Joe Neeman <joeneeman@gmail.com>
- (c) 2006 Joe Neeman <joeneeman@gmail.com>
+ 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/>.
*/
#ifndef PAGE_BREAKING_HH
#define PAGE_BREAKING_HH
#include "constrained-breaking.hh"
-#include "lily-guile.hh"
+#include "page-spacing.hh"
/* Either a paper-score, markup or header.
*/
struct System_spec
{
- System_spec (Paper_score*, int);
- System_spec (Prob*);
- System_spec ();
+ System_spec (Paper_score *ps)
+ {
+ pscore_ = ps;
+ prob_ = NULL;
+ }
+
+ System_spec (Prob *pb)
+ {
+ prob_ = pb;
+ pscore_ = NULL;
+ }
+
+ System_spec ()
+ {
+ pscore_ = NULL;
+ prob_ = NULL;
+ }
Paper_score *pscore_;
Prob *prob_;
-
- vsize score_break_count_; /* for scores, this is the number of start-points our line-
- breaker has */
};
struct Break_position
{
- vsize sys_; /* the index in our all_ list */
- vsize score_break_; /* if sys_ is a score, then we start at the score_brk_'th
- possible page-break in the score */
+ /*
+ index in system_spec_index_, if VPOS start of book.
+ */
+ vsize system_spec_index_;
+
+ /* if system_spec_index_ is a score, then we start at the score_brk_'th possible
+ page-break in the score */
+ vsize score_break_;
+
+ /* if system_spec_index_ is a score, this points to the broken column */
+ Grob *col_;
+ bool score_ender_;
- Break_position (vsize s=VPOS, vsize brk=VPOS)
+ /* if non-zero, this is the (fixed, uncompressed) number of lines between
+ this Break_position and the previous. */
+ int forced_line_count_;
+
+ Break_position (vsize s=VPOS, vsize brk=VPOS, Grob *g=NULL, bool end=false)
{
- sys_ = s;
+ system_spec_index_ = s;
score_break_ = brk;
+ col_ = g;
+ score_ender_ = end;
+ forced_line_count_ = 0;
+ }
+
+ /*
+ lexicographic in (system_spec_index_, score_break_)
+ */
+ bool operator< (const Break_position &other)
+ {
+ return (system_spec_index_ == VPOS && other.system_spec_index_ != VPOS)
+ || (system_spec_index_ < other.system_spec_index_)
+ || (system_spec_index_ == other.system_spec_index_ && score_break_ < other.score_break_);
+ }
+
+ bool operator<= (const Break_position &other)
+ {
+ return (system_spec_index_ == VPOS)
+ || (system_spec_index_ < other.system_spec_index_ && other.system_spec_index_ != VPOS)
+ || (system_spec_index_ == other.system_spec_index_ && score_break_ <= other.score_break_);
}
};
class Page_breaking
{
public:
+ typedef bool (*Break_predicate) (Grob *);
+ typedef bool (*Prob_break_predicate) (Prob *);
+ typedef vector<vsize> Line_division;
+
+ /*
+ TODO: naming.
+
+ determine the page breaking, and break scores into lines
+ appropriately.
+ */
virtual SCM solve () = 0;
- Page_breaking (Paper_book *pb, bool allow_intra_score_breaks);
+ Page_breaking (Paper_book *pb, Break_predicate, Prob_break_predicate);
virtual ~Page_breaking ();
-protected:
- std::vector<Break_position> breaks_;
- std::vector<System_spec> all_;
- std::vector<Constrained_breaking> line_breaking_;
+ bool ragged () const;
+ bool ragged_last () const;
+ bool is_last () const;
+ bool ends_score () const;
+ int systems_per_page () const;
+ int max_systems_per_page () const;
+ int min_systems_per_page () const;
+ Real page_height (int page_number, bool last) const;
+ vsize system_count () const;
+ Real line_count_penalty (int line_count) const;
+ int line_count_status (int line_count) const;
+ bool too_many_lines (int line_count) const;
+ bool too_few_lines (int line_count) const;
+ Real min_whitespace_at_top_of_page (Line_details const&) const;
+ Real min_whitespace_at_bottom_of_page (Line_details const&) const;
+ int orphan_penalty () const;
+protected:
Paper_book *book_;
- Real page_height (int page_number, bool last);
- vsize next_system (vsize starting_break_index) const;
-
- void create_system_list (bool allow_intra_score_breaks);
- std::vector<vsize> find_page_break_indices (Paper_score *pscore);
+ vsize next_system (Break_position const &break_pos) const;
SCM make_pages (vector<vsize> lines_per_page, SCM lines);
- void calc_system_count_bounds (vsize start, vsize end,
- vector<vsize> *min,
- vector<vsize> *max);
-
- void divide_systems (vsize system_count, vector<vsize> const &min,
- vector<vsize> const &max,
- vector<vector<vsize> > *result,
- vector<vsize> *cur);
-
- void line_breaker_args (vsize i, vsize *break_st, vsize *break_end);
- vsize get_min_systems (vsize sys, vsize break_start, vsize break_end);
- vsize get_max_systems (vsize sys, vsize break_start, vsize break_end);
- vector<Column_x_positions> get_line_breaks (vsize sys, vsize sys_count, vsize st, vsize end);
- vector<Line_details> get_line_details (vsize start_break, vsize end_break, vector<vsize> const &div);
+ vsize min_system_count (vsize start, vsize end);
+ vsize max_system_count (vsize start, vsize end);
+
+
+ void break_into_pieces (vsize start, vsize end, Line_division const &div);
+ SCM systems ();
+
+ void set_current_breakpoints (vsize start,
+ vsize end,
+ vsize system_count,
+ Line_division lower_bound = Line_division (),
+ Line_division upper_bound = Line_division ());
+ void set_to_ideal_line_configuration (vsize start, vsize end);
+
+ vsize current_configuration_count () const;
+ Line_division current_configuration (vsize configuration_index) const;
+ Page_spacing_result space_systems_on_n_pages (vsize configuration_index,
+ vsize n, vsize first_page_num);
+ Page_spacing_result space_systems_on_n_or_one_more_pages (vsize configuration_index, vsize n,
+ vsize first_page_num,
+ Real penalty_for_fewer_pages);
+ Page_spacing_result space_systems_on_best_pages (vsize configuration_index,
+ vsize first_page_num);
+ Page_spacing_result space_systems_with_fixed_number_per_page (vsize configuration_index,
+ vsize first_page_num);
+ Page_spacing_result pack_systems_on_least_pages (vsize configuration_index,
+ vsize first_page_num);
+ vsize min_page_count (vsize configuration_index, vsize first_page_num);
+ bool all_lines_stretched (vsize configuration_index);
+ Real blank_page_penalty () const;
+
+ SCM breakpoint_property (vsize breakpoint, char const *str);
+
+ vsize last_break_position () const;
+private:
+ vector<Break_position> breaks_;
+ vector<Break_position> chunks_;
+ vector<System_spec> system_specs_;
+ vector<Constrained_breaking> line_breaking_;
+ bool ragged_;
+ bool ragged_last_;
+ int systems_per_page_;
+ int max_systems_per_page_;
+ int min_systems_per_page_;
+ vsize system_count_;
+ int orphan_penalty_;
+
+ vector<Line_division> current_configurations_;
+ vector<Break_position> current_chunks_;
+ vsize current_start_breakpoint_;
+ vsize current_end_breakpoint_;
+
+ void cache_line_details (vsize configuration_index);
+ void compute_line_heights ();
+ void clear_line_details_cache ();
+ vsize cached_configuration_index_;
+ vector<Line_details> cached_line_details_;
+ vector<Line_details> uncompressed_line_details_;
+
+ vector<Break_position> chunk_list (vsize start, vsize end);
+ Line_division system_count_bounds (vector<Break_position> const &chunks, bool min);
+ void line_breaker_args (vsize i,
+ Break_position const &start,
+ Break_position const &end,
+ vsize *line_breaker_start,
+ vsize *line_breaker_end);
+
+ void line_divisions_rec (vsize system_count,
+ Line_division const &min,
+ Line_division const &max,
+ Line_division *cur);
+
+ vector<Line_details> line_details (vsize start, vsize end, Line_division const &div);
+ Page_spacing_result space_systems_on_1_page (vector<Line_details> const &lines, Real page_height, bool ragged);
+ Page_spacing_result space_systems_on_2_pages (vsize configuration_index, vsize first_page_num);
+ Page_spacing_result finalize_spacing_result (vsize configuration_index, Page_spacing_result);
+ void create_system_list ();
+ void find_chunks_and_breaks (Break_predicate, Prob_break_predicate);
+ SCM make_page (int page_num, bool last) const;
+ SCM get_page_configuration (SCM systems, int page_num, bool ragged, bool last);
+ SCM draw_page (SCM systems, SCM config, int page_num, bool last);
};
#endif /* PAGE_BREAKING_HH */
projects / lilypond.git / blobdiff