#include "llvm/TableGen/Record.h"

Classes
struct	AssertionInfo

Public Member Functions
	Record (Init *N, ArrayRef< SMLoc > locs, RecordKeeper &records, bool Anonymous=false, bool Class=false)

	Record (StringRef N, ArrayRef< SMLoc > locs, RecordKeeper &records, bool Class=false)

	Record (const Record &O)

unsigned	getID () const

StringRef	getName () const

Init *	getNameInit () const

std::string	getNameInitAsString () const

void	setName (Init *Name)

ArrayRef< SMLoc >	getLoc () const

void	appendLoc (SMLoc Loc)

ArrayRef< SMLoc >	getForwardDeclarationLocs () const

void	appendReferenceLoc (SMRange Loc)
	Add a reference to this record value.

ArrayRef< SMRange >	getReferenceLocs () const
	Return the references of this record value.

void	updateClassLoc (SMLoc Loc)

RecordRecTy *	getType ()

DefInit *	getDefInit ()
	get the corresponding DefInit.

bool	isClass () const

ArrayRef< Init * >	getTemplateArgs () const

ArrayRef< RecordVal >	getValues () const

ArrayRef< AssertionInfo >	getAssertions () 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 RecordVal *	getValue (const Init *Name) const

const RecordVal *	getValue (StringRef Name) const

RecordVal *	getValue (const Init *Name)

