2 paper-book.cc -- implement Paper_book
4 source file of the GNU LilyPond music typesetter
6 (c) 2004--2009 Jan Nieuwenhuizen <janneke@gnu.org>
9 #include "paper-book.hh"
12 #include "international.hh"
14 #include "output-def.hh"
15 #include "paper-column.hh"
16 #include "paper-score.hh"
17 #include "paper-system.hh"
18 #include "text-interface.hh"
20 #include "program-option.hh"
21 #include "page-marker.hh"
23 #include "ly-smobs.icc"
25 Paper_book::Paper_book ()
32 performances_ = SCM_EOL;
33 systems_ = SCM_BOOL_F;
40 Paper_book::~Paper_book ()
44 IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
45 IMPLEMENT_SMOBS (Paper_book);
46 IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?");
49 Paper_book::mark_smob (SCM smob)
51 Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
53 scm_gc_mark (b->paper_->self_scm ());
55 scm_gc_mark (b->parent_->self_scm ());
56 scm_gc_mark (b->header_);
57 scm_gc_mark (b->header_0_);
58 scm_gc_mark (b->pages_);
59 scm_gc_mark (b->performances_);
60 scm_gc_mark (b->scores_);
61 scm_gc_mark (b->bookparts_);
66 Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
68 Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
70 scm_puts ("#<Paper_book>", port);
75 Paper_book::top_paper ()
77 Output_def *paper = paper_;
78 while (paper->parent_)
79 paper = paper->parent_;
87 for (vsize i = dump_header_fieldnames_global.size (); i--;)
89 = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].c_str ()),
95 Paper_book::add_score (SCM s)
97 scores_ = scm_cons (s, scores_);
101 Paper_book::add_bookpart (SCM p)
103 bookparts_ = scm_cons (p, bookparts_);
107 Paper_book::add_performance (SCM s)
109 performances_ = scm_cons (s, performances_);
113 Paper_book::output_aux (SCM output_channel,
115 int *first_page_number,
116 int *first_performance_number)
119 if (scm_is_pair (performances_))
121 SCM proc = ly_lily_module_constant ("write-performances-midis");
126 scm_long2num (*first_performance_number));
127 *first_performance_number += scm_ilength (performances_);
130 if (scm_is_pair (bookparts_))
132 for (SCM p = bookparts_; scm_is_pair (p); p = scm_cdr (p))
133 if (Paper_book *pbookpart = unsmob_paper_book (scm_car (p)))
135 bool is_last_part = (is_last && !scm_is_pair (scm_cdr (p)));
136 page_nb += pbookpart->output_aux (output_channel,
139 first_performance_number);
144 if (scores_ == SCM_EOL)
146 paper_->set_variable (ly_symbol2scm ("first-page-number"),
147 scm_long2num (*first_page_number));
148 paper_->set_variable (ly_symbol2scm ("is-last-bookpart"),
149 ly_bool2scm (is_last));
150 /* Generate all stencils to trigger font loads. */
151 page_nb = scm_ilength (pages ());
152 *first_page_number += page_nb;
158 Paper_book::output (SCM output_channel)
160 int first_page_number = robust_scm2int (paper_->c_variable ("first-page-number"), 1);
161 int first_performance_number = 0;
162 if (!output_aux (output_channel,
165 &first_performance_number))
168 SCM scopes = SCM_EOL;
169 if (ly_is_module (header_))
170 scopes = scm_cons (header_, scopes);
172 string mod_nm = "scm framework-" + get_output_backend_name ();
174 SCM mod = scm_c_resolve_module (mod_nm.c_str ());
176 if (get_program_option ("print-pages"))
178 SCM framework = ly_module_lookup (mod, ly_symbol2scm ("output-framework"));
180 if (framework != SCM_BOOL_F)
182 SCM func = scm_variable_ref (framework);
183 scm_apply_0 (func, scm_list_n (output_channel,
190 warning (_f ("program option -dprint-pages not supported by backend `%s'",
191 get_output_backend_name ()));
194 if (get_program_option ("preview"))
196 SCM framework = ly_module_lookup (mod, ly_symbol2scm ("output-preview-framework"));
198 if (framework != SCM_BOOL_F)
200 SCM func = scm_variable_ref (framework);
201 scm_apply_0 (func, scm_list_n (output_channel,
208 warning (_f ("program option -dpreview not supported by backend `%s'",
209 get_output_backend_name ()));
214 Paper_book::classic_output_aux (SCM output,
215 int *first_performance_number)
217 if (scm_is_pair (performances_))
219 SCM proc = ly_lily_module_constant ("write-performances-midis");
223 scm_long2num (*first_performance_number));
224 *first_performance_number += scm_ilength (performances_);
227 /* Generate all stencils to trigger font loads. */
232 Paper_book::classic_output (SCM output)
234 int first_performance_number = 0;
235 classic_output_aux (output, &first_performance_number);
237 SCM scopes = SCM_EOL;
238 if (ly_is_module (header_))
239 scopes = scm_cons (header_, scopes);
241 if (ly_is_module (header_0_))
242 scopes = scm_cons (header_0_, scopes);
244 string format = get_output_backend_name ();
245 string mod_nm = "scm framework-" + format;
247 SCM mod = scm_c_resolve_module (mod_nm.c_str ());
248 SCM func = scm_c_module_lookup (mod, "output-classic-framework");
250 func = scm_variable_ref (func);
251 scm_apply_0 (func, scm_list_n (output,
257 progress_indication ("\n");
260 /* TODO: resurrect more complex user-tweaks for titling? */
262 Paper_book::book_title ()
264 SCM title_func = paper_->lookup_variable (ly_symbol2scm ("book-title"));
267 SCM scopes = SCM_EOL;
268 if (ly_is_module (header_))
269 scopes = scm_cons (header_, scopes);
272 if (ly_is_procedure (title_func))
273 tit = scm_call_2 (title_func,
277 if (unsmob_stencil (tit))
278 title = *unsmob_stencil (tit);
280 if (!title.is_empty ())
281 title.align_to (Y_AXIS, UP);
287 Paper_book::score_title (SCM header)
289 SCM title_func = paper_->lookup_variable (ly_symbol2scm ("score-title"));
293 SCM scopes = SCM_EOL;
294 if (ly_is_module (header_))
295 scopes = scm_cons (header_, scopes);
297 if (ly_is_module (header))
298 scopes = scm_cons (header, scopes);
301 if (ly_is_procedure (title_func))
302 tit = scm_call_2 (title_func,
306 if (unsmob_stencil (tit))
307 title = *unsmob_stencil (tit);
309 if (!title.is_empty ())
310 title.align_to (Y_AXIS, UP);
316 set_page_permission (SCM sys, SCM symbol, SCM permission)
318 if (Paper_score *ps = dynamic_cast<Paper_score*> (unsmob_music_output (sys)))
320 vector<Grob*> cols = ps->get_columns ();
323 Paper_column *col = dynamic_cast<Paper_column*> (cols.back ());
324 col->set_property (symbol, permission);
325 col->find_prebroken_piece (LEFT)->set_property (symbol, permission);
328 else if (Prob *pb = unsmob_prob (sys))
329 pb->set_property (symbol, permission);
332 /* read the breakbefore property of a score block and set up the preceding
333 system-spec to honour it. That is, SYS should be the system spec that
334 immediately precedes the score (from which HEADER is taken)
335 in the get_system_specs () list */
337 set_system_penalty (SCM sys, SCM header)
339 if (ly_is_module (header))
341 SCM force = ly_module_lookup (header, ly_symbol2scm ("breakbefore"));
342 if (SCM_VARIABLEP (force)
343 && scm_is_bool (SCM_VARIABLE_REF (force)))
345 if (to_boolean (SCM_VARIABLE_REF (force)))
347 set_page_permission (sys, ly_symbol2scm ("page-break-permission"),
348 ly_symbol2scm ("force"));
349 set_page_permission (sys, ly_symbol2scm ("line-break-permission"),
350 ly_symbol2scm ("force"));
353 set_page_permission (sys, ly_symbol2scm ("page-break-permission"), SCM_EOL);
359 set_labels (SCM sys, SCM labels)
361 if (Paper_score *ps = dynamic_cast<Paper_score*> (unsmob_music_output (sys)))
363 vector<Grob*> cols = ps->get_columns ();
366 Paper_column *col = dynamic_cast<Paper_column*> (cols[0]);
367 col->set_property ("labels",
368 scm_append_x (scm_list_2 (col->get_property ("labels"),
370 Paper_column *col_right = dynamic_cast<Paper_column*> (col->find_prebroken_piece (RIGHT));
371 col_right->set_property ("labels",
372 scm_append_x (scm_list_2 (col_right->get_property ("labels"),
376 else if (Prob *pb = unsmob_prob (sys))
377 pb->set_property ("labels",
378 scm_append_x (scm_list_2 (pb->get_property ("labels"),
383 Paper_book::get_score_title (SCM header)
385 Stencil title = score_title (header);
386 if (title.is_empty ())
387 title = score_title (header_);
388 if (!title.is_empty ())
391 TODO: this should come from the \layout {} block, which should
392 override settings from \paper {}
394 SCM props = paper_->lookup_variable (ly_symbol2scm ("score-title-properties"));
395 Prob *ps = make_paper_system (props);
396 paper_system_set_stencil (ps, title);
398 return ps->self_scm ();
406 Paper_book::get_system_specs ()
408 SCM system_specs = SCM_EOL;
410 Stencil title = book_title ();
411 if (!title.is_empty ())
413 SCM props = paper_->lookup_variable (ly_symbol2scm ("book-title-properties"));
414 Prob *ps = make_paper_system (props);
415 paper_system_set_stencil (ps, title);
417 system_specs = scm_cons (ps->self_scm (), system_specs);
422 = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
423 paper_->self_scm ());
425 SCM interpret_markup_list = ly_lily_module_constant ("interpret-markup-list");
426 SCM header = SCM_EOL;
427 SCM labels = SCM_EOL;
428 for (SCM s = scm_reverse (scores_); scm_is_pair (s); s = scm_cdr (s))
430 if (ly_is_module (scm_car (s)))
432 header = scm_car (s);
433 if (header_0_ == SCM_EOL)
436 else if (Page_marker *page_marker = unsmob_page_marker (scm_car (s)))
438 /* page markers are used to set page breaking/turning permission,
439 or to place bookmarking labels */
440 if (scm_is_symbol (page_marker->permission_symbol ()))
442 /* set previous element page break or turn permission */
443 if (scm_is_pair (system_specs))
444 set_page_permission (scm_car (system_specs),
445 page_marker->permission_symbol (),
446 page_marker->permission_value ());
448 if (scm_is_symbol (page_marker->label ()))
450 /* The next element label is to be set */
451 labels = scm_cons (page_marker->label (), labels);
454 else if (Music_output *mop = unsmob_music_output (scm_car (s)))
456 if (Paper_score *pscore = dynamic_cast<Paper_score *> (mop))
458 SCM title = get_score_title (header);
460 if (scm_is_pair (system_specs))
461 set_system_penalty (scm_car (system_specs), header);
463 if (unsmob_prob (title))
465 system_specs = scm_cons (title, system_specs);
466 unsmob_prob (title)->unprotect ();
470 system_specs = scm_cons (pscore->self_scm (), system_specs);
471 if (scm_is_pair (labels))
473 set_labels (scm_car (system_specs), labels);
484 else if (Text_interface::is_markup_list (scm_car (s)))
486 SCM texts = scm_call_3 (interpret_markup_list,
490 for (SCM list = texts ; scm_is_pair (list) ; list = scm_cdr (list))
492 SCM t = scm_car (list);
494 Prob *ps = make_paper_system (SCM_EOL);
495 ps->set_property ("page-break-permission", ly_symbol2scm ("allow"));
496 ps->set_property ("page-turn-permission", ly_symbol2scm ("allow"));
498 paper_system_set_stencil (ps, *unsmob_stencil (t));
499 ps->set_property ("is-title", SCM_BOOL_T);
500 if (scm_is_pair (scm_cdr (list)))
502 /* If an other markup is following, set this markup
503 * next padding and next space to 0, so that baseline-skip
504 * only should be taken into account for lines vertical
506 ps->set_property ("next-padding", scm_double2num (0.0));
507 ps->set_property ("next-space", scm_double2num (0.0));
509 system_specs = scm_cons (ps->self_scm (), system_specs);
512 if (scm_is_pair (labels))
514 set_labels (scm_car (system_specs), labels);
517 // FIXME: figure out penalty.
518 //set_system_penalty (ps, scores_[i].header_);
525 system_specs = scm_reverse_x (system_specs, SCM_EOL);
530 Paper_book::systems ()
532 if (systems_ != SCM_BOOL_F)
536 if (scm_is_pair (bookparts_))
538 for (SCM p = bookparts_; scm_is_pair (p); p = scm_cdr (p))
539 if (Paper_book *pbookpart = unsmob_paper_book (scm_car (p)))
540 systems_ = scm_append_x (scm_list_2 (systems_, pbookpart->systems ()));
544 SCM specs = get_system_specs ();
545 for (SCM s = specs; scm_is_pair (s); s = scm_cdr (s))
547 if (Paper_score *pscore = dynamic_cast<Paper_score*> (unsmob_music_output (scm_car (s))))
549 SCM system_list = scm_vector_to_list (pscore->get_paper_systems ());
550 system_list = scm_reverse (system_list);
551 systems_ = scm_append (scm_list_2 (system_list, systems_));
555 systems_ = scm_cons (scm_car (s), systems_);
558 systems_ = scm_reverse (systems_);
560 /* backwards compatibility for the old page breaker */
563 for (SCM s = systems_; scm_is_pair (s); s = scm_cdr (s))
565 Prob *ps = unsmob_prob (scm_car (s));
566 ps->set_property ("number", scm_from_int (++i));
569 && to_boolean (last->get_property ("is-title"))
570 && !scm_is_number (ps->get_property ("penalty")))
571 ps->set_property ("penalty", scm_from_int (10000));
574 if (scm_is_pair (scm_cdr (s)))
576 SCM perm = ps->get_property ("page-break-permission");
577 Prob *next = unsmob_prob (scm_cadr (s));
579 next->set_property ("penalty", scm_from_int (10001));
580 else if (perm == ly_symbol2scm ("force"))
581 next->set_property ("penalty", scm_from_int (-10001));
592 if (SCM_BOOL_F != pages_)
596 if (scm_is_pair (bookparts_))
598 for (SCM p = bookparts_; scm_is_pair (p); p = scm_cdr (p))
599 if (Paper_book *pbookpart = unsmob_paper_book (scm_car (p)))
600 pages_ = scm_append_x (scm_list_2 (pages_, pbookpart->pages ()));
602 else if (scm_is_pair (scores_))
604 SCM page_breaking = paper_->c_variable ("page-breaking");
605 pages_ = scm_apply_0 (page_breaking, scm_list_1 (self_scm ()));
606 SCM post_process = paper_->c_variable ("page-post-process");
607 if (ly_is_procedure (post_process))
608 scm_apply_2 (post_process, paper_->self_scm (), pages_, SCM_EOL);
610 /* set systems_ from the pages */
611 if (systems_ == SCM_BOOL_F)
614 for (SCM p = pages_; scm_is_pair (p); p = scm_cdr (p))
616 Prob *page = unsmob_prob (scm_car (p));
617 SCM systems = page->get_property ("lines");
618 systems_ = scm_append (scm_list_2 (systems_, systems));
626 Paper_book::performances () const
628 return scm_reverse (performances_);