forked from ful-stackz/SharpCode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInterfaceBuilder.cs
More file actions
247 lines (221 loc) · 8.86 KB
/
InterfaceBuilder.cs
File metadata and controls
247 lines (221 loc) · 8.86 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
using System;
using System.Collections.Generic;
using System.Linq;
using Optional;
namespace SharpCode
{
/// <summary>
/// Provides functionality for building interface structures. <see cref="InterfaceBuilder"/> instances are
/// <b>not</b> immutable.
/// </summary>
public class InterfaceBuilder
{
private readonly List<PropertyBuilder> _properties = new List<PropertyBuilder>();
internal InterfaceBuilder()
{
}
internal InterfaceBuilder(string name, AccessModifier accessModifier)
{
Interface = new Interface(accessModifier, Option.Some(name));
}
internal Interface Interface { get; private set; } = new Interface(AccessModifier.Public);
/// <summary>
/// Sets the access modifier of the interface being built.
/// </summary>
public InterfaceBuilder WithAccessModifier(AccessModifier accessModifier)
{
Interface = Interface.With(accessModifier: Option.Some(accessModifier));
return this;
}
/// <summary>
/// Sets the name of the interface being built.
/// </summary>
public InterfaceBuilder WithName(string name)
{
Interface = Interface.With(name: Option.Some(name));
return this;
}
/// <summary>
/// Adds a property to the interface being built.
/// </summary>
public InterfaceBuilder WithProperty(PropertyBuilder builder)
{
_properties.Add(builder);
return this;
}
/// <summary>
/// Adds a bunch of properties to the interface being built.
/// </summary>
public InterfaceBuilder WithProperties(params PropertyBuilder[] builders)
{
_properties.AddRange(builders);
return this;
}
/// <summary>
/// Adds a bunch of properties to the interface being built.
/// </summary>
public InterfaceBuilder WithProperties(IEnumerable<PropertyBuilder> builders)
{
_properties.AddRange(builders);
return this;
}
/// <summary>
/// Adds an interface to the list of interfaces that the interface implements.
/// </summary>
/// <param name="name">
/// The name of the interface that the interface implements.
/// </param>
/// <exception cref="ArgumentNullException">
/// The specified <paramref name="name"/> is <c>null</c>.
/// </exception>
public InterfaceBuilder WithImplementedInterface(string name)
{
if (name is null)
{
throw new ArgumentNullException(nameof(name));
}
Interface.ImplementedInterfaces.Add(name);
return this;
}
/// <summary>
/// Adds a bunch of interfaces to the list of interfaces that the interface implements.
/// </summary>
/// <param name="names">
/// A collection with the names of interfaces that the interface 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 InterfaceBuilder 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.");
}
Interface.ImplementedInterfaces.AddRange(names);
return this;
}
/// <summary>
/// Adds a bunch of interfaces to the list of interfaces that the interface implements.
/// </summary>
/// <param name="names">
/// A collection with the names of interfaces that the interface implements.
/// </param>
/// <exception cref="ArgumentException">
/// One of the specified <paramref name="names"/> is <c>null</c>.
/// </exception>
public InterfaceBuilder WithImplementedInterfaces(params string[] names)
{
if (names.Any(x => x is null))
{
throw new ArgumentException("One of the names is null.");
}
Interface.ImplementedInterfaces.AddRange(names);
return this;
}
/// <summary>
/// Adds XML summary documentation to the interface.
/// </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 InterfaceBuilder WithSummary(string summary)
{
if (summary is null)
{
throw new ArgumentNullException(nameof(summary));
}
Interface = Interface.With(summary: Option.Some(summary));
return this;
}
/// <summary>
/// Checks whether the described member exists in the interface 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="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,
StringComparison comparison = StringComparison.InvariantCultureIgnoreCase)
{
if (memberType == MemberType.Property)
{
return _properties.Any(x => x.Property.Name.Exists(n => n.Equals(name, comparison)));
}
if (!memberType.HasValue)
{
return HasMember(name, MemberType.Property, comparison);
}
return false;
}
/// <summary>
/// Returns the source code of the built interface.
/// </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 interface.
/// </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 Interface Build()
{
if (string.IsNullOrWhiteSpace(Interface.Name.ValueOr(string.Empty)))
{
throw new MissingBuilderSettingException(
"Providing the name of the interface is required when building an interface.");
}
Interface.Properties.AddRange(
_properties.Select(builder => builder
.WithAccessModifier(AccessModifier.None)
.Build()));
if (Interface.Properties.Any(prop => prop.DefaultValue.HasValue))
{
throw new SyntaxException("Interface properties cannot have a default value. (CS8053)");
}
else if (Interface.Properties.Any(prop => !prop.Getter.HasValue && !prop.Setter.HasValue))
{
throw new SyntaxException("Interface properties should have at least a getter or a setter.");
}
else if (Interface.Properties.Any(prop => prop.Getter.Exists(expr => !expr.Equals(Property.AutoGetterSetter))))
{
throw new SyntaxException("Interface properties can only define an auto implemented getter.");
}
else if (Interface.Properties.Any(prop => prop.Setter.Exists(expr => !expr.Equals(Property.AutoGetterSetter))))
{
throw new SyntaxException("Interface properties can only define an auto implemented setter.");
}
return Interface;
}
}
}