Merge pull request #14657 from hvitved/csharp/qualified-name

C#: Move qualified name computation into `QualifiedName.qll`

Author: hvitved

csharp/ql/lib/semmle/code/cil/Declaration.qll

@@ -5,6 +5,7 @@
 import CIL
 private import dotnet
 private import semmle.code.csharp.Member as CS
+private import semmle.code.csharp.commons.QualifiedName
 
 /**
  * A declaration. Either a member (`Member`) or a variable (`Variable`).
@@ -23,6 +24,14 @@ class Declaration extends DotNet::Declaration, Element, @cil_declaration {
   }
 
   override Declaration getUnboundDeclaration() { result = this }
+
+  override predicate hasQualifiedName(string qualifier, string name) {
+    exists(string dqualifier, string dname |
+      this.getDeclaringType().hasQualifiedName(dqualifier, dname) and
+      qualifier = getQualifiedName(dqualifier, dname)
+    ) and
+    name = this.getName()
+  }
 }
 
 private CS::Declaration toCSharpNonTypeParameter(Declaration d) { result.matchesHandle(d) }

csharp/ql/lib/semmle/code/csharp/Callable.qll

@@ -472,16 +472,6 @@ class Operator extends Callable, Member, Attributable, Overridable, @operator {
   override string toString() { result = Callable.super.toString() }
 
   override Parameter getRawParameter(int i) { result = this.getParameter(i) }
-
-  override predicate hasQualifiedName(string qualifier, string name) {
-    super.hasQualifiedName(qualifier, _) and
-    name = this.getFunctionName()
-  }
-
-  override predicate hasQualifiedName(string namespace, string type, string name) {
-    super.hasQualifiedName(namespace, type, _) and
-    name = this.getFunctionName()
-  }
 }
 
 /** A clone method on a record. */
@@ -1113,14 +1103,6 @@ class LocalFunction extends Callable, Modifiable, Attributable, @local_function
 
   override Callable getEnclosingCallable() { result = this.getStatement().getEnclosingCallable() }
 
-  override predicate hasQualifiedName(string qualifier, string name) {
-    exists(string cqualifier, string type |
-      this.getEnclosingCallable().hasQualifiedName(cqualifier, type) and
-      qualifier = getQualifiedName(cqualifier, type)
-    ) and
-    name = this.getName()
-  }
-
   override Location getALocation() { result = this.getStatement().getALocation() }
 
   override Parameter getRawParameter(int i) { result = this.getParameter(i) }

csharp/ql/lib/semmle/code/csharp/Element.qll

@@ -3,9 +3,9 @@
  */
 
 import Location
-import Member
 private import semmle.code.csharp.ExprOrStmtParent
 private import dotnet
+private import commons.QualifiedName
 
 /**
  * A program element. Either a control flow element (`ControlFlowElement`), an

csharp/ql/lib/semmle/code/csharp/Generics.qll

@@ -101,20 +101,6 @@ private string getTypeArgumentsNames(ConstructedGeneric cg) {
   result = strictconcat(Type t, int i | t = cg.getTypeArgument(i) | t.getName(), "," order by i)
 }
 
-bindingset[t]
-private string getFullName(Type t) {
-  exists(string qualifier, string name |
-    t.hasQualifiedName(qualifier, name) and
-    result = getQualifiedName(qualifier, name)
-  )
-}
-
-/** Gets the concatenation of the `getFullName` of type arguments. */
-language[monotonicAggregates]
-private string getTypeArgumentsQualifiedNames(ConstructedGeneric cg) {
-  result = strictconcat(Type t, int i | t = cg.getTypeArgument(i) | getFullName(t), "," order by i)
-}
-
 /**
  * An unbound generic type. This is a generic type with type parameters
  * (for example `List<T>`) or elided type parameters (for example `List<>`).
@@ -161,19 +147,6 @@ class UnboundGenericType extends ValueOrRefType, UnboundGeneric {
   final override string getName() {
     result = this.getUndecoratedName() + "<" + getTypeParameterCommas(this) + ">"
   }
-
-  final override predicate hasQualifiedName(string qualifier, string name) {
-    exists(string name0 | name = name0 + "<" + getTypeParameterCommas(this) + ">" |
-      exists(string enclosing |
-        this.getDeclaringType().hasQualifiedName(qualifier, enclosing) and
-        name0 = enclosing + "+" + this.getUndecoratedName()
-      )
-      or
-      not exists(this.getDeclaringType()) and
-      qualifier = this.getNamespace().getFullName() and
-      name0 = this.getUndecoratedName()
-    )
-  }
 }
 
 /**
@@ -240,11 +213,6 @@ class TypeParameter extends DotNet::TypeParameter, Type, @type_parameter {
   /** Gets the generic that defines this type parameter. */
   UnboundGeneric getGeneric() { type_parameters(this, _, result, _) }
 
