lily/paper-book.cc

   1 /*
   2   paper-book.cc -- implement Paper_book
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2004 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #include "ly-module.hh"
  10 #include "main.hh"
  11 #include "page.hh"
  12 #include "paper-book.hh"
  13 #include "paper-def.hh"
  14 #include "paper-outputter.hh"
  15 #include "paper-line.hh"
  16 #include "paper-score.hh"
  17 #include "stencil.hh"
  18 #include "warn.hh"
  19 #include "book-paper-def.hh"
  20
  21 // JUNKME
  22 SCM
  23 stencil2line (Stencil stil, bool is_title = false)
  24 {
  25   static SCM z;
  26   if (!z)
  27     z = scm_permanent_object (ly_offset2scm (Offset (0, 0)));
  28   Offset dim = Offset (stil.extent (X_AXIS).length (),
  29                        stil.extent (Y_AXIS).length ());
  30   Paper_line *pl = new Paper_line (dim, scm_cons (stil.smobbed_copy (),
  31                                                   SCM_EOL),
  32                                    -10001 * is_title, is_title);
  33
  34   return scm_gc_unprotect_object (pl->self_scm ());
  35 }
  36
  37
  38 Paper_book::Paper_book ()
  39 {
  40   copyright_ = SCM_EOL;
  41   tagline_ = SCM_EOL;
  42   bookpaper_ = 0;
  43   smobify_self ();
  44 }
  45
  46 Paper_book::~Paper_book ()
  47 {
  48 }
  49
  50 #include "ly-smobs.icc"
  51
  52 IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
  53 IMPLEMENT_SMOBS (Paper_book)
  54 IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?")
  55
  56 SCM
  57 Paper_book::mark_smob (SCM smob)
  58 {
  59   Paper_book *b = (Paper_book*) SCM_CELL_WORD_1 (smob);
  60   for (int i = 0; i < b->score_lines_.size (); i++)
  61     b->score_lines_[i].gc_mark ();
  62
  63   scm_gc_mark (b->copyright_);
  64   if (b->bookpaper_)
  65     scm_gc_mark (b->bookpaper_->self_scm ());
  66
  67   return b->tagline_;
  68 }
  69
  70 int
  71 Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
  72 {
  73   Paper_book *b = (Paper_book*) ly_cdr (smob);
  74
  75   scm_puts ("#<", port);
  76   scm_puts (classname (b), port);
  77   scm_puts (" ", port);
  78   //scm_puts (b->, port);
  79   scm_puts (">", port);
  80   return 1;
  81 }
  82
  83 void
  84 Paper_book::output (String outname)
  85 {
  86   if (!score_lines_.size ())
  87     // FIXME: no end-output?
  88     return;
  89
  90   /* Generate all stencils to trigger font loads.  */
  91   SCM pages = this->pages ();
  92
  93   Paper_def *paper = score_lines_[0].paper_;
  94   Paper_outputter *out = paper->get_paper_outputter (outname);
  95   int page_count = scm_ilength (pages);
  96   out->output_header (paper->bookpaper_, scopes (0), page_count, false);
  97
  98   for (SCM s = pages; s != SCM_EOL; s = ly_cdr (s))
  99     {
 100       Page *p = unsmob_page (ly_car (s));
 101       progress_indication ("[" + to_string (p->number_));
 102       out->output_page (p, ly_cdr (s) == SCM_EOL);
 103       progress_indication ("]");
 104     }
 105
 106   out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
 107   progress_indication ("\n");
 108 }
 109
 110 SCM
 111 Paper_book::scopes (int i)
 112 {
 113   return score_lines_[i].scopes ();
 114 }
 115
 116
 117 Stencil
 118 Paper_book::title (int i)
 119 {
 120   SCM user_title = bookpaper_->lookup_variable (ly_symbol2scm ("user-title"));
 121   SCM book_title = bookpaper_->lookup_variable (ly_symbol2scm ("book-title"));
 122   SCM score_title = bookpaper_->lookup_variable (ly_symbol2scm ("score-title"));
 123   SCM field = (i == 0 ? ly_symbol2scm ("bookTitle")
 124                : ly_symbol2scm ("scoreTitle"));
 125
 126   Stencil title;
 127   SCM scopes = this->scopes (i);
 128   SCM s = ly_modules_lookup (scopes, field);
 129   if (s != SCM_UNDEFINED && scm_variable_bound_p (s) == SCM_BOOL_T)
 130     title = *unsmob_stencil (scm_call_2 (user_title,
 131                                          score_lines_[0].paper_->self_scm (),
 132                                         scm_variable_ref (s)));
 133   else
 134     title = *unsmob_stencil (scm_call_2 (i == 0 ? book_title : score_title,
 135                                          score_lines_[0].paper_->self_scm (),
 136                                         scopes));
 137   if (!title.is_empty ())
 138     title.align_to (Y_AXIS, UP);
 139
 140   return title;
 141 }
 142
 143 void
 144 Paper_book::classic_output (String outname)
 145 {
 146   int count = score_lines_.size ();
 147   Paper_def * p = score_lines_.top ().paper_;
 148   Paper_outputter *out = p->get_paper_outputter (outname);
 149   out->output_header (p->bookpaper_, scopes (count - 1), 0, true);
 150
 151   SCM top_lines = score_lines_.top ().lines_;
 152   Paper_line *first = unsmob_paper_line (scm_vector_ref (top_lines,
 153                                                          scm_int2num (0)));
 154   Offset o (0, -0.5 * first->dim ()[Y_AXIS]);
 155   int line_count = SCM_VECTOR_LENGTH (top_lines);
 156   for (int i = 0; i < line_count; i++)
 157     {
 158       /* In classic compatibility TeX tracks how large things are, and
 159          advances the Y pos for us.  If we advance it too, we get too
 160          much space.
 161
 162          FIXME: vague... why is TeX is different from other ouput
 163                 backends, why not fix the TeX backend? -- jcn */
 164       if (output_format_global == "tex")
 165         o = Offset (0, 0);
 166
 167       out->output_line (scm_vector_ref (top_lines, scm_int2num (i)),
 168                         &o, i == line_count - 1);
 169     }
 170
 171   out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
 172   progress_indication ("\n");
 173 }
 174
 175 /* calculate book height, #lines, stencils.  */
 176 void
 177 Paper_book::init ()
 178 {
 179   int score_count = score_lines_.size ();
 180
 181   /* Calculate the full book height.  Hmm, can't we cache system
 182      heights while making stencils?  */
 183   height_ = 0;
 184   for (int i = 0; i < score_count; i++)
 185     {
 186       Stencil title = this->title (i);
 187       if (!title.is_empty ())
 188         height_ += title.extent (Y_AXIS).length ();
 189
 190       int line_count = SCM_VECTOR_LENGTH (score_lines_[i].lines_);
 191       for (int j = 0; j < line_count; j++)
 192         {
 193           SCM s = scm_vector_ref ((SCM) score_lines_[i].lines_, scm_int2num (j));
 194           height_ += unsmob_paper_line (s)->dim ()[Y_AXIS];
 195         }
 196     }
 197
 198   Paper_def *paper = score_lines_[0].paper_;
 199   SCM scopes = this->scopes (0);
 200
 201   SCM make_tagline = paper->c_variable ("make-tagline");
 202   tagline_ = scm_call_2 (make_tagline, paper->self_scm (), scopes);
 203   Real tag_height = 0;
 204   if (Stencil *s = unsmob_stencil (tagline_))
 205     tag_height = s->extent (Y_AXIS).length ();
 206   height_ += tag_height;
 207
 208   SCM make_copyright = paper->c_variable ("make-copyright");
 209   copyright_ = scm_call_2 (make_copyright, paper->self_scm (), scopes);
 210   Real copy_height = 0;
 211   if (Stencil *s = unsmob_stencil (copyright_))
 212     copy_height = s->extent (Y_AXIS).length ();
 213   height_ += copy_height;
 214 }
 215
 216 SCM
 217 Paper_book::lines ()
 218 {
 219   int score_count = score_lines_.size ();
 220   SCM lines = SCM_EOL;
 221   for (int i = 0; i < score_count; i++)
 222     {
 223       Stencil title = this->title (i);
 224       if (!title.is_empty ())
 225         lines = ly_snoc (stencil2line (title, true), lines);
 226       lines = scm_append (scm_list_2 (lines, scm_vector_to_list (score_lines_[i].lines_)));
 227     }
 228
 229   //debug helper; ughr
 230   int i = 0;
 231   for (SCM s = lines; s != SCM_EOL; s = ly_cdr (s))
 232     unsmob_paper_line (ly_car (s))->number_ = ++i;
 233   return lines;
 234 }
 235
 236 SCM
 237 Paper_book::pages ()
 238 {
 239   init ();
 240   Page::page_count_ = 0;
 241   Paper_def *paper = score_lines_[0].paper_;
 242   Page *page = new Page (paper, 1);
 243
 244   Real text_height = page->text_height ();
 245
 246   Real copy_height = 0;
 247   if (Stencil *s = unsmob_stencil (copyright_))
 248     copy_height = s->extent (Y_AXIS).length ();
 249
 250   Real tag_height = 0;
 251   if (Stencil *s = unsmob_stencil (tagline_))
 252     tag_height = s->extent (Y_AXIS).length ();
 253
 254   SCM all = lines ();
 255   SCM proc = paper->c_variable ("page-breaking");
 256   SCM breaks = scm_apply_0 (proc, scm_list_n (all, scm_make_real (height_),
 257                                               scm_make_real (text_height),
 258                                               scm_make_real (-copy_height),
 259                                               scm_make_real (-tag_height),
 260                                               SCM_UNDEFINED));
 261
 262   /* Copyright on first page.  */
 263   if (unsmob_stencil (copyright_))
 264     page->copyright_ = copyright_;
 265
 266   SCM pages = SCM_EOL;
 267   int page_count = SCM_VECTOR_LENGTH ((SCM) breaks);
 268   int line = 1;
 269   for (int i = 0; i < page_count; i++)
 270     {
 271       if (i)
 272         page = new Page (paper, i + 1);
 273
 274       int next = i + 1 < page_count
 275         ? ly_scm2int (scm_vector_ref (breaks, scm_int2num (i))) : 0;
 276       while ((!next && all != SCM_EOL) || line <= next)
 277         {
 278           SCM s = ly_car (all);
 279           page->lines_ = ly_snoc (s, page->lines_);
 280           page->height_ += unsmob_paper_line (s)->dim ()[Y_AXIS];
 281           page->line_count_++;
 282           all = ly_cdr (all);
 283           line++;
 284         }
 285       pages = scm_cons (page->self_scm (), pages);
 286     }
 287
 288   /* Tagline on last page.  */
 289   if (unsmob_stencil (tagline_))
 290     page->tagline_ = tagline_;
 291
 292   return scm_reverse (pages);
 293 }
 294
 295 static SCM
 296 c_ragged_page_breaks (SCM lines, Real book_height, Real text_height,
 297                       Real first, Real last)
 298 {
 299   int page_number = 0;
 300   int page_count = int (book_height / text_height + 0.5);
 301   SCM breaks = SCM_EOL;
 302   Real page_height = text_height + first;
 303   Real h = 0;
 304   int number = 0;
 305   for (SCM s = lines; s != SCM_EOL; s = ly_cdr (s))
 306     {
 307       Paper_line *pl = unsmob_paper_line (ly_car (s));
 308       if (!pl->is_title () && h < page_height)
 309         number++;
 310       h += pl->dim ()[Y_AXIS];
 311       if (!pl->is_title () && h > page_height)
 312         {
 313           breaks = ly_snoc (scm_int2num (number), breaks);
 314           page_number++;
 315           page_height = text_height + (page_number == page_count) * last;
 316           h = 0;
 317         }
 318       if (ly_cdr (s) == SCM_EOL)
 319         breaks = ly_snoc (scm_int2num (pl->number_), breaks);
 320     }
 321
 322   return scm_vector (breaks);
 323 }
 324
 325 LY_DEFINE (ly_ragged_page_breaks, "ly:ragged-page-breaks",
 326            5, 0, 0, (SCM lines, SCM book, SCM text, SCM first, SCM last),
 327            "Return a vector with line numbers of page breaks.")
 328 {
 329   SCM_ASSERT_TYPE (scm_pair_p (lines), lines, SCM_ARG1, __FUNCTION__, "list");
 330   SCM_ASSERT_TYPE (ly_c_number_p (book), book, SCM_ARG2, __FUNCTION__, "real");
 331   SCM_ASSERT_TYPE (ly_c_number_p (text), text, SCM_ARG2, __FUNCTION__, "real");
 332   SCM_ASSERT_TYPE (ly_c_number_p (first), first, SCM_ARG2, __FUNCTION__, "real");
 333   SCM_ASSERT_TYPE (ly_c_number_p (last), last, SCM_ARG2, __FUNCTION__, "real");
 334
 335   return c_ragged_page_breaks (lines,
 336                                ly_scm2double (book), ly_scm2double (text),
 337                                ly_scm2double (first), ly_scm2double (last));
 338 }
 339
 340 /****************************************************************/
 341
 342 Score_lines::Score_lines ()
 343 {
 344   lines_ = SCM_EOL;
 345   global_header_ = SCM_EOL;
 346   header_ = SCM_EOL;
 347   paper_ = 0;
 348 }
 349
 350 void
 351 Score_lines::gc_mark ()
 352 {
 353   scm_gc_mark (lines_);
 354   scm_gc_mark (global_header_);
 355   scm_gc_mark (header_);
 356   if (paper_)
 357     scm_gc_mark (paper_->self_scm ());
 358 }
 359
 360
 361 SCM
 362 Score_lines::scopes ()
 363 {
 364   SCM scopes = SCM_EOL;
 365   if (header_)
 366     scopes = scm_cons (header_, scopes);
 367   if (SCM_MODULEP(global_header_)
 368       && global_header_ != header_)
 369     scopes = scm_cons (global_header_, scopes);
 370
 371   return scopes;
 372 }