forked from ful-stackz/SharpCode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathStructBuilder.cs
More file actions
408 lines (365 loc) · 14.2 KB
/
StructBuilder.cs
File metadata and controls
408 lines (365 loc) · 14.2 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
using System;
using System.Collections.Generic;
using System.Linq;
using Optional;
using Optional.Collections;
namespace SharpCode
{
/// <summary>
/// Provides functionality for building structs. <see cref="StructBuilder"/> instances are <b>not</b>
/// immutable.
/// </summary>
public class StructBuilder
{
private readonly List<ConstructorBuilder> _constructors = new List<ConstructorBuilder>();
private readonly List<FieldBuilder> _fields = new List<FieldBuilder>();
private readonly List<PropertyBuilder> _properties = new List<PropertyBuilder>();
internal StructBuilder()
{
}
internal StructBuilder(string name, AccessModifier accessModifier)
{
Struct = new Struct(accessModifier, name: Option.Some(name));
}
internal Struct Struct { get; private set; } = new Struct(AccessModifier.Public);
/// <summary>
/// Sets the access modifier of the struct.
/// </summary>
/// <param name="accessModifier">
/// The access modifier of the struct.
/// </param>
public StructBuilder WithAccessModifier(AccessModifier accessModifier)
{
Struct = Struct.With(accessModifier: Option.Some(accessModifier));
return this;
}
/// <summary>
/// Sets the name of the struct.
/// </summary>
/// <param name="name">
/// The name of the struct.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="name"/> is <c>null</c>.
/// </exception>
public StructBuilder WithName(string name)
{
if (name is null)
{
throw new ArgumentNullException(nameof(name));
}
Struct = Struct.With(name: Option.Some(name));
return this;
}
/// <summary>
/// Adds XML summary documentation to the struct.
/// </summary>
/// <param name="summary">
/// The content of the summary documentation.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="summary"/> is <c>null</c>.
/// </exception>
public StructBuilder WithSummary(string summary)
{
if (summary is null)
{
throw new ArgumentNullException(nameof(summary));
}
Struct = Struct.With(summary: Option.Some(summary));
return this;
}
/// <summary>
/// Adds a constructor to the struct.
/// </summary>
/// <param name="builder">
/// The configuration of the constructor.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builder"/> is <c>null</c>.
/// </exception>
public StructBuilder WithConstructor(ConstructorBuilder builder)
{
if (builder is null)
{
throw new ArgumentNullException(nameof(builder));
}
_constructors.Add(builder);
return this;
}
/// <summary>
/// Adds a field to the struct.
/// </summary>
/// <param name="builder">
/// The configuration of the field.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builder"/> is <c>null</c>.
/// </exception>
public StructBuilder WithField(FieldBuilder builder)
{
if (builder is null)
{
throw new ArgumentNullException(nameof(builder));
}
_fields.Add(builder);
return this;
}
/// <summary>
/// Adds a bunch of fields to the struct.
/// </summary>
/// <param name="builders">
/// A collection of fields.
/// </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 StructBuilder WithFields(IEnumerable<FieldBuilder> 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.");
}
_fields.AddRange(builders);
return this;
}
/// <summary>
/// Adds a bunch of fields to the struct.
/// </summary>
/// <param name="builders">
/// A collection of fields.
/// </param>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
public StructBuilder WithFields(params FieldBuilder[] builders)
{
if (builders.Any(x => x is null))
{
throw new ArgumentException("One of the builders is null.");
}
_fields.AddRange(builders);
return this;
}
/// <summary>
/// Adds a property to the struct.
/// </summary>
/// <param name="builder">
/// The configuration of the property.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="builder"/> is <c>null</c>.
/// </exception>
public StructBuilder WithProperty(PropertyBuilder builder)
{
if (builder is null)
{
throw new ArgumentNullException(nameof(builder));
}
_properties.Add(builder);
return this;
}
/// <summary>
/// Adds a bunch of properties to the struct.
/// </summary>
/// <param name="builders">
/// A collection of properties.
/// </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 StructBuilder WithProperties(IEnumerable<PropertyBuilder> 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.");
}
_properties.AddRange(builders);
return this;
}
/// <summary>
/// Adds a bunch of properties to the struct.
/// </summary>
/// <param name="builders">
/// A collection of properties.
/// </param>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="builders"/> is <c>null</c>.
/// </exception>
public StructBuilder WithProperties(params PropertyBuilder[] builders)
{
if (builders.Any(x => x is null))
{
throw new ArgumentException("One of the builders is null.");
}
_properties.AddRange(builders);
return this;
}
/// <summary>
/// Adds an interface to the list of interfaces that the struct implements.
/// </summary>
/// <param name="name">
/// The name of the interface that the struct implements.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="name"/> is <c>null</c>.
/// </exception>
public StructBuilder WithImplementedInterface(string name)
{
if (name is null)
{
throw new ArgumentNullException(nameof(name));
}
Struct.ImplementedInterfaces.Add(name);
return this;
}
/// <summary>
/// Adds a bunch of interfaces to the list of interfaces that the struct implements.
/// </summary>
/// <param name="names">
/// A collection with the names of interfaces that the struct implements.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="names"/> is <c>null</c>.
/// </exception>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="names"/> is <c>null</c>.
/// </exception>
public StructBuilder WithImplementedInterfaces(IEnumerable<string> names)
{
if (names is null)
{
throw new ArgumentNullException(nameof(names));
}
if (names.Any(x => x is null))
{
throw new ArgumentException("One of the names is null.");
}
Struct.ImplementedInterfaces.AddRange(names);
return this;
}
/// <summary>
/// Adds a bunch of interfaces to the list of interfaces that the struct implements.
/// </summary>
/// <param name="names">
/// A collection with the names of interfaces that the struct implements.
/// </param>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="names"/> is <c>null</c>.
/// </exception>
public StructBuilder WithImplementedInterfaces(params string[] names)
{
if (names.Any(x => x is null))
{
throw new ArgumentException("One of the names is null.");
}
Struct.ImplementedInterfaces.AddRange(names);
return this;
}
/// <summary>
/// Checks whether the described member exists in the struct 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.Field)
{
return _fields
.Where(x => !accessModifier.HasValue || x.Field.AccessModifier == accessModifier)
.Any(x => x.Field.Name.Exists(n => n.Equals(name, comparison)));
}
if (memberType == MemberType.Property)
{
return _properties
.Where(x => !accessModifier.HasValue || x.Property.AccessModifier == accessModifier)
.Any(x => x.Property.Name.Exists(n => n.Equals(name, comparison)));
}
if (!memberType.HasValue)
{
return HasMember(name, MemberType.Field, accessModifier, comparison) ||
HasMember(name, MemberType.Property, accessModifier, comparison);
}
return false;
}
/// <summary>
/// Returns the source code of the built struct.
/// </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() =>
Ast.Stringify(Ast.FromDefinition(Build()));
/// <summary>
/// Returns the source code of the built struct.
/// </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 Struct Build()
{
var structName = Struct.Name.ValueOr(string.Empty);
if (string.IsNullOrWhiteSpace(structName))
{
throw new MissingBuilderSettingException(
"Providing the name of the struct is required when building a struct.");
}
Struct.ImplementedInterfaces
.FirstOrNone(x => string.IsNullOrWhiteSpace(x))
.MatchSome(_ => throw new MissingBuilderSettingException(
"Providing the name of the interface is required when adding an implemented interface to a struct."));
Struct.Fields.AddRange(_fields.Select(field => field.Build()));
Struct.Properties.AddRange(_properties.Select(prop => prop.Build()));
Struct.Properties
.FirstOrNone(x => x.DefaultValue.HasValue)
.MatchSome(prop => throw new SyntaxException(
"Default property values are not allowed in structs. (CS0573)"));
Struct.Constructors.AddRange(
_constructors.Select(ctor => ctor
.WithName(structName)
.Build()));
Struct.Constructors
.FirstOrNone(x => !x.Parameters.Any())
.MatchSome(ctor => throw new SyntaxException(
"Explicit parameterless contructors are not allowed in structs. (CS0568)"));
return Struct;
}
}
}