port to SDL3 (start)

Author: jube

include/gf2/core/Event.h

@@ -6,6 +6,7 @@
 #include <cstdint>
 
 #include <array>
+#include <string_view>
 #include <variant>
 
 #include "CoreApi.h"
@@ -30,7 +31,7 @@ namespace gf {
     WindowExposed,
     WindowMoved,
     WindowResized,
-    // WindowPixelSizeChanged, // TODO: SDL3
+    WindowPixelSizeChanged,
     WindowMinimized,
     WindowMaximized,
     WindowRestored,
@@ -45,7 +46,7 @@ namespace gf {
     KeyReleased,
 
     // TextEdited, // TODO: SDL3
-    TextEntered,
+    TextInput,
     // TextCandidatesShown, // TODO: SDL3
 
     MouseMoved,
@@ -91,10 +92,10 @@ namespace gf {
     Vec2I size;
   };
 
-  // struct GF_CORE_API WindowPixelSizeChangedEvent {
-  //   WindowId window_id;
-  //   Vec2I size;
-  // };
+  struct GF_CORE_API WindowPixelSizeChangedEvent {
+    WindowId window_id;
+    Vec2I size;
+  };
 
   struct GF_CORE_API WindowMinimizedEvent {
     WindowId window_id;
@@ -157,9 +158,9 @@ namespace gf {
   //   int32_t length;
   // };
 
-  struct GF_CORE_API TextEnteredEvent {
+  struct GF_CORE_API TextInputEvent {
     WindowId window_id;
-    std::array<char, 32> text; // TODO: SDL3: changed to a std::string_view
+    std::string_view text;
   };
 
   // struct GF_CORE_API TextCandidatesShownEvent {
@@ -181,23 +182,24 @@ namespace gf {
     WindowId window_id;
     MouseId mouse_id;
     MouseButton button;
-    Vec2I position;
+    Vec2F position;
     uint8_t clicks;
   };
 
   struct GF_CORE_API MouseButtonReleasedEvent {
     WindowId window_id;
     MouseId mouse_id;
     MouseButton button;
-    Vec2I position;
+    Vec2F position;
     uint8_t clicks;
   };
 
   struct GF_CORE_API MouseWheelScrolledEvent {
     WindowId window_id;
     MouseId mouse_id;
-    Vec2I offset;
+    Vec2F offset;
     MouseWheelDirection direction;
+    Vec2F position;
   };
 
   struct GF_CORE_API GamepadAxisMovedEvent {
@@ -217,7 +219,7 @@ namespace gf {
   };
 
   struct GF_CORE_API GamepadConnectedEvent {
-    GamepadHwId gamepad_hw_id;
+    GamepadId gamepad_id;
   };
 
   struct GF_CORE_API GamepadDisconnectedEvent {
@@ -315,7 +317,7 @@ namespace gf {
       WindowExposedEvent,
       WindowMovedEvent,
       WindowResizedEvent,
-      // WindowPixelSizeChangedEvent,
+      WindowPixelSizeChangedEvent,
       WindowMinimizedEvent,
       WindowMaximizedEvent,
       WindowRestoredEvent,
@@ -330,7 +332,7 @@ namespace gf {
       KeyReleasedEvent,
 
       // TextEditedEvent,
-      TextEnteredEvent,
+      TextInputEvent,
       // TextCandidatesShownEvent,
 
       MouseMovedEvent,

include/gf2/core/GamepadTypes.h

@@ -5,14 +5,17 @@
 
 #include <cstdint>
 
+#include <limits>
+#include <type_traits>
+
 namespace gf {
 
   enum class GamepadButton : int32_t { // NOLINT(performance-enum-size)
     Invalid = -1,
-    A,
-    B,
-    X,
-    Y,
+    South,
+    East,
+    West,
+    North,
     Back,
     Guide,
     Start,
@@ -50,13 +53,10 @@ namespace gf {
     Negative,
   };
 
-  enum class GamepadHwId : int { // NOLINT(performance-enum-size)
-  };
-
-  enum class GamepadId : int32_t { // NOLINT(performance-enum-size)
+  enum class GamepadId : uint32_t { // NOLINT(performance-enum-size)
   };
 
-  constexpr GamepadId AnyGamepad = static_cast<GamepadId>(INT32_C(-1));
+  constexpr GamepadId AnyGamepad = static_cast<GamepadId>(std::numeric_limits<std::underlying_type_t<GamepadId>>::max());
 
 }
 

include/gf2/core/Keycode.h

@@ -24,7 +24,7 @@ namespace gf {
     Tab = '\t',
     Space = ' ',
     Exclaim = '!',
-    QuoteDbl = '"',
+    DoubleApostrophe = '"',
     Hash = '#',
     Percent = '%',
     Dollar = '$',
@@ -60,7 +60,7 @@ namespace gf {
     RightBracket = ']',
     Caret = '^',
     Underscore = '_',
-    Backquote = '`',
+    Grave = '`',
     A = 'a',
     B = 'b',
     C = 'c',

include/gf2/core/TouchTypes.h

@@ -5,13 +5,16 @@
 
 #include <cstdint>
 
+#include <limits>
+#include <type_traits>
+
 namespace gf {
 
-  enum class TouchId : int64_t;
+  enum class TouchId : uint64_t;
 
-  constexpr TouchId MouseTouchId = TouchId{ -1 };
+  constexpr TouchId MouseTouchId = TouchId{ std::numeric_limits<std::underlying_type_t<TouchId>>::max() };
 
-  enum class FingerId : int64_t;
+  enum class FingerId : uint64_t;
 
 } // namespace gf
 

include/gf2/graphics/Cursor.h

@@ -12,18 +12,18 @@ struct SDL_Cursor;
 namespace gf {
 
   enum class CursorType : uint8_t {
-    Arrow,
+    Default,
     Text,
     Wait,
     Cross,
-    ArrowWait,
+    Progress,
     SizeTopLeftBottomRight,
     SizeBottomLeftTopRight,
     SizeHorizontal,
     SizeVertical,
-    SizeAll,
+    Move,
     NotAllowed,
-    Hand,
+    Pointer,
   };
 
   class GF_GRAPHICS_API Cursor {

include/gf2/graphics/Gamepad.h

@@ -15,7 +15,7 @@ namespace gf {
     static const char* button_name(GamepadButton button);
     static const char* gamepad_name(GamepadId id);
 
-    static GamepadId open(GamepadHwId hwid);
+    static void open(GamepadId hwid);
     static bool attached(GamepadId id);
     static void close(GamepadId id);
   };

include/gf2/imgui/ImguiManager.h

@@ -37,7 +37,7 @@ namespace gf {
     void update_mouse_cursor();
 
     Texture m_font_texture;
-    CursorType m_cursor_type = CursorType::Arrow;
+    CursorType m_cursor_type = CursorType::Default;
     Cursor m_cursor;
   };
 

library/core/Event.cc

@@ -26,6 +26,7 @@ namespace gf {
       event_data_check<gf::WindowExposedEvent, gf::EventType::WindowExposed>();
       event_data_check<gf::WindowMovedEvent, gf::EventType::WindowMoved>();
       event_data_check<gf::WindowResizedEvent, gf::EventType::WindowResized>();
+      event_data_check<gf::WindowPixelSizeChangedEvent, gf::EventType::WindowPixelSizeChanged>();
       event_data_check<gf::WindowMinimizedEvent, gf::EventType::WindowMinimized>();
       event_data_check<gf::WindowMaximizedEvent, gf::EventType::WindowMaximized>();
       event_data_check<gf::WindowRestoredEvent, gf::EventType::WindowRestored>();
@@ -37,7 +38,7 @@ namespace gf {
       event_data_check<gf::KeyPressedEvent, gf::EventType::KeyPressed>();
       event_data_check<gf::KeyRepeatedEvent, gf::EventType::KeyRepeated>();
       event_data_check<gf::KeyReleasedEvent, gf::EventType::KeyReleased>();
-      event_data_check<gf::TextEnteredEvent, gf::EventType::TextEntered>();
+      event_data_check<gf::TextInputEvent, gf::EventType::TextInput>();
       event_data_check<gf::MouseMovedEvent, gf::EventType::MouseMoved>();
       event_data_check<gf::MouseButtonPressedEvent, gf::EventType::MouseButtonPressed>();
       event_data_check<gf::MouseButtonReleasedEvent, gf::EventType::MouseButtonReleased>();

library/graphics/Clipboard.cc

@@ -3,28 +3,39 @@
 
 #include <gf2/graphics/Clipboard.h>
 
-#include <SDL2/SDL.h>
+#include <memory>
+
+#include <SDL3/SDL.h>
 
 #include <gf2/core/Log.h>
 
 namespace gf {
 
+  namespace {
+
+    struct ClipboardStringDeleter {
+      void operator()(char* str) const noexcept
+      {
+        SDL_free(str);
+      }
+    };
+
+  }
+
   std::string Clipboard::text()
   {
-    if (SDL_HasClipboardText() == SDL_FALSE) {
+    if (!SDL_HasClipboardText()) {
       return "";
     }
 
-    char* raw_text = SDL_GetClipboardText();
+    std::unique_ptr<char[], ClipboardStringDeleter> raw_text(SDL_GetClipboardText());
 
     if (raw_text == nullptr) {
       Log::error("Unable to get clipboard text: {}.", SDL_GetError());
       return "";
     }
 
-    std::string result(raw_text);
-    SDL_free(raw_text);
-    return result;
+    return raw_text.get();
   }
 
   void Clipboard::set_text(const std::string& text)

library/graphics/Cursor.cc

@@ -5,7 +5,7 @@
 
 #include <utility>
 
-#include <SDL2/SDL.h>
+#include <SDL3/SDL.h>
 
 #include <gf2/core/Log.h>
 
@@ -21,18 +21,18 @@ namespace gf {
 
     [[maybe_unused]] constexpr void cursor_check()
     {
-      cursor_type_check<CursorType::Arrow, SDL_SYSTEM_CURSOR_ARROW>();
-      cursor_type_check<CursorType::Text, SDL_SYSTEM_CURSOR_IBEAM>();
+      cursor_type_check<CursorType::Default, SDL_SYSTEM_CURSOR_DEFAULT>();
+      cursor_type_check<CursorType::Text, SDL_SYSTEM_CURSOR_TEXT>();
       cursor_type_check<CursorType::Wait, SDL_SYSTEM_CURSOR_WAIT>();
       cursor_type_check<CursorType::Cross, SDL_SYSTEM_CURSOR_CROSSHAIR>();
-      cursor_type_check<CursorType::ArrowWait, SDL_SYSTEM_CURSOR_WAITARROW>();
-      cursor_type_check<CursorType::SizeTopLeftBottomRight, SDL_SYSTEM_CURSOR_SIZENWSE>();
-      cursor_type_check<CursorType::SizeBottomLeftTopRight, SDL_SYSTEM_CURSOR_SIZENESW>();
-      cursor_type_check<CursorType::SizeHorizontal, SDL_SYSTEM_CURSOR_SIZEWE>();
-      cursor_type_check<CursorType::SizeVertical, SDL_SYSTEM_CURSOR_SIZENS>();
-      cursor_type_check<CursorType::SizeAll, SDL_SYSTEM_CURSOR_SIZEALL>();
-      cursor_type_check<CursorType::Hand, SDL_SYSTEM_CURSOR_HAND>();
-      cursor_type_check<CursorType::NotAllowed, SDL_SYSTEM_CURSOR_NO>();
+      cursor_type_check<CursorType::Progress, SDL_SYSTEM_CURSOR_PROGRESS>();
+      cursor_type_check<CursorType::SizeTopLeftBottomRight, SDL_SYSTEM_CURSOR_NWSE_RESIZE>();
+      cursor_type_check<CursorType::SizeBottomLeftTopRight, SDL_SYSTEM_CURSOR_NESW_RESIZE>();
+      cursor_type_check<CursorType::SizeHorizontal, SDL_SYSTEM_CURSOR_EW_RESIZE>();
+      cursor_type_check<CursorType::SizeVertical, SDL_SYSTEM_CURSOR_NS_RESIZE>();
+      cursor_type_check<CursorType::Move, SDL_SYSTEM_CURSOR_MOVE>();
+      cursor_type_check<CursorType::Pointer, SDL_SYSTEM_CURSOR_POINTER>();
+      cursor_type_check<CursorType::NotAllowed, SDL_SYSTEM_CURSOR_NOT_ALLOWED>();
     }
 
   }
@@ -53,7 +53,7 @@ namespace gf {
   Cursor::~Cursor()
   {
     if (m_cursor != nullptr) {
-      SDL_FreeCursor(m_cursor);
+      SDL_DestroyCursor(m_cursor);
     }
   }
 
@@ -65,7 +65,12 @@ namespace gf {
 
   void Cursor::set_mouse_cursor_visible(bool visible)
   {
-    SDL_ShowCursor(visible ? SDL_ENABLE : SDL_DISABLE);
+    // TODO: [SDL3] check return
+    if (visible) {
+      SDL_ShowCursor();
+    } else {
+      SDL_HideCursor();
+    }
   }
 
   void Cursor::set_mouse_cursor(const Cursor* cursor)