-
Notifications
You must be signed in to change notification settings - Fork 4k
/
SyntaxTrivia.cs
436 lines (379 loc) · 16 KB
/
SyntaxTrivia.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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
// 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.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Runtime.InteropServices;
using Microsoft.CodeAnalysis.Text;
using Roslyn.Utilities;
namespace Microsoft.CodeAnalysis
{
#pragma warning disable CA1200 // Avoid using cref tags with a prefix
/// <summary>
/// Represents a trivia in the syntax tree.
/// </summary>
#pragma warning restore CA1200 // Avoid using cref tags with a prefix
[DebuggerDisplay("{GetDebuggerDisplay(), nq}")]
[StructLayout(LayoutKind.Auto)]
public readonly struct SyntaxTrivia : IEquatable<SyntaxTrivia>
{
internal static readonly Func<SyntaxTrivia, bool> Any = t => true;
internal SyntaxTrivia(in SyntaxToken token, GreenNode? triviaNode, int position, int index)
{
Token = token;
UnderlyingNode = triviaNode;
Position = position;
Index = index;
Debug.Assert(this.RawKind != 0 || this.Equals(default(SyntaxTrivia)));
}
/// <summary>
/// An integer representing the language specific kind of this trivia.
/// </summary>
public int RawKind => UnderlyingNode?.RawKind ?? 0;
private string GetDebuggerDisplay()
{
return GetType().Name + " " + (UnderlyingNode?.KindText ?? "None") + " " + ToString();
}
/// <summary>
/// The language name that this trivia is syntax of.
/// </summary>
public string Language => UnderlyingNode?.Language ?? string.Empty;
/// <summary>
/// The parent token that contains this token in its LeadingTrivia or TrailingTrivia collection.
/// </summary>
public SyntaxToken Token { get; }
internal GreenNode? UnderlyingNode { get; }
internal GreenNode RequiredUnderlyingNode
{
get
{
var node = UnderlyingNode;
Debug.Assert(node is object);
return node;
}
}
internal int Position { get; }
internal int Index { get; }
/// <summary>
/// The width of this trivia in characters. If this trivia is a structured trivia then the returned width will
/// not include the widths of any leading or trailing trivia present on the child non-terminal node of this
/// trivia.
/// </summary>
internal int Width => UnderlyingNode?.Width ?? 0;
/// <summary>
/// The width of this trivia in characters. If this trivia is a structured trivia then the returned width will
/// include the widths of any leading or trailing trivia present on the child non-terminal node of this trivia.
/// </summary>
internal int FullWidth => UnderlyingNode?.FullWidth ?? 0;
/// <summary>
/// The absolute span of this trivia in characters. If this trivia is a structured trivia then the returned span
/// will not include spans of any leading or trailing trivia present on the child non-terminal node of this
/// trivia.
/// </summary>
public TextSpan Span
{
get
{
return UnderlyingNode != null
? new TextSpan(Position + UnderlyingNode.GetLeadingTriviaWidth(), UnderlyingNode.Width)
: default(TextSpan);
}
}
/// <summary>
/// Same as accessing <see cref="TextSpan.Start"/> on <see cref="Span"/>.
/// </summary>
/// <remarks>
/// Slight performance improvement.
/// </remarks>
public int SpanStart
{
get
{
return UnderlyingNode != null
? Position + UnderlyingNode.GetLeadingTriviaWidth()
: 0; // default(TextSpan).Start
}
}
/// <summary>
/// The absolute span of this trivia in characters. If this trivia is a structured trivia then the returned span
/// will include spans of any leading or trailing trivia present on the child non-terminal node of this trivia.
/// </summary>
public TextSpan FullSpan
{
get { return UnderlyingNode != null ? new TextSpan(Position, UnderlyingNode.FullWidth) : default(TextSpan); }
}
/// <summary>
/// Determines whether this trivia has any diagnostics on it. If this trivia is a structured trivia then the
/// returned value will indicate whether this trivia or any of its descendant nodes, tokens or trivia have any
/// diagnostics on them.
/// </summary>>
public bool ContainsDiagnostics => UnderlyingNode?.ContainsDiagnostics ?? false;
/// <summary>
/// Determines whether this trivia is a structured trivia.
/// </summary>
public bool HasStructure => UnderlyingNode?.IsStructuredTrivia ?? false;
/// <summary>
/// Determines whether this trivia is a descendant of a structured trivia.
/// </summary>
public bool IsPartOfStructuredTrivia()
{
return Token.Parent?.IsPartOfStructuredTrivia() ?? false;
}
/// <summary>
/// Determines whether this trivia or any of its structure has annotations.
/// </summary>
internal bool ContainsAnnotations => UnderlyingNode?.ContainsAnnotations ?? false;
/// <summary>
/// Determines where this trivia has annotations of the specified annotation kind.
/// </summary>
public bool HasAnnotations(string annotationKind)
{
return UnderlyingNode?.HasAnnotations(annotationKind) ?? false;
}
/// <summary>
/// Determines where this trivia has any annotations of the specified annotation kinds.
/// </summary>
public bool HasAnnotations(params string[] annotationKinds)
{
return UnderlyingNode?.HasAnnotations(annotationKinds) ?? false;
}
/// <summary>
/// Determines whether this trivia has the specific annotation.
/// </summary>
public bool HasAnnotation([NotNullWhen(true)] SyntaxAnnotation? annotation)
{
return UnderlyingNode?.HasAnnotation(annotation) ?? false;
}
/// <summary>
/// Get all the annotations of the specified annotation kind.
/// </summary>
public IEnumerable<SyntaxAnnotation> GetAnnotations(string annotationKind)
{
return UnderlyingNode != null
? UnderlyingNode.GetAnnotations(annotationKind)
: SpecializedCollections.EmptyEnumerable<SyntaxAnnotation>();
}
/// <summary>
/// Get all the annotations of the specified annotation kinds.
/// </summary>
public IEnumerable<SyntaxAnnotation> GetAnnotations(params string[] annotationKinds)
{
return UnderlyingNode != null
? UnderlyingNode.GetAnnotations(annotationKinds)
: SpecializedCollections.EmptyEnumerable<SyntaxAnnotation>();
}
/// <summary>
/// Determines whether this trivia represents a preprocessor directive.
/// </summary>
public bool IsDirective => UnderlyingNode?.IsDirective ?? false;
internal bool IsSkippedTokensTrivia => UnderlyingNode?.IsSkippedTokensTrivia ?? false;
internal bool IsDocumentationCommentTrivia => UnderlyingNode?.IsDocumentationCommentTrivia ?? false;
/// <summary>
/// Returns the child non-terminal node representing the syntax tree structure under this structured trivia.
/// </summary>
/// <returns>The child non-terminal node representing the syntax tree structure under this structured
/// trivia.</returns>
public SyntaxNode? GetStructure()
{
return HasStructure ? UnderlyingNode!.GetStructure(this) : null;
}
internal bool TryGetStructure([NotNullWhen(true)] out SyntaxNode? structure)
{
structure = GetStructure();
return structure is object;
}
/// <summary>
/// Returns the string representation of this trivia. If this trivia is structured trivia then the returned string
/// will not include any leading or trailing trivia present on the StructuredTriviaSyntax node of this trivia.
/// </summary>
/// <returns>The string representation of this trivia.</returns>
/// <remarks>The length of the returned string is always the same as Span.Length</remarks>
public override string ToString()
{
return UnderlyingNode != null ? UnderlyingNode.ToString() : string.Empty;
}
/// <summary>
/// Returns the full string representation of this trivia. If this trivia is structured trivia then the returned string will
/// include any leading or trailing trivia present on the StructuredTriviaSyntax node of this trivia.
/// </summary>
/// <returns>The full string representation of this trivia.</returns>
/// <remarks>The length of the returned string is always the same as FullSpan.Length</remarks>
public string ToFullString()
{
return UnderlyingNode != null ? UnderlyingNode.ToFullString() : string.Empty;
}
/// <summary>
/// Writes the full text of this trivia to the specified TextWriter.
/// </summary>
public void WriteTo(System.IO.TextWriter writer)
{
UnderlyingNode?.WriteTo(writer);
}
/// <summary>
/// Determines whether two <see cref="SyntaxTrivia"/>s are equal.
/// </summary>
public static bool operator ==(SyntaxTrivia left, SyntaxTrivia right)
{
return left.Equals(right);
}
/// <summary>
/// Determines whether two <see cref="SyntaxTrivia"/>s are unequal.
/// </summary>
public static bool operator !=(SyntaxTrivia left, SyntaxTrivia right)
{
return !left.Equals(right);
}
/// <summary>
/// Determines whether the supplied <see cref="SyntaxTrivia"/> is equal to this
/// <see cref="SyntaxTrivia"/>.
/// </summary>
public bool Equals(SyntaxTrivia other)
{
return Token == other.Token && UnderlyingNode == other.UnderlyingNode && Position == other.Position && Index == other.Index;
}
/// <summary>
/// Determines whether the supplied <see cref="SyntaxTrivia"/> is equal to this
/// <see cref="SyntaxTrivia"/>.
/// </summary>
public override bool Equals(object? obj)
{
return obj is SyntaxTrivia trivia && Equals(trivia);
}
/// <summary>
/// Serves as hash function for <see cref="SyntaxTrivia"/>.
/// </summary>
public override int GetHashCode()
{
return Hash.Combine(Token.GetHashCode(), Hash.Combine(UnderlyingNode, Hash.Combine(Position, Index)));
}
#region Annotations
/// <summary>
/// Creates a new SyntaxTrivia with the specified annotations.
/// </summary>
public SyntaxTrivia WithAdditionalAnnotations(params SyntaxAnnotation[] annotations)
{
return WithAdditionalAnnotations((IEnumerable<SyntaxAnnotation>)annotations);
}
/// <summary>
/// Creates a new SyntaxTrivia with the specified annotations.
/// </summary>
public SyntaxTrivia WithAdditionalAnnotations(IEnumerable<SyntaxAnnotation> annotations)
{
if (annotations == null)
{
throw new ArgumentNullException(nameof(annotations));
}
if (this.UnderlyingNode != null)
{
return new SyntaxTrivia(
token: default(SyntaxToken),
triviaNode: this.UnderlyingNode.WithAdditionalAnnotationsGreen(annotations),
position: 0, index: 0);
}
return default(SyntaxTrivia);
}
/// <summary>
/// Creates a new SyntaxTrivia without the specified annotations.
/// </summary>
public SyntaxTrivia WithoutAnnotations(params SyntaxAnnotation[] annotations)
{
return WithoutAnnotations((IEnumerable<SyntaxAnnotation>)annotations);
}
/// <summary>
/// Creates a new SyntaxTrivia without the specified annotations.
/// </summary>
public SyntaxTrivia WithoutAnnotations(IEnumerable<SyntaxAnnotation> annotations)
{
if (annotations == null)
{
throw new ArgumentNullException(nameof(annotations));
}
if (this.UnderlyingNode != null)
{
return new SyntaxTrivia(
token: default(SyntaxToken),
triviaNode: this.UnderlyingNode.WithoutAnnotationsGreen(annotations),
position: 0, index: 0);
}
return default(SyntaxTrivia);
}
/// <summary>
/// Creates a new SyntaxTrivia without annotations of the specified kind.
/// </summary>
public SyntaxTrivia WithoutAnnotations(string annotationKind)
{
if (annotationKind == null)
{
throw new ArgumentNullException(nameof(annotationKind));
}
if (this.HasAnnotations(annotationKind))
{
return this.WithoutAnnotations(this.GetAnnotations(annotationKind));
}
return this;
}
/// <summary>
/// Copies all SyntaxAnnotations, if any, from this SyntaxTrivia instance and attaches them to a new instance based on <paramref name="trivia" />.
/// </summary>
public SyntaxTrivia CopyAnnotationsTo(SyntaxTrivia trivia)
{
if (trivia.UnderlyingNode == null)
{
return default(SyntaxTrivia);
}
if (this.UnderlyingNode == null)
{
return trivia;
}
var annotations = this.UnderlyingNode.GetAnnotations();
if (annotations == null || annotations.Length == 0)
{
return trivia;
}
return new SyntaxTrivia(
token: default(SyntaxToken),
triviaNode: trivia.UnderlyingNode.WithAdditionalAnnotationsGreen(annotations),
position: 0, index: 0);
}
#endregion
/// <summary>
/// SyntaxTree which contains current SyntaxTrivia.
/// </summary>
public SyntaxTree? SyntaxTree
{
get
{
return Token.SyntaxTree;
}
}
/// <summary>
/// Get the location of this trivia.
/// </summary>
public Location GetLocation()
{
// https://github.com/dotnet/roslyn/issues/40773
return this.SyntaxTree!.GetLocation(this.Span);
}
/// <summary>
/// Gets a list of all the diagnostics associated with this trivia.
/// This method does not filter diagnostics based on #pragmas and compiler options
/// like nowarn, warnaserror etc.
/// </summary>
public IEnumerable<Diagnostic> GetDiagnostics()
{
// https://github.com/dotnet/roslyn/issues/40773
return this.SyntaxTree!.GetDiagnostics(this);
}
/// <summary>
/// Determines if this trivia is equivalent to the specified trivia.
/// </summary>
public bool IsEquivalentTo(SyntaxTrivia trivia)
{
return
(UnderlyingNode == null && trivia.UnderlyingNode == null) ||
(UnderlyingNode != null && trivia.UnderlyingNode != null && UnderlyingNode.IsEquivalentTo(trivia.UnderlyingNode));
}
}
}