]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/paper-book.cc
* ly/declarations-init.ly (paper): Define page-breaking.
[lilypond.git] / lily / paper-book.cc
index edb4396d2d6cc29fe7d485b63231a8126c9192cd..5f8624f511225439345d7cd26fbdd0a54953ca24 100644 (file)
@@ -19,7 +19,6 @@
 #include "stencil.hh"
 
 static Real const MIN_COVERAGE = 0.66;
-static Real const MAX_CRAMP = 0.05;
 
 static SCM
 stencil2line (Stencil* stil, bool is_title = false)
@@ -29,7 +28,8 @@ stencil2line (Stencil* stil, bool is_title = false)
     z = scm_permanent_object (ly_offset2scm (Offset (0, 0)));
   Offset dim = Offset (stil->extent (X_AXIS).length (),
                       stil->extent (Y_AXIS).length ());
-  Paper_line * pl = new Paper_line (dim, scm_cons (stil->smobbed_copy (), SCM_EOL), is_title);
+  Paper_line *pl = new Paper_line (dim, scm_cons (stil->smobbed_copy (),
+                                                 SCM_EOL), is_title);
   return pl->self_scm ();
 }
 
@@ -199,6 +199,43 @@ Paper_book::~Paper_book ()
 {
 }
 
+#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 *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]);
+
+  scm_gc_mark (pb->copyright_);
+  
+  return pb->tagline_;
+}
+
+int
+Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
+{
+  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;
+}
+
 void
 Paper_book::output (String outname)
 {
@@ -206,11 +243,11 @@ Paper_book::output (String outname)
     return;
     
   /* Generate all stencils to trigger font loads.  */
-  Link_array<Page> *pages = get_pages ();
+  Link_array<Page> *pages = this->pages ();
 
   Paper_def *paper = papers_[0];
   Paper_outputter *out = paper->get_paper_outputter (outname);
-  out->output_header (paper, get_scopes (0), pages->size ());
+  out->output_header (paper, scopes (0), pages->size ());
 
   int page_count = pages->size ();
   for (int i = 0; i < page_count; i++)
@@ -221,7 +258,7 @@ Paper_book::output (String outname)
 }
 
 SCM
-Paper_book::get_scopes (int i)
+Paper_book::scopes (int i)
 {
   SCM scopes = SCM_EOL;
   if (headers_[i])
@@ -232,7 +269,7 @@ Paper_book::get_scopes (int i)
 }
 
 Stencil*
-Paper_book::get_title (int i)
+Paper_book::title (int i)
 {
   SCM user_title = scm_primitive_eval (ly_symbol2scm ("user-title"));
   SCM book_title = scm_primitive_eval (ly_symbol2scm ("book-title"));
@@ -241,7 +278,7 @@ Paper_book::get_title (int i)
               : ly_symbol2scm ("scoreTitle"));
 
   Stencil *title = 0;
-  SCM scopes = get_scopes (i);
+  SCM scopes = this->scopes (i);
   SCM s = ly_modules_lookup (scopes, field);
   if (s != SCM_UNDEFINED && scm_variable_bound_p (s) == SCM_BOOL_T)
     title = unsmob_stencil (scm_call_2 (user_title,
@@ -257,6 +294,23 @@ Paper_book::get_title (int i)
   return title;
 }
 
+void
+Paper_book::classic_output (String outname)
+{
+  int count = scores_.size ();
+  Paper_outputter *out = papers_.top ()->get_paper_outputter (outname);
+  out->output_header (papers_.top (), scopes (count - 1), 0);
+
+  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)),
+                     0, i == line_count - 1);
+  
+  out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
+  progress_indication ("\n");
+}
+
+
 /* calculate book height, #lines, stencils.  */
 void
 Paper_book::init ()
@@ -268,7 +322,7 @@ Paper_book::init ()
   height_ = 0;
   for (int i = 0; i < score_count; i++)
     {
-      Stencil *title = get_title (i);
+      Stencil *title = this->title (i);
       if (title)
        height_ += title->extent (Y_AXIS).length ();
 
@@ -281,7 +335,7 @@ Paper_book::init ()
     }
 
   Paper_def *paper = papers_[0];
