clang  3.7.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
clang::BinaryOperator Class Reference

A builtin binary operation expression such as "x + y" or "x <= y". More...

#include <Expr.h>

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

Public Types

typedef BinaryOperatorKind Opcode
 
- 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_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

 BinaryOperator (Expr *lhs, Expr *rhs, Opcode opc, QualType ResTy, ExprValueKind VK, ExprObjectKind OK, SourceLocation opLoc, bool fpContractable)
 
 BinaryOperator (EmptyShell Empty)
 Construct an empty binary operator. More...
 
SourceLocation getExprLoc () const LLVM_READONLY
 
SourceLocation getOperatorLoc () const
 
void setOperatorLoc (SourceLocation L)
 
Opcode getOpcode () const
 
void setOpcode (Opcode O)
 
ExprgetLHS () const
 
void setLHS (Expr *E)
 
ExprgetRHS () const
 
void setRHS (Expr *E)
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
StringRef getOpcodeStr () const
 
bool isPtrMemOp () const
 predicates to categorize the respective opcodes. More...
 
bool isMultiplicativeOp () const
 
bool isAdditiveOp () const
 
bool isShiftOp () const
 
bool isBitwiseOp () const
 
bool isRelationalOp () const
 
bool isEqualityOp () const
 
bool isComparisonOp () const
 
bool isLogicalOp () const
 
bool isAssignmentOp () const
 
bool isCompoundAssignmentOp () const
 
bool isShiftAssignOp () const
 
child_range children ()
 
void setFPContractable (bool FPC)
 
bool isFPContractable () const
 
- Public Member Functions inherited from clang::Expr
QualType getType () const
 
void setType (QualType t)
 
bool isValueDependent () const
 
void setValueDependent (bool VD)
 Set whether this expression is value-dependent or not. More...
 
bool isTypeDependent () const
 
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
 
bool isUnusedResultAWarning (const Expr *&WarnExpr, SourceLocation &Loc, SourceRange &R1, SourceRange &R2, ASTContext &Ctx) const
 
bool isLValue () const
 
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
 
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
 
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 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
 
bool isIntegerConstantExpr (llvm::APSInt &Result, const ASTContext &Ctx, SourceLocation *Loc=nullptr, bool isEvaluated=true) const
 
bool isIntegerConstantExpr (const ASTContext &Ctx, SourceLocation *Loc=nullptr) const
 
bool isCXX98IntegralConstantExpr (const ASTContext &Ctx) const
 
bool isCXX11ConstantExpr (const ASTContext &Ctx, APValue *Result=nullptr, SourceLocation *Loc=nullptr) const
 
bool isConstantInitializer (ASTContext &Ctx, bool ForRef, const Expr **Culprit=nullptr) const
 
bool EvaluateAsRValue (EvalResult &Result, const ASTContext &Ctx) const
 
bool EvaluateAsBooleanCondition (bool &Result, const ASTContext &Ctx) const
 
bool EvaluateAsInt (llvm::APSInt &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects) const
 
bool isEvaluatable (const ASTContext &Ctx) const
 
bool HasSideEffects (const ASTContext &Ctx, bool IncludePossibleEffects=true) const
 
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
 
void EvaluateForOverflow (const ASTContext &Ctx) const
 
bool EvaluateAsLValue (EvalResult &Result, const ASTContext &Ctx) const
 
bool EvaluateAsInitializer (APValue &Result, const ASTContext &Ctx, const VarDecl *VD, SmallVectorImpl< PartialDiagnosticAt > &Notes) const
 
bool EvaluateWithSubstitution (APValue &Value, ASTContext &Ctx, const FunctionDecl *Callee, ArrayRef< const Expr * > Args) const
 
NullPointerConstantKind isNullPointerConstant (ASTContext &Ctx, NullPointerConstantValueDependence NPC) const
 
bool isOBJCGCCandidate (ASTContext &Ctx) const
 
bool isBoundMemberFunction (ASTContext &Ctx) const
 Returns true if this expression is a bound member function. More...
 
ExprIgnoreImpCasts () LLVM_READONLY
 
ExprIgnoreImplicit () LLVM_READONLY
 
const ExprIgnoreImplicit () const LLVM_READONLY
 
ExprIgnoreParens () LLVM_READONLY
 
ExprIgnoreParenCasts () LLVM_READONLY
 
ExprIgnoreCasts () LLVM_READONLY
 Ignore casts. Strip off any CastExprs, returning their operand. More...
 
