lily/page-layout-problem.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2009--2010 Joe Neeman <joeneeman@gmail.com>
   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 "page-layout-problem.hh"
  21
  22 #include "align-interface.hh"
  23 #include "axis-group-interface.hh"
  24 #include "hara-kiri-group-spanner.hh"
  25 #include "international.hh"
  26 #include "item.hh"
  27 #include "output-def.hh"
  28 #include "paper-book.hh"
  29 #include "paper-column.hh"
  30 #include "paper-score.hh"
  31 #include "pointer-group-interface.hh"
  32 #include "prob.hh"
  33 #include "skyline-pair.hh"
  34 #include "system.hh"
  35
  36 Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM systems)
  37   : bottom_skyline_ (DOWN)
  38 {
  39   Prob *page = unsmob_prob (page_scm);
  40   header_height_ = 0;
  41   footer_height_ = 0;
  42   header_padding_ = 0;
  43   footer_padding_ = 0;
  44   page_height_ = 100;
  45
  46   if (page)
  47     {
  48       Stencil *head = unsmob_stencil (page->get_property ("head-stencil"));
  49       Stencil *foot = unsmob_stencil (page->get_property ("foot-stencil"));
  50
  51       header_height_ = head ? head->extent (Y_AXIS).length () : 0;
  52       footer_height_ = foot ? foot->extent (Y_AXIS).length () : 0;
  53       page_height_ = robust_scm2double (page->get_property ("paper-height"), 100);
  54     }
  55
  56   // Initially, bottom_skyline_ represents the top of the page. Make
  57   // it solid, so that the top of the first system will be forced
  58   // below the top of the printable area.
  59   bottom_skyline_.set_minimum_height (-header_height_);
  60
  61   SCM system_system_spacing = SCM_EOL;
  62   SCM score_system_spacing = SCM_EOL;
  63   SCM markup_system_spacing = SCM_EOL;
  64   SCM score_markup_spacing = SCM_EOL;
  65   SCM markup_markup_spacing = SCM_EOL;
  66
  67   // top_system_spacing controls the spring from the top of the printable
  68   // area to the first staff. It allows the user to control the offset of
  69   // the first staff (as opposed to the top of the first system) from the
  70   // top of the page. Similarly for last_bottom_spacing.
  71   SCM top_system_spacing = SCM_EOL;
  72   SCM last_bottom_spacing = SCM_EOL;
  73   if (pb && pb->paper_)
  74     {
  75       Output_def *paper = pb->paper_;
  76       system_system_spacing = paper->c_variable ("system-system-spacing");
  77       score_system_spacing = paper->c_variable ("score-system-spacing");
  78       markup_system_spacing = paper->c_variable ("markup-system-spacing");
  79       score_markup_spacing = paper->c_variable ("score-markup-spacing");
  80       markup_markup_spacing = paper->c_variable ("markup-markup-spacing");
  81       last_bottom_spacing = paper->c_variable ("last-bottom-spacing");
  82       top_system_spacing = paper->c_variable ("top-system-spacing");
  83       if (scm_is_pair (systems) && unsmob_prob (scm_car (systems)))
  84         top_system_spacing = paper->c_variable ("top-markup-spacing");
  85
  86       // Note: the page height here does _not_ reserve space for headers and
  87       // footers. This is because we want to anchor the top-system-spacing
  88       // spring at the _top_ of the header.
  89       page_height_ -= robust_scm2double (paper->c_variable ("top-margin"), 0)
  90         + robust_scm2double (paper->c_variable ("bottom-margin"), 0);
  91
  92       read_spacing_spec (top_system_spacing, &header_padding_, ly_symbol2scm ("padding"));
  93       read_spacing_spec (last_bottom_spacing, &footer_padding_, ly_symbol2scm ("padding"));
  94     }
  95   bool last_system_was_title = false;
  96
  97
  98   for (SCM s = systems; scm_is_pair (s); s = scm_cdr (s))
  99     {
 100       bool first = (s == systems);
 101
 102       if (Grob *g = unsmob_grob (scm_car (s)))
 103         {
 104           System *sys = dynamic_cast<System*> (g);
 105           if (!sys)
 106             {
 107               programming_error ("got a grob for vertical spacing that wasn't a System");
 108               continue;
 109             }
 110
 111           SCM spec = system_system_spacing;
 112           if (first)
 113             spec = top_system_spacing;
 114           else if (last_system_was_title)
 115             spec = markup_system_spacing;
 116           else if (0 == Paper_column::get_rank (sys->get_bound (LEFT)))
 117             spec = score_system_spacing;
 118
 119           Spring spring (0, 0);
 120           Real padding = 0.0;
 121           Real indent = line_dimensions_int (sys->paper_score ()->layout (), sys->get_rank ())[LEFT];
 122           alter_spring_from_spacing_spec (spec, &spring);
 123           read_spacing_spec (spec, &padding, ly_symbol2scm ("padding"));
 124
 125           append_system (sys, spring, indent, padding);
 126           last_system_was_title = false;
 127         }
 128       else if (Prob *p = unsmob_prob (scm_car (s)))
 129         {
 130           SCM spec = first ? top_system_spacing
 131             : (last_system_was_title ? markup_markup_spacing : score_markup_spacing);
 132           Spring spring (0, 0);
 133           Real padding = 0.0;
 134           alter_spring_from_spacing_spec (spec, &spring);
 135           read_spacing_spec (spec, &padding, ly_symbol2scm ("padding"));
 136
 137           append_prob (p, spring, padding);
 138           last_system_was_title = true;
 139         }
 140       else
 141         programming_error ("got a system that was neither a Grob nor a Prob");
 142     }
 143
 144   Spring last_spring (0, 0);
 145   Real last_padding = 0;
 146   alter_spring_from_spacing_spec (last_bottom_spacing, &last_spring);
 147   read_spacing_spec (last_bottom_spacing, &last_padding, ly_symbol2scm ("padding"));
 148   last_spring.ensure_min_distance (last_padding - bottom_skyline_.max_height () + footer_height_);
 149   springs_.push_back (last_spring);
 150
 151   if (elements_.size ())
 152     {
 153       Real bottom_padding = 0;
 154
 155       // TODO: junk bottom-space now that we have last-bottom-spacing?
 156       // bottom-space has the flexibility that one can do it per-system.
 157       // NOTE: bottom-space is misnamed since it is not stretchable space.
 158       if (Prob *p = elements_.back ().prob)
 159         bottom_padding = robust_scm2double (p->get_property ("bottom-space"), 0);
 160       else if (elements_.back ().staves.size ())
 161         {
 162           SCM details = get_details (elements_.back ());
 163           bottom_padding = robust_scm2double (ly_assoc_get (ly_symbol2scm ("bottom-space"),
 164                                                             details,
 165                                                             SCM_BOOL_F),
 166                                               0.0);
 167         }
 168       page_height_ -= bottom_padding;
 169     }
 170 }
 171
 172 void
 173 Page_layout_problem::set_header_height (Real height)
 174 {
 175   header_height_ = height;
 176 }
 177
 178 void
 179 Page_layout_problem::set_footer_height (Real height)
 180 {
 181   footer_height_ = height;
 182 }
 183
 184 void
 185 Page_layout_problem::append_system (System *sys, Spring const& spring, Real indent, Real padding)
 186 {
 187   Grob *align = sys->get_vertical_alignment ();
 188   if (!align)
 189     return;
 190
 191   align->set_property ("positioning-done", SCM_BOOL_T);
 192
 193   extract_grob_set (align, "elements", all_elts);
 194   vector<Grob*> elts = filter_dead_elements (all_elts);
 195   vector<Real> minimum_offsets = Align_interface::get_minimum_translations_without_min_dist (align, elts, Y_AXIS);
 196   vector<Real> minimum_offsets_with_min_dist = Align_interface::get_minimum_translations (align, elts, Y_AXIS);
 197
 198   Skyline up_skyline (UP);
 199   Skyline down_skyline (DOWN);
 200   build_system_skyline (elts, minimum_offsets_with_min_dist, &up_skyline, &down_skyline);
 201   up_skyline.shift (indent);
 202   down_skyline.shift (indent);
 203
 204   Real minimum_distance = up_skyline.distance (bottom_skyline_) + padding;
 205
 206   Spring spring_copy = spring;
 207   spring_copy.ensure_min_distance (minimum_distance);
 208   springs_.push_back (spring_copy);
 209
 210   bottom_skyline_ = down_skyline;
 211   elements_.push_back (Element (elts, minimum_offsets));
 212
 213   // Add the springs for the VerticalAxisGroups in this system.
 214
 215   // If the user has specified the offsets of the individual staves, fix the
 216   // springs at the given distances. Otherwise, use stretchable springs.
 217   SCM details = get_details (elements_.back ());
 218   SCM manual_dists = ly_assoc_get (ly_symbol2scm ("alignment-distances"), details, SCM_EOL);
 219   vsize last_spaceable_staff = 0;
 220   bool found_spaceable_staff = false;
 221   for (vsize i = 0; i < elts.size (); ++i)
 222     {
 223       if (is_spaceable (elts[i]))
 224         {
 225           // We don't add a spring for the first staff, since
 226           // we are only adding springs _between_ staves here.
 227           if (!found_spaceable_staff)
 228             {
 229               found_spaceable_staff = true;
 230               last_spaceable_staff = i;
 231               continue;
 232             }
 233
 234           Spring spring (0.5, 0.0);
 235           SCM spec = elts[last_spaceable_staff]->get_property ("staff-staff-spacing");
 236           alter_spring_from_spacing_spec (spec, &spring);
 237
 238           springs_.push_back (spring);
 239           Real min_distance = (found_spaceable_staff ? minimum_offsets[last_spaceable_staff] : 0) - minimum_offsets[i];
 240           springs_.back ().ensure_min_distance (min_distance);
 241
 242           if (scm_is_pair (manual_dists))
 243             {
 244               if (scm_is_number (scm_car (manual_dists)))
 245                 {
 246                   Real dy = scm_to_double (scm_car (manual_dists));
 247
 248                   springs_.back ().set_distance (dy);
 249                   springs_.back ().set_min_distance (dy);
 250                   springs_.back ().set_inverse_stretch_strength (0);
 251                 }
 252               manual_dists = scm_cdr (manual_dists);
 253             }
 254           last_spaceable_staff = i;
 255         }
 256     }
 257
 258   // Corner case: there was only one staff, and it wasn't spaceable.
 259   // Mark it spaceable, because we do not allow non-spaceable staves
 260   // to be at the top or bottom of a system.
 261   if (!found_spaceable_staff && elts.size ())
 262     mark_as_spaceable (elts[0]);
 263 }
 264
 265 void
 266 Page_layout_problem::append_prob (Prob *prob, Spring const& spring, Real padding)
 267 {
 268   Skyline_pair *sky = Skyline_pair::unsmob (prob->get_property ("vertical-skylines"));
 269   Real minimum_distance = 0;
 270   bool tight_spacing = to_boolean (prob->get_property ("tight-spacing"));
 271
 272   if (sky)
 273     {
 274       minimum_distance = (*sky)[UP].distance (bottom_skyline_);
 275       bottom_skyline_ = (*sky)[DOWN];
 276     }
 277   else if (Stencil *sten = unsmob_stencil (prob->get_property ("stencil")))
 278     {
 279       Interval iv = sten->extent (Y_AXIS);
 280       minimum_distance = iv[UP] - bottom_skyline_.max_height ();
 281
 282       bottom_skyline_.clear ();
 283       bottom_skyline_.set_minimum_height (iv[DOWN]);
 284     }
 285
 286   Spring spring_copy = spring;
 287   if (tight_spacing)
 288     {
 289       spring_copy.set_min_distance (minimum_distance);
 290       spring_copy.set_inverse_stretch_strength (0.0);
 291       spring_copy.set_distance (0.0);
 292     }
 293   else
 294     spring_copy.ensure_min_distance (minimum_distance + padding);
 295
 296   springs_.push_back (spring_copy);
 297   elements_.push_back (Element (prob));
 298 }
 299
 300 void
 301 Page_layout_problem::solve_rod_spring_problem (bool ragged)
 302 {
 303   Simple_spacer spacer;
 304
 305   for (vsize i = 0; i < springs_.size (); ++i)
 306     spacer.add_spring (springs_[i]);
 307
 308   spacer.solve (page_height_, ragged);
 309   solution_ = spacer.spring_positions ();
 310
 311   if (!spacer.fits ())
 312     warning (_f ("couldn't fit music on page: overflow is %f",
 313                  spacer.configuration_length(spacer.force()) - page_height_));
 314 }
 315
 316 // The solution_ vector stores the position of every live VerticalAxisGroup
 317 // and every title. From that information,
 318 // 1) within each system, stretch the staves so they land at the right position
 319 // 2) find the offset of each system (relative to the printable area of the page).
 320 // TODO: this function is getting too long, maybe split it up?
 321 SCM
 322 Page_layout_problem::find_system_offsets ()
 323 {
 324   SCM system_offsets = SCM_EOL;
 325   SCM *tail = &system_offsets;
 326
 327   // spring_idx 0 is the top of the page. Interesting values start from 1.
 328   vsize spring_idx = 1;
 329   vector<Grob*> loose_lines;
 330   vector<Real> loose_line_min_distances;
 331   Grob *last_spaceable_line = 0;
 332   Real last_spaceable_line_translation = 0;
 333   Interval last_title_extent;
 334   for (vsize i = 0; i < elements_.size (); ++i)
 335     {
 336       if (elements_[i].prob)
 337         {
 338           *tail = scm_cons (scm_from_double (solution_[spring_idx]), SCM_EOL);
 339           tail = SCM_CDRLOC (*tail);
 340           Interval prob_extent = unsmob_stencil (elements_[i].prob->get_property ("stencil"))->extent (Y_AXIS);
 341
 342           // Lay out any non-spaceable lines between this line and
 343           // the last one.
 344           if (loose_lines.size ())
 345             {
 346               Interval loose_extent = loose_lines.back ()->extent (loose_lines.back (), Y_AXIS);
 347               Real min_distance = -loose_extent[DOWN] + prob_extent[UP]; // TODO: include padding/minimum-distance
 348
 349               loose_line_min_distances.push_back (min_distance);
 350               loose_lines.push_back (0);
 351
 352               distribute_loose_lines (loose_lines, loose_line_min_distances,
 353                                       last_spaceable_line_translation, -solution_[spring_idx]);
 354               loose_lines.clear ();
 355               loose_line_min_distances.clear ();
 356             }
 357
 358           last_spaceable_line = 0;
 359           last_spaceable_line_translation = -solution_[spring_idx];
 360           last_title_extent = prob_extent;
 361           spring_idx++;
 362         }
 363       else
 364         {
 365           // Getting this signs right here is a little tricky. The configuration
 366           // we return has zero at the top of the page and positive numbers further
 367           // down, as does the solution_ vector.  Within a staff, however, positive
 368           // numbers are up.
 369           // TODO: perhaps change the way the page 'configuration variable works so
 370           // that it is consistent with the usual up/down sign conventions in
 371           // Lilypond. Then this would be less confusing.
 372
 373           // These two positions are relative to the page (with positive numbers being
 374           // down).
 375           Real first_staff_position = solution_[spring_idx];
 376           Real first_staff_min_translation = elements_[i].min_offsets.size () ? elements_[i].min_offsets[0] : 0;
 377           Real system_position = first_staff_position + first_staff_min_translation;
 378
 379           // Position the staves within this system.
 380           Real translation = 0;
 381           vector<Real> const& min_offsets = elements_[i].min_offsets;
 382           bool found_spaceable_staff = false;
 383           for (vsize staff_idx = 0; staff_idx < elements_[i].staves.size (); ++staff_idx)
 384             {
 385               Grob *staff = elements_[i].staves[staff_idx];
 386               staff->set_property ("system-Y-offset", scm_from_double (-system_position));
 387
 388               if (is_spaceable (staff))
 389                 {
 390                   // this is relative to the system: negative numbers are down.
 391                   translation = system_position - solution_[spring_idx];
 392                   spring_idx++;
 393
 394                   // Lay out any non-spaceable lines between this line and
 395                   // the last one.
 396                   if (loose_lines.size ())
 397                     {
 398                       loose_line_min_distances.push_back (min_offsets[staff_idx-1] - min_offsets[staff_idx]);
 399                       loose_lines.push_back (staff);
 400
 401                       distribute_loose_lines (loose_lines, loose_line_min_distances,
 402                                               last_spaceable_line_translation, translation - system_position);
 403                       loose_lines.clear ();
 404                       loose_line_min_distances.clear ();
 405                     }
 406                   last_spaceable_line = staff;
 407                   // Negative is down but the translation is relative to the whole page.
 408                   last_spaceable_line_translation = -system_position + translation;
 409
 410                   staff->translate_axis (translation, Y_AXIS);
 411                   found_spaceable_staff = true;
 412                 }
 413               else
 414                 {
 415                   if (loose_lines.empty ())
 416                     loose_lines.push_back (last_spaceable_line);
 417
 418                   if (staff_idx)
 419                     loose_line_min_distances.push_back (min_offsets[staff_idx-1] - min_offsets[staff_idx]);
 420                   else
 421                     {
 422                       Real min_dist = 0;
 423                       if (loose_lines.back ())
 424                         min_dist = Axis_group_interface::minimum_distance (loose_lines.back (),
 425                                                                            staff,
 426                                                                            Y_AXIS);
 427                       else if (!last_title_extent.is_empty ())
 428                         { // distance to the preceding title
 429                           // TODO: add options for controlling the space between a loose line
 430                           // and a title/markup preceding it.
 431                           min_dist = staff->extent (staff, Y_AXIS)[UP] - last_title_extent[DOWN];
 432                         }
 433                       else // distance to the top margin
 434                         min_dist = header_padding_ + header_height_ + staff->extent (staff, Y_AXIS)[UP];
 435
 436                       loose_line_min_distances.push_back (min_dist);
 437                     }
 438                   loose_lines.push_back (staff);
 439                 }
 440             }
 441
 442           // Corner case: even if a system has no live staves, it still takes up
 443           // one spring (a system with one live staff also takes up one spring),
 444           // which we need to increment past.
 445           if (!found_spaceable_staff)
 446             spring_idx++;
 447
 448           *tail = scm_cons (scm_from_double (system_position), SCM_EOL);
 449           tail = SCM_CDRLOC (*tail);
 450         }
 451     }
 452
 453   if (loose_lines.size ())
 454     {
 455       Grob *last = loose_lines.back ();
 456       Interval last_ext = last->extent (last, Y_AXIS);
 457       loose_line_min_distances.push_back (-last_ext[DOWN] + footer_height_ + footer_padding_);
 458       loose_lines.push_back (0);
 459
 460       distribute_loose_lines (loose_lines, loose_line_min_distances,
 461                               last_spaceable_line_translation, -page_height_);
 462
 463     }
 464
 465   assert (spring_idx == solution_.size () - 1);
 466   return system_offsets;
 467 }
 468
 469 // Given two lines that are already spaced (the first and last
 470 // elements of loose_lines), distribute some unspaced lines between
 471 // them.
 472 // first_translation and last_translation are relative to the page.
 473 void
 474 Page_layout_problem::distribute_loose_lines (vector<Grob*> const &loose_lines,
 475                                              vector<Real> const &min_distances,
 476                                              Real first_translation, Real last_translation)
 477 {
 478   Simple_spacer spacer;
 479   for (vsize i = 0; i + 1 < loose_lines.size (); ++i)
 480     {
 481       SCM spec = get_spacing_spec (loose_lines[i], loose_lines[i+1], false, 0, INT_MAX);
 482       Spring spring (1.0, 0.0);
 483       alter_spring_from_spacing_spec (spec, &spring);
 484       spring.ensure_min_distance (min_distances[i]);
 485       spacer.add_spring (spring);
 486     }
 487
 488   // Remember: offsets are decreasing, since we're going from UP to DOWN!
 489   spacer.solve (first_translation - last_translation, false);
 490
 491   vector<Real> solution = spacer.spring_positions ();
 492   for (vsize i = 1; i + 1 < solution.size (); ++i)
 493     {
 494       Real system_offset = scm_to_double (loose_lines[i]->get_property ("system-Y-offset"));
 495       loose_lines[i]->translate_axis (first_translation - solution[i] - system_offset, Y_AXIS);
 496     }
 497 }
 498
 499 SCM
 500 Page_layout_problem::solution (bool ragged)
 501 {
 502   solve_rod_spring_problem (ragged);
 503   return find_system_offsets ();
 504 }
 505
 506 // Build upper and lower skylines for a system. We don't yet know the positions
 507 // of the staves within the system, so we make the skyline as conservative as
 508 // possible. That is, for the upper skyline, we pretend that all of the staves
 509 // in the system are packed together close to the top system; for the lower
 510 // skyline, we pretend that all of the staves are packed together close to
 511 // the bottom system.
 512 //
 513 // The upper skyline is relative to the top staff; the lower skyline is relative to
 514 // the bottom staff.
 515 void
 516 Page_layout_problem::build_system_skyline (vector<Grob*> const& staves,
 517                                            vector<Real> const& minimum_translations,
 518                                            Skyline *up,
 519                                            Skyline *down)
 520 {
 521   if (minimum_translations.empty ())
 522     return;
 523
 524   assert (staves.size () == minimum_translations.size ());
 525   Real first_translation = minimum_translations[0];
 526   Real last_spaceable_dy = 0;
 527   Real first_spaceable_dy = 0;
 528   bool found_spaceable_staff = false;
 529
 530   for (vsize i = 0; i < staves.size (); ++i)
 531     {
 532       Real dy = minimum_translations[i] - first_translation;
 533       Grob *g = staves[i];
 534       Skyline_pair *sky = Skyline_pair::unsmob (g->get_property ("vertical-skylines"));
 535       if (sky)
 536         {
 537           up->raise (-dy);
 538           up->merge ((*sky)[UP]);
 539           up->raise (dy);
 540
 541           down->raise (-dy);
 542           down->merge ((*sky)[DOWN]);
 543           down->raise (dy);
 544         }
 545       if (is_spaceable (staves[i]))
 546         {
 547           if (!found_spaceable_staff)
 548             {
 549               found_spaceable_staff = true;
 550               first_spaceable_dy = dy;
 551             }
 552           last_spaceable_dy = dy;
 553         }
 554     }
 555
 556   // Leave the up skyline at a position relative
 557   // to the top spaceable staff.
 558   up->raise (-first_spaceable_dy);
 559
 560   // Leave the down skyline at a position
 561   // relative to the bottom spaceable staff.
 562   down->raise (-last_spaceable_dy);
 563 }
 564
 565 Interval
 566 Page_layout_problem::prob_extent (Prob *p)
 567 {
 568   Stencil *sten = unsmob_stencil (p->get_property ("stencil"));
 569   return sten ? sten->extent (Y_AXIS) : Interval (0, 0);
 570 }
 571
 572 Interval
 573 Page_layout_problem::first_staff_extent (Element const& e)
 574 {
 575   if (e.prob)
 576     return prob_extent (e.prob);
 577   else if (e.staves.size ())
 578     return e.staves[0]->extent (e.staves[0], Y_AXIS);
 579
 580   return Interval (0, 0);
 581 }
 582
 583 Interval
 584 Page_layout_problem::last_staff_extent (Element const& e)
 585 {
 586   if (e.prob)
 587     return prob_extent (e.prob);
 588   else if (e.staves.size ())
 589     return e.staves.back ()->extent (e.staves.back (), Y_AXIS);
 590
 591   return Interval (0, 0);
 592 }
 593
 594 SCM
 595 Page_layout_problem::get_details (Element const& elt)
 596 {
 597   if (elt.staves.empty ())
 598     return SCM_EOL;
 599
 600   return get_details (elt.staves.back ()->get_system ());
 601 }
 602
 603 SCM
 604 Page_layout_problem::get_details (Grob *g)
 605 {
 606   Grob *left_bound = dynamic_cast<Spanner*> (g)->get_bound (LEFT);
 607   return left_bound->get_property ("line-break-system-details");
 608 }
 609
 610 bool
 611 Page_layout_problem::is_spaceable (Grob *g)
 612 {
 613   return !scm_is_number (g->get_property ("staff-affinity"));
 614 }
 615
 616 void
 617 Page_layout_problem::mark_as_spaceable (Grob *g)
 618 {
 619   g->set_property ("staff-affinity", SCM_BOOL_F);
 620 }
 621
 622 bool
 623 Page_layout_problem::read_spacing_spec (SCM spec, Real* dest, SCM sym)
 624 {
 625   SCM pair = scm_sloppy_assq (sym, spec);
 626   if (scm_is_pair (pair) && scm_is_number (scm_cdr (pair)))
 627     {
 628       *dest = scm_to_double (scm_cdr (pair));
 629       return true;
 630     }
 631   return false;
 632 }
 633
 634 // If there is a forced, fixed spacing between BEFORE and AFTER, return it.
 635 // Otherwise, return -infinity_f.
 636 // If after is spaceable, it is the (spaceable_index + 1)th spaceable grob in
 637 // its alignment.
 638 Real
 639 Page_layout_problem::get_fixed_spacing (Grob *before, Grob *after, int spaceable_index, bool pure, int start, int end)
 640 {
 641   SCM spec = Page_layout_problem::get_spacing_spec (before, after, pure, start, end);
 642   Real ret = -infinity_f;
 643   Real stretchability = 0;
 644   if (Page_layout_problem::read_spacing_spec (spec, &stretchability, ly_symbol2scm ("stretchability"))
 645       && stretchability == 0)
 646     Page_layout_problem::read_spacing_spec (spec, &ret, ly_symbol2scm ("space"));
 647
 648   // If we're pure, then paper-columns have not had their systems set,
 649   // and so elts[i]->get_system () is unreliable.
 650   System *sys = pure ? Grob::get_system (before) : before->get_system ();
 651   Grob *left_bound = sys ? sys->get_maybe_pure_bound (LEFT, pure, start, end) : 0;
 652
 653   if (is_spaceable (before) && is_spaceable (after) && left_bound)
 654     {
 655       SCM details = left_bound->get_property ("line-break-system-details");
 656       SCM manual_dists = ly_assoc_get (ly_symbol2scm ("alignment-distances"), details, SCM_EOL);
 657       if (scm_is_pair (manual_dists))
 658         {
 659           SCM forced = robust_list_ref (spaceable_index - 1, manual_dists);
 660           if (scm_is_number (forced))
 661             ret = max (ret, scm_to_double (forced));
 662         }
 663     }
 664   return ret;
 665 }
 666
 667 static SCM
 668 add_stretchability (SCM alist, Real stretch)
 669 {
 670   if (!scm_is_pair (scm_sloppy_assq (ly_symbol2scm ("stretchability"), alist)))
 671     return scm_acons (ly_symbol2scm ("stretchability"), scm_from_double (stretch), alist);
 672
 673   return alist;
 674 }
 675
 676 // We want to put a large stretch between a non-spaceable line and its
 677 // non-affinity staff. We want to put an even larger stretch between
 678 // a non-spaceable line and the top/bottom of the page. That way,
 679 // a spacing-affinity UP line at the bottom of the page will still be
 680 // placed close to its staff.
 681 const double LARGE_STRETCH = 10e5;
 682 const double HUGE_STRETCH = 10e7;
 683
 684 // Returns the spacing spec connecting BEFORE to AFTER.
 685 SCM
 686 Page_layout_problem::get_spacing_spec (Grob *before, Grob *after, bool pure, int start, int end)
 687 {
 688   // If there are no spacing wishes, return a very flexible spring.
 689   // This will occur, for example, if there are lyrics at the bottom of
 690   // the page, in which case we don't want the spring from the lyrics to
 691   // the bottom of the page to have much effect.
 692   if (!before || !after)
 693     return add_stretchability (SCM_EOL, HUGE_STRETCH);
 694
 695   if (is_spaceable (before))
 696     {
 697       if (is_spaceable (after))
 698         return before->get_maybe_pure_property ("staff-staff-spacing", pure, start, end);
 699       else
 700         {
 701           Direction affinity = to_dir (after->get_maybe_pure_property ("staff-affinity", pure, start, end));
 702           return (affinity == DOWN)
 703             ? add_stretchability (after->get_maybe_pure_property ("nonstaff-unrelatedstaff-spacing", pure, start, end),
 704                                   LARGE_STRETCH)
 705             : after->get_maybe_pure_property ("nonstaff-relatedstaff-spacing", pure, start, end);
 706         }
 707     }
 708   else
 709     {
 710       if (is_spaceable (after))
 711         {
 712           Direction affinity = to_dir (before->get_maybe_pure_property ("staff-affinity", pure, start, end));
 713           return (affinity == UP)
 714             ? add_stretchability (before->get_maybe_pure_property ("nonstaff-unrelatedstaff-spacing", pure, start, end),
 715                                   LARGE_STRETCH)
 716             : before->get_maybe_pure_property ("nonstaff-relatedstaff-spacing", pure, start, end);
 717         }
 718       else
 719         {
 720           Direction before_affinity = to_dir (before->get_maybe_pure_property ("staff-affinity", pure, start, end));
 721           Direction after_affinity = to_dir (after->get_maybe_pure_property ("staff-affinity", pure, start, end));
 722           if (after_affinity > before_affinity)
 723             {
 724               warning (_ ("staff-affinities should only decrease"));
 725               after_affinity = before_affinity;
 726             }
 727           if (before_affinity != UP)
 728             return before->get_maybe_pure_property ("nonstaff-nonstaff-spacing", pure, start, end);
 729           else if (after_affinity != DOWN)
 730             return before->get_maybe_pure_property ("nonstaff-nonstaff-spacing", pure, start, end);
 731           return add_stretchability (before->get_maybe_pure_property ("nonstaff-unrelatedstaff-spacing", pure, start, end),
 732                                      LARGE_STRETCH);
 733         }
 734     }
 735
 736   assert (0);
 737   return SCM_BOOL_F;
 738 }
 739
 740 void
 741 Page_layout_problem::alter_spring_from_spacing_spec (SCM spec, Spring* spring)
 742 {
 743   Real space;
 744   Real stretch;
 745   Real min_dist;
 746   if (read_spacing_spec (spec, &space, ly_symbol2scm ("space")))
 747     spring->set_distance (space);
 748   if (read_spacing_spec (spec, &min_dist, ly_symbol2scm ("minimum-distance")))
 749     spring->set_min_distance (min_dist);
 750   spring->set_default_strength ();
 751
 752   if (read_spacing_spec (spec, &stretch, ly_symbol2scm ("stretchability")))
 753     {
 754       spring->set_inverse_stretch_strength (stretch);
 755       spring->set_inverse_compress_strength (stretch);
 756     }
 757 }
 758
 759 vector<Grob*>
 760 Page_layout_problem::filter_dead_elements (vector<Grob*> const& input)
 761 {
 762   vector<Grob*> output;
 763   for (vsize i = 0; i < input.size (); ++i)
 764     {
 765       if (Hara_kiri_group_spanner::has_interface (input[i]))
 766         Hara_kiri_group_spanner::consider_suicide (input[i]);
 767
 768       if (input[i]->is_live ())
 769         output.push_back (input[i]);
 770     }
 771
 772   return output;
 773 }