Swift: make only Expr, Pattern and Type hideable

Author: redsun82

swift/ql/.generated.list

@@ -98,7 +98,7 @@ private predicate isBooleanConstant(ControlFlowElement n, boolean value) {
   // Boolean constants hidden inside conversions are also
   // constants that resolve to the same value.
   exists(ControlFlowElement parent |
-    parent.asAstNode() = n.asAstNode().getResolveStep() and
+    parent.asAstNode() = n.asAstNode().(HideableElement).getResolveStep() and
     isBooleanConstant(parent, value)
   )
 }
@@ -122,9 +122,9 @@ private predicate inBooleanContext(ControlFlowElement n) {
 private predicate astInBooleanContext(AstNode n) {
   n = any(ConditionElement condElem).getBoolean().getFullyUnresolved()
   or
-  n = any(ConditionElement condElem).getAvailability().getFullyUnresolved()
+  n = any(ConditionElement condElem).getAvailability()
   or
-  n = any(StmtCondition stmtCond).getFullyUnresolved()
+  n = any(StmtCondition stmtCond)
   or
   exists(RepeatWhileStmt repeat | n = repeat.getCondition().getFullyConverted())
   or

swift/ql/.gitattributes

@@ -264,7 +264,7 @@ module Stmts {
       or
       child.asAstNode() = ast.getAnElement().getBoolean().getFullyConverted()
       or
-      child.asAstNode() = ast.getAnElement().getAvailability().getFullyUnresolved()
+      child.asAstNode() = ast.getAnElement().getAvailability()
     }
 
     predicate firstElement(int i, ControlFlowElement first) {
@@ -278,7 +278,7 @@ module Stmts {
         astFirst(ast.getElement(i).getBoolean().getFullyConverted(), first)
         or
         // ... or an availability check.
-        astFirst(ast.getElement(i).getAvailability().getFullyUnresolved(), first)
+        astFirst(ast.getElement(i).getAvailability(), first)
       )
     }
 
@@ -296,7 +296,7 @@ module Stmts {
         astLast(ast.getElement(i).getBoolean().getFullyConverted(), pred, c)
         or
         // ... or the availability check ...
-        astLast(ast.getElement(i).getAvailability().getFullyUnresolved(), pred, c)
+        astLast(ast.getElement(i).getAvailability(), pred, c)
       ) and
       // We evaluate the next element
       c instanceof NormalCompletion and
@@ -313,7 +313,7 @@ module Stmts {
       not c.(MatchingCompletion).isMatch()
       or
       // Stop if an availability check failed
-      astLast(ast.getAnElement().getAvailability().getFullyUnresolved(), last, c) and
+      astLast(ast.getAnElement().getAvailability(), last, c) and
       c instanceof FalseCompletion
       or
       // Stop if we successfully evaluated all the conditionals
@@ -322,7 +322,7 @@ module Stmts {
         or
         astLast(ast.getLastElement().getPattern().getFullyUnresolved(), last, c)
         or
-        astLast(ast.getLastElement().getAvailability().getFullyUnresolved(), last, c)
+        astLast(ast.getLastElement().getAvailability(), last, c)
       ) and
       c instanceof NormalCompletion
     }
@@ -342,14 +342,14 @@ module Stmts {
     override IfStmt ast;
 
     final override predicate propagatesAbnormal(ControlFlowElement child) {
-      child.asAstNode() = ast.getCondition().getFullyUnresolved() or
+      child.asAstNode() = ast.getCondition() or
       child.asAstNode() = ast.getThen() or
       child.asAstNode() = ast.getElse()
     }
 
     final override predicate last(ControlFlowElement last, Completion c) {
       // Condition exits with a false completion and there is no `else` branch
-      astLast(ast.getCondition().getFullyUnresolved(), last, c) and
+      astLast(ast.getCondition(), last, c) and
       c instanceof FalseOrNonMatchCompletion and
       not exists(ast.getElse())
       or
@@ -360,10 +360,10 @@ module Stmts {
     final override predicate succ(ControlFlowElement pred, ControlFlowElement succ, Completion c) {
       // Pre-order: flow from statement itself to first element of condition
       pred.asAstNode() = ast and
-      astFirst(ast.getCondition().getFullyUnresolved(), succ) and
+      astFirst(ast.getCondition(), succ) and
       c instanceof SimpleCompletion
       or
-      astLast(ast.getCondition().getFullyUnresolved(), pred, c) and
+      astLast(ast.getCondition(), pred, c) and
       (
         // Flow from last element of condition to first element of then branch
         c instanceof TrueOrMatchCompletion and
@@ -380,7 +380,7 @@ module Stmts {
     override GuardStmt ast;
 
     final override predicate propagatesAbnormal(ControlFlowElement child) {
-      child.asAstNode() = ast.getCondition().getFullyUnresolved() or
+      child.asAstNode() = ast.getCondition() or
       child.asAstNode() = ast.getBody()
     }
 
@@ -390,18 +390,18 @@ module Stmts {
       c instanceof NormalCompletion
       or
       // Exit when a condition is true
-      astLast(ast.getCondition().getFullyUnresolved(), last, c) and
+      astLast(ast.getCondition(), last, c) and
       c instanceof TrueOrMatchCompletion
     }
 
     final override predicate succ(ControlFlowElement pred, ControlFlowElement succ, Completion c) {
       // Pre-order: flow from statement itself to first element of condition
       pred.asAstNode() = ast and
-      astFirst(ast.getCondition().getFullyUnresolved(), succ) and
+      astFirst(ast.getCondition(), succ) and
       c instanceof SimpleCompletion
       or
       // Flow to the body when the condition is false
-      astLast(ast.getCondition().getFullyUnresolved(), pred, c) and
+      astLast(ast.getCondition(), pred, c) and
       c instanceof FalseOrNonMatchCompletion and
       astFirst(ast.getBody(), succ)
     }
@@ -458,9 +458,7 @@ module Stmts {
     private class WhileTree extends LoopTree {
       override WhileStmt ast;
 
-      final override ControlFlowElement getCondition() {
-        result.asAstNode() = ast.getCondition().getFullyUnresolved()
-      }
+      final override ControlFlowElement getCondition() { result.asAstNode() = ast.getCondition() }
 
       final override ControlFlowElement getBody() { result.asAstNode() = ast.getBody() }
 
@@ -674,7 +672,7 @@ module Stmts {
 
     final override predicate last(ControlFlowElement last, Completion c) {
       // Case pattern exits with a non-match
-      astLast(ast.getLastLabel().getFullyUnresolved(), last, c) and
+      astLast(ast.getLastLabel(), last, c) and
       not c.(MatchingCompletion).isMatch()
       or
       // Case body exits with any completion
@@ -684,18 +682,18 @@ module Stmts {
     override predicate succ(ControlFlowElement pred, ControlFlowElement succ, Completion c) {
       // Pre-order: Flow from the case statement itself to the first label
       pred.asAstNode() = ast and
-      astFirst(ast.getFirstLabel().getFullyUnresolved(), succ) and
+      astFirst(ast.getFirstLabel(), succ) and
       c instanceof SimpleCompletion
       or
       // Left-to-right evaluation of labels until we find a match
       exists(int i |
-        astLast(ast.getLabel(i).getFullyUnresolved(), pred, c) and
-        astFirst(ast.getLabel(i + 1).getFullyUnresolved(), succ) and
+        astLast(ast.getLabel(i), pred, c) and
+        astFirst(ast.getLabel(i + 1), succ) and
         c.(MatchingCompletion).isNonMatch()
       )
       or
       // Flow from last element of pattern to first element of body
-      astLast(ast.getALabel().getFullyUnresolved(), pred, c) and
+      astLast(ast.getALabel(), pred, c) and
       astFirst(ast.getBody(), succ) and
       c.(MatchingCompletion).isMatch()
     }
@@ -1164,7 +1162,7 @@ module Exprs {
     override CaptureListExpr ast;
 
     final override ControlFlowElement getChildElement(int i) {
-      result.asAstNode() = ast.getBindingDecl(i).getFullyUnresolved()
+      result.asAstNode() = ast.getBindingDecl(i)
       or
       i = ast.getNumberOfBindingDecls() and
       result.asAstNode() = ast.getClosureBody().getFullyConverted()
@@ -1796,9 +1794,7 @@ module AvailabilityInfo {
   private class AvailabilityInfoTree extends AstStandardPostOrderTree {
     override AvailabilityInfo ast;
 
-    final override ControlFlowElement getChildElement(int i) {
-      result.asAstNode() = ast.getSpec(i).getFullyUnresolved()
-    }
+    final override ControlFlowElement getChildElement(int i) { result.asAstNode() = ast.getSpec(i) }
   }
 
   private class AvailabilitySpecTree extends AstLeafTree {

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

@@ -1,18 +1,7 @@
 private import codeql.swift.generated.Element
 
 class Element extends Generated::Element {
-  private predicate resolvesFrom(Element e) { e.getResolveStep() = this }
-
   override string toString() { result = this.getPrimaryQlClasses() }
-
-  Element getFullyUnresolved() {
-    not this.resolvesFrom(_) and result = this
-    or
-    exists(Element e |
-      this.resolvesFrom(e) and
-      result = e.getFullyUnresolved()
-    )
-  }
 }
 
 class UnknownElement extends Element {

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

@@ -0,0 +1,14 @@
+private import codeql.swift.generated.HideableElement
+
+class HideableElement extends Generated::HideableElement {
+  private predicate resolvesFrom(HideableElement e) { e.getResolveStep() = this }
+
+  HideableElement getFullyUnresolved() {
+    not this.resolvesFrom(_) and result = this
+    or
+    exists(HideableElement e |
+      this.resolvesFrom(e) and
+      result = e.getFullyUnresolved()
+    )
+  }
+}

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

@@ -4,10 +4,10 @@ private import codeql.swift.elements.UnknownLocation
 
 class Locatable extends Generated::Locatable {
   pragma[nomagic]
-  override Location getImmediateLocation() {
-    result = Generated::Locatable.super.getImmediateLocation()
+  override Location getLocation() {
+    result = Generated::Locatable.super.getLocation()
     or
-    not exists(Generated::Locatable.super.getImmediateLocation()) and
+    not exists(Generated::Locatable.super.getLocation()) and
     result instanceof UnknownLocation
   }
 

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

@@ -6,7 +6,7 @@ private import codeql.swift.elements.File
  * A `Location` that is given to something that is not associated with any position in the source code.
  */
 class UnknownLocation extends Generated::UnknownLocation {
-  override File getImmediateFile() { result instanceof UnknownFile }
+  override File getFile() { result instanceof UnknownFile }
 
   override int getStartLine() { result = 0 }
 

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

@@ -19,5 +19,5 @@ class UnspecifiedElement extends Generated::UnspecifiedElement {
     )
   }
 
-  override Location getImmediateLocation() { result = this.getParent().(Locatable).getLocation() }
+  override Location getLocation() { result = this.getParent().(Locatable).getLocation() }
 }