ExprIgnoreParenImpCasts () LLVM_READONLY
 
ExprIgnoreConversionOperator () LLVM_READONLY
 
const ExprIgnoreConversionOperator () const LLVM_READONLY
 
const ExprIgnoreParenImpCasts () const LLVM_READONLY
 
ExprIgnoreParenLValueCasts () LLVM_READONLY
 
const ExprIgnoreParenLValueCasts () const LLVM_READONLY
 
ExprIgnoreParenNoopCasts (ASTContext &Ctx) LLVM_READONLY
 
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
 

Static Public Member Functions

static StringRef getOpcodeStr (Opcode Op)
 
static Opcode getOverloadedOpcode (OverloadedOperatorKind OO)
 Retrieve the binary opcode that corresponds to the given overloaded operator. More...
 
static OverloadedOperatorKind getOverloadedOperator (Opcode Opc)
 Retrieve the overloaded operator kind that corresponds to the given binary opcode. More...
 
static bool isAdditiveOp (Opcode Opc)
 
static bool isShiftOp (Opcode Opc)
 
static bool isBitwiseOp (Opcode Opc)
 
static bool isRelationalOp (Opcode Opc)
 
static bool isEqualityOp (Opcode Opc)
 
static bool isComparisonOp (Opcode Opc)
 
static Opcode negateComparisonOp (Opcode Opc)
 
static Opcode reverseComparisonOp (Opcode Opc)
 
static bool isLogicalOp (Opcode Opc)
 
static bool isAssignmentOp (Opcode Opc)
 
static bool isCompoundAssignmentOp (Opcode Opc)
 
static Opcode getOpForCompoundAssignment (Opcode Opc)
 
static bool isShiftAssignOp (Opcode Opc)
 
static bool classof (const Stmt *S)
 
- Static Public Member Functions inherited from clang::Expr
static ExprValueKind getValueKindForType (QualType T)
 
