Merge pull request #11190 from github/redsun82/swift-exprs

Swift: extract some more `Expr`

Author: redsun82

swift/extractor/infra/SwiftTagTraits.h

@@ -16,6 +16,9 @@ using SILBoxTypeTag = SilBoxTypeTag;
 using SILFunctionTypeTag = SilFunctionTypeTag;
 using SILTokenTypeTag = SilTokenTypeTag;
 
+// OverloadSetRefExpr is collapsed with its only derived class OverloadedDeclRefExpr
+using OverloadSetRefExprTag = OverloadedDeclRefExprTag;
+
 #define MAP_TYPE_TO_TAG(TYPE, TAG)    \
   template <>                         \
   struct detail::ToTagFunctor<TYPE> { \

swift/extractor/translators/ExprTranslator.cpp

@@ -526,4 +526,72 @@ codeql::UnresolvedPatternExpr ExprTranslator::translateUnresolvedPatternExpr(
   return entry;
 }
 
+codeql::ObjectLiteralExpr ExprTranslator::translateObjectLiteralExpr(
+    const swift::ObjectLiteralExpr& expr) {
+  auto entry = createExprEntry(expr);
+  entry.kind = static_cast<int>(expr.getLiteralKind());
+  if (auto args = expr.getArgs()) {
+    for (const auto& arg : *args) {
+      entry.arguments.push_back(emitArgument(arg));
+    }
+  }
+  return entry;
+}
+codeql::OverloadedDeclRefExpr ExprTranslator::translateOverloadedDeclRefExpr(
+    const swift::OverloadedDeclRefExpr& expr) {
+  auto entry = createExprEntry(expr);
+  entry.possible_declarations = dispatcher.fetchRepeatedLabels(expr.getDecls());
+  return entry;
+}
+
+codeql::DynamicMemberRefExpr ExprTranslator::translateDynamicMemberRefExpr(
+    const swift::DynamicMemberRefExpr& expr) {
+  auto entry = createExprEntry(expr);
+  fillLookupExpr(expr, entry);
+  return entry;
+}
+
+codeql::DynamicSubscriptExpr ExprTranslator::translateDynamicSubscriptExpr(
+    const swift::DynamicSubscriptExpr& expr) {
+  auto entry = createExprEntry(expr);
+  fillLookupExpr(expr, entry);
+  return entry;
+}
+codeql::UnresolvedSpecializeExpr ExprTranslator::translateUnresolvedSpecializeExpr(
+    const swift::UnresolvedSpecializeExpr& expr) {
+  auto entry = createExprEntry(expr);
+  entry.sub_expr = dispatcher.fetchLabel(expr.getSubExpr());
+  return entry;
+}
+
+codeql::PropertyWrapperValuePlaceholderExpr
+ExprTranslator::translatePropertyWrapperValuePlaceholderExpr(
+    const swift::PropertyWrapperValuePlaceholderExpr& expr) {
+  auto entry = createExprEntry(expr);
+  entry.wrapped_value = dispatcher.fetchOptionalLabel(expr.getOriginalWrappedValue());
+  entry.placeholder = dispatcher.fetchLabel(expr.getOpaqueValuePlaceholder());
+  return entry;
+}
+
+static int translatePropertyWrapperValueKind(swift::AppliedPropertyWrapperExpr::ValueKind kind) {
+  using K = swift::AppliedPropertyWrapperExpr::ValueKind;
+  switch (kind) {
+    case K::WrappedValue:
+      return 1;
+    case K::ProjectedValue:
+      return 2;
+    default:
+      return 0;
+  }
+}
+codeql::AppliedPropertyWrapperExpr ExprTranslator::translateAppliedPropertyWrapperExpr(
+    const swift::AppliedPropertyWrapperExpr& expr) {
+  auto entry = createExprEntry(expr);
+  entry.kind = translatePropertyWrapperValueKind(expr.getValueKind());
+  entry.value =
+      dispatcher.fetchLabel(const_cast<swift::AppliedPropertyWrapperExpr&>(expr).getValue());
+  entry.param = dispatcher.fetchLabel(expr.getParamDecl());
+  return entry;
+}
+
 }  // namespace codeql

