GoaLitiuM/FlaxEngine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor struct custom marshalling generation

Browse Source
This commit is contained in:
Ari Vuollet
2024-04-01 16:01:57 +03:00
parent c8e893d2ec
commit a49b398c7f
1 changed files with 92 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
Source/Tools/Flax.Build/Bindings/BindingsGenerator.CSharp.cs
View File

@@ -1459,51 +1459,35 @@ namespace Flax.Build.Bindings
string structNativeMarshaling = ""; string structNativeMarshaling = "";
if (UseCustomMarshalling(buildData, structureInfo, structureInfo)) if (UseCustomMarshalling(buildData, structureInfo, structureInfo))
{ {
// NOTE: Permanent FlaxEngine.Object GCHandles must not be released when marshalling from native to managed.
string marshallerName = structureInfo.Name + "Marshaller"; string marshallerName = structureInfo.Name + "Marshaller";
structNativeMarshaling = $"[NativeMarshalling(typeof({marshallerName}))]"; structNativeMarshaling = $"[NativeMarshalling(typeof({marshallerName}))]";
contents.Append(indent).AppendLine($"/// <summary>");
contents.Append(indent).AppendLine($"/// Marshaller for type <see cref=\"{structureInfo.Name}\"/>.");
contents.Append(indent).AppendLine($"/// </summary>");
if (buildData.Target != null & buildData.Target.IsEditor)
contents.Append(indent).AppendLine("[HideInEditor]");
contents.Append(indent).AppendLine($"[CustomMarshaller(typeof({structureInfo.Name}), MarshalMode.ManagedToUnmanagedIn, typeof({marshallerName}.ManagedToNative))]");
contents.Append(indent).AppendLine($"[CustomMarshaller(typeof({structureInfo.Name}), MarshalMode.UnmanagedToManagedOut, typeof({marshallerName}.ManagedToNative))]");
contents.Append(indent).AppendLine($"[CustomMarshaller(typeof({structureInfo.Name}), MarshalMode.ElementIn, typeof({marshallerName}.ManagedToNative))]");
contents.Append(indent).AppendLine($"[CustomMarshaller(typeof({structureInfo.Name}), MarshalMode.ManagedToUnmanagedOut, typeof({marshallerName}.NativeToManaged))]");
contents.Append(indent).AppendLine($"[CustomMarshaller(typeof({structureInfo.Name}), MarshalMode.UnmanagedToManagedIn, typeof({marshallerName}.NativeToManaged))]");
contents.Append(indent).AppendLine($"[CustomMarshaller(typeof({structureInfo.Name}), MarshalMode.ElementOut, typeof({marshallerName}.NativeToManaged))]");
contents.Append(indent).AppendLine($"[CustomMarshaller(typeof({structureInfo.Name}), MarshalMode.ManagedToUnmanagedRef, typeof({marshallerName}.Bidirectional))]");
contents.Append(indent).AppendLine($"[CustomMarshaller(typeof({structureInfo.Name}), MarshalMode.UnmanagedToManagedRef, typeof({marshallerName}.Bidirectional))]");
contents.Append(indent).AppendLine($"[CustomMarshaller(typeof({structureInfo.Name}), MarshalMode.ElementRef, typeof({marshallerName}))]");
contents.Append(indent).AppendLine($"{GenerateCSharpAccessLevel(structureInfo.Access)}static unsafe class {marshallerName}");
contents.Append(indent).AppendLine("{");
contents.AppendLine("#pragma warning disable 1591");
indent += " ";
var toManagedContent = GetStringBuilder(); var toManagedContent = GetStringBuilder();
var toNativeContent = GetStringBuilder(); var toNativeContent = GetStringBuilder();
var freeContents = GetStringBuilder(); var freeContents = GetStringBuilder();
var freeContents2 = GetStringBuilder(); var freeContents2 = GetStringBuilder();
var structContents = GetStringBuilder();
{ {
// Native struct begin // Native struct begin
// TODO: skip using this utility structure if the auto-generated C# struct is already the same as XXXInternal here below // TODO: skip using this utility structure if the auto-generated C# struct is already the same as XXXInternal here below
var structIndent = "";
if (buildData.Target != null & buildData.Target.IsEditor) if (buildData.Target != null & buildData.Target.IsEditor)
contents.Append(indent).AppendLine("[HideInEditor]"); structContents.Append(structIndent).AppendLine("[HideInEditor]");
contents.Append(indent).AppendLine("[StructLayout(LayoutKind.Sequential)]"); structContents.Append(structIndent).AppendLine("[StructLayout(LayoutKind.Sequential)]");
contents.Append(indent).Append("public struct ").Append(structureInfo.Name).Append("Internal"); structContents.Append(structIndent).Append("public struct ").Append(structureInfo.Name).Append("Internal");
if (structureInfo.BaseType != null && structureInfo.IsPod) if (structureInfo.BaseType != null && structureInfo.IsPod)
contents.Append(" : ").Append(GenerateCSharpNativeToManaged(buildData, new TypeInfo { Type = structureInfo.BaseType.Name }, structureInfo)); structContents.Append(" : ").Append(GenerateCSharpNativeToManaged(buildData, new TypeInfo { Type = structureInfo.BaseType.Name }, structureInfo));
contents.AppendLine(); structContents.AppendLine();
contents.Append(indent + "{"); structContents.Append(structIndent + "{");
indent += " "; structIndent += " ";
toNativeContent.Append($"var unmanaged = new {structureInfo.Name}Internal();").AppendLine(); toNativeContent.Append($"var unmanaged = new {structureInfo.Name}Internal();").AppendLine();
toManagedContent.Append($"var managed = new {structureInfo.Name}();").AppendLine(); toManagedContent.Append($"var managed = new {structureInfo.Name}();").AppendLine();
contents.AppendLine(); structContents.AppendLine();
foreach (var fieldInfo in structureInfo.Fields) foreach (var fieldInfo in structureInfo.Fields)
{ {
if (fieldInfo.IsStatic || fieldInfo.IsConstexpr) if (fieldInfo.IsStatic || fieldInfo.IsConstexpr)
@@ -1520,7 +1504,7 @@ namespace Flax.Build.Bindings
else else
originalType = type = GenerateCSharpNativeToManaged(buildData, fieldInfo.Type, structureInfo); originalType = type = GenerateCSharpNativeToManaged(buildData, fieldInfo.Type, structureInfo);
contents.Append(indent).Append("public "); structContents.Append(structIndent).Append("public ");
var apiType = FindApiTypeInfo(buildData, fieldInfo.Type, structureInfo); var apiType = FindApiTypeInfo(buildData, fieldInfo.Type, structureInfo);
bool internalType = apiType is StructureInfo fieldStructureInfo && UseCustomMarshalling(buildData, fieldStructureInfo, structureInfo); bool internalType = apiType is StructureInfo fieldStructureInfo && UseCustomMarshalling(buildData, fieldStructureInfo, structureInfo);
@@ -1532,7 +1516,7 @@ namespace Flax.Build.Bindings
if (GenerateCSharpUseFixedBuffer(originalType)) if (GenerateCSharpUseFixedBuffer(originalType))
{ {
// Use fixed statement with primitive types of buffers // Use fixed statement with primitive types of buffers
contents.Append($"fixed {originalType} {fieldInfo.Name}0[{fieldInfo.Type.ArraySize}];").AppendLine(); structContents.Append($"fixed {originalType} {fieldInfo.Name}0[{fieldInfo.Type.ArraySize}];").AppendLine();
// Copy fixed-size array // Copy fixed-size array
toManagedContent.AppendLine($"FlaxEngine.Utils.MemoryCopy(new IntPtr(managed.{fieldInfo.Name}0), new IntPtr(unmanaged.{fieldInfo.Name}0), sizeof({originalType}) * {fieldInfo.Type.ArraySize}ul);"); toManagedContent.AppendLine($"FlaxEngine.Utils.MemoryCopy(new IntPtr(managed.{fieldInfo.Name}0), new IntPtr(unmanaged.{fieldInfo.Name}0), sizeof({originalType}) * {fieldInfo.Type.ArraySize}ul);");
@@ -1542,12 +1526,12 @@ namespace Flax.Build.Bindings
#endif #endif
{ {
// Padding in structs for fixed-size array // Padding in structs for fixed-size array
contents.Append(type).Append(' ').Append(fieldInfo.Name).Append("0;").AppendLine(); structContents.Append(type).Append(' ').Append(fieldInfo.Name).Append("0;").AppendLine();
for (int i = 1; i < fieldInfo.Type.ArraySize; i++) for (int i = 1; i < fieldInfo.Type.ArraySize; i++)
{ {
GenerateCSharpAttributes(buildData, contents, indent, structureInfo, fieldInfo, fieldInfo.IsStatic); GenerateCSharpAttributes(buildData, structContents, structIndent, structureInfo, fieldInfo, fieldInfo.IsStatic);
contents.Append(indent).Append("public "); structContents.Append(structIndent).Append("public ");
contents.Append(type).Append(' ').Append(fieldInfo.Name + i).Append(';').AppendLine(); structContents.Append(type).Append(' ').Append(fieldInfo.Name + i).Append(';').AppendLine();
} }
// Copy fixed-size array item one-by-one // Copy fixed-size array item one-by-one
@@ -1593,8 +1577,7 @@ namespace Flax.Build.Bindings
} }
//else if (type == "Guid") //else if (type == "Guid")
// type = "GuidNative"; // type = "GuidNative";
structContents.Append(type).Append(' ').Append(fieldInfo.Name).Append(';').AppendLine();
contents.Append(type).Append(' ').Append(fieldInfo.Name).Append(';').AppendLine();
} }
// Generate struct constructor/getter and deconstructor/setter function // Generate struct constructor/getter and deconstructor/setter function
@@ -1712,71 +1695,92 @@ namespace Flax.Build.Bindings
} }
// Native struct end // Native struct end
indent = indent.Substring(0, indent.Length - 4); structIndent = structIndent.Substring(0, structIndent.Length - 4);
contents.AppendLine(indent + "}").AppendLine(); structContents.AppendLine(structIndent + "}").AppendLine();
toNativeContent.Append("return unmanaged;"); toNativeContent.Append("return unmanaged;");
toManagedContent.Append("return managed;"); toManagedContent.Append("return managed;");
} }
var indent2 = indent + " "; contents.AppendLine(string.Join("\n" + indent, (indent + $$"""
var indent3 = indent2 + " "; /// <summary>
/// Marshaller for type <see cref="{{structureInfo.Name}}"/>.
/// </summary>
{{InsertHideInEditorSection()}}
[CustomMarshaller(typeof({{structureInfo.Name}}), MarshalMode.ManagedToUnmanagedIn, typeof({{marshallerName}}.ManagedToNative))]
[CustomMarshaller(typeof({{structureInfo.Name}}), MarshalMode.UnmanagedToManagedOut, typeof({{marshallerName}}.ManagedToNative))]
[CustomMarshaller(typeof({{structureInfo.Name}}), MarshalMode.ElementIn, typeof({{marshallerName}}.ManagedToNative))]
[CustomMarshaller(typeof({{structureInfo.Name}}), MarshalMode.ManagedToUnmanagedOut, typeof({{marshallerName}}.NativeToManaged))]
[CustomMarshaller(typeof({{structureInfo.Name}}), MarshalMode.UnmanagedToManagedIn, typeof({{marshallerName}}.NativeToManaged))]
[CustomMarshaller(typeof({{structureInfo.Name}}), MarshalMode.ElementOut, typeof({{marshallerName}}.NativeToManaged))]
[CustomMarshaller(typeof({{structureInfo.Name}}), MarshalMode.ManagedToUnmanagedRef, typeof({{marshallerName}}.Bidirectional))]
[CustomMarshaller(typeof({{structureInfo.Name}}), MarshalMode.UnmanagedToManagedRef, typeof({{marshallerName}}.Bidirectional))]
[CustomMarshaller(typeof({{structureInfo.Name}}), MarshalMode.ElementRef, typeof({{marshallerName}}))]
{{GenerateCSharpAccessLevel(structureInfo.Access)}}static unsafe class {{marshallerName}}
{
#pragma warning disable 1591
{{structContents.Replace("\n", "\n" + " ").ToString().TrimEnd()}}
// NativeToManaged stateless shape {{InsertHideInEditorSection()}}
// NOTE: GCHandles of FlaxEngine.Object must not be released in this case public static class NativeToManaged
if (buildData.Target != null && buildData.Target.IsEditor) {
contents.Append(indent).AppendLine("[HideInEditor]"); public static {{structureInfo.Name}} ConvertToManaged({{structureInfo.Name}}Internal unmanaged) => {{marshallerName}}.ToManaged(unmanaged);
contents.Append(indent).AppendLine("public static class NativeToManaged").Append(indent).AppendLine("{"); public static {{structureInfo.Name}}Internal ConvertToUnmanaged({{structureInfo.Name}} managed) => {{marshallerName}}.ToNative(managed);
contents.Append(indent2).AppendLine($"public static {structureInfo.Name} ConvertToManaged({structureInfo.Name}Internal unmanaged) => {marshallerName}.ToManaged(unmanaged);"); public static void Free({{structureInfo.Name}}Internal unmanaged)
contents.Append(indent2).AppendLine($"public static {structureInfo.Name}Internal ConvertToUnmanaged({structureInfo.Name} managed) => {marshallerName}.ToNative(managed);"); {
contents.Append(indent2).AppendLine($"public static void Free({structureInfo.Name}Internal unmanaged)"); {{freeContents2.Replace("\n", "\n" + " ").ToString().TrimEnd()}}
contents.Append(indent2).AppendLine("{").Append(indent3).AppendLine(freeContents2.Replace("\n", "\n" + indent3).ToString().TrimEnd()).Append(indent2).AppendLine("}"); }
contents.Append(indent).AppendLine("}"); }
{{InsertHideInEditorSection()}}
public static class ManagedToNative
{
public static {{structureInfo.Name}} ConvertToManaged({{structureInfo.Name}}Internal unmanaged) => {{marshallerName}}.ToManaged(unmanaged);
public static {{structureInfo.Name}}Internal ConvertToUnmanaged({{structureInfo.Name}} managed) => {{marshallerName}}.ToNative(managed);
public static void Free({{structureInfo.Name}}Internal unmanaged) => {{marshallerName}}.Free(unmanaged);
}
{{InsertHideInEditorSection()}}
public struct Bidirectional
{
{{structureInfo.Name}} managed;
{{structureInfo.Name}}Internal unmanaged;
public void FromManaged({{structureInfo.Name}} managed) => this.managed = managed;
public {{structureInfo.Name}}Internal ToUnmanaged() { unmanaged = {{marshallerName}}.ToNative(managed); return unmanaged; }
//public void FromUnmanaged({{structureInfo.Name}}Internal unmanaged) { {{marshallerName}}.Free(this.unmanaged.Value); this.unmanaged = unmanaged; }
public void FromUnmanaged({{structureInfo.Name}}Internal unmanaged) => this.unmanaged = unmanaged;
public {{structureInfo.Name}} ToManaged() { managed = {{marshallerName}}.ToManaged(unmanaged); return managed; }
public void Free() => NativeToManaged.Free(unmanaged);
}
internal static {{structureInfo.Name}} ConvertToManaged({{structureInfo.Name}}Internal unmanaged) => ToManaged(unmanaged);
internal static {{structureInfo.Name}}Internal ConvertToUnmanaged({{structureInfo.Name}} managed) => ToNative(managed);
internal static void Free({{structureInfo.Name}}Internal unmanaged)
{
{{freeContents.Replace("\n", "\n" + " ").ToString().TrimEnd()}}
}
// ManagedToNative stateless shape internal static {{structureInfo.Name}} ToManaged({{structureInfo.Name}}Internal unmanaged)
if (buildData.Target != null && buildData.Target.IsEditor) {
contents.Append(indent).AppendLine("[HideInEditor]"); {{toManagedContent.Replace("\n", "\n" + " ").ToString().TrimEnd()}}
contents.Append(indent).AppendLine($"public static class ManagedToNative").Append(indent).AppendLine("{"); }
contents.Append(indent2).AppendLine($"public static {structureInfo.Name} ConvertToManaged({structureInfo.Name}Internal unmanaged) => {marshallerName}.ToManaged(unmanaged);"); internal static {{structureInfo.Name}}Internal ToNative({{structureInfo.Name}} managed)
contents.Append(indent2).AppendLine($"public static {structureInfo.Name}Internal ConvertToUnmanaged({structureInfo.Name} managed) => {marshallerName}.ToNative(managed);"); {
contents.Append(indent2).AppendLine($"public static void Free({structureInfo.Name}Internal unmanaged) => {marshallerName}.Free(unmanaged);"); {{toNativeContent.Replace("\n", "\n" + " ").ToString().TrimEnd()}}
contents.Append(indent).AppendLine("}"); }
#pragma warning restore 1591
}
""").Split(new char[] { '\n' })));
// Bidirectional stateful shape string InsertHideInEditorSection()
// NOTE: GCHandles of FlaxEngine.Object must not be released unless they were allocated by this marshaller {
if (buildData.Target != null && buildData.Target.IsEditor) return (buildData.Target != null & buildData.Target.IsEditor) ? $$"""
contents.Append(indent).AppendLine("[HideInEditor]"); [HideInEditor]
contents.Append(indent).AppendLine($"public struct Bidirectional").Append(indent).AppendLine("{"); """ : "";
contents.Append(indent2).AppendLine($"{structureInfo.Name} managed;"); }
contents.Append(indent2).AppendLine($"{structureInfo.Name}Internal unmanaged;");
contents.Append(indent2).AppendLine($"public void FromManaged({structureInfo.Name} managed) => this.managed = managed;");
contents.Append(indent2).AppendLine($"public {structureInfo.Name}Internal ToUnmanaged() {{ unmanaged = {marshallerName}.ToNative(managed); return unmanaged; }}");
//contents.Append(indent2).AppendLine($"public void FromUnmanaged({structureInfo.Name}Internal unmanaged) {{ {marshallerName}.Free(this.unmanaged.Value); this.unmanaged = unmanaged; }}");
contents.Append(indent2).AppendLine($"public void FromUnmanaged({structureInfo.Name}Internal unmanaged) => this.unmanaged = unmanaged;");
contents.Append(indent2).AppendLine($"public {structureInfo.Name} ToManaged() {{ managed = {marshallerName}.ToManaged(unmanaged); return managed; }}");
contents.Append(indent2).AppendLine($"public void Free() => NativeToManaged.Free(unmanaged);");
contents.Append(indent).AppendLine("}");
// Bidirectional stateless shape
contents.Append(indent).AppendLine($"internal static {structureInfo.Name} ConvertToManaged({structureInfo.Name}Internal unmanaged) => ToManaged(unmanaged);");
contents.Append(indent).AppendLine($"internal static {structureInfo.Name}Internal ConvertToUnmanaged({structureInfo.Name} managed) => ToNative(managed);");
contents.Append(indent).AppendLine($"internal static void Free({structureInfo.Name}Internal unmanaged)");
contents.Append(indent).AppendLine("{").Append(indent2).AppendLine(freeContents.Replace("\n", "\n" + indent2).ToString().TrimEnd()).Append(indent).AppendLine("}");
// Managed/native converters
contents.Append(indent).AppendLine($"internal static {structureInfo.Name} ToManaged({structureInfo.Name}Internal unmanaged)");
contents.Append(indent).AppendLine("{").Append(indent2).AppendLine(toManagedContent.Replace("\n", "\n" + indent2).ToString().TrimEnd()).Append(indent).AppendLine("}");
contents.Append(indent).AppendLine($"internal static {structureInfo.Name}Internal ToNative({structureInfo.Name} managed)");
contents.Append(indent).AppendLine("{").Append(indent2).AppendLine(toNativeContent.Replace("\n", "\n" + indent2).ToString().TrimEnd()).Append(indent).AppendLine("}");
contents.AppendLine("#pragma warning restore 1591");
indent = indent.Substring(0, indent.Length - 4);
contents.Append(indent).AppendLine("}").AppendLine();
PutStringBuilder(toManagedContent); PutStringBuilder(toManagedContent);
PutStringBuilder(toNativeContent); PutStringBuilder(toNativeContent);
PutStringBuilder(freeContents); PutStringBuilder(freeContents);
PutStringBuilder(freeContents2); PutStringBuilder(freeContents2);
PutStringBuilder(structContents);
} }
#endif #endif
// Struct docs // Struct docs