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);
103 int paper_count = papers_.size ();
104 for (int i = 1; i < paper_count; i ++)
106 SCM fonts = papers_[i]->font_descriptions ();
107 out->output_scheme (scm_list_3 (ly_symbol2scm ("define-fonts"),
108 papers_[i]->self_scm (),
110 ly_quote_scm (ly_list_qsort_uniq_x (fonts))));
114 for (SCM s = pages; s != SCM_EOL; s = ly_cdr (s))
116 Page *p = unsmob_page (ly_car (s));
117 progress_indication ("[" + to_string (p->number_));
118 out->output_page (p, ly_cdr (s) == SCM_EOL);
119 progress_indication ("]");
122 out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
123 progress_indication ("\n");
127 Paper_book::scopes (int i)
129 SCM scopes = SCM_EOL;
131 scopes = scm_cons (headers_[i], scopes);
132 if (global_headers_.size ()
133 && global_headers_[i] && global_headers_[i] != headers_[i])
134 scopes = scm_cons (global_headers_[i], scopes);
139 Paper_book::title (int i)
142 TODO: get from book-paper definition.
144 SCM user_title = ly_scheme_function ("user-title");
145 SCM book_title = ly_scheme_function ("book-title");
146 SCM score_title = ly_scheme_function ("score-title");
147 SCM field = (i == 0 ? ly_symbol2scm ("bookTitle")
148 : ly_symbol2scm ("scoreTitle"));
151 SCM scopes = this->scopes (i);
152 SCM s = ly_modules_lookup (scopes, field);
153 if (s != SCM_UNDEFINED && scm_variable_bound_p (s) == SCM_BOOL_T)
154 title = *unsmob_stencil (scm_call_2 (user_title,
155 papers_[0]->self_scm (),
156 scm_variable_ref (s)));
158 title = *unsmob_stencil (scm_call_2 (i == 0 ? book_title : score_title,
159 papers_[0]->self_scm (),
161 if (!title.is_empty ())
162 title.align_to (Y_AXIS, UP);
168 Paper_book::classic_output (String outname)
170 int count = scores_.size ();
171 Paper_outputter *out = papers_.top ()->get_paper_outputter (outname);
172 out->output_header (papers_.top (), scopes (count - 1), 0, true);
174 Paper_line *first = unsmob_paper_line (scm_vector_ref (scores_.top (),
176 Offset o (0, -0.5 * first->dim ()[Y_AXIS]);
177 int line_count = SCM_VECTOR_LENGTH ((SCM) scores_.top ());
178 for (int i = 0; i < line_count; i++)
180 /* In classic compatibility TeX tracks how large things are, and
181 advances the Y pos for us. If we advance it too, we get too
184 FIXME: vague... why is TeX is different from other ouput
185 backends, why not fix the TeX backend? -- jcn */
186 if (output_format_global == "tex")
189 out->output_line (scm_vector_ref ((SCM) scores_.top (), scm_int2num (i)),
190 &o, i == line_count - 1);
193 out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
194 progress_indication ("\n");
197 /* calculate book height, #lines, stencils. */
201 int score_count = scores_.size ();
203 /* Calculate the full book height. Hmm, can't we cache system
204 heights while making stencils? */
206 for (int i = 0; i < score_count; i++)
208 Stencil title = this->title (i);
209 if (!title.is_empty ())
210 height_ += title.extent (Y_AXIS).length ();
212 int line_count = SCM_VECTOR_LENGTH ((SCM) scores_[i]);
213 for (int j = 0; j < line_count; j++)
215 SCM s = scm_vector_ref ((SCM) scores_[i], scm_int2num (j));
216 height_ += unsmob_paper_line (s)->dim ()[Y_AXIS];
220 Paper_def *paper = papers_[0];
221 SCM scopes = this->scopes (0);
223 SCM make_tagline = paper->c_variable ("make-tagline");
224 tagline_ = scm_call_2 (make_tagline, paper->self_scm (), scopes);
226 if (Stencil *s = unsmob_stencil (tagline_))
227 tag_height = s->extent (Y_AXIS).length ();
228 height_ += tag_height;
230 SCM make_copyright = paper->c_variable ("make-copyright");
231 copyright_ = scm_call_2 (make_copyright, paper->self_scm (), scopes);
232 Real copy_height = 0;
233 if (Stencil *s = unsmob_stencil (copyright_))
234 copy_height = s->extent (Y_AXIS).length ();
235 height_ += copy_height;
241 int score_count = scores_.size ();
243 for (int i = 0; i < score_count; i++)
245 Stencil title = this->title (i);
246 if (!title.is_empty ())
247 lines = ly_snoc (stencil2line (title, true), lines);
248 lines = scm_append (scm_list_2 (lines, scm_vector_to_list (scores_[i])));
252 for (SCM s = lines; s != SCM_EOL; s = ly_cdr (s))
253 unsmob_paper_line (ly_car (s))->number_ = ++i;
261 Page::page_count_ = 0;
262 Paper_def *paper = papers_[0];
263 Page *page = new Page (paper, 1);
265 Real text_height = page->text_height ();
267 Real copy_height = 0;
268 if (Stencil *s = unsmob_stencil (copyright_))
269 copy_height = s->extent (Y_AXIS).length ();
272 if (Stencil *s = unsmob_stencil (tagline_))
273 tag_height = s->extent (Y_AXIS).length ();
276 SCM proc = paper->c_variable ("page-breaking");
277 SCM breaks = scm_apply_0 (proc, scm_list_n (all, scm_make_real (height_),
278 scm_make_real (text_height),
279 scm_make_real (-copy_height),
280 scm_make_real (-tag_height),
283 /* Copyright on first page. */
284 if (unsmob_stencil (copyright_))
285 page->copyright_ = copyright_;
288 int page_count = SCM_VECTOR_LENGTH ((SCM) breaks);
290 for (int i = 0; i < page_count; i++)
293 page = new Page (paper, i + 1);
295 int next = i + 1 < page_count
296 ? ly_scm2int (scm_vector_ref (breaks, scm_int2num (i))) : 0;
297 while ((!next && all != SCM_EOL) || line <= next)
299 SCM s = ly_car (all);
300 page->lines_ = ly_snoc (s, page->lines_);
301 page->height_ += unsmob_paper_line (s)->dim ()[Y_AXIS];
306 pages = scm_cons (page->self_scm (), pages);
309 /* Tagline on last page. */
310 if (unsmob_stencil (tagline_))
311 page->tagline_ = tagline_;
313 return scm_reverse (pages);
317 c_ragged_page_breaks (SCM lines, Real book_height, Real text_height,
318 Real first, Real last)
321 int page_count = int (book_height / text_height + 0.5);
322 SCM breaks = SCM_EOL;
323 Real page_height = text_height + first;
326 for (SCM s = lines; s != SCM_EOL; s = ly_cdr (s))
328 Paper_line *pl = unsmob_paper_line (ly_car (s));
329 if (!pl->is_title () && h < page_height)
331 h += pl->dim ()[Y_AXIS];
332 if (!pl->is_title () && h > page_height)
334 breaks = ly_snoc (scm_int2num (number), breaks);
336 page_height = text_height + (page_number == page_count) * last;
339 if (ly_cdr (s) == SCM_EOL)
340 breaks = ly_snoc (scm_int2num (pl->number_), breaks);
343 return scm_vector (breaks);
346 LY_DEFINE (ly_ragged_page_breaks, "ly:ragged-page-breaks",
347 5, 0, 0, (SCM lines, SCM book, SCM text, SCM first, SCM last),
348 "Return a vector with line numbers of page breaks.")
350 SCM_ASSERT_TYPE (scm_pair_p (lines), lines, SCM_ARG1, __FUNCTION__, "list");
351 SCM_ASSERT_TYPE (ly_c_number_p (book), book, SCM_ARG2, __FUNCTION__, "real");
352 SCM_ASSERT_TYPE (ly_c_number_p (text), text, SCM_ARG2, __FUNCTION__, "real");
353 SCM_ASSERT_TYPE (ly_c_number_p (first), first, SCM_ARG2, __FUNCTION__, "real");
354 SCM_ASSERT_TYPE (ly_c_number_p (last), last, SCM_ARG2, __FUNCTION__, "real");
356 return c_ragged_page_breaks (lines,
357 ly_scm2double (book), ly_scm2double (text),
358 ly_scm2double (first), ly_scm2double (last));