mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
c3d1304345
Expand macros in the specified source file syntactically (without any
module imports, nor typechecking).
Request would look like:
```
{
key.compilerargs: [...]
key.sourcefile: <file name>
key.sourcetext: <source text> (optional)
key.expansions: [<expansion specifier>...]
}
```
`key.compilerargs` are used for getting plugins search paths. If
`key.sourcetext` is not specified, it's loaded from the file system.
Each `<expansion sepecifier>` is
```
{
key.offset: <offset>
key.modulename: <plugin module name>
key.typename: <macro typename>
key.macro_roles: [<macro role UID>...]
}
```
Clients have to provide the module and type names because that's
semantic.
Response is a `CategorizedEdits` just like (semantic) "ExpandMacro"
refactoring. But without `key.buffer_name`. Nested expnasions are not
supported at this point.
95 lines
3.8 KiB
C++
95 lines
3.8 KiB
C++
//===--- SwiftSyntaxMacro.cpp ---------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2023 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "SwiftLangSupport.h"
|
|
#include "swift/AST/MacroDefinition.h"
|
|
#include "swift/Frontend/Frontend.h"
|
|
#include "swift/Frontend/PrintingDiagnosticConsumer.h"
|
|
#include "swift/IDE/TypeContextInfo.h"
|
|
#include "swift/IDETool/SyntacticMacroExpansion.h"
|
|
#include "clang/AST/ASTContext.h"
|
|
#include "clang/AST/Comment.h"
|
|
#include "clang/AST/Decl.h"
|
|
|
|
using namespace SourceKit;
|
|
using namespace swift;
|
|
using namespace ide;
|
|
|
|
void SwiftLangSupport::expandMacroSyntactically(
|
|
llvm::MemoryBuffer *inputBuf, ArrayRef<const char *> args,
|
|
ArrayRef<MacroExpansionInfo> reqExpansions,
|
|
CategorizedEditsReceiver receiver) {
|
|
|
|
std::string error;
|
|
auto instance = SyntacticMacroExpansions->getInstance(args, error);
|
|
if (!instance) {
|
|
return receiver(
|
|
RequestResult<ArrayRef<CategorizedEdits>>::fromError(error));
|
|
}
|
|
auto &ctx = instance->getASTContext();
|
|
|
|
// Convert 'SourceKit::MacroExpansionInfo' to 'ide::MacroExpansionSpecifier'.
|
|
SmallVector<ide::MacroExpansionSpecifier, 4> expansions;
|
|
for (auto &req : reqExpansions) {
|
|
unsigned offset = req.offset;
|
|
|
|
swift::MacroRoles macroRoles;
|
|
if (req.roles.contains(SourceKit::MacroRole::Expression))
|
|
macroRoles |= swift::MacroRole::Expression;
|
|
if (req.roles.contains(SourceKit::MacroRole::Declaration))
|
|
macroRoles |= swift::MacroRole::Declaration;
|
|
if (req.roles.contains(SourceKit::MacroRole::CodeItem))
|
|
macroRoles |= swift::MacroRole::CodeItem;
|
|
if (req.roles.contains(SourceKit::MacroRole::Accessor))
|
|
macroRoles |= swift::MacroRole::Accessor;
|
|
if (req.roles.contains(SourceKit::MacroRole::MemberAttribute))
|
|
macroRoles |= swift::MacroRole::MemberAttribute;
|
|
if (req.roles.contains(SourceKit::MacroRole::Member))
|
|
macroRoles |= swift::MacroRole::Member;
|
|
if (req.roles.contains(SourceKit::MacroRole::Peer))
|
|
macroRoles |= swift::MacroRole::Peer;
|
|
if (req.roles.contains(SourceKit::MacroRole::Conformance))
|
|
macroRoles |= swift::MacroRole::Conformance;
|
|
|
|
MacroDefinition definition = [&] {
|
|
if (auto *expanded =
|
|
std::get_if<MacroExpansionInfo::ExpandedMacroDefinition>(
|
|
&req.macroDefinition)) {
|
|
SmallVector<ExpandedMacroReplacement, 2> replacements;
|
|
for (auto &reqReplacement : expanded->replacements) {
|
|
replacements.push_back(
|
|
{/*startOffset=*/reqReplacement.range.Offset,
|
|
/*endOffset=*/reqReplacement.range.Offset +
|
|
reqReplacement.range.Length,
|
|
/*parameterIndex=*/reqReplacement.parameterIndex});
|
|
}
|
|
return MacroDefinition::forExpanded(ctx, expanded->expansionText,
|
|
replacements);
|
|
} else if (auto *externalRef =
|
|
std::get_if<MacroExpansionInfo::ExternalMacroReference>(
|
|
&req.macroDefinition)) {
|
|
return MacroDefinition::forExternal(
|
|
ctx.getIdentifier(externalRef->moduleName),
|
|
ctx.getIdentifier(externalRef->typeName));
|
|
} else {
|
|
return MacroDefinition::forUndefined();
|
|
}
|
|
}();
|
|
|
|
expansions.push_back({offset, macroRoles, definition});
|
|
}
|
|
|
|
RequestRefactoringEditConsumer consumer(receiver);
|
|
instance->expandAll(inputBuf, expansions, consumer);
|
|
// consumer automatically send the results on destruction.
|
|
}
|