| 1 |
//===--- Compiler.h ----------------------------------------------*- C++-*-===// |
| 2 |
// |
| 3 |
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 |
// See https://llvm.org/LICENSE.txt for license information. |
| 5 |
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 6 |
// |
| 7 |
//===----------------------------------------------------------------------===// |
| 8 |
// |
| 9 |
// Shared utilities for invoking the clang compiler. |
| 10 |
// Most callers will use this through Preamble/ParsedAST, but some features like |
| 11 |
// CodeComplete run their own compile actions that share these low-level pieces. |
| 12 |
// |
| 13 |
//===----------------------------------------------------------------------===// |
| 14 |
|
| 15 |
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_COMPILER_H |
| 16 |
#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_COMPILER_H |
| 17 |
|
| 18 |
#include "FeatureModule.h" |
| 19 |
#include "TidyProvider.h" |
| 20 |
#include "index/Index.h" |
| 21 |
#include "support/ThreadsafeFS.h" |
| 22 |
#include "clang/Frontend/CompilerInstance.h" |
| 23 |
#include "clang/Frontend/PrecompiledPreamble.h" |
| 24 |
#include "clang/Tooling/CompilationDatabase.h" |
| 25 |
#include <memory> |
| 26 |
#include <vector> |
| 27 |
|
| 28 |
namespace clang { |
| 29 |
namespace clangd { |
| 30 |
|
| 31 |
class IgnoreDiagnostics : public DiagnosticConsumer { |
| 32 |
public: |
| 33 |
static void log(DiagnosticsEngine::Level DiagLevel, |
| 34 |
const clang::Diagnostic &Info); |
| 35 |
|
| 36 |
void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, |
| 37 |
const clang::Diagnostic &Info) override; |
| 38 |
}; |
| 39 |
|
| 40 |
// Options to run clang e.g. when parsing AST. |
| 41 |
struct ParseOptions { |
| 42 |
bool PreambleParseForwardingFunctions = false; |
| 43 |
|
| 44 |
bool ImportInsertions = false; |
| 45 |
}; |
| 46 |
|
| 47 |
/// Information required to run clang, e.g. to parse AST or do code completion. |
| 48 |
struct ParseInputs { |
| 49 |
tooling::CompileCommand CompileCommand; |
| 50 |
const ThreadsafeFS *TFS; |
| 51 |
std::string Contents; |
| 52 |
// Version identifier for Contents, provided by the client and opaque to us. |
| 53 |
std::string Version = "null"; |
| 54 |
// Prevent reuse of the cached preamble/AST. Slow! Useful to workaround |
| 55 |
// clangd's assumption that missing header files will stay missing. |
| 56 |
bool ForceRebuild = false; |
| 57 |
// Used to recover from diagnostics (e.g. find missing includes for symbol). |
| 58 |
const SymbolIndex *Index = nullptr; |
| 59 |
ParseOptions Opts = ParseOptions(); |
| 60 |
TidyProviderRef ClangTidyProvider = {}; |
| 61 |
// Used to acquire ASTListeners when parsing files. |
| 62 |
FeatureModuleSet *FeatureModules = nullptr; |
| 63 |
}; |
| 64 |
|
| 65 |
/// Clears \p CI from options that are not supported by clangd, like codegen or |
| 66 |
/// plugins. This should be combined with CommandMangler::adjust, which provides |
| 67 |
/// similar functionality for options that needs to be stripped from compile |
| 68 |
/// flags. |
| 69 |
void disableUnsupportedOptions(CompilerInvocation &CI); |
| 70 |
|
| 71 |
/// Builds compiler invocation that could be used to build AST or preamble. |
| 72 |
std::unique_ptr<CompilerInvocation> |
| 73 |
buildCompilerInvocation(const ParseInputs &Inputs, clang::DiagnosticConsumer &D, |
| 74 |
std::vector<std::string> *CC1Args = nullptr); |
| 75 |
|
| 76 |
/// Creates a compiler instance, configured so that: |
| 77 |
/// - Contents of the parsed file are remapped to \p MainFile. |
| 78 |
/// - Preamble is overriden to use PCH passed to this function. It means the |
| 79 |
/// changes to the preamble headers or files included in the preamble are |
| 80 |
/// not visible to this compiler instance. |
| 81 |
/// - llvm::vfs::FileSystem is used for all underlying file accesses. The |
| 82 |
/// actual vfs used by the compiler may be an overlay over the passed vfs. |
| 83 |
/// Returns null on errors. When non-null value is returned, it is expected to |
| 84 |
/// be consumed by FrontendAction::BeginSourceFile to properly destroy \p |
| 85 |
/// MainFile. |
| 86 |
std::unique_ptr<CompilerInstance> prepareCompilerInstance( |
| 87 |
std::unique_ptr<clang::CompilerInvocation>, const PrecompiledPreamble *, |
| 88 |
std::unique_ptr<llvm::MemoryBuffer> MainFile, |
| 89 |
IntrusiveRefCntPtr<llvm::vfs::FileSystem>, DiagnosticConsumer &); |
| 90 |
|
| 91 |
/// Respect `#pragma clang __debug crash` etc, which are usually disabled. |
| 92 |
/// This may only be called before threads are spawned. |
| 93 |
void allowCrashPragmasForTest(); |
| 94 |
|
| 95 |
} // namespace clangd |
| 96 |
} // namespace clang |
| 97 |
|
| 98 |
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_COMPILER_H |