org.eclipse.cdt.core.dom.ast
Interface IASTForStatement

All Superinterfaces:

IASTNode, IASTStatement

All Known Subinterfaces:

ICPPASTForStatement

public interface IASTForStatement
extends IASTStatement

The for statement. The initialization clause can be an expression or a declaration but not both.

Field Summary

static ASTNodeProperty	BODY BODY represents the relationship between a IASTForStatement and its IASTStatement body.
static ASTNodeProperty	CONDITION CONDITION represents the relationship between a IASTForStatement and its IASTExpression condition.
static ASTNodeProperty	INITIALIZER INITIALIZER represents the relationship between a IASTForStatement and its IASTDeclaration initializer.
static ASTNodeProperty	ITERATION ITERATION represents the relationship between a IASTForStatement and its IASTExpression iteration expression.

Fields inherited from interface org.eclipse.cdt.core.dom.ast.IASTStatement

EMPTY_STATEMENT_ARRAY

Fields inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode

EMPTY_NODE_ARRAY

Method Summary

IASTForStatement	copy() Returns a mutable copy of the tree rooted at this node.
IASTStatement	getBody() Get the statements that this for loop controls.
IASTExpression	getConditionExpression() Get the condition expression for the loop.
IASTStatement	getInitializerStatement()
IASTExpression	getIterationExpression() Get the expression that is evaluated after the completion of an iteration of the loop.
IScope	getScope() Get the IScope represented by this for loop.
void	setBody(IASTStatement statement) Set the body of the for loop.
void	setConditionExpression(IASTExpression condition) Set the condition expression for the loop.
void	setInitializerStatement(IASTStatement statement)
void	setIterationExpression(IASTExpression iterator) Set the expression that is evaluated after the completion of an iteration of the loop.

Methods inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode

accept, contains, getChildren, getContainingFilename, getFileLocation, getLeadingSyntax, getNodeLocations, getParent, getPropertyInParent, getRawSignature, getSyntax, getTrailingSyntax, getTranslationUnit, isActive, isFrozen, isPartOfTranslationUnitFile, setParent, setPropertyInParent

Field Detail

CONDITION

static final ASTNodeProperty CONDITION

CONDITION represents the relationship between a IASTForStatement and its IASTExpression condition.

ITERATION

static final ASTNodeProperty ITERATION

ITERATION represents the relationship between a IASTForStatement and its IASTExpression iteration expression.

BODY

static final ASTNodeProperty BODY

BODY represents the relationship between a IASTForStatement and its IASTStatement body.

INITIALIZER

static final ASTNodeProperty INITIALIZER

INITIALIZER represents the relationship between a IASTForStatement and its IASTDeclaration initializer.

Method Detail

getInitializerStatement

IASTStatement getInitializerStatement()

setInitializerStatement

void setInitializerStatement(IASTStatement statement)

Parameters:

statement -

getConditionExpression

IASTExpression getConditionExpression()

Get the condition expression for the loop.

Returns:

IASTExpression

setConditionExpression

void setConditionExpression(IASTExpression condition)

Set the condition expression for the loop.

Parameters:

condition - IASTExpression

getIterationExpression

IASTExpression getIterationExpression()

Get the expression that is evaluated after the completion of an iteration of the loop.

Returns:

IASTExpression

setIterationExpression

void setIterationExpression(IASTExpression iterator)

Set the expression that is evaluated after the completion of an iteration of the loop.

Parameters:

iterator - IASTExpression

getBody

IASTStatement getBody()

Get the statements that this for loop controls.

Returns:

IASTStatement

setBody

void setBody(IASTStatement statement)

Set the body of the for loop.

Parameters:

statement - IASTStatement

getScope

IScope getScope()

Get the IScope represented by this for loop.

Returns:

IScope

copy

IASTForStatement copy()

Description copied from interface: IASTNode

Returns a mutable copy of the tree rooted at this node. The following postconditions hold: copy.getParent() == null copy.getPropertyInParent() == null copy.isFrozen() == false Preprocessor nodes do not currently support being copied. Implicit name nodes are not copied, instead they can be regenerated if required.

Specified by:

copy in interface IASTNode

Specified by:

copy in interface IASTStatement

Since:

5.1