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

operandNode Class Reference
[The AST nodes]

Operand of an expression. More...

#include <ast.h>

Inheritance diagram for operandNode:

exprNode Node List of all members.

Garbage collection.

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

Public Member Functions

 operandNode (indexNode *the_var, const Coord coord=Coord::Unknown)
 operandNode (indexNode *the_var, bool star, bool addr, const Coord coord=Coord::Unknown)
 operandNode (indexNode *the_var, bool star, bool addr, id_list *fields, indexNode *array_index, const Coord coord=Coord::Unknown)
void addr (bool addr)
bool addr () const
void star (bool star)
bool star () const
void cast (typeNode *cast)
typeNode * cast (void)
const typeNode * cast (void) const
id_list & fields ()
const id_list & fields () const
void index (indexNode *index)
indexNode * index (void)
const indexNode * index (void) const
void var (indexNode *var)
indexNode * var (void)
const indexNode * var (void) const
virtual typeNode * type () const
 Return the node data type.
virtual void type (typeNode *)
virtual typeNode * noncast_type (bool convertArrays=true) const
virtual void eval ()
 Constant expression evaluator.
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.
virtual void dataflow (FlowVal *v, FlowProblem &fp)
 Run the dataflow analyzer.
virtual Node * clone () const
 Clone the input node.
virtual void output_expr (output_context &ct, Node *parent, int prec, Assoc assoc)
 Output a expression.
virtual typeNode * base_type (bool TdefIndir) const
 Return the base data type of a node.
virtual bool is_lvalue ()
 Is l-value.
typeNode * no_tdef_type ()
virtual void output (output_context &ct, Node *par)
 Generate C code.
virtual int precedence (Assoc &assoc)
 Associativity and precedence.
bool parens (int outer_prec, Assoc outer_assoc)
 Determine if parenthesis are needed.
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.

typeNode * get_type ()
const constant & value () const
constant & value ()
void value (const constant &newval)
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 exprNode * integral_promotions (exprNode *old_expr)
 Add integral promotions.
static pair< exprNode *, exprNode * > usual_arithmetic_conversions (exprNode *left, exprNode *right)
 Usual arithmetic conversions.
static void report ()
 Report node count statistics.

Private Attributes

bool _star
bool _addr
typeNode * _cast
indexNode * _var
id_list _fields
indexNode * _index

Detailed Description

Operand of an expression.

The role of operandNode is to represent a memory location or address. An operandNode represents a simple variable or constant when only the var field is set. Otherwise, it represents a memory location (or the address of a memory location) that can be loaded in a single instruction. This latter case assumes that the base address of the var field is already loaded into a register and the offset is either constant or already computed. In a grammatical sense, we can view an {operandNode} by the following rules:

operand -> [typecast] [&] (* var) {.field}* [[index]] -> [typecast] [&] var {.field}* [[index]]

The NodeType is the type of the operand expression, or, if there is a cast in the expression, the type is the cast type.

Definition at line 6040 of file ast.h.

Constructor & Destructor Documentation

operandNode::operandNode (  indexNode *  the_var,
const Coord  coord = Coord::Unknown
) 
 

Referenced by clone().

operandNode::operandNode (  indexNode *  the_var,
bool  star,
bool  addr,
const Coord  coord = Coord::Unknown
) 
 

operandNode::operandNode (  indexNode *  the_var,
bool  star,
bool  addr,
id_list *  fields,
indexNode *  array_index,
const Coord  coord = Coord::Unknown
) 
 

Member Function Documentation

bool operandNode::addr (   )  const [inline]
 

Definition at line 6056 of file ast.h.

References _addr.

void operandNode::addr (  bool  addr  )  [inline]
 

Definition at line 6055 of file ast.h.

References _addr.

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* exprNode::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 from Node.

Reimplemented in idNode, commaNode, and callNode.

const typeNode* operandNode::cast (  void   )  const [inline]
 

Definition at line 6061 of file ast.h.

References _cast.

typeNode* operandNode::cast (  void   )  [inline]
 

Definition at line 6060 of file ast.h.

References _cast.

void operandNode::cast (  typeNode *  cast  )  [inline]
 

Definition at line 6059 of file ast.h.

References _cast.

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

References operandNode().

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

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

Implements exprNode.

const id_list& operandNode::fields (   )  const [inline]
 

Definition at line 6063 of file ast.h.

References _fields.

id_list& operandNode::fields (   )  [inline]
 

Definition at line 6062 of file ast.h.

References _fields.

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.

typeNode* exprNode::get_type (   )  [inline, inherited]
 

Definition at line 3178 of file ast.h.

References exprNode::_type.

const indexNode* operandNode::index (  void   )  const [inline]
 

Definition at line 6066 of file ast.h.

References _index.

