lily/include/page-layout-problem.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2009--2011 Joe Neeman <joeneeman@gmail.com>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef PAGE_LAYOUT_HH
  21 #define PAGE_LAYOUT_HH
  22
  23 #include "simple-spacer.hh"
  24 #include "skyline.hh"
  25
  26 class Page_layout_problem
  27 {
  28 public:
  29   Page_layout_problem (Paper_book*, SCM page, SCM systems);
  30
  31   SCM solution (bool ragged);
  32   void set_header_height (Real);
  33   void set_footer_height (Real);
  34   static bool read_spacing_spec (SCM spec, Real* dest, SCM sym);
  35   static bool is_spaceable (Grob *g);
  36   static SCM get_details (Grob *g);
  37   static SCM get_footnotes_from_lines (SCM lines, Real padding);
  38   static Stencil* get_footnote_separator_stencil (Output_def *paper);
  39   static SCM get_spacing_spec (Grob *before, Grob *after, bool pure, int start, int end);
  40   static Real get_fixed_spacing (Grob *before, Grob *after, int spaceable_index, bool pure, int start, int end);
  41   static void add_footnotes_to_footer (SCM footnotes, Stencil *foot, Paper_book *pb);
  42
  43 protected:
  44   void append_system (System*, Spring const&, Real indent, Real padding);
  45   void append_prob (Prob*, Spring const&, Real padding);
  46
  47   void solve_rod_spring_problem (bool ragged);
  48   SCM find_system_offsets ();
  49   void distribute_loose_lines (vector<Grob*> const&, vector<Real> const&, Real, Real);
  50
  51   static void build_system_skyline (vector<Grob*> const&, vector<Real> const&, Skyline* up, Skyline* down);
  52   static vector<Grob*> filter_dead_elements (vector<Grob*> const&);
  53
  54   // This is a union (in spirit).
  55   // Either staves must be empty or prob must be null.
  56   typedef struct Element {
  57     Prob *prob;
  58     vector<Grob*> staves;
  59     vector<Real> min_offsets;
  60
  61     Element (vector<Grob*> const& a, vector<Real> const& o)
  62     {
  63       staves = a;
  64       min_offsets = o;
  65       prob = 0;
  66     }
  67
  68     Element (Prob *p)
  69     {
  70       prob = p;
  71     }
  72   } Element;
  73
  74   static Interval first_staff_extent (Element const&);
  75   static Interval last_staff_extent (Element const&);
  76   static Interval prob_extent (Prob*);
  77   static SCM get_details (Element const&);
  78   static SCM details_get_property (SCM details, const char*);
  79   static void alter_spring_from_spacing_spec (SCM spec, Spring* spring);
  80   static void mark_as_spaceable (Grob*);
  81
  82   vector<Spring> springs_;
  83   vector<Element> elements_;
  84   vector<Real> solution_;
  85   Skyline bottom_skyline_;
  86   Real page_height_;
  87   Real header_height_;
  88   Real footer_height_;
  89   Real header_padding_;
  90   Real footer_padding_;
  91 };
  92
  93 #endif /* PAGE_LAYOUT_HH */