clang  3.9.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
clang::PseudoObjectExpr Class Referencefinal

PseudoObjectExpr - An expression which accesses a pseudo-object l-value. More...

#include <Expr.h>

Inheritance diagram for clang::PseudoObjectExpr:
[legend]
Collaboration diagram for clang::PseudoObjectExpr:
[legend]

Public Types

enum  : unsigned { NoResult = ~0U }
 NoResult - A value for the result index indicating that there is no semantic result. More...
 
typedef Expr *const * semantics_iterator
 
typedef const Expr *const * const_semantics_iterator
 
- Public Types inherited from clang::Expr
enum  LValueClassification {
  LV_Valid, LV_NotObjectType, LV_IncompleteVoidType, LV_DuplicateVectorComponents,
  LV_InvalidExpression, LV_InvalidMessageExpression, LV_MemberFunction, LV_SubObjCPropertySetting,
  LV_ClassTemporary, LV_ArrayTemporary
}
 
enum  isModifiableLvalueResult {
  MLV_Valid, MLV_NotObjectType, MLV_IncompleteVoidType, MLV_DuplicateVectorComponents,
  MLV_InvalidExpression, MLV_LValueCast, MLV_IncompleteType, MLV_ConstQualified,
  MLV_ConstAddrSpace, MLV_ArrayType, MLV_NoSetterProperty, MLV_MemberFunction,
  MLV_SubObjCPropertySetting, MLV_InvalidMessageExpression, MLV_ClassTemporary, MLV_ArrayTemporary
}
 
enum  SideEffectsKind { SE_NoSideEffects, SE_AllowUndefinedBehavior, SE_AllowSideEffects }
 
enum  NullPointerConstantKind {
  NPCK_NotNull = 0, NPCK_ZeroExpression, NPCK_ZeroLiteral, NPCK_CXX11_nullptr,
  NPCK_GNUNull
}
 Enumeration used to describe the kind of Null pointer constant returned from isNullPointerConstant(). More...
 
enum  NullPointerConstantValueDependence { NPC_NeverValueDependent = 0, NPC_ValueDependentIsNull, NPC_ValueDependentIsNotNull }
 Enumeration used to describe how isNullPointerConstant() should cope with value-dependent expressions. More...
 

Public Member Functions

ExprgetSyntacticForm ()
 Return the syntactic form of this expression, i.e. More...
 
const ExprgetSyntacticForm () const
 
unsigned getResultExprIndex () const
 Return the index of the result-bearing expression into the semantics expressions, or PseudoObjectExpr::NoResult if there is none. More...
 
ExprgetResultExpr ()
 Return the result-bearing expression, or null if there is none. More...
 
const ExprgetResultExpr () const
 
unsigned getNumSemanticExprs () const
 
semantics_iterator semantics_begin ()
 
const_semantics_iterator semantics_begin () const
 
semantics_iterator semantics_end ()
 
const_semantics_iterator semantics_end () const
 
llvm::iterator_range
< semantics_iterator
semantics ()
 
llvm::iterator_range
< const_semantics_iterator
semantics () const
 
ExprgetSemanticExpr (unsigned index)
 
const ExprgetSemanticExpr (unsigned index) const
 
SourceLocation getExprLoc () const LLVM_READONLY
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
child_range children ()
 
- Public Member Functions inherited from clang::Expr
QualType getType () const
 
void setType (QualType t)
 
bool isValueDependent () const
 isValueDependent - Determines whether this expression is value-dependent (C++ [temp.dep.constexpr]). More...
 
void setValueDependent (bool VD)
 Set whether this expression is value-dependent or not. More...
 
bool isTypeDependent () const
 isTypeDependent - Determines whether this expression is type-dependent (C++ [temp.dep.expr]), which means that its type could change from one template instantiation to the next. More...
 
void setTypeDependent (bool TD)
 Set whether this expression is type-dependent or not. More...
 
bool isInstantiationDependent () const
 Whether this expression is instantiation-dependent, meaning that it depends in some way on a template parameter, even if neither its type nor (constant) value can change due to the template instantiation. More...
 
void setInstantiationDependent (bool ID)
 Set whether this expression is instantiation-dependent or not. More...
 
bool containsUnexpandedParameterPack () const
 Whether this expression contains an unexpanded parameter pack (for C++11 variadic templates). More...
 
void setContainsUnexpandedParameterPack (bool PP=true)
 Set the bit that describes whether this expression contains an unexpanded parameter pack. More...
 
