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