Skip to content

Improve binder gen binding logic (init, member binding, polymorphism) #91717

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
merged 5 commits into from
Sep 11, 2023
Merged

Improve binder gen binding logic (init, member binding, polymorphism) #91717

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ec6d2d2
Improve binder gen binding logic (init, member minding, polymorphism)
layomia Aug 31, 2023
b4bed3d
Improve handling of types with no bindable members
layomia Sep 8, 2023
8cbf503
Enhance bind-parse-type-from-method-param to comprehensive baseline test
layomia Sep 9, 2023
60f62fb
Move emitter methods to the files they are used in
layomia Sep 9, 2023
6e7945a
Address feedback regarding assertions
layomia Sep 9, 2023
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
161 changes: 96 additions & 65 deletions ...es/Microsoft.Extensions.Configuration.Binder/gen/ConfigurationBindingGenerator.Emitter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,18 +64,27 @@ file static class {{Identifier.BindingExtensions}}
_context.AddSource($"{Identifier.BindingExtensions}.g.cs", _writer.ToSourceText());
}

private void EmitBindCoreCall(
TypeSpec type,
private void EmitBindingLogic(
ComplexTypeSpec type,
string memberAccessExpr,
string configArgExpr,
InitializationKind initKind,
Action<string>? writeOnSuccess = null)
{
Debug.Assert(type.CanInitialize);

if (!type.NeedsMemberBinding)
if (!type.HasBindableMembers)
{
EmitObjectInit(memberAccessExpr, initKind);
if (initKind is not InitializationKind.None)
{
if (type.CanInstantiate)
{
EmitObjectInit(type, memberAccessExpr, initKind, configArgExpr);
}
else if (type is ObjectSpec { InitExceptionMessage: string exMsg })
{
_writer.WriteLine($@"throw new {Identifier.InvalidOperationException}(""{exMsg}"");");
}
}

return;
}

Expand All @@ -84,36 +93,56 @@ private void EmitBindCoreCall(
{
Debug.Assert(!type.IsValueType);
_writer.WriteLine($"{type.DisplayString}? {tempIdentifier} = {memberAccessExpr};");
EmitBindCoreCall(tempIdentifier, InitializationKind.AssignmentWithNullCheck);
EmitBindingLogic(tempIdentifier, InitializationKind.AssignmentWithNullCheck);
}
else if (initKind is InitializationKind.None && type.IsValueType)
{
EmitBindCoreCall(tempIdentifier, InitializationKind.Declaration);
EmitBindingLogic(tempIdentifier, InitializationKind.Declaration);
_writer.WriteLine($"{memberAccessExpr} = {tempIdentifier};");
}
else
{
EmitBindCoreCall(memberAccessExpr, initKind);
EmitBindingLogic(memberAccessExpr, initKind);
}

void EmitBindCoreCall(string instanceExpr, InitializationKind initKind)
void EmitBindingLogic(string instanceToBindExpr, InitializationKind initKind)
{
string bindCoreCall = $@"{nameof(MethodsToGen_CoreBindingHelper.BindCore)}({configArgExpr}, ref {instanceExpr}, {Identifier.binderOptions});";
EmitObjectInit(instanceExpr, initKind);
_writer.WriteLine(bindCoreCall);
writeOnSuccess?.Invoke(instanceExpr);
}
string bindCoreCall = $@"{nameof(MethodsToGen_CoreBindingHelper.BindCore)}({configArgExpr}, ref {instanceToBindExpr}, {Identifier.binderOptions});";

void EmitObjectInit(string instanceExpr, InitializationKind initKind)
{
if (initKind is not InitializationKind.None)
if (type.CanInstantiate)
{
if (initKind is not InitializationKind.None)
{
EmitObjectInit(type, instanceToBindExpr, initKind, configArgExpr);
}

EmitBindCoreCall();
}
else
{
Debug.Assert(!type.IsValueType);

if (type is ObjectSpec { InitExceptionMessage: string exMsg })
{
_writer.WriteLine($@"throw new {Identifier.InvalidOperationException}(""{exMsg}"");");
}
else
{
EmitStartBlock($"if ({instanceToBindExpr} is not null)");
EmitBindCoreCall();
EmitEndBlock();
}
}

void EmitBindCoreCall()
{
this.EmitObjectInit(type, instanceExpr, initKind, configArgExpr);
_writer.WriteLine(bindCoreCall);
writeOnSuccess?.Invoke(instanceToBindExpr);
}
}
}

private void EmitBindLogicFromString(
private void EmitBindingLogic(
ParsableFromStringSpec type,
string sectionValueExpr,
string sectionPathExpr,
Expand All @@ -126,20 +155,12 @@ private void EmitBindLogicFromString(

string nonNull_StringValue_Identifier = useIncrementalStringValueIdentifier ? GetIncrementalIdentifier(Identifier.value) : Identifier.value;
string stringValueToParse_Expr = checkForNullSectionValue ? nonNull_StringValue_Identifier : sectionValueExpr;

string parsedValueExpr;
if (typeKind is StringParsableTypeKind.AssignFromSectionValue)
string parsedValueExpr = typeKind switch
{
parsedValueExpr = stringValueToParse_Expr;
}
else if (typeKind is StringParsableTypeKind.Enum)
{
parsedValueExpr = $"ParseEnum<{type.DisplayString}>({stringValueToParse_Expr}, () => {sectionPathExpr})";
}
else
{
parsedValueExpr = $"{type.ParseMethodName}({stringValueToParse_Expr}, () => {sectionPathExpr})";
}
StringParsableTypeKind.AssignFromSectionValue => stringValueToParse_Expr,
StringParsableTypeKind.Enum => $"ParseEnum<{type.DisplayString}>({stringValueToParse_Expr}, () => {sectionPathExpr})",
_ => $"{type.ParseMethodName}({stringValueToParse_Expr}, () => {sectionPathExpr})",
};

if (!checkForNullSectionValue)
{
Expand All @@ -155,67 +176,77 @@ private void EmitBindLogicFromString(
void InvokeWriteOnSuccess() => writeOnSuccess?.Invoke(parsedValueExpr);
}

private bool EmitObjectInit(TypeSpec type, string memberAccessExpr, InitializationKind initKind, string configArgExpr)
private bool EmitObjectInit(ComplexTypeSpec type, string memberAccessExpr, InitializationKind initKind, string configArgExpr)
{
Debug.Assert(type.CanInitialize && initKind is not InitializationKind.None);

string initExpr;
CollectionSpec? collectionType = type as CollectionSpec;
string initExpr;

string effectiveDisplayString = type.DisplayString;
if (collectionType is not null)
{
if (collectionType is EnumerableSpec { InitializationStrategy: InitializationStrategy.Array })
if (collectionType is EnumerableSpec { InstantiationStrategy: InstantiationStrategy.Array })
{
initExpr = $"new {s_arrayBracketsRegex.Replace(effectiveDisplayString, "[0]", 1)}";
}
else
{
effectiveDisplayString = (collectionType.ConcreteType ?? collectionType).DisplayString;
effectiveDisplayString = (collectionType.TypeToInstantiate ?? collectionType).DisplayString;
initExpr = $"new {effectiveDisplayString}()";
}
}
else if (type.InitializationStrategy is InitializationStrategy.ParameterlessConstructor)
else if (type.InstantiationStrategy is InstantiationStrategy.ParameterlessConstructor)
{
initExpr = $"new {effectiveDisplayString}()";
}
else
{
Debug.Assert(type.InitializationStrategy is InitializationStrategy.ParameterizedConstructor);
Debug.Assert(type.InstantiationStrategy is InstantiationStrategy.ParameterizedConstructor);
string initMethodIdentifier = GetInitalizeMethodDisplayString(((ObjectSpec)type));
initExpr = $"{initMethodIdentifier}({configArgExpr}, {Identifier.binderOptions})";
}

if (initKind == InitializationKind.Declaration)
{
Debug.Assert(!memberAccessExpr.Contains("."));
_writer.WriteLine($"var {memberAccessExpr} = {initExpr};");
}
else if (initKind == InitializationKind.AssignmentWithNullCheck)
switch (initKind)
{
if (collectionType is CollectionSpec
case InitializationKind.Declaration:
{
InitializationStrategy: InitializationStrategy.ParameterizedConstructor or InitializationStrategy.ToEnumerableMethod
})
{
if (collectionType.InitializationStrategy is InitializationStrategy.ParameterizedConstructor)
Debug.Assert(!memberAccessExpr.Contains("."));
_writer.WriteLine($"var {memberAccessExpr} = {initExpr};");
}
break;
case InitializationKind.AssignmentWithNullCheck:
{
if (collectionType is CollectionSpec
{
InstantiationStrategy: InstantiationStrategy.ParameterizedConstructor or InstantiationStrategy.ToEnumerableMethod
})
{
if (collectionType.InstantiationStrategy is InstantiationStrategy.ParameterizedConstructor)
{
_writer.WriteLine($"{memberAccessExpr} = {memberAccessExpr} is null ? {initExpr} : new {effectiveDisplayString}({memberAccessExpr});");
}
else
{
Debug.Assert(collectionType is DictionarySpec);
_writer.WriteLine($"{memberAccessExpr} = {memberAccessExpr} is null ? {initExpr} : {memberAccessExpr}.ToDictionary(pair => pair.Key, pair => pair.Value);");
}
}
else
{
_writer.WriteLine($"{memberAccessExpr} ??= {initExpr};");
}
}
break;
case InitializationKind.SimpleAssignment:
{
_writer.WriteLine($"{memberAccessExpr} = {memberAccessExpr} is null ? {initExpr} : new {effectiveDisplayString}({memberAccessExpr});");
_writer.WriteLine($"{memberAccessExpr} = {initExpr};");
}
else
break;
default:
{
_writer.WriteLine($"{memberAccessExpr} = {memberAccessExpr} is null ? {initExpr} : {memberAccessExpr}.{collectionType.ToEnumerableMethodCall!};");
Debug.Fail($"Invaild initialization kind: {initKind}");
}
}
else
{
_writer.WriteLine($"{memberAccessExpr} ??= {initExpr};");
}
}
else
{
Debug.Assert(initKind is InitializationKind.SimpleAssignment);
_writer.WriteLine($"{memberAccessExpr} = {initExpr};");
break;

}

return true;
Expand Down
Loading