Merge pull request github#11196 from github/redsun82/swift-error-element

Swift: create common `ErrorElement` superclass and tests

Author: AlexDenisov

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

@@ -6,12 +6,12 @@ import codeql.swift.elements.DbFile
 import codeql.swift.elements.DbLocation
 import codeql.swift.elements.Diagnostics
 import codeql.swift.elements.Element
+import codeql.swift.elements.ErrorElement
 import codeql.swift.elements.File
 import codeql.swift.elements.Locatable
 import codeql.swift.elements.Location
 import codeql.swift.elements.UnknownFile
 import codeql.swift.elements.UnknownLocation
-import codeql.swift.elements.UnresolvedElement
 import codeql.swift.elements.UnspecifiedElement
 import codeql.swift.elements.decl.AbstractFunctionDecl
 import codeql.swift.elements.decl.AbstractStorageDecl

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

@@ -0,0 +1,4 @@
+// generated by codegen/codegen.py, remove this comment if you wish to edit this file
+private import codeql.swift.generated.ErrorElement
+
+class ErrorElement extends Generated::ErrorElement { }

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

@@ -1,5 +1,6 @@
 private import codeql.swift.generated.UnspecifiedElement
 import codeql.swift.elements.Location
+import codeql.swift.elements.Locatable
 
 class UnspecifiedElement extends Generated::UnspecifiedElement {
   override string toString() {

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

@@ -4,5 +4,8 @@ private import codeql.swift.generated.Raw
 import codeql.swift.elements.Locatable
 
 module Generated {
-  class UnresolvedElement extends Synth::TUnresolvedElement, Locatable { }
+  /**
+   * The superclass of all elements indicating some kind of error.
+   */
+  class ErrorElement extends Synth::TErrorElement, Locatable { }
 }

swift/ql/lib/codeql/swift/generated/UnresolvedElement.qll renamed to swift/ql/lib/codeql/swift/generated/ErrorElement.qll

@@ -135,6 +135,21 @@ private module Impl {
     )
   }
 
+  private Element getImmediateChildOfErrorElement(
+    ErrorElement e, int index, string partialPredicateCall
+  ) {
+    exists(int b, int bLocatable, int n |
+      b = 0 and
+      bLocatable = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfLocatable(e, i, _)) | i) and
+      n = bLocatable and
+      (
+        none()
+        or
+        result = getImmediateChildOfLocatable(e, index - b, partialPredicateCall)
+      )
+    )
+  }
+
   private Element getImmediateChildOfUnknownFile(
     UnknownFile e, int index, string partialPredicateCall
   ) {
@@ -165,32 +180,18 @@ private module Impl {
     )
   }
 
-  private Element getImmediateChildOfUnresolvedElement(
-    UnresolvedElement e, int index, string partialPredicateCall
-  ) {
-    exists(int b, int bLocatable, int n |
-      b = 0 and
-      bLocatable = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfLocatable(e, i, _)) | i) and
-      n = bLocatable and
-      (
-        none()
-        or
-        result = getImmediateChildOfLocatable(e, index - b, partialPredicateCall)
-      )
-    )
-  }
-
   private Element getImmediateChildOfUnspecifiedElement(
     UnspecifiedElement e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bLocatable, int n |
+    exists(int b, int bErrorElement, int n |
       b = 0 and
-      bLocatable = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfLocatable(e, i, _)) | i) and
-      n = bLocatable and
+      bErrorElement =
+        b + 1 + max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       (
         none()
         or
-        result = getImmediateChildOfLocatable(e, index - b, partialPredicateCall)
+        result = getImmediateChildOfErrorElement(e, index - b, partialPredicateCall)
       )
     )
   }
@@ -1215,14 +1216,18 @@ private module Impl {
   }
 
   private Element getImmediateChildOfErrorExpr(ErrorExpr e, int index, string partialPredicateCall) {
-    exists(int b, int bExpr, int n |
+    exists(int b, int bExpr, int bErrorElement, int n |
       b = 0 and
       bExpr = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfExpr(e, i, _)) | i) and
-      n = bExpr and
+      bErrorElement =
+        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       (
         none()
         or
         result = getImmediateChildOfExpr(e, index - b, partialPredicateCall)
+        or
+        result = getImmediateChildOfErrorElement(e, index - bExpr, partialPredicateCall)
       )
     )
   }
