Skip to content

jextract/ffm: Fix TranslatedParameter to hold a single JavaParameter #759

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
ktoso merged 2 commits into from
May 19, 2026
Merged

jextract/ffm: Fix TranslatedParameter to hold a single JavaParameter #759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
986fe1d
FFM translated parameter has only one parameter
sidepelican May 19, 2026
20088e5
format
sidepelican May 19, 2026
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
15 changes: 6 additions & 9 deletions Sources/JExtractSwiftLib/FFM/FFMSwift2JavaGenerator+JavaBindingsPrinting.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,8 +310,8 @@ extension FFMSwift2JavaGenerator {
)
} else {
// Otherwise, the lambda must be wrapped with the lowered function instance.
let apiParams = functionType.parameters.flatMap {
$0.javaParameters.map { param in "\(param.type) \(param.name)" }
let apiParams = functionType.parameters.map {
"\($0.parameter.type) \($0.parameter.name)"
}

printer.print(
Expand All @@ -338,7 +338,7 @@ extension FFMSwift2JavaGenerator {
printer.indent()
var convertedArgs: [String] = []
for param in functionType.parameters {
let arg = param.conversion.render(&printer, param.javaParameters[0].name)
let arg = param.conversion.render(&printer, param.parameter.name)
convertedArgs.append(arg)
}

Expand Down Expand Up @@ -379,8 +379,7 @@ extension FFMSwift2JavaGenerator {
if !annotationsStr.isEmpty { annotationsStr += "\n" }

var paramDecls = translatedSignature.parameters
.flatMap(\.javaParameters)
.map { $0.renderParameter() }
.map { $0.parameter.renderParameter() }
if translatedSignature.requiresSwiftArena {
paramDecls.append("AllocatingSwiftArena swiftArena")
}
Expand Down Expand Up @@ -435,10 +434,8 @@ extension FFMSwift2JavaGenerator {
var downCallArguments: [String] = []

// Regular parameters.
for (i, parameter) in translatedSignature.parameters.enumerated() {
let original = decl.functionSignature.parameters[i]
let parameterName = original.parameterName ?? "_\(i)"
let lowered = parameter.conversion.render(&printer, parameterName)
for parameter in translatedSignature.parameters {
let lowered = parameter.conversion.render(&printer, parameter.parameter.name)
downCallArguments.append(lowered)
}

Expand Down
105 changes: 37 additions & 68 deletions Sources/JExtractSwiftLib/FFM/FFMSwift2JavaGenerator+JavaTranslation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,8 @@ extension FFMSwift2JavaGenerator {

/// Represent a Swift API parameter translated to Java.
struct TranslatedParameter {
/// Java parameter(s) mapped to the Swift parameter.
///
/// Array because one Swift parameter can be mapped to multiple parameters.
var javaParameters: [JavaParameter]
/// Java parameter mapped to the Swift parameter.
var parameter: JavaParameter
Copy link
Copy Markdown
Collaborator

@ktoso ktoso May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Yeah I think that's right, lowering would explode it into multiple if necessary


/// Describes how to convert the Java parameter to the lowered arguments for
/// the foreign function.
Expand Down Expand Up @@ -255,9 +253,7 @@ extension FFMSwift2JavaGenerator {
) throws -> TranslatedParameter {
if let cType = try? CType(cdeclType: type) {
return TranslatedParameter(
javaParameters: [
JavaParameter(name: parameterName, type: cType.javaType)
],
parameter: JavaParameter(name: parameterName, type: cType.javaType),
conversion: .placeholder
)
}
Expand All @@ -268,9 +264,7 @@ extension FFMSwift2JavaGenerator {
switch knownType {
case .unsafeRawBufferPointer, .unsafeMutableRawBufferPointer:
return TranslatedParameter(
javaParameters: [
JavaParameter(name: parameterName, type: .javaForeignMemorySegment)
],
parameter: JavaParameter(name: parameterName, type: .javaForeignMemorySegment),
conversion: .method(
.explodedName(component: "pointer"),
methodName: "reinterpret",
Expand Down Expand Up @@ -373,13 +367,11 @@ extension FFMSwift2JavaGenerator {
overflowCheck = .none
}
return TranslatedParameter(
javaParameters: [
JavaParameter(
name: parameterName,
type: javaType,
annotations: parameterAnnotations
)
],
parameter: JavaParameter(
name: parameterName,
type: javaType,
annotations: parameterAnnotations
),
conversion: .placeholder,
needs32BitIntOverflowCheck: overflowCheck
)
Expand All @@ -389,13 +381,11 @@ extension FFMSwift2JavaGenerator {
case .metatype:
// Metatype are expressed as 'org.swift.swiftkit.SwiftAnyType'
return TranslatedParameter(
javaParameters: [
JavaParameter(
name: parameterName,
type: JavaType.class(package: "org.swift.swiftkit.ffm", name: "SwiftAnyType"),
annotations: parameterAnnotations
)
],
parameter: JavaParameter(
name: parameterName,
type: JavaType.class(package: "org.swift.swiftkit.ffm", name: "SwiftAnyType"),
annotations: parameterAnnotations
),
conversion: .swiftValueSelfSegment(.placeholder)
)

Expand All @@ -415,9 +405,7 @@ extension FFMSwift2JavaGenerator {

case .unsafeRawBufferPointer, .unsafeMutableRawBufferPointer:
return TranslatedParameter(
javaParameters: [
JavaParameter(name: parameterName, type: .javaForeignMemorySegment)
],
parameter: JavaParameter(name: parameterName, type: .javaForeignMemorySegment),
conversion: .commaSeparated([
.placeholder,
.method(.placeholder, methodName: "byteSize", arguments: [], withArena: false),
Expand All @@ -437,20 +425,16 @@ extension FFMSwift2JavaGenerator {

case .string:
return TranslatedParameter(
javaParameters: [
JavaParameter(
name: parameterName,
type: .javaLangString
)
],
parameter: JavaParameter(
name: parameterName,
type: .javaLangString
),
conversion: .call(.placeholder, function: "SwiftStrings.toCString", withArena: true)
)

case .array(let element) where element == knownTypes.uint8:
return TranslatedParameter(
javaParameters: [
JavaParameter(name: parameterName, type: .array(.byte), annotations: parameterAnnotations)
],
parameter: JavaParameter(name: parameterName, type: .array(.byte), annotations: parameterAnnotations),
conversion:
.commaSeparated([
.call(
Expand Down Expand Up @@ -481,24 +465,20 @@ extension FFMSwift2JavaGenerator {
}

return TranslatedParameter(
javaParameters: [
JavaParameter(
name: parameterName,
type: try translate(swiftType: swiftType)
)
],
parameter: JavaParameter(
name: parameterName,
type: try translate(swiftType: swiftType)
),
conversion: .swiftValueSelfSegment(.placeholder)
)

case .tuple([]):
return TranslatedParameter(
javaParameters: [
JavaParameter(
name: parameterName,
type: .void,
annotations: parameterAnnotations
)
],
parameter: JavaParameter(
name: parameterName,
type: .void,
annotations: parameterAnnotations
),
conversion: .placeholder
)

Expand All @@ -514,12 +494,10 @@ extension FFMSwift2JavaGenerator {

case .function:
return TranslatedParameter(
javaParameters: [
JavaParameter(
name: parameterName,
type: JavaType.class(package: nil, name: "\(methodName).\(parameterName)")
)
],
parameter: JavaParameter(
name: parameterName,
type: JavaType.class(package: nil, name: "\(methodName).\(parameterName)")
),
conversion: .call(.placeholder, function: "\(methodName).$toUpcallStub", withArena: true)
)

Expand Down Expand Up @@ -578,22 +556,17 @@ extension FFMSwift2JavaGenerator {
genericParameters: genericParameters,
genericRequirements: genericRequirements
)
guard elementTranslated.javaParameters.count == 1 else {
throw JavaTranslationError.unhandledType(element.type)
}
let extraction = JavaConversionStep.replacingPlaceholder(
elementTranslated.conversion,
placeholder: "\(parameterName).$\(idx)"
)
elementConversions.append(extraction)
elementJavaTypes.append(elementTranslated.javaParameters[0].type.javaType)
elementJavaTypes.append(elementTranslated.parameter.type.javaType)
}

let javaType: JavaType = .tuple(elementTypes: elementJavaTypes)
return TranslatedParameter(
javaParameters: [
JavaParameter(name: parameterName, type: javaType)
],
parameter: JavaParameter(name: parameterName, type: javaType),
conversion: .commaSeparated(elementConversions)
)
}
Expand Down Expand Up @@ -624,9 +597,7 @@ extension FFMSwift2JavaGenerator {
default: throw JavaTranslationError.unhandledType(known: .optional(swiftType))
}
return TranslatedParameter(
javaParameters: [
JavaParameter(name: parameterName, type: JavaType(className: translatedClass))
],
parameter: JavaParameter(name: parameterName, type: JavaType(className: translatedClass)),
conversion: .call(.placeholder, function: "SwiftRuntime.\(lowerFunc)", withArena: true)
)
}
Expand All @@ -646,9 +617,7 @@ extension FFMSwift2JavaGenerator {

let translatedTy = try self.translate(swiftType: swiftType)
return TranslatedParameter(
javaParameters: [
JavaParameter(name: parameterName, type: JavaType(className: "Optional<\(translatedTy.description)>"))
],
parameter: JavaParameter(name: parameterName, type: .optional(translatedTy)),
conversion: .call(.placeholder, function: "SwiftRuntime.toOptionalSegmentInstance", withArena: false)
)
case .existential, .opaque, .genericParameter:
Expand Down
2 changes: 1 addition & 1 deletion Tests/JExtractSwiftTests/DataImportTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ final class DataImportTests {
* public func receiveDataProtocol<T: DataProtocol>(dat: some DataProtocol, dat2: T?)
* }
*/
public static void receiveDataProtocol(Data dat, Optional<Data> dat2) {
public static void receiveDataProtocol(Data dat, java.util.Optional<Data> dat2) {
Copy link
Copy Markdown
Collaborator

@ktoso ktoso May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice side effect, FQN are better

swiftjava_SwiftModule_receiveDataProtocol_dat_dat2.call(dat.$memorySegment(), SwiftRuntime.toOptionalSegmentInstance(dat2));
}
""",
Expand Down
2 changes: 1 addition & 1 deletion Tests/JExtractSwiftTests/OptionalImportTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ final class OptionalImportTests {
* public func receiveOptionalDataProto(_ arg: (some DataProtocol)?)
* }
*/
public static void receiveOptionalDataProto(Optional<Data> arg) {
public static void receiveOptionalDataProto(java.util.Optional<Data> arg) {
swiftjava_SwiftModule_receiveOptionalDataProto__.call(SwiftRuntime.toOptionalSegmentInstance(arg));
}
""",
Expand Down
Loading