-  final override predicate hasQualifiedName(string qualifier, string name) {
-    qualifier = "" and
-    name = this.getName()
-  }
-
   override string getAPrimaryQlClass() { result = "TypeParameter" }
 }
 
@@ -440,19 +408,6 @@ class ConstructedType extends ValueOrRefType, ConstructedGeneric {
   final override string getName() {
     result = this.getUndecoratedName() + "<" + getTypeArgumentsNames(this) + ">"
   }
-
-  override predicate hasQualifiedName(string qualifier, string name) {
-    exists(string name0 | name = name0 + "<" + getTypeArgumentsQualifiedNames(this) + ">" |
-      exists(string enclosing |
-        this.getDeclaringType().hasQualifiedName(qualifier, enclosing) and
-        name0 = enclosing + "+" + this.getUndecoratedName()
-      )
-      or
-      not exists(this.getDeclaringType()) and
-      qualifier = this.getNamespace().getFullName() and
-      name0 = this.getUndecoratedName()
-    )
-  }
 }
 
 /**
@@ -624,11 +579,6 @@ class ConstructedMethod extends Method, ConstructedGeneric {
     result = this.getUndecoratedName() + "<" + getTypeArgumentsNames(this) + ">"
   }
 
-  override predicate hasQualifiedName(string namespace, string type, string name) {
-    this.getDeclaringType().hasQualifiedName(namespace, type) and
-    name = this.getUndecoratedName() + "<" + getTypeArgumentsQualifiedNames(this) + ">"
-  }
-
   final override string getUndecoratedName() { methods(this, result, _, _, _) }
 }
 

csharp/ql/lib/semmle/code/csharp/Member.qll

@@ -7,6 +7,9 @@ import Variable
 private import dotnet
 private import Implements
 private import TypeRef
+private import commons.QualifiedName
+
+private module QualifiedNameInput implements QualifiedNameInputSig { }
 
 /**
  * A declaration.
@@ -21,6 +24,10 @@ class Declaration extends DotNet::Declaration, Element, @declaration {
 
   override string toString() { result = this.getName() }
 
+  override predicate hasQualifiedName(string qualifier, string name) {
+    QualifiedName<QualifiedNameInput>::hasQualifiedName(this, qualifier, name)
+  }
+
   /**
    * Gets the fully qualified name of this declaration, including types, for example
    * the fully qualified name with types of `M` on line 3 is `N.C.M(int, string)` in
@@ -199,6 +206,10 @@ class Member extends DotNet::Member, Modifiable, @member {
   override predicate isRequired() { Modifiable.super.isRequired() }
 
   override predicate isFile() { Modifiable.super.isFile() }
+
+  final override predicate hasQualifiedName(string namespace, string type, string name) {
+    QualifiedName<QualifiedNameInput>::hasQualifiedName(this, namespace, type, name)
+  }
 }
 
 private class TOverridable = @virtualizable or @callable_accessor;

csharp/ql/lib/semmle/code/csharp/Namespace.qll

@@ -7,7 +7,7 @@ private import dotnet
 /**
  * A type container. Either a namespace (`Namespace`) or a type (`Type`).
  */
