feat: unify backends with QT

Author: ReenigneArcher

.github/workflows/ci.yml

@@ -52,7 +52,7 @@ jobs:
         include:
           - os: macos-latest
             shell: "bash"
-            qt_version: ''
+            qt_version: '6'
           - os: ubuntu-latest
             shell: "bash"
             qt_version: '5'
@@ -61,7 +61,7 @@ jobs:
             qt_version: '6'
           - os: windows-latest
             shell: "msys2 {0}"
-            qt_version: ''
+            qt_version: '6'
     steps:
       - name: Checkout
         uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10  # v6.0.3
@@ -118,6 +118,8 @@ jobs:
             "imagemagick"
             "ninja"
             "node"
+            "qtbase"
+            "qtsvg"
           )
           brew install "${dependencies[@]}"
 
@@ -171,6 +173,8 @@ jobs:
             mingw-w64-ucrt-x86_64-ninja
             mingw-w64-ucrt-x86_64-nodejs
             mingw-w64-ucrt-x86_64-toolchain
+            mingw-w64-ucrt-x86_64-qt6-base
+            mingw-w64-ucrt-x86_64-qt6-svg
 
       - name: Setup python
         id: setup-python

CMakeLists.txt

@@ -67,32 +67,30 @@ function(tray_copy_default_icons target_name)
     endforeach()
 endfunction()
 
