2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2014 Jan Nieuwenhuizen <janneke@gnu.org>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "paper-book.hh"
23 #include "international.hh"
25 #include "output-def.hh"
26 #include "paper-column.hh"
27 #include "paper-score.hh"
28 #include "paper-system.hh"
29 #include "text-interface.hh"
31 #include "program-option.hh"
32 #include "page-marker.hh"
34 #include "ly-smobs.icc"
36 Paper_book::Paper_book ()
43 performances_ = SCM_EOL;
44 systems_ = SCM_BOOL_F;
51 Paper_book::~Paper_book ()
55 IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
56 IMPLEMENT_SMOBS (Paper_book);
57 IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?");
60 Paper_book::mark_smob (SCM smob)
62 Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
64 scm_gc_mark (b->paper_->self_scm ());
66 scm_gc_mark (b->parent_->self_scm ());
67 scm_gc_mark (b->header_);
68 scm_gc_mark (b->header_0_);
69 scm_gc_mark (b->pages_);
70 scm_gc_mark (b->performances_);
71 scm_gc_mark (b->scores_);
72 scm_gc_mark (b->bookparts_);
77 Paper_book::print_smob (SCM smob, SCM port, scm_print_state *)
79 Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
81 scm_puts ("#<Paper_book>", port);
86 Paper_book::top_paper ()
88 Output_def *paper = paper_;
89 while (paper->parent_)
90 paper = paper->parent_;
98 for (vsize i = dump_header_fieldnames_global.size (); i--;)
100 = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].c_str ()),
106 Paper_book::add_score (SCM s)
108 scores_ = scm_cons (s, scores_);
112 Paper_book::add_bookpart (SCM p)
114 bookparts_ = scm_cons (p, bookparts_);
118 Paper_book::add_performance (SCM s)
120 performances_ = scm_cons (s, performances_);
124 Paper_book::output_aux (SCM output_channel,
126 long *first_page_number,
127 long *first_performance_number)
130 if (scm_is_pair (performances_))
132 SCM proc = ly_lily_module_constant ("write-performances-midis");
137 scm_from_long (*first_performance_number));
138 *first_performance_number += scm_ilength (performances_);
141 if (scm_is_pair (bookparts_))
143 for (SCM p = bookparts_; scm_is_pair (p); p = scm_cdr (p))
144 if (Paper_book *pbookpart = Paper_book::unsmob (scm_car (p)))
146 bool is_last_part = (is_last && !scm_is_pair (scm_cdr (p)));
147 page_nb += pbookpart->output_aux (output_channel,
150 first_performance_number);
155 if (scores_ == SCM_EOL)
157 paper_->set_variable (ly_symbol2scm ("first-page-number"),
158 scm_from_long (*first_page_number));
159 paper_->set_variable (ly_symbol2scm ("is-last-bookpart"),
160 ly_bool2scm (is_last));
161 /* Generate all stencils to trigger font loads. */
162 page_nb = scm_ilength (pages ());
163 *first_page_number += page_nb;
169 Paper_book::output (SCM output_channel)
171 long first_page_number
172 = robust_scm2int (paper_->c_variable ("first-page-number"), 1);
173 long first_performance_number = 0;
175 /* FIXME: We need a line-width for ps output (framework-ps.scm:92).
176 If we don't have any, we take the paper-width unless we know
177 better which line-width to choose (e.g. if there are \bookparts
178 with different line-widths) and why we need it at all.
181 if (paper_->c_variable ("line-width") == SCM_UNDEFINED)
182 paper_->set_variable (ly_symbol2scm ("line-width"),
183 paper_->c_variable ("paper-width"));
185 if (!output_aux (output_channel,
188 &first_performance_number))
191 SCM scopes = SCM_EOL;
192 if (ly_is_module (header_))
193 scopes = scm_cons (header_, scopes);
195 string mod_nm = "scm framework-" + get_output_backend_name ();
197 SCM mod = scm_c_resolve_module (mod_nm.c_str ());
199 if (get_program_option ("print-pages"))
201 SCM framework = ly_module_lookup (mod,
202 ly_symbol2scm ("output-framework"));
204 if (framework != SCM_BOOL_F)
206 SCM func = scm_variable_ref (framework);
214 warning (_f ("program option -dprint-pages not supported by backend `%s'",
215 get_output_backend_name ()));
218 if (get_program_option ("preview"))
221 = ly_module_lookup (mod, ly_symbol2scm ("output-preview-framework"));
223 if (framework != SCM_BOOL_F)
225 SCM func = scm_variable_ref (framework);
233 warning (_f ("program option -dpreview not supported by backend `%s'",
234 get_output_backend_name ()));
239 Paper_book::classic_output_aux (SCM output,
240 long *first_performance_number)
242 if (scm_is_pair (performances_))
244 SCM proc = ly_lily_module_constant ("write-performances-midis");
248 scm_from_long (*first_performance_number));
249 *first_performance_number += scm_ilength (performances_);
252 /* Generate all stencils to trigger font loads. */
257 Paper_book::classic_output (SCM output)
259 long first_performance_number = 0;
260 classic_output_aux (output, &first_performance_number);
262 SCM scopes = SCM_EOL;
263 if (ly_is_module (header_))
264 scopes = scm_cons (header_, scopes);
266 if (ly_is_module (header_0_))
267 scopes = scm_cons (header_0_, scopes);
269 string format = get_output_backend_name ();
270 string mod_nm = "scm framework-" + format;
272 SCM mod = scm_c_resolve_module (mod_nm.c_str ());
273 SCM func = scm_c_module_lookup (mod, "output-classic-framework");
275 func = scm_variable_ref (func);
281 progress_indication ("\n");
284 /* TODO: resurrect more complex user-tweaks for titling? */
286 Paper_book::book_title ()
288 SCM title_func = paper_->lookup_variable (ly_symbol2scm ("book-title"));
291 SCM scopes = SCM_EOL;
292 if (ly_is_module (header_))
293 scopes = scm_cons (header_, scopes);
296 if (ly_is_procedure (title_func))
297 tit = scm_call_2 (title_func,
301 if (Stencil::unsmob (tit))
302 title = *Stencil::unsmob (tit);
304 if (!title.is_empty ())
305 title.align_to (Y_AXIS, UP);
311 Paper_book::score_title (SCM header)
313 SCM title_func = paper_->lookup_variable (ly_symbol2scm ("score-title"));
317 SCM scopes = SCM_EOL;
318 if (ly_is_module (header_))
319 scopes = scm_cons (header_, scopes);
321 if (ly_is_module (header))
322 scopes = scm_cons (header, scopes);
325 if (ly_is_procedure (title_func))
326 tit = scm_call_2 (title_func,
330 if (Stencil::unsmob (tit))
331 title = *Stencil::unsmob (tit);
333 if (!title.is_empty ())
334 title.align_to (Y_AXIS, UP);
340 set_page_permission (SCM sys, SCM symbol, SCM permission)
342 if (Paper_score *ps = dynamic_cast<Paper_score *> (Music_output::unsmob (sys)))
344 vector<Grob *> cols = ps->get_columns ();
347 Paper_column *col = dynamic_cast<Paper_column *> (cols.back ());
348 col->set_property (symbol, permission);
349 col->find_prebroken_piece (LEFT)->set_property (symbol, permission);
352 else if (Prob *pb = Prob::unsmob (sys))
353 pb->set_property (symbol, permission);
356 /* read the breakbefore property of a score block and set up the preceding
357 system-spec to honour it. That is, SYS should be the system spec that
358 immediately precedes the score (from which HEADER is taken)
359 in the get_system_specs () list */
361 set_system_penalty (SCM sys, SCM header)
363 if (ly_is_module (header))
365 SCM force = ly_module_lookup (header, ly_symbol2scm ("breakbefore"));
366 if (SCM_VARIABLEP (force)
367 && scm_is_bool (SCM_VARIABLE_REF (force)))
369 if (to_boolean (SCM_VARIABLE_REF (force)))
371 set_page_permission (sys, ly_symbol2scm ("page-break-permission"),
372 ly_symbol2scm ("force"));
373 set_page_permission (sys, ly_symbol2scm ("line-break-permission"),
374 ly_symbol2scm ("force"));
377 set_page_permission (sys, ly_symbol2scm ("page-break-permission"),
384 set_labels (SCM sys, SCM labels)
386 if (Paper_score *ps = dynamic_cast<Paper_score *> (Music_output::unsmob (sys)))
388 vector<Grob *> cols = ps->get_columns ();
391 Paper_column *col = dynamic_cast<Paper_column *> (cols[0]);
392 col->set_property ("labels",
393 scm_append_x (scm_list_2 (col->get_property ("labels"),
395 Paper_column *col_right
396 = dynamic_cast<Paper_column *> (col->find_prebroken_piece (RIGHT));
397 col_right->set_property ("labels",
398 scm_append_x (scm_list_2 (col_right->get_property ("labels"),
402 else if (Prob *pb = Prob::unsmob (sys))
403 pb->set_property ("labels",
404 scm_append_x (scm_list_2 (pb->get_property ("labels"),
409 Paper_book::get_score_title (SCM header)
411 Stencil title = score_title (header);
412 if (title.is_empty ())
413 title = score_title (header_);
414 if (!title.is_empty ())
417 TODO: this should come from the \layout {} block, which should
418 override settings from \paper {}
421 = paper_->lookup_variable (ly_symbol2scm ("score-title-properties"));
422 Prob *ps = make_paper_system (props);
423 paper_system_set_stencil (ps, title);
425 return ps->self_scm ();
432 Paper_book::get_system_specs ()
434 SCM system_specs = SCM_EOL;
436 Stencil title = book_title ();
437 if (!title.is_empty ())
440 = paper_->lookup_variable (ly_symbol2scm ("book-title-properties"));
441 Prob *ps = make_paper_system (props);
442 paper_system_set_stencil (ps, title);
444 system_specs = scm_cons (ps->self_scm (), system_specs);
449 = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
450 paper_->self_scm ());
452 SCM interpret_markup_list = ly_lily_module_constant ("interpret-markup-list");
453 SCM header = SCM_EOL;
454 SCM labels = SCM_EOL;
455 for (SCM s = scm_reverse (scores_); scm_is_pair (s); s = scm_cdr (s))
457 if (ly_is_module (scm_car (s)))
459 header = scm_car (s);
460 if (header_0_ == SCM_EOL)
463 else if (Page_marker *page_marker = Page_marker::unsmob (scm_car (s)))
465 /* page markers are used to set page breaking/turning permission,
466 or to place bookmarking labels */
467 if (scm_is_symbol (page_marker->permission_symbol ()))
469 /* set previous element page break or turn permission */
470 if (scm_is_pair (system_specs))
471 set_page_permission (scm_car (system_specs),
472 page_marker->permission_symbol (),
473 page_marker->permission_value ());
475 if (scm_is_symbol (page_marker->label ()))
477 /* The next element label is to be set */
478 labels = scm_cons (page_marker->label (), labels);
481 else if (Music_output *mop = Music_output::unsmob (scm_car (s)))
483 if (Paper_score *pscore = dynamic_cast<Paper_score *> (mop))
485 SCM title = get_score_title (header);
487 if (scm_is_pair (system_specs))
488 set_system_penalty (scm_car (system_specs), header);
490 if (Prob::unsmob (title))
492 system_specs = scm_cons (title, system_specs);
493 Prob::unsmob (title)->unprotect ();
497 system_specs = scm_cons (pscore->self_scm (), system_specs);
498 if (scm_is_pair (labels))
500 set_labels (scm_car (system_specs), labels);
511 else if (Text_interface::is_markup_list (scm_car (s)))
513 SCM texts = scm_call_3 (interpret_markup_list,
519 for (SCM list = texts; scm_is_pair (list); list = scm_cdr (list))
521 SCM t = scm_car (list);
523 Prob *ps = make_paper_system (SCM_EOL);
524 ps->set_property ("page-break-permission",
525 ly_symbol2scm ("allow"));
526 ps->set_property ("page-turn-permission",
527 ly_symbol2scm ("allow"));
528 ps->set_property ("last-markup-line", SCM_BOOL_F);
529 ps->set_property ("first-markup-line", SCM_BOOL_F);
531 paper_system_set_stencil (ps, *Stencil::unsmob (t));
533 SCM footnotes = get_footnotes (Stencil::unsmob (t)->expr ());
534 ps->set_property ("footnotes", footnotes);
535 ps->set_property ("is-title", SCM_BOOL_T);
540 // last line so far, in a multi-line paragraph
542 //Place closely to previous line, no stretching.
543 ps->set_property ("tight-spacing", SCM_BOOL_T);
545 system_specs = scm_cons (ps->self_scm (), system_specs);
548 if (scm_is_pair (labels))
550 set_labels (scm_car (system_specs), labels);
553 // FIXME: figure out penalty.
554 //set_system_penalty (ps, scores_[i].header_);
556 /* Set properties to avoid widowed/orphaned lines.
557 Single-line markup_lists are excluded, but in future
558 we may want to add the case of a very short, single line. */
561 last->set_property ("last-markup-line", SCM_BOOL_T);
562 first->set_property ("first-markup-line", SCM_BOOL_T);
569 system_specs = scm_reverse_x (system_specs, SCM_EOL);
574 Paper_book::systems ()
576 if (systems_ != SCM_BOOL_F)
580 if (scm_is_pair (bookparts_))
582 SCM system_list = SCM_EOL;
583 for (SCM p = bookparts_; scm_is_pair (p); p = scm_cdr (p))
584 if (Paper_book *pbookpart = Paper_book::unsmob (scm_car (p)))
585 system_list = scm_cons (pbookpart->systems (), system_list);
586 systems_ = scm_append (scm_reverse_x (system_list, SCM_EOL));
590 SCM specs = get_system_specs ();
591 for (SCM s = specs; scm_is_pair (s); s = scm_cdr (s))
593 if (Paper_score * pscore
594 = dynamic_cast<Paper_score *> (Music_output::unsmob (scm_car (s))))
597 = scm_vector_to_list (pscore->get_paper_systems ());
599 systems_ = scm_reverse_x (system_list, systems_);
603 systems_ = scm_cons (scm_car (s), systems_);
606 systems_ = scm_reverse_x (systems_, SCM_EOL);
608 /* backwards compatibility for the old page breaker */
611 for (SCM s = systems_; scm_is_pair (s); s = scm_cdr (s))
613 Prob *ps = Prob::unsmob (scm_car (s));
614 ps->set_property ("number", scm_from_int (++i));
617 && to_boolean (last->get_property ("is-title"))
618 && !scm_is_number (ps->get_property ("penalty")))
619 ps->set_property ("penalty", scm_from_int (10000));
622 if (scm_is_pair (scm_cdr (s)))
624 SCM perm = ps->get_property ("page-break-permission");
625 Prob *next = Prob::unsmob (scm_cadr (s));
627 next->set_property ("penalty", scm_from_int (10001));
628 else if (perm == ly_symbol2scm ("force"))
629 next->set_property ("penalty", scm_from_int (-10001));
640 if (SCM_BOOL_F != pages_)
644 if (scm_is_pair (bookparts_))
646 for (SCM p = bookparts_; scm_is_pair (p); p = scm_cdr (p))
647 if (Paper_book *pbookpart = Paper_book::unsmob (scm_car (p)))
648 pages_ = scm_cons (pbookpart->pages (), pages_);
649 pages_ = scm_append (scm_reverse_x (pages_, SCM_EOL));
651 else if (scm_is_pair (scores_))
653 SCM page_breaking = paper_->c_variable ("page-breaking");
654 pages_ = scm_call_1 (page_breaking, self_scm ());
656 // Create all the page stencils.
657 SCM page_module = scm_c_resolve_module ("scm page");
658 SCM page_stencil = scm_c_module_lookup (page_module, "page-stencil");
659 page_stencil = scm_variable_ref (page_stencil);
660 for (SCM pages = pages_; scm_is_pair (pages); pages = scm_cdr (pages))
661 scm_call_1 (page_stencil, scm_car (pages));
663 // Perform any user-supplied post-processing.
664 SCM post_process = paper_->c_variable ("page-post-process");
665 if (ly_is_procedure (post_process))
666 scm_call_2 (post_process, paper_->self_scm (), pages_);
668 /* set systems_ from the pages */
669 if (systems_ == SCM_BOOL_F)
672 for (SCM p = pages_; scm_is_pair (p); p = scm_cdr (p))
674 Prob *page = Prob::unsmob (scm_car (p));
675 SCM systems = page->get_property ("lines");
676 systems_ = scm_cons (systems, systems_);
678 systems_ = scm_append (scm_reverse_x (systems_, SCM_EOL));
685 Paper_book::performances () const
687 return scm_reverse (performances_);