-  SCM scopes = get_scopes (0);
+  SCM scopes = this->scopes (0);
 
   SCM make_tagline = scm_primitive_eval (ly_symbol2scm ("make-tagline"));
   tagline_ = scm_call_2 (make_tagline, paper->self_scm (), scopes);
@@ -298,13 +352,26 @@ Paper_book::init ()
   height_ += copy_height;
 }
 
-/* Ideas:
-   - real page breaking algorithm (Gourlay?)
-     Hmmughr, Gourlay uses Grobs, columns etc -- looks like it needs serious
-     refactoring before it can be applied to Page breaking...
-   - override: # pages, or pageBreakLines= #'(3 3 4), ?  */
+SCM
+Paper_book::lines ()
+{
+  int score_count = scores_.size ();
+  SCM lines = SCM_EOL;
+  for (int i = 0; i < score_count; i++)
+    {
+      if (Stencil *title = this->title (i))
+       lines = ly_snoc (stencil2line (title, true), lines);
+      lines = scm_append (scm_list_2 (lines, scm_vector_to_list (scores_[i])));
+    }
+  //debug helper; ughr
+  int i = 0;
+  for (SCM s = lines; s != SCM_EOL; s = ly_cdr (s))
+    unsmob_paper_line (ly_car (s))->number_ = ++i;
+  return lines;
+}
+
 Link_array<Page>*
