]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/system.cc
Doc: NR trivial word change for footnotes
[lilypond.git] / lily / system.cc
index f4a37cd24dfa66d13eb4f891cf7c02cea064abfa..4e5fc1bb4ce5a9815b919d39917eaab86d164451 100644 (file)
@@ -23,6 +23,7 @@
 #include "all-font-metrics.hh"
 #include "axis-group-interface.hh"
 #include "break-align-interface.hh"
+#include "column-description.hh"
 #include "grob-array.hh"
 #include "hara-kiri-group-spanner.hh"
 #include "international.hh"
@@ -46,7 +47,6 @@ System::System (System const &src)
   all_elements_ = 0;
   pscore_ = 0;
   rank_ = 0;
-  checked_footnotes_ = false;
   init_elements ();
 }
 
@@ -55,7 +55,6 @@ System::System (SCM s)
 {
   all_elements_ = 0;
   rank_ = 0;
-  checked_footnotes_ = false;
   init_elements ();
 }
 
@@ -190,6 +189,7 @@ System::do_break_substitution_and_fixup_refpoints ()
     {
       System *child = dynamic_cast<System *> (broken_intos_[i]);
       child->all_elements_->remove_duplicates ();
+
       for (vsize j = 0; j < child->all_elements_->size (); j++)
         {
           Grob *g = child->all_elements_->grob (j);
@@ -228,66 +228,83 @@ System::get_paper_systems ()
   return lines;
 }
 
-void
-System::populate_footnote_grob_vector ()
-{
-  extract_grob_set (this, "all-elements", all_elts);
-  for (vsize i = 0; i < all_elts.size (); i++)
-    if (all_elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface")))
-      footnote_grobs_.push_back (all_elts[i]);
-
-  sort (footnote_grobs_.begin (), footnote_grobs_.end (), Grob::less);
-  checked_footnotes_ = true;
-}
-
-void
-System::get_footnote_grobs_in_range (vector<Grob *> &out, vsize start, vsize end)
+vector<Grob *>
+System::get_footnote_grobs_in_range (vsize start, vsize end)
 {
-  if (!checked_footnotes_)
-    populate_footnote_grob_vector ();
-
-  for (vsize i = 0; i < footnote_grobs_.size (); i++)
+  vector<Grob *> out;
+  extract_grob_set (this, "footnotes-before-line-breaking", footnote_grobs);
+  for (vsize i = 0; i < footnote_grobs.size (); i++)
     {
-      int pos = footnote_grobs_[i]->spanned_rank_interval ()[LEFT];
+      Grob *at_bat = footnote_grobs[i];
+      int pos = at_bat->spanned_rank_interval ()[LEFT];
       bool end_of_line_visible = true;
-      if (Spanner *s = dynamic_cast<Spanner *>(footnote_grobs_[i]))
+      if (Spanner *s = dynamic_cast<Spanner *>(at_bat))
         {
           Direction spanner_placement = robust_scm2dir (s->get_property ("spanner-placement"), LEFT);
           if (spanner_placement == CENTER)
             spanner_placement = LEFT;
 
           pos = s->spanned_rank_interval ()[spanner_placement];
+          if (s->original ())
+            {
+              Spanner *orig = dynamic_cast<Spanner *>(s->original ());
+              at_bat = spanner_placement == LEFT ? orig->broken_intos_[0] : orig->broken_intos_.back ();
+              pos = at_bat->spanned_rank_interval ()[RIGHT];
+            }
         }
 
-      if (Item *item = dynamic_cast<Item *>(footnote_grobs_[i]))
+      if (Item *item = dynamic_cast<Item *>(at_bat))
         {
           if (!Item::break_visible (item))
             continue;
           // safeguard to bring down the column rank so that end of line footnotes show up on the correct line
-          end_of_line_visible = (LEFT == item->break_status_dir ());
+          if (pos == int (start) && item->break_status_dir () != RIGHT)
+            continue;
+          if (pos == int (end) && item->break_status_dir () != LEFT)
+            continue;
+          if (pos != int (end) && pos != int (start) && item->break_status_dir () != CENTER)
+            continue;
         }
 
       if (pos < int (start))
         continue;
       if (pos > int (end))
-        break;
+        continue;
       if (pos == int (start) && end_of_line_visible)
         continue;
       if (pos == int (end) && !end_of_line_visible)
         continue;
-      if (!footnote_grobs_[i]->is_live ())
+      if (!at_bat->is_live ())
         continue;
 
-      out.push_back (footnote_grobs_[i]);
+      out.push_back (at_bat);
     }
+  return out;
+}
+
+vector<Real>
+System::get_footnote_heights_in_range (vsize start, vsize end)
+{
+  return internal_get_note_heights_in_range (start, end, true);
+}
+
+vector<Real>
+System::get_in_note_heights_in_range (vsize start, vsize end)
+{
+  return internal_get_note_heights_in_range (start, end, false);
 }
 
-vector<Stencil *>
-System::get_footnotes_in_range (vsize start, vsize end)
+vector<Real>
+System::internal_get_note_heights_in_range (vsize start, vsize end, bool foot)
 {
-  vector<Grob *> footnote_grobs;
-  get_footnote_grobs_in_range (footnote_grobs, start, end);
-  vector<Stencil *> out;
+  vector<Grob *> footnote_grobs = get_footnote_grobs_in_range (start, end);
+  vector<Real> out;
+
+  for (vsize i = footnote_grobs.size (); i--;)
+    if (foot
+        ? !to_boolean (footnote_grobs[i]->get_property ("footnote"))
+        : to_boolean (footnote_grobs[i]->get_property ("footnote")))
+      footnote_grobs.erase (footnote_grobs.begin () + i);
 
   for (vsize i = 0; i < footnote_grobs.size (); i++)
     {
@@ -303,7 +320,7 @@ System::get_footnotes_in_range (vsize start, vsize end)
                                                            props, footnote_markup);
 
       Stencil *footnote_stencil = unsmob_stencil (footnote_stl);
-      out.push_back (footnote_stencil);
+      out.push_back (footnote_stencil->extent (Y_AXIS).length ());
     }
 
   return out;
@@ -312,13 +329,66 @@ System::get_footnotes_in_range (vsize start, vsize end)
 vsize
 System::num_footnotes ()
 {
-  return footnote_grobs_.size ();
+  extract_grob_set (this, "footnotes-after-line-breaking", footnote_grobs);
+  return footnote_grobs.size ();
+}
+
+bool
+grob_2D_less (Grob *g1, Grob *g2)
+{
+  int sri[] = {0, 0};
+  Grob *gs[] = {g1, g2};
+
+  for (int i = 0; i < 2; i++)
+    {
+      sri[i] = gs[i]->spanned_rank_interval ()[LEFT];
+      if (Spanner *s = dynamic_cast<Spanner *> (gs[i]))
+        {
+          if (s->broken_intos_.size ())
+            s = (scm_to_int (s->broken_intos_[0]->get_property ("spanner-placement")) == LEFT
+                 ? s->broken_intos_[0]
+                 : s->broken_intos_.back ());
+          gs[i] = s;
+          if (robust_scm2double (s->get_property ("X-offset"), 0.0) > 0)
+            sri[i] = s->spanned_rank_interval ()[RIGHT];
+        }
+    }
+
+  if (sri[0] == sri[1])
+    return Grob::vertical_less (gs[0], gs[1]);
+
+  return sri[0] < sri[1];
+}
+
+MAKE_SCHEME_CALLBACK (System, footnotes_before_line_breaking, 1);
+SCM
+System::footnotes_before_line_breaking (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  vector<Grob *> footnotes;
+  SCM grobs_scm = Grob_array::make_array ();
+  extract_grob_set (me, "all-elements", elts);
+  for (vsize i = 0; i < elts.size (); i++)
+    if (elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface")))
+      footnotes.push_back (elts[i]);
+
+  unsmob_grob_array (grobs_scm)->set_array (footnotes);
+  return grobs_scm;
 }
 
-vector<Grob *>*
-System::footnote_grobs ()
+MAKE_SCHEME_CALLBACK (System, footnotes_after_line_breaking, 1);
+SCM
+System::footnotes_after_line_breaking (SCM smob)
 {
-  return &footnote_grobs_;
+  Spanner *sys_span = unsmob_spanner (smob);
+  System *sys = dynamic_cast<System *> (sys_span);
+  Interval_t<int> sri = sys->spanned_rank_interval ();
+  vector<Grob *> footnote_grobs = sys->get_footnote_grobs_in_range (sri[LEFT], sri[RIGHT]);
+  vector_sort (footnote_grobs, grob_2D_less);
+
+  SCM grobs_scm = Grob_array::make_array ();
+  unsmob_grob_array (grobs_scm)->set_array (footnote_grobs);
+  return grobs_scm;
 }
 
 void
@@ -337,8 +407,6 @@ System::break_into_pieces (vector<Column_x_positions> const &breaking)
       Interval iv (pure_height (this, st, end));
       system->set_property ("pure-Y-extent", ly_interval2scm (iv));
 
-      get_footnote_grobs_in_range (system->footnote_grobs_, st, end);
-
       system->set_bound (LEFT, c[0]);
       system->set_bound (RIGHT, c.back ());
       SCM system_labels = SCM_EOL;
@@ -537,7 +605,7 @@ System::get_paper_system ()
   pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
   pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
 
-  if (right_bound->original () == dynamic_cast<System*> (original ())->get_bound (RIGHT))
+  if (right_bound->original () == dynamic_cast<System *> (original ())->get_bound (RIGHT))
     pl->set_property ("last-in-score", SCM_BOOL_T);
 
   Interval staff_refpoints;
@@ -685,6 +753,82 @@ System::get_extremal_staff (Direction dir, Interval const &iv)
   return 0;
 }
 
+vector<Simple_spacer>
+System::get_simple_spacers (Real line_len, Real indent, bool ragged)
+{
+  if (!simple_spacers_.size ())
+    gen_simple_spacers (line_len, indent, ragged);
+
+  return simple_spacers_;
+}
+
+void
+System::gen_simple_spacers (Real line_len, Real indent, bool ragged)
+{
+  vector<vsize> breaks;
+  vector<Grob *> non_loose;
+  vector<Column_description> cols;
+  SCM force_break = ly_symbol2scm ("force");
+  vector<Grob *> columns = used_columns ();
+
+  for (vsize i = 0; i < columns.size (); i++)
+    if (!Paper_column::is_loose (columns[i])
+        || Paper_column::is_breakable (columns[i]))
+      non_loose.push_back (columns[i]);
+
+  breaks.clear ();
+  breaks.push_back (0);
+  cols.push_back (Column_description ());
+  for (vsize i = 1; i + 1 < non_loose.size (); i++)
+    {
+      if (Paper_column::is_breakable (non_loose[i]))
+        breaks.push_back (cols.size ());
+
+      cols.push_back (Column_description::get_column_description (non_loose, i, false));
+    }
+  breaks.push_back (cols.size ());
+  simple_spacers_.resize (breaks.size () * breaks.size (), Simple_spacer ());
+
+  for (vsize b = 0; b + 1 < breaks.size (); b++)
+    {
+      cols[breaks[b]] = Column_description::get_column_description (non_loose, breaks[b], true);
+      vsize st = breaks[b];
+
+      for (vsize c = b + 1; c < breaks.size (); c++)
+        {
+          vsize end = breaks[c];
+          Simple_spacer spacer;
+
+          for (vsize i = breaks[b]; i < end - 1; i++)
+            spacer.add_spring (cols[i].spring_);
+          spacer.add_spring (cols[end - 1].end_spring_);
+
+          for (vsize i = breaks[b]; i < end; i++)
+            {
+              for (vsize r = 0; r < cols[i].rods_.size (); r++)
+                if (cols[i].rods_[r].r_ < end)
+                  spacer.add_rod (i - st, cols[i].rods_[r].r_ - st, cols[i].rods_[r].dist_);
+              for (vsize r = 0; r < cols[i].end_rods_.size (); r++)
+                if (cols[i].end_rods_[r].r_ == end)
+                  spacer.add_rod (i - st, end - st, cols[i].end_rods_[r].dist_);
+              if (!cols[i].keep_inside_line_.is_empty ())
+                {
+                  spacer.add_rod (i - st, end - st, cols[i].keep_inside_line_[RIGHT]);
+                  spacer.add_rod (0, i - st, -cols[i].keep_inside_line_[LEFT]);
+                }
+            }
+          spacer.solve ((b == 0) ? line_len - indent : line_len, ragged);
+          spacer.minimal_ = c == b + 1;
+          simple_spacers_[b * breaks.size () + c] = spacer;
+
+          if (!spacer.fits ()
+              || (end < cols.size ()
+                  && cols[end].break_permission_ == force_break))
+            break;
+        }
+    }
+}
+
 Interval
 System::pure_refpoint_extent (vsize start, vsize end)
 {
@@ -840,7 +984,8 @@ System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
   return pure ? get_pure_bound (d, start, end) : get_bound (d);
 }
 
-enum {
+enum
+{
   SPACEABLE_STAVES,
   NONSPACEABLE_STAVES,
   ALL_STAVES
@@ -849,7 +994,7 @@ enum {
 static SCM
 get_maybe_spaceable_staves (SCM smob, int filter)
 {
-  System *me = dynamic_cast<System*> (unsmob_grob (smob));
+  System *me = dynamic_cast<System *> (unsmob_grob (smob));
   Grob *align = me->get_vertical_alignment ();
   SCM ret = SCM_EOL;
 
@@ -861,10 +1006,10 @@ get_maybe_spaceable_staves (SCM smob, int filter)
       for (vsize i = 0; i < staves.size (); ++i)
         {
           bool spaceable = Page_layout_problem::is_spaceable (staves[i]);
-          if (staves[i]->is_live () &&
-              ((filter == ALL_STAVES)
-               || (filter == SPACEABLE_STAVES && spaceable)
-               || (filter == NONSPACEABLE_STAVES && !spaceable)))
+          if (staves[i]->is_live ()
+              && ((filter == ALL_STAVES)
+                  || (filter == SPACEABLE_STAVES && spaceable)
+                  || (filter == NONSPACEABLE_STAVES && !spaceable)))
             {
               *tail = scm_cons (staves[i]->self_scm (), SCM_EOL);
               tail = SCM_CDRLOC (*tail);
@@ -896,7 +1041,6 @@ System::get_nonspaceable_staves (SCM smob)
   return get_maybe_spaceable_staves (smob, NONSPACEABLE_STAVES);
 }
 
-
 ADD_INTERFACE (System,
                "This is the top-level object: Each object in a score"
                " ultimately has a @code{System} object as its X and"
@@ -905,6 +1049,12 @@ ADD_INTERFACE (System,
                /* properties */
                "all-elements "
                "columns "
+               "footnote-stencil "
+               "footnotes-before-line-breaking "
+               "footnotes-after-line-breaking "
+               "in-note-direction "
+               "in-note-padding "
+               "in-note-stencil "
                "labels "
                "pure-Y-extent "
                "skyline-horizontal-padding "