C-Breeze
C Compiler Infrastructure

[ Project home page]
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

procNode Class Reference
[The AST nodes]

Procedure definition. More...

#include <ast.h>

Inheritance diagram for procNode:

defNode Node List of all members.

Parser methods

void define (blockNode *body)
procNode * define_and (blockNode *body)
static procNode * current ()

Garbage collection.

bool mark
static node_list nodes
static map< Node *, bool > deleted_nodes

Public Member Functions

 procNode (declNode *decl, blockNode *body, const Coord coord=Coord::Unknown)
 Create a new procedure.
 procNode (bool old_style, declNode *decl)
 Create a procedure during parsing.
virtual ~procNode ()
 Destroy a procNode.
void return_label (labelNode *label)
labelNode * return_label ()
void return_decl (declNode *decl)
declNode * return_decl ()
typeNode * base_type (bool TdefIndir) const
 Return the base data type of a node.
virtual void dataflow (FlowVal *v, FlowProblem &fp)
 Run the dataflow analyzer.
virtual Node * clone () const
 Clone the input node.
virtual void output (output_context &ct, Node *par)
 Generate C code.
virtual void grab_pragmas (void)
 Attaches pragmas to this defNode.
virtual typeNode * type () const
 Return the node data type.
typeNode * datatype () const
 Call base_type() with the argument true.
typeNode * datatype_superior () const
 Call base_type() with the argument false.
Accessors
Methods to get and set fields in the class.

declNode * decl () const
 Return the declaration for this procNode.
declNode * get_decl ()
 Return the declaration for this procNode, and set it to be empty.
void decl (declNode *decl)
 Set the declaration for this procNode to the given value.
blockNode * body () const
 Return this procNode's body.
blockNode * get_body ()
 Return the body for this procNode, and set it to be empty.
void body (blockNode *body)
 Set this procNode's body to the given value.
FlowVal * at_entry () const
 Return this Node's at_entry dataflow analysis value.
void at_entry (FlowVal *ae)
 Set this procNode's entry flow value.
FlowVal * at_exit () const
 Return this Node's at_exit dataflow analysis value.
void at_exit (FlowVal *ae)
 Set this procNode's exit flow value.
Control-flow Graph
These methods return the entry and exit basic blocks when a procedure is in control-flow graph form. Currently, the convention is that the first basic block is the entry and the last basic block is the exit; however, the user should not depend on this fact.

The control-flow graph is built using the cfg_changer.

See also:
cfg_changer


basicblockNode * entry () const
 Entry basic block.
basicblockNode * exit () const
 Exit basic block.
AST Traversal
Methods to uniformly traverse the AST. See the documentation in the Node class.

virtual void visit (Visitor *the_visitor)
 Dispatch a Visitor.
virtual void walk (Walker &the_walker)
 Dispatch a Walker.
virtual Node * change (Changer &the_changer, bool redispatch=false)
 Dispatch a Changer.
Accessors
Methods to get and set fields in the class.

text_list & pragmas ()
Accessors
Methods to get and set fields in the class.

NodeType typ () const
 Get the node type.
Coord coord () const
 Get the source location.
void coord (const Coord coord)
 Set the source location.
bool parenthesized () const
 Get the parenthesized boolean.
void parenthesized (bool paren)
 Set the parenthesized boolean.
annote_list & annotations ()
 Get the annotations list.
FlowVal * gen () const
 Get the "gen" flow value.
void gen (FlowVal *g)
 Set the "gen" flow value.
FlowVal * kill () const
 Get the "kill" flow value.
void kill (FlowVal *k)
 Set the "kill" flow value.

Static Public Member Functions

static void report ()
 Report node count statistics.

Private Attributes

TREE declNode * _decl
 Procedure declaration.
TREE blockNode * _body
 Procedure body.
labelNode * _return_label
declNode * _return_decl
Dataflow analysis
FlowVal * _at_entry
FlowVal * _at_exit

Static Private Attributes

static procNode * _current
 Current procedure during parsing.

Detailed Description

Procedure definition.

This class represents a procedure (or function) definition. The definition consists of a declarations (which gives the name and interface of the procedure) and the procedure body.

The NodeType is Proc.

Definition at line 1316 of file ast.h.

Constructor & Destructor Documentation

procNode::procNode (  declNode *  decl,
blockNode *  body,
const Coord  coord = Coord::Unknown
) 
 

Create a new procedure.

Parameters:
decl the procedure declaration (always type funcNode )
body the code of the procedure body
coord the location of the construct in the source file.

Referenced by clone().

procNode::procNode (  bool  old_style,
declNode *  decl
) 
 

Create a procedure during parsing.

virtual procNode::~procNode (   )  [virtual]
 

Destroy a procNode.

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

Member Function Documentation

annote_list& Node::annotations (   )  [inline, inherited]
 

Get the annotations list.

This method returns a modifiable reference to the list of annotations on the node. Users can add new annotations, search for annotations, or remove annotations. Users are responsible for ensuring that every element of the annotation list points to a valid annotation. In particular, no element should be NULL.

See also:
Annote class

