2 page.cc -- implement Page
4 source file of the GNU LilyPond music typesetter
6 (c) 2004 Jan Nieuwenhuizen <janneke@gnu.org>
9 #include "dimensions.hh"
10 #include "ly-module.hh"
12 #include "output-def.hh"
13 #include "paper-outputter.hh"
14 #include "paper-line.hh"
19 Real Page::MIN_COVERAGE_ = 0.66;
21 Page::Page (Output_def *paper, int number)
35 header_ = scm_call_2 (paper_->c_variable ("make-header"),
37 scm_int2num (number_));
38 if (unsmob_stencil (header_))
39 unsmob_stencil (header_)->align_to (Y_AXIS, UP);
41 footer_ = scm_call_2 (paper_->c_variable ("make-footer"),
43 scm_int2num (number_));
44 if (unsmob_stencil (footer_))
45 unsmob_stencil (footer_)->align_to (Y_AXIS, UP);
54 #include "ly-smobs.icc"
56 IMPLEMENT_DEFAULT_EQUAL_P (Page)
57 IMPLEMENT_SMOBS (Page)
58 IMPLEMENT_TYPE_P (Page, "ly:page?")
61 Page::mark_smob (SCM smob)
63 Page *p = (Page*) SCM_CELL_WORD_1 (smob);
64 scm_gc_mark (p->header_);
65 scm_gc_mark (p->footer_);
69 scm_gc_mark (p->paper_->self_scm ());
72 scm_gc_mark (p->copyright_);
73 scm_gc_mark (p->tagline_);
74 //scm_gc_mark (p->lines_);
79 Page::print_smob (SCM smob, SCM port, scm_print_state*)
81 Page *p = (Page*) ly_cdr (smob);
82 scm_puts ("#<", port);
83 scm_puts (classname (p), port);
84 scm_puts (to_string (p->number_).to_str0 (), port);
91 stack_stencils (Stencil a, Stencil b, Offset *origin)
93 Real height = b.extent (Y_AXIS).length ();
96 programming_error (to_string ("Improbable stencil height: %f", height));
103 (*origin)[Y_AXIS] += height;
108 Page::to_stencil () const
110 SCM proc = paper_->lookup_variable (ly_symbol2scm ("page-to-stencil"));
111 return *unsmob_stencil (scm_call_1 (proc, self_scm ()));
116 Page::left_margin () const
118 return (paper_->get_dimension (ly_symbol2scm ("hsize"))
119 - paper_->get_dimension (ly_symbol2scm ("linewidth"))) / 2;
122 LY_DEFINE (ly_page_header_lines_footer_stencil, "ly:page-header-lines-footer-stencil",
124 "Simple header, lines, footer stencil from PAGE.")
126 Page *p = unsmob_page (page);
127 SCM_ASSERT_TYPE (p, page, SCM_ARG1, __FUNCTION__, "page");
130 Offset o (p->left_margin (),
131 p->paper_->get_dimension (ly_symbol2scm ("top-margin")));
133 Real vfill = (p->line_count_ > 1
134 ? (p->text_height () - p->height_) / (p->line_count_ - 1)
137 Real coverage = p->height_ / p->text_height ();
138 if (coverage < p->MIN_COVERAGE_)
139 /* Do not space out a badly filled page. This is too simplistic
140 (ie broken), because this should not vary too much between
141 (subsequent?) pages in a book. */
144 if (Stencil *s = unsmob_stencil (p->header_))
146 stencil = stack_stencils (stencil, *s, &o);
147 o[Y_AXIS] += p->paper_->get_dimension (ly_symbol2scm ("head-sep"));
150 for (SCM s = p->lines_; s != SCM_EOL; s = ly_cdr (s))
152 Paper_line *p = unsmob_paper_line (ly_car (s));
153 stencil = stack_stencils (stencil, p->to_stencil (), &o);
154 /* Do not put vfill between title and its music, */
155 if (ly_cdr (s) != SCM_EOL
156 && (!p->is_title () || vfill < 0))
158 /* rather put extra just before the title. */
159 if (ly_cdr (s) != SCM_EOL
160 && (unsmob_paper_line (ly_cadr (s))->is_title () && vfill > 0))
164 o[Y_AXIS] = p->paper_->get_dimension (ly_symbol2scm ("vsize"))
165 - p->paper_->get_dimension (ly_symbol2scm ("bottom-margin"));
166 if (unsmob_stencil (p->copyright_))
167 o[Y_AXIS] -= unsmob_stencil (p->copyright_)->extent (Y_AXIS).length ();
168 if (unsmob_stencil (p->tagline_))
169 o[Y_AXIS] -= unsmob_stencil (p->tagline_)->extent (Y_AXIS).length ();
170 if (unsmob_stencil (p->footer_))
171 o[Y_AXIS] -= unsmob_stencil (p->footer_)->extent (Y_AXIS).length ();
173 if (Stencil *s = unsmob_stencil (p->copyright_))
174 stencil = stack_stencils (stencil, *s, &o);
175 if (Stencil *s = unsmob_stencil (p->tagline_))
176 stencil = stack_stencils (stencil, *s, &o);
177 if (Stencil *s = unsmob_stencil (p->footer_))
178 stencil = stack_stencils (stencil, *s, &o);
180 return stencil.smobbed_copy ();
184 Page::text_height () const
186 Real h = paper_->get_dimension (ly_symbol2scm ("vsize"))
187 - paper_->get_dimension (ly_symbol2scm ("top-margin"))
188 - paper_->get_dimension (ly_symbol2scm ("bottom-margin"));
189 if (unsmob_stencil (header_))
190 h -= unsmob_stencil (header_)->extent (Y_AXIS).length ()
191 + paper_->get_dimension (ly_symbol2scm ("head-sep"));
192 if (unsmob_stencil (copyright_)
193 || unsmob_stencil (tagline_)
194 || unsmob_stencil (footer_))
195 h -= paper_->get_dimension (ly_symbol2scm ("foot-sep"));
196 if (unsmob_stencil (copyright_))
197 h -= unsmob_stencil (copyright_)->extent (Y_AXIS).length ();
198 if (unsmob_stencil (tagline_))
199 h -= unsmob_stencil (tagline_)->extent (Y_AXIS).length ();
200 if (unsmob_stencil (footer_))
201 h -= unsmob_stencil (footer_)->extent (Y_AXIS).length ();
205 LY_DEFINE (ly_page_paper_lines, "ly:page-paper-lines",
207 "Return paper-lines from @var{page}.")
209 Page *p = unsmob_page (page);
210 SCM_ASSERT_TYPE (p, page, SCM_ARG1, __FUNCTION__, "page");
214 LY_DEFINE (ly_page_stencil, "ly:page-stencil",
216 "Return stencil for @var{page}.")
218 Page *p = unsmob_page (page);
219 SCM_ASSERT_TYPE (p, page, SCM_ARG1, __FUNCTION__, "page");
220 return p->to_stencil ().smobbed_copy ();
224 LY_DEFINE (ly_page_last_p, "ly:page-last?",
226 "Is @var{page} the last one?")
228 Page *p = unsmob_page (page);
229 SCM_ASSERT_TYPE (p, page, SCM_ARG1, __FUNCTION__, "page");
230 return ly_bool2scm (p->is_last_);