mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-23 15:16:09 +00:00
ae839b0250
Previously, everytime we want to get a source file declaring a specific module, we need to scan the whole projects again and again. The performance is super bad. This patch tries to improve this by introducing a simple cache.
58 lines
2.1 KiB
C++
58 lines
2.1 KiB
C++
//===------------------ ProjectModules.h -------------------------*- C++-*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_PROJECTMODULES_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_PROJECTMODULES_H
|
|
|
|
#include "support/Function.h"
|
|
#include "support/Path.h"
|
|
#include "support/ThreadsafeFS.h"
|
|
#include "clang/Tooling/CompilationDatabase.h"
|
|
|
|
#include <memory>
|
|
|
|
namespace clang {
|
|
namespace clangd {
|
|
|
|
/// An interface to query the modules information in the project.
|
|
/// Users should get instances of `ProjectModules` from
|
|
/// `GlobalCompilationDatabase::getProjectModules(PathRef)`.
|
|
///
|
|
/// Currently, the modules information includes:
|
|
/// - Given a source file, what are the required modules.
|
|
/// - Given a module name and a required source file, what is
|
|
/// the corresponding source file.
|
|
///
|
|
/// Note that there can be multiple source files declaring the same module
|
|
/// in a valid project. Although the language specification requires that
|
|
/// every module unit's name must be unique in valid program, there can be
|
|
/// multiple program in a project. And it is technically valid if these program
|
|
/// doesn't interfere with each other.
|
|
///
|
|
/// A module name should be in the format:
|
|
/// `<primary-module-name>[:partition-name]`. So module names covers partitions.
|
|
class ProjectModules {
|
|
public:
|
|
using CommandMangler =
|
|
llvm::unique_function<void(tooling::CompileCommand &, PathRef) const>;
|
|
|
|
virtual std::vector<std::string> getRequiredModules(PathRef File) = 0;
|
|
virtual std::string getModuleNameForSource(PathRef File) = 0;
|
|
virtual std::string getSourceForModuleName(llvm::StringRef ModuleName,
|
|
PathRef RequiredSrcFile) = 0;
|
|
|
|
virtual void setCommandMangler(CommandMangler Mangler) {}
|
|
|
|
virtual ~ProjectModules() = default;
|
|
};
|
|
|
|
} // namespace clangd
|
|
} // namespace clang
|
|
|
|
#endif
|