SourceLocation getExprLoc () const LLVM_READONLY
 getExprLoc - Return the preferred location for the arrow when diagnosing a problem with a generic expression. More...
 
bool isUnusedResultAWarning (const Expr *&WarnExpr, SourceLocation &Loc, SourceRange &R1, SourceRange &R2, ASTContext &Ctx) const
 isUnusedResultAWarning - Return true if this immediate expression should be warned about if the result is unused. More...
 
bool isLValue () const
 isLValue - True if this expression is an "l-value" according to the rules of the current language. More...
 
bool isRValue () const
 
bool isXValue () const
 
bool isGLValue () const
 
LValueClassification ClassifyLValue (ASTContext &Ctx) const
 Reasons why an expression might not be an l-value. More...
 
isModifiableLvalueResult isModifiableLvalue (ASTContext &Ctx, SourceLocation *Loc=nullptr) const
 isModifiableLvalue - C99 6.3.2.1: an lvalue that does not have array type, does not have an incomplete type, does not have a const-qualified type, and if it is a structure or union, does not have any member (including, recursively, any member or element of all contained aggregates or unions) with a const-qualified type. More...
 
Classification Classify (ASTContext &Ctx) const
 Classify - Classify this expression according to the C++11 expression taxonomy. More...
 
Classification ClassifyModifiable (ASTContext &Ctx, SourceLocation &Loc) const
 ClassifyModifiable - Classify this expression according to the C++11 expression taxonomy, and see if it is valid on the left side of an assignment. More...
 
ExprValueKind getValueKind () const
 getValueKind - The value kind that this expression produces. More...
 
ExprObjectKind getObjectKind () const
 getObjectKind - The object kind that this expression produces. More...
 
bool isOrdinaryOrBitFieldObject () const
 
void setValueKind (ExprValueKind Cat)
 setValueKind - Set the value kind produced by this expression. More...
 
void setObjectKind (ExprObjectKind Cat)
 setObjectKind - Set the object kind produced by this expression. More...
 
bool refersToBitField () const
 Returns true if this expression is a gl-value that potentially refers to a bit-field. More...
 
FieldDeclgetSourceBitField ()
 If this expression refers to a bit-field, retrieve the declaration of that bit-field. More...
 
const FieldDeclgetSourceBitField () const
 
const ObjCPropertyRefExprgetObjCProperty () const
 If this expression is an l-value for an Objective C property, find the underlying property reference expression. More...
 
bool isObjCSelfExpr () const
 Check if this expression is the ObjC 'self' implicit parameter. More...
 
bool refersToVectorElement () const
 Returns whether this expression refers to a vector element. More...
 
bool refersToGlobalRegisterVar () const
 Returns whether this expression refers to a global register variable. More...
 
bool hasPlaceholderType () const
 Returns whether this expression has a placeholder type. More...
 
bool hasPlaceholderType (BuiltinType::Kind K) const
 Returns whether this expression has a specific placeholder type. More...
 
bool isKnownToHaveBooleanValue () const
 isKnownToHaveBooleanValue - Return true if this is an integer expression that is known to return 0 or 1. More...
 
bool isIntegerConstantExpr (llvm::APSInt &Result, const ASTContext &Ctx, SourceLocation *Loc=nullptr, bool isEvaluated=true) const
 isIntegerConstantExpr - Return true if this expression is a valid integer constant expression, and, if so, return its value in Result. More...
 
bool isIntegerConstantExpr (const ASTContext &Ctx, SourceLocation *Loc=nullptr) const
 
bool isCXX98IntegralConstantExpr (const ASTContext &Ctx) const
 isCXX98IntegralConstantExpr - Return true if this expression is an integral constant expression in C++98. More...
 
bool isCXX11ConstantExpr (const ASTContext &Ctx, APValue *Result=nullptr, SourceLocation *Loc=nullptr) const
 isCXX11ConstantExpr - Return true if this expression is a constant expression in C++11. More...
 
bool isConstantInitializer (ASTContext &Ctx, bool ForRef, const Expr **Culprit=nullptr) const
 isConstantInitializer - Returns true if this expression can be emitted to IR as a constant, and thus can be used as a constant initializer in C. More...
 
bool EvaluateAsRValue (EvalResult &Result, const ASTContext &Ctx) const
 EvaluateAsRValue - Return true if this is a constant which we can fold to an rvalue using any crazy technique (that has nothing to do with language standards) that we want to, even if the expression has side-effects. More...
 
bool EvaluateAsBooleanCondition (bool &Result, const ASTContext &Ctx) const
 EvaluateAsBooleanCondition - Return true if this is a constant which we we can fold and convert to a boolean condition using any crazy technique that we want to, even if the expression has side-effects. More...
 
