2 spacing-determine-loose-columns.cc -- implement Spacing_spanner
3 methods that decide which columns to turn loose.
5 source file of the GNU LilyPond music typesetter
7 (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "staff-spacing.hh"
12 #include "spacing-options.hh"
14 #include "paper-column.hh"
15 #include "column-x-positions.hh"
16 #include "pointer-group-interface.hh"
17 #include "spacing-spanner.hh"
18 #include "note-spacing.hh"
20 #include "grob-array.hh"
21 #include "break-align-interface.hh"
25 Return whether COL is fixed to its neighbors by some kind of spacing
29 If in doubt, then we're not loose; the spacing engine should space
30 for it, risking suboptimal spacing.
32 (Otherwise, we might risk core dumps, and other weird stuff.)
35 is_loose_column (Grob *l, Grob *col, Grob *r, Spacing_options const *options)
37 if (!to_boolean (col->get_property ("allow-loose-spacing")))
40 if ((options->float_nonmusical_columns_
41 ||options->float_grace_columns_)
42 && Paper_column::when_mom (col).grace_part_)
45 if (Paper_column::is_musical (col)
46 || Paper_column::is_breakable (col))
49 extract_grob_set (col, "right-neighbors", rns);
50 extract_grob_set (col, "left-neighbors", lns);
53 If this column doesn't have a proper neighbor, we should really
54 make it loose, but spacing it correctly is more than we can
57 (this happens in the following situation:
68 the column containing the clef is really loose, and should be
69 attached right to the first column, but that is a lot of work for
70 such a borderline case.)
73 if (lns.empty () || rns.empty ())
76 Item *l_neighbor = dynamic_cast<Item *> (lns[0]);
77 Item *r_neighbor = dynamic_cast<Item *> (rns[0]);
79 if (!l_neighbor || !r_neighbor)
82 l_neighbor = l_neighbor->get_column ();
83 r_neighbor = dynamic_cast<Item *> (Note_spacing::right_column (r_neighbor));
85 if (l == l_neighbor && r == r_neighbor)
88 if (!l_neighbor || !r_neighbor)
92 Only declare loose if the bounds make a little sense. This means
93 some cases (two isolated, consecutive clef changes) won't be
94 nicely folded, but hey, then don't do that.
96 if (! ((Paper_column::is_musical (l_neighbor) || Paper_column::is_breakable (l_neighbor))
97 && (Paper_column::is_musical (r_neighbor) || Paper_column::is_breakable (r_neighbor))))
101 A rather hairy check, but we really only want to move around
102 clefs. (anything else?)
104 in any case, we don't want to move bar lines.
106 extract_grob_set (col, "elements", elts);
107 for (vsize i = elts.size (); i--;)
110 if (g && Break_alignment_interface::has_interface (g))
112 extract_grob_set (g, "elements", gelts);
113 for (vsize j = gelts.size (); j--;)
118 ugh. -- fix staff-bar name?
120 if (h && h->get_property ("break-align-symbol") == ly_symbol2scm ("staff-bar"))
130 Remove columns that are not tightly fitting from COLS. In the
131 removed columns, set 'between-cols to the columns where it is in
135 Spacing_spanner::prune_loose_columns (Grob *me, vector<Grob*> *cols,
136 Spacing_options const *options)
138 vector<Grob*> newcols;
140 for (vsize i = 0; i < cols->size (); i++)
142 Grob *c = cols->at (i);
144 bool loose = (i > 0 && i < cols->size () - 1)
145 && is_loose_column (cols->at (i - 1), c, cols->at (i + 1), options);
149 extract_grob_set (c, "right-neighbors", rns_arr);
150 extract_grob_set (c, "left-neighbors", lns_arr);
152 SCM lns = lns_arr.size () ? lns_arr.back ()->self_scm () : SCM_BOOL_F;
153 SCM rns = rns_arr.size () ? rns_arr.back ()->self_scm () : SCM_BOOL_F;
156 Either object can be non existent, if the score ends
160 extract_grob_set (unsmob_grob (rns), "right-items", right_items);
161 c->set_object ("between-cols", scm_cons (lns,
162 right_items[0]->self_scm ()));
165 Set distance constraints for loose columns
167 Drul_array<Grob *> next_door (cols->at (i - 1),
170 Drul_array<Real> dists (0, 0);
174 Item *lc = dynamic_cast<Item *> ((d == LEFT) ? next_door[LEFT] : c);
175 Item *rc = dynamic_cast<Item *> (d == LEFT ? c : next_door[RIGHT]);
177 extract_grob_set (lc, "spacing-wishes", wishes);
178 for (vsize k = wishes.size (); k--;)
180 Grob *sp = wishes[k];
181 if (Note_spacing::left_column (sp) != lc
182 || Note_spacing::right_column (sp) != rc)
185 if (Note_spacing::has_interface (sp))
188 The note spacing should be taken from the musical
195 Real base = note_spacing (me, lc, rc, options, &dummy);
196 Note_spacing::get_spacing (sp, rc, base, options->increment_,
199 space -= options->increment_;
201 dists[d] = max (dists[d], space);
203 else if (Staff_spacing::has_interface (sp))
206 Real fixed_space = 0;
207 Staff_spacing::get_spacing_params (sp,
208 &space, &fixed_space);
210 dists[d] = max (dists[d], fixed_space);
213 programming_error ("Subversive spacing wish");
216 while (flip (&d) != LEFT);
219 r.distance_ = dists[LEFT] + dists[RIGHT];
220 r.item_drul_[LEFT] = dynamic_cast<Item *> (cols->at (i - 1));
221 r.item_drul_[RIGHT] = dynamic_cast<Item *> (cols->at (i + 1));
226 newcols.push_back (c);
233 Set neighboring columns determined by the spacing-wishes grob property.
236 Spacing_spanner::set_explicit_neighbor_columns (vector<Grob*> const &cols)
238 for (vsize i = 0; i < cols.size (); i++)
240 SCM right_neighbors = Grob_array::make_array ();
241 Grob_array *rn_arr = unsmob_grob_array (right_neighbors);
242 int min_rank = 100000; // inf.
244 extract_grob_set (cols[i], "spacing-wishes", wishes);
245 for (vsize k = wishes.size (); k--;)
247 Item *wish = dynamic_cast<Item *> (wishes[k]);
249 Item *lc = wish->get_column ();
250 Grob *right = Note_spacing::right_column (wish);
255 Item *rc = dynamic_cast<Item *> (right);
257 int right_rank = Paper_column::get_rank (rc);
258 int left_rank = Paper_column::get_rank (lc);
261 update the left column.
263 if (right_rank <= min_rank)
265 if (right_rank < min_rank)
268 min_rank = right_rank;
273 update the right column of the wish.
277 extract_grob_set (rc, "left-neighbors", lns_arr);
280 Item *it = dynamic_cast<Item *> (lns_arr.back ());
281 maxrank = Paper_column::get_rank (it->get_column ());
284 if (left_rank >= maxrank)
287 if (left_rank > maxrank)
289 Grob_array *ga = unsmob_grob_array (rc->get_object ("left-neighbors"));
294 Pointer_group_interface::add_grob (rc, ly_symbol2scm ("left-neighbors"), wish);
299 cols[i]->set_object ("right-neighbors", right_neighbors);
304 Set neighboring columns that have no left/right-neighbor set
305 yet. Only do breakable non-musical columns, and musical columns.
308 Spacing_spanner::set_implicit_neighbor_columns (vector<Grob*> const &cols)
310 for (vsize i = 0; i < cols.size (); i++)
312 Item *it = dynamic_cast<Item *> (cols[i]);
313 if (!Paper_column::is_breakable (it) && !Paper_column::is_musical (it))
316 // it->breakable || it->musical
319 sloppy with typing left/right-neighbors should take list, but paper-column found instead.
321 extract_grob_set (cols[i], "left-neighbors", lns);
322 if (lns.empty () && i)
324 SCM ga_scm = Grob_array::make_array ();
325 Grob_array *ga = unsmob_grob_array (ga_scm);
326 ga->add (cols[i - 1]);
327 cols[i]->set_object ("left-neighbors", ga_scm);
329 extract_grob_set (cols[i], "right-neighbors", rns);
330 if (rns.empty () && i < cols.size () - 1)
332 SCM ga_scm = Grob_array::make_array ();
333 Grob_array *ga = unsmob_grob_array (ga_scm);
334 ga->add (cols[i + 1]);
335 cols[i]->set_object ("right-neighbors", ga_scm);