Swift: extract PropertyWrapperValuePlaceholderExpr

Author: redsun82

swift/extractor/translators/ExprTranslator.cpp

@@ -564,4 +564,13 @@ codeql::UnresolvedSpecializeExpr ExprTranslator::translateUnresolvedSpecializeEx
   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;
+}
+
 }  // namespace codeql

swift/extractor/translators/ExprTranslator.h

@@ -111,6 +111,8 @@ class ExprTranslator : public AstTranslatorBase<ExprTranslator> {
       const swift::DynamicSubscriptExpr& expr);
   codeql::UnresolvedSpecializeExpr translateUnresolvedSpecializeExpr(
       const swift::UnresolvedSpecializeExpr& expr);
+  codeql::PropertyWrapperValuePlaceholderExpr translatePropertyWrapperValuePlaceholderExpr(
+      const swift::PropertyWrapperValuePlaceholderExpr& expr);
 
  private:
   void fillAbstractClosureExpr(const swift::AbstractClosureExpr& expr,

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

@@ -561,6 +561,10 @@ module Raw {
 
   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 {

swift/ql/lib/codeql/swift/generated/expr/PropertyWrapperValuePlaceholderExpr.qll

@@ -2,10 +2,56 @@
 private import codeql.swift.generated.Synth
 private import codeql.swift.generated.Raw
 import codeql.swift.elements.expr.Expr
+import codeql.swift.elements.expr.OpaqueValueExpr
 
 module Generated {
+  /**
+   * A placeholder substituting property initializations with `=` when the property has a property
+   * wrapper with an initializer.
+   */
   class PropertyWrapperValuePlaceholderExpr extends Synth::TPropertyWrapperValuePlaceholderExpr,
     Expr {
     override string getAPrimaryQlClass() { result = "PropertyWrapperValuePlaceholderExpr" }
+
+    /**
+     * Gets the wrapped value of this property wrapper value placeholder expression, if it exists.
+     *
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behavior of both the `Immediate` and non-`Immediate` versions.
+     */
+    Expr getImmediateWrappedValue() {
+      result =
+        Synth::convertExprFromRaw(Synth::convertPropertyWrapperValuePlaceholderExprToRaw(this)
+              .(Raw::PropertyWrapperValuePlaceholderExpr)
+              .getWrappedValue())
+    }
+
+    /**
+     * Gets the wrapped value of this property wrapper value placeholder expression, if it exists.
+     */
+    final Expr getWrappedValue() { result = getImmediateWrappedValue().resolve() }
+
+    /**
+     * Holds if `getWrappedValue()` exists.
+     */
+    final predicate hasWrappedValue() { exists(getWrappedValue()) }
+
+    /**
+     * Gets the placeholder of this property wrapper value placeholder expression.
+     *
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behavior of both the `Immediate` and non-`Immediate` versions.
+     */
+    OpaqueValueExpr getImmediatePlaceholder() {
+      result =
+        Synth::convertOpaqueValueExprFromRaw(Synth::convertPropertyWrapperValuePlaceholderExprToRaw(this)
+              .(Raw::PropertyWrapperValuePlaceholderExpr)
+              .getPlaceholder())
+    }
+
+    /**
+     * Gets the placeholder of this property wrapper value placeholder expression.
+     */
+    final OpaqueValueExpr getPlaceholder() { result = getImmediatePlaceholder().resolve() }
   }
 }

swift/ql/lib/swift.dbscheme

@@ -987,7 +987,14 @@ pack_exprs(  //dir=expr
 );
 
 property_wrapper_value_placeholder_exprs(  //dir=expr
-  unique int id: @property_wrapper_value_placeholder_expr
+  unique int id: @property_wrapper_value_placeholder_expr,
+  int placeholder: @opaque_value_expr_or_none ref
+);
+
+#keyset[id]
+property_wrapper_value_placeholder_expr_wrapped_values(  //dir=expr
+  int id: @property_wrapper_value_placeholder_expr ref,
+  int wrapped_value: @expr_or_none ref
 );
 
 rebind_self_in_constructor_exprs(  //dir=expr

swift/ql/test/extractor-tests/generated/expr/PropertyWrapperValuePlaceholderExpr/MISSING_SOURCE.txt

@@ -0,0 +1 @@
+| property_wrapper_value_placeholder.swift:12:26:12:26 | PropertyWrapperValuePlaceholderExpr | getPlaceholder: | property_wrapper_value_placeholder.swift:12:26:12:26 | OpaqueValueExpr |

swift/ql/test/extractor-tests/generated/expr/PropertyWrapperValuePlaceholderExpr/PropertyWrapperValuePlaceholderExpr.expected

@@ -0,0 +1,10 @@
+// generated by codegen/codegen.py
+import codeql.swift.elements
+import TestUtils
+
+from PropertyWrapperValuePlaceholderExpr x, OpaqueValueExpr getPlaceholder
+where
+  toBeTested(x) and
+  not x.isUnknown() and
+  getPlaceholder = x.getPlaceholder()
+select x, "getPlaceholder:", getPlaceholder

swift/ql/test/extractor-tests/generated/expr/PropertyWrapperValuePlaceholderExpr/PropertyWrapperValuePlaceholderExpr.ql

@@ -0,0 +1 @@
+| property_wrapper_value_placeholder.swift:12:26:12:26 | PropertyWrapperValuePlaceholderExpr | Int |

swift/ql/test/extractor-tests/generated/expr/PropertyWrapperValuePlaceholderExpr/PropertyWrapperValuePlaceholderExpr_getType.expected

@@ -0,0 +1,7 @@
+// generated by codegen/codegen.py
+import codeql.swift.elements
+import TestUtils
+
+from PropertyWrapperValuePlaceholderExpr x
+where toBeTested(x) and not x.isUnknown()
+select x, x.getType()