swift/extractor/translators/ExprTranslator.h

@@ -102,6 +102,19 @@ class ExprTranslator : public AstTranslatorBase<ExprTranslator> {
   codeql::ErrorExpr translateErrorExpr(const swift::ErrorExpr& expr);
   codeql::UnresolvedPatternExpr translateUnresolvedPatternExpr(
       const swift::UnresolvedPatternExpr& expr);
+  codeql::ObjectLiteralExpr translateObjectLiteralExpr(const swift::ObjectLiteralExpr& expr);
+  codeql::OverloadedDeclRefExpr translateOverloadedDeclRefExpr(
+      const swift::OverloadedDeclRefExpr& expr);
+  codeql::DynamicMemberRefExpr translateDynamicMemberRefExpr(
+      const swift::DynamicMemberRefExpr& expr);
+  codeql::DynamicSubscriptExpr translateDynamicSubscriptExpr(
+      const swift::DynamicSubscriptExpr& expr);
+  codeql::UnresolvedSpecializeExpr translateUnresolvedSpecializeExpr(
+      const swift::UnresolvedSpecializeExpr& expr);
+  codeql::PropertyWrapperValuePlaceholderExpr translatePropertyWrapperValuePlaceholderExpr(
+      const swift::PropertyWrapperValuePlaceholderExpr& expr);
+  codeql::AppliedPropertyWrapperExpr translateAppliedPropertyWrapperExpr(
+      const swift::AppliedPropertyWrapperExpr& expr);
 
  private:
   void fillAbstractClosureExpr(const swift::AbstractClosureExpr& expr,

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

@@ -150,7 +150,6 @@ import codeql.swift.elements.expr.OpenExistentialExpr
 import codeql.swift.elements.expr.OptionalEvaluationExpr
 import codeql.swift.elements.expr.OptionalTryExpr
 import codeql.swift.elements.expr.OtherConstructorDeclRefExpr
-import codeql.swift.elements.expr.OverloadSetRefExpr
 import codeql.swift.elements.expr.OverloadedDeclRefExpr
 import codeql.swift.elements.expr.PackExpr
 import codeql.swift.elements.expr.ParenExpr

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

@@ -1,7 +1,21 @@
 private import codeql.swift.generated.expr.ObjectLiteralExpr
 
-class ObjectLiteralExpr extends Generated::ObjectLiteralExpr {
-  override string toString() {
-    result = "#...(...)" // TOOD: We can improve this once we extract the kind
-  }
+class ObjectLiteralExpr extends Generated::ObjectLiteralExpr { }
+
+class FileLiteralExpr extends ObjectLiteralExpr {
+  FileLiteralExpr() { this.getKind() = 0 }
+
+  override string toString() { result = "#fileLiteral(...)" }
+}
+
+class ImageLiteralExpr extends ObjectLiteralExpr {
+  ImageLiteralExpr() { this.getKind() = 1 }
+
+  override string toString() { result = "#imageLiteral(...)" }
+}
+
+class ColorLiteralExpr extends ObjectLiteralExpr {
+  ColorLiteralExpr() { this.getKind() = 2 }
+
+  override string toString() { result = "#colorLiteral(...)" }
 }

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

@@ -68,21 +68,6 @@ private module Impl {
     )
   }
 
-  private Element getImmediateChildOfUnresolvedElement(
-    UnresolvedElement e, int index, string partialPredicateCall
-  ) {
-    exists(int b, int bElement, int n |
-      b = 0 and
-      bElement = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfElement(e, i, _)) | i) and
-      n = bElement and
-      (
-        none()
-        or
-        result = getImmediateChildOfElement(e, index - b, partialPredicateCall)
-      )
-    )
-  }
-
   private Element getImmediateChildOfAstNode(AstNode e, int index, string partialPredicateCall) {
     exists(int b, int bLocatable, int n |
       b = 0 and
@@ -180,6 +165,21 @@ 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
   ) {
@@ -962,14 +962,17 @@ private module Impl {
   private Element getImmediateChildOfAppliedPropertyWrapperExpr(
     AppliedPropertyWrapperExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bExpr, int n |
+    exists(int b, int bExpr, int n, int nValue |
       b = 0 and
       bExpr = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfExpr(e, i, _)) | i) and
       n = bExpr and
+      nValue = n + 1 and
       (
         none()
         or
         result = getImmediateChildOfExpr(e, index - b, partialPredicateCall)
+        or
+        index = n and result = e.getImmediateValue() and partialPredicateCall = "Value()"
       )
     )
   }
@@ -1592,8 +1595,8 @@ private module Impl {
     )
   }
 
