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

#include <ExprObjC.h>

Inheritance diagram for clang::ObjCMessageExpr:

Collaboration diagram for clang::ObjCMessageExpr:

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 Member Functions
bool	isImplicit () const
	Indicates whether the message send was implicitly generated by the implementation. If false, it was written explicitly in the source code.
ReceiverKind	getReceiverKind () const
	Determine the kind of receiver that this message is being sent to.
SourceRange	getReceiverRange () const
	Source range of the receiver.
bool	isInstanceMessage () const
	Determine whether this is an instance message to either a computed object or to super.
bool	isClassMessage () const
	Determine whether this is an class message to either a specified class or to super.
Expr *	getInstanceReceiver ()
	Returns the object expression (receiver) for an instance message, or null for a message that is not an instance message.
const Expr *	getInstanceReceiver () const
void	setInstanceReceiver (Expr *rec)
	Turn this message send into an instance message that computes the receiver object with the given expression.
QualType	getClassReceiver () const
	Returns the type of a class message send, or NULL if the message is not a class message.
TypeSourceInfo *	getClassReceiverTypeInfo () const
	Returns a type-source information of a class message send, or NULL if the message is not a class message.
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.
QualType	getReceiverType () const
	Retrieve the receiver type to which this message is being directed.
ObjCInterfaceDecl *	getReceiverInterface () const
	Retrieve the Objective-C interface to which this message is being directed, if known.
QualType	getSuperType () const
	Retrieve the type referred to by 'super'.
void	setSuper (SourceLocation Loc, QualType T, bool IsInstanceSuper)
Selector	getSelector () const
void	setSelector (Selector S)
const ObjCMethodDecl *	getMethodDecl () const
ObjCMethodDecl *	getMethodDecl ()
void	setMethodDecl (ObjCMethodDecl *MD)
ObjCMethodFamily	getMethodFamily () const
unsigned	getNumArgs () const
	Return the number of actual arguments in this message, not counting the receiver.
Expr **	getArgs ()
	Retrieve the arguments to this message, not including the receiver.
const Expr const	getArgs () const
Expr *	getArg (unsigned Arg)
	getArg - Return the specified argument.
const Expr *	getArg (unsigned Arg) const
void	setArg (unsigned Arg, Expr *ArgExpr)
	setArg - Set the specified argument.
bool	isDelegateInitCall () const
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 ()
arg_iterator	arg_begin ()
arg_iterator	arg_end ()
const_arg_iterator	arg_begin () const
const_arg_iterator	arg_end () const
Static Public Member Functions
static 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)
	Create a message send to super.
static 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)
	Create a class message send.
static 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)
	Create an instance message send.
static ObjCMessageExpr *	CreateEmpty (const ASTContext &Context, unsigned NumArgs, unsigned NumStoredSelLocs)
	Create an empty Objective-C message expression, to be filled in by subsequent calls.
static bool	classof (const Stmt *T)
Friends
class	ASTStmtReader
class	ASTStmtWriter

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:

Definition at line 879 of file ExprObjC.h.

Member Typedef Documentation

typedef ExprIterator clang::ObjCMessageExpr::arg_iterator

Definition at line 1371 of file ExprObjC.h.

typedef ConstExprIterator clang::ObjCMessageExpr::const_arg_iterator

Definition at line 1372 of file ExprObjC.h.

Member Enumeration Documentation

enum clang::ObjCMessageExpr::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 1019 of file ExprObjC.h.

Member Function Documentation

arg_iterator clang::ObjCMessageExpr::arg_begin ( ) [inline]

Definition at line 1374 of file ExprObjC.h.

References getArgs().

Referenced by clang::CodeGen::CodeGenFunction::EmitObjCMessageExpr().

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

Definition at line 1378 of file ExprObjC.h.

References getArgs().

arg_iterator clang::ObjCMessageExpr::arg_end ( ) [inline]

Definition at line 1375 of file ExprObjC.h.

References getArgs().

Referenced by clang::CodeGen::CodeGenFunction::EmitObjCMessageExpr().

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

Definition at line 1381 of file ExprObjC.h.

References getArgs().

Stmt::child_range ObjCMessageExpr::children ( )

Reimplemented from clang::Stmt.

Definition at line 4076 of file Expr.cpp.

References getArgs(), getNumArgs(), getReceiverKind(), and Instance.

static bool clang::ObjCMessageExpr::classof ( const Stmt * T ) [inline, static]

Reimplemented from clang::Expr.

Definition at line 1364 of file ExprObjC.h.

References clang::Stmt::getStmtClass().

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:

Context	The ASTContext in which this expression will be created.
T	The result type of this message.
VK	The value kind of this message. A message returning a l-value or r-value reference will be an l-value or x-value, respectively.
LBracLoc	The location of the open square bracket '['.
SuperLoc	The location of the "super" keyword.
IsInstanceSuper	Whether this is an instance "super" message (otherwise, it's a class "super" message).
Sel	The selector used to determine which method gets called.
Method	The Objective-C method against which this message send was type-checked. May be NULL.
Args	The message send arguments.
RBracLoc	The location of the closing square bracket ']'.

Definition at line 3514 of file Expr.cpp.

References isImplicit().

Referenced by clang::Sema::BuildClassMessage(), and clang::Sema::BuildInstanceMessage().

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:

Context	The ASTContext in which this expression will be created.
T	The result type of this message.
VK	The value kind of this message. A message returning a l-value or r-value reference will be an l-value or x-value, respectively.
LBracLoc	The location of the open square bracket '['.
Receiver	The type of the receiver, including source-location information.
Sel	The selector used to determine which method gets called.
Method	The Objective-C method against which this message send was type-checked. May be NULL.
Args	The message send arguments.
RBracLoc	The location of the closing square bracket ']'.

Definition at line 3539 of file Expr.cpp.

References isImplicit().

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:

Context	The ASTContext in which this expression will be created.
T	The result type of this message.
VK	The value kind of this message. A message returning a l-value or r-value reference will be an l-value or x-value, respectively.
LBracLoc	The location of the open square bracket '['.
Receiver	The expression used to produce the object that will receive this message.
Sel	The selector used to determine which method gets called.
Method	The Objective-C method against which this message send was type-checked. May be NULL.
Args	The message send arguments.
RBracLoc	The location of the closing square bracket ']'.

Definition at line 3562 of file Expr.cpp.

References isImplicit().

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:

Context	The context in which the message send will be created.
NumArgs	The number of message arguments, not including the receiver.

Definition at line 3585 of file Expr.cpp.

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

getArg - Return the specified argument.

Definition at line 1307 of file ExprObjC.h.

References getArgs().

Referenced by clang::Sema::checkRetainCycles(), doRewriteToUTF8StringBoxedExpressionHelper(), clang::edit::rewriteObjCRedundantCallWithLiteral(), rewriteToArrayLiteral(), rewriteToArraySubscriptSet(), rewriteToDictionaryLiteral(), rewriteToDictionarySubscriptSet(), rewriteToNumberLiteral(), rewriteToNumericBoxedExpression(), rewriteToStringBoxedExpression(), rewriteToSubscriptGetCommon(), and shouldNotRewriteImmediateMessageArgs().

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

Definition at line 1311 of file ExprObjC.h.

References getArgs().

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

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

Definition at line 1299 of file ExprObjC.h.

Referenced by arg_begin(), arg_end(), children(), getArg(), getSelectorLoc(), and setArg().

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

Definition at line 1302 of file ExprObjC.h.

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 1192 of file ExprObjC.h.

References getClassReceiverTypeInfo().

Referenced by clang::CodeGen::CodeGenFunction::EmitObjCMessageExpr(), GetAssumedMessageSendExprType(), getReceiverType(), and maybeAdjustInterfaceForSubscriptingCheck().

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 1201 of file ExprObjC.h.

References Class, and getReceiverKind().

Referenced by getClassReceiver(), and getReceiverRange().

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

Returns the object expression (receiver) for an instance message, or null for a message that is not an instance message.

Definition at line 1173 of file ExprObjC.h.

References getReceiverKind(), and Instance.

Referenced by canRewriteToSubscriptSyntax(), checkForLiteralCreation(), clang::Sema::checkRetainCycles(), clang::CodeGen::CodeGenFunction::EmitObjCMessageExpr(), GetAssumedMessageSendExprType(), getInstanceReceiver(), clang::ento::NilReceiverBRVisitor::getNilReceiver(), getReceiverRange(), getReceiverType(), clang::arcmt::trans::hasSideEffects(), clang::sema::FunctionScopeInfo::recordUseOfWeak(), rewriteToArraySubscriptSet(), rewriteToDictionarySubscriptSet(), rewriteToSubscriptGetCommon(), and shouldExtendReceiverForInnerPointerMessage().

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

Definition at line 1179 of file ExprObjC.h.

References getInstanceReceiver().

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

Definition at line 1327 of file ExprObjC.h.

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

Reimplemented from clang::Stmt.

Definition at line 1362 of file ExprObjC.h.

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

Reimplemented from clang::Stmt.

Definition at line 1361 of file ExprObjC.h.

Referenced by getSelectorStartLoc().

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

Definition at line 1269 of file ExprObjC.h.

Referenced by checkForLiteralCreation(), clang::CodeGen::CodeGenFunction::EmitObjCMessageExpr(), clang::CodeGen::CodeGenFunction::EmitObjCMessageExprLValue(), clang::Sema::EmitRelatedResultTypeNote(), GetAssumedMessageSendExprType(), getMethodFamily(), clang::ObjCMethodCall::getRuntimeDefinition(), IsReadonlyMessage(), clang::Expr::isUnusedResultAWarning(), and clang::edit::rewriteToObjCSubscriptSyntax().

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

Definition at line 1276 of file ExprObjC.h.

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

Definition at line 1288 of file ExprObjC.h.

References getMethodDecl(), clang::ObjCMethodDecl::getMethodFamily(), clang::Selector::getMethodFamily(), and getSelector().

Referenced by clang::Sema::BuildInstanceMessage(), clang::arcmt::trans::hasSideEffects(), and clang::Expr::isUnusedResultAWarning().

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

Return the number of actual arguments in this message, not counting the receiver.

Definition at line 1295 of file ExprObjC.h.

Referenced by clang::Sema::checkRetainCycles(), children(), getSelectorLoc(), clang::sema::FunctionScopeInfo::recordUseOfWeak(), clang::edit::rewriteObjCRedundantCallWithLiteral(), rewriteToArrayLiteral(), rewriteToArraySubscriptSet(), rewriteToDictionaryLiteral(), rewriteToDictionarySubscriptSet(), rewriteToNumberLiteral(), rewriteToNumericBoxedExpression(), clang::edit::rewriteToObjCSubscriptSyntax(), rewriteToStringBoxedExpression(), rewriteToSubscriptGetCommon(), and shouldNotRewriteImmediateMessageArgs().

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

Definition at line 1348 of file ExprObjC.h.

References clang::Selector::getNumArgs(), getSelector(), isImplicit(), and clang::Selector::isUnarySelector().

Referenced by getSelectorLoc(), and getSelectorLocs().

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 3656 of file Expr.cpp.

References clang::Type::getAs(), and getReceiverType().

Referenced by checkForLiteralCreation(), getMethodReceiverIfKnownImmutable(), clang::ObjCMethodCall::getRuntimeDefinition(), and clang::ObjCNoReturn::isImplicitNoReturn().

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

Determine the kind of receiver that this message is being sent to.

Definition at line 1154 of file ExprObjC.h.

Referenced by checkForLiteralCreation(), clang::Sema::checkRetainCycles(), children(), clang::CodeGen::CodeGenFunction::EmitObjCMessageExpr(), GetAssumedMessageSendExprType(), getClassReceiverTypeInfo(), getInstanceReceiver(), getReceiverRange(), getReceiverType(), getSuperLoc(), getSuperType(), clang::arcmt::trans::hasSideEffects(), isClassMessage(), isInstanceMessage(), maybeAdjustInterfaceForSubscriptingCheck(), clang::edit::rewriteToObjCSubscriptSyntax(), shouldExtendReceiverForInnerPointerMessage(), and FindSuperCallVisitor::VisitObjCMessageExpr().

SourceRange ObjCMessageExpr::getReceiverRange ( ) const

Source range of the receiver.

Definition at line 3619 of file Expr.cpp.

References Class, getClassReceiverTypeInfo(), getInstanceReceiver(), getReceiverKind(), clang::TypeLoc::getSourceRange(), clang::Stmt::getSourceRange(), getSuperLoc(), clang::TypeSourceInfo::getTypeLoc(), Instance, SuperClass, and SuperInstance.

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 3642 of file Expr.cpp.

References Class, getClassReceiver(), getInstanceReceiver(), getReceiverKind(), getSuperType(), clang::Expr::getType(), Instance, SuperClass, and SuperInstance.

Referenced by getReceiverInterface(), and clang::Expr::isUnusedResultAWarning().

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

Definition at line 1328 of file ExprObjC.h.

Selector ObjCMessageExpr::getSelector ( ) const

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

Definition at line 1335 of file ExprObjC.h.

References getArgs(), getNumArgs(), getNumSelectorLocs(), getSelector(), clang::getStandardSelectorLoc(), and clang::SelLoc_StandardWithSpace.

Referenced by getSelectorLocs(), and getSelectorStartLoc().

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

Definition at line 3613 of file Expr.cpp.

References getNumSelectorLocs(), and getSelectorLoc().

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

Definition at line 1330 of file ExprObjC.h.

References getLocStart(), getSelectorLoc(), and isImplicit().

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 1214 of file ExprObjC.h.

References getReceiverKind(), SuperClass, and SuperInstance.

Referenced by clang::Sema::checkRetainCycles(), and getReceiverRange().

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 1249 of file ExprObjC.h.

References clang::QualType::getFromOpaquePtr(), getReceiverKind(), SuperClass, and SuperInstance.

Referenced by clang::CodeGen::CodeGenFunction::EmitObjCMessageExpr(), getReceiverType(), clang::ObjCMethodCall::getRuntimeDefinition(), and maybeAdjustInterfaceForSubscriptingCheck().

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

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

Definition at line 1167 of file ExprObjC.h.

References Class, getReceiverKind(), and SuperClass.

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 1324 of file ExprObjC.h.

Referenced by clang::CodeGen::CodeGenFunction::EmitObjCMessageExpr().

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 1150 of file ExprObjC.h.

Referenced by checkForLiteralCreation(), Create(), getNumSelectorLocs(), getSelectorStartLoc(), and clang::edit::rewriteToObjCSubscriptSyntax().

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

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

Definition at line 1161 of file ExprObjC.h.

References getReceiverKind(), Instance, and SuperInstance.

Referenced by clang::Sema::checkRetainCycles(), clang::ObjCMethodCall::getRuntimeDefinition(), clang::ObjCNoReturn::isImplicitNoReturn(), and clang::Expr::isUnusedResultAWarning().