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

targetNode Class Reference
[The AST nodes]

Jump target. More...

#include <ast.h>

Inheritance diagram for targetNode:

stmtNode Node caseNode labelNode List of all members.

Garbage collection.

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

Public Member Functions

 targetNode (NodeType typ, stmtNode *stmt, const Coord coord)
 Create a new target node.
virtual ~targetNode ()
 Destroy a targetNode.
virtual void output (output_context &ct, Node *par)
 Generate C code.
virtual void output_stmt (output_context &ct, Node *par)=0
 Output a statement.
void output_comment (output_context &ct)
virtual typeNode * type () const
 Return the node data type.
virtual typeNode * base_type (bool TdefIndir) const
 Return the base data type of a node.
typeNode * datatype () const
 Call base_type() with the argument true.
typeNode * datatype_superior () const
 Call base_type() with the argument false.
virtual void dataflow (FlowVal *v, FlowProblem &fp)=0
 Run the dataflow analyzer.
virtual Node * clone () const =0
 Clone the input node.
Accessors
Methods to get and set fields in the class.

blockNode * stmt () const
blockNode * get_stmt ()
void stmt (blockNode *stmt)
FlowVal * at_entry () const
void at_entry (FlowVal *ae)
Accessors
Methods to get and set fields in the class.

string & comment ()
FlowVal * at_exit () const
void at_exit (FlowVal *ae)
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.
AST traversal
These methods provide a uniform way to traverse the AST without explicitly testing the node types. They are all variations of the visitor design pattern. The input object is an instance of a user-defined subclass of Visitor, Walker or Changer. By overriding virtual methods, the user can define what to do at each kind of node that is encountered. See the C-Breeze documentation for more details.

virtual void visit (Visitor *the_visitor)=0
 Dispatch a Visitor.
virtual void walk (Walker &the_walker)=0
 Dispatch a Walker.
virtual Node * change (Changer &the_changer, bool redispatch=false)=0
 Dispatch a Changer.

Static Public Member Functions

static void report ()
 Report node count statistics.

Private Attributes

TREE blockNode * _stmt
 the target statement
FlowVal * _at_entry
 dataflow analysis entry value

Detailed Description

Jump target.

This class provides a base class for all statements that serve as targets for jumps. This includes the regular goto labels, as well as the switch cases and default. Note that in C, all labels refer to a statement. Syntactically, the labelled statement in the child of the label. For example, "case 5: x = 10; " results in a labelNode that has an exprstmtNode as it's child.

The NodeType is determined by the subclass (either Label, Case, or Default).

Definition at line 4708 of file ast.h.

Constructor & Destructor Documentation

targetNode::targetNode (  NodeType  typ,
stmtNode *  stmt,
const Coord  coord
) 
 

Create a new target node.

The new node has the given type and target statement.

Parameters:
typ the kind of target node (either Label, Case, or Default)
stmt the target statement

virtual targetNode::~targetNode (   )  [virtual]
 

Destroy a targetNode.

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 targetNode::at_entry (  FlowVal *  ae  )  [inline]
 

Definition at line 4754 of file ast.h.

References _at_entry.

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

Definition at line 4753 of file ast.h.

References _at_entry.

void stmtNode::at_exit (  FlowVal *  ae  )  [inline, inherited]
 

Reimplemented in basicblockNode.

Definition at line 4291 of file ast.h.

References stmtNode::_at_exit.

FlowVal* stmtNode::at_exit (   )  const [inline, inherited]
 

Reimplemented in basicblockNode.

Definition at line 4290 of file ast.h.

References stmtNode::_at_exit.

virtual typeNode* Node::base_type (  bool  TdefIndir  )  const [virtual, inherited]
 

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 in declNode, procNode, typeNode, tdefNode, exprNode, idNode, commaNode, callNode, blockNode, and exprstmtNode.

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

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.

Implemented in unitNode, declNode, subdeclNode, procNode, primNode, tdefNode, ptrNode, arrayNode, funcNode, structNode, unionNode, enumNode, suespecNode, constNode, idNode, binaryNode, unaryNode, castNode, commaNode, ternaryNode, callNode, initializerNode, blockNode, basicblockNode, exprstmtNode, labelNode, caseNode, ifNode, switchNode, whileNode, doNode, forNode, gotoNode, continueNode, breakNode, returnNode, attribNode, operandNode, conditiongotoNode, threeAddrNode, textNode, metaexprNode, and metastmtNode.

