Cool_Tools/ImHex
1
0
Fork 0
mirror of synced 2025-02-17 18:59:21 +01:00
Code Releases Wiki Activity

fix: Event unsubscribe not working correcetly when using same key for multiple events (#1309)

Browse Source 
<!--
Please provide as much information as possible about what your PR aims
to do.
PRs with no description will most likely be closed until more
information is provided.
If you're planing on changing fundamental behaviour or add big new
features, please open a GitHub Issue first before starting to work on
it.
If it's not something big and you still want to contact us about it,
feel free to do so !
-->

### Problem description
<!-- Describe the bug that you fixed/feature request that you
implemented, or link to an existing issue describing it -->

Fixed possible bug of  `EventManager::unsubscribe`

`std::map` only allows unique key, but the same token can subscribe to
multiple events.

1a2a926b77/lib/libimhex/include/hex/api/event.hpp (L104-L107)

If the previous token has already subscribed to an event, then when
subscribing again, `getTokenStore().insert` will not do anything
(Because its type is `std::map`)


1a2a926b77/lib/libimhex/include/hex/api/event.hpp (L122-L134)

At this point in `unsubscribe`, the `iter` may not be able to find the
correct event and erase it



### Implementation description
<!-- Explain what you did to correct the problem -->

Change `tokenStore` to `std::multimap` instead of `std::map`, which
cannot unsubscribe multiple events correctly

### Screenshots
<!-- If your change is visual, take a screenshot showing it. Ideally,
make before/after sceenshots -->

### Additional things
<!-- Anything else you would like to say -->
This commit is contained in:
lomekragow 2023-10-08 05:35:35 +08:00 committed by GitHub
parent bb36000dd9
commit 7fc2ff3002
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
lib/libimhex/include/hex/api/event.hpp
View File

@ -103,6 +103,17 @@ namespace hex {
*/
template<impl::EventType E>
static void subscribe(void *token, typename E::Callback function) {
if (getTokenStore().contains(token)) {
auto&& [begin, end] = getTokenStore().equal_range(token);
auto eventRegistered = std::any_of(begin, end, [&](auto &item) {
return item.second->first == E::Id;
});
if (eventRegistered) {
log::fatal("The token '{}' has already registered the same event ('{}')", token, wolv::type::getTypeName<E>());
return;
}
}
getTokenStore().insert(std::make_pair(token, subscribe<E>(function)));
}
@ -161,7 +172,7 @@ namespace hex {
}
private:
static std::map<void *, EventList::iterator>& getTokenStore();
static std::multimap<void *, EventList::iterator>& getTokenStore();
static EventList& getEvents();
};

4
lib/libimhex/source/api/event.cpp
View File

@ -2,8 +2,8 @@
namespace hex {
std::map<void *, EventManager::EventList::iterator>& EventManager::getTokenStore() {
static std::map<void *, EventManager::EventList::iterator> tokenStore;
std::multimap<void *, EventManager::EventList::iterator>& EventManager::getTokenStore() {
static std::multimap<void *, EventManager::EventList::iterator> tokenStore;
return tokenStore;
}