@@ -1592,14 +1597,18 @@ private module Impl {
   private Element getImmediateChildOfOverloadedDeclRefExpr(
     OverloadedDeclRefExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bExpr, int n |
+    exists(int b, int bExpr, int bErrorElement, int n |
       b = 0 and
       bExpr = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfExpr(e, i, _)) | i) and
-      n = bExpr and
+      bErrorElement =
+        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       (
         none()
         or
         result = getImmediateChildOfExpr(e, index - b, partialPredicateCall)
+        or
+        result = getImmediateChildOfErrorElement(e, index - bExpr, partialPredicateCall)
       )
     )
   }
@@ -1744,38 +1753,38 @@ private module Impl {
   private Element getImmediateChildOfUnresolvedDeclRefExpr(
     UnresolvedDeclRefExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bExpr, int bUnresolvedElement, int n |
+    exists(int b, int bExpr, int bErrorElement, int n |
       b = 0 and
       bExpr = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfExpr(e, i, _)) | i) and
-      bUnresolvedElement =
-        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfUnresolvedElement(e, i, _)) | i) and
-      n = bUnresolvedElement and
+      bErrorElement =
+        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       (
         none()
         or
         result = getImmediateChildOfExpr(e, index - b, partialPredicateCall)
         or
-        result = getImmediateChildOfUnresolvedElement(e, index - bExpr, partialPredicateCall)
+        result = getImmediateChildOfErrorElement(e, index - bExpr, partialPredicateCall)
       )
     )
   }
 
   private Element getImmediateChildOfUnresolvedDotExpr(
     UnresolvedDotExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bExpr, int bUnresolvedElement, int n, int nBase |
+    exists(int b, int bExpr, int bErrorElement, int n, int nBase |
       b = 0 and
       bExpr = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfExpr(e, i, _)) | i) and
-      bUnresolvedElement =
-        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfUnresolvedElement(e, i, _)) | i) and
-      n = bUnresolvedElement and
+      bErrorElement =
+        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       nBase = n + 1 and
       (
         none()
         or
         result = getImmediateChildOfExpr(e, index - b, partialPredicateCall)
         or
-        result = getImmediateChildOfUnresolvedElement(e, index - bExpr, partialPredicateCall)
+        result = getImmediateChildOfErrorElement(e, index - bExpr, partialPredicateCall)
         or
         index = n and result = e.getImmediateBase() and partialPredicateCall = "Base()"
       )
@@ -1785,38 +1794,38 @@ private module Impl {
   private Element getImmediateChildOfUnresolvedMemberExpr(
     UnresolvedMemberExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bExpr, int bUnresolvedElement, int n |
+    exists(int b, int bExpr, int bErrorElement, int n |
       b = 0 and
       bExpr = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfExpr(e, i, _)) | i) and
-      bUnresolvedElement =
-        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfUnresolvedElement(e, i, _)) | i) and
-      n = bUnresolvedElement and
+      bErrorElement =
+        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       (
         none()
         or
         result = getImmediateChildOfExpr(e, index - b, partialPredicateCall)
         or
-        result = getImmediateChildOfUnresolvedElement(e, index - bExpr, partialPredicateCall)
+        result = getImmediateChildOfErrorElement(e, index - bExpr, partialPredicateCall)
       )
     )
   }
 
   private Element getImmediateChildOfUnresolvedPatternExpr(
     UnresolvedPatternExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bExpr, int bUnresolvedElement, int n, int nSubPattern |
+    exists(int b, int bExpr, int bErrorElement, int n, int nSubPattern |
       b = 0 and
       bExpr = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfExpr(e, i, _)) | i) and
-      bUnresolvedElement =
-        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfUnresolvedElement(e, i, _)) | i) and
-      n = bUnresolvedElement and
+      bErrorElement =
+        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       nSubPattern = n + 1 and
       (
         none()
         or
         result = getImmediateChildOfExpr(e, index - b, partialPredicateCall)
         or
-        result = getImmediateChildOfUnresolvedElement(e, index - bExpr, partialPredicateCall)
+        result = getImmediateChildOfErrorElement(e, index - bExpr, partialPredicateCall)
         or
         index = n and result = e.getImmediateSubPattern() and partialPredicateCall = "SubPattern()"
       )
