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 InterfaceGenerator: Visitor
 120         {
 121                 std::string in_prefix;
 122                 std::string out_prefix;
 123                 unsigned scope_level;
 124                 std::map<std::string, ProgramSyntax::VariableDeclaration *> iface_declarations;
 125                 bool remove_node;
 126                 std::list<ProgramSyntax::Node *> insert_nodes;
 127
 128                 InterfaceGenerator();
 129
 130                 static std::string get_out_prefix(ProgramSyntax::StageType);
 131                 virtual void apply(ProgramSyntax::Stage &);
 132                 virtual void visit(ProgramSyntax::Block &);
 133                 std::string change_prefix(const std::string &, const std::string &) const;
 134                 bool generate_interface(ProgramSyntax::VariableDeclaration &, const std::string &, const std::string &);
 135                 void insert_assignment(const std::string &, ProgramSyntax::Expression *);
 136                 virtual void visit(ProgramSyntax::VariableReference &);
 137                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 138                 virtual void visit(ProgramSyntax::Passthrough &);
 139         };
 140
 141         struct VariableRenamer: Visitor
 142         {
 143                 virtual void visit(ProgramSyntax::VariableReference &);
 144                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 145         };
 146
 147         struct ExpressionEvaluator: ProgramSyntax::NodeVisitor
 148         {
 149                 typedef std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Expression *> ValueMap;
 150
 151                 const ValueMap *variable_values;
 152                 float result;
 153                 bool result_valid;
 154
 155                 ExpressionEvaluator();
 156                 ExpressionEvaluator(const ValueMap &);
 157
 158                 virtual void visit(ProgramSyntax::Literal &);
 159                 virtual void visit(ProgramSyntax::VariableReference &);
 160                 virtual void visit(ProgramSyntax::UnaryExpression &);
 161                 virtual void visit(ProgramSyntax::BinaryExpression &);
 162         };
 163
 164         struct ConstantConditionEliminator: Visitor
 165         {
 166                 unsigned scope_level;
 167                 ExpressionEvaluator::ValueMap variable_values;
 168                 bool remove_node;
 169                 ProgramSyntax::Block *replacement_block;
 170
 171                 ConstantConditionEliminator();
 172
 173                 virtual void visit(ProgramSyntax::Block &);
 174                 virtual void visit(ProgramSyntax::Assignment &);
 175                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 176                 virtual void visit(ProgramSyntax::Conditional &);
 177                 virtual void visit(ProgramSyntax::Iteration &);
 178         };
 179
 180         struct UnusedVariableLocator: Visitor
 181         {
 182                 struct AssignmentList
 183                 {
 184                         std::vector<ProgramSyntax::Node *> nodes;
 185                         bool conditional;
 186                         bool self_referencing;
 187                 };
 188
 189                 typedef std::set<ProgramSyntax::Node *> ResultType;
 190                 typedef std::map<ProgramSyntax::VariableDeclaration *, AssignmentList> BlockAssignmentMap;
 191
 192                 std::set<ProgramSyntax::Node *> unused_nodes;
 193                 std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Node *> aggregates;
 194                 ProgramSyntax::Node *aggregate;
 195                 std::vector<BlockAssignmentMap> assignments;
 196                 ProgramSyntax::Assignment *assignment;
 197                 bool assignment_target;
 198
 199                 UnusedVariableLocator();
 200
 201                 virtual void apply(ProgramSyntax::Stage &);
 202                 const ResultType &get_result() const { return unused_nodes; }
 203                 virtual void visit(ProgramSyntax::VariableReference &);
 204                 virtual void visit(ProgramSyntax::MemberAccess &);
 205                 virtual void visit(ProgramSyntax::BinaryExpression &);
 206                 virtual void visit(ProgramSyntax::Assignment &);
 207                 void record_assignment(ProgramSyntax::VariableDeclaration &, ProgramSyntax::Node &, bool);
 208                 virtual void visit(ProgramSyntax::ExpressionStatement &);
 209                 virtual void visit(ProgramSyntax::StructDeclaration &);
 210                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 211                 virtual void visit(ProgramSyntax::InterfaceBlock &);
 212                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 213                 void merge_down_assignments();
 214                 virtual void visit(ProgramSyntax::Conditional &);
 215                 virtual void visit(ProgramSyntax::Iteration &);
 216         };
 217
 218         struct UnusedFunctionLocator: Visitor
 219         {
 220                 typedef std::set<ProgramSyntax::Node *> ResultType;
 221
 222                 std::set<ProgramSyntax::Node *> unused_nodes;
 223                 std::set<ProgramSyntax::FunctionDeclaration *> used_definitions;
 224
 225                 const ResultType &get_result() const { return unused_nodes; }
 226                 virtual void visit(ProgramSyntax::FunctionCall &);
 227                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 228         };
 229
 230         struct NodeRemover: Visitor
 231         {
 232                 std::set<ProgramSyntax::Node *> to_remove;
 233
 234                 NodeRemover() { }
 235                 NodeRemover(const std::set<ProgramSyntax::Node *> &);
 236
 237                 virtual void visit(ProgramSyntax::Block &);
 238                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 239         };
 240
 241         Resources *resources;
 242         ProgramParser parser;
 243         ProgramSyntax::Module *module;
 244
 245 public:
 246         ProgramCompiler();
 247
 248         void compile(const std::string &);
 249         void compile(IO::Base &, Resources * = 0);
 250         void add_shaders(Program &);
 251
 252 private:
 253         static ProgramSyntax::Module *create_builtins_module();
 254         static ProgramSyntax::Module &get_builtins_module();
 255         static ProgramSyntax::Stage *get_builtins(ProgramSyntax::StageType);
 256         void process();
 257         void import(const std::string &);
 258         void generate(ProgramSyntax::Stage &);
 259         bool optimize(ProgramSyntax::Stage &);
 260         static void inject_block(ProgramSyntax::Block &, const ProgramSyntax::Block &);
 261         template<typename T>
 262         static typename T::ResultType apply(ProgramSyntax::Stage &);
 263         template<typename T, typename A>
 264         static typename T::ResultType apply(ProgramSyntax::Stage &, const A &);
 265 };
 266
 267 } // namespace GL
 268 } // namespace Msp
 269
 270 #endif