Definition at line 274 of file ast.h.

References Node::_annotations.

void procNode::at_entry (  FlowVal *  ae  )  [inline]
 

Set this procNode's entry flow value.

Definition at line 1455 of file ast.h.

References _at_entry.

FlowVal* procNode::at_entry (   )  const [inline]
 

Return this Node's at_entry dataflow analysis value.

Definition at line 1450 of file ast.h.

References _at_entry.

void procNode::at_exit (  FlowVal *  ae  )  [inline]
 

Set this procNode's exit flow value.

Definition at line 1465 of file ast.h.

References _at_exit.

FlowVal* procNode::at_exit (   )  const [inline]
 

Return this Node's at_exit dataflow analysis value.

Definition at line 1460 of file ast.h.

References _at_exit.

typeNode* procNode::base_type (  bool  TdefIndir  )  const [virtual]
 

Return the base data type of a node.

This method differs from the Node::type() method in two respects. First, it follows some of the simple type inferences. For example, calling it on an idNode will return the type of its declaration. Second, the boolean argument indicates whether or not to follow typedef links.

Parameters:
TdefIndir pass true to follow typedefs to their definitions.

Reimplemented from Node.

void procNode::body (  blockNode *  body  )  [inline]
 

Set this procNode's body to the given value.

To set this procNode's body to be empty, use a value of NULL.

Definition at line 1443 of file ast.h.

References _body.

blockNode* procNode::body (   )  const [inline]
 

Return this procNode's body.

Definition at line 1431 of file ast.h.

References _body.

Referenced by UnusedDeclarationCleanupChanger::at_proc().

virtual Node* procNode::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.

Implements Node.

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

Clone the input node.

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

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

Implements Node.

Definition at line 1537 of file ast.h.

References procNode().

void Node::coord (  const Coord  coord  )  [inline, inherited]
 

Set the source location.

This location should indicate the position in the source text that this Node represents, or Coord::Unknown if it does not represent any node in the source text.

It is not common to set the source location of a node. Currently, only the compiler error messages actually make use of it.

Parameters:
coord the new location.

Definition at line 243 of file ast.h.

References Node::_coord.

Coord Node::coord (   )  const [inline, inherited]
 

Get the source location.

The Coord class holds a location in the input source (file, line, position). During parsing, each AST node created records the position of the source text that it represents. However, subsequent phases may create or change nodes, so no guarantee is given about how the source location corresponds to the original source text.

Returns:
the Coord structure indicating where the node came from in the source file.

Definition at line 230 of file ast.h.

References Node::_coord.

static procNode* procNode::current (   )  [inline, static]
 

Definition at line 1512 of file ast.h.

References _current.

virtual void procNode::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).

Implements Node.

typeNode* Node::datatype (   )  const [inherited]
 

Call base_type() with the argument true.

typeNode* Node::datatype_superior (   )  const [inherited]
 

Call base_type() with the argument false.

void procNode::decl (  declNode *  decl  )  [inline]
 

Set the declaration for this procNode to the given value.

To set this procNode's declaration to be empty, use a value of NULL.

Definition at line 1427 of file ast.h.

References _decl.

declNode* procNode::decl (   )  const [inline]
 

Return the declaration for this procNode.

The declaration of the procedure consists of the name, plus the type, which specifies the function interface. The declaration's type is guaranteed to be a funcNode.

Definition at line 1410 of file ast.h.

References _decl.

void procNode::define (  blockNode *  body  ) 
 

procNode* procNode::define_and (  blockNode *  body  ) 
 

basicblockNode* procNode::entry (   )  const
 

Entry basic block.

Returns:
the entry basic block

basicblockNode* procNode::exit (   )  const
 

Exit basic block.

Returns:
the exit basic block

void Node::gen (  FlowVal *  g  )  [inline, inherited]
 

Set the "gen" flow value.

This value is used in dataflow analyses to store information that is generated at this node. Note that each node has exactly one "gen" flow value.

In order to set the flow value to be empty, call this method with a value of NULL.

Parameters:
g the new gen flow value.

Definition at line 297 of file ast.h.

References Node::_gen.

FlowVal* Node::gen (   )  const [inline, inherited]
 

Get the "gen" flow value.

This value is used in dataflow analyses to store information that is generated at this node. Note that each node has exactly one "gen" flow value.

Returns:
the "gen" flow value.

Definition at line 284 of file ast.h.

References Node::_gen.

blockNode* procNode::get_body (   )  [inline]
 

Return the body for this procNode, and set it to be empty.

Definition at line 1436 of file ast.h.

References _body.

declNode* procNode::get_decl (   )  [inline]
 

Return the declaration for this procNode, and set it to be empty.

The declaration of the procedure consists of the name, plus the type, which specifies the function interface. The declaration's type is guaranteed to be a funcNode.

Definition at line 1419 of file ast.h.

References _decl.

virtual void defNode::grab_pragmas (  void   )  [virtual, inherited]
 

Attaches pragmas to this defNode.

Used by parser to attach the current pragmas to a defNode.

void Node::kill (  FlowVal *  k  )  [inline, inherited]
 

