Add support for macOS timers

Done by Abhishek in PR #10 but had gmail address.

Task-Id: SRNTY-40

Author: iamsergio

src/KDFoundation/CMakeLists.txt

@@ -82,6 +82,8 @@ elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
         platform/macos/macos_platform_event_loop.h
         platform/macos/macos_platform_integration.mm
         platform/macos/macos_platform_integration.h
+        platform/macos/macos_platform_timer.mm
+        platform/macos/macos_platform_timer.h
     )
 endif()
 

src/KDFoundation/platform/macos/macos_platform_event_loop.h

@@ -13,9 +13,12 @@
 
 #include <KDFoundation/platform/abstract_platform_event_loop.h>
 #include <KDFoundation/kdfoundation_global.h>
+#include <unordered_map>
 
 namespace KDFoundation {
 
+class MacOSPlatformTimer;
+
 class KDFOUNDATION_API MacOSPlatformEventLoop : public AbstractPlatformEventLoop
 {
 public:
@@ -37,6 +40,9 @@ class KDFOUNDATION_API MacOSPlatformEventLoop : public AbstractPlatformEventLoop
 private:
     void waitForEventsImpl(int timeout) override;
     std::unique_ptr<AbstractPlatformTimer> createPlatformTimerImpl(Timer *timer) override;
+
+    std::unordered_map<void *, MacOSPlatformTimer *> timerMap;
+    friend class MacOSPlatformTimer;
 };
 
 } // namespace KDFoundation

src/KDFoundation/platform/macos/macos_platform_event_loop.mm

@@ -10,15 +10,16 @@
 */
 
 #include "macos_platform_event_loop.h"
-
+#include "macos_platform_timer.h"
+#import <Foundation/Foundation.h>
 #import <AppKit/AppKit.h>
-
 #include <limits>
-
-using namespace KDFoundation;
+#include <memory>
 
 constexpr auto KDFoundationCocoaEventSubTypeWakeup = std::numeric_limits<short>::max();
 
