Skip to content

Commit

Permalink
Keyboard event blocking corrections (#14728)
Browse files Browse the repository at this point in the history
  • Loading branch information
@sonninnos
sonninnos authored Dec 18, 2022
1 parent 4242a04 commit 883e88f
Show file tree
Hide file tree
Showing 4 changed files with 137 additions and 56 deletions.
178 changes: 129 additions & 49 deletions input/input_driver.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4035,23 +4035,24 @@ static void input_keys_pressed(
rarch_joypad_info_t *joypad_info)
{
unsigned i;
bool libretro_input_pressed = false;
input_driver_state_t *input_st = &input_driver_st;

if (!binds)
return;

if (CHECK_INPUT_DRIVER_BLOCK_HOTKEY(binds_norm, binds_auto))
{
if ( input_state_wrap(
input_st->current_driver,
input_st->current_data,
input_st->primary_joypad,
sec_joypad,
joypad_info,
&binds[port],
input_st->flags & INP_FLAG_KB_MAPPING_BLOCKED,
port, RETRO_DEVICE_JOYPAD, 0,
RARCH_ENABLE_HOTKEY))
if (input_state_wrap(
input_st->current_driver,
input_st->current_data,
input_st->primary_joypad,
sec_joypad,
joypad_info,
&binds[port],
input_st->flags & INP_FLAG_KB_MAPPING_BLOCKED,
port, RETRO_DEVICE_JOYPAD, 0,
RARCH_ENABLE_HOTKEY))
{
if (input_st->input_hotkey_block_counter < input_hotkey_block_delay)
input_st->input_hotkey_block_counter++;
Expand All @@ -4064,6 +4065,7 @@ static void input_keys_pressed(
input_st->flags |= INP_FLAG_BLOCK_HOTKEY;
}
}

if (!is_menu && binds[port][RARCH_GAME_FOCUS_TOGGLE].valid)
{
const struct retro_keybind *focus_binds_auto =
Expand All @@ -4077,24 +4079,26 @@ static void input_keys_pressed(
focus_normal, focus_binds_auto))
{
if (input_state_wrap(
input_st->current_driver,
input_st->current_data,
input_st->primary_joypad,
sec_joypad,
joypad_info,
&binds[port],
input_st->flags & INP_FLAG_KB_MAPPING_BLOCKED,
port,
RETRO_DEVICE_JOYPAD, 0, RARCH_GAME_FOCUS_TOGGLE))
input_st->current_driver,
input_st->current_data,
input_st->primary_joypad,
sec_joypad,
joypad_info,
&binds[port],
input_st->flags & INP_FLAG_KB_MAPPING_BLOCKED,
port,
RETRO_DEVICE_JOYPAD, 0, RARCH_GAME_FOCUS_TOGGLE))
input_st->flags &= ~INP_FLAG_BLOCK_HOTKEY;
}
}

{
int16_t ret = 0;

/* Check the libretro input first */
if (!(input_st->flags & INP_FLAG_BLOCK_LIBRETRO_INPUT))
/* Check libretro input if emulated device type is active,
* except device type is always active in menu. */
if ( !(input_st->flags & INP_FLAG_BLOCK_LIBRETRO_INPUT)
&& !(!is_menu && !input_config_get_device(port)))
ret = input_state_wrap(
input_st->current_driver,
input_st->current_data,
Expand All @@ -4113,12 +4117,43 @@ static void input_keys_pressed(
i, p_new_state))
{
BIT256_SET_PTR(p_new_state, i);
libretro_input_pressed = true;
}
}

/* Check joypad menu toggle button, because
* Guide button is not part of the usual buttons. */
i = RARCH_MENU_TOGGLE;
if ( !libretro_input_pressed
&& !input_st->keyboard_menu_toggle_pressed)
{
bool bit_pressed = binds[port][i].valid
&& input_state_wrap(
input_st->current_driver,
input_st->current_data,
input_st->primary_joypad,
sec_joypad,
joypad_info,
&binds[port],
input_st->flags & INP_FLAG_KB_MAPPING_BLOCKED,
port, RETRO_DEVICE_JOYPAD, 0, i);

if (
bit_pressed
|| BIT64_GET(lifecycle_state, i)
|| input_keys_pressed_other_sources(input_st,
i, p_new_state))
{
BIT256_SET_PTR(p_new_state, i);
libretro_input_pressed = true;
}
}
}

