source file of the GNU LilyPond music typesetter
- (c) 2004 Jan Nieuwenhuizen <janneke@gnu.org>
+ (c) 2004--2006 Jan Nieuwenhuizen <janneke@gnu.org>
*/
-#include "ly-module.hh"
-#include "main.hh"
-#include "page.hh"
#include "paper-book.hh"
+
+#include "grob.hh"
+#include "main.hh"
#include "output-def.hh"
-#include "paper-outputter.hh"
-#include "paper-line.hh"
+#include "paper-column.hh"
#include "paper-score.hh"
-#include "stencil.hh"
+#include "paper-system.hh"
+#include "text-interface.hh"
#include "warn.hh"
-
-/*
- Ugh. the Function of the Paper_book class is unclear. Trim this
- file.
-
- */
-
-// JUNKME
-SCM
-stencil2line (Stencil stil, bool is_title = false)
-{
- static SCM z;
- if (!z)
- z = scm_permanent_object (ly_offset2scm (Offset (0, 0)));
- Offset dim = Offset (stil.extent (X_AXIS).length (),
- stil.extent (Y_AXIS).length ());
- Paper_line *pl = new Paper_line (dim, scm_cons (stil.smobbed_copy (),
- SCM_EOL),
- -10001 * is_title, is_title);
-
- return scm_gc_unprotect_object (pl->self_scm ());
-}
-
+#include "ly-smobs.icc"
Paper_book::Paper_book ()
{
- pages_ = SCM_EOL;
- lines_ = SCM_EOL;
- copyright_ = SCM_EOL;
- tagline_ = SCM_EOL;
header_ = SCM_EOL;
-
- bookpaper_ = 0;
+ header_0_ = SCM_EOL;
+ pages_ = SCM_BOOL_F;
+ scores_ = SCM_EOL;
+ performances_ = SCM_EOL;
+ systems_ = SCM_BOOL_F;
+
+ paper_ = 0;
smobify_self ();
}
{
}
-#include "ly-smobs.icc"
-
IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
-IMPLEMENT_SMOBS (Paper_book)
-IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?")
+IMPLEMENT_SMOBS (Paper_book);
+IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?");
SCM
Paper_book::mark_smob (SCM smob)
{
- Paper_book *b = (Paper_book*) SCM_CELL_WORD_1 (smob);
- for (int i = 0; i < b->score_lines_.size (); i++)
- b->score_lines_[i].gc_mark ();
-
- scm_gc_mark (b->copyright_);
- if (b->bookpaper_)
- scm_gc_mark (b->bookpaper_->self_scm ());
+ 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->lines_);
- return b->tagline_;
+ scm_gc_mark (b->performances_);
+ scm_gc_mark (b->scores_);
+ return b->systems_;
}
int
Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
{
- Paper_book *b = (Paper_book*) ly_cdr (smob);
-
- scm_puts ("#<", port);
- scm_puts (classname (b), port);
- scm_puts (" ", port);
- //scm_puts (b->, port);
- scm_puts (">", port);
+ Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
+ (void)b;
+ scm_puts ("#<Paper_book>", port);
return 1;
}
-Array<String>
-split_string (String s, char c)
-{
- Array<String> rv;
- while (s.length ())
- {
- int i = s.index (c);
-
- if (i == 0)
- {
- s = s.nomid_string (0, 1);
- continue;
- }
-
- if (i < 0)
- i = s.length () ;
-
- rv.push (s.cut_string (0, i));
- s = s.nomid_string (0, i);
- }
-
- return rv;
-}
-
SCM
dump_fields ()
{
SCM fields = SCM_EOL;
- for (int i = dump_header_fieldnames_global.size (); i--; )
+ for (vsize i = dump_header_fieldnames_global.size (); i--;)
fields
- = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].to_str0 ()),
+ = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].c_str ()),
fields);
return fields;
}
-/*
- TODO: there is too much code dup, and the interface is not
- clear. FIXME.
- */
void
-Paper_book::output (String outname)
+Paper_book::add_score (SCM s)
{
- if (!score_lines_.size ())
- return;
-
- /* Generate all stencils to trigger font loads. */
- pages ();
-
- Array<String> output_formats = split_string (output_format_global, ',');
-
- for (int i = 0; i < output_formats.size (); i++)
- {
- String format = output_formats[i];
- Paper_outputter *out = get_paper_outputter (outname + "." + output_formats[i], format);
-
-
-
-
- SCM scopes = SCM_EOL;
- if (ly_c_module_p (header_))
- scopes = scm_cons (header_, scopes);
-
- String func_nm = format;
- func_nm = "output-framework-" + func_nm;
-
- SCM func = ly_scheme_function (func_nm.to_str0 ());
- scm_apply_0 (func, scm_list_n (out->self_scm (),
- self_scm (),
- scopes,
- dump_fields (),
- scm_makfrom0str (outname.to_str0 ()),
- SCM_UNDEFINED
- )) ;
-
- scm_gc_unprotect_object (out->self_scm ());
- }
+ scores_ = scm_cons (s, scores_);
}
+void
+Paper_book::add_performance (SCM s)
+{
+ performances_ = scm_cons (s, performances_);
+}
void
-Paper_book::classic_output (String outname)
+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);
+ }
- /* Generate all stencils to trigger font loads. */
- lines ();
+ if (scores_ == SCM_EOL)
+ return;
+ /* Generate all stencils to trigger font loads. */
+ pages ();
- // ugh code dup
SCM scopes = SCM_EOL;
- if (ly_c_module_p (header_))
+ if (ly_is_module (header_))
scopes = scm_cons (header_, scopes);
- if (ly_c_module_p (score_lines_[0].header_))
- scopes = scm_cons (score_lines_[0].header_, scopes);
- //end ugh
-
+ string mod_nm = "scm framework-" + output_backend_global;
- Array<String> output_formats = split_string (output_format_global, ',');
-
- for (int i = 0; i < output_formats.size (); i++)
+ SCM mod = scm_c_resolve_module (mod_nm.c_str ());
+ if (make_print)
{
- String format = output_formats[i];
- String func_nm = format;
- func_nm = "output-classic-framework-" + func_nm;
-
- SCM func = ly_scheme_function (func_nm.to_str0 ());
-
- Paper_outputter *out = get_paper_outputter (outname + "." + format, format);
+ SCM func = scm_c_module_lookup (mod, "output-framework");
- scm_apply_0 (func, scm_list_n (out->self_scm (),
+ func = scm_variable_ref (func);
+ scm_apply_0 (func, scm_list_n (output_channel,
self_scm (),
scopes,
dump_fields (),
- scm_makfrom0str (outname.to_str0 ()),
- SCM_UNDEFINED
- )) ;
+ SCM_UNDEFINED));
+ }
- scm_gc_unprotect_object (out->self_scm ());
+ 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));
}
-
- progress_indication ("\n");
}
-
-
-
-LY_DEFINE(ly_paper_book_pages, "ly:paper-book-pages",
- 1,0,0,
- (SCM pb),
- "Return pages in book PB.")
+void
+Paper_book::classic_output (SCM output)
{
- return unsmob_paper_book(pb)->pages ();
-}
+ /* Generate all stencils to trigger font loads. */
+ systems ();
+ SCM scopes = SCM_EOL;
+ if (ly_is_module (header_))
+ scopes = scm_cons (header_, scopes);
-LY_DEFINE(ly_paper_book_lines, "ly:paper-book-lines",
- 1,0,0,
- (SCM pb),
- "Return lines in book PB.")
-{
- return unsmob_paper_book (pb)->lines ();
-}
+ if (ly_is_module (header_0_))
+ scopes = scm_cons (header_0_, scopes);
+ string format = output_backend_global;
+ string mod_nm = "scm framework-" + format;
-LY_DEFINE(ly_paper_book_book_paper, "ly:paper-book-book-paper",
- 1,0,0,
- (SCM pb),
- "Return pages in book PB.")
-{
- return unsmob_paper_book(pb)->bookpaper_->self_scm ();
-}
+ 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));
-TODO: resurrect more complex user-tweaks for titling .
+ progress_indication ("\n");
+}
-*/
+/* TODO: resurrect more complex user-tweaks for titling? */
Stencil
Paper_book::book_title ()
{
- SCM title_func = bookpaper_->lookup_variable (ly_symbol2scm ("book-title"));
+ SCM title_func = paper_->lookup_variable (ly_symbol2scm ("book-title"));
Stencil title;
SCM scopes = SCM_EOL;
- if (ly_c_module_p (header_))
+ if (ly_is_module (header_))
scopes = scm_cons (header_, scopes);
-
SCM tit = SCM_EOL;
- if (ly_c_procedure_p (title_func))
+ if (ly_is_procedure (title_func))
tit = scm_call_2 (title_func,
- bookpaper_->self_scm (),
- scopes);
+ 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 (int i)
+Paper_book::score_title (SCM header)
{
- SCM title_func = bookpaper_->lookup_variable (ly_symbol2scm ("score-title"));
+ SCM title_func = paper_->lookup_variable (ly_symbol2scm ("score-title"));
Stencil title;
- // ugh code dup
SCM scopes = SCM_EOL;
- if (ly_c_module_p (header_))
+ if (ly_is_module (header_))
scopes = scm_cons (header_, scopes);
- if (ly_c_module_p (score_lines_[i].header_))
- scopes = scm_cons (score_lines_[i].header_, scopes);
- //end ugh
+ if (ly_is_module (header))
+ scopes = scm_cons (header, scopes);
SCM tit = SCM_EOL;
- if (ly_c_procedure_p (title_func))
- tit =scm_call_2 (title_func,
- bookpaper_->self_scm (),
- scopes);
+ 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;
}
-
-
-SCM
-Paper_book::lines ()
+/* 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
+set_system_penalty (SCM sys, SCM header)
{
- if (ly_c_pair_p (lines_))
- return lines_;
-
- Stencil title = book_title ();
- if (!title.is_empty ())
- lines_ = scm_cons (stencil2line (title, true), lines_);
-
- int score_count = score_lines_.size ();
- for (int i = 0; i < score_count; i++)
+ if (ly_is_module (header))
{
- Stencil title = score_title (i);
- if (!title.is_empty ())
- lines_ = scm_cons (stencil2line (title, true), lines_);
-
- SCM line_list = scm_vector_to_list (score_lines_[i].lines_); // guh.
- lines_ = scm_append (scm_list_2 (scm_reverse (line_list), lines_));
+ 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);
+ }
}
-
- lines_ = scm_reverse (lines_);
-
- int i = 0;
- for (SCM s = lines_; s != SCM_EOL; s = ly_cdr (s))
- unsmob_paper_line (ly_car (s))->number_ = ++i;
- return lines_;
}
SCM
-make_tagline (Output_def*paper, SCM scopes)
+Paper_book::get_score_title (SCM header)
{
- SCM make_tagline = paper->c_variable ("make-tagline");
- SCM tagline = scm_call_2 (make_tagline, paper->self_scm (), scopes);
- return tagline;
-}
+ 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();
+ }
-SCM
-make_copyright (Output_def *paper, SCM scopes)
-{
- SCM make_copyright = paper->c_variable ("make-copyright");
- SCM copyright = scm_call_2 (make_copyright, paper->self_scm (), scopes);
- return copyright;
+ return SCM_BOOL_F;
}
+
SCM
-Paper_book::pages ()
+Paper_book::get_system_specs ()
{
- if (ly_c_pair_p (pages_))
- return pages_;
-
- Output_def *paper = bookpaper_;
- Page *page = new Page (paper, 1);
-
- Real text_height = page->text_height ();
-
- Real copy_height = 0;
- if (Stencil *s = unsmob_stencil (copyright_))
- copy_height = s->extent (Y_AXIS).length ();
-
- Real tag_height = 0;
- if (Stencil *s = unsmob_stencil (tagline_))
- tag_height = s->extent (Y_AXIS).length ();
-
- SCM all = lines ();
- SCM proc = paper->c_variable ("page-breaking");
- SCM breaks = scm_apply_0 (proc, scm_list_n (all,
- self_scm (),
- scm_make_real (text_height),
- scm_make_real (-copy_height),
- scm_make_real (-tag_height),
- SCM_UNDEFINED));
-
-
- /*
- UGH - move this out of C++.
- */
- SCM scopes = SCM_EOL;
- if (ly_c_module_p (header_))
- scopes = scm_cons (header_, scopes);
+ SCM system_specs = SCM_EOL;
- tagline_ = make_tagline (bookpaper_, scopes);
- copyright_ = make_tagline (bookpaper_, scopes);
+ 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);
- int page_count = SCM_VECTOR_LENGTH ((SCM) breaks);
- int line = 1;
+ system_specs = scm_cons (ps->self_scm (), system_specs);
+ ps->unprotect ();
+ }
- for (int i = 0; i < page_count; i++)
- {
- if (i)
- page = new Page (paper, i + 1);
+ SCM page_properties
+ = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
+ paper_->self_scm ());
- int next = i + 1 < page_count
- ? ly_scm2int (scm_vector_ref (breaks, scm_int2num (i))) : 0;
- while ((!next && all != SCM_EOL) || line <= next)
+ 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)))
{
- SCM s = ly_car (all);
- page->lines_ = ly_snoc (s, page->lines_);
- page->height_ += unsmob_paper_line (s)->dim ()[Y_AXIS];
- page->line_count_++;
- all = ly_cdr (all);
- line++;
+ header = scm_car (s);
+ if (header_0_ == SCM_EOL)
+ header_0_ = header;
}
- if (i == page_count-1)
- page->is_last_ = true;
-
- pages_ = scm_cons (page->self_scm (), pages_);
+ 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);
}
- pages_ = scm_reverse (pages_);
- return pages_;
+ system_specs = scm_reverse_x (system_specs, SCM_EOL);
+ return system_specs;
}
-
-
-static SCM
-c_ragged_page_breaks (SCM lines,
- Paper_book *book,
- Real text_height,
- Real first, Real last)
+SCM
+Paper_book::systems ()
{
- int page_number = 0;
+ if (systems_ != SCM_BOOL_F)
+ return systems_;
- Real book_height =0.;
- for (SCM s = lines ; ly_c_pair_p (s); s = ly_cdr (s))
+ systems_ = SCM_EOL;
+ SCM specs = get_system_specs ();
+ for (SCM s = specs; scm_is_pair (s); s = scm_cdr (s))
{
- book_height += unsmob_paper_line (ly_car (s))->dim ()[Y_AXIS];
+ 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_);
+ }
}
-
- /*
- UGH. following stuff should go out of C++.
- */
- SCM scopes = SCM_EOL;
- if (ly_c_module_p (book->header_))
- scopes = scm_cons (book->header_, scopes);
+ systems_ = scm_reverse (systems_);
- SCM tag = make_tagline (book->bookpaper_, scopes);
- if (unsmob_stencil (tag))
+ /* 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))
{
- book_height += unsmob_stencil (tag)->extent (Y_AXIS).length ();
- }
+ Prob *ps = unsmob_prob (scm_car (s));
+ ps->set_property ("number", scm_from_int (++i));
- SCM cr = make_copyright (book->bookpaper_, scopes);
- if (unsmob_stencil (cr))
- {
- book_height += unsmob_stencil (cr)->extent (Y_AXIS).length ();
- }
+ 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;
- int page_count = int (book_height / text_height + 0.5); // ceil?
- SCM breaks = SCM_EOL;
- Real page_height = text_height + first;
- Real h = 0;
- int number = 0;
- for (SCM s = lines; ly_c_pair_p (s); s = ly_cdr (s))
- {
- Paper_line *pl = unsmob_paper_line (ly_car (s));
- if (!pl->is_title () && h < page_height)
- number++;
- h += pl->dim ()[Y_AXIS];
- if (!pl->is_title () && h > page_height)
+ if (scm_is_pair (scm_cdr (s)))
{
- breaks = ly_snoc (scm_int2num (number), breaks);
- page_number++;
- page_height = text_height + (page_number == page_count) * last;
- h = 0;
+ 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));
}
- if (ly_cdr (s) == SCM_EOL)
- breaks = ly_snoc (scm_int2num (pl->number_), breaks);
}
- return scm_vector (breaks);
+ return systems_;
}
-LY_DEFINE (ly_ragged_page_breaks, "ly:ragged-page-breaks",
- 5, 0, 0, (SCM lines, SCM book, SCM text, SCM first, SCM last),
- "Return a vector with line numbers of page breaks.")
+SCM
+Paper_book::pages ()
{
- Paper_book* b = unsmob_paper_book (book);
+ if (SCM_BOOL_F != pages_)
+ return pages_;
- SCM_ASSERT_TYPE (scm_pair_p (lines), lines, SCM_ARG1, __FUNCTION__, "list");
- SCM_ASSERT_TYPE (b, book, SCM_ARG2, __FUNCTION__, "Paper_book");
- SCM_ASSERT_TYPE (ly_c_number_p (text), text, SCM_ARG3, __FUNCTION__, "number");
- SCM_ASSERT_TYPE (ly_c_number_p (first), first, SCM_ARG4, __FUNCTION__, "number");
- SCM_ASSERT_TYPE (ly_c_number_p (last), last, SCM_ARG5, __FUNCTION__, "number");
+ pages_ = SCM_EOL;
+ SCM proc = paper_->c_variable ("page-breaking-wrapper");
+ pages_ = scm_apply_0 (proc, scm_list_1 (self_scm ()));
- return c_ragged_page_breaks (lines, b,
- ly_scm2double (text),
- ly_scm2double (first), ly_scm2double (last));
-}
+ /* set systems_ from the pages */
+ if (systems_ == SCM_BOOL_F)
+ {
+ 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));
+ }
+ }
-Score_lines::Score_lines ()
-{
- lines_ = SCM_EOL;
- header_ = SCM_EOL;
+ return pages_;
}
-void
-Score_lines::gc_mark ()
+SCM
+Paper_book::performances () const
{
- scm_gc_mark (lines_);
- scm_gc_mark (header_);
+ return scm_reverse (performances_);
}
-