-Paper_book::get_pages ()
+Paper_book::pages ()
 {
   init ();
   Page::page_count_ = 0;
@@ -312,81 +379,155 @@ Paper_book::get_pages ()
   Page *page = new Page (paper, 1);
 
   Real text_height = page->text_height ();
-  Real page_frac = height_ / text_height;
-  int page_count = (int) ceil (page_frac);
+
+  Real copy_height = 0;
+  if (Stencil *s = unsmob_stencil (copyright_))
+    copy_height = s->extent (Y_AXIS).length ();
+
+  Real tag_height = 0;
+  if (Stencil *s = unsmob_stencil (tagline_))
+    tag_height = s->extent (Y_AXIS).length ();
+
+  SCM all = lines ();
+  SCM proc = paper->get_scmvar ("page-breaking");
+  //  SCM proc = paper->scm_primitive_eval (ly_symbol2scm ("page-breaking"));
+  //  SCM proc = scm_primitive_eval (ly_symbol2scm ("page-breaking"));
+  SCM breaks = scm_apply_0 (proc, scm_list_n (all,
+                                             gh_double2scm (height_),
+                                             gh_double2scm (text_height),
+                                             gh_double2scm (copy_height),
+                                             gh_double2scm (tag_height),
+                                             SCM_UNDEFINED));
+
+  /* Copyright on first page.  */
   if (unsmob_stencil (copyright_))
     page->copyright_ = copyright_;
-  if (unsmob_stencil (tagline_) && page_count == 1)
-    page->tagline_ = tagline_;
 
-  /* Attempt to fill pages better using FUDGE kludge.  */
-  Real r = page_frac - (int) page_frac;
-  Real cramp_fudge = page_count > 1 ? (r / (page_count - 1)) * text_height : 0;
-  Real expand_fudge = - ((1 - r) / page_count) * text_height;
-  
-  Link_array<Page>* pages = 0;
-  if ((page_count > 1 && (r / (page_count - 1)) < MAX_CRAMP))
+  Link_array<Page> *pages = new Link_array<Page>;
+  int page_count = SCM_VECTOR_LENGTH ((SCM) breaks);
+  int line = 1;
+  for (int i = 0; i < page_count; i++)
     {
-      /* Just a little more space (<MAX_CRAMP) per page is needed,
-        cramp onto one page less.  */
-      pages = fill_pages (page, page_count - 1, cramp_fudge);
-      if (pages->size () != page_count - 1)
+      if (i)
+       page = new Page (paper, i+1);
+      int next = i + 1 < page_count
+       ? gh_scm2int (scm_vector_ref (breaks, gh_int2scm (i))) : 0;
+      while ((!next && all != SCM_EOL) || line <= next)
        {
-         /* Cramping failed.  */
-         page = pages->get (0);
-         delete pages;
-         pages = 0;
+         page->lines_ = ly_snoc (ly_car (all), page->lines_);
+         all = ly_cdr (all);
+         line++;
        }
-    }      
-  if (!pages && ((1 - r) / page_count) < 1 - MIN_COVERAGE)
+      pages->push (page);
+    }
+
+  /* Tagline on last page.  */
+  if (unsmob_stencil (tagline_))
+    page->tagline_ = tagline_;
+  return pages;
+}
+
+static SCM
+c_ragged_page_breaks (SCM lines, Real book_height, Real text_height,
+                     Real first, Real last)
+{
+  int page_number = 0;
+  int page_count = int (book_height / text_height + 0.5);
+  SCM breaks = SCM_EOL;
+  Real page_height = text_height + first;
+  Real h = 0;
+  int number = 0;
+  for (SCM s = lines; s != SCM_EOL; s = ly_cdr (s))
     {
-      /* There is space left, but not so much that paged would have too
-        little blackness (< MIN_COVERAGE), distribute evenly.  */
-      pages = fill_pages (page, page_count, expand_fudge);
-      bool badly_covered = false;
-      if (pages->size () == page_count)
-       for (int i = 0; i < page_count; i++)
-         {
-           Page *p = (*pages)[i];
-           Real coverage = p ->height_ / p->text_height ();
-           if (coverage < MIN_COVERAGE)
-             {
-               badly_covered = true;
-               break;
-             }
-         }
-      if (pages->size () != page_count || badly_covered)
+      Paper_line *pl = unsmob_paper_line (ly_car (s));
+      if (!pl->is_title () && h < page_height)
+       number++;
+      h += pl->dim ()[Y_AXIS];
+      if (!pl->is_title () && h > page_height)
        {
-         /* expanding failed.  */
-         page = pages->get (0);
-         delete pages;
-         pages = 0;
+         breaks = ly_snoc (gh_int2scm (number), breaks);
+         page_number++;
+         page_height = text_height + (page_number == page_count) * last;
+         h = 0;
        }
+      if (ly_cdr (s) == SCM_EOL)
+       breaks = ly_snoc (gh_int2scm (pl->number_), breaks);
     }
-  
-  if (!pages)
-    /* Fudging failed; just fill pages.  */
-    pages = fill_pages (page, page_count, 0);
-  return pages;
+
+  return scm_vector (breaks);
+}
+
+LY_DEFINE (ly_ragged_page_breaks, "ly:ragged-page-breaks",
+          5, 0, 0, (SCM lines, SCM book, SCM text, SCM first, SCM last),
+          "Return a vector with line numbers of page breaks.")
+{
+  SCM_ASSERT_TYPE (scm_pair_p (lines), lines, SCM_ARG1, __FUNCTION__, "list");
+  SCM_ASSERT_TYPE (gh_number_p (book), book, SCM_ARG2, __FUNCTION__, "real");
+  SCM_ASSERT_TYPE (gh_number_p (text), text, SCM_ARG2, __FUNCTION__, "real");
+  SCM_ASSERT_TYPE (gh_number_p (first), first, SCM_ARG2, __FUNCTION__, "real");
+  SCM_ASSERT_TYPE (gh_number_p (last), last, SCM_ARG2, __FUNCTION__, "real");
+
+  return c_ragged_page_breaks (lines,
+                              gh_scm2double (book), gh_scm2double (text),
+                              gh_scm2double (first), gh_scm2double (last));
 }
 
-/* Simplistic page breaking:
-   add lines until HEIGHT > PAGE.TEXT_HEIGHT_ + FUDGE  */
+#if 0
 Link_array<Page>*
