You've already forked godot
mirror of
https://github.com/godotengine/godot.git
synced 2025-11-05 12:10:55 +00:00
Add MustBeVariant attribute and analyzer
- MustBeVariant attribute can be used to enforce that generic types must be a marshable from/to Variant. - Also renames all diagnostic ids to be valid unicode identifiers.
This commit is contained in:
@@ -0,0 +1,100 @@
|
||||
using System.Collections.Immutable;
|
||||
using System.Diagnostics;
|
||||
using System.Linq;
|
||||
using Microsoft.CodeAnalysis;
|
||||
using Microsoft.CodeAnalysis.CSharp;
|
||||
using Microsoft.CodeAnalysis.CSharp.Syntax;
|
||||
using Microsoft.CodeAnalysis.Diagnostics;
|
||||
|
||||
namespace Godot.SourceGenerators
|
||||
{
|
||||
[DiagnosticAnalyzer(LanguageNames.CSharp)]
|
||||
public class MustBeVariantAnalyzer : DiagnosticAnalyzer
|
||||
{
|
||||
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics
|
||||
=> ImmutableArray.Create(
|
||||
Common.GenericTypeArgumentMustBeVariantRule,
|
||||
Common.GenericTypeParameterMustBeVariantAnnotatedRule,
|
||||
Common.TypeArgumentParentSymbolUnhandledRule);
|
||||
|
||||
public override void Initialize(AnalysisContext context)
|
||||
{
|
||||
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
|
||||
context.EnableConcurrentExecution();
|
||||
context.RegisterSyntaxNodeAction(AnalyzeNode, SyntaxKind.TypeArgumentList);
|
||||
}
|
||||
|
||||
private void AnalyzeNode(SyntaxNodeAnalysisContext context)
|
||||
{
|
||||
var typeArgListSyntax = (TypeArgumentListSyntax)context.Node;
|
||||
|
||||
// Method invocation or variable declaration that contained the type arguments
|
||||
var parentSyntax = context.Node.Parent;
|
||||
Debug.Assert(parentSyntax != null);
|
||||
|
||||
var sm = context.SemanticModel;
|
||||
|
||||
var typeCache = new MarshalUtils.TypeCache(context.Compilation);
|
||||
|
||||
for (int i = 0; i < typeArgListSyntax.Arguments.Count; i++)
|
||||
{
|
||||
var typeSyntax = typeArgListSyntax.Arguments[i];
|
||||
var typeSymbol = sm.GetSymbolInfo(typeSyntax).Symbol as ITypeSymbol;
|
||||
Debug.Assert(typeSymbol != null);
|
||||
|
||||
var parentSymbol = sm.GetSymbolInfo(parentSyntax).Symbol;
|
||||
|
||||
if (!ShouldCheckTypeArgument(context, parentSyntax, parentSymbol, typeSyntax, typeSymbol, i))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (typeSymbol is ITypeParameterSymbol typeParamSymbol)
|
||||
{
|
||||
if (!typeParamSymbol.GetAttributes().Any(a => a.AttributeClass?.IsGodotMustBeVariantAttribute() ?? false))
|
||||
{
|
||||
Common.ReportGenericTypeParameterMustBeVariantAnnotated(context, typeSyntax, typeSymbol);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
var marshalType = MarshalUtils.ConvertManagedTypeToMarshalType(typeSymbol, typeCache);
|
||||
|
||||
if (marshalType == null)
|
||||
{
|
||||
Common.ReportGenericTypeArgumentMustBeVariant(context, typeSyntax, typeSymbol);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Check if the given type argument is being used in a type parameter that contains
|
||||
/// the <c>MustBeVariantAttribute</c>; otherwise, we ignore the attribute.
|
||||
/// </summary>
|
||||
/// <param name="context">Context for a syntax node action.</param>
|
||||
/// <param name="parentSyntax">The parent node syntax that contains the type node syntax.</param>
|
||||
/// <param name="parentSymbol">The symbol retrieved for the parent node syntax.</param>
|
||||
/// <param name="typeArgumentSyntax">The type node syntax of the argument type to check.</param>
|
||||
/// <param name="typeArgumentSymbol">The symbol retrieved for the type node syntax.</param>
|
||||
/// <returns><see langword="true"/> if the type must be variant and must be analyzed.</returns>
|
||||
private bool ShouldCheckTypeArgument(SyntaxNodeAnalysisContext context, SyntaxNode parentSyntax, ISymbol parentSymbol, TypeSyntax typeArgumentSyntax, ITypeSymbol typeArgumentSymbol, int typeArgumentIndex)
|
||||
{
|
||||
var typeParamSymbol = parentSymbol switch
|
||||
{
|
||||
IMethodSymbol methodSymbol => methodSymbol.TypeParameters[typeArgumentIndex],
|
||||
INamedTypeSymbol typeSymbol => typeSymbol.TypeParameters[typeArgumentIndex],
|
||||
_ => null,
|
||||
};
|
||||
|
||||
if (typeParamSymbol == null)
|
||||
{
|
||||
Common.ReportTypeArgumentParentSymbolUnhandled(context, typeArgumentSyntax, parentSymbol);
|
||||
return false;
|
||||
}
|
||||
|
||||
return typeParamSymbol.GetAttributes()
|
||||
.Any(a => a.AttributeClass?.IsGodotMustBeVariantAttribute() ?? false);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user