source/programcompiler.h

   1 #ifndef MSP_GL_PROGRAMCOMPILER_H_
   2 #define MSP_GL_PROGRAMCOMPILER_H_
   3
   4 #include <set>
   5 #include "programparser.h"
   6 #include "programsyntax.h"
   7
   8 namespace Msp {
   9 namespace GL {
  10
  11 class Program;
  12 class Resources;
  13
  14 class ProgramCompiler
  15 {
  16 private:
  17         struct Visitor: ProgramSyntax::TraversingVisitor
  18         {
  19                 typedef void ResultType;
  20
  21                 ProgramSyntax::Stage *stage;
  22
  23                 Visitor();
  24
  25                 virtual void apply(ProgramSyntax::Stage &);
  26                 void get_result() const { }
  27         };
  28
  29         struct Formatter: Visitor
  30         {
  31                 typedef std::string ResultType;
  32
  33                 std::string formatted;
  34                 unsigned indent;
  35                 bool parameter_list;
  36                 unsigned else_if;
  37                 std::string block_interface;
  38
  39                 Formatter();
  40
  41                 const std::string &get_result() const { return formatted; }
  42                 virtual void visit(ProgramSyntax::Block &);
  43                 virtual void visit(ProgramSyntax::Literal &);
  44                 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
  45                 virtual void visit(ProgramSyntax::VariableReference &);
  46                 virtual void visit(ProgramSyntax::MemberAccess &);
  47                 virtual void visit(ProgramSyntax::UnaryExpression &);
  48                 virtual void visit(ProgramSyntax::BinaryExpression &);
  49                 virtual void visit(ProgramSyntax::Assignment &);
  50                 virtual void visit(ProgramSyntax::FunctionCall &);
  51                 virtual void visit(ProgramSyntax::ExpressionStatement &);
  52                 virtual void visit(ProgramSyntax::Import &);
  53                 virtual void visit(ProgramSyntax::Layout &);
  54                 virtual void visit(ProgramSyntax::StructDeclaration &);
  55                 virtual void visit(ProgramSyntax::VariableDeclaration &);
  56                 virtual void visit(ProgramSyntax::InterfaceBlock &);
  57                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
  58                 virtual void visit(ProgramSyntax::Conditional &);
  59                 virtual void visit(ProgramSyntax::Iteration &);
  60                 virtual void visit(ProgramSyntax::Return &);
  61         };
  62
  63         template<typename T>
  64         struct NodeGatherer: Visitor
  65         {
  66                 typedef std::list<T *> ResultType;
  67
  68                 std::list<T *> nodes;
  69
  70                 const ResultType &get_result() const { return nodes; }
  71                 virtual void visit(T &n) { nodes.push_back(&n); }
  72         };
  73
  74         struct DeclarationCombiner: Visitor
  75         {
  76                 bool toplevel;
  77                 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
  78                 std::map<std::string, ProgramSyntax::VariableDeclaration *> variables;
  79                 bool remove_node;
  80
  81                 DeclarationCombiner();
  82
  83                 virtual void visit(ProgramSyntax::Block &);
  84                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
  85                 virtual void visit(ProgramSyntax::VariableDeclaration &);
  86         };
  87
  88         struct VariableResolver: Visitor
  89         {
  90                 std::vector<ProgramSyntax::Block *> blocks;
  91                 ProgramSyntax::StructDeclaration *type;
  92                 bool anonymous;
  93                 std::string block_interface;
  94                 bool record_target;
  95                 ProgramSyntax::VariableDeclaration *assignment_target;
  96                 bool self_referencing;
  97
  98                 VariableResolver();
  99
 100                 virtual void apply(ProgramSyntax::Stage &);
 101                 virtual void visit(ProgramSyntax::Block &);
 102                 virtual void visit(ProgramSyntax::VariableReference &);
 103                 virtual void visit(ProgramSyntax::MemberAccess &);
 104                 virtual void visit(ProgramSyntax::BinaryExpression &);
 105                 virtual void visit(ProgramSyntax::Assignment &);
 106                 virtual void visit(ProgramSyntax::StructDeclaration &);
 107                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 108                 virtual void visit(ProgramSyntax::InterfaceBlock &);
 109         };
 110
 111         struct FunctionResolver: Visitor
 112         {
 113                 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
 114
 115                 virtual void visit(ProgramSyntax::FunctionCall &);
 116                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 117         };
 118
 119         struct BlockModifier: Visitor
 120         {
 121                 bool remove_node;
 122                 std::list<ProgramSyntax::Node *> insert_nodes;
 123
 124                 BlockModifier();
 125
 126                 void flatten_block(ProgramSyntax::Block &);
 127                 void apply_and_increment(ProgramSyntax::Block &, std::list<ProgramSyntax::NodePtr<ProgramSyntax::Node> >::iterator &);
 128                 virtual void visit(ProgramSyntax::Block &);
 129         };
 130
 131         struct InterfaceGenerator: BlockModifier
 132         {
 133                 std::string in_prefix;
 134                 std::string out_prefix;
 135                 unsigned scope_level;
 136                 std::map<std::string, ProgramSyntax::VariableDeclaration *> iface_declarations;
 137
 138                 InterfaceGenerator();
 139
 140                 static std::string get_out_prefix(ProgramSyntax::StageType);
 141                 virtual void apply(ProgramSyntax::Stage &);
 142                 virtual void visit(ProgramSyntax::Block &);
 143                 std::string change_prefix(const std::string &, const std::string &) const;
 144                 bool generate_interface(ProgramSyntax::VariableDeclaration &, const std::string &, const std::string &);
 145                 void insert_assignment(const std::string &, ProgramSyntax::Expression *);
 146                 virtual void visit(ProgramSyntax::VariableReference &);
 147                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 148                 virtual void visit(ProgramSyntax::Passthrough &);
 149         };
 150
 151         struct VariableRenamer: Visitor
 152         {
 153                 virtual void visit(ProgramSyntax::VariableReference &);
 154                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 155         };
 156
 157         struct ExpressionEvaluator: ProgramSyntax::NodeVisitor
 158         {
 159                 typedef std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Expression *> ValueMap;
 160
 161                 const ValueMap *variable_values;
 162                 float result;
 163                 bool result_valid;
 164
 165                 ExpressionEvaluator();
 166                 ExpressionEvaluator(const ValueMap &);
 167
 168                 virtual void visit(ProgramSyntax::Literal &);
 169                 virtual void visit(ProgramSyntax::VariableReference &);
 170                 virtual void visit(ProgramSyntax::UnaryExpression &);
 171                 virtual void visit(ProgramSyntax::BinaryExpression &);
 172         };
 173
 174         struct ConstantConditionEliminator: BlockModifier
 175         {
 176                 unsigned scope_level;
 177                 ExpressionEvaluator::ValueMap variable_values;
 178
 179                 ConstantConditionEliminator();
 180
 181                 virtual void visit(ProgramSyntax::Block &);
 182                 virtual void visit(ProgramSyntax::Assignment &);
 183                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 184                 virtual void visit(ProgramSyntax::Conditional &);
 185                 virtual void visit(ProgramSyntax::Iteration &);
 186         };
 187
 188         struct UnusedVariableLocator: Visitor
 189         {
 190                 struct AssignmentList
 191                 {
 192                         std::vector<ProgramSyntax::Node *> nodes;
 193                         bool conditional;
 194                         bool self_referencing;
 195                 };
 196
 197                 typedef std::set<ProgramSyntax::Node *> ResultType;
 198                 typedef std::map<ProgramSyntax::VariableDeclaration *, AssignmentList> BlockAssignmentMap;
 199
 200                 std::set<ProgramSyntax::Node *> unused_nodes;
 201                 std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Node *> aggregates;
 202                 ProgramSyntax::Node *aggregate;
 203                 std::vector<BlockAssignmentMap> assignments;
 204                 ProgramSyntax::Assignment *assignment;
 205                 bool assignment_target;
 206
 207                 UnusedVariableLocator();
 208
 209                 virtual void apply(ProgramSyntax::Stage &);
 210                 const ResultType &get_result() const { return unused_nodes; }
 211                 virtual void visit(ProgramSyntax::VariableReference &);
 212                 virtual void visit(ProgramSyntax::MemberAccess &);
 213                 virtual void visit(ProgramSyntax::BinaryExpression &);
 214                 virtual void visit(ProgramSyntax::Assignment &);
 215                 void record_assignment(ProgramSyntax::VariableDeclaration &, ProgramSyntax::Node &, bool);
 216                 virtual void visit(ProgramSyntax::ExpressionStatement &);
 217                 virtual void visit(ProgramSyntax::StructDeclaration &);
 218                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 219                 virtual void visit(ProgramSyntax::InterfaceBlock &);
 220                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 221                 void merge_down_assignments();
 222                 virtual void visit(ProgramSyntax::Conditional &);
 223                 virtual void visit(ProgramSyntax::Iteration &);
 224         };
 225
 226         struct UnusedFunctionLocator: Visitor
 227         {
 228                 typedef std::set<ProgramSyntax::Node *> ResultType;
 229
 230                 std::set<ProgramSyntax::Node *> unused_nodes;
 231                 std::set<ProgramSyntax::FunctionDeclaration *> used_definitions;
 232
 233                 const ResultType &get_result() const { return unused_nodes; }
 234                 virtual void visit(ProgramSyntax::FunctionCall &);
 235                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 236         };
 237
 238         struct NodeRemover: Visitor
 239         {
 240                 std::set<ProgramSyntax::Node *> to_remove;
 241
 242                 NodeRemover() { }
 243                 NodeRemover(const std::set<ProgramSyntax::Node *> &);
 244
 245                 virtual void visit(ProgramSyntax::Block &);
 246                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 247         };
 248
 249         Resources *resources;
 250         ProgramParser parser;
 251         ProgramSyntax::Module *module;
 252
 253 public:
 254         ProgramCompiler();
 255
 256         void compile(const std::string &);
 257         void compile(IO::Base &, Resources * = 0);
 258         void add_shaders(Program &);
 259
 260 private:
 261         static ProgramSyntax::Module *create_builtins_module();
 262         static ProgramSyntax::Module &get_builtins_module();
 263         static ProgramSyntax::Stage *get_builtins(ProgramSyntax::StageType);
 264         void process();
 265         void import(const std::string &);
 266         void generate(ProgramSyntax::Stage &);
 267         bool optimize(ProgramSyntax::Stage &);
 268         static void inject_block(ProgramSyntax::Block &, const ProgramSyntax::Block &);
 269         template<typename T>
 270         static typename T::ResultType apply(ProgramSyntax::Stage &);
 271         template<typename T, typename A>
 272         static typename T::ResultType apply(ProgramSyntax::Stage &, const A &);
 273 };
 274
 275 } // namespace GL
 276 } // namespace Msp
 277
 278 #endif