blob: ab89a185b4624c067afc1ae7f1a09bbc9c1dc758 [file] [log] [blame]
//===--- GlobalCompilationDatabase.h ----------------------------*- C++-*-===//
// The LLVM Compiler Infrastructure
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
#include "Path.h"
#include "llvm/ADT/StringMap.h"
#include <memory>
#include <mutex>
#include <vector>
namespace clang {
namespace tooling {
class CompilationDatabase;
struct CompileCommand;
} // namespace tooling
namespace clangd {
class Logger;
/// Provides compilation arguments used for parsing C and C++ files.
class GlobalCompilationDatabase {
virtual ~GlobalCompilationDatabase() = default;
/// If there are any known-good commands for building this file, returns one.
virtual llvm::Optional<tooling::CompileCommand>
getCompileCommand(PathRef File) const = 0;
/// Makes a guess at how to build a file.
/// The default implementation just runs clang on the file.
/// Clangd should treat the results as unreliable.
virtual tooling::CompileCommand getFallbackCommand(PathRef File) const;
/// FIXME(ibiryukov): add facilities to track changes to compilation flags of
/// existing targets.
/// Gets compile args from tooling::CompilationDatabases built for parent
/// directories.
class DirectoryBasedGlobalCompilationDatabase
: public GlobalCompilationDatabase {
llvm::Optional<Path> CompileCommandsDir);
~DirectoryBasedGlobalCompilationDatabase() override;
/// Scans File's parents looking for compilation databases.
/// Any extra flags will be added.
getCompileCommand(PathRef File) const override;
/// Uses the default fallback command, adding any extra flags.
tooling::CompileCommand getFallbackCommand(PathRef File) const override;
/// Set the compile commands directory to \p P.
void setCompileCommandsDir(Path P);
/// Sets the extra flags that should be added to a file.
void setExtraFlagsForFile(PathRef File, std::vector<std::string> ExtraFlags);
tooling::CompilationDatabase *getCDBForFile(PathRef File) const;
tooling::CompilationDatabase *getCDBInDirLocked(PathRef File) const;
void addExtraFlags(PathRef File, tooling::CompileCommand &C) const;
mutable std::mutex Mutex;
/// Caches compilation databases loaded from directories(keys are
/// directories).
mutable llvm::StringMap<std::unique_ptr<clang::tooling::CompilationDatabase>>
/// Stores extra flags per file.
llvm::StringMap<std::vector<std::string>> ExtraFlagsForFile;
/// Used for command argument pointing to folder where compile_commands.json
/// is located.
llvm::Optional<Path> CompileCommandsDir;
/// A wrapper around GlobalCompilationDatabase that caches the compile commands.
/// Note that only results of getCompileCommand are cached.
class CachingCompilationDb : public GlobalCompilationDatabase {
explicit CachingCompilationDb(const GlobalCompilationDatabase &InnerCDB);
/// Gets compile command for \p File from cache or CDB if it's not in the
/// cache.
getCompileCommand(PathRef File) const override;
/// Forwards to the inner CDB. Results of this function are not cached.
tooling::CompileCommand getFallbackCommand(PathRef File) const override;
/// Removes an entry for \p File if it's present in the cache.
void invalidate(PathRef File);
/// Removes all cached compile commands.
void clear();
const GlobalCompilationDatabase &InnerCDB;
mutable std::mutex Mut;
mutable llvm::StringMap<llvm::Optional<tooling::CompileCommand>>
Cached; /* GUARDED_BY(Mut) */
} // namespace clangd
} // namespace clang