2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2014 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 "break-align-interface.hh"
22 #include "align-interface.hh"
23 #include "axis-group-interface.hh"
24 #include "dimensions.hh"
25 #include "international.hh"
26 #include "output-def.hh"
27 #include "paper-column.hh"
28 #include "pointer-group-interface.hh"
29 #include "side-position-interface.hh"
33 This is tricky: we cannot modify 'elements, since callers are
34 iterating the same list. Reordering the list in-place, or resetting
35 'elements will skip elements in the loops of callers.
37 So we return the correct order as an array.
40 Break_alignment_interface::break_align_order (Item *me)
42 SCM order_vec = me->get_property ("break-align-orders");
43 if (!scm_is_vector (order_vec)
44 || scm_c_vector_length (order_vec) < 3)
47 SCM order = scm_vector_ref (order_vec,
48 scm_from_int (me->break_status_dir () + 1));
54 Break_alignment_interface::ordered_elements (Grob *grob)
56 Item *me = dynamic_cast<Item *> (grob);
57 extract_grob_set (me, "elements", elts);
59 SCM order = break_align_order (me);
61 if (order == SCM_BOOL_F)
64 vector<Grob *> writable_elts (elts);
66 Copy in order specified in BREAK-ALIGN-ORDER.
68 vector<Grob *> new_elts;
69 for (; scm_is_pair (order); order = scm_cdr (order))
71 SCM sym = scm_car (order);
73 for (vsize i = writable_elts.size (); i--;)
75 Grob *g = writable_elts[i];
76 if (g && sym == g->get_property ("break-align-symbol"))
78 new_elts.push_back (g);
79 writable_elts.erase (writable_elts.begin () + i);
88 Break_alignment_interface::add_element (Grob *me, Grob *toadd)
90 Align_interface::add_element (me, toadd);
93 MAKE_SCHEME_CALLBACK (Break_alignment_interface, calc_positioning_done, 1)
95 Break_alignment_interface::calc_positioning_done (SCM smob)
97 Grob *grob = unsmob_grob (smob);
98 Item *me = dynamic_cast<Item *> (grob);
100 me->set_property ("positioning-done", SCM_BOOL_T);
102 vector<Grob *> elems = ordered_elements (me);
103 vector<Interval> extents;
105 for (vsize i = 0; i < elems.size (); i++)
107 Interval y = elems[i]->extent (elems[i], X_AXIS);
108 extents.push_back (y);
112 while (idx < extents.size () && extents[idx].is_empty ())
115 vector<Real> offsets;
116 offsets.resize (elems.size ());
117 for (vsize i = 0; i < offsets.size (); i++)
120 Real extra_right_space = 0.0;
121 vsize edge_idx = VPOS;
122 while (idx < elems.size ())
124 vsize next_idx = idx + 1;
125 while (next_idx < elems.size ()
126 && extents[next_idx].is_empty ())
129 Grob *l = elems[idx];
132 if (next_idx < elems.size ())
138 Find the first grob with a space-alist entry.
140 extract_grob_set (l, "elements", elts);
142 for (vsize i = elts.size (); i--;)
147 && (elt->get_property ("break-align-symbol")
148 == ly_symbol2scm ("left-edge")))
151 SCM l = elt->get_property ("space-alist");
159 SCM rsym = r ? SCM_EOL : ly_symbol2scm ("right-edge");
162 We used to use #'cause to find out the symbol and the spacing
163 table, but that gets icky when that grob is suicided for some
168 extract_grob_set (r, "elements", elts);
169 for (vsize i = elts.size ();
170 !scm_is_symbol (rsym) && i--;)
173 rsym = elt->get_property ("break-align-symbol");
177 if (rsym == ly_symbol2scm ("left-edge"))
181 if (scm_is_symbol (rsym))
182 entry = scm_assq (rsym, alist);
184 bool entry_found = scm_is_pair (entry);
188 if (scm_is_symbol (rsym))
189 sym_string = ly_symbol2string (rsym);
192 if (unsmob_grob (l->get_property ("cause")))
193 orig_string = unsmob_grob (l->get_property ("cause"))->name ();
195 programming_error (to_string ("No spacing entry from %s to `%s'",
196 orig_string.c_str (),
197 sym_string.c_str ()));
201 SCM type = ly_symbol2scm ("extra-space");
205 entry = scm_cdr (entry);
207 distance = scm_to_double (scm_cdr (entry));
208 type = scm_car (entry);
213 if (type == ly_symbol2scm ("extra-space"))
214 offsets[next_idx] = extents[idx][RIGHT] + distance
215 - extents[next_idx][LEFT];
216 /* should probably junk minimum-space */
217 else if (type == ly_symbol2scm ("minimum-space"))
218 offsets[next_idx] = max (extents[idx][RIGHT], distance);
222 extra_right_space = distance;
223 if (idx + 1 < offsets.size ())
224 offsets[idx + 1] = extents[idx][RIGHT] + distance;
231 Interval total_extent;
233 Real alignment_off = 0.0;
234 for (vsize i = 0; i < offsets.size (); i++)
238 alignment_off = -here;
239 total_extent.unite (extents[i] + here);
242 if (total_extent.is_empty ())
245 if (me->break_status_dir () == LEFT)
246 alignment_off = -total_extent[RIGHT] - extra_right_space;
247 else if (edge_idx == VPOS)
248 alignment_off = -total_extent[LEFT];
250 here = alignment_off;
251 for (vsize i = 0; i < offsets.size (); i++)
254 elems[i]->translate_axis (here, X_AXIS);
260 MAKE_SCHEME_CALLBACK (Break_alignable_interface, self_align_callback, 1)
262 Break_alignable_interface::self_align_callback (SCM grob)
264 Grob *me = unsmob_grob (grob);
265 Item *alignment = dynamic_cast<Item *> (me->get_parent (X_AXIS));
266 if (!Break_alignment_interface::has_interface (alignment))
267 return scm_from_int (0);
269 SCM symbol_list = me->get_property ("break-align-symbols");
270 vector<Grob *> elements = Break_alignment_interface::ordered_elements (alignment);
271 if (elements.size () == 0)
272 return scm_from_int (0);
274 int break_aligned_grob = -1;
275 for (; scm_is_pair (symbol_list); symbol_list = scm_cdr (symbol_list))
277 SCM sym = scm_car (symbol_list);
278 for (vsize i = 0; i < elements.size (); i++)
280 if (elements[i]->get_property ("break-align-symbol") == sym)
282 if (Item::break_visible (elements[i])
283 && !elements[i]->extent (elements[i], X_AXIS).is_empty ())
285 break_aligned_grob = i;
286 goto found_break_aligned_grob; /* ugh. need to break out of 2 loops */
288 else if (break_aligned_grob == -1)
289 break_aligned_grob = i;
294 found_break_aligned_grob:
295 if (break_aligned_grob == -1)
296 return scm_from_int (0);
298 Grob *alignment_parent = elements[break_aligned_grob];
299 Grob *common = me->common_refpoint (alignment_parent, X_AXIS);
300 Real anchor = robust_scm2double (alignment_parent->get_property ("break-align-anchor"), 0);
302 return scm_from_double (alignment_parent->relative_coordinate (common, X_AXIS)
303 - me->relative_coordinate (common, X_AXIS)
307 MAKE_SCHEME_CALLBACK (Break_aligned_interface, calc_average_anchor, 1)
309 Break_aligned_interface::calc_average_anchor (SCM grob)
311 Grob *me = unsmob_grob (grob);
315 /* average the anchors of those children that have it set */
316 extract_grob_set (me, "elements", elts);
317 for (vsize i = 0; i < elts.size (); i++)
319 SCM anchor = elts[i]->get_property ("break-align-anchor");
320 if (scm_is_number (anchor))
323 avg += scm_to_double (anchor);
327 return scm_from_double (count > 0 ? avg / count : 0);
330 MAKE_SCHEME_CALLBACK (Break_aligned_interface, calc_extent_aligned_anchor, 1)
332 Break_aligned_interface::calc_extent_aligned_anchor (SCM smob)
334 Grob *me = unsmob_grob (smob);
335 Real alignment = robust_scm2double (me->get_property ("break-align-anchor-alignment"), 0.0);
336 Interval iv = me->extent (me, X_AXIS);
338 if (isinf (iv[LEFT]) && isinf (iv[RIGHT])) /* avoid NaN */
339 return scm_from_double (0.0);
341 return scm_from_double (iv.linear_combination (alignment));
344 MAKE_SCHEME_CALLBACK (Break_aligned_interface, calc_break_visibility, 1)
346 Break_aligned_interface::calc_break_visibility (SCM smob)
348 /* a BreakAlignGroup is break-visible if it has one element that is break-visible */
349 Grob *me = unsmob_grob (smob);
350 SCM ret = scm_c_make_vector (3, SCM_EOL);
351 extract_grob_set (me, "elements", elts);
352 for (int dir = 0; dir <= 2; dir++)
354 bool visible = false;
355 for (vsize i = 0; i < elts.size (); i++)
357 SCM vis = elts[i]->get_property ("break-visibility");
358 if (scm_is_vector (vis) && to_boolean (scm_c_vector_ref (vis, dir)))
361 scm_c_vector_set_x (ret, dir, scm_from_bool (visible));
366 ADD_INTERFACE (Break_alignable_interface,
367 "Object that is aligned on a break alignment.",
370 "break-align-symbols "
371 "non-break-align-symbols "
374 ADD_INTERFACE (Break_aligned_interface,
375 "Items that are aligned in prefatory matter.\n"
377 "The spacing of these items is controlled by the"
378 " @code{space-alist} property. It contains a list"
379 " @code{break-align-symbol}s with a specification of the"
380 " associated space. The space specification can be\n"
383 "@item (minimum-space . @var{spc}))\n"
384 "Pad space until the distance is @var{spc}.\n"
385 "@item (fixed-space . @var{spc})\n"
386 "Set a fixed space.\n"
387 "@item (semi-fixed-space . @var{spc})\n"
388 "Set a space. Half of it is fixed and half is stretchable."
389 " (does not work at start of line. fixme)\n"
390 "@item (extra-space . @var{spc})\n"
391 "Add @var{spc} amount of space.\n"
394 "Special keys for the alist are @code{first-note} and"
395 " @code{next-note}, signifying the first note on a line, and"
396 " the next note halfway a line.\n"
398 "Rules for this spacing are much more complicated than this."
399 " See [Wanske] page 126--134, [Ross] page 143--147.",
402 "break-align-anchor "
403 "break-align-anchor-alignment "
404 "break-align-symbol "
408 ADD_INTERFACE (Break_alignment_interface,
409 "The object that performs break alignment. See"
410 " @ref{break-aligned-interface}.",
414 "break-align-orders "