2 paper-book.cc -- implement Paper_book
4 source file of the GNU LilyPond music typesetter
6 (c) 2004--2007 Jan Nieuwenhuizen <janneke@gnu.org>
9 #include "paper-book.hh"
13 #include "output-def.hh"
14 #include "paper-column.hh"
15 #include "paper-score.hh"
16 #include "paper-system.hh"
17 #include "text-interface.hh"
19 #include "program-option.hh"
20 #include "page-marker.hh"
22 #include "ly-smobs.icc"
24 Paper_book::Paper_book ()
31 performances_ = SCM_EOL;
32 systems_ = SCM_BOOL_F;
39 Paper_book::~Paper_book ()
43 IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
44 IMPLEMENT_SMOBS (Paper_book);
45 IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?");
48 Paper_book::mark_smob (SCM smob)
50 Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
52 scm_gc_mark (b->paper_->self_scm ());
54 scm_gc_mark (b->parent_->self_scm ());
55 scm_gc_mark (b->header_);
56 scm_gc_mark (b->header_0_);
57 scm_gc_mark (b->pages_);
58 scm_gc_mark (b->performances_);
59 scm_gc_mark (b->scores_);
60 scm_gc_mark (b->bookparts_);
65 Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
67 Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
69 scm_puts ("#<Paper_book>", port);
74 Paper_book::top_paper ()
76 Output_def *paper = paper_;
77 while (paper->parent_)
78 paper = paper->parent_;
86 for (vsize i = dump_header_fieldnames_global.size (); i--;)
88 = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].c_str ()),
94 Paper_book::add_score (SCM s)
96 scores_ = scm_cons (s, scores_);
100 Paper_book::add_bookpart (SCM p)
102 bookparts_ = scm_cons (p, bookparts_);
106 Paper_book::add_performance (SCM s)
108 performances_ = scm_cons (s, performances_);
112 Paper_book::output_aux (SCM output_channel,
114 int *first_page_number,
115 int *first_performance_number)
117 if (scm_is_pair (performances_))
119 SCM proc = ly_lily_module_constant ("write-performances-midis");
124 scm_long2num (*first_performance_number));
125 *first_performance_number += scm_ilength (performances_);
128 if (scm_is_pair (bookparts_))
130 for (SCM p = scm_reverse (bookparts_); scm_is_pair (p); p = scm_cdr (p))
131 if (Paper_book *pbookpart = unsmob_paper_book (scm_car (p)))
133 bool is_last_part = (is_last && !scm_is_pair (scm_cdr (p)));
134 pbookpart->output_aux (output_channel,
137 first_performance_number);
142 if (scores_ == SCM_EOL)
144 paper_->set_variable (ly_symbol2scm ("first-page-number"),
145 scm_long2num (*first_page_number));
146 paper_->set_variable (ly_symbol2scm ("is-last-bookpart"),
147 ly_bool2scm (is_last));
148 /* Generate all stencils to trigger font loads. */
149 *first_page_number += scm_ilength (pages ());
154 Paper_book::output (SCM output_channel)
156 int first_page_number = robust_scm2int (paper_->c_variable ("first-page-number"), 1);
157 int first_performance_number = 0;
158 output_aux (output_channel,
161 &first_performance_number);
163 SCM scopes = SCM_EOL;
164 if (ly_is_module (header_))
165 scopes = scm_cons (header_, scopes);
167 string mod_nm = "scm framework-" + get_output_backend_name ();
169 SCM mod = scm_c_resolve_module (mod_nm.c_str ());
171 if (get_program_option ("print-pages"))
173 SCM func = scm_c_module_lookup (mod, "output-framework");
175 func = scm_variable_ref (func);
176 scm_apply_0 (func, scm_list_n (output_channel,
183 if (get_program_option ("preview"))
185 SCM func = scm_c_module_lookup (mod, "output-preview-framework");
186 func = scm_variable_ref (func);
187 scm_apply_0 (func, scm_list_n (output_channel,
196 Paper_book::classic_output_aux (SCM output,
197 int *first_performance_number)
199 if (scm_is_pair (performances_))
201 SCM proc = ly_lily_module_constant ("write-performances-midis");
205 scm_long2num (*first_performance_number));
206 *first_performance_number += scm_ilength (performances_);
209 /* Generate all stencils to trigger font loads. */
214 Paper_book::classic_output (SCM output)
216 int first_performance_number = 0;
217 classic_output_aux (output, &first_performance_number);
219 SCM scopes = SCM_EOL;
220 if (ly_is_module (header_))
221 scopes = scm_cons (header_, scopes);
223 if (ly_is_module (header_0_))
224 scopes = scm_cons (header_0_, scopes);
226 string format = get_output_backend_name ();
227 string mod_nm = "scm framework-" + format;
229 SCM mod = scm_c_resolve_module (mod_nm.c_str ());
230 SCM func = scm_c_module_lookup (mod, "output-classic-framework");
232 func = scm_variable_ref (func);
233 scm_apply_0 (func, scm_list_n (output,
239 progress_indication ("\n");
242 /* TODO: resurrect more complex user-tweaks for titling? */
244 Paper_book::book_title ()
246 SCM title_func = paper_->lookup_variable (ly_symbol2scm ("book-title"));
249 SCM scopes = SCM_EOL;
250 if (ly_is_module (header_))
251 scopes = scm_cons (header_, scopes);
254 if (ly_is_procedure (title_func))
255 tit = scm_call_2 (title_func,
259 if (unsmob_stencil (tit))
260 title = *unsmob_stencil (tit);
262 if (!title.is_empty ())
263 title.align_to (Y_AXIS, UP);
269 Paper_book::score_title (SCM header)
271 SCM title_func = paper_->lookup_variable (ly_symbol2scm ("score-title"));
275 SCM scopes = SCM_EOL;
276 if (ly_is_module (header_))
277 scopes = scm_cons (header_, scopes);
279 if (ly_is_module (header))
280 scopes = scm_cons (header, scopes);
283 if (ly_is_procedure (title_func))
284 tit = scm_call_2 (title_func,
288 if (unsmob_stencil (tit))
289 title = *unsmob_stencil (tit);
291 if (!title.is_empty ())
292 title.align_to (Y_AXIS, UP);
298 set_page_permission (SCM sys, SCM symbol, SCM permission)
300 if (Paper_score *ps = dynamic_cast<Paper_score*> (unsmob_music_output (sys)))
302 vector<Grob*> cols = ps->get_columns ();
305 Paper_column *col = dynamic_cast<Paper_column*> (cols.back ());
306 col->set_property (symbol, permission);
307 col->find_prebroken_piece (LEFT)->set_property (symbol, permission);
310 else if (Prob *pb = unsmob_prob (sys))
311 pb->set_property (symbol, permission);
314 /* read the breakbefore property of a score block and set up the preceding
315 system-spec to honour it. That is, SYS should be the system spec that
316 immediately precedes the score (from which HEADER is taken)
317 in the get_system_specs () list */
319 set_system_penalty (SCM sys, SCM header)
321 if (ly_is_module (header))
323 SCM force = ly_module_lookup (header, ly_symbol2scm ("breakbefore"));
324 if (SCM_VARIABLEP (force)
325 && scm_is_bool (SCM_VARIABLE_REF (force)))
327 if (to_boolean (SCM_VARIABLE_REF (force)))
329 set_page_permission (sys, ly_symbol2scm ("page-break-permission"),
330 ly_symbol2scm ("force"));
331 set_page_permission (sys, ly_symbol2scm ("line-break-permission"),
332 ly_symbol2scm ("force"));
335 set_page_permission (sys, ly_symbol2scm ("page-break-permission"), SCM_EOL);
341 set_labels (SCM sys, SCM labels)
343 if (Paper_score *ps = dynamic_cast<Paper_score*> (unsmob_music_output (sys)))
345 vector<Grob*> cols = ps->get_columns ();
348 Paper_column *col = dynamic_cast<Paper_column*> (cols[0]);
349 col->set_property ("labels",
350 scm_append_x (scm_list_2 (col->get_property ("labels"),
352 Paper_column *col_right = dynamic_cast<Paper_column*> (col->find_prebroken_piece (RIGHT));
353 col_right->set_property ("labels",
354 scm_append_x (scm_list_2 (col_right->get_property ("labels"),
358 else if (Prob *pb = unsmob_prob (sys))
359 pb->set_property ("labels",
360 scm_append_x (scm_list_2 (pb->get_property ("labels"),
365 Paper_book::get_score_title (SCM header)
367 Stencil title = score_title (header);
368 if (title.is_empty ())
369 title = score_title (header_);
370 if (!title.is_empty ())
373 TODO: this should come from the \layout {} block, which should
374 override settings from \paper {}
376 SCM props = paper_->lookup_variable (ly_symbol2scm ("score-title-properties"));
377 Prob *ps = make_paper_system (props);
378 paper_system_set_stencil (ps, title);
380 return ps->self_scm ();
388 Paper_book::get_system_specs ()
390 SCM system_specs = SCM_EOL;
392 Stencil title = book_title ();
393 if (!title.is_empty ())
395 SCM props = paper_->lookup_variable (ly_symbol2scm ("book-title-properties"));
396 Prob *ps = make_paper_system (props);
397 paper_system_set_stencil (ps, title);
399 system_specs = scm_cons (ps->self_scm (), system_specs);
404 = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
405 paper_->self_scm ());
407 SCM interpret_markup_list = ly_lily_module_constant ("interpret-markup-list");
408 SCM header = SCM_EOL;
409 SCM labels = SCM_EOL;
410 for (SCM s = scm_reverse (scores_); scm_is_pair (s); s = scm_cdr (s))
412 if (ly_is_module (scm_car (s)))
414 header = scm_car (s);
415 if (header_0_ == SCM_EOL)
418 else if (Page_marker *page_marker = unsmob_page_marker (scm_car (s)))
420 /* page markers are used to set page breaking/turning permission,
421 or to place bookmarking labels */
422 if (scm_is_symbol (page_marker->permission_symbol ()))
424 /* set previous element page break or turn permission */
425 if (scm_is_pair (system_specs))
426 set_page_permission (scm_car (system_specs),
427 page_marker->permission_symbol (),
428 page_marker->permission_value ());
430 if (scm_is_symbol (page_marker->label ()))
432 /* The next element label is to be set */
433 labels = scm_cons (page_marker->label (), labels);
436 else if (Music_output *mop = unsmob_music_output (scm_car (s)))
438 if (Paper_score *pscore = dynamic_cast<Paper_score *> (mop))
440 SCM title = get_score_title (header);
442 if (scm_is_pair (system_specs))
443 set_system_penalty (scm_car (system_specs), header);
445 if (unsmob_prob (title))
447 system_specs = scm_cons (title, system_specs);
448 unsmob_prob (title)->unprotect ();
452 system_specs = scm_cons (pscore->self_scm (), system_specs);
453 if (scm_is_pair (labels))
455 set_labels (scm_car (system_specs), labels);
466 else if (Text_interface::is_markup_list (scm_car (s)))
468 SCM texts = scm_call_3 (interpret_markup_list,
472 for (SCM list = texts ; scm_is_pair (list) ; list = scm_cdr (list))
474 SCM t = scm_car (list);
476 Prob *ps = make_paper_system (SCM_EOL);
477 ps->set_property ("page-break-permission", ly_symbol2scm ("allow"));
478 ps->set_property ("page-turn-permission", ly_symbol2scm ("allow"));
480 paper_system_set_stencil (ps, *unsmob_stencil (t));
481 ps->set_property ("is-title", SCM_BOOL_T);
482 if (scm_is_pair (scm_cdr (list)))
484 /* If an other markup is following, set this markup
485 * next padding and next space to 0, so that baseline-skip
486 * only should be taken into account for lines vertical
488 ps->set_property ("next-padding", scm_double2num (0.0));
489 ps->set_property ("next-space", scm_double2num (0.0));
491 system_specs = scm_cons (ps->self_scm (), system_specs);
494 if (scm_is_pair (labels))
496 set_labels (scm_car (system_specs), labels);
499 // FIXME: figure out penalty.
500 //set_system_penalty (ps, scores_[i].header_);
507 system_specs = scm_reverse_x (system_specs, SCM_EOL);
512 Paper_book::systems ()
514 if (systems_ != SCM_BOOL_F)
518 if (scm_is_pair (bookparts_))
520 for (SCM p = scm_reverse (bookparts_); scm_is_pair (p); p = scm_cdr (p))
521 if (Paper_book *pbookpart = unsmob_paper_book (scm_car (p)))
522 systems_ = scm_append_x (scm_list_2 (systems_, pbookpart->systems ()));
526 SCM specs = get_system_specs ();
527 for (SCM s = specs; scm_is_pair (s); s = scm_cdr (s))
529 if (Paper_score *pscore = dynamic_cast<Paper_score*> (unsmob_music_output (scm_car (s))))
531 SCM system_list = scm_vector_to_list (pscore->get_paper_systems ());
532 system_list = scm_reverse (system_list);
533 systems_ = scm_append (scm_list_2 (system_list, systems_));
537 systems_ = scm_cons (scm_car (s), systems_);
540 systems_ = scm_reverse (systems_);
542 /* backwards compatibility for the old page breaker */
545 for (SCM s = systems_; scm_is_pair (s); s = scm_cdr (s))
547 Prob *ps = unsmob_prob (scm_car (s));
548 ps->set_property ("number", scm_from_int (++i));
551 && to_boolean (last->get_property ("is-title"))
552 && !scm_is_number (ps->get_property ("penalty")))
553 ps->set_property ("penalty", scm_from_int (10000));
556 if (scm_is_pair (scm_cdr (s)))
558 SCM perm = ps->get_property ("page-break-permission");
559 Prob *next = unsmob_prob (scm_cadr (s));
561 next->set_property ("penalty", scm_from_int (10001));
562 else if (perm == ly_symbol2scm ("force"))
563 next->set_property ("penalty", scm_from_int (-10001));
574 if (SCM_BOOL_F != pages_)
578 if (scm_is_pair (bookparts_))
580 for (SCM p = scm_reverse (bookparts_); scm_is_pair (p); p = scm_cdr (p))
581 if (Paper_book *pbookpart = unsmob_paper_book (scm_car (p)))
582 pages_ = scm_append_x (scm_list_2 (pages_, pbookpart->pages ()));
586 SCM proc = paper_->c_variable ("page-breaking-wrapper");
587 pages_ = scm_apply_0 (proc, scm_list_1 (self_scm ()));
589 /* set systems_ from the pages */
590 if (systems_ == SCM_BOOL_F)
593 for (SCM p = pages_; scm_is_pair (p); p = scm_cdr (p))
595 Prob *page = unsmob_prob (scm_car (p));
596 SCM systems = page->get_property ("lines");
597 systems_ = scm_append (scm_list_2 (systems_, systems));
605 Paper_book::performances () const
607 return scm_reverse (performances_);