LLVM 23.0.0git
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 (const 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
const InitgetNameInit () const
std::string getNameInitAsString () const
void setName (const Init *Name)
ArrayRef< SMLocgetLoc () const
void appendLoc (SMLoc Loc)
ArrayRef< SMLocgetForwardDeclarationLocs () const
void appendReferenceLoc (SMRange Loc) const
 Add a reference to this record value.
ArrayRef< SMRangegetReferenceLocs () const
 Return the references of this record value.
void updateClassLoc (SMLoc Loc)
const RecordRecTygetType () const
DefInitgetDefInit () const
 get the corresponding DefInit.
bool isClass () const
bool isMultiClass () const
bool isAnonymous () const
ArrayRef< const Init * > getTemplateArgs () const
ArrayRef< RecordValgetValues () const
ArrayRef< AssertionInfogetAssertions () const
ArrayRef< DumpInfogetDumps () const
void getSuperClasses (std::vector< const Record * > &Classes) const
 Append all superclasses in post-order to Classes.
std::vector< const Record * > getSuperClasses () const
 Return all superclasses in post-order.
bool hasDirectSuperClass (const Record *SuperClass) const
 Determine whether this record has the specified direct superclass.
ArrayRef< std::pair< const Record *, SMRange > > getDirectSuperClasses () const
 Return the direct superclasses of this record.
bool isTemplateArg (const Init *Name) const
const RecordValgetValue (const Init *Name) const
const RecordValgetValue (StringRef Name) const
RecordValgetValue (const Init *Name)
RecordValgetValue (StringRef Name)
void addTemplateArg (const Init *Name)
void addValue (const RecordVal &RV)
void removeValue (const Init *Name)
void removeValue (StringRef Name)
void addAssertion (SMLoc Loc, const Init *Condition, const Init *Message)
void addDump (SMLoc Loc, const 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 addDirectSuperClass (const Record *R, SMRange Range)
void resolveReferences (const 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.
const 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.
const 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.
const 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< const 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.
const 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.
const 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.
const 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 1630 of file Record.h.

Member Enumeration Documentation

◆ RecordKind

Enumerator
RK_Def 
RK_AnonymousDef 
RK_Class 
RK_MultiClass 

Definition at line 1652 of file Record.h.

Constructor & Destructor Documentation

◆ Record() [1/3]

◆ Record() [2/3]

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

Definition at line 1693 of file Record.h.

References llvm::get(), N, Record(), and RK_Def.

◆ Record() [3/3]

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

Definition at line 1700 of file Record.h.

References getNewUID(), getRecords(), and Record().

Member Function Documentation

◆ addAssertion()

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

Definition at line 1827 of file Record.h.

◆ addDirectSuperClass()

void llvm::Record::addDirectSuperClass ( const Record * R,
SMRange Range )
inline

Definition at line 1867 of file Record.h.

References assert(), isSubClassOf(), Range, and Record().

◆ addDump()

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

Definition at line 1831 of file Record.h.

◆ addTemplateArg()

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

Definition at line 1805 of file Record.h.

References assert(), and isTemplateArg().

◆ addValue()

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

Definition at line 1810 of file Record.h.

References assert(), llvm::RecordVal::getNameInit(), and getValue().

◆ appendAssertions()

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

Definition at line 1835 of file Record.h.

References Record().

◆ appendDumps()

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

Definition at line 1839 of file Record.h.

References Record().

◆ appendLoc()

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

Definition at line 1722 of file Record.h.

◆ appendReferenceLoc()

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

Add a reference to this record value.

Definition at line 1729 of file Record.h.

◆ checkRecordAssertions()

void Record::checkRecordAssertions ( )

◆ checkUnusedTemplateArgs()

void Record::checkUnusedTemplateArgs ( )

◆ dump()

LLVM_DUMP_METHOD void Record::dump ( ) const

Definition at line 3097 of file Record.cpp.

References llvm::errs(), and LLVM_DUMP_METHOD.

◆ emitRecordDumps()

void Record::emitRecordDumps ( )

Definition at line 3318 of file Record.cpp.

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

◆ getAssertions()

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

Definition at line 1753 of file Record.h.

Referenced by checkRecordAssertions().

◆ getDefInit()

DefInit * Record::getDefInit ( ) const

get the corresponding DefInit.

Definition at line 3017 of file Record.cpp.

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

◆ getDirectSuperClasses()

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

Return the direct superclasses of this record.

Definition at line 1777 of file Record.h.

Referenced by getType().

◆ getDumps()

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

Definition at line 1754 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 3135 of file Record.cpp.

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

◆ getForwardDeclarationLocs()

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

Definition at line 1724 of file Record.h.

◆ getID()

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

Definition at line 1709 of file Record.h.

◆ getLoc()

◆ getName()

◆ getNameInit()

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

◆ getNameInitAsString()

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

Definition at line 1715 of file Record.h.

References llvm::Init::getAsUnquotedString(), and getNameInit().

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

◆ getNewUID()

unsigned Record::getNewUID ( RecordKeeper & RK)
static

Definition at line 3025 of file Record.cpp.

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

Referenced by Record(), and Record().

◆ getRecords()

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

Definition at line 1888 of file Record.h.

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

◆ getReferenceLocs()

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

Return the references of this record value.

Definition at line 1732 of file Record.h.

◆ getSuperClasses() [1/2]

std::vector< const Record * > llvm::Record::getSuperClasses ( ) const
inline

Return all superclasses in post-order.

Definition at line 1765 of file Record.h.

References getSuperClasses().

Referenced by getSuperClasses().

◆ getSuperClasses() [2/2]

void llvm::Record::getSuperClasses ( std::vector< const Record * > & Classes) const
inline

Append all superclasses in post-order to Classes.

Definition at line 1757 of file Record.h.

References llvm::make_first_range(), and Record().

◆ getTemplateArgs()

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

Definition at line 1749 of file Record.h.

Referenced by checkUnusedTemplateArgs().

◆ getType()

◆ getValue() [1/4]

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

Definition at line 1795 of file Record.h.

References Record().

◆ 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 1800 of file Record.h.

References Record().

◆ getValue() [4/4]

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

Definition at line 1791 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 3266 of file Record.cpp.

References llvm::dyn_cast(), getLoc(), getName(), getValueInit(), I, and llvm::PrintFatalError().

◆ 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 3274 of file Record.cpp.

References llvm::dyn_cast(), getLoc(), getName(), getValueInit(), I, llvm::isa(), llvm::PrintFatalError(), and llvm::Unset.

◆ getValueAsBitsInit()

const 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 3175 of file Record.cpp.

References llvm::dyn_cast(), getLoc(), getName(), getValueInit(), I, and llvm::PrintFatalError().

◆ getValueAsDag()

const 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 3287 of file Record.cpp.

References llvm::dyn_cast(), getLoc(), getName(), getValueInit(), I, and llvm::PrintFatalError().

◆ getValueAsDef()

const 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 3248 of file Record.cpp.

References llvm::dyn_cast(), getLoc(), getName(), getValueInit(), I, llvm::PrintFatalError(), and Record().

◆ 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 3206 of file Record.cpp.

References llvm::dyn_cast(), getLoc(), getName(), getValueInit(), I, II, and llvm::PrintFatalError().

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

◆ getValueAsListInit()

const 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 3183 of file Record.cpp.

References llvm::dyn_cast(), getLoc(), getName(), getValueInit(), I, and llvm::PrintFatalError().

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

◆ getValueAsListOfDefs()

std::vector< const 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 3192 of file Record.cpp.

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

◆ 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 3217 of file Record.cpp.

References llvm::dyn_cast(), getLoc(), getName(), getValueAsListInit(), I, II, 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 3233 of file Record.cpp.

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

◆ getValueAsOptionalDef()

const 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 3256 of file Record.cpp.

References llvm::dyn_cast(), getLoc(), getName(), getValueInit(), I, llvm::isa(), llvm::PrintFatalError(), and Record().

◆ 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 3160 of file Record.cpp.

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

◆ getValueAsString()

StringRef Record::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.

Definition at line 3151 of file Record.cpp.

References llvm::dyn_cast(), getLoc(), getName(), getValueInit(), I, and llvm::PrintFatalError().

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

◆ getValueInit()

const 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 3143 of file Record.cpp.

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

Referenced by getValueAsBit(), getValueAsBitOrUnset(), getValueAsBitsInit(), getValueAsDag(), getValueAsDef(), getValueAsInt(), getValueAsListInit(), getValueAsOptionalDef(), getValueAsString(), and isValueUnset().

◆ getValues()

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

Definition at line 1751 of file Record.h.

◆ hasDirectSuperClass()

bool llvm::Record::hasDirectSuperClass ( const Record * SuperClass) const
inline

Determine whether this record has the specified direct superclass.

Definition at line 1772 of file Record.h.

References llvm::is_contained(), llvm::make_first_range(), and Record().

◆ isAnonymous()

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

Definition at line 1747 of file Record.h.

References RK_AnonymousDef.

◆ isClass()

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

Definition at line 1743 of file Record.h.

References RK_Class.

◆ isMultiClass()

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

Definition at line 1745 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 1845 of file Record.h.

References llvm::make_first_range(), and Record().

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

◆ isSubClassOf() [2/2]

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

Definition at line 1853 of file Record.h.

References llvm::dyn_cast(), llvm::make_first_range(), and Record().

◆ isTemplateArg()

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

Definition at line 1781 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 1906 of file Record.h.

References getValueInit(), and llvm::isa().

◆ removeValue() [1/2]

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

Definition at line 1815 of file Record.h.

References llvm::find_if(), and llvm_unreachable.

Referenced by removeValue().

◆ removeValue() [2/2]

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

Definition at line 1823 of file Record.h.

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

◆ resolveReferences() [1/2]

void Record::resolveReferences ( const 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 3089 of file Record.cpp.

References resolveReferences().

Referenced by llvm::FieldInit::resolveReferences(), and 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 3045 of file Record.cpp.

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

◆ setName()

void Record::setName ( const Init * Name)

◆ updateClassLoc()

void Record::updateClassLoc ( SMLoc Loc)

Definition at line 2995 of file Record.cpp.

References assert().


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