source file of the GNU LilyPond music typesetter
- (c) 2004 Jan Nieuwenhuizen <janneke@gnu.org>
+ (c) 2004--2007 Jan Nieuwenhuizen <janneke@gnu.org>
*/
-#include "main.hh"
#include "paper-book.hh"
+
+#include "grob.hh"
+#include "main.hh"
+#include "output-def.hh"
+#include "paper-column.hh"
#include "paper-score.hh"
-#include "paper-def.hh"
-#include "stencil.hh"
-#include "paper-outputter.hh"
+#include "paper-system.hh"
+#include "text-interface.hh"
+#include "warn.hh"
+
+#include "ly-smobs.icc"
+
+Paper_book::Paper_book ()
+{
+ header_ = SCM_EOL;
+ header_0_ = SCM_EOL;
+ pages_ = SCM_BOOL_F;
+ scores_ = SCM_EOL;
+ performances_ = SCM_EOL;
+ systems_ = SCM_BOOL_F;
-// WIP -- simplistic page interface
-// Do we need this at all? SCM, smob?
-class Page
+ paper_ = 0;
+ smobify_self ();
+}
+
+Paper_book::~Paper_book ()
{
-public:
- Paper_def *paper_;
+}
- SCM lines_;
- Real hsize_;
- Real vsize_;
+IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
+IMPLEMENT_SMOBS (Paper_book);
+IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?");
- Page (Paper_def*);
- void output (Paper_outputter*, bool);
-};
+SCM
+Paper_book::mark_smob (SCM smob)
+{
+ Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
+ if (b->paper_)
+ scm_gc_mark (b->paper_->self_scm ());
+ scm_gc_mark (b->header_);
+ scm_gc_mark (b->header_0_);
+ scm_gc_mark (b->pages_);
+ scm_gc_mark (b->performances_);
+ scm_gc_mark (b->scores_);
+ return b->systems_;
+}
-Page::Page (Paper_def *paper)
+int
+Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
{
- paper_ = paper;
- hsize_ = paper->get_realvar (ly_symbol2scm ("hsize"));
- vsize_ = paper->get_realvar (ly_symbol2scm ("vsize"));
+ Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
+ (void)b;
+ scm_puts ("#<Paper_book>", port);
+ return 1;
+}
+
+SCM
+dump_fields ()
+{
+ SCM fields = SCM_EOL;
+ for (vsize i = dump_header_fieldnames_global.size (); i--;)
+ fields
+ = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].c_str ()),
+ fields);
+ return fields;
}
void
-Page::output (Paper_outputter *out, bool is_last)
+Paper_book::add_score (SCM s)
{
- int line_count = SCM_VECTOR_LENGTH ((SCM) lines_);
- for (int i = 0; i < line_count; i++)
- out->output_line (scm_vector_ref (lines_, scm_int2num (i)),
- is_last && i == line_count - 1);
+ scores_ = scm_cons (s, scores_);
}
+void
+Paper_book::add_performance (SCM s)
+{
+ performances_ = scm_cons (s, performances_);
+}
-Paper_book *paper_book;
+void
+Paper_book::output (SCM output_channel)
+{
+ if (scm_is_pair (performances_))
+ {
+ SCM proc = ly_lily_module_constant ("write-performances-midis");
+
+ scm_call_2 (proc, performances (), output_channel);
+ }
-Paper_book::Paper_book ()
+ if (scores_ == SCM_EOL)
+ return;
+
+ /* Generate all stencils to trigger font loads. */
+ pages ();
+
+ SCM scopes = SCM_EOL;
+ if (ly_is_module (header_))
+ scopes = scm_cons (header_, scopes);
+
+ string mod_nm = "scm framework-" + output_backend_global;
+
+ SCM mod = scm_c_resolve_module (mod_nm.c_str ());
+ if (make_print)
+ {
+ SCM func = scm_c_module_lookup (mod, "output-framework");
+
+ func = scm_variable_ref (func);
+ scm_apply_0 (func, scm_list_n (output_channel,
+ self_scm (),
+ scopes,
+ dump_fields (),
+ SCM_UNDEFINED));
+ }
+
+ if (make_preview)
+ {
+ SCM func = scm_c_module_lookup (mod, "output-preview-framework");
+ func = scm_variable_ref (func);
+ scm_apply_0 (func, scm_list_n (output_channel,
+ self_scm (),
+ scopes,
+ dump_fields (),
+ SCM_UNDEFINED));
+ }
+}
+
+void
+Paper_book::classic_output (SCM output)
+{
+ if (scm_is_pair (performances_))
+ {
+ SCM proc = ly_lily_module_constant ("write-performances-midis");
+
+ scm_call_2 (proc, performances (), output);
+ }
+
+ /* Generate all stencils to trigger font loads. */
+ systems ();
+
+ SCM scopes = SCM_EOL;
+ if (ly_is_module (header_))
+ scopes = scm_cons (header_, scopes);
+
+ if (ly_is_module (header_0_))
+ scopes = scm_cons (header_0_, scopes);
+
+ string format = output_backend_global;
+ string mod_nm = "scm framework-" + format;
+
+ SCM mod = scm_c_resolve_module (mod_nm.c_str ());
+ SCM func = scm_c_module_lookup (mod, "output-classic-framework");
+
+ func = scm_variable_ref (func);
+ scm_apply_0 (func, scm_list_n (output,
+ self_scm (),
+ scopes,
+ dump_fields (),
+ SCM_UNDEFINED));
+
+ progress_indication ("\n");
+}
+
+/* TODO: resurrect more complex user-tweaks for titling? */
+Stencil
+Paper_book::book_title ()
+{
+ SCM title_func = paper_->lookup_variable (ly_symbol2scm ("book-title"));
+ Stencil title;
+
+ SCM scopes = SCM_EOL;
+ if (ly_is_module (header_))
+ scopes = scm_cons (header_, scopes);
+
+ SCM tit = SCM_EOL;
+ if (ly_is_procedure (title_func))
+ tit = scm_call_2 (title_func,
+ paper_->self_scm (),
+ scopes);
+
+ if (unsmob_stencil (tit))
+ title = *unsmob_stencil (tit);
+
+ if (!title.is_empty ())
+ title.align_to (Y_AXIS, UP);
+
+ return title;
+}
+
+Stencil
+Paper_book::score_title (SCM header)
{
+ SCM title_func = paper_->lookup_variable (ly_symbol2scm ("score-title"));
+
+ Stencil title;
+
+ SCM scopes = SCM_EOL;
+ if (ly_is_module (header_))
+ scopes = scm_cons (header_, scopes);
+
+ if (ly_is_module (header))
+ scopes = scm_cons (header, scopes);
+
+ SCM tit = SCM_EOL;
+ if (ly_is_procedure (title_func))
+ tit = scm_call_2 (title_func,
+ paper_->self_scm (),
+ scopes);
+
+ if (unsmob_stencil (tit))
+ title = *unsmob_stencil (tit);
+
+ if (!title.is_empty ())
+ title.align_to (Y_AXIS, UP);
+
+ return title;
}
+/* read the breakbefore property of a score block and set up the preceding
+ system-spec to honour it. That is, SYM should be the system spec that
+ immediately precedes the score (from which HEADER is taken)
+ in the get_system_specs() list */
void
-Paper_book::output ()
+set_system_penalty (SCM sys, SCM header)
{
- Paper_outputter *out = paper_scores_[0]->outputter_;
+ if (ly_is_module (header))
+ {
+ SCM force = ly_module_lookup (header, ly_symbol2scm ("breakbefore"));
+ if (SCM_VARIABLEP (force)
+ && scm_is_bool (SCM_VARIABLE_REF (force)))
+ {
+ bool b = to_boolean (SCM_VARIABLE_REF (force));
+ SCM sym = b ? ly_symbol2scm ("force") : SCM_EOL;
+
+ if (Paper_score *ps = dynamic_cast<Paper_score*> (unsmob_music_output (sys)))
+ {
+ vector<Grob*> cols = ps->get_columns ();
+ if (cols.size ())
+ {
+ Paper_column *col = dynamic_cast<Paper_column*> (cols.back ());
+ col->set_property ("page-break-permission", sym);
+ col->find_prebroken_piece (LEFT)->set_property ("page-break-permission", sym);
+ }
+ }
+ else if (Prob *pb = unsmob_prob (sys))
+ pb->set_property ("page-break-permission", sym);
+ }
+ }
+}
+
+
+SCM
+Paper_book::get_score_title (SCM header)
+{
+ Stencil title = score_title (header);
+ if (title.is_empty ())
+ title = score_title (header_);
+ if (!title.is_empty ())
+ {
+ /*
+ TODO: this should come from the \layout {} block, which should
+ override settings from \paper {}
+ */
+ SCM props = paper_->lookup_variable (ly_symbol2scm ("score-title-properties"));
+ Prob *ps = make_paper_system (props);
+ paper_system_set_stencil (ps, title);
+
+ return ps->self_scm();
+ }
+
+ return SCM_BOOL_F;
+}
+
+
+SCM
+Paper_book::get_system_specs ()
+{
+ SCM system_specs = SCM_EOL;
- Paper_def *paper = paper_scores_[0]->paper_;
- out->output_header (paper);
+ Stencil title = book_title ();
+ if (!title.is_empty ())
+ {
+ SCM props = paper_->lookup_variable (ly_symbol2scm ("book-title-properties"));
+ Prob *ps = make_paper_system (props);
+ paper_system_set_stencil (ps, title);
+
+ system_specs = scm_cons (ps->self_scm (), system_specs);
+ ps->unprotect ();
+ }
+
+ SCM page_properties
+ = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
+ paper_->self_scm ());
+
+ SCM header = SCM_EOL;
+ for (SCM s = scm_reverse (scores_); scm_is_pair (s); s = scm_cdr (s))
+ {
+ if (ly_is_module (scm_car (s)))
+ {
+ header = scm_car (s);
+ if (header_0_ == SCM_EOL)
+ header_0_ = header;
+ }
+ else if (Music_output *mop = unsmob_music_output (scm_car (s)))
+ {
+ if (Paper_score *pscore = dynamic_cast<Paper_score *> (mop))
+ {
+ SCM title = get_score_title (header);
+
+ if (scm_is_pair (system_specs))
+ set_system_penalty (scm_car (system_specs), header);
+
+ if (unsmob_prob (title))
+ {
+ system_specs = scm_cons (title, system_specs);
+ unsmob_prob (title)->unprotect ();
+ }
+
+ header = SCM_EOL;
+ system_specs = scm_cons (pscore->self_scm (), system_specs);
+ }
+ else
+ {
+ /*
+ Ignore MIDI
+ */
+ }
+ }
+ else if (Text_interface::is_markup (scm_car (s)))
+ {
+ SCM t = Text_interface::interpret_markup (paper_->self_scm (),
+ page_properties,
+ scm_car (s));
+
+ // TODO: init props
+ Prob *ps = make_paper_system (SCM_EOL);
+ paper_system_set_stencil (ps, *unsmob_stencil (t));
+ ps->set_property ("is-title", SCM_BOOL_T);
+ system_specs = scm_cons (ps->self_scm (), system_specs);
+ ps->unprotect ();
+
+ // FIXME: figure out penalty.
+ //set_system_penalty (ps, scores_[i].header_);
+ }
+ else
+ assert (0);
+ }
+
+ system_specs = scm_reverse_x (system_specs, SCM_EOL);
+ return system_specs;
+}
+
+SCM
+Paper_book::systems ()
+{
+ if (systems_ != SCM_BOOL_F)
+ return systems_;
+
+ systems_ = SCM_EOL;
+ SCM specs = get_system_specs ();
+ for (SCM s = specs; scm_is_pair (s); s = scm_cdr (s))
+ {
+ if (Paper_score *pscore = dynamic_cast<Paper_score*> (unsmob_music_output (scm_car (s))))
+ {
+ SCM system_list = scm_vector_to_list (pscore->get_paper_systems ());
+ system_list = scm_reverse (system_list);
+ systems_ = scm_append (scm_list_2 (system_list, systems_));
+ }
+ else
+ {
+ systems_ = scm_cons (scm_car (s), systems_);
+ }
+ }
- if (paper_scores_[0]->book_title_)
- out->output_expr (paper_scores_[0]->book_title_->get_expr (),
- Offset (0, 0));
+ systems_ = scm_reverse (systems_);
+
+ /* backwards compatibility for the old page breaker */
+ int i = 0;
+ Prob *last = 0;
+ for (SCM s = systems_; scm_is_pair (s); s = scm_cdr (s))
+ {
+ Prob *ps = unsmob_prob (scm_car (s));
+ ps->set_property ("number", scm_from_int (++i));
- Link_array<Page> *pages = get_pages ();
- int page_count = pages->size ();
- for (int i = 0; i < page_count; i++)
- (*pages)[i]->output (out, i + 1 == page_count);
+ if (last
+ && to_boolean (last->get_property ("is-title"))
+ && !scm_is_number (ps->get_property ("penalty")))
+ ps->set_property ("penalty", scm_from_int (10000));
+ last = ps;
- out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
- progress_indication ("\n");
+ if (scm_is_pair (scm_cdr (s)))
+ {
+ SCM perm = ps->get_property ("page-break-permission");
+ Prob *next = unsmob_prob (scm_cadr (s));
+ if (perm == SCM_EOL)
+ next->set_property ("penalty", scm_from_int (10001));
+ else if (perm == ly_symbol2scm ("force"))
+ next->set_property ("penalty", scm_from_int (-10001));
+ }
+ }
+
+ return systems_;
}
-/*
- WIP -- this simply adds one Page per \score
- TODO:
- * get dimensions
- * title: bookTitle vs scoreTitle
- * start-page / stop-page in output-* interface
- * some page breaking algorithm
- * header / footer (generate per Page, with page#)
- * override: # pages, or pageBreakLines= #'(3 3 4), ?
- * what about between-system-breaking, can we junk that?
-
-*/
-Link_array<Page>*
-Paper_book::get_pages ()
+SCM
+Paper_book::pages ()
{
- Link_array<Page> *pages = new Link_array<Page>;
- Paper_def *paper = paper_scores_[0]->paper_;
- int score_count = paper_scores_.size ();
- for (int i = 0; i < score_count; i++)
+ if (SCM_BOOL_F != pages_)
+ return pages_;
+
+ pages_ = SCM_EOL;
+ SCM proc = paper_->c_variable ("page-breaking-wrapper");
+ pages_ = scm_apply_0 (proc, scm_list_1 (self_scm ()));
+
+ /* set systems_ from the pages */
+ if (systems_ == SCM_BOOL_F)
{
- Page *page = new Page (paper);
- page->lines_ = paper_scores_[i]->lines_;
- pages->push (page);
+ systems_ = SCM_EOL;
+ for (SCM p = pages_; scm_is_pair (p); p = scm_cdr (p))
+ {
+ Prob *page = unsmob_prob (scm_car (p));
+ SCM systems = page->get_property ("lines");
+
+ systems_ = scm_append (scm_list_2 (systems_, systems));
+ }
}
- //if (paper_scores_[0]->book_title_)
- // title = paper_scores_[0]->book_title_->extent (Y_AXIS).length ();
+ return pages_;
+}
- return pages;
+SCM
+Paper_book::performances () const
+{
+ return scm_reverse (performances_);
}
projects / lilypond.git / blobdiff