refactor the notification

Author: 1bsyl

include/SDL3/SDL_notification.h

@@ -52,39 +52,55 @@ typedef enum
 typedef enum
 {
     SDL_ICON_TYPE_SINGLE_FILE    = 0x00000010,   /**< A single icon file. */
-    SDL_ICON_TYPE_ICON_DIRECTORY = 0x00000020,   /**< A directory containing icons in "heightxwidth.bmp" format. */
-    SDL_ICON_TYPE_SURFACE        = 0x00000040    /**< Icon inside an SDL surface. */
+    SDL_ICON_TYPE_SURFACE        = 0x00000020,   /**< Icon inside an SDL surface. */
+    SDL_ICON_TYPE_WINDOW         = 0x00000040    /**< Icon is same as SDL window. */
 } SDL_IconFlags;
 
+/**
+ * Notification structure containing title, text, window, etc.
+ */
 typedef struct
 {
-  Uint32 flags;
-  union {
-      const char *path;
-      SDL_Surface *surface;
-  } icon;
-} SDL_Icon;
+    Uint32 flags;                       /**< ::SDL_NotificationFlags */
+    const char *title;                  /**< UTF-8 title */
+    const char *message;                /**< UTF-8 message text */
+
+    struct
+    {
+        Uint32 flags;                       /**< ::SDL_IconFlags */
+        union {
+            const char *path;
+            SDL_Surface *surface;
+            SDL_Window *window;
+        } data;
+    } icon;
+
+} SDL_NotificationData;
 
 /**
- *  \brief Create a simple system notification.
+ *  \brief Create a system notification.
  *
- *  If a window is specified it's icon will be used for the notification,
- *  and the notifcation will open that window when clicked on supported
- *  platforms. Alternatively if an icon is specified for the icon this will,
- *  be used instead.
+ *  \param notificationdata the SDL_NotificationData structure with title, text and other options
+ *  \returns 0 on success or a negative error code on failure; call
+ *          SDL_GetError() for more information.
+ *
+ *  \sa SDL_ShowSimpleNotification
+ *  \sa SDL_NotificationData
+ */
+extern DECLSPEC int SDLCALL SDL_ShowNotification(const SDL_NotificationData *notificationdata);
+
+/**
+ *  \brief Create a simple system notification.
  *
- *  \param flags    Notification/Priority Flags
  *  \param title    UTF-8 title text
  *  \param message  UTF-8 message text
- *  \param window   Window to associate to the notfication.
- *  \param icon     Icon (if different to window icon).
- *
- *  \return 0 on success, -1 on error
+ *  \returns 0 on success or a negative error code on failure; call
+ *          SDL_GetError() for more information.
  *
- *  \sa SDL_ShowSimpleNotification
+ *  \sa SDL_ShowNotification
+ *  \sa SDL_NotificationData
  */
-extern DECLSPEC int SDLCALL SDL_ShowSimpleNotification(Uint32 flags, const char *title, const char *message,
-                                                       SDL_Window *window, SDL_Icon *icon);
+extern DECLSPEC int SDLCALL SDL_ShowSimpleNotification(const char *title, const char *message);
 
 /* Ends C function definitions when using C++ */
 #ifdef __cplusplus

src/core/linux/SDL_dbus.c

@@ -499,7 +499,7 @@ SDL_DBus_ScreensaverInhibit(SDL_bool inhibit)
     return SDL_TRUE;
 }
 
