-
Notifications
You must be signed in to change notification settings - Fork 466
/
DiagnosticDescriptorCreationAnalyzer.cs
1321 lines (1163 loc) · 70.3 KB
/
DiagnosticDescriptorCreationAnalyzer.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) Microsoft. All Rights Reserved. Licensed under the MIT license. See License.txt in the project root for license information.
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Text;
using System.Threading;
using Analyzer.Utilities;
using Analyzer.Utilities.Extensions;
using Analyzer.Utilities.PooledObjects;
using Microsoft.CodeAnalysis.Analyzers.MetaAnalyzers.Helpers;
using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.Operations;
using Microsoft.CodeAnalysis.ReleaseTracking;
using Microsoft.CodeAnalysis.Text;
namespace Microsoft.CodeAnalysis.Analyzers.MetaAnalyzers
{
using static CodeAnalysisDiagnosticsResources;
using PooledLocalizabeStringsConcurrentDictionary = PooledConcurrentDictionary<INamedTypeSymbol, PooledConcurrentSet<(IFieldSymbol field, IArgumentOperation argument)>>;
using PooledResourcesDataValueConcurrentDictionary = PooledConcurrentDictionary<string, ImmutableDictionary<string, (string value, Location location)>>;
using PooledFieldToResourceNameAndFileNameConcurrentDictionary = PooledConcurrentDictionary<IFieldSymbol, (string nameOfResource, string resourceFileName)>;
using PooledFieldToCustomTagsConcurrentDictionary = PooledConcurrentDictionary<IFieldSymbol, ImmutableArray<string>>;
/// <summary>
/// RS1007 <inheritdoc cref="UseLocalizableStringsInDescriptorTitle"/>
/// RS1015 <inheritdoc cref="ProvideHelpUriInDescriptorTitle"/>
/// RS1017 <inheritdoc cref="DiagnosticIdMustBeAConstantTitle"/>
/// RS1019 <inheritdoc cref="UseUniqueDiagnosticIdTitle"/>
/// RS1028 <inheritdoc cref="ProvideCustomTagsInDescriptorTitle"/>
/// RS1029 <inheritdoc cref="DoNotUseReservedDiagnosticIdTitle"/>
/// RS1031 <inheritdoc cref="DefineDiagnosticTitleCorrectlyTitle"/>
/// RS1032 <inheritdoc cref="DefineDiagnosticMessageCorrectlyTitle"/>
/// RS1033 <inheritdoc cref="DefineDiagnosticDescriptionCorrectlyTitle"/>
/// </summary>
[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)]
public sealed partial class DiagnosticDescriptorCreationAnalyzer : DiagnosticAnalyzer
{
private const string HelpLinkUriParameterName = "helpLinkUri";
private const string CategoryParameterName = "category";
private const string DiagnosticIdParameterName = "id";
private const string CustomTagsParameterName = "customTags";
private const string IsEnabledByDefaultParameterName = "isEnabledByDefault";
private const string DefaultSeverityParameterName = "defaultSeverity";
private const string RuleLevelParameterName = "ruleLevel";
private const string CompilationEndWellKnownDiagnosticTag = "CompilationEnd" /*WellKnownDiagnosticTags.CompilationEnd*/;
internal const string DefineDescriptorArgumentCorrectlyFixValue = nameof(DefineDescriptorArgumentCorrectlyFixValue);
private const string DefineDescriptorArgumentCorrectlyFixAdditionalDocumentLocationInfo = nameof(DefineDescriptorArgumentCorrectlyFixAdditionalDocumentLocationInfo);
private const string AdditionalDocumentLocationInfoSeparator = ";;";
private static readonly ImmutableHashSet<string> CADiagnosticIdAllowedAssemblies = ImmutableHashSet.Create(
StringComparer.Ordinal,
"Microsoft.CodeAnalysis.VersionCheckAnalyzer",
"Microsoft.CodeAnalysis.NetAnalyzers",
"Microsoft.CodeAnalysis.CSharp.NetAnalyzers",
"Microsoft.CodeAnalysis.VisualBasic.NetAnalyzers",
"Microsoft.CodeQuality.Analyzers",
"Microsoft.CodeQuality.CSharp.Analyzers",
"Microsoft.CodeQuality.VisualBasic.Analyzers",
"Microsoft.NetCore.Analyzers",
"Microsoft.NetCore.CSharp.Analyzers",
"Microsoft.NetCore.VisualBasic.Analyzers",
"Microsoft.NetFramework.Analyzers",
"Microsoft.NetFramework.CSharp.Analyzers",
"Microsoft.NetFramework.VisualBasic.Analyzers",
"Text.Analyzers",
"Text.CSharp.Analyzers",
"Text.VisualBasic.Analyzers");
public static readonly DiagnosticDescriptor UseLocalizableStringsInDescriptorRule = new(
DiagnosticIds.UseLocalizableStringsInDescriptorRuleId,
CreateLocalizableResourceString(nameof(UseLocalizableStringsInDescriptorTitle)),
CreateLocalizableResourceString(nameof(UseLocalizableStringsInDescriptorMessage)),
DiagnosticCategory.MicrosoftCodeAnalysisLocalization,
DiagnosticSeverity.Warning,
isEnabledByDefault: false,
description: CreateLocalizableResourceString(nameof(UseLocalizableStringsInDescriptorDescription)),
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);
public static readonly DiagnosticDescriptor ProvideHelpUriInDescriptorRule = new(
DiagnosticIds.ProvideHelpUriInDescriptorRuleId,
CreateLocalizableResourceString(nameof(ProvideHelpUriInDescriptorTitle)),
CreateLocalizableResourceString(nameof(ProvideHelpUriInDescriptorMessage)),
DiagnosticCategory.MicrosoftCodeAnalysisDocumentation,
DiagnosticSeverity.Warning,
isEnabledByDefault: false,
description: CreateLocalizableResourceString(nameof(ProvideHelpUriInDescriptorDescription)),
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);
public static readonly DiagnosticDescriptor DiagnosticIdMustBeAConstantRule = new(
DiagnosticIds.DiagnosticIdMustBeAConstantRuleId,
CreateLocalizableResourceString(nameof(DiagnosticIdMustBeAConstantTitle)),
CreateLocalizableResourceString(nameof(DiagnosticIdMustBeAConstantMessage)),
DiagnosticCategory.MicrosoftCodeAnalysisDesign,
DiagnosticSeverity.Warning,
isEnabledByDefault: true,
description: CreateLocalizableResourceString(nameof(DiagnosticIdMustBeAConstantDescription)),
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);
public static readonly DiagnosticDescriptor UseUniqueDiagnosticIdRule = new(
DiagnosticIds.UseUniqueDiagnosticIdRuleId,
CreateLocalizableResourceString(nameof(UseUniqueDiagnosticIdTitle)),
CreateLocalizableResourceString(nameof(UseUniqueDiagnosticIdMessage)),
DiagnosticCategory.MicrosoftCodeAnalysisDesign,
DiagnosticSeverity.Warning,
isEnabledByDefault: true,
description: CreateLocalizableResourceString(nameof(UseUniqueDiagnosticIdDescription)),
customTags: WellKnownDiagnosticTagsExtensions.CompilationEndAndTelemetry);
public static readonly DiagnosticDescriptor ProvideCustomTagsInDescriptorRule = new(
DiagnosticIds.ProvideCustomTagsInDescriptorRuleId,
CreateLocalizableResourceString(nameof(ProvideCustomTagsInDescriptorTitle)),
CreateLocalizableResourceString(nameof(ProvideCustomTagsInDescriptorMessage)),
DiagnosticCategory.MicrosoftCodeAnalysisDocumentation,
DiagnosticSeverity.Warning,
isEnabledByDefault: false,
description: CreateLocalizableResourceString(nameof(ProvideCustomTagsInDescriptorDescription)),
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);
public static readonly DiagnosticDescriptor DoNotUseReservedDiagnosticIdRule = new(
DiagnosticIds.DoNotUseReservedDiagnosticIdRuleId,
CreateLocalizableResourceString(nameof(DoNotUseReservedDiagnosticIdTitle)),
CreateLocalizableResourceString(nameof(DoNotUseReservedDiagnosticIdMessage)),
DiagnosticCategory.MicrosoftCodeAnalysisDesign,
DiagnosticSeverity.Warning,
isEnabledByDefault: true,
description: CreateLocalizableResourceString(nameof(DoNotUseReservedDiagnosticIdDescription)),
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);
public static readonly DiagnosticDescriptor DefineDiagnosticTitleCorrectlyRule = new(
DiagnosticIds.DefineDiagnosticTitleCorrectlyRuleId,
CreateLocalizableResourceString(nameof(DefineDiagnosticTitleCorrectlyTitle)),
CreateLocalizableResourceString(nameof(DefineDiagnosticTitleCorrectlyMessage)),
DiagnosticCategory.MicrosoftCodeAnalysisDesign,
DiagnosticSeverity.Warning,
isEnabledByDefault: true,
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);
public static readonly DiagnosticDescriptor DefineDiagnosticMessageCorrectlyRule = new(
DiagnosticIds.DefineDiagnosticMessageCorrectlyRuleId,
CreateLocalizableResourceString(nameof(DefineDiagnosticMessageCorrectlyTitle)),
CreateLocalizableResourceString(nameof(DefineDiagnosticMessageCorrectlyMessage)),
DiagnosticCategory.MicrosoftCodeAnalysisDesign,
DiagnosticSeverity.Warning,
isEnabledByDefault: true,
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);
public static readonly DiagnosticDescriptor DefineDiagnosticDescriptionCorrectlyRule = new(
DiagnosticIds.DefineDiagnosticDescriptionCorrectlyRuleId,
CreateLocalizableResourceString(nameof(DefineDiagnosticDescriptionCorrectlyTitle)),
CreateLocalizableResourceString(nameof(DefineDiagnosticDescriptionCorrectlyMessage)),
DiagnosticCategory.MicrosoftCodeAnalysisDesign,
DiagnosticSeverity.Warning,
isEnabledByDefault: true,
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);
public static readonly DiagnosticDescriptor AddCompilationEndCustomTagRule = new(
DiagnosticIds.AddCompilationEndCustomTagRuleId,
CreateLocalizableResourceString(nameof(AddCompilationEndCustomTagTitle)),
CreateLocalizableResourceString(nameof(AddCompilationEndCustomTagMessage)),
DiagnosticCategory.MicrosoftCodeAnalysisDesign,
DiagnosticSeverity.Warning,
isEnabledByDefault: true,
description: CreateLocalizableResourceString(nameof(AddCompilationEndCustomTagDescription)),
customTags: WellKnownDiagnosticTagsExtensions.Telemetry);
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(
UseLocalizableStringsInDescriptorRule,
ProvideHelpUriInDescriptorRule,
DiagnosticIdMustBeAConstantRule,
DiagnosticIdMustBeInSpecifiedFormatRule,
UseUniqueDiagnosticIdRule,
UseCategoriesFromSpecifiedRangeRule,
AnalyzerCategoryAndIdRangeFileInvalidRule,
ProvideCustomTagsInDescriptorRule,
DoNotUseReservedDiagnosticIdRule,
DeclareDiagnosticIdInAnalyzerReleaseRule,
UpdateDiagnosticIdInAnalyzerReleaseRule,
RemoveUnshippedDeletedDiagnosticIdRule,
RemoveShippedDeletedDiagnosticIdRule,
UnexpectedAnalyzerDiagnosticForRemovedDiagnosticIdRule,
RemoveDuplicateEntriesForAnalyzerReleaseRule,
RemoveDuplicateEntriesBetweenAnalyzerReleasesRule,
InvalidEntryInAnalyzerReleasesFileRule,
InvalidHeaderInAnalyzerReleasesFileRule,
InvalidUndetectedEntryInAnalyzerReleasesFileRule,
InvalidRemovedOrChangedWithoutPriorNewEntryInAnalyzerReleasesFileRule,
EnableAnalyzerReleaseTrackingRule,
DefineDiagnosticTitleCorrectlyRule,
DefineDiagnosticMessageCorrectlyRule,
DefineDiagnosticDescriptionCorrectlyRule,
AddCompilationEndCustomTagRule);
public override void Initialize(AnalysisContext context)
{
context.EnableConcurrentExecution();
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
context.RegisterCompilationStartAction(compilationContext =>
{
if (!compilationContext.Compilation.TryGetOrCreateTypeByMetadataName(WellKnownTypeNames.MicrosoftCodeAnalysisDiagnosticDescriptor, out var diagnosticDescriptorType) ||
!compilationContext.Compilation.TryGetOrCreateTypeByMetadataName(WellKnownTypeNames.MicrosoftCodeAnalysisLocalizableString, out var localizableResourceType) ||
!compilationContext.Compilation.TryGetOrCreateTypeByMetadataName(WellKnownTypeNames.MicrosoftCodeAnalysisLocalizableResourceString, out var localizableResourceStringType) ||
!compilationContext.Compilation.TryGetOrCreateTypeByMetadataName(WellKnownTypeNames.MicrosoftCodeAnalysisDiagnosticsCompilationEndAnalysisContext, out var compilationEndContextType) ||
!compilationContext.Compilation.TryGetOrCreateTypeByMetadataName(WellKnownTypeNames.MicrosoftCodeAnalysisDiagnostic, out var diagnosticType))
{
return;
}
// Try read the additional file containing the allowed categories, and corresponding ID ranges.
var checkCategoryAndAllowedIds = TryGetCategoryAndAllowedIdsMap(
compilationContext.Options.AdditionalFiles,
compilationContext.CancellationToken,
out AdditionalText? diagnosticCategoryAndIdRangeText,
out ImmutableDictionary<string, ImmutableArray<(string? prefix, int start, int end)>>? categoryAndAllowedIdsMap,
out List<Diagnostic>? invalidFileDiagnostics);
// Try read the additional files containing the shipped and unshipped analyzer releases.
var isAnalyzerReleaseTracking = TryGetReleaseTrackingData(
compilationContext.Options.AdditionalFiles,
compilationContext.CancellationToken,
out var shippedData,
out var unshippedData,
out List<Diagnostic>? invalidReleaseFileEntryDiagnostics);
PooledLocalizabeStringsConcurrentDictionary? localizableTitles = null;
PooledLocalizabeStringsConcurrentDictionary? localizableMessages = null;
PooledLocalizabeStringsConcurrentDictionary? localizableDescriptions = null;
PooledResourcesDataValueConcurrentDictionary? resourcesDataValueMap = null;
var analyzeResourceStrings = HasResxAdditionalFiles(compilationContext.Options);
if (analyzeResourceStrings)
{
localizableTitles = PooledLocalizabeStringsConcurrentDictionary.GetInstance();
localizableMessages = PooledLocalizabeStringsConcurrentDictionary.GetInstance();
localizableDescriptions = PooledLocalizabeStringsConcurrentDictionary.GetInstance();
resourcesDataValueMap = PooledResourcesDataValueConcurrentDictionary.GetInstance();
}
var idToAnalyzerMap = new ConcurrentDictionary<string, ConcurrentDictionary<string, ConcurrentBag<Location>>>();
var seenRuleIds = PooledConcurrentSet<string>.GetInstance();
var customTagsMap = PooledFieldToCustomTagsConcurrentDictionary.GetInstance(SymbolEqualityComparer.Default);
compilationContext.RegisterOperationAction(operationAnalysisContext =>
{
var fieldInitializer = (IFieldInitializerOperation)operationAnalysisContext.Operation;
if (!TryGetDescriptorCreateMethodAndArguments(fieldInitializer, diagnosticDescriptorType, out var creationMethod, out var creationArguments))
{
return;
}
var containingType = operationAnalysisContext.ContainingSymbol.ContainingType;
AnalyzeTitle(operationAnalysisContext, creationArguments, fieldInitializer, containingType,
localizableTitles, resourcesDataValueMap, localizableResourceType, localizableResourceStringType);
AnalyzeMessage(operationAnalysisContext, creationArguments, containingType,
localizableMessages, resourcesDataValueMap, localizableResourceType, localizableResourceStringType);
AnalyzeDescription(operationAnalysisContext, creationArguments, containingType,
localizableDescriptions, resourcesDataValueMap, localizableResourceType, localizableResourceStringType);
AnalyzeHelpLinkUri(operationAnalysisContext, creationArguments, out var helpLink);
AnalyzeCustomTags(operationAnalysisContext, creationArguments, fieldInitializer, customTagsMap);
var (isEnabledByDefault, defaultSeverity) = GetDefaultSeverityAndEnabledByDefault(operationAnalysisContext.Compilation, creationArguments);
if (!TryAnalyzeCategory(operationAnalysisContext, creationArguments, checkCategoryAndAllowedIds,
diagnosticCategoryAndIdRangeText, categoryAndAllowedIdsMap, out var category, out var allowedIdsInfoList))
{
allowedIdsInfoList = default;
}
var analyzerName = fieldInitializer.InitializedFields.First().ContainingType.Name;
AnalyzeRuleId(operationAnalysisContext, creationArguments,
isAnalyzerReleaseTracking, shippedData, unshippedData, seenRuleIds, diagnosticCategoryAndIdRangeText,
category, analyzerName, helpLink, isEnabledByDefault, defaultSeverity, allowedIdsInfoList, idToAnalyzerMap);
}, OperationKind.FieldInitializer);
if (analyzeResourceStrings)
{
compilationContext.RegisterSymbolStartAction(context =>
{
var symbolToResourceMap = PooledFieldToResourceNameAndFileNameConcurrentDictionary.GetInstance(SymbolEqualityComparer.Default);
context.RegisterOperationAction(context =>
{
var fieldInitializer = (IFieldInitializerOperation)context.Operation;
if (TryGetLocalizableResourceStringCreation(fieldInitializer.Value, localizableResourceStringType,
out var nameOfLocalizableResource, out var resourceFileName))
{
foreach (var field in fieldInitializer.InitializedFields)
{
symbolToResourceMap.TryAdd(field, (nameOfLocalizableResource, resourceFileName));
}
}
}, OperationKind.FieldInitializer);
context.RegisterSymbolEndAction(context =>
{
RoslynDebug.Assert(localizableTitles != null);
RoslynDebug.Assert(localizableMessages != null);
RoslynDebug.Assert(localizableDescriptions != null);
RoslynDebug.Assert(resourcesDataValueMap != null);
var namedType = (INamedTypeSymbol)context.Symbol;
AnalyzeLocalizableStrings(localizableTitles, AnalyzeTitleCore, symbolToResourceMap, namedType,
resourcesDataValueMap, context.Options, context.ReportDiagnostic, context.CancellationToken);
AnalyzeLocalizableStrings(localizableMessages, AnalyzeMessageCore, symbolToResourceMap, namedType,
resourcesDataValueMap, context.Options, context.ReportDiagnostic, context.CancellationToken);
AnalyzeLocalizableStrings(localizableDescriptions, AnalyzeDescriptionCore, symbolToResourceMap, namedType,
resourcesDataValueMap, context.Options, context.ReportDiagnostic, context.CancellationToken);
symbolToResourceMap.Free(context.CancellationToken);
});
}, SymbolKind.NamedType);
}
// Flag descriptor fields that are used to report compilation end diagnostics,
// but do not have the required 'WellKnownDiagnosticTags.CompilationEnd' custom tag.
// See https://github.com/dotnet/roslyn-analyzers/issues/6282 for details.
if (compilationEndContextType.GetMembers(DiagnosticWellKnownNames.ReportDiagnosticName).FirstOrDefault() is IMethodSymbol compilationEndReportDiagnosticMethod)
{
var diagnosticCreateMethods = diagnosticType.GetMembers("Create").OfType<IMethodSymbol>()
.Where(m => m.IsPublic() && m.Parameters.Length > 0 && SymbolEqualityComparer.Default.Equals(m.Parameters[0].Type, diagnosticDescriptorType))
.ToImmutableHashSet(SymbolEqualityComparer.Default);
compilationContext.RegisterSymbolStartAction(context =>
{
var localsToDescriptorsMap = PooledConcurrentDictionary<ILocalSymbol, PooledConcurrentSet<IFieldSymbol>>.GetInstance(SymbolEqualityComparer.Default);
var localsUsedForCompilationEndReportDiagnostic = PooledConcurrentSet<ILocalSymbol>.GetInstance(SymbolEqualityComparer.Default);
var fieldsUsedForCompilationEndReportDiagnostic = PooledConcurrentSet<IFieldSymbol>.GetInstance(SymbolEqualityComparer.Default);
context.RegisterOperationAction(context =>
{
var invocation = (IInvocationOperation)context.Operation;
if (invocation.Arguments.IsEmpty)
return;
if (SymbolEqualityComparer.Default.Equals(invocation.TargetMethod, compilationEndReportDiagnosticMethod) &&
invocation.Arguments[0].Value.WalkDownConversion() is ILocalReferenceOperation localReference)
{
// Code pattern such as:
// var diagnostic = Diagnostic.Create(field, ...);
// context.ReportDiagnostic(diagnostic);
localsUsedForCompilationEndReportDiagnostic.Add(localReference.Local);
}
else if (diagnosticCreateMethods.Contains(invocation.TargetMethod))
{
if (invocation.Arguments[0].Value.WalkDownConversion() is IFieldReferenceOperation fieldReference)
{
// Code pattern such as:
// 'Diagnostic.Create(field, ...)'
if (invocation.GetAncestor<IInvocationOperation>(OperationKind.Invocation,
inv => SymbolEqualityComparer.Default.Equals(inv.TargetMethod, compilationEndReportDiagnosticMethod)) is not null)
{
// Code pattern such as:
// 'context.ReportDiagnostic(Diagnostic.Create(field, ...));'
fieldsUsedForCompilationEndReportDiagnostic.Add(fieldReference.Field);
}
else
{
switch (invocation.Parent)
{
case IVariableInitializerOperation variableInitializer:
// Code pattern such as:
// 'var diagnostic = Diagnostic.Create(field, ...);'
if (variableInitializer.GetAncestor<IVariableDeclarationOperation>(OperationKind.VariableDeclaration) is { } variableDeclaration)
{
foreach (var local in variableDeclaration.GetDeclaredVariables())
{
AddToLocalsToDescriptorsMap(local, fieldReference.Field, localsToDescriptorsMap);
}
}
break;
case ISimpleAssignmentOperation simpleAssignment:
// Code pattern such as:
// 'diagnostic = Diagnostic.Create(field, ...);'
if (simpleAssignment.Target is ILocalReferenceOperation localReferenceTarget)
{
AddToLocalsToDescriptorsMap(localReferenceTarget.Local, fieldReference.Field, localsToDescriptorsMap);
}
break;
}
}
}
static void AddToLocalsToDescriptorsMap(ILocalSymbol local, IFieldSymbol field, PooledConcurrentDictionary<ILocalSymbol, PooledConcurrentSet<IFieldSymbol>> localsToDescriptorsMap)
{
localsToDescriptorsMap.AddOrUpdate(local,
addValueFactory: _ =>
{
var set = PooledConcurrentSet<IFieldSymbol>.GetInstance(SymbolEqualityComparer.Default);
set.Add(field);
return set;
},
updateValueFactory: (_, fields) =>
{
fields.Add(field);
return fields;
});
}
}
}, OperationKind.Invocation);
context.RegisterSymbolEndAction(context =>
{
foreach (var local in localsUsedForCompilationEndReportDiagnostic)
{
if (localsToDescriptorsMap.TryGetValue(local, out var fields))
{
foreach (var field in fields)
AnalyzeField(field);
}
}
foreach (var field in fieldsUsedForCompilationEndReportDiagnostic)
{
AnalyzeField(field);
}
foreach (var value in localsToDescriptorsMap.Values)
value.Free(context.CancellationToken);
localsToDescriptorsMap.Free(context.CancellationToken);
localsUsedForCompilationEndReportDiagnostic.Free(context.CancellationToken);
fieldsUsedForCompilationEndReportDiagnostic.Free(context.CancellationToken);
void AnalyzeField(IFieldSymbol field)
{
if (customTagsMap.TryGetValue(field, out var customTags) &&
!customTags.IsDefault &&
!customTags.Contains(CompilationEndWellKnownDiagnosticTag) &&
!field.Locations.IsEmpty &&
field.Locations[0].IsInSource)
{
context.ReportDiagnostic(Diagnostic.Create(AddCompilationEndCustomTagRule, field.Locations[0], field.Name));
}
}
});
}, SymbolKind.NamedType);
}
compilationContext.RegisterCompilationEndAction(compilationEndContext =>
{
// Report any invalid additional file diagnostics.
if (invalidFileDiagnostics != null)
{
foreach (var diagnostic in invalidFileDiagnostics)
{
compilationEndContext.ReportDiagnostic(diagnostic);
}
}
// Report diagnostics for duplicate diagnostic ID used across analyzers.
foreach (var kvp in idToAnalyzerMap)
{
var ruleId = kvp.Key;
var analyzerToDescriptorLocationsMap = kvp.Value;
if (analyzerToDescriptorLocationsMap.Count <= 1)
{
// ID used by a single analyzer.
continue;
}
ImmutableSortedSet<string> sortedAnalyzerNames = analyzerToDescriptorLocationsMap.Keys.ToImmutableSortedSet();
var skippedAnalyzerName = sortedAnalyzerNames[0];
foreach (var analyzerName in sortedAnalyzerNames.Skip(1))
{
var locations = analyzerToDescriptorLocationsMap[analyzerName];
foreach (var location in locations)
{
// Diagnostic Id '{0}' is already used by analyzer '{1}'. Please use a different diagnostic ID.
var diagnostic = Diagnostic.Create(UseUniqueDiagnosticIdRule, location, ruleId, skippedAnalyzerName);
compilationEndContext.ReportDiagnostic(diagnostic);
}
}
}
// Report analyzer release tracking invalid entry and compilation end diagnostics.
if (isAnalyzerReleaseTracking || invalidReleaseFileEntryDiagnostics != null)
{
RoslynDebug.Assert(shippedData != null);
RoslynDebug.Assert(unshippedData != null);
ReportAnalyzerReleaseTrackingDiagnostics(invalidReleaseFileEntryDiagnostics, shippedData, unshippedData, seenRuleIds, compilationEndContext);
}
seenRuleIds.Free(compilationEndContext.CancellationToken);
if (analyzeResourceStrings)
{
RoslynDebug.Assert(localizableTitles != null);
RoslynDebug.Assert(localizableMessages != null);
RoslynDebug.Assert(localizableDescriptions != null);
RoslynDebug.Assert(resourcesDataValueMap != null);
FreeLocalizableStringsMap(localizableTitles, compilationEndContext.CancellationToken);
FreeLocalizableStringsMap(localizableMessages, compilationEndContext.CancellationToken);
FreeLocalizableStringsMap(localizableDescriptions, compilationEndContext.CancellationToken);
resourcesDataValueMap.Free(compilationEndContext.CancellationToken);
}
customTagsMap.Free(compilationEndContext.CancellationToken);
});
});
static void FreeLocalizableStringsMap(PooledLocalizabeStringsConcurrentDictionary localizableStrings, CancellationToken cancellationToken)
{
foreach (var builder in localizableStrings.Values)
{
builder.Free(cancellationToken);
}
localizableStrings.Free(cancellationToken);
}
}
private static bool TryGetDescriptorCreateMethodAndArguments(
IFieldInitializerOperation fieldInitializer,
INamedTypeSymbol diagnosticDescriptorType,
[NotNullWhen(returnValue: true)] out IMethodSymbol? creationMethod,
[NotNullWhen(returnValue: true)] out ImmutableArray<IArgumentOperation> creationArguments)
{
(creationMethod, creationArguments) = fieldInitializer.Value.WalkDownConversion() switch
{
IObjectCreationOperation objectCreation when IsDescriptorConstructor(objectCreation.Constructor)
=> (objectCreation.Constructor, objectCreation.Arguments),
IInvocationOperation invocation when IsCreateHelper(invocation.TargetMethod)
=> (invocation.TargetMethod, invocation.Arguments),
_ => default
};
return creationMethod != null;
bool IsDescriptorConstructor(IMethodSymbol? method)
=> SymbolEqualityComparer.Default.Equals(method?.ContainingType, diagnosticDescriptorType);
// Heuristic to identify helper methods to create DiagnosticDescriptor:
// "A method invocation that returns 'DiagnosticDescriptor' and has a first string parameter named 'id'"
bool IsCreateHelper(IMethodSymbol method)
=> SymbolEqualityComparer.Default.Equals(method.ReturnType, diagnosticDescriptorType) &&
!method.Parameters.IsEmpty &&
method.Parameters[0].Name == DiagnosticIdParameterName &&
method.Parameters[0].Type.SpecialType == SpecialType.System_String;
}
private static bool TryGetLocalizableResourceStringCreation(
IOperation operation,
INamedTypeSymbol localizableResourceStringType,
[NotNullWhen(returnValue: true)] out string? nameOfLocalizableResource,
[NotNullWhen(returnValue: true)] out string? resourceFileName)
{
return TryGetConstructorCreation(out nameOfLocalizableResource, out resourceFileName) ||
TryGetHelperMethodCreation(out nameOfLocalizableResource, out resourceFileName);
// Local functions
// Attempts to get the resource and file name for the creation of a localizable resource string using the
// constructor on LocalizableResourceString
bool TryGetConstructorCreation([NotNullWhen(true)] out string? nameOfLocalizableResource, [NotNullWhen(true)] out string? resourceFileName)
{
if (operation.WalkDownConversion() is IObjectCreationOperation objectCreation &&
SymbolEqualityComparer.Default.Equals(objectCreation.Constructor?.ContainingType, localizableResourceStringType) &&
objectCreation.Arguments.Length >= 3 &&
objectCreation.Arguments.GetArgumentForParameterAtIndex(0) is { } firstParamArgument &&
firstParamArgument.Parameter?.Type.SpecialType == SpecialType.System_String &&
firstParamArgument.Value.ConstantValue.HasValue &&
firstParamArgument.Value.ConstantValue.Value is string nameOfResource &&
objectCreation.Arguments.GetArgumentForParameterAtIndex(2) is { } thirdParamArgument &&
thirdParamArgument.Value is ITypeOfOperation typeOfOperation &&
typeOfOperation.TypeOperand is { } typeOfType)
{
nameOfLocalizableResource = nameOfResource;
resourceFileName = typeOfType.Name;
return true;
}
nameOfLocalizableResource = null;
resourceFileName = null;
return false;
}
// Attempts to get the resource and file name for the creation of a localizable resource string using a
// helper method on the resource class. For an operation to be considered a helper method invocation, it must
// - Be an invocation of a static method
// - Method must have return type 'LocalizableResourceString'
// - Method must have single 'string' parameter
// - Argument must be a compile-time constant (typically a nameof operation on one of the resource class's properties).
bool TryGetHelperMethodCreation([NotNullWhen(true)] out string? nameOfLocalizableResource, [NotNullWhen(true)] out string? resourceFileName)
{
if (operation.WalkDownConversion() is IInvocationOperation invocation &&
invocation.TargetMethod.ReturnType.Equals(localizableResourceStringType) &&
invocation.Arguments.Length == 1 &&
invocation.Arguments[0].Parameter?.Type.SpecialType == SpecialType.System_String &&
invocation.Arguments[0].Value.ConstantValue.HasValue &&
invocation.Arguments[0].Value.ConstantValue.Value is string nameOfResource)
{
nameOfLocalizableResource = nameOfResource;
resourceFileName = invocation.TargetMethod.ContainingType.Name;
return true;
}
nameOfLocalizableResource = null;
resourceFileName = null;
return false;
}
}
private static void AnalyzeTitle(
OperationAnalysisContext operationAnalysisContext,
ImmutableArray<IArgumentOperation> creationArguments,
IFieldInitializerOperation creation,
INamedTypeSymbol containingType,
PooledLocalizabeStringsConcurrentDictionary? localizableTitles,
PooledResourcesDataValueConcurrentDictionary? resourceDataValueMap,
INamedTypeSymbol localizableStringType,
INamedTypeSymbol localizableResourceStringType)
{
IArgumentOperation? titleArgument = creationArguments.FirstOrDefault(a => a.Parameter?.Name.Equals("title", StringComparison.OrdinalIgnoreCase) == true);
if (titleArgument != null)
{
if (titleArgument.Parameter?.Type.SpecialType == SpecialType.System_String)
{
operationAnalysisContext.ReportDiagnostic(creation.Value.CreateDiagnostic(UseLocalizableStringsInDescriptorRule, WellKnownTypeNames.MicrosoftCodeAnalysisLocalizableString));
}
AnalyzeDescriptorArgument(operationAnalysisContext, titleArgument,
AnalyzeTitleCore, containingType, localizableTitles, resourceDataValueMap,
localizableStringType, localizableResourceStringType);
}
}
private static void AnalyzeTitleCore(string title, IArgumentOperation argumentOperation, Location fixLocation, Action<Diagnostic> reportDiagnostic)
{
var hasLeadingOrTrailingWhitespaces = HasLeadingOrTrailingWhitespaces(title);
if (hasLeadingOrTrailingWhitespaces)
{
title = RemoveLeadingAndTrailingWhitespaces(title);
}
var isMultiSentences = IsMultiSentences(title);
var endsWithPeriod = EndsWithPeriod(title);
var containsLineReturn = ContainsLineReturn(title);
if (isMultiSentences || endsWithPeriod || containsLineReturn || hasLeadingOrTrailingWhitespaces)
{
// Leading and trailing spaces were already fixed
var fixedTitle = endsWithPeriod ? RemoveTrailingPeriod(title) : title;
fixedTitle = isMultiSentences ? FixMultiSentences(fixedTitle) : fixedTitle;
fixedTitle = containsLineReturn ? FixLineReturns(fixedTitle, allowMultisentences: false) : fixedTitle;
ReportDefineDiagnosticArgumentCorrectlyDiagnostic(DefineDiagnosticTitleCorrectlyRule,
argumentOperation, fixedTitle, fixLocation, reportDiagnostic);
}
}
private static void ReportDefineDiagnosticArgumentCorrectlyDiagnostic(
DiagnosticDescriptor descriptor,
IArgumentOperation argumentOperation,
string fixValue,
Location fixLocation,
Action<Diagnostic> reportDiagnostic)
{
// Additional location in an additional document does not seem to be preserved
// from analyzer to code fix due to a Roslyn bug: https://github.com/dotnet/roslyn/issues/46377
// We workaround this bug by passing additional document file path and location span as strings.
var additionalLocations = ImmutableArray<Location>.Empty;
var properties = ImmutableDictionary<string, string?>.Empty.Add(DefineDescriptorArgumentCorrectlyFixValue, fixValue);
if (fixLocation.IsInSource)
{
additionalLocations = additionalLocations.Add(fixLocation);
}
else
{
var span = fixLocation.SourceSpan;
var locationInfo = $"{span.Start}{AdditionalDocumentLocationInfoSeparator}{span.Length}{AdditionalDocumentLocationInfoSeparator}{fixLocation.GetLineSpan().Path}";
properties = properties.Add(DefineDescriptorArgumentCorrectlyFixAdditionalDocumentLocationInfo, locationInfo);
}
reportDiagnostic(argumentOperation.CreateDiagnostic(descriptor, additionalLocations, properties));
}
internal static bool TryGetAdditionalDocumentLocationInfo(Diagnostic diagnostic,
[NotNullWhen(returnValue: true)] out string? filePath,
[NotNullWhen(returnValue: true)] out TextSpan? fileSpan)
{
Debug.Assert(diagnostic.Id is DiagnosticIds.DefineDiagnosticTitleCorrectlyRuleId or
DiagnosticIds.DefineDiagnosticMessageCorrectlyRuleId or
DiagnosticIds.DefineDiagnosticDescriptionCorrectlyRuleId);
filePath = null;
fileSpan = null;
if (!diagnostic.Properties.TryGetValue(DefineDescriptorArgumentCorrectlyFixAdditionalDocumentLocationInfo, out var locationInfo)
|| locationInfo is null)
{
return false;
}
var parts = locationInfo.Split(new[] { AdditionalDocumentLocationInfoSeparator }, StringSplitOptions.None);
if (parts.Length != 3 ||
!int.TryParse(parts[0], out var spanSpart) ||
!int.TryParse(parts[1], out var spanLength))
{
return false;
}
fileSpan = new TextSpan(spanSpart, spanLength);
filePath = parts[2];
return !string.IsNullOrEmpty(filePath);
}
private static void AnalyzeMessage(
OperationAnalysisContext operationAnalysisContext,
ImmutableArray<IArgumentOperation> creationArguments,
INamedTypeSymbol containingType,
PooledLocalizabeStringsConcurrentDictionary? localizableMessages,
PooledResourcesDataValueConcurrentDictionary? resourceDataValueMap,
INamedTypeSymbol localizableStringType,
INamedTypeSymbol localizableResourceStringType)
{
var messageArgument = creationArguments.FirstOrDefault(a => a.Parameter?.Name.Equals("messageFormat", StringComparison.OrdinalIgnoreCase) == true);
if (messageArgument != null)
{
AnalyzeDescriptorArgument(operationAnalysisContext, messageArgument,
AnalyzeMessageCore, containingType, localizableMessages, resourceDataValueMap,
localizableStringType, localizableResourceStringType);
}
}
private static void AnalyzeMessageCore(string message, IArgumentOperation argumentOperation, Location fixLocation, Action<Diagnostic> reportDiagnostic)
{
var hasLeadingOrTrailingWhitespaces = HasLeadingOrTrailingWhitespaces(message);
if (hasLeadingOrTrailingWhitespaces)
{
message = RemoveLeadingAndTrailingWhitespaces(message);
}
var isMultiSentences = IsMultiSentences(message);
var endsWithPeriod = EndsWithPeriod(message);
var containsLineReturn = ContainsLineReturn(message);
if (isMultiSentences ^ endsWithPeriod || containsLineReturn || hasLeadingOrTrailingWhitespaces)
{
// Leading and trailing spaces were already fixed
var fixedMessage = containsLineReturn ? FixLineReturns(message, allowMultisentences: true) : message;
isMultiSentences = IsMultiSentences(fixedMessage);
endsWithPeriod = EndsWithPeriod(fixedMessage);
if (isMultiSentences ^ endsWithPeriod)
{
fixedMessage = endsWithPeriod ? RemoveTrailingPeriod(fixedMessage) : fixedMessage + ".";
}
ReportDefineDiagnosticArgumentCorrectlyDiagnostic(DefineDiagnosticMessageCorrectlyRule,
argumentOperation, fixedMessage, fixLocation, reportDiagnostic);
}
}
private static void AnalyzeDescription(
OperationAnalysisContext operationAnalysisContext,
ImmutableArray<IArgumentOperation> creationArguments,
INamedTypeSymbol containingType,
PooledLocalizabeStringsConcurrentDictionary? localizableDescriptions,
PooledResourcesDataValueConcurrentDictionary? resourceDataValueMap,
INamedTypeSymbol localizableStringType,
INamedTypeSymbol localizableResourceStringType)
{
IArgumentOperation? descriptionArgument = creationArguments.FirstOrDefault(a => a.Parameter?.Name.Equals("description", StringComparison.OrdinalIgnoreCase) == true);
if (descriptionArgument != null)
{
AnalyzeDescriptorArgument(operationAnalysisContext, descriptionArgument,
AnalyzeDescriptionCore, containingType, localizableDescriptions, resourceDataValueMap,
localizableStringType, localizableResourceStringType);
}
}
private static void AnalyzeDescriptionCore(string description, IArgumentOperation argumentOperation, Location fixLocation, Action<Diagnostic> reportDiagnostic)
{
var hasLeadingOrTrailingWhitespaces = HasLeadingOrTrailingWhitespaces(description);
if (hasLeadingOrTrailingWhitespaces)
{
description = RemoveLeadingAndTrailingWhitespaces(description);
}
var endsWithPunctuation = EndsWithPunctuation(description);
if (!endsWithPunctuation || hasLeadingOrTrailingWhitespaces)
{
var fixedDescription = !endsWithPunctuation ? description + "." : description;
ReportDefineDiagnosticArgumentCorrectlyDiagnostic(DefineDiagnosticDescriptionCorrectlyRule,
argumentOperation, fixedDescription, fixLocation, reportDiagnostic);
}
}
private static void AnalyzeDescriptorArgument(
OperationAnalysisContext operationAnalysisContext,
IArgumentOperation argument,
Action<string, IArgumentOperation, Location, Action<Diagnostic>> analyzeStringValueCore,
INamedTypeSymbol containingType,
PooledLocalizabeStringsConcurrentDictionary? localizableStringsMap,
PooledResourcesDataValueConcurrentDictionary? resourceDataValueMap,
INamedTypeSymbol localizableStringType,
INamedTypeSymbol localizableResourceStringType)
{
if (TryGetNonEmptyConstantStringValue(argument, out var argumentValue, out var argumentValueLocation))
{
analyzeStringValueCore(argumentValue, argument, argumentValueLocation, operationAnalysisContext.ReportDiagnostic);
}
else if (localizableStringsMap != null &&
SymbolEqualityComparer.Default.Equals(argument.Parameter?.Type, localizableStringType))
{
RoslynDebug.Assert(resourceDataValueMap != null);
if (TryGetLocalizableResourceStringCreation(argument.Value, localizableResourceStringType,
out var nameOfLocalizableResource, out var resourceFileName))
{
AnalyzeLocalizableDescriptorArgument(analyzeStringValueCore, nameOfLocalizableResource, resourceFileName,
argument, resourceDataValueMap, operationAnalysisContext.Options,
operationAnalysisContext.ReportDiagnostic, operationAnalysisContext.CancellationToken);
}
else
{
var value = argument.Value.WalkDownConversion();
if (value is IFieldReferenceOperation fieldReference &&
fieldReference.Field.Type.DerivesFrom(localizableStringType, baseTypesOnly: true))
{
var builder = localizableStringsMap.GetOrAdd(containingType, _ => PooledConcurrentSet<(IFieldSymbol, IArgumentOperation)>.GetInstance());
builder.Add((fieldReference.Field, argument));
}
}
}
}
private static void AnalyzeLocalizableDescriptorArgument(
Action<string, IArgumentOperation, Location, Action<Diagnostic>> analyzeStringValueCore,
string nameOfLocalizableResource,
string resourceFileName,
IArgumentOperation argument,
PooledResourcesDataValueConcurrentDictionary resourceDataValueMap,
AnalyzerOptions options,
Action<Diagnostic> reportDiagnostic,
CancellationToken cancellationToken)
{
var map = GetOrCreateResourceMap(options, resourceFileName, resourceDataValueMap, cancellationToken);
if (map.TryGetValue(nameOfLocalizableResource, out var resourceStringTuple))
{
analyzeStringValueCore(resourceStringTuple.value, argument, resourceStringTuple.location, reportDiagnostic);
}
}
private static void AnalyzeLocalizableStrings(
PooledLocalizabeStringsConcurrentDictionary localizableStringsMap,
Action<string, IArgumentOperation, Location, Action<Diagnostic>> analyzeLocalizableStringValueCore,
PooledFieldToResourceNameAndFileNameConcurrentDictionary symbolToResourceMap,
INamedTypeSymbol namedType,
PooledResourcesDataValueConcurrentDictionary resourceDataValueMap,
AnalyzerOptions options,
Action<Diagnostic> reportDiagnostic,
CancellationToken cancellationToken)
{
if (localizableStringsMap.TryRemove(namedType, out var localizableFieldsWithOriginalArguments))
{
foreach (var (field, argument) in localizableFieldsWithOriginalArguments)
{
if (symbolToResourceMap.TryGetValue(field, out var resourceTuple))
{
AnalyzeLocalizableDescriptorArgument(analyzeLocalizableStringValueCore, resourceTuple.nameOfResource, resourceTuple.resourceFileName,
argument, resourceDataValueMap, options, reportDiagnostic, cancellationToken);
}
}
localizableFieldsWithOriginalArguments.Dispose();
}
}
private static bool TryGetNonEmptyConstantStringValue(
IArgumentOperation argumentOperation,
[NotNullWhen(true)] out string? value,
[NotNullWhen(true)] out Location? valueLocation)
{
value = null;
valueLocation = null;
IOperation valueOperation;
var argumentValueOperation = argumentOperation.Value.WalkDownConversion();
if (argumentValueOperation is ILiteralOperation literalOperation)
{
valueOperation = literalOperation;
}
else if (argumentValueOperation is IFieldReferenceOperation fieldReferenceOperation &&
fieldReferenceOperation.Syntax.SyntaxTree == argumentValueOperation.Syntax.SyntaxTree &&
fieldReferenceOperation.Field.DeclaringSyntaxReferences.Length == 1 &&
fieldReferenceOperation.Field.DeclaringSyntaxReferences[0].GetSyntax() is { } fieldDeclaration &&
fieldDeclaration.SyntaxTree == argumentValueOperation.Syntax.SyntaxTree &&
GetFieldInitializer(fieldDeclaration, argumentValueOperation.SemanticModel!) is { } fieldInitializer &&
fieldInitializer.Value.WalkDownConversion() is ILiteralOperation fieldInitializerLiteral)
{
valueOperation = fieldInitializerLiteral;
}
else
{
valueOperation = argumentValueOperation;
}
if (!TryGetNonEmptyConstantStringValueCore(valueOperation, out var literalValue))
{
return false;
}
value = literalValue;
valueLocation = valueOperation.Syntax.GetLocation();
return true;
static IFieldInitializerOperation? GetFieldInitializer(SyntaxNode fieldDeclaration, SemanticModel model)
{
if (fieldDeclaration.Language == LanguageNames.VisualBasic)
{
// For VB, the field initializer is on the parent node.
fieldDeclaration = fieldDeclaration.Parent!;
}
foreach (var node in fieldDeclaration.DescendantNodes())
{
if (model.GetOperation(node) is IFieldInitializerOperation initializer)
{
return initializer;
}
}
return null;
}
}
private static bool TryGetNonEmptyConstantStringValueCore(IOperation operation, [NotNullWhen(returnValue: true)] out string? literalValue)
{
if (operation.ConstantValue.HasValue &&
operation.ConstantValue.Value is string value &&
!string.IsNullOrEmpty(value))
{
literalValue = value;
return true;
}
literalValue = null;
return false;
}
// Assumes that a string is a multi-sentences if it contains a period followed by a whitespace ('. ').
private const string MultiSentenceSeparator = ". ";
private static bool IsMultiSentences(string s)
=> s.Contains(MultiSentenceSeparator);
private static string FixMultiSentences(string s)
{
Debug.Assert(IsMultiSentences(s));
var index = s.IndexOf(MultiSentenceSeparator, StringComparison.OrdinalIgnoreCase);
return s[..index];
}
private static bool EndsWithPeriod(string s)
=> s[^1] == '.';
private static string RemoveTrailingPeriod(string s)
{
Debug.Assert(EndsWithPeriod(s));
return s[0..^1];
}
private static bool ContainsLineReturn(string s)
=> s.Contains("\r") || s.Contains("\n");
private static string FixLineReturns(string s, bool allowMultisentences)
{
Debug.Assert(ContainsLineReturn(s));
var parts = s.Split(new[] { "\r\n", "\r", "\n" }, StringSplitOptions.RemoveEmptyEntries);
if (!allowMultisentences)
{
return parts[0];
}
var builder = new StringBuilder();
for (var i = 0; i < parts.Length; i++)
{
var part = parts[i];
if (!EndsWithPeriod(part))
{
part += ".";
}
if (part.TrimEnd().Length == part.Length &&
i < parts.Length - 1)
{
part += " ";
}