[Foundation] Keep NS Updates due to changes in SE-0086

Second pass at updates for SE-0086 feedback

<rdar://problem/26892977> Make sure NSOrderedSet keeps its NS
<rdar://problem/26880016> NSBundleResourceRequest should keep its NS
<rdar://problem/26892958> Make sure NSAttributedString keeps its NS
<rdar://problem/26653694> NSCoder.decodeTopLevelObjectForKey does not follow naming guidelines
<rdar://problem/27355801> Foundation should have a structural type for TextCheckingResult
<rdar://problem/26770611> NSExpression naming is a bit awkward in swift
<rdar://problem/26653451> NSCoder encodeDataObject is misleading
<rdar://problem/26653653> NSCoder decodeObjectOfClass is redundant

Author: phausler

apinotes/Foundation.apinotes

@@ -68,7 +68,7 @@ Classes:
     SwiftName: dataWithContentsOfMappedFile(_:)
     MethodKind: Class
 - Name: NSCountedSet
-  SwiftName: CountedSet
+  SwiftName: NSCountedSet
 - Name: NSDate
   SwiftName: NSDate
   SwiftBridge: Date
@@ -173,6 +173,12 @@ Classes:
   - Selector: 'decodeIntForKey:'
     Availability: nonswift
     MethodKind: Instance
+  - Selector: 'encodeDataObject:'
+    SwiftName: encode(_:)
+    MethodKind: Instance
+  - Selector: 'decodeDataObject'
+    SwiftName: decodeData()
+    MethodKind: Instance
 - Name: NSNotification
   SwiftName: NSNotification
   SwiftBridge: Notification
@@ -756,6 +762,7 @@ Classes:
     SwiftName: isPartialStringValid(_:newEditingString:errorDescription:)
     MethodKind: Instance
 - Name: NSConditionLock
+  SwiftName: NSConditionLock
   Methods:
   - Selector: 'tryLockWhenCondition:'
     SwiftName: tryLock(whenCondition:)
@@ -813,6 +820,7 @@ Classes:
     SwiftName: scanUpTo(_:into:)
     MethodKind: Instance
 - Name: NSTextCheckingResult
+  SwiftName: NSTextCheckingResult
   Methods:
   - Selector: 'rangeAtIndex:'
     SwiftName: rangeAt(_:)
@@ -926,6 +934,9 @@ Classes:
     MethodKind: Instance
 - Name: NSUserDefaults
   Methods:
+  - Selector: 'registerDefaults:'
+    SwiftName: register(defaults:)
+    MethodKind: Instance
   - Selector: 'setObject:forKey:'
     SwiftName: set(_:forKey:)
     MethodKind: Instance
@@ -972,7 +983,39 @@ Classes:
   SwiftName: NSMachPort
 - Name: NSOutputStream
   SwiftName: NSOutputStream
+- Name: NSRegularExpression
+  SwiftName: NSRegularExpression
+- Name: NSComparisonPredicate
+  SwiftName: NSComparisonPredicate
+- Name: NSCompoundPredicate
+  SwiftName: NSCompoundPredicate
+- Name: NSPredicate
+  SwiftName: NSPredicate
+- Name: NSMapTable
+  SwiftName: NSMapTable
+- Name: NSHashTable
+  SwiftName: NSHashTable
+- Name: NSPointerArray
+  SwiftName: NSPointerArray
+- Name: NSPointerFunctions
+  SwiftName: NSPointerFunctions
+- Name: NSCache
+  SwiftName: NSCache
+- Name: NSPurgeableData
+  SwiftName: NSPurgeableData
+- Name: NSLock
+  SwiftName: NSLock
+- Name: NSCondition
+  SwiftName: NSCondition
+- Name: NSDistributedLock
+  SwiftName: NSDistributedLock
+- Name: NSRecursiveLock
+  SwiftName: NSRecursiveLock
+- Name: NSSortDescriptor
+  SwiftName: NSSortDescriptor
 Protocols:
+- Name: NSLocking
+  SwiftName: NSLocking
 - Name: NSMetadataQueryDelegate
   SwiftName: NSMetadataQueryDelegate
 - Name: NSCopying
@@ -1015,6 +1058,7 @@ Protocols:
     SwiftName: presentedSubitem(at:didResolve:)
     MethodKind: Instance
 - Name: NSDiscardableContent
+  SwiftName: NSDiscardableContent
   Methods:
   - Selector: beginContentAccess
     SwiftName: beginContentAccess()
@@ -1034,6 +1078,8 @@ Protocols:
   SwiftName: NSURLHandleClient
 - Name: NSMachPortDelegate
   SwiftName: NSMachPortDelegate
+- Name: NSCacheDelegate
+  SwiftName: NSCacheDelegate
 Tags:
 - Name: NSActivityOptions
   SwiftName: ProcessInfo.ActivityOptions