static bool isPotentialConstantExpr (const FunctionDecl *FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
 
static bool isPotentialConstantExprUnevaluated (Expr *E, const FunctionDecl *FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
 
static QualType findBoundMemberType (const Expr *expr)
 Given an expression of bound-member type, find the type of the member. Returns null if this is an overloaded bound member expression. More...
 
static bool hasAnyTypeDependentArguments (ArrayRef< Expr * > Exprs)
 
static bool classof (const Stmt *T)
 

Protected Member Functions

 BinaryOperator (Expr *lhs, Expr *rhs, Opcode opc, QualType ResTy, ExprValueKind VK, ExprObjectKind OK, SourceLocation opLoc, bool fpContractable, bool dead2)
 
 BinaryOperator (StmtClass SC, EmptyShell Empty)
 
- 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

A builtin binary operation expression such as "x + y" or "x <= y".

This expression node kind describes a builtin binary operation, such as "x + y" for integer values "x" and "y". The operands will already have been converted to appropriate types (e.g., by performing promotions or conversions).

In C++, where operators may be overloaded, a different kind of expression node (CXXOperatorCallExpr) is used to express the invocation of an overloaded operator with operator syntax. Within a C++ template, whether BinaryOperator or CXXOperatorCallExpr is used to store an expression "x + y" depends on the subexpressions for x and y. If neither x or y is type-dependent, and the "+" operator resolves to a built-in operation, BinaryOperator will be used to express the computation (x and y may still be value-dependent). If either x or y is type-dependent, or if the "+" resolves to an overloaded operator, CXXOperatorCallExpr will be used to express the computation.

Definition at line 2918 of file Expr.h.

Member Typedef Documentation

Definition at line 2920 of file Expr.h.

Constructor & Destructor Documentation

clang::BinaryOperator::BinaryOperator ( Expr lhs,
Expr rhs,
Opcode  opc,
QualType  ResTy,
ExprValueKind  VK,
ExprObjectKind  OK,
SourceLocation  opLoc,
bool  fpContractable 
)
inline

Definition at line 2936 of file Expr.h.

References isCompoundAssignmentOp().

clang::BinaryOperator::BinaryOperator ( EmptyShell  Empty)
inlineexplicit

Construct an empty binary operator.

Definition at line 2954 of file Expr.h.

clang::BinaryOperator::BinaryOperator ( Expr lhs,
Expr rhs,
Opcode  opc,
QualType  ResTy,
ExprValueKind  VK,
ExprObjectKind  OK,
SourceLocation  opLoc,
bool  fpContractable,
bool  dead2 
)
inlineprotected

Definition at line 3085 of file Expr.h.

clang::BinaryOperator::BinaryOperator ( StmtClass  SC,
EmptyShell  Empty 
)
inlineprotected

Definition at line 3100 of file Expr.h.

Member Function Documentation

child_range clang::BinaryOperator::children ( )
inline

Definition at line 3072 of file Expr.h.

static bool clang::BinaryOperator::classof ( const Stmt S)
inlinestatic

Definition at line 3066 of file Expr.h.

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

Definition at line 2957 of file Expr.h.

Referenced by clang::Sema::ActOnOpenMPAtomicDirective().

Expr* clang::BinaryOperator::getLHS ( ) const
inline
SourceLocation clang::BinaryOperator::getLocEnd ( ) const
inline

Definition at line 2972 of file Expr.h.

References getRHS().

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

Definition at line 2969 of file Expr.h.

References getLHS().

Referenced by DiagUninitUse().

Opcode clang::BinaryOperator::getOpcode ( ) const
inline

Definition at line 2961 of file Expr.h.

Referenced by clang::Sema::ActOnOpenMPAtomicDirective(), CheckICE(), ClassifyBinaryOp(), DiagUninitUse(), clang::CodeGen::CodeGenFunction::EmitBinaryOperatorLValue(), clang::CodeGen::CodeGenFunction::EmitComplexAssignmentLValue(), clang::CodeGen::CodeGenFunction::EmitComplexCompoundAssignmentLValue(), clang::CodeGen::CodeGenFunction::EmitCompoundAssignmentLValue(), clang::CodeGen::CodeGenFunction::EmitCXXMemberPointerCallExpr(), EmitDiagnosticForBitwiseAndInBitwiseOr(), EmitDiagnosticForLogicalAndInLogicalOr(), clang::CodeGen::CodeGenFunction::EmitPointerToDataMemberBinaryExpr(), clang::CodeGen::CodeGenFunction::EmitScalarCompoundAssignWithComplex(), EvalAddr(), GenerateMinimalPathDiagnostic(), getOpcodeStr(), HandleMemberPointerAccess(), isAdditiveOp(), isAssignmentOp(), isBitwiseOp(), isComparisonOp(), isCompoundAssignmentOp(), clang::ParentMap::isConsumedExpr(), isEqualityOp(), isIdenticalStmt(), isLogicalOp(), clang::arcmt::trans::isPlusOneAssign(), isRelationalOp(), isShiftAssignOp(), isShiftOp(), clang::Expr::isUnusedResultAWarning(), LookThroughTransitiveAssignmentsAndCommaOperators(), print_elem(), clang::ento::ExprEngine::Visit(), clang::ASTNodeImporter::VisitBinaryOperator(), clang::ento::ExprEngine::VisitBinaryOperator(), clang::consumed::ConsumedStmtVisitor::VisitBinaryOperator(), clang::ASTNodeImporter::VisitCompoundAssignOperator(), clang::ento::ExprEngine::VisitLogicalExpr(), and clang::ento::ConditionBRVisitor::VisitTrueTest().

StringRef BinaryOperator::getOpcodeStr ( Opcode  Op)
static
StringRef clang::BinaryOperator::getOpcodeStr ( ) const
inline
SourceLocation clang::BinaryOperator::getOperatorLoc ( ) const
inline
static Opcode clang::BinaryOperator::getOpForCompoundAssignment ( Opcode  Opc)
inlinestatic
BinaryOperatorKind BinaryOperator::getOverloadedOpcode ( OverloadedOperatorKind  OO)
static
OverloadedOperatorKind BinaryOperator::getOverloadedOperator ( Opcode  Opc)
static

Retrieve the overloaded operator kind that corresponds to the given binary opcode.

Definition at line 1858 of file Expr.cpp.

References clang::OO_None.

Referenced by BuildOverloadedBinOp(), and clang::Sema::CreateOverloadedBinOp().

Expr* clang::BinaryOperator::getRHS ( ) const
inline
static bool clang::BinaryOperator::isAdditiveOp ( Opcode  Opc)
inlinestatic

Definition at line 2993 of file Expr.h.

References clang::BO_Add, and clang::BO_Sub.

Referenced by ignoreLiteralAdditions(), and clang::ento::ExprEngine::VisitBinaryOperator().

bool clang::BinaryOperator::isAdditiveOp ( ) const
inline

Definition at line 2994 of file Expr.h.

References getOpcode(), and isAdditiveOp().

Referenced by isAdditiveOp().

static bool clang::BinaryOperator::isAssignmentOp ( Opcode  Opc)
inlinestatic
bool clang::BinaryOperator::isAssignmentOp ( ) const
inline
static bool clang::BinaryOperator::isBitwiseOp ( Opcode  Opc)
inlinestatic

Definition at line 2998 of file Expr.h.

References clang::BO_And, and clang::BO_Or.

Referenced by DiagnoseBitwisePrecedence().

bool clang::BinaryOperator::isBitwiseOp ( ) const
inline

Definition at line 2999 of file Expr.h.

References getOpcode(), and isBitwiseOp().

Referenced by DiagnoseBinOpPrecedence(), and isBitwiseOp().

static bool clang::BinaryOperator::isComparisonOp ( Opcode  Opc)
inlinestatic
bool clang::BinaryOperator::isComparisonOp ( ) const
inline
static bool clang::BinaryOperator::isCompoundAssignmentOp ( Opcode  Opc)
inlinestatic

Definition at line 3045 of file Expr.h.

References clang::BO_Assign, and clang::BO_OrAssign.

Referenced by clang::ento::ExprEngine::VisitBinaryOperator().

bool clang::BinaryOperator::isCompoundAssignmentOp ( ) const
inline
static bool clang::BinaryOperator::isEqualityOp ( Opcode  Opc)
inlinestatic

Definition at line 3004 of file Expr.h.

References clang::BO_EQ, and clang::BO_NE.

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

bool clang::BinaryOperator::isEqualityOp ( ) const
inline

Definition at line 3005 of file Expr.h.

References getOpcode(), and isEqualityOp().

Referenced by diagnoseObjCLiteralComparison(), and isEqualityOp().

bool clang::BinaryOperator::isFPContractable ( ) const
inline
static bool clang::BinaryOperator::isLogicalOp ( Opcode  Opc)
inlinestatic
bool clang::BinaryOperator::isLogicalOp ( ) const
inline

Definition at line 3038 of file Expr.h.

References getOpcode(), and isLogicalOp().

Referenced by isLogicalOp().

bool clang::BinaryOperator::isMultiplicativeOp ( ) const
inline

Definition at line 2992 of file Expr.h.

References clang::BO_Mul, and clang::BO_Rem.

bool clang::BinaryOperator::isPtrMemOp ( ) const
inline

predicates to categorize the respective opcodes.

Definition at line 2991 of file Expr.h.

References clang::BO_PtrMemD, and clang::BO_PtrMemI.

static bool clang::BinaryOperator::isRelationalOp ( Opcode  Opc)
inlinestatic

Definition at line 3001 of file Expr.h.

References clang::BO_GE, and clang::BO_LT.

Referenced by clang::ento::ExprEngine::Visit().

bool clang::BinaryOperator::isRelationalOp ( ) const
inline

Definition at line 3002 of file Expr.h.

References getOpcode(), and isRelationalOp().

Referenced by isRelationalOp().

static bool clang::BinaryOperator::isShiftAssignOp ( Opcode  Opc)
inlinestatic

Definition at line 3059 of file Expr.h.

References clang::BO_ShlAssign, and clang::BO_ShrAssign.

bool clang::BinaryOperator::isShiftAssignOp ( ) const
inline

Definition at line 3062 of file Expr.h.

References getOpcode().

static bool clang::BinaryOperator::isShiftOp ( Opcode  Opc)
inlinestatic

Definition at line 2995 of file Expr.h.

References clang::BO_Shl, and clang::BO_Shr.

bool clang::BinaryOperator::isShiftOp ( ) const
inline

Definition at line 2996 of file Expr.h.

References getOpcode(), and isShiftOp().

Referenced by isShiftOp().

static Opcode clang::BinaryOperator::negateComparisonOp ( Opcode  Opc)
inlinestatic
static Opcode clang::BinaryOperator::reverseComparisonOp ( Opcode  Opc)
inlinestatic
void clang::BinaryOperator::setFPContractable ( bool  FPC)
inline

Definition at line 3078 of file Expr.h.

void clang::BinaryOperator::setLHS ( Expr E)
inline

Definition at line 2965 of file Expr.h.

void clang::BinaryOperator::setOpcode ( Opcode  O)
inline

Definition at line 2962 of file Expr.h.

void clang::BinaryOperator::setOperatorLoc ( SourceLocation  L)
inline

Definition at line 2959 of file Expr.h.

void clang::BinaryOperator::setRHS ( Expr E)
inline

Definition at line 2967 of file Expr.h.


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