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"
22 Ugh. the Function of the Paper_book class is unclear. Trim this
28 Paper_book::Paper_book ()
40 Paper_book::~Paper_book ()
44 #include "ly-smobs.icc"
46 IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
47 IMPLEMENT_SMOBS (Paper_book)
48 IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?")
51 Paper_book::mark_smob (SCM smob)
53 Paper_book *b = (Paper_book*) SCM_CELL_WORD_1 (smob);
54 for (int i = 0; i < b->score_lines_.size (); i++)
55 b->score_lines_[i].gc_mark ();
57 scm_gc_mark (b->copyright_);
59 scm_gc_mark (b->bookpaper_->self_scm ());
60 scm_gc_mark (b->header_);
61 scm_gc_mark (b->pages_);
62 scm_gc_mark (b->lines_);
67 Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
69 Paper_book *b = (Paper_book*) ly_cdr (smob);
71 scm_puts ("#<", port);
72 scm_puts (classname (b), port);
74 //scm_puts (b->, port);
80 split_string (String s, char c)
89 s = s.nomid_string (0, 1);
96 rv.push (s.cut_string (0, i));
97 s = s.nomid_string (0, i);
106 SCM fields = SCM_EOL;
107 for (int i = dump_header_fieldnames_global.size (); i--; )
109 = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].to_str0 ()),
114 LY_DEFINE (ly_output_formats, "ly:output-formats",
116 "Formats passed to --format as a list of strings, "
117 "used for the output.")
119 Array<String> output_formats = split_string (output_format_global, ',');
122 for (int i = 0; i < output_formats.size (); i ++)
123 lst = scm_cons (scm_makfrom0str (output_formats[i].to_str0 ()), lst);
129 TODO: there is too much code dup, and the interface is not
133 Paper_book::output (String outname)
135 if (!score_lines_.size ())
139 /* Generate all stencils to trigger font loads. */
143 SCM formats = ly_output_formats();
144 for (SCM s = formats; ly_c_pair_p (s); s = ly_cdr (s))
146 String format = ly_scm2string (ly_car (s));
148 Paper_outputter *out = get_paper_outputter (outname + "." + format, format);
150 SCM scopes = SCM_EOL;
151 if (ly_c_module_p (header_))
152 scopes = scm_cons (header_, scopes);
154 String func_nm = format;
155 func_nm = "output-framework-" + func_nm;
157 SCM func = ly_scheme_function (func_nm.to_str0 ());
158 scm_apply_0 (func, scm_list_n (out->self_scm (),
162 scm_makfrom0str (outname.to_str0 ()),
166 scm_gc_unprotect_object (out->self_scm ());
172 Paper_book::classic_output (String outname)
175 /* Generate all stencils to trigger font loads. */
180 SCM scopes = SCM_EOL;
181 if (ly_c_module_p (header_))
182 scopes = scm_cons (header_, scopes);
184 if (ly_c_module_p (score_lines_[0].header_))
185 scopes = scm_cons (score_lines_[0].header_, scopes);
189 Array<String> output_formats = split_string (output_format_global, ',');
191 for (int i = 0; i < output_formats.size (); i++)
193 String format = output_formats[i];
194 String func_nm = format;
195 func_nm = "output-classic-framework-" + func_nm;
197 SCM func = ly_scheme_function (func_nm.to_str0 ());
199 Paper_outputter *out = get_paper_outputter (outname + "." + format, format);
201 scm_apply_0 (func, scm_list_n (out->self_scm (),
205 scm_makfrom0str (outname.to_str0 ()),
209 scm_gc_unprotect_object (out->self_scm ());
212 progress_indication ("\n");
218 LY_DEFINE(ly_paper_book_pages, "ly:paper-book-pages",
221 "Return pages in book PB.")
223 return unsmob_paper_book(pb)->pages ();
227 LY_DEFINE(ly_paper_book_lines, "ly:paper-book-lines",
230 "Return lines in book PB.")
232 return unsmob_paper_book (pb)->lines ();
236 LY_DEFINE(ly_paper_book_book_paper, "ly:paper-book-book-paper",
239 "Return pages in book PB.")
241 return unsmob_paper_book(pb)->bookpaper_->self_scm ();
246 TODO: resurrect more complex user-tweaks for titling .
250 Paper_book::book_title ()
252 SCM title_func = bookpaper_->lookup_variable (ly_symbol2scm ("book-title"));
255 SCM scopes = SCM_EOL;
256 if (ly_c_module_p (header_))
257 scopes = scm_cons (header_, scopes);
261 if (ly_c_procedure_p (title_func))
262 tit = scm_call_2 (title_func,
263 bookpaper_->self_scm (),
266 if (unsmob_stencil (tit))
267 title = *unsmob_stencil (tit);
269 if (!title.is_empty ())
270 title.align_to (Y_AXIS, UP);
278 Paper_book::score_title (int i)
280 SCM title_func = bookpaper_->lookup_variable (ly_symbol2scm ("score-title"));
285 SCM scopes = SCM_EOL;
286 if (ly_c_module_p (header_))
287 scopes = scm_cons (header_, scopes);
289 if (ly_c_module_p (score_lines_[i].header_))
290 scopes = scm_cons (score_lines_[i].header_, scopes);
294 if (ly_c_procedure_p (title_func))
295 tit =scm_call_2 (title_func,
296 bookpaper_->self_scm (),
299 if (unsmob_stencil (tit))
300 title = *unsmob_stencil (tit);
303 if (!title.is_empty ())
304 title.align_to (Y_AXIS, UP);
313 if (SCM_BOOL_F != lines_)
317 Stencil title = book_title ();
319 if (!title.is_empty ())
321 Paper_line *pl = new Paper_line (title, true);
323 lines_ = scm_cons (pl->self_scm (), lines_);
324 scm_gc_unprotect_object (pl->self_scm ());
327 int score_count = score_lines_.size ();
328 for (int i = 0; i < score_count; i++)
330 Stencil title = score_title (i);
331 if (!title.is_empty ())
333 Paper_line *pl = new Paper_line (title, true);
334 lines_ = scm_cons (pl->self_scm (), lines_);
335 scm_gc_unprotect_object (pl->self_scm ());
338 if (scm_vector_p (score_lines_[i].lines_) == SCM_BOOL_T)
340 SCM line_list = scm_vector_to_list (score_lines_[i].lines_); // guh.
342 line_list = scm_reverse (line_list);
343 lines_ = scm_append (scm_list_2 (line_list, lines_));
347 lines_ = scm_reverse (lines_);
350 Paper_line * last = 0;
351 for (SCM s = lines_; s != SCM_EOL; s = ly_cdr (s))
353 Paper_line * p = unsmob_paper_line (ly_car (s));
356 if (last && last->is_title ())
358 p->penalty_ = 10000; // ugh, hardcoded.
369 make_tagline (Output_def*paper, SCM scopes)
371 SCM make_tagline = paper->c_variable ("make-tagline");
372 SCM tagline = scm_call_2 (make_tagline, paper->self_scm (), scopes);
377 make_copyright (Output_def *paper, SCM scopes)
379 SCM make_copyright = paper->c_variable ("make-copyright");
380 SCM copyright = scm_call_2 (make_copyright, paper->self_scm (), scopes);
387 if (SCM_BOOL_F != pages_)
392 Output_def *paper = bookpaper_;
395 // dummy to extract dims
396 Page *page = new Page (SCM_EOL, paper, 1); // ugh
397 Real text_height = page->text_height ();
399 Real copy_height = 0;
400 if (Stencil *s = unsmob_stencil (copyright_))
401 copy_height = s->extent (Y_AXIS).length ();
404 if (Stencil *s = unsmob_stencil (tagline_))
405 tag_height = s->extent (Y_AXIS).length ();
407 scm_gc_unprotect_object (page->self_scm ());
410 UGH - move this out of C++.
412 SCM scopes = SCM_EOL;
413 if (ly_c_module_p (header_))
414 scopes = scm_cons (header_, scopes);
416 tagline_ = make_tagline (bookpaper_, scopes);
417 copyright_ = make_tagline (bookpaper_, scopes);
421 SCM proc = paper->c_variable ("page-breaking");
422 SCM pages = scm_apply_0 (proc, scm_list_n (all,
424 scm_make_real (text_height),
425 scm_make_real (-copy_height),
426 scm_make_real (-tag_height),
430 SCM *page_tail = &pages_;
432 for (SCM s = pages; ly_c_pair_p (s); s = ly_cdr (s))
434 Page * page = new Page (ly_car (s), paper, ++num);
436 *page_tail = scm_cons (page->self_scm () , SCM_EOL);
437 page_tail = SCM_CDRLOC(*page_tail);
439 scm_gc_unprotect_object (page->self_scm ());
441 if (!ly_c_pair_p (ly_cdr (s)))
442 page->is_last_ = true;
451 c_ragged_page_breaks (SCM lines,
454 Real first, Real last)
458 Real book_height =0.;
459 for (SCM s = lines ; ly_c_pair_p (s); s = ly_cdr (s))
461 book_height += unsmob_paper_line (ly_car (s))->dim ()[Y_AXIS];
465 UGH. following stuff should go out of C++.
467 SCM scopes = SCM_EOL;
468 if (ly_c_module_p (book->header_))
469 scopes = scm_cons (book->header_, scopes);
472 SCM tag = make_tagline (book->bookpaper_, scopes);
473 if (unsmob_stencil (tag))
475 book_height += unsmob_stencil (tag)->extent (Y_AXIS).length ();
478 SCM cr = make_copyright (book->bookpaper_, scopes);
479 if (unsmob_stencil (cr))
481 book_height += unsmob_stencil (cr)->extent (Y_AXIS).length ();
484 int page_count = int (book_height / text_height + 0.5); // ceil?
485 SCM breaks = SCM_EOL;
486 Real page_height = text_height + first;
489 for (SCM s = lines; ly_c_pair_p (s); s = ly_cdr (s))
491 Paper_line *pl = unsmob_paper_line (ly_car (s));
492 if (!pl->is_title () && h < page_height)
494 h += pl->dim ()[Y_AXIS];
495 if (!pl->is_title () && h > page_height)
497 breaks = ly_snoc (scm_int2num (number), breaks);
499 page_height = text_height + (page_number == page_count) * last;
502 if (ly_cdr (s) == SCM_EOL)
503 breaks = ly_snoc (scm_int2num (pl->number_), breaks);
506 return scm_vector (breaks);
509 LY_DEFINE (ly_ragged_page_breaks, "ly:ragged-page-breaks",
510 5, 0, 0, (SCM lines, SCM book, SCM text, SCM first, SCM last),
511 "Return a vector with line numbers of page breaks.")
513 Paper_book* b = unsmob_paper_book (book);
515 SCM_ASSERT_TYPE (scm_pair_p (lines), lines, SCM_ARG1, __FUNCTION__, "list");
516 SCM_ASSERT_TYPE (b, book, SCM_ARG2, __FUNCTION__, "Paper_book");
517 SCM_ASSERT_TYPE (ly_c_number_p (text), text, SCM_ARG3, __FUNCTION__, "number");
518 SCM_ASSERT_TYPE (ly_c_number_p (first), first, SCM_ARG4, __FUNCTION__, "number");
519 SCM_ASSERT_TYPE (ly_c_number_p (last), last, SCM_ARG5, __FUNCTION__, "number");
521 return c_ragged_page_breaks (lines, b,
522 ly_scm2double (text),
523 ly_scm2double (first), ly_scm2double (last));
526 /****************************************************************/
528 Score_lines::Score_lines ()
535 Score_lines::gc_mark ()
537 scm_gc_mark (lines_);
538 scm_gc_mark (header_);