1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
|
// 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
//
@_implementationOnly import CoreFoundation
internal import Synchronization
private let registeredDefaults = Mutex<[String: (Any & Sendable)]>([:])
private nonisolated(unsafe) var sharedDefaults = UserDefaults() // the default one is thread safe, at least
fileprivate func bridgeFromNSCFTypeIfNeeded(_ value: Any) -> Any {
let object = value as AnyObject
return __SwiftValue.fetch(nonOptional: object)
}
@available(*, unavailable)
extension UserDefaults : @unchecked Sendable { }
open class UserDefaults: NSObject {
static private func _isValueAllowed(_ nonbridgedValue: Any) -> Bool {
let value = bridgeFromNSCFTypeIfNeeded(nonbridgedValue)
if let value = value as? [Any] {
for innerValue in value {
if !_isValueAllowed(innerValue) {
return false
}
}
return true
}
if let value = value as? [AnyHashable: Any] {
for (key, innerValue) in value {
if !(key is String) {
return false
}
if !_isValueAllowed(innerValue) {
return false
}
}
return true
}
// NSNumber doesn't quite bridge -- treat it specially.
if value is NSNumber {
return true
}
let isOfCommonTypes = value is String || value is Data || value is Date || value is Int || value is Bool || value is CGFloat
if isOfCommonTypes {
return true
}
let isOfUncommonNumericTypes = value is Double || value is Float || value is Int8 || value is UInt8 || value is Int16 || value is UInt16 || value is Int32 || value is UInt32 || value is Int64 || value is UInt64
return isOfUncommonNumericTypes
}
static private func _unboxingNSNumbers(_ value: Any?) -> Any? {
if value == nil {
return nil
}
if let number = value as? NSNumber {
return number._swiftValueOfOptimalType
}
if let value = value as? [Any] {
return value.map(_unboxingNSNumbers)
}
if let value = value as? [AnyHashable: Any] {
return value.mapValues(_unboxingNSNumbers)
}
return value
}
private let suite: String?
open class var standard: UserDefaults {
return sharedDefaults
}
open class func resetStandardUserDefaults() {}
public convenience override init() {
self.init(suiteName: nil)!
}
/// nil suite means use the default search list that +standardUserDefaults uses
public init?(suiteName suitename: String?) {
suite = suitename
super.init()
setVolatileDomain(UserDefaults._parsedArgumentsDomain, forName: UserDefaults.argumentDomain)
}
open func object(forKey defaultName: String) -> Any? {
let argumentDomain = volatileDomain(forName: UserDefaults.argumentDomain)
if let object = argumentDomain[defaultName] {
return object
}
func getFromRegistered() -> Any? {
registeredDefaults.withLock {
UserDefaults._unboxingNSNumbers($0[defaultName])
}
}
guard let anObj = CFPreferencesCopyAppValue(defaultName._cfObject, suite?._cfObject ?? kCFPreferencesCurrentApplication) else {
return getFromRegistered()
}
if let fetched = __SwiftValue.fetch(anObj) {
return UserDefaults._unboxingNSNumbers(fetched)
} else {
return nil
}
}
open func set(_ value: Any?, forKey defaultName: String) {
guard let value = value else {
CFPreferencesSetAppValue(defaultName._cfObject, nil, suite?._cfObject ?? kCFPreferencesCurrentApplication)
return
}
if let url = value as? URL {
set(url.absoluteURL.path, forKey: defaultName)
return
}
if let url = value as? NSURL, let path = url.absoluteURL?.path {
set(path, forKey: defaultName)
return
}
guard UserDefaults._isValueAllowed(value) else {
fatalError("This value is not supported by set(_:forKey:)")
}
CFPreferencesSetAppValue(defaultName._cfObject, __SwiftValue.store(value), suite?._cfObject ?? kCFPreferencesCurrentApplication)
}
open func removeObject(forKey defaultName: String) {
CFPreferencesSetAppValue(defaultName._cfObject, nil, suite?._cfObject ?? kCFPreferencesCurrentApplication)
}
open func string(forKey defaultName: String) -> String? {
guard let aVal = object(forKey: defaultName) else {
return nil
}
if let bVal = aVal as? String {
return bVal
}
if let bVal = aVal as? Bool {
return NSNumber(value: bVal).stringValue
}
if let bVal = aVal as? Int {
return NSNumber(value: bVal).stringValue
}
if let bVal = aVal as? Float {
return NSNumber(value: bVal).stringValue
}
if let bVal = aVal as? Double {
return NSNumber(value: bVal).stringValue
}
return nil
}
open func array(forKey defaultName: String) -> [Any]? {
return object(forKey: defaultName) as? [Any]
}
open func dictionary(forKey defaultName: String) -> [String : Any]? {
return object(forKey: defaultName) as? [String: Any]
}
open func data(forKey defaultName: String) -> Data? {
return object(forKey: defaultName) as? Data
}
open func stringArray(forKey defaultName: String) -> [String]? {
return object(forKey: defaultName) as? [String]
}
open func integer(forKey defaultName: String) -> Int {
guard let aVal = object(forKey: defaultName) else {
return 0
}
if let bVal = aVal as? Int {
return bVal
}
if let bVal = aVal as? Bool {
return NSNumber(value: bVal).intValue
}
if let bVal = aVal as? Float {
return NSNumber(value: bVal).intValue
}
if let bVal = aVal as? Double {
return NSNumber(value: bVal).intValue
}
if let bVal = aVal as? String {
return NSString(string: bVal).integerValue
}
return 0
}
open func float(forKey defaultName: String) -> Float {
guard let aVal = object(forKey: defaultName) else {
return 0
}
if let bVal = aVal as? Float {
return bVal
}
if let bVal = aVal as? Bool {
return NSNumber(value: bVal).floatValue
}
if let bVal = aVal as? Int {
return NSNumber(value: bVal).floatValue
}
if let bVal = aVal as? Double {
return NSNumber(value: bVal).floatValue
}
if let bVal = aVal as? String {
return NSString(string: bVal).floatValue
}
return 0
}
open func double(forKey defaultName: String) -> Double {
guard let aVal = object(forKey: defaultName) else {
return 0
}
if let bVal = aVal as? Double {
return bVal
}
if let bVal = aVal as? Bool {
return NSNumber(value: bVal).doubleValue
}
if let bVal = aVal as? Int {
return NSNumber(value: bVal).doubleValue
}
if let bVal = aVal as? Float {
return NSNumber(value: bVal).doubleValue
}
if let bVal = aVal as? String {
return NSString(string: bVal).doubleValue
}
return 0
}
open func bool(forKey defaultName: String) -> Bool {
guard let aVal = object(forKey: defaultName) else {
return false
}
if let bVal = aVal as? Bool {
return bVal
}
if let bVal = aVal as? Int {
return bVal != 0
}
if let bVal = aVal as? Float {
return bVal != 0
}
if let bVal = aVal as? Double {
return bVal != 0
}
if let bVal = aVal as? String {
return NSString(string: bVal).boolValue
}
return false
}
open func url(forKey defaultName: String) -> URL? {
guard let aVal = object(forKey: defaultName) else {
return nil
}
if let bVal = aVal as? URL {
return bVal
} else if let bVal = aVal as? String {
let cVal = NSString(string: bVal).expandingTildeInPath
return URL(fileURLWithPath: cVal)
} else if let bVal = aVal as? Data {
return NSKeyedUnarchiver.unarchiveObject(with: bVal) as? URL
}
return nil
}
open func set(_ value: Int, forKey defaultName: String) {
set(NSNumber(value: value), forKey: defaultName)
}
open func set(_ value: Float, forKey defaultName: String) {
set(NSNumber(value: value), forKey: defaultName)
}
open func set(_ value: Double, forKey defaultName: String) {
set(NSNumber(value: value), forKey: defaultName)
}
open func set(_ value: Bool, forKey defaultName: String) {
set(NSNumber(value: value), forKey: defaultName)
}
open func set(_ url: URL?, forKey defaultName: String) {
if let url = url {
//FIXME: CFURLIsFileReferenceURL is limited to macOS/iOS
#if os(macOS) || os(iOS)
//FIXME: no SwiftFoundation version of CFURLIsFileReferenceURL at time of writing!
if CFURLIsFileReferenceURL(url._cfObject) {
let data = NSKeyedArchiver.archivedData(withRootObject: url._nsObject)
set(data._nsObject, forKey: defaultName)
return
}
#endif
set(url.path._nsObject, forKey: defaultName)
} else {
set(nil, forKey: defaultName)
}
}
open func register(defaults registrationDictionary: [String : Any]) {
// The 'Any' values here must be Property List types, which are all Sendable
nonisolated(unsafe) let copy = registrationDictionary
registeredDefaults.withLock {
$0.merge(copy.mapValues(bridgeFromNSCFTypeIfNeeded), uniquingKeysWith: { $1 })
}
}
open func addSuite(named suiteName: String) {
CFPreferencesAddSuitePreferencesToApp(kCFPreferencesCurrentApplication, suiteName._cfObject)
}
open func removeSuite(named suiteName: String) {
CFPreferencesRemoveSuitePreferencesFromApp(kCFPreferencesCurrentApplication, suiteName._cfObject)
}
open func dictionaryRepresentation() -> [String: Any] {
return _dictionaryRepresentation(includingVolatileDomains: true)
}
private func _dictionaryRepresentation(includingVolatileDomains: Bool) -> [String: (Any & Sendable)] {
let registeredDefaultsIfAllowed = includingVolatileDomains ? registeredDefaults.withLock { $0 } : [:]
let defaultsFromDiskCF = CFPreferencesCopyMultiple(nil, suite?._cfObject ?? kCFPreferencesCurrentApplication, kCFPreferencesCurrentUser, kCFPreferencesAnyHost)
let defaultsFromDiskWithNumbersBoxed = __SwiftValue.fetch(defaultsFromDiskCF) as? [String: (Any & Sendable)] ?? [:]
if registeredDefaultsIfAllowed.isEmpty {
return UserDefaults._unboxingNSNumbers(defaultsFromDiskWithNumbersBoxed) as! [String: (Any & Sendable)]
} else {
var allDefaults = registeredDefaultsIfAllowed
for (key, value) in defaultsFromDiskWithNumbersBoxed {
allDefaults[key] = value
}
return UserDefaults._unboxingNSNumbers(allDefaults) as! [String: (Any & Sendable)]
}
}
// We know, but cannot prove statically, that the 'Any' here is only property list types, which are all Sendable
private static nonisolated(unsafe) let _parsedArgumentsDomain: [String: Any] = UserDefaults._parseArguments(ProcessInfo.processInfo.arguments)
private var _volatileDomains: [String: [String: Any]] = [:]
private let _volatileDomainsLock = NSLock()
open var volatileDomainNames: [String] {
_volatileDomainsLock.lock()
let names = Array(_volatileDomains.keys)
_volatileDomainsLock.unlock()
return names
}
open func volatileDomain(forName domainName: String) -> [String : Any] {
_volatileDomainsLock.lock()
let domain = _volatileDomains[domainName]
_volatileDomainsLock.unlock()
return domain ?? [:]
}
open func setVolatileDomain(_ domain: [String : Any], forName domainName: String) {
if !UserDefaults._isValueAllowed(domain) {
fatalError("The content of 'domain' passed to UserDefaults.setVolatileDomain(_:forName:) is not supported.")
}
_volatileDomainsLock.lock()
var storedDomain: [String: Any] = _volatileDomains[domainName] ?? [:]
storedDomain.merge(domain, uniquingKeysWith: { $1 })
_volatileDomains[domainName] = storedDomain
_volatileDomainsLock.unlock()
}
open func removeVolatileDomain(forName domainName: String) {
_volatileDomainsLock.lock()
_volatileDomains.removeValue(forKey: domainName)
_volatileDomainsLock.unlock()
}
open func persistentDomain(forName domainName: String) -> [String : Any]? {
return UserDefaults(suiteName: domainName)?._dictionaryRepresentation(includingVolatileDomains: false)
}
open func setPersistentDomain(_ domain: [String : Any], forName domainName: String) {
if let defaults = UserDefaults(suiteName: domainName) {
for key in defaults._dictionaryRepresentation(includingVolatileDomains: false).keys {
defaults.removeObject(forKey: key)
}
for (key, value) in domain {
defaults.set(value, forKey: key)
}
_ = defaults.synchronize()
#if canImport(Dispatch)
NotificationCenter.default.post(name: UserDefaults.didChangeNotification, object: self)
#endif
}
}
open func removePersistentDomain(forName domainName: String) {
if let defaults = UserDefaults(suiteName: domainName) {
for key in defaults._dictionaryRepresentation(includingVolatileDomains: false).keys {
defaults.removeObject(forKey: key)
}
_ = defaults.synchronize()
#if canImport(Dispatch)
NotificationCenter.default.post(name: UserDefaults.didChangeNotification, object: self)
#endif
}
}
@discardableResult
open func synchronize() -> Bool {
return CFPreferencesAppSynchronize(suite?._cfObject ?? kCFPreferencesCurrentApplication)
}
open func objectIsForced(forKey key: String) -> Bool {
// If you're using this version of Foundation, there is nothing in particular that can force a key.
// So:
return false
}
open func objectIsForced(forKey key: String, inDomain domain: String) -> Bool {
// If you're using this version of Foundation, there is nothing in particular that can force a key.
// So:
return false
}
}
extension UserDefaults {
public static let didChangeNotification = NSNotification.Name(rawValue: "NSUserDefaultsDidChangeNotification")
public static let globalDomain: String = "NSGlobalDomain"
public static let argumentDomain: String = "NSArgumentDomain"
public static let registrationDomain: String = "NSRegistrationDomain"
}
// MARK: -
// MARK: Parsing arguments.
fileprivate let propertyListPrefixes: Set<Character> = [ "{", "[", "(", "<", "\"" ]
private extension UserDefaults {
static func _parseArguments(_ arguments: [String]) -> [String: Any] {
var result: [String: Any] = [:]
let count = arguments.count
var index = 0
while index < count - 1 { // We're looking for pairs, so stop at the second-to-last argument.
let current = arguments[index]
let next = arguments[index + 1]
if current.hasPrefix("-") && !next.hasPrefix("-") {
// Match what Darwin does, which is to check whether the first argument is one of the characters that make up a NeXTStep-style or XML property list: open brace, open parens, open bracket, open angle bracket, or double quote. If it is, attempt parsing it as a plist; otherwise, just use the argument value as a String.
let keySubstring = current[current.index(after: current.startIndex)...]
if !keySubstring.isEmpty {
let key = String(keySubstring)
let value = next.trimmingCharacters(in: .whitespacesAndNewlines)
var parsed = false
if let prefix = value.first, propertyListPrefixes.contains(prefix) {
if let data = value.data(using: .utf8),
let plist = try? PropertyListSerialization.propertyList(from: data, format: nil) {
// If we can parse that argument as a plist, use the parsed value.
parsed = true
result[key] = plist
}
}
if !parsed {
result[key] = value
}
}
index += 1 // Skip both the key and the value on this loop.
}
index += 1
}
return result
}
}
|