Swift: control flow and dataflow library renamings

Author: d10c

swift/ql/lib/codeql/swift/controlflow/CfgNodes.qll

@@ -136,7 +136,7 @@ class PropertyGetterCfgNode extends CfgNode {
 
   CfgNode getBase() { result.getAst() = n.getBase() }
 
-  AccessorDecl getAccessorDecl() { result = n.getAccessorDecl() }
+  Accessor getAccessor() { result = n.getAccessor() }
 }
 
 /** A control-flow node that wraps a property setter. */
@@ -149,7 +149,7 @@ class PropertySetterCfgNode extends CfgNode {
 
   CfgNode getSource() { result.getAst() = n.getAssignExpr().getSource() }
 
-  AccessorDecl getAccessorDecl() { result = n.getAccessorDecl() }
+  Accessor getAccessor() { result = n.getAccessor() }
 }
 
 class PropertyObserverCfgNode extends CfgNode {
@@ -161,7 +161,7 @@ class PropertyObserverCfgNode extends CfgNode {
 
   CfgNode getSource() { result.getAst() = n.getAssignExpr().getSource() }
 
-  AccessorDecl getAccessorDecl() { result = n.getObserver() }
+  Accessor getAccessor() { result = n.getObserver() }
 }
 
 class ApplyExprCfgNode extends ExprCfgNode {
@@ -171,7 +171,7 @@ class ApplyExprCfgNode extends ExprCfgNode {
 
   CfgNode getQualifier() { result.getAst() = e.getQualifier() }
 
-  AbstractFunctionDecl getStaticTarget() { result = e.getStaticTarget() }
+  Callable getStaticTarget() { result = e.getStaticTarget() }
 
   Expr getFunction() { result = e.getFunction() }
 }

swift/ql/lib/codeql/swift/controlflow/internal/Completion.qll

@@ -309,7 +309,7 @@ private predicate mayHaveThrowCompletion(ControlFlowElement n) {
   isThrowingType(n.asAstNode().(ApplyExpr).getFunction().getType())
   or
   // Getters are the only accessor declarators that may throw.
-  exists(AccessorDecl accessor | isThrowingType(accessor.getInterfaceType()) |
+  exists(Accessor accessor | isThrowingType(accessor.getInterfaceType()) |
     isPropertyGetterElement(n, accessor, _)
   )
 }

swift/ql/lib/codeql/swift/controlflow/internal/ControlFlowElements.qll

@@ -3,13 +3,13 @@ private import swift
 cached
 newtype TControlFlowElement =
   TAstElement(AstNode n) or
-  TFuncDeclElement(AbstractFunctionDecl func) { func.hasBody() } or
-  TClosureElement(ClosureExpr clos) or
+  TFuncDeclElement(Function func) { func.hasBody() } or
+  TClosureElement(ExplicitClosureExpr clos) or
   TPropertyGetterElement(Decl accessor, Expr ref) { isPropertyGetterElement(accessor, ref) } or
-  TPropertySetterElement(AccessorDecl accessor, AssignExpr assign) {
+  TPropertySetterElement(Accessor accessor, AssignExpr assign) {
     isPropertySetterElement(accessor, assign)
   } or
-  TPropertyObserverElement(AccessorDecl observer, AssignExpr assign) {
+  TPropertyObserverElement(Accessor observer, AssignExpr assign) {
     isPropertyObserverElement(observer, assign)
   } or
   TKeyPathElement(KeyPathExpr expr)
@@ -24,19 +24,19 @@ predicate ignoreAstElement(AstNode n) {
   isPropertySetterElement(_, n)
 }
 
-private AccessorDecl getAnAccessorDecl(Decl d) {
-  result = d.(VarDecl).getAnAccessorDecl() or
-  result = d.(SubscriptDecl).getAnAccessorDecl()
+private Accessor getAnAccessor(Decl d) {
+  result = d.(VarDecl).getAnAccessor() or
+  result = d.(SubscriptDecl).getAnAccessor()
 }
 
-predicate isPropertyGetterElement(AccessorDecl accessor, Expr ref) {
+predicate isPropertyGetterElement(Accessor accessor, Expr ref) {
   hasDirectToImplementationOrOrdinarySemantics(ref) and
   isRValue(ref) and
   accessor.isGetter() and
-  accessor = getAnAccessorDecl([ref.(LookupExpr).getMember(), ref.(DeclRefExpr).getDecl()])
+  accessor = getAnAccessor([ref.(LookupExpr).getMember(), ref.(DeclRefExpr).getDecl()])
 }
 
-predicate isPropertyGetterElement(PropertyGetterElement pge, AccessorDecl accessor, Expr ref) {
+predicate isPropertyGetterElement(PropertyGetterElement pge, Accessor accessor, Expr ref) {
   pge = TPropertyGetterElement(accessor, ref)
 }
 
@@ -60,32 +60,32 @@ private predicate hasDirectToImplementationOrOrdinarySemantics(Expr e) {
   hasDirectToImplementationSemantics(e) or hasOrdinarySemantics(e)
 }
 
-private predicate isPropertySetterElement(AccessorDecl accessor, AssignExpr assign) {
+private predicate isPropertySetterElement(Accessor accessor, AssignExpr assign) {
   exists(Expr lhs | lhs = assign.getDest() |
     hasDirectToImplementationOrOrdinarySemantics(lhs) and
     accessor.isSetter() and
     isLValue(lhs) and
-    accessor = getAnAccessorDecl([lhs.(LookupExpr).getMember(), lhs.(DeclRefExpr).getDecl()])
+    accessor = getAnAccessor([lhs.(LookupExpr).getMember(), lhs.(DeclRefExpr).getDecl()])
   )
 }
 
 predicate isPropertySetterElement(
-  PropertySetterElement pse, AccessorDecl accessor, AssignExpr assign
+  PropertySetterElement pse, Accessor accessor, AssignExpr assign
 ) {
   pse = TPropertySetterElement(accessor, assign)
 }
 
-private predicate isPropertyObserverElement(AccessorDecl observer, AssignExpr assign) {
+private predicate isPropertyObserverElement(Accessor observer, AssignExpr assign) {
   exists(Expr lhs | lhs = assign.getDest() |
     hasDirectToImplementationOrOrdinarySemantics(lhs) and
     observer.isPropertyObserver() and
     isLValue(lhs) and
-    observer = getAnAccessorDecl([lhs.(LookupExpr).getMember(), lhs.(DeclRefExpr).getDecl()])
+    observer = getAnAccessor([lhs.(LookupExpr).getMember(), lhs.(DeclRefExpr).getDecl()])
   )
 }
 
 predicate isPropertyObserverElement(
-  PropertyObserverElement poe, AccessorDecl accessor, AssignExpr assign
+  PropertyObserverElement poe, Accessor accessor, AssignExpr assign
 ) {
   poe = TPropertyObserverElement(accessor, assign)
 }
@@ -111,7 +111,7 @@ class AstElement extends ControlFlowElement, TAstElement {
 }
 
 class PropertyGetterElement extends ControlFlowElement, TPropertyGetterElement {
-  AccessorDecl accessor;
+  Accessor accessor;
   Expr ref;
 
   PropertyGetterElement() { this = TPropertyGetterElement(accessor, ref) }
@@ -122,13 +122,13 @@ class PropertyGetterElement extends ControlFlowElement, TPropertyGetterElement {
 
   Expr getRef() { result = ref }
 
-  AccessorDecl getAccessorDecl() { result = accessor }
+  Accessor getAccessor() { result = accessor }
 
   Expr getBase() { result = ref.(LookupExpr).getBase() }
 }
 
 class PropertySetterElement extends ControlFlowElement, TPropertySetterElement {
-  AccessorDecl accessor;
+  Accessor accessor;
   AssignExpr assign;
 
   PropertySetterElement() { this = TPropertySetterElement(accessor, assign) }
@@ -137,15 +137,15 @@ class PropertySetterElement extends ControlFlowElement, TPropertySetterElement {
 
   override Location getLocation() { result = assign.getLocation() }
 
-  AccessorDecl getAccessorDecl() { result = accessor }
+  Accessor getAccessor() { result = accessor }
 
   AssignExpr getAssignExpr() { result = assign }
 
   Expr getBase() { result = assign.getDest().(LookupExpr).getBase() }
 }
 
 class PropertyObserverElement extends ControlFlowElement, TPropertyObserverElement {
-  AccessorDecl observer;
+  Accessor observer;
   AssignExpr assign;
 
   PropertyObserverElement() { this = TPropertyObserverElement(observer, assign) }
@@ -160,7 +160,7 @@ class PropertyObserverElement extends ControlFlowElement, TPropertyObserverEleme
 
   override Location getLocation() { result = assign.getLocation() }
 
-  AccessorDecl getObserver() { result = observer }
+  Accessor getObserver() { result = observer }
 
   predicate isWillSet() { observer.isWillSet() }
 
@@ -172,15 +172,15 @@ class PropertyObserverElement extends ControlFlowElement, TPropertyObserverEleme
 }
 
 class FuncDeclElement extends ControlFlowElement, TFuncDeclElement {
-  AbstractFunctionDecl func;
+  Function func;
 
   FuncDeclElement() { this = TFuncDeclElement(func) }
 
   override string toString() { result = func.toString() }
 
   override Location getLocation() { result = func.getLocation() }
 
-  AbstractFunctionDecl getAst() { result = func }
+  Function getAst() { result = func }
 }
 
 class KeyPathElement extends ControlFlowElement, TKeyPathElement {
@@ -196,13 +196,13 @@ class KeyPathElement extends ControlFlowElement, TKeyPathElement {
 }
 
 class ClosureElement extends ControlFlowElement, TClosureElement {
-  ClosureExpr expr;
+  ExplicitClosureExpr expr;
 
   ClosureElement() { this = TClosureElement(expr) }
 
   override Location getLocation() { result = expr.getLocation() }
 
-  ClosureExpr getAst() { result = expr }
+  ExplicitClosureExpr getAst() { result = expr }
 
   override string toString() { result = expr.toString() }
 }

swift/ql/lib/codeql/swift/controlflow/internal/ControlFlowGraphImpl.qll

@@ -47,7 +47,7 @@ module CfgScope {
     abstract predicate exit(ControlFlowElement last, Completion c);
   }
 
-  private class BodyStmtCallableScope extends Range_ instanceof AbstractFunctionDecl {
+  private class BodyStmtCallableScope extends Range_ instanceof Function {
     Decls::FuncDeclTree tree;
 
     BodyStmtCallableScope() { tree.getAst() = this }
@@ -67,7 +67,7 @@ module CfgScope {
     final override predicate exit(ControlFlowElement last, Completion c) { last(tree, last, c) }
   }
 
-  private class ClosureExprScope extends Range_ instanceof ClosureExpr {
+  private class ClosureExprScope extends Range_ instanceof ExplicitClosureExpr {
     Exprs::ClosureExprTree tree;
 
     ClosureExprScope() { tree.getAst() = this }
@@ -1002,17 +1002,17 @@ module Decls {
    * }
    * ```
    */
-  private class AbstractFunctionDeclTree extends AstLeafTree {
-    override AbstractFunctionDecl ast;
+  private class FunctionTree extends AstLeafTree {
+    override Function ast;
   }
 
   /** The control-flow of a function declaration body. */
   class FuncDeclTree extends StandardPreOrderTree, TFuncDeclElement {
-    AbstractFunctionDecl ast;
+    Function ast;
 
     FuncDeclTree() { this = TFuncDeclElement(ast) }
 
-    AbstractFunctionDecl getAst() { result = ast }
+    Function getAst() { result = ast }
 
     final override ControlFlowElement getChildElement(int i) {
       i = -1 and
@@ -1107,12 +1107,12 @@ module Exprs {
      * direct-to-implementation-access semantics.
      */
     class PropertyAssignExpr extends AssignExprTree {
-      AccessorDecl accessorDecl;
+      Accessor accessor;
 
-      PropertyAssignExpr() { isPropertySetterElement(_, accessorDecl, ast) }
+      PropertyAssignExpr() { isPropertySetterElement(_, accessor, ast) }
 
       final override predicate isLast(ControlFlowElement last, Completion c) {
-        isPropertySetterElement(last, accessorDecl, ast) and
+        isPropertySetterElement(last, accessor, ast) and
         completionIsValidFor(c, last)
       }
 
@@ -1138,11 +1138,11 @@ module Exprs {
   }
 
   class ClosureExprTree extends StandardPreOrderTree, TClosureElement {
-    ClosureExpr expr;
+    ExplicitClosureExpr expr;
 
     ClosureExprTree() { this = TClosureElement(expr) }
 
-    ClosureExpr getAst() { result = expr }
+    ExplicitClosureExpr getAst() { result = expr }
 
     final override ControlFlowElement getChildElement(int i) {
       result.asAstNode() = expr.getParam(i)
@@ -1175,8 +1175,8 @@ module Exprs {
     class Closure = @auto_closure_expr or @closure_expr;
 
     // TODO: Traverse the expressions in the capture list once we extract it.
-    private class ClosureTree extends AstLeafTree {
-      override ClosureExpr ast;
+    private class ExplicitClosureTree extends AstLeafTree {
+      override ExplicitClosureExpr ast;
     }
 
     /**
@@ -1308,8 +1308,8 @@ module Exprs {
     }
   }
 
-  private class RebindSelfInConstructorTree extends AstStandardPostOrderTree {
-    override RebindSelfInConstructorExpr ast;
+  private class RebindSelfInInitializerTree extends AstStandardPostOrderTree {
+    override RebindSelfInInitializerExpr ast;
 
     final override ControlFlowElement getChildElement(int i) {
       result.asAstNode() = ast.getSubExpr().getFullyConverted() and i = 0
@@ -1342,8 +1342,8 @@ module Exprs {
     }
   }
 
-  private class LazyInitializerTree extends AstStandardPostOrderTree {
-    override LazyInitializerExpr ast;
+  private class LazyInitializationTree extends AstStandardPostOrderTree {
+    override LazyInitializationExpr ast;
 
     final override ControlFlowElement getChildElement(int i) {
       result.asAstNode() = ast.getSubExpr().getFullyConverted() and i = 0
@@ -1426,8 +1426,8 @@ module Exprs {
       DeclRefExprLValueTree() { isLValue(ast) }
     }
 
-    class OtherConstructorDeclRefTree extends AstLeafTree {
-      override OtherConstructorDeclRefExpr ast;
+    class OtherInitializerRefTree extends AstLeafTree {
+      override OtherInitializerRefExpr ast;
     }
 
     abstract class DeclRefExprRValueTree extends AstControlFlowTree {
@@ -1443,7 +1443,7 @@ module Exprs {
     }
 
     private class PropertyDeclRefRValueTree extends DeclRefExprRValueTree {
-      AccessorDecl accessor;
+      Accessor accessor;
 
       PropertyDeclRefRValueTree() { isPropertyGetterElement(_, accessor, ast) }
 
@@ -1550,7 +1550,7 @@ module Exprs {
      * or ordinary semantics that includes a getter.
      */
     private class PropertyMemberRefRValue extends MemberRefRValueTree {
-      AccessorDecl accessor;
+      Accessor accessor;
 
       PropertyMemberRefRValue() { isPropertyGetterElement(_, accessor, ast) }
 

swift/ql/lib/codeql/swift/controlflow/internal/Scope.qll

@@ -3,7 +3,7 @@ private import codeql.swift.generated.ParentChild
 private import codeql.swift.generated.Synth
 
 module CallableBase {
-  class TypeRange = Synth::TAbstractFunctionDecl or Synth::TKeyPathExpr or Synth::TClosureExpr;
+  class TypeRange = Synth::TFunction or Synth::TKeyPathExpr or Synth::TClosureExpr;
 
   class Range extends Scope::Range, TypeRange { }
 }

swift/ql/lib/codeql/swift/dataflow/ExternalFlow.qll

@@ -378,7 +378,7 @@ private predicate elementSpec(
   summaryModel(namespace, type, subtypes, name, signature, ext, _, _, _, _)
 }
 
-private string paramsStringPart(AbstractFunctionDecl c, int i) {
+private string paramsStringPart(Function c, int i) {
   i = -1 and result = "(" and exists(c)
   or
   exists(int n, string p | c.getParam(n).getType().toString() = p |
@@ -397,12 +397,12 @@ private string paramsStringPart(AbstractFunctionDecl c, int i) {
  * Parameter types are represented by their type erasure.
  */
 cached
-string paramsString(AbstractFunctionDecl c) {
+string paramsString(Function c) {
   result = concat(int i | | paramsStringPart(c, i) order by i)
 }
 
 bindingset[func]
-predicate matchesSignature(AbstractFunctionDecl func, string signature) {
+predicate matchesSignature(Function func, string signature) {
   signature = "" or
   paramsString(func) = signature
 }
@@ -425,17 +425,17 @@ private Element interpretElement0(
   namespace = "" and // TODO: Fill out when we properly extract modules.
   (
     // Non-member functions
-    exists(AbstractFunctionDecl func |
+    exists(Function func |
       func.getName() = name and
       type = "" and
       matchesSignature(func, signature) and
       subtypes = false and
-      not result instanceof MethodDecl and
+      not result instanceof Method and
       result = func
     )
     or
     // Member functions
-    exists(NominalTypeDecl namedTypeDecl, Decl declWithMethod, MethodDecl method |
+    exists(NominalTypeDecl namedTypeDecl, Decl declWithMethod, Method method |
       method.getName() = name and
       method = declWithMethod.getAMember() and
       namedTypeDecl.getFullName() = type and