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

subdeclNode Class Reference
[The AST nodes]

Indexed declaration. More...

#include <ast.h>

Inheritance diagram for subdeclNode:

declNode defNode Node List of all members.

Garbage collection.

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

Public Types

enum  Decl_location {
  UNKNOWN, TOP, BLOCK, FORMAL,
  SU, ENUM, PROC
}
 Declaration location. More...
enum  Storage_class {
  NONE, AUTO, EXTERN, REGISTER,
  STATIC, TYPEDEF
}
 Storage class specifier. More...

Public Member Functions

 subdeclNode (declNode *orig, int index)
 Create a sub-declaration.
virtual ~subdeclNode ()
 Destroy a subdeclNode.
string name_with_index ()
 Get the name with index.
virtual Node * clone () const
 Clone the input node.
virtual void output (output_context &ct, Node *par)
 Generate C code.
typeNode * base_type (bool TdefIndir) const
 Return the base data type of a node.
typeNode * no_tdef_type ()
 Return the type.
virtual void dataflow (FlowVal *v, FlowProblem &fp)
 Run the dataflow analyzer.
virtual void grab_pragmas (void)
 Attaches pragmas to this defNode.
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.

virtual declNode * original ()
 SSA original declaration.
int index () const
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 Node * change (Changer &the_changer, bool redispatch=false)
 Dispatch a Changer.
Accessors
Methods to get and set fields in the class.

typeNode * type () const
 Return this declNode's base C data type.
void type (typeNode *the_type)
 Set this declNode's base C data type.
typeNode * get_type ()
 Return this declNode's base C data type, and set the base C data type to be empty.
string & name ()
 Return the name of the variable declared by this declNode.
void name (string name)
 Set the name of the variable declared by this declNode.
Decl_location decl_location () const
 Return a Decl_location indicating the syntactic context in which this declaration occured.
void decl_location (Decl_location loc)
 Set the syntactic context in which this declaration occured.
Storage_class storage_class () const
 Return the storage class of the variable declared by this declNode.
void storage_class (Storage_class sc)
 Set the storage class of the variable declared by this declNode.
bool is_redundant_extern () const
 Return true iff this declaration is a redundant extern declaration.
void set_redundant_extern (bool v)
 Set whether this declaration is a redundant extern declaration.
void inc_references ()
 Increment the number of identifier nodes that point to this declaration.
exprNode * init () const
 Return the AST used to initialize the variable declared by this declNode.
void init (exprNode *init)
 Define the AST node used to initialize the variable declared by this declNode.
exprNode * bitsize () const
 Return this Node's bitsize.
void bitsize (exprNode *bitsize)
 Define the bitsize for this declNode.
int references () const
 Return the number of idNodes that point to this declaration.
void references (int references)
 Set the number of idNodes that point to this declaration.
id_list & ref_list ()
const id_list & ref_list () const
attrib_list & attribs ()
 Return a mutable reference to this declaration's attribute list.
const attrib_list & attribs () const
 Return an immutable reference to this declaration's attribute list.
void merge_attribs (attrib_list *attribs)
 Add each attribute in the given attribute list to this declNode's attribute list.
Parser methods
void set_type (typeNode *the_type, Storage_class sc, ScopeState redeclare)
declNode * set_type_and (typeNode *the_type, Storage_class sc, ScopeState redeclare)
declNode * set_type_and (declNode *the_decltype, Storage_class sc, ScopeState redeclare)
void inherit_type (decl_list *others, ScopeState redeclare)
declNode * inherit_type_and (decl_list *others, ScopeState redeclare)
void modify_type (typeNode *the_type)
declNode * modify_type_and (typeNode *the_type)
declNode * modify_type_and (declNode *the_type)
void set_init (exprNode *init)
declNode * set_init_and (exprNode *init)
void add_parameter_types (decl_list *types)
declNode * add_parameter_types_and (decl_list *types)
void finish (Storage_class sc)
declNode * finish_and (Storage_class sc)
Accessors
Methods to get and set fields in the class.

text_list & pragmas ()
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 void report ()
 Report node count statistics.
Output methods.
Actual Storage Type

These two methods are used when generating C code to convert the Storage_class and Decl_location values into strings.

static string storage_class_name (Storage_class sc)
 Return a string value containing the C code for this Declaration's storage class.
static string decl_location_name (Decl_location dl)
 Return a string value containing the C code for this Declaration's location.

Private Attributes

REF declNode * _original
int _index

Detailed Description

Indexed declaration.

Subclass of declNode used to create derived indexed declarations. It is currently only used in the SSA pass, which creates a series of indexed version of each variable. A subdeclNode consists of a base declaration and a subscript. For example, the indexed declaration for $x_1$ has the declaration for x as it base and has a subscript of 1. Sometimes, the subdeclNode's base is also refered to as its "original" declaration. The subdeclNode's subscript is also called its version or its index.

