#include "/work/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/AST/ByteCode/Pointer.h"

Public Member Functions
ArrayRef< PointerPathEntry >	path () const
bool	hasDeclBase () const
const VarDecl *	getBaseDecl () const
const Expr *	getBaseExpr () const
OpaquePointer	withFieldType (const Type *FieldTy, std::optional< bool > PastEnd=std::nullopt) const
OpaquePointer	withPath (const PointerPathEntry Path, unsigned PathLength, const Type FieldTy, std::optional< bool > PastEnd=std::nullopt) const
OpaquePointer	withPastEnd (bool PastEnd) const
QualType	getObjectType () const
QualType	getFieldType () const
bool	isArrayElement () const
std::optional< size_t >	computeLayoutOffset (const ASTContext &ASTCtx) const
QualType	getSurroundingArray () const
	If this is pointing to an array element, return the array.
bool	isOnePastEnd () const
bool	isOnePastEndOrElementPastEnd () const
	This is used in Pointer::isOnePastEnd().
bool	isConstexprUnknown () const
bool	isUnknownSizeArray () const
bool	isRoot () const
	Check if the pointer has offset 0.

Public Attributes
DeclOrExpr	Base
llvm::PointerIntPair< const Type *, 2, unsigned >	FieldType = {}
const PointerPathEntry *	Path = nullptr
unsigned	PathLength = 0

Detailed Description

Definition at line 435 of file Pointer.h.

Member Function Documentation

◆ computeLayoutOffset()

std::optional< size_t > OpaquePointer::computeLayoutOffset ( const ASTContext & ASTCtx ) const

Definition at line 1398 of file Pointer.cpp.

References clang::interp::Add(), clang::interp::PointerPathEntry::Array, clang::interp::PointerPathEntry::Base, clang::interp::PointerPathEntry::Field, clang::Type::getAsArrayTypeUnsafe(), clang::Type::getAsRecordDecl(), clang::ASTContext::getASTRecordLayout(), clang::ASTRecordLayout::getBaseClassOffset(), clang::ASTContext::getCanonicalTagType(), clang::ArrayType::getElementType(), clang::FieldDecl::getFieldIndex(), clang::ASTRecordLayout::getFieldOffset(), getObjectType(), clang::FieldDecl::getParent(), clang::CharUnits::getQuantity(), clang::ValueDecl::getType(), clang::ASTContext::getTypeSizeInChars(), clang::ASTRecordLayout::getVBaseClassOffset(), clang::ASTContext::hasLayout(), clang::isa(), clang::Type::isArrayType(), clang::interp::PointerPathEntry::NegativeArray, path(), clang::ASTContext::toCharUnitsFromBits(), and validType().

◆ getBaseDecl()

const VarDecl * clang::interp::OpaquePointer::getBaseDecl ( ) const

inline

Definition at line 444 of file Pointer.h.

References Base.

Referenced by computeOpaqueSize().

◆ getBaseExpr()

const Expr * clang::interp::OpaquePointer::getBaseExpr ( ) const

inline

Definition at line 445 of file Pointer.h.

References Base.

◆ getFieldType()

QualType clang::interp::OpaquePointer::getFieldType ( ) const

inline

Definition at line 482 of file Pointer.h.

References Base, and FieldType.

Referenced by clang::interp::addSubOffsetOpaque(), clang::interp::copyPrimitiveMemory(), clang::interp::copyPrimitiveMemory(), clang::interp::evaluateBuiltinObjectSize(), clang::interp::getBase(), clang::interp::getField(), getSurroundingArray(), clang::interp::InitGlobal(), isUnknownSizeArray(), and clang::interp::virtBaseHelper().

◆ getObjectType()

QualType clang::interp::OpaquePointer::getObjectType ( ) const

inline

Definition at line 475 of file Pointer.h.

References Base, and clang::T.

