Skip to content

Ensure that bool as a struct field is correctly handled #353

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
tannergooding merged 2 commits into from
Jun 17, 2022
Merged

Ensure that bool as a struct field is correctly handled #353

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
b6139e2
Adding tests covering bool as a struct/union field
tannergooding Jun 17, 2022
3a153d0
Ensure that bool as a struct field is correctly handled
tannergooding Jun 17, 2022
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
32 changes: 28 additions & 4 deletions sources/ClangSharp.PInvokeGenerator/PInvokeGenerator.VisitDecl.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,20 @@ private void VisitFieldDecl(FieldDecl fieldDecl)
var type = fieldDecl.Type;
var typeName = GetRemappedTypeName(fieldDecl, context: null, type, out var nativeTypeName);

if (typeName == "bool")
{
// bool is not blittable, so we shouldn't use it for structs that may be in P/Invoke signatures
typeName = "byte";
nativeTypeName = string.IsNullOrWhiteSpace(nativeTypeName) ? "bool" : nativeTypeName;
}

if (_config.GenerateCompatibleCode && typeName.StartsWith("bool*"))
{
// bool* is not blittable in compat mode, so we shouldn't use it for structs that may be in P/Invoke signatures
typeName = typeName.Replace("bool*", "byte*");
nativeTypeName = string.IsNullOrWhiteSpace(nativeTypeName) ? typeName.Replace("byte*", "bool *") : nativeTypeName;
}

int? offset = null;
if (fieldDecl.Parent.IsUnion)
{
Expand Down Expand Up @@ -509,11 +523,21 @@ private void VisitFunctionDecl(FunctionDecl functionDecl)
AddDiagnostic(DiagnosticLevel.Warning, $"Found manual import for {name} with no class remapping. First Parameter Type: {firstParameterTypeName}; Return Type: {returnTypeName}", functionDecl);
}

if ((isVirtual || !hasBody) && (returnTypeName == "bool"))
if (isVirtual || !hasBody)
{
// bool is not blittable, so we shouldn't use it for P/Invoke signatures
returnTypeName = "byte";
nativeTypeName = string.IsNullOrWhiteSpace(nativeTypeName) ? "bool" : nativeTypeName;
if (returnTypeName == "bool")
{
// bool is not blittable, so we shouldn't use it for P/Invoke signatures
returnTypeName = "byte";
nativeTypeName = string.IsNullOrWhiteSpace(nativeTypeName) ? "bool" : nativeTypeName;
}

if (_config.GenerateCompatibleCode && returnTypeName.StartsWith("bool*"))
{
// bool* is not blittable in compat mode, so we shouldn't use it for P/Invoke signatures
returnTypeName = returnTypeName.Replace("bool*", "byte*");
nativeTypeName = string.IsNullOrWhiteSpace(nativeTypeName) ? returnTypeName.Replace("byte*", "bool *") : nativeTypeName;
}
}

var type = functionDecl.Type;
Expand Down
8 changes: 8 additions & 0 deletions tests/ClangSharp.PInvokeGenerator.UnitTests/Base/StructDeclarationTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ public abstract class StructDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task BasicWithNativeTypeNameTest(string nativeType, string expectedManagedType) => BasicWithNativeTypeNameTestImpl(nativeType, expectedManagedType);

[Test]
Expand Down Expand Up @@ -57,6 +58,7 @@ public abstract class StructDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task FixedSizedBufferNonPrimitiveWithNativeTypeNameTest(string nativeType, string expectedManagedType) => FixedSizedBufferNonPrimitiveWithNativeTypeNameTestImpl(nativeType, expectedManagedType);

[TestCase("double *", "double*")]
Expand All @@ -75,6 +77,7 @@ public abstract class StructDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task FixedSizedBufferPrimitiveTest(string nativeType, string expectedManagedType) => FixedSizedBufferPrimitiveTestImpl(nativeType, expectedManagedType);

