QL: make FieldAccess::getDeclaration return a FieldDecl

Author: erik-krogh

ql/ql/src/codeql/GlobalValueNumbering.qll

@@ -5,7 +5,7 @@ private import codeql_ql.ast.internal.Builtins
 
 private newtype TValueNumber =
   TVariableValueNumber(VarDecl var) { variableAccessValueNumber(_, var) } or
-  TFieldValueNumber(VarDecl var) { fieldAccessValueNumber(_, var) } or
+  TFieldValueNumber(FieldDecl var) { fieldAccessValueNumber(_, var) } or
   TThisValueNumber(Predicate pred) { thisAccessValueNumber(_, pred) } or
   TPredicateValueNumber(PredicateOrBuiltin pred, ValueNumberArgumentList args) {
     predicateCallValueNumber(_, pred, args)
@@ -103,7 +103,7 @@ private predicate variableAccessValueNumber(VarAccess access, VarDef var) {
   access.getDeclaration() = var
 }
 
-private predicate fieldAccessValueNumber(FieldAccess access, VarDef var) {
+private predicate fieldAccessValueNumber(FieldAccess access, FieldDecl var) {
   access.getDeclaration() = var
 }
 
@@ -179,7 +179,7 @@ private TValueNumber nonUniqueValueNumber(Expr e) {
     result = TVariableValueNumber(var)
   )
   or
-  exists(VarDecl var |
+  exists(FieldDecl var |
     fieldAccessValueNumber(e, var) and
     result = TFieldValueNumber(var)
   )

ql/ql/src/codeql_ql/ast/Ast.qll

@@ -1754,11 +1754,11 @@ class FieldAccess extends Identifier {
   FieldAccess() { resolveField(this, decl) }
 
   /** Gets the accessed field. */
-  VarDecl getDeclaration() { result = decl }
+  FieldDecl getDeclaration() { result.getVarDecl() = decl }
 
   override string getName() { result = id.getChild().(QL::VarName).getChild().getValue() }
 
-  override Type getType() { result = this.getDeclaration().getType() }
+  override Type getType() { result = decl.getType() }
 
   override string getAPrimaryQlClass() { result = "FieldAccess" }
 }

ql/ql/src/codeql_ql/ast/internal/Variable.qll

@@ -85,7 +85,7 @@ module VarConsistency {
     strictcount(v.getDeclaration()) > 1
   }
 
-  query predicate multipleFieldDefs(FieldAccess f, VarDef decl) {
+  query predicate multipleFieldDefs(FieldAccess f, FieldDecl decl) {
     decl = f.getDeclaration() and
     strictcount(f.getDeclaration()) > 1
   }

ql/ql/src/codeql_ql/style/UseInstanceofExtensionQuery.qll

@@ -40,7 +40,7 @@ InlineCast getAThisCast(Class c, Type type) {
   )
 }
 
-predicate usesFieldBasedInstanceof(Class c, TypeExpr type, VarDecl field, ComparisonFormula comp) {
+predicate usesFieldBasedInstanceof(Class c, TypeExpr type, FieldDecl field, ComparisonFormula comp) {
   exists(FieldAccess fieldAccess |
     c.getCharPred().getBody() = comp or
     c.getCharPred().getBody().(Conjunction).getAnOperand() = comp
@@ -50,7 +50,7 @@ predicate usesFieldBasedInstanceof(Class c, TypeExpr type, VarDecl field, Compar
     comp.getAnOperand() instanceof ThisAccess and
     comp.getAnOperand() = fieldAccess and
     fieldAccess.getDeclaration() = field and
-    field.getTypeExpr() = type
+    field.getVarDecl().getTypeExpr() = type
   ) and
   // require that there is a call to the range field that matches the name of the enclosing predicate
   exists(FieldAccess access, MemberCall call |
@@ -60,7 +60,7 @@ predicate usesFieldBasedInstanceof(Class c, TypeExpr type, VarDecl field, Compar
   )
 }
 
-FieldAccess getARangeFieldAccess(Class c, VarDecl field, string name) {
+FieldAccess getARangeFieldAccess(Class c, FieldDecl field, string name) {
   exists(MemberCall call |
     result = call.getBase() and
     result.getDeclaration() = field and

ql/ql/src/codeql_ql/style/UseSetLiteralQuery.qll

@@ -68,7 +68,7 @@ class DisjunctionEqualsLiteral extends DisjunctionChain {
     )
     or
     // FieldAccess on the same variable
-    exists(VarDecl v |
+    exists(FieldDecl v |
       forex(Formula f | f = getOperand(_) |
         f.(EqualsLiteral).getAnOperand().(FieldAccess).getDeclaration() = v
       ) and

ql/ql/src/ide-contextual-queries/Definitions.qll

@@ -48,7 +48,7 @@ private predicate resolveVar(VarAccess va, VarDecl decl, string kind) {
   kind = "variable"
 }
 
-private predicate resolveField(FieldAccess va, VarDecl decl, string kind) {
+private predicate resolveField(FieldAccess va, FieldDecl decl, string kind) {
   decl = va.getDeclaration() and
   kind = "field"
 }

ql/ql/src/queries/style/FieldOnlyUsedInCharPred.ql

@@ -13,7 +13,7 @@ import ql
 from Class c, FieldDecl f
 where
   c.getAField() = f and
-  forex(FieldAccess access | access.getDeclaration() = f.getVarDecl() |
+  forex(FieldAccess access | access.getDeclaration() = f |
     access.getEnclosingPredicate() = c.getCharPred()
   ) and
   not f.getVarDecl().overrides(_)