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
 143   func = scm_variable_ref (func);
 144   scm_apply_0 (func, scm_list_n (scm_makfrom0str (outname.to_str0 ()),
 145                                  self_scm (),
 146                                  scopes,
 147                                  dump_fields (),
 148                                  SCM_UNDEFINED));
 149
 150   progress_indication ("\n");
 151 }
 152
 153
 154 /* TODO: resurrect more complex user-tweaks for titling?  */
 155 Stencil
 156 Paper_book::book_title ()
 157 {
 158   SCM title_func = paper_->lookup_variable (ly_symbol2scm ("book-title"));
 159   Stencil title;
 160
 161   SCM scopes = SCM_EOL;
 162   if (ly_c_module_p (header_))
 163     scopes = scm_cons (header_, scopes);
 164
 165
 166   SCM tit = SCM_EOL;
 167   if (ly_c_procedure_p (title_func))
 168     tit = scm_call_2 (title_func,
 169                      paper_->self_scm (),
 170                      scopes);
 171
 172   if (unsmob_stencil (tit))
 173     title = *unsmob_stencil (tit);
 174
 175   if (!title.is_empty ())
 176     title.align_to (Y_AXIS, UP);
 177
 178   return title;
 179 }
 180
 181 Stencil
 182 Paper_book::score_title (SCM header)
 183 {
 184   SCM title_func = paper_->lookup_variable (ly_symbol2scm ("score-title"));
 185
 186   Stencil title;
 187
 188   SCM scopes = SCM_EOL;
 189   if (ly_c_module_p (header_))
 190     scopes = scm_cons (header_, scopes);
 191
 192   if (ly_c_module_p (header))
 193     scopes = scm_cons (header, scopes);
 194
 195   SCM tit = SCM_EOL;
 196   if (ly_c_procedure_p (title_func))
 197     tit = scm_call_2 (title_func,
 198                      paper_->self_scm (),
 199                      scopes);
 200
 201   if (unsmob_stencil (tit))
 202     title = *unsmob_stencil (tit);
 203
 204   if (!title.is_empty ())
 205     title.align_to (Y_AXIS, UP);
 206
 207   return title;
 208 }
 209
 210 void
 211 set_system_penalty (Paper_system * ps, SCM header)
 212 {
 213   if (ly_c_module_p (header))
 214     {
 215       SCM force = ly_module_lookup (header, ly_symbol2scm ("breakbefore"));
 216       if (SCM_VARIABLEP(force)
 217           && scm_is_bool (SCM_VARIABLE_REF(force)))
 218         {
 219           ps->break_before_penalty_ = to_boolean (SCM_VARIABLE_REF(force))
 220             ? -10000
 221             : 10000;
 222         }
 223     }
 224 }
 225
 226 SCM
 227 Paper_book::systems ()
 228 {
 229   if (systems_ != SCM_BOOL_F)
 230     return systems_;
 231
 232   systems_ = SCM_EOL;
 233   Stencil title = book_title ();
 234
 235   if (!title.is_empty ())
 236     {
 237       Paper_system *ps = new Paper_system (title, true);
 238       set_system_penalty (ps, header_);
 239
 240       systems_ = scm_cons (ps->self_scm (), systems_);
 241       scm_gc_unprotect_object (ps->self_scm ());
 242     }
 243
 244   SCM page_properties
 245     = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
 246                   paper_->self_scm ());
 247
 248   SCM header = SCM_EOL;
 249   for (SCM s = scm_reverse (scores_); s != SCM_EOL; s = scm_cdr (s))
 250     {
 251       if (ly_c_module_p (scm_car (s)))
 252         {
 253           header = scm_car (s);
 254           if (header_0_ == SCM_EOL)
 255             header_0_ = header;
 256         }
 257       else if (scm_is_vector (scm_car (s)))
 258         {
 259           Stencil title = score_title (header);
 260           if (title.is_empty ())
 261             title = score_title (header_);
 262           if (!title.is_empty ())
 263             {
 264               Paper_system *ps = new Paper_system (title, true);
 265               systems_ = scm_cons (ps->self_scm (), systems_);
 266               scm_gc_unprotect_object (ps->self_scm ());
 267               set_system_penalty (ps, header);
 268             }
 269           header = SCM_EOL;
 270
 271           SCM system_list = scm_vector_to_list (scm_car (s));
 272           system_list = scm_reverse (system_list);
 273           systems_ = scm_append (scm_list_2 (system_list, systems_));
 274         }
 275       else if (Text_interface::markup_p (scm_car (s)))
 276         {
 277           SCM t = Text_interface::interpret_markup (paper_->self_scm (),
 278                                                     page_properties,
 279                                                     scm_car (s));
 280           // FIXME: title=true?
 281           Paper_system *ps = new Paper_system (*unsmob_stencil (t), true);
 282           systems_ = scm_cons (ps->self_scm (), systems_);
 283           scm_gc_unprotect_object (ps->self_scm ());
 284           // FIXME: figure out penalty.
 285           //set_system_penalty (ps, scores_[i].header_);
 286         }
 287       else
 288         assert (0);
 289     }
 290
 291   systems_ = scm_reverse (systems_);
 292
 293   int i = 0;
 294   Paper_system *last = 0;
 295   for (SCM s = systems_; s != SCM_EOL; s = scm_cdr (s))
 296     {
 297       Paper_system *ps = unsmob_paper_system (scm_car (s));
 298       ps->number_ = ++i;
 299
 300       if (last
 301           && last->is_title ()
 302           && !ps->break_before_penalty_)
 303         ps->break_before_penalty_ = 10000;
 304       last = ps;
 305     }
 306
 307   return systems_;
 308 }
 309
 310 SCM
 311 Paper_book::pages ()
 312 {
 313   if (SCM_BOOL_F != pages_)
 314     return pages_;
 315
 316   pages_ = SCM_EOL;
 317   SCM proc = paper_->c_variable ("page-breaking");
 318   pages_ = scm_apply_0 (proc, scm_list_2 (systems (), self_scm ()));
 319   return pages_;
 320 }