Refactor tray icon ID handling and accessors

Replaces direct access to the tray icon ID with a GetId() accessor method throughout the codebase. On macOS, tray icon IDs are now managed using Objective-C associated objects for better lifecycle management. Updates all usages to call GetId() instead of accessing the id member directly.

Author: lijy91

examples/window_example/main.cpp

@@ -82,7 +82,7 @@ int main() {
         "WVy6ENA/1l/"
         "XFg23zDhiRuqUXbBi1whJ9enqSQUWa7x3IcWHH0xDhLfUVYSpsWt6LMfZQwwX/"
         "wLVwWPG97osM9Wf7Df6GGOwnsP4BQFiPuOZ8wJUAAAAASUVORK5CYII=");
-    std::cout << "Tray ID: " << tray_icon.id << std::endl;
+    std::cout << "Tray ID: " << tray_icon.GetId() << std::endl;
     auto title = tray_icon.GetTitle();
     std::cout << "Tray Title: "
               << (title.has_value() ? title.value() : "(no title)")

src/capi/tray_icon_c.cpp

@@ -77,7 +77,7 @@ native_tray_icon_id_t native_tray_icon_get_id(native_tray_icon_t tray_icon) {
 
   try {
     auto tray_icon_ptr = static_cast<TrayIcon*>(tray_icon);
-    return tray_icon_ptr->id;
+    return tray_icon_ptr->GetId();
   } catch (...) {
     return -1;
   }

src/platform/linux/tray_icon_linux.cpp

@@ -5,6 +5,7 @@
 #include <iostream>
 #include <optional>
 #include <string>
+#include "../../foundation/id_allocator.h"
 #include "../../menu.h"
 #include "../../tray_icon.h"
 #include "../../tray_icon_event.h"
@@ -19,18 +20,20 @@ class TrayIcon::Impl {
         title_(std::nullopt),
         tooltip_(std::nullopt),
         context_menu_(nullptr),
-        visible_(false) {}
+        visible_(false) {
+    id_ = IdAllocator::Allocate<TrayIcon>();
+  }
 
   AppIndicator* app_indicator_;
   std::shared_ptr<Menu>
       context_menu_;  // Store menu shared_ptr to keep it alive
   std::optional<std::string> title_;
   std::optional<std::string> tooltip_;
   bool visible_;
+  TrayIconId id_;
 };
 
 TrayIcon::TrayIcon() : pimpl_(std::make_unique<Impl>(nullptr)) {
-  id = -1;
 
 #if HAS_GTK && HAS_AYATANA_APPINDICATOR
   // Create a unique ID for this tray icon
@@ -54,7 +57,6 @@ TrayIcon::TrayIcon() : pimpl_(std::make_unique<Impl>(nullptr)) {
 
 TrayIcon::TrayIcon(void* tray)
     : pimpl_(std::make_unique<Impl>((AppIndicator*)tray)) {
-  id = -1;  // Will be set by TrayManager when created
   // Make the indicator visible by default
   if (pimpl_->app_indicator_) {
     pimpl_->visible_ = true;
@@ -67,6 +69,10 @@ TrayIcon::~TrayIcon() {
   }
 }
 
+TrayIconId TrayIcon::GetId() {
+  return pimpl_->id_;
+}
+
 void TrayIcon::SetIcon(std::string icon) {
   if (!pimpl_->app_indicator_) {
     return;
@@ -88,7 +94,7 @@ void TrayIcon::SetIcon(std::string icon) {
         // Create a temporary file path
         const char* temp_dir = g_get_tmp_dir();
         std::string temp_path = std::string(temp_dir) +
-                                "/nativeapi_tray_icon_" + std::to_string(id) +
+                                "/nativeapi_tray_icon_" + std::to_string(GetId()) +
                                 ".png";
 
         // Write to file

src/platform/macos/tray_icon_macos.mm

@@ -6,6 +6,7 @@
 
 #import <Cocoa/Cocoa.h>
 #import <Foundation/Foundation.h>
+#import <objc/runtime.h>
 
 // Note: This file assumes ARC (Automatic Reference Counting) is enabled
 // for proper memory management of Objective-C objects.
@@ -15,11 +16,14 @@
 typedef void (^TrayIconRightClickedBlock)(nativeapi::TrayIconId tray_icon_id);
 typedef void (^TrayIconDoubleClickedBlock)(nativeapi::TrayIconId tray_icon_id);
 
+// Key for associated object to store tray icon ID
+static const void* kTrayIconIdKey = &kTrayIconIdKey;
+
 @interface NSStatusBarButtonTarget : NSObject
-@property(nonatomic, assign) nativeapi::TrayIcon* trayIcon;
 @property(nonatomic, copy) TrayIconClickedBlock leftClickedBlock;
 @property(nonatomic, copy) TrayIconRightClickedBlock rightClickedBlock;
 @property(nonatomic, copy) TrayIconDoubleClickedBlock doubleClickedBlock;
+@property(nonatomic, assign) nativeapi::TrayIcon* trayIcon;
 - (void)statusItemClicked:(id)sender;
 @end
 
@@ -33,6 +37,18 @@ - (void)statusItemClicked:(id)sender;
         ns_status_bar_button_target_(nil),
         menu_closed_listener_id_(0) {
     if (status_item) {
+      // Check if ID already exists in the associated object
+      NSNumber* allocatedId = objc_getAssociatedObject(status_item, kTrayIconIdKey);
+      if (allocatedId) {
+        // Reuse allocated ID
+        id_ = [allocatedId longValue];
+      } else {
+        // Allocate new ID and store it
+        id_ = IdAllocator::Allocate<TrayIcon>();
+        objc_setAssociatedObject(status_item, kTrayIconIdKey, [NSNumber numberWithLong:id_],
+                                 OBJC_ASSOCIATION_RETAIN_NONATOMIC);
+      }
+
       // Create and set up button target
       ns_status_bar_button_target_ = [[NSStatusBarButtonTarget alloc] init];
       ns_status_bar_button_target_.trayIcon = nullptr;  // Will be set later
@@ -71,6 +87,11 @@ - (void)statusItemClicked:(id)sender;
       }
       // Clear menu reference
       ns_status_item_.menu = nil;
+
+      // Clean up associated object
+      objc_setAssociatedObject(ns_status_item_, kTrayIconIdKey, nil,
+                               OBJC_ASSOCIATION_RETAIN_NONATOMIC);
+
       [[NSStatusBar systemStatusBar] removeStatusItem:ns_status_item_];
       ns_status_item_ = nil;
     }
@@ -83,15 +104,15 @@ - (void)statusItemClicked:(id)sender;
 
   NSStatusItem* ns_status_item_;
   NSStatusBarButtonTarget* ns_status_bar_button_target_;
+
+  TrayIconId id_;
   std::shared_ptr<Menu> context_menu_;
   size_t menu_closed_listener_id_;
 };
 
 TrayIcon::TrayIcon() : TrayIcon(nullptr) {}
 
 TrayIcon::TrayIcon(void* tray) {
-  id = IdAllocator::Allocate<TrayIcon>();
-
   NSStatusItem* status_item = nullptr;
 
   if (tray == nullptr) {
@@ -143,6 +164,10 @@ - (void)statusItemClicked:(id)sender;
   }
 }
 
+TrayIconId TrayIcon::GetId() {
+  return pimpl_->id_;
+}
+
 void TrayIcon::SetIcon(std::string icon) {
   if (!pimpl_->ns_status_item_ || !pimpl_->ns_status_item_.button) {
     return;
@@ -354,11 +379,11 @@ @implementation NSStatusBarButtonTarget
 
 - (void)statusItemClicked:(id)sender {
   // Check if trayIcon is still valid before proceeding
-  if (!_trayIcon)
+  if (!self.trayIcon)
     return;
 
   // Create a local reference to prevent race conditions
-  nativeapi::TrayIcon* trayIcon = _trayIcon;
+  nativeapi::TrayIcon* trayIcon = self.trayIcon;
   if (!trayIcon)
     return;
 
@@ -372,17 +397,17 @@ - (void)statusItemClicked:(id)sender {
        (event.modifierFlags & NSEventModifierFlagControl))) {
     // Right click or Ctrl+Left click
     if (_rightClickedBlock) {
-      _rightClickedBlock(trayIcon->id);
+      _rightClickedBlock(trayIcon->GetId());
     }
   } else if (event.type == NSEventTypeLeftMouseUp) {
     // Check for double click
     if (event.clickCount == 2) {
       if (_doubleClickedBlock) {
-        _doubleClickedBlock(trayIcon->id);
+        _doubleClickedBlock(trayIcon->GetId());
       }
     } else {
       if (_leftClickedBlock) {
-        _leftClickedBlock(trayIcon->id, "left");
+        _leftClickedBlock(trayIcon->GetId(), "left");
       }
     }
   }

src/platform/windows/tray_icon_windows.cpp

@@ -4,6 +4,7 @@
 #include <string>
 
 #include "../../foundation/geometry.h"
+#include "../../foundation/id_allocator.h"
 #include "../../menu.h"
 #include "../../tray_icon.h"
 #include "../../tray_icon_event.h"
@@ -14,10 +15,13 @@ namespace nativeapi {
 // Private implementation class
 class TrayIcon::Impl {
  public:
-  Impl() : hwnd_(nullptr), icon_id_(0), icon_handle_(nullptr) {}
+  Impl() : hwnd_(nullptr), icon_id_(0), icon_handle_(nullptr) {
+    id_ = IdAllocator::Allocate<TrayIcon>();
+  }
 
   Impl(HWND hwnd, UINT icon_id)
       : hwnd_(hwnd), icon_id_(icon_id), icon_handle_(nullptr) {
+    id_ = IdAllocator::Allocate<TrayIcon>();
     // Initialize NOTIFYICONDATA structure
     ZeroMemory(&nid_, sizeof(NOTIFYICONDATAW));
     nid_.cbSize = sizeof(NOTIFYICONDATAW);
@@ -50,14 +54,14 @@ class TrayIcon::Impl {
       switch (lParam) {
         case WM_LBUTTONUP:
           try {
-            tray_icon->EmitSync<TrayIconClickedEvent>(tray_icon->id, "left");
+            tray_icon->EmitSync<TrayIconClickedEvent>(tray_icon->GetId(), "left");
           } catch (...) {
             // Protect against event emission exceptions
           }
           break;
         case WM_RBUTTONUP:
           try {
-            tray_icon->EmitSync<TrayIconRightClickedEvent>(tray_icon->id);
+            tray_icon->EmitSync<TrayIconRightClickedEvent>(tray_icon->GetId());
           } catch (...) {
             // Protect against event emission exceptions
           }
@@ -67,7 +71,7 @@ class TrayIcon::Impl {
           break;
         case WM_LBUTTONDBLCLK:
           try {
-            tray_icon->EmitSync<TrayIconDoubleClickedEvent>(tray_icon->id);
+            tray_icon->EmitSync<TrayIconDoubleClickedEvent>(tray_icon->GetId());
           } catch (...) {
             // Protect against event emission exceptions
           }
@@ -92,9 +96,10 @@ class TrayIcon::Impl {
   NOTIFYICONDATAW nid_;
   std::shared_ptr<Menu> context_menu_;
   HICON icon_handle_;
+  TrayIconId id_;
 };
 
-TrayIcon::TrayIcon() : id(-1), pimpl_(std::make_unique<Impl>()) {
+TrayIcon::TrayIcon() : pimpl_(std::make_unique<Impl>()) {
   // Create a hidden window for this tray icon
   HINSTANCE hInstance = GetModuleHandle(nullptr);
 
@@ -128,14 +133,18 @@ TrayIcon::TrayIcon() : id(-1), pimpl_(std::make_unique<Impl>()) {
   }
 }
 
-TrayIcon::TrayIcon(void* tray) : id(-1), pimpl_(std::make_unique<Impl>()) {
+TrayIcon::TrayIcon(void* tray) : pimpl_(std::make_unique<Impl>()) {
   // In a real implementation, you'd extract HWND and icon ID from the tray
   // parameter For now, this constructor is mainly used by TrayManager for
   // creating uninitialized icons
 }
 
 TrayIcon::~TrayIcon() {}
 
+TrayIconId TrayIcon::GetId() {
+  return pimpl_->id_;
+}
+
 void TrayIcon::SetIcon(std::string icon) {
   if (!pimpl_->hwnd_) {
     return;

src/tray_icon.h

@@ -92,12 +92,11 @@ class TrayIcon : public EventEmitter, public NativeObjectProvider {
   virtual ~TrayIcon();
 
   /**
-   * @brief Unique identifier for this tray icon.
+   * @brief Get the unique identifier for this tray icon.
    *
-   * This ID is assigned by the TrayManager when the icon is created
-   * and can be used to reference the icon in subsequent operations.
+   * @return The unique identifier for this tray icon
    */
-  TrayIconId id;
+  TrayIconId GetId();
 
   /**
    * @brief Set the icon image for the tray icon.