[ASTGen] Rename macro related @_cdecl functions to swift_Macros_*

Rename @_cdecl name of functions moved to swiftMacros module.
Also move those function decls to dedicated 'Macros.h' header.

Author: rintaro

include/swift/Bridging/ASTGen.h

@@ -10,6 +10,9 @@
 //
 //===----------------------------------------------------------------------===//
 
+#ifndef SWIFT_BRIDGING_ASTGEN_H
+#define SWIFT_BRIDGING_ASTGEN_H
+
 #include "swift/AST/ASTBridging.h"
 #include "swift/Parse/ParseBridging.h"
 
@@ -61,51 +64,6 @@ void swift_ASTGen_buildTopLevelASTNodes(
 
 void swift_ASTGen_freeBridgedString(BridgedStringRef);
 
-void *_Nonnull swift_ASTGen_resolveExternalMacro(
-    const char *_Nonnull moduleName, const char *_Nonnull typeName,
-    void *_Nonnull opaquePluginHandle);
-void swift_ASTGen_destroyExternalMacro(void *_Nonnull macro);
-
-bool swift_ASTGen_checkDefaultArgumentMacroExpression(
-    void *_Nonnull diagEngine, void *_Nonnull sourceFile,
-    const void *_Nonnull macroSourceLocation);
-
-ptrdiff_t swift_ASTGen_checkMacroDefinition(
-    void *_Nonnull diagEngine, BridgedStringRef sourceFileBuffer,
-    BridgedStringRef macroDeclText,
-    BridgedStringRef *_Nonnull expansionSourceOutPtr,
-    ptrdiff_t *_Nullable *_Nonnull replacementsPtr,
-    ptrdiff_t *_Nonnull numReplacements,
-    ptrdiff_t *_Nullable *_Nonnull genericReplacementsPtr,
-    ptrdiff_t *_Nonnull numGenericReplacements);
-void swift_ASTGen_freeExpansionReplacements(
-    ptrdiff_t *_Nullable replacementsPtr, ptrdiff_t numReplacements);
-
-ptrdiff_t swift_ASTGen_expandFreestandingMacro(
-    void *_Nonnull diagEngine, const void *_Nonnull macro,
-    const char *_Nonnull discriminator, uint8_t rawMacroRole,
-    void *_Nonnull sourceFile, const void *_Nullable sourceLocation,
-    BridgedStringRef *_Nonnull evaluatedSourceOut);
-
-ptrdiff_t swift_ASTGen_expandAttachedMacro(
-    void *_Nonnull diagEngine, const void *_Nonnull macro,
-    const char *_Nonnull discriminator, const char *_Nonnull qualifiedType,
-    const char *_Nonnull conformances, uint8_t rawMacroRole,
-    void *_Nonnull customAttrSourceFile,
-    const void *_Nullable customAttrSourceLocation,
-    void *_Nonnull declarationSourceFile,
-    const void *_Nullable declarationSourceLocation,
-    void *_Nullable parentDeclSourceFile,
-    const void *_Nullable parentDeclSourceLocation,
-    BridgedStringRef *_Nonnull evaluatedSourceOut);
-
-bool swift_ASTGen_initializePlugin(void *_Nonnull handle,
-                                   void *_Nullable diagEngine);
-void swift_ASTGen_deinitializePlugin(void *_Nonnull handle);
-bool swift_ASTGen_pluginServerLoadLibraryPlugin(
-    void *_Nonnull handle, const char *_Nonnull libraryPath,
-    const char *_Nonnull moduleName, BridgedStringRef *_Nullable errorOut);
-
 /// Build a TypeRepr for AST node for the type at the given source location in
 /// the specified file.
 swift::TypeRepr *_Nullable swift_ASTGen_buildTypeRepr(
@@ -162,3 +120,5 @@ void swift_ASTGen_freeConfiguredRegions(
 #ifdef __cplusplus
 }
 #endif
+
+#endif // SWIFT_BRIDGING_ASTGEN_H

include/swift/Bridging/Macros.h

@@ -0,0 +1,71 @@
+//===--- Macros.h -----------------------------------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2024 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_BRIDGING_MACROS_H
+#define SWIFT_BRIDGING_MACROS_H
+
+#include "swift/Basic/BasicBridging.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+void *_Nonnull swift_Macros_resolveExternalMacro(
+    const char *_Nonnull moduleName, const char *_Nonnull typeName,
+    void *_Nonnull opaquePluginHandle);
+void swift_Macros_destroyExternalMacro(void *_Nonnull macro);
+
+bool swift_Macros_checkDefaultArgumentMacroExpression(
+    void *_Nonnull diagEngine, void *_Nonnull sourceFile,
+    const void *_Nonnull macroSourceLocation);
+
+ptrdiff_t swift_Macros_checkMacroDefinition(
+    void *_Nonnull diagEngine, BridgedStringRef sourceFileBuffer,
+    BridgedStringRef macroDeclText,
+    BridgedStringRef *_Nonnull expansionSourceOutPtr,
+    ptrdiff_t *_Nullable *_Nonnull replacementsPtr,
+    ptrdiff_t *_Nonnull numReplacements,
+    ptrdiff_t *_Nullable *_Nonnull genericReplacementsPtr,
+    ptrdiff_t *_Nonnull numGenericReplacements);
+void swift_Macros_freeExpansionReplacements(
+    ptrdiff_t *_Nullable replacementsPtr, ptrdiff_t numReplacements);
+
+ptrdiff_t swift_Macros_expandFreestandingMacro(
+    void *_Nonnull diagEngine, const void *_Nonnull macro,
+    const char *_Nonnull discriminator, uint8_t rawMacroRole,
+    void *_Nonnull sourceFile, const void *_Nullable sourceLocation,
+    BridgedStringRef *_Nonnull evaluatedSourceOut);
+
+ptrdiff_t swift_Macros_expandAttachedMacro(
+    void *_Nonnull diagEngine, const void *_Nonnull macro,
+    const char *_Nonnull discriminator, const char *_Nonnull qualifiedType,
+    const char *_Nonnull conformances, uint8_t rawMacroRole,
+    void *_Nonnull customAttrSourceFile,
+    const void *_Nullable customAttrSourceLocation,
+    void *_Nonnull declarationSourceFile,
+    const void *_Nullable declarationSourceLocation,
+    void *_Nullable parentDeclSourceFile,
+    const void *_Nullable parentDeclSourceLocation,
+    BridgedStringRef *_Nonnull evaluatedSourceOut);
+
+bool swift_Macros_initializePlugin(void *_Nonnull handle,
+                                   void *_Nullable diagEngine);
+void swift_Macros_deinitializePlugin(void *_Nonnull handle);
+bool swift_Macros_pluginServerLoadLibraryPlugin(
+    void *_Nonnull handle, const char *_Nonnull libraryPath,
+    const char *_Nonnull moduleName, BridgedStringRef *_Nullable errorOut);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // SWIFT_BRIDGING_MACROS_H

lib/ASTGen/Sources/Macros/Macros.swift

@@ -45,7 +45,7 @@ extension MacroRole {
   }
 }
 
