]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/paper-book.cc
* lily/lily-parser.cc (LY_DEFINE): Remove "Now " from message.
[lilypond.git] / lily / paper-book.cc
index 999fd0255b80035c6be2b398acd50f08b1a24813..08367608b38d7db94fe53e12506d873a200504ee 100644 (file)
   (c) 2004 Jan Nieuwenhuizen <janneke@gnu.org>
 */
 
-#include <stdio.h>
-
 #include "ly-module.hh"
 #include "main.hh"
+#include "output-def.hh"
 #include "paper-book.hh"
-#include "paper-def.hh"
 #include "paper-outputter.hh"
 #include "paper-score.hh"
+#include "paper-system.hh"
 #include "stencil.hh"
+#include "warn.hh"
 
-// WIP -- simplistic page interface
-// Do we need this at all?  SCM, smob?
-class Page
-{
-public:
-  Paper_def *paper_;
-
-  SCM lines_;
-  Stencil *header_;
-  Stencil *footer_;
+#include "ly-smobs.icc"
 
-  /* actual height filled with text.  */
-  Real height_;
+Paper_book::Paper_book ()
+{
+  pages_ = SCM_BOOL_F;
+  systems_ = SCM_BOOL_F;
+  header_ = SCM_EOL;
   
-  //HMMM all this size stuff to paper/paper-outputter?
-  Real hsize_;
-  Real vsize_;
-  Real foot_sep_;
-  Real head_sep_;
+  paper_ = 0;
+  smobify_self ();
+}
 
-  /* available area for text.  */
-  Real text_height ();
+Paper_book::~Paper_book ()
+{
+}
 
-  Page (Paper_def*);
-  void output (Paper_outputter*, bool);
-};
+IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
+IMPLEMENT_SMOBS (Paper_book)
+IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?")
 
-Page::Page (Paper_def *paper)
+SCM
+Paper_book::mark_smob (SCM smob)
 {
-  paper_ = paper;
-  height_ = 0;
-  header_ = 0;
-  footer_ = 0;
-  lines_ = SCM_EOL;
-  
-  hsize_ = paper->get_realvar (ly_symbol2scm ("hsize"));
-  vsize_ = paper->get_realvar (ly_symbol2scm ("vsize"));
-  head_sep_ = 0; //paper->get_realvar (ly_symbol2scm ("head-sep"));
-  foot_sep_ = 0; //paper->get_realvar (ly_symbol2scm ("foot-sep"));
+  Paper_book *b = (Paper_book*) SCM_CELL_WORD_1 (smob);
+  for (int i = 0; i < b->score_systems_.size (); i++)
+    b->score_systems_[i].gc_mark ();
+
+  if (b->paper_)
+    scm_gc_mark (b->paper_->self_scm ());
+  scm_gc_mark (b->header_);
+  scm_gc_mark (b->pages_);
+  return b->systems_;
 }
 
-void
-Page::output (Paper_outputter *out, bool is_last)
+int
+Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
 {
-  // TODO: header/footer etc
-  out->output_scheme (scm_list_1 (ly_symbol2scm ("start-page")));
-  for (SCM s = lines_; gh_pair_p (s); s = ly_cdr (s))
-    out->output_line (ly_car (s), is_last && gh_pair_p (ly_cdr (s)));
-  out->output_scheme (scm_list_2 (ly_symbol2scm ("stop-page"),
-                                 gh_bool2scm (is_last)));
+  Paper_book *b = (Paper_book*) SCM_CELL_WORD_1 (smob);
+     
+  scm_puts ("#<", port);
+  scm_puts (classname (b), port);
+  scm_puts (" ", port);
+  //scm_puts (b->, port);
+  scm_puts (">", port);
+  return 1;
 }
 
-Real
-Page::text_height ()
+Array<String>
+split_string (String s, char c)
 {
-  Real h = vsize_;
-  if (header_)
-    h -= header_->extent (Y_AXIS).length () + head_sep_;
-  if (footer_)
-    h -= footer_->extent (Y_AXIS).length () + foot_sep_;
-  return h;
+  Array<String> rv; 
+  while (s.length ())
+    {
+      int i = s.index (c);
+      
+      if (i == 0)
+       {
+         s = s.nomid_string (0, 1);
+         continue;
+       }
+      
+      if (i < 0)
+       i = s.length () ;
+
+      rv.push (s.cut_string (0, i));
+      s = s.nomid_string (0, i);
+    }
+
+  return rv;
 }
 
