Skip to content

Commit 71eb227

Browse files
nilsaufnilsauf
authored
Feature generic classes (#143)
* generate safe filenames * add extensions to get generic type parameters and syntax * add generic type parameters to class declaration * add additional method declaration * add generic types if needed * add generic test class * adding Parameter Helper Method * removing processed items + using rootContainingSymbols * using originalDefinition of generic types * type format without generics + extra generic type format * extra extension methods * using new generic type format for GenerateFullGenericName * use GetGenericTypeSyntax instead of GenerateFullGenericName * better type parameters and generic names * adding more test classes * fix usage of attributes input * adding classdeclaration with typeParameterConstraintClauses * adding extra MethodDeclaration helper * adding support for type parameter constraints * clean up
1 parent 8bda347 commit 71eb227

File tree

7 files changed

+181
-24
lines changed

7 files changed

+181
-24
lines changed

‎src/ReactiveMarbles.ObservableEvents.Example/MyForm.cs

+47
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
// See the LICENSE file in the project root for full license information.
44

55
using System;
6+
using System.Collections.ObjectModel;
7+
using System.Reactive.Linq;
68
using System.Threading.Tasks;
79

810
using ReactiveMarbles.ObservableEvents;
@@ -54,4 +56,49 @@ public static class StaticTest
5456
{
5557
public static event EventHandler? TestChanged;
5658
}
59+
60+
public class GenericTestClass<TGenericType, TGen2>
61+
{
62+
public event EventHandler<TGenericType> TestChanged;
63+
64+
public GenericTestClass()
65+
{
66+
var events = this.Events().TestChanged;
67+
}
68+
}
69+
70+
public class SecondGenericTextClass<TGen3> : GenericTestClass<AsyncEventsClass, TGen3>
71+
{
72+
public event EventHandler TestChanged2;
73+
74+
public SecondGenericTextClass()
75+
{
76+
var events = this.Events().TestChanged;
77+
}
78+
}
79+
80+
public class GenericClassesTestClass
81+
{
82+
public GenericClassesTestClass()
83+
{
84+
var colInt = new ObservableCollection<int>();
85+
colInt.Events();
86+
87+
var col = new ObservableCollection<AsyncEventsClass>();
88+
col.Events();
89+
}
90+
}
91+
92+
public class GenericConstraintsTestClass<TGen, TGen2, TGen3>
93+
where TGen : AsyncEventsClass
94+
where TGen2 : SecondGenericTextClass<TGen>
95+
where TGen3 : class, new()
96+
{
97+
public event EventHandler<TGen2> TestChanged;
98+
99+
public GenericConstraintsTestClass()
100+
{
101+
var events = this.Events().TestChanged;
102+
}
103+
}
57104
}

‎src/ReactiveMarbles.ObservableEvents.SourceGenerator/EventGenerator.cs

+11-12
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,8 @@ private static void GenerateEventExtensionMethods(GeneratorExecutionContext cont
119119
return;
120120
}
121121

122-
context.AddSource("TestExtensions.FoundEvents.SourceGenerated.cs", SourceText.From(compilationUnit.ToFullString(), Encoding.UTF8));
122+
string sourceText = compilationUnit.ToFullString();
123+
context.AddSource("TestExtensions.FoundEvents.SourceGenerated.cs", SourceText.From(sourceText, Encoding.UTF8));
123124
}
124125

