Merge pull request #11094 from github/redsun82/swift-translators

Swift: refactor visitors to use translations

Author: redsun82

.pre-commit-config.yaml

@@ -31,7 +31,7 @@ repos:
 
       - id: sync-files
         name: Fix files required to be identical
-        files: \.(qll?|qhelp|swift)$
+        files: \.(qll?|qhelp|swift)$|^config/identical-files\.json$
         language: system
         entry: python3 config/sync-files.py --latest
         pass_filenames: false

config/identical-files.json

@@ -600,8 +600,12 @@
     "swift/ql/test/extractor-tests/patterns/patterns.swift",
     "swift/ql/test/library-tests/ast/patterns.swift"
   ],
+  "Swift control flow test file": [
+    "swift/ql/test/library-tests/controlflow/graph/cfg.swift",
+    "swift/ql/test/library-tests/ast/cfg.swift"
+  ],
   "IncompleteMultiCharacterSanitization JS/Ruby": [
     "javascript/ql/lib/semmle/javascript/security/IncompleteMultiCharacterSanitizationQuery.qll",
     "ruby/ql/lib/codeql/ruby/security/IncompleteMultiCharacterSanitizationQuery.qll"
   ]
-}
+}

swift/codegen/lib/cpp.py

@@ -16,7 +16,7 @@
                 "xor", "xor_eq"}
 
 _field_overrides = [
-    (re.compile(r"(start|end)_(line|column)|index|width|num_.*"), {"type": "unsigned"}),
+    (re.compile(r"(start|end)_(line|column)|(.*_)?index|width|num_.*"), {"type": "unsigned"}),
     (re.compile(r"(.*)_"), lambda m: {"field_name": m[1]}),
 ]
 

swift/extractor/BUILD.bazel

@@ -11,7 +11,7 @@ swift_cc_binary(
     deps = [
         "//swift/extractor/infra",
         "//swift/extractor/remapping",
-        "//swift/extractor/visitors",
+        "//swift/extractor/translators",
         "//swift/third_party/swift-llvm-support",
     ],
 )

swift/extractor/SwiftExtractor.cpp

@@ -9,7 +9,7 @@
 #include <swift/AST/Builtins.h>
 
 #include "swift/extractor/trap/TrapDomain.h"
-#include "swift/extractor/visitors/SwiftVisitor.h"
+#include "swift/extractor/translators/SwiftVisitor.h"
 #include "swift/extractor/TargetTrapFile.h"
 #include "swift/extractor/SwiftBuiltinSymbols.h"
 

swift/extractor/infra/SwiftDispatcher.h

@@ -211,7 +211,9 @@ class SwiftDispatcher {
   template <typename Iterable>
   auto fetchRepeatedLabels(Iterable&& arg) {
     std::vector<decltype(fetchLabel(*arg.begin()))> ret;
-    ret.reserve(arg.size());
+    if constexpr (HasSize<Iterable>::value) {
+      ret.reserve(arg.size());
+    }
     for (auto&& e : arg) {
       ret.push_back(fetchLabel(e));
     }
@@ -262,6 +264,12 @@ class SwiftDispatcher {
   }
 
  private:
+  template <typename T, typename = void>
+  struct HasSize : std::false_type {};
+
+  template <typename T>
+  struct HasSize<T, decltype(std::declval<T>().size(), void())> : std::true_type {};
+
   void attachLocation(swift::SourceLoc start,
                       swift::SourceLoc end,
                       TrapLabel<LocatableTag> locatableLabel) {
@@ -320,18 +328,15 @@ class SwiftDispatcher {
     return ret;
   }
 
-  // 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(swift::Stmt* stmt) = 0;
+  virtual void visit(const swift::Decl* decl) = 0;
+  virtual void visit(const swift::Stmt* stmt) = 0;
   virtual void visit(const swift::StmtCondition* cond) = 0;
   virtual void visit(const swift::StmtConditionElement* cond) = 0;
-  virtual void visit(swift::CaseLabelItem* item) = 0;
-  virtual void visit(swift::Expr* expr) = 0;
-  virtual void visit(swift::Pattern* pattern) = 0;
-  virtual void visit(swift::TypeRepr* typeRepr, swift::Type type) = 0;
-  virtual void visit(swift::TypeBase* type) = 0;
+  virtual void visit(const swift::CaseLabelItem* item) = 0;
+  virtual void visit(const swift::Expr* expr) = 0;
+  virtual void visit(const swift::Pattern* pattern) = 0;
+  virtual void visit(const swift::TypeRepr* typeRepr, swift::Type type) = 0;
+  virtual void visit(const swift::TypeBase* type) = 0;
 
   void visit(const std::filesystem::path& file) {
     auto entry = createEntry(file, file.string());

swift/extractor/visitors/BUILD.bazel renamed to swift/extractor/translators/BUILD.bazel

@@ -1,7 +1,7 @@
 load("//swift:rules.bzl", "swift_cc_library")
 
 swift_cc_library(
-    name = "visitors",
+    name = "translators",
     srcs = glob(["*.cpp"]),
     hdrs = glob(["*.h"]),
     visibility = ["//swift:__subpackages__"],