[TestCase("unsigned char", "byte")]
Expand All @@ -87,6 +90,7 @@ public abstract class StructDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task FixedSizedBufferPrimitiveMultidimensionalTest(string nativeType, string expectedManagedType) => FixedSizedBufferPrimitiveMultidimensionalTestImpl(nativeType, expectedManagedType);

[TestCase("unsigned char", "byte")]
Expand All @@ -99,6 +103,7 @@ public abstract class StructDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task FixedSizedBufferPrimitiveTypedefTest(string nativeType, string expectedManagedType) => FixedSizedBufferPrimitiveTypedefTestImpl(nativeType, expectedManagedType);

[Test]
Expand Down Expand Up @@ -131,6 +136,7 @@ public abstract class StructDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task NestedWithNativeTypeNameTest(string nativeType, string expectedManagedType) => NestedWithNativeTypeNameTestImpl(nativeType, expectedManagedType);

[Test]
Expand Down Expand Up @@ -169,6 +175,7 @@ public abstract class StructDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task SkipNonDefinitionWithNativeTypeNameTest(string nativeType, string expectedManagedType) => SkipNonDefinitionWithNativeTypeNameTestImpl(nativeType, expectedManagedType);

[TestCase("unsigned char", "byte")]
Expand All @@ -181,6 +188,7 @@ public abstract class StructDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task TypedefTest(string nativeType, string expectedManagedType) => TypedefTestImpl(nativeType, expectedManagedType);

[Test]
Expand Down
8 changes: 8 additions & 0 deletions tests/ClangSharp.PInvokeGenerator.UnitTests/Base/UnionDeclarationTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ public abstract class UnionDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task BasicWithNativeTypeNameTest(string nativeType, string expectedManagedType) => BasicWithNativeTypeNameTestImpl(nativeType, expectedManagedType);

[Test]
Expand Down Expand Up @@ -57,6 +58,7 @@ public abstract class UnionDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task FixedSizedBufferNonPrimitiveWithNativeTypeNameTest(string nativeType, string expectedManagedType) => FixedSizedBufferNonPrimitiveWithNativeTypeNameTestImpl(nativeType, expectedManagedType);

[TestCase("double *", "double*")]
Expand All @@ -75,6 +77,7 @@ public abstract class UnionDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task FixedSizedBufferPrimitiveTest(string nativeType, string expectedManagedType) => FixedSizedBufferPrimitiveTestImpl(nativeType, expectedManagedType);

[TestCase("unsigned char", "byte")]
Expand All @@ -87,6 +90,7 @@ public abstract class UnionDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task FixedSizedBufferPrimitiveMultidimensionalTest(string nativeType, string expectedManagedType) => FixedSizedBufferPrimitiveMultidimensionalTestImpl(nativeType, expectedManagedType);

[TestCase("unsigned char", "byte")]
Expand All @@ -99,6 +103,7 @@ public abstract class UnionDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task FixedSizedBufferPrimitiveTypedefTest(string nativeType, string expectedManagedType) => FixedSizedBufferPrimitiveTypedefTestImpl(nativeType, expectedManagedType);

[Test]
Expand All @@ -125,6 +130,7 @@ public abstract class UnionDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task NestedWithNativeTypeNameTest(string nativeType, string expectedManagedType) => NestedWithNativeTypeNameTestImpl(nativeType, expectedManagedType);

[Test]
Expand Down Expand Up @@ -160,6 +166,7 @@ public abstract class UnionDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task SkipNonDefinitionWithNativeTypeNameTest(string nativeType, string expectedManagedType) => SkipNonDefinitionWithNativeTypeNameTestImpl(nativeType, expectedManagedType);

[TestCase("unsigned char", "byte")]
Expand All @@ -172,6 +179,7 @@ public abstract class UnionDeclarationTest : PInvokeGeneratorTest
[TestCase("unsigned short", "ushort")]
[TestCase("unsigned int", "uint")]
[TestCase("unsigned long long", "ulong")]
[TestCase("bool", "byte")]
public Task TypedefTest(string nativeType, string expectedManagedType) => TypedefTestImpl(nativeType, expectedManagedType);

protected abstract Task BasicTestImpl(string nativeType, string expectedManagedType);
Expand Down