Swift: pattern visitor

redsun82 · redsun82 · commit 3f45b73d62d2 · 2022-05-20T15:41:27.000+02:00
This transfers the current state of `PatternVisitor` from the
proof-of-concept.
diff --git a/swift/codegen/schema.yml b/swift/codegen/schema.yml
@@ -491,46 +491,46 @@ AnyPattern:
 
 BindingPattern:
   _extends: Pattern
-#  sub_pattern: Pattern
+  sub_pattern: Pattern
 
 BoolPattern:
   _extends: Pattern
-#  value: boolean
+  value: boolean
 
 EnumElementPattern:
   _extends: Pattern
-#  element: EnumElementDecl
-#  sub_pattern: Pattern?
+  element: EnumElementDecl
+  sub_pattern: Pattern?
 
 ExprPattern:
   _extends: Pattern
-#  sub_expr: Expr
+  sub_expr: Expr
 
 IsPattern:
   _extends: Pattern
-#  cast_type_repr: TypeRepr?
-#  sub_pattern: Pattern?
+  cast_type_repr: TypeRepr?
+  sub_pattern: Pattern?
 
 NamedPattern:
   _extends: Pattern
-#  name: string
+  name: string
 
 OptionalSomePattern:
   _extends: Pattern
-#  sub_pattern: Pattern
+  sub_pattern: Pattern
 
 ParenPattern:
   _extends: Pattern
-#  sub_pattern: Pattern
+  sub_pattern: Pattern
 
 TuplePattern:
   _extends: Pattern
-#  elements: Pattern*
+  elements: Pattern*
 
 TypedPattern:
   _extends: Pattern
-#  sub_pattern: Pattern
-#  type_repr: TypeRepr?
+  sub_pattern: Pattern
+  type_repr: TypeRepr?
 
 BraceStmt:
   _extends: Stmt