-SDL_bool SDL_DBus_SendNotification(const char *app, const char *title, const char *body)
+int SDL_DBus_ShowNotification(const SDL_NotificationData *notificationdata)
 {
     dbus_bool_t status = 0;
     DBusConnection *conn = dbus.session_conn;
@@ -510,6 +510,15 @@ SDL_bool SDL_DBus_SendNotification(const char *app, const char *title, const cha
     DBusMessageIter iter;
     DBusMessageIter sub;
 
+    const char *app;
+    const char *title;
+    const char *body;
+
+
+    app = notificationdata->title;
+    title = notificationdata->title;
+    body = notificationdata->message;
+
     if (conn == NULL) {
         return SDL_FALSE;
     }

src/core/linux/SDL_dbus.h

@@ -93,7 +93,7 @@ extern SDL_bool SDL_DBus_QueryPropertyOnConnection(DBusConnection *conn, const c
 
 extern void SDL_DBus_ScreensaverTickle(void);
 extern SDL_bool SDL_DBus_ScreensaverInhibit(SDL_bool inhibit);
-extern SDL_bool SDL_DBus_SendNotification(const char *app, const char *title, const char *body);
+extern int SDL_DBus_ShowNotification(const SDL_NotificationData *notificationdata);
 
 #endif /* HAVE_DBUS_DBUS_H */
 

src/dynapi/SDL_dynapi.sym

@@ -841,6 +841,7 @@ SDL3_0.0.0 {
     SDL_GetSystemTheme;
     SDL_CreatePopupWindow;
     SDL_GetWindowParent;
+    SDL_ShowNotification;
     SDL_ShowSimpleNotification;
     # extra symbols go here (don't modify this line)
   local: *;

src/dynapi/SDL_dynapi_overrides.h

@@ -868,4 +868,5 @@
 #define SDL_GetSystemTheme SDL_GetSystemTheme_REAL
 #define SDL_CreatePopupWindow SDL_CreatePopupWindow_REAL
 #define SDL_GetWindowParent SDL_GetWindowParent_REAL
+#define SDL_ShowNotification SDL_ShowNotification_REAL
 #define SDL_ShowSimpleNotification SDL_ShowSimpleNotification_REAL

src/dynapi/SDL_dynapi_procs.h

@@ -913,4 +913,5 @@ SDL_DYNAPI_PROC(int,SDL_GetRenderWindowSize,(SDL_Renderer *a, int *b, int *c),(a
 SDL_DYNAPI_PROC(SDL_SystemTheme,SDL_GetSystemTheme,(void),(),return)
 SDL_DYNAPI_PROC(SDL_Window*,SDL_CreatePopupWindow,(SDL_Window *a, int b, int c, int d, int e, Uint32 f),(a,b,c,d,e,f),return)
 SDL_DYNAPI_PROC(SDL_Window*,SDL_GetWindowParent,(SDL_Window *a),(a),return)
-SDL_DYNAPI_PROC(int,SDL_ShowSimpleNotification,(Uint32 a, const char *b, const char *c, SDL_Window *d, SDL_Icon *e),(a,b,c,d,e),return)
+SDL_DYNAPI_PROC(int,SDL_ShowNotification,(const SDL_NotificationData *a),(a),return)
+SDL_DYNAPI_PROC(int,SDL_ShowSimpleNotification,(const char *a, const char *b),(a,b),return)

src/video/SDL_sysvideo.h

@@ -345,7 +345,7 @@ struct SDL_VideoDevice
     int (*SetWindowHitTest)(SDL_Window *window, SDL_bool enabled);
 
     /* Notification */
-    int (*ShowNotification)(_THIS, const SDL_MessageBoxData *messageboxdata, int *buttonid);
+    int (*ShowNotification)(_THIS, const SDL_NotificationData *notificationdata);
 
     /* Tell window that app enabled drag'n'drop events */
     void (*AcceptDragAndDrop)(SDL_Window *window, SDL_bool accept);

src/video/SDL_video.c

@@ -5044,34 +5044,45 @@ void *SDL_Metal_GetLayer(SDL_MetalView view)
     }
 }
 
+int SDL_ShowNotification(const SDL_NotificationData *notificationdata)
+{
+    if (notificationdata == NULL) {
+        return SDL_InvalidParamError("notificationdata");
+    }
 
-#if defined(__LINUX__)
-#include "../core/linux/SDL_dbus.h"
-#endif
+    if (notificationdata->title == NULL) {
+        return SDL_InvalidParamError("notificationdata->title");
+    }
 
-static int SDL_PrivateShowNotification(Uint32 flags, const char *title, const char *message, SDL_Window *window, SDL_Icon *icon)
-{
-    int retval = -1;
+    if (notificationdata->message == NULL) {
+        return SDL_InvalidParamError("notificationdata->message");
+    }
 
-#if SDL_USE_LIBDBUS
-    /* Currently DBUS is initialized in X11 Video Init and needs to moved out */
-    if (retval == -1 &&
-        SDL_DBus_SendNotification(title, title, message) == SDL_TRUE) {
-        retval = 0;
+    if (notificationdata->icon.flags == SDL_ICON_TYPE_SINGLE_FILE && notificationdata->icon.data.path == NULL) {
+        return SDL_InvalidParamError("notificationdata->icon.dta.path");
     }
-#endif
 
-    if (retval == -1) {
-        retval = SDL_ShowSimpleMessageBox(0, title, message, window);
+    if (notificationdata->icon.flags == SDL_ICON_TYPE_SINGLE_FILE && notificationdata->icon.data.surface == NULL) {
+        return SDL_InvalidParamError("notificationdata->icon.data.surface");
     }
 
-    return retval;
+    if (notificationdata->icon.flags == SDL_ICON_TYPE_WINDOW && notificationdata->icon.data.window == NULL) {
+        return SDL_InvalidParamError("notificationdata->icon.data.window");
+    }
+
+    if (_this && _this->ShowNotification) {
+        return _this->ShowNotification(_this, notificationdata);
+    }
+
+    return SDL_Unsupported();
 }
 
-int SDL_ShowSimpleNotification(Uint32 flags, const char *title, const char *message, SDL_Window *window, SDL_Icon *icon)
+
+int SDL_ShowSimpleNotification(const char *title, const char *message)
 {
-    /* This is to allow expansion of the API later on.
-     Assuming you would create a notification which could then be updated later via a pointer.
-     This would be useful for progress notifications etc. */
-    return SDL_PrivateShowNotification(flags, title, message, window, icon);
+    SDL_NotificationData notificationdata;
+    SDL_zero(notificationdata);
+    notificationdata.title = title;
+    notificationdata.message = message;
+    return SDL_ShowNotification(&notificationdata);
 }

src/video/wayland/SDL_waylandvideo.c

@@ -162,6 +162,12 @@ static void Wayland_DeleteDevice(SDL_VideoDevice *device)
     SDL_WAYLAND_UnloadSymbols();
 }
 
+#ifdef SDL_USE_LIBDBUS
+static int Wayland_ShowNotification(_THIS, const SDL_NotificationData *notificationdata) {
+    return SDL_DBus_ShowNotification(notificationdata);
+}
+#endif
+
 static SDL_VideoDevice *Wayland_CreateDevice(void)
 {
     SDL_VideoDevice *device;
@@ -266,6 +272,10 @@ static SDL_VideoDevice *Wayland_CreateDevice(void)
     device->StopTextInput = Wayland_StopTextInput;
     device->SetTextInputRect = Wayland_SetTextInputRect;
 
+#ifdef SDL_USE_LIBDBUS
+    device->ShowNotification = Wayland_ShowNotification;
+#endif
+
 #if SDL_VIDEO_VULKAN
     device->Vulkan_LoadLibrary = Wayland_Vulkan_LoadLibrary;
     device->Vulkan_UnloadLibrary = Wayland_Vulkan_UnloadLibrary;

src/video/x11/SDL_x11video.c

@@ -140,6 +140,12 @@ static int X11_SafetyNetErrHandler(Display *d, XErrorEvent *e)
     return 0;
 }
 
+#ifdef SDL_USE_LIBDBUS
+static int X11_ShowNotification(_THIS, const SDL_NotificationData *notificationdata) {
+    return SDL_DBus_ShowNotification(notificationdata);
+}
+#endif
+
 static SDL_VideoDevice *X11_CreateDevice(void)
 {
     SDL_VideoDevice *device;
@@ -307,6 +313,10 @@ static SDL_VideoDevice *X11_CreateDevice(void)
     device->HideScreenKeyboard = X11_HideScreenKeyboard;
     device->IsScreenKeyboardShown = X11_IsScreenKeyboardShown;
 
+#ifdef SDL_USE_LIBDBUS
+    device->ShowNotification = X11_ShowNotification;
+#endif
+
     device->free = X11_DeleteDevice;
 
 #if SDL_VIDEO_VULKAN