clang 19.0.0git
Public Member Functions | Friends | List of all members
clang::ModuleMap::KnownHeader Class Reference

A header that is known to reside within a given module, whether it was included or excluded. More...

#include "clang/Lex/ModuleMap.h"

Public Member Functions

 KnownHeader ()
 
 KnownHeader (Module *M, ModuleHeaderRole Role)
 
ModulegetModule () const
 Retrieve the module the header is stored in.
 
ModuleHeaderRole getRole () const
 The role of this header within the module.
 
bool isAvailable () const
 Whether this header is available in the module.
 
bool isAccessibleFrom (Module *M) const
 Whether this header is accessible from the specified module.
 
 operator bool () const
 

Friends

bool operator== (const KnownHeader &A, const KnownHeader &B)
 
bool operator!= (const KnownHeader &A, const KnownHeader &B)
 

Detailed Description

A header that is known to reside within a given module, whether it was included or excluded.

Definition at line 159 of file ModuleMap.h.

Constructor & Destructor Documentation

◆ KnownHeader() [1/2]

clang::ModuleMap::KnownHeader::KnownHeader ( )
inline

Definition at line 163 of file ModuleMap.h.

◆ KnownHeader() [2/2]

clang::ModuleMap::KnownHeader::KnownHeader ( Module M,
ModuleHeaderRole  Role 
)
inline

Definition at line 164 of file ModuleMap.h.

Member Function Documentation

◆ getModule()

Module * clang::ModuleMap::KnownHeader::getModule ( ) const
inline

◆ getRole()

ModuleHeaderRole clang::ModuleMap::KnownHeader::getRole ( ) const
inline

◆ isAccessibleFrom()

bool clang::ModuleMap::KnownHeader::isAccessibleFrom ( Module M) const
inline

Whether this header is accessible from the specified module.

Definition at line 185 of file ModuleMap.h.

References getModule(), getRole(), clang::Module::getTopLevelModule(), and clang::ModuleMap::PrivateHeader.

Referenced by violatesPrivateInclude().

◆ isAvailable()

bool clang::ModuleMap::KnownHeader::isAvailable ( ) const
inline

Whether this header is available in the module.

Definition at line 180 of file ModuleMap.h.

References clang::ModuleMap::ExcludedHeader, getModule(), getRole(), and clang::Module::isAvailable().

◆ operator bool()

clang::ModuleMap::KnownHeader::operator bool ( ) const
inlineexplicit

Definition at line 192 of file ModuleMap.h.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const KnownHeader A,
const KnownHeader B 
)
friend

Definition at line 169 of file ModuleMap.h.

◆ operator==

bool operator== ( const KnownHeader A,
const KnownHeader B 
)
friend

Definition at line 166 of file ModuleMap.h.


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