@@ -1826,19 +1835,19 @@ private module Impl {
   private Element getImmediateChildOfUnresolvedSpecializeExpr(
     UnresolvedSpecializeExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bExpr, int bUnresolvedElement, int n, int nSubExpr |
+    exists(int b, int bExpr, int bErrorElement, int n, int nSubExpr |
       b = 0 and
       bExpr = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfExpr(e, i, _)) | i) and
-      bUnresolvedElement =
-        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfUnresolvedElement(e, i, _)) | i) and
-      n = bUnresolvedElement and
+      bErrorElement =
+        bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       nSubExpr = n + 1 and
       (
         none()
         or
         result = getImmediateChildOfExpr(e, index - b, partialPredicateCall)
         or
-        result = getImmediateChildOfUnresolvedElement(e, index - bExpr, partialPredicateCall)
+        result = getImmediateChildOfErrorElement(e, index - bExpr, partialPredicateCall)
         or
         index = n and result = e.getImmediateSubExpr() and partialPredicateCall = "SubExpr()"
       )
@@ -2805,45 +2814,43 @@ private module Impl {
   private Element getImmediateChildOfUnresolvedMemberChainResultExpr(
     UnresolvedMemberChainResultExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bIdentityExpr, int bUnresolvedElement, int n |
+    exists(int b, int bIdentityExpr, int bErrorElement, int n |
       b = 0 and
       bIdentityExpr =
         b + 1 + max(int i | i = -1 or exists(getImmediateChildOfIdentityExpr(e, i, _)) | i) and
-      bUnresolvedElement =
+      bErrorElement =
         bIdentityExpr + 1 +
-          max(int i | i = -1 or exists(getImmediateChildOfUnresolvedElement(e, i, _)) | i) and
-      n = bUnresolvedElement and
+          max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       (
         none()
         or
         result = getImmediateChildOfIdentityExpr(e, index - b, partialPredicateCall)
         or
-        result =
-          getImmediateChildOfUnresolvedElement(e, index - bIdentityExpr, partialPredicateCall)
+        result = getImmediateChildOfErrorElement(e, index - bIdentityExpr, partialPredicateCall)
       )
     )
   }
 
   private Element getImmediateChildOfUnresolvedTypeConversionExpr(
     UnresolvedTypeConversionExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bImplicitConversionExpr, int bUnresolvedElement, int n |
+    exists(int b, int bImplicitConversionExpr, int bErrorElement, int n |
       b = 0 and
       bImplicitConversionExpr =
         b + 1 +
           max(int i | i = -1 or exists(getImmediateChildOfImplicitConversionExpr(e, i, _)) | i) and
-      bUnresolvedElement =
+      bErrorElement =
         bImplicitConversionExpr + 1 +
-          max(int i | i = -1 or exists(getImmediateChildOfUnresolvedElement(e, i, _)) | i) and
-      n = bUnresolvedElement and
+          max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       (
         none()
         or
         result = getImmediateChildOfImplicitConversionExpr(e, index - b, partialPredicateCall)
         or
         result =
-          getImmediateChildOfUnresolvedElement(e, index - bImplicitConversionExpr,
-            partialPredicateCall)
+          getImmediateChildOfErrorElement(e, index - bImplicitConversionExpr, partialPredicateCall)
       )
     )
   }
@@ -3838,14 +3845,18 @@ private module Impl {
   }
 
   private Element getImmediateChildOfErrorType(ErrorType e, int index, string partialPredicateCall) {
-    exists(int b, int bType, int n |
+    exists(int b, int bType, int bErrorElement, int n |
       b = 0 and
       bType = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfType(e, i, _)) | i) and
-      n = bType and
+      bErrorElement =
+        bType + 1 + max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       (
         none()
         or
         result = getImmediateChildOfType(e, index - b, partialPredicateCall)
+        or
+        result = getImmediateChildOfErrorElement(e, index - bType, partialPredicateCall)
       )
     )
   }
@@ -3993,18 +4004,18 @@ private module Impl {
   private Element getImmediateChildOfUnresolvedType(
     UnresolvedType e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bType, int bUnresolvedElement, int n |
+    exists(int b, int bType, int bErrorElement, int n |
       b = 0 and
       bType = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfType(e, i, _)) | i) and
-      bUnresolvedElement =
-        bType + 1 + max(int i | i = -1 or exists(getImmediateChildOfUnresolvedElement(e, i, _)) | i) and
-      n = bUnresolvedElement and
+      bErrorElement =
+        bType + 1 + max(int i | i = -1 or exists(getImmediateChildOfErrorElement(e, i, _)) | i) and
+      n = bErrorElement and
       (
         none()
         or
         result = getImmediateChildOfType(e, index - b, partialPredicateCall)
         or
-        result = getImmediateChildOfUnresolvedElement(e, index - bType, partialPredicateCall)
+        result = getImmediateChildOfErrorElement(e, index - bType, partialPredicateCall)
       )
     )
   }