Wii U: Add support for swkbd. (#100)

* Implemented swkbd on the Wii U.

* Let clang format it.

* - Cleaned up code.
- No more replacement of global new/delete operators; use strings with custom allocators
  instead.
- Don't rely on C locale API, let the user control the locale explicitly.
- A few more customization functions.
- Properly documented all functions.
- Added enums.
- Input feeding from VPAD and KPAD is now public.

* - Added events to differentiate before and after all text is received.
- Added function to manually disable the swkbd.

* Don't reset swkbd window to null until it's fully hidden.

* - Added `-lstdc++` as a dependency, because the swkbd API is C++.
- Added missing include `<new>`.
- Don't copy the user-supplied `nn::swkbd::AppearArg`.

* Removed duplicated name.

* Link libstdc++ before libwut.

* Fixed inconsistent indentation.

* Removed dependency on libstdc++.

* Removed emacs local variables.

* Renamed SDL_wiiu_swkbd.* to SDL_wiiuswkbd.*

* Removed CreateArg and AppearArg API.

* Clean up swkbd from WIIU_VideoQuit().

* Forgot to remove attribute.

* The default swkbd layout works for all languages.

---------

Co-authored-by: Daniel K. O. (dkosmari) <none@none>

Author: 2 people

.clang-format

@@ -34,6 +34,7 @@ BraceWrapping:
   AfterStruct: true
   AfterUnion: true
   AfterExternBlock: false
+  BeforeCatch: true
   BeforeElse: false
   BeforeWhile: false
   IndentBraces: false
@@ -62,6 +63,8 @@ IndentGotoLabels: true
 IndentPPDirectives: None
 IndentExternBlock: NoIndent
 
+NamespaceIndentation: All
+
 PointerAlignment: Right
 SpaceAfterCStyleCast: false
 SpacesInCStyleCastParentheses: false

CMakeLists.txt

@@ -243,6 +243,9 @@ endif()
 if(WIIU)
   # Prefer coreinit atomics on Wii U due to a hardware bug in load-exclusive and store-exclusive instructions
   set(OPT_DEF_GCC_ATOMICS OFF)
+  # Needed for nn::swkbd API
+  set(LINKER_LANGUAGE CXX)
+  set (CMAKE_CXX_STANDARD 23)
 endif()
 
 # Default option knobs
@@ -2987,14 +2990,14 @@ elseif(WIIU)
   if(SDL_VIDEO)
     set(SDL_VIDEO_DRIVER_WIIU 1)
     set(SDL_VIDEO_RENDER_WIIU 1)
-    file(GLOB WIIU_VIDEO_SOURCES ${SDL2_SOURCE_DIR}/src/video/wiiu/*.c)
+    file(GLOB WIIU_VIDEO_SOURCES
+        ${SDL2_SOURCE_DIR}/src/video/wiiu/*.c
+        ${SDL2_SOURCE_DIR}/src/video/wiiu/*.cpp)
     set(SOURCE_FILES ${SOURCE_FILES} ${WIIU_VIDEO_SOURCES})
     set(HAVE_SDL_VIDEO TRUE)
   endif()
-
-  list(APPEND EXTRA_LIBS
-      wut
-    )
+  list(APPEND EXTRA_CXXFLAGS "-fno-exceptions")
+  list(APPEND EXTRA_LIBS wut)
 endif()
 
 if(HAVE_VULKAN AND NOT SDL_LOADSO)
@@ -3130,8 +3133,13 @@ endif()
 if(EXTRA_CFLAGS)
   list(REMOVE_DUPLICATES EXTRA_CFLAGS)
 endif()
+if(EXTRA_CXXFLAGS)
+  list(REMOVE_DUPLICATES EXTRA_CXXFLAGS)
+endif()
 listtostr(EXTRA_CFLAGS _EXTRA_CFLAGS)
 set(EXTRA_CFLAGS ${_EXTRA_CFLAGS})
+listtostr(EXTRA_CXXFLAGS _EXTRA_CXXFLAGS)
+set(EXTRA_CXXFLAGS ${_EXTRA_CXXFLAGS})
 
 if(USE_GCC OR USE_CLANG)
   string(REGEX REPLACE "(^| )-I" "\\1 -isystem" EXTRA_CFLAGS "${EXTRA_CFLAGS}")
@@ -3384,10 +3392,11 @@ if("${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
   message(STATUS " CMAKE_CXX_FLAGS_DEBUG: ${CMAKE_CXX_FLAGS_DEBUG}")
 endif()
 message(STATUS "")
-message(STATUS " CFLAGS:        ${CMAKE_C_FLAGS}")
-message(STATUS " EXTRA_CFLAGS:  ${EXTRA_CFLAGS}")
-message(STATUS " EXTRA_LDFLAGS: ${EXTRA_LDFLAGS} ${EXTRA_LDFLAGS_BUILD}")
-message(STATUS " EXTRA_LIBS:    ${EXTRA_LIBS}")
+message(STATUS " CFLAGS:         ${CMAKE_C_FLAGS}")
+message(STATUS " EXTRA_CFLAGS:   ${EXTRA_CFLAGS}")
+message(STATUS " EXTRA_CXXFLAGS: ${EXTRA_CXXFLAGS}")
+message(STATUS " EXTRA_LDFLAGS:  ${EXTRA_LDFLAGS} ${EXTRA_LDFLAGS_BUILD}")
+message(STATUS " EXTRA_LIBS:     ${EXTRA_LIBS}")
 message(STATUS "")
 message(STATUS " Build Shared Library: ${SDL_SHARED}")
 message(STATUS " Build Static Library: ${SDL_STATIC}")
@@ -3422,6 +3431,8 @@ endif()
 
 # Ensure that the extra cflags are used at compile time
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${EXTRA_CFLAGS} ${EXTRA_CFLAGS_BUILD}")
+# Same for cxxflags
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${EXTRA_CXXFLAGS} ${EXTRA_CXXFLAGS_BUILD}")
 
 if(NOT WINDOWS_STORE AND NOT SDL2_DISABLE_SDL2MAIN)
   # Build SDLmain

include/SDL_system.h

@@ -631,6 +631,212 @@ extern DECLSPEC int SDLCALL SDL_GDKGetDefaultUser(XUserHandle * outUserHandle);
 
 #endif
 
+/* Platform specific functions for Wii U */
+#if defined(__WIIU__)
+typedef enum SDL_WiiUSysWMEventType {
+    /** Sent before any text input event. */
+    SDL_WIIU_SYSWM_SWKBD_OK_START_EVENT = 1,
+    /** Sent after all text input events. */
+    SDL_WIIU_SYSWM_SWKBD_OK_FINISH_EVENT,
+    /** Sent after the swkbd was canceled. */
+    SDL_WIIU_SYSWM_SWKBD_CANCEL_EVENT
+} SDL_WiiUSysWMEventType;
+
+/**
+ * Disable the swkbd.
+ *
+ * Use this function if you only want text input from a physical USB keyboard.
+ *
+ * \param enabled `SDL_FALSE` if you do not want the swkbd to show up after calling
+ * `SDL_StartTextInput()`.
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDEnabled(SDL_bool enabled);
+
+/**
+ * Select the swkbd keyboard mode.
+ *
+ * \sa SDL_WiiUSetSWKBDKeyboardMode
+ */
+typedef enum SDL_WiiUSWKBDKeyboardMode {
+    /** Full keyboard. */
+    SDL_WIIU_SWKBD_KEYBOARD_MODE_FULL,
+    /** Numeric keyboard. */
+    SDL_WIIU_SWKBD_KEYBOARD_MODE_NUMPAD,
+    /** Restricted keyboard (only letters, numbers and symbols.) */
+    SDL_WIIU_SWKBD_KEYBOARD_MODE_RESTRICTED,
+    /** NNID keyboard. */
+    SDL_WIIU_SWKBD_KEYBOARD_MODE_NNID
+} SDL_WiiUSWKBDKeyboardMode;
+
+/**
+ * Sets the swkbd's keyboard mode.
+ *
+ * \param mode One of SDL_WiiUSWKBDKeyboardMode. The default is
+ * `SDL_WIIU_SWKBD_KEYBOARD_MODE_FULL`.
+ *
+ * \note
+ * This option is reset to the default value after the swkbd is shown.
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDKeyboardMode(SDL_WiiUSWKBDKeyboardMode mode);
+
+/**
+ * Sets the label for the swkbd's "OK" button.
+ *
+ * \param label String for the "OK" button, encoded in UTF-8, or `NULL` to use the
+ * default.
+ *
+ * \note
+ * This option is reset to the default value after the swkbd is shown.
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDOKLabel(const char * label);
+
+/**
+ * Sets the swkbd's word suggestions option.
+ *
+ * \param show `SDL_TRUE` to enable word suggestions. The default is `SDL_TRUE`.
+ *
+ * \note
+ * This option is reset to the default value after the swkbd is shown.
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDShowWordSuggestions(SDL_bool show);
+
+/**
+ * Sets the swkbd's initial text.
+ *
+ * \param text String for the initial text, encoded in UTF-8, or `NULL` to use the
+ * default (no initial text.)
+ *
+ * \note
+ * This option is reset to the default value after the swkbd is shown.
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDInitialText(const char * text);
+
+/**
+ * Sets the swkbd's hint text.
+ *
+ * \param text String for the hint text, encoded in UTF-8, or `NULL` to use the default
+ * (no hint.)
+ *
+ * \note
+ * This option is reset to the default value after the swkbd is shown.
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDHintText(const char * text);
+
+/**
+ * Controls how to display passwwords in the swkbd when in password mode.
+ */
+typedef enum SDL_WiiUSWKBDPasswordMode {
+    SDL_WIIU_SWKBD_PASSWORD_MODE_SHOW, /**< Show password. */
+    SDL_WIIU_SWKBD_PASSWORD_MODE_HIDE, /**< Hide password. */
+    SDL_WIIU_SWKBD_PASSWORD_MODE_FADE  /**< Hide password after 1 second. */
+} SDL_WiiUSWKBDPasswordMode;
+
+/**
+ * Sets the swkbd's password mode.
+ *
+ * \param mode One of of the SDL_WiiUSWKBDPasswordMode values. The default is
+ * `SDL_WIIU_SWKBD_PASSWORD_MODE_SHOW`.
+ *
+ * \note
+ * This option is reset to the default value after the swkbd is shown.
+ *
+ * \sa SDL_WiiUSetSWKBDKeyboardMode
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDPasswordMode(SDL_WiiUSWKBDPasswordMode mode);
+
+/**
+ * Sets whether to highlight (select) the swkbd's initial text.
+ *
+ * \param highlight `SDL_TRUE` to highlight the initial text. The default is `SDL_FALSE`.
+
+ * \note
+ * This option is reset to the default value after the swkbd is shown.
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDHighlightInitialText(SDL_bool highlight);
+
+/**
+ * Sets the swkbd's copy-paste button option.
+ *
+ * \param show `SDL_TRUE` to show copy-paste buttons. The default is `SDL_FALSE`.
+ *
+ * \note
+ * This option is reset to the default value after the swkbd is shown.
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDShowCopyPasteButtons(SDL_bool show);
+
+/**
+ * Sets the swkbd's built-in rendering of the Wii remote pointer.
+ *
+ * \param draw `SDL_TRUE` to let the swkbd draw its own Wii remote pointer. The default is
+ * `SDL_TRUE`.
+ *
+ * This option is reset to the default value after the swkbd is shown.
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDDrawWiiPointer(SDL_bool draw);
+
+/**
+ * Sets the swkbd's locale (region and language.)
+ *
+ * \param locale String representing the intended keyboard region and language, using
+ * Unix-style locale format (e.g. `"en_US"`, `"fr_CA"`, `ja_JP`, `"en"`.) Set to `NULL` to
+ * use the system region and language. The default is `NULL`.
+ *
+ * The recognized languages are:
+ *   - ja: Japanese
+ *   - en: English
+ *   - fr: French
+ *   - de: German
+ *   - it: Italian
+ *   - es: Spanish
+ *   - nl: Dutch
+ *   - pt: Portuguese
+ *   - ru: Russian
+ *
+ * The recognized regions are:
+ *   - US, CA, MX, BR: mapped to the "USA" console region.
+ *   - DE, ES, FR, GB, IT, NL, PT, RU: mapped to the "EUR" console region.
+ *   - JP: mapped to the "JPN" console region.
+ *
+ * When no country is specified, "jp" will map to the "JPN" region, "en" to "USA" region,
+ * and everything else will map to "EUR" region.
+ *
+ * By default the locale is obtained from the system configuration (cafe.language). The
+ * empty locale string is equivalent to the system configuration.
+ *
+ * \note
+ * The swkbd will be re-initialized after calling this function.
+ */
+extern DECLSPEC void SDLCALL SDL_WiiUSetSWKBDLocale(const char * locale);
+
+/**
+ * Sends VPAD input to the swkbd.
+ *
+ * Call this function at every frame if your application calls `VPADRead()` instead of
+ * using the SDL game controller subsystem.
+ *
+ * \param vpad Pointer to a `VPADStatus` object.
+ * \returns `SDL_TRUE` if the swkbd is visible and is going to use the input.
+ *
+ * \note
+ * The touch point in `tpNormal` should contain a calibrated point, by calling
+ * `VPADGetTPCalibratedPoint()`, prior to calling this function.
+ */
+extern DECLSPEC SDL_bool SDLCALL SDL_WiiUSetSWKBDVPAD(const void * vpad);
+
+/**
+ * Sends KPAD input to the swkbd.
+ *
+ * Call this function at every frame if you call `KPADRead()` or `KPADReadEx()` in your
+ * application, instead of using the SDL game controller subsystem.
+ *
+ * \param channel Number of channel.
+ * \param kpad Pointer to a `KPADStatus` object.
+ * \returns `SDL_TRUE` if the swkbd is visible and is going to use the input.
+ */
+extern DECLSPEC SDL_bool SDLCALL SDL_WiiUSetSWKBDKPAD(int channel, const void * kpad);
+
+#endif /* Wii U */
+
 /* Ends C function definitions when using C++ */
 #ifdef __cplusplus
 }

include/SDL_syswm.h

@@ -148,7 +148,8 @@ typedef enum SDL_SYSWM_TYPE
     SDL_SYSWM_OS2,
     SDL_SYSWM_HAIKU,
     SDL_SYSWM_KMSDRM,
-    SDL_SYSWM_RISCOS
+    SDL_SYSWM_RISCOS,
+    SDL_SYSWM_WIIU
 } SDL_SYSWM_TYPE;
 
 /**
@@ -211,6 +212,11 @@ struct SDL_SysWMmsg
             MPARAM mp1;                 /**< The first first message parameter */
             MPARAM mp2;                 /**< The second first message parameter */
         } os2;
