LLVM 19.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
llvm::Record Class Reference

#include "llvm/TableGen/Record.h"

Classes

struct  AssertionInfo
 
struct  DumpInfo
 

Public Types

enum  RecordKind { RK_Def , RK_AnonymousDef , RK_Class , RK_MultiClass }
 

Public Member Functions

 Record (Init *N, ArrayRef< SMLoc > locs, RecordKeeper &records, RecordKind Kind=RK_Def)
 
 Record (StringRef N, ArrayRef< SMLoc > locs, RecordKeeper &records, RecordKind Kind=RK_Def)
 
 Record (const Record &O)
 
unsigned getID () const
 
StringRef getName () const
 
InitgetNameInit () const
 
std::string getNameInitAsString () const
 
void setName (Init *Name)
 
ArrayRef< SMLocgetLoc () const
 
void appendLoc (SMLoc Loc)
 
ArrayRef< SMLocgetForwardDeclarationLocs () const
 
void appendReferenceLoc (SMRange Loc)
 Add a reference to this record value.
 
ArrayRef< SMRangegetReferenceLocs () const
 Return the references of this record value.
 
void updateClassLoc (SMLoc Loc)
 
RecordRecTygetType ()
 
DefInitgetDefInit ()
 get the corresponding DefInit.
 
bool isClass () const
 
bool isMultiClass () const
 
bool isAnonymous () const
 
ArrayRef< Init * > getTemplateArgs () const
 
ArrayRef< RecordValgetValues () const
 
ArrayRef< AssertionInfogetAssertions () const
 
ArrayRef< DumpInfogetDumps () const
 
ArrayRef< std::pair< Record *, SMRange > > getSuperClasses () const
 
bool hasDirectSuperClass (const Record *SuperClass) const
 Determine whether this record has the specified direct superclass.
 
void getDirectSuperClasses (SmallVectorImpl< Record * > &Classes) const
 Append the direct superclasses of this record to Classes.
 
bool isTemplateArg (Init *Name) const
 
const RecordValgetValue (const Init *Name) const
 
const RecordValgetValue (StringRef Name) const
 
RecordValgetValue (const Init *Name)
 
RecordValgetValue (StringRef Name)
 
void addTemplateArg (Init *Name)
 
void addValue (const RecordVal &RV)
 
void removeValue (Init *Name)
 
void removeValue (StringRef Name)
 
void addAssertion (SMLoc Loc, Init *Condition, Init *Message)
 
void addDump (SMLoc Loc, Init *Message)
 
void appendAssertions (const Record *Rec)
 
void appendDumps (const Record *Rec)
 
void checkRecordAssertions ()
 
void emitRecordDumps ()
 
void checkUnusedTemplateArgs ()
 
bool isSubClassOf (const Record *R) const
 
bool isSubClassOf (StringRef Name) const
 
void addSuperClass (Record *R, SMRange Range)
 
void resolveReferences (Init *NewName=nullptr)
 If there are any field references that refer to fields that have been filled in, we can propagate the values now.
 
void resolveReferences (Resolver &R, const RecordVal *SkipVal=nullptr)
 Apply the resolver to the name of the record as well as to the initializers of all fields of the record except SkipVal.
 
RecordKeepergetRecords () const
 
void dump () const
 
SMLoc getFieldLoc (StringRef FieldName) const
 Return the source location for the named field.
 
InitgetValueInit (StringRef FieldName) const
 Return the initializer for a value with the specified name, or throw an exception if the field does not exist.
 
bool isValueUnset (StringRef FieldName) const
 Return true if the named field is unset.
 
StringRef getValueAsString (StringRef FieldName) const
 This method looks up the specified field and returns its value as a string, throwing an exception if the field does not exist or if the value is not a string.
 
std::optional< StringRefgetValueAsOptionalString (StringRef FieldName) const
 This method looks up the specified field and returns its value as a string, throwing an exception if the value is not a string and std::nullopt if the field does not exist.
 
BitsInitgetValueAsBitsInit (StringRef FieldName) const
 This method looks up the specified field and returns its value as a BitsInit, throwing an exception if the field does not exist or if the value is not the right type.
 
ListInitgetValueAsListInit (StringRef FieldName) const
 This method looks up the specified field and returns its value as a ListInit, throwing an exception if the field does not exist or if the value is not the right type.
 