-Paper_book::fill_pages (Page *page, int page_count, Real fudge)
+Paper_book::ragged_pages ()
 {
-  int page_number = 1;
+  Link_array<Page> *pages = new Link_array<Page>;
   int score_count = scores_.size ();
+
+  /* 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 = this->title (i);
+      if (title)
+       book_height += title->extent (Y_AXIS).length ();
+
+      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];
+       }
+    }
+
   Paper_def *paper = papers_[0];
-  Link_array<Page> *pages = new Link_array<Page>;
-  page->lines_ = SCM_EOL;
-  page->height_ = 0;
-  page->line_count_ = 0;
+  SCM scopes = this->scopes (0);
+
+  SCM make_tagline = scm_primitive_eval (ly_symbol2scm ("make-tagline"));
+  SCM tagline = scm_call_2 (make_tagline, paper->self_scm (), scopes);
+  Real tag_height = 0;
+  if (Stencil *s = unsmob_stencil (tagline))
+    tag_height = s->extent (Y_AXIS).length ();
+  book_height += tag_height;
+
+  SCM make_copyright = scm_primitive_eval (ly_symbol2scm ("make-copyright"));
+  SCM copyright = scm_call_2 (make_copyright, paper->self_scm (), scopes);
+  Real copy_height = 0;
+  if (Stencil *s = unsmob_stencil (copyright))
+    copy_height = s->extent (Y_AXIS).length ();
+  book_height += copy_height;
+  
+  Page::page_count_ = 0;
+  int page_number = 0;
+  Page *page = new Page (paper, ++page_number);
+  int page_count = int (book_height / page->text_height () + 0.5);
+  if (unsmob_stencil (copyright))
+    page->copyright_ = copyright;
+  if (unsmob_stencil (tagline) && page_number == page_count)
+    page->tagline_ = tagline;
+
+  /* Simplistic page breaking.  */
   Real text_height = page->text_height ();
   for (int i = 0; i < score_count; i++)
     {
       Real h = 0;
-      Stencil *title = get_title (i);
+      Stencil *title = this->title (i);
       if (title)
        h = title->extent (Y_AXIS).length ();
 
@@ -395,17 +536,7 @@ Paper_book::fill_pages (Page *page, int page_count, Real fudge)
        {
          SCM line = scm_vector_ref ((SCM) scores_[i], scm_int2num (j));
          h += unsmob_paper_line (line)->dim ()[Y_AXIS];
-         Real fill = (page->height_ - text_height) / text_height;
-         // Real fill_h = (page->height_ + h - text_height) / text_height;
-         Real fudged_fill = (page->height_ - (text_height + fudge))
-           / (text_height + fudge);
-         Real fudged_fill_h = ((page->height_ + h) - (text_height + fudge))
-           / (text_height + fudge);
-         if (fill > -MAX_CRAMP
-             || (fudged_fill > -MAX_CRAMP
-                 && (fudge < 0
-                     || !(fudged_fill_h > 0
-                          && abs (fudged_fill_h) < 4 * abs (fudged_fill)))))
+         if (page->height_ + h > text_height)
            {
              pages->push (page);
              page = new Page (paper, ++page_number);
@@ -425,58 +556,4 @@ Paper_book::fill_pages (Page *page, int page_count, Real fudge)
   pages->push (page);
   return pages;
 }
-
-void
-Paper_book::classic_output (String outname)
-{
-  int count = scores_.size ();
-  Paper_outputter *out = papers_.top ()->get_paper_outputter (outname);
-  out->output_header (papers_.top (), get_scopes (count - 1), 0);
-
-  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)),
-                     0, i == line_count - 1);
-  
-  out->output_scheme (scm_list_1 (ly_symbol2scm ("end-output")));
-  progress_indication ("\n");
-}
-
-
-#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 *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]);
-
-  scm_gc_mark (pb->copyright_);
-
-  
-  return pb->tagline_;
-}
-
-int
-Paper_book::print_smob (SCM smob, SCM port, scm_print_state*)
-{
-  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;
-}
+#endif