-  private Element getImmediateChildOfOverloadSetRefExpr(
-    OverloadSetRefExpr e, int index, string partialPredicateCall
+  private Element getImmediateChildOfOverloadedDeclRefExpr(
+    OverloadedDeclRefExpr e, int index, string partialPredicateCall
   ) {
     exists(int b, int bExpr, int n |
       b = 0 and
@@ -1842,18 +1845,21 @@ private module Impl {
   private Element getImmediateChildOfUnresolvedSpecializeExpr(
     UnresolvedSpecializeExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bExpr, int bUnresolvedElement, int n |
+    exists(int b, int bExpr, int bUnresolvedElement, 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
+      nSubExpr = n + 1 and
       (
         none()
         or
         result = getImmediateChildOfExpr(e, index - b, partialPredicateCall)
         or
         result = getImmediateChildOfUnresolvedElement(e, index - bExpr, partialPredicateCall)
+        or
+        index = n and result = e.getImmediateSubExpr() and partialPredicateCall = "SubExpr()"
       )
     )
   }
@@ -2588,15 +2594,19 @@ private module Impl {
   private Element getImmediateChildOfObjectLiteralExpr(
     ObjectLiteralExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bLiteralExpr, int n |
+    exists(int b, int bLiteralExpr, int n, int nArgument |
       b = 0 and
       bLiteralExpr =
         b + 1 + max(int i | i = -1 or exists(getImmediateChildOfLiteralExpr(e, i, _)) | i) and
       n = bLiteralExpr and
+      nArgument = n + 1 + max(int i | i = -1 or exists(e.getImmediateArgument(i)) | i) and
       (
         none()
         or
         result = getImmediateChildOfLiteralExpr(e, index - b, partialPredicateCall)
+        or
+        result = e.getImmediateArgument(index - n) and
+        partialPredicateCall = "Argument(" + (index - n).toString() + ")"
       )
     )
   }
@@ -2617,22 +2627,6 @@ private module Impl {
     )
   }
 
-  private Element getImmediateChildOfOverloadedDeclRefExpr(
-    OverloadedDeclRefExpr e, int index, string partialPredicateCall
-  ) {
-    exists(int b, int bOverloadSetRefExpr, int n |
-      b = 0 and
-      bOverloadSetRefExpr =
-        b + 1 + max(int i | i = -1 or exists(getImmediateChildOfOverloadSetRefExpr(e, i, _)) | i) and
-      n = bOverloadSetRefExpr and
-      (
-        none()
-        or
-        result = getImmediateChildOfOverloadSetRefExpr(e, index - b, partialPredicateCall)
-      )
-    )
-  }
-
   private Element getImmediateChildOfParenExpr(ParenExpr e, int index, string partialPredicateCall) {
     exists(int b, int bIdentityExpr, int n |
       b = 0 and
@@ -5024,6 +5018,8 @@ private module Impl {
     or
     result = getImmediateChildOfOtherConstructorDeclRefExpr(e, index, partialAccessor)
     or
+    result = getImmediateChildOfOverloadedDeclRefExpr(e, index, partialAccessor)
+    or
     result = getImmediateChildOfPackExpr(e, index, partialAccessor)
     or
     result = getImmediateChildOfPropertyWrapperValuePlaceholderExpr(e, index, partialAccessor)
@@ -5136,8 +5132,6 @@ private module Impl {
     or
     result = getImmediateChildOfOptionalTryExpr(e, index, partialAccessor)
     or
-    result = getImmediateChildOfOverloadedDeclRefExpr(e, index, partialAccessor)
-    or
     result = getImmediateChildOfParenExpr(e, index, partialAccessor)
     or
     result = getImmediateChildOfPointerToPointerExpr(e, index, partialAccessor)

swift/ql/lib/codeql/swift/generated/ParentChild.qll

@@ -33,8 +33,6 @@ module Raw {
     int getEndColumn() { locations(this, _, _, _, _, result) }
   }
 
-  class UnresolvedElement extends @unresolved_element, Element { }
-
   class AstNode extends @ast_node, Locatable { }
 
   class Comment extends @comment, Locatable {
@@ -59,6 +57,8 @@ module Raw {
     int getKind() { diagnostics(this, _, result) }
   }
 
+  class UnresolvedElement extends @unresolved_element, Locatable { }
+
   class UnspecifiedElement extends @unspecified_element, Locatable {
     override string toString() { result = "UnspecifiedElement" }
 
@@ -327,6 +327,12 @@ module Raw {
 
   class AppliedPropertyWrapperExpr extends @applied_property_wrapper_expr, Expr {
     override string toString() { result = "AppliedPropertyWrapperExpr" }
+
+    int getKind() { applied_property_wrapper_exprs(this, result, _, _) }
+
+    Expr getValue() { applied_property_wrapper_exprs(this, _, result, _) }
+
+    ParamDecl getParam() { applied_property_wrapper_exprs(this, _, _, result) }
   }
 
   class ApplyExpr extends @apply_expr, Expr {
@@ -547,14 +553,24 @@ module Raw {
     ConstructorDecl getConstructorDecl() { other_constructor_decl_ref_exprs(this, result) }
   }
 
-  class OverloadSetRefExpr extends @overload_set_ref_expr, Expr { }
+  class OverloadedDeclRefExpr extends @overloaded_decl_ref_expr, Expr {
+    override string toString() { result = "OverloadedDeclRefExpr" }
+
+    ValueDecl getPossibleDeclaration(int index) {
+      overloaded_decl_ref_expr_possible_declarations(this, index, result)
+    }
+  }
 
   class PackExpr extends @pack_expr, Expr {
     override string toString() { result = "PackExpr" }
   }
 
   class PropertyWrapperValuePlaceholderExpr extends @property_wrapper_value_placeholder_expr, Expr {
     override string toString() { result = "PropertyWrapperValuePlaceholderExpr" }
+
+    Expr getWrappedValue() { property_wrapper_value_placeholder_expr_wrapped_values(this, result) }
+
+    OpaqueValueExpr getPlaceholder() { property_wrapper_value_placeholder_exprs(this, result) }
   }
 
   class RebindSelfInConstructorExpr extends @rebind_self_in_constructor_expr, Expr {
@@ -635,6 +651,8 @@ module Raw {
 
   class UnresolvedSpecializeExpr extends @unresolved_specialize_expr, Expr, UnresolvedElement {
     override string toString() { result = "UnresolvedSpecializeExpr" }
+
+    Expr getSubExpr() { unresolved_specialize_exprs(this, result) }
   }
 
   class VarargExpansionExpr extends @vararg_expansion_expr, Expr {
@@ -839,16 +857,16 @@ module Raw {
 
   class ObjectLiteralExpr extends @object_literal_expr, LiteralExpr {
     override string toString() { result = "ObjectLiteralExpr" }
+
+    int getKind() { object_literal_exprs(this, result) }
+
+    Argument getArgument(int index) { object_literal_expr_arguments(this, index, result) }
   }
 
   class OptionalTryExpr extends @optional_try_expr, AnyTryExpr {
     override string toString() { result = "OptionalTryExpr" }
   }
 
-  class OverloadedDeclRefExpr extends @overloaded_decl_ref_expr, OverloadSetRefExpr {
-    override string toString() { result = "OverloadedDeclRefExpr" }
-  }
-
   class ParenExpr extends @paren_expr, IdentityExpr {
     override string toString() { result = "ParenExpr" }
   }