C-Breeze
C Compiler Infrastructure

[ Project home page]

unitNode Class Reference
[The AST nodes]

Holds the AST of one translation unit. More...

#include <ast.h>

Inheritance diagram for unitNode:

Node List of all members.

Garbage collection.

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

Public Member Functions

 unitNode (string input_file, string output_file, string obj_file, const Coord coord=Coord::Unknown)
 Create a new translation unit from a source file.
virtual ~unitNode ()
 Destroy a unitNode.
void parse (str_list *cpp_flags, bool abortOnError=true)
 Parse the input file.
void fixup ()
 Run fixup passes.
void merge_in (def_list *defs)
 Merge in external definitions.
void enter_scope ()
 Enter a new scope.
void exit_scope ()
 Exit scope.
void enter_pragmas ()
 Enter a new pragma depth.
void exit_pragmas ()
 Exit s pragma depth.
virtual void dataflow (FlowVal *v, FlowProblem &fp)
 Run the dataflow analyzer.
virtual Nodeclone () const
 Clone the input node.
virtual void output (output_context &ct, Node *par)
 Generate C code.
virtual typeNodetype () const
 Return the node data type.
virtual typeNodebase_type (bool TdefIndir) const
 Return the base data type of a node.
typeNodedatatype () const
 Call base_type() with the argument true.
typeNodedatatype_superior () const
 Call base_type() with the argument false.
Accessors
Methods to get and set fields in the class.

def_listdefs ()
const def_listdefs () const
int symbol_level () const
int pragma_level () const
Identifiers_tabletypes () const
Tags_tabletags () const
string & input_file ()
string & output_file ()
string & obj_file ()
int errors () const
void inc_errors ()
int warnings () const
void inc_warnings ()
decl_listundef_funcs ()
suespec_listsuespecs ()
text_listpragmas ()
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 Nodechange (Changer &the_changer, bool redispatch=false)
 Dispatch a Changer.
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_listannotations ()
 Get the annotations list.
FlowValgen () const
 Get the "gen" flow value.
void gen (FlowVal *g)
 Set the "gen" flow value.
FlowValkill () 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 Member Functions

FILE * _open_input_file (str_list *cpp_flags)
 Open the input file.

Private Attributes

TREE def_list _defs
 The external definitions.
int _symbol_level
 Depth of the scope.
int _pragma_level
 Depth for pragmas.
Identifiers_table_types
 Table of type names.
Tags_table_tags
 Table of struct/union tags.
string _input_file
 Source file name.
string _output_file
 The output file name.
string _obj_file
 The object output file name.
int _errors
 The number of errors.
int _warnings
 The number of warnings.
TREE decl_list _undef_funcs
 Undeclared functions.
TREE suespec_list _suespecs
 struct/enum/union contents
text_list _pragmas
 Pragmas.

Detailed Description

Holds the AST of one translation unit.

A translation unit corresponds to a single input source file (with all header files included). To parse a source file in, create a unitNode and then call the parse() method. However, this is typically done by the main driver, which also handles the flags provided on the command line.

All instances of unitNode created by the main driver are stored in a global list in the CBZ class.

The NodeType is Unit.

In addition to containing the AST for the code, unitNode contains auxillary information gathered during the parsing. This includes:

  • A table of the type names in the file (only used during parsing).
  • A table of the struct/union tags (only used during parsing).
  • A list of any functions without explicit declarations.
  • The list of struct/union bodies.

Definition at line 467 of file ast.h.


Constructor & Destructor Documentation

unitNode::unitNode string  input_file,
string  output_file,
string  obj_file,
const Coord  coord = Coord::Unknown
 

Create a new translation unit from a source file.

Instantiate a new unitNode with the given input and output source file names. This is typically done automatically by the front-end driver.

Parameters:
input_file the name of the input source file.
output_file the name of the output source file.
obj_file the name of the object file produced
coord the location of the construct in the source file.

Referenced by clone().

virtual unitNode::~unitNode  )  [virtual]
 

Destroy a unitNode.

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


Member Function Documentation

FILE* unitNode::_open_input_file str_list cpp_flags  )  [private]
 

Open the input file.

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.

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* unitNode::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.

Referenced by constantsChanger::optimize().

virtual Node* unitNode::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 708 of file ast.h.

References unitNode().

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 unitNode::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.

const def_list& unitNode::defs  )  const [inline]
 

Definition at line 622 of file ast.h.

References _defs.

def_list& unitNode::defs  )  [inline]
 

Definition at line 621 of file ast.h.

References _defs.

void unitNode::enter_pragmas  ) 
 

Enter a new pragma depth.

void unitNode::enter_scope  ) 
 

Enter a new scope.

int unitNode::errors  )  const [inline]
 

Definition at line 633 of file ast.h.

References _errors.