125126
private static void GetAvailableTypes(
@@ -162,6 +163,11 @@ private static void GetAvailableTypes(
162163
continue;
163164
}
164165

166+
if (callingSymbol.IsGenericType)
167+
{
168+
callingSymbol = callingSymbol.OriginalDefinition;
169+
}
170+
165171
var location = Location.Create(invocation.SyntaxTree, invocation.Span);
166172

167173
instanceNamespaceList.Add((location, callingSymbol));
@@ -202,23 +208,14 @@ private static bool GenerateEvents(
202208
return true;
203209
}
204210

205-
var processedItems = new HashSet<INamedTypeSymbol>(SymbolEqualityComparer.Default);
206-
207211
var fileType = isStatic ? "Static" : "Instance";
208212

209213
var rootContainingSymbols = symbols.Select(x => x.NamedType).ToImmutableSortedSet(TypeDefinitionNameComparer.Default);
210214

211215
bool hasEvents = false;
212216

213-
foreach (var (location, item) in symbols)
214-
{
215-
if (processedItems.Contains(item))
217+
foreach (var item in rootContainingSymbols)
216218
{
217-
continue;
218-
}
219-
220-
processedItems.Add(item);
221-
222219
var namespaceItem = symbolGenerator.Generate(item, context.Compilation.GetTypeByMetadataName);
223220

224221
if (namespaceItem == null)
@@ -237,7 +234,9 @@ private static bool GenerateEvents(
237234

238235
var sourceText = compilationUnit.ToFullString();
239236

240-
var name = $"SourceClass{item.ToDisplayString(RoslynHelpers.SymbolDisplayFormat)}-{fileType}Events.SourceGenerated.cs";
237+
SymbolDisplayFormat fileNameFormat = RoslynHelpers.SymbolDisplayFormat.WithGenericsOptions(SymbolDisplayGenericsOptions.None);
238+
string genericHint = item.IsGenericType ? $"-{string.Join("-", item.TypeParameters.Select(type => type.Name))}" : string.Empty;
239+
var name = $"SourceClass{item.ToDisplayString(fileNameFormat)}{genericHint}-{fileType}Events.SourceGenerated.cs";
241240

242241
context.AddSource(
243242
name,

‎src/ReactiveMarbles.ObservableEvents.SourceGenerator/EventGenerators/Generators/InstanceEventGenerator.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ private static ConstructorDeclarationSyntax GenerateEventWrapperClassConstructor
4545
},
4646
2);
4747

48-
return ConstructorDeclaration(default, new[] { SyntaxKind.PublicKeyword }, new[] { Parameter(typeDefinition.GenerateFullGenericName(), dataParameterName) }, className, constructorBlock, 1)
48+
return ConstructorDeclaration(default, new[] { SyntaxKind.PublicKeyword }, new[] { Parameter(typeDefinition.GetTypeSyntax(), dataParameterName) }, className, constructorBlock, 1)
4949
.WithLeadingTrivia(
5050
XmlSyntaxFactory.GenerateSummarySeeAlsoComment("Initializes a new instance of the {0} class.", className, (dataParameterName, "The class that is being wrapped.")));
5151
}
5252

5353
private static FieldDeclarationSyntax GenerateEventWrapperField(INamedTypeSymbol typeDefinition)
5454
{
5555
return FieldDeclaration(
56-
typeDefinition.GenerateFullGenericName(),
56+
typeDefinition.GetTypeSyntax(),
5757
DataFieldName,
5858
new[] { SyntaxKind.PrivateKeyword, SyntaxKind.ReadOnlyKeyword },
5959
1);
@@ -93,6 +93,8 @@ private static IEnumerable<ClassDeclarationSyntax> GenerateEventWrapperClasses(I
9393
obsoleteList,
9494
new[] { SyntaxKind.InternalKeyword },
9595
members.Concat(properties).ToList(),
96+
typeDefinition.GetTypeParameterConstraints(),
97+
typeDefinition.GetTypeParametersAsTypeParameterSyntax(),
9698
1);
9799
}
98100
}

‎src/ReactiveMarbles.ObservableEvents.SourceGenerator/EventGenerators/MethodGenerator.cs

+6-7
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22
// ReactiveUI Association Incorporated licenses this file to you under the MIT license.
33
// See the LICENSE file in the project root for full license information.
44

