2 separation-item.cc -- implement Separation_item
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "separation-item.hh"
12 #include "paper-column.hh"
14 #include "pointer-group-interface.hh"
15 #include "accidental-placement.hh"
18 Separation_item::add_item (Grob *s, Item *i)
21 Pointer_group_interface::add_grob (s, ly_symbol2scm ("elements"), i);
25 Separation_item::add_conditional_item (Grob *me, Grob *e)
27 Pointer_group_interface::add_grob (me, ly_symbol2scm ("conditional-elements"), e);
31 Separation_item::set_skyline_distance (Drul_array<Item *> items,
34 Drul_array<Skyline*> lines;
39 SCM prop = items[d]->get_property ("skylines");
40 lines[d] = Skyline::unsmob (index_get_cell (prop, -d));
42 while (flip (&d) != LEFT);
44 Real dist = padding + lines[LEFT]->distance (*lines[RIGHT]);
49 rod.item_drul_ = items;
57 Separation_item::set_distance (Drul_array<Item *> items,
60 if (!Item::is_non_musical (items[LEFT])
61 && !Item::is_non_musical (items[RIGHT]))
63 set_skyline_distance (items, padding);
67 Interval li (Separation_item::width (items[LEFT]));
68 Interval ri (Separation_item::conditional_width (items[RIGHT], items[LEFT]));
69 if (!li.is_empty () && !ri.is_empty ())
73 rod.item_drul_ = items;
75 rod.distance_ = li[RIGHT] - ri[LEFT] + padding;
77 if (rod.distance_ > 0)
85 Return the width of ME given that we are considering the object on
89 Separation_item::conditional_width (Grob *me, Grob *left)
91 Interval w = width (me);
93 Item *item = dynamic_cast<Item *> (me);
94 Paper_column *pc = item->get_column ();
96 extract_grob_set (me, "conditional-elements", elts);
97 for (vsize i = 0; i < elts.size (); i++)
99 Item *il = dynamic_cast<Item *> (elts[i]);
100 if (pc != il->get_column ())
102 programming_error ("Separation_item element from wrong column");
106 if (to_boolean (il->get_property ("no-spacing-rods")))
109 if (Accidental_placement::has_interface (il))
110 w.unite (Accidental_placement::get_relevant_accidental_extent (il, pc, left));
113 SCM pad = me->get_property ("padding");
115 w.widen (robust_scm2double (pad, 0.0));
120 MAKE_SCHEME_CALLBACK(Separation_item,calc_skylines,1);
122 Separation_item::calc_skylines (SCM smob)
124 Item *me = unsmob_item (smob);
125 SCM lines = scm_cons (SCM_BOOL_F,SCM_BOOL_F);
128 vector<Box> bs = boxes (me);
131 /* todo: make skyline max-slope configurable? */
132 Skyline l (bs, 2, Y_AXIS, d);
133 index_set_cell (lines, d, l.smobbed_copy ());
135 while (flip (&d) != LEFT);
142 Separation_item::boxes (Grob *me)
144 Item *item = dynamic_cast<Item *> (me);
146 int very_large = INT_MAX;
147 Paper_column *pc = item->get_column ();
149 extract_grob_set (me, "elements", elts);
151 Grob *ycommon = common_refpoint_of_array (elts, me, Y_AXIS);
153 for (vsize i = 0; i < elts.size (); i++)
155 Item *il = dynamic_cast<Item *> (elts[i]);
156 if (pc != il->get_column ())
161 if (to_boolean (il->get_property ("no-spacing-rods")))
164 Interval y (il->pure_height (ycommon, 0, very_large));
165 y.widen (0.01); // fixme
166 Box b (il->extent (pc, X_AXIS), y);
175 Separation_item::width (Grob *me)
177 SCM sw = me->get_property ("X-extent");
178 if (is_number_pair (sw))
179 return ly_scm2interval (sw);
181 Item *item = dynamic_cast<Item *> (me);
182 Paper_column *pc = item->get_column ();
185 extract_grob_set (me, "elements", elts);
186 for (vsize i = 0; i < elts.size (); i++)
188 Item *il = dynamic_cast<Item *> (elts[i]);
189 if (pc != il->get_column ())
191 /* this shouldn't happen, but let's continue anyway. */
192 programming_error ("Separation_item: I've been drinking too much");
193 continue; /*UGH UGH*/
196 if (to_boolean (il->get_property ("no-spacing-rods")))
199 Interval iv (il->extent (pc, X_AXIS));
204 SCM pad = me->get_property ("padding");
206 w.widen (robust_scm2double (pad, 0.0));
208 me->set_property ("X-extent", ly_interval2scm (w));
214 Separation_item::relative_width (Grob *me, Grob *common)
216 Interval iv = width (me);
218 return dynamic_cast<Item *> (me)->get_column ()->relative_coordinate (common, X_AXIS) + iv;
222 Try to find the break-aligned symbol in SEPARATION_ITEM that is
223 sticking out at direction D. The x size is put in LAST_EXT
226 Separation_item::extremal_break_aligned_grob (Grob *me,
230 Grob *col = dynamic_cast<Item *> (me)->get_column ();
231 last_ext->set_empty ();
234 extract_grob_set (me, "elements", elts);
235 for (vsize i = elts.size (); i--;)
237 Grob *break_item = elts[i];
238 if (!scm_is_symbol (break_item->get_property ("break-align-symbol")))
241 if (!scm_is_pair (break_item->get_property ("space-alist")))
244 Interval ext = break_item->extent (col, X_AXIS);
250 || (last_grob && d * (ext[d]- (*last_ext)[d]) > 0))
253 last_grob = break_item;
260 ADD_INTERFACE (Separation_item,
261 "Item that computes widths to generate spacing rods. "
262 "This is done in concert with @ref{separating-group-spanner-interface}.",
265 "conditional-elements "