Replace Id with ID

Author: rauhul

Sources/System/FileStatus/FileMode/FileMode.swift renamed to Sources/System/FileStatus/FileMode.swift

@@ -21,11 +21,11 @@ public struct FileStatus: RawRepresentable {
   @_alwaysEmitIntoClient
   public init(rawValue: CInterop.Stat) { self.rawValue = rawValue }
 
-  // FIXME: replace with swift type DeviceId that splits out major/minor
-  // FIXME: whats the difference between this and rDeviceId?
+  // FIXME: replace with swift type DeviceID that splits out major/minor
+  // FIXME: whats the difference between this and rDeviceID?
   /// ID of device containing file.
   @_alwaysEmitIntoClient
-  public var deviceId: CInterop.DeviceId { rawValue.st_dev }
+  public var deviceID: CInterop.DeviceID { rawValue.st_dev }
 
   /// Mode of file.
   @_alwaysEmitIntoClient
@@ -41,16 +41,16 @@ public struct FileStatus: RawRepresentable {
 
   /// User ID of the file.
   @_alwaysEmitIntoClient
-  public var userId: CInterop.UserId { rawValue.st_uid }
+  public var userID: CInterop.UserID { rawValue.st_uid }
 
   /// Group ID of the file.
   @_alwaysEmitIntoClient
-  public var groupId: CInterop.GroupId { rawValue.st_gid }
+  public var groupID: CInterop.GroupID { rawValue.st_gid }
 
-  // FIXME: whats the difference between this and deviceId?
+  // FIXME: whats the difference between this and deviceID?
   /// Device ID.
   @_alwaysEmitIntoClient
-  public var rDeviceId: CInterop.DeviceId { rawValue.st_rdev }
+  public var rDeviceID: CInterop.DeviceID { rawValue.st_rdev }
 
   /// Time of last access.
   @_alwaysEmitIntoClient
@@ -86,7 +86,7 @@ public struct FileStatus: RawRepresentable {
 
   /// File generation number.
   @_alwaysEmitIntoClient
-  public var generation: CInterop.GenerationId { rawValue.st_gen }
+  public var generationID: CInterop.GenerationID { rawValue.st_gen }
 }
 
 #endif

Sources/System/FileStatus/FileMode/FilePermissions.swift renamed to Sources/System/FileStatus/FilePermissions.swift

@@ -251,30 +251,30 @@ extension FileDescriptor {
 extension FilePath {
   @_alwaysEmitIntoClient
   public func chown(
-    userId: CInterop.UserId,
-    groupId: CInterop.GroupId,
+    userID: CInterop.UserID,
+    groupID: CInterop.GroupID,
     followSymlinks: Bool = true,
     retryOnInterrupt: Bool = true
   ) throws {
     try _chown(
-      userId: userId,
-      groupId: groupId,
+      userID: userID,
+      groupID: groupID,
       followSymlinks: followSymlinks,
       retryOnInterrupt: retryOnInterrupt
     ).get()
   }
 
   @usableFromInline
   internal func _chown(
-    userId: CInterop.UserId,
-    groupId: CInterop.GroupId,
+    userID: CInterop.UserID,
+    groupID: CInterop.GroupID,
     followSymlinks: Bool,
     retryOnInterrupt: Bool
   ) -> Result<Void, Errno> {
     let _chown = followSymlinks ? system_chown : system_lchown
     return withPlatformString { ptr in
       nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        _chown(ptr, userId, groupId)
+        _chown(ptr, userID, groupID)
       }
     }
   }
@@ -284,40 +284,40 @@ extension FilePath {
 extension FileDescriptor {
   @_alwaysEmitIntoClient
   public func fchown(
-    userId: CInterop.UserId,
-    groupId: CInterop.GroupId,
+    userID: CInterop.UserID,
+    groupID: CInterop.GroupID,
     retryOnInterrupt: Bool = true
   ) throws {
     try _fchown(
-      userId: userId,
-      groupId: groupId,
+      userID: userID,
+      groupID: groupID,
       retryOnInterrupt: retryOnInterrupt
     ).get()
   }
 
   @usableFromInline
   internal func _fchown(
-    userId: CInterop.UserId,
-    groupId: CInterop.GroupId,
+    userID: CInterop.UserID,
+    groupID: CInterop.GroupID,
     retryOnInterrupt: Bool
   ) -> Result<Void, Errno> {
     nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-      system_fchown(self.rawValue, userId, groupId)
+      system_fchown(self.rawValue, userID, groupID)
     }
   }
 
   @_alwaysEmitIntoClient
   public func fchownat(
     path: FilePath,
-    userId: CInterop.UserId,
-    groupId: CInterop.GroupId,
+    userID: CInterop.UserID,
+    groupID: CInterop.GroupID,
     fcntrl: FileDescriptor.ControlFlags,
     retryOnInterrupt: Bool = true
   ) throws {
     try _fchownat(
       path: path,
-      userId: userId,
-      groupId: groupId,
+      userID: userID,
+      groupID: groupID,
       fcntrl: fcntrl,
       retryOnInterrupt: retryOnInterrupt
     ).get()
@@ -326,14 +326,14 @@ extension FileDescriptor {
   @usableFromInline
   internal func _fchownat(
     path: FilePath,
-    userId: CInterop.UserId,
-    groupId: CInterop.GroupId,
+    userID: CInterop.UserID,
+    groupID: CInterop.GroupID,
     fcntrl: FileDescriptor.ControlFlags,
     retryOnInterrupt: Bool
   ) -> Result<Void, Errno> {
     path.withPlatformString { ptr in
       nothingOrErrno(retryOnInterrupt: retryOnInterrupt) {
-        system_fchownat(self.rawValue, ptr, userId, groupId, fcntrl.rawValue)
+        system_fchownat(self.rawValue, ptr, userID, groupID, fcntrl.rawValue)
       }
     }
   }
@@ -457,7 +457,7 @@ extension FilePath {
   @_alwaysEmitIntoClient
   public func mknod(
     permissions: FilePermissions,
-    device: CInterop.DeviceId,
+    device: CInterop.DeviceID,
     retryOnInterrupt: Bool = true
   ) throws {
     try _mknod(
@@ -470,7 +470,7 @@ extension FilePath {
   @usableFromInline
   internal func _mknod(
     permissions: FilePermissions,
-    device: CInterop.DeviceId,
+    device: CInterop.DeviceID,
     retryOnInterrupt: Bool
   ) -> Result<Void, Errno> {
     withPlatformString { ptr in

Sources/System/FileStatus/FileStatus.swift

@@ -65,18 +65,40 @@ public enum CInterop {
 #endif
 
 #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
-  // FIXME: Document
+  /// The C `stat` type.
   public typealias Stat = stat
-  public typealias UserId = uid_t
-  public typealias GroupId = gid_t
-  public typealias DeviceId = dev_t
+
+  /// The C `uid_t` type.
+  public typealias UserID = uid_t
+
+  /// The C `gid_t` type.
+  public typealias GroupID = gid_t
+
+  /// The C `dev_t` type.
+  public typealias DeviceID = dev_t
+
+  /// The C `nlink_t` type.
   public typealias NumberOfLinks = nlink_t
+
+  /// The C `ino_t` type.
   public typealias INodeNumber = ino_t
+
+  /// The C `timespec` type.
   public typealias TimeSpec = timespec
+
+  /// The C `off_t` type.
   public typealias Offset = off_t
+
+  /// The C `blkcnt_t` type.
   public typealias BlockCount = blkcnt_t
+
+  /// The C `blksize_t` type.
   public typealias BlockSize = blksize_t
-  public typealias GenerationId = UInt32
+
+  /// The C `UInt32` type.
+  public typealias GenerationID = UInt32
+
+  /// The C `UInt32` type.
   public typealias FileFlags = UInt32
 #endif
 }

Sources/System/FileStatus/FileStatusOperations.swift

@@ -531,7 +531,7 @@ internal var _SEEK_DATA: CInt { SEEK_DATA }
 
 // MARK: - Mode Masks
 #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
-// mode_t: xxxx ugs rwx rwx rwx
+// mode_t: type ugs rwx rwx rwx
 @_alwaysEmitIntoClient
 internal var _MODE_PERMISSIONS: CInterop.Mode { 0b0000_111_111_111_111 }
 

Sources/System/FileStatus/FileMode/FileType.swift renamed to Sources/System/FileStatus/FileType.swift

@@ -219,51 +219,51 @@ internal func system_fchmodat(
 // chown
 internal func system_chown(
   _ path: UnsafePointer<CInterop.PlatformChar>?,
-  _ userId: CInterop.UserId,
-  _ groupId: CInterop.GroupId
+  _ userID: CInterop.UserID,
+  _ groupID: CInterop.GroupID
 ) -> Int32 {
 #if ENABLE_MOCKING
-  if mockingEnabled { return _mock(path, userId, groupId) }
+  if mockingEnabled { return _mock(path, userID, groupID) }
 #endif
-  return chown(path, userId, groupId)
+  return chown(path, userID, groupID)
 }
 
 // lchown
 internal func system_lchown(
   _ path: UnsafePointer<CInterop.PlatformChar>?,
-  _ userId: CInterop.UserId,
-  _ groupId: CInterop.GroupId
+  _ userID: CInterop.UserID,
+  _ groupID: CInterop.GroupID
 ) -> Int32 {
 #if ENABLE_MOCKING
-  if mockingEnabled { return _mock(path, userId, groupId) }
+  if mockingEnabled { return _mock(path, userID, groupID) }
 #endif
-  return lchown(path, userId, groupId)
+  return lchown(path, userID, groupID)
 }
 
 // fchown
 internal func system_fchown(
   _ fd: Int32,
-  _ userId: CInterop.UserId,
-  _ groupId: CInterop.GroupId
+  _ userID: CInterop.UserID,
+  _ groupID: CInterop.GroupID
 ) -> Int32 {
 #if ENABLE_MOCKING
-  if mockingEnabled { return _mock(fd, userId, groupId) }
+  if mockingEnabled { return _mock(fd, userID, groupID) }
 #endif
-  return fchown(fd, userId, groupId)
+  return fchown(fd, userID, groupID)
 }
 
 // fchownat
 internal func system_fchownat(
   _ fd: Int32,
   _ path: UnsafePointer<CInterop.PlatformChar>?,
-  _ userId: CInterop.UserId,
-  _ groupId: CInterop.GroupId,
+  _ userID: CInterop.UserID,
+  _ groupID: CInterop.GroupID,
   _ flag: Int32
 ) -> Int32 {
 #if ENABLE_MOCKING
-  if mockingEnabled { return _mock(fd, path, userId, groupId, flag) }
+  if mockingEnabled { return _mock(fd, path, userID, groupID, flag) }
 #endif
-  return fchownat(fd, path, userId, groupId, flag)
+  return fchownat(fd, path, userID, groupID, flag)
 }
 
 // chflags
@@ -324,12 +324,12 @@ internal func system_mkfifo(
 internal func system_mknod(
   _ path: UnsafePointer<CInterop.PlatformChar>?,
   _ mode: CInterop.Mode,
-  _ deviceId: CInterop.DeviceId
+  _ deviceID: CInterop.DeviceID
 ) -> Int32 {
 #if ENABLE_MOCKING
-  if mockingEnabled { return _mock(path, mode, deviceId) }
+  if mockingEnabled { return _mock(path, mode, deviceID) }
 #endif
-  return mknod(path, mode, deviceId)
+  return mknod(path, mode, deviceID)
 }
 
 // mkdir