Merge pull request #4618 from hvitved/csharp/get-source-decl-rename

C#: Rename `getSourceDeclaration()` to `getUnboundDeclaration()`

Author: hvitved

csharp/change-notes/2020-11-05-get-sourcedeclaration-rename.md

@@ -0,0 +1,4 @@
+lgtm,codescanning
+* The predicate `Declaration::getSourceDeclaration/0` has been renamed to `Declaration::getUnboundDeclaration/0`.
+  This is to avoid confusion, as it has nothing to do with declarations from source code (as opposed to declarations
+  in assemblies), but instead has to do with generics.

csharp/ql/examples/snippets/null_argument.ql

@@ -17,7 +17,7 @@ where
   add.hasName("Add") and
   add
       .getDeclaringType()
-      .getSourceDeclaration()
+      .getUnboundDeclaration()
       .hasQualifiedName("System.Collections.Generic.ICollection<>") and
   call.getAnArgument() instanceof NullLiteral
 select call

csharp/ql/src/API Abuse/Dispose.qll

@@ -56,7 +56,7 @@ class LocalScopeDisposableCreation extends Call {
       exists(Method create | this.getTarget() = create |
         create.hasName("Create") and
         create.isStatic() and
-        create.getDeclaringType().getSourceDeclaration() = t.getSourceDeclaration()
+        create.getDeclaringType().getUnboundDeclaration() = t.getUnboundDeclaration()
       )
     )
   }

csharp/ql/src/API Abuse/NonOverridingMethod.ql