-class TypeContainer extends DotNet::NamedElement, Element, @type_container { }
+class TypeContainer extends Declaration, @type_container { }
 
 /**
  * A namespace, for example
@@ -30,6 +30,10 @@ class Namespace extends DotNet::Namespace, TypeContainer, Declaration, @namespac
     parent_namespace(result, this)
   }
 
+  override predicate hasQualifiedName(string qualifier, string name) {
+    DotNet::Namespace.super.hasQualifiedName(qualifier, name)
+  }
+
   /**
    * Gets a type directly declared in this namespace, if any.
    * For example, the class `File` in

csharp/ql/lib/semmle/code/csharp/Type.qll

@@ -56,23 +56,6 @@ private predicate isObjectClass(Class c) { c instanceof ObjectType }
  * Either a value type (`ValueType`) or a reference type (`RefType`).
  */
 class ValueOrRefType extends DotNet::ValueOrRefType, Type, Attributable, @value_or_ref_type {
-  /**
-   * Holds if this type has the qualified name `qualifier`.`name`.
-   *
-   * For example the class `System.IO.IOException` has
-   * `qualifier`=`System.IO` and `name`=`IOException`.
-   */
-  override predicate hasQualifiedName(string qualifier, string name) {
-    exists(string enclosing |
-      this.getDeclaringType().hasQualifiedName(qualifier, enclosing) and
-      name = enclosing + "+" + this.getUndecoratedName()
-    )
-    or
-    not exists(this.getDeclaringType()) and
-    qualifier = this.getNamespace().getFullName() and
-    name = this.getUndecoratedName()
-  }
-
   /** Gets the namespace containing this type. */
   Namespace getNamespace() {
     if exists(this.getDeclaringType())
@@ -409,11 +392,6 @@ class NonNestedType extends ValueOrRefType {
  * The `void` type.
  */
 class VoidType extends ValueOrRefType, @void_type {
-  override predicate hasQualifiedName(string qualifier, string name) {
-    qualifier = "System" and
-    name = "Void"
-  }
-
   final override string getName() { result = "Void" }
 
   final override string getUndecoratedName() { result = "Void" }
@@ -1028,11 +1006,6 @@ class NullableType extends ValueType, ConstructedType, @nullable_type {
   override Type getTypeArgument(int p) { p = 0 and result = this.getUnderlyingType() }
 
   override string getAPrimaryQlClass() { result = "NullableType" }
-
-  final override predicate hasQualifiedName(string qualifier, string name) {
-    qualifier = "System" and
-    name = "Nullable<" + this.getUnderlyingType().getQualifiedName() + ">"
-  }
 }
 
 /**
@@ -1102,13 +1075,6 @@ class ArrayType extends DotNet::ArrayType, RefType, @array_type {
     not type_location(this, _) and
     result = this.getElementType().getALocation()
   }
-
-  final override predicate hasQualifiedName(string qualifier, string name) {
-    exists(Type elementType, string name0 |
-      elementType.hasQualifiedName(qualifier, name0) and
-      name = name0 + this.getDimensionString(elementType)
-    )
-  }
 }
 
 /**
@@ -1137,13 +1103,6 @@ class PointerType extends DotNet::PointerType, Type, @pointer_type {
   override string toString() { result = DotNet::PointerType.super.toString() }
 
   override string getAPrimaryQlClass() { result = "PointerType" }
-
-  final override predicate hasQualifiedName(string qualifier, string name) {
-    exists(string name0 |
-      this.getReferentType().hasQualifiedName(qualifier, name0) and
-      name = name0 + "*"
-    )
-  }
 }
 
 /**
@@ -1230,10 +1189,6 @@ class TupleType extends ValueType, @tuple_type {
 
   override Type getChild(int i) { result = this.getUnderlyingType().getChild(i) }
 
-  final override predicate hasQualifiedName(string qualifier, string name) {
-    this.getUnderlyingType().hasQualifiedName(qualifier, name)
-  }
-
   override string getAPrimaryQlClass() { result = "TupleType" }
 }
 

csharp/ql/lib/semmle/code/csharp/Variable.qll

@@ -75,8 +75,6 @@ class LocalScopeVariable extends Variable, @local_scope_variable {
    * Holds if this local variable or parameter is `scoped`.
    */
   predicate isScoped() { scoped_annotation(this, _) }
-
-  override predicate hasQualifiedName(string qualifier, string name) { none() }
 }
 
 /**