Files
clice/src/Compiler/Compilation.cpp
2025-07-07 11:32:16 +08:00

254 lines
10 KiB
C++

#include "CompilationUnitImpl.h"
#include "Compiler/Command.h"
#include "Compiler/Compilation.h"
#include "Compiler/Diagnostic.h"
#include "clang/Lex/PreprocessorOptions.h"
#include "clang/Frontend/TextDiagnosticPrinter.h"
#define TRY_OR_RETURN(expr) \
do { \
auto&& macro_result = (expr); \
if(!macro_result.has_value()) { \
return std::unexpected(std::move(macro_result.error())); \
} \
} while(0)
#define ASSIGN_OR_RETURN(var, expr) \
do { \
auto&& macro_result = (expr); \
if(!macro_result.has_value()) { \
return std::unexpected(std::move(macro_result.error())); \
} \
var = std::move(*macro_result); \
} while(0)
namespace clice {
namespace {
std::unexpected<std::string> report_diagnostics(llvm::StringRef message,
std::vector<Diagnostic>& diagnostics) {
std::string error = message.str();
for(auto& diagnostic: diagnostics) {
error += std::format("{}\n", diagnostic.message);
}
return std::unexpected(std::move(error));
}
/// create a `clang::CompilerInvocation` for compilation, it set and reset
/// all necessary arguments and flags for clice compilation.
auto create_invocation(CompilationParams& params,
std::shared_ptr<std::vector<Diagnostic>>& diagnostics,
llvm::IntrusiveRefCntPtr<clang::DiagnosticsEngine>& diagnostic_engine)
-> std::expected<std::unique_ptr<clang::CompilerInvocation>, std::string> {
/// Create clang invocation.
clang::CreateInvocationOptions options = {
.Diags = diagnostic_engine,
.VFS = params.vfs,
};
auto invocation = clang::createInvocation(params.arguments, options);
if(!invocation) {
return report_diagnostics("fail to create compiler invocation", *diagnostics);
}
auto& pp_opts = invocation->getPreprocessorOpts();
assert(!pp_opts.RetainRemappedFileBuffers && "RetainRemappedFileBuffers should be false");
for(auto& [file, buffer]: params.buffers) {
pp_opts.addRemappedFile(file, buffer.release());
}
params.buffers.clear();
auto [pch, bound] = params.pch;
pp_opts.ImplicitPCHInclude = std::move(pch);
if(bound != 0) {
pp_opts.PrecompiledPreambleBytes = {bound, false};
}
auto& header_search_opts = invocation->getHeaderSearchOpts();
for(auto& [name, path]: params.pcms) {
header_search_opts.PrebuiltModuleFiles.try_emplace(name.str(), std::move(path));
}
auto& front_opts = invocation->getFrontendOpts();
front_opts.DisableFree = false;
clang::LangOptions& langOpts = invocation->getLangOpts();
langOpts.CommentOpts.ParseAllComments = true;
langOpts.RetainCommentsFromSystemHeaders = true;
return invocation;
}
template <typename Action, typename Adjuster>
std::expected<CompilationUnit, std::string> clang_compile(CompilationParams& params,
const Adjuster& adjuster) {
auto diagnostics = std::make_shared<std::vector<Diagnostic>>();
auto diagnostic_engine =
clang::CompilerInstance::createDiagnostics(*params.vfs,
new clang::DiagnosticOptions(),
Diagnostic::create(diagnostics));
auto invocation = create_invocation(params, diagnostics, diagnostic_engine);
TRY_OR_RETURN(invocation);
auto instance = std::make_unique<clang::CompilerInstance>();
instance->setInvocation(std::move(*invocation));
instance->setDiagnostics(diagnostic_engine.get());
if(auto remapping = clang::createVFSFromCompilerInvocation(instance->getInvocation(),
instance->getDiagnostics(),
params.vfs)) {
instance->createFileManager(std::move(remapping));
}
if(!instance->createTarget()) {
return std::unexpected("fail to create target");
}
/// Adjust the compiler instance, for example, set preamble or modules.
adjuster(*instance);
auto action = std::make_unique<Action>();
if(!action->BeginSourceFile(*instance, instance->getFrontendOpts().Inputs[0])) {
/// TODO: collect error message from diagnostics.
return report_diagnostics("Failed to begin source file", *diagnostics);
}
auto& pp = instance->getPreprocessor();
// FIXME: clang-tidy, include-fixer, etc?
// `BeginSourceFile` may create new preprocessor, so all operations related to preprocessor
// should be done after `BeginSourceFile`.
/// Collect directives.
llvm::DenseMap<clang::FileID, Directive> directives;
Directive::attach(pp, directives);
/// Collect tokens.
std::optional<clang::syntax::TokenCollector> tokCollector;
/// It is not necessary to collect tokens if we are running code completion.
/// And in fact will cause assertion failure.
if(!instance->hasCodeCompletionConsumer()) {
tokCollector.emplace(pp);
}
if(auto error = action->Execute()) {
return std::unexpected(std::format("Failed to execute action, because {} ", error));
}
if(instance->getDiagnostics().hasFatalErrorOccurred()) {
action->EndSourceFile();
return report_diagnostics("Fetal error occured!!!", *diagnostics);
}
std::optional<clang::syntax::TokenBuffer> tokBuf;
if(tokCollector) {
tokBuf = std::move(*tokCollector).consume();
}
/// FIXME: getDependencies currently return ArrayRef<std::string>, which actually results in
/// extra copy. It would be great to avoid this copy.
std::optional<TemplateResolver> resolver;
if(instance->hasSema()) {
resolver.emplace(instance->getSema());
}
auto impl = new CompilationUnit::Impl{
.interested = pp.getSourceManager().getMainFileID(),
.SM = instance->getSourceManager(),
.action = std::move(action),
.instance = std::move(instance),
.m_resolver = std::move(resolver),
.buffer = std::move(tokBuf),
.m_directives = std::move(directives),
.pathCache = llvm::DenseMap<clang::FileID, llvm::StringRef>(),
.symbolHashCache = llvm::DenseMap<const void*, std::uint64_t>(),
.diagnostics = diagnostics,
};
return CompilationUnit(CompilationUnit::SyntaxOnly, impl);
}
} // namespace
std::expected<CompilationUnit, std::string> preprocess(CompilationParams& params) {
return clang_compile<clang::PreprocessOnlyAction>(params, [](auto&) {});
}
std::expected<CompilationUnit, std::string> compile(CompilationParams& params) {
return clang_compile<clang::SyntaxOnlyAction>(params, [](auto&) {});
}
std::expected<CompilationUnit, std::string> complete(CompilationParams& params,
clang::CodeCompleteConsumer* consumer) {
auto& [file, offset] = params.completion;
/// The location of clang is 1-1 based.
std::uint32_t line = 1;
std::uint32_t column = 1;
/// FIXME:
assert(params.buffers.size() == 1);
llvm::StringRef content = params.buffers.begin()->second->getBuffer();
for(auto c: content.substr(0, offset)) {
if(c == '\n') {
line += 1;
column = 1;
continue;
}
column += 1;
}
return clang_compile<clang::SyntaxOnlyAction>(params, [&](clang::CompilerInstance& instance) {
/// Set options to run code completion.
instance.getFrontendOpts().CodeCompletionAt.FileName = std::move(file);
instance.getFrontendOpts().CodeCompletionAt.Line = line;
instance.getFrontendOpts().CodeCompletionAt.Column = column;
instance.setCodeCompletionConsumer(consumer);
});
}
std::expected<CompilationUnit, std::string> compile(CompilationParams& params, PCHInfo& out) {
/// assert(params.bound.has_value() && "Preamble bounds is required to build PCH");
out.path = params.outPath.str();
/// out.preamble = params.content.substr(0, *params.bound);
/// out.command = params.arguments.str();
/// FIXME: out.deps = info->deps();
return clang_compile<clang::GeneratePCHAction>(params, [&](clang::CompilerInstance& instance) {
/// Set options to generate PCH.
instance.getFrontendOpts().OutputFile = params.outPath.str();
instance.getFrontendOpts().ProgramAction = clang::frontend::GeneratePCH;
instance.getPreprocessorOpts().GeneratePreamble = true;
instance.getLangOpts().CompilingPCH = true;
});
}
std::expected<CompilationUnit, std::string> compile(CompilationParams& params, PCMInfo& out) {
for(auto& [name, path]: params.pcms) {
out.mods.emplace_back(name);
}
out.path = params.outPath.str();
return clang_compile<clang::GenerateReducedModuleInterfaceAction>(
params,
[&](clang::CompilerInstance& instance) {
/// Set options to generate PCH.
instance.getFrontendOpts().OutputFile = params.outPath.str();
instance.getFrontendOpts().ProgramAction =
clang::frontend::GenerateReducedModuleInterface;
out.srcPath = instance.getFrontendOpts().Inputs[0].getFile();
});
}
} // namespace clice