Referenced by computeFieldType(), computeLayoutOffset(), computeOpaquePtrOffset(), computeOpaqueSize(), clang::interp::evaluateBuiltinObjectSize(), getSurroundingArray(), isRoot(), and isUserWritingOffTheEnd().

◆ getSurroundingArray()

QualType OpaquePointer::getSurroundingArray ( ) const

If this is pointing to an array element, return the array.

Definition at line 1460 of file Pointer.cpp.

References clang::interp::PointerPathEntry::Array, clang::interp::PointerPathEntry::Base, clang::interp::PointerPathEntry::Field, clang::Type::getAsArrayTypeUnsafe(), clang::ArrayType::getElementType(), getFieldType(), getObjectType(), isArrayElement(), clang::Type::isArrayType(), clang::interp::PointerPathEntry::NegativeArray, Path, path(), and PathLength.

Referenced by clang::interp::addSubOffsetOpaque(), clang::interp::arrayElemPtrOpaque(), isOnePastEndOrElementPastEnd(), isUnknownSizeArray(), and pointsToCompleteObject().

◆ hasDeclBase()

bool clang::interp::OpaquePointer::hasDeclBase ( ) const

inline

Definition at line 443 of file Pointer.h.

References Base.

◆ isArrayElement()

bool clang::interp::OpaquePointer::isArrayElement ( ) const

inline

Definition at line 488 of file Pointer.h.

References clang::interp::PointerPathEntry::Array, Path, and PathLength.

Referenced by clang::interp::addSubOffsetOpaque(), clang::interp::arrayElemPtrOpaque(), getSurroundingArray(), isUnknownSizeArray(), and pointsToCompleteObject().

◆ isConstexprUnknown()

bool clang::interp::OpaquePointer::isConstexprUnknown ( ) const

inline

Definition at line 499 of file Pointer.h.

References FieldType.

Referenced by withFieldType(), and withPath().

◆ isOnePastEnd()

bool clang::interp::OpaquePointer::isOnePastEnd ( ) const

inline

Definition at line 497 of file Pointer.h.

References FieldType.

Referenced by clang::interp::AddrOf(), clang::interp::copyPrimitiveMemory(), clang::interp::copyPrimitiveMemory(), clang::interp::InitGlobal(), and isOnePastEndOrElementPastEnd().

◆ isOnePastEndOrElementPastEnd()

bool OpaquePointer::isOnePastEndOrElementPastEnd ( ) const

This is used in Pointer::isOnePastEnd().

We cannot read from such pointers. We can of course never read from opaque pointers anyway but we diagnose one-past-the-end pointers differently.

In contrast, OpaquePointer::isOnePastEnd() only uses the past-end bit. That is used for the APValue conversion.

Definition at line 1548 of file Pointer.cpp.

References clang::interp::PointerPathEntry::Array, clang::Type::getAsArrayTypeUnsafe(), getSurroundingArray(), clang::Type::isArrayType(), isOnePastEnd(), Path, and PathLength.

◆ isRoot()

bool OpaquePointer::isRoot ( ) const

Check if the pointer has offset 0.

Definition at line 1491 of file Pointer.cpp.

References clang::interp::PointerPathEntry::Array, clang::interp::PointerPathEntry::Base, clang::interp::PointerPathEntry::Field, clang::Type::getAsArrayTypeUnsafe(), clang::ArrayType::getElementType(), getObjectType(), clang::Type::isArrayType(), clang::interp::PointerPathEntry::NegativeArray, and path().

◆ isUnknownSizeArray()

bool OpaquePointer::isUnknownSizeArray ( ) const

Definition at line 1520 of file Pointer.cpp.

References Base, FieldType, getFieldType(), getSurroundingArray(), clang::isa(), isArrayElement(), and clang::Result.

◆ path()

ArrayRef< PointerPathEntry > clang::interp::OpaquePointer::path ( ) const

inline

Definition at line 442 of file Pointer.h.

References Path, and PathLength.

Referenced by computeFieldType(), computeLayoutOffset(), computeOpaquePtrOffset(), getSurroundingArray(), and isRoot().

