clang 22.0.0git
clang::tooling::dependencies::ModuleDeps Struct Reference

#include "clang/Tooling/DependencyScanning/ModuleDepCollector.h"

Public Member Functions

void forEachFileDep (llvm::function_ref< void(StringRef)> Cb) const
 Invokes Cb for all file dependencies of this module.
const std::vector< std::string > & getBuildArguments () const
 Get (or compute) the compiler invocation that can be used to build this module.

Public Attributes

ModuleID ID
 The identifier of the module.
bool IsSystem
 Whether this is a "system" module.
bool IsInStableDirectories
 Whether this module is fully composed of file & module inputs from locations likely to stay the same across the active development and build cycle.
std::string ClangModuleMapFile
 The path to the modulemap file which defines this module.
std::vector< std::string > ModuleMapFileDeps
 A collection of absolute paths to module map files that this module needs to know about.
std::vector< PrebuiltModuleDepPrebuiltModuleDeps
 A collection of prebuilt modular dependencies this module directly depends on, not including transitive dependencies.
std::vector< ModuleIDClangModuleDeps
 A list of module identifiers this module directly depends on, not including transitive dependencies.
llvm::SmallVector< Module::LinkLibrary, 2 > LinkLibraries
 The set of libraries or frameworks to link against when an entity from this module is used.

Friends

class ModuleDepCollector
class ModuleDepCollectorPP

Detailed Description

Definition at line 152 of file ModuleDepCollector.h.

Member Function Documentation

◆ forEachFileDep()

void ModuleDeps::forEachFileDep ( llvm::function_ref< void(StringRef)> Cb) const

Invokes Cb for all file dependencies of this module.

Each provided StringRef is only valid within the individual callback invocation.

Definition at line 23 of file ModuleDepCollector.cpp.

References clang::ASTReader::ResolveImportedPath().

◆ getBuildArguments()

const std::vector< std::string > & ModuleDeps::getBuildArguments ( ) const

Get (or compute) the compiler invocation that can be used to build this module.

Does not include argv[0].

Definition at line 33 of file ModuleDepCollector.cpp.

◆ ModuleDepCollector

friend class ModuleDepCollector
friend

Definition at line 201 of file ModuleDepCollector.h.

References ModuleDepCollector.

Referenced by ModuleDepCollector.

◆ ModuleDepCollectorPP

friend class ModuleDepCollectorPP
friend

Definition at line 202 of file ModuleDepCollector.h.

References ModuleDepCollectorPP.

Referenced by ModuleDepCollectorPP.

Member Data Documentation

◆ ClangModuleDeps

std::vector<ModuleID> clang::tooling::dependencies::ModuleDeps::ClangModuleDeps

A list of module identifiers this module directly depends on, not including transitive dependencies.

This may include modules with a different context hash when it can be determined that the differences are benign for this compilation.

Definition at line 186 of file ModuleDepCollector.h.

Referenced by getModuleContextHash().

◆ ClangModuleMapFile

std::string clang::tooling::dependencies::ModuleDeps::ClangModuleMapFile

The path to the modulemap file which defines this module.

This can be used to explicitly build this module. This file will additionally appear in FileDeps as a dependency.

Definition at line 171 of file ModuleDepCollector.h.

◆ ID

ModuleID clang::tooling::dependencies::ModuleDeps::ID

The identifier of the module.

Definition at line 154 of file ModuleDepCollector.h.

Referenced by clang::tooling::dependencies::FullDependencyConsumer::handleModuleDependency().

◆ IsInStableDirectories

bool clang::tooling::dependencies::ModuleDeps::IsInStableDirectories

Whether this module is fully composed of file & module inputs from locations likely to stay the same across the active development and build cycle.

For example, when all those input paths only resolve in Sysroot.

External paths, as opposed to virtual file paths, are always used for computing this value.

Definition at line 165 of file ModuleDepCollector.h.

◆ IsSystem

bool clang::tooling::dependencies::ModuleDeps::IsSystem

Whether this is a "system" module.

Definition at line 157 of file ModuleDepCollector.h.

◆ LinkLibraries

llvm::SmallVector<Module::LinkLibrary, 2> clang::tooling::dependencies::ModuleDeps::LinkLibraries

The set of libraries or frameworks to link against when an entity from this module is used.

Definition at line 190 of file ModuleDepCollector.h.

◆ ModuleMapFileDeps

std::vector<std::string> clang::tooling::dependencies::ModuleDeps::ModuleMapFileDeps

A collection of absolute paths to module map files that this module needs to know about.

The ordering is significant.

Definition at line 175 of file ModuleDepCollector.h.

◆ PrebuiltModuleDeps

std::vector<PrebuiltModuleDep> clang::tooling::dependencies::ModuleDeps::PrebuiltModuleDeps

A collection of prebuilt modular dependencies this module directly depends on, not including transitive dependencies.

Definition at line 179 of file ModuleDepCollector.h.


The documentation for this struct was generated from the following files: