source/glsl/visitor.h

   1 #ifndef MSP_GL_SL_VISITOR_H_
   2 #define MSP_GL_SL_VISITOR_H_
   3
   4 #include <set>
   5 #include <vector>
   6 #include "syntax.h"
   7
   8 namespace Msp {
   9 namespace GL {
  10 namespace SL {
  11
  12 /** Base class for all node visitors. */
  13 class NodeVisitor
  14 {
  15 protected:
  16         NodeVisitor() { }
  17 public:
  18         virtual ~NodeVisitor() { }
  19
  20         virtual void visit(Block &) { }
  21         virtual void visit(Literal &) { }
  22         virtual void visit(ParenthesizedExpression &) { }
  23         virtual void visit(VariableReference &) { }
  24         virtual void visit(InterfaceBlockReference &) { }
  25         virtual void visit(MemberAccess &) { }
  26         virtual void visit(UnaryExpression &) { }
  27         virtual void visit(BinaryExpression &) { }
  28         virtual void visit(Assignment &) { }
  29         virtual void visit(FunctionCall &) { }
  30         virtual void visit(ExpressionStatement &) { }
  31         virtual void visit(Import &) { }
  32         virtual void visit(Precision &) { }
  33         virtual void visit(Layout &) { }
  34         virtual void visit(InterfaceLayout &) { }
  35         virtual void visit(BasicTypeDeclaration &) { }
  36         virtual void visit(ImageTypeDeclaration &) { }
  37         virtual void visit(StructDeclaration &) { }
  38         virtual void visit(VariableDeclaration &) { }
  39         virtual void visit(InterfaceBlock &) { }
  40         virtual void visit(FunctionDeclaration &) { }
  41         virtual void visit(Conditional &) { }
  42         virtual void visit(Iteration &) { }
  43         virtual void visit(Passthrough &) { }
  44         virtual void visit(Return &) { }
  45         virtual void visit(Jump &) { }
  46 };
  47
  48 /** An intermediate base visitor class which traverses the syntax tree. */
  49 class TraversingVisitor: public NodeVisitor
  50 {
  51 protected:
  52         Block *current_block;
  53
  54         TraversingVisitor(): current_block(0) { }
  55
  56 public:
  57         virtual void enter(Block &) { }
  58         virtual void visit(Block &);
  59         virtual void visit(ParenthesizedExpression &);
  60         virtual void visit(MemberAccess &);
  61         virtual void visit(UnaryExpression &);
  62         virtual void visit(BinaryExpression &);
  63         virtual void visit(Assignment &);
  64         virtual void visit(FunctionCall &);
  65         virtual void visit(ExpressionStatement &);
  66         virtual void visit(InterfaceLayout &);
  67         virtual void visit(StructDeclaration &);
  68         virtual void visit(VariableDeclaration &);
  69         virtual void visit(InterfaceBlock &);
  70         virtual void visit(FunctionDeclaration &);
  71         virtual void visit(Conditional &);
  72         virtual void visit(Iteration &);
  73         virtual void visit(Passthrough &);
  74         virtual void visit(Return &);
  75 };
  76
  77 /** Gathers nodes of a particular type from the syntax tree. */
  78 template<typename T>
  79 class NodeGatherer: private TraversingVisitor
  80 {
  81 private:
  82         std::vector<T *> nodes;
  83
  84 public:
  85         const std::vector<T *> &apply(Stage &s) { s.content.visit(*this); return nodes; }
  86
  87 private:
  88         virtual void visit(T &n) { nodes.push_back(&n); }
  89 };
  90
  91 /** Removes a set of nodes from the syntax tree. */
  92 class NodeRemover: private TraversingVisitor
  93 {
  94 private:
  95         Stage *stage;
  96         const std::set<Node *> *to_remove;
  97         bool recursive_remove;
  98
  99 public:
 100         NodeRemover();
 101
 102         void apply(Stage &, const std::set<Node *> &);
 103
 104 private:
 105         template<typename T>
 106         void remove_from_map(std::map<std::string, T *> &, const std::string &, T &);
 107
 108         virtual void visit(Block &);
 109         void visit(TypeDeclaration &);
 110         virtual void visit(BasicTypeDeclaration &t) { visit(static_cast<TypeDeclaration &>(t)); }
 111         virtual void visit(ImageTypeDeclaration &t) { visit(static_cast<TypeDeclaration &>(t)); }
 112         virtual void visit(StructDeclaration &t) { visit(static_cast<TypeDeclaration &>(t)); }
 113         virtual void visit(VariableDeclaration &);
 114         virtual void visit(InterfaceBlock &);
 115         virtual void visit(FunctionDeclaration &);
 116         virtual void visit(Iteration &);
 117 };
 118
 119 /** Reorders a set of nodes so they appear before another node.  Only nodes
 120 on the same hierarchly level as the target node are reordered. */
 121 class NodeReorderer: private TraversingVisitor
 122 {
 123 private:
 124         Node *reorder_before;
 125         const std::set<Node *> *to_reorder;
 126
 127 public:
 128         NodeReorderer();
 129
 130         void apply(Stage &, Node &, const std::set<Node *> &);
 131
 132 private:
 133         virtual void visit(Block &);
 134 };
 135
 136 } // namespace SL
 137 } // namespace GL
 138 } // namespace Msp
 139
 140 #endif