2 page-breaking.hh -- declare a superclass and utility
3 functions for several different page-breaking algorithms
5 source file of the GNU LilyPond music typesetter
7 (c) 2006 Joe Neeman <joeneeman@gmail.com>
10 #ifndef PAGE_BREAKING_HH
11 #define PAGE_BREAKING_HH
13 #include "constrained-breaking.hh"
14 #include "lily-guile.hh"
16 /* Either a paper-score, markup or header.
20 System_spec (Paper_score *ps)
26 System_spec (Prob *pb)
44 vsize sys_; /* our index in the all_ list */
45 vsize score_break_; /* if sys_ is a score, then we start at the score_brk_'th
46 possible page-break in the score */
47 Grob *col_; /* if sys_ is a score, this points to the broken column */
50 Break_position (vsize s=VPOS, vsize brk=VPOS, Grob *g=NULL, bool end=false)
58 bool operator< (const Break_position &other)
60 return (sys_ == VPOS && other.sys_ != VPOS)
61 || (sys_ < other.sys_)
62 || (sys_ == other.sys_ && score_break_ < other.score_break_);
65 bool operator<= (const Break_position &other)
68 || (sys_ < other.sys_ && other.sys_ != VPOS)
69 || (sys_ == other.sys_ && score_break_ <= other.score_break_);
76 typedef bool (*Break_predicate) (Grob *);
77 typedef vector<vsize> Line_division;
78 virtual SCM solve () = 0;
80 Page_breaking (Paper_book *pb, Break_predicate);
81 virtual ~Page_breaking ();
86 Real page_height (int page_number, bool last);
87 vsize next_system (Break_position const &break_pos) const;
89 SCM make_pages (vector<vsize> lines_per_page, SCM lines);
91 vsize min_system_count (vsize start, vsize end);
92 vsize max_system_count (vsize start, vsize end);
93 vector<Line_details> line_details (vsize start, vsize end, Line_division const &div);
95 void break_into_pieces (vsize start, vsize end, Line_division const &div);
99 vector<Line_division> line_divisions (vsize start,
102 Line_division lower_bound = Line_division (),
103 Line_division upper_bound = Line_division ());
105 SCM breakpoint_property (vsize breakpoint, char const *str);
106 vector<Break_position> breaks_;
109 vector<Break_position> chunks_;
110 vector<System_spec> all_;
111 vector<Constrained_breaking> line_breaking_;
113 vector<Break_position> chunk_list (vsize start, vsize end);
114 Line_division system_count_bounds (vector<Break_position> const &chunks, bool min);
115 void line_breaker_args (vsize i,
116 Break_position const &start,
117 Break_position const &end,
118 vsize *line_breaker_start,
119 vsize *line_breaker_end);
121 void line_divisions_rec (vsize system_count,
122 Line_division const &min,
123 Line_division const &max,
124 vector<Line_division> *result,
127 void create_system_list ();
128 void find_chunks_and_breaks (Break_predicate);
130 #endif /* PAGE_BREAKING_HH */