Swift: extract PoundDiagnosticDecl

Author: redsun82

swift/extractor/translators/DeclTranslator.cpp

@@ -401,4 +401,23 @@ std::optional<codeql::OpaqueTypeDecl> DeclTranslator::translateOpaqueTypeDecl(
   return std::nullopt;
 }
 
+static int translateDiagnosticsKind(swift::DiagnosticKind kind) {
+  switch (kind) {
+    case swift::DiagnosticKind::Error:
+      return 1;
+    case swift::DiagnosticKind::Warning:
+      return 2;
+    default:
+      return 0;
+  }
+}
+
+codeql::PoundDiagnosticDecl DeclTranslator::translatePoundDiagnosticDecl(
+    const swift::PoundDiagnosticDecl& decl) {
+  auto entry = createEntry(decl);
+  entry.kind = translateDiagnosticsKind(decl.getKind());
+  entry.message = dispatcher.fetchLabel(decl.getMessage());
+  return entry;
+}
+
 }  // namespace codeql

swift/extractor/translators/DeclTranslator.h

@@ -46,6 +46,7 @@ class DeclTranslator : public AstTranslatorBase<DeclTranslator> {
   std::optional<codeql::ModuleDecl> translateModuleDecl(const swift::ModuleDecl& decl);
   codeql::IfConfigDecl translateIfConfigDecl(const swift::IfConfigDecl& decl);
   std::optional<codeql::OpaqueTypeDecl> translateOpaqueTypeDecl(const swift::OpaqueTypeDecl& decl);
+  codeql::PoundDiagnosticDecl translatePoundDiagnosticDecl(const swift::PoundDiagnosticDecl& decl);
 
  private:
   std::string mangledName(const swift::ValueDecl& decl);

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

@@ -2,6 +2,12 @@ private import codeql.swift.generated.decl.PoundDiagnosticDecl
 
 class PoundDiagnosticDecl extends Generated::PoundDiagnosticDecl {
   override string toString() {
-    result = "#..." // TODO: Once we extract whether this is an error or a warning we can improve this.
+    this.isError() and result = "#error(...)"
+    or
+    this.isWarning() and result = "#warning(...)"
   }
+
+  predicate isError() { this.getKind() = 1 }
+
+  predicate isWarning() { this.getKind() = 2 }
 }

swift/ql/lib/codeql/swift/generated/ParentChild.qll

@@ -358,14 +358,17 @@ private module Impl {
   private Element getImmediateChildOfPoundDiagnosticDecl(
     PoundDiagnosticDecl e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bDecl, int n |
+    exists(int b, int bDecl, int n, int nMessage |
       b = 0 and
       bDecl = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfDecl(e, i, _)) | i) and
       n = bDecl and
+      nMessage = n + 1 and
       (
         none()
         or
         result = getImmediateChildOfDecl(e, index - b, partialPredicateCall)
+        or
+        index = n and result = e.getImmediateMessage() and partialPredicateCall = "Message()"
       )
     )
   }

swift/ql/lib/codeql/swift/generated/Raw.qll

@@ -123,6 +123,10 @@ module Raw {
 
   class PoundDiagnosticDecl extends @pound_diagnostic_decl, Decl {
     override string toString() { result = "PoundDiagnosticDecl" }
+
+    int getKind() { pound_diagnostic_decls(this, result, _) }
+
+    StringLiteralExpr getMessage() { pound_diagnostic_decls(this, _, result) }
   }
 
   class PrecedenceGroupDecl extends @precedence_group_decl, Decl {

swift/ql/lib/codeql/swift/generated/decl/PoundDiagnosticDecl.qll

@@ -2,9 +2,38 @@
 private import codeql.swift.generated.Synth
 private import codeql.swift.generated.Raw
 import codeql.swift.elements.decl.Decl
+import codeql.swift.elements.expr.StringLiteralExpr
 
 module Generated {
+  /**
+   * A diagnostic directive, which is either `#error` or `#warning`.
+   */
   class PoundDiagnosticDecl extends Synth::TPoundDiagnosticDecl, Decl {
     override string getAPrimaryQlClass() { result = "PoundDiagnosticDecl" }
+
+    /**
+     * Gets the This is 1 for `#error` and 2 for `#warning`.
+     */
+    int getKind() {
+      result = Synth::convertPoundDiagnosticDeclToRaw(this).(Raw::PoundDiagnosticDecl).getKind()
+    }
+
+    /**
+     * Gets the message of this pound diagnostic declaration.
+     *
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behavior of both the `Immediate` and non-`Immediate` versions.
+     */
+    StringLiteralExpr getImmediateMessage() {
+      result =
+        Synth::convertStringLiteralExprFromRaw(Synth::convertPoundDiagnosticDeclToRaw(this)
+              .(Raw::PoundDiagnosticDecl)
+              .getMessage())
+    }
+
+    /**
+     * Gets the message of this pound diagnostic declaration.
+     */
+    final StringLiteralExpr getMessage() { result = getImmediateMessage().resolve() }
   }
 }

swift/ql/lib/swift.dbscheme

@@ -281,7 +281,9 @@ pattern_binding_decl_patterns(  //dir=decl
 );
 
 pound_diagnostic_decls(  //dir=decl
-  unique int id: @pound_diagnostic_decl
+  unique int id: @pound_diagnostic_decl,
+  int kind: int ref,
+  int message: @string_literal_expr_or_none ref
 );
 
 precedence_group_decls(  //dir=decl
@@ -2443,6 +2445,11 @@ variadic_sequence_types(  //dir=type
 | @unspecified_element
 ;
 
+@string_literal_expr_or_none =
+  @string_literal_expr
+| @unspecified_element
+;
+
 @tap_expr_or_none =
   @tap_expr
 | @unspecified_element

swift/ql/test/extractor-tests/generated/decl/PoundDiagnosticDecl/MISSING_SOURCE.txt

@@ -0,0 +1,2 @@
+| diagnostics.swift:2:1:2:25 | #warning(...) | getModule: | file://:0:0:0:0 | diagnostics | getKind: | 2 | getMessage: | diagnostics.swift:2:10:2:10 | I'm a warning |
+| diagnostics.swift:3:1:3:26 | #error(...) | getModule: | file://:0:0:0:0 | diagnostics | getKind: | 1 | getMessage: | diagnostics.swift:3:8:3:8 | And I'm an error |

swift/ql/test/extractor-tests/generated/decl/PoundDiagnosticDecl/PoundDiagnosticDecl.expected

@@ -0,0 +1,12 @@
+// generated by codegen/codegen.py
+import codeql.swift.elements
+import TestUtils
+
+from PoundDiagnosticDecl x, ModuleDecl getModule, int getKind, StringLiteralExpr getMessage
+where
+  toBeTested(x) and
+  not x.isUnknown() and
+  getModule = x.getModule() and
+  getKind = x.getKind() and
+  getMessage = x.getMessage()
+select x, "getModule:", getModule, "getKind:", getKind, "getMessage:", getMessage