|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
Node Class ReferenceAST node base class.
More...
|
Garbage collection. | |
bool | mark |
static node_list | nodes |
static map< Node *, bool > | deleted_nodes |
Memory leak detection. | |
int | _uid |
static int | _count |
static int | _t_count [50] |
static int | _uid_count |
Public Member Functions | |
Node (NodeType typ, const Coord coord, bool parenthesized=false) | |
Construct a new node. | |
Node (const Node &other) | |
Copy constructor. | |
virtual | ~Node () |
Destructor. | |
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. | |
virtual void | output (output_context &ct, Node *par)=0 |
Generate C code. | |
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 | |
NodeType | _typ |
The kind of AST node. | |
Coord | _coord |
The source location. | |
bool | _parenthesized |
Whether this Node was enclosed in parenthases in the souce code. | |
annote_list | _annotations |
Annotations list. | |
FlowVal * | _gen |
"Gen" flow value. | |
FlowVal * | _kill |
"Kill" flow value. |
Each AST node corresponds to a C construction, such as a unary expression or a while loop. Subclasses are used to represent specific constructions.
To determine what type of AST node is contained in a Node, use the typ() method.
Each node has a source location, known as its "coord." This location specifies what part of the source C code a Node corresponds to.
A Node can have zero or more children. Each child is a Node that is "contained" within the construction represented by the Node. For example, a binary expression node has two children: one for its right operand, and one for its left operand. The Walker and Changer classes may be used to perform operations on a Node and all of its ancestors. See AST traversal for more information.
Definition at line 74 of file ast.h.
|
Construct a new node. The new Node's annotation list is initialized to be empty; its GEN and KILL values are set to NULL.
|
|
Copy constructor. Construct a copy of the given node, with the same type, coordinate, and parenthasization. Annotations and the GEN and KILL value are not copied: the annotation list is initialized to be empty, and the GEN and KILL values are set to NULL.
|
|
Destructor.
|
|
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.
Definition at line 274 of file ast.h. References _annotations. |
|
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.
Reimplemented in declNode, procNode, typeNode, tdefNode, exprNode, idNode, commaNode, callNode, blockNode, and exprstmtNode. |
|
Dispatch a Changer. This abstract method works much the walker, but allows the tree to be 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. |
|
Clone the input node. This is not a "deep" clone, so be careful. For a deep clone, use the ref_clone_changer class.
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(). |
|
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.
Definition at line 243 of file ast.h. References _coord. |
|
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.
Definition at line 230 of file ast.h. References _coord. |
|
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.
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. |
|
Call base_type() with the argument true.
|
|
Call base_type() with the argument false.
|
|
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.
Definition at line 297 of file ast.h. References _gen. |
|
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.
Definition at line 284 of file ast.h. References _gen. |
|
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.
Definition at line 320 of file ast.h. References _kill. |
|
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.
Definition at line 307 of file ast.h. References _kill. |
|
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.
Implemented in unitNode, declNode, subdeclNode, procNode, typeNode, exprNode, stmtNode, and textNode. |
|
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.
Definition at line 262 of file ast.h. References _parenthesized. |
|
Get the parenthesized boolean.
Definition at line 250 of file ast.h. References _parenthesized. |
|
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. |
|
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).
Definition at line 216 of file ast.h. References _typ. Referenced by gcWalker::delete_nodes(), and NodeInfo::nodeIndex(). |
|
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.
Reimplemented in declNode, typeNode, exprNode, and operandNode. |
|
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.
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. |
|
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.
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(). |
|
Annotations list. This is a user-accessible list of Annotation objects that allows general information to be attached to any node. Every element in the list should point to a valid Annotation; in particular, the list should contain no pointers to NULL values. Definition at line 112 of file ast.h. Referenced by annotations(). |
|
The source location. For nodes created during parsing, this indicates (roughly) where in the source code the node came from. For nodes created by other processing, you can either pass an existing Coord, or use Coord::Unknown. Definition at line 93 of file ast.h. Referenced by coord(). |
|
|
|
"Gen" flow value. For dataflow analysis, this field can hold a flow value that stores information generated at this node. When not in use, its value is NULL. Definition at line 120 of file ast.h. Referenced by gen(). |
|
"Kill" flow value. For dataflow analysis, this field can hold a flow value that stores information killed at this node. When not in use, its value is NULL. Definition at line 128 of file ast.h. Referenced by kill(). |
|
Whether this Node was enclosed in parenthases in the souce code. This value is used to decide whether to insert extra parenthases when generating C code from the AST. Note that parenthases will always be included when they are necessary to disambiguate an expression, regardless of the value of this variable. Definition at line 103 of file ast.h. Referenced by parenthesized(). |
|
|
|
The kind of AST node. This should be set by the constructor for the specific node subclass being created. Definition at line 84 of file ast.h. Referenced by typ(). |
|
|
|
|
|
Definition at line 165 of file ast.h. Referenced by gcWalker::delete_nodes(). |
|
Definition at line 168 of file ast.h. Referenced by gcWalker::at_binary(), and gcWalker::delete_nodes(). |
|
Definition at line 162 of file ast.h. Referenced by gcWalker::delete_nodes(), and gcWalker::gcWalker(). |
Generated on February 1, 2006
Back to the C-Breeze home page