Merge pull request github#6260 from tamasvajk/feature/method-name

C#: Change generic method names to include <> and type args/params

Author: tamasvajk

csharp/change-notes/2021-08-17-callable-qualified-names.md

@@ -0,0 +1,8 @@
+lgtm,codescanning
+* Generic methods return their names (`getName()`, `getQualifiedName()` and `toStringWithTypes()`) with angle brackets,
+  for example `System.Linq.Enumerable.Empty<TResult>()` returns `Empty<>`, `System.Linq.Enumerable.Empty<>` and
+  `Empty<TResult>()` respectively for the unbound generic method; and `Empty<Int32>`,
+  `System.Linq.Enumerable.Empty<System.Int32>` and `Empty<int>()` respectively for the constructed generic case.
+* When accessing `getName()`, `getQualifiedName()` and `toStringWithTypes()` on constructed types, the type argument
+  names are rendered by `getName()`, `getQualifiedName()` and `toStringWithTypes()` respectively.
+* `getUndecoratedName()` can be used to access the name without angle brackets.

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

@@ -81,6 +81,8 @@ class Method extends DotNet::Callable, Element, Member, TypeContainer, DataFlowN
 
   override string getName() { cil_method(this, result, _, _) }
 
+  override string getUndecoratedName() { result = getName() }
+
   override string toString() { result = this.getName() }
 
   override Type getDeclaringType() { cil_method(this, _, result, _) }

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

@@ -25,8 +25,6 @@ class Namespace extends DotNet::Namespace, TypeContainer, @namespace {
 
   override Namespace getParentNamespace() { parent_namespace(this, result) }
 
-  override string getName() { namespaces(this, result) }
-
   override Location getLocation() { none() }
 }
 