diff --git a/swift/extractor/visitors/PatternVisitor.h b/swift/extractor/visitors/PatternVisitor.h
@@ -7,6 +7,91 @@ namespace codeql {
 class PatternVisitor : public AstVisitorBase<PatternVisitor> {
  public:
   using AstVisitorBase<PatternVisitor>::AstVisitorBase;
-};
 
+  void visitNamedPattern(swift::NamedPattern* pattern) {
+    auto label = dispatcher_.assignNewLabel(pattern);
+    // TODO: in some (but not all) cases, this seems to introduce a duplicate entry
+    // for example the vars listed in a case stmt have a different pointer than then ones in
+    // patterns.
+    //  assert(pattern->getDecl() && "expect NamedPattern to have Decl");
+    //  dispatcher_.emit(NamedPatternsTrap{label, pattern->getNameStr().str(),
+    //                                       dispatcher_.fetchLabel(pattern->getDecl())});
+    dispatcher_.emit(NamedPatternsTrap{label, pattern->getNameStr().str()});
+  }
+
+  void visitTypedPattern(swift::TypedPattern* pattern) {
+    auto label = dispatcher_.assignNewLabel(pattern);
+    assert(pattern->getSubPattern() && "expect TypedPattern to have a SubPattern");
+    dispatcher_.emit(TypedPatternsTrap{label, dispatcher_.fetchLabel(pattern->getSubPattern())});
+    if (auto typeRepr = pattern->getTypeRepr()) {
+      dispatcher_.emit(
+          TypedPatternTypeReprsTrap{label, dispatcher_.fetchLabel(pattern->getTypeRepr())});
+    }
+  }
+
+  void visitTuplePattern(swift::TuplePattern* pattern) {
+    auto label = dispatcher_.assignNewLabel(pattern);
+    dispatcher_.emit(TuplePatternsTrap{label});
+    auto i = 0u;
+    for (auto p : pattern->getElements()) {
+      dispatcher_.emit(
+          TuplePatternElementsTrap{label, i++, dispatcher_.fetchLabel(p.getPattern())});
+    }
+  }
+  void visitAnyPattern(swift::AnyPattern* pattern) {
+    dispatcher_.emit(AnyPatternsTrap{dispatcher_.assignNewLabel(pattern)});
+  }
+
+  void visitBindingPattern(swift::BindingPattern* pattern) {
+    auto label = dispatcher_.assignNewLabel(pattern);
+    assert(pattern->getSubPattern() && "expect BindingPattern to have a SubPattern");
+    dispatcher_.emit(BindingPatternsTrap{label, dispatcher_.fetchLabel(pattern->getSubPattern())});
+  }
+
+  void visitEnumElementPattern(swift::EnumElementPattern* pattern) {
+    auto label = dispatcher_.assignNewLabel(pattern);
+    dispatcher_.emit(
+        EnumElementPatternsTrap{label, dispatcher_.fetchLabel(pattern->getElementDecl())});
+    if (auto subPattern = pattern->getSubPattern()) {
+      dispatcher_.emit(EnumElementPatternSubPatternsTrap{
+          label, dispatcher_.fetchLabel(pattern->getSubPattern())});
+    }
+  }
+
+  void visitOptionalSomePattern(swift::OptionalSomePattern* pattern) {
+    auto label = dispatcher_.assignNewLabel(pattern);
+    assert(pattern->getSubPattern() && "expect BindingPattern to have a SubPattern");
+    dispatcher_.emit(
+        OptionalSomePatternsTrap{label, dispatcher_.fetchLabel(pattern->getSubPattern())});
+  }
+
+  void visitIsPattern(swift::IsPattern* pattern) {
+    auto label = dispatcher_.assignNewLabel(pattern);
+    dispatcher_.emit(IsPatternsTrap{label});
+
+    if (auto typeRepr = pattern->getCastTypeRepr()) {
+      dispatcher_.emit(IsPatternCastTypeReprsTrap{label, dispatcher_.fetchLabel(typeRepr)});
+    }
+    if (auto subPattern = pattern->getSubPattern()) {
+      dispatcher_.emit(IsPatternSubPatternsTrap{label, dispatcher_.fetchLabel(subPattern)});
+    }
+  }
+
+  void visitExprPattern(swift::ExprPattern* pattern) {
+    auto label = dispatcher_.assignNewLabel(pattern);
+    assert(pattern->getSubExpr() && "expect ExprPattern to have SubExpr");
+    dispatcher_.emit(ExprPatternsTrap{label, dispatcher_.fetchLabel(pattern->getSubExpr())});
+  }
+
+  void visitParenPattern(swift::ParenPattern* pattern) {
+    auto label = dispatcher_.assignNewLabel(pattern);
+    assert(pattern->getSubPattern() && "expect ParenPattern to have SubPattern");
+    dispatcher_.emit(ParenPatternsTrap{label, dispatcher_.fetchLabel(pattern->getSubPattern())});
+  }
+
+  void visitBoolPattern(swift::BoolPattern* pattern) {
+    auto label = dispatcher_.assignNewLabel(pattern);
+    dispatcher_.emit(BoolPatternsTrap{label, pattern->getValue()});
+  }
+};
 }  // namespace codeql
diff --git a/swift/ql/lib/codeql/swift/generated/pattern/BindingPattern.qll b/swift/ql/lib/codeql/swift/generated/pattern/BindingPattern.qll
@@ -3,4 +3,11 @@ import codeql.swift.elements.pattern.Pattern
 
 class BindingPatternBase extends @binding_pattern, Pattern {
   override string getAPrimaryQlClass() { result = "BindingPattern" }
+
+  Pattern getSubPattern() {
+    exists(Pattern x |
+      binding_patterns(this, x) and
+      result = x.resolve()
+    )
+  }
 }
diff --git a/swift/ql/lib/codeql/swift/generated/pattern/BoolPattern.qll b/swift/ql/lib/codeql/swift/generated/pattern/BoolPattern.qll
@@ -3,4 +3,6 @@ import codeql.swift.elements.pattern.Pattern
 
 class BoolPatternBase extends @bool_pattern, Pattern {
   override string getAPrimaryQlClass() { result = "BoolPattern" }
+
+  boolean getValue() { bool_patterns(this, result) }
 }
diff --git a/swift/ql/lib/codeql/swift/generated/pattern/EnumElementPattern.qll b/swift/ql/lib/codeql/swift/generated/pattern/EnumElementPattern.qll
@@ -1,6 +1,23 @@
 // generated by codegen/codegen.py
+import codeql.swift.elements.decl.EnumElementDecl
 import codeql.swift.elements.pattern.Pattern
 
 class EnumElementPatternBase extends @enum_element_pattern, Pattern {
   override string getAPrimaryQlClass() { result = "EnumElementPattern" }
+
+  EnumElementDecl getElement() {
+    exists(EnumElementDecl x |
+      enum_element_patterns(this, x) and
+      result = x.resolve()
+    )
+  }
+
+  Pattern getSubPattern() {
+    exists(Pattern x |
+      enum_element_pattern_sub_patterns(this, x) and
+      result = x.resolve()
+    )
+  }
+
+  predicate hasSubPattern() { exists(getSubPattern()) }
 }
