lily/spacing-loose-columns.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2005--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
   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 "system.hh"
  21 #include "paper-column.hh"
  22 #include "column-x-positions.hh"
  23 #include "pointer-group-interface.hh"
  24 #include "staff-spacing.hh"
  25 #include "note-spacing.hh"
  26 #include "spacing-spanner.hh"
  27 #include "warn.hh"
  28 #include "moment.hh"
  29 #include "spacing-options.hh"
  30
  31 /* Find the loose columns in POSNS, and drape them around the columns
  32    specified in BETWEEN-COLS.  */
  33 void
  34 set_loose_columns (System *which, Column_x_positions const *posns)
  35 {
  36   int loose_col_count = posns->loose_cols_.size ();
  37   if (!loose_col_count)
  38     return;
  39
  40   for (int i = 0; i < loose_col_count; i++)
  41     dynamic_cast<Paper_column *> (posns->loose_cols_[i])->set_system (which);
  42
  43   for (int i = 0; i < loose_col_count; i++)
  44     {
  45       int divide_over = 1;
  46       Item *loose = dynamic_cast<Item *> (posns->loose_cols_[i]);
  47
  48       Item *left = 0;
  49       Item *right = 0;
  50
  51       vector<Item *> clique;
  52       while (1)
  53         {
  54           SCM between = loose->get_object ("between-cols");
  55           if (!scm_is_pair (between))
  56             break;
  57
  58           /* If the line was broken at one of the loose columns, split
  59              the clique at that column. */
  60           if (!loose->get_system ())
  61             break;
  62
  63           Paper_column *le = dynamic_cast<Paper_column *> (unsmob_grob (scm_car (between)));
  64           Paper_column *re = dynamic_cast<Paper_column *> (unsmob_grob (scm_cdr (between)));
  65
  66           if (! (le && re))
  67             break;
  68
  69           if (!left && le)
  70             {
  71               left = le->get_column ();
  72               if (!left->get_system ())
  73                 left = left->find_prebroken_piece (RIGHT);
  74
  75               clique.push_back (left);
  76             }
  77
  78           clique.push_back (loose);
  79
  80           divide_over++;
  81           loose = right = re->get_column ();
  82         }
  83
  84       if (!right)
  85         {
  86           programming_error ("Can't attach loose column sensibly."
  87                              "  Attaching to end of system.");
  88           right = which->get_bound (RIGHT);
  89         }
  90
  91       if (right->get_system ())
  92         ; /* do nothing */
  93       else if (right->find_prebroken_piece (LEFT)
  94                && right->find_prebroken_piece (LEFT)->get_system () == which)
  95         right = right->find_prebroken_piece (LEFT);
  96       else if (Paper_column::get_rank (which->get_bound (RIGHT)) < Paper_column::get_rank (right))
  97         right = which->get_bound (RIGHT);
  98       else
  99         {
 100           clique.back ()->programming_error ("Loose column does not have right side to attach to.");
 101           System *base_system = dynamic_cast<System *> (which->original ());
 102           int j = Paper_column::get_rank (clique.back ()) + 1;
 103           int end_rank = Paper_column::get_rank (which->get_bound (RIGHT));
 104           extract_grob_set (base_system, "columns", base_cols);
 105           for (; j < end_rank; j++)
 106             {
 107               if (base_cols[j]->get_system () == which)
 108                 right = dynamic_cast<Item *> ((Grob *)base_cols[j]);
 109             }
 110         }
 111
 112       Grob *common = right->common_refpoint (left, X_AXIS);
 113
 114       clique.push_back (right);
 115
 116       /*
 117         We use two vectors to keep track of loose column spacing:
 118           clique_spacing keeps track of ideal spaces.
 119           clique_tight_spacing keeps track of minimum spaces.
 120         Below, a scale factor is applied to the shifting of loose columns that
 121         aims to preserve clique_spacing but gets closer to clique_tight_spacing as the
 122         space becomes smaller.  This is used because the rods placed for loose columns
 123         are tight (meaning they use minimum distances - see set_distances_for_loose_columns).
 124         However, other rods may widen this distance, in which case we don't want a crammed score.
 125         Thus, we aim for non-crammed, and fall back on crammed as needed.
 126       */
 127       vector<Real> clique_spacing;
 128       vector<Real> clique_tight_spacing;
 129       clique_spacing.push_back (0.0);
 130       clique_tight_spacing.push_back (0.0);
 131       for (vsize j = 1; j + 1 < clique.size (); j++)
 132         {
 133           Grob *clique_col = clique[j];
 134
 135           Paper_column *loose_col = dynamic_cast<Paper_column *> (clique[j]);
 136           Paper_column *next_col = dynamic_cast<Paper_column *> (clique[j + 1]);
 137
 138           Grob *spacing = unsmob_grob (clique_col->get_object ("spacing"));
 139           if (Grob *grace_spacing = unsmob_grob (clique_col->get_object ("grace-spacing")))
 140             {
 141               spacing = grace_spacing;
 142             }
 143
 144           Spacing_options options;
 145           if (spacing)
 146             options.init_from_grob (spacing);
 147           else
 148             programming_error ("Column without spacing object");
 149
 150           Real base_note_space = 0.0;
 151           Real tight_note_space = 0.0;
 152
 153           if (Paper_column::is_musical (next_col)
 154               && Paper_column::is_musical (loose_col))
 155             {
 156               Spring spring = Spacing_spanner::note_spacing (spacing, loose_col,
 157                                                              next_col, &options);
 158               if (Note_spacing::has_interface (spacing))
 159                 spring = Note_spacing::get_spacing (spacing, next_col,
 160                                                     spring, options.increment_);
 161
 162               base_note_space = spring.distance ();
 163               tight_note_space = spring.min_distance ();
 164             }
 165           else
 166             {
 167               Spring spring = Spacing_spanner::standard_breakable_column_spacing (spacing,
 168                               loose_col, next_col,
 169                               &options);
 170
 171               base_note_space = spring.distance ();
 172               tight_note_space = spring.min_distance ();
 173             }
 174
 175           Real loose_col_horizontal_length = loose_col->extent (loose_col, X_AXIS).length ();
 176           base_note_space = max (base_note_space, loose_col_horizontal_length);
 177           tight_note_space = max (tight_note_space, loose_col_horizontal_length);
 178
 179           clique_spacing.push_back (base_note_space);
 180           clique_tight_spacing.push_back (tight_note_space);
 181         }
 182
 183       Real permissible_distance = clique.back ()->relative_coordinate (common, X_AXIS) - robust_relative_extent (clique[0], common, X_AXIS)[RIGHT];
 184       Real right_point = robust_relative_extent (clique.back (), common, X_AXIS)[LEFT];
 185       Grob *finished_right_column = clique.back ();
 186
 187       Real sum_tight_spacing = 0;
 188       Real sum_spacing = 0;
 189       // currently a magic number - what would be a good grob to hold this property?
 190       Real left_padding = 0.15;
 191       for (vsize j = 0; j < clique_spacing.size (); j++)
 192         {
 193           sum_tight_spacing += clique_tight_spacing[j];
 194           sum_spacing += clique_spacing[j];
 195         }
 196       Real scale_factor = max (0.0, min (1.0, (permissible_distance - left_padding - sum_tight_spacing) / (sum_spacing - sum_tight_spacing)));
 197       for (vsize j = clique.size () - 2; j > 0; j--)
 198         {
 199           Paper_column *clique_col = dynamic_cast<Paper_column *> (clique[j]);
 200
 201           right_point = finished_right_column->relative_coordinate (common, X_AXIS);
 202
 203           Real distance_to_next = clique_tight_spacing[j] + (clique_spacing[j] - clique_tight_spacing[j]) * scale_factor;
 204
 205           Real my_offset = right_point - distance_to_next;
 206
 207           clique_col->translate_axis (my_offset - clique_col->relative_coordinate (common, X_AXIS), X_AXIS);
 208
 209           finished_right_column = clique_col;
 210         }
 211     }
 212 }
 213