Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,9 @@ private sealed partial class Emitter
private readonly InterceptorInfo _interceptorInfo;
private readonly BindingHelperInfo _bindingHelperInfo;
private readonly TypeIndex _typeIndex;
private readonly bool _emitEnumParseMethod;
private readonly bool _emitGenericParseEnum;
private readonly bool _emitThrowIfNullMethod;

private readonly SourceWriter _writer = new();

Expand All@@ -21,6 +24,9 @@ public Emitter(SourceGenerationSpec sourceGenSpec)
_interceptorInfo = sourceGenSpec.InterceptorInfo;
_bindingHelperInfo = sourceGenSpec.BindingHelperInfo;
_typeIndex = new TypeIndex(sourceGenSpec.ConfigTypes);
_emitEnumParseMethod = sourceGenSpec.EmitEnumParseMethod;
_emitGenericParseEnum = sourceGenSpec.EmitGenericParseEnum;
_emitThrowIfNullMethod = sourceGenSpec.EmitThrowIfNullMethod;
}

public void Emit(SourceProductionContext context)
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,8 @@ internal sealed partial class Parser(CompilationData compilationData)

private readonly InterceptorInfo.Builder _interceptorInfoBuilder = new();
private BindingHelperInfo.Builder? _helperInfoBuilder; // Init'ed with type index when registering interceptors, after creating type specs.
private bool _emitEnumParseMethod;
private bool _emitGenericParseEnum;

public List<DiagnosticInfo>? Diagnostics { get; private set; }

Expand All@@ -45,12 +47,16 @@ internal sealed partial class Parser(CompilationData compilationData)
ParseInvocations(invocations);
CreateTypeSpecs(cancellationToken);
RegisterInterceptors();
CheckIfToEmitParseEnumMethod();

return new SourceGenerationSpec
{
InterceptorInfo = _interceptorInfoBuilder.ToIncrementalValue(),
BindingHelperInfo = _helperInfoBuilder!.ToIncrementalValue(),
ConfigTypes = _createdTypeSpecs.Values.OrderBy(s => s.TypeRef.FullyQualifiedName).ToImmutableEquatableArray(),
EmitEnumParseMethod = _emitEnumParseMethod,
EmitGenericParseEnum = _emitGenericParseEnum,
EmitThrowIfNullMethod = IsThrowIfNullMethodToBeEmitted()
};
}

Expand DownExpand Up@@ -842,6 +848,45 @@ private void RecordDiagnostic(DiagnosticDescriptor descriptor, Location trimmedL
Diagnostics ??= new List<DiagnosticInfo>();
Diagnostics.Add(DiagnosticInfo.Create(descriptor, trimmedLocation, messageArgs));
}

private void CheckIfToEmitParseEnumMethod()
{
foreach (var typeSymbol in _createdTypeSpecs.Keys)
{
if (IsEnum(typeSymbol))
{
_emitEnumParseMethod = true;
_emitGenericParseEnum = _typeSymbols.Enum.GetMembers("Parse").Any(m => m is IMethodSymbol methodSymbol && methodSymbol.IsGenericMethod);
Comment thread
tarekgh marked this conversation as resolved.
return;
}
}
}

