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 ()
 110 {
 111   if (paper_)
 112     scm_gc_mark (paper_->self_scm ());
 113   scm_gc_mark (scores_);
 114   scm_gc_mark (bookparts_);
 115   scm_gc_mark (input_location_);
 116
 117   return header_;
 118 }
 119
 120 void
 121 Book::add_score (SCM s)
 122 {
 123   scores_ = scm_cons (s, scores_);
 124 }
 125
 126 void
 127 Book::set_parent (Book *parent)
 128 {
 129   if (!paper_)
 130     {
 131       paper_ = new Output_def ();
 132       paper_->unprotect ();
 133     }
 134   paper_->parent_ = parent->paper_;
 135   /* Copy the header block of the parent */
 136   if (ly_is_module (parent->header_))
 137     {
 138       SCM tmp_header = ly_make_module (false);
 139       ly_module_copy (tmp_header, parent->header_);
 140       if (ly_is_module (header_))
 141         ly_module_copy (tmp_header, header_);
 142       header_ = tmp_header;
 143     }
 144 }
 145
 146 /* Before an explicit \bookpart is encountered, scores are added to the book.
 147  * But once a bookpart is added, the previous scores shall be collected into
 148  * a new bookpart.
 149  */
 150 void
 151 Book::add_scores_to_bookpart ()
 152 {
 153   if (scm_is_pair (scores_))
 154     {
 155       /* If scores have been added to this book, add them to a child
 156        * book part */
 157       Book *part = new Book;
 158       part->set_parent (this);
 159       part->scores_ = scores_;
 160       bookparts_ = scm_cons (part->self_scm (), bookparts_);
 161       part->unprotect ();
 162       scores_ = SCM_EOL;
 163     }
 164 }
 165
 166 void
 167 Book::add_bookpart (SCM b)
 168 {
 169   add_scores_to_bookpart ();
 170   Book *part = Book::unsmob (b);
 171   part->set_parent (this);
 172   bookparts_ = scm_cons (b, bookparts_);
 173 }
 174
 175 bool
 176 Book::error_found ()
 177 {
 178   for (SCM s = scores_; scm_is_pair (s); s = scm_cdr (s))
 179     if (Score *score = Score::unsmob (scm_car (s)))
 180       if (score->error_found_)
 181         return true;
 182
 183   for (SCM part = bookparts_; scm_is_pair (part); part = scm_cdr (part))
 184     if (Book *bookpart = Book::unsmob (scm_car (part)))
 185       if (bookpart->error_found ())
 186         return true;
 187
 188   return false;
 189 }
 190
 191 Paper_book *
 192 Book::process (Output_def *default_paper,
 193                Output_def *default_layout)
 194 {
 195   return process (default_paper, default_layout, 0);
 196 }
 197
 198 void
 199 Book::process_bookparts (Paper_book *output_paper_book, Output_def *paper, Output_def *layout)
 200 {
 201   add_scores_to_bookpart ();
 202   for (SCM p = scm_reverse (bookparts_); scm_is_pair (p); p = scm_cdr (p))
 203     {
 204       if (Book *book = Book::unsmob (scm_car (p)))
 205         {
 206           Paper_book *paper_book_part = book->process (paper, layout, output_paper_book);
 207           if (paper_book_part)
 208             {
 209               output_paper_book->add_bookpart (paper_book_part->self_scm ());
 210               paper_book_part->unprotect ();
 211             }
 212         }
 213     }
 214   /* In a Paper_book, bookparts are stored in straight order */
 215   output_paper_book->bookparts_ = scm_reverse_x (output_paper_book->bookparts_, SCM_EOL);
 216 }
 217
 218 void
 219 Book::process_score (SCM s, Paper_book *output_paper_book, Output_def *layout)
 220 {
 221   if (Score *score = Score::unsmob (scm_car (s)))
 222     {
 223       SCM outputs = score
 224                     ->book_rendering (output_paper_book->paper_, layout);
 225
 226       while (scm_is_pair (outputs))
 227         {
 228           Music_output *output = Music_output::unsmob (scm_car (outputs));
 229
 230           if (Performance *perf = dynamic_cast<Performance *> (output))
 231             output_paper_book->add_performance (perf->self_scm ());
 232           else if (Paper_score *pscore = dynamic_cast<Paper_score *> (output))
 233             {
 234               if (ly_is_module (score->get_header ()))
 235                 output_paper_book->add_score (score->get_header ());
 236               output_paper_book->add_score (pscore->self_scm ());
 237             }
 238
 239           outputs = scm_cdr (outputs);
 240         }
 241     }
 242   else if (Text_interface::is_markup_list (scm_car (s))
 243            || Page_marker::is_smob (scm_car (s)))
 244     output_paper_book->add_score (scm_car (s));
 245   else
 246     assert (0);
 247
 248 }
 249
 250 /* Concatenate all score or book part outputs into a Paper_book
 251  */
 252 Paper_book *
 253 Book::process (Output_def *default_paper,
 254                Output_def *default_layout,
 255                Paper_book *parent_part)
 256 {
 257   Output_def *paper = paper_ ? paper_ : default_paper;
 258
 259   /* If top book, recursively check score errors */
 260   if (!parent_part && error_found ())
 261     return 0;
 262
 263   if (!paper)
 264     return 0;
 265
 266   Paper_book *paper_book = new Paper_book ();
 267   Real scale = scm_to_double (paper->c_variable ("output-scale"));
 268   Output_def *scaled_bookdef = scale_output_def (paper, scale);
 269   paper_book->paper_ = scaled_bookdef;
 270   if (parent_part)
 271     {
 272       paper_book->parent_ = parent_part;
 273       paper_book->paper_->parent_ = parent_part->paper_;
 274     }
 275   paper_book->header_ = header_;
 276   scaled_bookdef->unprotect ();
 277
 278   if (scm_is_pair (bookparts_))
 279     {
 280       /* Process children book parts */
 281       process_bookparts (paper_book, paper, default_layout);
 282     }
 283   else
 284     {
 285       paper_book->paper_->normalize ();
 286       /* Process scores */
 287       /* Render in order of parsing.  */
 288       for (SCM s = scm_reverse (scores_); scm_is_pair (s); s = scm_cdr (s))
 289         {
 290           process_score (s, paper_book, default_layout);
 291         }
 292     }
 293
 294   return paper_book;
 295 }