-if(WIN32)
-    list(APPEND TRAY_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/src/tray_windows.c")
+find_package(Qt6 COMPONENTS Widgets Svg)
+if(Qt6_FOUND)
+    set(TRAY_QT_VERSION 6)
 else()
-    if(UNIX)
-        if(APPLE)
-            find_library(COCOA Cocoa REQUIRED)
-            list(APPEND TRAY_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/src/tray_darwin.m")
-        else()
-            find_package(LibNotify REQUIRED)
-            find_package(Qt6 COMPONENTS Widgets Svg)
-            if(Qt6_FOUND)
-                set(TRAY_QT_VERSION 6)
-            else()
-                find_package(Qt5 REQUIRED COMPONENTS Widgets Svg)
-                set(TRAY_QT_VERSION 5)
-            endif()
-            set(TRAY_QT_VERSION  # cmake-lint: disable=C0103
-                    "${TRAY_QT_VERSION}"
-                    CACHE INTERNAL "Qt major version selected by tray"
-            )
-            set(CMAKE_AUTOMOC ON)
-            list(APPEND TRAY_SOURCES
-                    "${CMAKE_CURRENT_SOURCE_DIR}/src/tray_linux.cpp"
-                    "${CMAKE_CURRENT_SOURCE_DIR}/src/QtTrayMenu.cpp"
-            )
-        endif()
+    find_package(Qt5 REQUIRED COMPONENTS Widgets Svg)
+    set(TRAY_QT_VERSION 5)
+endif()
+set(TRAY_QT_VERSION  # cmake-lint: disable=C0103
+        "${TRAY_QT_VERSION}"
+        CACHE INTERNAL "Qt major version selected by tray"
+)
+set(CMAKE_AUTOMOC ON)
+list(APPEND TRAY_SOURCES
+        "${CMAKE_CURRENT_SOURCE_DIR}/src/tray_qt.cpp"
+        "${CMAKE_CURRENT_SOURCE_DIR}/src/QtTrayMenu.cpp"
+)
+
+if(UNIX AND NOT APPLE)
+    find_package(LibNotify)
+    if(LIBNOTIFY_FOUND)
+        list(APPEND TRAY_COMPILE_DEFINITIONS TRAY_USE_LIBNOTIFY=1)
+        list(APPEND TRAY_EXTERNAL_LIBRARIES ${LIBNOTIFY_LIBRARIES})
+        list(APPEND TRAY_EXTERNAL_DIRECTORIES ${LIBNOTIFY_LIBRARY_DIRS})
+        list(APPEND TRAY_EXTERNAL_INCLUDES ${LIBNOTIFY_INCLUDE_DIRS})
     endif()
 endif()
 
@@ -104,27 +102,32 @@ target_include_directories(${PROJECT_NAME}
         $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src>
         $<INSTALL_INTERFACE:include>)
 
-if(WIN32)
-    if(MSVC)
-        list(APPEND TRAY_COMPILE_OPTIONS "/MT$<$<CONFIG:Debug>:d>")
-    endif()
+if(WIN32 AND MSVC)
+    list(APPEND TRAY_COMPILE_OPTIONS "/MT$<$<CONFIG:Debug>:d>")
+endif()
+
+if(TRAY_QT_VERSION EQUAL 6)
+    list(APPEND TRAY_EXTERNAL_LIBRARIES Qt6::Widgets Qt6::Svg)
 else()
-    if(UNIX)
-        if(APPLE)
-            list(APPEND TRAY_EXTERNAL_LIBRARIES ${COCOA})
-        else()
-            if(TRAY_QT_VERSION EQUAL 6)
-                list(APPEND TRAY_EXTERNAL_LIBRARIES Qt6::Widgets Qt6::Svg)
-            else()
-                list(APPEND TRAY_EXTERNAL_LIBRARIES Qt5::Widgets Qt5::Svg)
-            endif()
-            list(APPEND TRAY_LIBNOTIFY=1)
-            list(APPEND TRAY_EXTERNAL_LIBRARIES ${LIBNOTIFY_LIBRARIES})
-
-            include_directories(SYSTEM ${LIBNOTIFY_INCLUDE_DIRS})
-            link_directories(${LIBNOTIFY_LIBRARY_DIRS})
+    list(APPEND TRAY_EXTERNAL_LIBRARIES Qt5::Widgets Qt5::Svg)
+endif()
+
+if(TRAY_EXTERNAL_INCLUDES)
+    target_include_directories(${PROJECT_NAME}
+            SYSTEM PRIVATE
+            ${TRAY_EXTERNAL_INCLUDES})
+endif()
+
+if(TRAY_COMPILE_DEFINITIONS)
+    target_compile_definitions(${PROJECT_NAME} PRIVATE ${TRAY_COMPILE_DEFINITIONS})
+endif()
+
+if(TRAY_EXTERNAL_DIRECTORIES)
+    foreach(TRAY_EXTERNAL_DIRECTORY IN LISTS TRAY_EXTERNAL_DIRECTORIES)
+        if(TRAY_EXTERNAL_DIRECTORY)
+            target_link_directories(${PROJECT_NAME} PRIVATE "${TRAY_EXTERNAL_DIRECTORY}")
         endif()
-    endif()
+    endforeach()
 endif()
 
 add_library(tray::tray ALIAS ${PROJECT_NAME})
@@ -142,7 +145,6 @@ if(TRAY_IS_TOP_LEVEL)
 endif()
 
 target_compile_options(${PROJECT_NAME} PRIVATE ${TRAY_COMPILE_OPTIONS})
-target_link_directories(${PROJECT_NAME} PRIVATE ${TRAY_EXTERNAL_DIRECTORIES})
 target_link_libraries(${PROJECT_NAME} PRIVATE ${TRAY_EXTERNAL_LIBRARIES})
 
 #

README.md

@@ -6,9 +6,9 @@
 
 ## About
 
-Cross-platform, super tiny C99 implementation of a system tray icon with a popup menu and notifications.
+Cross-platform C++17 Qt-backed system tray icon with a popup menu and notifications.
 
-The code is C++ friendly and will compile fine in C++98 and up. This is a fork of
+This is a fork of
 [dmikushin/tray](https://github.com/dmikushin/tray) and is intended to add additional features required for our own
 [Sunshine](https://github.com/LizardByte/Sunshine) project.
 
@@ -32,18 +32,20 @@ This fork adds the following features:
 
 ## Supported platforms
 
-* Linux/Qt (Qt5 or Qt6 Widgets)
-* Windows XP or newer (shellapi.h)
-* MacOS (Cocoa/AppKit)
+* Linux with Qt5 or Qt6 Widgets
+* macOS with Qt5 or Qt6 Widgets
+* Windows with Qt5 or Qt6 Widgets
 
 ## Prerequisites
 
 * CMake
 * [Ninja](https://ninja-build.org/), to have the same build commands on all platforms.
+* C++17 compiler
+* Qt5 or Qt6 Widgets and Svg modules
 
-### Linux Dependencies
+### Platform Dependencies
 
-Install either Qt6 _or_ Qt5 as well as libnotify development packages. The Linux backend requires libnotify and Qt Widgets+Svg modules.
+Install either Qt6 _or_ Qt5. Linux builds can also use libnotify when the development package is available.
 
 <div class="tabbed">
 
@@ -74,6 +76,20 @@ Install either Qt6 _or_ Qt5 as well as libnotify development packages. The Linux
     sudo dnf install qt5-qtbase-devel qt5-qtsvg-devel libnotify-devel
     ```
 
+- <b class="tab-title">macOS</b>
+    ```bash
+    brew install cmake ninja qtbase qtsvg
+    ```
+
+- <b class="tab-title">Windows (MSYS2 UCRT64)</b>
+    ```bash
+    pacman -S mingw-w64-ucrt-x86_64-cmake \
+      mingw-w64-ucrt-x86_64-ninja \
+      mingw-w64-ucrt-x86_64-toolchain \
+      mingw-w64-ucrt-x86_64-qt6-base \
+      mingw-w64-ucrt-x86_64-qt6-svg
+    ```
+
 </div>
 
 ## Building

docs/Doxyfile

@@ -24,14 +24,13 @@
 # project metadata
 DOCSET_BUNDLE_ID = dev.lizardbyte.tray
 DOCSET_PUBLISHER_ID = dev.lizardbyte.tray.documentation
-PROJECT_BRIEF = "Cross-platform, super tiny C99 implementation of a system tray icon with a popup menu and notifications."
+PROJECT_BRIEF = "Cross-platform C++17 Qt-backed system tray icon with a popup menu and notifications."
 PROJECT_NAME = tray
 
 # project specific settings
 DOT_GRAPH_MAX_NODES = 50
 IMAGE_PATH = ../docs/images
 INCLUDE_PATH =
-PREDEFINED += TRAY_WINAPI
 
 # files and directories to process
 USE_MDFILE_AS_MAINPAGE = ../README.md

src/QtTrayMenu.cpp

@@ -250,33 +250,35 @@ struct tray_menu *QtTrayMenu::getTrayMenuItem(QAction *action) {  // NOSONAR(cpp
 }
 
 void QtTrayMenu::onMessageClicked() const {
-  if (notificationCallback != nullptr) {
-    notificationCallback();
+  if (notificationCallback == nullptr) {
+    return;
   }
+
+  auto callback = std::move(notificationCallback);
+  notificationCallback = nullptr;
+  callback();
 }
 
 void QtTrayMenu::configureAppMetadata(const QString &appName, const QString &appDisplayName, const QString &desktopName) const {
   const QString effective_name = !appName.isEmpty() ? appName : QStringLiteral("tray");
-  if (QApplication::applicationName().isEmpty()) {
+  if (!appName.isEmpty() || QApplication::applicationName().isEmpty() || QApplication::applicationName() == QStringLiteral("TrayMenuApp")) {
     QApplication::setApplicationName(effective_name);
   }
 
-  if (QApplication::applicationDisplayName().isEmpty()) {
-    if (!appDisplayName.isEmpty()) {
-      QApplication::setApplicationDisplayName(appDisplayName);
-    } else {
-      const QString display_name =
-        (trayStruct && trayStruct->tooltip) ? QString::fromUtf8(trayStruct->tooltip) : effective_name;
-      QApplication::setApplicationDisplayName(display_name);
-    }
+  if (!appDisplayName.isEmpty()) {
+    QApplication::setApplicationDisplayName(appDisplayName);
+  } else if (QApplication::applicationDisplayName().isEmpty()) {
+    const QString display_name =
+      (trayStruct && trayStruct->tooltip) ? QString::fromUtf8(trayStruct->tooltip) : effective_name;
+    QApplication::setApplicationDisplayName(display_name);
   }
 
-  if (!QApplication::desktopFileName().isEmpty()) {
+  if (!desktopName.isEmpty()) {
+    QApplication::setDesktopFileName(desktopName);
     return;
   }
 
-  if (!desktopName.isEmpty()) {
-    QApplication::setDesktopFileName(desktopName);
+  if (!QApplication::desktopFileName().isEmpty()) {
     return;
   }
 
@@ -347,3 +349,7 @@ void QtTrayMenu::clickMessage() const {
   }
   emit trayIcon->messageClicked();
 }
+
+void QtTrayMenu::clearMessageCallback() const {
+  notificationCallback = nullptr;
+}

src/QtTrayMenu.h

@@ -101,6 +101,11 @@ class QtTrayMenu: public QObject {
    */
   void clickMessage() const;
 
+  /**
+   * @brief Clear the stored popup message callback
+   */
+  void clearMessageCallback() const;
+
   /**
    * @brief Check if QtTrayMenu supports messages
    * @return true if messages can be shown
@@ -137,7 +142,7 @@ class QtTrayMenu: public QObject {
   bool running = false;
   bool blockingEventLoop = false;
   struct tray_menu *getTrayMenuItem(QAction *action);
-  std::function<void()> notificationCallback = nullptr;
+  mutable std::function<void()> notificationCallback = nullptr;
 
 private slots:
   void onExitRequested();

src/example.c

@@ -9,13 +9,8 @@
 // local includes
 #include "tray.h"
 
-#if defined(_WIN32)
-  #define TRAY_ICON1 "icon.ico"  ///< Path to first icon.
-  #define TRAY_ICON2 "icon.ico"  ///< Path to second icon.
-#else
-  #define TRAY_ICON1 "icon.png"
-  #define TRAY_ICON2 "icon.png"
-#endif
+#define TRAY_ICON1 "icon.png"  ///< Path to first icon.
+#define TRAY_ICON2 "icon.png"  ///< Path to second icon.
 
 static struct tray tray;
 

src/tray.h

@@ -5,10 +5,6 @@
 #ifndef TRAY_H
 #define TRAY_H
 
-#if defined(_WIN32)
-  #include <Windows.h>
-#endif
-
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -77,17 +73,15 @@ extern "C" {
   /**
    * @brief Simulate a notification click, invoking the notification callback (for testing purposes).
    *
-   * On Linux (Qt): triggers the stored notification callback as if the user clicked the notification.
-   * On other platforms: no-op.
+   * Triggers the stored notification callback as if the user clicked the notification.
    */
   void tray_simulate_notification_click(void);
 
   /**
    * @brief Simulate clicking a top-level menu item by index (for testing purposes).
    *
-   * On Linux (Qt): triggers the QAction associated with the given top-level menu
-   * index (separators and submenus are ignored).
-   * On other platforms: no-op.
+   * Triggers the QAction associated with the given top-level menu index
+   * (separators and submenus are ignored).
    *
    * @param index Zero-based index in the top-level tray menu.
    */
@@ -101,9 +95,8 @@ extern "C" {
   /**
    * @brief Set a callback for log messages produced by the tray library.
    *
-   * On Linux the callback is installed as a Qt message handler so all Qt
-   * diagnostic output is routed through it. On other platforms this function
-   * is a no-op.
+   * The callback is installed as a Qt message handler so all Qt diagnostic
+   * output is routed through it.
    *
    * @param cb Callback invoked with level (0=debug, 1=info, 2=warning, 3=error)
    *   and the message string. Pass NULL to restore the default logging behaviour.
@@ -113,9 +106,8 @@ extern "C" {
   /**
    * @brief Set application metadata used by the tray library.
    *
-   * Must be called before tray_init(). On Linux (Qt), sets the Qt application
-   * name, display name, and desktop file name used for D-Bus registration. On
-   * other platforms this function is a no-op.
+   * Must be called before tray_init(). Sets the Qt application name, display
+   * name, and desktop file name.
    *
    * @param app_name Application name used as a technical identifier (e.g., for
    *   D-Bus registration). Converted to lowercase automatically. NULL uses the
@@ -127,14 +119,6 @@ extern "C" {
    */
   void tray_set_app_info(const char *app_name, const char *app_display_name, const char *desktop_name);
 
-#if defined(_WIN32)
-  /**
-   * @brief Get the tray window handle.
-   * @return The window handle.
-   */
-  HWND tray_get_hwnd(void);
-#endif
-
 #ifdef __cplusplus
 }  // extern "C"
 #endif