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"
19 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner
, y_extent
, 1);
21 Hara_kiri_group_spanner::y_extent (SCM smob
)
23 Grob
*me
= unsmob_grob (smob
);
24 consider_suicide (me
);
25 return Axis_group_interface::generic_group_extent (me
, Y_AXIS
);
28 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner
, pure_height
, 3);
30 Hara_kiri_group_spanner::pure_height (SCM smob
, SCM start_scm
, SCM end_scm
)
32 Grob
*me
= unsmob_grob (smob
);
33 int start
= robust_scm2int (start_scm
, 0);
34 int end
= robust_scm2int (end_scm
, INT_MAX
);
36 if (request_suicide (me
, start
, end
))
37 return ly_interval2scm (Interval ());
38 return Axis_group_interface::pure_group_height (me
, start
, end
);
41 /* there is probably a way that doesn't involve re-implementing a binary
42 search (I would love some proper closures right now) */
43 bool find_in_range (SCM vector
, int low
, int hi
, int min
, int max
)
48 int mid
= low
+ (hi
- low
) / 2;
49 int val
= scm_to_int (scm_c_vector_ref (vector
, mid
));
50 if (val
>= min
&& val
<= max
)
53 return find_in_range (vector
, mid
+1, hi
, min
, max
);
54 return find_in_range (vector
, low
, mid
, min
, max
);
58 Hara_kiri_group_spanner::request_suicide (Grob
*me
, int start
, int end
)
60 if (!to_boolean (me
->get_property ("remove-empty")))
63 bool remove_first
= to_boolean (me
->get_property ("remove-first"));
64 if (!remove_first
&& start
<= 0)
67 SCM important
= me
->get_property ("important-column-ranks");
68 if (scm_is_vector (important
))
70 int len
= scm_c_vector_length (important
);
71 if (find_in_range (important
, 0, len
, start
, end
))
74 else /* build the important-columns-cache */
76 extract_grob_set (me
, "items-worth-living", worth
);
79 for (vsize i
= 0; i
< worth
.size (); i
++)
81 Interval_t
<int> iv
= worth
[i
]->spanned_rank_iv ();
82 for (int j
= iv
[LEFT
]; j
<= iv
[RIGHT
]; j
++)
85 vector_sort (ranks
, less
<int> ());
88 SCM scm_vec
= scm_c_make_vector (ranks
.size (), SCM_EOL
);
89 for (vsize i
= 0; i
< ranks
.size (); i
++)
90 scm_vector_set_x (scm_vec
, scm_from_int (i
), scm_from_int (ranks
[i
]));
91 me
->set_property ("important-column-ranks", scm_vec
);
93 return request_suicide (me
, start
, end
);
100 Hara_kiri_group_spanner::consider_suicide (Grob
*me
)
102 Spanner
*sp
= dynamic_cast<Spanner
*> (me
);
103 int left
= sp
->get_bound (LEFT
)->get_column ()->get_rank ();
104 int right
= sp
->get_bound (RIGHT
)->get_column ()->get_rank ();
105 if (!request_suicide (me
, left
, right
))
108 vector
<Grob
*> childs
;
109 Axis_group_interface::get_children (me
, &childs
);
110 for (vsize i
= 0; i
< childs
.size (); i
++)
111 childs
[i
]->suicide ();
114 very appropriate name here :-)
120 We can't rely on offsets and dimensions of elements in a hara-kiri
121 group. Use a callback to make sure that hara-kiri has been done
122 before asking for offsets. */
123 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner
, after_line_breaking
, 1);
125 Hara_kiri_group_spanner::after_line_breaking (SCM smob
)
127 Grob
*me
= unsmob_grob (smob
);
128 consider_suicide (me
);
129 return SCM_UNSPECIFIED
;
132 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner
, force_hara_kiri_callback
, 1);
134 Hara_kiri_group_spanner::force_hara_kiri_callback (SCM smob
)
136 Grob
*me
= unsmob_grob (smob
);
137 consider_suicide (me
);
138 return scm_from_double (0.0);
141 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner
, force_hara_kiri_in_y_parent_callback
, 1);
143 Hara_kiri_group_spanner::force_hara_kiri_in_y_parent_callback (SCM smob
)
145 Grob
*daughter
= unsmob_grob (smob
);
146 force_hara_kiri_callback (daughter
->get_parent (Y_AXIS
)->self_scm ());
147 return scm_from_double (0.0);
151 Hara_kiri_group_spanner::add_interesting_item (Grob
*me
, Grob
*n
)
153 Pointer_group_interface::add_unordered_grob (me
, ly_symbol2scm ("items-worth-living"), n
);
156 ADD_INTERFACE (Hara_kiri_group_spanner
, "hara-kiri-group-interface",
157 "A group spanner that keeps track of interesting items. If it "
158 "doesn't contain any after linebreaking, then it "
159 "will remove itself and all its children.",
163 "items-worth-living "
164 "important-column-ranks "