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--2005 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #include "paper-book.hh"
  10
  11 #include "main.hh"
  12 #include "output-def.hh"
  13 #include "paper-score.hh"
  14 #include "paper-system.hh"
  15 #include "text-interface.hh"
  16 #include "warn.hh"
  17
  18 #include "ly-smobs.icc"
  19
  20 Paper_book::Paper_book ()
  21 {
  22   header_ = SCM_EOL;
  23   header_0_ = SCM_EOL;
  24   pages_ = SCM_BOOL_F;
  25   scores_ = SCM_EOL;
  26   performances_ = SCM_EOL;
  27   systems_ = SCM_BOOL_F;
  28
  29   paper_ = 0;
  30   smobify_self ();
  31 }
  32
  33 Paper_book::~Paper_book ()
  34 {
  35 }
  36
  37 IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
  38 IMPLEMENT_SMOBS (Paper_book);
  39 IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?");
  40
  41 SCM
  42 Paper_book::mark_smob (SCM smob)
  43 {
  44   Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
  45   if (b->paper_)
  46     scm_gc_mark (b->paper_->self_scm ());
  47   scm_gc_mark (b->header_);
  48   scm_gc_mark (b->header_0_);
  49   scm_gc_mark (b->pages_);
  50   scm_gc_mark (b->performances_);
  51   scm_gc_mark (b->scores_);
  52   return b->systems_;
  53 }
  54
  55 int
  56 Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
  57 {
  58   Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
  59
  60   scm_puts ("#<Paper_book>", port);
  61   return 1;
  62 }
  63
  64 SCM
  65 dump_fields ()
  66 {
  67   SCM fields = SCM_EOL;
  68   for (int i = dump_header_fieldnames_global.size (); i--;)
  69     fields
  70       = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].to_str0 ()),
  71                   fields);
  72   return fields;
  73 }
  74
  75 void
  76 Paper_book::add_score (SCM s)
  77 {
  78   scores_ = scm_cons (s, scores_);
  79 }
  80
  81 void
  82 Paper_book::add_performance (SCM s)
  83 {
  84   performances_ = scm_cons (s, performances_);
  85 }
  86
  87 void
  88 Paper_book::output (SCM output_channel)
  89 {
  90   if (scm_is_pair (performances_))
  91     {
  92       SCM proc = ly_lily_module_constant ("paper-book-write-midis");
  93
  94       scm_call_2 (proc, self_scm (), output_channel);
  95     }
  96
  97   if (scores_ == SCM_EOL)
  98     return;
  99
 100   /* Generate all stencils to trigger font loads.  */
 101   pages ();
 102
 103   SCM scopes = SCM_EOL;
 104   if (ly_is_module (header_))
 105     scopes = scm_cons (header_, scopes);
 106
 107   String mod_nm = "scm framework-" + output_backend_global;
 108
 109   SCM mod = scm_c_resolve_module (mod_nm.to_str0 ());
 110   if (make_print)
 111     {
 112       SCM func = scm_c_module_lookup (mod, "output-framework");
 113
 114       func = scm_variable_ref (func);
 115       scm_apply_0 (func, scm_list_n (output_channel,
 116                                      self_scm (),
 117                                      scopes,
 118                                      dump_fields (),
 119                                      SCM_UNDEFINED));
 120     }
 121
 122   if (make_preview)
 123     {
 124       SCM func = scm_c_module_lookup (mod, "output-preview-framework");
 125       func = scm_variable_ref (func);
 126       scm_apply_0 (func, scm_list_n (output_channel,
 127                                      self_scm (),
 128                                      scopes,
 129                                      dump_fields (),
 130                                      SCM_UNDEFINED));
 131     }
 132 }
 133
 134 void
 135 Paper_book::classic_output (SCM output)
 136 {
 137   /* Generate all stencils to trigger font loads.  */
 138   systems ();
 139
 140   SCM scopes = SCM_EOL;
 141   if (ly_is_module (header_))
 142     scopes = scm_cons (header_, scopes);
 143
 144   if (ly_is_module (header_0_))
 145     scopes = scm_cons (header_0_, scopes);
 146
 147   String format = output_backend_global;
 148   String mod_nm = "scm framework-" + format;
 149
 150   SCM mod = scm_c_resolve_module (mod_nm.to_str0 ());
 151   SCM func = scm_c_module_lookup (mod, "output-classic-framework");
 152
 153   func = scm_variable_ref (func);
 154   scm_apply_0 (func, scm_list_n (output,
 155                                  self_scm (),
 156                                  scopes,
 157                                  dump_fields (),
 158                                  SCM_UNDEFINED));
 159
 160   progress_indication ("\n");
 161 }
 162
 163 /* TODO: resurrect more complex user-tweaks for titling?  */
 164 Stencil
 165 Paper_book::book_title ()
 166 {
 167   SCM title_func = paper_->lookup_variable (ly_symbol2scm ("book-title"));
 168   Stencil title;
 169
 170   SCM scopes = SCM_EOL;
 171   if (ly_is_module (header_))
 172     scopes = scm_cons (header_, scopes);
 173
 174   SCM tit = SCM_EOL;
 175   if (ly_is_procedure (title_func))
 176     tit = scm_call_2 (title_func,
 177                       paper_->self_scm (),
 178                       scopes);
 179
 180   if (unsmob_stencil (tit))
 181     title = *unsmob_stencil (tit);
 182
 183   if (!title.is_empty ())
 184     title.align_to (Y_AXIS, UP);
 185
 186   return title;
 187 }
 188
 189 Stencil
 190 Paper_book::score_title (SCM header)
 191 {
 192   SCM title_func = paper_->lookup_variable (ly_symbol2scm ("score-title"));
 193
 194   Stencil title;
 195
 196   SCM scopes = SCM_EOL;
 197   if (ly_is_module (header_))
 198     scopes = scm_cons (header_, scopes);
 199
 200   if (ly_is_module (header))
 201     scopes = scm_cons (header, scopes);
 202
 203   SCM tit = SCM_EOL;
 204   if (ly_is_procedure (title_func))
 205     tit = scm_call_2 (title_func,
 206                       paper_->self_scm (),
 207                       scopes);
 208
 209   if (unsmob_stencil (tit))
 210     title = *unsmob_stencil (tit);
 211
 212   if (!title.is_empty ())
 213     title.align_to (Y_AXIS, UP);
 214
 215   return title;
 216 }
 217
 218 void
 219 set_system_penalty (Paper_system *ps, SCM header)
 220 {
 221   if (ly_is_module (header))
 222     {
 223       SCM force = ly_module_lookup (header, ly_symbol2scm ("breakbefore"));
 224       if (SCM_VARIABLEP (force)
 225           && scm_is_bool (SCM_VARIABLE_REF (force)))
 226         {
 227           ps->set_property ("penalty",
 228                             scm_from_int(to_boolean (SCM_VARIABLE_REF (force))
 229                                          ? -10000
 230                                          : 10000));
 231         }
 232     }
 233 }
 234
 235 void
 236 Paper_book::add_score_title (SCM header)
 237 {
 238   Stencil title = score_title (header);
 239   if (title.is_empty ())
 240     title = score_title (header_);
 241   if (!title.is_empty ())
 242     {
 243       /*
 244         TODO: this should come from the \layout {} block, which should
 245         override settings from \paper {}
 246       */
 247       SCM props = paper_->lookup_variable (ly_symbol2scm ("score-title-properties"));
 248       Paper_system *ps = new Paper_system (title, props);
 249       ps->unprotect ();
 250       set_system_penalty (ps, header);
 251     }
 252 }
 253
 254 SCM
 255 Paper_book::systems ()
 256 {
 257   if (systems_ != SCM_BOOL_F)
 258     return systems_;
 259
 260   systems_ = SCM_EOL;
 261   Stencil title = book_title ();
 262
 263   if (!title.is_empty ())
 264     {
 265       SCM props = paper_->lookup_variable (ly_symbol2scm ("book-title-properties"));
 266       Paper_system *ps = new Paper_system (title, props);
 267       set_system_penalty (ps, header_);
 268
 269       systems_ = scm_cons (ps->self_scm (), systems_);
 270       ps->unprotect ();
 271     }
 272
 273   SCM page_properties
 274     = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
 275                   paper_->self_scm ());
 276
 277   SCM header = SCM_EOL;
 278   for (SCM s = scm_reverse (scores_); s != SCM_EOL; s = scm_cdr (s))
 279     {
 280       if (ly_is_module (scm_car (s)))
 281         {
 282           header = scm_car (s);
 283           if (header_0_ == SCM_EOL)
 284             header_0_ = header;
 285         }
 286       else if (Music_output *mop = unsmob_music_output (scm_car (s)))
 287
 288         {
 289           if (Paper_score *pscore = dynamic_cast<Paper_score *> (mop))
 290             {
 291               add_score_title (header);
 292
 293               header = SCM_EOL;
 294
 295               SCM system_list = scm_vector_to_list (pscore->get_paper_systems ());
 296               system_list = scm_reverse (system_list);
 297               systems_ = scm_append (scm_list_2 (system_list, systems_));
 298             }
 299           else
 300             {
 301               /*
 302                 Ignore MIDI
 303               */
 304             }
 305         }
 306       else if (scm_is_vector (scm_car (s)))
 307         {
 308           /*
 309             UGH. code dup.
 310           */
 311           add_score_title (header);
 312           header = SCM_EOL;
 313
 314           SCM system_list = scm_vector_to_list (scm_car (s));
 315           system_list = scm_reverse (system_list);
 316           systems_ = scm_append (scm_list_2 (system_list, systems_));
 317         }
 318       else if (Text_interface::is_markup (scm_car (s)))
 319         {
 320           SCM t = Text_interface::interpret_markup (paper_->self_scm (),
 321                                                     page_properties,
 322                                                     scm_car (s));
 323
 324           // TODO: init props
 325           Paper_system *ps = new Paper_system (*unsmob_stencil (t), SCM_EOL);
 326           ps->set_property ("is-title", SCM_BOOL_T);
 327           systems_ = scm_cons (ps->self_scm (), systems_);
 328           ps->unprotect ();
 329
 330           // FIXME: figure out penalty.
 331           //set_system_penalty (ps, scores_[i].header_);
 332         }
 333       else
 334         assert (0);
 335     }
 336
 337   systems_ = scm_reverse (systems_);
 338
 339   int i = 0;
 340   Paper_system *last = 0;
 341   for (SCM s = systems_; s != SCM_EOL; s = scm_cdr (s))
 342     {
 343       Paper_system *ps = unsmob_paper_system (scm_car (s));
 344       ps->set_property ("number", scm_from_int (++i));
 345
 346       if (last
 347           && to_boolean (last->get_property ("is-title"))
 348           && !scm_is_number (ps->get_property ("penalty")))
 349         ps->set_property ("penalty", scm_from_int (10000));
 350       last = ps;
 351     }
 352
 353   return systems_;
 354 }
 355
 356 SCM
 357 Paper_book::pages ()
 358 {
 359   if (SCM_BOOL_F != pages_)
 360     return pages_;
 361
 362   pages_ = SCM_EOL;
 363   SCM proc = paper_->c_variable ("page-breaking");
 364   pages_ = scm_apply_0 (proc, scm_list_2 (systems (), self_scm ()));
 365   return pages_;
 366 }
 367
 368 SCM
 369 Paper_book::performances () const
 370 {
 371   return scm_reverse (performances_);
 372 }