The NodeType is Decl.

Definition at line 1239 of file ast.h.

Member Enumeration Documentation

enum declNode::Decl_location [inherited]
 

Declaration location.

This type is used to record some syntactic context information about the declaration. This information is computed by the id_lookup_walker.

See also:
id_lookup_walker
Enumeration values:
UNKNOWN  No context provided
TOP  A top-level declaration (either a global variable or a function declaration).
BLOCK  A regular local variable declared inside a function body.
FORMAL  A formal argument declared in the function interface.
SU  A struct/union field declaration.
ENUM  An element of an enum declaration.
PROC  A function declaration that has the function definition.

Definition at line 790 of file ast.h.

enum declNode::Storage_class [inherited]
 

Storage class specifier.

This type indicates any storage class information associated with the declaration. It is overloaded to also indicate when a declaration is a typedef.

Enumeration values:
NONE 
AUTO 
EXTERN 
REGISTER 
STATIC 
TYPEDEF 

Definition at line 807 of file ast.h.

Constructor & Destructor Documentation

subdeclNode::subdeclNode (  declNode *  orig,
int  index
) 
 

Create a sub-declaration.

This constructor creates a new sub-declaration of the given input declaration. The index indicates which version (or subscript) to associate with the sub-declaration.

Parameters:
orig the original declaration from which this subdeclaration is derived
index the index of the new sub-declaration

Referenced by clone().

virtual subdeclNode::~subdeclNode (   )  [virtual]
 

Destroy a subdeclNode.

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

Member Function Documentation

void declNode::add_parameter_types (  decl_list *  types  )  [inherited]
 

declNode* declNode::add_parameter_types_and (  decl_list *  types  )  [inherited]
 

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.

const attrib_list& declNode::attribs (   )  const [inline, inherited]
 

Return an immutable reference to this declaration's attribute list.

Definition at line 1108 of file ast.h.

References declNode::_attribs.

attrib_list& declNode::attribs (   )  [inline, inherited]
 

Return a mutable reference to this declaration's attribute list.

Definition at line 1103 of file ast.h.

References declNode::_attribs.

Referenced by tree_visitor::at_decl().

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

void declNode::bitsize (  exprNode *  bitsize  )  [inline, inherited]
 

Define the bitsize for this declNode.

To set the bitsize of this declNode to be empty, call this method with a value of NULL.

Definition at line 1085 of file ast.h.

References declNode::_bitsize.

exprNode* declNode::bitsize (   )  const [inline, inherited]
 

Return this Node's bitsize.

Definition at line 1078 of file ast.h.

References declNode::_bitsize.

Referenced by tree_visitor::at_decl().

virtual Node* subdeclNode::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 declNode.

virtual Node* subdeclNode::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).

Reimplemented from declNode.

Definition at line 1300 of file ast.h.

References subdeclNode().

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 declNode::dataflow (  FlowVal *  v,
FlowProblem &  fp
)  [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).

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.

void declNode::decl_location (  Decl_location  loc  )  [inline, inherited]
 

Set the syntactic context in which this declaration occured.

Definition at line 1033 of file ast.h.

References declNode::_decl_location.

Decl_location declNode::decl_location (   )  const [inline, inherited]
 

Return a Decl_location indicating the syntactic context in which this declaration occured.

Definition at line 1028 of file ast.h.

References declNode::_decl_location.

static string declNode::decl_location_name (  Decl_location  dl  )  [static, inherited]
 

Return a string value containing the C code for this Declaration's location.

void declNode::finish (  Storage_class  sc  )  [inherited]
 

declNode* declNode::finish_and (  Storage_class  sc  )  [inherited]
 

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* declNode::get_type (   )  [inline, inherited]
 

Return this declNode's base C data type, and set the base C data type to be empty.

Definition at line 1006 of file ast.h.

References declNode::_type.

virtual void defNode::grab_pragmas (  void   )  [virtual, inherited]
 

Attaches pragmas to this defNode.

Used by parser to attach the current pragmas to a defNode.

void declNode::inc_references (   )  [inline, inherited]
 

Increment the number of identifier nodes that point to this declaration.

Definition at line 1061 of file ast.h.

References declNode::_references.

int subdeclNode::index (   )  const [inline]
 

Definition at line 1273 of file ast.h.

References _index.

void declNode::inherit_type (  decl_list *  others,
ScopeState  redeclare
)  [inherited]
 

declNode* declNode::inherit_type_and (  decl_list *  others,
ScopeState  redeclare
)  [inherited]
 

void declNode::init (  exprNode *  init  )  [inline, inherited]
 

Define the AST node used to initialize the variable declared by this declNode.

To set the initializer of this declNode to be empty, call this method with a value of NULL.

Definition at line 1074 of file ast.h.

References declNode::_init.

exprNode* declNode::init (   )  const [inline, inherited]
 

