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 vsize get_footnote_count (SCM lines);
  38   static SCM get_footnotes_from_lines (SCM lines);
  39   static void add_footnotes_to_lines (SCM lines, int counter, Paper_book *pb);
  40   static Stencil *get_footnote_separator_stencil (Output_def *paper);
  41   static SCM get_spacing_spec (Grob *before, Grob *after, bool pure, int start, int end);
  42   static Real get_fixed_spacing (Grob *before, Grob *after, int spaceable_index, bool pure, int start, int end);
  43   static void add_footnotes_to_footer (SCM footnotes, Stencil *foot, Paper_book *pb);
  44
  45 protected:
  46   void append_system (System *, Spring const &, Real indent, Real padding);
  47   void append_prob (Prob *, Spring const &, Real padding);
  48
  49   void solve_rod_spring_problem (bool ragged);
  50   SCM find_system_offsets ();
  51   void distribute_loose_lines (vector<Grob *> const &, vector<Real> const &, Real, Real);
  52
  53   static void build_system_skyline (vector<Grob *> const &, vector<Real> const &, Skyline *up, Skyline *down);
  54   static vector<Grob *> filter_dead_elements (vector<Grob *> const &);
  55
  56   // This is a union (in spirit).
  57   // Either staves must be empty or prob must be null.
  58   typedef struct Element
  59   {
  60     Prob *prob;
  61     vector<Grob *> staves;
  62     vector<Real> min_offsets;
  63     // Store the appropriate '*-*-spacing 'padding,
  64     //  for spacing any adjacent loose line
  65     Real padding;
  66
  67     Element (vector<Grob *> const &a, vector<Real> const &o, Real p)
  68     {
  69       staves = a;
  70       min_offsets = o;
  71       padding = p;
  72       prob = 0;
  73     }
  74
  75     Element (Prob *p, Real pad)
  76     {
  77       prob = p;
  78       padding = pad;
  79     }
  80   } Element;
  81
  82   static Interval first_staff_extent (Element const &);
  83   static Interval last_staff_extent (Element const &);
  84   static Interval prob_extent (Prob *);
  85   static SCM get_details (Element const &);
  86   static SCM details_get_property (SCM details, const char *);
  87   static void alter_spring_from_spacing_spec (SCM spec, Spring *spring);
  88   static void mark_as_spaceable (Grob *);
  89
  90   vector<Spring> springs_;
  91   vector<Element> elements_;
  92   vector<Real> solution_;
  93   Skyline bottom_skyline_;
  94   Real page_height_;
  95   Real header_height_;
  96   Real footer_height_;
  97   Real header_padding_;
  98   Real footer_padding_;
  99   Real in_note_padding_;
 100   Direction in_note_direction_;
 101 };
 102
 103 #endif /* PAGE_LAYOUT_HH */