Merge pull request #21067 from paldepind/rust/type-inference-use-type-item

Rust: Refactor type inference to use new `TypeItem` class

Author: paldepind

rust/ql/lib/codeql/rust/frameworks/rustcrypto/RustCrypto.qll

@@ -30,7 +30,8 @@ class StreamCipherInit extends Cryptography::CryptographicOperation::Range {
       // extract the algorithm name from the type of `ce` or its receiver.
       exists(Type t, TypePath tp |
         t = inferType([call, call.(MethodCall).getReceiver()], tp) and
-        rawAlgorithmName = t.(StructType).getStruct().(Addressable).getCanonicalPath().splitAt("::")
+        rawAlgorithmName =
+          t.(StructType).getTypeItem().(Addressable).getCanonicalPath().splitAt("::")
       ) and
       algorithmName = simplifyAlgorithmName(rawAlgorithmName) and
       // only match a known cryptographic algorithm

rust/ql/lib/codeql/rust/internal/Type.qll

@@ -32,10 +32,8 @@ private predicate dynTraitTypeParameter(Trait trait, AstNode n) {
 
 cached
 newtype TType =
-  TStruct(Struct s) { Stages::TypeInferenceStage::ref() } or
-  TEnum(Enum e) or
+  TDataType(TypeItem ti) { Stages::TypeInferenceStage::ref() } or
   TTrait(Trait t) or
-  TUnion(Union u) or
   TImplTraitType(ImplTraitTypeRepr impl) or
   TDynTraitType(Trait t) { t = any(DynTraitTypeRepr dt).getTrait() } or
   TNeverType() or
@@ -92,7 +90,7 @@ abstract class Type extends TType {
 class TupleType extends StructType {
   private int arity;
 
-  TupleType() { arity = this.getStruct().(Builtins::TupleType).getArity() }
+  TupleType() { arity = this.getTypeItem().(Builtins::TupleType).getArity() }
 
   /** Gets the arity of this tuple type. */
   int getArity() { result = arity }
@@ -112,48 +110,55 @@ class UnitType extends TupleType {
   override string toString() { result = "()" }
 }
 
-/** A struct type. */
-class StructType extends Type, TStruct {
-  private Struct struct;
+class DataType extends Type, TDataType {
+  private TypeItem typeItem;
 
-  StructType() { this = TStruct(struct) }
+  DataType() { this = TDataType(typeItem) }
 
-  /** Gets the struct that this struct type represents. */
-  Struct getStruct() { result = struct }
+  /** Gets the type item that this data type represents. */
+  TypeItem getTypeItem() { result = typeItem }
 
   override TypeParameter getPositionalTypeParameter(int i) {
-    result = TTypeParamTypeParameter(struct.getGenericParamList().getTypeParam(i))
+    result = TTypeParamTypeParameter(typeItem.getGenericParamList().getTypeParam(i))
   }
 
   override TypeMention getTypeParameterDefault(int i) {
-    result = struct.getGenericParamList().getTypeParam(i).getDefaultType()
+    result = typeItem.getGenericParamList().getTypeParam(i).getDefaultType()
   }
 
-  override string toString() { result = struct.getName().getText() }
+  override string toString() { result = typeItem.getName().getText() }
 
-  override Location getLocation() { result = struct.getLocation() }
+  override Location getLocation() { result = typeItem.getLocation() }
+}
+
+/** A struct type. */
+class StructType extends DataType {
+  private Struct struct;
+
+  StructType() { struct = super.getTypeItem() }
+
+  /** Gets the struct that this struct type represents. */
+  override Struct getTypeItem() { result = struct }
 }
 
 /** An enum type. */
-class EnumType extends Type, TEnum {
+class EnumType extends DataType {
   private Enum enum;
 
-  EnumType() { this = TEnum(enum) }
+  EnumType() { enum = super.getTypeItem() }
 
   /** Gets the enum that this enum type represents. */
-  Enum getEnum() { result = enum }
-
-  override TypeParameter getPositionalTypeParameter(int i) {
-    result = TTypeParamTypeParameter(enum.getGenericParamList().getTypeParam(i))
-  }
+  override Enum getTypeItem() { result = enum }
+}
 
-  override TypeMention getTypeParameterDefault(int i) {
-    result = enum.getGenericParamList().getTypeParam(i).getDefaultType()
-  }
+/** A union type. */
+class UnionType extends DataType {
+  private Union union;
 
-  override string toString() { result = enum.getName().getText() }
+  UnionType() { union = super.getTypeItem() }
 
-  override Location getLocation() { result = enum.getLocation() }
+  /** Gets the union that this union type represents. */
+  override Union getTypeItem() { result = union }
 }
 
 /** A trait type. */
@@ -186,35 +191,13 @@ class TraitType extends Type, TTrait {
   override Location getLocation() { result = trait.getLocation() }
 }
 
-/** A union type. */
-class UnionType extends Type, TUnion {
-  private Union union;
-
-  UnionType() { this = TUnion(union) }
-
-  /** Gets the union that this union type represents. */
-  Union getUnion() { result = union }
-
-  override TypeParameter getPositionalTypeParameter(int i) {
-    result = TTypeParamTypeParameter(union.getGenericParamList().getTypeParam(i))
-  }
-
-  override TypeMention getTypeParameterDefault(int i) {
-    result = union.getGenericParamList().getTypeParam(i).getDefaultType()
-  }
-
-  override string toString() { result = union.getName().getText() }
-
-  override Location getLocation() { result = union.getLocation() }
-}
-
 /**
  * An array type.
  *
  * Array types like `[i64; 5]` are modeled as normal generic types.
  */
 class ArrayType extends StructType {
-  ArrayType() { this.getStruct() instanceof Builtins::ArrayType }
+  ArrayType() { this.getTypeItem() instanceof Builtins::ArrayType }
 
   override string toString() { result = "[;]" }
 }
@@ -227,13 +210,13 @@ TypeParamTypeParameter getArrayTypeParameter() {
 abstract class RefType extends StructType { }
 
 class RefMutType extends RefType {
-  RefMutType() { this.getStruct() instanceof Builtins::RefMutType }
+  RefMutType() { this.getTypeItem() instanceof Builtins::RefMutType }
 
   override string toString() { result = "&mut" }
 }
 
 class RefSharedType extends RefType {
-  RefSharedType() { this.getStruct() instanceof Builtins::RefSharedType }
+  RefSharedType() { this.getTypeItem() instanceof Builtins::RefSharedType }
 
   override string toString() { result = "&" }
 }
@@ -330,7 +313,7 @@ class ImplTraitReturnType extends ImplTraitType {
  * with a single type argument.
  */
 class SliceType extends StructType {
-  SliceType() { this.getStruct() instanceof Builtins::SliceType }
+  SliceType() { this.getTypeItem() instanceof Builtins::SliceType }
 
   override string toString() { result = "[]" }
 }
@@ -356,13 +339,13 @@ TypeParamTypeParameter getPtrTypeParameter() {
 }
 
 class PtrMutType extends PtrType {
-  PtrMutType() { this.getStruct() instanceof Builtins::PtrMutType }
+  PtrMutType() { this.getTypeItem() instanceof Builtins::PtrMutType }
 
   override string toString() { result = "*mut" }
 }
 
 class PtrConstType extends PtrType {
-  PtrConstType() { this.getStruct() instanceof Builtins::PtrConstType }
+  PtrConstType() { this.getTypeItem() instanceof Builtins::PtrConstType }
 
   override string toString() { result = "*const" }
 }
@@ -624,7 +607,7 @@ pragma[nomagic]
 predicate validSelfType(Type t) {
   t instanceof RefType
   or
-  exists(Struct s | t = TStruct(s) |
+  exists(Struct s | t = TDataType(s) |
     s instanceof BoxStruct or
     s instanceof RcStruct or
     s instanceof ArcStruct or