lily/include/page-breaking.hh

   1 /*
   2   page-breaking.hh -- declare a superclass and utility
   3   functions for several different page-breaking algorithms
   4
   5   source file of the GNU LilyPond music typesetter
   6
   7   (c) 2006--2007 Joe Neeman <joeneeman@gmail.com>
   8 */
   9
  10 #ifndef PAGE_BREAKING_HH
  11 #define PAGE_BREAKING_HH
  12
  13 #include "constrained-breaking.hh"
  14 #include "page-spacing.hh"
  15
  16 /* Either a paper-score, markup or header.
  17  */
  18 struct System_spec
  19 {
  20   System_spec (Paper_score *ps)
  21   {
  22     pscore_ = ps;
  23     prob_ = NULL;
  24   }
  25
  26   System_spec (Prob *pb)
  27   {
  28     prob_ = pb;
  29     pscore_ = NULL;
  30   }
  31
  32   System_spec ()
  33   {
  34     pscore_ = NULL;
  35     prob_ = NULL;
  36   }
  37
  38   Paper_score *pscore_;
  39   Prob *prob_;
  40 };
  41
  42 struct Break_position
  43 {
  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 */
  48   bool score_ender_;
  49
  50   Break_position (vsize s=VPOS, vsize brk=VPOS, Grob *g=NULL, bool end=false)
  51   {
  52     sys_ = s;
  53     score_break_ = brk;
  54     col_ = g;
  55     score_ender_ = end;
  56   }
  57
  58   bool operator< (const Break_position &other)
  59   {
  60     return (sys_ == VPOS && other.sys_ != VPOS)
  61       || (sys_ < other.sys_)
  62       || (sys_ == other.sys_ && score_break_ < other.score_break_);
  63   }
  64
  65   bool operator<= (const Break_position &other)
  66   {
  67     return (sys_ == VPOS)
  68       || (sys_ < other.sys_ && other.sys_ != VPOS)
  69       || (sys_ == other.sys_ && score_break_ <= other.score_break_);
  70   }
  71 };
  72
  73 class Page_breaking
  74 {
  75 public:
  76   typedef bool (*Break_predicate) (Grob *);
  77   typedef vector<vsize> Line_division;
  78   virtual SCM solve () = 0;
  79
  80   Page_breaking (Paper_book *pb, Break_predicate);
  81   virtual ~Page_breaking ();
  82
  83   bool ragged () const;
  84   bool ragged_last () const;
  85   bool last () const;
  86   Real page_height (int page_number, bool last) const;
  87
  88 protected:
  89   Paper_book *book_;
  90
  91   vsize next_system (Break_position const &break_pos) const;
  92
  93   SCM make_pages (vector<vsize> lines_per_page, SCM lines);
  94
  95   vsize min_system_count (vsize start, vsize end);
  96   vsize max_system_count (vsize start, vsize end);
  97
  98
  99   void break_into_pieces (vsize start, vsize end, Line_division const &div);
 100   SCM systems ();
 101
 102   void set_current_breakpoints (vsize start,
 103                                 vsize end,
 104                                 vsize system_count,
 105                                 Line_division lower_bound = Line_division (),
 106                                 Line_division upper_bound = Line_division ());
 107   vsize current_configuration_count () const;
 108   Line_division current_configuration (vsize configuration_index) const;
 109   Spacing_result space_systems_on_n_pages (vsize configuration_index, vsize n, vsize first_page_num);
 110   Spacing_result space_systems_on_n_or_one_more_pages (vsize configuration_index, vsize n, vsize first_page_num);
 111   Spacing_result space_systems_on_best_pages (vsize configuration_index, vsize first_page_num);
 112   vsize min_page_count (vsize configuration_index, vsize first_page_num);
 113   bool all_lines_stretched (vsize configuration_index);
 114   Real blank_page_penalty () const;
 115
 116   SCM breakpoint_property (vsize breakpoint, char const *str);
 117   vector<Break_position> breaks_;
 118
 119 private:
 120   vector<Break_position> chunks_;
 121   vector<System_spec> all_;
 122   vector<Constrained_breaking> line_breaking_;
 123   bool ragged_;
 124   bool ragged_last_;
 125
 126   vector<Line_division> current_configurations_;
 127   vector<Break_position> current_chunks_;
 128   vsize current_start_breakpoint_;
 129   vsize current_end_breakpoint_;
 130
 131   void cache_line_details (vsize configuration_index);
 132   void clear_line_details_cache ();
 133   vsize cached_configuration_index_;
 134   vector<Line_details> cached_line_details_;
 135   vector<Line_details> uncompressed_line_details_;
 136
 137   vector<Break_position> chunk_list (vsize start, vsize end);
 138   Line_division system_count_bounds (vector<Break_position> const &chunks, bool min);
 139   void line_breaker_args (vsize i,
 140                           Break_position const &start,
 141                           Break_position const &end,
 142                           vsize *line_breaker_start,
 143                           vsize *line_breaker_end);
 144
 145   void line_divisions_rec (vsize system_count,
 146                            Line_division const &min,
 147                            Line_division const &max,
 148                            Line_division *cur);
 149
 150   vector<Line_details> line_details (vsize start, vsize end, Line_division const &div);
 151   Spacing_result space_systems_on_1_page (vector<Line_details> const &lines, Real page_height, bool ragged);
 152   Spacing_result space_systems_on_2_pages (vsize configuration_index, vsize first_page_num);
 153   Spacing_result finalize_spacing_result (vsize configuration_index, Spacing_result);
 154   void create_system_list ();
 155   void find_chunks_and_breaks (Break_predicate);
 156 };
 157 #endif /* PAGE_BREAKING_HH */