/* Check the hotkeys */
if (input_st->flags & INP_FLAG_BLOCK_HOTKEY)
/* Check hotkeys, and block keyboard and joypad hotkeys separately. */
if ( input_st->flags & INP_FLAG_BLOCK_HOTKEY
&& !( binds[0][RARCH_ENABLE_HOTKEY].key == RETROK_UNKNOWN
&& !libretro_input_pressed))
{
for (i = RARCH_FIRST_META_KEY; i < RARCH_BIND_LIST_END; i++)
{
Expand All @@ -4145,6 +4180,7 @@ static void input_keys_pressed(
&binds[port],
input_st->flags & INP_FLAG_KB_MAPPING_BLOCKED,
port, RETRO_DEVICE_JOYPAD, 0, i);

if ( bit_pressed
|| BIT64_GET(lifecycle_state, i)
|| input_keys_pressed_other_sources(input_st,
Expand Down Expand Up @@ -4211,7 +4247,7 @@ static int16_t input_state_device(
{
#ifdef HAVE_MENU
bool menu_driver_alive = menu_state_get_ptr()->flags &
MENU_ST_FLAG_ALIVE;
MENU_ST_FLAG_ALIVE;
#else
bool menu_driver_alive = false;
#endif
Expand Down Expand Up @@ -5371,11 +5407,9 @@ int16_t input_state_internal(unsigned port, unsigned device,
#ifdef HAVE_MENU
struct menu_state *menu_st = menu_state_get_ptr();
bool input_blocked = (menu_st->input_driver_flushing_input > 0) ||
(input_st->flags &
INP_FLAG_BLOCK_LIBRETRO_INPUT);
(input_st->flags & INP_FLAG_BLOCK_LIBRETRO_INPUT);
#else
bool input_blocked = (input_st->flags &
INP_FLAG_BLOCK_LIBRETRO_INPUT);
bool input_blocked = (input_st->flags & INP_FLAG_BLOCK_LIBRETRO_INPUT);
#endif
bool bitmask_enabled = false;
unsigned max_users = settings->uints.input_max_users;
Expand Down Expand Up @@ -5840,7 +5874,7 @@ void input_driver_collect_system_input(input_driver_state_t *input_st,
#ifdef HAVE_MENU
bool display_kb = menu_input_dialog_get_display_kb();
bool menu_is_alive = menu_state_get_ptr()->flags &
MENU_ST_FLAG_ALIVE;
MENU_ST_FLAG_ALIVE;
bool menu_input_active = menu_is_alive &&
!(settings->bools.menu_unified_controls && !display_kb);
#endif
Expand Down Expand Up @@ -5931,7 +5965,7 @@ void input_driver_collect_system_input(input_driver_state_t *input_st,

input_keys_pressed(port,
#ifdef HAVE_MENU
menu_input_active,
menu_is_alive,
#else
false,
#endif
Expand Down Expand Up @@ -6135,14 +6169,15 @@ void input_keyboard_event(bool down, unsigned code,
{
runloop_state_t *runloop_st = runloop_state_get_ptr();
retro_keyboard_event_t
*key_event = &runloop_st->key_event;
*key_event = &runloop_st->key_event;
input_driver_state_t
*input_st = &input_driver_st;
#ifdef HAVE_ACCESSIBILITY
access_state_t *access_st = access_state_get_ptr();
settings_t *settings = config_get_ptr();
bool accessibility_enable = settings->bools.accessibility_enable;
unsigned accessibility_narrator_speech_speed = settings->uints.accessibility_narrator_speech_speed;
unsigned accessibility_narrator_speech_speed
= settings->uints.accessibility_narrator_speech_speed;
#endif
#ifdef HAVE_MENU
struct menu_state *menu_st = menu_state_get_ptr();
Expand Down Expand Up @@ -6292,24 +6327,69 @@ void input_keyboard_event(bool down, unsigned code,
if (code == RETROK_UNKNOWN)
return;

/* Block hotkey + RetroPad mapped keyboard key events,
* but not with game focus, and from keyboard device type,
* and with 'enable_hotkey' modifier set and unpressed */
if (!input_st->game_focus_state.enabled &&
BIT512_GET(input_st->keyboard_mapping_bits, code))
/* Store keyboard menu toggle key for separating it from
* joypad menu toggle button when using 'enable_hotkey'. */
if (code == input_config_binds[0][RARCH_MENU_TOGGLE].key)
input_st->keyboard_menu_toggle_pressed = !!down;

/* Check if keyboard events should be blocked when
* pressing hotkeys and RetroPad binds, but
* - not with Game Focus
* - not from keyboard device type mappings
* - with 'enable_hotkey' modifier set and unpressed. */
if ( !input_st->game_focus_state.enabled
&& BIT512_GET(input_st->keyboard_mapping_bits, code))
{
input_mapper_t *handle = &input_st->mapper;
struct retro_keybind hotkey = input_config_binds[0][RARCH_ENABLE_HOTKEY];
bool hotkey_pressed =
(input_st->input_hotkey_block_counter > 0)
|| (hotkey.key == code);

if (!(MAPPER_GET_KEY(handle, code)) &&
!(!hotkey_pressed && (
(hotkey.key != RETROK_UNKNOWN)
|| (hotkey.joykey != NO_BTN)
|| (hotkey.joyaxis != AXIS_NONE)
)))
settings_t *settings = config_get_ptr();
unsigned max_users = settings->uints.input_max_users;
unsigned j;
bool hotkey_pressed = (input_st->input_hotkey_block_counter > 0);
bool block_key_event = false;

/* Loop enabled ports for keycode dupes. */
for (j = 0; j < max_users; j++)
{
unsigned k;
unsigned hotkey_code = input_config_binds[0][RARCH_ENABLE_HOTKEY].key;

/* Block hotkey key events based on 'enable_hotkey' modifier,
* and only when modifier is a keyboard key. */
if ( j == 0
&& !block_key_event
&& !( !hotkey_pressed
&& hotkey_code != RETROK_UNKNOWN
&& hotkey_code != code))
{
for (k = RARCH_FIRST_META_KEY; k < RARCH_BIND_LIST_END; k++)
{
if (input_config_binds[j][k].key == code)
{
block_key_event = true;
break;
}
}
}

/* RetroPad blocking needed only when emulated device type is active. */
if ( input_config_get_device(j)
&& !block_key_event)
{
for (k = 0; k < RARCH_FIRST_META_KEY; k++)
{
if (input_config_binds[j][k].key == code)
{
block_key_event = true;
break;
}
}
}
}

/* No blocking when event comes from emulated keyboard device type */
if (MAPPER_GET_KEY(&input_st->mapper, code))
block_key_event = false;

if (block_key_event)
return;
}

Expand Down
1 change: 1 addition & 0 deletions input/input_driver.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,7 @@ typedef struct

/* primitives */
bool analog_requested[MAX_USERS];
bool keyboard_menu_toggle_pressed;
retro_bits_512_t keyboard_mapping_bits; /* bool alignment */
input_game_focus_state_t game_focus_state; /* bool alignment */
} input_driver_state_t;
Expand Down
2 changes: 1 addition & 1 deletion intl/msg_hash_us.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2723,7 +2723,7 @@ MSG_HASH(
)
MSG_HASH(
MENU_ENUM_SUBLABEL_INPUT_META_ENABLE_HOTKEY,
"When assigned, the 'Hotkey Enable' key must be held before any other hotkeys are recognized. Allows controller buttons to be mapped to hotkey functions without affecting normal input."
"When assigned, the 'Hotkey Enable' key must be held before any other hotkeys are recognized. Allows controller buttons to be mapped to hotkey functions without affecting normal input. Assigning the modifier to controller only will not require it for keyboard hotkeys, but both modifiers work for both devices."
)
MSG_HASH(
MENU_ENUM_LABEL_VALUE_INPUT_HOTKEY_BLOCK_DELAY,
Expand Down
12 changes: 6 additions & 6 deletions menu/menu_driver.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5390,10 +5390,10 @@ bool menu_input_key_bind_iterate(
/* Tick main timers */
_binds->timer_timeout.current = current_time;
_binds->timer_timeout.timeout_us = _binds->timer_timeout.timeout_end -
current_time;
current_time;
_binds->timer_hold .current = current_time;
_binds->timer_hold .timeout_us = _binds->timer_hold .timeout_end -
current_time;
current_time;

if (_binds->timer_timeout.timeout_us <= 0)
{
Expand Down Expand Up @@ -5429,7 +5429,7 @@ current_time;
{
input_st->keyboard_press_cb = NULL;
input_st->keyboard_press_data = NULL;
input_st->flags &= ~INP_FLAG_KB_MAPPING_BLOCKED;
input_st->flags &= ~INP_FLAG_KB_MAPPING_BLOCKED;
}

return true;
Expand Down Expand Up @@ -5470,7 +5470,7 @@ current_time;
new_binds.timer_hold.timeout_end - current_time;

snprintf(bind->s, bind->len,
"[%s]\npress keyboard, mouse or joypad\nand hold ...",
"[%s]\nPress keyboard, mouse or joypad\nand hold ...",
input_config_bind_map_get_desc(
_binds->begin - MENU_SETTINGS_BIND_BEGIN));

Expand Down Expand Up @@ -5501,7 +5501,7 @@ current_time;
uint64_t current_usec = cpu_features_get_time_usec();
*(new_binds.output) = new_binds.buffer;

input_st->flags &= ~INP_FLAG_KB_MAPPING_BLOCKED;
input_st->flags &= ~INP_FLAG_KB_MAPPING_BLOCKED;

/* Avoid new binds triggering things right away. */
/* Inhibits input for 2 frames
Expand All @@ -5515,7 +5515,7 @@ current_time;
{
input_st->keyboard_press_cb = NULL;
input_st->keyboard_press_data = NULL;
input_st->flags &= ~INP_FLAG_KB_MAPPING_BLOCKED;
input_st->flags &= ~INP_FLAG_KB_MAPPING_BLOCKED;
return true;
}

Expand Down

0 comments on commit 883e88f

Please sign in to comment.