+namespace KDFoundation {
+
 MacOSPlatformEventLoop::MacOSPlatformEventLoop()
 {
     @autoreleasepool {
@@ -78,9 +79,9 @@
     // TODO
     return false;
 }
-
 std::unique_ptr<AbstractPlatformTimer> MacOSPlatformEventLoop::createPlatformTimerImpl(Timer *timer)
 {
-    // TODO
-    return {};
+    return std::make_unique<MacOSPlatformTimer>(timer);
 }
+
+} // namespace KDFoundation

src/KDFoundation/platform/macos/macos_platform_timer.h

@@ -0,0 +1,39 @@
+/*
+  This file is part of KDUtils.
+
+  SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  Author: Paul Lemire <paul.lemire@kdab.com>
+
+  SPDX-License-Identifier: MIT
+
+  Contact KDAB at <info@kdab.com> for commercial licensing options.
+*/
+
+#pragma once
+
+#include <CoreFoundation/CoreFoundation.h>
+
+#include <chrono>
+
+#include <KDFoundation/platform/abstract_platform_timer.h>
+#include <KDFoundation/file_descriptor_notifier.h>
+
+namespace KDFoundation {
+
+class Timer;
+
+class KDFOUNDATION_API MacOSPlatformTimer : public AbstractPlatformTimer
+{
+public:
+    explicit MacOSPlatformTimer(Timer *timer);
+    ~MacOSPlatformTimer() override;
+
+private:
+    void arm(std::chrono::microseconds us);
+    void disarm();
+    static void timerFired(CFRunLoopTimerRef timer, void *info);
+    Timer *m_handler;
+    CFRunLoopTimerRef cfTimer;
+};
+
+} // namespace KDFoundation

src/KDFoundation/platform/macos/macos_platform_timer.mm

@@ -0,0 +1,98 @@
+/*
+  This file is part of KDUtils.
+
+  SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
+  Author: Paul Lemire <paul.lemire@kdab.com>
+
+  SPDX-License-Identifier: MIT
+
+  Contact KDAB at <info@kdab.com> for commercial licensing options.
+*/
+
+#include "macos_platform_timer.h"
+#include "macos_platform_event_loop.h"
+#include <Foundation/Foundation.h>
+#include <algorithm>
+#include <cassert>
+#include <chrono>
+#include <cstddef>
+#include <type_traits>
+#include <unistd.h>
+#include "KDFoundation/core_application.h"
+#include "KDFoundation/timer.h"
+#include "KDFoundation/platform/macos/macos_platform_event_loop.h"
+
+using namespace KDFoundation;
+
+inline MacOSPlatformEventLoop *eventLoop()
+{
+    return static_cast<MacOSPlatformEventLoop *>(CoreApplication::instance()->eventLoop());
+}
+
+MacOSPlatformTimer::MacOSPlatformTimer(Timer *timer)
+    : m_handler{ timer }, cfTimer{ nullptr }
+{
+    timer->running.valueChanged().connect([this, timer](bool running) {
+        if (running) {
+            arm(timer->interval.get());
+        } else {
+            disarm();
+        }
+    });
+    timer->interval.valueChanged().connect([this, timer]() {
+        if (timer->running.get()) {
+            arm(timer->interval.get());
+        }
+    });
+}
+
+MacOSPlatformTimer::~MacOSPlatformTimer()
+{
+    disarm();
+}
+
+void MacOSPlatformTimer::timerFired(CFRunLoopTimerRef timer, void *info)
+{
+    MacOSPlatformEventLoop *ev = eventLoop();
+    void *key = timer;
+    if (auto it = ev->timerMap.find(key); it != ev->timerMap.end()) {
+        it->second->m_handler->timeout.emit();
+    }
+}
+
+void MacOSPlatformTimer::arm(std::chrono::microseconds us)
+{
+    if (cfTimer) {
+        disarm();
+    }
+
+    CFTimeInterval interval = std::chrono::duration_cast<std::chrono::duration<double>>(us).count();
+    CFRunLoopTimerContext timerContext = { 0, NULL, NULL, NULL, NULL };
+    CFAbsoluteTime fireDate = CFAbsoluteTimeGetCurrent() + interval;
+    // Create the timer
+    cfTimer = CFRunLoopTimerCreate(
+            kCFAllocatorDefault, // Allocator
+            fireDate, // Fire time
+            interval, // Interval
+            0, // Flags
+            0, // Order
+            timerFired, // Callback function
+            &timerContext // Timer context
+    );
+    CFRunLoopAddTimer(CFRunLoopGetCurrent(), cfTimer, kCFRunLoopCommonModes);
+
+    if (cfTimer) {
+        void *key = reinterpret_cast<void *>(cfTimer);
+        eventLoop()->timerMap[key] = this;
+    }
+}
+
+void MacOSPlatformTimer::disarm()
+{
+    if (cfTimer) {
+        void *key = reinterpret_cast<void *>(cfTimer);
+        eventLoop()->timerMap.erase(key);
+        CFRelease(cfTimer);
+        cfTimer = nullptr;
+    }
+}

tests/auto/foundation/core_application/tst_core_application.cpp

@@ -187,8 +187,7 @@ TEST_CASE("Event handling")
     }
 }
 
-#ifndef KD_PLATFORM_MACOS
-TEST_CASE("Timer handling")
+TEST_CASE("Timer handling" * doctest::timeout(120))
 {
     SUBCASE("timer fires correctly")
     {
@@ -204,15 +203,18 @@ TEST_CASE("Timer handling")
         auto time = startTime;
         std::ignore = timer.timeout.connect([&]() {
             const auto endTime = std::chrono::steady_clock::now();
+            const auto elapsedTime = std::chrono::duration_cast<std::chrono::milliseconds>(endTime - time).count();
+            SPDLOG_INFO("elapsedTime = {}", elapsedTime);
             REQUIRE(endTime - time > 50ms);
-            REQUIRE(endTime - time < 150ms);
+            REQUIRE(endTime - time < 250ms);
             time = endTime;
             timeout++;
         });
 
         while (std::chrono::steady_clock::now() - startTime < 500ms) {
             app.processEvents(500);
         }
+        SPDLOG_INFO("timeout = {}", timeout);
         REQUIRE(timeout > 3);
         REQUIRE(timeout < 8);
 
@@ -260,7 +262,6 @@ TEST_CASE("Timer handling")
         REQUIRE(fired == true);
     }
 }
-#endif
 
 TEST_CASE("Main event loop")
 {