blob: 8925d242de8e898362e64d7b1e2d29c1debc8d31 [file] [log] [blame]
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
import CoreFoundation
internal func __NSFireTimer(_ timer: CFRunLoopTimer?, info: UnsafeMutablePointer<Void>?) -> Void {
let t: Timer = NSObject.unretainedReference(info!)
t._fire(t)
}
public class Timer: NSObject {
typealias CFType = CFRunLoopTimer
internal var _cfObject: CFType {
get {
return _timer!
}
set {
_timer = newValue
}
}
internal var _timer: CFRunLoopTimer? // has to be optional because this is a chicken/egg problem with initialization in swift
internal var _fire: (Timer) -> Void = { (_: Timer) in }
/// Alternative API for timer creation with a block.
/// - Experiment: This is a draft API currently under consideration for official import into Foundation as a suitable alternative to creation via selector
/// - Note: Since this API is under consideration it may be either removed or revised in the near future
/// - Warning: Capturing the timer or the owner of the timer inside of the block may cause retain cycles. Use with caution
public init(fire date: Date, interval: TimeInterval, repeats: Bool, block: (Timer) -> Swift.Void) {
super.init()
_fire = block
var context = CFRunLoopTimerContext()
withRetainedReference {
context.info = $0
}
let timer = withUnsafeMutablePointer(&context) { (ctx: UnsafeMutablePointer<CFRunLoopTimerContext>) -> CFRunLoopTimer in
var t = interval
if !repeats {
t = 0.0
}
return CFRunLoopTimerCreate(kCFAllocatorSystemDefault, date.timeIntervalSinceReferenceDate, t, 0, 0, __NSFireTimer, ctx)
}
_timer = timer
}
/// Alternative API for timer creation with a block.
/// - Experiment: This is a draft API currently under consideration for official import into Foundation as a suitable alternative to creation via selector
/// - Note: Since this API is under consideration it may be either removed or revised in the near future
/// - Warning: Capturing the timer or the owner of the timer inside of the block may cause retain cycles. Use with caution
public class func scheduledTimer(withTimeInterval interval: TimeInterval, repeats: Bool, block: (Timer) -> Void) -> Timer {
let timer = Timer(fire: Date(timeIntervalSinceNow: interval), interval: interval, repeats: repeats, block: block)
CFRunLoopAddTimer(CFRunLoopGetCurrent(), timer._timer!, kCFRunLoopDefaultMode)
return timer
}
public func fire() {
if !valid {
return
}
_fire(self)
if timeInterval == 0.0 {
invalidate()
}
}
public var fireDate: Date {
get {
return Date(timeIntervalSinceReferenceDate: CFRunLoopTimerGetNextFireDate(_timer!))
}
set {
CFRunLoopTimerSetNextFireDate(_timer!, newValue.timeIntervalSinceReferenceDate)
}
}
public var timeInterval: TimeInterval {
return CFRunLoopTimerGetInterval(_timer!)
}
public var tolerance: TimeInterval {
get {
return CFRunLoopTimerGetTolerance(_timer!)
}
set {
CFRunLoopTimerSetTolerance(_timer!, newValue)
}
}
public func invalidate() {
CFRunLoopTimerInvalidate(_timer!)
}
public var valid: Bool {
return CFRunLoopTimerIsValid(_timer!)
}
}