5-
using System;
6-
using System.Collections.Generic;
7-
using System.Text;
8-
95
using Microsoft.CodeAnalysis;
106
using Microsoft.CodeAnalysis.CSharp;
117
using Microsoft.CodeAnalysis.CSharp.Syntax;
@@ -37,11 +33,14 @@ private static MethodDeclarationSyntax GenerateInstanceMethod(INamedTypeSymbol d
3733
{
3834
var eventsClassName = "global::" + declarationType.ContainingNamespace.ToDisplayString(RoslynHelpers.SymbolDisplayFormat) + ".Rx" + declarationType.Name + "Events";
3935
var modifiers = new[] { SyntaxKind.PublicKeyword, SyntaxKind.StaticKeyword };
40-
var parameters = new[] { Parameter(declarationType.GenerateFullGenericName(), "item", new[] { SyntaxKind.ThisKeyword }) };
41-
var body = ArrowExpressionClause(ObjectCreationExpression(eventsClassName, new[] { Argument("item") }));
36+
var parameters = new[] { Parameter(declarationType.GetTypeSyntax(), "item", new[] { SyntaxKind.ThisKeyword }) };
37+
var typeParameterConstraints = declarationType.GetTypeParameterConstraints();
38+
var typeParameters = declarationType.GetTypeParametersAsTypeParameterSyntax();
39+
var returnTypeSyntax = declarationType.GetTypeSyntax(eventsClassName);
40+
var body = ArrowExpressionClause(ObjectCreationExpression(returnTypeSyntax, new[] { Argument("item") }));
4241
var attributes = RoslynHelpers.GenerateObsoleteAttributeList(declarationType);
4342

44-
return MethodDeclaration(attributes, modifiers, eventsClassName, "Events", parameters, 0, body)
43+
return MethodDeclaration(attributes, modifiers, returnTypeSyntax, "Events", parameters, typeParameterConstraints, typeParameters, 0, body)
4544
.WithLeadingTrivia(XmlSyntaxFactory.GenerateSummarySeeAlsoComment("A wrapper class which wraps all the events contained within the {0} class.", declarationType.GetArityDisplayName()));
4645
}
4746
}

