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