Compare commits

...

4 Commits

Author SHA1 Message Date
monxa 94840c5a5c
Merge 0fc11bf05b into 60a767032e 2024-09-26 15:37:10 +00:00
Alexander Montag 0fc11bf05b Make TreeSearch::_select_item consistent 2024-09-26 15:36:59 +00:00
Serhii Snitsaruk 60a767032e
Merge pull request #226 from limbonaut/fix-hsm-exit-crash
Fix invalid access errors on exit in LimboHSM
2024-09-26 16:54:31 +02:00
Serhii Snitsaruk 60142b191d
Fix invalid access crash on exit in LimboHSM
Since #131, `LimboState::_exit()` became a source of potential crashes
if object references are used without a validity check. It's too easy
to miss this, which can lead to game crashing during runtime.

This fix reverts #131 change and proposes alternative approach of
re-activating root HSM upon tree entering if it was previously active.
Note that it's not an ideal solution, as some state will be lost upon
re-parenting: HSM exits and then re-activates and enters its initial state.
2024-09-22 13:57:15 +02:00
5 changed files with 32 additions and 17 deletions

View File

@ -35,6 +35,7 @@
#include <godot_cpp/classes/style_box_flat.hpp> #include <godot_cpp/classes/style_box_flat.hpp>
#include <godot_cpp/classes/viewport.hpp> #include <godot_cpp/classes/viewport.hpp>
#include <godot_cpp/core/math.hpp> #include <godot_cpp/core/math.hpp>
#endif // LIMBOAI_GDEXTENSION #endif // LIMBOAI_GDEXTENSION
#define UPPER_BOUND (1 << 15) // for substring search. #define UPPER_BOUND (1 << 15) // for substring search.
@ -58,14 +59,16 @@ void TreeSearchPanel::_initialize_controls() {
this->set_anchors_and_offsets_preset(LayoutPreset::PRESET_BOTTOM_WIDE); this->set_anchors_and_offsets_preset(LayoutPreset::PRESET_BOTTOM_WIDE);
this->set_v_size_flags(SIZE_SHRINK_CENTER); // Do not expand vertically this->set_v_size_flags(SIZE_SHRINK_CENTER); // Do not expand vertically
// hack add separator to the left so line edit doesn't clip.
line_edit_search->set_h_size_flags(SIZE_EXPAND_FILL); line_edit_search->set_h_size_flags(SIZE_EXPAND_FILL);
_add_spacer(0.25); // otherwise the lineedits expand margin touches the left border. _add_spacer(0.25); // otherwise the lineedits expand margin touches the left border.
add_child(line_edit_search); add_child(line_edit_search);
_add_spacer(0.25);
add_child(check_button_filter_highlight); add_child(check_button_filter_highlight);
add_child(label_filter); add_child(label_filter);
_add_spacer();
_add_spacer(0.25);
add_child(close_button); add_child(close_button);
_add_spacer(0.25); _add_spacer(0.25);
} }
@ -86,7 +89,7 @@ void TreeSearchPanel::_emit_text_submitted(const String &p_text) {
this->emit_signal("text_submitted"); this->emit_signal("text_submitted");
} }
void TreeSearchPanel::_emit_update_requested(){ void TreeSearchPanel::_emit_update_requested() {
emit_signal("update_requested"); emit_signal("update_requested");
} }
@ -364,18 +367,21 @@ TreeSearch::StringSearchIndices TreeSearch::_substring_bounds(const String &p_se
void TreeSearch::_select_item(TreeItem *p_item) { void TreeSearch::_select_item(TreeItem *p_item) {
if (!p_item) if (!p_item)
return; return;
tree_reference->set_selected(p_item, 0);
// first unfold ancestors // first unfold ancestors
TreeItem * ancestor = p_item->get_parent(); TreeItem *ancestor = p_item->get_parent();
ancestor = ancestor->get_parent(); ancestor = ancestor->get_parent();
while (ancestor) { while (ancestor) {
ancestor->set_collapsed(false); ancestor->set_collapsed(false);
ancestor = ancestor->get_parent(); ancestor = ancestor->get_parent();
} }
// then scroll to [item]
//then scroll to [item]
tree_reference->scroll_to_item(p_item); tree_reference->scroll_to_item(p_item);
// ...and select it
tree_reference->deselect_all();
tree_reference->set_selected(p_item, 0);
} }
void TreeSearch::_select_first_match() { void TreeSearch::_select_first_match() {

View File

@ -95,7 +95,6 @@ private:
void _update_ordered_tree_items(TreeItem *p_tree_item); void _update_ordered_tree_items(TreeItem *p_tree_item);
void _update_number_matches(); void _update_number_matches();
Vector<TreeItem *> _find_matching_entries(TreeItem *p_tree_item, const String &p_search_mask, Vector<TreeItem *> &p_buffer); Vector<TreeItem *> _find_matching_entries(TreeItem *p_tree_item, const String &p_search_mask, Vector<TreeItem *> &p_buffer);
StringSearchIndices _substring_bounds(const String &p_searchable, const String &p_search_mask) const; StringSearchIndices _substring_bounds(const String &p_searchable, const String &p_search_mask) const;
@ -103,8 +102,9 @@ private:
void _select_first_match(); void _select_first_match();
void _select_next_match(); void _select_next_match();
template<typename T> template <typename T>
bool _vector_has_bsearch(Vector<T*> p_vec, T* element); bool _vector_has_bsearch(Vector<T *> p_vec, T *element);
protected: protected:
static void _bind_methods() {} static void _bind_methods() {}
@ -119,5 +119,3 @@ public:
#endif // TREE_SEARCH_H #endif // TREE_SEARCH_H
#endif // ! TOOLS_ENABLED #endif // ! TOOLS_ENABLED

View File

@ -263,6 +263,21 @@ void LimboHSM::_validate_property(PropertyInfo &p_property) const {
void LimboHSM::_notification(int p_what) { void LimboHSM::_notification(int p_what) {
switch (p_what) { switch (p_what) {
case NOTIFICATION_POST_ENTER_TREE: { case NOTIFICATION_POST_ENTER_TREE: {
if (was_active && is_root()) {
// Re-activate the root HSM if it was previously active.
// Typically, this happens when the node is re-entered scene repeatedly (e.g., re-parenting, pooling).
set_active(true);
}
} break;
case NOTIFICATION_EXIT_TREE: {
if (is_root()) {
// Remember active status for re-parenting and exit state machine
// to release resources and signal connections if active.
was_active = active;
if (is_active()) {
_exit();
}
}
} break; } break;
case NOTIFICATION_PROCESS: { case NOTIFICATION_PROCESS: {
_update(get_process_delta_time()); _update(get_process_delta_time());

View File

@ -55,6 +55,7 @@ private:
LimboState *previous_active; LimboState *previous_active;
LimboState *next_active; LimboState *next_active;
bool updating = false; bool updating = false;
bool was_active = false;
HashMap<TransitionKey, Transition, TransitionKeyHasher> transitions; HashMap<TransitionKey, Transition, TransitionKeyHasher> transitions;

View File

@ -190,11 +190,6 @@ void LimboState::_notification(int p_what) {
_update_blackboard_plan(); _update_blackboard_plan();
} }
} break; } break;
case NOTIFICATION_PREDELETE: {
if (is_active()) {
_exit();
}
} break;
} }
} }