Skip to content
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

Jump to bottom

Fix friendly overload handling of reserved parameters #841

Merged
merged 1 commit into from
Jan 5, 2023
Merged

Fix friendly overload handling of reserved parameters #841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 17 additions & 9 deletions src/Microsoft.Windows.CsWin32/Generator.FriendlyOverloads.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ private IEnumerable<MethodDeclarationSyntax> DeclareFriendlyOverloads(MethodDefi
MethodSignature<TypeHandleInfo> originalSignature = methodDefinition.DecodeSignature(SignatureHandleProvider.Instance, null);
var parameters = externMethodDeclaration.ParameterList.Parameters.Select(StripAttributes).ToList();
var lengthParamUsedBy = new Dictionary<int, int>();
var parametersToRemove = new List<int>();
var arguments = externMethodDeclaration.ParameterList.Parameters.Select(p => Argument(IdentifierName(p.Identifier.Text)).WithRefKindKeyword(p.Modifiers.FirstOrDefault(p => p.Kind() is SyntaxKind.RefKeyword or SyntaxKind.OutKeyword or SyntaxKind.InKeyword))).ToList();
TypeSyntax? externMethodReturnType = externMethodDeclaration.ReturnType.WithoutLeadingTrivia();
var fixedBlocks = new List<VariableDeclarationSyntax>();
Expand All @@ -72,6 +73,8 @@ private IEnumerable<MethodDeclarationSyntax> DeclareFriendlyOverloads(MethodDefi
}

bool isOptional = (param.Attributes & ParameterAttributes.Optional) == ParameterAttributes.Optional;
bool isReserved = this.FindInteropDecorativeAttribute(param.GetCustomAttributes(), "ReservedAttribute") is not null;
isOptional |= isReserved; // Per metadata decision made at https://github.com/microsoft/win32metadata/issues/1421#issuecomment-1372608090
bool isIn = (param.Attributes & ParameterAttributes.In) == ParameterAttributes.In;
bool isConst = this.FindInteropDecorativeAttribute(param.GetCustomAttributes(), "ConstAttribute") is not null;
bool isComOutPtr = this.FindInteropDecorativeAttribute(param.GetCustomAttributes(), "ComOutPtrAttribute") is not null;
Expand All @@ -90,7 +93,14 @@ private IEnumerable<MethodDeclarationSyntax> DeclareFriendlyOverloads(MethodDefi
bool isManagedParameterType = this.IsManagedType(parameterTypeInfo);
IdentifierNameSyntax origName = IdentifierName(externParam.Identifier.ValueText);

if (isManagedParameterType && (externParam.Modifiers.Any(SyntaxKind.OutKeyword) || externParam.Modifiers.Any(SyntaxKind.RefKeyword)))
if (isReserved && !isOut)
{
// Remove the parameter and supply the default value for the type to the extern method.
arguments[param.SequenceNumber - 1] = Argument(LiteralExpression(SyntaxKind.DefaultLiteralExpression));
parametersToRemove.Add(param.SequenceNumber - 1);
signatureChanged = true;
}
else if (isManagedParameterType && (externParam.Modifiers.Any(SyntaxKind.OutKeyword) || externParam.Modifiers.Any(SyntaxKind.RefKeyword)))
{
bool hasOut = externParam.Modifiers.Any(SyntaxKind.OutKeyword);
arguments[param.SequenceNumber - 1] = arguments[param.SequenceNumber - 1].WithRefKindKeyword(TokenWithSpace(hasOut ? SyntaxKind.OutKeyword : SyntaxKind.RefKeyword));
Expand Down Expand Up @@ -487,15 +497,13 @@ private IEnumerable<MethodDeclarationSyntax> DeclareFriendlyOverloads(MethodDefi

if (signatureChanged)
{
if (lengthParamUsedBy.Count > 0)
// Remove in reverse order so as to not invalidate the indexes of elements to remove.
// Also take care to only remove each element once, even if it shows up multiple times in the collection.
SortedSet<int> parameterIndexesToRemove = new(lengthParamUsedBy.Keys);
parameterIndexesToRemove.UnionWith(parametersToRemove);
foreach (int indexToRemove in parameterIndexesToRemove.Reverse())
{
// Remove in reverse order so as to not invalidate the indexes of elements to remove.
// Also take care to only remove each element once, even if it shows up multiple times in the collection.
var parameterIndexesToRemove = new SortedSet<int>(lengthParamUsedBy.Keys);
foreach (int indexToRemove in parameterIndexesToRemove.Reverse())
{
parameters.RemoveAt(indexToRemove);
}
parameters.RemoveAt(indexToRemove);
}

TypeSyntax docRefExternName = overloadOf == FriendlyOverloadOf.InterfaceMethod
Expand Down
2 changes: 1 addition & 1 deletion test/GenerationSandbox.Tests/GeneratedForm.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ private static void PROC_InSignatureChangedToIntPtr()

private static void RegKeyHandle()
{
WIN32_ERROR status = PInvoke.RegLoadAppKey(string.Empty, out SafeRegistryHandle handle, 0, 0, 0);
WIN32_ERROR status = PInvoke.RegLoadAppKey(string.Empty, out SafeRegistryHandle handle, 0, 0);
}

private static void PreserveSigBasedOnMetadata()
Expand Down
2 changes: 2 additions & 0 deletions test/Microsoft.Windows.CsWin32.Tests/GeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,8 @@ public void SupportedOSPlatform_AppearsOnFriendlyOverloads()
"PZZWSTR",
"PCZZSTR",
"PCZZWSTR",
"LoadLibraryEx", // method with a reserved parameter
"IEnumNetCfgComponent", // interface with a method containing an `[Reserved] out` parameter (bonkers, I know).
"IEventSubscription",
"IRealTimeStylusSynchronization", // uses the `lock` C# keyword.
"IHTMLInputElement", // has a field named `checked`, a C# keyword.
Expand Down