RecordVal *	getValue (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	appendAssertions (const Record *Rec)

void	checkRecordAssertions ()

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.

RecordKeeper &	getRecords () const

bool	isAnonymous () const

void	dump () const

SMLoc	getFieldLoc (StringRef FieldName) const
	Return the source location for the named field.

Init *	getValueInit (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< StringRef >	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.

BitsInit *	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.

ListInit *	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.

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

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.

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.

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.

DagInit *	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.

Static Public Member Functions
static unsigned	getNewUID (RecordKeeper &RK)

Detailed Description

Definition at line 1630 of file Record.h.

Constructor & Destructor Documentation

◆ Record() [1/3]

llvm::Record::Record	(	Init *	N,
		ArrayRef< SMLoc >	locs,
		RecordKeeper &	records,
		bool	Anonymous = `false`,
		bool	Class = `false`
	)

inlineexplicit

Definition at line 1675 of file Record.h.

◆ Record() [2/3]

llvm::Record::Record	(	StringRef	N,
		ArrayRef< SMLoc >	locs,
		RecordKeeper &	records,
		bool	Class = `false`
	)

inlineexplicit

Definition at line 1683 of file Record.h.

◆ Record() [3/3]

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

inline

Definition at line 1690 of file Record.h.

Member Function Documentation

◆ addAssertion()

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

inline

Definition at line 1800 of file Record.h.

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

◆ addSuperClass()

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

inline

Definition at line 1830 of file Record.h.

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

◆ addTemplateArg()

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

inline

Definition at line 1777 of file Record.h.

References assert(), and isTemplateArg().

◆ addValue()

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

inline

Definition at line 1782 of file Record.h.

References assert(), llvm::RecordVal::getNameInit(), getValue(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().

◆ appendAssertions()

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

inline

Definition at line 1804 of file Record.h.

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

◆ appendLoc()

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

inline

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

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

◆ checkRecordAssertions()

void Record::checkRecordAssertions ( )

Definition at line 3061 of file Record.cpp.

References llvm::CheckAssert(), getAssertions(), and llvm::Init::resolveReferences().

◆ checkUnusedTemplateArgs()

void Record::checkUnusedTemplateArgs ( )

Definition at line 3073 of file Record.cpp.

References llvm::RecordVal::getLoc(), llvm::RecordVal::getName(), getTemplateArgs(), getValue(), llvm::RecordVal::isUsed(), and llvm::PrintWarning().

◆ dump()

LLVM_DUMP_METHOD void Record::dump ( ) const

Definition at line 2826 of file Record.cpp.

References llvm::errs().

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

◆ getAssertions()

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

inline

Definition at line 1743 of file Record.h.

Referenced by checkRecordAssertions().

◆ getDefInit()

DefInit * Record::getDefInit ( )

get the corresponding DefInit.

Definition at line 2723 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 2769 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().

◆ getFieldLoc()

SMLoc Record::getFieldLoc ( StringRef FieldName ) const

Return the source location for the named field.

Definition at line 2865 of file Record.cpp.

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

◆ getForwardDeclarationLocs()

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

inline

Definition at line 1716 of file Record.h.

◆ getID()

unsigned llvm::Record::getID ( ) const

inline

Definition at line 1699 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

Definition at line 1703 of file Record.h.

Referenced by llvm::UnOpInit::Fold(), llvm::ExistsOpInit::Fold(), getNameInitAsString(), QualifyName(), removeValue(), and resolveReferences().

◆ getNameInitAsString()

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

inline

Definition at line 1707 of file Record.h.

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

Referenced by llvm::CondOpInit::Fold(), and llvm::VarDefInit::getAsString().

◆ getNewUID()

unsigned Record::getNewUID ( RecordKeeper & RK )

static

Definition at line 2731 of file Record.cpp.

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

◆ getRecords()

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

inline

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

◆ getSuperClasses()

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

inline

Definition at line 1745 of file Record.h.

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

◆ getTemplateArgs()

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

inline

Definition at line 1737 of file Record.h.

Referenced by checkUnusedTemplateArgs().

◆ getType()

RecordRecTy * Record::getType ( )

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

References getValue().

◆ getValue() [2/4]

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

inline

Definition at line 1759 of file Record.h.

Referenced by addValue(), checkUnusedTemplateArgs(), getFieldLoc(), llvm::DefInit::getFieldType(), getValue(), getValueAsBit(), getValueAsBitOrUnset(), getValueAsBitsInit(), getValueAsDag(), getValueAsDef(), getValueAsInt(), getValueAsListInit(), getValueAsOptionalDef(), getValueAsOptionalString(), getValueInit(), and llvm::TGVarScope::getVar().

◆ getValue() [3/4]

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

inline

Definition at line 1773 of file Record.h.

References getValue().

◆ getValue() [4/4]

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

inline

Definition at line 1765 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 3016 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 3028 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 2905 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 3045 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 2989 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 2943 of file Record.cpp.

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

◆ 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 2917 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 2930 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 2958 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 2974 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 3001 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 2890 of file Record.cpp.

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

Referenced by getValueAsString().

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

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

Referenced by llvm::BaseRecord::getAlternativeName(), llvm::Clause::getClangClass(), llvm::DirectiveLanguage::getClauseEnumSetClass(), llvm::DirectiveLanguage::getClausePrefix(), llvm::DirectiveLanguage::getCppNamespace(), llvm::DirectiveLanguage::getDirectivePrefix(), llvm::Clause::getFlangClass(), llvm::DirectiveLanguage::getFlangClauseBaseClass(), llvm::BaseRecord::getFormattedName(), llvm::Clause::getFormattedParserClassName(), llvm::DirectiveLanguage::getName(), llvm::BaseRecord::getName(), and llvm::LessRecordFieldName::operator()().

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

◆ hasDirectSuperClass()

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

Determine whether this record has the specified direct superclass.

Definition at line 2756 of file Record.cpp.

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

◆ isAnonymous()

bool llvm::Record::isAnonymous ( ) const

inline

Definition at line 1855 of file Record.h.

◆ isClass()

bool llvm::Record::isClass ( ) const

inline

Definition at line 1735 of file Record.h.

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

◆ isSubClassOf() [1/2]

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

inline

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

◆ isTemplateArg()

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

inline

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

References getValueInit().

◆ removeValue() [1/2]

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

inline

Definition at line 1787 of file Record.h.

References llvm::SmallVectorTemplateCommon< T, typename >::begin(), llvm::SmallVectorImpl< T >::erase(), getNameInit(), llvm_unreachable, and llvm::SmallVectorBase< Size_T >::size().

Referenced by removeValue().

◆ removeValue() [2/2]

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

inline

Definition at line 1796 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 2818 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 2779 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 2735 of file Record.cpp.

Referenced by resolveReferences().

◆ updateClassLoc()

void Record::updateClassLoc ( SMLoc Loc )

Definition at line 2701 of file Record.cpp.

References assert().

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

include/llvm/TableGen/Record.h
lib/TableGen/Record.cpp

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Record() [1/3]

◆ Record() [2/3]

◆ Record() [3/3]

Member Function Documentation

◆ addAssertion()

◆ addSuperClass()

◆ addTemplateArg()

◆ addValue()

◆ appendAssertions()

◆ appendLoc()

◆ appendReferenceLoc()

◆ checkRecordAssertions()

◆ checkUnusedTemplateArgs()

◆ dump()

◆ getAssertions()

◆ getDefInit()

◆ getDirectSuperClasses()

◆ getFieldLoc()

◆ getForwardDeclarationLocs()

◆ getID()

◆ getLoc()

◆ getName()

◆ getNameInit()

◆ getNameInitAsString()

◆ getNewUID()

◆ getRecords()

◆ getReferenceLocs()

◆ getSuperClasses()

◆ getTemplateArgs()

◆ getType()

◆ getValue() [1/4]

◆ getValue() [2/4]

◆ getValue() [3/4]

◆ getValue() [4/4]

◆ getValueAsBit()

◆ getValueAsBitOrUnset()

◆ getValueAsBitsInit()

◆ getValueAsDag()

◆ getValueAsDef()

◆ getValueAsInt()

◆ getValueAsListInit()

◆ getValueAsListOfDefs()

◆ getValueAsListOfInts()

◆ getValueAsListOfStrings()

◆ getValueAsOptionalDef()

◆ getValueAsOptionalString()

◆ getValueAsString()

◆ getValueInit()

◆ getValues()

◆ hasDirectSuperClass()

◆ isAnonymous()

◆ isClass()

◆ isSubClassOf() [1/2]

◆ isSubClassOf() [2/2]

◆ isTemplateArg()

◆ isValueUnset()

◆ removeValue() [1/2]

◆ removeValue() [2/2]

◆ resolveReferences() [1/2]

◆ resolveReferences() [2/2]

◆ setName()

◆ updateClassLoc()