-
Notifications
You must be signed in to change notification settings - Fork 4k
/
ClsComplianceChecker.cs
1416 lines (1225 loc) · 60.4 KB
/
ClsComplianceChecker.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
// 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.
#nullable disable
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.CSharp.Symbols;
using Microsoft.CodeAnalysis.ErrorReporting;
using Microsoft.CodeAnalysis.Text;
using Roslyn.Utilities;
namespace Microsoft.CodeAnalysis.CSharp
{
/// <summary>
/// Traverses the symbol table checking for CLS compliance.
/// </summary>
internal partial class ClsComplianceChecker : CSharpSymbolVisitor
{
private readonly CSharpCompilation _compilation;
private readonly SyntaxTree _filterTree; //if not null, limit analysis to types residing in this tree
private readonly TextSpan? _filterSpanWithinTree; //if filterTree and filterSpanWithinTree is not null, limit analysis to types residing within this span in the filterTree.
private readonly BindingDiagnosticBag _diagnostics;
private readonly CancellationToken _cancellationToken;
private readonly ConcurrentDictionary<Symbol, Compliance> _declaredOrInheritedCompliance;
/// <seealso cref="MethodCompiler._compilerTasks"/>
private readonly ConcurrentStack<Task> _compilerTasks;
private ClsComplianceChecker(
CSharpCompilation compilation,
SyntaxTree filterTree,
TextSpan? filterSpanWithinTree,
BindingDiagnosticBag diagnostics,
CancellationToken cancellationToken)
{
Debug.Assert(diagnostics.DependenciesBag is null || diagnostics.DependenciesBag is ConcurrentSet<AssemblySymbol>);
_compilation = compilation;
_filterTree = filterTree;
_filterSpanWithinTree = filterSpanWithinTree;
_diagnostics = diagnostics;
_cancellationToken = cancellationToken;
_declaredOrInheritedCompliance = new ConcurrentDictionary<Symbol, Compliance>(Symbols.SymbolEqualityComparer.ConsiderEverything);
if (ConcurrentAnalysis)
{
_compilerTasks = new ConcurrentStack<Task>();
}
}
/// <summary>
/// Gets a value indicating whether <see cref="ClsComplianceChecker"/> is allowed to analyze in parallel.
/// </summary>
private bool ConcurrentAnalysis => _filterTree == null && _compilation.Options.ConcurrentBuild;
/// <summary>
/// Traverses the symbol table checking for CLS compliance.
/// </summary>
/// <param name="compilation">Compilation that owns the symbol table.</param>
/// <param name="diagnostics">Will be supplemented with documentation comment diagnostics.</param>
/// <param name="cancellationToken">To stop traversing the symbol table early.</param>
/// <param name="filterTree">Only report diagnostics from this syntax tree, if non-null.</param>
/// <param name="filterSpanWithinTree">If <paramref name="filterTree"/> and <paramref name="filterSpanWithinTree"/> is non-null, report diagnostics within this span in the <paramref name="filterTree"/>.</param>
public static void CheckCompliance(CSharpCompilation compilation, BindingDiagnosticBag diagnostics, CancellationToken cancellationToken, SyntaxTree filterTree = null, TextSpan? filterSpanWithinTree = null)
{
var queue = new BindingDiagnosticBag(diagnostics.DiagnosticBag, diagnostics.AccumulatesDependencies ? new ConcurrentSet<AssemblySymbol>() : null);
var checker = new ClsComplianceChecker(compilation, filterTree, filterSpanWithinTree, queue, cancellationToken);
checker.Visit(compilation.Assembly);
checker.WaitForWorkers();
diagnostics.AddDependencies(queue);
}
public override void VisitAssembly(AssemblySymbol symbol)
{
_cancellationToken.ThrowIfCancellationRequested();
System.Diagnostics.Debug.Assert(symbol is SourceAssemblySymbol);
Compliance assemblyCompliance = GetDeclaredOrInheritedCompliance(symbol);
if (assemblyCompliance == Compliance.DeclaredFalse)
{
// Our interpretation of an assembly-level CLSCompliant attribute is as follows:
// 1) If true, then perform all CLS checks.
// 2) If false, then perform no CLS checks (dev11 still performs a few, mostly around
// meaningless attributes). Our interpretation is that the user ultimately wants
// his code to be CLS-compliant, but is temporarily disabling the checks (e.g. during
// refactoring/prototyping).
// 3) If absent, the perform all CLS checks. Our interpretation is that - in the
// absence of an assembly-level attribute - any CLS problems within the compilation
// indicate that the user was trying to do something but didn't know how. It would
// be nice if the most common case (i.e. this one) was the cheapest, but we don't
// want to confuse novice users.
return;
}
bool assemblyComplianceValue = IsTrue(assemblyCompliance);
for (int i = 0; i < symbol.Modules.Length; i++)
{
ModuleSymbol module = symbol.Modules[i];
Location attributeLocation;
bool? moduleDeclaredCompliance = GetDeclaredCompliance(module, out attributeLocation);
Location warningLocation = i == 0 ? attributeLocation : module.Locations[0];
System.Diagnostics.Debug.Assert(warningLocation != null || !moduleDeclaredCompliance.HasValue || (i == 0 && _filterTree != null),
"Can only be null when the source location is filtered out.");
if (moduleDeclaredCompliance.HasValue)
{
if (warningLocation != null)
{
if (!IsDeclared(assemblyCompliance))
{
// This is not useful on non-source modules, but dev11 reports it anyway.
this.AddDiagnostic(ErrorCode.WRN_CLS_NotOnModules, warningLocation);
}
else if (assemblyComplianceValue != moduleDeclaredCompliance.GetValueOrDefault())
{
this.AddDiagnostic(ErrorCode.WRN_CLS_NotOnModules2, warningLocation);
}
}
}
else if (assemblyComplianceValue && i > 0)
{
bool sawClsCompliantAttribute = false;
var peModule = (Symbols.Metadata.PE.PEModuleSymbol)module;
foreach (CSharpAttributeData assemblyLevelAttribute in peModule.GetAssemblyAttributes())
{
if (assemblyLevelAttribute.IsTargetAttribute(peModule, AttributeDescription.CLSCompliantAttribute))
{
sawClsCompliantAttribute = true;
break;
}
}
if (!sawClsCompliantAttribute)
{
this.AddDiagnostic(ErrorCode.WRN_CLS_ModuleMissingCLS, warningLocation);
}
}
}
if (assemblyComplianceValue)
{
CheckForAttributeWithArrayArgument(symbol);
}
ModuleSymbol sourceModule = symbol.Modules[0];
if (IsTrue(GetDeclaredOrInheritedCompliance(sourceModule)))
{
CheckForAttributeWithArrayArgument(sourceModule);
}
Visit(symbol.GlobalNamespace);
}
private void WaitForWorkers()
{
var tasks = _compilerTasks;
if (tasks == null)
{
return;
}
while (tasks.TryPop(out Task curTask))
{
curTask.GetAwaiter().GetResult();
}
}
public override void VisitNamespace(NamespaceSymbol symbol)
{
_cancellationToken.ThrowIfCancellationRequested();
if (DoNotVisit(symbol)) return;
if (IsTrue(GetDeclaredOrInheritedCompliance(symbol)))
{
CheckName(symbol);
CheckMemberDistinctness(symbol);
}
if (ConcurrentAnalysis)
{
VisitNamespaceMembersAsTasks(symbol);
}
else
{
VisitNamespaceMembers(symbol);
}
}
private void VisitNamespaceMembersAsTasks(NamespaceSymbol symbol)
{
foreach (var m in symbol.GetMembersUnordered())
{
_compilerTasks.Push(Task.Run(UICultureUtilities.WithCurrentUICulture(() =>
{
try
{
Visit(m);
}
catch (Exception e) when (FatalError.ReportAndPropagateUnlessCanceled(e))
{
throw ExceptionUtilities.Unreachable();
}
}), _cancellationToken));
}
}
private void VisitNamespaceMembers(NamespaceSymbol symbol)
{
foreach (var m in symbol.GetMembersUnordered())
{
Visit(m);
}
}
[PerformanceSensitive("https://github.com/dotnet/roslyn/issues/23582", IsParallelEntry = false)]
public override void VisitNamedType(NamedTypeSymbol symbol)
{
_cancellationToken.ThrowIfCancellationRequested();
if (DoNotVisit(symbol)) return;
Debug.Assert(!symbol.IsImplicitClass);
Compliance compliance = GetDeclaredOrInheritedCompliance(symbol);
if (VisitTypeOrMember(symbol, compliance))
{
if (IsTrue(compliance))
{
CheckBaseTypeCompliance(symbol);
CheckTypeParameterCompliance(symbol.TypeParameters, symbol);
if (symbol.TypeKind == TypeKind.Delegate)
{
CheckParameterCompliance(symbol.DelegateInvokeMethod.Parameters, symbol);
}
else if (_compilation.IsAttributeType(symbol) && !HasAcceptableAttributeConstructor(symbol))
{
this.AddDiagnostic(ErrorCode.WRN_CLS_BadAttributeType, symbol.Locations[0], symbol);
}
}
}
// You may assume we could skip the members if this type is inaccessible,
// but dev11 reports that they are inaccessible as well.
foreach (var m in symbol.GetMembersUnordered())
{
Visit(m);
}
}
private bool HasAcceptableAttributeConstructor(NamedTypeSymbol attributeType)
{
foreach (MethodSymbol constructor in attributeType.InstanceConstructors)
{
if (IsTrue(GetDeclaredOrInheritedCompliance(constructor)) && IsAccessibleIfContainerIsAccessible(constructor))
{
System.Diagnostics.Debug.Assert(IsAccessibleOutsideAssembly(constructor), "Should be implied by IsAccessibleIfContainerIsAccessible");
bool hasUnacceptableParameterType = false;
foreach (var paramType in constructor.ParameterTypesWithAnnotations) // Public caller would select type out of parameters.
{
if (paramType.TypeKind == TypeKind.Array ||
paramType.Type.GetAttributeParameterTypedConstantKind(_compilation) == TypedConstantKind.Error)
{
hasUnacceptableParameterType = true;
break;
}
}
if (!hasUnacceptableParameterType)
{
return true;
}
}
}
return false;
}
public override void VisitMethod(MethodSymbol symbol)
{
_cancellationToken.ThrowIfCancellationRequested();
if (DoNotVisit(symbol)) return;
Compliance compliance = GetDeclaredOrInheritedCompliance(symbol);
// Most CLS checks don't apply to accessors.
if (symbol.IsAccessor())
{
CheckForAttributeOnAccessor(symbol);
CheckForMeaninglessOnParameter(symbol.Parameters);
CheckForMeaninglessOnReturn(symbol);
if (IsTrue(compliance))
{
CheckForAttributeWithArrayArgument(symbol);
}
return;
}
if (!VisitTypeOrMember(symbol, compliance)) return;
if (IsTrue(compliance))
{
CheckParameterCompliance(symbol.Parameters, symbol.ContainingType);
CheckTypeParameterCompliance(symbol.TypeParameters, symbol.ContainingType);
if (symbol.IsVararg)
{
this.AddDiagnostic(ErrorCode.WRN_CLS_NoVarArgs, symbol.Locations[0]);
}
}
}
private void CheckForAttributeOnAccessor(MethodSymbol symbol)
{
foreach (CSharpAttributeData attribute in symbol.GetAttributes())
{
if (attribute.IsTargetAttribute(symbol, AttributeDescription.CLSCompliantAttribute))
{
Location attributeLocation;
if (TryGetAttributeWarningLocation(attribute, out attributeLocation))
{
AttributeUsageInfo attributeUsage = attribute.AttributeClass.GetAttributeUsageInfo();
this.AddDiagnostic(ErrorCode.ERR_AttributeNotOnAccessor, attributeLocation, attribute.AttributeClass.Name, attributeUsage.GetValidTargetsErrorArgument());
break;
}
}
}
}
public override void VisitProperty(PropertySymbol symbol)
{
_cancellationToken.ThrowIfCancellationRequested();
if (DoNotVisit(symbol)) return;
Compliance compliance = GetDeclaredOrInheritedCompliance(symbol);
if (!VisitTypeOrMember(symbol, compliance)) return;
// Rule 28 requires that the accessors "adhere to a special naming pattern".
// We don't actually need to do anything here, because they automatically
// will unless they override accessors from metadata - we don't check overrides -
// or they explicitly implement interface accessors - we don't check non-public
// members.
if (IsTrue(compliance))
{
CheckParameterCompliance(symbol.Parameters, symbol.ContainingType);
}
}
public override void VisitEvent(EventSymbol symbol)
{
_cancellationToken.ThrowIfCancellationRequested();
if (DoNotVisit(symbol)) return;
Compliance compliance = GetDeclaredOrInheritedCompliance(symbol);
// Rule 32 specifies the shapes of the accessor signatures. However,
// even though WinRT events have a different shape, dev11 does not
// report that they are non-compliant.
// Rule 28 requires that the accessors "adhere to a special naming pattern".
// We don't actually need to do anything here, because they automatically
// will unless they override accessors from metadata - we don't check overrides -
// or they explicitly implement interface accessors - we don't check non-public
// members.
if (!VisitTypeOrMember(symbol, compliance)) return;
}
public override void VisitField(FieldSymbol symbol)
{
_cancellationToken.ThrowIfCancellationRequested();
if (DoNotVisit(symbol)) return;
Compliance compliance = GetDeclaredOrInheritedCompliance(symbol);
if (!VisitTypeOrMember(symbol, compliance)) return;
if (IsTrue(compliance))
{
if (symbol.IsVolatile)
{
this.AddDiagnostic(ErrorCode.WRN_CLS_VolatileField, symbol.Locations[0], symbol);
}
}
}
/// <returns>False if no further checks are required (because they would be cascading).</returns>
private bool VisitTypeOrMember(Symbol symbol, Compliance compliance)
{
SymbolKind symbolKind = symbol.Kind;
System.Diagnostics.Debug.Assert(
symbolKind == SymbolKind.NamedType ||
symbolKind == SymbolKind.Field ||
symbolKind == SymbolKind.Property ||
symbolKind == SymbolKind.Event ||
symbolKind == SymbolKind.Method);
System.Diagnostics.Debug.Assert(!symbol.IsAccessor());
if (!CheckForDeclarationWithoutAssemblyDeclaration(symbol, compliance))
{
return false; // Don't cascade from this failure.
}
bool isCompliant = IsTrue(compliance);
bool isAccessibleOutsideAssembly = IsAccessibleOutsideAssembly(symbol);
if (isAccessibleOutsideAssembly)
{
if (isCompliant)
{
CheckName(symbol);
CheckForCompliantWithinNonCompliant(symbol);
CheckReturnTypeCompliance(symbol);
if (symbol.Kind == SymbolKind.NamedType)
{
CheckMemberDistinctness((NamedTypeSymbol)symbol);
}
}
else if (GetDeclaredOrInheritedCompliance(symbol.ContainingAssembly) == Compliance.DeclaredTrue && IsTrue(GetInheritedCompliance(symbol)))
{
CheckForNonCompliantAbstractMember(symbol);
}
}
else if (IsDeclared(compliance))
{
this.AddDiagnostic(ErrorCode.WRN_CLS_MeaninglessOnPrivateType, symbol.Locations[0], symbol);
return false; // Don't cascade from this failure.
}
if (isCompliant)
{
// Independent of accessibility.
CheckForAttributeWithArrayArgument(symbol);
}
// These checks are independent of accessibility and compliance.
if (symbolKind == SymbolKind.NamedType)
{
NamedTypeSymbol type = (NamedTypeSymbol)symbol;
if (type.TypeKind == TypeKind.Delegate)
{
MethodSymbol method = type.DelegateInvokeMethod;
CheckForMeaninglessOnParameter(method.Parameters);
CheckForMeaninglessOnReturn(method);
}
}
else if (symbolKind == SymbolKind.Method)
{
MethodSymbol method = (MethodSymbol)symbol;
CheckForMeaninglessOnParameter(method.Parameters);
CheckForMeaninglessOnReturn(method);
}
else if (symbolKind == SymbolKind.Property)
{
PropertySymbol property = (PropertySymbol)symbol;
CheckForMeaninglessOnParameter(property.Parameters);
}
// All checks that apply to inaccessible symbols are performed by this method.
return isAccessibleOutsideAssembly;
}
private void CheckForNonCompliantAbstractMember(Symbol symbol)
{
System.Diagnostics.Debug.Assert(!IsTrue(GetDeclaredOrInheritedCompliance(symbol)), "Only call on non-compliant symbols");
NamedTypeSymbol containingType = symbol.ContainingType;
if ((object)containingType != null && containingType.IsInterface)
{
this.AddDiagnostic(ErrorCode.WRN_CLS_BadInterfaceMember, symbol.Locations[0], symbol);
}
else if (symbol.IsAbstract && symbol.Kind != SymbolKind.NamedType)
{
this.AddDiagnostic(ErrorCode.WRN_CLS_NoAbstractMembers, symbol.Locations[0], symbol);
}
}
private void CheckBaseTypeCompliance(NamedTypeSymbol symbol)
{
System.Diagnostics.Debug.Assert(IsTrue(GetDeclaredOrInheritedCompliance(symbol)), "Only call on compliant symbols");
// NOTE: implemented interfaces do not have to be CLS-compliant (unless the type itself is an interface).
if (symbol.IsInterface)
{
foreach (NamedTypeSymbol interfaceType in symbol.InterfacesNoUseSiteDiagnostics())
{
if (!IsCompliantType(interfaceType, symbol))
{
// TODO: it would be nice to report this on the base type clause.
this.AddDiagnostic(ErrorCode.WRN_CLS_BadInterface, symbol.Locations[0], symbol, interfaceType);
}
}
}
else
{
NamedTypeSymbol baseType = symbol.EnumUnderlyingType ?? symbol.BaseTypeNoUseSiteDiagnostics; // null for interfaces
System.Diagnostics.Debug.Assert((object)baseType != null || symbol.SpecialType == SpecialType.System_Object, "Only object has no base.");
if ((object)baseType != null && !IsCompliantType(baseType, symbol))
{
// TODO: it would be nice to report this on the base type clause.
this.AddDiagnostic(ErrorCode.WRN_CLS_BadBase, symbol.Locations[0], symbol, baseType);
}
}
}
private void CheckForCompliantWithinNonCompliant(Symbol symbol)
{
System.Diagnostics.Debug.Assert(IsTrue(GetDeclaredOrInheritedCompliance(symbol)), "Only call on compliant symbols");
NamedTypeSymbol containingType = symbol.ContainingType;
System.Diagnostics.Debug.Assert((object)containingType == null || !containingType.IsImplicitClass);
if ((object)containingType != null && !IsTrue(GetDeclaredOrInheritedCompliance(containingType)))
{
this.AddDiagnostic(ErrorCode.WRN_CLS_IllegalTrueInFalse, symbol.Locations[0], symbol, containingType);
}
}
private void CheckTypeParameterCompliance(ImmutableArray<TypeParameterSymbol> typeParameters, NamedTypeSymbol context)
{
System.Diagnostics.Debug.Assert(typeParameters.IsEmpty || IsTrue(GetDeclaredOrInheritedCompliance(context)), "Only call on compliant symbols");
foreach (TypeParameterSymbol typeParameter in typeParameters)
{
foreach (TypeWithAnnotations constraintType in typeParameter.ConstraintTypesNoUseSiteDiagnostics)
{
if (!IsCompliantType(constraintType.Type, context))
{
// TODO: it would be nice to report this on the constraint clause.
// NOTE: we're improving over dev11 by reporting on the type parameter declaration,
// rather than on the constraint type declaration.
this.AddDiagnostic(ErrorCode.WRN_CLS_BadTypeVar, typeParameter.Locations[0], constraintType.Type);
}
}
}
}
private void CheckParameterCompliance(ImmutableArray<ParameterSymbol> parameters, NamedTypeSymbol context)
{
System.Diagnostics.Debug.Assert(parameters.IsEmpty || IsTrue(GetDeclaredOrInheritedCompliance(context)), "Only call on compliant symbols");
foreach (ParameterSymbol parameter in parameters)
{
if (!IsCompliantType(parameter.Type, context))
{
this.AddDiagnostic(ErrorCode.WRN_CLS_BadArgType, parameter.Locations[0], parameter.Type);
}
}
}
private void CheckForAttributeWithArrayArgument(Symbol symbol)
{
System.Diagnostics.Debug.Assert(IsTrue(GetDeclaredOrInheritedCompliance(symbol)), "Only call on compliant symbols");
CheckForAttributeWithArrayArgumentInternal(symbol.GetAttributes());
if (symbol.Kind == SymbolKind.Method)
{
CheckForAttributeWithArrayArgumentInternal(((MethodSymbol)symbol).GetReturnTypeAttributes());
}
}
/// <remarks>
/// BREAK: Dev11 reports WRN_CLS_ArrayArgumentToAttribute on all symbols, whereas roslyn reports it only
/// on accessible symbols.
/// </remarks>
private void CheckForAttributeWithArrayArgumentInternal(ImmutableArray<CSharpAttributeData> attributes)
{
foreach (CSharpAttributeData attribute in attributes)
{
foreach (TypedConstant argument in attribute.ConstructorArguments)
{
if (argument.TypeInternal.TypeKind == TypeKind.Array)
{
// TODO: it would be nice to report for each bad argument, but currently it's pointless since they
// would all have the same message and location.
Location warningLocation;
if (TryGetAttributeWarningLocation(attribute, out warningLocation))
{
this.AddDiagnostic(ErrorCode.WRN_CLS_ArrayArgumentToAttribute, warningLocation);
return;
}
}
}
foreach (var pair in attribute.NamedArguments)
{
TypedConstant argument = pair.Value;
if (argument.TypeInternal.TypeKind == TypeKind.Array)
{
// TODO: it would be nice to report for each bad argument, but currently it's pointless since they
// would all have the same message and location.
Location warningLocation;
if (TryGetAttributeWarningLocation(attribute, out warningLocation))
{
this.AddDiagnostic(ErrorCode.WRN_CLS_ArrayArgumentToAttribute, warningLocation);
return;
}
}
}
// This catches things like param arrays and converted null literals.
if ((object)attribute.AttributeConstructor != null) // Happens in error scenarios.
{
foreach (var type in attribute.AttributeConstructor.ParameterTypesWithAnnotations)
{
if (type.TypeKind == TypeKind.Array)
{
// TODO: it would be nice to report for each bad argument, but currently it's pointless since they
// would all have the same message and location.
Location warningLocation;
if (TryGetAttributeWarningLocation(attribute, out warningLocation))
{
this.AddDiagnostic(ErrorCode.WRN_CLS_ArrayArgumentToAttribute, warningLocation);
return;
}
}
}
}
}
}
private bool TryGetAttributeWarningLocation(CSharpAttributeData attribute, out Location location)
{
SyntaxReference syntaxRef = attribute.ApplicationSyntaxReference;
if (syntaxRef == null && _filterTree == null)
{
location = NoLocation.Singleton;
return true;
}
else if (_filterTree == null || (syntaxRef != null && syntaxRef.SyntaxTree == _filterTree))
{
System.Diagnostics.Debug.Assert(syntaxRef.SyntaxTree.HasCompilationUnitRoot);
location = new SourceLocation(syntaxRef);
return true;
}
location = null;
return false;
}
private void CheckForMeaninglessOnParameter(ImmutableArray<ParameterSymbol> parameters)
{
if (parameters.IsEmpty) return;
int startPos = 0;
Symbol container = parameters[0].ContainingSymbol;
if (container.Kind == SymbolKind.Method)
{
Symbol associated = ((MethodSymbol)container).AssociatedSymbol;
if ((object)associated != null && associated.Kind == SymbolKind.Property)
{
// Only care about "value" parameter for accessors.
// NOTE: public caller would have to count parameters.
startPos = ((PropertySymbol)associated).ParameterCount;
}
}
for (int i = startPos; i < parameters.Length; i++)
{
Location attributeLocation;
if (TryGetClsComplianceAttributeLocation(parameters[i].GetAttributes(), parameters[i], out attributeLocation))
{
this.AddDiagnostic(ErrorCode.WRN_CLS_MeaninglessOnParam, attributeLocation);
}
}
}
private void CheckForMeaninglessOnReturn(MethodSymbol method)
{
Location attributeLocation;
if (TryGetClsComplianceAttributeLocation(method.GetReturnTypeAttributes(), method, out attributeLocation))
{
this.AddDiagnostic(ErrorCode.WRN_CLS_MeaninglessOnReturn, attributeLocation);
}
}
private void CheckReturnTypeCompliance(Symbol symbol)
{
System.Diagnostics.Debug.Assert(IsTrue(GetDeclaredOrInheritedCompliance(symbol)), "Only call on compliant symbols");
ErrorCode code;
TypeSymbol type;
switch (symbol.Kind)
{
case SymbolKind.Field:
code = ErrorCode.WRN_CLS_BadFieldPropType;
type = ((FieldSymbol)symbol).Type;
break;
case SymbolKind.Property:
code = ErrorCode.WRN_CLS_BadFieldPropType;
type = ((PropertySymbol)symbol).Type;
break;
case SymbolKind.Event:
code = ErrorCode.WRN_CLS_BadFieldPropType;
type = ((EventSymbol)symbol).Type;
break;
case SymbolKind.Method:
code = ErrorCode.WRN_CLS_BadReturnType;
MethodSymbol method = (MethodSymbol)symbol;
type = method.ReturnType;
if (method.MethodKind == MethodKind.DelegateInvoke)
{
System.Diagnostics.Debug.Assert(method.ContainingType.TypeKind == TypeKind.Delegate);
symbol = method.ContainingType; // Refer to the delegate type in diagnostics.
}
// Diagnostic not interesting for accessors.
System.Diagnostics.Debug.Assert(!method.IsAccessor());
break;
case SymbolKind.NamedType:
symbol = ((NamedTypeSymbol)symbol).DelegateInvokeMethod;
if ((object)symbol == null)
{
return;
}
else
{
goto case SymbolKind.Method;
}
default:
throw ExceptionUtilities.UnexpectedValue(symbol.Kind);
}
if (!IsCompliantType(type, symbol.ContainingType))
{
this.AddDiagnostic(code, symbol.Locations[0], symbol);
}
}
private bool TryGetClsComplianceAttributeLocation(ImmutableArray<CSharpAttributeData> attributes, Symbol targetSymbol, out Location attributeLocation)
{
foreach (CSharpAttributeData data in attributes)
{
if (data.IsTargetAttribute(targetSymbol, AttributeDescription.CLSCompliantAttribute))
{
if (TryGetAttributeWarningLocation(data, out attributeLocation))
{
return true;
}
}
}
attributeLocation = null;
return false;
}
/// <returns>True if the symbol is okay (i.e. no warnings).</returns>
private bool CheckForDeclarationWithoutAssemblyDeclaration(Symbol symbol, Compliance compliance)
{
if (IsDeclared(compliance))
{
Compliance assemblyCompliance = GetDeclaredOrInheritedCompliance(symbol.ContainingAssembly);
if (!IsDeclared(assemblyCompliance))
{
ErrorCode code = IsTrue(compliance)
? ErrorCode.WRN_CLS_AssemblyNotCLS
: ErrorCode.WRN_CLS_AssemblyNotCLS2;
this.AddDiagnostic(code, symbol.Locations[0], symbol);
return false;
}
}
return true;
}
private void CheckMemberDistinctness(NamespaceOrTypeSymbol symbol)
{
System.Diagnostics.Debug.Assert(IsAccessibleOutsideAssembly(symbol));
System.Diagnostics.Debug.Assert(IsTrue(GetDeclaredOrInheritedCompliance(symbol)));
MultiDictionary<string, Symbol> seenByName = new MultiDictionary<string, Symbol>(CaseInsensitiveComparison.Comparer);
// For types, we also need to consider collisions with inherited members.
if (symbol.Kind != SymbolKind.Namespace)
{
NamedTypeSymbol type = (NamedTypeSymbol)symbol;
// NOTE: As in dev11 we're using Interfaces, rather than AllInterfaces.
// This seems like a bug, but it's easier to reproduce it than to deal
// with all the potential breaks.
// NOTE: It's not clear why dev11 is looking in interfaces at all. Maybe
// it was only supposed to happen for interface types?
foreach (NamedTypeSymbol @interface in type.InterfacesAndTheirBaseInterfacesNoUseSiteDiagnostics.Keys) // NOTE: would be hand-rolled in a standalone component.
{
if (!IsAccessibleOutsideAssembly(@interface)) continue;
foreach (Symbol member in @interface.GetMembersUnordered())
{
// NOTE: As in dev11 we filter out overriding methods and properties (but not events).
// NOTE: As in dev11, we ignore the CLS compliance of the interface and its members.
if (IsAccessibleIfContainerIsAccessible(member) &&
(!member.IsOverride || !(member.Kind == SymbolKind.Method || member.Kind == SymbolKind.Property)))
{
seenByName.Add(member.Name, member);
}
}
}
NamedTypeSymbol baseType = type.BaseTypeNoUseSiteDiagnostics;
while ((object)baseType != null)
{
foreach (Symbol member in baseType.GetMembersUnordered())
{
// NOTE: As in dev11 we filter out overriding methods and properties (but not events).
// NOTE: Unlike for interface members, we check CLS compliance of base type members.
if (IsAccessibleOutsideAssembly(member) &&
IsTrue(GetDeclaredOrInheritedCompliance(member)) &&
(!member.IsOverride || !(member.Kind == SymbolKind.Method || member.Kind == SymbolKind.Property)))
{
seenByName.Add(member.Name, member);
}
}
baseType = baseType.BaseTypeNoUseSiteDiagnostics;
}
}
// NOTE: visit the members in order so that the same one is always reported as a conflict.
foreach (Symbol member in symbol.GetMembers())
{
// Filter out uninteresting members:
if (DoNotVisit(member) ||
!IsAccessibleIfContainerIsAccessible(member) || // We already know that the container is accessible.
!IsTrue(GetDeclaredOrInheritedCompliance(member)) ||
member.IsOverride)
{
continue;
}
var name = member.Name;
var sameNameSymbols = seenByName[name];
if (sameNameSymbols.Count > 0)
{
CheckSymbolDistinctness(member, name, sameNameSymbols);
}
seenByName.Add(name, member);
}
}
/// <remarks>
/// NOTE: Dev11 behavior - First, it ignores arity,
/// which seems like a good way to disambiguate symbols (in particular,
/// CLS Rule 43 says that the name includes backtick-arity). Second, it
/// does not consider two members with identical names (i.e. not differing
/// in case) to collide.
/// </remarks>
private void CheckSymbolDistinctness(Symbol symbol, string symbolName, MultiDictionary<string, Symbol>.ValueSet sameNameSymbols)
{
Debug.Assert(sameNameSymbols.Count > 0);
Debug.Assert(symbol.Name == symbolName);
bool isMethodOrProperty = symbol.Kind == SymbolKind.Method || symbol.Kind == SymbolKind.Property;
foreach (Symbol other in sameNameSymbols)
{
if (other.Name != symbolName && !(isMethodOrProperty && other.Kind == symbol.Kind))
{
// TODO: Shouldn't we somehow reference the conflicting member? Dev11 doesn't.
this.AddDiagnostic(ErrorCode.WRN_CLS_BadIdentifierCase, symbol.Locations[0], symbol);
return;
}
}
if (!isMethodOrProperty)
{
return;
}
foreach (Symbol other in sameNameSymbols)
{
// Note: not checking accessor signatures, but checking accessor names.
ErrorCode code;
if (symbol.Kind == other.Kind &&
!symbol.IsAccessor() &&
!other.IsAccessor() &&
TryGetCollisionErrorCode(symbol, other, out code))
{
this.AddDiagnostic(code, symbol.Locations[0], symbol);
return;
}
else if (other.Name != symbolName)
{
// TODO: Shouldn't we somehow reference the conflicting member? Dev11 doesn't.
this.AddDiagnostic(ErrorCode.WRN_CLS_BadIdentifierCase, symbol.Locations[0], symbol);
return;
}
}
}
private void CheckName(Symbol symbol)
{
System.Diagnostics.Debug.Assert(IsTrue(GetDeclaredOrInheritedCompliance(symbol)));
System.Diagnostics.Debug.Assert(IsAccessibleOutsideAssembly(symbol));
if (!symbol.CanBeReferencedByName || symbol.IsOverride) return;
string name = symbol.Name;
// NOTE: The CLI spec says
// CLS Rule 4: Assemblies shall follow Annex 7 of Technical Report 15 of the Unicode Standard 3.0 governing
// the set of characters permitted to start and be included in identifiers, available on-line at
// http://www.unicode.org/unicode/reports/tr15/tr15-18.html. Identifiers shall be in the canonical format defined
// by Unicode Normalization Form C. For CLS purposes, two identifiers are the same if their lowercase mappings
// (as specified by the Unicode locale-insensitive, one-to-one lowercase mappings) are the same. That is, for two
// identifiers to be considered different under the CLS they shall differ in more than simply their case. However,
// in order to override an inherited definition the CLI requires the precise encoding of the original declaration be
// used.
//
// However, what the native compiler actually does is ignore everything about composed and decomposed characters
// (see comment in CompilationPass::checkCLSnaming) and then just checks if the first character is underscore
// (0x005F or 0xFF3F). Presumably, it assumes that the language rules have weeded out any other identifiers
// forbidden by the unicode spec.
// NOTE: The parser won't actually accept '\uFF3F' as part of an identifier.
System.Diagnostics.Debug.Assert(name.Length == 0 || name[0] != '\uFF3F');
if (name.Length > 0 && name[0] == '\u005F')
{
this.AddDiagnostic(ErrorCode.WRN_CLS_BadIdentifier, symbol.Locations[0], name);
}
}
private bool DoNotVisit(Symbol symbol)
{
if (symbol.Kind == SymbolKind.Namespace)
{
return false;
}
// TODO: There's no public equivalent of Symbol.DeclaringCompilation.
return symbol.DeclaringCompilation != _compilation ||
symbol.IsImplicitlyDeclared ||
IsSyntacticallyFilteredOut(symbol);
}
private bool IsSyntacticallyFilteredOut(Symbol symbol)
{
// TODO: it would be nice to be more precise than this: we only want to
// warn about the base class if it is listed in the filter tree, not if
// any part of the type is in the filter tree.
return _filterTree != null && !symbol.IsDefinedInSourceTree(_filterTree, _filterSpanWithinTree);
}
private bool IsCompliantType(TypeSymbol type, NamedTypeSymbol context)
{
switch (type.TypeKind)
{
case TypeKind.Array:
return IsCompliantType(((ArrayTypeSymbol)type).ElementType, context);
case TypeKind.Dynamic:
// NOTE: It would probably be most correct to return
// IsCompliantType(this.compilation.GetSpecialType(SpecialType.System_Object), context)
// but that's way too much work in the 99.9% case.
return true;
case TypeKind.Pointer:
case TypeKind.FunctionPointer:
return false;
case TypeKind.Error:
case TypeKind.TypeParameter:
// Possibly not the most accurate answer, but the gist is that we
// don't want to report problems with these types.
return true;
case TypeKind.Class:
case TypeKind.Struct:
case TypeKind.Interface:
case TypeKind.Delegate:
case TypeKind.Enum:
case TypeKind.Submission:
return IsCompliantType((NamedTypeSymbol)type, context);
default: