clang  6.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
clang::ObjCMessageExpr Class Referencefinal

An expression that sends a message to the given Objective-C object or class. More...

#include "clang/AST/ExprObjC.h"

Inheritance diagram for clang::ObjCMessageExpr:
Inheritance graph
[legend]
Collaboration diagram for clang::ObjCMessageExpr:
Collaboration graph
[legend]

Public Types

enum  ReceiverKind { Class = 0, Instance, SuperClass, SuperInstance }
 The kind of receiver this message is sending to. More...
 
typedef ExprIterator arg_iterator
 
typedef ConstExprIterator const_arg_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_ConstQualifiedField, 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 Types inherited from clang::Stmt
enum  StmtClass { NoStmtClass = 0 }
 
typedef StmtIterator child_iterator
 Child Iterators: All subclasses must implement 'children' to permit easy iteration over the substatements/subexpessions of an AST node. More...
 
typedef ConstStmtIterator const_child_iterator
 
typedef llvm::iterator_range< child_iteratorchild_range
 
typedef llvm::iterator_range< const_child_iteratorconst_child_range
 

Public Member Functions

bool isImplicit () const
 Indicates whether the message send was implicitly generated by the implementation. More...
 
ReceiverKind getReceiverKind () const
 Determine the kind of receiver that this message is being sent to. More...
 
SourceRange getReceiverRange () const
 Source range of the receiver. More...
 
bool isInstanceMessage () const
 Determine whether this is an instance message to either a computed object or to super. More...
 
bool isClassMessage () const
 Determine whether this is an class message to either a specified class or to super. More...
 
ExprgetInstanceReceiver ()
 Returns the object expression (receiver) for an instance message, or null for a message that is not an instance message. More...
 
const ExprgetInstanceReceiver () const
 
void setInstanceReceiver (Expr *rec)
 Turn this message send into an instance message that computes the receiver object with the given expression. More...
 
QualType getClassReceiver () const
 Returns the type of a class message send, or NULL if the message is not a class message. More...
 
TypeSourceInfogetClassReceiverTypeInfo () const
 Returns a type-source information of a class message send, or NULL if the message is not a class message. More...
 
void setClassReceiver (TypeSourceInfo *TSInfo)
 
SourceLocation getSuperLoc () const
 Retrieve the location of the 'super' keyword for a class or instance message to 'super', otherwise an invalid source location. More...
 
QualType getReceiverType () const
 Retrieve the receiver type to which this message is being directed. More...
 
ObjCInterfaceDeclgetReceiverInterface () const
 Retrieve the Objective-C interface to which this message is being directed, if known. More...
 
QualType getSuperType () const
 Retrieve the type referred to by 'super'. More...
 
void setSuper (SourceLocation Loc, QualType T, bool IsInstanceSuper)
 
Selector getSelector () const
 
void setSelector (Selector S)
 
const ObjCMethodDeclgetMethodDecl () const
 
ObjCMethodDeclgetMethodDecl ()
 
void setMethodDecl (ObjCMethodDecl *MD)
 
ObjCMethodFamily getMethodFamily () const
 
unsigned getNumArgs () const
 Return the number of actual arguments in this message, not counting the receiver. More...
 
Expr ** getArgs ()
 Retrieve the arguments to this message, not including the receiver. More...
 
const Expr *const * getArgs () const
 
ExprgetArg (unsigned Arg)
 getArg - Return the specified argument. More...
 
const ExprgetArg (unsigned Arg) const
 
void setArg (unsigned Arg, Expr *ArgExpr)
 setArg - Set the specified argument. More...
 
bool isDelegateInitCall () const
 isDelegateInitCall - Answers whether this message send has been tagged as a "delegate init call", i.e. More...
 
void setDelegateInitCall (bool isDelegate)
 
SourceLocation getLeftLoc () const
 
SourceLocation getRightLoc () const
 
SourceLocation getSelectorStartLoc () const
 
SourceLocation getSelectorLoc (unsigned Index) const
 
void getSelectorLocs (SmallVectorImpl< SourceLocation > &SelLocs) const
 
unsigned getNumSelectorLocs () const
 
void setSourceRange (SourceRange R)
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
child_range children ()
 
llvm::iterator_range< arg_iteratorarguments ()
 
llvm::iterator_range< const_arg_iteratorarguments () const
 
arg_iterator arg_begin ()
 
arg_iterator arg_end ()
 
const_arg_iterator arg_begin () const
 
const_arg_iterator arg_end () const
 
- 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
 
DeclgetReferencedDeclOfCallee ()
 
const DeclgetReferencedDeclOfCallee () 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 Expr *This=nullptr) 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 ExprgetBestDynamicClassTypeExpr () const
 Get the inner expression that determines the best dynamic class. 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...
 
const ExprskipRValueSubobjectAdjustments () const
 
- Public Member Functions inherited from clang::Stmt
void * operator new (size_t bytes, const ASTContext &C, unsigned alignment=8)
 
void * operator new (size_t bytes, const ASTContext *C, unsigned alignment=8)
 
void * operator new (size_t bytes, void *mem) noexcept
 
void operator delete (void *, const ASTContext &, unsigned) noexcept
 
void operator delete (void *, const ASTContext *, unsigned) noexcept
 
void operator delete (void *, size_t) noexcept
 
void operator delete (void *, void *) noexcept
 
 Stmt (StmtClass SC)
 
StmtClass getStmtClass () const
 
const char * getStmtClassName () const
 
SourceRange getSourceRange () const LLVM_READONLY
 SourceLocation tokens are not useful in isolation - they are low level value objects created/interpreted by SourceManager. More...
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
void dump () const
 Dumps the specified AST fragment and all subtrees to llvm::errs(). More...
 
void dump (SourceManager &SM) const
 
void dump (raw_ostream &OS, SourceManager &SM) const
 
void dump (raw_ostream &OS) const
 
void dumpColor () const
 dumpColor - same as dump(), but forces color highlighting. More...
 
void dumpPretty (const ASTContext &Context) const
 dumpPretty/printPretty - These two methods do a "pretty print" of the AST back to its original source language syntax. More...
 
void printPretty (raw_ostream &OS, PrinterHelper *Helper, const PrintingPolicy &Policy, unsigned Indentation=0, const ASTContext *Context=nullptr) const
 
void viewAST () const
 viewAST - Visualize an AST rooted at this Stmt* using GraphViz. More...
 
StmtIgnoreImplicit ()
 Skip past any implicit AST nodes which might surround this statement, such as ExprWithCleanups or ImplicitCastExpr nodes. More...
 
const StmtIgnoreImplicit () const
 
StmtIgnoreContainers (bool IgnoreCaptured=false)
 Skip no-op (attributed, compound) container stmts and skip captured stmt at the top, if IgnoreCaptured is true. More...
 
const StmtstripLabelLikeStatements () const
 Strip off all label-like statements. More...
 
StmtstripLabelLikeStatements ()
 
child_range children ()
 
const_child_range children () const
 
child_iterator child_begin ()
 
child_iterator child_end ()
 
const_child_iterator child_begin () const
 
const_child_iterator child_end () const
 
void Profile (llvm::FoldingSetNodeID &ID, const ASTContext &Context, bool Canonical) const
 Produce a unique representation of the given statement. More...
 
void ProcessODRHash (llvm::FoldingSetNodeID &ID, ODRHash &Hash) const
 Calculate a unique representation for a statement that is stable across compiler invocations. More...
 

Static Public Member Functions

static ObjCMessageExprCreate (const ASTContext &Context, QualType T, ExprValueKind VK, SourceLocation LBracLoc, SourceLocation SuperLoc, bool IsInstanceSuper, QualType SuperType, Selector Sel, ArrayRef< SourceLocation > SelLocs, ObjCMethodDecl *Method, ArrayRef< Expr *> Args, SourceLocation RBracLoc, bool isImplicit)
 Create a message send to super. More...
 
static ObjCMessageExprCreate (const ASTContext &Context, QualType T, ExprValueKind VK, SourceLocation LBracLoc, TypeSourceInfo *Receiver, Selector Sel, ArrayRef< SourceLocation > SelLocs, ObjCMethodDecl *Method, ArrayRef< Expr *> Args, SourceLocation RBracLoc, bool isImplicit)
 Create a class message send. More...
 
static ObjCMessageExprCreate (const ASTContext &Context, QualType T, ExprValueKind VK, SourceLocation LBracLoc, Expr *Receiver, Selector Sel, ArrayRef< SourceLocation > SeLocs, ObjCMethodDecl *Method, ArrayRef< Expr *> Args, SourceLocation RBracLoc, bool isImplicit)
 Create an instance message send. More...
 
static ObjCMessageExprCreateEmpty (const ASTContext &Context, unsigned NumArgs, unsigned NumStoredSelLocs)
 Create an empty Objective-C message expression, to be filled in by subsequent calls. More...
 
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)
 
- Static Public Member Functions inherited from clang::Stmt
static void addStmtClass (const StmtClass s)
 
static void EnableStatistics ()
 
static void PrintStats ()
 

Public Attributes

friend TrailingObjects
 

Friends

class ASTStmtReader
 
class ASTStmtWriter
 

Additional Inherited Members

- Protected Types inherited from clang::Stmt
enum  { NumStmtBits = 8 }
 
enum  { NumExprBits = 17 }
 
enum  APFloatSemantics {
  IEEEhalf, IEEEsingle, IEEEdouble, x87DoubleExtended,
  IEEEquad, PPCDoubleDouble
}
 
- 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...
 
- Protected Member Functions inherited from clang::Stmt
void * operator new (size_t bytes) noexcept
 
void operator delete (void *data) noexcept
 
 Stmt (StmtClass SC, EmptyShell)
 Construct an empty statement. More...
 
- Protected Attributes inherited from clang::Stmt
union {
   StmtBitfields   StmtBits
 
   CompoundStmtBitfields   CompoundStmtBits
 
   IfStmtBitfields   IfStmtBits
 
   ExprBitfields   ExprBits
 
   CharacterLiteralBitfields   CharacterLiteralBits
 
   FloatingLiteralBitfields   FloatingLiteralBits
 
   UnaryExprOrTypeTraitExprBitfields   UnaryExprOrTypeTraitExprBits
 
   DeclRefExprBitfields   DeclRefExprBits
 
   CastExprBitfields   CastExprBits
 
   CallExprBitfields   CallExprBits
 
   ExprWithCleanupsBitfields   ExprWithCleanupsBits
 
   PseudoObjectExprBitfields   PseudoObjectExprBits
 
   ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits
 
   InitListExprBitfields   InitListExprBits
 
   TypeTraitExprBitfields   TypeTraitExprBits
 
   CoawaitExprBitfields   CoawaitBits
 
}; 
 

Detailed Description

An expression that sends a message to the given Objective-C object or class.

The following contains two message send expressions:

[[NSString alloc] initWithString:@"Hello"]

The innermost message send invokes the "alloc" class method on the NSString class, while the outermost message send invokes the "initWithString" instance method on the object returned from NSString's "alloc". In all, an Objective-C message send can take on four different (although related) forms:

  1. Send to an object instance.
  2. Send to a class.
  3. Send to the superclass instance of the current class.
  4. Send to the superclass of the current class.

All four kinds of message sends are modeled by the ObjCMessageExpr class, and can be distinguished via getReceiverKind(). Example:

The "void *" trailing objects are actually ONE void * (the receiver pointer), and NumArgs Expr *. But due to the implementation of children(), these must be together contiguously.

Definition at line 860 of file ExprObjC.h.

Member Typedef Documentation

◆ arg_iterator

Definition at line 1354 of file ExprObjC.h.

◆ const_arg_iterator

Definition at line 1355 of file ExprObjC.h.

Member Enumeration Documentation

◆ ReceiverKind

The kind of receiver this message is sending to.

Enumerator
Class 

The receiver is a class.

Instance 

The receiver is an object instance.

SuperClass 

The receiver is a superclass.

SuperInstance 

The receiver is the instance of the superclass object.

Definition at line 1001 of file ExprObjC.h.

Member Function Documentation

◆ arg_begin() [1/2]

arg_iterator clang::ObjCMessageExpr::arg_begin ( )
inline

Definition at line 1365 of file ExprObjC.h.

◆ arg_begin() [2/2]

const_arg_iterator clang::ObjCMessageExpr::arg_begin ( ) const
inline

Definition at line 1369 of file ExprObjC.h.

◆ arg_end() [1/2]

arg_iterator clang::ObjCMessageExpr::arg_end ( )
inline

Definition at line 1366 of file ExprObjC.h.

◆ arg_end() [2/2]

const_arg_iterator clang::ObjCMessageExpr::arg_end ( ) const
inline

Definition at line 1372 of file ExprObjC.h.

◆ arguments() [1/2]

llvm::iterator_range<arg_iterator> clang::ObjCMessageExpr::arguments ( )
inline

Definition at line 1357 of file ExprObjC.h.

◆ arguments() [2/2]

llvm::iterator_range<const_arg_iterator> clang::ObjCMessageExpr::arguments ( ) const
inline

Definition at line 1361 of file ExprObjC.h.

◆ children()

Stmt::child_range ObjCMessageExpr::children ( )

◆ classof()

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