-/****************************************************************/
+SCM
+dump_fields ()
+{
+  SCM fields = SCM_EOL;
+  for (int i = dump_header_fieldnames_global.size (); i--; )
+    fields
+      = scm_cons (ly_symbol2scm (dump_header_fieldnames_global[i].to_str0 ()),
+                 fields);
+  return fields;
+}
 
+LY_DEFINE (ly_output_formats, "ly:output-formats",
+          0, 0, 0, (),
+          "Formats passed to --format as a list of strings, "
+          "used for the output.")
+{
+  Array<String> output_formats = split_string (output_format_global, ',');
 
-Paper_book *paper_book;                // huh? global var? --hwn
+  SCM lst = SCM_EOL;
+  int output_formats_count = output_formats.size ();
+  for (int i = 0; i < output_formats_count; i ++)
+    lst = scm_cons (scm_makfrom0str (output_formats[i].to_str0 ()), lst);
+  
+  return lst; 
+}
 
-Paper_book::Paper_book ()
+void
+Paper_book::post_processing (SCM module,
+                            SCM file_name)
 {
-  smobify_self ();
+  struct
+  {
+    bool do_it_;
+    char const *func_name_;
+  } settings[] = {
+    {make_tex, "convert-to-tex"},
+    {make_dvi, "convert-to-dvi"},
+    {make_ps, "convert-to-ps"},
+    {make_pdf, "convert-to-pdf"},
+    {make_png, "convert-to-png"},
+    {0, 0},
+  };
+
+  for (int i = 0; settings[i].func_name_; i++)
+    {
+      if (settings[i].do_it_)
+       {
+         SCM func = scm_c_module_lookup (module, settings[i].func_name_);
+         if (scm_variable_p (func) == SCM_BOOL_T)
+           {
+             func = scm_variable_ref (func);
+             if (ly_c_procedure_p (func))
+               scm_call_2 (func, self_scm (), file_name);
+           }
+       }
+    }
 }
 
 void
 Paper_book::output (String outname)
 {
-  /* Generate all stencils to trigger font loads.  */
-  Link_array<Page> *pages = get_pages ();
-
-  Paper_def *paper = papers_[0];
-  Paper_outputter *out = paper->get_paper_outputter (outname);
-  out->output_metadata (get_scopes (0), paper);
-  out->output_header (paper);
+  if (!score_systems_.size ())
+    return;
 
-  int page_count = pages->size ();
-  for (int i = 0; i < page_count; i++)
-    (*pages)[i]->output (out, i + 1 == page_count);
+  /* Generate all stencils to trigger font loads.  */
+  pages ();
+  
+  SCM formats = ly_output_formats ();
+  for (SCM s = formats; scm_is_pair (s); s = scm_cdr (s)) 
+    {
+      String format = ly_scm2string (scm_car (s));
+      String file_name = outname;
+      
+      if (file_name != "-")
+       file_name += "." + format;
+      
+      Paper_outputter *out = get_paper_outputter (file_name, format);
+  
+      SCM scopes = SCM_EOL;
+      if (ly_c_module_p (header_))
+       scopes = scm_cons (header_, scopes);
+  
+      String mod_nm = "scm framework-" + format;
 
-  out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
+      SCM mod = scm_c_resolve_module (mod_nm.to_str0 ());
+      if (make_pages)
+       {
+         SCM func = scm_c_module_lookup (mod, "output-framework");
+
+         func = scm_variable_ref (func);
+         scm_apply_0 (func, scm_list_n (out->self_scm (),
+                                        self_scm (),
+                                        scopes,
+                                        dump_fields (),
+                                        scm_makfrom0str (outname.to_str0 ()),
+                                        SCM_UNDEFINED));
+         out->close ();
+         scm_gc_unprotect_object (out->self_scm ());
+         post_processing (mod, scm_makfrom0str (file_name.to_str0 ()));
+       }
+      
+      if (make_preview)
+       {
+         String file_name = outname + ".preview." + format;
+         Paper_outputter *out = get_paper_outputter (file_name, format);
+  
+         SCM func = scm_c_module_lookup (mod, "output-preview-framework");
+         func = scm_variable_ref (func);
+         scm_apply_0 (func, scm_list_n (out->self_scm (),
+                                        self_scm (),
+                                        scopes,
+                                        dump_fields (),
+                                        scm_makfrom0str (outname.to_str0 ()),
+                                        SCM_UNDEFINED));
+
+         out->close ();
+         scm_gc_unprotect_object (out->self_scm ());
+
+         post_processing (mod, scm_makfrom0str (file_name.to_str0 ()));
+       }
+    }
   progress_indication ("\n");
 }
 