‎src/ReactiveMarbles.ObservableEvents.SourceGenerator/EventGenerators/RoslynGeneratorExtensions.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ public static IReadOnlyList<TypeParameterSyntax> ToTypeParameters(this IEnumerab
203203
/// <returns>A type descriptor including the generic arguments.</returns>
204204
public static string GenerateFullGenericName(this ITypeSymbol currentType)
205205
{
206-
return currentType.ToDisplayString(RoslynHelpers.TypeFormat);
206+
return currentType.ToDisplayString(RoslynHelpers.GenericTypeFormat);
207207
}
208208

209209
public static IEnumerable<INamedTypeSymbol> GetBasesWithCondition(this INamedTypeSymbol symbol, Func<INamedTypeSymbol, bool> condition)

‎src/ReactiveMarbles.ObservableEvents.SourceGenerator/EventGenerators/RoslynHelpers.cs

+89-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
// See the LICENSE file in the project root for full license information.
44

55
using System;
6+
using System.Collections.Generic;
67
using System.Linq;
78

89
using Microsoft.CodeAnalysis;
@@ -23,7 +24,9 @@ internal static class RoslynHelpers
2324

2425
public static SymbolDisplayFormat SymbolDisplayFormat { get; } = new SymbolDisplayFormat(typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces, genericsOptions: SymbolDisplayGenericsOptions.IncludeTypeParameters | SymbolDisplayGenericsOptions.IncludeTypeConstraints | SymbolDisplayGenericsOptions.IncludeVariance);
2526

26-
public static SymbolDisplayFormat TypeFormat { get; } = new SymbolDisplayFormat(globalNamespaceStyle: SymbolDisplayGlobalNamespaceStyle.Included, typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces, genericsOptions: SymbolDisplayGenericsOptions.IncludeTypeParameters, miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes);
27+
public static SymbolDisplayFormat GenericTypeFormat { get; } = new SymbolDisplayFormat(globalNamespaceStyle: SymbolDisplayGlobalNamespaceStyle.Included, typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces, genericsOptions: SymbolDisplayGenericsOptions.IncludeTypeParameters, miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes);
28+
29+
public static SymbolDisplayFormat TypeFormat { get; } = new SymbolDisplayFormat(globalNamespaceStyle: SymbolDisplayGlobalNamespaceStyle.Included, typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces, genericsOptions: SymbolDisplayGenericsOptions.None, miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes);
2730

2831
/// <summary>
2932
/// Gets an argument which access System.Reactive.Unit.Default member.
@@ -60,5 +63,90 @@ public static AttributeListSyntax[] GenerateObsoleteAttributeList(ISymbol eventD
6063

6164
return Array.Empty<AttributeListSyntax>();
6265
}
66+
67+
public static IReadOnlyCollection<TypeParameterSyntax> GetTypeParametersAsTypeParameterSyntax(
68+
this INamedTypeSymbol typeSymbol)
69+
{
70+
return typeSymbol.GetTypeParametersAs(TypeParameter);
71+
}
72+
73+
public static IReadOnlyCollection<TypeSyntax> GetTypeParametersAsTypeSyntax(
74+
this INamedTypeSymbol typeSymbol)
75+
{
76+
return typeSymbol.GetTypeParametersAs(name => SyntaxFactory.ParseTypeName(name));
77+
}
78+
79+
public static TypeSyntax GetTypeSyntax(
80+
this ITypeSymbol typeSymbol,
81+
string? newName = null,
82+
IReadOnlyCollection<TypeSyntax>? genericTypeParameters = null)
83+
{
84+
string typeName = newName ?? typeSymbol.ToDisplayString(TypeFormat);
85+
86+
if (typeSymbol is INamedTypeSymbol namedTypeSymbol && namedTypeSymbol.TypeParameters.Any())
87+
{
88+
return GenericName(typeName, genericTypeParameters ?? namedTypeSymbol.GetTypeParametersAsTypeSyntax());
89+
}
90+
91+
return IdentifierName(typeName);
92+
}
93+
94+
public static IReadOnlyCollection<TypeParameterConstraintClauseSyntax> GetTypeParameterConstraints(
95+
this INamedTypeSymbol typeSymbol)
96+
{
97+
return typeSymbol.TypeParameters
98+
.Select(tp => (
99+
tp.Name,
100+
Constraints: tp.GetOtherConstrainst()
101+
.Concat(tp.ConstraintTypes.Select(GetAsTypeConstraint))
102+
.Select(tpc => tpc.WithTrailingTrivia(SyntaxFactory.Space).WithoutLeadingTrivia())
103+
.ToArray()))
104+
.Where(tp => tp.Constraints.Length > 0)
105+
.Select(tp => TypeParameterConstraintClause(tp.Name, tp.Constraints))
106+
.ToArray();
107+
}
108+
109+
private static IEnumerable<TypeParameterConstraintSyntax> GetOtherConstrainst(
110+
this ITypeParameterSymbol typeSymbol)
111+
{
112+
if (typeSymbol.HasReferenceTypeConstraint ||
113+
typeSymbol.HasValueTypeConstraint)
114+
{
115+
yield return SyntaxFactory.ClassOrStructConstraint(
116+
typeSymbol.HasReferenceTypeConstraint ? SyntaxKind.ClassConstraint :
117+
typeSymbol.HasValueTypeConstraint ? SyntaxKind.StructConstraint :
118+
throw new InvalidOperationException());
119+
}
120+
121+
if (typeSymbol.HasConstructorConstraint)
122+
{
123+
yield return SyntaxFactory.ConstructorConstraint();
124+
}
125+
}
126+
127+
private static TypeParameterConstraintSyntax GetAsTypeConstraint(
128+
this ITypeSymbol typeSymbol)
129+
{
130+
if (typeSymbol is INamedTypeSymbol namedTypeSymbol && namedTypeSymbol.TypeArguments.Any())
131+
{
132+
return TypeConstraint(namedTypeSymbol.GetTypeSyntax(
133+
genericTypeParameters: namedTypeSymbol.TypeArguments
134+
.Select(tp => tp.GenerateFullGenericName())
135+
.Select(IdentifierName)
136+
.ToArray()));
137+
}
138+
139+
return TypeConstraint(typeSymbol.GetTypeSyntax());
140+
}
141+
142+
private static IReadOnlyCollection<T> GetTypeParametersAs<T>(
143+
this INamedTypeSymbol typeSymbol,
144+
Func<string, T> parseName)
145+
{
146+
return typeSymbol.TypeParameters
147+
.Select(tp => tp.Name)
148+
.Select(parseName)
149+
.ToArray();
150+
}
63151
}
64152
}

0 commit comments

Comments
 (0)