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 "output-def.hh"
  12 #include "paper-book.hh"
  13 #include "paper-outputter.hh"
  14 #include "paper-score.hh"
  15 #include "paper-system.hh"
  16 #include "stencil.hh"
  17 #include "warn.hh"
  18
  19 #include "ly-smobs.icc"
  20
  21 Paper_book::Paper_book ()
  22 {
  23   pages_ = SCM_BOOL_F;
  24   systems_ = SCM_BOOL_F;
  25   header_ = SCM_EOL;
  26
  27   bookpaper_ = 0;
  28   smobify_self ();
  29 }
  30
  31 Paper_book::~Paper_book ()
  32 {
  33 }
  34
  35 IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
  36 IMPLEMENT_SMOBS (Paper_book)
  37 IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?")
  38
  39 SCM
  40 Paper_book::mark_smob (SCM smob)
  41 {
  42   Paper_book *b = (Paper_book*) SCM_CELL_WORD_1 (smob);
  43   for (int i = 0; i < b->score_systems_.size (); i++)
  44     b->score_systems_[i].gc_mark ();
  45
  46   if (b->bookpaper_)
  47     scm_gc_mark (b->bookpaper_->self_scm ());
  48   scm_gc_mark (b->header_);
  49   scm_gc_mark (b->pages_);
  50   return b->systems_;
  51 }
  52
  53 int
  54 Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
  55 {
  56   Paper_book *b = (Paper_book*) SCM_CELL_WORD_1 (smob);
  57
  58   scm_puts ("#<", port);
  59   scm_puts (classname (b), port);
  60   scm_puts (" ", port);
  61   //scm_puts (b->, port);
  62   scm_puts (">", port);
  63   return 1;
  64 }
  65
  66 Array<String>
  67 split_string (String s, char c)
  68 {
  69   Array<String> rv;
  70   while (s.length ())
  71     {
  72       int i = s.index (c);
  73
  74       if (i == 0)
  75         {
  76           s = s.nomid_string (0, 1);
  77           continue;
  78         }
  79
  80       if (i < 0)
  81         i = s.length () ;
  82
  83       rv.push (s.cut_string (0, i));
  84       s = s.nomid_string (0, i);
  85     }
  86
  87   return rv;
  88 }
  89
  90 SCM
  91 dump_fields ()
  92 {
  93   SCM fields = SCM_EOL;
  94   for (int i = dump_header_fieldnames_global.size (); i--; )
  95     fields
  96       = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].to_str0 ()),
  97                   fields);
  98   return fields;
  99 }
 100
 101 LY_DEFINE (ly_output_formats, "ly:output-formats",
 102            0, 0, 0, (),
 103            "Formats passed to --format as a list of strings, "
 104            "used for the output.")
 105 {
 106   Array<String> output_formats = split_string (output_format_global, ',');
 107
 108   SCM lst = SCM_EOL;
 109   int output_formats_count = output_formats.size ();
 110   for (int i = 0; i < output_formats_count; i ++)
 111     lst = scm_cons (scm_makfrom0str (output_formats[i].to_str0 ()), lst);
 112
 113   return lst;
 114 }
 115
 116 void
 117 Paper_book::post_processing (SCM module,
 118                              SCM file_name)
 119 {
 120   struct
 121   {
 122     bool do_it_;
 123     char const *func_name_;
 124   } settings[] = {
 125     {make_tex, "convert-to-tex"},
 126     {make_dvi, "convert-to-dvi"},
 127     {make_ps, "convert-to-ps"},
 128     {make_pdf, "convert-to-pdf"},
 129     {make_png, "convert-to-png"},
 130     {0,0}
 131   };
 132
 133   for (int i= 0; settings[i].func_name_; i++)
 134     {
 135       if (settings[i].do_it_)
 136         {
 137           SCM func = scm_c_module_lookup (module, settings[i].func_name_);
 138           if (scm_variable_p (func) == SCM_BOOL_T)
 139             {
 140               func = scm_variable_ref (func);
 141               if (ly_c_procedure_p (func))
 142                 scm_call_2 (func, self_scm(), file_name);
 143             }
 144         }
 145     }
 146 }
 147
 148 void
 149 Paper_book::output (String outname)
 150 {
 151   if (!score_systems_.size ())
 152     return;
 153
 154   /* Generate all stencils to trigger font loads.  */
 155   pages ();
 156
 157   SCM formats = ly_output_formats ();
 158   for (SCM s = formats; scm_is_pair (s); s = scm_cdr (s))
 159     {
 160       String format = ly_scm2string (scm_car (s));
 161       String file_name = outname;
 162
 163       if (file_name != "-")
 164         file_name += "." + format;
 165
 166       Paper_outputter *out = get_paper_outputter (file_name, format);
 167
 168       SCM scopes = SCM_EOL;
 169       if (ly_c_module_p (header_))
 170         scopes = scm_cons (header_, scopes);
 171
 172       String mod_nm = "scm framework-" + format;
 173
 174       SCM mod = scm_c_resolve_module (mod_nm.to_str0 ());
 175       SCM func = scm_c_module_lookup (mod, "output-framework");
 176
 177       func = scm_variable_ref (func);
 178       scm_apply_0 (func, scm_list_n (out->self_scm (),
 179                                      self_scm (),
 180                                      scopes,
 181                                      dump_fields (),
 182                                      scm_makfrom0str (outname.to_str0 ()),
 183                                      SCM_UNDEFINED));
 184       out->close ();
 185       scm_gc_unprotect_object (out->self_scm ());
 186
 187       post_processing (mod, scm_makfrom0str (file_name.to_str0 ()));
 188
 189       if (make_preview)
 190         {
 191           String file_name = outname + ".preview." + format;
 192           Paper_outputter *out = get_paper_outputter (file_name, format);
 193
 194           SCM func = scm_c_module_lookup (mod, "output-preview-framework");
 195           func = scm_variable_ref (func);
 196           scm_apply_0 (func, scm_list_n (out->self_scm (),
 197                                          self_scm (),
 198                                          scopes,
 199                                          dump_fields (),
 200                                          scm_makfrom0str (outname.to_str0 ()),
 201                                          SCM_UNDEFINED));
 202
 203           out->close ();
 204           scm_gc_unprotect_object (out->self_scm ());
 205
 206           post_processing (mod, scm_makfrom0str (file_name.to_str0 ()));
 207         }
 208
 209       progress_indication ("\n");
 210     }
 211 }
 212
 213 void
 214 Paper_book::classic_output (String outname)
 215 {
 216   /* Generate all stencils to trigger font loads.  */
 217   systems ();
 218
 219   // ugh code dup
 220   SCM scopes = SCM_EOL;
 221   if (ly_c_module_p (header_))
 222     scopes = scm_cons (header_, scopes);
 223
 224   if (ly_c_module_p (score_systems_[0].header_))
 225     scopes = scm_cons (score_systems_[0].header_, scopes);
 226   //end ugh
 227
 228   Array<String> output_formats = split_string (output_format_global, ',');
 229
 230   for (int i = 0; i < output_formats.size (); i++)
 231     {
 232       String format = output_formats[i];
 233       String mod_nm = "scm framework-" + format;
 234
 235       SCM mod = scm_c_resolve_module (mod_nm.to_str0 ());
 236       SCM func = scm_c_module_lookup (mod, "output-classic-framework");
 237
 238       func = scm_variable_ref (func);
 239
 240       Paper_outputter *out = get_paper_outputter (outname + "." + format,
 241                                                   format);
 242
 243       scm_apply_0 (func, scm_list_n (out->self_scm (), self_scm (), scopes,
 244                                      dump_fields (),
 245                                      scm_makfrom0str (outname.to_str0 ()),
 246                                      SCM_UNDEFINED));
 247
 248       scm_gc_unprotect_object (out->self_scm ());
 249       progress_indication ("\n");
 250     }
 251 }
 252
 253 LY_DEFINE (ly_paper_book_pages, "ly:paper-book-pages",
 254           1, 0, 0, (SCM pb),
 255           "Return pages in book PB.")
 256 {
 257   return unsmob_paper_book(pb)->pages ();
 258 }
 259
 260 LY_DEFINE (ly_paper_book_scopes, "ly:paper-book-scopes",
 261           1, 0, 0, (SCM book),
 262           "Return pages in paper book @var{book}.")
 263 {
 264   Paper_book *pb = unsmob_paper_book(book);
 265   SCM_ASSERT_TYPE(pb, book, SCM_ARG1, __FUNCTION__, "Paper_book");
 266
 267   SCM scopes = SCM_EOL;
 268   if (ly_c_module_p (pb->header_))
 269     scopes = scm_cons (pb->header_, scopes);
 270
 271   return scopes;
 272 }
 273
 274 LY_DEFINE (ly_paper_book_systems, "ly:paper-book-systems",
 275            1, 0, 0, (SCM pb),
 276            "Return systems in book PB.")
 277 {
 278   return unsmob_paper_book (pb)->systems ();
 279 }
 280
 281 LY_DEFINE (ly_paper_book_book_paper, "ly:paper-book-book-paper",
 282           1, 0, 0, (SCM pb),
 283           "Return pages in book PB.")
 284 {
 285   return unsmob_paper_book (pb)->bookpaper_->self_scm ();
 286 }
 287
 288 /* TODO: resurrect more complex user-tweaks for titling?  */
 289 Stencil
 290 Paper_book::book_title ()
 291 {
 292   SCM title_func = bookpaper_->lookup_variable (ly_symbol2scm ("book-title"));
 293   Stencil title;
 294
 295   SCM scopes = SCM_EOL;
 296   if (ly_c_module_p (header_))
 297     scopes = scm_cons (header_, scopes);
 298
 299
 300   SCM tit = SCM_EOL;
 301   if (ly_c_procedure_p (title_func))
 302     tit = scm_call_2 (title_func,
 303                      bookpaper_->self_scm (),
 304                      scopes);
 305
 306   if (unsmob_stencil (tit))
 307     title = *unsmob_stencil (tit);
 308
 309   if (!title.is_empty ())
 310     title.align_to (Y_AXIS, UP);
 311
 312   return title;
 313 }
 314
 315 Stencil
 316 Paper_book::score_title (int i)
 317 {
 318   SCM title_func = bookpaper_->lookup_variable (ly_symbol2scm ("score-title"));
 319
 320   Stencil title;
 321
 322   // ugh code dup
 323   SCM scopes = SCM_EOL;
 324   if (ly_c_module_p (header_))
 325     scopes = scm_cons (header_, scopes);
 326
 327   if (ly_c_module_p (score_systems_[i].header_))
 328     scopes = scm_cons (score_systems_[i].header_, scopes);
 329   //end ugh
 330
 331   SCM tit = SCM_EOL;
 332   if (ly_c_procedure_p (title_func))
 333     tit = scm_call_2 (title_func,
 334                      bookpaper_->self_scm (),
 335                      scopes);
 336
 337   if (unsmob_stencil (tit))
 338     title = *unsmob_stencil (tit);
 339
 340   if (!title.is_empty ())
 341     title.align_to (Y_AXIS, UP);
 342
 343   return title;
 344 }
 345
 346 SCM
 347 Paper_book::systems ()
 348 {
 349   if (systems_ != SCM_BOOL_F)
 350     return systems_;
 351
 352   systems_ = SCM_EOL;
 353   Stencil title = book_title ();
 354
 355   if (!title.is_empty ())
 356     {
 357       Paper_system *ps = new Paper_system (title, true);
 358       systems_ = scm_cons (ps->self_scm (), systems_);
 359       scm_gc_unprotect_object (ps->self_scm ());
 360     }
 361
 362   int score_count = score_systems_.size ();
 363   for (int i = 0; i < score_count; i++)
 364     {
 365       Stencil title = score_title (i);
 366       if (!title.is_empty ())
 367         {
 368           Paper_system *ps = new Paper_system (title, true);
 369           systems_ = scm_cons (ps->self_scm (), systems_);
 370           scm_gc_unprotect_object (ps->self_scm ());
 371         }
 372
 373       if (scm_vector_p (score_systems_[i].systems_) == SCM_BOOL_T)
 374         {
 375           // guh.
 376           SCM system_list = scm_vector_to_list (score_systems_[i].systems_);
 377
 378           system_list = scm_reverse (system_list);
 379           systems_ = scm_append (scm_list_2 (system_list, systems_));
 380         }
 381     }
 382
 383   systems_ = scm_reverse (systems_);
 384
 385   int i = 0;
 386   Paper_system *last = 0;
 387   for (SCM s = systems_; s != SCM_EOL; s = scm_cdr (s))
 388     {
 389       Paper_system *ps = unsmob_paper_system (scm_car (s));
 390       ps->number_ = ++i;
 391
 392       if (last && last->is_title ())
 393         // ugh, hardcoded.
 394         ps->penalty_ = 10000;
 395       last = ps;
 396     }
 397
 398   return systems_;
 399 }
 400
 401 SCM
 402 Paper_book::pages ()
 403 {
 404   if (SCM_BOOL_F != pages_)
 405     return pages_;
 406
 407   pages_ = SCM_EOL;
 408   SCM proc = bookpaper_->c_variable ("page-breaking");
 409   pages_ = scm_apply_0 (proc, scm_list_2 (systems (), self_scm ()));
 410   return pages_;
 411 }
 412
 413
 414 /****************************************************************/
 415
 416 Score_systems::Score_systems ()
 417 {
 418   systems_ = SCM_EOL;
 419   header_ = SCM_EOL;
 420 }
 421
 422 void
 423 Score_systems::gc_mark ()
 424 {
 425   scm_gc_mark (systems_);
 426   scm_gc_mark (header_);
 427 }
 428