Skip to content

Constraints on parameter types allow ref struct #727

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

Open
wants to merge 13 commits into
base: develop
Choose a base branch
from
+31 −1
Open

Constraints on parameter types allow ref struct #727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1f344e6
update
v-fuquanli Apr 27, 2025
1bc01ee
add unit test
v-fuquanli Apr 27, 2025
73a7e46
update
v-fuquanli Apr 28, 2025
af027b8
update
v-fuquanli Apr 29, 2025
8ae4996
update
v-fuquanli Apr 30, 2025
4c0ef9d
update
v-fuquanli Apr 30, 2025
bd829ec
update
v-fuquanli May 6, 2025
8683a17
update
v-fuquanli May 6, 2025
7ed7657
update
v-fuquanli May 6, 2025
427f5de
update ut case
v-fuquanli May 7, 2025
fc115aa
update
v-fuquanli May 7, 2025
74f33a1
update
v-fuquanli May 7, 2025
7d91c75
update
v-fuquanli May 7, 2025
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
Binary file added external/Test/AllowsRefStructDemo.dll
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

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

@huangmin-ms @v-fuquanli Is it not required that the code used for the test cases be compiled as part of the project build? #712 and #713 are more or less hung up on assuming that's a requirement.

Binary file not shown.
3 changes: 3 additions & 0 deletions mdoc/Mono.Documentation/MDocUpdater.Member.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ internal static void MakeTypeParameterConstraints(XmlElement root, XmlElement e,
AppendElementText(ce, "ParameterAttribute", "NotNullableValueTypeConstraint");
if ((attrs & GenericParameterAttributes.ReferenceTypeConstraint) != 0)
AppendElementText(ce, "ParameterAttribute", "ReferenceTypeConstraint");
// Check for 'allows ref struct' constraint
if ((attrs & (GenericParameterAttributes)0x0020) != 0) // Assuming 0x0020 is the flag for 'allows ref struct'
AppendElementText(ce, "ParameterAttribute", "AllowByRefLike");

#if NEW_CECIL
foreach (GenericParameterConstraint c in constraints)
Expand Down
11 changes: 10 additions & 1 deletion mdoc/Mono.Documentation/Updater/Formatters/CSharpFullMemberFormatter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,9 +314,10 @@ private StringBuilder AppendConstraints (StringBuilder buf, IList<GenericParamet
bool isref = (attrs & GenericParameterAttributes.ReferenceTypeConstraint) != 0;
bool isvt = (attrs & GenericParameterAttributes.NotNullableValueTypeConstraint) != 0;
bool isnew = (attrs & GenericParameterAttributes.DefaultConstructorConstraint) != 0;
bool isAllowsRefStruct = (attrs & (GenericParameterAttributes)0x0020) != 0; // Assuming 0x0020 is the flag for 'allows ref struct'
bool comma = false;

if (!isref && !isvt && !isnew && constraints.Count == 0)
if (!isref && !isvt && !isAllowsRefStruct && !isnew && constraints.Count == 0)
continue;
buf.Append (" where ").Append (genArg.Name).Append (" : ");
if (isref)
Expand Down Expand Up @@ -350,6 +351,14 @@ private StringBuilder AppendConstraints (StringBuilder buf, IList<GenericParamet
buf.Append (", ");
buf.Append ("new()");
}

// Handle 'allows ref struct' constraint
if (isAllowsRefStruct)
{
if (comma || constraints.Count > 0 || isnew)
buf.Append(", ");
buf.Append("allows ref struct");
}
}
return buf;
}
Expand Down
18 changes: 18 additions & 0 deletions mdoc/mdoc.Test/FormatterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,6 +601,24 @@ public void CSharpStaticEventImplementation(string typeFullName, string eventNam
TestEventSignature(staticVirtualMemberDllPath, typeFullName, eventName, expectedSignature);
}

[TestCase("AllowsRefStructDemo.IRefStructProcessor`1",
"public interface IRefStructProcessor<T> where T : allows ref struct")]
public void CSharpAllowsRefStructForTypeTest(string typeFullName, string expectedSignature)
{
var allowsRefStructDllPath = "../../../../external/Test/AllowsRefStructDemo.dll";
TestTypeSignature(allowsRefStructDllPath, typeFullName, expectedSignature);
}

[TestCase("AllowsRefStructDemo.Immutable", "Update",
"public bool Update<TArg> (TArg transformerArgument) where TArg : new(), allows ref struct;")]
[TestCase("AllowsRefStructDemo.RefStructHandler", "Handle",
"public void Handle<T> (ref T item) where T : new(), allows ref struct;")]
public void CSharpAllowsRefStructForMemberTest(string typeFullName, string methodName, string expectedSignature)
{
var allowsRefStructDllPath = "../../../../external/Test/AllowsRefStructDemo.dll";
TestMethodSignature(allowsRefStructDllPath, typeFullName, methodName, expectedSignature);
}

#region Helper Methods
string RealTypeName(string name){
switch (name) {
Expand Down