-SCM
-Paper_book::get_scopes (int i)
+void
+Paper_book::classic_output (String outname)
 {
+  /* Generate all stencils to trigger font loads.  */
+  systems ();
+
+  // ugh code dup
   SCM scopes = SCM_EOL;
-  if (headers_[i])
-    scopes = scm_cons (headers_[i], scopes);
-  if (global_headers_[i] && global_headers_[i] != headers_[i])
-    scopes = scm_cons (global_headers_[i], scopes);
-  return scopes;
-}
+  if (ly_c_module_p (header_))
+    scopes = scm_cons (header_, scopes);
 
-Stencil*
-Paper_book::get_title (int i)
-{
-  SCM make_title = scm_primitive_eval (ly_symbol2scm ("make-title"));
-  SCM field = (i == 0 ? ly_symbol2scm ("bookTitle")
-              : ly_symbol2scm ("scoreTitle"));
+  if (ly_c_module_p (score_systems_[0].header_))
+    scopes = scm_cons (score_systems_[0].header_, scopes);
+  //end ugh
+
+  Array<String> output_formats = split_string (output_format_global, ',');
 
-  SCM s = ly_modules_lookup (get_scopes (i), field); 
-  if (s != SCM_UNDEFINED && scm_variable_bound_p (s) == SCM_BOOL_T)
+  for (int i = 0; i < output_formats.size (); i++)
     {
-      Stencil *title = unsmob_stencil (gh_call2 (make_title,
-                                                papers_[0]->self_scm (),
-                                                scm_variable_ref (s)));
+      String format = output_formats[i];
+      String mod_nm = "scm framework-" + format;
       
-      title->align_to (Y_AXIS, UP);
-      return title;
+      SCM mod = scm_c_resolve_module (mod_nm.to_str0 ());
+      SCM func = scm_c_module_lookup (mod, "output-classic-framework");
+
+      func = scm_variable_ref (func);
+      
+      Paper_outputter *out = get_paper_outputter (outname + "." + format,
+                                                 format);
+
+      scm_apply_0 (func, scm_list_n (out->self_scm (), self_scm (), scopes,
+                                    dump_fields (),
+                                    scm_makfrom0str (outname.to_str0 ()),
+                                    SCM_UNDEFINED));
+
+      scm_gc_unprotect_object (out->self_scm ());
+      progress_indication ("\n");
     }
+}
+
+LY_DEFINE (ly_paper_book_pages, "ly:paper-book-pages",
+         1, 0, 0, (SCM pb),
+         "Return pages in book PB.")
+{
+  return unsmob_paper_book(pb)->pages ();
+}
+
+LY_DEFINE (ly_paper_book_scopes, "ly:paper-book-scopes",
+         1, 0, 0, (SCM book),
+         "Return pages in layout book @var{book}.")
+{
+  Paper_book *pb = unsmob_paper_book(book);
+  SCM_ASSERT_TYPE(pb, book, SCM_ARG1, __FUNCTION__, "Paper_book");
   
-  return 0;
+  SCM scopes = SCM_EOL;
+  if (ly_c_module_p (pb->header_))
+    scopes = scm_cons (pb->header_, scopes);
+  
+  return scopes;
 }
 