std::vector< Record * > getValueAsListOfDefs (StringRef FieldName) const
 This method looks up the specified field and returns its value as a vector of records, throwing an exception if the field does not exist or if the value is not the right type.
 
std::vector< int64_t > getValueAsListOfInts (StringRef FieldName) const
 This method looks up the specified field and returns its value as a vector of integers, throwing an exception if the field does not exist or if the value is not the right type.
 
std::vector< StringRefgetValueAsListOfStrings (StringRef FieldName) const
 This method looks up the specified field and returns its value as a vector of strings, throwing an exception if the field does not exist or if the value is not the right type.
 
RecordgetValueAsDef (StringRef FieldName) const
 This method looks up the specified field and returns its value as a Record, throwing an exception if the field does not exist or if the value is not the right type.
 
RecordgetValueAsOptionalDef (StringRef FieldName) const
 This method looks up the specified field and returns its value as a Record, returning null if the field exists but is "uninitialized" (i.e.
 
bool getValueAsBit (StringRef FieldName) const
 This method looks up the specified field and returns its value as a bit, throwing an exception if the field does not exist or if the value is not the right type.
 
bool getValueAsBitOrUnset (StringRef FieldName, bool &Unset) const
 This method looks up the specified field and returns its value as a bit.
 
int64_t getValueAsInt (StringRef FieldName) const
 This method looks up the specified field and returns its value as an int64_t, throwing an exception if the field does not exist or if the value is not the right type.
 
DagInitgetValueAsDag (StringRef FieldName) const
 This method looks up the specified field and returns its value as an Dag, throwing an exception if the field does not exist or if the value is not the right type.
 

Static Public Member Functions

static unsigned getNewUID (RecordKeeper &RK)
 

Detailed Description

Definition at line 1631 of file Record.h.

Member Enumeration Documentation

◆ RecordKind

Enumerator
RK_Def 
RK_AnonymousDef 
RK_Class 
RK_MultiClass 

Definition at line 1653 of file Record.h.

Constructor & Destructor Documentation

◆ Record() [1/3]

llvm::Record::Record ( Init N,
ArrayRef< SMLoc locs,
RecordKeeper records,
RecordKind  Kind = RK_Def 
)
inlineexplicit

Definition at line 1687 of file Record.h.

◆ Record() [2/3]

llvm::Record::Record ( StringRef  N,
ArrayRef< SMLoc locs,
RecordKeeper records,
RecordKind  Kind = RK_Def 
)
inlineexplicit

Definition at line 1694 of file Record.h.

◆ Record() [3/3]

llvm::Record::Record ( const Record O)
inline

Definition at line 1701 of file Record.h.

Member Function Documentation

◆ addAssertion()

void llvm::Record::addAssertion ( SMLoc  Loc,
Init Condition,
Init Message 
)
inline

Definition at line 1815 of file Record.h.

References llvm::SmallVectorTemplateBase< T, bool >::push_back().

◆ addDump()

void llvm::Record::addDump ( SMLoc  Loc,
Init Message 
)
inline

Definition at line 1819 of file Record.h.

References llvm::SmallVectorTemplateBase< T, bool >::push_back().

◆ addSuperClass()

void llvm::Record::addSuperClass ( Record R,
SMRange  Range 
)
inline

◆ addTemplateArg()

void llvm::Record::addTemplateArg ( Init Name)
inline

Definition at line 1792 of file Record.h.

References assert(), and isTemplateArg().

◆ addValue()

void llvm::Record::addValue ( const RecordVal RV)
inline

◆ appendAssertions()

void llvm::Record::appendAssertions ( const Record Rec)
inline

Definition at line 1823 of file Record.h.

References llvm::SmallVectorImpl< T >::append().

◆ appendDumps()

void llvm::Record::appendDumps ( const Record Rec)
inline

Definition at line 1827 of file Record.h.

References llvm::SmallVectorImpl< T >::append().

◆ appendLoc()

void llvm::Record::appendLoc ( SMLoc  Loc)
inline

Definition at line 1724 of file Record.h.

References llvm::SmallVectorTemplateBase< T, bool >::push_back().

◆ appendReferenceLoc()

void llvm::Record::appendReferenceLoc ( SMRange  Loc)
inline

Add a reference to this record value.

Definition at line 1731 of file Record.h.

References llvm::SmallVectorTemplateBase< T, bool >::push_back().

◆ checkRecordAssertions()

void Record::checkRecordAssertions ( )

◆ checkUnusedTemplateArgs()

void Record::checkUnusedTemplateArgs ( )

◆ dump()

LLVM_DUMP_METHOD void Record::dump ( ) const

Definition at line 2891 of file Record.cpp.

References llvm::errs().

Referenced by llvm::MultiClass::dump().

◆ emitRecordDumps()

void Record::emitRecordDumps ( )

Definition at line 3137 of file Record.cpp.

References llvm::dumpMessage(), and getDumps().

◆ getAssertions()

ArrayRef< AssertionInfo > llvm::Record::getAssertions ( ) const
inline

Definition at line 1757 of file Record.h.

Referenced by checkRecordAssertions().

◆ getDefInit()

DefInit * Record::getDefInit ( )

get the corresponding DefInit.

Definition at line 2783 of file Record.cpp.

References llvm::detail::RecordKeeperImpl::Allocator, and llvm::RecordKeeper::getImpl().

◆ getDirectSuperClasses()

void Record::getDirectSuperClasses ( SmallVectorImpl< Record * > &  Classes) const

Append the direct superclasses of this record to Classes.

Definition at line 2829 of file Record.cpp.

References llvm::ArrayRef< T >::back(), llvm::ArrayRef< T >::drop_back(), llvm::ArrayRef< T >::empty(), getSuperClasses(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().

Referenced by getType().

◆ getDumps()

ArrayRef< DumpInfo > llvm::Record::getDumps ( ) const
inline

Definition at line 1758 of file Record.h.

Referenced by emitRecordDumps().

◆ getFieldLoc()

SMLoc Record::getFieldLoc ( StringRef  FieldName) const

Return the source location for the named field.

Definition at line 2930 of file Record.cpp.

References getLoc(), getName(), getValue(), and llvm::PrintFatalError().

◆ getForwardDeclarationLocs()

ArrayRef< SMLoc > llvm::Record::getForwardDeclarationLocs ( ) const
inline

Definition at line 1726 of file Record.h.

◆ getID()

unsigned llvm::Record::getID ( ) const
inline

Definition at line 1709 of file Record.h.

◆ getLoc()

ArrayRef< SMLoc > llvm::Record::getLoc ( ) const
inline

◆ getName()

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

◆ getNameInit()

Init * llvm::Record::getNameInit ( ) const
inline

◆ getNameInitAsString()

std::string llvm::Record::getNameInitAsString ( ) const
inline

◆ getNewUID()

unsigned Record::getNewUID ( RecordKeeper RK)
static

◆ getRecords()

RecordKeeper & llvm::Record::getRecords ( ) const
inline

Definition at line 1873 of file Record.h.

Referenced by getValue(), QualifiedNameOfImplicitName(), QualifyName(), and removeValue().

◆ getReferenceLocs()

ArrayRef< SMRange > llvm::Record::getReferenceLocs ( ) const
inline

Return the references of this record value.

Definition at line 1734 of file Record.h.

◆ getSuperClasses()

ArrayRef< std::pair< Record *, SMRange > > llvm::Record::getSuperClasses ( ) const
inline

Definition at line 1760 of file Record.h.

Referenced by llvm::SetTheory::expand(), getDirectSuperClasses(), and hasDirectSuperClass().

◆ getTemplateArgs()

ArrayRef< Init * > llvm::Record::getTemplateArgs ( ) const
inline

Definition at line 1751 of file Record.h.

Referenced by checkUnusedTemplateArgs().

◆ getType()

RecordRecTy * Record::getType ( )

Definition at line 2777 of file Record.cpp.

References llvm::RecordRecTy::get(), and getDirectSuperClasses().

Referenced by llvm::ExistsOpInit::Fold().

◆ getValue() [1/4]

RecordVal * llvm::Record::getValue ( const Init Name)
inline

Definition at line 1784 of file Record.h.

References getValue().

◆ getValue() [2/4]

const RecordVal * llvm::Record::getValue ( const Init Name) const
inline

◆ getValue() [3/4]

RecordVal * llvm::Record::getValue ( StringRef  Name)
inline

Definition at line 1788 of file Record.h.

References getValue().

◆ getValue() [4/4]

const RecordVal * llvm::Record::getValue ( StringRef  Name) const
inline

Definition at line 1780 of file Record.h.

References llvm::StringInit::get(), getRecords(), and getValue().

◆ getValueAsBit()

bool Record::getValueAsBit ( StringRef  FieldName) const

This method looks up the specified field and returns its value as a bit, throwing an exception if the field does not exist or if the value is not the right type.

Definition at line 3081 of file Record.cpp.

References getLoc(), getName(), getValue(), and llvm::PrintFatalError().

Referenced by llvm::DirectiveLanguage::hasEnableBitmaskEnumInNamespace(), llvm::DirectiveLanguage::hasMakeEnumAvailableInNamespace(), and llvm::BaseRecord::isDefault().

◆ getValueAsBitOrUnset()

bool Record::getValueAsBitOrUnset ( StringRef  FieldName,
bool Unset 
) const

This method looks up the specified field and returns its value as a bit.

If the field is unset, sets Unset to true and returns false.

Definition at line 3093 of file Record.cpp.

References getLoc(), getName(), getValue(), llvm::PrintFatalError(), and llvm::StringRef::str().

◆ getValueAsBitsInit()

BitsInit * Record::getValueAsBitsInit ( StringRef  FieldName) const

This method looks up the specified field and returns its value as a BitsInit, throwing an exception if the field does not exist or if the value is not the right type.

Definition at line 2970 of file Record.cpp.

References getLoc(), getName(), getValue(), and llvm::PrintFatalError().

◆ getValueAsDag()

DagInit * Record::getValueAsDag ( StringRef  FieldName) const

This method looks up the specified field and returns its value as an Dag, throwing an exception if the field does not exist or if the value is not the right type.

Definition at line 3110 of file Record.cpp.

References getLoc(), getName(), getValue(), and llvm::PrintFatalError().

◆ getValueAsDef()

Record * Record::getValueAsDef ( StringRef  FieldName) const

This method looks up the specified field and returns its value as a Record, throwing an exception if the field does not exist or if the value is not the right type.

Definition at line 3054 of file Record.cpp.

References getLoc(), getName(), getValue(), and llvm::PrintFatalError().

◆ getValueAsInt()

int64_t Record::getValueAsInt ( StringRef  FieldName) const

This method looks up the specified field and returns its value as an int64_t, throwing an exception if the field does not exist or if the value is not the right type.

Definition at line 3008 of file Record.cpp.

References getLoc(), getName(), getValue(), and llvm::PrintFatalError().

Referenced by llvm::LessRecordRegister::operator()().

◆ getValueAsListInit()

ListInit * Record::getValueAsListInit ( StringRef  FieldName) const

This method looks up the specified field and returns its value as a ListInit, throwing an exception if the field does not exist or if the value is not the right type.

Definition at line 2982 of file Record.cpp.

References getLoc(), getName(), getValue(), and llvm::PrintFatalError().

Referenced by getValueAsListOfDefs(), getValueAsListOfInts(), and getValueAsListOfStrings().

◆ getValueAsListOfDefs()

std::vector< Record * > Record::getValueAsListOfDefs ( StringRef  FieldName) const

This method looks up the specified field and returns its value as a vector of records, throwing an exception if the field does not exist or if the value is not the right type.

Definition at line 2995 of file Record.cpp.

References getLoc(), getName(), getValueAsListInit(), I, llvm::List, and llvm::PrintFatalError().

Referenced by llvm::Directive::getAllowedClauses(), llvm::Directive::getAllowedExclusiveClauses(), llvm::Directive::getAllowedOnceClauses(), and llvm::Directive::getRequiredClauses().

◆ getValueAsListOfInts()

std::vector< int64_t > Record::getValueAsListOfInts ( StringRef  FieldName) const

This method looks up the specified field and returns its value as a vector of integers, throwing an exception if the field does not exist or if the value is not the right type.

Definition at line 3023 of file Record.cpp.

References getLoc(), getName(), getValueAsListInit(), I, llvm::List, and llvm::PrintFatalError().

◆ getValueAsListOfStrings()

std::vector< StringRef > Record::getValueAsListOfStrings ( StringRef  FieldName) const

This method looks up the specified field and returns its value as a vector of strings, throwing an exception if the field does not exist or if the value is not the right type.

Definition at line 3039 of file Record.cpp.

References getLoc(), getName(), getValueAsListInit(), I, llvm::List, and llvm::PrintFatalError().

◆ getValueAsOptionalDef()

Record * Record::getValueAsOptionalDef ( StringRef  FieldName) const

This method looks up the specified field and returns its value as a Record, returning null if the field exists but is "uninitialized" (i.e.

set to ?), and throwing an exception if the field does not exist or if its value is not the right type.

Definition at line 3066 of file Record.cpp.

References getLoc(), getName(), getValue(), and llvm::PrintFatalError().

◆ getValueAsOptionalString()

std::optional< StringRef > Record::getValueAsOptionalString ( StringRef  FieldName) const

This method looks up the specified field and returns its value as a string, throwing an exception if the value is not a string and std::nullopt if the field does not exist.

Definition at line 2955 of file Record.cpp.

References getLoc(), getName(), getValue(), and llvm::PrintFatalError().

Referenced by getValueAsString().

◆ getValueAsString()

StringRef Record::getValueAsString ( StringRef  FieldName) const

◆ getValueInit()

Init * Record::getValueInit ( StringRef  FieldName) const

Return the initializer for a value with the specified name, or throw an exception if the field does not exist.

Definition at line 2938 of file Record.cpp.

References getLoc(), getName(), getValue(), and llvm::PrintFatalError().

Referenced by isValueUnset().

◆ getValues()

ArrayRef< RecordVal > llvm::Record::getValues ( ) const
inline

Definition at line 1755 of file Record.h.

◆ hasDirectSuperClass()

bool Record::hasDirectSuperClass ( const Record SuperClass) const

Determine whether this record has the specified direct superclass.

Definition at line 2816 of file Record.cpp.

References getSuperClasses(), I, and llvm::ArrayRef< T >::size().

◆ isAnonymous()

bool llvm::Record::isAnonymous ( ) const
inline

Definition at line 1749 of file Record.h.

References RK_AnonymousDef.

◆ isClass()

bool llvm::Record::isClass ( ) const
inline

Definition at line 1745 of file Record.h.

References RK_Class.

Referenced by llvm::TGVarScope::getVar().

◆ isMultiClass()

bool llvm::Record::isMultiClass ( ) const
inline

Definition at line 1747 of file Record.h.

References RK_MultiClass.

Referenced by QualifyName().

◆ isSubClassOf() [1/2]

bool llvm::Record::isSubClassOf ( const Record R) const
inline

Definition at line 1833 of file Record.h.

Referenced by addSuperClass(), and llvm::RecordRecTy::isSubClassOf().

◆ isSubClassOf() [2/2]

bool llvm::Record::isSubClassOf ( StringRef  Name) const
inline

Definition at line 1840 of file Record.h.

◆ isTemplateArg()

bool llvm::Record::isTemplateArg ( Init Name) const
inline

Definition at line 1770 of file Record.h.

References llvm::is_contained().

Referenced by addTemplateArg(), and llvm::TGVarScope::getVar().

◆ isValueUnset()

bool llvm::Record::isValueUnset ( StringRef  FieldName) const
inline

Return true if the named field is unset.

Definition at line 1891 of file Record.h.

References getValueInit().

◆ removeValue() [1/2]

void llvm::Record::removeValue ( Init Name)
inline

◆ removeValue() [2/2]

void llvm::Record::removeValue ( StringRef  Name)
inline

Definition at line 1811 of file Record.h.

References llvm::StringInit::get(), getRecords(), and removeValue().

◆ resolveReferences() [1/2]

void Record::resolveReferences ( Init NewName = nullptr)

If there are any field references that refer to fields that have been filled in, we can propagate the values now.

This is a final resolve: any error messages, e.g. due to undefined !cast references, are generated now.

Definition at line 2883 of file Record.cpp.

References resolveReferences().

Referenced by resolveReferences().

◆ resolveReferences() [2/2]

void Record::resolveReferences ( Resolver R,
const RecordVal SkipVal = nullptr 
)

Apply the resolver to the name of the record as well as to the initializers of all fields of the record except SkipVal.

The resolver should not resolve any of the fields itself, to avoid recursion / infinite loops.

Definition at line 2839 of file Record.cpp.

References llvm::Init::getAsUnquotedString(), getLoc(), getNameInit(), llvm::Value::getType(), llvm::PrintFatalError(), llvm::Init::resolveReferences(), and setName().

◆ setName()

void Record::setName ( Init Name)

Definition at line 2795 of file Record.cpp.

Referenced by resolveReferences().

◆ updateClassLoc()

void Record::updateClassLoc ( SMLoc  Loc)

Definition at line 2761 of file Record.cpp.

References assert().


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