bool EvaluateAsInt (llvm::APSInt &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects) const
 EvaluateAsInt - Return true if this is a constant which we can fold and convert to an integer, using any crazy technique that we want to. More...
 
bool EvaluateAsFloat (llvm::APFloat &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects) const
 EvaluateAsFloat - Return true if this is a constant which we can fold and convert to a floating point value, using any crazy technique that we want to. More...
 
bool isEvaluatable (const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects) const
 isEvaluatable - Call EvaluateAsRValue to see if this expression can be constant folded without side-effects, but discard the result. More...
 
bool HasSideEffects (const ASTContext &Ctx, bool IncludePossibleEffects=true) const
 HasSideEffects - This routine returns true for all those expressions which have any effect other than producing a value. More...
 
bool hasNonTrivialCall (const ASTContext &Ctx) const
 Determine whether this expression involves a call to any function that is not trivial. More...
 
llvm::APSInt EvaluateKnownConstInt (const ASTContext &Ctx, SmallVectorImpl< PartialDiagnosticAt > *Diag=nullptr) const
 EvaluateKnownConstInt - Call EvaluateAsRValue and return the folded integer. More...
 
void EvaluateForOverflow (const ASTContext &Ctx) const
 
bool EvaluateAsLValue (EvalResult &Result, const ASTContext &Ctx) const
 EvaluateAsLValue - Evaluate an expression to see if we can fold it to an lvalue with link time known address, with no side-effects. More...
 
bool EvaluateAsInitializer (APValue &Result, const ASTContext &Ctx, const VarDecl *VD, SmallVectorImpl< PartialDiagnosticAt > &Notes) const
 EvaluateAsInitializer - Evaluate an expression as if it were the initializer of the given declaration. More...
 
bool EvaluateWithSubstitution (APValue &Value, ASTContext &Ctx, const FunctionDecl *Callee, ArrayRef< const Expr * > Args) const
 EvaluateWithSubstitution - Evaluate an expression as if from the context of a call to the given function with the given arguments, inside an unevaluated context. More...
 
bool tryEvaluateObjectSize (uint64_t &Result, ASTContext &Ctx, unsigned Type) const
 If the current Expr is a pointer, this will try to statically determine the number of bytes available where the pointer is pointing. More...
 
NullPointerConstantKind isNullPointerConstant (ASTContext &Ctx, NullPointerConstantValueDependence NPC) const
 isNullPointerConstant - C99 6.3.2.3p3 - Test if this reduces down to a Null pointer constant. More...
 
bool isOBJCGCCandidate (ASTContext &Ctx) const
 isOBJCGCCandidate - Return true if this expression may be used in a read/ write barrier. More...
 
bool isBoundMemberFunction (ASTContext &Ctx) const
 Returns true if this expression is a bound member function. More...
 
ExprIgnoreImpCasts () LLVM_READONLY
 IgnoreImpCasts - Skip past any implicit casts which might surround this expression. More...
 
ExprIgnoreImplicit () LLVM_READONLY
 IgnoreImplicit - Skip past any implicit AST nodes which might surround this expression. More...
 
const ExprIgnoreImplicit () const LLVM_READONLY
 
ExprIgnoreParens () LLVM_READONLY
 IgnoreParens - Ignore parentheses. More...
 
ExprIgnoreParenCasts () LLVM_READONLY
 IgnoreParenCasts - Ignore parentheses and casts. More...
 
ExprIgnoreCasts () LLVM_READONLY
 Ignore casts. Strip off any CastExprs, returning their operand. More...
 
ExprIgnoreParenImpCasts () LLVM_READONLY
 IgnoreParenImpCasts - Ignore parentheses and implicit casts. More...
 
ExprIgnoreConversionOperator () LLVM_READONLY
 IgnoreConversionOperator - Ignore conversion operator. More...
 
const ExprIgnoreConversionOperator () const LLVM_READONLY
 
const ExprIgnoreParenImpCasts () const LLVM_READONLY
 
ExprIgnoreParenLValueCasts () LLVM_READONLY
 Ignore parentheses and lvalue casts. More...
 
const ExprIgnoreParenLValueCasts () const LLVM_READONLY
 
ExprIgnoreParenNoopCasts (ASTContext &Ctx) LLVM_READONLY
 IgnoreParenNoopCasts - Ignore parentheses and casts that do not change the value (including ptr->int casts of the same size). More...
 
