Apply review suggestions: use ArgumentNode.argumentOf, and change more uses of ValuePreservingCallable -> ValuePreservingMethod

smowton · smowton · commit 012058a86652 · 2021-03-05T13:34:13.000Z
diff --git a/java/ql/src/semmle/code/java/dataflow/FlowSteps.qll b/java/ql/src/semmle/code/java/dataflow/FlowSteps.qll
@@ -46,14 +46,14 @@ abstract class ValuePreservingMethod extends Method {
  * These steps will be visible for all global data-flow purposes, as well as via
  * `DataFlow::Node.getASuccessor` and other related functions exposing intraprocedural dataflow.
  */
-abstract class FluentMethod extends ValuePreservingCallable {
+abstract class FluentMethod extends ValuePreservingMethod {
   override predicate returnsValue(int arg) { arg = -1 }
 }
 
 private class StandardLibraryValuePreservingMethod extends ValuePreservingMethod {
   int returnsArgNo;
 
-  StandardLibraryValuePreservingCallable() {
+  StandardLibraryValuePreservingMethod() {
     this.getDeclaringType().hasQualifiedName("java.util", "Objects") and
     (
       this.hasName(["requireNonNull", "requireNonNullElseGet"]) and returnsArgNo = 0
@@ -63,9 +63,7 @@ private class StandardLibraryValuePreservingMethod extends ValuePreservingMethod
       this.hasName("toString") and returnsArgNo = 1
     )
     or
-    this.getDeclaringType()
-        .getASourceSupertype*()
-        .hasQualifiedName("java.util", "Stack") and
+    this.getDeclaringType().getASourceSupertype*().hasQualifiedName("java.util", "Stack") and
     this.hasName("push") and
     returnsArgNo = 0
   }
diff --git a/java/ql/src/semmle/code/java/dataflow/internal/DataFlowUtil.qll b/java/ql/src/semmle/code/java/dataflow/internal/DataFlowUtil.qll
@@ -409,15 +409,11 @@ predicate simpleLocalFlowStep(Node node1, Node node2) {
   or
   summaryStep(node1, node2, "value")
   or
-  exists(MethodAccess ma, ValuePreservingCallable c, int argNo |
-    ma.getCallee().getSourceDeclaration() = c and c.returnsValue(argNo)
+  exists(MethodAccess ma, ValuePreservingMethod m, int argNo |
+    ma.getCallee().getSourceDeclaration() = m and m.returnsValue(argNo)
   |
     node2.asExpr() = ma and
-    (
-      node1.asExpr() = ma.getArgument(argNo)
-      or
-      argNo = -1 and node1.asExpr() = ma.getQualifier()
-    )
+    node1.(ArgumentNode).argumentOf(ma, argNo)
   )
 }
 
diff --git a/java/ql/test/library-tests/dataflow/fluent-methods/flow.ql b/java/ql/test/library-tests/dataflow/fluent-methods/flow.ql
@@ -19,7 +19,7 @@ class Model extends FluentMethod {
   Model() { this.getName() = "modelledFluentMethod" }
 }
 
-class IdentityModel extends ValuePreservingCallable {
+class IdentityModel extends ValuePreservingMethod {
   IdentityModel() { this.getName() = "modelledIdentity" }
 
   override predicate returnsValue(int arg) { arg = 0 }

Original file line number	Diff line number	Diff line change
`@@ -409,15 +409,11 @@ predicate simpleLocalFlowStep(Node node1, Node node2) {`
`409`	`409`	`or`
`410`	`410`	`summaryStep(node1, node2, "value")`
`411`	`411`	`or`
`412`		`- exists(MethodAccess ma, ValuePreservingCallable c, int argNo \|`
`413`		`- ma.getCallee().getSourceDeclaration() = c and c.returnsValue(argNo)`
	`412`	`+ exists(MethodAccess ma, ValuePreservingMethod m, int argNo \|`
	`413`	`+ ma.getCallee().getSourceDeclaration() = m and m.returnsValue(argNo)`
`414`	`414`	`\|`
`415`	`415`	`node2.asExpr() = ma and`
`416`		`- (`
`417`		`- node1.asExpr() = ma.getArgument(argNo)`
`418`		`- or`
`419`		`- argNo = -1 and node1.asExpr() = ma.getQualifier()`
`420`		`- )`
	`416`	`+ node1.(ArgumentNode).argumentOf(ma, argNo)`
`421`	`417`	`)`
`422`	`418`	`}`
`423`	`419`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class Model extends FluentMethod {`
`19`	`19`	`Model() { this.getName() = "modelledFluentMethod" }`
`20`	`20`	`}`
`21`	`21`
`22`		`-class IdentityModel extends ValuePreservingCallable {`
	`22`	`+class IdentityModel extends ValuePreservingMethod {`
`23`	`23`	`IdentityModel() { this.getName() = "modelledIdentity" }`
`24`	`24`
`25`	`25`	`override predicate returnsValue(int arg) { arg = 0 }`