-
Notifications
You must be signed in to change notification settings - Fork 368
/
PlainTextFormatter.cs
399 lines (324 loc) · 12.1 KB
/
PlainTextFormatter.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
// Copyright (c) .NET Foundation and contributors. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Dynamic;
using System.IO;
using System.Linq;
using System.Numerics;
using System.Reflection;
using System.Text.Encodings.Web;
using System.Text.Json;
using System.Text.RegularExpressions;
using System.Threading;
using Microsoft.AspNetCore.Html;
using Microsoft.DotNet.Interactive.CSharp;
using Pocket;
namespace Microsoft.DotNet.Interactive.Formatting;
public static class PlainTextFormatter
{
public const string MimeType = "text/plain";
public static ITypeFormatter GetPreferredFormatterFor(Type type) =>
Formatter.GetPreferredFormatterFor(type, MimeType);
public static ITypeFormatter GetPreferredFormatterFor<T>() =>
GetPreferredFormatterFor(typeof(T));
private const int NumberOfSpacesToIndent = 2;
internal static ITypeFormatter GetDefaultFormatterForAnyObject(Type type, bool includeInternals = false) =>
FormattersForAnyObject.GetOrCreateFormatterForType(type);
internal static FormatDelegate<T> CreateFormatDelegate<T>(MemberInfo[] forMembers)
{
var accessors = forMembers.GetMemberAccessors<T>().ToArray();
if (Formatter<T>.TypeIsValueTuple ||
Formatter<T>.TypeIsTuple)
{
return FormatTuple;
}
if (typeof(T).IsEnum)
{
return (enumValue, context) =>
{
context.Writer.Write(enumValue.ToString());
return true;
};
}
var formatEnumerableValues = typeof(T).IsEnumerable();
var shouldOnlyDisplayEnumerableValues = formatEnumerableValues &&
!typeof(T).ShouldIncludePropertiesInOutput();
if (!shouldOnlyDisplayEnumerableValues && accessors.Length == 0)
{
// If we haven't got any members to show, just resort to ToString()
return FormatUsingToString;
}
return FormatObject;
bool FormatUsingToString(T target, FormatContext context)
{
context.Writer.Write(target.ToString());
return true;
}
bool FormatObject(T target, FormatContext context)
{
if (accessors.Length > 0 && !shouldOnlyDisplayEnumerableValues)
{
if (!context.IsStartingObjectWithinSequence)
{
var type = target.GetType();
type.WriteCSharpDeclarationTo(context.Writer, true);
context.Writer.WriteLine();
}
for (var i = 0; i < accessors.Length; i++)
{
var accessor = accessors[i];
object value = accessor.GetValueOrException(target);
WriteStartProperty(context);
context.Writer.Write(accessor.MemberName);
context.Writer.Write(": ");
value.FormatTo(context, MimeType);
if (i < accessors.Length - 1 && !formatEnumerableValues)
{
context.Writer.WriteLine();
}
}
}
if (formatEnumerableValues)
{
if (!shouldOnlyDisplayEnumerableValues)
{
context.Writer.WriteLine();
WriteStartProperty(context);
context.Writer.Write("(values)");
context.Writer.Write(": ");
}
var formatter = FormattersForAnyEnumerable.GetOrCreateFormatterForType(typeof(T));
formatter.Format(target, context);
}
return true;
}
bool FormatTuple(T target, FormatContext context)
{
if (Formatter<T>.TypeIsTupleOfScalars)
{
context.Writer.Write("( ");
for (var i = 0; i < accessors.Length; i++)
{
var value = accessors[i].GetValueOrException(target);
value.FormatTo(context, MimeType);
if (i < accessors.Length - 1)
{
context.Writer.Write(", ");
}
}
context.Writer.Write(" )");
}
else
{
for (var i = 0; i < accessors.Length; i++)
{
var value = accessors[i].GetValueOrException(target);
context.IsStartingObjectWithinSequence = true;
WriteStartProperty(context);
value.FormatTo(context, MimeType);
context.IsStartingObjectWithinSequence = true;
if (i < accessors.Length - 1)
{
context.Writer.WriteLine();
}
}
}
return true;
}
}
internal static FormatterMapByType FormattersForAnyObject =
new(typeof(PlainTextFormatter<>), nameof(PlainTextFormatter<object>.CreateForAnyObject));
internal static FormatterMapByType FormattersForAnyEnumerable =
new(typeof(PlainTextFormatter<>), nameof(PlainTextFormatter<object>.CreateForAnyEnumerable));
internal static ITypeFormatter[] DefaultFormatters =
{
new PlainTextFormatter<Exception>((exception, context) =>
{
context.Writer.Write(exception.ToString().IndentAtNewLines(context));
return true;
}),
new PlainTextFormatter<ExpandoObject>((expando, context) =>
{
var pairs = expando.ToArray();
var length = pairs.Length;
for (var i = 0; i < length; i++)
{
var pair = pairs[i];
context.Writer.Write(pair.Key);
context.Writer.Write(": ");
pair.Value.FormatTo(context, MimeType);
if (i < length - 1)
{
context.Writer.WriteLine();
}
}
return true;
}),
new PlainTextFormatter<IHtmlContent>((view, context) =>
{
view.WriteTo(context.Writer, HtmlEncoder.Default);
return true;
}),
new PlainTextFormatter<KeyValuePair<string, object>>((pair, context) =>
{
context.Writer.Write(pair.Key);
context.Writer.Write(": ");
pair.Value.FormatTo(context, MimeType);
return true;
}),
new PlainTextFormatter<ReadOnlyMemory<char>>((memory, context) =>
{
context.Writer.Write(memory.Span.ToString());
return true;
}),
new PlainTextFormatter<Type>((type, context) =>
{
if (type.IsAnonymous())
{
context.Writer.Write("(anonymous)");
return true;
}
type.WriteCSharpDeclarationTo(context.Writer);
return true;
}),
new PlainTextFormatter<DateTime>((value, context) =>
{
context.Writer.Write(value.ToString("u"));
return true;
}),
new PlainTextFormatter<DateTimeOffset>((value, context) =>
{
context.Writer.Write(value.ToString("u"));
return true;
}),
new AnonymousTypeFormatter<object>(type: typeof(ReadOnlyMemory<>),
mimeType: MimeType,
format: ( obj, context) =>
{
var actualType = obj.GetType();
var toArray = Formatter.FormatReadOnlyMemoryMethod.MakeGenericMethod
(actualType.GetGenericArguments());
var array = toArray.Invoke(null, new[] { obj });
array.FormatTo(context, PlainTextFormatter.MimeType);
return true;
}),
new PlainTextFormatter<JsonElement>((obj, context) =>
{
context.Writer.Write(obj);
return true;
}),
// BigInteger should be displayed as plain text
new PlainTextFormatter<BigInteger>((value, context) =>
{
value.FormatTo(context, PlainTextFormatter.MimeType);
return true;
}),
// Decimal should be displayed as plain text
new PlainTextFormatter<decimal>((value, context) =>
{
value.FormatTo(context, PlainTextFormatter.MimeType);
return true;
}),
// Fallback for any object
new PlainTextFormatter<object>((obj, context) =>
{
if (obj is null)
{
context.Writer.Write(Formatter.NullString);
return true;
}
var type = obj.GetType();
var formatter = GetDefaultFormatterForAnyObject(type);
return formatter.Format(obj, context);
})
};
private static string IndentAtNewLines(this string s, FormatContext context) =>
Regex.Replace(s, @"^\s+", new string(' ', (context.Depth + 1) * NumberOfSpacesToIndent), RegexOptions.Multiline);
internal static void WriteIndent(FormatContext context, string bonus = " ")
{
var effectiveIndent = context.Depth * NumberOfSpacesToIndent;
var indent = new string(' ', effectiveIndent);
context.Writer.Write(indent);
context.Writer.Write(bonus);
}
public static void WriteStartProperty(FormatContext context)
{
if (context.IsStartingObjectWithinSequence)
{
WriteIndent(context, " - ");
context.IsStartingObjectWithinSequence = false;
}
else
{
WriteIndent(context);
}
}
internal static void Join(
IEnumerable list,
TextWriter writer,
FormatContext context) =>
JoinGeneric(list.Cast<object>(), writer, context);
internal static void JoinGeneric<T>(
IEnumerable<T> seq,
TextWriter writer,
FormatContext context)
{
if (seq is null)
{
writer.Write(Formatter.NullString);
return;
}
var singleLine = Formatter<T>.TypeIsScalar || !context.AllowRecursion;
if (singleLine)
{
context.Writer.Write("[ ");
}
else
{
seq.GetType().WriteCSharpDeclarationTo(context.Writer, true);
context.Writer.WriteLine();
}
var listExpansionLimit = Formatter<T>.ListExpansionLimit;
var (itemsToWrite, remainingCount) = seq.TakeAndCountRemaining(listExpansionLimit);
for (var i = 0; i < itemsToWrite.Count; i++)
{
var item = itemsToWrite[i];
if (i < listExpansionLimit)
{
if (i > 0)
{
if (singleLine)
{
context.Writer.Write(", ");
}
else
{
context.Writer.WriteLine();
}
}
context.IsStartingObjectWithinSequence = true;
if (!singleLine && typeof(T) == typeof(object))
{
WriteIndent(context, " - ");
}
item.FormatTo(context, MimeType);
context.IsStartingObjectWithinSequence = false;
}
}
if (remainingCount != 0)
{
writer.Write(" ... (");
if (remainingCount is { })
{
writer.Write($"{remainingCount} ");
}
writer.Write("more)");
}
if (singleLine)
{
context.Writer.Write(" ]");
}
}
}