Swift: AST library renamings

Author: d10c

swift/ql/lib/codeql/swift/elements/AstNode.qll

@@ -1,7 +1,7 @@
 private import codeql.swift.generated.AstNode
-private import codeql.swift.elements.decl.AbstractFunctionDecl
+private import codeql.swift.elements.decl.Function
 private import codeql.swift.elements.decl.Decl
-private import codeql.swift.elements.expr.AbstractClosureExpr
+private import codeql.swift.elements.expr.ClosureExpr
 private import codeql.swift.elements.Callable
 private import codeql.swift.generated.ParentChild
 
@@ -15,12 +15,12 @@ private module Cached {
   Decl getEnclosingDecl(AstNode ast) { result = getEnclosingDeclStep*(getImmediateParent(ast)) }
 
   private Element getEnclosingFunctionStep(Element e) {
-    not e instanceof AbstractFunctionDecl and
+    not e instanceof Function and
     result = getEnclosingDecl(e)
   }
 
   cached
-  AbstractFunctionDecl getEnclosingFunction(AstNode ast) {
+  Function getEnclosingFunction(AstNode ast) {
     result = getEnclosingFunctionStep*(getEnclosingDecl(ast))
   }
 
@@ -30,7 +30,7 @@ private module Cached {
   }
 
   cached
-  AbstractClosureExpr getEnclosingClosure(AstNode ast) {
+  ClosureExpr getEnclosingClosure(AstNode ast) {
     result = getEnclosingClosureStep*(getImmediateParent(ast))
   }
 }
@@ -53,7 +53,7 @@ class AstNode extends Generated::AstNode {
    * }
    * ```
    */
-  final AbstractFunctionDecl getEnclosingFunction() { result = Cached::getEnclosingFunction(this) }
+  final Function getEnclosingFunction() { result = Cached::getEnclosingFunction(this) }
 
   /**
    * Gets the nearest declaration that contains this AST node, if any.

swift/ql/lib/codeql/swift/elements/decl/Accessor.qll

@@ -0,0 +1,40 @@
+private import codeql.swift.generated.decl.Accessor
+
+private predicate isKnownAccessorKind(Accessor decl, string kind) {
+  decl.isGetter() and kind = "get"
+  or
+  decl.isSetter() and kind = "set"
+  or
+  decl.isWillSet() and kind = "willSet"
+  or
+  decl.isDidSet() and kind = "didSet"
+  or
+  decl.isRead() and kind = "_read"
+  or
+  decl.isModify() and kind = "_modify"
+  or
+  decl.isUnsafeAddress() and kind = "unsafeAddress"
+  or
+  decl.isUnsafeMutableAddress() and kind = "unsafeMutableAddress"
+}
+
+class Accessor extends Generated::Accessor {
+  predicate isPropertyObserver() {
+    this instanceof WillSetObserver or this instanceof DidSetObserver
+  }
+
+  override string toString() {
+    isKnownAccessorKind(this, result)
+    or
+    not isKnownAccessorKind(this, _) and
+    result = super.toString()
+  }
+}
+
+class WillSetObserver extends Accessor {
+  WillSetObserver() { this.isWillSet() }
+}
+
+class DidSetObserver extends Accessor {
+  DidSetObserver() { this.isDidSet() }
+}

swift/ql/lib/codeql/swift/elements/decl/Deinitializer.qll

@@ -0,0 +1,9 @@
+private import codeql.swift.generated.decl.Deinitializer
+private import codeql.swift.elements.decl.Method
+
+/**
+ * A deinitializer of a class.
+ */
+class Deinitializer extends Generated::Deinitializer, Method {
+  override string toString() { result = this.getSelfParam().getType() + "." + super.toString() }
+}

swift/ql/lib/codeql/swift/elements/decl/Function.qll

@@ -0,0 +1,16 @@
+private import codeql.swift.generated.decl.Function
+private import codeql.swift.elements.decl.Method
+
+/**
+ * A function.
+ */
+class Function extends Generated::Function, Callable {
+  override string toString() { result = this.getName() }
+}
+
+/**
+ * A free (non-member) function.
+ */
+class FreeFunction extends Function {
+  FreeFunction() { not this instanceof Method }
+}

swift/ql/lib/codeql/swift/elements/decl/Initializer.qll

@@ -0,0 +1,17 @@
+private import codeql.swift.generated.decl.Initializer
+private import codeql.swift.elements.decl.Method
+private import codeql.swift.elements.type.FunctionType
+private import codeql.swift.elements.type.OptionalType
+
+/**
+ * An initializer of a class, struct, enum or protocol.
+ */
+class Initializer extends Generated::Initializer, Method {
+  override string toString() { result = this.getSelfParam().getType() + "." + super.toString() }
+
+  /** Holds if this initializer returns an optional type. Failable initializers are written as `init?`. */
+  predicate isFailable() {
+    this.getInterfaceType().(FunctionType).getResult().(FunctionType).getResult() instanceof
+      OptionalType
+  }
+}

swift/ql/lib/codeql/swift/elements/decl/MethodDecl.qll renamed to swift/ql/lib/codeql/swift/elements/decl/Method.qll

@@ -5,15 +5,15 @@ private Decl getAMember(Decl ctx) {
   or
   exists(VarDecl var |
     ctx.getAMember() = var and
-    var.getAnAccessorDecl() = result
+    var.getAnAccessor() = result
   )
 }
 
 /**
  * A function that is a member of a class, struct, enum or protocol.
  */
-class MethodDecl extends AbstractFunctionDecl {
-  MethodDecl() {
+class Method extends Function {
+  Method() {
     this = getAMember(any(ClassDecl c))
     or
     this = getAMember(any(StructDecl c))

swift/ql/lib/codeql/swift/elements/expr/ApplyExpr.qll

@@ -4,7 +4,7 @@ private import codeql.swift.elements.expr.DeclRefExpr
 private import codeql.swift.elements.expr.MethodLookupExpr
 private import codeql.swift.elements.expr.DotSyntaxBaseIgnoredExpr
 private import codeql.swift.elements.expr.AutoClosureExpr
-private import codeql.swift.elements.decl.MethodDecl
+private import codeql.swift.elements.decl.Method
 
 class ApplyExpr extends Generated::ApplyExpr {
   Callable getStaticTarget() { result = this.getFunction().(DeclRefExpr).getDecl() }
@@ -33,7 +33,7 @@ class MethodApplyExpr extends ApplyExpr {
 
   MethodApplyExpr() { method = this.getFunction() }
 
-  override MethodDecl getStaticTarget() { result = method.getMethod() }
+  override Method getStaticTarget() { result = method.getMethod() }
 
   override Expr getQualifier() { result = method.getBase() }
 }

swift/ql/lib/codeql/swift/elements/expr/BinaryExpr.qll

@@ -1,6 +1,6 @@
 private import codeql.swift.generated.expr.BinaryExpr
 private import codeql.swift.elements.expr.Expr
-private import codeql.swift.elements.decl.AbstractFunctionDecl
+private import codeql.swift.elements.decl.Function
 
 /**
  * A Swift binary expression, that is, an expression that appears between its
@@ -23,7 +23,7 @@ class BinaryExpr extends Generated::BinaryExpr {
   /**
    * Gets the operator of this binary expression (the function that is called).
    */
-  AbstractFunctionDecl getOperator() { result = this.getStaticTarget() }
+  Function getOperator() { result = this.getStaticTarget() }
 
   /**
    * Gets an operand of this binary expression (left or right).
@@ -32,5 +32,5 @@ class BinaryExpr extends Generated::BinaryExpr {
 
   override string toString() { result = "... " + this.getFunction().toString() + " ..." }
 
-  override AbstractFunctionDecl getStaticTarget() { result = super.getStaticTarget() }
+  override Function getStaticTarget() { result = super.getStaticTarget() }
 }

swift/ql/lib/codeql/swift/elements/expr/DotSyntaxBaseIgnoredExpr.qll

@@ -2,7 +2,7 @@ private import codeql.swift.generated.expr.DotSyntaxBaseIgnoredExpr
 private import codeql.swift.elements.expr.AutoClosureExpr
 private import codeql.swift.elements.expr.CallExpr
 private import codeql.swift.elements.expr.TypeExpr
-private import codeql.swift.elements.decl.MethodDecl
+private import codeql.swift.elements.decl.Method
 
 /**
  * An expression representing a partially applied lookup of an instance property via the receiver's type object.
@@ -28,7 +28,7 @@ class DotSyntaxBaseIgnoredExpr extends Generated::DotSyntaxBaseIgnoredExpr {
    * Gets the underlying instance method that is called when the result of this
    * expression is fully applied.
    */
-  MethodDecl getMethod() {
+  Method getMethod() {
     result =
       this.getSubExpr()
           .(AutoClosureExpr)

swift/ql/lib/codeql/swift/elements/expr/InitializerCallExpr.qll

@@ -1,9 +1,9 @@
 private import codeql.swift.elements.expr.MethodCallExpr
 private import codeql.swift.elements.expr.InitializerLookupExpr
-private import codeql.swift.elements.decl.ConstructorDecl
+private import codeql.swift.elements.decl.Initializer
 
 class InitializerCallExpr extends MethodCallExpr {
   InitializerCallExpr() { this.getFunction() instanceof InitializerLookupExpr }
 
-  override ConstructorDecl getStaticTarget() { result = super.getStaticTarget() }
+  override Initializer getStaticTarget() { result = super.getStaticTarget() }
 }