-
Notifications
You must be signed in to change notification settings - Fork 40
/
ToolkitSampleMetadataGenerator.Sample.cs
318 lines (261 loc) · 19.4 KB
/
ToolkitSampleMetadataGenerator.Sample.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using CommunityToolkit.Labs.Core.SourceGenerators.Attributes;
using CommunityToolkit.Labs.Core.SourceGenerators.Diagnostics;
using CommunityToolkit.Labs.Core.SourceGenerators.Metadata;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Text;
namespace CommunityToolkit.Labs.Core.SourceGenerators;
/// <summary>
/// Crawls all referenced projects for <see cref="ToolkitSampleAttribute"/>s and generates a static method that returns metadata for each one found. Uses markdown files to generate a listing of <see cref="ToolkitFrontMatter"/> data and an index of references samples for them.
/// </summary>
[Generator]
public partial class ToolkitSampleMetadataGenerator : IIncrementalGenerator
{
/// <inheritdoc />
public void Initialize(IncrementalGeneratorInitializationContext context)
{
var symbolsInExecutingAssembly = context.SyntaxProvider
.CreateSyntaxProvider(
static (s, _) => s is ClassDeclarationSyntax c && c.AttributeLists.Count > 0,
static (ctx, _) => ctx.SemanticModel.GetDeclaredSymbol(ctx.Node))
.Where(static m => m is not null)
.Select(static (x, _) => x!);
var symbolsInReferencedAssemblies = context.CompilationProvider
.SelectMany((x, _) => x.SourceModule.ReferencedAssemblySymbols)
.SelectMany((asm, _) => asm.GlobalNamespace.CrawlForAllNamedTypes())
.Where(x => x.TypeKind == TypeKind.Class && x.CanBeReferencedByName)
.Select((x, _) => (ISymbol)x);
var markdownFiles = context.AdditionalTextsProvider
.Where(static file => file.Path.EndsWith(".md"))
.Collect();
var assemblyName = context.CompilationProvider.Select((x, _) => x.Assembly.Name);
// Only generate diagnostics (sample projects)
// Skip creating the registry for symbols in the executing assembly. This would place an incomplete registry in each sample project and cause compiler erorrs.
Execute(symbolsInExecutingAssembly, skipRegistry: true);
// Only generate the registry (project head)
// Skip diagnostics for symbols in referenced assemblies. We can't place diagnostics here even if we tried,
// and running diagnostics here will cause errors when executing in the sample project, due to not finding sample metadata in the provided symbols.
Execute(symbolsInReferencedAssemblies, skipDiagnostics: true);
void Execute(IncrementalValuesProvider<ISymbol> types, bool skipDiagnostics = false, bool skipRegistry = false)
{
// Get all attributes + the original type symbol.
var allAttributeData = types.SelectMany(static (sym, _) => sym.GetAttributes().Select(x => (sym, x)));
// Find and reconstruct generated pane option attributes + the original type symbol.
var generatedPaneOptions = allAttributeData
.Select(static (x, _) =>
{
if (x.Item2.TryReconstructAs<ToolkitSampleBoolOptionAttribute>() is ToolkitSampleBoolOptionAttribute boolOptionAttribute)
return (x.Item1, (ToolkitSampleOptionBaseAttribute)boolOptionAttribute);
if (x.Item2.TryReconstructAs<ToolkitSampleMultiChoiceOptionAttribute>() is ToolkitSampleMultiChoiceOptionAttribute multiChoiceOptionAttribute)
return (x.Item1, (ToolkitSampleOptionBaseAttribute)multiChoiceOptionAttribute);
return default;
})
.Where(static x => x != default)
.Collect();
// Find and reconstruct sample attributes
var toolkitSampleAttributeData = allAttributeData
.Select(static (data, _) =>
{
if (data.Item2.TryReconstructAs<ToolkitSampleAttribute>() is ToolkitSampleAttribute sampleAttribute)
return (Attribute: sampleAttribute, AttachedQualifiedTypeName: data.Item1.ToString(), Symbol: data.Item1);
return default;
})
.Where(static x => x != default)
.Collect();
var optionsPaneAttributes = allAttributeData
.Select(static (x, _) => (x.Item2.TryReconstructAs<ToolkitSampleOptionsPaneAttribute>(), x.Item1))
.Where(static x => x.Item1 is not null)
.Collect();
var all = optionsPaneAttributes
.Combine(toolkitSampleAttributeData)
.Combine(generatedPaneOptions)
.Combine(markdownFiles)
.Combine(assemblyName);
context.RegisterSourceOutput(all, (ctx, data) =>
{
var toolkitSampleAttributeData = data.Left.Left.Left.Right.Where(x => x != default).Distinct();
var optionsPaneAttribute = data.Left.Left.Left.Left.Where(x => x != default).Distinct();
var generatedOptionPropertyData = data.Left.Left.Right.Where(x => x != default).Distinct();
var markdownFileData = data.Left.Right.Where(x => x != default).Distinct();
var currentAssembly = data.Right;
var isExecutingInSampleProject = currentAssembly?.EndsWith(".Sample") ?? false;
// Reconstruct sample metadata from attributes
var sampleMetadata = toolkitSampleAttributeData
.ToDictionary(
sample => sample.Attribute.Id,
sample =>
new ToolkitSampleRecord(
sample.Attribute.Id,
sample.Attribute.DisplayName,
sample.Attribute.Description,
sample.AttachedQualifiedTypeName,
optionsPaneAttribute.FirstOrDefault(x => x.Item1?.SampleId == sample.Attribute.Id).Item2?.ToString(),
generatedOptionPropertyData.Where(x => ReferenceEquals(x.Item1, sample.Symbol)).Select(x => x.Item2)
)
);
var docFrontMatter = GatherDocumentFrontMatter(ctx, markdownFileData);
if (isExecutingInSampleProject && !skipDiagnostics)
{
ReportSampleDiagnostics(ctx, toolkitSampleAttributeData, optionsPaneAttribute, generatedOptionPropertyData);
ReportDocumentDiagnostics(ctx, sampleMetadata, markdownFileData, toolkitSampleAttributeData, docFrontMatter);
}
if (!isExecutingInSampleProject && !skipRegistry)
{
CreateDocumentRegistry(ctx, docFrontMatter);
CreateSampleRegistry(ctx, sampleMetadata);
}
});
}
}
private static void CreateSampleRegistry(SourceProductionContext ctx, Dictionary<string, ToolkitSampleRecord> sampleMetadata)
{
// TODO: Emit a better error that no samples are here?
if (sampleMetadata.Count == 0)
return;
var source = BuildRegistrationCallsFromMetadata(sampleMetadata);
ctx.AddSource($"ToolkitSampleRegistry.g.cs", source);
}
private static void ReportSampleDiagnostics(SourceProductionContext ctx,
IEnumerable<(ToolkitSampleAttribute Attribute, string AttachedQualifiedTypeName, ISymbol Symbol)> toolkitSampleAttributeData,
IEnumerable<(ToolkitSampleOptionsPaneAttribute?, ISymbol)> optionsPaneAttribute,
IEnumerable<(ISymbol, ToolkitSampleOptionBaseAttribute)> generatedOptionPropertyData)
{
ReportDiagnosticsForInvalidAttributeUsage(ctx, toolkitSampleAttributeData, optionsPaneAttribute, generatedOptionPropertyData);
ReportDiagnosticsForLinkedOptionsPane(ctx, toolkitSampleAttributeData, optionsPaneAttribute);
ReportDiagnosticsGeneratedOptionsPane(ctx, toolkitSampleAttributeData, generatedOptionPropertyData);
}
private static void ReportDiagnosticsForInvalidAttributeUsage(SourceProductionContext ctx,
IEnumerable<(ToolkitSampleAttribute Attribute, string AttachedQualifiedTypeName, ISymbol Symbol)> toolkitSampleAttributeData,
IEnumerable<(ToolkitSampleOptionsPaneAttribute?, ISymbol)> optionsPaneAttribute,
IEnumerable<(ISymbol, ToolkitSampleOptionBaseAttribute)> generatedOptionPropertyData)
{
var toolkitAttributesOnUnsupportedType = toolkitSampleAttributeData.Where(x => x.Symbol is not INamedTypeSymbol namedSym || !IsValidXamlControl(namedSym));
var optionsAttributeOnUnsupportedType = optionsPaneAttribute.Where(x => x.Item2 is not INamedTypeSymbol namedSym || !IsValidXamlControl(namedSym));
var generatedOptionAttributeOnUnsupportedType = generatedOptionPropertyData.Where(x => x.Item1 is not INamedTypeSymbol namedSym || !IsValidXamlControl(namedSym));
foreach (var item in toolkitAttributesOnUnsupportedType)
ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.SampleAttributeOnUnsupportedType, item.Symbol.Locations.FirstOrDefault()));
foreach (var item in optionsAttributeOnUnsupportedType)
ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.SampleOptionPaneAttributeOnUnsupportedType, item.Item2.Locations.FirstOrDefault()));
foreach (var item in generatedOptionAttributeOnUnsupportedType)
ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.SampleGeneratedOptionAttributeOnUnsupportedType, item.Item1.Locations.FirstOrDefault()));
}
private static void ReportDiagnosticsForLinkedOptionsPane(SourceProductionContext ctx,
IEnumerable<(ToolkitSampleAttribute Attribute, string AttachedQualifiedTypeName, ISymbol Symbol)> toolkitSampleAttributeData,
IEnumerable<(ToolkitSampleOptionsPaneAttribute?, ISymbol)> optionsPaneAttribute)
{
// Check for options pane attributes with no matching sample ID
var optionsPaneAttributeWithMissingOrInvalidSampleId = optionsPaneAttribute.Where(x => !toolkitSampleAttributeData.Any(sample => sample.Attribute.Id == x.Item1?.SampleId));
foreach (var item in optionsPaneAttributeWithMissingOrInvalidSampleId)
ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.OptionsPaneAttributeWithMissingOrInvalidSampleId, item.Item2.Locations.FirstOrDefault()));
}
private static void ReportDiagnosticsGeneratedOptionsPane(SourceProductionContext ctx,
IEnumerable<(ToolkitSampleAttribute Attribute, string AttachedQualifiedTypeName, ISymbol Symbol)> toolkitSampleAttributeData,
IEnumerable<(ISymbol, ToolkitSampleOptionBaseAttribute)> generatedOptionPropertyData)
{
ReportGeneratedMultiChoiceOptionsPaneDiagnostics(ctx, generatedOptionPropertyData);
// Check for generated options which don't have a valid sample attribute
var generatedOptionsWithMissingSampleAttribute = generatedOptionPropertyData.Where(x => !toolkitSampleAttributeData.Any(sample => ReferenceEquals(sample.Symbol, x.Item1)));
foreach (var item in generatedOptionsWithMissingSampleAttribute)
ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.SamplePaneOptionAttributeOnNonSample, item.Item1.Locations.FirstOrDefault()));
// Check for generated options with an empty or invalid name.
var generatedOptionsWithBadName = generatedOptionPropertyData.Where(x => string.IsNullOrWhiteSpace(x.Item2.Name) || // Must not be null or empty
!x.Item2.Name.Any(char.IsLetterOrDigit) || // Must be alphanumeric
x.Item2.Name.Any(char.IsWhiteSpace) || // Must not have whitespace
SyntaxFacts.GetKeywordKind(x.Item2.Name) != SyntaxKind.None); // Must not be a reserved keyword
foreach (var item in generatedOptionsWithBadName)
ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.SamplePaneOptionWithBadName, item.Item1.Locations.FirstOrDefault(), item.Item1.ToString()));
// Check for generated options with duplicate names.
var generatedOptionsWithDuplicateName = generatedOptionPropertyData.GroupBy(x => x.Item1, SymbolEqualityComparer.Default) // Group by containing symbol (allow reuse across samples)
.SelectMany(y => y.GroupBy(x => x.Item2.Name) // In this symbol, group options by name.
.Where(x => x.Any(x => x.Item2 is not ToolkitSampleMultiChoiceOptionAttribute)) // Exclude Multichoice.
.Where(x => x.Count() > 1)); // Options grouped by name should only contain 1 item.
foreach (var item in generatedOptionsWithDuplicateName)
ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.SamplePaneOptionWithDuplicateName, item.SelectMany(x => x.Item1.Locations).FirstOrDefault(), item.Key));
// Check for generated options that conflict with an existing property name
var generatedOptionsWithConflictingPropertyNames = generatedOptionPropertyData.Where(x => GetAllMembers((INamedTypeSymbol)x.Item1).Any(y => x.Item2.Name == y.Name));
foreach (var item in generatedOptionsWithConflictingPropertyNames)
ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.SamplePaneOptionWithConflictingName, item.Item1.Locations.FirstOrDefault(), item.Item2.Name));
}
private static void ReportGeneratedMultiChoiceOptionsPaneDiagnostics(SourceProductionContext ctx, IEnumerable<(ISymbol, ToolkitSampleOptionBaseAttribute)> generatedOptionPropertyData)
{
foreach (var item in generatedOptionPropertyData)
{
if (item.Item2 is ToolkitSampleMultiChoiceOptionAttribute multiChoiceAttr && multiChoiceAttr.Choices.Length == 0)
{
ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.SamplePaneMultiChoiceOptionWithNoChoices, item.Item1.Locations.FirstOrDefault(), item.Item2.Title));
}
}
}
private static string BuildRegistrationCallsFromMetadata(IDictionary<string, ToolkitSampleRecord> sampleMetadata)
{
return $@"#nullable enable
namespace CommunityToolkit.Labs.Core.SourceGenerators;
public static class ToolkitSampleRegistry
{{
public static System.Collections.Generic.Dictionary<string, {typeof(ToolkitSampleMetadata).FullName}> Listing
{{ get; }} = new() {{
{
string.Join(",\n ", sampleMetadata.Select(MetadataToRegistryCall).ToArray())
}
}};
}}";
}
private static string MetadataToRegistryCall(KeyValuePair<string, ToolkitSampleRecord> kvp)
{
var metadata = kvp.Value;
var sampleControlTypeParam = $"typeof({metadata.SampleAssemblyQualifiedName})";
var sampleControlFactoryParam = $"() => new {metadata.SampleAssemblyQualifiedName}()";
var generatedSampleOptionsParam = $"new {typeof(IGeneratedToolkitSampleOptionViewModel).FullName}[] {{ {string.Join(", ", BuildNewGeneratedSampleOptionMetadataSource(metadata).ToArray())} }}";
var sampleOptionsParam = metadata.SampleOptionsAssemblyQualifiedName is null ? "null" : $"typeof({metadata.SampleOptionsAssemblyQualifiedName})";
var sampleOptionsPaneFactoryParam = metadata.SampleOptionsAssemblyQualifiedName is null ? "null" : $"x => new {metadata.SampleOptionsAssemblyQualifiedName}(({metadata.SampleAssemblyQualifiedName})x)";
return @$"[""{kvp.Key}""] = new {typeof(ToolkitSampleMetadata).FullName}(""{metadata.Id}"", ""{metadata.DisplayName}"", ""{metadata.Description}"", {sampleControlTypeParam}, {sampleControlFactoryParam}, {sampleOptionsParam}, {sampleOptionsPaneFactoryParam}, {generatedSampleOptionsParam})";
}
private static IEnumerable<string> BuildNewGeneratedSampleOptionMetadataSource(ToolkitSampleRecord sample)
{
foreach (var item in sample.GeneratedSampleOptions ?? Enumerable.Empty<ToolkitSampleOptionBaseAttribute>())
{
if (item is ToolkitSampleMultiChoiceOptionAttribute multiChoiceAttr)
{
yield return $@"new {typeof(ToolkitSampleMultiChoiceOptionMetadataViewModel).FullName}(name: ""{item.Name}"", options: new[] {{ {string.Join(",", multiChoiceAttr.Choices.Select(x => $@"new {typeof(MultiChoiceOption).FullName}(""{x.Label}"", ""{x.Value}"")").ToArray())} }}, title: ""{item.Title}"")";
}
else if (item is ToolkitSampleBoolOptionAttribute boolAttribute)
{
yield return $@"new {typeof(ToolkitSampleBoolOptionMetadataViewModel).FullName}(id: ""{boolAttribute.Name}"", label: ""{boolAttribute.Label}"", defaultState: {boolAttribute.DefaultState?.ToString().ToLower()}, title: ""{boolAttribute.Title}"")";
}
else
{
throw new NotSupportedException($"Unsupported or unhandled type {item.GetType()}.");
}
}
}
/// <summary>
/// Checks if a symbol is or inherits from a type representing a XAML framework.
/// </summary>
/// <returns><see langwork="true"/> if the <paramref name="symbol"/> is or inherits from a type representing a XAML framework.</returns>
private static bool IsValidXamlControl(INamedTypeSymbol symbol)
{
// In UWP, Page inherits UserControl
// In Uno, Page doesn't appear to inherit UserControl.
var validSimpleTypeNames = new[] { "UserControl", "Page" };
// UWP / Uno / WinUI 3 namespaces.
var validNamespaceRoots = new[] { "Microsoft", "Windows" };
// Recursively crawl the base types until either UserControl or Page is found.
var validInheritedSymbol = symbol.CrawlBy(x => x?.BaseType, baseType => validNamespaceRoots.Any(x => $"{baseType}".StartsWith(x)) &&
$"{baseType}".Contains(".UI.Xaml.Controls.") &&
validSimpleTypeNames.Any(x => $"{baseType}".EndsWith(x)));
var typeIsAccessible = symbol.DeclaredAccessibility == Accessibility.Public;
return validInheritedSymbol != default && typeIsAccessible && !symbol.IsStatic;
}
private static IEnumerable<ISymbol> GetAllMembers(INamedTypeSymbol symbol)
{
foreach (var item in symbol.GetMembers())
yield return item;
if (symbol.BaseType is not null)
foreach (var item in GetAllMembers(symbol.BaseType))
yield return item;
}
}