◆ withFieldType()

OpaquePointer clang::interp::OpaquePointer::withFieldType	(	const Type *	FieldTy,
		std::optional< bool >	PastEnd = std::nullopt ) const

inline

Definition at line 448 of file Pointer.h.

References Base, FieldType, isConstexprUnknown(), Path, and PathLength.

Referenced by clang::interp::AddrOf(), clang::interp::arrayElemPtrOpaque(), and clang::interp::LoadPopL().

◆ withPastEnd()

OpaquePointer clang::interp::OpaquePointer::withPastEnd ( bool PastEnd ) const

inline

Definition at line 467 of file Pointer.h.

References Base, FieldType, Path, and PathLength.

Referenced by clang::interp::addSubOffsetOpaque().

◆ withPath()

OpaquePointer clang::interp::OpaquePointer::withPath	(	const PointerPathEntry *	Path,
		unsigned	PathLength,
		const Type *	FieldTy,
		std::optional< bool >	PastEnd = std::nullopt ) const

inline

Definition at line 457 of file Pointer.h.

References Base, FieldType, isConstexprUnknown(), Path, and PathLength.

Referenced by clang::interp::addSubOffsetOpaque(), clang::interp::arrayElemPtrOpaque(), clang::interp::copyPrimitiveMemory(), clang::interp::copyPrimitiveMemory(), clang::interp::getBase(), clang::interp::getField(), clang::interp::InitGlobal(), and clang::interp::virtBaseHelper().

Member Data Documentation

◆ Base

DeclOrExpr clang::interp::OpaquePointer::Base

Definition at line 436 of file Pointer.h.

Referenced by clang::interp::evaluateBuiltinObjectSize(), getBaseDecl(), getBaseExpr(), getFieldType(), getObjectType(), hasDeclBase(), clang::interp::Pointer::hasSameBase(), isUnknownSizeArray(), clang::interp::Pointer::operator==(), withFieldType(), withPastEnd(), and withPath().

◆ FieldType

llvm::PointerIntPair<const Type *, 2, unsigned> clang::interp::OpaquePointer::FieldType = {}

Definition at line 438 of file Pointer.h.

Referenced by clang::interp::AddrOf(), clang::interp::addSubOffsetOpaque(), getFieldType(), isConstexprUnknown(), isOnePastEnd(), isUnknownSizeArray(), withFieldType(), withPastEnd(), and withPath().

◆ Path

const PointerPathEntry* clang::interp::OpaquePointer::Path = nullptr

Definition at line 439 of file Pointer.h.

Referenced by clang::interp::addSubOffsetOpaque(), clang::interp::arrayElemPtrOpaque(), clang::interp::copyPrimitiveMemory(), clang::interp::copyPrimitiveMemory(), clang::interp::getBase(), clang::interp::getField(), getSurroundingArray(), clang::interp::InitGlobal(), isArrayElement(), isOnePastEndOrElementPastEnd(), isUserWritingOffTheEnd(), clang::interp::Pointer::operator==(), path(), clang::interp::virtBaseHelper(), withFieldType(), withPastEnd(), and withPath().

◆ PathLength

unsigned clang::interp::OpaquePointer::PathLength = 0

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

lib/AST/ByteCode/Pointer.h
lib/AST/ByteCode/Pointer.cpp

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ computeLayoutOffset()

◆ getBaseDecl()

◆ getBaseExpr()

◆ getFieldType()

◆ getObjectType()

◆ getSurroundingArray()

◆ hasDeclBase()

◆ isArrayElement()

◆ isConstexprUnknown()

◆ isOnePastEnd()

◆ isOnePastEndOrElementPastEnd()

◆ isRoot()

◆ isUnknownSizeArray()

◆ path()

◆ withFieldType()

◆ withPastEnd()

◆ withPath()

Member Data Documentation

◆ Base

◆ FieldType

◆ Path

◆ PathLength