From a226f7414924f442576c6fb314c03396fb2dbcea Mon Sep 17 00:00:00 2001 From: citra-swkbd <32505789+citra-swkbd@users.noreply.github.com> Date: Wed, 4 Oct 2017 00:57:33 -0500 Subject: [PATCH] Implement Software Keyboard --- src/core/hle/applets/swkbd.h | 154 +++++++++++++++++++++++++++++++---- 1 file changed, 137 insertions(+), 17 deletions(-) diff --git a/src/core/hle/applets/swkbd.h b/src/core/hle/applets/swkbd.h index cc92a8f19..5c7311e09 100644 --- a/src/core/hle/applets/swkbd.h +++ b/src/core/hle/applets/swkbd.h @@ -15,33 +15,153 @@ namespace HLE { namespace Applets { +/// Maximum number of buttons that can be in the keyboard. +#define SWKBD_MAX_BUTTON 3 +/// Maximum button text length, in UTF-16 code units. +#define SWKBD_MAX_BUTTON_TEXT_LEN 16 +/// Maximum hint text length, in UTF-16 code units. +#define SWKBD_MAX_HINT_TEXT_LEN 64 +/// Maximum filter callback error message length, in UTF-16 code units. +#define SWKBD_MAX_CALLBACK_MSG_LEN 256 + +/// Keyboard types +enum class SwkbdType : u32 { + NORMAL = 0, ///< Normal keyboard with several pages (QWERTY/accents/symbol/mobile) + QWERTY, ///< QWERTY keyboard only. + NUMPAD, ///< Number pad. + WESTERN, ///< On JPN systems, a text keyboard without Japanese input capabilities, + /// otherwise same as SWKBD_TYPE_NORMAL. +}; + +/// Keyboard dialog buttons. +enum class SwkbdButtonConfig : u32 { + SINGLE_BUTTON = 0, ///< Ok button + DUAL_BUTTON, ///< Cancel | Ok buttons + TRIPLE_BUTTON, ///< Cancel | I Forgot | Ok buttons + NO_BUTTON, ///< No button (returned by swkbdInputText in special cases) +}; + +/// Accepted input types. +enum class SwkbdValidInput : u32 { + ANYTHING = 0, ///< All inputs are accepted. + NOTEMPTY, ///< Empty inputs are not accepted. + NOTEMPTY_NOTBLANK, ///< Empty or blank inputs (consisting solely of whitespace) are not + /// accepted. + NOTBLANK, ///< Blank inputs (consisting solely of whitespace) are not accepted, but empty + /// inputs are. + FIXEDLEN, ///< The input must have a fixed length (specified by maxTextLength in + /// swkbdInit). +}; + +/// Keyboard password modes. +enum class SwkbdPasswordMode : u32 { + NONE = 0, ///< Characters are not concealed. + HIDE, ///< Characters are concealed immediately. + HIDE_DELAY, ///< Characters are concealed a second after they've been typed. +}; + +/// Keyboard input filtering flags. +enum SwkbdFilter { + SWKBDFILTER_DIGITS = + 1, ///< Disallow the use of more than a certain number of digits (0 or more) + SWKBDFILTER_AT = 1 << 1, ///< Disallow the use of the @ sign. + SWKBDFILTER_PERCENT = 1 << 2, ///< Disallow the use of the % sign. + SWKBDFILTER_BACKSLASH = 1 << 3, ///< Disallow the use of the \ sign. + SWKBDFILTER_PROFANITY = 1 << 4, ///< Disallow profanity using Nintendo's profanity filter. + SWKBDFILTER_CALLBACK = 1 << 5, ///< Use a callback in order to check the input. +}; + +/// Keyboard features. +enum SwkbdFeatures { + SWKBDFEATURES_PARENTAL = 1, ///< Parental PIN mode. + SWKBDFEATURES_DARKEN_TOP_SCREEN = 1 << 1, ///< Darken the top screen when the keyboard is shown. + SWKBDFEATURES_PREDICTIVE_INPUT = + 1 << 2, ///< Enable predictive input (necessary for Kanji input in JPN systems). + SWKBDFEATURES_MULTILINE = 1 << 3, ///< Enable multiline input. + SWKBDFEATURES_FIXED_WIDTH = 1 << 4, ///< Enable fixed-width mode. + SWKBDFEATURES_ALLOW_HOME = 1 << 5, ///< Allow the usage of the HOME button. + SWKBDFEATURES_ALLOW_RESET = 1 << 6, ///< Allow the usage of a software-reset combination. + SWKBDFEATURES_ALLOW_POWER = 1 << 7, ///< Allow the usage of the POWER button. + SWKBDFEATURES_DEFAULT_QWERTY = 1 + << 9, ///< Default to the QWERTY page when the keyboard is shown. +}; + +/// Keyboard filter callback return values. +enum class SwkbdCallbackResult : u32 { + OK = 0, ///< Specifies that the input is valid. + CLOSE, ///< Displays an error message, then closes the keyboard. + CONTINUE, ///< Displays an error message and continues displaying the keyboard. +}; + +/// Keyboard return values. +enum class SwkbdResult : s32 { + NONE = -1, ///< Dummy/unused. + INVALID_INPUT = -2, ///< Invalid parameters to swkbd. + OUTOFMEM = -3, ///< Out of memory. + + D0_CLICK = 0, ///< The button was clicked in 1-button dialogs. + D1_CLICK0, ///< The left button was clicked in 2-button dialogs. + D1_CLICK1, ///< The right button was clicked in 2-button dialogs. + D2_CLICK0, ///< The left button was clicked in 3-button dialogs. + D2_CLICK1, ///< The middle button was clicked in 3-button dialogs. + D2_CLICK2, ///< The right button was clicked in 3-button dialogs. + + HOMEPRESSED = 10, ///< The HOME button was pressed. + RESETPRESSED, ///< The soft-reset key combination was pressed. + POWERPRESSED, ///< The POWER button was pressed. + + PARENTAL_OK = 20, ///< The parental PIN was verified successfully. + PARENTAL_FAIL, ///< The parental PIN was incorrect. + + BANNED_INPUT = 30, ///< The filter callback returned SWKBD_CALLBACK_CLOSE. +}; + struct SoftwareKeyboardConfig { - INSERT_PADDING_WORDS(0x8); - + SwkbdType type; + SwkbdButtonConfig num_buttons_m1; + SwkbdValidInput valid_input; + SwkbdPasswordMode password_mode; + s32 is_parental_screen; + s32 darken_top_screen; + u32 filter_flags; + u32 save_state_flags; u16 max_text_length; ///< Maximum length of the input text + u16 dict_word_count; + u16 max_digits; + u16 button_text[SWKBD_MAX_BUTTON][SWKBD_MAX_BUTTON_TEXT_LEN + 1]; + u16 numpad_keys[2]; + u16 hint_text[SWKBD_MAX_HINT_TEXT_LEN + 1]; ///< Text to display when asking the user for input + bool predictive_input; + bool multiline; + bool fixed_width; + bool allow_home; + bool allow_reset; + bool allow_power; + bool unknown; // XX: what is this supposed to do? "communicateWithOtherRegions" + bool default_qwerty; + bool button_submits_text[4]; + u16 language; // XX: not working? supposedly 0 = use system language, CFG_Language+1 = pick + // language - INSERT_PADDING_BYTES(0x6E); - - char16_t display_text[65]; ///< Text to display when asking the user for input - - INSERT_PADDING_BYTES(0xE); - - u32 default_text_offset; ///< Offset of the default text in the output SharedMemory - - INSERT_PADDING_WORDS(0x3); - + u32 initial_text_offset; ///< Offset of the default text in the output SharedMemory + u32 dict_offset; + u32 initial_status_offset; + u32 initial_learning_offset; u32 shared_memory_size; ///< Size of the SharedMemory + u32 version; - INSERT_PADDING_WORDS(0x1); + SwkbdResult return_code; - u32 return_code; ///< Return code of the SoftwareKeyboard, usually 2, other values are unknown - - INSERT_PADDING_WORDS(0x2); + u32 status_offset; + u32 learning_offset; u32 text_offset; ///< Offset in the SharedMemory where the output text starts u16 text_length; ///< Length in characters of the output text - INSERT_PADDING_BYTES(0x2B6); + int callback_result; + u16 callback_msg[SWKBD_MAX_CALLBACK_MSG_LEN + 1]; + bool skip_at_check; + INSERT_PADDING_BYTES(0xAB); }; /**