lily/book.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "book.hh"
  21
  22 #include <cstdio>
  23 using namespace std;
  24
  25 #include "main.hh"
  26 #include "music.hh"
  27 #include "output-def.hh"
  28 #include "paper-book.hh"
  29 #include "score.hh"
  30 #include "text-interface.hh"
  31 #include "warn.hh"
  32 #include "performance.hh"
  33 #include "paper-score.hh"
  34 #include "page-marker.hh"
  35
  36
  37 Book::Book ()
  38 {
  39   paper_ = 0;
  40   header_ = SCM_EOL;
  41   scores_ = SCM_EOL;
  42   bookparts_ = SCM_EOL;
  43   input_location_ = SCM_EOL;
  44   smobify_self ();
  45
  46   input_location_ = Input ().smobbed_copy ();
  47 }
  48
  49 Book::Book (Book const &s)
  50 {
  51   paper_ = 0;
  52   header_ = SCM_EOL;
  53   scores_ = SCM_EOL;
  54   bookparts_ = SCM_EOL;
  55   input_location_ = SCM_EOL;
  56   smobify_self ();
  57
  58   if (s.paper_)
  59     {
  60       paper_ = s.paper_->clone ();
  61       paper_->unprotect ();
  62     }
  63
  64   input_location_ = s.origin ()->smobbed_copy ();
  65
  66   header_ = ly_make_module (false);
  67   if (ly_is_module (s.header_))
  68     ly_module_copy (header_, s.header_);
  69   SCM *t = &scores_;
  70   for (SCM p = s.scores_; scm_is_pair (p); p = scm_cdr (p))
  71     {
  72       SCM entry = scm_car (p);
  73
  74       if (Score *newscore = Score::unsmob (entry))
  75         * t = scm_cons (newscore->clone ()->unprotect (), SCM_EOL);
  76       else if (Page_marker *marker = Page_marker::unsmob (entry))
  77         * t = scm_cons (marker->clone ()->unprotect (), SCM_EOL);
  78       else
  79         {
  80           /* This entry is a markup list */
  81           *t = scm_cons (entry, SCM_EOL);
  82         }
  83       t = SCM_CDRLOC (*t);
  84     }
  85
  86   t = &bookparts_;
  87   for (SCM p = s.bookparts_; scm_is_pair (p); p = scm_cdr (p))
  88     {
  89       Book *newpart = Book::unsmob (scm_car (p))->clone ();
  90
  91       *t = scm_cons (newpart->self_scm (), SCM_EOL);
  92       t = SCM_CDRLOC (*t);
  93       newpart->unprotect ();
  94     }
  95 }
  96
  97 Input *
  98 Book::origin () const
  99 {
 100   return Input::unsmob (input_location_);
 101 }
 102
 103 Book::~Book ()
 104 {
 105 }
 106
 107
 108 SCM
 109 Book::mark_smob (SCM s)
 110 {
 111   Book *book = (Book *) SCM_CELL_WORD_1 (s);
 112
 113   if (book->paper_)
 114     scm_gc_mark (book->paper_->self_scm ());
 115   scm_gc_mark (book->scores_);
 116   scm_gc_mark (book->bookparts_);
 117   scm_gc_mark (book->input_location_);
 118
 119   return book->header_;
 120 }
 121
 122 int
 123 Book::print_smob (SCM, SCM p, scm_print_state *)
 124 {
 125   scm_puts ("#<Book>", p);
 126   return 1;
 127 }
 128
 129 void
 130 Book::add_score (SCM s)
 131 {
 132   scores_ = scm_cons (s, scores_);
 133 }
 134
 135 void
 136 Book::set_parent (Book *parent)
 137 {
 138   if (!paper_)
 139     {
 140       paper_ = new Output_def ();
 141       paper_->unprotect ();
 142     }
 143   paper_->parent_ = parent->paper_;
 144   /* Copy the header block of the parent */
 145   if (ly_is_module (parent->header_))
 146     {
 147       SCM tmp_header = ly_make_module (false);
 148       ly_module_copy (tmp_header, parent->header_);
 149       if (ly_is_module (header_))
 150         ly_module_copy (tmp_header, header_);
 151       header_ = tmp_header;
 152     }
 153 }
 154
 155 /* Before an explicit \bookpart is encountered, scores are added to the book.
 156  * But once a bookpart is added, the previous scores shall be collected into
 157  * a new bookpart.
 158  */
 159 void
 160 Book::add_scores_to_bookpart ()
 161 {
 162   if (scm_is_pair (scores_))
 163     {
 164       /* If scores have been added to this book, add them to a child
 165        * book part */
 166       Book *part = new Book;
 167       part->set_parent (this);
 168       part->scores_ = scores_;
 169       bookparts_ = scm_cons (part->self_scm (), bookparts_);
 170       part->unprotect ();
 171       scores_ = SCM_EOL;
 172     }
 173 }
 174
 175 void
 176 Book::add_bookpart (SCM b)
 177 {
 178   add_scores_to_bookpart ();
 179   Book *part = Book::unsmob (b);
 180   part->set_parent (this);
 181   bookparts_ = scm_cons (b, bookparts_);
 182 }
 183
 184 bool
 185 Book::error_found ()
 186 {
 187   for (SCM s = scores_; scm_is_pair (s); s = scm_cdr (s))
 188     if (Score *score = Score::unsmob (scm_car (s)))
 189       if (score->error_found_)
 190         return true;
 191
 192   for (SCM part = bookparts_; scm_is_pair (part); part = scm_cdr (part))
 193     if (Book *bookpart = Book::unsmob (scm_car (part)))
 194       if (bookpart->error_found ())
 195         return true;
 196
 197   return false;
 198 }
 199
 200 Paper_book *
 201 Book::process (Output_def *default_paper,
 202                Output_def *default_layout)
 203 {
 204   return process (default_paper, default_layout, 0);
 205 }
 206
 207 void
 208 Book::process_bookparts (Paper_book *output_paper_book, Output_def *paper, Output_def *layout)
 209 {
 210   add_scores_to_bookpart ();
 211   for (SCM p = scm_reverse (bookparts_); scm_is_pair (p); p = scm_cdr (p))
 212     {
 213       if (Book *book = Book::unsmob (scm_car (p)))
 214         {
 215           Paper_book *paper_book_part = book->process (paper, layout, output_paper_book);
 216           if (paper_book_part)
 217             {
 218               output_paper_book->add_bookpart (paper_book_part->self_scm ());
 219               paper_book_part->unprotect ();
 220             }
 221         }
 222     }
 223   /* In a Paper_book, bookparts are stored in straight order */
 224   output_paper_book->bookparts_ = scm_reverse_x (output_paper_book->bookparts_, SCM_EOL);
 225 }
 226
 227 void
 228 Book::process_score (SCM s, Paper_book *output_paper_book, Output_def *layout)
 229 {
 230   if (Score *score = Score::unsmob (scm_car (s)))
 231     {
 232       SCM outputs = score
 233                     ->book_rendering (output_paper_book->paper_, layout);
 234
 235       while (scm_is_pair (outputs))
 236         {
 237           Music_output *output = Music_output::unsmob (scm_car (outputs));
 238
 239           if (Performance *perf = dynamic_cast<Performance *> (output))
 240             output_paper_book->add_performance (perf->self_scm ());
 241           else if (Paper_score *pscore = dynamic_cast<Paper_score *> (output))
 242             {
 243               if (ly_is_module (score->get_header ()))
 244                 output_paper_book->add_score (score->get_header ());
 245               output_paper_book->add_score (pscore->self_scm ());
 246             }
 247
 248           outputs = scm_cdr (outputs);
 249         }
 250     }
 251   else if (Text_interface::is_markup_list (scm_car (s))
 252            || Page_marker::unsmob (scm_car (s)))
 253     output_paper_book->add_score (scm_car (s));
 254   else
 255     assert (0);
 256
 257 }
 258
 259 /* Concatenate all score or book part outputs into a Paper_book
 260  */
 261 Paper_book *
 262 Book::process (Output_def *default_paper,
 263                Output_def *default_layout,
 264                Paper_book *parent_part)
 265 {
 266   Output_def *paper = paper_ ? paper_ : default_paper;
 267
 268   /* If top book, recursively check score errors */
 269   if (!parent_part && error_found ())
 270     return 0;
 271
 272   if (!paper)
 273     return 0;
 274
 275   Paper_book *paper_book = new Paper_book ();
 276   Real scale = scm_to_double (paper->c_variable ("output-scale"));
 277   Output_def *scaled_bookdef = scale_output_def (paper, scale);
 278   paper_book->paper_ = scaled_bookdef;
 279   if (parent_part)
 280     {
 281       paper_book->parent_ = parent_part;
 282       paper_book->paper_->parent_ = parent_part->paper_;
 283     }
 284   paper_book->header_ = header_;
 285   scaled_bookdef->unprotect ();
 286
 287   if (scm_is_pair (bookparts_))
 288     {
 289       /* Process children book parts */
 290       process_bookparts (paper_book, paper, default_layout);
 291     }
 292   else
 293     {
 294       paper_book->paper_->normalize ();
 295       /* Process scores */
 296       /* Render in order of parsing.  */
 297       for (SCM s = scm_reverse (scores_); scm_is_pair (s); s = scm_cdr (s))
 298         {
 299           process_score (s, paper_book, default_layout);
 300         }
 301     }
 302
 303   return paper_book;
 304 }