-@_cdecl("swift_ASTGen_resolveExternalMacro")
+@_cdecl("swift_Macros_resolveExternalMacro")
 public func resolveExternalMacro(
   moduleName: UnsafePointer<CChar>,
   typeName: UnsafePointer<CChar>,
@@ -65,7 +65,7 @@ public func resolveExternalMacro(
   return UnsafeRawPointer(exportedPtr)
 }
 
-@_cdecl("swift_ASTGen_destroyExternalMacro")
+@_cdecl("swift_Macros_destroyExternalMacro")
 public func destroyExternalMacro(
   macroPtr: UnsafeMutableRawPointer
 ) {
@@ -139,7 +139,7 @@ fileprivate func identifierFromStringLiteral(_ node: ExprSyntax) -> String? {
 ///
 /// - Returns: `true` if all restrictions are satisfied, `false` if diagnostics
 /// are emitted.
-@_cdecl("swift_ASTGen_checkDefaultArgumentMacroExpression")
+@_cdecl("swift_Macros_checkDefaultArgumentMacroExpression")
 func checkDefaultArgumentMacroExpression(
   diagEnginePtr: UnsafeMutableRawPointer,
   sourceFilePtr: UnsafeRawPointer,
@@ -196,7 +196,7 @@ func checkDefaultArgumentMacroExpression(
 /// (start offset, end offset, parameter index): the [start offset, end offset)
 /// range in the macro expansion expression should be replaced with the
 /// argument matching the corresponding parameter.
-@_cdecl("swift_ASTGen_checkMacroDefinition")
+@_cdecl("swift_Macros_checkMacroDefinition")
 func checkMacroDefinition(
   diagEnginePtr: UnsafeMutableRawPointer,
   sourceFileBuffer: BridgedStringRef,
@@ -399,7 +399,7 @@ func checkMacroDefinition(
   }
 }
 
-@_cdecl("swift_ASTGen_freeExpansionReplacements")
+@_cdecl("swift_Macros_freeExpansionReplacements")
 public func freeExpansionReplacements(
   pointer: UnsafeMutablePointer<Int>?,
   numReplacements: Int
@@ -420,7 +420,7 @@ func makeExpansionOutputResult(
   return 0
 }
 
-@_cdecl("swift_ASTGen_expandFreestandingMacro")
+@_cdecl("swift_Macros_expandFreestandingMacro")
 @usableFromInline
 func expandFreestandingMacro(
   diagEnginePtr: UnsafeMutableRawPointer,
@@ -556,7 +556,7 @@ func expandFreestandingMacroImpl(
   }
 }
 
-@_cdecl("swift_ASTGen_expandAttachedMacro")
+@_cdecl("swift_Macros_expandAttachedMacro")
 @usableFromInline
 func expandAttachedMacro(
   diagEnginePtr: UnsafeMutableRawPointer,

lib/ASTGen/Sources/Macros/PluginHost.swift

@@ -25,7 +25,7 @@ enum PluginError: String, Error, CustomStringConvertible {
   var description: String { rawValue }
 }
 
-@_cdecl("swift_ASTGen_initializePlugin")
+@_cdecl("swift_Macros_initializePlugin")
 public func _initializePlugin(
   opaqueHandle: UnsafeMutableRawPointer,
   cxxDiagnosticEngine: UnsafeMutableRawPointer?
@@ -42,7 +42,7 @@ public func _initializePlugin(
   }
 }
 
-@_cdecl("swift_ASTGen_deinitializePlugin")
+@_cdecl("swift_Macros_deinitializePlugin")
 public func _deinitializePlugin(
   opaqueHandle: UnsafeMutableRawPointer
 ) {
@@ -52,8 +52,8 @@ public func _deinitializePlugin(
 
 /// Load the library plugin in the plugin server.
 /// This should be called inside lock.
-@_cdecl("swift_ASTGen_pluginServerLoadLibraryPlugin")
-func swift_ASTGen_pluginServerLoadLibraryPlugin(
+@_cdecl("swift_Macros_pluginServerLoadLibraryPlugin")
+func swift_Macros_pluginServerLoadLibraryPlugin(
   opaqueHandle: UnsafeMutableRawPointer,
   libraryPath: UnsafePointer<CChar>,
   moduleName: UnsafePointer<CChar>,

lib/Sema/TypeCheckDeclPrimary.cpp

@@ -56,7 +56,7 @@
 #include "swift/Basic/Assertions.h"
 #include "swift/Basic/Defer.h"
 #include "swift/Basic/Statistic.h"
-#include "swift/Bridging/ASTGen.h"
+#include "swift/Bridging/Macros.h"
 #include "swift/Parse/Lexer.h"
 #include "swift/Parse/Parser.h"
 #include "swift/Serialization/SerializedModuleLoader.h"
@@ -1153,7 +1153,7 @@ static bool checkExpressionMacroDefaultValueRestrictions(ParamDecl *param) {
 #if SWIFT_BUILD_SWIFT_SYNTAX
   auto *DC = param->getInnermostDeclContext();
   const SourceFile *SF = DC->getParentSourceFile();
-  return swift_ASTGen_checkDefaultArgumentMacroExpression(
+  return swift_Macros_checkDefaultArgumentMacroExpression(
       &ctx.Diags, SF->getExportedSourceFile(),
       initExpr->getLoc().getOpaquePointerValue());
 #else

lib/Sema/TypeCheckMacros.cpp

@@ -40,6 +40,7 @@
 #include "swift/Basic/SourceManager.h"
 #include "swift/Basic/StringExtras.h"
 #include "swift/Bridging/ASTGen.h"
+#include "swift/Bridging/Macros.h"
 #include "swift/Demangling/Demangler.h"
 #include "swift/Demangling/ManglingMacros.h"
 #include "swift/Parse/Lexer.h"
@@ -121,7 +122,7 @@ MacroDefinition MacroDefinitionRequest::evaluate(
   ptrdiff_t *genericReplacements = nullptr;
   ptrdiff_t numGenericReplacements = 0;
 
-  // Parse 'macro' decl in swift_ASTGen_checkMacroDefinition.
+  // Parse 'macro' decl in swift_Macros_checkMacroDefinition.
   // NOTE: We don't use source->getExportedSourceFile() because it parses the
   // entire source buffer, which we don't want. Usually 'macro' decl is not in
   // the same file as the expansion, so we only want to parse only the decl.
@@ -133,16 +134,16 @@ MacroDefinition MacroDefinitionRequest::evaluate(
       SM.extractText(Lexer::getCharSourceRangeFromSourceRange(
           SM, macro->getSourceRangeIncludingAttrs()));
 
-  auto checkResult = swift_ASTGen_checkMacroDefinition(
+  auto checkResult = swift_Macros_checkMacroDefinition(
       &ctx.Diags, sourceFileText, macroDeclText, &externalMacroName,
       &replacements, &numReplacements, &genericReplacements,
       &numGenericReplacements);
 
   // Clean up after the call.
   SWIFT_DEFER {
     swift_ASTGen_freeBridgedString(externalMacroName);
-    swift_ASTGen_freeExpansionReplacements(replacements, numReplacements);
-    // swift_ASTGen_freeExpansionGenericReplacements(genericReplacements, numGenericReplacements); // FIXME: !!!!!!
+    swift_Macros_freeExpansionReplacements(replacements, numReplacements);
+    // swift_Macros_freeExpansionGenericReplacements(genericReplacements, numGenericReplacements); // FIXME: !!!!!!
   };
 
   if (checkResult < 0 && ctx.CompletionCallback) {
@@ -247,20 +248,20 @@ initializePlugin(ASTContext &ctx, CompilerPlugin *plugin, StringRef libraryPath,
   // But plugin loading is in libAST and it can't link ASTGen symbols.
   if (!plugin->isInitialized()) {
 #if SWIFT_BUILD_SWIFT_SYNTAX
-    if (!swift_ASTGen_initializePlugin(plugin, &ctx.Diags)) {
+    if (!swift_Macros_initializePlugin(plugin, &ctx.Diags)) {
       return llvm::createStringError(llvm::inconvertibleErrorCode(),
                                      "'%s' produced malformed response",
                                      plugin->getPath().data());
     }
 
     // Resend the compiler capability on reconnect.
     auto *callback = new std::function<void(void)>([plugin]() {
-      (void)swift_ASTGen_initializePlugin(plugin, /*diags=*/nullptr);
+      (void)swift_Macros_initializePlugin(plugin, /*diags=*/nullptr);
     });
     plugin->addOnReconnect(callback);
 
     plugin->setCleanup([plugin, callback] {
-      swift_ASTGen_deinitializePlugin(plugin);
+      swift_Macros_deinitializePlugin(plugin);
       delete callback;
     });
 #endif
@@ -281,7 +282,7 @@ initializePlugin(ASTContext &ctx, CompilerPlugin *plugin, StringRef libraryPath,
     std::string moduleNameStr(moduleName.str());
 
     BridgedStringRef bridgedErrorOut{nullptr, 0};
-    bool loaded = swift_ASTGen_pluginServerLoadLibraryPlugin(
+    bool loaded = swift_Macros_pluginServerLoadLibraryPlugin(
         plugin, resolvedLibraryPathStr.c_str(), moduleNameStr.c_str(),
         &bridgedErrorOut);
 
@@ -300,7 +301,7 @@ initializePlugin(ASTContext &ctx, CompilerPlugin *plugin, StringRef libraryPath,
     // Set a callback to load the library again on reconnections.
     auto *callback = new std::function<void(void)>(
         [plugin, resolvedLibraryPathStr, moduleNameStr]() {
-          (void)swift_ASTGen_pluginServerLoadLibraryPlugin(
+          (void)swift_Macros_pluginServerLoadLibraryPlugin(
               plugin, resolvedLibraryPathStr.c_str(), moduleNameStr.c_str(),
               /*errorOut=*/nullptr);
         });
@@ -385,10 +386,10 @@ static ExternalMacroDefinition resolveExternalMacro(ASTContext &ctx,
                                                     Identifier moduleName,
                                                     Identifier typeName) {
 #if SWIFT_BUILD_SWIFT_SYNTAX
-  if (auto *macro = swift_ASTGen_resolveExternalMacro(moduleName.get(),
+  if (auto *macro = swift_Macros_resolveExternalMacro(moduleName.get(),
                                                       typeName.get(), plugin)) {
     // Make sure we clean up after the macro.
-    ctx.addCleanup([macro]() { swift_ASTGen_destroyExternalMacro(macro); });
+    ctx.addCleanup([macro]() { swift_Macros_destroyExternalMacro(macro); });
     return ExternalMacroDefinition::success(macro);
   }
   // NOTE: this is not reachable because executable macro resolution always
@@ -1163,7 +1164,7 @@ evaluateFreestandingMacro(FreestandingMacroExpansion *expansion,
 
     BridgedStringRef evaluatedSourceOut{nullptr, 0};
     assert(!externalDef.isError());
-    swift_ASTGen_expandFreestandingMacro(
+    swift_Macros_expandFreestandingMacro(
         &ctx.Diags, externalDef.get(), discriminator->c_str(),
         getRawMacroRole(macroRole), astGenSourceFile,
         expansion->getSourceRange().Start.getOpaquePointerValue(),
@@ -1487,7 +1488,7 @@ static SourceFile *evaluateAttachedMacro(MacroDecl *macro, Decl *attachedTo,
 
     BridgedStringRef evaluatedSourceOut{nullptr, 0};
     assert(!externalDef.isError());
-    swift_ASTGen_expandAttachedMacro(
+    swift_Macros_expandAttachedMacro(
         &ctx.Diags, externalDef.get(), discriminator->c_str(),
         extendedType.c_str(), conformanceList.c_str(), getRawMacroRole(role),
         astGenAttrSourceFile, attr->AtLoc.getOpaquePointerValue(),