/
SyntaxExtensions.cs
4403 lines (3712 loc) · 148 KB
/
SyntaxExtensions.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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Josef Pihrt and Contributors. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Text;
using Roslynator.CSharp.Documentation;
using Roslynator.CSharp.Syntax;
using Roslynator.CSharp.SyntaxRewriters;
using Roslynator.CSharp.SyntaxWalkers;
using Roslynator.Documentation;
using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
using static Roslynator.CSharp.CSharpFactory;
namespace Roslynator.CSharp;
/// <summary>
/// A set of extension methods for syntax (types derived from <see cref="CSharpSyntaxNode"/>).
/// </summary>
public static class SyntaxExtensions
{
#region AccessorDeclarationSyntax
/// <summary>
/// Returns true is the specified accessor is auto-implemented accessor.
/// </summary>
/// <param name="accessorDeclaration"></param>
public static bool IsAutoImplemented(this AccessorDeclarationSyntax accessorDeclaration)
{
return accessorDeclaration?.SemicolonToken.IsKind(SyntaxKind.SemicolonToken) == true
&& accessorDeclaration.BodyOrExpressionBody() is null;
}
/// <summary>
/// Returns accessor body or an expression body if the body is null.
/// </summary>
/// <param name="accessorDeclaration"></param>
public static CSharpSyntaxNode BodyOrExpressionBody(this AccessorDeclarationSyntax accessorDeclaration)
{
if (accessorDeclaration is null)
throw new ArgumentNullException(nameof(accessorDeclaration));
return accessorDeclaration.Body ?? (CSharpSyntaxNode)accessorDeclaration.ExpressionBody;
}
#endregion AccessorDeclarationSyntax
#region AccessorListSyntax
/// <summary>
/// Returns a get accessor contained in the specified list.
/// </summary>
/// <param name="accessorList"></param>
public static AccessorDeclarationSyntax Getter(this AccessorListSyntax accessorList)
{
return Accessor(accessorList, SyntaxKind.GetAccessorDeclaration);
}
/// <summary>
/// Returns a set accessor contained in the specified list.
/// </summary>
/// <param name="accessorList"></param>
public static AccessorDeclarationSyntax Setter(this AccessorListSyntax accessorList)
{
return Accessor(accessorList, SyntaxKind.SetAccessorDeclaration, SyntaxKind.InitAccessorDeclaration);
}
private static AccessorDeclarationSyntax Accessor(this AccessorListSyntax accessorList, SyntaxKind kind)
{
if (accessorList is null)
throw new ArgumentNullException(nameof(accessorList));
foreach (AccessorDeclarationSyntax accessor in accessorList.Accessors)
{
if (accessor.IsKind(kind))
return accessor;
}
return null;
}
private static AccessorDeclarationSyntax Accessor(this AccessorListSyntax accessorList, SyntaxKind kind1, SyntaxKind kind2)
{
if (accessorList is null)
throw new ArgumentNullException(nameof(accessorList));
foreach (AccessorDeclarationSyntax accessor in accessorList.Accessors)
{
if (accessor.IsKind(kind1, kind2))
return accessor;
}
return null;
}
#endregion AccessorListSyntax
#region BlockSyntax
internal static StatementSyntax SingleNonBlockStatementOrDefault(this BlockSyntax body, bool recursive = false)
{
if (recursive)
{
StatementSyntax statement;
do
{
statement = body.Statements.SingleOrDefault(shouldThrow: false);
body = statement as BlockSyntax;
}
while (body is not null);
return statement;
}
else
{
StatementSyntax statement = body.Statements.SingleOrDefault(shouldThrow: false);
if (statement is not null
&& statement.Kind() != SyntaxKind.Block)
{
return statement;
}
return null;
}
}
internal static bool ContainsYield(this BlockSyntax block, bool yieldReturn = true, bool yieldBreak = true)
{
return ContainsYieldWalker.ContainsYield(block, yieldReturn, yieldBreak);
}
#endregion BlockSyntax
#region BaseArgumentListSyntax
internal static BaseArgumentListSyntax WithArguments(this BaseArgumentListSyntax baseArgumentList, SeparatedSyntaxList<ArgumentSyntax> arguments)
{
switch (baseArgumentList.Kind())
{
case SyntaxKind.ArgumentList:
return ((ArgumentListSyntax)baseArgumentList).WithArguments(arguments);
case SyntaxKind.BracketedArgumentList:
return ((BracketedArgumentListSyntax)baseArgumentList).WithArguments(arguments);
}
Debug.Fail(baseArgumentList?.Kind().ToString());
return null;
}
#endregion BaseArgumentListSyntax
#region BinaryExpressionSyntax
/// <summary>
/// Returns <see cref="ExpressionChain"/> that enables to enumerate expressions of a binary expression.
/// </summary>
/// <param name="binaryExpression"></param>
/// <param name="span"></param>
public static ExpressionChain AsChain(this BinaryExpressionSyntax binaryExpression, TextSpan? span = null)
{
return new ExpressionChain(binaryExpression, span);
}
#endregion BinaryExpressionSyntax
#region CastExpressionSyntax
/// <summary>
/// The absolute span of the parentheses, not including its leading and trailing trivia.
/// </summary>
/// <param name="castExpression"></param>
public static TextSpan ParenthesesSpan(this CastExpressionSyntax castExpression)
{
if (castExpression is null)
throw new ArgumentNullException(nameof(castExpression));
return TextSpan.FromBounds(
castExpression.OpenParenToken.SpanStart,
castExpression.CloseParenToken.Span.End);
}
#endregion CastExpressionSyntax
#region ClassDeclarationSyntax
/// <summary>
/// Creates a new <see cref="ClassDeclarationSyntax"/> with the members updated.
/// </summary>
/// <param name="classDeclaration"></param>
/// <param name="member"></param>
public static ClassDeclarationSyntax WithMembers(
this ClassDeclarationSyntax classDeclaration,
MemberDeclarationSyntax member)
{
if (classDeclaration is null)
throw new ArgumentNullException(nameof(classDeclaration));
return classDeclaration.WithMembers(SingletonList(member));
}
/// <summary>
/// Creates a new <see cref="ClassDeclarationSyntax"/> with the members updated.
/// </summary>
/// <param name="classDeclaration"></param>
/// <param name="members"></param>
public static ClassDeclarationSyntax WithMembers(
this ClassDeclarationSyntax classDeclaration,
IEnumerable<MemberDeclarationSyntax> members)
{
if (classDeclaration is null)
throw new ArgumentNullException(nameof(classDeclaration));
return classDeclaration.WithMembers(List(members));
}
/// <summary>
/// The absolute span of the braces, not including its leading and trailing trivia.
/// </summary>
/// <param name="classDeclaration"></param>
public static TextSpan BracesSpan(this ClassDeclarationSyntax classDeclaration)
{
if (classDeclaration is null)
throw new ArgumentNullException(nameof(classDeclaration));
return TextSpan.FromBounds(
classDeclaration.OpenBraceToken.SpanStart,
classDeclaration.CloseBraceToken.Span.End);
}
#endregion ClassDeclarationSyntax
#region CommonForEachStatementSyntax
/// <summary>
/// The absolute span of the parentheses, not including its leading and trailing trivia.
/// </summary>
/// <param name="forEachStatement"></param>
public static TextSpan ParenthesesSpan(this CommonForEachStatementSyntax forEachStatement)
{
if (forEachStatement is null)
throw new ArgumentNullException(nameof(forEachStatement));
return TextSpan.FromBounds(forEachStatement.OpenParenToken.SpanStart, forEachStatement.CloseParenToken.Span.End);
}
internal static StatementSyntax EmbeddedStatement(this CommonForEachStatementSyntax forEachStatement)
{
StatementSyntax statement = forEachStatement.Statement;
return (statement?.Kind() == SyntaxKind.Block) ? null : statement;
}
#endregion CommonForEachStatementSyntax
#region CompilationUnitSyntax
/// <summary>
/// Creates a new <see cref="CompilationUnitSyntax"/> with the members updated.
/// </summary>
/// <param name="compilationUnit"></param>
/// <param name="member"></param>
public static CompilationUnitSyntax WithMembers(
this CompilationUnitSyntax compilationUnit,
MemberDeclarationSyntax member)
{
if (compilationUnit is null)
throw new ArgumentNullException(nameof(compilationUnit));
return compilationUnit.WithMembers(SingletonList(member));
}
/// <summary>
/// Creates a new <see cref="CompilationUnitSyntax"/> with the members updated.
/// </summary>
/// <param name="compilationUnit"></param>
/// <param name="members"></param>
public static CompilationUnitSyntax WithMembers(
this CompilationUnitSyntax compilationUnit,
IEnumerable<MemberDeclarationSyntax> members)
{
if (compilationUnit is null)
throw new ArgumentNullException(nameof(compilationUnit));
return compilationUnit.WithMembers(List(members));
}
/// <summary>
/// Creates a new <see cref="CompilationUnitSyntax"/> with the specified using directives added.
/// </summary>
/// <param name="compilationUnit"></param>
/// <param name="keepSingleLineCommentsOnTop"></param>
/// <param name="usings"></param>
public static CompilationUnitSyntax AddUsings(this CompilationUnitSyntax compilationUnit, bool keepSingleLineCommentsOnTop, params UsingDirectiveSyntax[] usings)
{
if (compilationUnit is null)
throw new ArgumentNullException(nameof(compilationUnit));
if (usings is null)
throw new ArgumentNullException(nameof(usings));
if (keepSingleLineCommentsOnTop
&& usings.Length > 0
&& !compilationUnit.Usings.Any())
{
List<SyntaxTrivia> topTrivia = null;
SyntaxTriviaList leadingTrivia = compilationUnit.GetLeadingTrivia();
SyntaxTriviaList.Enumerator en = leadingTrivia.GetEnumerator();
while (en.MoveNext())
{
if (en.Current.IsKind(SyntaxKind.SingleLineCommentTrivia))
{
SyntaxTrivia trivia = en.Current;
if (en.MoveNext()
&& en.Current.IsEndOfLineTrivia())
{
(topTrivia ??= new List<SyntaxTrivia>()).Add(trivia);
topTrivia.Add(en.Current);
}
else
{
break;
}
}
else
{
break;
}
}
if (topTrivia?.Count > 0)
{
compilationUnit = compilationUnit.WithoutLeadingTrivia();
usings[0] = usings[0].WithLeadingTrivia(topTrivia);
usings[usings.Length - 1] = usings[usings.Length - 1].WithTrailingTrivia(leadingTrivia.Skip(topTrivia.Count));
}
}
return compilationUnit.AddUsings(usings);
}
#endregion CompilationUnitSyntax
internal static ExpressionSyntax RemoveOperatorToken(this ConditionalAccessExpressionSyntax conditionalAccessExpression)
{
SyntaxToken operatorToken = conditionalAccessExpression.OperatorToken;
string text = conditionalAccessExpression
.ToFullString()
.Remove(operatorToken.FullSpan.Start - conditionalAccessExpression.FullSpan.Start, operatorToken.FullSpan.Length);
return ParseExpression(text);
}
#region ConstructorDeclarationSyntax
internal static TextSpan HeaderSpan(this ConstructorDeclarationSyntax constructorDeclaration)
{
int start;
SyntaxList<AttributeListSyntax> attributeLists = constructorDeclaration.AttributeLists;
if (attributeLists.Any())
{
SyntaxTokenList modifiers = constructorDeclaration.Modifiers;
start = (modifiers.Any())
? modifiers[0].SpanStart
: constructorDeclaration.Identifier.SpanStart;
}
else
{
start = constructorDeclaration.SpanStart;
}
return TextSpan.FromBounds(
start,
constructorDeclaration.Initializer?.Span.End
?? constructorDeclaration.ParameterList?.Span.End
?? constructorDeclaration.Identifier.Span.End);
}
/// <summary>
/// Returns constructor body or an expression body if the body is null.
/// </summary>
/// <param name="constructorDeclaration"></param>
public static CSharpSyntaxNode BodyOrExpressionBody(this ConstructorDeclarationSyntax constructorDeclaration)
{
if (constructorDeclaration is null)
throw new ArgumentNullException(nameof(constructorDeclaration));
return constructorDeclaration.Body ?? (CSharpSyntaxNode)constructorDeclaration.ExpressionBody;
}
#endregion ConstructorDeclarationSyntax
#region ConversionOperatorDeclarationSyntax
/// <summary>
/// Returns conversion operator body or an expression body if the body is null.
/// </summary>
/// <param name="conversionOperatorDeclaration"></param>
public static CSharpSyntaxNode BodyOrExpressionBody(this ConversionOperatorDeclarationSyntax conversionOperatorDeclaration)
{
if (conversionOperatorDeclaration is null)
throw new ArgumentNullException(nameof(conversionOperatorDeclaration));
return conversionOperatorDeclaration.Body ?? (CSharpSyntaxNode)conversionOperatorDeclaration.ExpressionBody;
}
internal static TextSpan HeaderSpan(this ConversionOperatorDeclarationSyntax operatorDeclaration)
{
int start;
SyntaxList<AttributeListSyntax> attributeLists = operatorDeclaration.AttributeLists;
if (attributeLists.Any())
{
SyntaxTokenList modifiers = operatorDeclaration.Modifiers;
start = (modifiers.Any())
? modifiers[0].SpanStart
: operatorDeclaration.ImplicitOrExplicitKeyword.SpanStart;
}
else
{
start = operatorDeclaration.SpanStart;
}
return TextSpan.FromBounds(
start,
operatorDeclaration.ParameterList?.Span.End
?? operatorDeclaration.Type.Span.End);
}
#endregion ConversionOperatorDeclarationSyntax
#region DefaultExpressionSyntax
internal static TextSpan ParenthesesSpan(this DefaultExpressionSyntax defaultExpression)
{
return TextSpan.FromBounds(defaultExpression.OpenParenToken.SpanStart, defaultExpression.CloseParenToken.Span.End);
}
#endregion DefaultExpressionSyntax
#region DelegateDeclarationSyntax
/// <summary>
/// Returns true the specified delegate return type is <see cref="void"/>.
/// </summary>
/// <param name="delegateDeclaration"></param>
public static bool ReturnsVoid(this DelegateDeclarationSyntax delegateDeclaration)
{
return delegateDeclaration?.ReturnType?.IsVoid() == true;
}
#endregion DelegateDeclarationSyntax
#region DestructorDeclarationSyntax
/// <summary>
/// Returns destructor body or an expression body if the body is null.
/// </summary>
/// <param name="destructorDeclaration"></param>
public static CSharpSyntaxNode BodyOrExpressionBody(this DestructorDeclarationSyntax destructorDeclaration)
{
if (destructorDeclaration is null)
throw new ArgumentNullException(nameof(destructorDeclaration));
return destructorDeclaration.Body ?? (CSharpSyntaxNode)destructorDeclaration.ExpressionBody;
}
internal static TextSpan HeaderSpan(this DestructorDeclarationSyntax destructorDeclaration)
{
int start;
SyntaxList<AttributeListSyntax> attributeLists = destructorDeclaration.AttributeLists;
if (attributeLists.Any())
{
SyntaxTokenList modifiers = destructorDeclaration.Modifiers;
start = (modifiers.Any())
? modifiers[0].SpanStart
: destructorDeclaration.TildeToken.SpanStart;
}
else
{
start = destructorDeclaration.SpanStart;
}
return TextSpan.FromBounds(
start,
destructorDeclaration.ParameterList?.Span.End
?? destructorDeclaration.TildeToken.Span.End);
}
#endregion DestructorDeclarationSyntax
#region DirectiveTriviaSyntax
/// <summary>
/// Returns the next related directive.
/// </summary>
/// <param name="directiveTrivia"></param>
public static DirectiveTriviaSyntax GetNextRelatedDirective(this DirectiveTriviaSyntax directiveTrivia)
{
DirectiveTriviaSyntax d = directiveTrivia;
switch (d.Kind())
{
case SyntaxKind.IfDirectiveTrivia:
case SyntaxKind.ElifDirectiveTrivia:
{
while (true)
{
d = d.GetNextPossiblyRelatedDirective();
if (d is null)
break;
if (d.IsKind(
SyntaxKind.ElifDirectiveTrivia,
SyntaxKind.ElseDirectiveTrivia,
SyntaxKind.EndIfDirectiveTrivia))
{
return d;
}
}
break;
}
case SyntaxKind.ElseDirectiveTrivia:
{
while (true)
{
d = d.GetNextPossiblyRelatedDirective();
if (d is null)
break;
if (d.Kind() == SyntaxKind.EndIfDirectiveTrivia)
return d;
}
break;
}
case SyntaxKind.RegionDirectiveTrivia:
{
while (true)
{
d = d.GetNextPossiblyRelatedDirective();
if (d is null)
break;
if (d.Kind() == SyntaxKind.EndRegionDirectiveTrivia)
return d;
}
break;
}
}
return null;
}
private static DirectiveTriviaSyntax GetNextPossiblyRelatedDirective(this DirectiveTriviaSyntax directiveTrivia)
{
DirectiveTriviaSyntax d = directiveTrivia;
while (d is not null)
{
d = d.GetNextDirective();
if (d is not null)
{
switch (d.Kind())
{
case SyntaxKind.IfDirectiveTrivia:
{
do
{
d = d.GetNextRelatedDirective();
}
while (d is not null && d.Kind() != SyntaxKind.EndIfDirectiveTrivia);
continue;
}
case SyntaxKind.RegionDirectiveTrivia:
{
do
{
d = d.GetNextRelatedDirective();
}
while (d is not null && d.Kind() != SyntaxKind.EndRegionDirectiveTrivia);
continue;
}
}
}
return d;
}
return null;
}
#endregion DirectiveTriviaSyntax
#region DocumentationCommentTriviaSyntax
internal static XmlElementSyntax SummaryElement(this DocumentationCommentTriviaSyntax documentationComment)
{
if (documentationComment is null)
throw new ArgumentNullException(nameof(documentationComment));
foreach (XmlNodeSyntax node in documentationComment.Content)
{
if (node is XmlElementSyntax element
&& element.IsLocalName("summary", StringComparison.OrdinalIgnoreCase))
{
return element;
}
}
return null;
}
/// <summary>
/// Gets a list of xml elements with the specified local name.
/// </summary>
/// <param name="documentationComment"></param>
/// <param name="localName"></param>
public static IEnumerable<XmlElementSyntax> Elements(this DocumentationCommentTriviaSyntax documentationComment, string localName)
{
if (documentationComment is null)
throw new ArgumentNullException(nameof(documentationComment));
return ElementsIterator();
IEnumerable<XmlElementSyntax> ElementsIterator()
{
foreach (XmlNodeSyntax node in documentationComment.Content)
{
if (node is XmlElementSyntax xmlElement
&& xmlElement.IsLocalName(localName))
{
yield return xmlElement;
}
}
}
}
internal static IEnumerable<XmlElementSyntax> Elements(this DocumentationCommentTriviaSyntax documentationComment, XmlTag tag)
{
foreach (XmlNodeSyntax node in documentationComment.Content)
{
if (node is XmlElementSyntax xmlElement
&& xmlElement.HasTag(tag))
{
yield return xmlElement;
}
}
}
internal static bool IsPartOfMemberDeclaration(this DocumentationCommentTriviaSyntax documentationComment)
{
SyntaxNode node = documentationComment.ParentTrivia.Token.Parent;
return node is MemberDeclarationSyntax
|| node.Parent is MemberDeclarationSyntax;
}
#endregion DocumentationCommentTriviaSyntax
#region DoStatementSyntax
internal static StatementSyntax EmbeddedStatement(this DoStatementSyntax doStatement)
{
StatementSyntax statement = doStatement.Statement;
return (statement?.Kind() == SyntaxKind.Block) ? null : statement;
}
#endregion DoStatementSyntax
#region ElseClauseSyntax
internal static StatementSyntax SingleNonBlockStatementOrDefault(this ElseClauseSyntax elseClause)
{
return SingleNonBlockStatementOrDefault(elseClause.Statement);
}
/// <summary>
/// Returns topmost if statement of the if-else cascade the specified else clause is part of.
/// </summary>
/// <param name="elseClause"></param>
public static IfStatementSyntax GetTopmostIf(this ElseClauseSyntax elseClause)
{
if (elseClause is null)
throw new ArgumentNullException(nameof(elseClause));
if (elseClause.Parent is IfStatementSyntax ifStatement)
return ifStatement.GetTopmostIf();
return null;
}
internal static StatementSyntax EmbeddedStatement(this ElseClauseSyntax elseClause, bool allowIfStatement = true)
{
StatementSyntax statement = elseClause.Statement;
if (statement is null)
return null;
SyntaxKind kind = statement.Kind();
if (kind == SyntaxKind.Block)
return null;
if (!allowIfStatement
&& kind == SyntaxKind.IfStatement)
{
return null;
}
return statement;
}
#endregion ElseClauseSyntax
#region EndRegionDirectiveTriviaSyntax
/// <summary>
/// Returns region directive that is related to the specified endregion directive. Returns null if no matching region directive is found.
/// </summary>
/// <param name="endRegionDirective"></param>
public static RegionDirectiveTriviaSyntax GetRegionDirective(this EndRegionDirectiveTriviaSyntax endRegionDirective)
{
if (endRegionDirective is null)
throw new ArgumentNullException(nameof(endRegionDirective));
RegionInfo region = SyntaxInfo.RegionInfo(endRegionDirective);
return (region.Success) ? region.Directive : null;
}
/// <summary>
/// Gets preprocessing message for the specified endregion directive if such message exists.
/// </summary>
/// <param name="endRegionDirective"></param>
public static SyntaxTrivia GetPreprocessingMessageTrivia(this EndRegionDirectiveTriviaSyntax endRegionDirective)
{
if (endRegionDirective is null)
throw new ArgumentNullException(nameof(endRegionDirective));
SyntaxToken endOfDirective = endRegionDirective.EndOfDirectiveToken;
SyntaxTriviaList leading = endOfDirective.LeadingTrivia;
if (leading.Count == 1)
{
SyntaxTrivia trivia = leading[0];
if (trivia.IsKind(SyntaxKind.PreprocessingMessageTrivia))
return trivia;
}
return default;
}
/// <summary>
/// Returns true the specified endregion directive has preprocessing message trivia.
/// </summary>
/// <param name="endRegionDirective"></param>
internal static bool HasPreprocessingMessageTrivia(this EndRegionDirectiveTriviaSyntax endRegionDirective)
{
return GetPreprocessingMessageTrivia(endRegionDirective).IsKind(SyntaxKind.PreprocessingMessageTrivia);
}
#endregion EndRegionDirectiveTriviaSyntax
#region EnumDeclarationSyntax
/// <summary>
/// The absolute span of the braces, not including its leading and trailing trivia.
/// </summary>
/// <param name="enumDeclaration"></param>
public static TextSpan BracesSpan(this EnumDeclarationSyntax enumDeclaration)
{
if (enumDeclaration is null)
throw new ArgumentNullException(nameof(enumDeclaration));
return TextSpan.FromBounds(
enumDeclaration.OpenBraceToken.SpanStart,
enumDeclaration.CloseBraceToken.Span.End);
}
#endregion EnumDeclarationSyntax
#region EventDeclarationSyntax
internal static TextSpan HeaderSpan(this EventDeclarationSyntax eventDeclaration)
{
if (eventDeclaration is null)
throw new ArgumentNullException(nameof(eventDeclaration));
return TextSpan.FromBounds(
eventDeclaration.SpanStart,
eventDeclaration.Identifier.Span.End);
}
#endregion EventDeclarationSyntax
#region ExpressionSyntax
/// <summary>
/// Returns topmost parenthesized expression or self if the expression if not parenthesized.
/// </summary>
/// <param name="expression"></param>
public static ExpressionSyntax WalkUpParentheses(this ExpressionSyntax expression)
{
while (expression.IsParentKind(SyntaxKind.ParenthesizedExpression))
expression = (ExpressionSyntax)expression.Parent;
return expression;
}
/// <summary>
/// Returns lowest expression in parentheses or self if the expression is not parenthesized.
/// </summary>
/// <param name="expression"></param>
public static ExpressionSyntax WalkDownParentheses(this ExpressionSyntax expression)
{
if (expression is null)
throw new ArgumentNullException(nameof(expression));
while (expression.Kind() == SyntaxKind.ParenthesizedExpression)
expression = ((ParenthesizedExpressionSyntax)expression).Expression;
return expression;
}
internal static ExpressionSyntax WalkDownParenthesesIf(this ExpressionSyntax expression, bool condition)
{
return (condition) ? WalkDownParentheses(expression) : expression;
}
internal static bool IsNumericLiteralExpression(this ExpressionSyntax expression, string valueText)
{
return expression.IsKind(SyntaxKind.NumericLiteralExpression)
&& string.Equals(((LiteralExpressionSyntax)expression).Token.ValueText, valueText, StringComparison.Ordinal);
}
#endregion ExpressionSyntax
#region FixedStatementSyntax
internal static StatementSyntax EmbeddedStatement(this FixedStatementSyntax fixedStatement)
{
StatementSyntax statement = fixedStatement.Statement;
return (statement?.Kind() == SyntaxKind.Block) ? null : statement;
}
#endregion FixedStatementSyntax
#region ForStatementSyntax
/// <summary>
/// Absolute span of the parentheses, not including the leading and trailing trivia.
/// </summary>
/// <param name="forStatement"></param>
public static TextSpan ParenthesesSpan(this ForStatementSyntax forStatement)
{
if (forStatement is null)
throw new ArgumentNullException(nameof(forStatement));
return TextSpan.FromBounds(forStatement.OpenParenToken.SpanStart, forStatement.CloseParenToken.Span.End);
}
internal static StatementSyntax EmbeddedStatement(this ForStatementSyntax forStatement)
{
StatementSyntax statement = forStatement.Statement;
return (statement?.Kind() == SyntaxKind.Block) ? null : statement;
}
#endregion ForStatementSyntax
#region IfStatementSyntax
internal static StatementSyntax SingleNonBlockStatementOrDefault(this IfStatementSyntax ifStatement)
{
return SingleNonBlockStatementOrDefault(ifStatement.Statement);
}
/// <summary>
/// Returns true if the specified if statement is a simple if statement.
/// Simple if statement is defined as follows: it is not a child of an else clause and it has no else clause.
/// </summary>
/// <param name="ifStatement"></param>
public static bool IsSimpleIf(this IfStatementSyntax ifStatement)
{
return ifStatement?.IsParentKind(SyntaxKind.ElseClause) == false
&& ifStatement.Else is null;
}
/// <summary>
/// Returns topmost if statement of the if-else cascade the specified if statement is part of.
/// </summary>
/// <param name="ifStatement"></param>
public static IfStatementSyntax GetTopmostIf(this IfStatementSyntax ifStatement)
{
if (ifStatement is null)
throw new ArgumentNullException(nameof(ifStatement));
while (true)
{
IfStatementSyntax parentIf = GetPreviousIf(ifStatement);
if (parentIf is not null)
{
ifStatement = parentIf;
}
else
{
break;
}
}
return ifStatement;
}
/// <summary>
/// Returns true if the specified if statement is not a child of an else clause.
/// </summary>
/// <param name="ifStatement"></param>
public static bool IsTopmostIf(this IfStatementSyntax ifStatement)
{
return ifStatement?.IsParentKind(SyntaxKind.ElseClause) == false;
}
internal static IfStatementSyntax GetNextIf(this IfStatementSyntax ifStatement)
{
StatementSyntax statement = ifStatement.Else?.Statement;
if (statement?.Kind() == SyntaxKind.IfStatement)
return (IfStatementSyntax)statement;
return null;
}
internal static IfStatementSyntax GetPreviousIf(this IfStatementSyntax ifStatement)
{
SyntaxNode parent = ifStatement.Parent;
if (parent.IsKind(SyntaxKind.ElseClause))
{
parent = parent.Parent;
if (parent.IsKind(SyntaxKind.IfStatement))
return (IfStatementSyntax)parent;
}
return null;
}
internal static StatementSyntax EmbeddedStatement(this IfStatementSyntax ifStatement)
{
StatementSyntax statement = ifStatement.Statement;
return (statement?.Kind() == SyntaxKind.Block) ? null : statement;
}
/// <summary>
/// Returns <see cref="IfStatementCascade"/> that enables to enumerate if-else cascade.
/// </summary>
/// <param name="ifStatement"></param>
public static IfStatementCascade AsCascade(this IfStatementSyntax ifStatement)
{
if (ifStatement is null)
throw new ArgumentNullException(nameof(ifStatement));
return new IfStatementCascade(ifStatement);
}
/// <summary>
/// Returns <see cref="IfStatementCascadeInfo"/> that summarizes information about if-else cascade.
/// </summary>
/// <param name="ifStatement"></param>
public static IfStatementCascadeInfo GetCascadeInfo(this IfStatementSyntax ifStatement)
{
if (ifStatement is null)
throw new ArgumentNullException(nameof(ifStatement));
return new IfStatementCascadeInfo(ifStatement);
}
#endregion IfStatementSyntax
#region IEnumerable<T>
/// <summary>
/// Creates a list of syntax nodes from a sequence of nodes.
/// </summary>
/// <typeparam name="TNode"></typeparam>
/// <param name="nodes"></param>
public static SyntaxList<TNode> ToSyntaxList<TNode>(this IEnumerable<TNode> nodes) where TNode : SyntaxNode
{
return List(nodes);
}
/// <summary>
/// Creates a separated list of syntax nodes from a sequence of nodes.
/// </summary>
/// <typeparam name="TNode"></typeparam>
/// <param name="nodes"></param>
public static SeparatedSyntaxList<TNode> ToSeparatedSyntaxList<TNode>(this IEnumerable<TNode> nodes) where TNode : SyntaxNode
{
return SeparatedList(nodes);
}
/// <summary>
/// Creates a separated list of syntax nodes from a sequence of nodes and tokens.
/// </summary>
/// <typeparam name="TNode"></typeparam>
/// <param name="nodesAndTokens"></param>
public static SeparatedSyntaxList<TNode> ToSeparatedSyntaxList<TNode>(this IEnumerable<SyntaxNodeOrToken> nodesAndTokens) where TNode : SyntaxNode
{
return SeparatedList<TNode>(nodesAndTokens);
}
/// <summary>