Skip to content

Commit

Permalink
refactor: 🏷️ Change functions returning uint32_t to return int32_t
Browse files Browse the repository at this point in the history
  • Loading branch information
@ion098
ion098 committed Jan 29, 2025
1 parent f127b09 commit 08e6723
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 20 deletions.
16 changes: 8 additions & 8 deletions include/gamepad/button.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ class Button {
* gamepad::master.Up.onPress("upPress1", []() { std::cout << "I was pressed!" << std::endl; });
* @endcode
*/
uint32_t onPress(std::string listenerName, std::function<void(void)> func) const;
int32_t onPress(std::string listenerName, std::function<void(void)> func) const;
/**
* @brief Register a function to run when the button is long pressed.
*
Expand All @@ -108,7 +108,7 @@ class Button {
* std::endl; });
* @endcode
*/
uint32_t onLongPress(std::string listenerName, std::function<void(void)> func) const;
int32_t onLongPress(std::string listenerName, std::function<void(void)> func) const;
/**
* @brief Register a function to run when the button is released.
*
Expand All @@ -125,7 +125,7 @@ class Button {
* gamepad::master.Y.onRelease("stopIntake", []() { intake.move(0); });
* @endcode
*/
uint32_t onRelease(std::string listenerName, std::function<void(void)> func) const;
int32_t onRelease(std::string listenerName, std::function<void(void)> func) const;
/**
* @brief Register a function to run when the button is short released.
*
Expand All @@ -147,7 +147,7 @@ class Button {
* gamepad::master.B.onShortRelease("intakeOnePiece", []() { intake.move_relative(600, 100); });
* @endcode
*/
uint32_t onShortRelease(std::string listenerName, std::function<void(void)> func) const;
int32_t onShortRelease(std::string listenerName, std::function<void(void)> func) const;
/**
* @brief Register a function to run when the button is long released.
*
Expand All @@ -168,7 +168,7 @@ class Button {
* @endcode
*
*/
uint32_t onLongRelease(std::string listenerName, std::function<void(void)> func) const;
int32_t onLongRelease(std::string listenerName, std::function<void(void)> func) const;
/**
* @brief Register a function to run periodically after its been held
*
Expand All @@ -189,7 +189,7 @@ class Button {
* @endcode
*
*/
uint32_t onRepeatPress(std::string listenerName, std::function<void(void)> func) const;
int32_t onRepeatPress(std::string listenerName, std::function<void(void)> func) const;
/**
* @brief Register a function to run for a given event.
*
Expand All @@ -207,7 +207,7 @@ class Button {
* gamepad::master.L1.addListener(gamepad::ON_RELEASE, "stop_spin", []() { motor1.brake(); });
* @endcode
*/
uint32_t addListener(EventType event, std::string listenerName, std::function<void(void)> func) const;
int32_t addListener(EventType event, std::string listenerName, std::function<void(void)> func) const;
/**
* @brief Removes a listener from the button
* @warning Usage of this function is discouraged.
Expand All @@ -224,7 +224,7 @@ class Button {
* gamepad::master.L1.removeListener("do_something");
* @endcode
*/
uint32_t removeListener(std::string listenerName) const;
int32_t removeListener(std::string listenerName) const;

/**
* @brief Returns a value indicating whether the button is currently being held.
Expand Down
8 changes: 4 additions & 4 deletions include/gamepad/event_handler.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ template <typename Key, typename... Args> class EventHandler {
* @return 0 The listener was successfully added
* @return UINT32_MAX The listener was NOT successfully added (there is already a listener with the same key)
*/
uint32_t addListener(Key key, Listener func) {
int32_t addListener(Key key, Listener func) {
std::lock_guard lock(m_mutex);
if (std::find(m_keys.begin(), m_keys.end(), key) != m_keys.end()) return UINT32_MAX;
if (std::find(m_keys.begin(), m_keys.end(), key) != m_keys.end()) return INT32_MAX;
m_keys.push_back(key);
m_listeners.push_back(func);
return 0;
Expand All @@ -42,15 +42,15 @@ template <typename Key, typename... Args> class EventHandler {
* @return 0 The listener was successfully removed
* @return UINT32_MAX The listener was NOT successfully removed (there is no listener with the same key)
*/
uint32_t removeListener(Key key) {
int32_t removeListener(Key key) {
std::lock_guard lock(m_mutex);
auto i = std::find(m_keys.begin(), m_keys.end(), key);
if (i != m_keys.end()) {
m_keys.erase(i);
m_listeners.erase(m_listeners.begin() + (i - m_keys.begin()));
return 0;
}
return UINT32_MAX;
return INT32_MAX;
}

/**
Expand Down
16 changes: 8 additions & 8 deletions src/gamepad/button.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,31 @@ void Button::setLongPressThreshold(uint32_t threshold) const { m_long_press_thre

void Button::setRepeatCooldown(uint32_t cooldown) const { m_repeat_cooldown = cooldown; }

uint32_t Button::onPress(std::string listenerName, std::function<void(void)> func) const {
int32_t Button::onPress(std::string listenerName, std::function<void(void)> func) const {
return m_on_press_event.addListener(std::move(listenerName) + "_user", std::move(func));
}

uint32_t Button::onLongPress(std::string listenerName, std::function<void(void)> func) const {
int32_t Button::onLongPress(std::string listenerName, std::function<void(void)> func) const {
return m_on_long_press_event.addListener(std::move(listenerName) + "_user", std::move(func));
}

uint32_t Button::onRelease(std::string listenerName, std::function<void(void)> func) const {
int32_t Button::onRelease(std::string listenerName, std::function<void(void)> func) const {
return m_on_release_event.addListener(std::move(listenerName) + "_user", std::move(func));
}

uint32_t Button::onShortRelease(std::string listenerName, std::function<void(void)> func) const {
int32_t Button::onShortRelease(std::string listenerName, std::function<void(void)> func) const {
return m_on_short_release_event.addListener(std::move(listenerName) + "_user", std::move(func));
}

uint32_t Button::onLongRelease(std::string listenerName, std::function<void(void)> func) const {
int32_t Button::onLongRelease(std::string listenerName, std::function<void(void)> func) const {
return m_on_long_release_event.addListener(std::move(listenerName) + "_user", std::move(func));
}

uint32_t Button::onRepeatPress(std::string listenerName, std::function<void(void)> func) const {
int32_t Button::onRepeatPress(std::string listenerName, std::function<void(void)> func) const {
return m_on_repeat_press_event.addListener(std::move(listenerName) + "_user", std::move(func));
}

uint32_t Button::addListener(EventType event, std::string listenerName, std::function<void(void)> func) const {
int32_t Button::addListener(EventType event, std::string listenerName, std::function<void(void)> func) const {
switch (event) {
case gamepad::EventType::ON_PRESS: return this->onPress(std::move(listenerName), std::move(func));
case gamepad::EventType::ON_LONG_PRESS: return this->onLongPress(std::move(listenerName), std::move(func));
Expand All @@ -48,7 +48,7 @@ uint32_t Button::addListener(EventType event, std::string listenerName, std::fun
}
}

uint32_t Button::removeListener(std::string listenerName) const {
int32_t Button::removeListener(std::string listenerName) const {
return m_on_press_event.removeListener(listenerName + "_user") ||
m_on_long_press_event.removeListener(listenerName + "_user") ||
m_on_release_event.removeListener(listenerName + "_user") ||
Expand Down

0 comments on commit 08e6723

Please sign in to comment.