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-item.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   systems_ = SCM_BOOL_F;
  27
  28   paper_ = 0;
  29   smobify_self ();
  30 }
  31
  32 Paper_book::~Paper_book ()
  33 {
  34 }
  35
  36 IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
  37 IMPLEMENT_SMOBS (Paper_book)
  38   IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?")
  39
  40   SCM
  41 Paper_book::mark_smob (SCM smob)
  42 {
  43   Paper_book *b = (Paper_book *) SCM_CELL_WORD_1 (smob);
  44   if (b->paper_)
  45     scm_gc_mark (b->paper_->self_scm ());
  46   scm_gc_mark (b->header_);
  47   scm_gc_mark (b->header_0_);
  48   scm_gc_mark (b->pages_);
  49   scm_gc_mark (b->scores_);
  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 (">", port);
  62   return 1;
  63 }
  64
  65 SCM
  66 dump_fields ()
  67 {
  68   SCM fields = SCM_EOL;
  69   for (int i = dump_header_fieldnames_global.size (); i--;)
  70     fields
  71       = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].to_str0 ()),
  72                   fields);
  73   return fields;
  74 }
  75
  76 void
  77 Paper_book::add_score (SCM s)
  78 {
  79   scores_ = scm_cons (s, scores_);
  80 }
  81
  82 void
  83 Paper_book::output (String outname)
  84 {
  85   if (scores_ == SCM_EOL)
  86     return;
  87
  88   /* Generate all stencils to trigger font loads.  */
  89   pages ();
  90
  91   SCM scopes = SCM_EOL;
  92   if (ly_c_module_p (header_))
  93     scopes = scm_cons (header_, scopes);
  94
  95   String mod_nm = "scm framework-" + output_backend_global;
  96
  97   SCM mod = scm_c_resolve_module (mod_nm.to_str0 ());
  98   if (make_pages)
  99     {
 100       SCM func = scm_c_module_lookup (mod, "output-framework");
 101
 102       func = scm_variable_ref (func);
 103       scm_apply_0 (func, scm_list_n (scm_makfrom0str (outname.to_str0 ()),
 104                                      self_scm (),
 105                                      scopes,
 106                                      dump_fields (),
 107                                      SCM_UNDEFINED));
 108     }
 109
 110   if (make_preview)
 111     {
 112       SCM func = scm_c_module_lookup (mod, "output-preview-framework");
 113       func = scm_variable_ref (func);
 114       scm_apply_0 (func, scm_list_n (scm_makfrom0str (outname.to_str0 ()),
 115                                      self_scm (),
 116                                      scopes,
 117                                      dump_fields (),
 118                                      SCM_UNDEFINED));
 119     }
 120   progress_indication ("\n");
 121 }
 122
 123 void
 124 Paper_book::classic_output (String outname)
 125 {
 126   /* Generate all stencils to trigger font loads.  */
 127   systems ();
 128
 129   SCM scopes = SCM_EOL;
 130   if (ly_c_module_p (header_))
 131     scopes = scm_cons (header_, scopes);
 132
 133   if (ly_c_module_p (header_0_))
 134     scopes = scm_cons (header_0_, scopes);
 135
 136   String format = output_backend_global;
 137   String mod_nm = "scm framework-" + format;
 138
 139   SCM mod = scm_c_resolve_module (mod_nm.to_str0 ());
 140   SCM func = scm_c_module_lookup (mod, "output-classic-framework");
 141
 142   func = scm_variable_ref (func);
 143   scm_apply_0 (func, scm_list_n (scm_makfrom0str (outname.to_str0 ()),
 144                                  self_scm (),
 145                                  scopes,
 146                                  dump_fields (),
 147                                  SCM_UNDEFINED));
 148
 149   progress_indication ("\n");
 150 }
 151
 152 /* TODO: resurrect more complex user-tweaks for titling?  */
 153 Stencil
 154 Paper_book::book_title ()
 155 {
 156   SCM title_func = paper_->lookup_variable (ly_symbol2scm ("book-title"));
 157   Stencil title;
 158
 159   SCM scopes = SCM_EOL;
 160   if (ly_c_module_p (header_))
 161     scopes = scm_cons (header_, scopes);
 162
 163   SCM tit = SCM_EOL;
 164   if (ly_c_procedure_p (title_func))
 165     tit = scm_call_2 (title_func,
 166                       paper_->self_scm (),
 167                       scopes);
 168
 169   if (unsmob_stencil (tit))
 170     title = *unsmob_stencil (tit);
 171
 172   if (!title.is_empty ())
 173     title.align_to (Y_AXIS, UP);
 174
 175   return title;
 176 }
 177
 178 Stencil
 179 Paper_book::score_title (SCM header)
 180 {
 181   SCM title_func = paper_->lookup_variable (ly_symbol2scm ("score-title"));
 182
 183   Stencil title;
 184
 185   SCM scopes = SCM_EOL;
 186   if (ly_c_module_p (header_))
 187     scopes = scm_cons (header_, scopes);
 188
 189   if (ly_c_module_p (header))
 190     scopes = scm_cons (header, scopes);
 191
 192   SCM tit = SCM_EOL;
 193   if (ly_c_procedure_p (title_func))
 194     tit = scm_call_2 (title_func,
 195                       paper_->self_scm (),
 196                       scopes);
 197
 198   if (unsmob_stencil (tit))
 199     title = *unsmob_stencil (tit);
 200
 201   if (!title.is_empty ())
 202     title.align_to (Y_AXIS, UP);
 203
 204   return title;
 205 }
 206
 207 void
 208 set_system_penalty (Paper_system *ps, SCM header)
 209 {
 210   if (ly_c_module_p (header))
 211     {
 212       SCM force = ly_module_lookup (header, ly_symbol2scm ("breakbefore"));
 213       if (SCM_VARIABLEP (force)
 214           && scm_is_bool (SCM_VARIABLE_REF (force)))
 215         {
 216           ps->break_before_penalty_ = to_boolean (SCM_VARIABLE_REF (force))
 217             ? -10000
 218             : 10000;
 219         }
 220     }
 221 }
 222
 223 SCM
 224 Paper_book::systems ()
 225 {
 226   if (systems_ != SCM_BOOL_F)
 227     return systems_;
 228
 229   systems_ = SCM_EOL;
 230   Stencil title = book_title ();
 231
 232   if (!title.is_empty ())
 233     {
 234       Paper_system *ps = new Paper_system (title, true);
 235       set_system_penalty (ps, header_);
 236
 237       systems_ = scm_cons (ps->self_scm (), systems_);
 238       scm_gc_unprotect_object (ps->self_scm ());
 239     }
 240
 241   SCM page_properties
 242     = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
 243                   paper_->self_scm ());
 244
 245   SCM header = SCM_EOL;
 246   for (SCM s = scm_reverse (scores_); s != SCM_EOL; s = scm_cdr (s))
 247     {
 248       if (ly_c_module_p (scm_car (s)))
 249         {
 250           header = scm_car (s);
 251           if (header_0_ == SCM_EOL)
 252             header_0_ = header;
 253         }
 254       else if (scm_is_vector (scm_car (s)))
 255         {
 256           Stencil title = score_title (header);
 257           if (title.is_empty ())
 258             title = score_title (header_);
 259           if (!title.is_empty ())
 260             {
 261               Paper_system *ps = new Paper_system (title, true);
 262               systems_ = scm_cons (ps->self_scm (), systems_);
 263               scm_gc_unprotect_object (ps->self_scm ());
 264               set_system_penalty (ps, header);
 265             }
 266           header = SCM_EOL;
 267
 268           SCM system_list = scm_vector_to_list (scm_car (s));
 269           system_list = scm_reverse (system_list);
 270           systems_ = scm_append (scm_list_2 (system_list, systems_));
 271         }
 272       else if (Text_interface::markup_p (scm_car (s)))
 273         {
 274           SCM t = Text_interface::interpret_markup (paper_->self_scm (),
 275                                                     page_properties,
 276                                                     scm_car (s));
 277           // FIXME: title=true?
 278           Paper_system *ps = new Paper_system (*unsmob_stencil (t), true);
 279           systems_ = scm_cons (ps->self_scm (), systems_);
 280           scm_gc_unprotect_object (ps->self_scm ());
 281           // FIXME: figure out penalty.
 282           //set_system_penalty (ps, scores_[i].header_);
 283         }
 284       else
 285         assert (0);
 286     }
 287
 288   systems_ = scm_reverse (systems_);
 289
 290   int i = 0;
 291   Paper_system *last = 0;
 292   for (SCM s = systems_; s != SCM_EOL; s = scm_cdr (s))
 293     {
 294       Paper_system *ps = unsmob_paper_system (scm_car (s));
 295       ps->number_ = ++i;
 296
 297       if (last
 298           && last->is_title ()
 299           && !ps->break_before_penalty_)
 300         ps->break_before_penalty_ = 10000;
 301       last = ps;
 302     }
 303
 304   return systems_;
 305 }
 306
 307 SCM
 308 Paper_book::pages ()
 309 {
 310   if (SCM_BOOL_F != pages_)
 311     return pages_;
 312
 313   pages_ = SCM_EOL;
 314   SCM proc = paper_->c_variable ("page-breaking");
 315   pages_ = scm_apply_0 (proc, scm_list_2 (systems (), self_scm ()));
 316   return pages_;
 317 }