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 "output-def.hh"
14 #include "paper-outputter.hh"
15 #include "paper-line.hh"
16 #include "paper-score.hh"
23 stencil2line (Stencil stil, bool is_title = false)
27 z = scm_permanent_object (ly_offset2scm (Offset (0, 0)));
28 Offset dim = Offset (stil.extent (X_AXIS).length (),
29 stil.extent (Y_AXIS).length ());
30 Paper_line *pl = new Paper_line (dim, scm_cons (stil.smobbed_copy (),
32 -10001 * is_title, is_title);
34 return scm_gc_unprotect_object (pl->self_scm ());
38 Paper_book::Paper_book ()
48 Paper_book::~Paper_book ()
52 #include "ly-smobs.icc"
54 IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
55 IMPLEMENT_SMOBS (Paper_book)
56 IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?")
59 Paper_book::mark_smob (SCM smob)
61 Paper_book *b = (Paper_book*) SCM_CELL_WORD_1 (smob);
62 for (int i = 0; i < b->score_lines_.size (); i++)
63 b->score_lines_[i].gc_mark ();
65 scm_gc_mark (b->copyright_);
67 scm_gc_mark (b->bookpaper_->self_scm ());
68 scm_gc_mark (b->header_);
73 Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
75 Paper_book *b = (Paper_book*) ly_cdr (smob);
77 scm_puts ("#<", port);
78 scm_puts (classname (b), port);
80 //scm_puts (b->, port);
87 TODO: there is too much code dup, and the interface is not
92 Paper_book::output (String outname)
94 if (!score_lines_.size ())
95 // FIXME: no end-output?
98 /* Generate all stencils to trigger font loads. */
99 SCM pages = this->pages ();
101 Paper_outputter *out = get_paper_outputter (outname);
102 int page_count = scm_ilength (pages);
104 out->output_header (bookpaper_, scm_list_1 (header_), page_count, false);
106 for (SCM s = pages; s != SCM_EOL; s = ly_cdr (s))
108 Page *p = unsmob_page (ly_car (s));
109 progress_indication ("[" + to_string (p->number_));
110 out->output_page (p, ly_cdr (s) == SCM_EOL);
111 progress_indication ("]");
114 out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
115 progress_indication ("\n");
120 Paper_book::title (int i)
122 SCM user_title = bookpaper_->lookup_variable (ly_symbol2scm ("user-title"));
123 SCM book_title = bookpaper_->lookup_variable (ly_symbol2scm ("book-title"));
124 SCM score_title = bookpaper_->lookup_variable (ly_symbol2scm ("score-title"));
125 SCM field = (i == 0 ? ly_symbol2scm ("bookTitle")
126 : ly_symbol2scm ("scoreTitle"));
131 SCM scopes = SCM_EOL;
132 if (ly_c_module_p (header_))
133 scopes = scm_cons (header_, scopes);
135 if (ly_c_module_p (score_lines_[i].header_))
136 scopes = scm_cons (score_lines_[i].header_, scopes);
139 SCM s = ly_modules_lookup (scopes, field, SCM_BOOL_F);
141 title = *unsmob_stencil (scm_call_2 (user_title,
142 bookpaper_->self_scm (),
145 title = *unsmob_stencil (scm_call_2 (i == 0 ? book_title : score_title,
146 bookpaper_->self_scm (),
148 if (!title.is_empty ())
149 title.align_to (Y_AXIS, UP);
155 Paper_book::classic_output (String outname)
157 Paper_outputter *out = get_paper_outputter (outname);
159 Output_def * p = bookpaper_;
160 while (p && p->parent_)
164 SCM scopes = SCM_EOL;
165 if (ly_c_module_p (header_))
166 scopes = scm_cons (header_, scopes);
168 if (ly_c_module_p (score_lines_[0].header_))
169 scopes = scm_cons (score_lines_[0].header_, scopes);
172 out->output_header (p, header_, 0, true);
174 SCM top_lines = score_lines_.top ().lines_;
175 Paper_line *first = unsmob_paper_line (scm_vector_ref (top_lines,
177 Offset o (0, -0.5 * first->dim ()[Y_AXIS]);
178 int line_count = SCM_VECTOR_LENGTH (top_lines);
179 for (int i = 0; i < line_count; i++)
181 /* In classic compatibility TeX tracks how large things are, and
182 advances the Y pos for us. If we advance it too, we get too
185 FIXME: vague... why is TeX is different from other ouput
186 backends, why not fix the TeX backend? -- jcn */
187 if (output_format_global == "tex")
190 out->output_line (scm_vector_ref (top_lines, scm_int2num (i)),
191 &o, i == line_count - 1);
194 out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
195 progress_indication ("\n");
198 /* calculate book height, #lines, stencils. */
202 int score_count = score_lines_.size ();
204 /* Calculate the full book height. Hmm, can't we cache system
205 heights while making stencils? */
207 for (int i = 0; i < score_count; i++)
209 Stencil title = this->title (i);
210 if (!title.is_empty ())
211 height_ += title.extent (Y_AXIS).length ();
213 int line_count = SCM_VECTOR_LENGTH (score_lines_[i].lines_);
214 for (int j = 0; j < line_count; j++)
216 SCM s = scm_vector_ref ((SCM) score_lines_[i].lines_, scm_int2num (j));
217 height_ += unsmob_paper_line (s)->dim ()[Y_AXIS];
221 Output_def *paper = bookpaper_;
223 SCM scopes = SCM_EOL;
224 if (ly_c_module_p (header_))
225 scopes = scm_cons (header_, scopes);
227 SCM make_tagline = paper->c_variable ("make-tagline");
228 tagline_ = scm_call_2 (make_tagline, paper->self_scm (), scopes);
230 if (Stencil *s = unsmob_stencil (tagline_))
231 tag_height = s->extent (Y_AXIS).length ();
232 height_ += tag_height;
234 SCM make_copyright = paper->c_variable ("make-copyright");
235 copyright_ = scm_call_2 (make_copyright, paper->self_scm (), scopes);
236 Real copy_height = 0;
237 if (Stencil *s = unsmob_stencil (copyright_))
238 copy_height = s->extent (Y_AXIS).length ();
239 height_ += copy_height;
245 int score_count = score_lines_.size ();
247 for (int i = 0; i < score_count; i++)
249 Stencil title = this->title (i);
250 if (!title.is_empty ())
251 lines = ly_snoc (stencil2line (title, true), lines);
252 lines = scm_append (scm_list_2 (lines, scm_vector_to_list (score_lines_[i].lines_)));
257 for (SCM s = lines; s != SCM_EOL; s = ly_cdr (s))
258 unsmob_paper_line (ly_car (s))->number_ = ++i;
266 Page::page_count_ = 0;
268 Output_def *paper = bookpaper_;
269 Page *page = new Page (paper, 1);
271 Real text_height = page->text_height ();
273 Real copy_height = 0;
274 if (Stencil *s = unsmob_stencil (copyright_))
275 copy_height = s->extent (Y_AXIS).length ();
278 if (Stencil *s = unsmob_stencil (tagline_))
279 tag_height = s->extent (Y_AXIS).length ();
282 SCM proc = paper->c_variable ("page-breaking");
283 SCM breaks = scm_apply_0 (proc, scm_list_n (all, scm_make_real (height_),
284 scm_make_real (text_height),
285 scm_make_real (-copy_height),
286 scm_make_real (-tag_height),
289 /* Copyright on first page. */
290 if (unsmob_stencil (copyright_))
291 page->copyright_ = copyright_;
294 int page_count = SCM_VECTOR_LENGTH ((SCM) breaks);
296 for (int i = 0; i < page_count; i++)
299 page = new Page (paper, i + 1);
301 int next = i + 1 < page_count
302 ? ly_scm2int (scm_vector_ref (breaks, scm_int2num (i))) : 0;
303 while ((!next && all != SCM_EOL) || line <= next)
305 SCM s = ly_car (all);
306 page->lines_ = ly_snoc (s, page->lines_);
307 page->height_ += unsmob_paper_line (s)->dim ()[Y_AXIS];
312 pages = scm_cons (page->self_scm (), pages);
315 /* Tagline on last page. */
316 if (unsmob_stencil (tagline_))
317 page->tagline_ = tagline_;
319 return scm_reverse (pages);
323 c_ragged_page_breaks (SCM lines, Real book_height, Real text_height,
324 Real first, Real last)
327 int page_count = int (book_height / text_height + 0.5);
328 SCM breaks = SCM_EOL;
329 Real page_height = text_height + first;
332 for (SCM s = lines; s != SCM_EOL; s = ly_cdr (s))
334 Paper_line *pl = unsmob_paper_line (ly_car (s));
335 if (!pl->is_title () && h < page_height)
337 h += pl->dim ()[Y_AXIS];
338 if (!pl->is_title () && h > page_height)
340 breaks = ly_snoc (scm_int2num (number), breaks);
342 page_height = text_height + (page_number == page_count) * last;
345 if (ly_cdr (s) == SCM_EOL)
346 breaks = ly_snoc (scm_int2num (pl->number_), breaks);
349 return scm_vector (breaks);
352 LY_DEFINE (ly_ragged_page_breaks, "ly:ragged-page-breaks",
353 5, 0, 0, (SCM lines, SCM book, SCM text, SCM first, SCM last),
354 "Return a vector with line numbers of page breaks.")
356 SCM_ASSERT_TYPE (scm_pair_p (lines), lines, SCM_ARG1, __FUNCTION__, "list");
357 SCM_ASSERT_TYPE (ly_c_number_p (book), book, SCM_ARG2, __FUNCTION__, "real");
358 SCM_ASSERT_TYPE (ly_c_number_p (text), text, SCM_ARG2, __FUNCTION__, "real");
359 SCM_ASSERT_TYPE (ly_c_number_p (first), first, SCM_ARG2, __FUNCTION__, "real");
360 SCM_ASSERT_TYPE (ly_c_number_p (last), last, SCM_ARG2, __FUNCTION__, "real");
362 return c_ragged_page_breaks (lines,
363 ly_scm2double (book), ly_scm2double (text),
364 ly_scm2double (first), ly_scm2double (last));
367 /****************************************************************/
369 Score_lines::Score_lines ()
376 Score_lines::gc_mark ()
378 scm_gc_mark (lines_);
379 scm_gc_mark (header_);