citra_qt/applets/swkbd: QtKeyboard and misc fixes
* Addressed comments and removed the applet interface * swkbd: address @lioncash's comments * core: more fixes ** Moved registered_swkbd to System ** Removed an usused virtual ** Removed functionality of DrawScreenKeyboard ** Removed src/core/settings.h change * swkbd: address @lioncash's 2nd review * swkbd: update logging macro * QtKeyboard: Make dialog modal and hide help
This commit is contained in:
parent
f23443b921
commit
5407ed8b5e
15 changed files with 369 additions and 255 deletions
|
@ -2,6 +2,7 @@
|
|||
// Licensed under GPLv2 or any later version
|
||||
// Refer to the license.txt file included.
|
||||
|
||||
#include <algorithm>
|
||||
#include <cstring>
|
||||
#include <string>
|
||||
#include "common/assert.h"
|
||||
|
@ -70,7 +71,7 @@ ResultCode SoftwareKeyboard::StartImpl(Service::APT::AppletStartupParameter cons
|
|||
DrawScreenKeyboard();
|
||||
|
||||
using namespace Frontend;
|
||||
frontend_applet = GetRegisteredApplet(AppletType::SoftwareKeyboard);
|
||||
frontend_applet = GetRegisteredSoftwareKeyboard();
|
||||
if (frontend_applet) {
|
||||
KeyboardConfig frontend_config = ToFrontendConfig(config);
|
||||
frontend_applet->Setup(&frontend_config);
|
||||
|
@ -82,38 +83,38 @@ ResultCode SoftwareKeyboard::StartImpl(Service::APT::AppletStartupParameter cons
|
|||
|
||||
void SoftwareKeyboard::Update() {
|
||||
using namespace Frontend;
|
||||
KeyboardData data(*static_cast<const KeyboardData*>(frontend_applet->ReceiveData()));
|
||||
KeyboardData data(*frontend_applet->ReceiveData());
|
||||
std::u16string text = Common::UTF8ToUTF16(data.text);
|
||||
memcpy(text_memory->GetPointer(), text.c_str(), text.length() * sizeof(char16_t));
|
||||
switch (config.num_buttons_m1) {
|
||||
case SoftwareKeyboardButtonConfig::SINGLE_BUTTON:
|
||||
config.return_code = SoftwareKeyboardResult::D0_CLICK;
|
||||
case SoftwareKeyboardButtonConfig::SingleButton:
|
||||
config.return_code = SoftwareKeyboardResult::D0Click;
|
||||
break;
|
||||
case SoftwareKeyboardButtonConfig::DUAL_BUTTON:
|
||||
case SoftwareKeyboardButtonConfig::DualButton:
|
||||
if (data.button == 0)
|
||||
config.return_code = SoftwareKeyboardResult::D1_CLICK0;
|
||||
config.return_code = SoftwareKeyboardResult::D1Click0;
|
||||
else
|
||||
config.return_code = SoftwareKeyboardResult::D1_CLICK1;
|
||||
config.return_code = SoftwareKeyboardResult::D1Click1;
|
||||
break;
|
||||
case SoftwareKeyboardButtonConfig::TRIPLE_BUTTON:
|
||||
case SoftwareKeyboardButtonConfig::TripleButton:
|
||||
if (data.button == 0)
|
||||
config.return_code = SoftwareKeyboardResult::D2_CLICK0;
|
||||
config.return_code = SoftwareKeyboardResult::D2Click0;
|
||||
else if (data.button == 1)
|
||||
config.return_code = SoftwareKeyboardResult::D2_CLICK1;
|
||||
config.return_code = SoftwareKeyboardResult::D2Click1;
|
||||
else
|
||||
config.return_code = SoftwareKeyboardResult::D2_CLICK2;
|
||||
config.return_code = SoftwareKeyboardResult::D2Click2;
|
||||
break;
|
||||
case SoftwareKeyboardButtonConfig::NO_BUTTON:
|
||||
case SoftwareKeyboardButtonConfig::NoButton:
|
||||
// TODO: find out what is actually returned
|
||||
config.return_code = SoftwareKeyboardResult::NONE;
|
||||
config.return_code = SoftwareKeyboardResult::None;
|
||||
break;
|
||||
default:
|
||||
NGLOG_CRITICAL(Applet_SWKBD, "Unknown button config {}",
|
||||
static_cast<int>(config.num_buttons_m1));
|
||||
LOG_CRITICAL(Applet_SWKBD, "Unknown button config {}",
|
||||
static_cast<int>(config.num_buttons_m1));
|
||||
UNREACHABLE();
|
||||
}
|
||||
|
||||
config.text_length = static_cast<u16>(text.size() + 1);
|
||||
config.text_length = static_cast<u16>(text.size());
|
||||
config.text_offset = 0;
|
||||
|
||||
// TODO(Subv): We're finalizing the applet immediately after it's started,
|
||||
|
@ -122,13 +123,7 @@ void SoftwareKeyboard::Update() {
|
|||
}
|
||||
|
||||
void SoftwareKeyboard::DrawScreenKeyboard() {
|
||||
auto bottom_screen = Service::GSP::GetFrameBufferInfo(0, 1);
|
||||
auto info = bottom_screen->framebuffer_info[bottom_screen->index];
|
||||
|
||||
// TODO(Subv): Draw the HLE keyboard, for now just zero-fill the framebuffer
|
||||
Memory::ZeroBlock(info.address_left, info.stride * 320);
|
||||
|
||||
Service::GSP::SetBufferSwap(1, info);
|
||||
// TODO(Subv): Draw the HLE keyboard, for now just do nothing
|
||||
}
|
||||
|
||||
void SoftwareKeyboard::Finalize() {
|
||||
|
@ -144,7 +139,8 @@ void SoftwareKeyboard::Finalize() {
|
|||
is_running = false;
|
||||
}
|
||||
|
||||
Frontend::KeyboardConfig SoftwareKeyboard::ToFrontendConfig(SoftwareKeyboardConfig config) {
|
||||
Frontend::KeyboardConfig SoftwareKeyboard::ToFrontendConfig(
|
||||
const SoftwareKeyboardConfig& config) const {
|
||||
using namespace Frontend;
|
||||
KeyboardConfig frontend_config;
|
||||
frontend_config.button_config = static_cast<ButtonConfig>(config.num_buttons_m1);
|
||||
|
@ -152,32 +148,33 @@ Frontend::KeyboardConfig SoftwareKeyboard::ToFrontendConfig(SoftwareKeyboardConf
|
|||
frontend_config.multiline_mode = config.multiline;
|
||||
frontend_config.max_text_length = config.max_text_length;
|
||||
frontend_config.max_digits = config.max_digits;
|
||||
std::wstring_convert<std::codecvt_utf8_utf16<char16_t>, char16_t> convert;
|
||||
frontend_config.hint_text =
|
||||
convert.to_bytes(reinterpret_cast<const char16_t*>(config.hint_text.data()));
|
||||
std::u16string buffer(config.hint_text.size(), 0);
|
||||
std::memcpy(buffer.data(), config.hint_text.data(), config.hint_text.size() * sizeof(u16));
|
||||
frontend_config.hint_text = Common::UTF16ToUTF8(buffer);
|
||||
frontend_config.has_custom_button_text =
|
||||
std::all_of(config.button_text.begin(), config.button_text.end(),
|
||||
[](std::array<u16, HLE::Applets::MAX_BUTTON_TEXT_LEN + 1> x) {
|
||||
return std::all_of(x.begin(), x.end(), [](u16 x) { return x == 0; });
|
||||
});
|
||||
!std::all_of(config.button_text.begin(), config.button_text.end(),
|
||||
[](std::array<u16, HLE::Applets::MAX_BUTTON_TEXT_LEN + 1> x) {
|
||||
return std::all_of(x.begin(), x.end(), [](u16 x) { return x == 0; });
|
||||
});
|
||||
if (frontend_config.has_custom_button_text) {
|
||||
for (const auto& text : config.button_text) {
|
||||
frontend_config.button_text.push_back(
|
||||
convert.to_bytes(reinterpret_cast<const char16_t*>(text.data())));
|
||||
buffer.resize(text.size());
|
||||
std::memcpy(buffer.data(), text.data(), text.size() * sizeof(u16));
|
||||
frontend_config.button_text.push_back(Common::UTF16ToUTF8(buffer));
|
||||
}
|
||||
}
|
||||
frontend_config.filters.prevent_digit =
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::DIGITS);
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::Digits);
|
||||
frontend_config.filters.prevent_at =
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::AT);
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::At);
|
||||
frontend_config.filters.prevent_percent =
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::PERCENT);
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::Percent);
|
||||
frontend_config.filters.prevent_backslash =
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::BACKSLASH);
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::Backslash);
|
||||
frontend_config.filters.prevent_profanity =
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::PROFANITY);
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::Profanity);
|
||||
frontend_config.filters.enable_callback =
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::CALLBACK);
|
||||
static_cast<bool>(config.filter_flags & SoftwareKeyboardFilter::Callback);
|
||||
return frontend_config;
|
||||
}
|
||||
} // namespace Applets
|
||||
|
|
|
@ -27,97 +27,97 @@ constexpr int MAX_CALLBACK_MSG_LEN = 256;
|
|||
|
||||
/// Keyboard types
|
||||
enum class SoftwareKeyboardType : 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.
|
||||
Normal, ///< 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 SoftwareKeyboardButtonConfig : 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)
|
||||
SingleButton, ///< Ok button
|
||||
DualButton, ///< Cancel | Ok buttons
|
||||
TripleButton, ///< Cancel | I Forgot | Ok buttons
|
||||
NoButton, ///< No button (returned by swkbdInputText in special cases)
|
||||
};
|
||||
|
||||
/// Accepted input types.
|
||||
enum class SoftwareKeyboardValidInput : 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
|
||||
Anything, ///< All inputs are accepted.
|
||||
NotEmpty, ///< Empty inputs are not accepted.
|
||||
NotEmptyNotBlank, ///< 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
|
||||
FixedLen, ///< The input must have a fixed length (specified by maxTextLength in
|
||||
/// swkbdInit).
|
||||
};
|
||||
|
||||
/// Keyboard password modes.
|
||||
enum class SoftwareKeyboardPasswordMode : u32 {
|
||||
NONE = 0, ///< Characters are not concealed.
|
||||
HIDE, ///< Characters are concealed immediately.
|
||||
HIDE_DELAY, ///< Characters are concealed a second after they've been typed.
|
||||
None, ///< Characters are not concealed.
|
||||
Hide, ///< Characters are concealed immediately.
|
||||
HideDelay, ///< Characters are concealed a second after they've been typed.
|
||||
};
|
||||
|
||||
/// Keyboard input filtering flags. Allows the caller to specify what input is explicitly not
|
||||
/// allowed
|
||||
namespace SoftwareKeyboardFilter {
|
||||
enum Filter {
|
||||
DIGITS = 1, ///< Disallow the use of more than a certain number of digits (0 or more)
|
||||
AT = 1 << 1, ///< Disallow the use of the @ sign.
|
||||
PERCENT = 1 << 2, ///< Disallow the use of the % sign.
|
||||
BACKSLASH = 1 << 3, ///< Disallow the use of the \ sign.
|
||||
PROFANITY = 1 << 4, ///< Disallow profanity using Nintendo's profanity filter.
|
||||
CALLBACK = 1 << 5, ///< Use a callback in order to check the input.
|
||||
Digits = 1, ///< Disallow the use of more than a certain number of digits (0 or more)
|
||||
At = 1 << 1, ///< Disallow the use of the @ sign.
|
||||
Percent = 1 << 2, ///< Disallow the use of the % sign.
|
||||
Backslash = 1 << 3, ///< Disallow the use of the \ sign.
|
||||
Profanity = 1 << 4, ///< Disallow profanity using Nintendo's profanity filter.
|
||||
Callback = 1 << 5, ///< Use a callback in order to check the input.
|
||||
};
|
||||
} // namespace SoftwareKeyboardFilter
|
||||
|
||||
/// Keyboard features.
|
||||
namespace SoftwareKeyboardFeature {
|
||||
enum Feature {
|
||||
PARENTAL = 1, ///< Parental PIN mode.
|
||||
DARKEN_TOP_SCREEN = 1 << 1, ///< Darken the top screen when the keyboard is shown.
|
||||
PREDICTIVE_INPUT =
|
||||
1 << 2, ///< Enable predictive input (necessary for Kanji input in JPN systems).
|
||||
MULTILINE = 1 << 3, ///< Enable multiline input.
|
||||
FIXED_WIDTH = 1 << 4, ///< Enable fixed-width mode.
|
||||
ALLOW_HOME = 1 << 5, ///< Allow the usage of the HOME button.
|
||||
ALLOW_RESET = 1 << 6, ///< Allow the usage of a software-reset combination.
|
||||
ALLOW_POWER = 1 << 7, ///< Allow the usage of the POWER button.
|
||||
DEFAULT_QWERTY = 1 << 9, ///< Default to the QWERTY page when the keyboard is shown.
|
||||
Parental = 1, ///< Parental PIN mode.
|
||||
DarkenTopScreen = 1 << 1, ///< Darken the top screen when the keyboard is shown.
|
||||
PredictiveInput =
|
||||
1 << 2, ///< Enable predictive input (necessary for Kanji input in JPN systems).
|
||||
Multiline = 1 << 3, ///< Enable multiline input.
|
||||
FixedWidth = 1 << 4, ///< Enable fixed-width mode.
|
||||
AllowHome = 1 << 5, ///< Allow the usage of the HOME button.
|
||||
AllowReset = 1 << 6, ///< Allow the usage of a software-reset combination.
|
||||
AllowPower = 1 << 7, ///< Allow the usage of the POWER button.
|
||||
DefaultQWERTY = 1 << 9, ///< Default to the QWERTY page when the keyboard is shown.
|
||||
};
|
||||
} // namespace SoftwareKeyboardFeature
|
||||
|
||||
/// Keyboard filter callback return values.
|
||||
enum class SoftwareKeyboardCallbackResult : 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.
|
||||
OK, ///< 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 SoftwareKeyboardResult : s32 {
|
||||
NONE = -1, ///< Dummy/unused.
|
||||
INVALID_INPUT = -2, ///< Invalid parameters to swkbd.
|
||||
OUTOFMEM = -3, ///< Out of memory.
|
||||
None = -1, ///< Dummy/unused.
|
||||
InvalidInput = -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.
|
||||
D0Click = 0, ///< The button was clicked in 1-button dialogs.
|
||||
D1Click0, ///< The left button was clicked in 2-button dialogs.
|
||||
D1Click1, ///< The right button was clicked in 2-button dialogs.
|
||||
D2Click0, ///< The left button was clicked in 3-button dialogs.
|
||||
D2Click1, ///< The middle button was clicked in 3-button dialogs.
|
||||
D2Click2, ///< 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.
|
||||
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.
|
||||
ParentalOK = 20, ///< The parental PIN was verified successfully.
|
||||
ParentalFail, ///< The parental PIN was incorrect.
|
||||
|
||||
BANNED_INPUT = 30, ///< The filter callback returned SoftwareKeyboardCallback::CLOSE.
|
||||
BannedInput = 30, ///< The filter callback returned SoftwareKeyboardCallback::CLOSE.
|
||||
};
|
||||
|
||||
struct SoftwareKeyboardConfig {
|
||||
|
@ -195,7 +195,7 @@ public:
|
|||
void Finalize();
|
||||
|
||||
private:
|
||||
Frontend::KeyboardConfig ToFrontendConfig(SoftwareKeyboardConfig config);
|
||||
Frontend::KeyboardConfig ToFrontendConfig(const SoftwareKeyboardConfig& config) const;
|
||||
|
||||
/// This SharedMemory will be created when we receive the LibAppJustStarted message.
|
||||
/// It holds the framebuffer info retrieved by the application with
|
||||
|
@ -208,7 +208,7 @@ private:
|
|||
/// Configuration of this instance of the SoftwareKeyboard, as received from the application
|
||||
SoftwareKeyboardConfig config;
|
||||
|
||||
std::shared_ptr<Frontend::AppletInterface> frontend_applet;
|
||||
std::shared_ptr<Frontend::SoftwareKeyboard> frontend_applet;
|
||||
};
|
||||
} // namespace Applets
|
||||
} // namespace HLE
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue