-
Notifications
You must be signed in to change notification settings - Fork 13
/
AutoInterfaceGenerator.cs
416 lines (344 loc) · 14.3 KB
/
AutoInterfaceGenerator.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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
using System;
using System.CodeDom.Compiler;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Text;
namespace InterfaceGenerator
{
[Generator]
public class AutoInterfaceGenerator : ISourceGenerator
{
private INamedTypeSymbol _generateAutoInterfaceAttribute = null!;
private INamedTypeSymbol _ignoreAttribute = null!;
public void Initialize(GeneratorInitializationContext context)
{
context.RegisterForSyntaxNotifications(() => new SyntaxReceiver());
}
public void Execute(GeneratorExecutionContext context)
{
// setting the culture to invariant prevents errors such as emitting a decimal comma (0,1) instead of
// a decimal point (0.1) in certain cultures
var prevCulture = Thread.CurrentThread.CurrentCulture;
Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture;
GenerateAttributes(context);
GenerateInterfaces(context);
Thread.CurrentThread.CurrentCulture = prevCulture;
}
private static void GenerateAttributes(GeneratorExecutionContext context)
{
context.AddSource(
Attributes.GenerateAutoInterfaceClassname,
SourceText.From(Attributes.AttributesSourceCode, Encoding.UTF8));
}
private void GenerateInterfaces(GeneratorExecutionContext context)
{
if (context.SyntaxReceiver is not SyntaxReceiver receiver)
return;
var compilation = GetCompilation(context);
InitAttributes(compilation);
var classSymbols = GetImplTypeSymbols(compilation, receiver);
foreach (var implTypeSymbol in classSymbols)
{
if (!implTypeSymbol.TryGetAttribute(_generateAutoInterfaceAttribute, out var attributes))
{
continue;
}
var attribute = attributes.Single();
var source = SourceText.From(GenerateInterfaceCode(implTypeSymbol, attribute), Encoding.UTF8);
context.AddSource($"{implTypeSymbol.Name}_AutoInterface.cs", source);
}
}
private string GetVisibilityModifier(INamedTypeSymbol implTypeSymbol, AttributeData attributeData)
{
var pair = attributeData.NamedArguments.FirstOrDefault(x => x.Key == Attributes.VisibilityModifierPropName);
string? result = pair.Value.Value?.ToString();
if (!string.IsNullOrEmpty(result))
{
return result;
}
return implTypeSymbol.DeclaredAccessibility switch
{
Accessibility.Public => "public",
var _ => "internal",
};
}
private string GetInterfaceName(INamedTypeSymbol implTypeSymbol, AttributeData attributeData)
{
var pair = attributeData.NamedArguments.FirstOrDefault(x => x.Key == Attributes.InterfaceNamePropName);
string? result = pair.Value.Value?.ToString();
if (!string.IsNullOrEmpty(result))
{
return result;
}
return "I" + implTypeSymbol.Name;
}
private string GenerateInterfaceCode(INamedTypeSymbol implTypeSymbol, AttributeData attributeData)
{
using var stream = new MemoryStream();
var streamWriter = new StreamWriter(stream, Encoding.UTF8);
var codeWriter = new IndentedTextWriter(streamWriter, GeneratorConsts.Indent);
var namespaceName = implTypeSymbol.ContainingNamespace.ToDisplayString();
var interfaceName = GetInterfaceName(implTypeSymbol, attributeData);
var visibilityModifier = GetVisibilityModifier(implTypeSymbol, attributeData);
codeWriter.WriteLine("namespace {0}", namespaceName);
codeWriter.WriteLine("{");
++codeWriter.Indent;
codeWriter.Write("{0} partial interface {1}", visibilityModifier, interfaceName);
WriteTypeGenericsIfNeeded(codeWriter, implTypeSymbol);
codeWriter.WriteLine();
codeWriter.WriteLine("{");
++codeWriter.Indent;
GenerateInterfaceMemberDefinitions(codeWriter, implTypeSymbol);
--codeWriter.Indent;
codeWriter.WriteLine("}");
--codeWriter.Indent;
codeWriter.WriteLine("}");
codeWriter.Flush();
stream.Seek(0, SeekOrigin.Begin);
using var reader = new StreamReader(stream, Encoding.UTF8, true);
return reader.ReadToEnd();
}
private void WriteTypeGenericsIfNeeded(IndentedTextWriter writer, INamedTypeSymbol implTypeSymbol)
{
if (!implTypeSymbol.IsGenericType)
{
return;
}
writer.Write("<");
writer.WriteJoin(", ", implTypeSymbol.TypeParameters.Select(x => x.Name));
writer.Write(">");
WriteTypeParameterConstraints(writer, implTypeSymbol.TypeParameters);
}
private void GenerateInterfaceMemberDefinitions(IndentedTextWriter writer, INamedTypeSymbol implTypeSymbol)
{
foreach (var member in implTypeSymbol.GetMembers())
{
if (member.DeclaredAccessibility != Accessibility.Public)
{
continue;
}
if (member.HasAttribute(_ignoreAttribute))
{
continue;
}
GenerateInterfaceMemberDefinition(writer, member);
}
}
private static void GenerateInterfaceMemberDefinition(IndentedTextWriter writer, ISymbol member)
{
switch (member)
{
case IPropertySymbol propertySymbol:
GeneratePropertyDefinition(writer, propertySymbol);
break;
case IMethodSymbol methodSymbol:
GenerateMethodDefinition(writer, methodSymbol);
break;
}
}
private static void WriteMemberDocs(IndentedTextWriter writer, ISymbol member)
{
var xml = member.GetDocumentationCommentXml();
if (string.IsNullOrWhiteSpace(xml))
{
return;
}
// omit the fist and last lines to skip the <member> tag
var reader = new StringReader(xml);
var lines = new List<string>();
while (true)
{
var line = reader.ReadLine();
if (line is null)
{
break;
}
lines.Add(line);
}
for (int i = 1; i < lines.Count - 1; i++)
{
var line = lines[i];
writer.WriteLine("/// {0}", line);
}
}
private static bool IsPublicOrInternal(IMethodSymbol methodSymbol)
{
return methodSymbol.DeclaredAccessibility == Accessibility.Public ||
methodSymbol.DeclaredAccessibility == Accessibility.Internal;
}
private static void GeneratePropertyDefinition(IndentedTextWriter writer, IPropertySymbol propertySymbol)
{
if (propertySymbol.IsStatic)
{
return;
}
bool hasPublicGetter = propertySymbol.GetMethod is not null &&
IsPublicOrInternal(propertySymbol.GetMethod);
bool hasPublicSetter = propertySymbol.SetMethod is not null &&
IsPublicOrInternal(propertySymbol.SetMethod);
if (!hasPublicGetter && !hasPublicSetter)
{
return;
}
WriteMemberDocs(writer, propertySymbol);
if (propertySymbol.IsIndexer)
{
writer.Write("{0} this[", propertySymbol.Type);
writer.WriteJoin(", ", propertySymbol.Parameters, WriteMethodParam);
writer.Write("] ");
}
else
{
writer.Write("{0} {1} ", propertySymbol.Type, propertySymbol.Name); // ex. int Foo
}
writer.Write("{ ");
if (hasPublicGetter)
{
writer.Write("get; ");
}
if (hasPublicSetter)
{
if (propertySymbol.SetMethod!.IsInitOnly)
{
writer.Write("init; ");
}
else
{
writer.Write("set; ");
}
}
writer.WriteLine("}");
}
private static void GenerateMethodDefinition(IndentedTextWriter writer, IMethodSymbol methodSymbol)
{
if (methodSymbol.MethodKind != MethodKind.Ordinary || methodSymbol.IsStatic)
{
return;
}
if (methodSymbol.IsImplicitlyDeclared && methodSymbol.Name != "Deconstruct")
{
// omit methods that are auto generated by the compiler (eg. record's methods),
// except for the record Deconstruct method
return;
}
WriteMemberDocs(writer, methodSymbol);
writer.Write("{0} {1}", methodSymbol.ReturnType, methodSymbol.Name); // ex. int Foo
if (methodSymbol.IsGenericMethod)
{
writer.Write("<");
writer.WriteJoin(", ", methodSymbol.TypeParameters.Select(x => x.Name));
writer.Write(">");
}
writer.Write("(");
writer.WriteJoin(", ", methodSymbol.Parameters, WriteMethodParam);
writer.Write(")");
if (methodSymbol.IsGenericMethod)
{
WriteTypeParameterConstraints(writer, methodSymbol.TypeParameters);
}
writer.WriteLine(";");
}
private static void WriteMethodParam(TextWriter writer, IParameterSymbol param)
{
if (param.IsParams)
{
writer.Write("params ");
}
switch (param.RefKind)
{
case RefKind.Ref:
writer.Write("ref ");
break;
case RefKind.Out:
writer.Write("out ");
break;
case RefKind.In:
writer.Write("in ");
break;
}
writer.Write("{0} {1}", param.Type, param.Name);
if (param.HasExplicitDefaultValue)
{
WriteParamExplicitDefaultValue(writer, param);
}
}
private static void WriteParamExplicitDefaultValue(TextWriter writer, IParameterSymbol param)
{
if (param.ExplicitDefaultValue is null)
{
writer.Write(" = default");
}
else
{
switch (param.Type.Name)
{
case nameof(String):
writer.Write(" = \"{0}\"", param.ExplicitDefaultValue);
break;
case nameof(Single):
writer.Write(" = {0}f", param.ExplicitDefaultValue);
break;
case nameof(Double):
writer.Write(" = {0}d", param.ExplicitDefaultValue);
break;
case nameof(Decimal):
writer.Write(" = {0}m", param.ExplicitDefaultValue);
break;
case nameof(Boolean):
writer.Write(" = {0}", param.ExplicitDefaultValue.ToString().ToLower());
break;
default:
writer.Write(" = {0}", param.ExplicitDefaultValue);
break;
}
}
}
private static void WriteTypeParameterConstraints(
IndentedTextWriter writer,
IEnumerable<ITypeParameterSymbol> typeParameters)
{
foreach (var typeParameter in typeParameters)
{
var constraints = typeParameter.EnumGenericConstraints().ToList();
if (constraints.Count == 0)
{
break;
}
writer.Write(" where {0} : ", typeParameter.Name);
writer.WriteJoin(", ", constraints);
}
}
private void InitAttributes(Compilation compilation)
{
_generateAutoInterfaceAttribute = compilation.GetTypeByMetadataName(
$"{Attributes.AttributesNamespace}.{Attributes.GenerateAutoInterfaceClassname}")!;
_ignoreAttribute = compilation.GetTypeByMetadataName(
$"{Attributes.AttributesNamespace}.{Attributes.AutoInterfaceIgnoreAttributeClassname}")!;
}
private static IEnumerable<INamedTypeSymbol> GetImplTypeSymbols(Compilation compilation, SyntaxReceiver receiver)
{
return receiver.CandidateTypes.Select(candidate => GetTypeSymbol(compilation, candidate));
}
private static INamedTypeSymbol GetTypeSymbol(Compilation compilation, TypeDeclarationSyntax type)
{
var model = compilation.GetSemanticModel(type.SyntaxTree);
var typeSymbol = ModelExtensions.GetDeclaredSymbol(model, type)!;
return (INamedTypeSymbol)typeSymbol;
}
private static Compilation GetCompilation(GeneratorExecutionContext context)
{
var options = context.Compilation.SyntaxTrees.First().Options as CSharpParseOptions;
var compilation = context.Compilation.AddSyntaxTrees(
CSharpSyntaxTree.ParseText(
SourceText.From(Attributes.AttributesSourceCode, Encoding.UTF8), options));
return compilation;
}
}
}