2 break-align-interface.cc -- implement Break_align_interface
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
11 #include <libc-extension.hh> // isinf
13 #include "self-alignment-interface.hh"
14 #include "side-position-interface.hh"
15 #include "axis-group-interface.hh"
17 #include "lily-guile.hh"
18 #include "break-align-interface.hh"
19 #include "dimensions.hh"
20 #include "paper-def.hh"
21 #include "paper-column.hh"
22 #include "group-interface.hh"
23 #include "align-interface.hh"
25 MAKE_SCHEME_CALLBACK (Break_align_interface,alignment_callback,2);
28 Break_align_interface::alignment_callback (SCM element_smob, SCM axis)
30 Grob *me = unsmob_grob (element_smob);
31 Axis a = (Axis) gh_scm2int (axis);
34 Grob *par = me->get_parent (a);
35 if (par && !to_boolean (par->get_property ("positioning-done")))
37 par->set_property ("positioning-done", SCM_BOOL_T);
38 Break_align_interface::do_alignment (par);
41 return gh_double2scm (0);
44 MAKE_SCHEME_CALLBACK (Break_align_interface,self_align_callback,2);
46 Break_align_interface::self_align_callback (SCM element_smob, SCM axis)
48 Grob *me = unsmob_grob (element_smob);
49 Axis a = (Axis) gh_scm2int (axis);
52 Item* item = dynamic_cast<Item*> (me);
53 Direction bsd = item->break_status_dir ();
56 me->set_property ("self-alignment-X", scm_int2num (RIGHT));
60 Force break alignment itself to be done first, in the case
62 return Self_alignment_interface::aligned_on_self (element_smob, axis);
66 Break_align_interface::add_element (Grob*me, Grob *toadd)
68 Axis_group_interface::add_element (me, toadd);
72 Break_align_interface::do_alignment (Grob *me)
74 Item * item = dynamic_cast<Item*> (me);
75 Link_array<Grob> elems
76 = Pointer_group_interface__extract_grobs (me, (Grob*)0,
78 Array<Interval> extents;
80 int last_nonempty = -1;
81 for (int i=0; i < elems.size (); i++)
83 Interval y = elems[i]->extent (elems[i], X_AXIS);
90 while (idx < extents.size () && extents[idx].is_empty ())
94 offsets.set_size (elems.size ());
95 for (int i= 0; i < offsets.size ();i ++)
99 Real extra_right_space = 0.0;
101 while (idx < elems.size ())
103 int next_idx = idx+1;
104 while (next_idx < elems.size () &&
105 extents[next_idx].is_empty () )
108 Grob *l = elems[idx];
111 if (next_idx < elems.size ())
118 Find the first grob with a space-alist entry.
120 for (SCM s= l->get_property ("elements");
121 gh_pair_p (s) ; s = gh_cdr (s))
123 Grob *elt = unsmob_grob (gh_car (s));
126 && elt->get_property ("break-align-symbol")
127 == ly_symbol2scm ( "left-edge"))
130 SCM l =elt->get_property ("space-alist");
138 SCM rsym = r ? SCM_EOL : ly_symbol2scm ("right-edge");
141 We used to use #'cause to find out the symbol and the spacing
142 table, but that gets icky when that grob is suicided for some
145 for (SCM s = r ? r->get_property ("elements") : SCM_EOL;
146 !gh_symbol_p (rsym) && gh_pair_p (s); s = gh_cdr (s))
148 Grob * elt =unsmob_grob (gh_car (s));
150 rsym = elt->get_property ("break-align-symbol");
153 if (rsym == ly_symbol2scm ("left-edge"))
157 if (gh_symbol_p (rsym))
158 entry = scm_assq (rsym, alist);
160 bool entry_found = gh_pair_p (entry);
164 if (gh_symbol_p (rsym))
165 sym_string = ly_symbol2string (rsym);
168 if (unsmob_grob (l->get_property ("cause")))
169 orig_string = unsmob_grob (l->get_property ("cause"))->name ();
171 programming_error (_f ("No spacing entry from %s to `%s'",
172 orig_string.to_str0 (),
173 sym_string.to_str0 ()));
177 SCM type = ly_symbol2scm ("extra-space");
181 entry = gh_cdr (entry);
183 distance = gh_scm2double (gh_cdr (entry));
184 type = gh_car (entry) ;
189 if (type == ly_symbol2scm ("extra-space"))
190 offsets[next_idx] = extents[idx][RIGHT] + distance
191 - extents[next_idx][LEFT];
192 /* should probably junk minimum-space */
193 else if (type == ly_symbol2scm ("minimum-space"))
194 offsets[next_idx] = extents[idx][RIGHT] >? distance;
198 extra_right_space = distance;
205 Interval total_extent;
207 Real alignment_off =0.0;
208 for (int i =0 ; i < offsets.size (); i++)
212 alignment_off = -here;
213 total_extent.unite (extents[i] + here);
217 if (item->break_status_dir () == LEFT)
219 alignment_off = - total_extent[RIGHT] - extra_right_space;
221 else if (edge_idx < 0)
222 alignment_off = -total_extent[LEFT];
224 here = alignment_off;
225 for (int i =0 ; i < offsets.size (); i++)
228 elems[i]->translate_axis (here, X_AXIS);
233 ADD_INTERFACE (Break_aligned_interface, "break-aligned-interface",
234 "Items that are aligned in prefatory matter.\n"
236 "The spacing of these items is controlled by the @code{space-alist}\n"
237 "property. It contains a list @code{break-align-symbol}s with a specification\n"
238 "of the associated space. The space specification can be "
240 "@item (minimum-space . @var{spc}))\n"
241 " Pad space until the distance is @var{spc}\n"
242 "@item (fixed-space . @var{spc})\n"
243 " Set a fixed space\n"
244 "@item (semi-fixed-space . @var{spc})\n"
245 " Set a space. Half of it is fixed and half is stretchable. \n"
246 "(does not work at start of line. fixme)\n"
247 "@item (extra-space . @var{spc})\n"
248 " Add @var{spc} amount of space.\n"
251 "Special keys for the alist are @code{first-note} and @code{next-note}, signifying\n"
252 "the first note on a line, and the next note halfway a line.\n"
254 "Rules for this spacing are much more complicated than this. \n"
255 "See [Wanske] page 126 -- 134, [Ross] pg 143 -- 147\n",
256 "break-align-symbol space-alist");
258 ADD_INTERFACE (Break_align_interface, "break-alignment-interface",
259 "The object that performs break aligment. See @ref{break-aligned-interface}.",