Skip to content

Let CodeGenerators provide extension for CustomOptions. #1679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 16, 2024
Merged

Let CodeGenerators provide extension for CustomOptions. #1679

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion Sources/SwiftProtobufPluginLibrary/CodeGenerator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ public protocol CodeGenerator {
/// error.
var supportedEditionRange: ClosedRange<Google_Protobuf_Edition> { get }

/// A list of extensions that define Custom Options
/// (https://protobuf.dev/programming-guides/proto2/#customoptions) for this generator so
/// they will be exposed on the `Descriptor` options.
var customOptionExtensions: [any AnyMessageExtension] { get }

/// If provided, the argument parsing will support `--version` and report
/// this value.
var version: String? { get }
Expand Down Expand Up @@ -110,10 +115,29 @@ extension CodeGenerator {
return
}

var extensionMap = SimpleExtensionMap()
if !customOptionExtensions.isEmpty {
for e in customOptionExtensions {
// Don't include Google_Protobuf_FeatureSet, that will be handing via custom features.
precondition(e.messageType == Google_Protobuf_EnumOptions.self ||
e.messageType == Google_Protobuf_EnumValueOptions.self ||
e.messageType == Google_Protobuf_ExtensionRangeOptions.self ||
e.messageType == Google_Protobuf_FieldOptions.self ||
e.messageType == Google_Protobuf_FileOptions.self ||
e.messageType == Google_Protobuf_MessageOptions.self ||
e.messageType == Google_Protobuf_MethodOptions.self ||
e.messageType == Google_Protobuf_OneofOptions.self ||
e.messageType == Google_Protobuf_ServiceOptions.self,
"CodeGenerator `customOptionExtensions` must only extend the descriptor.proto 'Options' messages \(e.messageType).")
}
extensionMap.insert(contentsOf: customOptionExtensions)
}

let response: Google_Protobuf_Compiler_CodeGeneratorResponse
do {
let request = try Google_Protobuf_Compiler_CodeGeneratorRequest(
serializedBytes: FileHandle.standardInput.readDataToEndOfFile()
serializedBytes: FileHandle.standardInput.readDataToEndOfFile(),
extensions: extensionMap
)
response = generateCode(request: request, generator: self)
} catch let e {
Expand Down Expand Up @@ -150,6 +174,7 @@ extension CodeGenerator {
// they support editions.
return Google_Protobuf_Edition.unknown...Google_Protobuf_Edition.unknown
}
public var customOptionExtensions: [any AnyMessageExtension] { return [] }
public var version: String? { return nil }
public var projectURL: String? { return nil }
public var copyrightLine: String? { return nil }
Expand Down