virtual Node* Node::clone (   )  const [pure virtual, inherited]
 

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).

Implemented in unitNode, declNode, subdeclNode, procNode, primNode, tdefNode, ptrNode, arrayNode, funcNode, structNode, unionNode, enumNode, suespecNode, constNode, idNode, binaryNode, unaryNode, castNode, commaNode, ternaryNode, callNode, initializerNode, blockNode, basicblockNode, exprstmtNode, labelNode, caseNode, ifNode, switchNode, whileNode, doNode, forNode, gotoNode, continueNode, breakNode, returnNode, attribNode, operandNode, conditiongotoNode, threeAddrNode, textNode, metaexprNode, and metastmtNode.

Referenced by ref_clone_changer::at_node().

string& stmtNode::comment (   )  [inline, inherited]
 

Definition at line 4286 of file ast.h.

References stmtNode::_comment.

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.

virtual void Node::dataflow (  FlowVal *  v,
FlowProblem &  fp
)  [pure virtual, inherited]
 

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).

Implemented in unitNode, declNode, procNode, typeNode, constNode, idNode, binaryNode, unaryNode, castNode, commaNode, ternaryNode, callNode, initializerNode, blockNode, exprstmtNode, labelNode, caseNode, ifNode, switchNode, whileNode, doNode, forNode, gotoNode, continueNode, breakNode, returnNode, attribNode, operandNode, conditiongotoNode, threeAddrNode, textNode, metaexprNode, and metastmtNode.

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 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* targetNode::get_stmt (   )  [inline]
 

Definition at line 4748 of file ast.h.

References _stmt.

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 stmtNode::output (  output_context &  ct,
Node *  par
)  [virtual, inherited]
 

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 stmtNode::output_comment (  output_context &  ct  )  [inherited]
 

virtual void stmtNode::output_stmt (  output_context &  ct,
Node *  par
)  [pure virtual, inherited]
 

Output a statement.

Implemented in blockNode, exprstmtNode, labelNode, caseNode, ifNode, switchNode, whileNode, doNode, forNode, gotoNode, continueNode, breakNode, returnNode, attribNode, conditiongotoNode, threeAddrNode, and metastmtNode.

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.

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.

void targetNode::stmt (  blockNode *  stmt  )  [inline]
 

Definition at line 4749 of file ast.h.

References _stmt.

blockNode* targetNode::stmt (   )  const [inline]
 

Definition at line 4747 of file ast.h.

References _stmt.

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 Node::visit (  Visitor *  the_visitor  )  [pure virtual, inherited]
 

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.

Implemented in unitNode, declNode, subdeclNode, procNode, primNode, tdefNode, ptrNode, arrayNode, funcNode, structNode, unionNode, enumNode, suespecNode, constNode, idNode, binaryNode, unaryNode, castNode, commaNode, ternaryNode, callNode, initializerNode, blockNode, basicblockNode, exprstmtNode, labelNode, caseNode, ifNode, switchNode, whileNode, doNode, forNode, gotoNode, continueNode, breakNode, returnNode, attribNode, operandNode, conditiongotoNode, threeAddrNode, textNode, metaexprNode, and metastmtNode.

virtual void Node::walk (  Walker &  the_walker  )  [pure virtual, inherited]
 

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.

Implemented in unitNode, declNode, subdeclNode, procNode, primNode, tdefNode, ptrNode, arrayNode, funcNode, structNode, unionNode, enumNode, suespecNode, constNode, idNode, binaryNode, unaryNode, castNode, commaNode, ternaryNode, callNode, initializerNode, blockNode, basicblockNode, exprstmtNode, labelNode, caseNode, ifNode, switchNode, whileNode, doNode, forNode, gotoNode, continueNode, breakNode, returnNode, attribNode, operandNode, conditiongotoNode, threeAddrNode, textNode, metaexprNode, and metastmtNode.

Referenced by gcWalker::at_binary(), sue_complete_walker::check(), and df_number_walker::number().

Member Data Documentation

FlowVal* targetNode::_at_entry [private]
 

dataflow analysis entry value

This field is used by the dataflow analysis framework to accumulate the flow-value coming in from the various jump statements.

Definition at line 4722 of file ast.h.

Referenced by at_entry().

TREE blockNode* targetNode::_stmt [private]
 

the target statement

Definition at line 4715 of file ast.h.

Referenced by get_stmt(), and stmt().

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