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