@@ -1074,13 +1120,13 @@ Tags:
 - Name: NSDecodingFailurePolicy
   SwiftName: NSCoder.DecodingFailurePolicy
 - Name: NSComparisonPredicateOptions
-  SwiftName: ComparisonPredicate.Options
+  SwiftName: NSComparisonPredicate.Options
 - Name: NSComparisonPredicateModifier
-  SwiftName: ComparisonPredicate.Modifier
+  SwiftName: NSComparisonPredicate.Modifier
 - Name: NSPredicateOperatorType
-  SwiftName: ComparisonPredicate.Operator
+  SwiftName: NSComparisonPredicate.Operator
 - Name: NSCompoundPredicateType
-  SwiftName: CompoundPredicate.LogicalType
+  SwiftName: NSCompoundPredicate.LogicalType
 - Name: NSDateFormatterStyle
   SwiftName: DateFormatter.Style
 - Name: NSDateFormatterBehavior
@@ -1166,22 +1212,22 @@ Tags:
 - Name: NSPropertyListFormat
   SwiftName: PropertyListSerialization.PropertyListFormat
 - Name: NSRegularExpressionOptions
-  SwiftName: RegularExpression.Options
+  SwiftName: NSRegularExpression.Options
 - Name: NSMatchingOptions
-  SwiftName: RegularExpression.MatchingOptions
+  SwiftName: NSRegularExpression.MatchingOptions
 - Name: NSMatchingFlags
-  SwiftName: RegularExpression.MatchingFlags
+  SwiftName: NSRegularExpression.MatchingFlags
 - Name: NSStreamStatus
   SwiftName: Stream.Status
 - Name: NSStreamEvent
   SwiftName: Stream.Event
 - Name: NSTaskTerminationReason
   SwiftName: Task.TerminationReason
 - Name: NSTextCheckingType
-  SwiftName: TextCheckingResult.CheckingType
+  SwiftName: NSTextCheckingResult.CheckingType
 - Name: NSTextCheckingTypes
   Availability: nonswift
-  AvailabilityMsg: Use 'TextCheckingResult.CheckingType'
+  AvailabilityMsg: Use 'NSTextCheckingResult.CheckingType'
 - Name: NSTimeZoneNameStyle
   SwiftName: TimeZone.NameStyle
 - Name: NSURLCacheStoragePolicy
@@ -1239,7 +1285,7 @@ Tags:
 - Name: NSNetServiceOptions
   SwiftName: NSNetService.Options
 - Name: NSPointerFunctionsOptions
-  SwiftName: PointerFunctions.Options
+  SwiftName: NSPointerFunctions.Options
 - Name: NSSearchPathDirectory
   SwiftName: FileManager.SearchPathDirectory
 - Name: NSSearchPathDomainMask
@@ -1351,6 +1397,14 @@ Typedefs:
   SwiftName: URLFileProtection
 - Name: NSURLBookmarkFileCreationOptions
   SwiftName: NSURL.BookmarkFileCreationOptions
+- Name: NSMapTableValueCallBacks
+  SwiftName: NSMapTableValueCallBacks
+- Name: NSKeyValueOperator
+  SwiftName: NSKeyValueOperator
+- Name: NSValueTransformerName
+  SwiftName: NSValueTransformerName
+- Name: NSErrorDomain
+  SwiftName: NSErrorDomain
 Globals:
 - Name: NSAppleScriptErrorMessage
   SwiftName: NSAppleScript.errorMessage
@@ -1383,11 +1437,11 @@ Globals:
 - Name: NSTaskDidTerminateNotification
   SwiftName: Task.didTerminateNotification
 - Name: NSTextCheckingAllSystemTypes
-  SwiftName: TextCheckingResult.CheckingType.allSystemTypes
+  SwiftName: NSTextCheckingResult.CheckingType.allSystemTypes
 - Name: NSTextCheckingAllCustomTypes
-  SwiftName: TextCheckingResult.CheckingType.allCustomTypes
+  SwiftName: NSTextCheckingResult.CheckingType.allCustomTypes
 - Name: NSTextCheckingAllTypes
-  SwiftName: TextCheckingResult.CheckingType.allTypes
+  SwiftName: NSTextCheckingResult.CheckingType.allTypes
 - Name: NSUbiquitousKeyValueStoreDidChangeExternallyNotification
   SwiftName: NSUbiquitousKeyValueStore.didChangeExternallyNotification
 - Name: NSURLSessionTaskPriorityDefault

stdlib/public/SDK/CoreData/CoreData.swift