diff --git a/swift/ql/lib/codeql/swift/generated/pattern/ExprPattern.qll b/swift/ql/lib/codeql/swift/generated/pattern/ExprPattern.qll
@@ -1,6 +1,14 @@
 // generated by codegen/codegen.py
+import codeql.swift.elements.expr.Expr
 import codeql.swift.elements.pattern.Pattern
 
 class ExprPatternBase extends @expr_pattern, Pattern {
   override string getAPrimaryQlClass() { result = "ExprPattern" }
+
+  Expr getSubExpr() {
+    exists(Expr x |
+      expr_patterns(this, x) and
+      result = x.resolve()
+    )
+  }
 }
diff --git a/swift/ql/lib/codeql/swift/generated/pattern/IsPattern.qll b/swift/ql/lib/codeql/swift/generated/pattern/IsPattern.qll
@@ -1,6 +1,25 @@
 // generated by codegen/codegen.py
 import codeql.swift.elements.pattern.Pattern
+import codeql.swift.elements.typerepr.TypeRepr
 
 class IsPatternBase extends @is_pattern, Pattern {
   override string getAPrimaryQlClass() { result = "IsPattern" }
+
+  TypeRepr getCastTypeRepr() {
+    exists(TypeRepr x |
+      is_pattern_cast_type_reprs(this, x) and
+      result = x.resolve()
+    )
+  }
+
+  predicate hasCastTypeRepr() { exists(getCastTypeRepr()) }
+
+  Pattern getSubPattern() {
+    exists(Pattern x |
+      is_pattern_sub_patterns(this, x) and
+      result = x.resolve()
+    )
+  }
+
+  predicate hasSubPattern() { exists(getSubPattern()) }
 }
diff --git a/swift/ql/lib/codeql/swift/generated/pattern/NamedPattern.qll b/swift/ql/lib/codeql/swift/generated/pattern/NamedPattern.qll
@@ -3,4 +3,6 @@ import codeql.swift.elements.pattern.Pattern
 
 class NamedPatternBase extends @named_pattern, Pattern {
   override string getAPrimaryQlClass() { result = "NamedPattern" }
+
+  string getName() { named_patterns(this, result) }
 }
diff --git a/swift/ql/lib/codeql/swift/generated/pattern/OptionalSomePattern.qll b/swift/ql/lib/codeql/swift/generated/pattern/OptionalSomePattern.qll
@@ -3,4 +3,11 @@ import codeql.swift.elements.pattern.Pattern
 
 class OptionalSomePatternBase extends @optional_some_pattern, Pattern {
   override string getAPrimaryQlClass() { result = "OptionalSomePattern" }
+
+  Pattern getSubPattern() {
+    exists(Pattern x |
+      optional_some_patterns(this, x) and
+      result = x.resolve()
+    )
+  }
 }
diff --git a/swift/ql/lib/codeql/swift/generated/pattern/ParenPattern.qll b/swift/ql/lib/codeql/swift/generated/pattern/ParenPattern.qll
@@ -3,4 +3,11 @@ import codeql.swift.elements.pattern.Pattern
 
 class ParenPatternBase extends @paren_pattern, Pattern {
   override string getAPrimaryQlClass() { result = "ParenPattern" }
+
+  Pattern getSubPattern() {
+    exists(Pattern x |
+      paren_patterns(this, x) and
+      result = x.resolve()
+    )
+  }
 }
diff --git a/swift/ql/lib/codeql/swift/generated/pattern/TuplePattern.qll b/swift/ql/lib/codeql/swift/generated/pattern/TuplePattern.qll
@@ -3,4 +3,15 @@ import codeql.swift.elements.pattern.Pattern
 
 class TuplePatternBase extends @tuple_pattern, Pattern {
   override string getAPrimaryQlClass() { result = "TuplePattern" }
+
+  Pattern getElement(int index) {
+    exists(Pattern x |
+      tuple_pattern_elements(this, index, x) and
+      result = x.resolve()
+    )
+  }
+
+  Pattern getAnElement() { result = getElement(_) }
+
+  int getNumberOfElements() { result = count(getAnElement()) }
 }
