C-Breeze
C Compiler Infrastructure

[ Project home page]
Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

metastmtNode Class Reference
[The AST nodes]

Meta-variable statement node, for use in lexer. More...

#include <meta.h>

Inheritance diagram for metastmtNode:

stmtNode metaVariable Node List of all members.

Garbage collection.

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

Public Member Functions

 metastmtNode (idNode *id)
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.

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

virtual Nodeclone () const
 Clone the input node.

virtual void output_stmt (output_context &ct, Node *par)
 Output a statement.

virtual void output (output_context &ct, Node *par)
 Generate C code.

void output_comment (output_context &ct)
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.

string & name ()
Accessors
Methods to get and set fields in the class.

string & comment ()
FlowValat_exit () const
void at_exit (FlowVal *ae)
text_listpragmas ()
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

bool is_meta_stmt (char *name)
 Call this to identify meta variables of type stmt (in the lexer).

void add_meta_stmt (char *name)
 Call this method when you recognize a macro formal argument of type $stmt (in the parser).

void clear ()
 Call this method to clear the list of recognized macro variables (e.g., at the end of a macro definition.

void report ()
 Report node count statistics.


Static Private Attributes

list< string > meta_stmt_variables
 Meta-statement list.


Detailed Description

Meta-variable statement node, for use in lexer.

Definition at line 125 of file meta.h.


Constructor & Destructor Documentation

metastmtNode::metastmtNode idNode   id [inline]
 

Definition at line 153 of file meta.h.

References Node::coord(), Meta, and metaVariable::name().

Referenced by clone().


Member Function Documentation

void metastmtNode::add_meta_stmt char *    name [static]
 

Call this method when you recognize a macro formal argument of type $stmt (in the parser).

Definition at line 154 of file meta.cc.

References meta_stmt_variables.

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 276 of file ast.h.

References annote_list.

void stmtNode::at_exit FlowVal   ae [inline, inherited]
 

Reimplemented in basicblockNode.

Definition at line 4373 of file ast.h.

FlowVal* stmtNode::at_exit   const [inline, inherited]
 

Reimplemented in basicblockNode.

Definition at line 4372 of file ast.h.

Referenced by init_flowproblem_walker::at_stmt(), whileNode::dataflow(), switchNode::dataflow(), returnNode::dataflow(), forNode::dataflow(), doNode::dataflow(), and breakNode::dataflow().

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.

Definition at line 152 of file node.cc.

Referenced by Node::datatype(), and Node::datatype_superior().

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

Definition at line 189 of file meta.cc.

References Changer::at_stmt(), Changer::Both, Node::change(), Changer::order(), Changer::Order, Changer::Postorder, and Changer::Preorder.

void metastmtNode::clear   [static]
 

Call this method to clear the list of recognized macro variables (e.g., at the end of a macro definition.

Definition at line 159 of file meta.cc.

References meta_stmt_variables.

virtual Node* metastmtNode::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 172 of file meta.h.

References metastmtNode().

string& stmtNode::comment   [inline, inherited]
 

Definition at line 4368 of file ast.h.

Referenced by DefUseWalker::at_basicblock(), reachingGenKillWalker::at_proc(), copyPropChanger::at_proc(), deadcodeChanger::at_threeAddr(), LivenessComments::comment_stmt(), loopTree::depthFirstSearch(), loopTree::findBody(), stmtNode::output_comment(), and Dominators::print().

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 245 of file ast.h.

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 232 of file ast.h.

Referenced by funcNode::add_parameter_types(), Unify_Structure::all_str(), Pointers::analyze_procedure(), semcheck_expr_visitor::at_binary(), id_lookup_walker::at_binary(), ExpressionDismantle::at_binary(), ArrowDismantle::at_binary(), SelectionDismantle::at_binary(), set_container_walker::at_break(), BreakContinueChanger::at_break(), UnificationBasedPtr::at_call(), semcheck_expr_visitor::at_call(), NodeLocator::at_call(), id_lookup_walker::at_call(), ExpressionDismantle::at_call(), set_container_walker::at_case(), constantsChanger::at_conditiongoto(), set_container_walker::at_continue(), BreakContinueChanger::at_continue(), NodeLocator::at_decl(), id_lookup_walker::at_decl(), InitializerDismantle::at_decl(), LoopDismantle::at_do(), enum_value_walker::at_enum(), NodeLocator::at_expr(), ExpressionDismantle::at_exprstmt(), LoopDismantle::at_for(), goto_label_walker::at_goto(), Linker::at_id(), id_lookup_walker::at_id(), SelectionDismantle::at_if(), goto_label_walker::at_label(), id_lookup_walker::at_proc(), ReturnDismantle::at_proc(), ReturnDismantle::at_return(), NodeLocator::at_stmt(), UnificationBasedPtr::at_suespec(), semcheck_walker::at_suespec(), SelectionDismantle::at_switch(), TernaryDismantle::at_ternary(), SizeofChanger::at_threeAddr(), AllocSizeChanger::at_unary(), ExpressionDismantle::at_unary(), LoopDismantle::at_while(), Pointers::call_operator(), semcheck_expr_visitor::check_binary(), semcheck_expr_visitor::check_unary(), UnificationBasedPtr::compatible_type(), procNode::define(), exprstmtNode::exprstmtNode(), typeNode::finish(), InitializerDismantle::init_array(), InitializerDismantle::init_scalar(), InitializerDismantle::init_struct(), function_inline::inliner(), exprNode::integral_promotions(), UnificationBasedPtr::make_compatible(), reachingDefinitionsWalker::make_ud_chains(), Unify_Structure::map_str(), primNode::merge_in(), metaexprNode::metaexprNode(), metastmtNode(), vcgCCGWalker::node_label(), vcgASTWalker::node_label(), vcgCCGWalker::node_title(), vcgASTWalker::node_title(), DismantleUtil::Not(), Externals_table::notify_exit_scope(), Labels_table::notify_exit_scope(), Identifiers_table::notify_exit_scope(), Pointers::pass_parameters(), vcgCCGWalker::print_edge(), vcgASTWalker::print_edge(), vcgCCGWalker::print_node(), vcgASTWalker::print_node(), stmtLocation::print_path(), procNode::procNode(), NodeInfo::readCall(), NodeInfo::readDecl(), NodeInfo::readExprOrStmt(), NodeInfo::readsuef(), Pointers::record_external_inputs_and_outputs(), P::run(), Tags_table::shadow(), Identifiers_table::shadow(), memoryBlock::top_most_containers(), suespecNode::update(), exprNode::usual_arithmetic_conversions(), CBZ::WarnAboutPrecedence(), NodeInfo::writeDecl(), NodeInfo::writeExpr(), NodeInfo::writeProc(), NodeInfo::writeStmt(), and NodeInfo::writeType().

void metastmtNode::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.

Definition at line 213 of file meta.cc.

References FlowProblem::flow_stmt(), and FlowProblem::forward().

typeNode * Node::datatype   const [inherited]
 

Call base_type() with the argument true.

Definition at line 157 of file node.cc.

References Node::base_type().

Referenced by funcNode::is_void_args().

typeNode * Node::datatype_superior   const [inherited]
 

Call base_type() with the argument false.

Definition at line 162 of file node.cc.

References Node::base_type().

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 299 of file ast.h.

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 286 of file ast.h.

bool metastmtNode::is_meta_stmt char *    name [static]
 

Call this to identify meta variables of type stmt (in the lexer).

Definition at line 148 of file meta.cc.

References meta_stmt_variables.

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 322 of file ast.h.

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 309 of file ast.h.

string& metaVariable::name   [inline, inherited]
 

Definition at line 56 of file meta.h.

Referenced by metaexprNode::metaexprNode(), metastmtNode(), metaVariable::metaVariable(), metaexprNode::output_expr(), and output_stmt().

void stmtNode::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.

Definition at line 55 of file stmtnode.cc.

References Block, output_context::new_line(), stmtNode::output_comment(), stmtNode::output_stmt(), and Node::typ().

Referenced by Pointers::analyze_procedure(), deadcodeChanger::at_threeAddr(), procedureInfo::block_position(), procNode::output(), whileNode::output_stmt(), switchNode::output_stmt(), loopTreeNode::output_stmt(), labelNode::output_stmt(), ifNode::output_stmt(), forNode::output_stmt(), doNode::output_stmt(), caseNode::output_stmt(), precisionAnalyzer::record(), and precisionAnalyzer::report().

void stmtNode::output_comment output_context   ct [inherited]
 

Definition at line 65 of file stmtnode.cc.

References stmtNode::comment(), output_context::indent_in(), output_context::indent_out(), and output_context::new_line().

Referenced by stmtNode::output(), and blockNode::output_stmt().

void metastmtNode::output_stmt output_context   ct,
Node   par
[virtual]
 

Output a statement.

Implements stmtNode.

Definition at line 227 of file meta.cc.

References metaVariable::name().

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 264 of file ast.h.

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 252 of file ast.h.

Referenced by exprNode::parens(), and CBZ::WarnAboutPrecedence().

text_list& stmtNode::pragmas   [inline, inherited]
 

Definition at line 4377 of file ast.h.

References text_list.

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.

Definition at line 184 of file node.cc.

References Node::_count, Node::_t_count, Array, Attrib, Binary, Block, Break, Call, Case, Cast, Comma, Const, Continue, Decl, Do, Enum, Expr, For, Func, Goto, Id, If, Initializer, Label, Prim, Proc, Ptr, Return, Struct, sueSpec, Switch, Tdef, Ternary, Text, Unary, Undeclared, Union, and While.

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 218 of file ast.h.

References NodeType.

Referenced by declNode::add_parameter_types(), Pointers::analyze_procedure(), SSA::assignment(), Pointers::assignment_operator(), Assignment_walker::at_binary(), semcheck_expr_visitor::at_binary(), id_lookup_walker::at_binary(), ExpressionDismantle::at_binary(), constantAnalyzer::at_binary(), UnificationBasedPtr::at_call(), TreeChecker::at_call(), semcheck_expr_visitor::at_call(), NodeLocator::at_call(), Linker::at_call(), id_lookup_walker::at_call(), ExpressionDismantle::at_call(), ExpressionDismantle::at_cast(), constantAnalyzer::at_cast(), ExpressionDismantle::at_comma(), constantFoldingChanger::at_conditiongoto(), constantPropChanger::at_conditiongoto(), constantAnalyzer::at_const(), vcgASTWalker::at_decl(), UnificationBasedPtr::at_decl(), name_mangle_walker::at_decl(), AllocToMemWalker::at_decl(), id_lookup_walker::at_decl(), InitializerDismantle::at_decl(), remove_stale_type_walker::at_expr(), NodeLocator::at_expr(), constantPropChanger::at_expr(), FlattenDismantle::at_goto(), Linker::at_id(), callGraph::at_id(), CFS_Changer::at_if(), UnificationBasedPtr::at_initializer(), TreeChecker::at_label(), FlattenDismantle::at_label(), UnificationBasedPtr::at_proc(), LivenessWalker::at_proc(), FlattenDismantle::at_proc(), DefUseWalker::at_proc(), cfg_changer::at_proc(), unreachableCodeRemover::at_proc(), TreeChecker::at_return(), constantAnalyzer::at_sizeof(), NodeLocator::at_stmt(), print_walker::at_sue(), print_tree_visitor::at_sue(), vcgCCGWalker::at_threeAddr(), Linker::at_threeAddr(), identify_inlinees::at_threeAddr(), function_inline::at_threeAddr(), W::at_type(), ExpressionDismantle::at_unary(), fixPointerWalker::at_unary(), constantAnalyzer::at_unary(), callNode::base_type(), NodeInfo::canonical(), ipConstant::cast_operator(), semcheck_expr_visitor::check_binary(), semcheck_expr_visitor::check_unary(), UnificationBasedPtr::compatible_type(), memoryModel::create_memory_object(), UnificationBasedPtr::create_synthetic_proc(), NodeInfo::def_type(), gcWalker::delete_nodes(), Pointers::determine_call_targets(), DFPreds::DFPreds(), DominanceFrontiers::DominanceFrontiers(), memoryBlock::dot(), Pointers::dot_operator(), UnificationBasedPtr::ecr1(), typeNode::equal_to(), Pointers::eval(), castNode::eval(), typeNode::finish(), typeNode::follow_tdefs(), memoryModel::generate_array_elements_for(), DefUseWalker::get_def(), DefUseWalker::get_uses(), Register::getRegRetVal(), NodeInfo::getType(), memoryModel::initialize_struct(), function_inline::inliner(), typeNode::integral_promotions(), exprNode::integral_promotions(), labelNode::is_undeclared(), UnificationBasedPtr::is_va_list(), Pointers::is_va_list(), SSA::lhs(), Linker::link(), lir_gen_walker::load_global_value(), lir_gen_walker::load_stack_value(), LocalCopyPropChanger::local_copy_prop(), memoryModel::lookup_variable(), arch_info::make_template_replacements(), reachingDefinitionsWalker::make_ud_chains(), SSA::need_ssa(), vcgCCGWalker::node_label(), vcgCCGWalker::node_name(), vcgASTWalker::node_name(), vcgCCGWalker::node_title(), NodeInfo::nodeIndex(), operandNode::noncast_type(), DismantleUtil::Not(), Externals_table::notify_exit_scope(), Identifiers_table::notify_exit_scope(), stmtNode::output(), operandNode::output_expr(), blockNode::output_stmt(), sueNode::output_type(), ptrNode::output_type(), Pointers::pass_parameters(), SSA::phi(), SSA::place_one_phi(), vcgASTWalker::print_edge(), vcgCCGWalker::print_node(), vcgASTWalker::print_node(), procedureInfo::procedureInfo(), procNode::procNode(), LocalCopyPropChanger::prop(), LocalCopyPropChanger::prop_expr(), arrayNode::qualified_equal_to(), NodeInfo::readCall(), NodeInfo::readDecl(), NodeInfo::readExprOrStmt(), NodeInfo::readProc(), NodeInfo::readsuef(), NodeInfo::readType(), Unreachable::remove(), P::run(), dfpreds_phase::run(), ssa_phase::run(), pointers_phase::run(), SSA::search(), sueNode::set_name_fields(), Register::setType(), Unify_Size::sizeOf(), Unify_Size::sizeOfAssign(), SSA::SSA(), Pointers::star_operator(), lir_gen_walker::store_global(), lir_gen_walker::store_stack(), Pointers::struct_union_assignment(), blockNode::toBlock(), memoryBlock::top_most_containers(), P::type_name(), NodeInfo::type_name(), Unify_ECR::Unify_ECR(), typeNode::unwind_tdefs(), suespecNode::update(), typeNode::usual_arithmetic_conversions(), exprNode::usual_arithmetic_conversions(), binaryNode::walk(), CBZ::WarnAboutPrecedence(), NodeInfo::writeCall(), NodeInfo::writeExpr(), NodeInfo::writeProc(), NodeInfo::writeStmt(), and NodeInfo::writeType().

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 344 of file ast.h.

Referenced by tree_visitor::at_block(), ReturnDismantle::at_return(), asm_gen_walker::doCallerSave(), and briggs_reg_alloc::interfere().

void metastmtNode::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.

Definition at line 167 of file meta.cc.

References Visitor::at_stmt().

void metastmtNode::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.

Definition at line 173 of file meta.cc.

References Walker::at_stmt(), Walker::Both, Walker::depth(), Walker::order(), Walker::Order, Walker::Postorder, Walker::Preorder, and Walker::Subtree.


Member Data Documentation

map< Node *, bool > Node::deleted_nodes [static, inherited]
 

Definition at line 116 of file node.cc.

Referenced by gcWalker::delete_nodes(), and Node::~Node().

bool Node::mark [inherited]
 

Definition at line 170 of file ast.h.

Referenced by gcWalker::at_binary(), gcWalker::at_node(), gcWalker::delete_nodes(), and SymbolTable< T >::mark_nodes().

list< string > metastmtNode::meta_stmt_variables [static, private]
 

Meta-statement list.

Definition at line 43 of file meta.cc.

Referenced by add_meta_stmt(), clear(), and is_meta_stmt().

node_list Node::nodes [static, inherited]
 

Definition at line 115 of file node.cc.

Referenced by gcWalker::delete_nodes(), gcWalker::gcWalker(), and Node::Node().


The documentation for this class was generated from the following files:

Generated on August 27, 2003
Back to the C-Breeze home page