-/*
-  WIP
+LY_DEFINE (ly_paper_book_systems, "ly:paper-book-systems",
+          1, 0, 0, (SCM pb),
+          "Return systems in book PB.")
+{
+  return unsmob_paper_book (pb)->systems ();
+}
+
+LY_DEFINE (ly_paper_book_paper, "ly:paper-book-paper",
+         1, 0, 0, (SCM pb),
+         "Return pages in book PB.")
+{
+  return unsmob_paper_book (pb)->paper_->self_scm ();
+}
+
+/* TODO: resurrect more complex user-tweaks for titling?  */
+Stencil
+Paper_book::book_title ()
+{
+  SCM title_func = paper_->lookup_variable (ly_symbol2scm ("book-title"));
+  Stencil title;
+
+  SCM scopes = SCM_EOL;
+  if (ly_c_module_p (header_))
+    scopes = scm_cons (header_, scopes);
+
+  SCM tit = SCM_EOL;
+  if (ly_c_procedure_p (title_func))
+    tit = scm_call_2 (title_func,
+                    paper_->self_scm (),
+                    scopes);
+
+  if (unsmob_stencil (tit))
+    title = *unsmob_stencil (tit);
 
-  FIXME: titling is broken.
+  if (!title.is_empty ())
+    title.align_to (Y_AXIS, UP);
   
-  TODO:
-     * ->SCM?
-     * decent page breaking algorithm
-     * header / footer (generate per Page, with page#)
-     * override: # pages, or pageBreakLines= #'(3 3 4), ?
-     * what about between-system-breaking, can we junk that?
-     
-*/
-Link_array<Page>*
-Paper_book::get_pages ()
+  return title;
+}
+
+Stencil
+Paper_book::score_title (int i)
 {
-  Link_array<Page> *pages = new Link_array<Page>;
-  int score_count = scores_.size ();
+  SCM title_func = paper_->lookup_variable (ly_symbol2scm ("score-title"));
 
-  /* Calculate the full book height.  Hmm, can't we cache system
-     heights while making stencils?  */
-  Real book_height = 0;
-  for (int i = 0; i < score_count; i++)
-    {
-      Stencil *title = get_title (i);
-      if (title)
-       book_height += title->extent (Y_AXIS).length ();
+  Stencil title;
 
-      int line_count = SCM_VECTOR_LENGTH ((SCM) scores_[i]);
-      for (int j = 0; j < line_count; j++)
-       {
-         SCM line = scm_vector_ref ((SCM) scores_[i], scm_int2num (j));
-         book_height += ly_scm2offset (ly_car (line))[Y_AXIS];
-       }
-    }
+  // ugh code dup
+  SCM scopes = SCM_EOL;
+  if (ly_c_module_p (header_))
+    scopes = scm_cons (header_, scopes);
 
-  Paper_def *paper = papers_[0];
-  Page *page = new Page (paper);
-  fprintf (stderr, "book_height: %f\n", book_height);
-  fprintf (stderr, "vsize: %f\n", page->vsize_);
-  fprintf (stderr, "pages: %f\n", book_height / page->text_height ());
+  if (ly_c_module_p (score_systems_[i].header_))
+    scopes = scm_cons (score_systems_[i].header_, scopes);
+  //end ugh
 
-  /* Simplistic page breaking.  */
-  Real text_height = page->text_height ();
+  SCM tit = SCM_EOL;
+  if (ly_c_procedure_p (title_func))
+    tit = scm_call_2 (title_func,
+                    paper_->self_scm (),
+                    scopes);
+
+  if (unsmob_stencil (tit))
+    title = *unsmob_stencil (tit);
+
+  if (!title.is_empty ())
+    title.align_to (Y_AXIS, UP);
+  
+  return title;
+}
+  
+SCM
+Paper_book::systems ()
+{
+  if (systems_ != SCM_BOOL_F)
+    return systems_;
+
+  systems_ = SCM_EOL;
+  Stencil title = book_title ();
+
+  if (!title.is_empty ())
+    {
+      Paper_system *ps = new Paper_system (title, true);
+      systems_ = scm_cons (ps->self_scm (), systems_);
+      scm_gc_unprotect_object (ps->self_scm ());
+    }
+  
+  int score_count = score_systems_.size ();
   for (int i = 0; i < score_count; i++)
     {
-      Stencil *title = get_title (i);
-      if (title)
-       book_height += title->extent (Y_AXIS).length ();
-      Real h = 0;
-      if (title)
-       h = title->extent (Y_AXIS).length ();
-
-      int line_count = SCM_VECTOR_LENGTH ((SCM) scores_[i]);
-      for (int j = 0; j < line_count; j++)
+      Stencil title = score_title (i);      
+      if (!title.is_empty ())
        {
-         SCM line = scm_vector_ref ((SCM) scores_[i], scm_int2num (j));
-         h += ly_scm2offset (ly_car (line))[Y_AXIS];
-         if (page->height_ + h > text_height)
-           {
-             pages->push (page);
-             page = new Page (paper);
-           }
-         if (page->height_ + h <= text_height || page->height_ == 0)
-           {
-             if (j == 0 && title)
-               {
-                 Offset dim = Offset (title->extent (X_AXIS).length (),
-                                      title->extent (Y_AXIS).length ());
-                 page->lines_
-                   = ly_snoc (scm_cons (ly_offset2scm (dim),
-                                        scm_list_1
-                                        (scm_cons
-                                         (ly_offset2scm (Offset (0, 0)),
-                                          title->smobbed_copy ()))),
-                            page->lines_);
-               }
-             page->lines_ = ly_snoc (line, page->lines_);
-             page->height_ += h;
-             h = 0;
-           }
+         Paper_system *ps = new Paper_system (title, true);
+         systems_ = scm_cons (ps->self_scm (), systems_);
+         scm_gc_unprotect_object (ps->self_scm ());
+       }
+      
+      if (scm_vector_p (score_systems_[i].systems_) == SCM_BOOL_T)
+       {
+         // guh.         
+         SCM system_list = scm_vector_to_list (score_systems_[i].systems_);
+
+         system_list = scm_reverse (system_list);
+         systems_ = scm_append (scm_list_2 (system_list, systems_));
        }
     }
   
-  pages->push (page);
-  return pages;
-}
-
-void
-Paper_book::classic_output (String outname)
-{
-  Paper_outputter *out = papers_.top ()->get_paper_outputter (outname);
-  int count = scores_.size ();
+  systems_ = scm_reverse (systems_);
   
-  out->output_metadata (get_scopes (count - 1), papers_.top ());
-  out->output_header (papers_.top ());
+  int i = 0;
+  Paper_system *last = 0;
+  for (SCM s = systems_; s != SCM_EOL; s = scm_cdr (s))
+    {
+      Paper_system *ps = unsmob_paper_system (scm_car (s));
+      ps->number_ = ++i;
 
-  int line_count = SCM_VECTOR_LENGTH ((SCM) scores_.top ());
-  for (int i = 0; i < line_count; i++)
-    out->output_line (scm_vector_ref ((SCM) scores_.top (), scm_int2num (i)),
-                     i == line_count - 1);
+      if (last && last->is_title ())
+       // ugh, hardcoded.      
+       ps->penalty_ = 10000;
+      last = ps;
+    }
   
-  out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
-  progress_indication ("\n");
+  return systems_;
 }
 
-
-#include "ly-smobs.icc"
-
-IMPLEMENT_DEFAULT_EQUAL_P (Paper_book);
-IMPLEMENT_SMOBS (Paper_book)
-IMPLEMENT_TYPE_P (Paper_book, "ly:paper-book?")
-
 SCM
-Paper_book::mark_smob (SCM smob)
+Paper_book::pages ()
 {
-  Paper_book *pb = (Paper_book*) SCM_CELL_WORD_1 (smob);
-  for (int i = 0; i < pb->headers_.size (); i++)
-    scm_gc_mark (pb->headers_[i]);
-  for (int i = 0; i < pb->global_headers_.size (); i++)
-    scm_gc_mark (pb->global_headers_[i]);
-  for (int i = 0; i < pb->papers_.size (); i++)
-    scm_gc_mark (pb->papers_[i]->self_scm ());
-  for (int i = 0; i < pb->scores_.size (); i++)
-    scm_gc_mark (pb->scores_[i]);
-  return SCM_EOL;
+  if (SCM_BOOL_F != pages_)
+    return pages_;
+
+  pages_ = SCM_EOL;
+  SCM proc = paper_->c_variable ("page-breaking");
+  pages_ = scm_apply_0 (proc, scm_list_2 (systems (), self_scm ()));
+  return pages_;
 }
 
-int
-Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
+
+/****************************************************************/
+
+Score_systems::Score_systems ()
 {
-  Paper_book *b = (Paper_book*) ly_cdr (smob);
-     
-  scm_puts ("#<", port);
-  scm_puts (classname (b), port);
-  scm_puts (" ", port);
-  //scm_puts (b->, port);
-  scm_puts (">", port);
-  return 1;
+  systems_ = SCM_EOL;
+  header_ = SCM_EOL;
 }
 
-Paper_book::~Paper_book ()
+void
+Score_systems::gc_mark ()
 {
+  scm_gc_mark (systems_);
+  scm_gc_mark (header_);
 }