private bool IsThrowIfNullMethodToBeEmitted()
{
if (_typeSymbols.ArgumentNullException is not null)
{
var throwIfNullMethods = _typeSymbols.ArgumentNullException.GetMembers("ThrowIfNull");
Comment thread
tarekgh marked this conversation as resolved.

foreach (var throwIfNullMethod in throwIfNullMethods)
{
if (throwIfNullMethod is IMethodSymbol throwIfNullMethodSymbol && throwIfNullMethodSymbol.IsStatic && throwIfNullMethodSymbol.Parameters.Length == 2)
{
var parameters = throwIfNullMethodSymbol.Parameters;
var firstParam = parameters[0];
var secondParam = parameters[1];

if (firstParam.Name == "argument" && firstParam.Type.SpecialType == SpecialType.System_Object
&& secondParam.Name == "paramName" && secondParam.Type.Equals(_typeSymbols.String, SymbolEqualityComparer.Default))
{
return true;
}
}
}
}

return false;
}
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -144,8 +144,8 @@ void EmitMethods(ImmutableEquatableArray<TypedInterceptorInvocationInfo>? interc
Debug.Assert(!type.IsValueType);
string binderOptionsArg = configureOptions ? $"{Identifier.GetBinderOptions}({Identifier.configureOptions})" : $"{Identifier.binderOptions}: null";

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
_writer.WriteLine($$"""
var {{Identifier.typedObj}} = ({{type.DisplayString}}){{Identifier.instance}};
{{nameof(MethodsToGen_CoreBindingHelper.BindCore)}}({{configExpression}}, ref {{Identifier.typedObj}}, defaultValueIfNotFound: false, {{binderOptionsArg}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ private void EmitGetCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, Action<{Identifier.BinderOptions}>? {Identifier.configureOptions})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);

_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -178,7 +178,7 @@ private void EmitGetValueCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetValueCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, string {Identifier.key})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
_writer.WriteLine($@"{Identifier.IConfigurationSection} {Identifier.section} = {GetSectionFromConfigurationExpression(Identifier.key, addQuotes: false)};");
_writer.WriteLine();

Expand DownExpand Up@@ -224,7 +224,7 @@ private void EmitBindCoreMainMethod()

EmitBlankLineIfRequired();
EmitStartBlock($"public static void {nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}({Identifier.IConfiguration} {Identifier.configuration}, object {Identifier.instance}, Type {Identifier.type}, {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions})");
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
EmitIConfigurationHasValueOrChildrenCheck(voidReturn: true);
_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -475,24 +475,20 @@ private void EmitHelperMethods()
EmitGetBinderOptionsHelper();
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
if (_emitEnumParseMethod)
{
bool enumTypeExists = false;
_writer.WriteLine();
EmitEnumParseMethod();
_emitBlankLineBeforeNextStatement = true;
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
{
foreach (ParsableFromStringSpec type in stringParsableTypes)
{
EmitBlankLineIfRequired();

if (type.StringParsableTypeKind == StringParsableTypeKind.Enum)
{
if (!enumTypeExists)
{
EmitEnumParseMethod();
enumTypeExists = true;
}
}
else
if (type.StringParsableTypeKind is not StringParsableTypeKind.Enum)
{
EmitBlankLineIfRequired();
EmitPrimitiveParseMethod(type);
}
}
Expand DownExpand Up@@ -585,16 +581,13 @@ private void EmitEnumParseMethod()
{
string exceptionArg1 = string.Format(ExceptionMessages.FailedBinding, $"{{{Identifier.getPath}()}}", $"{{typeof(T)}}");

string parseEnumCall = _emitGenericParseEnum ? "Enum.Parse<T>(value, ignoreCase: true)" : "(T)Enum.Parse(typeof(T), value, ignoreCase: true)";
_writer.WriteLine($$"""
public static T ParseEnum<T>(string value, Func<string?> getPath) where T : struct
{
try
{
#if NETFRAMEWORK || NETSTANDARD2_0
return (T)Enum.Parse(typeof(T), value, ignoreCase: true);
#else
return Enum.Parse<T>(value, ignoreCase: true);
#endif
return {{parseEnumCall}};
}
catch ({{Identifier.Exception}} {{Identifier.exception}})
{
Expand All@@ -614,8 +607,6 @@ private void EmitPrimitiveParseMethod(ParsableFromStringSpec type)

switch (typeKind)
{
case StringParsableTypeKind.Enum:
return;
case StringParsableTypeKind.ByteArray:
{
parsedValueExpr = $"Convert.FromBase64String({Identifier.value})";
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -229,18 +229,30 @@ private void EmitBlankLineIfRequired()
_emitBlankLineBeforeNextStatement = true;
}

private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool voidReturn = false)
private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool useThrowIfNullMethod, bool voidReturn = false)
{
string returnExpr = voidReturn
? "return"
: $"throw new ArgumentNullException(nameof({paramName}))";

_writer.WriteLine($$"""
if (voidReturn)
{
_writer.WriteLine($$"""
if ({{paramName}} is null)
{
{{returnExpr}};
return;
}
""");
}
else
{
string throwIfNullExpr = useThrowIfNullMethod
? $"ArgumentNullException.ThrowIfNull({paramName});"
Comment thread
tarekgh marked this conversation as resolved.
: $$"""
if ({{paramName}} is null)
{
throw new ArgumentNullException(nameof({{paramName}}));
}
""";

_writer.WriteLine(throwIfNullExpr);
}

_writer.WriteLine();
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ private void EmitBindMethods_Extensions_OptionsBuilder()
paramList + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureBinder}",
documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);

_writer.WriteLine($$"""
{{Identifier.Configure}}<{{Identifier.TOptions}}>({{Identifier.optionsBuilder}}.{{Identifier.Services}}, {{Identifier.optionsBuilder}}.Name, {{Identifier.config}}, {{Identifier.configureBinder}});
Expand All@@ -65,11 +65,11 @@ private void EmitBindConfigurationMethod()

EmitMethodStartBlock(MethodsToGen.OptionsBuilderExt_BindConfiguration, "BindConfiguration", paramList, documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath, _emitThrowIfNullMethod);

EmitStartBlock($"{Identifier.optionsBuilder}.{Identifier.Configure}<{Identifier.IConfiguration}>(({Identifier.instance}, {Identifier.config}) =>");
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
{{Identifier.IConfiguration}} {{Identifier.section}} = string.Equals(string.Empty, {{Identifier.configSectionPath}}, StringComparison.OrdinalIgnoreCase) ? {{Identifier.config}} : {{Identifier.config}}.{{Identifier.GetSection}}({{Identifier.configSectionPath}});
{{nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}}({{Identifier.section}}, {{Identifier.instance}}, typeof({{Identifier.TOptions}}), {{Identifier.configureBinder}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ private void EmitConfigureMethods()
// Like the others, it is public API that could be called directly by users.
// So, it is always generated whenever a Configure overload is called.
EmitStartMethod(MethodsToGen.ServiceCollectionExt_Configure_T_name_BinderOptions, paramList: $"string? {Identifier.name}, " + configParam + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions}");
EmitCheckForNullArgument_WithBlankLine(Identifier.services);
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.services, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
OptionsServiceCollectionExtensions.AddOptions({{Identifier.services}});
{{Identifier.services}}.{{Identifier.AddSingleton}}<{{Identifier.IOptionsChangeTokenSource}}<{{Identifier.TOptions}}>>(new {{Identifier.ConfigurationChangeTokenSource}}<{{Identifier.TOptions}}>({{Identifier.name}}, {{Identifier.config}}));
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,8 @@ internal sealed class KnownTypeSymbols
public INamedTypeSymbol? ISet_Unbound { get; }
public INamedTypeSymbol? ISet { get; }
public INamedTypeSymbol? List { get; }
public INamedTypeSymbol Enum { get; }
public INamedTypeSymbol? ArgumentNullException { get; }

public KnownTypeSymbols(CSharpCompilation compilation)
{
Expand DownExpand Up@@ -113,6 +115,12 @@ public KnownTypeSymbols(CSharpCompilation compilation)
IReadOnlyList_Unbound = compilation.GetBestTypeByMetadataName(typeof(IReadOnlyList<>))?.ConstructUnboundGenericType();
IReadOnlySet_Unbound = compilation.GetBestTypeByMetadataName("System.Collections.Generic.IReadOnlySet`1")?.ConstructUnboundGenericType();
ISet_Unbound = ISet?.ConstructUnboundGenericType();

// needed to be able to know if a member exist inside the compilation unit
Enum = compilation.GetSpecialType(SpecialType.System_Enum);
ArgumentNullException = compilation.GetBestTypeByMetadataName(typeof(ArgumentNullException));

String = compilation.GetBestTypeByMetadataName(typeof(string));
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,5 +10,8 @@ public sealed record SourceGenerationSpec
public required InterceptorInfo InterceptorInfo { get; init; }
public required BindingHelperInfo BindingHelperInfo { get; init; }
public required ImmutableEquatableArray<TypeSpec> ConfigTypes { get; init; }
public required bool EmitEnumParseMethod { get; set; }
public required bool EmitGenericParseEnum { get; set; }
public required bool EmitThrowIfNullMethod { get; set; }
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Address feedback from config binding gen PR to improve enum parsing by pedrobsaila · Pull Request #89952 · dotnet/runtime · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,9 @@ private sealed partial class Emitter
private readonly InterceptorInfo _interceptorInfo;
private readonly BindingHelperInfo _bindingHelperInfo;
private readonly TypeIndex _typeIndex;
private readonly bool _emitEnumParseMethod;
private readonly bool _emitGenericParseEnum;
private readonly bool _emitThrowIfNullMethod;

private readonly SourceWriter _writer = new();

Expand All@@ -21,6 +24,9 @@ public Emitter(SourceGenerationSpec sourceGenSpec)
_interceptorInfo = sourceGenSpec.InterceptorInfo;
_bindingHelperInfo = sourceGenSpec.BindingHelperInfo;
_typeIndex = new TypeIndex(sourceGenSpec.ConfigTypes);
_emitEnumParseMethod = sourceGenSpec.EmitEnumParseMethod;
_emitGenericParseEnum = sourceGenSpec.EmitGenericParseEnum;
_emitThrowIfNullMethod = sourceGenSpec.EmitThrowIfNullMethod;
}

public void Emit(SourceProductionContext context)
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,8 @@ internal sealed partial class Parser(CompilationData compilationData)

private readonly InterceptorInfo.Builder _interceptorInfoBuilder = new();
private BindingHelperInfo.Builder? _helperInfoBuilder; // Init'ed with type index when registering interceptors, after creating type specs.
private bool _emitEnumParseMethod;
private bool _emitGenericParseEnum;

public List<DiagnosticInfo>? Diagnostics { get; private set; }

Expand All@@ -45,12 +47,16 @@ internal sealed partial class Parser(CompilationData compilationData)
ParseInvocations(invocations);
CreateTypeSpecs(cancellationToken);
RegisterInterceptors();
CheckIfToEmitParseEnumMethod();

return new SourceGenerationSpec
{
InterceptorInfo = _interceptorInfoBuilder.ToIncrementalValue(),
BindingHelperInfo = _helperInfoBuilder!.ToIncrementalValue(),
ConfigTypes = _createdTypeSpecs.Values.OrderBy(s => s.TypeRef.FullyQualifiedName).ToImmutableEquatableArray(),
EmitEnumParseMethod = _emitEnumParseMethod,
EmitGenericParseEnum = _emitGenericParseEnum,
EmitThrowIfNullMethod = IsThrowIfNullMethodToBeEmitted()
};
}

Expand DownExpand Up@@ -842,6 +848,45 @@ private void RecordDiagnostic(DiagnosticDescriptor descriptor, Location trimmedL
Diagnostics ??= new List<DiagnosticInfo>();
Diagnostics.Add(DiagnosticInfo.Create(descriptor, trimmedLocation, messageArgs));
}

private void CheckIfToEmitParseEnumMethod()
{
foreach (var typeSymbol in _createdTypeSpecs.Keys)
{
if (IsEnum(typeSymbol))
{
_emitEnumParseMethod = true;
_emitGenericParseEnum = _typeSymbols.Enum.GetMembers("Parse").Any(m => m is IMethodSymbol methodSymbol && methodSymbol.IsGenericMethod);
Comment thread
tarekgh marked this conversation as resolved.
return;
}
}
}

private bool IsThrowIfNullMethodToBeEmitted()
{
if (_typeSymbols.ArgumentNullException is not null)
{
var throwIfNullMethods = _typeSymbols.ArgumentNullException.GetMembers("ThrowIfNull");
Comment thread
tarekgh marked this conversation as resolved.

foreach (var throwIfNullMethod in throwIfNullMethods)
{
if (throwIfNullMethod is IMethodSymbol throwIfNullMethodSymbol && throwIfNullMethodSymbol.IsStatic && throwIfNullMethodSymbol.Parameters.Length == 2)
{
var parameters = throwIfNullMethodSymbol.Parameters;
var firstParam = parameters[0];
var secondParam = parameters[1];

if (firstParam.Name == "argument" && firstParam.Type.SpecialType == SpecialType.System_Object
&& secondParam.Name == "paramName" && secondParam.Type.Equals(_typeSymbols.String, SymbolEqualityComparer.Default))
{
return true;
}
}
}
}

return false;
}
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -144,8 +144,8 @@ void EmitMethods(ImmutableEquatableArray<TypedInterceptorInvocationInfo>? interc
Debug.Assert(!type.IsValueType);
string binderOptionsArg = configureOptions ? $"{Identifier.GetBinderOptions}({Identifier.configureOptions})" : $"{Identifier.binderOptions}: null";

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
_writer.WriteLine($$"""
var {{Identifier.typedObj}} = ({{type.DisplayString}}){{Identifier.instance}};
{{nameof(MethodsToGen_CoreBindingHelper.BindCore)}}({{configExpression}}, ref {{Identifier.typedObj}}, defaultValueIfNotFound: false, {{binderOptionsArg}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ private void EmitGetCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, Action<{Identifier.BinderOptions}>? {Identifier.configureOptions})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);

_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -178,7 +178,7 @@ private void EmitGetValueCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetValueCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, string {Identifier.key})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
_writer.WriteLine($@"{Identifier.IConfigurationSection} {Identifier.section} = {GetSectionFromConfigurationExpression(Identifier.key, addQuotes: false)};");
_writer.WriteLine();

Expand DownExpand Up@@ -224,7 +224,7 @@ private void EmitBindCoreMainMethod()

EmitBlankLineIfRequired();
EmitStartBlock($"public static void {nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}({Identifier.IConfiguration} {Identifier.configuration}, object {Identifier.instance}, Type {Identifier.type}, {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions})");
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
EmitIConfigurationHasValueOrChildrenCheck(voidReturn: true);
_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -475,24 +475,20 @@ private void EmitHelperMethods()
EmitGetBinderOptionsHelper();
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
if (_emitEnumParseMethod)
{
bool enumTypeExists = false;
_writer.WriteLine();
EmitEnumParseMethod();
_emitBlankLineBeforeNextStatement = true;
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
{
foreach (ParsableFromStringSpec type in stringParsableTypes)
{
EmitBlankLineIfRequired();

if (type.StringParsableTypeKind == StringParsableTypeKind.Enum)
{
if (!enumTypeExists)
{
EmitEnumParseMethod();
enumTypeExists = true;
}
}
else
if (type.StringParsableTypeKind is not StringParsableTypeKind.Enum)
{
EmitBlankLineIfRequired();
EmitPrimitiveParseMethod(type);
}
}
Expand DownExpand Up@@ -585,16 +581,13 @@ private void EmitEnumParseMethod()
{
string exceptionArg1 = string.Format(ExceptionMessages.FailedBinding, $"{{{Identifier.getPath}()}}", $"{{typeof(T)}}");

string parseEnumCall = _emitGenericParseEnum ? "Enum.Parse<T>(value, ignoreCase: true)" : "(T)Enum.Parse(typeof(T), value, ignoreCase: true)";
_writer.WriteLine($$"""
public static T ParseEnum<T>(string value, Func<string?> getPath) where T : struct
{
try
{
#if NETFRAMEWORK || NETSTANDARD2_0
return (T)Enum.Parse(typeof(T), value, ignoreCase: true);
#else
return Enum.Parse<T>(value, ignoreCase: true);
#endif
return {{parseEnumCall}};
}
catch ({{Identifier.Exception}} {{Identifier.exception}})
{
Expand All@@ -614,8 +607,6 @@ private void EmitPrimitiveParseMethod(ParsableFromStringSpec type)

switch (typeKind)
{
case StringParsableTypeKind.Enum:
return;
case StringParsableTypeKind.ByteArray:
{
parsedValueExpr = $"Convert.FromBase64String({Identifier.value})";
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -229,18 +229,30 @@ private void EmitBlankLineIfRequired()
_emitBlankLineBeforeNextStatement = true;
}

private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool voidReturn = false)
private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool useThrowIfNullMethod, bool voidReturn = false)
{
string returnExpr = voidReturn
? "return"
: $"throw new ArgumentNullException(nameof({paramName}))";

_writer.WriteLine($$"""
if (voidReturn)
{
_writer.WriteLine($$"""
if ({{paramName}} is null)
{
{{returnExpr}};
return;
}
""");
}
else
{
string throwIfNullExpr = useThrowIfNullMethod
? $"ArgumentNullException.ThrowIfNull({paramName});"
Comment thread
tarekgh marked this conversation as resolved.
: $$"""
if ({{paramName}} is null)
{
throw new ArgumentNullException(nameof({{paramName}}));
}
""";

_writer.WriteLine(throwIfNullExpr);
}

_writer.WriteLine();
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ private void EmitBindMethods_Extensions_OptionsBuilder()
paramList + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureBinder}",
documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);

_writer.WriteLine($$"""
{{Identifier.Configure}}<{{Identifier.TOptions}}>({{Identifier.optionsBuilder}}.{{Identifier.Services}}, {{Identifier.optionsBuilder}}.Name, {{Identifier.config}}, {{Identifier.configureBinder}});
Expand All@@ -65,11 +65,11 @@ private void EmitBindConfigurationMethod()

EmitMethodStartBlock(MethodsToGen.OptionsBuilderExt_BindConfiguration, "BindConfiguration", paramList, documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath, _emitThrowIfNullMethod);

EmitStartBlock($"{Identifier.optionsBuilder}.{Identifier.Configure}<{Identifier.IConfiguration}>(({Identifier.instance}, {Identifier.config}) =>");
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
{{Identifier.IConfiguration}} {{Identifier.section}} = string.Equals(string.Empty, {{Identifier.configSectionPath}}, StringComparison.OrdinalIgnoreCase) ? {{Identifier.config}} : {{Identifier.config}}.{{Identifier.GetSection}}({{Identifier.configSectionPath}});
{{nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}}({{Identifier.section}}, {{Identifier.instance}}, typeof({{Identifier.TOptions}}), {{Identifier.configureBinder}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ private void EmitConfigureMethods()
// Like the others, it is public API that could be called directly by users.
// So, it is always generated whenever a Configure overload is called.
EmitStartMethod(MethodsToGen.ServiceCollectionExt_Configure_T_name_BinderOptions, paramList: $"string? {Identifier.name}, " + configParam + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions}");
EmitCheckForNullArgument_WithBlankLine(Identifier.services);
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.services, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
OptionsServiceCollectionExtensions.AddOptions({{Identifier.services}});
{{Identifier.services}}.{{Identifier.AddSingleton}}<{{Identifier.IOptionsChangeTokenSource}}<{{Identifier.TOptions}}>>(new {{Identifier.ConfigurationChangeTokenSource}}<{{Identifier.TOptions}}>({{Identifier.name}}, {{Identifier.config}}));
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,8 @@ internal sealed class KnownTypeSymbols
public INamedTypeSymbol? ISet_Unbound { get; }
public INamedTypeSymbol? ISet { get; }
public INamedTypeSymbol? List { get; }
public INamedTypeSymbol Enum { get; }
public INamedTypeSymbol? ArgumentNullException { get; }

public KnownTypeSymbols(CSharpCompilation compilation)
{
Expand DownExpand Up@@ -113,6 +115,12 @@ public KnownTypeSymbols(CSharpCompilation compilation)
IReadOnlyList_Unbound = compilation.GetBestTypeByMetadataName(typeof(IReadOnlyList<>))?.ConstructUnboundGenericType();
IReadOnlySet_Unbound = compilation.GetBestTypeByMetadataName("System.Collections.Generic.IReadOnlySet`1")?.ConstructUnboundGenericType();
ISet_Unbound = ISet?.ConstructUnboundGenericType();

// needed to be able to know if a member exist inside the compilation unit
Enum = compilation.GetSpecialType(SpecialType.System_Enum);
ArgumentNullException = compilation.GetBestTypeByMetadataName(typeof(ArgumentNullException));

String = compilation.GetBestTypeByMetadataName(typeof(string));
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,5 +10,8 @@ public sealed record SourceGenerationSpec
public required InterceptorInfo InterceptorInfo { get; init; }
public required BindingHelperInfo BindingHelperInfo { get; init; }
public required ImmutableEquatableArray<TypeSpec> ConfigTypes { get; init; }
public required bool EmitEnumParseMethod { get; set; }
public required bool EmitGenericParseEnum { get; set; }
public required bool EmitThrowIfNullMethod { get; set; }
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Address feedback from config binding gen PR to improve enum parsing by pedrobsaila · Pull Request #89952 · dotnet/runtime · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,9 @@ private sealed partial class Emitter
private readonly InterceptorInfo _interceptorInfo;
private readonly BindingHelperInfo _bindingHelperInfo;
private readonly TypeIndex _typeIndex;
private readonly bool _emitEnumParseMethod;
private readonly bool _emitGenericParseEnum;
private readonly bool _emitThrowIfNullMethod;

private readonly SourceWriter _writer = new();

Expand All@@ -21,6 +24,9 @@ public Emitter(SourceGenerationSpec sourceGenSpec)
_interceptorInfo = sourceGenSpec.InterceptorInfo;
_bindingHelperInfo = sourceGenSpec.BindingHelperInfo;
_typeIndex = new TypeIndex(sourceGenSpec.ConfigTypes);
_emitEnumParseMethod = sourceGenSpec.EmitEnumParseMethod;
_emitGenericParseEnum = sourceGenSpec.EmitGenericParseEnum;
_emitThrowIfNullMethod = sourceGenSpec.EmitThrowIfNullMethod;
}

public void Emit(SourceProductionContext context)
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,8 @@ internal sealed partial class Parser(CompilationData compilationData)

private readonly InterceptorInfo.Builder _interceptorInfoBuilder = new();
private BindingHelperInfo.Builder? _helperInfoBuilder; // Init'ed with type index when registering interceptors, after creating type specs.
private bool _emitEnumParseMethod;
private bool _emitGenericParseEnum;

public List<DiagnosticInfo>? Diagnostics { get; private set; }

Expand All@@ -45,12 +47,16 @@ internal sealed partial class Parser(CompilationData compilationData)
ParseInvocations(invocations);
CreateTypeSpecs(cancellationToken);
RegisterInterceptors();
CheckIfToEmitParseEnumMethod();

return new SourceGenerationSpec
{
InterceptorInfo = _interceptorInfoBuilder.ToIncrementalValue(),
BindingHelperInfo = _helperInfoBuilder!.ToIncrementalValue(),
ConfigTypes = _createdTypeSpecs.Values.OrderBy(s => s.TypeRef.FullyQualifiedName).ToImmutableEquatableArray(),
EmitEnumParseMethod = _emitEnumParseMethod,
EmitGenericParseEnum = _emitGenericParseEnum,
EmitThrowIfNullMethod = IsThrowIfNullMethodToBeEmitted()
};
}

Expand DownExpand Up@@ -842,6 +848,45 @@ private void RecordDiagnostic(DiagnosticDescriptor descriptor, Location trimmedL
Diagnostics ??= new List<DiagnosticInfo>();
Diagnostics.Add(DiagnosticInfo.Create(descriptor, trimmedLocation, messageArgs));
}

private void CheckIfToEmitParseEnumMethod()
{
foreach (var typeSymbol in _createdTypeSpecs.Keys)
{
if (IsEnum(typeSymbol))
{
_emitEnumParseMethod = true;
_emitGenericParseEnum = _typeSymbols.Enum.GetMembers("Parse").Any(m => m is IMethodSymbol methodSymbol && methodSymbol.IsGenericMethod);
Comment thread
tarekgh marked this conversation as resolved.
return;
}
}
}

private bool IsThrowIfNullMethodToBeEmitted()
{
if (_typeSymbols.ArgumentNullException is not null)
{
var throwIfNullMethods = _typeSymbols.ArgumentNullException.GetMembers("ThrowIfNull");
Comment thread
tarekgh marked this conversation as resolved.

foreach (var throwIfNullMethod in throwIfNullMethods)
{
if (throwIfNullMethod is IMethodSymbol throwIfNullMethodSymbol && throwIfNullMethodSymbol.IsStatic && throwIfNullMethodSymbol.Parameters.Length == 2)
{
var parameters = throwIfNullMethodSymbol.Parameters;
var firstParam = parameters[0];
var secondParam = parameters[1];

if (firstParam.Name == "argument" && firstParam.Type.SpecialType == SpecialType.System_Object
&& secondParam.Name == "paramName" && secondParam.Type.Equals(_typeSymbols.String, SymbolEqualityComparer.Default))
{
return true;
}
}
}
}

return false;
}
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -144,8 +144,8 @@ void EmitMethods(ImmutableEquatableArray<TypedInterceptorInvocationInfo>? interc
Debug.Assert(!type.IsValueType);
string binderOptionsArg = configureOptions ? $"{Identifier.GetBinderOptions}({Identifier.configureOptions})" : $"{Identifier.binderOptions}: null";

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
_writer.WriteLine($$"""
var {{Identifier.typedObj}} = ({{type.DisplayString}}){{Identifier.instance}};
{{nameof(MethodsToGen_CoreBindingHelper.BindCore)}}({{configExpression}}, ref {{Identifier.typedObj}}, defaultValueIfNotFound: false, {{binderOptionsArg}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ private void EmitGetCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, Action<{Identifier.BinderOptions}>? {Identifier.configureOptions})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);

_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -178,7 +178,7 @@ private void EmitGetValueCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetValueCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, string {Identifier.key})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
_writer.WriteLine($@"{Identifier.IConfigurationSection} {Identifier.section} = {GetSectionFromConfigurationExpression(Identifier.key, addQuotes: false)};");
_writer.WriteLine();

Expand DownExpand Up@@ -224,7 +224,7 @@ private void EmitBindCoreMainMethod()

EmitBlankLineIfRequired();
EmitStartBlock($"public static void {nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}({Identifier.IConfiguration} {Identifier.configuration}, object {Identifier.instance}, Type {Identifier.type}, {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions})");
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
EmitIConfigurationHasValueOrChildrenCheck(voidReturn: true);
_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -475,24 +475,20 @@ private void EmitHelperMethods()
EmitGetBinderOptionsHelper();
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
if (_emitEnumParseMethod)
{
bool enumTypeExists = false;
_writer.WriteLine();
EmitEnumParseMethod();
_emitBlankLineBeforeNextStatement = true;
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
{
foreach (ParsableFromStringSpec type in stringParsableTypes)
{
EmitBlankLineIfRequired();

if (type.StringParsableTypeKind == StringParsableTypeKind.Enum)
{
if (!enumTypeExists)
{
EmitEnumParseMethod();
enumTypeExists = true;
}
}
else
if (type.StringParsableTypeKind is not StringParsableTypeKind.Enum)
{
EmitBlankLineIfRequired();
EmitPrimitiveParseMethod(type);
}
}
Expand DownExpand Up@@ -585,16 +581,13 @@ private void EmitEnumParseMethod()
{
string exceptionArg1 = string.Format(ExceptionMessages.FailedBinding, $"{{{Identifier.getPath}()}}", $"{{typeof(T)}}");

string parseEnumCall = _emitGenericParseEnum ? "Enum.Parse<T>(value, ignoreCase: true)" : "(T)Enum.Parse(typeof(T), value, ignoreCase: true)";
_writer.WriteLine($$"""
public static T ParseEnum<T>(string value, Func<string?> getPath) where T : struct
{
try
{
#if NETFRAMEWORK || NETSTANDARD2_0
return (T)Enum.Parse(typeof(T), value, ignoreCase: true);
#else
return Enum.Parse<T>(value, ignoreCase: true);
#endif
return {{parseEnumCall}};
}
catch ({{Identifier.Exception}} {{Identifier.exception}})
{
Expand All@@ -614,8 +607,6 @@ private void EmitPrimitiveParseMethod(ParsableFromStringSpec type)

switch (typeKind)
{
case StringParsableTypeKind.Enum:
return;
case StringParsableTypeKind.ByteArray:
{
parsedValueExpr = $"Convert.FromBase64String({Identifier.value})";
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -229,18 +229,30 @@ private void EmitBlankLineIfRequired()
_emitBlankLineBeforeNextStatement = true;
}

private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool voidReturn = false)
private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool useThrowIfNullMethod, bool voidReturn = false)
{
string returnExpr = voidReturn
? "return"
: $"throw new ArgumentNullException(nameof({paramName}))";

_writer.WriteLine($$"""
if (voidReturn)
{
_writer.WriteLine($$"""
if ({{paramName}} is null)
{
{{returnExpr}};
return;
}
""");
}
else
{
string throwIfNullExpr = useThrowIfNullMethod
? $"ArgumentNullException.ThrowIfNull({paramName});"
Comment thread
tarekgh marked this conversation as resolved.
: $$"""
if ({{paramName}} is null)
{
throw new ArgumentNullException(nameof({{paramName}}));
}
""";

_writer.WriteLine(throwIfNullExpr);
}

_writer.WriteLine();
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ private void EmitBindMethods_Extensions_OptionsBuilder()
paramList + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureBinder}",
documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);

_writer.WriteLine($$"""
{{Identifier.Configure}}<{{Identifier.TOptions}}>({{Identifier.optionsBuilder}}.{{Identifier.Services}}, {{Identifier.optionsBuilder}}.Name, {{Identifier.config}}, {{Identifier.configureBinder}});
Expand All@@ -65,11 +65,11 @@ private void EmitBindConfigurationMethod()

EmitMethodStartBlock(MethodsToGen.OptionsBuilderExt_BindConfiguration, "BindConfiguration", paramList, documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath, _emitThrowIfNullMethod);

EmitStartBlock($"{Identifier.optionsBuilder}.{Identifier.Configure}<{Identifier.IConfiguration}>(({Identifier.instance}, {Identifier.config}) =>");
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
{{Identifier.IConfiguration}} {{Identifier.section}} = string.Equals(string.Empty, {{Identifier.configSectionPath}}, StringComparison.OrdinalIgnoreCase) ? {{Identifier.config}} : {{Identifier.config}}.{{Identifier.GetSection}}({{Identifier.configSectionPath}});
{{nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}}({{Identifier.section}}, {{Identifier.instance}}, typeof({{Identifier.TOptions}}), {{Identifier.configureBinder}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ private void EmitConfigureMethods()
// Like the others, it is public API that could be called directly by users.
// So, it is always generated whenever a Configure overload is called.
EmitStartMethod(MethodsToGen.ServiceCollectionExt_Configure_T_name_BinderOptions, paramList: $"string? {Identifier.name}, " + configParam + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions}");
EmitCheckForNullArgument_WithBlankLine(Identifier.services);
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.services, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
OptionsServiceCollectionExtensions.AddOptions({{Identifier.services}});
{{Identifier.services}}.{{Identifier.AddSingleton}}<{{Identifier.IOptionsChangeTokenSource}}<{{Identifier.TOptions}}>>(new {{Identifier.ConfigurationChangeTokenSource}}<{{Identifier.TOptions}}>({{Identifier.name}}, {{Identifier.config}}));
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,8 @@ internal sealed class KnownTypeSymbols
public INamedTypeSymbol? ISet_Unbound { get; }
public INamedTypeSymbol? ISet { get; }
public INamedTypeSymbol? List { get; }
public INamedTypeSymbol Enum { get; }
public INamedTypeSymbol? ArgumentNullException { get; }

public KnownTypeSymbols(CSharpCompilation compilation)
{
Expand DownExpand Up@@ -113,6 +115,12 @@ public KnownTypeSymbols(CSharpCompilation compilation)
IReadOnlyList_Unbound = compilation.GetBestTypeByMetadataName(typeof(IReadOnlyList<>))?.ConstructUnboundGenericType();
IReadOnlySet_Unbound = compilation.GetBestTypeByMetadataName("System.Collections.Generic.IReadOnlySet`1")?.ConstructUnboundGenericType();
ISet_Unbound = ISet?.ConstructUnboundGenericType();

// needed to be able to know if a member exist inside the compilation unit
Enum = compilation.GetSpecialType(SpecialType.System_Enum);
ArgumentNullException = compilation.GetBestTypeByMetadataName(typeof(ArgumentNullException));

String = compilation.GetBestTypeByMetadataName(typeof(string));
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,5 +10,8 @@ public sealed record SourceGenerationSpec
public required InterceptorInfo InterceptorInfo { get; init; }
public required BindingHelperInfo BindingHelperInfo { get; init; }
public required ImmutableEquatableArray<TypeSpec> ConfigTypes { get; init; }
public required bool EmitEnumParseMethod { get; set; }
public required bool EmitGenericParseEnum { get; set; }
public required bool EmitThrowIfNullMethod { get; set; }
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Address feedback from config binding gen PR to improve enum parsing by pedrobsaila · Pull Request #89952 · dotnet/runtime · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,9 @@ private sealed partial class Emitter
private readonly InterceptorInfo _interceptorInfo;
private readonly BindingHelperInfo _bindingHelperInfo;
private readonly TypeIndex _typeIndex;
private readonly bool _emitEnumParseMethod;
private readonly bool _emitGenericParseEnum;
private readonly bool _emitThrowIfNullMethod;

private readonly SourceWriter _writer = new();

Expand All@@ -21,6 +24,9 @@ public Emitter(SourceGenerationSpec sourceGenSpec)
_interceptorInfo = sourceGenSpec.InterceptorInfo;
_bindingHelperInfo = sourceGenSpec.BindingHelperInfo;
_typeIndex = new TypeIndex(sourceGenSpec.ConfigTypes);
_emitEnumParseMethod = sourceGenSpec.EmitEnumParseMethod;
_emitGenericParseEnum = sourceGenSpec.EmitGenericParseEnum;
_emitThrowIfNullMethod = sourceGenSpec.EmitThrowIfNullMethod;
}

public void Emit(SourceProductionContext context)
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,8 @@ internal sealed partial class Parser(CompilationData compilationData)

private readonly InterceptorInfo.Builder _interceptorInfoBuilder = new();
private BindingHelperInfo.Builder? _helperInfoBuilder; // Init'ed with type index when registering interceptors, after creating type specs.
private bool _emitEnumParseMethod;
private bool _emitGenericParseEnum;

public List<DiagnosticInfo>? Diagnostics { get; private set; }

Expand All@@ -45,12 +47,16 @@ internal sealed partial class Parser(CompilationData compilationData)
ParseInvocations(invocations);
CreateTypeSpecs(cancellationToken);
RegisterInterceptors();
CheckIfToEmitParseEnumMethod();

return new SourceGenerationSpec
{
InterceptorInfo = _interceptorInfoBuilder.ToIncrementalValue(),
BindingHelperInfo = _helperInfoBuilder!.ToIncrementalValue(),
ConfigTypes = _createdTypeSpecs.Values.OrderBy(s => s.TypeRef.FullyQualifiedName).ToImmutableEquatableArray(),
EmitEnumParseMethod = _emitEnumParseMethod,
EmitGenericParseEnum = _emitGenericParseEnum,
EmitThrowIfNullMethod = IsThrowIfNullMethodToBeEmitted()
};
}

Expand DownExpand Up@@ -842,6 +848,45 @@ private void RecordDiagnostic(DiagnosticDescriptor descriptor, Location trimmedL
Diagnostics ??= new List<DiagnosticInfo>();
Diagnostics.Add(DiagnosticInfo.Create(descriptor, trimmedLocation, messageArgs));
}

private void CheckIfToEmitParseEnumMethod()
{
foreach (var typeSymbol in _createdTypeSpecs.Keys)
{
if (IsEnum(typeSymbol))
{
_emitEnumParseMethod = true;
_emitGenericParseEnum = _typeSymbols.Enum.GetMembers("Parse").Any(m => m is IMethodSymbol methodSymbol && methodSymbol.IsGenericMethod);
Comment thread
tarekgh marked this conversation as resolved.
return;
}
}
}

private bool IsThrowIfNullMethodToBeEmitted()
{
if (_typeSymbols.ArgumentNullException is not null)
{
var throwIfNullMethods = _typeSymbols.ArgumentNullException.GetMembers("ThrowIfNull");
Comment thread
tarekgh marked this conversation as resolved.

foreach (var throwIfNullMethod in throwIfNullMethods)
{
if (throwIfNullMethod is IMethodSymbol throwIfNullMethodSymbol && throwIfNullMethodSymbol.IsStatic && throwIfNullMethodSymbol.Parameters.Length == 2)
{
var parameters = throwIfNullMethodSymbol.Parameters;
var firstParam = parameters[0];
var secondParam = parameters[1];

if (firstParam.Name == "argument" && firstParam.Type.SpecialType == SpecialType.System_Object
&& secondParam.Name == "paramName" && secondParam.Type.Equals(_typeSymbols.String, SymbolEqualityComparer.Default))
{
return true;
}
}
}
}

return false;
}
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -144,8 +144,8 @@ void EmitMethods(ImmutableEquatableArray<TypedInterceptorInvocationInfo>? interc
Debug.Assert(!type.IsValueType);
string binderOptionsArg = configureOptions ? $"{Identifier.GetBinderOptions}({Identifier.configureOptions})" : $"{Identifier.binderOptions}: null";

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
_writer.WriteLine($$"""
var {{Identifier.typedObj}} = ({{type.DisplayString}}){{Identifier.instance}};
{{nameof(MethodsToGen_CoreBindingHelper.BindCore)}}({{configExpression}}, ref {{Identifier.typedObj}}, defaultValueIfNotFound: false, {{binderOptionsArg}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ private void EmitGetCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, Action<{Identifier.BinderOptions}>? {Identifier.configureOptions})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);

_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -178,7 +178,7 @@ private void EmitGetValueCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetValueCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, string {Identifier.key})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
_writer.WriteLine($@"{Identifier.IConfigurationSection} {Identifier.section} = {GetSectionFromConfigurationExpression(Identifier.key, addQuotes: false)};");
_writer.WriteLine();

Expand DownExpand Up@@ -224,7 +224,7 @@ private void EmitBindCoreMainMethod()

EmitBlankLineIfRequired();
EmitStartBlock($"public static void {nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}({Identifier.IConfiguration} {Identifier.configuration}, object {Identifier.instance}, Type {Identifier.type}, {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions})");
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
EmitIConfigurationHasValueOrChildrenCheck(voidReturn: true);
_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -475,24 +475,20 @@ private void EmitHelperMethods()
EmitGetBinderOptionsHelper();
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
if (_emitEnumParseMethod)
{
bool enumTypeExists = false;
_writer.WriteLine();
EmitEnumParseMethod();
_emitBlankLineBeforeNextStatement = true;
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
{
foreach (ParsableFromStringSpec type in stringParsableTypes)
{
EmitBlankLineIfRequired();

if (type.StringParsableTypeKind == StringParsableTypeKind.Enum)
{
if (!enumTypeExists)
{
EmitEnumParseMethod();
enumTypeExists = true;
}
}
else
if (type.StringParsableTypeKind is not StringParsableTypeKind.Enum)
{
EmitBlankLineIfRequired();
EmitPrimitiveParseMethod(type);
}
}
Expand DownExpand Up@@ -585,16 +581,13 @@ private void EmitEnumParseMethod()
{
string exceptionArg1 = string.Format(ExceptionMessages.FailedBinding, $"{{{Identifier.getPath}()}}", $"{{typeof(T)}}");

string parseEnumCall = _emitGenericParseEnum ? "Enum.Parse<T>(value, ignoreCase: true)" : "(T)Enum.Parse(typeof(T), value, ignoreCase: true)";
_writer.WriteLine($$"""
public static T ParseEnum<T>(string value, Func<string?> getPath) where T : struct
{
try
{
#if NETFRAMEWORK || NETSTANDARD2_0
return (T)Enum.Parse(typeof(T), value, ignoreCase: true);
#else
return Enum.Parse<T>(value, ignoreCase: true);
#endif
return {{parseEnumCall}};
}
catch ({{Identifier.Exception}} {{Identifier.exception}})
{
Expand All@@ -614,8 +607,6 @@ private void EmitPrimitiveParseMethod(ParsableFromStringSpec type)

switch (typeKind)
{
case StringParsableTypeKind.Enum:
return;
case StringParsableTypeKind.ByteArray:
{
parsedValueExpr = $"Convert.FromBase64String({Identifier.value})";
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -229,18 +229,30 @@ private void EmitBlankLineIfRequired()
_emitBlankLineBeforeNextStatement = true;
}

private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool voidReturn = false)
private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool useThrowIfNullMethod, bool voidReturn = false)
{
string returnExpr = voidReturn
? "return"
: $"throw new ArgumentNullException(nameof({paramName}))";

_writer.WriteLine($$"""
if (voidReturn)
{
_writer.WriteLine($$"""
if ({{paramName}} is null)
{
{{returnExpr}};
return;
}
""");
}
else
{
string throwIfNullExpr = useThrowIfNullMethod
? $"ArgumentNullException.ThrowIfNull({paramName});"
Comment thread
tarekgh marked this conversation as resolved.
: $$"""
if ({{paramName}} is null)
{
throw new ArgumentNullException(nameof({{paramName}}));
}
""";

_writer.WriteLine(throwIfNullExpr);
}

_writer.WriteLine();
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ private void EmitBindMethods_Extensions_OptionsBuilder()
paramList + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureBinder}",
documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);

_writer.WriteLine($$"""
{{Identifier.Configure}}<{{Identifier.TOptions}}>({{Identifier.optionsBuilder}}.{{Identifier.Services}}, {{Identifier.optionsBuilder}}.Name, {{Identifier.config}}, {{Identifier.configureBinder}});
Expand All@@ -65,11 +65,11 @@ private void EmitBindConfigurationMethod()

EmitMethodStartBlock(MethodsToGen.OptionsBuilderExt_BindConfiguration, "BindConfiguration", paramList, documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath, _emitThrowIfNullMethod);

EmitStartBlock($"{Identifier.optionsBuilder}.{Identifier.Configure}<{Identifier.IConfiguration}>(({Identifier.instance}, {Identifier.config}) =>");
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
{{Identifier.IConfiguration}} {{Identifier.section}} = string.Equals(string.Empty, {{Identifier.configSectionPath}}, StringComparison.OrdinalIgnoreCase) ? {{Identifier.config}} : {{Identifier.config}}.{{Identifier.GetSection}}({{Identifier.configSectionPath}});
{{nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}}({{Identifier.section}}, {{Identifier.instance}}, typeof({{Identifier.TOptions}}), {{Identifier.configureBinder}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ private void EmitConfigureMethods()
// Like the others, it is public API that could be called directly by users.
// So, it is always generated whenever a Configure overload is called.
EmitStartMethod(MethodsToGen.ServiceCollectionExt_Configure_T_name_BinderOptions, paramList: $"string? {Identifier.name}, " + configParam + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions}");
EmitCheckForNullArgument_WithBlankLine(Identifier.services);
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.services, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
OptionsServiceCollectionExtensions.AddOptions({{Identifier.services}});
{{Identifier.services}}.{{Identifier.AddSingleton}}<{{Identifier.IOptionsChangeTokenSource}}<{{Identifier.TOptions}}>>(new {{Identifier.ConfigurationChangeTokenSource}}<{{Identifier.TOptions}}>({{Identifier.name}}, {{Identifier.config}}));
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,8 @@ internal sealed class KnownTypeSymbols
public INamedTypeSymbol? ISet_Unbound { get; }
public INamedTypeSymbol? ISet { get; }
public INamedTypeSymbol? List { get; }
public INamedTypeSymbol Enum { get; }
public INamedTypeSymbol? ArgumentNullException { get; }

public KnownTypeSymbols(CSharpCompilation compilation)
{
Expand DownExpand Up@@ -113,6 +115,12 @@ public KnownTypeSymbols(CSharpCompilation compilation)
IReadOnlyList_Unbound = compilation.GetBestTypeByMetadataName(typeof(IReadOnlyList<>))?.ConstructUnboundGenericType();
IReadOnlySet_Unbound = compilation.GetBestTypeByMetadataName("System.Collections.Generic.IReadOnlySet`1")?.ConstructUnboundGenericType();
ISet_Unbound = ISet?.ConstructUnboundGenericType();

// needed to be able to know if a member exist inside the compilation unit
Enum = compilation.GetSpecialType(SpecialType.System_Enum);
ArgumentNullException = compilation.GetBestTypeByMetadataName(typeof(ArgumentNullException));

String = compilation.GetBestTypeByMetadataName(typeof(string));
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,5 +10,8 @@ public sealed record SourceGenerationSpec
public required InterceptorInfo InterceptorInfo { get; init; }
public required BindingHelperInfo BindingHelperInfo { get; init; }
public required ImmutableEquatableArray<TypeSpec> ConfigTypes { get; init; }
public required bool EmitEnumParseMethod { get; set; }
public required bool EmitGenericParseEnum { get; set; }
public required bool EmitThrowIfNullMethod { get; set; }
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Address feedback from config binding gen PR to improve enum parsing by pedrobsaila · Pull Request #89952 · dotnet/runtime · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,9 @@ private sealed partial class Emitter
private readonly InterceptorInfo _interceptorInfo;
private readonly BindingHelperInfo _bindingHelperInfo;
private readonly TypeIndex _typeIndex;
private readonly bool _emitEnumParseMethod;
private readonly bool _emitGenericParseEnum;
private readonly bool _emitThrowIfNullMethod;

private readonly SourceWriter _writer = new();

Expand All@@ -21,6 +24,9 @@ public Emitter(SourceGenerationSpec sourceGenSpec)
_interceptorInfo = sourceGenSpec.InterceptorInfo;
_bindingHelperInfo = sourceGenSpec.BindingHelperInfo;
_typeIndex = new TypeIndex(sourceGenSpec.ConfigTypes);
_emitEnumParseMethod = sourceGenSpec.EmitEnumParseMethod;
_emitGenericParseEnum = sourceGenSpec.EmitGenericParseEnum;
_emitThrowIfNullMethod = sourceGenSpec.EmitThrowIfNullMethod;
}

public void Emit(SourceProductionContext context)
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,8 @@ internal sealed partial class Parser(CompilationData compilationData)

private readonly InterceptorInfo.Builder _interceptorInfoBuilder = new();
private BindingHelperInfo.Builder? _helperInfoBuilder; // Init'ed with type index when registering interceptors, after creating type specs.
private bool _emitEnumParseMethod;
private bool _emitGenericParseEnum;

public List<DiagnosticInfo>? Diagnostics { get; private set; }

Expand All@@ -45,12 +47,16 @@ internal sealed partial class Parser(CompilationData compilationData)
ParseInvocations(invocations);
CreateTypeSpecs(cancellationToken);
RegisterInterceptors();
CheckIfToEmitParseEnumMethod();

return new SourceGenerationSpec
{
InterceptorInfo = _interceptorInfoBuilder.ToIncrementalValue(),
BindingHelperInfo = _helperInfoBuilder!.ToIncrementalValue(),
ConfigTypes = _createdTypeSpecs.Values.OrderBy(s => s.TypeRef.FullyQualifiedName).ToImmutableEquatableArray(),
EmitEnumParseMethod = _emitEnumParseMethod,
EmitGenericParseEnum = _emitGenericParseEnum,
EmitThrowIfNullMethod = IsThrowIfNullMethodToBeEmitted()
};
}

Expand DownExpand Up@@ -842,6 +848,45 @@ private void RecordDiagnostic(DiagnosticDescriptor descriptor, Location trimmedL
Diagnostics ??= new List<DiagnosticInfo>();
Diagnostics.Add(DiagnosticInfo.Create(descriptor, trimmedLocation, messageArgs));
}

private void CheckIfToEmitParseEnumMethod()
{
foreach (var typeSymbol in _createdTypeSpecs.Keys)
{
if (IsEnum(typeSymbol))
{
_emitEnumParseMethod = true;
_emitGenericParseEnum = _typeSymbols.Enum.GetMembers("Parse").Any(m => m is IMethodSymbol methodSymbol && methodSymbol.IsGenericMethod);
Comment thread
tarekgh marked this conversation as resolved.
return;
}
}
}

private bool IsThrowIfNullMethodToBeEmitted()
{
if (_typeSymbols.ArgumentNullException is not null)
{
var throwIfNullMethods = _typeSymbols.ArgumentNullException.GetMembers("ThrowIfNull");
Comment thread
tarekgh marked this conversation as resolved.

foreach (var throwIfNullMethod in throwIfNullMethods)
{
if (throwIfNullMethod is IMethodSymbol throwIfNullMethodSymbol && throwIfNullMethodSymbol.IsStatic && throwIfNullMethodSymbol.Parameters.Length == 2)
{
var parameters = throwIfNullMethodSymbol.Parameters;
var firstParam = parameters[0];
var secondParam = parameters[1];

if (firstParam.Name == "argument" && firstParam.Type.SpecialType == SpecialType.System_Object
&& secondParam.Name == "paramName" && secondParam.Type.Equals(_typeSymbols.String, SymbolEqualityComparer.Default))
{
return true;
}
}
}
}

return false;
}
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -144,8 +144,8 @@ void EmitMethods(ImmutableEquatableArray<TypedInterceptorInvocationInfo>? interc
Debug.Assert(!type.IsValueType);
string binderOptionsArg = configureOptions ? $"{Identifier.GetBinderOptions}({Identifier.configureOptions})" : $"{Identifier.binderOptions}: null";

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
_writer.WriteLine($$"""
var {{Identifier.typedObj}} = ({{type.DisplayString}}){{Identifier.instance}};
{{nameof(MethodsToGen_CoreBindingHelper.BindCore)}}({{configExpression}}, ref {{Identifier.typedObj}}, defaultValueIfNotFound: false, {{binderOptionsArg}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ private void EmitGetCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, Action<{Identifier.BinderOptions}>? {Identifier.configureOptions})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);

_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -178,7 +178,7 @@ private void EmitGetValueCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetValueCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, string {Identifier.key})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
_writer.WriteLine($@"{Identifier.IConfigurationSection} {Identifier.section} = {GetSectionFromConfigurationExpression(Identifier.key, addQuotes: false)};");
_writer.WriteLine();

Expand DownExpand Up@@ -224,7 +224,7 @@ private void EmitBindCoreMainMethod()

EmitBlankLineIfRequired();
EmitStartBlock($"public static void {nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}({Identifier.IConfiguration} {Identifier.configuration}, object {Identifier.instance}, Type {Identifier.type}, {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions})");
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
EmitIConfigurationHasValueOrChildrenCheck(voidReturn: true);
_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -475,24 +475,20 @@ private void EmitHelperMethods()
EmitGetBinderOptionsHelper();
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
if (_emitEnumParseMethod)
{
bool enumTypeExists = false;
_writer.WriteLine();
EmitEnumParseMethod();
_emitBlankLineBeforeNextStatement = true;
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
{
foreach (ParsableFromStringSpec type in stringParsableTypes)
{
EmitBlankLineIfRequired();

if (type.StringParsableTypeKind == StringParsableTypeKind.Enum)
{
if (!enumTypeExists)
{
EmitEnumParseMethod();
enumTypeExists = true;
}
}
else
if (type.StringParsableTypeKind is not StringParsableTypeKind.Enum)
{
EmitBlankLineIfRequired();
EmitPrimitiveParseMethod(type);
}
}
Expand DownExpand Up@@ -585,16 +581,13 @@ private void EmitEnumParseMethod()
{
string exceptionArg1 = string.Format(ExceptionMessages.FailedBinding, $"{{{Identifier.getPath}()}}", $"{{typeof(T)}}");

string parseEnumCall = _emitGenericParseEnum ? "Enum.Parse<T>(value, ignoreCase: true)" : "(T)Enum.Parse(typeof(T), value, ignoreCase: true)";
_writer.WriteLine($$"""
public static T ParseEnum<T>(string value, Func<string?> getPath) where T : struct
{
try
{
#if NETFRAMEWORK || NETSTANDARD2_0
return (T)Enum.Parse(typeof(T), value, ignoreCase: true);
#else
return Enum.Parse<T>(value, ignoreCase: true);
#endif
return {{parseEnumCall}};
}
catch ({{Identifier.Exception}} {{Identifier.exception}})
{
Expand All@@ -614,8 +607,6 @@ private void EmitPrimitiveParseMethod(ParsableFromStringSpec type)

switch (typeKind)
{
case StringParsableTypeKind.Enum:
return;
case StringParsableTypeKind.ByteArray:
{
parsedValueExpr = $"Convert.FromBase64String({Identifier.value})";
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -229,18 +229,30 @@ private void EmitBlankLineIfRequired()
_emitBlankLineBeforeNextStatement = true;
}

private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool voidReturn = false)
private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool useThrowIfNullMethod, bool voidReturn = false)
{
string returnExpr = voidReturn
? "return"
: $"throw new ArgumentNullException(nameof({paramName}))";

_writer.WriteLine($$"""
if (voidReturn)
{
_writer.WriteLine($$"""
if ({{paramName}} is null)
{
{{returnExpr}};
return;
}
""");
}
else
{
string throwIfNullExpr = useThrowIfNullMethod
? $"ArgumentNullException.ThrowIfNull({paramName});"
Comment thread
tarekgh marked this conversation as resolved.
: $$"""
if ({{paramName}} is null)
{
throw new ArgumentNullException(nameof({{paramName}}));
}
""";

_writer.WriteLine(throwIfNullExpr);
}

_writer.WriteLine();
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ private void EmitBindMethods_Extensions_OptionsBuilder()
paramList + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureBinder}",
documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);

_writer.WriteLine($$"""
{{Identifier.Configure}}<{{Identifier.TOptions}}>({{Identifier.optionsBuilder}}.{{Identifier.Services}}, {{Identifier.optionsBuilder}}.Name, {{Identifier.config}}, {{Identifier.configureBinder}});
Expand All@@ -65,11 +65,11 @@ private void EmitBindConfigurationMethod()

EmitMethodStartBlock(MethodsToGen.OptionsBuilderExt_BindConfiguration, "BindConfiguration", paramList, documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath, _emitThrowIfNullMethod);

EmitStartBlock($"{Identifier.optionsBuilder}.{Identifier.Configure}<{Identifier.IConfiguration}>(({Identifier.instance}, {Identifier.config}) =>");
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
{{Identifier.IConfiguration}} {{Identifier.section}} = string.Equals(string.Empty, {{Identifier.configSectionPath}}, StringComparison.OrdinalIgnoreCase) ? {{Identifier.config}} : {{Identifier.config}}.{{Identifier.GetSection}}({{Identifier.configSectionPath}});
{{nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}}({{Identifier.section}}, {{Identifier.instance}}, typeof({{Identifier.TOptions}}), {{Identifier.configureBinder}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ private void EmitConfigureMethods()
// Like the others, it is public API that could be called directly by users.
// So, it is always generated whenever a Configure overload is called.
EmitStartMethod(MethodsToGen.ServiceCollectionExt_Configure_T_name_BinderOptions, paramList: $"string? {Identifier.name}, " + configParam + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions}");
EmitCheckForNullArgument_WithBlankLine(Identifier.services);
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.services, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
OptionsServiceCollectionExtensions.AddOptions({{Identifier.services}});
{{Identifier.services}}.{{Identifier.AddSingleton}}<{{Identifier.IOptionsChangeTokenSource}}<{{Identifier.TOptions}}>>(new {{Identifier.ConfigurationChangeTokenSource}}<{{Identifier.TOptions}}>({{Identifier.name}}, {{Identifier.config}}));
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,8 @@ internal sealed class KnownTypeSymbols
public INamedTypeSymbol? ISet_Unbound { get; }
public INamedTypeSymbol? ISet { get; }
public INamedTypeSymbol? List { get; }
public INamedTypeSymbol Enum { get; }
public INamedTypeSymbol? ArgumentNullException { get; }

public KnownTypeSymbols(CSharpCompilation compilation)
{
Expand DownExpand Up@@ -113,6 +115,12 @@ public KnownTypeSymbols(CSharpCompilation compilation)
IReadOnlyList_Unbound = compilation.GetBestTypeByMetadataName(typeof(IReadOnlyList<>))?.ConstructUnboundGenericType();
IReadOnlySet_Unbound = compilation.GetBestTypeByMetadataName("System.Collections.Generic.IReadOnlySet`1")?.ConstructUnboundGenericType();
ISet_Unbound = ISet?.ConstructUnboundGenericType();

// needed to be able to know if a member exist inside the compilation unit
Enum = compilation.GetSpecialType(SpecialType.System_Enum);
ArgumentNullException = compilation.GetBestTypeByMetadataName(typeof(ArgumentNullException));

String = compilation.GetBestTypeByMetadataName(typeof(string));
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,5 +10,8 @@ public sealed record SourceGenerationSpec
public required InterceptorInfo InterceptorInfo { get; init; }
public required BindingHelperInfo BindingHelperInfo { get; init; }
public required ImmutableEquatableArray<TypeSpec> ConfigTypes { get; init; }
public required bool EmitEnumParseMethod { get; set; }
public required bool EmitGenericParseEnum { get; set; }
public required bool EmitThrowIfNullMethod { get; set; }
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Address feedback from config binding gen PR to improve enum parsing by pedrobsaila · Pull Request #89952 · dotnet/runtime · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,9 @@ private sealed partial class Emitter
private readonly InterceptorInfo _interceptorInfo;
private readonly BindingHelperInfo _bindingHelperInfo;
private readonly TypeIndex _typeIndex;
private readonly bool _emitEnumParseMethod;
private readonly bool _emitGenericParseEnum;
private readonly bool _emitThrowIfNullMethod;

private readonly SourceWriter _writer = new();

Expand All@@ -21,6 +24,9 @@ public Emitter(SourceGenerationSpec sourceGenSpec)
_interceptorInfo = sourceGenSpec.InterceptorInfo;
_bindingHelperInfo = sourceGenSpec.BindingHelperInfo;
_typeIndex = new TypeIndex(sourceGenSpec.ConfigTypes);
_emitEnumParseMethod = sourceGenSpec.EmitEnumParseMethod;
_emitGenericParseEnum = sourceGenSpec.EmitGenericParseEnum;
_emitThrowIfNullMethod = sourceGenSpec.EmitThrowIfNullMethod;
}

public void Emit(SourceProductionContext context)
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,8 @@ internal sealed partial class Parser(CompilationData compilationData)

private readonly InterceptorInfo.Builder _interceptorInfoBuilder = new();
private BindingHelperInfo.Builder? _helperInfoBuilder; // Init'ed with type index when registering interceptors, after creating type specs.
private bool _emitEnumParseMethod;
private bool _emitGenericParseEnum;

public List<DiagnosticInfo>? Diagnostics { get; private set; }

Expand All@@ -45,12 +47,16 @@ internal sealed partial class Parser(CompilationData compilationData)
ParseInvocations(invocations);
CreateTypeSpecs(cancellationToken);
RegisterInterceptors();
CheckIfToEmitParseEnumMethod();

return new SourceGenerationSpec
{
InterceptorInfo = _interceptorInfoBuilder.ToIncrementalValue(),
BindingHelperInfo = _helperInfoBuilder!.ToIncrementalValue(),
ConfigTypes = _createdTypeSpecs.Values.OrderBy(s => s.TypeRef.FullyQualifiedName).ToImmutableEquatableArray(),
EmitEnumParseMethod = _emitEnumParseMethod,
EmitGenericParseEnum = _emitGenericParseEnum,
EmitThrowIfNullMethod = IsThrowIfNullMethodToBeEmitted()
};
}

Expand DownExpand Up@@ -842,6 +848,45 @@ private void RecordDiagnostic(DiagnosticDescriptor descriptor, Location trimmedL
Diagnostics ??= new List<DiagnosticInfo>();
Diagnostics.Add(DiagnosticInfo.Create(descriptor, trimmedLocation, messageArgs));
}

private void CheckIfToEmitParseEnumMethod()
{
foreach (var typeSymbol in _createdTypeSpecs.Keys)
{
if (IsEnum(typeSymbol))
{
_emitEnumParseMethod = true;
_emitGenericParseEnum = _typeSymbols.Enum.GetMembers("Parse").Any(m => m is IMethodSymbol methodSymbol && methodSymbol.IsGenericMethod);
Comment thread
tarekgh marked this conversation as resolved.
return;
}
}
}

private bool IsThrowIfNullMethodToBeEmitted()
{
if (_typeSymbols.ArgumentNullException is not null)
{
var throwIfNullMethods = _typeSymbols.ArgumentNullException.GetMembers("ThrowIfNull");
Comment thread
tarekgh marked this conversation as resolved.

foreach (var throwIfNullMethod in throwIfNullMethods)
{
if (throwIfNullMethod is IMethodSymbol throwIfNullMethodSymbol && throwIfNullMethodSymbol.IsStatic && throwIfNullMethodSymbol.Parameters.Length == 2)
{
var parameters = throwIfNullMethodSymbol.Parameters;
var firstParam = parameters[0];
var secondParam = parameters[1];

if (firstParam.Name == "argument" && firstParam.Type.SpecialType == SpecialType.System_Object
&& secondParam.Name == "paramName" && secondParam.Type.Equals(_typeSymbols.String, SymbolEqualityComparer.Default))
{
return true;
}
}
}
}

return false;
}
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -144,8 +144,8 @@ void EmitMethods(ImmutableEquatableArray<TypedInterceptorInvocationInfo>? interc
Debug.Assert(!type.IsValueType);
string binderOptionsArg = configureOptions ? $"{Identifier.GetBinderOptions}({Identifier.configureOptions})" : $"{Identifier.binderOptions}: null";

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
_writer.WriteLine($$"""
var {{Identifier.typedObj}} = ({{type.DisplayString}}){{Identifier.instance}};
{{nameof(MethodsToGen_CoreBindingHelper.BindCore)}}({{configExpression}}, ref {{Identifier.typedObj}}, defaultValueIfNotFound: false, {{binderOptionsArg}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ private void EmitGetCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, Action<{Identifier.BinderOptions}>? {Identifier.configureOptions})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);

_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -178,7 +178,7 @@ private void EmitGetValueCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetValueCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, string {Identifier.key})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
_writer.WriteLine($@"{Identifier.IConfigurationSection} {Identifier.section} = {GetSectionFromConfigurationExpression(Identifier.key, addQuotes: false)};");
_writer.WriteLine();

Expand DownExpand Up@@ -224,7 +224,7 @@ private void EmitBindCoreMainMethod()

EmitBlankLineIfRequired();
EmitStartBlock($"public static void {nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}({Identifier.IConfiguration} {Identifier.configuration}, object {Identifier.instance}, Type {Identifier.type}, {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions})");
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
EmitIConfigurationHasValueOrChildrenCheck(voidReturn: true);
_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -475,24 +475,20 @@ private void EmitHelperMethods()
EmitGetBinderOptionsHelper();
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
if (_emitEnumParseMethod)
{
bool enumTypeExists = false;
_writer.WriteLine();
EmitEnumParseMethod();
_emitBlankLineBeforeNextStatement = true;
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
{
foreach (ParsableFromStringSpec type in stringParsableTypes)
{
EmitBlankLineIfRequired();

if (type.StringParsableTypeKind == StringParsableTypeKind.Enum)
{
if (!enumTypeExists)
{
EmitEnumParseMethod();
enumTypeExists = true;
}
}
else
if (type.StringParsableTypeKind is not StringParsableTypeKind.Enum)
{
EmitBlankLineIfRequired();
EmitPrimitiveParseMethod(type);
}
}
Expand DownExpand Up@@ -585,16 +581,13 @@ private void EmitEnumParseMethod()
{
string exceptionArg1 = string.Format(ExceptionMessages.FailedBinding, $"{{{Identifier.getPath}()}}", $"{{typeof(T)}}");

string parseEnumCall = _emitGenericParseEnum ? "Enum.Parse<T>(value, ignoreCase: true)" : "(T)Enum.Parse(typeof(T), value, ignoreCase: true)";
_writer.WriteLine($$"""
public static T ParseEnum<T>(string value, Func<string?> getPath) where T : struct
{
try
{
#if NETFRAMEWORK || NETSTANDARD2_0
return (T)Enum.Parse(typeof(T), value, ignoreCase: true);
#else
return Enum.Parse<T>(value, ignoreCase: true);
#endif
return {{parseEnumCall}};
}
catch ({{Identifier.Exception}} {{Identifier.exception}})
{
Expand All@@ -614,8 +607,6 @@ private void EmitPrimitiveParseMethod(ParsableFromStringSpec type)

switch (typeKind)
{
case StringParsableTypeKind.Enum:
return;
case StringParsableTypeKind.ByteArray:
{
parsedValueExpr = $"Convert.FromBase64String({Identifier.value})";
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -229,18 +229,30 @@ private void EmitBlankLineIfRequired()
_emitBlankLineBeforeNextStatement = true;
}

private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool voidReturn = false)
private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool useThrowIfNullMethod, bool voidReturn = false)
{
string returnExpr = voidReturn
? "return"
: $"throw new ArgumentNullException(nameof({paramName}))";

_writer.WriteLine($$"""
if (voidReturn)
{
_writer.WriteLine($$"""
if ({{paramName}} is null)
{
{{returnExpr}};
return;
}
""");
}
else
{
string throwIfNullExpr = useThrowIfNullMethod
? $"ArgumentNullException.ThrowIfNull({paramName});"
Comment thread
tarekgh marked this conversation as resolved.
: $$"""
if ({{paramName}} is null)
{
throw new ArgumentNullException(nameof({{paramName}}));
}
""";

_writer.WriteLine(throwIfNullExpr);
}

_writer.WriteLine();
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ private void EmitBindMethods_Extensions_OptionsBuilder()
paramList + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureBinder}",
documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);

_writer.WriteLine($$"""
{{Identifier.Configure}}<{{Identifier.TOptions}}>({{Identifier.optionsBuilder}}.{{Identifier.Services}}, {{Identifier.optionsBuilder}}.Name, {{Identifier.config}}, {{Identifier.configureBinder}});
Expand All@@ -65,11 +65,11 @@ private void EmitBindConfigurationMethod()

EmitMethodStartBlock(MethodsToGen.OptionsBuilderExt_BindConfiguration, "BindConfiguration", paramList, documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath, _emitThrowIfNullMethod);

EmitStartBlock($"{Identifier.optionsBuilder}.{Identifier.Configure}<{Identifier.IConfiguration}>(({Identifier.instance}, {Identifier.config}) =>");
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
{{Identifier.IConfiguration}} {{Identifier.section}} = string.Equals(string.Empty, {{Identifier.configSectionPath}}, StringComparison.OrdinalIgnoreCase) ? {{Identifier.config}} : {{Identifier.config}}.{{Identifier.GetSection}}({{Identifier.configSectionPath}});
{{nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}}({{Identifier.section}}, {{Identifier.instance}}, typeof({{Identifier.TOptions}}), {{Identifier.configureBinder}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ private void EmitConfigureMethods()
// Like the others, it is public API that could be called directly by users.
// So, it is always generated whenever a Configure overload is called.
EmitStartMethod(MethodsToGen.ServiceCollectionExt_Configure_T_name_BinderOptions, paramList: $"string? {Identifier.name}, " + configParam + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions}");
EmitCheckForNullArgument_WithBlankLine(Identifier.services);
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.services, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
OptionsServiceCollectionExtensions.AddOptions({{Identifier.services}});
{{Identifier.services}}.{{Identifier.AddSingleton}}<{{Identifier.IOptionsChangeTokenSource}}<{{Identifier.TOptions}}>>(new {{Identifier.ConfigurationChangeTokenSource}}<{{Identifier.TOptions}}>({{Identifier.name}}, {{Identifier.config}}));
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,8 @@ internal sealed class KnownTypeSymbols
public INamedTypeSymbol? ISet_Unbound { get; }
public INamedTypeSymbol? ISet { get; }
public INamedTypeSymbol? List { get; }
public INamedTypeSymbol Enum { get; }
public INamedTypeSymbol? ArgumentNullException { get; }

public KnownTypeSymbols(CSharpCompilation compilation)
{
Expand DownExpand Up@@ -113,6 +115,12 @@ public KnownTypeSymbols(CSharpCompilation compilation)
IReadOnlyList_Unbound = compilation.GetBestTypeByMetadataName(typeof(IReadOnlyList<>))?.ConstructUnboundGenericType();
IReadOnlySet_Unbound = compilation.GetBestTypeByMetadataName("System.Collections.Generic.IReadOnlySet`1")?.ConstructUnboundGenericType();
ISet_Unbound = ISet?.ConstructUnboundGenericType();

// needed to be able to know if a member exist inside the compilation unit
Enum = compilation.GetSpecialType(SpecialType.System_Enum);
ArgumentNullException = compilation.GetBestTypeByMetadataName(typeof(ArgumentNullException));

String = compilation.GetBestTypeByMetadataName(typeof(string));
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,5 +10,8 @@ public sealed record SourceGenerationSpec
public required InterceptorInfo InterceptorInfo { get; init; }
public required BindingHelperInfo BindingHelperInfo { get; init; }
public required ImmutableEquatableArray<TypeSpec> ConfigTypes { get; init; }
public required bool EmitEnumParseMethod { get; set; }
public required bool EmitGenericParseEnum { get; set; }
public required bool EmitThrowIfNullMethod { get; set; }
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Address feedback from config binding gen PR to improve enum parsing by pedrobsaila · Pull Request #89952 · dotnet/runtime · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,9 @@ private sealed partial class Emitter
private readonly InterceptorInfo _interceptorInfo;
private readonly BindingHelperInfo _bindingHelperInfo;
private readonly TypeIndex _typeIndex;
private readonly bool _emitEnumParseMethod;
private readonly bool _emitGenericParseEnum;
private readonly bool _emitThrowIfNullMethod;

private readonly SourceWriter _writer = new();

Expand All@@ -21,6 +24,9 @@ public Emitter(SourceGenerationSpec sourceGenSpec)
_interceptorInfo = sourceGenSpec.InterceptorInfo;
_bindingHelperInfo = sourceGenSpec.BindingHelperInfo;
_typeIndex = new TypeIndex(sourceGenSpec.ConfigTypes);
_emitEnumParseMethod = sourceGenSpec.EmitEnumParseMethod;
_emitGenericParseEnum = sourceGenSpec.EmitGenericParseEnum;
_emitThrowIfNullMethod = sourceGenSpec.EmitThrowIfNullMethod;
}

public void Emit(SourceProductionContext context)
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,8 @@ internal sealed partial class Parser(CompilationData compilationData)

private readonly InterceptorInfo.Builder _interceptorInfoBuilder = new();
private BindingHelperInfo.Builder? _helperInfoBuilder; // Init'ed with type index when registering interceptors, after creating type specs.
private bool _emitEnumParseMethod;
private bool _emitGenericParseEnum;

public List<DiagnosticInfo>? Diagnostics { get; private set; }

Expand All@@ -45,12 +47,16 @@ internal sealed partial class Parser(CompilationData compilationData)
ParseInvocations(invocations);
CreateTypeSpecs(cancellationToken);
RegisterInterceptors();
CheckIfToEmitParseEnumMethod();

return new SourceGenerationSpec
{
InterceptorInfo = _interceptorInfoBuilder.ToIncrementalValue(),
BindingHelperInfo = _helperInfoBuilder!.ToIncrementalValue(),
ConfigTypes = _createdTypeSpecs.Values.OrderBy(s => s.TypeRef.FullyQualifiedName).ToImmutableEquatableArray(),
EmitEnumParseMethod = _emitEnumParseMethod,
EmitGenericParseEnum = _emitGenericParseEnum,
EmitThrowIfNullMethod = IsThrowIfNullMethodToBeEmitted()
};
}

Expand DownExpand Up@@ -842,6 +848,45 @@ private void RecordDiagnostic(DiagnosticDescriptor descriptor, Location trimmedL
Diagnostics ??= new List<DiagnosticInfo>();
Diagnostics.Add(DiagnosticInfo.Create(descriptor, trimmedLocation, messageArgs));
}

private void CheckIfToEmitParseEnumMethod()
{
foreach (var typeSymbol in _createdTypeSpecs.Keys)
{
if (IsEnum(typeSymbol))
{
_emitEnumParseMethod = true;
_emitGenericParseEnum = _typeSymbols.Enum.GetMembers("Parse").Any(m => m is IMethodSymbol methodSymbol && methodSymbol.IsGenericMethod);
Comment thread
tarekgh marked this conversation as resolved.
return;
}
}
}

private bool IsThrowIfNullMethodToBeEmitted()
{
if (_typeSymbols.ArgumentNullException is not null)
{
var throwIfNullMethods = _typeSymbols.ArgumentNullException.GetMembers("ThrowIfNull");
Comment thread
tarekgh marked this conversation as resolved.

foreach (var throwIfNullMethod in throwIfNullMethods)
{
if (throwIfNullMethod is IMethodSymbol throwIfNullMethodSymbol && throwIfNullMethodSymbol.IsStatic && throwIfNullMethodSymbol.Parameters.Length == 2)
{
var parameters = throwIfNullMethodSymbol.Parameters;
var firstParam = parameters[0];
var secondParam = parameters[1];

if (firstParam.Name == "argument" && firstParam.Type.SpecialType == SpecialType.System_Object
&& secondParam.Name == "paramName" && secondParam.Type.Equals(_typeSymbols.String, SymbolEqualityComparer.Default))
{
return true;
}
}
}
}

return false;
}
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -144,8 +144,8 @@ void EmitMethods(ImmutableEquatableArray<TypedInterceptorInvocationInfo>? interc
Debug.Assert(!type.IsValueType);
string binderOptionsArg = configureOptions ? $"{Identifier.GetBinderOptions}({Identifier.configureOptions})" : $"{Identifier.binderOptions}: null";

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
_writer.WriteLine($$"""
var {{Identifier.typedObj}} = ({{type.DisplayString}}){{Identifier.instance}};
{{nameof(MethodsToGen_CoreBindingHelper.BindCore)}}({{configExpression}}, ref {{Identifier.typedObj}}, defaultValueIfNotFound: false, {{binderOptionsArg}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ private void EmitGetCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, Action<{Identifier.BinderOptions}>? {Identifier.configureOptions})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);

_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -178,7 +178,7 @@ private void EmitGetValueCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetValueCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, string {Identifier.key})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
_writer.WriteLine($@"{Identifier.IConfigurationSection} {Identifier.section} = {GetSectionFromConfigurationExpression(Identifier.key, addQuotes: false)};");
_writer.WriteLine();

Expand DownExpand Up@@ -224,7 +224,7 @@ private void EmitBindCoreMainMethod()

EmitBlankLineIfRequired();
EmitStartBlock($"public static void {nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}({Identifier.IConfiguration} {Identifier.configuration}, object {Identifier.instance}, Type {Identifier.type}, {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions})");
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
EmitIConfigurationHasValueOrChildrenCheck(voidReturn: true);
_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -475,24 +475,20 @@ private void EmitHelperMethods()
EmitGetBinderOptionsHelper();
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
if (_emitEnumParseMethod)
{
bool enumTypeExists = false;
_writer.WriteLine();
EmitEnumParseMethod();
_emitBlankLineBeforeNextStatement = true;
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
{
foreach (ParsableFromStringSpec type in stringParsableTypes)
{
EmitBlankLineIfRequired();

if (type.StringParsableTypeKind == StringParsableTypeKind.Enum)
{
if (!enumTypeExists)
{
EmitEnumParseMethod();
enumTypeExists = true;
}
}
else
if (type.StringParsableTypeKind is not StringParsableTypeKind.Enum)
{
EmitBlankLineIfRequired();
EmitPrimitiveParseMethod(type);
}
}
Expand DownExpand Up@@ -585,16 +581,13 @@ private void EmitEnumParseMethod()
{
string exceptionArg1 = string.Format(ExceptionMessages.FailedBinding, $"{{{Identifier.getPath}()}}", $"{{typeof(T)}}");

string parseEnumCall = _emitGenericParseEnum ? "Enum.Parse<T>(value, ignoreCase: true)" : "(T)Enum.Parse(typeof(T), value, ignoreCase: true)";
_writer.WriteLine($$"""
public static T ParseEnum<T>(string value, Func<string?> getPath) where T : struct
{
try
{
#if NETFRAMEWORK || NETSTANDARD2_0
return (T)Enum.Parse(typeof(T), value, ignoreCase: true);
#else
return Enum.Parse<T>(value, ignoreCase: true);
#endif
return {{parseEnumCall}};
}
catch ({{Identifier.Exception}} {{Identifier.exception}})
{
Expand All@@ -614,8 +607,6 @@ private void EmitPrimitiveParseMethod(ParsableFromStringSpec type)

switch (typeKind)
{
case StringParsableTypeKind.Enum:
return;
case StringParsableTypeKind.ByteArray:
{
parsedValueExpr = $"Convert.FromBase64String({Identifier.value})";
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -229,18 +229,30 @@ private void EmitBlankLineIfRequired()
_emitBlankLineBeforeNextStatement = true;
}

private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool voidReturn = false)
private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool useThrowIfNullMethod, bool voidReturn = false)
{
string returnExpr = voidReturn
? "return"
: $"throw new ArgumentNullException(nameof({paramName}))";

_writer.WriteLine($$"""
if (voidReturn)
{
_writer.WriteLine($$"""
if ({{paramName}} is null)
{
{{returnExpr}};
return;
}
""");
}
else
{
string throwIfNullExpr = useThrowIfNullMethod
? $"ArgumentNullException.ThrowIfNull({paramName});"
Comment thread
tarekgh marked this conversation as resolved.
: $$"""
if ({{paramName}} is null)
{
throw new ArgumentNullException(nameof({{paramName}}));
}
""";

_writer.WriteLine(throwIfNullExpr);
}

_writer.WriteLine();
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ private void EmitBindMethods_Extensions_OptionsBuilder()
paramList + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureBinder}",
documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);

_writer.WriteLine($$"""
{{Identifier.Configure}}<{{Identifier.TOptions}}>({{Identifier.optionsBuilder}}.{{Identifier.Services}}, {{Identifier.optionsBuilder}}.Name, {{Identifier.config}}, {{Identifier.configureBinder}});
Expand All@@ -65,11 +65,11 @@ private void EmitBindConfigurationMethod()

EmitMethodStartBlock(MethodsToGen.OptionsBuilderExt_BindConfiguration, "BindConfiguration", paramList, documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath, _emitThrowIfNullMethod);

EmitStartBlock($"{Identifier.optionsBuilder}.{Identifier.Configure}<{Identifier.IConfiguration}>(({Identifier.instance}, {Identifier.config}) =>");
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
{{Identifier.IConfiguration}} {{Identifier.section}} = string.Equals(string.Empty, {{Identifier.configSectionPath}}, StringComparison.OrdinalIgnoreCase) ? {{Identifier.config}} : {{Identifier.config}}.{{Identifier.GetSection}}({{Identifier.configSectionPath}});
{{nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}}({{Identifier.section}}, {{Identifier.instance}}, typeof({{Identifier.TOptions}}), {{Identifier.configureBinder}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ private void EmitConfigureMethods()
// Like the others, it is public API that could be called directly by users.
// So, it is always generated whenever a Configure overload is called.
EmitStartMethod(MethodsToGen.ServiceCollectionExt_Configure_T_name_BinderOptions, paramList: $"string? {Identifier.name}, " + configParam + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions}");
EmitCheckForNullArgument_WithBlankLine(Identifier.services);
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.services, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
OptionsServiceCollectionExtensions.AddOptions({{Identifier.services}});
{{Identifier.services}}.{{Identifier.AddSingleton}}<{{Identifier.IOptionsChangeTokenSource}}<{{Identifier.TOptions}}>>(new {{Identifier.ConfigurationChangeTokenSource}}<{{Identifier.TOptions}}>({{Identifier.name}}, {{Identifier.config}}));
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,8 @@ internal sealed class KnownTypeSymbols
public INamedTypeSymbol? ISet_Unbound { get; }
public INamedTypeSymbol? ISet { get; }
public INamedTypeSymbol? List { get; }
public INamedTypeSymbol Enum { get; }
public INamedTypeSymbol? ArgumentNullException { get; }

public KnownTypeSymbols(CSharpCompilation compilation)
{
Expand DownExpand Up@@ -113,6 +115,12 @@ public KnownTypeSymbols(CSharpCompilation compilation)
IReadOnlyList_Unbound = compilation.GetBestTypeByMetadataName(typeof(IReadOnlyList<>))?.ConstructUnboundGenericType();
IReadOnlySet_Unbound = compilation.GetBestTypeByMetadataName("System.Collections.Generic.IReadOnlySet`1")?.ConstructUnboundGenericType();
ISet_Unbound = ISet?.ConstructUnboundGenericType();

// needed to be able to know if a member exist inside the compilation unit
Enum = compilation.GetSpecialType(SpecialType.System_Enum);
ArgumentNullException = compilation.GetBestTypeByMetadataName(typeof(ArgumentNullException));

String = compilation.GetBestTypeByMetadataName(typeof(string));
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,5 +10,8 @@ public sealed record SourceGenerationSpec
public required InterceptorInfo InterceptorInfo { get; init; }
public required BindingHelperInfo BindingHelperInfo { get; init; }
public required ImmutableEquatableArray<TypeSpec> ConfigTypes { get; init; }
public required bool EmitEnumParseMethod { get; set; }
public required bool EmitGenericParseEnum { get; set; }
public required bool EmitThrowIfNullMethod { get; set; }
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Address feedback from config binding gen PR to improve enum parsing by pedrobsaila · Pull Request #89952 · dotnet/runtime · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,9 @@ private sealed partial class Emitter
private readonly InterceptorInfo _interceptorInfo;
private readonly BindingHelperInfo _bindingHelperInfo;
private readonly TypeIndex _typeIndex;
private readonly bool _emitEnumParseMethod;
private readonly bool _emitGenericParseEnum;
private readonly bool _emitThrowIfNullMethod;

private readonly SourceWriter _writer = new();

Expand All@@ -21,6 +24,9 @@ public Emitter(SourceGenerationSpec sourceGenSpec)
_interceptorInfo = sourceGenSpec.InterceptorInfo;
_bindingHelperInfo = sourceGenSpec.BindingHelperInfo;
_typeIndex = new TypeIndex(sourceGenSpec.ConfigTypes);
_emitEnumParseMethod = sourceGenSpec.EmitEnumParseMethod;
_emitGenericParseEnum = sourceGenSpec.EmitGenericParseEnum;
_emitThrowIfNullMethod = sourceGenSpec.EmitThrowIfNullMethod;
}

public void Emit(SourceProductionContext context)
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,8 @@ internal sealed partial class Parser(CompilationData compilationData)

private readonly InterceptorInfo.Builder _interceptorInfoBuilder = new();
private BindingHelperInfo.Builder? _helperInfoBuilder; // Init'ed with type index when registering interceptors, after creating type specs.
private bool _emitEnumParseMethod;
private bool _emitGenericParseEnum;

public List<DiagnosticInfo>? Diagnostics { get; private set; }

Expand All@@ -45,12 +47,16 @@ internal sealed partial class Parser(CompilationData compilationData)
ParseInvocations(invocations);
CreateTypeSpecs(cancellationToken);
RegisterInterceptors();
CheckIfToEmitParseEnumMethod();

return new SourceGenerationSpec
{
InterceptorInfo = _interceptorInfoBuilder.ToIncrementalValue(),
BindingHelperInfo = _helperInfoBuilder!.ToIncrementalValue(),
ConfigTypes = _createdTypeSpecs.Values.OrderBy(s => s.TypeRef.FullyQualifiedName).ToImmutableEquatableArray(),
EmitEnumParseMethod = _emitEnumParseMethod,
EmitGenericParseEnum = _emitGenericParseEnum,
EmitThrowIfNullMethod = IsThrowIfNullMethodToBeEmitted()
};
}

Expand DownExpand Up@@ -842,6 +848,45 @@ private void RecordDiagnostic(DiagnosticDescriptor descriptor, Location trimmedL
Diagnostics ??= new List<DiagnosticInfo>();
Diagnostics.Add(DiagnosticInfo.Create(descriptor, trimmedLocation, messageArgs));
}

private void CheckIfToEmitParseEnumMethod()
{
foreach (var typeSymbol in _createdTypeSpecs.Keys)
{
if (IsEnum(typeSymbol))
{
_emitEnumParseMethod = true;
_emitGenericParseEnum = _typeSymbols.Enum.GetMembers("Parse").Any(m => m is IMethodSymbol methodSymbol && methodSymbol.IsGenericMethod);
Comment thread
tarekgh marked this conversation as resolved.
return;
}
}
}

private bool IsThrowIfNullMethodToBeEmitted()
{
if (_typeSymbols.ArgumentNullException is not null)
{
var throwIfNullMethods = _typeSymbols.ArgumentNullException.GetMembers("ThrowIfNull");
Comment thread
tarekgh marked this conversation as resolved.

foreach (var throwIfNullMethod in throwIfNullMethods)
{
if (throwIfNullMethod is IMethodSymbol throwIfNullMethodSymbol && throwIfNullMethodSymbol.IsStatic && throwIfNullMethodSymbol.Parameters.Length == 2)
{
var parameters = throwIfNullMethodSymbol.Parameters;
var firstParam = parameters[0];
var secondParam = parameters[1];

if (firstParam.Name == "argument" && firstParam.Type.SpecialType == SpecialType.System_Object
&& secondParam.Name == "paramName" && secondParam.Type.Equals(_typeSymbols.String, SymbolEqualityComparer.Default))
{
return true;
}
}
}
}

return false;
}
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -144,8 +144,8 @@ void EmitMethods(ImmutableEquatableArray<TypedInterceptorInvocationInfo>? interc
Debug.Assert(!type.IsValueType);
string binderOptionsArg = configureOptions ? $"{Identifier.GetBinderOptions}({Identifier.configureOptions})" : $"{Identifier.binderOptions}: null";

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
_writer.WriteLine($$"""
var {{Identifier.typedObj}} = ({{type.DisplayString}}){{Identifier.instance}};
{{nameof(MethodsToGen_CoreBindingHelper.BindCore)}}({{configExpression}}, ref {{Identifier.typedObj}}, defaultValueIfNotFound: false, {{binderOptionsArg}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ private void EmitGetCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, Action<{Identifier.BinderOptions}>? {Identifier.configureOptions})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);

_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -178,7 +178,7 @@ private void EmitGetValueCoreMethod()
EmitBlankLineIfRequired();
EmitStartBlock($"public static object? {nameof(MethodsToGen_CoreBindingHelper.GetValueCore)}(this {Identifier.IConfiguration} {Identifier.configuration}, Type {Identifier.type}, string {Identifier.key})");

EmitCheckForNullArgument_WithBlankLine(Identifier.configuration);
EmitCheckForNullArgument_WithBlankLine(Identifier.configuration, _emitThrowIfNullMethod);
_writer.WriteLine($@"{Identifier.IConfigurationSection} {Identifier.section} = {GetSectionFromConfigurationExpression(Identifier.key, addQuotes: false)};");
_writer.WriteLine();

Expand DownExpand Up@@ -224,7 +224,7 @@ private void EmitBindCoreMainMethod()

EmitBlankLineIfRequired();
EmitStartBlock($"public static void {nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}({Identifier.IConfiguration} {Identifier.configuration}, object {Identifier.instance}, Type {Identifier.type}, {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions})");
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, voidReturn: true);
EmitCheckForNullArgument_WithBlankLine(Identifier.instance, _emitThrowIfNullMethod, voidReturn: true);
EmitIConfigurationHasValueOrChildrenCheck(voidReturn: true);
_writer.WriteLine($"{Identifier.BinderOptions}? {Identifier.binderOptions} = {Identifier.GetBinderOptions}({Identifier.configureOptions});");
_writer.WriteLine();
Expand DownExpand Up@@ -475,24 +475,20 @@ private void EmitHelperMethods()
EmitGetBinderOptionsHelper();
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
if (_emitEnumParseMethod)
{
bool enumTypeExists = false;
_writer.WriteLine();
EmitEnumParseMethod();
_emitBlankLineBeforeNextStatement = true;
}

if (_bindingHelperInfo.TypesForGen_ParsePrimitive is { Count: not 0 } stringParsableTypes)
{
foreach (ParsableFromStringSpec type in stringParsableTypes)
{
EmitBlankLineIfRequired();

if (type.StringParsableTypeKind == StringParsableTypeKind.Enum)
{
if (!enumTypeExists)
{
EmitEnumParseMethod();
enumTypeExists = true;
}
}
else
if (type.StringParsableTypeKind is not StringParsableTypeKind.Enum)
{
EmitBlankLineIfRequired();
EmitPrimitiveParseMethod(type);
}
}
Expand DownExpand Up@@ -585,16 +581,13 @@ private void EmitEnumParseMethod()
{
string exceptionArg1 = string.Format(ExceptionMessages.FailedBinding, $"{{{Identifier.getPath}()}}", $"{{typeof(T)}}");

string parseEnumCall = _emitGenericParseEnum ? "Enum.Parse<T>(value, ignoreCase: true)" : "(T)Enum.Parse(typeof(T), value, ignoreCase: true)";
_writer.WriteLine($$"""
public static T ParseEnum<T>(string value, Func<string?> getPath) where T : struct
{
try
{
#if NETFRAMEWORK || NETSTANDARD2_0
return (T)Enum.Parse(typeof(T), value, ignoreCase: true);
#else
return Enum.Parse<T>(value, ignoreCase: true);
#endif
return {{parseEnumCall}};
}
catch ({{Identifier.Exception}} {{Identifier.exception}})
{
Expand All@@ -614,8 +607,6 @@ private void EmitPrimitiveParseMethod(ParsableFromStringSpec type)

switch (typeKind)
{
case StringParsableTypeKind.Enum:
return;
case StringParsableTypeKind.ByteArray:
{
parsedValueExpr = $"Convert.FromBase64String({Identifier.value})";
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -229,18 +229,30 @@ private void EmitBlankLineIfRequired()
_emitBlankLineBeforeNextStatement = true;
}

private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool voidReturn = false)
private void EmitCheckForNullArgument_WithBlankLine(string paramName, bool useThrowIfNullMethod, bool voidReturn = false)
{
string returnExpr = voidReturn
? "return"
: $"throw new ArgumentNullException(nameof({paramName}))";

_writer.WriteLine($$"""
if (voidReturn)
{
_writer.WriteLine($$"""
if ({{paramName}} is null)
{
{{returnExpr}};
return;
}
""");
}
else
{
string throwIfNullExpr = useThrowIfNullMethod
? $"ArgumentNullException.ThrowIfNull({paramName});"
Comment thread
tarekgh marked this conversation as resolved.
: $$"""
if ({{paramName}} is null)
{
throw new ArgumentNullException(nameof({{paramName}}));
}
""";

_writer.WriteLine(throwIfNullExpr);
}

_writer.WriteLine();
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ private void EmitBindMethods_Extensions_OptionsBuilder()
paramList + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureBinder}",
documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);

_writer.WriteLine($$"""
{{Identifier.Configure}}<{{Identifier.TOptions}}>({{Identifier.optionsBuilder}}.{{Identifier.Services}}, {{Identifier.optionsBuilder}}.Name, {{Identifier.config}}, {{Identifier.configureBinder}});
Expand All@@ -65,11 +65,11 @@ private void EmitBindConfigurationMethod()

EmitMethodStartBlock(MethodsToGen.OptionsBuilderExt_BindConfiguration, "BindConfiguration", paramList, documentation);

EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath);
EmitCheckForNullArgument_WithBlankLine(Identifier.optionsBuilder, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.configSectionPath, _emitThrowIfNullMethod);

EmitStartBlock($"{Identifier.optionsBuilder}.{Identifier.Configure}<{Identifier.IConfiguration}>(({Identifier.instance}, {Identifier.config}) =>");
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
{{Identifier.IConfiguration}} {{Identifier.section}} = string.Equals(string.Empty, {{Identifier.configSectionPath}}, StringComparison.OrdinalIgnoreCase) ? {{Identifier.config}} : {{Identifier.config}}.{{Identifier.GetSection}}({{Identifier.configSectionPath}});
{{nameof(MethodsToGen_CoreBindingHelper.BindCoreMain)}}({{Identifier.section}}, {{Identifier.instance}}, typeof({{Identifier.TOptions}}), {{Identifier.configureBinder}});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ private void EmitConfigureMethods()
// Like the others, it is public API that could be called directly by users.
// So, it is always generated whenever a Configure overload is called.
EmitStartMethod(MethodsToGen.ServiceCollectionExt_Configure_T_name_BinderOptions, paramList: $"string? {Identifier.name}, " + configParam + $", {TypeDisplayString.NullableActionOfBinderOptions} {Identifier.configureOptions}");
EmitCheckForNullArgument_WithBlankLine(Identifier.services);
EmitCheckForNullArgument_WithBlankLine(Identifier.config);
EmitCheckForNullArgument_WithBlankLine(Identifier.services, _emitThrowIfNullMethod);
EmitCheckForNullArgument_WithBlankLine(Identifier.config, _emitThrowIfNullMethod);
_writer.WriteLine($$"""
OptionsServiceCollectionExtensions.AddOptions({{Identifier.services}});
{{Identifier.services}}.{{Identifier.AddSingleton}}<{{Identifier.IOptionsChangeTokenSource}}<{{Identifier.TOptions}}>>(new {{Identifier.ConfigurationChangeTokenSource}}<{{Identifier.TOptions}}>({{Identifier.name}}, {{Identifier.config}}));
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,6 +56,8 @@ internal sealed class KnownTypeSymbols
public INamedTypeSymbol? ISet_Unbound { get; }
public INamedTypeSymbol? ISet { get; }
public INamedTypeSymbol? List { get; }
public INamedTypeSymbol Enum { get; }
public INamedTypeSymbol? ArgumentNullException { get; }

public KnownTypeSymbols(CSharpCompilation compilation)
{
Expand DownExpand Up@@ -113,6 +115,12 @@ public KnownTypeSymbols(CSharpCompilation compilation)
IReadOnlyList_Unbound = compilation.GetBestTypeByMetadataName(typeof(IReadOnlyList<>))?.ConstructUnboundGenericType();
IReadOnlySet_Unbound = compilation.GetBestTypeByMetadataName("System.Collections.Generic.IReadOnlySet`1")?.ConstructUnboundGenericType();
ISet_Unbound = ISet?.ConstructUnboundGenericType();

// needed to be able to know if a member exist inside the compilation unit
Enum = compilation.GetSpecialType(SpecialType.System_Enum);
ArgumentNullException = compilation.GetBestTypeByMetadataName(typeof(ArgumentNullException));

String = compilation.GetBestTypeByMetadataName(typeof(string));
}
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,5 +10,8 @@ public sealed record SourceGenerationSpec
public required InterceptorInfo InterceptorInfo { get; init; }
public required BindingHelperInfo BindingHelperInfo { get; init; }
public required ImmutableEquatableArray<TypeSpec> ConfigTypes { get; init; }
public required bool EmitEnumParseMethod { get; set; }
public required bool EmitGenericParseEnum { get; set; }
public required bool EmitThrowIfNullMethod { get; set; }
}
}
Loading