applets/swkbd: Implement the Normal and Inline Software Keyboard Applet

src/core/CMakeLists.txt

@@ -273,6 +273,7 @@ add_library(core STATIC
     hle/service/am/applets/profile_select.h
     hle/service/am/applets/software_keyboard.cpp
     hle/service/am/applets/software_keyboard.h
+    hle/service/am/applets/software_keyboard_types.h
     hle/service/am/applets/web_browser.cpp
     hle/service/am/applets/web_browser.h
     hle/service/am/applets/web_types.h

src/core/hle/service/am/applets/software_keyboard.cpp

@@ -1,7 +1,8 @@
-// Copyright 2018 yuzu emulator team
+// Copyright 2021 yuzu Emulator Project
 // Licensed under GPLv2 or any later version
 // Refer to the license.txt file included.
 
+#include "common/string_util.h"
 #include "core/core.h"
 #include "core/frontend/applets/software_keyboard.h"
 #include "core/hle/service/am/am.h"
@@ -9,20 +10,1068 @@
 
 namespace Service::AM::Applets {
 
-SoftwareKeyboard::SoftwareKeyboard(Core::System& system_,
-                                   const Core::Frontend::SoftwareKeyboardApplet& frontend_)
-    : Applet{system_.Kernel()}, frontend{frontend_}, system{system_} {}
+namespace {
+
+// The maximum number of UTF-16 characters that can be input into the swkbd text field.
+constexpr u32 DEFAULT_MAX_TEXT_LENGTH = 500;
+
+constexpr std::size_t REPLY_BASE_SIZE = sizeof(SwkbdState) + sizeof(SwkbdReplyType);
+constexpr std::size_t REPLY_UTF8_SIZE = 0x7D4;
+constexpr std::size_t REPLY_UTF16_SIZE = 0x3EC;
+
+constexpr const char* GetTextCheckResultName(SwkbdTextCheckResult text_check_result) {
+    switch (text_check_result) {
+    case SwkbdTextCheckResult::Success:
+        return "Success";
+    case SwkbdTextCheckResult::Failure:
+        return "Failure";
+    case SwkbdTextCheckResult::Confirm:
+        return "Confirm";
+    case SwkbdTextCheckResult::Silent:
+        return "Silent";
+    default:
+        UNIMPLEMENTED_MSG("Unknown TextCheckResult={}", text_check_result);
+        return "Unknown";
+    }
+}
+
+void SetReplyBase(std::vector<u8>& reply, SwkbdState state, SwkbdReplyType reply_type) {
+    std::memcpy(reply.data(), &state, sizeof(SwkbdState));
+    std::memcpy(reply.data() + sizeof(SwkbdState), &reply_type, sizeof(SwkbdReplyType));
+}
+
+} // Anonymous namespace
+
+SoftwareKeyboard::SoftwareKeyboard(Core::System& system_, LibraryAppletMode applet_mode_,
+                                   Core::Frontend::SoftwareKeyboardApplet& frontend_)
+    : Applet{system_.Kernel()}, applet_mode{applet_mode_}, frontend{frontend_}, system{system_} {}
 
 SoftwareKeyboard::~SoftwareKeyboard() = default;
 
-void SoftwareKeyboard::Initialize() {}
+void SoftwareKeyboard::Initialize() {
+    Applet::Initialize();
+
+    LOG_INFO(Service_AM, "Initializing Software Keyboard Applet with LibraryAppletMode={}",
+             applet_mode);
+
+    LOG_DEBUG(Service_AM,
+              "Initializing Applet with common_args: arg_version={}, lib_version={}, "
+              "play_startup_sound={}, size={}, system_tick={}, theme_color={}",
+              common_args.arguments_version, common_args.library_version,
+              common_args.play_startup_sound, common_args.size, common_args.system_tick,
+              common_args.theme_color);
+
+    swkbd_applet_version = SwkbdAppletVersion{common_args.library_version};
+
+    switch (applet_mode) {
+    case LibraryAppletMode::AllForeground:
+        InitializeForeground();
+        break;
+    case LibraryAppletMode::Background:
+    case LibraryAppletMode::BackgroundIndirectDisplay:
+        InitializeBackground(applet_mode);
+        break;
+    default:
+        UNREACHABLE_MSG("Invalid LibraryAppletMode={}", applet_mode);
+        break;
+    }
+}
+
+bool SoftwareKeyboard::TransactionComplete() const {
+    return complete;
+}
+
+ResultCode SoftwareKeyboard::GetStatus() const {
+    return status;
+}
+
+void SoftwareKeyboard::ExecuteInteractive() {
+    if (complete) {
+        return;
+    }
+
+    if (is_background) {
+        ProcessInlineKeyboardRequest();
+    } else {
+        ProcessTextCheck();
+    }
+}
+
+void SoftwareKeyboard::Execute() {
+    if (complete) {
+        return;
+    }
+
+    if (is_background) {
+        return;
+    }
+
+    ShowNormalKeyboard();
+}
+
+void SoftwareKeyboard::SubmitTextNormal(SwkbdResult result, std::u16string submitted_text) {
+    if (complete) {
+        return;
+    }
+
+    if (swkbd_config_common.use_text_check && result == SwkbdResult::Ok) {
+        SubmitForTextCheck(submitted_text);
+    } else {
+        SubmitNormalOutputAndExit(result, submitted_text);
+    }
+}
+
+void SoftwareKeyboard::SubmitTextInline(SwkbdReplyType reply_type, std::u16string submitted_text,
+                                        s32 cursor_position) {
+    if (complete) {
+        return;
+    }
+
+    current_text = std::move(submitted_text);
+    current_cursor_position = cursor_position;
+
+    if (inline_use_utf8) {
+        switch (reply_type) {
+        case SwkbdReplyType::ChangedString:
+            reply_type = SwkbdReplyType::ChangedStringUtf8;
+            break;
+        case SwkbdReplyType::MovedCursor:
+            reply_type = SwkbdReplyType::MovedCursorUtf8;
+            break;
+        case SwkbdReplyType::DecidedEnter:
+            reply_type = SwkbdReplyType::DecidedEnterUtf8;
+            break;
+        default:
+            break;
+        }
+    }
+
+    if (use_changed_string_v2) {
+        switch (reply_type) {
+        case SwkbdReplyType::ChangedString:
+            reply_type = SwkbdReplyType::ChangedStringV2;
+            break;
+        case SwkbdReplyType::ChangedStringUtf8:
+            reply_type = SwkbdReplyType::ChangedStringUtf8V2;
+            break;
+        default:
+            break;
+        }
+    }
+
+    if (use_moved_cursor_v2) {
+        switch (reply_type) {
+        case SwkbdReplyType::MovedCursor:
+            reply_type = SwkbdReplyType::MovedCursorV2;
+            break;
+        case SwkbdReplyType::MovedCursorUtf8:
+            reply_type = SwkbdReplyType::MovedCursorUtf8V2;
+            break;
+        default:
+            break;
+        }
+    }
+
+    SendReply(reply_type);
+}
+
+void SoftwareKeyboard::InitializeForeground() {
+    LOG_INFO(Service_AM, "Initializing Normal Software Keyboard Applet.");
+
+    is_background = false;
+
+    const auto swkbd_config_storage = broker.PopNormalDataToApplet();
+    ASSERT(swkbd_config_storage != nullptr);
+
+    const auto& swkbd_config_data = swkbd_config_storage->GetData();
+    ASSERT(swkbd_config_data.size() >= sizeof(SwkbdConfigCommon));
+
+    std::memcpy(&swkbd_config_common, swkbd_config_data.data(), sizeof(SwkbdConfigCommon));
+
+    switch (swkbd_applet_version) {
+    case SwkbdAppletVersion::Version5:
+    case SwkbdAppletVersion::Version65542:
+        ASSERT(swkbd_config_data.size() == sizeof(SwkbdConfigCommon) + sizeof(SwkbdConfigOld));
+        std::memcpy(&swkbd_config_old, swkbd_config_data.data() + sizeof(SwkbdConfigCommon),
+                    sizeof(SwkbdConfigOld));
+        break;
+    case SwkbdAppletVersion::Version196615:
+    case SwkbdAppletVersion::Version262152:
+    case SwkbdAppletVersion::Version327689:
+        ASSERT(swkbd_config_data.size() == sizeof(SwkbdConfigCommon) + sizeof(SwkbdConfigOld2));
+        std::memcpy(&swkbd_config_old2, swkbd_config_data.data() + sizeof(SwkbdConfigCommon),
+                    sizeof(SwkbdConfigOld2));
+        break;
+    case SwkbdAppletVersion::Version393227:
+    case SwkbdAppletVersion::Version524301:
+        ASSERT(swkbd_config_data.size() == sizeof(SwkbdConfigCommon) + sizeof(SwkbdConfigNew));
+        std::memcpy(&swkbd_config_new, swkbd_config_data.data() + sizeof(SwkbdConfigCommon),
+                    sizeof(SwkbdConfigNew));
+        break;
+    default:
+        UNIMPLEMENTED_MSG("Unknown SwkbdConfig revision={} with size={}", swkbd_applet_version,
+                          swkbd_config_data.size());
+        ASSERT(swkbd_config_data.size() >= sizeof(SwkbdConfigCommon) + sizeof(SwkbdConfigNew));
+        std::memcpy(&swkbd_config_new, swkbd_config_data.data() + sizeof(SwkbdConfigCommon),
+                    sizeof(SwkbdConfigNew));
+        break;
+    }
+
+    const auto work_buffer_storage = broker.PopNormalDataToApplet();
+    ASSERT(work_buffer_storage != nullptr);
+
+    if (swkbd_config_common.initial_string_length == 0) {
+        InitializeFrontendKeyboard();
+        return;
+    }
+
+    const auto& work_buffer = work_buffer_storage->GetData();
+
+    std::vector<char16_t> initial_string(swkbd_config_common.initial_string_length);
+
+    std::memcpy(initial_string.data(),
+                work_buffer.data() + swkbd_config_common.initial_string_offset,
+                swkbd_config_common.initial_string_length * sizeof(char16_t));
+
+    initial_text = Common::UTF16StringFromFixedZeroTerminatedBuffer(initial_string.data(),
+                                                                    initial_string.size());
+
+    LOG_DEBUG(Service_AM, "\nInitial Text: {}", Common::UTF16ToUTF8(initial_text));
+
+    InitializeFrontendKeyboard();
+}
+
+void SoftwareKeyboard::InitializeBackground(LibraryAppletMode applet_mode) {
+    LOG_INFO(Service_AM, "Initializing Inline Software Keyboard Applet.");
+
+    is_background = true;
+
+    const auto swkbd_inline_initialize_arg_storage = broker.PopNormalDataToApplet();
+    ASSERT(swkbd_inline_initialize_arg_storage != nullptr);
+
+    const auto& swkbd_inline_initialize_arg = swkbd_inline_initialize_arg_storage->GetData();
+    ASSERT(swkbd_inline_initialize_arg.size() == sizeof(SwkbdInitializeArg));
+
+    std::memcpy(&swkbd_initialize_arg, swkbd_inline_initialize_arg.data(),
+                swkbd_inline_initialize_arg.size());
+
+    if (swkbd_initialize_arg.library_applet_mode_flag) {
+        ASSERT(applet_mode == LibraryAppletMode::Background);
+    } else {
+        ASSERT(applet_mode == LibraryAppletMode::BackgroundIndirectDisplay);
+    }
+}
+
+void SoftwareKeyboard::ProcessTextCheck() {
+    const auto text_check_storage = broker.PopInteractiveDataToApplet();
+    ASSERT(text_check_storage != nullptr);
+
+    const auto& text_check_data = text_check_storage->GetData();
+    ASSERT(text_check_data.size() == sizeof(SwkbdTextCheck));
+
+    SwkbdTextCheck swkbd_text_check;
+
+    std::memcpy(&swkbd_text_check, text_check_data.data(), sizeof(SwkbdTextCheck));
+
+    std::u16string text_check_message = Common::UTF16StringFromFixedZeroTerminatedBuffer(
+        swkbd_text_check.text_check_message.data(), swkbd_text_check.text_check_message.size());
+
+    LOG_INFO(Service_AM, "\nTextCheckResult: {}\nTextCheckMessage: {}",
+             GetTextCheckResultName(swkbd_text_check.text_check_result),
+             Common::UTF16ToUTF8(text_check_message));
+
+    switch (swkbd_text_check.text_check_result) {
+    case SwkbdTextCheckResult::Success:
+        SubmitNormalOutputAndExit(SwkbdResult::Ok, current_text);
+        break;
+    case SwkbdTextCheckResult::Failure:
+        ShowTextCheckDialog(SwkbdTextCheckResult::Failure, text_check_message);
+        break;
+    case SwkbdTextCheckResult::Confirm:
+        ShowTextCheckDialog(SwkbdTextCheckResult::Confirm, text_check_message);
+        break;
+    case SwkbdTextCheckResult::Silent:
+    default:
+        break;
+    }
+}
+
+void SoftwareKeyboard::ProcessInlineKeyboardRequest() {
+    const auto request_data_storage = broker.PopInteractiveDataToApplet();
+    ASSERT(request_data_storage != nullptr);
+
+    const auto& request_data = request_data_storage->GetData();
+    ASSERT(request_data.size() >= sizeof(SwkbdRequestCommand));
+
+    SwkbdRequestCommand request_command;
+
+    std::memcpy(&request_command, request_data.data(), sizeof(SwkbdRequestCommand));
+
+    switch (request_command) {
+    case SwkbdRequestCommand::Finalize:
+        RequestFinalize(request_data);
+        break;
+    case SwkbdRequestCommand::SetUserWordInfo:
+        RequestSetUserWordInfo(request_data);
+        break;
+    case SwkbdRequestCommand::SetCustomizeDic:
+        RequestSetCustomizeDic(request_data);
+        break;
+    case SwkbdRequestCommand::Calc:
+        RequestCalc(request_data);
+        break;
+    case SwkbdRequestCommand::SetCustomizedDictionaries:
+        RequestSetCustomizedDictionaries(request_data);
+        break;
+    case SwkbdRequestCommand::UnsetCustomizedDictionaries:
+        RequestUnsetCustomizedDictionaries(request_data);
+        break;
+    case SwkbdRequestCommand::SetChangedStringV2Flag:
+        RequestSetChangedStringV2Flag(request_data);
+        break;
+    case SwkbdRequestCommand::SetMovedCursorV2Flag:
+        RequestSetMovedCursorV2Flag(request_data);
+        break;
+    default:
+        UNIMPLEMENTED_MSG("Unknown SwkbdRequestCommand={}", request_command);
+        break;
+    }
+}
+
+void SoftwareKeyboard::SubmitNormalOutputAndExit(SwkbdResult result,
+                                                 std::u16string submitted_text) {
+    std::vector<u8> out_data(sizeof(SwkbdResult) + STRING_BUFFER_SIZE);
+
+    if (swkbd_config_common.use_utf8) {
+        std::string utf8_submitted_text = Common::UTF16ToUTF8(submitted_text);
+
+        LOG_DEBUG(Service_AM, "\nSwkbdResult: {}\nUTF-8 Submitted Text: {}", result,
+                  utf8_submitted_text);
+
+        std::memcpy(out_data.data(), &result, sizeof(SwkbdResult));
+        std::memcpy(out_data.data() + sizeof(SwkbdResult), utf8_submitted_text.data(),
+                    utf8_submitted_text.size());
+    } else {
+        LOG_DEBUG(Service_AM, "\nSwkbdResult: {}\nUTF-16 Submitted Text: {}", result,
+                  Common::UTF16ToUTF8(submitted_text));
+
+        std::memcpy(out_data.data(), &result, sizeof(SwkbdResult));
+        std::memcpy(out_data.data() + sizeof(SwkbdResult), submitted_text.data(),
+                    submitted_text.size() * sizeof(char16_t));
+    }
+
+    broker.PushNormalDataFromApplet(std::make_shared<IStorage>(system, std::move(out_data)));
+
+    ExitKeyboard();
+}
+
+void SoftwareKeyboard::SubmitForTextCheck(std::u16string submitted_text) {
+    current_text = std::move(submitted_text);
+
+    std::vector<u8> out_data(sizeof(u64) + STRING_BUFFER_SIZE);
+
+    if (swkbd_config_common.use_utf8) {
+        std::string utf8_submitted_text = Common::UTF16ToUTF8(current_text);
+        const u64 buffer_size = sizeof(u64) + utf8_submitted_text.size();
+
+        LOG_DEBUG(Service_AM, "\nBuffer Size: {}\nUTF-8 Submitted Text: {}", buffer_size,
+                  utf8_submitted_text);
+
+        std::memcpy(out_data.data(), &buffer_size, sizeof(u64));
+        std::memcpy(out_data.data() + sizeof(u64), utf8_submitted_text.data(),
+                    utf8_submitted_text.size());
+    } else {
+        const u64 buffer_size = sizeof(u64) + current_text.size() * sizeof(char16_t);
+
+        LOG_DEBUG(Service_AM, "\nBuffer Size: {}\nUTF-16 Submitted Text: {}", buffer_size,
+                  Common::UTF16ToUTF8(current_text));
+
+        std::memcpy(out_data.data(), &buffer_size, sizeof(u64));
+        std::memcpy(out_data.data() + sizeof(u64), current_text.data(),
+                    current_text.size() * sizeof(char16_t));
+    }
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(out_data)));
+}
+
+void SoftwareKeyboard::SendReply(SwkbdReplyType reply_type) {
+    switch (reply_type) {
+    case SwkbdReplyType::FinishedInitialize:
+        ReplyFinishedInitialize();
+        break;
+    case SwkbdReplyType::Default:
+        ReplyDefault();
+        break;
+    case SwkbdReplyType::ChangedString:
+        ReplyChangedString();
+        break;
+    case SwkbdReplyType::MovedCursor:
+        ReplyMovedCursor();
+        break;
+    case SwkbdReplyType::MovedTab:
+        ReplyMovedTab();
+        break;
+    case SwkbdReplyType::DecidedEnter:
+        ReplyDecidedEnter();
+        break;
+    case SwkbdReplyType::DecidedCancel:
+        ReplyDecidedCancel();
+        break;
+    case SwkbdReplyType::ChangedStringUtf8:
+        ReplyChangedStringUtf8();
+        break;
+    case SwkbdReplyType::MovedCursorUtf8:
+        ReplyMovedCursorUtf8();
+        break;
+    case SwkbdReplyType::DecidedEnterUtf8:
+        ReplyDecidedEnterUtf8();
+        break;
+    case SwkbdReplyType::UnsetCustomizeDic:
+        ReplyUnsetCustomizeDic();
+        break;
+    case SwkbdReplyType::ReleasedUserWordInfo:
+        ReplyReleasedUserWordInfo();
+        break;
+    case SwkbdReplyType::UnsetCustomizedDictionaries:
+        ReplyUnsetCustomizedDictionaries();
+        break;
+    case SwkbdReplyType::ChangedStringV2:
+        ReplyChangedStringV2();
+        break;
+    case SwkbdReplyType::MovedCursorV2:
+        ReplyMovedCursorV2();
+        break;
+    case SwkbdReplyType::ChangedStringUtf8V2:
+        ReplyChangedStringUtf8V2();
+        break;
+    case SwkbdReplyType::MovedCursorUtf8V2:
+        ReplyMovedCursorUtf8V2();
+        break;
+    default:
+        UNIMPLEMENTED_MSG("Unknown SwkbdReplyType={}", reply_type);
+        ReplyDefault();
+        break;
+    }
+}
+
+void SoftwareKeyboard::ChangeState(SwkbdState state) {
+    swkbd_state = state;
+
+    ReplyDefault();
+}
+
+void SoftwareKeyboard::InitializeFrontendKeyboard() {
+    if (is_background) {
+        const auto& appear_arg = swkbd_calc_arg.appear_arg;
+
+        std::u16string ok_text = Common::UTF16StringFromFixedZeroTerminatedBuffer(
+            appear_arg.ok_text.data(), appear_arg.ok_text.size());
+
+        const u32 max_text_length =
+            appear_arg.max_text_length > 0 && appear_arg.max_text_length <= DEFAULT_MAX_TEXT_LENGTH
+                ? appear_arg.max_text_length
+                : DEFAULT_MAX_TEXT_LENGTH;
+
+        const u32 min_text_length =
+            appear_arg.min_text_length <= max_text_length ? appear_arg.min_text_length : 0;
+
+        const s32 initial_cursor_position =
+            current_cursor_position > 0 ? current_cursor_position : 0;
+
+        const auto text_draw_type =
+            max_text_length <= 32 ? SwkbdTextDrawType::Line : SwkbdTextDrawType::Box;
+
+        Core::Frontend::KeyboardInitializeParameters initialize_parameters{
+            .ok_text{ok_text},
+            .header_text{},
+            .sub_text{},
+            .guide_text{},
+            .initial_text{current_text},
+            .max_text_length{max_text_length},
+            .min_text_length{min_text_length},
+            .initial_cursor_position{initial_cursor_position},
+            .type{appear_arg.type},
+            .password_mode{SwkbdPasswordMode::Disabled},
+            .text_draw_type{text_draw_type},
+            .key_disable_flags{appear_arg.key_disable_flags},
+            .use_blur_background{false},
+            .enable_backspace_button{swkbd_calc_arg.enable_backspace_button},
+            .enable_return_button{appear_arg.enable_return_button},
+            .disable_cancel_button{appear_arg.disable_cancel_button},
+        };
+
+        frontend.InitializeKeyboard(
+            true, std::move(initialize_parameters), {},
+            [this](SwkbdReplyType reply_type, std::u16string submitted_text, s32 cursor_position) {
+                SubmitTextInline(reply_type, submitted_text, cursor_position);
+            });
+    } else {
+        std::u16string ok_text = Common::UTF16StringFromFixedZeroTerminatedBuffer(
+            swkbd_config_common.ok_text.data(), swkbd_config_common.ok_text.size());
+
+        std::u16string header_text = Common::UTF16StringFromFixedZeroTerminatedBuffer(
+            swkbd_config_common.header_text.data(), swkbd_config_common.header_text.size());
+
+        std::u16string sub_text = Common::UTF16StringFromFixedZeroTerminatedBuffer(
+            swkbd_config_common.sub_text.data(), swkbd_config_common.sub_text.size());
+
+        std::u16string guide_text = Common::UTF16StringFromFixedZeroTerminatedBuffer(
+            swkbd_config_common.guide_text.data(), swkbd_config_common.guide_text.size());
+
+        const u32 max_text_length =
+            swkbd_config_common.max_text_length > 0 &&
+                    swkbd_config_common.max_text_length <= DEFAULT_MAX_TEXT_LENGTH
+                ? swkbd_config_common.max_text_length
+                : DEFAULT_MAX_TEXT_LENGTH;
+
+        const u32 min_text_length = swkbd_config_common.min_text_length <= max_text_length
+                                        ? swkbd_config_common.min_text_length
+                                        : 0;
+
+        const s32 initial_cursor_position = [this] {
+            switch (swkbd_config_common.initial_cursor_position) {
+            case SwkbdInitialCursorPosition::Start:
+            default:
+                return 0;
+            case SwkbdInitialCursorPosition::End:
+                return static_cast<s32>(initial_text.size());
+            }
+        }();
+
+        const auto text_draw_type = [this, max_text_length] {
+            switch (swkbd_config_common.text_draw_type) {
+            case SwkbdTextDrawType::Line:
+            default:
+                return max_text_length <= 32 ? SwkbdTextDrawType::Line : SwkbdTextDrawType::Box;
+            case SwkbdTextDrawType::Box:
+            case SwkbdTextDrawType::DownloadCode:
+                return swkbd_config_common.text_draw_type;
+            }
+        }();
+
+        const auto enable_return_button = text_draw_type == SwkbdTextDrawType::Box
+                                              ? swkbd_config_common.enable_return_button
+                                              : false;
+
+        const auto disable_cancel_button = swkbd_applet_version >= SwkbdAppletVersion::Version393227
+                                               ? swkbd_config_new.disable_cancel_button
+                                               : false;
+
+        Core::Frontend::KeyboardInitializeParameters initialize_parameters{
+            .ok_text{ok_text},
+            .header_text{header_text},
+            .sub_text{sub_text},
+            .guide_text{guide_text},
+            .initial_text{initial_text},
+            .max_text_length{max_text_length},
+            .min_text_length{min_text_length},
+            .initial_cursor_position{initial_cursor_position},
+            .type{swkbd_config_common.type},
+            .password_mode{swkbd_config_common.password_mode},
+            .text_draw_type{text_draw_type},
+            .key_disable_flags{swkbd_config_common.key_disable_flags},
+            .use_blur_background{swkbd_config_common.use_blur_background},
+            .enable_backspace_button{true},
+            .enable_return_button{enable_return_button},
+            .disable_cancel_button{disable_cancel_button},
+        };
+
+        frontend.InitializeKeyboard(false, std::move(initialize_parameters),
+                                    [this](SwkbdResult result, std::u16string submitted_text) {
+                                        SubmitTextNormal(result, submitted_text);
+                                    },
+                                    {});
+    }
+}
+
+void SoftwareKeyboard::ShowNormalKeyboard() {
+    frontend.ShowNormalKeyboard();
+}
+
+void SoftwareKeyboard::ShowTextCheckDialog(SwkbdTextCheckResult text_check_result,
+                                           std::u16string text_check_message) {
+    frontend.ShowTextCheckDialog(text_check_result, text_check_message);
+}
+
+void SoftwareKeyboard::ShowInlineKeyboard() {
+    if (swkbd_state != SwkbdState::InitializedIsHidden) {
+        return;
+    }
+
+    ChangeState(SwkbdState::InitializedIsAppearing);
+
+    const auto& appear_arg = swkbd_calc_arg.appear_arg;
+
+    const u32 max_text_length =
+        appear_arg.max_text_length > 0 && appear_arg.max_text_length <= DEFAULT_MAX_TEXT_LENGTH
+            ? appear_arg.max_text_length
+            : DEFAULT_MAX_TEXT_LENGTH;
+
+    const u32 min_text_length =
+        appear_arg.min_text_length <= max_text_length ? appear_arg.min_text_length : 0;
+
+    Core::Frontend::InlineAppearParameters appear_parameters{
+        .max_text_length{max_text_length},
+        .min_text_length{min_text_length},
+        .key_top_scale_x{swkbd_calc_arg.key_top_scale_x},
+        .key_top_scale_y{swkbd_calc_arg.key_top_scale_y},
+        .key_top_translate_x{swkbd_calc_arg.key_top_translate_x},
+        .key_top_translate_y{swkbd_calc_arg.key_top_translate_y},
+        .type{appear_arg.type},
+        .key_disable_flags{appear_arg.key_disable_flags},
+        .key_top_as_floating{swkbd_calc_arg.key_top_as_floating},
+        .enable_backspace_button{swkbd_calc_arg.enable_backspace_button},
+        .enable_return_button{appear_arg.enable_return_button},
+        .disable_cancel_button{appear_arg.disable_cancel_button},
+    };
+
+    frontend.ShowInlineKeyboard(std::move(appear_parameters));
+
+    ChangeState(SwkbdState::InitializedIsShown);
+}
+
+void SoftwareKeyboard::HideInlineKeyboard() {
+    if (swkbd_state != SwkbdState::InitializedIsShown) {
+        return;
+    }
+
+    ChangeState(SwkbdState::InitializedIsDisappearing);
+
+    frontend.HideInlineKeyboard();
+
+    ChangeState(SwkbdState::InitializedIsHidden);
+}
+
+void SoftwareKeyboard::InlineTextChanged() {
+    Core::Frontend::InlineTextParameters text_parameters{
+        .input_text{current_text},
+        .cursor_position{current_cursor_position},
+    };
+
+    frontend.InlineTextChanged(std::move(text_parameters));
+}
+
+void SoftwareKeyboard::ExitKeyboard() {
+    complete = true;
+    status = RESULT_SUCCESS;
+
+    frontend.ExitKeyboard();
+
+    broker.SignalStateChanged();
+}
+
+// Inline Software Keyboard Requests
+
+void SoftwareKeyboard::RequestFinalize(const std::vector<u8>& request_data) {
+    LOG_DEBUG(Service_AM, "Processing Request: Finalize");
+
+    ChangeState(SwkbdState::NotInitialized);
+
+    ExitKeyboard();
+}
+
+void SoftwareKeyboard::RequestSetUserWordInfo(const std::vector<u8>& request_data) {
+    LOG_WARNING(Service_AM, "SetUserWordInfo is not implemented.");
+}
+
+void SoftwareKeyboard::RequestSetCustomizeDic(const std::vector<u8>& request_data) {
+    LOG_WARNING(Service_AM, "SetCustomizeDic is not implemented.");
+}
+
+void SoftwareKeyboard::RequestCalc(const std::vector<u8>& request_data) {
+    LOG_DEBUG(Service_AM, "Processing Request: Calc");
+
+    ASSERT(request_data.size() == sizeof(SwkbdRequestCommand) + sizeof(SwkbdCalcArg));
+
+    std::memcpy(&swkbd_calc_arg, request_data.data() + sizeof(SwkbdRequestCommand),
+                sizeof(SwkbdCalcArg));
+
+    if (swkbd_calc_arg.flags.set_input_text) {
+        current_text = Common::UTF16StringFromFixedZeroTerminatedBuffer(
+            swkbd_calc_arg.input_text.data(), swkbd_calc_arg.input_text.size());
+    }
+
+    if (swkbd_calc_arg.flags.set_cursor_position) {
+        current_cursor_position = swkbd_calc_arg.cursor_position;
+    }
+
+    if (swkbd_calc_arg.flags.set_utf8_mode) {
+        inline_use_utf8 = swkbd_calc_arg.utf8_mode;
+    }
+
+    if (swkbd_state <= SwkbdState::InitializedIsHidden &&
+        swkbd_calc_arg.flags.unset_customize_dic) {
+        ReplyUnsetCustomizeDic();
+    }
+
+    if (swkbd_state <= SwkbdState::InitializedIsHidden &&
+        swkbd_calc_arg.flags.unset_user_word_info) {
+        ReplyReleasedUserWordInfo();
+    }
+
+    if (swkbd_state == SwkbdState::NotInitialized && swkbd_calc_arg.flags.set_initialize_arg) {
+        InitializeFrontendKeyboard();
+
+        ChangeState(SwkbdState::InitializedIsHidden);
+
+        ReplyFinishedInitialize();
+    }
+
+    if (!swkbd_calc_arg.flags.set_initialize_arg &&
+        (swkbd_calc_arg.flags.set_input_text || swkbd_calc_arg.flags.set_cursor_position)) {
+        InlineTextChanged();
+    }
+
+    if (swkbd_state == SwkbdState::InitializedIsHidden && swkbd_calc_arg.flags.appear) {
+        ShowInlineKeyboard();
+        return;
+    }
+
+    if (swkbd_state == SwkbdState::InitializedIsShown && swkbd_calc_arg.flags.disappear) {
+        HideInlineKeyboard();
+        return;
+    }
+}
+
+void SoftwareKeyboard::RequestSetCustomizedDictionaries(const std::vector<u8>& request_data) {
+    LOG_WARNING(Service_AM, "SetCustomizedDictionaries is not implemented.");
+}
+
+void SoftwareKeyboard::RequestUnsetCustomizedDictionaries(const std::vector<u8>& request_data) {
+    LOG_WARNING(Service_AM, "(STUBBED) Processing Request: UnsetCustomizedDictionaries");
+
+    ReplyUnsetCustomizedDictionaries();
+}
+
+void SoftwareKeyboard::RequestSetChangedStringV2Flag(const std::vector<u8>& request_data) {
+    LOG_DEBUG(Service_AM, "Processing Request: SetChangedStringV2Flag");
+
+    ASSERT(request_data.size() == sizeof(SwkbdRequestCommand) + 1);
+
+    std::memcpy(&use_changed_string_v2, request_data.data() + sizeof(SwkbdRequestCommand), 1);
+}
+
+void SoftwareKeyboard::RequestSetMovedCursorV2Flag(const std::vector<u8>& request_data) {
+    LOG_DEBUG(Service_AM, "Processing Request: SetMovedCursorV2Flag");
+
+    ASSERT(request_data.size() == sizeof(SwkbdRequestCommand) + 1);
+
+    std::memcpy(&use_moved_cursor_v2, request_data.data() + sizeof(SwkbdRequestCommand), 1);
+}
+
+// Inline Software Keyboard Replies
+
+void SoftwareKeyboard::ReplyFinishedInitialize() {
+    LOG_DEBUG(Service_AM, "Sending Reply: FinishedInitialize");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + 1);
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::FinishedInitialize);
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyDefault() {
+    LOG_DEBUG(Service_AM, "Sending Reply: Default");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE);
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::Default);
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyChangedString() {
+    LOG_DEBUG(Service_AM, "Sending Reply: ChangedString");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF16_SIZE + sizeof(SwkbdChangedStringArg));
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::ChangedString);
+
+    const SwkbdChangedStringArg changed_string_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+        .dictionary_start_cursor_position{-1},
+        .dictionary_end_cursor_position{-1},
+        .cursor_position{current_cursor_position},
+    };
+
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, current_text.data(),
+                current_text.size() * sizeof(char16_t));
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF16_SIZE, &changed_string_arg,
+                sizeof(SwkbdChangedStringArg));
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyMovedCursor() {
+    LOG_DEBUG(Service_AM, "Sending Reply: MovedCursor");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF16_SIZE + sizeof(SwkbdMovedCursorArg));
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::MovedCursor);
+
+    const SwkbdMovedCursorArg moved_cursor_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+        .cursor_position{current_cursor_position},
+    };
+
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, current_text.data(),
+                current_text.size() * sizeof(char16_t));
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF16_SIZE, &moved_cursor_arg,
+                sizeof(SwkbdMovedCursorArg));
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyMovedTab() {
+    LOG_DEBUG(Service_AM, "Sending Reply: MovedTab");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF16_SIZE + sizeof(SwkbdMovedTabArg));
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::MovedTab);
+
+    const SwkbdMovedTabArg moved_tab_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+        .cursor_position{current_cursor_position},
+    };
+
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, current_text.data(),
+                current_text.size() * sizeof(char16_t));
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF16_SIZE, &moved_tab_arg,
+                sizeof(SwkbdMovedTabArg));
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyDecidedEnter() {
+    LOG_DEBUG(Service_AM, "Sending Reply: DecidedEnter");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF16_SIZE + sizeof(SwkbdDecidedEnterArg));
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::DecidedEnter);
+
+    const SwkbdDecidedEnterArg decided_enter_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+    };
+
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, current_text.data(),
+                current_text.size() * sizeof(char16_t));
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF16_SIZE, &decided_enter_arg,
+                sizeof(SwkbdDecidedEnterArg));
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+
+    HideInlineKeyboard();
+}
+
+void SoftwareKeyboard::ReplyDecidedCancel() {
+    LOG_DEBUG(Service_AM, "Sending Reply: DecidedCancel");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE);
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::DecidedCancel);
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+
+    HideInlineKeyboard();
+}
+
+void SoftwareKeyboard::ReplyChangedStringUtf8() {
+    LOG_DEBUG(Service_AM, "Sending Reply: ChangedStringUtf8");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF8_SIZE + sizeof(SwkbdChangedStringArg));
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::ChangedStringUtf8);
+
+    std::string utf8_current_text = Common::UTF16ToUTF8(current_text);
+
+    const SwkbdChangedStringArg changed_string_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+        .dictionary_start_cursor_position{-1},
+        .dictionary_end_cursor_position{-1},
+        .cursor_position{current_cursor_position},
+    };
+
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, utf8_current_text.data(), utf8_current_text.size());
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF8_SIZE, &changed_string_arg,
+                sizeof(SwkbdChangedStringArg));
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyMovedCursorUtf8() {
+    LOG_DEBUG(Service_AM, "Sending Reply: MovedCursorUtf8");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF8_SIZE + sizeof(SwkbdMovedCursorArg));
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::MovedCursorUtf8);
+
+    std::string utf8_current_text = Common::UTF16ToUTF8(current_text);
+
+    const SwkbdMovedCursorArg moved_cursor_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+        .cursor_position{current_cursor_position},
+    };
+
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, utf8_current_text.data(), utf8_current_text.size());
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF8_SIZE, &moved_cursor_arg,
+                sizeof(SwkbdMovedCursorArg));
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyDecidedEnterUtf8() {
+    LOG_DEBUG(Service_AM, "Sending Reply: DecidedEnterUtf8");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF8_SIZE + sizeof(SwkbdDecidedEnterArg));
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::DecidedEnterUtf8);
+
+    std::string utf8_current_text = Common::UTF16ToUTF8(current_text);
+
+    const SwkbdDecidedEnterArg decided_enter_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+    };
+
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, utf8_current_text.data(), utf8_current_text.size());
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF8_SIZE, &decided_enter_arg,
+                sizeof(SwkbdDecidedEnterArg));
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+
+    HideInlineKeyboard();
+}
+
+void SoftwareKeyboard::ReplyUnsetCustomizeDic() {
+    LOG_DEBUG(Service_AM, "Sending Reply: UnsetCustomizeDic");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE);
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::UnsetCustomizeDic);
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyReleasedUserWordInfo() {
+    LOG_DEBUG(Service_AM, "Sending Reply: ReleasedUserWordInfo");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE);
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::ReleasedUserWordInfo);
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyUnsetCustomizedDictionaries() {
+    LOG_DEBUG(Service_AM, "Sending Reply: UnsetCustomizedDictionaries");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE);
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::UnsetCustomizedDictionaries);
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyChangedStringV2() {
+    LOG_DEBUG(Service_AM, "Sending Reply: ChangedStringV2");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF16_SIZE + sizeof(SwkbdChangedStringArg) + 1);
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::ChangedStringV2);
+
+    const SwkbdChangedStringArg changed_string_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+        .dictionary_start_cursor_position{-1},
+        .dictionary_end_cursor_position{-1},
+        .cursor_position{current_cursor_position},
+    };
+
+    constexpr u8 flag = 0;
+
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, current_text.data(),
+                current_text.size() * sizeof(char16_t));
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF16_SIZE, &changed_string_arg,
+                sizeof(SwkbdChangedStringArg));
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF16_SIZE + sizeof(SwkbdChangedStringArg),
+                &flag, 1);
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyMovedCursorV2() {
+    LOG_DEBUG(Service_AM, "Sending Reply: MovedCursorV2");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF16_SIZE + sizeof(SwkbdMovedCursorArg) + 1);
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::MovedCursorV2);
+
+    const SwkbdMovedCursorArg moved_cursor_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+        .cursor_position{current_cursor_position},
+    };
+
+    constexpr u8 flag = 0;
+
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, current_text.data(),
+                current_text.size() * sizeof(char16_t));
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF16_SIZE, &moved_cursor_arg,
+                sizeof(SwkbdMovedCursorArg));
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF16_SIZE + sizeof(SwkbdMovedCursorArg),
+                &flag, 1);
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyChangedStringUtf8V2() {
+    LOG_DEBUG(Service_AM, "Sending Reply: ChangedStringUtf8V2");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF8_SIZE + sizeof(SwkbdChangedStringArg) + 1);
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::ChangedStringUtf8V2);
+
+    std::string utf8_current_text = Common::UTF16ToUTF8(current_text);
+
+    const SwkbdChangedStringArg changed_string_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+        .dictionary_start_cursor_position{-1},
+        .dictionary_end_cursor_position{-1},
+        .cursor_position{current_cursor_position},
+    };
+
+    constexpr u8 flag = 0;
+
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, utf8_current_text.data(), utf8_current_text.size());
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF8_SIZE, &changed_string_arg,
+                sizeof(SwkbdChangedStringArg));
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF8_SIZE + sizeof(SwkbdChangedStringArg),
+                &flag, 1);
+
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
+
+void SoftwareKeyboard::ReplyMovedCursorUtf8V2() {
+    LOG_DEBUG(Service_AM, "Sending Reply: MovedCursorUtf8V2");
+
+    std::vector<u8> reply(REPLY_BASE_SIZE + REPLY_UTF8_SIZE + sizeof(SwkbdMovedCursorArg) + 1);
+
+    SetReplyBase(reply, swkbd_state, SwkbdReplyType::MovedCursorUtf8V2);
+
+    std::string utf8_current_text = Common::UTF16ToUTF8(current_text);
 
-bool SoftwareKeyboard::TransactionComplete() const {}
+    const SwkbdMovedCursorArg moved_cursor_arg{
+        .text_length{static_cast<u32>(current_text.size())},
+        .cursor_position{current_cursor_position},
+    };
 
-ResultCode SoftwareKeyboard::GetStatus() const {}
+    constexpr u8 flag = 0;
 
-void SoftwareKeyboard::ExecuteInteractive() {}
+    std::memcpy(reply.data() + REPLY_BASE_SIZE, utf8_current_text.data(), utf8_current_text.size());
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF8_SIZE, &moved_cursor_arg,
+                sizeof(SwkbdMovedCursorArg));
+    std::memcpy(reply.data() + REPLY_BASE_SIZE + REPLY_UTF8_SIZE + sizeof(SwkbdMovedCursorArg),
+                &flag, 1);
 