◆ Create() [1/3]

ObjCMessageExpr * ObjCMessageExpr::Create ( const ASTContext Context,
QualType  T,
ExprValueKind  VK,
SourceLocation  LBracLoc,
SourceLocation  SuperLoc,
bool  IsInstanceSuper,
QualType  SuperType,
Selector  Sel,
ArrayRef< SourceLocation SelLocs,
ObjCMethodDecl Method,
ArrayRef< Expr *>  Args,
SourceLocation  RBracLoc,
bool  isImplicit 
)
static

Create a message send to super.

Parameters
ContextThe ASTContext in which this expression will be created.
TThe result type of this message.
VKThe value kind of this message. A message returning a l-value or r-value reference will be an l-value or x-value, respectively.
LBracLocThe location of the open square bracket '['.
SuperLocThe location of the "super" keyword.
IsInstanceSuperWhether this is an instance "super" message (otherwise, it's a class "super" message).
SelThe selector used to determine which method gets called.
MethodThe Objective-C method against which this message send was type-checked. May be NULL.
ArgsThe message send arguments.
RBracLocThe location of the closing square bracket ']'.

Definition at line 201 of file ExprObjC.cpp.

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

◆ Create() [2/3]

ObjCMessageExpr * ObjCMessageExpr::Create ( const ASTContext Context,
QualType  T,
ExprValueKind  VK,
SourceLocation  LBracLoc,
TypeSourceInfo Receiver,
Selector  Sel,
ArrayRef< SourceLocation SelLocs,
ObjCMethodDecl Method,
ArrayRef< Expr *>  Args,
SourceLocation  RBracLoc,
bool  isImplicit 
)
static

Create a class message send.

Parameters
ContextThe ASTContext in which this expression will be created.
TThe result type of this message.
VKThe value kind of this message. A message returning a l-value or r-value reference will be an l-value or x-value, respectively.
LBracLocThe location of the open square bracket '['.
ReceiverThe type of the receiver, including source-location information.
SelThe selector used to determine which method gets called.
MethodThe Objective-C method against which this message send was type-checked. May be NULL.
ArgsThe message send arguments.
RBracLocThe location of the closing square bracket ']'.

Definition at line 221 of file ExprObjC.cpp.

◆ Create() [3/3]

ObjCMessageExpr * ObjCMessageExpr::Create ( const ASTContext Context,
QualType  T,
ExprValueKind  VK,
SourceLocation  LBracLoc,
Expr Receiver,
Selector  Sel,
ArrayRef< SourceLocation SeLocs,
ObjCMethodDecl Method,
ArrayRef< Expr *>  Args,
SourceLocation  RBracLoc,
bool  isImplicit 
)
static

Create an instance message send.

Parameters
ContextThe ASTContext in which this expression will be created.
TThe result type of this message.
VKThe value kind of this message. A message returning a l-value or r-value reference will be an l-value or x-value, respectively.
LBracLocThe location of the open square bracket '['.
ReceiverThe expression used to produce the object that will receive this message.
SelThe selector used to determine which method gets called.
MethodThe Objective-C method against which this message send was type-checked. May be NULL.
ArgsThe message send arguments.
RBracLocThe location of the closing square bracket ']'.

Definition at line 240 of file ExprObjC.cpp.

◆ CreateEmpty()

ObjCMessageExpr * ObjCMessageExpr::CreateEmpty ( const ASTContext Context,
unsigned  NumArgs,
unsigned  NumStoredSelLocs 
)
static

Create an empty Objective-C message expression, to be filled in by subsequent calls.

Parameters
ContextThe context in which the message send will be created.
NumArgsThe number of message arguments, not including the receiver.

Definition at line 258 of file ExprObjC.cpp.

◆ getArg() [1/2]

Expr* clang::ObjCMessageExpr::getArg ( unsigned  Arg)
inline

◆ getArg() [2/2]

const Expr* clang::ObjCMessageExpr::getArg ( unsigned  Arg) const
inline

Definition at line 1294 of file ExprObjC.h.

◆ getArgs() [1/2]

Expr** clang::ObjCMessageExpr::getArgs ( )
inline

Retrieve the arguments to this message, not including the receiver.

Definition at line 1281 of file ExprObjC.h.

Referenced by clang::arcmt::ObjCMigrateAction::BeginInvocation().

◆ getArgs() [2/2]

const Expr* const* clang::ObjCMessageExpr::getArgs ( ) const
inline

Definition at line 1284 of file ExprObjC.h.

◆ getClassReceiver()

QualType clang::ObjCMessageExpr::getClassReceiver ( ) const
inline

Returns the type of a class message send, or NULL if the message is not a class message.

Definition at line 1174 of file ExprObjC.h.

Referenced by getReturnTypeForMethod(), maybeAdjustInterfaceForSubscriptingCheck(), and recordFixedType().

◆ getClassReceiverTypeInfo()

TypeSourceInfo* clang::ObjCMessageExpr::getClassReceiverTypeInfo ( ) const
inline

Returns a type-source information of a class message send, or NULL if the message is not a class message.

Definition at line 1183 of file ExprObjC.h.

◆ getInstanceReceiver() [1/2]

Expr* clang::ObjCMessageExpr::getInstanceReceiver ( )
inline

◆ getInstanceReceiver() [2/2]

const Expr* clang::ObjCMessageExpr::getInstanceReceiver ( ) const
inline

Definition at line 1161 of file ExprObjC.h.

◆ getLeftLoc()

SourceLocation clang::ObjCMessageExpr::getLeftLoc ( ) const
inline

Definition at line 1310 of file ExprObjC.h.

◆ getLocEnd()

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

Definition at line 1345 of file ExprObjC.h.

◆ getLocStart()

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

Definition at line 1344 of file ExprObjC.h.

◆ getMethodDecl() [1/2]

const ObjCMethodDecl* clang::ObjCMessageExpr::getMethodDecl ( ) const
inline

◆ getMethodDecl() [2/2]

ObjCMethodDecl* clang::ObjCMessageExpr::getMethodDecl ( )
inline

Definition at line 1258 of file ExprObjC.h.

◆ getMethodFamily()

ObjCMethodFamily clang::ObjCMessageExpr::getMethodFamily ( ) const
inline

Definition at line 1270 of file ExprObjC.h.

Referenced by clang::Expr::isUnusedResultAWarning().

◆ getNumArgs()

unsigned clang::ObjCMessageExpr::getNumArgs ( ) const
inline

◆ getNumSelectorLocs()

unsigned clang::ObjCMessageExpr::getNumSelectorLocs ( ) const
inline

◆ getReceiverInterface()

ObjCInterfaceDecl * ObjCMessageExpr::getReceiverInterface ( ) const

Retrieve the Objective-C interface to which this message is being directed, if known.

This routine cross-cuts all of the different kinds of message sends to determine what the underlying (statically known) type of the receiver will be; use getReceiverKind() to determine whether the message is a class or an instance method, whether it is a send to super or not, etc.

Returns
The Objective-C interface if known, otherwise NULL.

Definition at line 327 of file ExprObjC.cpp.

References clang::Type::getAs().

Referenced by checkForLiteralCreation(), getMethodReceiverIfKnownImmutable(), GetNSMutableArrayArgumentIndex(), GetNSMutableDictionaryArgumentIndex(), and GetNSSetArgumentIndex().

◆ getReceiverKind()

ReceiverKind clang::ObjCMessageExpr::getReceiverKind ( ) const
inline

◆ getReceiverRange()

SourceRange ObjCMessageExpr::getReceiverRange ( ) const

Source range of the receiver.

Definition at line 290 of file ExprObjC.cpp.

Referenced by updateOutParameter().

◆ getReceiverType()

QualType ObjCMessageExpr::getReceiverType ( ) const

Retrieve the receiver type to which this message is being directed.

This routine cross-cuts all of the different kinds of message sends to determine what the underlying (statically known) type of the receiver will be; use getReceiverKind() to determine whether the message is a class or an instance method, whether it is a send to super or not, etc.

Returns
The type of the receiver.

Definition at line 313 of file ExprObjC.cpp.

Referenced by findMethodDecl().

◆ getRightLoc()

SourceLocation clang::ObjCMessageExpr::getRightLoc ( ) const
inline

Definition at line 1311 of file ExprObjC.h.

◆ getSelector()

Selector ObjCMessageExpr::getSelector ( ) const

◆ getSelectorLoc()

SourceLocation clang::ObjCMessageExpr::getSelectorLoc ( unsigned  Index) const
inline

◆ getSelectorLocs()

void ObjCMessageExpr::getSelectorLocs ( SmallVectorImpl< SourceLocation > &  SelLocs) const

Definition at line 284 of file ExprObjC.cpp.

◆ getSelectorStartLoc()

SourceLocation clang::ObjCMessageExpr::getSelectorStartLoc ( ) const
inline

Definition at line 1313 of file ExprObjC.h.

References clang::ObjCStringLiteral::getLocStart().

◆ getSuperLoc()

SourceLocation clang::ObjCMessageExpr::getSuperLoc ( ) const
inline

Retrieve the location of the 'super' keyword for a class or instance message to 'super', otherwise an invalid source location.

Definition at line 1196 of file ExprObjC.h.

Referenced by clang::arcmt::ObjCMigrateAction::BeginInvocation(), and clang::Sema::checkRetainCycles().

◆ getSuperType()

QualType clang::ObjCMessageExpr::getSuperType ( ) const
inline

Retrieve the type referred to by 'super'.

The returned type will either be an ObjCInterfaceType (for an class message to super) or an ObjCObjectPointerType that refers to a class (for an instance message to super);

Definition at line 1231 of file ExprObjC.h.

References clang::QualType::getFromOpaquePtr().

Referenced by maybeAdjustInterfaceForSubscriptingCheck(), and recordFixedType().

◆ isClassMessage()

bool clang::ObjCMessageExpr::isClassMessage ( ) const
inline

Determine whether this is an class message to either a specified class or to super.

Definition at line 1149 of file ExprObjC.h.

◆ isDelegateInitCall()

bool clang::ObjCMessageExpr::isDelegateInitCall ( ) const
inline

isDelegateInitCall - Answers whether this message send has been tagged as a "delegate init call", i.e.

a call to a method in the -init family on self from within an -init method implementation.

Definition at line 1307 of file ExprObjC.h.

◆ isImplicit()

bool clang::ObjCMessageExpr::isImplicit ( ) const
inline

Indicates whether the message send was implicitly generated by the implementation.

If false, it was written explicitly in the source code.

Definition at line 1132 of file ExprObjC.h.

Referenced by clang::arcmt::ObjCMigrateAction::BeginInvocation(), checkForLiteralCreation(), and clang::edit::rewriteToObjCSubscriptSyntax().

◆ isInstanceMessage()

bool clang::ObjCMessageExpr::isInstanceMessage ( ) const
inline

Determine whether this is an instance message to either a computed object or to super.

Definition at line 1143 of file ExprObjC.h.

Referenced by clang::Sema::checkRetainCycles(), GetNSSetArgumentIndex(), and clang::Expr::isUnusedResultAWarning().

◆ setArg()

void clang::ObjCMessageExpr::setArg ( unsigned  Arg,
Expr ArgExpr 
)
inline

setArg - Set the specified argument.

Definition at line 1299 of file ExprObjC.h.

Referenced by CheckKeyForObjCARCConversion(), and LookupMethodInReceiverType().

◆ setClassReceiver()

void clang::ObjCMessageExpr::setClassReceiver ( TypeSourceInfo TSInfo)
inline

Definition at line 1189 of file ExprObjC.h.

◆ setDelegateInitCall()

void clang::ObjCMessageExpr::setDelegateInitCall ( bool  isDelegate)
inline

Definition at line 1308 of file ExprObjC.h.

◆ setInstanceReceiver()

void clang::ObjCMessageExpr::setInstanceReceiver ( Expr rec)
inline

Turn this message send into an instance message that computes the receiver object with the given expression.

Definition at line 1167 of file ExprObjC.h.

◆ setMethodDecl()

void clang::ObjCMessageExpr::setMethodDecl ( ObjCMethodDecl MD)
inline

Definition at line 1265 of file ExprObjC.h.

◆ setSelector()

void clang::ObjCMessageExpr::setSelector ( Selector  S)
inline

Definition at line 1246 of file ExprObjC.h.

◆ setSourceRange()

void clang::ObjCMessageExpr::setSourceRange ( SourceRange  R)
inline

Definition at line 1340 of file ExprObjC.h.

References clang::SourceRange::getBegin(), and clang::SourceRange::getEnd().

◆ setSuper()

void clang::ObjCMessageExpr::setSuper ( SourceLocation  Loc,
QualType  T,
bool  IsInstanceSuper 
)
inline

Definition at line 1238 of file ExprObjC.h.

References clang::QualType::getAsOpaquePtr().

Friends And Related Function Documentation

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 1377 of file ExprObjC.h.

◆ ASTStmtWriter

friend class ASTStmtWriter
friend

Definition at line 1378 of file ExprObjC.h.

Member Data Documentation

◆ TrailingObjects

friend clang::ObjCMessageExpr::TrailingObjects

Definition at line 1376 of file ExprObjC.h.


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