Return the AST used to initialize the variable declared by this declNode.

Definition at line 1066 of file ast.h.

References declNode::_init.

Referenced by tree_visitor::at_decl().

bool declNode::is_redundant_extern (   )  const [inline, inherited]
 

Return true iff this declaration is a redundant extern declaration.

Redundant extern declarations are allowed in C.

Definition at line 1051 of file ast.h.

References declNode::_is_redundant_extern.

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 declNode::merge_attribs (  attrib_list *  attribs  )  [inherited]
 

Add each attribute in the given attribute list to this declNode's attribute list.

void declNode::modify_type (  typeNode *  the_type  )  [inherited]
 

declNode* declNode::modify_type_and (  declNode *  the_type  )  [inherited]
 

declNode* declNode::modify_type_and (  typeNode *  the_type  )  [inherited]
 

void declNode::name (  string  name  )  [inline, inherited]
 

Set the name of the variable declared by this declNode.

Definition at line 1023 of file ast.h.

References declNode::_name.

string& declNode::name (   )  [inline, inherited]
 

Return the name of the variable declared by this declNode.

Definition at line 1018 of file ast.h.

References declNode::_name.

string subdeclNode::name_with_index (   ) 
 

Get the name with index.

This method returns the name of the declaration, with its index appended. For example, when this method is called on the subdeclaration for $x_1$ , the string "x@1" will be returned.

Returns:
the name with the index appended

typeNode* declNode::no_tdef_type (   )  [inherited]
 

Return the type.

Return the type after following any typedefs to the real type.

Returns:
the type

virtual declNode* subdeclNode::original (   )  [inline, virtual]
 

SSA original declaration.

For use with subdeclNode when the code is in SSA form. This method returns the original declaration from which the sub-declaration was derived.

Returns:
the original declaration

Reimplemented from declNode.

Definition at line 1272 of file ast.h.

References _original, and declNode::original().

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

Reimplemented from declNode.

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.

text_list& defNode::pragmas (   )  [inline, inherited]
 

Definition at line 749 of file ast.h.

References defNode::_pragmas.

const id_list& declNode::ref_list (   )  const [inline, inherited]
 

Definition at line 1098 of file ast.h.

References declNode::_ref_list.

id_list& declNode::ref_list (   )  [inline, inherited]
 

Definition at line 1097 of file ast.h.

References declNode::_ref_list.

Referenced by ref_clone_changer::at_decl().

void declNode::references (  int  references  )  [inline, inherited]
 

Set the number of idNodes that point to this declaration.

Definition at line 1095 of file ast.h.

References declNode::_references.

int declNode::references (   )  const [inline, inherited]
 

Return the number of idNodes that point to this declaration.

Definition at line 1090 of file ast.h.

References declNode::_references.

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 declNode::set_init (  exprNode *  init  )  [inherited]
 

declNode* declNode::set_init_and (  exprNode *  init  )  [inherited]
 

void declNode::set_redundant_extern (  bool  v  )  [inline, inherited]
 

Set whether this declaration is a redundant extern declaration.

Definition at line 1056 of file ast.h.

References declNode::_is_redundant_extern.

void declNode::set_type (  typeNode *  the_type,
Storage_class  sc,
ScopeState  redeclare
)  [inherited]
 

declNode* declNode::set_type_and (  declNode *  the_decltype,
Storage_class  sc,
ScopeState  redeclare
)  [inherited]
 

declNode* declNode::set_type_and (  typeNode *  the_type,
Storage_class  sc,
ScopeState  redeclare
)  [inherited]
 

void declNode::storage_class (  Storage_class  sc  )  [inline, inherited]
 

Set the storage class of the variable declared by this declNode.

Definition at line 1043 of file ast.h.

References declNode::_storage_class.

Storage_class declNode::storage_class (   )  const [inline, inherited]
 

Return the storage class of the variable declared by this declNode.

Definition at line 1038 of file ast.h.

References declNode::_storage_class.

Referenced by has_struct_walker::at_decl().

static string declNode::storage_class_name (  Storage_class  sc  )  [static, inherited]
 

Return a string value containing the C code for this Declaration's storage class.

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

void declNode::type (  typeNode *  the_type  )  [inline, inherited]
 

Set this declNode's base C data type.

To set the data type to be empty, call this method with a value of NULL.

Definition at line 1013 of file ast.h.

References declNode::_type.

typeNode* declNode::type (   )  const [inline, virtual, inherited]
 

Return this declNode's base C data type.

Reimplemented from Node.

Definition at line 1000 of file ast.h.

References declNode::_type.

Referenced by tree_visitor::at_decl().

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

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

Member Data Documentation

int subdeclNode::_index [private]
 

Definition at line 1244 of file ast.h.

Referenced by index().

REF declNode* subdeclNode::_original [private]
 

Definition at line 1243 of file ast.h.

Referenced by original().

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