Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Split large switch case out into a helper + add comment #959

Merged
merged 1 commit into from
Aug 9, 2024
Merged

Split large switch case out into a helper + add comment #959

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 79 additions & 72 deletions src/D2L.CodeStyle.Analyzers/Immutability/ImmutableAttributeConsistencyChecker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,94 +87,101 @@ private void CompareConsistencyToBaseType(
CancellationToken cancellationToken
) {
switch( baseTypeInfo.Kind ) {
// The base type doesn't require its subtypes to be immutable
case ImmutableTypeKind.None:
return;

case ImmutableTypeKind.Instance:
return;

case ImmutableTypeKind.Total:
bool missingConditionalParameterUsage = false;
if( typeInfo.Kind == ImmutableTypeKind.Total ) {
if( !typeInfo.IsConditional ) {
break;
}
CompareConsistencyToTotallyImmutableBaseType( typeInfo, baseTypeInfo, cancellationToken );
break;

default:
throw new NotImplementedException();
}
}

if( baseTypeInfo.IsConditional ) {
foreach( ITypeParameterSymbol typeParameter in typeInfo.ConditionalTypeParameters ) {
bool parameterUsed = false;
for( int i = 0; i < baseTypeInfo.Type.TypeArguments.Length && !parameterUsed; i++ ) {
ITypeSymbol typeArgument = baseTypeInfo.Type.TypeArguments[ i ];
if( !SymbolEqualityComparer.Default.Equals( typeParameter, typeArgument ) ) {
continue;
}

ITypeParameterSymbol baseTypeParameter = baseTypeInfo.Type.TypeParameters[ i ];
if( baseTypeInfo.ConditionalTypeParameters.Contains( baseTypeParameter, SymbolEqualityComparer.Default ) ) {
parameterUsed = true;
break;
}
}

if( !parameterUsed ) {
missingConditionalParameterUsage = true;
break;
}
private void CompareConsistencyToTotallyImmutableBaseType(
ImmutableTypeInfo typeInfo,
ImmutableTypeInfo baseTypeInfo,
CancellationToken cancellationToken
) {
bool missingConditionalParameterUsage = false;
if( typeInfo.Kind == ImmutableTypeKind.Total ) {
if( !typeInfo.IsConditional ) {
return;
}

if( baseTypeInfo.IsConditional ) {
foreach( ITypeParameterSymbol typeParameter in typeInfo.ConditionalTypeParameters ) {
bool parameterUsed = false;
for( int i = 0; i < baseTypeInfo.Type.TypeArguments.Length && !parameterUsed; i++ ) {
ITypeSymbol typeArgument = baseTypeInfo.Type.TypeArguments[ i ];
if( !SymbolEqualityComparer.Default.Equals( typeParameter, typeArgument ) ) {
continue;
}

if( !missingConditionalParameterUsage ) {
ITypeParameterSymbol baseTypeParameter = baseTypeInfo.Type.TypeParameters[ i ];
if( baseTypeInfo.ConditionalTypeParameters.Contains( baseTypeParameter, SymbolEqualityComparer.Default ) ) {
parameterUsed = true;
break;
}
}
}

// The docs say the only things that can have BaseType == null
// are interfaces, System.Object itself (won't come up in our
// analysis because (1) it !hasTheImmutableAttribute (2) you
// can't explicitly list it as a base class anyway) and
// pointer types (the base value type probably also doesn't
// have it.)
bool isInterface =
baseTypeInfo.Type.BaseType == null
&& baseTypeInfo.Type.SpecialType != SpecialType.System_Object
&& baseTypeInfo.Type.SpecialType != SpecialType.System_ValueType
&& baseTypeInfo.Type.Kind != SymbolKind.PointerType;

(TypeDeclarationSyntax syntax, _) = typeInfo.Type.ExpensiveGetSyntaxImplementingType(
baseTypeOrInterface: baseTypeInfo.Type,
compilation: m_compilation,
cancellationToken
);

if( missingConditionalParameterUsage ) {
m_diagnosticSink(
Diagnostic.Create(
Diagnostics.UnappliedConditionalImmutability,
syntax.Identifier.GetLocation(),
typeInfo.Type.GetFullTypeName(),
isInterface ? "interface" : "base class",
baseTypeInfo.Type.GetFullTypeName()
)
);
} else {
m_diagnosticSink(
Diagnostic.Create(
Diagnostics.MissingTransitiveImmutableAttribute,
syntax.Identifier.GetLocation(),
properties: FixArgs,
typeInfo.Type.GetFullTypeName(),
baseTypeInfo.IsConditional ? " (or [ConditionallyImmutable])" : "",
isInterface ? "interface" : "base class",
baseTypeInfo.Type.GetFullTypeName()
)
);
if( !parameterUsed ) {
missingConditionalParameterUsage = true;
break;
}
}

break;
if( !missingConditionalParameterUsage ) {
return;
}
}
}

default:
throw new NotImplementedException();
// The docs say the only things that can have BaseType == null
// are interfaces, System.Object itself (won't come up in our
// analysis because (1) it !hasTheImmutableAttribute (2) you
// can't explicitly list it as a base class anyway) and
// pointer types (the base value type probably also doesn't
// have it.)
bool isInterface =
baseTypeInfo.Type.BaseType == null
&& baseTypeInfo.Type.SpecialType != SpecialType.System_Object
&& baseTypeInfo.Type.SpecialType != SpecialType.System_ValueType
&& baseTypeInfo.Type.Kind != SymbolKind.PointerType;

(TypeDeclarationSyntax syntax, _) = typeInfo.Type.ExpensiveGetSyntaxImplementingType(
baseTypeOrInterface: baseTypeInfo.Type,
compilation: m_compilation,
cancellationToken
);

if( missingConditionalParameterUsage ) {
m_diagnosticSink(
Diagnostic.Create(
Diagnostics.UnappliedConditionalImmutability,
syntax.Identifier.GetLocation(),
typeInfo.Type.GetFullTypeName(),
isInterface ? "interface" : "base class",
baseTypeInfo.Type.GetFullTypeName()
)
);
} else {
m_diagnosticSink(
Diagnostic.Create(
Diagnostics.MissingTransitiveImmutableAttribute,
syntax.Identifier.GetLocation(),
properties: FixArgs,
typeInfo.Type.GetFullTypeName(),
baseTypeInfo.IsConditional ? " (or [ConditionallyImmutable])" : "",
isInterface ? "interface" : "base class",
baseTypeInfo.Type.GetFullTypeName()
)
);
}

}

private static Location GetLocationOfNthTypeParameter(
Expand Down
Loading