Avoid proto comments during experimental_strip_nonfunctional_codegen.

Following upstream protobuf, honor the experimental_strip_nonfunctional_codegen generation option to not include comments in generated code.
apple · Feb 21, 2024 · 29c253f · 29c253f
1 parent 8ee79e4
commit 29c253f
Show file tree

Hide file tree

Showing 7 changed files with 70 additions and 9 deletions.
diff --git a/Sources/protoc-gen-swift/EnumGenerator.swift b/Sources/protoc-gen-swift/EnumGenerator.swift
@@ -56,7 +56,7 @@ class EnumGenerator {
 
     p.print(
       "",
-      "\(enumDescriptor.protoSourceCommentsWithDeprecation())\(visibility)enum \(swiftRelativeName): \(namer.swiftProtobufModulePrefix)Enum {")
+      "\(enumDescriptor.protoSourceCommentsWithDeprecation(generatorOptions: generatorOptions))\(visibility)enum \(swiftRelativeName): \(namer.swiftProtobufModulePrefix)Enum {")
     p.withIndentation { p in
       p.print("\(visibility)typealias RawValue = Int")
 
@@ -117,7 +117,7 @@ class EnumGenerator {
   private func generateCasesOrAliases(printer p: inout CodePrinter) {
     let visibility = generatorOptions.visibilitySourceSnippet
     for enumValueDescriptor in namer.uniquelyNamedValues(valueAliasInfo: aliasInfo) {
-      let comments = enumValueDescriptor.protoSourceCommentsWithDeprecation()
+      let comments = enumValueDescriptor.protoSourceCommentsWithDeprecation(generatorOptions: generatorOptions)
       if !comments.isEmpty {
         p.print()
       }

diff --git a/Sources/protoc-gen-swift/ExtensionSetGenerator.swift b/Sources/protoc-gen-swift/ExtensionSetGenerator.swift
@@ -57,7 +57,7 @@ class ExtensionSetGenerator {
 
             swiftFullExtensionName = namer.fullName(extensionField: descriptor)
 
-            comments = descriptor.protoSourceCommentsWithDeprecation()
+            comments = descriptor.protoSourceCommentsWithDeprecation(generatorOptions: generatorOptions)
             containingTypeSwiftFullName = namer.fullName(message: fieldDescriptor.containingType)
         }
 

diff --git a/Sources/protoc-gen-swift/MessageFieldGenerator.swift b/Sources/protoc-gen-swift/MessageFieldGenerator.swift
@@ -71,7 +71,7 @@ class MessageFieldGenerator: FieldGeneratorBase, FieldGenerator {
         swiftStorageType = descriptor.swiftStorageType(namer: namer)
         swiftDefaultValue = descriptor.swiftDefaultValue(namer: namer)
         traitsType = descriptor.traitsType(namer: namer)
-        comments = descriptor.protoSourceCommentsWithDeprecation()
+        comments = descriptor.protoSourceCommentsWithDeprecation(generatorOptions: generatorOptions)
 
         if usesHeapStorage {
             storedProperty = "_storage.\(underscoreSwiftName)"

diff --git a/Sources/protoc-gen-swift/MessageGenerator.swift b/Sources/protoc-gen-swift/MessageGenerator.swift
@@ -129,7 +129,7 @@ class MessageGenerator {
 
     p.print(
         "",
-        "\(descriptor.protoSourceCommentsWithDeprecation())\(visibility)struct \(swiftRelativeName): \(conformances.joined(separator: ", ")) {")
+        "\(descriptor.protoSourceCommentsWithDeprecation(generatorOptions: generatorOptions))\(visibility)struct \(swiftRelativeName): \(conformances.joined(separator: ", ")) {")
     p.withIndentation { p in
       p.print("""
               // \(namer.swiftProtobufModuleName).Message conformance is added in an extension below. See the

diff --git a/Sources/protoc-gen-swift/OneofGenerator.swift b/Sources/protoc-gen-swift/OneofGenerator.swift
@@ -42,7 +42,7 @@ class OneofGenerator {
         // Only valid on message fields.
         var messageType: Descriptor? { return fieldDescriptor.messageType }
 
-        init(descriptor: FieldDescriptor, namer: SwiftProtobufNamer) {
+        init(descriptor: FieldDescriptor, generatorOptions: GeneratorOptions, namer: SwiftProtobufNamer) {
             precondition(descriptor.oneofIndex != nil)
 
             // Set after creation.
@@ -57,7 +57,7 @@ class OneofGenerator {
             swiftType = descriptor.swiftType(namer: namer)
             swiftDefaultValue = descriptor.swiftDefaultValue(namer: namer)
             protoGenericType = descriptor.protoGenericType
-            comments = descriptor.protoSourceCommentsWithDeprecation()
+            comments = descriptor.protoSourceCommentsWithDeprecation(generatorOptions: generatorOptions)
 
             super.init(descriptor: descriptor)
         }
@@ -130,7 +130,7 @@ class OneofGenerator {
         self.namer = namer
         self.usesHeapStorage = usesHeapStorage
 
-        comments = descriptor.protoSourceComments()
+        comments = descriptor.protoSourceComments(generatorOptions: generatorOptions)
 
         swiftRelativeName = namer.relativeName(oneof: descriptor)
         swiftFullName = namer.fullName(oneof: descriptor)
@@ -145,7 +145,9 @@ class OneofGenerator {
         }
 
         fields = descriptor.fields.map {
-            return MemberFieldGenerator(descriptor: $0, namer: namer)
+            return MemberFieldGenerator(descriptor: $0,
+                                        generatorOptions: generatorOptions,
+                                        namer: namer)
         }
         fieldsSortedByNumber = fields.sorted {$0.number < $1.number}
 

diff --git a/Sources/protoc-gen-swift/ProvidesDeprecationComment+Extensions.swift b/Sources/protoc-gen-swift/ProvidesDeprecationComment+Extensions.swift
@@ -0,0 +1,29 @@
+// Sources/protoc-gen-swift/ProvidesSourceCodeLocation+Extensions.swift
+//
+// Copyright (c) 2014 - 2024 Apple Inc. and the project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See LICENSE.txt for license information:
+// https://github.com/apple/swift-protobuf/blob/main/LICENSE.txt
+//
+// -----------------------------------------------------------------------------
+
+import Foundation
+
+import SwiftProtobufPluginLibrary
+
+extension ProvidesSourceCodeLocation {
+  func protoSourceComments(
+    generatorOptions: GeneratorOptions,
+    commentPrefix: String = "///",
+    leadingDetachedPrefix: String? = nil
+  ) -> String {
+    if generatorOptions.experimentalStripNonfunctionalCodegen {
+      // Comments are inherently non-functional, and may change subtly on
+      // transformations.
+      return String()
+    }
+    return protoSourceComments(commentPrefix: commentPrefix,
+                               leadingDetachedPrefix: leadingDetachedPrefix)
+  }
+}
diff --git a/Sources/protoc-gen-swift/ProvidesSourceCodeLocation+Extensions.swift b/Sources/protoc-gen-swift/ProvidesSourceCodeLocation+Extensions.swift
@@ -0,0 +1,30 @@
+// Sources/protoc-gen-swift/ProvidesDeprecationComment+Extensions.swift
+//
+// Copyright (c) 2014 - 2024 Apple Inc. and the project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See LICENSE.txt for license information:
+// https://github.com/apple/swift-protobuf/blob/main/LICENSE.txt
+//
+// -----------------------------------------------------------------------------
+
+import Foundation
+
+import SwiftProtobufPluginLibrary
+
+extension ProvidesDeprecationComment where Self: ProvidesSourceCodeLocation {
+  func protoSourceCommentsWithDeprecation(
+    generatorOptions: GeneratorOptions,
+    commentPrefix: String = "///",
+    leadingDetachedPrefix: String? = nil
+  ) -> String {
+    if generatorOptions.experimentalStripNonfunctionalCodegen {
+      // Comments are inherently non-functional, and may change subtly on
+      // transformations.
+      return deprecationComment(commentPrefix: commentPrefix)
+    }
+
+    return protoSourceCommentsWithDeprecation(commentPrefix: commentPrefix,
+                                              leadingDetachedPrefix: leadingDetachedPrefix)
+  }
+}