Java: Rename ReturnStmt.getResult to getExpr.

Author: aschackmull

java/ql/examples/snippets/returnstatement.ql

@@ -10,5 +10,5 @@
 import java
 
 from ReturnStmt r
-where r.getResult() instanceof NullLiteral
+where r.getExpr() instanceof NullLiteral
 select r

java/ql/lib/semmle/code/java/ControlFlowGraph.qll

@@ -849,7 +849,7 @@ private module ControlFlowGraphImpl {
       or
       index = 0 and result = this.(ClassExpr).getExpr()
       or
-      index = 0 and result = this.(ReturnStmt).getResult()
+      index = 0 and result = this.(ReturnStmt).getExpr()
       or
       index = 0 and result = this.(ThrowStmt).getExpr()
       or

java/ql/lib/semmle/code/java/Conversions.qll

@@ -69,7 +69,7 @@ class AssignmentConversionContext extends ConversionSite {
 class ReturnConversionSite extends ConversionSite {
   ReturnStmt r;
 
-  ReturnConversionSite() { this = r.getResult() }
+  ReturnConversionSite() { this = r.getExpr() }
 
   override Type getConversionTarget() { result = r.getEnclosingCallable().getReturnType() }
 

java/ql/lib/semmle/code/java/Expr.qll

@@ -1312,7 +1312,7 @@ class LambdaExpr extends FunctionalExpr, @lambdaexpr {
 
   /** Gets the body of this lambda expression, if it is an expression. */
   Expr getExprBody() {
-    this.hasExprBody() and result = this.asMethod().getBody().getAChild().(ReturnStmt).getResult()
+    this.hasExprBody() and result = this.asMethod().getBody().getAChild().(ReturnStmt).getExpr()
   }
 
   /** Gets the body of this lambda expression, if it is a statement. */
@@ -1347,7 +1347,7 @@ class MemberRefExpr extends FunctionalExpr, @memberref {
     exists(Stmt stmt |
       stmt = this.asMethod().getBody().(SingletonBlock).getStmt() and
       (
-        result = stmt.(ReturnStmt).getResult()
+        result = stmt.(ReturnStmt).getExpr()
         or
         // Note: Currently never an ExprStmt, but might change once https://github.com/github/codeql/issues/3605 is fixed
         result = stmt.(ExprStmt).getExpr()

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

@@ -680,13 +680,13 @@ class GetterMethod extends Method {
   GetterMethod() {
     this.hasNoParameters() and
     exists(ReturnStmt s, Field f | s = this.getBody().(SingletonBlock).getStmt() |
-      s.getResult() = f.getAnAccess()
+      s.getExpr() = f.getAnAccess()
     )
   }
 
   /** Gets the field whose value is returned by this getter method. */
   Field getField() {
-    exists(ReturnStmt r | r.getEnclosingCallable() = this | r.getResult() = result.getAnAccess())
+    exists(ReturnStmt r | r.getEnclosingCallable() = this | r.getExpr() = result.getAnAccess())
   }
 }
 

java/ql/lib/semmle/code/java/PrettyPrintAst.qll

@@ -854,7 +854,7 @@ private class PpSynchronizedStmt extends PpAst, SynchronizedStmt {
 
 private class PpReturnStmt extends PpAst, ReturnStmt {
   override string getPart(int i) {
-    if exists(this.getResult())
+    if exists(this.getExpr())
     then
       i = 0 and result = "return "
       or
@@ -864,7 +864,7 @@ private class PpReturnStmt extends PpAst, ReturnStmt {
     )
   }
 
-  override PpAst getChild(int i) { i = 1 and result = this.getResult() }
+  override PpAst getChild(int i) { i = 1 and result = this.getExpr() }
 }
 
 private class PpThrowStmt extends PpAst, ThrowStmt {

java/ql/lib/semmle/code/java/Statement.qll

@@ -627,8 +627,15 @@ class SynchronizedStmt extends Stmt, @synchronizedstmt {
 
 /** A `return` statement. */
 class ReturnStmt extends Stmt, @returnstmt {
+  /**
+   * DEPRECATED: Use getExpr() instead.
+   *
+   * Gets the expression returned by this `return` statement, if any.
+   */
+  deprecated Expr getResult() { result.getParent() = this }
+
   /** Gets the expression returned by this `return` statement, if any. */
-  Expr getResult() { result.getParent() = this }
+  Expr getExpr() { result.getParent() = this }
 
   override string pp() { result = "return ..." }
 

java/ql/lib/semmle/code/java/controlflow/Guards.qll

@@ -349,7 +349,7 @@ private module GuardsInput implements SharedGuards::InputSig<Location, ControlFl
     GuardsInput::Expr getAReturnExpr() {
       exists(ReturnStmt ret |
         this = ret.getEnclosingCallable() and
-        ret.getResult() = result
+        ret.getExpr() = result
       )
     }
   }

java/ql/lib/semmle/code/java/controlflow/UnreachableBlocks.qll

@@ -49,9 +49,7 @@ class ConstantMethod extends Method {
     // Just one return statement
     count(ReturnStmt rs | rs.getEnclosingCallable() = this) = 1 and
     // Which returns a constant expr
-    exists(ReturnStmt rs | rs.getEnclosingCallable() = this |
-      rs.getResult() instanceof ConstantExpr
-    ) and
+    exists(ReturnStmt rs | rs.getEnclosingCallable() = this | rs.getExpr() instanceof ConstantExpr) and
     // And this method is not overridden
     not exists(Method m | m.overrides(this))
   }
@@ -61,7 +59,7 @@ class ConstantMethod extends Method {
    */
   ConstantExpr getConstantValue() {
     exists(ReturnStmt returnStmt | returnStmt.getEnclosingCallable() = this |
-      result = returnStmt.getResult()
+      result = returnStmt.getExpr()
     )
   }
 }

java/ql/lib/semmle/code/java/dataflow/Nullness.qll

@@ -73,7 +73,7 @@ private predicate unboxed(Expr e) {
     exists(Parameter p | p.getType() instanceof PrimitiveType and p.getAnArgument() = e)
     or
     exists(ReturnStmt ret |
-      ret.getEnclosingCallable().getReturnType() instanceof PrimitiveType and ret.getResult() = e
+      ret.getEnclosingCallable().getReturnType() instanceof PrimitiveType and ret.getExpr() = e
     )
   )
 }