Module dev.civl.abc

Package dev.civl.abc.ast.node.IF.declaration

Interface FunctionDefinitionNode

All Superinterfaces:

ASTNode, BlockItemNode, DeclarationNode, FunctionDeclarationNode, OrdinaryDeclarationNode

All Known Subinterfaces:

PredicateNode

public interface FunctionDefinitionNode
extends FunctionDeclarationNode

Represents a function definition, i.e., a function declaration which includes the function body.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.civl.abc.ast.node.IF.ASTNode

ASTNode.NodeKind

Nested classes/interfaces inherited from interface dev.civl.abc.ast.node.IF.statement.BlockItemNode

BlockItemNode.BlockItemKind

Nested classes/interfaces inherited from interface dev.civl.abc.ast.node.IF.declaration.OrdinaryDeclarationNode

OrdinaryDeclarationNode.OrdinaryDeclarationKind

Method Summary

Modifier and Type	Method	Description
FunctionDefinitionNode	copy()	Returns a deep copy of this AST node.
CompoundStatementNode	getBody()	Returns the body of the function, a compound statement.
ExpressionNode	getLogicDefinition()	Pre-condition: call to FunctionDeclarationNode.isLogicFunction() returns true.
FunctionTypeNode	getTypeNode()	The type of the thing being declared.
void	setBody(CompoundStatementNode statement)	Sets the body to the given statement.

Methods inherited from interface dev.civl.abc.ast.node.IF.ASTNode

addAllTransformAnnotations, addTransformAnnotation, child, childIndex, children, diff, equiv, getAttribute, getOwner, getScope, getSource, id, keepOnly, nextDFS, nodeKind, numChildren, parent, prettyPrint, prettyRepresentation, prettyRepresentation, print, remove, removeChild, removeTransformAnnotation, setAttribute, setChild, setId, setOwner, setScope, toString, transformAnnotations

Methods inherited from interface dev.civl.abc.ast.node.IF.statement.BlockItemNode

blockItemKind

Methods inherited from interface dev.civl.abc.ast.node.IF.declaration.DeclarationNode

getIdentifier, getName, isDefinition, setEntity, setIdentifier, setIsDefinition

Methods inherited from interface dev.civl.abc.ast.node.IF.declaration.FunctionDeclarationNode

getContract, getEntity, getSystemLibrary, hasAtomicFunctionSpecifier, hasDeviceFunctionSpecifier, hasGlobalFunctionSpecifier, hasInlineFunctionSpecifier, hasNoreturnFunctionSpecifier, hasPureFunctionSpecifier, hasStatefFunctionSpecifier, hasSystemFunctionSpecifier, isLogicFunction, setAtomicFunctionSpecifier, setContract, setDeviceFunctionSpecifier, setGlobalFunctionSpecifier, setInlineFunctionSpecifier, setIsLogicFunction, setNoreturnFunctionSpecifier, setPureFunctionSpecifier, setStatefFunctionSpecifier, setSystemFunctionSpecifier, setSystemLibrary

Methods inherited from interface dev.civl.abc.ast.node.IF.declaration.OrdinaryDeclarationNode

hasExternStorage, hasStaticStorage, ordinaryDeclarationKind, setExternStorage, setStaticStorage, setTypeNode

Method Details

getBody

CompoundStatementNode getBody()

Returns the body of the function, a compound statement.

Returns:

the function body

setBody

void setBody(CompoundStatementNode statement)

Sets the body to the given statement. The statement becomes a child of this node.

Parameters:

statement - node to be made the body child of this node

copy

FunctionDefinitionNode copy()

Description copied from interface: ASTNode

Returns a deep copy of this AST node. The node and all of its descendants will be cloned. The cloning does not copy analysis or attribute information.

Specified by:

copy in interface ASTNode

Specified by:

copy in interface BlockItemNode

Specified by:

copy in interface DeclarationNode

Specified by:

copy in interface FunctionDeclarationNode

Specified by:

copy in interface OrdinaryDeclarationNode

Returns:

deep copy of this node

getTypeNode

FunctionTypeNode getTypeNode()

Description copied from interface: OrdinaryDeclarationNode

The type of the thing being declared. This may be null: e.g., in a function declaration, the parameter types do not necessarily have to be declared.

Specified by:

getTypeNode in interface OrdinaryDeclarationNode

Returns:

the type node for the type of the entity being declared

See Also:

• OrdinaryDeclarationNode.setTypeNode(TypeNode)

getLogicDefinition

ExpressionNode getLogicDefinition()

Pre-condition: call to FunctionDeclarationNode.isLogicFunction() returns true.

Returns:

The logic function definition, which is a side-effect free expression, if this funciton is a logic function. Otherwise, null.