ExprignoreParenBaseCasts () LLVM_READONLY
 Ignore parentheses and derived-to-base casts. More...
 
const ExprignoreParenBaseCasts () const LLVM_READONLY
 
bool isDefaultArgument () const
 Determine whether this expression is a default function argument. More...
 
bool isTemporaryObject (ASTContext &Ctx, const CXXRecordDecl *TempTy) const
 Determine whether the result of this expression is a temporary object of the given class type. More...
 
bool isImplicitCXXThis () const
 Whether this expression is an implicit reference to 'this' in C++. More...
 
const ExprIgnoreImpCasts () const LLVM_READONLY
 
const ExprIgnoreParens () const LLVM_READONLY
 
const ExprIgnoreParenCasts () const LLVM_READONLY
 
const ExprIgnoreCasts () const LLVM_READONLY
 Strip off casts, but keep parentheses. More...
 
const ExprIgnoreParenNoopCasts (ASTContext &Ctx) const LLVM_READONLY
 
const CXXRecordDeclgetBestDynamicClassType () const
 For an expression of class type or pointer to class type, return the most derived class decl the expression is known to refer to. More...
 
const ExprskipRValueSubobjectAdjustments (SmallVectorImpl< const Expr * > &CommaLHS, SmallVectorImpl< SubobjectAdjustment > &Adjustments) const
 Walk outwards from an expression we want to bind a reference to and find the expression whose lifetime needs to be extended. More...
 

Static Public Member Functions

static PseudoObjectExprCreate (const ASTContext &Context, Expr *syntactic, ArrayRef< Expr * > semantic, unsigned resultIndex)
 
static PseudoObjectExprCreate (const ASTContext &Context, EmptyShell shell, unsigned numSemanticExprs)
 
static bool classof (const Stmt *T)
 
- Static Public Member Functions inherited from clang::Expr
static ExprValueKind getValueKindForType (QualType T)
 getValueKindForType - Given a formal return or parameter type, give its value kind. More...
 
