[xcodegen] NFC: Fold Xcodeproj library into SwiftXcodeGen

This was originally a separate library since it was copied directly
from the legacy SwiftPM library. However it's since been changed a
bunch, and ought to be able leverage SwiftXcodeGen utilities such as
RelativePath. Fold it into SwiftXcodeGen.

I considered splitting out the utility code from SwiftXcodeGen into
a new library, but unfortunately that currently regresses performance
(even with max CMO). The module organization doesn't really currently
matter since we don't expose any products.

Author: hamishknight

utils/swift-xcodegen/Package.swift

@@ -8,13 +8,14 @@ let package = Package(
     name: "swift-xcodegen",
     platforms: [.macOS(.v13)],
     targets: [
-        .target(name: "Xcodeproj", exclude: ["README.md"]),
         .target(
             name: "SwiftXcodeGen",
             dependencies: [
               .product(name: "ArgumentParser", package: "swift-argument-parser"),
               .product(name: "SwiftOptions", package: "swift-driver"),
-              "Xcodeproj"
+            ],
+            exclude: [
+              "Xcodeproj/README.md",
             ],
             swiftSettings: [
               .enableExperimentalFeature("StrictConcurrency")

utils/swift-xcodegen/Sources/SwiftXcodeGen/Generator/ProjectGenerator.swift

@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Xcodeproj
 import Darwin
 
 extension Xcode.Reference {

utils/swift-xcodegen/Sources/SwiftXcodeGen/Generator/SchemeGenerator.swift

@@ -10,8 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Xcodeproj
-
 struct Scheme {
   var name: String
   var buildAction: BuildAction

utils/swift-xcodegen/Sources/Xcodeproj/PropertyList.swift renamed to utils/swift-xcodegen/Sources/SwiftXcodeGen/Xcodeproj/PropertyList.swift

@@ -16,16 +16,16 @@
  and serialization to .xcodeproj plists.  There is no consistency checking to
  ensure, for example, that build settings have valid values, dependency cycles
  are not created, etc.
- 
+
  Everything here is geared toward supporting project generation.  The intended
  usage model is for custom logic to build up a project using Xcode terminology
  (e.g. "group", "reference", "target", "build phase"), but there is almost no
  provision for modifying the model after it has been built up.  The intent is
  to create it as desired from the start.
- 
+
  Rather than try to represent everything that Xcode's project model supports,
  the approach is to start small and to add functionality as needed.
- 
+
  Note that this API represents only the project model — there is no notion of
  workspaces, schemes, etc (although schemes are represented individually in a
  separate API).  The notion of build settings is also somewhat different from
@@ -37,11 +37,11 @@
  configuration of the settings, since most values are the same between Debug
  and Release.  Also, the build settings themselves are represented as structs
  of named fields, instead of dictionaries with arbitrary name strings as keys.
- 
+
  It is expected that some of these simplifications will need to be lifted over
  time, based on need.  That should be done carefully, however, to avoid ending
  up with an overly complicated model.
- 
+
  Some things that are incomplete in even this first model:
  - copy files build phases are incomplete
  - shell script build phases are incomplete
@@ -57,7 +57,7 @@
  */
 
 public struct Xcode {
-  
+
   /// An Xcode project, consisting of a tree of groups and file references,
   /// a list of targets, and some additional information.  Note that schemes
   /// are outside of the project data model.
@@ -74,7 +74,7 @@ public struct Xcode {
       self.projectDir = ""
       self.targets = []
     }
-    
+
     /// Creates and adds a new target (which does not initially have any
     /// build phases).
     public func addTarget(objectID: String? = nil, productType: Target.ProductType? = nil, name: String) -> Target {
@@ -94,7 +94,7 @@ public struct Xcode {
     /// Name of the reference, if different from the last path component
     /// (if not set, Xcode will use the last path component as the name).
     public var name: String?
-    
+
     /// Determines the base path for a reference's relative path (this is
     /// what for some reason is called a "source tree" in Xcode).
     public enum RefPathBase: String {
@@ -111,13 +111,13 @@ public struct Xcode {
       /// destination, or even an overridden build setting.
       case buildDir = "BUILT_PRODUCTS_DIR"
     }
-    
+
     init(path: String, pathBase: RefPathBase = .groupDir, name: String? = nil) {
       self.path = path
       self.pathBase = pathBase
       self.name = name
     }
-    
+
     /// Whether this is either a group or directory reference (blue folder).
     public var isDirectoryLike: Bool {
       if self is Xcode.Group {
@@ -129,7 +129,7 @@ public struct Xcode {
       return false
     }
   }
-  
+
   /// A reference to a file system entity (a file, folder, etc).
   public final class FileReference: Reference {
     public var objectID: String?
@@ -153,7 +153,7 @@ public struct Xcode {
   /// references whose source tree type is GroupRelative.
   public final class Group: Reference {
     public var subitems = [Reference]()
-    
+
     /// Creates and appends a new Group to the list of subitems.
     /// The new group is returned so that it can be configured.
     @discardableResult
@@ -166,7 +166,7 @@ public struct Xcode {
       subitems.append(group)
       return group
     }
-    
+
     /// Creates and appends a new FileReference to the list of subitems.
     @discardableResult
     public func addFileReference(
@@ -212,11 +212,11 @@ public struct Xcode {
       self.dependencies = []
       self.buildableFolders = []
     }
-    
+
     // FIXME: There's a lot repetition in these methods; using generics to
     // try to avoid that raised other issues in terms of requirements on
     // the Reference class, though.
-    
+
     /// Adds a "headers" build phase, i.e. one that copies headers into a
     /// directory of the product, after suitable processing.
     @discardableResult
@@ -225,7 +225,7 @@ public struct Xcode {
       buildPhases.append(phase)
       return phase
     }
-    
+
     /// Adds a "sources" build phase, i.e. one that compiles sources and
     /// provides them to be linked into the executable code of the product.
     @discardableResult
@@ -234,7 +234,7 @@ public struct Xcode {
       buildPhases.append(phase)
       return phase
     }
-    
+
     /// Adds a "frameworks" build phase, i.e. one that links compiled code
     /// and libraries into the executable of the product.
     @discardableResult
@@ -243,7 +243,7 @@ public struct Xcode {
       buildPhases.append(phase)
       return phase
     }
-    
+
     /// Adds a "copy files" build phase, i.e. one that copies files to an
     /// arbitrary location relative to the product.
     @discardableResult
@@ -252,7 +252,7 @@ public struct Xcode {
       buildPhases.append(phase)
       return phase
     }
-    
+
     /// Adds a "shell script" build phase, i.e. one that runs a custom
     /// shell script as part of the build.
     @discardableResult
@@ -265,7 +265,7 @@ public struct Xcode {
       buildPhases.append(phase)
       return phase
     }
-    
+
     /// Adds a dependency on another target.
     /// FIXME: We do not check for cycles.  Should we?  This is an extremely
     /// minimal API so it's not clear that we should.
@@ -286,11 +286,11 @@ public struct Xcode {
       public unowned var target: Target
     }
   }
-  
+
   /// Abstract base class for all build phases in a target.
   public class BuildPhase {
     public var files: [BuildFile] = []
-    
+
     /// Adds a new build file that refers to `fileRef`.
     @discardableResult
     public func addBuildFile(fileRef: FileReference) -> BuildFile {
@@ -299,25 +299,25 @@ public struct Xcode {
       return buildFile
     }
   }
-  
+
   /// A "headers" build phase, i.e. one that copies headers into a directory
   /// of the product, after suitable processing.
   public final class HeadersBuildPhase: BuildPhase {
     // Nothing extra yet.
   }
-  
+
   /// A "sources" build phase, i.e. one that compiles sources and provides
   /// them to be linked into the executable code of the product.
   public final class SourcesBuildPhase: BuildPhase {
     // Nothing extra yet.
   }
-  
+
   /// A "frameworks" build phase, i.e. one that links compiled code and
   /// libraries into the executable of the product.
   public final class FrameworksBuildPhase: BuildPhase {
     // Nothing extra yet.
   }
-  
+
   /// A "copy files" build phase, i.e. one that copies files to an arbitrary
   /// location relative to the product.
   public final class CopyFilesBuildPhase: BuildPhase {
@@ -326,7 +326,7 @@ public struct Xcode {
       self.dstDir = dstDir
     }
   }
-  
+
   /// A "shell script" build phase, i.e. one that runs a custom shell script.
   public final class ShellScriptBuildPhase: BuildPhase {
     public var script: String
@@ -340,27 +340,27 @@ public struct Xcode {
       self.alwaysRun = alwaysRun
     }
   }
-  
+
   /// A build file, representing the membership of a file reference in a
   /// build phase of a target.
   public final class BuildFile {
     public var fileRef: FileReference?
     init(fileRef: FileReference) {
       self.fileRef = fileRef
     }
-    
+
     public var settings = Settings()
-    
+
     /// A set of file settings.
     public struct Settings: Encodable {
       public var ATTRIBUTES: [String]?
       public var COMPILER_FLAGS: String?
-      
+
       public init() {
       }
     }
   }
-  
+
   /// A table of build settings, which for the sake of simplicity consists
   /// (in this simplified model) of a set of common settings, and a set of
   /// overlay settings for Debug and Release builds.  There can also be a
@@ -369,21 +369,21 @@ public struct Xcode {
     /// Common build settings are in both generated configurations (Debug
     /// and Release).
     public var common = BuildSettings()
-    
+
     /// Debug build settings are overlaid over the common settings in the
     /// generated Debug configuration.
     public var debug = BuildSettings()
-    
+
     /// Release build settings are overlaid over the common settings in the
     /// generated Release configuration.
     public var release = BuildSettings()
-    
+
     /// An optional file reference to an .xcconfig file.
     public var xcconfigFileRef: FileReference?
-    
+
     public init() {
     }
-    
+
     /// A set of build settings, which is represented as a struct of optional
     /// build settings.  This is not optimally efficient, but it is great for
     /// code completion and type-checking.

utils/swift-xcodegen/Sources/Xcodeproj/PropertyListEncoder.swift renamed to utils/swift-xcodegen/Sources/SwiftXcodeGen/Xcodeproj/PropertyListEncoder.swift

@@ -386,6 +386,14 @@ extension Xcode.BuildSettingsTable: PropertyListSerializable {
   }
 }
 
+fileprivate struct InternalError: Error {
+  private let description: String
+  public init(_ description: String) {
+    assertionFailure(description)
+    self.description = description
+  }
+}
+
 /// Private helper function that combines a base property list and an overlay
 /// property list, respecting the semantics of `$(inherited)` as we go.
 fileprivate func combineBuildSettingsPropertyLists(