Merge pull request #9795 from github/redsun82/swift-extraction

Swift: extract more entities

Author: redsun82

swift/codegen/schema.yml

@@ -274,6 +274,16 @@ EnumCaseDecl:
 
 IfConfigDecl:
   _extends: Decl
+  _children:
+    clauses: IfConfigClause*
+
+IfConfigClause:
+  _extends: Locatable
+  _children:
+    condition: Expr?
+    elements: AstNode*
+  is_active: predicate
+  _dir: decl
 
 ImportDecl:
   _extends: Decl
@@ -550,7 +560,6 @@ TypeExpr:
 UnresolvedDeclRefExpr:
   _extends: Expr
   name: string?
-  _pragma: qltest_skip  # we should really never extract these
 
 UnresolvedDotExpr:
   _extends: Expr
@@ -565,7 +574,8 @@ UnresolvedMemberExpr:
 
 UnresolvedPatternExpr:
   _extends: Expr
-  _pragma: qltest_skip  # we should really never extract these
+  _children:
+    sub_pattern: Pattern
 
 UnresolvedSpecializeExpr:
   _extends: Expr

swift/extractor/infra/SwiftDispatcher.h

@@ -93,6 +93,10 @@ class SwiftDispatcher {
     return fetchLabelFromUnion<AstNodeTag>(node);
   }
 
+  TrapLabel<IfConfigClauseTag> fetchLabel(const swift::IfConfigClause& clause) {
+    return fetchLabel(&clause);
+  }
+
   TrapLabel<ConditionElementTag> fetchLabel(const swift::StmtConditionElement& element) {
     return fetchLabel(&element);
   }
@@ -140,6 +144,15 @@ class SwiftDispatcher {
     attachLocation(locatable->getStartLoc(), locatable->getEndLoc(), locatableLabel);
   }
 
+  void attachLocation(const swift::IfConfigClause* clause, TrapLabel<LocatableTag> locatableLabel) {
+    attachLocation(clause->Loc, clause->Loc, locatableLabel);
+  }
+
+  // Emits a Location TRAP entry and attaches it to a `Locatable` trap label for a given `SourceLoc`
+  void attachLocation(swift::SourceLoc loc, TrapLabel<LocatableTag> locatableLabel) {
+    attachLocation(loc, loc, locatableLabel);
+  }
+
   // Emits a Location TRAP entry for a list of swift entities and attaches it to a `Locatable` trap
   // label
   template <typename Locatable>