@@ -73,7 +71,7 @@ class Type extends DotNet::Type, Declaration, TypeContainer, @cil_type {
   predicate isSystemType(string name) {
     exists(Namespace system | this.getParent() = system |
       system.getName() = "System" and
-      system.getParentNamespace() instanceof DotNet::GlobalNamespace and
+      system.getParentNamespace().getName() = "" and
       name = this.getName()
     )
   }

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

@@ -36,7 +36,7 @@ class TypeParameter extends DotNet::TypeParameter, Type, @cil_typeparameter {
 class ValueOrRefType extends DotNet::ValueOrRefType, Type, @cil_valueorreftype {
   override ValueOrRefType getDeclaringType() { result = getParent() }
 
-  override string getUndecoratedName() { result = getName() }
+  override string getUndecoratedName() { cil_type(this, result, _, _, _) }
 
   override Namespace getDeclaringNamespace() { result = getNamespace() }
 

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

@@ -243,6 +243,8 @@ class Method extends Callable, Virtualizable, Attributable, @method {
   /** Gets the name of this method. */
   override string getName() { methods(this, result, _, _, _) }
 
+  override string getUndecoratedName() { methods(this, result, _, _, _) }
+
   override ValueOrRefType getDeclaringType() { methods(this, _, result, _, _) }
 
   override Type getReturnType() { methods(this, _, _, getTypeRef(result), _) }
@@ -448,6 +450,8 @@ class Operator extends Callable, Member, Attributable, @operator {
 
   override string getName() { operators(this, _, result, _, _, _) }
 
+  override string getUndecoratedName() { operators(this, _, result, _, _, _) }
+
   /**
    * Gets the metadata name of the operator, such as `op_implicit` or `op_RightShift`.
    */
@@ -989,6 +993,8 @@ class ExplicitConversionOperator extends ConversionOperator {
 class LocalFunction extends Callable, Modifiable, Attributable, @local_function {
   override string getName() { local_functions(this, result, _, _) }
 
+  override string getUndecoratedName() { local_functions(this, result, _, _) }
+
   override LocalFunction getUnboundDeclaration() { local_functions(this, _, _, result) }
 
   override Type getReturnType() { local_functions(this, _, result, _) }

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

@@ -19,6 +19,8 @@ private import TypeRef
 class Event extends DeclarationWithAccessors, @event {
   override string getName() { events(this, result, _, _, _) }
 
+  override string getUndecoratedName() { events(this, result, _, _, _) }
+
   override ValueOrRefType getDeclaringType() { events(this, _, result, _, _) }
 
   override DelegateType getType() { events(this, _, _, getTypeRef(result), _) }
@@ -111,6 +113,8 @@ class EventAccessor extends Accessor, @event_accessor {
 class AddEventAccessor extends EventAccessor, @add_event_accessor {
   override string getName() { result = "add" + "_" + getDeclaration().getName() }
 
+  override string getUndecoratedName() { result = "add" + "_" + getDeclaration().getName() }
+
   override string getAPrimaryQlClass() { result = "AddEventAccessor" }
 }
 
@@ -130,5 +134,7 @@ class AddEventAccessor extends EventAccessor, @add_event_accessor {
 class RemoveEventAccessor extends EventAccessor, @remove_event_accessor {
   override string getName() { result = "remove" + "_" + getDeclaration().getName() }
 
+  override string getUndecoratedName() { result = "remove" + "_" + getDeclaration().getName() }
+
   override string getAPrimaryQlClass() { result = "RemoveEventAccessor" }
 }

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

@@ -47,6 +47,18 @@ class UnboundGeneric extends DotNet::UnboundGeneric, Generic {
   }
 }
 
+/** Gets the type parameters as a comma-separated string. */
+language[monotonicAggregates]
+private string getTypeParametersToString(UnboundGeneric ug) {
+  result =
+    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)) | "", ",")
+}
+
 /**
  * A constructed generic.
  *
@@ -72,6 +84,26 @@ class ConstructedGeneric extends DotNet::ConstructedGeneric, Generic {
   final AnnotatedType getAnnotatedTypeArgument(int i) { result.appliesToTypeArgument(this, i) }
 }
 
+/** Gets the type arguments as a comma-separated string. */
+language[monotonicAggregates]
+private string getTypeArgumentsToString(ConstructedGeneric cg) {
+  result =
+    strictconcat(Type t, int i | t = cg.getTypeArgument(i) | t.toStringWithTypes(), ", " order by i)
+}
+
+/** Gets the concatenation of the `getName()` of type arguments. */
+language[monotonicAggregates]
+private string getTypeArgumentsNames(ConstructedGeneric cg) {
+  result = strictconcat(Type t, int i | t = cg.getTypeArgument(i) | t.getName(), "," order by i)
+}
+
+/** Gets the concatenation of the `getQualifiedName()` of type arguments. */
+language[monotonicAggregates]
+private string getTypeArgumentsQualifiedNames(ConstructedGeneric cg) {
+  result =
+    strictconcat(Type t, int i | t = cg.getTypeArgument(i) | t.getQualifiedName(), "," 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<>`).
@@ -111,20 +143,16 @@ class UnboundGenericType extends ValueOrRefType, UnboundGeneric {
 
   final override Type getChild(int n) { result = getTypeParameter(n) }
 
-  private string getTypeParameterCommas() {
-    result = strictconcat(int i | exists(this.getTypeParameter(i)) | "", ",")
-  }
-
   override string toStringWithTypes() {
-    result = this.getUndecoratedName() + "<" + this.typeParametersToString() + ">"
+    result = this.getUndecoratedName() + "<" + getTypeParametersToString(this) + ">"
   }
 
   final override string getName() {
-    result = this.getUndecoratedName() + "<" + this.getTypeParameterCommas() + ">"
+    result = this.getUndecoratedName() + "<" + getTypeParameterCommas(this) + ">"
   }
 
   final override predicate hasQualifiedName(string qualifier, string name) {
-    exists(string name0 | name = name0 + "<" + this.getTypeParameterCommas() + ">" |
+    exists(string name0 | name = name0 + "<" + getTypeParameterCommas(this) + ">" |
       exists(string enclosing |
         this.getDeclaringType().hasQualifiedName(qualifier, enclosing) and
         name0 = enclosing + "+" + this.getUndecoratedName()
@@ -348,8 +376,8 @@ class UnboundGenericDelegateType extends DelegateType, UnboundGenericType {
 
   override string toStringWithTypes() {
     result =
-      getUndecoratedName() + "<" + this.typeParametersToString() + ">(" + parameterTypesToString() +
-        ")"
+      getUndecoratedName() + "<" + getTypeParametersToString(this) + ">(" + parameterTypesToString()
+        + ")"
   }
 }
 
@@ -378,37 +406,16 @@ class ConstructedType extends ValueOrRefType, ConstructedGeneric {
 
   final override Type getChild(int n) { result = getTypeArgument(n) }
 
-  language[monotonicAggregates]
-  private string getTypeArgumentsString() {
-    result =
-      strictconcat(Type t, int i | t = this.getTypeArgument(i) | t.toString(), ", " order by i)
-  }
-
-  language[monotonicAggregates]
-  private string getTypeArgumentsNames() {
-    result = strictconcat(Type t, int i | t = this.getTypeArgument(i) | t.getName(), "," order by i)
-  }
-
-  language[monotonicAggregates]
-  private string getTypeArgumentsQualifiedNames() {
-    result =
-      strictconcat(Type t, int i |
-        t = this.getTypeArgument(i)
-      |
-        t.getQualifiedName(), "," order by i
-      )
-  }
-
   final override string toStringWithTypes() {
-    result = this.getUndecoratedName() + "<" + this.getTypeArgumentsString() + ">"
+    result = this.getUndecoratedName() + "<" + getTypeArgumentsToString(this) + ">"
   }
 
   final override string getName() {
-    result = this.getUndecoratedName() + "<" + this.getTypeArgumentsNames() + ">"
+    result = this.getUndecoratedName() + "<" + getTypeArgumentsNames(this) + ">"
   }
 
   final override predicate hasQualifiedName(string qualifier, string name) {
-    exists(string name0 | name = name0 + "<" + this.getTypeArgumentsQualifiedNames() + ">" |
+    exists(string name0 | name = name0 + "<" + getTypeArgumentsQualifiedNames(this) + ">" |
       exists(string enclosing |
         this.getDeclaringType().hasQualifiedName(qualifier, enclosing) and
         name0 = enclosing + "+" + this.getUndecoratedName()
@@ -535,8 +542,15 @@ class UnboundGenericMethod extends Method, UnboundGeneric {
 
   override string toStringWithTypes() {
     result =
-      getName() + "<" + this.typeParametersToString() + ">" + "(" + parameterTypesToString() + ")"
+      getUndecoratedName() + "<" + getTypeParametersToString(this) + ">" + "(" +
+        parameterTypesToString() + ")"
+  }
+
+  final override string getName() {
+    result = getUndecoratedName() + "<" + getTypeParameterCommas(this) + ">"
   }
+
+  final override string getUndecoratedName() { methods(this, result, _, _, _) }
 }
 
 /**
@@ -566,12 +580,24 @@ class ConstructedMethod extends Method, ConstructedGeneric {
 
   override string toStringWithTypes() {
     result =
-      getName() + "<" + this.typeArgumentsToString() + ">" + "(" + parameterTypesToString() + ")"
+      getUndecoratedName() + "<" + getTypeArgumentsToString(this) + ">" + "(" +
+        parameterTypesToString() + ")"
   }
 
   override UnboundGenericMethod getUnboundDeclaration() {
     result = Method.super.getUnboundDeclaration()
   }
+
+  final override string getName() {
+    result = getUndecoratedName() + "<" + getTypeArgumentsNames(this) + ">"
+  }
+
+  override predicate hasQualifiedName(string qualifier, string name) {
+    qualifier = getDeclaringType().getQualifiedName() and
+    name = getUndecoratedName() + "<" + getTypeArgumentsQualifiedNames(this) + ">"
+  }
+
+  final override string getUndecoratedName() { methods(this, result, _, _, _) }
 }
 
 /**

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

@@ -125,7 +125,7 @@ private DeclarationWithAccessors getACompatibleInterfaceAccessor(DeclarationWith
 }
 
 private DeclarationWithAccessors getACompatibleInterfaceAccessorCandidate(DeclarationWithAccessors d) {
-  getACompatibleInterfaceAccessorAux(result, d.getDeclaringType(), d.getName()) and
+  getACompatibleInterfaceAccessorAux(result, d.getDeclaringType(), d.getUndecoratedName()) and
   not d instanceof Indexer and
   d.isPublic()
 }
@@ -135,7 +135,7 @@ private predicate getACompatibleInterfaceAccessorAux(
   DeclarationWithAccessors d, ValueOrRefType t, string name
 ) {
   t = getAPossibleImplementor(d.getDeclaringType()) and
-  name = d.getName()
+  name = d.getUndecoratedName()
 }
 
 /**
@@ -215,7 +215,7 @@ private Method getACompatibleInterfaceMethod(Method m) {
  * in a type that is a possible implementor type for the interface type.
  */
 private Method getAnInterfaceMethodCandidate(Method m) {
-  getAPotentialInterfaceMethodAux(result, m.getDeclaringType(), m.getName(),
+  getAPotentialInterfaceMethodAux(result, m.getDeclaringType(), m.getUndecoratedName(),
     m.getNumberOfParameters()) and
   m.isPublic()
 }
@@ -225,7 +225,7 @@ private predicate getAPotentialInterfaceMethodAux(
   Method m, ValueOrRefType t, string name, int params
 ) {
   t = getAPossibleImplementor(m.getDeclaringType()) and
-  name = m.getName() and
+  name = m.getUndecoratedName() and
   params = m.getNumberOfParameters()
 }
 

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

@@ -19,9 +19,6 @@ class TypeContainer extends DotNet::NamedElement, Element, @type_container { }
  * ```
  */
 class Namespace extends DotNet::Namespace, TypeContainer, Declaration, @namespace {
-  /** Gets the simple name of this namespace, for example `IO` in `System.IO`. */
-  override string getName() { namespaces(this, result) }
-
   override Namespace getParent() { result = this.getParentNamespace() }
 
   override Namespace getParentNamespace() { parent_namespace(this, result) }

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

@@ -116,6 +116,8 @@ class DeclarationWithGetSetAccessors extends DeclarationWithAccessors, TopLevelE
 class Property extends DotNet::Property, DeclarationWithGetSetAccessors, @property {
   override string getName() { properties(this, result, _, _, _) }
 
+  override string getUndecoratedName() { properties(this, result, _, _, _) }
+
   override ValueOrRefType getDeclaringType() { properties(this, _, result, _, _) }
 
   override Type getType() { properties(this, _, _, getTypeRef(result), _) }
@@ -251,6 +253,8 @@ class Property extends DotNet::Property, DeclarationWithGetSetAccessors, @proper
 class Indexer extends DeclarationWithGetSetAccessors, Parameterizable, @indexer {
   override string getName() { indexers(this, result, _, _, _) }
 
+  override string getUndecoratedName() { indexers(this, result, _, _, _) }
+
   /** Gets the dimension of this indexer, that is, its number of parameters. */
   int getDimension() { result = getNumberOfParameters() }
 
@@ -393,6 +397,8 @@ class Accessor extends Callable, Modifiable, Attributable, @callable_accessor {
 class Getter extends Accessor, @getter {
   override string getName() { result = "get" + "_" + getDeclaration().getName() }
 
+  override string getUndecoratedName() { result = "get" + "_" + getDeclaration().getName() }
+
   override Type getReturnType() { result = getDeclaration().getType() }
 
   /**
@@ -440,6 +446,8 @@ class Getter extends Accessor, @getter {
 class Setter extends Accessor, @setter {
   override string getName() { result = "set" + "_" + getDeclaration().getName() }
 
+  override string getUndecoratedName() { result = "set" + "_" + getDeclaration().getName() }
+
   override Type getReturnType() {
     exists(this) and // needed to avoid compiler warning
     result instanceof VoidType