Added writeCommentLine and support to group with the next line.

tristanlabelle · Oct 30, 2023 · 551eea6 · 551eea6
1 parent a2f322b
commit 551eea6
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 18 deletions.
diff --git a/Generator/Package.swift b/Generator/Package.swift
@@ -14,25 +14,28 @@ let package = Package(
         .package(url: "https://github.com/tristanlabelle/swift-dotnetmetadata", branch: "main")
     ],
     targets: [
-        // Code generator
+        .target(
+            name: "CodeWriters",
+            path: "Sources/CodeWriters"),
+        .target(
+            name: "ProjectionGenerator",
+            dependencies: [
+                "CodeWriters",
+                .product(name: "Collections", package: "swift-collections"),
+                .product(name: "DotNetMetadata", package: "swift-dotnetmetadata")
+            ],
+            path: "Sources/ProjectionGenerator"),
         .executableTarget(
             name: "SwiftWinRT",
             dependencies: [
+                "ProjectionGenerator",
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
                 .product(name: "Collections", package: "swift-collections"),
-                .product(name: "DotNetMetadata", package: "swift-dotnetmetadata"),
-                "ProjectionGenerator"
+                .product(name: "DotNetMetadata", package: "swift-dotnetmetadata")
             ],
             path: "Sources/SwiftWinRT",
             // Workaround for SPM library support limitations causing "LNK4217: locally defined symbol imported" spew
             linkerSettings: [ .unsafeFlags(["-Xlinker", "-ignore:4217"]) ]),
-        .target(
-            name: "CodeWriters",
-            path: "Sources/CodeWriters"),
-        .target(
-            name: "ProjectionGenerator",
-            dependencies: [ "CodeWriters" ],
-            path: "Sources/ProjectionGenerator"),
         .testTarget(
             name: "Tests",
             dependencies: [ "CodeWriters", "ProjectionGenerator" ],

diff --git a/Generator/Sources/CodeWriters/IndentedTextOutputStream.swift b/Generator/Sources/CodeWriters/IndentedTextOutputStream.swift
@@ -63,9 +63,10 @@ public class IndentedTextOutputStream: TextOutputStream {
         return .withGroup(AnonymousVerticalGroup(id: lastAllocatedGroupID))
     }
 
-    public func writeLine(grouping: VerticalGrouping = .withDefault, _ str: String = "") {
+    public func writeLine(grouping: VerticalGrouping = .withDefault, _ str: String = "", groupWithNext: Bool = false) {
         beginLine(grouping: grouping)
         write(str, endLine: true)
+        if groupWithNext { lineGrouping = nil }
     }
 
     private func write(_ str: Substring) {
@@ -128,8 +129,9 @@ public class IndentedTextOutputStream: TextOutputStream {
         }
     }
 
-    public func endLine() {
+    public func endLine(groupWithNext: Bool = false) {
         lineState = .end
+        if groupWithNext { lineGrouping = nil }
     }
 
     public func writeIndentedBlock(

diff --git a/Generator/Sources/CodeWriters/Swift/SyntaxWriters/SyntaxWriters.swift b/Generator/Sources/CodeWriters/Swift/SyntaxWriters/SyntaxWriters.swift
@@ -18,6 +18,13 @@ extension IndentedTextOutputStream {
 }
 
 extension SwiftSyntaxWriter {
+    public func writeCommentLine(_ comment: String, groupWithNext: Bool = true) {
+        output.beginLine(grouping: .never)
+        output.write("// ")
+        output.write(comment)
+        output.endLine(groupWithNext: groupWithNext)
+    }
+
     internal func writeTypeParameters(_ typeParameters: [String]) {
         guard !typeParameters.isEmpty else { return }
         var output = output

diff --git a/Generator/Sources/ProjectionGenerator/SwiftAssemblyModuleFileWriter+classes.swift b/Generator/Sources/ProjectionGenerator/SwiftAssemblyModuleFileWriter+classes.swift
@@ -142,7 +142,7 @@ extension SwiftAssemblyModuleFileWriter {
     }
 
     fileprivate func writeDefaultInitializer(_ classDefinition: ClassDefinition, to writer: SwiftTypeDefinitionWriter) throws {
-        writer.output.writeLine("// IActivationFactory")
+        writer.writeCommentLine("IActivationFactory")
 
         // 00000035-0000-0000-C000-000000000046
         let iactivationFactoryID = UUID(uuid: (

diff --git a/Generator/Sources/ProjectionGenerator/SwiftAssemblyModuleFileWriter+referenceTypes.swift b/Generator/Sources/ProjectionGenerator/SwiftAssemblyModuleFileWriter+referenceTypes.swift
@@ -103,7 +103,7 @@ extension SwiftAssemblyModuleFileWriter {
 
         var nonDefaultInterfaceStoredProperties = [String]()
         for interface in recursiveInterfaces {
-            try writer.output.writeLine("// \(WinRTTypeName.from(type: interface.asBoundType).description)")
+            try writer.writeCommentLine(WinRTTypeName.from(type: interface.asBoundType).description)
             if interface == defaultInterface {
                 try writeMemberImplementations(
                     interfaceOrDelegate: interface.asBoundType,

diff --git a/Generator/Sources/ProjectionGenerator/SwiftAssemblyModuleFileWriter.swift b/Generator/Sources/ProjectionGenerator/SwiftAssemblyModuleFileWriter.swift
@@ -11,8 +11,8 @@ public struct SwiftAssemblyModuleFileWriter {
         self.sourceFileWriter = SwiftSourceFileWriter(output: FileTextOutputStream(path: path))
         self.module = module
 
-        sourceFileWriter.output.writeLine("// Generated by swift-winrt")
-        sourceFileWriter.output.writeLine("// swiftlint:disable all")
+        sourceFileWriter.writeCommentLine("Generated by swift-winrt")
+        sourceFileWriter.writeCommentLine("swiftlint:disable all", groupWithNext: false)
 
         if importAbiModule {
             sourceFileWriter.writeImport(module: projection.abiModuleName)

diff --git a/Generator/Sources/ProjectionGenerator/SwiftNamespaceModuleFileWriter.swift b/Generator/Sources/ProjectionGenerator/SwiftNamespaceModuleFileWriter.swift
@@ -10,8 +10,8 @@ public struct SwiftNamespaceModuleFileWriter {
         self.sourceFileWriter = SwiftSourceFileWriter(output: FileTextOutputStream(path: path))
         self.module = module
 
-        sourceFileWriter.output.writeLine("// Generated by swift-winrt")
-        sourceFileWriter.output.writeLine("// swiftlint:disable all")
+        sourceFileWriter.writeCommentLine("Generated by swift-winrt")
+        sourceFileWriter.writeCommentLine("swiftlint:disable all", groupWithNext: false)
 
         sourceFileWriter.writeImport(module: module.assemblyModuleName)
     }