Skip to content

Commit

Permalink
Even fancier marshaling (#553)
Browse files Browse the repository at this point in the history 
* Remove legacy implementation altogether

* Print side by side

* Snapshot

* Update UtilityGen.swift

* Snapshot

* Snapshot

* Update MethodGen.swift

* Snapshot

* Tests are green!

* Add some tests

* Update MarshalTests.swift

* Modify tests

* Remove some dead-code

* Revert "Remove some dead-code"

This reverts commit 2e9d4e3.

* Delete workspace.xml

* Update MethodGen.swift

* Refactor

* Add docs

* Green!

* Minor refactoring

* Extract logic too

* Update MethodGen.swift

* GC pass

* Another GC pass

* Another GC pass

* Update MethodGen.swift

* Update MethodGen.swift

* Update MethodGen.swift

* Fix possible exclusivity issues

* Fix minor logical error
  • Loading branch information
@elijah-semyonov
elijah-semyonov authored Oct 2, 2024
1 parent b77670e commit 59d1ff2
Show file tree
Hide file tree
Showing 10 changed files with 695 additions and 1,132 deletions.
6 changes: 3 additions & 3 deletions ...reddata/xcbaselines/SwiftGodotTests.xcbaseline/53914494-654F-4AE6-BFE1-6777D0E5FBA3.plist
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<key>com.apple.XCTPerformanceMetric_WallClockTime</key>
<dict>
<key>baselineAverage</key>
<real>0.223000</real>
<real>0.221789</real>
<key>baselineIntegrationDisplayName</key>
<string>Local Baseline</string>
</dict>
Expand All @@ -21,7 +21,7 @@
<key>com.apple.XCTPerformanceMetric_WallClockTime</key>
<dict>
<key>baselineAverage</key>
<real>0.446000</real>
<real>0.436672</real>
<key>baselineIntegrationDisplayName</key>
<string>Local Baseline</string>
</dict>
Expand All @@ -31,7 +31,7 @@
<key>com.apple.XCTPerformanceMetric_WallClockTime</key>
<dict>
<key>baselineAverage</key>
<real>0.332172</real>
<real>0.336487</real>
<key>baselineIntegrationDisplayName</key>
<string>Local Baseline</string>
</dict>
Expand Down
131 changes: 6 additions & 125 deletions Generator/Generator/Arguments.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ func godotArgumentToSwift (_ name: String) -> String {
return escapeSwift (snakeToCamel (name))
}

func isSmallInt (_ arg: JGodotArgument) -> Bool {
func isSmallInt(_ arg: JGodotArgument) -> Bool {
if arg.type != "int" {
return false
}
Expand All @@ -26,7 +26,7 @@ func isSmallInt (_ arg: JGodotArgument) -> Bool {
}
}

func getArgumentDeclaration (_ argument: JGodotArgument, eliminate: String, kind: ArgumentKind = .classes, isOptional: Bool) -> String {
func getArgumentDeclaration(_ argument: JGodotArgument, omitLabel: Bool, kind: ArgumentKind = .classes, isOptional: Bool) -> String {
//let optNeedInOut = isCoreType(name: argument.type) ? "inout " : ""
let optNeedInOut = ""

Expand Down Expand Up @@ -180,7 +180,10 @@ func getArgumentDeclaration (_ argument: JGodotArgument, eliminate: String, kind
}
}
}
return "\(eliminate)\(godotArgumentToSwift (argument.name)): \(optNeedInOut)\(getGodotType(argument, kind: kind))\(isOptional ? "?" : "")\(def)"

let prefix = omitLabel ? "_ " : ""

return "\(prefix)\(godotArgumentToSwift (argument.name)): \(optNeedInOut)\(getGodotType(argument, kind: kind))\(isOptional ? "?" : "")\(def)"
}

func getArgRef (arg: JGodotArgument) -> String {
Expand Down Expand Up @@ -212,125 +215,3 @@ func getArgRef (arg: JGodotArgument) -> String {
return "\(needAddress)\(escapeSwift(argref))\(optstorage)"
}
}

func generateCopies (_ args: [JGodotArgument]) -> String {
var body = ""

for arg in args {
//if !isCoreType (name: arg.type) {
var reference = godotArgumentToSwift (arg.name)

if isStructMap [arg.type] ?? false {
if arg.type == "float" {
reference = "Double (\(reference))"
}
body += "var copy_\(arg.name) = \(reference)\n"
} else if arg.type == "String" && mapStringToSwift {
body += "let gstr_\(arg.name) = GString (\(reference))\n"
}
}
return body
}

/// Wrap arguments before marshaling them to Godot
///
/// Returns a tuple of
/// - `body` - blob with arguments preparation
/// - `identation` - for caller to add missing braces
/// - `argsRef` - literal expression to be passed into GDExtensionInterface. Can be `nil` if method takes no args, `args` if arguments are wrapped into stack-resident struct, or `&args` if legacy approach is used and `[UnsafeRawPointer?]` is passed.
func generateArgPrepare(isVararg: Bool, _ args: [JGodotArgument], methodHasReturn: Bool) -> (body: String, indentation: Int, argsRef: String) {
// A runtime hook for opt-out from using new marshaling in case some specific method breaks
var useLegacyMarshalling = false

#if LEGACY_MARSHALING || !canImport(Darwin)
useLegacyMarshalling = true
#endif

if useLegacyMarshalling {
return generateArgPrepareLegacy(isVararg: isVararg, args, methodHasReturn: methodHasReturn)
} else {
return generateArgPrepareNew(isVararg: isVararg, args, methodHasReturn: methodHasReturn)
}
}

func generateArgPrepareLegacy(isVararg: Bool, _ args: [JGodotArgument], methodHasReturn: Bool) -> (body: String, indentation: Int, argsRef: String) {
var body = ""
var withUnsafeCallNestLevel = 0
let retFromWith = methodHasReturn ? "return " : ""

let argsRef: String

if isVararg || args.count > 0 {
body += generateCopies (args)
body += "var args: [UnsafeRawPointer?] = []\n"
if isVararg {
body += "let cptr = UnsafeMutableBufferPointer<Variant.ContentType>.allocate(capacity: arguments.count)\n"
body += "defer { cptr.deallocate () }\n\n"
}

for arg in args {
let prefix = String(repeating: " ", count: withUnsafeCallNestLevel * 4)
let ar = getArgRef(arg: arg)
body += "\(prefix)\(retFromWith)withUnsafePointer (to: \(ar)) { p\(withUnsafeCallNestLevel) in\n\(prefix) args.append (p\(withUnsafeCallNestLevel))\n"
withUnsafeCallNestLevel += 1
}
if isVararg {
body += "for idx in 0..<arguments.count {\n"
body += " cptr [idx] = arguments [idx].content\n"
body += " args.append (cptr.baseAddress! + idx)\n"
body += "}\n"
}

argsRef = "&args"
} else {
argsRef = "nil"
}

return (body, withUnsafeCallNestLevel, argsRef)
}

func generateArgPrepareNew(isVararg: Bool, _ args: [JGodotArgument], methodHasReturn: Bool) -> (body: String, indentation: Int, argsRef: String) {
var body = ""
var withUnsafeCallNestLevel = 0
let retFromWith = methodHasReturn ? "return " : ""

let argsRef: String

// TODO: this case should get the same treatment as a second branch.
if isVararg {
body += generateCopies(args)
body += "var args: [UnsafeRawPointer?] = []\n"
body += "let cptr = UnsafeMutableBufferPointer<Variant.ContentType>.allocate(capacity: arguments.count)\n"
body += "defer { cptr.deallocate () }\n\n"

for arg in args {
let prefix = String(repeating: " ", count: withUnsafeCallNestLevel * 4)
let ar = getArgRef(arg: arg)
body += "\(prefix)\(retFromWith)withUnsafePointer (to: \(ar)) { p\(withUnsafeCallNestLevel) in\n\(prefix) args.append (p\(withUnsafeCallNestLevel))\n"
withUnsafeCallNestLevel += 1
}
body += "for idx in 0..<arguments.count {\n".indented(by: withUnsafeCallNestLevel)
body += " cptr [idx] = arguments [idx].content\n".indented(by: withUnsafeCallNestLevel)
body += " args.append (cptr.baseAddress! + idx)\n".indented(by: withUnsafeCallNestLevel)
body += "}\n".indented(by: withUnsafeCallNestLevel)

argsRef = "&args"
} else if args.count > 0 {
body += generateCopies(args)

let prefix = String(repeating: " ", count: withUnsafeCallNestLevel * 4)

let argsString = args.map { arg in
getArgRef(arg: arg)
}.joined(separator: ", ")

body += "\(prefix)\(retFromWith)withUnsafeArgumentsPointer(\(argsString)) { args in"
withUnsafeCallNestLevel += 1

argsRef = "args"
} else {
argsRef = "nil"
}

return (body, withUnsafeCallNestLevel, argsRef)
}
Loading

0 comments on commit 59d1ff2

Please sign in to comment.