2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2009--2011 Joe Neeman <joeneeman@gmail.com>
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.
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.
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/>.
20 #ifndef PAGE_LAYOUT_HH
21 #define PAGE_LAYOUT_HH
23 #include "simple-spacer.hh"
26 class Page_layout_problem
29 Page_layout_problem (Paper_book *, SCM page, SCM systems);
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 vector<Grob *> get_footnote_grobs (SCM lines);
38 static vsize get_footnote_count (SCM lines);
39 static SCM get_footnotes_from_lines (SCM lines);
40 static void add_footnotes_to_lines (SCM lines, int counter, Paper_book *pb);
41 static Stencil *get_footnote_separator_stencil (Output_def *paper);
42 static SCM get_spacing_spec (Grob *before, Grob *after, bool pure, int start, int end);
43 static Real get_fixed_spacing (Grob *before, Grob *after, int spaceable_index, bool pure, int start, int end);
44 static void add_footnotes_to_footer (SCM footnotes, Stencil *foot, Paper_book *pb);
47 void append_system (System *, Spring const &, Real indent, Real padding);
48 void append_prob (Prob *, Spring const &, Real padding);
50 void solve_rod_spring_problem (bool ragged);
51 SCM find_system_offsets ();
52 void distribute_loose_lines (vector<Grob *> const &, vector<Real> const &, Real, Real);
54 static void build_system_skyline (vector<Grob *> const &, vector<Real> const &, Skyline *up, Skyline *down);
55 static vector<Grob *> filter_dead_elements (vector<Grob *> const &);
57 // This is a union (in spirit).
58 // Either staves must be empty or prob must be null.
59 typedef struct Element
62 vector<Grob *> staves;
63 vector<Real> min_offsets;
64 // Store the appropriate '*-*-spacing 'padding,
65 // for spacing any adjacent loose line
68 Element (vector<Grob *> const &a, vector<Real> const &o, Real p)
76 Element (Prob *p, Real pad)
83 static Interval first_staff_extent (Element const &);
84 static Interval last_staff_extent (Element const &);
85 static Interval prob_extent (Prob *);
86 static SCM get_details (Element const &);
87 static SCM details_get_property (SCM details, const char *);
88 static void alter_spring_from_spacing_spec (SCM spec, Spring *spring);
89 static void mark_as_spaceable (Grob *);
91 vector<Spring> springs_;
92 vector<Element> elements_;
93 vector<Real> solution_;
94 Skyline bottom_skyline_;
100 Real in_note_padding_;
101 Direction in_note_direction_;
104 #endif /* PAGE_LAYOUT_HH */