C#: Deprecate {get,has}QualifiedName and replace with {get,has}FullyQualifiedName

Author: hvitved

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

@@ -25,13 +25,21 @@ class Declaration extends DotNet::Declaration, Element, @cil_declaration {
 
   override Declaration getUnboundDeclaration() { result = this }
 
-  override predicate hasQualifiedName(string qualifier, string name) {
+  deprecated 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()
   }
+
+  override predicate hasFullyQualifiedName(string qualifier, string name) {
+    exists(string dqualifier, string dname |
+      this.getDeclaringType().hasFullyQualifiedName(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/cil/InstructionGroups.qll

@@ -151,7 +151,7 @@ class Call extends Expr, DotNet::Call, @cil_call_any {
 
   override Method getARuntimeTarget() { result = this.getTarget().getAnOverrider*() }
 
-  override string getExtra() { result = this.getTarget().getQualifiedName() }
+  override string getExtra() { result = this.getTarget().getFullyQualifiedName() }
 
   /**
    * Gets the return type of the call. Methods that do not return a value

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

@@ -529,7 +529,7 @@ module Opcodes {
     /** Gets the type that is being tested against. */
     Type getTestedType() { result = this.getAccess() }
 
-    override string getExtra() { result = this.getTestedType().getQualifiedName() }
+    override string getExtra() { result = this.getTestedType().getFullyQualifiedName() }
   }
 
   /** A `castclass` instruction. */
@@ -541,7 +541,7 @@ module Opcodes {
     /** Gets the type that is being cast to. */
     Type getTestedType() { result = this.getAccess() }
 
-    override string getExtra() { result = this.getTestedType().getQualifiedName() }
+    override string getExtra() { result = this.getTestedType().getFullyQualifiedName() }
   }
 
   /** An `stloc.0` instruction. */
@@ -879,7 +879,7 @@ module Opcodes {
       result = this.getAccess()
     }
 
-    override string getExtra() { result = this.getType().getQualifiedName() }
+    override string getExtra() { result = this.getType().getFullyQualifiedName() }
   }
 
   /** An `ldelem` instruction. */

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

@@ -51,13 +51,22 @@ class Type extends DotNet::Type, Declaration, TypeContainer, @cil_type {
    */
   Type getUnboundType() { cil_type(this, _, _, _, result) }
 
-  override predicate hasQualifiedName(string qualifier, string name) {
+  deprecated override predicate hasQualifiedName(string qualifier, string name) {
     name = this.getName() and
     exists(string pqualifier, string pname | this.getParent().hasQualifiedName(pqualifier, pname) |
       qualifier = getQualifiedName(pqualifier, pname)
     )
   }
 
+  override predicate hasFullyQualifiedName(string qualifier, string name) {
+    name = this.getName() and
+    exists(string pqualifier, string pname |
+      this.getParent().hasFullyQualifiedName(pqualifier, pname)
+    |
+      qualifier = getQualifiedName(pqualifier, pname)
+    )
+  }
+
   override Location getALocation() { cil_type_location(this.getUnboundDeclaration(), result) }
 
   /** Holds if this type is a class. */

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

@@ -29,7 +29,9 @@ class Variable extends DotNet::Variable, Declaration, DataFlowNode, @cil_variabl
 
 /** A stack variable. Either a local variable (`LocalVariable`) or a parameter (`Parameter`). */
 class StackVariable extends Variable, @cil_stack_variable {
-  override predicate hasQualifiedName(string qualifier, string name) { none() }
+  deprecated override predicate hasQualifiedName(string qualifier, string name) { none() }
+
+  override predicate hasFullyQualifiedName(string qualifier, string name) { none() }
 }
 
 /**

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

@@ -56,9 +56,9 @@ private string getTypeParametersToString(UnboundGeneric ug) {
     strictconcat(Type t, int i | t = ug.getTypeParameter(i) | t.toStringWithTypes(), ", " order by i)
 }
 
-/** Gets a string of `N` commas where `N + 1` is the number of type parameters of this unbound generic. */
-private string getTypeParameterCommas(UnboundGeneric ug) {
-  result = strictconcat(int i | exists(ug.getTypeParameter(i)) | "", ",")
+/** Gets a string ``"`N"``,  where `N` is the number of type parameters of this unbound generic. */
+private string getTypeParameterBacktick(UnboundGeneric ug) {
+  result = "`" + ug.getNumberOfTypeParameters()
 }
 
 /**
@@ -147,7 +147,7 @@ class UnboundGenericType extends ValueOrRefType, UnboundGeneric {
   }
 
   final override string getName() {
-    result = this.getUndecoratedName() + "<" + getTypeParameterCommas(this) + ">"
+    result = this.getUndecoratedName() + getTypeParameterBacktick(this)
   }
 }
 
@@ -531,7 +531,7 @@ class UnboundGenericMethod extends Method, UnboundGeneric {
   }
 
   final override string getName() {
-    result = this.getUndecoratedName() + "<" + getTypeParameterCommas(this) + ">"
+    result = this.getUndecoratedName() + getTypeParameterBacktick(this)
   }
 
   final override string getUndecoratedName() { methods(this, result, _, _, _) }

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

@@ -9,7 +9,17 @@ private import Implements
 private import TypeRef
 private import commons.QualifiedName
 
-private module QualifiedNameInput implements QualifiedNameInputSig { }
+private module QualifiedNameInput implements QualifiedNameInputSig {
+  string getUnboundGenericSuffix(UnboundGeneric ug) {
+    result = "<" + strictconcat(int i | exists(ug.getTypeParameter(i)) | "", ",") + ">"
+  }
+}
+
+private module FullyQualifiedNameInput implements QualifiedNameInputSig {
+  string getUnboundGenericSuffix(UnboundGeneric ug) {
+    result = "`" + ug.getNumberOfTypeParameters()
+  }
+}
 
 /**
  * A declaration.
@@ -24,11 +34,17 @@ class Declaration extends DotNet::Declaration, Element, @declaration {
 
   override string toString() { result = this.getName() }
 
-  override predicate hasQualifiedName(string qualifier, string name) {
+  deprecated override predicate hasQualifiedName(string qualifier, string name) {
     QualifiedName<QualifiedNameInput>::hasQualifiedName(this, qualifier, name)
   }
 
+  override predicate hasFullyQualifiedName(string qualifier, string name) {
+    QualifiedName<FullyQualifiedNameInput>::hasQualifiedName(this, qualifier, name)
+  }
+
   /**
+   * DEPRECATED: Use `getFullyQualifiedNameWithTypes` instead.
+   *
    * 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
    *
@@ -40,7 +56,7 @@ class Declaration extends DotNet::Declaration, Element, @declaration {
    * }
    * ```
    */
-  string getQualifiedNameWithTypes() {
+  deprecated string getQualifiedNameWithTypes() {
     exists(string qual |
       qual = this.getDeclaringType().getQualifiedName() and
       if this instanceof NestedType
@@ -49,6 +65,27 @@ class Declaration extends DotNet::Declaration, Element, @declaration {
     )
   }
 
+  /**
+   * 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
+   *
+   * ```csharp
+   * namespace N {
+   *   class C {
+   *     void M(int i, string s) { }
+   *   }
+   * }
+   * ```
+   */
+  string getFullyQualifiedNameWithTypes() {
+    exists(string qual |
+      qual = this.getDeclaringType().getFullyQualifiedName() and
+      if this instanceof NestedType
+      then result = qual + "+" + this.toStringWithTypes()
+      else result = qual + "." + this.toStringWithTypes()
+    )
+  }
+
   /**
    * Holds if this declaration has been generated by the compiler, for example
    * implicit constructors or accessors.
@@ -207,9 +244,13 @@ class Member extends DotNet::Member, Modifiable, @member {
 
   override predicate isFile() { Modifiable.super.isFile() }
 
-  final override predicate hasQualifiedName(string namespace, string type, string name) {
+  deprecated final override predicate hasQualifiedName(string namespace, string type, string name) {
     QualifiedName<QualifiedNameInput>::hasQualifiedName(this, namespace, type, name)
   }
+
+  final override predicate hasFullyQualifiedName(string namespace, string type, string name) {
+    QualifiedName<FullyQualifiedNameInput>::hasQualifiedName(this, namespace, type, name)
+  }
 }
 
 private class TOverridable = @virtualizable or @callable_accessor;

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

@@ -30,10 +30,14 @@ class Namespace extends DotNet::Namespace, TypeContainer, Declaration, @namespac
     parent_namespace(result, this)
   }
 
-  override predicate hasQualifiedName(string qualifier, string name) {
+  deprecated override predicate hasQualifiedName(string qualifier, string name) {
     DotNet::Namespace.super.hasQualifiedName(qualifier, name)
   }
 
+  override predicate hasFullyQualifiedName(string qualifier, string name) {
+    DotNet::Namespace.super.hasFullyQualifiedName(qualifier, name)
+  }
+
   /**
    * Gets a type directly declared in this namespace, if any.
    * For example, the class `File` in

csharp/ql/lib/semmle/code/csharp/commons/QualifiedName.qll

@@ -21,17 +21,10 @@ predicate namespaceHasQualifiedName(DotNet::Namespace n, string qualifier, strin
   )
 }
 
-/** Gets a string of `N` commas where `N + 1` is the number of type parameters of this unbound generic. */
-private string getTypeParameterCommas(UnboundGeneric ug) {
-  result = strictconcat(int i | exists(ug.getTypeParameter(i)) | "", ",")
-}
-
 /** Provides the input to `QualifiedName`. */
 signature module QualifiedNameInputSig {
   /** Gets the suffix to print after unbound generic `ug`. */
-  default string getUnboundGenericSuffix(UnboundGeneric ug) {
-    result = "<" + getTypeParameterCommas(ug) + ">"
-  }
+  string getUnboundGenericSuffix(UnboundGeneric ug);
 }
 
 /** Provides predicates for computing fully qualified names. */

csharp/ql/lib/semmle/code/csharp/dataflow/SSA.qll

@@ -120,7 +120,7 @@ module Ssa {
           result = prefix + "." + this.getAssignable()
         |
           if f.(Modifiable).isStatic()
-          then prefix = f.getDeclaringType().getQualifiedName()
+          then prefix = f.getDeclaringType().getFullyQualifiedName()
           else prefix = "this"
         )
       }