Skip to content

[JExtract] Translate generic parameters #336

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 31, 2025
Merged

[JExtract] Translate generic parameters #336

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,7 @@ let package = Package(
name: "JExtractSwiftLib",
dependencies: [
.product(name: "SwiftBasicFormat", package: "swift-syntax"),
.product(name: "SwiftLexicalLookup", package: "swift-syntax"),
.product(name: "SwiftSyntax", package: "swift-syntax"),
.product(name: "SwiftSyntaxBuilder", package: "swift-syntax"),
.product(name: "ArgumentParser", package: "swift-argument-parser"),
Expand Down
4 changes: 2 additions & 2 deletions Sources/JExtractSwiftLib/FFM/CDeclLowering/CRepresentation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ extension CType {
case .optional(let wrapped) where wrapped.isPointer:
try self.init(cdeclType: wrapped)

case .metatype, .optional, .tuple, .opaque, .existential:
case .genericParameter, .metatype, .optional, .tuple, .opaque, .existential:
throw CDeclToCLoweringError.invalidCDeclType(cdeclType)
}
}
Expand Down Expand Up @@ -98,7 +98,7 @@ extension CFunction {

enum CDeclToCLoweringError: Error {
case invalidCDeclType(SwiftType)
case invalidNominalType(SwiftNominalTypeDeclaration)
case invalidNominalType(SwiftTypeDeclaration)
case invalidFunctionConvention(SwiftFunctionType)
}

Expand Down
75 changes: 38 additions & 37 deletions Sources/JExtractSwiftLib/FFM/CDeclLowering/FFMSwift2JavaGenerator+FunctionLowering.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ extension FFMSwift2JavaGenerator {
) throws -> LoweredFunctionSignature {
let signature = try SwiftFunctionSignature(
decl,
enclosingType: try enclosingType.map { try SwiftType($0, symbolTable: symbolTable) },
symbolTable: symbolTable
enclosingType: try enclosingType.map { try SwiftType($0, lookupContext: lookupContext) },
lookupContext: lookupContext
)
return try CdeclLowering(symbolTable: symbolTable).lowerFunctionSignature(signature)
return try CdeclLowering(symbolTable: lookupContext.symbolTable).lowerFunctionSignature(signature)
}

/// Lower the given initializer to a C-compatible entrypoint,
Expand All @@ -42,11 +42,11 @@ extension FFMSwift2JavaGenerator {
) throws -> LoweredFunctionSignature {
let signature = try SwiftFunctionSignature(
decl,
enclosingType: try enclosingType.map { try SwiftType($0, symbolTable: symbolTable) },
symbolTable: symbolTable
enclosingType: try enclosingType.map { try SwiftType($0, lookupContext: lookupContext) },
lookupContext: lookupContext
)

return try CdeclLowering(symbolTable: symbolTable).lowerFunctionSignature(signature)
return try CdeclLowering(symbolTable: lookupContext.symbolTable).lowerFunctionSignature(signature)
}

/// Lower the given variable decl to a C-compatible entrypoint,
Expand All @@ -66,10 +66,10 @@ extension FFMSwift2JavaGenerator {
let signature = try SwiftFunctionSignature(
decl,
isSet: isSet,
enclosingType: try enclosingType.map { try SwiftType($0, symbolTable: symbolTable) },
symbolTable: symbolTable
enclosingType: try enclosingType.map { try SwiftType($0, lookupContext: lookupContext) },
lookupContext: lookupContext
)
return try CdeclLowering(symbolTable: symbolTable).lowerFunctionSignature(signature)
return try CdeclLowering(symbolTable: lookupContext.symbolTable).lowerFunctionSignature(signature)
}
}

Expand Down Expand Up @@ -98,18 +98,22 @@ struct CdeclLowering {
try lowerParameter(
selfParameter.type,
convention: selfParameter.convention,
parameterName: selfParameter.parameterName ?? "self"
parameterName: selfParameter.parameterName ?? "self",
genericParameters: signature.genericParameters,
genericRequirements: signature.genericRequirements
)
case nil, .initializer(_), .staticMethod(_):
nil
}

// Lower all of the parameters.
let loweredParameters = try signature.parameters.enumerated().map { (index, param) in
try lowerParameter(
return try lowerParameter(
param.type,
convention: param.convention,
parameterName: param.parameterName ?? "_\(index)"
parameterName: param.parameterName ?? "_\(index)",
genericParameters: signature.genericParameters,
genericRequirements: signature.genericRequirements
)
}

Expand Down Expand Up @@ -142,7 +146,9 @@ struct CdeclLowering {
func lowerParameter(
_ type: SwiftType,
convention: SwiftParameterConvention,
parameterName: String
parameterName: String,
genericParameters: [SwiftGenericParameterDeclaration],
genericRequirements: [SwiftGenericRequirement]
) throws -> LoweredParameter {
// If there is a 1:1 mapping between this Swift type and a C type, we just
// return it.
Expand Down Expand Up @@ -257,7 +263,7 @@ struct CdeclLowering {
guard let genericArgs = nominal.genericArguments, genericArgs.count == 1 else {
throw LoweringError.unhandledType(type)
}
return try lowerOptionalParameter(genericArgs[0], convention: convention, parameterName: parameterName)
return try lowerOptionalParameter(genericArgs[0], convention: convention, parameterName: parameterName, genericParameters: genericParameters, genericRequirements: genericRequirements)

case .string:
// 'String' is passed in by C string. i.e. 'UnsafePointer<Int8>' ('const uint8_t *')
Expand Down Expand Up @@ -300,7 +306,7 @@ struct CdeclLowering {

case .tuple(let tuple):
if tuple.count == 1 {
return try lowerParameter(tuple[0], convention: convention, parameterName: parameterName)
return try lowerParameter(tuple[0], convention: convention, parameterName: parameterName, genericParameters: genericParameters, genericRequirements: genericRequirements)
}
if convention == .inout {
throw LoweringError.inoutNotSupported(type)
Expand All @@ -310,7 +316,7 @@ struct CdeclLowering {
for (idx, element) in tuple.enumerated() {
// FIXME: Use tuple element label.
let cdeclName = "\(parameterName)_\(idx)"
let lowered = try lowerParameter(element, convention: convention, parameterName: cdeclName)
let lowered = try lowerParameter(element, convention: convention, parameterName: cdeclName, genericParameters: genericParameters, genericRequirements: genericRequirements)

parameters.append(contentsOf: lowered.cdeclParameters)
conversions.append(lowered.conversion)
Expand All @@ -330,20 +336,14 @@ struct CdeclLowering {
conversion: conversion
)

case .opaque(let proto), .existential(let proto):
// If the protocol has a known representative implementation, e.g. `String` for `StringProtocol`
// Translate it as the concrete type.
// NOTE: This is a temporary workaround until we add support for generics.
if
let knownProtocol = proto.asNominalTypeDeclaration?.knownTypeKind,
let concreteTy = knownTypes.representativeType(of: knownProtocol)
{
return try lowerParameter(concreteTy, convention: convention, parameterName: parameterName)
case .opaque, .existential, .genericParameter:
if let concreteTy = type.representativeConcreteTypeIn(knownTypes: knownTypes, genericParameters: genericParameters, genericRequirements: genericRequirements) {
return try lowerParameter(concreteTy, convention: convention, parameterName: parameterName, genericParameters: genericParameters, genericRequirements: genericRequirements)
}
throw LoweringError.unhandledType(type)

case .optional(let wrapped):
return try lowerOptionalParameter(wrapped, convention: convention, parameterName: parameterName)
return try lowerOptionalParameter(wrapped, convention: convention, parameterName: parameterName, genericParameters: genericParameters, genericRequirements: genericRequirements)
}
}

Expand All @@ -354,7 +354,9 @@ struct CdeclLowering {
func lowerOptionalParameter(
_ wrappedType: SwiftType,
convention: SwiftParameterConvention,
parameterName: String
parameterName: String,
genericParameters: [SwiftGenericParameterDeclaration],
genericRequirements: [SwiftGenericRequirement]
) throws -> LoweredParameter {
// If there is a 1:1 mapping between this Swift type and a C type, lower it to 'UnsafePointer<T>?'
if let _ = try? CType(cdeclType: wrappedType) {
Expand Down Expand Up @@ -398,18 +400,15 @@ struct CdeclLowering {
conversion: .pointee(.typedPointer(.optionalChain(.placeholder), swiftType: wrappedType))
)

case .existential(let proto), .opaque(let proto):
if
let knownProtocol = proto.asNominalTypeDeclaration?.knownTypeKind,
let concreteTy = knownTypes.representativeType(of: knownProtocol)
{
return try lowerOptionalParameter(concreteTy, convention: convention, parameterName: parameterName)
case .existential, .opaque, .genericParameter:
if let concreteTy = wrappedType.representativeConcreteTypeIn(knownTypes: knownTypes, genericParameters: genericParameters, genericRequirements: genericRequirements) {
return try lowerOptionalParameter(concreteTy, convention: convention, parameterName: parameterName, genericParameters: genericParameters, genericRequirements: genericRequirements)
}
throw LoweringError.unhandledType(.optional(wrappedType))

case .tuple(let tuple):
if tuple.count == 1 {
return try lowerOptionalParameter(tuple[0], convention: convention, parameterName: parameterName)
return try lowerOptionalParameter(tuple[0], convention: convention, parameterName: parameterName, genericParameters: genericParameters, genericRequirements: genericRequirements)
}
throw LoweringError.unhandledType(.optional(wrappedType))

Expand Down Expand Up @@ -514,7 +513,7 @@ struct CdeclLowering {
// Custom types are not supported yet.
throw LoweringError.unhandledType(type)

case .function, .metatype, .optional, .tuple, .existential, .opaque:
case .genericParameter, .function, .metatype, .optional, .tuple, .existential, .opaque:
// TODO: Implement
throw LoweringError.unhandledType(type)
}
Expand Down Expand Up @@ -668,7 +667,7 @@ struct CdeclLowering {
conversion: .tupleExplode(conversions, name: outParameterName)
)

case .function, .optional, .existential, .opaque:
case .genericParameter, .function, .optional, .existential, .opaque:
throw LoweringError.unhandledType(type)
}
}
Expand Down Expand Up @@ -754,7 +753,9 @@ public struct LoweredFunctionSignature: Equatable {
selfParameter: nil,
parameters: allLoweredParameters,
result: SwiftResult(convention: .direct, type: result.cdeclResultType),
effectSpecifiers: []
effectSpecifiers: [],
genericParameters: [],
genericRequirements: []
)
}
}
Expand Down
81 changes: 54 additions & 27 deletions Sources/JExtractSwiftLib/FFM/FFMSwift2JavaGenerator+JavaTranslation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ extension FFMSwift2JavaGenerator {

let translated: TranslatedFunctionDecl?
do {
let translation = JavaTranslation(symbolTable: self.symbolTable)
let translation = JavaTranslation(knownTypes: SwiftKnownTypes(symbolTable: lookupContext.symbolTable))
translated = try translation.translate(decl)
} catch {
self.log.info("Failed to translate: '\(decl.swiftDecl.qualifiedNameForDebug)'; \(error)")
Expand Down Expand Up @@ -115,8 +115,8 @@ extension FFMSwift2JavaGenerator {
struct JavaTranslation {
var knownTypes: SwiftKnownTypes

init(symbolTable: SwiftSymbolTable) {
self.knownTypes = SwiftKnownTypes(symbolTable: symbolTable)
init(knownTypes: SwiftKnownTypes) {
self.knownTypes = knownTypes
}

func translate(
Expand Down Expand Up @@ -256,7 +256,9 @@ extension FFMSwift2JavaGenerator {
convention: swiftSelf.convention,
parameterName: swiftSelf.parameterName ?? "self",
loweredParam: loweredFunctionSignature.selfParameter!,
methodName: methodName
methodName: methodName,
genericParameters: swiftSignature.genericParameters,
genericRequirements: swiftSignature.genericRequirements
)
} else {
selfParameter = nil
Expand All @@ -272,7 +274,9 @@ extension FFMSwift2JavaGenerator {
convention: swiftParam.convention,
parameterName: parameterName,
loweredParam: loweredParam,
methodName: methodName
methodName: methodName,
genericParameters: swiftSignature.genericParameters,
genericRequirements: swiftSignature.genericRequirements
)
}

Expand All @@ -295,7 +299,9 @@ extension FFMSwift2JavaGenerator {
convention: SwiftParameterConvention,
parameterName: String,
loweredParam: LoweredParameter,
methodName: String
methodName: String,
genericParameters: [SwiftGenericParameterDeclaration],
genericRequirements: [SwiftGenericRequirement]
) throws -> TranslatedParameter {

// If there is a 1:1 mapping between this Swift type and a C type, that can
Expand Down Expand Up @@ -352,7 +358,15 @@ extension FFMSwift2JavaGenerator {
guard let genericArgs = swiftNominalType.genericArguments, genericArgs.count == 1 else {
throw JavaTranslationError.unhandledType(swiftType)
}
return try translateOptionalParameter(wrappedType: genericArgs[0], convention: convention, parameterName: parameterName, loweredParam: loweredParam, methodName: methodName)
return try translateOptionalParameter(
wrappedType: genericArgs[0],
convention: convention,
parameterName: parameterName,
loweredParam: loweredParam,
methodName: methodName,
genericParameters: genericParameters,
genericRequirements: genericRequirements
)

case .string:
return TranslatedParameter(
Expand Down Expand Up @@ -399,28 +413,32 @@ extension FFMSwift2JavaGenerator {
conversion: .call(.placeholder, function: "\(methodName).$toUpcallStub", withArena: true)
)

case .existential(let proto), .opaque(let proto):
// If the protocol has a known representative implementation, e.g. `String` for `StringProtocol`
// Translate it as the concrete type.
// NOTE: This is a temporary workaround until we add support for generics.
if
let knownProtocol = proto.asNominalTypeDeclaration?.knownTypeKind,
let concreteTy = knownTypes.representativeType(of: knownProtocol)
{
case .existential, .opaque, .genericParameter:
if let concreteTy = swiftType.representativeConcreteTypeIn(knownTypes: knownTypes, genericParameters: genericParameters, genericRequirements: genericRequirements) {
return try translateParameter(
type: concreteTy,
convention: convention,
parameterName: parameterName,
loweredParam: loweredParam,
methodName: methodName
methodName: methodName,
genericParameters: genericParameters,
genericRequirements: genericRequirements
)
}

// Otherwise, not supported yet.
throw JavaTranslationError.unhandledType(swiftType)

case .optional(let wrapped):
return try translateOptionalParameter(wrappedType: wrapped, convention: convention, parameterName: parameterName, loweredParam: loweredParam, methodName: methodName)
return try translateOptionalParameter(
wrappedType: wrapped,
convention: convention,
parameterName: parameterName,
loweredParam: loweredParam,
methodName: methodName,
genericParameters: genericParameters,
genericRequirements: genericRequirements
)
}
}

Expand All @@ -430,12 +448,14 @@ extension FFMSwift2JavaGenerator {
convention: SwiftParameterConvention,
parameterName: String,
loweredParam: LoweredParameter,
methodName: String
methodName: String,
genericParameters: [SwiftGenericParameterDeclaration],
genericRequirements: [SwiftGenericRequirement]
) throws -> TranslatedParameter {
// If there is a 1:1 mapping between this Swift type and a C type, that can
// be expressed as a Java primitive type.
if let cType = try? CType(cdeclType: swiftType) {
var (translatedClass, lowerFunc) = switch cType.javaType {
let (translatedClass, lowerFunc) = switch cType.javaType {
case .int: ("OptionalInt", "toOptionalSegmentInt")
case .long: ("OptionalLong", "toOptionalSegmentLong")
case .double: ("OptionalDouble", "toOptionalSegmentDouble")
Expand Down Expand Up @@ -473,23 +493,30 @@ extension FFMSwift2JavaGenerator {
],
conversion: .call(.placeholder, function: "SwiftRuntime.toOptionalSegmentInstance", withArena: false)
)
case .existential(let proto), .opaque(let proto):
if
let knownProtocol = proto.asNominalTypeDeclaration?.knownTypeKind,
let concreteTy = knownTypes.representativeType(of: knownProtocol)
{
case .existential, .opaque, .genericParameter:
if let concreteTy = swiftType.representativeConcreteTypeIn(knownTypes: knownTypes, genericParameters: genericParameters, genericRequirements: genericRequirements) {
return try translateOptionalParameter(
wrappedType: concreteTy,
convention: convention,
parameterName: parameterName,
loweredParam: loweredParam,
methodName: methodName
methodName: methodName,
genericParameters: genericParameters,
genericRequirements: genericRequirements
)
}
throw JavaTranslationError.unhandledType(.optional(swiftType))
case .tuple(let tuple):
if tuple.count == 1 {
return try translateOptionalParameter(wrappedType: tuple[0], convention: convention, parameterName: parameterName, loweredParam: loweredParam, methodName: methodName)
return try translateOptionalParameter(
wrappedType: tuple[0],
convention: convention,
parameterName: parameterName,
loweredParam: loweredParam,
methodName: methodName,
genericParameters: genericParameters,
genericRequirements: genericRequirements
)
}
throw JavaTranslationError.unhandledType(.optional(swiftType))
default:
Expand Down Expand Up @@ -580,7 +607,7 @@ extension FFMSwift2JavaGenerator {
// TODO: Implement.
throw JavaTranslationError.unhandledType(swiftType)

case .optional, .function, .existential, .opaque:
case .genericParameter, .optional, .function, .existential, .opaque:
throw JavaTranslationError.unhandledType(swiftType)
}

Expand Down
Loading
Loading