org.eclipse.cdt.internal.core.dom.parser.c

Class CASTFunctionDefinition

java.lang.Object

org.eclipse.cdt.internal.core.dom.parser.ASTNode

org.eclipse.cdt.internal.core.dom.parser.c.CASTFunctionDefinition

All Implemented Interfaces:

IASTDeclaration, IASTFunctionDefinition, IASTNode, IASTAmbiguityParent

public class CASTFunctionDefinition
extends ASTNode
implements IASTFunctionDefinition, IASTAmbiguityParent

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.cdt.core.dom.ast.IASTNode

IASTNode.CopyStyle

Field Summary

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

DECL_SPECIFIER, DECLARATOR, FUNCTION_BODY

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

EMPTY_DECLARATION_ARRAY

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

EMPTY_NODE_ARRAY

Constructor Summary

Constructors

Constructor and Description
CASTFunctionDefinition()
CASTFunctionDefinition(IASTDeclSpecifier declSpecifier, IASTFunctionDeclarator declarator, IASTStatement bodyStatement)

Method Summary

Modifier and Type	Method and Description
boolean	accept(ASTVisitor action) Abstract method to be overridden by all subclasses.
CASTFunctionDefinition	copy() Returns a mutable copy of the tree rooted at this node.
CASTFunctionDefinition	copy(IASTNode.CopyStyle style) Returns a mutable copy of the tree rooted at this node.
IASTStatement	getBody() Returns the body of the function.
IASTFunctionDeclarator	getDeclarator() Returns the function declarator of the function.
IASTDeclSpecifier	getDeclSpecifier() Returns the decl specifier for the function.
IScope	getScope() Get the logical IScope that the function definition body represents.
void	replace(IASTNode child, IASTNode other)
void	setBody(IASTStatement statement) Sets the body of the function.
void	setDeclarator(IASTFunctionDeclarator declarator) Sets the declarator for the function.
void	setDeclSpecifier(IASTDeclSpecifier declSpec) Set the decl specifier for the function.

Methods inherited from class org.eclipse.cdt.internal.core.dom.parser.ASTNode

acceptByNodes, assertNotFrozen, contains, copy, getChildren, getContainingFilename, getFileLocation, getImageLocation, getLeadingSyntax, getLength, getNodeLocations, getOffset, getOriginalNode, getParent, getPropertyInParent, getRawSignature, getRawSignatureChars, getSyntax, getTrailingSyntax, getTranslationUnit, isActive, isFrozen, isPartOfSourceFile, isPartOfTranslationUnitFile, resolvePendingAmbiguities, setInactive, setLength, setOffset, setOffsetAndLength, setOffsetAndLength, setParent, setPropertyInParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Constructor Detail

CASTFunctionDefinition

public CASTFunctionDefinition()

CASTFunctionDefinition

public CASTFunctionDefinition(IASTDeclSpecifier declSpecifier,
                              IASTFunctionDeclarator declarator,
                              IASTStatement bodyStatement)

Method Detail

copy

public CASTFunctionDefinition 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.

Calling this method is equivalent to copy(CopyStyle.withoutLocations).

Specified by:

copy in interface IASTDeclaration

Specified by:

copy in interface IASTFunctionDefinition

Specified by:

copy in interface IASTNode

copy

public CASTFunctionDefinition copy(IASTNode.CopyStyle style)

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 IASTDeclaration

Specified by:

copy in interface IASTFunctionDefinition

Specified by:

copy in interface IASTNode

Parameters:

style - IASTNode.CopyStyle create a copy with or without locations. Please see IASTNode.CopyStyle for restrictions on copies with Locations.

getDeclSpecifier

public IASTDeclSpecifier getDeclSpecifier()

Description copied from interface: IASTFunctionDefinition

Returns the decl specifier for the function.

Specified by:

getDeclSpecifier in interface IASTFunctionDefinition

setDeclSpecifier

public void setDeclSpecifier(IASTDeclSpecifier declSpec)

Description copied from interface: IASTFunctionDefinition

Set the decl specifier for the function.

Specified by:

setDeclSpecifier in interface IASTFunctionDefinition

getDeclarator

public IASTFunctionDeclarator getDeclarator()

Description copied from interface: IASTFunctionDefinition

Returns the function declarator of the function. Note, that the function declarator may contain nested declarators and may also nest within another declarator. In the latter case this function definition is always the parent of the outermost declarator.

 void (f)(int a); // has nested declarator
 void (f(int a)); // is nested in another declarator
 

Specified by:

getDeclarator in interface IASTFunctionDefinition

setDeclarator

public void setDeclarator(IASTFunctionDeclarator declarator)

Description copied from interface: IASTFunctionDefinition

Sets the declarator for the function. Note, that the function declarator may contain nested declarators and may also nest within another declarator. In the latter case this function definition is set to be the parent of the outermost declarator.

 void (f)(int a); // has nested declarator
 void (f(int a)); // is nested in another declarator
 

Specified by:

setDeclarator in interface IASTFunctionDefinition

getBody

public IASTStatement getBody()

Description copied from interface: IASTFunctionDefinition

Returns the body of the function. This is usually a compound statement but C++ also has a function try block.

Specified by:

getBody in interface IASTFunctionDefinition

setBody

public void setBody(IASTStatement statement)

Description copied from interface: IASTFunctionDefinition

Sets the body of the function.

Specified by:

setBody in interface IASTFunctionDefinition

getScope

public IScope getScope()

Description copied from interface: IASTFunctionDefinition

Get the logical IScope that the function definition body represents.

Specified by:

getScope in interface IASTFunctionDefinition

Returns:

IScope representing function body.

accept

public boolean accept(ASTVisitor action)

Description copied from interface: IASTNode

Abstract method to be overridden by all subclasses. Necessary for visitation of the tree using an ASTVisitor.

Specified by:

accept in interface IASTNode

Overrides:

accept in class ASTNode

Returns:

continue on (true) or quit (false)

replace

public void replace(IASTNode child,
                    IASTNode other)

Specified by:

replace in interface IASTAmbiguityParent