-void SoftwareKeyboard::Execute() {}
+    broker.PushInteractiveDataFromApplet(std::make_shared<IStorage>(system, std::move(reply)));
+}
 
 } // namespace Service::AM::Applets

src/core/hle/service/am/applets/software_keyboard.h

@@ -1,4 +1,4 @@
-// Copyright 2018 yuzu emulator team
+// Copyright 2021 yuzu Emulator Project
 // Licensed under GPLv2 or any later version
 // Refer to the license.txt file included.
 
@@ -8,6 +8,7 @@
 #include "common/common_types.h"
 #include "core/hle/result.h"
 #include "core/hle/service/am/applets/applets.h"
+#include "core/hle/service/am/applets/software_keyboard_types.h"
 
 namespace Core {
 class System;
@@ -17,8 +18,8 @@ namespace Service::AM::Applets {
 
 class SoftwareKeyboard final : public Applet {
 public:
-    explicit SoftwareKeyboard(Core::System& system_,
-                              const Core::Frontend::SoftwareKeyboardApplet& frontend_);
+    explicit SoftwareKeyboard(Core::System& system_, LibraryAppletMode applet_mode_,
+                              Core::Frontend::SoftwareKeyboardApplet& frontend_);
     ~SoftwareKeyboard() override;
 
     void Initialize() override;
@@ -28,10 +29,139 @@ public:
     void ExecuteInteractive() override;
     void Execute() override;
 
+    /**
+     * Submits the input text to the application.
+     * If text checking is enabled, the application will verify the input text.
+     * If use_utf8 is enabled, the input text will be converted to UTF-8 prior to being submitted.
+     * This should only be used by the normal software keyboard.
+     *
+     * @param result SwkbdResult enum
+     * @param submitted_text UTF-16 encoded string
+     */
+    void SubmitTextNormal(SwkbdResult result, std::u16string submitted_text);
+
+    /**
+     * Submits the input text to the application.
+     * If utf8_mode is enabled, the input text will be converted to UTF-8 prior to being submitted.
+     * This should only be used by the inline software keyboard.
+     *
+     * @param reply_type SwkbdReplyType enum
+     * @param submitted_text UTF-16 encoded string
+     * @param cursor_position The current position of the text cursor
+     */
+    void SubmitTextInline(SwkbdReplyType reply_type, std::u16string submitted_text,
+                          s32 cursor_position);
+
 private:
-    const Core::Frontend::SoftwareKeyboardApplet& frontend;
+    /// Initializes the normal software keyboard.
+    void InitializeForeground();
+
+    /// Initializes the inline software keyboard.
+    void InitializeBackground(LibraryAppletMode applet_mode);
+
+    /// Processes the text check sent by the application.
+    void ProcessTextCheck();
+
+    /// Processes the inline software keyboard request command sent by the application.
+    void ProcessInlineKeyboardRequest();
+
+    /// Submits the input text and exits the applet.
+    void SubmitNormalOutputAndExit(SwkbdResult result, std::u16string submitted_text);
+
+    /// Submits the input text for text checking.
+    void SubmitForTextCheck(std::u16string submitted_text);
+
+    /// Sends a reply to the application after processing a request command.
+    void SendReply(SwkbdReplyType reply_type);
+
+    /// Changes the inline keyboard state.
+    void ChangeState(SwkbdState state);
+
+    /**
+     * Signals the frontend to initialize the software keyboard with common parameters.
+     * This initializes either the normal software keyboard or the inline software keyboard
+     * depending on the state of is_background.
+     * Note that this does not cause the keyboard to appear.
+     * Use the respective Show*Keyboard() functions to cause the respective keyboards to appear.
+     */
+    void InitializeFrontendKeyboard();
+
+    /// Signals the frontend to show the normal software keyboard.
+    void ShowNormalKeyboard();
+
+    /// Signals the frontend to show the text check dialog.
+    void ShowTextCheckDialog(SwkbdTextCheckResult text_check_result,
+                             std::u16string text_check_message);
+
+    /// Signals the frontend to show the inline software keyboard.
+    void ShowInlineKeyboard();
 
+    /// Signals the frontend to hide the inline software keyboard.
+    void HideInlineKeyboard();
+
+    /// Signals the frontend that the current inline keyboard text has changed.
+    void InlineTextChanged();
+
+    /// Signals both the frontend and application that the software keyboard is exiting.
+    void ExitKeyboard();
+
+    // Inline Software Keyboard Requests
+
+    void RequestFinalize(const std::vector<u8>& request_data);
+    void RequestSetUserWordInfo(const std::vector<u8>& request_data);
+    void RequestSetCustomizeDic(const std::vector<u8>& request_data);
+    void RequestCalc(const std::vector<u8>& request_data);
+    void RequestSetCustomizedDictionaries(const std::vector<u8>& request_data);
+    void RequestUnsetCustomizedDictionaries(const std::vector<u8>& request_data);
+    void RequestSetChangedStringV2Flag(const std::vector<u8>& request_data);
+    void RequestSetMovedCursorV2Flag(const std::vector<u8>& request_data);
+
+    // Inline Software Keyboard Replies
+
+    void ReplyFinishedInitialize();
+    void ReplyDefault();
+    void ReplyChangedString();
+    void ReplyMovedCursor();
+    void ReplyMovedTab();
+    void ReplyDecidedEnter();
+    void ReplyDecidedCancel();
+    void ReplyChangedStringUtf8();
+    void ReplyMovedCursorUtf8();
+    void ReplyDecidedEnterUtf8();
+    void ReplyUnsetCustomizeDic();
+    void ReplyReleasedUserWordInfo();
+    void ReplyUnsetCustomizedDictionaries();
+    void ReplyChangedStringV2();
+    void ReplyMovedCursorV2();
+    void ReplyChangedStringUtf8V2();
+    void ReplyMovedCursorUtf8V2();
+
+    LibraryAppletMode applet_mode;
+    Core::Frontend::SoftwareKeyboardApplet& frontend;
     Core::System& system;
+
+    SwkbdAppletVersion swkbd_applet_version;
+
+    SwkbdConfigCommon swkbd_config_common;
+    SwkbdConfigOld swkbd_config_old;
+    SwkbdConfigOld2 swkbd_config_old2;
+    SwkbdConfigNew swkbd_config_new;
+    std::u16string initial_text;
+
+    SwkbdState swkbd_state{SwkbdState::NotInitialized};
+    SwkbdInitializeArg swkbd_initialize_arg;
+    SwkbdCalcArg swkbd_calc_arg;
+    bool use_changed_string_v2{false};
+    bool use_moved_cursor_v2{false};
+    bool inline_use_utf8{false};
+    s32 current_cursor_position{};
+
+    std::u16string current_text;
+
+    bool is_background{false};
+
+    bool complete{false};
+    ResultCode status{RESULT_SUCCESS};
 };
 
 } // namespace Service::AM::Applets

src/core/hle/service/am/applets/software_keyboard_types.h

@@ -0,0 +1,295 @@
+// Copyright 2021 yuzu Emulator Project
+// Licensed under GPLv2 or any later version
+// Refer to the license.txt file included.
+
+#pragma once
+
+#include <array>
+
+#include "common/bit_field.h"
+#include "common/common_funcs.h"
+#include "common/common_types.h"
+#include "common/swap.h"
+
+namespace Service::AM::Applets {
+
+constexpr std::size_t MAX_OK_TEXT_LENGTH = 8;
+constexpr std::size_t MAX_HEADER_TEXT_LENGTH = 64;
+constexpr std::size_t MAX_SUB_TEXT_LENGTH = 128;
+constexpr std::size_t MAX_GUIDE_TEXT_LENGTH = 256;
+constexpr std::size_t STRING_BUFFER_SIZE = 0x7D4;
+
+enum class SwkbdAppletVersion : u32_le {
+    Version5 = 0x5,          // 1.0.0
+    Version65542 = 0x10006,  // 2.0.0 - 2.3.0
+    Version196615 = 0x30007, // 3.0.0 - 3.0.2
+    Version262152 = 0x40008, // 4.0.0 - 4.1.0
+    Version327689 = 0x50009, // 5.0.0 - 5.1.0
+    Version393227 = 0x6000B, // 6.0.0 - 7.0.1
+    Version524301 = 0x8000D, // 8.0.0+
+};
+
+enum class SwkbdType : u32 {
+    Normal,
+    NumberPad,
+    Qwerty,
+    Unknown3,
+    Latin,
+    SimplifiedChinese,
+    TraditionalChinese,
+    Korean,
+};
+
+enum class SwkbdInitialCursorPosition : u32 {
+    Start,
+    End,
+};
+
+enum class SwkbdPasswordMode : u32 {
+    Disabled,
+    Enabled,
+};
+
+enum class SwkbdTextDrawType : u32 {
+    Line,
+    Box,
+    DownloadCode,
+};
+
+enum class SwkbdResult : u32 {
+    Ok,
+    Cancel,
+};
+
+enum class SwkbdTextCheckResult : u32 {
+    Success,
+    Failure,
+    Confirm,
+    Silent,
+};
+
+enum class SwkbdState : u32 {
+    NotInitialized = 0x0,
+    InitializedIsHidden = 0x1,
+    InitializedIsAppearing = 0x2,
+    InitializedIsShown = 0x3,
+    InitializedIsDisappearing = 0x4,
+};
+
+enum class SwkbdRequestCommand : u32 {
+    Finalize = 0x4,
+    SetUserWordInfo = 0x6,
+    SetCustomizeDic = 0x7,
+    Calc = 0xA,
+    SetCustomizedDictionaries = 0xB,
+    UnsetCustomizedDictionaries = 0xC,
+    SetChangedStringV2Flag = 0xD,
+    SetMovedCursorV2Flag = 0xE,
+};
+
+enum class SwkbdReplyType : u32 {
+    FinishedInitialize = 0x0,
+    Default = 0x1,
+    ChangedString = 0x2,
+    MovedCursor = 0x3,
+    MovedTab = 0x4,
+    DecidedEnter = 0x5,
+    DecidedCancel = 0x6,
+    ChangedStringUtf8 = 0x7,
+    MovedCursorUtf8 = 0x8,
+    DecidedEnterUtf8 = 0x9,
+    UnsetCustomizeDic = 0xA,
+    ReleasedUserWordInfo = 0xB,
+    UnsetCustomizedDictionaries = 0xC,
+    ChangedStringV2 = 0xD,
+    MovedCursorV2 = 0xE,
+    ChangedStringUtf8V2 = 0xF,
+    MovedCursorUtf8V2 = 0x10,
+};
+
+struct SwkbdKeyDisableFlags {
+    union {
+        u32 raw{};
+
+        BitField<1, 1, u32> space;
+        BitField<2, 1, u32> at;
+        BitField<3, 1, u32> percent;
+        BitField<4, 1, u32> slash;
+        BitField<5, 1, u32> backslash;
+        BitField<6, 1, u32> numbers;
+        BitField<7, 1, u32> download_code;
+        BitField<8, 1, u32> username;
+    };
+};
+static_assert(sizeof(SwkbdKeyDisableFlags) == 0x4, "SwkbdKeyDisableFlags has incorrect size.");
+
+struct SwkbdConfigCommon {
+    SwkbdType type{};
+    std::array<char16_t, MAX_OK_TEXT_LENGTH + 1> ok_text{};
+    char16_t left_optional_symbol_key{};
+    char16_t right_optional_symbol_key{};
+    bool use_prediction{};
+    INSERT_PADDING_BYTES(1);
+    SwkbdKeyDisableFlags key_disable_flags{};
+    SwkbdInitialCursorPosition initial_cursor_position{};
+    std::array<char16_t, MAX_HEADER_TEXT_LENGTH + 1> header_text{};
+    std::array<char16_t, MAX_SUB_TEXT_LENGTH + 1> sub_text{};
+    std::array<char16_t, MAX_GUIDE_TEXT_LENGTH + 1> guide_text{};
+    u32 max_text_length{};
+    u32 min_text_length{};
+    SwkbdPasswordMode password_mode{};
+    SwkbdTextDrawType text_draw_type{};
+    bool enable_return_button{};
+    bool use_utf8{};
+    bool use_blur_background{};
+    INSERT_PADDING_BYTES(1);
+    u32 initial_string_offset{};
+    u32 initial_string_length{};
+    u32 user_dictionary_offset{};
+    u32 user_dictionary_entries{};
+    bool use_text_check{};
+    INSERT_PADDING_BYTES(3);
+};
+static_assert(sizeof(SwkbdConfigCommon) == 0x3D4, "SwkbdConfigCommon has incorrect size.");
+
+#pragma pack(push, 4)
+// SwkbdAppletVersion 0x5, 0x10006
+struct SwkbdConfigOld {
+    INSERT_PADDING_WORDS(1);
+    VAddr text_check_callback{};
+};
+static_assert(sizeof(SwkbdConfigOld) == 0x3E0 - sizeof(SwkbdConfigCommon),
+              "SwkbdConfigOld has incorrect size.");
+
+// SwkbdAppletVersion 0x30007, 0x40008, 0x50009
+struct SwkbdConfigOld2 {
+    INSERT_PADDING_WORDS(1);
+    VAddr text_check_callback{};
+    std::array<u32, 8> text_grouping{};
+};
+static_assert(sizeof(SwkbdConfigOld2) == 0x400 - sizeof(SwkbdConfigCommon),
+              "SwkbdConfigOld2 has incorrect size.");
+
+// SwkbdAppletVersion 0x6000B, 0x8000D
+struct SwkbdConfigNew {
+    std::array<u32, 8> text_grouping{};
+    std::array<u64, 24> customized_dictionary_set_entries{};
+    u8 total_customized_dictionary_set_entries{};
+    bool disable_cancel_button{};
+    INSERT_PADDING_BYTES(18);
+};
+static_assert(sizeof(SwkbdConfigNew) == 0x4C8 - sizeof(SwkbdConfigCommon),
+              "SwkbdConfigNew has incorrect size.");
+#pragma pack(pop)
+
+struct SwkbdTextCheck {
+    SwkbdTextCheckResult text_check_result{};
+    std::array<char16_t, STRING_BUFFER_SIZE / 2> text_check_message{};
+};
+static_assert(sizeof(SwkbdTextCheck) == 0x7D8, "SwkbdTextCheck has incorrect size.");
+
+struct SwkbdCalcArgFlags {
+    union {
+        u64 raw{};
+
+        BitField<0, 1, u64> set_initialize_arg;
+        BitField<1, 1, u64> set_volume;
+        BitField<2, 1, u64> appear;
+        BitField<3, 1, u64> set_input_text;
+        BitField<4, 1, u64> set_cursor_position;
+        BitField<5, 1, u64> set_utf8_mode;
+        BitField<6, 1, u64> unset_customize_dic;
+        BitField<7, 1, u64> disappear;
+        BitField<8, 1, u64> unknown;
+        BitField<9, 1, u64> set_key_top_translate_scale;
+        BitField<10, 1, u64> unset_user_word_info;
+        BitField<11, 1, u64> set_disable_hardware_keyboard;
+    };
+};
+static_assert(sizeof(SwkbdCalcArgFlags) == 0x8, "SwkbdCalcArgFlags has incorrect size.");
+
+struct SwkbdInitializeArg {
+    u32 unknown{};
+    bool library_applet_mode_flag{};
+    bool is_above_hos_500{};
+    INSERT_PADDING_BYTES(2);
+};
+static_assert(sizeof(SwkbdInitializeArg) == 0x8, "SwkbdInitializeArg has incorrect size.");
+
+struct SwkbdAppearArg {
+    SwkbdType type{};
+    std::array<char16_t, MAX_OK_TEXT_LENGTH + 1> ok_text{};
+    char16_t left_optional_symbol_key{};
+    char16_t right_optional_symbol_key{};
+    bool use_prediction{};
+    bool disable_cancel_button{};
+    SwkbdKeyDisableFlags key_disable_flags{};
+    u32 max_text_length{};
+    u32 min_text_length{};
+    bool enable_return_button{};
+    INSERT_PADDING_BYTES(3);
+    u32 flags{};
+    INSERT_PADDING_WORDS(6);
+};
+static_assert(sizeof(SwkbdAppearArg) == 0x48, "SwkbdAppearArg has incorrect size.");
+
+struct SwkbdCalcArg {
+    u32 unknown{};
+    u16 calc_arg_size{};
+    INSERT_PADDING_BYTES(2);
+    SwkbdCalcArgFlags flags{};
+    SwkbdInitializeArg initialize_arg{};
+    f32 volume{};
+    s32 cursor_position{};
+    SwkbdAppearArg appear_arg{};
+    std::array<char16_t, 0x1FA> input_text{};
+    bool utf8_mode{};
+    INSERT_PADDING_BYTES(1);
+    bool enable_backspace_button{};
+    INSERT_PADDING_BYTES(3);
+    bool key_top_as_floating{};
+    bool footer_scalable{};
+    bool alpha_enabled_in_input_mode{};
+    u8 input_mode_fade_type{};
+    bool disable_touch{};
+    bool disable_hardware_keyboard{};
+    INSERT_PADDING_BYTES(8);
+    f32 key_top_scale_x{};
+    f32 key_top_scale_y{};
+    f32 key_top_translate_x{};
+    f32 key_top_translate_y{};
+    f32 key_top_bg_alpha{};
+    f32 footer_bg_alpha{};
+    f32 balloon_scale{};
+    INSERT_PADDING_WORDS(4);
+    u8 se_group{};
+    INSERT_PADDING_BYTES(3);
+};
+static_assert(sizeof(SwkbdCalcArg) == 0x4A0, "SwkbdCalcArg has incorrect size.");
+
+struct SwkbdChangedStringArg {
+    u32 text_length{};
+    s32 dictionary_start_cursor_position{};
+    s32 dictionary_end_cursor_position{};
+    s32 cursor_position{};
+};
+static_assert(sizeof(SwkbdChangedStringArg) == 0x10, "SwkbdChangedStringArg has incorrect size.");
+
+struct SwkbdMovedCursorArg {
+    u32 text_length{};
+    s32 cursor_position{};
+};
+static_assert(sizeof(SwkbdMovedCursorArg) == 0x8, "SwkbdMovedCursorArg has incorrect size.");
+
+struct SwkbdMovedTabArg {
+    u32 text_length{};
+    s32 cursor_position{};
+};
+static_assert(sizeof(SwkbdMovedTabArg) == 0x8, "SwkbdMovedTabArg has incorrect size.");
+
+struct SwkbdDecidedEnterArg {
+    u32 text_length{};
+};
+static_assert(sizeof(SwkbdDecidedEnterArg) == 0x4, "SwkbdDecidedEnterArg has incorrect size.");
+
+} // namespace Service::AM::Applets