Skip to content

Improve compatibility with Embedded Swift #58

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.

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
Apr 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion Sources/WebIDLToSwift/IDLBuilder.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import WebIDL

enum IDLBuilder {
static let basicDependencies = ["ECMAScript", "JavaScriptKit", "JavaScriptEventLoop"]
static let optionalDependencies = ["JavaScriptEventLoop"]

static let preamble = """
// This file was auto-generated by WebIDLToSwift. DO NOT EDIT!
Expand Down Expand Up @@ -42,7 +43,11 @@ enum IDLBuilder {
dependencies.append("JavaScriptBigIntSupport")
}

let formedPreamble = preamble + dependencies.map { "import \($0)" }.joined(separator: "\n")
let formedPreamble = preamble + (optionalDependencies.map { """
#if canImport\($0)
import \($0)
#endif
""" } + dependencies.map { "import \($0)" }).joined(separator: "\n")

try (formedPreamble + "\n\n" + content).write(toFile: path, atomically: true, encoding: .utf8)
}
Expand All @@ -54,6 +59,7 @@ enum IDLBuilder {
var contents: [SwiftSource] = []

var state = ScopedState.root(
dictionaries: merged.dictionaries,
interfaces: merged.interfaces,
ignored: [
// variadic callbacks are unsupported
Expand Down
6 changes: 6 additions & 0 deletions Sources/WebIDLToSwift/MergeDeclarations.swift
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ enum DeclarationMerger {

private static func enhanceMembers(_ members: [IDLNode]) -> [IDLNode] {
members.flatMap { member -> [IDLNode] in
if let named = member as? IDLNamed, named.name.contains("-") {
return []
}

if let operation = member as? IDLOperation,
case .generic("Promise", _) = operation.idlType?.value
{
Expand Down Expand Up @@ -223,6 +227,7 @@ enum DeclarationMerger {
+ [Typedefs(typedefs: allTypes)]
+ allNodes(ofType: IDLEnum.self)
+ allNodes(ofType: IDLCallbackInterface.self),
dictionaries: mergedDictionaries,
interfaces: mergedInterfaces,
types: mergedTypes
// unions: unions
Expand All @@ -231,6 +236,7 @@ enum DeclarationMerger {

struct MergeResult {
let declarations: [DeclarationFile]
let dictionaries: [String: MergedDictionary]
let interfaces: [String: MergedInterface]
let types: [String: IDLTypealias]
// let unions: Set<UnionType>
Expand Down
3 changes: 3 additions & 0 deletions Sources/WebIDLToSwift/ModuleState.swift
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ struct ScopedState {
private(set) var this: SwiftSource!
private(set) var className: SwiftSource!
private(set) var interfaces: [String: MergedInterface]!
private(set) var dictionaries: [String: MergedDictionary]!
private(set) var ignored: [String: Set<String>]!
private(set) var types: [String: IDLTypealias]!
private(set) var override = false
Expand Down Expand Up @@ -106,12 +107,14 @@ struct ScopedState {
}

static func root(
dictionaries: [String: MergedDictionary],
interfaces: [String: MergedInterface],
ignored: [String: Set<String>],
types: [String: IDLTypealias]
) -> Self {
var newState = ModuleState.current
newState.interfaces = interfaces
newState.dictionaries = dictionaries
newState.ignored = ignored
newState.types = types
return newState
Expand Down
10 changes: 4 additions & 6 deletions Sources/WebIDLToSwift/UnionType+SwiftRepresentable.swift
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ extension UnionType: SwiftRepresentable {
var initializers: [SwiftSource] {
zip(sortedTypes, sortedNames).flatMap { (type, name) -> [SwiftSource] in
let basicInitializer: [SwiftSource] = ["""
init(_ \(name): \(type)) {
public init(_ \(name): \(type)) {
let val: \(self.name) = .\(name)(\(name))
self = val
}
Expand Down Expand Up @@ -162,10 +162,8 @@ extension SlimIDLType: SwiftRepresentable {
case "FrozenArray", "ObservableArray":
// ???
return ["Element == \(args[0])"]
case "Promise":
case "Promise", "record":
return []
case "record":
return ["Key == \(args[0])", "Value == \(args[1])"]
default:
fatalError("Unsupported generic type: \(name)")
}
Expand All @@ -190,7 +188,7 @@ extension SlimIDLType.TypeValue: SwiftRepresentable {
case "Promise":
return "JSPromise"
case "record":
return "Dictionary"
return "JSObject"
default:
fatalError("Unsupported generic type: \(name)")
}
Expand Down Expand Up @@ -220,7 +218,7 @@ extension SlimIDLType.TypeValue: SwiftRepresentable {
case "Promise":
return "JSPromise"
case "record":
return "[\(args[0]): \(args[1])]"
return "JSObject"
default:
fatalError("Unsupported generic type: \(name)")
}
Expand Down
20 changes: 15 additions & 5 deletions Sources/WebIDLToSwift/WebIDL+SwiftRepresentation.swift
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,16 @@ extension IDLAttribute: SwiftRepresentable, Initializable {
}
}

extension IDLDictionary.Member {
var isOptional: Bool {
!required && !idlType.nullable && !idlType.isFunction
}

var optionalSuffix: String {
isOptional ? "?" : ""
}
}

extension MergedDictionary: SwiftRepresentable {
var swiftRepresentation: SwiftSource {
"""
Expand All @@ -98,7 +108,7 @@ extension MergedDictionary: SwiftRepresentable {
"""
}

private var membersWithPropertyWrapper: [(IDLDictionary.Member, SwiftSource)] {
private func membersWithPropertyWrapper(_ members: [IDLDictionary.Member]) -> [(IDLDictionary.Member, SwiftSource)] {
members.map {
($0, $0.idlType.propertyWrapper(readonly: false))
}
Expand All @@ -111,7 +121,7 @@ extension MergedDictionary: SwiftRepresentable {
return """
public convenience init(\(sequence: params)) {
let object = JSObject.global[\(ModuleState.source(for: "Object"))].function!.new()
\(lines: membersWithPropertyWrapper.map { member, wrapper in
\(lines: membersWithPropertyWrapper(members).map { member, wrapper in
if member.idlType.isFunction {
return """
\(wrapper)[\(ModuleState.source(for: member.name)), in: object] = \(member.name)
Expand All @@ -126,7 +136,7 @@ extension MergedDictionary: SwiftRepresentable {
}

public required init(unsafelyWrapping object: JSObject) {
\(lines: membersWithPropertyWrapper.map { member, wrapper in
\(lines: membersWithPropertyWrapper(members).map { member, wrapper in
"_\(raw: member.name) = \(wrapper)(jsObject: object, name: \(ModuleState.source(for: member.name)))"
})
super.init(unsafelyWrapping: object)
Expand All @@ -135,10 +145,10 @@ extension MergedDictionary: SwiftRepresentable {
}

private var swiftMembers: [SwiftSource] {
membersWithPropertyWrapper.map { member, wrapper in
self.membersWithPropertyWrapper(members).map { member, wrapper in
"""
@\(wrapper)
public var \(member.name): \(member.idlType)
public var \(member.name): \(member.idlType)\(member.optionalSuffix)
"""
}
}
Expand Down
Loading