Swift: extract types for patterns

swift/downgrades/60be249ad164f6e4b43c203323f1b3956dc97c2f/upgrade.properties

@@ -0,0 +1,4 @@
+description: Remove types for patterns
+compatibility: partial
+
+pattern_types.rel: delete

swift/extractor/translators/PatternTranslator.cpp

@@ -3,62 +3,63 @@
 namespace codeql {
 
 codeql::NamedPattern PatternTranslator::translateNamedPattern(const swift::NamedPattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+
+  auto entry = createPatternEntry(pattern);
   entry.var_decl = dispatcher.fetchLabel(pattern.getDecl());
   return entry;
 }
 
 codeql::TypedPattern PatternTranslator::translateTypedPattern(const swift::TypedPattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+  auto entry = createPatternEntry(pattern);
   entry.sub_pattern = dispatcher.fetchLabel(pattern.getSubPattern());
   entry.type_repr = dispatcher.fetchOptionalLabel(pattern.getTypeRepr(), pattern.getType());
   return entry;
 }
 
 codeql::TuplePattern PatternTranslator::translateTuplePattern(const swift::TuplePattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+  auto entry = createPatternEntry(pattern);
   for (const auto& p : pattern.getElements()) {
     entry.elements.push_back(dispatcher.fetchLabel(p.getPattern()));
   }
   return entry;
 }
 codeql::AnyPattern PatternTranslator::translateAnyPattern(const swift::AnyPattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+  auto entry = createPatternEntry(pattern);
   return entry;
 }
 
 codeql::BindingPattern PatternTranslator::translateBindingPattern(
     const swift::BindingPattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+  auto entry = createPatternEntry(pattern);
   entry.sub_pattern = dispatcher.fetchLabel(pattern.getSubPattern());
   return entry;
 }
 
 codeql::EnumElementPattern PatternTranslator::translateEnumElementPattern(
     const swift::EnumElementPattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+  auto entry = createPatternEntry(pattern);
   entry.element = dispatcher.fetchLabel(pattern.getElementDecl());
   entry.sub_pattern = dispatcher.fetchOptionalLabel(pattern.getSubPattern());
   return entry;
 }
 
 codeql::OptionalSomePattern PatternTranslator::translateOptionalSomePattern(
     const swift::OptionalSomePattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+  auto entry = createPatternEntry(pattern);
   entry.sub_pattern = dispatcher.fetchLabel(pattern.getSubPattern());
   return entry;
 }
 
 codeql::IsPattern PatternTranslator::translateIsPattern(const swift::IsPattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+  auto entry = createPatternEntry(pattern);
   entry.cast_type_repr =
       dispatcher.fetchOptionalLabel(pattern.getCastTypeRepr(), pattern.getCastType());
   entry.sub_pattern = dispatcher.fetchOptionalLabel(pattern.getSubPattern());
   return entry;
 }
 
 codeql::ExprPattern PatternTranslator::translateExprPattern(const swift::ExprPattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+  auto entry = createPatternEntry(pattern);
   if (auto match = pattern.getMatchExpr()) {
     entry.sub_expr = dispatcher.fetchLabel(match);
   } else {
@@ -68,13 +69,13 @@ codeql::ExprPattern PatternTranslator::translateExprPattern(const swift::ExprPat
 }
 
 codeql::ParenPattern PatternTranslator::translateParenPattern(const swift::ParenPattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+  auto entry = createPatternEntry(pattern);
   entry.sub_pattern = dispatcher.fetchLabel(pattern.getSubPattern());
   return entry;
 }
 
 codeql::BoolPattern PatternTranslator::translateBoolPattern(const swift::BoolPattern& pattern) {
-  auto entry = dispatcher.createEntry(pattern);
+  auto entry = createPatternEntry(pattern);
   entry.value = pattern.getValue();
   return entry;
 }

swift/extractor/translators/PatternTranslator.h

@@ -23,5 +23,13 @@ class PatternTranslator : public AstTranslatorBase<PatternTranslator> {
   codeql::ExprPattern translateExprPattern(const swift::ExprPattern& pattern);
   codeql::ParenPattern translateParenPattern(const swift::ParenPattern& pattern);
   codeql::BoolPattern translateBoolPattern(const swift::BoolPattern& pattern);
+
+ private:
+  template <typename T>
+  TrapClassOf<T> createPatternEntry(const T& pattern) {
+    auto entry = dispatcher.createEntry(pattern);
+    entry.type = dispatcher.fetchOptionalLabel(pattern.getType());
+    return entry;
+  }
 };
 }  // namespace codeql

swift/ql/lib/change-notes/2023-10-24-pattern-types.md

@@ -0,0 +1,5 @@
+---
+category: minorAnalysis
+---
+
+* Tyes for patterns are now included in the database and made available through the `Pattern::getType()` method.