2 paper-book.cc -- implement Paper_book
4 source file of the GNU LilyPond music typesetter
6 (c) 2004 Jan Nieuwenhuizen <janneke@gnu.org>
9 #include "ly-module.hh"
12 #include "paper-book.hh"
13 #include "paper-def.hh"
14 #include "paper-outputter.hh"
15 #include "paper-line.hh"
16 #include "paper-score.hh"
22 stencil2line (Stencil* stil, bool is_title = false)
26 z = scm_permanent_object (ly_offset2scm (Offset (0, 0)));
27 Offset dim = Offset (stil->extent (X_AXIS).length (),
28 stil->extent (Y_AXIS).length ());
29 Paper_line *pl = new Paper_line (dim, scm_cons (stil->smobbed_copy (),
31 -10001 * is_title, is_title);
33 return scm_gc_unprotect_object (pl->self_scm ());
37 Paper_book::Paper_book ()
45 Paper_book::~Paper_book ()
49 #include "ly-smobs.icc"
51 IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
52 IMPLEMENT_SMOBS (Paper_book)
53 IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?")
56 Paper_book::mark_smob (SCM smob)
58 Paper_book *b = (Paper_book*) SCM_CELL_WORD_1 (smob);
59 for (int i = 0; i < b->headers_.size (); i++)
60 scm_gc_mark (b->headers_[i]);
61 for (int i = 0; i < b->global_headers_.size (); i++)
62 scm_gc_mark (b->global_headers_[i]);
63 for (int i = 0; i < b->papers_.size (); i++)
64 scm_gc_mark (b->papers_[i]->self_scm ());
65 for (int i = 0; i < b->scores_.size (); i++)
66 scm_gc_mark (b->scores_[i]);
68 scm_gc_mark (b->copyright_);
74 Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
76 Paper_book *b = (Paper_book*) ly_cdr (smob);
78 scm_puts ("#<", port);
79 scm_puts (classname (b), port);
81 //scm_puts (b->, port);
87 Paper_book::output (String outname)
90 // FIXME: no end-output?
93 /* Generate all stencils to trigger font loads. */
94 SCM pages = this->pages ();
96 Paper_def *paper = papers_[0];
97 Paper_outputter *out = paper->get_paper_outputter (outname);
98 int page_count = scm_ilength (pages);
99 out->output_header (paper, scopes (0), page_count, false);
101 for (SCM s = pages; s != SCM_EOL; s = ly_cdr (s))
103 Page *p = unsmob_page (ly_car (s));
104 progress_indication ("[" + to_string (p->number_));
105 out->output_page (p, ly_cdr (s) == SCM_EOL);
106 progress_indication ("]");
109 out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
110 progress_indication ("\n");
114 Paper_book::scopes (int i)
116 SCM scopes = SCM_EOL;
118 scopes = scm_cons (headers_[i], scopes);
119 if (global_headers_.size ()
120 && global_headers_[i] && global_headers_[i] != headers_[i])
121 scopes = scm_cons (global_headers_[i], scopes);
126 Paper_book::title (int i)
128 SCM user_title = ly_scheme_function ("user-title");
129 SCM book_title = ly_scheme_function ("book-title");
130 SCM score_title = ly_scheme_function ("score-title");
131 SCM field = (i == 0 ? ly_symbol2scm ("bookTitle")
132 : ly_symbol2scm ("scoreTitle"));
135 SCM scopes = this->scopes (i);
136 SCM s = ly_modules_lookup (scopes, field);
137 if (s != SCM_UNDEFINED && scm_variable_bound_p (s) == SCM_BOOL_T)
138 title = unsmob_stencil (scm_call_2 (user_title,
139 papers_[0]->self_scm (),
140 scm_variable_ref (s)));
142 title = unsmob_stencil (scm_call_2 (i == 0 ? book_title : score_title,
143 papers_[0]->self_scm (),
146 title->align_to (Y_AXIS, UP);
152 Paper_book::classic_output (String outname)
154 int count = scores_.size ();
155 Paper_outputter *out = papers_.top ()->get_paper_outputter (outname);
156 out->output_header (papers_.top (), scopes (count - 1), 0, true);
158 Paper_line *first = unsmob_paper_line (scm_vector_ref (scores_.top (),
160 Offset o (0, -0.5 * first->dim ()[Y_AXIS]);
161 int line_count = SCM_VECTOR_LENGTH ((SCM) scores_.top ());
162 for (int i = 0; i < line_count; i++)
164 /* In classic compatibility TeX tracks how large things are, and
165 advances the Y pos for us. If we advance it too, we get too
168 FIXME: vague... why is TeX is different from other ouput
169 backends, why not fix the TeX backend? -- jcn */
170 if (output_format_global == "tex")
173 out->output_line (scm_vector_ref ((SCM) scores_.top (), scm_int2num (i)),
174 &o, i == line_count - 1);
177 out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
178 progress_indication ("\n");
181 /* calculate book height, #lines, stencils. */
185 int score_count = scores_.size ();
187 /* Calculate the full book height. Hmm, can't we cache system
188 heights while making stencils? */
190 for (int i = 0; i < score_count; i++)
192 Stencil *title = this->title (i);
194 height_ += title->extent (Y_AXIS).length ();
196 int line_count = SCM_VECTOR_LENGTH ((SCM) scores_[i]);
197 for (int j = 0; j < line_count; j++)
199 SCM s = scm_vector_ref ((SCM) scores_[i], scm_int2num (j));
200 height_ += unsmob_paper_line (s)->dim ()[Y_AXIS];
204 Paper_def *paper = papers_[0];
205 SCM scopes = this->scopes (0);
207 SCM make_tagline = ly_scheme_function ("make-tagline");
208 tagline_ = scm_call_2 (make_tagline, paper->self_scm (), scopes);
210 if (Stencil *s = unsmob_stencil (tagline_))
211 tag_height = s->extent (Y_AXIS).length ();
212 height_ += tag_height;
214 SCM make_copyright = ly_scheme_function ("make-copyright");
215 copyright_ = scm_call_2 (make_copyright, paper->self_scm (), scopes);
216 Real copy_height = 0;
217 if (Stencil *s = unsmob_stencil (copyright_))
218 copy_height = s->extent (Y_AXIS).length ();
219 height_ += copy_height;
225 int score_count = scores_.size ();
227 for (int i = 0; i < score_count; i++)
229 if (Stencil *title = this->title (i))
230 lines = ly_snoc (stencil2line (title, true), lines);
231 lines = scm_append (scm_list_2 (lines, scm_vector_to_list (scores_[i])));
235 for (SCM s = lines; s != SCM_EOL; s = ly_cdr (s))
236 unsmob_paper_line (ly_car (s))->number_ = ++i;
244 Page::page_count_ = 0;
245 Paper_def *paper = papers_[0];
246 Page *page = new Page (paper, 1);
248 Real text_height = page->text_height ();
250 Real copy_height = 0;
251 if (Stencil *s = unsmob_stencil (copyright_))
252 copy_height = s->extent (Y_AXIS).length ();
255 if (Stencil *s = unsmob_stencil (tagline_))
256 tag_height = s->extent (Y_AXIS).length ();
259 SCM proc = paper->get_scmvar ("page-breaking");
260 SCM breaks = scm_apply_0 (proc, scm_list_n (all, scm_make_real (height_),
261 scm_make_real (text_height),
262 scm_make_real (-copy_height),
263 scm_make_real (-tag_height),
266 /* Copyright on first page. */
267 if (unsmob_stencil (copyright_))
268 page->copyright_ = copyright_;
271 int page_count = SCM_VECTOR_LENGTH ((SCM) breaks);
273 for (int i = 0; i < page_count; i++)
276 page = new Page (paper, i+1);
277 int next = i + 1 < page_count
278 ? ly_scm2int (scm_vector_ref (breaks, scm_int2num (i))) : 0;
279 while ((!next && all != SCM_EOL) || line <= next)
281 SCM s = ly_car (all);
282 page->lines_ = ly_snoc (s, page->lines_);
283 page->height_ += unsmob_paper_line (s)->dim ()[Y_AXIS];
288 pages = scm_cons (page->self_scm (), pages);
291 /* Tagline on last page. */
292 if (unsmob_stencil (tagline_))
293 page->tagline_ = tagline_;
295 return scm_reverse (pages);
299 c_ragged_page_breaks (SCM lines, Real book_height, Real text_height,
300 Real first, Real last)
303 int page_count = int (book_height / text_height + 0.5);
304 SCM breaks = SCM_EOL;
305 Real page_height = text_height + first;
308 for (SCM s = lines; s != SCM_EOL; s = ly_cdr (s))
310 Paper_line *pl = unsmob_paper_line (ly_car (s));
311 if (!pl->is_title () && h < page_height)
313 h += pl->dim ()[Y_AXIS];
314 if (!pl->is_title () && h > page_height)
316 breaks = ly_snoc (scm_int2num (number), breaks);
318 page_height = text_height + (page_number == page_count) * last;
321 if (ly_cdr (s) == SCM_EOL)
322 breaks = ly_snoc (scm_int2num (pl->number_), breaks);
325 return scm_vector (breaks);
328 LY_DEFINE (ly_ragged_page_breaks, "ly:ragged-page-breaks",
329 5, 0, 0, (SCM lines, SCM book, SCM text, SCM first, SCM last),
330 "Return a vector with line numbers of page breaks.")
332 SCM_ASSERT_TYPE (scm_pair_p (lines), lines, SCM_ARG1, __FUNCTION__, "list");
333 SCM_ASSERT_TYPE (ly_c_number_p (book), book, SCM_ARG2, __FUNCTION__, "real");
334 SCM_ASSERT_TYPE (ly_c_number_p (text), text, SCM_ARG2, __FUNCTION__, "real");
335 SCM_ASSERT_TYPE (ly_c_number_p (first), first, SCM_ARG2, __FUNCTION__, "real");
336 SCM_ASSERT_TYPE (ly_c_number_p (last), last, SCM_ARG2, __FUNCTION__, "real");
338 return c_ragged_page_breaks (lines,
339 ly_scm2double (book), ly_scm2double (text),
340 ly_scm2double (first), ly_scm2double (last));