2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1998--2010 Jan Nieuwenhuizen <janneke@gnu.org>
5 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 LilyPond is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 LilyPond is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
21 #include "hara-kiri-group-spanner.hh"
23 #include "paper-column.hh"
24 #include "pointer-group-interface.hh"
25 #include "axis-group-interface.hh"
29 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner
, y_extent
, 1);
31 Hara_kiri_group_spanner::y_extent (SCM smob
)
33 Grob
*me
= unsmob_grob (smob
);
34 consider_suicide (me
);
35 return Axis_group_interface::generic_group_extent (me
, Y_AXIS
);
38 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner
, calc_skylines
, 1);
40 Hara_kiri_group_spanner::calc_skylines (SCM smob
)
42 Grob
*me
= unsmob_grob (smob
);
43 consider_suicide (me
);
44 return Axis_group_interface::calc_skylines (smob
);
47 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner
, pure_height
, 3);
49 Hara_kiri_group_spanner::pure_height (SCM smob
, SCM start_scm
, SCM end_scm
)
51 Grob
*me
= unsmob_grob (smob
);
52 int start
= robust_scm2int (start_scm
, 0);
53 int end
= robust_scm2int (end_scm
, INT_MAX
);
55 if (request_suicide (me
, start
, end
))
56 return ly_interval2scm (Interval ());
58 return ly_interval2scm (Axis_group_interface::pure_group_height (me
, start
, end
));
61 /* there is probably a way that doesn't involve re-implementing a binary
62 search (I would love some proper closures right now) */
63 bool find_in_range (SCM vector
, int low
, int hi
, int min
, int max
)
68 int mid
= low
+ (hi
- low
) / 2;
69 int val
= scm_to_int (scm_c_vector_ref (vector
, mid
));
70 if (val
>= min
&& val
<= max
)
73 return find_in_range (vector
, mid
+1, hi
, min
, max
);
74 return find_in_range (vector
, low
, mid
, min
, max
);
78 Hara_kiri_group_spanner::request_suicide (Grob
*me
, int start
, int end
)
80 if (!request_suicide_alone (me
, start
, end
))
83 extract_grob_set (me
, "keep-alive-with", friends
);
84 for (vsize i
= 0; i
< friends
.size (); ++i
)
85 if (friends
[i
]->is_live () && !request_suicide_alone (friends
[i
], start
, end
))
92 Hara_kiri_group_spanner::request_suicide_alone (Grob
*me
, int start
, int end
)
94 if (!to_boolean (me
->get_property ("remove-empty")))
97 bool remove_first
= to_boolean (me
->get_property ("remove-first"));
98 if (!remove_first
&& start
<= 0)
101 SCM important
= me
->get_property ("important-column-ranks");
102 if (scm_is_vector (important
))
104 int len
= scm_c_vector_length (important
);
105 if (find_in_range (important
, 0, len
, start
, end
))
108 else /* build the important-columns-cache */
110 extract_grob_set (me
, "items-worth-living", worth
);
113 for (vsize i
= 0; i
< worth
.size (); i
++)
115 Interval_t
<int> iv
= worth
[i
]->spanned_rank_interval ();
116 for (int j
= iv
[LEFT
]; j
<= iv
[RIGHT
]; j
++)
119 vector_sort (ranks
, less
<int> ());
122 SCM scm_vec
= scm_c_make_vector (ranks
.size (), SCM_EOL
);
123 for (vsize i
= 0; i
< ranks
.size (); i
++)
124 scm_vector_set_x (scm_vec
, scm_from_int (i
), scm_from_int (ranks
[i
]));
125 me
->set_property ("important-column-ranks", scm_vec
);
127 return request_suicide (me
, start
, end
);
134 Hara_kiri_group_spanner::consider_suicide (Grob
*me
)
136 Spanner
*sp
= dynamic_cast<Spanner
*> (me
);
137 int left
= sp
->get_bound (LEFT
)->get_column ()->get_rank ();
138 int right
= sp
->get_bound (RIGHT
)->get_column ()->get_rank ();
139 if (!request_suicide (me
, left
, right
))
142 vector
<Grob
*> childs
;
143 Axis_group_interface::get_children (me
, &childs
);
144 for (vsize i
= 0; i
< childs
.size (); i
++)
145 childs
[i
]->suicide ();
148 very appropriate name here :-)
154 We can't rely on offsets and dimensions of elements in a hara-kiri
155 group. Use a callback to make sure that hara-kiri has been done
156 before asking for offsets. */
157 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner
, force_hara_kiri_callback
, 1);
159 Hara_kiri_group_spanner::force_hara_kiri_callback (SCM smob
)
161 Grob
*me
= unsmob_grob (smob
);
162 consider_suicide (me
);
163 return scm_from_double (0.0);
166 MAKE_SCHEME_CALLBACK (Hara_kiri_group_spanner
, force_hara_kiri_in_y_parent_callback
, 1);
168 Hara_kiri_group_spanner::force_hara_kiri_in_y_parent_callback (SCM smob
)
170 Grob
*daughter
= unsmob_grob (smob
);
171 force_hara_kiri_callback (daughter
->get_parent (Y_AXIS
)->self_scm ());
172 return scm_from_double (0.0);
176 Hara_kiri_group_spanner::add_interesting_item (Grob
*me
, Grob
*n
)
178 Pointer_group_interface::add_unordered_grob (me
, ly_symbol2scm ("items-worth-living"), n
);
181 ADD_INTERFACE (Hara_kiri_group_spanner
,
182 "A group spanner that keeps track of interesting items. If it"
183 " doesn't contain any after line breaking, it removes itself"
184 " and all its children.",
187 "items-worth-living "
188 "important-column-ranks "