2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1998--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
20 #include "side-position-interface.hh"
22 #include <cmath> // ceil.
29 #include "accidental-interface.hh"
30 #include "accidental-placement.hh"
31 #include "axis-group-interface.hh"
32 #include "directional-element-interface.hh"
34 #include "grob-array.hh"
35 #include "international.hh"
39 #include "note-head.hh"
40 #include "note-column.hh"
41 #include "pointer-group-interface.hh"
42 #include "skyline-pair.hh"
43 #include "staff-symbol-referencer.hh"
44 #include "staff-symbol.hh"
46 #include "string-convert.hh"
49 #include "unpure-pure-container.hh"
52 Side_position_interface::add_support (Grob *me, Grob *e)
54 Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("side-support-elements"), e);
58 Side_position_interface::recursive_add_support (Grob *me, Grob *e)
60 Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("side-support-elements"), e);
61 extract_grob_set (e, "side-support-elements", sse);
62 for (vsize i = 0; i < sse.size (); i++)
63 recursive_add_support (me, sse[i]);
67 get_support_set (Grob *me)
69 // Only slightly kludgy heuristic...
70 // We want to make sure that all AccidentalPlacements'
71 // accidentals make it into the side support
72 extract_grob_set (me, "side-support-elements", proto_support);
75 for (vsize i = 0; i < proto_support.size (); i++)
77 if (Accidental_placement::has_interface (proto_support[i]))
79 Grob *accs = proto_support[i];
80 for (SCM acs = accs->get_object ("accidental-grobs"); scm_is_pair (acs);
82 for (SCM s = scm_cdar (acs); scm_is_pair (s); s = scm_cdr (s))
84 Grob *a = unsmob_grob (scm_car (s));
89 support.insert (proto_support[i]);
95 Position next to support, taking into account my own dimensions and padding.
98 axis_aligned_side_helper (SCM smob, Axis a, bool pure, int start, int end, SCM current_off_scm)
101 Real *current_off_ptr = 0;
102 if (scm_is_number (current_off_scm))
104 r = scm_to_double (current_off_scm);
105 current_off_ptr = &r;
108 Grob *me = unsmob_grob (smob);
109 // We will only ever want widths of spanners after line breaking
110 // so we can set pure to false
111 if (dynamic_cast<Spanner *> (me) && a == X_AXIS)
114 return Side_position_interface::aligned_side (me, a, pure, start, end, current_off_ptr);
117 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, x_aligned_side, 2, 1, "");
119 Side_position_interface::x_aligned_side (SCM smob, SCM current_off)
121 // Because horizontal skylines need vertical heights, we'd trigger
122 // unpure calculations too soon if this were called before line breaking.
123 // So, we always use pure heights. Given that horizontal skylines are
124 // almost always used before line breaking anyway, this doesn't cause
126 return axis_aligned_side_helper (smob, X_AXIS, true, 0, 0, current_off);
129 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, y_aligned_side, 2, 1, "");
131 Side_position_interface::y_aligned_side (SCM smob, SCM current_off)
133 return axis_aligned_side_helper (smob, Y_AXIS, false, 0, 0, current_off);
136 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Side_position_interface, pure_y_aligned_side, 4, 1, "");
138 Side_position_interface::pure_y_aligned_side (SCM smob, SCM start, SCM end, SCM cur_off)
140 return axis_aligned_side_helper (smob, Y_AXIS, true,
146 MAKE_SCHEME_CALLBACK (Side_position_interface, calc_cross_staff, 1)
148 Side_position_interface::calc_cross_staff (SCM smob)
150 Grob *me = unsmob_grob (smob);
151 extract_grob_set (me, "side-support-elements", elts);
153 Direction my_dir = get_grob_direction (me) ;
155 for (vsize i = 0; i < elts.size (); i++)
158 If 'me' is placed relative to any cross-staff element with a
159 'direction callback defined, the placement of 'me' is likely
160 to depend on staff-spacing, thus 'me' should be considered
163 if (to_boolean (elts[i]->get_property ("cross-staff"))
164 && !is_direction (elts[i]->get_property_data ("direction")))
168 If elts[i] is cross-staff and is pointing in the same
169 direction as 'me', we assume that the alignment
170 of 'me' is influenced the cross-staffitude of elts[i]
171 and thus we mark 'me' as cross-staff.
173 if (to_boolean (elts[i]->get_property ("cross-staff"))
174 && my_dir == get_grob_direction (elts[i]))
178 Grob *myvag = Grob::get_vertical_axis_group (me);
179 for (vsize i = 0; i < elts.size (); i++)
180 if (myvag != Grob::get_vertical_axis_group (elts[i]))
186 // long function - each stage is clearly marked
189 Side_position_interface::aligned_side (Grob *me, Axis a, bool pure, int start, int end,
192 Direction dir = get_grob_direction (me);
194 set<Grob *> support = get_support_set (me);
197 for (Axis ax = X_AXIS; ax < NO_AXES; incr (ax))
198 common[ax] = common_refpoint_of_array (support,
200 ? me->get_parent (ax)
204 Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (me);
205 bool quantize_position = to_boolean (me->get_maybe_pure_property ("quantize-position", pure, start, end));
210 && scm_is_number (me->get_maybe_pure_property ("staff-padding", pure, start, end))
211 && !quantize_position;
214 common[Y_AXIS] = staff_symbol->common_refpoint (common[Y_AXIS], Y_AXIS);
217 SCM skyp = me->get_maybe_pure_property (a == X_AXIS
218 ? "horizontal-skylines"
219 : "vertical-skylines",
223 if (Skyline_pair::unsmob (skyp))
225 // for spanner pure heights, we don't know horizontal spacing,
226 // so a spanner can never have a meaningful x coordiante
227 // we just give it the parents' coordinate because its
228 // skyline will likely be of infinite width anyway
229 // and we don't want to prematurely trigger H spacing
230 Real xc = a == X_AXIS || (pure && dynamic_cast<Spanner *> (me))
231 ? me->get_parent (X_AXIS)->relative_coordinate (common[X_AXIS], X_AXIS)
232 : me->relative_coordinate (common[X_AXIS], X_AXIS);
233 // same here, for X_AXIS spacing, if it's happening, it should only be
234 // before line breaking. because there is no thing as "pure" x spacing,
235 // we assume that it is all pure
236 Real yc = a == X_AXIS
237 ? me->pure_relative_y_coordinate (common[Y_AXIS], start, end)
238 : me->get_parent (Y_AXIS)->maybe_pure_coordinate (common[Y_AXIS], Y_AXIS, pure, start, end);
239 Skyline_pair copy = *Skyline_pair::unsmob (skyp);
240 copy.shift (a == X_AXIS ? yc : xc);
241 copy.raise (a == X_AXIS ? xc : yc);
245 me->warning ("cannot find skylines - strange alignment will follow");
249 vector<Skyline_pair> skyps;
250 set<Grob *>::iterator it;
251 Real max_raise = -dir * infinity_f;
252 bool aligns_to_cross_staff = false;
254 for (it = support.begin (); it != support.end (); it++)
258 // In the case of a stem, we will find a note head as well
259 // ignoring the stem solves cyclic dependencies if the stem is
260 // attached to a cross-staff beam.
261 bool cross_staff = to_boolean (e->get_property ("cross-staff"));
263 // avoid cyclic dependency for direction
266 && Stem::has_interface (e)
268 && !is_direction (e->get_property_data ("direction")))
271 // avoid unnecessary stem look up (if pointing away, it is not
272 // supporting anything)
274 && Stem::has_interface (e)
275 && dir == - get_grob_direction (e))
282 SCM sp = e->get_maybe_pure_property (a == X_AXIS
283 ? "horizontal-skylines"
284 : "vertical-skylines",
289 aligns_to_cross_staff |= cross_staff;
290 if (Skyline_pair::unsmob (sp))
292 Real xc = pure && dynamic_cast<Spanner *> (e)
293 ? e->get_parent (X_AXIS)->relative_coordinate (common[X_AXIS], X_AXIS)
294 : e->relative_coordinate (common[X_AXIS], X_AXIS);
295 // same logic as above
296 // we assume horizontal spacing is always pure
297 Real yc = a == X_AXIS
298 ? e->pure_relative_y_coordinate (common[Y_AXIS], start, end)
299 : e->maybe_pure_coordinate (common[Y_AXIS], Y_AXIS, pure, start, end);
300 Skyline_pair copy = *Skyline_pair::unsmob (sp);
302 && Stem::has_interface (e)
303 && to_boolean (me->get_maybe_pure_property ("add-stem-support", pure, start, end)))
304 copy[dir].set_minimum_height (copy[dir].max_height ());
305 copy.shift (a == X_AXIS ? yc : xc);
306 copy.raise (a == X_AXIS ? xc : yc);
307 max_raise = minmax (dir, max_raise, a == X_AXIS ? xc : yc);
308 skyps.push_back (copy);
310 else { /* no warning*/ }
314 Skyline dim (boxes, other_axis (a), dir);
317 Skyline_pair merged (skyps);
318 dim.merge (merged[dir]);
323 Interval staff_extents;
324 common[Y_AXIS] = staff_symbol->common_refpoint (common[Y_AXIS], Y_AXIS);
325 staff_extents = staff_symbol->maybe_pure_extent (common[Y_AXIS], Y_AXIS, pure, start, end);
326 dim.set_minimum_height (staff_extents[dir]);
329 // Sometimes, we want to side position for grobs but they
330 // don't position against anything. Some cases where this is true:
331 // - StanzaNumber if the supporting lyrics are hara-kiri'd
332 // SystemStartBracket
334 // In all these cases, we set the height of the support to 0.
335 // This becomes then like the self-alignment-interface with the
336 // caveat that there is padding added.
337 // TODO: if there is a grob that never has side-support-elements
338 // (like InstrumentName), why are we using this function? Isn't it
339 // overkill? A function like self-alignment-interface with padding
341 // One could even imagine the two interfaces merged, as the only
342 // difference is that in self-alignment-interface we align on the parent
343 // where as here we align on a group of grobs.
346 dim = Skyline (dim.direction ());
347 dim.set_minimum_height (0.0);
350 // Many cross-staff grobs do not have good height estimations.
351 // We give the grob the best chance of not colliding by shifting
352 // it to the maximum height in the case of cross-staff alignment.
353 // This means, in other words, that the old way things were done
354 // (using boxes instead of skylines) is just reactivated for
355 // alignment to cross-staff grobs.
356 if (aligns_to_cross_staff)
357 dim.set_minimum_height (dim.max_height ());
359 Real ss = Staff_symbol_referencer::staff_space (me);
360 Real dist = dim.distance (my_dim, robust_scm2double (me->get_maybe_pure_property ("horizon-padding", pure, start, end), 0.0));
361 Real total_off = !isinf (dist) ? dir * dist : 0.0;
363 total_off += dir * ss * robust_scm2double (me->get_maybe_pure_property ("padding", pure, start, end), 0.0);
365 Real minimum_space = ss * robust_scm2double (me->get_maybe_pure_property ("minimum-space", pure, start, end), -1);
367 if (minimum_space >= 0
369 && total_off * dir < minimum_space)
370 total_off = minimum_space * dir;
373 total_off = dir * max (dir * total_off,
374 dir * (*current_off));
376 /* FIXME: 1000 should relate to paper size. */
377 if (fabs (total_off) > 1000)
380 = String_convert::form_string ("Improbable offset for grob %s: %f",
381 me->name ().c_str (), total_off);
383 programming_error (msg);
384 if (strict_infinity_checking)
385 scm_misc_error (__FUNCTION__, "Improbable offset.", SCM_EOL);
389 Maintain a minimum distance to the staff. This is similar to side
390 position with padding, but it will put adjoining objects on a row if
391 stuff sticks out of the staff a little.
393 Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
394 if (staff && a == Y_AXIS)
396 if (quantize_position)
398 Grob *common = me->common_refpoint (staff, Y_AXIS);
399 Real my_off = me->get_parent (Y_AXIS)->maybe_pure_coordinate (common, Y_AXIS, pure, start, end);
400 Real staff_off = staff->maybe_pure_coordinate (common, Y_AXIS, pure, start, end);
401 Real ss = Staff_symbol::staff_space (staff);
402 Real position = 2 * (my_off + total_off - staff_off) / ss;
403 Real rounded = directed_round (position, dir);
404 Grob *head = me->get_parent (X_AXIS);
406 Interval staff_span = Staff_symbol::line_span (staff);
407 staff_span.widen (1);
408 if (staff_span.contains (position)
409 /* In case of a ledger lines, quantize even if we're outside the staff. */
410 || (Note_head::has_interface (head)
412 && abs (Staff_symbol_referencer::get_position (head)) > abs (position)))
414 total_off += (rounded - position) * 0.5 * ss;
415 if (Staff_symbol_referencer::on_line (me, int (rounded)))
416 total_off += dir * 0.5 * ss;
419 else if (scm_is_number (me->get_maybe_pure_property ("staff-padding", pure, start, end)) && dir)
421 Interval iv = me->maybe_pure_extent (me, a, pure, start, end);
424 = Staff_symbol_referencer::staff_space (me)
425 * scm_to_double (me->get_maybe_pure_property ("staff-padding", pure, start, end));
427 Grob *parent = me->get_parent (Y_AXIS);
428 Grob *common = me->common_refpoint (staff, Y_AXIS);
429 Real parent_position = parent->maybe_pure_coordinate (common, Y_AXIS, pure, start, end);
430 Real staff_position = staff->maybe_pure_coordinate (common, Y_AXIS, pure, start, end);
431 Interval staff_extent = staff->maybe_pure_extent (staff, a, pure, start, end);
432 Real diff = (dir * staff_extent[dir] + staff_padding
433 - dir * (total_off + iv[-dir])
434 + dir * (staff_position - parent_position));
435 total_off += dir * max (diff, 0.0);
438 return scm_from_double (total_off);
442 Side_position_interface::set_axis (Grob *me, Axis a)
444 if (!scm_is_number (me->get_property ("side-axis")))
446 me->set_property ("side-axis", scm_from_int (a));
447 chain_offset_callback (me,
449 ? x_aligned_side_proc
450 : ly_make_unpure_pure_container (y_aligned_side_proc, pure_y_aligned_side_proc),
456 Side_position_interface::get_axis (Grob *me)
458 if (scm_is_number (me->get_property ("side-axis")))
459 return Axis (scm_to_int (me->get_property ("side-axis")));
461 string msg = String_convert::form_string ("side-axis not set for grob %s.",
462 me->name ().c_str ());
463 me->programming_error (msg);
467 MAKE_SCHEME_CALLBACK (Side_position_interface, move_to_extremal_staff, 1);
469 Side_position_interface::move_to_extremal_staff (SCM smob)
471 Grob *me = unsmob_grob (smob);
472 System *sys = dynamic_cast<System *> (me->get_system ());
473 Direction dir = get_grob_direction (me);
477 Interval iv = me->extent (sys, X_AXIS);
479 Grob *top_staff = sys->get_extremal_staff (dir, iv);
484 // Only move this grob if it is a direct child of the system. We
485 // are not interested in moving marks from other staves to the top
486 // staff; we only want to move marks from the system to the top
488 if (sys != me->get_parent (Y_AXIS))
491 me->set_parent (top_staff, Y_AXIS);
492 me->flush_extent_cache (Y_AXIS);
493 Axis_group_interface::add_element (top_staff, me);
495 // Remove any cross-staff side-support dependencies
496 Grob_array *ga = unsmob_grob_array (me->get_object ("side-support-elements"));
499 vector<Grob *> const &elts = ga->array ();
500 vector<Grob *> new_elts;
501 for (vsize i = 0; i < elts.size (); ++i)
503 if (me->common_refpoint (elts[i], Y_AXIS) == top_staff)
504 new_elts.push_back (elts[i]);
506 ga->set_array (new_elts);
511 ADD_INTERFACE (Side_position_interface,
512 "Position a victim object (this one) next to other objects"
513 " (the support). The property @code{direction} signifies where"
514 " to put the victim object relative to the support (left or"
515 " right, up or down?)\n"
517 "The routine also takes the size of the staff into account if"
518 " @code{staff-padding} is set. If undefined, the staff symbol"
529 "side-support-elements "