Repository navigation
Expand file tree
/
Copy pathAsyncApiWriterBase.cs
More file actions
408 lines (357 loc) · 12.2 KB
/
Copy pathAsyncApiWriterBase.cs
File metadata and controls
408 lines (357 loc) · 12.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
// Copyright (c) The LEGO Group. All rights reserved.
namespace LEGO.AsyncAPI.Writers
{
using System;
using System.Collections.Generic;
using System.IO;
public abstract class AsyncApiWriterBase : IAsyncApiWriter
{
/// <summary>
/// The indentation string to prepand to each line for each indentation level.
/// </summary>
protected const string IndentationString = " ";
/// <summary>
/// Gets or sets settings for controlling how the AsyncApi document will be written out.
/// </summary>
public AsyncApiWriterSettings Settings { get; set; }
/// <summary>
/// Scope of the AsyncApi element - object, array, property.
/// </summary>
protected readonly Stack<Scope> Scopes;
/// <summary>
/// Number which specifies the level of indentation.
/// </summary>
private int indentLevel;
/// <summary>
/// Initializes a new instance of the <see cref="AsyncApiWriterBase"/> class.
/// </summary>
/// <param name="textWriter">The text writer.</param>
public AsyncApiWriterBase(TextWriter textWriter)
: this(textWriter, null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="AsyncApiWriterBase"/> class.
/// </summary>
/// <param name="textWriter"></param>
/// <param name="settings"></param>
public AsyncApiWriterBase(TextWriter textWriter, AsyncApiWriterSettings settings)
{
this.Writer = textWriter;
this.Writer.NewLine = "\n";
this.Scopes = new Stack<Scope>();
if (settings == null)
{
settings = new AsyncApiWriterSettings();
}
this.Settings = settings;
}
/// <summary>
/// Gets base Indentation Level.
/// This denotes how many indentations are needed for the property in the base object.
/// </summary>
protected abstract int BaseIndentation { get; }
/// <summary>
/// Gets the text writer.
/// </summary>
protected TextWriter Writer { get; }
/// <summary>
/// Write start object.
/// </summary>
public abstract void WriteStartObject();
/// <summary>
/// Write end object.
/// </summary>
public abstract void WriteEndObject();
/// <summary>
/// Write start array.
/// </summary>
public abstract void WriteStartArray();
/// <summary>
/// Write end array.
/// </summary>
public abstract void WriteEndArray();
/// <summary>
/// Write the start property.
/// </summary>
public abstract void WritePropertyName(string name);
/// <summary>
/// Writes a separator of a value if it's needed for the next value to be written.
/// </summary>
protected abstract void WriteValueSeparator();
/// <summary>
/// Write null value.
/// </summary>
public abstract void WriteNull();
/// <summary>
/// Write content raw value.
/// </summary>
public abstract void WriteRaw(string value);
/// <summary>
/// Flush the writer.
/// </summary>
public void Flush()
{
this.Writer.Flush();
}
/// <summary>
/// Write string value.
/// </summary>
/// <param name="value">The string value.</param>
public abstract void WriteValue(string value);
/// <summary>
/// Write float value.
/// </summary>
/// <param name="value">The float value.</param>
public virtual void WriteValue(float value)
{
this.WriteValueSeparator();
this.Writer.Write(value);
}
/// <summary>
/// Write double value.
/// </summary>
/// <param name="value">The double value.</param>
public virtual void WriteValue(double value)
{
this.WriteValueSeparator();
this.Writer.Write(value);
}
/// <summary>
/// Write decimal value.
/// </summary>
/// <param name="value">The decimal value.</param>
public virtual void WriteValue(decimal value)
{
this.WriteValueSeparator();
this.Writer.Write(value);
}
/// <summary>
/// Write integer value.
/// </summary>
/// <param name="value">The integer value.</param>
public virtual void WriteValue(int value)
{
this.WriteValueSeparator();
this.Writer.Write(value);
}
/// <summary>
/// Write long value.
/// </summary>
/// <param name="value">The long value.</param>
public virtual void WriteValue(long value)
{
this.WriteValueSeparator();
this.Writer.Write(value);
}
/// <summary>
/// Write DateTime value.
/// </summary>
/// <param name="value">The DateTime value.</param>
public virtual void WriteValue(DateTime value)
{
this.WriteValue(value.ToString(this.Settings.DateTimeFormat, this.Settings.CultureInfo));
}
/// <summary>
/// Write DateTimeOffset value.
/// </summary>
/// <param name="value">The DateTimeOffset value.</param>
public virtual void WriteValue(DateTimeOffset value)
{
this.WriteValue(value.ToString(this.Settings.DateTimeFormat, this.Settings.CultureInfo));
}
/// <summary>
/// Write boolean value.
/// </summary>
/// <param name="value">The boolean value.</param>
public virtual void WriteValue(bool value)
{
this.WriteValueSeparator();
this.Writer.Write(value.ToString().ToLower());
}
/// <summary>
/// Write object value.
/// </summary>
/// <param name="value">The object value.</param>
public virtual void WriteValue(object value)
{
if (value == null)
{
this.WriteNull();
return;
}
var type = value.GetType();
if (type == typeof(string))
{
this.WriteValue((string)(value));
}
else if (type == typeof(int) || type == typeof(int?))
{
this.WriteValue((int)value);
}
else if (type == typeof(long) || type == typeof(long?))
{
this.WriteValue((long)value);
}
else if (type == typeof(bool) || type == typeof(bool?))
{
this.WriteValue((bool)value);
}
else if (type == typeof(float) || type == typeof(float?))
{
this.WriteValue((float)value);
}
else if (type == typeof(double) || type == typeof(double?))
{
this.WriteValue((double)value);
}
else if (type == typeof(decimal) || type == typeof(decimal?))
{
this.WriteValue((decimal)value);
}
else if (type == typeof(DateTime) || type == typeof(DateTime?))
{
this.WriteValue((DateTime)value);
}
else if (type == typeof(DateTimeOffset) || type == typeof(DateTimeOffset?))
{
this.WriteValue((DateTimeOffset)value);
}
else
{
throw new AsyncApiWriterException(string.Format("The type '{0}' is not supported in AsyncApi document.", type.FullName));
}
}
/// <summary>
/// Increases the level of indentation applied to the output.
/// </summary>
public virtual void IncreaseIndentation()
{
this.indentLevel++;
}
/// <summary>
/// Decreases the level of indentation applied to the output.
/// </summary>
public virtual void DecreaseIndentation()
{
if (this.indentLevel == 0)
{
throw new AsyncApiWriterException("Indentation level cannot be lower than 0.");
}
if (this.indentLevel < 1)
{
this.indentLevel = 0;
}
else
{
this.indentLevel--;
}
}
/// <summary>
/// Write the indentation.
/// </summary>
public virtual void WriteIndentation()
{
for (var i = 0; i < (this.BaseIndentation + this.indentLevel - 1); i++)
{
this.Writer.Write(IndentationString);
}
}
/// <summary>
/// Get current scope.
/// </summary>
/// <returns></returns>
protected Scope CurrentScope()
{
return this.Scopes.Count == 0 ? null : this.Scopes.Peek();
}
/// <summary>
/// Start the scope given the scope type.
/// </summary>
/// <param name="type">The scope type to start.</param>
protected Scope StartScope(ScopeType type)
{
if (this.Scopes.Count != 0)
{
var currentScope = this.Scopes.Peek();
currentScope.ObjectCount++;
}
var scope = new Scope(type);
this.Scopes.Push(scope);
return scope;
}
/// <summary>
/// End the scope of the given scope type.
/// </summary>
/// <param name="type"></param>
/// <returns></returns>
protected Scope EndScope(ScopeType type)
{
if (this.Scopes.Count == 0)
{
throw new AsyncApiWriterException("Scope must be present to end.");
}
if (this.Scopes.Peek().Type != type)
{
throw new AsyncApiWriterException(
string.Format(
"The scope to end is expected to be of type '{0}' but it is of type '{1}'.",
type,
this.Scopes.Peek().Type));
}
return this.Scopes.Pop();
}
/// <summary>
/// Whether the current scope is the top level (outermost) scope.
/// </summary>
protected bool IsTopLevelScope()
{
return this.Scopes.Count == 1;
}
/// <summary>
/// Whether the current scope is an object scope.
/// </summary>
protected bool IsObjectScope()
{
return this.IsScopeType(ScopeType.Object);
}
/// <summary>
/// Whether the current scope is an array scope.
/// </summary>
/// <returns></returns>
protected bool IsArrayScope()
{
return this.IsScopeType(ScopeType.Array);
}
private bool IsScopeType(ScopeType type)
{
if (this.Scopes.Count == 0)
{
return false;
}
return this.Scopes.Peek().Type == type;
}
/// <summary>
/// Verifies whether a property name can be written based on whether
/// the property name is a valid string and whether the current scope is an object scope.
/// </summary>
/// <param name="name">property name.</param>
protected void VerifyCanWritePropertyName(string name)
{
if (string.IsNullOrWhiteSpace(name))
{
throw new ArgumentException($"'{nameof(name)}' cannot be null or whitespace.", nameof(name));
}
if (this.Scopes.Count == 0)
{
throw new AsyncApiWriterException(
string.Format("There must be an active scope for name '{0}' to be written.", name));
}
if (this.Scopes.Peek().Type != ScopeType.Object)
{
throw new AsyncApiWriterException(
string.Format("The active scope must be an object scope for property name '{0}' to be written.", name));
}
}
}
}