indexNode* operandNode::index (  void   )  [inline]
 

Definition at line 6065 of file ast.h.

References _index.

void operandNode::index (  indexNode *  index  )  [inline]
 

Definition at line 6064 of file ast.h.

References _index.

static exprNode* exprNode::integral_promotions (  exprNode *  old_expr  )  [static, inherited]
 

Add integral promotions.

This method takes an expression and calls typeNode::integral_promotions() on its type to determine if any apply. If they do, it inserts an implicit castNode above the input expression that represents this implicit conversion.

See also:
castNode
Parameters:
old_expr the expression to perform integral promotion on
Returns:
the resulting expression, with a cast added if necessary

virtual bool exprNode::is_lvalue (   )  [inline, virtual, inherited]
 

Is l-value.

Indicates if the expression is an l-value (that is, the left side of an assignment).

Todo:
This doesn't work yet.
Returns:
true if the given expression is an l-value

Definition at line 3224 of file ast.h.

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.

typeNode* exprNode::no_tdef_type (   )  [inline, inherited]
 

Definition at line 3226 of file ast.h.

References exprNode::type().

virtual typeNode* operandNode::noncast_type (  bool  convertArrays = true  )  const [virtual]
 

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

virtual void operandNode::output_expr (  output_context &  ct,
Node *  parent,
int  prec,
Assoc  assoc
)  [virtual]
 

Output a expression.

Implements exprNode.

bool exprNode::parens (  int  outer_prec,
Assoc  outer_assoc
)  [inherited]
 

Determine if parenthesis are needed.

This method takes the associativity and precedence values of the enclosing expression and determines if parentheses are needed.

See also:
exprNode::output_expr()

exprNode::precedence()

Parameters:
outer_prec the precedence value of the enclosing expression
outer_assoc the associativity value of the enclosing expression
Returns:
true if parentheses are needed.

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.

virtual int exprNode::precedence (  Assoc &  assoc  )  [virtual, inherited]
 

Associativity and precedence.

Determine the associativity and precedence of the expression. Each exprNode subclass overrides this method to provide the specific results. The default is highest precedence and left-associative.

See also:
exprNode::output_expr()

exprNode::parens()

Parameters:
assoc a reference parameter that is set to the associativity value
Returns:
the precedence value

Reimplemented in binaryNode, unaryNode, castNode, commaNode, and ternaryNode.

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.

bool operandNode::star (   )  const [inline]
 

Definition at line 6058 of file ast.h.

References _star.

void operandNode::star (  bool  star  )  [inline]
 

Definition at line 6057 of file ast.h.

References _star.

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 void operandNode::type (  typeNode *   )  [virtual]
 

Reimplemented from exprNode.

virtual typeNode* operandNode::type (   )  const [virtual]
 

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 from exprNode.

static pair<exprNode *, exprNode *> exprNode::usual_arithmetic_conversions (  exprNode *  left,
exprNode *  right
)  [static, inherited]
 

Usual arithmetic conversions.

This method takes two expressions and adds any casts that are necessary to make them compatible for arithmetic operations. It calls typeNode::usual_arithmetic_conversions(), passing the types of the expressions, to determine when the casts are needed. It inserts implicit castNode objects above the expressions for the casts.

See also:
castNode
Parameters:
left the left-hand expression
right the right-hand expression
Returns:
the left and right expressions, possibly with casts added

void exprNode::value (  const constant &  newval  )  [inline, inherited]
 

Definition at line 3183 of file ast.h.

References exprNode::_value.

constant& exprNode::value (   )  [inline, inherited]
 

Definition at line 3182 of file ast.h.

References exprNode::_value.

const constant& exprNode::value (   )  const [inline, inherited]
 

Definition at line 3181 of file ast.h.

References exprNode::_value.

const indexNode* operandNode::var (  void   )  const [inline]
 

Definition at line 6069 of file ast.h.

References _var.

indexNode* operandNode::var (  void   )  [inline]
 

Definition at line 6068 of file ast.h.

References _var.

void operandNode::var (  indexNode *  var  )  [inline]
 

Definition at line 6067 of file ast.h.

References _var.

virtual void operandNode::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 operandNode::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

bool operandNode::_addr [private]
 

Definition at line 6043 of file ast.h.

Referenced by addr().

typeNode* operandNode::_cast [private]
 

Definition at line 6044 of file ast.h.

Referenced by cast().

id_list operandNode::_fields [private]
 

Definition at line 6046 of file ast.h.

Referenced by fields().

indexNode* operandNode::_index [private]
 

Definition at line 6047 of file ast.h.

Referenced by index().

bool operandNode::_star [private]
 

Definition at line 6042 of file ast.h.

Referenced by star().

indexNode* operandNode::_var [private]
 

Definition at line 6045 of file ast.h.

Referenced by var().

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