+#endif
+#if defined(SDL_VIDEO_DRIVER_WIIU)
+        struct {
+            unsigned event;
+        } wiiu;
 #endif
         /* Can't have an empty union */
         int dummy;

src/events/SDL_events_c.h

@@ -24,6 +24,10 @@
 
 #include "../SDL_internal.h"
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /* Useful functions and variables from SDL_events.c */
 #include "SDL_events.h"
 #include "SDL_thread.h"
@@ -58,6 +62,11 @@ extern void SDL_SendPendingSignalEvents(void);
 extern int SDL_QuitInit(void);
 extern void SDL_QuitQuit(void);
 
+#ifdef __cplusplus
+}
+#endif
+
+
 #endif /* SDL_events_c_h_ */
 
 /* vi: set ts=4 sw=4 expandtab: */

src/events/SDL_keyboard_c.h

@@ -26,6 +26,10 @@
 #include "SDL_keycode.h"
 #include "SDL_events.h"
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /* Initialize the keyboard subsystem */
 extern int SDL_KeyboardInit(void);
 
@@ -84,6 +88,10 @@ extern char *SDL_UCS4ToUTF8(Uint32 ch, char *dst);
 /* Toggle on or off pieces of the keyboard mod state. */
 extern void SDL_ToggleModState(const SDL_Keymod modstate, const SDL_bool toggle);
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* SDL_keyboard_c_h_ */
 
 /* vi: set ts=4 sw=4 expandtab: */