static bool isPotentialConstantExpr (const FunctionDecl *FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
 isPotentialConstantExpr - Return true if this function's definition might be usable in a constant expression in C++11, if it were marked constexpr. More...
 
static bool isPotentialConstantExprUnevaluated (Expr *E, const FunctionDecl *FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
 isPotentialConstantExprUnevaluted - Return true if this expression might be usable in a constant expression in C++11 in an unevaluated context, if it were in function FD marked constexpr. More...
 
static QualType findBoundMemberType (const Expr *expr)
 Given an expression of bound-member type, find the type of the member. More...
 
static bool hasAnyTypeDependentArguments (ArrayRef< Expr * > Exprs)
 hasAnyTypeDependentArguments - Determines if any of the expressions in Exprs is type-dependent. More...
 
static bool classof (const Stmt *T)
 

Public Attributes

friend TrailingObjects
 

Friends

class ASTStmtReader
 

Additional Inherited Members

- Protected Member Functions inherited from clang::Expr
 Expr (StmtClass SC, QualType T, ExprValueKind VK, ExprObjectKind OK, bool TD, bool VD, bool ID, bool ContainsUnexpandedParameterPack)
 
 Expr (StmtClass SC, EmptyShell)
 Construct an empty expression. More...
 

Detailed Description

PseudoObjectExpr - An expression which accesses a pseudo-object l-value.

A pseudo-object is an abstract object, accesses to which are translated to calls. The pseudo-object expression has a syntactic form, which shows how the expression was actually written in the source code, and a semantic form, which is a series of expressions to be executed in order which detail how the operation is actually evaluated. Optionally, one of the semantic forms may also provide a result value for the expression.

If any of the semantic-form expressions is an OpaqueValueExpr, that OVE is required to have a source expression, and it is bound to the result of that source expression. Such OVEs may appear only in subsequent semantic-form expressions and as sub-expressions of the syntactic form.

PseudoObjectExpr should be used only when an operation can be usefully described in terms of fairly simple rewrite rules on objects and functions that are meant to be used by end-developers. For example, under the Itanium ABI, dynamic casts are implemented as a call to a runtime function called __dynamic_cast; using this class to describe that would be inappropriate because that call is not really part of the user-visible semantics, and instead the cast is properly reflected in the AST and IR-generation has been taught to generate the call as necessary. In contrast, an Objective-C property access is semantically defined to be equivalent to a particular message send, and this is very much part of the user model. The name of this class encourages this modelling design.

Definition at line 4679 of file Expr.h.

Member Typedef Documentation

Definition at line 4746 of file Expr.h.

Definition at line 4745 of file Expr.h.

Member Enumeration Documentation

anonymous enum : unsigned

NoResult - A value for the result index indicating that there is no semantic result.

Enumerator
NoResult 

Definition at line 4711 of file Expr.h.

Member Function Documentation

child_range clang::PseudoObjectExpr::children ( )
inline

Definition at line 4786 of file Expr.h.

static bool clang::PseudoObjectExpr::classof ( const Stmt T)
inlinestatic

Definition at line 4791 of file Expr.h.

PseudoObjectExpr * PseudoObjectExpr::Create ( const ASTContext Context,
Expr syntactic,
ArrayRef< Expr * >  semantic,
unsigned  resultIndex 
)
static
PseudoObjectExpr * PseudoObjectExpr::Create ( const ASTContext Context,
EmptyShell  shell,
unsigned  numSemanticExprs 
)
static

Definition at line 3736 of file Expr.cpp.

References clang::ASTContext::Allocate().

SourceLocation clang::PseudoObjectExpr::getExprLoc ( ) const
inline

Definition at line 4775 of file Expr.h.

References clang::Expr::getExprLoc(), and getSyntacticForm().

SourceLocation clang::PseudoObjectExpr::getLocEnd ( ) const
inline

Definition at line 4782 of file Expr.h.

References getSyntacticForm().

SourceLocation clang::PseudoObjectExpr::getLocStart ( ) const
inline

Definition at line 4779 of file Expr.h.

References getSyntacticForm().

unsigned clang::PseudoObjectExpr::getNumSemanticExprs ( ) const
inline

Definition at line 4743 of file Expr.h.

Expr* clang::PseudoObjectExpr::getResultExpr ( )
inline

Return the result-bearing expression, or null if there is none.

Definition at line 4734 of file Expr.h.

Referenced by emitPseudoObjectExpr(), getResultExpr(), and clang::ento::ExprEngine::Visit().

const Expr* clang::PseudoObjectExpr::getResultExpr ( ) const
inline

Definition at line 4739 of file Expr.h.

References getResultExpr().

unsigned clang::PseudoObjectExpr::getResultExprIndex ( ) const
inline

Return the index of the result-bearing expression into the semantics expressions, or PseudoObjectExpr::NoResult if there is none.

Definition at line 4728 of file Expr.h.

References NoResult.

Expr* clang::PseudoObjectExpr::getSemanticExpr ( unsigned  index)
inline

Definition at line 4767 of file Expr.h.

Referenced by getSemanticExpr().

const Expr* clang::PseudoObjectExpr::getSemanticExpr ( unsigned  index) const
inline

Definition at line 4771 of file Expr.h.

References getSemanticExpr().

Expr* clang::PseudoObjectExpr::getSyntacticForm ( )
inline

Return the syntactic form of this expression, i.e.

the expression it actually looks like. Likely to be expressed in terms of OpaqueValueExprs bound in the semantic form.

Definition at line 4723 of file Expr.h.

Referenced by BuildParentMap(), getExprLoc(), getLocEnd(), getLocStart(), getSyntacticFromForPseudoObjectExpr(), clang::Expr::isUnusedResultAWarning(), clang::sema::FunctionScopeInfo::markSafeWeakUse(), and clang::Sema::recreateSyntacticForm().

const Expr* clang::PseudoObjectExpr::getSyntacticForm ( ) const
inline

Definition at line 4724 of file Expr.h.

llvm::iterator_range<semantics_iterator> clang::PseudoObjectExpr::semantics ( )
inline

Definition at line 4760 of file Expr.h.

References semantics_begin(), and semantics_end().

llvm::iterator_range<const_semantics_iterator> clang::PseudoObjectExpr::semantics ( ) const
inline

Definition at line 4763 of file Expr.h.

References semantics_begin(), and semantics_end().

semantics_iterator clang::PseudoObjectExpr::semantics_begin ( )
inline
const_semantics_iterator clang::PseudoObjectExpr::semantics_begin ( ) const
inline

Definition at line 4750 of file Expr.h.

semantics_iterator clang::PseudoObjectExpr::semantics_end ( )
inline
const_semantics_iterator clang::PseudoObjectExpr::semantics_end ( ) const
inline

Definition at line 4756 of file Expr.h.

Friends And Related Function Documentation

friend class ASTStmtReader
friend

Definition at line 4796 of file Expr.h.

Member Data Documentation

friend clang::PseudoObjectExpr::TrailingObjects

Definition at line 4795 of file Expr.h.


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