Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

returnNode Class Reference

Return statement. More...

#include <ast.h>

Inheritance diagram for returnNode::

jumpNode stmtNode Node List of all members.

Public Methods

 returnNode (exprNode *expr, procNode *proc, const Coord coord=Coord::Unknown)
 Create a new return statement. More...

virtual ~returnNode ()
 Destroy a returnNode. More...

virtual void dataflow (FlowVal *v, FlowProblem &fp)
 Run the dataflow analyzer. More...

virtual Node * clone () const
 Clone the input node. More...

virtual void output_stmt (output_context &ct, Node *par)
 Output a statement. More...

Accessors
Methods to get and set fields in the class.

exprNode * expr () const
exprNode * get_expr ()
void expr (exprNode *expr)
procNode * proc () const
void proc (procNode *proc)
AST Traversal
Methods to uniformly traverse the AST. See the documentation in the Node class.

virtual void visit (Visitor *the_visitor)
 Dispatch a Visitor. More...

virtual void walk (Walker &the_walker)
 Dispatch a Walker. More...

virtual Node * change (Changer &the_changer, bool redispatch=false)
 Dispatch a Changer. More...


Private Attributes

TREE exprNode * _expr
 the return value, or null if there is none. More...

REF procNode * _proc
 a reference to the enclosing procedure. More...


Detailed Description

Return statement.

This class represents the return statement. It is classified as a jump because control leaves the procedure unconditionally.

The NodeType is Return.


Constructor & Destructor Documentation

returnNode::returnNode (  exprNode *    expr,
procNode *    proc,
const Coord    coord = Coord::Unknown
) 
 

Create a new return statement.

The new return statement has the given return value expression and containing procedure. For return statements with no return value, pass null for the expression.

Parameters:
expr  the return value expression, or null
proc  the enclosing procedure
coord  the location of the construct in the source file.

returnNode::~returnNode (    )  [virtual]
 

Destroy a returnNode.

Warning:
Do not use the destructors to delete AST nodes. Instead, rely on the node garbage collector.


Member Function Documentation

Node * returnNode::change (  Changer &    the_changer,
bool    redispatch = false
)  [virtual]
 

Dispatch a Changer.

This abstract method works much the walker, but allows the tree to be changed.

Parameters:
the_changer  the specific Changer object to use.
redispatch  pass true to revisit parts of the tree that have changed.

Reimplemented from Node.

virtual Node* returnNode::clone (    )  const [inline, virtual]
 

Clone the input node.

This is not a "deep" clone, so be careful. For a deep clone, use the clone_changer class.

Returns:
a shallow copy of the node (no subtrees are copied).

Reimplemented from Node.

void returnNode::dataflow (  FlowVal *    v,
FlowProblem &    fp
)  [virtual]
 

Run the dataflow analyzer.

Each subclass overrides this method to define it's semantics for dataflow analysis. It alters the input flow value to reflect the effect of the node within the given flow problem, calling dataflow() on it's subtrees as necessary. See the dataflow analysis documentation for more information.

Parameters:
v  the flow value to pass through the node.
fp  the flow problem (specifying the transfer functions).

Reimplemented from Node.

void returnNode::expr (  exprNode *    expr )  [inline]
 

exprNode* returnNode::expr (    )  const [inline]
 

exprNode* returnNode::get_expr (    )  [inline]
 

void returnNode::output_stmt (  output_context &    ct,
Node *    parent
)  [virtual]
 

Output a statement.

Reimplemented from stmtNode.

void returnNode::proc (  procNode *    proc )  [inline]
 

procNode* returnNode::proc (    )  const [inline]
 

void returnNode::visit (  Visitor *    the_visitor )  [virtual]
 

Dispatch a Visitor.

This abstract method is the entry point for the visitor design pattern. Each node subclass defines a visit() method that calls the appropriate at_ method in the visitor. For more information see the Visitor documentation.

Parameters:
the_visitor  the specific Visitor object to use.

Reimplemented from Node.

void returnNode::walk (  Walker &    the_walker )  [virtual]
 

Dispatch a Walker.

This abstract method works much like the visitor, but instead walks the entire underlying subtree calling the appropriate at_ method at each node. For more information see the Walker documentation.

Parameters:
the_walker  the specific Walker object to use.

Reimplemented from Node.


Member Data Documentation

TREE exprNode* returnNode::_expr [private]
 

the return value, or null if there is none.

REF procNode* returnNode::_proc [private]
 

a reference to the enclosing procedure.


The documentation for this class was generated from the following files:
Generated on Thu Jan 10 12:06:33 2002 for C-Breeze by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001