aecw/osu-framework
1
0
Fork 0
mirror of https://github.com/SK-la/osu-framework.git synced 2026-03-13 11:20:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix nested DI candidates not analysed in non-candidate parent types

Browse Source
This commit is contained in:
Dan Balasescu
2023-06-15 18:53:36 +09:00
parent 73ebbe343d
commit 31df65ebb1
2 changed files with 27 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
osu.Framework.SourceGeneration/Analysers/DiagnosticRules.cs
View File

@@ -13,12 +13,12 @@ namespace osu.Framework.SourceGeneration.Analysers
public static readonly DiagnosticDescriptor MAKE_DI_CLASS_PARTIAL = new DiagnosticDescriptor(
"OFSG001",
"This class is a candidate for dependency injection and should be partial",
"This class is a candidate for dependency injection and should be partial",
"This type, or a nested type, is a candidate for dependency injection and should be partial",
"This type, or a nested type, is a candidate for dependency injection and should be partial",
"Performance",
DiagnosticSeverity.Warning,
true,
"Classes that are candidates for dependency injection should be made partial to benefit from compile-time optimisations.");
"Types that are candidates for dependency injection should be made partial to benefit from compile-time optimisations.");
#pragma warning restore RS2008
}

29
osu.Framework.SourceGeneration/Analysers/DrawableAnalyser.cs
View File

@@ -24,19 +24,38 @@ namespace osu.Framework.SourceGeneration.Analysers
}
/// <summary>
/// Analyses class definitions for implementations of IDrawable, ISourceGeneratedDependencyActivator, and Transformable.
/// Analyses class definitions for implementations of IDependencyInjectionCandidateInterface.
/// </summary>
private void analyseClass(SyntaxNodeAnalysisContext context)
{
var classSyntax = (ClassDeclarationSyntax)context.Node;
if (classSyntax.Modifiers.Any(m => m.IsKind(SyntaxKind.PartialKeyword)))
if (classSyntax.Ancestors().OfType<ClassDeclarationSyntax>().Any())
return;
INamedTypeSymbol? type = context.SemanticModel.GetDeclaredSymbol(classSyntax);
analyseRecursively(context, classSyntax);
if (type?.AllInterfaces.Any(SyntaxHelpers.IsIDependencyInjectionCandidateInterface) == true)
context.ReportDiagnostic(Diagnostic.Create(DiagnosticRules.MAKE_DI_CLASS_PARTIAL, context.Node.GetLocation(), context.Node));
static bool analyseRecursively(SyntaxNodeAnalysisContext context, ClassDeclarationSyntax node)
{
bool requiresPartial = false;
// Child nodes always have to be analysed to provide diagnostics.
foreach (var nested in node.DescendantNodes().OfType<ClassDeclarationSyntax>())
requiresPartial |= analyseRecursively(context, nested);
// - If at least one child requires partial, then this node also needs to be partial regardless of its own type (optimisation).
// - If no child requires partial, we need to check if this node is a DI candidate (e.g. If the node has no nested types).
if (!requiresPartial)
requiresPartial = context.SemanticModel.GetDeclaredSymbol(node)?.AllInterfaces.Any(SyntaxHelpers.IsIDependencyInjectionCandidateInterface) == true;
// Whether the node is already partial.
bool isPartial = node.Modifiers.Any(m => m.IsKind(SyntaxKind.PartialKeyword));
if (requiresPartial && !isPartial)
context.ReportDiagnostic(Diagnostic.Create(DiagnosticRules.MAKE_DI_CLASS_PARTIAL, node.GetLocation(), node));
return requiresPartial;
}
}
}
}