Merge branch 'master' of git://git.savannah.gnu.org/lilypond.git

[lilypond.git] / lily / include / page-breaking.hh

diff --git a/lily/include/page-breaking.hh b/lily/include/page-breaking.hh
index 002d7def29ee7e9be8409d77dbb91d9236c83b8b..acf6bac51ce43e9d9a11263994c2deabb8eebd03 100644 (file)
--- a/lily/include/page-breaking.hh
+++ b/lily/include/page-breaking.hh
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2006--2009 Joe Neeman <joeneeman@gmail.com>
+  Copyright (C) 2006--2011 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
@@ -52,15 +52,16 @@ 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 */
+  /* 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 */
+  /* if system_spec_index_ indexes a score, this points to the broken column */
   Grob *col_;  
   bool score_ender_;
 
@@ -99,6 +100,7 @@ class Page_breaking
 {
 public:
   typedef bool (*Break_predicate) (Grob *);
+  typedef bool (*Prob_break_predicate) (Prob *);
   typedef vector<vsize> Line_division;
   
   /*
@@ -109,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;
@@ -120,13 +122,19 @@ 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 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;
+  int orphan_penalty () const;
 
 protected:
   Paper_book *book_;
@@ -141,6 +149,7 @@ protected:
 
   void break_into_pieces (vsize start, vsize end, Line_division const &div);
   SCM systems ();
+  SCM footnotes ();
 
   void set_current_breakpoints (vsize start,
                                vsize end,
@@ -180,6 +189,11 @@ private:
   int max_systems_per_page_;
   int min_systems_per_page_;
   vsize system_count_;
+  Real footnote_separator_stencil_height_;
+  Real footnote_padding_;
+  Real footnote_number_raise_;
+  Real footnote_footer_padding_;
+  int orphan_penalty_;
 
   vector<Line_division> current_configurations_;
   vector<Break_position> current_chunks_;
@@ -187,11 +201,16 @@ 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<Line_details> cached_line_details_;
   vector<Line_details> uncompressed_line_details_;
 
+  Real paper_height_;
+  mutable vector<Real> page_height_cache_;
+  mutable vector<Real> last_page_height_cache_;
+
   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,
@@ -210,9 +229,9 @@ private:
   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);
+  SCM get_page_configuration (SCM systems, int page_num, int footnote_count, bool ragged, bool last);
+  SCM draw_page (SCM systems, SCM config, int page_num, int footnote_num, bool last);
 };
 #endif /* PAGE_BREAKING_HH */