@@ -28,7 +28,7 @@ predicate nonOverridingMethod(Method m, Method vm) {
   not m.overrides() and
   not m.isOverride() and
   not m.isNew() and
-  m = m.getSourceDeclaration() and
+  m.isUnboundDeclaration() and
   m.getNumberOfParameters() = vm.getNumberOfParameters() and
   forall(int i, Parameter p1, Parameter p2 | p1 = m.getParameter(i) and p2 = vm.getParameter(i) |
     p1.getType() = p2.getType()
@@ -41,4 +41,4 @@ where
   m.fromSource() and
   nonOverridingMethod(m, vm)
 select m, "Method '" + m.getName() + "' looks like it should override $@ but does not do so.",
-  vm.getSourceDeclaration(), vm.getQualifiedName()
+  vm.getUnboundDeclaration(), vm.getQualifiedName()

csharp/ql/src/API Abuse/NullArgumentToEquals.ql

@@ -15,7 +15,7 @@ import semmle.code.csharp.frameworks.System
 
 from MethodCall c, EqualsMethod equals
 where
-  c.getTarget().getSourceDeclaration() = equals and
+  c.getTarget().getUnboundDeclaration() = equals and
   c.getArgument(0) instanceof NullLiteral and
   not c.getQualifier().getType() instanceof NullableType
 select c, "Equality test with 'null' will never be true, but may throw a 'NullReferenceException'."

csharp/ql/src/API Abuse/UncheckedReturnValue.ql

@@ -32,7 +32,7 @@ predicate important(Method m) {
 /** Holds if the return type of `m` is an instantiated type parameter from `m`. */
 predicate methodHasGenericReturnType(ConstructedMethod cm) {
   exists(UnboundGenericMethod ugm |
-    ugm = cm.getSourceDeclaration() and
+    ugm = cm.getUnboundGeneric() and
     ugm.getReturnType() = ugm.getATypeParameter()
   )
 }
@@ -46,16 +46,16 @@ predicate dubious(Method m, int percentage) {
   // Suppress on methods designed for chaining
   not designedForChaining(m) and
   exists(int used, int total, Method target |
-    target = m.getSourceDeclaration() and
+    target = m.getUnboundDeclaration() and
     used =
       count(MethodCall mc |
-        mc.getTarget().getSourceDeclaration() = target and
+        mc.getTarget().getUnboundDeclaration() = target and
         not mc instanceof DiscardedMethodCall and
         (methodHasGenericReturnType(m) implies m.getReturnType() = mc.getTarget().getReturnType())
       ) and
     total =
       count(MethodCall mc |
-        mc.getTarget().getSourceDeclaration() = target and
+        mc.getTarget().getUnboundDeclaration() = target and
         (methodHasGenericReturnType(m) implies m.getReturnType() = mc.getTarget().getReturnType())
       ) and
     used != total and

csharp/ql/src/Architecture/Refactoring Opportunities/FeatureEnvy.ql

@@ -16,10 +16,10 @@ import csharp
 
 Member getAUsedMember(Method m) {
   exists(MemberAccess ma | ma.getEnclosingCallable() = m |
-    result = ma.getTarget().getSourceDeclaration()
+    result = ma.getTarget().getUnboundDeclaration()
   )
   or
-  exists(Call c | c.getEnclosingCallable() = m | result = c.getTarget().getSourceDeclaration())
+  exists(Call c | c.getEnclosingCallable() = m | result = c.getTarget().getUnboundDeclaration())
 }
 
 int dependencyCount(Method source, RefType target) {
@@ -50,8 +50,8 @@ predicate query(Method m, RefType targetType, int selfCount, int depCount) {
     not m instanceof ExtensionMethod and
     // Do not move up/down the class hierarchy
     not (
-      sourceType.getABaseType*().getSourceDeclaration() = targetType or
-      targetType.getABaseType*().getSourceDeclaration() = sourceType
+      sourceType.getABaseType*().getUnboundDeclaration() = targetType or
+      targetType.getABaseType*().getUnboundDeclaration() = sourceType
     ) and
     // Do not move between nested types
     not (sourceType.getDeclaringType*() = targetType or targetType.getDeclaringType*() = sourceType) and

csharp/ql/src/Bad Practices/Implementation Hiding/AbstractToConcreteCollection.ql

@@ -22,9 +22,9 @@ class CollectionInterface extends Interface {
   CollectionInterface() {
     exists(Interface i | i = this.getABaseInterface*() |
       i instanceof SystemCollectionsICollectionInterface or
-      i.getSourceDeclaration() instanceof SystemCollectionsGenericICollectionInterface or
+      i.getUnboundDeclaration() instanceof SystemCollectionsGenericICollectionInterface or
       i instanceof SystemCollectionsIEnumerableInterface or
-      i.getSourceDeclaration() instanceof SystemCollectionsGenericIEnumerableTInterface
+      i.getUnboundDeclaration() instanceof SystemCollectionsGenericIEnumerableTInterface
     )
   }
 }

csharp/ql/src/Bad Practices/Implementation Hiding/ExposeRepresentation.ql

@@ -15,15 +15,15 @@ import semmle.code.csharp.commons.Collections
 import DataFlow
 
 predicate storesCollection(Callable c, Parameter p, Field f) {
-  f.getDeclaringType() = c.getDeclaringType().getABaseType*().getSourceDeclaration() and
+  f.getDeclaringType() = c.getDeclaringType().getABaseType*().getUnboundDeclaration() and
   f.getType() instanceof CollectionType and
   p = c.getAParameter() and
   f.getAnAssignedValue() = p.getAnAccess() and
   not c.(Modifiable).isStatic()
 }
 
 predicate returnsCollection(Callable c, Field f) {
-  f.getDeclaringType() = c.getDeclaringType().getABaseType*().getSourceDeclaration() and
+  f.getDeclaringType() = c.getDeclaringType().getABaseType*().getUnboundDeclaration() and
   f.getType() instanceof CollectionType and
   c.canReturn(f.getAnAccess()) and
   not c.(Modifiable).isStatic()

csharp/ql/src/Dead Code/DeadCode.qll

@@ -36,8 +36,8 @@ Expr getAnAccessByDynamicCall(Method m) {
 Expr getAMethodAccess(Method m) {
   result = getAnAccessByDynamicCall(m) or
   result = getAnAccessByReflection(m) or
-  result.(MethodCall).getTarget().getSourceDeclaration() = m or
-  result.(MethodAccess).getTarget().getSourceDeclaration() = m
+  result.(MethodCall).getTarget().getUnboundDeclaration() = m or
+  result.(MethodAccess).getTarget().getUnboundDeclaration() = m
 }
 
 predicate potentiallyAccessedByForEach(Method m) {
@@ -63,7 +63,7 @@ predicate isRecursivelyLiveMethod(Method m) {
   or
   potentiallyAccessedByForEach(m)
   or
-  isRecursivelyLiveMethod(m.(ConstructedMethod).getSourceDeclaration())
+  isRecursivelyLiveMethod(m.(ConstructedMethod).getUnboundDeclaration())
   or
   nunitValueSource(m)
   or
@@ -78,7 +78,7 @@ predicate nunitValueSource(Method m) {
 }
 
 predicate nunitTestCaseSource(Declaration f) {
-  exists(TestCaseSourceAttribute attribute | attribute.getSourceDeclaration() = f)
+  exists(TestCaseSourceAttribute attribute | attribute.getUnboundDeclaration() = f)
 }
 
 predicate isDeadMethod(Method m) {
@@ -89,9 +89,9 @@ predicate isDeadMethod(Method m) {
 predicate isDeadField(Field f) {
   f.isPrivate() and
   not f.getDeclaringType() instanceof AnonymousClass and
-  f.getSourceDeclaration() = f and
+  f.getUnboundDeclaration() = f and
   not nunitTestCaseSource(f) and
-  forall(FieldAccess fc | fc.getTarget().getSourceDeclaration() = f |
+  forall(FieldAccess fc | fc.getTarget().getUnboundDeclaration() = f |
     isDeadMethod(fc.getEnclosingCallable())
     or
     not fc instanceof FieldRead and not fc.isRefArgument()