-
Notifications
You must be signed in to change notification settings - Fork 1.9k
C# 14: Implicit span conversions. #21065
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| category: minorAnalysis | ||
| --- | ||
| * C# 14: Support for *implicit* span conversions in the QL library. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,6 +28,7 @@ private module Cached { | |
| * | ||
| * - Identity conversions | ||
| * - Implicit numeric conversions | ||
| * - Implicit span conversions | ||
| * - Implicit nullable conversions | ||
| * - Implicit reference conversions | ||
| * - Boxing conversions | ||
|
|
@@ -38,6 +39,8 @@ private module Cached { | |
| or | ||
| convNumeric(fromType, toType) | ||
| or | ||
| convSpan(fromType, toType) | ||
| or | ||
| convNullableType(fromType, toType) | ||
| or | ||
| convRefTypeNonNull(fromType, toType) | ||
|
|
@@ -81,6 +84,7 @@ private predicate implicitConversionNonNull(Type fromType, Type toType) { | |
| * | ||
| * - Identity conversions | ||
| * - Implicit numeric conversions | ||
| * - Implicit span conversions | ||
| * - Implicit nullable conversions | ||
| * - Implicit reference conversions | ||
| * - Boxing conversions | ||
|
|
@@ -491,6 +495,53 @@ private predicate convNumericChar(SimpleType toType) { | |
|
|
||
| private predicate convNumericFloat(SimpleType toType) { toType instanceof DoubleType } | ||
|
|
||
| private class SpanType extends GenericType { | ||
| SpanType() { this.getUnboundGeneric() instanceof SystemSpanStruct } | ||
|
|
||
| Type getElementType() { result = this.getTypeArgument(0) } | ||
| } | ||
|
|
||
| private class ReadOnlySpanType extends GenericType { | ||
| ReadOnlySpanType() { this.getUnboundGeneric() instanceof SystemReadOnlySpanStruct } | ||
|
|
||
| Type getElementType() { result = this.getTypeArgument(0) } | ||
| } | ||
|
|
||
| private class SimpleArrayType extends ArrayType { | ||
| SimpleArrayType() { | ||
| this.getRank() = 1 and | ||
| this.getDimension() = 1 | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * INTERNAL: Do not use. | ||
| * | ||
| * Holds if there is an implicit span conversion from `fromType` to `toType`. | ||
| * | ||
| * 10.2.1: Implicit span conversions (added in C# 14). | ||
| * [Documentation](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/proposals/csharp-14.0/first-class-span-types#span-conversions) | ||
| */ | ||
| predicate convSpan(Type fromType, Type toType) { | ||
| fromType.(SimpleArrayType).getElementType() = toType.(SpanType).getElementType() | ||
| or | ||
| exists(Type fromElementType, Type toElementType | | ||
| ( | ||
| fromElementType = fromType.(SimpleArrayType).getElementType() or | ||
| fromElementType = fromType.(SpanType).getElementType() or | ||
| fromElementType = fromType.(ReadOnlySpanType).getElementType() | ||
| ) and | ||
| toElementType = toType.(ReadOnlySpanType).getElementType() | ||
| | | ||
| convIdentity(fromElementType, toElementType) | ||
| or | ||
| convCovariance(fromElementType, toElementType) | ||
| ) | ||
| or | ||
| fromType instanceof SystemStringClass and | ||
| toType.(ReadOnlySpanType).getElementType() instanceof CharType | ||
| } | ||
|
|
||
| /** | ||
| * INTERNAL: Do not use. | ||
| * | ||
|
|
@@ -784,8 +835,8 @@ predicate convConversionOperator(Type fromType, Type toType) { | |
| ) | ||
| } | ||
|
|
||
| /** 13.1.3.2: Variance conversion. */ | ||
| private predicate convVariance(GenericType fromType, GenericType toType) { | ||
| pragma[nomagic] | ||
| private predicate convVarianceAux(UnboundGenericType ugt, GenericType fromType, GenericType toType) { | ||
|
||
| // Semantically equivalent with | ||
| // ```ql | ||
| // ugt = fromType.getUnboundGeneric() | ||
|
|
@@ -805,10 +856,23 @@ private predicate convVariance(GenericType fromType, GenericType toType) { | |
| // ``` | ||
| // but performance is improved by explicitly evaluating the `i`th argument | ||
| // only when all preceding arguments are convertible. | ||
| Variance::convVarianceSingle(_, fromType, toType) | ||
| Variance::convVarianceSingle(ugt, fromType, toType) | ||
| or | ||
| Variance::convVarianceMultiple(ugt, fromType, toType, ugt.getNumberOfTypeParameters() - 1) | ||
| } | ||
|
|
||
| /** 13.1.3.2: Variance conversion. */ | ||
| private predicate convVariance(GenericType fromType, GenericType toType) { | ||
| convVarianceAux(_, fromType, toType) | ||
| } | ||
|
|
||
| /** | ||
| * Holds, if `fromType` is covariance convertible to `toType`. | ||
| */ | ||
| private predicate convCovariance(GenericType fromType, GenericType toType) { | ||
| exists(UnboundGenericType ugt | | ||
| Variance::convVarianceMultiple(ugt, fromType, toType, ugt.getNumberOfTypeParameters() - 1) | ||
| convVarianceAux(ugt, fromType, toType) and | ||
| forall(TypeParameter tp | tp = ugt.getATypeParameter() | tp.isOut()) | ||
| ) | ||
| } | ||
|
Comment on lines
+872
to
877
|
||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
|
|
||
| public interface CovariantInterface<out T> { } | ||
|
|
||
| public interface InvariantInterface<T> { } | ||
|
|
||
| public interface Interface<out T1, T2> { } | ||
|
|
||
| public class Base { } | ||
|
|
||
| public class Derived : Base { } | ||
|
|
||
| public class C | ||
| { | ||
| public void M() | ||
| { | ||
| string[] stringArray = []; | ||
| string[][] stringArrayArray; | ||
| string[,] stringArray2D; | ||
|
|
||
| Span<string> stringSpan = stringArray; // string[] -> Span<string>; | ||
|
|
||
| // Covariant conversions to ReadOnlySpan | ||
| // Assignments are included to illustrate that this compiles. | ||
| // Only the use of the types matter in terms of test output. | ||
| ReadOnlySpan<CovariantInterface<Base>> covariantInterfaceBaseReadOnlySpan; | ||
| ReadOnlySpan<CovariantInterface<Derived>> covariantInterfaceDerivedReadOnlySpan = default; | ||
| Span<CovariantInterface<Derived>> covariantInterfaceDerivedSpan = default; | ||
| CovariantInterface<Derived>[] covariantInterfaceDerivedArray = []; | ||
| covariantInterfaceBaseReadOnlySpan = covariantInterfaceDerivedReadOnlySpan; // ReadOnlySpan<CovariantInterface<Derived>> -> ReadOnlySpan<CovariantInterface<Base>> | ||
| covariantInterfaceBaseReadOnlySpan = covariantInterfaceDerivedSpan; // Span<CovariantInterface<Derived>> -> ReadOnlySpan<CovariantInterface<Base>> | ||
| covariantInterfaceBaseReadOnlySpan = covariantInterfaceDerivedArray; // CovariantInterface<Derived>[] -> ReadOnlySpan<CovariantInterface<Base>> | ||
|
|
||
| // Identify conversions to ReadOnlySpan | ||
| ReadOnlySpan<string> stringReadOnlySpan; | ||
| stringReadOnlySpan = stringSpan; // Span<string> -> ReadOnlySpan<string>; | ||
| stringReadOnlySpan = stringArray; // string[] -> ReadOnlySpan<string>; | ||
|
|
||
| // Convert string to ReadOnlySpan<char> | ||
| string s = ""; | ||
| ReadOnlySpan<char> charReadOnlySpan = s; // string -> ReadOnlySpan<char> | ||
|
|
||
| // Use the non-covariant interfaces to show that no conversion is possible. | ||
| ReadOnlySpan<InvariantInterface<Base>> invariantInterfaceBaseReadOnlySpan; | ||
| ReadOnlySpan<InvariantInterface<Derived>> invariantInterfaceDerivedReadOnlySpan; | ||
| Span<InvariantInterface<Derived>> invariantInterfaceDerivedSpan; | ||
| InvariantInterface<Derived>[] invariantInterfaceDerivedArray; | ||
| ReadOnlySpan<Interface<Base, string>> interfaceBaseReadOnlySpan; | ||
| ReadOnlySpan<Interface<Derived, string>> interfaceDerivedReadOnlySpan; | ||
| Span<Interface<Derived, string>> interfaceDerivedSpan; | ||
| Interface<Derived, string>[] interfaceDerivedArray; | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| | CovariantInterface<Derived>[] | ReadOnlySpan<CovariantInterface<Base>> | | ||
| | CovariantInterface<Derived>[] | ReadOnlySpan<CovariantInterface<Derived>> | | ||
| | CovariantInterface<Derived>[] | Span<CovariantInterface<Derived>> | | ||
| | Interface<Derived,String>[] | ReadOnlySpan<Interface<Derived, string>> | | ||
| | Interface<Derived,String>[] | Span<Interface<Derived, string>> | | ||
| | InvariantInterface<Derived>[] | ReadOnlySpan<InvariantInterface<Derived>> | | ||
| | InvariantInterface<Derived>[] | Span<InvariantInterface<Derived>> | | ||
| | ReadOnlySpan<CovariantInterface<Derived>> | ReadOnlySpan<CovariantInterface<Base>> | | ||
| | Span<CovariantInterface<Derived>> | ReadOnlySpan<CovariantInterface<Base>> | | ||
| | Span<CovariantInterface<Derived>> | ReadOnlySpan<CovariantInterface<Derived>> | | ||
| | Span<Interface<Derived, string>> | ReadOnlySpan<Interface<Derived, string>> | | ||
| | Span<InvariantInterface<Derived>> | ReadOnlySpan<InvariantInterface<Derived>> | | ||
| | Span<string> | ReadOnlySpan<string> | | ||
| | String[] | ReadOnlySpan<string> | | ||
| | String[] | Span<string> | | ||
| | string | ReadOnlySpan<char> | |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import semmle.code.csharp.Conversion | ||
|
|
||
| private class InterestingType extends Type { | ||
| InterestingType() { exists(LocalVariable lv | lv.getType() = this) } | ||
| } | ||
|
|
||
| from InterestingType sub, InterestingType sup | ||
| where convSpan(sub, sup) and sub != sup | ||
| select sub.toStringWithTypes() as s1, sup.toStringWithTypes() as s2 order by s1, s2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
SimpleArrayTypeclass lacks documentation explaining what distinguishes it from other array types. Add a docstring clarifying that this represents single-dimensional, zero-based arrays (SZ arrays), asgetRank() = 1 and getDimension() = 1restricts it to this specific array form.