@@ -272,8 +272,8 @@ extension CocoaError {
 
   /// For predicate-based validation, the predicate for the condition
   /// that failed to validate.
-  public var validationPredicate: Predicate? {
-    return userInfo[NSValidationPredicateErrorKey] as? Predicate
+  public var validationPredicate: NSPredicate? {
+    return userInfo[NSValidationPredicateErrorKey] as? NSPredicate
   }
 
   /// The value for the key that failed to validate for a validation

stdlib/public/SDK/Foundation/Foundation.swift

@@ -611,17 +611,17 @@ extension Dictionary : _ObjectiveCBridgeable {
 // TextChecking
 //===----------------------------------------------------------------------===//
 
-extension TextCheckingResult.CheckingType {
-    public static var allSystemTypes : TextCheckingResult.CheckingType {
-        return TextCheckingResult.CheckingType(rawValue: 0xffffffff)
+extension NSTextCheckingResult.CheckingType {
+    public static var allSystemTypes : NSTextCheckingResult.CheckingType {
+        return NSTextCheckingResult.CheckingType(rawValue: 0xffffffff)
     }
 
-    public static var allCustomTypes : TextCheckingResult.CheckingType {
-        return TextCheckingResult.CheckingType(rawValue: 0xffffffff << 32)
+    public static var allCustomTypes : NSTextCheckingResult.CheckingType {
+        return NSTextCheckingResult.CheckingType(rawValue: 0xffffffff << 32)
     }
 
-    public static var allTypes : TextCheckingResult.CheckingType {
-        return TextCheckingResult.CheckingType(rawValue: UInt64.max)
+    public static var allTypes : NSTextCheckingResult.CheckingType {
+        return NSTextCheckingResult.CheckingType(rawValue: UInt64.max)
     }
 }
 
@@ -1010,7 +1010,7 @@ func _convertErrorToNSError(_ error: Error) -> NSError {
 // Variadic initializers and methods
 //===----------------------------------------------------------------------===//
 
-extension Predicate {
+extension NSPredicate {
   // + (NSPredicate *)predicateWithFormat:(NSString *)predicateFormat, ...;
   public
   convenience init(format predicateFormat: String, _ args: CVarArg...) {
@@ -1225,24 +1225,35 @@ internal func resolveError(_ error: NSError?) throws {
 }
 
 extension NSCoder {
+  @available(*, unavailable, renamed: "decodeObject(of:forKey:)")
   public func decodeObjectOfClass<DecodedObjectType>(
     _ cls: DecodedObjectType.Type, forKey key: String
+  ) -> DecodedObjectType?
+    where DecodedObjectType : NSCoding, DecodedObjectType : NSObject {
+    fatalError("This API has been renamed")
+  }
+
+  public func decodeObject<DecodedObjectType>(
+    of cls: DecodedObjectType.Type, forKey key: String
   ) -> DecodedObjectType?
     where DecodedObjectType : NSCoding, DecodedObjectType : NSObject {
     let result = NS_Swift_NSCoder_decodeObjectOfClassForKey(self as AnyObject, cls as AnyObject, key as AnyObject, nil)
-    return result as! DecodedObjectType?
+    return result as? DecodedObjectType
   }
 
+  @available(*, unavailable, renamed: "decodeObject(of:forKey:)")
   @nonobjc
   public func decodeObjectOfClasses(_ classes: NSSet?, forKey key: String) -> AnyObject? {
-    var classesAsNSObjects: Set<NSObject>? = nil
+    fatalError("This API has been renamed")
+  }
+
+  @nonobjc
+  public func decodeObject(of classes: [AnyClass]?, forKey key: String) -> AnyObject? {
+    var classesAsNSObjects: NSSet? = nil
     if let theClasses = classes {
-      classesAsNSObjects =
-        Set(IteratorSequence(NSFastEnumerationIterator(theClasses)).map {
-          unsafeBitCast($0, to: NSObject.self)
-        })
+      classesAsNSObjects = NSSet(array: theClasses.map { $0 as AnyObject })
     }
-    return self.__decodeObject(ofClasses: classesAsNSObjects, forKey: key)
+    return NS_Swift_NSCoder_decodeObjectOfClassesForKey(self as AnyObject, classesAsNSObjects, key as AnyObject, nil)
   }
 
   @available(OSX 10.11, iOS 9.0, *)
@@ -1253,29 +1264,51 @@ extension NSCoder {
     return result
   }
 
-  @available(OSX 10.11, iOS 9.0, *)
+  @available(*, unavailable, renamed: "decodeTopLevelObject(forKey:)")
   public func decodeTopLevelObjectForKey(_ key: String) throws -> AnyObject? {
+    fatalError("This API has been renamed")
+  }
+
+  @available(OSX 10.11, iOS 9.0, *)
+  public func decodeTopLevelObject(forKey key: String) throws -> AnyObject? {
     var error: NSError?
     let result = NS_Swift_NSCoder_decodeObjectForKey(self as AnyObject, key as AnyObject, &error)
     try resolveError(error)
     return result
   }
 
-  @available(OSX 10.11, iOS 9.0, *)
+  @available(*, unavailable, renamed: "decodeTopLevelObject(of:forKey:)")
   public func decodeTopLevelObjectOfClass<DecodedObjectType>(
     _ cls: DecodedObjectType.Type, forKey key: String
+  ) throws -> DecodedObjectType?
+    where DecodedObjectType : NSCoding, DecodedObjectType : NSObject {
+    fatalError("This API has been renamed")
+  }
+
+  @available(OSX 10.11, iOS 9.0, *)
+  public func decodeTopLevelObject<DecodedObjectType>(
+    of cls: DecodedObjectType.Type, forKey key: String
   ) throws -> DecodedObjectType?
     where DecodedObjectType : NSCoding, DecodedObjectType : NSObject {
     var error: NSError?
     let result = NS_Swift_NSCoder_decodeObjectOfClassForKey(self as AnyObject, cls as AnyObject, key as AnyObject, &error)
     try resolveError(error)
-    return result as! DecodedObjectType?
+    return result as? DecodedObjectType
   }
 
-  @available(OSX 10.11, iOS 9.0, *)
+  @available(*, unavailable, renamed: "decodeTopLevelObject(of:forKey:)")
   public func decodeTopLevelObjectOfClasses(_ classes: NSSet?, forKey key: String) throws -> AnyObject? {
-    var error: NSError?
-    let result = NS_Swift_NSCoder_decodeObjectOfClassesForKey(self as AnyObject, classes, key as AnyObject, &error)
+    fatalError("This API has been renamed")
+  }
+
+  @available(OSX 10.11, iOS 9.0, *)
+  public func decodeTopLevelObject(of classes: [AnyClass]?, forKey key: String) throws -> AnyObject? {
+    var error: NSError? = nil
+    var classesAsNSObjects: NSSet? = nil
+    if let theClasses = classes {
+      classesAsNSObjects = NSSet(array: theClasses.map { $0 as AnyObject })
+    }
+    let result = NS_Swift_NSCoder_decodeObjectOfClassesForKey(self as AnyObject, classesAsNSObjects, key as AnyObject, &error)
     try resolveError(error)
     return result
   }

test/1_stdlib/ErrorBridged.swift

@@ -75,7 +75,7 @@ func archiveAndUnarchiveObject<T: NSCoding where T: NSObject>(
     NSKeyedArchiver.archivedData(withRootObject: object)
   )
   unarchiver.requiresSecureCoding = true
-  return unarchiver.decodeObjectOfClass(T.self, forKey: "root")
+  return unarchiver.decodeObject(of: T.self, forKey: "root")
 }
 ErrorBridgingTests.test("NSCoding") {
   autoreleasepool {

test/1_stdlib/Foundation_NewGenericAPIs.swift

@@ -24,18 +24,18 @@ func test_NSCoder_decodeObjectForKey(_ coder: NSCoder, key: String) {
 }
 
 func test_NSCoder_decodeObjectOfClasses_forKey(
-  _ coder: NSCoder, classes: NSSet?, key: String
+  _ coder: NSCoder, classes: [AnyClass]?, key: String
 ) {
-  var r = coder.decodeObjectOfClasses(classes, forKey: key)
+  var r = coder.decodeObject(of: classes, forKey: key)
   expectType(Optional<AnyObject>.self, &r)
 }
 
 @available(iOS, introduced: 9.0)
 @available(OSX, introduced: 10.11)
 func test_NSCoder_decodeTopLevelObjectOfClasses_forKey_error(
-  _ coder: NSCoder, classes: NSSet?, key: String
+  _ coder: NSCoder, classes: [AnyClass]?, key: String
 ) throws {
-  var r = try coder.decodeTopLevelObjectOfClasses(classes, forKey: key)
+  var r = try coder.decodeTopLevelObject(of: classes, forKey: key)
   expectType(Optional<AnyObject>.self, &r)
 }
 

test/ClangModules/objc_parse.swift

@@ -549,7 +549,7 @@ extension Printing {
 func testSetInitializers() {
   let a: [AnyObject] = [NSObject()]
 
-  let _ = CountedSet(array: a)
+  let _ = NSCountedSet(array: a)
   let _ = NSMutableSet(array: a)
 }
 

test/Interpreter/SDK/Foundation_NSPredicate.swift

@@ -7,7 +7,7 @@
 import Foundation
 
 // Test overlain variadic methods.
-let s = Predicate(format: "(lastName like[cd] %@) AND (birthday > %@)", "LLLL", "BBBB")
+let s = NSPredicate(format: "(lastName like[cd] %@) AND (birthday > %@)", "LLLL", "BBBB")
 print(s.predicateFormat)
 
 // CHECK: lastName LIKE[cd] "LLLL" AND birthday > "BBBB"