---

walker.h

Go to the documentation of this file.

// ----------------------------------------------------------------------
//
//  C-Breeze
//  C Compiler Framework
// 
//  Copyright (c) 2000 University of Texas at Austin
// 
//  Samuel Z. Guyer
//  Daniel A. Jimenez
//  Calvin Lin
// 
//  Permission is hereby granted, free of charge, to any person
//  obtaining a copy of this software and associated documentation
//  files (the "Software"), to deal in the Software without
//  restriction, including without limitation the rights to use, copy,
//  modify, merge, publish, distribute, sublicense, and/or sell copies
//  of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//  
//  The above copyright notice and this permission notice shall be
//  included in all copies or substantial portions of the Software.
//  
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
//  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//  NONINFRINGEMENT.  IN NO EVENT SHALL THE UNIVERSITY OF TEXAS AT
//  AUSTIN BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
//  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
//  OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
//
//  We acknowledge the C-to-C Translator from MIT Laboratory for
//  Computer Science for inspiring parts of the C-Breeze design.
//
// ----------------------------------------------------------------------

#ifndef CBZ_WALKER_H
#define CBZ_WALKER_H

class Walker {

public:

  typedef enum {
    Preorder,     
    Postorder,    
    Both          
  } Order;

  typedef enum {
    Subtree,     
    NodeOnly     
  } Depth;

private:

  Order _order;

  Depth _depth;


public:

  Walker(Order the_order, Depth depth)
    : _order(the_order),
      _depth(depth)
  {}


  inline Order order() const { return _order; }

  inline Depth depth() const { return _depth; }



  virtual void at_node(Node * the_node, Order ord)
     { // Default: do nothing
     }

  virtual void at_unit(unitNode * the_unit, Order ord)
     { at_node(the_unit, ord); }

  virtual void at_def(defNode * the_def, Order ord)
     { at_node(the_def, ord); }

  virtual void at_decl(declNode * the_decl, Order ord)
     { at_def(the_decl, ord); }

  virtual void at_subdecl(subdeclNode * the_subdecl, Order ord)
     { at_decl(the_subdecl, ord); }

  virtual void at_proc(procNode * the_proc, Order ord)
     { at_def(the_proc, ord); }

  virtual void at_type(typeNode * the_type, Order ord)
     { at_node(the_type, ord); }

  virtual void at_prim(primNode * the_prim, Order ord)
     { at_type(the_prim, ord); }

  virtual void at_tdef(tdefNode * the_tdef, Order ord)
     { at_type(the_tdef, ord); }

  virtual void at_ptr(ptrNode * the_ptr, Order ord)
     { at_type(the_ptr, ord); }

  virtual void at_array(arrayNode * the_array, Order ord)
     { at_type(the_array, ord); }

  virtual void at_func(funcNode * the_func, Order ord)
     { at_type(the_func, ord); }

  virtual void at_sue(sueNode * the_sue, Order ord)
     { at_type(the_sue, ord); }

  virtual void at_struct(structNode * the_struct, Order ord)
     { at_sue(the_struct, ord); }

  virtual void at_union(unionNode * the_union, Order ord)
     { at_sue(the_union, ord); }

  virtual void at_enum(enumNode * the_enum, Order ord)
     { at_sue(the_enum, ord); }

  virtual void at_suespec(suespecNode * the_suespec, Order ord)
     { at_type(the_suespec, ord); }

  virtual void at_expr(exprNode * the_expr, Order ord)
     { at_node(the_expr, ord); }

  virtual void at_const(constNode * the_const, Order ord)
     { at_expr(the_const, ord); }

  virtual void at_id(idNode * the_id, Order ord)
     { at_expr(the_id, ord); }

  virtual void at_binary(binaryNode * the_binary, Order ord)
     { at_expr(the_binary, ord); }

  virtual void at_unary(unaryNode * the_unary, Order ord)
     { at_expr(the_unary, ord); }

  virtual void at_cast(castNode * the_cast, Order ord)
     { at_expr(the_cast, ord); }

  virtual void at_comma(commaNode * the_comma, Order ord)
     { at_expr(the_comma, ord); }

  virtual void at_ternary(ternaryNode * the_ternary, Order ord)
     { at_expr(the_ternary, ord); }

  virtual void at_call(callNode * the_call, Order ord)
     { at_expr(the_call, ord); }

  virtual void at_initializer(initializerNode * the_initializer, Order ord)
     { at_expr(the_initializer, ord); }

  virtual void at_stmt(stmtNode * the_stmt, Order ord)
     { at_node(the_stmt, ord); }

  virtual void at_block(blockNode * the_block, Order ord)
     { at_stmt(the_block, ord); }

  virtual void at_basicblock(basicblockNode * the_basicblock, Order ord)
     { at_block(the_basicblock, ord); }

  virtual void at_exprstmt(exprstmtNode * the_exprstmt, Order ord)
     { at_stmt(the_exprstmt, ord); }

  virtual void at_target(targetNode * the_target, Order ord)
     { at_stmt(the_target, ord); }

  virtual void at_label(labelNode * the_label, Order ord)
     { at_target(the_label, ord); }

  virtual void at_case(caseNode * the_case, Order ord)
     { at_target(the_case, ord); }

  virtual void at_selection(selectionNode * the_selection, Order ord)
     { at_stmt(the_selection, ord); }

  virtual void at_if(ifNode * the_if, Order ord)
     { at_selection(the_if, ord); }

  virtual void at_switch(switchNode * the_switch, Order ord)
     { at_selection(the_switch, ord); }

  virtual void at_loop(loopNode * the_loop, Order ord)
     { at_stmt(the_loop, ord); }

  virtual void at_while(whileNode * the_while, Order ord)
     { at_loop(the_while, ord); }

  virtual void at_do(doNode * the_do, Order ord)
     { at_loop(the_do, ord); }

  virtual void at_for(forNode * the_for, Order ord)
     { at_loop(the_for, ord); }

  virtual void at_jump(jumpNode * the_jump, Order ord)
     { at_stmt(the_jump, ord); }

  virtual void at_goto(gotoNode * the_goto, Order ord)
     { at_jump(the_goto, ord); }

  virtual void at_continue(continueNode * the_continue, Order ord)
     { at_jump(the_continue, ord); }

  virtual void at_break(breakNode * the_break, Order ord)
     { at_jump(the_break, ord); }

  virtual void at_return(returnNode * the_return, Order ord)
     { at_jump(the_return, ord); }

  virtual void at_attrib(attribNode * the_attrib, Order ord)
     { at_stmt(the_attrib, ord); }

  virtual void at_text(textNode * the_text, Order ord)
     { at_node(the_text, ord); }


private:

  /* -- Deprecated...

  virtual void at_index(indexNode * the_index, Order ord)
     { at_expr(the_index, ord); }

  virtual void at_implicitcast(implicitcastNode * the_implicitcast, Order ord)
     { at_expr(the_implicitcast, ord); }

  virtual void at_default(defaultNode * the_default, Order ord)
     { at_target(the_default, ord); }

  virtual void at_ifelse(ifelseNode * the_ifelse, Order ord)
     { at_selection(the_ifelse, ord); }

  */
};

// -- Invoke the walker on a list...

template< class T >
void list_walker(list< T > & l, Walker & the_walker)
{
  for (list< T >::iterator p = l.begin();
       p != l.end();
       ++p)
    (*p)->walk(the_walker);
}


#endif // CBZ_WALKER_H

---