diff --git a/swift/ql/lib/codeql/swift/generated/pattern/TypedPattern.qll b/swift/ql/lib/codeql/swift/generated/pattern/TypedPattern.qll
@@ -1,6 +1,23 @@
 // generated by codegen/codegen.py
 import codeql.swift.elements.pattern.Pattern
+import codeql.swift.elements.typerepr.TypeRepr
 
 class TypedPatternBase extends @typed_pattern, Pattern {
   override string getAPrimaryQlClass() { result = "TypedPattern" }
+
+  Pattern getSubPattern() {
+    exists(Pattern x |
+      typed_patterns(this, x) and
+      result = x.resolve()
+    )
+  }
+
+  TypeRepr getTypeRepr() {
+    exists(TypeRepr x |
+      typed_pattern_type_reprs(this, x) and
+      result = x.resolve()
+    )
+  }
+
+  predicate hasTypeRepr() { exists(getTypeRepr()) }
 }
diff --git a/swift/ql/lib/swift.dbscheme b/swift/ql/lib/swift.dbscheme
@@ -836,43 +836,82 @@ any_patterns(
 );
 
 binding_patterns(
-  unique int id: @binding_pattern
+  unique int id: @binding_pattern,
+  int sub_pattern: @pattern ref
 );
 
 bool_patterns(
-  unique int id: @bool_pattern
+  unique int id: @bool_pattern,
+  boolean value: boolean ref
 );
 
 enum_element_patterns(
-  unique int id: @enum_element_pattern
+  unique int id: @enum_element_pattern,
+  int element: @enum_element_decl ref
+);
+
+#keyset[id]
+enum_element_pattern_sub_patterns(
+  int id: @enum_element_pattern ref,
+  int sub_pattern: @pattern ref
 );
 
 expr_patterns(
-  unique int id: @expr_pattern
+  unique int id: @expr_pattern,
+  int sub_expr: @expr ref
 );
 
 is_patterns(
   unique int id: @is_pattern
 );
 
+#keyset[id]
+is_pattern_cast_type_reprs(
+  int id: @is_pattern ref,
+  int cast_type_repr: @type_repr ref
+);
+
+#keyset[id]
+is_pattern_sub_patterns(
+  int id: @is_pattern ref,
+  int sub_pattern: @pattern ref
+);
+
 named_patterns(
-  unique int id: @named_pattern
+  unique int id: @named_pattern,
+  string name: string ref
 );
 
 optional_some_patterns(
-  unique int id: @optional_some_pattern
+  unique int id: @optional_some_pattern,
+  int sub_pattern: @pattern ref
 );
 
 paren_patterns(
-  unique int id: @paren_pattern
+  unique int id: @paren_pattern,
+  int sub_pattern: @pattern ref
 );
 
 tuple_patterns(
   unique int id: @tuple_pattern
 );
 
+#keyset[id, index]
+tuple_pattern_elements(
+  int id: @tuple_pattern ref,
+  int index: int ref,
+  int element: @pattern ref
+);
+
 typed_patterns(
-  unique int id: @typed_pattern
+  unique int id: @typed_pattern,
+  int sub_pattern: @pattern ref
+);
+
+#keyset[id]
+typed_pattern_type_reprs(
+  int id: @typed_pattern ref,
+  int type_repr: @type_repr ref
 );
 
 brace_stmts(
diff --git a/swift/ql/test/extractor-tests/patterns/all.expected b/swift/ql/test/extractor-tests/patterns/all.expected
diff --git a/swift/ql/test/extractor-tests/patterns/all.ql b/swift/ql/test/extractor-tests/patterns/all.ql
diff --git a/swift/ql/test/extractor-tests/patterns/patterns.swift b/swift/ql/test/extractor-tests/patterns/patterns.swift

Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,6 @@ import codeql.swift.elements.pattern.Pattern`
`3`	`3`
`4`	`4`	`class BoolPatternBase extends @bool_pattern, Pattern {`
`5`	`5`	`override string getAPrimaryQlClass() { result = "BoolPattern" }`
	`6`	`+`
	`7`	`+ boolean getValue() { bool_patterns(this, result) }`
`6`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,6 @@ import codeql.swift.elements.pattern.Pattern`
`3`	`3`
`4`	`4`	`class NamedPatternBase extends @named_pattern, Pattern {`
`5`	`5`	`override string getAPrimaryQlClass() { result = "NamedPattern" }`
	`6`	`+`
	`7`	`+ string getName() { named_patterns(this, result) }`
`6`	`8`	`}`