apply naming changes

Author: chloe-yeo

Sources/FoundationEssentials/ProgressReporter/ProgressReporter+Interop.swift

@@ -21,15 +21,15 @@ internal import _ForSwiftFoundation
 // Actual ProgressReporter Child
 extension Progress {
 
-    /// Returns a ProgressReporter.Progress which can be passed to any method that reports progress
+    /// Returns a Subprogress which can be passed to any method that reports progress
     /// and can be initialized into a child `ProgressReporter` to the `self`.
     ///
     /// Delegates a portion of totalUnitCount to a future child `ProgressReporter` instance.
     ///
     /// - Parameter count: Number of units delegated to a child instance of `ProgressReporter`
-    /// which may be instantiated by `ProgressReporter.Progress` later when `reporter(totalCount:)` is called.
-    /// - Returns: A `ProgressReporter.Progress` instance.
-    public func makeChild(withPendingUnitCount count: Int) -> ProgressReporter.Progress {
+    /// which may be instantiated by `Subprogress` later when `reporter(totalCount:)` is called.
+    /// - Returns: A `Subprogress` instance.
+    public func makeChild(withPendingUnitCount count: Int) -> Subprogress {
 
         // Make ghost parent & add it to actual parent's children list
         let ghostProgressParent = Progress(totalUnitCount: Int64(count))
@@ -42,7 +42,7 @@ extension Progress {
         let observation = _ProgressParentProgressReporterChild(ghostParent: ghostProgressParent, ghostChild: ghostReporterChild)
 
         // Make actual child with ghost child being parent
-        var actualProgress = ghostReporterChild.assign(count: count)
+        var actualProgress = ghostReporterChild.subprogress(assigningCount: count)
         actualProgress.observation = observation
         actualProgress.ghostReporter = ghostReporterChild
         actualProgress.interopWithProgressParent = true
@@ -88,7 +88,7 @@ extension ProgressReporter {
     /// - Parameters:
     ///   - count: Number of units delegated from `self`'s `totalCount`.
     ///   - progress: `Progress` which receives the delegated `count`.
-    public func assign(count: Int, to progress: Foundation.Progress) {
+    public func subprogress(assigningCount count: Int, to progress: Foundation.Progress) {
         let parentBridge = _NSProgressParentBridge(reporterParent: self)
         progress._setParent(parentBridge, portion: Int64(count))
 

Sources/FoundationEssentials/ProgressReporter/ProgressReporter+Progress.swift

@@ -11,46 +11,44 @@
 //===----------------------------------------------------------------------===//
 
 @available(FoundationPreview 6.2, *)
-// ProgressReporter.Progress
-extension ProgressReporter {
-    /// ProgressReporter.Progress is a nested ~Copyable struct used to establish parent-child relationship between two instances of ProgressReporter.
-    ///
-    /// ProgressReporter.Progress is returned from a call to `assign(count:)` by a parent ProgressReporter.
-    /// A child ProgressReporter is then returned by calling`reporter(totalCount:)` on a ProgressReporter.Progress.
-    public struct Progress: ~Copyable, Sendable {
-        internal var parent: ProgressReporter
-        internal var portionOfParent: Int
-        internal var isInitializedToProgressReporter: Bool
+/// Subprogress is a nested ~Copyable struct used to establish parent-child relationship between two instances of ProgressReporter.
+///
+/// Subprogress is returned from a call to `subprogress(assigningCount:)` by a parent ProgressReporter.
+/// A child ProgressReporter is then returned by calling`reporter(totalCount:)` on a Subprogress.
+public struct Subprogress: ~Copyable, Sendable {
+    internal var parent: ProgressReporter
+    internal var portionOfParent: Int
+    internal var isInitializedToProgressReporter: Bool
+    
+    // Interop variables for Progress - ProgressReporter Interop
+    internal var interopWithProgressParent: Bool = false
+    // To be kept alive in ProgressReporter
+    internal var observation: (any Sendable)?
+    internal var ghostReporter: ProgressReporter?
+            
+    internal init(parent: ProgressReporter, portionOfParent: Int) {
+        self.parent = parent
+        self.portionOfParent = portionOfParent
+        self.isInitializedToProgressReporter = false
+    }
+    
+    /// Instantiates a ProgressReporter which is a child to the parent from which `self` is returned.
+    /// - Parameter totalCount: Total count of returned child `ProgressReporter` instance.
+    /// - Returns: A `ProgressReporter` instance.
+    public consuming func reporter(totalCount: Int?) -> ProgressReporter {
+        isInitializedToProgressReporter = true
 
-        // Interop variables for Progress - ProgressReporter Interop
-        internal var interopWithProgressParent: Bool = false
-        // To be kept alive in ProgressReporter
-        internal var observation: (any Sendable)?
-        internal var ghostReporter: ProgressReporter?
-                
-        internal init(parent: ProgressReporter, portionOfParent: Int) {
-            self.parent = parent
-            self.portionOfParent = portionOfParent
-            self.isInitializedToProgressReporter = false
-        }
+        let childReporter = ProgressReporter(total: totalCount, parent: parent, portionOfParent: portionOfParent, ghostReporter: ghostReporter, interopObservation: observation)
 
-        /// Instantiates a ProgressReporter which is a child to the parent from which `self` is returned.
-        /// - Parameter totalCount: Total count of returned child `ProgressReporter` instance.
-        /// - Returns: A `ProgressReporter` instance.
-        public consuming func reporter(totalCount: Int?) -> ProgressReporter {
-            isInitializedToProgressReporter = true
-            
-            let childReporter = ProgressReporter(total: totalCount, parent: parent, portionOfParent: portionOfParent, ghostReporter: ghostReporter, interopObservation: observation)
-            
-            if interopWithProgressParent {
-                // Set interop child of ghost reporter so ghost reporter reads from here
-                ghostReporter?.setInteropChild(interopChild: childReporter)
-            } else {
-                // Add child to parent's _children list
-               parent.addToChildren(childReporter: childReporter)
-            }
-            
-            return childReporter
+        if interopWithProgressParent {
+            // Set interop child of ghost reporter so ghost reporter reads from here
+            ghostReporter?.setInteropChild(interopChild: childReporter)
+        } else {
+            // Add child to parent's _children list
+           parent.addToChildren(childReporter: childReporter)
         }
+        
+        return childReporter
     }
 }
+

Sources/FoundationEssentials/ProgressReporter/ProgressReporter.swift

@@ -269,17 +269,16 @@ internal struct AnyMetatypeWrapper: Hashable, Equatable, Sendable {
     }
 
 
-    /// Returns a `ProgressReporter.Progress` representing a portion of `self`which can be passed to any method that reports progress.
+    /// Returns a `Subprogress` representing a portion of `self`which can be passed to any method that reports progress.
     ///
-    /// - Parameter count: Units, which is a portion of `totalCount`delegated to an instance of `ProgressReporter.Progress`.
-    /// - Returns: A `ProgressReporter.Progress` instance.
-    public func assign(count portionOfParent: Int) -> Progress {
+    /// - Parameter count: Units, which is a portion of `totalCount`delegated to an instance of `Subprogress`.
+    /// - Returns: A `Subprogress` instance.
+    public func subprogress(assigningCount portionOfParent: Int) -> Subprogress {
         precondition(portionOfParent > 0, "Giving out zero units is not a valid operation.")
-        let childProgress = Progress(parent: self, portionOfParent: portionOfParent)
-        return childProgress
+        let subprogress = Subprogress(parent: self, portionOfParent: portionOfParent)
+        return subprogress
     }
 
-    
     /// Increases `completedCount` by `count`.
     /// - Parameter count: Units of work.
     public func complete(count: Int) {