[xcodegen] Add file references to project first

This requires ensuring we check that we're not
ever attempting to add a group under an existing
folder reference. This will be required for
buildable folders.

Author: hamishknight

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

@@ -25,7 +25,13 @@ fileprivate final class ProjectGenerator {
   private var project = Xcode.Project()
   private let allTarget: Xcode.Target
 
-  private var groups: [RelativePath: Xcode.Group] = [:]
+  enum CachedGroup {
+    /// Covered by a parent folder reference.
+    case covered
+    /// Present in the project.
+    case present(Xcode.Group)
+  }
+  private var groups: [RelativePath: CachedGroup] = [:]
   private var files: [RelativePath: Xcode.FileReference] = [:]
   private var targets: [String: Xcode.Target] = [:]
   private var unbuildableSources: [ClangTarget.Source] = []
@@ -103,7 +109,7 @@ fileprivate final class ProjectGenerator {
   /// for a file path relative to the project root.
   private func parentGroup(
     for path: RelativePath
-  ) -> (parentGroup: Xcode.Group, childPath: RelativePath) {
+  ) -> (parentGroup: Xcode.Group, childPath: RelativePath)? {
     guard let parent = path.parentDir else {
       // We've already handled paths under the repo, so this must be for
       // paths outside the repo.
@@ -114,18 +120,31 @@ fileprivate final class ProjectGenerator {
     if parent == repoRelativePath || parent == mainRepoDirInProject {
       return (project.mainGroup, path)
     }
-    return (group(for: parent), RelativePath(path.fileName))
+    guard let parentGroup = group(for: parent) else { return nil }
+    return (parentGroup, RelativePath(path.fileName))
   }
 
-  private func group(for path: RelativePath) -> Xcode.Group {
-    if let group = groups[path] {
-      return group
+  /// Returns the group for a given path, or `nil` if the path is covered
+  /// by a parent folder reference.
+  private func group(for path: RelativePath) -> Xcode.Group? {
+    if let result = groups[path] {
+      switch result {
+      case .covered:
+        return nil
+      case .present(let g):
+        return g
+      }
+    }
+    guard
+      files[path] == nil, let (parentGroup, childPath) = parentGroup(for: path)
+    else {
+      groups[path] = .covered
+      return nil
     }
-    let (parentGroup, childPath) = parentGroup(for: path)
     let group = parentGroup.addGroup(
       path: childPath.rawPath, pathBase: .groupDir, name: path.fileName
     )
-    groups[path] = group
+    groups[path] = .present(group)
     return group
   }
 
@@ -167,7 +186,9 @@ fileprivate final class ProjectGenerator {
         return nil
       }
     }
-    let (parentGroup, childPath) = parentGroup(for: path)
+    guard let (parentGroup, childPath) = parentGroup(for: path) else {
+      return nil
+    }
     let file = parentGroup.addFileReference(
       path: childPath.rawPath, isDirectory: ref.kind == .folder,
       pathBase: .groupDir, name: path.fileName
@@ -190,13 +211,19 @@ fileprivate final class ProjectGenerator {
   }
 
   func generateBaseTarget(
-    _ name: String, productType: Xcode.Target.ProductType?,
-    includeInAllTarget: Bool
+    _ name: String, at parentPath: RelativePath?,
+    productType: Xcode.Target.ProductType?, includeInAllTarget: Bool
   ) -> Xcode.Target? {
     guard targets[name] == nil else {
       log.warning("Duplicate target '\(name)', skipping")
       return nil
     }
+    // Make sure we can create a group for the parent path, otherwise
+    // this is nested in a folder reference and there's nothing we can do.
+    if let parentPath, !parentPath.components.isEmpty,
+       group(for: repoRelativePath.appending(parentPath)) == nil {
+      return nil
+    }
     let target = project.addTarget(productType: productType, name: name)
     targets[name] = target
     if includeInAllTarget {
@@ -263,7 +290,7 @@ fileprivate final class ProjectGenerator {
       return
     }
     let target = generateBaseTarget(
-      targetInfo.name, productType: .staticArchive,
+      targetInfo.name, at: targetInfo.parentPath, productType: .staticArchive,
       includeInAllTarget: includeInAllTarget
     )
     guard let target else { return }
@@ -437,7 +464,8 @@ fileprivate final class ProjectGenerator {
       )
     }
     let target = generateBaseTarget(
-      targetInfo.name, productType: nil, includeInAllTarget: includeInAllTarget
+      targetInfo.name, at: nil, productType: nil,
+      includeInAllTarget: includeInAllTarget
     )
     guard let target else { return nil }
 
@@ -478,7 +506,7 @@ fileprivate final class ProjectGenerator {
       return nil
     }
     let target = generateBaseTarget(
-      targetInfo.name, productType: .staticArchive,
+      targetInfo.name, at: buildRule.parentPath, productType: .staticArchive,
       includeInAllTarget: includeInAllTarget
     )
     guard let target else { return nil }
@@ -599,6 +627,12 @@ fileprivate final class ProjectGenerator {
     guard !generated else { return }
     generated = true
 
+    // First add file/folder references.
+    for ref in spec.referencesToAdd {
+      // Allow important references to bypass exclusion checks.
+      getOrCreateRepoRef(ref, allowExcluded: ref.isImportant)
+    }
+
     // Gather the Swift targets to generate, including any dependencies.
     var swiftTargets: Set<SwiftTarget> = []
     for targetSource in spec.swiftTargetSources {
@@ -681,11 +715,6 @@ fileprivate final class ProjectGenerator {
       }
     }
 
-    for ref in spec.referencesToAdd {
-      // Allow important references to bypass exclusion checks.
-      getOrCreateRepoRef(ref, allowExcluded: ref.isImportant)
-    }
-
     // Sort the groups.
     sortGroupChildren(project.mainGroup)
   }

utils/swift-xcodegen/Sources/SwiftXcodeGen/Path/PathProtocol.swift

@@ -127,8 +127,11 @@ extension PathProtocol {
 }
 
 extension Collection where Element: PathProtocol {
+  /// Computes the common parent for a collection of paths. If there is only
+  /// a single unique path, this returns the parent for that path.
   var commonAncestor: Element? {
     guard let first = self.first else { return nil }
-    return dropFirst().reduce(first, { $0.commonAncestor(with: $1) })
+    let result = dropFirst().reduce(first, { $0.commonAncestor(with: $1) })
+    return result == first ? result.parentDir : result
   }
 }