Swift: extract MacroDecl

Author: AlexDenisov

swift/extractor/infra/SwiftDispatcher.h

@@ -36,7 +36,8 @@ class SwiftDispatcher {
                               const swift::TypeBase*,
                               const swift::CapturedValue*,
                               const swift::PoundAvailableInfo*,
-                              const swift::AvailabilitySpec*>;
+                              const swift::AvailabilitySpec*,
+                              const swift::MacroRoleAttr*>;
 
  public:
   // all references and pointers passed as parameters to this constructor are supposed to outlive
@@ -334,6 +335,7 @@ class SwiftDispatcher {
   virtual void visit(const swift::TypeRepr* typeRepr, swift::Type type) = 0;
   virtual void visit(const swift::TypeBase* type) = 0;
   virtual void visit(const swift::CapturedValue* capture) = 0;
+  virtual void visit(const swift::MacroRoleAttr* attr) = 0;
 
   template <typename T>
   requires(!std::derived_from<T, swift::TypeRepr>) void visit(const T* e, swift::Type) { visit(e); }

swift/extractor/infra/SwiftLocationExtractor.h

@@ -28,6 +28,13 @@ concept HasStartAndEndLoc = requires(T e) {
 }
 &&!(HasSourceRange<T>);
 
+template <typename T>
+concept HasLAndRParenLoc = requires(T e) {
+  e.getLParenLoc();
+  e.getRParenLoc();
+}
+&&!(HasSourceRange<T>)&&!(HasStartAndEndLoc<T>);
+
 template <typename T>
 concept HasOneLoc = requires(T e) {
   e.getLoc();
@@ -50,6 +57,13 @@ swift::SourceRange getSourceRange(const HasStartAndEndLoc auto& locatable) {
   return {locatable.getStartLoc()};
 }
 
+swift::SourceRange getSourceRange(const HasLAndRParenLoc auto& locatable) {
+  if (locatable.getLParenLoc() && locatable.getRParenLoc()) {
+    return {locatable.getLParenLoc(), locatable.getRParenLoc()};
+  }
+  return {locatable.getLParenLoc()};
+}
+
 swift::SourceRange getSourceRange(const HasOneLoc auto& locatable) {
   return {locatable.getLoc()};
 }

swift/extractor/infra/SwiftTagTraits.h

@@ -228,7 +228,7 @@ MAP(swift::Decl, DeclTag)
       MAP(swift::FuncDecl, AccessorOrNamedFunctionTag)
         MAP_CONCRETE(swift::FuncDecl, NamedFunctionTag)
         MAP(swift::AccessorDecl, AccessorTag)
-    MAP(swift::MacroDecl, void)  // TODO (introduced in 5.8)
+    MAP(swift::MacroDecl, MacroDeclTag)
     MAP(swift::EnumElementDecl, EnumElementDeclTag)
   MAP(swift::ExtensionDecl, ExtensionDeclTag)
   MAP(swift::TopLevelCodeDecl, TopLevelCodeDeclTag)
@@ -350,6 +350,7 @@ MAP(swift::AvailabilitySpec, AvailabilitySpecTag)
   MAP(swift::OtherPlatformAvailabilitySpec, OtherAvailabilitySpecTag)
 
 MAP(swift::PoundAvailableInfo, AvailabilityInfoTag)
+MAP(swift::MacroRoleAttr, MacroRoleTag)
 
 // clang-format on
 #undef MAP

swift/extractor/translators/DeclTranslator.cpp

@@ -374,4 +374,32 @@ codeql::CapturedDecl DeclTranslator::translateCapturedValue(const swift::Capture
   entry.is_escaping = !capture.isNoEscape();
   return entry;
 }
+
+codeql::MacroDecl DeclTranslator::translateMacroDecl(const swift::MacroDecl& decl) {
+  auto entry = createEntry(decl);
+  fillValueDecl(decl, entry);
+  fillGenericContext(decl, entry);
+  entry.name = constructName(decl.getName());
+  for (auto attr : decl.getAttrs().getAttributes<swift::MacroRoleAttr>()) {
+    entry.roles.emplace_back(dispatcher.fetchLabel(attr));
+  }
+  if (decl.getParameterList()) {
+    for (auto param : *decl.getParameterList()) {
+      entry.parameters.emplace_back(dispatcher.fetchLabel(param));
+    }
+  }
+  return entry;
+}
+
+codeql::MacroRole DeclTranslator::translateMacroRoleAttr(const swift::MacroRoleAttr& attr) {
+  auto entry = dispatcher.createEntry(attr);
+  entry.kind = static_cast<uint32_t>(attr.getMacroRole());
+  entry.macro_syntax = static_cast<uint8_t>(attr.getMacroSyntax());
+  entry.conformances = dispatcher.fetchRepeatedLabels(attr.getConformances());
+  for (auto& declName : attr.getNames()) {
+    entry.names.emplace_back(constructName(declName.getName()));
+  }
+  return entry;
+}
+
 }  // namespace codeql

swift/extractor/translators/DeclTranslator.h

@@ -49,6 +49,8 @@ class DeclTranslator : public AstTranslatorBase<DeclTranslator> {
   codeql::PoundDiagnosticDecl translatePoundDiagnosticDecl(const swift::PoundDiagnosticDecl& decl);
   codeql::MissingMemberDecl translateMissingMemberDecl(const swift::MissingMemberDecl& decl);
   codeql::CapturedDecl translateCapturedValue(const swift::CapturedValue& capture);
+  codeql::MacroDecl translateMacroDecl(const swift::MacroDecl& decl);
+  codeql::MacroRole translateMacroRoleAttr(const swift::MacroRoleAttr& attr);
 
  private:
   void fillFunction(const swift::AbstractFunctionDecl& decl, codeql::Function& entry);

swift/extractor/translators/SwiftVisitor.h

@@ -53,6 +53,8 @@ class SwiftVisitor : private SwiftDispatcher {
     declTranslator.translateAndEmit(*capture);
   }
 
+  void visit(const swift::MacroRoleAttr* attr) override { declTranslator.translateAndEmit(*attr); }
+
   DeclTranslator declTranslator{*this};
   ExprTranslator exprTranslator{*this};
   StmtTranslator stmtTranslator{*this};

swift/extractor/translators/TranslatorBase.h

@@ -89,6 +89,10 @@ class AstTranslatorBase : private swift::ASTVisitor<CrtpSubclass>,
     dispatcher.emit(static_cast<CrtpSubclass*>(this)->translateCapturedValue(e));
   }
 
+  void translateAndEmit(const swift::MacroRoleAttr& attr) {
+    dispatcher.emit(static_cast<CrtpSubclass*>(this)->translateMacroRoleAttr(attr));
+  }
+
  private:
   friend class swift::ASTVisitor<CrtpSubclass>;