frontend/applets: misc fixes

* Renamed applet to applets

* Added log classes Applet and Applet.SWKBD

* Fixes to get it compile

src/core/frontend/applets/swkbd.h

@@ -0,0 +1,134 @@
+// Copyright 2018 Citra Emulator Project
+// Licensed under GPLv2 or any later version
+// Refer to the license.txt file included.
+
+#pragma once
+
+#include <codecvt>
+#include <locale>
+#include <unordered_map>
+#include <utility>
+#include <vector>
+#include "core/frontend/applets/interface.h"
+
+namespace Frontend {
+
+enum class AcceptedInput {
+    Anything = 0,        /// All inputs are accepted.
+    NotEmpty,            /// Empty inputs are not accepted.
+    NotEmptyAndNotBlank, /// 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.
+    FixedLength, /// The input must have a fixed length (specified by maxTextLength in
+                 /// swkbdInit).
+};
+
+enum class ButtonConfig {
+    Single = 0, /// Ok button
+    Dual,       /// Cancel | Ok buttons
+    Triple,     /// Cancel | I Forgot | Ok buttons
+    None,       /// No button (returned by swkbdInputText in special cases)
+};
+
+/// Default English button text mappings. Frontends may need to copy this to internationalize it.
+static const char* BUTTON_OKAY = "Ok";
+static const char* BUTTON_CANCEL = "Cancel";
+static const char* BUTTON_FORGOT = "I Forgot";
+static const std::unordered_map<ButtonConfig, std::vector<std::string>> DEFAULT_BUTTON_MAPPING = {
+    {ButtonConfig::Single, {BUTTON_OKAY}},
+    {ButtonConfig::Dual, {BUTTON_CANCEL, BUTTON_OKAY}},
+    {ButtonConfig::Triple, {BUTTON_CANCEL, BUTTON_FORGOT, BUTTON_OKAY}},
+};
+
+/// Configuration thats relevent to frontend implementation of applets. Anything missing that we
+/// later learn is needed can be added here and filled in by the backend HLE applet
+struct KeyboardConfig : public AppletConfig {
+    ButtonConfig button_config;
+    AcceptedInput accept_mode;   /// What kinds of input are accepted (blank/empty/fixed width)
+    bool multiline_mode;         /// True if the keyboard accepts multiple lines of input
+    u16 max_text_length;         /// Maximum number of letters allowed if its a text input
+    u16 max_digits;              /// Maximum number of numbers allowed if its a number input
+    std::string hint_text;       /// Displayed in the field as a hint before
+    bool has_custom_button_text; /// If true, use the button_text instead
+    std::vector<std::string> button_text; /// Contains the button text that the caller provides
+    struct Filters {
+        bool prevent_digit;     /// Disallow the use of more than a certain number of digits
+                                /// TODO: how many is a certain number
+        bool prevent_at;        /// Disallow the use of the @ sign.
+        bool prevent_percent;   /// Disallow the use of the % sign.
+        bool prevent_backslash; /// Disallow the use of the \ sign.
+        bool prevent_profanity; /// Disallow profanity using Nintendo's profanity filter.
+        bool enable_callback;   /// Use a callback in order to check the input.
+    } filters;
+};
+
+class KeyboardData : public AppletData {
+public:
+    std::string text;
+    u8 button{};
+
+    KeyboardData(std::string text, u8 button) : text(std::move(text)), button(button) {}
+    KeyboardData() = default;
+};
+
+enum class ValidationError {
+    None,
+    // Button Selection
+    ButtonOutOfRange,
+    // Configured Filters
+    DigitNotAllowed,
+    AtSignNotAllowed,
+    PercentNotAllowed,
+    BackslashNotAllowed,
+    ProfanityNotAllowed,
+    CallbackFailed,
+    // Allowed Input Type
+    FixedLengthRequired,
+    MaxLengthExceeded,
+    BlankInputNotAllowed,
+    EmptyInputNotAllowed,
+};
+
+class SoftwareKeyboard : public AppletInterface {
+public:
+    explicit SoftwareKeyboard() : AppletInterface() {}
+    const AppletData* ReceiveData() override {
+        return &data;
+    }
+    void Setup(const AppletConfig* config) override {
+        this->config = KeyboardConfig(*static_cast<const KeyboardConfig*>(config));
+    }
+
+protected:
+    /**
+     * Validates if the provided string breaks any of the filter rules. This is meant to be called
+     * whenever the user input changes to check to see if the new input is valid. Frontends can
+     * decide if they want to check the input continuously or once before submission
+     */
+    ValidationError ValidateFilters(const std::string& input);
+
+    /**
+     * Validates the the provided string doesn't break any extra rules like "input must not be
+     * empty". This will be called by Finalize but can be called earlier if the frontend needs
+     */
+    ValidationError ValidateInput(const std::string& input);
+
+    /**
+     * Verifies that the selected button is valid. This should be used as the last check before
+     * closing.
+     */
+    ValidationError ValidateButton(u8 button);
+
+    /**
+     * Runs all validation phases. If successful, stores the data so that the HLE applet in core can
+     * send this to the calling application
+     */
+    ValidationError Finalize(const std::string& text, u8 button);
+
+private:
+    KeyboardConfig config;
+    KeyboardData data;
+};
+
+} // namespace Frontend