clang::clangd::ProjectModules Class Reference

An interface to query the modules information in the project. More...

#include <ProjectModules.h>

Inheritance diagram for clang::clangd::ProjectModules:

Public Types
enum class	ModuleNameState { Unknown , Unique , Multiple }
using	CommandMangler

Public Member Functions
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 ModuleNameState	getModuleNameState (llvm::StringRef ModuleName)
virtual void	setCommandMangler (CommandMangler Mangler)
virtual	~ProjectModules ()=default

Detailed Description

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.

Definition at line 39 of file ProjectModules.h.

Member Typedef Documentation

CommandMangler

using clang::clangd::ProjectModules::CommandMangler

Initial value:

 
      llvm::unique_function<void(tooling::CompileCommand &, PathRef) const>

Definition at line 47 of file ProjectModules.h.

Member Enumeration Documentation

ModuleNameState

enum class clang::clangd::ProjectModules::ModuleNameState

strong

Enumerator
Unknown
Unique
Multiple

Definition at line 41 of file ProjectModules.h.

Constructor & Destructor Documentation

~ProjectModules()

virtual clang::clangd::ProjectModules::~ProjectModules ( )

virtualdefault

Member Function Documentation

getModuleNameForSource()

virtual std::string clang::clangd::ProjectModules::getModuleNameForSource ( PathRef File )

pure virtual

Implemented in clang::clangd::CompileCommandsProjectModules, clang::clangd::CompoundProjectModules, and clang::clangd::ScanningAllProjectModules.

References clang::clangd::File.

getModuleNameState()

virtual ModuleNameState clang::clangd::ProjectModules::getModuleNameState ( llvm::StringRef ModuleName )

inlinevirtual

Reimplemented in clang::clangd::CompileCommandsProjectModules, clang::clangd::CompoundProjectModules, and clang::clangd::ScanningAllProjectModules.

Definition at line 54 of file ProjectModules.h.

References Unknown.

getRequiredModules()

virtual std::vector< std::string > clang::clangd::ProjectModules::getRequiredModules ( PathRef File )

pure virtual

Implemented in clang::clangd::CompileCommandsProjectModules, clang::clangd::CompoundProjectModules, and clang::clangd::ScanningAllProjectModules.

References clang::clangd::File.

getSourceForModuleName()

virtual std::string clang::clangd::ProjectModules::getSourceForModuleName ( llvm::StringRef ModuleName, PathRef RequiredSrcFile )

pure virtual

Implemented in clang::clangd::CompileCommandsProjectModules, clang::clangd::CompoundProjectModules, and clang::clangd::ScanningAllProjectModules.

setCommandMangler()

virtual void clang::clangd::ProjectModules::setCommandMangler ( CommandMangler Mangler )

inlinevirtual

Reimplemented in clang::clangd::CompileCommandsProjectModules, clang::clangd::CompoundProjectModules, and clang::clangd::ScanningAllProjectModules.

Definition at line 58 of file ProjectModules.h.

---

The documentation for this class was generated from the following file:

• ProjectModules.h