Web: mention Linux Magazine article.

[lilypond.git] / lily / page-layout-problem.cc

diff --git a/lily/page-layout-problem.cc b/lily/page-layout-problem.cc
index 54624304d540f60b85367e2bdf54be296b415ef3..636e937a72eab6290433b242a24e992d074f3f0b 100644 (file)
--- a/lily/page-layout-problem.cc
+++ b/lily/page-layout-problem.cc
@@ -32,6 +32,98 @@
 #include "prob.hh"
 #include "skyline-pair.hh"
 #include "system.hh"
+#include "text-interface.hh"
+
+/*
+   Returns a stencil for the footnote of each system.  This stencil may
+   itself be comprised of several footnotes.
+*/
+
+SCM
+Page_layout_problem::get_footnotes_from_lines (SCM lines, Real padding)
+{
+  SCM footnotes = SCM_EOL;
+  // ugh...code dup from the Page_layout_problem constructor
+  for (SCM s = lines; scm_is_pair (s); s = scm_cdr (s))
+    {
+      if (Grob *g = unsmob_grob (scm_car (s)))
+       {
+         System *sys = dynamic_cast<System *> (g);
+         if (!sys)
+            {
+              programming_error ("got a grob for footnotes that wasn't a System");
+              continue;
+            }
+          footnotes = scm_cons (sys->make_footnote_stencil (padding).smobbed_copy (), footnotes);
+        }
+      else if (Prob *p = unsmob_prob (scm_car (s)))
+        {
+          SCM stencils = p->get_property ("footnotes");
+          if (stencils == SCM_EOL)
+            continue;
+          Stencil footnote_stencil;
+
+          for (SCM st = stencils; scm_is_pair (st); st = scm_cdr (st))
+            footnote_stencil.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (scm_car (st)), padding);
+          footnotes = scm_cons (footnote_stencil.smobbed_copy (), footnotes);
+        }
+    }
+
+  if (!scm_is_pair (footnotes))
+    return SCM_EOL;
+
+  return scm_reverse (footnotes);
+}
+
+Stencil*
+Page_layout_problem::get_footnote_separator_stencil (Output_def *paper)
+{
+  SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
+                          paper->self_scm ());
+
+  SCM markup = paper->c_variable ("footnote-separator-markup");
+
+  if (!Text_interface::is_markup (markup))
+    return NULL;
+
+  SCM footnote_stencil = Text_interface::interpret_markup (paper->self_scm (),
+                                                           props, markup);
+
+  Stencil *footnote_separator = unsmob_stencil (footnote_stencil);
+
+  return footnote_separator;
+}
+
+void
+Page_layout_problem::add_footnotes_to_footer (SCM footnotes, Stencil *foot, Paper_book *pb)
+{
+  bool footnotes_found = false;
+  Real footnote_padding = robust_scm2double (pb->paper_->c_variable ("footnote-padding"), 0.0);
+  Real footnote_footer_padding = robust_scm2double (pb->paper_->c_variable ("footnote-footer-padding"), 0.0);
+  
+  footnotes = scm_reverse (footnotes);
+
+  for (SCM s = footnotes; scm_is_pair (s); s = scm_cdr (s))
+    {
+      Stencil *stencil = unsmob_stencil (scm_car (s));
+
+      if (!stencil)
+        continue;
+
+      if (!stencil->is_empty ())
+        {
+          foot->add_at_edge (Y_AXIS, UP, *stencil, (!footnotes_found ? footnote_footer_padding : footnote_padding));
+          footnotes_found = true;
+        }
+    }
+  
+  if (footnotes_found)
+    {
+      Stencil *separator = get_footnote_separator_stencil (pb->paper_);
+      if (separator)
+        foot->add_at_edge (Y_AXIS, UP, *separator, footnote_padding);
+    }
+}
 
 Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM systems)
   : bottom_skyline_ (DOWN)
@@ -47,7 +139,13 @@ Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM syst
     {
       Stencil *head = unsmob_stencil (page->get_property ("head-stencil"));
       Stencil *foot = unsmob_stencil (page->get_property ("foot-stencil"));
-
+      
+      Real footnote_padding = 0.0;
+      if (pb && pb->paper_)
+        footnote_padding = robust_scm2double (pb->paper_->c_variable ("footnote-padding"), 0.0);
+      SCM footnotes = get_footnotes_from_lines (systems, footnote_padding);
+      add_footnotes_to_footer (footnotes, foot, pb);
+      
       header_height_ = head ? head->extent (Y_AXIS).length () : 0;
       footer_height_ = foot ? foot->extent (Y_AXIS).length () : 0;
       page_height_ = robust_scm2double (page->get_property ("paper-height"), 100);
@@ -319,10 +417,10 @@ Page_layout_problem::solve_rod_spring_problem (bool ragged)
       Real overflow = spacer.configuration_length (spacer.force ())
                      - page_height_;
       if (ragged && overflow < 1e-6)
-       warning (_ ("couldn't fit music on page: ragged-spacing was requested, but page was compressed"));
+       warning (_ ("cannot fit music on page: ragged-spacing was requested, but page was compressed"));
       else
        {
-         warning (_f ("couldn't fit music on page: overflow is %f",
+         warning (_f ("cannot fit music on page: overflow is %f",
                       overflow));
          warning (_ ("compressing music to fit"));
          vsize space_count = solution_.size ();
@@ -658,6 +756,19 @@ Page_layout_problem::read_spacing_spec (SCM spec, Real* dest, SCM sym)
 Real
 Page_layout_problem::get_fixed_spacing (Grob *before, Grob *after, int spaceable_index, bool pure, int start, int end)
 {
+  Spanner *after_sp = dynamic_cast<Spanner*> (after);
+  SCM cache_symbol = (is_spaceable (before) && is_spaceable (after))
+    ? ly_symbol2scm ("spaceable-fixed-spacing")
+    : ly_symbol2scm ("loose-fixed-spacing");
+  if (pure)
+    {
+      // The result of this function doesn't depend on "end," so we can reduce the
+      // size of the cache by ignoring it.
+      SCM cached = after_sp->get_cached_pure_property (cache_symbol, start, 0);
+      if (scm_is_number (cached))
+       return robust_scm2double (cached, 0.0);
+    }
+
   SCM spec = Page_layout_problem::get_spacing_spec (before, after, pure, start, end);
   Real ret = -infinity_f;
   Real stretchability = 0;
@@ -681,6 +792,11 @@ Page_layout_problem::get_fixed_spacing (Grob *before, Grob *after, int spaceable
            ret = max (ret, scm_to_double (forced));
        }
     }
+
+  // Cache the result.  As above, we ignore "end."
+  if (pure)
+    after_sp->cache_pure_property (cache_symbol, start, 0, scm_from_double (ret));
+    
   return ret;
 }