Set the "kill" flow value.

This value is used in dataflow analyses to store information that is killed at this node. Note that each node has exactly one "kill" flow value.

To set the flow value to be empty, call this method with a value of NULL.

Parameters:
k the new kill flow value.

Definition at line 320 of file ast.h.

References Node::_kill.

FlowVal* Node::kill (   )  const [inline, inherited]
 

Get the "kill" flow value.

This value is used in dataflow analyses to store information that is killed at this node. Note that each node has exactly one "kill" flow value.

Returns:
the "kill" flow value.

Definition at line 307 of file ast.h.

References Node::_kill.

virtual void procNode::output (  output_context &  ct,
Node *  par
)  [virtual]
 

Generate C code.

Each subclass overrides this method to define how to produce the output C code. To use this method, pass an output_context and a null parent.

Parameters:
ct the output context which describes the formatting.
par the parent node (or null, if at the top of a subtree).

Implements Node.

void Node::parenthesized (  bool  paren  )  [inline, inherited]
 

Set the parenthesized boolean.

This boolean determines whether this expression will be parenthesized in the output. Note that that the parentheses will always be added when they are needed to disambiguate the output. This variable only controls the use of "un-necessary" parentheses.

Parameters:
paren the new value of the parenthesized boolean.

Definition at line 262 of file ast.h.

References Node::_parenthesized.

bool Node::parenthesized (   )  const [inline, inherited]
 

Get the parenthesized boolean.

Returns:
true if the construct corresponding to this Node was parenthesized in the source.

Definition at line 250 of file ast.h.

References Node::_parenthesized.

text_list& defNode::pragmas (   )  [inline, inherited]
 

Definition at line 749 of file ast.h.

References defNode::_pragmas.

static void Node::report (   )  [static, inherited]
 

Report node count statistics.

The code can be configured to gather statistics about node usage according to type. This method prints the current state of that accounting information to standard out.

declNode* procNode::return_decl (   )  [inline]
 

Definition at line 1472 of file ast.h.

References _return_decl.

void procNode::return_decl (  declNode *  decl  )  [inline]
 

Definition at line 1471 of file ast.h.

References _return_decl.

labelNode* procNode::return_label (   )  [inline]
 

Definition at line 1470 of file ast.h.

References _return_label.

void procNode::return_label (  labelNode *  label  )  [inline]
 

Definition at line 1469 of file ast.h.

References _return_label.

NodeType Node::typ (   )  const [inline, inherited]
 

Get the node type.

This has nothing to do with types in the source code. It indicates what kind of AST node this is (e.g., a unary expression node or a while node).

Returns:
the node type.

Definition at line 216 of file ast.h.

References Node::_typ.

Referenced by gcWalker::delete_nodes(), and NodeInfo::nodeIndex().

virtual typeNode* Node::type (   )  const [inline, virtual, inherited]
 

Return the node data type.

This method returns the C data type of a node. Several different kinds of nodes contain typeNode pointers. This method is just a unified way to access them. It does not attempt to compute the type, it just returns whatever typeNode pointer resides on the node. The subclasses that have types return them, and the others return null.

Returns:
the typeNode pointer on the node.

Reimplemented in declNode, typeNode, exprNode, and operandNode.

Definition at line 342 of file ast.h.

virtual void procNode::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.

Implements Node.

virtual void procNode::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.

Implements Node.

Member Data Documentation

FlowVal* procNode::_at_entry [private]
 

Definition at line 1356 of file ast.h.

Referenced by at_entry().

FlowVal* procNode::_at_exit [private]
 

Definition at line 1357 of file ast.h.

Referenced by at_exit().

TREE blockNode* procNode::_body [private]
 

Procedure body.

The procedure body is represented as a statement block

Definition at line 1335 of file ast.h.

Referenced by body(), and get_body().

procNode* procNode::_current [static, private]
 

Current procedure during parsing.

Definition at line 1343 of file ast.h.

Referenced by current().

TREE declNode* procNode::_decl [private]
 

Procedure declaration.

The declaration of the procedure consists of the name, plus the type, which specifies the function interface. The type is always a funcNode. If _decl is NULL, then the procedure's declaration is empty.

Definition at line 1329 of file ast.h.

Referenced by decl(), and get_decl().

declNode* procNode::_return_decl [private]
 

Definition at line 1366 of file ast.h.

Referenced by return_decl().

labelNode* procNode::_return_label [private]
 

Definition at line 1365 of file ast.h.

Referenced by return_label().

map<Node *, bool> Node::deleted_nodes [static, inherited]
 

Definition at line 165 of file ast.h.

Referenced by gcWalker::delete_nodes().

bool Node::mark [inherited]
 

Definition at line 168 of file ast.h.

Referenced by gcWalker::at_binary(), and gcWalker::delete_nodes().

node_list Node::nodes [static, inherited]
 

Definition at line 162 of file ast.h.

Referenced by gcWalker::delete_nodes(), and gcWalker::gcWalker().

The documentation for this class was generated from the following file:

Generated on February 1, 2006
Back to the C-Breeze home page