Merge pull request #10386 from github/redsun82/swift-do-not-extract-inactive-ifconfig-clauses

Swift: do not extract unresolved things from `IfConfigDecl`

Author: MathiasVP

swift/codegen/schema.yml

@@ -17,6 +17,9 @@ Element:
     _pragma: cpp_skip  # this is emitted using trap entries directly
   _pragma: qltest_skip
 
+UnresolvedElement:
+  _pragma: [ qltest_collapse_hierarchy, qltest_skip ]
+
 File:
   name: string
   _pragma: qltest_collapse_hierarchy
@@ -27,7 +30,7 @@ DbFile:
 UnknownFile:
   _extends: File
   _synth:
-    on: {}
+    on: { }
 
 Locatable:
   location:
@@ -41,15 +44,15 @@ Location:
   start_column: int
   end_line: int
   end_column: int
-  _pragma: [qltest_skip, qltest_collapse_hierarchy]
+  _pragma: [ qltest_skip, qltest_collapse_hierarchy ]
 
 DbLocation:
   _extends: Location
 
 UnknownLocation:
   _extends: Location
   _synth:
-    on: {}
+    on: { }
 
 Comment:
   _extends: Locatable
@@ -179,7 +182,9 @@ TypeVariableType:
   _extends: Type
 
 UnresolvedType:
-  _extends: Type
+  _extends:
+    - Type
+    - UnresolvedElement
 
 ClassDecl:
   _extends: NominalTypeDecl
@@ -209,7 +214,7 @@ Stmt:
 
 TypeRepr:
   _extends: AstNode
-  type: Type?  # type can be absent on unresolved entities
+  type: Type
 
 FunctionType:
   _extends: AnyFunctionType
@@ -299,15 +304,7 @@ EnumCaseDecl:
 IfConfigDecl:
   _extends: Decl
   _children:
-    clauses: IfConfigClause*
-
-IfConfigClause:
-  _extends: Locatable
-  _children:
-    condition: Expr?
-    elements: AstNode*
-  is_active: predicate
-  _dir: decl
+    active_elements: AstNode*
 
 ImportDecl:
   _extends: Decl
@@ -581,28 +578,36 @@ TypeExpr:
     type_repr: TypeRepr?
 
 UnresolvedDeclRefExpr:
-  _extends: Expr
+  _extends:
+    - Expr
+    - UnresolvedElement
   name: string?
 
 UnresolvedDotExpr:
-  _extends: Expr
+  _extends:
+    - Expr
+    - UnresolvedElement
   _children:
     base: Expr
   name: string
 
 UnresolvedMemberExpr:
-  _extends: Expr
+  _extends:
+    - Expr
+    - UnresolvedElement
   name: string
-  _pragma: qltest_skip  # we should really never extract these
 
 UnresolvedPatternExpr:
-  _extends: Expr
+  _extends:
+    - Expr
+    - UnresolvedElement
   _children:
     sub_pattern: Pattern
 
 UnresolvedSpecializeExpr:
-  _extends: Expr
-  _pragma: qltest_skip  # we should really never extract these
+  _extends:
+    - Expr
+    - UnresolvedElement
 
 VarargExpansionExpr:
   _extends: Expr
@@ -864,7 +869,9 @@ ParenExpr:
   _extends: IdentityExpr
 
 UnresolvedMemberChainResultExpr:
-  _extends: IdentityExpr
+  _extends:
+    - IdentityExpr
+    - UnresolvedElement
 
 AnyHashableErasureExpr:
   _extends: ImplicitConversionExpr
@@ -960,7 +967,9 @@ UnevaluatedInstanceExpr:
   _extends: ImplicitConversionExpr
 
 UnresolvedTypeConversionExpr:
-  _extends: ImplicitConversionExpr
+  _extends:
+    - ImplicitConversionExpr
+    - UnresolvedElement
 
 BuiltinLiteralExpr:
   _extends: LiteralExpr

swift/extractor/infra/SwiftDispatcher.h

@@ -29,7 +29,6 @@ class SwiftDispatcher {
                                const swift::Pattern*,
                                const swift::TypeRepr*,
                                const swift::TypeBase*,
-                               const swift::IfConfigClause*,
                                FilePath>;
 
   template <typename E>
@@ -323,7 +322,6 @@ class SwiftDispatcher {
   // 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,7 +49,6 @@ 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

@@ -380,15 +380,9 @@ void DeclVisitor::fillAbstractStorageDecl(const swift::AbstractStorageDecl& decl
 
 codeql::IfConfigDecl DeclVisitor::translateIfConfigDecl(const swift::IfConfigDecl& decl) {
   auto entry = 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;
+  if (auto activeClause = decl.getActiveClause()) {
+    entry.active_elements = dispatcher_.fetchRepeatedLabels(activeClause->Elements);
+  }
   return entry;
 }
 

swift/extractor/visitors/DeclVisitor.h

@@ -16,10 +16,6 @@ class DeclVisitor : public AstVisitorBase<DeclVisitor> {
   using AstVisitorBase<DeclVisitor>::AstVisitorBase;
   using AstVisitorBase<DeclVisitor>::visit;
 
-  void visit(const swift::IfConfigClause* clause) {
-    dispatcher_.emit(translateIfConfigClause(*clause));
-  }
-
   std::optional<codeql::ConcreteFuncDecl> translateFuncDecl(const swift::FuncDecl& decl);
   std::optional<codeql::ConstructorDecl> translateConstructorDecl(
       const swift::ConstructorDecl& decl);
@@ -50,7 +46,6 @@ class DeclVisitor : public AstVisitorBase<DeclVisitor> {
   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/SwiftVisitor.h

@@ -22,7 +22,6 @@ 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

@@ -11,7 +11,7 @@ void TypeVisitor::visit(swift::TypeBase* type) {
 
 codeql::TypeRepr TypeVisitor::translateTypeRepr(const swift::TypeRepr& typeRepr, swift::Type type) {
   auto entry = dispatcher_.createEntry(typeRepr);
-  entry.type = dispatcher_.fetchOptionalLabel(type);
+  entry.type = dispatcher_.fetchLabel(type);
   return entry;
 }
 

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

@@ -10,6 +10,7 @@ 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.decl.AbstractFunctionDecl
 import codeql.swift.elements.decl.AbstractStorageDecl
 import codeql.swift.elements.decl.AbstractTypeParamDecl
@@ -29,7 +30,6 @@ import codeql.swift.elements.decl.FuncDecl
 import codeql.swift.elements.decl.GenericContext
 import codeql.swift.elements.decl.GenericTypeDecl
 import codeql.swift.elements.decl.GenericTypeParamDecl
-import codeql.swift.elements.decl.IfConfigClause
 import codeql.swift.elements.decl.IfConfigDecl
 import codeql.swift.elements.decl.ImportDecl
 import codeql.swift.elements.decl.InfixOperatorDecl

swift/ql/lib/codeql/swift/elements/UnresolvedElement.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.UnresolvedElement
+
+class UnresolvedElement extends UnresolvedElementBase { }