X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fpage-breaking.hh;h=a7babd4f70da4bc91e2409bcd6524121bcf14b82;hb=66b2a060d7402e0d9d42586207b71ca3eda752f1;hp=e0b2abac33f48a6df6bf21762a04a874d5356365;hpb=dc3018f0d0733c502e8b665ff97b141d95176f4a;p=lilypond.git diff --git a/lily/include/page-breaking.hh b/lily/include/page-breaking.hh index e0b2abac33..a7babd4f70 100644 --- a/lily/include/page-breaking.hh +++ b/lily/include/page-breaking.hh @@ -1,10 +1,20 @@ /* - 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--2012 Joe Neeman - (c) 2006--2009 Joe Neeman + 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 . */ #ifndef PAGE_BREAKING_HH @@ -42,23 +52,24 @@ struct System_spec struct Break_position { /* - index in system_spec_index_, if VPOS start of book. + index into system_specs_, if this is VPOS, the Break_position represents the + start of the 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_ indexes 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_; + /* if system_spec_index_ indexes a score, this points to the broken column */ + Grob *col_; bool score_ender_; /* 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) + Break_position (vsize s = VPOS, vsize brk = VPOS, Grob *g = NULL, bool end = false) { system_spec_index_ = s; score_break_ = brk; @@ -70,18 +81,18 @@ struct Break_position /* lexicographic in (system_spec_index_, score_break_) */ - bool operator< (const Break_position &other) + 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_); + || (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) + 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_); + || (system_spec_index_ < other.system_spec_index_ && other.system_spec_index_ != VPOS) + || (system_spec_index_ == other.system_spec_index_ && score_break_ <= other.score_break_); } }; @@ -89,8 +100,9 @@ class Page_breaking { public: typedef bool (*Break_predicate) (Grob *); + typedef bool (*Prob_break_predicate) (Prob *); typedef vector Line_division; - + /* TODO: naming. @@ -99,7 +111,7 @@ public: */ virtual SCM solve () = 0; - Page_breaking (Paper_book *pb, Break_predicate); + Page_breaking (Paper_book *pb, Break_predicate, Prob_break_predicate); virtual ~Page_breaking (); bool ragged () const; @@ -110,13 +122,20 @@ public: int max_systems_per_page () const; int min_systems_per_page () const; Real page_height (int page_number, bool last) const; + Real paper_height () const; vsize system_count () const; + Real footnote_separator_stencil_height () const; + Real footnote_padding () const; + Real in_note_padding () const; + Real footnote_number_raise () const; + Real footnote_footer_padding () 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; + 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_; @@ -128,29 +147,30 @@ protected: 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 (); + SCM footnotes (); void set_current_breakpoints (vsize start, - vsize end, - vsize system_count, - Line_division lower_bound = Line_division (), - Line_division upper_bound = Line_division ()); + 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); + 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); + vsize first_page_num, + Real penalty_for_fewer_pages); Page_spacing_result space_systems_on_best_pages (vsize configuration_index, - vsize first_page_num); + vsize first_page_num); Page_spacing_result space_systems_with_fixed_number_per_page (vsize configuration_index, - vsize first_page_num); + vsize first_page_num); Page_spacing_result pack_systems_on_least_pages (vsize configuration_index, - vsize first_page_num); + 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; @@ -169,6 +189,12 @@ private: int max_systems_per_page_; int min_systems_per_page_; vsize system_count_; + Real footnote_separator_stencil_height_; + Real footnote_padding_; + Real in_note_padding_; + Real footnote_number_raise_; + Real footnote_footer_padding_; + int orphan_penalty_; vector current_configurations_; vector current_chunks_; @@ -176,30 +202,35 @@ private: 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 cached_line_details_; vector uncompressed_line_details_; + Real paper_height_; + mutable vector page_height_cache_; + mutable vector last_page_height_cache_; + vector chunk_list (vsize start, vsize end); Line_division system_count_bounds (vector 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); + 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); + Line_division const &min, + Line_division const &max, + Line_division *cur); vector line_details (vsize start, vsize end, Line_division const &div); Page_spacing_result space_systems_on_1_page (vector 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); + 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);