-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy pathNamespaceBuilder.cs
More file actions
457 lines (400 loc) · 17.8 KB
/
NamespaceBuilder.cs
File metadata and controls
457 lines (400 loc) · 17.8 KB
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
using System;
using System.Collections.Generic;
using System.Linq;
using Optional;
using Optional.Collections;
namespace SharpCode
{
/// <summary>
/// Provides functionality for building namespaces. <see cref="NamespaceBuilder"/> instances are <b>not</b>
/// immutable.
/// </summary>
public class NamespaceBuilder
{
private static readonly AccessModifier[] AllowedMemberAccessModifiers = new AccessModifier[]
{
AccessModifier.None,
AccessModifier.Internal,
AccessModifier.Public,
};
private readonly List<ClassBuilder> _classes = new List<ClassBuilder>();
private readonly List<StructBuilder> _structs = new List<StructBuilder>();
private readonly List<InterfaceBuilder> _interfaces = new List<InterfaceBuilder>();
private readonly List<EnumBuilder> _enums = new List<EnumBuilder>();
internal NamespaceBuilder()
{
}
internal Namespace Namespace { get; private set; } = new Namespace(name: Option.None<string>());
/// <summary>
/// Sets the name of the namespace being built.
/// </summary>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="name"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// The specified <paramref name="name"/> is empty or invalid.
/// </exception>
public NamespaceBuilder WithName(string name)
{
if (name is null)
throw new ArgumentNullException(nameof(name));
if (string.IsNullOrWhiteSpace(name))
throw new ArgumentException("The interface name must be a valid, non-empty string.", nameof(name));
Namespace = Namespace.With(name: Option.Some(name));
return this;
}
/// <summary>
/// Adds a using directive to the namespace being built.
/// </summary>
/// <param name="usingDirective">
/// The using directive to be added, for example <c>"System"</c> or <c>"System.Collections.Generic"</c>
/// The semi-colon at the end is optional.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="usingDirective"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// The specified <paramref name="usingDirective"/> is empty or invalid.
/// </exception>
public NamespaceBuilder WithUsing(string usingDirective)
{
if (usingDirective is null)
throw new ArgumentNullException(nameof(usingDirective));
if (string.IsNullOrWhiteSpace(usingDirective))
throw new ArgumentException("The using directive must be a valid, non-empty string.", nameof(usingDirective));
Namespace.Usings.Add(usingDirective.Replace(";", string.Empty));
return this;
}
/// <summary>
/// Adds a class to the namespace being built.
/// </summary>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builder"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithClass(ClassBuilder builder)
{
if (builder is null)
throw new ArgumentNullException(nameof(builder));
_classes.Add(builder);
return this;
}
/// <summary>
/// Adds a bunch of classes to the namespace being built.
/// </summary>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithClasses(params ClassBuilder[] builders)
{
if (builders is null)
throw new ArgumentNullException(nameof(builders));
if (builders.Any(x => x is null))
throw new ArgumentException($"One of the {nameof(builders)} parameter values is null.");
_classes.AddRange(builders);
return this;
}
/// <summary>
/// Adds a bunch of classes to the namespace being built.
/// </summary>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithClasses(IEnumerable<ClassBuilder> builders)
{
if (builders is null)
throw new ArgumentNullException(nameof(builders));
if (builders.Any(x => x is null))
throw new ArgumentException("One of the builders is null.");
_classes.AddRange(builders);
return this;
}
/// <summary>
/// Adds an interface definition to the namespace being built.
/// </summary>
/// <param name="builder">
/// The configuration of the interface.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builder"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithInterface(InterfaceBuilder builder)
{
if (builder is null)
throw new ArgumentNullException(nameof(builder));
_interfaces.Add(builder);
return this;
}
/// <summary>
/// Adds a bunch of interface definitions to the namespace being built.
/// </summary>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithInterfaces(params InterfaceBuilder[] builders)
{
if (builders is null)
throw new ArgumentNullException(nameof(builders));
if (builders.Any(x => x is null))
throw new ArgumentException("One of the builders is null.");
_interfaces.AddRange(builders);
return this;
}
/// <summary>
/// Adds a bunch of interface definitions to the namespace being built.
/// </summary>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithInterfaces(IEnumerable<InterfaceBuilder> builders)
{
if (builders is null)
throw new ArgumentNullException(nameof(builders));
if (builders.Any(x => x is null))
throw new ArgumentException("One of the builders is null.");
_interfaces.AddRange(builders);
return this;
}
/// <summary>
/// Adds an enum definition to the namespace being built.
/// </summary>
/// <param name="builder">
/// The configuration of the enum.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builder"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithEnum(EnumBuilder builder)
{
if (builder is null)
throw new ArgumentNullException(nameof(builder));
_enums.Add(builder);
return this;
}
/// <summary>
/// Adds a bunch of enum definitions to the namespace being built.
/// </summary>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithEnums(params EnumBuilder[] builders)
{
if (builders is null)
throw new ArgumentNullException(nameof(builders));
if (builders.Any(x => x is null))
throw new ArgumentException("One of the builders is null.");
_enums.AddRange(builders);
return this;
}
/// <summary>
/// Adds a bunch of enum definitions to the namespace being built.
/// </summary>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithEnums(IEnumerable<EnumBuilder> builders)
{
if (builders is null)
throw new ArgumentNullException(nameof(builders));
if (builders.Any(x => x is null))
throw new ArgumentException("One of the builders is null.");
_enums.AddRange(builders);
return this;
}
/// <summary>
/// Adds a struct to the namespace.
/// </summary>
/// <param name="builder">
/// The configuration of the struct.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builder"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithStruct(StructBuilder builder)
{
if (builder is null)
throw new ArgumentNullException(nameof(builder));
_structs.Add(builder);
return this;
}
/// <summary>
/// Adds a bunch of structs to the namespace.
/// </summary>
/// <param name="builders">
/// A collection of structs which will be added to the namespace.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithStructs(params StructBuilder[] builders)
{
if (builders is null)
throw new ArgumentNullException(nameof(builders));
if (builders.Any(x => x is null))
throw new ArgumentException("One of the builders is null.");
_structs.AddRange(builders);
return this;
}
/// <summary>
/// Adds a bunch of structs to the namespace.
/// </summary>
/// <param name="builders">
/// A collection of structs which will be added to the namespace.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
public NamespaceBuilder WithStructs(IEnumerable<StructBuilder> builders)
{
if (builders is null)
throw new ArgumentNullException(nameof(builders));
if (builders.Any(x => x is null))
throw new ArgumentException("One of the builders is null.");
_structs.AddRange(builders);
return this;
}
/// <summary>
/// Checks whether the described member exists in the namespace structure.
/// </summary>
/// <param name="name">
/// The name of the member.
/// </param>
/// <param name="memberType">
/// The type of the member. By default all members will be taken into account.
/// </param>
/// <param name="accessModifier">
/// The access modifier of the member. By default all access modifiers will be taken into account.
/// </param>
/// <param name="comparison">
/// The comparision type to be performed when comparing the described name against the names of the actual
/// members. By default casing is ignored.
/// </param>
public bool HasMember(
string name,
MemberType? memberType = default,
AccessModifier? accessModifier = default,
StringComparison comparison = StringComparison.InvariantCultureIgnoreCase)
{
if (memberType == MemberType.Class)
{
return _classes
.Where(x => !accessModifier.HasValue || x.Class.AccessModifier == accessModifier)
.Any(x => x.Class.Name.Exists(n => n.Equals(name, comparison)));
}
if (memberType == MemberType.Enum)
{
return _enums
.Where(x => !accessModifier.HasValue || x.Enumeration.AccessModifier == accessModifier)
.Any(x => x.Enumeration.Name.Exists(n => n.Equals(name, comparison)));
}
if (memberType == MemberType.Interface)
{
return _interfaces
.Where(x => !accessModifier.HasValue || x.Interface.AccessModifier == accessModifier)
.Any(x => x.Interface.Name.Exists(n => n.Equals(name, comparison)));
}
if (memberType == MemberType.Struct)
{
return _structs
.Where(x => !accessModifier.HasValue || x.Struct.AccessModifier == accessModifier)
.Any(x => x.Struct.Name.Exists(n => n.Equals(name, comparison)));
}
if (memberType == MemberType.UsingStatement)
{
return Namespace.Usings.Any(x => x.Equals(name, comparison));
}
if (!memberType.HasValue)
{
return HasMember(name, MemberType.Class, accessModifier, comparison) ||
HasMember(name, MemberType.Enum, accessModifier, comparison) ||
HasMember(name, MemberType.Interface, accessModifier, comparison) ||
HasMember(name, MemberType.Struct, accessModifier, comparison) ||
HasMember(name, MemberType.UsingStatement, accessModifier, comparison);
}
return false;
}
/// <summary>
/// Returns the source code of the built namespace.
/// </summary>
/// <exception cref="MissingBuilderSettingException">
/// A setting that is required to build a valid class structure is missing.
/// </exception>
/// <exception cref="SyntaxException">
/// The class builder is configured in such a way that the resulting code would be invalid.
/// </exception>
public string ToSourceCode()
{
var build = Build();
var container = Ast.NamespaceContainer(build.Usings);
var @namespace = Ast.FromDefinition(build);
return Ast.Stringify(container.AddMembers(@namespace));
}
/// <summary>
/// Returns the source code of the built namespace.
/// </summary>
/// <exception cref="MissingBuilderSettingException">
/// A setting that is required to build a valid class structure is missing.
/// </exception>
/// <exception cref="SyntaxException">
/// The class builder is configured in such a way that the resulting code would be invalid.
/// </exception>
public override string ToString() =>
ToSourceCode();
internal Namespace Build()
{
if (string.IsNullOrWhiteSpace(Namespace.Name.ValueOr(string.Empty)))
{
throw new MissingBuilderSettingException(
"Providing the name of the namespace is required when building a namespace.");
}
Namespace.Classes.AddRange(_classes.Select(builder => builder.Build()));
Namespace.Classes
.FirstOrNone(item => !AllowedMemberAccessModifiers.Contains(item.AccessModifier))
.MatchSome(item => throw new SyntaxException(
"A class defined under a namespace cannot have the access modifier " +
$"'{item.AccessModifier}'."));
Namespace.Structs.AddRange(_structs.Select(builder => builder.Build()));
Namespace.Structs
.FirstOrNone(item => !AllowedMemberAccessModifiers.Contains(item.AccessModifier))
.MatchSome(item => throw new SyntaxException(
"A struct defined under a namespace cannot have the access modifier " +
$"'{item.AccessModifier}'."));
Namespace.Interfaces.AddRange(_interfaces.Select(builder => builder.Build()));
Namespace.Interfaces
.FirstOrNone(item => !AllowedMemberAccessModifiers.Contains(item.AccessModifier))
.MatchSome(item => throw new SyntaxException(
"An interface defined under a namespace cannot have the access modifier " +
$"'{item.AccessModifier}'."));
Namespace.Enums.AddRange(_enums.Select(builder => builder.Build()));
Namespace.Enums
.FirstOrNone(item => !AllowedMemberAccessModifiers.Contains(item.AccessModifier))
.MatchSome(item => throw new SyntaxException(
"An enum defined under a namespace cannot have the access modifier " +
$"'{item.AccessModifier}'."));
return Namespace;
}
}
}