Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GUI2/Dispatcher: encode event categories in their enum values #6621

Merged
merged 3 commits into from
Apr 10, 2022
Merged

GUI2/Dispatcher: encode event categories in their enum values #6621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
806a3e3
GUI2/Dispatcher: encode event categories in their enum values
Vultraz Apr 10, 2022
2ccabd1
nyeeeee
Vultraz Apr 10, 2022
3ae0ad0
Made event_category explicitly uint32_t
Vultraz Apr 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 9 additions & 9 deletions src/gui/core/event/dispatcher.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ bool dispatcher::has_event(const ui_event event, const event_queue_type event_ty

bool dispatcher::fire(const ui_event event, widget& target)
{
assert(is_general_event(event));
assert(is_in_category(event, event_category::general));
switch(event) {
case LEFT_BUTTON_DOUBLE_CLICK:
return fire_event_double_click<LEFT_BUTTON_CLICK, LEFT_BUTTON_DOUBLE_CLICK,
Expand All @@ -89,7 +89,7 @@ bool dispatcher::fire(const ui_event event, widget& target)

bool dispatcher::fire(const ui_event event, widget& target, const point& coordinate)
{
assert(is_mouse_event(event));
assert(is_in_category(event, event_category::mouse));
return fire_event<signal_mouse_function>(event, this, &target, coordinate);
}

Expand All @@ -99,43 +99,43 @@ bool dispatcher::fire(const ui_event event,
const SDL_Keymod modifier,
const std::string& unicode)
{
assert(is_keyboard_event(event));
assert(is_in_category(event, event_category::keyboard));
return fire_event<signal_keyboard_function>(event, this, &target, key, modifier, unicode);
}

bool dispatcher::fire(const ui_event event, widget& target, const point& pos, const point& distance)
{
assert(is_touch_motion_event(event));
assert(is_in_category(event, event_category::touch_motion));
return fire_event<signal_touch_motion_function>(event, this, &target, pos, distance);
}

bool dispatcher::fire(const ui_event event, widget& target, const point& center, float dTheta, float dDist, uint8_t numFingers)
{
assert(is_touch_gesture_event(event));
assert(is_in_category(event, event_category::touch_gesture));
return fire_event<signal_touch_gesture_function>(event, this, &target, center, dTheta, dDist, numFingers);
}

bool dispatcher::fire(const ui_event event, widget& target, const SDL_Event& sdlevent)
{
assert(is_raw_event_event(event));
assert(is_in_category(event, event_category::raw_event));
return fire_event<signal_raw_event_function>(event, this, &target, sdlevent);
}

bool dispatcher::fire(const ui_event event, widget& target, const std::string& text, int32_t start, int32_t len)
{
assert(is_text_input_event(event));
assert(is_in_category(event, event_category::text_input));
return fire_event<signal_text_input_function>(event, this, &target, text, start, len);
}

bool dispatcher::fire(const ui_event event, widget& target, void*)
{
assert(is_notification_event(event));
assert(is_in_category(event, event_category::notification));
return fire_event<signal_notification_function>(event, this, &target, nullptr);
}

bool dispatcher::fire(const ui_event event, widget& target, const message& msg)
{
assert(is_message_event(event));
assert(is_in_category(event, event_category::message));
return fire_event<signal_message_function>(event, this, &target, msg);
}

Expand Down
194 changes: 27 additions & 167 deletions src/gui/core/event/dispatcher.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,146 +35,6 @@ class widget;

namespace event
{
/**
* Helper for catching use error of @ref dispatcher::connect_signal.
*
* This helper is needed as a user can't supply the wrong kind of callback
* functions to dispatcher::connect_signal. If a wrong callback would be send
* it will never get called.
*
* This version is for callbacks without extra parameters.
* NOTE some mouse functions like MOUSE_ENTER don't send the mouse coordinates
* to the callback function so they are also in this category.
*/
constexpr bool is_general_event(const ui_event event)
{
return event == DRAW
|| event == CLOSE_WINDOW
|| event == MOUSE_ENTER
|| event == MOUSE_LEAVE
|| event == LEFT_BUTTON_DOWN
|| event == LEFT_BUTTON_UP
|| event == LEFT_BUTTON_CLICK
|| event == LEFT_BUTTON_DOUBLE_CLICK
|| event == MIDDLE_BUTTON_DOWN
|| event == MIDDLE_BUTTON_UP
|| event == MIDDLE_BUTTON_CLICK
|| event == MIDDLE_BUTTON_DOUBLE_CLICK
|| event == RIGHT_BUTTON_DOWN
|| event == RIGHT_BUTTON_UP
|| event == RIGHT_BUTTON_CLICK
|| event == RIGHT_BUTTON_DOUBLE_CLICK;
}

/**
* Helper for catching use error of @ref dispatcher::connect_signal.
*
* This version is for callbacks with a coordinate as extra parameter.
*/
constexpr bool is_mouse_event(const ui_event event)
{
return event == SDL_VIDEO_RESIZE
|| event == SDL_MOUSE_MOTION
|| event == MOUSE_MOTION
|| event == SDL_LEFT_BUTTON_DOWN
|| event == SDL_LEFT_BUTTON_UP
|| event == SDL_MIDDLE_BUTTON_DOWN
|| event == SDL_MIDDLE_BUTTON_UP
|| event == SDL_RIGHT_BUTTON_DOWN
|| event == SDL_RIGHT_BUTTON_UP
|| event == SHOW_TOOLTIP
|| event == SHOW_HELPTIP
|| event == SDL_WHEEL_UP
|| event == SDL_WHEEL_DOWN
|| event == SDL_WHEEL_LEFT
|| event == SDL_WHEEL_RIGHT
|| event == SDL_TOUCH_UP
|| event == SDL_TOUCH_DOWN;
}

/**
* Helper for catching use error of @ref dispatcher::connect_signal.
*
* This version is for callbacks with the keyboard values (these haven't been
* determined yet).
*/
constexpr bool is_keyboard_event(const ui_event event)
{
return event == SDL_KEY_DOWN;
}

/**
* Helper for catching use error of @ref dispatcher::connect_signal.
*
* This version is for callbacks of touch motion events.
*/
constexpr bool is_touch_motion_event(const ui_event event)
{
return event == SDL_TOUCH_MOTION;
}

/**
* Helper for catching use error of @ref dispatcher::connect_signal.
*
* This version is for callbacks of touch gesture events.
*/
constexpr bool is_touch_gesture_event(const ui_event event)
{
return event == SDL_TOUCH_MULTI_GESTURE;
}

/**
* Helper for catching use error of @ref dispatcher::connect_signal.
*
* This version is for callbacks with a sender aka notification messages. Like the
* ones in set_event it has no extra parameters, but this version is only
* send to the target and not using the pre and post queue.
*/
constexpr bool is_notification_event(const ui_event event)
{
return event == NOTIFY_REMOVAL
|| event == NOTIFY_MODIFIED
|| event == RECEIVE_KEYBOARD_FOCUS
|| event == LOSE_KEYBOARD_FOCUS
|| event == NOTIFY_REMOVE_TOOLTIP
|| event == SDL_ACTIVATE;
}

/**
* Helper for catching use error of @ref dispatcher::connect_signal.
*
* This version is for callbacks with a sender aka notification messages.
* Unlike the notifications this message is send through the chain. The event
* is send from a widget all the way up to the window, who always is the
* receiver of the message (unless somebody grabbed it before).
*/
constexpr bool is_message_event(const ui_event event)
{
return event == MESSAGE_SHOW_TOOLTIP
|| event == MESSAGE_SHOW_HELPTIP
|| event == REQUEST_PLACEMENT;
}

/**
* Helper for catching use error of @ref dispatcher::connect_signal.
*
* This version is for callbacks of raw events.
*/
constexpr bool is_raw_event_event(const ui_event event)
{
return event == SDL_RAW_EVENT;
}

/**
* Helper for catching use error of @ref dispatcher::connect_signal.
*
* This version is for callbacks of text input events.
*/
constexpr bool is_text_input_event(const ui_event event)
{
return event == SDL_TEXT_INPUT || event == SDL_TEXT_EDITING;
}

struct message;

/**
Expand All @@ -195,14 +55,14 @@ using dispatcher_callback_func = std::function<void(widget&, const ui_event, boo
/**
* Callback function signature.
*
* This is used for events matching @ref is_general_event.
* This is used for events in event_category::general.
*/
using signal_function = dispatcher_callback_func<>;

/**
* Callback function signature.
*
* This is used for events matching @ref is_mouse_event.
* This is used for events in event_category::mouse.
*
* Extra parameters:
* 5. The x,y coordinate of the mouse when this event is fired.
Expand All @@ -212,7 +72,7 @@ using signal_mouse_function = dispatcher_callback_func<const point&>;
/**
* Callback function signature.
*
* This is used for events matching @ref is_keyboard_event.
* This is used for events in event_category::keyboard.
*
* Extra parameters:
* 5. The keycode of the key that triggered this event.
Expand All @@ -224,7 +84,7 @@ using signal_keyboard_function = dispatcher_callback_func<const SDL_Keycode, con
/**
* Callback function signature.
*
* This is used for events matching @ref is_touch_motion_event.
* This is used for events in event_category::touch_motion.
*
* Extra parameters:
* 5. Origin of the touch event, in x,y format.
Expand All @@ -235,7 +95,7 @@ using signal_touch_motion_function = dispatcher_callback_func<const point&, cons
/**
* Callback function signature.
*
* This is used for events matching @ref is_touch_gesture_event.
* This is used for events in event_category::touch_gesture.
*
* Extra parameters: (TODO: document what these actually are)
* 5. center
Expand All @@ -248,7 +108,7 @@ using signal_touch_gesture_function = dispatcher_callback_func<const point&, flo
/**
* Callback function signature.
*
* This is used for events matching @ref is_notification_event.
* This is used for events in event_category::notification.
*
* Extra parameters:
* 5. A dummy void* parameter which will always be nullptr, used to differentiate
Expand All @@ -259,7 +119,7 @@ using signal_notification_function = dispatcher_callback_func<void*>;
/**
* Callback function signature.
*
* This is used for events matching @ref is_message_event.
* This is used for events in event_category::message.
*
* Extra parameters:
* 5. The applicable data this event requires.
Expand All @@ -269,7 +129,7 @@ using signal_message_function = dispatcher_callback_func<const message&>;
/**
* Raw event callback function signature.
*
* This is used for events matching @ref is_raw_event_event.
* This is used for events in event_category::raw_event.
*
* Extra parameters:
* 5. The raw SDL_Event.
Expand All @@ -279,7 +139,7 @@ using signal_raw_event_function = dispatcher_callback_func<const SDL_Event&>;
/**
* Callback function signature.
*
* This is used for events matching @ref is_text_input_event.
* This is used for eventsin event_category::text_input.
*
* Extra parameters:
* 5. The text entered.
Expand Down Expand Up @@ -507,23 +367,23 @@ class dispatcher
template<ui_event E, typename F>
void connect_signal(const F& func, const queue_position position = back_child)
{
if constexpr(is_general_event(E)) {
if constexpr(is_in_category(E, event_category::general)) {
VALIDATE_AND_ADD_TO_QUEUE(signal)
} else if constexpr(is_mouse_event(E)) {
} else if constexpr(is_in_category(E, event_category::mouse)) {
VALIDATE_AND_ADD_TO_QUEUE(signal_mouse)
} else if constexpr(is_keyboard_event(E)) {
} else if constexpr(is_in_category(E, event_category::keyboard)) {
VALIDATE_AND_ADD_TO_QUEUE(signal_keyboard)
} else if constexpr(is_touch_motion_event(E)) {
} else if constexpr(is_in_category(E, event_category::touch_motion)) {
VALIDATE_AND_ADD_TO_QUEUE(signal_touch_motion)
} else if constexpr(is_touch_gesture_event(E)) {
} else if constexpr(is_in_category(E, event_category::touch_gesture)) {
VALIDATE_AND_ADD_TO_QUEUE(signal_touch_gesture)
} else if constexpr(is_notification_event(E)) {
} else if constexpr(is_in_category(E, event_category::notification)) {
VALIDATE_AND_ADD_TO_QUEUE(signal_notification)
} else if constexpr(is_message_event(E)) {
} else if constexpr(is_in_category(E, event_category::message)) {
VALIDATE_AND_ADD_TO_QUEUE(signal_message)
} else if constexpr(is_raw_event_event(E)) {
} else if constexpr(is_in_category(E, event_category::raw_event)) {
VALIDATE_AND_ADD_TO_QUEUE(signal_raw_event)
} else if constexpr(is_text_input_event(E)) {
} else if constexpr(is_in_category(E, event_category::text_input)) {
VALIDATE_AND_ADD_TO_QUEUE(signal_text_input)
} else {
static_assert(utils::dependent_false_v<E>, "No matching signal queue found for event");
Expand Down Expand Up @@ -551,23 +411,23 @@ class dispatcher
template<ui_event E, typename F>
void disconnect_signal(const F& func, const queue_position position = back_child)
{
if constexpr(is_general_event(E)) {
if constexpr(is_in_category(E, event_category::general)) {
VALIDATE_AND_REMOVE_FROM_QUEUE(signal)
} else if constexpr(is_mouse_event(E)) {
} else if constexpr(is_in_category(E, event_category::mouse)) {
VALIDATE_AND_REMOVE_FROM_QUEUE(signal_mouse)
} else if constexpr(is_keyboard_event(E)) {
} else if constexpr(is_in_category(E, event_category::keyboard)) {
VALIDATE_AND_REMOVE_FROM_QUEUE(signal_keyboard)
} else if constexpr(is_touch_motion_event(E)) {
} else if constexpr(is_in_category(E, event_category::touch_motion)) {
VALIDATE_AND_REMOVE_FROM_QUEUE(signal_touch_motion)
} else if constexpr(is_touch_gesture_event(E)) {
} else if constexpr(is_in_category(E, event_category::touch_gesture)) {
VALIDATE_AND_REMOVE_FROM_QUEUE(signal_touch_gesture)
} else if constexpr(is_notification_event(E)) {
} else if constexpr(is_in_category(E, event_category::notification)) {
VALIDATE_AND_REMOVE_FROM_QUEUE(signal_notification)
} else if constexpr(is_message_event(E)) {
} else if constexpr(is_in_category(E, event_category::message)) {
VALIDATE_AND_REMOVE_FROM_QUEUE(signal_message)
} else if constexpr(is_raw_event_event(E)) {
} else if constexpr(is_in_category(E, event_category::raw_event)) {
VALIDATE_AND_REMOVE_FROM_QUEUE(signal_raw_event)
} else if constexpr(is_text_input_event(E)) {
} else if constexpr(is_in_category(E, event_category::text_input)) {
VALIDATE_AND_REMOVE_FROM_QUEUE(signal_text_input)
} else {
static_assert(utils::dependent_false_v<E>, "No matching signal queue found for event");
Expand Down
4 changes: 2 additions & 2 deletions src/gui/core/event/dispatcher_private.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ struct dispatcher_implementation
#undef FUNCTION_QUEUE_CHECK

#define RUNTIME_EVENT_SIGNAL_CHECK(TYPE) \
else if(is_##TYPE##_event(event)) { \
else if(is_in_category(event, event_category::TYPE)) { \
return queue_check(dispatcher.signal_##TYPE##_queue_); \
}

Expand All @@ -85,7 +85,7 @@ struct dispatcher_implementation
return !queue_set.queue[event].empty(queue_type);
};

if(is_general_event(event)) {
if(is_in_category(event, event_category::general)) {
return queue_check(dispatcher.signal_queue_);
}

Expand Down