lily/book-scheme.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2015 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 "output-def.hh"
  23 #include "score.hh"
  24 #include "paper-book.hh"
  25
  26 LY_DEFINE (ly_make_book, "ly:make-book",
  27            2, 0, 1, (SCM paper, SCM header, SCM scores),
  28            "Make a @code{\\book} of @var{paper} and @var{header}"
  29            " (which may be @code{#f} as well) containing @code{\\scores}.")
  30 {
  31   Output_def *odef = unsmob<Output_def> (paper);
  32   LY_ASSERT_SMOB (Output_def, paper, 1);
  33
  34   Book *book = new Book;
  35   book->paper_ = odef;
  36
  37   if (ly_is_module (header))
  38     book->header_ = header;
  39
  40   book->scores_ = scm_append (scm_list_2 (scores, book->scores_));
  41
  42   SCM x = book->self_scm ();
  43   book->unprotect ();
  44   return x;
  45 }
  46
  47 LY_DEFINE (ly_make_book_part, "ly:make-book-part",
  48            1, 0, 0, (SCM scores),
  49            "Make a @code{\\bookpart} containing @code{\\scores}.")
  50 {
  51   Book *book = new Book;
  52   book->scores_ = scm_append (scm_list_2 (scores, book->scores_));
  53
  54   SCM x = book->self_scm ();
  55   book->unprotect ();
  56   return x;
  57 }
  58
  59 LY_DEFINE (ly_book_process, "ly:book-process",
  60            4, 0, 0, (SCM book_smob,
  61                      SCM default_paper,
  62                      SCM default_layout,
  63                      SCM output),
  64            "Print book.  @var{output} is passed to the backend unchanged."
  65            "  For example, it may be a string (for file based outputs)"
  66            " or a socket (for network based output).")
  67 {
  68   Book *book = unsmob<Book> (book_smob);
  69
  70   LY_ASSERT_SMOB (Book, book_smob, 1);
  71   LY_ASSERT_SMOB (Output_def, default_paper, 2);
  72   LY_ASSERT_SMOB (Output_def, default_layout, 3);
  73
  74   Paper_book *pb = book->process (unsmob<Output_def> (default_paper),
  75                                   unsmob<Output_def> (default_layout));
  76   if (pb)
  77     {
  78       pb->output (output);
  79       pb->unprotect ();
  80     }
  81
  82   return SCM_UNSPECIFIED;
  83 }
  84
  85 LY_DEFINE (ly_book_process_to_systems, "ly:book-process-to-systems",
  86            4, 0, 0, (SCM book_smob,
  87                      SCM default_paper,
  88                      SCM default_layout,
  89                      SCM output),
  90            "Print book.  @var{output} is passed to the backend unchanged."
  91            "  For example, it may be a string (for file based outputs)"
  92            " or a socket (for network based output).")
  93 {
  94   LY_ASSERT_SMOB (Book, book_smob, 1);
  95   LY_ASSERT_SMOB (Output_def, default_paper, 2);
  96   LY_ASSERT_SMOB (Output_def, default_layout, 3);
  97
  98   Book *book = unsmob<Book> (book_smob);
  99
 100   Paper_book *pb = book->process (unsmob<Output_def> (default_paper),
 101                                   unsmob<Output_def> (default_layout));
 102   if (pb)
 103     {
 104       pb->classic_output (output);
 105       pb->unprotect ();
 106     }
 107
 108   return SCM_UNSPECIFIED;
 109 }
 110
 111 LY_DEFINE (ly_book_add_score_x, "ly:book-add-score!",
 112            2, 0, 0, (SCM book_smob, SCM score),
 113            "Add @var{score} to @var{book-smob} score list.")
 114 {
 115   LY_ASSERT_SMOB (Book, book_smob, 1);
 116   Book *book = unsmob<Book> (book_smob);
 117   book->add_score (score);
 118   return SCM_UNSPECIFIED;
 119 }
 120
 121 LY_DEFINE (ly_book_add_bookpart_x, "ly:book-add-bookpart!",
 122            2, 0, 0, (SCM book_smob, SCM book_part),
 123            "Add @var{book-part} to @var{book-smob} book part list.")
 124 {
 125   LY_ASSERT_SMOB (Book, book_smob, 1);
 126   Book *book = unsmob<Book> (book_smob);
 127   book->add_bookpart (book_part);
 128   return SCM_UNSPECIFIED;
 129 }
 130
 131 LY_DEFINE (ly_book_book_parts, "ly:book-book-parts",
 132            1, 0, 0, (SCM book),
 133            "Return book parts in @var{book}.")
 134 {
 135   LY_ASSERT_SMOB (Book, book, 1);
 136   Book *b = unsmob<Book> (book);
 137   return b->bookparts_;
 138 }
 139
 140 LY_DEFINE (ly_book_paper, "ly:book-paper",
 141            1, 0, 0, (SCM book),
 142            "Return paper in @var{book}.")
 143 {
 144   LY_ASSERT_SMOB (Book, book, 1);
 145   Book *b = unsmob<Book> (book);
 146   return b->paper_ ? b->paper_->self_scm () : SCM_BOOL_F;
 147 }
 148
 149 LY_DEFINE (ly_book_header, "ly:book-header",
 150            1, 0, 0, (SCM book),
 151            "Return header in @var{book}.")
 152 {
 153   LY_ASSERT_SMOB (Book, book, 1);
 154   Book *b = unsmob<Book> (book);
 155   return ly_is_module (b->header_) ? b->header_ : SCM_BOOL_F;
 156 }
 157
 158 LY_DEFINE (ly_book_set_header_x, "ly:book-set-header!",
 159            2, 0, 0, (SCM book, SCM module),
 160            "Set the book header.")
 161 {
 162   LY_ASSERT_SMOB (Book, book, 1);
 163   SCM_ASSERT_TYPE (ly_is_module (module), module, SCM_ARG2, __FUNCTION__,
 164                    "module");
 165
 166   Book *b = unsmob<Book> (book);
 167   b->header_ = (module);
 168   return SCM_UNSPECIFIED;
 169 }
 170
 171 LY_DEFINE (ly_book_scores, "ly:book-scores",
 172            1, 0, 0, (SCM book),
 173            "Return scores in @var{book}.")
 174 {
 175   LY_ASSERT_SMOB (Book, book, 1);
 176   Book *b = unsmob<Book> (book);
 177   return b->scores_;
 178 }
 179
 180
 181 const char * const Book::type_p_name_ = "ly:book?";