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

idNode Class Reference

Identifier. More...

#include <ast.h>

Inheritance diagram for idNode::

exprNode Node List of all members.

Public Methods

 idNode (const char *text, const Coord coord=Coord::Unknown)
 Create a new identfier. More...

 idNode (declNode *the_decl, const Coord coord=Coord::Unknown)
 Create an identifier with a declaration. More...

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

typeNodebase_type (bool TdefIndir) const
 Return the base data type of a node. More...

virtual void eval ()
 Constant expression evaluator. More...

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

virtual Nodeclone () const
 Clone the input node. More...

virtual void output_expr (output_context &ct, Node *par, int prec, Assoc assoc)
 Output a expression. More...

Accessors
Methods to get and set fields in the class.

string & name ()
const string & name () const
void name (string nm)
declNodedecl () const
void decl (declNode *decl)
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 Nodechange (Changer &the_changer, bool redispatch=false)
 Dispatch a Changer. More...


Private Attributes

string _name
 the name. More...

REF declNode_decl
 the declaration. More...


Detailed Description

Identifier.

This class represents identifiers in the code. Each identifier has a name, and a reference to a declaration. Initially, the reference is empty, but can be populated using id_lookup_walker.

The NodeType is Id.

See also:
id_lookup_walker


Constructor & Destructor Documentation

idNode::idNode const char *    text,
const Coord    coord = Coord::Unknown
 

Create a new identfier.

The new identifier has the given name, which is copies, and not deleted.

Parameters:
text  the name of the identifier (copied; not deleted)
coord  the location of the construct in the source file.

idNode::idNode declNode   the_decl,
const Coord    coord = Coord::Unknown
 

Create an identifier with a declaration.

This constructor allows you to specify the associated declaration explicitly. The name of the identifier is copied from the declaration.

Parameters:
the_decl  the declaration to refer to
coord  the location of the construct in the source file.

idNode::~idNode   [virtual]
 

Destroy a idNode.

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


Member Function Documentation

typeNode * idNode::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 exprNode.

Node * idNode::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* idNode::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 idNode::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 idNode::decl declNode   decl [inline]
 

declNode* idNode::decl   const [inline]
 

void idNode::eval   [virtual]
 

Constant expression evaluator.

This method attempts to evaluate an expression at compile-time. This only yields a meaningful value when the leaves of the given expression are constants, enums, or other compile-time values (e.g., sizeof). The resulting value is stored on each exprNode, in the _value field. Each exprNode sublcass implements this method, calling it recursively when necessary.

Reimplemented from exprNode.

void idNode::name string    nm [inline]
 

const string& idNode::name   const [inline]
 

string& idNode::name   [inline]
 

void idNode::output_expr output_context   ct,
Node   parent,
int    prec,
Assoc    assoc
[virtual]
 

Output a expression.

Reimplemented from exprNode.

void idNode::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 idNode::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

REF declNode* idNode::_decl [private]
 

the declaration.

The declaration to which this identifier refers. Use the id_lookup_walker to compute the declarations of all identifiers.

See also:
id_lookup_walker

string idNode::_name [private]
 

the name.

The name of the identifier


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