void unitNode::exit_pragmas  ) 
 

Exit s pragma depth.

void unitNode::exit_scope  ) 
 

Exit scope.

void unitNode::fixup  ) 
 

Run fixup passes.

Run the various fix-up passes, just as we would after parsing.

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.

void unitNode::inc_errors  )  [inline]
 

Definition at line 634 of file ast.h.

References _errors.

void unitNode::inc_warnings  )  [inline]
 

Definition at line 637 of file ast.h.

References _warnings.

string& unitNode::input_file  )  [inline]
 

Definition at line 629 of file ast.h.

References _input_file.

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.

void unitNode::merge_in def_list defs  )  [inline]
 

Merge in external definitions.

Definition at line 658 of file ast.h.

References _defs.

string& unitNode::obj_file  )  [inline]
 

Definition at line 631 of file ast.h.

References _obj_file.

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

string& unitNode::output_file  )  [inline]
 

Definition at line 630 of file ast.h.

References _output_file.

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.

void unitNode::parse str_list cpp_flags,
bool  abortOnError = true
 

Parse the input file.

Run the parser on the input file using the given preprocessor flags. The resulting AST is stored in the various unitNode fields ( _defs, _types, etc.).

Parameters:
cpp_flags a list of strings, each one is a preprocessor flag.

int unitNode::pragma_level  )  const [inline]
 

Definition at line 625 of file ast.h.

References _pragma_level.

text_list& unitNode::pragmas  )  [inline]
 

Definition at line 643 of file ast.h.

References _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.

suespec_list& unitNode::suespecs  )  [inline]
 

Definition at line 641 of file ast.h.

References _suespecs.

int unitNode::symbol_level  )  const [inline]
 

Definition at line 624 of file ast.h.

References _symbol_level.

Tags_table* unitNode::tags  )  const [inline]
 

Definition at line 627 of file ast.h.

References _tags.

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.

Identifiers_table* unitNode::types  )  const [inline]
 

Definition at line 626 of file ast.h.

References _types.

decl_list& unitNode::undef_funcs  )  [inline]
 

Definition at line 639 of file ast.h.

References _undef_funcs.

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

int unitNode::warnings  )  const [inline]
 

Definition at line 636 of file ast.h.

References _warnings.


Member Data Documentation

TREE def_list unitNode::_defs [private]
 

The external definitions.

The list of external definitions (top level) parsed in from the source. This is the top of the AST.

Definition at line 477 of file ast.h.

Referenced by defs(), and merge_in().

int unitNode::_errors [private]
 

The number of errors.

The number of errors encountered during parsing.

Definition at line 533 of file ast.h.

Referenced by errors(), and inc_errors().

string unitNode::_input_file [private]
 

Source file name.

The name of the source file from which this AST was parsed.

Definition at line 514 of file ast.h.

Referenced by input_file().

string unitNode::_obj_file [private]
 

The object output file name.

The name of the object file generated when using -gccobj

Definition at line 527 of file ast.h.

Referenced by obj_file().

string unitNode::_output_file [private]
 

The output file name.

The name of the output file to which the resulting code is written (only if the -c-code flag is given).

Definition at line 521 of file ast.h.

Referenced by output_file().

int unitNode::_pragma_level [private]
 

Depth for pragmas.

Definition at line 492 of file ast.h.

Referenced by pragma_level().

text_list unitNode::_pragmas [private]
 

Pragmas.

This list will contain any pragmas that belong at the end of the given unitNode. During parsing, they are collected into the CBZ::pragmas list and then placed here in the unitNode::parse.

Definition at line 574 of file ast.h.

Referenced by pragmas().

TREE suespec_list unitNode::_suespecs [private]
 

struct/enum/union contents

During parsing, we maintain a separate, global list of the contents of struct/enum/union definitions. The reason is that this avoids the problem of which declaration "owns" the content definition. Instead, all uses of the s/u/e type simply refer to one of the elements of this list.

Definition at line 559 of file ast.h.

Referenced by suespecs().

int unitNode::_symbol_level [private]
 

Depth of the scope.

Definition at line 484 of file ast.h.

Referenced by symbol_level().

Tags_table* unitNode::_tags [private]
 

Table of struct/union tags.

Definition at line 508 of file ast.h.

Referenced by tags().

Identifiers_table* unitNode::_types [private]
 

Table of type names.

Definition at line 500 of file ast.h.

Referenced by types().

TREE decl_list unitNode::_undef_funcs [private]
 

Undeclared functions.

This list will contain a function declaration for any functions not explicitly declared in the source.

Definition at line 546 of file ast.h.

Referenced by undef_funcs().

int unitNode::_warnings [private]
 

The number of warnings.

The number of warnings encountered during parsing.

Definition at line 539 of file ast.h.

Referenced by inc_warnings(), and warnings().

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