LLVM 18.0.0git
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::DIEnumerator Class Reference

Enumeration value. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIEnumerator:
Inheritance graph
[legend]

Public Member Functions

 DEFINE_MDNODE_GET (DIEnumerator,(int64_t Value, bool IsUnsigned, StringRef Name),(APInt(64, Value, !IsUnsigned), IsUnsigned, Name)) DEFINE_MDNODE_GET(DIEnumerator
 
int64_t bool MDString APInt (64, Value, !IsUnsigned)
 
int64_t bool MDString Name DEFINE_MDNODE_GET (DIEnumerator,(APInt Value, bool IsUnsigned, StringRef Name),(Value, IsUnsigned, Name)) DEFINE_MDNODE_GET(DIEnumerator
 
int64_t bool MDString Name APInt bool MDString Name TempDIEnumerator clone () const
 
const APIntgetValue () const
 
bool isUnsigned () const
 
StringRef getName () const
 
MDStringgetRawName () const
 
- Public Member Functions inherited from llvm::DINode
dwarf::Tag getTag () const
 
- Public Member Functions inherited from llvm::MDNode
 MDNode (const MDNode &)=delete
 
void operator= (const MDNode &)=delete
 
void * operator new (size_t)=delete
 
TempMDNode clone () const
 Create a (temporary) clone of this.
 
LLVMContextgetContext () const
 
void replaceOperandWith (unsigned I, Metadata *New)
 Replace a specific operand.
 
bool isResolved () const
 Check if node is fully resolved.
 
bool isUniqued () const
 
bool isDistinct () const
 
bool isTemporary () const
 
void replaceAllUsesWith (Metadata *MD)
 RAUW a temporary.
 
void resolveCycles ()
 Resolve cycles.
 
void resolve ()
 Resolve a unique, unresolved node.
 
op_iterator op_begin () const
 
op_iterator op_end () const
 
ArrayRef< MDOperandoperands () const
 
const MDOperandgetOperand (unsigned I) const
 
unsigned getNumOperands () const
 Return number of MDNode operands.
 
bool isTBAAVtableAccess () const
 Check whether MDNode is a vtable access.
 
void printTree (raw_ostream &OS, const Module *M=nullptr) const
 Print in tree shape.
 
void printTree (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const
 
void dumpTree () const
 User-friendly dump in tree shape.
 
void dumpTree (const Module *M) const
 

Static Public Member Functions

static bool classof (const Metadata *MD)
 
- Static Public Member Functions inherited from llvm::DINode
static DIFlags getFlag (StringRef Flag)
 
static StringRef getFlagString (DIFlags Flag)
 
static DIFlags splitFlags (DIFlags Flags, SmallVectorImpl< DIFlags > &SplitFlags)
 Split up a flags bitfield.
 
static bool classof (const Metadata *MD)
 
- Static Public Member Functions inherited from llvm::MDNode
static MDTupleget (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static MDTuplegetIfExists (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static MDTuplegetDistinct (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static TempMDTuple getTemporary (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static void deleteTemporary (MDNode *N)
 Deallocate a node created by getTemporary.
 
template<class T >
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > replaceWithPermanent (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a permanent one.
 
template<class T >
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > replaceWithUniqued (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a uniqued one.
 
template<class T >
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > replaceWithDistinct (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a distinct one.
 
static bool classof (const Metadata *MD)
 Methods for support type inquiry through isa, cast, and dyn_cast:
 
static MDNodeconcatenate (MDNode *A, MDNode *B)
 Methods for metadata merging.
 
static MDNodeintersect (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericTBAA (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericFPMath (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericRange (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericAliasScope (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericAlignmentOrDereferenceable (MDNode *A, MDNode *B)
 
static MDNodegetMergedProfMetadata (MDNode *A, MDNode *B, const Instruction *AInstr, const Instruction *BInstr)
 Merge !prof metadata from two instructions.
 

Public Attributes

int64_t Value
 
int64_t bool IsUnsigned
 
int64_t bool MDStringName
 
int64_t bool MDString IsUnsigned
 
int64_t bool MDString Name APInt Value
 
int64_t bool MDString Name APInt bool IsUnsigned
 
int64_t bool MDString Name APInt bool MDStringName
 
int64_t bool MDString Name APInt bool MDString Value
 
int64_t bool MDString Name APInt bool MDString IsUnsigned
 

Friends

class LLVMContextImpl
 
class MDNode
 

Additional Inherited Members

- Public Types inherited from llvm::DINode
enum  DIFlags : uint32_t { FlagAccessibility = FlagPrivate | FlagProtected | FlagPublic , FlagPtrToMemberRep }
 Debug info flags. More...
 
- Public Types inherited from llvm::MDNode
using op_iterator = const MDOperand *
 
using op_range = iterator_range< op_iterator >
 
- Protected Types inherited from llvm::MDNode
using mutable_op_range = iterator_range< MDOperand * >
 
 Active type of storage. More...
- Protected Member Functions inherited from llvm::DINode
 DINode (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2=std::nullopt)
 
 ~DINode ()=default
 
template<class Ty >
Ty * getOperandAs (unsigned I) const
 
StringRef getStringOperand (unsigned I) const
 
void setTag (unsigned Tag)
 Allow subclasses to mutate the tag.
 
- Protected Member Functions inherited from llvm::MDNode
 MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2=std::nullopt)
 
 ~MDNode ()=default
 
void * operator new (size_t Size, size_t NumOps, StorageType Storage)
 
void operator delete (void *Mem)
 
void operator delete (void *, unsigned)
 Required by std, but never called.
 
void operator delete (void *, unsigned, bool)
 Required by std, but never called.
 
void dropAllReferences ()
 
MDOperandmutable_begin ()
 
MDOperandmutable_end ()
 
mutable_op_range mutable_operands ()
 
void setOperand (unsigned I, Metadata *New)
 Set an operand.
 
unsigned getNumUnresolved () const
 
void setNumUnresolved (unsigned N)
 
void storeDistinctInContext ()
 
void resize (size_t NumOps)
 Resize the node to hold NumOps operands.
 
- Static Protected Member Functions inherited from llvm::DINode
static MDStringgetCanonicalMDString (LLVMContext &Context, StringRef S)
 
- Static Protected Member Functions inherited from llvm::MDNode
template<class T , class StoreT >
static TstoreImpl (T *N, StorageType Storage, StoreT &Store)
 
template<class T >
static TstoreImpl (T *N, StorageType Storage)
 

Detailed Description

Enumeration value.

TODO: Add a pointer to the context (DW_TAG_enumeration_type) once that no longer creates a type cycle.

Definition at line 449 of file DebugInfoMetadata.h.

Member Function Documentation

◆ APInt()

int64_t bool MDString llvm::DIEnumerator::APInt ( 64  ,
Value  ,
IsUnsigned 
)

◆ classof()

static bool llvm::DIEnumerator::classof ( const Metadata MD)
inlinestatic

Definition at line 498 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

int64_t bool MDString Name APInt bool MDString Name TempDIEnumerator llvm::DIEnumerator::clone ( ) const
inline

Definition at line 490 of file DebugInfoMetadata.h.

◆ DEFINE_MDNODE_GET() [1/2]

int64_t bool MDString Name llvm::DIEnumerator::DEFINE_MDNODE_GET ( DIEnumerator  ,
(APInt Value, bool IsUnsigned, StringRef Name ,
(Value, IsUnsigned, Name  
)

◆ DEFINE_MDNODE_GET() [2/2]

llvm::DIEnumerator::DEFINE_MDNODE_GET ( DIEnumerator  ,
(int64_t Value, bool IsUnsigned, StringRef Name ,
(APInt(64, Value, !IsUnsigned), IsUnsigned, Name  
)

◆ getName()

StringRef llvm::DIEnumerator::getName ( ) const
inline

Definition at line 494 of file DebugInfoMetadata.h.

References llvm::DINode::getStringOperand().

◆ getRawName()

MDString * llvm::DIEnumerator::getRawName ( ) const
inline

Definition at line 496 of file DebugInfoMetadata.h.

◆ getValue()

const APInt & llvm::DIEnumerator::getValue ( ) const
inline

Definition at line 492 of file DebugInfoMetadata.h.

◆ isUnsigned()

bool llvm::DIEnumerator::isUnsigned ( ) const
inline

Definition at line 493 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData32.

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 450 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode
friend

Definition at line 451 of file DebugInfoMetadata.h.

Member Data Documentation

◆ IsUnsigned [1/4]

int64_t bool llvm::DIEnumerator::IsUnsigned

Definition at line 481 of file DebugInfoMetadata.h.

◆ IsUnsigned [2/4]

int64_t bool MDString llvm::DIEnumerator::IsUnsigned

Definition at line 482 of file DebugInfoMetadata.h.

◆ IsUnsigned [3/4]

int64_t bool MDString Name APInt bool llvm::DIEnumerator::IsUnsigned

Definition at line 487 of file DebugInfoMetadata.h.

◆ IsUnsigned [4/4]

int64_t bool MDString Name APInt bool MDString llvm::DIEnumerator::IsUnsigned

Definition at line 488 of file DebugInfoMetadata.h.

◆ Name [1/2]

int64_t bool MDString* llvm::DIEnumerator::Name

Definition at line 481 of file DebugInfoMetadata.h.

◆ Name [2/2]

int64_t bool MDString Name APInt bool MDString* llvm::DIEnumerator::Name

Definition at line 487 of file DebugInfoMetadata.h.

◆ Value [1/3]

int64_t llvm::DIEnumerator::Value

Definition at line 481 of file DebugInfoMetadata.h.

◆ Value [2/3]

int64_t bool MDString Name APInt llvm::DIEnumerator::Value

Definition at line 487 of file DebugInfoMetadata.h.

◆ Value [3/3]

int64_t bool MDString Name APInt bool MDString llvm::DIEnumerator::Value

Definition at line 488 of file DebugInfoMetadata.h.


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