@@ -215,7 +228,8 @@ class SwiftDispatcher {
                                swift::Expr,
                                swift::Pattern,
                                swift::TypeRepr,
-                               swift::TypeBase>;
+                               swift::TypeBase,
+                               swift::IfConfigClause>;
 
   void attachLocation(swift::SourceLoc start,
                       swift::SourceLoc end,
@@ -269,9 +283,11 @@ class SwiftDispatcher {
     return realPath.str().str();
   }
 
-  // TODO: The following methods are supposed to redirect TRAP emission to correpsonding visitors,
-  // which are to be introduced in follow-up PRs
+  // TODO: for const correctness these should consistently be `const` (and maybe const references
+  // as we don't expect `nullptr` here. However `swift::ASTVisitor` and `swift::TypeVisitor` do not
+  // accept const pointers
   virtual void visit(swift::Decl* decl) = 0;
+  virtual void visit(const swift::IfConfigClause* clause) = 0;
   virtual void visit(swift::Stmt* stmt) = 0;
   virtual void visit(const swift::StmtCondition* cond) = 0;
   virtual void visit(const swift::StmtConditionElement* cond) = 0;

swift/extractor/infra/SwiftTagTraits.h

@@ -49,6 +49,7 @@ MAP_TAG(Argument);
 #include <swift/AST/ExprNodes.def>
 
 MAP_TAG(Decl);
+MAP_TAG(IfConfigClause);
 #define ABSTRACT_DECL(CLASS, PARENT) MAP_SUBTAG(CLASS##Decl, PARENT)
 #define DECL(CLASS, PARENT) ABSTRACT_DECL(CLASS, PARENT)
 #include <swift/AST/DeclNodes.def>

swift/extractor/visitors/DeclVisitor.cpp

@@ -358,4 +358,18 @@ void DeclVisitor::fillAbstractStorageDecl(const swift::AbstractStorageDecl& decl
   fillValueDecl(decl, entry);
 }
 
+codeql::IfConfigDecl DeclVisitor::translateIfConfigDecl(const swift::IfConfigDecl& decl) {
+  auto entry = dispatcher_.createEntry(decl);
+  entry.clauses = dispatcher_.fetchRepeatedLabels(decl.getClauses());
+  return entry;
+}
+
+codeql::IfConfigClause DeclVisitor::translateIfConfigClause(const swift::IfConfigClause& clause) {
+  auto entry = dispatcher_.createEntry(clause);
+  entry.condition = dispatcher_.fetchOptionalLabel(clause.Cond);
+  entry.elements = dispatcher_.fetchRepeatedLabels(clause.Elements);
+  entry.is_active = clause.isActive;
+  return entry;
+}
+
 }  // namespace codeql

swift/extractor/visitors/DeclVisitor.h

@@ -14,6 +14,11 @@ namespace codeql {
 class DeclVisitor : public AstVisitorBase<DeclVisitor> {
  public:
   using AstVisitorBase<DeclVisitor>::AstVisitorBase;
+  using AstVisitorBase<DeclVisitor>::visit;
+
+  void visit(const swift::IfConfigClause* clause) {
+    dispatcher_.emit(translateIfConfigClause(*clause));
+  }
 
   std::variant<codeql::ConcreteFuncDecl, codeql::ConcreteFuncDeclsTrap> translateFuncDecl(
       const swift::FuncDecl& decl);
@@ -52,6 +57,8 @@ class DeclVisitor : public AstVisitorBase<DeclVisitor> {
   codeql::ExtensionDecl translateExtensionDecl(const swift::ExtensionDecl& decl);
   codeql::ImportDecl translateImportDecl(const swift::ImportDecl& decl);
   std::optional<codeql::ModuleDecl> translateModuleDecl(const swift::ModuleDecl& decl);
+  codeql::IfConfigDecl translateIfConfigDecl(const swift::IfConfigDecl& decl);
+  codeql::IfConfigClause translateIfConfigClause(const swift::IfConfigClause& clause);
 
  private:
   std::string mangledName(const swift::ValueDecl& decl);

swift/extractor/visitors/ExprVisitor.cpp

@@ -668,4 +668,10 @@ void ExprVisitor::emitLookupExpr(const swift::LookupExpr* expr, TrapLabel<Lookup
   }
 }
 
+codeql::UnresolvedPatternExpr ExprVisitor::translateUnresolvedPatternExpr(
+    swift::UnresolvedPatternExpr& expr) {
+  auto entry = dispatcher_.createEntry(expr);
+  entry.sub_pattern = dispatcher_.fetchLabel(expr.getSubPattern());
+  return entry;
+}
 }  // namespace codeql

swift/extractor/visitors/ExprVisitor.h

@@ -84,6 +84,13 @@ class ExprVisitor : public AstVisitorBase<ExprVisitor> {
   codeql::BridgeFromObjCExpr translateBridgeFromObjCExpr(const swift::BridgeFromObjCExpr& expr);
   codeql::DotSelfExpr translateDotSelfExpr(const swift::DotSelfExpr& expr);
   codeql::ErrorExpr translateErrorExpr(const swift::ErrorExpr& expr);
+  // The following function requires a non-const parameter because:
+  // * `swift::UnresolvedPatternExpr::getSubPattern` has a `const`-qualified overload returning
+  //   `const swift::Pattern*`
+  // * `swift::ASTVisitor` only visits non-const pointers
+  // either we accept this, or we fix constness, e.g. by providing `visit` on `const` pointers
+  // in `VisitorBase`, or by doing a `const_cast` in `SwifDispatcher::fetchLabel`
+  codeql::UnresolvedPatternExpr translateUnresolvedPatternExpr(swift::UnresolvedPatternExpr& expr);
 
  private:
   void fillAbstractClosureExpr(const swift::AbstractClosureExpr& expr,

swift/extractor/visitors/SwiftVisitor.h

@@ -21,6 +21,7 @@ class SwiftVisitor : private SwiftDispatcher {
 
  private:
   void visit(swift::Decl* decl) override { declVisitor.visit(decl); }
+  void visit(const swift::IfConfigClause* clause) override { declVisitor.visit(clause); }
   void visit(swift::Stmt* stmt) override { stmtVisitor.visit(stmt); }
   void visit(const swift::StmtCondition* cond) override {
     emit(stmtVisitor.translateStmtCondition(*cond));

swift/extractor/visitors/TypeVisitor.cpp

@@ -1,4 +1,5 @@
 #include "swift/extractor/visitors/TypeVisitor.h"
+
 namespace codeql {
 void TypeVisitor::visit(swift::TypeBase* type) {
   TypeVisitorBase<TypeVisitor>::visit(type);
@@ -368,4 +369,10 @@ codeql::BuiltinVectorType TypeVisitor::translateBuiltinVectorType(
   return createTypeEntry(type);
 }
 
+codeql::OpenedArchetypeType TypeVisitor::translateOpenedArchetypeType(
+    const swift::OpenedArchetypeType& type) {
+  auto entry = createTypeEntry(type);
+  fillArchetypeType(type, entry);
+  return entry;
+}
 }  // namespace codeql

swift/extractor/visitors/TypeVisitor.h

@@ -68,6 +68,7 @@ class TypeVisitor : public TypeVisitorBase<TypeVisitor> {
   codeql::BuiltinUnsafeValueBufferType translateBuiltinUnsafeValueBufferType(
       const swift::BuiltinUnsafeValueBufferType& type);
   codeql::BuiltinVectorType translateBuiltinVectorType(const swift::BuiltinVectorType& type);
+  codeql::OpenedArchetypeType translateOpenedArchetypeType(const swift::OpenedArchetypeType& type);
 
  private:
   void fillType(const swift::TypeBase& type, codeql::Type& entry);