david-swift 04c77831b5
Some checks are pending
Deploy Docs / publish (push) Waiting to run
SwiftLint / SwiftLint (push) Waiting to run
Remove Core library
2025-10-30 21:36:13 +01:00

127 lines
4.3 KiB
Swift

//
// Idle.swift
// Adwaita
//
// Created by david-swift on 12.08.24.
//
import CAdw
/// Add a task to GLib's idle.
public struct Idle {
/// The idle handler.
static let handler = IdleHandler()
/// Run a function whenever there are no higher priority events pending to the default main loop.
/// - Parameters:
/// - priority: The task's priority, default priority by default.
/// - closure: The closure to run.
@discardableResult
public init(
priority: Priority = .defaultIdle,
closure: @escaping () -> Void
) {
Self.handler.add({ closure(); return false }, priority: .init(priority.rawValue))
}
/// Repeat a function with a certain delay.
/// - Parameters:
/// - delay: The delay between the repetitions.
/// - priority: The task's priority, default priority by default.
/// - closure: The closure to run. Return if you want to exit the loop.
@discardableResult
@available(macOS, introduced: 13)
public init(
delay: Duration,
priority: Priority = .defaultIdle,
closure: @escaping () -> Bool
) {
let secondsToMilliseconds: Int64 = 1_000
let attosecondsToMilliseconds: Int64 = 1_000_000_000_000_000
let milliseconds = delay.components.seconds * secondsToMilliseconds
+ (delay.components.attoseconds / attosecondsToMilliseconds)
self.init(delay: milliseconds, priority: priority, closure: closure)
}
/// Repeat a function with a certain delay.
/// - Parameters:
/// - delay: The delay between the repetitions in milliseconds.
/// - priority: The task's priority, default priority by default.
/// - closure: The closure to run. Return if you want to exit the loop.
@discardableResult
@available(macOS, deprecated: 13)
public init(
delay: Int64,
priority: Priority = .defaultIdle,
closure: @escaping () -> Bool
) {
Self.handler.add(closure, priority: .init(priority.rawValue), delay: delay)
}
/// The priority of an idle task.
public enum Priority: Int {
/// A very low priority background task.
case low = 300
/// A high priority event source.
case high = -100
/// A default priority event source.
case `default` = 0
/// A high priority idle function.
case highIdle = 100
/// A default priority idle function.
case defaultIdle = 200
}
/// An idle handler.
class IdleHandler {
/// Execute the function.
/// - Parameter pointer: The closure wrapper's pointer.
static func run(pointer: gpointer?) -> Int32 {
if let pointer {
let container = Unmanaged<ClosureContainer>.fromOpaque(pointer).takeUnretainedValue()
let result = container.closure()
if !result {
Unmanaged<ClosureContainer>.fromOpaque(pointer).release()
}
return result.cBool
}
return G_SOURCE_REMOVE
}
/// Add a function to be called whenever there are no higher priority events pending to the default main loop.
/// - Parameter closure: The function.
func add(_ closure: @escaping () -> Bool, priority: Int32, delay: Int64? = nil) {
let context = UnsafeMutableRawPointer(Unmanaged.passRetained(ClosureContainer(closure: closure)).toOpaque())
if let delay {
// swiftlint:disable prefer_self_in_static_references
g_timeout_add_full(priority, .init(delay), { IdleHandler.run(pointer: $0) }, context, nil)
// swiftlint:enable prefer_self_in_static_references
} else {
// swiftlint:disable prefer_self_in_static_references
g_idle_add_full(priority, { IdleHandler.run(pointer: $0) }, context, nil)
// swiftlint:enable prefer_self_in_static_references
}
}
}
/// A reference type holding a closure.
class ClosureContainer {
/// The closure.
var closure: () -> Bool
/// Initialize an object.
/// - Parameter closure: The closure.
init(closure: @escaping () -> Bool) {
self.closure = closure
}
}
}