clang-tools  17.0.0git
Public Member Functions | Public Attributes | List of all members
clang::clangd::Symbol::IncludeHeaderWithReferences Struct Reference

#include <Symbol.h>

Collaboration diagram for clang::clangd::Symbol::IncludeHeaderWithReferences:
Collaboration graph
[legend]

Public Member Functions

 IncludeHeaderWithReferences ()=default
 
 IncludeHeaderWithReferences (llvm::StringRef IncludeHeader, uint32_t References, IncludeDirective SupportedDirectives)
 
IncludeDirective supportedDirectives () const
 

Public Attributes

llvm::StringRef IncludeHeader = ""
 This can be either a URI of the header to be #include'd for this symbol, or a literal header quoted with <> or "" that is suitable to be included directly. More...
 
uint32_t References: 30
 The number of translation units that reference this symbol and include this header. More...
 
uint32_t SupportedDirectives: 2
 Bitfield of supported directives (IncludeDirective) that can be used when including this header. More...
 

Detailed Description

Definition at line 100 of file Symbol.h.

Constructor & Destructor Documentation

◆ IncludeHeaderWithReferences() [1/2]

clang::clangd::Symbol::IncludeHeaderWithReferences::IncludeHeaderWithReferences ( )
default

◆ IncludeHeaderWithReferences() [2/2]

clang::clangd::Symbol::IncludeHeaderWithReferences::IncludeHeaderWithReferences ( llvm::StringRef  IncludeHeader,
uint32_t  References,
IncludeDirective  SupportedDirectives 
)
inline

Definition at line 103 of file Symbol.h.

Member Function Documentation

◆ supportedDirectives()

IncludeDirective clang::clangd::Symbol::IncludeHeaderWithReferences::supportedDirectives ( ) const
inline

Definition at line 124 of file Symbol.h.

References SupportedDirectives.

Member Data Documentation

◆ IncludeHeader

llvm::StringRef clang::clangd::Symbol::IncludeHeaderWithReferences::IncludeHeader = ""

This can be either a URI of the header to be #include'd for this symbol, or a literal header quoted with <> or "" that is suitable to be included directly.

When it is a URI, the exact #include path needs to be calculated according to the URI scheme.

Note that the include header is a canonical include for the symbol and can be different from FileURI in the CanonicalDeclaration.

Definition at line 116 of file Symbol.h.

◆ References

uint32_t clang::clangd::Symbol::IncludeHeaderWithReferences::References

The number of translation units that reference this symbol and include this header.

This number is only meaningful if aggregated in an index.

Definition at line 119 of file Symbol.h.

◆ SupportedDirectives

uint32_t clang::clangd::Symbol::IncludeHeaderWithReferences::SupportedDirectives

Bitfield of supported directives (IncludeDirective) that can be used when including this header.

Definition at line 122 of file Symbol.h.

Referenced by supportedDirectives().


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