2 hara-kiri-vertical-group-spanner.cc -- implement Hara_kiri_group_spanner
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
7 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "hara-kiri-group-spanner.hh"
12 #include "paper-column.hh"
13 #include "pointer-group-interface.hh"
14 #include "axis-group-interface.hh"
18 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, y_extent, 1);
20 Hara_kiri_group_spanner::y_extent (SCM smob)
22 Grob *me = unsmob_grob (smob);
23 consider_suicide (me);
24 return Axis_group_interface::generic_group_extent (me, Y_AXIS);
27 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, pure_height, 3);
29 Hara_kiri_group_spanner::pure_height (SCM smob, SCM start_scm, SCM end_scm)
31 Grob *me = unsmob_grob (smob);
32 int start = robust_scm2int (start_scm, 0);
33 int end = robust_scm2int (end_scm, INT_MAX);
35 if (request_suicide (me, start, end))
36 return ly_interval2scm (Interval ());
37 return Axis_group_interface::pure_group_height (me, start, end);
40 /* there is probably a way that doesn't involve re-implementing a binary
41 search (I would love some proper closures right now) */
42 bool find_in_range (SCM vector, int low, int hi, int min, int max)
47 int mid = low + (hi - low) / 2;
48 int val = scm_to_int (scm_c_vector_ref (vector, mid));
49 if (val >= min && val <= max)
52 return find_in_range (vector, mid+1, hi, min, max);
53 return find_in_range (vector, low, mid, min, max);
57 Hara_kiri_group_spanner::request_suicide (Grob *me, int start, int end)
59 if (!to_boolean (me->get_property ("remove-empty")))
62 bool remove_first = to_boolean (me->get_property ("remove-first"));
63 if (!remove_first && start <= 0)
66 SCM important = me->get_property ("important-column-ranks");
67 if (scm_is_vector (important))
69 int len = scm_c_vector_length (important);
70 if (find_in_range (important, 0, len, start, end))
73 else /* build the important-columns-cache */
75 extract_grob_set (me, "items-worth-living", worth);
78 for (vsize i = 0; i < worth.size (); i++)
80 Interval_t<int> iv = worth[i]->spanned_rank_iv ();
81 for (int j = iv[LEFT]; j <= iv[RIGHT]; j++)
84 vector_sort (ranks, less<int> ());
87 SCM scm_vec = scm_c_make_vector (ranks.size (), SCM_EOL);
88 for (vsize i = 0; i < ranks.size (); i++)
89 scm_vector_set_x (scm_vec, scm_from_int (i), scm_from_int (ranks[i]));
90 me->set_property ("important-column-ranks", scm_vec);
92 return request_suicide (me, start, end);
99 Hara_kiri_group_spanner::consider_suicide (Grob *me)
101 Spanner *sp = dynamic_cast<Spanner*> (me);
102 int left = sp->get_bound (LEFT)->get_column ()->get_rank ();
103 int right = sp->get_bound (RIGHT)->get_column ()->get_rank ();
104 if (!request_suicide (me, left, right))
107 vector<Grob*> childs;
108 Axis_group_interface::get_children (me, &childs);
109 for (vsize i = 0; i < childs.size (); i++)
110 childs[i]->suicide ();
113 very appropriate name here :-)
119 We can't rely on offsets and dimensions of elements in a hara-kiri
120 group. Use a callback to make sure that hara-kiri has been done
121 before asking for offsets. */
122 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, after_line_breaking, 1);
124 Hara_kiri_group_spanner::after_line_breaking (SCM smob)
126 Grob *me = unsmob_grob (smob);
127 consider_suicide (me);
128 return SCM_UNSPECIFIED;
131 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, force_hara_kiri_callback, 1);
133 Hara_kiri_group_spanner::force_hara_kiri_callback (SCM smob)
135 Grob *me = unsmob_grob (smob);
136 consider_suicide (me);
137 return scm_from_double (0.0);
140 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner, force_hara_kiri_in_y_parent_callback, 1);
142 Hara_kiri_group_spanner::force_hara_kiri_in_y_parent_callback (SCM smob)
144 Grob *daughter = unsmob_grob (smob);
145 force_hara_kiri_callback (daughter->get_parent (Y_AXIS)->self_scm ());
146 return scm_from_double (0.0);
150 Hara_kiri_group_spanner::add_interesting_item (Grob *me, Grob *n)
152 Pointer_group_interface::add_unordered_grob (me, ly_symbol2scm ("items-worth-living"), n);
155 ADD_INTERFACE (Hara_kiri_group_spanner,
156 "A group spanner that keeps track of interesting items. If it "
157 "doesn't contain any after linebreaking, then it "
158 "will remove itself and all its children.",
162 "items-worth-living "
163 "important-column-ranks "