Merge remote-tracking branch 'origin/master' into swift-4.0-branch

Author: swift-ci

Foundation.xcodeproj/project.pbxproj

@@ -50,15 +50,15 @@ open class ByteCountFormatter : Formatter {
         NSUnimplemented()
     }
 
-    /* Specify the units that can be used in the output. If NSByteCountFormatterUseDefault, uses platform-appropriate settings; otherwise will only use the specified units. This is the default value. Note that ZB and YB cannot be covered by the range of possible values, but you can still choose to use these units to get fractional display ("0.0035 ZB" for instance).
+    /* Specify the units that can be used in the output. If ByteCountFormatter.Units.useDefault, uses platform-appropriate settings; otherwise will only use the specified units. This is the default value. Note that ZB and YB cannot be covered by the range of possible values, but you can still choose to use these units to get fractional display ("0.0035 ZB" for instance).
      */
     open var allowedUnits: Units = .useDefault
 
-    /* Specify how the count is displayed by indicating the number of bytes to be used for kilobyte. The default setting is NSByteCountFormatterFileCount, which is the system specific value for file and storage sizes.
+    /* Specify how the count is displayed by indicating the number of bytes to be used for kilobyte. The default setting is ByteCountFormatter.CountStyle.fileCount, which is the system specific value for file and storage sizes.
      */
     open var countStyle: CountStyle = .file
 
-    /* Choose whether to allow more natural display of some values, such as zero, where it may be displayed as "Zero KB," ignoring all other flags or options (with the exception of NSByteCountFormatterUseBytes, which would generate "Zero bytes"). The result is appropriate for standalone output. Default value is YES. Special handling of certain values such as zero is especially important in some languages, so it's highly recommended that this property be left in its default state.
+    /* Choose whether to allow more natural display of some values, such as zero, where it may be displayed as "Zero KB," ignoring all other flags or options (with the exception of ByteCountFormatter.Units.useBytes, which would generate "Zero bytes"). The result is appropriate for standalone output. Default value is YES. Special handling of certain values such as zero is especially important in some languages, so it's highly recommended that this property be left in its default state.
      */
     open var allowsNonnumericFormatting: Bool = true
 
