Rename 'SourceVariable.getVariable' to 'SourceVariable.getIRVariable' and replace 'Def.getVariable' to 'Def.getSourceVariable'.

MathiasVP · MathiasVP · commit 387c96d1e2d4 · 2021-10-28T14:00:50.000+01:00
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/Ssa.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/Ssa.qll
@@ -73,7 +73,7 @@ abstract class Def extends DefOrUse {
   Instruction getInstruction() { result = store }
 
   /** Gets the variable that is defined by this definition. */
-  abstract SourceVariable getVariable();
+  abstract SourceVariable getSourceVariable();
 
   /** Holds if this definition is guaranteed to happen. */
   abstract predicate isCertain();
@@ -94,10 +94,10 @@ abstract class Def extends DefOrUse {
 private class ExplicitDef extends Def, TExplicitDef {
   ExplicitDef() { this = TExplicitDef(store) }
 
-  override SourceVariable getVariable() {
+  override SourceVariable getSourceVariable() {
     exists(VariableInstruction var |
       explicitWrite(_, this.getInstruction(), var) and
-      result.getVariable() = var.getIRVariable() and
+      result.getIRVariable() = var.getIRVariable() and
       not result.isIndirection()
     )
   }
@@ -108,11 +108,11 @@ private class ExplicitDef extends Def, TExplicitDef {
 private class ParameterDef extends Def, TInitializeParam {
   ParameterDef() { this = TInitializeParam(store) }
 
-  override SourceVariable getVariable() {
-    result.getVariable() = store.(InitializeParameterInstruction).getIRVariable() and
+  override SourceVariable getSourceVariable() {
+    result.getIRVariable() = store.(InitializeParameterInstruction).getIRVariable() and
     not result.isIndirection()
     or
-    result.getVariable() = store.(InitializeIndirectionInstruction).getIRVariable() and
+    result.getIRVariable() = store.(InitializeIndirectionInstruction).getIRVariable() and
     result.isIndirection()
   }
 
@@ -130,7 +130,7 @@ abstract class Use extends DefOrUse {
   override string toString() { result = "Use" }
 
   /** Gets the variable that is used by this use. */
-  abstract SourceVariable getVariable();
+  abstract SourceVariable getSourceVariable();
 
   override IRBlock getBlock() { result = use.getUse().getBlock() }
 
@@ -144,10 +144,10 @@ abstract class Use extends DefOrUse {
 private class ExplicitUse extends Use, TExplicitUse {
   ExplicitUse() { this = TExplicitUse(use) }
 
-  override SourceVariable getVariable() {
+  override SourceVariable getSourceVariable() {
     exists(VariableInstruction var |
       use.getDef() = var and
-      result.getVariable() = var.getIRVariable() and
+      result.getIRVariable() = var.getIRVariable() and
       (
         if use.getUse() instanceof ReadSideEffectInstruction
         then result.isIndirection()
@@ -160,10 +160,10 @@ private class ExplicitUse extends Use, TExplicitUse {
 private class ReturnParameterIndirection extends Use, TReturnParamIndirection {
   ReturnParameterIndirection() { this = TReturnParamIndirection(use) }
 
-  override SourceVariable getVariable() {
+  override SourceVariable getSourceVariable() {
     exists(ReturnIndirectionInstruction ret |
       returnParameterIndirection(use, ret) and
-      result.getVariable() = ret.getIRVariable() and
+      result.getIRVariable() = ret.getIRVariable() and
       result.isIndirection()
     )
   }
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/SsaImplSpecific.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/SsaImplSpecific.qll
@@ -21,7 +21,7 @@ private newtype TSourceVariable =
 abstract class SourceVariable extends TSourceVariable {
   IRVariable var;
 
-  IRVariable getVariable() { result = var }
+  IRVariable getIRVariable() { result = var }
 
   abstract string toString();
 
@@ -31,7 +31,7 @@ abstract class SourceVariable extends TSourceVariable {
 class SourceIRVariable extends SourceVariable, TSourceIRVariable {
   SourceIRVariable() { this = TSourceIRVariable(var) }
 
-  override string toString() { result = this.getVariable().toString() }
+  override string toString() { result = this.getIRVariable().toString() }
 }
 
 class SourceIRVariableIndirection extends SourceVariable, TSourceIRVariableIndirection {
@@ -41,7 +41,7 @@ class SourceIRVariableIndirection extends SourceVariable, TSourceIRVariableIndir
     this = TSourceIRVariableIndirection(init) and var = init.getIRVariable()
   }
 
-  override string toString() { result = "*" + this.getVariable().toString() }
+  override string toString() { result = "*" + this.getIRVariable().toString() }
 
   override predicate isIndirection() { any() }
 }
@@ -50,15 +50,15 @@ predicate variableWrite(BasicBlock bb, int i, SourceVariable v, boolean certain)
   DataFlowImplCommon::forceCachingInSameStage() and
   exists(Ssa::Def def |
     def.hasRankInBlock(bb, i) and
-    v = def.getVariable() and
+    v = def.getSourceVariable() and
     (if def.isCertain() then certain = true else certain = false)
   )
 }
 
 predicate variableRead(BasicBlock bb, int i, SourceVariable v, boolean certain) {
   exists(Ssa::Use use |
     use.hasRankInBlock(bb, i) and
-    v = use.getVariable() and
+    v = use.getSourceVariable() and
     certain = true
   )
 }

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ private newtype TSourceVariable =`
`21`	`21`	`abstract class SourceVariable extends TSourceVariable {`
`22`	`22`	`IRVariable var;`
`23`	`23`
`24`		`- IRVariable getVariable() { result = var }`
	`24`	`+ IRVariable getIRVariable() { result = var }`
`25`	`25`
`26`	`26`	`abstract string toString();`
`27`	`27`
`@@ -31,7 +31,7 @@ abstract class SourceVariable extends TSourceVariable {`
`31`	`31`	`class SourceIRVariable extends SourceVariable, TSourceIRVariable {`
`32`	`32`	`SourceIRVariable() { this = TSourceIRVariable(var) }`
`33`	`33`
`34`		`- override string toString() { result = this.getVariable().toString() }`
	`34`	`+ override string toString() { result = this.getIRVariable().toString() }`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`class SourceIRVariableIndirection extends SourceVariable, TSourceIRVariableIndirection {`
`@@ -41,7 +41,7 @@ class SourceIRVariableIndirection extends SourceVariable, TSourceIRVariableIndir`
`41`	`41`	`this = TSourceIRVariableIndirection(init) and var = init.getIRVariable()`
`42`	`42`	`}`
`43`	`43`
`44`		`- override string toString() { result = "*" + this.getVariable().toString() }`
	`44`	`+ override string toString() { result = "*" + this.getIRVariable().toString() }`
`45`	`45`
`46`	`46`	`override predicate isIndirection() { any() }`
`47`	`47`	`}`
`@@ -50,15 +50,15 @@ predicate variableWrite(BasicBlock bb, int i, SourceVariable v, boolean certain)`
`50`	`50`	`DataFlowImplCommon::forceCachingInSameStage() and`
`51`	`51`	`exists(Ssa::Def def \|`
`52`	`52`	`def.hasRankInBlock(bb, i) and`
`53`		`- v = def.getVariable() and`
	`53`	`+ v = def.getSourceVariable() and`
`54`	`54`	`(if def.isCertain() then certain = true else certain = false)`
`55`	`55`	`)`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`predicate variableRead(BasicBlock bb, int i, SourceVariable v, boolean certain) {`
`59`	`59`	`exists(Ssa::Use use \|`
`60`	`60`	`use.hasRankInBlock(bb, i) and`
`61`		`- v = use.getVariable() and`
	`61`	`+ v = use.getSourceVariable() and`
`62`	`62`	`certain = true`
`63`	`63`	`)`
`64`	`64`	`}`