-
Notifications
You must be signed in to change notification settings - Fork 4k
/
Formatter.cs
379 lines (325 loc) · 25.4 KB
/
Formatter.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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.Editing;
using Microsoft.CodeAnalysis.Formatting.Rules;
using Microsoft.CodeAnalysis.Host;
using Microsoft.CodeAnalysis.Options;
using Microsoft.CodeAnalysis.OrganizeImports;
using Microsoft.CodeAnalysis.Shared.Extensions;
using Microsoft.CodeAnalysis.Text;
using Roslyn.Utilities;
using static Microsoft.CodeAnalysis.Formatting.FormattingExtensions;
namespace Microsoft.CodeAnalysis.Formatting
{
/// <summary>
/// Formats whitespace in documents or syntax trees.
/// </summary>
public static class Formatter
{
/// <summary>
/// The annotation used to mark portions of a syntax tree to be formatted.
/// </summary>
public static SyntaxAnnotation Annotation { get; } = new SyntaxAnnotation();
/// <summary>
/// Gets the formatting rules that would be applied if left unspecified.
/// </summary>
internal static ImmutableArray<AbstractFormattingRule> GetDefaultFormattingRules(Document document)
=> GetDefaultFormattingRules(document.Project.Services);
internal static ImmutableArray<AbstractFormattingRule> GetDefaultFormattingRules(LanguageServices languageServices)
=> languageServices.GetService<ISyntaxFormattingService>()?.GetDefaultFormattingRules() ?? ImmutableArray<AbstractFormattingRule>.Empty;
/// <summary>
/// Formats the whitespace in a document.
/// </summary>
/// <param name="document">The document to format.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the document's workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The formatted document.</returns>
public static Task<Document> FormatAsync(Document document, OptionSet? options = null, CancellationToken cancellationToken = default)
#pragma warning disable RS0030 // Do not used banned APIs
=> FormatAsync(document, spans: null, options: options, cancellationToken: cancellationToken);
#pragma warning restore
internal static Task<Document> FormatAsync(Document document, SyntaxFormattingOptions options, CancellationToken cancellationToken)
=> FormatAsync(document, spans: null, options, rules: null, cancellationToken);
/// <summary>
/// Formats the whitespace in an area of a document corresponding to a text span.
/// </summary>
/// <param name="document">The document to format.</param>
/// <param name="span">The span of the document's text to format.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the document's workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The formatted document.</returns>
public static Task<Document> FormatAsync(Document document, TextSpan span, OptionSet? options = null, CancellationToken cancellationToken = default)
#pragma warning disable RS0030 // Do not used banned APIs
=> FormatAsync(document, SpecializedCollections.SingletonEnumerable(span), options, cancellationToken);
#pragma warning restore
internal static Task<Document> FormatAsync(Document document, TextSpan span, SyntaxFormattingOptions options, CancellationToken cancellationToken)
=> FormatAsync(document, SpecializedCollections.SingletonEnumerable(span), options, rules: null, cancellationToken);
/// <summary>
/// Formats the whitespace in areas of a document corresponding to multiple non-overlapping spans.
/// </summary>
/// <param name="document">The document to format.</param>
/// <param name="spans">The spans of the document's text to format.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the document's workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The formatted document.</returns>
public static async Task<Document> FormatAsync(Document document, IEnumerable<TextSpan>? spans, OptionSet? options = null, CancellationToken cancellationToken = default)
{
var formattingService = document.GetLanguageService<IFormattingService>();
if (formattingService == null)
{
return document;
}
var (syntaxFormattingOptions, lineFormattingOptions) = await GetFormattingOptionsAsync(document, options, cancellationToken).ConfigureAwait(false);
return await formattingService.FormatAsync(document, spans, lineFormattingOptions, syntaxFormattingOptions, cancellationToken).ConfigureAwait(false);
}
internal static async Task<Document> FormatAsync(Document document, IEnumerable<TextSpan>? spans, SyntaxFormattingOptions options, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken)
{
var root = await document.GetRequiredSyntaxRootAsync(cancellationToken).ConfigureAwait(false);
var services = document.Project.Solution.Services;
return document.WithSyntaxRoot(Format(root, spans, services, options, rules, cancellationToken));
}
/// <summary>
/// Formats the whitespace in areas of a document corresponding to annotated nodes.
/// </summary>
/// <param name="document">The document to format.</param>
/// <param name="annotation">The annotation used to find on nodes to identify spans to format.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the document's workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The formatted document.</returns>
public static Task<Document> FormatAsync(Document document, SyntaxAnnotation annotation, OptionSet? options = null, CancellationToken cancellationToken = default)
=> FormatAsync(document, annotation, options, rules: null, cancellationToken: cancellationToken);
internal static Task<Document> FormatAsync(Document document, SyntaxAnnotation annotation, SyntaxFormattingOptions options, CancellationToken cancellationToken)
=> FormatAsync(document, annotation, options, rules: null, cancellationToken);
internal static async Task<Document> FormatAsync(Document document, SyntaxAnnotation annotation, SyntaxFormattingOptions options, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken)
{
var root = await document.GetRequiredSyntaxRootAsync(cancellationToken).ConfigureAwait(false);
var services = document.Project.Solution.Services;
return document.WithSyntaxRoot(Format(root, annotation, services, options, rules, cancellationToken));
}
internal static async Task<Document> FormatAsync(Document document, SyntaxAnnotation annotation, OptionSet? optionSet, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken)
{
if (document == null)
{
throw new ArgumentNullException(nameof(document));
}
if (annotation == null)
{
throw new ArgumentNullException(nameof(annotation));
}
var root = await document.GetRequiredSyntaxRootAsync(cancellationToken).ConfigureAwait(false);
var services = document.Project.Solution.Services;
// must have syntax formatting options since we require the document to have a syntax tree:
var (formattingOptions, _) = await GetFormattingOptionsAsync(document, optionSet, cancellationToken).ConfigureAwait(false);
Contract.ThrowIfNull(formattingOptions);
return document.WithSyntaxRoot(Format(root, annotation, services, formattingOptions, rules, cancellationToken));
}
/// <summary>
/// Formats the whitespace in areas of a syntax tree corresponding to annotated nodes.
/// </summary>
/// <param name="node">The root node of a syntax tree to format.</param>
/// <param name="annotation">The annotation used to find nodes to identify spans to format.</param>
/// <param name="workspace">A workspace used to give the formatting context.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The formatted tree's root node.</returns>
public static SyntaxNode Format(SyntaxNode node, SyntaxAnnotation annotation, Workspace workspace, OptionSet? options = null, CancellationToken cancellationToken = default)
=> Format(node, annotation, workspace, options, rules: null, cancellationToken);
internal static SyntaxNode Format(SyntaxNode node, SyntaxAnnotation annotation, SolutionServices services, SyntaxFormattingOptions options, CancellationToken cancellationToken)
=> Format(node, annotation, services, options, rules: null, cancellationToken);
private static SyntaxNode Format(SyntaxNode node, SyntaxAnnotation annotation, Workspace workspace, OptionSet? options, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken)
{
if (workspace == null)
{
throw new ArgumentNullException(nameof(workspace));
}
if (node == null)
{
throw new ArgumentNullException(nameof(node));
}
if (annotation == null)
{
throw new ArgumentNullException(nameof(annotation));
}
return Format(node, GetAnnotatedSpans(node, annotation), workspace, options, rules, cancellationToken);
}
internal static SyntaxNode Format(SyntaxNode node, SyntaxAnnotation annotation, SolutionServices services, SyntaxFormattingOptions options, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken)
=> Format(node, GetAnnotatedSpans(node, annotation), services, options, rules, cancellationToken);
/// <summary>
/// Formats the whitespace of a syntax tree.
/// </summary>
/// <param name="node">The root node of a syntax tree to format.</param>
/// <param name="workspace">A workspace used to give the formatting context.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The formatted tree's root node.</returns>
public static SyntaxNode Format(SyntaxNode node, Workspace workspace, OptionSet? options = null, CancellationToken cancellationToken = default)
=> Format(node, SpecializedCollections.SingletonEnumerable(node.FullSpan), workspace, options, rules: null, cancellationToken);
internal static SyntaxNode Format(SyntaxNode node, SolutionServices services, SyntaxFormattingOptions options, CancellationToken cancellationToken)
=> Format(node, SpecializedCollections.SingletonEnumerable(node.FullSpan), services, options, rules: null, cancellationToken);
/// <summary>
/// Formats the whitespace in areas of a syntax tree identified by a span.
/// </summary>
/// <param name="node">The root node of a syntax tree to format.</param>
/// <param name="span">The span within the node's full span to format.</param>
/// <param name="workspace">A workspace used to give the formatting context.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The formatted tree's root node.</returns>
public static SyntaxNode Format(SyntaxNode node, TextSpan span, Workspace workspace, OptionSet? options = null, CancellationToken cancellationToken = default)
=> Format(node, SpecializedCollections.SingletonEnumerable(span), workspace, options, rules: null, cancellationToken: cancellationToken);
internal static SyntaxNode Format(SyntaxNode node, TextSpan span, SolutionServices services, SyntaxFormattingOptions options, CancellationToken cancellationToken)
=> Format(node, SpecializedCollections.SingletonEnumerable(span), services, options, rules: null, cancellationToken: cancellationToken);
/// <summary>
/// Formats the whitespace in areas of a syntax tree identified by multiple non-overlapping spans.
/// </summary>
/// <param name="node">The root node of a syntax tree to format.</param>
/// <param name="spans">The spans within the node's full span to format.</param>
/// <param name="workspace">A workspace used to give the formatting context.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The formatted tree's root node.</returns>
public static SyntaxNode Format(SyntaxNode node, IEnumerable<TextSpan>? spans, Workspace workspace, OptionSet? options = null, CancellationToken cancellationToken = default)
=> Format(node, spans, workspace, options, rules: null, cancellationToken: cancellationToken);
private static SyntaxNode Format(SyntaxNode node, IEnumerable<TextSpan>? spans, Workspace workspace, OptionSet? options, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken)
{
var formattingResult = GetFormattingResult(node, spans, workspace, options, rules, cancellationToken);
return formattingResult == null ? node : formattingResult.GetFormattedRoot(cancellationToken);
}
internal static SyntaxNode Format(SyntaxNode node, IEnumerable<TextSpan>? spans, SolutionServices services, SyntaxFormattingOptions options, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken)
=> GetFormattingResult(node, spans, services, options, rules, cancellationToken).GetFormattedRoot(cancellationToken);
private static IFormattingResult? GetFormattingResult(SyntaxNode node, IEnumerable<TextSpan>? spans, Workspace workspace, OptionSet? options, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken)
{
if (workspace == null)
{
throw new ArgumentNullException(nameof(workspace));
}
if (node == null)
{
throw new ArgumentNullException(nameof(node));
}
var languageServices = workspace.Services.GetLanguageServices(node.Language);
var languageFormatter = languageServices.GetService<ISyntaxFormattingService>();
if (languageFormatter == null)
{
return null;
}
spans ??= SpecializedCollections.SingletonEnumerable(node.FullSpan);
var formattingOptions = GetFormattingOptions(workspace, options, node.Language);
return languageFormatter.GetFormattingResult(node, spans, formattingOptions, rules, cancellationToken);
}
internal static IFormattingResult GetFormattingResult(SyntaxNode node, IEnumerable<TextSpan>? spans, SolutionServices services, SyntaxFormattingOptions options, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken)
{
var formatter = services.GetRequiredLanguageService<ISyntaxFormattingService>(node.Language);
return formatter.GetFormattingResult(node, spans, options, rules, cancellationToken);
}
/// <summary>
/// Determines the changes necessary to format the whitespace of a syntax tree.
/// </summary>
/// <param name="node">The root node of a syntax tree to format.</param>
/// <param name="workspace">A workspace used to give the formatting context.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The changes necessary to format the tree.</returns>
public static IList<TextChange> GetFormattedTextChanges(SyntaxNode node, Workspace workspace, OptionSet? options = null, CancellationToken cancellationToken = default)
=> GetFormattedTextChanges(node, SpecializedCollections.SingletonEnumerable(node.FullSpan), workspace, options, rules: null, cancellationToken: cancellationToken);
internal static IList<TextChange> GetFormattedTextChanges(SyntaxNode node, SolutionServices services, SyntaxFormattingOptions options, CancellationToken cancellationToken)
=> GetFormattedTextChanges(node, SpecializedCollections.SingletonEnumerable(node.FullSpan), services, options, rules: null, cancellationToken: cancellationToken);
/// <summary>
/// Determines the changes necessary to format the whitespace of a syntax tree.
/// </summary>
/// <param name="node">The root node of a syntax tree to format.</param>
/// <param name="span">The span within the node's full span to format.</param>
/// <param name="workspace">A workspace used to give the formatting context.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The changes necessary to format the tree.</returns>
public static IList<TextChange> GetFormattedTextChanges(SyntaxNode node, TextSpan span, Workspace workspace, OptionSet? options = null, CancellationToken cancellationToken = default)
=> GetFormattedTextChanges(node, SpecializedCollections.SingletonEnumerable(span), workspace, options, rules: null, cancellationToken);
internal static IList<TextChange> GetFormattedTextChanges(SyntaxNode node, TextSpan span, SolutionServices services, SyntaxFormattingOptions options, CancellationToken cancellationToken = default)
=> GetFormattedTextChanges(node, SpecializedCollections.SingletonEnumerable(span), services, options, rules: null, cancellationToken);
/// <summary>
/// Determines the changes necessary to format the whitespace of a syntax tree.
/// </summary>
/// <param name="node">The root node of a syntax tree to format.</param>
/// <param name="spans">The spans within the node's full span to format.</param>
/// <param name="workspace">A workspace used to give the formatting context.</param>
/// <param name="options">An optional set of formatting options. If these options are not supplied the current set of options from the workspace will be used.</param>
/// <param name="cancellationToken">An optional cancellation token.</param>
/// <returns>The changes necessary to format the tree.</returns>
public static IList<TextChange> GetFormattedTextChanges(SyntaxNode node, IEnumerable<TextSpan>? spans, Workspace workspace, OptionSet? options = null, CancellationToken cancellationToken = default)
=> GetFormattedTextChanges(node, spans, workspace, options, rules: null, cancellationToken);
internal static IList<TextChange> GetFormattedTextChanges(SyntaxNode node, IEnumerable<TextSpan>? spans, SolutionServices services, SyntaxFormattingOptions options, CancellationToken cancellationToken = default)
=> GetFormattedTextChanges(node, spans, services, options, rules: null, cancellationToken);
private static IList<TextChange> GetFormattedTextChanges(SyntaxNode node, IEnumerable<TextSpan>? spans, Workspace workspace, OptionSet? options, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken)
{
var formattingResult = GetFormattingResult(node, spans, workspace, options, rules, cancellationToken);
return formattingResult == null
? SpecializedCollections.EmptyList<TextChange>()
: formattingResult.GetTextChanges(cancellationToken);
}
internal static IList<TextChange> GetFormattedTextChanges(SyntaxNode node, IEnumerable<TextSpan>? spans, SolutionServices services, SyntaxFormattingOptions options, IEnumerable<AbstractFormattingRule>? rules, CancellationToken cancellationToken = default)
{
var formatter = services.GetRequiredLanguageService<ISyntaxFormattingService>(node.Language);
return formatter.GetFormattingResult(node, spans, options, rules, cancellationToken).GetTextChanges(cancellationToken);
}
internal static SyntaxFormattingOptions GetFormattingOptions(Workspace workspace, OptionSet? optionSet, string language)
{
var syntaxFormattingService = workspace.Services.GetRequiredLanguageService<ISyntaxFormattingService>(language);
var optionService = workspace.Services.GetRequiredService<IEditorConfigOptionMappingService>();
var configOptionSet = (optionSet ?? workspace.CurrentSolution.Options).AsAnalyzerConfigOptions(optionService, language);
return syntaxFormattingService.GetFormattingOptions(configOptionSet, fallbackOptions: null);
}
#pragma warning disable RS0030 // Do not used banned APIs (backwards compatibility)
internal static async ValueTask<(SyntaxFormattingOptions? Syntax, LineFormattingOptions Line)> GetFormattingOptionsAsync(Document document, OptionSet? optionSet, CancellationToken cancellationToken)
{
var optionService = document.Project.Solution.Services.GetRequiredService<IEditorConfigOptionMappingService>();
var configOptionSet = (optionSet ?? await document.GetOptionsAsync(cancellationToken).ConfigureAwait(false)).AsAnalyzerConfigOptions(optionService, document.Project.Language);
LineFormattingOptions lineFormattingOptions;
SyntaxFormattingOptions? syntaxFormattingOptions;
var syntaxFormattingService = document.GetLanguageService<ISyntaxFormattingService>();
if (syntaxFormattingService != null)
{
syntaxFormattingOptions = syntaxFormattingService.GetFormattingOptions(configOptionSet, fallbackOptions: null);
lineFormattingOptions = syntaxFormattingOptions.LineFormatting;
}
else
{
syntaxFormattingOptions = null;
lineFormattingOptions = configOptionSet.GetLineFormattingOptions(fallbackOptions: null);
}
return (syntaxFormattingOptions, lineFormattingOptions);
}
#pragma warning restore
/// <summary>
/// Organizes the imports in the document.
/// </summary>
/// <param name="document">The document to organize.</param>
/// <param name="cancellationToken">The cancellation token that the operation will observe.</param>
/// <returns>The document with organized imports. If the language does not support organizing imports, or if no changes were made, this method returns <paramref name="document"/>.</returns>
public static async Task<Document> OrganizeImportsAsync(Document document, CancellationToken cancellationToken = default)
{
var organizeImportsService = document.GetLanguageService<IOrganizeImportsService>();
if (organizeImportsService is null)
{
return document;
}
var options = await GetOrganizeImportsOptionsAsync(document, cancellationToken).ConfigureAwait(false);
return await organizeImportsService.OrganizeImportsAsync(document, options, cancellationToken).ConfigureAwait(false);
}
#pragma warning disable RS0030 // Do not used banned APIs (backwards compatibility)
internal static async ValueTask<OrganizeImportsOptions> GetOrganizeImportsOptionsAsync(Document document, CancellationToken cancellationToken)
{
var optionService = document.Project.Solution.Services.GetRequiredService<IEditorConfigOptionMappingService>();
var configOptionSet = (await document.GetOptionsAsync(cancellationToken).ConfigureAwait(false)).AsAnalyzerConfigOptions(optionService, document.Project.Language);
return configOptionSet.GetOrganizeImportsOptions(fallbackOptions: null);
}
#pragma warning restore
}
}