@@ -91,7 +91,7 @@ open class ByteCountFormatter : Formatter {
      */
     private let numberFormatter = NumberFormatter()
 
-    /* Shortcut for converting a byte count into a string without creating an NSByteCountFormatter and an NSNumber. If you need to specify options other than countStyle, create an instance of NSByteCountFormatter first.
+    /* Shortcut for converting a byte count into a string without creating an ByteCountFormatter and an NSNumber. If you need to specify options other than countStyle, create an instance of ByteCountFormatter first.
      */
     open class func string(fromByteCount byteCount: Int64, countStyle: ByteCountFormatter.CountStyle) -> String {
         let formatter = ByteCountFormatter()

Foundation/NSAffineTransform.swift Foundation/AffineTransform.swift

@@ -34,7 +34,7 @@ extension DateComponentsFormatter {
     }
 }
 
-/* NSDateComponentsFormatter provides locale-correct and flexible string formatting of quantities of time, such as "1 day" or "1h 10m", as specified by NSDateComponents. For formatting intervals of time (such as "2PM to 5PM"), see NSDateIntervalFormatter. NSDateComponentsFormatter is thread-safe, in that calling methods on it from multiple threads will not cause crashes or incorrect results, but it makes no attempt to prevent confusion when one thread sets something and another thread isn't expecting it to change.
+/* DateComponentsFormatter provides locale-correct and flexible string formatting of quantities of time, such as "1 day" or "1h 10m", as specified by NSDateComponents. For formatting intervals of time (such as "2PM to 5PM"), see DateIntervalFormatter. DateComponentsFormatter is thread-safe, in that calling methods on it from multiple threads will not cause crashes or incorrect results, but it makes no attempt to prevent confusion when one thread sets something and another thread isn't expecting it to change.
  */
 
 open class DateComponentsFormatter : Formatter {
@@ -53,11 +53,11 @@ open class DateComponentsFormatter : Formatter {
 
     open func string(from components: DateComponents) -> String? { NSUnimplemented() }
 
-    /* Normally, NSDateComponentsFormatter will calculate as though counting from the current date and time (e.g. in February, 1 month formatted as a number of days will be 28). -stringFromDate:toDate: calculates from the passed-in startDate instead.
+    /* Normally, DateComponentsFormatter will calculate as though counting from the current date and time (e.g. in February, 1 month formatted as a number of days will be 28). -stringFromDate:toDate: calculates from the passed-in startDate instead.
 
        See 'allowedUnits' for how the default set of allowed units differs from -stringFromDateComponents:.
 
-       Note that this is still formatting the quantity of time between the dates, not the pair of dates itself. For strings like "Feb 22nd - Feb 28th", use NSDateIntervalFormatter.
+       Note that this is still formatting the quantity of time between the dates, not the pair of dates itself. For strings like "Feb 22nd - Feb 28th", use DateIntervalFormatter.
      */
     open func string(from startDate: Date, to endDate: Date) -> String? { NSUnimplemented() }
 
@@ -67,7 +67,7 @@ open class DateComponentsFormatter : Formatter {
 
     open class func localizedString(from components: DateComponents, unitsStyle: UnitsStyle) -> String? { NSUnimplemented() }
 
-    /* Choose how to indicate units. For example, 1h 10m vs 1:10. Default is NSDateComponentsFormatterUnitsStylePositional.
+    /* Choose how to indicate units. For example, 1h 10m vs 1:10. Default is DateComponentsFormatter.UnitsStyle.positional.
      */
     open var unitsStyle: UnitsStyle
 
@@ -87,9 +87,9 @@ open class DateComponentsFormatter : Formatter {
      */
     open var allowedUnits: NSCalendar.Unit
 
-    /* Bitmask specifying how to handle zeros in units. This includes both padding and dropping zeros so that a consistent number digits are displayed, causing updating displays to remain more stable. Default is NSDateComponentsFormatterZeroFormattingBehaviorDefault.
+    /* Bitmask specifying how to handle zeros in units. This includes both padding and dropping zeros so that a consistent number digits are displayed, causing updating displays to remain more stable. Default is DateComponentsFormatter.ZeroFormattingBehavior.default.
 
-       If the combination of zero formatting behavior and style would lead to ambiguous date formats (for example, 1:10 meaning 1 hour, 10 seconds), NSDateComponentsFormatter will throw an exception.
+       If the combination of zero formatting behavior and style would lead to ambiguous date formats (for example, 1:10 meaning 1 hour, 10 seconds), DateComponentsFormatter will throw an exception.
      */
     open var zeroFormattingBehavior: ZeroFormattingBehavior
 
@@ -129,7 +129,7 @@ open class DateComponentsFormatter : Formatter {
      */
     open var formattingContext: Context
 
-    /* NSDateComponentsFormatter currently only implements formatting, not parsing. Until it implements parsing, this will always return NO.
+    /* DateComponentsFormatter currently only implements formatting, not parsing. Until it implements parsing, this will always return NO.
      */
     /// - Experiment: This is a draft API currently under consideration for official import into Foundation as a suitable alternative
     /// - Note: Since this API is under consideration it may be either removed or revised in the near future

Foundation/ByteCountFormatter.swift

@@ -19,8 +19,8 @@ extension DateIntervalFormatter {
     }
 }
 
-// NSDateIntervalFormatter is used to format the range between two NSDates in a locale-sensitive way.
-// NSDateIntervalFormatter returns nil and NO for all methods in NSFormatter.
+// DateIntervalFormatter is used to format the range between two NSDates in a locale-sensitive way.
+// DateIntervalFormatter returns nil and NO for all methods in Formatter.
 
 open class DateIntervalFormatter : Formatter {
 
@@ -36,8 +36,8 @@ open class DateIntervalFormatter : Formatter {
     /*@NSCopying*/ open var calendar: Calendar! // default is the calendar of the locale
     /*@NSCopying*/ open var timeZone: TimeZone! // default is [NSTimeZone defaultTimeZone]
     open var dateTemplate: String! // default is an empty string
-    open var dateStyle: Style // default is NSDateIntervalFormatterNoStyle
-    open var timeStyle: Style // default is NSDateIntervalFormatterNoStyle
+    open var dateStyle: Style // default is .noStyle
+    open var timeStyle: Style // default is .noStyle
 
     /*
          If the range smaller than the resolution specified by the dateTemplate, a single date format will be produced. If the range is larger than the format specified by the dateTemplate, a locale-specific fallback will be used to format the items missing from the pattern.

Foundation/DateComponentsFormatter.swift

@@ -1929,7 +1929,7 @@ fileprivate let pow10 = [
 /*^39 is on 9 shorts. */
 ]
 
-// Copied from NSScanner.swift
+// Copied from Scanner.swift
 private func decimalSep(_ locale: Locale?) -> String {
     if let loc = locale {
         if let sep = loc._bridgeToObjectiveC().object(forKey: .decimalSeparator) as? NSString {
@@ -1941,15 +1941,15 @@ private func decimalSep(_ locale: Locale?) -> String {
     }
 }
 
-// Copied from NSScanner.swift
+// Copied from Scanner.swift
 private func isADigit(_ ch: unichar) -> Bool {
     struct Local {
         static let set = CharacterSet.decimalDigits
     }
     return Local.set.contains(UnicodeScalar(ch)!)
 }
 
-// Copied from NSScanner.swift
+// Copied from Scanner.swift
 private func numericValue(_ ch: unichar) -> Int {
     if (ch >= unichar(unicodeScalarLiteral: "0") && ch <= unichar(unicodeScalarLiteral: "9")) {
         return Int(ch) - Int(unichar(unicodeScalarLiteral: "0"))

Foundation/DateIntervalFormatter.swift

@@ -78,9 +78,9 @@ open class EnergyFormatter: Formatter {
         super.init()
     }
 
-    /*@NSCopying*/ open var numberFormatter: NumberFormatter! // default is NSNumberFormatter with NSNumberFormatterDecimalStyle
+    /*@NSCopying*/ open var numberFormatter: NumberFormatter! // default is NumberFormatter with NumberFormatter.Style.decimal
     open var unitStyle: UnitStyle // default is NSFormattingUnitStyleMedium
-    open var isForFoodEnergyUse: Bool // default is NO; if it is set to YES, NSEnergyFormatterUnitKilocalorie may be “C” instead of “kcal"
+    open var isForFoodEnergyUse: Bool // default is NO; if it is set to YES, EnergyFormatter.Unit.kilocalorie may be “C” instead of “kcal"
 
     // Format a combination of a number and an unit to a localized string.
     open func string(fromValue value: Double, unit: Unit) -> String {

Foundation/NSDecimal.swift Foundation/Decimal.swift

@@ -111,7 +111,7 @@ open class FileManager : NSObject {
         try self.createSymbolicLink(atPath: url.path, withDestinationPath: destURL.path)
     }
 
-    /* Instances of NSFileManager may now have delegates. Each instance has one delegate, and the delegate is not retained. In versions of Mac OS X prior to 10.5, the behavior of calling [[NSFileManager alloc] init] was undefined. In Mac OS X 10.5 "Leopard" and later, calling [[NSFileManager alloc] init] returns a new instance of an NSFileManager.
+    /* Instances of FileManager may now have delegates. Each instance has one delegate, and the delegate is not retained. In versions of Mac OS X prior to 10.5, the behavior of calling [[NSFileManager alloc] init] was undefined. In Mac OS X 10.5 "Leopard" and later, calling [[NSFileManager alloc] init] returns a new instance of an FileManager.
      */
     open weak var delegate: FileManagerDelegate? {
         NSUnimplemented()
@@ -505,7 +505,7 @@ open class FileManager : NSObject {
         try self.removeItem(atPath: url.path)
     }
 
-    /* Process working directory management. Despite the fact that these are instance methods on NSFileManager, these methods report and change (respectively) the working directory for the entire process. Developers are cautioned that doing so is fraught with peril.
+    /* Process working directory management. Despite the fact that these are instance methods on FileManager, these methods report and change (respectively) the working directory for the entire process. Developers are cautioned that doing so is fraught with peril.
      */
     open var currentDirectoryPath: String {
         let length = Int(PATH_MAX) + 1
@@ -856,7 +856,7 @@ public protocol FileManagerDelegate : NSObjectProtocol {
     func fileManager(_ fileManager: FileManager, shouldCopyItemAtPath srcPath: String, toPath dstPath: String) -> Bool
     func fileManager(_ fileManager: FileManager, shouldCopyItemAt srcURL: URL, to dstURL: URL) -> Bool
 
-    /* fileManager:shouldProceedAfterError:copyingItemAtPath:toPath: gives the delegate an opportunity to recover from or continue copying after an error. If an error occurs, the error object will contain an NSError indicating the problem. The source path and destination paths are also provided. If this method returns YES, the NSFileManager instance will continue as if the error had not occurred. If this method returns NO, the NSFileManager instance will stop copying, return NO from copyItemAtPath:toPath:error: and the error will be provied there.
+    /* fileManager:shouldProceedAfterError:copyingItemAtPath:toPath: gives the delegate an opportunity to recover from or continue copying after an error. If an error occurs, the error object will contain an NSError indicating the problem. The source path and destination paths are also provided. If this method returns YES, the FileManager instance will continue as if the error had not occurred. If this method returns NO, the FileManager instance will stop copying, return NO from copyItemAtPath:toPath:error: and the error will be provied there.
      */
     func fileManager(_ fileManager: FileManager, shouldProceedAfterError error: Error, copyingItemAtPath srcPath: String, toPath dstPath: String) -> Bool
     func fileManager(_ fileManager: FileManager, shouldProceedAfterError error: Error, copyingItemAt srcURL: URL, to dstURL: URL) -> Bool
@@ -882,7 +882,7 @@ public protocol FileManagerDelegate : NSObjectProtocol {
     func fileManager(_ fileManager: FileManager, shouldProceedAfterError error: Error, linkingItemAtPath srcPath: String, toPath dstPath: String) -> Bool
     func fileManager(_ fileManager: FileManager, shouldProceedAfterError error: Error, linkingItemAt srcURL: URL, to dstURL: URL) -> Bool
 
-    /* fileManager:shouldRemoveItemAtPath: allows the delegate the opportunity to not remove the item at path. If the delegate returns YES from this method, the NSFileManager instance will attempt to remove the item. If the delegate returns NO from this method, the remove skips the item. If the item is a directory, no children of that item will be visited.
+    /* fileManager:shouldRemoveItemAtPath: allows the delegate the opportunity to not remove the item at path. If the delegate returns YES from this method, the FileManager instance will attempt to remove the item. If the delegate returns NO from this method, the remove skips the item. If the item is a directory, no children of that item will be visited.
      */
     func fileManager(_ fileManager: FileManager, shouldRemoveItemAtPath path: String) -> Bool
     func fileManager(_ fileManager: FileManager, shouldRemoveItemAt URL: URL) -> Bool

Foundation/EnergyFormatter.swift

@@ -71,9 +71,9 @@ extension HTTPCookiePropertyKey {
     internal static let created = HTTPCookiePropertyKey(rawValue: "Created")
 }
 
-/// `NSHTTPCookie` represents an http cookie.
+/// `HTTPCookie` represents an http cookie.
 ///
-/// An `NSHTTPCookie` instance represents a single http cookie. It is
+/// An `HTTPCookie` instance represents a single http cookie. It is
 /// an immutable object initialized from a dictionary that contains
 /// the various cookie attributes. It has accessors to get the various
 /// attributes of a cookie.
@@ -98,7 +98,7 @@ open class HTTPCookie : NSObject {
            .path, .secure, .expires, .comment, .commentURL,
            .discard, .maximumAge, .port]
 
-    /// Initialize a NSHTTPCookie object with a dictionary of parameters
+    /// Initialize a HTTPCookie object with a dictionary of parameters
     ///
     /// - Parameter properties: The dictionary of properties to be used to
     /// initialize this cookie.
@@ -216,7 +216,7 @@ open class HTTPCookie : NSObject {
     ///
     /// All other keys are ignored.
     ///
-    /// - Returns: An initialized `NSHTTPCookie`, or nil if the set of
+    /// - Returns: An initialized `HTTPCookie`, or nil if the set of
     /// dictionary keys is invalid, for example because a required key is
     /// missing, or a recognized key maps to an illegal value.
     ///
@@ -373,7 +373,7 @@ open class HTTPCookie : NSObject {
     /// you can pass a dictionary containing data other than cookie data.
     /// - Parameter headerFields: The response header fields to check for cookies.
     /// - Parameter URL: The URL that the cookies came from - relevant to how the cookies are interpeted.
-    /// - Returns: An array of NSHTTPCookie objects
+    /// - Returns: An array of HTTPCookie objects
     open class func cookies(withResponseHeaderFields headerFields: [String : String], for URL: URL) -> [HTTPCookie] {
 
         //HTTP Cookie parsing based on RFC 6265: https://tools.ietf.org/html/rfc6265
@@ -469,10 +469,10 @@ open class HTTPCookie : NSObject {
     /// Returns a dictionary representation of the receiver.
     ///
     /// This method returns a dictionary representation of the
-    /// `NSHTTPCookie` which can be saved and passed to
+    /// `HTTPCookie` which can be saved and passed to
     /// `init(properties:)` later to reconstitute an equivalent cookie.
     ///
-    /// See the `NSHTTPCookie` `init(properties:)` method for
+    /// See the `HTTPCookie` `init(properties:)` method for
     /// more information on the constraints imposed on the dictionary, and
     /// for descriptions of the supported keys and values.
     ///